MdeModulePkg/Universal/SmbiosDxe/SmbiosDxe.h

   1 /** @file
   2   This code supports the implementation of the Smbios protocol
   3
   4 Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
   5 This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef _SMBIOS_DXE_H_
  16 #define _SMBIOS_DXE_H_
  17
  18
  19 #include <PiDxe.h>
  20
  21 #include <Protocol/Smbios.h>
  22 #include <IndustryStandard/SmBios.h>
  23 #include <Guid/EventGroup.h>
  24 #include <Guid/SmBios.h>
  25 #include <Library/DebugLib.h>
  26 #include <Library/UefiDriverEntryPoint.h>
  27 #include <Library/UefiLib.h>
  28 #include <Library/BaseLib.h>
  29 #include <Library/BaseMemoryLib.h>
  30 #include <Library/MemoryAllocationLib.h>
  31 #include <Library/UefiBootServicesTableLib.h>
  32 #include <Library/PcdLib.h>
  33
  34 #define SMBIOS_INSTANCE_SIGNATURE SIGNATURE_32 ('S', 'B', 'i', 's')
  35 typedef struct {
  36   UINT32                Signature;
  37   EFI_HANDLE            Handle;
  38   //
  39   // Produced protocol
  40   //
  41   EFI_SMBIOS_PROTOCOL   Smbios;
  42   //
  43   // Updates to record list must be locked.
  44   //
  45   EFI_LOCK              DataLock;
  46   //
  47   // List of EFI_SMBIOS_ENTRY structures.
  48   //
  49   LIST_ENTRY            DataListHead;
  50   //
  51   // List of allocated SMBIOS handle.
  52   //
  53   LIST_ENTRY            AllocatedHandleListHead;
  54 } SMBIOS_INSTANCE;
  55
  56 #define SMBIOS_INSTANCE_FROM_THIS(this)  CR (this, SMBIOS_INSTANCE, Smbios, SMBIOS_INSTANCE_SIGNATURE)
  57
  58 //
  59 // SMBIOS record Header
  60 //
  61 // An SMBIOS internal Record is an EFI_SMBIOS_RECORD_HEADER followed by (RecordSize - HeaderSize) bytes of
  62 //  data. The format of the data is defined by the SMBIOS spec.
  63 //
  64 //
  65 #define EFI_SMBIOS_RECORD_HEADER_VERSION  0x0100
  66 typedef struct {
  67   UINT16      Version;
  68   UINT16      HeaderSize;
  69   UINTN       RecordSize;
  70   EFI_HANDLE  ProducerHandle;
  71   UINTN       NumberOfStrings;
  72 } EFI_SMBIOS_RECORD_HEADER;
  73
  74
  75 //
  76 // Private data structure to contain the SMBIOS record. One record per
  77 //  structure. SmbiosRecord is a copy of the data passed in and follows RecordHeader .
  78 //
  79 #define EFI_SMBIOS_ENTRY_SIGNATURE  SIGNATURE_32 ('S', 'r', 'e', 'c')
  80 typedef struct {
  81   UINT32                    Signature;
  82   LIST_ENTRY                Link;
  83   EFI_SMBIOS_RECORD_HEADER  *RecordHeader;
  84   UINTN                     RecordSize;
  85 } EFI_SMBIOS_ENTRY;
  86
  87 #define SMBIOS_ENTRY_FROM_LINK(link)  CR (link, EFI_SMBIOS_ENTRY, Link, EFI_SMBIOS_ENTRY_SIGNATURE)
  88
  89 //
  90 // Private data to contain the Smbios handle that already allocated.
  91 //
  92 #define SMBIOS_HANDLE_ENTRY_SIGNATURE  SIGNATURE_32 ('S', 'h', 'r', 'd')
  93
  94 typedef struct {
  95   UINT32               Signature;
  96   LIST_ENTRY           Link;
  97   //
  98   // Filter driver will register what record guid filter should be used.
  99   //
 100   EFI_SMBIOS_HANDLE    SmbiosHandle;
 101
 102 } SMBIOS_HANDLE_ENTRY;
 103
 104 #define SMBIOS_HANDLE_ENTRY_FROM_LINK(link)  CR (link, SMBIOS_HANDLE_ENTRY, Link, SMBIOS_HANDLE_ENTRY_SIGNATURE)
 105
 106 typedef struct {
 107   EFI_SMBIOS_TABLE_HEADER  Header;
 108   UINT8                    Tailing[2];
 109 } EFI_SMBIOS_TABLE_END_STRUCTURE;
 110
 111 #endif