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