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