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