Enhance SmbiosDxe driver:

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

/** @file\r
  This code supports the implementation of the Smbios protocol\r
  \r
Copyright (c) 2009 - 2012, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The full text of the license may be found at        \r
http://opensource.org/licenses/bsd-license.php                                            \r
                                                                                          \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
**/\r
\r
#ifndef _SMBIOS_DXE_H_\r
#define _SMBIOS_DXE_H_\r
\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
\r
//\r
// The length of the entire structure table (including all strings) must be reported\r
// in the Structure Table Length field of the SMBIOS Structure Table Entry Point,\r
// which is a WORD field limited to 65,535 bytes.\r
//\r
#define SMBIOS_TABLE_MAX_LENGTH 0xFFFF\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
//\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
} 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
\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
VOID\r
EFIAPI\r
SmbiosTableConstruction (\r
  VOID\r
  );\r
\r
#endif\r