1 /******************************************************************************
2 *
3 * Module Name: tbinstal - ACPI table installation and removal
4 *
5 *****************************************************************************/
6
7 /*
8 * Copyright (C) 2000 - 2014, Intel Corp.
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
25 *
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
29 *
30 * NO WARRANTY
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
42 */
43
44 #include "acpi.h"
45 #include "accommon.h"
46 #include "actables.h"
47
48 #define _COMPONENT ACPI_TABLES
49 ACPI_MODULE_NAME ("tbinstal")
50
51 /* Local prototypes */
52
53 static BOOLEAN
54 AcpiTbCompareTables (
55 ACPI_TABLE_DESC *TableDesc,
56 UINT32 TableIndex);
57
58
59 /*******************************************************************************
60 *
61 * FUNCTION: AcpiTbCompareTables
62 *
63 * PARAMETERS: TableDesc - Table 1 descriptor to be compared
64 * TableIndex - Index of table 2 to be compared
65 *
66 * RETURN: TRUE if both tables are identical.
67 *
68 * DESCRIPTION: This function compares a table with another table that has
69 * already been installed in the root table list.
70 *
71 ******************************************************************************/
72
73 static BOOLEAN
AcpiTbCompareTables(ACPI_TABLE_DESC * TableDesc,UINT32 TableIndex)74 AcpiTbCompareTables (
75 ACPI_TABLE_DESC *TableDesc,
76 UINT32 TableIndex)
77 {
78 ACPI_STATUS Status = AE_OK;
79 BOOLEAN IsIdentical;
80 ACPI_TABLE_HEADER *Table;
81 UINT32 TableLength;
82 UINT8 TableFlags;
83
84
85 Status = AcpiTbAcquireTable (&AcpiGbl_RootTableList.Tables[TableIndex],
86 &Table, &TableLength, &TableFlags);
87 if (ACPI_FAILURE (Status))
88 {
89 return (FALSE);
90 }
91
92 /*
93 * Check for a table match on the entire table length,
94 * not just the header.
95 */
96 IsIdentical = (BOOLEAN)((TableDesc->Length != TableLength ||
97 ACPI_MEMCMP (TableDesc->Pointer, Table, TableLength)) ?
98 FALSE : TRUE);
99
100 /* Release the acquired table */
101
102 AcpiTbReleaseTable (Table, TableLength, TableFlags);
103 return (IsIdentical);
104 }
105
106
107 /*******************************************************************************
108 *
109 * FUNCTION: AcpiTbInstallTableWithOverride
110 *
111 * PARAMETERS: TableIndex - Index into root table array
112 * NewTableDesc - New table descriptor to install
113 * Override - Whether override should be performed
114 *
115 * RETURN: None
116 *
117 * DESCRIPTION: Install an ACPI table into the global data structure. The
118 * table override mechanism is called to allow the host
119 * OS to replace any table before it is installed in the root
120 * table array.
121 *
122 ******************************************************************************/
123
124 void
AcpiTbInstallTableWithOverride(UINT32 TableIndex,ACPI_TABLE_DESC * NewTableDesc,BOOLEAN Override)125 AcpiTbInstallTableWithOverride (
126 UINT32 TableIndex,
127 ACPI_TABLE_DESC *NewTableDesc,
128 BOOLEAN Override)
129 {
130
131 if (TableIndex >= AcpiGbl_RootTableList.CurrentTableCount)
132 {
133 return;
134 }
135
136 /*
137 * ACPI Table Override:
138 *
139 * Before we install the table, let the host OS override it with a new
140 * one if desired. Any table within the RSDT/XSDT can be replaced,
141 * including the DSDT which is pointed to by the FADT.
142 */
143 if (Override)
144 {
145 AcpiTbOverrideTable (NewTableDesc);
146 }
147
148 AcpiTbInitTableDescriptor (&AcpiGbl_RootTableList.Tables[TableIndex],
149 NewTableDesc->Address, NewTableDesc->Flags, NewTableDesc->Pointer);
150
151 AcpiTbPrintTableHeader (NewTableDesc->Address, NewTableDesc->Pointer);
152
153 /* Set the global integer width (based upon revision of the DSDT) */
154
155 if (TableIndex == ACPI_TABLE_INDEX_DSDT)
156 {
157 AcpiUtSetIntegerWidth (NewTableDesc->Pointer->Revision);
158 }
159 }
160
161
162 /*******************************************************************************
163 *
164 * FUNCTION: AcpiTbInstallFixedTable
165 *
166 * PARAMETERS: Address - Physical address of DSDT or FACS
167 * Signature - Table signature, NULL if no need to
168 * match
169 * TableIndex - Index into root table array
170 *
171 * RETURN: Status
172 *
173 * DESCRIPTION: Install a fixed ACPI table (DSDT/FACS) into the global data
174 * structure.
175 *
176 ******************************************************************************/
177
178 ACPI_STATUS
AcpiTbInstallFixedTable(ACPI_PHYSICAL_ADDRESS Address,char * Signature,UINT32 TableIndex)179 AcpiTbInstallFixedTable (
180 ACPI_PHYSICAL_ADDRESS Address,
181 char *Signature,
182 UINT32 TableIndex)
183 {
184 ACPI_TABLE_DESC NewTableDesc;
185 ACPI_STATUS Status;
186
187
188 ACPI_FUNCTION_TRACE (TbInstallFixedTable);
189
190
191 if (!Address)
192 {
193 ACPI_ERROR ((AE_INFO, "Null physical address for ACPI table [%s]",
194 Signature));
195 return (AE_NO_MEMORY);
196 }
197
198 /* Fill a table descriptor for validation */
199
200 Status = AcpiTbAcquireTempTable (&NewTableDesc, Address,
201 ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL);
202 if (ACPI_FAILURE (Status))
203 {
204 ACPI_ERROR ((AE_INFO, "Could not acquire table length at %p",
205 ACPI_CAST_PTR (void, Address)));
206 return_ACPI_STATUS (Status);
207 }
208
209 /* Validate and verify a table before installation */
210
211 Status = AcpiTbVerifyTempTable (&NewTableDesc, Signature);
212 if (ACPI_FAILURE (Status))
213 {
214 goto ReleaseAndExit;
215 }
216
217 AcpiTbInstallTableWithOverride (TableIndex, &NewTableDesc, TRUE);
218
219 ReleaseAndExit:
220
221 /* Release the temporary table descriptor */
222
223 AcpiTbReleaseTempTable (&NewTableDesc);
224 return_ACPI_STATUS (Status);
225 }
226
227
228 /*******************************************************************************
229 *
230 * FUNCTION: AcpiTbInstallStandardTable
231 *
232 * PARAMETERS: Address - Address of the table (might be a virtual
233 * address depending on the TableFlags)
234 * Flags - Flags for the table
235 * Reload - Whether reload should be performed
236 * Override - Whether override should be performed
237 * TableIndex - Where the table index is returned
238 *
239 * RETURN: Status
240 *
241 * DESCRIPTION: This function is called to install an ACPI table that is
242 * neither DSDT nor FACS (a "standard" table.)
243 * When this function is called by "Load" or "LoadTable" opcodes,
244 * or by AcpiLoadTable() API, the "Reload" parameter is set.
245 * After sucessfully returning from this function, table is
246 * "INSTALLED" but not "VALIDATED".
247 *
248 ******************************************************************************/
249
250 ACPI_STATUS
AcpiTbInstallStandardTable(ACPI_PHYSICAL_ADDRESS Address,UINT8 Flags,BOOLEAN Reload,BOOLEAN Override,UINT32 * TableIndex)251 AcpiTbInstallStandardTable (
252 ACPI_PHYSICAL_ADDRESS Address,
253 UINT8 Flags,
254 BOOLEAN Reload,
255 BOOLEAN Override,
256 UINT32 *TableIndex)
257 {
258 UINT32 i;
259 ACPI_STATUS Status = AE_OK;
260 ACPI_TABLE_DESC NewTableDesc;
261
262
263 ACPI_FUNCTION_TRACE (TbInstallStandardTable);
264
265
266 /* Acquire a temporary table descriptor for validation */
267
268 Status = AcpiTbAcquireTempTable (&NewTableDesc, Address, Flags);
269 if (ACPI_FAILURE (Status))
270 {
271 ACPI_ERROR ((AE_INFO, "Could not acquire table length at %p",
272 ACPI_CAST_PTR (void, Address)));
273 return_ACPI_STATUS (Status);
274 }
275
276 /*
277 * Optionally do not load any SSDTs from the RSDT/XSDT. This can
278 * be useful for debugging ACPI problems on some machines.
279 */
280 if (!Reload &&
281 AcpiGbl_DisableSsdtTableInstall &&
282 ACPI_COMPARE_NAME (&NewTableDesc.Signature, ACPI_SIG_SSDT))
283 {
284 ACPI_INFO ((AE_INFO, "Ignoring installation of %4.4s at %p",
285 NewTableDesc.Signature.Ascii, ACPI_CAST_PTR (void, Address)));
286 goto ReleaseAndExit;
287 }
288
289 /* Validate and verify a table before installation */
290
291 Status = AcpiTbVerifyTempTable (&NewTableDesc, NULL);
292 if (ACPI_FAILURE (Status))
293 {
294 goto ReleaseAndExit;
295 }
296
297 if (Reload)
298 {
299 /*
300 * Validate the incoming table signature.
301 *
302 * 1) Originally, we checked the table signature for "SSDT" or "PSDT".
303 * 2) We added support for OEMx tables, signature "OEM".
304 * 3) Valid tables were encountered with a null signature, so we just
305 * gave up on validating the signature, (05/2008).
306 * 4) We encountered non-AML tables such as the MADT, which caused
307 * interpreter errors and kernel faults. So now, we once again allow
308 * only "SSDT", "OEMx", and now, also a null signature. (05/2011).
309 */
310 if ((NewTableDesc.Signature.Ascii[0] != 0x00) &&
311 (!ACPI_COMPARE_NAME (&NewTableDesc.Signature, ACPI_SIG_SSDT)) &&
312 (ACPI_STRNCMP (NewTableDesc.Signature.Ascii, "OEM", 3)))
313 {
314 ACPI_BIOS_ERROR ((AE_INFO,
315 "Table has invalid signature [%4.4s] (0x%8.8X), "
316 "must be SSDT or OEMx",
317 AcpiUtValidAcpiName (NewTableDesc.Signature.Ascii) ?
318 NewTableDesc.Signature.Ascii : "????",
319 NewTableDesc.Signature.Integer));
320
321 Status = AE_BAD_SIGNATURE;
322 goto ReleaseAndExit;
323 }
324
325 /* Check if table is already registered */
326
327 for (i = 0; i < AcpiGbl_RootTableList.CurrentTableCount; ++i)
328 {
329 /*
330 * Check for a table match on the entire table length,
331 * not just the header.
332 */
333 if (!AcpiTbCompareTables (&NewTableDesc, i))
334 {
335 continue;
336 }
337
338 /*
339 * Note: the current mechanism does not unregister a table if it is
340 * dynamically unloaded. The related namespace entries are deleted,
341 * but the table remains in the root table list.
342 *
343 * The assumption here is that the number of different tables that
344 * will be loaded is actually small, and there is minimal overhead
345 * in just keeping the table in case it is needed again.
346 *
347 * If this assumption changes in the future (perhaps on large
348 * machines with many table load/unload operations), tables will
349 * need to be unregistered when they are unloaded, and slots in the
350 * root table list should be reused when empty.
351 */
352 if (AcpiGbl_RootTableList.Tables[i].Flags & ACPI_TABLE_IS_LOADED)
353 {
354 /* Table is still loaded, this is an error */
355
356 Status = AE_ALREADY_EXISTS;
357 goto ReleaseAndExit;
358 }
359 else
360 {
361 /*
362 * Table was unloaded, allow it to be reloaded.
363 * As we are going to return AE_OK to the caller, we should
364 * take the responsibility of freeing the input descriptor.
365 * Refill the input descriptor to ensure
366 * AcpiTbInstallTableWithOverride() can be called again to
367 * indicate the re-installation.
368 */
369 AcpiTbUninstallTable (&NewTableDesc);
370 *TableIndex = i;
371 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
372 return_ACPI_STATUS (AE_OK);
373 }
374 }
375 }
376
377 /* Add the table to the global root table list */
378
379 Status = AcpiTbGetNextRootIndex (&i);
380 if (ACPI_FAILURE (Status))
381 {
382 goto ReleaseAndExit;
383 }
384
385 *TableIndex = i;
386 AcpiTbInstallTableWithOverride (i, &NewTableDesc, Override);
387
388 ReleaseAndExit:
389
390 /* Release the temporary table descriptor */
391
392 AcpiTbReleaseTempTable (&NewTableDesc);
393 return_ACPI_STATUS (Status);
394 }
395
396
397 /*******************************************************************************
398 *
399 * FUNCTION: AcpiTbOverrideTable
400 *
401 * PARAMETERS: OldTableDesc - Validated table descriptor to be
402 * overridden
403 *
404 * RETURN: None
405 *
406 * DESCRIPTION: Attempt table override by calling the OSL override functions.
407 * Note: If the table is overridden, then the entire new table
408 * is acquired and returned by this function.
409 * Before/after invocation, the table descriptor is in a state
410 * that is "VALIDATED".
411 *
412 ******************************************************************************/
413
414 void
AcpiTbOverrideTable(ACPI_TABLE_DESC * OldTableDesc)415 AcpiTbOverrideTable (
416 ACPI_TABLE_DESC *OldTableDesc)
417 {
418 ACPI_STATUS Status;
419 char *OverrideType;
420 ACPI_TABLE_DESC NewTableDesc;
421 ACPI_TABLE_HEADER *Table;
422 ACPI_PHYSICAL_ADDRESS Address;
423 UINT32 Length;
424
425
426 /* (1) Attempt logical override (returns a logical address) */
427
428 Status = AcpiOsTableOverride (OldTableDesc->Pointer, &Table);
429 if (ACPI_SUCCESS (Status) && Table)
430 {
431 AcpiTbAcquireTempTable (&NewTableDesc, ACPI_PTR_TO_PHYSADDR (Table),
432 ACPI_TABLE_ORIGIN_EXTERNAL_VIRTUAL);
433 OverrideType = "Logical";
434 goto FinishOverride;
435 }
436
437 /* (2) Attempt physical override (returns a physical address) */
438
439 Status = AcpiOsPhysicalTableOverride (OldTableDesc->Pointer,
440 &Address, &Length);
441 if (ACPI_SUCCESS (Status) && Address && Length)
442 {
443 AcpiTbAcquireTempTable (&NewTableDesc, Address,
444 ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL);
445 OverrideType = "Physical";
446 goto FinishOverride;
447 }
448
449 return; /* There was no override */
450
451
452 FinishOverride:
453
454 /* Validate and verify a table before overriding */
455
456 Status = AcpiTbVerifyTempTable (&NewTableDesc, NULL);
457 if (ACPI_FAILURE (Status))
458 {
459 return;
460 }
461
462 ACPI_INFO ((AE_INFO, "%4.4s " ACPI_PRINTF_UINT
463 " %s table override, new table: " ACPI_PRINTF_UINT,
464 OldTableDesc->Signature.Ascii,
465 ACPI_FORMAT_TO_UINT (OldTableDesc->Address),
466 OverrideType, ACPI_FORMAT_TO_UINT (NewTableDesc.Address)));
467
468 /* We can now uninstall the original table */
469
470 AcpiTbUninstallTable (OldTableDesc);
471
472 /*
473 * Replace the original table descriptor and keep its state as
474 * "VALIDATED".
475 */
476 AcpiTbInitTableDescriptor (OldTableDesc, NewTableDesc.Address,
477 NewTableDesc.Flags, NewTableDesc.Pointer);
478 AcpiTbValidateTempTable (OldTableDesc);
479
480 /* Release the temporary table descriptor */
481
482 AcpiTbReleaseTempTable (&NewTableDesc);
483 }
484
485
486 /*******************************************************************************
487 *
488 * FUNCTION: AcpiTbStoreTable
489 *
490 * PARAMETERS: Address - Table address
491 * Table - Table header
492 * Length - Table length
493 * Flags - Install flags
494 * TableIndex - Where the table index is returned
495 *
496 * RETURN: Status and table index.
497 *
498 * DESCRIPTION: Add an ACPI table to the global table list
499 *
500 ******************************************************************************/
501
502 ACPI_STATUS
AcpiTbStoreTable(ACPI_PHYSICAL_ADDRESS Address,ACPI_TABLE_HEADER * Table,UINT32 Length,UINT8 Flags,UINT32 * TableIndex)503 AcpiTbStoreTable (
504 ACPI_PHYSICAL_ADDRESS Address,
505 ACPI_TABLE_HEADER *Table,
506 UINT32 Length,
507 UINT8 Flags,
508 UINT32 *TableIndex)
509 {
510 ACPI_STATUS Status;
511 ACPI_TABLE_DESC *TableDesc;
512
513
514 Status = AcpiTbGetNextRootIndex (TableIndex);
515 if (ACPI_FAILURE (Status))
516 {
517 return (Status);
518 }
519
520 /* Initialize added table */
521
522 TableDesc = &AcpiGbl_RootTableList.Tables[*TableIndex];
523 AcpiTbInitTableDescriptor (TableDesc, Address, Flags, Table);
524 TableDesc->Pointer = Table;
525 return (AE_OK);
526 }
527
528
529 /*******************************************************************************
530 *
531 * FUNCTION: AcpiTbUninstallTable
532 *
533 * PARAMETERS: TableDesc - Table descriptor
534 *
535 * RETURN: None
536 *
537 * DESCRIPTION: Delete one internal ACPI table
538 *
539 ******************************************************************************/
540
541 void
AcpiTbUninstallTable(ACPI_TABLE_DESC * TableDesc)542 AcpiTbUninstallTable (
543 ACPI_TABLE_DESC *TableDesc)
544 {
545
546 ACPI_FUNCTION_TRACE (TbUninstallTable);
547
548
549 /* Table must be installed */
550
551 if (!TableDesc->Address)
552 {
553 return_VOID;
554 }
555
556 AcpiTbInvalidateTable (TableDesc);
557
558 if ((TableDesc->Flags & ACPI_TABLE_ORIGIN_MASK) ==
559 ACPI_TABLE_ORIGIN_INTERNAL_VIRTUAL)
560 {
561 ACPI_FREE (ACPI_CAST_PTR (void, TableDesc->Address));
562 }
563
564 TableDesc->Address = ACPI_PTR_TO_PHYSADDR (NULL);
565 return_VOID;
566 }
567