[efi] Add the "snpnet" driver
[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 #include <gpxe/efi/Protocol/LoadedImage.h>
53
54 /* Reset any trailing #pragma pack directives */
55 #pragma pack(1)
56 #pragma pack()
57
58 #include <gpxe/tables.h>
59 #include <gpxe/uuid.h>
60
61 /** An EFI protocol used by gPXE */
62 struct efi_protocol {
63         /** GUID */
64         union {
65                 /** EFI protocol GUID */
66                 EFI_GUID guid;
67                 /** UUID structure understood by gPXE */
68                 union uuid uuid;
69         } u;
70         /** Variable containing pointer to protocol structure */
71         void **protocol;
72 };
73
74 /** EFI protocol table */
75 #define EFI_PROTOCOLS __table ( struct efi_protocol, "efi_protocols" )
76
77 /** Declare an EFI protocol used by gPXE */
78 #define __efi_protocol __table_entry ( EFI_PROTOCOLS, 01 )
79
80 /** Declare an EFI protocol to be required by gPXE
81  *
82  * @v _protocol         EFI protocol name
83  * @v _ptr              Pointer to protocol instance
84  */
85 #define EFI_REQUIRE_PROTOCOL( _protocol, _ptr )                              \
86         struct efi_protocol __ ## _protocol __efi_protocol = {               \
87                 .u.guid = _protocol ## _GUID,                                \
88                 .protocol = ( ( void ** ) ( void * )                         \
89                               ( ( (_ptr) == ( ( _protocol ** ) (_ptr) ) ) ?  \
90                                 (_ptr) : (_ptr) ) ),                         \
91         }
92
93 /** An EFI configuration table used by gPXE */
94 struct efi_config_table {
95         /** GUID */
96         union {
97                 /** EFI configuration table GUID */
98                 EFI_GUID guid;
99                 /** UUID structure understood by gPXE */
100                 union uuid uuid;
101         } u;
102         /** Variable containing pointer to configuration table */
103         void **table;
104         /** Table is required for operation */
105         int required;
106 };
107
108 /** EFI configuration table table */
109 #define EFI_CONFIG_TABLES \
110         __table ( struct efi_config_table, "efi_config_tables" )
111
112 /** Declare an EFI configuration table used by gPXE */
113 #define __efi_config_table __table_entry ( EFI_CONFIG_TABLES, 01 )
114
115 /** Declare an EFI configuration table to be used by gPXE
116  *
117  * @v _table            EFI configuration table name
118  * @v _ptr              Pointer to configuration table
119  * @v _required         Table is required for operation
120  */
121 #define EFI_USE_TABLE( _table, _ptr, _required )                             \
122         struct efi_config_table __ ## _table __efi_config_table = {          \
123                 .u.guid = _table ## _GUID,                                   \
124                 .table = ( ( void ** ) ( void * ) (_ptr) ),                  \
125                 .required = (_required),                                     \
126         }
127
128 /** Convert a gPXE status code to an EFI status code
129  *
130  * FIXME: actually perform some kind of conversion.  gPXE error codes
131  * will be detected as EFI error codes; both have the top bit set, and
132  * the success return code is zero for both.  Anything that just
133  * reports a numerical error will be OK, anything attempting to
134  * interpret the value or to display a text equivalent will be
135  * screwed.
136  */
137 #define RC_TO_EFIRC( rc ) (rc)
138
139 /** Convert an EFI status code to a gPXE status code
140  *
141  * FIXME: as above
142  */
143 #define EFIRC_TO_RC( efirc ) (efirc)
144
145 extern EFI_HANDLE efi_image_handle;
146 extern EFI_LOADED_IMAGE_PROTOCOL *efi_loaded_image;
147 extern EFI_SYSTEM_TABLE *efi_systab;
148
149 extern const char * efi_strerror ( EFI_STATUS efirc );
150 extern EFI_STATUS efi_init ( EFI_HANDLE image_handle,
151                              EFI_SYSTEM_TABLE *systab );
152 extern int efi_snp_install ( void );
153
154 #endif /* _EFI_H */