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