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