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 /* UEFI spec version 2.7 */
25 #define EFI_SPECIFICATION_VERSION (2 << 16 | 70)
27 /* Types and defines for EFI CreateEvent */
28 enum efi_timer_delay {
30 EFI_TIMER_PERIODIC = 1,
31 EFI_TIMER_RELATIVE = 2
34 #define efi_uintn_t size_t
35 typedef uint16_t *efi_string_t;
37 #define EVT_TIMER 0x80000000
38 #define EVT_RUNTIME 0x40000000
39 #define EVT_NOTIFY_WAIT 0x00000100
40 #define EVT_NOTIFY_SIGNAL 0x00000200
41 #define EVT_SIGNAL_EXIT_BOOT_SERVICES 0x00000201
42 #define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE 0x60000202
44 #define TPL_APPLICATION 0x04
45 #define TPL_CALLBACK 0x08
46 #define TPL_NOTIFY 0x10
47 #define TPL_HIGH_LEVEL 0x1F
51 /* EFI Boot Services table */
52 #define EFI_BOOT_SERVICES_SIGNATURE 0x56524553544f4f42
53 struct efi_boot_services {
54 struct efi_table_hdr hdr;
55 efi_status_t (EFIAPI *raise_tpl)(efi_uintn_t new_tpl);
56 void (EFIAPI *restore_tpl)(efi_uintn_t old_tpl);
58 efi_status_t (EFIAPI *allocate_pages)(int, int, efi_uintn_t,
59 efi_physical_addr_t *);
60 efi_status_t (EFIAPI *free_pages)(efi_physical_addr_t, efi_uintn_t);
61 efi_status_t (EFIAPI *get_memory_map)(efi_uintn_t *memory_map_size,
62 struct efi_mem_desc *desc,
64 efi_uintn_t *desc_size,
66 efi_status_t (EFIAPI *allocate_pool)(int, efi_uintn_t, void **);
67 efi_status_t (EFIAPI *free_pool)(void *);
69 efi_status_t (EFIAPI *create_event)(uint32_t type,
70 efi_uintn_t notify_tpl,
71 void (EFIAPI *notify_function) (
72 struct efi_event *event,
74 void *notify_context, struct efi_event **event);
75 efi_status_t (EFIAPI *set_timer)(struct efi_event *event,
76 enum efi_timer_delay type,
77 uint64_t trigger_time);
78 efi_status_t (EFIAPI *wait_for_event)(efi_uintn_t number_of_events,
79 struct efi_event **event,
81 efi_status_t (EFIAPI *signal_event)(struct efi_event *event);
82 efi_status_t (EFIAPI *close_event)(struct efi_event *event);
83 efi_status_t (EFIAPI *check_event)(struct efi_event *event);
84 #define EFI_NATIVE_INTERFACE 0x00000000
85 efi_status_t (EFIAPI *install_protocol_interface)(
86 void **handle, const efi_guid_t *protocol,
87 int protocol_interface_type, void *protocol_interface);
88 efi_status_t (EFIAPI *reinstall_protocol_interface)(
89 void *handle, const efi_guid_t *protocol,
90 void *old_interface, void *new_interface);
91 efi_status_t (EFIAPI *uninstall_protocol_interface)(
92 efi_handle_t handle, const efi_guid_t *protocol,
93 void *protocol_interface);
94 efi_status_t (EFIAPI *handle_protocol)(
95 efi_handle_t handle, const efi_guid_t *protocol,
96 void **protocol_interface);
98 efi_status_t (EFIAPI *register_protocol_notify)(
99 const efi_guid_t *protocol, struct efi_event *event,
100 void **registration);
101 efi_status_t (EFIAPI *locate_handle)(
102 enum efi_locate_search_type search_type,
103 const efi_guid_t *protocol, void *search_key,
104 efi_uintn_t *buffer_size, efi_handle_t *buffer);
105 efi_status_t (EFIAPI *locate_device_path)(const efi_guid_t *protocol,
106 struct efi_device_path **device_path,
107 efi_handle_t *device);
108 efi_status_t (EFIAPI *install_configuration_table)(
109 efi_guid_t *guid, void *table);
111 efi_status_t (EFIAPI *load_image)(bool boot_policiy,
112 efi_handle_t parent_image,
113 struct efi_device_path *file_path, void *source_buffer,
114 efi_uintn_t source_size, efi_handle_t *image);
115 efi_status_t (EFIAPI *start_image)(efi_handle_t handle,
116 unsigned long *exitdata_size,
118 efi_status_t (EFIAPI *exit)(efi_handle_t handle,
119 efi_status_t exit_status,
120 unsigned long exitdata_size, s16 *exitdata);
121 efi_status_t (EFIAPI *unload_image)(efi_handle_t image_handle);
122 efi_status_t (EFIAPI *exit_boot_services)(efi_handle_t, unsigned long);
124 efi_status_t (EFIAPI *get_next_monotonic_count)(u64 *count);
125 efi_status_t (EFIAPI *stall)(unsigned long usecs);
126 efi_status_t (EFIAPI *set_watchdog_timer)(unsigned long timeout,
127 uint64_t watchdog_code, unsigned long data_size,
128 uint16_t *watchdog_data);
129 efi_status_t(EFIAPI *connect_controller)(efi_handle_t controller_handle,
130 efi_handle_t *driver_image_handle,
131 struct efi_device_path *remaining_device_path,
133 efi_status_t (EFIAPI *disconnect_controller)(
134 efi_handle_t controller_handle,
135 efi_handle_t driver_image_handle,
136 efi_handle_t child_handle);
137 #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001
138 #define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002
139 #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004
140 #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008
141 #define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010
142 #define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020
143 efi_status_t (EFIAPI *open_protocol)(efi_handle_t handle,
144 const efi_guid_t *protocol, void **interface,
145 efi_handle_t agent_handle,
146 efi_handle_t controller_handle, u32 attributes);
147 efi_status_t (EFIAPI *close_protocol)(
148 efi_handle_t handle, const efi_guid_t *protocol,
149 efi_handle_t agent_handle,
150 efi_handle_t controller_handle);
151 efi_status_t(EFIAPI *open_protocol_information)(efi_handle_t handle,
152 const efi_guid_t *protocol,
153 struct efi_open_protocol_info_entry **entry_buffer,
154 efi_uintn_t *entry_count);
155 efi_status_t (EFIAPI *protocols_per_handle)(efi_handle_t handle,
156 efi_guid_t ***protocol_buffer,
157 efi_uintn_t *protocols_buffer_count);
158 efi_status_t (EFIAPI *locate_handle_buffer) (
159 enum efi_locate_search_type search_type,
160 const efi_guid_t *protocol, void *search_key,
161 efi_uintn_t *no_handles, efi_handle_t **buffer);
162 efi_status_t (EFIAPI *locate_protocol)(const efi_guid_t *protocol,
163 void *registration, void **protocol_interface);
164 efi_status_t (EFIAPI *install_multiple_protocol_interfaces)(
166 efi_status_t (EFIAPI *uninstall_multiple_protocol_interfaces)(
168 efi_status_t (EFIAPI *calculate_crc32)(void *data,
169 unsigned long data_size, uint32_t *crc32);
170 void (EFIAPI *copy_mem)(void *destination, const void *source,
172 void (EFIAPI *set_mem)(void *buffer, size_t size, uint8_t value);
173 efi_status_t (EFIAPI *create_event_ex)(
174 uint32_t type, efi_uintn_t notify_tpl,
175 void (EFIAPI *notify_function) (
176 struct efi_event *event,
178 void *notify_context,
179 efi_guid_t *event_group,
180 struct efi_event **event);
183 /* Types and defines for EFI ResetSystem */
184 enum efi_reset_type {
187 EFI_RESET_SHUTDOWN = 2,
188 EFI_RESET_PLATFORM_SPECIFIC = 3,
191 /* EFI Runtime Services table */
192 #define EFI_RUNTIME_SERVICES_SIGNATURE 0x56524553544e5552ULL
194 #define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000
195 #define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE 0x00020000
196 #define CAPSULE_FLAGS_INITIATE_RESET 0x00040000
198 struct efi_capsule_header {
199 efi_guid_t *capsule_guid;
202 u32 capsule_image_size;
205 struct efi_runtime_services {
206 struct efi_table_hdr hdr;
207 efi_status_t (EFIAPI *get_time)(struct efi_time *time,
208 struct efi_time_cap *capabilities);
209 efi_status_t (EFIAPI *set_time)(struct efi_time *time);
210 efi_status_t (EFIAPI *get_wakeup_time)(char *enabled, char *pending,
211 struct efi_time *time);
212 efi_status_t (EFIAPI *set_wakeup_time)(char enabled,
213 struct efi_time *time);
214 efi_status_t (EFIAPI *set_virtual_address_map)(
215 unsigned long memory_map_size,
216 unsigned long descriptor_size,
217 uint32_t descriptor_version,
218 struct efi_mem_desc *virtmap);
219 efi_status_t (*convert_pointer)(unsigned long dbg, void **address);
220 efi_status_t (EFIAPI *get_variable)(u16 *variable_name,
221 efi_guid_t *vendor, u32 *attributes,
222 efi_uintn_t *data_size, void *data);
223 efi_status_t (EFIAPI *get_next_variable_name)(
224 efi_uintn_t *variable_name_size,
225 u16 *variable_name, efi_guid_t *vendor);
226 efi_status_t (EFIAPI *set_variable)(u16 *variable_name,
227 efi_guid_t *vendor, u32 attributes,
228 efi_uintn_t data_size, void *data);
229 efi_status_t (EFIAPI *get_next_high_mono_count)(
230 uint32_t *high_count);
231 void (EFIAPI *reset_system)(enum efi_reset_type reset_type,
232 efi_status_t reset_status,
233 unsigned long data_size, void *reset_data);
234 efi_status_t (EFIAPI *update_capsule)(
235 struct efi_capsule_header **capsule_header_array,
236 efi_uintn_t capsule_count,
237 u64 scatter_gather_list);
238 efi_status_t (EFIAPI *query_capsule_caps)(
239 struct efi_capsule_header **capsule_header_array,
240 efi_uintn_t capsule_count,
241 u64 maximum_capsule_size,
243 efi_status_t (EFIAPI *query_variable_info)(
245 u64 *maximum_variable_storage_size,
246 u64 *remaining_variable_storage_size,
247 u64 *maximum_variable_size);
250 /* EFI event group GUID definitions */
251 #define EFI_EVENT_GROUP_EXIT_BOOT_SERVICES \
252 EFI_GUID(0x27abf055, 0xb1b8, 0x4c26, 0x80, 0x48, \
253 0x74, 0x8f, 0x37, 0xba, 0xa2, 0xdf)
255 #define EFI_EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE \
256 EFI_GUID(0x13fa7698, 0xc831, 0x49c7, 0x87, 0xea, \
257 0x8f, 0x43, 0xfc, 0xc2, 0x51, 0x96)
259 #define EFI_EVENT_GROUP_MEMORY_MAP_CHANGE \
260 EFI_GUID(0x78bee926, 0x692f, 0x48fd, 0x9e, 0xdb, \
261 0x01, 0x42, 0x2e, 0xf0, 0xd7, 0xab)
263 #define EFI_EVENT_GROUP_READY_TO_BOOT \
264 EFI_GUID(0x7ce88fb3, 0x4bd7, 0x4679, 0x87, 0xa8, \
265 0xa8, 0xd8, 0xde, 0xe5, 0x0d, 0x2b)
267 #define EFI_EVENT_GROUP_RESET_SYSTEM \
268 EFI_GUID(0x62da6a56, 0x13fb, 0x485a, 0xa8, 0xda, \
269 0xa3, 0xdd, 0x79, 0x12, 0xcb, 0x6b)
271 /* EFI Configuration Table and GUID definitions */
273 EFI_GUID(0x00000000, 0x0000, 0x0000, 0x00, 0x00, \
274 0x00, 0x00, 0x00, 0x00, 0x00, 0x00)
276 #define EFI_GLOBAL_VARIABLE_GUID \
277 EFI_GUID(0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, \
278 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c)
280 #define LOADED_IMAGE_PROTOCOL_GUID \
281 EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, \
282 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
284 #define EFI_FDT_GUID \
285 EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5, \
286 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0)
288 #define EFI_ACPI_TABLE_GUID \
289 EFI_GUID(0x8868e871, 0xe4f1, 0x11d3, \
290 0xbc, 0x22, 0x00, 0x80, 0xc7, 0x3c, 0x88, 0x81)
292 #define SMBIOS_TABLE_GUID \
293 EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3, \
294 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
296 struct efi_configuration_table
302 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
304 struct efi_system_table {
305 struct efi_table_hdr hdr;
306 unsigned long fw_vendor; /* physical addr of wchar_t vendor string */
308 efi_handle_t con_in_handle;
309 struct efi_simple_input_interface *con_in;
310 efi_handle_t con_out_handle;
311 struct efi_simple_text_output_protocol *con_out;
312 efi_handle_t stderr_handle;
313 struct efi_simple_text_output_protocol *std_err;
314 struct efi_runtime_services *runtime;
315 struct efi_boot_services *boottime;
316 efi_uintn_t nr_tables;
317 struct efi_configuration_table *tables;
320 #define LOADED_IMAGE_GUID \
321 EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, \
322 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
324 #define EFI_LOADED_IMAGE_PROTOCOL_REVISION 0x1000
326 struct efi_loaded_image {
329 struct efi_system_table *system_table;
330 efi_handle_t device_handle;
331 struct efi_device_path *file_path;
333 u32 load_options_size;
336 aligned_u64 image_size;
337 unsigned int image_code_type;
338 unsigned int image_data_type;
339 unsigned long unload;
341 /* Below are efi loader private fields */
342 #ifdef CONFIG_EFI_LOADER
344 aligned_u64 reloc_size;
345 efi_status_t exit_status;
346 struct jmp_buf_data exit_jmp;
350 #define DEVICE_PATH_GUID \
351 EFI_GUID(0x09576e91, 0x6d3f, 0x11d2, \
352 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
354 #define DEVICE_PATH_TYPE_END 0x7f
355 # define DEVICE_PATH_SUB_TYPE_INSTANCE_END 0x01
356 # define DEVICE_PATH_SUB_TYPE_END 0xff
358 struct efi_device_path {
364 struct efi_mac_addr {
368 #define DEVICE_PATH_TYPE_HARDWARE_DEVICE 0x01
369 # define DEVICE_PATH_SUB_TYPE_MEMORY 0x03
370 # define DEVICE_PATH_SUB_TYPE_VENDOR 0x04
372 struct efi_device_path_memory {
373 struct efi_device_path dp;
379 struct efi_device_path_vendor {
380 struct efi_device_path dp;
385 #define DEVICE_PATH_TYPE_ACPI_DEVICE 0x02
386 # define DEVICE_PATH_SUB_TYPE_ACPI_DEVICE 0x01
388 #define EFI_PNP_ID(ID) (u32)(((ID) << 16) | 0x41D0)
389 #define EISA_PNP_ID(ID) EFI_PNP_ID(ID)
390 #define EISA_PNP_NUM(ID) ((ID) >> 16)
392 struct efi_device_path_acpi_path {
393 struct efi_device_path dp;
398 #define DEVICE_PATH_TYPE_MESSAGING_DEVICE 0x03
399 # define DEVICE_PATH_SUB_TYPE_MSG_ATAPI 0x01
400 # define DEVICE_PATH_SUB_TYPE_MSG_SCSI 0x02
401 # define DEVICE_PATH_SUB_TYPE_MSG_USB 0x05
402 # define DEVICE_PATH_SUB_TYPE_MSG_MAC_ADDR 0x0b
403 # define DEVICE_PATH_SUB_TYPE_MSG_USB_CLASS 0x0f
404 # define DEVICE_PATH_SUB_TYPE_MSG_SD 0x1a
405 # define DEVICE_PATH_SUB_TYPE_MSG_MMC 0x1d
407 struct efi_device_path_atapi {
408 struct efi_device_path dp;
409 u8 primary_secondary;
411 u16 logical_unit_number;
414 struct efi_device_path_scsi {
415 struct efi_device_path dp;
417 u16 logical_unit_number;
420 struct efi_device_path_usb {
421 struct efi_device_path dp;
422 u8 parent_port_number;
426 struct efi_device_path_mac_addr {
427 struct efi_device_path dp;
428 struct efi_mac_addr mac;
432 struct efi_device_path_usb_class {
433 struct efi_device_path dp;
441 struct efi_device_path_sd_mmc_path {
442 struct efi_device_path dp;
446 #define DEVICE_PATH_TYPE_MEDIA_DEVICE 0x04
447 # define DEVICE_PATH_SUB_TYPE_HARD_DRIVE_PATH 0x01
448 # define DEVICE_PATH_SUB_TYPE_CDROM_PATH 0x02
449 # define DEVICE_PATH_SUB_TYPE_FILE_PATH 0x04
451 struct efi_device_path_hard_drive_path {
452 struct efi_device_path dp;
453 u32 partition_number;
456 u8 partition_signature[16];
461 struct efi_device_path_cdrom_path {
462 struct efi_device_path dp;
468 struct efi_device_path_file_path {
469 struct efi_device_path dp;
473 #define BLOCK_IO_GUID \
474 EFI_GUID(0x964e5b21, 0x6459, 0x11d2, \
475 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
477 struct efi_block_io_media
480 char removable_media;
482 char logical_partition;
490 /* Added in revision 2 of the protocol */
491 u64 lowest_aligned_lba;
492 u32 logical_blocks_per_physical_block;
493 /* Added in revision 3 of the protocol */
494 u32 optimal_transfer_length_granualarity;
497 #define EFI_BLOCK_IO_PROTOCOL_REVISION2 0x00020001
498 #define EFI_BLOCK_IO_PROTOCOL_REVISION3 0x0002001f
500 struct efi_block_io {
502 struct efi_block_io_media *media;
503 efi_status_t (EFIAPI *reset)(struct efi_block_io *this,
504 char extended_verification);
505 efi_status_t (EFIAPI *read_blocks)(struct efi_block_io *this,
506 u32 media_id, u64 lba, efi_uintn_t buffer_size,
508 efi_status_t (EFIAPI *write_blocks)(struct efi_block_io *this,
509 u32 media_id, u64 lba, efi_uintn_t buffer_size,
511 efi_status_t (EFIAPI *flush_blocks)(struct efi_block_io *this);
514 struct simple_text_output_mode {
524 #define EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID \
525 EFI_GUID(0x387477c2, 0x69c7, 0x11d2, \
526 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
528 #define EFI_BLACK 0x00
529 #define EFI_BLUE 0x01
530 #define EFI_GREEN 0x02
531 #define EFI_CYAN 0x03
533 #define EFI_MAGENTA 0x05
534 #define EFI_BROWN 0x06
535 #define EFI_LIGHTGRAY 0x07
536 #define EFI_BRIGHT 0x08
537 #define EFI_DARKGRAY 0x08
538 #define EFI_LIGHTBLUE 0x09
539 #define EFI_LIGHTGREEN 0x0a
540 #define EFI_LIGHTCYAN 0x0b
541 #define EFI_LIGHTRED 0x0c
542 #define EFI_LIGHTMAGENTA 0x0d
543 #define EFI_YELLOW 0x0e
544 #define EFI_WHITE 0x0f
545 #define EFI_BACKGROUND_BLACK 0x00
546 #define EFI_BACKGROUND_BLUE 0x10
547 #define EFI_BACKGROUND_GREEN 0x20
548 #define EFI_BACKGROUND_CYAN 0x30
549 #define EFI_BACKGROUND_RED 0x40
550 #define EFI_BACKGROUND_MAGENTA 0x50
551 #define EFI_BACKGROUND_BROWN 0x60
552 #define EFI_BACKGROUND_LIGHTGRAY 0x70
554 /* extract foreground color from EFI attribute */
555 #define EFI_ATTR_FG(attr) ((attr) & 0x07)
556 /* treat high bit of FG as bright/bold (similar to edk2) */
557 #define EFI_ATTR_BOLD(attr) (((attr) >> 3) & 0x01)
558 /* extract background color from EFI attribute */
559 #define EFI_ATTR_BG(attr) (((attr) >> 4) & 0x7)
561 struct efi_simple_text_output_protocol {
563 efi_status_t (EFIAPI *output_string)(
564 struct efi_simple_text_output_protocol *this,
565 const efi_string_t str);
566 efi_status_t (EFIAPI *test_string)(
567 struct efi_simple_text_output_protocol *this,
568 const efi_string_t str);
569 efi_status_t(EFIAPI *query_mode)(
570 struct efi_simple_text_output_protocol *this,
571 unsigned long mode_number, unsigned long *columns,
572 unsigned long *rows);
573 efi_status_t(EFIAPI *set_mode)(
574 struct efi_simple_text_output_protocol *this,
575 unsigned long mode_number);
576 efi_status_t(EFIAPI *set_attribute)(
577 struct efi_simple_text_output_protocol *this,
578 unsigned long attribute);
579 efi_status_t(EFIAPI *clear_screen) (
580 struct efi_simple_text_output_protocol *this);
581 efi_status_t(EFIAPI *set_cursor_position) (
582 struct efi_simple_text_output_protocol *this,
583 unsigned long column, unsigned long row);
584 efi_status_t(EFIAPI *enable_cursor)(
585 struct efi_simple_text_output_protocol *this,
587 struct simple_text_output_mode *mode;
590 struct efi_input_key {
595 #define EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID \
596 EFI_GUID(0x387477c1, 0x69c7, 0x11d2, \
597 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
599 struct efi_simple_input_interface {
600 efi_status_t(EFIAPI *reset)(struct efi_simple_input_interface *this,
601 bool ExtendedVerification);
602 efi_status_t(EFIAPI *read_key_stroke)(
603 struct efi_simple_input_interface *this,
604 struct efi_input_key *key);
605 struct efi_event *wait_for_key;
608 #define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID \
609 EFI_GUID(0x8b843e20, 0x8132, 0x4852, \
610 0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c)
612 struct efi_device_path_to_text_protocol
614 uint16_t *(EFIAPI *convert_device_node_to_text)(
615 struct efi_device_path *device_node,
617 bool allow_shortcuts);
618 uint16_t *(EFIAPI *convert_device_path_to_text)(
619 struct efi_device_path *device_path,
621 bool allow_shortcuts);
624 #define EFI_DEVICE_PATH_UTILITIES_PROTOCOL_GUID \
625 EFI_GUID(0x0379be4e, 0xd706, 0x437d, \
626 0xb0, 0x37, 0xed, 0xb8, 0x2f, 0xb7, 0x72, 0xa4)
628 struct efi_device_path_utilities_protocol {
629 efi_uintn_t (EFIAPI *get_device_path_size)(
630 const struct efi_device_path *device_path);
631 struct efi_device_path *(EFIAPI *duplicate_device_path)(
632 const struct efi_device_path *device_path);
633 struct efi_device_path *(EFIAPI *append_device_path)(
634 const struct efi_device_path *src1,
635 const struct efi_device_path *src2);
636 struct efi_device_path *(EFIAPI *append_device_node)(
637 const struct efi_device_path *device_path,
638 const struct efi_device_path *device_node);
639 struct efi_device_path *(EFIAPI *append_device_path_instance)(
640 const struct efi_device_path *device_path,
641 const struct efi_device_path *device_path_instance);
642 struct efi_device_path *(EFIAPI *get_next_device_path_instance)(
643 struct efi_device_path **device_path_instance,
644 efi_uintn_t *device_path_instance_size);
645 bool (EFIAPI *is_device_path_multi_instance)(
646 const struct efi_device_path *device_path);
647 struct efi_device_path *(EFIAPI *create_device_node)(
649 uint8_t node_sub_type,
650 uint16_t node_length);
653 #define EFI_GOP_GUID \
654 EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, \
655 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
657 #define EFI_GOT_RGBA8 0
658 #define EFI_GOT_BGRA8 1
659 #define EFI_GOT_BITMASK 2
661 struct efi_gop_mode_info
667 u32 pixel_bitmask[4];
668 u32 pixels_per_scanline;
675 struct efi_gop_mode_info *info;
676 unsigned long info_size;
677 efi_physical_addr_t fb_base;
678 unsigned long fb_size;
681 struct efi_gop_pixel {
688 #define EFI_BLT_VIDEO_FILL 0
689 #define EFI_BLT_VIDEO_TO_BLT_BUFFER 1
690 #define EFI_BLT_BUFFER_TO_VIDEO 2
691 #define EFI_BLT_VIDEO_TO_VIDEO 3
695 efi_status_t (EFIAPI *query_mode)(struct efi_gop *this, u32 mode_number,
696 efi_uintn_t *size_of_info,
697 struct efi_gop_mode_info **info);
698 efi_status_t (EFIAPI *set_mode)(struct efi_gop *this, u32 mode_number);
699 efi_status_t (EFIAPI *blt)(struct efi_gop *this,
700 struct efi_gop_pixel *buffer,
701 u32 operation, efi_uintn_t sx,
702 efi_uintn_t sy, efi_uintn_t dx,
703 efi_uintn_t dy, efi_uintn_t width,
704 efi_uintn_t height, efi_uintn_t delta);
705 struct efi_gop_mode *mode;
708 #define EFI_SIMPLE_NETWORK_GUID \
709 EFI_GUID(0xa19832b9, 0xac25, 0x11d3, \
710 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
712 struct efi_mac_address {
716 struct efi_ip_address {
718 } __attribute__((aligned(4)));
720 enum efi_simple_network_state {
723 EFI_NETWORK_INITIALIZED,
726 struct efi_simple_network_mode {
727 enum efi_simple_network_state state;
729 u32 media_header_size;
732 u32 nvram_access_size;
733 u32 receive_filter_mask;
734 u32 receive_filter_setting;
735 u32 max_mcast_filter_count;
736 u32 mcast_filter_count;
737 struct efi_mac_address mcast_filter[16];
738 struct efi_mac_address current_address;
739 struct efi_mac_address broadcast_address;
740 struct efi_mac_address permanent_address;
743 u8 multitx_supported;
744 u8 media_present_supported;
748 /* receive_filters bit mask */
749 #define EFI_SIMPLE_NETWORK_RECEIVE_UNICAST 0x01
750 #define EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST 0x02
751 #define EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST 0x04
752 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS 0x08
753 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST 0x10
755 /* interrupt status bit mask */
756 #define EFI_SIMPLE_NETWORK_RECEIVE_INTERRUPT 0x01
757 #define EFI_SIMPLE_NETWORK_TRANSMIT_INTERRUPT 0x02
758 #define EFI_SIMPLE_NETWORK_COMMAND_INTERRUPT 0x04
759 #define EFI_SIMPLE_NETWORK_SOFTWARE_INTERRUPT 0x08
761 /* revision of the simple network protocol */
762 #define EFI_SIMPLE_NETWORK_PROTOCOL_REVISION 0x00010000
764 struct efi_simple_network
767 efi_status_t (EFIAPI *start)(struct efi_simple_network *this);
768 efi_status_t (EFIAPI *stop)(struct efi_simple_network *this);
769 efi_status_t (EFIAPI *initialize)(struct efi_simple_network *this,
770 ulong extra_rx, ulong extra_tx);
771 efi_status_t (EFIAPI *reset)(struct efi_simple_network *this,
772 int extended_verification);
773 efi_status_t (EFIAPI *shutdown)(struct efi_simple_network *this);
774 efi_status_t (EFIAPI *receive_filters)(struct efi_simple_network *this,
775 u32 enable, u32 disable, int reset_mcast_filter,
776 ulong mcast_filter_count,
777 struct efi_mac_address *mcast_filter);
778 efi_status_t (EFIAPI *station_address)(struct efi_simple_network *this,
779 int reset, struct efi_mac_address *new_mac);
780 efi_status_t (EFIAPI *statistics)(struct efi_simple_network *this,
781 int reset, ulong *stat_size, void *stat_table);
782 efi_status_t (EFIAPI *mcastiptomac)(struct efi_simple_network *this,
783 int ipv6, struct efi_ip_address *ip,
784 struct efi_mac_address *mac);
785 efi_status_t (EFIAPI *nvdata)(struct efi_simple_network *this,
786 int read_write, ulong offset, ulong buffer_size,
788 efi_status_t (EFIAPI *get_status)(struct efi_simple_network *this,
789 u32 *int_status, void **txbuf);
790 efi_status_t (EFIAPI *transmit)(struct efi_simple_network *this,
791 size_t header_size, size_t buffer_size, void *buffer,
792 struct efi_mac_address *src_addr,
793 struct efi_mac_address *dest_addr, u16 *protocol);
794 efi_status_t (EFIAPI *receive)(struct efi_simple_network *this,
795 size_t *header_size, size_t *buffer_size, void *buffer,
796 struct efi_mac_address *src_addr,
797 struct efi_mac_address *dest_addr, u16 *protocol);
798 struct efi_event *wait_for_packet;
799 struct efi_simple_network_mode *mode;
802 #define EFI_PXE_GUID \
803 EFI_GUID(0x03c4e603, 0xac28, 0x11d3, \
804 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
806 struct efi_pxe_packet {
820 u8 dhcp_discover_valid;
821 u8 dhcp_ack_received;
822 u8 proxy_offer_received;
823 u8 pxe_discover_valid;
824 u8 pxe_reply_received;
825 u8 pxe_bis_reply_received;
826 u8 icmp_error_received;
827 u8 tftp_error_received;
832 struct efi_ip_address station_ip;
833 struct efi_ip_address subnet_mask;
834 struct efi_pxe_packet dhcp_discover;
835 struct efi_pxe_packet dhcp_ack;
836 struct efi_pxe_packet proxy_offer;
837 struct efi_pxe_packet pxe_discover;
838 struct efi_pxe_packet pxe_reply;
843 void (EFIAPI *start)(void);
844 void (EFIAPI *stop)(void);
845 void (EFIAPI *dhcp)(void);
846 void (EFIAPI *discover)(void);
847 void (EFIAPI *mftp)(void);
848 void (EFIAPI *udpwrite)(void);
849 void (EFIAPI *udpread)(void);
850 void (EFIAPI *setipfilter)(void);
851 void (EFIAPI *arp)(void);
852 void (EFIAPI *setparams)(void);
853 void (EFIAPI *setstationip)(void);
854 void (EFIAPI *setpackets)(void);
855 struct efi_pxe_mode *mode;
858 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID \
859 EFI_GUID(0x964e5b22, 0x6459, 0x11d2, \
860 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
861 #define EFI_FILE_PROTOCOL_REVISION 0x00010000
863 struct efi_file_handle {
865 efi_status_t (EFIAPI *open)(struct efi_file_handle *file,
866 struct efi_file_handle **new_handle,
867 s16 *file_name, u64 open_mode, u64 attributes);
868 efi_status_t (EFIAPI *close)(struct efi_file_handle *file);
869 efi_status_t (EFIAPI *delete)(struct efi_file_handle *file);
870 efi_status_t (EFIAPI *read)(struct efi_file_handle *file,
871 efi_uintn_t *buffer_size, void *buffer);
872 efi_status_t (EFIAPI *write)(struct efi_file_handle *file,
873 efi_uintn_t *buffer_size, void *buffer);
874 efi_status_t (EFIAPI *getpos)(struct efi_file_handle *file,
876 efi_status_t (EFIAPI *setpos)(struct efi_file_handle *file,
878 efi_status_t (EFIAPI *getinfo)(struct efi_file_handle *file,
879 const efi_guid_t *info_type, efi_uintn_t *buffer_size,
881 efi_status_t (EFIAPI *setinfo)(struct efi_file_handle *file,
882 const efi_guid_t *info_type, efi_uintn_t buffer_size,
884 efi_status_t (EFIAPI *flush)(struct efi_file_handle *file);
887 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID \
888 EFI_GUID(0x964e5b22, 0x6459, 0x11d2, \
889 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
890 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION 0x00010000
892 struct efi_simple_file_system_protocol {
894 efi_status_t (EFIAPI *open_volume)(struct efi_simple_file_system_protocol *this,
895 struct efi_file_handle **root);
898 #define EFI_FILE_INFO_GUID \
899 EFI_GUID(0x9576e92, 0x6d3f, 0x11d2, \
900 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
902 #define EFI_FILE_SYSTEM_INFO_GUID \
903 EFI_GUID(0x09576e93, 0x6d3f, 0x11d2, \
904 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
906 #define EFI_FILE_MODE_READ 0x0000000000000001
907 #define EFI_FILE_MODE_WRITE 0x0000000000000002
908 #define EFI_FILE_MODE_CREATE 0x8000000000000000
910 #define EFI_FILE_READ_ONLY 0x0000000000000001
911 #define EFI_FILE_HIDDEN 0x0000000000000002
912 #define EFI_FILE_SYSTEM 0x0000000000000004
913 #define EFI_FILE_RESERVED 0x0000000000000008
914 #define EFI_FILE_DIRECTORY 0x0000000000000010
915 #define EFI_FILE_ARCHIVE 0x0000000000000020
916 #define EFI_FILE_VALID_ATTR 0x0000000000000037
918 struct efi_file_info {
922 struct efi_time create_time;
923 struct efi_time last_access_time;
924 struct efi_time modification_time;
929 struct efi_file_system_info {
938 #define EFI_DRIVER_BINDING_PROTOCOL_GUID \
939 EFI_GUID(0x18a031ab, 0xb443, 0x4d1a,\
940 0xa5, 0xc0, 0x0c, 0x09, 0x26, 0x1e, 0x9f, 0x71)
941 struct efi_driver_binding_protocol {
942 efi_status_t (EFIAPI * supported)(
943 struct efi_driver_binding_protocol *this,
944 efi_handle_t controller_handle,
945 struct efi_device_path *remaining_device_path);
946 efi_status_t (EFIAPI * start)(
947 struct efi_driver_binding_protocol *this,
948 efi_handle_t controller_handle,
949 struct efi_device_path *remaining_device_path);
950 efi_status_t (EFIAPI * stop)(
951 struct efi_driver_binding_protocol *this,
952 efi_handle_t controller_handle,
953 efi_uintn_t number_of_children,
954 efi_handle_t *child_handle_buffer);
956 efi_handle_t image_handle;
957 efi_handle_t driver_binding_handle;