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