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