Merge tag 'efi-2020-01-rc2' of https://gitlab.denx.de/u-boot/custodians/u-boot-efi
[oweals/u-boot.git] / include / efi_api.h
index d4f32dbdc818f03f0b27447cdb1ee18da4a13e40..22396172e15f258155b6b3d9093985c10e85fd58 100644 (file)
@@ -238,8 +238,8 @@ struct efi_runtime_services {
        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,
+                       efi_uintn_t memory_map_size,
+                       efi_uintn_t descriptor_size,
                        uint32_t descriptor_version,
                        struct efi_mem_desc *virtmap);
        efi_status_t (EFIAPI *convert_pointer)(
@@ -422,6 +422,7 @@ struct efi_device_path_acpi_path {
 #  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_NVME                0x17
 #  define DEVICE_PATH_SUB_TYPE_MSG_SD          0x1a
 #  define DEVICE_PATH_SUB_TYPE_MSG_MMC         0x1d
 
@@ -464,6 +465,12 @@ struct efi_device_path_sd_mmc_path {
        u8 slot_number;
 } __packed;
 
+struct efi_device_path_nvme {
+       struct efi_device_path dp;
+       u32 ns_id;
+       u8 eui64[8];
+} __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
@@ -483,7 +490,7 @@ struct efi_device_path_cdrom_path {
        struct efi_device_path dp;
        u32 boot_entry;
        u64 partition_start;
-       u64 partition_end;
+       u64 partition_size;
 } __packed;
 
 struct efi_device_path_file_path {
@@ -1281,12 +1288,17 @@ struct efi_simple_network {
                        struct efi_mac_address *dest_addr, u16 *protocol);
        struct efi_event *wait_for_packet;
        struct efi_simple_network_mode *mode;
+       /* private fields */
+       u32 int_status;
 };
 
 #define EFI_PXE_BASE_CODE_PROTOCOL_GUID \
        EFI_GUID(0x03c4e603, 0xac28, 0x11d3, \
                 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
 
+#define EFI_PXE_BASE_CODE_PROTOCOL_REVISION 0x00010000
+#define EFI_PXE_BASE_CODE_MAX_IPCNT 8
+
 struct efi_pxe_packet {
        u8 packet[1472];
 };
@@ -1321,20 +1333,131 @@ struct efi_pxe_mode {
        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_base_code_srvlist {
+       u16 type;
+       u8 accept_any_response;
+       u8 reserved;
+       struct efi_ip_address ip_addr;
+};
+
+struct efi_pxe_base_code_discover_info {
+       u8 use_m_cast;
+       u8 use_b_cast;
+       u8 use_u_cast;
+       u8 must_use_list;
+       struct efi_ip_address server_m_cast_ip;
+       u16 ip_cnt;
+       struct efi_pxe_base_code_srvlist srv_list[];
+};
+
+struct efi_pxe_base_code_mtftp_info {
+       struct efi_ip_address m_cast_ip;
+       u16 cport;
+       u16 sport;
+       u16 listen_timeout;
+       u16 transit_timeout;
+};
+
+struct efi_pxe_base_code_filter {
+       u8 filters;
+       u8 ip_cnt;
+       u16 reserved;
+       struct efi_ip_address ip_list[EFI_PXE_BASE_CODE_MAX_IPCNT];
+};
+
+struct efi_pxe_base_code_dhcpv4_packet {
+       u8 bootp_op_code;
+       u8 bootp_hw_type;
+       u8 bootp_addr_len;
+       u8 bootp_gate_hops;
+       u32 bootp_ident;
+       u16 bootp_seconds;
+       u16 bootp_flags;
+       u8 bootp_ci_addr[4];
+       u8 bootp_yi_addr[4];
+       u8 bootp_si_addr[4];
+       u8 bootp_gi_addr[4];
+       u8 bootp_hw_addr[16];
+       u8 bootp_srv_name[64];
+       u8 bootp_boot_file[128];
+       u32 dhcp_magick;
+       u8 dhcp_options[56];
+};
+
+struct efi_pxe_base_code_dhcpv6_packet {
+       u8 message_type;
+       u8 transaction_id[3];
+       u8 dhcp_options[1024];
+};
+
+typedef union {
+       u8 raw[1472];
+       struct efi_pxe_base_code_dhcpv4_packet dhcpv4;
+       struct efi_pxe_base_code_dhcpv6_packet dhcpv6;
+} EFI_PXE_BASE_CODE_PACKET;
+
+struct efi_pxe_base_code_protocol {
+       u64 revision;
+       efi_status_t (EFIAPI *start)(struct efi_pxe_base_code_protocol *this,
+                                    u8 use_ipv6);
+       efi_status_t (EFIAPI *stop)(struct efi_pxe_base_code_protocol *this);
+       efi_status_t (EFIAPI *dhcp)(struct efi_pxe_base_code_protocol *this,
+                                   u8 sort_offers);
+       efi_status_t (EFIAPI *discover)(
+                               struct efi_pxe_base_code_protocol *this,
+                               u16 type, u16 *layer, u8 bis,
+                               struct efi_pxe_base_code_discover_info *info);
+       efi_status_t (EFIAPI *mtftp)(
+                               struct efi_pxe_base_code_protocol *this,
+                               u32 operation, void *buffer_ptr,
+                               u8 overwrite, efi_uintn_t *buffer_size,
+                               struct efi_ip_address server_ip, char *filename,
+                               struct efi_pxe_base_code_mtftp_info *info,
+                               u8 dont_use_buffer);
+       efi_status_t (EFIAPI *udp_write)(
+                               struct efi_pxe_base_code_protocol *this,
+                               u16 op_flags, struct efi_ip_address *dest_ip,
+                               u16 *dest_port,
+                               struct efi_ip_address *gateway_ip,
+                               struct efi_ip_address *src_ip, u16 *src_port,
+                               efi_uintn_t *header_size, void *header_ptr,
+                               efi_uintn_t *buffer_size, void *buffer_ptr);
+       efi_status_t (EFIAPI *udp_read)(
+                               struct efi_pxe_base_code_protocol *this,
+                               u16 op_flags, struct efi_ip_address *dest_ip,
+                               u16 *dest_port, struct efi_ip_address *src_ip,
+                               u16 *src_port, efi_uintn_t *header_size,
+                               void *header_ptr, efi_uintn_t *buffer_size,
+                               void *buffer_ptr);
+       efi_status_t (EFIAPI *set_ip_filter)(
+                               struct efi_pxe_base_code_protocol *this,
+                               struct efi_pxe_base_code_filter *new_filter);
+       efi_status_t (EFIAPI *arp)(struct efi_pxe_base_code_protocol *this,
+                                  struct efi_ip_address *ip_addr,
+                                  struct efi_mac_address *mac_addr);
+       efi_status_t (EFIAPI *set_parameters)(
+                               struct efi_pxe_base_code_protocol *this,
+                               u8 *new_auto_arp, u8 *new_send_guid,
+                               u8 *new_ttl, u8 *new_tos,
+                               u8 *new_make_callback);
+       efi_status_t (EFIAPI *set_station_ip)(
+                               struct efi_pxe_base_code_protocol *this,
+                               struct efi_ip_address *new_station_ip,
+                               struct efi_ip_address *new_subnet_mask);
+       efi_status_t (EFIAPI *set_packets)(
+                               struct efi_pxe_base_code_protocol *this,
+                               u8 *new_dhcp_discover_valid,
+                               u8 *new_dhcp_ack_received,
+                               u8 *new_proxy_offer_received,
+                               u8 *new_pxe_discover_valid,
+                               u8 *new_pxe_reply_received,
+                               u8 *new_pxe_bis_reply_received,
+                               EFI_PXE_BASE_CODE_PACKET *new_dchp_discover,
+                               EFI_PXE_BASE_CODE_PACKET *new_dhcp_acc,
+                               EFI_PXE_BASE_CODE_PACKET *new_proxy_offer,
+                               EFI_PXE_BASE_CODE_PACKET *new_pxe_discover,
+                               EFI_PXE_BASE_CODE_PACKET *new_pxe_reply,
+                               EFI_PXE_BASE_CODE_PACKET *new_pxe_bis_reply);
        struct efi_pxe_mode *mode;
 };
 
@@ -1345,6 +1468,12 @@ struct efi_pxe {
 #define EFI_FILE_PROTOCOL_REVISION2    0x00020000
 #define EFI_FILE_PROTOCOL_LATEST_REVISION EFI_FILE_PROTOCOL_REVISION2
 
+struct efi_file_io_token {
+       struct efi_event *event;
+       efi_status_t status;
+       efi_uintn_t buffer_size;
+       void *buffer;};
+
 struct efi_file_handle {
        u64 rev;
        efi_status_t (EFIAPI *open)(struct efi_file_handle *file,
@@ -1367,10 +1496,16 @@ struct efi_file_handle {
                        const efi_guid_t *info_type, efi_uintn_t buffer_size,
                        void *buffer);
        efi_status_t (EFIAPI *flush)(struct efi_file_handle *file);
-       /*
-        * TODO: We currently only support EFI file protocol revision 0x00010000
-        *       while UEFI specs 2.4 - 2.7 prescribe revision 0x00020000.
-        */
+       efi_status_t (EFIAPI *open_ex)(struct efi_file_handle *file,
+                       struct efi_file_handle **new_handle,
+                       u16 *file_name, u64 open_mode, u64 attributes,
+                       struct efi_file_io_token *token);
+       efi_status_t (EFIAPI *read_ex)(struct efi_file_handle *file,
+                       struct efi_file_io_token *token);
+       efi_status_t (EFIAPI *write_ex)(struct efi_file_handle *file,
+                       struct efi_file_io_token *token);
+       efi_status_t (EFIAPI *flush_ex)(struct efi_file_handle *file,
+                       struct efi_file_io_token *token);
 };
 
 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION 0x00010000
@@ -1389,6 +1524,10 @@ struct efi_simple_file_system_protocol {
        EFI_GUID(0x09576e93, 0x6d3f, 0x11d2, \
                 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 
+#define EFI_FILE_SYSTEM_VOLUME_LABEL_ID \
+       EFI_GUID(0xdb47d7d3, 0xfe81, 0x11d3, \
+                0x9a, 0x35, 0x00, 0x90, 0x27, 0x3f, 0xC1, 0x4d)
+
 #define EFI_FILE_MODE_READ     0x0000000000000001
 #define EFI_FILE_MODE_WRITE    0x0000000000000002
 #define EFI_FILE_MODE_CREATE   0x8000000000000000