Re: [edk2-platforms][PATCH V2 03/11] Platform/Sgi: Add Initial SMBIOS support

["Sami Mujawar" <sami.mujawar@arm.com>]

[-- Attachment #1: Type: text/plain, Size: 14531 bytes --]

Hi Pranav,

Please find my comments inline marked [SAMI].

With those addressed.

Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>

Regards,

Sami Mujawar

On 16/05/2021 10:29 AM, Pranav Madhu wrote:
> SMBIOS provides basic hardware and firmware configuration information
> through table-driven data structure. This patch adds SMBIOS driver
> support that allows for installation of multiple SMBIOS types. Also add
> SMBIOS Type0 (BIOS Information) table, that include information about
> BIOS vendor name, version, SMBIOS version and other information related
> to BIOS.
>
> Signed-off-by: Pranav Madhu <pranav.madhu@arm.com>
> ---
>   Platform/ARM/SgiPkg/SgiPlatform.dsc.inc                              |  10 ++
>   Platform/ARM/SgiPkg/SgiPlatform.fdf                                  |   8 +-
>   Platform/ARM/SgiPkg/Drivers/SmbiosPlatformDxe/SmbiosPlatformDxe.inf  |  46 +++++++
>   Platform/ARM/SgiPkg/Drivers/SmbiosPlatformDxe/SmbiosPlatformDxe.h    |  20 ++++
>   Platform/ARM/SgiPkg/Drivers/SmbiosPlatformDxe/SmbiosPlatformDxe.c    |  98 +++++++++++++++
>   Platform/ARM/SgiPkg/Drivers/SmbiosPlatformDxe/Type0BiosInformation.c | 125 ++++++++++++++++++++
>   6 files changed, 306 insertions(+), 1 deletion(-)
>
> diff --git a/Platform/ARM/SgiPkg/SgiPlatform.dsc.inc b/Platform/ARM/SgiPkg/SgiPlatform.dsc.inc
> index 42e3600d15f4..a0f217f5107c 100644
> --- a/Platform/ARM/SgiPkg/SgiPlatform.dsc.inc
> +++ b/Platform/ARM/SgiPkg/SgiPlatform.dsc.inc
> @@ -109,6 +109,10 @@
>     # ACPI Table Version
>     gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiExposedTableVersions|0x20
>   
> +  # SMBIOS entry point version
> +  gEfiMdeModulePkgTokenSpaceGuid.PcdSmbiosVersion|0x0304
> +  gEfiMdeModulePkgTokenSpaceGuid.PcdSmbiosDocRev|0x0
> +
>     #
>     # PCIe
>     #
> @@ -247,6 +251,12 @@
>     MdeModulePkg/Universal/Acpi/AcpiTableDxe/AcpiTableDxe.inf
>     MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabaseDxe.inf
>   
> +  #
> +  # SMBIOS/DMI
> +  #
> +  MdeModulePkg/Universal/SmbiosDxe/SmbiosDxe.inf
> +  Platform/ARM/SgiPkg/Drivers/SmbiosPlatformDxe/SmbiosPlatformDxe.inf
> +
>     #
>     # platform driver
>     #
> diff --git a/Platform/ARM/SgiPkg/SgiPlatform.fdf b/Platform/ARM/SgiPkg/SgiPlatform.fdf
> index da23804828e5..e11d943d6efc 100644
> --- a/Platform/ARM/SgiPkg/SgiPlatform.fdf
> +++ b/Platform/ARM/SgiPkg/SgiPlatform.fdf
> @@ -1,5 +1,5 @@
>   #
> -#  Copyright (c) 2018, ARM Limited. All rights reserved.
> +#  Copyright (c) 2018-2021, ARM Limited. All rights reserved.
>   #
>   #  SPDX-License-Identifier: BSD-2-Clause-Patent
>   #
> @@ -102,6 +102,12 @@ READ_LOCK_STATUS   = TRUE
>     INF MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabaseDxe.inf
>   !include $(BOARD_DXE_FV_COMPONENTS)
>   
> +  #
> +  # SMBIOS/DMI
> +  #
> +  INF MdeModulePkg/Universal/SmbiosDxe/SmbiosDxe.inf
> +  INF Platform/ARM/SgiPkg/Drivers/SmbiosPlatformDxe/SmbiosPlatformDxe.inf
> +
>     # Required by PCI
>     INF ArmPkg/Drivers/ArmPciCpuIo2Dxe/ArmPciCpuIo2Dxe.inf
>   
> diff --git a/Platform/ARM/SgiPkg/Drivers/SmbiosPlatformDxe/SmbiosPlatformDxe.inf b/Platform/ARM/SgiPkg/Drivers/SmbiosPlatformDxe/SmbiosPlatformDxe.inf
> new file mode 100644
> index 000000000000..3568380f8404
> --- /dev/null
> +++ b/Platform/ARM/SgiPkg/Drivers/SmbiosPlatformDxe/SmbiosPlatformDxe.inf
> @@ -0,0 +1,46 @@
> +## @file
> +#  This driver installs SMBIOS information for RD Platforms
> +#
> +#  Copyright (c) 2021, ARM Limited. All rights reserved.
> +#  SPDX-License-Identifier: BSD-2-Clause-Patent
> +##
> +
> +[Defines]
> +  INF_VERSION                    = 0x0001001A
> +  BASE_NAME                      = SmbiosPlatformDxe
> +  FILE_GUID                      = 86e0aa8b-4f8d-44a5-a140-1f693d529c76
> +  MODULE_TYPE                    = DXE_DRIVER
> +  VERSION_STRING                 = 1.0
> +  ENTRY_POINT                    = SmbiosTableEntryPoint
> +
> +[Sources]
> +  SmbiosPlatformDxe.c
> +  Type0BiosInformation.c
> +
> +[Packages]
> +  ArmPkg/ArmPkg.dec
> +  ArmPlatformPkg/ArmPlatformPkg.dec
> +  MdeModulePkg/MdeModulePkg.dec
> +  MdePkg/MdePkg.dec
> +  Platform/ARM/SgiPkg/SgiPlatform.dec
> +
> +[LibraryClasses]
> +  ArmPlatformLib
> +  DebugLib
> +  HobLib
> +  UefiDriverEntryPoint
> +
> +[Guids]
> +  gEfiGlobalVariableGuid
> +  gArmSgiPlatformIdDescriptorGuid
> +
> +[FixedPcd]
> +  gEfiMdeModulePkgTokenSpaceGuid.PcdFirmwareRevision
> +
> +[Protocols]
> +  gEfiSmbiosProtocolGuid                      # PROTOCOL ALWAYS_CONSUMED
> +
> +[Guids]
> +
> +[Depex]
> +  gEfiSmbiosProtocolGuid
> diff --git a/Platform/ARM/SgiPkg/Drivers/SmbiosPlatformDxe/SmbiosPlatformDxe.h b/Platform/ARM/SgiPkg/Drivers/SmbiosPlatformDxe/SmbiosPlatformDxe.h
> new file mode 100644
> index 000000000000..091e0ec8314e
> --- /dev/null
> +++ b/Platform/ARM/SgiPkg/Drivers/SmbiosPlatformDxe/SmbiosPlatformDxe.h
> @@ -0,0 +1,20 @@
> +/** @file
> +  Declarations required for SMBIOS DXE driver.
> +
> +  Functions declarations and data type declarations required for SMBIOS DXE
> +  driver of the Arm Reference Design platforms.
> +
> +  Copyright (c) 2021, ARM Limited. All rights reserved.
> +  SPDX-License-Identifier: BSD-2-Clause-Patent
> +**/
> +
> +#ifndef SMBIOS_PLATFORM_DXE_H_
> +#define SMBIOS_PLATFORM_DXE_H_
> +
> +EFI_STATUS
> +EFIAPI
> +InstallBiosInformation (
> +  IN     EFI_SMBIOS_PROTOCOL    *Smbios
> +  );
[SAMI] Doxygen header? Same comment for other patches in this series.
[/SAMI]
> +
> +#endif // SMBIOS_PLATFORM_DXE_H_
> diff --git a/Platform/ARM/SgiPkg/Drivers/SmbiosPlatformDxe/SmbiosPlatformDxe.c b/Platform/ARM/SgiPkg/Drivers/SmbiosPlatformDxe/SmbiosPlatformDxe.c
> new file mode 100644
> index 000000000000..eb3ba45ca654
> --- /dev/null
> +++ b/Platform/ARM/SgiPkg/Drivers/SmbiosPlatformDxe/SmbiosPlatformDxe.c
> @@ -0,0 +1,98 @@
> +/** @file
> +  Install SMBIOS tables for Arm's SGI/RD platforms.
> +
> +  This file is the driver entry point for installing SMBIOS tables on Arm's
> +  Reference Design platforms. For each SMBIOS table installation handler
> +  registered, the driver invokes the handler to register the respective table.
> +
> +  Copyright (c) 2021, ARM Limited. All rights reserved.
> +  SPDX-License-Identifier: BSD-2-Clause-Patent
> +
> +  @par Specification Reference:
> +    - SMBIOS Reference Specification 3.4.0
> +**/
> +
> +#include <IndustryStandard/SmBios.h>
> +#include <Library/DebugLib.h>
> +#include <Library/HobLib.h>
> +#include <Library/UefiBootServicesTableLib.h>
> +#include <PiDxe.h>
> +#include <Protocol/Smbios.h>
> +
> +#include "SgiPlatform.h"
> +#include "SmbiosPlatformDxe.h"
> +
> +typedef EFI_STATUS (*ARM_RD_SMBIOS_TABLE_INSTALL_FPTR)(EFI_SMBIOS_PROTOCOL *);
> +
> +STATIC
> +ARM_RD_SMBIOS_TABLE_INSTALL_FPTR mSmbiosTableList[] = {
> +  &InstallBiosInformation,
> +};
> +
> +/**
> +  Driver entry point. Installs SMBIOS information.
> +
> +  For all the available SMBIOS table installation handlers, invoke each of
> +  those handlers and let the handlers install the SMBIOS tables. The count
> +  of handlers that fail to install the SMBIOS tables is maintained for
> +  additional logging.
> +
> +  @param ImageHandle     Module's image handle.
> +  @param SystemTable     Pointer of EFI_SYSTEM_TABLE.
> +
> +  @retval EFI_SUCCESS    All SMBIOS table install handlers invoked.
> +  @retval EFI_NOT_FOUND  Unsupported platform.
> +  @retval Others         Failed to invoke SMBIOS table install handlders.
> +**/
> +EFI_STATUS
> +EFIAPI
> +SmbiosTableEntryPoint (
> +  IN     EFI_HANDLE             ImageHandle,
> +  IN     EFI_SYSTEM_TABLE       *SystemTable
> +  )
> +{
> +  EFI_STATUS Status;
> +  EFI_SMBIOS_PROTOCOL *Smbios = NULL;
> +  UINT8 CountFail = 0;
> +  UINT8 Idx;
> +
> +  /* Install SMBIOS table only for supported product */
> +  if (SgiGetProductId () == UnknownId) {
> +    DEBUG ((
> +      DEBUG_ERROR,
> +      "Failed to install SMBIOS: Unknown product\n"
> +      ));
> +    return EFI_NOT_FOUND;
> +  }
> +
> +  /* Find the SMBIOS protocol */
> +  Status = gBS->LocateProtocol (
> +                  &gEfiSmbiosProtocolGuid,
> +                  NULL,
> +                  (VOID **)&Smbios
> +                  );
> +  if (EFI_ERROR (Status)) {
> +    DEBUG ((
> +      DEBUG_ERROR,
> +      "Failed to install SMBIOS: Unable to locate protocol\n"
> +      ));
> +    return Status;
> +  }
> +
> +  /* Install the tables listed in mSmbiosTableList */
> +  for (Idx = 0; Idx < ARRAY_SIZE (mSmbiosTableList); Idx++) {
> +    Status = (*mSmbiosTableList[Idx]) (Smbios);
> +    if (Status != EFI_SUCCESS) {
> +      CountFail++;
> +    }
> +  }
> +
> +  DEBUG ((
> +    DEBUG_INFO,
> +    "Installed %d of %d available SMBIOS tables\n",
> +    ARRAY_SIZE (mSmbiosTableList) - CountFail,
> +    ARRAY_SIZE (mSmbiosTableList)
> +    ));
> +
> +  return EFI_SUCCESS;
> +}
> diff --git a/Platform/ARM/SgiPkg/Drivers/SmbiosPlatformDxe/Type0BiosInformation.c b/Platform/ARM/SgiPkg/Drivers/SmbiosPlatformDxe/Type0BiosInformation.c
> new file mode 100644
> index 000000000000..67c20c336c3d
> --- /dev/null
> +++ b/Platform/ARM/SgiPkg/Drivers/SmbiosPlatformDxe/Type0BiosInformation.c
> @@ -0,0 +1,125 @@
> +/** @file
> +  SMBIOS Type 0 (BIOS information) table for ARM RD platforms.
> +
> +  Install SMBIOS Type 0 (BIOS information) table for Arm's Reference Design
> +  platforms.
> +
> +  Copyright (c) 2021, ARM Limited. All rights reserved.
> +  SPDX-License-Identifier: BSD-2-Clause-Patent
> +
> +  @par Specification Reference:
> +    - SMBIOS Reference Specification 3.4.0, Chapter 7.1
> +**/
> +
> +#include <Library/DebugLib.h>
> +#include <Protocol/Smbios.h>
> +
> +#define TYPE0_STRINGS                                   \
> +  "ARM LTD\0"                   /* Vendor */            \
> +  "EDK II\0"                    /* BiosVersion */       \
> +  __DATE__"\0"                  /* BiosReleaseDate */   \
> +  "\0"
> +
> +/* SMBIOS Type0 structure */
> +#pragma pack(1)
> +struct ArmRdSmbiosType0 {
[SAMI] typedef for the struct ? Please also revisit the structure naming 
convention in the coding standard.
Same comment for other patches in this series.
[/SAMI]
> +  SMBIOS_TABLE_TYPE0  Base;
> +  INT8                Strings[sizeof (TYPE0_STRINGS)];
[SAMI]Can CHAR8 be used instead of INT8?
> +};
> +#pragma pack()
> +
> +/* BIOS information */
> +static struct ArmRdSmbiosType0 mArmRdSmbiosType0 = {
[SAMI] STATIC in capital letters.
[/SAMI]
> +  {
> +    {
> +      // SMBIOS header
> +      EFI_SMBIOS_TYPE_BIOS_INFORMATION, // Type 0
> +      sizeof (SMBIOS_TABLE_TYPE0),      // Length
> +      SMBIOS_HANDLE_PI_RESERVED,        // Assign an unused handle number
> +    },
> +    1,              // String number of vendor name in TYPE0_STRINGS
> +    2,              // String number of BiosVersion
[SAMI] Can enums be used for the string numbers? Same comment for other 
patches in this series.
> +    0,              // Bios starting address segment
> +    3,              // String number of BiosReleaseDate
> +    0,              // Bios ROM size
[SAMI] Neither BIOS ROM size not Extended BIOS ROM size is set. Is this 
specification compliant?
> +    {               // MISC_BIOS_CHARACTERISTICS BiosCharacteristics
> +      0,            // Reserved
> +      0,            // Unknown
> +      0,            // BIOS Characteristics are not supported
> +      0,            // ISA is supported
> +      0,            // MCA is supported
> +      0,            // EISA is supported
[SAMI] Can you revisit the comments for this structure initialisation, 
please? They look a bit out of place.
These look to be copied from the specification wherein the table column 
header mentions 'Meaning if Set'.
See if this can be clarified in the comments Or a suggestion would be to 
change the comments to something like '// ISA support'.
[/SAMI]
> +      1,            // PCI supported
> +      0,            // PC card (PCMCIA) is supported
> +      1,            // Plug and Play is supported
> +      0,            // APM is supported
> +      1,            // BIOS upgradable
> +      0,            // BIOS shadowing is allowed
> +      0,            // VL-VESA is supported
> +      0,            // ESCD support is available
> +      0,            // Boot from CD is supported
> +      1,            // selectable boot
> +    },
> +    {               // BIOSCharacteristicsExtensionBytes
> +      (
> +        (1 << 0) |  // ACPI Supported
> +        (1 << 1)    // Legacy USB supported
> +      ),
> +      (
> +        (1 << 3) |  // Content distribution enabled
> +        (1 << 4)    // UEFI spec supported
> +      )
> +    },
> +    0,              // SMBIOS Major Release, updated dynamically
> +    0,              // SMBIOS Minor Release, updated dynamically
> +    0xFF,           // Embedded Controller Firmware Major Release
> +    0xFF            // Embedded Controller Firmware Minor Release
> +  },
> +  // Text strings (unformatted area)
> +  TYPE0_STRINGS
> +};
> +
> +/**
> +  Install SMBIOS BIOS information Table.
> +
> +  Install the SMBIOS BIOS information (type 0) table for Arm's reference design
> +  platforms.
> +
> +  @param[in] Smbios   SMBIOS protocol.
> +
> +  @retval EFI_SUCCESS           Record was added.
> +  @retval EFI_OUT_OF_RESOURCES  Record was not added.
> +  @retval EFI_ALREADY_STARTED   The SmbiosHandle passed in is already in use.
> +**/
> +EFI_STATUS
> +InstallBiosInformation (
[SAMI] Would it be good to change the function name to indicate Type0 
SMBIOS table? Something like InstallType<n><Short description> ?
Same comment for other patches in this series.
[/SAMI]
> +  IN     EFI_SMBIOS_PROTOCOL    *Smbios
> +  )
> +{
> +  EFI_STATUS Status;
> +  EFI_SMBIOS_HANDLE SmbiosHandle;
> +
> +  SmbiosHandle = ((EFI_SMBIOS_TABLE_HEADER *)&mArmRdSmbiosType0)->Handle;
> +
> +  /* Update firmware revision */
> +  mArmRdSmbiosType0.Base.SystemBiosMajorRelease =
> +    (PcdGet32 ( PcdFirmwareRevision ) >> 16) & 0xFF;
[SAMI] No space should be there before and after PcdFirmwareRevision. 
Same comment for the line below.
> +  mArmRdSmbiosType0.Base.SystemBiosMinorRelease =
> +    PcdGet32 ( PcdFirmwareRevision ) & 0xFF;
> +
> +  /* Install type 0 table */
> +  Status = Smbios->Add (
> +                     Smbios,
> +                     NULL,
> +                     &SmbiosHandle,
> +                     (EFI_SMBIOS_TABLE_HEADER *)&mArmRdSmbiosType0
> +                     );
> +  if (Status != EFI_SUCCESS) {
[SAMI] if (EFI_ERROR (Status)) ?
> +    DEBUG ((
> +      DEBUG_ERROR,
> +      "SMBIOS: Failed to install Type0 SMBIOS table.\n"
> +      ));
> +  }
> +
> +  return Status;
> +}


[-- Attachment #2: Type: text/html, Size: 16062 bytes --]