1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Extensible Firmware Interface
4 * Based on 'Extensible Firmware Interface Specification' version 0.9,
7 * Copyright (C) 1999 VA Linux Systems
8 * Copyright (C) 1999 Walt Drummond <drummond@valinux.com>
9 * Copyright (C) 1999, 2002-2003 Hewlett-Packard Co.
10 * David Mosberger-Tang <davidm@hpl.hp.com>
11 * Stephane Eranian <eranian@hpl.hp.com>
13 * From include/linux/efi.h in kernel 4.1 with some additions/subtractions
21 #ifdef CONFIG_EFI_LOADER
22 #include <asm/setjmp.h>
25 /* UEFI spec version 2.7 */
26 #define EFI_SPECIFICATION_VERSION (2 << 16 | 70)
28 /* Types and defines for EFI CreateEvent */
29 enum efi_timer_delay {
31 EFI_TIMER_PERIODIC = 1,
32 EFI_TIMER_RELATIVE = 2
35 #define efi_intn_t ssize_t
36 #define efi_uintn_t size_t
37 typedef uint16_t *efi_string_t;
39 #define EVT_TIMER 0x80000000
40 #define EVT_RUNTIME 0x40000000
41 #define EVT_NOTIFY_WAIT 0x00000100
42 #define EVT_NOTIFY_SIGNAL 0x00000200
43 #define EVT_SIGNAL_EXIT_BOOT_SERVICES 0x00000201
44 #define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE 0x60000202
46 #define TPL_APPLICATION 0x04
47 #define TPL_CALLBACK 0x08
48 #define TPL_NOTIFY 0x10
49 #define TPL_HIGH_LEVEL 0x1F
53 /* EFI Boot Services table */
54 #define EFI_BOOT_SERVICES_SIGNATURE 0x56524553544f4f42
55 struct efi_boot_services {
56 struct efi_table_hdr hdr;
57 efi_status_t (EFIAPI *raise_tpl)(efi_uintn_t new_tpl);
58 void (EFIAPI *restore_tpl)(efi_uintn_t old_tpl);
60 efi_status_t (EFIAPI *allocate_pages)(int, int, efi_uintn_t,
61 efi_physical_addr_t *);
62 efi_status_t (EFIAPI *free_pages)(efi_physical_addr_t, efi_uintn_t);
63 efi_status_t (EFIAPI *get_memory_map)(efi_uintn_t *memory_map_size,
64 struct efi_mem_desc *desc,
66 efi_uintn_t *desc_size,
68 efi_status_t (EFIAPI *allocate_pool)(int, efi_uintn_t, void **);
69 efi_status_t (EFIAPI *free_pool)(void *);
71 efi_status_t (EFIAPI *create_event)(uint32_t type,
72 efi_uintn_t notify_tpl,
73 void (EFIAPI *notify_function) (
74 struct efi_event *event,
76 void *notify_context, struct efi_event **event);
77 efi_status_t (EFIAPI *set_timer)(struct efi_event *event,
78 enum efi_timer_delay type,
79 uint64_t trigger_time);
80 efi_status_t (EFIAPI *wait_for_event)(efi_uintn_t number_of_events,
81 struct efi_event **event,
83 efi_status_t (EFIAPI *signal_event)(struct efi_event *event);
84 efi_status_t (EFIAPI *close_event)(struct efi_event *event);
85 efi_status_t (EFIAPI *check_event)(struct efi_event *event);
86 #define EFI_NATIVE_INTERFACE 0x00000000
87 efi_status_t (EFIAPI *install_protocol_interface)(
88 efi_handle_t *handle, const efi_guid_t *protocol,
89 int protocol_interface_type, void *protocol_interface);
90 efi_status_t (EFIAPI *reinstall_protocol_interface)(
91 efi_handle_t handle, const efi_guid_t *protocol,
92 void *old_interface, void *new_interface);
93 efi_status_t (EFIAPI *uninstall_protocol_interface)(
94 efi_handle_t handle, const efi_guid_t *protocol,
95 void *protocol_interface);
96 efi_status_t (EFIAPI *handle_protocol)(
97 efi_handle_t handle, const efi_guid_t *protocol,
98 void **protocol_interface);
100 efi_status_t (EFIAPI *register_protocol_notify)(
101 const efi_guid_t *protocol, struct efi_event *event,
102 void **registration);
103 efi_status_t (EFIAPI *locate_handle)(
104 enum efi_locate_search_type search_type,
105 const efi_guid_t *protocol, void *search_key,
106 efi_uintn_t *buffer_size, efi_handle_t *buffer);
107 efi_status_t (EFIAPI *locate_device_path)(const efi_guid_t *protocol,
108 struct efi_device_path **device_path,
109 efi_handle_t *device);
110 efi_status_t (EFIAPI *install_configuration_table)(
111 efi_guid_t *guid, void *table);
113 efi_status_t (EFIAPI *load_image)(bool boot_policiy,
114 efi_handle_t parent_image,
115 struct efi_device_path *file_path, void *source_buffer,
116 efi_uintn_t source_size, efi_handle_t *image);
117 efi_status_t (EFIAPI *start_image)(efi_handle_t handle,
118 efi_uintn_t *exitdata_size,
120 efi_status_t (EFIAPI *exit)(efi_handle_t handle,
121 efi_status_t exit_status,
122 efi_uintn_t exitdata_size, u16 *exitdata);
123 efi_status_t (EFIAPI *unload_image)(efi_handle_t image_handle);
124 efi_status_t (EFIAPI *exit_boot_services)(efi_handle_t, unsigned long);
126 efi_status_t (EFIAPI *get_next_monotonic_count)(u64 *count);
127 efi_status_t (EFIAPI *stall)(unsigned long usecs);
128 efi_status_t (EFIAPI *set_watchdog_timer)(unsigned long timeout,
129 uint64_t watchdog_code, unsigned long data_size,
130 uint16_t *watchdog_data);
131 efi_status_t(EFIAPI *connect_controller)(efi_handle_t controller_handle,
132 efi_handle_t *driver_image_handle,
133 struct efi_device_path *remaining_device_path,
135 efi_status_t (EFIAPI *disconnect_controller)(
136 efi_handle_t controller_handle,
137 efi_handle_t driver_image_handle,
138 efi_handle_t child_handle);
139 #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001
140 #define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002
141 #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004
142 #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008
143 #define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010
144 #define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020
145 efi_status_t (EFIAPI *open_protocol)(efi_handle_t handle,
146 const efi_guid_t *protocol, void **interface,
147 efi_handle_t agent_handle,
148 efi_handle_t controller_handle, u32 attributes);
149 efi_status_t (EFIAPI *close_protocol)(
150 efi_handle_t handle, const efi_guid_t *protocol,
151 efi_handle_t agent_handle,
152 efi_handle_t controller_handle);
153 efi_status_t(EFIAPI *open_protocol_information)(efi_handle_t handle,
154 const efi_guid_t *protocol,
155 struct efi_open_protocol_info_entry **entry_buffer,
156 efi_uintn_t *entry_count);
157 efi_status_t (EFIAPI *protocols_per_handle)(efi_handle_t handle,
158 efi_guid_t ***protocol_buffer,
159 efi_uintn_t *protocols_buffer_count);
160 efi_status_t (EFIAPI *locate_handle_buffer) (
161 enum efi_locate_search_type search_type,
162 const efi_guid_t *protocol, void *search_key,
163 efi_uintn_t *no_handles, efi_handle_t **buffer);
164 efi_status_t (EFIAPI *locate_protocol)(const efi_guid_t *protocol,
165 void *registration, void **protocol_interface);
166 efi_status_t (EFIAPI *install_multiple_protocol_interfaces)(
167 efi_handle_t *handle, ...);
168 efi_status_t (EFIAPI *uninstall_multiple_protocol_interfaces)(
169 efi_handle_t handle, ...);
170 efi_status_t (EFIAPI *calculate_crc32)(const void *data,
171 efi_uintn_t data_size,
173 void (EFIAPI *copy_mem)(void *destination, const void *source,
175 void (EFIAPI *set_mem)(void *buffer, size_t size, uint8_t value);
176 efi_status_t (EFIAPI *create_event_ex)(
177 uint32_t type, efi_uintn_t notify_tpl,
178 void (EFIAPI *notify_function) (
179 struct efi_event *event,
181 void *notify_context,
182 efi_guid_t *event_group,
183 struct efi_event **event);
186 /* Types and defines for EFI ResetSystem */
187 enum efi_reset_type {
190 EFI_RESET_SHUTDOWN = 2,
191 EFI_RESET_PLATFORM_SPECIFIC = 3,
194 /* EFI Runtime Services table */
195 #define EFI_RUNTIME_SERVICES_SIGNATURE 0x56524553544e5552ULL
197 #define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000
198 #define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE 0x00020000
199 #define CAPSULE_FLAGS_INITIATE_RESET 0x00040000
201 struct efi_capsule_header {
202 efi_guid_t *capsule_guid;
205 u32 capsule_image_size;
208 struct efi_runtime_services {
209 struct efi_table_hdr hdr;
210 efi_status_t (EFIAPI *get_time)(struct efi_time *time,
211 struct efi_time_cap *capabilities);
212 efi_status_t (EFIAPI *set_time)(struct efi_time *time);
213 efi_status_t (EFIAPI *get_wakeup_time)(char *enabled, char *pending,
214 struct efi_time *time);
215 efi_status_t (EFIAPI *set_wakeup_time)(char enabled,
216 struct efi_time *time);
217 efi_status_t (EFIAPI *set_virtual_address_map)(
218 unsigned long memory_map_size,
219 unsigned long descriptor_size,
220 uint32_t descriptor_version,
221 struct efi_mem_desc *virtmap);
222 efi_status_t (*convert_pointer)(unsigned long dbg, void **address);
223 efi_status_t (EFIAPI *get_variable)(u16 *variable_name,
224 const efi_guid_t *vendor,
226 efi_uintn_t *data_size, void *data);
227 efi_status_t (EFIAPI *get_next_variable_name)(
228 efi_uintn_t *variable_name_size,
229 u16 *variable_name, const efi_guid_t *vendor);
230 efi_status_t (EFIAPI *set_variable)(u16 *variable_name,
231 const efi_guid_t *vendor,
233 efi_uintn_t data_size,
235 efi_status_t (EFIAPI *get_next_high_mono_count)(
236 uint32_t *high_count);
237 void (EFIAPI *reset_system)(enum efi_reset_type reset_type,
238 efi_status_t reset_status,
239 unsigned long data_size, void *reset_data);
240 efi_status_t (EFIAPI *update_capsule)(
241 struct efi_capsule_header **capsule_header_array,
242 efi_uintn_t capsule_count,
243 u64 scatter_gather_list);
244 efi_status_t (EFIAPI *query_capsule_caps)(
245 struct efi_capsule_header **capsule_header_array,
246 efi_uintn_t capsule_count,
247 u64 *maximum_capsule_size,
249 efi_status_t (EFIAPI *query_variable_info)(
251 u64 *maximum_variable_storage_size,
252 u64 *remaining_variable_storage_size,
253 u64 *maximum_variable_size);
256 /* EFI event group GUID definitions */
257 #define EFI_EVENT_GROUP_EXIT_BOOT_SERVICES \
258 EFI_GUID(0x27abf055, 0xb1b8, 0x4c26, 0x80, 0x48, \
259 0x74, 0x8f, 0x37, 0xba, 0xa2, 0xdf)
261 #define EFI_EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE \
262 EFI_GUID(0x13fa7698, 0xc831, 0x49c7, 0x87, 0xea, \
263 0x8f, 0x43, 0xfc, 0xc2, 0x51, 0x96)
265 #define EFI_EVENT_GROUP_MEMORY_MAP_CHANGE \
266 EFI_GUID(0x78bee926, 0x692f, 0x48fd, 0x9e, 0xdb, \
267 0x01, 0x42, 0x2e, 0xf0, 0xd7, 0xab)
269 #define EFI_EVENT_GROUP_READY_TO_BOOT \
270 EFI_GUID(0x7ce88fb3, 0x4bd7, 0x4679, 0x87, 0xa8, \
271 0xa8, 0xd8, 0xde, 0xe5, 0x0d, 0x2b)
273 #define EFI_EVENT_GROUP_RESET_SYSTEM \
274 EFI_GUID(0x62da6a56, 0x13fb, 0x485a, 0xa8, 0xda, \
275 0xa3, 0xdd, 0x79, 0x12, 0xcb, 0x6b)
277 /* EFI Configuration Table and GUID definitions */
279 EFI_GUID(0x00000000, 0x0000, 0x0000, 0x00, 0x00, \
280 0x00, 0x00, 0x00, 0x00, 0x00, 0x00)
282 #define EFI_GLOBAL_VARIABLE_GUID \
283 EFI_GUID(0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, \
284 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c)
286 #define LOADED_IMAGE_PROTOCOL_GUID \
287 EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, \
288 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
290 #define EFI_FDT_GUID \
291 EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5, \
292 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0)
294 #define EFI_ACPI_TABLE_GUID \
295 EFI_GUID(0x8868e871, 0xe4f1, 0x11d3, \
296 0xbc, 0x22, 0x00, 0x80, 0xc7, 0x3c, 0x88, 0x81)
298 #define SMBIOS_TABLE_GUID \
299 EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3, \
300 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
302 struct efi_configuration_table {
307 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
309 struct efi_system_table {
310 struct efi_table_hdr hdr;
311 u16 *fw_vendor; /* physical addr of wchar_t vendor string */
313 efi_handle_t con_in_handle;
314 struct efi_simple_text_input_protocol *con_in;
315 efi_handle_t con_out_handle;
316 struct efi_simple_text_output_protocol *con_out;
317 efi_handle_t stderr_handle;
318 struct efi_simple_text_output_protocol *std_err;
319 struct efi_runtime_services *runtime;
320 struct efi_boot_services *boottime;
321 efi_uintn_t nr_tables;
322 struct efi_configuration_table *tables;
325 #define LOADED_IMAGE_GUID \
326 EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, \
327 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
329 #define EFI_LOADED_IMAGE_PROTOCOL_REVISION 0x1000
331 struct efi_loaded_image {
334 struct efi_system_table *system_table;
335 efi_handle_t device_handle;
336 struct efi_device_path *file_path;
338 u32 load_options_size;
341 aligned_u64 image_size;
342 unsigned int image_code_type;
343 unsigned int image_data_type;
344 unsigned long unload;
347 #define DEVICE_PATH_GUID \
348 EFI_GUID(0x09576e91, 0x6d3f, 0x11d2, \
349 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
351 #define DEVICE_PATH_TYPE_END 0x7f
352 # define DEVICE_PATH_SUB_TYPE_INSTANCE_END 0x01
353 # define DEVICE_PATH_SUB_TYPE_END 0xff
355 struct efi_device_path {
361 struct efi_mac_addr {
365 #define DEVICE_PATH_TYPE_HARDWARE_DEVICE 0x01
366 # define DEVICE_PATH_SUB_TYPE_MEMORY 0x03
367 # define DEVICE_PATH_SUB_TYPE_VENDOR 0x04
369 struct efi_device_path_memory {
370 struct efi_device_path dp;
376 struct efi_device_path_vendor {
377 struct efi_device_path dp;
382 #define DEVICE_PATH_TYPE_ACPI_DEVICE 0x02
383 # define DEVICE_PATH_SUB_TYPE_ACPI_DEVICE 0x01
385 #define EFI_PNP_ID(ID) (u32)(((ID) << 16) | 0x41D0)
386 #define EISA_PNP_ID(ID) EFI_PNP_ID(ID)
387 #define EISA_PNP_NUM(ID) ((ID) >> 16)
389 struct efi_device_path_acpi_path {
390 struct efi_device_path dp;
395 #define DEVICE_PATH_TYPE_MESSAGING_DEVICE 0x03
396 # define DEVICE_PATH_SUB_TYPE_MSG_ATAPI 0x01
397 # define DEVICE_PATH_SUB_TYPE_MSG_SCSI 0x02
398 # define DEVICE_PATH_SUB_TYPE_MSG_USB 0x05
399 # define DEVICE_PATH_SUB_TYPE_MSG_MAC_ADDR 0x0b
400 # define DEVICE_PATH_SUB_TYPE_MSG_USB_CLASS 0x0f
401 # define DEVICE_PATH_SUB_TYPE_MSG_SD 0x1a
402 # define DEVICE_PATH_SUB_TYPE_MSG_MMC 0x1d
404 struct efi_device_path_atapi {
405 struct efi_device_path dp;
406 u8 primary_secondary;
408 u16 logical_unit_number;
411 struct efi_device_path_scsi {
412 struct efi_device_path dp;
414 u16 logical_unit_number;
417 struct efi_device_path_usb {
418 struct efi_device_path dp;
419 u8 parent_port_number;
423 struct efi_device_path_mac_addr {
424 struct efi_device_path dp;
425 struct efi_mac_addr mac;
429 struct efi_device_path_usb_class {
430 struct efi_device_path dp;
438 struct efi_device_path_sd_mmc_path {
439 struct efi_device_path dp;
443 #define DEVICE_PATH_TYPE_MEDIA_DEVICE 0x04
444 # define DEVICE_PATH_SUB_TYPE_HARD_DRIVE_PATH 0x01
445 # define DEVICE_PATH_SUB_TYPE_CDROM_PATH 0x02
446 # define DEVICE_PATH_SUB_TYPE_FILE_PATH 0x04
448 struct efi_device_path_hard_drive_path {
449 struct efi_device_path dp;
450 u32 partition_number;
453 u8 partition_signature[16];
458 struct efi_device_path_cdrom_path {
459 struct efi_device_path dp;
465 struct efi_device_path_file_path {
466 struct efi_device_path dp;
470 #define BLOCK_IO_GUID \
471 EFI_GUID(0x964e5b21, 0x6459, 0x11d2, \
472 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
474 struct efi_block_io_media {
476 char removable_media;
478 char logical_partition;
486 /* Added in revision 2 of the protocol */
487 u64 lowest_aligned_lba;
488 u32 logical_blocks_per_physical_block;
489 /* Added in revision 3 of the protocol */
490 u32 optimal_transfer_length_granualarity;
493 #define EFI_BLOCK_IO_PROTOCOL_REVISION2 0x00020001
494 #define EFI_BLOCK_IO_PROTOCOL_REVISION3 0x0002001f
496 struct efi_block_io {
498 struct efi_block_io_media *media;
499 efi_status_t (EFIAPI *reset)(struct efi_block_io *this,
500 char extended_verification);
501 efi_status_t (EFIAPI *read_blocks)(struct efi_block_io *this,
502 u32 media_id, u64 lba, efi_uintn_t buffer_size,
504 efi_status_t (EFIAPI *write_blocks)(struct efi_block_io *this,
505 u32 media_id, u64 lba, efi_uintn_t buffer_size,
507 efi_status_t (EFIAPI *flush_blocks)(struct efi_block_io *this);
510 struct simple_text_output_mode {
519 #define EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID \
520 EFI_GUID(0x387477c2, 0x69c7, 0x11d2, \
521 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
523 #define EFI_BLACK 0x00
524 #define EFI_BLUE 0x01
525 #define EFI_GREEN 0x02
526 #define EFI_CYAN 0x03
528 #define EFI_MAGENTA 0x05
529 #define EFI_BROWN 0x06
530 #define EFI_LIGHTGRAY 0x07
531 #define EFI_BRIGHT 0x08
532 #define EFI_DARKGRAY 0x08
533 #define EFI_LIGHTBLUE 0x09
534 #define EFI_LIGHTGREEN 0x0a
535 #define EFI_LIGHTCYAN 0x0b
536 #define EFI_LIGHTRED 0x0c
537 #define EFI_LIGHTMAGENTA 0x0d
538 #define EFI_YELLOW 0x0e
539 #define EFI_WHITE 0x0f
540 #define EFI_BACKGROUND_BLACK 0x00
541 #define EFI_BACKGROUND_BLUE 0x10
542 #define EFI_BACKGROUND_GREEN 0x20
543 #define EFI_BACKGROUND_CYAN 0x30
544 #define EFI_BACKGROUND_RED 0x40
545 #define EFI_BACKGROUND_MAGENTA 0x50
546 #define EFI_BACKGROUND_BROWN 0x60
547 #define EFI_BACKGROUND_LIGHTGRAY 0x70
549 /* extract foreground color from EFI attribute */
550 #define EFI_ATTR_FG(attr) ((attr) & 0x07)
551 /* treat high bit of FG as bright/bold (similar to edk2) */
552 #define EFI_ATTR_BOLD(attr) (((attr) >> 3) & 0x01)
553 /* extract background color from EFI attribute */
554 #define EFI_ATTR_BG(attr) (((attr) >> 4) & 0x7)
556 struct efi_simple_text_output_protocol {
558 efi_status_t (EFIAPI *output_string)(
559 struct efi_simple_text_output_protocol *this,
560 const efi_string_t str);
561 efi_status_t (EFIAPI *test_string)(
562 struct efi_simple_text_output_protocol *this,
563 const efi_string_t str);
564 efi_status_t(EFIAPI *query_mode)(
565 struct efi_simple_text_output_protocol *this,
566 unsigned long mode_number, unsigned long *columns,
567 unsigned long *rows);
568 efi_status_t(EFIAPI *set_mode)(
569 struct efi_simple_text_output_protocol *this,
570 unsigned long mode_number);
571 efi_status_t(EFIAPI *set_attribute)(
572 struct efi_simple_text_output_protocol *this,
573 unsigned long attribute);
574 efi_status_t(EFIAPI *clear_screen) (
575 struct efi_simple_text_output_protocol *this);
576 efi_status_t(EFIAPI *set_cursor_position) (
577 struct efi_simple_text_output_protocol *this,
578 unsigned long column, unsigned long row);
579 efi_status_t(EFIAPI *enable_cursor)(
580 struct efi_simple_text_output_protocol *this,
582 struct simple_text_output_mode *mode;
585 #define EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL_GUID \
586 EFI_GUID(0xdd9e7534, 0x7762, 0x4698, \
587 0x8c, 0x14, 0xf5, 0x85, 0x17, 0xa6, 0x25, 0xaa)
589 struct efi_input_key {
594 #define EFI_SHIFT_STATE_INVALID 0x00000000
595 #define EFI_RIGHT_SHIFT_PRESSED 0x00000001
596 #define EFI_LEFT_SHIFT_PRESSED 0x00000002
597 #define EFI_RIGHT_CONTROL_PRESSED 0x00000004
598 #define EFI_LEFT_CONTROL_PRESSED 0x00000008
599 #define EFI_RIGHT_ALT_PRESSED 0x00000010
600 #define EFI_LEFT_ALT_PRESSED 0x00000020
601 #define EFI_RIGHT_LOGO_PRESSED 0x00000040
602 #define EFI_LEFT_LOGO_PRESSED 0x00000080
603 #define EFI_MENU_KEY_PRESSED 0x00000100
604 #define EFI_SYS_REQ_PRESSED 0x00000200
605 #define EFI_SHIFT_STATE_VALID 0x80000000
607 #define EFI_TOGGLE_STATE_INVALID 0x00
608 #define EFI_SCROLL_LOCK_ACTIVE 0x01
609 #define EFI_NUM_LOCK_ACTIVE 0x02
610 #define EFI_CAPS_LOCK_ACTIVE 0x04
611 #define EFI_KEY_STATE_EXPOSED 0x40
612 #define EFI_TOGGLE_STATE_VALID 0x80
614 struct efi_key_state {
619 struct efi_key_data {
620 struct efi_input_key key;
621 struct efi_key_state key_state;
624 struct efi_simple_text_input_ex_protocol {
625 efi_status_t (EFIAPI *reset) (
626 struct efi_simple_text_input_ex_protocol *this,
627 bool extended_verification);
628 efi_status_t (EFIAPI *read_key_stroke_ex) (
629 struct efi_simple_text_input_ex_protocol *this,
630 struct efi_key_data *key_data);
631 struct efi_event *wait_for_key_ex;
632 efi_status_t (EFIAPI *set_state) (
633 struct efi_simple_text_input_ex_protocol *this,
634 u8 key_toggle_state);
635 efi_status_t (EFIAPI *register_key_notify) (
636 struct efi_simple_text_input_ex_protocol *this,
637 struct efi_key_data *key_data,
638 efi_status_t (EFIAPI *key_notify_function)(
639 struct efi_key_data *key_data),
640 void **notify_handle);
641 efi_status_t (EFIAPI *unregister_key_notify) (
642 struct efi_simple_text_input_ex_protocol *this,
643 void *notification_handle);
646 #define EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID \
647 EFI_GUID(0x387477c1, 0x69c7, 0x11d2, \
648 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
650 struct efi_simple_text_input_protocol {
651 efi_status_t(EFIAPI *reset)(struct efi_simple_text_input_protocol *this,
652 bool extended_verification);
653 efi_status_t(EFIAPI *read_key_stroke)(
654 struct efi_simple_text_input_protocol *this,
655 struct efi_input_key *key);
656 struct efi_event *wait_for_key;
659 #define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID \
660 EFI_GUID(0x8b843e20, 0x8132, 0x4852, \
661 0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c)
663 struct efi_device_path_to_text_protocol {
664 uint16_t *(EFIAPI *convert_device_node_to_text)(
665 struct efi_device_path *device_node,
667 bool allow_shortcuts);
668 uint16_t *(EFIAPI *convert_device_path_to_text)(
669 struct efi_device_path *device_path,
671 bool allow_shortcuts);
674 #define EFI_DEVICE_PATH_UTILITIES_PROTOCOL_GUID \
675 EFI_GUID(0x0379be4e, 0xd706, 0x437d, \
676 0xb0, 0x37, 0xed, 0xb8, 0x2f, 0xb7, 0x72, 0xa4)
678 struct efi_device_path_utilities_protocol {
679 efi_uintn_t (EFIAPI *get_device_path_size)(
680 const struct efi_device_path *device_path);
681 struct efi_device_path *(EFIAPI *duplicate_device_path)(
682 const struct efi_device_path *device_path);
683 struct efi_device_path *(EFIAPI *append_device_path)(
684 const struct efi_device_path *src1,
685 const struct efi_device_path *src2);
686 struct efi_device_path *(EFIAPI *append_device_node)(
687 const struct efi_device_path *device_path,
688 const struct efi_device_path *device_node);
689 struct efi_device_path *(EFIAPI *append_device_path_instance)(
690 const struct efi_device_path *device_path,
691 const struct efi_device_path *device_path_instance);
692 struct efi_device_path *(EFIAPI *get_next_device_path_instance)(
693 struct efi_device_path **device_path_instance,
694 efi_uintn_t *device_path_instance_size);
695 bool (EFIAPI *is_device_path_multi_instance)(
696 const struct efi_device_path *device_path);
697 struct efi_device_path *(EFIAPI *create_device_node)(
699 uint8_t node_sub_type,
700 uint16_t node_length);
703 #define EFI_GOP_GUID \
704 EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, \
705 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
707 #define EFI_GOT_RGBA8 0
708 #define EFI_GOT_BGRA8 1
709 #define EFI_GOT_BITMASK 2
711 struct efi_gop_mode_info {
716 u32 pixel_bitmask[4];
717 u32 pixels_per_scanline;
720 struct efi_gop_mode {
723 struct efi_gop_mode_info *info;
724 unsigned long info_size;
725 efi_physical_addr_t fb_base;
726 unsigned long fb_size;
729 struct efi_gop_pixel {
736 #define EFI_BLT_VIDEO_FILL 0
737 #define EFI_BLT_VIDEO_TO_BLT_BUFFER 1
738 #define EFI_BLT_BUFFER_TO_VIDEO 2
739 #define EFI_BLT_VIDEO_TO_VIDEO 3
742 efi_status_t (EFIAPI *query_mode)(struct efi_gop *this, u32 mode_number,
743 efi_uintn_t *size_of_info,
744 struct efi_gop_mode_info **info);
745 efi_status_t (EFIAPI *set_mode)(struct efi_gop *this, u32 mode_number);
746 efi_status_t (EFIAPI *blt)(struct efi_gop *this,
747 struct efi_gop_pixel *buffer,
748 u32 operation, efi_uintn_t sx,
749 efi_uintn_t sy, efi_uintn_t dx,
750 efi_uintn_t dy, efi_uintn_t width,
751 efi_uintn_t height, efi_uintn_t delta);
752 struct efi_gop_mode *mode;
755 #define EFI_SIMPLE_NETWORK_GUID \
756 EFI_GUID(0xa19832b9, 0xac25, 0x11d3, \
757 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
759 struct efi_mac_address {
763 struct efi_ip_address {
765 } __attribute__((aligned(4)));
767 enum efi_simple_network_state {
770 EFI_NETWORK_INITIALIZED,
773 struct efi_simple_network_mode {
774 enum efi_simple_network_state state;
776 u32 media_header_size;
779 u32 nvram_access_size;
780 u32 receive_filter_mask;
781 u32 receive_filter_setting;
782 u32 max_mcast_filter_count;
783 u32 mcast_filter_count;
784 struct efi_mac_address mcast_filter[16];
785 struct efi_mac_address current_address;
786 struct efi_mac_address broadcast_address;
787 struct efi_mac_address permanent_address;
790 u8 multitx_supported;
791 u8 media_present_supported;
795 /* receive_filters bit mask */
796 #define EFI_SIMPLE_NETWORK_RECEIVE_UNICAST 0x01
797 #define EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST 0x02
798 #define EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST 0x04
799 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS 0x08
800 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST 0x10
802 /* interrupt status bit mask */
803 #define EFI_SIMPLE_NETWORK_RECEIVE_INTERRUPT 0x01
804 #define EFI_SIMPLE_NETWORK_TRANSMIT_INTERRUPT 0x02
805 #define EFI_SIMPLE_NETWORK_COMMAND_INTERRUPT 0x04
806 #define EFI_SIMPLE_NETWORK_SOFTWARE_INTERRUPT 0x08
808 /* revision of the simple network protocol */
809 #define EFI_SIMPLE_NETWORK_PROTOCOL_REVISION 0x00010000
811 struct efi_simple_network {
813 efi_status_t (EFIAPI *start)(struct efi_simple_network *this);
814 efi_status_t (EFIAPI *stop)(struct efi_simple_network *this);
815 efi_status_t (EFIAPI *initialize)(struct efi_simple_network *this,
816 ulong extra_rx, ulong extra_tx);
817 efi_status_t (EFIAPI *reset)(struct efi_simple_network *this,
818 int extended_verification);
819 efi_status_t (EFIAPI *shutdown)(struct efi_simple_network *this);
820 efi_status_t (EFIAPI *receive_filters)(struct efi_simple_network *this,
821 u32 enable, u32 disable, int reset_mcast_filter,
822 ulong mcast_filter_count,
823 struct efi_mac_address *mcast_filter);
824 efi_status_t (EFIAPI *station_address)(struct efi_simple_network *this,
825 int reset, struct efi_mac_address *new_mac);
826 efi_status_t (EFIAPI *statistics)(struct efi_simple_network *this,
827 int reset, ulong *stat_size, void *stat_table);
828 efi_status_t (EFIAPI *mcastiptomac)(struct efi_simple_network *this,
829 int ipv6, struct efi_ip_address *ip,
830 struct efi_mac_address *mac);
831 efi_status_t (EFIAPI *nvdata)(struct efi_simple_network *this,
832 int read_write, ulong offset, ulong buffer_size,
834 efi_status_t (EFIAPI *get_status)(struct efi_simple_network *this,
835 u32 *int_status, void **txbuf);
836 efi_status_t (EFIAPI *transmit)(struct efi_simple_network *this,
837 size_t header_size, size_t buffer_size, void *buffer,
838 struct efi_mac_address *src_addr,
839 struct efi_mac_address *dest_addr, u16 *protocol);
840 efi_status_t (EFIAPI *receive)(struct efi_simple_network *this,
841 size_t *header_size, size_t *buffer_size, void *buffer,
842 struct efi_mac_address *src_addr,
843 struct efi_mac_address *dest_addr, u16 *protocol);
844 struct efi_event *wait_for_packet;
845 struct efi_simple_network_mode *mode;
848 #define EFI_PXE_GUID \
849 EFI_GUID(0x03c4e603, 0xac28, 0x11d3, \
850 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
852 struct efi_pxe_packet {
856 struct efi_pxe_mode {
865 u8 dhcp_discover_valid;
866 u8 dhcp_ack_received;
867 u8 proxy_offer_received;
868 u8 pxe_discover_valid;
869 u8 pxe_reply_received;
870 u8 pxe_bis_reply_received;
871 u8 icmp_error_received;
872 u8 tftp_error_received;
877 struct efi_ip_address station_ip;
878 struct efi_ip_address subnet_mask;
879 struct efi_pxe_packet dhcp_discover;
880 struct efi_pxe_packet dhcp_ack;
881 struct efi_pxe_packet proxy_offer;
882 struct efi_pxe_packet pxe_discover;
883 struct efi_pxe_packet pxe_reply;
888 void (EFIAPI *start)(void);
889 void (EFIAPI *stop)(void);
890 void (EFIAPI *dhcp)(void);
891 void (EFIAPI *discover)(void);
892 void (EFIAPI *mftp)(void);
893 void (EFIAPI *udpwrite)(void);
894 void (EFIAPI *udpread)(void);
895 void (EFIAPI *setipfilter)(void);
896 void (EFIAPI *arp)(void);
897 void (EFIAPI *setparams)(void);
898 void (EFIAPI *setstationip)(void);
899 void (EFIAPI *setpackets)(void);
900 struct efi_pxe_mode *mode;
903 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID \
904 EFI_GUID(0x964e5b22, 0x6459, 0x11d2, \
905 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
906 #define EFI_FILE_PROTOCOL_REVISION 0x00010000
908 struct efi_file_handle {
910 efi_status_t (EFIAPI *open)(struct efi_file_handle *file,
911 struct efi_file_handle **new_handle,
912 u16 *file_name, u64 open_mode, u64 attributes);
913 efi_status_t (EFIAPI *close)(struct efi_file_handle *file);
914 efi_status_t (EFIAPI *delete)(struct efi_file_handle *file);
915 efi_status_t (EFIAPI *read)(struct efi_file_handle *file,
916 efi_uintn_t *buffer_size, void *buffer);
917 efi_status_t (EFIAPI *write)(struct efi_file_handle *file,
918 efi_uintn_t *buffer_size, void *buffer);
919 efi_status_t (EFIAPI *getpos)(struct efi_file_handle *file,
921 efi_status_t (EFIAPI *setpos)(struct efi_file_handle *file,
923 efi_status_t (EFIAPI *getinfo)(struct efi_file_handle *file,
924 const efi_guid_t *info_type, efi_uintn_t *buffer_size,
926 efi_status_t (EFIAPI *setinfo)(struct efi_file_handle *file,
927 const efi_guid_t *info_type, efi_uintn_t buffer_size,
929 efi_status_t (EFIAPI *flush)(struct efi_file_handle *file);
932 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID \
933 EFI_GUID(0x964e5b22, 0x6459, 0x11d2, \
934 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
935 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION 0x00010000
937 struct efi_simple_file_system_protocol {
939 efi_status_t (EFIAPI *open_volume)(struct efi_simple_file_system_protocol *this,
940 struct efi_file_handle **root);
943 #define EFI_FILE_INFO_GUID \
944 EFI_GUID(0x9576e92, 0x6d3f, 0x11d2, \
945 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
947 #define EFI_FILE_SYSTEM_INFO_GUID \
948 EFI_GUID(0x09576e93, 0x6d3f, 0x11d2, \
949 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
951 #define EFI_FILE_MODE_READ 0x0000000000000001
952 #define EFI_FILE_MODE_WRITE 0x0000000000000002
953 #define EFI_FILE_MODE_CREATE 0x8000000000000000
955 #define EFI_FILE_READ_ONLY 0x0000000000000001
956 #define EFI_FILE_HIDDEN 0x0000000000000002
957 #define EFI_FILE_SYSTEM 0x0000000000000004
958 #define EFI_FILE_RESERVED 0x0000000000000008
959 #define EFI_FILE_DIRECTORY 0x0000000000000010
960 #define EFI_FILE_ARCHIVE 0x0000000000000020
961 #define EFI_FILE_VALID_ATTR 0x0000000000000037
963 struct efi_file_info {
967 struct efi_time create_time;
968 struct efi_time last_access_time;
969 struct efi_time modification_time;
974 struct efi_file_system_info {
983 #define EFI_DRIVER_BINDING_PROTOCOL_GUID \
984 EFI_GUID(0x18a031ab, 0xb443, 0x4d1a,\
985 0xa5, 0xc0, 0x0c, 0x09, 0x26, 0x1e, 0x9f, 0x71)
986 struct efi_driver_binding_protocol {
987 efi_status_t (EFIAPI * supported)(
988 struct efi_driver_binding_protocol *this,
989 efi_handle_t controller_handle,
990 struct efi_device_path *remaining_device_path);
991 efi_status_t (EFIAPI * start)(
992 struct efi_driver_binding_protocol *this,
993 efi_handle_t controller_handle,
994 struct efi_device_path *remaining_device_path);
995 efi_status_t (EFIAPI * stop)(
996 struct efi_driver_binding_protocol *this,
997 efi_handle_t controller_handle,
998 efi_uintn_t number_of_children,
999 efi_handle_t *child_handle_buffer);
1001 efi_handle_t image_handle;
1002 efi_handle_t driver_binding_handle;
1005 #define EFI_UNICODE_COLLATION_PROTOCOL2_GUID \
1006 EFI_GUID(0xa4c751fc, 0x23ae, 0x4c3e, \
1007 0x92, 0xe9, 0x49, 0x64, 0xcf, 0x63, 0xf3, 0x49)
1008 struct efi_unicode_collation_protocol {
1009 efi_intn_t (EFIAPI *stri_coll)(
1010 struct efi_unicode_collation_protocol *this, u16 *s1, u16 *s2);
1011 bool (EFIAPI *metai_match)(struct efi_unicode_collation_protocol *this,
1012 const u16 *string, const u16 *patter);
1013 void (EFIAPI *str_lwr)(struct efi_unicode_collation_protocol
1014 *this, u16 *string);
1015 void (EFIAPI *str_upr)(struct efi_unicode_collation_protocol *this,
1017 void (EFIAPI *fat_to_str)(struct efi_unicode_collation_protocol *this,
1018 efi_uintn_t fat_size, char *fat, u16 *string);
1019 bool (EFIAPI *str_to_fat)(struct efi_unicode_collation_protocol *this,
1020 const u16 *string, efi_uintn_t fat_size,
1022 char *supported_languages;