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
  22 #ifdef CONFIG_EFI_LOADER
  23 #include <asm/setjmp.h>
  24 #endif
  25
  26 /* UEFI spec version 2.7 */
  27 #define EFI_SPECIFICATION_VERSION (2 << 16 | 70)
  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                         unsigned long memory_map_size,
 242                         unsigned long descriptor_size,
 243                         uint32_t descriptor_version,
 244                         struct efi_mem_desc *virtmap);
 245         efi_status_t (*convert_pointer)(unsigned long dbg, void **address);
 246         efi_status_t (EFIAPI *get_variable)(u16 *variable_name,
 247                                             const efi_guid_t *vendor,
 248                                             u32 *attributes,
 249                                             efi_uintn_t *data_size, void *data);
 250         efi_status_t (EFIAPI *get_next_variable_name)(
 251                         efi_uintn_t *variable_name_size,
 252                         u16 *variable_name, const efi_guid_t *vendor);
 253         efi_status_t (EFIAPI *set_variable)(u16 *variable_name,
 254                                             const efi_guid_t *vendor,
 255                                             u32 attributes,
 256                                             efi_uintn_t data_size,
 257                                             const void *data);
 258         efi_status_t (EFIAPI *get_next_high_mono_count)(
 259                         uint32_t *high_count);
 260         void (EFIAPI *reset_system)(enum efi_reset_type reset_type,
 261                                     efi_status_t reset_status,
 262                                     unsigned long data_size, void *reset_data);
 263         efi_status_t (EFIAPI *update_capsule)(
 264                         struct efi_capsule_header **capsule_header_array,
 265                         efi_uintn_t capsule_count,
 266                         u64 scatter_gather_list);
 267         efi_status_t (EFIAPI *query_capsule_caps)(
 268                         struct efi_capsule_header **capsule_header_array,
 269                         efi_uintn_t capsule_count,
 270                         u64 *maximum_capsule_size,
 271                         u32 *reset_type);
 272         efi_status_t (EFIAPI *query_variable_info)(
 273                         u32 attributes,
 274                         u64 *maximum_variable_storage_size,
 275                         u64 *remaining_variable_storage_size,
 276                         u64 *maximum_variable_size);
 277 };
 278
 279 /* EFI event group GUID definitions */
 280 #define EFI_EVENT_GROUP_EXIT_BOOT_SERVICES \
 281         EFI_GUID(0x27abf055, 0xb1b8, 0x4c26, 0x80, 0x48, \
 282                  0x74, 0x8f, 0x37, 0xba, 0xa2, 0xdf)
 283
 284 #define EFI_EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE \
 285         EFI_GUID(0x13fa7698, 0xc831, 0x49c7, 0x87, 0xea, \
 286                  0x8f, 0x43, 0xfc, 0xc2, 0x51, 0x96)
 287
 288 #define EFI_EVENT_GROUP_MEMORY_MAP_CHANGE \
 289         EFI_GUID(0x78bee926, 0x692f, 0x48fd, 0x9e, 0xdb, \
 290                  0x01, 0x42, 0x2e, 0xf0, 0xd7, 0xab)
 291
 292 #define EFI_EVENT_GROUP_READY_TO_BOOT \
 293         EFI_GUID(0x7ce88fb3, 0x4bd7, 0x4679, 0x87, 0xa8, \
 294                  0xa8, 0xd8, 0xde, 0xe5, 0x0d, 0x2b)
 295
 296 #define EFI_EVENT_GROUP_RESET_SYSTEM \
 297         EFI_GUID(0x62da6a56, 0x13fb, 0x485a, 0xa8, 0xda, \
 298                  0xa3, 0xdd, 0x79, 0x12, 0xcb, 0x6b)
 299
 300 /* EFI Configuration Table and GUID definitions */
 301 #define NULL_GUID \
 302         EFI_GUID(0x00000000, 0x0000, 0x0000, 0x00, 0x00, \
 303                  0x00, 0x00, 0x00, 0x00, 0x00, 0x00)
 304
 305 #define EFI_GLOBAL_VARIABLE_GUID \
 306         EFI_GUID(0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, \
 307                  0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c)
 308
 309 #define EFI_FDT_GUID \
 310         EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5, \
 311                  0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0)
 312
 313 #define EFI_ACPI_TABLE_GUID \
 314         EFI_GUID(0x8868e871, 0xe4f1, 0x11d3, \
 315                  0xbc, 0x22, 0x00, 0x80, 0xc7, 0x3c, 0x88, 0x81)
 316
 317 #define SMBIOS_TABLE_GUID \
 318         EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3,  \
 319                  0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
 320
 321 struct efi_configuration_table {
 322         efi_guid_t guid;
 323         void *table;
 324 } __packed;
 325
 326 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
 327
 328 struct efi_system_table {
 329         struct efi_table_hdr hdr;
 330         u16 *fw_vendor;   /* physical addr of wchar_t vendor string */
 331         u32 fw_revision;
 332         efi_handle_t con_in_handle;
 333         struct efi_simple_text_input_protocol *con_in;
 334         efi_handle_t con_out_handle;
 335         struct efi_simple_text_output_protocol *con_out;
 336         efi_handle_t stderr_handle;
 337         struct efi_simple_text_output_protocol *std_err;
 338         struct efi_runtime_services *runtime;
 339         struct efi_boot_services *boottime;
 340         efi_uintn_t nr_tables;
 341         struct efi_configuration_table *tables;
 342 };
 343
 344 #define EFI_LOADED_IMAGE_PROTOCOL_GUID \
 345         EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, \
 346                  0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 347
 348 #define EFI_LOADED_IMAGE_DEVICE_PATH_PROTOCOL_GUID \
 349         EFI_GUID(0xbc62157e, 0x3e33, 0x4fec, \
 350                  0x99, 0x20, 0x2d, 0x3b, 0x36, 0xd7, 0x50, 0xdf)
 351
 352 #define EFI_LOADED_IMAGE_PROTOCOL_REVISION 0x1000
 353
 354 struct efi_loaded_image {
 355         u32 revision;
 356         void *parent_handle;
 357         struct efi_system_table *system_table;
 358         efi_handle_t device_handle;
 359         struct efi_device_path *file_path;
 360         void *reserved;
 361         u32 load_options_size;
 362         void *load_options;
 363         void *image_base;
 364         aligned_u64 image_size;
 365         unsigned int image_code_type;
 366         unsigned int image_data_type;
 367         efi_status_t (EFIAPI *unload)(efi_handle_t image_handle);
 368 };
 369
 370 #define EFI_DEVICE_PATH_PROTOCOL_GUID \
 371         EFI_GUID(0x09576e91, 0x6d3f, 0x11d2, \
 372                  0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 373
 374 #define DEVICE_PATH_TYPE_END                    0x7f
 375 #  define DEVICE_PATH_SUB_TYPE_INSTANCE_END     0x01
 376 #  define DEVICE_PATH_SUB_TYPE_END              0xff
 377
 378 struct efi_device_path {
 379         u8 type;
 380         u8 sub_type;
 381         u16 length;
 382 } __packed;
 383
 384 struct efi_mac_addr {
 385         u8 addr[32];
 386 } __packed;
 387
 388 #define DEVICE_PATH_TYPE_HARDWARE_DEVICE        0x01
 389 #  define DEVICE_PATH_SUB_TYPE_MEMORY           0x03
 390 #  define DEVICE_PATH_SUB_TYPE_VENDOR           0x04
 391
 392 struct efi_device_path_memory {
 393         struct efi_device_path dp;
 394         u32 memory_type;
 395         u64 start_address;
 396         u64 end_address;
 397 } __packed;
 398
 399 struct efi_device_path_vendor {
 400         struct efi_device_path dp;
 401         efi_guid_t guid;
 402         u8 vendor_data[];
 403 } __packed;
 404
 405 #define DEVICE_PATH_TYPE_ACPI_DEVICE            0x02
 406 #  define DEVICE_PATH_SUB_TYPE_ACPI_DEVICE      0x01
 407
 408 #define EFI_PNP_ID(ID)                          (u32)(((ID) << 16) | 0x41D0)
 409 #define EISA_PNP_ID(ID)                         EFI_PNP_ID(ID)
 410 #define EISA_PNP_NUM(ID)                        ((ID) >> 16)
 411
 412 struct efi_device_path_acpi_path {
 413         struct efi_device_path dp;
 414         u32 hid;
 415         u32 uid;
 416 } __packed;
 417
 418 #define DEVICE_PATH_TYPE_MESSAGING_DEVICE       0x03
 419 #  define DEVICE_PATH_SUB_TYPE_MSG_ATAPI        0x01
 420 #  define DEVICE_PATH_SUB_TYPE_MSG_SCSI         0x02
 421 #  define DEVICE_PATH_SUB_TYPE_MSG_USB          0x05
 422 #  define DEVICE_PATH_SUB_TYPE_MSG_MAC_ADDR     0x0b
 423 #  define DEVICE_PATH_SUB_TYPE_MSG_USB_CLASS    0x0f
 424 #  define DEVICE_PATH_SUB_TYPE_MSG_SD           0x1a
 425 #  define DEVICE_PATH_SUB_TYPE_MSG_MMC          0x1d
 426
 427 struct efi_device_path_atapi {
 428         struct efi_device_path dp;
 429         u8 primary_secondary;
 430         u8 slave_master;
 431         u16 logical_unit_number;
 432 } __packed;
 433
 434 struct efi_device_path_scsi {
 435         struct efi_device_path dp;
 436         u16 target_id;
 437         u16 logical_unit_number;
 438 } __packed;
 439
 440 struct efi_device_path_usb {
 441         struct efi_device_path dp;
 442         u8 parent_port_number;
 443         u8 usb_interface;
 444 } __packed;
 445
 446 struct efi_device_path_mac_addr {
 447         struct efi_device_path dp;
 448         struct efi_mac_addr mac;
 449         u8 if_type;
 450 } __packed;
 451
 452 struct efi_device_path_usb_class {
 453         struct efi_device_path dp;
 454         u16 vendor_id;
 455         u16 product_id;
 456         u8 device_class;
 457         u8 device_subclass;
 458         u8 device_protocol;
 459 } __packed;
 460
 461 struct efi_device_path_sd_mmc_path {
 462         struct efi_device_path dp;
 463         u8 slot_number;
 464 } __packed;
 465
 466 #define DEVICE_PATH_TYPE_MEDIA_DEVICE           0x04
 467 #  define DEVICE_PATH_SUB_TYPE_HARD_DRIVE_PATH  0x01
 468 #  define DEVICE_PATH_SUB_TYPE_CDROM_PATH       0x02
 469 #  define DEVICE_PATH_SUB_TYPE_FILE_PATH        0x04
 470
 471 struct efi_device_path_hard_drive_path {
 472         struct efi_device_path dp;
 473         u32 partition_number;
 474         u64 partition_start;
 475         u64 partition_end;
 476         u8 partition_signature[16];
 477         u8 partmap_type;
 478         u8 signature_type;
 479 } __packed;
 480
 481 struct efi_device_path_cdrom_path {
 482         struct efi_device_path dp;
 483         u32 boot_entry;
 484         u64 partition_start;
 485         u64 partition_end;
 486 } __packed;
 487
 488 struct efi_device_path_file_path {
 489         struct efi_device_path dp;
 490         u16 str[];
 491 } __packed;
 492
 493 #define EFI_BLOCK_IO_PROTOCOL_GUID \
 494         EFI_GUID(0x964e5b21, 0x6459, 0x11d2, \
 495                  0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 496
 497 struct efi_block_io_media {
 498         u32 media_id;
 499         char removable_media;
 500         char media_present;
 501         char logical_partition;
 502         char read_only;
 503         char write_caching;
 504         u8 pad[3];
 505         u32 block_size;
 506         u32 io_align;
 507         u8 pad2[4];
 508         u64 last_block;
 509         /* Added in revision 2 of the protocol */
 510         u64 lowest_aligned_lba;
 511         u32 logical_blocks_per_physical_block;
 512         /* Added in revision 3 of the protocol */
 513         u32 optimal_transfer_length_granualarity;
 514 };
 515
 516 #define EFI_BLOCK_IO_PROTOCOL_REVISION2 0x00020001
 517 #define EFI_BLOCK_IO_PROTOCOL_REVISION3 0x0002001f
 518
 519 struct efi_block_io {
 520         u64 revision;
 521         struct efi_block_io_media *media;
 522         efi_status_t (EFIAPI *reset)(struct efi_block_io *this,
 523                         char extended_verification);
 524         efi_status_t (EFIAPI *read_blocks)(struct efi_block_io *this,
 525                         u32 media_id, u64 lba, efi_uintn_t buffer_size,
 526                         void *buffer);
 527         efi_status_t (EFIAPI *write_blocks)(struct efi_block_io *this,
 528                         u32 media_id, u64 lba, efi_uintn_t buffer_size,
 529                         void *buffer);
 530         efi_status_t (EFIAPI *flush_blocks)(struct efi_block_io *this);
 531 };
 532
 533 struct simple_text_output_mode {
 534         s32 max_mode;
 535         s32 mode;
 536         s32 attribute;
 537         s32 cursor_column;
 538         s32 cursor_row;
 539         bool cursor_visible;
 540 };
 541
 542 #define EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID \
 543         EFI_GUID(0x387477c2, 0x69c7, 0x11d2, \
 544                  0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 545
 546 #define EFI_BLACK                0x00
 547 #define EFI_BLUE                 0x01
 548 #define EFI_GREEN                0x02
 549 #define EFI_CYAN                 0x03
 550 #define EFI_RED                  0x04
 551 #define EFI_MAGENTA              0x05
 552 #define EFI_BROWN                0x06
 553 #define EFI_LIGHTGRAY            0x07
 554 #define EFI_BRIGHT               0x08
 555 #define EFI_DARKGRAY             0x08
 556 #define EFI_LIGHTBLUE            0x09
 557 #define EFI_LIGHTGREEN           0x0a
 558 #define EFI_LIGHTCYAN            0x0b
 559 #define EFI_LIGHTRED             0x0c
 560 #define EFI_LIGHTMAGENTA         0x0d
 561 #define EFI_YELLOW               0x0e
 562 #define EFI_WHITE                0x0f
 563 #define EFI_BACKGROUND_BLACK     0x00
 564 #define EFI_BACKGROUND_BLUE      0x10
 565 #define EFI_BACKGROUND_GREEN     0x20
 566 #define EFI_BACKGROUND_CYAN      0x30
 567 #define EFI_BACKGROUND_RED       0x40
 568 #define EFI_BACKGROUND_MAGENTA   0x50
 569 #define EFI_BACKGROUND_BROWN     0x60
 570 #define EFI_BACKGROUND_LIGHTGRAY 0x70
 571
 572 /* extract foreground color from EFI attribute */
 573 #define EFI_ATTR_FG(attr)        ((attr) & 0x07)
 574 /* treat high bit of FG as bright/bold (similar to edk2) */
 575 #define EFI_ATTR_BOLD(attr)      (((attr) >> 3) & 0x01)
 576 /* extract background color from EFI attribute */
 577 #define EFI_ATTR_BG(attr)        (((attr) >> 4) & 0x7)
 578
 579 struct efi_simple_text_output_protocol {
 580         efi_status_t (EFIAPI *reset)(
 581                         struct efi_simple_text_output_protocol *this,
 582                         char extended_verification);
 583         efi_status_t (EFIAPI *output_string)(
 584                         struct efi_simple_text_output_protocol *this,
 585                         const efi_string_t str);
 586         efi_status_t (EFIAPI *test_string)(
 587                         struct efi_simple_text_output_protocol *this,
 588                         const efi_string_t str);
 589         efi_status_t(EFIAPI *query_mode)(
 590                         struct efi_simple_text_output_protocol *this,
 591                         unsigned long mode_number, unsigned long *columns,
 592                         unsigned long *rows);
 593         efi_status_t(EFIAPI *set_mode)(
 594                         struct efi_simple_text_output_protocol *this,
 595                         unsigned long mode_number);
 596         efi_status_t(EFIAPI *set_attribute)(
 597                         struct efi_simple_text_output_protocol *this,
 598                         unsigned long attribute);
 599         efi_status_t(EFIAPI *clear_screen) (
 600                         struct efi_simple_text_output_protocol *this);
 601         efi_status_t(EFIAPI *set_cursor_position) (
 602                         struct efi_simple_text_output_protocol *this,
 603                         unsigned long column, unsigned long row);
 604         efi_status_t(EFIAPI *enable_cursor)(
 605                         struct efi_simple_text_output_protocol *this,
 606                         bool enable);
 607         struct simple_text_output_mode *mode;
 608 };
 609
 610 #define EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL_GUID \
 611         EFI_GUID(0xdd9e7534, 0x7762, 0x4698, \
 612                  0x8c, 0x14, 0xf5, 0x85, 0x17, 0xa6, 0x25, 0xaa)
 613
 614 struct efi_input_key {
 615         u16 scan_code;
 616         s16 unicode_char;
 617 };
 618
 619 #define EFI_SHIFT_STATE_INVALID         0x00000000
 620 #define EFI_RIGHT_SHIFT_PRESSED         0x00000001
 621 #define EFI_LEFT_SHIFT_PRESSED          0x00000002
 622 #define EFI_RIGHT_CONTROL_PRESSED       0x00000004
 623 #define EFI_LEFT_CONTROL_PRESSED        0x00000008
 624 #define EFI_RIGHT_ALT_PRESSED           0x00000010
 625 #define EFI_LEFT_ALT_PRESSED            0x00000020
 626 #define EFI_RIGHT_LOGO_PRESSED          0x00000040
 627 #define EFI_LEFT_LOGO_PRESSED           0x00000080
 628 #define EFI_MENU_KEY_PRESSED            0x00000100
 629 #define EFI_SYS_REQ_PRESSED             0x00000200
 630 #define EFI_SHIFT_STATE_VALID           0x80000000
 631
 632 #define EFI_TOGGLE_STATE_INVALID        0x00
 633 #define EFI_SCROLL_LOCK_ACTIVE          0x01
 634 #define EFI_NUM_LOCK_ACTIVE             0x02
 635 #define EFI_CAPS_LOCK_ACTIVE            0x04
 636 #define EFI_KEY_STATE_EXPOSED           0x40
 637 #define EFI_TOGGLE_STATE_VALID          0x80
 638
 639 struct efi_key_state {
 640         u32 key_shift_state;
 641         u8 key_toggle_state;
 642 };
 643
 644 struct efi_key_data {
 645         struct efi_input_key key;
 646         struct efi_key_state key_state;
 647 };
 648
 649 struct efi_simple_text_input_ex_protocol {
 650         efi_status_t (EFIAPI *reset) (
 651                 struct efi_simple_text_input_ex_protocol *this,
 652                 bool extended_verification);
 653         efi_status_t (EFIAPI *read_key_stroke_ex) (
 654                 struct efi_simple_text_input_ex_protocol *this,
 655                 struct efi_key_data *key_data);
 656         struct efi_event *wait_for_key_ex;
 657         efi_status_t (EFIAPI *set_state) (
 658                 struct efi_simple_text_input_ex_protocol *this,
 659                 u8 *key_toggle_state);
 660         efi_status_t (EFIAPI *register_key_notify) (
 661                 struct efi_simple_text_input_ex_protocol *this,
 662                 struct efi_key_data *key_data,
 663                 efi_status_t (EFIAPI *key_notify_function)(
 664                         struct efi_key_data *key_data),
 665                 void **notify_handle);
 666         efi_status_t (EFIAPI *unregister_key_notify) (
 667                 struct efi_simple_text_input_ex_protocol *this,
 668                 void *notification_handle);
 669 };
 670
 671 #define EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID \
 672         EFI_GUID(0x387477c1, 0x69c7, 0x11d2, \
 673                  0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 674
 675 struct efi_simple_text_input_protocol {
 676         efi_status_t(EFIAPI *reset)(struct efi_simple_text_input_protocol *this,
 677                                     bool extended_verification);
 678         efi_status_t(EFIAPI *read_key_stroke)(
 679                         struct efi_simple_text_input_protocol *this,
 680                         struct efi_input_key *key);
 681         struct efi_event *wait_for_key;
 682 };
 683
 684 #define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID \
 685         EFI_GUID(0x8b843e20, 0x8132, 0x4852, \
 686                  0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c)
 687
 688 struct efi_device_path_to_text_protocol {
 689         uint16_t *(EFIAPI *convert_device_node_to_text)(
 690                         struct efi_device_path *device_node,
 691                         bool display_only,
 692                         bool allow_shortcuts);
 693         uint16_t *(EFIAPI *convert_device_path_to_text)(
 694                         struct efi_device_path *device_path,
 695                         bool display_only,
 696                         bool allow_shortcuts);
 697 };
 698
 699 #define EFI_DEVICE_PATH_UTILITIES_PROTOCOL_GUID \
 700         EFI_GUID(0x0379be4e, 0xd706, 0x437d, \
 701                  0xb0, 0x37, 0xed, 0xb8, 0x2f, 0xb7, 0x72, 0xa4)
 702
 703 struct efi_device_path_utilities_protocol {
 704         efi_uintn_t (EFIAPI *get_device_path_size)(
 705                 const struct efi_device_path *device_path);
 706         struct efi_device_path *(EFIAPI *duplicate_device_path)(
 707                 const struct efi_device_path *device_path);
 708         struct efi_device_path *(EFIAPI *append_device_path)(
 709                 const struct efi_device_path *src1,
 710                 const struct efi_device_path *src2);
 711         struct efi_device_path *(EFIAPI *append_device_node)(
 712                 const struct efi_device_path *device_path,
 713                 const struct efi_device_path *device_node);
 714         struct efi_device_path *(EFIAPI *append_device_path_instance)(
 715                 const struct efi_device_path *device_path,
 716                 const struct efi_device_path *device_path_instance);
 717         struct efi_device_path *(EFIAPI *get_next_device_path_instance)(
 718                 struct efi_device_path **device_path_instance,
 719                 efi_uintn_t *device_path_instance_size);
 720         bool (EFIAPI *is_device_path_multi_instance)(
 721                 const struct efi_device_path *device_path);
 722         struct efi_device_path *(EFIAPI *create_device_node)(
 723                 uint8_t node_type,
 724                 uint8_t node_sub_type,
 725                 uint16_t node_length);
 726 };
 727
 728 /*
 729  * Human Interface Infrastructure (HII)
 730  */
 731 struct efi_hii_package_list_header {
 732         efi_guid_t package_list_guid;
 733         u32 package_length;
 734 } __packed;
 735
 736 /**
 737  * struct efi_hii_package_header - EFI HII package header
 738  *
 739  * @fields:     'fields' replaces the bit-fields defined in the EFI
 740  *              specification to to avoid possible compiler incompatibilities::
 741  *
 742  *              u32 length:24;
 743  *              u32 type:8;
 744  */
 745 struct efi_hii_package_header {
 746         u32 fields;
 747 } __packed;
 748
 749 #define __EFI_HII_PACKAGE_LEN_SHIFT     0
 750 #define __EFI_HII_PACKAGE_TYPE_SHIFT    24
 751 #define __EFI_HII_PACKAGE_LEN_MASK      0xffffff
 752 #define __EFI_HII_PACKAGE_TYPE_MASK     0xff
 753
 754 #define EFI_HII_PACKAGE_TYPE_ALL          0x00
 755 #define EFI_HII_PACKAGE_TYPE_GUID         0x01
 756 #define EFI_HII_PACKAGE_FORMS             0x02
 757 #define EFI_HII_PACKAGE_STRINGS           0x04
 758 #define EFI_HII_PACKAGE_FONTS             0x05
 759 #define EFI_HII_PACKAGE_IMAGES            0x06
 760 #define EFI_HII_PACKAGE_SIMPLE_FONTS      0x07
 761 #define EFI_HII_PACKAGE_DEVICE_PATH       0x08
 762 #define EFI_HII_PACKAGE_KEYBOARD_LAYOUT   0x09
 763 #define EFI_HII_PACKAGE_ANIMATIONS        0x0A
 764 #define EFI_HII_PACKAGE_END               0xDF
 765 #define EFI_HII_PACKAGE_TYPE_SYSTEM_BEGIN 0xE0
 766 #define EFI_HII_PACKAGE_TYPE_SYSTEM_END   0xFF
 767
 768 /*
 769  * HII GUID package
 770  */
 771 struct efi_hii_guid_package {
 772         struct efi_hii_package_header header;
 773         efi_guid_t guid;
 774         char data[];
 775 } __packed;
 776
 777 /*
 778  * HII string package
 779  */
 780 struct efi_hii_strings_package {
 781         struct efi_hii_package_header header;
 782         u32 header_size;
 783         u32 string_info_offset;
 784         u16 language_window[16];
 785         efi_string_id_t language_name;
 786         u8  language[];
 787 } __packed;
 788
 789 struct efi_hii_string_block {
 790         u8 block_type;
 791         /* u8 block_body[]; */
 792 } __packed;
 793
 794 #define EFI_HII_SIBT_END               0x00
 795 #define EFI_HII_SIBT_STRING_SCSU       0x10
 796 #define EFI_HII_SIBT_STRING_SCSU_FONT  0x11
 797 #define EFI_HII_SIBT_STRINGS_SCSU      0x12
 798 #define EFI_HII_SIBT_STRINGS_SCSU_FONT 0x13
 799 #define EFI_HII_SIBT_STRING_UCS2       0x14
 800 #define EFI_HII_SIBT_STRING_UCS2_FONT  0x15
 801 #define EFI_HII_SIBT_STRINGS_UCS2      0x16
 802 #define EFI_HII_SIBT_STRINGS_UCS2_FONT 0x17
 803 #define EFI_HII_SIBT_DUPLICATE         0x20
 804 #define EFI_HII_SIBT_SKIP2             0x21
 805 #define EFI_HII_SIBT_SKIP1             0x22
 806 #define EFI_HII_SIBT_EXT1              0x30
 807 #define EFI_HII_SIBT_EXT2              0x31
 808 #define EFI_HII_SIBT_EXT4              0x32
 809 #define EFI_HII_SIBT_FONT              0x40
 810
 811 struct efi_hii_sibt_string_ucs2_block {
 812         struct efi_hii_string_block header;
 813         u16 string_text[];
 814 } __packed;
 815
 816 static inline struct efi_hii_string_block *
 817 efi_hii_sibt_string_ucs2_block_next(struct efi_hii_sibt_string_ucs2_block *blk)
 818 {
 819         return ((void *)blk) + sizeof(*blk) +
 820                 (u16_strlen(blk->string_text) + 1) * 2;
 821 }
 822
 823 /*
 824  * HII forms package
 825  * TODO: full scope of definitions
 826  */
 827 struct efi_hii_time {
 828         u8 hour;
 829         u8 minute;
 830         u8 second;
 831 };
 832
 833 struct efi_hii_date {
 834         u16 year;
 835         u8 month;
 836         u8 day;
 837 };
 838
 839 struct efi_hii_ref {
 840         efi_question_id_t question_id;
 841         efi_form_id_t form_id;
 842         efi_guid_t form_set_guid;
 843         efi_string_id_t device_path;
 844 };
 845
 846 union efi_ifr_type_value {
 847         u8 u8;                          // EFI_IFR_TYPE_NUM_SIZE_8
 848         u16 u16;                        // EFI_IFR_TYPE_NUM_SIZE_16
 849         u32 u32;                        // EFI_IFR_TYPE_NUM_SIZE_32
 850         u64 u64;                        // EFI_IFR_TYPE_NUM_SIZE_64
 851         bool b;                         // EFI_IFR_TYPE_BOOLEAN
 852         struct efi_hii_time time;       // EFI_IFR_TYPE_TIME
 853         struct efi_hii_date date;       // EFI_IFR_TYPE_DATE
 854         efi_string_id_t string; // EFI_IFR_TYPE_STRING, EFI_IFR_TYPE_ACTION
 855         struct efi_hii_ref ref;         // EFI_IFR_TYPE_REF
 856         // u8 buffer[];                 // EFI_IFR_TYPE_BUFFER
 857 };
 858
 859 #define EFI_IFR_TYPE_NUM_SIZE_8         0x00
 860 #define EFI_IFR_TYPE_NUM_SIZE_16        0x01
 861 #define EFI_IFR_TYPE_NUM_SIZE_32        0x02
 862 #define EFI_IFR_TYPE_NUM_SIZE_64        0x03
 863 #define EFI_IFR_TYPE_BOOLEAN            0x04
 864 #define EFI_IFR_TYPE_TIME               0x05
 865 #define EFI_IFR_TYPE_DATE               0x06
 866 #define EFI_IFR_TYPE_STRING             0x07
 867 #define EFI_IFR_TYPE_OTHER              0x08
 868 #define EFI_IFR_TYPE_UNDEFINED          0x09
 869 #define EFI_IFR_TYPE_ACTION             0x0A
 870 #define EFI_IFR_TYPE_BUFFER             0x0B
 871 #define EFI_IFR_TYPE_REF                0x0C
 872 #define EFI_IFR_OPTION_DEFAULT          0x10
 873 #define EFI_IFR_OPTION_DEFAULT_MFG      0x20
 874
 875 #define EFI_IFR_ONE_OF_OPTION_OP        0x09
 876
 877 struct efi_ifr_op_header {
 878         u8 opCode;
 879         u8 length:7;
 880         u8 scope:1;
 881 };
 882
 883 struct efi_ifr_one_of_option {
 884         struct efi_ifr_op_header header;
 885         efi_string_id_t option;
 886         u8 flags;
 887         u8 type;
 888         union efi_ifr_type_value value;
 889 };
 890
 891 typedef efi_uintn_t efi_browser_action_t;
 892
 893 #define EFI_BROWSER_ACTION_REQUEST_NONE                 0
 894 #define EFI_BROWSER_ACTION_REQUEST_RESET                1
 895 #define EFI_BROWSER_ACTION_REQUEST_SUBMIT               2
 896 #define EFI_BROWSER_ACTION_REQUEST_EXIT                 3
 897 #define EFI_BROWSER_ACTION_REQUEST_FORM_SUBMIT_EXIT     4
 898 #define EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD_EXIT    5
 899 #define EFI_BROWSER_ACTION_REQUEST_FORM_APPLY           6
 900 #define EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD         7
 901 #define EFI_BROWSER_ACTION_REQUEST_RECONNECT            8
 902
 903 typedef efi_uintn_t efi_browser_action_request_t;
 904
 905 #define EFI_BROWSER_ACTION_CHANGING                     0
 906 #define EFI_BROWSER_ACTION_CHANGED                      1
 907 #define EFI_BROWSER_ACTION_RETRIEVE                     2
 908 #define EFI_BROWSER_ACTION_FORM_OPEN                    3
 909 #define EFI_BROWSER_ACTION_FORM_CLOSE                   4
 910 #define EFI_BROWSER_ACTION_SUBMITTED                    5
 911 #define EFI_BROWSER_ACTION_DEFAULT_STANDARD             0x1000
 912 #define EFI_BROWSER_ACTION_DEFAULT_MANUFACTURING        0x1001
 913 #define EFI_BROWSER_ACTION_DEFAULT_SAFE                 0x1002
 914 #define EFI_BROWSER_ACTION_DEFAULT_PLATFORM             0x2000
 915 #define EFI_BROWSER_ACTION_DEFAULT_HARDWARE             0x3000
 916 #define EFI_BROWSER_ACTION_DEFAULT_FIRMWARE             0x4000
 917
 918 /*
 919  * HII keyboard package
 920  */
 921 typedef enum {
 922         EFI_KEY_LCTRL, EFI_KEY_A0, EFI_KEY_LALT, EFI_KEY_SPACE_BAR,
 923         EFI_KEY_A2, EFI_KEY_A3, EFI_KEY_A4, EFI_KEY_RCTRL, EFI_KEY_LEFT_ARROW,
 924         EFI_KEY_DOWN_ARROW, EFI_KEY_RIGHT_ARROW, EFI_KEY_ZERO,
 925         EFI_KEY_PERIOD, EFI_KEY_ENTER, EFI_KEY_LSHIFT, EFI_KEY_B0,
 926         EFI_KEY_B1, EFI_KEY_B2, EFI_KEY_B3, EFI_KEY_B4, EFI_KEY_B5, EFI_KEY_B6,
 927         EFI_KEY_B7, EFI_KEY_B8, EFI_KEY_B9, EFI_KEY_B10, EFI_KEY_RSHIFT,
 928         EFI_KEY_UP_ARROW, EFI_KEY_ONE, EFI_KEY_TWO, EFI_KEY_THREE,
 929         EFI_KEY_CAPS_LOCK, EFI_KEY_C1, EFI_KEY_C2, EFI_KEY_C3, EFI_KEY_C4,
 930         EFI_KEY_C5, EFI_KEY_C6, EFI_KEY_C7, EFI_KEY_C8, EFI_KEY_C9,
 931         EFI_KEY_C10, EFI_KEY_C11, EFI_KEY_C12, EFI_KEY_FOUR, EFI_KEY_FIVE,
 932         EFI_KEY_SIX, EFI_KEY_PLUS, EFI_KEY_TAB, EFI_KEY_D1, EFI_KEY_D2,
 933         EFI_KEY_D3, EFI_KEY_D4, EFI_KEY_D5, EFI_KEY_D6, EFI_KEY_D7, EFI_KEY_D8,
 934         EFI_KEY_D9, EFI_KEY_D10, EFI_KEY_D11, EFI_KEY_D12, EFI_KEY_D13,
 935         EFI_KEY_DEL, EFI_KEY_END, EFI_KEY_PG_DN, EFI_KEY_SEVEN, EFI_KEY_EIGHT,
 936         EFI_KEY_NINE, EFI_KEY_E0, EFI_KEY_E1, EFI_KEY_E2, EFI_KEY_E3,
 937         EFI_KEY_E4, EFI_KEY_E5, EFI_KEY_E6, EFI_KEY_E7, EFI_KEY_E8, EFI_KEY_E9,
 938         EFI_KEY_E10, EFI_KEY_E11, EFI_KEY_E12, EFI_KEY_BACK_SPACE,
 939         EFI_KEY_INS, EFI_KEY_HOME, EFI_KEY_PG_UP, EFI_KEY_NLCK, EFI_KEY_SLASH,
 940         EFI_KEY_ASTERISK, EFI_KEY_MINUS, EFI_KEY_ESC, EFI_KEY_F1, EFI_KEY_F2,
 941         EFI_KEY_F3, EFI_KEY_F4, EFI_KEY_F5, EFI_KEY_F6, EFI_KEY_F7, EFI_KEY_F8,
 942         EFI_KEY_F9, EFI_KEY_F10, EFI_KEY_F11, EFI_KEY_F12, EFI_KEY_PRINT,
 943         EFI_KEY_SLCK, EFI_KEY_PAUSE,
 944 } efi_key;
 945
 946 struct efi_key_descriptor {
 947         u32 key;
 948         u16 unicode;
 949         u16 shifted_unicode;
 950         u16 alt_gr_unicode;
 951         u16 shifted_alt_gr_unicode;
 952         u16 modifier;
 953         u16 affected_attribute;
 954 } __packed;
 955
 956 struct efi_hii_keyboard_layout {
 957         u16 layout_length;
 958         efi_guid_t guid;
 959         u32 layout_descriptor_string_offset;
 960         u8 descriptor_count;
 961         struct efi_key_descriptor descriptors[];
 962 } __packed;
 963
 964 struct efi_hii_keyboard_package {
 965         struct efi_hii_package_header header;
 966         u16 layout_count;
 967         struct efi_hii_keyboard_layout layout[];
 968 } __packed;
 969
 970 /*
 971  * HII protocols
 972  */
 973 #define EFI_HII_STRING_PROTOCOL_GUID \
 974         EFI_GUID(0x0fd96974, 0x23aa, 0x4cdc, \
 975                  0xb9, 0xcb, 0x98, 0xd1, 0x77, 0x50, 0x32, 0x2a)
 976
 977 struct efi_font_info {
 978         efi_hii_font_style_t font_style;
 979         u16 font_size;
 980         u16 font_name[1];
 981 };
 982
 983 struct efi_hii_string_protocol {
 984         efi_status_t(EFIAPI *new_string)(
 985                 const struct efi_hii_string_protocol *this,
 986                 efi_hii_handle_t package_list,
 987                 efi_string_id_t *string_id,
 988                 const u8 *language,
 989                 const u16 *language_name,
 990                 const efi_string_t string,
 991                 const struct efi_font_info *string_font_info);
 992         efi_status_t(EFIAPI *get_string)(
 993                 const struct efi_hii_string_protocol *this,
 994                 const u8 *language,
 995                 efi_hii_handle_t package_list,
 996                 efi_string_id_t string_id,
 997                 efi_string_t string,
 998                 efi_uintn_t *string_size,
 999                 struct efi_font_info **string_font_info);
1000         efi_status_t(EFIAPI *set_string)(
1001                 const struct efi_hii_string_protocol *this,
1002                 efi_hii_handle_t package_list,
1003                 efi_string_id_t string_id,
1004                 const u8 *language,
1005                 const efi_string_t string,
1006                 const struct efi_font_info *string_font_info);
1007         efi_status_t(EFIAPI *get_languages)(
1008                 const struct efi_hii_string_protocol *this,
1009                 efi_hii_handle_t package_list,
1010                 u8 *languages,
1011                 efi_uintn_t *languages_size);
1012         efi_status_t(EFIAPI *get_secondary_languages)(
1013                 const struct efi_hii_string_protocol *this,
1014                 efi_hii_handle_t package_list,
1015                 const u8 *primary_language,
1016                 u8 *secondary_languages,
1017                 efi_uintn_t *secondary_languages_size);
1018 };
1019
1020 #define EFI_HII_DATABASE_PROTOCOL_GUID       \
1021         EFI_GUID(0xef9fc172, 0xa1b2, 0x4693, \
1022                  0xb3, 0x27, 0x6d, 0x32, 0xfc, 0x41, 0x60, 0x42)
1023
1024 struct efi_hii_database_protocol {
1025         efi_status_t(EFIAPI *new_package_list)(
1026                 const struct efi_hii_database_protocol *this,
1027                 const struct efi_hii_package_list_header *package_list,
1028                 const efi_handle_t driver_handle,
1029                 efi_hii_handle_t *handle);
1030         efi_status_t(EFIAPI *remove_package_list)(
1031                 const struct efi_hii_database_protocol *this,
1032                 efi_hii_handle_t handle);
1033         efi_status_t(EFIAPI *update_package_list)(
1034                 const struct efi_hii_database_protocol *this,
1035                 efi_hii_handle_t handle,
1036                 const struct efi_hii_package_list_header *package_list);
1037         efi_status_t(EFIAPI *list_package_lists)(
1038                 const struct efi_hii_database_protocol *this,
1039                 u8 package_type,
1040                 const efi_guid_t *package_guid,
1041                 efi_uintn_t *handle_buffer_length,
1042                 efi_hii_handle_t *handle);
1043         efi_status_t(EFIAPI *export_package_lists)(
1044                 const struct efi_hii_database_protocol *this,
1045                 efi_hii_handle_t handle,
1046                 efi_uintn_t *buffer_size,
1047                 struct efi_hii_package_list_header *buffer);
1048         efi_status_t(EFIAPI *register_package_notify)(
1049                 const struct efi_hii_database_protocol *this,
1050                 u8 package_type,
1051                 const efi_guid_t *package_guid,
1052                 const void *package_notify_fn,
1053                 efi_uintn_t notify_type,
1054                 efi_handle_t *notify_handle);
1055         efi_status_t(EFIAPI *unregister_package_notify)(
1056                 const struct efi_hii_database_protocol *this,
1057                 efi_handle_t notification_handle
1058                 );
1059         efi_status_t(EFIAPI *find_keyboard_layouts)(
1060                 const struct efi_hii_database_protocol *this,
1061                 u16 *key_guid_buffer_length,
1062                 efi_guid_t *key_guid_buffer);
1063         efi_status_t(EFIAPI *get_keyboard_layout)(
1064                 const struct efi_hii_database_protocol *this,
1065                 efi_guid_t *key_guid,
1066                 u16 *keyboard_layout_length,
1067                 struct efi_hii_keyboard_layout *keyboard_layout);
1068         efi_status_t(EFIAPI *set_keyboard_layout)(
1069                 const struct efi_hii_database_protocol *this,
1070                 efi_guid_t *key_guid);
1071         efi_status_t(EFIAPI *get_package_list_handle)(
1072                 const struct efi_hii_database_protocol *this,
1073                 efi_hii_handle_t package_list_handle,
1074                 efi_handle_t *driver_handle);
1075 };
1076
1077 #define EFI_HII_CONFIG_ROUTING_PROTOCOL_GUID \
1078         EFI_GUID(0x587e72d7, 0xcc50, 0x4f79, \
1079                  0x82, 0x09, 0xca, 0x29, 0x1f, 0xc1, 0xa1, 0x0f)
1080
1081 struct efi_hii_config_routing_protocol {
1082         efi_status_t(EFIAPI *extract_config)(
1083                 const struct efi_hii_config_routing_protocol *this,
1084                 const efi_string_t request,
1085                 efi_string_t *progress,
1086                 efi_string_t *results);
1087         efi_status_t(EFIAPI *export_config)(
1088                 const struct efi_hii_config_routing_protocol *this,
1089                 efi_string_t *results);
1090         efi_status_t(EFIAPI *route_config)(
1091                 const struct efi_hii_config_routing_protocol *this,
1092                 const efi_string_t configuration,
1093                 efi_string_t *progress);
1094         efi_status_t(EFIAPI *block_to_config)(
1095                 const struct efi_hii_config_routing_protocol *this,
1096                 const efi_string_t config_request,
1097                 const uint8_t *block,
1098                 const efi_uintn_t block_size,
1099                 efi_string_t *config,
1100                 efi_string_t *progress);
1101         efi_status_t(EFIAPI *config_to_block)(
1102                 const struct efi_hii_config_routing_protocol *this,
1103                 const efi_string_t config_resp,
1104                 const uint8_t *block,
1105                 const efi_uintn_t *block_size,
1106                 efi_string_t *progress);
1107         efi_status_t(EFIAPI *get_alt_config)(
1108                 const struct efi_hii_config_routing_protocol *this,
1109                 const efi_string_t config_resp,
1110                 const efi_guid_t *guid,
1111                 const efi_string_t name,
1112                 const struct efi_device_path *device_path,
1113                 const efi_string_t alt_cfg_id,
1114                 efi_string_t *alt_cfg_resp);
1115 };
1116
1117 #define EFI_HII_CONFIG_ACCESS_PROTOCOL_GUID \
1118         EFI_GUID(0x330d4706, 0xf2a0, 0x4e4f, \
1119                  0xa3, 0x69, 0xb6, 0x6f, 0xa8, 0xd5, 0x43, 0x85)
1120
1121 struct efi_hii_config_access_protocol {
1122         efi_status_t(EFIAPI *extract_config_access)(
1123                 const struct efi_hii_config_access_protocol *this,
1124                 const efi_string_t request,
1125                 efi_string_t *progress,
1126                 efi_string_t *results);
1127         efi_status_t(EFIAPI *route_config_access)(
1128                 const struct efi_hii_config_access_protocol *this,
1129                 const efi_string_t configuration,
1130                 efi_string_t *progress);
1131         efi_status_t(EFIAPI *form_callback)(
1132                 const struct efi_hii_config_access_protocol *this,
1133                 efi_browser_action_t action,
1134                 efi_question_id_t question_id,
1135                 u8 type,
1136                 union efi_ifr_type_value *value,
1137                 efi_browser_action_request_t *action_request);
1138 };
1139
1140 #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
1141         EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, \
1142                  0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
1143
1144 #define EFI_GOT_RGBA8           0
1145 #define EFI_GOT_BGRA8           1
1146 #define EFI_GOT_BITMASK         2
1147
1148 struct efi_gop_mode_info {
1149         u32 version;
1150         u32 width;
1151         u32 height;
1152         u32 pixel_format;
1153         u32 pixel_bitmask[4];
1154         u32 pixels_per_scanline;
1155 };
1156
1157 struct efi_gop_mode {
1158         u32 max_mode;
1159         u32 mode;
1160         struct efi_gop_mode_info *info;
1161         unsigned long info_size;
1162         efi_physical_addr_t fb_base;
1163         unsigned long fb_size;
1164 };
1165
1166 struct efi_gop_pixel {
1167         u8 blue;
1168         u8 green;
1169         u8 red;
1170         u8 reserved;
1171 };
1172
1173 #define EFI_BLT_VIDEO_FILL              0
1174 #define EFI_BLT_VIDEO_TO_BLT_BUFFER     1
1175 #define EFI_BLT_BUFFER_TO_VIDEO         2
1176 #define EFI_BLT_VIDEO_TO_VIDEO          3
1177
1178 struct efi_gop {
1179         efi_status_t (EFIAPI *query_mode)(struct efi_gop *this, u32 mode_number,
1180                                           efi_uintn_t *size_of_info,
1181                                           struct efi_gop_mode_info **info);
1182         efi_status_t (EFIAPI *set_mode)(struct efi_gop *this, u32 mode_number);
1183         efi_status_t (EFIAPI *blt)(struct efi_gop *this,
1184                                    struct efi_gop_pixel *buffer,
1185                                    u32 operation, efi_uintn_t sx,
1186                                    efi_uintn_t sy, efi_uintn_t dx,
1187                                    efi_uintn_t dy, efi_uintn_t width,
1188                                    efi_uintn_t height, efi_uintn_t delta);
1189         struct efi_gop_mode *mode;
1190 };
1191
1192 #define EFI_SIMPLE_NETWORK_PROTOCOL_GUID \
1193         EFI_GUID(0xa19832b9, 0xac25, 0x11d3, \
1194                  0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
1195
1196 struct efi_mac_address {
1197         char mac_addr[32];
1198 };
1199
1200 struct efi_ip_address {
1201         u8 ip_addr[16];
1202 } __attribute__((aligned(4)));
1203
1204 enum efi_simple_network_state {
1205         EFI_NETWORK_STOPPED,
1206         EFI_NETWORK_STARTED,
1207         EFI_NETWORK_INITIALIZED,
1208 };
1209
1210 struct efi_simple_network_mode {
1211         enum efi_simple_network_state state;
1212         u32 hwaddr_size;
1213         u32 media_header_size;
1214         u32 max_packet_size;
1215         u32 nvram_size;
1216         u32 nvram_access_size;
1217         u32 receive_filter_mask;
1218         u32 receive_filter_setting;
1219         u32 max_mcast_filter_count;
1220         u32 mcast_filter_count;
1221         struct efi_mac_address mcast_filter[16];
1222         struct efi_mac_address current_address;
1223         struct efi_mac_address broadcast_address;
1224         struct efi_mac_address permanent_address;
1225         u8 if_type;
1226         u8 mac_changeable;
1227         u8 multitx_supported;
1228         u8 media_present_supported;
1229         u8 media_present;
1230 };
1231
1232 /* receive_filters bit mask */
1233 #define EFI_SIMPLE_NETWORK_RECEIVE_UNICAST               0x01
1234 #define EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST             0x02
1235 #define EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST             0x04
1236 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS           0x08
1237 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST 0x10
1238
1239 /* interrupt status bit mask */
1240 #define EFI_SIMPLE_NETWORK_RECEIVE_INTERRUPT    0x01
1241 #define EFI_SIMPLE_NETWORK_TRANSMIT_INTERRUPT   0x02
1242 #define EFI_SIMPLE_NETWORK_COMMAND_INTERRUPT    0x04
1243 #define EFI_SIMPLE_NETWORK_SOFTWARE_INTERRUPT   0x08
1244
1245 /* revision of the simple network protocol */
1246 #define EFI_SIMPLE_NETWORK_PROTOCOL_REVISION    0x00010000
1247
1248 struct efi_simple_network {
1249         u64 revision;
1250         efi_status_t (EFIAPI *start)(struct efi_simple_network *this);
1251         efi_status_t (EFIAPI *stop)(struct efi_simple_network *this);
1252         efi_status_t (EFIAPI *initialize)(struct efi_simple_network *this,
1253                         ulong extra_rx, ulong extra_tx);
1254         efi_status_t (EFIAPI *reset)(struct efi_simple_network *this,
1255                         int extended_verification);
1256         efi_status_t (EFIAPI *shutdown)(struct efi_simple_network *this);
1257         efi_status_t (EFIAPI *receive_filters)(struct efi_simple_network *this,
1258                         u32 enable, u32 disable, int reset_mcast_filter,
1259                         ulong mcast_filter_count,
1260                         struct efi_mac_address *mcast_filter);
1261         efi_status_t (EFIAPI *station_address)(struct efi_simple_network *this,
1262                         int reset, struct efi_mac_address *new_mac);
1263         efi_status_t (EFIAPI *statistics)(struct efi_simple_network *this,
1264                         int reset, ulong *stat_size, void *stat_table);
1265         efi_status_t (EFIAPI *mcastiptomac)(struct efi_simple_network *this,
1266                         int ipv6, struct efi_ip_address *ip,
1267                         struct efi_mac_address *mac);
1268         efi_status_t (EFIAPI *nvdata)(struct efi_simple_network *this,
1269                         int read_write, ulong offset, ulong buffer_size,
1270                         char *buffer);
1271         efi_status_t (EFIAPI *get_status)(struct efi_simple_network *this,
1272                         u32 *int_status, void **txbuf);
1273         efi_status_t (EFIAPI *transmit)(struct efi_simple_network *this,
1274                         size_t header_size, size_t buffer_size, void *buffer,
1275                         struct efi_mac_address *src_addr,
1276                         struct efi_mac_address *dest_addr, u16 *protocol);
1277         efi_status_t (EFIAPI *receive)(struct efi_simple_network *this,
1278                         size_t *header_size, size_t *buffer_size, void *buffer,
1279                         struct efi_mac_address *src_addr,
1280                         struct efi_mac_address *dest_addr, u16 *protocol);
1281         struct efi_event *wait_for_packet;
1282         struct efi_simple_network_mode *mode;
1283 };
1284
1285 #define EFI_PXE_BASE_CODE_PROTOCOL_GUID \
1286         EFI_GUID(0x03c4e603, 0xac28, 0x11d3, \
1287                  0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
1288
1289 struct efi_pxe_packet {
1290         u8 packet[1472];
1291 };
1292
1293 struct efi_pxe_mode {
1294         u8 started;
1295         u8 ipv6_available;
1296         u8 ipv6_supported;
1297         u8 using_ipv6;
1298         u8 bis_supported;
1299         u8 bis_detected;
1300         u8 auto_arp;
1301         u8 send_guid;
1302         u8 dhcp_discover_valid;
1303         u8 dhcp_ack_received;
1304         u8 proxy_offer_received;
1305         u8 pxe_discover_valid;
1306         u8 pxe_reply_received;
1307         u8 pxe_bis_reply_received;
1308         u8 icmp_error_received;
1309         u8 tftp_error_received;
1310         u8 make_callbacks;
1311         u8 ttl;
1312         u8 tos;
1313         u8 pad;
1314         struct efi_ip_address station_ip;
1315         struct efi_ip_address subnet_mask;
1316         struct efi_pxe_packet dhcp_discover;
1317         struct efi_pxe_packet dhcp_ack;
1318         struct efi_pxe_packet proxy_offer;
1319         struct efi_pxe_packet pxe_discover;
1320         struct efi_pxe_packet pxe_reply;
1321 };
1322
1323 struct efi_pxe {
1324         u64 rev;
1325         void (EFIAPI *start)(void);
1326         void (EFIAPI *stop)(void);
1327         void (EFIAPI *dhcp)(void);
1328         void (EFIAPI *discover)(void);
1329         void (EFIAPI *mftp)(void);
1330         void (EFIAPI *udpwrite)(void);
1331         void (EFIAPI *udpread)(void);
1332         void (EFIAPI *setipfilter)(void);
1333         void (EFIAPI *arp)(void);
1334         void (EFIAPI *setparams)(void);
1335         void (EFIAPI *setstationip)(void);
1336         void (EFIAPI *setpackets)(void);
1337         struct efi_pxe_mode *mode;
1338 };
1339
1340 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID \
1341         EFI_GUID(0x964e5b22, 0x6459, 0x11d2, \
1342                  0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
1343 #define EFI_FILE_PROTOCOL_REVISION      0x00010000
1344 #define EFI_FILE_PROTOCOL_REVISION2     0x00020000
1345 #define EFI_FILE_PROTOCOL_LATEST_REVISION EFI_FILE_PROTOCOL_REVISION2
1346
1347 struct efi_file_handle {
1348         u64 rev;
1349         efi_status_t (EFIAPI *open)(struct efi_file_handle *file,
1350                         struct efi_file_handle **new_handle,
1351                         u16 *file_name, u64 open_mode, u64 attributes);
1352         efi_status_t (EFIAPI *close)(struct efi_file_handle *file);
1353         efi_status_t (EFIAPI *delete)(struct efi_file_handle *file);
1354         efi_status_t (EFIAPI *read)(struct efi_file_handle *file,
1355                         efi_uintn_t *buffer_size, void *buffer);
1356         efi_status_t (EFIAPI *write)(struct efi_file_handle *file,
1357                         efi_uintn_t *buffer_size, void *buffer);
1358         efi_status_t (EFIAPI *getpos)(struct efi_file_handle *file,
1359                                       u64 *pos);
1360         efi_status_t (EFIAPI *setpos)(struct efi_file_handle *file,
1361                                       u64 pos);
1362         efi_status_t (EFIAPI *getinfo)(struct efi_file_handle *file,
1363                         const efi_guid_t *info_type, efi_uintn_t *buffer_size,
1364                         void *buffer);
1365         efi_status_t (EFIAPI *setinfo)(struct efi_file_handle *file,
1366                         const efi_guid_t *info_type, efi_uintn_t buffer_size,
1367                         void *buffer);
1368         efi_status_t (EFIAPI *flush)(struct efi_file_handle *file);
1369         /*
1370          * TODO: We currently only support EFI file protocol revision 0x00010000
1371          *       while UEFI specs 2.4 - 2.7 prescribe revision 0x00020000.
1372          */
1373 };
1374
1375 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION 0x00010000
1376
1377 struct efi_simple_file_system_protocol {
1378         u64 rev;
1379         efi_status_t (EFIAPI *open_volume)(struct efi_simple_file_system_protocol *this,
1380                         struct efi_file_handle **root);
1381 };
1382
1383 #define EFI_FILE_INFO_GUID \
1384         EFI_GUID(0x9576e92, 0x6d3f, 0x11d2, \
1385                  0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
1386
1387 #define EFI_FILE_SYSTEM_INFO_GUID \
1388         EFI_GUID(0x09576e93, 0x6d3f, 0x11d2, \
1389                  0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
1390
1391 #define EFI_FILE_MODE_READ      0x0000000000000001
1392 #define EFI_FILE_MODE_WRITE     0x0000000000000002
1393 #define EFI_FILE_MODE_CREATE    0x8000000000000000
1394
1395 #define EFI_FILE_READ_ONLY      0x0000000000000001
1396 #define EFI_FILE_HIDDEN         0x0000000000000002
1397 #define EFI_FILE_SYSTEM         0x0000000000000004
1398 #define EFI_FILE_RESERVED       0x0000000000000008
1399 #define EFI_FILE_DIRECTORY      0x0000000000000010
1400 #define EFI_FILE_ARCHIVE        0x0000000000000020
1401 #define EFI_FILE_VALID_ATTR     0x0000000000000037
1402
1403 struct efi_file_info {
1404         u64 size;
1405         u64 file_size;
1406         u64 physical_size;
1407         struct efi_time create_time;
1408         struct efi_time last_access_time;
1409         struct efi_time modification_time;
1410         u64 attribute;
1411         u16 file_name[0];
1412 };
1413
1414 struct efi_file_system_info {
1415         u64 size;
1416         u8 read_only;
1417         u64 volume_size;
1418         u64 free_space;
1419         u32 block_size;
1420         u16 volume_label[0];
1421 };
1422
1423 #define EFI_DRIVER_BINDING_PROTOCOL_GUID \
1424         EFI_GUID(0x18a031ab, 0xb443, 0x4d1a,\
1425                  0xa5, 0xc0, 0x0c, 0x09, 0x26, 0x1e, 0x9f, 0x71)
1426 struct efi_driver_binding_protocol {
1427         efi_status_t (EFIAPI * supported)(
1428                         struct efi_driver_binding_protocol *this,
1429                         efi_handle_t controller_handle,
1430                         struct efi_device_path *remaining_device_path);
1431         efi_status_t (EFIAPI * start)(
1432                         struct efi_driver_binding_protocol *this,
1433                         efi_handle_t controller_handle,
1434                         struct efi_device_path *remaining_device_path);
1435         efi_status_t (EFIAPI * stop)(
1436                         struct efi_driver_binding_protocol *this,
1437                         efi_handle_t controller_handle,
1438                         efi_uintn_t number_of_children,
1439                         efi_handle_t *child_handle_buffer);
1440         u32 version;
1441         efi_handle_t image_handle;
1442         efi_handle_t driver_binding_handle;
1443 };
1444
1445 /* Deprecated version of the Unicode collation protocol */
1446 #define EFI_UNICODE_COLLATION_PROTOCOL_GUID \
1447         EFI_GUID(0x1d85cd7f, 0xf43d, 0x11d2, \
1448                  0x9a, 0x0c, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
1449 /* Current version of the Unicode collation protocol */
1450 #define EFI_UNICODE_COLLATION_PROTOCOL2_GUID \
1451         EFI_GUID(0xa4c751fc, 0x23ae, 0x4c3e, \
1452                  0x92, 0xe9, 0x49, 0x64, 0xcf, 0x63, 0xf3, 0x49)
1453 struct efi_unicode_collation_protocol {
1454         efi_intn_t (EFIAPI *stri_coll)(
1455                 struct efi_unicode_collation_protocol *this, u16 *s1, u16 *s2);
1456         bool (EFIAPI *metai_match)(struct efi_unicode_collation_protocol *this,
1457                                    const u16 *string, const u16 *patter);
1458         void (EFIAPI *str_lwr)(struct efi_unicode_collation_protocol
1459                                *this, u16 *string);
1460         void (EFIAPI *str_upr)(struct efi_unicode_collation_protocol *this,
1461                                u16 *string);
1462         void (EFIAPI *fat_to_str)(struct efi_unicode_collation_protocol *this,
1463                                   efi_uintn_t fat_size, char *fat, u16 *string);
1464         bool (EFIAPI *str_to_fat)(struct efi_unicode_collation_protocol *this,
1465                                   const u16 *string, efi_uintn_t fat_size,
1466                                   char *fat);
1467         char *supported_languages;
1468 };
1469
1470 /* Boot manager load options */
1471 #define LOAD_OPTION_ACTIVE              0x00000001
1472 #define LOAD_OPTION_FORCE_RECONNECT     0x00000002
1473 #define LOAD_OPTION_HIDDEN              0x00000008
1474 /* All values 0x00000200-0x00001F00 are reserved */
1475 #define LOAD_OPTION_CATEGORY            0x00001F00
1476 #define LOAD_OPTION_CATEGORY_BOOT       0x00000000
1477 #define LOAD_OPTION_CATEGORY_APP        0x00000100
1478
1479 #endif