DynamicTablesPkg: Add SMBIOS table generation

Add the SMBIOS Table generator code to the DynamicTablesPkg.

This change includes adding new logic to the DynamicTableManager
to process and add SMBIOS tables and augmenting the existing SMBIOS
Factory generator to include installing multiple SMBIOS tables .

Signed-off-by: Girish Mahadevan <[email protected]>

Author: gmahadevan

DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/DynamicTableFactory.h

@@ -49,6 +49,13 @@ typedef struct DynamicTableFactoryInfo {
         CustomDtTableGeneratorList[FixedPcdGet16 (
                                  PcdMaxCustomDTGenerators
                                  )];
+
+  /// An array for holding a map of SMBIOS handles and the CM Object
+  /// token used to build the SMBIOS record.
+  SMBIOS_HANDLE_MAP
+        SmbiosHandleMap[FixedPcdGet16 (
+                        PcdMaxSmbiosHandleMapEntries
+                        )];
 } EDKII_DYNAMIC_TABLE_FACTORY_INFO;
 
 /** Return a pointer to the ACPI table generator.

DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/DynamicTableFactoryDxe.c

@@ -44,6 +44,9 @@ EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL  DynamicTableFactoryProtocol = {
   GetDtTableGenerator,
   RegisterDtTableGenerator,
   DeregisterDtTableGenerator,
+  AddSmbiosHandle,
+  FindSmbiosHandle,
+  FindSmbiosHandleEx,
   &TableFactoryInfo
 };
 
@@ -65,6 +68,12 @@ DynamicTableFactoryDxeInitialize (
   )
 {
   EFI_STATUS  Status;
+  UINTN       Idx;
+
+  for (Idx = 0; Idx < FixedPcdGet16(PcdMaxSmbiosHandleMapEntries); Idx++) {
+    TableFactoryInfo.SmbiosHandleMap[Idx].SmbiosTblHandle = SMBIOS_HANDLE_PI_RESERVED;
+    TableFactoryInfo.SmbiosHandleMap[Idx].SmbiosCmToken   = 0;
+  }
 
   Status = gBS->InstallProtocolInterface (
                   &ImageHandle,

DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/DynamicTableFactoryDxe.inf

@@ -44,6 +44,7 @@
   gEdkiiDynamicTablesPkgTokenSpaceGuid.PcdMaxCustomACPIGenerators
   gEdkiiDynamicTablesPkgTokenSpaceGuid.PcdMaxCustomSMBIOSGenerators
   gEdkiiDynamicTablesPkgTokenSpaceGuid.PcdMaxCustomDTGenerators
+  gEdkiiDynamicTablesPkgTokenSpaceGuid.PcdMaxSmbiosHandleMapEntries
 
 [Protocols]
   gEdkiiDynamicTableFactoryProtocolGuid         # PRODUCES

DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/SmbiosTableFactory/SmbiosTableFactory.c

@@ -12,6 +12,7 @@
 #include <IndustryStandard/SmBios.h>
 #include <Library/BaseLib.h>
 #include <Library/BaseMemoryLib.h>
+#include <Library/MemoryAllocationLib.h>
 #include <Library/DebugLib.h>
 
 // Module specific include files.
@@ -24,6 +25,70 @@
 
 extern EDKII_DYNAMIC_TABLE_FACTORY_INFO  TableFactoryInfo;
 
+/** Add a new entry to the SMBIOS table Map.
+
+  @param [in]  Smbios         SMBIOS Protocol pointer.
+  @param [in]  SmbiosHandle   SMBIOS Handle to be added.
+  @param [in]  CmObjectToken  CmObjectToken of the CM_OBJECT used to build the SMBIOS Table
+  @param [in]  GeneratorId    Smbios Table Generator Id.
+
+  @retval EFI_SUCCESS               Successfully added/generated the handle.
+  @retval EFI_OUT_OF_RESOURCESNULL  Failure to add/generate the handle.
+**/
+EFI_STATUS
+EFIAPI
+AddSmbiosHandle (
+  IN EFI_SMBIOS_PROTOCOL         *Smbios,
+  IN SMBIOS_HANDLE               *SmbiosHandle,
+  IN CM_OBJECT_TOKEN             CmObjectToken,
+  IN SMBIOS_TABLE_GENERATOR_ID   GeneratorId
+  )
+{
+  EFI_STATUS  Status;
+  UINTN       Index;
+
+  Status = EFI_OUT_OF_RESOURCES;
+
+  for (Index = 0; Index < FixedPcdGet16(PcdMaxSmbiosHandleMapEntries); Index++) {
+    if (TableFactoryInfo.SmbiosHandleMap[Index].SmbiosTblHandle == SMBIOS_HANDLE_PI_RESERVED) {
+      TableFactoryInfo.SmbiosHandleMap[Index].SmbiosTblHandle   = *SmbiosHandle;
+      TableFactoryInfo.SmbiosHandleMap[Index].SmbiosCmToken     = CmObjectToken;
+      TableFactoryInfo.SmbiosHandleMap[Index].SmbiosGeneratorId = GeneratorId;
+      Status                                                    = EFI_SUCCESS;
+      break;
+    }
+  }
+
+  return Status;
+}
+
+/** Return a pointer to the SMBIOS table Map.
+
+  @param [in]  GeneratorId  The CmObjectToken to look up an SMBIOS Handle.
+
+  @retval SMBIOS_HANDLE_MAP if the CmObjectToken is found.
+  @retval NULL if not found.
+**/
+SMBIOS_HANDLE_MAP *
+EFIAPI
+FindSmbiosHandle (
+  CM_OBJECT_TOKEN  CmObjectToken
+  )
+{
+  UINTN              Index;
+  SMBIOS_HANDLE_MAP  *SmbiosHandleMap;
+
+  SmbiosHandleMap = NULL;
+  for (Index = 0; Index < FixedPcdGet16(PcdMaxSmbiosHandleMapEntries); Index++) {
+    if (TableFactoryInfo.SmbiosHandleMap[Index].SmbiosCmToken == CmObjectToken) {
+      SmbiosHandleMap = &TableFactoryInfo.SmbiosHandleMap[Index];
+      break;
+    }
+  }
+
+  return SmbiosHandleMap;
+}
+
 /** Return a pointer to the SMBIOS table generator.
 
   @param [in]  This         Pointer to the Dynamic Table Factory Protocol.
@@ -229,3 +294,44 @@ DeregisterSmbiosTableGenerator (
   DEBUG ((DEBUG_INFO, "Deregistering %s\n", Generator->Description));
   return EFI_SUCCESS;
 }
+
+/** Find and return SMBIOS handle based on associated CM object token.
+
+  @param [in]  GeneratorId     SMBIOS generator ID used to build the SMBIOS Table.
+  @param [in]  CmObjectToken   Token of the CM_OBJECT used to build the SMBIOS Table.
+
+  @return  SMBIOS handle of the table associated with SmbiosGeneratorId and
+           CmObjectToken if found. Otherwise, returns 0xFFFF.
+**/
+SMBIOS_HANDLE
+EFIAPI
+FindSmbiosHandleEx (
+  IN  SMBIOS_TABLE_GENERATOR_ID  GeneratorId,
+  IN  CM_OBJECT_TOKEN            CmObjToken
+  )
+{
+  SMBIOS_HANDLE_MAP  *HandleMap;
+
+  if (CmObjToken == CM_NULL_TOKEN) {
+    return SMBIOS_HANDLE_INVALID;
+  }
+
+  HandleMap = FindSmbiosHandle (CmObjToken);
+  if (HandleMap == NULL) {
+    return SMBIOS_HANDLE_INVALID;
+  }
+
+  if (HandleMap->SmbiosGeneratorId != GeneratorId) {
+    DEBUG ((
+      DEBUG_ERROR,
+      "%a: Expect ID %d but get %d\n",
+      __func__,
+      GeneratorId,
+      HandleMap->SmbiosGeneratorId
+      ));
+    ASSERT (FALSE);
+    return SMBIOS_HANDLE_INVALID;
+  }
+
+  return HandleMap->SmbiosTblHandle;
+}