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