c796bdd24bc193131f0e9a7300306f8a034094af
[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 /* EFI headers expect ICC to define __GNUC__ */
35 #if defined ( __ICC ) && ! defined ( __GNUC__ )
36 #define __GNUC__ 1
37 #endif
38
39 /* EFI headers think your compiler uses the MS ABI by default on X64 */
40 #if __x86_64__
41 #define EFIAPI __attribute__((ms_abi))
42 #endif
43
44 /* EFI headers assume regparm(0) on i386, but that is not the case for gPXE */
45 #if __i386__
46 #define EFIAPI __attribute__((cdecl,regparm(0)))
47 #endif
48
49 /* Include the top-level EFI header files */
50 #include <gpxe/efi/Uefi.h>
51 #include <gpxe/efi/PiDxe.h>
52
53 /* Reset any trailing #pragma pack directives */
54 #pragma pack(1)
55 #pragma pack()
56
57 #include <gpxe/tables.h>
58 #include <gpxe/uuid.h>
59
60 /** An EFI protocol used by gPXE */
61 struct efi_protocol {
62         /** GUID */
63         union {
64                 /** EFI protocol GUID */
65                 EFI_GUID guid;
66                 /** UUID structure understood by gPXE */
67                 union uuid uuid;
68         } u;
69         /** Variable containing pointer to protocol structure */
70         void **protocol;
71 };
72
73 /** EFI protocol table */
74 #define EFI_PROTOCOLS __table ( struct efi_protocol, "efi_protocols" )
75
76 /** Declare an EFI protocol used by gPXE */
77 #define __efi_protocol __table_entry ( EFI_PROTOCOLS, 01 )
78
79 /** Declare an EFI protocol to be required by gPXE
80  *
81  * @v _protocol         EFI protocol name
82  * @v _ptr              Pointer to protocol instance
83  */
84 #define EFI_REQUIRE_PROTOCOL( _protocol, _ptr )                              \
85         struct efi_protocol __ ## _protocol __efi_protocol = {               \
86                 .u.guid = _protocol ## _GUID,                                \
87                 .protocol = ( ( void ** ) ( void * )                         \
88                               ( ( (_ptr) == ( ( _protocol ** ) (_ptr) ) ) ?  \
89                                 (_ptr) : (_ptr) ) ),                         \
90         }
91
92 /** An EFI configuration table used by gPXE */
93 struct efi_config_table {
94         /** GUID */
95         union {
96                 /** EFI configuration table GUID */
97                 EFI_GUID guid;
98                 /** UUID structure understood by gPXE */
99                 union uuid uuid;
100         } u;
101         /** Variable containing pointer to configuration table */
102         void **table;
103         /** Table is required for operation */
104         int required;
105 };
106
107 /** EFI configuration table table */
108 #define EFI_CONFIG_TABLES \
109         __table ( struct efi_config_table, "efi_config_tables" )
110
111 /** Declare an EFI configuration table used by gPXE */
112 #define __efi_config_table __table_entry ( EFI_CONFIG_TABLES, 01 )
113
114 /** Declare an EFI configuration table to be used by gPXE
115  *
116  * @v _table            EFI configuration table name
117  * @v _ptr              Pointer to configuration table
118  * @v _required         Table is required for operation
119  */
120 #define EFI_USE_TABLE( _table, _ptr, _required )                             \
121         struct efi_config_table __ ## _table __efi_config_table = {          \
122                 .u.guid = _table ## _GUID,                                   \
123                 .table = ( ( void ** ) ( void * ) (_ptr) ),                  \
124                 .required = (_required),                                     \
125         }
126
127 /** Convert a gPXE status code to an EFI status code
128  *
129  * FIXME: actually perform some kind of conversion.  gPXE error codes
130  * will be detected as EFI error codes; both have the top bit set, and
131  * the success return code is zero for both.  Anything that just
132  * reports a numerical error will be OK, anything attempting to
133  * interpret the value or to display a text equivalent will be
134  * screwed.
135  */
136 #define RC_TO_EFIRC( rc ) (rc)
137
138 /** Convert an EFI status code to a gPXE status code
139  *
140  * FIXME: as above
141  */
142 #define EFIRC_TO_RC( efirc ) (efirc)
143
144 extern EFI_HANDLE efi_image_handle;
145 extern EFI_SYSTEM_TABLE *efi_systab;
146
147 extern const char * efi_strerror ( EFI_STATUS efirc );
148 extern EFI_STATUS efi_init ( EFI_HANDLE image_handle,
149                              EFI_SYSTEM_TABLE *systab );
150 extern int efi_snp_install ( void );
151
152 #endif /* _EFI_H */