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