]> 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
efi_loader: Initial HII database protocols
[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>
867a6ac8 21
a86aeaf2
AG		 22#ifdef CONFIG_EFI_LOADER
23#include <asm/setjmp.h>
24#endif
25
112f2430
HS		 26/* UEFI spec version 2.7 */
27#define EFI_SPECIFICATION_VERSION (2 << 16 | 70)
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;
503f2695 42
c6841592
HS		 43#define EVT_TIMER 0x80000000
44#define EVT_RUNTIME 0x40000000
45#define EVT_NOTIFY_WAIT 0x00000100
46#define EVT_NOTIFY_SIGNAL 0x00000200
47#define EVT_SIGNAL_EXIT_BOOT_SERVICES 0x00000201
48#define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE 0x60000202
49
50#define TPL_APPLICATION 0x04
51#define TPL_CALLBACK 0x08
52#define TPL_NOTIFY 0x10
53#define TPL_HIGH_LEVEL 0x1F
37a980b3 54
2fd945fe
HS		 55struct efi_event;
56
867a6ac8 57/* EFI Boot Services table */
112f2430 58#define EFI_BOOT_SERVICES_SIGNATURE 0x56524553544f4f42
867a6ac8
SG		 59struct efi_boot_services {
60 struct efi_table_hdr hdr;
152cade3
HS		 61 efi_status_t (EFIAPI *raise_tpl)(efi_uintn_t new_tpl);
62 void (EFIAPI *restore_tpl)(efi_uintn_t old_tpl);
867a6ac8 63
f5a2a938 64 efi_status_t (EFIAPI *allocate_pages)(int, int, efi_uintn_t,
867a6ac8 65 efi_physical_addr_t *);
f5a2a938
HS		 66 efi_status_t (EFIAPI *free_pages)(efi_physical_addr_t, efi_uintn_t);
67 efi_status_t (EFIAPI *get_memory_map)(efi_uintn_t *memory_map_size,
68 struct efi_mem_desc *desc,
69 efi_uintn_t *key,
70 efi_uintn_t *desc_size,
71 u32 *desc_version);
72 efi_status_t (EFIAPI *allocate_pool)(int, efi_uintn_t, void **);
867a6ac8
SG		 73 efi_status_t (EFIAPI *free_pool)(void *);
74
b521d29e 75 efi_status_t (EFIAPI *create_event)(uint32_t type,
152cade3 76 efi_uintn_t notify_tpl,
2fd945fe
HS		 77 void (EFIAPI *notify_function) (
78 struct efi_event *event,
79 void *context),
80 void *notify_context, struct efi_event **event);
b521d29e
HS		 81 efi_status_t (EFIAPI *set_timer)(struct efi_event *event,
82 enum efi_timer_delay type,
83 uint64_t trigger_time);
f5a2a938
HS		 84 efi_status_t (EFIAPI *wait_for_event)(efi_uintn_t number_of_events,
85 struct efi_event **event,
86 efi_uintn_t *index);
2fd945fe
HS		 87 efi_status_t (EFIAPI *signal_event)(struct efi_event *event);
88 efi_status_t (EFIAPI *close_event)(struct efi_event *event);
89 efi_status_t (EFIAPI *check_event)(struct efi_event *event);
e0549f8a 90#define EFI_NATIVE_INTERFACE 0x00000000
2bb9b79d 91 efi_status_t (EFIAPI *install_protocol_interface)(
faea1041 92 efi_handle_t *handle, const efi_guid_t *protocol,
2bb9b79d
AG		 93 int protocol_interface_type, void *protocol_interface);
94 efi_status_t (EFIAPI *reinstall_protocol_interface)(
faea1041 95 efi_handle_t handle, const efi_guid_t *protocol,
2bb9b79d 96 void *old_interface, void *new_interface);
2074f700
HS		 97 efi_status_t (EFIAPI *uninstall_protocol_interface)(
98 efi_handle_t handle, const efi_guid_t *protocol,
99 void *protocol_interface);
100 efi_status_t (EFIAPI *handle_protocol)(
101 efi_handle_t handle, const efi_guid_t *protocol,
102 void **protocol_interface);
867a6ac8 103 void *reserved;
2bb9b79d 104 efi_status_t (EFIAPI *register_protocol_notify)(
5a9682d0 105 const efi_guid_t *protocol, struct efi_event *event,
2bb9b79d 106 void **registration);
867a6ac8
SG		 107 efi_status_t (EFIAPI *locate_handle)(
108 enum efi_locate_search_type search_type,
5a9682d0 109 const efi_guid_t *protocol, void *search_key,
f5a2a938 110 efi_uintn_t *buffer_size, efi_handle_t *buffer);
5a9682d0 111 efi_status_t (EFIAPI *locate_device_path)(const efi_guid_t *protocol,
867a6ac8
SG		 112 struct efi_device_path **device_path,
113 efi_handle_t *device);
2bb9b79d
AG		 114 efi_status_t (EFIAPI *install_configuration_table)(
115 efi_guid_t *guid, void *table);
867a6ac8
SG		 116
117 efi_status_t (EFIAPI *load_image)(bool boot_policiy,
118 efi_handle_t parent_image,
119 struct efi_device_path *file_path, void *source_buffer,
7fb96a10 120 efi_uintn_t source_size, efi_handle_t *image);
867a6ac8 121 efi_status_t (EFIAPI *start_image)(efi_handle_t handle,
cc8e3417
HS		 122 efi_uintn_t *exitdata_size,
123 u16 **exitdata);
867a6ac8
SG		 124 efi_status_t (EFIAPI *exit)(efi_handle_t handle,
125 efi_status_t exit_status,
cc8e3417 126 efi_uintn_t exitdata_size, u16 *exitdata);
2074f700 127 efi_status_t (EFIAPI *unload_image)(efi_handle_t image_handle);
867a6ac8
SG		 128 efi_status_t (EFIAPI *exit_boot_services)(efi_handle_t, unsigned long);
129
130 efi_status_t (EFIAPI *get_next_monotonic_count)(u64 *count);
131 efi_status_t (EFIAPI *stall)(unsigned long usecs);
2bb9b79d
AG		 132 efi_status_t (EFIAPI *set_watchdog_timer)(unsigned long timeout,
133 uint64_t watchdog_code, unsigned long data_size,
134 uint16_t *watchdog_data);
867a6ac8
SG		 135 efi_status_t(EFIAPI *connect_controller)(efi_handle_t controller_handle,
136 efi_handle_t *driver_image_handle,
137 struct efi_device_path *remaining_device_path,
138 bool recursive);
3ebcd007
HS		 139 efi_status_t (EFIAPI *disconnect_controller)(
140 efi_handle_t controller_handle,
141 efi_handle_t driver_image_handle,
142 efi_handle_t child_handle);
867a6ac8
SG		 143#define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001
144#define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002
145#define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004
146#define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008
147#define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010
148#define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020
149 efi_status_t (EFIAPI *open_protocol)(efi_handle_t handle,
5a9682d0 150 const efi_guid_t *protocol, void **interface,
867a6ac8
SG		 151 efi_handle_t agent_handle,
152 efi_handle_t controller_handle, u32 attributes);
2074f700
HS		 153 efi_status_t (EFIAPI *close_protocol)(
154 efi_handle_t handle, const efi_guid_t *protocol,
155 efi_handle_t agent_handle,
156 efi_handle_t controller_handle);
867a6ac8 157 efi_status_t(EFIAPI *open_protocol_information)(efi_handle_t handle,
5a9682d0 158 const efi_guid_t *protocol,
867a6ac8 159 struct efi_open_protocol_info_entry **entry_buffer,
f5a2a938 160 efi_uintn_t *entry_count);
867a6ac8
SG		 161 efi_status_t (EFIAPI *protocols_per_handle)(efi_handle_t handle,
162 efi_guid_t ***protocol_buffer,
f5a2a938 163 efi_uintn_t *protocols_buffer_count);
867a6ac8
SG		 164 efi_status_t (EFIAPI *locate_handle_buffer) (
165 enum efi_locate_search_type search_type,
5a9682d0 166 const efi_guid_t *protocol, void *search_key,
f5a2a938 167 efi_uintn_t *no_handles, efi_handle_t **buffer);
5a9682d0 168 efi_status_t (EFIAPI *locate_protocol)(const efi_guid_t *protocol,
2bb9b79d
AG		 169 void *registration, void **protocol_interface);
170 efi_status_t (EFIAPI *install_multiple_protocol_interfaces)(
faea1041 171 efi_handle_t *handle, ...);
2bb9b79d 172 efi_status_t (EFIAPI *uninstall_multiple_protocol_interfaces)(
faea1041 173 efi_handle_t handle, ...);
8aa8360e
HS		 174 efi_status_t (EFIAPI *calculate_crc32)(const void *data,
175 efi_uintn_t data_size,
176 u32 *crc32);
fc05a959
HS		 177 void (EFIAPI *copy_mem)(void *destination, const void *source,
178 size_t length);
179 void (EFIAPI *set_mem)(void *buffer, size_t size, uint8_t value);
9f0930e5
HS		 180 efi_status_t (EFIAPI *create_event_ex)(
181 uint32_t type, efi_uintn_t notify_tpl,
182 void (EFIAPI *notify_function) (
183 struct efi_event *event,
184 void *context),
185 void *notify_context,
186 efi_guid_t *event_group,
187 struct efi_event **event);
867a6ac8
SG		 188};
189
190/* Types and defines for EFI ResetSystem */
191enum efi_reset_type {
192 EFI_RESET_COLD = 0,
193 EFI_RESET_WARM = 1,
482fc90c
HS		 194 EFI_RESET_SHUTDOWN = 2,
195 EFI_RESET_PLATFORM_SPECIFIC = 3,
867a6ac8
SG		 196};
197
198/* EFI Runtime Services table */
bdfb894a 199#define EFI_RUNTIME_SERVICES_SIGNATURE 0x56524553544e5552ULL
867a6ac8 200
0c230743
HS		 201#define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000
202#define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE 0x00020000
203#define CAPSULE_FLAGS_INITIATE_RESET 0x00040000
204
205struct efi_capsule_header {
206 efi_guid_t *capsule_guid;
207 u32 header_size;
208 u32 flags;
209 u32 capsule_image_size;
210};
211
867a6ac8
SG		 212struct efi_runtime_services {
213 struct efi_table_hdr hdr;
2bb9b79d
AG		 214 efi_status_t (EFIAPI *get_time)(struct efi_time *time,
215 struct efi_time_cap *capabilities);
216 efi_status_t (EFIAPI *set_time)(struct efi_time *time);
217 efi_status_t (EFIAPI *get_wakeup_time)(char *enabled, char *pending,
218 struct efi_time *time);
219 efi_status_t (EFIAPI *set_wakeup_time)(char enabled,
220 struct efi_time *time);
221 efi_status_t (EFIAPI *set_virtual_address_map)(
222 unsigned long memory_map_size,
223 unsigned long descriptor_size,
224 uint32_t descriptor_version,
225 struct efi_mem_desc *virtmap);
226 efi_status_t (*convert_pointer)(unsigned long dbg, void **address);
45c66f9c 227 efi_status_t (EFIAPI *get_variable)(u16 *variable_name,
0bda81bf
HS		 228 const efi_guid_t *vendor,
229 u32 *attributes,
45c66f9c
HS		 230 efi_uintn_t *data_size, void *data);
231 efi_status_t (EFIAPI *get_next_variable_name)(
232 efi_uintn_t *variable_name_size,
0bda81bf 233 u16 *variable_name, const efi_guid_t *vendor);
45c66f9c 234 efi_status_t (EFIAPI *set_variable)(u16 *variable_name,
0bda81bf
HS		 235 const efi_guid_t *vendor,
236 u32 attributes,
452257a3
HS		 237 efi_uintn_t data_size,
238 const void *data);
2bb9b79d
AG		 239 efi_status_t (EFIAPI *get_next_high_mono_count)(
240 uint32_t *high_count);
867a6ac8
SG		 241 void (EFIAPI *reset_system)(enum efi_reset_type reset_type,
242 efi_status_t reset_status,
243 unsigned long data_size, void *reset_data);
0c230743
HS		 244 efi_status_t (EFIAPI *update_capsule)(
245 struct efi_capsule_header **capsule_header_array,
246 efi_uintn_t capsule_count,
247 u64 scatter_gather_list);
248 efi_status_t (EFIAPI *query_capsule_caps)(
249 struct efi_capsule_header **capsule_header_array,
250 efi_uintn_t capsule_count,
19dd9074
AT		 251 u64 *maximum_capsule_size,
252 u32 *reset_type);
0c230743
HS		 253 efi_status_t (EFIAPI *query_variable_info)(
254 u32 attributes,
45c66f9c
HS		 255 u64 *maximum_variable_storage_size,
256 u64 *remaining_variable_storage_size,
257 u64 *maximum_variable_size);
867a6ac8
SG		 258};
259
a3a28f5f
HS		 260/* EFI event group GUID definitions */
261#define EFI_EVENT_GROUP_EXIT_BOOT_SERVICES \
262 EFI_GUID(0x27abf055, 0xb1b8, 0x4c26, 0x80, 0x48, \
263 0x74, 0x8f, 0x37, 0xba, 0xa2, 0xdf)
264
265#define EFI_EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE \
266 EFI_GUID(0x13fa7698, 0xc831, 0x49c7, 0x87, 0xea, \
267 0x8f, 0x43, 0xfc, 0xc2, 0x51, 0x96)
268
269#define EFI_EVENT_GROUP_MEMORY_MAP_CHANGE \
270 EFI_GUID(0x78bee926, 0x692f, 0x48fd, 0x9e, 0xdb, \
271 0x01, 0x42, 0x2e, 0xf0, 0xd7, 0xab)
272
273#define EFI_EVENT_GROUP_READY_TO_BOOT \
274 EFI_GUID(0x7ce88fb3, 0x4bd7, 0x4679, 0x87, 0xa8, \
275 0xa8, 0xd8, 0xde, 0xe5, 0x0d, 0x2b)
276
277#define EFI_EVENT_GROUP_RESET_SYSTEM \
278 EFI_GUID(0x62da6a56, 0x13fb, 0x485a, 0xa8, 0xda, \
279 0xa3, 0xdd, 0x79, 0x12, 0xcb, 0x6b)
280
867a6ac8
SG		 281/* EFI Configuration Table and GUID definitions */
282#define NULL_GUID \
283 EFI_GUID(0x00000000, 0x0000, 0x0000, 0x00, 0x00, \
284 0x00, 0x00, 0x00, 0x00, 0x00, 0x00)
285
9975fe96
RC		 286#define EFI_GLOBAL_VARIABLE_GUID \
287 EFI_GUID(0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, \
288 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c)
289
867a6ac8
SG		 290#define LOADED_IMAGE_PROTOCOL_GUID \
291 EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, \
292 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
293
2bb9b79d
AG		 294#define EFI_FDT_GUID \
295 EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5, \
296 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0)
297
86df34d4
BM		 298#define EFI_ACPI_TABLE_GUID \
299 EFI_GUID(0x8868e871, 0xe4f1, 0x11d3, \
300 0xbc, 0x22, 0x00, 0x80, 0xc7, 0x3c, 0x88, 0x81)
301
e663b350
AG		 302#define SMBIOS_TABLE_GUID \
303 EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3, \
304 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
305
2e0d79a0 306struct efi_configuration_table {
2bb9b79d
AG		 307 efi_guid_t guid;
308 void *table;
2859f446 309} __packed;
2bb9b79d
AG		 310
311#define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
312
867a6ac8
SG		 313struct efi_system_table {
314 struct efi_table_hdr hdr;
0b386537 315 u16 *fw_vendor; /* physical addr of wchar_t vendor string */
867a6ac8 316 u32 fw_revision;
cc20ed03 317 efi_handle_t con_in_handle;
3e603ec7 318 struct efi_simple_text_input_protocol *con_in;
cc20ed03 319 efi_handle_t con_out_handle;
867a6ac8 320 struct efi_simple_text_output_protocol *con_out;
cc20ed03 321 efi_handle_t stderr_handle;
2bb9b79d 322 struct efi_simple_text_output_protocol *std_err;
867a6ac8
SG		 323 struct efi_runtime_services *runtime;
324 struct efi_boot_services *boottime;
f5a2a938 325 efi_uintn_t nr_tables;
2bb9b79d 326 struct efi_configuration_table *tables;
867a6ac8
SG		 327};
328
2bb9b79d
AG		 329#define LOADED_IMAGE_GUID \
330 EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, \
331 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
332
95147313
HS		 333#define EFI_LOADED_IMAGE_PROTOCOL_REVISION 0x1000
334
867a6ac8
SG		 335struct efi_loaded_image {
336 u32 revision;
337 void *parent_handle;
338 struct efi_system_table *system_table;
43dace5d
HS		 339 efi_handle_t device_handle;
340 struct efi_device_path *file_path;
867a6ac8
SG		 341 void *reserved;
342 u32 load_options_size;
343 void *load_options;
344 void *image_base;
345 aligned_u64 image_size;
346 unsigned int image_code_type;
347 unsigned int image_data_type;
348 unsigned long unload;
349};
350
2bb9b79d
AG		 351#define DEVICE_PATH_GUID \
352 EFI_GUID(0x09576e91, 0x6d3f, 0x11d2, \
2e0d79a0 353 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
2bb9b79d
AG		 354
355#define DEVICE_PATH_TYPE_END 0x7f
3acef5da 356# define DEVICE_PATH_SUB_TYPE_INSTANCE_END 0x01
2bb9b79d
AG		 357# define DEVICE_PATH_SUB_TYPE_END 0xff
358
867a6ac8
SG		 359struct efi_device_path {
360 u8 type;
361 u8 sub_type;
362 u16 length;
a8606ef0 363} __packed;
867a6ac8 364
d7608aba
OT		 365struct efi_mac_addr {
366 u8 addr[32];
a8606ef0 367} __packed;
d7608aba 368
c80214ce 369#define DEVICE_PATH_TYPE_HARDWARE_DEVICE 0x01
bf19273e 370# define DEVICE_PATH_SUB_TYPE_MEMORY 0x03
c80214ce
PJ		 371# define DEVICE_PATH_SUB_TYPE_VENDOR 0x04
372
bf19273e
RC		 373struct efi_device_path_memory {
374 struct efi_device_path dp;
375 u32 memory_type;
376 u64 start_address;
377 u64 end_address;
378} __packed;
379
c80214ce
PJ		 380struct efi_device_path_vendor {
381 struct efi_device_path dp;
382 efi_guid_t guid;
383 u8 vendor_data[];
384} __packed;
385
386#define DEVICE_PATH_TYPE_ACPI_DEVICE 0x02
387# define DEVICE_PATH_SUB_TYPE_ACPI_DEVICE 0x01
388
389#define EFI_PNP_ID(ID) (u32)(((ID) << 16) | 0x41D0)
390#define EISA_PNP_ID(ID) EFI_PNP_ID(ID)
adae4313 391#define EISA_PNP_NUM(ID) ((ID) >> 16)
c80214ce
PJ		 392
393struct efi_device_path_acpi_path {
394 struct efi_device_path dp;
395 u32 hid;
396 u32 uid;
397} __packed;
398
d7608aba 399#define DEVICE_PATH_TYPE_MESSAGING_DEVICE 0x03
af3106a1
HS		 400# define DEVICE_PATH_SUB_TYPE_MSG_ATAPI 0x01
401# define DEVICE_PATH_SUB_TYPE_MSG_SCSI 0x02
c80214ce 402# define DEVICE_PATH_SUB_TYPE_MSG_USB 0x05
d7608aba 403# define DEVICE_PATH_SUB_TYPE_MSG_MAC_ADDR 0x0b
b66c60dd 404# define DEVICE_PATH_SUB_TYPE_MSG_USB_CLASS 0x0f
c80214ce
PJ		 405# define DEVICE_PATH_SUB_TYPE_MSG_SD 0x1a
406# define DEVICE_PATH_SUB_TYPE_MSG_MMC 0x1d
407
af3106a1
HS		 408struct efi_device_path_atapi {
409 struct efi_device_path dp;
410 u8 primary_secondary;
411 u8 slave_master;
412 u16 logical_unit_number;
413} __packed;
414
415struct efi_device_path_scsi {
416 struct efi_device_path dp;
417 u16 target_id;
418 u16 logical_unit_number;
419} __packed;
420
c80214ce
PJ		 421struct efi_device_path_usb {
422 struct efi_device_path dp;
423 u8 parent_port_number;
424 u8 usb_interface;
425} __packed;
d7608aba
OT		 426
427struct efi_device_path_mac_addr {
428 struct efi_device_path dp;
429 struct efi_mac_addr mac;
430 u8 if_type;
a8606ef0 431} __packed;
d7608aba 432
b66c60dd
RC		 433struct efi_device_path_usb_class {
434 struct efi_device_path dp;
435 u16 vendor_id;
436 u16 product_id;
437 u8 device_class;
438 u8 device_subclass;
439 u8 device_protocol;
440} __packed;
441
c80214ce
PJ		 442struct efi_device_path_sd_mmc_path {
443 struct efi_device_path dp;
444 u8 slot_number;
445} __packed;
446
2bb9b79d 447#define DEVICE_PATH_TYPE_MEDIA_DEVICE 0x04
c80214ce
PJ		 448# define DEVICE_PATH_SUB_TYPE_HARD_DRIVE_PATH 0x01
449# define DEVICE_PATH_SUB_TYPE_CDROM_PATH 0x02
2bb9b79d
AG		 450# define DEVICE_PATH_SUB_TYPE_FILE_PATH 0x04
451
c80214ce
PJ		 452struct efi_device_path_hard_drive_path {
453 struct efi_device_path dp;
454 u32 partition_number;
455 u64 partition_start;
456 u64 partition_end;
457 u8 partition_signature[16];
458 u8 partmap_type;
459 u8 signature_type;
460} __packed;
461
462struct efi_device_path_cdrom_path {
463 struct efi_device_path dp;
464 u32 boot_entry;
465 u64 partition_start;
466 u64 partition_end;
467} __packed;
468
2bb9b79d
AG		 469struct efi_device_path_file_path {
470 struct efi_device_path dp;
61b7e224 471 u16 str[];
a8606ef0 472} __packed;
2bb9b79d
AG		 473
474#define BLOCK_IO_GUID \
475 EFI_GUID(0x964e5b21, 0x6459, 0x11d2, \
476 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
477
2e0d79a0 478struct efi_block_io_media {
2bb9b79d
AG		 479 u32 media_id;
480 char removable_media;
481 char media_present;
482 char logical_partition;
483 char read_only;
484 char write_caching;
485 u8 pad[3];
486 u32 block_size;
487 u32 io_align;
488 u8 pad2[4];
489 u64 last_block;
4f94865b
HS		 490 /* Added in revision 2 of the protocol */
491 u64 lowest_aligned_lba;
492 u32 logical_blocks_per_physical_block;
493 /* Added in revision 3 of the protocol */
494 u32 optimal_transfer_length_granualarity;
2bb9b79d
AG		 495};
496
4f94865b
HS		 497#define EFI_BLOCK_IO_PROTOCOL_REVISION2 0x00020001
498#define EFI_BLOCK_IO_PROTOCOL_REVISION3 0x0002001f
499
2bb9b79d
AG		 500struct efi_block_io {
501 u64 revision;
502 struct efi_block_io_media *media;
503 efi_status_t (EFIAPI *reset)(struct efi_block_io *this,
504 char extended_verification);
505 efi_status_t (EFIAPI *read_blocks)(struct efi_block_io *this,
4f94865b 506 u32 media_id, u64 lba, efi_uintn_t buffer_size,
2bb9b79d
AG		 507 void *buffer);
508 efi_status_t (EFIAPI *write_blocks)(struct efi_block_io *this,
4f94865b 509 u32 media_id, u64 lba, efi_uintn_t buffer_size,
2bb9b79d
AG		 510 void *buffer);
511 efi_status_t (EFIAPI *flush_blocks)(struct efi_block_io *this);
512};
513
867a6ac8
SG		 514struct simple_text_output_mode {
515 s32 max_mode;
516 s32 mode;
517 s32 attribute;
518 s32 cursor_column;
519 s32 cursor_row;
520 bool cursor_visible;
521};
522
a17e62cc
RC		 523#define EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID \
524 EFI_GUID(0x387477c2, 0x69c7, 0x11d2, \
525 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
526
2d5dc2a5
RC		 527#define EFI_BLACK 0x00
528#define EFI_BLUE 0x01
529#define EFI_GREEN 0x02
530#define EFI_CYAN 0x03
531#define EFI_RED 0x04
532#define EFI_MAGENTA 0x05
533#define EFI_BROWN 0x06
534#define EFI_LIGHTGRAY 0x07
535#define EFI_BRIGHT 0x08
536#define EFI_DARKGRAY 0x08
537#define EFI_LIGHTBLUE 0x09
538#define EFI_LIGHTGREEN 0x0a
539#define EFI_LIGHTCYAN 0x0b
540#define EFI_LIGHTRED 0x0c
541#define EFI_LIGHTMAGENTA 0x0d
542#define EFI_YELLOW 0x0e
543#define EFI_WHITE 0x0f
544#define EFI_BACKGROUND_BLACK 0x00
545#define EFI_BACKGROUND_BLUE 0x10
546#define EFI_BACKGROUND_GREEN 0x20
547#define EFI_BACKGROUND_CYAN 0x30
548#define EFI_BACKGROUND_RED 0x40
549#define EFI_BACKGROUND_MAGENTA 0x50
550#define EFI_BACKGROUND_BROWN 0x60
551#define EFI_BACKGROUND_LIGHTGRAY 0x70
552
553/* extract foreground color from EFI attribute */
554#define EFI_ATTR_FG(attr) ((attr) & 0x07)
555/* treat high bit of FG as bright/bold (similar to edk2) */
556#define EFI_ATTR_BOLD(attr) (((attr) >> 3) & 0x01)
557/* extract background color from EFI attribute */
558#define EFI_ATTR_BG(attr) (((attr) >> 4) & 0x7)
559
867a6ac8
SG		 560struct efi_simple_text_output_protocol {
561 void *reset;
562 efi_status_t (EFIAPI *output_string)(
563 struct efi_simple_text_output_protocol *this,
3a45bc7f 564 const efi_string_t str);
2bb9b79d
AG		 565 efi_status_t (EFIAPI *test_string)(
566 struct efi_simple_text_output_protocol *this,
3a45bc7f 567 const efi_string_t str);
867a6ac8
SG		 568 efi_status_t(EFIAPI *query_mode)(
569 struct efi_simple_text_output_protocol *this,
570 unsigned long mode_number, unsigned long *columns,
571 unsigned long *rows);
572 efi_status_t(EFIAPI *set_mode)(
573 struct efi_simple_text_output_protocol *this,
574 unsigned long mode_number);
575 efi_status_t(EFIAPI *set_attribute)(
576 struct efi_simple_text_output_protocol *this,
577 unsigned long attribute);
578 efi_status_t(EFIAPI *clear_screen) (
579 struct efi_simple_text_output_protocol *this);
580 efi_status_t(EFIAPI *set_cursor_position) (
581 struct efi_simple_text_output_protocol *this,
582 unsigned long column, unsigned long row);
2bb9b79d
AG		 583 efi_status_t(EFIAPI *enable_cursor)(
584 struct efi_simple_text_output_protocol *this,
585 bool enable);
867a6ac8
SG		 586 struct simple_text_output_mode *mode;
587};
588
110c6280
HS		 589#define EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL_GUID \
590 EFI_GUID(0xdd9e7534, 0x7762, 0x4698, \
591 0x8c, 0x14, 0xf5, 0x85, 0x17, 0xa6, 0x25, 0xaa)
592
867a6ac8
SG		 593struct efi_input_key {
594 u16 scan_code;
595 s16 unicode_char;
596};
597
110c6280
HS		 598#define EFI_SHIFT_STATE_INVALID 0x00000000
599#define EFI_RIGHT_SHIFT_PRESSED 0x00000001
600#define EFI_LEFT_SHIFT_PRESSED 0x00000002
601#define EFI_RIGHT_CONTROL_PRESSED 0x00000004
602#define EFI_LEFT_CONTROL_PRESSED 0x00000008
603#define EFI_RIGHT_ALT_PRESSED 0x00000010
604#define EFI_LEFT_ALT_PRESSED 0x00000020
605#define EFI_RIGHT_LOGO_PRESSED 0x00000040
606#define EFI_LEFT_LOGO_PRESSED 0x00000080
607#define EFI_MENU_KEY_PRESSED 0x00000100
608#define EFI_SYS_REQ_PRESSED 0x00000200
609#define EFI_SHIFT_STATE_VALID 0x80000000
610
611#define EFI_TOGGLE_STATE_INVALID 0x00
612#define EFI_SCROLL_LOCK_ACTIVE 0x01
613#define EFI_NUM_LOCK_ACTIVE 0x02
614#define EFI_CAPS_LOCK_ACTIVE 0x04
615#define EFI_KEY_STATE_EXPOSED 0x40
616#define EFI_TOGGLE_STATE_VALID 0x80
617
618struct efi_key_state {
619 u32 key_shift_state;
620 u8 key_toggle_state;
621};
622
623struct efi_key_data {
624 struct efi_input_key key;
625 struct efi_key_state key_state;
626};
627
628struct efi_simple_text_input_ex_protocol {
629 efi_status_t (EFIAPI *reset) (
630 struct efi_simple_text_input_ex_protocol *this,
631 bool extended_verification);
632 efi_status_t (EFIAPI *read_key_stroke_ex) (
633 struct efi_simple_text_input_ex_protocol *this,
634 struct efi_key_data *key_data);
635 struct efi_event *wait_for_key_ex;
636 efi_status_t (EFIAPI *set_state) (
637 struct efi_simple_text_input_ex_protocol *this,
638 u8 key_toggle_state);
639 efi_status_t (EFIAPI *register_key_notify) (
640 struct efi_simple_text_input_ex_protocol *this,
641 struct efi_key_data *key_data,
642 efi_status_t (EFIAPI *key_notify_function)(
643 struct efi_key_data *key_data),
644 void **notify_handle);
645 efi_status_t (EFIAPI *unregister_key_notify) (
646 struct efi_simple_text_input_ex_protocol *this,
647 void *notification_handle);
648};
649
a17e62cc
RC		 650#define EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID \
651 EFI_GUID(0x387477c1, 0x69c7, 0x11d2, \
652 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
653
3e603ec7
HS		 654struct efi_simple_text_input_protocol {
655 efi_status_t(EFIAPI *reset)(struct efi_simple_text_input_protocol *this,
656 bool extended_verification);
867a6ac8 657 efi_status_t(EFIAPI *read_key_stroke)(
3e603ec7 658 struct efi_simple_text_input_protocol *this,
867a6ac8 659 struct efi_input_key *key);
2fd945fe 660 struct efi_event *wait_for_key;
867a6ac8
SG		 661};
662
cc5b7081
HS		 663#define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID \
664 EFI_GUID(0x8b843e20, 0x8132, 0x4852, \
665 0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c)
666
2e0d79a0 667struct efi_device_path_to_text_protocol {
cc5b7081 668 uint16_t *(EFIAPI *convert_device_node_to_text)(
9309a1b7 669 struct efi_device_path *device_node,
cc5b7081
HS		 670 bool display_only,
671 bool allow_shortcuts);
672 uint16_t *(EFIAPI *convert_device_path_to_text)(
9309a1b7 673 struct efi_device_path *device_path,
cc5b7081
HS		 674 bool display_only,
675 bool allow_shortcuts);
676};
677
e70f8dfa
LL		 678#define EFI_DEVICE_PATH_UTILITIES_PROTOCOL_GUID \
679 EFI_GUID(0x0379be4e, 0xd706, 0x437d, \
680 0xb0, 0x37, 0xed, 0xb8, 0x2f, 0xb7, 0x72, 0xa4)
681
682struct efi_device_path_utilities_protocol {
683 efi_uintn_t (EFIAPI *get_device_path_size)(
684 const struct efi_device_path *device_path);
685 struct efi_device_path *(EFIAPI *duplicate_device_path)(
686 const struct efi_device_path *device_path);
687 struct efi_device_path *(EFIAPI *append_device_path)(
688 const struct efi_device_path *src1,
689 const struct efi_device_path *src2);
690 struct efi_device_path *(EFIAPI *append_device_node)(
691 const struct efi_device_path *device_path,
692 const struct efi_device_path *device_node);
693 struct efi_device_path *(EFIAPI *append_device_path_instance)(
694 const struct efi_device_path *device_path,
695 const struct efi_device_path *device_path_instance);
696 struct efi_device_path *(EFIAPI *get_next_device_path_instance)(
697 struct efi_device_path **device_path_instance,
698 efi_uintn_t *device_path_instance_size);
699 bool (EFIAPI *is_device_path_multi_instance)(
700 const struct efi_device_path *device_path);
701 struct efi_device_path *(EFIAPI *create_device_node)(
702 uint8_t node_type,
703 uint8_t node_sub_type,
704 uint16_t node_length);
705};
706
c9bfb222
LL		 707/*
708 * Human Interface Infrastructure (HII)
709 */
710struct efi_hii_package_list_header {
711 efi_guid_t package_list_guid;
712 u32 package_length;
713} __packed;
714
715/**
716 * struct efi_hii_package_header - EFI HII package header
717 *
718 * @fields: 'fields' replaces the bit-fields defined in the EFI
719 * specification to to avoid possible compiler incompatibilities::
720 *
721 * u32 length:24;
722 * u32 type:8;
723 */
724struct efi_hii_package_header {
725 u32 fields;
726} __packed;
727
728#define __EFI_HII_PACKAGE_LEN_SHIFT 0
729#define __EFI_HII_PACKAGE_TYPE_SHIFT 24
730#define __EFI_HII_PACKAGE_LEN_MASK 0xffffff
731#define __EFI_HII_PACKAGE_TYPE_MASK 0xff
732
733#define EFI_HII_PACKAGE_TYPE_ALL 0x00
734#define EFI_HII_PACKAGE_TYPE_GUID 0x01
735#define EFI_HII_PACKAGE_FORMS 0x02
736#define EFI_HII_PACKAGE_STRINGS 0x04
737#define EFI_HII_PACKAGE_FONTS 0x05
738#define EFI_HII_PACKAGE_IMAGES 0x06
739#define EFI_HII_PACKAGE_SIMPLE_FONTS 0x07
740#define EFI_HII_PACKAGE_DEVICE_PATH 0x08
741#define EFI_HII_PACKAGE_KEYBOARD_LAYOUT 0x09
742#define EFI_HII_PACKAGE_ANIMATIONS 0x0A
743#define EFI_HII_PACKAGE_END 0xDF
744#define EFI_HII_PACKAGE_TYPE_SYSTEM_BEGIN 0xE0
745#define EFI_HII_PACKAGE_TYPE_SYSTEM_END 0xFF
746
747/*
748 * HII string package
749 */
750struct efi_hii_strings_package {
751 struct efi_hii_package_header header;
752 u32 header_size;
753 u32 string_info_offset;
754 u16 language_window[16];
755 efi_string_id_t language_name;
756 u8 language[];
757} __packed;
758
759struct efi_hii_string_block {
760 u8 block_type;
761 /* u8 block_body[]; */
762} __packed;
763
764#define EFI_HII_SIBT_END 0x00
765#define EFI_HII_SIBT_STRING_SCSU 0x10
766#define EFI_HII_SIBT_STRING_SCSU_FONT 0x11
767#define EFI_HII_SIBT_STRINGS_SCSU 0x12
768#define EFI_HII_SIBT_STRINGS_SCSU_FONT 0x13
769#define EFI_HII_SIBT_STRING_UCS2 0x14
770#define EFI_HII_SIBT_STRING_UCS2_FONT 0x15
771#define EFI_HII_SIBT_STRINGS_UCS2 0x16
772#define EFI_HII_SIBT_STRINGS_UCS2_FONT 0x17
773#define EFI_HII_SIBT_DUPLICATE 0x20
774#define EFI_HII_SIBT_SKIP2 0x21
775#define EFI_HII_SIBT_SKIP1 0x22
776#define EFI_HII_SIBT_EXT1 0x30
777#define EFI_HII_SIBT_EXT2 0x31
778#define EFI_HII_SIBT_EXT4 0x32
779#define EFI_HII_SIBT_FONT 0x40
780
781struct efi_hii_sibt_string_ucs2_block {
782 struct efi_hii_string_block header;
783 u16 string_text[];
784} __packed;
785
786static inline struct efi_hii_string_block *
787efi_hii_sibt_string_ucs2_block_next(struct efi_hii_sibt_string_ucs2_block *blk)
788{
789 return ((void *)blk) + sizeof(*blk) +
790 (u16_strlen(blk->string_text) + 1) * 2;
791}
792
793/*
794 * HII keyboard package
795 */
796typedef enum {
797 EFI_KEY_LCTRL, EFI_KEY_A0, EFI_KEY_LALT, EFI_KEY_SPACE_BAR,
798 EFI_KEY_A2, EFI_KEY_A3, EFI_KEY_A4, EFI_KEY_RCTRL, EFI_KEY_LEFT_ARROW,
799 EFI_KEY_DOWN_ARROW, EFI_KEY_RIGHT_ARROW, EFI_KEY_ZERO,
800 EFI_KEY_PERIOD, EFI_KEY_ENTER, EFI_KEY_LSHIFT, EFI_KEY_B0,
801 EFI_KEY_B1, EFI_KEY_B2, EFI_KEY_B3, EFI_KEY_B4, EFI_KEY_B5, EFI_KEY_B6,
802 EFI_KEY_B7, EFI_KEY_B8, EFI_KEY_B9, EFI_KEY_B10, EFI_KEY_RSHIFT,
803 EFI_KEY_UP_ARROW, EFI_KEY_ONE, EFI_KEY_TWO, EFI_KEY_THREE,
804 EFI_KEY_CAPS_LOCK, EFI_KEY_C1, EFI_KEY_C2, EFI_KEY_C3, EFI_KEY_C4,
805 EFI_KEY_C5, EFI_KEY_C6, EFI_KEY_C7, EFI_KEY_C8, EFI_KEY_C9,
806 EFI_KEY_C10, EFI_KEY_C11, EFI_KEY_C12, EFI_KEY_FOUR, EFI_KEY_FIVE,
807 EFI_KEY_SIX, EFI_KEY_PLUS, EFI_KEY_TAB, EFI_KEY_D1, EFI_KEY_D2,
808 EFI_KEY_D3, EFI_KEY_D4, EFI_KEY_D5, EFI_KEY_D6, EFI_KEY_D7, EFI_KEY_D8,
809 EFI_KEY_D9, EFI_KEY_D10, EFI_KEY_D11, EFI_KEY_D12, EFI_KEY_D13,
810 EFI_KEY_DEL, EFI_KEY_END, EFI_KEY_PG_DN, EFI_KEY_SEVEN, EFI_KEY_EIGHT,
811 EFI_KEY_NINE, EFI_KEY_E0, EFI_KEY_E1, EFI_KEY_E2, EFI_KEY_E3,
812 EFI_KEY_E4, EFI_KEY_E5, EFI_KEY_E6, EFI_KEY_E7, EFI_KEY_E8, EFI_KEY_E9,
813 EFI_KEY_E10, EFI_KEY_E11, EFI_KEY_E12, EFI_KEY_BACK_SPACE,
814 EFI_KEY_INS, EFI_KEY_HOME, EFI_KEY_PG_UP, EFI_KEY_NLCK, EFI_KEY_SLASH,
815 EFI_KEY_ASTERISK, EFI_KEY_MINUS, EFI_KEY_ESC, EFI_KEY_F1, EFI_KEY_F2,
816 EFI_KEY_F3, EFI_KEY_F4, EFI_KEY_F5, EFI_KEY_F6, EFI_KEY_F7, EFI_KEY_F8,
817 EFI_KEY_F9, EFI_KEY_F10, EFI_KEY_F11, EFI_KEY_F12, EFI_KEY_PRINT,
818 EFI_KEY_SLCK, EFI_KEY_PAUSE,
819} efi_key;
820
821struct efi_key_descriptor {
822 u32 key;
823 u16 unicode;
824 u16 shifted_unicode;
825 u16 alt_gr_unicode;
826 u16 shifted_alt_gr_unicode;
827 u16 modifier;
828 u16 affected_attribute;
829} __packed;
830
831struct efi_hii_keyboard_layout {
832 u16 layout_length;
833 efi_guid_t guid;
834 u32 layout_descriptor_string_offset;
835 u8 descriptor_count;
836 struct efi_key_descriptor descriptors[];
837} __packed;
838
839/*
840 * HII protocols
841 */
842#define EFI_HII_STRING_PROTOCOL_GUID \
843 EFI_GUID(0x0fd96974, 0x23aa, 0x4cdc, \
844 0xb9, 0xcb, 0x98, 0xd1, 0x77, 0x50, 0x32, 0x2a)
845
846struct efi_font_info {
847 efi_hii_font_style_t font_style;
848 u16 font_size;
849 u16 font_name[1];
850};
851
852struct efi_hii_string_protocol {
853 efi_status_t(EFIAPI *new_string)(
854 const struct efi_hii_string_protocol *this,
855 efi_hii_handle_t package_list,
856 efi_string_id_t *string_id,
857 const u8 *language,
858 const u16 *language_name,
859 const efi_string_t string,
860 const struct efi_font_info *string_font_info);
861 efi_status_t(EFIAPI *get_string)(
862 const struct efi_hii_string_protocol *this,
863 const u8 *language,
864 efi_hii_handle_t package_list,
865 efi_string_id_t string_id,
866 efi_string_t string,
867 efi_uintn_t *string_size,
868 struct efi_font_info **string_font_info);
869 efi_status_t(EFIAPI *set_string)(
870 const struct efi_hii_string_protocol *this,
871 efi_hii_handle_t package_list,
872 efi_string_id_t string_id,
873 const u8 *language,
874 const efi_string_t string,
875 const struct efi_font_info *string_font_info);
876 efi_status_t(EFIAPI *get_languages)(
877 const struct efi_hii_string_protocol *this,
878 efi_hii_handle_t package_list,
879 u8 *languages,
880 efi_uintn_t *languages_size);
881 efi_status_t(EFIAPI *get_secondary_languages)(
882 const struct efi_hii_string_protocol *this,
883 efi_hii_handle_t package_list,
884 const u8 *primary_language,
885 u8 *secondary_languages,
886 efi_uintn_t *secondary_languages_size);
887};
888
889#define EFI_HII_DATABASE_PROTOCOL_GUID \
890 EFI_GUID(0xef9fc172, 0xa1b2, 0x4693, \
891 0xb3, 0x27, 0x6d, 0x32, 0xfc, 0x41, 0x60, 0x42)
892
893struct efi_hii_database_protocol {
894 efi_status_t(EFIAPI *new_package_list)(
895 const struct efi_hii_database_protocol *this,
896 const struct efi_hii_package_list_header *package_list,
897 const efi_handle_t driver_handle,
898 efi_hii_handle_t *handle);
899 efi_status_t(EFIAPI *remove_package_list)(
900 const struct efi_hii_database_protocol *this,
901 efi_hii_handle_t handle);
902 efi_status_t(EFIAPI *update_package_list)(
903 const struct efi_hii_database_protocol *this,
904 efi_hii_handle_t handle,
905 const struct efi_hii_package_list_header *package_list);
906 efi_status_t(EFIAPI *list_package_lists)(
907 const struct efi_hii_database_protocol *this,
908 u8 package_type,
909 const efi_guid_t *package_guid,
910 efi_uintn_t *handle_buffer_length,
911 efi_hii_handle_t *handle);
912 efi_status_t(EFIAPI *export_package_lists)(
913 const struct efi_hii_database_protocol *this,
914 efi_hii_handle_t handle,
915 efi_uintn_t *buffer_size,
916 struct efi_hii_package_list_header *buffer);
917 efi_status_t(EFIAPI *register_package_notify)(
918 const struct efi_hii_database_protocol *this,
919 u8 package_type,
920 const efi_guid_t *package_guid,
921 const void *package_notify_fn,
922 efi_uintn_t notify_type,
923 efi_handle_t *notify_handle);
924 efi_status_t(EFIAPI *unregister_package_notify)(
925 const struct efi_hii_database_protocol *this,
926 efi_handle_t notification_handle
927 );
928 efi_status_t(EFIAPI *find_keyboard_layouts)(
929 const struct efi_hii_database_protocol *this,
930 u16 *key_guid_buffer_length,
931 efi_guid_t *key_guid_buffer);
932 efi_status_t(EFIAPI *get_keyboard_layout)(
933 const struct efi_hii_database_protocol *this,
934 efi_guid_t *key_guid,
935 u16 *keyboard_layout_length,
936 struct efi_hii_keyboard_layout *keyboard_layout);
937 efi_status_t(EFIAPI *set_keyboard_layout)(
938 const struct efi_hii_database_protocol *this,
939 efi_guid_t *key_guid);
940 efi_status_t(EFIAPI *get_package_list_handle)(
941 const struct efi_hii_database_protocol *this,
942 efi_hii_handle_t package_list_handle,
943 efi_handle_t *driver_handle);
944};
945
be8d3241
AG		 946#define EFI_GOP_GUID \
947 EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, \
948 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
949
950#define EFI_GOT_RGBA8 0
951#define EFI_GOT_BGRA8 1
952#define EFI_GOT_BITMASK 2
953
2e0d79a0 954struct efi_gop_mode_info {
be8d3241
AG		 955 u32 version;
956 u32 width;
957 u32 height;
958 u32 pixel_format;
959 u32 pixel_bitmask[4];
960 u32 pixels_per_scanline;
961};
962
2e0d79a0 963struct efi_gop_mode {
be8d3241
AG		 964 u32 max_mode;
965 u32 mode;
966 struct efi_gop_mode_info *info;
967 unsigned long info_size;
968 efi_physical_addr_t fb_base;
969 unsigned long fb_size;
970};
971
0e0a3ceb
HS		 972struct efi_gop_pixel {
973 u8 blue;
974 u8 green;
975 u8 red;
976 u8 reserved;
977};
978
be8d3241
AG		 979#define EFI_BLT_VIDEO_FILL 0
980#define EFI_BLT_VIDEO_TO_BLT_BUFFER 1
981#define EFI_BLT_BUFFER_TO_VIDEO 2
982#define EFI_BLT_VIDEO_TO_VIDEO 3
983
2e0d79a0 984struct efi_gop {
be8d3241 985 efi_status_t (EFIAPI *query_mode)(struct efi_gop *this, u32 mode_number,
1c38a774 986 efi_uintn_t *size_of_info,
be8d3241
AG		 987 struct efi_gop_mode_info **info);
988 efi_status_t (EFIAPI *set_mode)(struct efi_gop *this, u32 mode_number);
0e0a3ceb
HS		 989 efi_status_t (EFIAPI *blt)(struct efi_gop *this,
990 struct efi_gop_pixel *buffer,
1c38a774
HS		 991 u32 operation, efi_uintn_t sx,
992 efi_uintn_t sy, efi_uintn_t dx,
993 efi_uintn_t dy, efi_uintn_t width,
994 efi_uintn_t height, efi_uintn_t delta);
be8d3241
AG		 995 struct efi_gop_mode *mode;
996};
997
0efe1bcf
AG		 998#define EFI_SIMPLE_NETWORK_GUID \
999 EFI_GUID(0xa19832b9, 0xac25, 0x11d3, \
1000 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
1001
1002struct efi_mac_address {
1003 char mac_addr[32];
1004};
1005
1006struct efi_ip_address {
1007 u8 ip_addr[16];
e2742358 1008} __attribute__((aligned(4)));
0efe1bcf
AG		 1009
1010enum efi_simple_network_state {
1011 EFI_NETWORK_STOPPED,
1012 EFI_NETWORK_STARTED,
1013 EFI_NETWORK_INITIALIZED,
1014};
1015
1016struct efi_simple_network_mode {
1017 enum efi_simple_network_state state;
1018 u32 hwaddr_size;
1019 u32 media_header_size;
1020 u32 max_packet_size;
1021 u32 nvram_size;
1022 u32 nvram_access_size;
1023 u32 receive_filter_mask;
1024 u32 receive_filter_setting;
1025 u32 max_mcast_filter_count;
1026 u32 mcast_filter_count;
1027 struct efi_mac_address mcast_filter[16];
1028 struct efi_mac_address current_address;
1029 struct efi_mac_address broadcast_address;
1030 struct efi_mac_address permanent_address;
1031 u8 if_type;
1032 u8 mac_changeable;
1033 u8 multitx_supported;
1034 u8 media_present_supported;
1035 u8 media_present;
1036};
1037
2e0864a4
HS		 1038/* receive_filters bit mask */
1039#define EFI_SIMPLE_NETWORK_RECEIVE_UNICAST 0x01
1040#define EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST 0x02
1041#define EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST 0x04
1042#define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS 0x08
1043#define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST 0x10
0efe1bcf 1044
891b3d90
HS		 1045/* interrupt status bit mask */
1046#define EFI_SIMPLE_NETWORK_RECEIVE_INTERRUPT 0x01
1047#define EFI_SIMPLE_NETWORK_TRANSMIT_INTERRUPT 0x02
1048#define EFI_SIMPLE_NETWORK_COMMAND_INTERRUPT 0x04
1049#define EFI_SIMPLE_NETWORK_SOFTWARE_INTERRUPT 0x08
1050
bdecf974
HS		 1051/* revision of the simple network protocol */
1052#define EFI_SIMPLE_NETWORK_PROTOCOL_REVISION 0x00010000
1053
2e0d79a0 1054struct efi_simple_network {
0efe1bcf
AG		 1055 u64 revision;
1056 efi_status_t (EFIAPI *start)(struct efi_simple_network *this);
1057 efi_status_t (EFIAPI *stop)(struct efi_simple_network *this);
1058 efi_status_t (EFIAPI *initialize)(struct efi_simple_network *this,
1059 ulong extra_rx, ulong extra_tx);
1060 efi_status_t (EFIAPI *reset)(struct efi_simple_network *this,
1061 int extended_verification);
1062 efi_status_t (EFIAPI *shutdown)(struct efi_simple_network *this);
1063 efi_status_t (EFIAPI *receive_filters)(struct efi_simple_network *this,
1064 u32 enable, u32 disable, int reset_mcast_filter,
1065 ulong mcast_filter_count,
1066 struct efi_mac_address *mcast_filter);
1067 efi_status_t (EFIAPI *station_address)(struct efi_simple_network *this,
1068 int reset, struct efi_mac_address *new_mac);
1069 efi_status_t (EFIAPI *statistics)(struct efi_simple_network *this,
1070 int reset, ulong *stat_size, void *stat_table);
1071 efi_status_t (EFIAPI *mcastiptomac)(struct efi_simple_network *this,
1072 int ipv6, struct efi_ip_address *ip,
1073 struct efi_mac_address *mac);
1074 efi_status_t (EFIAPI *nvdata)(struct efi_simple_network *this,
1075 int read_write, ulong offset, ulong buffer_size,
1076 char *buffer);
1077 efi_status_t (EFIAPI *get_status)(struct efi_simple_network *this,
1078 u32 *int_status, void **txbuf);
1079 efi_status_t (EFIAPI *transmit)(struct efi_simple_network *this,
8db174d6 1080 size_t header_size, size_t buffer_size, void *buffer,
0efe1bcf
AG		 1081 struct efi_mac_address *src_addr,
1082 struct efi_mac_address *dest_addr, u16 *protocol);
1083 efi_status_t (EFIAPI *receive)(struct efi_simple_network *this,
8db174d6 1084 size_t *header_size, size_t *buffer_size, void *buffer,
0efe1bcf
AG		 1085 struct efi_mac_address *src_addr,
1086 struct efi_mac_address *dest_addr, u16 *protocol);
84a12ce6 1087 struct efi_event *wait_for_packet;
0efe1bcf
AG		 1088 struct efi_simple_network_mode *mode;
1089};
1090
1091#define EFI_PXE_GUID \
1092 EFI_GUID(0x03c4e603, 0xac28, 0x11d3, \
1093 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
1094
1095struct efi_pxe_packet {
1096 u8 packet[1472];
1097};
1098
2e0d79a0 1099struct efi_pxe_mode {
e2742358
PW		 1100 u8 started;
1101 u8 ipv6_available;
1102 u8 ipv6_supported;
1103 u8 using_ipv6;
1104 u8 bis_supported;
1105 u8 bis_detected;
1106 u8 auto_arp;
1107 u8 send_guid;
1108 u8 dhcp_discover_valid;
1109 u8 dhcp_ack_received;
1110 u8 proxy_offer_received;
1111 u8 pxe_discover_valid;
1112 u8 pxe_reply_received;
1113 u8 pxe_bis_reply_received;
1114 u8 icmp_error_received;
1115 u8 tftp_error_received;
1116 u8 make_callbacks;
1117 u8 ttl;
1118 u8 tos;
1119 u8 pad;
1120 struct efi_ip_address station_ip;
1121 struct efi_ip_address subnet_mask;
0efe1bcf
AG		 1122 struct efi_pxe_packet dhcp_discover;
1123 struct efi_pxe_packet dhcp_ack;
1124 struct efi_pxe_packet proxy_offer;
1125 struct efi_pxe_packet pxe_discover;
1126 struct efi_pxe_packet pxe_reply;
1127};
1128
1129struct efi_pxe {
1130 u64 rev;
1131 void (EFIAPI *start)(void);
1132 void (EFIAPI *stop)(void);
1133 void (EFIAPI *dhcp)(void);
1134 void (EFIAPI *discover)(void);
1135 void (EFIAPI *mftp)(void);
1136 void (EFIAPI *udpwrite)(void);
1137 void (EFIAPI *udpread)(void);
1138 void (EFIAPI *setipfilter)(void);
1139 void (EFIAPI *arp)(void);
1140 void (EFIAPI *setparams)(void);
1141 void (EFIAPI *setstationip)(void);
1142 void (EFIAPI *setpackets)(void);
1143 struct efi_pxe_mode *mode;
1144};
1145
2a92080d
RC		 1146#define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID \
1147 EFI_GUID(0x964e5b22, 0x6459, 0x11d2, \
1148 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
1149#define EFI_FILE_PROTOCOL_REVISION 0x00010000
1150
1151struct efi_file_handle {
1152 u64 rev;
1153 efi_status_t (EFIAPI *open)(struct efi_file_handle *file,
1154 struct efi_file_handle **new_handle,
c82f8f60 1155 u16 *file_name, u64 open_mode, u64 attributes);
2a92080d
RC		 1156 efi_status_t (EFIAPI *close)(struct efi_file_handle *file);
1157 efi_status_t (EFIAPI *delete)(struct efi_file_handle *file);
1158 efi_status_t (EFIAPI *read)(struct efi_file_handle *file,
b6dd5777 1159 efi_uintn_t *buffer_size, void *buffer);
2a92080d 1160 efi_status_t (EFIAPI *write)(struct efi_file_handle *file,
b6dd5777 1161 efi_uintn_t *buffer_size, void *buffer);
2a92080d 1162 efi_status_t (EFIAPI *getpos)(struct efi_file_handle *file,
0801d4d2 1163 u64 *pos);
2a92080d 1164 efi_status_t (EFIAPI *setpos)(struct efi_file_handle *file,
0801d4d2 1165 u64 pos);
2a92080d 1166 efi_status_t (EFIAPI *getinfo)(struct efi_file_handle *file,
9c9021e2 1167 const efi_guid_t *info_type, efi_uintn_t *buffer_size,
b6dd5777 1168 void *buffer);
2a92080d 1169 efi_status_t (EFIAPI *setinfo)(struct efi_file_handle *file,
9c9021e2 1170 const efi_guid_t *info_type, efi_uintn_t buffer_size,
b6dd5777 1171 void *buffer);
2a92080d
RC		 1172 efi_status_t (EFIAPI *flush)(struct efi_file_handle *file);
1173};
1174
2a92080d
RC		 1175#define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION 0x00010000
1176
1177struct efi_simple_file_system_protocol {
1178 u64 rev;
1179 efi_status_t (EFIAPI *open_volume)(struct efi_simple_file_system_protocol *this,
1180 struct efi_file_handle **root);
1181};
1182
1183#define EFI_FILE_INFO_GUID \
1184 EFI_GUID(0x9576e92, 0x6d3f, 0x11d2, \
1185 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
1186
9e6835e6
HS		 1187#define EFI_FILE_SYSTEM_INFO_GUID \
1188 EFI_GUID(0x09576e93, 0x6d3f, 0x11d2, \
1189 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
1190
2a92080d
RC		 1191#define EFI_FILE_MODE_READ 0x0000000000000001
1192#define EFI_FILE_MODE_WRITE 0x0000000000000002
1193#define EFI_FILE_MODE_CREATE 0x8000000000000000
1194
1195#define EFI_FILE_READ_ONLY 0x0000000000000001
1196#define EFI_FILE_HIDDEN 0x0000000000000002
1197#define EFI_FILE_SYSTEM 0x0000000000000004
1198#define EFI_FILE_RESERVED 0x0000000000000008
1199#define EFI_FILE_DIRECTORY 0x0000000000000010
1200#define EFI_FILE_ARCHIVE 0x0000000000000020
1201#define EFI_FILE_VALID_ATTR 0x0000000000000037
1202
1203struct efi_file_info {
1204 u64 size;
1205 u64 file_size;
1206 u64 physical_size;
1207 struct efi_time create_time;
1208 struct efi_time last_access_time;
1209 struct efi_time modification_time;
1210 u64 attribute;
02c2f029 1211 u16 file_name[0];
2a92080d
RC		 1212};
1213
9e6835e6
HS		 1214struct efi_file_system_info {
1215 u64 size;
1216 u8 read_only;
1217 u64 volume_size;
1218 u64 free_space;
1219 u32 block_size;
1220 u16 volume_label[0];
1221};
1222
f0959dbe
HS		 1223#define EFI_DRIVER_BINDING_PROTOCOL_GUID \
1224 EFI_GUID(0x18a031ab, 0xb443, 0x4d1a,\
1225 0xa5, 0xc0, 0x0c, 0x09, 0x26, 0x1e, 0x9f, 0x71)
1226struct efi_driver_binding_protocol {
1227 efi_status_t (EFIAPI * supported)(
1228 struct efi_driver_binding_protocol *this,
1229 efi_handle_t controller_handle,
1230 struct efi_device_path *remaining_device_path);
1231 efi_status_t (EFIAPI * start)(
1232 struct efi_driver_binding_protocol *this,
1233 efi_handle_t controller_handle,
1234 struct efi_device_path *remaining_device_path);
1235 efi_status_t (EFIAPI * stop)(
1236 struct efi_driver_binding_protocol *this,
1237 efi_handle_t controller_handle,
1238 efi_uintn_t number_of_children,
1239 efi_handle_t *child_handle_buffer);
1240 u32 version;
1241 efi_handle_t image_handle;
1242 efi_handle_t driver_binding_handle;
1243};
1244
0bc4b0da
HS		 1245#define EFI_UNICODE_COLLATION_PROTOCOL2_GUID \
1246 EFI_GUID(0xa4c751fc, 0x23ae, 0x4c3e, \
1247 0x92, 0xe9, 0x49, 0x64, 0xcf, 0x63, 0xf3, 0x49)
1248struct efi_unicode_collation_protocol {
1249 efi_intn_t (EFIAPI *stri_coll)(
1250 struct efi_unicode_collation_protocol *this, u16 *s1, u16 *s2);
1251 bool (EFIAPI *metai_match)(struct efi_unicode_collation_protocol *this,
1252 const u16 *string, const u16 *patter);
1253 void (EFIAPI *str_lwr)(struct efi_unicode_collation_protocol
1254 *this, u16 *string);
1255 void (EFIAPI *str_upr)(struct efi_unicode_collation_protocol *this,
1256 u16 *string);
1257 void (EFIAPI *fat_to_str)(struct efi_unicode_collation_protocol *this,
1258 efi_uintn_t fat_size, char *fat, u16 *string);
1259 bool (EFIAPI *str_to_fat)(struct efi_unicode_collation_protocol *this,
1260 const u16 *string, efi_uintn_t fat_size,
1261 char *fat);
1262 char *supported_languages;
1263};
1264
867a6ac8 1265#endif
"Das U-Boot" Source Tree