1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3 * Extensible Firmware Interface
4 * Based on 'Extensible Firmware Interface Specification' version 0.9,
5 * April 30, 1999
6 *
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>
12 *
13 * From include/linux/efi.h in kernel 4.1 with some additions/subtractions
14 */
15
16 #ifndef _EFI_API_H
17 #define _EFI_API_H
18
19 #include <efi.h>
20 #include <charset.h>
21 #include <pe.h>
22
23 #ifdef CONFIG_EFI_LOADER
24 #include <asm/setjmp.h>
25 #endif
26
27 /* UEFI spec version 2.8 */
28 #define EFI_SPECIFICATION_VERSION (2 << 16 | 80)
29
30 /* Types and defines for EFI CreateEvent */
31 enum efi_timer_delay {
32 EFI_TIMER_STOP = 0,
33 EFI_TIMER_PERIODIC = 1,
34 EFI_TIMER_RELATIVE = 2
35 };
36
37 typedef void *efi_hii_handle_t;
38 typedef u16 *efi_string_t;
39 typedef u16 efi_string_id_t;
40 typedef u32 efi_hii_font_style_t;
41 typedef u16 efi_question_id_t;
42 typedef u16 efi_image_id_t;
43 typedef u16 efi_form_id_t;
44
45 #define EVT_TIMER 0x80000000
46 #define EVT_RUNTIME 0x40000000
47 #define EVT_NOTIFY_WAIT 0x00000100
48 #define EVT_NOTIFY_SIGNAL 0x00000200
49 #define EVT_SIGNAL_EXIT_BOOT_SERVICES 0x00000201
50 #define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE 0x60000202
51
52 #define TPL_APPLICATION 0x04
53 #define TPL_CALLBACK 0x08
54 #define TPL_NOTIFY 0x10
55 #define TPL_HIGH_LEVEL 0x1F
56
57 struct efi_event;
58
59 /* OsIndicationsSupported flags */
60 #define EFI_OS_INDICATIONS_BOOT_TO_FW_UI 0x0000000000000001
61 #define EFI_OS_INDICATIONS_TIMESTAMP_REVOCATION 0x0000000000000002
62 #define EFI_OS_INDICATIONS_FILE_CAPSULE_DELIVERY_SUPPORTED 0x0000000000000004
63 #define EFI_OS_INDICATIONS_FMP_CAPSULE_SUPPORTED 0x0000000000000008
64 #define EFI_OS_INDICATIONS_CAPSULE_RESULT_VAR_SUPPORTED 0x0000000000000010
65 #define EFI_OS_INDICATIONS_START_OS_RECOVERY 0x0000000000000020
66 #define EFI_OS_INDICATIONS_START_PLATFORM_RECOVERY 0x0000000000000040
67 #define EFI_OS_INDICATIONS_JSON_CONFIG_DATA_REFRESH 0x0000000000000080
68
69 /* EFI Boot Services table */
70 #define EFI_BOOT_SERVICES_SIGNATURE 0x56524553544f4f42
71 struct efi_boot_services {
72 struct efi_table_hdr hdr;
73 efi_status_t (EFIAPI *raise_tpl)(efi_uintn_t new_tpl);
74 void (EFIAPI *restore_tpl)(efi_uintn_t old_tpl);
75
76 efi_status_t (EFIAPI *allocate_pages)(int, int, efi_uintn_t,
77 efi_physical_addr_t *);
78 efi_status_t (EFIAPI *free_pages)(efi_physical_addr_t, efi_uintn_t);
79 efi_status_t (EFIAPI *get_memory_map)(efi_uintn_t *memory_map_size,
80 struct efi_mem_desc *desc,
81 efi_uintn_t *key,
82 efi_uintn_t *desc_size,
83 u32 *desc_version);
84 efi_status_t (EFIAPI *allocate_pool)(int, efi_uintn_t, void **);
85 efi_status_t (EFIAPI *free_pool)(void *);
86
87 efi_status_t (EFIAPI *create_event)(uint32_t type,
88 efi_uintn_t notify_tpl,
89 void (EFIAPI *notify_function) (
90 struct efi_event *event,
91 void *context),
92 void *notify_context, struct efi_event **event);
93 efi_status_t (EFIAPI *set_timer)(struct efi_event *event,
94 enum efi_timer_delay type,
95 uint64_t trigger_time);
96 efi_status_t (EFIAPI *wait_for_event)(efi_uintn_t number_of_events,
97 struct efi_event **event,
98 efi_uintn_t *index);
99 efi_status_t (EFIAPI *signal_event)(struct efi_event *event);
100 efi_status_t (EFIAPI *close_event)(struct efi_event *event);
101 efi_status_t (EFIAPI *check_event)(struct efi_event *event);
102 #define EFI_NATIVE_INTERFACE 0x00000000
103 efi_status_t (EFIAPI *install_protocol_interface)(
104 efi_handle_t *handle, const efi_guid_t *protocol,
105 int protocol_interface_type, void *protocol_interface);
106 efi_status_t (EFIAPI *reinstall_protocol_interface)(
107 efi_handle_t handle, const efi_guid_t *protocol,
108 void *old_interface, void *new_interface);
109 efi_status_t (EFIAPI *uninstall_protocol_interface)(
110 efi_handle_t handle, const efi_guid_t *protocol,
111 void *protocol_interface);
112 efi_status_t (EFIAPI *handle_protocol)(
113 efi_handle_t handle, const efi_guid_t *protocol,
114 void **protocol_interface);
115 void *reserved;
116 efi_status_t (EFIAPI *register_protocol_notify)(
117 const efi_guid_t *protocol, struct efi_event *event,
118 void **registration);
119 efi_status_t (EFIAPI *locate_handle)(
120 enum efi_locate_search_type search_type,
121 const efi_guid_t *protocol, void *search_key,
122 efi_uintn_t *buffer_size, efi_handle_t *buffer);
123 efi_status_t (EFIAPI *locate_device_path)(const efi_guid_t *protocol,
124 struct efi_device_path **device_path,
125 efi_handle_t *device);
126 efi_status_t (EFIAPI *install_configuration_table)(
127 efi_guid_t *guid, void *table);
128
129 efi_status_t (EFIAPI *load_image)(bool boot_policiy,
130 efi_handle_t parent_image,
131 struct efi_device_path *file_path, void *source_buffer,
132 efi_uintn_t source_size, efi_handle_t *image);
133 efi_status_t (EFIAPI *start_image)(efi_handle_t handle,
134 efi_uintn_t *exitdata_size,
135 u16 **exitdata);
136 efi_status_t (EFIAPI *exit)(efi_handle_t handle,
137 efi_status_t exit_status,
138 efi_uintn_t exitdata_size, u16 *exitdata);
139 efi_status_t (EFIAPI *unload_image)(efi_handle_t image_handle);
140 efi_status_t (EFIAPI *exit_boot_services)(efi_handle_t image_handle,
141 efi_uintn_t map_key);
142
143 efi_status_t (EFIAPI *get_next_monotonic_count)(u64 *count);
144 efi_status_t (EFIAPI *stall)(unsigned long usecs);
145 efi_status_t (EFIAPI *set_watchdog_timer)(unsigned long timeout,
146 uint64_t watchdog_code, unsigned long data_size,
147 uint16_t *watchdog_data);
148 efi_status_t(EFIAPI *connect_controller)(efi_handle_t controller_handle,
149 efi_handle_t *driver_image_handle,
150 struct efi_device_path *remaining_device_path,
151 bool recursive);
152 efi_status_t (EFIAPI *disconnect_controller)(
153 efi_handle_t controller_handle,
154 efi_handle_t driver_image_handle,
155 efi_handle_t child_handle);
156 #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001
157 #define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002
158 #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004
159 #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008
160 #define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010
161 #define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020
162 efi_status_t (EFIAPI *open_protocol)(efi_handle_t handle,
163 const efi_guid_t *protocol, void **interface,
164 efi_handle_t agent_handle,
165 efi_handle_t controller_handle, u32 attributes);
166 efi_status_t (EFIAPI *close_protocol)(
167 efi_handle_t handle, const efi_guid_t *protocol,
168 efi_handle_t agent_handle,
169 efi_handle_t controller_handle);
170 efi_status_t(EFIAPI *open_protocol_information)(efi_handle_t handle,
171 const efi_guid_t *protocol,
172 struct efi_open_protocol_info_entry **entry_buffer,
173 efi_uintn_t *entry_count);
174 efi_status_t (EFIAPI *protocols_per_handle)(efi_handle_t handle,
175 efi_guid_t ***protocol_buffer,
176 efi_uintn_t *protocols_buffer_count);
177 efi_status_t (EFIAPI *locate_handle_buffer) (
178 enum efi_locate_search_type search_type,
179 const efi_guid_t *protocol, void *search_key,
180 efi_uintn_t *no_handles, efi_handle_t **buffer);
181 efi_status_t (EFIAPI *locate_protocol)(const efi_guid_t *protocol,
182 void *registration, void **protocol_interface);
183 efi_status_t (EFIAPI *install_multiple_protocol_interfaces)(
184 efi_handle_t *handle, ...);
185 efi_status_t (EFIAPI *uninstall_multiple_protocol_interfaces)(
186 efi_handle_t handle, ...);
187 efi_status_t (EFIAPI *calculate_crc32)(const void *data,
188 efi_uintn_t data_size,
189 u32 *crc32);
190 void (EFIAPI *copy_mem)(void *destination, const void *source,
191 size_t length);
192 void (EFIAPI *set_mem)(void *buffer, size_t size, uint8_t value);
193 efi_status_t (EFIAPI *create_event_ex)(
194 uint32_t type, efi_uintn_t notify_tpl,
195 void (EFIAPI *notify_function) (
196 struct efi_event *event,
197 void *context),
198 void *notify_context,
199 efi_guid_t *event_group,
200 struct efi_event **event);
201 };
202
203 /* Types and defines for EFI ResetSystem */
204 enum efi_reset_type {
205 EFI_RESET_COLD = 0,
206 EFI_RESET_WARM = 1,
207 EFI_RESET_SHUTDOWN = 2,
208 EFI_RESET_PLATFORM_SPECIFIC = 3,
209 };
210
211 /* EFI Runtime Services table */
212 #define EFI_RUNTIME_SERVICES_SIGNATURE 0x56524553544e5552ULL
213
214 #define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000
215 #define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE 0x00020000
216 #define CAPSULE_FLAGS_INITIATE_RESET 0x00040000
217
218 #define CAPSULE_SUPPORT_AUTHENTICATION 0x0000000000000001
219 #define CAPSULE_SUPPORT_DEPENDENCY 0x0000000000000002
220
221 #define EFI_CAPSULE_REPORT_GUID \
222 EFI_GUID(0x39b68c46, 0xf7fb, 0x441b, 0xb6, 0xec, \
223 0x16, 0xb0, 0xf6, 0x98, 0x21, 0xf3)
224
225 #define EFI_MEMORY_RANGE_CAPSULE_GUID \
226 EFI_GUID(0xde9f0ec, 0x88b6, 0x428f, 0x97, 0x7a, \
227 0x25, 0x8f, 0x1d, 0xe, 0x5e, 0x72)
228
229 #define EFI_FIRMWARE_MANAGEMENT_CAPSULE_ID_GUID \
230 EFI_GUID(0x6dcbd5ed, 0xe82d, 0x4c44, 0xbd, 0xa1, \
231 0x71, 0x94, 0x19, 0x9a, 0xd9, 0x2a)
232
233 struct efi_capsule_header {
234 efi_guid_t capsule_guid;
235 u32 header_size;
236 u32 flags;
237 u32 capsule_image_size;
238 } __packed;
239
240 struct efi_capsule_result_variable_header {
241 u32 variable_total_size;
242 u32 reserved;
243 efi_guid_t capsule_guid;
244 struct efi_time capsule_processed;
245 efi_status_t capsule_status;
246 } __packed;
247
248 struct efi_memory_range {
249 efi_physical_addr_t address;
250 u64 length;
251 };
252
253 struct efi_memory_range_capsule {
254 struct efi_capsule_header *header;
255 /* EFI_MEMORY_TYPE: 0x80000000-0xFFFFFFFF */
256 enum efi_mem_type os_requested_memory_type;
257 u64 number_of_memory_ranges;
258 struct efi_memory_range memory_ranges[];
259 } __packed;
260
261 struct efi_firmware_management_capsule_header {
262 u32 version;
263 u16 embedded_driver_count;
264 u16 payload_item_count;
265 u64 item_offset_list[];
266 } __packed;
267
268 struct efi_firmware_management_capsule_image_header {
269 u32 version;
270 efi_guid_t update_image_type_id;
271 u8 update_image_index;
272 u8 reserved[3];
273 u32 update_image_size;
274 u32 update_vendor_code_size;
275 u64 update_hardware_instance;
276 u64 image_capsule_support;
277 } __packed;
278
279 struct efi_capsule_result_variable_fmp {
280 u16 version;
281 u8 payload_index;
282 u8 update_image_index;
283 efi_guid_t update_image_type_id;
284 // u16 capsule_file_name[];
285 // u16 capsule_target[];
286 } __packed;
287
288 #define EFI_RT_SUPPORTED_GET_TIME 0x0001
289 #define EFI_RT_SUPPORTED_SET_TIME 0x0002
290 #define EFI_RT_SUPPORTED_GET_WAKEUP_TIME 0x0004
291 #define EFI_RT_SUPPORTED_SET_WAKEUP_TIME 0x0008
292 #define EFI_RT_SUPPORTED_GET_VARIABLE 0x0010
293 #define EFI_RT_SUPPORTED_GET_NEXT_VARIABLE_NAME 0x0020
294 #define EFI_RT_SUPPORTED_SET_VARIABLE 0x0040
295 #define EFI_RT_SUPPORTED_SET_VIRTUAL_ADDRESS_MAP 0x0080
296 #define EFI_RT_SUPPORTED_CONVERT_POINTER 0x0100
297 #define EFI_RT_SUPPORTED_GET_NEXT_HIGH_MONOTONIC_COUNT 0x0200
298 #define EFI_RT_SUPPORTED_RESET_SYSTEM 0x0400
299 #define EFI_RT_SUPPORTED_UPDATE_CAPSULE 0x0800
300 #define EFI_RT_SUPPORTED_QUERY_CAPSULE_CAPABILITIES 0x1000
301 #define EFI_RT_SUPPORTED_QUERY_VARIABLE_INFO 0x2000
302
303 #define EFI_RT_PROPERTIES_TABLE_GUID \
304 EFI_GUID(0xeb66918a, 0x7eef, 0x402a, 0x84, 0x2e, \
305 0x93, 0x1d, 0x21, 0xc3, 0x8a, 0xe9)
306
307 #define EFI_RT_PROPERTIES_TABLE_VERSION 0x1
308
309 struct efi_rt_properties_table {
310 u16 version;
311 u16 length;
312 u32 runtime_services_supported;
313 };
314
315 #define EFI_OPTIONAL_PTR 0x00000001
316
317 struct efi_runtime_services {
318 struct efi_table_hdr hdr;
319 efi_status_t (EFIAPI *get_time)(struct efi_time *time,
320 struct efi_time_cap *capabilities);
321 efi_status_t (EFIAPI *set_time)(struct efi_time *time);
322 efi_status_t (EFIAPI *get_wakeup_time)(char *enabled, char *pending,
323 struct efi_time *time);
324 efi_status_t (EFIAPI *set_wakeup_time)(char enabled,
325 struct efi_time *time);
326 efi_status_t (EFIAPI *set_virtual_address_map)(
327 efi_uintn_t memory_map_size,
328 efi_uintn_t descriptor_size,
329 uint32_t descriptor_version,
330 struct efi_mem_desc *virtmap);
331 efi_status_t (EFIAPI *convert_pointer)(
332 efi_uintn_t debug_disposition, void **address);
333 efi_status_t (EFIAPI *get_variable)(u16 *variable_name,
334 const efi_guid_t *vendor,
335 u32 *attributes,
336 efi_uintn_t *data_size, void *data);
337 efi_status_t (EFIAPI *get_next_variable_name)(
338 efi_uintn_t *variable_name_size,
339 u16 *variable_name, efi_guid_t *vendor);
340 efi_status_t (EFIAPI *set_variable)(u16 *variable_name,
341 const efi_guid_t *vendor,
342 u32 attributes,
343 efi_uintn_t data_size,
344 const void *data);
345 efi_status_t (EFIAPI *get_next_high_mono_count)(
346 uint32_t *high_count);
347 void (EFIAPI *reset_system)(enum efi_reset_type reset_type,
348 efi_status_t reset_status,
349 unsigned long data_size, void *reset_data);
350 efi_status_t (EFIAPI *update_capsule)(
351 struct efi_capsule_header **capsule_header_array,
352 efi_uintn_t capsule_count,
353 u64 scatter_gather_list);
354 efi_status_t (EFIAPI *query_capsule_caps)(
355 struct efi_capsule_header **capsule_header_array,
356 efi_uintn_t capsule_count,
357 u64 *maximum_capsule_size,
358 u32 *reset_type);
359 efi_status_t (EFIAPI *query_variable_info)(
360 u32 attributes,
361 u64 *maximum_variable_storage_size,
362 u64 *remaining_variable_storage_size,
363 u64 *maximum_variable_size);
364 };
365
366 /* EFI event group GUID definitions */
367 #define EFI_EVENT_GROUP_EXIT_BOOT_SERVICES \
368 EFI_GUID(0x27abf055, 0xb1b8, 0x4c26, 0x80, 0x48, \
369 0x74, 0x8f, 0x37, 0xba, 0xa2, 0xdf)
370
371 #define EFI_EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE \
372 EFI_GUID(0x13fa7698, 0xc831, 0x49c7, 0x87, 0xea, \
373 0x8f, 0x43, 0xfc, 0xc2, 0x51, 0x96)
374
375 #define EFI_EVENT_GROUP_MEMORY_MAP_CHANGE \
376 EFI_GUID(0x78bee926, 0x692f, 0x48fd, 0x9e, 0xdb, \
377 0x01, 0x42, 0x2e, 0xf0, 0xd7, 0xab)
378
379 #define EFI_EVENT_GROUP_READY_TO_BOOT \
380 EFI_GUID(0x7ce88fb3, 0x4bd7, 0x4679, 0x87, 0xa8, \
381 0xa8, 0xd8, 0xde, 0xe5, 0x0d, 0x2b)
382
383 #define EFI_EVENT_GROUP_RESET_SYSTEM \
384 EFI_GUID(0x62da6a56, 0x13fb, 0x485a, 0xa8, 0xda, \
385 0xa3, 0xdd, 0x79, 0x12, 0xcb, 0x6b)
386
387 /* EFI Configuration Table and GUID definitions */
388 #define NULL_GUID \
389 EFI_GUID(0x00000000, 0x0000, 0x0000, 0x00, 0x00, \
390 0x00, 0x00, 0x00, 0x00, 0x00, 0x00)
391
392 #define EFI_GLOBAL_VARIABLE_GUID \
393 EFI_GUID(0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, \
394 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c)
395
396 #define EFI_IMAGE_SECURITY_DATABASE_GUID \
397 EFI_GUID(0xd719b2cb, 0x3d3a, 0x4596, 0xa3, 0xbc, \
398 0xda, 0xd0, 0x0e, 0x67, 0x65, 0x6f)
399
400 #define EFI_FDT_GUID \
401 EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5, \
402 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0)
403
404 #define EFI_ACPI_TABLE_GUID \
405 EFI_GUID(0x8868e871, 0xe4f1, 0x11d3, \
406 0xbc, 0x22, 0x00, 0x80, 0xc7, 0x3c, 0x88, 0x81)
407
408 #define SMBIOS_TABLE_GUID \
409 EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3, \
410 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
411
412 #define EFI_LOAD_FILE_PROTOCOL_GUID \
413 EFI_GUID(0x56ec3091, 0x954c, 0x11d2, \
414 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
415
416 #define EFI_LOAD_FILE2_PROTOCOL_GUID \
417 EFI_GUID(0x4006c0c1, 0xfcb3, 0x403e, \
418 0x99, 0x6d, 0x4a, 0x6c, 0x87, 0x24, 0xe0, 0x6d)
419
420 #define EFI_TCG2_FINAL_EVENTS_TABLE_GUID \
421 EFI_GUID(0x1e2ed096, 0x30e2, 0x4254, 0xbd, \
422 0x89, 0x86, 0x3b, 0xbe, 0xf8, 0x23, 0x25)
423
424 struct efi_configuration_table {
425 efi_guid_t guid;
426 void *table;
427 } __packed;
428
429 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
430
431 struct efi_system_table {
432 struct efi_table_hdr hdr;
433 u16 *fw_vendor; /* physical addr of wchar_t vendor string */
434 u32 fw_revision;
435 efi_handle_t con_in_handle;
436 struct efi_simple_text_input_protocol *con_in;
437 efi_handle_t con_out_handle;
438 struct efi_simple_text_output_protocol *con_out;
439 efi_handle_t stderr_handle;
440 struct efi_simple_text_output_protocol *std_err;
441 struct efi_runtime_services *runtime;
442 struct efi_boot_services *boottime;
443 efi_uintn_t nr_tables;
444 struct efi_configuration_table *tables;
445 };
446
447 #define EFI_LOADED_IMAGE_PROTOCOL_GUID \
448 EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, \
449 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
450
451 #define EFI_LOADED_IMAGE_DEVICE_PATH_PROTOCOL_GUID \
452 EFI_GUID(0xbc62157e, 0x3e33, 0x4fec, \
453 0x99, 0x20, 0x2d, 0x3b, 0x36, 0xd7, 0x50, 0xdf)
454
455 #define EFI_LOADED_IMAGE_PROTOCOL_REVISION 0x1000
456
457 struct efi_loaded_image {
458 u32 revision;
459 void *parent_handle;
460 struct efi_system_table *system_table;
461 efi_handle_t device_handle;
462 struct efi_device_path *file_path;
463 void *reserved;
464 u32 load_options_size;
465 void *load_options;
466 void *image_base;
467 aligned_u64 image_size;
468 unsigned int image_code_type;
469 unsigned int image_data_type;
470 efi_status_t (EFIAPI *unload)(efi_handle_t image_handle);
471 };
472
473 #define EFI_DEVICE_PATH_PROTOCOL_GUID \
474 EFI_GUID(0x09576e91, 0x6d3f, 0x11d2, \
475 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
476
477 #define DEVICE_PATH_TYPE_END 0x7f
478 # define DEVICE_PATH_SUB_TYPE_INSTANCE_END 0x01
479 # define DEVICE_PATH_SUB_TYPE_END 0xff
480
481 struct efi_device_path {
482 u8 type;
483 u8 sub_type;
484 u16 length;
485 } __packed;
486
487 struct efi_mac_addr {
488 u8 addr[32];
489 } __packed;
490
491 #define DEVICE_PATH_TYPE_HARDWARE_DEVICE 0x01
492 # define DEVICE_PATH_SUB_TYPE_MEMORY 0x03
493 # define DEVICE_PATH_SUB_TYPE_VENDOR 0x04
494
495 struct efi_device_path_memory {
496 struct efi_device_path dp;
497 u32 memory_type;
498 u64 start_address;
499 u64 end_address;
500 } __packed;
501
502 struct efi_device_path_vendor {
503 struct efi_device_path dp;
504 efi_guid_t guid;
505 u8 vendor_data[];
506 } __packed;
507
508 #define DEVICE_PATH_TYPE_ACPI_DEVICE 0x02
509 # define DEVICE_PATH_SUB_TYPE_ACPI_DEVICE 0x01
510
511 #define EFI_PNP_ID(ID) (u32)(((ID) << 16) | 0x41D0)
512 #define EISA_PNP_ID(ID) EFI_PNP_ID(ID)
513 #define EISA_PNP_NUM(ID) ((ID) >> 16)
514
515 struct efi_device_path_acpi_path {
516 struct efi_device_path dp;
517 u32 hid;
518 u32 uid;
519 } __packed;
520
521 #define DEVICE_PATH_TYPE_MESSAGING_DEVICE 0x03
522 # define DEVICE_PATH_SUB_TYPE_MSG_ATAPI 0x01
523 # define DEVICE_PATH_SUB_TYPE_MSG_SCSI 0x02
524 # define DEVICE_PATH_SUB_TYPE_MSG_USB 0x05
525 # define DEVICE_PATH_SUB_TYPE_MSG_MAC_ADDR 0x0b
526 # define DEVICE_PATH_SUB_TYPE_MSG_UART 0x0e
527 # define DEVICE_PATH_SUB_TYPE_MSG_USB_CLASS 0x0f
528 # define DEVICE_PATH_SUB_TYPE_MSG_SATA 0x12
529 # define DEVICE_PATH_SUB_TYPE_MSG_NVME 0x17
530 # define DEVICE_PATH_SUB_TYPE_MSG_SD 0x1a
531 # define DEVICE_PATH_SUB_TYPE_MSG_MMC 0x1d
532
533 struct efi_device_path_atapi {
534 struct efi_device_path dp;
535 u8 primary_secondary;
536 u8 slave_master;
537 u16 logical_unit_number;
538 } __packed;
539
540 struct efi_device_path_scsi {
541 struct efi_device_path dp;
542 u16 target_id;
543 u16 logical_unit_number;
544 } __packed;
545
546 struct efi_device_path_uart {
547 struct efi_device_path dp;
548 u32 reserved;
549 u64 baud_rate;
550 u8 data_bits;
551 u8 parity;
552 u8 stop_bits;
553 } __packed;
554
555 struct efi_device_path_usb {
556 struct efi_device_path dp;
557 u8 parent_port_number;
558 u8 usb_interface;
559 } __packed;
560
561 struct efi_device_path_sata {
562 struct efi_device_path dp;
563 u16 hba_port;
564 u16 port_multiplier_port;
565 u16 logical_unit_number;
566 } __packed;
567
568 struct efi_device_path_mac_addr {
569 struct efi_device_path dp;
570 struct efi_mac_addr mac;
571 u8 if_type;
572 } __packed;
573
574 struct efi_device_path_usb_class {
575 struct efi_device_path dp;
576 u16 vendor_id;
577 u16 product_id;
578 u8 device_class;
579 u8 device_subclass;
580 u8 device_protocol;
581 } __packed;
582
583 struct efi_device_path_sd_mmc_path {
584 struct efi_device_path dp;
585 u8 slot_number;
586 } __packed;
587
588 struct efi_device_path_nvme {
589 struct efi_device_path dp;
590 u32 ns_id;
591 u8 eui64[8];
592 } __packed;
593
594 #define DEVICE_PATH_TYPE_MEDIA_DEVICE 0x04
595 # define DEVICE_PATH_SUB_TYPE_HARD_DRIVE_PATH 0x01
596 # define DEVICE_PATH_SUB_TYPE_CDROM_PATH 0x02
597 # define DEVICE_PATH_SUB_TYPE_VENDOR_PATH 0x03
598 # define DEVICE_PATH_SUB_TYPE_FILE_PATH 0x04
599
600 struct efi_device_path_hard_drive_path {
601 struct efi_device_path dp;
602 u32 partition_number;
603 u64 partition_start;
604 u64 partition_end;
605 u8 partition_signature[16];
606 u8 partmap_type;
607 u8 signature_type;
608 } __packed;
609
610 struct efi_device_path_cdrom_path {
611 struct efi_device_path dp;
612 u32 boot_entry;
613 u64 partition_start;
614 u64 partition_size;
615 } __packed;
616
617 struct efi_device_path_file_path {
618 struct efi_device_path dp;
619 u16 str[];
620 } __packed;
621
622 #define EFI_BLOCK_IO_PROTOCOL_GUID \
623 EFI_GUID(0x964e5b21, 0x6459, 0x11d2, \
624 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
625
626 struct efi_block_io_media {
627 u32 media_id;
628 char removable_media;
629 char media_present;
630 char logical_partition;
631 char read_only;
632 char write_caching;
633 u8 pad[3];
634 u32 block_size;
635 u32 io_align;
636 u8 pad2[4];
637 u64 last_block;
638 /* Added in revision 2 of the protocol */
639 u64 lowest_aligned_lba;
640 u32 logical_blocks_per_physical_block;
641 /* Added in revision 3 of the protocol */
642 u32 optimal_transfer_length_granualarity;
643 };
644
645 #define EFI_BLOCK_IO_PROTOCOL_REVISION2 0x00020001
646 #define EFI_BLOCK_IO_PROTOCOL_REVISION3 0x0002001f
647
648 struct efi_block_io {
649 u64 revision;
650 struct efi_block_io_media *media;
651 efi_status_t (EFIAPI *reset)(struct efi_block_io *this,
652 char extended_verification);
653 efi_status_t (EFIAPI *read_blocks)(struct efi_block_io *this,
654 u32 media_id, u64 lba, efi_uintn_t buffer_size,
655 void *buffer);
656 efi_status_t (EFIAPI *write_blocks)(struct efi_block_io *this,
657 u32 media_id, u64 lba, efi_uintn_t buffer_size,
658 void *buffer);
659 efi_status_t (EFIAPI *flush_blocks)(struct efi_block_io *this);
660 };
661
662 struct simple_text_output_mode {
663 s32 max_mode;
664 s32 mode;
665 s32 attribute;
666 s32 cursor_column;
667 s32 cursor_row;
668 bool cursor_visible;
669 };
670
671 #define EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID \
672 EFI_GUID(0x387477c2, 0x69c7, 0x11d2, \
673 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
674
675 #define EFI_BLACK 0x00
676 #define EFI_BLUE 0x01
677 #define EFI_GREEN 0x02
678 #define EFI_CYAN 0x03
679 #define EFI_RED 0x04
680 #define EFI_MAGENTA 0x05
681 #define EFI_BROWN 0x06
682 #define EFI_LIGHTGRAY 0x07
683 #define EFI_BRIGHT 0x08
684 #define EFI_DARKGRAY 0x08
685 #define EFI_LIGHTBLUE 0x09
686 #define EFI_LIGHTGREEN 0x0a
687 #define EFI_LIGHTCYAN 0x0b
688 #define EFI_LIGHTRED 0x0c
689 #define EFI_LIGHTMAGENTA 0x0d
690 #define EFI_YELLOW 0x0e
691 #define EFI_WHITE 0x0f
692 #define EFI_BACKGROUND_BLACK 0x00
693 #define EFI_BACKGROUND_BLUE 0x10
694 #define EFI_BACKGROUND_GREEN 0x20
695 #define EFI_BACKGROUND_CYAN 0x30
696 #define EFI_BACKGROUND_RED 0x40
697 #define EFI_BACKGROUND_MAGENTA 0x50
698 #define EFI_BACKGROUND_BROWN 0x60
699 #define EFI_BACKGROUND_LIGHTGRAY 0x70
700
701 /* extract foreground color from EFI attribute */
702 #define EFI_ATTR_FG(attr) ((attr) & 0x07)
703 /* treat high bit of FG as bright/bold (similar to edk2) */
704 #define EFI_ATTR_BOLD(attr) (((attr) >> 3) & 0x01)
705 /* extract background color from EFI attribute */
706 #define EFI_ATTR_BG(attr) (((attr) >> 4) & 0x7)
707
708 struct efi_simple_text_output_protocol {
709 efi_status_t (EFIAPI *reset)(
710 struct efi_simple_text_output_protocol *this,
711 char extended_verification);
712 efi_status_t (EFIAPI *output_string)(
713 struct efi_simple_text_output_protocol *this,
714 const u16 *str);
715 efi_status_t (EFIAPI *test_string)(
716 struct efi_simple_text_output_protocol *this,
717 const u16 *str);
718 efi_status_t(EFIAPI *query_mode)(
719 struct efi_simple_text_output_protocol *this,
720 unsigned long mode_number, unsigned long *columns,
721 unsigned long *rows);
722 efi_status_t(EFIAPI *set_mode)(
723 struct efi_simple_text_output_protocol *this,
724 unsigned long mode_number);
725 efi_status_t(EFIAPI *set_attribute)(
726 struct efi_simple_text_output_protocol *this,
727 unsigned long attribute);
728 efi_status_t(EFIAPI *clear_screen) (
729 struct efi_simple_text_output_protocol *this);
730 efi_status_t(EFIAPI *set_cursor_position) (
731 struct efi_simple_text_output_protocol *this,
732 unsigned long column, unsigned long row);
733 efi_status_t(EFIAPI *enable_cursor)(
734 struct efi_simple_text_output_protocol *this,
735 bool enable);
736 struct simple_text_output_mode *mode;
737 };
738
739 #define EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL_GUID \
740 EFI_GUID(0xdd9e7534, 0x7762, 0x4698, \
741 0x8c, 0x14, 0xf5, 0x85, 0x17, 0xa6, 0x25, 0xaa)
742
743 struct efi_input_key {
744 u16 scan_code;
745 s16 unicode_char;
746 };
747
748 #define EFI_SHIFT_STATE_INVALID 0x00000000
749 #define EFI_RIGHT_SHIFT_PRESSED 0x00000001
750 #define EFI_LEFT_SHIFT_PRESSED 0x00000002
751 #define EFI_RIGHT_CONTROL_PRESSED 0x00000004
752 #define EFI_LEFT_CONTROL_PRESSED 0x00000008
753 #define EFI_RIGHT_ALT_PRESSED 0x00000010
754 #define EFI_LEFT_ALT_PRESSED 0x00000020
755 #define EFI_RIGHT_LOGO_PRESSED 0x00000040
756 #define EFI_LEFT_LOGO_PRESSED 0x00000080
757 #define EFI_MENU_KEY_PRESSED 0x00000100
758 #define EFI_SYS_REQ_PRESSED 0x00000200
759 #define EFI_SHIFT_STATE_VALID 0x80000000
760
761 #define EFI_TOGGLE_STATE_INVALID 0x00
762 #define EFI_SCROLL_LOCK_ACTIVE 0x01
763 #define EFI_NUM_LOCK_ACTIVE 0x02
764 #define EFI_CAPS_LOCK_ACTIVE 0x04
765 #define EFI_KEY_STATE_EXPOSED 0x40
766 #define EFI_TOGGLE_STATE_VALID 0x80
767
768 struct efi_key_state {
769 u32 key_shift_state;
770 u8 key_toggle_state;
771 };
772
773 struct efi_key_data {
774 struct efi_input_key key;
775 struct efi_key_state key_state;
776 };
777
778 struct efi_simple_text_input_ex_protocol {
779 efi_status_t (EFIAPI *reset) (
780 struct efi_simple_text_input_ex_protocol *this,
781 bool extended_verification);
782 efi_status_t (EFIAPI *read_key_stroke_ex) (
783 struct efi_simple_text_input_ex_protocol *this,
784 struct efi_key_data *key_data);
785 struct efi_event *wait_for_key_ex;
786 efi_status_t (EFIAPI *set_state) (
787 struct efi_simple_text_input_ex_protocol *this,
788 u8 *key_toggle_state);
789 efi_status_t (EFIAPI *register_key_notify) (
790 struct efi_simple_text_input_ex_protocol *this,
791 struct efi_key_data *key_data,
792 efi_status_t (EFIAPI *key_notify_function)(
793 struct efi_key_data *key_data),
794 void **notify_handle);
795 efi_status_t (EFIAPI *unregister_key_notify) (
796 struct efi_simple_text_input_ex_protocol *this,
797 void *notification_handle);
798 };
799
800 #define EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID \
801 EFI_GUID(0x387477c1, 0x69c7, 0x11d2, \
802 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
803
804 struct efi_simple_text_input_protocol {
805 efi_status_t(EFIAPI *reset)(struct efi_simple_text_input_protocol *this,
806 bool extended_verification);
807 efi_status_t(EFIAPI *read_key_stroke)(
808 struct efi_simple_text_input_protocol *this,
809 struct efi_input_key *key);
810 struct efi_event *wait_for_key;
811 };
812
813 #define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID \
814 EFI_GUID(0x8b843e20, 0x8132, 0x4852, \
815 0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c)
816
817 struct efi_device_path_to_text_protocol {
818 uint16_t *(EFIAPI *convert_device_node_to_text)(
819 struct efi_device_path *device_node,
820 bool display_only,
821 bool allow_shortcuts);
822 uint16_t *(EFIAPI *convert_device_path_to_text)(
823 struct efi_device_path *device_path,
824 bool display_only,
825 bool allow_shortcuts);
826 };
827
828 #define EFI_DEVICE_PATH_UTILITIES_PROTOCOL_GUID \
829 EFI_GUID(0x0379be4e, 0xd706, 0x437d, \
830 0xb0, 0x37, 0xed, 0xb8, 0x2f, 0xb7, 0x72, 0xa4)
831
832 struct efi_device_path_utilities_protocol {
833 efi_uintn_t (EFIAPI *get_device_path_size)(
834 const struct efi_device_path *device_path);
835 struct efi_device_path *(EFIAPI *duplicate_device_path)(
836 const struct efi_device_path *device_path);
837 struct efi_device_path *(EFIAPI *append_device_path)(
838 const struct efi_device_path *src1,
839 const struct efi_device_path *src2);
840 struct efi_device_path *(EFIAPI *append_device_node)(
841 const struct efi_device_path *device_path,
842 const struct efi_device_path *device_node);
843 struct efi_device_path *(EFIAPI *append_device_path_instance)(
844 const struct efi_device_path *device_path,
845 const struct efi_device_path *device_path_instance);
846 struct efi_device_path *(EFIAPI *get_next_device_path_instance)(
847 struct efi_device_path **device_path_instance,
848 efi_uintn_t *device_path_instance_size);
849 bool (EFIAPI *is_device_path_multi_instance)(
850 const struct efi_device_path *device_path);
851 struct efi_device_path *(EFIAPI *create_device_node)(
852 uint8_t node_type,
853 uint8_t node_sub_type,
854 uint16_t node_length);
855 };
856
857 /*
858 * Human Interface Infrastructure (HII)
859 */
860 struct efi_hii_package_list_header {
861 efi_guid_t package_list_guid;
862 u32 package_length;
863 } __packed;
864
865 /**
866 * struct efi_hii_package_header - EFI HII package header
867 *
868 * @fields: 'fields' replaces the bit-fields defined in the EFI
869 * specification to to avoid possible compiler incompatibilities::
870 *
871 * u32 length:24;
872 * u32 type:8;
873 */
874 struct efi_hii_package_header {
875 u32 fields;
876 } __packed;
877
878 #define __EFI_HII_PACKAGE_LEN_SHIFT 0
879 #define __EFI_HII_PACKAGE_TYPE_SHIFT 24
880 #define __EFI_HII_PACKAGE_LEN_MASK 0xffffff
881 #define __EFI_HII_PACKAGE_TYPE_MASK 0xff
882
883 #define EFI_HII_PACKAGE_TYPE_ALL 0x00
884 #define EFI_HII_PACKAGE_TYPE_GUID 0x01
885 #define EFI_HII_PACKAGE_FORMS 0x02
886 #define EFI_HII_PACKAGE_STRINGS 0x04
887 #define EFI_HII_PACKAGE_FONTS 0x05
888 #define EFI_HII_PACKAGE_IMAGES 0x06
889 #define EFI_HII_PACKAGE_SIMPLE_FONTS 0x07
890 #define EFI_HII_PACKAGE_DEVICE_PATH 0x08
891 #define EFI_HII_PACKAGE_KEYBOARD_LAYOUT 0x09
892 #define EFI_HII_PACKAGE_ANIMATIONS 0x0A
893 #define EFI_HII_PACKAGE_END 0xDF
894 #define EFI_HII_PACKAGE_TYPE_SYSTEM_BEGIN 0xE0
895 #define EFI_HII_PACKAGE_TYPE_SYSTEM_END 0xFF
896
897 /*
898 * HII GUID package
899 */
900 struct efi_hii_guid_package {
901 struct efi_hii_package_header header;
902 efi_guid_t guid;
903 char data[];
904 } __packed;
905
906 /*
907 * HII string package
908 */
909 struct efi_hii_strings_package {
910 struct efi_hii_package_header header;
911 u32 header_size;
912 u32 string_info_offset;
913 u16 language_window[16];
914 efi_string_id_t language_name;
915 u8 language[];
916 } __packed;
917
918 struct efi_hii_string_block {
919 u8 block_type;
920 /* u8 block_body[]; */
921 } __packed;
922
923 #define EFI_HII_SIBT_END 0x00
924 #define EFI_HII_SIBT_STRING_SCSU 0x10
925 #define EFI_HII_SIBT_STRING_SCSU_FONT 0x11
926 #define EFI_HII_SIBT_STRINGS_SCSU 0x12
927 #define EFI_HII_SIBT_STRINGS_SCSU_FONT 0x13
928 #define EFI_HII_SIBT_STRING_UCS2 0x14
929 #define EFI_HII_SIBT_STRING_UCS2_FONT 0x15
930 #define EFI_HII_SIBT_STRINGS_UCS2 0x16
931 #define EFI_HII_SIBT_STRINGS_UCS2_FONT 0x17
932 #define EFI_HII_SIBT_DUPLICATE 0x20
933 #define EFI_HII_SIBT_SKIP2 0x21
934 #define EFI_HII_SIBT_SKIP1 0x22
935 #define EFI_HII_SIBT_EXT1 0x30
936 #define EFI_HII_SIBT_EXT2 0x31
937 #define EFI_HII_SIBT_EXT4 0x32
938 #define EFI_HII_SIBT_FONT 0x40
939
940 struct efi_hii_sibt_string_ucs2_block {
941 struct efi_hii_string_block header;
942 u16 string_text[];
943 } __packed;
944
945 static inline struct efi_hii_string_block *
efi_hii_sibt_string_ucs2_block_next(struct efi_hii_sibt_string_ucs2_block * blk)946 efi_hii_sibt_string_ucs2_block_next(struct efi_hii_sibt_string_ucs2_block *blk)
947 {
948 return ((void *)blk) + sizeof(*blk) +
949 (u16_strlen(blk->string_text) + 1) * 2;
950 }
951
952 /*
953 * HII forms package
954 * TODO: full scope of definitions
955 */
956 struct efi_hii_time {
957 u8 hour;
958 u8 minute;
959 u8 second;
960 };
961
962 struct efi_hii_date {
963 u16 year;
964 u8 month;
965 u8 day;
966 };
967
968 struct efi_hii_ref {
969 efi_question_id_t question_id;
970 efi_form_id_t form_id;
971 efi_guid_t form_set_guid;
972 efi_string_id_t device_path;
973 };
974
975 union efi_ifr_type_value {
976 u8 u8; // EFI_IFR_TYPE_NUM_SIZE_8
977 u16 u16; // EFI_IFR_TYPE_NUM_SIZE_16
978 u32 u32; // EFI_IFR_TYPE_NUM_SIZE_32
979 u64 u64; // EFI_IFR_TYPE_NUM_SIZE_64
980 bool b; // EFI_IFR_TYPE_BOOLEAN
981 struct efi_hii_time time; // EFI_IFR_TYPE_TIME
982 struct efi_hii_date date; // EFI_IFR_TYPE_DATE
983 efi_string_id_t string; // EFI_IFR_TYPE_STRING, EFI_IFR_TYPE_ACTION
984 struct efi_hii_ref ref; // EFI_IFR_TYPE_REF
985 // u8 buffer[]; // EFI_IFR_TYPE_BUFFER
986 };
987
988 #define EFI_IFR_TYPE_NUM_SIZE_8 0x00
989 #define EFI_IFR_TYPE_NUM_SIZE_16 0x01
990 #define EFI_IFR_TYPE_NUM_SIZE_32 0x02
991 #define EFI_IFR_TYPE_NUM_SIZE_64 0x03
992 #define EFI_IFR_TYPE_BOOLEAN 0x04
993 #define EFI_IFR_TYPE_TIME 0x05
994 #define EFI_IFR_TYPE_DATE 0x06
995 #define EFI_IFR_TYPE_STRING 0x07
996 #define EFI_IFR_TYPE_OTHER 0x08
997 #define EFI_IFR_TYPE_UNDEFINED 0x09
998 #define EFI_IFR_TYPE_ACTION 0x0A
999 #define EFI_IFR_TYPE_BUFFER 0x0B
1000 #define EFI_IFR_TYPE_REF 0x0C
1001 #define EFI_IFR_OPTION_DEFAULT 0x10
1002 #define EFI_IFR_OPTION_DEFAULT_MFG 0x20
1003
1004 #define EFI_IFR_ONE_OF_OPTION_OP 0x09
1005
1006 struct efi_ifr_op_header {
1007 u8 opCode;
1008 u8 length:7;
1009 u8 scope:1;
1010 };
1011
1012 struct efi_ifr_one_of_option {
1013 struct efi_ifr_op_header header;
1014 efi_string_id_t option;
1015 u8 flags;
1016 u8 type;
1017 union efi_ifr_type_value value;
1018 };
1019
1020 typedef efi_uintn_t efi_browser_action_t;
1021
1022 #define EFI_BROWSER_ACTION_REQUEST_NONE 0
1023 #define EFI_BROWSER_ACTION_REQUEST_RESET 1
1024 #define EFI_BROWSER_ACTION_REQUEST_SUBMIT 2
1025 #define EFI_BROWSER_ACTION_REQUEST_EXIT 3
1026 #define EFI_BROWSER_ACTION_REQUEST_FORM_SUBMIT_EXIT 4
1027 #define EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD_EXIT 5
1028 #define EFI_BROWSER_ACTION_REQUEST_FORM_APPLY 6
1029 #define EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD 7
1030 #define EFI_BROWSER_ACTION_REQUEST_RECONNECT 8
1031
1032 typedef efi_uintn_t efi_browser_action_request_t;
1033
1034 #define EFI_BROWSER_ACTION_CHANGING 0
1035 #define EFI_BROWSER_ACTION_CHANGED 1
1036 #define EFI_BROWSER_ACTION_RETRIEVE 2
1037 #define EFI_BROWSER_ACTION_FORM_OPEN 3
1038 #define EFI_BROWSER_ACTION_FORM_CLOSE 4
1039 #define EFI_BROWSER_ACTION_SUBMITTED 5
1040 #define EFI_BROWSER_ACTION_DEFAULT_STANDARD 0x1000
1041 #define EFI_BROWSER_ACTION_DEFAULT_MANUFACTURING 0x1001
1042 #define EFI_BROWSER_ACTION_DEFAULT_SAFE 0x1002
1043 #define EFI_BROWSER_ACTION_DEFAULT_PLATFORM 0x2000
1044 #define EFI_BROWSER_ACTION_DEFAULT_HARDWARE 0x3000
1045 #define EFI_BROWSER_ACTION_DEFAULT_FIRMWARE 0x4000
1046
1047 /*
1048 * HII keyboard package
1049 */
1050 typedef enum {
1051 EFI_KEY_LCTRL, EFI_KEY_A0, EFI_KEY_LALT, EFI_KEY_SPACE_BAR,
1052 EFI_KEY_A2, EFI_KEY_A3, EFI_KEY_A4, EFI_KEY_RCTRL, EFI_KEY_LEFT_ARROW,
1053 EFI_KEY_DOWN_ARROW, EFI_KEY_RIGHT_ARROW, EFI_KEY_ZERO,
1054 EFI_KEY_PERIOD, EFI_KEY_ENTER, EFI_KEY_LSHIFT, EFI_KEY_B0,
1055 EFI_KEY_B1, EFI_KEY_B2, EFI_KEY_B3, EFI_KEY_B4, EFI_KEY_B5, EFI_KEY_B6,
1056 EFI_KEY_B7, EFI_KEY_B8, EFI_KEY_B9, EFI_KEY_B10, EFI_KEY_RSHIFT,
1057 EFI_KEY_UP_ARROW, EFI_KEY_ONE, EFI_KEY_TWO, EFI_KEY_THREE,
1058 EFI_KEY_CAPS_LOCK, EFI_KEY_C1, EFI_KEY_C2, EFI_KEY_C3, EFI_KEY_C4,
1059 EFI_KEY_C5, EFI_KEY_C6, EFI_KEY_C7, EFI_KEY_C8, EFI_KEY_C9,
1060 EFI_KEY_C10, EFI_KEY_C11, EFI_KEY_C12, EFI_KEY_FOUR, EFI_KEY_FIVE,
1061 EFI_KEY_SIX, EFI_KEY_PLUS, EFI_KEY_TAB, EFI_KEY_D1, EFI_KEY_D2,
1062 EFI_KEY_D3, EFI_KEY_D4, EFI_KEY_D5, EFI_KEY_D6, EFI_KEY_D7, EFI_KEY_D8,
1063 EFI_KEY_D9, EFI_KEY_D10, EFI_KEY_D11, EFI_KEY_D12, EFI_KEY_D13,
1064 EFI_KEY_DEL, EFI_KEY_END, EFI_KEY_PG_DN, EFI_KEY_SEVEN, EFI_KEY_EIGHT,
1065 EFI_KEY_NINE, EFI_KEY_E0, EFI_KEY_E1, EFI_KEY_E2, EFI_KEY_E3,
1066 EFI_KEY_E4, EFI_KEY_E5, EFI_KEY_E6, EFI_KEY_E7, EFI_KEY_E8, EFI_KEY_E9,
1067 EFI_KEY_E10, EFI_KEY_E11, EFI_KEY_E12, EFI_KEY_BACK_SPACE,
1068 EFI_KEY_INS, EFI_KEY_HOME, EFI_KEY_PG_UP, EFI_KEY_NLCK, EFI_KEY_SLASH,
1069 EFI_KEY_ASTERISK, EFI_KEY_MINUS, EFI_KEY_ESC, EFI_KEY_F1, EFI_KEY_F2,
1070 EFI_KEY_F3, EFI_KEY_F4, EFI_KEY_F5, EFI_KEY_F6, EFI_KEY_F7, EFI_KEY_F8,
1071 EFI_KEY_F9, EFI_KEY_F10, EFI_KEY_F11, EFI_KEY_F12, EFI_KEY_PRINT,
1072 EFI_KEY_SLCK, EFI_KEY_PAUSE,
1073 } efi_key;
1074
1075 struct efi_key_descriptor {
1076 u32 key;
1077 u16 unicode;
1078 u16 shifted_unicode;
1079 u16 alt_gr_unicode;
1080 u16 shifted_alt_gr_unicode;
1081 u16 modifier;
1082 u16 affected_attribute;
1083 } __packed;
1084
1085 struct efi_hii_keyboard_layout {
1086 u16 layout_length;
1087 efi_guid_t guid;
1088 u32 layout_descriptor_string_offset;
1089 u8 descriptor_count;
1090 struct efi_key_descriptor descriptors[];
1091 } __packed;
1092
1093 struct efi_hii_keyboard_package {
1094 struct efi_hii_package_header header;
1095 u16 layout_count;
1096 struct efi_hii_keyboard_layout layout[];
1097 } __packed;
1098
1099 /*
1100 * HII protocols
1101 */
1102 #define EFI_HII_STRING_PROTOCOL_GUID \
1103 EFI_GUID(0x0fd96974, 0x23aa, 0x4cdc, \
1104 0xb9, 0xcb, 0x98, 0xd1, 0x77, 0x50, 0x32, 0x2a)
1105
1106 struct efi_font_info {
1107 efi_hii_font_style_t font_style;
1108 u16 font_size;
1109 u16 font_name[1];
1110 };
1111
1112 struct efi_hii_string_protocol {
1113 efi_status_t(EFIAPI *new_string)(
1114 const struct efi_hii_string_protocol *this,
1115 efi_hii_handle_t package_list,
1116 efi_string_id_t *string_id,
1117 const u8 *language,
1118 const u16 *language_name,
1119 const efi_string_t string,
1120 const struct efi_font_info *string_font_info);
1121 efi_status_t(EFIAPI *get_string)(
1122 const struct efi_hii_string_protocol *this,
1123 const u8 *language,
1124 efi_hii_handle_t package_list,
1125 efi_string_id_t string_id,
1126 efi_string_t string,
1127 efi_uintn_t *string_size,
1128 struct efi_font_info **string_font_info);
1129 efi_status_t(EFIAPI *set_string)(
1130 const struct efi_hii_string_protocol *this,
1131 efi_hii_handle_t package_list,
1132 efi_string_id_t string_id,
1133 const u8 *language,
1134 const efi_string_t string,
1135 const struct efi_font_info *string_font_info);
1136 efi_status_t(EFIAPI *get_languages)(
1137 const struct efi_hii_string_protocol *this,
1138 efi_hii_handle_t package_list,
1139 u8 *languages,
1140 efi_uintn_t *languages_size);
1141 efi_status_t(EFIAPI *get_secondary_languages)(
1142 const struct efi_hii_string_protocol *this,
1143 efi_hii_handle_t package_list,
1144 const u8 *primary_language,
1145 u8 *secondary_languages,
1146 efi_uintn_t *secondary_languages_size);
1147 };
1148
1149 #define EFI_HII_DATABASE_PROTOCOL_GUID \
1150 EFI_GUID(0xef9fc172, 0xa1b2, 0x4693, \
1151 0xb3, 0x27, 0x6d, 0x32, 0xfc, 0x41, 0x60, 0x42)
1152
1153 struct efi_hii_database_protocol {
1154 efi_status_t(EFIAPI *new_package_list)(
1155 const struct efi_hii_database_protocol *this,
1156 const struct efi_hii_package_list_header *package_list,
1157 const efi_handle_t driver_handle,
1158 efi_hii_handle_t *handle);
1159 efi_status_t(EFIAPI *remove_package_list)(
1160 const struct efi_hii_database_protocol *this,
1161 efi_hii_handle_t handle);
1162 efi_status_t(EFIAPI *update_package_list)(
1163 const struct efi_hii_database_protocol *this,
1164 efi_hii_handle_t handle,
1165 const struct efi_hii_package_list_header *package_list);
1166 efi_status_t(EFIAPI *list_package_lists)(
1167 const struct efi_hii_database_protocol *this,
1168 u8 package_type,
1169 const efi_guid_t *package_guid,
1170 efi_uintn_t *handle_buffer_length,
1171 efi_hii_handle_t *handle);
1172 efi_status_t(EFIAPI *export_package_lists)(
1173 const struct efi_hii_database_protocol *this,
1174 efi_hii_handle_t handle,
1175 efi_uintn_t *buffer_size,
1176 struct efi_hii_package_list_header *buffer);
1177 efi_status_t(EFIAPI *register_package_notify)(
1178 const struct efi_hii_database_protocol *this,
1179 u8 package_type,
1180 const efi_guid_t *package_guid,
1181 const void *package_notify_fn,
1182 efi_uintn_t notify_type,
1183 efi_handle_t *notify_handle);
1184 efi_status_t(EFIAPI *unregister_package_notify)(
1185 const struct efi_hii_database_protocol *this,
1186 efi_handle_t notification_handle
1187 );
1188 efi_status_t(EFIAPI *find_keyboard_layouts)(
1189 const struct efi_hii_database_protocol *this,
1190 u16 *key_guid_buffer_length,
1191 efi_guid_t *key_guid_buffer);
1192 efi_status_t(EFIAPI *get_keyboard_layout)(
1193 const struct efi_hii_database_protocol *this,
1194 efi_guid_t *key_guid,
1195 u16 *keyboard_layout_length,
1196 struct efi_hii_keyboard_layout *keyboard_layout);
1197 efi_status_t(EFIAPI *set_keyboard_layout)(
1198 const struct efi_hii_database_protocol *this,
1199 efi_guid_t *key_guid);
1200 efi_status_t(EFIAPI *get_package_list_handle)(
1201 const struct efi_hii_database_protocol *this,
1202 efi_hii_handle_t package_list_handle,
1203 efi_handle_t *driver_handle);
1204 };
1205
1206 #define EFI_HII_CONFIG_ROUTING_PROTOCOL_GUID \
1207 EFI_GUID(0x587e72d7, 0xcc50, 0x4f79, \
1208 0x82, 0x09, 0xca, 0x29, 0x1f, 0xc1, 0xa1, 0x0f)
1209
1210 struct efi_hii_config_routing_protocol {
1211 efi_status_t(EFIAPI *extract_config)(
1212 const struct efi_hii_config_routing_protocol *this,
1213 const efi_string_t request,
1214 efi_string_t *progress,
1215 efi_string_t *results);
1216 efi_status_t(EFIAPI *export_config)(
1217 const struct efi_hii_config_routing_protocol *this,
1218 efi_string_t *results);
1219 efi_status_t(EFIAPI *route_config)(
1220 const struct efi_hii_config_routing_protocol *this,
1221 const efi_string_t configuration,
1222 efi_string_t *progress);
1223 efi_status_t(EFIAPI *block_to_config)(
1224 const struct efi_hii_config_routing_protocol *this,
1225 const efi_string_t config_request,
1226 const uint8_t *block,
1227 const efi_uintn_t block_size,
1228 efi_string_t *config,
1229 efi_string_t *progress);
1230 efi_status_t(EFIAPI *config_to_block)(
1231 const struct efi_hii_config_routing_protocol *this,
1232 const efi_string_t config_resp,
1233 const uint8_t *block,
1234 const efi_uintn_t *block_size,
1235 efi_string_t *progress);
1236 efi_status_t(EFIAPI *get_alt_config)(
1237 const struct efi_hii_config_routing_protocol *this,
1238 const efi_string_t config_resp,
1239 const efi_guid_t *guid,
1240 const efi_string_t name,
1241 const struct efi_device_path *device_path,
1242 const efi_string_t alt_cfg_id,
1243 efi_string_t *alt_cfg_resp);
1244 };
1245
1246 #define EFI_HII_CONFIG_ACCESS_PROTOCOL_GUID \
1247 EFI_GUID(0x330d4706, 0xf2a0, 0x4e4f, \
1248 0xa3, 0x69, 0xb6, 0x6f, 0xa8, 0xd5, 0x43, 0x85)
1249
1250 struct efi_hii_config_access_protocol {
1251 efi_status_t(EFIAPI *extract_config_access)(
1252 const struct efi_hii_config_access_protocol *this,
1253 const efi_string_t request,
1254 efi_string_t *progress,
1255 efi_string_t *results);
1256 efi_status_t(EFIAPI *route_config_access)(
1257 const struct efi_hii_config_access_protocol *this,
1258 const efi_string_t configuration,
1259 efi_string_t *progress);
1260 efi_status_t(EFIAPI *form_callback)(
1261 const struct efi_hii_config_access_protocol *this,
1262 efi_browser_action_t action,
1263 efi_question_id_t question_id,
1264 u8 type,
1265 union efi_ifr_type_value *value,
1266 efi_browser_action_request_t *action_request);
1267 };
1268
1269 #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
1270 EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, \
1271 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
1272
1273 #define EFI_GOT_RGBA8 0
1274 #define EFI_GOT_BGRA8 1
1275 #define EFI_GOT_BITMASK 2
1276
1277 struct efi_gop_mode_info {
1278 u32 version;
1279 u32 width;
1280 u32 height;
1281 u32 pixel_format;
1282 u32 pixel_bitmask[4];
1283 u32 pixels_per_scanline;
1284 };
1285
1286 struct efi_gop_mode {
1287 u32 max_mode;
1288 u32 mode;
1289 struct efi_gop_mode_info *info;
1290 unsigned long info_size;
1291 efi_physical_addr_t fb_base;
1292 unsigned long fb_size;
1293 };
1294
1295 struct efi_gop_pixel {
1296 u8 blue;
1297 u8 green;
1298 u8 red;
1299 u8 reserved;
1300 };
1301
1302 #define EFI_BLT_VIDEO_FILL 0
1303 #define EFI_BLT_VIDEO_TO_BLT_BUFFER 1
1304 #define EFI_BLT_BUFFER_TO_VIDEO 2
1305 #define EFI_BLT_VIDEO_TO_VIDEO 3
1306
1307 struct efi_gop {
1308 efi_status_t (EFIAPI *query_mode)(struct efi_gop *this, u32 mode_number,
1309 efi_uintn_t *size_of_info,
1310 struct efi_gop_mode_info **info);
1311 efi_status_t (EFIAPI *set_mode)(struct efi_gop *this, u32 mode_number);
1312 efi_status_t (EFIAPI *blt)(struct efi_gop *this,
1313 struct efi_gop_pixel *buffer,
1314 u32 operation, efi_uintn_t sx,
1315 efi_uintn_t sy, efi_uintn_t dx,
1316 efi_uintn_t dy, efi_uintn_t width,
1317 efi_uintn_t height, efi_uintn_t delta);
1318 struct efi_gop_mode *mode;
1319 };
1320
1321 #define EFI_SIMPLE_NETWORK_PROTOCOL_GUID \
1322 EFI_GUID(0xa19832b9, 0xac25, 0x11d3, \
1323 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
1324
1325 struct efi_mac_address {
1326 char mac_addr[32];
1327 };
1328
1329 struct efi_ip_address {
1330 u8 ip_addr[16];
1331 } __attribute__((aligned(4)));
1332
1333 enum efi_simple_network_state {
1334 EFI_NETWORK_STOPPED,
1335 EFI_NETWORK_STARTED,
1336 EFI_NETWORK_INITIALIZED,
1337 };
1338
1339 struct efi_simple_network_mode {
1340 enum efi_simple_network_state state;
1341 u32 hwaddr_size;
1342 u32 media_header_size;
1343 u32 max_packet_size;
1344 u32 nvram_size;
1345 u32 nvram_access_size;
1346 u32 receive_filter_mask;
1347 u32 receive_filter_setting;
1348 u32 max_mcast_filter_count;
1349 u32 mcast_filter_count;
1350 struct efi_mac_address mcast_filter[16];
1351 struct efi_mac_address current_address;
1352 struct efi_mac_address broadcast_address;
1353 struct efi_mac_address permanent_address;
1354 u8 if_type;
1355 u8 mac_changeable;
1356 u8 multitx_supported;
1357 u8 media_present_supported;
1358 u8 media_present;
1359 };
1360
1361 /* receive_filters bit mask */
1362 #define EFI_SIMPLE_NETWORK_RECEIVE_UNICAST 0x01
1363 #define EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST 0x02
1364 #define EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST 0x04
1365 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS 0x08
1366 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST 0x10
1367
1368 /* interrupt status bit mask */
1369 #define EFI_SIMPLE_NETWORK_RECEIVE_INTERRUPT 0x01
1370 #define EFI_SIMPLE_NETWORK_TRANSMIT_INTERRUPT 0x02
1371 #define EFI_SIMPLE_NETWORK_COMMAND_INTERRUPT 0x04
1372 #define EFI_SIMPLE_NETWORK_SOFTWARE_INTERRUPT 0x08
1373
1374 /* revision of the simple network protocol */
1375 #define EFI_SIMPLE_NETWORK_PROTOCOL_REVISION 0x00010000
1376
1377 struct efi_simple_network {
1378 u64 revision;
1379 efi_status_t (EFIAPI *start)(struct efi_simple_network *this);
1380 efi_status_t (EFIAPI *stop)(struct efi_simple_network *this);
1381 efi_status_t (EFIAPI *initialize)(struct efi_simple_network *this,
1382 ulong extra_rx, ulong extra_tx);
1383 efi_status_t (EFIAPI *reset)(struct efi_simple_network *this,
1384 int extended_verification);
1385 efi_status_t (EFIAPI *shutdown)(struct efi_simple_network *this);
1386 efi_status_t (EFIAPI *receive_filters)(struct efi_simple_network *this,
1387 u32 enable, u32 disable, int reset_mcast_filter,
1388 ulong mcast_filter_count,
1389 struct efi_mac_address *mcast_filter);
1390 efi_status_t (EFIAPI *station_address)(struct efi_simple_network *this,
1391 int reset, struct efi_mac_address *new_mac);
1392 efi_status_t (EFIAPI *statistics)(struct efi_simple_network *this,
1393 int reset, ulong *stat_size, void *stat_table);
1394 efi_status_t (EFIAPI *mcastiptomac)(struct efi_simple_network *this,
1395 int ipv6, struct efi_ip_address *ip,
1396 struct efi_mac_address *mac);
1397 efi_status_t (EFIAPI *nvdata)(struct efi_simple_network *this,
1398 int read_write, ulong offset, ulong buffer_size,
1399 char *buffer);
1400 efi_status_t (EFIAPI *get_status)(struct efi_simple_network *this,
1401 u32 *int_status, void **txbuf);
1402 efi_status_t (EFIAPI *transmit)(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 efi_status_t (EFIAPI *receive)(struct efi_simple_network *this,
1407 size_t *header_size, size_t *buffer_size, void *buffer,
1408 struct efi_mac_address *src_addr,
1409 struct efi_mac_address *dest_addr, u16 *protocol);
1410 struct efi_event *wait_for_packet;
1411 struct efi_simple_network_mode *mode;
1412 /* private fields */
1413 u32 int_status;
1414 };
1415
1416 #define EFI_PXE_BASE_CODE_PROTOCOL_GUID \
1417 EFI_GUID(0x03c4e603, 0xac28, 0x11d3, \
1418 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
1419
1420 #define EFI_PXE_BASE_CODE_PROTOCOL_REVISION 0x00010000
1421 #define EFI_PXE_BASE_CODE_MAX_IPCNT 8
1422
1423 struct efi_pxe_packet {
1424 u8 packet[1472];
1425 };
1426
1427 struct efi_pxe_mode {
1428 u8 started;
1429 u8 ipv6_available;
1430 u8 ipv6_supported;
1431 u8 using_ipv6;
1432 u8 bis_supported;
1433 u8 bis_detected;
1434 u8 auto_arp;
1435 u8 send_guid;
1436 u8 dhcp_discover_valid;
1437 u8 dhcp_ack_received;
1438 u8 proxy_offer_received;
1439 u8 pxe_discover_valid;
1440 u8 pxe_reply_received;
1441 u8 pxe_bis_reply_received;
1442 u8 icmp_error_received;
1443 u8 tftp_error_received;
1444 u8 make_callbacks;
1445 u8 ttl;
1446 u8 tos;
1447 u8 pad;
1448 struct efi_ip_address station_ip;
1449 struct efi_ip_address subnet_mask;
1450 struct efi_pxe_packet dhcp_discover;
1451 struct efi_pxe_packet dhcp_ack;
1452 struct efi_pxe_packet proxy_offer;
1453 struct efi_pxe_packet pxe_discover;
1454 struct efi_pxe_packet pxe_reply;
1455 };
1456
1457 struct efi_pxe_base_code_srvlist {
1458 u16 type;
1459 u8 accept_any_response;
1460 u8 reserved;
1461 struct efi_ip_address ip_addr;
1462 };
1463
1464 struct efi_pxe_base_code_discover_info {
1465 u8 use_m_cast;
1466 u8 use_b_cast;
1467 u8 use_u_cast;
1468 u8 must_use_list;
1469 struct efi_ip_address server_m_cast_ip;
1470 u16 ip_cnt;
1471 struct efi_pxe_base_code_srvlist srv_list[];
1472 };
1473
1474 struct efi_pxe_base_code_mtftp_info {
1475 struct efi_ip_address m_cast_ip;
1476 u16 cport;
1477 u16 sport;
1478 u16 listen_timeout;
1479 u16 transit_timeout;
1480 };
1481
1482 struct efi_pxe_base_code_filter {
1483 u8 filters;
1484 u8 ip_cnt;
1485 u16 reserved;
1486 struct efi_ip_address ip_list[EFI_PXE_BASE_CODE_MAX_IPCNT];
1487 };
1488
1489 struct efi_pxe_base_code_dhcpv4_packet {
1490 u8 bootp_op_code;
1491 u8 bootp_hw_type;
1492 u8 bootp_addr_len;
1493 u8 bootp_gate_hops;
1494 u32 bootp_ident;
1495 u16 bootp_seconds;
1496 u16 bootp_flags;
1497 u8 bootp_ci_addr[4];
1498 u8 bootp_yi_addr[4];
1499 u8 bootp_si_addr[4];
1500 u8 bootp_gi_addr[4];
1501 u8 bootp_hw_addr[16];
1502 u8 bootp_srv_name[64];
1503 u8 bootp_boot_file[128];
1504 u32 dhcp_magick;
1505 u8 dhcp_options[56];
1506 };
1507
1508 struct efi_pxe_base_code_dhcpv6_packet {
1509 u8 message_type;
1510 u8 transaction_id[3];
1511 u8 dhcp_options[1024];
1512 };
1513
1514 typedef union {
1515 u8 raw[1472];
1516 struct efi_pxe_base_code_dhcpv4_packet dhcpv4;
1517 struct efi_pxe_base_code_dhcpv6_packet dhcpv6;
1518 } EFI_PXE_BASE_CODE_PACKET;
1519
1520 struct efi_pxe_base_code_protocol {
1521 u64 revision;
1522 efi_status_t (EFIAPI *start)(struct efi_pxe_base_code_protocol *this,
1523 u8 use_ipv6);
1524 efi_status_t (EFIAPI *stop)(struct efi_pxe_base_code_protocol *this);
1525 efi_status_t (EFIAPI *dhcp)(struct efi_pxe_base_code_protocol *this,
1526 u8 sort_offers);
1527 efi_status_t (EFIAPI *discover)(
1528 struct efi_pxe_base_code_protocol *this,
1529 u16 type, u16 *layer, u8 bis,
1530 struct efi_pxe_base_code_discover_info *info);
1531 efi_status_t (EFIAPI *mtftp)(
1532 struct efi_pxe_base_code_protocol *this,
1533 u32 operation, void *buffer_ptr,
1534 u8 overwrite, efi_uintn_t *buffer_size,
1535 struct efi_ip_address server_ip, char *filename,
1536 struct efi_pxe_base_code_mtftp_info *info,
1537 u8 dont_use_buffer);
1538 efi_status_t (EFIAPI *udp_write)(
1539 struct efi_pxe_base_code_protocol *this,
1540 u16 op_flags, struct efi_ip_address *dest_ip,
1541 u16 *dest_port,
1542 struct efi_ip_address *gateway_ip,
1543 struct efi_ip_address *src_ip, u16 *src_port,
1544 efi_uintn_t *header_size, void *header_ptr,
1545 efi_uintn_t *buffer_size, void *buffer_ptr);
1546 efi_status_t (EFIAPI *udp_read)(
1547 struct efi_pxe_base_code_protocol *this,
1548 u16 op_flags, struct efi_ip_address *dest_ip,
1549 u16 *dest_port, struct efi_ip_address *src_ip,
1550 u16 *src_port, efi_uintn_t *header_size,
1551 void *header_ptr, efi_uintn_t *buffer_size,
1552 void *buffer_ptr);
1553 efi_status_t (EFIAPI *set_ip_filter)(
1554 struct efi_pxe_base_code_protocol *this,
1555 struct efi_pxe_base_code_filter *new_filter);
1556 efi_status_t (EFIAPI *arp)(struct efi_pxe_base_code_protocol *this,
1557 struct efi_ip_address *ip_addr,
1558 struct efi_mac_address *mac_addr);
1559 efi_status_t (EFIAPI *set_parameters)(
1560 struct efi_pxe_base_code_protocol *this,
1561 u8 *new_auto_arp, u8 *new_send_guid,
1562 u8 *new_ttl, u8 *new_tos,
1563 u8 *new_make_callback);
1564 efi_status_t (EFIAPI *set_station_ip)(
1565 struct efi_pxe_base_code_protocol *this,
1566 struct efi_ip_address *new_station_ip,
1567 struct efi_ip_address *new_subnet_mask);
1568 efi_status_t (EFIAPI *set_packets)(
1569 struct efi_pxe_base_code_protocol *this,
1570 u8 *new_dhcp_discover_valid,
1571 u8 *new_dhcp_ack_received,
1572 u8 *new_proxy_offer_received,
1573 u8 *new_pxe_discover_valid,
1574 u8 *new_pxe_reply_received,
1575 u8 *new_pxe_bis_reply_received,
1576 EFI_PXE_BASE_CODE_PACKET *new_dchp_discover,
1577 EFI_PXE_BASE_CODE_PACKET *new_dhcp_acc,
1578 EFI_PXE_BASE_CODE_PACKET *new_proxy_offer,
1579 EFI_PXE_BASE_CODE_PACKET *new_pxe_discover,
1580 EFI_PXE_BASE_CODE_PACKET *new_pxe_reply,
1581 EFI_PXE_BASE_CODE_PACKET *new_pxe_bis_reply);
1582 struct efi_pxe_mode *mode;
1583 };
1584
1585 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID \
1586 EFI_GUID(0x964e5b22, 0x6459, 0x11d2, \
1587 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
1588 #define EFI_FILE_PROTOCOL_REVISION 0x00010000
1589 #define EFI_FILE_PROTOCOL_REVISION2 0x00020000
1590 #define EFI_FILE_PROTOCOL_LATEST_REVISION EFI_FILE_PROTOCOL_REVISION2
1591
1592 struct efi_file_io_token {
1593 struct efi_event *event;
1594 efi_status_t status;
1595 efi_uintn_t buffer_size;
1596 void *buffer;};
1597
1598 struct efi_file_handle {
1599 u64 rev;
1600 efi_status_t (EFIAPI *open)(struct efi_file_handle *this,
1601 struct efi_file_handle **new_handle,
1602 u16 *file_name, u64 open_mode, u64 attributes);
1603 efi_status_t (EFIAPI *close)(struct efi_file_handle *this);
1604 efi_status_t (EFIAPI *delete)(struct efi_file_handle *this);
1605 efi_status_t (EFIAPI *read)(struct efi_file_handle *this,
1606 efi_uintn_t *buffer_size, void *buffer);
1607 efi_status_t (EFIAPI *write)(struct efi_file_handle *this,
1608 efi_uintn_t *buffer_size, void *buffer);
1609 efi_status_t (EFIAPI *getpos)(struct efi_file_handle *this,
1610 u64 *pos);
1611 efi_status_t (EFIAPI *setpos)(struct efi_file_handle *this,
1612 u64 pos);
1613 efi_status_t (EFIAPI *getinfo)(struct efi_file_handle *this,
1614 const efi_guid_t *info_type, efi_uintn_t *buffer_size,
1615 void *buffer);
1616 efi_status_t (EFIAPI *setinfo)(struct efi_file_handle *this,
1617 const efi_guid_t *info_type, efi_uintn_t buffer_size,
1618 void *buffer);
1619 efi_status_t (EFIAPI *flush)(struct efi_file_handle *this);
1620 efi_status_t (EFIAPI *open_ex)(struct efi_file_handle *this,
1621 struct efi_file_handle **new_handle,
1622 u16 *file_name, u64 open_mode, u64 attributes,
1623 struct efi_file_io_token *token);
1624 efi_status_t (EFIAPI *read_ex)(struct efi_file_handle *this,
1625 struct efi_file_io_token *token);
1626 efi_status_t (EFIAPI *write_ex)(struct efi_file_handle *this,
1627 struct efi_file_io_token *token);
1628 efi_status_t (EFIAPI *flush_ex)(struct efi_file_handle *this,
1629 struct efi_file_io_token *token);
1630 };
1631
1632 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION 0x00010000
1633
1634 struct efi_simple_file_system_protocol {
1635 u64 rev;
1636 efi_status_t (EFIAPI *open_volume)(struct efi_simple_file_system_protocol *this,
1637 struct efi_file_handle **root);
1638 };
1639
1640 #define EFI_FILE_INFO_GUID \
1641 EFI_GUID(0x9576e92, 0x6d3f, 0x11d2, \
1642 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
1643
1644 #define EFI_FILE_SYSTEM_INFO_GUID \
1645 EFI_GUID(0x09576e93, 0x6d3f, 0x11d2, \
1646 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
1647
1648 #define EFI_FILE_SYSTEM_VOLUME_LABEL_ID \
1649 EFI_GUID(0xdb47d7d3, 0xfe81, 0x11d3, \
1650 0x9a, 0x35, 0x00, 0x90, 0x27, 0x3f, 0xC1, 0x4d)
1651
1652 #define EFI_FILE_MODE_READ 0x0000000000000001
1653 #define EFI_FILE_MODE_WRITE 0x0000000000000002
1654 #define EFI_FILE_MODE_CREATE 0x8000000000000000
1655
1656 #define EFI_FILE_READ_ONLY 0x0000000000000001
1657 #define EFI_FILE_HIDDEN 0x0000000000000002
1658 #define EFI_FILE_SYSTEM 0x0000000000000004
1659 #define EFI_FILE_RESERVED 0x0000000000000008
1660 #define EFI_FILE_DIRECTORY 0x0000000000000010
1661 #define EFI_FILE_ARCHIVE 0x0000000000000020
1662 #define EFI_FILE_VALID_ATTR 0x0000000000000037
1663
1664 struct efi_file_info {
1665 u64 size;
1666 u64 file_size;
1667 u64 physical_size;
1668 struct efi_time create_time;
1669 struct efi_time last_access_time;
1670 struct efi_time modification_time;
1671 u64 attribute;
1672 u16 file_name[0];
1673 };
1674
1675 struct efi_file_system_info {
1676 u64 size;
1677 u8 read_only;
1678 u64 volume_size;
1679 u64 free_space;
1680 u32 block_size;
1681 u16 volume_label[0];
1682 };
1683
1684 #define EFI_DRIVER_BINDING_PROTOCOL_GUID \
1685 EFI_GUID(0x18a031ab, 0xb443, 0x4d1a,\
1686 0xa5, 0xc0, 0x0c, 0x09, 0x26, 0x1e, 0x9f, 0x71)
1687 struct efi_driver_binding_protocol {
1688 efi_status_t (EFIAPI * supported)(
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 * start)(
1693 struct efi_driver_binding_protocol *this,
1694 efi_handle_t controller_handle,
1695 struct efi_device_path *remaining_device_path);
1696 efi_status_t (EFIAPI * stop)(
1697 struct efi_driver_binding_protocol *this,
1698 efi_handle_t controller_handle,
1699 efi_uintn_t number_of_children,
1700 efi_handle_t *child_handle_buffer);
1701 u32 version;
1702 efi_handle_t image_handle;
1703 efi_handle_t driver_binding_handle;
1704 };
1705
1706 /* Current version of the Unicode collation protocol */
1707 #define EFI_UNICODE_COLLATION_PROTOCOL2_GUID \
1708 EFI_GUID(0xa4c751fc, 0x23ae, 0x4c3e, \
1709 0x92, 0xe9, 0x49, 0x64, 0xcf, 0x63, 0xf3, 0x49)
1710 struct efi_unicode_collation_protocol {
1711 efi_intn_t (EFIAPI *stri_coll)(
1712 struct efi_unicode_collation_protocol *this, u16 *s1, u16 *s2);
1713 bool (EFIAPI *metai_match)(struct efi_unicode_collation_protocol *this,
1714 const u16 *string, const u16 *patter);
1715 void (EFIAPI *str_lwr)(struct efi_unicode_collation_protocol
1716 *this, u16 *string);
1717 void (EFIAPI *str_upr)(struct efi_unicode_collation_protocol *this,
1718 u16 *string);
1719 void (EFIAPI *fat_to_str)(struct efi_unicode_collation_protocol *this,
1720 efi_uintn_t fat_size, char *fat, u16 *string);
1721 bool (EFIAPI *str_to_fat)(struct efi_unicode_collation_protocol *this,
1722 const u16 *string, efi_uintn_t fat_size,
1723 char *fat);
1724 char *supported_languages;
1725 };
1726
1727 struct efi_load_file_protocol {
1728 efi_status_t (EFIAPI *load_file)(struct efi_load_file_protocol *this,
1729 struct efi_device_path *file_path,
1730 bool boot_policy,
1731 efi_uintn_t *buffer_size,
1732 void *buffer);
1733 };
1734
1735 struct efi_system_resource_entry {
1736 efi_guid_t fw_class;
1737 u32 fw_type;
1738 u32 fw_version;
1739 u32 lowest_supported_fw_version;
1740 u32 capsule_flags;
1741 u32 last_attempt_version;
1742 u32 last_attempt_status;
1743 } __packed;
1744
1745 struct efi_system_resource_table {
1746 u32 fw_resource_count;
1747 u32 fw_resource_count_max;
1748 u64 fw_resource_version;
1749 struct efi_system_resource_entry entries[];
1750 } __packed;
1751
1752 /* Boot manager load options */
1753 #define LOAD_OPTION_ACTIVE 0x00000001
1754 #define LOAD_OPTION_FORCE_RECONNECT 0x00000002
1755 #define LOAD_OPTION_HIDDEN 0x00000008
1756 /* All values 0x00000200-0x00001F00 are reserved */
1757 #define LOAD_OPTION_CATEGORY 0x00001F00
1758 #define LOAD_OPTION_CATEGORY_BOOT 0x00000000
1759 #define LOAD_OPTION_CATEGORY_APP 0x00000100
1760
1761 /*
1762 * System Resource Table
1763 */
1764 /* Firmware Type Definitions */
1765 #define ESRT_FW_TYPE_UNKNOWN 0x00000000
1766 #define ESRT_FW_TYPE_SYSTEMFIRMWARE 0x00000001
1767 #define ESRT_FW_TYPE_DEVICEFIRMWARE 0x00000002
1768 #define ESRT_FW_TYPE_UEFIDRIVER 0x00000003
1769
1770 #define EFI_SYSTEM_RESOURCE_TABLE_GUID\
1771 EFI_GUID(0xb122a263, 0x3661, 0x4f68,\
1772 0x99, 0x29, 0x78, 0xf8, 0xb0, 0xd6, 0x21, 0x80)
1773
1774 /* Last Attempt Status Values */
1775 #define LAST_ATTEMPT_STATUS_SUCCESS 0x00000000
1776 #define LAST_ATTEMPT_STATUS_ERROR_UNSUCCESSFUL 0x00000001
1777 #define LAST_ATTEMPT_STATUS_ERROR_INSUFFICIENT_RESOURCES 0x00000002
1778 #define LAST_ATTEMPT_STATUS_ERROR_INCORRECT_VERSION 0x00000003
1779 #define LAST_ATTEMPT_STATUS_ERROR_INVALID_FORMAT 0x00000004
1780 #define LAST_ATTEMPT_STATUS_ERROR_AUTH_ERROR 0x00000005
1781 #define LAST_ATTEMPT_STATUS_ERROR_PWR_EVT_AC 0x00000006
1782 #define LAST_ATTEMPT_STATUS_ERROR_PWR_EVT_BATT 0x00000007
1783 #define LAST_ATTEMPT_STATUS_ERROR_UNSATISFIED_DEPENDENCIES 0x00000008
1784
1785 /*
1786 * The LastAttemptStatus values of 0x1000 - 0x4000 are reserved for vendor
1787 * usage.
1788 */
1789 #define LAST_ATTEMPT_STATUS_ERROR_UNSUCCESSFUL_VENDOR_RANGE_MIN 0x00001000
1790 #define LAST_ATTEMPT_STATUS_ERROR_UNSUCCESSFUL_VENDOR_RANGE_MAX 0x00004000
1791
1792 /* Certificate types in signature database */
1793 #define EFI_CERT_SHA256_GUID \
1794 EFI_GUID(0xc1c41626, 0x504c, 0x4092, 0xac, 0xa9, \
1795 0x41, 0xf9, 0x36, 0x93, 0x43, 0x28)
1796 #define EFI_CERT_RSA2048_GUID \
1797 EFI_GUID(0x3c5766e8, 0x269c, 0x4e34, 0xaa, 0x14, \
1798 0xed, 0x77, 0x6e, 0x85, 0xb3, 0xb6)
1799 #define EFI_CERT_X509_GUID \
1800 EFI_GUID(0xa5c059a1, 0x94e4, 0x4aa7, 0x87, 0xb5, \
1801 0xab, 0x15, 0x5c, 0x2b, 0xf0, 0x72)
1802 #define EFI_CERT_X509_SHA256_GUID \
1803 EFI_GUID(0x3bd2a492, 0x96c0, 0x4079, 0xb4, 0x20, \
1804 0xfc, 0xf9, 0x8e, 0xf1, 0x03, 0xed)
1805 #define EFI_CERT_TYPE_PKCS7_GUID \
1806 EFI_GUID(0x4aafd29d, 0x68df, 0x49ee, 0x8a, 0xa9, \
1807 0x34, 0x7d, 0x37, 0x56, 0x65, 0xa7)
1808
1809 /**
1810 * win_certificate_uefi_guid - A certificate that encapsulates
1811 * a GUID-specific signature
1812 *
1813 * @hdr: Windows certificate header
1814 * @cert_type: Certificate type
1815 * @cert_data: Certificate data
1816 */
1817 struct win_certificate_uefi_guid {
1818 WIN_CERTIFICATE hdr;
1819 efi_guid_t cert_type;
1820 u8 cert_data[];
1821 } __attribute__((__packed__));
1822
1823 /**
1824 * efi_variable_authentication_2 - A time-based authentication method
1825 * descriptor
1826 *
1827 * This structure describes an authentication information for
1828 * a variable with EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
1829 * and should be included as part of a variable's value.
1830 * Only EFI_CERT_TYPE_PKCS7_GUID is accepted.
1831 *
1832 * @time_stamp: Descriptor's time stamp
1833 * @auth_info: Authentication info
1834 */
1835 struct efi_variable_authentication_2 {
1836 struct efi_time time_stamp;
1837 struct win_certificate_uefi_guid auth_info;
1838 } __attribute__((__packed__));
1839
1840 /**
1841 * efi_firmware_image_authentication - Capsule authentication method
1842 * descriptor
1843 *
1844 * This structure describes an authentication information for
1845 * a capsule with IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED set
1846 * and should be included as part of the capsule.
1847 * Only EFI_CERT_TYPE_PKCS7_GUID is accepted.
1848 *
1849 * @monotonic_count: Count to prevent replay
1850 * @auth_info: Authentication info
1851 */
1852 struct efi_firmware_image_authentication {
1853 uint64_t monotonic_count;
1854 struct win_certificate_uefi_guid auth_info;
1855 } __attribute__((__packed__));
1856
1857
1858 /**
1859 * efi_signature_data - A format of signature
1860 *
1861 * This structure describes a single signature in signature database.
1862 *
1863 * @signature_owner: Signature owner
1864 * @signature_data: Signature data
1865 */
1866 struct efi_signature_data {
1867 efi_guid_t signature_owner;
1868 u8 signature_data[];
1869 } __attribute__((__packed__));
1870
1871 /**
1872 * efi_signature_list - A format of signature database
1873 *
1874 * This structure describes a list of signatures with the same type.
1875 * An authenticated variable's value is a concatenation of one or more
1876 * efi_signature_list's.
1877 *
1878 * @signature_type: Signature type
1879 * @signature_list_size: Size of signature list
1880 * @signature_header_size: Size of signature header
1881 * @signature_size: Size of signature
1882 */
1883 struct efi_signature_list {
1884 efi_guid_t signature_type;
1885 u32 signature_list_size;
1886 u32 signature_header_size;
1887 u32 signature_size;
1888 /* u8 signature_header[signature_header_size]; */
1889 /* struct efi_signature_data signatures[...][signature_size]; */
1890 } __attribute__((__packed__));
1891
1892 /*
1893 * Firmware management protocol
1894 */
1895 #define EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GUID \
1896 EFI_GUID(0x86c77a67, 0x0b97, 0x4633, 0xa1, 0x87, \
1897 0x49, 0x10, 0x4d, 0x06, 0x85, 0xc7)
1898
1899 #define EFI_FIRMWARE_IMAGE_TYPE_UBOOT_FIT_GUID \
1900 EFI_GUID(0xae13ff2d, 0x9ad4, 0x4e25, 0x9a, 0xc8, \
1901 0x6d, 0x80, 0xb3, 0xb2, 0x21, 0x47)
1902
1903 #define EFI_FIRMWARE_IMAGE_TYPE_UBOOT_RAW_GUID \
1904 EFI_GUID(0xe2bb9c06, 0x70e9, 0x4b14, 0x97, 0xa3, \
1905 0x5a, 0x79, 0x13, 0x17, 0x6e, 0x3f)
1906
1907 #define IMAGE_ATTRIBUTE_IMAGE_UPDATABLE 0x0000000000000001
1908 #define IMAGE_ATTRIBUTE_RESET_REQUIRED 0x0000000000000002
1909 #define IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED 0x0000000000000004
1910 #define IMAGE_ATTRIBUTE_IN_USE 0x0000000000000008
1911 #define IMAGE_ATTRIBUTE_UEFI_IMAGE 0x0000000000000010
1912 #define IMAGE_ATTRIBUTE_DEPENDENCY 0x0000000000000020
1913
1914 #define IMAGE_COMPATIBILITY_CHECK_SUPPORTED 0x0000000000000001
1915
1916 #define IMAGE_UPDATABLE_VALID 0x0000000000000001
1917 #define IMAGE_UPDATABLE_INVALID 0x0000000000000002
1918 #define IMAGE_UPDATABLE_INVALID_TYPE 0x0000000000000004
1919 #define IMAGE_UPDATABLE_INVALID_OLLD 0x0000000000000008
1920 #define IMAGE_UPDATABLE_VALID_WITH_VENDOR_CODE 0x0000000000000010
1921
1922 #define PACKAGE_ATTRIBUTE_VERSION_UPDATABLE 0x0000000000000001
1923 #define PACKAGE_ATTRIBUTE_RESET_REQUIRED 0x0000000000000002
1924 #define PACKAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED 0x0000000000000004
1925
1926 #define EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION 4
1927
1928 typedef struct efi_firmware_image_dependencies {
1929 u8 dependencies[0];
1930 } efi_firmware_image_dep_t;
1931
1932 struct efi_firmware_image_descriptor {
1933 u8 image_index;
1934 efi_guid_t image_type_id;
1935 u64 image_id;
1936 u16 *image_id_name;
1937 u32 version;
1938 u16 *version_name;
1939 efi_uintn_t size;
1940 u64 attributes_supported;
1941 u64 attributes_setting;
1942 u64 compatibilities;
1943 u32 lowest_supported_image_version;
1944 u32 last_attempt_version;
1945 u32 last_attempt_status;
1946 u64 hardware_instance;
1947 efi_firmware_image_dep_t *dependencies;
1948 };
1949
1950 struct efi_firmware_management_protocol {
1951 efi_status_t (EFIAPI *get_image_info)(
1952 struct efi_firmware_management_protocol *this,
1953 efi_uintn_t *image_info_size,
1954 struct efi_firmware_image_descriptor *image_info,
1955 u32 *descriptor_version,
1956 u8 *descriptor_count,
1957 efi_uintn_t *descriptor_size,
1958 u32 *package_version,
1959 u16 **package_version_name);
1960 efi_status_t (EFIAPI *get_image)(
1961 struct efi_firmware_management_protocol *this,
1962 u8 image_index,
1963 void *image,
1964 efi_uintn_t *image_size);
1965 efi_status_t (EFIAPI *set_image)(
1966 struct efi_firmware_management_protocol *this,
1967 u8 image_index,
1968 const void *image,
1969 efi_uintn_t image_size,
1970 const void *vendor_code,
1971 efi_status_t (*progress)(efi_uintn_t completion),
1972 u16 **abort_reason);
1973 efi_status_t (EFIAPI *check_image)(
1974 struct efi_firmware_management_protocol *this,
1975 u8 image_index,
1976 const void *image,
1977 efi_uintn_t *image_size,
1978 u32 *image_updatable);
1979 efi_status_t (EFIAPI *get_package_info)(
1980 struct efi_firmware_management_protocol *this,
1981 u32 *package_version,
1982 u16 **package_version_name,
1983 u32 *package_version_name_maxlen,
1984 u64 *attributes_supported,
1985 u64 *attributes_setting);
1986 efi_status_t (EFIAPI *set_package_info)(
1987 struct efi_firmware_management_protocol *this,
1988 const void *image,
1989 efi_uintn_t *image_size,
1990 const void *vendor_code,
1991 u32 package_version,
1992 const u16 *package_version_name);
1993 };
1994
1995 #endif
1996