[u-boot.git] / include / efi_tcg2.h

/* SPDX-License-Identifier: GPL-2.0+ */
/*
 * Defines data structures and APIs that allow an OS to interact with UEFI
 * firmware to query information about the device
 *
 * This file refers the following TCG specification.
 *  - TCG PC Client Platform Firmware Profile Specification
 *    https://trustedcomputinggroup.org/resource/pc-client-specific-platform-firmware-profile-specification/
 *
 *  - TCG EFI Protocol Specification
 *    https://trustedcomputinggroup.org/resource/tcg-efi-protocol-specification/
 *
 * Copyright (c) 2020, Linaro Limited
 */

#if !defined _EFI_TCG2_PROTOCOL_H_
#define _EFI_TCG2_PROTOCOL_H_

#include <efi_api.h>
#include <tpm-v2.h>

#define EFI_TCG2_PROTOCOL_GUID \
	EFI_GUID(0x607f766c, 0x7455, 0x42be, 0x93, \
		 0x0b, 0xe4, 0xd7, 0x6d, 0xb2, 0x72, 0x0f)

/* TPMV2 only */
#define TCG2_EVENT_LOG_FORMAT_TCG_2 0x00000002
#define EFI_TCG2_EXTEND_ONLY 0x0000000000000001
#define PE_COFF_IMAGE 0x0000000000000010

#define EFI_TCG2_MAX_PCR_INDEX 23

/* Algorithm Registry */
#define EFI_TCG2_BOOT_HASH_ALG_SHA1    0x00000001
#define EFI_TCG2_BOOT_HASH_ALG_SHA256  0x00000002
#define EFI_TCG2_BOOT_HASH_ALG_SHA384  0x00000004
#define EFI_TCG2_BOOT_HASH_ALG_SHA512  0x00000008
#define EFI_TCG2_BOOT_HASH_ALG_SM3_256 0x00000010

#define EFI_TCG2_FINAL_EVENTS_TABLE_VERSION 1

#define TPM2_EVENT_LOG_SIZE CONFIG_EFI_TCG2_PROTOCOL_EVENTLOG_SIZE

typedef u32 efi_tcg_event_log_bitmap;
typedef u32 efi_tcg_event_log_format;
typedef u32 efi_tcg_event_algorithm_bitmap;

/**
 * struct tdEFI_TCG2_VERSION - structure of EFI TCG2 version
 * @major:	major version
 * @minor:	minor version
 */
struct efi_tcg2_version {
	u8 major;
	u8 minor;
};

/**
 * struct tdEFI_TCG2_EVENT_HEADER - structure of EFI TCG2 event header
 * @header_size:	size of the event header
 * @header_version:	header version
 * @pcr_index:		index of the PCR that is extended
 * @event_type:		type of the event that is extended
 */
struct efi_tcg2_event_header {
	u32 header_size;
	u16 header_version;
	u32 pcr_index;
	u32 event_type;
} __packed;

/**
 * struct tdEFI_TCG2_EVENT - structure of EFI TCG2 event
 * @size:	total size of the event including the size component, the header
 *		and the event data
 * @header:	event header
 * @event:	event to add
 */
struct efi_tcg2_event {
	u32 size;
	struct efi_tcg2_event_header header;
	u8 event[];
} __packed;

/**
 * struct tdUEFI_IMAGE_LOAD_EVENT - structure of PE/COFF image measurement
 * @image_location_in_memory:	image address
 * @image_length_in_memory:	image size
 * @image_link_time_address:	image link time address
 * @length_of_device_path:	devive path size
 * @device_path:		device path
 */
struct uefi_image_load_event {
	efi_physical_addr_t image_location_in_memory;
	u64 image_length_in_memory;
	u64 image_link_time_address;
	u64 length_of_device_path;
	struct efi_device_path device_path[];
};

