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