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 /* UEFI spec version 2.8 */
24 #define EFI_SPECIFICATION_VERSION (2 << 16 | 80)
26 /* Types and defines for EFI CreateEvent */
27 enum efi_timer_delay {
29 EFI_TIMER_PERIODIC = 1,
30 EFI_TIMER_RELATIVE = 2
33 typedef void *efi_hii_handle_t;
34 typedef u16 *efi_string_t;
35 typedef u16 efi_string_id_t;
36 typedef u32 efi_hii_font_style_t;
37 typedef u16 efi_question_id_t;
38 typedef u16 efi_image_id_t;
39 typedef u16 efi_form_id_t;
41 #define EVT_TIMER 0x80000000
42 #define EVT_RUNTIME 0x40000000
43 #define EVT_NOTIFY_WAIT 0x00000100
44 #define EVT_NOTIFY_SIGNAL 0x00000200
45 #define EVT_SIGNAL_EXIT_BOOT_SERVICES 0x00000201
46 #define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE 0x60000202
48 #define TPL_APPLICATION 0x04
49 #define TPL_CALLBACK 0x08
50 #define TPL_NOTIFY 0x10
51 #define TPL_HIGH_LEVEL 0x1F
55 /* OsIndicationsSupported flags */
56 #define EFI_OS_INDICATIONS_BOOT_TO_FW_UI 0x0000000000000001
57 #define EFI_OS_INDICATIONS_TIMESTAMP_REVOCATION 0x0000000000000002
58 #define EFI_OS_INDICATIONS_FILE_CAPSULE_DELIVERY_SUPPORTED 0x0000000000000004
59 #define EFI_OS_INDICATIONS_FMP_CAPSULE_SUPPORTED 0x0000000000000008
60 #define EFI_OS_INDICATIONS_CAPSULE_RESULT_VAR_SUPPORTED 0x0000000000000010
61 #define EFI_OS_INDICATIONS_START_OS_RECOVERY 0x0000000000000020
62 #define EFI_OS_INDICATIONS_START_PLATFORM_RECOVERY 0x0000000000000040
63 #define EFI_OS_INDICATIONS_JSON_CONFIG_DATA_REFRESH 0x0000000000000080
65 /* EFI Boot Services table */
66 #define EFI_BOOT_SERVICES_SIGNATURE 0x56524553544f4f42
67 struct efi_boot_services {
68 struct efi_table_hdr hdr;
69 efi_status_t (EFIAPI *raise_tpl)(efi_uintn_t new_tpl);
70 void (EFIAPI *restore_tpl)(efi_uintn_t old_tpl);
72 efi_status_t (EFIAPI *allocate_pages)(int, int, efi_uintn_t,
73 efi_physical_addr_t *);
74 efi_status_t (EFIAPI *free_pages)(efi_physical_addr_t, efi_uintn_t);
75 efi_status_t (EFIAPI *get_memory_map)(efi_uintn_t *memory_map_size,
76 struct efi_mem_desc *desc,
78 efi_uintn_t *desc_size,
80 efi_status_t (EFIAPI *allocate_pool)(int, efi_uintn_t, void **);
81 efi_status_t (EFIAPI *free_pool)(void *);
83 efi_status_t (EFIAPI *create_event)(uint32_t type,
84 efi_uintn_t notify_tpl,
85 void (EFIAPI *notify_function) (
86 struct efi_event *event,
88 void *notify_context, struct efi_event **event);
89 efi_status_t (EFIAPI *set_timer)(struct efi_event *event,
90 enum efi_timer_delay type,
91 uint64_t trigger_time);
92 efi_status_t (EFIAPI *wait_for_event)(efi_uintn_t number_of_events,
93 struct efi_event **event,
95 efi_status_t (EFIAPI *signal_event)(struct efi_event *event);
96 efi_status_t (EFIAPI *close_event)(struct efi_event *event);
97 efi_status_t (EFIAPI *check_event)(struct efi_event *event);
98 #define EFI_NATIVE_INTERFACE 0x00000000
99 efi_status_t (EFIAPI *install_protocol_interface)(
100 efi_handle_t *handle, const efi_guid_t *protocol,
101 int protocol_interface_type, void *protocol_interface);
102 efi_status_t (EFIAPI *reinstall_protocol_interface)(
103 efi_handle_t handle, const efi_guid_t *protocol,
104 void *old_interface, void *new_interface);
105 efi_status_t (EFIAPI *uninstall_protocol_interface)(
106 efi_handle_t handle, const efi_guid_t *protocol,
107 void *protocol_interface);
108 efi_status_t (EFIAPI *handle_protocol)(
109 efi_handle_t handle, const efi_guid_t *protocol,
110 void **protocol_interface);
112 efi_status_t (EFIAPI *register_protocol_notify)(
113 const efi_guid_t *protocol, struct efi_event *event,
114 void **registration);
115 efi_status_t (EFIAPI *locate_handle)(
116 enum efi_locate_search_type search_type,
117 const efi_guid_t *protocol, void *search_key,
118 efi_uintn_t *buffer_size, efi_handle_t *buffer);
119 efi_status_t (EFIAPI *locate_device_path)(const efi_guid_t *protocol,
120 struct efi_device_path **device_path,
121 efi_handle_t *device);
122 efi_status_t (EFIAPI *install_configuration_table)(
123 efi_guid_t *guid, void *table);
125 efi_status_t (EFIAPI *load_image)(bool boot_policiy,
126 efi_handle_t parent_image,
127 struct efi_device_path *file_path, void *source_buffer,
128 efi_uintn_t source_size, efi_handle_t *image);
129 efi_status_t (EFIAPI *start_image)(efi_handle_t handle,
130 efi_uintn_t *exitdata_size,
132 efi_status_t (EFIAPI *exit)(efi_handle_t handle,
133 efi_status_t exit_status,
134 efi_uintn_t exitdata_size, u16 *exitdata);
135 efi_status_t (EFIAPI *unload_image)(efi_handle_t image_handle);
136 efi_status_t (EFIAPI *exit_boot_services)(efi_handle_t image_handle,
137 efi_uintn_t map_key);
139 efi_status_t (EFIAPI *get_next_monotonic_count)(u64 *count);
140 efi_status_t (EFIAPI *stall)(unsigned long usecs);
141 efi_status_t (EFIAPI *set_watchdog_timer)(unsigned long timeout,
142 uint64_t watchdog_code, unsigned long data_size,
143 uint16_t *watchdog_data);
144 efi_status_t(EFIAPI *connect_controller)(efi_handle_t controller_handle,
145 efi_handle_t *driver_image_handle,
146 struct efi_device_path *remaining_device_path,
148 efi_status_t (EFIAPI *disconnect_controller)(
149 efi_handle_t controller_handle,
150 efi_handle_t driver_image_handle,
151 efi_handle_t child_handle);
152 #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001
153 #define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002
154 #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004
155 #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008
156 #define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010
157 #define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020
158 efi_status_t (EFIAPI *open_protocol)(efi_handle_t handle,
159 const efi_guid_t *protocol, void **interface,
160 efi_handle_t agent_handle,
161 efi_handle_t controller_handle, u32 attributes);
162 efi_status_t (EFIAPI *close_protocol)(
163 efi_handle_t handle, const efi_guid_t *protocol,
164 efi_handle_t agent_handle,
165 efi_handle_t controller_handle);
166 efi_status_t(EFIAPI *open_protocol_information)(efi_handle_t handle,
167 const efi_guid_t *protocol,
168 struct efi_open_protocol_info_entry **entry_buffer,
169 efi_uintn_t *entry_count);
170 efi_status_t (EFIAPI *protocols_per_handle)(efi_handle_t handle,
171 efi_guid_t ***protocol_buffer,
172 efi_uintn_t *protocols_buffer_count);
173 efi_status_t (EFIAPI *locate_handle_buffer) (
174 enum efi_locate_search_type search_type,
175 const efi_guid_t *protocol, void *search_key,
176 efi_uintn_t *no_handles, efi_handle_t **buffer);
177 efi_status_t (EFIAPI *locate_protocol)(const efi_guid_t *protocol,
178 void *registration, void **protocol_interface);
179 efi_status_t (EFIAPI *install_multiple_protocol_interfaces)(
180 efi_handle_t *handle, ...);
181 efi_status_t (EFIAPI *uninstall_multiple_protocol_interfaces)(
182 efi_handle_t handle, ...);
183 efi_status_t (EFIAPI *calculate_crc32)(const void *data,
184 efi_uintn_t data_size,
186 void (EFIAPI *copy_mem)(void *destination, const void *source,
188 void (EFIAPI *set_mem)(void *buffer, size_t size, uint8_t value);
189 efi_status_t (EFIAPI *create_event_ex)(
190 uint32_t type, efi_uintn_t notify_tpl,
191 void (EFIAPI *notify_function) (
192 struct efi_event *event,
194 void *notify_context,
195 efi_guid_t *event_group,
196 struct efi_event **event);
199 /* Types and defines for EFI ResetSystem */
200 enum efi_reset_type {
203 EFI_RESET_SHUTDOWN = 2,
204 EFI_RESET_PLATFORM_SPECIFIC = 3,
207 /* EFI Runtime Services table */
208 #define EFI_RUNTIME_SERVICES_SIGNATURE 0x56524553544e5552ULL
210 #define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000
211 #define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE 0x00020000
212 #define CAPSULE_FLAGS_INITIATE_RESET 0x00040000
214 #define CAPSULE_SUPPORT_AUTHENTICATION 0x0000000000000001
215 #define CAPSULE_SUPPORT_DEPENDENCY 0x0000000000000002
217 #define EFI_CAPSULE_REPORT_GUID \
218 EFI_GUID(0x39b68c46, 0xf7fb, 0x441b, 0xb6, 0xec, \
219 0x16, 0xb0, 0xf6, 0x98, 0x21, 0xf3)
221 #define EFI_MEMORY_RANGE_CAPSULE_GUID \
222 EFI_GUID(0xde9f0ec, 0x88b6, 0x428f, 0x97, 0x7a, \
223 0x25, 0x8f, 0x1d, 0xe, 0x5e, 0x72)
225 #define EFI_FIRMWARE_MANAGEMENT_CAPSULE_ID_GUID \
226 EFI_GUID(0x6dcbd5ed, 0xe82d, 0x4c44, 0xbd, 0xa1, \
227 0x71, 0x94, 0x19, 0x9a, 0xd9, 0x2a)
229 struct efi_capsule_header {
230 efi_guid_t capsule_guid;
233 u32 capsule_image_size;
236 struct efi_capsule_result_variable_header {
237 u32 variable_total_size;
239 efi_guid_t capsule_guid;
240 struct efi_time capsule_processed;
241 efi_status_t capsule_status;
244 struct efi_memory_range {
245 efi_physical_addr_t address;
249 struct efi_memory_range_capsule {
250 struct efi_capsule_header *header;
251 /* EFI_MEMORY_TYPE: 0x80000000-0xFFFFFFFF */
252 enum efi_mem_type os_requested_memory_type;
253 u64 number_of_memory_ranges;
254 struct efi_memory_range memory_ranges[];
257 struct efi_firmware_management_capsule_header {
259 u16 embedded_driver_count;
260 u16 payload_item_count;
261 u64 item_offset_list[];
264 struct efi_firmware_management_capsule_image_header {
266 efi_guid_t update_image_type_id;
267 u8 update_image_index;
269 u32 update_image_size;
270 u32 update_vendor_code_size;
271 u64 update_hardware_instance;
272 u64 image_capsule_support;
275 struct efi_capsule_result_variable_fmp {
278 u8 update_image_index;
279 efi_guid_t update_image_type_id;
280 // u16 capsule_file_name[];
281 // u16 capsule_target[];
284 #define EFI_RT_SUPPORTED_GET_TIME 0x0001
285 #define EFI_RT_SUPPORTED_SET_TIME 0x0002
286 #define EFI_RT_SUPPORTED_GET_WAKEUP_TIME 0x0004
287 #define EFI_RT_SUPPORTED_SET_WAKEUP_TIME 0x0008
288 #define EFI_RT_SUPPORTED_GET_VARIABLE 0x0010
289 #define EFI_RT_SUPPORTED_GET_NEXT_VARIABLE_NAME 0x0020
290 #define EFI_RT_SUPPORTED_SET_VARIABLE 0x0040
291 #define EFI_RT_SUPPORTED_SET_VIRTUAL_ADDRESS_MAP 0x0080
292 #define EFI_RT_SUPPORTED_CONVERT_POINTER 0x0100
293 #define EFI_RT_SUPPORTED_GET_NEXT_HIGH_MONOTONIC_COUNT 0x0200
294 #define EFI_RT_SUPPORTED_RESET_SYSTEM 0x0400
295 #define EFI_RT_SUPPORTED_UPDATE_CAPSULE 0x0800
296 #define EFI_RT_SUPPORTED_QUERY_CAPSULE_CAPABILITIES 0x1000
297 #define EFI_RT_SUPPORTED_QUERY_VARIABLE_INFO 0x2000
299 #define EFI_RT_PROPERTIES_TABLE_GUID \
300 EFI_GUID(0xeb66918a, 0x7eef, 0x402a, 0x84, 0x2e, \
301 0x93, 0x1d, 0x21, 0xc3, 0x8a, 0xe9)
303 #define EFI_RT_PROPERTIES_TABLE_VERSION 0x1
305 struct efi_rt_properties_table {
308 u32 runtime_services_supported;
311 #define EFI_OPTIONAL_PTR 0x00000001
313 struct efi_runtime_services {
314 struct efi_table_hdr hdr;
315 efi_status_t (EFIAPI *get_time)(struct efi_time *time,
316 struct efi_time_cap *capabilities);
317 efi_status_t (EFIAPI *set_time)(struct efi_time *time);
318 efi_status_t (EFIAPI *get_wakeup_time)(char *enabled, char *pending,
319 struct efi_time *time);
320 efi_status_t (EFIAPI *set_wakeup_time)(char enabled,
321 struct efi_time *time);
322 efi_status_t (EFIAPI *set_virtual_address_map)(
323 efi_uintn_t memory_map_size,
324 efi_uintn_t descriptor_size,
325 uint32_t descriptor_version,
326 struct efi_mem_desc *virtmap);
327 efi_status_t (EFIAPI *convert_pointer)(
328 efi_uintn_t debug_disposition, void **address);
329 efi_status_t (EFIAPI *get_variable)(u16 *variable_name,
330 const efi_guid_t *vendor,
332 efi_uintn_t *data_size, void *data);
333 efi_status_t (EFIAPI *get_next_variable_name)(
334 efi_uintn_t *variable_name_size,
335 u16 *variable_name, efi_guid_t *vendor);
336 efi_status_t (EFIAPI *set_variable)(u16 *variable_name,
337 const efi_guid_t *vendor,
339 efi_uintn_t data_size,
341 efi_status_t (EFIAPI *get_next_high_mono_count)(
342 uint32_t *high_count);
343 void (EFIAPI *reset_system)(enum efi_reset_type reset_type,
344 efi_status_t reset_status,
345 unsigned long data_size, void *reset_data);
346 efi_status_t (EFIAPI *update_capsule)(
347 struct efi_capsule_header **capsule_header_array,
348 efi_uintn_t capsule_count,
349 u64 scatter_gather_list);
350 efi_status_t (EFIAPI *query_capsule_caps)(
351 struct efi_capsule_header **capsule_header_array,
352 efi_uintn_t capsule_count,
353 u64 *maximum_capsule_size,
355 efi_status_t (EFIAPI *query_variable_info)(
357 u64 *maximum_variable_storage_size,
358 u64 *remaining_variable_storage_size,
359 u64 *maximum_variable_size);
362 /* EFI event group GUID definitions */
363 #define EFI_EVENT_GROUP_EXIT_BOOT_SERVICES \
364 EFI_GUID(0x27abf055, 0xb1b8, 0x4c26, 0x80, 0x48, \
365 0x74, 0x8f, 0x37, 0xba, 0xa2, 0xdf)
367 #define EFI_EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE \
368 EFI_GUID(0x13fa7698, 0xc831, 0x49c7, 0x87, 0xea, \
369 0x8f, 0x43, 0xfc, 0xc2, 0x51, 0x96)
371 #define EFI_EVENT_GROUP_MEMORY_MAP_CHANGE \
372 EFI_GUID(0x78bee926, 0x692f, 0x48fd, 0x9e, 0xdb, \
373 0x01, 0x42, 0x2e, 0xf0, 0xd7, 0xab)
375 #define EFI_EVENT_GROUP_READY_TO_BOOT \
376 EFI_GUID(0x7ce88fb3, 0x4bd7, 0x4679, 0x87, 0xa8, \
377 0xa8, 0xd8, 0xde, 0xe5, 0x0d, 0x2b)
379 #define EFI_EVENT_GROUP_RESET_SYSTEM \
380 EFI_GUID(0x62da6a56, 0x13fb, 0x485a, 0xa8, 0xda, \
381 0xa3, 0xdd, 0x79, 0x12, 0xcb, 0x6b)
383 /* EFI Configuration Table and GUID definitions */
385 EFI_GUID(0x00000000, 0x0000, 0x0000, 0x00, 0x00, \
386 0x00, 0x00, 0x00, 0x00, 0x00, 0x00)
388 #define EFI_GLOBAL_VARIABLE_GUID \
389 EFI_GUID(0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, \
390 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c)
392 #define EFI_IMAGE_SECURITY_DATABASE_GUID \
393 EFI_GUID(0xd719b2cb, 0x3d3a, 0x4596, 0xa3, 0xbc, \
394 0xda, 0xd0, 0x0e, 0x67, 0x65, 0x6f)
396 #define EFI_FDT_GUID \
397 EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5, \
398 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0)
400 #define EFI_ACPI_TABLE_GUID \
401 EFI_GUID(0x8868e871, 0xe4f1, 0x11d3, \
402 0xbc, 0x22, 0x00, 0x80, 0xc7, 0x3c, 0x88, 0x81)
404 #define SMBIOS_TABLE_GUID \
405 EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3, \
406 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
408 #define EFI_LOAD_FILE_PROTOCOL_GUID \
409 EFI_GUID(0x56ec3091, 0x954c, 0x11d2, \
410 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
412 #define EFI_LOAD_FILE2_PROTOCOL_GUID \
413 EFI_GUID(0x4006c0c1, 0xfcb3, 0x403e, \
414 0x99, 0x6d, 0x4a, 0x6c, 0x87, 0x24, 0xe0, 0x6d)
416 #define EFI_TCG2_FINAL_EVENTS_TABLE_GUID \
417 EFI_GUID(0x1e2ed096, 0x30e2, 0x4254, 0xbd, \
418 0x89, 0x86, 0x3b, 0xbe, 0xf8, 0x23, 0x25)
420 struct efi_configuration_table {
425 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
427 struct efi_system_table {
428 struct efi_table_hdr hdr;
429 u16 *fw_vendor; /* physical addr of wchar_t vendor string */
431 efi_handle_t con_in_handle;
432 struct efi_simple_text_input_protocol *con_in;
433 efi_handle_t con_out_handle;
434 struct efi_simple_text_output_protocol *con_out;
435 efi_handle_t stderr_handle;
436 struct efi_simple_text_output_protocol *std_err;
437 struct efi_runtime_services *runtime;
438 struct efi_boot_services *boottime;
439 efi_uintn_t nr_tables;
440 struct efi_configuration_table *tables;
443 #define EFI_LOADED_IMAGE_PROTOCOL_GUID \
444 EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, \
445 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
447 #define EFI_LOADED_IMAGE_DEVICE_PATH_PROTOCOL_GUID \
448 EFI_GUID(0xbc62157e, 0x3e33, 0x4fec, \
449 0x99, 0x20, 0x2d, 0x3b, 0x36, 0xd7, 0x50, 0xdf)
451 #define EFI_LOADED_IMAGE_PROTOCOL_REVISION 0x1000
453 struct efi_loaded_image {
456 struct efi_system_table *system_table;
457 efi_handle_t device_handle;
458 struct efi_device_path *file_path;
460 u32 load_options_size;
463 aligned_u64 image_size;
464 unsigned int image_code_type;
465 unsigned int image_data_type;
466 efi_status_t (EFIAPI *unload)(efi_handle_t image_handle);
469 #define EFI_DEVICE_PATH_PROTOCOL_GUID \
470 EFI_GUID(0x09576e91, 0x6d3f, 0x11d2, \
471 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
473 #define DEVICE_PATH_TYPE_END 0x7f
474 # define DEVICE_PATH_SUB_TYPE_INSTANCE_END 0x01
475 # define DEVICE_PATH_SUB_TYPE_END 0xff
477 struct efi_device_path {
483 struct efi_mac_addr {
487 #define DEVICE_PATH_TYPE_HARDWARE_DEVICE 0x01
488 # define DEVICE_PATH_SUB_TYPE_MEMORY 0x03
489 # define DEVICE_PATH_SUB_TYPE_VENDOR 0x04
491 struct efi_device_path_memory {
492 struct efi_device_path dp;
498 struct efi_device_path_vendor {
499 struct efi_device_path dp;
504 #define DEVICE_PATH_TYPE_ACPI_DEVICE 0x02
505 # define DEVICE_PATH_SUB_TYPE_ACPI_DEVICE 0x01
507 #define EFI_PNP_ID(ID) (u32)(((ID) << 16) | 0x41D0)
508 #define EISA_PNP_ID(ID) EFI_PNP_ID(ID)
509 #define EISA_PNP_NUM(ID) ((ID) >> 16)
511 struct efi_device_path_acpi_path {
512 struct efi_device_path dp;
517 #define DEVICE_PATH_TYPE_MESSAGING_DEVICE 0x03
518 # define DEVICE_PATH_SUB_TYPE_MSG_ATAPI 0x01
519 # define DEVICE_PATH_SUB_TYPE_MSG_SCSI 0x02
520 # define DEVICE_PATH_SUB_TYPE_MSG_USB 0x05
521 # define DEVICE_PATH_SUB_TYPE_MSG_MAC_ADDR 0x0b
522 # define DEVICE_PATH_SUB_TYPE_MSG_UART 0x0e
523 # define DEVICE_PATH_SUB_TYPE_MSG_USB_CLASS 0x0f
524 # define DEVICE_PATH_SUB_TYPE_MSG_SATA 0x12
525 # define DEVICE_PATH_SUB_TYPE_MSG_NVME 0x17
526 # define DEVICE_PATH_SUB_TYPE_MSG_SD 0x1a
527 # define DEVICE_PATH_SUB_TYPE_MSG_MMC 0x1d
529 struct efi_device_path_atapi {
530 struct efi_device_path dp;
531 u8 primary_secondary;
533 u16 logical_unit_number;
536 struct efi_device_path_scsi {
537 struct efi_device_path dp;
539 u16 logical_unit_number;
542 struct efi_device_path_uart {
543 struct efi_device_path dp;
551 struct efi_device_path_usb {
552 struct efi_device_path dp;
553 u8 parent_port_number;
557 struct efi_device_path_sata {
558 struct efi_device_path dp;
560 u16 port_multiplier_port;
561 u16 logical_unit_number;
564 struct efi_device_path_mac_addr {
565 struct efi_device_path dp;
566 struct efi_mac_addr mac;
570 struct efi_device_path_usb_class {
571 struct efi_device_path dp;
579 struct efi_device_path_sd_mmc_path {
580 struct efi_device_path dp;
584 struct efi_device_path_nvme {
585 struct efi_device_path dp;
590 #define DEVICE_PATH_TYPE_MEDIA_DEVICE 0x04
591 # define DEVICE_PATH_SUB_TYPE_HARD_DRIVE_PATH 0x01
592 # define DEVICE_PATH_SUB_TYPE_CDROM_PATH 0x02
593 # define DEVICE_PATH_SUB_TYPE_VENDOR_PATH 0x03
594 # define DEVICE_PATH_SUB_TYPE_FILE_PATH 0x04
596 struct efi_device_path_hard_drive_path {
597 struct efi_device_path dp;
598 u32 partition_number;
601 u8 partition_signature[16];
606 struct efi_device_path_cdrom_path {
607 struct efi_device_path dp;
613 struct efi_device_path_file_path {
614 struct efi_device_path dp;
618 #define EFI_BLOCK_IO_PROTOCOL_GUID \
619 EFI_GUID(0x964e5b21, 0x6459, 0x11d2, \
620 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
622 struct efi_block_io_media {
624 char removable_media;
626 char logical_partition;
634 /* Added in revision 2 of the protocol */
635 u64 lowest_aligned_lba;
636 u32 logical_blocks_per_physical_block;
637 /* Added in revision 3 of the protocol */
638 u32 optimal_transfer_length_granualarity;
641 #define EFI_BLOCK_IO_PROTOCOL_REVISION2 0x00020001
642 #define EFI_BLOCK_IO_PROTOCOL_REVISION3 0x0002001f
644 struct efi_block_io {
646 struct efi_block_io_media *media;
647 efi_status_t (EFIAPI *reset)(struct efi_block_io *this,
648 char extended_verification);
649 efi_status_t (EFIAPI *read_blocks)(struct efi_block_io *this,
650 u32 media_id, u64 lba, efi_uintn_t buffer_size,
652 efi_status_t (EFIAPI *write_blocks)(struct efi_block_io *this,
653 u32 media_id, u64 lba, efi_uintn_t buffer_size,
655 efi_status_t (EFIAPI *flush_blocks)(struct efi_block_io *this);
658 struct simple_text_output_mode {
667 #define EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID \
668 EFI_GUID(0x387477c2, 0x69c7, 0x11d2, \
669 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
671 #define EFI_BLACK 0x00
672 #define EFI_BLUE 0x01
673 #define EFI_GREEN 0x02
674 #define EFI_CYAN 0x03
676 #define EFI_MAGENTA 0x05
677 #define EFI_BROWN 0x06
678 #define EFI_LIGHTGRAY 0x07
679 #define EFI_BRIGHT 0x08
680 #define EFI_DARKGRAY 0x08
681 #define EFI_LIGHTBLUE 0x09
682 #define EFI_LIGHTGREEN 0x0a
683 #define EFI_LIGHTCYAN 0x0b
684 #define EFI_LIGHTRED 0x0c
685 #define EFI_LIGHTMAGENTA 0x0d
686 #define EFI_YELLOW 0x0e
687 #define EFI_WHITE 0x0f
688 #define EFI_BACKGROUND_BLACK 0x00
689 #define EFI_BACKGROUND_BLUE 0x10
690 #define EFI_BACKGROUND_GREEN 0x20
691 #define EFI_BACKGROUND_CYAN 0x30
692 #define EFI_BACKGROUND_RED 0x40
693 #define EFI_BACKGROUND_MAGENTA 0x50
694 #define EFI_BACKGROUND_BROWN 0x60
695 #define EFI_BACKGROUND_LIGHTGRAY 0x70
697 /* extract foreground color from EFI attribute */
698 #define EFI_ATTR_FG(attr) ((attr) & 0x07)
699 /* treat high bit of FG as bright/bold (similar to edk2) */
700 #define EFI_ATTR_BOLD(attr) (((attr) >> 3) & 0x01)
701 /* extract background color from EFI attribute */
702 #define EFI_ATTR_BG(attr) (((attr) >> 4) & 0x7)
704 struct efi_simple_text_output_protocol {
705 efi_status_t (EFIAPI *reset)(
706 struct efi_simple_text_output_protocol *this,
707 char extended_verification);
708 efi_status_t (EFIAPI *output_string)(
709 struct efi_simple_text_output_protocol *this,
711 efi_status_t (EFIAPI *test_string)(
712 struct efi_simple_text_output_protocol *this,
714 efi_status_t(EFIAPI *query_mode)(
715 struct efi_simple_text_output_protocol *this,
716 unsigned long mode_number, unsigned long *columns,
717 unsigned long *rows);
718 efi_status_t(EFIAPI *set_mode)(
719 struct efi_simple_text_output_protocol *this,
720 unsigned long mode_number);
721 efi_status_t(EFIAPI *set_attribute)(
722 struct efi_simple_text_output_protocol *this,
723 unsigned long attribute);
724 efi_status_t(EFIAPI *clear_screen) (
725 struct efi_simple_text_output_protocol *this);
726 efi_status_t(EFIAPI *set_cursor_position) (
727 struct efi_simple_text_output_protocol *this,
728 unsigned long column, unsigned long row);
729 efi_status_t(EFIAPI *enable_cursor)(
730 struct efi_simple_text_output_protocol *this,
732 struct simple_text_output_mode *mode;
735 #define EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL_GUID \
736 EFI_GUID(0xdd9e7534, 0x7762, 0x4698, \
737 0x8c, 0x14, 0xf5, 0x85, 0x17, 0xa6, 0x25, 0xaa)
739 struct efi_input_key {
744 #define EFI_SHIFT_STATE_INVALID 0x00000000
745 #define EFI_RIGHT_SHIFT_PRESSED 0x00000001
746 #define EFI_LEFT_SHIFT_PRESSED 0x00000002
747 #define EFI_RIGHT_CONTROL_PRESSED 0x00000004
748 #define EFI_LEFT_CONTROL_PRESSED 0x00000008
749 #define EFI_RIGHT_ALT_PRESSED 0x00000010
750 #define EFI_LEFT_ALT_PRESSED 0x00000020
751 #define EFI_RIGHT_LOGO_PRESSED 0x00000040
752 #define EFI_LEFT_LOGO_PRESSED 0x00000080
753 #define EFI_MENU_KEY_PRESSED 0x00000100
754 #define EFI_SYS_REQ_PRESSED 0x00000200
755 #define EFI_SHIFT_STATE_VALID 0x80000000
757 #define EFI_TOGGLE_STATE_INVALID 0x00
758 #define EFI_SCROLL_LOCK_ACTIVE 0x01
759 #define EFI_NUM_LOCK_ACTIVE 0x02
760 #define EFI_CAPS_LOCK_ACTIVE 0x04
761 #define EFI_KEY_STATE_EXPOSED 0x40
762 #define EFI_TOGGLE_STATE_VALID 0x80
764 struct efi_key_state {
769 struct efi_key_data {
770 struct efi_input_key key;
771 struct efi_key_state key_state;
774 struct efi_simple_text_input_ex_protocol {
775 efi_status_t (EFIAPI *reset) (
776 struct efi_simple_text_input_ex_protocol *this,
777 bool extended_verification);
778 efi_status_t (EFIAPI *read_key_stroke_ex) (
779 struct efi_simple_text_input_ex_protocol *this,
780 struct efi_key_data *key_data);
781 struct efi_event *wait_for_key_ex;
782 efi_status_t (EFIAPI *set_state) (
783 struct efi_simple_text_input_ex_protocol *this,
784 u8 *key_toggle_state);
785 efi_status_t (EFIAPI *register_key_notify) (
786 struct efi_simple_text_input_ex_protocol *this,
787 struct efi_key_data *key_data,
788 efi_status_t (EFIAPI *key_notify_function)(
789 struct efi_key_data *key_data),
790 void **notify_handle);
791 efi_status_t (EFIAPI *unregister_key_notify) (
792 struct efi_simple_text_input_ex_protocol *this,
793 void *notification_handle);
796 #define EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID \
797 EFI_GUID(0x387477c1, 0x69c7, 0x11d2, \
798 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
800 struct efi_simple_text_input_protocol {
801 efi_status_t(EFIAPI *reset)(struct efi_simple_text_input_protocol *this,
802 bool extended_verification);
803 efi_status_t(EFIAPI *read_key_stroke)(
804 struct efi_simple_text_input_protocol *this,
805 struct efi_input_key *key);
806 struct efi_event *wait_for_key;
809 #define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID \
810 EFI_GUID(0x8b843e20, 0x8132, 0x4852, \
811 0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c)
813 struct efi_device_path_to_text_protocol {
814 uint16_t *(EFIAPI *convert_device_node_to_text)(
815 struct efi_device_path *device_node,
817 bool allow_shortcuts);
818 uint16_t *(EFIAPI *convert_device_path_to_text)(
819 struct efi_device_path *device_path,
821 bool allow_shortcuts);
824 #define EFI_DEVICE_PATH_UTILITIES_PROTOCOL_GUID \
825 EFI_GUID(0x0379be4e, 0xd706, 0x437d, \
826 0xb0, 0x37, 0xed, 0xb8, 0x2f, 0xb7, 0x72, 0xa4)
828 struct efi_device_path_utilities_protocol {
829 efi_uintn_t (EFIAPI *get_device_path_size)(
830 const struct efi_device_path *device_path);
831 struct efi_device_path *(EFIAPI *duplicate_device_path)(
832 const struct efi_device_path *device_path);
833 struct efi_device_path *(EFIAPI *append_device_path)(
834 const struct efi_device_path *src1,
835 const struct efi_device_path *src2);
836 struct efi_device_path *(EFIAPI *append_device_node)(
837 const struct efi_device_path *device_path,
838 const struct efi_device_path *device_node);
839 struct efi_device_path *(EFIAPI *append_device_path_instance)(
840 const struct efi_device_path *device_path,
841 const struct efi_device_path *device_path_instance);
842 struct efi_device_path *(EFIAPI *get_next_device_path_instance)(
843 struct efi_device_path **device_path_instance,
844 efi_uintn_t *device_path_instance_size);
845 bool (EFIAPI *is_device_path_multi_instance)(
846 const struct efi_device_path *device_path);
847 struct efi_device_path *(EFIAPI *create_device_node)(
849 uint8_t node_sub_type,
850 uint16_t node_length);
854 * Human Interface Infrastructure (HII)
856 struct efi_hii_package_list_header {
857 efi_guid_t package_list_guid;
862 * struct efi_hii_package_header - EFI HII package header
864 * @fields: 'fields' replaces the bit-fields defined in the EFI
865 * specification to to avoid possible compiler incompatibilities::
870 struct efi_hii_package_header {
874 #define __EFI_HII_PACKAGE_LEN_SHIFT 0
875 #define __EFI_HII_PACKAGE_TYPE_SHIFT 24
876 #define __EFI_HII_PACKAGE_LEN_MASK 0xffffff
877 #define __EFI_HII_PACKAGE_TYPE_MASK 0xff
879 #define EFI_HII_PACKAGE_TYPE_ALL 0x00
880 #define EFI_HII_PACKAGE_TYPE_GUID 0x01
881 #define EFI_HII_PACKAGE_FORMS 0x02
882 #define EFI_HII_PACKAGE_STRINGS 0x04
883 #define EFI_HII_PACKAGE_FONTS 0x05
884 #define EFI_HII_PACKAGE_IMAGES 0x06
885 #define EFI_HII_PACKAGE_SIMPLE_FONTS 0x07
886 #define EFI_HII_PACKAGE_DEVICE_PATH 0x08
887 #define EFI_HII_PACKAGE_KEYBOARD_LAYOUT 0x09
888 #define EFI_HII_PACKAGE_ANIMATIONS 0x0A
889 #define EFI_HII_PACKAGE_END 0xDF
890 #define EFI_HII_PACKAGE_TYPE_SYSTEM_BEGIN 0xE0
891 #define EFI_HII_PACKAGE_TYPE_SYSTEM_END 0xFF
896 struct efi_hii_guid_package {
897 struct efi_hii_package_header header;
905 struct efi_hii_strings_package {
906 struct efi_hii_package_header header;
908 u32 string_info_offset;
909 u16 language_window[16];
910 efi_string_id_t language_name;
914 struct efi_hii_string_block {
916 /* u8 block_body[]; */
919 #define EFI_HII_SIBT_END 0x00
920 #define EFI_HII_SIBT_STRING_SCSU 0x10
921 #define EFI_HII_SIBT_STRING_SCSU_FONT 0x11
922 #define EFI_HII_SIBT_STRINGS_SCSU 0x12
923 #define EFI_HII_SIBT_STRINGS_SCSU_FONT 0x13
924 #define EFI_HII_SIBT_STRING_UCS2 0x14
925 #define EFI_HII_SIBT_STRING_UCS2_FONT 0x15
926 #define EFI_HII_SIBT_STRINGS_UCS2 0x16
927 #define EFI_HII_SIBT_STRINGS_UCS2_FONT 0x17
928 #define EFI_HII_SIBT_DUPLICATE 0x20
929 #define EFI_HII_SIBT_SKIP2 0x21
930 #define EFI_HII_SIBT_SKIP1 0x22
931 #define EFI_HII_SIBT_EXT1 0x30
932 #define EFI_HII_SIBT_EXT2 0x31
933 #define EFI_HII_SIBT_EXT4 0x32
934 #define EFI_HII_SIBT_FONT 0x40
936 struct efi_hii_sibt_string_ucs2_block {
937 struct efi_hii_string_block header;
941 static inline struct efi_hii_string_block *
942 efi_hii_sibt_string_ucs2_block_next(struct efi_hii_sibt_string_ucs2_block *blk)
944 return ((void *)blk) + sizeof(*blk) +
945 (u16_strlen(blk->string_text) + 1) * 2;
950 * TODO: full scope of definitions
952 struct efi_hii_time {
958 struct efi_hii_date {
965 efi_question_id_t question_id;
966 efi_form_id_t form_id;
967 efi_guid_t form_set_guid;
968 efi_string_id_t device_path;
971 union efi_ifr_type_value {
972 u8 u8; // EFI_IFR_TYPE_NUM_SIZE_8
973 u16 u16; // EFI_IFR_TYPE_NUM_SIZE_16
974 u32 u32; // EFI_IFR_TYPE_NUM_SIZE_32
975 u64 u64; // EFI_IFR_TYPE_NUM_SIZE_64
976 bool b; // EFI_IFR_TYPE_BOOLEAN
977 struct efi_hii_time time; // EFI_IFR_TYPE_TIME
978 struct efi_hii_date date; // EFI_IFR_TYPE_DATE
979 efi_string_id_t string; // EFI_IFR_TYPE_STRING, EFI_IFR_TYPE_ACTION
980 struct efi_hii_ref ref; // EFI_IFR_TYPE_REF
981 // u8 buffer[]; // EFI_IFR_TYPE_BUFFER
984 #define EFI_IFR_TYPE_NUM_SIZE_8 0x00
985 #define EFI_IFR_TYPE_NUM_SIZE_16 0x01
986 #define EFI_IFR_TYPE_NUM_SIZE_32 0x02
987 #define EFI_IFR_TYPE_NUM_SIZE_64 0x03
988 #define EFI_IFR_TYPE_BOOLEAN 0x04
989 #define EFI_IFR_TYPE_TIME 0x05
990 #define EFI_IFR_TYPE_DATE 0x06
991 #define EFI_IFR_TYPE_STRING 0x07
992 #define EFI_IFR_TYPE_OTHER 0x08
993 #define EFI_IFR_TYPE_UNDEFINED 0x09
994 #define EFI_IFR_TYPE_ACTION 0x0A
995 #define EFI_IFR_TYPE_BUFFER 0x0B
996 #define EFI_IFR_TYPE_REF 0x0C
997 #define EFI_IFR_OPTION_DEFAULT 0x10
998 #define EFI_IFR_OPTION_DEFAULT_MFG 0x20
1000 #define EFI_IFR_ONE_OF_OPTION_OP 0x09
1002 struct efi_ifr_op_header {
1008 struct efi_ifr_one_of_option {
1009 struct efi_ifr_op_header header;
1010 efi_string_id_t option;
1013 union efi_ifr_type_value value;
1016 typedef efi_uintn_t efi_browser_action_t;
1018 #define EFI_BROWSER_ACTION_REQUEST_NONE 0
1019 #define EFI_BROWSER_ACTION_REQUEST_RESET 1
1020 #define EFI_BROWSER_ACTION_REQUEST_SUBMIT 2
1021 #define EFI_BROWSER_ACTION_REQUEST_EXIT 3
1022 #define EFI_BROWSER_ACTION_REQUEST_FORM_SUBMIT_EXIT 4
1023 #define EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD_EXIT 5
1024 #define EFI_BROWSER_ACTION_REQUEST_FORM_APPLY 6
1025 #define EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD 7
1026 #define EFI_BROWSER_ACTION_REQUEST_RECONNECT 8
1028 typedef efi_uintn_t efi_browser_action_request_t;
1030 #define EFI_BROWSER_ACTION_CHANGING 0
1031 #define EFI_BROWSER_ACTION_CHANGED 1
1032 #define EFI_BROWSER_ACTION_RETRIEVE 2
1033 #define EFI_BROWSER_ACTION_FORM_OPEN 3
1034 #define EFI_BROWSER_ACTION_FORM_CLOSE 4
1035 #define EFI_BROWSER_ACTION_SUBMITTED 5
1036 #define EFI_BROWSER_ACTION_DEFAULT_STANDARD 0x1000
1037 #define EFI_BROWSER_ACTION_DEFAULT_MANUFACTURING 0x1001
1038 #define EFI_BROWSER_ACTION_DEFAULT_SAFE 0x1002
1039 #define EFI_BROWSER_ACTION_DEFAULT_PLATFORM 0x2000
1040 #define EFI_BROWSER_ACTION_DEFAULT_HARDWARE 0x3000
1041 #define EFI_BROWSER_ACTION_DEFAULT_FIRMWARE 0x4000
1044 * HII keyboard package
1047 EFI_KEY_LCTRL, EFI_KEY_A0, EFI_KEY_LALT, EFI_KEY_SPACE_BAR,
1048 EFI_KEY_A2, EFI_KEY_A3, EFI_KEY_A4, EFI_KEY_RCTRL, EFI_KEY_LEFT_ARROW,
1049 EFI_KEY_DOWN_ARROW, EFI_KEY_RIGHT_ARROW, EFI_KEY_ZERO,
1050 EFI_KEY_PERIOD, EFI_KEY_ENTER, EFI_KEY_LSHIFT, EFI_KEY_B0,
1051 EFI_KEY_B1, EFI_KEY_B2, EFI_KEY_B3, EFI_KEY_B4, EFI_KEY_B5, EFI_KEY_B6,
1052 EFI_KEY_B7, EFI_KEY_B8, EFI_KEY_B9, EFI_KEY_B10, EFI_KEY_RSHIFT,
1053 EFI_KEY_UP_ARROW, EFI_KEY_ONE, EFI_KEY_TWO, EFI_KEY_THREE,
1054 EFI_KEY_CAPS_LOCK, EFI_KEY_C1, EFI_KEY_C2, EFI_KEY_C3, EFI_KEY_C4,
1055 EFI_KEY_C5, EFI_KEY_C6, EFI_KEY_C7, EFI_KEY_C8, EFI_KEY_C9,
1056 EFI_KEY_C10, EFI_KEY_C11, EFI_KEY_C12, EFI_KEY_FOUR, EFI_KEY_FIVE,
1057 EFI_KEY_SIX, EFI_KEY_PLUS, EFI_KEY_TAB, EFI_KEY_D1, EFI_KEY_D2,
1058 EFI_KEY_D3, EFI_KEY_D4, EFI_KEY_D5, EFI_KEY_D6, EFI_KEY_D7, EFI_KEY_D8,
1059 EFI_KEY_D9, EFI_KEY_D10, EFI_KEY_D11, EFI_KEY_D12, EFI_KEY_D13,
1060 EFI_KEY_DEL, EFI_KEY_END, EFI_KEY_PG_DN, EFI_KEY_SEVEN, EFI_KEY_EIGHT,
1061 EFI_KEY_NINE, EFI_KEY_E0, EFI_KEY_E1, EFI_KEY_E2, EFI_KEY_E3,
1062 EFI_KEY_E4, EFI_KEY_E5, EFI_KEY_E6, EFI_KEY_E7, EFI_KEY_E8, EFI_KEY_E9,
1063 EFI_KEY_E10, EFI_KEY_E11, EFI_KEY_E12, EFI_KEY_BACK_SPACE,
1064 EFI_KEY_INS, EFI_KEY_HOME, EFI_KEY_PG_UP, EFI_KEY_NLCK, EFI_KEY_SLASH,
1065 EFI_KEY_ASTERISK, EFI_KEY_MINUS, EFI_KEY_ESC, EFI_KEY_F1, EFI_KEY_F2,
1066 EFI_KEY_F3, EFI_KEY_F4, EFI_KEY_F5, EFI_KEY_F6, EFI_KEY_F7, EFI_KEY_F8,
1067 EFI_KEY_F9, EFI_KEY_F10, EFI_KEY_F11, EFI_KEY_F12, EFI_KEY_PRINT,
1068 EFI_KEY_SLCK, EFI_KEY_PAUSE,
1071 struct efi_key_descriptor {
1074 u16 shifted_unicode;
1076 u16 shifted_alt_gr_unicode;
1078 u16 affected_attribute;
1081 struct efi_hii_keyboard_layout {
1084 u32 layout_descriptor_string_offset;
1085 u8 descriptor_count;
1086 struct efi_key_descriptor descriptors[];
1089 struct efi_hii_keyboard_package {
1090 struct efi_hii_package_header header;
1092 struct efi_hii_keyboard_layout layout[];
1098 #define EFI_HII_STRING_PROTOCOL_GUID \
1099 EFI_GUID(0x0fd96974, 0x23aa, 0x4cdc, \
1100 0xb9, 0xcb, 0x98, 0xd1, 0x77, 0x50, 0x32, 0x2a)
1102 struct efi_font_info {
1103 efi_hii_font_style_t font_style;
1108 struct efi_hii_string_protocol {
1109 efi_status_t(EFIAPI *new_string)(
1110 const struct efi_hii_string_protocol *this,
1111 efi_hii_handle_t package_list,
1112 efi_string_id_t *string_id,
1114 const u16 *language_name,
1115 const efi_string_t string,
1116 const struct efi_font_info *string_font_info);
1117 efi_status_t(EFIAPI *get_string)(
1118 const struct efi_hii_string_protocol *this,
1120 efi_hii_handle_t package_list,
1121 efi_string_id_t string_id,
1122 efi_string_t string,
1123 efi_uintn_t *string_size,
1124 struct efi_font_info **string_font_info);
1125 efi_status_t(EFIAPI *set_string)(
1126 const struct efi_hii_string_protocol *this,
1127 efi_hii_handle_t package_list,
1128 efi_string_id_t string_id,
1130 const efi_string_t string,
1131 const struct efi_font_info *string_font_info);
1132 efi_status_t(EFIAPI *get_languages)(
1133 const struct efi_hii_string_protocol *this,
1134 efi_hii_handle_t package_list,
1136 efi_uintn_t *languages_size);
1137 efi_status_t(EFIAPI *get_secondary_languages)(
1138 const struct efi_hii_string_protocol *this,
1139 efi_hii_handle_t package_list,
1140 const u8 *primary_language,
1141 u8 *secondary_languages,
1142 efi_uintn_t *secondary_languages_size);
1145 #define EFI_HII_DATABASE_PROTOCOL_GUID \
1146 EFI_GUID(0xef9fc172, 0xa1b2, 0x4693, \
1147 0xb3, 0x27, 0x6d, 0x32, 0xfc, 0x41, 0x60, 0x42)
1149 struct efi_hii_database_protocol {
1150 efi_status_t(EFIAPI *new_package_list)(
1151 const struct efi_hii_database_protocol *this,
1152 const struct efi_hii_package_list_header *package_list,
1153 const efi_handle_t driver_handle,
1154 efi_hii_handle_t *handle);
1155 efi_status_t(EFIAPI *remove_package_list)(
1156 const struct efi_hii_database_protocol *this,
1157 efi_hii_handle_t handle);
1158 efi_status_t(EFIAPI *update_package_list)(
1159 const struct efi_hii_database_protocol *this,
1160 efi_hii_handle_t handle,
1161 const struct efi_hii_package_list_header *package_list);
1162 efi_status_t(EFIAPI *list_package_lists)(
1163 const struct efi_hii_database_protocol *this,
1165 const efi_guid_t *package_guid,
1166 efi_uintn_t *handle_buffer_length,
1167 efi_hii_handle_t *handle);
1168 efi_status_t(EFIAPI *export_package_lists)(
1169 const struct efi_hii_database_protocol *this,
1170 efi_hii_handle_t handle,
1171 efi_uintn_t *buffer_size,
1172 struct efi_hii_package_list_header *buffer);
1173 efi_status_t(EFIAPI *register_package_notify)(
1174 const struct efi_hii_database_protocol *this,
1176 const efi_guid_t *package_guid,
1177 const void *package_notify_fn,
1178 efi_uintn_t notify_type,
1179 efi_handle_t *notify_handle);
1180 efi_status_t(EFIAPI *unregister_package_notify)(
1181 const struct efi_hii_database_protocol *this,
1182 efi_handle_t notification_handle
1184 efi_status_t(EFIAPI *find_keyboard_layouts)(
1185 const struct efi_hii_database_protocol *this,
1186 u16 *key_guid_buffer_length,
1187 efi_guid_t *key_guid_buffer);
1188 efi_status_t(EFIAPI *get_keyboard_layout)(
1189 const struct efi_hii_database_protocol *this,
1190 efi_guid_t *key_guid,
1191 u16 *keyboard_layout_length,
1192 struct efi_hii_keyboard_layout *keyboard_layout);
1193 efi_status_t(EFIAPI *set_keyboard_layout)(
1194 const struct efi_hii_database_protocol *this,
1195 efi_guid_t *key_guid);
1196 efi_status_t(EFIAPI *get_package_list_handle)(
1197 const struct efi_hii_database_protocol *this,
1198 efi_hii_handle_t package_list_handle,
1199 efi_handle_t *driver_handle);
1202 #define EFI_HII_CONFIG_ROUTING_PROTOCOL_GUID \
1203 EFI_GUID(0x587e72d7, 0xcc50, 0x4f79, \
1204 0x82, 0x09, 0xca, 0x29, 0x1f, 0xc1, 0xa1, 0x0f)
1206 struct efi_hii_config_routing_protocol {
1207 efi_status_t(EFIAPI *extract_config)(
1208 const struct efi_hii_config_routing_protocol *this,
1209 const efi_string_t request,
1210 efi_string_t *progress,
1211 efi_string_t *results);
1212 efi_status_t(EFIAPI *export_config)(
1213 const struct efi_hii_config_routing_protocol *this,
1214 efi_string_t *results);
1215 efi_status_t(EFIAPI *route_config)(
1216 const struct efi_hii_config_routing_protocol *this,
1217 const efi_string_t configuration,
1218 efi_string_t *progress);
1219 efi_status_t(EFIAPI *block_to_config)(
1220 const struct efi_hii_config_routing_protocol *this,
1221 const efi_string_t config_request,
1222 const uint8_t *block,
1223 const efi_uintn_t block_size,
1224 efi_string_t *config,
1225 efi_string_t *progress);
1226 efi_status_t(EFIAPI *config_to_block)(
1227 const struct efi_hii_config_routing_protocol *this,
1228 const efi_string_t config_resp,
1229 const uint8_t *block,
1230 const efi_uintn_t *block_size,
1231 efi_string_t *progress);
1232 efi_status_t(EFIAPI *get_alt_config)(
1233 const struct efi_hii_config_routing_protocol *this,
1234 const efi_string_t config_resp,
1235 const efi_guid_t *guid,
1236 const efi_string_t name,
1237 const struct efi_device_path *device_path,
1238 const efi_string_t alt_cfg_id,
1239 efi_string_t *alt_cfg_resp);
1242 #define EFI_HII_CONFIG_ACCESS_PROTOCOL_GUID \
1243 EFI_GUID(0x330d4706, 0xf2a0, 0x4e4f, \
1244 0xa3, 0x69, 0xb6, 0x6f, 0xa8, 0xd5, 0x43, 0x85)
1246 struct efi_hii_config_access_protocol {
1247 efi_status_t(EFIAPI *extract_config_access)(
1248 const struct efi_hii_config_access_protocol *this,
1249 const efi_string_t request,
1250 efi_string_t *progress,
1251 efi_string_t *results);
1252 efi_status_t(EFIAPI *route_config_access)(
1253 const struct efi_hii_config_access_protocol *this,
1254 const efi_string_t configuration,
1255 efi_string_t *progress);
1256 efi_status_t(EFIAPI *form_callback)(
1257 const struct efi_hii_config_access_protocol *this,
1258 efi_browser_action_t action,
1259 efi_question_id_t question_id,
1261 union efi_ifr_type_value *value,
1262 efi_browser_action_request_t *action_request);
1265 #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
1266 EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, \
1267 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
1269 #define EFI_GOT_RGBA8 0
1270 #define EFI_GOT_BGRA8 1
1271 #define EFI_GOT_BITMASK 2
1273 struct efi_gop_mode_info {
1278 u32 pixel_bitmask[4];
1279 u32 pixels_per_scanline;
1282 struct efi_gop_mode {
1285 struct efi_gop_mode_info *info;
1286 unsigned long info_size;
1287 efi_physical_addr_t fb_base;
1288 unsigned long fb_size;
1291 struct efi_gop_pixel {
1298 #define EFI_BLT_VIDEO_FILL 0
1299 #define EFI_BLT_VIDEO_TO_BLT_BUFFER 1
1300 #define EFI_BLT_BUFFER_TO_VIDEO 2
1301 #define EFI_BLT_VIDEO_TO_VIDEO 3
1304 efi_status_t (EFIAPI *query_mode)(struct efi_gop *this, u32 mode_number,
1305 efi_uintn_t *size_of_info,
1306 struct efi_gop_mode_info **info);
1307 efi_status_t (EFIAPI *set_mode)(struct efi_gop *this, u32 mode_number);
1308 efi_status_t (EFIAPI *blt)(struct efi_gop *this,
1309 struct efi_gop_pixel *buffer,
1310 u32 operation, efi_uintn_t sx,
1311 efi_uintn_t sy, efi_uintn_t dx,
1312 efi_uintn_t dy, efi_uintn_t width,
1313 efi_uintn_t height, efi_uintn_t delta);
1314 struct efi_gop_mode *mode;
1317 #define EFI_SIMPLE_NETWORK_PROTOCOL_GUID \
1318 EFI_GUID(0xa19832b9, 0xac25, 0x11d3, \
1319 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
1321 struct efi_mac_address {
1325 struct efi_ip_address {
1327 } __attribute__((aligned(4)));
1329 enum efi_simple_network_state {
1330 EFI_NETWORK_STOPPED,
1331 EFI_NETWORK_STARTED,
1332 EFI_NETWORK_INITIALIZED,
1335 struct efi_simple_network_mode {
1336 enum efi_simple_network_state state;
1338 u32 media_header_size;
1339 u32 max_packet_size;
1341 u32 nvram_access_size;
1342 u32 receive_filter_mask;
1343 u32 receive_filter_setting;
1344 u32 max_mcast_filter_count;
1345 u32 mcast_filter_count;
1346 struct efi_mac_address mcast_filter[16];
1347 struct efi_mac_address current_address;
1348 struct efi_mac_address broadcast_address;
1349 struct efi_mac_address permanent_address;
1352 u8 multitx_supported;
1353 u8 media_present_supported;
1357 /* receive_filters bit mask */
1358 #define EFI_SIMPLE_NETWORK_RECEIVE_UNICAST 0x01
1359 #define EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST 0x02
1360 #define EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST 0x04
1361 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS 0x08
1362 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST 0x10
1364 /* interrupt status bit mask */
1365 #define EFI_SIMPLE_NETWORK_RECEIVE_INTERRUPT 0x01
1366 #define EFI_SIMPLE_NETWORK_TRANSMIT_INTERRUPT 0x02
1367 #define EFI_SIMPLE_NETWORK_COMMAND_INTERRUPT 0x04
1368 #define EFI_SIMPLE_NETWORK_SOFTWARE_INTERRUPT 0x08
1370 /* revision of the simple network protocol */
1371 #define EFI_SIMPLE_NETWORK_PROTOCOL_REVISION 0x00010000
1373 struct efi_simple_network {
1375 efi_status_t (EFIAPI *start)(struct efi_simple_network *this);
1376 efi_status_t (EFIAPI *stop)(struct efi_simple_network *this);
1377 efi_status_t (EFIAPI *initialize)(struct efi_simple_network *this,
1378 ulong extra_rx, ulong extra_tx);
1379 efi_status_t (EFIAPI *reset)(struct efi_simple_network *this,
1380 int extended_verification);
1381 efi_status_t (EFIAPI *shutdown)(struct efi_simple_network *this);
1382 efi_status_t (EFIAPI *receive_filters)(struct efi_simple_network *this,
1383 u32 enable, u32 disable, int reset_mcast_filter,
1384 ulong mcast_filter_count,
1385 struct efi_mac_address *mcast_filter);
1386 efi_status_t (EFIAPI *station_address)(struct efi_simple_network *this,
1387 int reset, struct efi_mac_address *new_mac);
1388 efi_status_t (EFIAPI *statistics)(struct efi_simple_network *this,
1389 int reset, ulong *stat_size, void *stat_table);
1390 efi_status_t (EFIAPI *mcastiptomac)(struct efi_simple_network *this,
1391 int ipv6, struct efi_ip_address *ip,
1392 struct efi_mac_address *mac);
1393 efi_status_t (EFIAPI *nvdata)(struct efi_simple_network *this,
1394 int read_write, ulong offset, ulong buffer_size,
1396 efi_status_t (EFIAPI *get_status)(struct efi_simple_network *this,
1397 u32 *int_status, void **txbuf);
1398 efi_status_t (EFIAPI *transmit)(struct efi_simple_network *this,
1399 size_t header_size, size_t buffer_size, void *buffer,
1400 struct efi_mac_address *src_addr,
1401 struct efi_mac_address *dest_addr, u16 *protocol);
1402 efi_status_t (EFIAPI *receive)(struct efi_simple_network *this,
1403 size_t *header_size, size_t *buffer_size, void *buffer,
1404 struct efi_mac_address *src_addr,
1405 struct efi_mac_address *dest_addr, u16 *protocol);
1406 struct efi_event *wait_for_packet;
1407 struct efi_simple_network_mode *mode;
1408 /* private fields */
1412 #define EFI_PXE_BASE_CODE_PROTOCOL_GUID \
1413 EFI_GUID(0x03c4e603, 0xac28, 0x11d3, \
1414 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
1416 #define EFI_PXE_BASE_CODE_PROTOCOL_REVISION 0x00010000
1417 #define EFI_PXE_BASE_CODE_MAX_IPCNT 8
1419 struct efi_pxe_packet {
1423 struct efi_pxe_mode {
1432 u8 dhcp_discover_valid;
1433 u8 dhcp_ack_received;
1434 u8 proxy_offer_received;
1435 u8 pxe_discover_valid;
1436 u8 pxe_reply_received;
1437 u8 pxe_bis_reply_received;
1438 u8 icmp_error_received;
1439 u8 tftp_error_received;
1444 struct efi_ip_address station_ip;
1445 struct efi_ip_address subnet_mask;
1446 struct efi_pxe_packet dhcp_discover;
1447 struct efi_pxe_packet dhcp_ack;
1448 struct efi_pxe_packet proxy_offer;
1449 struct efi_pxe_packet pxe_discover;
1450 struct efi_pxe_packet pxe_reply;
1453 struct efi_pxe_base_code_srvlist {
1455 u8 accept_any_response;
1457 struct efi_ip_address ip_addr;
1460 struct efi_pxe_base_code_discover_info {
1465 struct efi_ip_address server_m_cast_ip;
1467 struct efi_pxe_base_code_srvlist srv_list[];
1470 struct efi_pxe_base_code_mtftp_info {
1471 struct efi_ip_address m_cast_ip;
1475 u16 transit_timeout;
1478 struct efi_pxe_base_code_filter {
1482 struct efi_ip_address ip_list[EFI_PXE_BASE_CODE_MAX_IPCNT];
1485 struct efi_pxe_base_code_dhcpv4_packet {
1493 u8 bootp_ci_addr[4];
1494 u8 bootp_yi_addr[4];
1495 u8 bootp_si_addr[4];
1496 u8 bootp_gi_addr[4];
1497 u8 bootp_hw_addr[16];
1498 u8 bootp_srv_name[64];
1499 u8 bootp_boot_file[128];
1501 u8 dhcp_options[56];
1504 struct efi_pxe_base_code_dhcpv6_packet {
1506 u8 transaction_id[3];
1507 u8 dhcp_options[1024];
1512 struct efi_pxe_base_code_dhcpv4_packet dhcpv4;
1513 struct efi_pxe_base_code_dhcpv6_packet dhcpv6;
1514 } EFI_PXE_BASE_CODE_PACKET;
1516 struct efi_pxe_base_code_protocol {
1518 efi_status_t (EFIAPI *start)(struct efi_pxe_base_code_protocol *this,
1520 efi_status_t (EFIAPI *stop)(struct efi_pxe_base_code_protocol *this);
1521 efi_status_t (EFIAPI *dhcp)(struct efi_pxe_base_code_protocol *this,
1523 efi_status_t (EFIAPI *discover)(
1524 struct efi_pxe_base_code_protocol *this,
1525 u16 type, u16 *layer, u8 bis,
1526 struct efi_pxe_base_code_discover_info *info);
1527 efi_status_t (EFIAPI *mtftp)(
1528 struct efi_pxe_base_code_protocol *this,
1529 u32 operation, void *buffer_ptr,
1530 u8 overwrite, efi_uintn_t *buffer_size,
1531 struct efi_ip_address server_ip, char *filename,
1532 struct efi_pxe_base_code_mtftp_info *info,
1533 u8 dont_use_buffer);
1534 efi_status_t (EFIAPI *udp_write)(
1535 struct efi_pxe_base_code_protocol *this,
1536 u16 op_flags, struct efi_ip_address *dest_ip,
1538 struct efi_ip_address *gateway_ip,
1539 struct efi_ip_address *src_ip, u16 *src_port,
1540 efi_uintn_t *header_size, void *header_ptr,
1541 efi_uintn_t *buffer_size, void *buffer_ptr);
1542 efi_status_t (EFIAPI *udp_read)(
1543 struct efi_pxe_base_code_protocol *this,
1544 u16 op_flags, struct efi_ip_address *dest_ip,
1545 u16 *dest_port, struct efi_ip_address *src_ip,
1546 u16 *src_port, efi_uintn_t *header_size,
1547 void *header_ptr, efi_uintn_t *buffer_size,
1549 efi_status_t (EFIAPI *set_ip_filter)(
1550 struct efi_pxe_base_code_protocol *this,
1551 struct efi_pxe_base_code_filter *new_filter);
1552 efi_status_t (EFIAPI *arp)(struct efi_pxe_base_code_protocol *this,
1553 struct efi_ip_address *ip_addr,
1554 struct efi_mac_address *mac_addr);
1555 efi_status_t (EFIAPI *set_parameters)(
1556 struct efi_pxe_base_code_protocol *this,
1557 u8 *new_auto_arp, u8 *new_send_guid,
1558 u8 *new_ttl, u8 *new_tos,
1559 u8 *new_make_callback);
1560 efi_status_t (EFIAPI *set_station_ip)(
1561 struct efi_pxe_base_code_protocol *this,
1562 struct efi_ip_address *new_station_ip,
1563 struct efi_ip_address *new_subnet_mask);
1564 efi_status_t (EFIAPI *set_packets)(
1565 struct efi_pxe_base_code_protocol *this,
1566 u8 *new_dhcp_discover_valid,
1567 u8 *new_dhcp_ack_received,
1568 u8 *new_proxy_offer_received,
1569 u8 *new_pxe_discover_valid,
1570 u8 *new_pxe_reply_received,
1571 u8 *new_pxe_bis_reply_received,
1572 EFI_PXE_BASE_CODE_PACKET *new_dchp_discover,
1573 EFI_PXE_BASE_CODE_PACKET *new_dhcp_acc,
1574 EFI_PXE_BASE_CODE_PACKET *new_proxy_offer,
1575 EFI_PXE_BASE_CODE_PACKET *new_pxe_discover,
1576 EFI_PXE_BASE_CODE_PACKET *new_pxe_reply,
1577 EFI_PXE_BASE_CODE_PACKET *new_pxe_bis_reply);
1578 struct efi_pxe_mode *mode;
1581 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID \
1582 EFI_GUID(0x964e5b22, 0x6459, 0x11d2, \
1583 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
1584 #define EFI_FILE_PROTOCOL_REVISION 0x00010000
1585 #define EFI_FILE_PROTOCOL_REVISION2 0x00020000
1586 #define EFI_FILE_PROTOCOL_LATEST_REVISION EFI_FILE_PROTOCOL_REVISION2
1588 struct efi_file_io_token {
1589 struct efi_event *event;
1590 efi_status_t status;
1591 efi_uintn_t buffer_size;
1594 struct efi_file_handle {
1596 efi_status_t (EFIAPI *open)(struct efi_file_handle *this,
1597 struct efi_file_handle **new_handle,
1598 u16 *file_name, u64 open_mode, u64 attributes);
1599 efi_status_t (EFIAPI *close)(struct efi_file_handle *this);
1600 efi_status_t (EFIAPI *delete)(struct efi_file_handle *this);
1601 efi_status_t (EFIAPI *read)(struct efi_file_handle *this,
1602 efi_uintn_t *buffer_size, void *buffer);
1603 efi_status_t (EFIAPI *write)(struct efi_file_handle *this,
1604 efi_uintn_t *buffer_size, void *buffer);
1605 efi_status_t (EFIAPI *getpos)(struct efi_file_handle *this,
1607 efi_status_t (EFIAPI *setpos)(struct efi_file_handle *this,
1609 efi_status_t (EFIAPI *getinfo)(struct efi_file_handle *this,
1610 const efi_guid_t *info_type, efi_uintn_t *buffer_size,
1612 efi_status_t (EFIAPI *setinfo)(struct efi_file_handle *this,
1613 const efi_guid_t *info_type, efi_uintn_t buffer_size,
1615 efi_status_t (EFIAPI *flush)(struct efi_file_handle *this);
1616 efi_status_t (EFIAPI *open_ex)(struct efi_file_handle *this,
1617 struct efi_file_handle **new_handle,
1618 u16 *file_name, u64 open_mode, u64 attributes,
1619 struct efi_file_io_token *token);
1620 efi_status_t (EFIAPI *read_ex)(struct efi_file_handle *this,
1621 struct efi_file_io_token *token);
1622 efi_status_t (EFIAPI *write_ex)(struct efi_file_handle *this,
1623 struct efi_file_io_token *token);
1624 efi_status_t (EFIAPI *flush_ex)(struct efi_file_handle *this,
1625 struct efi_file_io_token *token);
1628 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION 0x00010000
1630 struct efi_simple_file_system_protocol {
1632 efi_status_t (EFIAPI *open_volume)(struct efi_simple_file_system_protocol *this,
1633 struct efi_file_handle **root);
1636 #define EFI_FILE_INFO_GUID \
1637 EFI_GUID(0x9576e92, 0x6d3f, 0x11d2, \
1638 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
1640 #define EFI_FILE_SYSTEM_INFO_GUID \
1641 EFI_GUID(0x09576e93, 0x6d3f, 0x11d2, \
1642 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
1644 #define EFI_FILE_SYSTEM_VOLUME_LABEL_ID \
1645 EFI_GUID(0xdb47d7d3, 0xfe81, 0x11d3, \
1646 0x9a, 0x35, 0x00, 0x90, 0x27, 0x3f, 0xC1, 0x4d)
1648 #define EFI_FILE_MODE_READ 0x0000000000000001
1649 #define EFI_FILE_MODE_WRITE 0x0000000000000002
1650 #define EFI_FILE_MODE_CREATE 0x8000000000000000
1652 #define EFI_FILE_READ_ONLY 0x0000000000000001
1653 #define EFI_FILE_HIDDEN 0x0000000000000002
1654 #define EFI_FILE_SYSTEM 0x0000000000000004
1655 #define EFI_FILE_RESERVED 0x0000000000000008
1656 #define EFI_FILE_DIRECTORY 0x0000000000000010
1657 #define EFI_FILE_ARCHIVE 0x0000000000000020
1658 #define EFI_FILE_VALID_ATTR 0x0000000000000037
1660 struct efi_file_info {
1664 struct efi_time create_time;
1665 struct efi_time last_access_time;
1666 struct efi_time modification_time;
1671 struct efi_file_system_info {
1677 u16 volume_label[0];
1680 #define EFI_DRIVER_BINDING_PROTOCOL_GUID \
1681 EFI_GUID(0x18a031ab, 0xb443, 0x4d1a,\
1682 0xa5, 0xc0, 0x0c, 0x09, 0x26, 0x1e, 0x9f, 0x71)
1683 struct efi_driver_binding_protocol {
1684 efi_status_t (EFIAPI * supported)(
1685 struct efi_driver_binding_protocol *this,
1686 efi_handle_t controller_handle,
1687 struct efi_device_path *remaining_device_path);
1688 efi_status_t (EFIAPI * start)(
1689 struct efi_driver_binding_protocol *this,
1690 efi_handle_t controller_handle,
1691 struct efi_device_path *remaining_device_path);
1692 efi_status_t (EFIAPI * stop)(
1693 struct efi_driver_binding_protocol *this,
1694 efi_handle_t controller_handle,
1695 efi_uintn_t number_of_children,
1696 efi_handle_t *child_handle_buffer);
1698 efi_handle_t image_handle;
1699 efi_handle_t driver_binding_handle;
1702 /* Current version of the Unicode collation protocol */
1703 #define EFI_UNICODE_COLLATION_PROTOCOL2_GUID \
1704 EFI_GUID(0xa4c751fc, 0x23ae, 0x4c3e, \
1705 0x92, 0xe9, 0x49, 0x64, 0xcf, 0x63, 0xf3, 0x49)
1706 struct efi_unicode_collation_protocol {
1707 efi_intn_t (EFIAPI *stri_coll)(
1708 struct efi_unicode_collation_protocol *this, u16 *s1, u16 *s2);
1709 bool (EFIAPI *metai_match)(struct efi_unicode_collation_protocol *this,
1710 const u16 *string, const u16 *patter);
1711 void (EFIAPI *str_lwr)(struct efi_unicode_collation_protocol
1712 *this, u16 *string);
1713 void (EFIAPI *str_upr)(struct efi_unicode_collation_protocol *this,
1715 void (EFIAPI *fat_to_str)(struct efi_unicode_collation_protocol *this,
1716 efi_uintn_t fat_size, char *fat, u16 *string);
1717 bool (EFIAPI *str_to_fat)(struct efi_unicode_collation_protocol *this,
1718 const u16 *string, efi_uintn_t fat_size,
1720 char *supported_languages;
1723 struct efi_load_file_protocol {
1724 efi_status_t (EFIAPI *load_file)(struct efi_load_file_protocol *this,
1725 struct efi_device_path *file_path,
1727 efi_uintn_t *buffer_size,
1731 struct efi_system_resource_entry {
1732 efi_guid_t fw_class;
1735 u32 lowest_supported_fw_version;
1737 u32 last_attempt_version;
1738 u32 last_attempt_status;
1741 struct efi_system_resource_table {
1742 u32 fw_resource_count;
1743 u32 fw_resource_count_max;
1744 u64 fw_resource_version;
1745 struct efi_system_resource_entry entries[];
1748 /* Boot manager load options */
1749 #define LOAD_OPTION_ACTIVE 0x00000001
1750 #define LOAD_OPTION_FORCE_RECONNECT 0x00000002
1751 #define LOAD_OPTION_HIDDEN 0x00000008
1752 /* All values 0x00000200-0x00001F00 are reserved */
1753 #define LOAD_OPTION_CATEGORY 0x00001F00
1754 #define LOAD_OPTION_CATEGORY_BOOT 0x00000000
1755 #define LOAD_OPTION_CATEGORY_APP 0x00000100
1758 * System Resource Table
1760 /* Firmware Type Definitions */
1761 #define ESRT_FW_TYPE_UNKNOWN 0x00000000
1762 #define ESRT_FW_TYPE_SYSTEMFIRMWARE 0x00000001
1763 #define ESRT_FW_TYPE_DEVICEFIRMWARE 0x00000002
1764 #define ESRT_FW_TYPE_UEFIDRIVER 0x00000003
1766 #define EFI_SYSTEM_RESOURCE_TABLE_GUID\
1767 EFI_GUID(0xb122a263, 0x3661, 0x4f68,\
1768 0x99, 0x29, 0x78, 0xf8, 0xb0, 0xd6, 0x21, 0x80)
1770 /* Last Attempt Status Values */
1771 #define LAST_ATTEMPT_STATUS_SUCCESS 0x00000000
1772 #define LAST_ATTEMPT_STATUS_ERROR_UNSUCCESSFUL 0x00000001
1773 #define LAST_ATTEMPT_STATUS_ERROR_INSUFFICIENT_RESOURCES 0x00000002
1774 #define LAST_ATTEMPT_STATUS_ERROR_INCORRECT_VERSION 0x00000003
1775 #define LAST_ATTEMPT_STATUS_ERROR_INVALID_FORMAT 0x00000004
1776 #define LAST_ATTEMPT_STATUS_ERROR_AUTH_ERROR 0x00000005
1777 #define LAST_ATTEMPT_STATUS_ERROR_PWR_EVT_AC 0x00000006
1778 #define LAST_ATTEMPT_STATUS_ERROR_PWR_EVT_BATT 0x00000007
1779 #define LAST_ATTEMPT_STATUS_ERROR_UNSATISFIED_DEPENDENCIES 0x00000008
1782 * The LastAttemptStatus values of 0x1000 - 0x4000 are reserved for vendor
1785 #define LAST_ATTEMPT_STATUS_ERROR_UNSUCCESSFUL_VENDOR_RANGE_MIN 0x00001000
1786 #define LAST_ATTEMPT_STATUS_ERROR_UNSUCCESSFUL_VENDOR_RANGE_MAX 0x00004000
1788 /* Certificate types in signature database */
1789 #define EFI_CERT_SHA256_GUID \
1790 EFI_GUID(0xc1c41626, 0x504c, 0x4092, 0xac, 0xa9, \
1791 0x41, 0xf9, 0x36, 0x93, 0x43, 0x28)
1792 #define EFI_CERT_RSA2048_GUID \
1793 EFI_GUID(0x3c5766e8, 0x269c, 0x4e34, 0xaa, 0x14, \
1794 0xed, 0x77, 0x6e, 0x85, 0xb3, 0xb6)
1795 #define EFI_CERT_X509_GUID \
1796 EFI_GUID(0xa5c059a1, 0x94e4, 0x4aa7, 0x87, 0xb5, \
1797 0xab, 0x15, 0x5c, 0x2b, 0xf0, 0x72)
1798 #define EFI_CERT_X509_SHA256_GUID \
1799 EFI_GUID(0x3bd2a492, 0x96c0, 0x4079, 0xb4, 0x20, \
1800 0xfc, 0xf9, 0x8e, 0xf1, 0x03, 0xed)
1801 #define EFI_CERT_TYPE_PKCS7_GUID \
1802 EFI_GUID(0x4aafd29d, 0x68df, 0x49ee, 0x8a, 0xa9, \
1803 0x34, 0x7d, 0x37, 0x56, 0x65, 0xa7)
1806 * win_certificate_uefi_guid - A certificate that encapsulates
1807 * a GUID-specific signature
1809 * @hdr: Windows certificate header
1810 * @cert_type: Certificate type
1811 * @cert_data: Certificate data
1813 struct win_certificate_uefi_guid {
1814 WIN_CERTIFICATE hdr;
1815 efi_guid_t cert_type;
1817 } __attribute__((__packed__));
1820 * efi_variable_authentication_2 - A time-based authentication method
1823 * This structure describes an authentication information for
1824 * a variable with EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
1825 * and should be included as part of a variable's value.
1826 * Only EFI_CERT_TYPE_PKCS7_GUID is accepted.
1828 * @time_stamp: Descriptor's time stamp
1829 * @auth_info: Authentication info
1831 struct efi_variable_authentication_2 {
1832 struct efi_time time_stamp;
1833 struct win_certificate_uefi_guid auth_info;
1834 } __attribute__((__packed__));
1837 * efi_firmware_image_authentication - Capsule authentication method
1840 * This structure describes an authentication information for
1841 * a capsule with IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED set
1842 * and should be included as part of the capsule.
1843 * Only EFI_CERT_TYPE_PKCS7_GUID is accepted.
1845 * @monotonic_count: Count to prevent replay
1846 * @auth_info: Authentication info
1848 struct efi_firmware_image_authentication {
1849 uint64_t monotonic_count;
1850 struct win_certificate_uefi_guid auth_info;
1851 } __attribute__((__packed__));
1855 * efi_signature_data - A format of signature
1857 * This structure describes a single signature in signature database.
1859 * @signature_owner: Signature owner
1860 * @signature_data: Signature data
1862 struct efi_signature_data {
1863 efi_guid_t signature_owner;
1864 u8 signature_data[];
1865 } __attribute__((__packed__));
1868 * efi_signature_list - A format of signature database
1870 * This structure describes a list of signatures with the same type.
1871 * An authenticated variable's value is a concatenation of one or more
1872 * efi_signature_list's.
1874 * @signature_type: Signature type
1875 * @signature_list_size: Size of signature list
1876 * @signature_header_size: Size of signature header
1877 * @signature_size: Size of signature
1879 struct efi_signature_list {
1880 efi_guid_t signature_type;
1881 u32 signature_list_size;
1882 u32 signature_header_size;
1884 /* u8 signature_header[signature_header_size]; */
1885 /* struct efi_signature_data signatures[...][signature_size]; */
1886 } __attribute__((__packed__));
1889 * Firmware management protocol
1891 #define EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GUID \
1892 EFI_GUID(0x86c77a67, 0x0b97, 0x4633, 0xa1, 0x87, \
1893 0x49, 0x10, 0x4d, 0x06, 0x85, 0xc7)
1895 #define EFI_FIRMWARE_IMAGE_TYPE_UBOOT_FIT_GUID \
1896 EFI_GUID(0xae13ff2d, 0x9ad4, 0x4e25, 0x9a, 0xc8, \
1897 0x6d, 0x80, 0xb3, 0xb2, 0x21, 0x47)
1899 #define EFI_FIRMWARE_IMAGE_TYPE_UBOOT_RAW_GUID \
1900 EFI_GUID(0xe2bb9c06, 0x70e9, 0x4b14, 0x97, 0xa3, \
1901 0x5a, 0x79, 0x13, 0x17, 0x6e, 0x3f)
1903 #define IMAGE_ATTRIBUTE_IMAGE_UPDATABLE 0x0000000000000001
1904 #define IMAGE_ATTRIBUTE_RESET_REQUIRED 0x0000000000000002
1905 #define IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED 0x0000000000000004
1906 #define IMAGE_ATTRIBUTE_IN_USE 0x0000000000000008
1907 #define IMAGE_ATTRIBUTE_UEFI_IMAGE 0x0000000000000010
1908 #define IMAGE_ATTRIBUTE_DEPENDENCY 0x0000000000000020
1910 #define IMAGE_COMPATIBILITY_CHECK_SUPPORTED 0x0000000000000001
1912 #define IMAGE_UPDATABLE_VALID 0x0000000000000001
1913 #define IMAGE_UPDATABLE_INVALID 0x0000000000000002
1914 #define IMAGE_UPDATABLE_INVALID_TYPE 0x0000000000000004
1915 #define IMAGE_UPDATABLE_INVALID_OLLD 0x0000000000000008
1916 #define IMAGE_UPDATABLE_VALID_WITH_VENDOR_CODE 0x0000000000000010
1918 #define PACKAGE_ATTRIBUTE_VERSION_UPDATABLE 0x0000000000000001
1919 #define PACKAGE_ATTRIBUTE_RESET_REQUIRED 0x0000000000000002
1920 #define PACKAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED 0x0000000000000004
1922 #define EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION 4
1924 typedef struct efi_firmware_image_dependencies {
1926 } efi_firmware_image_dep_t;
1928 struct efi_firmware_image_descriptor {
1930 efi_guid_t image_type_id;
1936 u64 attributes_supported;
1937 u64 attributes_setting;
1938 u64 compatibilities;
1939 u32 lowest_supported_image_version;
1940 u32 last_attempt_version;
1941 u32 last_attempt_status;
1942 u64 hardware_instance;
1943 efi_firmware_image_dep_t *dependencies;
1946 struct efi_firmware_management_protocol {
1947 efi_status_t (EFIAPI *get_image_info)(
1948 struct efi_firmware_management_protocol *this,
1949 efi_uintn_t *image_info_size,
1950 struct efi_firmware_image_descriptor *image_info,
1951 u32 *descriptor_version,
1952 u8 *descriptor_count,
1953 efi_uintn_t *descriptor_size,
1954 u32 *package_version,
1955 u16 **package_version_name);
1956 efi_status_t (EFIAPI *get_image)(
1957 struct efi_firmware_management_protocol *this,
1960 efi_uintn_t *image_size);
1961 efi_status_t (EFIAPI *set_image)(
1962 struct efi_firmware_management_protocol *this,
1965 efi_uintn_t image_size,
1966 const void *vendor_code,
1967 efi_status_t (*progress)(efi_uintn_t completion),
1968 u16 **abort_reason);
1969 efi_status_t (EFIAPI *check_image)(
1970 struct efi_firmware_management_protocol *this,
1973 efi_uintn_t *image_size,
1974 u32 *image_updatable);
1975 efi_status_t (EFIAPI *get_package_info)(
1976 struct efi_firmware_management_protocol *this,
1977 u32 *package_version,
1978 u16 **package_version_name,
1979 u32 *package_version_name_maxlen,
1980 u64 *attributes_supported,
1981 u64 *attributes_setting);
1982 efi_status_t (EFIAPI *set_package_info)(
1983 struct efi_firmware_management_protocol *this,
1985 efi_uintn_t *image_size,
1986 const void *vendor_code,
1987 u32 package_version,
1988 const u16 *package_version_name);