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
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)(enum efi_event_type 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, int type,
69 uint64_t trigger_time);
70 efi_status_t (EFIAPI *wait_for_event)(unsigned long number_of_events,
71 struct efi_event **event, unsigned long *index);
72 efi_status_t (EFIAPI *signal_event)(struct efi_event *event);
73 efi_status_t (EFIAPI *close_event)(struct efi_event *event);
74 efi_status_t (EFIAPI *check_event)(struct efi_event *event);
75 #define EFI_NATIVE_INTERFACE 0x00000000
76 efi_status_t (EFIAPI *install_protocol_interface)(
77 void **handle, efi_guid_t *protocol,
78 int protocol_interface_type, void *protocol_interface);
79 efi_status_t (EFIAPI *reinstall_protocol_interface)(
80 void *handle, efi_guid_t *protocol,
81 void *old_interface, void *new_interface);
82 efi_status_t (EFIAPI *uninstall_protocol_interface)(void *handle,
83 efi_guid_t *protocol, void *protocol_interface);
84 efi_status_t (EFIAPI *handle_protocol)(efi_handle_t, efi_guid_t *,
87 efi_status_t (EFIAPI *register_protocol_notify)(
88 efi_guid_t *protocol, struct efi_event *event,
90 efi_status_t (EFIAPI *locate_handle)(
91 enum efi_locate_search_type search_type,
92 efi_guid_t *protocol, void *search_key,
93 unsigned long *buffer_size, efi_handle_t *buffer);
94 efi_status_t (EFIAPI *locate_device_path)(efi_guid_t *protocol,
95 struct efi_device_path **device_path,
96 efi_handle_t *device);
97 efi_status_t (EFIAPI *install_configuration_table)(
98 efi_guid_t *guid, void *table);
100 efi_status_t (EFIAPI *load_image)(bool boot_policiy,
101 efi_handle_t parent_image,
102 struct efi_device_path *file_path, void *source_buffer,
103 unsigned long source_size, efi_handle_t *image);
104 efi_status_t (EFIAPI *start_image)(efi_handle_t handle,
105 unsigned long *exitdata_size,
107 efi_status_t (EFIAPI *exit)(efi_handle_t handle,
108 efi_status_t exit_status,
109 unsigned long exitdata_size, s16 *exitdata);
110 efi_status_t (EFIAPI *unload_image)(void *image_handle);
111 efi_status_t (EFIAPI *exit_boot_services)(efi_handle_t, unsigned long);
113 efi_status_t (EFIAPI *get_next_monotonic_count)(u64 *count);
114 efi_status_t (EFIAPI *stall)(unsigned long usecs);
115 efi_status_t (EFIAPI *set_watchdog_timer)(unsigned long timeout,
116 uint64_t watchdog_code, unsigned long data_size,
117 uint16_t *watchdog_data);
118 efi_status_t(EFIAPI *connect_controller)(efi_handle_t controller_handle,
119 efi_handle_t *driver_image_handle,
120 struct efi_device_path *remaining_device_path,
122 efi_status_t (EFIAPI *disconnect_controller)(void *controller_handle,
123 void *driver_image_handle, void *child_handle);
124 #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001
125 #define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002
126 #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004
127 #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008
128 #define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010
129 #define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020
130 efi_status_t (EFIAPI *open_protocol)(efi_handle_t handle,
131 efi_guid_t *protocol, void **interface,
132 efi_handle_t agent_handle,
133 efi_handle_t controller_handle, u32 attributes);
134 efi_status_t (EFIAPI *close_protocol)(void *handle,
135 efi_guid_t *protocol, void *agent_handle,
136 void *controller_handle);
137 efi_status_t(EFIAPI *open_protocol_information)(efi_handle_t handle,
138 efi_guid_t *protocol,
139 struct efi_open_protocol_info_entry **entry_buffer,
140 unsigned long *entry_count);
141 efi_status_t (EFIAPI *protocols_per_handle)(efi_handle_t handle,
142 efi_guid_t ***protocol_buffer,
143 unsigned long *protocols_buffer_count);
144 efi_status_t (EFIAPI *locate_handle_buffer) (
145 enum efi_locate_search_type search_type,
146 efi_guid_t *protocol, void *search_key,
147 unsigned long *no_handles, efi_handle_t **buffer);
148 efi_status_t (EFIAPI *locate_protocol)(efi_guid_t *protocol,
149 void *registration, void **protocol_interface);
150 efi_status_t (EFIAPI *install_multiple_protocol_interfaces)(
152 efi_status_t (EFIAPI *uninstall_multiple_protocol_interfaces)(
154 efi_status_t (EFIAPI *calculate_crc32)(void *data,
155 unsigned long data_size, uint32_t *crc32);
156 void (EFIAPI *copy_mem)(void *destination, void *source,
157 unsigned long length);
158 void (EFIAPI *set_mem)(void *buffer, unsigned long size,
160 void *create_event_ex;
163 /* Types and defines for EFI ResetSystem */
164 enum efi_reset_type {
167 EFI_RESET_SHUTDOWN = 2
170 /* EFI Runtime Services table */
171 #define EFI_RUNTIME_SERVICES_SIGNATURE 0x5652453544e5552ULL
172 #define EFI_RUNTIME_SERVICES_REVISION 0x00010000
174 struct efi_runtime_services {
175 struct efi_table_hdr hdr;
176 efi_status_t (EFIAPI *get_time)(struct efi_time *time,
177 struct efi_time_cap *capabilities);
178 efi_status_t (EFIAPI *set_time)(struct efi_time *time);
179 efi_status_t (EFIAPI *get_wakeup_time)(char *enabled, char *pending,
180 struct efi_time *time);
181 efi_status_t (EFIAPI *set_wakeup_time)(char enabled,
182 struct efi_time *time);
183 efi_status_t (EFIAPI *set_virtual_address_map)(
184 unsigned long memory_map_size,
185 unsigned long descriptor_size,
186 uint32_t descriptor_version,
187 struct efi_mem_desc *virtmap);
188 efi_status_t (*convert_pointer)(unsigned long dbg, void **address);
189 efi_status_t (EFIAPI *get_variable)(s16 *variable_name,
190 efi_guid_t *vendor, u32 *attributes,
191 unsigned long *data_size, void *data);
192 efi_status_t (EFIAPI *get_next_variable)(
193 unsigned long *variable_name_size,
194 s16 *variable_name, efi_guid_t *vendor);
195 efi_status_t (EFIAPI *set_variable)(s16 *variable_name,
196 efi_guid_t *vendor, u32 attributes,
197 unsigned long data_size, void *data);
198 efi_status_t (EFIAPI *get_next_high_mono_count)(
199 uint32_t *high_count);
200 void (EFIAPI *reset_system)(enum efi_reset_type reset_type,
201 efi_status_t reset_status,
202 unsigned long data_size, void *reset_data);
203 void *update_capsule;
204 void *query_capsule_caps;
205 void *query_variable_info;
208 /* EFI Configuration Table and GUID definitions */
210 EFI_GUID(0x00000000, 0x0000, 0x0000, 0x00, 0x00, \
211 0x00, 0x00, 0x00, 0x00, 0x00, 0x00)
213 #define LOADED_IMAGE_PROTOCOL_GUID \
214 EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, \
215 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
217 #define EFI_FDT_GUID \
218 EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5, \
219 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0)
221 #define SMBIOS_TABLE_GUID \
222 EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3, \
223 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
225 struct efi_configuration_table
231 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
233 struct efi_system_table {
234 struct efi_table_hdr hdr;
235 unsigned long fw_vendor; /* physical addr of wchar_t vendor string */
237 unsigned long con_in_handle;
238 struct efi_simple_input_interface *con_in;
239 unsigned long con_out_handle;
240 struct efi_simple_text_output_protocol *con_out;
241 unsigned long stderr_handle;
242 struct efi_simple_text_output_protocol *std_err;
243 struct efi_runtime_services *runtime;
244 struct efi_boot_services *boottime;
245 unsigned long nr_tables;
246 struct efi_configuration_table *tables;
249 #define LOADED_IMAGE_GUID \
250 EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, \
251 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
253 struct efi_loaded_image {
256 struct efi_system_table *system_table;
260 u32 load_options_size;
263 aligned_u64 image_size;
264 unsigned int image_code_type;
265 unsigned int image_data_type;
266 unsigned long unload;
268 /* Below are efi loader private fields */
269 #ifdef CONFIG_EFI_LOADER
270 efi_status_t exit_status;
271 struct jmp_buf_data exit_jmp;
275 #define DEVICE_PATH_GUID \
276 EFI_GUID(0x09576e91, 0x6d3f, 0x11d2, \
277 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
279 #define DEVICE_PATH_TYPE_END 0x7f
280 # define DEVICE_PATH_SUB_TYPE_END 0xff
282 struct efi_device_path {
288 struct efi_mac_addr {
292 #define DEVICE_PATH_TYPE_MESSAGING_DEVICE 0x03
293 # define DEVICE_PATH_SUB_TYPE_MSG_MAC_ADDR 0x0b
295 struct efi_device_path_mac_addr {
296 struct efi_device_path dp;
297 struct efi_mac_addr mac;
301 #define DEVICE_PATH_TYPE_MEDIA_DEVICE 0x04
302 # define DEVICE_PATH_SUB_TYPE_FILE_PATH 0x04
304 struct efi_device_path_file_path {
305 struct efi_device_path dp;
309 #define BLOCK_IO_GUID \
310 EFI_GUID(0x964e5b21, 0x6459, 0x11d2, \
311 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
313 struct efi_block_io_media
316 char removable_media;
318 char logical_partition;
328 struct efi_block_io {
330 struct efi_block_io_media *media;
331 efi_status_t (EFIAPI *reset)(struct efi_block_io *this,
332 char extended_verification);
333 efi_status_t (EFIAPI *read_blocks)(struct efi_block_io *this,
334 u32 media_id, u64 lba, unsigned long buffer_size,
336 efi_status_t (EFIAPI *write_blocks)(struct efi_block_io *this,
337 u32 media_id, u64 lba, unsigned long buffer_size,
339 efi_status_t (EFIAPI *flush_blocks)(struct efi_block_io *this);
342 struct simple_text_output_mode {
351 struct efi_simple_text_output_protocol {
353 efi_status_t (EFIAPI *output_string)(
354 struct efi_simple_text_output_protocol *this,
355 const unsigned short *str);
356 efi_status_t (EFIAPI *test_string)(
357 struct efi_simple_text_output_protocol *this,
358 const unsigned short *str);
359 efi_status_t(EFIAPI *query_mode)(
360 struct efi_simple_text_output_protocol *this,
361 unsigned long mode_number, unsigned long *columns,
362 unsigned long *rows);
363 efi_status_t(EFIAPI *set_mode)(
364 struct efi_simple_text_output_protocol *this,
365 unsigned long mode_number);
366 efi_status_t(EFIAPI *set_attribute)(
367 struct efi_simple_text_output_protocol *this,
368 unsigned long attribute);
369 efi_status_t(EFIAPI *clear_screen) (
370 struct efi_simple_text_output_protocol *this);
371 efi_status_t(EFIAPI *set_cursor_position) (
372 struct efi_simple_text_output_protocol *this,
373 unsigned long column, unsigned long row);
374 efi_status_t(EFIAPI *enable_cursor)(
375 struct efi_simple_text_output_protocol *this,
377 struct simple_text_output_mode *mode;
380 struct efi_input_key {
385 struct efi_simple_input_interface {
386 efi_status_t(EFIAPI *reset)(struct efi_simple_input_interface *this,
387 bool ExtendedVerification);
388 efi_status_t(EFIAPI *read_key_stroke)(
389 struct efi_simple_input_interface *this,
390 struct efi_input_key *key);
391 struct efi_event *wait_for_key;
394 #define CONSOLE_CONTROL_GUID \
395 EFI_GUID(0xf42f7782, 0x12e, 0x4c12, \
396 0x99, 0x56, 0x49, 0xf9, 0x43, 0x4, 0xf7, 0x21)
397 #define EFI_CONSOLE_MODE_TEXT 0
398 #define EFI_CONSOLE_MODE_GFX 1
400 struct efi_console_control_protocol
402 efi_status_t (EFIAPI *get_mode)(
403 struct efi_console_control_protocol *this, int *mode,
404 char *uga_exists, char *std_in_locked);
405 efi_status_t (EFIAPI *set_mode)(
406 struct efi_console_control_protocol *this, int mode);
407 efi_status_t (EFIAPI *lock_std_in)(
408 struct efi_console_control_protocol *this,
412 #define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID \
413 EFI_GUID(0x8b843e20, 0x8132, 0x4852, \
414 0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c)
416 struct efi_device_path_protocol
424 struct efi_device_path_to_text_protocol
426 uint16_t *(EFIAPI *convert_device_node_to_text)(
427 struct efi_device_path_protocol *device_node,
429 bool allow_shortcuts);
430 uint16_t *(EFIAPI *convert_device_path_to_text)(
431 struct efi_device_path_protocol *device_path,
433 bool allow_shortcuts);
436 #define EFI_GOP_GUID \
437 EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, \
438 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
440 #define EFI_GOT_RGBA8 0
441 #define EFI_GOT_BGRA8 1
442 #define EFI_GOT_BITMASK 2
444 struct efi_gop_mode_info
450 u32 pixel_bitmask[4];
451 u32 pixels_per_scanline;
458 struct efi_gop_mode_info *info;
459 unsigned long info_size;
460 efi_physical_addr_t fb_base;
461 unsigned long fb_size;
464 #define EFI_BLT_VIDEO_FILL 0
465 #define EFI_BLT_VIDEO_TO_BLT_BUFFER 1
466 #define EFI_BLT_BUFFER_TO_VIDEO 2
467 #define EFI_BLT_VIDEO_TO_VIDEO 3
471 efi_status_t (EFIAPI *query_mode)(struct efi_gop *this, u32 mode_number,
472 unsigned long *size_of_info,
473 struct efi_gop_mode_info **info);
474 efi_status_t (EFIAPI *set_mode)(struct efi_gop *this, u32 mode_number);
475 efi_status_t (EFIAPI *blt)(struct efi_gop *this, void *buffer,
476 unsigned long operation, unsigned long sx,
477 unsigned long sy, unsigned long dx,
478 unsigned long dy, unsigned long width,
479 unsigned long height, unsigned long delta);
480 struct efi_gop_mode *mode;
483 #define EFI_SIMPLE_NETWORK_GUID \
484 EFI_GUID(0xa19832b9, 0xac25, 0x11d3, \
485 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
487 struct efi_mac_address {
491 struct efi_ip_address {
495 enum efi_simple_network_state {
498 EFI_NETWORK_INITIALIZED,
501 struct efi_simple_network_mode {
502 enum efi_simple_network_state state;
504 u32 media_header_size;
507 u32 nvram_access_size;
508 u32 receive_filter_mask;
509 u32 receive_filter_setting;
510 u32 max_mcast_filter_count;
511 u32 mcast_filter_count;
512 struct efi_mac_address mcast_filter[16];
513 struct efi_mac_address current_address;
514 struct efi_mac_address broadcast_address;
515 struct efi_mac_address permanent_address;
518 u8 multitx_supported;
519 u8 media_present_supported;
523 #define EFI_SIMPLE_NETWORK_RECEIVE_UNICAST 0x01,
524 #define EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST 0x02,
525 #define EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST 0x04,
526 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS 0x08,
527 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST 0x10,
529 struct efi_simple_network
532 efi_status_t (EFIAPI *start)(struct efi_simple_network *this);
533 efi_status_t (EFIAPI *stop)(struct efi_simple_network *this);
534 efi_status_t (EFIAPI *initialize)(struct efi_simple_network *this,
535 ulong extra_rx, ulong extra_tx);
536 efi_status_t (EFIAPI *reset)(struct efi_simple_network *this,
537 int extended_verification);
538 efi_status_t (EFIAPI *shutdown)(struct efi_simple_network *this);
539 efi_status_t (EFIAPI *receive_filters)(struct efi_simple_network *this,
540 u32 enable, u32 disable, int reset_mcast_filter,
541 ulong mcast_filter_count,
542 struct efi_mac_address *mcast_filter);
543 efi_status_t (EFIAPI *station_address)(struct efi_simple_network *this,
544 int reset, struct efi_mac_address *new_mac);
545 efi_status_t (EFIAPI *statistics)(struct efi_simple_network *this,
546 int reset, ulong *stat_size, void *stat_table);
547 efi_status_t (EFIAPI *mcastiptomac)(struct efi_simple_network *this,
548 int ipv6, struct efi_ip_address *ip,
549 struct efi_mac_address *mac);
550 efi_status_t (EFIAPI *nvdata)(struct efi_simple_network *this,
551 int read_write, ulong offset, ulong buffer_size,
553 efi_status_t (EFIAPI *get_status)(struct efi_simple_network *this,
554 u32 *int_status, void **txbuf);
555 efi_status_t (EFIAPI *transmit)(struct efi_simple_network *this,
556 ulong header_size, ulong buffer_size, void *buffer,
557 struct efi_mac_address *src_addr,
558 struct efi_mac_address *dest_addr, u16 *protocol);
559 efi_status_t (EFIAPI *receive)(struct efi_simple_network *this,
560 ulong *header_size, ulong *buffer_size, void *buffer,
561 struct efi_mac_address *src_addr,
562 struct efi_mac_address *dest_addr, u16 *protocol);
563 void (EFIAPI *waitforpacket)(void);
564 struct efi_simple_network_mode *mode;
567 #define EFI_PXE_GUID \
568 EFI_GUID(0x03c4e603, 0xac28, 0x11d3, \
569 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
571 struct efi_pxe_packet {
578 struct efi_pxe_packet dhcp_discover;
579 struct efi_pxe_packet dhcp_ack;
580 struct efi_pxe_packet proxy_offer;
581 struct efi_pxe_packet pxe_discover;
582 struct efi_pxe_packet pxe_reply;
587 void (EFIAPI *start)(void);
588 void (EFIAPI *stop)(void);
589 void (EFIAPI *dhcp)(void);
590 void (EFIAPI *discover)(void);
591 void (EFIAPI *mftp)(void);
592 void (EFIAPI *udpwrite)(void);
593 void (EFIAPI *udpread)(void);
594 void (EFIAPI *setipfilter)(void);
595 void (EFIAPI *arp)(void);
596 void (EFIAPI *setparams)(void);
597 void (EFIAPI *setstationip)(void);
598 void (EFIAPI *setpackets)(void);
599 struct efi_pxe_mode *mode;