EmulatorPkg/MiscSubClassPlatformDxe/MiscSubClassDriver.h

   1 /*++
   2
   3 Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
   4 This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13
  14   MiscSubclassDriver.h
  15
  16 Abstract:
  17
  18   Header file for MiscSubclass Driver.
  19
  20 **/
  21
  22 #ifndef _MISC_SUBCLASS_DRIVER_H
  23 #define _MISC_SUBCLASS_DRIVER_H
  24
  25 #include <FrameworkDxe.h>
  26
  27 #include <Guid/DataHubRecords.h>
  28 #include <IndustryStandard/SmBios.h>
  29 #include <Protocol/Smbios.h>
  30 #include <Protocol/EmuIoThunk.h>
  31
  32 #include <Library/BaseLib.h>
  33 #include <Library/DebugLib.h>
  34 #include <Library/HiiLib.h>
  35 #include <Library/UefiLib.h>
  36 #include <Library/UefiDriverEntryPoint.h>
  37 #include <Library/BaseMemoryLib.h>
  38 #include <Library/MemoryAllocationLib.h>
  39 #include <Library/UefiBootServicesTableLib.h>
  40 #include <Library/DevicePathLib.h>
  41 #include <Library/PcdLib.h>
  42
  43
  44 #include <MiscDevicePath.h>
  45 #include <Protocol/FrameworkHii.h>
  46 #include <Library/HiiLib.h>
  47
  48 //
  49 // Data table entry update function.
  50 //
  51 typedef EFI_STATUS (EFIAPI EFI_MISC_SMBIOS_DATA_FUNCTION) (
  52   IN  VOID                 *RecordData,
  53   IN  EFI_SMBIOS_PROTOCOL  *Smbios
  54   );
  55
  56 //
  57 // Data table entry definition.
  58 //
  59 typedef struct {
  60   //
  61   // intermediat input data for SMBIOS record
  62   //
  63   VOID                              *RecordData;
  64   EFI_MISC_SMBIOS_DATA_FUNCTION     *Function;
  65 } EFI_MISC_SMBIOS_DATA_TABLE;
  66
  67 //
  68 // Data Table extern definitions.
  69 //
  70 #define MISC_SMBIOS_TABLE_EXTERNS(NAME1, NAME2, NAME3) \
  71 extern NAME1 NAME2 ## Data; \
  72 extern EFI_MISC_SMBIOS_DATA_FUNCTION NAME3 ## Function
  73
  74
  75 //
  76 // Data Table entries
  77 //
  78 #define MISC_SMBIOS_TABLE_ENTRY_DATA_AND_FUNCTION(NAME1, NAME2) \
  79 { \
  80   & NAME1 ## Data, \
  81   & NAME2 ## Function \
  82 }
  83
  84 //
  85 // Global definition macros.
  86 //
  87 #define MISC_SMBIOS_TABLE_DATA(NAME1, NAME2) \
  88   NAME1 NAME2 ## Data
  89
  90 #define MISC_SMBIOS_TABLE_FUNCTION(NAME2) \
  91   EFI_STATUS EFIAPI NAME2 ## Function( \
  92   IN  VOID                  *RecordData, \
  93   IN  EFI_SMBIOS_PROTOCOL   *Smbios \
  94   )
  95
  96
  97 //
  98 // Data Table Array
  99 //
 100 extern EFI_MISC_SMBIOS_DATA_TABLE mMiscSubclassDataTable[];
 101
 102 //
 103 // Data Table Array Entries
 104 //
 105 extern UINTN                        mMiscSubclassDataTableEntries;
 106 extern UINT8                        MiscSubclassStrings[];
 107 extern EFI_HII_HANDLE               mHiiHandle;
 108
 109 /**
 110   Add an SMBIOS record.
 111
 112   @param  Smbios                The EFI_SMBIOS_PROTOCOL instance.
 113   @param  SmbiosHandle          A unique handle will be assigned to the SMBIOS record.
 114   @param  Record                The data for the fixed portion of the SMBIOS record. The format of the record is
 115                                 determined by EFI_SMBIOS_TABLE_HEADER.Type. The size of the formatted area is defined
 116                                 by EFI_SMBIOS_TABLE_HEADER.Length and either followed by a double-null (0x0000) or
 117                                 a set of null terminated strings and a null.
 118
 119   @retval EFI_SUCCESS           Record was added.
 120   @retval EFI_OUT_OF_RESOURCES  Record was not added due to lack of system resources.
 121
 122 **/
 123 EFI_STATUS
 124 AddSmbiosRecord (
 125   IN EFI_SMBIOS_PROTOCOL        *Smbios,
 126   OUT EFI_SMBIOS_HANDLE         *SmbiosHandle,
 127   IN EFI_SMBIOS_TABLE_HEADER    *Record
 128   );
 129
 130 #endif /* _MISC_SUBCLASS_DRIVER_H */
 131
 132 /* eof - MiscSubclassDriver.h */