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