reboot.h File Reference

iPXE reboot API More...

#include <ipxe/api.h>
#include <config/reboot.h>
#include <ipxe/null_reboot.h>
#include <ipxe/efi/efi_reboot.h>
#include <bits/reboot.h>

Go to the source code of this file.

Macros
#define	REBOOT_INLINE(_subsys, _api_func)   SINGLE_API_INLINE ( REBOOT_PREFIX_ ## _subsys, _api_func )
	Calculate static inline reboot API function name. More...
#define	PROVIDE_REBOOT(_subsys, _api_func, _func)   PROVIDE_SINGLE_API ( REBOOT_PREFIX_ ## _subsys, _api_func, _func )
	Provide an reboot API implementation. More...
#define	PROVIDE_REBOOT_INLINE(_subsys, _api_func)   PROVIDE_SINGLE_API_INLINE ( REBOOT_PREFIX_ ## _subsys, _api_func )
	Provide a static inline reboot API implementation. More...
#define	REBOOT_WARM   0x00000001
	Perform a warm reboot. More...
#define	REBOOT_SETUP   0x00000002
	Reboot to firmware setup. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
void	reboot (int flags)
	Reboot system. More...
int	poweroff (void)
	Power off system. More...

Detailed Description

iPXE reboot API

Definition in file reboot.h.

Macro Definition Documentation

REBOOT_INLINE

#define REBOOT_INLINE	(		_subsys,
			_api_func
	)		SINGLE_API_INLINE ( REBOOT_PREFIX_ ## _subsys, _api_func )

Calculate static inline reboot API function name.

Parameters

_prefix	Subsystem prefix
_api_func	API function

Return values

_subsys_func

Subsystem API function

Definition at line 22 of file reboot.h.

PROVIDE_REBOOT

#define PROVIDE_REBOOT	(		_subsys,
			_api_func,
			_func
	)		PROVIDE_SINGLE_API ( REBOOT_PREFIX_ ## _subsys, _api_func, _func )

Provide an reboot API implementation.

Parameters

_prefix	Subsystem prefix
_api_func	API function
_func	Implementing function

Definition at line 32 of file reboot.h.

PROVIDE_REBOOT_INLINE

#define PROVIDE_REBOOT_INLINE	(		_subsys,
			_api_func
	)		PROVIDE_SINGLE_API_INLINE ( REBOOT_PREFIX_ ## _subsys, _api_func )

Provide a static inline reboot API implementation.

Parameters

_prefix	Subsystem prefix
_api_func	API function

Definition at line 41 of file reboot.h.

REBOOT_WARM

#define REBOOT_WARM   0x00000001

Perform a warm reboot.

Definition at line 58 of file reboot.h.

REBOOT_SETUP

#define REBOOT_SETUP   0x00000002

Reboot to firmware setup.

Definition at line 59 of file reboot.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

reboot()

void reboot

(

int

flags

)

Reboot system.

Parameters

flags

Reboot flags

Referenced by reboot_exec().

poweroff()

int poweroff

(

void

)

Power off system.

Return values

rc	Return status code

This function may fail, since not all systems support being powered off by software.

Referenced by poweroff_exec().