init.h File Reference

#include <ipxe/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...

Macros
#define	INIT_FNS   __table ( struct init_fn, "init_fns" )
	Initialisation function table.
#define	__init_fn(init_order)
	Declare an initialisation functon.
#define	INIT_EARLY   01
	Early initialisation.
#define	INIT_CONSOLE   02
	Console initialisation.
#define	INIT_NORMAL   03
	Normal initialisation.
#define	INIT_LATE   04
	Late initialisation.
#define	STARTUP_FNS   __table ( struct startup_fn, "startup_fns" )
	Startup/shutdown function table.
#define	__startup_fn(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.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
void	initialise (void)
	Initialise iPXE.
void	startup (void)
	Start up iPXE.
void	shutdown (int booting)
	Shut down iPXE.
static void	shutdown_boot (void)
	Shut down system for OS boot.
static void	shutdown_exit (void)
	Shut down system for exit back to firmware.

Macro Definition Documentation

INIT_FNS

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

Initialisation function table.

Definition at line 21 of file init.h.

Referenced by initialise().

__init_fn

#define __init_fn

(

init_order

)

Value:

__table_entry ( INIT_FNS, init_order )

Declare an initialisation functon.

Definition at line 24 of file init.h.

Referenced by __init_fn(), __init_fn(), __init_fn(), and __init_fn().

STARTUP_FNS

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

Startup/shutdown function table.

Definition at line 50 of file init.h.

Referenced by shutdown(), and startup().

__startup_fn

#define __startup_fn

(

startup_order

)

Value:

        __table_entry ( STARTUP_FNS, startup_order )

Declare a startup/shutdown function.

Definition at line 53 of file init.h.

#define __startup_fn( startup_order ) \
        __table_entry ( STARTUP_FNS, startup_order )

Referenced by __startup_fn(), __startup_fn(), and __startup_fn().

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

initialise()

void initialise ( void )

extern

Initialise iPXE.

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 53 of file init.c.

                         {
        struct init_fn *init_fn;
 
        /* Call registered initialisation functions */
        for_each_table_entry ( init_fn, INIT_FNS ) {
                DBGC ( colour, "INIT initialising %s...\n", init_fn->name );
                init_fn->initialise ();
        }
}

References colour, DBGC, for_each_table_entry, INIT_FNS, init_fn::initialise, and init_fn::name.

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

startup()

void startup ( void )

extern

Start up iPXE.

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 70 of file init.c.

                      {
        struct startup_fn *startup_fn;
 
        if ( started )
                return;
 
        /* Call registered startup functions */
        for_each_table_entry ( startup_fn, STARTUP_FNS ) {
                if ( startup_fn->startup ) {
                        DBGC ( colour, "INIT startup %s...\n",
                               startup_fn->name );
                        startup_fn->startup();
                }
        }
 
        started = 1;
        DBGC ( colour, "INIT startup complete\n" );
}

References colour, DBGC, for_each_table_entry, startup_fn::name, started, startup_fn::startup, and STARTUP_FNS.

Referenced by _efidrv_start(), main(), pnic_do_nway(), pxenv_start_undi(), and select_media().

shutdown()

void shutdown ( int flags )

extern

Shut down iPXE.

Parameters

flags

Shutdown behaviour flags

This function reverses the actions of startup(), and leaves iPXE 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 101 of file init.c.

                            {
        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 ) {
                        DBGC ( colour, "INIT shutdown %s...\n",
                               startup_fn->name );
                        startup_fn->shutdown ( flags );
                }
        }
 
        /* Reset console */
        console_reset();
 
        started = 0;
        DBGC ( colour, "INIT shutdown complete\n" );
}

References colour, console_reset(), DBGC, flags, for_each_table_entry_reverse, startup_fn::name, startup_fn::shutdown, started, and STARTUP_FNS.

Referenced by intelxl_admin_shutdown(), shutdown_boot(), and shutdown_exit().

shutdown_boot()

void shutdown_boot ( void )

inlinestatic

Shut down system for OS boot.

Definition at line 78 of file init.h.

                                          {
        shutdown ( 1 );
}

References shutdown().

Referenced by bzimage_exec(), efi_shutdown_hook(), elfboot_exec(), int22(), lkrn_exec(), multiboot_exec(), nbi_exec(), and pxenv_stop_undi().

shutdown_exit()

void shutdown_exit ( void )

inlinestatic

Shut down system for exit back to firmware.

Definition at line 86 of file init.h.

                                          {
        shutdown ( 0 );
}

References shutdown().

Referenced by efi_unload(), and main().