]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Universal/Acpi/AcpiTableDxe/AcpiTableProtocol.c
InstallAcpiTable() - Do not update the checksum in the passed in buffer – the buffer...
[mirror_edk2.git] / MdeModulePkg / Universal / Acpi / AcpiTableDxe / AcpiTableProtocol.c
CommitLineData
5f55c700 1/** @file\r
2 ACPI Table Protocol Implementation\r
3\r
36d58153 4 Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
e5eed7d3 5 This program and the accompanying materials\r
5f55c700 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//\r
16// Includes\r
17//\r
18#include "AcpiTable.h"\r
da935a5c 19//\r
20// The maximum number of tables that pre-allocated. \r
21//\r
22UINTN mEfiAcpiMaxNumTables = EFI_ACPI_MAX_NUM_TABLES; \r
5f55c700 23\r
24/**\r
25 This function adds an ACPI table to the table list. It will detect FACS and\r
26 allocate the correct type of memory and properly align the table.\r
27\r
28 @param AcpiTableInstance Instance of the protocol.\r
29 @param Table Table to add.\r
30 @param Checksum Does the table require checksumming.\r
31 @param Version The version of the list to add the table to.\r
32 @param Handle Pointer for returning the handle.\r
33\r
34 @return EFI_SUCCESS The function completed successfully.\r
35 @return EFI_OUT_OF_RESOURCES Could not allocate a required resource.\r
36 @return EFI_ABORTED The table is a duplicate of a table that is required\r
37 to be unique.\r
38\r
39**/\r
40EFI_STATUS\r
41AddTableToList (\r
42 IN EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance,\r
43 IN VOID *Table,\r
44 IN BOOLEAN Checksum,\r
45 IN EFI_ACPI_TABLE_VERSION Version,\r
46 OUT UINTN *Handle\r
47 );\r
48\r
49/**\r
50 This function finds and removes the table specified by the handle.\r
51\r
52 @param AcpiTableInstance Instance of the protocol.\r
53 @param Version Bitmask of which versions to remove.\r
54 @param Handle Table to remove.\r
55\r
56 @return EFI_SUCCESS The function completed successfully.\r
57 @return EFI_ABORTED An error occurred.\r
58 @return EFI_NOT_FOUND Handle not found in table list.\r
59\r
60**/\r
61EFI_STATUS\r
62RemoveTableFromList (\r
63 IN EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance,\r
64 IN EFI_ACPI_TABLE_VERSION Version,\r
65 IN UINTN Handle\r
66 );\r
67\r
68/**\r
69 This function calculates and updates an UINT8 checksum.\r
70\r
71 @param Buffer Pointer to buffer to checksum\r
72 @param Size Number of bytes to checksum\r
73 @param ChecksumOffset Offset to place the checksum result in\r
74\r
75 @return EFI_SUCCESS The function completed successfully.\r
5f55c700 76**/\r
77EFI_STATUS\r
78AcpiPlatformChecksum (\r
79 IN VOID *Buffer,\r
80 IN UINTN Size,\r
81 IN UINTN ChecksumOffset\r
82 );\r
83\r
84/**\r
85 Checksum all versions of the common tables, RSDP, RSDT, XSDT.\r
86\r
87 @param AcpiTableInstance Protocol instance private data.\r
88\r
89 @return EFI_SUCCESS The function completed successfully.\r
90\r
91**/\r
92EFI_STATUS\r
93ChecksumCommonTables (\r
94 IN OUT EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance\r
95 );\r
96\r
97//\r
98// Protocol function implementations.\r
99//\r
100\r
101/**\r
102 This function adds, removes, or updates ACPI tables. If the address is not\r
103 null and the handle value is null, the table is added. If both the address and \r
104 handle are not null, the table at handle is updated with the table at address.\r
105 If the address is null and the handle is not, the table at handle is deleted.\r
106\r
107 @param AcpiTableInstance Instance of the protocol.\r
108 @param Table Pointer to a table.\r
109 @param Checksum Boolean indicating if the checksum should be calculated.\r
110 @param Version Version(s) to set.\r
111 @param Handle Handle of the table.\r
112\r
113 @return EFI_SUCCESS The function completed successfully.\r
114 @return EFI_INVALID_PARAMETER Both the Table and *Handle were NULL.\r
115 @return EFI_ABORTED Could not complete the desired request.\r
116\r
117**/\r
118EFI_STATUS\r
119EFIAPI\r
120SetAcpiTable (\r
121 IN EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance,\r
122 IN VOID *Table OPTIONAL,\r
123 IN BOOLEAN Checksum,\r
124 IN EFI_ACPI_TABLE_VERSION Version,\r
125 IN OUT UINTN *Handle\r
126 )\r
127{\r
128 UINTN SavedHandle;\r
129 EFI_STATUS Status;\r
130\r
131 //\r
132 // Check for invalid input parameters\r
133 //\r
134 ASSERT (Handle);\r
135\r
136 //\r
137 // Initialize locals\r
138 //\r
139 //\r
140 // Determine desired action\r
141 //\r
142 if (*Handle == 0) {\r
143 if (Table == NULL) {\r
144 //\r
145 // Invalid parameter combination\r
146 //\r
147 return EFI_INVALID_PARAMETER;\r
148 } else {\r
149 //\r
150 // Add table\r
151 //\r
152 Status = AddTableToList (AcpiTableInstance, Table, Checksum, Version, Handle);\r
153 }\r
154 } else {\r
155 if (Table != NULL) {\r
156 //\r
157 // Update table\r
158 //\r
159 //\r
160 // Delete the table list entry\r
161 //\r
162 Status = RemoveTableFromList (AcpiTableInstance, Version, *Handle);\r
163 if (EFI_ERROR (Status)) {\r
164 //\r
165 // Should not get an error here ever, but abort if we do.\r
166 //\r
167 return EFI_ABORTED;\r
168 }\r
169 //\r
170 // Set the handle to replace the table at the same handle\r
171 //\r
172 SavedHandle = AcpiTableInstance->CurrentHandle;\r
173 AcpiTableInstance->CurrentHandle = *Handle;\r
174\r
175 //\r
176 // Add the table\r
177 //\r
178 Status = AddTableToList (AcpiTableInstance, Table, Checksum, Version, Handle);\r
179\r
180 //\r
181 // Restore the saved current handle\r
182 //\r
183 AcpiTableInstance->CurrentHandle = SavedHandle;\r
184 } else {\r
185 //\r
186 // Delete table\r
187 //\r
188 Status = RemoveTableFromList (AcpiTableInstance, Version, *Handle);\r
189 }\r
190 }\r
191\r
192 if (EFI_ERROR (Status)) {\r
193 //\r
194 // Should not get an error here ever, but abort if we do.\r
195 //\r
196 return EFI_ABORTED;\r
197 }\r
198 //\r
199 // Done\r
200 //\r
201 return EFI_SUCCESS;\r
202}\r
203\r
204/**\r
205 This function publishes the specified versions of the ACPI tables by\r
206 installing EFI configuration table entries for them. Any combination of\r
207 table versions can be published.\r
208\r
209 @param AcpiTableInstance Instance of the protocol.\r
210 @param Version Version(s) to publish.\r
211\r
212 @return EFI_SUCCESS The function completed successfully.\r
213 @return EFI_ABORTED The function could not complete successfully.\r
214\r
215**/\r
216EFI_STATUS\r
217EFIAPI\r
218PublishTables (\r
219 IN EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance,\r
220 IN EFI_ACPI_TABLE_VERSION Version\r
221 )\r
222{\r
223 EFI_STATUS Status;\r
224 UINT32 *CurrentRsdtEntry;\r
225 VOID *CurrentXsdtEntry;\r
226 UINT64 Buffer64;\r
227\r
228 //\r
229 // Reorder tables as some operating systems don't seem to find the\r
230 // FADT correctly if it is not in the first few entries\r
231 //\r
232\r
233 //\r
234 // Add FADT as the first entry\r
235 //\r
236 if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
237 CurrentRsdtEntry = (UINT32 *) ((UINT8 *) AcpiTableInstance->Rsdt1 + sizeof (EFI_ACPI_DESCRIPTION_HEADER));\r
238 *CurrentRsdtEntry = (UINT32) (UINTN) AcpiTableInstance->Fadt1;\r
239 }\r
240 if ((Version & EFI_ACPI_TABLE_VERSION_2_0) != 0 ||\r
241 (Version & EFI_ACPI_TABLE_VERSION_3_0) != 0) {\r
242 CurrentRsdtEntry = (UINT32 *) ((UINT8 *) AcpiTableInstance->Rsdt3 + sizeof (EFI_ACPI_DESCRIPTION_HEADER));\r
243 *CurrentRsdtEntry = (UINT32) (UINTN) AcpiTableInstance->Fadt3;\r
244 CurrentXsdtEntry = (VOID *) ((UINT8 *) AcpiTableInstance->Xsdt + sizeof (EFI_ACPI_DESCRIPTION_HEADER));\r
245 //\r
246 // Add entry to XSDT, XSDT expects 64 bit pointers, but\r
247 // the table pointers in XSDT are not aligned on 8 byte boundary.\r
248 //\r
249 Buffer64 = (UINT64) (UINTN) AcpiTableInstance->Fadt3;\r
250 CopyMem (\r
251 CurrentXsdtEntry,\r
252 &Buffer64,\r
253 sizeof (UINT64)\r
254 );\r
255 }\r
256\r
257 //\r
258 // Do checksum again because Dsdt/Xsdt is updated.\r
259 //\r
260 ChecksumCommonTables (AcpiTableInstance);\r
261\r
262 //\r
263 // Add the RSD_PTR to the system table and store that we have installed the\r
264 // tables.\r
265 //\r
266 if (((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) &&\r
267 !AcpiTableInstance->TablesInstalled1) {\r
268 Status = gBS->InstallConfigurationTable (&gEfiAcpi10TableGuid, AcpiTableInstance->Rsdp1);\r
269 if (EFI_ERROR (Status)) {\r
270 return EFI_ABORTED;\r
271 }\r
272\r
273 AcpiTableInstance->TablesInstalled1 = TRUE;\r
274 }\r
275\r
276 if (((Version & EFI_ACPI_TABLE_VERSION_2_0) != 0 ||\r
277 (Version & EFI_ACPI_TABLE_VERSION_3_0) != 0) &&\r
278 !AcpiTableInstance->TablesInstalled3) {\r
279 Status = gBS->InstallConfigurationTable (&gEfiAcpiTableGuid, AcpiTableInstance->Rsdp3);\r
280 if (EFI_ERROR (Status)) {\r
281 return EFI_ABORTED;\r
282 }\r
283\r
284 AcpiTableInstance->TablesInstalled3= TRUE;\r
285 }\r
286\r
287 return EFI_SUCCESS;\r
288}\r
289\r
290\r
291/**\r
292 Installs an ACPI table into the RSDT/XSDT.\r
2fd3009f 293 Note that the ACPI table should be checksumed before installing it.\r
294 Otherwise it will assert.\r
5f55c700 295\r
296 @param This Protocol instance pointer.\r
297 @param AcpiTableBuffer A pointer to a buffer containing the ACPI table to be installed.\r
298 @param AcpiTableBufferSize Specifies the size, in bytes, of the AcpiTableBuffer buffer.\r
299 @param TableKey Reurns a key to refer to the ACPI table.\r
300\r
301 @return EFI_SUCCESS The table was successfully inserted.\r
302 @return EFI_INVALID_PARAMETER Either AcpiTableBuffer is NULL, TableKey is NULL, or AcpiTableBufferSize \r
303 and the size field embedded in the ACPI table pointed to by AcpiTableBuffer\r
304 are not in sync.\r
305 @return EFI_OUT_OF_RESOURCES Insufficient resources exist to complete the request.\r
306\r
307**/\r
308EFI_STATUS\r
309EFIAPI\r
310InstallAcpiTable (\r
db0f0d3c 311 IN EFI_ACPI_TABLE_PROTOCOL *This,\r
312 IN VOID *AcpiTableBuffer,\r
313 IN UINTN AcpiTableBufferSize,\r
314 OUT UINTN *TableKey\r
5f55c700 315 )\r
316{\r
317 EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance;\r
318 EFI_STATUS Status;\r
319 VOID *AcpiTableBufferConst;\r
320\r
321 //\r
322 // Check for invalid input parameters\r
323 //\r
324 if ((AcpiTableBuffer == NULL) || (TableKey == NULL)\r
325 || (((EFI_ACPI_DESCRIPTION_HEADER *) AcpiTableBuffer)->Length != AcpiTableBufferSize)) {\r
326 return EFI_INVALID_PARAMETER;\r
327 }\r
328\r
329 //\r
330 // Get the instance of the ACPI table protocol\r
331 //\r
332 AcpiTableInstance = EFI_ACPI_TABLE_INSTANCE_FROM_THIS (This);\r
333\r
334 //\r
335 // Install the ACPI table\r
336 //\r
337 AcpiTableBufferConst = AllocateCopyPool (AcpiTableBufferSize,AcpiTableBuffer);\r
338 *TableKey = 0;\r
339 Status = SetAcpiTable (\r
340 AcpiTableInstance,\r
341 AcpiTableBufferConst,\r
71824dd8 342 TRUE,\r
46a989f7 343 EFI_ACPI_TABLE_VERSION_1_0B | EFI_ACPI_TABLE_VERSION_2_0 | EFI_ACPI_TABLE_VERSION_3_0,\r
5f55c700 344 TableKey\r
345 );\r
346 if (!EFI_ERROR (Status)) {\r
347 Status = PublishTables (\r
348 AcpiTableInstance,\r
46a989f7 349 EFI_ACPI_TABLE_VERSION_1_0B | EFI_ACPI_TABLE_VERSION_2_0 | EFI_ACPI_TABLE_VERSION_3_0\r
5f55c700 350 );\r
351 }\r
352 FreePool (AcpiTableBufferConst);\r
353 \r
3dc8585e
JY
354 //\r
355 // Add a new table successfully, notify registed callback\r
356 //\r
357 if (FeaturePcdGet (PcdInstallAcpiSdtProtocol)) {\r
358 if (!EFI_ERROR (Status)) {\r
359 SdtNotifyAcpiList (\r
360 AcpiTableInstance,\r
361 EFI_ACPI_TABLE_VERSION_1_0B | EFI_ACPI_TABLE_VERSION_2_0 | EFI_ACPI_TABLE_VERSION_3_0,\r
362 *TableKey\r
363 );\r
364 }\r
365 }\r
366\r
5f55c700 367 return Status;\r
368}\r
369\r
370\r
371/**\r
372 Removes an ACPI table from the RSDT/XSDT.\r
373\r
374 @param This Protocol instance pointer.\r
375 @param TableKey Specifies the table to uninstall. The key was returned from InstallAcpiTable().\r
376\r
377 @return EFI_SUCCESS The table was successfully uninstalled.\r
378 @return EFI_NOT_FOUND TableKey does not refer to a valid key for a table entry.\r
379\r
380**/\r
381EFI_STATUS\r
382EFIAPI\r
383UninstallAcpiTable (\r
db0f0d3c 384 IN EFI_ACPI_TABLE_PROTOCOL *This,\r
385 IN UINTN TableKey\r
5f55c700 386 )\r
387{\r
388 EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance;\r
389 EFI_STATUS Status;\r
390\r
391 //\r
392 // Get the instance of the ACPI table protocol\r
393 //\r
394 AcpiTableInstance = EFI_ACPI_TABLE_INSTANCE_FROM_THIS (This);\r
395\r
396 //\r
397 // Uninstall the ACPI table\r
398 //\r
399 Status = SetAcpiTable (\r
400 AcpiTableInstance,\r
401 NULL,\r
402 FALSE,\r
46a989f7 403 EFI_ACPI_TABLE_VERSION_1_0B | EFI_ACPI_TABLE_VERSION_2_0 | EFI_ACPI_TABLE_VERSION_3_0,\r
5f55c700 404 &TableKey\r
405 );\r
406 if (!EFI_ERROR (Status)) {\r
407 Status = PublishTables (\r
408 AcpiTableInstance,\r
46a989f7 409 EFI_ACPI_TABLE_VERSION_1_0B | EFI_ACPI_TABLE_VERSION_2_0 | EFI_ACPI_TABLE_VERSION_3_0\r
5f55c700 410 );\r
411 }\r
412\r
413 if (EFI_ERROR (Status)) {\r
414 return EFI_NOT_FOUND;\r
415 } else {\r
416 return EFI_SUCCESS;\r
417 }\r
418}\r
419\r
da935a5c 420/**\r
421 If the number of APCI tables exceeds the preallocated max table number, enlarge the table buffer.\r
422\r
423 @param AcpiTableInstance ACPI table protocol instance data structure.\r
424\r
425 @return EFI_SUCCESS reallocate the table beffer successfully.\r
426 @return EFI_OUT_OF_RESOURCES Unable to allocate required resources.\r
427\r
428**/\r
429EFI_STATUS\r
430ReallocateAcpiTableBuffer (\r
431 IN EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance\r
432 )\r
433{\r
434 UINTN NewMaxTableNumber;\r
435 UINTN TotalSize;\r
436 UINT8 *Pointer;\r
437 EFI_PHYSICAL_ADDRESS PageAddress;\r
438 EFI_ACPI_TABLE_INSTANCE TempPrivateData;\r
439 EFI_STATUS Status;\r
440 UINT64 CurrentData;\r
441 \r
442 CopyMem (&TempPrivateData, AcpiTableInstance, sizeof (EFI_ACPI_TABLE_INSTANCE)); \r
443 //\r
444 // Enlarge the max table number from mEfiAcpiMaxNumTables to mEfiAcpiMaxNumTables + EFI_ACPI_MAX_NUM_TABLES\r
445 //\r
446 NewMaxTableNumber = mEfiAcpiMaxNumTables + EFI_ACPI_MAX_NUM_TABLES;\r
447 //\r
37abfb7e 448 // Create RSDT, XSDT structures and allocate buffers.\r
da935a5c 449 //\r
37abfb7e
LG
450 TotalSize = sizeof (EFI_ACPI_DESCRIPTION_HEADER) + // for ACPI 1.0 RSDT\r
451 NewMaxTableNumber * sizeof (UINT32) +\r
452 sizeof (EFI_ACPI_DESCRIPTION_HEADER) + // for ACPI 2.0/3.0 RSDT\r
453 NewMaxTableNumber * sizeof (UINT32) +\r
454 sizeof (EFI_ACPI_DESCRIPTION_HEADER) + // for ACPI 2.0/3.0 XSDT\r
455 NewMaxTableNumber * sizeof (UINT64);\r
da935a5c 456\r
457 //\r
458 // Allocate memory in the lower 32 bit of address range for\r
459 // compatibility with ACPI 1.0 OS.\r
460 //\r
461 // This is done because ACPI 1.0 pointers are 32 bit values.\r
462 // ACPI 2.0 OS and all 64 bit OS must use the 64 bit ACPI table addresses.\r
463 // There is no architectural reason these should be below 4GB, it is purely\r
464 // for convenience of implementation that we force memory below 4GB.\r
465 //\r
466 PageAddress = 0xFFFFFFFF;\r
467 Status = gBS->AllocatePages (\r
468 AllocateMaxAddress,\r
469 EfiACPIReclaimMemory,\r
470 EFI_SIZE_TO_PAGES (TotalSize),\r
471 &PageAddress\r
472 );\r
473\r
474 if (EFI_ERROR (Status)) {\r
475 return EFI_OUT_OF_RESOURCES;\r
476 }\r
477\r
478 Pointer = (UINT8 *) (UINTN) PageAddress;\r
479 ZeroMem (Pointer, TotalSize);\r
480 \r
da935a5c 481 AcpiTableInstance->Rsdt1 = (EFI_ACPI_DESCRIPTION_HEADER *) Pointer;\r
482 Pointer += (sizeof (EFI_ACPI_DESCRIPTION_HEADER) + NewMaxTableNumber * sizeof (UINT32));\r
483 AcpiTableInstance->Rsdt3 = (EFI_ACPI_DESCRIPTION_HEADER *) Pointer;\r
484 Pointer += (sizeof (EFI_ACPI_DESCRIPTION_HEADER) + NewMaxTableNumber * sizeof (UINT32));\r
da935a5c 485 AcpiTableInstance->Xsdt = (EFI_ACPI_DESCRIPTION_HEADER *) Pointer;\r
5f55c700 486\r
da935a5c 487 //\r
37abfb7e 488 // Update RSDP to point to the new Rsdt and Xsdt address.\r
da935a5c 489 //\r
da935a5c 490 AcpiTableInstance->Rsdp1->RsdtAddress = (UINT32) (UINTN) AcpiTableInstance->Rsdt1;\r
da935a5c 491 AcpiTableInstance->Rsdp3->RsdtAddress = (UINT32) (UINTN) AcpiTableInstance->Rsdt3;\r
492 CurrentData = (UINT64) (UINTN) AcpiTableInstance->Xsdt;\r
493 CopyMem (&AcpiTableInstance->Rsdp3->XsdtAddress, &CurrentData, sizeof (UINT64));\r
494\r
495 //\r
496 // copy the original Rsdt1, Rsdt3 and Xsdt structure to new buffer \r
497 //\r
498 CopyMem (AcpiTableInstance->Rsdt1, TempPrivateData.Rsdt1, (sizeof (EFI_ACPI_DESCRIPTION_HEADER) + mEfiAcpiMaxNumTables * sizeof (UINT32))); \r
499 CopyMem (AcpiTableInstance->Rsdt3, TempPrivateData.Rsdt3, (sizeof (EFI_ACPI_DESCRIPTION_HEADER) + mEfiAcpiMaxNumTables * sizeof (UINT32))); \r
500 CopyMem (AcpiTableInstance->Xsdt, TempPrivateData.Xsdt, (sizeof (EFI_ACPI_DESCRIPTION_HEADER) + mEfiAcpiMaxNumTables * sizeof (UINT64)));\r
501 \r
502 //\r
503 // Calculate orignal ACPI table buffer size\r
504 //\r
37abfb7e
LG
505 TotalSize = sizeof (EFI_ACPI_DESCRIPTION_HEADER) + // for ACPI 1.0 RSDT\r
506 mEfiAcpiMaxNumTables * sizeof (UINT32) +\r
507 sizeof (EFI_ACPI_DESCRIPTION_HEADER) + // for ACPI 2.0/3.0 RSDT\r
508 mEfiAcpiMaxNumTables * sizeof (UINT32) +\r
509 sizeof (EFI_ACPI_DESCRIPTION_HEADER) + // for ACPI 2.0/3.0 XSDT\r
510 mEfiAcpiMaxNumTables * sizeof (UINT64);\r
511 gBS->FreePages ((EFI_PHYSICAL_ADDRESS)(UINTN)TempPrivateData.Rsdt1, EFI_SIZE_TO_PAGES (TotalSize));\r
da935a5c 512 \r
513 //\r
514 // Update the Max ACPI table number\r
515 // \r
516 mEfiAcpiMaxNumTables = NewMaxTableNumber;\r
517 return EFI_SUCCESS;\r
518}\r
5f55c700 519/**\r
520 This function adds an ACPI table to the table list. It will detect FACS and\r
521 allocate the correct type of memory and properly align the table.\r
522\r
523 @param AcpiTableInstance Instance of the protocol.\r
524 @param Table Table to add.\r
525 @param Checksum Does the table require checksumming.\r
526 @param Version The version of the list to add the table to.\r
527 @param Handle Pointer for returning the handle.\r
528\r
529 @return EFI_SUCCESS The function completed successfully.\r
530 @return EFI_OUT_OF_RESOURCES Could not allocate a required resource.\r
531 @return EFI_ABORTED The table is a duplicate of a table that is required\r
532 to be unique.\r
533\r
534**/\r
535EFI_STATUS\r
536AddTableToList (\r
537 IN EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance,\r
538 IN VOID *Table,\r
539 IN BOOLEAN Checksum,\r
540 IN EFI_ACPI_TABLE_VERSION Version,\r
541 OUT UINTN *Handle\r
542 )\r
543{\r
544 EFI_STATUS Status;\r
545 EFI_ACPI_TABLE_LIST *CurrentTableList;\r
546 UINT32 CurrentTableSignature;\r
547 UINT32 CurrentTableSize;\r
548 UINT32 *CurrentRsdtEntry;\r
549 VOID *CurrentXsdtEntry;\r
550 UINT64 Buffer64;\r
551 BOOLEAN AddToRsdt;\r
552\r
553 //\r
554 // Check for invalid input parameters\r
555 //\r
556 ASSERT (AcpiTableInstance);\r
557 ASSERT (Table);\r
558 ASSERT (Handle);\r
559\r
560 //\r
561 // Init locals\r
562 //\r
563 AddToRsdt = TRUE;\r
564\r
565 //\r
566 // Create a new list entry\r
567 //\r
568 CurrentTableList = AllocatePool (sizeof (EFI_ACPI_TABLE_LIST));\r
569 ASSERT (CurrentTableList);\r
570\r
571 //\r
572 // Determine table type and size\r
573 //\r
574 CurrentTableSignature = ((EFI_ACPI_COMMON_HEADER *) Table)->Signature;\r
575 CurrentTableSize = ((EFI_ACPI_COMMON_HEADER *) Table)->Length;\r
576\r
577 //\r
578 // Allocate a buffer for the table. All tables are allocated in the lower 32 bits of address space\r
579 // for backwards compatibility with ACPI 1.0 OS.\r
580 //\r
581 // This is done because ACPI 1.0 pointers are 32 bit values.\r
582 // ACPI 2.0 OS and all 64 bit OS must use the 64 bit ACPI table addresses.\r
583 // There is no architectural reason these should be below 4GB, it is purely\r
584 // for convenience of implementation that we force memory below 4GB.\r
585 //\r
586 CurrentTableList->PageAddress = 0xFFFFFFFF;\r
587 CurrentTableList->NumberOfPages = EFI_SIZE_TO_PAGES (CurrentTableSize);\r
588\r
589 //\r
590 // Allocation memory type depends on the type of the table\r
591 //\r
36d58153
JY
592 if ((CurrentTableSignature == EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE) || \r
593 (CurrentTableSignature == EFI_ACPI_4_0_UEFI_ACPI_DATA_TABLE_SIGNATURE)) {\r
5f55c700 594 //\r
595 // Allocate memory for the FACS. This structure must be aligned\r
596 // on a 64 byte boundary and must be ACPI NVS memory.\r
597 // Using AllocatePages should ensure that it is always aligned.\r
36d58153
JY
598 // Do not change signature for new ACPI version because they are same.\r
599 //\r
600 // UEFI table also need to be in ACPI NVS memory, because some data field\r
601 // could be updated by OS present agent. For example, BufferPtrAddress in\r
602 // SMM communication ACPI table.\r
5f55c700 603 //\r
604 ASSERT ((EFI_PAGE_SIZE % 64) == 0);\r
605 Status = gBS->AllocatePages (\r
606 AllocateMaxAddress,\r
607 EfiACPIMemoryNVS,\r
608 CurrentTableList->NumberOfPages,\r
609 &CurrentTableList->PageAddress\r
610 );\r
611 } else {\r
612 //\r
613 // All other tables are ACPI reclaim memory, no alignment requirements.\r
614 //\r
615 Status = gBS->AllocatePages (\r
616 AllocateMaxAddress,\r
617 EfiACPIReclaimMemory,\r
618 CurrentTableList->NumberOfPages,\r
619 &CurrentTableList->PageAddress\r
620 );\r
621 }\r
622 //\r
623 // Check return value from memory alloc.\r
624 //\r
625 if (EFI_ERROR (Status)) {\r
626 gBS->FreePool (CurrentTableList);\r
627 return EFI_OUT_OF_RESOURCES;\r
628 }\r
629 //\r
630 // Update the table pointer with the allocated memory start\r
631 //\r
632 CurrentTableList->Table = (EFI_ACPI_COMMON_HEADER *) (UINTN) CurrentTableList->PageAddress;\r
633\r
634 //\r
635 // Initialize the table contents\r
636 //\r
637 CurrentTableList->Signature = EFI_ACPI_TABLE_LIST_SIGNATURE;\r
638 CopyMem (CurrentTableList->Table, Table, CurrentTableSize);\r
639 CurrentTableList->Handle = AcpiTableInstance->CurrentHandle++;\r
640 *Handle = CurrentTableList->Handle;\r
641 CurrentTableList->Version = Version;\r
642\r
643 //\r
644 // Update internal pointers if this is a required table. If it is a required\r
645 // table and a table of that type already exists, return an error.\r
646 //\r
647 // Calculate the checksum if the table is not FACS.\r
648 //\r
649 switch (CurrentTableSignature) {\r
650\r
651 case EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE:\r
652 //\r
653 // We don't add the FADT in the standard way because some\r
654 // OS expect the FADT to be early in the table list.\r
655 // So we always add it as the first element in the list.\r
656 //\r
657 AddToRsdt = FALSE;\r
658\r
659 //\r
660 // Check that the table has not been previously added.\r
661 //\r
662 if (((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0 && AcpiTableInstance->Fadt1 != NULL) ||\r
663 ((Version & EFI_ACPI_TABLE_VERSION_2_0) != 0 && AcpiTableInstance->Fadt3 != NULL) ||\r
664 ((Version & EFI_ACPI_TABLE_VERSION_3_0) != 0 && AcpiTableInstance->Fadt3 != NULL)\r
665 ) {\r
666 gBS->FreePages (CurrentTableList->PageAddress, CurrentTableList->NumberOfPages);\r
667 gBS->FreePool (CurrentTableList);\r
668 return EFI_ABORTED;\r
669 }\r
670 //\r
671 // Add the table to the appropriate table version\r
672 //\r
673 if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
674 //\r
675 // Save a pointer to the table\r
676 //\r
677 AcpiTableInstance->Fadt1 = (EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE *) CurrentTableList->Table;\r
678\r
679 //\r
680 // Update pointers in FADT. If tables don't exist this will put NULL pointers there.\r
681 //\r
682 AcpiTableInstance->Fadt1->FirmwareCtrl = (UINT32) (UINTN) AcpiTableInstance->Facs1;\r
683 AcpiTableInstance->Fadt1->Dsdt = (UINT32) (UINTN) AcpiTableInstance->Dsdt1;\r
684\r
685 //\r
686 // RSDP OEM information is updated to match the FADT OEM information\r
687 //\r
688 CopyMem (\r
689 &AcpiTableInstance->Rsdp1->OemId,\r
690 &AcpiTableInstance->Fadt1->Header.OemId,\r
691 6\r
692 );\r
693\r
694 //\r
695 // RSDT OEM information is updated to match the FADT OEM information.\r
696 //\r
697 CopyMem (\r
698 &AcpiTableInstance->Rsdt1->OemId,\r
699 &AcpiTableInstance->Fadt1->Header.OemId,\r
700 6\r
701 );\r
702\r
703 CopyMem (\r
704 &AcpiTableInstance->Rsdt1->OemTableId,\r
705 &AcpiTableInstance->Fadt1->Header.OemTableId,\r
706 sizeof (UINT64)\r
707 );\r
708 AcpiTableInstance->Rsdt1->OemRevision = AcpiTableInstance->Fadt1->Header.OemRevision;\r
709 }\r
710\r
711 if ((Version & EFI_ACPI_TABLE_VERSION_2_0) != 0 ||\r
712 (Version & EFI_ACPI_TABLE_VERSION_3_0) != 0) {\r
713 //\r
714 // Save a pointer to the table\r
715 //\r
716 AcpiTableInstance->Fadt3 = (EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE *) CurrentTableList->Table;\r
717\r
718 //\r
719 // Update pointers in FADT. If tables don't exist this will put NULL pointers there.\r
720 //\r
f0c855b2 721 AcpiTableInstance->Fadt3->FirmwareCtrl = (UINT32) (UINTN) AcpiTableInstance->Facs3;\r
722 Buffer64 = (UINT64) (UINTN) AcpiTableInstance->Facs3;\r
723 CopyMem (\r
724 &AcpiTableInstance->Fadt3->XFirmwareCtrl,\r
725 &Buffer64,\r
726 sizeof (UINT64)\r
727 );\r
728 AcpiTableInstance->Fadt3->Dsdt = (UINT32) (UINTN) AcpiTableInstance->Dsdt3;\r
729 Buffer64 = (UINT64) (UINTN) AcpiTableInstance->Dsdt3;\r
730 CopyMem (\r
731 &AcpiTableInstance->Fadt3->XDsdt,\r
732 &Buffer64,\r
733 sizeof (UINT64)\r
734 );\r
5f55c700 735\r
f0c855b2 736 //\r
737 // RSDP OEM information is updated to match the FADT OEM information\r
738 //\r
739 CopyMem (\r
740 &AcpiTableInstance->Rsdp3->OemId,\r
741 &AcpiTableInstance->Fadt3->Header.OemId,\r
742 6\r
743 );\r
744 \r
745 //\r
746 // RSDT OEM information is updated to match FADT OEM information.\r
747 //\r
748 CopyMem (\r
749 &AcpiTableInstance->Rsdt3->OemId,\r
750 &AcpiTableInstance->Fadt3->Header.OemId,\r
751 6\r
752 );\r
753 CopyMem (\r
754 &AcpiTableInstance->Rsdt3->OemTableId,\r
755 &AcpiTableInstance->Fadt3->Header.OemTableId,\r
756 sizeof (UINT64)\r
757 );\r
758 AcpiTableInstance->Rsdt3->OemRevision = AcpiTableInstance->Fadt3->Header.OemRevision;\r
759 \r
760 //\r
761 // XSDT OEM information is updated to match FADT OEM information.\r
762 //\r
763 CopyMem (\r
764 &AcpiTableInstance->Xsdt->OemId,\r
765 &AcpiTableInstance->Fadt3->Header.OemId,\r
766 6\r
767 );\r
768 CopyMem (\r
769 &AcpiTableInstance->Xsdt->OemTableId,\r
770 &AcpiTableInstance->Fadt3->Header.OemTableId,\r
771 sizeof (UINT64)\r
772 );\r
773 AcpiTableInstance->Xsdt->OemRevision = AcpiTableInstance->Fadt3->Header.OemRevision;\r
5f55c700 774 } \r
775 //\r
776 // Checksum the table\r
777 //\r
778 if (Checksum) {\r
779 AcpiPlatformChecksum (\r
780 CurrentTableList->Table,\r
781 CurrentTableList->Table->Length,\r
782 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
783 Checksum)\r
784 );\r
785 }\r
786 break;\r
787\r
788 case EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE:\r
789 //\r
790 // Check that the table has not been previously added.\r
791 //\r
792 if (((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0 && AcpiTableInstance->Facs1 != NULL) ||\r
793 ((Version & EFI_ACPI_TABLE_VERSION_2_0) != 0 && AcpiTableInstance->Facs3 != NULL) ||\r
794 ((Version & EFI_ACPI_TABLE_VERSION_3_0) != 0 && AcpiTableInstance->Facs3 != NULL)\r
795 ) {\r
796 gBS->FreePages (CurrentTableList->PageAddress, CurrentTableList->NumberOfPages);\r
797 gBS->FreePool (CurrentTableList);\r
798 return EFI_ABORTED;\r
799 }\r
800 //\r
801 // FACS is referenced by FADT and is not part of RSDT\r
802 //\r
803 AddToRsdt = FALSE;\r
804\r
805 //\r
806 // Add the table to the appropriate table version\r
807 //\r
808 if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
809 //\r
810 // Save a pointer to the table\r
811 //\r
812 AcpiTableInstance->Facs1 = (EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *) CurrentTableList->Table;\r
813\r
814 //\r
815 // If FADT already exists, update table pointers.\r
816 //\r
817 if (AcpiTableInstance->Fadt1 != NULL) {\r
818 AcpiTableInstance->Fadt1->FirmwareCtrl = (UINT32) (UINTN) AcpiTableInstance->Facs1;\r
819\r
820 //\r
821 // Checksum FADT table\r
822 //\r
823 AcpiPlatformChecksum (\r
824 AcpiTableInstance->Fadt1,\r
825 AcpiTableInstance->Fadt1->Header.Length,\r
826 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
827 Checksum)\r
828 );\r
829 }\r
830 }\r
831\r
832 if ((Version & EFI_ACPI_TABLE_VERSION_2_0) != 0 ||\r
833 (Version & EFI_ACPI_TABLE_VERSION_3_0) != 0) {\r
834 //\r
835 // Save a pointer to the table\r
836 //\r
837 AcpiTableInstance->Facs3 = (EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *) CurrentTableList->Table;\r
838\r
839 //\r
840 // If FADT already exists, update table pointers.\r
841 //\r
842 if (AcpiTableInstance->Fadt3 != NULL) {\r
843 AcpiTableInstance->Fadt3->FirmwareCtrl = (UINT32) (UINTN) AcpiTableInstance->Facs3;\r
844 Buffer64 = (UINT64) (UINTN) AcpiTableInstance->Facs3;\r
845 CopyMem (\r
846 &AcpiTableInstance->Fadt3->XFirmwareCtrl,\r
847 &Buffer64,\r
848 sizeof (UINT64)\r
849 );\r
850\r
851 //\r
852 // Checksum FADT table\r
853 //\r
854 AcpiPlatformChecksum (\r
855 AcpiTableInstance->Fadt3,\r
856 AcpiTableInstance->Fadt3->Header.Length,\r
857 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
858 Checksum)\r
859 );\r
860 }\r
861 }\r
862\r
863 break;\r
864\r
865 case EFI_ACPI_1_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE:\r
866 //\r
867 // Check that the table has not been previously added.\r
868 //\r
869 if (((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0 && AcpiTableInstance->Dsdt1 != NULL) ||\r
870 ((Version & EFI_ACPI_TABLE_VERSION_2_0) != 0 && AcpiTableInstance->Dsdt3 != NULL) ||\r
871 ((Version & EFI_ACPI_TABLE_VERSION_3_0) != 0 && AcpiTableInstance->Dsdt3 != NULL)\r
872 ) {\r
873 gBS->FreePages (CurrentTableList->PageAddress, CurrentTableList->NumberOfPages);\r
874 gBS->FreePool (CurrentTableList);\r
875 return EFI_ABORTED;\r
876 }\r
877 //\r
878 // DSDT is referenced by FADT and is not part of RSDT\r
879 //\r
880 AddToRsdt = FALSE;\r
881\r
882 //\r
883 // Add the table to the appropriate table version\r
884 //\r
885 if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
886 //\r
887 // Save a pointer to the table\r
888 //\r
889 AcpiTableInstance->Dsdt1 = (EFI_ACPI_DESCRIPTION_HEADER *) CurrentTableList->Table;\r
890\r
891 //\r
892 // If FADT already exists, update table pointers.\r
893 //\r
894 if (AcpiTableInstance->Fadt1 != NULL) {\r
895 AcpiTableInstance->Fadt1->Dsdt = (UINT32) (UINTN) AcpiTableInstance->Dsdt1;\r
896\r
897 //\r
898 // Checksum FADT table\r
899 //\r
900 AcpiPlatformChecksum (\r
901 AcpiTableInstance->Fadt1,\r
902 AcpiTableInstance->Fadt1->Header.Length,\r
903 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
904 Checksum)\r
905 );\r
906 }\r
907 }\r
908 \r
909 if ((Version & EFI_ACPI_TABLE_VERSION_2_0) != 0 ||\r
910 (Version & EFI_ACPI_TABLE_VERSION_3_0) != 0) {\r
911 //\r
912 // Save a pointer to the table\r
913 //\r
914 AcpiTableInstance->Dsdt3 = (EFI_ACPI_DESCRIPTION_HEADER *) CurrentTableList->Table;\r
915\r
916 //\r
917 // If FADT already exists, update table pointers.\r
918 //\r
919 if (AcpiTableInstance->Fadt3 != NULL) {\r
920 AcpiTableInstance->Fadt3->Dsdt = (UINT32) (UINTN) AcpiTableInstance->Dsdt3;\r
921 Buffer64 = (UINT64) (UINTN) AcpiTableInstance->Dsdt3;\r
922 CopyMem (\r
923 &AcpiTableInstance->Fadt3->XDsdt,\r
924 &Buffer64,\r
925 sizeof (UINT64)\r
926 );\r
927\r
928 //\r
929 // Checksum FADT table\r
930 //\r
931 AcpiPlatformChecksum (\r
932 AcpiTableInstance->Fadt3,\r
933 AcpiTableInstance->Fadt3->Header.Length,\r
934 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
935 Checksum)\r
936 );\r
937 }\r
938 } \r
939 //\r
940 // Checksum the table\r
941 //\r
942 if (Checksum) {\r
943 AcpiPlatformChecksum (\r
944 CurrentTableList->Table,\r
945 CurrentTableList->Table->Length,\r
946 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
947 Checksum)\r
948 );\r
949 }\r
950 break;\r
951\r
952 default:\r
953 //\r
954 // Checksum the table\r
955 //\r
956 if (Checksum) {\r
957 AcpiPlatformChecksum (\r
958 CurrentTableList->Table,\r
959 CurrentTableList->Table->Length,\r
960 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
961 Checksum)\r
962 );\r
963 }\r
964 break;\r
965 }\r
966 //\r
967 // Add the table to the current list of tables\r
968 //\r
969 InsertTailList (&AcpiTableInstance->TableList, &CurrentTableList->Link);\r
970\r
971 //\r
972 // Add the table to RSDT and/or XSDT table entry lists.\r
973 //\r
974 //\r
975 // Add to ACPI 1.0b table tree\r
976 //\r
977 if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
5f55c700 978 if (AddToRsdt) {\r
979 //\r
da935a5c 980 // If the table number exceed the gEfiAcpiMaxNumTables, enlarge the table buffer\r
5f55c700 981 //\r
da935a5c 982 if (AcpiTableInstance->NumberOfTableEntries1 >= mEfiAcpiMaxNumTables) {\r
983 Status = ReallocateAcpiTableBuffer (AcpiTableInstance);\r
984 ASSERT_EFI_ERROR (Status);\r
985 }\r
5f55c700 986 CurrentRsdtEntry = (UINT32 *)\r
987 (\r
da935a5c 988 (UINT8 *) AcpiTableInstance->Rsdt1 +\r
5f55c700 989 sizeof (EFI_ACPI_DESCRIPTION_HEADER) +\r
da935a5c 990 AcpiTableInstance->NumberOfTableEntries1 *\r
5f55c700 991 sizeof (UINT32)\r
992 );\r
993\r
994 //\r
da935a5c 995 // Add entry to the RSDT unless its the FACS or DSDT\r
5f55c700 996 //\r
997 *CurrentRsdtEntry = (UINT32) (UINTN) CurrentTableList->Table;\r
998\r
999 //\r
1000 // Update RSDT length\r
1001 //\r
da935a5c 1002 AcpiTableInstance->Rsdt1->Length = AcpiTableInstance->Rsdt1->Length + sizeof (UINT32);\r
5f55c700 1003\r
da935a5c 1004 AcpiTableInstance->NumberOfTableEntries1++;\r
1005 }\r
1006 }\r
1007 //\r
1008 // Add to ACPI 2.0/3.0 table tree\r
1009 //\r
1010 if ((Version & EFI_ACPI_TABLE_VERSION_2_0) != 0 ||\r
1011 (Version & EFI_ACPI_TABLE_VERSION_3_0) != 0) {\r
1012 if (AddToRsdt) {\r
1013 //\r
1014 // If the table number exceed the gEfiAcpiMaxNumTables, enlarge the table buffer\r
1015 //\r
1016 if (AcpiTableInstance->NumberOfTableEntries3 >= mEfiAcpiMaxNumTables) {\r
1017 Status = ReallocateAcpiTableBuffer (AcpiTableInstance);\r
1018 ASSERT_EFI_ERROR (Status);\r
1019 }\r
1020 //\r
1021 // At this time, it is assumed that RSDT and XSDT maintain parallel lists of tables.\r
1022 // If it becomes necessary to maintain separate table lists, changes will be required.\r
1023 //\r
1024 CurrentRsdtEntry = (UINT32 *)\r
1025 (\r
1026 (UINT8 *) AcpiTableInstance->Rsdt3 +\r
1027 sizeof (EFI_ACPI_DESCRIPTION_HEADER) +\r
1028 AcpiTableInstance->NumberOfTableEntries3 *\r
1029 sizeof (UINT32)\r
1030 );\r
1031\r
1032 //\r
1033 // This pointer must not be directly dereferenced as the XSDT entries may not\r
1034 // be 64 bit aligned resulting in a possible fault. Use CopyMem to update.\r
1035 //\r
1036 CurrentXsdtEntry = (VOID *)\r
1037 (\r
1038 (UINT8 *) AcpiTableInstance->Xsdt +\r
1039 sizeof (EFI_ACPI_DESCRIPTION_HEADER) +\r
1040 AcpiTableInstance->NumberOfTableEntries3 *\r
1041 sizeof (UINT64)\r
1042 );\r
1043\r
1044 //\r
1045 // Add entry to the RSDT\r
1046 //\r
1047 *CurrentRsdtEntry = (UINT32) (UINTN) CurrentTableList->Table;\r
1048\r
1049 //\r
1050 // Update RSDT length\r
1051 //\r
1052 AcpiTableInstance->Rsdt3->Length = AcpiTableInstance->Rsdt3->Length + sizeof (UINT32);\r
1053\r
1054 //\r
1055 // Add entry to XSDT, XSDT expects 64 bit pointers, but\r
1056 // the table pointers in XSDT are not aligned on 8 byte boundary.\r
1057 //\r
1058 Buffer64 = (UINT64) (UINTN) CurrentTableList->Table;\r
1059 CopyMem (\r
1060 CurrentXsdtEntry,\r
1061 &Buffer64,\r
1062 sizeof (UINT64)\r
1063 );\r
1064\r
1065 //\r
1066 // Update length\r
1067 //\r
1068 AcpiTableInstance->Xsdt->Length = AcpiTableInstance->Xsdt->Length + sizeof (UINT64);\r
1069\r
1070 AcpiTableInstance->NumberOfTableEntries3++;\r
5f55c700 1071 }\r
5f55c700 1072 }\r
1073\r
1074 ChecksumCommonTables (AcpiTableInstance);\r
1075 return EFI_SUCCESS;\r
1076}\r
1077\r
1078\r
1079/**\r
1080 This function finds the table specified by the handle and returns a pointer to it.\r
1081 If the handle is not found, EFI_NOT_FOUND is returned and the contents of Table are\r
1082 undefined.\r
1083\r
1084 @param Handle Table to find.\r
1085 @param TableList Table list to search\r
1086 @param Table Pointer to table found. \r
1087\r
1088 @return EFI_SUCCESS The function completed successfully.\r
1089 @return EFI_NOT_FOUND No table found matching the handle specified.\r
1090\r
1091**/\r
1092EFI_STATUS\r
1093FindTableByHandle (\r
1094 IN UINTN Handle,\r
1095 IN LIST_ENTRY *TableList,\r
1096 OUT EFI_ACPI_TABLE_LIST **Table\r
1097 )\r
1098{\r
1099 LIST_ENTRY *CurrentLink;\r
1100 EFI_ACPI_TABLE_LIST *CurrentTable;\r
1101\r
1102 //\r
1103 // Check for invalid input parameters\r
1104 //\r
1105 ASSERT (Table);\r
1106\r
1107 //\r
1108 // Find the table\r
1109 //\r
1110 CurrentLink = TableList->ForwardLink;\r
1111\r
1112 while (CurrentLink != TableList) {\r
1113 CurrentTable = EFI_ACPI_TABLE_LIST_FROM_LINK (CurrentLink);\r
1114 if (CurrentTable->Handle == Handle) {\r
1115 //\r
1116 // Found handle, so return this table.\r
1117 //\r
1118 *Table = CurrentTable;\r
1119 return EFI_SUCCESS;\r
1120 }\r
1121\r
1122 CurrentLink = CurrentLink->ForwardLink;\r
1123 }\r
1124 //\r
1125 // Table not found\r
1126 //\r
1127 return EFI_NOT_FOUND;\r
1128}\r
1129\r
1130\r
1131/**\r
1132 This function removes a basic table from the RSDT and/or XSDT.\r
1133 For Acpi 1.0 tables, pass in the Rsdt.\r
1134 For Acpi 2.0 tables, pass in both Rsdt and Xsdt.\r
1135\r
1136 @param Table Pointer to table found. \r
1137 @param NumberOfTableEntries Current number of table entries in the RSDT/XSDT\r
1138 @param Rsdt Pointer to the RSDT to remove from\r
1139 @param Xsdt Pointer to the Xsdt to remove from\r
1140\r
1141 @return EFI_SUCCESS The function completed successfully.\r
1142 @return EFI_INVALID_PARAMETER The table was not found in both Rsdt and Xsdt.\r
1143\r
1144**/\r
1145EFI_STATUS\r
1146RemoveTableFromRsdt (\r
1147 IN OUT EFI_ACPI_TABLE_LIST * Table,\r
1148 IN OUT UINTN *NumberOfTableEntries,\r
1149 IN OUT EFI_ACPI_DESCRIPTION_HEADER * Rsdt,\r
1150 IN OUT EFI_ACPI_DESCRIPTION_HEADER * Xsdt OPTIONAL\r
1151 )\r
1152{\r
1153 UINT32 *CurrentRsdtEntry;\r
1154 VOID *CurrentXsdtEntry;\r
1155 UINT64 CurrentTablePointer64;\r
1156 UINTN Index;\r
1157\r
1158 //\r
1159 // Check for invalid input parameters\r
1160 //\r
1161 ASSERT (Table);\r
1162 ASSERT (NumberOfTableEntries);\r
1163 ASSERT (Rsdt);\r
1164\r
1165 //\r
1166 // Find the table entry in the RSDT and XSDT\r
1167 //\r
1168 for (Index = 0; Index < *NumberOfTableEntries; Index++) {\r
1169 //\r
1170 // At this time, it is assumed that RSDT and XSDT maintain parallel lists of tables.\r
1171 // If it becomes necessary to maintain separate table lists, changes will be required.\r
1172 //\r
1173 CurrentRsdtEntry = (UINT32 *) ((UINT8 *) Rsdt + sizeof (EFI_ACPI_DESCRIPTION_HEADER) + Index * sizeof (UINT32));\r
1174 if (Xsdt != NULL) {\r
1175 //\r
1176 // This pointer must not be directly dereferenced as the XSDT entries may not\r
1177 // be 64 bit aligned resulting in a possible fault. Use CopyMem to update.\r
1178 //\r
1179 CurrentXsdtEntry = (VOID *) ((UINT8 *) Xsdt + sizeof (EFI_ACPI_DESCRIPTION_HEADER) + Index * sizeof (UINT64));\r
1180\r
1181 //\r
1182 // Read the entry value out of the XSDT\r
1183 //\r
1184 CopyMem (&CurrentTablePointer64, CurrentXsdtEntry, sizeof (UINT64));\r
1185 } else {\r
1186 //\r
1187 // Initialize to NULL\r
1188 //\r
1189 CurrentXsdtEntry = 0;\r
1190 CurrentTablePointer64 = 0;\r
1191 }\r
1192 //\r
1193 // Check if we have found the corresponding entry in both RSDT and XSDT\r
1194 //\r
1195 if (*CurrentRsdtEntry == (UINT32) (UINTN) Table->Table &&\r
1196 ((Xsdt == NULL) || CurrentTablePointer64 == (UINT64) (UINTN) Table->Table)\r
1197 ) {\r
1198 //\r
1199 // Found entry, so copy all following entries and shrink table\r
1200 // We actually copy all + 1 to copy the initialized value of memory over\r
1201 // the last entry.\r
1202 //\r
1203 CopyMem (CurrentRsdtEntry, CurrentRsdtEntry + 1, (*NumberOfTableEntries - Index) * sizeof (UINT32));\r
1204 Rsdt->Length = Rsdt->Length - sizeof (UINT32);\r
1205 if (Xsdt != NULL) {\r
1206 CopyMem (CurrentXsdtEntry, ((UINT64 *) CurrentXsdtEntry) + 1, (*NumberOfTableEntries - Index) * sizeof (UINT64));\r
1207 Xsdt->Length = Xsdt->Length - sizeof (UINT64);\r
1208 }\r
1209 break;\r
1210 } else if (Index + 1 == *NumberOfTableEntries) {\r
1211 //\r
1212 // At the last entry, and table not found\r
1213 //\r
1214 return EFI_INVALID_PARAMETER;\r
1215 }\r
1216 }\r
1217 //\r
1218 // Checksum the tables\r
1219 //\r
1220 AcpiPlatformChecksum (\r
1221 Rsdt,\r
1222 Rsdt->Length,\r
1223 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
1224 Checksum)\r
1225 );\r
1226\r
1227 if (Xsdt != NULL) {\r
1228 AcpiPlatformChecksum (\r
1229 Xsdt,\r
1230 Xsdt->Length,\r
1231 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
1232 Checksum)\r
1233 );\r
1234 }\r
1235 //\r
1236 // Decrement the number of tables\r
1237 //\r
1238 (*NumberOfTableEntries)--;\r
1239\r
1240 return EFI_SUCCESS;\r
1241}\r
1242\r
1243\r
1244/**\r
1245 This function removes a table and frees any associated memory.\r
1246\r
1247 @param AcpiTableInstance Instance of the protocol.\r
1248 @param Version Version(s) to delete.\r
1249 @param Table Pointer to table found.\r
1250\r
1251 @return EFI_SUCCESS The function completed successfully.\r
1252\r
1253**/\r
1254EFI_STATUS\r
1255DeleteTable (\r
1256 IN EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance,\r
1257 IN EFI_ACPI_TABLE_VERSION Version,\r
1258 IN OUT EFI_ACPI_TABLE_LIST *Table\r
1259 )\r
1260{\r
1261 UINT32 CurrentTableSignature;\r
1262 BOOLEAN RemoveFromRsdt;\r
1263\r
1264 //\r
1265 // Check for invalid input parameters\r
1266 //\r
1267 ASSERT (AcpiTableInstance);\r
1268 ASSERT (Table);\r
1269\r
1270 //\r
1271 // Init locals\r
1272 //\r
1273 RemoveFromRsdt = TRUE;\r
6198c346 1274 //\r
1275 // Check for Table->Table\r
1276 //\r
1277 ASSERT (Table->Table != NULL);\r
5f55c700 1278 CurrentTableSignature = ((EFI_ACPI_COMMON_HEADER *) Table->Table)->Signature;\r
1279\r
1280 //\r
1281 // Basic tasks to accomplish delete are:\r
1282 // Determine removal requirements (in RSDT/XSDT or not)\r
1283 // Remove entry from RSDT/XSDT\r
1284 // Remove any table references to the table\r
1285 // If no one is using the table\r
1286 // Free the table (removing pointers from private data and tables)\r
1287 // Remove from list\r
1288 // Free list structure\r
1289 //\r
1290 //\r
1291 // Determine if this table is in the RSDT or XSDT\r
1292 //\r
1293 if ((CurrentTableSignature == EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE) ||\r
1294 (CurrentTableSignature == EFI_ACPI_2_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE) ||\r
1295 (CurrentTableSignature == EFI_ACPI_3_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE)\r
1296 ) {\r
1297 RemoveFromRsdt = FALSE;\r
1298 }\r
1299 //\r
1300 // We don't remove the FADT in the standard way because some\r
1301 // OS expect the FADT to be early in the table list.\r
1302 // So we always put it as the first element in the list.\r
1303 //\r
1304 if (CurrentTableSignature == EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE) {\r
1305 RemoveFromRsdt = FALSE;\r
1306 }\r
1307\r
1308 //\r
1309 // Remove the table from RSDT and XSDT\r
1310 //\r
1311 if (Table->Table != NULL) {\r
1312 //\r
1313 // This is a basic table, remove it from any lists and the Rsdt and/or Xsdt\r
1314 //\r
1315 if (Version & EFI_ACPI_TABLE_VERSION_NONE & Table->Version) {\r
1316 //\r
1317 // Remove this version from the table\r
1318 //\r
1319 Table->Version = Table->Version &~EFI_ACPI_TABLE_VERSION_NONE;\r
1320 }\r
1321\r
1322 if (Version & EFI_ACPI_TABLE_VERSION_1_0B & Table->Version) {\r
1323 //\r
1324 // Remove this version from the table\r
1325 //\r
1326 Table->Version = Table->Version &~EFI_ACPI_TABLE_VERSION_1_0B;\r
1327\r
1328 //\r
1329 // Remove from Rsdt. We don't care about the return value because it is\r
1330 // acceptable for the table to not exist in Rsdt.\r
1331 // We didn't add some tables so we don't remove them.\r
1332 //\r
1333 if (RemoveFromRsdt) {\r
1334 RemoveTableFromRsdt (\r
1335 Table,\r
1336 &AcpiTableInstance->NumberOfTableEntries1,\r
1337 AcpiTableInstance->Rsdt1,\r
1338 NULL\r
1339 );\r
1340 }\r
1341 }\r
1342\r
1343 if ((Version & EFI_ACPI_TABLE_VERSION_2_0 & Table->Version) ||\r
1344 (Version & EFI_ACPI_TABLE_VERSION_3_0 & Table->Version)) {\r
1345 //\r
1346 // Remove this version from the table\r
1347 //\r
1348 if (Version & EFI_ACPI_TABLE_VERSION_2_0 & Table->Version) {\r
1349 Table->Version = Table->Version &~EFI_ACPI_TABLE_VERSION_2_0;\r
1350 } \r
1351 if (Version & EFI_ACPI_TABLE_VERSION_3_0 & Table->Version) {\r
1352 Table->Version = Table->Version &~EFI_ACPI_TABLE_VERSION_3_0;\r
1353 }\r
1354 \r
1355 //\r
1356 // Remove from Rsdt and Xsdt. We don't care about the return value\r
1357 // because it is acceptable for the table to not exist in Rsdt/Xsdt.\r
1358 // We didn't add some tables so we don't remove them.\r
1359 //\r
1360 if (RemoveFromRsdt) {\r
1361 RemoveTableFromRsdt (\r
1362 Table,\r
1363 &AcpiTableInstance->NumberOfTableEntries3,\r
1364 AcpiTableInstance->Rsdt3,\r
1365 AcpiTableInstance->Xsdt\r
1366 );\r
1367 }\r
1368 } \r
1369 //\r
1370 // Free the table, clean up any dependent tables and our private data pointers.\r
1371 //\r
1372 switch (Table->Table->Signature) {\r
1373\r
1374 case EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE:\r
1375 if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
1376 AcpiTableInstance->Fadt1 = NULL;\r
1377 }\r
1378\r
1379 if ((Version & EFI_ACPI_TABLE_VERSION_2_0) != 0 ||\r
1380 (Version & EFI_ACPI_TABLE_VERSION_3_0) != 0) {\r
1381 AcpiTableInstance->Fadt3 = NULL;\r
1382 }\r
1383 break;\r
1384\r
1385 case EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE:\r
1386 if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
1387 AcpiTableInstance->Facs1 = NULL;\r
1388\r
1389 //\r
1390 // Update FADT table pointers\r
1391 //\r
1392 if (AcpiTableInstance->Fadt1 != NULL) {\r
1393 AcpiTableInstance->Fadt1->FirmwareCtrl = 0;\r
1394\r
1395 //\r
1396 // Checksum table\r
1397 //\r
1398 AcpiPlatformChecksum (\r
1399 AcpiTableInstance->Fadt1,\r
1400 AcpiTableInstance->Fadt1->Header.Length,\r
1401 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
1402 Checksum)\r
1403 );\r
1404 }\r
1405 }\r
1406\r
1407 if ((Version & EFI_ACPI_TABLE_VERSION_2_0) != 0 ||\r
1408 (Version & EFI_ACPI_TABLE_VERSION_3_0) != 0) {\r
1409 AcpiTableInstance->Facs3 = NULL;\r
1410\r
1411 //\r
1412 // Update FADT table pointers\r
1413 //\r
1414 if (AcpiTableInstance->Fadt3 != NULL) {\r
1415 AcpiTableInstance->Fadt3->FirmwareCtrl = 0;\r
1416 ZeroMem (&AcpiTableInstance->Fadt3->XFirmwareCtrl, sizeof (UINT64));\r
1417\r
1418 //\r
1419 // Checksum table\r
1420 //\r
1421 AcpiPlatformChecksum (\r
1422 AcpiTableInstance->Fadt3,\r
1423 AcpiTableInstance->Fadt3->Header.Length,\r
1424 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
1425 Checksum)\r
1426 );\r
1427 }\r
1428 } \r
1429 break;\r
1430\r
1431 case EFI_ACPI_3_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE:\r
1432 if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
1433 AcpiTableInstance->Dsdt1 = NULL;\r
1434\r
1435 //\r
1436 // Update FADT table pointers\r
1437 //\r
1438 if (AcpiTableInstance->Fadt1 != NULL) {\r
1439 AcpiTableInstance->Fadt1->Dsdt = 0;\r
1440\r
1441 //\r
1442 // Checksum table\r
1443 //\r
1444 AcpiPlatformChecksum (\r
1445 AcpiTableInstance->Fadt1,\r
1446 AcpiTableInstance->Fadt1->Header.Length,\r
1447 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
1448 Checksum)\r
1449 );\r
1450 }\r
1451 }\r
1452\r
1453 \r
1454 if ((Version & EFI_ACPI_TABLE_VERSION_2_0) != 0 ||\r
1455 (Version & EFI_ACPI_TABLE_VERSION_3_0) != 0) {\r
1456 AcpiTableInstance->Dsdt3 = NULL;\r
1457\r
1458 //\r
1459 // Update FADT table pointers\r
1460 //\r
1461 if (AcpiTableInstance->Fadt3 != NULL) {\r
1462 AcpiTableInstance->Fadt3->Dsdt = 0;\r
1463 ZeroMem (&AcpiTableInstance->Fadt3->XDsdt, sizeof (UINT64));\r
1464\r
1465 //\r
1466 // Checksum table\r
1467 //\r
1468 AcpiPlatformChecksum (\r
1469 AcpiTableInstance->Fadt3,\r
1470 AcpiTableInstance->Fadt3->Header.Length,\r
1471 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
1472 Checksum)\r
1473 );\r
1474 }\r
1475 }\r
1476 break;\r
1477\r
1478 default:\r
1479 //\r
1480 // Do nothing\r
1481 //\r
1482 break;\r
1483 }\r
1484 }\r
1485 //\r
1486 // If no version is using this table anymore, remove and free list entry.\r
1487 //\r
1488 if (Table->Version == 0) {\r
1489 //\r
1490 // Free the Table\r
1491 //\r
1492 gBS->FreePages (Table->PageAddress, Table->NumberOfPages);\r
1493 RemoveEntryList (&(Table->Link));\r
1494 gBS->FreePool (Table);\r
1495 }\r
1496 //\r
1497 // Done\r
1498 //\r
1499 return EFI_SUCCESS;\r
1500}\r
1501\r
1502\r
1503/**\r
1504 This function finds and removes the table specified by the handle.\r
1505\r
1506 @param AcpiTableInstance Instance of the protocol.\r
1507 @param Version Bitmask of which versions to remove.\r
1508 @param Handle Table to remove.\r
1509\r
1510 @return EFI_SUCCESS The function completed successfully.\r
1511 @return EFI_ABORTED An error occurred.\r
1512 @return EFI_NOT_FOUND Handle not found in table list.\r
1513\r
1514**/\r
1515EFI_STATUS\r
1516RemoveTableFromList (\r
1517 IN EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance,\r
1518 IN EFI_ACPI_TABLE_VERSION Version,\r
1519 IN UINTN Handle\r
1520 )\r
1521{\r
1522 EFI_ACPI_TABLE_LIST *Table;\r
1523 EFI_STATUS Status;\r
1524\r
b474ed49 1525 Table = (EFI_ACPI_TABLE_LIST*) NULL;\r
1526\r
5f55c700 1527 //\r
1528 // Check for invalid input parameters\r
1529 //\r
1530 ASSERT (AcpiTableInstance);\r
1531\r
1532 //\r
1533 // Find the table\r
1534 //\r
1535 Status = FindTableByHandle (\r
1536 Handle,\r
1537 &AcpiTableInstance->TableList,\r
1538 &Table\r
1539 );\r
1540 if (EFI_ERROR (Status)) {\r
1541 return EFI_NOT_FOUND;\r
1542 }\r
1543 //\r
1544 // Remove the table\r
1545 //\r
1546 Status = DeleteTable (AcpiTableInstance, Version, Table);\r
1547 if (EFI_ERROR (Status)) {\r
1548 return EFI_ABORTED;\r
1549 }\r
1550 //\r
1551 // Completed successfully\r
1552 //\r
1553 return EFI_SUCCESS;\r
1554}\r
1555\r
1556\r
1557/**\r
1558 This function calculates and updates an UINT8 checksum.\r
1559\r
1560 @param Buffer Pointer to buffer to checksum\r
1561 @param Size Number of bytes to checksum\r
1562 @param ChecksumOffset Offset to place the checksum result in\r
1563\r
1564 @return EFI_SUCCESS The function completed successfully.\r
1565\r
1566**/\r
1567EFI_STATUS\r
1568AcpiPlatformChecksum (\r
1569 IN VOID *Buffer,\r
1570 IN UINTN Size,\r
1571 IN UINTN ChecksumOffset\r
1572 )\r
1573{\r
1574 UINT8 Sum;\r
1575 UINT8 *Ptr;\r
1576\r
1577 Sum = 0;\r
1578 //\r
1579 // Initialize pointer\r
1580 //\r
1581 Ptr = Buffer;\r
1582\r
1583 //\r
1584 // set checksum to 0 first\r
1585 //\r
1586 Ptr[ChecksumOffset] = 0;\r
1587\r
1588 //\r
1589 // add all content of buffer\r
1590 //\r
1591 while ((Size--) != 0) {\r
1592 Sum = (UINT8) (Sum + (*Ptr++));\r
1593 }\r
1594 //\r
1595 // set checksum\r
1596 //\r
1597 Ptr = Buffer;\r
1598 Ptr[ChecksumOffset] = (UINT8) (0xff - Sum + 1);\r
1599\r
1600 return EFI_SUCCESS;\r
1601}\r
1602\r
1603\r
1604/**\r
1605 Checksum all versions of the common tables, RSDP, RSDT, XSDT.\r
1606\r
1607 @param AcpiTableInstance Protocol instance private data.\r
1608\r
1609 @return EFI_SUCCESS The function completed successfully.\r
1610\r
1611**/\r
1612EFI_STATUS\r
1613ChecksumCommonTables (\r
1614 IN OUT EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance\r
1615 )\r
1616{\r
1617 //\r
1618 // RSDP ACPI 1.0 checksum for 1.0 table. This is only the first 20 bytes of the structure\r
1619 //\r
1620 AcpiPlatformChecksum (\r
1621 AcpiTableInstance->Rsdp1,\r
1622 sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER),\r
1623 OFFSET_OF (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER,\r
1624 Checksum)\r
1625 );\r
1626\r
1627 //\r
1628 // RSDP ACPI 1.0 checksum for 2.0/3.0 table. This is only the first 20 bytes of the structure\r
1629 //\r
1630 AcpiPlatformChecksum (\r
1631 AcpiTableInstance->Rsdp3,\r
1632 sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER),\r
1633 OFFSET_OF (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER,\r
1634 Checksum)\r
1635 );\r
1636\r
1637 //\r
1638 // RSDP ACPI 2.0/3.0 checksum, this is the entire table\r
1639 //\r
1640 AcpiPlatformChecksum (\r
1641 AcpiTableInstance->Rsdp3,\r
1642 sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER),\r
1643 OFFSET_OF (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER,\r
1644 ExtendedChecksum)\r
1645 );\r
1646\r
1647 //\r
1648 // RSDT checksums\r
1649 //\r
1650 AcpiPlatformChecksum (\r
1651 AcpiTableInstance->Rsdt1,\r
1652 AcpiTableInstance->Rsdt1->Length,\r
1653 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
1654 Checksum)\r
1655 );\r
1656\r
1657 AcpiPlatformChecksum (\r
1658 AcpiTableInstance->Rsdt3,\r
1659 AcpiTableInstance->Rsdt3->Length,\r
1660 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
1661 Checksum)\r
1662 );\r
1663\r
1664 //\r
1665 // XSDT checksum\r
1666 //\r
1667 AcpiPlatformChecksum (\r
1668 AcpiTableInstance->Xsdt,\r
1669 AcpiTableInstance->Xsdt->Length,\r
1670 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
1671 Checksum)\r
1672 );\r
1673 \r
1674 return EFI_SUCCESS;\r
1675}\r
1676\r
1677\r
1678/**\r
1679 Constructor for the ACPI table protocol. Initializes instance\r
1680 data.\r
1681\r
1682 @param AcpiTableInstance Instance to construct\r
1683\r
1684 @return EFI_SUCCESS Instance initialized.\r
1685 @return EFI_OUT_OF_RESOURCES Unable to allocate required resources.\r
1686\r
1687**/\r
1688EFI_STATUS\r
1689AcpiTableAcpiTableConstructor (\r
1690 EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance\r
1691 )\r
1692{\r
1693 EFI_STATUS Status;\r
1694 UINT64 CurrentData;\r
1695 UINTN TotalSize;\r
37abfb7e 1696 UINTN RsdpTableSize;\r
5f55c700 1697 UINT8 *Pointer;\r
1698 EFI_PHYSICAL_ADDRESS PageAddress;\r
1699\r
1700 //\r
1701 // Check for invalid input parameters\r
1702 //\r
1703 ASSERT (AcpiTableInstance);\r
1704\r
1705 InitializeListHead (&AcpiTableInstance->TableList);\r
1706 AcpiTableInstance->CurrentHandle = 1;\r
1707\r
1708 AcpiTableInstance->AcpiTableProtocol.InstallAcpiTable = InstallAcpiTable;\r
1709 AcpiTableInstance->AcpiTableProtocol.UninstallAcpiTable = UninstallAcpiTable;\r
3dc8585e
JY
1710\r
1711 if (FeaturePcdGet (PcdInstallAcpiSdtProtocol)) {\r
1712 SdtAcpiTableAcpiSdtConstructor (AcpiTableInstance);\r
1713 }\r
1714\r
5f55c700 1715 //\r
37abfb7e
LG
1716 // Create RSDP table\r
1717 //\r
1718 RsdpTableSize = sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER) +\r
1719 sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER);\r
1720\r
1721 PageAddress = 0xFFFFFFFF;\r
1722 Status = gBS->AllocatePages (\r
1723 AllocateMaxAddress,\r
1724 EfiACPIReclaimMemory,\r
1725 EFI_SIZE_TO_PAGES (RsdpTableSize),\r
1726 &PageAddress\r
1727 );\r
1728\r
1729 if (EFI_ERROR (Status)) {\r
1730 return EFI_OUT_OF_RESOURCES;\r
1731 }\r
1732\r
1733 Pointer = (UINT8 *) (UINTN) PageAddress;\r
1734 ZeroMem (Pointer, RsdpTableSize);\r
1735\r
1736 AcpiTableInstance->Rsdp1 = (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER *) Pointer;\r
1737 Pointer += sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER);\r
1738 AcpiTableInstance->Rsdp3 = (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER *) Pointer;\r
1739\r
1740 //\r
1741 // Create RSDT, XSDT structures\r
5f55c700 1742 //\r
37abfb7e
LG
1743 TotalSize = sizeof (EFI_ACPI_DESCRIPTION_HEADER) + // for ACPI 1.0 RSDT\r
1744 mEfiAcpiMaxNumTables * sizeof (UINT32) +\r
1745 sizeof (EFI_ACPI_DESCRIPTION_HEADER) + // for ACPI 2.0/3.0 RSDT\r
1746 mEfiAcpiMaxNumTables * sizeof (UINT32) +\r
1747 sizeof (EFI_ACPI_DESCRIPTION_HEADER) + // for ACPI 2.0/3.0 XSDT\r
1748 mEfiAcpiMaxNumTables * sizeof (UINT64);\r
5f55c700 1749\r
1750 //\r
1751 // Allocate memory in the lower 32 bit of address range for\r
1752 // compatibility with ACPI 1.0 OS.\r
1753 //\r
1754 // This is done because ACPI 1.0 pointers are 32 bit values.\r
1755 // ACPI 2.0 OS and all 64 bit OS must use the 64 bit ACPI table addresses.\r
1756 // There is no architectural reason these should be below 4GB, it is purely\r
1757 // for convenience of implementation that we force memory below 4GB.\r
1758 //\r
1759 PageAddress = 0xFFFFFFFF;\r
1760 Status = gBS->AllocatePages (\r
1761 AllocateMaxAddress,\r
1762 EfiACPIReclaimMemory,\r
1763 EFI_SIZE_TO_PAGES (TotalSize),\r
1764 &PageAddress\r
1765 );\r
1766\r
1767 if (EFI_ERROR (Status)) {\r
37abfb7e 1768 gBS->FreePages ((EFI_PHYSICAL_ADDRESS)(UINTN)AcpiTableInstance->Rsdp1, EFI_SIZE_TO_PAGES (RsdpTableSize));\r
5f55c700 1769 return EFI_OUT_OF_RESOURCES;\r
1770 }\r
1771\r
1772 Pointer = (UINT8 *) (UINTN) PageAddress;\r
1773 ZeroMem (Pointer, TotalSize);\r
1774\r
5f55c700 1775 AcpiTableInstance->Rsdt1 = (EFI_ACPI_DESCRIPTION_HEADER *) Pointer;\r
1776 Pointer += (sizeof (EFI_ACPI_DESCRIPTION_HEADER) + EFI_ACPI_MAX_NUM_TABLES * sizeof (UINT32));\r
1777 AcpiTableInstance->Rsdt3 = (EFI_ACPI_DESCRIPTION_HEADER *) Pointer;\r
1778 Pointer += (sizeof (EFI_ACPI_DESCRIPTION_HEADER) + EFI_ACPI_MAX_NUM_TABLES * sizeof (UINT32));\r
5f55c700 1779 AcpiTableInstance->Xsdt = (EFI_ACPI_DESCRIPTION_HEADER *) Pointer;\r
1780\r
1781 //\r
1782 // Initialize RSDP\r
1783 //\r
1784 CurrentData = EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE;\r
1785 CopyMem (&AcpiTableInstance->Rsdp1->Signature, &CurrentData, sizeof (UINT64));\r
1786 CopyMem (AcpiTableInstance->Rsdp1->OemId, EFI_ACPI_OEM_ID, 6);\r
1787 AcpiTableInstance->Rsdp1->Reserved = EFI_ACPI_RESERVED_BYTE;\r
1788 AcpiTableInstance->Rsdp1->RsdtAddress = (UINT32) (UINTN) AcpiTableInstance->Rsdt1;\r
1789\r
1790 CurrentData = EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE;\r
1791 CopyMem (&AcpiTableInstance->Rsdp3->Signature, &CurrentData, sizeof (UINT64));\r
1792 CopyMem (AcpiTableInstance->Rsdp3->OemId, EFI_ACPI_OEM_ID, 6);\r
1793 AcpiTableInstance->Rsdp3->Revision = EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION;\r
1794 AcpiTableInstance->Rsdp3->RsdtAddress = (UINT32) (UINTN) AcpiTableInstance->Rsdt3;\r
1795 AcpiTableInstance->Rsdp3->Length = sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER);\r
1796 CurrentData = (UINT64) (UINTN) AcpiTableInstance->Xsdt;\r
1797 CopyMem (&AcpiTableInstance->Rsdp3->XsdtAddress, &CurrentData, sizeof (UINT64));\r
1798 SetMem (AcpiTableInstance->Rsdp3->Reserved, 3, EFI_ACPI_RESERVED_BYTE);\r
1799\r
1800 //\r
1801 // Initialize Rsdt\r
1802 //\r
1803 // Note that we "reserve" one entry for the FADT so it can always be\r
1804 // at the beginning of the list of tables. Some OS don't seem\r
1805 // to find it correctly if it is too far down the list.\r
1806 //\r
1807 AcpiTableInstance->Rsdt1->Signature = EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE;\r
1808 AcpiTableInstance->Rsdt1->Length = sizeof (EFI_ACPI_DESCRIPTION_HEADER);\r
1809 AcpiTableInstance->Rsdt1->Revision = EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION;\r
1810 CopyMem (AcpiTableInstance->Rsdt1->OemId, EFI_ACPI_OEM_ID, 6);\r
1811 CurrentData = EFI_ACPI_OEM_TABLE_ID;\r
1812 CopyMem (&AcpiTableInstance->Rsdt1->OemTableId, &CurrentData, sizeof (UINT64));\r
1813 AcpiTableInstance->Rsdt1->OemRevision = EFI_ACPI_OEM_REVISION;\r
1814 AcpiTableInstance->Rsdt1->CreatorId = EFI_ACPI_CREATOR_ID;\r
1815 AcpiTableInstance->Rsdt1->CreatorRevision = EFI_ACPI_CREATOR_REVISION;\r
1816 //\r
1817 // We always reserve first one for FADT\r
1818 //\r
1819 AcpiTableInstance->NumberOfTableEntries1 = 1;\r
1820 AcpiTableInstance->Rsdt1->Length = AcpiTableInstance->Rsdt1->Length + sizeof(UINT32);\r
1821\r
1822 AcpiTableInstance->Rsdt3->Signature = EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE;\r
1823 AcpiTableInstance->Rsdt3->Length = sizeof (EFI_ACPI_DESCRIPTION_HEADER);\r
1824 AcpiTableInstance->Rsdt3->Revision = EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION;\r
1825 CopyMem (AcpiTableInstance->Rsdt3->OemId, EFI_ACPI_OEM_ID, 6);\r
1826 CurrentData = EFI_ACPI_OEM_TABLE_ID;\r
1827 CopyMem (&AcpiTableInstance->Rsdt3->OemTableId, &CurrentData, sizeof (UINT64));\r
1828 AcpiTableInstance->Rsdt3->OemRevision = EFI_ACPI_OEM_REVISION;\r
1829 AcpiTableInstance->Rsdt3->CreatorId = EFI_ACPI_CREATOR_ID;\r
1830 AcpiTableInstance->Rsdt3->CreatorRevision = EFI_ACPI_CREATOR_REVISION;\r
1831 //\r
1832 // We always reserve first one for FADT\r
1833 //\r
1834 AcpiTableInstance->NumberOfTableEntries3 = 1;\r
1835 AcpiTableInstance->Rsdt3->Length = AcpiTableInstance->Rsdt3->Length + sizeof(UINT32);\r
1836\r
1837 //\r
1838 // Initialize Xsdt\r
1839 //\r
1840 AcpiTableInstance->Xsdt->Signature = EFI_ACPI_3_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE;\r
1841 AcpiTableInstance->Xsdt->Length = sizeof (EFI_ACPI_DESCRIPTION_HEADER);\r
1842 AcpiTableInstance->Xsdt->Revision = EFI_ACPI_3_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION;\r
1843 CopyMem (AcpiTableInstance->Xsdt->OemId, EFI_ACPI_OEM_ID, 6);\r
1844 CurrentData = EFI_ACPI_OEM_TABLE_ID;\r
1845 CopyMem (&AcpiTableInstance->Xsdt->OemTableId, &CurrentData, sizeof (UINT64));\r
1846 AcpiTableInstance->Xsdt->OemRevision = EFI_ACPI_OEM_REVISION;\r
1847 AcpiTableInstance->Xsdt->CreatorId = EFI_ACPI_CREATOR_ID;\r
1848 AcpiTableInstance->Xsdt->CreatorRevision = EFI_ACPI_CREATOR_REVISION;\r
1849 //\r
1850 // We always reserve first one for FADT\r
1851 //\r
1852 AcpiTableInstance->Xsdt->Length = AcpiTableInstance->Xsdt->Length + sizeof(UINT64);\r
1853\r
1854 ChecksumCommonTables (AcpiTableInstance);\r
1855\r
1856 //\r
1857 // Completed successfully\r
1858 //\r
1859 return EFI_SUCCESS;\r
1860}\r
1861\r