blob: 982c2001728dd0704c614bf0de346be4cf6aaa6e [file] [log] [blame]
Heinrich Schuchardt2e0d79a2018-09-08 10:50:40 +02001/* SPDX-License-Identifier: GPL-2.0 */
Simon Glass867a6ac2015-07-31 09:31:36 -06002/*
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>
Leif Lindholmc9bfb222019-01-21 12:12:57 +090020#include <charset.h>
AKASHI Takahiro593e17d2020-04-14 11:51:39 +090021#include <pe.h>
Simon Glass867a6ac2015-07-31 09:31:36 -060022
Heinrich Schuchardtdc525782021-11-17 18:55:59 +010023/* UEFI spec version 2.9 */
24#define EFI_SPECIFICATION_VERSION (2 << 16 | 90)
Heinrich Schuchardt112f2432018-06-28 12:45:27 +020025
Alexander Graf2bb9b792016-03-04 01:09:57 +010026/* Types and defines for EFI CreateEvent */
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +020027enum efi_timer_delay {
Alexander Graf2bb9b792016-03-04 01:09:57 +010028 EFI_TIMER_STOP = 0,
29 EFI_TIMER_PERIODIC = 1,
30 EFI_TIMER_RELATIVE = 2
31};
32
Leif Lindholmc9bfb222019-01-21 12:12:57 +090033typedef void *efi_hii_handle_t;
34typedef u16 *efi_string_t;
35typedef u16 efi_string_id_t;
36typedef u32 efi_hii_font_style_t;
AKASHI Takahirocb728e52019-01-21 12:13:00 +090037typedef u16 efi_question_id_t;
38typedef u16 efi_image_id_t;
39typedef u16 efi_form_id_t;
xypron.glpk@gmx.de503f2692017-07-18 20:17:19 +020040
xypron.glpk@gmx.dec6841592017-07-18 20:17:18 +020041#define EVT_TIMER 0x80000000
42#define EVT_RUNTIME 0x40000000
43#define EVT_NOTIFY_WAIT 0x00000100
44#define EVT_NOTIFY_SIGNAL 0x00000200
45#define EVT_SIGNAL_EXIT_BOOT_SERVICES 0x00000201
46#define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE 0x60000202
47
48#define TPL_APPLICATION 0x04
49#define TPL_CALLBACK 0x08
50#define TPL_NOTIFY 0x10
51#define TPL_HIGH_LEVEL 0x1F
Jonathan Gray37a980b2017-03-12 19:26:06 +110052
xypron.glpk@gmx.de2fd945f2017-07-18 20:17:17 +020053struct efi_event;
54
AKASHI Takahiro7cceef72020-03-17 11:12:34 +090055/* OsIndicationsSupported flags */
56#define EFI_OS_INDICATIONS_BOOT_TO_FW_UI 0x0000000000000001
57#define EFI_OS_INDICATIONS_TIMESTAMP_REVOCATION 0x0000000000000002
58#define EFI_OS_INDICATIONS_FILE_CAPSULE_DELIVERY_SUPPORTED 0x0000000000000004
59#define EFI_OS_INDICATIONS_FMP_CAPSULE_SUPPORTED 0x0000000000000008
60#define EFI_OS_INDICATIONS_CAPSULE_RESULT_VAR_SUPPORTED 0x0000000000000010
61#define EFI_OS_INDICATIONS_START_OS_RECOVERY 0x0000000000000020
62#define EFI_OS_INDICATIONS_START_PLATFORM_RECOVERY 0x0000000000000040
63#define EFI_OS_INDICATIONS_JSON_CONFIG_DATA_REFRESH 0x0000000000000080
64
Simon Glass867a6ac2015-07-31 09:31:36 -060065/* EFI Boot Services table */
Heinrich Schuchardt112f2432018-06-28 12:45:27 +020066#define EFI_BOOT_SERVICES_SIGNATURE 0x56524553544f4f42
Simon Glass867a6ac2015-07-31 09:31:36 -060067struct efi_boot_services {
68 struct efi_table_hdr hdr;
Heinrich Schuchardt152cade2017-11-06 21:17:47 +010069 efi_status_t (EFIAPI *raise_tpl)(efi_uintn_t new_tpl);
70 void (EFIAPI *restore_tpl)(efi_uintn_t old_tpl);
Simon Glass867a6ac2015-07-31 09:31:36 -060071
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +010072 efi_status_t (EFIAPI *allocate_pages)(int, int, efi_uintn_t,
Simon Glass867a6ac2015-07-31 09:31:36 -060073 efi_physical_addr_t *);
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +010074 efi_status_t (EFIAPI *free_pages)(efi_physical_addr_t, efi_uintn_t);
75 efi_status_t (EFIAPI *get_memory_map)(efi_uintn_t *memory_map_size,
76 struct efi_mem_desc *desc,
77 efi_uintn_t *key,
78 efi_uintn_t *desc_size,
79 u32 *desc_version);
80 efi_status_t (EFIAPI *allocate_pool)(int, efi_uintn_t, void **);
Simon Glass867a6ac2015-07-31 09:31:36 -060081 efi_status_t (EFIAPI *free_pool)(void *);
82
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +020083 efi_status_t (EFIAPI *create_event)(uint32_t type,
Heinrich Schuchardt152cade2017-11-06 21:17:47 +010084 efi_uintn_t notify_tpl,
xypron.glpk@gmx.de2fd945f2017-07-18 20:17:17 +020085 void (EFIAPI *notify_function) (
86 struct efi_event *event,
87 void *context),
88 void *notify_context, struct efi_event **event);
xypron.glpk@gmx.deb521d292017-07-19 19:22:34 +020089 efi_status_t (EFIAPI *set_timer)(struct efi_event *event,
90 enum efi_timer_delay type,
91 uint64_t trigger_time);
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +010092 efi_status_t (EFIAPI *wait_for_event)(efi_uintn_t number_of_events,
93 struct efi_event **event,
94 efi_uintn_t *index);
xypron.glpk@gmx.de2fd945f2017-07-18 20:17:17 +020095 efi_status_t (EFIAPI *signal_event)(struct efi_event *event);
96 efi_status_t (EFIAPI *close_event)(struct efi_event *event);
97 efi_status_t (EFIAPI *check_event)(struct efi_event *event);
xypron.glpk@gmx.dee0549f82017-07-11 22:06:16 +020098#define EFI_NATIVE_INTERFACE 0x00000000
Alexander Graf2bb9b792016-03-04 01:09:57 +010099 efi_status_t (EFIAPI *install_protocol_interface)(
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +0200100 efi_handle_t *handle, const efi_guid_t *protocol,
Alexander Graf2bb9b792016-03-04 01:09:57 +0100101 int protocol_interface_type, void *protocol_interface);
102 efi_status_t (EFIAPI *reinstall_protocol_interface)(
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +0200103 efi_handle_t handle, const efi_guid_t *protocol,
Alexander Graf2bb9b792016-03-04 01:09:57 +0100104 void *old_interface, void *new_interface);
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100105 efi_status_t (EFIAPI *uninstall_protocol_interface)(
106 efi_handle_t handle, const efi_guid_t *protocol,
107 void *protocol_interface);
108 efi_status_t (EFIAPI *handle_protocol)(
109 efi_handle_t handle, const efi_guid_t *protocol,
110 void **protocol_interface);
Simon Glass867a6ac2015-07-31 09:31:36 -0600111 void *reserved;
Alexander Graf2bb9b792016-03-04 01:09:57 +0100112 efi_status_t (EFIAPI *register_protocol_notify)(
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +0200113 const efi_guid_t *protocol, struct efi_event *event,
Alexander Graf2bb9b792016-03-04 01:09:57 +0100114 void **registration);
Simon Glass867a6ac2015-07-31 09:31:36 -0600115 efi_status_t (EFIAPI *locate_handle)(
116 enum efi_locate_search_type search_type,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +0200117 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100118 efi_uintn_t *buffer_size, efi_handle_t *buffer);
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +0200119 efi_status_t (EFIAPI *locate_device_path)(const efi_guid_t *protocol,
Simon Glass867a6ac2015-07-31 09:31:36 -0600120 struct efi_device_path **device_path,
121 efi_handle_t *device);
Alexander Graf2bb9b792016-03-04 01:09:57 +0100122 efi_status_t (EFIAPI *install_configuration_table)(
Masahisa Kojimaf86352e2021-10-22 20:24:24 +0900123 const efi_guid_t *guid, void *table);
Simon Glass867a6ac2015-07-31 09:31:36 -0600124
125 efi_status_t (EFIAPI *load_image)(bool boot_policiy,
126 efi_handle_t parent_image,
127 struct efi_device_path *file_path, void *source_buffer,
Heinrich Schuchardt7fb96a12018-04-03 22:29:30 +0200128 efi_uintn_t source_size, efi_handle_t *image);
Simon Glass867a6ac2015-07-31 09:31:36 -0600129 efi_status_t (EFIAPI *start_image)(efi_handle_t handle,
Heinrich Schuchardtcc8e3412018-12-28 12:41:15 +0100130 efi_uintn_t *exitdata_size,
131 u16 **exitdata);
Simon Glass867a6ac2015-07-31 09:31:36 -0600132 efi_status_t (EFIAPI *exit)(efi_handle_t handle,
133 efi_status_t exit_status,
Heinrich Schuchardtcc8e3412018-12-28 12:41:15 +0100134 efi_uintn_t exitdata_size, u16 *exitdata);
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100135 efi_status_t (EFIAPI *unload_image)(efi_handle_t image_handle);
Heinrich Schuchardtb015ab52019-05-05 21:58:35 +0200136 efi_status_t (EFIAPI *exit_boot_services)(efi_handle_t image_handle,
137 efi_uintn_t map_key);
Simon Glass867a6ac2015-07-31 09:31:36 -0600138
139 efi_status_t (EFIAPI *get_next_monotonic_count)(u64 *count);
140 efi_status_t (EFIAPI *stall)(unsigned long usecs);
Alexander Graf2bb9b792016-03-04 01:09:57 +0100141 efi_status_t (EFIAPI *set_watchdog_timer)(unsigned long timeout,
142 uint64_t watchdog_code, unsigned long data_size,
143 uint16_t *watchdog_data);
Simon Glass867a6ac2015-07-31 09:31:36 -0600144 efi_status_t(EFIAPI *connect_controller)(efi_handle_t controller_handle,
145 efi_handle_t *driver_image_handle,
146 struct efi_device_path *remaining_device_path,
147 bool recursive);
Heinrich Schuchardt3ebcd002018-01-11 08:16:03 +0100148 efi_status_t (EFIAPI *disconnect_controller)(
149 efi_handle_t controller_handle,
150 efi_handle_t driver_image_handle,
151 efi_handle_t child_handle);
Simon Glass867a6ac2015-07-31 09:31:36 -0600152#define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001
153#define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002
154#define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004
155#define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008
156#define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010
157#define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020
158 efi_status_t (EFIAPI *open_protocol)(efi_handle_t handle,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +0200159 const efi_guid_t *protocol, void **interface,
Simon Glass867a6ac2015-07-31 09:31:36 -0600160 efi_handle_t agent_handle,
161 efi_handle_t controller_handle, u32 attributes);
Heinrich Schuchardt2074f702018-01-11 08:16:09 +0100162 efi_status_t (EFIAPI *close_protocol)(
163 efi_handle_t handle, const efi_guid_t *protocol,
164 efi_handle_t agent_handle,
165 efi_handle_t controller_handle);
Simon Glass867a6ac2015-07-31 09:31:36 -0600166 efi_status_t(EFIAPI *open_protocol_information)(efi_handle_t handle,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +0200167 const efi_guid_t *protocol,
Simon Glass867a6ac2015-07-31 09:31:36 -0600168 struct efi_open_protocol_info_entry **entry_buffer,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100169 efi_uintn_t *entry_count);
Simon Glass867a6ac2015-07-31 09:31:36 -0600170 efi_status_t (EFIAPI *protocols_per_handle)(efi_handle_t handle,
171 efi_guid_t ***protocol_buffer,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100172 efi_uintn_t *protocols_buffer_count);
Simon Glass867a6ac2015-07-31 09:31:36 -0600173 efi_status_t (EFIAPI *locate_handle_buffer) (
174 enum efi_locate_search_type search_type,
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +0200175 const efi_guid_t *protocol, void *search_key,
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100176 efi_uintn_t *no_handles, efi_handle_t **buffer);
Heinrich Schuchardt5a9682d2017-10-05 16:35:53 +0200177 efi_status_t (EFIAPI *locate_protocol)(const efi_guid_t *protocol,
Alexander Graf2bb9b792016-03-04 01:09:57 +0100178 void *registration, void **protocol_interface);
179 efi_status_t (EFIAPI *install_multiple_protocol_interfaces)(
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +0200180 efi_handle_t *handle, ...);
Alexander Graf2bb9b792016-03-04 01:09:57 +0100181 efi_status_t (EFIAPI *uninstall_multiple_protocol_interfaces)(
Heinrich Schuchardtfaea1042018-09-26 05:27:54 +0200182 efi_handle_t handle, ...);
Heinrich Schuchardt8aa83602018-07-07 15:36:04 +0200183 efi_status_t (EFIAPI *calculate_crc32)(const void *data,
184 efi_uintn_t data_size,
185 u32 *crc32);
Heinrich Schuchardtfc05a952017-10-05 16:35:52 +0200186 void (EFIAPI *copy_mem)(void *destination, const void *source,
187 size_t length);
188 void (EFIAPI *set_mem)(void *buffer, size_t size, uint8_t value);
Heinrich Schuchardt9f0930e2018-02-04 23:05:13 +0100189 efi_status_t (EFIAPI *create_event_ex)(
190 uint32_t type, efi_uintn_t notify_tpl,
191 void (EFIAPI *notify_function) (
192 struct efi_event *event,
193 void *context),
194 void *notify_context,
195 efi_guid_t *event_group,
196 struct efi_event **event);
Simon Glass867a6ac2015-07-31 09:31:36 -0600197};
198
199/* Types and defines for EFI ResetSystem */
200enum efi_reset_type {
201 EFI_RESET_COLD = 0,
202 EFI_RESET_WARM = 1,
Heinrich Schuchardt482fc902018-02-06 22:00:22 +0100203 EFI_RESET_SHUTDOWN = 2,
204 EFI_RESET_PLATFORM_SPECIFIC = 3,
Simon Glass867a6ac2015-07-31 09:31:36 -0600205};
206
207/* EFI Runtime Services table */
Heinrich Schuchardtbdfb8942018-06-28 12:45:28 +0200208#define EFI_RUNTIME_SERVICES_SIGNATURE 0x56524553544e5552ULL
Simon Glass867a6ac2015-07-31 09:31:36 -0600209
Heinrich Schuchardt0c230742018-02-09 20:41:21 +0100210#define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000
211#define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE 0x00020000
212#define CAPSULE_FLAGS_INITIATE_RESET 0x00040000
213
AKASHI Takahiro8d990262020-11-30 18:12:11 +0900214#define CAPSULE_SUPPORT_AUTHENTICATION 0x0000000000000001
215#define CAPSULE_SUPPORT_DEPENDENCY 0x0000000000000002
216
AKASHI Takahiro2bc27ca2020-11-17 09:27:55 +0900217#define EFI_CAPSULE_REPORT_GUID \
218 EFI_GUID(0x39b68c46, 0xf7fb, 0x441b, 0xb6, 0xec, \
219 0x16, 0xb0, 0xf6, 0x98, 0x21, 0xf3)
220
AKASHI Takahiroed9349c2020-11-17 09:27:57 +0900221#define EFI_MEMORY_RANGE_CAPSULE_GUID \
222 EFI_GUID(0xde9f0ec, 0x88b6, 0x428f, 0x97, 0x7a, \
223 0x25, 0x8f, 0x1d, 0xe, 0x5e, 0x72)
224
AKASHI Takahiro8d990262020-11-30 18:12:11 +0900225#define EFI_FIRMWARE_MANAGEMENT_CAPSULE_ID_GUID \
226 EFI_GUID(0x6dcbd5ed, 0xe82d, 0x4c44, 0xbd, 0xa1, \
227 0x71, 0x94, 0x19, 0x9a, 0xd9, 0x2a)
228
Heinrich Schuchardt0c230742018-02-09 20:41:21 +0100229struct efi_capsule_header {
AKASHI Takahiro74b44872020-03-17 11:12:37 +0900230 efi_guid_t capsule_guid;
Heinrich Schuchardt0c230742018-02-09 20:41:21 +0100231 u32 header_size;
232 u32 flags;
233 u32 capsule_image_size;
AKASHI Takahiro74b44872020-03-17 11:12:37 +0900234} __packed;
Heinrich Schuchardt0c230742018-02-09 20:41:21 +0100235
AKASHI Takahiro2bc27ca2020-11-17 09:27:55 +0900236struct efi_capsule_result_variable_header {
237 u32 variable_total_size;
238 u32 reserved;
239 efi_guid_t capsule_guid;
240 struct efi_time capsule_processed;
241 efi_status_t capsule_status;
242} __packed;
243
AKASHI Takahiroed9349c2020-11-17 09:27:57 +0900244struct efi_memory_range {
245 efi_physical_addr_t address;
246 u64 length;
247};
248
249struct efi_memory_range_capsule {
250 struct efi_capsule_header *header;
251 /* EFI_MEMORY_TYPE: 0x80000000-0xFFFFFFFF */
Heinrich Schuchardtc91737b2021-08-17 15:02:23 +0200252 enum efi_memory_type os_requested_memory_type;
AKASHI Takahiroed9349c2020-11-17 09:27:57 +0900253 u64 number_of_memory_ranges;
254 struct efi_memory_range memory_ranges[];
255} __packed;
256
AKASHI Takahiro8d990262020-11-30 18:12:11 +0900257struct efi_firmware_management_capsule_header {
258 u32 version;
259 u16 embedded_driver_count;
260 u16 payload_item_count;
261 u64 item_offset_list[];
262} __packed;
263
264struct efi_firmware_management_capsule_image_header {
265 u32 version;
266 efi_guid_t update_image_type_id;
267 u8 update_image_index;
268 u8 reserved[3];
269 u32 update_image_size;
270 u32 update_vendor_code_size;
271 u64 update_hardware_instance;
272 u64 image_capsule_support;
273} __packed;
274
275struct efi_capsule_result_variable_fmp {
276 u16 version;
277 u8 payload_index;
278 u8 update_image_index;
279 efi_guid_t update_image_type_id;
280 // u16 capsule_file_name[];
281 // u16 capsule_target[];
282} __packed;
283
AKASHI Takahiroe771b4b2019-06-05 13:21:38 +0900284#define EFI_RT_SUPPORTED_GET_TIME 0x0001
285#define EFI_RT_SUPPORTED_SET_TIME 0x0002
286#define EFI_RT_SUPPORTED_GET_WAKEUP_TIME 0x0004
287#define EFI_RT_SUPPORTED_SET_WAKEUP_TIME 0x0008
288#define EFI_RT_SUPPORTED_GET_VARIABLE 0x0010
289#define EFI_RT_SUPPORTED_GET_NEXT_VARIABLE_NAME 0x0020
290#define EFI_RT_SUPPORTED_SET_VARIABLE 0x0040
291#define EFI_RT_SUPPORTED_SET_VIRTUAL_ADDRESS_MAP 0x0080
292#define EFI_RT_SUPPORTED_CONVERT_POINTER 0x0100
293#define EFI_RT_SUPPORTED_GET_NEXT_HIGH_MONOTONIC_COUNT 0x0200
294#define EFI_RT_SUPPORTED_RESET_SYSTEM 0x0400
295#define EFI_RT_SUPPORTED_UPDATE_CAPSULE 0x0800
296#define EFI_RT_SUPPORTED_QUERY_CAPSULE_CAPABILITIES 0x1000
297#define EFI_RT_SUPPORTED_QUERY_VARIABLE_INFO 0x2000
298
Heinrich Schuchardt76be6872020-02-19 20:48:49 +0100299#define EFI_RT_PROPERTIES_TABLE_GUID \
300 EFI_GUID(0xeb66918a, 0x7eef, 0x402a, 0x84, 0x2e, \
301 0x93, 0x1d, 0x21, 0xc3, 0x8a, 0xe9)
302
303#define EFI_RT_PROPERTIES_TABLE_VERSION 0x1
304
305struct efi_rt_properties_table {
306 u16 version;
307 u16 length;
308 u32 runtime_services_supported;
309};
310
Heinrich Schuchardt724d2812020-03-24 17:52:40 +0100311#define EFI_OPTIONAL_PTR 0x00000001
312
Simon Glass867a6ac2015-07-31 09:31:36 -0600313struct efi_runtime_services {
314 struct efi_table_hdr hdr;
Alexander Graf2bb9b792016-03-04 01:09:57 +0100315 efi_status_t (EFIAPI *get_time)(struct efi_time *time,
316 struct efi_time_cap *capabilities);
317 efi_status_t (EFIAPI *set_time)(struct efi_time *time);
318 efi_status_t (EFIAPI *get_wakeup_time)(char *enabled, char *pending,
319 struct efi_time *time);
320 efi_status_t (EFIAPI *set_wakeup_time)(char enabled,
321 struct efi_time *time);
322 efi_status_t (EFIAPI *set_virtual_address_map)(
Heinrich Schuchardt24e67222019-07-27 20:28:47 +0200323 efi_uintn_t memory_map_size,
324 efi_uintn_t descriptor_size,
Alexander Graf2bb9b792016-03-04 01:09:57 +0100325 uint32_t descriptor_version,
326 struct efi_mem_desc *virtmap);
Heinrich Schuchardtefcf0a12019-06-29 03:51:36 +0200327 efi_status_t (EFIAPI *convert_pointer)(
328 efi_uintn_t debug_disposition, void **address);
Heinrich Schuchardt45c66f92018-05-17 07:57:05 +0200329 efi_status_t (EFIAPI *get_variable)(u16 *variable_name,
Heinrich Schuchardt0bda81b2018-12-30 20:53:51 +0100330 const efi_guid_t *vendor,
331 u32 *attributes,
Heinrich Schuchardt45c66f92018-05-17 07:57:05 +0200332 efi_uintn_t *data_size, void *data);
333 efi_status_t (EFIAPI *get_next_variable_name)(
334 efi_uintn_t *variable_name_size,
Heinrich Schuchardt7a4e7172020-03-22 18:28:20 +0100335 u16 *variable_name, efi_guid_t *vendor);
Heinrich Schuchardt45c66f92018-05-17 07:57:05 +0200336 efi_status_t (EFIAPI *set_variable)(u16 *variable_name,
Heinrich Schuchardt0bda81b2018-12-30 20:53:51 +0100337 const efi_guid_t *vendor,
338 u32 attributes,
Heinrich Schuchardt452257a2018-12-30 21:03:15 +0100339 efi_uintn_t data_size,
340 const void *data);
Alexander Graf2bb9b792016-03-04 01:09:57 +0100341 efi_status_t (EFIAPI *get_next_high_mono_count)(
342 uint32_t *high_count);
Simon Glass867a6ac2015-07-31 09:31:36 -0600343 void (EFIAPI *reset_system)(enum efi_reset_type reset_type,
344 efi_status_t reset_status,
345 unsigned long data_size, void *reset_data);
Heinrich Schuchardt0c230742018-02-09 20:41:21 +0100346 efi_status_t (EFIAPI *update_capsule)(
347 struct efi_capsule_header **capsule_header_array,
348 efi_uintn_t capsule_count,
349 u64 scatter_gather_list);
350 efi_status_t (EFIAPI *query_capsule_caps)(
351 struct efi_capsule_header **capsule_header_array,
352 efi_uintn_t capsule_count,
AKASHI Takahiro19dd9072018-11-14 16:18:53 +0900353 u64 *maximum_capsule_size,
354 u32 *reset_type);
Heinrich Schuchardt0c230742018-02-09 20:41:21 +0100355 efi_status_t (EFIAPI *query_variable_info)(
356 u32 attributes,
Heinrich Schuchardt45c66f92018-05-17 07:57:05 +0200357 u64 *maximum_variable_storage_size,
358 u64 *remaining_variable_storage_size,
359 u64 *maximum_variable_size);
Simon Glass867a6ac2015-07-31 09:31:36 -0600360};
361
Heinrich Schuchardta3a28f52018-02-18 15:17:51 +0100362/* EFI event group GUID definitions */
Heinrich Schuchardt43eaf5b2021-11-16 18:46:27 +0100363
Heinrich Schuchardta3a28f52018-02-18 15:17:51 +0100364#define EFI_EVENT_GROUP_EXIT_BOOT_SERVICES \
365 EFI_GUID(0x27abf055, 0xb1b8, 0x4c26, 0x80, 0x48, \
366 0x74, 0x8f, 0x37, 0xba, 0xa2, 0xdf)
367
Heinrich Schuchardt43eaf5b2021-11-16 18:46:27 +0100368#define EFI_EVENT_GROUP_BEFORE_EXIT_BOOT_SERVICES \
369 EFI_GUID(0x8be0e274, 0x3970, 0x4b44, 0x80, 0xc5, \
370 0x1a, 0xb9, 0x50, 0x2f, 0x3b, 0xfc)
371
Heinrich Schuchardta3a28f52018-02-18 15:17:51 +0100372#define EFI_EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE \
373 EFI_GUID(0x13fa7698, 0xc831, 0x49c7, 0x87, 0xea, \
374 0x8f, 0x43, 0xfc, 0xc2, 0x51, 0x96)
375
376#define EFI_EVENT_GROUP_MEMORY_MAP_CHANGE \
377 EFI_GUID(0x78bee926, 0x692f, 0x48fd, 0x9e, 0xdb, \
378 0x01, 0x42, 0x2e, 0xf0, 0xd7, 0xab)
379
380#define EFI_EVENT_GROUP_READY_TO_BOOT \
381 EFI_GUID(0x7ce88fb3, 0x4bd7, 0x4679, 0x87, 0xa8, \
382 0xa8, 0xd8, 0xde, 0xe5, 0x0d, 0x2b)
383
Heinrich Schuchardt43eaf5b2021-11-16 18:46:27 +0100384#define EFI_EVENT_GROUP_AFTER_READY_TO_BOOT \
385 EFI_GUID(0x3a2a00ad, 0x98b9, 0x4cdf, 0xa4, 0x78, \
386 0x70, 0x27, 0x77, 0xf1, 0xc1, 0xb)
387
Heinrich Schuchardta3a28f52018-02-18 15:17:51 +0100388#define EFI_EVENT_GROUP_RESET_SYSTEM \
389 EFI_GUID(0x62da6a56, 0x13fb, 0x485a, 0xa8, 0xda, \
390 0xa3, 0xdd, 0x79, 0x12, 0xcb, 0x6b)
391
Simon Glass867a6ac2015-07-31 09:31:36 -0600392/* EFI Configuration Table and GUID definitions */
393#define NULL_GUID \
394 EFI_GUID(0x00000000, 0x0000, 0x0000, 0x00, 0x00, \
395 0x00, 0x00, 0x00, 0x00, 0x00, 0x00)
396
Rob Clark9975fe92017-09-13 18:05:38 -0400397#define EFI_GLOBAL_VARIABLE_GUID \
398 EFI_GUID(0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, \
399 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c)
400
AKASHI Takahiro593e17d2020-04-14 11:51:39 +0900401#define EFI_IMAGE_SECURITY_DATABASE_GUID \
402 EFI_GUID(0xd719b2cb, 0x3d3a, 0x4596, 0xa3, 0xbc, \
403 0xda, 0xd0, 0x0e, 0x67, 0x65, 0x6f)
404
Alexander Graf2bb9b792016-03-04 01:09:57 +0100405#define EFI_FDT_GUID \
406 EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5, \
407 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0)
408
Bin Meng86df34d2018-06-27 20:38:03 -0700409#define EFI_ACPI_TABLE_GUID \
410 EFI_GUID(0x8868e871, 0xe4f1, 0x11d3, \
411 0xbc, 0x22, 0x00, 0x80, 0xc7, 0x3c, 0x88, 0x81)
412
Alexander Grafe663b352016-08-19 01:23:29 +0200413#define SMBIOS_TABLE_GUID \
414 EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3, \
415 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
416
Ilias Apalodimasec80b472020-02-21 09:55:45 +0200417#define EFI_LOAD_FILE_PROTOCOL_GUID \
418 EFI_GUID(0x56ec3091, 0x954c, 0x11d2, \
419 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
420
421#define EFI_LOAD_FILE2_PROTOCOL_GUID \
422 EFI_GUID(0x4006c0c1, 0xfcb3, 0x403e, \
423 0x99, 0x6d, 0x4a, 0x6c, 0x87, 0x24, 0xe0, 0x6d)
424
Ilias Apalodimasc8d0fd52020-11-30 11:47:40 +0200425#define EFI_TCG2_FINAL_EVENTS_TABLE_GUID \
426 EFI_GUID(0x1e2ed096, 0x30e2, 0x4254, 0xbd, \
427 0x89, 0x86, 0x3b, 0xbe, 0xf8, 0x23, 0x25)
428
Heinrich Schuchardt3adae642022-01-16 14:10:23 +0100429#define EFI_RNG_PROTOCOL_GUID \
430 EFI_GUID(0x3152bca5, 0xeade, 0x433d, 0x86, 0x2e, \
431 0xc0, 0x1c, 0xdc, 0x29, 0x1f, 0x44)
432
433#define EFI_DT_FIXUP_PROTOCOL_GUID \
434 EFI_GUID(0xe617d64c, 0xfe08, 0x46da, 0xf4, 0xdc, \
435 0xbb, 0xd5, 0x87, 0x0c, 0x73, 0x00)
436
Heinrich Schuchardt38040a62022-01-16 17:46:38 +0100437#define EFI_TCG2_PROTOCOL_GUID \
438 EFI_GUID(0x607f766c, 0x7455, 0x42be, 0x93, \
439 0x0b, 0xe4, 0xd7, 0x6d, 0xb2, 0x72, 0x0f)
440
Sunil V L1ccf8712022-01-28 20:48:44 +0530441#define RISCV_EFI_BOOT_PROTOCOL_GUID \
442 EFI_GUID(0xccd15fec, 0x6f73, 0x4eec, 0x83, \
443 0x95, 0x3e, 0x69, 0xe4, 0xb9, 0x40, 0xbf)
444
Masahisa Kojima45c16fd2021-11-12 16:24:27 +0900445/**
446 * struct efi_configuration_table - EFI Configuration Table
447 *
448 * This table contains a set of GUID/pointer pairs.
449 * The EFI Configuration Table may contain at most one instance of each table type.
450 *
451 * @guid: GUID that uniquely identifies the system configuration table
452 * @table: A pointer to the table associated with guid
453 */
Heinrich Schuchardt2e0d79a2018-09-08 10:50:40 +0200454struct efi_configuration_table {
Alexander Graf2bb9b792016-03-04 01:09:57 +0100455 efi_guid_t guid;
456 void *table;
Heinrich Schuchardt2859f442018-12-18 00:06:05 +0100457} __packed;
Alexander Graf2bb9b792016-03-04 01:09:57 +0100458
459#define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
460
Masahisa Kojima45c16fd2021-11-12 16:24:27 +0900461/**
462 * struct efi_system_table - EFI System Table
463 *
464 * EFI System Table contains pointers to the runtime and boot services tables.
465 *
466 * @hdr: The table header for the EFI System Table
467 * @fw_vendor: A pointer to a null terminated string that identifies the vendor
468 * that produces the system firmware
469 * @fw_revision: The revision of the system firmware
470 * @con_in_handle: The handle for the active console input device
471 * @con_in: A pointer to the EFI_SIMPLE_TEXT_INPUT_PROTOCOL interface
472 * that is associated with con_in_handle
473 * @con_out_handle: The handle for the active console output device
474 * @con_out: A pointer to the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL interface
475 * that is associated with con_out_handle
476 * @stderr_handle: The handle for the active standard error console device
477 * @std_err: A pointer to the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL interface
478 * that is associated with stderr_handle
479 * @runtime: A pointer to the EFI Runtime Services Table
480 * @boottime: A pointer to the EFI Boot Services Table
481 * @nr_tables: The number of system configuration tables
482 * @tables: A pointer to the system configuration tables
483 */
Simon Glass867a6ac2015-07-31 09:31:36 -0600484struct efi_system_table {
485 struct efi_table_hdr hdr;
Heinrich Schuchardt0b386532018-06-28 12:45:30 +0200486 u16 *fw_vendor; /* physical addr of wchar_t vendor string */
Simon Glass867a6ac2015-07-31 09:31:36 -0600487 u32 fw_revision;
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +0100488 efi_handle_t con_in_handle;
Heinrich Schuchardt3e603ec2018-09-08 10:20:10 +0200489 struct efi_simple_text_input_protocol *con_in;
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +0100490 efi_handle_t con_out_handle;
Simon Glass867a6ac2015-07-31 09:31:36 -0600491 struct efi_simple_text_output_protocol *con_out;
Heinrich Schuchardtcc20ed02018-01-19 20:24:52 +0100492 efi_handle_t stderr_handle;
Alexander Graf2bb9b792016-03-04 01:09:57 +0100493 struct efi_simple_text_output_protocol *std_err;
Simon Glass867a6ac2015-07-31 09:31:36 -0600494 struct efi_runtime_services *runtime;
495 struct efi_boot_services *boottime;
Heinrich Schuchardtf5a2a932017-11-06 21:17:48 +0100496 efi_uintn_t nr_tables;
Alexander Graf2bb9b792016-03-04 01:09:57 +0100497 struct efi_configuration_table *tables;
Simon Glass867a6ac2015-07-31 09:31:36 -0600498};
499
Heinrich Schuchardtdec88e42019-04-20 07:39:11 +0200500#define EFI_LOADED_IMAGE_PROTOCOL_GUID \
Alexander Graf2bb9b792016-03-04 01:09:57 +0100501 EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, \
502 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
503
Heinrich Schuchardtdec88e42019-04-20 07:39:11 +0200504#define EFI_LOADED_IMAGE_DEVICE_PATH_PROTOCOL_GUID \
AKASHI Takahirobc8fc322019-03-27 13:40:32 +0900505 EFI_GUID(0xbc62157e, 0x3e33, 0x4fec, \
506 0x99, 0x20, 0x2d, 0x3b, 0x36, 0xd7, 0x50, 0xdf)
507
Heinrich Schuchardt95147312018-07-05 08:17:58 +0200508#define EFI_LOADED_IMAGE_PROTOCOL_REVISION 0x1000
509
Simon Glass867a6ac2015-07-31 09:31:36 -0600510struct efi_loaded_image {
511 u32 revision;
512 void *parent_handle;
513 struct efi_system_table *system_table;
Heinrich Schuchardt43dace52018-04-03 22:29:33 +0200514 efi_handle_t device_handle;
515 struct efi_device_path *file_path;
Simon Glass867a6ac2015-07-31 09:31:36 -0600516 void *reserved;
517 u32 load_options_size;
518 void *load_options;
519 void *image_base;
520 aligned_u64 image_size;
521 unsigned int image_code_type;
522 unsigned int image_data_type;
Heinrich Schuchardtdf116e82019-05-01 18:25:45 +0200523 efi_status_t (EFIAPI *unload)(efi_handle_t image_handle);
Simon Glass867a6ac2015-07-31 09:31:36 -0600524};
525
Heinrich Schuchardtdec88e42019-04-20 07:39:11 +0200526#define EFI_DEVICE_PATH_PROTOCOL_GUID \
Alexander Graf2bb9b792016-03-04 01:09:57 +0100527 EFI_GUID(0x09576e91, 0x6d3f, 0x11d2, \
Heinrich Schuchardt2e0d79a2018-09-08 10:50:40 +0200528 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
Alexander Graf2bb9b792016-03-04 01:09:57 +0100529
530#define DEVICE_PATH_TYPE_END 0x7f
Heinrich Schuchardt3acef5d2018-04-16 07:59:09 +0200531# define DEVICE_PATH_SUB_TYPE_INSTANCE_END 0x01
Alexander Graf2bb9b792016-03-04 01:09:57 +0100532# define DEVICE_PATH_SUB_TYPE_END 0xff
533
Simon Glass867a6ac2015-07-31 09:31:36 -0600534struct efi_device_path {
535 u8 type;
536 u8 sub_type;
537 u16 length;
Rob Clarka8606ef2017-09-13 18:05:26 -0400538} __packed;
Simon Glass867a6ac2015-07-31 09:31:36 -0600539
Oleksandr Tymoshenkod7608ab2016-10-24 10:47:01 -0700540struct efi_mac_addr {
541 u8 addr[32];
Rob Clarka8606ef2017-09-13 18:05:26 -0400542} __packed;
Oleksandr Tymoshenkod7608ab2016-10-24 10:47:01 -0700543
Peter Jonesc80214c2017-09-13 18:05:27 -0400544#define DEVICE_PATH_TYPE_HARDWARE_DEVICE 0x01
Rob Clarkbf192732017-10-10 08:23:06 -0400545# define DEVICE_PATH_SUB_TYPE_MEMORY 0x03
Peter Jonesc80214c2017-09-13 18:05:27 -0400546# define DEVICE_PATH_SUB_TYPE_VENDOR 0x04
547
Rob Clarkbf192732017-10-10 08:23:06 -0400548struct efi_device_path_memory {
549 struct efi_device_path dp;
550 u32 memory_type;
551 u64 start_address;
552 u64 end_address;
553} __packed;
554
Peter Jonesc80214c2017-09-13 18:05:27 -0400555struct efi_device_path_vendor {
556 struct efi_device_path dp;
557 efi_guid_t guid;
558 u8 vendor_data[];
559} __packed;
560
561#define DEVICE_PATH_TYPE_ACPI_DEVICE 0x02
562# define DEVICE_PATH_SUB_TYPE_ACPI_DEVICE 0x01
563
564#define EFI_PNP_ID(ID) (u32)(((ID) << 16) | 0x41D0)
565#define EISA_PNP_ID(ID) EFI_PNP_ID(ID)
Rob Clarkadae4312017-09-13 18:05:30 -0400566#define EISA_PNP_NUM(ID) ((ID) >> 16)
Peter Jonesc80214c2017-09-13 18:05:27 -0400567
568struct efi_device_path_acpi_path {
569 struct efi_device_path dp;
570 u32 hid;
571 u32 uid;
572} __packed;
573
Oleksandr Tymoshenkod7608ab2016-10-24 10:47:01 -0700574#define DEVICE_PATH_TYPE_MESSAGING_DEVICE 0x03
Heinrich Schuchardtaf3106a2017-12-11 12:56:44 +0100575# define DEVICE_PATH_SUB_TYPE_MSG_ATAPI 0x01
576# define DEVICE_PATH_SUB_TYPE_MSG_SCSI 0x02
Peter Jonesc80214c2017-09-13 18:05:27 -0400577# define DEVICE_PATH_SUB_TYPE_MSG_USB 0x05
Oleksandr Tymoshenkod7608ab2016-10-24 10:47:01 -0700578# define DEVICE_PATH_SUB_TYPE_MSG_MAC_ADDR 0x0b
Heinrich Schuchardtf0272222021-03-19 02:49:54 +0100579# define DEVICE_PATH_SUB_TYPE_MSG_UART 0x0e
Rob Clarkb66c60d2017-09-13 18:05:28 -0400580# define DEVICE_PATH_SUB_TYPE_MSG_USB_CLASS 0x0f
Heinrich Schuchardtbf3bcef2020-05-20 23:12:02 +0200581# define DEVICE_PATH_SUB_TYPE_MSG_SATA 0x12
Patrick Wildtf2d247d2019-10-03 16:24:17 +0200582# define DEVICE_PATH_SUB_TYPE_MSG_NVME 0x17
Heinrich Schuchardt148ce202021-08-05 21:10:05 +0000583# define DEVICE_PATH_SUB_TYPE_MSG_URI 0x18
Peter Jonesc80214c2017-09-13 18:05:27 -0400584# define DEVICE_PATH_SUB_TYPE_MSG_SD 0x1a
585# define DEVICE_PATH_SUB_TYPE_MSG_MMC 0x1d
586
Heinrich Schuchardtaf3106a2017-12-11 12:56:44 +0100587struct efi_device_path_atapi {
588 struct efi_device_path dp;
589 u8 primary_secondary;
590 u8 slave_master;
591 u16 logical_unit_number;
592} __packed;
593
594struct efi_device_path_scsi {
595 struct efi_device_path dp;
596 u16 target_id;
597 u16 logical_unit_number;
598} __packed;
599
Heinrich Schuchardtf0272222021-03-19 02:49:54 +0100600struct efi_device_path_uart {
601 struct efi_device_path dp;
602 u32 reserved;
603 u64 baud_rate;
604 u8 data_bits;
605 u8 parity;
606 u8 stop_bits;
607} __packed;
608
Peter Jonesc80214c2017-09-13 18:05:27 -0400609struct efi_device_path_usb {
610 struct efi_device_path dp;
611 u8 parent_port_number;
612 u8 usb_interface;
613} __packed;
Oleksandr Tymoshenkod7608ab2016-10-24 10:47:01 -0700614
Heinrich Schuchardtbf3bcef2020-05-20 23:12:02 +0200615struct efi_device_path_sata {
616 struct efi_device_path dp;
617 u16 hba_port;
618 u16 port_multiplier_port;
619 u16 logical_unit_number;
620} __packed;
621
Oleksandr Tymoshenkod7608ab2016-10-24 10:47:01 -0700622struct efi_device_path_mac_addr {
623 struct efi_device_path dp;
624 struct efi_mac_addr mac;
625 u8 if_type;
Rob Clarka8606ef2017-09-13 18:05:26 -0400626} __packed;
Oleksandr Tymoshenkod7608ab2016-10-24 10:47:01 -0700627
Rob Clarkb66c60d2017-09-13 18:05:28 -0400628struct efi_device_path_usb_class {
629 struct efi_device_path dp;
630 u16 vendor_id;
631 u16 product_id;
632 u8 device_class;
633 u8 device_subclass;
634 u8 device_protocol;
635} __packed;
636
Peter Jonesc80214c2017-09-13 18:05:27 -0400637struct efi_device_path_sd_mmc_path {
638 struct efi_device_path dp;
639 u8 slot_number;
640} __packed;
641
Patrick Wildtf2d247d2019-10-03 16:24:17 +0200642struct efi_device_path_nvme {
643 struct efi_device_path dp;
644 u32 ns_id;
645 u8 eui64[8];
646} __packed;
647
Heinrich Schuchardt148ce202021-08-05 21:10:05 +0000648struct efi_device_path_uri {
649 struct efi_device_path dp;
650 u8 uri[];
651} __packed;
652
Alexander Graf2bb9b792016-03-04 01:09:57 +0100653#define DEVICE_PATH_TYPE_MEDIA_DEVICE 0x04
Peter Jonesc80214c2017-09-13 18:05:27 -0400654# define DEVICE_PATH_SUB_TYPE_HARD_DRIVE_PATH 0x01
655# define DEVICE_PATH_SUB_TYPE_CDROM_PATH 0x02
Ilias Apalodimasec80b472020-02-21 09:55:45 +0200656# define DEVICE_PATH_SUB_TYPE_VENDOR_PATH 0x03
Alexander Graf2bb9b792016-03-04 01:09:57 +0100657# define DEVICE_PATH_SUB_TYPE_FILE_PATH 0x04
658
Peter Jonesc80214c2017-09-13 18:05:27 -0400659struct efi_device_path_hard_drive_path {
660 struct efi_device_path dp;
661 u32 partition_number;
662 u64 partition_start;
663 u64 partition_end;
664 u8 partition_signature[16];
665 u8 partmap_type;
666 u8 signature_type;
667} __packed;
668
669struct efi_device_path_cdrom_path {
670 struct efi_device_path dp;
671 u32 boot_entry;
672 u64 partition_start;
Heinrich Schuchardtd0384d52019-09-04 13:56:01 +0200673 u64 partition_size;
Peter Jonesc80214c2017-09-13 18:05:27 -0400674} __packed;
675
Alexander Graf2bb9b792016-03-04 01:09:57 +0100676struct efi_device_path_file_path {
677 struct efi_device_path dp;
Rob Clark61b7e222017-09-13 18:05:39 -0400678 u16 str[];
Rob Clarka8606ef2017-09-13 18:05:26 -0400679} __packed;
Alexander Graf2bb9b792016-03-04 01:09:57 +0100680
Heinrich Schuchardtdec88e42019-04-20 07:39:11 +0200681#define EFI_BLOCK_IO_PROTOCOL_GUID \
Alexander Graf2bb9b792016-03-04 01:09:57 +0100682 EFI_GUID(0x964e5b21, 0x6459, 0x11d2, \
683 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
684
Heinrich Schuchardt2e0d79a2018-09-08 10:50:40 +0200685struct efi_block_io_media {
Alexander Graf2bb9b792016-03-04 01:09:57 +0100686 u32 media_id;
687 char removable_media;
688 char media_present;
689 char logical_partition;
690 char read_only;
691 char write_caching;
692 u8 pad[3];
693 u32 block_size;
694 u32 io_align;
695 u8 pad2[4];
696 u64 last_block;
Heinrich Schuchardt4f948652018-01-19 20:24:48 +0100697 /* Added in revision 2 of the protocol */
698 u64 lowest_aligned_lba;
699 u32 logical_blocks_per_physical_block;
700 /* Added in revision 3 of the protocol */
701 u32 optimal_transfer_length_granualarity;
Alexander Graf2bb9b792016-03-04 01:09:57 +0100702};
703
Heinrich Schuchardt4f948652018-01-19 20:24:48 +0100704#define EFI_BLOCK_IO_PROTOCOL_REVISION2 0x00020001
705#define EFI_BLOCK_IO_PROTOCOL_REVISION3 0x0002001f
706
Alexander Graf2bb9b792016-03-04 01:09:57 +0100707struct efi_block_io {
708 u64 revision;
709 struct efi_block_io_media *media;
710 efi_status_t (EFIAPI *reset)(struct efi_block_io *this,
711 char extended_verification);
712 efi_status_t (EFIAPI *read_blocks)(struct efi_block_io *this,
Heinrich Schuchardt4f948652018-01-19 20:24:48 +0100713 u32 media_id, u64 lba, efi_uintn_t buffer_size,
Alexander Graf2bb9b792016-03-04 01:09:57 +0100714 void *buffer);
715 efi_status_t (EFIAPI *write_blocks)(struct efi_block_io *this,
Heinrich Schuchardt4f948652018-01-19 20:24:48 +0100716 u32 media_id, u64 lba, efi_uintn_t buffer_size,
Alexander Graf2bb9b792016-03-04 01:09:57 +0100717 void *buffer);
718 efi_status_t (EFIAPI *flush_blocks)(struct efi_block_io *this);
719};
720
Simon Glass867a6ac2015-07-31 09:31:36 -0600721struct simple_text_output_mode {
722 s32 max_mode;
723 s32 mode;
724 s32 attribute;
725 s32 cursor_column;
726 s32 cursor_row;
727 bool cursor_visible;
728};
729
Rob Clarka17e62c2017-07-24 10:39:01 -0400730#define EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID \
731 EFI_GUID(0x387477c2, 0x69c7, 0x11d2, \
732 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
733
Rob Clark2d5dc2a2017-10-10 08:23:01 -0400734#define EFI_BLACK 0x00
735#define EFI_BLUE 0x01
736#define EFI_GREEN 0x02
737#define EFI_CYAN 0x03
738#define EFI_RED 0x04
739#define EFI_MAGENTA 0x05
740#define EFI_BROWN 0x06
741#define EFI_LIGHTGRAY 0x07
742#define EFI_BRIGHT 0x08
743#define EFI_DARKGRAY 0x08
744#define EFI_LIGHTBLUE 0x09
745#define EFI_LIGHTGREEN 0x0a
746#define EFI_LIGHTCYAN 0x0b
747#define EFI_LIGHTRED 0x0c
748#define EFI_LIGHTMAGENTA 0x0d
749#define EFI_YELLOW 0x0e
750#define EFI_WHITE 0x0f
751#define EFI_BACKGROUND_BLACK 0x00
752#define EFI_BACKGROUND_BLUE 0x10
753#define EFI_BACKGROUND_GREEN 0x20
754#define EFI_BACKGROUND_CYAN 0x30
755#define EFI_BACKGROUND_RED 0x40
756#define EFI_BACKGROUND_MAGENTA 0x50
757#define EFI_BACKGROUND_BROWN 0x60
758#define EFI_BACKGROUND_LIGHTGRAY 0x70
759
760/* extract foreground color from EFI attribute */
761#define EFI_ATTR_FG(attr) ((attr) & 0x07)
762/* treat high bit of FG as bright/bold (similar to edk2) */
763#define EFI_ATTR_BOLD(attr) (((attr) >> 3) & 0x01)
764/* extract background color from EFI attribute */
765#define EFI_ATTR_BG(attr) (((attr) >> 4) & 0x7)
766
Simon Glass867a6ac2015-07-31 09:31:36 -0600767struct efi_simple_text_output_protocol {
Heinrich Schuchardt21b6b542019-06-15 14:47:25 +0200768 efi_status_t (EFIAPI *reset)(
769 struct efi_simple_text_output_protocol *this,
770 char extended_verification);
Simon Glass867a6ac2015-07-31 09:31:36 -0600771 efi_status_t (EFIAPI *output_string)(
772 struct efi_simple_text_output_protocol *this,
Heinrich Schuchardt7913c7d2021-01-05 07:50:09 +0100773 const u16 *str);
Alexander Graf2bb9b792016-03-04 01:09:57 +0100774 efi_status_t (EFIAPI *test_string)(
775 struct efi_simple_text_output_protocol *this,
Heinrich Schuchardt7913c7d2021-01-05 07:50:09 +0100776 const u16 *str);
Simon Glass867a6ac2015-07-31 09:31:36 -0600777 efi_status_t(EFIAPI *query_mode)(
778 struct efi_simple_text_output_protocol *this,
779 unsigned long mode_number, unsigned long *columns,
780 unsigned long *rows);
781 efi_status_t(EFIAPI *set_mode)(
782 struct efi_simple_text_output_protocol *this,
783 unsigned long mode_number);
784 efi_status_t(EFIAPI *set_attribute)(
785 struct efi_simple_text_output_protocol *this,
786 unsigned long attribute);
787 efi_status_t(EFIAPI *clear_screen) (
788 struct efi_simple_text_output_protocol *this);
789 efi_status_t(EFIAPI *set_cursor_position) (
790 struct efi_simple_text_output_protocol *this,
791 unsigned long column, unsigned long row);
Alexander Graf2bb9b792016-03-04 01:09:57 +0100792 efi_status_t(EFIAPI *enable_cursor)(
793 struct efi_simple_text_output_protocol *this,
794 bool enable);
Simon Glass867a6ac2015-07-31 09:31:36 -0600795 struct simple_text_output_mode *mode;
796};
797
Heinrich Schuchardt110c6282018-09-11 22:38:08 +0200798#define EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL_GUID \
799 EFI_GUID(0xdd9e7534, 0x7762, 0x4698, \
800 0x8c, 0x14, 0xf5, 0x85, 0x17, 0xa6, 0x25, 0xaa)
801
Simon Glass867a6ac2015-07-31 09:31:36 -0600802struct efi_input_key {
803 u16 scan_code;
804 s16 unicode_char;
805};
806
Heinrich Schuchardt110c6282018-09-11 22:38:08 +0200807#define EFI_SHIFT_STATE_INVALID 0x00000000
808#define EFI_RIGHT_SHIFT_PRESSED 0x00000001
809#define EFI_LEFT_SHIFT_PRESSED 0x00000002
810#define EFI_RIGHT_CONTROL_PRESSED 0x00000004
811#define EFI_LEFT_CONTROL_PRESSED 0x00000008
812#define EFI_RIGHT_ALT_PRESSED 0x00000010
813#define EFI_LEFT_ALT_PRESSED 0x00000020
814#define EFI_RIGHT_LOGO_PRESSED 0x00000040
815#define EFI_LEFT_LOGO_PRESSED 0x00000080
816#define EFI_MENU_KEY_PRESSED 0x00000100
817#define EFI_SYS_REQ_PRESSED 0x00000200
818#define EFI_SHIFT_STATE_VALID 0x80000000
819
820#define EFI_TOGGLE_STATE_INVALID 0x00
821#define EFI_SCROLL_LOCK_ACTIVE 0x01
822#define EFI_NUM_LOCK_ACTIVE 0x02
823#define EFI_CAPS_LOCK_ACTIVE 0x04
824#define EFI_KEY_STATE_EXPOSED 0x40
825#define EFI_TOGGLE_STATE_VALID 0x80
826
827struct efi_key_state {
828 u32 key_shift_state;
829 u8 key_toggle_state;
830};
831
832struct efi_key_data {
833 struct efi_input_key key;
834 struct efi_key_state key_state;
835};
836
837struct efi_simple_text_input_ex_protocol {
838 efi_status_t (EFIAPI *reset) (
839 struct efi_simple_text_input_ex_protocol *this,
840 bool extended_verification);
841 efi_status_t (EFIAPI *read_key_stroke_ex) (
842 struct efi_simple_text_input_ex_protocol *this,
843 struct efi_key_data *key_data);
844 struct efi_event *wait_for_key_ex;
845 efi_status_t (EFIAPI *set_state) (
846 struct efi_simple_text_input_ex_protocol *this,
Heinrich Schuchardtacee9652019-05-18 17:07:52 +0200847 u8 *key_toggle_state);
Heinrich Schuchardt110c6282018-09-11 22:38:08 +0200848 efi_status_t (EFIAPI *register_key_notify) (
849 struct efi_simple_text_input_ex_protocol *this,
850 struct efi_key_data *key_data,
851 efi_status_t (EFIAPI *key_notify_function)(
852 struct efi_key_data *key_data),
853 void **notify_handle);
854 efi_status_t (EFIAPI *unregister_key_notify) (
855 struct efi_simple_text_input_ex_protocol *this,
856 void *notification_handle);
857};
858
Rob Clarka17e62c2017-07-24 10:39:01 -0400859#define EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID \
860 EFI_GUID(0x387477c1, 0x69c7, 0x11d2, \
861 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
862
Heinrich Schuchardt3e603ec2018-09-08 10:20:10 +0200863struct efi_simple_text_input_protocol {
864 efi_status_t(EFIAPI *reset)(struct efi_simple_text_input_protocol *this,
865 bool extended_verification);
Simon Glass867a6ac2015-07-31 09:31:36 -0600866 efi_status_t(EFIAPI *read_key_stroke)(
Heinrich Schuchardt3e603ec2018-09-08 10:20:10 +0200867 struct efi_simple_text_input_protocol *this,
Simon Glass867a6ac2015-07-31 09:31:36 -0600868 struct efi_input_key *key);
xypron.glpk@gmx.de2fd945f2017-07-18 20:17:17 +0200869 struct efi_event *wait_for_key;
Simon Glass867a6ac2015-07-31 09:31:36 -0600870};
871
xypron.glpk@gmx.decc5b7082017-07-11 22:06:25 +0200872#define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID \
873 EFI_GUID(0x8b843e20, 0x8132, 0x4852, \
874 0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c)
875
Heinrich Schuchardt2e0d79a2018-09-08 10:50:40 +0200876struct efi_device_path_to_text_protocol {
xypron.glpk@gmx.decc5b7082017-07-11 22:06:25 +0200877 uint16_t *(EFIAPI *convert_device_node_to_text)(
Rob Clark9309a1b2017-09-13 18:05:29 -0400878 struct efi_device_path *device_node,
xypron.glpk@gmx.decc5b7082017-07-11 22:06:25 +0200879 bool display_only,
880 bool allow_shortcuts);
881 uint16_t *(EFIAPI *convert_device_path_to_text)(
Rob Clark9309a1b2017-09-13 18:05:29 -0400882 struct efi_device_path *device_path,
xypron.glpk@gmx.decc5b7082017-07-11 22:06:25 +0200883 bool display_only,
884 bool allow_shortcuts);
885};
886
Leif Lindholme70f8df2018-03-09 17:43:21 +0100887#define EFI_DEVICE_PATH_UTILITIES_PROTOCOL_GUID \
888 EFI_GUID(0x0379be4e, 0xd706, 0x437d, \
889 0xb0, 0x37, 0xed, 0xb8, 0x2f, 0xb7, 0x72, 0xa4)
890
891struct efi_device_path_utilities_protocol {
892 efi_uintn_t (EFIAPI *get_device_path_size)(
893 const struct efi_device_path *device_path);
894 struct efi_device_path *(EFIAPI *duplicate_device_path)(
895 const struct efi_device_path *device_path);
896 struct efi_device_path *(EFIAPI *append_device_path)(
897 const struct efi_device_path *src1,
898 const struct efi_device_path *src2);
899 struct efi_device_path *(EFIAPI *append_device_node)(
900 const struct efi_device_path *device_path,
901 const struct efi_device_path *device_node);
902 struct efi_device_path *(EFIAPI *append_device_path_instance)(
903 const struct efi_device_path *device_path,
904 const struct efi_device_path *device_path_instance);
905 struct efi_device_path *(EFIAPI *get_next_device_path_instance)(
906 struct efi_device_path **device_path_instance,
907 efi_uintn_t *device_path_instance_size);
908 bool (EFIAPI *is_device_path_multi_instance)(
909 const struct efi_device_path *device_path);
910 struct efi_device_path *(EFIAPI *create_device_node)(
911 uint8_t node_type,
912 uint8_t node_sub_type,
913 uint16_t node_length);
914};
915
Leif Lindholmc9bfb222019-01-21 12:12:57 +0900916/*
917 * Human Interface Infrastructure (HII)
918 */
919struct efi_hii_package_list_header {
920 efi_guid_t package_list_guid;
921 u32 package_length;
922} __packed;
923
924/**
925 * struct efi_hii_package_header - EFI HII package header
926 *
927 * @fields: 'fields' replaces the bit-fields defined in the EFI
928 * specification to to avoid possible compiler incompatibilities::
929 *
Heinrich Schuchardte032cb22021-11-20 09:28:54 +0100930 * u32 length:24;
931 * u32 type:8;
Leif Lindholmc9bfb222019-01-21 12:12:57 +0900932 */
933struct efi_hii_package_header {
934 u32 fields;
935} __packed;
936
937#define __EFI_HII_PACKAGE_LEN_SHIFT 0
938#define __EFI_HII_PACKAGE_TYPE_SHIFT 24
939#define __EFI_HII_PACKAGE_LEN_MASK 0xffffff
940#define __EFI_HII_PACKAGE_TYPE_MASK 0xff
941
942#define EFI_HII_PACKAGE_TYPE_ALL 0x00
943#define EFI_HII_PACKAGE_TYPE_GUID 0x01
944#define EFI_HII_PACKAGE_FORMS 0x02
945#define EFI_HII_PACKAGE_STRINGS 0x04
946#define EFI_HII_PACKAGE_FONTS 0x05
947#define EFI_HII_PACKAGE_IMAGES 0x06
948#define EFI_HII_PACKAGE_SIMPLE_FONTS 0x07
949#define EFI_HII_PACKAGE_DEVICE_PATH 0x08
950#define EFI_HII_PACKAGE_KEYBOARD_LAYOUT 0x09
951#define EFI_HII_PACKAGE_ANIMATIONS 0x0A
952#define EFI_HII_PACKAGE_END 0xDF
953#define EFI_HII_PACKAGE_TYPE_SYSTEM_BEGIN 0xE0
954#define EFI_HII_PACKAGE_TYPE_SYSTEM_END 0xFF
955
956/*
AKASHI Takahiro9ab0bdd2019-01-21 12:12:58 +0900957 * HII GUID package
958 */
959struct efi_hii_guid_package {
960 struct efi_hii_package_header header;
961 efi_guid_t guid;
962 char data[];
963} __packed;
964
965/*
Leif Lindholmc9bfb222019-01-21 12:12:57 +0900966 * HII string package
967 */
968struct efi_hii_strings_package {
969 struct efi_hii_package_header header;
970 u32 header_size;
971 u32 string_info_offset;
972 u16 language_window[16];
973 efi_string_id_t language_name;
974 u8 language[];
975} __packed;
976
977struct efi_hii_string_block {
978 u8 block_type;
979 /* u8 block_body[]; */
980} __packed;
981
982#define EFI_HII_SIBT_END 0x00
983#define EFI_HII_SIBT_STRING_SCSU 0x10
984#define EFI_HII_SIBT_STRING_SCSU_FONT 0x11
985#define EFI_HII_SIBT_STRINGS_SCSU 0x12
986#define EFI_HII_SIBT_STRINGS_SCSU_FONT 0x13
987#define EFI_HII_SIBT_STRING_UCS2 0x14
988#define EFI_HII_SIBT_STRING_UCS2_FONT 0x15
989#define EFI_HII_SIBT_STRINGS_UCS2 0x16
990#define EFI_HII_SIBT_STRINGS_UCS2_FONT 0x17
991#define EFI_HII_SIBT_DUPLICATE 0x20
992#define EFI_HII_SIBT_SKIP2 0x21
993#define EFI_HII_SIBT_SKIP1 0x22
994#define EFI_HII_SIBT_EXT1 0x30
995#define EFI_HII_SIBT_EXT2 0x31
996#define EFI_HII_SIBT_EXT4 0x32
997#define EFI_HII_SIBT_FONT 0x40
998
999struct efi_hii_sibt_string_ucs2_block {
1000 struct efi_hii_string_block header;
1001 u16 string_text[];
1002} __packed;
1003
1004static inline struct efi_hii_string_block *
1005efi_hii_sibt_string_ucs2_block_next(struct efi_hii_sibt_string_ucs2_block *blk)
1006{
1007 return ((void *)blk) + sizeof(*blk) +
1008 (u16_strlen(blk->string_text) + 1) * 2;
1009}
1010
1011/*
AKASHI Takahirocb728e52019-01-21 12:13:00 +09001012 * HII forms package
1013 * TODO: full scope of definitions
1014 */
1015struct efi_hii_time {
1016 u8 hour;
1017 u8 minute;
1018 u8 second;
1019};
1020
1021struct efi_hii_date {
1022 u16 year;
1023 u8 month;
1024 u8 day;
1025};
1026
1027struct efi_hii_ref {
1028 efi_question_id_t question_id;
1029 efi_form_id_t form_id;
1030 efi_guid_t form_set_guid;
1031 efi_string_id_t device_path;
1032};
1033
1034union efi_ifr_type_value {
1035 u8 u8; // EFI_IFR_TYPE_NUM_SIZE_8
1036 u16 u16; // EFI_IFR_TYPE_NUM_SIZE_16
1037 u32 u32; // EFI_IFR_TYPE_NUM_SIZE_32
1038 u64 u64; // EFI_IFR_TYPE_NUM_SIZE_64
1039 bool b; // EFI_IFR_TYPE_BOOLEAN
1040 struct efi_hii_time time; // EFI_IFR_TYPE_TIME
1041 struct efi_hii_date date; // EFI_IFR_TYPE_DATE
1042 efi_string_id_t string; // EFI_IFR_TYPE_STRING, EFI_IFR_TYPE_ACTION
1043 struct efi_hii_ref ref; // EFI_IFR_TYPE_REF
1044 // u8 buffer[]; // EFI_IFR_TYPE_BUFFER
1045};
1046
1047#define EFI_IFR_TYPE_NUM_SIZE_8 0x00
1048#define EFI_IFR_TYPE_NUM_SIZE_16 0x01
1049#define EFI_IFR_TYPE_NUM_SIZE_32 0x02
1050#define EFI_IFR_TYPE_NUM_SIZE_64 0x03
1051#define EFI_IFR_TYPE_BOOLEAN 0x04
1052#define EFI_IFR_TYPE_TIME 0x05
1053#define EFI_IFR_TYPE_DATE 0x06
1054#define EFI_IFR_TYPE_STRING 0x07
1055#define EFI_IFR_TYPE_OTHER 0x08
1056#define EFI_IFR_TYPE_UNDEFINED 0x09
1057#define EFI_IFR_TYPE_ACTION 0x0A
1058#define EFI_IFR_TYPE_BUFFER 0x0B
1059#define EFI_IFR_TYPE_REF 0x0C
1060#define EFI_IFR_OPTION_DEFAULT 0x10
1061#define EFI_IFR_OPTION_DEFAULT_MFG 0x20
1062
1063#define EFI_IFR_ONE_OF_OPTION_OP 0x09
1064
1065struct efi_ifr_op_header {
1066 u8 opCode;
1067 u8 length:7;
1068 u8 scope:1;
1069};
1070
1071struct efi_ifr_one_of_option {
1072 struct efi_ifr_op_header header;
1073 efi_string_id_t option;
1074 u8 flags;
1075 u8 type;
1076 union efi_ifr_type_value value;
1077};
1078
1079typedef efi_uintn_t efi_browser_action_t;
1080
1081#define EFI_BROWSER_ACTION_REQUEST_NONE 0
1082#define EFI_BROWSER_ACTION_REQUEST_RESET 1
1083#define EFI_BROWSER_ACTION_REQUEST_SUBMIT 2
1084#define EFI_BROWSER_ACTION_REQUEST_EXIT 3
1085#define EFI_BROWSER_ACTION_REQUEST_FORM_SUBMIT_EXIT 4
1086#define EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD_EXIT 5
1087#define EFI_BROWSER_ACTION_REQUEST_FORM_APPLY 6
1088#define EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD 7
1089#define EFI_BROWSER_ACTION_REQUEST_RECONNECT 8
1090
1091typedef efi_uintn_t efi_browser_action_request_t;
1092
1093#define EFI_BROWSER_ACTION_CHANGING 0
1094#define EFI_BROWSER_ACTION_CHANGED 1
1095#define EFI_BROWSER_ACTION_RETRIEVE 2
1096#define EFI_BROWSER_ACTION_FORM_OPEN 3
1097#define EFI_BROWSER_ACTION_FORM_CLOSE 4
1098#define EFI_BROWSER_ACTION_SUBMITTED 5
1099#define EFI_BROWSER_ACTION_DEFAULT_STANDARD 0x1000
1100#define EFI_BROWSER_ACTION_DEFAULT_MANUFACTURING 0x1001
1101#define EFI_BROWSER_ACTION_DEFAULT_SAFE 0x1002
1102#define EFI_BROWSER_ACTION_DEFAULT_PLATFORM 0x2000
1103#define EFI_BROWSER_ACTION_DEFAULT_HARDWARE 0x3000
1104#define EFI_BROWSER_ACTION_DEFAULT_FIRMWARE 0x4000
1105
1106/*
Leif Lindholmc9bfb222019-01-21 12:12:57 +09001107 * HII keyboard package
1108 */
1109typedef enum {
1110 EFI_KEY_LCTRL, EFI_KEY_A0, EFI_KEY_LALT, EFI_KEY_SPACE_BAR,
1111 EFI_KEY_A2, EFI_KEY_A3, EFI_KEY_A4, EFI_KEY_RCTRL, EFI_KEY_LEFT_ARROW,
1112 EFI_KEY_DOWN_ARROW, EFI_KEY_RIGHT_ARROW, EFI_KEY_ZERO,
1113 EFI_KEY_PERIOD, EFI_KEY_ENTER, EFI_KEY_LSHIFT, EFI_KEY_B0,
1114 EFI_KEY_B1, EFI_KEY_B2, EFI_KEY_B3, EFI_KEY_B4, EFI_KEY_B5, EFI_KEY_B6,
1115 EFI_KEY_B7, EFI_KEY_B8, EFI_KEY_B9, EFI_KEY_B10, EFI_KEY_RSHIFT,
1116 EFI_KEY_UP_ARROW, EFI_KEY_ONE, EFI_KEY_TWO, EFI_KEY_THREE,
1117 EFI_KEY_CAPS_LOCK, EFI_KEY_C1, EFI_KEY_C2, EFI_KEY_C3, EFI_KEY_C4,
1118 EFI_KEY_C5, EFI_KEY_C6, EFI_KEY_C7, EFI_KEY_C8, EFI_KEY_C9,
1119 EFI_KEY_C10, EFI_KEY_C11, EFI_KEY_C12, EFI_KEY_FOUR, EFI_KEY_FIVE,
1120 EFI_KEY_SIX, EFI_KEY_PLUS, EFI_KEY_TAB, EFI_KEY_D1, EFI_KEY_D2,
1121 EFI_KEY_D3, EFI_KEY_D4, EFI_KEY_D5, EFI_KEY_D6, EFI_KEY_D7, EFI_KEY_D8,
1122 EFI_KEY_D9, EFI_KEY_D10, EFI_KEY_D11, EFI_KEY_D12, EFI_KEY_D13,
1123 EFI_KEY_DEL, EFI_KEY_END, EFI_KEY_PG_DN, EFI_KEY_SEVEN, EFI_KEY_EIGHT,
1124 EFI_KEY_NINE, EFI_KEY_E0, EFI_KEY_E1, EFI_KEY_E2, EFI_KEY_E3,
1125 EFI_KEY_E4, EFI_KEY_E5, EFI_KEY_E6, EFI_KEY_E7, EFI_KEY_E8, EFI_KEY_E9,
1126 EFI_KEY_E10, EFI_KEY_E11, EFI_KEY_E12, EFI_KEY_BACK_SPACE,
1127 EFI_KEY_INS, EFI_KEY_HOME, EFI_KEY_PG_UP, EFI_KEY_NLCK, EFI_KEY_SLASH,
1128 EFI_KEY_ASTERISK, EFI_KEY_MINUS, EFI_KEY_ESC, EFI_KEY_F1, EFI_KEY_F2,
1129 EFI_KEY_F3, EFI_KEY_F4, EFI_KEY_F5, EFI_KEY_F6, EFI_KEY_F7, EFI_KEY_F8,
1130 EFI_KEY_F9, EFI_KEY_F10, EFI_KEY_F11, EFI_KEY_F12, EFI_KEY_PRINT,
1131 EFI_KEY_SLCK, EFI_KEY_PAUSE,
1132} efi_key;
1133
1134struct efi_key_descriptor {
1135 u32 key;
1136 u16 unicode;
1137 u16 shifted_unicode;
1138 u16 alt_gr_unicode;
1139 u16 shifted_alt_gr_unicode;
1140 u16 modifier;
1141 u16 affected_attribute;
1142} __packed;
1143
1144struct efi_hii_keyboard_layout {
1145 u16 layout_length;
1146 efi_guid_t guid;
1147 u32 layout_descriptor_string_offset;
1148 u8 descriptor_count;
1149 struct efi_key_descriptor descriptors[];
1150} __packed;
1151
AKASHI Takahiro8d3b77e2019-01-21 12:12:59 +09001152struct efi_hii_keyboard_package {
1153 struct efi_hii_package_header header;
1154 u16 layout_count;
1155 struct efi_hii_keyboard_layout layout[];
1156} __packed;
1157
Leif Lindholmc9bfb222019-01-21 12:12:57 +09001158/*
1159 * HII protocols
1160 */
1161#define EFI_HII_STRING_PROTOCOL_GUID \
1162 EFI_GUID(0x0fd96974, 0x23aa, 0x4cdc, \
1163 0xb9, 0xcb, 0x98, 0xd1, 0x77, 0x50, 0x32, 0x2a)
1164
1165struct efi_font_info {
1166 efi_hii_font_style_t font_style;
1167 u16 font_size;
1168 u16 font_name[1];
1169};
1170
1171struct efi_hii_string_protocol {
1172 efi_status_t(EFIAPI *new_string)(
1173 const struct efi_hii_string_protocol *this,
1174 efi_hii_handle_t package_list,
1175 efi_string_id_t *string_id,
1176 const u8 *language,
1177 const u16 *language_name,
1178 const efi_string_t string,
1179 const struct efi_font_info *string_font_info);
1180 efi_status_t(EFIAPI *get_string)(
1181 const struct efi_hii_string_protocol *this,
1182 const u8 *language,
1183 efi_hii_handle_t package_list,
1184 efi_string_id_t string_id,
1185 efi_string_t string,
1186 efi_uintn_t *string_size,
1187 struct efi_font_info **string_font_info);
1188 efi_status_t(EFIAPI *set_string)(
1189 const struct efi_hii_string_protocol *this,
1190 efi_hii_handle_t package_list,
1191 efi_string_id_t string_id,
1192 const u8 *language,
1193 const efi_string_t string,
1194 const struct efi_font_info *string_font_info);
1195 efi_status_t(EFIAPI *get_languages)(
1196 const struct efi_hii_string_protocol *this,
1197 efi_hii_handle_t package_list,
1198 u8 *languages,
1199 efi_uintn_t *languages_size);
1200 efi_status_t(EFIAPI *get_secondary_languages)(
1201 const struct efi_hii_string_protocol *this,
1202 efi_hii_handle_t package_list,
1203 const u8 *primary_language,
1204 u8 *secondary_languages,
1205 efi_uintn_t *secondary_languages_size);
1206};
1207
1208#define EFI_HII_DATABASE_PROTOCOL_GUID \
1209 EFI_GUID(0xef9fc172, 0xa1b2, 0x4693, \
1210 0xb3, 0x27, 0x6d, 0x32, 0xfc, 0x41, 0x60, 0x42)
1211
1212struct efi_hii_database_protocol {
1213 efi_status_t(EFIAPI *new_package_list)(
1214 const struct efi_hii_database_protocol *this,
1215 const struct efi_hii_package_list_header *package_list,
1216 const efi_handle_t driver_handle,
1217 efi_hii_handle_t *handle);
1218 efi_status_t(EFIAPI *remove_package_list)(
1219 const struct efi_hii_database_protocol *this,
1220 efi_hii_handle_t handle);
1221 efi_status_t(EFIAPI *update_package_list)(
1222 const struct efi_hii_database_protocol *this,
1223 efi_hii_handle_t handle,
1224 const struct efi_hii_package_list_header *package_list);
1225 efi_status_t(EFIAPI *list_package_lists)(
1226 const struct efi_hii_database_protocol *this,
1227 u8 package_type,
1228 const efi_guid_t *package_guid,
1229 efi_uintn_t *handle_buffer_length,
1230 efi_hii_handle_t *handle);
1231 efi_status_t(EFIAPI *export_package_lists)(
1232 const struct efi_hii_database_protocol *this,
1233 efi_hii_handle_t handle,
1234 efi_uintn_t *buffer_size,
1235 struct efi_hii_package_list_header *buffer);
1236 efi_status_t(EFIAPI *register_package_notify)(
1237 const struct efi_hii_database_protocol *this,
1238 u8 package_type,
1239 const efi_guid_t *package_guid,
1240 const void *package_notify_fn,
1241 efi_uintn_t notify_type,
1242 efi_handle_t *notify_handle);
1243 efi_status_t(EFIAPI *unregister_package_notify)(
1244 const struct efi_hii_database_protocol *this,
1245 efi_handle_t notification_handle
1246 );
1247 efi_status_t(EFIAPI *find_keyboard_layouts)(
1248 const struct efi_hii_database_protocol *this,
1249 u16 *key_guid_buffer_length,
1250 efi_guid_t *key_guid_buffer);
1251 efi_status_t(EFIAPI *get_keyboard_layout)(
1252 const struct efi_hii_database_protocol *this,
1253 efi_guid_t *key_guid,
1254 u16 *keyboard_layout_length,
1255 struct efi_hii_keyboard_layout *keyboard_layout);
1256 efi_status_t(EFIAPI *set_keyboard_layout)(
1257 const struct efi_hii_database_protocol *this,
1258 efi_guid_t *key_guid);
1259 efi_status_t(EFIAPI *get_package_list_handle)(
1260 const struct efi_hii_database_protocol *this,
1261 efi_hii_handle_t package_list_handle,
1262 efi_handle_t *driver_handle);
1263};
1264
AKASHI Takahirocb728e52019-01-21 12:13:00 +09001265#define EFI_HII_CONFIG_ROUTING_PROTOCOL_GUID \
1266 EFI_GUID(0x587e72d7, 0xcc50, 0x4f79, \
1267 0x82, 0x09, 0xca, 0x29, 0x1f, 0xc1, 0xa1, 0x0f)
1268
1269struct efi_hii_config_routing_protocol {
1270 efi_status_t(EFIAPI *extract_config)(
1271 const struct efi_hii_config_routing_protocol *this,
1272 const efi_string_t request,
1273 efi_string_t *progress,
1274 efi_string_t *results);
1275 efi_status_t(EFIAPI *export_config)(
1276 const struct efi_hii_config_routing_protocol *this,
1277 efi_string_t *results);
1278 efi_status_t(EFIAPI *route_config)(
1279 const struct efi_hii_config_routing_protocol *this,
1280 const efi_string_t configuration,
1281 efi_string_t *progress);
1282 efi_status_t(EFIAPI *block_to_config)(
1283 const struct efi_hii_config_routing_protocol *this,
1284 const efi_string_t config_request,
1285 const uint8_t *block,
1286 const efi_uintn_t block_size,
1287 efi_string_t *config,
1288 efi_string_t *progress);
1289 efi_status_t(EFIAPI *config_to_block)(
1290 const struct efi_hii_config_routing_protocol *this,
1291 const efi_string_t config_resp,
1292 const uint8_t *block,
1293 const efi_uintn_t *block_size,
1294 efi_string_t *progress);
1295 efi_status_t(EFIAPI *get_alt_config)(
1296 const struct efi_hii_config_routing_protocol *this,
1297 const efi_string_t config_resp,
1298 const efi_guid_t *guid,
1299 const efi_string_t name,
1300 const struct efi_device_path *device_path,
1301 const efi_string_t alt_cfg_id,
1302 efi_string_t *alt_cfg_resp);
1303};
1304
1305#define EFI_HII_CONFIG_ACCESS_PROTOCOL_GUID \
1306 EFI_GUID(0x330d4706, 0xf2a0, 0x4e4f, \
1307 0xa3, 0x69, 0xb6, 0x6f, 0xa8, 0xd5, 0x43, 0x85)
1308
1309struct efi_hii_config_access_protocol {
1310 efi_status_t(EFIAPI *extract_config_access)(
1311 const struct efi_hii_config_access_protocol *this,
1312 const efi_string_t request,
1313 efi_string_t *progress,
1314 efi_string_t *results);
1315 efi_status_t(EFIAPI *route_config_access)(
1316 const struct efi_hii_config_access_protocol *this,
1317 const efi_string_t configuration,
1318 efi_string_t *progress);
1319 efi_status_t(EFIAPI *form_callback)(
1320 const struct efi_hii_config_access_protocol *this,
1321 efi_browser_action_t action,
1322 efi_question_id_t question_id,
1323 u8 type,
1324 union efi_ifr_type_value *value,
1325 efi_browser_action_request_t *action_request);
1326};
1327
Heinrich Schuchardtdec88e42019-04-20 07:39:11 +02001328#define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
Alexander Grafbe8d3242016-03-15 18:38:21 +01001329 EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, \
1330 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
1331
1332#define EFI_GOT_RGBA8 0
1333#define EFI_GOT_BGRA8 1
1334#define EFI_GOT_BITMASK 2
1335
Heinrich Schuchardt2e0d79a2018-09-08 10:50:40 +02001336struct efi_gop_mode_info {
Alexander Grafbe8d3242016-03-15 18:38:21 +01001337 u32 version;
1338 u32 width;
1339 u32 height;
1340 u32 pixel_format;
1341 u32 pixel_bitmask[4];
1342 u32 pixels_per_scanline;
1343};
1344
Heinrich Schuchardt2e0d79a2018-09-08 10:50:40 +02001345struct efi_gop_mode {
Alexander Grafbe8d3242016-03-15 18:38:21 +01001346 u32 max_mode;
1347 u32 mode;
1348 struct efi_gop_mode_info *info;
1349 unsigned long info_size;
1350 efi_physical_addr_t fb_base;
1351 unsigned long fb_size;
1352};
1353
Heinrich Schuchardt0e0a3ce2018-02-07 22:14:22 +01001354struct efi_gop_pixel {
1355 u8 blue;
1356 u8 green;
1357 u8 red;
1358 u8 reserved;
1359};
1360
Alexander Grafbe8d3242016-03-15 18:38:21 +01001361#define EFI_BLT_VIDEO_FILL 0
1362#define EFI_BLT_VIDEO_TO_BLT_BUFFER 1
1363#define EFI_BLT_BUFFER_TO_VIDEO 2
1364#define EFI_BLT_VIDEO_TO_VIDEO 3
1365
Heinrich Schuchardt2e0d79a2018-09-08 10:50:40 +02001366struct efi_gop {
Alexander Grafbe8d3242016-03-15 18:38:21 +01001367 efi_status_t (EFIAPI *query_mode)(struct efi_gop *this, u32 mode_number,
Heinrich Schuchardt1c38a772017-10-26 19:25:51 +02001368 efi_uintn_t *size_of_info,
Alexander Grafbe8d3242016-03-15 18:38:21 +01001369 struct efi_gop_mode_info **info);
1370 efi_status_t (EFIAPI *set_mode)(struct efi_gop *this, u32 mode_number);
Heinrich Schuchardt0e0a3ce2018-02-07 22:14:22 +01001371 efi_status_t (EFIAPI *blt)(struct efi_gop *this,
1372 struct efi_gop_pixel *buffer,
Heinrich Schuchardt1c38a772017-10-26 19:25:51 +02001373 u32 operation, efi_uintn_t sx,
1374 efi_uintn_t sy, efi_uintn_t dx,
1375 efi_uintn_t dy, efi_uintn_t width,
1376 efi_uintn_t height, efi_uintn_t delta);
Alexander Grafbe8d3242016-03-15 18:38:21 +01001377 struct efi_gop_mode *mode;
1378};
1379
Heinrich Schuchardtdec88e42019-04-20 07:39:11 +02001380#define EFI_SIMPLE_NETWORK_PROTOCOL_GUID \
Alexander Graf0efe1bc2016-05-06 21:01:01 +02001381 EFI_GUID(0xa19832b9, 0xac25, 0x11d3, \
1382 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
1383
1384struct efi_mac_address {
1385 char mac_addr[32];
1386};
1387
1388struct efi_ip_address {
1389 u8 ip_addr[16];
Patrick Wildte2742352018-03-27 14:23:20 +02001390} __attribute__((aligned(4)));
Alexander Graf0efe1bc2016-05-06 21:01:01 +02001391
1392enum efi_simple_network_state {
1393 EFI_NETWORK_STOPPED,
1394 EFI_NETWORK_STARTED,
1395 EFI_NETWORK_INITIALIZED,
1396};
1397
1398struct efi_simple_network_mode {
1399 enum efi_simple_network_state state;
1400 u32 hwaddr_size;
1401 u32 media_header_size;
1402 u32 max_packet_size;
1403 u32 nvram_size;
1404 u32 nvram_access_size;
1405 u32 receive_filter_mask;
1406 u32 receive_filter_setting;
1407 u32 max_mcast_filter_count;
1408 u32 mcast_filter_count;
1409 struct efi_mac_address mcast_filter[16];
1410 struct efi_mac_address current_address;
1411 struct efi_mac_address broadcast_address;
1412 struct efi_mac_address permanent_address;
1413 u8 if_type;
1414 u8 mac_changeable;
1415 u8 multitx_supported;
1416 u8 media_present_supported;
1417 u8 media_present;
1418};
1419
Heinrich Schuchardt2e0864a2017-10-05 16:35:56 +02001420/* receive_filters bit mask */
1421#define EFI_SIMPLE_NETWORK_RECEIVE_UNICAST 0x01
1422#define EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST 0x02
1423#define EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST 0x04
1424#define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS 0x08
1425#define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST 0x10
Alexander Graf0efe1bc2016-05-06 21:01:01 +02001426
Heinrich Schuchardt891b3d92017-10-05 16:36:02 +02001427/* interrupt status bit mask */
1428#define EFI_SIMPLE_NETWORK_RECEIVE_INTERRUPT 0x01
1429#define EFI_SIMPLE_NETWORK_TRANSMIT_INTERRUPT 0x02
1430#define EFI_SIMPLE_NETWORK_COMMAND_INTERRUPT 0x04
1431#define EFI_SIMPLE_NETWORK_SOFTWARE_INTERRUPT 0x08
1432
Heinrich Schuchardtbdecf972017-10-05 16:35:57 +02001433/* revision of the simple network protocol */
1434#define EFI_SIMPLE_NETWORK_PROTOCOL_REVISION 0x00010000
1435
Heinrich Schuchardt2e0d79a2018-09-08 10:50:40 +02001436struct efi_simple_network {
Alexander Graf0efe1bc2016-05-06 21:01:01 +02001437 u64 revision;
1438 efi_status_t (EFIAPI *start)(struct efi_simple_network *this);
1439 efi_status_t (EFIAPI *stop)(struct efi_simple_network *this);
1440 efi_status_t (EFIAPI *initialize)(struct efi_simple_network *this,
1441 ulong extra_rx, ulong extra_tx);
1442 efi_status_t (EFIAPI *reset)(struct efi_simple_network *this,
1443 int extended_verification);
1444 efi_status_t (EFIAPI *shutdown)(struct efi_simple_network *this);
1445 efi_status_t (EFIAPI *receive_filters)(struct efi_simple_network *this,
1446 u32 enable, u32 disable, int reset_mcast_filter,
1447 ulong mcast_filter_count,
1448 struct efi_mac_address *mcast_filter);
1449 efi_status_t (EFIAPI *station_address)(struct efi_simple_network *this,
1450 int reset, struct efi_mac_address *new_mac);
1451 efi_status_t (EFIAPI *statistics)(struct efi_simple_network *this,
1452 int reset, ulong *stat_size, void *stat_table);
1453 efi_status_t (EFIAPI *mcastiptomac)(struct efi_simple_network *this,
1454 int ipv6, struct efi_ip_address *ip,
1455 struct efi_mac_address *mac);
1456 efi_status_t (EFIAPI *nvdata)(struct efi_simple_network *this,
1457 int read_write, ulong offset, ulong buffer_size,
1458 char *buffer);
1459 efi_status_t (EFIAPI *get_status)(struct efi_simple_network *this,
1460 u32 *int_status, void **txbuf);
1461 efi_status_t (EFIAPI *transmit)(struct efi_simple_network *this,
Heinrich Schuchardt8db174d2017-10-05 16:36:03 +02001462 size_t header_size, size_t buffer_size, void *buffer,
Alexander Graf0efe1bc2016-05-06 21:01:01 +02001463 struct efi_mac_address *src_addr,
1464 struct efi_mac_address *dest_addr, u16 *protocol);
1465 efi_status_t (EFIAPI *receive)(struct efi_simple_network *this,
Heinrich Schuchardt8db174d2017-10-05 16:36:03 +02001466 size_t *header_size, size_t *buffer_size, void *buffer,
Alexander Graf0efe1bc2016-05-06 21:01:01 +02001467 struct efi_mac_address *src_addr,
1468 struct efi_mac_address *dest_addr, u16 *protocol);
Heinrich Schuchardt84a12ce2017-10-05 16:35:55 +02001469 struct efi_event *wait_for_packet;
Alexander Graf0efe1bc2016-05-06 21:01:01 +02001470 struct efi_simple_network_mode *mode;
Heinrich Schuchardt7f6d8742019-08-31 09:56:30 +02001471 /* private fields */
1472 u32 int_status;
Alexander Graf0efe1bc2016-05-06 21:01:01 +02001473};
1474
Heinrich Schuchardtdec88e42019-04-20 07:39:11 +02001475#define EFI_PXE_BASE_CODE_PROTOCOL_GUID \
Alexander Graf0efe1bc2016-05-06 21:01:01 +02001476 EFI_GUID(0x03c4e603, 0xac28, 0x11d3, \
1477 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
1478
Heinrich Schuchardta6d37092019-08-06 08:13:33 +02001479#define EFI_PXE_BASE_CODE_PROTOCOL_REVISION 0x00010000
1480#define EFI_PXE_BASE_CODE_MAX_IPCNT 8
1481
Alexander Graf0efe1bc2016-05-06 21:01:01 +02001482struct efi_pxe_packet {
1483 u8 packet[1472];
1484};
1485
Heinrich Schuchardt2e0d79a2018-09-08 10:50:40 +02001486struct efi_pxe_mode {
Patrick Wildte2742352018-03-27 14:23:20 +02001487 u8 started;
1488 u8 ipv6_available;
1489 u8 ipv6_supported;
1490 u8 using_ipv6;
1491 u8 bis_supported;
1492 u8 bis_detected;
1493 u8 auto_arp;
1494 u8 send_guid;
1495 u8 dhcp_discover_valid;
1496 u8 dhcp_ack_received;
1497 u8 proxy_offer_received;
1498 u8 pxe_discover_valid;
1499 u8 pxe_reply_received;
1500 u8 pxe_bis_reply_received;
1501 u8 icmp_error_received;
1502 u8 tftp_error_received;
1503 u8 make_callbacks;
1504 u8 ttl;
1505 u8 tos;
1506 u8 pad;
1507 struct efi_ip_address station_ip;
1508 struct efi_ip_address subnet_mask;
Alexander Graf0efe1bc2016-05-06 21:01:01 +02001509 struct efi_pxe_packet dhcp_discover;
1510 struct efi_pxe_packet dhcp_ack;
1511 struct efi_pxe_packet proxy_offer;
1512 struct efi_pxe_packet pxe_discover;
1513 struct efi_pxe_packet pxe_reply;
1514};
1515
Heinrich Schuchardta6d37092019-08-06 08:13:33 +02001516struct efi_pxe_base_code_srvlist {
1517 u16 type;
1518 u8 accept_any_response;
1519 u8 reserved;
1520 struct efi_ip_address ip_addr;
1521};
1522
1523struct efi_pxe_base_code_discover_info {
1524 u8 use_m_cast;
1525 u8 use_b_cast;
1526 u8 use_u_cast;
1527 u8 must_use_list;
1528 struct efi_ip_address server_m_cast_ip;
1529 u16 ip_cnt;
1530 struct efi_pxe_base_code_srvlist srv_list[];
1531};
1532
1533struct efi_pxe_base_code_mtftp_info {
1534 struct efi_ip_address m_cast_ip;
1535 u16 cport;
1536 u16 sport;
1537 u16 listen_timeout;
1538 u16 transit_timeout;
1539};
1540
1541struct efi_pxe_base_code_filter {
1542 u8 filters;
1543 u8 ip_cnt;
1544 u16 reserved;
1545 struct efi_ip_address ip_list[EFI_PXE_BASE_CODE_MAX_IPCNT];
1546};
1547
1548struct efi_pxe_base_code_dhcpv4_packet {
1549 u8 bootp_op_code;
1550 u8 bootp_hw_type;
1551 u8 bootp_addr_len;
1552 u8 bootp_gate_hops;
1553 u32 bootp_ident;
1554 u16 bootp_seconds;
1555 u16 bootp_flags;
1556 u8 bootp_ci_addr[4];
1557 u8 bootp_yi_addr[4];
1558 u8 bootp_si_addr[4];
1559 u8 bootp_gi_addr[4];
1560 u8 bootp_hw_addr[16];
1561 u8 bootp_srv_name[64];
1562 u8 bootp_boot_file[128];
1563 u32 dhcp_magick;
1564 u8 dhcp_options[56];
1565};
1566
1567struct efi_pxe_base_code_dhcpv6_packet {
1568 u8 message_type;
1569 u8 transaction_id[3];
1570 u8 dhcp_options[1024];
1571};
1572
1573typedef union {
1574 u8 raw[1472];
1575 struct efi_pxe_base_code_dhcpv4_packet dhcpv4;
1576 struct efi_pxe_base_code_dhcpv6_packet dhcpv6;
1577} EFI_PXE_BASE_CODE_PACKET;
1578
1579struct efi_pxe_base_code_protocol {
1580 u64 revision;
1581 efi_status_t (EFIAPI *start)(struct efi_pxe_base_code_protocol *this,
1582 u8 use_ipv6);
1583 efi_status_t (EFIAPI *stop)(struct efi_pxe_base_code_protocol *this);
1584 efi_status_t (EFIAPI *dhcp)(struct efi_pxe_base_code_protocol *this,
1585 u8 sort_offers);
1586 efi_status_t (EFIAPI *discover)(
1587 struct efi_pxe_base_code_protocol *this,
1588 u16 type, u16 *layer, u8 bis,
1589 struct efi_pxe_base_code_discover_info *info);
1590 efi_status_t (EFIAPI *mtftp)(
1591 struct efi_pxe_base_code_protocol *this,
1592 u32 operation, void *buffer_ptr,
1593 u8 overwrite, efi_uintn_t *buffer_size,
1594 struct efi_ip_address server_ip, char *filename,
1595 struct efi_pxe_base_code_mtftp_info *info,
1596 u8 dont_use_buffer);
1597 efi_status_t (EFIAPI *udp_write)(
1598 struct efi_pxe_base_code_protocol *this,
1599 u16 op_flags, struct efi_ip_address *dest_ip,
1600 u16 *dest_port,
1601 struct efi_ip_address *gateway_ip,
1602 struct efi_ip_address *src_ip, u16 *src_port,
1603 efi_uintn_t *header_size, void *header_ptr,
1604 efi_uintn_t *buffer_size, void *buffer_ptr);
1605 efi_status_t (EFIAPI *udp_read)(
1606 struct efi_pxe_base_code_protocol *this,
1607 u16 op_flags, struct efi_ip_address *dest_ip,
1608 u16 *dest_port, struct efi_ip_address *src_ip,
1609 u16 *src_port, efi_uintn_t *header_size,
1610 void *header_ptr, efi_uintn_t *buffer_size,
1611 void *buffer_ptr);
1612 efi_status_t (EFIAPI *set_ip_filter)(
1613 struct efi_pxe_base_code_protocol *this,
1614 struct efi_pxe_base_code_filter *new_filter);
1615 efi_status_t (EFIAPI *arp)(struct efi_pxe_base_code_protocol *this,
1616 struct efi_ip_address *ip_addr,
1617 struct efi_mac_address *mac_addr);
1618 efi_status_t (EFIAPI *set_parameters)(
1619 struct efi_pxe_base_code_protocol *this,
1620 u8 *new_auto_arp, u8 *new_send_guid,
1621 u8 *new_ttl, u8 *new_tos,
1622 u8 *new_make_callback);
1623 efi_status_t (EFIAPI *set_station_ip)(
1624 struct efi_pxe_base_code_protocol *this,
1625 struct efi_ip_address *new_station_ip,
1626 struct efi_ip_address *new_subnet_mask);
1627 efi_status_t (EFIAPI *set_packets)(
1628 struct efi_pxe_base_code_protocol *this,
1629 u8 *new_dhcp_discover_valid,
1630 u8 *new_dhcp_ack_received,
1631 u8 *new_proxy_offer_received,
1632 u8 *new_pxe_discover_valid,
1633 u8 *new_pxe_reply_received,
1634 u8 *new_pxe_bis_reply_received,
1635 EFI_PXE_BASE_CODE_PACKET *new_dchp_discover,
1636 EFI_PXE_BASE_CODE_PACKET *new_dhcp_acc,
1637 EFI_PXE_BASE_CODE_PACKET *new_proxy_offer,
1638 EFI_PXE_BASE_CODE_PACKET *new_pxe_discover,
1639 EFI_PXE_BASE_CODE_PACKET *new_pxe_reply,
1640 EFI_PXE_BASE_CODE_PACKET *new_pxe_bis_reply);
Alexander Graf0efe1bc2016-05-06 21:01:01 +02001641 struct efi_pxe_mode *mode;
1642};
1643
Rob Clark2a920802017-09-13 18:05:34 -04001644#define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID \
1645 EFI_GUID(0x964e5b22, 0x6459, 0x11d2, \
1646 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
Heinrich Schuchardt17394f92019-03-27 21:41:04 +01001647#define EFI_FILE_PROTOCOL_REVISION 0x00010000
1648#define EFI_FILE_PROTOCOL_REVISION2 0x00020000
1649#define EFI_FILE_PROTOCOL_LATEST_REVISION EFI_FILE_PROTOCOL_REVISION2
Rob Clark2a920802017-09-13 18:05:34 -04001650
Heinrich Schuchardte692ed12019-09-08 09:35:32 +02001651struct efi_file_io_token {
1652 struct efi_event *event;
1653 efi_status_t status;
1654 efi_uintn_t buffer_size;
1655 void *buffer;};
1656
Rob Clark2a920802017-09-13 18:05:34 -04001657struct efi_file_handle {
1658 u64 rev;
Heinrich Schuchardtdb12f512021-01-01 08:39:43 +01001659 efi_status_t (EFIAPI *open)(struct efi_file_handle *this,
Rob Clark2a920802017-09-13 18:05:34 -04001660 struct efi_file_handle **new_handle,
Heinrich Schuchardtc82f8f62019-01-12 12:02:33 +01001661 u16 *file_name, u64 open_mode, u64 attributes);
Heinrich Schuchardtdb12f512021-01-01 08:39:43 +01001662 efi_status_t (EFIAPI *close)(struct efi_file_handle *this);
1663 efi_status_t (EFIAPI *delete)(struct efi_file_handle *this);
1664 efi_status_t (EFIAPI *read)(struct efi_file_handle *this,
Heinrich Schuchardtb6dd5772018-04-03 22:37:11 +02001665 efi_uintn_t *buffer_size, void *buffer);
Heinrich Schuchardtdb12f512021-01-01 08:39:43 +01001666 efi_status_t (EFIAPI *write)(struct efi_file_handle *this,
Heinrich Schuchardtb6dd5772018-04-03 22:37:11 +02001667 efi_uintn_t *buffer_size, void *buffer);
Heinrich Schuchardtdb12f512021-01-01 08:39:43 +01001668 efi_status_t (EFIAPI *getpos)(struct efi_file_handle *this,
Heinrich Schuchardt0801d4d2018-10-07 05:26:26 +02001669 u64 *pos);
Heinrich Schuchardtdb12f512021-01-01 08:39:43 +01001670 efi_status_t (EFIAPI *setpos)(struct efi_file_handle *this,
Heinrich Schuchardt0801d4d2018-10-07 05:26:26 +02001671 u64 pos);
Heinrich Schuchardtdb12f512021-01-01 08:39:43 +01001672 efi_status_t (EFIAPI *getinfo)(struct efi_file_handle *this,
Heinrich Schuchardt9c9021e2018-04-04 15:42:09 +02001673 const efi_guid_t *info_type, efi_uintn_t *buffer_size,
Heinrich Schuchardtb6dd5772018-04-03 22:37:11 +02001674 void *buffer);
Heinrich Schuchardtdb12f512021-01-01 08:39:43 +01001675 efi_status_t (EFIAPI *setinfo)(struct efi_file_handle *this,
Heinrich Schuchardt9c9021e2018-04-04 15:42:09 +02001676 const efi_guid_t *info_type, efi_uintn_t buffer_size,
Heinrich Schuchardtb6dd5772018-04-03 22:37:11 +02001677 void *buffer);
Heinrich Schuchardtdb12f512021-01-01 08:39:43 +01001678 efi_status_t (EFIAPI *flush)(struct efi_file_handle *this);
1679 efi_status_t (EFIAPI *open_ex)(struct efi_file_handle *this,
Heinrich Schuchardte692ed12019-09-08 09:35:32 +02001680 struct efi_file_handle **new_handle,
1681 u16 *file_name, u64 open_mode, u64 attributes,
1682 struct efi_file_io_token *token);
Heinrich Schuchardtdb12f512021-01-01 08:39:43 +01001683 efi_status_t (EFIAPI *read_ex)(struct efi_file_handle *this,
Heinrich Schuchardte692ed12019-09-08 09:35:32 +02001684 struct efi_file_io_token *token);
Heinrich Schuchardtdb12f512021-01-01 08:39:43 +01001685 efi_status_t (EFIAPI *write_ex)(struct efi_file_handle *this,
Heinrich Schuchardte692ed12019-09-08 09:35:32 +02001686 struct efi_file_io_token *token);
Heinrich Schuchardtdb12f512021-01-01 08:39:43 +01001687 efi_status_t (EFIAPI *flush_ex)(struct efi_file_handle *this,
Heinrich Schuchardte692ed12019-09-08 09:35:32 +02001688 struct efi_file_io_token *token);
Rob Clark2a920802017-09-13 18:05:34 -04001689};
1690
Rob Clark2a920802017-09-13 18:05:34 -04001691#define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION 0x00010000
1692
1693struct efi_simple_file_system_protocol {
1694 u64 rev;
1695 efi_status_t (EFIAPI *open_volume)(struct efi_simple_file_system_protocol *this,
1696 struct efi_file_handle **root);
1697};
1698
1699#define EFI_FILE_INFO_GUID \
1700 EFI_GUID(0x9576e92, 0x6d3f, 0x11d2, \
1701 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
1702
Heinrich Schuchardt9e6835e2018-04-04 15:42:11 +02001703#define EFI_FILE_SYSTEM_INFO_GUID \
1704 EFI_GUID(0x09576e93, 0x6d3f, 0x11d2, \
1705 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
1706
Heinrich Schuchardt632834c2019-09-08 10:32:54 +02001707#define EFI_FILE_SYSTEM_VOLUME_LABEL_ID \
1708 EFI_GUID(0xdb47d7d3, 0xfe81, 0x11d3, \
1709 0x9a, 0x35, 0x00, 0x90, 0x27, 0x3f, 0xC1, 0x4d)
1710
Rob Clark2a920802017-09-13 18:05:34 -04001711#define EFI_FILE_MODE_READ 0x0000000000000001
1712#define EFI_FILE_MODE_WRITE 0x0000000000000002
1713#define EFI_FILE_MODE_CREATE 0x8000000000000000
1714
1715#define EFI_FILE_READ_ONLY 0x0000000000000001
1716#define EFI_FILE_HIDDEN 0x0000000000000002
1717#define EFI_FILE_SYSTEM 0x0000000000000004
1718#define EFI_FILE_RESERVED 0x0000000000000008
1719#define EFI_FILE_DIRECTORY 0x0000000000000010
1720#define EFI_FILE_ARCHIVE 0x0000000000000020
1721#define EFI_FILE_VALID_ATTR 0x0000000000000037
1722
1723struct efi_file_info {
1724 u64 size;
1725 u64 file_size;
1726 u64 physical_size;
1727 struct efi_time create_time;
1728 struct efi_time last_access_time;
1729 struct efi_time modification_time;
1730 u64 attribute;
Heinrich Schuchardt02c2f022018-11-05 20:22:12 +01001731 u16 file_name[0];
Rob Clark2a920802017-09-13 18:05:34 -04001732};
1733
Heinrich Schuchardt9e6835e2018-04-04 15:42:11 +02001734struct efi_file_system_info {
1735 u64 size;
1736 u8 read_only;
1737 u64 volume_size;
1738 u64 free_space;
1739 u32 block_size;
1740 u16 volume_label[0];
1741};
1742
Heinrich Schuchardtf0959db2018-01-11 08:16:02 +01001743#define EFI_DRIVER_BINDING_PROTOCOL_GUID \
1744 EFI_GUID(0x18a031ab, 0xb443, 0x4d1a,\
1745 0xa5, 0xc0, 0x0c, 0x09, 0x26, 0x1e, 0x9f, 0x71)
1746struct efi_driver_binding_protocol {
1747 efi_status_t (EFIAPI * supported)(
1748 struct efi_driver_binding_protocol *this,
1749 efi_handle_t controller_handle,
1750 struct efi_device_path *remaining_device_path);
1751 efi_status_t (EFIAPI * start)(
1752 struct efi_driver_binding_protocol *this,
1753 efi_handle_t controller_handle,
1754 struct efi_device_path *remaining_device_path);
1755 efi_status_t (EFIAPI * stop)(
1756 struct efi_driver_binding_protocol *this,
1757 efi_handle_t controller_handle,
1758 efi_uintn_t number_of_children,
1759 efi_handle_t *child_handle_buffer);
1760 u32 version;
1761 efi_handle_t image_handle;
1762 efi_handle_t driver_binding_handle;
1763};
1764
Heinrich Schuchardtb1b782d2019-05-16 18:19:00 +02001765/* Current version of the Unicode collation protocol */
Heinrich Schuchardt0bc4b0d2018-09-04 19:34:58 +02001766#define EFI_UNICODE_COLLATION_PROTOCOL2_GUID \
1767 EFI_GUID(0xa4c751fc, 0x23ae, 0x4c3e, \
1768 0x92, 0xe9, 0x49, 0x64, 0xcf, 0x63, 0xf3, 0x49)
1769struct efi_unicode_collation_protocol {
1770 efi_intn_t (EFIAPI *stri_coll)(
1771 struct efi_unicode_collation_protocol *this, u16 *s1, u16 *s2);
1772 bool (EFIAPI *metai_match)(struct efi_unicode_collation_protocol *this,
1773 const u16 *string, const u16 *patter);
1774 void (EFIAPI *str_lwr)(struct efi_unicode_collation_protocol
1775 *this, u16 *string);
1776 void (EFIAPI *str_upr)(struct efi_unicode_collation_protocol *this,
1777 u16 *string);
1778 void (EFIAPI *fat_to_str)(struct efi_unicode_collation_protocol *this,
1779 efi_uintn_t fat_size, char *fat, u16 *string);
1780 bool (EFIAPI *str_to_fat)(struct efi_unicode_collation_protocol *this,
1781 const u16 *string, efi_uintn_t fat_size,
1782 char *fat);
1783 char *supported_languages;
1784};
1785
Ilias Apalodimasec80b472020-02-21 09:55:45 +02001786struct efi_load_file_protocol {
1787 efi_status_t (EFIAPI *load_file)(struct efi_load_file_protocol *this,
1788 struct efi_device_path *file_path,
1789 bool boot_policy,
1790 efi_uintn_t *buffer_size,
1791 void *buffer);
1792};
1793
Jose Marinho64a8aae2021-03-02 17:26:38 +00001794struct efi_system_resource_entry {
1795 efi_guid_t fw_class;
1796 u32 fw_type;
1797 u32 fw_version;
1798 u32 lowest_supported_fw_version;
1799 u32 capsule_flags;
1800 u32 last_attempt_version;
1801 u32 last_attempt_status;
1802} __packed;
1803
1804struct efi_system_resource_table {
1805 u32 fw_resource_count;
1806 u32 fw_resource_count_max;
1807 u64 fw_resource_version;
1808 struct efi_system_resource_entry entries[];
1809} __packed;
1810
AKASHI Takahiro454568b2019-02-25 15:54:37 +09001811/* Boot manager load options */
1812#define LOAD_OPTION_ACTIVE 0x00000001
1813#define LOAD_OPTION_FORCE_RECONNECT 0x00000002
1814#define LOAD_OPTION_HIDDEN 0x00000008
1815/* All values 0x00000200-0x00001F00 are reserved */
1816#define LOAD_OPTION_CATEGORY 0x00001F00
1817#define LOAD_OPTION_CATEGORY_BOOT 0x00000000
1818#define LOAD_OPTION_CATEGORY_APP 0x00000100
1819
AKASHI Takahirob74d5682020-03-17 11:12:35 +09001820/*
1821 * System Resource Table
1822 */
1823/* Firmware Type Definitions */
1824#define ESRT_FW_TYPE_UNKNOWN 0x00000000
1825#define ESRT_FW_TYPE_SYSTEMFIRMWARE 0x00000001
1826#define ESRT_FW_TYPE_DEVICEFIRMWARE 0x00000002
1827#define ESRT_FW_TYPE_UEFIDRIVER 0x00000003
1828
Jose Marinho64a8aae2021-03-02 17:26:38 +00001829#define EFI_SYSTEM_RESOURCE_TABLE_GUID\
1830 EFI_GUID(0xb122a263, 0x3661, 0x4f68,\
1831 0x99, 0x29, 0x78, 0xf8, 0xb0, 0xd6, 0x21, 0x80)
1832
AKASHI Takahirob74d5682020-03-17 11:12:35 +09001833/* Last Attempt Status Values */
1834#define LAST_ATTEMPT_STATUS_SUCCESS 0x00000000
1835#define LAST_ATTEMPT_STATUS_ERROR_UNSUCCESSFUL 0x00000001
1836#define LAST_ATTEMPT_STATUS_ERROR_INSUFFICIENT_RESOURCES 0x00000002
1837#define LAST_ATTEMPT_STATUS_ERROR_INCORRECT_VERSION 0x00000003
1838#define LAST_ATTEMPT_STATUS_ERROR_INVALID_FORMAT 0x00000004
1839#define LAST_ATTEMPT_STATUS_ERROR_AUTH_ERROR 0x00000005
1840#define LAST_ATTEMPT_STATUS_ERROR_PWR_EVT_AC 0x00000006
1841#define LAST_ATTEMPT_STATUS_ERROR_PWR_EVT_BATT 0x00000007
1842#define LAST_ATTEMPT_STATUS_ERROR_UNSATISFIED_DEPENDENCIES 0x00000008
1843
1844/*
1845 * The LastAttemptStatus values of 0x1000 - 0x4000 are reserved for vendor
1846 * usage.
1847 */
1848#define LAST_ATTEMPT_STATUS_ERROR_UNSUCCESSFUL_VENDOR_RANGE_MIN 0x00001000
1849#define LAST_ATTEMPT_STATUS_ERROR_UNSUCCESSFUL_VENDOR_RANGE_MAX 0x00004000
1850
AKASHI Takahiro593e17d2020-04-14 11:51:39 +09001851/* Certificate types in signature database */
Ilias Apalodimas4b634312022-01-29 00:20:31 +02001852#define EFI_CERT_SHA1_GUID \
1853 EFI_GUID(0x826ca512, 0xcf10, 0x4ac9, 0xb1, 0x87, \
1854 0xbe, 0x01, 0x49, 0x66, 0x31, 0xbd)
1855#define EFI_CERT_SHA224_GUID \
1856 EFI_GUID(0xb6e5233, 0xa65c, 0x44c9, 0x94, 0x07, \
1857 0xd9, 0xab, 0x83, 0xbf, 0xc8, 0xbd)
AKASHI Takahiro593e17d2020-04-14 11:51:39 +09001858#define EFI_CERT_SHA256_GUID \
1859 EFI_GUID(0xc1c41626, 0x504c, 0x4092, 0xac, 0xa9, \
1860 0x41, 0xf9, 0x36, 0x93, 0x43, 0x28)
Ilias Apalodimas4b634312022-01-29 00:20:31 +02001861#define EFI_CERT_SHA384_GUID \
1862 EFI_GUID(0xff3e5307, 0x9fd0, 0x48c9, 0x85, 0xf1, \
1863 0x8a, 0xd5, 0x6c, 0x70, 0x1e, 0x01)
1864#define EFI_CERT_SHA512_GUID \
1865 EFI_GUID(0x93e0fae, 0xa6c4, 0x4f50, 0x9f, 0x1b, \
1866 0xd4, 0x1e, 0x2b, 0x89, 0xc1, 0x9a)
AKASHI Takahiro593e17d2020-04-14 11:51:39 +09001867#define EFI_CERT_RSA2048_GUID \
1868 EFI_GUID(0x3c5766e8, 0x269c, 0x4e34, 0xaa, 0x14, \
1869 0xed, 0x77, 0x6e, 0x85, 0xb3, 0xb6)
1870#define EFI_CERT_X509_GUID \
1871 EFI_GUID(0xa5c059a1, 0x94e4, 0x4aa7, 0x87, 0xb5, \
1872 0xab, 0x15, 0x5c, 0x2b, 0xf0, 0x72)
1873#define EFI_CERT_X509_SHA256_GUID \
1874 EFI_GUID(0x3bd2a492, 0x96c0, 0x4079, 0xb4, 0x20, \
1875 0xfc, 0xf9, 0x8e, 0xf1, 0x03, 0xed)
1876#define EFI_CERT_TYPE_PKCS7_GUID \
1877 EFI_GUID(0x4aafd29d, 0x68df, 0x49ee, 0x8a, 0xa9, \
1878 0x34, 0x7d, 0x37, 0x56, 0x65, 0xa7)
1879
1880/**
Heinrich Schuchardte032cb22021-11-20 09:28:54 +01001881 * struct win_certificate_uefi_guid - A certificate that encapsulates
AKASHI Takahiro593e17d2020-04-14 11:51:39 +09001882 * a GUID-specific signature
1883 *
1884 * @hdr: Windows certificate header
1885 * @cert_type: Certificate type
1886 * @cert_data: Certificate data
1887 */
1888struct win_certificate_uefi_guid {
1889 WIN_CERTIFICATE hdr;
1890 efi_guid_t cert_type;
1891 u8 cert_data[];
1892} __attribute__((__packed__));
1893
1894/**
Heinrich Schuchardte032cb22021-11-20 09:28:54 +01001895 * struct efi_variable_authentication_2 - A time-based authentication method
AKASHI Takahiro593e17d2020-04-14 11:51:39 +09001896 * descriptor
1897 *
1898 * This structure describes an authentication information for
1899 * a variable with EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
1900 * and should be included as part of a variable's value.
1901 * Only EFI_CERT_TYPE_PKCS7_GUID is accepted.
1902 *
1903 * @time_stamp: Descriptor's time stamp
1904 * @auth_info: Authentication info
1905 */
1906struct efi_variable_authentication_2 {
1907 struct efi_time time_stamp;
1908 struct win_certificate_uefi_guid auth_info;
1909} __attribute__((__packed__));
1910
1911/**
Heinrich Schuchardte032cb22021-11-20 09:28:54 +01001912 * struct efi_firmware_image_authentication - Capsule authentication method
Sughosh Ganu04be98b2020-12-30 19:27:09 +05301913 * descriptor
1914 *
1915 * This structure describes an authentication information for
1916 * a capsule with IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED set
1917 * and should be included as part of the capsule.
1918 * Only EFI_CERT_TYPE_PKCS7_GUID is accepted.
1919 *
1920 * @monotonic_count: Count to prevent replay
1921 * @auth_info: Authentication info
1922 */
1923struct efi_firmware_image_authentication {
1924 uint64_t monotonic_count;
1925 struct win_certificate_uefi_guid auth_info;
1926} __attribute__((__packed__));
1927
1928
1929/**
Heinrich Schuchardte032cb22021-11-20 09:28:54 +01001930 * struct efi_signature_data - A format of signature
AKASHI Takahiro593e17d2020-04-14 11:51:39 +09001931 *
1932 * This structure describes a single signature in signature database.
1933 *
1934 * @signature_owner: Signature owner
1935 * @signature_data: Signature data
1936 */
1937struct efi_signature_data {
1938 efi_guid_t signature_owner;
1939 u8 signature_data[];
1940} __attribute__((__packed__));
1941
1942/**
Heinrich Schuchardte032cb22021-11-20 09:28:54 +01001943 * struct efi_signature_list - A format of signature database
AKASHI Takahiro593e17d2020-04-14 11:51:39 +09001944 *
1945 * This structure describes a list of signatures with the same type.
1946 * An authenticated variable's value is a concatenation of one or more
1947 * efi_signature_list's.
1948 *
1949 * @signature_type: Signature type
1950 * @signature_list_size: Size of signature list
1951 * @signature_header_size: Size of signature header
1952 * @signature_size: Size of signature
1953 */
1954struct efi_signature_list {
1955 efi_guid_t signature_type;
1956 u32 signature_list_size;
1957 u32 signature_header_size;
1958 u32 signature_size;
1959/* u8 signature_header[signature_header_size]; */
1960/* struct efi_signature_data signatures[...][signature_size]; */
1961} __attribute__((__packed__));
1962
AKASHI Takahiro8d990262020-11-30 18:12:11 +09001963/*
1964 * Firmware management protocol
1965 */
1966#define EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GUID \
1967 EFI_GUID(0x86c77a67, 0x0b97, 0x4633, 0xa1, 0x87, \
1968 0x49, 0x10, 0x4d, 0x06, 0x85, 0xc7)
1969
AKASHI Takahirof27c2012020-11-30 18:12:12 +09001970#define EFI_FIRMWARE_IMAGE_TYPE_UBOOT_FIT_GUID \
1971 EFI_GUID(0xae13ff2d, 0x9ad4, 0x4e25, 0x9a, 0xc8, \
1972 0x6d, 0x80, 0xb3, 0xb2, 0x21, 0x47)
1973
AKASHI Takahirobb7e71d2020-11-17 09:28:00 +09001974#define EFI_FIRMWARE_IMAGE_TYPE_UBOOT_RAW_GUID \
1975 EFI_GUID(0xe2bb9c06, 0x70e9, 0x4b14, 0x97, 0xa3, \
1976 0x5a, 0x79, 0x13, 0x17, 0x6e, 0x3f)
1977
AKASHI Takahiro8d990262020-11-30 18:12:11 +09001978#define IMAGE_ATTRIBUTE_IMAGE_UPDATABLE 0x0000000000000001
1979#define IMAGE_ATTRIBUTE_RESET_REQUIRED 0x0000000000000002
1980#define IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED 0x0000000000000004
1981#define IMAGE_ATTRIBUTE_IN_USE 0x0000000000000008
1982#define IMAGE_ATTRIBUTE_UEFI_IMAGE 0x0000000000000010
1983#define IMAGE_ATTRIBUTE_DEPENDENCY 0x0000000000000020
1984
1985#define IMAGE_COMPATIBILITY_CHECK_SUPPORTED 0x0000000000000001
1986
1987#define IMAGE_UPDATABLE_VALID 0x0000000000000001
1988#define IMAGE_UPDATABLE_INVALID 0x0000000000000002
1989#define IMAGE_UPDATABLE_INVALID_TYPE 0x0000000000000004
1990#define IMAGE_UPDATABLE_INVALID_OLLD 0x0000000000000008
1991#define IMAGE_UPDATABLE_VALID_WITH_VENDOR_CODE 0x0000000000000010
1992
1993#define PACKAGE_ATTRIBUTE_VERSION_UPDATABLE 0x0000000000000001
1994#define PACKAGE_ATTRIBUTE_RESET_REQUIRED 0x0000000000000002
1995#define PACKAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED 0x0000000000000004
1996
1997#define EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION 4
1998
1999typedef struct efi_firmware_image_dependencies {
2000 u8 dependencies[0];
2001} efi_firmware_image_dep_t;
2002
2003struct efi_firmware_image_descriptor {
2004 u8 image_index;
2005 efi_guid_t image_type_id;
2006 u64 image_id;
2007 u16 *image_id_name;
2008 u32 version;
2009 u16 *version_name;
2010 efi_uintn_t size;
2011 u64 attributes_supported;
2012 u64 attributes_setting;
2013 u64 compatibilities;
2014 u32 lowest_supported_image_version;
2015 u32 last_attempt_version;
2016 u32 last_attempt_status;
2017 u64 hardware_instance;
2018 efi_firmware_image_dep_t *dependencies;
2019};
2020
2021struct efi_firmware_management_protocol {
2022 efi_status_t (EFIAPI *get_image_info)(
2023 struct efi_firmware_management_protocol *this,
2024 efi_uintn_t *image_info_size,
2025 struct efi_firmware_image_descriptor *image_info,
2026 u32 *descriptor_version,
2027 u8 *descriptor_count,
2028 efi_uintn_t *descriptor_size,
2029 u32 *package_version,
2030 u16 **package_version_name);
2031 efi_status_t (EFIAPI *get_image)(
2032 struct efi_firmware_management_protocol *this,
2033 u8 image_index,
2034 void *image,
2035 efi_uintn_t *image_size);
2036 efi_status_t (EFIAPI *set_image)(
2037 struct efi_firmware_management_protocol *this,
2038 u8 image_index,
2039 const void *image,
2040 efi_uintn_t image_size,
2041 const void *vendor_code,
2042 efi_status_t (*progress)(efi_uintn_t completion),
2043 u16 **abort_reason);
2044 efi_status_t (EFIAPI *check_image)(
2045 struct efi_firmware_management_protocol *this,
2046 u8 image_index,
2047 const void *image,
2048 efi_uintn_t *image_size,
2049 u32 *image_updatable);
2050 efi_status_t (EFIAPI *get_package_info)(
2051 struct efi_firmware_management_protocol *this,
2052 u32 *package_version,
2053 u16 **package_version_name,
2054 u32 *package_version_name_maxlen,
2055 u64 *attributes_supported,
2056 u64 *attributes_setting);
2057 efi_status_t (EFIAPI *set_package_info)(
2058 struct efi_firmware_management_protocol *this,
2059 const void *image,
2060 efi_uintn_t *image_size,
2061 const void *vendor_code,
2062 u32 package_version,
2063 const u16 *package_version_name);
2064};
2065
Simon Glass613cd0c2021-12-29 11:57:36 -07002066#define EFI_DISK_IO_PROTOCOL_GUID \
2067 EFI_GUID(0xce345171, 0xba0b, 0x11d2, 0x8e, 0x4f, \
2068 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
2069
2070struct efi_disk {
2071 u64 revision;
2072 efi_status_t (EFIAPI *read_disk)(struct efi_disk *this, u32 media_id,
2073 u64 offset, efi_uintn_t buffer_size,
2074 void *buffer);
2075
2076 efi_status_t (EFIAPI *write_disk)(struct efi_disk *this, u32 media_id,
2077 u64 offset, efi_uintn_t buffer_size,
2078 void *buffer);
2079};
2080
Simon Glass867a6ac2015-07-31 09:31:36 -06002081#endif