iPXE
efi.h
Go to the documentation of this file.
1 #ifndef _IPXE_EFI_H
2 #define _IPXE_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 iPXE. 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 iPXE tree. It will
20  * also tidy up the file by removing carriage return characters and
21  * trailing whitespace.
22  */
23 
24 FILE_LICENCE ( GPL2_OR_LATER );
25 
26 /* EFI headers rudely redefine NULL */
27 #undef NULL
28 
29 /* EFI headers redefine ARRAY_SIZE */
30 #undef ARRAY_SIZE
31 
32 /* EFI headers expect ICC to define __GNUC__ */
33 #if defined ( __ICC ) && ! defined ( __GNUC__ )
34 #define __GNUC__ 1
35 #endif
36 
37 /* EFI headers think your compiler uses the MS ABI by default on X64 */
38 #if __x86_64__
39 #define EFIAPI __attribute__((ms_abi))
40 #endif
41 
42 /* EFI headers assume regparm(0) on i386, but that is not the case for iPXE */
43 #if __i386__
44 #define EFIAPI __attribute__((cdecl,regparm(0)))
45 #endif
46 
47 /* EFI headers define EFI_HANDLE as a void pointer, which renders type
48  * checking somewhat useless. Work around this bizarre sabotage
49  * attempt by redefining EFI_HANDLE as a pointer to an anonymous
50  * structure.
51  */
52 #define EFI_HANDLE STUPID_EFI_HANDLE
54 #undef EFI_HANDLE
55 typedef struct {} *EFI_HANDLE;
56 
57 /* Include the top-level EFI header files */
58 #include <ipxe/efi/Uefi.h>
59 #include <ipxe/efi/PiDxe.h>
61 
62 /* Reset any trailing #pragma pack directives */
63 #pragma pack(1)
64 #pragma pack()
65 
66 #include <ipxe/tables.h>
67 #include <ipxe/uuid.h>
68 
69 /** An EFI protocol used by iPXE */
70 struct efi_protocol {
71  /** GUID */
73  /** Variable containing pointer to protocol structure */
74  void **protocol;
75  /** Protocol is required */
76  int required;
77 };
78 
79 /** EFI protocol table */
80 #define EFI_PROTOCOLS __table ( struct efi_protocol, "efi_protocols" )
81 
82 /** Declare an EFI protocol used by iPXE */
83 #define __efi_protocol __table_entry ( EFI_PROTOCOLS, 01 )
84 
85 /** Declare an EFI protocol to be required by iPXE
86  *
87  * @v _protocol EFI protocol name
88  * @v _ptr Pointer to protocol instance
89  */
90 #define EFI_REQUIRE_PROTOCOL( _protocol, _ptr ) \
91  struct efi_protocol __ ## _protocol __efi_protocol = { \
92  .guid = _protocol ## _GUID, \
93  .protocol = ( ( void ** ) ( void * ) \
94  ( ( (_ptr) == ( ( _protocol ** ) (_ptr) ) ) ? \
95  (_ptr) : (_ptr) ) ), \
96  .required = 1, \
97  }
98 
99 /** Declare an EFI protocol to be requested by iPXE
100  *
101  * @v _protocol EFI protocol name
102  * @v _ptr Pointer to protocol instance
103  */
104 #define EFI_REQUEST_PROTOCOL( _protocol, _ptr ) \
105  struct efi_protocol __ ## _protocol __efi_protocol = { \
106  .guid = _protocol ## _GUID, \
107  .protocol = ( ( void ** ) ( void * ) \
108  ( ( (_ptr) == ( ( _protocol ** ) (_ptr) ) ) ? \
109  (_ptr) : (_ptr) ) ), \
110  .required = 0, \
111  }
112 
113 /** An EFI configuration table used by iPXE */
115  /** GUID */
117  /** Variable containing pointer to configuration table */
118  void **table;
119  /** Table is required for operation */
120  int required;
121 };
122 
123 /** EFI configuration table table */
124 #define EFI_CONFIG_TABLES \
125  __table ( struct efi_config_table, "efi_config_tables" )
126 
127 /** Declare an EFI configuration table used by iPXE */
128 #define __efi_config_table __table_entry ( EFI_CONFIG_TABLES, 01 )
129 
130 /** Declare an EFI configuration table to be used by iPXE
131  *
132  * @v _table EFI configuration table name
133  * @v _ptr Pointer to configuration table
134  * @v _required Table is required for operation
135  */
136 #define EFI_USE_TABLE( _table, _ptr, _required ) \
137  struct efi_config_table __ ## _table __efi_config_table = { \
138  .guid = _table ## _GUID, \
139  .table = ( ( void ** ) ( void * ) (_ptr) ), \
140  .required = (_required), \
141  }
142 
143 /**
144  * Convert an iPXE status code to an EFI status code
145  *
146  * @v rc iPXE status code
147  * @ret efirc EFI status code
148  */
149 #define EFIRC( rc ) ERRNO_TO_PLATFORM ( -(rc) )
150 
151 /**
152  * Convert an EFI status code to an iPXE status code
153  *
154  * @v efirc EFI status code
155  * @ret rc iPXE status code (before negation)
156  */
157 #define EEFI( efirc ) EPLATFORM ( EINFO_EPLATFORM, efirc )
158 
213 
216 
221 extern int efi_shutdown_in_progress;
222 
223 extern const __attribute__ (( pure )) char * efi_guid_ntoa ( EFI_GUID *guid );
224 extern const __attribute__ (( pure )) char *
226 extern const __attribute__ (( pure )) char *
227 efi_open_attributes_name ( unsigned int attributes );
228 extern const __attribute__ (( pure )) char *
230 extern const __attribute__ (( pure )) char *
232 
234 extern void dbg_efi_protocols ( EFI_HANDLE handle );
235 
236 #define DBG_EFI_OPENERS_IF( level, handle, protocol ) do { \
237  if ( DBG_ ## level ) { \
238  dbg_efi_openers ( handle, protocol ); \
239  } \
240  } while ( 0 )
241 
242 #define DBG_EFI_PROTOCOLS_IF( level, handle ) do { \
243  if ( DBG_ ## level ) { \
244  dbg_efi_protocols ( handle ); \
245  } \
246  } while ( 0 )
247 
248 #define DBGC_EFI_OPENERS_IF( level, id, ... ) do { \
249  DBG_AC_IF ( level, id ); \
250  DBG_EFI_OPENERS_IF ( level, __VA_ARGS__ ); \
251  DBG_DC_IF ( level ); \
252  } while ( 0 )
253 
254 #define DBGC_EFI_PROTOCOLS_IF( level, id, ... ) do { \
255  DBG_AC_IF ( level, id ); \
256  DBG_EFI_PROTOCOLS_IF ( level, __VA_ARGS__ ); \
257  DBG_DC_IF ( level ); \
258  } while ( 0 )
259 
260 #define DBGC_EFI_OPENERS( ... ) \
261  DBGC_EFI_OPENERS_IF ( LOG, ##__VA_ARGS__ )
262 #define DBGC_EFI_PROTOCOLS( ... ) \
263  DBGC_EFI_PROTOCOLS_IF ( LOG, ##__VA_ARGS__ )
264 
265 #define DBGC2_EFI_OPENERS( ... ) \
266  DBGC_EFI_OPENERS_IF ( EXTRA, ##__VA_ARGS__ )
267 #define DBGC2_EFI_PROTOCOLS( ... ) \
268  DBGC_EFI_PROTOCOLS_IF ( EXTRA, ##__VA_ARGS__ )
269 
270 #define DBGCP_EFI_OPENERS( ... ) \
271  DBGC_EFI_OPENERS_IF ( PROFILE, ##__VA_ARGS__ )
272 #define DBGCP_EFI_PROTOCOLS( ... ) \
273  DBGC_EFI_PROTOCOLS_IF ( PROFILE, ##__VA_ARGS__ )
274 
275 extern EFI_STATUS efi_init ( EFI_HANDLE image_handle,
276  EFI_SYSTEM_TABLE *systab );
277 
278 #endif /* _IPXE_EFI_H */
#define __attribute__(x)
Definition: compiler.h:10
void ** protocol
Variable containing pointer to protocol structure.
Definition: efi.h:74
EFI_GUID efi_pci_root_bridge_io_protocol_guid
PCI root bridge I/O protocol GUID.
Definition: efi_guid.c:220
EFI_GUID efi_mtftp4_service_binding_protocol_guid
MTFTPv4 service binding protocol GUID.
Definition: efi_guid.c:204
EFI_GUID efi_component_name2_protocol_guid
Component name 2 protocol GUID.
Definition: efi_guid.c:124
EFI_GUID efi_ip4_protocol_guid
IPv4 protocol GUID.
Definition: efi_guid.c:164
EFI_DEVICE_PATH_PROTOCOL * efi_loaded_image_path
EFI_GUID efi_block_io_protocol_guid
Block I/O protocol GUID.
Definition: efi_guid.c:108
#define EFI_HANDLE
Definition: efi.h:52
EFI_GUID efi_load_file2_protocol_guid
Load file 2 protocol GUID.
Definition: efi_guid.c:180
EFI_GUID efi_simple_file_system_protocol_guid
Simple file system protocol GUID.
Definition: efi_guid.c:232
128 bit buffer containing a unique identifier value.
Definition: Base.h:263
EFI_GUID efi_dhcp4_protocol_guid
DHCPv4 protocol GUID.
Definition: efi_guid.c:136
FILE_LICENCE(GPL2_OR_LATER_OR_UBDL)
const char * efi_guid_ntoa(EFI_GUID *guid)
Convert GUID to a printable string.
Definition: efi_debug.c:192
EFI_GUID efi_simple_pointer_protocol_guid
Simple pointer protocol GUID.
Definition: efi_guid.c:240
EFI_GUID efi_component_name_protocol_guid
Component name protocol GUID.
Definition: efi_guid.c:120
EFI_GUID guid
GUID.
Definition: efi.h:72
EFI_GUID efi_tcp4_service_binding_protocol_guid
TCPv4 service binding protocol GUID.
Definition: efi_guid.c:264
EFI_GUID efi_device_path_protocol_guid
Device path protocol GUID.
Definition: efi_guid.c:132
EFI_GUID efi_apple_net_boot_protocol_guid
Apple NetBoot protocol GUID.
Definition: efi_guid.c:96
EFI_GUID efi_loaded_image_protocol_guid
Loaded image protocol GUID.
Definition: efi_guid.c:184
EFI_GUID efi_acpi_table_protocol_guid
ACPI table protocol GUID.
Definition: efi_guid.c:92
const char * efi_locate_search_type_name(EFI_LOCATE_SEARCH_TYPE search_type)
Name locate search type.
Definition: efi_debug.c:225
Universally unique IDs.
void dbg_efi_openers(EFI_HANDLE handle, EFI_GUID *protocol)
Print list of openers of a given protocol on a given handle.
Definition: efi_debug.c:271
EFI_GUID efi_unicode_collation_protocol_guid
Unicode collation protocol GUID.
Definition: efi_guid.c:284
EFI_GUID efi_uga_draw_protocol_guid
UGA draw protocol GUID.
Definition: efi_guid.c:280
This protocol can be used on any device handle to obtain generic path/location information concerning...
Definition: DevicePath.h:51
EFI_GUID efi_load_file_protocol_guid
Load file protocol GUID.
Definition: efi_guid.c:176
EFI_LOADED_IMAGE_PROTOCOL * efi_loaded_image
Loaded image protocol for this image.
Definition: efi_init.c:33
Root include file for Mde Package DXE_CORE, DXE, RUNTIME, SMM, SAL type modules.
UEFI 2.0 Loaded image protocol definition.
An EFI configuration table used by iPXE.
Definition: efi.h:114
EFI_GUID efi_nii_protocol_guid
Network interface identifier protocol GUID (old version)
Definition: efi_guid.c:208
Can be used on any image handle to obtain information about the loaded image.
Definition: LoadedImage.h:51
EFI_GUID efi_block_io2_protocol_guid
Block I/O version 2 protocol GUID.
Definition: efi_guid.c:112
EFI_GUID efi_pxe_base_code_protocol_guid
PXE base code protocol GUID.
Definition: efi_guid.c:224
EFI_GUID efi_console_control_protocol_guid
Console control protocol GUID.
Definition: efi_guid.c:128
EFI_GUID efi_dhcp4_service_binding_protocol_guid
DHCPv4 service binding protocol GUID.
Definition: efi_guid.c:140
const char * efi_devpath_text(EFI_DEVICE_PATH_PROTOCOL *path)
Get textual representation of device path.
Definition: efi_debug.c:366
EFI_GUID efi_usb2_hc_protocol_guid
USB2 host controller protocol GUID.
Definition: efi_guid.c:292
EFI_GUID efi_usb_hc_protocol_guid
USB host controller protocol GUID.
Definition: efi_guid.c:288
EFI_GUID efi_simple_text_input_protocol_guid
Simple text input protocol GUID.
Definition: efi_guid.c:244
EFI_STATUS efi_init(EFI_HANDLE image_handle, EFI_SYSTEM_TABLE *systab)
Initialise EFI environment.
Definition: efi_init.c:97
An EFI protocol used by iPXE.
Definition: efi.h:70
EFI_GUID efi_simple_network_protocol_guid
Simple network protocol GUID.
Definition: efi_guid.c:236
EFI_GUID efi_simple_text_output_protocol_guid
Simple text output protocol GUID.
Definition: efi_guid.c:252
EFI_GUID efi_vlan_config_protocol_guid
VLAN configuration protocol GUID.
Definition: efi_guid.c:300
const char * efi_handle_name(EFI_HANDLE handle)
Get name of an EFI handle.
Definition: efi_debug.c:713
EFI_GUID efi_graphics_output_protocol_guid
Graphics output protocol GUID.
Definition: efi_guid.c:152
EFI_GUID efi_bus_specific_driver_override_protocol_guid
Bus specific driver override protocol GUID.
Definition: efi_guid.c:116
EFI_GUID efi_mtftp4_protocol_guid
MTFTPv4 protocol GUID.
Definition: efi_guid.c:200
Root include file for Mde Package UEFI, UEFI_APPLICATION type modules.
EFI_GUID efi_hii_font_protocol_guid
HII font protocol GUID.
Definition: efi_guid.c:160
EFI_GUID efi_simple_text_input_ex_protocol_guid
Simple text input extension protocol GUID.
Definition: efi_guid.c:248
EFI System Table.
Definition: UefiSpec.h:1949
EFI_GUID efi_arp_protocol_guid
ARP protocol GUID.
Definition: efi_guid.c:100
EFI_GUID efi_tcp4_protocol_guid
TCPv4 protocol GUID.
Definition: efi_guid.c:260
EFI_GUID efi_tree_protocol_guid
TrEE protocol GUID.
Definition: efi_guid.c:268
EFI_GUID efi_managed_network_protocol_guid
Managed network protocol GUID.
Definition: efi_guid.c:192
void ** table
Variable containing pointer to configuration table.
Definition: efi.h:118
uint64_t guid
GUID.
Definition: edd.h:30
int required
Protocol is required.
Definition: efi.h:76
EFI_GUID efi_arp_service_binding_protocol_guid
ARP service binding protocol GUID.
Definition: efi_guid.c:104
EFI_GUID efi_serial_io_protocol_guid
Serial I/O protocol GUID.
Definition: efi_guid.c:228
EFI_GUID efi_udp4_protocol_guid
UDPv4 protocol GUID.
Definition: efi_guid.c:272
EFI_GUID guid
GUID.
Definition: efi.h:116
const char * efi_open_attributes_name(unsigned int attributes)
Name protocol open attributes.
Definition: efi_debug.c:250
RETURN_STATUS EFI_STATUS
Function return status for EFI API.
Definition: UefiBaseType.h:35
EFI_GUID efi_nii31_protocol_guid
Network interface identifier protocol GUID (new version)
Definition: efi_guid.c:212
EFI_GUID efi_tcg_protocol_guid
TCG protocol GUID.
Definition: efi_guid.c:256
EFI_GUID efi_udp4_service_binding_protocol_guid
UDPv4 service binding protocol GUID.
Definition: efi_guid.c:276
Defines data types and constants introduced in UEFI.
int efi_shutdown_in_progress
EFI shutdown is in progress.
Definition: efi_init.c:45
Linker tables.
EFI_HANDLE efi_image_handle
Image handle passed to entry point.
Definition: efi_init.c:30
EFI_GUID efi_managed_network_service_binding_protocol_guid
Managed network service binding protocol GUID.
Definition: efi_guid.c:196
EFI_GUID efi_usb_io_protocol_guid
USB I/O protocol GUID.
Definition: efi_guid.c:296
EFI_GUID efi_file_system_info_id
File system information GUID.
Definition: efi_guid.c:306
EFI_GUID efi_absolute_pointer_protocol_guid
Absolute pointer protocol GUID.
Definition: efi_guid.c:88
EFI_GUID efi_hii_config_access_protocol_guid
HII configuration access protocol GUID.
Definition: efi_guid.c:156
EFI_SYSTEM_TABLE * efi_systab
uint16_t protocol
Protocol ID.
Definition: stp.h:18
EFI_GUID efi_loaded_image_device_path_protocol_guid
Loaded image device path protocol GUID.
Definition: efi_guid.c:188
EFI_LOCATE_SEARCH_TYPE
Enumeration of EFI Locate Search Types.
Definition: UefiSpec.h:1435
EFI_GUID efi_driver_binding_protocol_guid
Driver binding protocol GUID.
Definition: efi_guid.c:148
EFI_GUID efi_ip4_config_protocol_guid
IPv4 configuration protocol GUID.
Definition: efi_guid.c:168
EFI_GUID efi_pci_io_protocol_guid
PCI I/O protocol GUID.
Definition: efi_guid.c:216
int required
Table is required for operation.
Definition: efi.h:120
EFI_GUID efi_file_info_id
File information GUID.
Definition: efi_guid.c:303
uint16_t handle
Handle.
Definition: smbios.h:16
Definition: efi.h:55
EFI_GUID efi_ip4_service_binding_protocol_guid
IPv4 service binding protocol GUID.
Definition: efi_guid.c:172
EFI_GUID efi_disk_io_protocol_guid
Disk I/O protocol GUID.
Definition: efi_guid.c:144
void dbg_efi_protocols(EFI_HANDLE handle)
Print list of protocol handlers attached to a handle.
Definition: efi_debug.c:323