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