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]>
Change-Id: I4c1b04518889806e78a84e7b2c5c3b1c700f2bd2

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,112 @@
 
 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_RESOURCES      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  Pointer to the SMBIOS Handle Map if the
+                             CmObjectToken is found.
+  @retval NULL               if CmObjectToken is 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;
+}
+
+/** 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 SMBIOS_HANDLE_INVALID.
+**/
+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;
+}
+
 /** Return a pointer to the SMBIOS table generator.
 
   @param [in]  This         Pointer to the Dynamic Table Factory Protocol.

DynamicTablesPkg/Drivers/DynamicTableManagerDxe/DynamicTableManagerDxe.c

@@ -24,6 +24,7 @@
 #include "DynamicTableManagerDxe.h"
 
 STATIC VOID  *mAcpiTableProtocolRegistration;
+STATIC VOID  *mSmbiosProtocolRegistration;
 
 /** Entrypoint of Dynamic Table Manager Dxe.
 
@@ -54,6 +55,7 @@ DynamicTableManagerDxeInitialize (
   )
 {
   EFI_EVENT  AcpiEvent;
+  EFI_EVENT  SmbiosEvent;
 
   AcpiEvent = EfiCreateProtocolNotifyEvent (
                 &gEfiAcpiTableProtocolGuid,
@@ -70,5 +72,21 @@ DynamicTableManagerDxeInitialize (
     return EFI_OUT_OF_RESOURCES;
   }
 
+  SmbiosEvent = EfiCreateProtocolNotifyEvent (
+                  &gEfiSmbiosProtocolGuid,
+                  TPL_CALLBACK,
+                  SmbiosProtocolReady,
+                  NULL,
+                  &mSmbiosProtocolRegistration
+                  );
+  if (SmbiosEvent == NULL) {
+    DEBUG ((
+      DEBUG_ERROR,
+      "Failed to register SMBIOS protocol notification event.\n"
+      ));
+    gBS->CloseEvent (AcpiEvent);
+    return EFI_OUT_OF_RESOURCES;
+  }
+
   return EFI_SUCCESS;
 }

DynamicTablesPkg/Drivers/DynamicTableManagerDxe/DynamicTableManagerDxe.h

@@ -77,4 +77,21 @@ AcpiTableProtocolReady (
   IN  VOID       *Context
   );
 
+/** SMBIOS table Protocol ready event handler.
+
+  This event notification indicates that the SMBIOS protocol is ready.
+  Therefore, dispatch the building of the SMBIOS tables.
+
+  @param  [in]  Event     The Event that is signalled.
+  @param  [in]  Context   The Context information.
+
+  @retval None
+**/
+VOID
+EFIAPI
+SmbiosProtocolReady (
+  IN  EFI_EVENT  Event,
+  IN  VOID       *Context
+  );
+
 #endif // DYNAMIC_TABLE_MANAGER_DXE_H_

DynamicTablesPkg/Drivers/DynamicTableManagerDxe/DynamicTableManagerDxe.inf

@@ -1,5 +1,5 @@
 ## @file
-# Module that drives the table generation and installation process.
+#  Module that drives the table generation and installation process.
 #
 #  Copyright (c) 2017 - 2022, Arm Limited. All rights reserved.
 #  Copyright (c) 2024 Advanced Micro Devices, Inc. All rights reserved.
@@ -27,6 +27,7 @@
   SmbiosTableDispatcher.c
   SmbiosTableDispatcher.h
   AcpiTableBuilder.c
+  SmbiosTableBuilder.c
 
 [Sources.ARM, Sources.AARCH64]
   Arm/ArmDynamicTableManager.c
@@ -52,7 +53,7 @@
 [Protocols]
   gEfiAcpiTableProtocolGuid                     # PROTOCOL ALWAYS_CONSUMED
   gEfiAcpiSdtProtocolGuid                       # PROTOCOL ALWAYS_CONSUMED
-
+  gEfiSmbiosProtocolGuid                        # PROTOCOL ALWAYS_CONSUMED
   gEdkiiConfigurationManagerProtocolGuid        # PROTOCOL ALWAYS_CONSUMED
   gEdkiiDynamicTableFactoryProtocolGuid         # PROTOCOL ALWAYS_CONSUMED