Convert CONFIG_SYS_LOAD_ADDR to Kconfig
[platform/kernel/u-boot.git] / include / efi_api.h
index 5744f6a..c8f959b 100644 (file)
 #include <charset.h>
 #include <pe.h>
 
-#ifdef CONFIG_EFI_LOADER
-#include <asm/setjmp.h>
-#endif
-
 /* UEFI spec version 2.8 */
 #define EFI_SPECIFICATION_VERSION (2 << 16 | 80)
 
@@ -34,8 +30,6 @@ enum efi_timer_delay {
        EFI_TIMER_RELATIVE = 2
 };
 
-#define efi_intn_t ssize_t
-#define efi_uintn_t size_t
 typedef void *efi_hii_handle_t;
 typedef u16 *efi_string_t;
 typedef u16 efi_string_id_t;
@@ -217,6 +211,21 @@ enum efi_reset_type {
 #define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE    0x00020000
 #define CAPSULE_FLAGS_INITIATE_RESET           0x00040000
 
+#define CAPSULE_SUPPORT_AUTHENTICATION         0x0000000000000001
+#define CAPSULE_SUPPORT_DEPENDENCY             0x0000000000000002
+
+#define EFI_CAPSULE_REPORT_GUID \
+       EFI_GUID(0x39b68c46, 0xf7fb, 0x441b, 0xb6, 0xec, \
+                0x16, 0xb0, 0xf6, 0x98, 0x21, 0xf3)
+
+#define EFI_MEMORY_RANGE_CAPSULE_GUID \
+       EFI_GUID(0xde9f0ec, 0x88b6, 0x428f, 0x97, 0x7a, \
+                0x25, 0x8f, 0x1d, 0xe, 0x5e, 0x72)
+
+#define EFI_FIRMWARE_MANAGEMENT_CAPSULE_ID_GUID \
+       EFI_GUID(0x6dcbd5ed, 0xe82d, 0x4c44, 0xbd, 0xa1, \
+                0x71, 0x94, 0x19, 0x9a, 0xd9, 0x2a)
+
 struct efi_capsule_header {
        efi_guid_t capsule_guid;
        u32 header_size;
@@ -224,6 +233,54 @@ struct efi_capsule_header {
        u32 capsule_image_size;
 } __packed;
 
+struct efi_capsule_result_variable_header {
+       u32 variable_total_size;
+       u32 reserved;
+       efi_guid_t capsule_guid;
+       struct efi_time capsule_processed;
+       efi_status_t capsule_status;
+} __packed;
+
+struct efi_memory_range {
+       efi_physical_addr_t     address;
+       u64                     length;
+};
+
+struct efi_memory_range_capsule {
+       struct efi_capsule_header *header;
+       /* EFI_MEMORY_TYPE: 0x80000000-0xFFFFFFFF */
+       enum efi_memory_type os_requested_memory_type;
+       u64 number_of_memory_ranges;
+       struct efi_memory_range memory_ranges[];
+} __packed;
+
+struct efi_firmware_management_capsule_header {
+       u32 version;
+       u16 embedded_driver_count;
+       u16 payload_item_count;
+       u64 item_offset_list[];
+} __packed;
+
+struct efi_firmware_management_capsule_image_header {
+       u32 version;
+       efi_guid_t update_image_type_id;
+       u8 update_image_index;
+       u8 reserved[3];
+       u32 update_image_size;
+       u32 update_vendor_code_size;
+       u64 update_hardware_instance;
+       u64 image_capsule_support;
+} __packed;
+
+struct efi_capsule_result_variable_fmp {
+       u16 version;
+       u8 payload_index;
+       u8 update_image_index;
+       efi_guid_t update_image_type_id;
+       // u16 capsule_file_name[];
+       // u16 capsule_target[];
+} __packed;
+
 #define EFI_RT_SUPPORTED_GET_TIME                      0x0001
 #define EFI_RT_SUPPORTED_SET_TIME                      0x0002
 #define EFI_RT_SUPPORTED_GET_WAKEUP_TIME               0x0004
@@ -356,6 +413,10 @@ struct efi_runtime_services {
        EFI_GUID(0x4006c0c1, 0xfcb3, 0x403e, \
                 0x99, 0x6d, 0x4a, 0x6c, 0x87, 0x24, 0xe0, 0x6d)
 
+#define EFI_TCG2_FINAL_EVENTS_TABLE_GUID \
+       EFI_GUID(0x1e2ed096, 0x30e2, 0x4254, 0xbd, \
+                0x89, 0x86, 0x3b, 0xbe, 0xf8, 0x23, 0x25)
+
 struct efi_configuration_table {
        efi_guid_t guid;
        void *table;
@@ -458,9 +519,11 @@ struct efi_device_path_acpi_path {
 #  define DEVICE_PATH_SUB_TYPE_MSG_SCSI                0x02
 #  define DEVICE_PATH_SUB_TYPE_MSG_USB         0x05
 #  define DEVICE_PATH_SUB_TYPE_MSG_MAC_ADDR    0x0b
+#  define DEVICE_PATH_SUB_TYPE_MSG_UART                0x0e
 #  define DEVICE_PATH_SUB_TYPE_MSG_USB_CLASS   0x0f
 #  define DEVICE_PATH_SUB_TYPE_MSG_SATA                0x12
 #  define DEVICE_PATH_SUB_TYPE_MSG_NVME                0x17
+#  define DEVICE_PATH_SUB_TYPE_MSG_URI         0x18
 #  define DEVICE_PATH_SUB_TYPE_MSG_SD          0x1a
 #  define DEVICE_PATH_SUB_TYPE_MSG_MMC         0x1d
 
@@ -477,6 +540,15 @@ struct efi_device_path_scsi {
        u16 logical_unit_number;
 } __packed;
 
+struct efi_device_path_uart {
+       struct efi_device_path dp;
+       u32 reserved;
+       u64 baud_rate;
+       u8 data_bits;
+       u8 parity;
+       u8 stop_bits;
+} __packed;
+
 struct efi_device_path_usb {
        struct efi_device_path dp;
        u8 parent_port_number;
@@ -516,6 +588,11 @@ struct efi_device_path_nvme {
        u8 eui64[8];
 } __packed;
 
+struct efi_device_path_uri {
+       struct efi_device_path dp;
+       u8 uri[];
+} __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
@@ -636,10 +713,10 @@ struct efi_simple_text_output_protocol {
                        char extended_verification);
        efi_status_t (EFIAPI *output_string)(
                        struct efi_simple_text_output_protocol *this,
-                       const efi_string_t str);
+                       const u16 *str);
        efi_status_t (EFIAPI *test_string)(
                        struct efi_simple_text_output_protocol *this,
-                       const efi_string_t str);
+                       const u16 *str);
        efi_status_t(EFIAPI *query_mode)(
                        struct efi_simple_text_output_protocol *this,
                        unsigned long mode_number, unsigned long *columns,
@@ -1522,35 +1599,35 @@ struct efi_file_io_token {
 
 struct efi_file_handle {
        u64 rev;
-       efi_status_t (EFIAPI *open)(struct efi_file_handle *file,
+       efi_status_t (EFIAPI *open)(struct efi_file_handle *this,
                        struct efi_file_handle **new_handle,
                        u16 *file_name, u64 open_mode, u64 attributes);
-       efi_status_t (EFIAPI *close)(struct efi_file_handle *file);
-       efi_status_t (EFIAPI *delete)(struct efi_file_handle *file);
-       efi_status_t (EFIAPI *read)(struct efi_file_handle *file,
+       efi_status_t (EFIAPI *close)(struct efi_file_handle *this);
+       efi_status_t (EFIAPI *delete)(struct efi_file_handle *this);
+       efi_status_t (EFIAPI *read)(struct efi_file_handle *this,
                        efi_uintn_t *buffer_size, void *buffer);
-       efi_status_t (EFIAPI *write)(struct efi_file_handle *file,
+       efi_status_t (EFIAPI *write)(struct efi_file_handle *this,
                        efi_uintn_t *buffer_size, void *buffer);
-       efi_status_t (EFIAPI *getpos)(struct efi_file_handle *file,
+       efi_status_t (EFIAPI *getpos)(struct efi_file_handle *this,
                                      u64 *pos);
-       efi_status_t (EFIAPI *setpos)(struct efi_file_handle *file,
+       efi_status_t (EFIAPI *setpos)(struct efi_file_handle *this,
                                      u64 pos);
-       efi_status_t (EFIAPI *getinfo)(struct efi_file_handle *file,
+       efi_status_t (EFIAPI *getinfo)(struct efi_file_handle *this,
                        const efi_guid_t *info_type, efi_uintn_t *buffer_size,
                        void *buffer);
-       efi_status_t (EFIAPI *setinfo)(struct efi_file_handle *file,
+       efi_status_t (EFIAPI *setinfo)(struct efi_file_handle *this,
                        const efi_guid_t *info_type, efi_uintn_t buffer_size,
                        void *buffer);
-       efi_status_t (EFIAPI *flush)(struct efi_file_handle *file);
-       efi_status_t (EFIAPI *open_ex)(struct efi_file_handle *file,
+       efi_status_t (EFIAPI *flush)(struct efi_file_handle *this);
+       efi_status_t (EFIAPI *open_ex)(struct efi_file_handle *this,
                        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,
+       efi_status_t (EFIAPI *read_ex)(struct efi_file_handle *this,
                        struct efi_file_io_token *token);
-       efi_status_t (EFIAPI *write_ex)(struct efi_file_handle *file,
+       efi_status_t (EFIAPI *write_ex)(struct efi_file_handle *this,
                        struct efi_file_io_token *token);
-       efi_status_t (EFIAPI *flush_ex)(struct efi_file_handle *file,
+       efi_status_t (EFIAPI *flush_ex)(struct efi_file_handle *this,
                        struct efi_file_io_token *token);
 };
 
@@ -1628,10 +1705,6 @@ struct efi_driver_binding_protocol {
        efi_handle_t driver_binding_handle;
 };
 
-/* Deprecated version of the Unicode collation protocol */
-#define EFI_UNICODE_COLLATION_PROTOCOL_GUID \
-       EFI_GUID(0x1d85cd7f, 0xf43d, 0x11d2, \
-                0x9a, 0x0c, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
 /* Current version of the Unicode collation protocol */
 #define EFI_UNICODE_COLLATION_PROTOCOL2_GUID \
        EFI_GUID(0xa4c751fc, 0x23ae, 0x4c3e, \
@@ -1661,6 +1734,23 @@ struct efi_load_file_protocol {
                                         void *buffer);
 };
 
+struct efi_system_resource_entry {
+       efi_guid_t fw_class;
+       u32 fw_type;
+       u32 fw_version;
+       u32 lowest_supported_fw_version;
+       u32 capsule_flags;
+       u32 last_attempt_version;
+       u32 last_attempt_status;
+} __packed;
+
+struct efi_system_resource_table {
+       u32 fw_resource_count;
+       u32 fw_resource_count_max;
+       u64 fw_resource_version;
+       struct efi_system_resource_entry entries[];
+} __packed;
+
 /* Boot manager load options */
 #define LOAD_OPTION_ACTIVE             0x00000001
 #define LOAD_OPTION_FORCE_RECONNECT    0x00000002
@@ -1679,6 +1769,10 @@ struct efi_load_file_protocol {
 #define ESRT_FW_TYPE_DEVICEFIRMWARE    0x00000002
 #define ESRT_FW_TYPE_UEFIDRIVER                0x00000003
 
+#define EFI_SYSTEM_RESOURCE_TABLE_GUID\
+       EFI_GUID(0xb122a263, 0x3661, 0x4f68,\
+               0x99, 0x29, 0x78, 0xf8, 0xb0, 0xd6, 0x21, 0x80)
+
 /* Last Attempt Status Values */
 #define LAST_ATTEMPT_STATUS_SUCCESS                    0x00000000
 #define LAST_ATTEMPT_STATUS_ERROR_UNSUCCESSFUL         0x00000001
@@ -1746,6 +1840,24 @@ struct efi_variable_authentication_2 {
 } __attribute__((__packed__));
 
 /**
+ * efi_firmware_image_authentication - Capsule authentication method
+ * descriptor
+ *
+ * This structure describes an authentication information for
+ * a capsule with IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED set
+ * and should be included as part of the capsule.
+ * Only EFI_CERT_TYPE_PKCS7_GUID is accepted.
+ *
+ * @monotonic_count: Count to prevent replay
+ * @auth_info: Authentication info
+ */
+struct efi_firmware_image_authentication {
+       uint64_t monotonic_count;
+       struct win_certificate_uefi_guid auth_info;
+} __attribute__((__packed__));
+
+
+/**
  * efi_signature_data - A format of signature
  *
  * This structure describes a single signature in signature database.
@@ -1779,4 +1891,107 @@ struct efi_signature_list {
 /*     struct efi_signature_data signatures[...][signature_size]; */
 } __attribute__((__packed__));
 
+/*
+ * Firmware management protocol
+ */
+#define EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GUID \
+       EFI_GUID(0x86c77a67, 0x0b97, 0x4633, 0xa1, 0x87, \
+                0x49, 0x10, 0x4d, 0x06, 0x85, 0xc7)
+
+#define EFI_FIRMWARE_IMAGE_TYPE_UBOOT_FIT_GUID \
+       EFI_GUID(0xae13ff2d, 0x9ad4, 0x4e25, 0x9a, 0xc8, \
+                0x6d, 0x80, 0xb3, 0xb2, 0x21, 0x47)
+
+#define EFI_FIRMWARE_IMAGE_TYPE_UBOOT_RAW_GUID \
+       EFI_GUID(0xe2bb9c06, 0x70e9, 0x4b14, 0x97, 0xa3, \
+                0x5a, 0x79, 0x13, 0x17, 0x6e, 0x3f)
+
+#define IMAGE_ATTRIBUTE_IMAGE_UPDATABLE                0x0000000000000001
+#define IMAGE_ATTRIBUTE_RESET_REQUIRED         0x0000000000000002
+#define IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED        0x0000000000000004
+#define IMAGE_ATTRIBUTE_IN_USE                 0x0000000000000008
+#define IMAGE_ATTRIBUTE_UEFI_IMAGE             0x0000000000000010
+#define IMAGE_ATTRIBUTE_DEPENDENCY             0x0000000000000020
+
+#define IMAGE_COMPATIBILITY_CHECK_SUPPORTED    0x0000000000000001
+
+#define IMAGE_UPDATABLE_VALID                  0x0000000000000001
+#define IMAGE_UPDATABLE_INVALID                        0x0000000000000002
+#define IMAGE_UPDATABLE_INVALID_TYPE           0x0000000000000004
+#define IMAGE_UPDATABLE_INVALID_OLLD           0x0000000000000008
+#define IMAGE_UPDATABLE_VALID_WITH_VENDOR_CODE 0x0000000000000010
+
+#define PACKAGE_ATTRIBUTE_VERSION_UPDATABLE            0x0000000000000001
+#define PACKAGE_ATTRIBUTE_RESET_REQUIRED               0x0000000000000002
+#define PACKAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED      0x0000000000000004
+
+#define EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION  4
+
+typedef struct efi_firmware_image_dependencies {
+       u8 dependencies[0];
+} efi_firmware_image_dep_t;
+
+struct efi_firmware_image_descriptor {
+       u8 image_index;
+       efi_guid_t image_type_id;
+       u64 image_id;
+       u16 *image_id_name;
+       u32 version;
+       u16 *version_name;
+       efi_uintn_t size;
+       u64 attributes_supported;
+       u64 attributes_setting;
+       u64 compatibilities;
+       u32 lowest_supported_image_version;
+       u32 last_attempt_version;
+       u32 last_attempt_status;
+       u64 hardware_instance;
+       efi_firmware_image_dep_t *dependencies;
+};
+
+struct efi_firmware_management_protocol {
+       efi_status_t (EFIAPI *get_image_info)(
+                       struct efi_firmware_management_protocol *this,
+                       efi_uintn_t *image_info_size,
+                       struct efi_firmware_image_descriptor *image_info,
+                       u32 *descriptor_version,
+                       u8 *descriptor_count,
+                       efi_uintn_t *descriptor_size,
+                       u32 *package_version,
+                       u16 **package_version_name);
+       efi_status_t (EFIAPI *get_image)(
+                       struct efi_firmware_management_protocol *this,
+                       u8 image_index,
+                       void *image,
+                       efi_uintn_t *image_size);
+       efi_status_t (EFIAPI *set_image)(
+                       struct efi_firmware_management_protocol *this,
+                       u8 image_index,
+                       const void *image,
+                       efi_uintn_t image_size,
+                       const void *vendor_code,
+                       efi_status_t (*progress)(efi_uintn_t completion),
+                       u16 **abort_reason);
+       efi_status_t (EFIAPI *check_image)(
+                       struct efi_firmware_management_protocol *this,
+                       u8 image_index,
+                       const void *image,
+                       efi_uintn_t *image_size,
+                       u32 *image_updatable);
+       efi_status_t (EFIAPI *get_package_info)(
+                       struct efi_firmware_management_protocol *this,
+                       u32 *package_version,
+                       u16 **package_version_name,
+                       u32 *package_version_name_maxlen,
+                       u64 *attributes_supported,
+                       u64 *attributes_setting);
+       efi_status_t (EFIAPI *set_package_info)(
+                       struct efi_firmware_management_protocol *this,
+                       const void *image,
+                       efi_uintn_t *image_size,
+                       const void *vendor_code,
+                       u32 package_version,
+                       const u16 *package_version_name);
+};
+
 #endif