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