ArmPkg: Add Universal/Smbios/SmbiosMiscDxe

[mirror_edk2.git] / ArmPkg / Universal / Smbios / SmbiosMiscDxe / SmbiosMisc.h

/** @file\r
  Header file for the SmbiosMisc Driver.\r
\r
  Based on files under Nt32Pkg/MiscSubClassPlatformDxe/\r
\r
  Copyright (c) 2021, NUVIA Inc. All rights reserved.<BR>\r
  Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
  Copyright (c) 2015, Hisilicon Limited. All rights reserved.<BR>\r
  Copyright (c) 2015, Linaro Limited. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef SMBIOS_MISC_H_\r
#define SMBIOS_MISC_H_\r
\r
#include <Protocol/Smbios.h>\r
#include <IndustryStandard/SmBios.h>\r
\r
//\r
// Data table entry update function.\r
//\r
typedef EFI_STATUS (EFIAPI SMBIOS_MISC_DATA_FUNCTION) (\r
  IN  VOID                 *RecordData,\r
  IN  EFI_SMBIOS_PROTOCOL  *Smbios\r
  );\r
\r
\r
//\r
// Data table entry definition.\r
//\r
typedef struct {\r
  //\r
  // intermediate input data for SMBIOS record\r
  //\r
  VOID                          *RecordData;\r
  SMBIOS_MISC_DATA_FUNCTION     *Function;\r
} SMBIOS_MISC_DATA_TABLE;\r
\r
\r
//\r
// SMBIOS table extern definitions\r
//\r
#define SMBIOS_MISC_TABLE_EXTERNS(NAME1, NAME2, NAME3) \\r
extern NAME1 NAME2 ## Data; \\r
extern SMBIOS_MISC_DATA_FUNCTION NAME3 ## Function;\r
\r
\r
//\r
// SMBIOS data table entries\r
//\r
// This is used to define a pair of table structure pointer and functions\r
// in order to iterate through the list of tables, populate them and add\r
// them into the system.\r
#define SMBIOS_MISC_TABLE_ENTRY_DATA_AND_FUNCTION(NAME1, NAME2) \\r
{ \\r
  & NAME1 ## Data, \\r
    NAME2 ## Function \\r
}\r
\r
//\r
// Global definition macros.\r
//\r
#define SMBIOS_MISC_TABLE_DATA(NAME1, NAME2) \\r
  NAME1 NAME2 ## Data\r
\r
#define SMBIOS_MISC_TABLE_FUNCTION(NAME2) \\r
  EFI_STATUS EFIAPI NAME2 ## Function( \\r
  IN  VOID                  *RecordData, \\r
  IN  EFI_SMBIOS_PROTOCOL   *Smbios \\r
  )\r
\r
//\r
// Data Table Array Entries\r
//\r
extern EFI_HII_HANDLE               mSmbiosMiscHiiHandle;\r
\r
typedef struct _SMBIOS_TYPE13_BIOS_LANGUAGE_INFORMATION_STRING{\r
  UINT8                               *LanguageSignature;\r
  EFI_STRING_ID                       InstallableLanguageLongString;\r
  EFI_STRING_ID                       InstallableLanguageAbbreviateString;\r
} SMBIOS_TYPE13_BIOS_LANGUAGE_INFORMATION_STRING;\r
\r
\r
/**\r
  Adds an SMBIOS record.\r
\r
  @param  Buffer        The data for the SMBIOS record.\r
                        The format of the record is determined by\r
                        EFI_SMBIOS_TABLE_HEADER.Type. The size of the\r
                        formatted area is defined by EFI_SMBIOS_TABLE_HEADER.Length\r
                        and either followed by a double-null (0x0000) or a set\r
                        of null terminated strings and a null.\r
  @param  SmbiosHandle  A unique handle will be assigned to the SMBIOS record\r
                        if not NULL.\r
\r
  @retval EFI_SUCCESS           Record was added.\r
  @retval EFI_OUT_OF_RESOURCES  Record was not added due to lack of system resources.\r
  @retval EFI_ALREADY_STARTED   The SmbiosHandle passed in was already in use.\r
\r
**/\r
EFI_STATUS\r
SmbiosMiscAddRecord (\r
  IN       UINT8                      *Buffer,\r
  IN  OUT  EFI_SMBIOS_HANDLE          *SmbiosHandle OPTIONAL\r
  );\r
\r
/**\r
 Get Link Type Handle.\r
\r
 @param [in]   SmbiosType     Get this Type from SMBIOS table\r
 @param [out]  HandleArray    Pointer to handle array which will be freed by caller\r
 @param [out]  HandleCount    Pointer to handle count\r
\r
**/\r
VOID\r
SmbiosMiscGetLinkTypeHandle(\r
  IN  UINT8                 SmbiosType,\r
  OUT UINT16                **HandleArray,\r
  OUT UINTN                 *HandleCount\r
  );\r
\r
//\r
// Data Table Array\r
//\r
extern SMBIOS_MISC_DATA_TABLE   mSmbiosMiscDataTable[];\r
\r
//\r
// Data Table Array Entries\r
//\r
extern UINTN   mSmbiosMiscDataTableEntries;\r
extern UINT8   mSmbiosMiscDxeStrings[];\r
\r
#endif // SMBIOS_MISC_H_\r