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