src/include/gpxe/init.h

   1 #ifndef _GPXE_INIT_H
   2 #define _GPXE_INIT_H
   3
   4 #include <gpxe/tables.h>
   5
   6 /**
   7  * An initialisation function
   8  *
   9  * Initialisation functions are called exactly once, as part of the
  10  * call to initialise().
  11  */
  12 struct init_fn {
  13         void ( * initialise ) ( void );
  14 };
  15
  16 /** Initialisation function table */
  17 #define INIT_FNS "init_fns"
  18
  19 /** Declare an initialisation functon */
  20 #define __init_fn( init_order ) \
  21         __table ( struct init_fn, INIT_FNS, init_order )
  22
  23 /** @defgroup initfn_order Initialisation function ordering
  24  * @{
  25  */
  26
  27 #define INIT_EARLY      01      /**< Early initialisation */
  28 #define INIT_SERIAL     02      /**< Serial driver initialisation */
  29 #define INIT_CONSOLE    03      /**< Console initialisation */
  30 #define INIT_NORMAL     04      /**< Normal initialisation */
  31
  32 /** @} */
  33
  34 /** Shutdown flags */
  35 enum shutdown_flags {
  36         /** Shutdown is in order to exit (return to gPXE's caller) */
  37         SHUTDOWN_EXIT = 0x0001,
  38         /** Shutdown is in order to boot an OS */
  39         SHUTDOWN_BOOT = 0x0002,
  40         /** Do not remove devices */
  41         SHUTDOWN_KEEP_DEVICES = 0x0004,
  42 };
  43
  44 /**
  45  * A startup/shutdown function
  46  *
  47  * Startup and shutdown functions may be called multiple times, as
  48  * part of the calls to startup() and shutdown().
  49  */
  50 struct startup_fn {
  51         void ( * startup ) ( void );
  52         void ( * shutdown ) ( int flags );
  53 };
  54
  55 /** Startup/shutdown function table */
  56 #define STARTUP_FNS "startup_fns"
  57
  58 /** Declare a startup/shutdown function */
  59 #define __startup_fn( startup_order ) \
  60         __table ( struct startup_fn, STARTUP_FNS, startup_order )
  61
  62 /** @defgroup startfn_order Startup/shutdown function ordering
  63  *
  64  * Shutdown functions are called in the reverse order to startup
  65  * functions.
  66  *
  67  * @{
  68  */
  69
  70 #define STARTUP_EARLY   01      /**< Early startup */
  71 #define STARTUP_NORMAL  02      /**< Normal startup */
  72 #define STARTUP_LATE    03      /**< Late startup */
  73
  74 /** @} */
  75
  76 extern void initialise ( void );
  77 extern void startup ( void );
  78 extern void shutdown ( int flags );
  79
  80 #endif /* _GPXE_INIT_H */