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 /* Types and defines for EFI CreateEvent */
  25 enum efi_timer_delay {
  26         EFI_TIMER_STOP = 0,
  27         EFI_TIMER_PERIODIC = 1,
  28         EFI_TIMER_RELATIVE = 2
  29 };
  30
  31 #define efi_uintn_t size_t
  32 typedef uint16_t *efi_string_t;
  33
  34 #define EVT_TIMER                               0x80000000
  35 #define EVT_RUNTIME                             0x40000000
  36 #define EVT_NOTIFY_WAIT                         0x00000100
  37 #define EVT_NOTIFY_SIGNAL                       0x00000200
  38 #define EVT_SIGNAL_EXIT_BOOT_SERVICES           0x00000201
  39 #define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE       0x60000202
  40
  41 #define TPL_APPLICATION         0x04
  42 #define TPL_CALLBACK            0x08
  43 #define TPL_NOTIFY              0x10
  44 #define TPL_HIGH_LEVEL          0x1F
  45
  46 struct efi_event;
  47
  48 /* EFI Boot Services table */
  49 struct efi_boot_services {
  50         struct efi_table_hdr hdr;
  51         efi_status_t (EFIAPI *raise_tpl)(efi_uintn_t new_tpl);
  52         void (EFIAPI *restore_tpl)(efi_uintn_t old_tpl);
  53
  54         efi_status_t (EFIAPI *allocate_pages)(int, int, efi_uintn_t,
  55                                               efi_physical_addr_t *);
  56         efi_status_t (EFIAPI *free_pages)(efi_physical_addr_t, efi_uintn_t);
  57         efi_status_t (EFIAPI *get_memory_map)(efi_uintn_t *memory_map_size,
  58                                               struct efi_mem_desc *desc,
  59                                               efi_uintn_t *key,
  60                                               efi_uintn_t *desc_size,
  61                                               u32 *desc_version);
  62         efi_status_t (EFIAPI *allocate_pool)(int, efi_uintn_t, void **);
  63         efi_status_t (EFIAPI *free_pool)(void *);
  64
  65         efi_status_t (EFIAPI *create_event)(uint32_t type,
  66                         efi_uintn_t notify_tpl,
  67                         void (EFIAPI *notify_function) (
  68                                         struct efi_event *event,
  69                                         void *context),
  70                         void *notify_context, struct efi_event **event);
  71         efi_status_t (EFIAPI *set_timer)(struct efi_event *event,
  72                                          enum efi_timer_delay type,
  73                                          uint64_t trigger_time);
  74         efi_status_t (EFIAPI *wait_for_event)(efi_uintn_t number_of_events,
  75                                               struct efi_event **event,
  76                                               efi_uintn_t *index);
  77         efi_status_t (EFIAPI *signal_event)(struct efi_event *event);
  78         efi_status_t (EFIAPI *close_event)(struct efi_event *event);
  79         efi_status_t (EFIAPI *check_event)(struct efi_event *event);
  80 #define EFI_NATIVE_INTERFACE    0x00000000
  81         efi_status_t (EFIAPI *install_protocol_interface)(
  82                         void **handle, const efi_guid_t *protocol,
  83                         int protocol_interface_type, void *protocol_interface);
  84         efi_status_t (EFIAPI *reinstall_protocol_interface)(
  85                         void *handle, const efi_guid_t *protocol,
  86                         void *old_interface, void *new_interface);
  87         efi_status_t (EFIAPI *uninstall_protocol_interface)(void *handle,
  88                         const efi_guid_t *protocol, void *protocol_interface);
  89         efi_status_t (EFIAPI *handle_protocol)(efi_handle_t,
  90                                                const efi_guid_t *protocol,
  91                                                void **protocol_interface);
  92         void *reserved;
  93         efi_status_t (EFIAPI *register_protocol_notify)(
  94                         const efi_guid_t *protocol, struct efi_event *event,
  95                         void **registration);
  96         efi_status_t (EFIAPI *locate_handle)(
  97                         enum efi_locate_search_type search_type,
  98                         const efi_guid_t *protocol, void *search_key,
  99                         efi_uintn_t *buffer_size, efi_handle_t *buffer);
 100         efi_status_t (EFIAPI *locate_device_path)(const efi_guid_t *protocol,
 101                         struct efi_device_path **device_path,
 102                         efi_handle_t *device);
 103         efi_status_t (EFIAPI *install_configuration_table)(
 104                         efi_guid_t *guid, void *table);
 105
 106         efi_status_t (EFIAPI *load_image)(bool boot_policiy,
 107                         efi_handle_t parent_image,
 108                         struct efi_device_path *file_path, void *source_buffer,
 109                         unsigned long source_size, efi_handle_t *image);
 110         efi_status_t (EFIAPI *start_image)(efi_handle_t handle,
 111                                            unsigned long *exitdata_size,
 112                                            s16 **exitdata);
 113         efi_status_t (EFIAPI *exit)(efi_handle_t handle,
 114                                     efi_status_t exit_status,
 115                                     unsigned long exitdata_size, s16 *exitdata);
 116         efi_status_t (EFIAPI *unload_image)(void *image_handle);
 117         efi_status_t (EFIAPI *exit_boot_services)(efi_handle_t, unsigned long);
 118
 119         efi_status_t (EFIAPI *get_next_monotonic_count)(u64 *count);
 120         efi_status_t (EFIAPI *stall)(unsigned long usecs);
 121         efi_status_t (EFIAPI *set_watchdog_timer)(unsigned long timeout,
 122                         uint64_t watchdog_code, unsigned long data_size,
 123                         uint16_t *watchdog_data);
 124         efi_status_t(EFIAPI *connect_controller)(efi_handle_t controller_handle,
 125                         efi_handle_t *driver_image_handle,
 126                         struct efi_device_path *remaining_device_path,
 127                         bool recursive);
 128         efi_status_t (EFIAPI *disconnect_controller)(
 129                         efi_handle_t controller_handle,
 130                         efi_handle_t driver_image_handle,
 131                         efi_handle_t child_handle);
 132 #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL  0x00000001
 133 #define EFI_OPEN_PROTOCOL_GET_PROTOCOL        0x00000002
 134 #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL       0x00000004
 135 #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008
 136 #define EFI_OPEN_PROTOCOL_BY_DRIVER           0x00000010
 137 #define EFI_OPEN_PROTOCOL_EXCLUSIVE           0x00000020
 138         efi_status_t (EFIAPI *open_protocol)(efi_handle_t handle,
 139                         const efi_guid_t *protocol, void **interface,
 140                         efi_handle_t agent_handle,
 141                         efi_handle_t controller_handle, u32 attributes);
 142         efi_status_t (EFIAPI *close_protocol)(void *handle,
 143                         const efi_guid_t *protocol, void *agent_handle,
 144                         void *controller_handle);
 145         efi_status_t(EFIAPI *open_protocol_information)(efi_handle_t handle,
 146                         const efi_guid_t *protocol,
 147                         struct efi_open_protocol_info_entry **entry_buffer,
 148                         efi_uintn_t *entry_count);
 149         efi_status_t (EFIAPI *protocols_per_handle)(efi_handle_t handle,
 150                         efi_guid_t ***protocol_buffer,
 151                         efi_uintn_t *protocols_buffer_count);
 152         efi_status_t (EFIAPI *locate_handle_buffer) (
 153                         enum efi_locate_search_type search_type,
 154                         const efi_guid_t *protocol, void *search_key,
 155                         efi_uintn_t *no_handles, efi_handle_t **buffer);
 156         efi_status_t (EFIAPI *locate_protocol)(const efi_guid_t *protocol,
 157                         void *registration, void **protocol_interface);
 158         efi_status_t (EFIAPI *install_multiple_protocol_interfaces)(
 159                         void **handle, ...);
 160         efi_status_t (EFIAPI *uninstall_multiple_protocol_interfaces)(
 161                         void *handle, ...);
 162         efi_status_t (EFIAPI *calculate_crc32)(void *data,
 163                         unsigned long data_size, uint32_t *crc32);
 164         void (EFIAPI *copy_mem)(void *destination, const void *source,
 165                         size_t length);
 166         void (EFIAPI *set_mem)(void *buffer, size_t size, uint8_t value);
 167         void *create_event_ex;
 168 };
 169
 170 /* Types and defines for EFI ResetSystem */
 171 enum efi_reset_type {
 172         EFI_RESET_COLD = 0,
 173         EFI_RESET_WARM = 1,
 174         EFI_RESET_SHUTDOWN = 2
 175 };
 176
 177 /* EFI Runtime Services table */
 178 #define EFI_RUNTIME_SERVICES_SIGNATURE  0x5652453544e5552ULL
 179 #define EFI_RUNTIME_SERVICES_REVISION   0x00010000
 180
 181 struct efi_runtime_services {
 182         struct efi_table_hdr hdr;
 183         efi_status_t (EFIAPI *get_time)(struct efi_time *time,
 184                         struct efi_time_cap *capabilities);
 185         efi_status_t (EFIAPI *set_time)(struct efi_time *time);
 186         efi_status_t (EFIAPI *get_wakeup_time)(char *enabled, char *pending,
 187                         struct efi_time *time);
 188         efi_status_t (EFIAPI *set_wakeup_time)(char enabled,
 189                         struct efi_time *time);
 190         efi_status_t (EFIAPI *set_virtual_address_map)(
 191                         unsigned long memory_map_size,
 192                         unsigned long descriptor_size,
 193                         uint32_t descriptor_version,
 194                         struct efi_mem_desc *virtmap);
 195         efi_status_t (*convert_pointer)(unsigned long dbg, void **address);
 196         efi_status_t (EFIAPI *get_variable)(s16 *variable_name,
 197                         efi_guid_t *vendor, u32 *attributes,
 198                         unsigned long *data_size, void *data);
 199         efi_status_t (EFIAPI *get_next_variable)(
 200                         unsigned long *variable_name_size,
 201                         s16 *variable_name, efi_guid_t *vendor);
 202         efi_status_t (EFIAPI *set_variable)(s16 *variable_name,
 203                         efi_guid_t *vendor, u32 attributes,
 204                         unsigned long data_size, void *data);
 205         efi_status_t (EFIAPI *get_next_high_mono_count)(
 206                         uint32_t *high_count);
 207         void (EFIAPI *reset_system)(enum efi_reset_type reset_type,
 208                                     efi_status_t reset_status,
 209                                     unsigned long data_size, void *reset_data);
 210         void *update_capsule;
 211         void *query_capsule_caps;
 212         void *query_variable_info;
 213 };
 214
 215 /* EFI Configuration Table and GUID definitions */
 216 #define NULL_GUID \
 217         EFI_GUID(0x00000000, 0x0000, 0x0000, 0x00, 0x00, \
 218                  0x00, 0x00, 0x00, 0x00, 0x00, 0x00)
 219
 220 #define EFI_GLOBAL_VARIABLE_GUID \
 221         EFI_GUID(0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, \
 222                  0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c)
 223
 224 #define LOADED_IMAGE_PROTOCOL_GUID \
 225         EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, \
 226                  0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 227
 228 #define EFI_FDT_GUID \
 229         EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5, \
 230                  0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0)
 231
 232 #define SMBIOS_TABLE_GUID \
 233         EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3,  \
 234                  0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
 235
 236 struct efi_configuration_table
 237 {
 238         efi_guid_t guid;
 239         void *table;
 240 };
 241
 242 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
 243
 244 struct efi_system_table {
 245         struct efi_table_hdr hdr;
 246         unsigned long fw_vendor;   /* physical addr of wchar_t vendor string */
 247         u32 fw_revision;
 248         unsigned long con_in_handle;
 249         struct efi_simple_input_interface *con_in;
 250         unsigned long con_out_handle;
 251         struct efi_simple_text_output_protocol *con_out;
 252         unsigned long stderr_handle;
 253         struct efi_simple_text_output_protocol *std_err;
 254         struct efi_runtime_services *runtime;
 255         struct efi_boot_services *boottime;
 256         efi_uintn_t nr_tables;
 257         struct efi_configuration_table *tables;
 258 };
 259
 260 #define LOADED_IMAGE_GUID \
 261         EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, \
 262                  0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 263
 264 struct efi_loaded_image {
 265         u32 revision;
 266         void *parent_handle;
 267         struct efi_system_table *system_table;
 268         void *device_handle;
 269         void *file_path;
 270         void *reserved;
 271         u32 load_options_size;
 272         void *load_options;
 273         void *image_base;
 274         aligned_u64 image_size;
 275         unsigned int image_code_type;
 276         unsigned int image_data_type;
 277         unsigned long unload;
 278
 279         /* Below are efi loader private fields */
 280 #ifdef CONFIG_EFI_LOADER
 281         efi_status_t exit_status;
 282         struct jmp_buf_data exit_jmp;
 283 #endif
 284 };
 285
 286 #define DEVICE_PATH_GUID \
 287         EFI_GUID(0x09576e91, 0x6d3f, 0x11d2, \
 288                  0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
 289
 290 #define DEVICE_PATH_TYPE_END                    0x7f
 291 #  define DEVICE_PATH_SUB_TYPE_END              0xff
 292
 293 struct efi_device_path {
 294         u8 type;
 295         u8 sub_type;
 296         u16 length;
 297 } __packed;
 298
 299 struct efi_mac_addr {
 300         u8 addr[32];
 301 } __packed;
 302
 303 #define DEVICE_PATH_TYPE_HARDWARE_DEVICE        0x01
 304 #  define DEVICE_PATH_SUB_TYPE_MEMORY           0x03
 305 #  define DEVICE_PATH_SUB_TYPE_VENDOR           0x04
 306
 307 struct efi_device_path_memory {
 308         struct efi_device_path dp;
 309         u32 memory_type;
 310         u64 start_address;
 311         u64 end_address;
 312 } __packed;
 313
 314 struct efi_device_path_vendor {
 315         struct efi_device_path dp;
 316         efi_guid_t guid;
 317         u8 vendor_data[];
 318 } __packed;
 319
 320 #define DEVICE_PATH_TYPE_ACPI_DEVICE            0x02
 321 #  define DEVICE_PATH_SUB_TYPE_ACPI_DEVICE      0x01
 322
 323 #define EFI_PNP_ID(ID)                          (u32)(((ID) << 16) | 0x41D0)
 324 #define EISA_PNP_ID(ID)                         EFI_PNP_ID(ID)
 325 #define EISA_PNP_NUM(ID)                        ((ID) >> 16)
 326
 327 struct efi_device_path_acpi_path {
 328         struct efi_device_path dp;
 329         u32 hid;
 330         u32 uid;
 331 } __packed;
 332
 333 #define DEVICE_PATH_TYPE_MESSAGING_DEVICE       0x03
 334 #  define DEVICE_PATH_SUB_TYPE_MSG_ATAPI        0x01
 335 #  define DEVICE_PATH_SUB_TYPE_MSG_SCSI         0x02
 336 #  define DEVICE_PATH_SUB_TYPE_MSG_USB          0x05
 337 #  define DEVICE_PATH_SUB_TYPE_MSG_MAC_ADDR     0x0b
 338 #  define DEVICE_PATH_SUB_TYPE_MSG_USB_CLASS    0x0f
 339 #  define DEVICE_PATH_SUB_TYPE_MSG_SD           0x1a
 340 #  define DEVICE_PATH_SUB_TYPE_MSG_MMC          0x1d
 341
 342 struct efi_device_path_atapi {
 343         struct efi_device_path dp;
 344         u8 primary_secondary;
 345         u8 slave_master;
 346         u16 logical_unit_number;
 347 } __packed;
 348
 349 struct efi_device_path_scsi {
 350         struct efi_device_path dp;
 351         u16 target_id;
 352         u16 logical_unit_number;
 353 } __packed;
 354
 355 struct efi_device_path_usb {
 356         struct efi_device_path dp;
 357         u8 parent_port_number;
 358         u8 usb_interface;
 359 } __packed;
 360
 361 struct efi_device_path_mac_addr {
 362         struct efi_device_path dp;
 363         struct efi_mac_addr mac;
 364         u8 if_type;
 365 } __packed;
 366
 367 struct efi_device_path_usb_class {
 368         struct efi_device_path dp;
 369         u16 vendor_id;
 370         u16 product_id;
 371         u8 device_class;
 372         u8 device_subclass;
 373         u8 device_protocol;
 374 } __packed;
 375
 376 struct efi_device_path_sd_mmc_path {
 377         struct efi_device_path dp;
 378         u8 slot_number;
 379 } __packed;
 380
 381 #define DEVICE_PATH_TYPE_MEDIA_DEVICE           0x04
 382 #  define DEVICE_PATH_SUB_TYPE_HARD_DRIVE_PATH  0x01
 383 #  define DEVICE_PATH_SUB_TYPE_CDROM_PATH       0x02
 384 #  define DEVICE_PATH_SUB_TYPE_FILE_PATH        0x04
 385
 386 struct efi_device_path_hard_drive_path {
 387         struct efi_device_path dp;
 388         u32 partition_number;
 389         u64 partition_start;
 390         u64 partition_end;
 391         u8 partition_signature[16];
 392         u8 partmap_type;
 393         u8 signature_type;
 394 } __packed;
 395
 396 struct efi_device_path_cdrom_path {
 397         struct efi_device_path dp;
 398         u32 boot_entry;
 399         u64 partition_start;
 400         u64 partition_end;
 401 } __packed;
 402
 403 struct efi_device_path_file_path {
 404         struct efi_device_path dp;
 405         u16 str[];
 406 } __packed;
 407
 408 #define BLOCK_IO_GUID \
 409         EFI_GUID(0x964e5b21, 0x6459, 0x11d2, \
 410                  0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 411
 412 struct efi_block_io_media
 413 {
 414         u32 media_id;
 415         char removable_media;
 416         char media_present;
 417         char logical_partition;
 418         char read_only;
 419         char write_caching;
 420         u8 pad[3];
 421         u32 block_size;
 422         u32 io_align;
 423         u8 pad2[4];
 424         u64 last_block;
 425 };
 426
 427 struct efi_block_io {
 428         u64 revision;
 429         struct efi_block_io_media *media;
 430         efi_status_t (EFIAPI *reset)(struct efi_block_io *this,
 431                         char extended_verification);
 432         efi_status_t (EFIAPI *read_blocks)(struct efi_block_io *this,
 433                         u32 media_id, u64 lba, unsigned long buffer_size,
 434                         void *buffer);
 435         efi_status_t (EFIAPI *write_blocks)(struct efi_block_io *this,
 436                         u32 media_id, u64 lba, unsigned long buffer_size,
 437                         void *buffer);
 438         efi_status_t (EFIAPI *flush_blocks)(struct efi_block_io *this);
 439 };
 440
 441 struct simple_text_output_mode {
 442         s32 max_mode;
 443         s32 mode;
 444         s32 attribute;
 445         s32 cursor_column;
 446         s32 cursor_row;
 447         bool cursor_visible;
 448 };
 449
 450
 451 #define EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID \
 452         EFI_GUID(0x387477c2, 0x69c7, 0x11d2, \
 453                  0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 454
 455 #define EFI_BLACK                0x00
 456 #define EFI_BLUE                 0x01
 457 #define EFI_GREEN                0x02
 458 #define EFI_CYAN                 0x03
 459 #define EFI_RED                  0x04
 460 #define EFI_MAGENTA              0x05
 461 #define EFI_BROWN                0x06
 462 #define EFI_LIGHTGRAY            0x07
 463 #define EFI_BRIGHT               0x08
 464 #define EFI_DARKGRAY             0x08
 465 #define EFI_LIGHTBLUE            0x09
 466 #define EFI_LIGHTGREEN           0x0a
 467 #define EFI_LIGHTCYAN            0x0b
 468 #define EFI_LIGHTRED             0x0c
 469 #define EFI_LIGHTMAGENTA         0x0d
 470 #define EFI_YELLOW               0x0e
 471 #define EFI_WHITE                0x0f
 472 #define EFI_BACKGROUND_BLACK     0x00
 473 #define EFI_BACKGROUND_BLUE      0x10
 474 #define EFI_BACKGROUND_GREEN     0x20
 475 #define EFI_BACKGROUND_CYAN      0x30
 476 #define EFI_BACKGROUND_RED       0x40
 477 #define EFI_BACKGROUND_MAGENTA   0x50
 478 #define EFI_BACKGROUND_BROWN     0x60
 479 #define EFI_BACKGROUND_LIGHTGRAY 0x70
 480
 481 /* extract foreground color from EFI attribute */
 482 #define EFI_ATTR_FG(attr)        ((attr) & 0x07)
 483 /* treat high bit of FG as bright/bold (similar to edk2) */
 484 #define EFI_ATTR_BOLD(attr)      (((attr) >> 3) & 0x01)
 485 /* extract background color from EFI attribute */
 486 #define EFI_ATTR_BG(attr)        (((attr) >> 4) & 0x7)
 487
 488 struct efi_simple_text_output_protocol {
 489         void *reset;
 490         efi_status_t (EFIAPI *output_string)(
 491                         struct efi_simple_text_output_protocol *this,
 492                         const efi_string_t str);
 493         efi_status_t (EFIAPI *test_string)(
 494                         struct efi_simple_text_output_protocol *this,
 495                         const efi_string_t str);
 496         efi_status_t(EFIAPI *query_mode)(
 497                         struct efi_simple_text_output_protocol *this,
 498                         unsigned long mode_number, unsigned long *columns,
 499                         unsigned long *rows);
 500         efi_status_t(EFIAPI *set_mode)(
 501                         struct efi_simple_text_output_protocol *this,
 502                         unsigned long mode_number);
 503         efi_status_t(EFIAPI *set_attribute)(
 504                         struct efi_simple_text_output_protocol *this,
 505                         unsigned long attribute);
 506         efi_status_t(EFIAPI *clear_screen) (
 507                         struct efi_simple_text_output_protocol *this);
 508         efi_status_t(EFIAPI *set_cursor_position) (
 509                         struct efi_simple_text_output_protocol *this,
 510                         unsigned long column, unsigned long row);
 511         efi_status_t(EFIAPI *enable_cursor)(
 512                         struct efi_simple_text_output_protocol *this,
 513                         bool enable);
 514         struct simple_text_output_mode *mode;
 515 };
 516
 517 struct efi_input_key {
 518         u16 scan_code;
 519         s16 unicode_char;
 520 };
 521
 522 #define EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID \
 523         EFI_GUID(0x387477c1, 0x69c7, 0x11d2, \
 524                  0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 525
 526 struct efi_simple_input_interface {
 527         efi_status_t(EFIAPI *reset)(struct efi_simple_input_interface *this,
 528                         bool ExtendedVerification);
 529         efi_status_t(EFIAPI *read_key_stroke)(
 530                         struct efi_simple_input_interface *this,
 531                         struct efi_input_key *key);
 532         struct efi_event *wait_for_key;
 533 };
 534
 535 #define CONSOLE_CONTROL_GUID \
 536         EFI_GUID(0xf42f7782, 0x12e, 0x4c12, \
 537                  0x99, 0x56, 0x49, 0xf9, 0x43, 0x4, 0xf7, 0x21)
 538 #define EFI_CONSOLE_MODE_TEXT   0
 539 #define EFI_CONSOLE_MODE_GFX    1
 540
 541 struct efi_console_control_protocol
 542 {
 543         efi_status_t (EFIAPI *get_mode)(
 544                         struct efi_console_control_protocol *this, int *mode,
 545                         char *uga_exists, char *std_in_locked);
 546         efi_status_t (EFIAPI *set_mode)(
 547                         struct efi_console_control_protocol *this, int mode);
 548         efi_status_t (EFIAPI *lock_std_in)(
 549                         struct efi_console_control_protocol *this,
 550                         uint16_t *password);
 551 };
 552
 553 #define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID \
 554         EFI_GUID(0x8b843e20, 0x8132, 0x4852, \
 555                  0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c)
 556
 557 struct efi_device_path_to_text_protocol
 558 {
 559         uint16_t *(EFIAPI *convert_device_node_to_text)(
 560                         struct efi_device_path *device_node,
 561                         bool display_only,
 562                         bool allow_shortcuts);
 563         uint16_t *(EFIAPI *convert_device_path_to_text)(
 564                         struct efi_device_path *device_path,
 565                         bool display_only,
 566                         bool allow_shortcuts);
 567 };
 568
 569 #define EFI_GOP_GUID \
 570         EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, \
 571                  0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
 572
 573 #define EFI_GOT_RGBA8           0
 574 #define EFI_GOT_BGRA8           1
 575 #define EFI_GOT_BITMASK         2
 576
 577 struct efi_gop_mode_info
 578 {
 579         u32 version;
 580         u32 width;
 581         u32 height;
 582         u32 pixel_format;
 583         u32 pixel_bitmask[4];
 584         u32 pixels_per_scanline;
 585 };
 586
 587 struct efi_gop_mode
 588 {
 589         u32 max_mode;
 590         u32 mode;
 591         struct efi_gop_mode_info *info;
 592         unsigned long info_size;
 593         efi_physical_addr_t fb_base;
 594         unsigned long fb_size;
 595 };
 596
 597 #define EFI_BLT_VIDEO_FILL              0
 598 #define EFI_BLT_VIDEO_TO_BLT_BUFFER     1
 599 #define EFI_BLT_BUFFER_TO_VIDEO         2
 600 #define EFI_BLT_VIDEO_TO_VIDEO          3
 601
 602 struct efi_gop
 603 {
 604         efi_status_t (EFIAPI *query_mode)(struct efi_gop *this, u32 mode_number,
 605                                           efi_uintn_t *size_of_info,
 606                                           struct efi_gop_mode_info **info);
 607         efi_status_t (EFIAPI *set_mode)(struct efi_gop *this, u32 mode_number);
 608         efi_status_t (EFIAPI *blt)(struct efi_gop *this, void *buffer,
 609                                    u32 operation, efi_uintn_t sx,
 610                                    efi_uintn_t sy, efi_uintn_t dx,
 611                                    efi_uintn_t dy, efi_uintn_t width,
 612                                    efi_uintn_t height, efi_uintn_t delta);
 613         struct efi_gop_mode *mode;
 614 };
 615
 616 #define EFI_SIMPLE_NETWORK_GUID \
 617         EFI_GUID(0xa19832b9, 0xac25, 0x11d3, \
 618                  0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
 619
 620 struct efi_mac_address {
 621         char mac_addr[32];
 622 };
 623
 624 struct efi_ip_address {
 625         u8 ip_addr[16];
 626 };
 627
 628 enum efi_simple_network_state {
 629         EFI_NETWORK_STOPPED,
 630         EFI_NETWORK_STARTED,
 631         EFI_NETWORK_INITIALIZED,
 632 };
 633
 634 struct efi_simple_network_mode {
 635         enum efi_simple_network_state state;
 636         u32 hwaddr_size;
 637         u32 media_header_size;
 638         u32 max_packet_size;
 639         u32 nvram_size;
 640         u32 nvram_access_size;
 641         u32 receive_filter_mask;
 642         u32 receive_filter_setting;
 643         u32 max_mcast_filter_count;
 644         u32 mcast_filter_count;
 645         struct efi_mac_address mcast_filter[16];
 646         struct efi_mac_address current_address;
 647         struct efi_mac_address broadcast_address;
 648         struct efi_mac_address permanent_address;
 649         u8 if_type;
 650         u8 mac_changeable;
 651         u8 multitx_supported;
 652         u8 media_present_supported;
 653         u8 media_present;
 654 };
 655
 656 /* receive_filters bit mask */
 657 #define EFI_SIMPLE_NETWORK_RECEIVE_UNICAST               0x01
 658 #define EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST             0x02
 659 #define EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST             0x04
 660 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS           0x08
 661 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST 0x10
 662
 663 /* interrupt status bit mask */
 664 #define EFI_SIMPLE_NETWORK_RECEIVE_INTERRUPT    0x01
 665 #define EFI_SIMPLE_NETWORK_TRANSMIT_INTERRUPT   0x02
 666 #define EFI_SIMPLE_NETWORK_COMMAND_INTERRUPT    0x04
 667 #define EFI_SIMPLE_NETWORK_SOFTWARE_INTERRUPT   0x08
 668
 669 /* revision of the simple network protocol */
 670 #define EFI_SIMPLE_NETWORK_PROTOCOL_REVISION    0x00010000
 671
 672 struct efi_simple_network
 673 {
 674         u64 revision;
 675         efi_status_t (EFIAPI *start)(struct efi_simple_network *this);
 676         efi_status_t (EFIAPI *stop)(struct efi_simple_network *this);
 677         efi_status_t (EFIAPI *initialize)(struct efi_simple_network *this,
 678                         ulong extra_rx, ulong extra_tx);
 679         efi_status_t (EFIAPI *reset)(struct efi_simple_network *this,
 680                         int extended_verification);
 681         efi_status_t (EFIAPI *shutdown)(struct efi_simple_network *this);
 682         efi_status_t (EFIAPI *receive_filters)(struct efi_simple_network *this,
 683                         u32 enable, u32 disable, int reset_mcast_filter,
 684                         ulong mcast_filter_count,
 685                         struct efi_mac_address *mcast_filter);
 686         efi_status_t (EFIAPI *station_address)(struct efi_simple_network *this,
 687                         int reset, struct efi_mac_address *new_mac);
 688         efi_status_t (EFIAPI *statistics)(struct efi_simple_network *this,
 689                         int reset, ulong *stat_size, void *stat_table);
 690         efi_status_t (EFIAPI *mcastiptomac)(struct efi_simple_network *this,
 691                         int ipv6, struct efi_ip_address *ip,
 692                         struct efi_mac_address *mac);
 693         efi_status_t (EFIAPI *nvdata)(struct efi_simple_network *this,
 694                         int read_write, ulong offset, ulong buffer_size,
 695                         char *buffer);
 696         efi_status_t (EFIAPI *get_status)(struct efi_simple_network *this,
 697                         u32 *int_status, void **txbuf);
 698         efi_status_t (EFIAPI *transmit)(struct efi_simple_network *this,
 699                         size_t header_size, size_t buffer_size, void *buffer,
 700                         struct efi_mac_address *src_addr,
 701                         struct efi_mac_address *dest_addr, u16 *protocol);
 702         efi_status_t (EFIAPI *receive)(struct efi_simple_network *this,
 703                         size_t *header_size, size_t *buffer_size, void *buffer,
 704                         struct efi_mac_address *src_addr,
 705                         struct efi_mac_address *dest_addr, u16 *protocol);
 706         struct efi_event *wait_for_packet;
 707         struct efi_simple_network_mode *mode;
 708 };
 709
 710 #define EFI_PXE_GUID \
 711         EFI_GUID(0x03c4e603, 0xac28, 0x11d3, \
 712                  0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
 713
 714 struct efi_pxe_packet {
 715         u8 packet[1472];
 716 };
 717
 718 struct efi_pxe_mode
 719 {
 720         u8 unused[52];
 721         struct efi_pxe_packet dhcp_discover;
 722         struct efi_pxe_packet dhcp_ack;
 723         struct efi_pxe_packet proxy_offer;
 724         struct efi_pxe_packet pxe_discover;
 725         struct efi_pxe_packet pxe_reply;
 726 };
 727
 728 struct efi_pxe {
 729         u64 rev;
 730         void (EFIAPI *start)(void);
 731         void (EFIAPI *stop)(void);
 732         void (EFIAPI *dhcp)(void);
 733         void (EFIAPI *discover)(void);
 734         void (EFIAPI *mftp)(void);
 735         void (EFIAPI *udpwrite)(void);
 736         void (EFIAPI *udpread)(void);
 737         void (EFIAPI *setipfilter)(void);
 738         void (EFIAPI *arp)(void);
 739         void (EFIAPI *setparams)(void);
 740         void (EFIAPI *setstationip)(void);
 741         void (EFIAPI *setpackets)(void);
 742         struct efi_pxe_mode *mode;
 743 };
 744
 745 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID \
 746         EFI_GUID(0x964e5b22, 0x6459, 0x11d2, \
 747                  0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 748 #define EFI_FILE_PROTOCOL_REVISION 0x00010000
 749
 750 struct efi_file_handle {
 751         u64 rev;
 752         efi_status_t (EFIAPI *open)(struct efi_file_handle *file,
 753                         struct efi_file_handle **new_handle,
 754                         s16 *file_name, u64 open_mode, u64 attributes);
 755         efi_status_t (EFIAPI *close)(struct efi_file_handle *file);
 756         efi_status_t (EFIAPI *delete)(struct efi_file_handle *file);
 757         efi_status_t (EFIAPI *read)(struct efi_file_handle *file,
 758                         u64 *buffer_size, void *buffer);
 759         efi_status_t (EFIAPI *write)(struct efi_file_handle *file,
 760                         u64 *buffer_size, void *buffer);
 761         efi_status_t (EFIAPI *getpos)(struct efi_file_handle *file,
 762                         u64 *pos);
 763         efi_status_t (EFIAPI *setpos)(struct efi_file_handle *file,
 764                         u64 pos);
 765         efi_status_t (EFIAPI *getinfo)(struct efi_file_handle *file,
 766                         efi_guid_t *info_type, u64 *buffer_size, void *buffer);
 767         efi_status_t (EFIAPI *setinfo)(struct efi_file_handle *file,
 768                         efi_guid_t *info_type, u64 buffer_size, void *buffer);
 769         efi_status_t (EFIAPI *flush)(struct efi_file_handle *file);
 770 };
 771
 772 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID \
 773         EFI_GUID(0x964e5b22, 0x6459, 0x11d2, \
 774                  0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 775 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION 0x00010000
 776
 777 struct efi_simple_file_system_protocol {
 778         u64 rev;
 779         efi_status_t (EFIAPI *open_volume)(struct efi_simple_file_system_protocol *this,
 780                         struct efi_file_handle **root);
 781 };
 782
 783 #define EFI_FILE_INFO_GUID \
 784         EFI_GUID(0x9576e92, 0x6d3f, 0x11d2, \
 785                  0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 786
 787 #define EFI_FILE_MODE_READ      0x0000000000000001
 788 #define EFI_FILE_MODE_WRITE     0x0000000000000002
 789 #define EFI_FILE_MODE_CREATE    0x8000000000000000
 790
 791 #define EFI_FILE_READ_ONLY      0x0000000000000001
 792 #define EFI_FILE_HIDDEN         0x0000000000000002
 793 #define EFI_FILE_SYSTEM         0x0000000000000004
 794 #define EFI_FILE_RESERVED       0x0000000000000008
 795 #define EFI_FILE_DIRECTORY      0x0000000000000010
 796 #define EFI_FILE_ARCHIVE        0x0000000000000020
 797 #define EFI_FILE_VALID_ATTR     0x0000000000000037
 798
 799 struct efi_file_info {
 800         u64 size;
 801         u64 file_size;
 802         u64 physical_size;
 803         struct efi_time create_time;
 804         struct efi_time last_access_time;
 805         struct efi_time modification_time;
 806         u64 attribute;
 807         s16 file_name[0];
 808 };
 809
 810 #define EFI_DRIVER_BINDING_PROTOCOL_GUID \
 811         EFI_GUID(0x18a031ab, 0xb443, 0x4d1a,\
 812                  0xa5, 0xc0, 0x0c, 0x09, 0x26, 0x1e, 0x9f, 0x71)
 813 struct efi_driver_binding_protocol {
 814         efi_status_t (EFIAPI * supported)(
 815                         struct efi_driver_binding_protocol *this,
 816                         efi_handle_t controller_handle,
 817                         struct efi_device_path *remaining_device_path);
 818         efi_status_t (EFIAPI * start)(
 819                         struct efi_driver_binding_protocol *this,
 820                         efi_handle_t controller_handle,
 821                         struct efi_device_path *remaining_device_path);
 822         efi_status_t (EFIAPI * stop)(
 823                         struct efi_driver_binding_protocol *this,
 824                         efi_handle_t controller_handle,
 825                         efi_uintn_t number_of_children,
 826                         efi_handle_t *child_handle_buffer);
 827         u32 version;
 828         efi_handle_t image_handle;
 829         efi_handle_t driver_binding_handle;
 830 };
 831
 832 #endif