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 */
27 EFI_TIMER_PERIODIC = 1,
28 EFI_TIMER_RELATIVE = 2
31 #define EVT_TIMER 0x80000000
32 #define EVT_RUNTIME 0x40000000
33 #define EVT_NOTIFY_WAIT 0x00000100
34 #define EVT_NOTIFY_SIGNAL 0x00000200
35 #define EVT_SIGNAL_EXIT_BOOT_SERVICES 0x00000201
36 #define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE 0x60000202
38 #define TPL_APPLICATION 0x04
39 #define TPL_CALLBACK 0x08
40 #define TPL_NOTIFY 0x10
41 #define TPL_HIGH_LEVEL 0x1F
45 /* EFI Boot Services table */
46 struct efi_boot_services {
47 struct efi_table_hdr hdr;
48 efi_status_t (EFIAPI *raise_tpl)(unsigned long new_tpl);
49 void (EFIAPI *restore_tpl)(unsigned long old_tpl);
51 efi_status_t (EFIAPI *allocate_pages)(int, int, unsigned long,
52 efi_physical_addr_t *);
53 efi_status_t (EFIAPI *free_pages)(efi_physical_addr_t, unsigned long);
54 efi_status_t (EFIAPI *get_memory_map)(unsigned long *memory_map_size,
55 struct efi_mem_desc *desc, unsigned long *key,
56 unsigned long *desc_size, u32 *desc_version);
57 efi_status_t (EFIAPI *allocate_pool)(int, unsigned long, void **);
58 efi_status_t (EFIAPI *free_pool)(void *);
60 efi_status_t (EFIAPI *create_event)(enum efi_event_type type,
61 unsigned long notify_tpl,
62 void (EFIAPI *notify_function) (
63 struct efi_event *event,
65 void *notify_context, struct efi_event **event);
66 efi_status_t (EFIAPI *set_timer)(struct efi_event *event, int type,
67 uint64_t trigger_time);
68 efi_status_t (EFIAPI *wait_for_event)(unsigned long number_of_events,
69 struct efi_event **event, unsigned long *index);
70 efi_status_t (EFIAPI *signal_event)(struct efi_event *event);
71 efi_status_t (EFIAPI *close_event)(struct efi_event *event);
72 efi_status_t (EFIAPI *check_event)(struct efi_event *event);
73 #define EFI_NATIVE_INTERFACE 0x00000000
74 efi_status_t (EFIAPI *install_protocol_interface)(
75 void **handle, efi_guid_t *protocol,
76 int protocol_interface_type, void *protocol_interface);
77 efi_status_t (EFIAPI *reinstall_protocol_interface)(
78 void *handle, efi_guid_t *protocol,
79 void *old_interface, void *new_interface);
80 efi_status_t (EFIAPI *uninstall_protocol_interface)(void *handle,
81 efi_guid_t *protocol, void *protocol_interface);
82 efi_status_t (EFIAPI *handle_protocol)(efi_handle_t, efi_guid_t *,
85 efi_status_t (EFIAPI *register_protocol_notify)(
86 efi_guid_t *protocol, struct efi_event *event,
88 efi_status_t (EFIAPI *locate_handle)(
89 enum efi_locate_search_type search_type,
90 efi_guid_t *protocol, void *search_key,
91 unsigned long *buffer_size, efi_handle_t *buffer);
92 efi_status_t (EFIAPI *locate_device_path)(efi_guid_t *protocol,
93 struct efi_device_path **device_path,
94 efi_handle_t *device);
95 efi_status_t (EFIAPI *install_configuration_table)(
96 efi_guid_t *guid, void *table);
98 efi_status_t (EFIAPI *load_image)(bool boot_policiy,
99 efi_handle_t parent_image,
100 struct efi_device_path *file_path, void *source_buffer,
101 unsigned long source_size, efi_handle_t *image);
102 efi_status_t (EFIAPI *start_image)(efi_handle_t handle,
103 unsigned long *exitdata_size,
105 efi_status_t (EFIAPI *exit)(efi_handle_t handle,
106 efi_status_t exit_status,
107 unsigned long exitdata_size, s16 *exitdata);
108 efi_status_t (EFIAPI *unload_image)(void *image_handle);
109 efi_status_t (EFIAPI *exit_boot_services)(efi_handle_t, unsigned long);
111 efi_status_t (EFIAPI *get_next_monotonic_count)(u64 *count);
112 efi_status_t (EFIAPI *stall)(unsigned long usecs);
113 efi_status_t (EFIAPI *set_watchdog_timer)(unsigned long timeout,
114 uint64_t watchdog_code, unsigned long data_size,
115 uint16_t *watchdog_data);
116 efi_status_t(EFIAPI *connect_controller)(efi_handle_t controller_handle,
117 efi_handle_t *driver_image_handle,
118 struct efi_device_path *remaining_device_path,
120 efi_status_t (EFIAPI *disconnect_controller)(void *controller_handle,
121 void *driver_image_handle, void *child_handle);
122 #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001
123 #define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002
124 #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004
125 #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008
126 #define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010
127 #define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020
128 efi_status_t (EFIAPI *open_protocol)(efi_handle_t handle,
129 efi_guid_t *protocol, void **interface,
130 efi_handle_t agent_handle,
131 efi_handle_t controller_handle, u32 attributes);
132 efi_status_t (EFIAPI *close_protocol)(void *handle,
133 efi_guid_t *protocol, void *agent_handle,
134 void *controller_handle);
135 efi_status_t(EFIAPI *open_protocol_information)(efi_handle_t handle,
136 efi_guid_t *protocol,
137 struct efi_open_protocol_info_entry **entry_buffer,
138 unsigned long *entry_count);
139 efi_status_t (EFIAPI *protocols_per_handle)(efi_handle_t handle,
140 efi_guid_t ***protocol_buffer,
141 unsigned long *protocols_buffer_count);
142 efi_status_t (EFIAPI *locate_handle_buffer) (
143 enum efi_locate_search_type search_type,
144 efi_guid_t *protocol, void *search_key,
145 unsigned long *no_handles, efi_handle_t **buffer);
146 efi_status_t (EFIAPI *locate_protocol)(efi_guid_t *protocol,
147 void *registration, void **protocol_interface);
148 efi_status_t (EFIAPI *install_multiple_protocol_interfaces)(
150 efi_status_t (EFIAPI *uninstall_multiple_protocol_interfaces)(
152 efi_status_t (EFIAPI *calculate_crc32)(void *data,
153 unsigned long data_size, uint32_t *crc32);
154 void (EFIAPI *copy_mem)(void *destination, void *source,
155 unsigned long length);
156 void (EFIAPI *set_mem)(void *buffer, unsigned long size,
158 void *create_event_ex;
161 /* Types and defines for EFI ResetSystem */
162 enum efi_reset_type {
165 EFI_RESET_SHUTDOWN = 2
168 /* EFI Runtime Services table */
169 #define EFI_RUNTIME_SERVICES_SIGNATURE 0x5652453544e5552ULL
170 #define EFI_RUNTIME_SERVICES_REVISION 0x00010000
172 struct efi_runtime_services {
173 struct efi_table_hdr hdr;
174 efi_status_t (EFIAPI *get_time)(struct efi_time *time,
175 struct efi_time_cap *capabilities);
176 efi_status_t (EFIAPI *set_time)(struct efi_time *time);
177 efi_status_t (EFIAPI *get_wakeup_time)(char *enabled, char *pending,
178 struct efi_time *time);
179 efi_status_t (EFIAPI *set_wakeup_time)(char enabled,
180 struct efi_time *time);
181 efi_status_t (EFIAPI *set_virtual_address_map)(
182 unsigned long memory_map_size,
183 unsigned long descriptor_size,
184 uint32_t descriptor_version,
185 struct efi_mem_desc *virtmap);
186 efi_status_t (*convert_pointer)(unsigned long dbg, void **address);
187 efi_status_t (EFIAPI *get_variable)(s16 *variable_name,
188 efi_guid_t *vendor, u32 *attributes,
189 unsigned long *data_size, void *data);
190 efi_status_t (EFIAPI *get_next_variable)(
191 unsigned long *variable_name_size,
192 s16 *variable_name, efi_guid_t *vendor);
193 efi_status_t (EFIAPI *set_variable)(s16 *variable_name,
194 efi_guid_t *vendor, u32 attributes,
195 unsigned long data_size, void *data);
196 efi_status_t (EFIAPI *get_next_high_mono_count)(
197 uint32_t *high_count);
198 void (EFIAPI *reset_system)(enum efi_reset_type reset_type,
199 efi_status_t reset_status,
200 unsigned long data_size, void *reset_data);
201 void *update_capsule;
202 void *query_capsule_caps;
203 void *query_variable_info;
206 /* EFI Configuration Table and GUID definitions */
208 EFI_GUID(0x00000000, 0x0000, 0x0000, 0x00, 0x00, \
209 0x00, 0x00, 0x00, 0x00, 0x00, 0x00)
211 #define LOADED_IMAGE_PROTOCOL_GUID \
212 EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, \
213 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
215 #define EFI_FDT_GUID \
216 EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5, \
217 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0)
219 #define SMBIOS_TABLE_GUID \
220 EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3, \
221 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
223 struct efi_configuration_table
229 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
231 struct efi_system_table {
232 struct efi_table_hdr hdr;
233 unsigned long fw_vendor; /* physical addr of wchar_t vendor string */
235 unsigned long con_in_handle;
236 struct efi_simple_input_interface *con_in;
237 unsigned long con_out_handle;
238 struct efi_simple_text_output_protocol *con_out;
239 unsigned long stderr_handle;
240 struct efi_simple_text_output_protocol *std_err;
241 struct efi_runtime_services *runtime;
242 struct efi_boot_services *boottime;
243 unsigned long nr_tables;
244 struct efi_configuration_table *tables;
247 #define LOADED_IMAGE_GUID \
248 EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, \
249 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
251 struct efi_loaded_image {
254 struct efi_system_table *system_table;
258 u32 load_options_size;
261 aligned_u64 image_size;
262 unsigned int image_code_type;
263 unsigned int image_data_type;
264 unsigned long unload;
266 /* Below are efi loader private fields */
267 #ifdef CONFIG_EFI_LOADER
268 efi_status_t exit_status;
269 struct jmp_buf_data exit_jmp;
273 #define DEVICE_PATH_GUID \
274 EFI_GUID(0x09576e91, 0x6d3f, 0x11d2, \
275 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
277 #define DEVICE_PATH_TYPE_END 0x7f
278 # define DEVICE_PATH_SUB_TYPE_END 0xff
280 struct efi_device_path {
286 struct efi_mac_addr {
290 #define DEVICE_PATH_TYPE_MESSAGING_DEVICE 0x03
291 # define DEVICE_PATH_SUB_TYPE_MSG_MAC_ADDR 0x0b
293 struct efi_device_path_mac_addr {
294 struct efi_device_path dp;
295 struct efi_mac_addr mac;
299 #define DEVICE_PATH_TYPE_MEDIA_DEVICE 0x04
300 # define DEVICE_PATH_SUB_TYPE_FILE_PATH 0x04
302 struct efi_device_path_file_path {
303 struct efi_device_path dp;
307 #define BLOCK_IO_GUID \
308 EFI_GUID(0x964e5b21, 0x6459, 0x11d2, \
309 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
311 struct efi_block_io_media
314 char removable_media;
316 char logical_partition;
326 struct efi_block_io {
328 struct efi_block_io_media *media;
329 efi_status_t (EFIAPI *reset)(struct efi_block_io *this,
330 char extended_verification);
331 efi_status_t (EFIAPI *read_blocks)(struct efi_block_io *this,
332 u32 media_id, u64 lba, unsigned long buffer_size,
334 efi_status_t (EFIAPI *write_blocks)(struct efi_block_io *this,
335 u32 media_id, u64 lba, unsigned long buffer_size,
337 efi_status_t (EFIAPI *flush_blocks)(struct efi_block_io *this);
340 struct simple_text_output_mode {
349 struct efi_simple_text_output_protocol {
351 efi_status_t (EFIAPI *output_string)(
352 struct efi_simple_text_output_protocol *this,
353 const unsigned short *str);
354 efi_status_t (EFIAPI *test_string)(
355 struct efi_simple_text_output_protocol *this,
356 const unsigned short *str);
357 efi_status_t(EFIAPI *query_mode)(
358 struct efi_simple_text_output_protocol *this,
359 unsigned long mode_number, unsigned long *columns,
360 unsigned long *rows);
361 efi_status_t(EFIAPI *set_mode)(
362 struct efi_simple_text_output_protocol *this,
363 unsigned long mode_number);
364 efi_status_t(EFIAPI *set_attribute)(
365 struct efi_simple_text_output_protocol *this,
366 unsigned long attribute);
367 efi_status_t(EFIAPI *clear_screen) (
368 struct efi_simple_text_output_protocol *this);
369 efi_status_t(EFIAPI *set_cursor_position) (
370 struct efi_simple_text_output_protocol *this,
371 unsigned long column, unsigned long row);
372 efi_status_t(EFIAPI *enable_cursor)(
373 struct efi_simple_text_output_protocol *this,
375 struct simple_text_output_mode *mode;
378 struct efi_input_key {
383 struct efi_simple_input_interface {
384 efi_status_t(EFIAPI *reset)(struct efi_simple_input_interface *this,
385 bool ExtendedVerification);
386 efi_status_t(EFIAPI *read_key_stroke)(
387 struct efi_simple_input_interface *this,
388 struct efi_input_key *key);
389 struct efi_event *wait_for_key;
392 #define CONSOLE_CONTROL_GUID \
393 EFI_GUID(0xf42f7782, 0x12e, 0x4c12, \
394 0x99, 0x56, 0x49, 0xf9, 0x43, 0x4, 0xf7, 0x21)
395 #define EFI_CONSOLE_MODE_TEXT 0
396 #define EFI_CONSOLE_MODE_GFX 1
398 struct efi_console_control_protocol
400 efi_status_t (EFIAPI *get_mode)(
401 struct efi_console_control_protocol *this, int *mode,
402 char *uga_exists, char *std_in_locked);
403 efi_status_t (EFIAPI *set_mode)(
404 struct efi_console_control_protocol *this, int mode);
405 efi_status_t (EFIAPI *lock_std_in)(
406 struct efi_console_control_protocol *this,
410 #define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID \
411 EFI_GUID(0x8b843e20, 0x8132, 0x4852, \
412 0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c)
414 struct efi_device_path_protocol
422 struct efi_device_path_to_text_protocol
424 uint16_t *(EFIAPI *convert_device_node_to_text)(
425 struct efi_device_path_protocol *device_node,
427 bool allow_shortcuts);
428 uint16_t *(EFIAPI *convert_device_path_to_text)(
429 struct efi_device_path_protocol *device_path,
431 bool allow_shortcuts);
434 #define EFI_GOP_GUID \
435 EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, \
436 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
438 #define EFI_GOT_RGBA8 0
439 #define EFI_GOT_BGRA8 1
440 #define EFI_GOT_BITMASK 2
442 struct efi_gop_mode_info
448 u32 pixel_bitmask[4];
449 u32 pixels_per_scanline;
456 struct efi_gop_mode_info *info;
457 unsigned long info_size;
458 efi_physical_addr_t fb_base;
459 unsigned long fb_size;
462 #define EFI_BLT_VIDEO_FILL 0
463 #define EFI_BLT_VIDEO_TO_BLT_BUFFER 1
464 #define EFI_BLT_BUFFER_TO_VIDEO 2
465 #define EFI_BLT_VIDEO_TO_VIDEO 3
469 efi_status_t (EFIAPI *query_mode)(struct efi_gop *this, u32 mode_number,
470 unsigned long *size_of_info,
471 struct efi_gop_mode_info **info);
472 efi_status_t (EFIAPI *set_mode)(struct efi_gop *this, u32 mode_number);
473 efi_status_t (EFIAPI *blt)(struct efi_gop *this, void *buffer,
474 unsigned long operation, unsigned long sx,
475 unsigned long sy, unsigned long dx,
476 unsigned long dy, unsigned long width,
477 unsigned long height, unsigned long delta);
478 struct efi_gop_mode *mode;
481 #define EFI_SIMPLE_NETWORK_GUID \
482 EFI_GUID(0xa19832b9, 0xac25, 0x11d3, \
483 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
485 struct efi_mac_address {
489 struct efi_ip_address {
493 enum efi_simple_network_state {
496 EFI_NETWORK_INITIALIZED,
499 struct efi_simple_network_mode {
500 enum efi_simple_network_state state;
502 u32 media_header_size;
505 u32 nvram_access_size;
506 u32 receive_filter_mask;
507 u32 receive_filter_setting;
508 u32 max_mcast_filter_count;
509 u32 mcast_filter_count;
510 struct efi_mac_address mcast_filter[16];
511 struct efi_mac_address current_address;
512 struct efi_mac_address broadcast_address;
513 struct efi_mac_address permanent_address;
516 u8 multitx_supported;
517 u8 media_present_supported;
521 #define EFI_SIMPLE_NETWORK_RECEIVE_UNICAST 0x01,
522 #define EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST 0x02,
523 #define EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST 0x04,
524 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS 0x08,
525 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST 0x10,
527 struct efi_simple_network
530 efi_status_t (EFIAPI *start)(struct efi_simple_network *this);
531 efi_status_t (EFIAPI *stop)(struct efi_simple_network *this);
532 efi_status_t (EFIAPI *initialize)(struct efi_simple_network *this,
533 ulong extra_rx, ulong extra_tx);
534 efi_status_t (EFIAPI *reset)(struct efi_simple_network *this,
535 int extended_verification);
536 efi_status_t (EFIAPI *shutdown)(struct efi_simple_network *this);
537 efi_status_t (EFIAPI *receive_filters)(struct efi_simple_network *this,
538 u32 enable, u32 disable, int reset_mcast_filter,
539 ulong mcast_filter_count,
540 struct efi_mac_address *mcast_filter);
541 efi_status_t (EFIAPI *station_address)(struct efi_simple_network *this,
542 int reset, struct efi_mac_address *new_mac);
543 efi_status_t (EFIAPI *statistics)(struct efi_simple_network *this,
544 int reset, ulong *stat_size, void *stat_table);
545 efi_status_t (EFIAPI *mcastiptomac)(struct efi_simple_network *this,
546 int ipv6, struct efi_ip_address *ip,
547 struct efi_mac_address *mac);
548 efi_status_t (EFIAPI *nvdata)(struct efi_simple_network *this,
549 int read_write, ulong offset, ulong buffer_size,
551 efi_status_t (EFIAPI *get_status)(struct efi_simple_network *this,
552 u32 *int_status, void **txbuf);
553 efi_status_t (EFIAPI *transmit)(struct efi_simple_network *this,
554 ulong header_size, ulong buffer_size, void *buffer,
555 struct efi_mac_address *src_addr,
556 struct efi_mac_address *dest_addr, u16 *protocol);
557 efi_status_t (EFIAPI *receive)(struct efi_simple_network *this,
558 ulong *header_size, ulong *buffer_size, void *buffer,
559 struct efi_mac_address *src_addr,
560 struct efi_mac_address *dest_addr, u16 *protocol);
561 void (EFIAPI *waitforpacket)(void);
562 struct efi_simple_network_mode *mode;
565 #define EFI_PXE_GUID \
566 EFI_GUID(0x03c4e603, 0xac28, 0x11d3, \
567 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
569 struct efi_pxe_packet {
576 struct efi_pxe_packet dhcp_discover;
577 struct efi_pxe_packet dhcp_ack;
578 struct efi_pxe_packet proxy_offer;
579 struct efi_pxe_packet pxe_discover;
580 struct efi_pxe_packet pxe_reply;
585 void (EFIAPI *start)(void);
586 void (EFIAPI *stop)(void);
587 void (EFIAPI *dhcp)(void);
588 void (EFIAPI *discover)(void);
589 void (EFIAPI *mftp)(void);
590 void (EFIAPI *udpwrite)(void);
591 void (EFIAPI *udpread)(void);
592 void (EFIAPI *setipfilter)(void);
593 void (EFIAPI *arp)(void);
594 void (EFIAPI *setparams)(void);
595 void (EFIAPI *setstationip)(void);
596 void (EFIAPI *setpackets)(void);
597 struct efi_pxe_mode *mode;