]> 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
efi_loader: make get_load_options() static
[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
dec88e41 516#define EFI_LOADED_IMAGE_PROTOCOL_GUID \
2bb9b79d
AG		 517 EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, \
518 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
519
dec88e41 520#define EFI_LOADED_IMAGE_DEVICE_PATH_PROTOCOL_GUID \
bc8fc328
AT		 521 EFI_GUID(0xbc62157e, 0x3e33, 0x4fec, \
522 0x99, 0x20, 0x2d, 0x3b, 0x36, 0xd7, 0x50, 0xdf)
523
95147313
HS		 524#define EFI_LOADED_IMAGE_PROTOCOL_REVISION 0x1000
525
867a6ac8
SG		 526struct efi_loaded_image {
527 u32 revision;
528 void *parent_handle;
529 struct efi_system_table *system_table;
43dace5d
HS		 530 efi_handle_t device_handle;
531 struct efi_device_path *file_path;
867a6ac8
SG		 532 void *reserved;
533 u32 load_options_size;
534 void *load_options;
535 void *image_base;
536 aligned_u64 image_size;
537 unsigned int image_code_type;
538 unsigned int image_data_type;
df116e81 539 efi_status_t (EFIAPI *unload)(efi_handle_t image_handle);
867a6ac8
SG		 540};
541
dec88e41 542#define EFI_DEVICE_PATH_PROTOCOL_GUID \
2bb9b79d 543 EFI_GUID(0x09576e91, 0x6d3f, 0x11d2, \
2e0d79a0 544 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
2bb9b79d
AG		 545
546#define DEVICE_PATH_TYPE_END 0x7f
3acef5da 547# define DEVICE_PATH_SUB_TYPE_INSTANCE_END 0x01
2bb9b79d
AG		 548# define DEVICE_PATH_SUB_TYPE_END 0xff
549
867a6ac8
SG		 550struct efi_device_path {
551 u8 type;
552 u8 sub_type;
553 u16 length;
a8606ef0 554} __packed;
867a6ac8 555
d7608aba
OT		 556struct efi_mac_addr {
557 u8 addr[32];
a8606ef0 558} __packed;
d7608aba 559
c80214ce 560#define DEVICE_PATH_TYPE_HARDWARE_DEVICE 0x01
bf19273e 561# define DEVICE_PATH_SUB_TYPE_MEMORY 0x03
c80214ce
PJ		 562# define DEVICE_PATH_SUB_TYPE_VENDOR 0x04
563
bf19273e
RC		 564struct efi_device_path_memory {
565 struct efi_device_path dp;
566 u32 memory_type;
567 u64 start_address;
568 u64 end_address;
569} __packed;
570
c80214ce
PJ		 571struct efi_device_path_vendor {
572 struct efi_device_path dp;
573 efi_guid_t guid;
574 u8 vendor_data[];
575} __packed;
576
577#define DEVICE_PATH_TYPE_ACPI_DEVICE 0x02
578# define DEVICE_PATH_SUB_TYPE_ACPI_DEVICE 0x01
579
580#define EFI_PNP_ID(ID) (u32)(((ID) << 16) | 0x41D0)
581#define EISA_PNP_ID(ID) EFI_PNP_ID(ID)
adae4313 582#define EISA_PNP_NUM(ID) ((ID) >> 16)
c80214ce
PJ		 583
584struct efi_device_path_acpi_path {
585 struct efi_device_path dp;
586 u32 hid;
587 u32 uid;
588} __packed;
589
d7608aba 590#define DEVICE_PATH_TYPE_MESSAGING_DEVICE 0x03
af3106a1
HS		 591# define DEVICE_PATH_SUB_TYPE_MSG_ATAPI 0x01
592# define DEVICE_PATH_SUB_TYPE_MSG_SCSI 0x02
c80214ce 593# define DEVICE_PATH_SUB_TYPE_MSG_USB 0x05
d7608aba 594# define DEVICE_PATH_SUB_TYPE_MSG_MAC_ADDR 0x0b
f027222a 595# define DEVICE_PATH_SUB_TYPE_MSG_UART 0x0e
b66c60dd 596# define DEVICE_PATH_SUB_TYPE_MSG_USB_CLASS 0x0f
bf3bcef7 597# define DEVICE_PATH_SUB_TYPE_MSG_SATA 0x12
f2d247df 598# define DEVICE_PATH_SUB_TYPE_MSG_NVME 0x17
148ce205 599# define DEVICE_PATH_SUB_TYPE_MSG_URI 0x18
c80214ce
PJ		 600# define DEVICE_PATH_SUB_TYPE_MSG_SD 0x1a
601# define DEVICE_PATH_SUB_TYPE_MSG_MMC 0x1d
602
af3106a1
HS		 603struct efi_device_path_atapi {
604 struct efi_device_path dp;
605 u8 primary_secondary;
606 u8 slave_master;
607 u16 logical_unit_number;
608} __packed;
609
610struct efi_device_path_scsi {
611 struct efi_device_path dp;
612 u16 target_id;
613 u16 logical_unit_number;
614} __packed;
615
f027222a
HS		 616struct efi_device_path_uart {
617 struct efi_device_path dp;
618 u32 reserved;
619 u64 baud_rate;
620 u8 data_bits;
621 u8 parity;
622 u8 stop_bits;
623} __packed;
624
c80214ce
PJ		 625struct efi_device_path_usb {
626 struct efi_device_path dp;
627 u8 parent_port_number;
628 u8 usb_interface;
629} __packed;
d7608aba 630
bf3bcef7
HS		 631struct efi_device_path_sata {
632 struct efi_device_path dp;
633 u16 hba_port;
634 u16 port_multiplier_port;
635 u16 logical_unit_number;
636} __packed;
637
d7608aba
OT		 638struct efi_device_path_mac_addr {
639 struct efi_device_path dp;
640 struct efi_mac_addr mac;
641 u8 if_type;
a8606ef0 642} __packed;
d7608aba 643
b66c60dd
RC		 644struct efi_device_path_usb_class {
645 struct efi_device_path dp;
646 u16 vendor_id;
647 u16 product_id;
648 u8 device_class;
649 u8 device_subclass;
650 u8 device_protocol;
651} __packed;
652
c80214ce
PJ		 653struct efi_device_path_sd_mmc_path {
654 struct efi_device_path dp;
655 u8 slot_number;
656} __packed;
657
f2d247df
PW		 658struct efi_device_path_nvme {
659 struct efi_device_path dp;
660 u32 ns_id;
661 u8 eui64[8];
662} __packed;
663
148ce205
HS		 664struct efi_device_path_uri {
665 struct efi_device_path dp;
666 u8 uri[];
667} __packed;
668
2bb9b79d 669#define DEVICE_PATH_TYPE_MEDIA_DEVICE 0x04
c80214ce
PJ		 670# define DEVICE_PATH_SUB_TYPE_HARD_DRIVE_PATH 0x01
671# define DEVICE_PATH_SUB_TYPE_CDROM_PATH 0x02
ec80b473 672# define DEVICE_PATH_SUB_TYPE_VENDOR_PATH 0x03
2bb9b79d
AG		 673# define DEVICE_PATH_SUB_TYPE_FILE_PATH 0x04
674
c80214ce
PJ		 675struct efi_device_path_hard_drive_path {
676 struct efi_device_path dp;
677 u32 partition_number;
678 u64 partition_start;
679 u64 partition_end;
680 u8 partition_signature[16];
681 u8 partmap_type;
682 u8 signature_type;
683} __packed;
684
685struct efi_device_path_cdrom_path {
686 struct efi_device_path dp;
687 u32 boot_entry;
688 u64 partition_start;
d0384d51 689 u64 partition_size;
c80214ce
PJ		 690} __packed;
691
2bb9b79d
AG		 692struct efi_device_path_file_path {
693 struct efi_device_path dp;
61b7e224 694 u16 str[];
a8606ef0 695} __packed;
2bb9b79d 696
dec88e41 697#define EFI_BLOCK_IO_PROTOCOL_GUID \
2bb9b79d
AG		 698 EFI_GUID(0x964e5b21, 0x6459, 0x11d2, \
699 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
700
2e0d79a0 701struct efi_block_io_media {
2bb9b79d
AG		 702 u32 media_id;
703 char removable_media;
704 char media_present;
705 char logical_partition;
706 char read_only;
707 char write_caching;
708 u8 pad[3];
709 u32 block_size;
710 u32 io_align;
711 u8 pad2[4];
712 u64 last_block;
4f94865b
HS		 713 /* Added in revision 2 of the protocol */
714 u64 lowest_aligned_lba;
715 u32 logical_blocks_per_physical_block;
716 /* Added in revision 3 of the protocol */
717 u32 optimal_transfer_length_granualarity;
2bb9b79d
AG		 718};
719
4f94865b
HS		 720#define EFI_BLOCK_IO_PROTOCOL_REVISION2 0x00020001
721#define EFI_BLOCK_IO_PROTOCOL_REVISION3 0x0002001f
722
2bb9b79d
AG		 723struct efi_block_io {
724 u64 revision;
725 struct efi_block_io_media *media;
726 efi_status_t (EFIAPI *reset)(struct efi_block_io *this,
727 char extended_verification);
728 efi_status_t (EFIAPI *read_blocks)(struct efi_block_io *this,
4f94865b 729 u32 media_id, u64 lba, efi_uintn_t buffer_size,
2bb9b79d
AG		 730 void *buffer);
731 efi_status_t (EFIAPI *write_blocks)(struct efi_block_io *this,
4f94865b 732 u32 media_id, u64 lba, efi_uintn_t buffer_size,
2bb9b79d
AG		 733 void *buffer);
734 efi_status_t (EFIAPI *flush_blocks)(struct efi_block_io *this);
735};
736
867a6ac8
SG		 737struct simple_text_output_mode {
738 s32 max_mode;
739 s32 mode;
740 s32 attribute;
741 s32 cursor_column;
742 s32 cursor_row;
743 bool cursor_visible;
744};
745
a17e62cc
RC		 746#define EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID \
747 EFI_GUID(0x387477c2, 0x69c7, 0x11d2, \
748 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
749
2d5dc2a5
RC		 750#define EFI_BLACK 0x00
751#define EFI_BLUE 0x01
752#define EFI_GREEN 0x02
753#define EFI_CYAN 0x03
754#define EFI_RED 0x04
755#define EFI_MAGENTA 0x05
756#define EFI_BROWN 0x06
757#define EFI_LIGHTGRAY 0x07
758#define EFI_BRIGHT 0x08
759#define EFI_DARKGRAY 0x08
760#define EFI_LIGHTBLUE 0x09
761#define EFI_LIGHTGREEN 0x0a
762#define EFI_LIGHTCYAN 0x0b
763#define EFI_LIGHTRED 0x0c
764#define EFI_LIGHTMAGENTA 0x0d
765#define EFI_YELLOW 0x0e
766#define EFI_WHITE 0x0f
767#define EFI_BACKGROUND_BLACK 0x00
768#define EFI_BACKGROUND_BLUE 0x10
769#define EFI_BACKGROUND_GREEN 0x20
770#define EFI_BACKGROUND_CYAN 0x30
771#define EFI_BACKGROUND_RED 0x40
772#define EFI_BACKGROUND_MAGENTA 0x50
773#define EFI_BACKGROUND_BROWN 0x60
774#define EFI_BACKGROUND_LIGHTGRAY 0x70
775
776/* extract foreground color from EFI attribute */
777#define EFI_ATTR_FG(attr) ((attr) & 0x07)
778/* treat high bit of FG as bright/bold (similar to edk2) */
779#define EFI_ATTR_BOLD(attr) (((attr) >> 3) & 0x01)
780/* extract background color from EFI attribute */
781#define EFI_ATTR_BG(attr) (((attr) >> 4) & 0x7)
782
867a6ac8 783struct efi_simple_text_output_protocol {
21b6b540
HS		 784 efi_status_t (EFIAPI *reset)(
785 struct efi_simple_text_output_protocol *this,
786 char extended_verification);
867a6ac8
SG		 787 efi_status_t (EFIAPI *output_string)(
788 struct efi_simple_text_output_protocol *this,
7913c7dc 789 const u16 *str);
2bb9b79d
AG		 790 efi_status_t (EFIAPI *test_string)(
791 struct efi_simple_text_output_protocol *this,
7913c7dc 792 const u16 *str);
867a6ac8
SG		 793 efi_status_t(EFIAPI *query_mode)(
794 struct efi_simple_text_output_protocol *this,
795 unsigned long mode_number, unsigned long *columns,
796 unsigned long *rows);
797 efi_status_t(EFIAPI *set_mode)(
798 struct efi_simple_text_output_protocol *this,
799 unsigned long mode_number);
800 efi_status_t(EFIAPI *set_attribute)(
801 struct efi_simple_text_output_protocol *this,
802 unsigned long attribute);
803 efi_status_t(EFIAPI *clear_screen) (
804 struct efi_simple_text_output_protocol *this);
805 efi_status_t(EFIAPI *set_cursor_position) (
806 struct efi_simple_text_output_protocol *this,
807 unsigned long column, unsigned long row);
2bb9b79d
AG		 808 efi_status_t(EFIAPI *enable_cursor)(
809 struct efi_simple_text_output_protocol *this,
810 bool enable);
867a6ac8
SG		 811 struct simple_text_output_mode *mode;
812};
813
110c6280
HS		 814#define EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL_GUID \
815 EFI_GUID(0xdd9e7534, 0x7762, 0x4698, \
816 0x8c, 0x14, 0xf5, 0x85, 0x17, 0xa6, 0x25, 0xaa)
817
867a6ac8
SG		 818struct efi_input_key {
819 u16 scan_code;
820 s16 unicode_char;
821};
822
110c6280
HS		 823#define EFI_SHIFT_STATE_INVALID 0x00000000
824#define EFI_RIGHT_SHIFT_PRESSED 0x00000001
825#define EFI_LEFT_SHIFT_PRESSED 0x00000002
826#define EFI_RIGHT_CONTROL_PRESSED 0x00000004
827#define EFI_LEFT_CONTROL_PRESSED 0x00000008
828#define EFI_RIGHT_ALT_PRESSED 0x00000010
829#define EFI_LEFT_ALT_PRESSED 0x00000020
830#define EFI_RIGHT_LOGO_PRESSED 0x00000040
831#define EFI_LEFT_LOGO_PRESSED 0x00000080
832#define EFI_MENU_KEY_PRESSED 0x00000100
833#define EFI_SYS_REQ_PRESSED 0x00000200
834#define EFI_SHIFT_STATE_VALID 0x80000000
835
836#define EFI_TOGGLE_STATE_INVALID 0x00
837#define EFI_SCROLL_LOCK_ACTIVE 0x01
838#define EFI_NUM_LOCK_ACTIVE 0x02
839#define EFI_CAPS_LOCK_ACTIVE 0x04
840#define EFI_KEY_STATE_EXPOSED 0x40
841#define EFI_TOGGLE_STATE_VALID 0x80
842
843struct efi_key_state {
844 u32 key_shift_state;
845 u8 key_toggle_state;
846};
847
848struct efi_key_data {
849 struct efi_input_key key;
850 struct efi_key_state key_state;
851};
852
853struct efi_simple_text_input_ex_protocol {
854 efi_status_t (EFIAPI *reset) (
855 struct efi_simple_text_input_ex_protocol *this,
856 bool extended_verification);
857 efi_status_t (EFIAPI *read_key_stroke_ex) (
858 struct efi_simple_text_input_ex_protocol *this,
859 struct efi_key_data *key_data);
860 struct efi_event *wait_for_key_ex;
861 efi_status_t (EFIAPI *set_state) (
862 struct efi_simple_text_input_ex_protocol *this,
acee9652 863 u8 *key_toggle_state);
110c6280
HS		 864 efi_status_t (EFIAPI *register_key_notify) (
865 struct efi_simple_text_input_ex_protocol *this,
866 struct efi_key_data *key_data,
867 efi_status_t (EFIAPI *key_notify_function)(
868 struct efi_key_data *key_data),
869 void **notify_handle);
870 efi_status_t (EFIAPI *unregister_key_notify) (
871 struct efi_simple_text_input_ex_protocol *this,
872 void *notification_handle);
873};
874
a17e62cc
RC		 875#define EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID \
876 EFI_GUID(0x387477c1, 0x69c7, 0x11d2, \
877 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
878
3e603ec7
HS		 879struct efi_simple_text_input_protocol {
880 efi_status_t(EFIAPI *reset)(struct efi_simple_text_input_protocol *this,
881 bool extended_verification);
867a6ac8 882 efi_status_t(EFIAPI *read_key_stroke)(
3e603ec7 883 struct efi_simple_text_input_protocol *this,
867a6ac8 884 struct efi_input_key *key);
2fd945fe 885 struct efi_event *wait_for_key;
867a6ac8
SG		 886};
887
cc5b7081
HS		 888#define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID \
889 EFI_GUID(0x8b843e20, 0x8132, 0x4852, \
890 0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c)
891
2e0d79a0 892struct efi_device_path_to_text_protocol {
cc5b7081 893 uint16_t *(EFIAPI *convert_device_node_to_text)(
9309a1b7 894 struct efi_device_path *device_node,
cc5b7081
HS		 895 bool display_only,
896 bool allow_shortcuts);
897 uint16_t *(EFIAPI *convert_device_path_to_text)(
9309a1b7 898 struct efi_device_path *device_path,
cc5b7081
HS		 899 bool display_only,
900 bool allow_shortcuts);
901};
902
e70f8dfa
LL		 903#define EFI_DEVICE_PATH_UTILITIES_PROTOCOL_GUID \
904 EFI_GUID(0x0379be4e, 0xd706, 0x437d, \
905 0xb0, 0x37, 0xed, 0xb8, 0x2f, 0xb7, 0x72, 0xa4)
906
907struct efi_device_path_utilities_protocol {
908 efi_uintn_t (EFIAPI *get_device_path_size)(
909 const struct efi_device_path *device_path);
910 struct efi_device_path *(EFIAPI *duplicate_device_path)(
911 const struct efi_device_path *device_path);
912 struct efi_device_path *(EFIAPI *append_device_path)(
913 const struct efi_device_path *src1,
914 const struct efi_device_path *src2);
915 struct efi_device_path *(EFIAPI *append_device_node)(
916 const struct efi_device_path *device_path,
917 const struct efi_device_path *device_node);
918 struct efi_device_path *(EFIAPI *append_device_path_instance)(
919 const struct efi_device_path *device_path,
920 const struct efi_device_path *device_path_instance);
921 struct efi_device_path *(EFIAPI *get_next_device_path_instance)(
922 struct efi_device_path **device_path_instance,
923 efi_uintn_t *device_path_instance_size);
924 bool (EFIAPI *is_device_path_multi_instance)(
925 const struct efi_device_path *device_path);
926 struct efi_device_path *(EFIAPI *create_device_node)(
927 uint8_t node_type,
928 uint8_t node_sub_type,
929 uint16_t node_length);
930};
931
c9bfb222
LL		 932/*
933 * Human Interface Infrastructure (HII)
934 */
935struct efi_hii_package_list_header {
936 efi_guid_t package_list_guid;
937 u32 package_length;
938} __packed;
939
940/**
941 * struct efi_hii_package_header - EFI HII package header
942 *
943 * @fields: 'fields' replaces the bit-fields defined in the EFI
944 * specification to to avoid possible compiler incompatibilities::
945 *
e032cb2a
HS		 946 * u32 length:24;
947 * u32 type:8;
c9bfb222
LL		 948 */
949struct efi_hii_package_header {
950 u32 fields;
951} __packed;
952
953#define __EFI_HII_PACKAGE_LEN_SHIFT 0
954#define __EFI_HII_PACKAGE_TYPE_SHIFT 24
955#define __EFI_HII_PACKAGE_LEN_MASK 0xffffff
956#define __EFI_HII_PACKAGE_TYPE_MASK 0xff
957
958#define EFI_HII_PACKAGE_TYPE_ALL 0x00
959#define EFI_HII_PACKAGE_TYPE_GUID 0x01
960#define EFI_HII_PACKAGE_FORMS 0x02
961#define EFI_HII_PACKAGE_STRINGS 0x04
962#define EFI_HII_PACKAGE_FONTS 0x05
963#define EFI_HII_PACKAGE_IMAGES 0x06
964#define EFI_HII_PACKAGE_SIMPLE_FONTS 0x07
965#define EFI_HII_PACKAGE_DEVICE_PATH 0x08
966#define EFI_HII_PACKAGE_KEYBOARD_LAYOUT 0x09
967#define EFI_HII_PACKAGE_ANIMATIONS 0x0A
968#define EFI_HII_PACKAGE_END 0xDF
969#define EFI_HII_PACKAGE_TYPE_SYSTEM_BEGIN 0xE0
970#define EFI_HII_PACKAGE_TYPE_SYSTEM_END 0xFF
971
9ab0bdd9
AT		 972/*
973 * HII GUID package
974 */
975struct efi_hii_guid_package {
976 struct efi_hii_package_header header;
977 efi_guid_t guid;
978 char data[];
979} __packed;
980
c9bfb222
LL		 981/*
982 * HII string package
983 */
984struct efi_hii_strings_package {
985 struct efi_hii_package_header header;
986 u32 header_size;
987 u32 string_info_offset;
988 u16 language_window[16];
989 efi_string_id_t language_name;
990 u8 language[];
991} __packed;
992
993struct efi_hii_string_block {
994 u8 block_type;
995 /* u8 block_body[]; */
996} __packed;
997
998#define EFI_HII_SIBT_END 0x00
999#define EFI_HII_SIBT_STRING_SCSU 0x10
1000#define EFI_HII_SIBT_STRING_SCSU_FONT 0x11
1001#define EFI_HII_SIBT_STRINGS_SCSU 0x12
1002#define EFI_HII_SIBT_STRINGS_SCSU_FONT 0x13
1003#define EFI_HII_SIBT_STRING_UCS2 0x14
1004#define EFI_HII_SIBT_STRING_UCS2_FONT 0x15
1005#define EFI_HII_SIBT_STRINGS_UCS2 0x16
1006#define EFI_HII_SIBT_STRINGS_UCS2_FONT 0x17
1007#define EFI_HII_SIBT_DUPLICATE 0x20
1008#define EFI_HII_SIBT_SKIP2 0x21
1009#define EFI_HII_SIBT_SKIP1 0x22
1010#define EFI_HII_SIBT_EXT1 0x30
1011#define EFI_HII_SIBT_EXT2 0x31
1012#define EFI_HII_SIBT_EXT4 0x32
1013#define EFI_HII_SIBT_FONT 0x40
1014
1015struct efi_hii_sibt_string_ucs2_block {
1016 struct efi_hii_string_block header;
1017 u16 string_text[];
1018} __packed;
1019
1020static inline struct efi_hii_string_block *
1021efi_hii_sibt_string_ucs2_block_next(struct efi_hii_sibt_string_ucs2_block *blk)
1022{
1023 return ((void *)blk) + sizeof(*blk) +
1024 (u16_strlen(blk->string_text) + 1) * 2;
1025}
1026
cb728e51
AT		 1027/*
1028 * HII forms package
1029 * TODO: full scope of definitions
1030 */
1031struct efi_hii_time {
1032 u8 hour;
1033 u8 minute;
1034 u8 second;
1035};
1036
1037struct efi_hii_date {
1038 u16 year;
1039 u8 month;
1040 u8 day;
1041};
1042
1043struct efi_hii_ref {
1044 efi_question_id_t question_id;
1045 efi_form_id_t form_id;
1046 efi_guid_t form_set_guid;
1047 efi_string_id_t device_path;
1048};
1049
1050union efi_ifr_type_value {
1051 u8 u8; // EFI_IFR_TYPE_NUM_SIZE_8
1052 u16 u16; // EFI_IFR_TYPE_NUM_SIZE_16
1053 u32 u32; // EFI_IFR_TYPE_NUM_SIZE_32
1054 u64 u64; // EFI_IFR_TYPE_NUM_SIZE_64
1055 bool b; // EFI_IFR_TYPE_BOOLEAN
1056 struct efi_hii_time time; // EFI_IFR_TYPE_TIME
1057 struct efi_hii_date date; // EFI_IFR_TYPE_DATE
1058 efi_string_id_t string; // EFI_IFR_TYPE_STRING, EFI_IFR_TYPE_ACTION
1059 struct efi_hii_ref ref; // EFI_IFR_TYPE_REF
1060 // u8 buffer[]; // EFI_IFR_TYPE_BUFFER
1061};
1062
1063#define EFI_IFR_TYPE_NUM_SIZE_8 0x00
1064#define EFI_IFR_TYPE_NUM_SIZE_16 0x01
1065#define EFI_IFR_TYPE_NUM_SIZE_32 0x02
1066#define EFI_IFR_TYPE_NUM_SIZE_64 0x03
1067#define EFI_IFR_TYPE_BOOLEAN 0x04
1068#define EFI_IFR_TYPE_TIME 0x05
1069#define EFI_IFR_TYPE_DATE 0x06
1070#define EFI_IFR_TYPE_STRING 0x07
1071#define EFI_IFR_TYPE_OTHER 0x08
1072#define EFI_IFR_TYPE_UNDEFINED 0x09
1073#define EFI_IFR_TYPE_ACTION 0x0A
1074#define EFI_IFR_TYPE_BUFFER 0x0B
1075#define EFI_IFR_TYPE_REF 0x0C
1076#define EFI_IFR_OPTION_DEFAULT 0x10
1077#define EFI_IFR_OPTION_DEFAULT_MFG 0x20
1078
1079#define EFI_IFR_ONE_OF_OPTION_OP 0x09
1080
1081struct efi_ifr_op_header {
1082 u8 opCode;
1083 u8 length:7;
1084 u8 scope:1;
1085};
1086
1087struct efi_ifr_one_of_option {
1088 struct efi_ifr_op_header header;
1089 efi_string_id_t option;
1090 u8 flags;
1091 u8 type;
1092 union efi_ifr_type_value value;
1093};
1094
1095typedef efi_uintn_t efi_browser_action_t;
1096
1097#define EFI_BROWSER_ACTION_REQUEST_NONE 0
1098#define EFI_BROWSER_ACTION_REQUEST_RESET 1
1099#define EFI_BROWSER_ACTION_REQUEST_SUBMIT 2
1100#define EFI_BROWSER_ACTION_REQUEST_EXIT 3
1101#define EFI_BROWSER_ACTION_REQUEST_FORM_SUBMIT_EXIT 4
1102#define EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD_EXIT 5
1103#define EFI_BROWSER_ACTION_REQUEST_FORM_APPLY 6
1104#define EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD 7
1105#define EFI_BROWSER_ACTION_REQUEST_RECONNECT 8
1106
1107typedef efi_uintn_t efi_browser_action_request_t;
1108
1109#define EFI_BROWSER_ACTION_CHANGING 0
1110#define EFI_BROWSER_ACTION_CHANGED 1
1111#define EFI_BROWSER_ACTION_RETRIEVE 2
1112#define EFI_BROWSER_ACTION_FORM_OPEN 3
1113#define EFI_BROWSER_ACTION_FORM_CLOSE 4
1114#define EFI_BROWSER_ACTION_SUBMITTED 5
1115#define EFI_BROWSER_ACTION_DEFAULT_STANDARD 0x1000
1116#define EFI_BROWSER_ACTION_DEFAULT_MANUFACTURING 0x1001
1117#define EFI_BROWSER_ACTION_DEFAULT_SAFE 0x1002
1118#define EFI_BROWSER_ACTION_DEFAULT_PLATFORM 0x2000
1119#define EFI_BROWSER_ACTION_DEFAULT_HARDWARE 0x3000
1120#define EFI_BROWSER_ACTION_DEFAULT_FIRMWARE 0x4000
1121
c9bfb222
LL		 1122/*
1123 * HII keyboard package
1124 */
1125typedef enum {
1126 EFI_KEY_LCTRL, EFI_KEY_A0, EFI_KEY_LALT, EFI_KEY_SPACE_BAR,
1127 EFI_KEY_A2, EFI_KEY_A3, EFI_KEY_A4, EFI_KEY_RCTRL, EFI_KEY_LEFT_ARROW,
1128 EFI_KEY_DOWN_ARROW, EFI_KEY_RIGHT_ARROW, EFI_KEY_ZERO,
1129 EFI_KEY_PERIOD, EFI_KEY_ENTER, EFI_KEY_LSHIFT, EFI_KEY_B0,
1130 EFI_KEY_B1, EFI_KEY_B2, EFI_KEY_B3, EFI_KEY_B4, EFI_KEY_B5, EFI_KEY_B6,
1131 EFI_KEY_B7, EFI_KEY_B8, EFI_KEY_B9, EFI_KEY_B10, EFI_KEY_RSHIFT,
1132 EFI_KEY_UP_ARROW, EFI_KEY_ONE, EFI_KEY_TWO, EFI_KEY_THREE,
1133 EFI_KEY_CAPS_LOCK, EFI_KEY_C1, EFI_KEY_C2, EFI_KEY_C3, EFI_KEY_C4,
1134 EFI_KEY_C5, EFI_KEY_C6, EFI_KEY_C7, EFI_KEY_C8, EFI_KEY_C9,
1135 EFI_KEY_C10, EFI_KEY_C11, EFI_KEY_C12, EFI_KEY_FOUR, EFI_KEY_FIVE,
1136 EFI_KEY_SIX, EFI_KEY_PLUS, EFI_KEY_TAB, EFI_KEY_D1, EFI_KEY_D2,
1137 EFI_KEY_D3, EFI_KEY_D4, EFI_KEY_D5, EFI_KEY_D6, EFI_KEY_D7, EFI_KEY_D8,
1138 EFI_KEY_D9, EFI_KEY_D10, EFI_KEY_D11, EFI_KEY_D12, EFI_KEY_D13,
1139 EFI_KEY_DEL, EFI_KEY_END, EFI_KEY_PG_DN, EFI_KEY_SEVEN, EFI_KEY_EIGHT,
1140 EFI_KEY_NINE, EFI_KEY_E0, EFI_KEY_E1, EFI_KEY_E2, EFI_KEY_E3,
1141 EFI_KEY_E4, EFI_KEY_E5, EFI_KEY_E6, EFI_KEY_E7, EFI_KEY_E8, EFI_KEY_E9,
1142 EFI_KEY_E10, EFI_KEY_E11, EFI_KEY_E12, EFI_KEY_BACK_SPACE,
1143 EFI_KEY_INS, EFI_KEY_HOME, EFI_KEY_PG_UP, EFI_KEY_NLCK, EFI_KEY_SLASH,
1144 EFI_KEY_ASTERISK, EFI_KEY_MINUS, EFI_KEY_ESC, EFI_KEY_F1, EFI_KEY_F2,
1145 EFI_KEY_F3, EFI_KEY_F4, EFI_KEY_F5, EFI_KEY_F6, EFI_KEY_F7, EFI_KEY_F8,
1146 EFI_KEY_F9, EFI_KEY_F10, EFI_KEY_F11, EFI_KEY_F12, EFI_KEY_PRINT,
1147 EFI_KEY_SLCK, EFI_KEY_PAUSE,
1148} efi_key;
1149
1150struct efi_key_descriptor {
1151 u32 key;
1152 u16 unicode;
1153 u16 shifted_unicode;
1154 u16 alt_gr_unicode;
1155 u16 shifted_alt_gr_unicode;
1156 u16 modifier;
1157 u16 affected_attribute;
1158} __packed;
1159
1160struct efi_hii_keyboard_layout {
1161 u16 layout_length;
1162 efi_guid_t guid;
1163 u32 layout_descriptor_string_offset;
1164 u8 descriptor_count;
1165 struct efi_key_descriptor descriptors[];
1166} __packed;
1167
8d3b77e3
AT		 1168struct efi_hii_keyboard_package {
1169 struct efi_hii_package_header header;
1170 u16 layout_count;
1171 struct efi_hii_keyboard_layout layout[];
1172} __packed;
1173
c9bfb222
LL		 1174/*
1175 * HII protocols
1176 */
1177#define EFI_HII_STRING_PROTOCOL_GUID \
1178 EFI_GUID(0x0fd96974, 0x23aa, 0x4cdc, \
1179 0xb9, 0xcb, 0x98, 0xd1, 0x77, 0x50, 0x32, 0x2a)
1180
1181struct efi_font_info {
1182 efi_hii_font_style_t font_style;
1183 u16 font_size;
1184 u16 font_name[1];
1185};
1186
1187struct efi_hii_string_protocol {
1188 efi_status_t(EFIAPI *new_string)(
1189 const struct efi_hii_string_protocol *this,
1190 efi_hii_handle_t package_list,
1191 efi_string_id_t *string_id,
1192 const u8 *language,
1193 const u16 *language_name,
1194 const efi_string_t string,
1195 const struct efi_font_info *string_font_info);
1196 efi_status_t(EFIAPI *get_string)(
1197 const struct efi_hii_string_protocol *this,
1198 const u8 *language,
1199 efi_hii_handle_t package_list,
1200 efi_string_id_t string_id,
1201 efi_string_t string,
1202 efi_uintn_t *string_size,
1203 struct efi_font_info **string_font_info);
1204 efi_status_t(EFIAPI *set_string)(
1205 const struct efi_hii_string_protocol *this,
1206 efi_hii_handle_t package_list,
1207 efi_string_id_t string_id,
1208 const u8 *language,
1209 const efi_string_t string,
1210 const struct efi_font_info *string_font_info);
1211 efi_status_t(EFIAPI *get_languages)(
1212 const struct efi_hii_string_protocol *this,
1213 efi_hii_handle_t package_list,
1214 u8 *languages,
1215 efi_uintn_t *languages_size);
1216 efi_status_t(EFIAPI *get_secondary_languages)(
1217 const struct efi_hii_string_protocol *this,
1218 efi_hii_handle_t package_list,
1219 const u8 *primary_language,
1220 u8 *secondary_languages,
1221 efi_uintn_t *secondary_languages_size);
1222};
1223
1224#define EFI_HII_DATABASE_PROTOCOL_GUID \
1225 EFI_GUID(0xef9fc172, 0xa1b2, 0x4693, \
1226 0xb3, 0x27, 0x6d, 0x32, 0xfc, 0x41, 0x60, 0x42)
1227
1228struct efi_hii_database_protocol {
1229 efi_status_t(EFIAPI *new_package_list)(
1230 const struct efi_hii_database_protocol *this,
1231 const struct efi_hii_package_list_header *package_list,
1232 const efi_handle_t driver_handle,
1233 efi_hii_handle_t *handle);
1234 efi_status_t(EFIAPI *remove_package_list)(
1235 const struct efi_hii_database_protocol *this,
1236 efi_hii_handle_t handle);
1237 efi_status_t(EFIAPI *update_package_list)(
1238 const struct efi_hii_database_protocol *this,
1239 efi_hii_handle_t handle,
1240 const struct efi_hii_package_list_header *package_list);
1241 efi_status_t(EFIAPI *list_package_lists)(
1242 const struct efi_hii_database_protocol *this,
1243 u8 package_type,
1244 const efi_guid_t *package_guid,
1245 efi_uintn_t *handle_buffer_length,
1246 efi_hii_handle_t *handle);
1247 efi_status_t(EFIAPI *export_package_lists)(
1248 const struct efi_hii_database_protocol *this,
1249 efi_hii_handle_t handle,
1250 efi_uintn_t *buffer_size,
1251 struct efi_hii_package_list_header *buffer);
1252 efi_status_t(EFIAPI *register_package_notify)(
1253 const struct efi_hii_database_protocol *this,
1254 u8 package_type,
1255 const efi_guid_t *package_guid,
1256 const void *package_notify_fn,
1257 efi_uintn_t notify_type,
1258 efi_handle_t *notify_handle);
1259 efi_status_t(EFIAPI *unregister_package_notify)(
1260 const struct efi_hii_database_protocol *this,
1261 efi_handle_t notification_handle
1262 );
1263 efi_status_t(EFIAPI *find_keyboard_layouts)(
1264 const struct efi_hii_database_protocol *this,
1265 u16 *key_guid_buffer_length,
1266 efi_guid_t *key_guid_buffer);
1267 efi_status_t(EFIAPI *get_keyboard_layout)(
1268 const struct efi_hii_database_protocol *this,
1269 efi_guid_t *key_guid,
1270 u16 *keyboard_layout_length,
1271 struct efi_hii_keyboard_layout *keyboard_layout);
1272 efi_status_t(EFIAPI *set_keyboard_layout)(
1273 const struct efi_hii_database_protocol *this,
1274 efi_guid_t *key_guid);
1275 efi_status_t(EFIAPI *get_package_list_handle)(
1276 const struct efi_hii_database_protocol *this,
1277 efi_hii_handle_t package_list_handle,
1278 efi_handle_t *driver_handle);
1279};
1280
cb728e51
AT		 1281#define EFI_HII_CONFIG_ROUTING_PROTOCOL_GUID \
1282 EFI_GUID(0x587e72d7, 0xcc50, 0x4f79, \
1283 0x82, 0x09, 0xca, 0x29, 0x1f, 0xc1, 0xa1, 0x0f)
1284
1285struct efi_hii_config_routing_protocol {
1286 efi_status_t(EFIAPI *extract_config)(
1287 const struct efi_hii_config_routing_protocol *this,
1288 const efi_string_t request,
1289 efi_string_t *progress,
1290 efi_string_t *results);
1291 efi_status_t(EFIAPI *export_config)(
1292 const struct efi_hii_config_routing_protocol *this,
1293 efi_string_t *results);
1294 efi_status_t(EFIAPI *route_config)(
1295 const struct efi_hii_config_routing_protocol *this,
1296 const efi_string_t configuration,
1297 efi_string_t *progress);
1298 efi_status_t(EFIAPI *block_to_config)(
1299 const struct efi_hii_config_routing_protocol *this,
1300 const efi_string_t config_request,
1301 const uint8_t *block,
1302 const efi_uintn_t block_size,
1303 efi_string_t *config,
1304 efi_string_t *progress);
1305 efi_status_t(EFIAPI *config_to_block)(
1306 const struct efi_hii_config_routing_protocol *this,
1307 const efi_string_t config_resp,
1308 const uint8_t *block,
1309 const efi_uintn_t *block_size,
1310 efi_string_t *progress);
1311 efi_status_t(EFIAPI *get_alt_config)(
1312 const struct efi_hii_config_routing_protocol *this,
1313 const efi_string_t config_resp,
1314 const efi_guid_t *guid,
1315 const efi_string_t name,
1316 const struct efi_device_path *device_path,
1317 const efi_string_t alt_cfg_id,
1318 efi_string_t *alt_cfg_resp);
1319};
1320
1321#define EFI_HII_CONFIG_ACCESS_PROTOCOL_GUID \
1322 EFI_GUID(0x330d4706, 0xf2a0, 0x4e4f, \
1323 0xa3, 0x69, 0xb6, 0x6f, 0xa8, 0xd5, 0x43, 0x85)
1324
1325struct efi_hii_config_access_protocol {
1326 efi_status_t(EFIAPI *extract_config_access)(
1327 const struct efi_hii_config_access_protocol *this,
1328 const efi_string_t request,
1329 efi_string_t *progress,
1330 efi_string_t *results);
1331 efi_status_t(EFIAPI *route_config_access)(
1332 const struct efi_hii_config_access_protocol *this,
1333 const efi_string_t configuration,
1334 efi_string_t *progress);
1335 efi_status_t(EFIAPI *form_callback)(
1336 const struct efi_hii_config_access_protocol *this,
1337 efi_browser_action_t action,
1338 efi_question_id_t question_id,
1339 u8 type,
1340 union efi_ifr_type_value *value,
1341 efi_browser_action_request_t *action_request);
1342};
1343
dec88e41 1344#define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
be8d3241
AG		 1345 EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, \
1346 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
1347
1348#define EFI_GOT_RGBA8 0
1349#define EFI_GOT_BGRA8 1
1350#define EFI_GOT_BITMASK 2
1351
2e0d79a0 1352struct efi_gop_mode_info {
be8d3241
AG		 1353 u32 version;
1354 u32 width;
1355 u32 height;
1356 u32 pixel_format;
1357 u32 pixel_bitmask[4];
1358 u32 pixels_per_scanline;
1359};
1360
2e0d79a0 1361struct efi_gop_mode {
be8d3241
AG		 1362 u32 max_mode;
1363 u32 mode;
1364 struct efi_gop_mode_info *info;
1365 unsigned long info_size;
1366 efi_physical_addr_t fb_base;
1367 unsigned long fb_size;
1368};
1369
0e0a3ceb
HS		 1370struct efi_gop_pixel {
1371 u8 blue;
1372 u8 green;
1373 u8 red;
1374 u8 reserved;
1375};
1376
be8d3241
AG		 1377#define EFI_BLT_VIDEO_FILL 0
1378#define EFI_BLT_VIDEO_TO_BLT_BUFFER 1
1379#define EFI_BLT_BUFFER_TO_VIDEO 2
1380#define EFI_BLT_VIDEO_TO_VIDEO 3
1381
2e0d79a0 1382struct efi_gop {
be8d3241 1383 efi_status_t (EFIAPI *query_mode)(struct efi_gop *this, u32 mode_number,
1c38a774 1384 efi_uintn_t *size_of_info,
be8d3241
AG		 1385 struct efi_gop_mode_info **info);
1386 efi_status_t (EFIAPI *set_mode)(struct efi_gop *this, u32 mode_number);
0e0a3ceb
HS		 1387 efi_status_t (EFIAPI *blt)(struct efi_gop *this,
1388 struct efi_gop_pixel *buffer,
1c38a774
HS		 1389 u32 operation, efi_uintn_t sx,
1390 efi_uintn_t sy, efi_uintn_t dx,
1391 efi_uintn_t dy, efi_uintn_t width,
1392 efi_uintn_t height, efi_uintn_t delta);
be8d3241
AG		 1393 struct efi_gop_mode *mode;
1394};
1395
dec88e41 1396#define EFI_SIMPLE_NETWORK_PROTOCOL_GUID \
0efe1bcf
AG		 1397 EFI_GUID(0xa19832b9, 0xac25, 0x11d3, \
1398 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
1399
1400struct efi_mac_address {
1401 char mac_addr[32];
1402};
1403
1404struct efi_ip_address {
1405 u8 ip_addr[16];
e2742358 1406} __attribute__((aligned(4)));
0efe1bcf
AG		 1407
1408enum efi_simple_network_state {
1409 EFI_NETWORK_STOPPED,
1410 EFI_NETWORK_STARTED,
1411 EFI_NETWORK_INITIALIZED,
1412};
1413
1414struct efi_simple_network_mode {
1415 enum efi_simple_network_state state;
1416 u32 hwaddr_size;
1417 u32 media_header_size;
1418 u32 max_packet_size;
1419 u32 nvram_size;
1420 u32 nvram_access_size;
1421 u32 receive_filter_mask;
1422 u32 receive_filter_setting;
1423 u32 max_mcast_filter_count;
1424 u32 mcast_filter_count;
1425 struct efi_mac_address mcast_filter[16];
1426 struct efi_mac_address current_address;
1427 struct efi_mac_address broadcast_address;
1428 struct efi_mac_address permanent_address;
1429 u8 if_type;
1430 u8 mac_changeable;
1431 u8 multitx_supported;
1432 u8 media_present_supported;
1433 u8 media_present;
1434};
1435
2e0864a4
HS		 1436/* receive_filters bit mask */
1437#define EFI_SIMPLE_NETWORK_RECEIVE_UNICAST 0x01
1438#define EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST 0x02
1439#define EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST 0x04
1440#define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS 0x08
1441#define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST 0x10
0efe1bcf 1442
891b3d90
HS		 1443/* interrupt status bit mask */
1444#define EFI_SIMPLE_NETWORK_RECEIVE_INTERRUPT 0x01
1445#define EFI_SIMPLE_NETWORK_TRANSMIT_INTERRUPT 0x02
1446#define EFI_SIMPLE_NETWORK_COMMAND_INTERRUPT 0x04
1447#define EFI_SIMPLE_NETWORK_SOFTWARE_INTERRUPT 0x08
1448
bdecf974
HS		 1449/* revision of the simple network protocol */
1450#define EFI_SIMPLE_NETWORK_PROTOCOL_REVISION 0x00010000
1451
2e0d79a0 1452struct efi_simple_network {
0efe1bcf
AG		 1453 u64 revision;
1454 efi_status_t (EFIAPI *start)(struct efi_simple_network *this);
1455 efi_status_t (EFIAPI *stop)(struct efi_simple_network *this);
1456 efi_status_t (EFIAPI *initialize)(struct efi_simple_network *this,
1457 ulong extra_rx, ulong extra_tx);
1458 efi_status_t (EFIAPI *reset)(struct efi_simple_network *this,
1459 int extended_verification);
1460 efi_status_t (EFIAPI *shutdown)(struct efi_simple_network *this);
1461 efi_status_t (EFIAPI *receive_filters)(struct efi_simple_network *this,
1462 u32 enable, u32 disable, int reset_mcast_filter,
1463 ulong mcast_filter_count,
1464 struct efi_mac_address *mcast_filter);
1465 efi_status_t (EFIAPI *station_address)(struct efi_simple_network *this,
1466 int reset, struct efi_mac_address *new_mac);
1467 efi_status_t (EFIAPI *statistics)(struct efi_simple_network *this,
1468 int reset, ulong *stat_size, void *stat_table);
1469 efi_status_t (EFIAPI *mcastiptomac)(struct efi_simple_network *this,
1470 int ipv6, struct efi_ip_address *ip,
1471 struct efi_mac_address *mac);
1472 efi_status_t (EFIAPI *nvdata)(struct efi_simple_network *this,
1473 int read_write, ulong offset, ulong buffer_size,
1474 char *buffer);
1475 efi_status_t (EFIAPI *get_status)(struct efi_simple_network *this,
1476 u32 *int_status, void **txbuf);
1477 efi_status_t (EFIAPI *transmit)(struct efi_simple_network *this,
8db174d6 1478 size_t header_size, size_t buffer_size, void *buffer,
0efe1bcf
AG		 1479 struct efi_mac_address *src_addr,
1480 struct efi_mac_address *dest_addr, u16 *protocol);
1481 efi_status_t (EFIAPI *receive)(struct efi_simple_network *this,
8db174d6 1482 size_t *header_size, size_t *buffer_size, void *buffer,
0efe1bcf
AG		 1483 struct efi_mac_address *src_addr,
1484 struct efi_mac_address *dest_addr, u16 *protocol);
84a12ce6 1485 struct efi_event *wait_for_packet;
0efe1bcf 1486 struct efi_simple_network_mode *mode;
7f6d874d
HS		 1487 /* private fields */
1488 u32 int_status;
0efe1bcf
AG		 1489};
1490
dec88e41 1491#define EFI_PXE_BASE_CODE_PROTOCOL_GUID \
0efe1bcf
AG		 1492 EFI_GUID(0x03c4e603, 0xac28, 0x11d3, \
1493 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
1494
a6d37098
HS		 1495#define EFI_PXE_BASE_CODE_PROTOCOL_REVISION 0x00010000
1496#define EFI_PXE_BASE_CODE_MAX_IPCNT 8
1497
0efe1bcf
AG		 1498struct efi_pxe_packet {
1499 u8 packet[1472];
1500};
1501
2e0d79a0 1502struct efi_pxe_mode {
e2742358
PW		 1503 u8 started;
1504 u8 ipv6_available;
1505 u8 ipv6_supported;
1506 u8 using_ipv6;
1507 u8 bis_supported;
1508 u8 bis_detected;
1509 u8 auto_arp;
1510 u8 send_guid;
1511 u8 dhcp_discover_valid;
1512 u8 dhcp_ack_received;
1513 u8 proxy_offer_received;
1514 u8 pxe_discover_valid;
1515 u8 pxe_reply_received;
1516 u8 pxe_bis_reply_received;
1517 u8 icmp_error_received;
1518 u8 tftp_error_received;
1519 u8 make_callbacks;
1520 u8 ttl;
1521 u8 tos;
1522 u8 pad;
1523 struct efi_ip_address station_ip;
1524 struct efi_ip_address subnet_mask;
0efe1bcf
AG		 1525 struct efi_pxe_packet dhcp_discover;
1526 struct efi_pxe_packet dhcp_ack;
1527 struct efi_pxe_packet proxy_offer;
1528 struct efi_pxe_packet pxe_discover;
1529 struct efi_pxe_packet pxe_reply;
1530};
1531
a6d37098
HS		 1532struct efi_pxe_base_code_srvlist {
1533 u16 type;
1534 u8 accept_any_response;
1535 u8 reserved;
1536 struct efi_ip_address ip_addr;
1537};
1538
1539struct efi_pxe_base_code_discover_info {
1540 u8 use_m_cast;
1541 u8 use_b_cast;
1542 u8 use_u_cast;
1543 u8 must_use_list;
1544 struct efi_ip_address server_m_cast_ip;
1545 u16 ip_cnt;
1546 struct efi_pxe_base_code_srvlist srv_list[];
1547};
1548
1549struct efi_pxe_base_code_mtftp_info {
1550 struct efi_ip_address m_cast_ip;
1551 u16 cport;
1552 u16 sport;
1553 u16 listen_timeout;
1554 u16 transit_timeout;
1555};
1556
1557struct efi_pxe_base_code_filter {
1558 u8 filters;
1559 u8 ip_cnt;
1560 u16 reserved;
1561 struct efi_ip_address ip_list[EFI_PXE_BASE_CODE_MAX_IPCNT];
1562};
1563
1564struct efi_pxe_base_code_dhcpv4_packet {
1565 u8 bootp_op_code;
1566 u8 bootp_hw_type;
1567 u8 bootp_addr_len;
1568 u8 bootp_gate_hops;
1569 u32 bootp_ident;
1570 u16 bootp_seconds;
1571 u16 bootp_flags;
1572 u8 bootp_ci_addr[4];
1573 u8 bootp_yi_addr[4];
1574 u8 bootp_si_addr[4];
1575 u8 bootp_gi_addr[4];
1576 u8 bootp_hw_addr[16];
1577 u8 bootp_srv_name[64];
1578 u8 bootp_boot_file[128];
1579 u32 dhcp_magick;
1580 u8 dhcp_options[56];
1581};
1582
1583struct efi_pxe_base_code_dhcpv6_packet {
1584 u8 message_type;
1585 u8 transaction_id[3];
1586 u8 dhcp_options[1024];
1587};
1588
1589typedef union {
1590 u8 raw[1472];
1591 struct efi_pxe_base_code_dhcpv4_packet dhcpv4;
1592 struct efi_pxe_base_code_dhcpv6_packet dhcpv6;
1593} EFI_PXE_BASE_CODE_PACKET;
1594
1595struct efi_pxe_base_code_protocol {
1596 u64 revision;
1597 efi_status_t (EFIAPI *start)(struct efi_pxe_base_code_protocol *this,
1598 u8 use_ipv6);
1599 efi_status_t (EFIAPI *stop)(struct efi_pxe_base_code_protocol *this);
1600 efi_status_t (EFIAPI *dhcp)(struct efi_pxe_base_code_protocol *this,
1601 u8 sort_offers);
1602 efi_status_t (EFIAPI *discover)(
1603 struct efi_pxe_base_code_protocol *this,
1604 u16 type, u16 *layer, u8 bis,
1605 struct efi_pxe_base_code_discover_info *info);
1606 efi_status_t (EFIAPI *mtftp)(
1607 struct efi_pxe_base_code_protocol *this,
1608 u32 operation, void *buffer_ptr,
1609 u8 overwrite, efi_uintn_t *buffer_size,
1610 struct efi_ip_address server_ip, char *filename,
1611 struct efi_pxe_base_code_mtftp_info *info,
1612 u8 dont_use_buffer);
1613 efi_status_t (EFIAPI *udp_write)(
1614 struct efi_pxe_base_code_protocol *this,
1615 u16 op_flags, struct efi_ip_address *dest_ip,
1616 u16 *dest_port,
1617 struct efi_ip_address *gateway_ip,
1618 struct efi_ip_address *src_ip, u16 *src_port,
1619 efi_uintn_t *header_size, void *header_ptr,
1620 efi_uintn_t *buffer_size, void *buffer_ptr);
1621 efi_status_t (EFIAPI *udp_read)(
1622 struct efi_pxe_base_code_protocol *this,
1623 u16 op_flags, struct efi_ip_address *dest_ip,
1624 u16 *dest_port, struct efi_ip_address *src_ip,
1625 u16 *src_port, efi_uintn_t *header_size,
1626 void *header_ptr, efi_uintn_t *buffer_size,
1627 void *buffer_ptr);
1628 efi_status_t (EFIAPI *set_ip_filter)(
1629 struct efi_pxe_base_code_protocol *this,
1630 struct efi_pxe_base_code_filter *new_filter);
1631 efi_status_t (EFIAPI *arp)(struct efi_pxe_base_code_protocol *this,
1632 struct efi_ip_address *ip_addr,
1633 struct efi_mac_address *mac_addr);
1634 efi_status_t (EFIAPI *set_parameters)(
1635 struct efi_pxe_base_code_protocol *this,
1636 u8 *new_auto_arp, u8 *new_send_guid,
1637 u8 *new_ttl, u8 *new_tos,
1638 u8 *new_make_callback);
1639 efi_status_t (EFIAPI *set_station_ip)(
1640 struct efi_pxe_base_code_protocol *this,
1641 struct efi_ip_address *new_station_ip,
1642 struct efi_ip_address *new_subnet_mask);
1643 efi_status_t (EFIAPI *set_packets)(
1644 struct efi_pxe_base_code_protocol *this,
1645 u8 *new_dhcp_discover_valid,
1646 u8 *new_dhcp_ack_received,
1647 u8 *new_proxy_offer_received,
1648 u8 *new_pxe_discover_valid,
1649 u8 *new_pxe_reply_received,
1650 u8 *new_pxe_bis_reply_received,
1651 EFI_PXE_BASE_CODE_PACKET *new_dchp_discover,
1652 EFI_PXE_BASE_CODE_PACKET *new_dhcp_acc,
1653 EFI_PXE_BASE_CODE_PACKET *new_proxy_offer,
1654 EFI_PXE_BASE_CODE_PACKET *new_pxe_discover,
1655 EFI_PXE_BASE_CODE_PACKET *new_pxe_reply,
1656 EFI_PXE_BASE_CODE_PACKET *new_pxe_bis_reply);
0efe1bcf
AG		 1657 struct efi_pxe_mode *mode;
1658};
1659
2a92080d
RC		 1660#define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID \
1661 EFI_GUID(0x964e5b22, 0x6459, 0x11d2, \
1662 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
17394f9a
HS		 1663#define EFI_FILE_PROTOCOL_REVISION 0x00010000
1664#define EFI_FILE_PROTOCOL_REVISION2 0x00020000
1665#define EFI_FILE_PROTOCOL_LATEST_REVISION EFI_FILE_PROTOCOL_REVISION2
2a92080d 1666
e692ed1d
HS		 1667struct efi_file_io_token {
1668 struct efi_event *event;
1669 efi_status_t status;
1670 efi_uintn_t buffer_size;
1671 void *buffer;};
1672
2a92080d
RC		 1673struct efi_file_handle {
1674 u64 rev;
db12f518 1675 efi_status_t (EFIAPI *open)(struct efi_file_handle *this,
2a92080d 1676 struct efi_file_handle **new_handle,
c82f8f60 1677 u16 *file_name, u64 open_mode, u64 attributes);
db12f518
HS		 1678 efi_status_t (EFIAPI *close)(struct efi_file_handle *this);
1679 efi_status_t (EFIAPI *delete)(struct efi_file_handle *this);
1680 efi_status_t (EFIAPI *read)(struct efi_file_handle *this,
b6dd5777 1681 efi_uintn_t *buffer_size, void *buffer);
db12f518 1682 efi_status_t (EFIAPI *write)(struct efi_file_handle *this,
b6dd5777 1683 efi_uintn_t *buffer_size, void *buffer);
db12f518 1684 efi_status_t (EFIAPI *getpos)(struct efi_file_handle *this,
0801d4d2 1685 u64 *pos);
db12f518 1686 efi_status_t (EFIAPI *setpos)(struct efi_file_handle *this,
0801d4d2 1687 u64 pos);
db12f518 1688 efi_status_t (EFIAPI *getinfo)(struct efi_file_handle *this,
9c9021e2 1689 const efi_guid_t *info_type, efi_uintn_t *buffer_size,
b6dd5777 1690 void *buffer);
db12f518 1691 efi_status_t (EFIAPI *setinfo)(struct efi_file_handle *this,
9c9021e2 1692 const efi_guid_t *info_type, efi_uintn_t buffer_size,
b6dd5777 1693 void *buffer);
db12f518
HS		 1694 efi_status_t (EFIAPI *flush)(struct efi_file_handle *this);
1695 efi_status_t (EFIAPI *open_ex)(struct efi_file_handle *this,
e692ed1d
HS		 1696 struct efi_file_handle **new_handle,
1697 u16 *file_name, u64 open_mode, u64 attributes,
1698 struct efi_file_io_token *token);
db12f518 1699 efi_status_t (EFIAPI *read_ex)(struct efi_file_handle *this,
e692ed1d 1700 struct efi_file_io_token *token);
db12f518 1701 efi_status_t (EFIAPI *write_ex)(struct efi_file_handle *this,
e692ed1d 1702 struct efi_file_io_token *token);
db12f518 1703 efi_status_t (EFIAPI *flush_ex)(struct efi_file_handle *this,
e692ed1d 1704 struct efi_file_io_token *token);
2a92080d
RC		 1705};
1706
2a92080d
RC		 1707#define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION 0x00010000
1708
1709struct efi_simple_file_system_protocol {
1710 u64 rev;
1711 efi_status_t (EFIAPI *open_volume)(struct efi_simple_file_system_protocol *this,
1712 struct efi_file_handle **root);
1713};
1714
1715#define EFI_FILE_INFO_GUID \
1716 EFI_GUID(0x9576e92, 0x6d3f, 0x11d2, \
1717 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
1718
9e6835e6
HS		 1719#define EFI_FILE_SYSTEM_INFO_GUID \
1720 EFI_GUID(0x09576e93, 0x6d3f, 0x11d2, \
1721 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
1722
632834ce
HS		 1723#define EFI_FILE_SYSTEM_VOLUME_LABEL_ID \
1724 EFI_GUID(0xdb47d7d3, 0xfe81, 0x11d3, \
1725 0x9a, 0x35, 0x00, 0x90, 0x27, 0x3f, 0xC1, 0x4d)
1726
2a92080d
RC		 1727#define EFI_FILE_MODE_READ 0x0000000000000001
1728#define EFI_FILE_MODE_WRITE 0x0000000000000002
1729#define EFI_FILE_MODE_CREATE 0x8000000000000000
1730
1731#define EFI_FILE_READ_ONLY 0x0000000000000001
1732#define EFI_FILE_HIDDEN 0x0000000000000002
1733#define EFI_FILE_SYSTEM 0x0000000000000004
1734#define EFI_FILE_RESERVED 0x0000000000000008
1735#define EFI_FILE_DIRECTORY 0x0000000000000010
1736#define EFI_FILE_ARCHIVE 0x0000000000000020
1737#define EFI_FILE_VALID_ATTR 0x0000000000000037
1738
1739struct efi_file_info {
1740 u64 size;
1741 u64 file_size;
1742 u64 physical_size;
1743 struct efi_time create_time;
1744 struct efi_time last_access_time;
1745 struct efi_time modification_time;
1746 u64 attribute;
02c2f029 1747 u16 file_name[0];
2a92080d
RC		 1748};
1749
9e6835e6
HS		 1750struct efi_file_system_info {
1751 u64 size;
1752 u8 read_only;
1753 u64 volume_size;
1754 u64 free_space;
1755 u32 block_size;
1756 u16 volume_label[0];
1757};
1758
f0959dbe
HS		 1759#define EFI_DRIVER_BINDING_PROTOCOL_GUID \
1760 EFI_GUID(0x18a031ab, 0xb443, 0x4d1a,\
1761 0xa5, 0xc0, 0x0c, 0x09, 0x26, 0x1e, 0x9f, 0x71)
1762struct efi_driver_binding_protocol {
1763 efi_status_t (EFIAPI * supported)(
1764 struct efi_driver_binding_protocol *this,
1765 efi_handle_t controller_handle,
1766 struct efi_device_path *remaining_device_path);
1767 efi_status_t (EFIAPI * start)(
1768 struct efi_driver_binding_protocol *this,
1769 efi_handle_t controller_handle,
1770 struct efi_device_path *remaining_device_path);
1771 efi_status_t (EFIAPI * stop)(
1772 struct efi_driver_binding_protocol *this,
1773 efi_handle_t controller_handle,
1774 efi_uintn_t number_of_children,
1775 efi_handle_t *child_handle_buffer);
1776 u32 version;
1777 efi_handle_t image_handle;
1778 efi_handle_t driver_binding_handle;
1779};
1780
b1b782d3 1781/* Current version of the Unicode collation protocol */
0bc4b0da
HS		 1782#define EFI_UNICODE_COLLATION_PROTOCOL2_GUID \
1783 EFI_GUID(0xa4c751fc, 0x23ae, 0x4c3e, \
1784 0x92, 0xe9, 0x49, 0x64, 0xcf, 0x63, 0xf3, 0x49)
1785struct efi_unicode_collation_protocol {
1786 efi_intn_t (EFIAPI *stri_coll)(
1787 struct efi_unicode_collation_protocol *this, u16 *s1, u16 *s2);
1788 bool (EFIAPI *metai_match)(struct efi_unicode_collation_protocol *this,
1789 const u16 *string, const u16 *patter);
1790 void (EFIAPI *str_lwr)(struct efi_unicode_collation_protocol
1791 *this, u16 *string);
1792 void (EFIAPI *str_upr)(struct efi_unicode_collation_protocol *this,
1793 u16 *string);
1794 void (EFIAPI *fat_to_str)(struct efi_unicode_collation_protocol *this,
1795 efi_uintn_t fat_size, char *fat, u16 *string);
1796 bool (EFIAPI *str_to_fat)(struct efi_unicode_collation_protocol *this,
1797 const u16 *string, efi_uintn_t fat_size,
1798 char *fat);
1799 char *supported_languages;
1800};
1801
ec80b473
IA		 1802struct efi_load_file_protocol {
1803 efi_status_t (EFIAPI *load_file)(struct efi_load_file_protocol *this,
1804 struct efi_device_path *file_path,
1805 bool boot_policy,
1806 efi_uintn_t *buffer_size,
1807 void *buffer);
1808};
1809
64a8aae1
JM		 1810struct efi_system_resource_entry {
1811 efi_guid_t fw_class;
1812 u32 fw_type;
1813 u32 fw_version;
1814 u32 lowest_supported_fw_version;
1815 u32 capsule_flags;
1816 u32 last_attempt_version;
1817 u32 last_attempt_status;
1818} __packed;
1819
1820struct efi_system_resource_table {
1821 u32 fw_resource_count;
1822 u32 fw_resource_count_max;
1823 u64 fw_resource_version;
1824 struct efi_system_resource_entry entries[];
1825} __packed;
1826
454568b4
AT		 1827/* Boot manager load options */
1828#define LOAD_OPTION_ACTIVE 0x00000001
1829#define LOAD_OPTION_FORCE_RECONNECT 0x00000002
1830#define LOAD_OPTION_HIDDEN 0x00000008
1831/* All values 0x00000200-0x00001F00 are reserved */
1832#define LOAD_OPTION_CATEGORY 0x00001F00
1833#define LOAD_OPTION_CATEGORY_BOOT 0x00000000
1834#define LOAD_OPTION_CATEGORY_APP 0x00000100
1835
b74d568d
AT		 1836/*
1837 * System Resource Table
1838 */
1839/* Firmware Type Definitions */
1840#define ESRT_FW_TYPE_UNKNOWN 0x00000000
1841#define ESRT_FW_TYPE_SYSTEMFIRMWARE 0x00000001
1842#define ESRT_FW_TYPE_DEVICEFIRMWARE 0x00000002
1843#define ESRT_FW_TYPE_UEFIDRIVER 0x00000003
1844
64a8aae1
JM		 1845#define EFI_SYSTEM_RESOURCE_TABLE_GUID\
1846 EFI_GUID(0xb122a263, 0x3661, 0x4f68,\
1847 0x99, 0x29, 0x78, 0xf8, 0xb0, 0xd6, 0x21, 0x80)
1848
b74d568d
AT		 1849/* Last Attempt Status Values */
1850#define LAST_ATTEMPT_STATUS_SUCCESS 0x00000000
1851#define LAST_ATTEMPT_STATUS_ERROR_UNSUCCESSFUL 0x00000001
1852#define LAST_ATTEMPT_STATUS_ERROR_INSUFFICIENT_RESOURCES 0x00000002
1853#define LAST_ATTEMPT_STATUS_ERROR_INCORRECT_VERSION 0x00000003
1854#define LAST_ATTEMPT_STATUS_ERROR_INVALID_FORMAT 0x00000004
1855#define LAST_ATTEMPT_STATUS_ERROR_AUTH_ERROR 0x00000005
1856#define LAST_ATTEMPT_STATUS_ERROR_PWR_EVT_AC 0x00000006
1857#define LAST_ATTEMPT_STATUS_ERROR_PWR_EVT_BATT 0x00000007
1858#define LAST_ATTEMPT_STATUS_ERROR_UNSATISFIED_DEPENDENCIES 0x00000008
1859
1860/*
1861 * The LastAttemptStatus values of 0x1000 - 0x4000 are reserved for vendor
1862 * usage.
1863 */
1864#define LAST_ATTEMPT_STATUS_ERROR_UNSUCCESSFUL_VENDOR_RANGE_MIN 0x00001000
1865#define LAST_ATTEMPT_STATUS_ERROR_UNSUCCESSFUL_VENDOR_RANGE_MAX 0x00004000
1866
593e17d6 1867/* Certificate types in signature database */
4b634313
IA		 1868#define EFI_CERT_SHA1_GUID \
1869 EFI_GUID(0x826ca512, 0xcf10, 0x4ac9, 0xb1, 0x87, \
1870 0xbe, 0x01, 0x49, 0x66, 0x31, 0xbd)
1871#define EFI_CERT_SHA224_GUID \
1872 EFI_GUID(0xb6e5233, 0xa65c, 0x44c9, 0x94, 0x07, \
1873 0xd9, 0xab, 0x83, 0xbf, 0xc8, 0xbd)
593e17d6
AT		 1874#define EFI_CERT_SHA256_GUID \
1875 EFI_GUID(0xc1c41626, 0x504c, 0x4092, 0xac, 0xa9, \
1876 0x41, 0xf9, 0x36, 0x93, 0x43, 0x28)
4b634313
IA		 1877#define EFI_CERT_SHA384_GUID \
1878 EFI_GUID(0xff3e5307, 0x9fd0, 0x48c9, 0x85, 0xf1, \
1879 0x8a, 0xd5, 0x6c, 0x70, 0x1e, 0x01)
1880#define EFI_CERT_SHA512_GUID \
1881 EFI_GUID(0x93e0fae, 0xa6c4, 0x4f50, 0x9f, 0x1b, \
1882 0xd4, 0x1e, 0x2b, 0x89, 0xc1, 0x9a)
593e17d6
AT		 1883#define EFI_CERT_RSA2048_GUID \
1884 EFI_GUID(0x3c5766e8, 0x269c, 0x4e34, 0xaa, 0x14, \
1885 0xed, 0x77, 0x6e, 0x85, 0xb3, 0xb6)
1886#define EFI_CERT_X509_GUID \
1887 EFI_GUID(0xa5c059a1, 0x94e4, 0x4aa7, 0x87, 0xb5, \
1888 0xab, 0x15, 0x5c, 0x2b, 0xf0, 0x72)
1889#define EFI_CERT_X509_SHA256_GUID \
1890 EFI_GUID(0x3bd2a492, 0x96c0, 0x4079, 0xb4, 0x20, \
1891 0xfc, 0xf9, 0x8e, 0xf1, 0x03, 0xed)
b436cc6a
IA		 1892#define EFI_CERT_X509_SHA384_GUID \
1893 EFI_GUID(0x7076876e, 0x80c2, 0x4ee6, \
1894 0xaa, 0xd2, 0x28, 0xb3, 0x49, 0xa6, 0x86, 0x5b)
1895#define EFI_CERT_X509_SHA512_GUID \
1896 EFI_GUID(0x446dbf63, 0x2502, 0x4cda, \
1897 0xbc, 0xfa, 0x24, 0x65, 0xd2, 0xb0, 0xfe, 0x9d)
593e17d6
AT		 1898#define EFI_CERT_TYPE_PKCS7_GUID \
1899 EFI_GUID(0x4aafd29d, 0x68df, 0x49ee, 0x8a, 0xa9, \
1900 0x34, 0x7d, 0x37, 0x56, 0x65, 0xa7)
1901
1902/**
e032cb2a 1903 * struct win_certificate_uefi_guid - A certificate that encapsulates
593e17d6
AT		 1904 * a GUID-specific signature
1905 *
1906 * @hdr: Windows certificate header
1907 * @cert_type: Certificate type
1908 * @cert_data: Certificate data
1909 */
1910struct win_certificate_uefi_guid {
1911 WIN_CERTIFICATE hdr;
1912 efi_guid_t cert_type;
1913 u8 cert_data[];
1914} __attribute__((__packed__));
1915
1916/**
e032cb2a 1917 * struct efi_variable_authentication_2 - A time-based authentication method
593e17d6
AT		 1918 * descriptor
1919 *
1920 * This structure describes an authentication information for
1921 * a variable with EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
1922 * and should be included as part of a variable's value.
1923 * Only EFI_CERT_TYPE_PKCS7_GUID is accepted.
1924 *
1925 * @time_stamp: Descriptor's time stamp
1926 * @auth_info: Authentication info
1927 */
1928struct efi_variable_authentication_2 {
1929 struct efi_time time_stamp;
1930 struct win_certificate_uefi_guid auth_info;
1931} __attribute__((__packed__));
1932
04be98bd 1933/**
e032cb2a 1934 * struct efi_firmware_image_authentication - Capsule authentication method
04be98bd
SG		 1935 * descriptor
1936 *
1937 * This structure describes an authentication information for
1938 * a capsule with IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED set
1939 * and should be included as part of the capsule.
1940 * Only EFI_CERT_TYPE_PKCS7_GUID is accepted.
1941 *
1942 * @monotonic_count: Count to prevent replay
1943 * @auth_info: Authentication info
1944 */
1945struct efi_firmware_image_authentication {
1946 uint64_t monotonic_count;
1947 struct win_certificate_uefi_guid auth_info;
1948} __attribute__((__packed__));
1949
1950
593e17d6 1951/**
e032cb2a 1952 * struct efi_signature_data - A format of signature
593e17d6
AT		 1953 *
1954 * This structure describes a single signature in signature database.
1955 *
1956 * @signature_owner: Signature owner
1957 * @signature_data: Signature data
1958 */
1959struct efi_signature_data {
1960 efi_guid_t signature_owner;
1961 u8 signature_data[];
1962} __attribute__((__packed__));
1963
1964/**
e032cb2a 1965 * struct efi_signature_list - A format of signature database
593e17d6
AT		 1966 *
1967 * This structure describes a list of signatures with the same type.
1968 * An authenticated variable's value is a concatenation of one or more
1969 * efi_signature_list's.
1970 *
1971 * @signature_type: Signature type
1972 * @signature_list_size: Size of signature list
1973 * @signature_header_size: Size of signature header
1974 * @signature_size: Size of signature
1975 */
1976struct efi_signature_list {
1977 efi_guid_t signature_type;
1978 u32 signature_list_size;
1979 u32 signature_header_size;
1980 u32 signature_size;
1981/* u8 signature_header[signature_header_size]; */
1982/* struct efi_signature_data signatures[...][signature_size]; */
1983} __attribute__((__packed__));
1984
8d99026f
AT		 1985/*
1986 * Firmware management protocol
1987 */
1988#define EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GUID \
1989 EFI_GUID(0x86c77a67, 0x0b97, 0x4633, 0xa1, 0x87, \
1990 0x49, 0x10, 0x4d, 0x06, 0x85, 0xc7)
1991
1992#define IMAGE_ATTRIBUTE_IMAGE_UPDATABLE 0x0000000000000001
1993#define IMAGE_ATTRIBUTE_RESET_REQUIRED 0x0000000000000002
1994#define IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED 0x0000000000000004
1995#define IMAGE_ATTRIBUTE_IN_USE 0x0000000000000008
1996#define IMAGE_ATTRIBUTE_UEFI_IMAGE 0x0000000000000010
1997#define IMAGE_ATTRIBUTE_DEPENDENCY 0x0000000000000020
1998
1999#define IMAGE_COMPATIBILITY_CHECK_SUPPORTED 0x0000000000000001
2000
2001#define IMAGE_UPDATABLE_VALID 0x0000000000000001
2002#define IMAGE_UPDATABLE_INVALID 0x0000000000000002
2003#define IMAGE_UPDATABLE_INVALID_TYPE 0x0000000000000004
2004#define IMAGE_UPDATABLE_INVALID_OLLD 0x0000000000000008
2005#define IMAGE_UPDATABLE_VALID_WITH_VENDOR_CODE 0x0000000000000010
2006
2007#define PACKAGE_ATTRIBUTE_VERSION_UPDATABLE 0x0000000000000001
2008#define PACKAGE_ATTRIBUTE_RESET_REQUIRED 0x0000000000000002
2009#define PACKAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED 0x0000000000000004
2010
2011#define EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION 4
2012
2013typedef struct efi_firmware_image_dependencies {
2014 u8 dependencies[0];
2015} efi_firmware_image_dep_t;
2016
2017struct efi_firmware_image_descriptor {
2018 u8 image_index;
2019 efi_guid_t image_type_id;
2020 u64 image_id;
2021 u16 *image_id_name;
2022 u32 version;
2023 u16 *version_name;
2024 efi_uintn_t size;
2025 u64 attributes_supported;
2026 u64 attributes_setting;
2027 u64 compatibilities;
2028 u32 lowest_supported_image_version;
2029 u32 last_attempt_version;
2030 u32 last_attempt_status;
2031 u64 hardware_instance;
2032 efi_firmware_image_dep_t *dependencies;
2033};
2034
2035struct efi_firmware_management_protocol {
2036 efi_status_t (EFIAPI *get_image_info)(
2037 struct efi_firmware_management_protocol *this,
2038 efi_uintn_t *image_info_size,
2039 struct efi_firmware_image_descriptor *image_info,
2040 u32 *descriptor_version,
2041 u8 *descriptor_count,
2042 efi_uintn_t *descriptor_size,
2043 u32 *package_version,
2044 u16 **package_version_name);
2045 efi_status_t (EFIAPI *get_image)(
2046 struct efi_firmware_management_protocol *this,
2047 u8 image_index,
2048 void *image,
2049 efi_uintn_t *image_size);
2050 efi_status_t (EFIAPI *set_image)(
2051 struct efi_firmware_management_protocol *this,
2052 u8 image_index,
2053 const void *image,
2054 efi_uintn_t image_size,
2055 const void *vendor_code,
2056 efi_status_t (*progress)(efi_uintn_t completion),
2057 u16 **abort_reason);
2058 efi_status_t (EFIAPI *check_image)(
2059 struct efi_firmware_management_protocol *this,
2060 u8 image_index,
2061 const void *image,
2062 efi_uintn_t *image_size,
2063 u32 *image_updatable);
2064 efi_status_t (EFIAPI *get_package_info)(
2065 struct efi_firmware_management_protocol *this,
2066 u32 *package_version,
2067 u16 **package_version_name,
2068 u32 *package_version_name_maxlen,
2069 u64 *attributes_supported,
2070 u64 *attributes_setting);
2071 efi_status_t (EFIAPI *set_package_info)(
2072 struct efi_firmware_management_protocol *this,
2073 const void *image,
2074 efi_uintn_t *image_size,
2075 const void *vendor_code,
2076 u32 package_version,
2077 const u16 *package_version_name);
2078};
2079
613cd0c4
SG		 2080#define EFI_DISK_IO_PROTOCOL_GUID \
2081 EFI_GUID(0xce345171, 0xba0b, 0x11d2, 0x8e, 0x4f, \
2082 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
2083
2084struct efi_disk {
2085 u64 revision;
2086 efi_status_t (EFIAPI *read_disk)(struct efi_disk *this, u32 media_id,
2087 u64 offset, efi_uintn_t buffer_size,
2088 void *buffer);
2089
2090 efi_status_t (EFIAPI *write_disk)(struct efi_disk *this, u32 media_id,
2091 u64 offset, efi_uintn_t buffer_size,
2092 void *buffer);
2093};
2094
867a6ac8 2095#endif
Empty description
This page took 0.712794 seconds and 4 git commands to generate.