/**
 * struct tdEFI_TCG2_BOOT_SERVICE_CAPABILITY - protocol capability information
 * @size:			allocated size of the structure
 * @structure_version:		version of this structure
 * @protocol_version:		version of the EFI TCG2 protocol.
 * @hash_algorithm_bitmap:	supported hash algorithms
 * @supported_event_logs:	bitmap of supported event log formats
 * @tpm_present_flag:		false = TPM not present
 * @max_command_size:		max size (in bytes) of a command
 *				that can be sent to the TPM
 * @max_response_size:		max size (in bytes) of a response that
 *				can be provided by the TPM
 * @manufacturer_id:		4-byte Vendor ID
 * @number_of_pcr_banks:	maximum number of PCR banks
 * @active_pcr_banks:		bitmap of currently active
 *				PCR banks (hashing algorithms).
 */
struct efi_tcg2_boot_service_capability {
	u8 size;
	struct efi_tcg2_version structure_version;
	struct efi_tcg2_version protocol_version;
	efi_tcg_event_algorithm_bitmap hash_algorithm_bitmap;
	efi_tcg_event_log_bitmap supported_event_logs;
	u8 tpm_present_flag;
	u16 max_command_size;
	u16 max_response_size;
	u32 manufacturer_id;
	u32 number_of_pcr_banks;
	efi_tcg_event_algorithm_bitmap active_pcr_banks;
};

/* up to and including the vendor ID (manufacturer_id) field */
#define BOOT_SERVICE_CAPABILITY_MIN \
	offsetof(struct efi_tcg2_boot_service_capability, number_of_pcr_banks)

#define TCG_EFI_SPEC_ID_EVENT_SIGNATURE_03 "Spec ID Event03"
#define TCG_EFI_SPEC_ID_EVENT_SPEC_VERSION_MAJOR_TPM2 2
#define TCG_EFI_SPEC_ID_EVENT_SPEC_VERSION_MINOR_TPM2 0
#define TCG_EFI_SPEC_ID_EVENT_SPEC_VERSION_ERRATA_TPM2 2

/**
 *  struct TCG_EfiSpecIdEventAlgorithmSize - hashing algorithm information
 *
 *  @algorithm_id:	algorithm defined in enum tpm2_algorithms
 *  @digest_size:	size of the algorithm
 */
struct tcg_efi_spec_id_event_algorithm_size {
	u16      algorithm_id;
	u16      digest_size;
} __packed;

/**
 * struct TCG_EfiSpecIDEventStruct - content of the event log header
 *
 * @signature:			signature, set to Spec ID Event03
 * @platform_class:		class defined in TCG ACPI Specification
 *				Client  Common Header.
 * @spec_version_minor:		minor version
 * @spec_version_major:		major version
 * @spec_version_errata:	major version
 * @uintn_size:			size of the efi_uintn_t fields used in various
 *				data structures used in this specification.
 *				0x01 indicates u32  and 0x02  indicates u64
 * @number_of_algorithms:	hashing algorithms used in this event log
 * @digest_sizes:		array of number_of_algorithms pairs
 *				1st member defines the algorithm id
 *				2nd member defines the algorithm size
 */
struct tcg_efi_spec_id_event {
	u8 signature[16];
	u32 platform_class;
	u8 spec_version_minor;
	u8 spec_version_major;
	u8 spec_errata;
	u8 uintn_size;
	u32 number_of_algorithms;
	struct tcg_efi_spec_id_event_algorithm_size digest_sizes[];
} __packed;

/**
 * struct tdEFI_TCG2_FINAL_EVENTS_TABLE - log entries after Get Event Log
 * @version:		version number for this structure
 * @number_of_events:	number of events recorded after invocation of
 *			GetEventLog()
 * @event:		List of events of type tcg_pcr_event2
 */
struct efi_tcg2_final_events_table {
	u64 version;
	u64 number_of_events;
	struct tcg_pcr_event2 event[];
};

/**
 * struct tdUEFI_VARIABLE_DATA - event log structure of UEFI variable
 * @variable_name:		The vendorGUID parameter in the
 *				GetVariable() API.
 * @unicode_name_length:	The length in CHAR16 of the Unicode name of
 *				the variable.
 * @variable_data_length:	The size of the variable data.
 * @unicode_name:		The CHAR16 unicode name of the variable
 *				without NULL-terminator.
 * @variable_data:		The data parameter of the efi variable
 *				in the GetVariable() API.
 */
