/* * Extensible Firmware Interface * Based on 'Extensible Firmware Interface Specification' version 0.9, * April 30, 1999 * * Copyright (C) 1999 VA Linux Systems * Copyright (C) 1999 Walt Drummond * Copyright (C) 1999, 2002-2003 Hewlett-Packard Co. * David Mosberger-Tang * Stephane Eranian * * From include/linux/efi.h in kernel 4.1 with some additions/subtractions */ #ifndef _EFI_API_H #define _EFI_API_H #include #ifdef CONFIG_EFI_LOADER #include #endif /* Types and defines for EFI CreateEvent */ enum efi_timer_delay { EFI_TIMER_STOP = 0, EFI_TIMER_PERIODIC = 1, EFI_TIMER_RELATIVE = 2 }; #define UINTN size_t #define EVT_TIMER 0x80000000 #define EVT_RUNTIME 0x40000000 #define EVT_NOTIFY_WAIT 0x00000100 #define EVT_NOTIFY_SIGNAL 0x00000200 #define EVT_SIGNAL_EXIT_BOOT_SERVICES 0x00000201 #define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE 0x60000202 #define TPL_APPLICATION 0x04 #define TPL_CALLBACK 0x08 #define TPL_NOTIFY 0x10 #define TPL_HIGH_LEVEL 0x1F struct efi_event; /* EFI Boot Services table */ struct efi_boot_services { struct efi_table_hdr hdr; efi_status_t (EFIAPI *raise_tpl)(UINTN new_tpl); void (EFIAPI *restore_tpl)(UINTN old_tpl); efi_status_t (EFIAPI *allocate_pages)(int, int, unsigned long, efi_physical_addr_t *); efi_status_t (EFIAPI *free_pages)(efi_physical_addr_t, unsigned long); efi_status_t (EFIAPI *get_memory_map)(unsigned long *memory_map_size, struct efi_mem_desc *desc, unsigned long *key, unsigned long *desc_size, u32 *desc_version); efi_status_t (EFIAPI *allocate_pool)(int, unsigned long, void **); efi_status_t (EFIAPI *free_pool)(void *); efi_status_t (EFIAPI *create_event)(uint32_t type, UINTN notify_tpl, void (EFIAPI *notify_function) ( struct efi_event *event, void *context), void *notify_context, struct efi_event **event); efi_status_t (EFIAPI *set_timer)(struct efi_event *event, enum efi_timer_delay type, uint64_t trigger_time); efi_status_t (EFIAPI *wait_for_event)(unsigned long number_of_events, struct efi_event **event, unsigned long *index); efi_status_t (EFIAPI *signal_event)(struct efi_event *event); efi_status_t (EFIAPI *close_event)(struct efi_event *event); efi_status_t (EFIAPI *check_event)(struct efi_event *event); #define EFI_NATIVE_INTERFACE 0x00000000 efi_status_t (EFIAPI *install_protocol_interface)( void **handle, efi_guid_t *protocol, int protocol_interface_type, void *protocol_interface); efi_status_t (EFIAPI *reinstall_protocol_interface)( void *handle, efi_guid_t *protocol, void *old_interface, void *new_interface); efi_status_t (EFIAPI *uninstall_protocol_interface)(void *handle, efi_guid_t *protocol, void *protocol_interface); efi_status_t (EFIAPI *handle_protocol)(efi_handle_t, efi_guid_t *, void **); void *reserved; efi_status_t (EFIAPI *register_protocol_notify)( efi_guid_t *protocol, struct efi_event *event, void **registration); efi_status_t (EFIAPI *locate_handle)( enum efi_locate_search_type search_type, efi_guid_t *protocol, void *search_key, unsigned long *buffer_size, efi_handle_t *buffer); efi_status_t (EFIAPI *locate_device_path)(efi_guid_t *protocol, struct efi_device_path **device_path, efi_handle_t *device); efi_status_t (EFIAPI *install_configuration_table)( efi_guid_t *guid, void *table); efi_status_t (EFIAPI *load_image)(bool boot_policiy, efi_handle_t parent_image, struct efi_device_path *file_path, void *source_buffer, unsigned long source_size, efi_handle_t *image); efi_status_t (EFIAPI *start_image)(efi_handle_t handle, unsigned long *exitdata_size, s16 **exitdata); efi_status_t (EFIAPI *exit)(efi_handle_t handle, efi_status_t exit_status, unsigned long exitdata_size, s16 *exitdata); efi_status_t (EFIAPI *unload_image)(void *image_handle); efi_status_t (EFIAPI *exit_boot_services)(efi_handle_t, unsigned long); efi_status_t (EFIAPI *get_next_monotonic_count)(u64 *count); efi_status_t (EFIAPI *stall)(unsigned long usecs); efi_status_t (EFIAPI *set_watchdog_timer)(unsigned long timeout, uint64_t watchdog_code, unsigned long data_size, uint16_t *watchdog_data); efi_status_t(EFIAPI *connect_controller)(efi_handle_t controller_handle, efi_handle_t *driver_image_handle, struct efi_device_path *remaining_device_path, bool recursive); efi_status_t (EFIAPI *disconnect_controller)(void *controller_handle, void *driver_image_handle, void *child_handle); #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001 #define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002 #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004 #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008 #define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010 #define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020 efi_status_t (EFIAPI *open_protocol)(efi_handle_t handle, efi_guid_t *protocol, void **interface, efi_handle_t agent_handle, efi_handle_t controller_handle, u32 attributes); efi_status_t (EFIAPI *close_protocol)(void *handle, efi_guid_t *protocol, void *agent_handle, void *controller_handle); efi_status_t(EFIAPI *open_protocol_information)(efi_handle_t handle, efi_guid_t *protocol, struct efi_open_protocol_info_entry **entry_buffer, unsigned long *entry_count); efi_status_t (EFIAPI *protocols_per_handle)(efi_handle_t handle, efi_guid_t ***protocol_buffer, unsigned long *protocols_buffer_count); efi_status_t (EFIAPI *locate_handle_buffer) ( enum efi_locate_search_type search_type, efi_guid_t *protocol, void *search_key, unsigned long *no_handles, efi_handle_t **buffer); efi_status_t (EFIAPI *locate_protocol)(efi_guid_t *protocol, void *registration, void **protocol_interface); efi_status_t (EFIAPI *install_multiple_protocol_interfaces)( void **handle, ...); efi_status_t (EFIAPI *uninstall_multiple_protocol_interfaces)( void *handle, ...); efi_status_t (EFIAPI *calculate_crc32)(void *data, unsigned long data_size, uint32_t *crc32); void (EFIAPI *copy_mem)(void *destination, void *source, unsigned long length); void (EFIAPI *set_mem)(void *buffer, unsigned long size, uint8_t value); void *create_event_ex; }; /* Types and defines for EFI ResetSystem */ enum efi_reset_type { EFI_RESET_COLD = 0, EFI_RESET_WARM = 1, EFI_RESET_SHUTDOWN = 2 }; /* EFI Runtime Services table */ #define EFI_RUNTIME_SERVICES_SIGNATURE 0x5652453544e5552ULL #define EFI_RUNTIME_SERVICES_REVISION 0x00010000 struct efi_runtime_services { struct efi_table_hdr hdr; efi_status_t (EFIAPI *get_time)(struct efi_time *time, struct efi_time_cap *capabilities); efi_status_t (EFIAPI *set_time)(struct efi_time *time); efi_status_t (EFIAPI *get_wakeup_time)(char *enabled, char *pending, struct efi_time *time); efi_status_t (EFIAPI *set_wakeup_time)(char enabled, struct efi_time *time); efi_status_t (EFIAPI *set_virtual_address_map)( unsigned long memory_map_size, unsigned long descriptor_size, uint32_t descriptor_version, struct efi_mem_desc *virtmap); efi_status_t (*convert_pointer)(unsigned long dbg, void **address); efi_status_t (EFIAPI *get_variable)(s16 *variable_name, efi_guid_t *vendor, u32 *attributes, unsigned long *data_size, void *data); efi_status_t (EFIAPI *get_next_variable)( unsigned long *variable_name_size, s16 *variable_name, efi_guid_t *vendor); efi_status_t (EFIAPI *set_variable)(s16 *variable_name, efi_guid_t *vendor, u32 attributes, unsigned long data_size, void *data); efi_status_t (EFIAPI *get_next_high_mono_count)( uint32_t *high_count); void (EFIAPI *reset_system)(enum efi_reset_type reset_type, efi_status_t reset_status, unsigned long data_size, void *reset_data); void *update_capsule; void *query_capsule_caps; void *query_variable_info; }; /* EFI Configuration Table and GUID definitions */ #define NULL_GUID \ EFI_GUID(0x00000000, 0x0000, 0x0000, 0x00, 0x00, \ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00) #define LOADED_IMAGE_PROTOCOL_GUID \ EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, \ 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b) #define EFI_FDT_GUID \ EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5, \ 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0) #define SMBIOS_TABLE_GUID \ EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3, \ 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d) struct efi_configuration_table { efi_guid_t guid; void *table; }; #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL) struct efi_system_table { struct efi_table_hdr hdr; unsigned long fw_vendor; /* physical addr of wchar_t vendor string */ u32 fw_revision; unsigned long con_in_handle; struct efi_simple_input_interface *con_in; unsigned long con_out_handle; struct efi_simple_text_output_protocol *con_out; unsigned long stderr_handle; struct efi_simple_text_output_protocol *std_err; struct efi_runtime_services *runtime; struct efi_boot_services *boottime; unsigned long nr_tables; struct efi_configuration_table *tables; }; #define LOADED_IMAGE_GUID \ EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, \ 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b) struct efi_loaded_image { u32 revision; void *parent_handle; struct efi_system_table *system_table; void *device_handle; void *file_path; void *reserved; u32 load_options_size; void *load_options; void *image_base; aligned_u64 image_size; unsigned int image_code_type; unsigned int image_data_type; unsigned long unload; /* Below are efi loader private fields */ #ifdef CONFIG_EFI_LOADER efi_status_t exit_status; struct jmp_buf_data exit_jmp; #endif }; #define DEVICE_PATH_GUID \ EFI_GUID(0x09576e91, 0x6d3f, 0x11d2, \ 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b ) #define DEVICE_PATH_TYPE_END 0x7f # define DEVICE_PATH_SUB_TYPE_END 0xff struct efi_device_path { u8 type; u8 sub_type; u16 length; }; struct efi_mac_addr { u8 addr[32]; }; #define DEVICE_PATH_TYPE_HARDWARE_DEVICE 0x01 # define DEVICE_PATH_SUB_TYPE_VENDOR 0x04 struct efi_device_path_vendor { struct efi_device_path dp; efi_guid_t guid; u8 vendor_data[]; } __packed; #define DEVICE_PATH_TYPE_ACPI_DEVICE 0x02 # define DEVICE_PATH_SUB_TYPE_ACPI_DEVICE 0x01 #define EFI_PNP_ID(ID) (u32)(((ID) << 16) | 0x41D0) #define EISA_PNP_ID(ID) EFI_PNP_ID(ID) struct efi_device_path_acpi_path { struct efi_device_path dp; u32 hid; u32 uid; } __packed; #define DEVICE_PATH_TYPE_MESSAGING_DEVICE 0x03 # define DEVICE_PATH_SUB_TYPE_MSG_USB 0x05 # define DEVICE_PATH_SUB_TYPE_MSG_MAC_ADDR 0x0b # define DEVICE_PATH_SUB_TYPE_MSG_USB_CLASS 0x0f # define DEVICE_PATH_SUB_TYPE_MSG_SD 0x1a # define DEVICE_PATH_SUB_TYPE_MSG_MMC 0x1d struct efi_device_path_usb { struct efi_device_path dp; u8 parent_port_number; u8 usb_interface; } __packed; struct efi_device_path_mac_addr { struct efi_device_path dp; struct efi_mac_addr mac; u8 if_type; }; struct efi_device_path_usb_class { struct efi_device_path dp; u16 vendor_id; u16 product_id; u8 device_class; u8 device_subclass; u8 device_protocol; } __packed; struct efi_device_path_sd_mmc_path { struct efi_device_path dp; u8 slot_number; } __packed; #define DEVICE_PATH_TYPE_MEDIA_DEVICE 0x04 # define DEVICE_PATH_SUB_TYPE_HARD_DRIVE_PATH 0x01 # define DEVICE_PATH_SUB_TYPE_CDROM_PATH 0x02 # define DEVICE_PATH_SUB_TYPE_FILE_PATH 0x04 struct efi_device_path_hard_drive_path { struct efi_device_path dp; u32 partition_number; u64 partition_start; u64 partition_end; u8 partition_signature[16]; u8 partmap_type; u8 signature_type; } __packed; struct efi_device_path_cdrom_path { struct efi_device_path dp; u32 boot_entry; u64 partition_start; u64 partition_end; } __packed; struct efi_device_path_file_path { struct efi_device_path dp; u16 str[32]; }; #define BLOCK_IO_GUID \ EFI_GUID(0x964e5b21, 0x6459, 0x11d2, \ 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b) struct efi_block_io_media { u32 media_id; char removable_media; char media_present; char logical_partition; char read_only; char write_caching; u8 pad[3]; u32 block_size; u32 io_align; u8 pad2[4]; u64 last_block; }; struct efi_block_io { u64 revision; struct efi_block_io_media *media; efi_status_t (EFIAPI *reset)(struct efi_block_io *this, char extended_verification); efi_status_t (EFIAPI *read_blocks)(struct efi_block_io *this, u32 media_id, u64 lba, unsigned long buffer_size, void *buffer); efi_status_t (EFIAPI *write_blocks)(struct efi_block_io *this, u32 media_id, u64 lba, unsigned long buffer_size, void *buffer); efi_status_t (EFIAPI *flush_blocks)(struct efi_block_io *this); }; struct simple_text_output_mode { s32 max_mode; s32 mode; s32 attribute; s32 cursor_column; s32 cursor_row; bool cursor_visible; }; #define EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID \ EFI_GUID(0x387477c2, 0x69c7, 0x11d2, \ 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b) struct efi_simple_text_output_protocol { void *reset; efi_status_t (EFIAPI *output_string)( struct efi_simple_text_output_protocol *this, const unsigned short *str); efi_status_t (EFIAPI *test_string)( struct efi_simple_text_output_protocol *this, const unsigned short *str); efi_status_t(EFIAPI *query_mode)( struct efi_simple_text_output_protocol *this, unsigned long mode_number, unsigned long *columns, unsigned long *rows); efi_status_t(EFIAPI *set_mode)( struct efi_simple_text_output_protocol *this, unsigned long mode_number); efi_status_t(EFIAPI *set_attribute)( struct efi_simple_text_output_protocol *this, unsigned long attribute); efi_status_t(EFIAPI *clear_screen) ( struct efi_simple_text_output_protocol *this); efi_status_t(EFIAPI *set_cursor_position) ( struct efi_simple_text_output_protocol *this, unsigned long column, unsigned long row); efi_status_t(EFIAPI *enable_cursor)( struct efi_simple_text_output_protocol *this, bool enable); struct simple_text_output_mode *mode; }; struct efi_input_key { u16 scan_code; s16 unicode_char; }; #define EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID \ EFI_GUID(0x387477c1, 0x69c7, 0x11d2, \ 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b) struct efi_simple_input_interface { efi_status_t(EFIAPI *reset)(struct efi_simple_input_interface *this, bool ExtendedVerification); efi_status_t(EFIAPI *read_key_stroke)( struct efi_simple_input_interface *this, struct efi_input_key *key); struct efi_event *wait_for_key; }; #define CONSOLE_CONTROL_GUID \ EFI_GUID(0xf42f7782, 0x12e, 0x4c12, \ 0x99, 0x56, 0x49, 0xf9, 0x43, 0x4, 0xf7, 0x21) #define EFI_CONSOLE_MODE_TEXT 0 #define EFI_CONSOLE_MODE_GFX 1 struct efi_console_control_protocol { efi_status_t (EFIAPI *get_mode)( struct efi_console_control_protocol *this, int *mode, char *uga_exists, char *std_in_locked); efi_status_t (EFIAPI *set_mode)( struct efi_console_control_protocol *this, int mode); efi_status_t (EFIAPI *lock_std_in)( struct efi_console_control_protocol *this, uint16_t *password); }; #define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID \ EFI_GUID(0x8b843e20, 0x8132, 0x4852, \ 0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c) struct efi_device_path_protocol { uint8_t type; uint8_t sub_type; uint16_t length; uint8_t data[]; }; struct efi_device_path_to_text_protocol { uint16_t *(EFIAPI *convert_device_node_to_text)( struct efi_device_path_protocol *device_node, bool display_only, bool allow_shortcuts); uint16_t *(EFIAPI *convert_device_path_to_text)( struct efi_device_path_protocol *device_path, bool display_only, bool allow_shortcuts); }; #define EFI_GOP_GUID \ EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, \ 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a) #define EFI_GOT_RGBA8 0 #define EFI_GOT_BGRA8 1 #define EFI_GOT_BITMASK 2 struct efi_gop_mode_info { u32 version; u32 width; u32 height; u32 pixel_format; u32 pixel_bitmask[4]; u32 pixels_per_scanline; }; struct efi_gop_mode { u32 max_mode; u32 mode; struct efi_gop_mode_info *info; unsigned long info_size; efi_physical_addr_t fb_base; unsigned long fb_size; }; #define EFI_BLT_VIDEO_FILL 0 #define EFI_BLT_VIDEO_TO_BLT_BUFFER 1 #define EFI_BLT_BUFFER_TO_VIDEO 2 #define EFI_BLT_VIDEO_TO_VIDEO 3 struct efi_gop { efi_status_t (EFIAPI *query_mode)(struct efi_gop *this, u32 mode_number, unsigned long *size_of_info, struct efi_gop_mode_info **info); efi_status_t (EFIAPI *set_mode)(struct efi_gop *this, u32 mode_number); efi_status_t (EFIAPI *blt)(struct efi_gop *this, void *buffer, unsigned long operation, unsigned long sx, unsigned long sy, unsigned long dx, unsigned long dy, unsigned long width, unsigned long height, unsigned long delta); struct efi_gop_mode *mode; }; #define EFI_SIMPLE_NETWORK_GUID \ EFI_GUID(0xa19832b9, 0xac25, 0x11d3, \ 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d) struct efi_mac_address { char mac_addr[32]; }; struct efi_ip_address { u8 ip_addr[16]; }; enum efi_simple_network_state { EFI_NETWORK_STOPPED, EFI_NETWORK_STARTED, EFI_NETWORK_INITIALIZED, }; struct efi_simple_network_mode { enum efi_simple_network_state state; u32 hwaddr_size; u32 media_header_size; u32 max_packet_size; u32 nvram_size; u32 nvram_access_size; u32 receive_filter_mask; u32 receive_filter_setting; u32 max_mcast_filter_count; u32 mcast_filter_count; struct efi_mac_address mcast_filter[16]; struct efi_mac_address current_address; struct efi_mac_address broadcast_address; struct efi_mac_address permanent_address; u8 if_type; u8 mac_changeable; u8 multitx_supported; u8 media_present_supported; u8 media_present; }; #define EFI_SIMPLE_NETWORK_RECEIVE_UNICAST 0x01, #define EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST 0x02, #define EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST 0x04, #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS 0x08, #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST 0x10, struct efi_simple_network { u64 revision; efi_status_t (EFIAPI *start)(struct efi_simple_network *this); efi_status_t (EFIAPI *stop)(struct efi_simple_network *this); efi_status_t (EFIAPI *initialize)(struct efi_simple_network *this, ulong extra_rx, ulong extra_tx); efi_status_t (EFIAPI *reset)(struct efi_simple_network *this, int extended_verification); efi_status_t (EFIAPI *shutdown)(struct efi_simple_network *this); efi_status_t (EFIAPI *receive_filters)(struct efi_simple_network *this, u32 enable, u32 disable, int reset_mcast_filter, ulong mcast_filter_count, struct efi_mac_address *mcast_filter); efi_status_t (EFIAPI *station_address)(struct efi_simple_network *this, int reset, struct efi_mac_address *new_mac); efi_status_t (EFIAPI *statistics)(struct efi_simple_network *this, int reset, ulong *stat_size, void *stat_table); efi_status_t (EFIAPI *mcastiptomac)(struct efi_simple_network *this, int ipv6, struct efi_ip_address *ip, struct efi_mac_address *mac); efi_status_t (EFIAPI *nvdata)(struct efi_simple_network *this, int read_write, ulong offset, ulong buffer_size, char *buffer); efi_status_t (EFIAPI *get_status)(struct efi_simple_network *this, u32 *int_status, void **txbuf); efi_status_t (EFIAPI *transmit)(struct efi_simple_network *this, ulong header_size, ulong buffer_size, void *buffer, struct efi_mac_address *src_addr, struct efi_mac_address *dest_addr, u16 *protocol); efi_status_t (EFIAPI *receive)(struct efi_simple_network *this, ulong *header_size, ulong *buffer_size, void *buffer, struct efi_mac_address *src_addr, struct efi_mac_address *dest_addr, u16 *protocol); void (EFIAPI *waitforpacket)(void); struct efi_simple_network_mode *mode; }; #define EFI_PXE_GUID \ EFI_GUID(0x03c4e603, 0xac28, 0x11d3, \ 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d) struct efi_pxe_packet { u8 packet[1472]; }; struct efi_pxe_mode { u8 unused[52]; struct efi_pxe_packet dhcp_discover; struct efi_pxe_packet dhcp_ack; struct efi_pxe_packet proxy_offer; struct efi_pxe_packet pxe_discover; struct efi_pxe_packet pxe_reply; }; struct efi_pxe { u64 rev; void (EFIAPI *start)(void); void (EFIAPI *stop)(void); void (EFIAPI *dhcp)(void); void (EFIAPI *discover)(void); void (EFIAPI *mftp)(void); void (EFIAPI *udpwrite)(void); void (EFIAPI *udpread)(void); void (EFIAPI *setipfilter)(void); void (EFIAPI *arp)(void); void (EFIAPI *setparams)(void); void (EFIAPI *setstationip)(void); void (EFIAPI *setpackets)(void); struct efi_pxe_mode *mode; }; #endif