UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm

[mirror_edk2.git] / MdeModulePkg / Universal / SmbiosDxe / SmbiosDxe.h

/** @file\r
  This code supports the implementation of the Smbios protocol\r
\r
Copyright (c) 2009 - 2021, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _SMBIOS_DXE_H_\r
#define _SMBIOS_DXE_H_\r
\r
#include <PiDxe.h>\r
\r
#include <Protocol/Smbios.h>\r
#include <IndustryStandard/SmBios.h>\r
#include <Guid/EventGroup.h>\r
#include <Guid/SmBios.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/HobLib.h>\r
#include <UniversalPayload/SmbiosTable.h>\r
\r
#define SMBIOS_INSTANCE_SIGNATURE  SIGNATURE_32 ('S', 'B', 'i', 's')\r
typedef struct {\r
  UINT32                 Signature;\r
  EFI_HANDLE             Handle;\r
  //\r
  // Produced protocol\r
  //\r
  EFI_SMBIOS_PROTOCOL    Smbios;\r
  //\r
  // Updates to record list must be locked.\r
  //\r
  EFI_LOCK               DataLock;\r
  //\r
  // List of EFI_SMBIOS_ENTRY structures.\r
  //\r
  LIST_ENTRY             DataListHead;\r
  //\r
  // List of allocated SMBIOS handle.\r
  //\r
  LIST_ENTRY             AllocatedHandleListHead;\r
} SMBIOS_INSTANCE;\r
\r
#define SMBIOS_INSTANCE_FROM_THIS(this)  CR (this, SMBIOS_INSTANCE, Smbios, SMBIOS_INSTANCE_SIGNATURE)\r
\r
//\r
// SMBIOS record Header\r
//\r
// An SMBIOS internal Record is an EFI_SMBIOS_RECORD_HEADER followed by (RecordSize - HeaderSize) bytes of\r
//  data. The format of the data is defined by the SMBIOS spec.\r
//\r
//\r
#define EFI_SMBIOS_RECORD_HEADER_VERSION  0x0100\r
typedef struct {\r
  UINT16        Version;\r
  UINT16        HeaderSize;\r
  UINTN         RecordSize;\r
  EFI_HANDLE    ProducerHandle;\r
  UINTN         NumberOfStrings;\r
} EFI_SMBIOS_RECORD_HEADER;\r
\r
//\r
// Private data structure to contain the SMBIOS record. One record per\r
//  structure. SmbiosRecord is a copy of the data passed in and follows RecordHeader .\r
//\r
#define EFI_SMBIOS_ENTRY_SIGNATURE  SIGNATURE_32 ('S', 'r', 'e', 'c')\r
typedef struct {\r
  UINT32                      Signature;\r
  LIST_ENTRY                  Link;\r
  EFI_SMBIOS_RECORD_HEADER    *RecordHeader;\r
  UINTN                       RecordSize;\r
  //\r
  // Indicate which table this record is added to.\r
  //\r
  BOOLEAN                     Smbios32BitTable;\r
  BOOLEAN                     Smbios64BitTable;\r
} EFI_SMBIOS_ENTRY;\r
\r
#define SMBIOS_ENTRY_FROM_LINK(link)  CR (link, EFI_SMBIOS_ENTRY, Link, EFI_SMBIOS_ENTRY_SIGNATURE)\r
\r
//\r
// Private data to contain the Smbios handle that already allocated.\r
//\r
#define SMBIOS_HANDLE_ENTRY_SIGNATURE  SIGNATURE_32 ('S', 'h', 'r', 'd')\r
\r
typedef struct {\r
  UINT32               Signature;\r
  LIST_ENTRY           Link;\r
  //\r
  // Filter driver will register what record guid filter should be used.\r
  //\r
  EFI_SMBIOS_HANDLE    SmbiosHandle;\r
} SMBIOS_HANDLE_ENTRY;\r
\r
#define SMBIOS_HANDLE_ENTRY_FROM_LINK(link)  CR (link, SMBIOS_HANDLE_ENTRY, Link, SMBIOS_HANDLE_ENTRY_SIGNATURE)\r
\r
typedef struct {\r
  EFI_SMBIOS_TABLE_HEADER    Header;\r
  UINT8                      Tailing[2];\r
} EFI_SMBIOS_TABLE_END_STRUCTURE;\r
\r
/**\r
  Create Smbios Table and installs the Smbios Table to the System Table.\r
\r
  @param  Smbios32BitTable    The flag to update 32-bit table.\r
  @param  Smbios64BitTable    The flag to update 64-bit table.\r
\r
**/\r
VOID\r
EFIAPI\r
SmbiosTableConstruction (\r
  BOOLEAN  Smbios32BitTable,\r
  BOOLEAN  Smbios64BitTable\r
  );\r
\r
/**\r
  Validates a SMBIOS 3.0 table entry point.\r
\r
  @param  TableEntry       The SmBios table entry to validate.\r
  @param  TableAddress     On exit, point to the smbios table addres.\r
  @param  TableMaximumSize On exit, point to the maximum size of the table.\r
\r
  @retval TRUE           SMBIOS table entry point is valid.\r
  @retval FALSE          SMBIOS table entry point is malformed.\r
\r
**/\r
STATIC\r
BOOLEAN\r
IsValidSmbios30Table (\r
  IN  VOID   *TableEntry,\r
  OUT VOID   **TableAddress,\r
  OUT UINTN  *TableMaximumSize,\r
  OUT UINT8  *MajorVersion,\r
  OUT UINT8  *MinorVersion\r
  );\r
\r
/**\r
  Validates a SMBIOS 2.0 table entry point.\r
\r
  @param  TableEntry       The SmBios table entry to validate.\r
  @param  TableAddress     On exit, point to the smbios table addres.\r
  @param  TableMaximumSize On exit, point to the maximum size of the table.\r
\r
  @retval TRUE           SMBIOS table entry point is valid.\r
  @retval FALSE          SMBIOS table entry point is malformed.\r
\r
**/\r
STATIC\r
BOOLEAN\r
IsValidSmbios20Table (\r
  IN  VOID   *TableEntry,\r
  OUT VOID   **TableAddress,\r
  OUT UINTN  *TableMaximumSize,\r
  OUT UINT8  *MajorVersion,\r
  OUT UINT8  *MinorVersion\r
  );\r
\r
/**\r
  Validates a SMBIOS table entry point.\r
\r
  @param  TableEntry       The SmBios table entry to validate.\r
  @param  TableAddress     On exit, point to the smbios table addres.\r
  @param  TableMaximumSize On exit, point to the maximum size of the table.\r
\r
  @retval TRUE           SMBIOS table entry point is valid.\r
  @retval FALSE          SMBIOS table entry point is malformed.\r
\r
**/\r
typedef\r
BOOLEAN\r
(*IS_SMBIOS_TABLE_VALID) (\r
  IN  VOID   *TableEntry,\r
  OUT VOID   **TableAddress,\r
  OUT UINTN  *TableMaximumSize,\r
  OUT UINT8  *MajorVersion,\r
  OUT UINT8  *MinorVersion\r
  );\r
typedef struct {\r
  EFI_GUID                 *Guid;\r
  IS_SMBIOS_TABLE_VALID    IsValid;\r
} IS_SMBIOS_TABLE_VALID_ENTRY;\r
\r
#endif\r