Re: [PATCH v5 20/23] ArmPkg: Add Universal/Smbios/OemMiscLibNull

["Leif Lindholm" <leif@nuviainc.com>]

On Mon, Jan 04, 2021 at 15:58:27 -0700, Rebecca Cran wrote:
> Add a Null implementation of OemMiscLib.
> 
> OemMiscLib provides functions that platforms implement to fill in
> SMBIOS information for the SmbiosMiscDxe and ProcessSubClassDxe drivers.

Given that it would never be a useful thing to *use* this library
at runtime, could you add ASSERT (FALSE) to all functions?

/
    Leif

> 
> Signed-off-by: Rebecca Cran <rebecca@nuviainc.com>
> ---
>  ArmPkg/Universal/Smbios/OemMiscLibNull/OemMiscLibNull.inf |  31 +++++
>  ArmPkg/Universal/Smbios/OemMiscLibNull/OemMiscLib.c       | 140 ++++++++++++++++++++
>  2 files changed, 171 insertions(+)
> 
> diff --git a/ArmPkg/Universal/Smbios/OemMiscLibNull/OemMiscLibNull.inf b/ArmPkg/Universal/Smbios/OemMiscLibNull/OemMiscLibNull.inf
> new file mode 100644
> index 000000000000..342290acdb53
> --- /dev/null
> +++ b/ArmPkg/Universal/Smbios/OemMiscLibNull/OemMiscLibNull.inf
> @@ -0,0 +1,31 @@
> +#/** @file
> +#    OemMiscLib.inf
> +#
> +#    Copyright (c) 2020, NUVIA Inc. All rights reserved.
> +#    Copyright (c) 2018, Hisilicon Limited. All rights reserved.
> +#    Copyright (c) 2018, Linaro Limited. All rights reserved.
> +#
> +#    SPDX-License-Identifier: BSD-2-Clause-Patent
> +#
> +#**/
> +
> +[Defines]
> +  INF_VERSION                    = 1.29
> +  BASE_NAME                      = OemMiscLibNull
> +  FILE_GUID                      = e80b8e6b-fffb-4c39-b433-41de67c9d7b8
> +  MODULE_TYPE                    = BASE
> +  VERSION_STRING                 = 1.0
> +  LIBRARY_CLASS                  = OemMiscLib
> +
> +[Sources.common]
> +  OemMiscLib.c
> +
> +[Packages]
> +  ArmPkg/ArmPkg.dec
> +  EmbeddedPkg/EmbeddedPkg.dec
> +  MdeModulePkg/MdeModulePkg.dec
> +  MdePkg/MdePkg.dec
> +
> +[LibraryClasses]
> +  BaseMemoryLib
> +
> diff --git a/ArmPkg/Universal/Smbios/OemMiscLibNull/OemMiscLib.c b/ArmPkg/Universal/Smbios/OemMiscLibNull/OemMiscLib.c
> new file mode 100644
> index 000000000000..ceee45839746
> --- /dev/null
> +++ b/ArmPkg/Universal/Smbios/OemMiscLibNull/OemMiscLib.c
> @@ -0,0 +1,140 @@
> +/** @file
> +*  OemMiscLib.c
> +*
> +*  Copyright (c) 2018, Hisilicon Limited. All rights reserved.
> +*  Copyright (c) 2018, Linaro Limited. All rights reserved.
> +*
> +*  SPDX-License-Identifier: BSD-2-Clause-Patent
> +*
> +**/
> +
> +#include <Uefi.h>
> +#include <Library/BaseMemoryLib.h>
> +#include <Library/HiiLib.h>
> +
> +#include <Library/OemMiscLib.h>
> +
> +
> +/** Gets the CPU frequency of the specified processor.
> +
> +  @param ProcessorIndex Index of the processor to get the frequency for.
> +
> +  @return               CPU frequency in Hz
> +**/
> +EFIAPI
> +UINTN
> +OemGetCpuFreq (
> +  IN UINT8 ProcessorIndex
> +  )
> +{
> +  return 0;
> +}
> +
> +/** Gets information about the specified processor and stores it in
> +    the structures provided.
> +
> +  @param ProcessorIndex  Index of the processor to get the information for.
> +  @param ProcessorStatus Processor status.
> +  @param ProcessorCharacteristics Processor characteritics.
> +  @param MiscProcessorData        Miscellaneous processor information.
> +
> +  @return  TRUE on success, FALSE on failure.
> +**/
> +EFIAPI
> +BOOLEAN
> +OemGetProcessorInformation (
> +  IN UINTN ProcessorIndex,
> +  IN OUT PROCESSOR_STATUS_DATA *ProcessorStatus,
> +  IN OUT PROCESSOR_CHARACTERISTIC_FLAGS *ProcessorCharacteristics,
> +  IN OUT MISC_PROCESSOR_DATA *MiscProcessorData
> +  )
> +{
> +  return TRUE;
> +}
> +
> +/** Gets information about the cache at the specified cache level.
> +
> +  @param ProcessorIndex The processor to get information for.
> +  @param CacheLevel The cache level to get information for.
> +  @param InstructionOrUnifiedCache Whether the cache is instruction or
> +                                   unified, not data.
> +  @param SmbiosCacheTable The SMBIOS Type7 cache information structure.
> +
> +  @return TRUE on success, FALSE on failure.
> +**/
> +EFIAPI
> +BOOLEAN
> +OemGetCacheInformation (
> +  IN UINT8   ProcessorIndex,
> +  IN UINT8   CacheLevel,
> +  IN BOOLEAN InstructionOrUnifiedCache,
> +  IN OUT SMBIOS_TABLE_TYPE7 *SmbiosCacheTable
> +  )
> +{
> +  return TRUE;
> +}
> +
> +/** Gets the maximum number of sockets supported by the platform.
> +
> +  @return The maximum number of sockets.
> +**/
> +EFIAPI
> +UINT8
> +OemGetProcessorMaxSockets (
> +  VOID
> +  )
> +{
> +  return 1;
> +}
> +
> +/** Gets the type of chassis for the system.
> +
> +  @param ChassisType The type of the chassis.
> +
> +  @retval EFI_SUCCESS The chassis type was fetched successfully.
> +**/
> +EFI_STATUS
> +EFIAPI
> +OemGetChassisType (
> +  UINT8 *ChassisType
> +  )
> +{
> +  *ChassisType = MiscChassisTypeUnknown;
> +  return EFI_SUCCESS;
> +}
> +
> +/** Returns whether the specified processor is present or not.
> +
> +  @param ProcessIndex The processor index to check.
> +
> +  @return TRUE is the processor is present, FALSE otherwise.
> +**/
> +EFIAPI
> +BOOLEAN
> +OemIsSocketPresent (
> +  IN UINTN ProcessorIndex
> +  )
> +{
> +  if (ProcessorIndex == 0) {
> +    return TRUE;
> +  }
> +
> +  return FALSE;
> +}
> +
> +/** Updates the HII string for the specified field.
> +
> +  @param mHiiHandle    The HII handle.
> +  @param TokenToUpdate The string to update.
> +  @param Offset        The field to get information about.
> +**/
> +EFIAPI
> +VOID
> +UpdateSmbiosInfo (
> +  IN EFI_HII_HANDLE mHiiHandle,
> +  IN EFI_STRING_ID TokenToUpdate,
> +  IN SMBIOS_HII_STRING_FIELD Offset
> +  )
> +{
> +
> +}
> -- 
> 2.26.2
>