include/efi_api.h

   1 /*
   2  * Extensible Firmware Interface
   3  * Based on 'Extensible Firmware Interface Specification' version 0.9,
   4  * April 30, 1999
   5  *
   6  * Copyright (C) 1999 VA Linux Systems
   7  * Copyright (C) 1999 Walt Drummond <drummond@valinux.com>
   8  * Copyright (C) 1999, 2002-2003 Hewlett-Packard Co.
   9  *      David Mosberger-Tang <davidm@hpl.hp.com>
  10  *      Stephane Eranian <eranian@hpl.hp.com>
  11  *
  12  * From include/linux/efi.h in kernel 4.1 with some additions/subtractions
  13  */
  14
  15 #ifndef _EFI_API_H
  16 #define _EFI_API_H
  17
  18 #include <efi.h>
  19
  20 #ifdef CONFIG_EFI_LOADER
  21 #include <asm/setjmp.h>
  22 #endif
  23
  24 /* UEFI spec version 2.7 */
  25 #define EFI_SPECIFICATION_VERSION (2 << 16 | 70)
  26
  27 /* Types and defines for EFI CreateEvent */
  28 enum efi_timer_delay {
  29         EFI_TIMER_STOP = 0,
  30         EFI_TIMER_PERIODIC = 1,
  31         EFI_TIMER_RELATIVE = 2
  32 };
  33
  34 #define efi_intn_t ssize_t
  35 #define efi_uintn_t size_t
  36 typedef uint16_t *efi_string_t;
  37
  38 #define EVT_TIMER                               0x80000000
  39 #define EVT_RUNTIME                             0x40000000
  40 #define EVT_NOTIFY_WAIT                         0x00000100
  41 #define EVT_NOTIFY_SIGNAL                       0x00000200
  42 #define EVT_SIGNAL_EXIT_BOOT_SERVICES           0x00000201
  43 #define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE       0x60000202
  44
  45 #define TPL_APPLICATION         0x04
  46 #define TPL_CALLBACK            0x08
  47 #define TPL_NOTIFY              0x10
  48 #define TPL_HIGH_LEVEL          0x1F
  49
  50 struct efi_event;
  51
  52 /* EFI Boot Services table */
  53 #define EFI_BOOT_SERVICES_SIGNATURE 0x56524553544f4f42
  54 struct efi_boot_services {
  55         struct efi_table_hdr hdr;
  56         efi_status_t (EFIAPI *raise_tpl)(efi_uintn_t new_tpl);
  57         void (EFIAPI *restore_tpl)(efi_uintn_t old_tpl);
  58
  59         efi_status_t (EFIAPI *allocate_pages)(int, int, efi_uintn_t,
  60                                               efi_physical_addr_t *);
  61         efi_status_t (EFIAPI *free_pages)(efi_physical_addr_t, efi_uintn_t);
  62         efi_status_t (EFIAPI *get_memory_map)(efi_uintn_t *memory_map_size,
  63                                               struct efi_mem_desc *desc,
  64                                               efi_uintn_t *key,
  65                                               efi_uintn_t *desc_size,
  66                                               u32 *desc_version);
  67         efi_status_t (EFIAPI *allocate_pool)(int, efi_uintn_t, void **);
  68         efi_status_t (EFIAPI *free_pool)(void *);
  69
  70         efi_status_t (EFIAPI *create_event)(uint32_t type,
  71                         efi_uintn_t notify_tpl,
  72                         void (EFIAPI *notify_function) (
  73                                         struct efi_event *event,
  74                                         void *context),
  75                         void *notify_context, struct efi_event **event);
  76         efi_status_t (EFIAPI *set_timer)(struct efi_event *event,
  77                                          enum efi_timer_delay type,
  78                                          uint64_t trigger_time);
  79         efi_status_t (EFIAPI *wait_for_event)(efi_uintn_t number_of_events,
  80                                               struct efi_event **event,
  81                                               efi_uintn_t *index);
  82         efi_status_t (EFIAPI *signal_event)(struct efi_event *event);
  83         efi_status_t (EFIAPI *close_event)(struct efi_event *event);
  84         efi_status_t (EFIAPI *check_event)(struct efi_event *event);
  85 #define EFI_NATIVE_INTERFACE    0x00000000
  86         efi_status_t (EFIAPI *install_protocol_interface)(
  87                         void **handle, const efi_guid_t *protocol,
  88                         int protocol_interface_type, void *protocol_interface);
  89         efi_status_t (EFIAPI *reinstall_protocol_interface)(
  90                         void *handle, const efi_guid_t *protocol,
  91                         void *old_interface, void *new_interface);
  92         efi_status_t (EFIAPI *uninstall_protocol_interface)(
  93                         efi_handle_t handle, const efi_guid_t *protocol,
  94                         void *protocol_interface);
  95         efi_status_t (EFIAPI *handle_protocol)(
  96                         efi_handle_t handle, const efi_guid_t *protocol,
  97                         void **protocol_interface);
  98         void *reserved;
  99         efi_status_t (EFIAPI *register_protocol_notify)(
 100                         const efi_guid_t *protocol, struct efi_event *event,
 101                         void **registration);
 102         efi_status_t (EFIAPI *locate_handle)(
 103                         enum efi_locate_search_type search_type,
 104                         const efi_guid_t *protocol, void *search_key,
 105                         efi_uintn_t *buffer_size, efi_handle_t *buffer);
 106         efi_status_t (EFIAPI *locate_device_path)(const efi_guid_t *protocol,
 107                         struct efi_device_path **device_path,
 108                         efi_handle_t *device);
 109         efi_status_t (EFIAPI *install_configuration_table)(
 110                         efi_guid_t *guid, void *table);
 111
 112         efi_status_t (EFIAPI *load_image)(bool boot_policiy,
 113                         efi_handle_t parent_image,
 114                         struct efi_device_path *file_path, void *source_buffer,
 115                         efi_uintn_t source_size, efi_handle_t *image);
 116         efi_status_t (EFIAPI *start_image)(efi_handle_t handle,
 117                                            unsigned long *exitdata_size,
 118                                            s16 **exitdata);
 119         efi_status_t (EFIAPI *exit)(efi_handle_t handle,
 120                                     efi_status_t exit_status,
 121                                     unsigned long exitdata_size, s16 *exitdata);
 122         efi_status_t (EFIAPI *unload_image)(efi_handle_t image_handle);
 123         efi_status_t (EFIAPI *exit_boot_services)(efi_handle_t, unsigned long);
 124
 125         efi_status_t (EFIAPI *get_next_monotonic_count)(u64 *count);
 126         efi_status_t (EFIAPI *stall)(unsigned long usecs);
 127         efi_status_t (EFIAPI *set_watchdog_timer)(unsigned long timeout,
 128                         uint64_t watchdog_code, unsigned long data_size,
 129                         uint16_t *watchdog_data);
 130         efi_status_t(EFIAPI *connect_controller)(efi_handle_t controller_handle,
 131                         efi_handle_t *driver_image_handle,
 132                         struct efi_device_path *remaining_device_path,
 133                         bool recursive);
 134         efi_status_t (EFIAPI *disconnect_controller)(
 135                         efi_handle_t controller_handle,
 136                         efi_handle_t driver_image_handle,
 137                         efi_handle_t child_handle);
 138 #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL  0x00000001
 139 #define EFI_OPEN_PROTOCOL_GET_PROTOCOL        0x00000002
 140 #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL       0x00000004
 141 #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008
 142 #define EFI_OPEN_PROTOCOL_BY_DRIVER           0x00000010
 143 #define EFI_OPEN_PROTOCOL_EXCLUSIVE           0x00000020
 144         efi_status_t (EFIAPI *open_protocol)(efi_handle_t handle,
 145                         const efi_guid_t *protocol, void **interface,
 146                         efi_handle_t agent_handle,
 147                         efi_handle_t controller_handle, u32 attributes);
 148         efi_status_t (EFIAPI *close_protocol)(
 149                         efi_handle_t handle, const efi_guid_t *protocol,
 150                         efi_handle_t agent_handle,
 151                         efi_handle_t controller_handle);
 152         efi_status_t(EFIAPI *open_protocol_information)(efi_handle_t handle,
 153                         const efi_guid_t *protocol,
 154                         struct efi_open_protocol_info_entry **entry_buffer,
 155                         efi_uintn_t *entry_count);
 156         efi_status_t (EFIAPI *protocols_per_handle)(efi_handle_t handle,
 157                         efi_guid_t ***protocol_buffer,
 158                         efi_uintn_t *protocols_buffer_count);
 159         efi_status_t (EFIAPI *locate_handle_buffer) (
 160                         enum efi_locate_search_type search_type,
 161                         const efi_guid_t *protocol, void *search_key,
 162                         efi_uintn_t *no_handles, efi_handle_t **buffer);
 163         efi_status_t (EFIAPI *locate_protocol)(const efi_guid_t *protocol,
 164                         void *registration, void **protocol_interface);
 165         efi_status_t (EFIAPI *install_multiple_protocol_interfaces)(
 166                         void **handle, ...);
 167         efi_status_t (EFIAPI *uninstall_multiple_protocol_interfaces)(
 168                         void *handle, ...);
 169         efi_status_t (EFIAPI *calculate_crc32)(const void *data,
 170                                                efi_uintn_t data_size,
 171                                                u32 *crc32);
 172         void (EFIAPI *copy_mem)(void *destination, const void *source,
 173                         size_t length);
 174         void (EFIAPI *set_mem)(void *buffer, size_t size, uint8_t value);
 175         efi_status_t (EFIAPI *create_event_ex)(
 176                                 uint32_t type, efi_uintn_t notify_tpl,
 177                                 void (EFIAPI *notify_function) (
 178                                         struct efi_event *event,
 179                                         void *context),
 180                                 void *notify_context,
 181                                 efi_guid_t *event_group,
 182                                 struct efi_event **event);
 183 };
 184
 185 /* Types and defines for EFI ResetSystem */
 186 enum efi_reset_type {
 187         EFI_RESET_COLD = 0,
 188         EFI_RESET_WARM = 1,
 189         EFI_RESET_SHUTDOWN = 2,
 190         EFI_RESET_PLATFORM_SPECIFIC = 3,
 191 };
 192
 193 /* EFI Runtime Services table */
 194 #define EFI_RUNTIME_SERVICES_SIGNATURE  0x56524553544e5552ULL
 195
 196 #define CAPSULE_FLAGS_PERSIST_ACROSS_RESET      0x00010000
 197 #define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE     0x00020000
 198 #define CAPSULE_FLAGS_INITIATE_RESET            0x00040000
 199
 200 struct efi_capsule_header {
 201         efi_guid_t *capsule_guid;
 202         u32 header_size;
 203         u32 flags;
 204         u32 capsule_image_size;
 205 };
 206
 207 struct efi_runtime_services {
 208         struct efi_table_hdr hdr;
 209         efi_status_t (EFIAPI *get_time)(struct efi_time *time,
 210                         struct efi_time_cap *capabilities);
 211         efi_status_t (EFIAPI *set_time)(struct efi_time *time);
 212         efi_status_t (EFIAPI *get_wakeup_time)(char *enabled, char *pending,
 213                         struct efi_time *time);
 214         efi_status_t (EFIAPI *set_wakeup_time)(char enabled,
 215                         struct efi_time *time);
 216         efi_status_t (EFIAPI *set_virtual_address_map)(
 217                         unsigned long memory_map_size,
 218                         unsigned long descriptor_size,
 219                         uint32_t descriptor_version,
 220                         struct efi_mem_desc *virtmap);
 221         efi_status_t (*convert_pointer)(unsigned long dbg, void **address);
 222         efi_status_t (EFIAPI *get_variable)(u16 *variable_name,
 223                                             efi_guid_t *vendor, u32 *attributes,
 224                                             efi_uintn_t *data_size, void *data);
 225         efi_status_t (EFIAPI *get_next_variable_name)(
 226                         efi_uintn_t *variable_name_size,
 227                         u16 *variable_name, efi_guid_t *vendor);
 228         efi_status_t (EFIAPI *set_variable)(u16 *variable_name,
 229                                             efi_guid_t *vendor, u32 attributes,
 230                                             efi_uintn_t data_size, void *data);
 231         efi_status_t (EFIAPI *get_next_high_mono_count)(
 232                         uint32_t *high_count);
 233         void (EFIAPI *reset_system)(enum efi_reset_type reset_type,
 234                                     efi_status_t reset_status,
 235                                     unsigned long data_size, void *reset_data);
 236         efi_status_t (EFIAPI *update_capsule)(
 237                         struct efi_capsule_header **capsule_header_array,
 238                         efi_uintn_t capsule_count,
 239                         u64 scatter_gather_list);
 240         efi_status_t (EFIAPI *query_capsule_caps)(
 241                         struct efi_capsule_header **capsule_header_array,
 242                         efi_uintn_t capsule_count,
 243                         u64 maximum_capsule_size,
 244                         u32 reset_type);
 245         efi_status_t (EFIAPI *query_variable_info)(
 246                         u32 attributes,
 247                         u64 *maximum_variable_storage_size,
 248                         u64 *remaining_variable_storage_size,
 249                         u64 *maximum_variable_size);
 250 };
 251
 252 /* EFI event group GUID definitions */
 253 #define EFI_EVENT_GROUP_EXIT_BOOT_SERVICES \
 254         EFI_GUID(0x27abf055, 0xb1b8, 0x4c26, 0x80, 0x48, \
 255                  0x74, 0x8f, 0x37, 0xba, 0xa2, 0xdf)
 256
 257 #define EFI_EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE \
 258         EFI_GUID(0x13fa7698, 0xc831, 0x49c7, 0x87, 0xea, \
 259                  0x8f, 0x43, 0xfc, 0xc2, 0x51, 0x96)
 260
 261 #define EFI_EVENT_GROUP_MEMORY_MAP_CHANGE \
 262         EFI_GUID(0x78bee926, 0x692f, 0x48fd, 0x9e, 0xdb, \
 263                  0x01, 0x42, 0x2e, 0xf0, 0xd7, 0xab)
 264
 265 #define EFI_EVENT_GROUP_READY_TO_BOOT \
 266         EFI_GUID(0x7ce88fb3, 0x4bd7, 0x4679, 0x87, 0xa8, \
 267                  0xa8, 0xd8, 0xde, 0xe5, 0x0d, 0x2b)
 268
 269 #define EFI_EVENT_GROUP_RESET_SYSTEM \
 270         EFI_GUID(0x62da6a56, 0x13fb, 0x485a, 0xa8, 0xda, \
 271                  0xa3, 0xdd, 0x79, 0x12, 0xcb, 0x6b)
 272
 273 /* EFI Configuration Table and GUID definitions */
 274 #define NULL_GUID \
 275         EFI_GUID(0x00000000, 0x0000, 0x0000, 0x00, 0x00, \
 276                  0x00, 0x00, 0x00, 0x00, 0x00, 0x00)
 277
 278 #define EFI_GLOBAL_VARIABLE_GUID \
 279         EFI_GUID(0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, \
 280                  0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c)
 281
 282 #define LOADED_IMAGE_PROTOCOL_GUID \
 283         EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, \
 284                  0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 285
 286 #define EFI_FDT_GUID \
 287         EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5, \
 288                  0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0)
 289
 290 #define EFI_ACPI_TABLE_GUID \
 291         EFI_GUID(0x8868e871, 0xe4f1, 0x11d3, \
 292                  0xbc, 0x22, 0x00, 0x80, 0xc7, 0x3c, 0x88, 0x81)
 293
 294 #define SMBIOS_TABLE_GUID \
 295         EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3,  \
 296                  0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
 297
 298 struct efi_configuration_table
 299 {
 300         efi_guid_t guid;
 301         void *table;
 302 };
 303
 304 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
 305
 306 struct efi_system_table {
 307         struct efi_table_hdr hdr;
 308         u16 *fw_vendor;   /* physical addr of wchar_t vendor string */
 309         u32 fw_revision;
 310         efi_handle_t con_in_handle;
 311         struct efi_simple_input_interface *con_in;
 312         efi_handle_t con_out_handle;
 313         struct efi_simple_text_output_protocol *con_out;
 314         efi_handle_t stderr_handle;
 315         struct efi_simple_text_output_protocol *std_err;
 316         struct efi_runtime_services *runtime;
 317         struct efi_boot_services *boottime;
 318         efi_uintn_t nr_tables;
 319         struct efi_configuration_table *tables;
 320 };
 321
 322 #define LOADED_IMAGE_GUID \
 323         EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, \
 324                  0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 325
 326 #define EFI_LOADED_IMAGE_PROTOCOL_REVISION 0x1000
 327
 328 struct efi_loaded_image {
 329         u32 revision;
 330         void *parent_handle;
 331         struct efi_system_table *system_table;
 332         efi_handle_t device_handle;
 333         struct efi_device_path *file_path;
 334         void *reserved;
 335         u32 load_options_size;
 336         void *load_options;
 337         void *image_base;
 338         aligned_u64 image_size;
 339         unsigned int image_code_type;
 340         unsigned int image_data_type;
 341         unsigned long unload;
 342
 343         /* Below are efi loader private fields */
 344 #ifdef CONFIG_EFI_LOADER
 345         void *reloc_base;
 346         aligned_u64 reloc_size;
 347         efi_status_t exit_status;
 348         struct jmp_buf_data exit_jmp;
 349 #endif
 350 };
 351
 352 #define DEVICE_PATH_GUID \
 353         EFI_GUID(0x09576e91, 0x6d3f, 0x11d2, \
 354                  0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
 355
 356 #define DEVICE_PATH_TYPE_END                    0x7f
 357 #  define DEVICE_PATH_SUB_TYPE_INSTANCE_END     0x01
 358 #  define DEVICE_PATH_SUB_TYPE_END              0xff
 359
 360 struct efi_device_path {
 361         u8 type;
 362         u8 sub_type;
 363         u16 length;
 364 } __packed;
 365
 366 struct efi_mac_addr {
 367         u8 addr[32];
 368 } __packed;
 369
 370 #define DEVICE_PATH_TYPE_HARDWARE_DEVICE        0x01
 371 #  define DEVICE_PATH_SUB_TYPE_MEMORY           0x03
 372 #  define DEVICE_PATH_SUB_TYPE_VENDOR           0x04
 373
 374 struct efi_device_path_memory {
 375         struct efi_device_path dp;
 376         u32 memory_type;
 377         u64 start_address;
 378         u64 end_address;
 379 } __packed;
 380
 381 struct efi_device_path_vendor {
 382         struct efi_device_path dp;
 383         efi_guid_t guid;
 384         u8 vendor_data[];
 385 } __packed;
 386
 387 #define DEVICE_PATH_TYPE_ACPI_DEVICE            0x02
 388 #  define DEVICE_PATH_SUB_TYPE_ACPI_DEVICE      0x01
 389
 390 #define EFI_PNP_ID(ID)                          (u32)(((ID) << 16) | 0x41D0)
 391 #define EISA_PNP_ID(ID)                         EFI_PNP_ID(ID)
 392 #define EISA_PNP_NUM(ID)                        ((ID) >> 16)
 393
 394 struct efi_device_path_acpi_path {
 395         struct efi_device_path dp;
 396         u32 hid;
 397         u32 uid;
 398 } __packed;
 399
 400 #define DEVICE_PATH_TYPE_MESSAGING_DEVICE       0x03
 401 #  define DEVICE_PATH_SUB_TYPE_MSG_ATAPI        0x01
 402 #  define DEVICE_PATH_SUB_TYPE_MSG_SCSI         0x02
 403 #  define DEVICE_PATH_SUB_TYPE_MSG_USB          0x05
 404 #  define DEVICE_PATH_SUB_TYPE_MSG_MAC_ADDR     0x0b
 405 #  define DEVICE_PATH_SUB_TYPE_MSG_USB_CLASS    0x0f
 406 #  define DEVICE_PATH_SUB_TYPE_MSG_SD           0x1a
 407 #  define DEVICE_PATH_SUB_TYPE_MSG_MMC          0x1d
 408
 409 struct efi_device_path_atapi {
 410         struct efi_device_path dp;
 411         u8 primary_secondary;
 412         u8 slave_master;
 413         u16 logical_unit_number;
 414 } __packed;
 415
 416 struct efi_device_path_scsi {
 417         struct efi_device_path dp;
 418         u16 target_id;
 419         u16 logical_unit_number;
 420 } __packed;
 421
 422 struct efi_device_path_usb {
 423         struct efi_device_path dp;
 424         u8 parent_port_number;
 425         u8 usb_interface;
 426 } __packed;
 427
 428 struct efi_device_path_mac_addr {
 429         struct efi_device_path dp;
 430         struct efi_mac_addr mac;
 431         u8 if_type;
 432 } __packed;
 433
 434 struct efi_device_path_usb_class {
 435         struct efi_device_path dp;
 436         u16 vendor_id;
 437         u16 product_id;
 438         u8 device_class;
 439         u8 device_subclass;
 440         u8 device_protocol;
 441 } __packed;
 442
 443 struct efi_device_path_sd_mmc_path {
 444         struct efi_device_path dp;
 445         u8 slot_number;
 446 } __packed;
 447
 448 #define DEVICE_PATH_TYPE_MEDIA_DEVICE           0x04
 449 #  define DEVICE_PATH_SUB_TYPE_HARD_DRIVE_PATH  0x01
 450 #  define DEVICE_PATH_SUB_TYPE_CDROM_PATH       0x02
 451 #  define DEVICE_PATH_SUB_TYPE_FILE_PATH        0x04
 452
 453 struct efi_device_path_hard_drive_path {
 454         struct efi_device_path dp;
 455         u32 partition_number;
 456         u64 partition_start;
 457         u64 partition_end;
 458         u8 partition_signature[16];
 459         u8 partmap_type;
 460         u8 signature_type;
 461 } __packed;
 462
 463 struct efi_device_path_cdrom_path {
 464         struct efi_device_path dp;
 465         u32 boot_entry;
 466         u64 partition_start;
 467         u64 partition_end;
 468 } __packed;
 469
 470 struct efi_device_path_file_path {
 471         struct efi_device_path dp;
 472         u16 str[];
 473 } __packed;
 474
 475 #define BLOCK_IO_GUID \
 476         EFI_GUID(0x964e5b21, 0x6459, 0x11d2, \
 477                  0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 478
 479 struct efi_block_io_media
 480 {
 481         u32 media_id;
 482         char removable_media;
 483         char media_present;
 484         char logical_partition;
 485         char read_only;
 486         char write_caching;
 487         u8 pad[3];
 488         u32 block_size;
 489         u32 io_align;
 490         u8 pad2[4];
 491         u64 last_block;
 492         /* Added in revision 2 of the protocol */
 493         u64 lowest_aligned_lba;
 494         u32 logical_blocks_per_physical_block;
 495         /* Added in revision 3 of the protocol */
 496         u32 optimal_transfer_length_granualarity;
 497 };
 498
 499 #define EFI_BLOCK_IO_PROTOCOL_REVISION2 0x00020001
 500 #define EFI_BLOCK_IO_PROTOCOL_REVISION3 0x0002001f
 501
 502 struct efi_block_io {
 503         u64 revision;
 504         struct efi_block_io_media *media;
 505         efi_status_t (EFIAPI *reset)(struct efi_block_io *this,
 506                         char extended_verification);
 507         efi_status_t (EFIAPI *read_blocks)(struct efi_block_io *this,
 508                         u32 media_id, u64 lba, efi_uintn_t buffer_size,
 509                         void *buffer);
 510         efi_status_t (EFIAPI *write_blocks)(struct efi_block_io *this,
 511                         u32 media_id, u64 lba, efi_uintn_t buffer_size,
 512                         void *buffer);
 513         efi_status_t (EFIAPI *flush_blocks)(struct efi_block_io *this);
 514 };
 515
 516 struct simple_text_output_mode {
 517         s32 max_mode;
 518         s32 mode;
 519         s32 attribute;
 520         s32 cursor_column;
 521         s32 cursor_row;
 522         bool cursor_visible;
 523 };
 524
 525
 526 #define EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID \
 527         EFI_GUID(0x387477c2, 0x69c7, 0x11d2, \
 528                  0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 529
 530 #define EFI_BLACK                0x00
 531 #define EFI_BLUE                 0x01
 532 #define EFI_GREEN                0x02
 533 #define EFI_CYAN                 0x03
 534 #define EFI_RED                  0x04
 535 #define EFI_MAGENTA              0x05
 536 #define EFI_BROWN                0x06
 537 #define EFI_LIGHTGRAY            0x07
 538 #define EFI_BRIGHT               0x08
 539 #define EFI_DARKGRAY             0x08
 540 #define EFI_LIGHTBLUE            0x09
 541 #define EFI_LIGHTGREEN           0x0a
 542 #define EFI_LIGHTCYAN            0x0b
 543 #define EFI_LIGHTRED             0x0c
 544 #define EFI_LIGHTMAGENTA         0x0d
 545 #define EFI_YELLOW               0x0e
 546 #define EFI_WHITE                0x0f
 547 #define EFI_BACKGROUND_BLACK     0x00
 548 #define EFI_BACKGROUND_BLUE      0x10
 549 #define EFI_BACKGROUND_GREEN     0x20
 550 #define EFI_BACKGROUND_CYAN      0x30
 551 #define EFI_BACKGROUND_RED       0x40
 552 #define EFI_BACKGROUND_MAGENTA   0x50
 553 #define EFI_BACKGROUND_BROWN     0x60
 554 #define EFI_BACKGROUND_LIGHTGRAY 0x70
 555
 556 /* extract foreground color from EFI attribute */
 557 #define EFI_ATTR_FG(attr)        ((attr) & 0x07)
 558 /* treat high bit of FG as bright/bold (similar to edk2) */
 559 #define EFI_ATTR_BOLD(attr)      (((attr) >> 3) & 0x01)
 560 /* extract background color from EFI attribute */
 561 #define EFI_ATTR_BG(attr)        (((attr) >> 4) & 0x7)
 562
 563 struct efi_simple_text_output_protocol {
 564         void *reset;
 565         efi_status_t (EFIAPI *output_string)(
 566                         struct efi_simple_text_output_protocol *this,
 567                         const efi_string_t str);
 568         efi_status_t (EFIAPI *test_string)(
 569                         struct efi_simple_text_output_protocol *this,
 570                         const efi_string_t str);
 571         efi_status_t(EFIAPI *query_mode)(
 572                         struct efi_simple_text_output_protocol *this,
 573                         unsigned long mode_number, unsigned long *columns,
 574                         unsigned long *rows);
 575         efi_status_t(EFIAPI *set_mode)(
 576                         struct efi_simple_text_output_protocol *this,
 577                         unsigned long mode_number);
 578         efi_status_t(EFIAPI *set_attribute)(
 579                         struct efi_simple_text_output_protocol *this,
 580                         unsigned long attribute);
 581         efi_status_t(EFIAPI *clear_screen) (
 582                         struct efi_simple_text_output_protocol *this);
 583         efi_status_t(EFIAPI *set_cursor_position) (
 584                         struct efi_simple_text_output_protocol *this,
 585                         unsigned long column, unsigned long row);
 586         efi_status_t(EFIAPI *enable_cursor)(
 587                         struct efi_simple_text_output_protocol *this,
 588                         bool enable);
 589         struct simple_text_output_mode *mode;
 590 };
 591
 592 struct efi_input_key {
 593         u16 scan_code;
 594         s16 unicode_char;
 595 };
 596
 597 #define EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID \
 598         EFI_GUID(0x387477c1, 0x69c7, 0x11d2, \
 599                  0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 600
 601 struct efi_simple_input_interface {
 602         efi_status_t(EFIAPI *reset)(struct efi_simple_input_interface *this,
 603                         bool ExtendedVerification);
 604         efi_status_t(EFIAPI *read_key_stroke)(
 605                         struct efi_simple_input_interface *this,
 606                         struct efi_input_key *key);
 607         struct efi_event *wait_for_key;
 608 };
 609
 610 #define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID \
 611         EFI_GUID(0x8b843e20, 0x8132, 0x4852, \
 612                  0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c)
 613
 614 struct efi_device_path_to_text_protocol
 615 {
 616         uint16_t *(EFIAPI *convert_device_node_to_text)(
 617                         struct efi_device_path *device_node,
 618                         bool display_only,
 619                         bool allow_shortcuts);
 620         uint16_t *(EFIAPI *convert_device_path_to_text)(
 621                         struct efi_device_path *device_path,
 622                         bool display_only,
 623                         bool allow_shortcuts);
 624 };
 625
 626 #define EFI_DEVICE_PATH_UTILITIES_PROTOCOL_GUID \
 627         EFI_GUID(0x0379be4e, 0xd706, 0x437d, \
 628                  0xb0, 0x37, 0xed, 0xb8, 0x2f, 0xb7, 0x72, 0xa4)
 629
 630 struct efi_device_path_utilities_protocol {
 631         efi_uintn_t (EFIAPI *get_device_path_size)(
 632                 const struct efi_device_path *device_path);
 633         struct efi_device_path *(EFIAPI *duplicate_device_path)(
 634                 const struct efi_device_path *device_path);
 635         struct efi_device_path *(EFIAPI *append_device_path)(
 636                 const struct efi_device_path *src1,
 637                 const struct efi_device_path *src2);
 638         struct efi_device_path *(EFIAPI *append_device_node)(
 639                 const struct efi_device_path *device_path,
 640                 const struct efi_device_path *device_node);
 641         struct efi_device_path *(EFIAPI *append_device_path_instance)(
 642                 const struct efi_device_path *device_path,
 643                 const struct efi_device_path *device_path_instance);
 644         struct efi_device_path *(EFIAPI *get_next_device_path_instance)(
 645                 struct efi_device_path **device_path_instance,
 646                 efi_uintn_t *device_path_instance_size);
 647         bool (EFIAPI *is_device_path_multi_instance)(
 648                 const struct efi_device_path *device_path);
 649         struct efi_device_path *(EFIAPI *create_device_node)(
 650                 uint8_t node_type,
 651                 uint8_t node_sub_type,
 652                 uint16_t node_length);
 653 };
 654
 655 #define EFI_GOP_GUID \
 656         EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, \
 657                  0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
 658
 659 #define EFI_GOT_RGBA8           0
 660 #define EFI_GOT_BGRA8           1
 661 #define EFI_GOT_BITMASK         2
 662
 663 struct efi_gop_mode_info
 664 {
 665         u32 version;
 666         u32 width;
 667         u32 height;
 668         u32 pixel_format;
 669         u32 pixel_bitmask[4];
 670         u32 pixels_per_scanline;
 671 };
 672
 673 struct efi_gop_mode
 674 {
 675         u32 max_mode;
 676         u32 mode;
 677         struct efi_gop_mode_info *info;
 678         unsigned long info_size;
 679         efi_physical_addr_t fb_base;
 680         unsigned long fb_size;
 681 };
 682
 683 struct efi_gop_pixel {
 684         u8 blue;
 685         u8 green;
 686         u8 red;
 687         u8 reserved;
 688 };
 689
 690 #define EFI_BLT_VIDEO_FILL              0
 691 #define EFI_BLT_VIDEO_TO_BLT_BUFFER     1
 692 #define EFI_BLT_BUFFER_TO_VIDEO         2
 693 #define EFI_BLT_VIDEO_TO_VIDEO          3
 694
 695 struct efi_gop
 696 {
 697         efi_status_t (EFIAPI *query_mode)(struct efi_gop *this, u32 mode_number,
 698                                           efi_uintn_t *size_of_info,
 699                                           struct efi_gop_mode_info **info);
 700         efi_status_t (EFIAPI *set_mode)(struct efi_gop *this, u32 mode_number);
 701         efi_status_t (EFIAPI *blt)(struct efi_gop *this,
 702                                    struct efi_gop_pixel *buffer,
 703                                    u32 operation, efi_uintn_t sx,
 704                                    efi_uintn_t sy, efi_uintn_t dx,
 705                                    efi_uintn_t dy, efi_uintn_t width,
 706                                    efi_uintn_t height, efi_uintn_t delta);
 707         struct efi_gop_mode *mode;
 708 };
 709
 710 #define EFI_SIMPLE_NETWORK_GUID \
 711         EFI_GUID(0xa19832b9, 0xac25, 0x11d3, \
 712                  0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
 713
 714 struct efi_mac_address {
 715         char mac_addr[32];
 716 };
 717
 718 struct efi_ip_address {
 719         u8 ip_addr[16];
 720 } __attribute__((aligned(4)));
 721
 722 enum efi_simple_network_state {
 723         EFI_NETWORK_STOPPED,
 724         EFI_NETWORK_STARTED,
 725         EFI_NETWORK_INITIALIZED,
 726 };
 727
 728 struct efi_simple_network_mode {
 729         enum efi_simple_network_state state;
 730         u32 hwaddr_size;
 731         u32 media_header_size;
 732         u32 max_packet_size;
 733         u32 nvram_size;
 734         u32 nvram_access_size;
 735         u32 receive_filter_mask;
 736         u32 receive_filter_setting;
 737         u32 max_mcast_filter_count;
 738         u32 mcast_filter_count;
 739         struct efi_mac_address mcast_filter[16];
 740         struct efi_mac_address current_address;
 741         struct efi_mac_address broadcast_address;
 742         struct efi_mac_address permanent_address;
 743         u8 if_type;
 744         u8 mac_changeable;
 745         u8 multitx_supported;
 746         u8 media_present_supported;
 747         u8 media_present;
 748 };
 749
 750 /* receive_filters bit mask */
 751 #define EFI_SIMPLE_NETWORK_RECEIVE_UNICAST               0x01
 752 #define EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST             0x02
 753 #define EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST             0x04
 754 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS           0x08
 755 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST 0x10
 756
 757 /* interrupt status bit mask */
 758 #define EFI_SIMPLE_NETWORK_RECEIVE_INTERRUPT    0x01
 759 #define EFI_SIMPLE_NETWORK_TRANSMIT_INTERRUPT   0x02
 760 #define EFI_SIMPLE_NETWORK_COMMAND_INTERRUPT    0x04
 761 #define EFI_SIMPLE_NETWORK_SOFTWARE_INTERRUPT   0x08
 762
 763 /* revision of the simple network protocol */
 764 #define EFI_SIMPLE_NETWORK_PROTOCOL_REVISION    0x00010000
 765
 766 struct efi_simple_network
 767 {
 768         u64 revision;
 769         efi_status_t (EFIAPI *start)(struct efi_simple_network *this);
 770         efi_status_t (EFIAPI *stop)(struct efi_simple_network *this);
 771         efi_status_t (EFIAPI *initialize)(struct efi_simple_network *this,
 772                         ulong extra_rx, ulong extra_tx);
 773         efi_status_t (EFIAPI *reset)(struct efi_simple_network *this,
 774                         int extended_verification);
 775         efi_status_t (EFIAPI *shutdown)(struct efi_simple_network *this);
 776         efi_status_t (EFIAPI *receive_filters)(struct efi_simple_network *this,
 777                         u32 enable, u32 disable, int reset_mcast_filter,
 778                         ulong mcast_filter_count,
 779                         struct efi_mac_address *mcast_filter);
 780         efi_status_t (EFIAPI *station_address)(struct efi_simple_network *this,
 781                         int reset, struct efi_mac_address *new_mac);
 782         efi_status_t (EFIAPI *statistics)(struct efi_simple_network *this,
 783                         int reset, ulong *stat_size, void *stat_table);
 784         efi_status_t (EFIAPI *mcastiptomac)(struct efi_simple_network *this,
 785                         int ipv6, struct efi_ip_address *ip,
 786                         struct efi_mac_address *mac);
 787         efi_status_t (EFIAPI *nvdata)(struct efi_simple_network *this,
 788                         int read_write, ulong offset, ulong buffer_size,
 789                         char *buffer);
 790         efi_status_t (EFIAPI *get_status)(struct efi_simple_network *this,
 791                         u32 *int_status, void **txbuf);
 792         efi_status_t (EFIAPI *transmit)(struct efi_simple_network *this,
 793                         size_t header_size, size_t buffer_size, void *buffer,
 794                         struct efi_mac_address *src_addr,
 795                         struct efi_mac_address *dest_addr, u16 *protocol);
 796         efi_status_t (EFIAPI *receive)(struct efi_simple_network *this,
 797                         size_t *header_size, size_t *buffer_size, void *buffer,
 798                         struct efi_mac_address *src_addr,
 799                         struct efi_mac_address *dest_addr, u16 *protocol);
 800         struct efi_event *wait_for_packet;
 801         struct efi_simple_network_mode *mode;
 802 };
 803
 804 #define EFI_PXE_GUID \
 805         EFI_GUID(0x03c4e603, 0xac28, 0x11d3, \
 806                  0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
 807
 808 struct efi_pxe_packet {
 809         u8 packet[1472];
 810 };
 811
 812 struct efi_pxe_mode
 813 {
 814         u8 started;
 815         u8 ipv6_available;
 816         u8 ipv6_supported;
 817         u8 using_ipv6;
 818         u8 bis_supported;
 819         u8 bis_detected;
 820         u8 auto_arp;
 821         u8 send_guid;
 822         u8 dhcp_discover_valid;
 823         u8 dhcp_ack_received;
 824         u8 proxy_offer_received;
 825         u8 pxe_discover_valid;
 826         u8 pxe_reply_received;
 827         u8 pxe_bis_reply_received;
 828         u8 icmp_error_received;
 829         u8 tftp_error_received;
 830         u8 make_callbacks;
 831         u8 ttl;
 832         u8 tos;
 833         u8 pad;
 834         struct efi_ip_address station_ip;
 835         struct efi_ip_address subnet_mask;
 836         struct efi_pxe_packet dhcp_discover;
 837         struct efi_pxe_packet dhcp_ack;
 838         struct efi_pxe_packet proxy_offer;
 839         struct efi_pxe_packet pxe_discover;
 840         struct efi_pxe_packet pxe_reply;
 841 };
 842
 843 struct efi_pxe {
 844         u64 rev;
 845         void (EFIAPI *start)(void);
 846         void (EFIAPI *stop)(void);
 847         void (EFIAPI *dhcp)(void);
 848         void (EFIAPI *discover)(void);
 849         void (EFIAPI *mftp)(void);
 850         void (EFIAPI *udpwrite)(void);
 851         void (EFIAPI *udpread)(void);
 852         void (EFIAPI *setipfilter)(void);
 853         void (EFIAPI *arp)(void);
 854         void (EFIAPI *setparams)(void);
 855         void (EFIAPI *setstationip)(void);
 856         void (EFIAPI *setpackets)(void);
 857         struct efi_pxe_mode *mode;
 858 };
 859
 860 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID \
 861         EFI_GUID(0x964e5b22, 0x6459, 0x11d2, \
 862                  0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 863 #define EFI_FILE_PROTOCOL_REVISION 0x00010000
 864
 865 struct efi_file_handle {
 866         u64 rev;
 867         efi_status_t (EFIAPI *open)(struct efi_file_handle *file,
 868                         struct efi_file_handle **new_handle,
 869                         s16 *file_name, u64 open_mode, u64 attributes);
 870         efi_status_t (EFIAPI *close)(struct efi_file_handle *file);
 871         efi_status_t (EFIAPI *delete)(struct efi_file_handle *file);
 872         efi_status_t (EFIAPI *read)(struct efi_file_handle *file,
 873                         efi_uintn_t *buffer_size, void *buffer);
 874         efi_status_t (EFIAPI *write)(struct efi_file_handle *file,
 875                         efi_uintn_t *buffer_size, void *buffer);
 876         efi_status_t (EFIAPI *getpos)(struct efi_file_handle *file,
 877                         efi_uintn_t *pos);
 878         efi_status_t (EFIAPI *setpos)(struct efi_file_handle *file,
 879                         efi_uintn_t pos);
 880         efi_status_t (EFIAPI *getinfo)(struct efi_file_handle *file,
 881                         const efi_guid_t *info_type, efi_uintn_t *buffer_size,
 882                         void *buffer);
 883         efi_status_t (EFIAPI *setinfo)(struct efi_file_handle *file,
 884                         const efi_guid_t *info_type, efi_uintn_t buffer_size,
 885                         void *buffer);
 886         efi_status_t (EFIAPI *flush)(struct efi_file_handle *file);
 887 };
 888
 889 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID \
 890         EFI_GUID(0x964e5b22, 0x6459, 0x11d2, \
 891                  0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 892 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION 0x00010000
 893
 894 struct efi_simple_file_system_protocol {
 895         u64 rev;
 896         efi_status_t (EFIAPI *open_volume)(struct efi_simple_file_system_protocol *this,
 897                         struct efi_file_handle **root);
 898 };
 899
 900 #define EFI_FILE_INFO_GUID \
 901         EFI_GUID(0x9576e92, 0x6d3f, 0x11d2, \
 902                  0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 903
 904 #define EFI_FILE_SYSTEM_INFO_GUID \
 905         EFI_GUID(0x09576e93, 0x6d3f, 0x11d2, \
 906                  0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 907
 908 #define EFI_FILE_MODE_READ      0x0000000000000001
 909 #define EFI_FILE_MODE_WRITE     0x0000000000000002
 910 #define EFI_FILE_MODE_CREATE    0x8000000000000000
 911
 912 #define EFI_FILE_READ_ONLY      0x0000000000000001
 913 #define EFI_FILE_HIDDEN         0x0000000000000002
 914 #define EFI_FILE_SYSTEM         0x0000000000000004
 915 #define EFI_FILE_RESERVED       0x0000000000000008
 916 #define EFI_FILE_DIRECTORY      0x0000000000000010
 917 #define EFI_FILE_ARCHIVE        0x0000000000000020
 918 #define EFI_FILE_VALID_ATTR     0x0000000000000037
 919
 920 struct efi_file_info {
 921         u64 size;
 922         u64 file_size;
 923         u64 physical_size;
 924         struct efi_time create_time;
 925         struct efi_time last_access_time;
 926         struct efi_time modification_time;
 927         u64 attribute;
 928         s16 file_name[0];
 929 };
 930
 931 struct efi_file_system_info {
 932         u64 size;
 933         u8 read_only;
 934         u64 volume_size;
 935         u64 free_space;
 936         u32 block_size;
 937         u16 volume_label[0];
 938 };
 939
 940 #define EFI_DRIVER_BINDING_PROTOCOL_GUID \
 941         EFI_GUID(0x18a031ab, 0xb443, 0x4d1a,\
 942                  0xa5, 0xc0, 0x0c, 0x09, 0x26, 0x1e, 0x9f, 0x71)
 943 struct efi_driver_binding_protocol {
 944         efi_status_t (EFIAPI * supported)(
 945                         struct efi_driver_binding_protocol *this,
 946                         efi_handle_t controller_handle,
 947                         struct efi_device_path *remaining_device_path);
 948         efi_status_t (EFIAPI * start)(
 949                         struct efi_driver_binding_protocol *this,
 950                         efi_handle_t controller_handle,
 951                         struct efi_device_path *remaining_device_path);
 952         efi_status_t (EFIAPI * stop)(
 953                         struct efi_driver_binding_protocol *this,
 954                         efi_handle_t controller_handle,
 955                         efi_uintn_t number_of_children,
 956                         efi_handle_t *child_handle_buffer);
 957         u32 version;
 958         efi_handle_t image_handle;
 959         efi_handle_t driver_binding_handle;
 960 };
 961
 962 #define EFI_UNICODE_COLLATION_PROTOCOL2_GUID \
 963         EFI_GUID(0xa4c751fc, 0x23ae, 0x4c3e, \
 964                  0x92, 0xe9, 0x49, 0x64, 0xcf, 0x63, 0xf3, 0x49)
 965 struct efi_unicode_collation_protocol {
 966         efi_intn_t (EFIAPI *stri_coll)(
 967                 struct efi_unicode_collation_protocol *this, u16 *s1, u16 *s2);
 968         bool (EFIAPI *metai_match)(struct efi_unicode_collation_protocol *this,
 969                                    const u16 *string, const u16 *patter);
 970         void (EFIAPI *str_lwr)(struct efi_unicode_collation_protocol
 971                                *this, u16 *string);
 972         void (EFIAPI *str_upr)(struct efi_unicode_collation_protocol *this,
 973                                u16 *string);
 974         void (EFIAPI *fat_to_str)(struct efi_unicode_collation_protocol *this,
 975                                   efi_uintn_t fat_size, char *fat, u16 *string);
 976         bool (EFIAPI *str_to_fat)(struct efi_unicode_collation_protocol *this,
 977                                   const u16 *string, efi_uintn_t fat_size,
 978                                   char *fat);
 979         char *supported_languages;
 980 };
 981
 982 #endif