From: Masahisa Kojima <masahisa.kojima@linaro.org>
To: Heinrich Schuchardt <xypron.glpk@gmx.de>,
Alexander Graf <agraf@csgraf.de>,
Ilias Apalodimas <ilias.apalodimas@linaro.org>,
Simon Glass <sjg@chromium.org>,
Masahisa Kojima <masahisa.kojima@linaro.org>,
Dhananjay Phadke <dphadke@linux.microsoft.com>,
AKASHI Takahiro <takahiro.akashi@linaro.org>,
u-boot@lists.denx.de
Subject: [PATCH v4 5/5] efi_loader: add comment for efi_tcg2.h
Date: Fri, 13 Aug 2021 16:12:43 +0900 [thread overview]
Message-ID: <20210813071243.18885-6-masahisa.kojima@linaro.org> (raw)
In-Reply-To: <20210813071243.18885-1-masahisa.kojima@linaro.org>
This commit adds the comment of the TCG Specification
efi_tcg2.h file refers, and comment for the structure.
Signed-off-by: Masahisa Kojima <masahisa.kojima@linaro.org>
---
(no change since v3)
Changes in v3:
- update comment format
Changes in v2:
- newly create commit from v2
include/efi_tcg2.h | 57 +++++++++++++++++++++++++++++++++++++++++++---
1 file changed, 54 insertions(+), 3 deletions(-)
diff --git a/include/efi_tcg2.h b/include/efi_tcg2.h
index 497ba3ce94..b6b958da51 100644
--- a/include/efi_tcg2.h
+++ b/include/efi_tcg2.h
@@ -3,6 +3,13 @@
* 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
*/
@@ -36,11 +43,23 @@ 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;
@@ -48,12 +67,27 @@ struct efi_tcg2_event_header {
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;
@@ -62,6 +96,23 @@ struct uefi_image_load_event {
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;
@@ -86,7 +137,7 @@ struct efi_tcg2_boot_service_capability {
#define TCG_EFI_SPEC_ID_EVENT_SPEC_VERSION_ERRATA_TPM2 2
/**
- * struct TCG_EfiSpecIdEventAlgorithmSize
+ * struct TCG_EfiSpecIdEventAlgorithmSize - hashing algorithm information
*
* @algorithm_id: algorithm defined in enum tpm2_algorithms
* @digest_size: size of the algorithm
@@ -97,7 +148,7 @@ struct tcg_efi_spec_id_event_algorithm_size {
} __packed;
/**
- * struct TCG_EfiSpecIDEventStruct
+ * struct TCG_EfiSpecIDEventStruct - content of the event log header
*
* @signature: signature, set to Spec ID Event03
* @platform_class: class defined in TCG ACPI Specification
@@ -130,7 +181,7 @@ struct tcg_efi_spec_id_event {
} __packed;
/**
- * struct tdEFI_TCG2_FINAL_EVENTS_TABLE
+ * 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()
--
2.17.1
prev parent reply other threads:[~2021-08-13 7:13 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-08-13 7:12 [PATCH v4 0/5] add measurement support Masahisa Kojima
2021-08-13 7:12 ` [PATCH v4 1/5] efi_loader: add secure boot variable measurement Masahisa Kojima
2021-08-13 7:12 ` [PATCH v4 2/5] efi_loader: add " Masahisa Kojima
2021-08-13 7:12 ` [PATCH v4 3/5] efi_loader: add ExitBootServices() measurement Masahisa Kojima
2021-08-14 8:28 ` Heinrich Schuchardt
2021-08-14 9:06 ` Heinrich Schuchardt
2021-08-16 0:33 ` Masahisa Kojima
2021-08-13 7:12 ` [PATCH v4 4/5] efi_loader: refactor efi_append_scrtm_version() Masahisa Kojima
2021-08-13 7:12 ` Masahisa Kojima [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210813071243.18885-6-masahisa.kojima@linaro.org \
--to=masahisa.kojima@linaro.org \
--cc=agraf@csgraf.de \
--cc=dphadke@linux.microsoft.com \
--cc=ilias.apalodimas@linaro.org \
--cc=sjg@chromium.org \
--cc=takahiro.akashi@linaro.org \
--cc=u-boot@lists.denx.de \
--cc=xypron.glpk@gmx.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).