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