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