struct efi_tcg2_uefi_variable_data {
	efi_guid_t variable_name;
	u64 unicode_name_length;
	u64 variable_data_length;
	u16 unicode_name[1];
	u8 variable_data[1];
};

/**
 * struct tdUEFI_HANDOFF_TABLE_POINTERS2 - event log structure of SMBOIS tables
 * @table_description_size:	size of table description
 * @table_description:		table description
 * @number_of_tables:		number of uefi configuration table
 * @table_entry:		uefi configuration table entry
 */
#define SMBIOS_HANDOFF_TABLE_DESC  "SmbiosTable"
struct smbios_handoff_table_pointers2 {
	u8 table_description_size;
	u8 table_description[sizeof(SMBIOS_HANDOFF_TABLE_DESC)];
	u64 number_of_tables;
	struct efi_configuration_table table_entry[];
} __packed;

/**
 * struct tdUEFI_GPT_DATA - event log structure of industry standard tables
 * @uefi_partition_header:	gpt partition header
 * @number_of_partitions:	the number of partition
 * @partitions:			partition entries
 */
struct efi_gpt_data {
	gpt_header uefi_partition_header;
	u64 number_of_partitions;
	gpt_entry partitions[];
} __packed;

struct efi_tcg2_protocol {
	efi_status_t (EFIAPI * get_capability)(struct efi_tcg2_protocol *this,
					       struct efi_tcg2_boot_service_capability *capability);
	efi_status_t (EFIAPI * get_eventlog)(struct efi_tcg2_protocol *this,
					     efi_tcg_event_log_format log_format,
					     u64 *event_log_location, u64 *event_log_last_entry,
					     bool *event_log_truncated);
	efi_status_t (EFIAPI * hash_log_extend_event)(struct efi_tcg2_protocol *this,
						      u64 flags,
						      efi_physical_addr_t data_to_hash,
						      u64 data_to_hash_len,
						      struct efi_tcg2_event *efi_tcg_event);
	efi_status_t (EFIAPI * submit_command)(struct efi_tcg2_protocol *this,
					       u32 input_parameter_block_size,
					       u8 *input_parameter_block,
					       u32 output_parameter_block_size,
					       u8 *output_parameter_block);
	efi_status_t (EFIAPI * get_active_pcr_banks)(struct efi_tcg2_protocol *this,
						     u32 *active_pcr_banks);
	efi_status_t (EFIAPI * set_active_pcr_banks)(struct efi_tcg2_protocol *this,
						     u32 active_pcr_banks);
	efi_status_t (EFIAPI * get_result_of_set_active_pcr_banks)(struct efi_tcg2_protocol *this,
								   u32 *operation_present,
								   u32 *response);
};
#endif
Commit	Line	Data
c1c02105 IA	1	/* SPDX-License-Identifier: GPL-2.0+ */
	2	/*
	3	* Defines data structures and APIs that allow an OS to interact with UEFI
	4	* firmware to query information about the device
	5	*
7685d17b MK	6	* This file refers the following TCG specification.
	7	* - TCG PC Client Platform Firmware Profile Specification
	8	* https://trustedcomputinggroup.org/resource/pc-client-specific-platform-firmware-profile-specification/
	9	*
	10	* - TCG EFI Protocol Specification
	11	* https://trustedcomputinggroup.org/resource/tcg-efi-protocol-specification/
	12	*
c1c02105 IA	13	* Copyright (c) 2020, Linaro Limited
	14	*/
	15
	16	#if !defined _EFI_TCG2_PROTOCOL_H_
	17	#define _EFI_TCG2_PROTOCOL_H_
	18
