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
23 #ifdef CONFIG_EFI_LOADER
24 #include <asm/setjmp.h>
27 /* UEFI spec version 2.8 */
28 #define EFI_SPECIFICATION_VERSION (2 << 16 | 80)
30 /* Types and defines for EFI CreateEvent */
31 enum efi_timer_delay {
33 EFI_TIMER_PERIODIC = 1,
34 EFI_TIMER_RELATIVE = 2
37 #define efi_intn_t ssize_t
38 #define efi_uintn_t size_t
39 typedef void *efi_hii_handle_t;
40 typedef u16 *efi_string_t;
41 typedef u16 efi_string_id_t;
42 typedef u32 efi_hii_font_style_t;
43 typedef u16 efi_question_id_t;
44 typedef u16 efi_image_id_t;
45 typedef u16 efi_form_id_t;
47 #define EVT_TIMER 0x80000000
48 #define EVT_RUNTIME 0x40000000
49 #define EVT_NOTIFY_WAIT 0x00000100
50 #define EVT_NOTIFY_SIGNAL 0x00000200
51 #define EVT_SIGNAL_EXIT_BOOT_SERVICES 0x00000201
52 #define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE 0x60000202
54 #define TPL_APPLICATION 0x04
55 #define TPL_CALLBACK 0x08
56 #define TPL_NOTIFY 0x10
57 #define TPL_HIGH_LEVEL 0x1F
61 /* OsIndicationsSupported flags */
62 #define EFI_OS_INDICATIONS_BOOT_TO_FW_UI 0x0000000000000001
63 #define EFI_OS_INDICATIONS_TIMESTAMP_REVOCATION 0x0000000000000002
64 #define EFI_OS_INDICATIONS_FILE_CAPSULE_DELIVERY_SUPPORTED 0x0000000000000004
65 #define EFI_OS_INDICATIONS_FMP_CAPSULE_SUPPORTED 0x0000000000000008
66 #define EFI_OS_INDICATIONS_CAPSULE_RESULT_VAR_SUPPORTED 0x0000000000000010
67 #define EFI_OS_INDICATIONS_START_OS_RECOVERY 0x0000000000000020
68 #define EFI_OS_INDICATIONS_START_PLATFORM_RECOVERY 0x0000000000000040
69 #define EFI_OS_INDICATIONS_JSON_CONFIG_DATA_REFRESH 0x0000000000000080
71 /* EFI Boot Services table */
72 #define EFI_BOOT_SERVICES_SIGNATURE 0x56524553544f4f42
73 struct efi_boot_services {
74 struct efi_table_hdr hdr;
75 efi_status_t (EFIAPI *raise_tpl)(efi_uintn_t new_tpl);
76 void (EFIAPI *restore_tpl)(efi_uintn_t old_tpl);
78 efi_status_t (EFIAPI *allocate_pages)(int, int, efi_uintn_t,
79 efi_physical_addr_t *);
80 efi_status_t (EFIAPI *free_pages)(efi_physical_addr_t, efi_uintn_t);
81 efi_status_t (EFIAPI *get_memory_map)(efi_uintn_t *memory_map_size,
82 struct efi_mem_desc *desc,
84 efi_uintn_t *desc_size,
86 efi_status_t (EFIAPI *allocate_pool)(int, efi_uintn_t, void **);
87 efi_status_t (EFIAPI *free_pool)(void *);
89 efi_status_t (EFIAPI *create_event)(uint32_t type,
90 efi_uintn_t notify_tpl,
91 void (EFIAPI *notify_function) (
92 struct efi_event *event,
94 void *notify_context, struct efi_event **event);
95 efi_status_t (EFIAPI *set_timer)(struct efi_event *event,
96 enum efi_timer_delay type,
97 uint64_t trigger_time);
98 efi_status_t (EFIAPI *wait_for_event)(efi_uintn_t number_of_events,
99 struct efi_event **event,
101 efi_status_t (EFIAPI *signal_event)(struct efi_event *event);
102 efi_status_t (EFIAPI *close_event)(struct efi_event *event);
103 efi_status_t (EFIAPI *check_event)(struct efi_event *event);
104 #define EFI_NATIVE_INTERFACE 0x00000000
105 efi_status_t (EFIAPI *install_protocol_interface)(
106 efi_handle_t *handle, const efi_guid_t *protocol,
107 int protocol_interface_type, void *protocol_interface);
108 efi_status_t (EFIAPI *reinstall_protocol_interface)(
109 efi_handle_t handle, const efi_guid_t *protocol,
110 void *old_interface, void *new_interface);
111 efi_status_t (EFIAPI *uninstall_protocol_interface)(
112 efi_handle_t handle, const efi_guid_t *protocol,
113 void *protocol_interface);
114 efi_status_t (EFIAPI *handle_protocol)(
115 efi_handle_t handle, const efi_guid_t *protocol,
116 void **protocol_interface);
118 efi_status_t (EFIAPI *register_protocol_notify)(
119 const efi_guid_t *protocol, struct efi_event *event,
120 void **registration);
121 efi_status_t (EFIAPI *locate_handle)(
122 enum efi_locate_search_type search_type,
123 const efi_guid_t *protocol, void *search_key,
124 efi_uintn_t *buffer_size, efi_handle_t *buffer);
125 efi_status_t (EFIAPI *locate_device_path)(const efi_guid_t *protocol,
126 struct efi_device_path **device_path,
127 efi_handle_t *device);
128 efi_status_t (EFIAPI *install_configuration_table)(
129 efi_guid_t *guid, void *table);
131 efi_status_t (EFIAPI *load_image)(bool boot_policiy,
132 efi_handle_t parent_image,
133 struct efi_device_path *file_path, void *source_buffer,
134 efi_uintn_t source_size, efi_handle_t *image);
135 efi_status_t (EFIAPI *start_image)(efi_handle_t handle,
136 efi_uintn_t *exitdata_size,
138 efi_status_t (EFIAPI *exit)(efi_handle_t handle,
139 efi_status_t exit_status,
140 efi_uintn_t exitdata_size, u16 *exitdata);
141 efi_status_t (EFIAPI *unload_image)(efi_handle_t image_handle);
142 efi_status_t (EFIAPI *exit_boot_services)(efi_handle_t image_handle,
143 efi_uintn_t map_key);
145 efi_status_t (EFIAPI *get_next_monotonic_count)(u64 *count);
146 efi_status_t (EFIAPI *stall)(unsigned long usecs);
147 efi_status_t (EFIAPI *set_watchdog_timer)(unsigned long timeout,
148 uint64_t watchdog_code, unsigned long data_size,
149 uint16_t *watchdog_data);
150 efi_status_t(EFIAPI *connect_controller)(efi_handle_t controller_handle,
151 efi_handle_t *driver_image_handle,
152 struct efi_device_path *remaining_device_path,
154 efi_status_t (EFIAPI *disconnect_controller)(
155 efi_handle_t controller_handle,
156 efi_handle_t driver_image_handle,
157 efi_handle_t child_handle);
158 #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001
159 #define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002
160 #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004
161 #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008
162 #define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010
163 #define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020
164 efi_status_t (EFIAPI *open_protocol)(efi_handle_t handle,
165 const efi_guid_t *protocol, void **interface,
166 efi_handle_t agent_handle,
167 efi_handle_t controller_handle, u32 attributes);
168 efi_status_t (EFIAPI *close_protocol)(
169 efi_handle_t handle, const efi_guid_t *protocol,
170 efi_handle_t agent_handle,
171 efi_handle_t controller_handle);
172 efi_status_t(EFIAPI *open_protocol_information)(efi_handle_t handle,
173 const efi_guid_t *protocol,
174 struct efi_open_protocol_info_entry **entry_buffer,
175 efi_uintn_t *entry_count);
176 efi_status_t (EFIAPI *protocols_per_handle)(efi_handle_t handle,
177 efi_guid_t ***protocol_buffer,
178 efi_uintn_t *protocols_buffer_count);
179 efi_status_t (EFIAPI *locate_handle_buffer) (
180 enum efi_locate_search_type search_type,
181 const efi_guid_t *protocol, void *search_key,
182 efi_uintn_t *no_handles, efi_handle_t **buffer);
183 efi_status_t (EFIAPI *locate_protocol)(const efi_guid_t *protocol,
184 void *registration, void **protocol_interface);
185 efi_status_t (EFIAPI *install_multiple_protocol_interfaces)(
186 efi_handle_t *handle, ...);
187 efi_status_t (EFIAPI *uninstall_multiple_protocol_interfaces)(
188 efi_handle_t handle, ...);
189 efi_status_t (EFIAPI *calculate_crc32)(const void *data,
190 efi_uintn_t data_size,
192 void (EFIAPI *copy_mem)(void *destination, const void *source,
194 void (EFIAPI *set_mem)(void *buffer, size_t size, uint8_t value);
195 efi_status_t (EFIAPI *create_event_ex)(
196 uint32_t type, efi_uintn_t notify_tpl,
197 void (EFIAPI *notify_function) (
198 struct efi_event *event,
200 void *notify_context,
201 efi_guid_t *event_group,
202 struct efi_event **event);
205 /* Types and defines for EFI ResetSystem */
206 enum efi_reset_type {
209 EFI_RESET_SHUTDOWN = 2,
210 EFI_RESET_PLATFORM_SPECIFIC = 3,
213 /* EFI Runtime Services table */
214 #define EFI_RUNTIME_SERVICES_SIGNATURE 0x56524553544e5552ULL
216 #define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000
217 #define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE 0x00020000
218 #define CAPSULE_FLAGS_INITIATE_RESET 0x00040000
220 struct efi_capsule_header {
221 efi_guid_t capsule_guid;
224 u32 capsule_image_size;
227 #define EFI_RT_SUPPORTED_GET_TIME 0x0001
228 #define EFI_RT_SUPPORTED_SET_TIME 0x0002
229 #define EFI_RT_SUPPORTED_GET_WAKEUP_TIME 0x0004
230 #define EFI_RT_SUPPORTED_SET_WAKEUP_TIME 0x0008
231 #define EFI_RT_SUPPORTED_GET_VARIABLE 0x0010
232 #define EFI_RT_SUPPORTED_GET_NEXT_VARIABLE_NAME 0x0020
233 #define EFI_RT_SUPPORTED_SET_VARIABLE 0x0040
234 #define EFI_RT_SUPPORTED_SET_VIRTUAL_ADDRESS_MAP 0x0080
235 #define EFI_RT_SUPPORTED_CONVERT_POINTER 0x0100
236 #define EFI_RT_SUPPORTED_GET_NEXT_HIGH_MONOTONIC_COUNT 0x0200
237 #define EFI_RT_SUPPORTED_RESET_SYSTEM 0x0400
238 #define EFI_RT_SUPPORTED_UPDATE_CAPSULE 0x0800
239 #define EFI_RT_SUPPORTED_QUERY_CAPSULE_CAPABILITIES 0x1000
240 #define EFI_RT_SUPPORTED_QUERY_VARIABLE_INFO 0x2000
242 #define EFI_RT_PROPERTIES_TABLE_GUID \
243 EFI_GUID(0xeb66918a, 0x7eef, 0x402a, 0x84, 0x2e, \
244 0x93, 0x1d, 0x21, 0xc3, 0x8a, 0xe9)
246 #define EFI_RT_PROPERTIES_TABLE_VERSION 0x1
248 struct efi_rt_properties_table {
251 u32 runtime_services_supported;
254 #define EFI_OPTIONAL_PTR 0x00000001
256 struct efi_runtime_services {
257 struct efi_table_hdr hdr;
258 efi_status_t (EFIAPI *get_time)(struct efi_time *time,
259 struct efi_time_cap *capabilities);
260 efi_status_t (EFIAPI *set_time)(struct efi_time *time);
261 efi_status_t (EFIAPI *get_wakeup_time)(char *enabled, char *pending,
262 struct efi_time *time);
263 efi_status_t (EFIAPI *set_wakeup_time)(char enabled,
264 struct efi_time *time);
265 efi_status_t (EFIAPI *set_virtual_address_map)(
266 efi_uintn_t memory_map_size,
267 efi_uintn_t descriptor_size,
268 uint32_t descriptor_version,
269 struct efi_mem_desc *virtmap);
270 efi_status_t (EFIAPI *convert_pointer)(
271 efi_uintn_t debug_disposition, void **address);
272 efi_status_t (EFIAPI *get_variable)(u16 *variable_name,
273 const efi_guid_t *vendor,
275 efi_uintn_t *data_size, void *data);
276 efi_status_t (EFIAPI *get_next_variable_name)(
277 efi_uintn_t *variable_name_size,
278 u16 *variable_name, efi_guid_t *vendor);
279 efi_status_t (EFIAPI *set_variable)(u16 *variable_name,
280 const efi_guid_t *vendor,
282 efi_uintn_t data_size,
284 efi_status_t (EFIAPI *get_next_high_mono_count)(
285 uint32_t *high_count);
286 void (EFIAPI *reset_system)(enum efi_reset_type reset_type,
287 efi_status_t reset_status,
288 unsigned long data_size, void *reset_data);
289 efi_status_t (EFIAPI *update_capsule)(
290 struct efi_capsule_header **capsule_header_array,
291 efi_uintn_t capsule_count,
292 u64 scatter_gather_list);
293 efi_status_t (EFIAPI *query_capsule_caps)(
294 struct efi_capsule_header **capsule_header_array,
295 efi_uintn_t capsule_count,
296 u64 *maximum_capsule_size,
298 efi_status_t (EFIAPI *query_variable_info)(
300 u64 *maximum_variable_storage_size,
301 u64 *remaining_variable_storage_size,
302 u64 *maximum_variable_size);
305 /* EFI event group GUID definitions */
306 #define EFI_EVENT_GROUP_EXIT_BOOT_SERVICES \
307 EFI_GUID(0x27abf055, 0xb1b8, 0x4c26, 0x80, 0x48, \
308 0x74, 0x8f, 0x37, 0xba, 0xa2, 0xdf)
310 #define EFI_EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE \
311 EFI_GUID(0x13fa7698, 0xc831, 0x49c7, 0x87, 0xea, \
312 0x8f, 0x43, 0xfc, 0xc2, 0x51, 0x96)
314 #define EFI_EVENT_GROUP_MEMORY_MAP_CHANGE \
315 EFI_GUID(0x78bee926, 0x692f, 0x48fd, 0x9e, 0xdb, \
316 0x01, 0x42, 0x2e, 0xf0, 0xd7, 0xab)
318 #define EFI_EVENT_GROUP_READY_TO_BOOT \
319 EFI_GUID(0x7ce88fb3, 0x4bd7, 0x4679, 0x87, 0xa8, \
320 0xa8, 0xd8, 0xde, 0xe5, 0x0d, 0x2b)
322 #define EFI_EVENT_GROUP_RESET_SYSTEM \
323 EFI_GUID(0x62da6a56, 0x13fb, 0x485a, 0xa8, 0xda, \
324 0xa3, 0xdd, 0x79, 0x12, 0xcb, 0x6b)
326 /* EFI Configuration Table and GUID definitions */
328 EFI_GUID(0x00000000, 0x0000, 0x0000, 0x00, 0x00, \
329 0x00, 0x00, 0x00, 0x00, 0x00, 0x00)
331 #define EFI_GLOBAL_VARIABLE_GUID \
332 EFI_GUID(0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, \
333 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c)
335 #define EFI_IMAGE_SECURITY_DATABASE_GUID \
336 EFI_GUID(0xd719b2cb, 0x3d3a, 0x4596, 0xa3, 0xbc, \
337 0xda, 0xd0, 0x0e, 0x67, 0x65, 0x6f)
339 #define EFI_FDT_GUID \
340 EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5, \
341 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0)
343 #define EFI_ACPI_TABLE_GUID \
344 EFI_GUID(0x8868e871, 0xe4f1, 0x11d3, \
345 0xbc, 0x22, 0x00, 0x80, 0xc7, 0x3c, 0x88, 0x81)
347 #define SMBIOS_TABLE_GUID \
348 EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3, \
349 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
351 #define EFI_LOAD_FILE_PROTOCOL_GUID \
352 EFI_GUID(0x56ec3091, 0x954c, 0x11d2, \
353 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
355 #define EFI_LOAD_FILE2_PROTOCOL_GUID \
356 EFI_GUID(0x4006c0c1, 0xfcb3, 0x403e, \
357 0x99, 0x6d, 0x4a, 0x6c, 0x87, 0x24, 0xe0, 0x6d)
359 #define EFI_TCG2_FINAL_EVENTS_TABLE_GUID \
360 EFI_GUID(0x1e2ed096, 0x30e2, 0x4254, 0xbd, \
361 0x89, 0x86, 0x3b, 0xbe, 0xf8, 0x23, 0x25)
363 struct efi_configuration_table {
368 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
370 struct efi_system_table {
371 struct efi_table_hdr hdr;
372 u16 *fw_vendor; /* physical addr of wchar_t vendor string */
374 efi_handle_t con_in_handle;
375 struct efi_simple_text_input_protocol *con_in;
376 efi_handle_t con_out_handle;
377 struct efi_simple_text_output_protocol *con_out;
378 efi_handle_t stderr_handle;
379 struct efi_simple_text_output_protocol *std_err;
380 struct efi_runtime_services *runtime;
381 struct efi_boot_services *boottime;
382 efi_uintn_t nr_tables;
383 struct efi_configuration_table *tables;
386 #define EFI_LOADED_IMAGE_PROTOCOL_GUID \
387 EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, \
388 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
390 #define EFI_LOADED_IMAGE_DEVICE_PATH_PROTOCOL_GUID \
391 EFI_GUID(0xbc62157e, 0x3e33, 0x4fec, \
392 0x99, 0x20, 0x2d, 0x3b, 0x36, 0xd7, 0x50, 0xdf)
394 #define EFI_LOADED_IMAGE_PROTOCOL_REVISION 0x1000
396 struct efi_loaded_image {
399 struct efi_system_table *system_table;
400 efi_handle_t device_handle;
401 struct efi_device_path *file_path;
403 u32 load_options_size;
406 aligned_u64 image_size;
407 unsigned int image_code_type;
408 unsigned int image_data_type;
409 efi_status_t (EFIAPI *unload)(efi_handle_t image_handle);
412 #define EFI_DEVICE_PATH_PROTOCOL_GUID \
413 EFI_GUID(0x09576e91, 0x6d3f, 0x11d2, \
414 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
416 #define DEVICE_PATH_TYPE_END 0x7f
417 # define DEVICE_PATH_SUB_TYPE_INSTANCE_END 0x01
418 # define DEVICE_PATH_SUB_TYPE_END 0xff
420 struct efi_device_path {
426 struct efi_mac_addr {
430 #define DEVICE_PATH_TYPE_HARDWARE_DEVICE 0x01
431 # define DEVICE_PATH_SUB_TYPE_MEMORY 0x03
432 # define DEVICE_PATH_SUB_TYPE_VENDOR 0x04
434 struct efi_device_path_memory {
435 struct efi_device_path dp;
441 struct efi_device_path_vendor {
442 struct efi_device_path dp;
447 #define DEVICE_PATH_TYPE_ACPI_DEVICE 0x02
448 # define DEVICE_PATH_SUB_TYPE_ACPI_DEVICE 0x01
450 #define EFI_PNP_ID(ID) (u32)(((ID) << 16) | 0x41D0)
451 #define EISA_PNP_ID(ID) EFI_PNP_ID(ID)
452 #define EISA_PNP_NUM(ID) ((ID) >> 16)
454 struct efi_device_path_acpi_path {
455 struct efi_device_path dp;
460 #define DEVICE_PATH_TYPE_MESSAGING_DEVICE 0x03
461 # define DEVICE_PATH_SUB_TYPE_MSG_ATAPI 0x01
462 # define DEVICE_PATH_SUB_TYPE_MSG_SCSI 0x02
463 # define DEVICE_PATH_SUB_TYPE_MSG_USB 0x05
464 # define DEVICE_PATH_SUB_TYPE_MSG_MAC_ADDR 0x0b
465 # define DEVICE_PATH_SUB_TYPE_MSG_USB_CLASS 0x0f
466 # define DEVICE_PATH_SUB_TYPE_MSG_SATA 0x12
467 # define DEVICE_PATH_SUB_TYPE_MSG_NVME 0x17
468 # define DEVICE_PATH_SUB_TYPE_MSG_SD 0x1a
469 # define DEVICE_PATH_SUB_TYPE_MSG_MMC 0x1d
471 struct efi_device_path_atapi {
472 struct efi_device_path dp;
473 u8 primary_secondary;
475 u16 logical_unit_number;
478 struct efi_device_path_scsi {
479 struct efi_device_path dp;
481 u16 logical_unit_number;
484 struct efi_device_path_usb {
485 struct efi_device_path dp;
486 u8 parent_port_number;
490 struct efi_device_path_sata {
491 struct efi_device_path dp;
493 u16 port_multiplier_port;
494 u16 logical_unit_number;
497 struct efi_device_path_mac_addr {
498 struct efi_device_path dp;
499 struct efi_mac_addr mac;
503 struct efi_device_path_usb_class {
504 struct efi_device_path dp;
512 struct efi_device_path_sd_mmc_path {
513 struct efi_device_path dp;
517 struct efi_device_path_nvme {
518 struct efi_device_path dp;
523 #define DEVICE_PATH_TYPE_MEDIA_DEVICE 0x04
524 # define DEVICE_PATH_SUB_TYPE_HARD_DRIVE_PATH 0x01
525 # define DEVICE_PATH_SUB_TYPE_CDROM_PATH 0x02
526 # define DEVICE_PATH_SUB_TYPE_VENDOR_PATH 0x03
527 # define DEVICE_PATH_SUB_TYPE_FILE_PATH 0x04
529 struct efi_device_path_hard_drive_path {
530 struct efi_device_path dp;
531 u32 partition_number;
534 u8 partition_signature[16];
539 struct efi_device_path_cdrom_path {
540 struct efi_device_path dp;
546 struct efi_device_path_file_path {
547 struct efi_device_path dp;
551 #define EFI_BLOCK_IO_PROTOCOL_GUID \
552 EFI_GUID(0x964e5b21, 0x6459, 0x11d2, \
553 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
555 struct efi_block_io_media {
557 char removable_media;
559 char logical_partition;
567 /* Added in revision 2 of the protocol */
568 u64 lowest_aligned_lba;
569 u32 logical_blocks_per_physical_block;
570 /* Added in revision 3 of the protocol */
571 u32 optimal_transfer_length_granualarity;
574 #define EFI_BLOCK_IO_PROTOCOL_REVISION2 0x00020001
575 #define EFI_BLOCK_IO_PROTOCOL_REVISION3 0x0002001f
577 struct efi_block_io {
579 struct efi_block_io_media *media;
580 efi_status_t (EFIAPI *reset)(struct efi_block_io *this,
581 char extended_verification);
582 efi_status_t (EFIAPI *read_blocks)(struct efi_block_io *this,
583 u32 media_id, u64 lba, efi_uintn_t buffer_size,
585 efi_status_t (EFIAPI *write_blocks)(struct efi_block_io *this,
586 u32 media_id, u64 lba, efi_uintn_t buffer_size,
588 efi_status_t (EFIAPI *flush_blocks)(struct efi_block_io *this);
591 struct simple_text_output_mode {
600 #define EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID \
601 EFI_GUID(0x387477c2, 0x69c7, 0x11d2, \
602 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
604 #define EFI_BLACK 0x00
605 #define EFI_BLUE 0x01
606 #define EFI_GREEN 0x02
607 #define EFI_CYAN 0x03
609 #define EFI_MAGENTA 0x05
610 #define EFI_BROWN 0x06
611 #define EFI_LIGHTGRAY 0x07
612 #define EFI_BRIGHT 0x08
613 #define EFI_DARKGRAY 0x08
614 #define EFI_LIGHTBLUE 0x09
615 #define EFI_LIGHTGREEN 0x0a
616 #define EFI_LIGHTCYAN 0x0b
617 #define EFI_LIGHTRED 0x0c
618 #define EFI_LIGHTMAGENTA 0x0d
619 #define EFI_YELLOW 0x0e
620 #define EFI_WHITE 0x0f
621 #define EFI_BACKGROUND_BLACK 0x00
622 #define EFI_BACKGROUND_BLUE 0x10
623 #define EFI_BACKGROUND_GREEN 0x20
624 #define EFI_BACKGROUND_CYAN 0x30
625 #define EFI_BACKGROUND_RED 0x40
626 #define EFI_BACKGROUND_MAGENTA 0x50
627 #define EFI_BACKGROUND_BROWN 0x60
628 #define EFI_BACKGROUND_LIGHTGRAY 0x70
630 /* extract foreground color from EFI attribute */
631 #define EFI_ATTR_FG(attr) ((attr) & 0x07)
632 /* treat high bit of FG as bright/bold (similar to edk2) */
633 #define EFI_ATTR_BOLD(attr) (((attr) >> 3) & 0x01)
634 /* extract background color from EFI attribute */
635 #define EFI_ATTR_BG(attr) (((attr) >> 4) & 0x7)
637 struct efi_simple_text_output_protocol {
638 efi_status_t (EFIAPI *reset)(
639 struct efi_simple_text_output_protocol *this,
640 char extended_verification);
641 efi_status_t (EFIAPI *output_string)(
642 struct efi_simple_text_output_protocol *this,
643 const efi_string_t str);
644 efi_status_t (EFIAPI *test_string)(
645 struct efi_simple_text_output_protocol *this,
646 const efi_string_t str);
647 efi_status_t(EFIAPI *query_mode)(
648 struct efi_simple_text_output_protocol *this,
649 unsigned long mode_number, unsigned long *columns,
650 unsigned long *rows);
651 efi_status_t(EFIAPI *set_mode)(
652 struct efi_simple_text_output_protocol *this,
653 unsigned long mode_number);
654 efi_status_t(EFIAPI *set_attribute)(
655 struct efi_simple_text_output_protocol *this,
656 unsigned long attribute);
657 efi_status_t(EFIAPI *clear_screen) (
658 struct efi_simple_text_output_protocol *this);
659 efi_status_t(EFIAPI *set_cursor_position) (
660 struct efi_simple_text_output_protocol *this,
661 unsigned long column, unsigned long row);
662 efi_status_t(EFIAPI *enable_cursor)(
663 struct efi_simple_text_output_protocol *this,
665 struct simple_text_output_mode *mode;
668 #define EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL_GUID \
669 EFI_GUID(0xdd9e7534, 0x7762, 0x4698, \
670 0x8c, 0x14, 0xf5, 0x85, 0x17, 0xa6, 0x25, 0xaa)
672 struct efi_input_key {
677 #define EFI_SHIFT_STATE_INVALID 0x00000000
678 #define EFI_RIGHT_SHIFT_PRESSED 0x00000001
679 #define EFI_LEFT_SHIFT_PRESSED 0x00000002
680 #define EFI_RIGHT_CONTROL_PRESSED 0x00000004
681 #define EFI_LEFT_CONTROL_PRESSED 0x00000008
682 #define EFI_RIGHT_ALT_PRESSED 0x00000010
683 #define EFI_LEFT_ALT_PRESSED 0x00000020
684 #define EFI_RIGHT_LOGO_PRESSED 0x00000040
685 #define EFI_LEFT_LOGO_PRESSED 0x00000080
686 #define EFI_MENU_KEY_PRESSED 0x00000100
687 #define EFI_SYS_REQ_PRESSED 0x00000200
688 #define EFI_SHIFT_STATE_VALID 0x80000000
690 #define EFI_TOGGLE_STATE_INVALID 0x00
691 #define EFI_SCROLL_LOCK_ACTIVE 0x01
692 #define EFI_NUM_LOCK_ACTIVE 0x02
693 #define EFI_CAPS_LOCK_ACTIVE 0x04
694 #define EFI_KEY_STATE_EXPOSED 0x40
695 #define EFI_TOGGLE_STATE_VALID 0x80
697 struct efi_key_state {
702 struct efi_key_data {
703 struct efi_input_key key;
704 struct efi_key_state key_state;
707 struct efi_simple_text_input_ex_protocol {
708 efi_status_t (EFIAPI *reset) (
709 struct efi_simple_text_input_ex_protocol *this,
710 bool extended_verification);
711 efi_status_t (EFIAPI *read_key_stroke_ex) (
712 struct efi_simple_text_input_ex_protocol *this,
713 struct efi_key_data *key_data);
714 struct efi_event *wait_for_key_ex;
715 efi_status_t (EFIAPI *set_state) (
716 struct efi_simple_text_input_ex_protocol *this,
717 u8 *key_toggle_state);
718 efi_status_t (EFIAPI *register_key_notify) (
719 struct efi_simple_text_input_ex_protocol *this,
720 struct efi_key_data *key_data,
721 efi_status_t (EFIAPI *key_notify_function)(
722 struct efi_key_data *key_data),
723 void **notify_handle);
724 efi_status_t (EFIAPI *unregister_key_notify) (
725 struct efi_simple_text_input_ex_protocol *this,
726 void *notification_handle);
729 #define EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID \
730 EFI_GUID(0x387477c1, 0x69c7, 0x11d2, \
731 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
733 struct efi_simple_text_input_protocol {
734 efi_status_t(EFIAPI *reset)(struct efi_simple_text_input_protocol *this,
735 bool extended_verification);
736 efi_status_t(EFIAPI *read_key_stroke)(
737 struct efi_simple_text_input_protocol *this,
738 struct efi_input_key *key);
739 struct efi_event *wait_for_key;
742 #define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID \
743 EFI_GUID(0x8b843e20, 0x8132, 0x4852, \
744 0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c)
746 struct efi_device_path_to_text_protocol {
747 uint16_t *(EFIAPI *convert_device_node_to_text)(
748 struct efi_device_path *device_node,
750 bool allow_shortcuts);
751 uint16_t *(EFIAPI *convert_device_path_to_text)(
752 struct efi_device_path *device_path,
754 bool allow_shortcuts);
757 #define EFI_DEVICE_PATH_UTILITIES_PROTOCOL_GUID \
758 EFI_GUID(0x0379be4e, 0xd706, 0x437d, \
759 0xb0, 0x37, 0xed, 0xb8, 0x2f, 0xb7, 0x72, 0xa4)
761 struct efi_device_path_utilities_protocol {
762 efi_uintn_t (EFIAPI *get_device_path_size)(
763 const struct efi_device_path *device_path);
764 struct efi_device_path *(EFIAPI *duplicate_device_path)(
765 const struct efi_device_path *device_path);
766 struct efi_device_path *(EFIAPI *append_device_path)(
767 const struct efi_device_path *src1,
768 const struct efi_device_path *src2);
769 struct efi_device_path *(EFIAPI *append_device_node)(
770 const struct efi_device_path *device_path,
771 const struct efi_device_path *device_node);
772 struct efi_device_path *(EFIAPI *append_device_path_instance)(
773 const struct efi_device_path *device_path,
774 const struct efi_device_path *device_path_instance);
775 struct efi_device_path *(EFIAPI *get_next_device_path_instance)(
776 struct efi_device_path **device_path_instance,
777 efi_uintn_t *device_path_instance_size);
778 bool (EFIAPI *is_device_path_multi_instance)(
779 const struct efi_device_path *device_path);
780 struct efi_device_path *(EFIAPI *create_device_node)(
782 uint8_t node_sub_type,
783 uint16_t node_length);
787 * Human Interface Infrastructure (HII)
789 struct efi_hii_package_list_header {
790 efi_guid_t package_list_guid;
795 * struct efi_hii_package_header - EFI HII package header
797 * @fields: 'fields' replaces the bit-fields defined in the EFI
798 * specification to to avoid possible compiler incompatibilities::
803 struct efi_hii_package_header {
807 #define __EFI_HII_PACKAGE_LEN_SHIFT 0
808 #define __EFI_HII_PACKAGE_TYPE_SHIFT 24
809 #define __EFI_HII_PACKAGE_LEN_MASK 0xffffff
810 #define __EFI_HII_PACKAGE_TYPE_MASK 0xff
812 #define EFI_HII_PACKAGE_TYPE_ALL 0x00
813 #define EFI_HII_PACKAGE_TYPE_GUID 0x01
814 #define EFI_HII_PACKAGE_FORMS 0x02
815 #define EFI_HII_PACKAGE_STRINGS 0x04
816 #define EFI_HII_PACKAGE_FONTS 0x05
817 #define EFI_HII_PACKAGE_IMAGES 0x06
818 #define EFI_HII_PACKAGE_SIMPLE_FONTS 0x07
819 #define EFI_HII_PACKAGE_DEVICE_PATH 0x08
820 #define EFI_HII_PACKAGE_KEYBOARD_LAYOUT 0x09
821 #define EFI_HII_PACKAGE_ANIMATIONS 0x0A
822 #define EFI_HII_PACKAGE_END 0xDF
823 #define EFI_HII_PACKAGE_TYPE_SYSTEM_BEGIN 0xE0
824 #define EFI_HII_PACKAGE_TYPE_SYSTEM_END 0xFF
829 struct efi_hii_guid_package {
830 struct efi_hii_package_header header;
838 struct efi_hii_strings_package {
839 struct efi_hii_package_header header;
841 u32 string_info_offset;
842 u16 language_window[16];
843 efi_string_id_t language_name;
847 struct efi_hii_string_block {
849 /* u8 block_body[]; */
852 #define EFI_HII_SIBT_END 0x00
853 #define EFI_HII_SIBT_STRING_SCSU 0x10
854 #define EFI_HII_SIBT_STRING_SCSU_FONT 0x11
855 #define EFI_HII_SIBT_STRINGS_SCSU 0x12
856 #define EFI_HII_SIBT_STRINGS_SCSU_FONT 0x13
857 #define EFI_HII_SIBT_STRING_UCS2 0x14
858 #define EFI_HII_SIBT_STRING_UCS2_FONT 0x15
859 #define EFI_HII_SIBT_STRINGS_UCS2 0x16
860 #define EFI_HII_SIBT_STRINGS_UCS2_FONT 0x17
861 #define EFI_HII_SIBT_DUPLICATE 0x20
862 #define EFI_HII_SIBT_SKIP2 0x21
863 #define EFI_HII_SIBT_SKIP1 0x22
864 #define EFI_HII_SIBT_EXT1 0x30
865 #define EFI_HII_SIBT_EXT2 0x31
866 #define EFI_HII_SIBT_EXT4 0x32
867 #define EFI_HII_SIBT_FONT 0x40
869 struct efi_hii_sibt_string_ucs2_block {
870 struct efi_hii_string_block header;
874 static inline struct efi_hii_string_block *
875 efi_hii_sibt_string_ucs2_block_next(struct efi_hii_sibt_string_ucs2_block *blk)
877 return ((void *)blk) + sizeof(*blk) +
878 (u16_strlen(blk->string_text) + 1) * 2;
883 * TODO: full scope of definitions
885 struct efi_hii_time {
891 struct efi_hii_date {
898 efi_question_id_t question_id;
899 efi_form_id_t form_id;
900 efi_guid_t form_set_guid;
901 efi_string_id_t device_path;
904 union efi_ifr_type_value {
905 u8 u8; // EFI_IFR_TYPE_NUM_SIZE_8
906 u16 u16; // EFI_IFR_TYPE_NUM_SIZE_16
907 u32 u32; // EFI_IFR_TYPE_NUM_SIZE_32
908 u64 u64; // EFI_IFR_TYPE_NUM_SIZE_64
909 bool b; // EFI_IFR_TYPE_BOOLEAN
910 struct efi_hii_time time; // EFI_IFR_TYPE_TIME
911 struct efi_hii_date date; // EFI_IFR_TYPE_DATE
912 efi_string_id_t string; // EFI_IFR_TYPE_STRING, EFI_IFR_TYPE_ACTION
913 struct efi_hii_ref ref; // EFI_IFR_TYPE_REF
914 // u8 buffer[]; // EFI_IFR_TYPE_BUFFER
917 #define EFI_IFR_TYPE_NUM_SIZE_8 0x00
918 #define EFI_IFR_TYPE_NUM_SIZE_16 0x01
919 #define EFI_IFR_TYPE_NUM_SIZE_32 0x02
920 #define EFI_IFR_TYPE_NUM_SIZE_64 0x03
921 #define EFI_IFR_TYPE_BOOLEAN 0x04
922 #define EFI_IFR_TYPE_TIME 0x05
923 #define EFI_IFR_TYPE_DATE 0x06
924 #define EFI_IFR_TYPE_STRING 0x07
925 #define EFI_IFR_TYPE_OTHER 0x08
926 #define EFI_IFR_TYPE_UNDEFINED 0x09
927 #define EFI_IFR_TYPE_ACTION 0x0A
928 #define EFI_IFR_TYPE_BUFFER 0x0B
929 #define EFI_IFR_TYPE_REF 0x0C
930 #define EFI_IFR_OPTION_DEFAULT 0x10
931 #define EFI_IFR_OPTION_DEFAULT_MFG 0x20
933 #define EFI_IFR_ONE_OF_OPTION_OP 0x09
935 struct efi_ifr_op_header {
941 struct efi_ifr_one_of_option {
942 struct efi_ifr_op_header header;
943 efi_string_id_t option;
946 union efi_ifr_type_value value;
949 typedef efi_uintn_t efi_browser_action_t;
951 #define EFI_BROWSER_ACTION_REQUEST_NONE 0
952 #define EFI_BROWSER_ACTION_REQUEST_RESET 1
953 #define EFI_BROWSER_ACTION_REQUEST_SUBMIT 2
954 #define EFI_BROWSER_ACTION_REQUEST_EXIT 3
955 #define EFI_BROWSER_ACTION_REQUEST_FORM_SUBMIT_EXIT 4
956 #define EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD_EXIT 5
957 #define EFI_BROWSER_ACTION_REQUEST_FORM_APPLY 6
958 #define EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD 7
959 #define EFI_BROWSER_ACTION_REQUEST_RECONNECT 8
961 typedef efi_uintn_t efi_browser_action_request_t;
963 #define EFI_BROWSER_ACTION_CHANGING 0
964 #define EFI_BROWSER_ACTION_CHANGED 1
965 #define EFI_BROWSER_ACTION_RETRIEVE 2
966 #define EFI_BROWSER_ACTION_FORM_OPEN 3
967 #define EFI_BROWSER_ACTION_FORM_CLOSE 4
968 #define EFI_BROWSER_ACTION_SUBMITTED 5
969 #define EFI_BROWSER_ACTION_DEFAULT_STANDARD 0x1000
970 #define EFI_BROWSER_ACTION_DEFAULT_MANUFACTURING 0x1001
971 #define EFI_BROWSER_ACTION_DEFAULT_SAFE 0x1002
972 #define EFI_BROWSER_ACTION_DEFAULT_PLATFORM 0x2000
973 #define EFI_BROWSER_ACTION_DEFAULT_HARDWARE 0x3000
974 #define EFI_BROWSER_ACTION_DEFAULT_FIRMWARE 0x4000
977 * HII keyboard package
980 EFI_KEY_LCTRL, EFI_KEY_A0, EFI_KEY_LALT, EFI_KEY_SPACE_BAR,
981 EFI_KEY_A2, EFI_KEY_A3, EFI_KEY_A4, EFI_KEY_RCTRL, EFI_KEY_LEFT_ARROW,
982 EFI_KEY_DOWN_ARROW, EFI_KEY_RIGHT_ARROW, EFI_KEY_ZERO,
983 EFI_KEY_PERIOD, EFI_KEY_ENTER, EFI_KEY_LSHIFT, EFI_KEY_B0,
984 EFI_KEY_B1, EFI_KEY_B2, EFI_KEY_B3, EFI_KEY_B4, EFI_KEY_B5, EFI_KEY_B6,
985 EFI_KEY_B7, EFI_KEY_B8, EFI_KEY_B9, EFI_KEY_B10, EFI_KEY_RSHIFT,
986 EFI_KEY_UP_ARROW, EFI_KEY_ONE, EFI_KEY_TWO, EFI_KEY_THREE,
987 EFI_KEY_CAPS_LOCK, EFI_KEY_C1, EFI_KEY_C2, EFI_KEY_C3, EFI_KEY_C4,
988 EFI_KEY_C5, EFI_KEY_C6, EFI_KEY_C7, EFI_KEY_C8, EFI_KEY_C9,
989 EFI_KEY_C10, EFI_KEY_C11, EFI_KEY_C12, EFI_KEY_FOUR, EFI_KEY_FIVE,
990 EFI_KEY_SIX, EFI_KEY_PLUS, EFI_KEY_TAB, EFI_KEY_D1, EFI_KEY_D2,
991 EFI_KEY_D3, EFI_KEY_D4, EFI_KEY_D5, EFI_KEY_D6, EFI_KEY_D7, EFI_KEY_D8,
992 EFI_KEY_D9, EFI_KEY_D10, EFI_KEY_D11, EFI_KEY_D12, EFI_KEY_D13,
993 EFI_KEY_DEL, EFI_KEY_END, EFI_KEY_PG_DN, EFI_KEY_SEVEN, EFI_KEY_EIGHT,
994 EFI_KEY_NINE, EFI_KEY_E0, EFI_KEY_E1, EFI_KEY_E2, EFI_KEY_E3,
995 EFI_KEY_E4, EFI_KEY_E5, EFI_KEY_E6, EFI_KEY_E7, EFI_KEY_E8, EFI_KEY_E9,
996 EFI_KEY_E10, EFI_KEY_E11, EFI_KEY_E12, EFI_KEY_BACK_SPACE,
997 EFI_KEY_INS, EFI_KEY_HOME, EFI_KEY_PG_UP, EFI_KEY_NLCK, EFI_KEY_SLASH,
998 EFI_KEY_ASTERISK, EFI_KEY_MINUS, EFI_KEY_ESC, EFI_KEY_F1, EFI_KEY_F2,
999 EFI_KEY_F3, EFI_KEY_F4, EFI_KEY_F5, EFI_KEY_F6, EFI_KEY_F7, EFI_KEY_F8,
1000 EFI_KEY_F9, EFI_KEY_F10, EFI_KEY_F11, EFI_KEY_F12, EFI_KEY_PRINT,
1001 EFI_KEY_SLCK, EFI_KEY_PAUSE,
1004 struct efi_key_descriptor {
1007 u16 shifted_unicode;
1009 u16 shifted_alt_gr_unicode;
1011 u16 affected_attribute;
1014 struct efi_hii_keyboard_layout {
1017 u32 layout_descriptor_string_offset;
1018 u8 descriptor_count;
1019 struct efi_key_descriptor descriptors[];
1022 struct efi_hii_keyboard_package {
1023 struct efi_hii_package_header header;
1025 struct efi_hii_keyboard_layout layout[];
1031 #define EFI_HII_STRING_PROTOCOL_GUID \
1032 EFI_GUID(0x0fd96974, 0x23aa, 0x4cdc, \
1033 0xb9, 0xcb, 0x98, 0xd1, 0x77, 0x50, 0x32, 0x2a)
1035 struct efi_font_info {
1036 efi_hii_font_style_t font_style;
1041 struct efi_hii_string_protocol {
1042 efi_status_t(EFIAPI *new_string)(
1043 const struct efi_hii_string_protocol *this,
1044 efi_hii_handle_t package_list,
1045 efi_string_id_t *string_id,
1047 const u16 *language_name,
1048 const efi_string_t string,
1049 const struct efi_font_info *string_font_info);
1050 efi_status_t(EFIAPI *get_string)(
1051 const struct efi_hii_string_protocol *this,
1053 efi_hii_handle_t package_list,
1054 efi_string_id_t string_id,
1055 efi_string_t string,
1056 efi_uintn_t *string_size,
1057 struct efi_font_info **string_font_info);
1058 efi_status_t(EFIAPI *set_string)(
1059 const struct efi_hii_string_protocol *this,
1060 efi_hii_handle_t package_list,
1061 efi_string_id_t string_id,
1063 const efi_string_t string,
1064 const struct efi_font_info *string_font_info);
1065 efi_status_t(EFIAPI *get_languages)(
1066 const struct efi_hii_string_protocol *this,
1067 efi_hii_handle_t package_list,
1069 efi_uintn_t *languages_size);
1070 efi_status_t(EFIAPI *get_secondary_languages)(
1071 const struct efi_hii_string_protocol *this,
1072 efi_hii_handle_t package_list,
1073 const u8 *primary_language,
1074 u8 *secondary_languages,
1075 efi_uintn_t *secondary_languages_size);
1078 #define EFI_HII_DATABASE_PROTOCOL_GUID \
1079 EFI_GUID(0xef9fc172, 0xa1b2, 0x4693, \
1080 0xb3, 0x27, 0x6d, 0x32, 0xfc, 0x41, 0x60, 0x42)
1082 struct efi_hii_database_protocol {
1083 efi_status_t(EFIAPI *new_package_list)(
1084 const struct efi_hii_database_protocol *this,
1085 const struct efi_hii_package_list_header *package_list,
1086 const efi_handle_t driver_handle,
1087 efi_hii_handle_t *handle);
1088 efi_status_t(EFIAPI *remove_package_list)(
1089 const struct efi_hii_database_protocol *this,
1090 efi_hii_handle_t handle);
1091 efi_status_t(EFIAPI *update_package_list)(
1092 const struct efi_hii_database_protocol *this,
1093 efi_hii_handle_t handle,
1094 const struct efi_hii_package_list_header *package_list);
1095 efi_status_t(EFIAPI *list_package_lists)(
1096 const struct efi_hii_database_protocol *this,
1098 const efi_guid_t *package_guid,
1099 efi_uintn_t *handle_buffer_length,
1100 efi_hii_handle_t *handle);
1101 efi_status_t(EFIAPI *export_package_lists)(
1102 const struct efi_hii_database_protocol *this,
1103 efi_hii_handle_t handle,
1104 efi_uintn_t *buffer_size,
1105 struct efi_hii_package_list_header *buffer);
1106 efi_status_t(EFIAPI *register_package_notify)(
1107 const struct efi_hii_database_protocol *this,
1109 const efi_guid_t *package_guid,
1110 const void *package_notify_fn,
1111 efi_uintn_t notify_type,
1112 efi_handle_t *notify_handle);
1113 efi_status_t(EFIAPI *unregister_package_notify)(
1114 const struct efi_hii_database_protocol *this,
1115 efi_handle_t notification_handle
1117 efi_status_t(EFIAPI *find_keyboard_layouts)(
1118 const struct efi_hii_database_protocol *this,
1119 u16 *key_guid_buffer_length,
1120 efi_guid_t *key_guid_buffer);
1121 efi_status_t(EFIAPI *get_keyboard_layout)(
1122 const struct efi_hii_database_protocol *this,
1123 efi_guid_t *key_guid,
1124 u16 *keyboard_layout_length,
1125 struct efi_hii_keyboard_layout *keyboard_layout);
1126 efi_status_t(EFIAPI *set_keyboard_layout)(
1127 const struct efi_hii_database_protocol *this,
1128 efi_guid_t *key_guid);
1129 efi_status_t(EFIAPI *get_package_list_handle)(
1130 const struct efi_hii_database_protocol *this,
1131 efi_hii_handle_t package_list_handle,
1132 efi_handle_t *driver_handle);
1135 #define EFI_HII_CONFIG_ROUTING_PROTOCOL_GUID \
1136 EFI_GUID(0x587e72d7, 0xcc50, 0x4f79, \
1137 0x82, 0x09, 0xca, 0x29, 0x1f, 0xc1, 0xa1, 0x0f)
1139 struct efi_hii_config_routing_protocol {
1140 efi_status_t(EFIAPI *extract_config)(
1141 const struct efi_hii_config_routing_protocol *this,
1142 const efi_string_t request,
1143 efi_string_t *progress,
1144 efi_string_t *results);
1145 efi_status_t(EFIAPI *export_config)(
1146 const struct efi_hii_config_routing_protocol *this,
1147 efi_string_t *results);
1148 efi_status_t(EFIAPI *route_config)(
1149 const struct efi_hii_config_routing_protocol *this,
1150 const efi_string_t configuration,
1151 efi_string_t *progress);
1152 efi_status_t(EFIAPI *block_to_config)(
1153 const struct efi_hii_config_routing_protocol *this,
1154 const efi_string_t config_request,
1155 const uint8_t *block,
1156 const efi_uintn_t block_size,
1157 efi_string_t *config,
1158 efi_string_t *progress);
1159 efi_status_t(EFIAPI *config_to_block)(
1160 const struct efi_hii_config_routing_protocol *this,
1161 const efi_string_t config_resp,
1162 const uint8_t *block,
1163 const efi_uintn_t *block_size,
1164 efi_string_t *progress);
1165 efi_status_t(EFIAPI *get_alt_config)(
1166 const struct efi_hii_config_routing_protocol *this,
1167 const efi_string_t config_resp,
1168 const efi_guid_t *guid,
1169 const efi_string_t name,
1170 const struct efi_device_path *device_path,
1171 const efi_string_t alt_cfg_id,
1172 efi_string_t *alt_cfg_resp);
1175 #define EFI_HII_CONFIG_ACCESS_PROTOCOL_GUID \
1176 EFI_GUID(0x330d4706, 0xf2a0, 0x4e4f, \
1177 0xa3, 0x69, 0xb6, 0x6f, 0xa8, 0xd5, 0x43, 0x85)
1179 struct efi_hii_config_access_protocol {
1180 efi_status_t(EFIAPI *extract_config_access)(
1181 const struct efi_hii_config_access_protocol *this,
1182 const efi_string_t request,
1183 efi_string_t *progress,
1184 efi_string_t *results);
1185 efi_status_t(EFIAPI *route_config_access)(
1186 const struct efi_hii_config_access_protocol *this,
1187 const efi_string_t configuration,
1188 efi_string_t *progress);
1189 efi_status_t(EFIAPI *form_callback)(
1190 const struct efi_hii_config_access_protocol *this,
1191 efi_browser_action_t action,
1192 efi_question_id_t question_id,
1194 union efi_ifr_type_value *value,
1195 efi_browser_action_request_t *action_request);
1198 #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
1199 EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, \
1200 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
1202 #define EFI_GOT_RGBA8 0
1203 #define EFI_GOT_BGRA8 1
1204 #define EFI_GOT_BITMASK 2
1206 struct efi_gop_mode_info {
1211 u32 pixel_bitmask[4];
1212 u32 pixels_per_scanline;
1215 struct efi_gop_mode {
1218 struct efi_gop_mode_info *info;
1219 unsigned long info_size;
1220 efi_physical_addr_t fb_base;
1221 unsigned long fb_size;
1224 struct efi_gop_pixel {
1231 #define EFI_BLT_VIDEO_FILL 0
1232 #define EFI_BLT_VIDEO_TO_BLT_BUFFER 1
1233 #define EFI_BLT_BUFFER_TO_VIDEO 2
1234 #define EFI_BLT_VIDEO_TO_VIDEO 3
1237 efi_status_t (EFIAPI *query_mode)(struct efi_gop *this, u32 mode_number,
1238 efi_uintn_t *size_of_info,
1239 struct efi_gop_mode_info **info);
1240 efi_status_t (EFIAPI *set_mode)(struct efi_gop *this, u32 mode_number);
1241 efi_status_t (EFIAPI *blt)(struct efi_gop *this,
1242 struct efi_gop_pixel *buffer,
1243 u32 operation, efi_uintn_t sx,
1244 efi_uintn_t sy, efi_uintn_t dx,
1245 efi_uintn_t dy, efi_uintn_t width,
1246 efi_uintn_t height, efi_uintn_t delta);
1247 struct efi_gop_mode *mode;
1250 #define EFI_SIMPLE_NETWORK_PROTOCOL_GUID \
1251 EFI_GUID(0xa19832b9, 0xac25, 0x11d3, \
1252 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
1254 struct efi_mac_address {
1258 struct efi_ip_address {
1260 } __attribute__((aligned(4)));
1262 enum efi_simple_network_state {
1263 EFI_NETWORK_STOPPED,
1264 EFI_NETWORK_STARTED,
1265 EFI_NETWORK_INITIALIZED,
1268 struct efi_simple_network_mode {
1269 enum efi_simple_network_state state;
1271 u32 media_header_size;
1272 u32 max_packet_size;
1274 u32 nvram_access_size;
1275 u32 receive_filter_mask;
1276 u32 receive_filter_setting;
1277 u32 max_mcast_filter_count;
1278 u32 mcast_filter_count;
1279 struct efi_mac_address mcast_filter[16];
1280 struct efi_mac_address current_address;
1281 struct efi_mac_address broadcast_address;
1282 struct efi_mac_address permanent_address;
1285 u8 multitx_supported;
1286 u8 media_present_supported;
1290 /* receive_filters bit mask */
1291 #define EFI_SIMPLE_NETWORK_RECEIVE_UNICAST 0x01
1292 #define EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST 0x02
1293 #define EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST 0x04
1294 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS 0x08
1295 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST 0x10
1297 /* interrupt status bit mask */
1298 #define EFI_SIMPLE_NETWORK_RECEIVE_INTERRUPT 0x01
1299 #define EFI_SIMPLE_NETWORK_TRANSMIT_INTERRUPT 0x02
1300 #define EFI_SIMPLE_NETWORK_COMMAND_INTERRUPT 0x04
1301 #define EFI_SIMPLE_NETWORK_SOFTWARE_INTERRUPT 0x08
1303 /* revision of the simple network protocol */
1304 #define EFI_SIMPLE_NETWORK_PROTOCOL_REVISION 0x00010000
1306 struct efi_simple_network {
1308 efi_status_t (EFIAPI *start)(struct efi_simple_network *this);
1309 efi_status_t (EFIAPI *stop)(struct efi_simple_network *this);
1310 efi_status_t (EFIAPI *initialize)(struct efi_simple_network *this,
1311 ulong extra_rx, ulong extra_tx);
1312 efi_status_t (EFIAPI *reset)(struct efi_simple_network *this,
1313 int extended_verification);
1314 efi_status_t (EFIAPI *shutdown)(struct efi_simple_network *this);
1315 efi_status_t (EFIAPI *receive_filters)(struct efi_simple_network *this,
1316 u32 enable, u32 disable, int reset_mcast_filter,
1317 ulong mcast_filter_count,
1318 struct efi_mac_address *mcast_filter);
1319 efi_status_t (EFIAPI *station_address)(struct efi_simple_network *this,
1320 int reset, struct efi_mac_address *new_mac);
1321 efi_status_t (EFIAPI *statistics)(struct efi_simple_network *this,
1322 int reset, ulong *stat_size, void *stat_table);
1323 efi_status_t (EFIAPI *mcastiptomac)(struct efi_simple_network *this,
1324 int ipv6, struct efi_ip_address *ip,
1325 struct efi_mac_address *mac);
1326 efi_status_t (EFIAPI *nvdata)(struct efi_simple_network *this,
1327 int read_write, ulong offset, ulong buffer_size,
1329 efi_status_t (EFIAPI *get_status)(struct efi_simple_network *this,
1330 u32 *int_status, void **txbuf);
1331 efi_status_t (EFIAPI *transmit)(struct efi_simple_network *this,
1332 size_t header_size, size_t buffer_size, void *buffer,
1333 struct efi_mac_address *src_addr,
1334 struct efi_mac_address *dest_addr, u16 *protocol);
1335 efi_status_t (EFIAPI *receive)(struct efi_simple_network *this,
1336 size_t *header_size, size_t *buffer_size, void *buffer,
1337 struct efi_mac_address *src_addr,
1338 struct efi_mac_address *dest_addr, u16 *protocol);
1339 struct efi_event *wait_for_packet;
1340 struct efi_simple_network_mode *mode;
1341 /* private fields */
1345 #define EFI_PXE_BASE_CODE_PROTOCOL_GUID \
1346 EFI_GUID(0x03c4e603, 0xac28, 0x11d3, \
1347 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
1349 #define EFI_PXE_BASE_CODE_PROTOCOL_REVISION 0x00010000
1350 #define EFI_PXE_BASE_CODE_MAX_IPCNT 8
1352 struct efi_pxe_packet {
1356 struct efi_pxe_mode {
1365 u8 dhcp_discover_valid;
1366 u8 dhcp_ack_received;
1367 u8 proxy_offer_received;
1368 u8 pxe_discover_valid;
1369 u8 pxe_reply_received;
1370 u8 pxe_bis_reply_received;
1371 u8 icmp_error_received;
1372 u8 tftp_error_received;
1377 struct efi_ip_address station_ip;
1378 struct efi_ip_address subnet_mask;
1379 struct efi_pxe_packet dhcp_discover;
1380 struct efi_pxe_packet dhcp_ack;
1381 struct efi_pxe_packet proxy_offer;
1382 struct efi_pxe_packet pxe_discover;
1383 struct efi_pxe_packet pxe_reply;
1386 struct efi_pxe_base_code_srvlist {
1388 u8 accept_any_response;
1390 struct efi_ip_address ip_addr;
1393 struct efi_pxe_base_code_discover_info {
1398 struct efi_ip_address server_m_cast_ip;
1400 struct efi_pxe_base_code_srvlist srv_list[];
1403 struct efi_pxe_base_code_mtftp_info {
1404 struct efi_ip_address m_cast_ip;
1408 u16 transit_timeout;
1411 struct efi_pxe_base_code_filter {
1415 struct efi_ip_address ip_list[EFI_PXE_BASE_CODE_MAX_IPCNT];
1418 struct efi_pxe_base_code_dhcpv4_packet {
1426 u8 bootp_ci_addr[4];
1427 u8 bootp_yi_addr[4];
1428 u8 bootp_si_addr[4];
1429 u8 bootp_gi_addr[4];
1430 u8 bootp_hw_addr[16];
1431 u8 bootp_srv_name[64];
1432 u8 bootp_boot_file[128];
1434 u8 dhcp_options[56];
1437 struct efi_pxe_base_code_dhcpv6_packet {
1439 u8 transaction_id[3];
1440 u8 dhcp_options[1024];
1445 struct efi_pxe_base_code_dhcpv4_packet dhcpv4;
1446 struct efi_pxe_base_code_dhcpv6_packet dhcpv6;
1447 } EFI_PXE_BASE_CODE_PACKET;
1449 struct efi_pxe_base_code_protocol {
1451 efi_status_t (EFIAPI *start)(struct efi_pxe_base_code_protocol *this,
1453 efi_status_t (EFIAPI *stop)(struct efi_pxe_base_code_protocol *this);
1454 efi_status_t (EFIAPI *dhcp)(struct efi_pxe_base_code_protocol *this,
1456 efi_status_t (EFIAPI *discover)(
1457 struct efi_pxe_base_code_protocol *this,
1458 u16 type, u16 *layer, u8 bis,
1459 struct efi_pxe_base_code_discover_info *info);
1460 efi_status_t (EFIAPI *mtftp)(
1461 struct efi_pxe_base_code_protocol *this,
1462 u32 operation, void *buffer_ptr,
1463 u8 overwrite, efi_uintn_t *buffer_size,
1464 struct efi_ip_address server_ip, char *filename,
1465 struct efi_pxe_base_code_mtftp_info *info,
1466 u8 dont_use_buffer);
1467 efi_status_t (EFIAPI *udp_write)(
1468 struct efi_pxe_base_code_protocol *this,
1469 u16 op_flags, struct efi_ip_address *dest_ip,
1471 struct efi_ip_address *gateway_ip,
1472 struct efi_ip_address *src_ip, u16 *src_port,
1473 efi_uintn_t *header_size, void *header_ptr,
1474 efi_uintn_t *buffer_size, void *buffer_ptr);
1475 efi_status_t (EFIAPI *udp_read)(
1476 struct efi_pxe_base_code_protocol *this,
1477 u16 op_flags, struct efi_ip_address *dest_ip,
1478 u16 *dest_port, struct efi_ip_address *src_ip,
1479 u16 *src_port, efi_uintn_t *header_size,
1480 void *header_ptr, efi_uintn_t *buffer_size,
1482 efi_status_t (EFIAPI *set_ip_filter)(
1483 struct efi_pxe_base_code_protocol *this,
1484 struct efi_pxe_base_code_filter *new_filter);
1485 efi_status_t (EFIAPI *arp)(struct efi_pxe_base_code_protocol *this,
1486 struct efi_ip_address *ip_addr,
1487 struct efi_mac_address *mac_addr);
1488 efi_status_t (EFIAPI *set_parameters)(
1489 struct efi_pxe_base_code_protocol *this,
1490 u8 *new_auto_arp, u8 *new_send_guid,
1491 u8 *new_ttl, u8 *new_tos,
1492 u8 *new_make_callback);
1493 efi_status_t (EFIAPI *set_station_ip)(
1494 struct efi_pxe_base_code_protocol *this,
1495 struct efi_ip_address *new_station_ip,
1496 struct efi_ip_address *new_subnet_mask);
1497 efi_status_t (EFIAPI *set_packets)(
1498 struct efi_pxe_base_code_protocol *this,
1499 u8 *new_dhcp_discover_valid,
1500 u8 *new_dhcp_ack_received,
1501 u8 *new_proxy_offer_received,
1502 u8 *new_pxe_discover_valid,
1503 u8 *new_pxe_reply_received,
1504 u8 *new_pxe_bis_reply_received,
1505 EFI_PXE_BASE_CODE_PACKET *new_dchp_discover,
1506 EFI_PXE_BASE_CODE_PACKET *new_dhcp_acc,
1507 EFI_PXE_BASE_CODE_PACKET *new_proxy_offer,
1508 EFI_PXE_BASE_CODE_PACKET *new_pxe_discover,
1509 EFI_PXE_BASE_CODE_PACKET *new_pxe_reply,
1510 EFI_PXE_BASE_CODE_PACKET *new_pxe_bis_reply);
1511 struct efi_pxe_mode *mode;
1514 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID \
1515 EFI_GUID(0x964e5b22, 0x6459, 0x11d2, \
1516 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
1517 #define EFI_FILE_PROTOCOL_REVISION 0x00010000
1518 #define EFI_FILE_PROTOCOL_REVISION2 0x00020000
1519 #define EFI_FILE_PROTOCOL_LATEST_REVISION EFI_FILE_PROTOCOL_REVISION2
1521 struct efi_file_io_token {
1522 struct efi_event *event;
1523 efi_status_t status;
1524 efi_uintn_t buffer_size;
1527 struct efi_file_handle {
1529 efi_status_t (EFIAPI *open)(struct efi_file_handle *file,
1530 struct efi_file_handle **new_handle,
1531 u16 *file_name, u64 open_mode, u64 attributes);
1532 efi_status_t (EFIAPI *close)(struct efi_file_handle *file);
1533 efi_status_t (EFIAPI *delete)(struct efi_file_handle *file);
1534 efi_status_t (EFIAPI *read)(struct efi_file_handle *file,
1535 efi_uintn_t *buffer_size, void *buffer);
1536 efi_status_t (EFIAPI *write)(struct efi_file_handle *file,
1537 efi_uintn_t *buffer_size, void *buffer);
1538 efi_status_t (EFIAPI *getpos)(struct efi_file_handle *file,
1540 efi_status_t (EFIAPI *setpos)(struct efi_file_handle *file,
1542 efi_status_t (EFIAPI *getinfo)(struct efi_file_handle *file,
1543 const efi_guid_t *info_type, efi_uintn_t *buffer_size,
1545 efi_status_t (EFIAPI *setinfo)(struct efi_file_handle *file,
1546 const efi_guid_t *info_type, efi_uintn_t buffer_size,
1548 efi_status_t (EFIAPI *flush)(struct efi_file_handle *file);
1549 efi_status_t (EFIAPI *open_ex)(struct efi_file_handle *file,
1550 struct efi_file_handle **new_handle,
1551 u16 *file_name, u64 open_mode, u64 attributes,
1552 struct efi_file_io_token *token);
1553 efi_status_t (EFIAPI *read_ex)(struct efi_file_handle *file,
1554 struct efi_file_io_token *token);
1555 efi_status_t (EFIAPI *write_ex)(struct efi_file_handle *file,
1556 struct efi_file_io_token *token);
1557 efi_status_t (EFIAPI *flush_ex)(struct efi_file_handle *file,
1558 struct efi_file_io_token *token);
1561 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION 0x00010000
1563 struct efi_simple_file_system_protocol {
1565 efi_status_t (EFIAPI *open_volume)(struct efi_simple_file_system_protocol *this,
1566 struct efi_file_handle **root);
1569 #define EFI_FILE_INFO_GUID \
1570 EFI_GUID(0x9576e92, 0x6d3f, 0x11d2, \
1571 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
1573 #define EFI_FILE_SYSTEM_INFO_GUID \
1574 EFI_GUID(0x09576e93, 0x6d3f, 0x11d2, \
1575 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
1577 #define EFI_FILE_SYSTEM_VOLUME_LABEL_ID \
1578 EFI_GUID(0xdb47d7d3, 0xfe81, 0x11d3, \
1579 0x9a, 0x35, 0x00, 0x90, 0x27, 0x3f, 0xC1, 0x4d)
1581 #define EFI_FILE_MODE_READ 0x0000000000000001
1582 #define EFI_FILE_MODE_WRITE 0x0000000000000002
1583 #define EFI_FILE_MODE_CREATE 0x8000000000000000
1585 #define EFI_FILE_READ_ONLY 0x0000000000000001
1586 #define EFI_FILE_HIDDEN 0x0000000000000002
1587 #define EFI_FILE_SYSTEM 0x0000000000000004
1588 #define EFI_FILE_RESERVED 0x0000000000000008
1589 #define EFI_FILE_DIRECTORY 0x0000000000000010
1590 #define EFI_FILE_ARCHIVE 0x0000000000000020
1591 #define EFI_FILE_VALID_ATTR 0x0000000000000037
1593 struct efi_file_info {
1597 struct efi_time create_time;
1598 struct efi_time last_access_time;
1599 struct efi_time modification_time;
1604 struct efi_file_system_info {
1610 u16 volume_label[0];
1613 #define EFI_DRIVER_BINDING_PROTOCOL_GUID \
1614 EFI_GUID(0x18a031ab, 0xb443, 0x4d1a,\
1615 0xa5, 0xc0, 0x0c, 0x09, 0x26, 0x1e, 0x9f, 0x71)
1616 struct efi_driver_binding_protocol {
1617 efi_status_t (EFIAPI * supported)(
1618 struct efi_driver_binding_protocol *this,
1619 efi_handle_t controller_handle,
1620 struct efi_device_path *remaining_device_path);
1621 efi_status_t (EFIAPI * start)(
1622 struct efi_driver_binding_protocol *this,
1623 efi_handle_t controller_handle,
1624 struct efi_device_path *remaining_device_path);
1625 efi_status_t (EFIAPI * stop)(
1626 struct efi_driver_binding_protocol *this,
1627 efi_handle_t controller_handle,
1628 efi_uintn_t number_of_children,
1629 efi_handle_t *child_handle_buffer);
1631 efi_handle_t image_handle;
1632 efi_handle_t driver_binding_handle;
1635 /* Deprecated version of the Unicode collation protocol */
1636 #define EFI_UNICODE_COLLATION_PROTOCOL_GUID \
1637 EFI_GUID(0x1d85cd7f, 0xf43d, 0x11d2, \
1638 0x9a, 0x0c, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
1639 /* Current version of the Unicode collation protocol */
1640 #define EFI_UNICODE_COLLATION_PROTOCOL2_GUID \
1641 EFI_GUID(0xa4c751fc, 0x23ae, 0x4c3e, \
1642 0x92, 0xe9, 0x49, 0x64, 0xcf, 0x63, 0xf3, 0x49)
1643 struct efi_unicode_collation_protocol {
1644 efi_intn_t (EFIAPI *stri_coll)(
1645 struct efi_unicode_collation_protocol *this, u16 *s1, u16 *s2);
1646 bool (EFIAPI *metai_match)(struct efi_unicode_collation_protocol *this,
1647 const u16 *string, const u16 *patter);
1648 void (EFIAPI *str_lwr)(struct efi_unicode_collation_protocol
1649 *this, u16 *string);
1650 void (EFIAPI *str_upr)(struct efi_unicode_collation_protocol *this,
1652 void (EFIAPI *fat_to_str)(struct efi_unicode_collation_protocol *this,
1653 efi_uintn_t fat_size, char *fat, u16 *string);
1654 bool (EFIAPI *str_to_fat)(struct efi_unicode_collation_protocol *this,
1655 const u16 *string, efi_uintn_t fat_size,
1657 char *supported_languages;
1660 struct efi_load_file_protocol {
1661 efi_status_t (EFIAPI *load_file)(struct efi_load_file_protocol *this,
1662 struct efi_device_path *file_path,
1664 efi_uintn_t *buffer_size,
1668 /* Boot manager load options */
1669 #define LOAD_OPTION_ACTIVE 0x00000001
1670 #define LOAD_OPTION_FORCE_RECONNECT 0x00000002
1671 #define LOAD_OPTION_HIDDEN 0x00000008
1672 /* All values 0x00000200-0x00001F00 are reserved */
1673 #define LOAD_OPTION_CATEGORY 0x00001F00
1674 #define LOAD_OPTION_CATEGORY_BOOT 0x00000000
1675 #define LOAD_OPTION_CATEGORY_APP 0x00000100
1678 * System Resource Table
1680 /* Firmware Type Definitions */
1681 #define ESRT_FW_TYPE_UNKNOWN 0x00000000
1682 #define ESRT_FW_TYPE_SYSTEMFIRMWARE 0x00000001
1683 #define ESRT_FW_TYPE_DEVICEFIRMWARE 0x00000002
1684 #define ESRT_FW_TYPE_UEFIDRIVER 0x00000003
1686 /* Last Attempt Status Values */
1687 #define LAST_ATTEMPT_STATUS_SUCCESS 0x00000000
1688 #define LAST_ATTEMPT_STATUS_ERROR_UNSUCCESSFUL 0x00000001
1689 #define LAST_ATTEMPT_STATUS_ERROR_INSUFFICIENT_RESOURCES 0x00000002
1690 #define LAST_ATTEMPT_STATUS_ERROR_INCORRECT_VERSION 0x00000003
1691 #define LAST_ATTEMPT_STATUS_ERROR_INVALID_FORMAT 0x00000004
1692 #define LAST_ATTEMPT_STATUS_ERROR_AUTH_ERROR 0x00000005
1693 #define LAST_ATTEMPT_STATUS_ERROR_PWR_EVT_AC 0x00000006
1694 #define LAST_ATTEMPT_STATUS_ERROR_PWR_EVT_BATT 0x00000007
1695 #define LAST_ATTEMPT_STATUS_ERROR_UNSATISFIED_DEPENDENCIES 0x00000008
1698 * The LastAttemptStatus values of 0x1000 - 0x4000 are reserved for vendor
1701 #define LAST_ATTEMPT_STATUS_ERROR_UNSUCCESSFUL_VENDOR_RANGE_MIN 0x00001000
1702 #define LAST_ATTEMPT_STATUS_ERROR_UNSUCCESSFUL_VENDOR_RANGE_MAX 0x00004000
1704 /* Certificate types in signature database */
1705 #define EFI_CERT_SHA256_GUID \
1706 EFI_GUID(0xc1c41626, 0x504c, 0x4092, 0xac, 0xa9, \
1707 0x41, 0xf9, 0x36, 0x93, 0x43, 0x28)
1708 #define EFI_CERT_RSA2048_GUID \
1709 EFI_GUID(0x3c5766e8, 0x269c, 0x4e34, 0xaa, 0x14, \
1710 0xed, 0x77, 0x6e, 0x85, 0xb3, 0xb6)
1711 #define EFI_CERT_X509_GUID \
1712 EFI_GUID(0xa5c059a1, 0x94e4, 0x4aa7, 0x87, 0xb5, \
1713 0xab, 0x15, 0x5c, 0x2b, 0xf0, 0x72)
1714 #define EFI_CERT_X509_SHA256_GUID \
1715 EFI_GUID(0x3bd2a492, 0x96c0, 0x4079, 0xb4, 0x20, \
1716 0xfc, 0xf9, 0x8e, 0xf1, 0x03, 0xed)
1717 #define EFI_CERT_TYPE_PKCS7_GUID \
1718 EFI_GUID(0x4aafd29d, 0x68df, 0x49ee, 0x8a, 0xa9, \
1719 0x34, 0x7d, 0x37, 0x56, 0x65, 0xa7)
1722 * win_certificate_uefi_guid - A certificate that encapsulates
1723 * a GUID-specific signature
1725 * @hdr: Windows certificate header
1726 * @cert_type: Certificate type
1727 * @cert_data: Certificate data
1729 struct win_certificate_uefi_guid {
1730 WIN_CERTIFICATE hdr;
1731 efi_guid_t cert_type;
1733 } __attribute__((__packed__));
1736 * efi_variable_authentication_2 - A time-based authentication method
1739 * This structure describes an authentication information for
1740 * a variable with EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
1741 * and should be included as part of a variable's value.
1742 * Only EFI_CERT_TYPE_PKCS7_GUID is accepted.
1744 * @time_stamp: Descriptor's time stamp
1745 * @auth_info: Authentication info
1747 struct efi_variable_authentication_2 {
1748 struct efi_time time_stamp;
1749 struct win_certificate_uefi_guid auth_info;
1750 } __attribute__((__packed__));
1753 * efi_signature_data - A format of signature
1755 * This structure describes a single signature in signature database.
1757 * @signature_owner: Signature owner
1758 * @signature_data: Signature data
1760 struct efi_signature_data {
1761 efi_guid_t signature_owner;
1762 u8 signature_data[];
1763 } __attribute__((__packed__));
1766 * efi_signature_list - A format of signature database
1768 * This structure describes a list of signatures with the same type.
1769 * An authenticated variable's value is a concatenation of one or more
1770 * efi_signature_list's.
1772 * @signature_type: Signature type
1773 * @signature_list_size: Size of signature list
1774 * @signature_header_size: Size of signature header
1775 * @signature_size: Size of signature
1777 struct efi_signature_list {
1778 efi_guid_t signature_type;
1779 u32 signature_list_size;
1780 u32 signature_header_size;
1782 /* u8 signature_header[signature_header_size]; */
1783 /* struct efi_signature_data signatures[...][signature_size]; */
1784 } __attribute__((__packed__));