]>
Commit | Line | Data |
---|---|---|
7130bcef SM |
1 | /** @file\r |
2 | Table Helper\r | |
3 | \r | |
4 | Copyright (c) 2017 - 2019, ARM Limited. All rights reserved.\r | |
9cd9bdc6 | 5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
7130bcef SM |
6 | **/\r |
7 | \r | |
8 | #include <Protocol/AcpiTable.h>\r | |
9 | #include <Library/BaseLib.h>\r | |
10 | #include <Library/DebugLib.h>\r | |
11 | #include <Library/BaseMemoryLib.h>\r | |
12 | \r | |
13 | // Module specific include files.\r | |
14 | #include <AcpiTableGenerator.h>\r | |
15 | #include <ConfigurationManagerObject.h>\r | |
c1b53091 | 16 | #include <Library/TableHelperLib.h>\r |
7130bcef SM |
17 | #include <Protocol/ConfigurationManagerProtocol.h>\r |
18 | \r | |
19 | /** The GetCgfMgrInfo function gets the CM_STD_OBJ_CONFIGURATION_MANAGER_INFO\r | |
20 | object from the Configuration Manager.\r | |
21 | \r | |
22 | @param [in] CfgMgrProtocol Pointer to the Configuration Manager protocol\r | |
23 | interface.\r | |
24 | @param [out] CfgMfrInfo Pointer to the Configuration Manager Info\r | |
25 | object structure.\r | |
26 | \r | |
27 | @retval EFI_SUCCESS The object is returned.\r | |
28 | @retval EFI_INVALID_PARAMETER The Object ID is invalid.\r | |
29 | @retval EFI_NOT_FOUND The requested Object is not found.\r | |
30 | @retval EFI_BAD_BUFFER_SIZE The size returned by the Configuration\r | |
31 | Manager is less than the Object size.\r | |
32 | **/\r | |
33 | EFI_STATUS\r | |
34 | EFIAPI\r | |
35 | GetCgfMgrInfo (\r | |
36 | IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL * CONST CfgMgrProtocol,\r | |
37 | OUT CM_STD_OBJ_CONFIGURATION_MANAGER_INFO ** CfgMfrInfo\r | |
38 | )\r | |
39 | {\r | |
40 | EFI_STATUS Status;\r | |
41 | CM_OBJ_DESCRIPTOR CmObjectDesc;\r | |
42 | \r | |
43 | ASSERT (CfgMgrProtocol != NULL);\r | |
44 | ASSERT (CfgMfrInfo != NULL);\r | |
45 | \r | |
46 | *CfgMfrInfo = NULL;\r | |
47 | Status = CfgMgrProtocol->GetObject (\r | |
48 | CfgMgrProtocol,\r | |
49 | CREATE_CM_STD_OBJECT_ID (EStdObjCfgMgrInfo),\r | |
50 | CM_NULL_TOKEN,\r | |
51 | &CmObjectDesc\r | |
52 | );\r | |
53 | if (EFI_ERROR (Status)) {\r | |
54 | DEBUG ((\r | |
55 | DEBUG_ERROR,\r | |
56 | "ERROR: Failed to Get Configuration Manager Info. Status = %r\n",\r | |
57 | Status\r | |
58 | ));\r | |
59 | return Status;\r | |
60 | }\r | |
61 | \r | |
62 | if (CmObjectDesc.ObjectId != CREATE_CM_STD_OBJECT_ID (EStdObjCfgMgrInfo)) {\r | |
63 | DEBUG ((\r | |
64 | DEBUG_ERROR,\r | |
65 | "ERROR: EStdObjCfgMgrInfo: Invalid ObjectId = 0x%x, expected Id = 0x%x\n",\r | |
66 | CmObjectDesc.ObjectId,\r | |
67 | CREATE_CM_STD_OBJECT_ID (EStdObjCfgMgrInfo)\r | |
68 | ));\r | |
69 | ASSERT (FALSE);\r | |
70 | return EFI_INVALID_PARAMETER;\r | |
71 | }\r | |
72 | \r | |
73 | if (CmObjectDesc.Size <\r | |
74 | (sizeof (CM_STD_OBJ_CONFIGURATION_MANAGER_INFO) * CmObjectDesc.Count)) {\r | |
75 | DEBUG ((\r | |
76 | DEBUG_ERROR,\r | |
77 | "ERROR: EStdObjCfgMgrInfo: Buffer too small, size = 0x%x\n",\r | |
78 | CmObjectDesc.Size\r | |
79 | ));\r | |
80 | ASSERT (FALSE);\r | |
81 | return EFI_BAD_BUFFER_SIZE;\r | |
82 | }\r | |
83 | \r | |
84 | *CfgMfrInfo = (CM_STD_OBJ_CONFIGURATION_MANAGER_INFO*)CmObjectDesc.Data;\r | |
85 | return Status;\r | |
86 | }\r | |
87 | \r | |
88 | /** The AddAcpiHeader function updates the ACPI header structure pointed by\r | |
89 | the AcpiHeader. It utilizes the ACPI table Generator and the Configuration\r | |
90 | Manager protocol to obtain any information required for constructing the\r | |
91 | header.\r | |
92 | \r | |
93 | @param [in] CfgMgrProtocol Pointer to the Configuration Manager\r | |
94 | protocol interface.\r | |
95 | @param [in] Generator Pointer to the ACPI table Generator.\r | |
96 | @param [in,out] AcpiHeader Pointer to the ACPI table header to be\r | |
97 | updated.\r | |
e12bdeb1 | 98 | @param [in] AcpiTableInfo Pointer to the ACPI table info structure.\r |
7130bcef SM |
99 | @param [in] Length Length of the ACPI table.\r |
100 | \r | |
101 | @retval EFI_SUCCESS The ACPI table is updated successfully.\r | |
102 | @retval EFI_INVALID_PARAMETER A parameter is invalid.\r | |
103 | @retval EFI_NOT_FOUND The required object information is not found.\r | |
104 | @retval EFI_BAD_BUFFER_SIZE The size returned by the Configuration\r | |
105 | Manager is less than the Object size for the\r | |
106 | requested object.\r | |
107 | **/\r | |
108 | EFI_STATUS\r | |
109 | EFIAPI\r | |
110 | AddAcpiHeader (\r | |
111 | IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL * CONST CfgMgrProtocol,\r | |
112 | IN CONST ACPI_TABLE_GENERATOR * CONST Generator,\r | |
113 | IN OUT EFI_ACPI_DESCRIPTION_HEADER * CONST AcpiHeader,\r | |
e12bdeb1 | 114 | IN CONST CM_STD_OBJ_ACPI_TABLE_INFO * CONST AcpiTableInfo,\r |
7130bcef SM |
115 | IN CONST UINT32 Length\r |
116 | )\r | |
117 | {\r | |
118 | EFI_STATUS Status;\r | |
119 | CM_STD_OBJ_CONFIGURATION_MANAGER_INFO * CfgMfrInfo;\r | |
120 | \r | |
121 | ASSERT (CfgMgrProtocol != NULL);\r | |
122 | ASSERT (Generator != NULL);\r | |
123 | ASSERT (AcpiHeader != NULL);\r | |
124 | ASSERT (Length >= sizeof (EFI_ACPI_DESCRIPTION_HEADER));\r | |
125 | \r | |
126 | if ((CfgMgrProtocol == NULL) ||\r | |
127 | (Generator == NULL) ||\r | |
128 | (AcpiHeader == NULL) ||\r | |
129 | (Length < sizeof (EFI_ACPI_DESCRIPTION_HEADER))\r | |
130 | ) {\r | |
131 | return EFI_INVALID_PARAMETER;\r | |
132 | }\r | |
133 | \r | |
134 | Status = GetCgfMgrInfo (CfgMgrProtocol, &CfgMfrInfo);\r | |
135 | if (EFI_ERROR (Status)) {\r | |
136 | DEBUG ((\r | |
137 | DEBUG_ERROR,\r | |
138 | "ERROR: Failed to get Configuration Manager info. Status = %r\n",\r | |
139 | Status\r | |
140 | ));\r | |
141 | goto error_handler;\r | |
142 | }\r | |
143 | \r | |
144 | // UINT32 Signature\r | |
145 | AcpiHeader->Signature = Generator->AcpiTableSignature;\r | |
146 | // UINT32 Length\r | |
147 | AcpiHeader->Length = Length;\r | |
148 | // UINT8 Revision\r | |
e12bdeb1 | 149 | AcpiHeader->Revision = AcpiTableInfo->AcpiTableRevision;\r |
7130bcef SM |
150 | // UINT8 Checksum\r |
151 | AcpiHeader->Checksum = 0;\r | |
152 | \r | |
153 | // UINT8 OemId[6]\r | |
154 | CopyMem (AcpiHeader->OemId, CfgMfrInfo->OemId, sizeof (AcpiHeader->OemId));\r | |
155 | \r | |
156 | // UINT64 OemTableId\r | |
e12bdeb1 SM |
157 | if (AcpiTableInfo->OemTableId != 0) {\r |
158 | AcpiHeader->OemTableId = AcpiTableInfo->OemTableId;\r | |
159 | } else {\r | |
160 | AcpiHeader->OemTableId = SIGNATURE_32 (\r | |
161 | CfgMfrInfo->OemId[0],\r | |
162 | CfgMfrInfo->OemId[1],\r | |
163 | CfgMfrInfo->OemId[2],\r | |
164 | CfgMfrInfo->OemId[3]\r | |
165 | ) |\r | |
166 | ((UINT64)Generator->AcpiTableSignature << 32);\r | |
167 | }\r | |
7130bcef SM |
168 | \r |
169 | // UINT32 OemRevision\r | |
e12bdeb1 SM |
170 | if (AcpiTableInfo->OemRevision != 0) {\r |
171 | AcpiHeader->OemRevision = AcpiTableInfo->OemRevision;\r | |
172 | } else {\r | |
173 | AcpiHeader->OemRevision = CfgMfrInfo->Revision;\r | |
174 | }\r | |
7130bcef SM |
175 | \r |
176 | // UINT32 CreatorId\r | |
177 | AcpiHeader->CreatorId = Generator->CreatorId;\r | |
178 | // UINT32 CreatorRevision\r | |
179 | AcpiHeader->CreatorRevision = Generator->CreatorRevision;\r | |
180 | \r | |
181 | error_handler:\r | |
182 | return Status;\r | |
183 | }\r | |
c1b53091 KK |
184 | \r |
185 | /**\r | |
186 | Test and report if a duplicate entry exists in the given array of comparable\r | |
187 | elements.\r | |
188 | \r | |
189 | @param [in] Array Array of elements to test for duplicates.\r | |
190 | @param [in] Count Number of elements in Array.\r | |
191 | @param [in] ElementSize Size of an element in bytes\r | |
192 | @param [in] EqualTestFunction The function to call to check if any two\r | |
193 | elements are equal.\r | |
194 | \r | |
195 | @retval TRUE A duplicate element was found or one of\r | |
196 | the input arguments is invalid.\r | |
197 | @retval FALSE Every element in Array is unique.\r | |
198 | **/\r | |
199 | BOOLEAN\r | |
200 | EFIAPI\r | |
201 | FindDuplicateValue (\r | |
202 | IN CONST VOID * Array,\r | |
203 | IN CONST UINTN Count,\r | |
204 | IN CONST UINTN ElementSize,\r | |
205 | IN PFN_IS_EQUAL EqualTestFunction\r | |
206 | )\r | |
207 | {\r | |
208 | UINTN Index1;\r | |
209 | UINTN Index2;\r | |
210 | UINT8 * Element1;\r | |
211 | UINT8 * Element2;\r | |
212 | \r | |
213 | if (Array == NULL) {\r | |
214 | DEBUG ((DEBUG_ERROR, "ERROR: FindDuplicateValues: Array is NULL.\n"));\r | |
215 | return TRUE;\r | |
216 | }\r | |
217 | \r | |
218 | if (ElementSize == 0) {\r | |
219 | DEBUG ((DEBUG_ERROR, "ERROR: FindDuplicateValues: ElementSize is 0.\n"));\r | |
220 | return TRUE;\r | |
221 | }\r | |
222 | \r | |
223 | if (EqualTestFunction == NULL) {\r | |
224 | DEBUG ((\r | |
225 | DEBUG_ERROR,\r | |
226 | "ERROR: FindDuplicateValues: EqualTestFunction is NULL.\n"\r | |
227 | ));\r | |
228 | return TRUE;\r | |
229 | }\r | |
230 | \r | |
231 | if (Count < 2) {\r | |
232 | return FALSE;\r | |
233 | }\r | |
234 | \r | |
235 | for (Index1 = 0; Index1 < Count - 1; Index1++) {\r | |
236 | for (Index2 = Index1 + 1; Index2 < Count; Index2++) {\r | |
237 | Element1 = (UINT8*)Array + (Index1 * ElementSize);\r | |
238 | Element2 = (UINT8*)Array + (Index2 * ElementSize);\r | |
239 | \r | |
240 | if (EqualTestFunction (Element1, Element2, Index1, Index2)) {\r | |
241 | return TRUE;\r | |
242 | }\r | |
243 | }\r | |
244 | }\r | |
245 | return FALSE;\r | |
246 | }\r |