163a0d7e	19	#include <efi_api.h>
c1c02105 IA	20	#include <tpm-v2.h>
	21
	22	#define EFI_TCG2_PROTOCOL_GUID \
	23	EFI_GUID(0x607f766c, 0x7455, 0x42be, 0x93, \
	24	0x0b, 0xe4, 0xd7, 0x6d, 0xb2, 0x72, 0x0f)
	25
	26	/* TPMV2 only */
	27	#define TCG2_EVENT_LOG_FORMAT_TCG_2 0x00000002
c8d0fd58 IA	28	#define EFI_TCG2_EXTEND_ONLY 0x0000000000000001
c8d0fd58 IA	29	#define PE_COFF_IMAGE 0x0000000000000010
c1c02105	30
538c0f2d MK	31	#define EFI_TCG2_MAX_PCR_INDEX 23
538c0f2d MK	32
c1c02105 IA	33	/* Algorithm Registry */
	34	#define EFI_TCG2_BOOT_HASH_ALG_SHA1 0x00000001
	35	#define EFI_TCG2_BOOT_HASH_ALG_SHA256 0x00000002
	36	#define EFI_TCG2_BOOT_HASH_ALG_SHA384 0x00000004
	37	#define EFI_TCG2_BOOT_HASH_ALG_SHA512 0x00000008
	38	#define EFI_TCG2_BOOT_HASH_ALG_SM3_256 0x00000010
	39
c8d0fd58 IA	40	#define EFI_TCG2_FINAL_EVENTS_TABLE_VERSION 1
	41
	42	#define TPM2_EVENT_LOG_SIZE CONFIG_EFI_TCG2_PROTOCOL_EVENTLOG_SIZE
	43
c1c02105 IA	44	typedef u32 efi_tcg_event_log_bitmap;
	45	typedef u32 efi_tcg_event_log_format;
	46	typedef u32 efi_tcg_event_algorithm_bitmap;
	47
7685d17b MK	48	/**
	49	* struct tdEFI_TCG2_VERSION - structure of EFI TCG2 version
	50	* @major: major version
	51	* @minor: minor version
	52	*/
c1c02105 IA	53	struct efi_tcg2_version {
	54	u8 major;
	55	u8 minor;
	56	};
	57
7685d17b MK	58	/**
	59	* struct tdEFI_TCG2_EVENT_HEADER - structure of EFI TCG2 event header
	60	* @header_size: size of the event header
	61	* @header_version: header version
	62	* @pcr_index: index of the PCR that is extended
	63	* @event_type: type of the event that is extended
	64	*/
c1c02105 IA	65	struct efi_tcg2_event_header {
	66	u32 header_size;
	67	u16 header_version;
	68	u32 pcr_index;
	69	u32 event_type;
	70	} __packed;
	71
7685d17b MK	72	/**
	73	* struct tdEFI_TCG2_EVENT - structure of EFI TCG2 event
	74	* @size: total size of the event including the size component, the header
	75	* and the event data
	76	* @header: event header
	77	* @event: event to add
	78	*/
c1c02105 IA	79	struct efi_tcg2_event {
	80	u32 size;
	81	struct efi_tcg2_event_header header;
	82	u8 event[];
	83	} __packed;
	84
7685d17b MK	85	/**
	86	* struct tdUEFI_IMAGE_LOAD_EVENT - structure of PE/COFF image measurement
	87	* @image_location_in_memory: image address
	88	* @image_length_in_memory: image size
	89	* @image_link_time_address: image link time address
	90	* @length_of_device_path: devive path size
	91	* @device_path: device path
	92	*/
163a0d7e MK	93	struct uefi_image_load_event {
	94	efi_physical_addr_t image_location_in_memory;
	95	u64 image_length_in_memory;
	96	u64 image_link_time_address;
	97	u64 length_of_device_path;
	98	struct efi_device_path device_path[];
	99	};
	100
