[tables] Redefine methods for accessing linker tables
[people/lynusvaz/gpxe.git] / src / core / init.c
1 /*
2  * Copyright (C) 2007 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 #include <gpxe/device.h>
20 #include <gpxe/init.h>
21
22 /** @file
23  *
24  * Initialisation, startup and shutdown routines
25  *
26  */
27
28 /** "startup() has been called" flag */
29 static int started = 0;
30
31 /**
32  * Initialise gPXE
33  *
34  * This function performs the one-time-only and irreversible
35  * initialisation steps, such as initialising the heap.  It must be
36  * called before (almost) any other function.
37  *
38  * There is, by definition, no counterpart to this function on the
39  * shutdown path.
40  */
41 void initialise ( void ) {
42         struct init_fn *init_fn;
43
44         /* Call registered initialisation functions */
45         for_each_table_entry ( init_fn, INIT_FNS )
46                 init_fn->initialise ();
47 }
48
49 /**
50  * Start up gPXE
51  *
52  * This function performs the repeatable initialisation steps, such as
53  * probing devices.  You may call startup() and shutdown() multiple
54  * times (as is done via the PXE API when PXENV_START_UNDI is used).
55  */
56 void startup ( void ) {
57         struct startup_fn *startup_fn;
58
59         if ( started )
60                 return;
61
62         /* Call registered startup functions */
63         for_each_table_entry ( startup_fn, STARTUP_FNS ) {
64                 if ( startup_fn->startup )
65                         startup_fn->startup();
66         }
67
68         started = 1;
69 }
70
71 /**
72  * Shut down gPXE
73  *
74  * @v flags             Shutdown behaviour flags
75  *
76  * This function reverses the actions of startup(), and leaves gPXE in
77  * a state ready to be removed from memory.  You may call startup()
78  * again after calling shutdown().
79  *
80  * Call this function only once, before either exiting main() or
81  * starting up a non-returnable image.
82  */
83 void shutdown ( int flags ) {
84         struct startup_fn *startup_fn;
85
86         if ( ! started )
87                 return;
88
89         /* Call registered shutdown functions (in reverse order) */
90         for_each_table_entry_reverse ( startup_fn, STARTUP_FNS ) {
91                 if ( startup_fn->shutdown )
92                         startup_fn->shutdown ( flags );
93         }
94
95         started = 0;
96 }