nap.h File Reference

CPU sleeping. More...

#include <ipxe/api.h>
#include <config/nap.h>
#include <ipxe/null_nap.h>
#include <ipxe/efi/efi_nap.h>
#include <ipxe/linux/linux_nap.h>
#include <bits/nap.h>

Go to the source code of this file.

Macros
#define	NAP_INLINE(_subsys, _api_func)
	Calculate static inline CPU sleeping API function name.
#define	PROVIDE_NAP(_subsys, _api_func, _func)
	Provide an CPU sleeping API implementation.
#define	PROVIDE_NAP_INLINE(_subsys, _api_func)
	Provide a static inline CPU sleeping API implementation.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
void	cpu_halt (void)
	Sleep until next CPU interrupt.
void	cpu_nap (void)
	Sleep with interrupts enabled until next CPU interrupt.

Detailed Description

CPU sleeping.

Definition in file nap.h.

Macro Definition Documentation

NAP_INLINE

#define NAP_INLINE	(		_subsys,
			_api_func )

Value:

        SINGLE_API_INLINE ( NAP_PREFIX_ ## _subsys, _api_func )

Calculate static inline CPU sleeping API function name.

Parameters

_prefix	Subsystem prefix
_api_func	API function

Return values

_subsys_func

Subsystem API function

Definition at line 23 of file nap.h.

#define NAP_INLINE( _subsys, _api_func ) \
        SINGLE_API_INLINE ( NAP_PREFIX_ ## _subsys, _api_func )

PROVIDE_NAP

#define PROVIDE_NAP	(		_subsys,
			_api_func,
			_func )

Value:

        PROVIDE_SINGLE_API ( NAP_PREFIX_ ## _subsys, _api_func, _func )

Provide an CPU sleeping API implementation.

Parameters

_prefix	Subsystem prefix
_api_func	API function
_func	Implementing function

Definition at line 33 of file nap.h.

#define PROVIDE_NAP( _subsys, _api_func, _func ) \
        PROVIDE_SINGLE_API ( NAP_PREFIX_ ## _subsys, _api_func, _func )

PROVIDE_NAP_INLINE

#define PROVIDE_NAP_INLINE	(		_subsys,
			_api_func )

Value:

        PROVIDE_SINGLE_API_INLINE ( NAP_PREFIX_ ## _subsys, _api_func )

Provide a static inline CPU sleeping API implementation.

Parameters

_prefix	Subsystem prefix
_api_func	API function

Definition at line 42 of file nap.h.

#define PROVIDE_NAP_INLINE( _subsys, _api_func ) \
        PROVIDE_SINGLE_API_INLINE ( NAP_PREFIX_ ## _subsys, _api_func )

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

cpu_halt()

void cpu_halt

(

void

)

Sleep until next CPU interrupt.

Referenced by efi_cpu_nap().

cpu_nap()

void cpu_nap

(

void

)

Sleep with interrupts enabled until next CPU interrupt.

Referenced by gdbudp_recv(), getchar(), getchar_timeout(), NAP_INLINE(), nap_test_exec(), PROVIDE_NAP(), PROVIDE_NAP(), PROVIDE_NAP_INLINE(), sleep_interruptible(), xenbus_backend_wait(), xenstore_recv(), xenstore_response(), and xenstore_send().