7685d17b MK	101	/**
	102	* struct tdEFI_TCG2_BOOT_SERVICE_CAPABILITY - protocol capability information
	103	* @size: allocated size of the structure
	104	* @structure_version: version of this structure
	105	* @protocol_version: version of the EFI TCG2 protocol.
	106	* @hash_algorithm_bitmap: supported hash algorithms
	107	* @supported_event_logs: bitmap of supported event log formats
	108	* @tpm_present_flag: false = TPM not present
	109	* @max_command_size: max size (in bytes) of a command
	110	* that can be sent to the TPM
	111	* @max_response_size: max size (in bytes) of a response that
	112	* can be provided by the TPM
	113	* @manufacturer_id: 4-byte Vendor ID
	114	* @number_of_pcr_banks: maximum number of PCR banks
	115	* @active_pcr_banks: bitmap of currently active
	116	* PCR banks (hashing algorithms).
	117	*/
c1c02105 IA	118	struct efi_tcg2_boot_service_capability {
	119	u8 size;
	120	struct efi_tcg2_version structure_version;
	121	struct efi_tcg2_version protocol_version;
	122	efi_tcg_event_algorithm_bitmap hash_algorithm_bitmap;
	123	efi_tcg_event_log_bitmap supported_event_logs;
	124	u8 tpm_present_flag;
	125	u16 max_command_size;
	126	u16 max_response_size;
	127	u32 manufacturer_id;
	128	u32 number_of_pcr_banks;
	129	efi_tcg_event_algorithm_bitmap active_pcr_banks;
	130	};
	131
db3ed2cf	132	/* up to and including the vendor ID (manufacturer_id) field */
bad49da2	133	#define BOOT_SERVICE_CAPABILITY_MIN \
c1c02105 IA	134	offsetof(struct efi_tcg2_boot_service_capability, number_of_pcr_banks)
c1c02105 IA	135
c8d0fd58 IA	136	#define TCG_EFI_SPEC_ID_EVENT_SIGNATURE_03 "Spec ID Event03"
	137	#define TCG_EFI_SPEC_ID_EVENT_SPEC_VERSION_MAJOR_TPM2 2
	138	#define TCG_EFI_SPEC_ID_EVENT_SPEC_VERSION_MINOR_TPM2 0
	139	#define TCG_EFI_SPEC_ID_EVENT_SPEC_VERSION_ERRATA_TPM2 2
	140
	141	/**
7685d17b	142	* struct TCG_EfiSpecIdEventAlgorithmSize - hashing algorithm information
c8d0fd58 IA	143	*
	144	* @algorithm_id: algorithm defined in enum tpm2_algorithms
	145	* @digest_size: size of the algorithm
	146	*/
	147	struct tcg_efi_spec_id_event_algorithm_size {
	148	u16 algorithm_id;
	149	u16 digest_size;
	150	} __packed;
	151
	152	/**
7685d17b	153	* struct TCG_EfiSpecIDEventStruct - content of the event log header
c8d0fd58 IA	154	*
	155	* @signature: signature, set to Spec ID Event03
	156	* @platform_class: class defined in TCG ACPI Specification
	157	* Client Common Header.
	158	* @spec_version_minor: minor version
	159	* @spec_version_major: major version
	160	* @spec_version_errata: major version
	161	* @uintn_size: size of the efi_uintn_t fields used in various
	162	* data structures used in this specification.
	163	* 0x01 indicates u32 and 0x02 indicates u64
	164	* @number_of_algorithms: hashing algorithms used in this event log
	165	* @digest_sizes: array of number_of_algorithms pairs
	166	* 1st member defines the algorithm id
	167	* 2nd member defines the algorithm size
c8d0fd58 IA	168	*/
	169	struct tcg_efi_spec_id_event {
	170	u8 signature[16];
	171	u32 platform_class;
	172	u8 spec_version_minor;
	173	u8 spec_version_major;
	174	u8 spec_errata;
	175	u8 uintn_size;
	176	u32 number_of_algorithms;
346cee3a	177	struct tcg_efi_spec_id_event_algorithm_size digest_sizes[];
c8d0fd58 IA	178	} __packed;
	179
	180	/**
7685d17b	181	* struct tdEFI_TCG2_FINAL_EVENTS_TABLE - log entries after Get Event Log
c8d0fd58 IA	182	* @version: version number for this structure
	183	* @number_of_events: number of events recorded after invocation of
	184	* GetEventLog()
	185	* @event: List of events of type tcg_pcr_event2
	186	*/
	187	struct efi_tcg2_final_events_table {
	188	u64 version;
	189	u64 number_of_events;
	190	struct tcg_pcr_event2 event[];
	191	};
	192
