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