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