cfbcf054 MK	193	/**
	194	* struct tdUEFI_VARIABLE_DATA - event log structure of UEFI variable
	195	* @variable_name: The vendorGUID parameter in the
	196	* GetVariable() API.
	197	* @unicode_name_length: The length in CHAR16 of the Unicode name of
	198	* the variable.
	199	* @variable_data_length: The size of the variable data.
	200	* @unicode_name: The CHAR16 unicode name of the variable
	201	* without NULL-terminator.
	202	* @variable_data: The data parameter of the efi variable
	203	* in the GetVariable() API.
	204	*/
	205	struct efi_tcg2_uefi_variable_data {
	206	efi_guid_t variable_name;
	207	u64 unicode_name_length;
	208	u64 variable_data_length;
	209	u16 unicode_name[1];
	210	u8 variable_data[1];
	211	};
	212
3d49ee85 MK	213	/**
	214	* struct tdUEFI_HANDOFF_TABLE_POINTERS2 - event log structure of SMBOIS tables
	215	* @table_description_size: size of table description
	216	* @table_description: table description
	217	* @number_of_tables: number of uefi configuration table
	218	* @table_entry: uefi configuration table entry
	219	*/
	220	#define SMBIOS_HANDOFF_TABLE_DESC "SmbiosTable"
	221	struct smbios_handoff_table_pointers2 {
	222	u8 table_description_size;
	223	u8 table_description[sizeof(SMBIOS_HANDOFF_TABLE_DESC)];
	224	u64 number_of_tables;
	225	struct efi_configuration_table table_entry[];
	226	} __packed;
	227
ce3dbc5d MK	228	/**
	229	* struct tdUEFI_GPT_DATA - event log structure of industry standard tables
	230	* @uefi_partition_header: gpt partition header
	231	* @number_of_partitions: the number of partition
	232	* @partitions: partition entries
	233	*/
	234	struct efi_gpt_data {
	235	gpt_header uefi_partition_header;
	236	u64 number_of_partitions;
	237	gpt_entry partitions[];
	238	} __packed;
	239
c1c02105 IA	240	struct efi_tcg2_protocol {
	241	efi_status_t (EFIAPI * get_capability)(struct efi_tcg2_protocol *this,
	242	struct efi_tcg2_boot_service_capability *capability);
	243	efi_status_t (EFIAPI * get_eventlog)(struct efi_tcg2_protocol *this,
	244	efi_tcg_event_log_format log_format,
	245	u64 event_log_location, u64 event_log_last_entry,
	246	bool *event_log_truncated);
	247	efi_status_t (EFIAPI * hash_log_extend_event)(struct efi_tcg2_protocol *this,
c8d0fd58 IA	248	u64 flags,
c8d0fd58 IA	249	efi_physical_addr_t data_to_hash,
c1c02105 IA	250	u64 data_to_hash_len,
	251	struct efi_tcg2_event *efi_tcg_event);
	252	efi_status_t (EFIAPI * submit_command)(struct efi_tcg2_protocol *this,
	253	u32 input_parameter_block_size,
	254	u8 *input_parameter_block,
	255	u32 output_parameter_block_size,
	256	u8 *output_parameter_block);
	257	efi_status_t (EFIAPI * get_active_pcr_banks)(struct efi_tcg2_protocol *this,
	258	u32 *active_pcr_banks);
	259	efi_status_t (EFIAPI * set_active_pcr_banks)(struct efi_tcg2_protocol *this,
	260	u32 active_pcr_banks);
	261	efi_status_t (EFIAPI * get_result_of_set_active_pcr_banks)(struct efi_tcg2_protocol *this,
	262	u32 *operation_present,
	263	u32 *response);
	264	};
	265	#endif