DynamicTablesPkg: Add OEM Info

This patch originally merged in edk2 master at
c788bdaba47536447ae37518a96d92e0da54aad7. However, this was
later reverted at bdbbedea949eb4b10d24110c0e559b03c7a6bce4
as it was merged during the Soft Feature Freeze for
edk2-stable201903.

Resubmitting this patch as the edk2 merge window is now open.

Added option for OEMs to provide OEM Table ID and
OEM Revision for ACPI tables.

Cc: Laszlo Ersek <lersek@redhat.com>
Cc: Alexei Fedorov <alexei.fedorov@arm.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Sami Mujawar <sami.mujawar@arm.com>
Reviewed-by: Alexei Fedorov <alexei.fedorov@arm.com>

diff --git a/DynamicTablesPkg/Include/Library/TableHelperLib.h b/DynamicTablesPkg/Include/Library/TableHelperLib.h
index 3c4e1d23d2e6955388ab0b51fb57779f2225beb2..0f872bc3d08bf78e33bd8dab866e7bf57e00cb8c 100644 (file)
--- a/DynamicTablesPkg/Include/Library/TableHelperLib.h
+++ b/DynamicTablesPkg/Include/Library/TableHelperLib.h
@@ -45,7 +45,7 @@ GetCgfMgrInfo (
   @param [in]     Generator      Pointer to the ACPI table Generator.\r
   @param [in,out] AcpiHeader     Pointer to the ACPI table header to be\r
                                  updated.\r
   @param [in]     Generator      Pointer to the ACPI table Generator.\r
   @param [in,out] AcpiHeader     Pointer to the ACPI table header to be\r
                                  updated.\r

-  @param [in]     Revision       Revision of the ACPI table.\r
+  @param [in]     AcpiTableInfo  Pointer to the ACPI table info structure.\r

   @param [in]     Length         Length of the ACPI table.\r
 \r
   @retval EFI_SUCCESS           The ACPI table is updated successfully.\r
   @param [in]     Length         Length of the ACPI table.\r
 \r
   @retval EFI_SUCCESS           The ACPI table is updated successfully.\r


@@ -61,7 +61,7 @@ AddAcpiHeader (
   IN      CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL  * CONST CfgMgrProtocol,\r
   IN      CONST ACPI_TABLE_GENERATOR                  * CONST Generator,\r
   IN OUT  EFI_ACPI_DESCRIPTION_HEADER                 * CONST AcpiHeader,\r
   IN      CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL  * CONST CfgMgrProtocol,\r
   IN      CONST ACPI_TABLE_GENERATOR                  * CONST Generator,\r
   IN OUT  EFI_ACPI_DESCRIPTION_HEADER                 * CONST AcpiHeader,\r

-  IN      CONST UINT32                                        Revision,\r
+  IN      CONST CM_STD_OBJ_ACPI_TABLE_INFO            * CONST AcpiTableInfo,\r

   IN      CONST UINT32                                        Length\r
   );\r
 \r
   IN      CONST UINT32                                        Length\r
   );\r
 \r

