From: "PierreGondois" <pierre.gondois@arm.com>
To: Abdul Lateef Attar <AbdulLateef.Attar@amd.com>, devel@edk2.groups.io
Cc: Sami Mujawar <Sami.Mujawar@arm.com>
Subject: Re: [edk2-devel] [RESEND PATCH v4 3/5] DynamicTablesPkg: Adds ACPI WSMT Table generator
Date: Thu, 2 May 2024 18:36:54 +0200 [thread overview]
Message-ID: <7db31c04-3ad5-45ea-a5a2-59a8ddfc686c@arm.com> (raw)
In-Reply-To: <75c1147b052ecd8b8194e2128c1ff62c28872c8e.1714369949.git.AbdulLateef.Attar@amd.com>
Hello Abdul,
some comments on the patch:
On 4/29/24 08:03, Abdul Lateef Attar wrote:
> Adds generic ACPI WSMT table generator library.
> Register/Deregister WSMT table.
> Update the WSMT table during boot as per specification.
>
> Cc: Sami Mujawar <Sami.Mujawar@arm.com>
> Cc: Pierre Gondois <pierre.gondois@arm.com>
> Signed-off-by: Abdul Lateef Attar <AbdulLateef.Attar@amd.com>
> ---
> DynamicTablesPkg/DynamicTables.dsc.inc | 2 +
> DynamicTablesPkg/Include/AcpiTableGenerator.h | 1 +
> .../Include/ArchNameSpaceObjects.h | 11 +
> .../Library/Acpi/AcpiWsmtLib/AcpiWsmtLib.inf | 30 +++
> .../Library/Acpi/AcpiWsmtLib/WsmtGenerator.c | 243 ++++++++++++++++++
> 5 files changed, 287 insertions(+)
> create mode 100644 DynamicTablesPkg/Library/Acpi/AcpiWsmtLib/AcpiWsmtLib.inf
> create mode 100644 DynamicTablesPkg/Library/Acpi/AcpiWsmtLib/WsmtGenerator.c
>
> diff --git a/DynamicTablesPkg/DynamicTables.dsc.inc b/DynamicTablesPkg/DynamicTables.dsc.inc
> index b2ef36eb8a..477dc6b6a9 100644
> --- a/DynamicTablesPkg/DynamicTables.dsc.inc
> +++ b/DynamicTablesPkg/DynamicTables.dsc.inc
> @@ -35,6 +35,7 @@
> #
> DynamicTablesPkg/Library/Acpi/AcpiFadtLib/AcpiFadtLib.inf
> DynamicTablesPkg/Library/Acpi/AcpiHpetLib/AcpiHpetLib.inf
> + DynamicTablesPkg/Library/Acpi/AcpiWsmtLib/AcpiWsmtLib.inf
Same comment as in:
[PATCH v4 2/5] DynamicTablesPkg: Adds ACPI HPET Table generator
about:
[Components.IA32, Components.X64]
also if the table is Intel specific, maybe the generator should be placed under:
DynamicTablesPkg/Library/Acpi/X64/
(or a better folder name)
also I think the CmObject should be moved to:
X64NameSpaceObjects.h
>
> [Components.IA32, Components.X64]
> #
> @@ -44,6 +45,7 @@
> <LibraryClasses>
> NULL|DynamicTablesPkg/Library/Acpi/AcpiFadtLib/AcpiFadtLib.inf
> NULL|DynamicTablesPkg/Library/Acpi/AcpiHpetLib/AcpiHpetLib.inf
> + NULL|DynamicTablesPkg/Library/Acpi/AcpiWsmtLib/AcpiWsmtLib.inf
> }
>
> [Components.ARM, Components.AARCH64]
> diff --git a/DynamicTablesPkg/Include/AcpiTableGenerator.h b/DynamicTablesPkg/Include/AcpiTableGenerator.h
> index 18b5f99f47..a32ef46ecb 100644
> --- a/DynamicTablesPkg/Include/AcpiTableGenerator.h
> +++ b/DynamicTablesPkg/Include/AcpiTableGenerator.h
> @@ -100,6 +100,7 @@ typedef enum StdAcpiTableId {
> EStdAcpiTableIdSsdtPciExpress, ///< SSDT Pci Express Generator
> EStdAcpiTableIdPcct, ///< PCCT Generator
> EStdAcpiTableIdHpet, ///< HPET Generator
> + EStdAcpiTableIdWsmt, ///< WSMT Generator
> EStdAcpiTableIdMax
> } ESTD_ACPI_TABLE_ID;
>
> diff --git a/DynamicTablesPkg/Include/ArchNameSpaceObjects.h b/DynamicTablesPkg/Include/ArchNameSpaceObjects.h
> index b90e573a88..8b16056ba1 100644
> --- a/DynamicTablesPkg/Include/ArchNameSpaceObjects.h
> +++ b/DynamicTablesPkg/Include/ArchNameSpaceObjects.h
> @@ -40,6 +40,7 @@ typedef enum ArchObjectID {
> EArchObjFadtHypervisorVendorId, ///< 12 - Hypervisor vendor identity information
> EArchObjFadtMiscInfo, ///< 13 - Legacy fields; RTC, latency, flush stride, etc
> EArchObjHpetBaseAddress, ///< 14 - HPET Base Address
> + EArchObjWsmtProtectionFlags, ///< 15 - WSMT protection flags
> EArchObjMax
> } E_ARCH_OBJECT_ID;
>
> @@ -223,4 +224,14 @@ typedef struct CmArchFadtMiscInfo {
> typedef struct CmArchHpetBaseAddress {
> UINT64 BaseAddress;
> } CM_ARCH_HPET_BASE_ADDRESS;
> +
> +/** A structure that describes the
> + protection flags for the WSMT fields information.
> +
> + ID: EArchObjWsmtProtectionFlags
> +*/
> +typedef struct CmArchWsmtProtectionFlags {
> + UINT32 ProtectionFlags;
> +} CM_ARCH_WSMT_PROTECTION_FLAGS;
> +
> #endif
> diff --git a/DynamicTablesPkg/Library/Acpi/AcpiWsmtLib/AcpiWsmtLib.inf b/DynamicTablesPkg/Library/Acpi/AcpiWsmtLib/AcpiWsmtLib.inf
> new file mode 100644
> index 0000000000..80ddaf0ab4
> --- /dev/null
> +++ b/DynamicTablesPkg/Library/Acpi/AcpiWsmtLib/AcpiWsmtLib.inf
> @@ -0,0 +1,30 @@
> +## @file
> +# WSMT Table Generator
> +#
> +# Copyright (C) 2024 Advanced Micro Devices, Inc. All rights reserved.
> +#
> +# SPDX-License-Identifier: BSD-2-Clause-Patent
> +##
> +
> +[Defines]
> + INF_VERSION = 1.27
> + BASE_NAME = AcpiWsmtLib
> + FILE_GUID = D6C34086-C914-4F8E-B56A-08329B4D1271
> + VERSION_STRING = 1.0
> + MODULE_TYPE = DXE_DRIVER
> + LIBRARY_CLASS = NULL|DXE_DRIVER
> + CONSTRUCTOR = AcpiWsmtLibConstructor
> + DESTRUCTOR = AcpiWsmtLibDestructor
> +
> +[Sources]
> + WsmtGenerator.c
> +
> +[Packages]
> + DynamicTablesPkg/DynamicTablesPkg.dec
> + MdeModulePkg/MdeModulePkg.dec
> + MdePkg/MdePkg.dec
> +
> +[LibraryClasses]
> + BaseLib
> + DebugLib
> +
> diff --git a/DynamicTablesPkg/Library/Acpi/AcpiWsmtLib/WsmtGenerator.c b/DynamicTablesPkg/Library/Acpi/AcpiWsmtLib/WsmtGenerator.c
> new file mode 100644
> index 0000000000..a63b4b4859
> --- /dev/null
> +++ b/DynamicTablesPkg/Library/Acpi/AcpiWsmtLib/WsmtGenerator.c
> @@ -0,0 +1,243 @@
> +/** @file
> + WSMT Table Generator
> +
> + Copyright (c) 2017 - 2023, Arm Limited. All rights reserved.
> + Copyright (C) 2024 Advanced Micro Devices, Inc. All rights reserved.
> +
> + SPDX-License-Identifier: BSD-2-Clause-Patent
> +
> + @par Reference(s):
> + - ACPI 6.5 Specification, Aug 29, 2022
> + - WSMT spec, version 1.0, April 18, 2016
> + https://msdn.microsoft.com/windows/hardware/drivers/bringup/acpi-system-description-tables#wsmt
> +
> +**/
> +
> +#include <AcpiTableGenerator.h>
> +#include <ConfigurationManagerHelper.h>
> +#include <ConfigurationManagerObject.h>
> +#include <IndustryStandard/WindowsSmmSecurityMitigationTable.h>
> +#include <Library/DebugLib.h>
> +#include <Library/TableHelperLib.h>
> +#include <Protocol/ConfigurationManagerProtocol.h>
> +#include <ArchNameSpaceObjects.h>
> +
> +/** The Creator ID for the ACPI tables generated using
> + the standard ACPI table generators.
> +*/
> +#define TABLE_GENERATOR_CREATOR_ID_GENERIC SIGNATURE_32('D', 'Y', 'N', 'T')
> +
> +/** The AcpiWsmt is a template EFI_ACPI_WSMT_TABLE
> + structure used for generating the WSMT Table.
> +*/
> +STATIC
> +EFI_ACPI_WSMT_TABLE mAcpiWsmt = {
> + ACPI_HEADER (
> + EFI_ACPI_WINDOWS_SMM_SECURITY_MITIGATION_TABLE_SIGNATURE,
> + EFI_ACPI_WSMT_TABLE,
> + EFI_WSMT_TABLE_REVISION
> + ),
> + EFI_WSMT_PROTECTION_FLAGS_SYSTEM_RESOURCE_PROTECTION| \
> + EFI_WSMT_PROTECTION_FLAGS_COMM_BUFFER_NESTED_PTR_PROTECTION| \
> + EFI_WSMT_PROTECTION_FLAGS_FIXED_COMM_BUFFERS
> +};
> +
> +/** This macro expands to a function that retrieves the
> + protection flags information for WSMT Table.
> +*/
> +GET_OBJECT_LIST (
> + EObjNameSpaceArch,
> + EArchObjWsmtProtectionFlags,
> + CM_ARCH_WSMT_PROTECTION_FLAGS
> + );
> +
> +/** Construct the WSMT table.
> +
> + This function invokes the Configuration Manager protocol interface
> + to get the required hardware information for generating the ACPI
> + table.
> +
> + If this function allocates any resources then they must be freed
> + in the FreeXXXXTableResources function.
> +
> + @param [in] This Pointer to the table generator.
> + @param [in] AcpiTableInfo Pointer to the ACPI Table Info.
> + @param [in] CfgMgrProtocol Pointer to the Configuration Manager
> + Protocol Interface.
> + @param [out] Table Pointer to the constructed ACPI Table.
> +
> + @retval EFI_SUCCESS Table generated successfully.
> + @retval EFI_INVALID_PARAMETER A parameter is invalid.
> + @retval EFI_NOT_FOUND The required object was not found.
> + @retval EFI_BAD_BUFFER_SIZE The size returned by the Configuration
> + Manager is less than the Object size for the
> + requested object.
> +**/
> +STATIC
> +EFI_STATUS
> +BuildWsmtTable (
> + IN CONST ACPI_TABLE_GENERATOR *CONST This,
> + IN CONST CM_STD_OBJ_ACPI_TABLE_INFO *CONST AcpiTableInfo,
> + IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL *CONST CfgMgrProtocol,
> + OUT EFI_ACPI_DESCRIPTION_HEADER **CONST Table
> + )
> +{
> + EFI_STATUS Status;
> + CM_ARCH_WSMT_PROTECTION_FLAGS *ProtectionFlags;
> +
> + ASSERT (This != NULL);
> + ASSERT (AcpiTableInfo != NULL);
> + ASSERT (CfgMgrProtocol != NULL);
> + ASSERT (Table != NULL);
> + ASSERT (AcpiTableInfo->TableGeneratorId == This->GeneratorID);
> + ASSERT (AcpiTableInfo->AcpiTableSignature == This->AcpiTableSignature);
> +
> + if ((AcpiTableInfo->AcpiTableRevision < This->MinAcpiTableRevision) ||
> + (AcpiTableInfo->AcpiTableRevision > This->AcpiTableRevision))
> + {
> + DEBUG ((
> + DEBUG_ERROR,
> + "ERROR: WSMT: Requested table revision = %d, is not supported."
> + "Supported table revision: Minimum = %d, Maximum = %d\n",
> + AcpiTableInfo->AcpiTableRevision,
> + This->MinAcpiTableRevision,
> + This->AcpiTableRevision
> + ));
> + return EFI_INVALID_PARAMETER;
> + }
> +
> + *Table = NULL;
> +
> + Status = AddAcpiHeader (
> + CfgMgrProtocol,
> + This,
> + (EFI_ACPI_DESCRIPTION_HEADER *)&mAcpiWsmt,
> + AcpiTableInfo,
> + sizeof (EFI_ACPI_WSMT_TABLE)
> + );
> + if (EFI_ERROR (Status)) {
> + DEBUG ((
> + DEBUG_ERROR,
> + "ERROR: WSMT: Failed to add ACPI header. Status = %r\n",
> + Status
> + ));
> + return Status;
> + }
> +
> + Status = GetEArchObjWsmtProtectionFlags (
> + CfgMgrProtocol,
> + CM_NULL_TOKEN,
> + &ProtectionFlags,
> + NULL
> + );
> + if (EFI_ERROR (Status)) {
> + DEBUG ((
> + DEBUG_ERROR,
> + "ERROR: WSMT: Failed to get protection flags information." \
> + " Status = %r\n",
> + Status
> + ));
> + } else {
> + mAcpiWsmt.ProtectionFlags = ProtectionFlags->ProtectionFlags;
> + }
> +
> + /// Sanity check WSMT Projection Flags
> + if ((mAcpiWsmt.ProtectionFlags & EFI_WSMT_PROTECTION_FLAGS_COMM_BUFFER_NESTED_PTR_PROTECTION) != 0) {
> + if ((mAcpiWsmt.ProtectionFlags & EFI_WSMT_PROTECTION_FLAGS_FIXED_COMM_BUFFERS) == 0) {
> + DEBUG ((
> + DEBUG_ERROR,
> + "ERROR: WSMT: Protection flags are invalid. " \
> + "COMM_BUFFER_NESTED_PTR_PROTECTION is set but FIXED_COMM_BUFFERS is not set.\n"
> + ));
> + return EFI_INVALID_PARAMETER;
> + }
> + }
> +
> + *Table = (EFI_ACPI_DESCRIPTION_HEADER *)&mAcpiWsmt;
> +
> + return Status;
> +}
> +
> +/** This macro defines the WSMT Table Generator revision.
> +*/
> +#define WSMT_GENERATOR_REVISION CREATE_REVISION (1, 0)
> +
> +/** The interface for the WSMT Table Generator.
> +*/
> +STATIC
> +CONST
> +ACPI_TABLE_GENERATOR mWsmtGenerator = {
> + // Generator ID
> + CREATE_STD_ACPI_TABLE_GEN_ID (EStdAcpiTableIdWsmt),
> + // Generator Description
> + L"ACPI.STD.WSMT.GENERATOR",
> + // ACPI Table Signature
> + EFI_ACPI_WINDOWS_SMM_SECURITY_MITIGATION_TABLE_SIGNATURE,
> + // ACPI Table Revision supported by this Generator
> + EFI_WSMT_TABLE_REVISION,
> + // Minimum supported ACPI Table Revision
> + EFI_WSMT_TABLE_REVISION,
> + // Creator ID
> + TABLE_GENERATOR_CREATOR_ID_GENERIC,
> + // Creator Revision
> + WSMT_GENERATOR_REVISION,
> + // Build Table function
> + BuildWsmtTable,
> + // No additional resources are allocated by the generator.
> + // Hence the Free Resource function is not required.
> + NULL,
> + // Extended build function not needed
> + NULL,
> + // Extended build function not implemented by the generator.
> + // Hence extended free resource function is not required.
> + NULL
> +};
> +
> +/** Register the Generator with the ACPI Table Factory.
> +
> + @param [in] ImageHandle The handle to the image.
> + @param [in] SystemTable Pointer to the System Table.
> +
> + @retval EFI_SUCCESS The Generator is registered.
> + @retval EFI_INVALID_PARAMETER A parameter is invalid.
> + @retval EFI_ALREADY_STARTED The Generator for the Table ID
> + is already registered.
> +**/
> +EFI_STATUS
> +EFIAPI
> +AcpiWsmtLibConstructor (
> + IN EFI_HANDLE ImageHandle,
> + IN EFI_SYSTEM_TABLE *SystemTable
> + )
> +{
> + EFI_STATUS Status;
> +
> + Status = RegisterAcpiTableGenerator (&mWsmtGenerator);
> + DEBUG ((DEBUG_INFO, "WSMT: Register Generator. Status = %r\n", Status));
> + ASSERT_EFI_ERROR (Status);
> + return Status;
> +}
> +
> +/** Deregister the Generator from the ACPI Table Factory.
> +
> + @param [in] ImageHandle The handle to the image.
> + @param [in] SystemTable Pointer to the System Table.
> +
> + @retval EFI_SUCCESS The Generator is deregistered.
> + @retval EFI_INVALID_PARAMETER A parameter is invalid.
> + @retval EFI_NOT_FOUND The Generator is not registered.
> +**/
> +EFI_STATUS
> +EFIAPI
> +AcpiWsmtLibDestructor (
> + IN EFI_HANDLE ImageHandle,
> + IN EFI_SYSTEM_TABLE *SystemTable
> + )
> +{
> + EFI_STATUS Status;
> +
> + Status = DeregisterAcpiTableGenerator (&mWsmtGenerator);
> + DEBUG ((DEBUG_INFO, "WSMT: Deregister Generator. Status = %r\n", Status));
> + ASSERT_EFI_ERROR (Status);
> + return Status;
> +}
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#118530): https://edk2.groups.io/g/devel/message/118530
Mute This Topic: https://groups.io/mt/105796052/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-
next prev parent reply other threads:[~2024-05-02 16:37 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-29 6:03 [edk2-devel] [RESEND PATCH v4 0/5] DynamicTablesPkg: Adds FADT, HPET, WSMT and MADT Table generators Abdul Lateef Attar via groups.io
2024-04-29 6:03 ` [edk2-devel] [RESEND PATCH v4 1/5] DynamicTablesPkg: Adds ACPI FADT Table generator Abdul Lateef Attar via groups.io
2024-04-29 6:03 ` [edk2-devel] [RESEND PATCH v4 2/5] DynamicTablesPkg: Adds ACPI HPET " Abdul Lateef Attar via groups.io
2024-05-02 16:36 ` PierreGondois
2024-04-29 6:03 ` [edk2-devel] [RESEND PATCH v4 3/5] DynamicTablesPkg: Adds ACPI WSMT " Abdul Lateef Attar via groups.io
2024-05-02 16:36 ` PierreGondois [this message]
2024-04-29 6:03 ` [edk2-devel] [RESEND PATCH v4 4/5] DynamicTablesPkg: Adds ACPI SSDT HPET " Abdul Lateef Attar via groups.io
2024-05-02 16:37 ` PierreGondois
2024-04-29 6:03 ` [edk2-devel] [RESEND PATCH v4 5/5] DynamicTablesPkg: Adds X64 arch MADT " Abdul Lateef Attar via groups.io
2024-05-02 16:37 ` PierreGondois
2024-05-02 7:21 ` [edk2-devel] [RESEND PATCH v4 0/5] DynamicTablesPkg: Adds FADT, HPET, WSMT and MADT Table generators Abdul Lateef Attar via groups.io
2024-05-02 16:35 ` PierreGondois
2024-05-03 7:41 ` Sami Mujawar
2024-05-13 4:08 ` Abdul Lateef Attar via groups.io
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-list 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=7db31c04-3ad5-45ea-a5a2-59a8ddfc686c@arm.com \
--to=devel@edk2.groups.io \
/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