include/efi_api.h

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