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