diff --git a/DynamicTablesPkg/Include/StandardNameSpaceObjects.h b/DynamicTablesPkg/Include/StandardNameSpaceObjects.h
index 4377ee8f785399b02fec824f3a34d2f4ed3b1c01..58503858b27141cf7647a410c4b0b3fa574033de 100644 (file)
--- a/DynamicTablesPkg/Include/StandardNameSpaceObjects.h
+++ b/DynamicTablesPkg/Include/StandardNameSpaceObjects.h
@@ -93,6 +93,24 @@ typedef struct CmAStdObjAcpiTableInfo {
   /// Optional pointer to the ACPI table data\r
   EFI_ACPI_DESCRIPTION_HEADER  * AcpiTableData;\r
 \r
   /// Optional pointer to the ACPI table data\r
   EFI_ACPI_DESCRIPTION_HEADER  * AcpiTableData;\r
 \r

+  /// An OEM-supplied string that the OEM uses to identify the particular\r
+  /// data table. This field is particularly useful when defining a definition\r
+  /// block to distinguish definition block functions. The OEM assigns each\r
+  /// dissimilar table a new OEM Table ID.\r
+  /// This field could be constructed using the SIGNATURE_64() macro.\r
+  ///   e.g. SIGNATURE_64 ('A','R','M','H','G','T','D','T')\r
+  /// Note: If this field is not populated (has value of Zero), then the\r
+  /// Generators shall populate this information using part of the\r
+  /// CM_STD_OBJ_CONFIGURATION_MANAGER_INFO.OemId field and the\r
+  /// ACPI table signature.\r
+  UINT64                         OemTableId;\r
+\r
+  /// An OEM-supplied revision number. Larger numbers are assumed to be\r
+  /// newer revisions.\r
+  /// Note: If this field is not populated (has value of Zero), then the\r
+  /// Generators shall populate this information using the revision of the\r
+  /// Configuration Manager (CM_STD_OBJ_CONFIGURATION_MANAGER_INFO.Revision).\r
+  UINT32                         OemRevision;\r

 } CM_STD_OBJ_ACPI_TABLE_INFO;\r
 \r
 /** A structure used to describe the SMBIOS table generators to be invoked.\r
 } CM_STD_OBJ_ACPI_TABLE_INFO;\r
 \r
 /** A structure used to describe the SMBIOS table generators to be invoked.\r

diff --git a/DynamicTablesPkg/Library/Acpi/Arm/AcpiDbg2LibArm/Dbg2Generator.c b/DynamicTablesPkg/Library/Acpi/Arm/AcpiDbg2LibArm/Dbg2Generator.c
index e21e2b660634b1aedce8167b74573694d6df2a3b..697cfc46abaedf34d30abf26e7ebb2b4d271822a 100644 (file)
--- a/DynamicTablesPkg/Library/Acpi/Arm/AcpiDbg2LibArm/Dbg2Generator.c
+++ b/DynamicTablesPkg/Library/Acpi/Arm/AcpiDbg2LibArm/Dbg2Generator.c
@@ -342,7 +342,7 @@ BuildDbg2Table (
              CfgMgrProtocol,\r
              This,\r
              (EFI_ACPI_DESCRIPTION_HEADER*)&AcpiDbg2,\r
              CfgMgrProtocol,\r
              This,\r
              (EFI_ACPI_DESCRIPTION_HEADER*)&AcpiDbg2,\r

-             AcpiTableInfo->AcpiTableRevision,\r
+             AcpiTableInfo,\r

              sizeof (DBG2_TABLE)\r
              );\r
   if (EFI_ERROR (Status)) {\r
              sizeof (DBG2_TABLE)\r
              );\r
   if (EFI_ERROR (Status)) {\r

diff --git a/DynamicTablesPkg/Library/Acpi/Arm/AcpiFadtLibArm/FadtGenerator.c b/DynamicTablesPkg/Library/Acpi/Arm/AcpiFadtLibArm/FadtGenerator.c
index 62927b51d6d7c1585da1cb0d59785e2382639002..6699901b42a63a152027de59887ed097748ece91 100644 (file)
--- a/DynamicTablesPkg/Library/Acpi/Arm/AcpiFadtLibArm/FadtGenerator.c
+++ b/DynamicTablesPkg/Library/Acpi/Arm/AcpiFadtLibArm/FadtGenerator.c
@@ -537,7 +537,7 @@ BuildFadtTable (
              CfgMgrProtocol,\r
              This,\r
              (EFI_ACPI_DESCRIPTION_HEADER*)&AcpiFadt,\r
              CfgMgrProtocol,\r
              This,\r
              (EFI_ACPI_DESCRIPTION_HEADER*)&AcpiFadt,\r

-             AcpiTableInfo->AcpiTableRevision,\r
+             AcpiTableInfo,\r

              sizeof (EFI_ACPI_6_2_FIXED_ACPI_DESCRIPTION_TABLE)\r
              );\r
   if (EFI_ERROR (Status)) {\r
              sizeof (EFI_ACPI_6_2_FIXED_ACPI_DESCRIPTION_TABLE)\r
              );\r
   if (EFI_ERROR (Status)) {\r

diff --git a/DynamicTablesPkg/Library/Acpi/Arm/AcpiGtdtLibArm/GtdtGenerator.c b/DynamicTablesPkg/Library/Acpi/Arm/AcpiGtdtLibArm/GtdtGenerator.c
index 70f52507bc7f12a776f76271b3f378bc62e717ba..d58794ee3ef5b72a8b2e3eb930ad5ab5bbb57c38 100644 (file)
--- a/DynamicTablesPkg/Library/Acpi/Arm/AcpiGtdtLibArm/GtdtGenerator.c
+++ b/DynamicTablesPkg/Library/Acpi/Arm/AcpiGtdtLibArm/GtdtGenerator.c
@@ -518,7 +518,7 @@ BuildGtdtTable (
              CfgMgrProtocol,\r
              This,\r
              &Gtdt->Header,\r
              CfgMgrProtocol,\r
              This,\r
              &Gtdt->Header,\r

-             AcpiTableInfo->AcpiTableRevision,\r
+             AcpiTableInfo,\r

              TableSize\r
              );\r
   if (EFI_ERROR (Status)) {\r
              TableSize\r
              );\r
   if (EFI_ERROR (Status)) {\r

diff --git a/DynamicTablesPkg/Library/Acpi/Arm/AcpiIortLibArm/IortGenerator.c b/DynamicTablesPkg/Library/Acpi/Arm/AcpiIortLibArm/IortGenerator.c
index b53c4bb47798d4ad441db1fe1b1e5b180e313403..2bac7a59ea40d6a3cae675b39d5df26ab7783a29 100644 (file)
--- a/DynamicTablesPkg/Library/Acpi/Arm/AcpiIortLibArm/IortGenerator.c
+++ b/DynamicTablesPkg/Library/Acpi/Arm/AcpiIortLibArm/IortGenerator.c
@@ -1798,7 +1798,7 @@ BuildIortTable (
              CfgMgrProtocol,\r
              This,\r
              &Iort->Header,\r
              CfgMgrProtocol,\r
              This,\r
              &Iort->Header,\r

-             AcpiTableInfo->AcpiTableRevision,\r
+             AcpiTableInfo,\r

              TableSize\r
              );\r
   if (EFI_ERROR (Status)) {\r
              TableSize\r
              );\r
   if (EFI_ERROR (Status)) {\r

diff --git a/DynamicTablesPkg/Library/Acpi/Arm/AcpiMadtLibArm/MadtGenerator.c b/DynamicTablesPkg/Library/Acpi/Arm/AcpiMadtLibArm/MadtGenerator.c
index 06794758308e028b7d8da06670b1793cbdb3ae81..1ee0b9e006bfa00ea5bbf6aa64209dac244c90a0 100644 (file)
--- a/DynamicTablesPkg/Library/Acpi/Arm/AcpiMadtLibArm/MadtGenerator.c
+++ b/DynamicTablesPkg/Library/Acpi/Arm/AcpiMadtLibArm/MadtGenerator.c
@@ -569,7 +569,7 @@ BuildMadtTable (
              CfgMgrProtocol,\r
              This,\r
              &Madt->Header,\r
              CfgMgrProtocol,\r
              This,\r
              &Madt->Header,\r

-             AcpiTableInfo->AcpiTableRevision,\r
+             AcpiTableInfo,\r

              TableSize\r
              );\r
   if (EFI_ERROR (Status)) {\r
              TableSize\r
              );\r
   if (EFI_ERROR (Status)) {\r

diff --git a/DynamicTablesPkg/Library/Acpi/Arm/AcpiMcfgLibArm/McfgGenerator.c b/DynamicTablesPkg/Library/Acpi/Arm/AcpiMcfgLibArm/McfgGenerator.c
index 29eb72bd917227e87b8f126aa098a6e0ff3918cc..2131683a35158f40304892da9ab12e547483a4bc 100644 (file)
--- a/DynamicTablesPkg/Library/Acpi/Arm/AcpiMcfgLibArm/McfgGenerator.c
+++ b/DynamicTablesPkg/Library/Acpi/Arm/AcpiMcfgLibArm/McfgGenerator.c
@@ -220,7 +220,7 @@ BuildMcfgTable (
              CfgMgrProtocol,\r
              This,\r
              &Mcfg->Header,\r
              CfgMgrProtocol,\r
              This,\r
              &Mcfg->Header,\r

-             AcpiTableInfo->AcpiTableRevision,\r
+             AcpiTableInfo,\r

              TableSize\r
              );\r
   if (EFI_ERROR (Status)) {\r
              TableSize\r
              );\r
   if (EFI_ERROR (Status)) {\r

diff --git a/DynamicTablesPkg/Library/Acpi/Arm/AcpiSpcrLibArm/SpcrGenerator.c b/DynamicTablesPkg/Library/Acpi/Arm/AcpiSpcrLibArm/SpcrGenerator.c
index a4654acb39812af022a1e678b78e31415d94ef30..6778d7673e71e6347f21935b5f709b690f64dab4 100644 (file)
--- a/DynamicTablesPkg/Library/Acpi/Arm/AcpiSpcrLibArm/SpcrGenerator.c
+++ b/DynamicTablesPkg/Library/Acpi/Arm/AcpiSpcrLibArm/SpcrGenerator.c
@@ -211,7 +211,7 @@ BuildSpcrTable (
              CfgMgrProtocol,\r
              This,\r
              (EFI_ACPI_DESCRIPTION_HEADER*)&AcpiSpcr,\r
              CfgMgrProtocol,\r
              This,\r
              (EFI_ACPI_DESCRIPTION_HEADER*)&AcpiSpcr,\r

-             AcpiTableInfo->AcpiTableRevision,\r
+             AcpiTableInfo,\r

              sizeof (EFI_ACPI_SERIAL_PORT_CONSOLE_REDIRECTION_TABLE)\r
              );\r
   if (EFI_ERROR (Status)) {\r
              sizeof (EFI_ACPI_SERIAL_PORT_CONSOLE_REDIRECTION_TABLE)\r
              );\r
   if (EFI_ERROR (Status)) {\r

diff --git a/DynamicTablesPkg/Library/Common/TableHelperLib/TableHelper.c b/DynamicTablesPkg/Library/Common/TableHelperLib/TableHelper.c
index 02860ddf233b4a44c30450c8c090b416f1e07d81..203207bac2b202f568072b68e8cb25c5c258045f 100644 (file)
--- a/DynamicTablesPkg/Library/Common/TableHelperLib/TableHelper.c
+++ b/DynamicTablesPkg/Library/Common/TableHelperLib/TableHelper.c
@@ -100,7 +100,7 @@ GetCgfMgrInfo (
   @param [in]     Generator      Pointer to the ACPI table Generator.\r
   @param [in,out] AcpiHeader     Pointer to the ACPI table header to be\r
                                  updated.\r
   @param [in]     Generator      Pointer to the ACPI table Generator.\r
   @param [in,out] AcpiHeader     Pointer to the ACPI table header to be\r
                                  updated.\r

-  @param [in]     Revision       Revision of the ACPI table.\r
+  @param [in]     AcpiTableInfo  Pointer to the ACPI table info structure.\r

   @param [in]     Length         Length of the ACPI table.\r
 \r
   @retval EFI_SUCCESS           The ACPI table is updated successfully.\r
   @param [in]     Length         Length of the ACPI table.\r
 \r
   @retval EFI_SUCCESS           The ACPI table is updated successfully.\r


@@ -116,7 +116,7 @@ AddAcpiHeader (
   IN      CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL  * CONST CfgMgrProtocol,\r
   IN      CONST ACPI_TABLE_GENERATOR                  * CONST Generator,\r
   IN OUT  EFI_ACPI_DESCRIPTION_HEADER                 * CONST AcpiHeader,\r
   IN      CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL  * CONST CfgMgrProtocol,\r
   IN      CONST ACPI_TABLE_GENERATOR                  * CONST Generator,\r
   IN OUT  EFI_ACPI_DESCRIPTION_HEADER                 * CONST AcpiHeader,\r

-  IN      CONST UINT32                                        Revision,\r
+  IN      CONST CM_STD_OBJ_ACPI_TABLE_INFO            * CONST AcpiTableInfo,\r

   IN      CONST UINT32                                        Length\r
   )\r
 {\r
   IN      CONST UINT32                                        Length\r
   )\r
 {\r


@@ -151,7 +151,7 @@ AddAcpiHeader (
   // UINT32  Length\r
   AcpiHeader->Length = Length;\r
   // UINT8   Revision\r
   // UINT32  Length\r
   AcpiHeader->Length = Length;\r
   // UINT8   Revision\r

-  AcpiHeader->Revision = Revision;\r
+  AcpiHeader->Revision = AcpiTableInfo->AcpiTableRevision;\r

   // UINT8   Checksum\r
   AcpiHeader->Checksum = 0;\r
 \r
   // UINT8   Checksum\r
   AcpiHeader->Checksum = 0;\r
 \r


@@ -159,12 +159,24 @@ AddAcpiHeader (
   CopyMem (AcpiHeader->OemId, CfgMfrInfo->OemId, sizeof (AcpiHeader->OemId));\r
 \r
   // UINT64  OemTableId\r
   CopyMem (AcpiHeader->OemId, CfgMfrInfo->OemId, sizeof (AcpiHeader->OemId));\r
 \r
   // UINT64  OemTableId\r

-  AcpiHeader->OemTableId = Generator->CreatorId;\r
-  AcpiHeader->OemTableId <<= 32;\r
-  AcpiHeader->OemTableId |= Generator->AcpiTableSignature;\r
+  if (AcpiTableInfo->OemTableId != 0) {\r
+    AcpiHeader->OemTableId = AcpiTableInfo->OemTableId;\r
+  } else {\r
+    AcpiHeader->OemTableId = SIGNATURE_32 (\r
+                               CfgMfrInfo->OemId[0],\r
+                               CfgMfrInfo->OemId[1],\r
+                               CfgMfrInfo->OemId[2],\r
+                               CfgMfrInfo->OemId[3]\r
+                               ) |\r
+                             ((UINT64)Generator->AcpiTableSignature << 32);\r
+  }\r

 \r
   // UINT32  OemRevision\r
 \r
   // UINT32  OemRevision\r

-  AcpiHeader->OemRevision = CfgMfrInfo->Revision;\r
+  if (AcpiTableInfo->OemRevision != 0) {\r
+    AcpiHeader->OemRevision = AcpiTableInfo->OemRevision;\r
+  } else {\r
+    AcpiHeader->OemRevision = CfgMfrInfo->Revision;\r
+  }\r

 \r
   // UINT32  CreatorId\r
   AcpiHeader->CreatorId = Generator->CreatorId;\r
 \r
   // UINT32  CreatorId\r
   AcpiHeader->CreatorId = Generator->CreatorId;\r