[efi] Allow use of EFI configuration tables
[people/asdlkf/gpxe.git] / src / include / gpxe / efi / efi.h
1 #ifndef _EFI_H
2 #define _EFI_H
3
4 /** @file
5  *
6  * EFI API
7  *
8  * The intention is to include near-verbatim copies of the EFI headers
9  * required by gPXE.  This is achieved using the import.pl script in
10  * this directory.  Run the import script to update the local copies
11  * of the headers:
12  *
13  *     ./import.pl /path/to/edk2/edk2
14  *
15  * where /path/to/edk2/edk2 is the path to your local checkout of the
16  * EFI Development Kit.
17  *
18  * Note that import.pl will modify any #include lines in each imported
19  * header to reflect its new location within the gPXE tree.  It will
20  * also tidy up the file by removing carriage return characters and
21  * trailing whitespace.
22  *
23  *
24  * At the time of writing, there are a few other modifications to
25  * these headers that are present in my personal edk2 tree, that are
26  * not yet committed back to the main edk2 repository.  These
27  * modifications are fixes for compilation on case-dependent
28  * filesystems, compilation under -mrtd and -mregparm=3, etc.
29  */
30
31 /* EFI headers rudely redefine NULL */
32 #undef NULL
33
34 /* Include the top-level EFI header files */
35 #include <gpxe/efi/Uefi.h>
36 #include <gpxe/efi/PiDxe.h>
37
38 /* Reset any trailing #pragma pack directives */
39 #pragma pack()
40
41 #include <gpxe/tables.h>
42 #include <gpxe/uuid.h>
43
44 /** An EFI protocol used by gPXE */
45 struct efi_protocol {
46         /** GUID */
47         union {
48                 /** EFI protocol GUID */
49                 EFI_GUID guid;
50                 /** UUID structure understood by gPXE */
51                 union uuid uuid;
52         } u;
53         /** Variable containing pointer to protocol structure */
54         void **protocol;
55 };
56
57 /** Declare an EFI protocol used by gPXE */
58 #define __efi_protocol \
59         __table ( struct efi_protocol, efi_protocols, 01 )
60
61 /** Declare an EFI protocol to be required by gPXE
62  *
63  * @v _protocol         EFI protocol name
64  * @v _ptr              Pointer to protocol instance
65  */
66 #define EFI_REQUIRE_PROTOCOL( _protocol, _ptr )                              \
67         struct efi_protocol __ ## _protocol __efi_protocol = {               \
68                 .u.guid = _protocol ## _GUID,                                \
69                 .protocol = ( ( void ** ) ( void * )                         \
70                               ( ( (_ptr) == ( ( _protocol ** ) NULL ) ) ?    \
71                                 (_ptr) : (_ptr) ) ),                         \
72         }
73
74 /** An EFI configuration table used by gPXE */
75 struct efi_config_table {
76         /** GUID */
77         union {
78                 /** EFI configuration table GUID */
79                 EFI_GUID guid;
80                 /** UUID structure understood by gPXE */
81                 union uuid uuid;
82         } u;
83         /** Variable containing pointer to configuration table */
84         void **table;
85         /** Table is required for operation */
86         int required;
87 };
88
89 /** Declare an EFI configuration table used by gPXE */
90 #define __efi_config_table \
91         __table ( struct efi_config_table, efi_config_tables, 01 )
92
93 /** Declare an EFI configuration table to be used by gPXE
94  *
95  * @v _table            EFI configuration table name
96  * @v _ptr              Pointer to configuration table
97  * @v _required         Table is required for operation
98  */
99 #define EFI_USE_TABLE( _table, _ptr, _required )                             \
100         struct efi_config_table __ ## _table __efi_config_table = {          \
101                 .u.guid = _table ## _GUID,                                   \
102                 .table = ( ( void ** ) ( void * ) (_ptr) ),                  \
103                 .required = (_required),                                     \
104         }
105
106 /** Convert a gPXE status code to an EFI status code
107  *
108  * FIXME: actually perform some kind of conversion.  gPXE error codes
109  * will be detected as EFI error codes; both have the top bit set, and
110  * the success return code is zero for both.  Anything that just
111  * reports a numerical error will be OK, anything attempting to
112  * interpret the value or to display a text equivalent will be
113  * screwed.
114  */
115 #define RC_TO_EFIRC( rc ) (rc)
116
117 /** Convert an EFI status code to a gPXE status code
118  *
119  * FIXME: as above
120  */
121 #define EFIRC_TO_RC( efirc ) (efirc)
122
123 extern EFI_HANDLE efi_image_handle;
124 extern EFI_SYSTEM_TABLE *efi_systab;
125
126 extern const char * efi_strerror ( EFI_STATUS efirc );
127
128 #endif /* _EFI_H */