init.h File Reference

#include <gpxe/tables.h>

Go to the source code of this file.

Data Structures
struct	init_fn
	An initialisation function. More...
struct	startup_fn
	A startup/shutdown function. More...
Defines
#define	INIT_FNS   __table ( struct init_fn, "init_fns" )
	Initialisation function table.
#define	__init_fn(init_order)   __table_entry ( INIT_FNS, init_order )
	Declare an initialisation functon.
#define	INIT_EARLY   01
	Early initialisation.
#define	INIT_SERIAL   02
	Serial driver initialisation.
#define	INIT_CONSOLE   03
	Console initialisation.
#define	INIT_NORMAL   04
	Normal initialisation.
#define	STARTUP_FNS   __table ( struct startup_fn, "startup_fns" )
	Startup/shutdown function table.
#define	__startup_fn(startup_order)   __table_entry ( STARTUP_FNS, startup_order )
	Declare a startup/shutdown function.
#define	STARTUP_EARLY   01
	Early startup.
#define	STARTUP_NORMAL   02
	Normal startup.
#define	STARTUP_LATE   03
	Late startup.
Enumerations
enum	shutdown_flags { SHUTDOWN_EXIT = 0x0001, SHUTDOWN_BOOT = 0x0002, SHUTDOWN_KEEP_DEVICES = 0x0004 }
	Shutdown flags. More...
Functions
	FILE_LICENCE (GPL2_OR_LATER)
void	initialise (void)
	Initialise gPXE.
void	startup (void)
	Start up gPXE.
void	shutdown (int flags)
	Shut down gPXE.

---

Define Documentation

#define INIT_FNS   __table ( struct init_fn, "init_fns" )

Initialisation function table.

Definition at line 19 of file init.h.

Referenced by initialise().

#define __init_fn

(

init_order

)

__table_entry ( INIT_FNS, init_order )

Declare an initialisation functon.

Definition at line 22 of file init.h.

#define STARTUP_FNS   __table ( struct startup_fn, "startup_fns" )

Startup/shutdown function table.

Definition at line 57 of file init.h.

Referenced by shutdown(), and startup().

#define __startup_fn

(

startup_order

)

__table_entry ( STARTUP_FNS, startup_order )

Declare a startup/shutdown function.

Definition at line 60 of file init.h.

---

Enumeration Type Documentation

enum shutdown_flags

Shutdown flags.

Enumerator:

SHUTDOWN_EXIT	Shutdown is in order to exit (return to gPXE's caller).
SHUTDOWN_BOOT	Shutdown is in order to boot an OS.
SHUTDOWN_KEEP_DEVICES	Do not remove devices.

Definition at line 36 of file init.h.

                    {
        /** Shutdown is in order to exit (return to gPXE's caller) */
        SHUTDOWN_EXIT = 0x0001,
        /** Shutdown is in order to boot an OS */
        SHUTDOWN_BOOT = 0x0002,
        /** Do not remove devices */
        SHUTDOWN_KEEP_DEVICES = 0x0004,
};

---

Function Documentation

FILE_LICENCE

(

GPL2_OR_LATER

)

void initialise

(

void

)

Initialise gPXE.

This function performs the one-time-only and irreversible initialisation steps, such as initialising the heap. It must be called before (almost) any other function.

There is, by definition, no counterpart to this function on the shutdown path.

Definition at line 43 of file init.c.

References for_each_table_entry, INIT_FNS, and init_fn::initialise.

Referenced by _start(), main(), and undi_loader().

                         {
        struct init_fn *init_fn;

        /* Call registered initialisation functions */
        for_each_table_entry ( init_fn, INIT_FNS )
                init_fn->initialise ();
}

void startup

(

void

)

Start up gPXE.

This function performs the repeatable initialisation steps, such as probing devices. You may call startup() and shutdown() multiple times (as is done via the PXE API when PXENV_START_UNDI is used).

Definition at line 58 of file init.c.

References for_each_table_entry, started, startup_fn::startup, and STARTUP_FNS.

Referenced by _start(), main(), and pxenv_start_undi().

                      {
        struct startup_fn *startup_fn;

        if ( started )
                return;

        /* Call registered startup functions */
        for_each_table_entry ( startup_fn, STARTUP_FNS ) {
                if ( startup_fn->startup )
                        startup_fn->startup();
        }

        started = 1;
}

void shutdown

(

int

flags

)

Shut down gPXE.

Parameters:

flags

Shutdown behaviour flags

This function reverses the actions of startup(), and leaves gPXE in a state ready to be removed from memory. You may call startup() again after calling shutdown().

Call this function only once, before either exiting main() or starting up a non-returnable image.

Definition at line 85 of file init.c.

References for_each_table_entry_reverse, startup_fn::shutdown, started, and STARTUP_FNS.

Referenced by bzimage_exec(), elfboot_exec(), ib_cmrc_shutdown(), int22(), main(), multiboot_exec(), nbi_exec(), and pxenv_stop_undi().

                            {
        struct startup_fn *startup_fn;

        if ( ! started )
                return;

        /* Call registered shutdown functions (in reverse order) */
        for_each_table_entry_reverse ( startup_fn, STARTUP_FNS ) {
                if ( startup_fn->shutdown )
                        startup_fn->shutdown ( flags );
        }

        started = 0;
}