Prepare v2025.01
[u-boot.git] / include / efi_tcg2.h
blob8dfb1bc9527b0d8659743bb7ac8fbbe05d30bea7
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
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/
10 * - TCG EFI Protocol Specification
11 * https://trustedcomputinggroup.org/resource/tcg-efi-protocol-specification/
13 * Copyright (c) 2020, Linaro Limited
16 #if !defined _EFI_TCG2_PROTOCOL_H_
17 #define _EFI_TCG2_PROTOCOL_H_
19 #include <efi_api.h>
20 #include <tpm-v2.h>
21 #include <tpm_tcg2.h>
23 /* TPMV2 only */
24 #define TCG2_EVENT_LOG_FORMAT_TCG_2 0x00000002
25 #define EFI_TCG2_EXTEND_ONLY 0x0000000000000001
26 #define PE_COFF_IMAGE 0x0000000000000010
28 #define EFI_TCG2_MAX_PCR_INDEX 23
29 #define EFI_TCG2_FINAL_EVENTS_TABLE_VERSION 1
31 #define TPM2_EVENT_LOG_SIZE CONFIG_EFI_TCG2_PROTOCOL_EVENTLOG_SIZE
33 typedef u32 efi_tcg_event_log_bitmap;
34 typedef u32 efi_tcg_event_log_format;
35 typedef u32 efi_tcg_event_algorithm_bitmap;
37 /**
38 * struct tdEFI_TCG2_VERSION - structure of EFI TCG2 version
39 * @major: major version
40 * @minor: minor version
42 struct efi_tcg2_version {
43 u8 major;
44 u8 minor;
47 /**
48 * struct tdEFI_TCG2_EVENT_HEADER - structure of EFI TCG2 event header
49 * @header_size: size of the event header
50 * @header_version: header version
51 * @pcr_index: index of the PCR that is extended
52 * @event_type: type of the event that is extended
54 struct efi_tcg2_event_header {
55 u32 header_size;
56 u16 header_version;
57 u32 pcr_index;
58 u32 event_type;
59 } __packed;
61 /**
62 * struct tdEFI_TCG2_EVENT - structure of EFI TCG2 event
63 * @size: total size of the event including the size component, the header
64 * and the event data
65 * @header: event header
66 * @event: event to add
68 struct efi_tcg2_event {
69 u32 size;
70 struct efi_tcg2_event_header header;
71 u8 event[];
72 } __packed;
74 /**
75 * struct tdUEFI_IMAGE_LOAD_EVENT - structure of PE/COFF image measurement
76 * @image_location_in_memory: image address
77 * @image_length_in_memory: image size
78 * @image_link_time_address: image link time address
79 * @length_of_device_path: devive path size
80 * @device_path: device path
82 struct uefi_image_load_event {
83 efi_physical_addr_t image_location_in_memory;
84 u64 image_length_in_memory;
85 u64 image_link_time_address;
86 u64 length_of_device_path;
87 struct efi_device_path device_path[];
90 /**
91 * struct tdEFI_TCG2_BOOT_SERVICE_CAPABILITY - protocol capability information
92 * @size: allocated size of the structure
93 * @structure_version: version of this structure
94 * @protocol_version: version of the EFI TCG2 protocol.
95 * @hash_algorithm_bitmap: supported hash algorithms
96 * @supported_event_logs: bitmap of supported event log formats
97 * @tpm_present_flag: false = TPM not present
98 * @max_command_size: max size (in bytes) of a command
99 * that can be sent to the TPM
100 * @max_response_size: max size (in bytes) of a response that
101 * can be provided by the TPM
102 * @manufacturer_id: 4-byte Vendor ID
103 * @number_of_pcr_banks: maximum number of PCR banks
104 * @active_pcr_banks: bitmap of currently active
105 * PCR banks (hashing algorithms).
107 struct efi_tcg2_boot_service_capability {
108 u8 size;
109 struct efi_tcg2_version structure_version;
110 struct efi_tcg2_version protocol_version;
111 efi_tcg_event_algorithm_bitmap hash_algorithm_bitmap;
112 efi_tcg_event_log_bitmap supported_event_logs;
113 u8 tpm_present_flag;
114 u16 max_command_size;
115 u16 max_response_size;
116 u32 manufacturer_id;
117 u32 number_of_pcr_banks;
118 efi_tcg_event_algorithm_bitmap active_pcr_banks;
121 /* up to and including the vendor ID (manufacturer_id) field */
122 #define BOOT_SERVICE_CAPABILITY_MIN \
123 offsetof(struct efi_tcg2_boot_service_capability, number_of_pcr_banks)
126 * struct tdEFI_TCG2_FINAL_EVENTS_TABLE - log entries after Get Event Log
127 * @version: version number for this structure
128 * @number_of_events: number of events recorded after invocation of
129 * GetEventLog()
130 * @event: List of events of type tcg_pcr_event2
132 struct efi_tcg2_final_events_table {
133 u64 version;
134 u64 number_of_events;
135 struct tcg_pcr_event2 event[];
139 * struct tdUEFI_VARIABLE_DATA - event log structure of UEFI variable
140 * @variable_name: The vendorGUID parameter in the
141 * GetVariable() API.
142 * @unicode_name_length: The length in CHAR16 of the Unicode name of
143 * the variable.
144 * @variable_data_length: The size of the variable data.
145 * @unicode_name: The CHAR16 unicode name of the variable
146 * without NULL-terminator followed by data.
148 struct efi_tcg2_uefi_variable_data {
149 efi_guid_t variable_name;
150 u64 unicode_name_length;
151 u64 variable_data_length;
152 u16 unicode_name[];
153 // u8 variable_data[];
157 * struct tdUEFI_HANDOFF_TABLE_POINTERS2 - event log structure of SMBOIS tables
158 * @table_description_size: size of table description
159 * @table_description: table description
160 * @number_of_tables: number of uefi configuration table
161 * @table_entry: uefi configuration table entry
163 #define SMBIOS_HANDOFF_TABLE_DESC "SmbiosTable"
164 struct smbios_handoff_table_pointers2 {
165 u8 table_description_size;
166 u8 table_description[sizeof(SMBIOS_HANDOFF_TABLE_DESC)];
167 u64 number_of_tables;
168 struct efi_configuration_table table_entry[];
169 } __packed;
172 * struct tdUEFI_GPT_DATA - event log structure of industry standard tables
173 * @uefi_partition_header: gpt partition header
174 * @number_of_partitions: the number of partition
175 * @partitions: partition entries
177 struct efi_gpt_data {
178 gpt_header uefi_partition_header;
179 u64 number_of_partitions;
180 gpt_entry partitions[];
181 } __packed;
184 * struct tdUEFI_PLATFORM_FIRMWARE_BLOB2
185 * @blob_description_size: Byte size of @data
186 * @data: Description data
188 struct uefi_platform_firmware_blob2 {
189 u8 blob_description_size;
190 u8 data[];
191 } __packed;
193 struct efi_tcg2_protocol {
194 efi_status_t (EFIAPI * get_capability)(struct efi_tcg2_protocol *this,
195 struct efi_tcg2_boot_service_capability *capability);
196 efi_status_t (EFIAPI * get_eventlog)(struct efi_tcg2_protocol *this,
197 efi_tcg_event_log_format log_format,
198 u64 *event_log_location, u64 *event_log_last_entry,
199 bool *event_log_truncated);
200 efi_status_t (EFIAPI * hash_log_extend_event)(struct efi_tcg2_protocol *this,
201 u64 flags,
202 efi_physical_addr_t data_to_hash,
203 u64 data_to_hash_len,
204 struct efi_tcg2_event *efi_tcg_event);
205 efi_status_t (EFIAPI * submit_command)(struct efi_tcg2_protocol *this,
206 u32 input_parameter_block_size,
207 u8 *input_parameter_block,
208 u32 output_parameter_block_size,
209 u8 *output_parameter_block);
210 efi_status_t (EFIAPI * get_active_pcr_banks)(struct efi_tcg2_protocol *this,
211 u32 *active_pcr_banks);
212 efi_status_t (EFIAPI * set_active_pcr_banks)(struct efi_tcg2_protocol *this,
213 u32 active_pcr_banks);
214 efi_status_t (EFIAPI * get_result_of_set_active_pcr_banks)(struct efi_tcg2_protocol *this,
215 u32 *operation_present,
216 u32 *response);
218 #endif