2 * Extensible Firmware Interface
3 * Based on 'Extensible Firmware Interface Specification' version 0.9,
6 * Copyright (C) 1999 VA Linux Systems
7 * Copyright (C) 1999 Walt Drummond <drummond@valinux.com>
8 * Copyright (C) 1999, 2002-2003 Hewlett-Packard Co.
9 * David Mosberger-Tang <davidm@hpl.hp.com>
10 * Stephane Eranian <eranian@hpl.hp.com>
12 * From include/linux/efi.h in kernel 4.1 with some additions/subtractions
20 #ifdef CONFIG_EFI_LOADER
21 #include <asm/setjmp.h>
24 /* Types and defines for EFI CreateEvent */
25 enum efi_timer_delay {
27 EFI_TIMER_PERIODIC = 1,
28 EFI_TIMER_RELATIVE = 2
33 #define EVT_TIMER 0x80000000
34 #define EVT_RUNTIME 0x40000000
35 #define EVT_NOTIFY_WAIT 0x00000100
36 #define EVT_NOTIFY_SIGNAL 0x00000200
37 #define EVT_SIGNAL_EXIT_BOOT_SERVICES 0x00000201
38 #define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE 0x60000202
40 #define TPL_APPLICATION 0x04
41 #define TPL_CALLBACK 0x08
42 #define TPL_NOTIFY 0x10
43 #define TPL_HIGH_LEVEL 0x1F
47 /* EFI Boot Services table */
48 struct efi_boot_services {
49 struct efi_table_hdr hdr;
50 efi_status_t (EFIAPI *raise_tpl)(UINTN new_tpl);
51 void (EFIAPI *restore_tpl)(UINTN old_tpl);
53 efi_status_t (EFIAPI *allocate_pages)(int, int, unsigned long,
54 efi_physical_addr_t *);
55 efi_status_t (EFIAPI *free_pages)(efi_physical_addr_t, unsigned long);
56 efi_status_t (EFIAPI *get_memory_map)(unsigned long *memory_map_size,
57 struct efi_mem_desc *desc, unsigned long *key,
58 unsigned long *desc_size, u32 *desc_version);
59 efi_status_t (EFIAPI *allocate_pool)(int, unsigned long, void **);
60 efi_status_t (EFIAPI *free_pool)(void *);
62 efi_status_t (EFIAPI *create_event)(uint32_t type,
64 void (EFIAPI *notify_function) (
65 struct efi_event *event,
67 void *notify_context, struct efi_event **event);
68 efi_status_t (EFIAPI *set_timer)(struct efi_event *event,
69 enum efi_timer_delay type,
70 uint64_t trigger_time);
71 efi_status_t (EFIAPI *wait_for_event)(unsigned long number_of_events,
72 struct efi_event **event, unsigned long *index);
73 efi_status_t (EFIAPI *signal_event)(struct efi_event *event);
74 efi_status_t (EFIAPI *close_event)(struct efi_event *event);
75 efi_status_t (EFIAPI *check_event)(struct efi_event *event);
76 #define EFI_NATIVE_INTERFACE 0x00000000
77 efi_status_t (EFIAPI *install_protocol_interface)(
78 void **handle, efi_guid_t *protocol,
79 int protocol_interface_type, void *protocol_interface);
80 efi_status_t (EFIAPI *reinstall_protocol_interface)(
81 void *handle, efi_guid_t *protocol,
82 void *old_interface, void *new_interface);
83 efi_status_t (EFIAPI *uninstall_protocol_interface)(void *handle,
84 efi_guid_t *protocol, void *protocol_interface);
85 efi_status_t (EFIAPI *handle_protocol)(efi_handle_t, efi_guid_t *,
88 efi_status_t (EFIAPI *register_protocol_notify)(
89 efi_guid_t *protocol, struct efi_event *event,
91 efi_status_t (EFIAPI *locate_handle)(
92 enum efi_locate_search_type search_type,
93 efi_guid_t *protocol, void *search_key,
94 unsigned long *buffer_size, efi_handle_t *buffer);
95 efi_status_t (EFIAPI *locate_device_path)(efi_guid_t *protocol,
96 struct efi_device_path **device_path,
97 efi_handle_t *device);
98 efi_status_t (EFIAPI *install_configuration_table)(
99 efi_guid_t *guid, void *table);
101 efi_status_t (EFIAPI *load_image)(bool boot_policiy,
102 efi_handle_t parent_image,
103 struct efi_device_path *file_path, void *source_buffer,
104 unsigned long source_size, efi_handle_t *image);
105 efi_status_t (EFIAPI *start_image)(efi_handle_t handle,
106 unsigned long *exitdata_size,
108 efi_status_t (EFIAPI *exit)(efi_handle_t handle,
109 efi_status_t exit_status,
110 unsigned long exitdata_size, s16 *exitdata);
111 efi_status_t (EFIAPI *unload_image)(void *image_handle);
112 efi_status_t (EFIAPI *exit_boot_services)(efi_handle_t, unsigned long);
114 efi_status_t (EFIAPI *get_next_monotonic_count)(u64 *count);
115 efi_status_t (EFIAPI *stall)(unsigned long usecs);
116 efi_status_t (EFIAPI *set_watchdog_timer)(unsigned long timeout,
117 uint64_t watchdog_code, unsigned long data_size,
118 uint16_t *watchdog_data);
119 efi_status_t(EFIAPI *connect_controller)(efi_handle_t controller_handle,
120 efi_handle_t *driver_image_handle,
121 struct efi_device_path *remaining_device_path,
123 efi_status_t (EFIAPI *disconnect_controller)(void *controller_handle,
124 void *driver_image_handle, void *child_handle);
125 #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001
126 #define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002
127 #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004
128 #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008
129 #define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010
130 #define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020
131 efi_status_t (EFIAPI *open_protocol)(efi_handle_t handle,
132 efi_guid_t *protocol, void **interface,
133 efi_handle_t agent_handle,
134 efi_handle_t controller_handle, u32 attributes);
135 efi_status_t (EFIAPI *close_protocol)(void *handle,
136 efi_guid_t *protocol, void *agent_handle,
137 void *controller_handle);
138 efi_status_t(EFIAPI *open_protocol_information)(efi_handle_t handle,
139 efi_guid_t *protocol,
140 struct efi_open_protocol_info_entry **entry_buffer,
141 unsigned long *entry_count);
142 efi_status_t (EFIAPI *protocols_per_handle)(efi_handle_t handle,
143 efi_guid_t ***protocol_buffer,
144 unsigned long *protocols_buffer_count);
145 efi_status_t (EFIAPI *locate_handle_buffer) (
146 enum efi_locate_search_type search_type,
147 efi_guid_t *protocol, void *search_key,
148 unsigned long *no_handles, efi_handle_t **buffer);
149 efi_status_t (EFIAPI *locate_protocol)(efi_guid_t *protocol,
150 void *registration, void **protocol_interface);
151 efi_status_t (EFIAPI *install_multiple_protocol_interfaces)(
153 efi_status_t (EFIAPI *uninstall_multiple_protocol_interfaces)(
155 efi_status_t (EFIAPI *calculate_crc32)(void *data,
156 unsigned long data_size, uint32_t *crc32);
157 void (EFIAPI *copy_mem)(void *destination, void *source,
158 unsigned long length);
159 void (EFIAPI *set_mem)(void *buffer, unsigned long size,
161 void *create_event_ex;
164 /* Types and defines for EFI ResetSystem */
165 enum efi_reset_type {
168 EFI_RESET_SHUTDOWN = 2
171 /* EFI Runtime Services table */
172 #define EFI_RUNTIME_SERVICES_SIGNATURE 0x5652453544e5552ULL
173 #define EFI_RUNTIME_SERVICES_REVISION 0x00010000
175 struct efi_runtime_services {
176 struct efi_table_hdr hdr;
177 efi_status_t (EFIAPI *get_time)(struct efi_time *time,
178 struct efi_time_cap *capabilities);
179 efi_status_t (EFIAPI *set_time)(struct efi_time *time);
180 efi_status_t (EFIAPI *get_wakeup_time)(char *enabled, char *pending,
181 struct efi_time *time);
182 efi_status_t (EFIAPI *set_wakeup_time)(char enabled,
183 struct efi_time *time);
184 efi_status_t (EFIAPI *set_virtual_address_map)(
185 unsigned long memory_map_size,
186 unsigned long descriptor_size,
187 uint32_t descriptor_version,
188 struct efi_mem_desc *virtmap);
189 efi_status_t (*convert_pointer)(unsigned long dbg, void **address);
190 efi_status_t (EFIAPI *get_variable)(s16 *variable_name,
191 efi_guid_t *vendor, u32 *attributes,
192 unsigned long *data_size, void *data);
193 efi_status_t (EFIAPI *get_next_variable)(
194 unsigned long *variable_name_size,
195 s16 *variable_name, efi_guid_t *vendor);
196 efi_status_t (EFIAPI *set_variable)(s16 *variable_name,
197 efi_guid_t *vendor, u32 attributes,
198 unsigned long data_size, void *data);
199 efi_status_t (EFIAPI *get_next_high_mono_count)(
200 uint32_t *high_count);
201 void (EFIAPI *reset_system)(enum efi_reset_type reset_type,
202 efi_status_t reset_status,
203 unsigned long data_size, void *reset_data);
204 void *update_capsule;
205 void *query_capsule_caps;
206 void *query_variable_info;
209 /* EFI Configuration Table and GUID definitions */
211 EFI_GUID(0x00000000, 0x0000, 0x0000, 0x00, 0x00, \
212 0x00, 0x00, 0x00, 0x00, 0x00, 0x00)
214 #define LOADED_IMAGE_PROTOCOL_GUID \
215 EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, \
216 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
218 #define EFI_FDT_GUID \
219 EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5, \
220 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0)
222 #define SMBIOS_TABLE_GUID \
223 EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3, \
224 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
226 struct efi_configuration_table
232 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
234 struct efi_system_table {
235 struct efi_table_hdr hdr;
236 unsigned long fw_vendor; /* physical addr of wchar_t vendor string */
238 unsigned long con_in_handle;
239 struct efi_simple_input_interface *con_in;
240 unsigned long con_out_handle;
241 struct efi_simple_text_output_protocol *con_out;
242 unsigned long stderr_handle;
243 struct efi_simple_text_output_protocol *std_err;
244 struct efi_runtime_services *runtime;
245 struct efi_boot_services *boottime;
246 unsigned long nr_tables;
247 struct efi_configuration_table *tables;
250 #define LOADED_IMAGE_GUID \
251 EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, \
252 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
254 struct efi_loaded_image {
257 struct efi_system_table *system_table;
261 u32 load_options_size;
264 aligned_u64 image_size;
265 unsigned int image_code_type;
266 unsigned int image_data_type;
267 unsigned long unload;
269 /* Below are efi loader private fields */
270 #ifdef CONFIG_EFI_LOADER
271 efi_status_t exit_status;
272 struct jmp_buf_data exit_jmp;
276 #define DEVICE_PATH_GUID \
277 EFI_GUID(0x09576e91, 0x6d3f, 0x11d2, \
278 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
280 #define DEVICE_PATH_TYPE_END 0x7f
281 # define DEVICE_PATH_SUB_TYPE_END 0xff
283 struct efi_device_path {
289 struct efi_mac_addr {
293 #define DEVICE_PATH_TYPE_MESSAGING_DEVICE 0x03
294 # define DEVICE_PATH_SUB_TYPE_MSG_MAC_ADDR 0x0b
296 struct efi_device_path_mac_addr {
297 struct efi_device_path dp;
298 struct efi_mac_addr mac;
302 #define DEVICE_PATH_TYPE_MEDIA_DEVICE 0x04
303 # define DEVICE_PATH_SUB_TYPE_FILE_PATH 0x04
305 struct efi_device_path_file_path {
306 struct efi_device_path dp;
310 #define BLOCK_IO_GUID \
311 EFI_GUID(0x964e5b21, 0x6459, 0x11d2, \
312 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
314 struct efi_block_io_media
317 char removable_media;
319 char logical_partition;
329 struct efi_block_io {
331 struct efi_block_io_media *media;
332 efi_status_t (EFIAPI *reset)(struct efi_block_io *this,
333 char extended_verification);
334 efi_status_t (EFIAPI *read_blocks)(struct efi_block_io *this,
335 u32 media_id, u64 lba, unsigned long buffer_size,
337 efi_status_t (EFIAPI *write_blocks)(struct efi_block_io *this,
338 u32 media_id, u64 lba, unsigned long buffer_size,
340 efi_status_t (EFIAPI *flush_blocks)(struct efi_block_io *this);
343 struct simple_text_output_mode {
353 #define EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID \
354 EFI_GUID(0x387477c2, 0x69c7, 0x11d2, \
355 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
357 struct efi_simple_text_output_protocol {
359 efi_status_t (EFIAPI *output_string)(
360 struct efi_simple_text_output_protocol *this,
361 const unsigned short *str);
362 efi_status_t (EFIAPI *test_string)(
363 struct efi_simple_text_output_protocol *this,
364 const unsigned short *str);
365 efi_status_t(EFIAPI *query_mode)(
366 struct efi_simple_text_output_protocol *this,
367 unsigned long mode_number, unsigned long *columns,
368 unsigned long *rows);
369 efi_status_t(EFIAPI *set_mode)(
370 struct efi_simple_text_output_protocol *this,
371 unsigned long mode_number);
372 efi_status_t(EFIAPI *set_attribute)(
373 struct efi_simple_text_output_protocol *this,
374 unsigned long attribute);
375 efi_status_t(EFIAPI *clear_screen) (
376 struct efi_simple_text_output_protocol *this);
377 efi_status_t(EFIAPI *set_cursor_position) (
378 struct efi_simple_text_output_protocol *this,
379 unsigned long column, unsigned long row);
380 efi_status_t(EFIAPI *enable_cursor)(
381 struct efi_simple_text_output_protocol *this,
383 struct simple_text_output_mode *mode;
386 struct efi_input_key {
391 #define EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID \
392 EFI_GUID(0x387477c1, 0x69c7, 0x11d2, \
393 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
395 struct efi_simple_input_interface {
396 efi_status_t(EFIAPI *reset)(struct efi_simple_input_interface *this,
397 bool ExtendedVerification);
398 efi_status_t(EFIAPI *read_key_stroke)(
399 struct efi_simple_input_interface *this,
400 struct efi_input_key *key);
401 struct efi_event *wait_for_key;
404 #define CONSOLE_CONTROL_GUID \
405 EFI_GUID(0xf42f7782, 0x12e, 0x4c12, \
406 0x99, 0x56, 0x49, 0xf9, 0x43, 0x4, 0xf7, 0x21)
407 #define EFI_CONSOLE_MODE_TEXT 0
408 #define EFI_CONSOLE_MODE_GFX 1
410 struct efi_console_control_protocol
412 efi_status_t (EFIAPI *get_mode)(
413 struct efi_console_control_protocol *this, int *mode,
414 char *uga_exists, char *std_in_locked);
415 efi_status_t (EFIAPI *set_mode)(
416 struct efi_console_control_protocol *this, int mode);
417 efi_status_t (EFIAPI *lock_std_in)(
418 struct efi_console_control_protocol *this,
422 #define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID \
423 EFI_GUID(0x8b843e20, 0x8132, 0x4852, \
424 0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c)
426 struct efi_device_path_protocol
434 struct efi_device_path_to_text_protocol
436 uint16_t *(EFIAPI *convert_device_node_to_text)(
437 struct efi_device_path_protocol *device_node,
439 bool allow_shortcuts);
440 uint16_t *(EFIAPI *convert_device_path_to_text)(
441 struct efi_device_path_protocol *device_path,
443 bool allow_shortcuts);
446 #define EFI_GOP_GUID \
447 EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, \
448 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
450 #define EFI_GOT_RGBA8 0
451 #define EFI_GOT_BGRA8 1
452 #define EFI_GOT_BITMASK 2
454 struct efi_gop_mode_info
460 u32 pixel_bitmask[4];
461 u32 pixels_per_scanline;
468 struct efi_gop_mode_info *info;
469 unsigned long info_size;
470 efi_physical_addr_t fb_base;
471 unsigned long fb_size;
474 #define EFI_BLT_VIDEO_FILL 0
475 #define EFI_BLT_VIDEO_TO_BLT_BUFFER 1
476 #define EFI_BLT_BUFFER_TO_VIDEO 2
477 #define EFI_BLT_VIDEO_TO_VIDEO 3
481 efi_status_t (EFIAPI *query_mode)(struct efi_gop *this, u32 mode_number,
482 unsigned long *size_of_info,
483 struct efi_gop_mode_info **info);
484 efi_status_t (EFIAPI *set_mode)(struct efi_gop *this, u32 mode_number);
485 efi_status_t (EFIAPI *blt)(struct efi_gop *this, void *buffer,
486 unsigned long operation, unsigned long sx,
487 unsigned long sy, unsigned long dx,
488 unsigned long dy, unsigned long width,
489 unsigned long height, unsigned long delta);
490 struct efi_gop_mode *mode;
493 #define EFI_SIMPLE_NETWORK_GUID \
494 EFI_GUID(0xa19832b9, 0xac25, 0x11d3, \
495 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
497 struct efi_mac_address {
501 struct efi_ip_address {
505 enum efi_simple_network_state {
508 EFI_NETWORK_INITIALIZED,
511 struct efi_simple_network_mode {
512 enum efi_simple_network_state state;
514 u32 media_header_size;
517 u32 nvram_access_size;
518 u32 receive_filter_mask;
519 u32 receive_filter_setting;
520 u32 max_mcast_filter_count;
521 u32 mcast_filter_count;
522 struct efi_mac_address mcast_filter[16];
523 struct efi_mac_address current_address;
524 struct efi_mac_address broadcast_address;
525 struct efi_mac_address permanent_address;
528 u8 multitx_supported;
529 u8 media_present_supported;
533 #define EFI_SIMPLE_NETWORK_RECEIVE_UNICAST 0x01,
534 #define EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST 0x02,
535 #define EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST 0x04,
536 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS 0x08,
537 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST 0x10,
539 struct efi_simple_network
542 efi_status_t (EFIAPI *start)(struct efi_simple_network *this);
543 efi_status_t (EFIAPI *stop)(struct efi_simple_network *this);
544 efi_status_t (EFIAPI *initialize)(struct efi_simple_network *this,
545 ulong extra_rx, ulong extra_tx);
546 efi_status_t (EFIAPI *reset)(struct efi_simple_network *this,
547 int extended_verification);
548 efi_status_t (EFIAPI *shutdown)(struct efi_simple_network *this);
549 efi_status_t (EFIAPI *receive_filters)(struct efi_simple_network *this,
550 u32 enable, u32 disable, int reset_mcast_filter,
551 ulong mcast_filter_count,
552 struct efi_mac_address *mcast_filter);
553 efi_status_t (EFIAPI *station_address)(struct efi_simple_network *this,
554 int reset, struct efi_mac_address *new_mac);
555 efi_status_t (EFIAPI *statistics)(struct efi_simple_network *this,
556 int reset, ulong *stat_size, void *stat_table);
557 efi_status_t (EFIAPI *mcastiptomac)(struct efi_simple_network *this,
558 int ipv6, struct efi_ip_address *ip,
559 struct efi_mac_address *mac);
560 efi_status_t (EFIAPI *nvdata)(struct efi_simple_network *this,
561 int read_write, ulong offset, ulong buffer_size,
563 efi_status_t (EFIAPI *get_status)(struct efi_simple_network *this,
564 u32 *int_status, void **txbuf);
565 efi_status_t (EFIAPI *transmit)(struct efi_simple_network *this,
566 ulong header_size, ulong buffer_size, void *buffer,
567 struct efi_mac_address *src_addr,
568 struct efi_mac_address *dest_addr, u16 *protocol);
569 efi_status_t (EFIAPI *receive)(struct efi_simple_network *this,
570 ulong *header_size, ulong *buffer_size, void *buffer,
571 struct efi_mac_address *src_addr,
572 struct efi_mac_address *dest_addr, u16 *protocol);
573 void (EFIAPI *waitforpacket)(void);
574 struct efi_simple_network_mode *mode;
577 #define EFI_PXE_GUID \
578 EFI_GUID(0x03c4e603, 0xac28, 0x11d3, \
579 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
581 struct efi_pxe_packet {
588 struct efi_pxe_packet dhcp_discover;
589 struct efi_pxe_packet dhcp_ack;
590 struct efi_pxe_packet proxy_offer;
591 struct efi_pxe_packet pxe_discover;
592 struct efi_pxe_packet pxe_reply;
597 void (EFIAPI *start)(void);
598 void (EFIAPI *stop)(void);
599 void (EFIAPI *dhcp)(void);
600 void (EFIAPI *discover)(void);
601 void (EFIAPI *mftp)(void);
602 void (EFIAPI *udpwrite)(void);
603 void (EFIAPI *udpread)(void);
604 void (EFIAPI *setipfilter)(void);
605 void (EFIAPI *arp)(void);
606 void (EFIAPI *setparams)(void);
607 void (EFIAPI *setstationip)(void);
608 void (EFIAPI *setpackets)(void);
609 struct efi_pxe_mode *mode;