iPXE
Defines | Functions
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.

Defines

#define REBOOT_INLINE(_subsys, _api_func)   SINGLE_API_INLINE ( REBOOT_PREFIX_ ## _subsys, _api_func )
 Calculate static inline reboot API function name.
#define PROVIDE_REBOOT(_subsys, _api_func, _func)   PROVIDE_SINGLE_API ( REBOOT_PREFIX_ ## _subsys, _api_func, _func )
 Provide an reboot API implementation.
#define PROVIDE_REBOOT_INLINE(_subsys, _api_func)   PROVIDE_SINGLE_API_INLINE ( REBOOT_PREFIX_ ## _subsys, _api_func )
 Provide a static inline reboot API implementation.

Functions

 FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
void reboot (int warm)
 Reboot system.
int poweroff (void)
 Power off system.

Detailed Description

iPXE reboot API

Definition in file reboot.h.


Define Documentation

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

Calculate static inline reboot API function name.

Parameters:
_prefixSubsystem prefix
_api_funcAPI function
Return values:
_subsys_funcSubsystem API function

Definition at line 22 of file reboot.h.

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

Provide an reboot API implementation.

Parameters:
_prefixSubsystem prefix
_api_funcAPI function
_funcImplementing function

Definition at line 32 of file reboot.h.

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

Provide a static inline reboot API implementation.

Parameters:
_prefixSubsystem prefix
_api_funcAPI function

Definition at line 41 of file reboot.h.


Function Documentation

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL  )
void reboot ( int  warm)

Reboot system.

Parameters:
warmPerform a warm reboot

Referenced by reboot_exec().

int poweroff ( void  )

Power off system.

Return values:
rcReturn status code

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

Referenced by poweroff_exec().