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