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