• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /**@file
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 #include <WinNtDxe.h>
27 #include <Guid/DataHubRecords.h>
28 #include <IndustryStandard/SmBios.h>
29 #include <Protocol/Smbios.h>
30 #include <Protocol/WinNtIo.h>
31 #include <Library/BaseLib.h>
32 #include <Library/DebugLib.h>
33 #include <Library/HiiLib.h>
34 #include <Library/UefiLib.h>
35 #include <Library/UefiDriverEntryPoint.h>
36 #include <Library/BaseMemoryLib.h>
37 #include <Library/UefiBootServicesTableLib.h>
38 #include <Library/DevicePathLib.h>
39 #include <Library/PcdLib.h>
40 #include <Library/MemoryAllocationLib.h>
41 #include <MiscDevicePath.h>
42 
43 
44 //
45 // Data table entry update function.
46 //
47 typedef EFI_STATUS (EFIAPI EFI_MISC_SMBIOS_DATA_FUNCTION) (
48   IN  VOID                 *RecordData,
49   IN  EFI_SMBIOS_PROTOCOL  *Smbios
50   );
51 
52 //
53 // Data table entry definition.
54 //
55 typedef struct {
56   //
57   // intermediat input data for SMBIOS record
58   //
59   VOID                              *RecordData;
60   EFI_MISC_SMBIOS_DATA_FUNCTION     *Function;
61 } EFI_MISC_SMBIOS_DATA_TABLE;
62 
63 //
64 // Data Table extern definitions.
65 //
66 #define MISC_SMBIOS_TABLE_EXTERNS(NAME1, NAME2, NAME3) \
67 extern NAME1 NAME2 ## Data; \
68 extern EFI_MISC_SMBIOS_DATA_FUNCTION NAME3 ## Function
69 
70 
71 //
72 // Data Table entries
73 //
74 #define MISC_SMBIOS_TABLE_ENTRY_DATA_AND_FUNCTION(NAME1, NAME2) \
75 { \
76   & NAME1 ## Data, \
77   & NAME2 ## Function \
78 }
79 
80 //
81 // Global definition macros.
82 //
83 #define MISC_SMBIOS_TABLE_DATA(NAME1, NAME2) \
84   NAME1 NAME2 ## Data
85 
86 #define MISC_SMBIOS_TABLE_FUNCTION(NAME2) \
87   EFI_STATUS EFIAPI NAME2 ## Function( \
88   IN  VOID                  *RecordData, \
89   IN  EFI_SMBIOS_PROTOCOL   *Smbios \
90   )
91 
92 
93 //
94 // Data Table Array
95 //
96 extern EFI_MISC_SMBIOS_DATA_TABLE mMiscSubclassDataTable[];
97 
98 //
99 // Data Table Array Entries
100 //
101 extern UINTN                        mMiscSubclassDataTableEntries;
102 extern UINT8                        MiscSubclassStrings[];
103 extern EFI_HII_HANDLE               mHiiHandle;
104 
105 
106 /**
107   Add an SMBIOS record.
108 
109   @param  Smbios                The EFI_SMBIOS_PROTOCOL instance.
110   @param  SmbiosHandle          A unique handle will be assigned to the SMBIOS record.
111   @param  Record                The data for the fixed portion of the SMBIOS record. The format of the record is
112                                 determined by EFI_SMBIOS_TABLE_HEADER.Type. The size of the formatted area is defined
113                                 by EFI_SMBIOS_TABLE_HEADER.Length and either followed by a double-null (0x0000) or
114                                 a set of null terminated strings and a null.
115 
116   @retval EFI_SUCCESS           Record was added.
117   @retval EFI_OUT_OF_RESOURCES  Record was not added due to lack of system resources.
118 
119 **/
120 EFI_STATUS
121 AddSmbiosRecord (
122   IN EFI_SMBIOS_PROTOCOL        *Smbios,
123   OUT EFI_SMBIOS_HANDLE         *SmbiosHandle,
124   IN EFI_SMBIOS_TABLE_HEADER    *Record
125   );
126 
127 #endif /* _MISC_SUBCLASS_DRIVER_H */
128 
129 /* eof - MiscSubclassDriver.h */
130