]>
Commit | Line | Data |
---|---|---|
a485dce6 SM |
1 | /** @file\r |
2 | \r | |
3 | Copyright (c) 2017 - 2019, ARM Limited. All rights reserved.\r | |
4 | \r | |
5 | This program and the accompanying materials\r | |
6 | are licensed and made available under the terms and conditions of the BSD License\r | |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
13 | **/\r | |
14 | \r | |
15 | #ifndef SMBIOS_TABLE_GENERATOR_H_\r | |
16 | #define SMBIOS_TABLE_GENERATOR_H_\r | |
17 | \r | |
18 | #include <IndustryStandard/SmBios.h>\r | |
19 | \r | |
20 | #include <TableGenerator.h>\r | |
21 | \r | |
22 | #pragma pack(1)\r | |
23 | \r | |
24 | /** The SMBIOS_TABLE_GENERATOR_ID type describes SMBIOS table generator ID.\r | |
25 | */\r | |
26 | typedef TABLE_GENERATOR_ID SMBIOS_TABLE_GENERATOR_ID;\r | |
27 | \r | |
28 | /** The ESTD_SMBIOS_TABLE_ID enum describes the SMBIOS table IDs reserved for\r | |
29 | the standard generators.\r | |
30 | \r | |
31 | NOTE: The SMBIOS Generator IDs do not match the table type numbers!\r | |
32 | This allows 0 to be used to catch invalid parameters.\r | |
33 | */\r | |
34 | typedef enum StdSmbiosTableGeneratorId {\r | |
35 | EStdSmbiosTableIdReserved = 0x0000,\r | |
36 | EStdSmbiosTableIdRAW,\r | |
37 | EStdSmbiosTableIdType00,\r | |
38 | EStdSmbiosTableIdType01,\r | |
39 | EStdSmbiosTableIdType02,\r | |
40 | EStdSmbiosTableIdType03,\r | |
41 | EStdSmbiosTableIdType04,\r | |
42 | EStdSmbiosTableIdType05,\r | |
43 | EStdSmbiosTableIdType06,\r | |
44 | EStdSmbiosTableIdType07,\r | |
45 | EStdSmbiosTableIdType08,\r | |
46 | EStdSmbiosTableIdType09,\r | |
47 | EStdSmbiosTableIdType10,\r | |
48 | EStdSmbiosTableIdType11,\r | |
49 | EStdSmbiosTableIdType12,\r | |
50 | EStdSmbiosTableIdType13,\r | |
51 | EStdSmbiosTableIdType14,\r | |
52 | EStdSmbiosTableIdType15,\r | |
53 | EStdSmbiosTableIdType16,\r | |
54 | EStdSmbiosTableIdType17,\r | |
55 | EStdSmbiosTableIdType18,\r | |
56 | EStdSmbiosTableIdType19,\r | |
57 | EStdSmbiosTableIdType20,\r | |
58 | EStdSmbiosTableIdType21,\r | |
59 | EStdSmbiosTableIdType22,\r | |
60 | EStdSmbiosTableIdType23,\r | |
61 | EStdSmbiosTableIdType24,\r | |
62 | EStdSmbiosTableIdType25,\r | |
63 | EStdSmbiosTableIdType26,\r | |
64 | EStdSmbiosTableIdType27,\r | |
65 | EStdSmbiosTableIdType28,\r | |
66 | EStdSmbiosTableIdType29,\r | |
67 | EStdSmbiosTableIdType30,\r | |
68 | EStdSmbiosTableIdType31,\r | |
69 | EStdSmbiosTableIdType32,\r | |
70 | EStdSmbiosTableIdType33,\r | |
71 | EStdSmbiosTableIdType34,\r | |
72 | EStdSmbiosTableIdType35,\r | |
73 | EStdSmbiosTableIdType36,\r | |
74 | EStdSmbiosTableIdType37,\r | |
75 | EStdSmbiosTableIdType38,\r | |
76 | EStdSmbiosTableIdType39,\r | |
77 | EStdSmbiosTableIdType40,\r | |
78 | EStdSmbiosTableIdType41,\r | |
79 | EStdSmbiosTableIdType42,\r | |
80 | \r | |
81 | // IDs 43 - 125 are reserved\r | |
82 | \r | |
83 | EStdSmbiosTableIdType126 = (EStdSmbiosTableIdType00 + 126),\r | |
84 | EStdSmbiosTableIdType127,\r | |
85 | EStdSmbiosTableIdMax\r | |
86 | } ESTD_SMBIOS_TABLE_ID;\r | |
87 | \r | |
88 | /** This macro checks if the Table Generator ID is for an SMBIOS Table\r | |
89 | Generator.\r | |
90 | \r | |
91 | @param [in] TableGeneratorId The table generator ID.\r | |
92 | \r | |
93 | @return TRUE if the table generator ID is for an SMBIOS Table\r | |
94 | Generator.\r | |
95 | **/\r | |
96 | #define IS_GENERATOR_TYPE_SMBIOS(TableGeneratorId) \\r | |
97 | ( \\r | |
98 | GET_TABLE_TYPE (TableGeneratorId) == \\r | |
99 | ETableGeneratorTypeSmbios \\r | |
100 | )\r | |
101 | \r | |
102 | /** This macro checks if the Table Generator ID is for a standard SMBIOS\r | |
103 | Table Generator.\r | |
104 | \r | |
105 | @param [in] TableGeneratorId The table generator ID.\r | |
106 | \r | |
107 | @return TRUE if the table generator ID is for a standard SMBIOS\r | |
108 | Table Generator.\r | |
109 | **/\r | |
110 | #define IS_VALID_STD_SMBIOS_GENERATOR_ID(TableGeneratorId) \\r | |
111 | ( \\r | |
112 | IS_GENERATOR_NAMESPACE_STD(TableGeneratorId) && \\r | |
113 | IS_GENERATOR_TYPE_SMBIOS(TableGeneratorId) && \\r | |
114 | ((GET_TABLE_ID(GeneratorId) >= EStdSmbiosTableIdRaw) && \\r | |
115 | (GET_TABLE_ID(GeneratorId) < EStdSmbiosTableIdMax)) \\r | |
116 | )\r | |
117 | \r | |
118 | /** This macro creates a standard SMBIOS Table Generator ID.\r | |
119 | \r | |
120 | @param [in] TableId The table generator ID.\r | |
121 | \r | |
122 | @return a standard SMBIOS table generator ID.\r | |
123 | **/\r | |
124 | #define CREATE_STD_SMBIOS_TABLE_GEN_ID(TableId) \\r | |
125 | CREATE_TABLE_GEN_ID ( \\r | |
126 | ETableGeneratorTypeSmbios, \\r | |
127 | ETableGeneratorNameSpaceStd, \\r | |
128 | TableId \\r | |
129 | )\r | |
130 | \r | |
131 | /** Forward declarations.\r | |
132 | */\r | |
133 | typedef struct ConfigurationManagerProtocol EDKII_CONFIGURATION_MANAGER_PROTOCOL;\r | |
134 | typedef struct CmStdObjSmbiosTableInfo CM_STD_OBJ_SMBIOS_TABLE_INFO;\r | |
135 | typedef struct SmbiosTableGenerator SMBIOS_TABLE_GENERATOR;\r | |
136 | \r | |
137 | /** This function pointer describes the interface to SMBIOS table build\r | |
138 | functions provided by the SMBIOS table generator and called by the\r | |
139 | Table Manager to build an SMBIOS table.\r | |
140 | \r | |
141 | @param [in] Generator Pointer to the SMBIOS table generator.\r | |
142 | @param [in] SmbiosTableInfo Pointer to the SMBIOS table information.\r | |
143 | @param [in] CfgMgrProtocol Pointer to the Configuration Manager\r | |
144 | Protocol interface.\r | |
145 | @param [out] Table Pointer to the generated SMBIOS table.\r | |
146 | \r | |
147 | @return EFI_SUCCESS If the table is generated successfully or other\r | |
148 | failure codes as returned by the generator.\r | |
149 | **/\r | |
150 | typedef EFI_STATUS (*SMBIOS_TABLE_GENERATOR_BUILD_TABLE) (\r | |
151 | IN CONST SMBIOS_TABLE_GENERATOR * Generator,\r | |
152 | IN CM_STD_OBJ_SMBIOS_TABLE_INFO * CONST SmbiosTableInfo,\r | |
153 | IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL * CONST CfgMgrProtocol,\r | |
154 | OUT SMBIOS_STRUCTURE ** Table\r | |
155 | );\r | |
156 | \r | |
157 | /** This function pointer describes the interface to used by the\r | |
158 | Table Manager to give the generator an opportunity to free\r | |
159 | any resources allocated for building the SMBIOS table.\r | |
160 | \r | |
161 | @param [in] Generator Pointer to the SMBIOS table generator.\r | |
162 | @param [in] SmbiosTableInfo Pointer to the SMBIOS table information.\r | |
163 | @param [in] CfgMgrProtocol Pointer to the Configuration Manager\r | |
164 | Protocol interface.\r | |
165 | @param [in] Table Pointer to the generated SMBIOS table.\r | |
166 | \r | |
167 | @return EFI_SUCCESS If freed successfully or other failure codes\r | |
168 | as returned by the generator.\r | |
169 | **/\r | |
170 | typedef EFI_STATUS (*SMBIOS_TABLE_GENERATOR_FREE_TABLE) (\r | |
171 | IN CONST SMBIOS_TABLE_GENERATOR * Generator,\r | |
172 | IN CONST CM_STD_OBJ_SMBIOS_TABLE_INFO * CONST SmbiosTableInfo,\r | |
173 | IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL * CONST CfgMgrProtocol,\r | |
174 | IN SMBIOS_STRUCTURE ** Table\r | |
175 | );\r | |
176 | \r | |
177 | /** The SMBIOS_TABLE_GENERATOR structure provides an interface that the\r | |
178 | Table Manager can use to invoke the functions to build SMBIOS tables.\r | |
179 | */\r | |
180 | typedef struct SmbiosTableGenerator {\r | |
181 | /// The SMBIOS table generator ID.\r | |
182 | SMBIOS_TABLE_GENERATOR_ID GeneratorID;\r | |
183 | \r | |
184 | /// String describing the DT table\r | |
185 | /// generator.\r | |
186 | CONST CHAR16* Description;\r | |
187 | \r | |
188 | /// The SMBIOS table type.\r | |
189 | SMBIOS_TYPE Type;\r | |
190 | \r | |
191 | /// SMBIOS table build function pointer.\r | |
192 | SMBIOS_TABLE_GENERATOR_BUILD_TABLE BuildSmbiosTable;\r | |
193 | \r | |
194 | /** The function to free any resources\r | |
195 | allocated for building the SMBIOS table.\r | |
196 | */\r | |
197 | SMBIOS_TABLE_GENERATOR_FREE_TABLE FreeTableResources;\r | |
198 | } SMBIOS_TABLE_GENERATOR;\r | |
199 | \r | |
200 | /** Register SMBIOS table factory generator.\r | |
201 | \r | |
202 | The SMBIOS table factory maintains a list of the Standard and OEM SMBIOS\r | |
203 | table generators.\r | |
204 | \r | |
205 | @param [in] Generator Pointer to the SMBIOS table generator.\r | |
206 | \r | |
207 | @retval EFI_SUCCESS The Generator was registered\r | |
208 | successfully.\r | |
209 | @retval EFI_INVALID_PARAMETER The Generator ID is invalid or\r | |
210 | the Generator pointer is NULL.\r | |
211 | @retval EFI_ALREADY_STARTED The Generator for the Table ID is\r | |
212 | already registered.\r | |
213 | **/\r | |
214 | EFI_STATUS\r | |
215 | EFIAPI\r | |
216 | RegisterSmbiosTableGenerator (\r | |
217 | IN CONST SMBIOS_TABLE_GENERATOR * CONST Generator\r | |
218 | );\r | |
219 | \r | |
220 | /** Deregister SMBIOS generator.\r | |
221 | \r | |
222 | This function is called by the SMBIOS table generator to deregister itself\r | |
223 | from the SMBIOS table factory.\r | |
224 | \r | |
225 | @param [in] Generator Pointer to the SMBIOS table generator.\r | |
226 | \r | |
227 | @retval EFI_SUCCESS Success.\r | |
228 | @retval EFI_INVALID_PARAMETER The generator is invalid.\r | |
229 | @retval EFI_NOT_FOUND The requested generator is not found\r | |
230 | in the list of registered generators.\r | |
231 | **/\r | |
232 | EFI_STATUS\r | |
233 | EFIAPI\r | |
234 | DeregisterSmbiosTableGenerator (\r | |
235 | IN CONST SMBIOS_TABLE_GENERATOR * CONST Generator\r | |
236 | );\r | |
237 | #pragma pack()\r | |
238 | \r | |
239 | #endif // SMBIOS_TABLE_GENERATOR_H_\r | |
240 | \r |