1 /******************************************************************************
3 * Module Name: tbinstal - ACPI table installation and removal
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2015, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
48 #define _COMPONENT ACPI_TABLES
49 ACPI_MODULE_NAME ("tbinstal")
51 /* Local prototypes */
55 ACPI_TABLE_DESC
*TableDesc
,
59 /*******************************************************************************
61 * FUNCTION: AcpiTbCompareTables
63 * PARAMETERS: TableDesc - Table 1 descriptor to be compared
64 * TableIndex - Index of table 2 to be compared
66 * RETURN: TRUE if both tables are identical.
68 * DESCRIPTION: This function compares a table with another table that has
69 * already been installed in the root table list.
71 ******************************************************************************/
75 ACPI_TABLE_DESC
*TableDesc
,
78 ACPI_STATUS Status
= AE_OK
;
80 ACPI_TABLE_HEADER
*Table
;
85 Status
= AcpiTbAcquireTable (&AcpiGbl_RootTableList
.Tables
[TableIndex
],
86 &Table
, &TableLength
, &TableFlags
);
87 if (ACPI_FAILURE (Status
))
93 * Check for a table match on the entire table length,
94 * not just the header.
96 IsIdentical
= (BOOLEAN
)((TableDesc
->Length
!= TableLength
||
97 memcmp (TableDesc
->Pointer
, Table
, TableLength
)) ?
100 /* Release the acquired table */
102 AcpiTbReleaseTable (Table
, TableLength
, TableFlags
);
103 return (IsIdentical
);
107 /*******************************************************************************
109 * FUNCTION: AcpiTbInstallTableWithOverride
111 * PARAMETERS: NewTableDesc - New table descriptor to install
112 * Override - Whether override should be performed
113 * TableIndex - Where the table index is returned
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
122 ******************************************************************************/
125 AcpiTbInstallTableWithOverride (
126 ACPI_TABLE_DESC
*NewTableDesc
,
134 Status
= AcpiTbGetNextTableDescriptor (&i
, NULL
);
135 if (ACPI_FAILURE (Status
))
141 * ACPI Table Override:
143 * Before we install the table, let the host OS override it with a new
144 * one if desired. Any table within the RSDT/XSDT can be replaced,
145 * including the DSDT which is pointed to by the FADT.
149 AcpiTbOverrideTable (NewTableDesc
);
152 AcpiTbInitTableDescriptor (&AcpiGbl_RootTableList
.Tables
[i
],
153 NewTableDesc
->Address
, NewTableDesc
->Flags
, NewTableDesc
->Pointer
);
155 AcpiTbPrintTableHeader (NewTableDesc
->Address
, NewTableDesc
->Pointer
);
157 /* This synchronizes AcpiGbl_DsdtIndex */
161 /* Set the global integer width (based upon revision of the DSDT) */
163 if (i
== AcpiGbl_DsdtIndex
)
165 AcpiUtSetIntegerWidth (NewTableDesc
->Pointer
->Revision
);
170 /*******************************************************************************
172 * FUNCTION: AcpiTbInstallFixedTable
174 * PARAMETERS: Address - Physical address of DSDT or FACS
175 * Signature - Table signature, NULL if no need to
177 * TableIndex - Where the table index is returned
181 * DESCRIPTION: Install a fixed ACPI table (DSDT/FACS) into the global data
184 ******************************************************************************/
187 AcpiTbInstallFixedTable (
188 ACPI_PHYSICAL_ADDRESS Address
,
192 ACPI_TABLE_DESC NewTableDesc
;
196 ACPI_FUNCTION_TRACE (TbInstallFixedTable
);
201 ACPI_ERROR ((AE_INFO
, "Null physical address for ACPI table [%s]",
203 return (AE_NO_MEMORY
);
206 /* Fill a table descriptor for validation */
208 Status
= AcpiTbAcquireTempTable (&NewTableDesc
, Address
,
209 ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL
);
210 if (ACPI_FAILURE (Status
))
212 ACPI_ERROR ((AE_INFO
, "Could not acquire table length at %8.8X%8.8X",
213 ACPI_FORMAT_UINT64 (Address
)));
214 return_ACPI_STATUS (Status
);
217 /* Validate and verify a table before installation */
219 Status
= AcpiTbVerifyTempTable (&NewTableDesc
, Signature
);
220 if (ACPI_FAILURE (Status
))
225 /* Add the table to the global root table list */
227 AcpiTbInstallTableWithOverride (&NewTableDesc
, TRUE
, TableIndex
);
231 /* Release the temporary table descriptor */
233 AcpiTbReleaseTempTable (&NewTableDesc
);
234 return_ACPI_STATUS (Status
);
238 /*******************************************************************************
240 * FUNCTION: AcpiTbInstallStandardTable
242 * PARAMETERS: Address - Address of the table (might be a virtual
243 * address depending on the TableFlags)
244 * Flags - Flags for the table
245 * Reload - Whether reload should be performed
246 * Override - Whether override should be performed
247 * TableIndex - Where the table index is returned
251 * DESCRIPTION: This function is called to install an ACPI table that is
252 * neither DSDT nor FACS (a "standard" table.)
253 * When this function is called by "Load" or "LoadTable" opcodes,
254 * or by AcpiLoadTable() API, the "Reload" parameter is set.
255 * After sucessfully returning from this function, table is
256 * "INSTALLED" but not "VALIDATED".
258 ******************************************************************************/
261 AcpiTbInstallStandardTable (
262 ACPI_PHYSICAL_ADDRESS Address
,
269 ACPI_STATUS Status
= AE_OK
;
270 ACPI_TABLE_DESC NewTableDesc
;
273 ACPI_FUNCTION_TRACE (TbInstallStandardTable
);
276 /* Acquire a temporary table descriptor for validation */
278 Status
= AcpiTbAcquireTempTable (&NewTableDesc
, Address
, Flags
);
279 if (ACPI_FAILURE (Status
))
281 ACPI_ERROR ((AE_INFO
,
282 "Could not acquire table length at %8.8X%8.8X",
283 ACPI_FORMAT_UINT64 (Address
)));
284 return_ACPI_STATUS (Status
);
288 * Optionally do not load any SSDTs from the RSDT/XSDT. This can
289 * be useful for debugging ACPI problems on some machines.
292 AcpiGbl_DisableSsdtTableInstall
&&
293 ACPI_COMPARE_NAME (&NewTableDesc
.Signature
, ACPI_SIG_SSDT
))
296 "Ignoring installation of %4.4s at %8.8X%8.8X",
297 NewTableDesc
.Signature
.Ascii
, ACPI_FORMAT_UINT64 (Address
)));
301 /* Validate and verify a table before installation */
303 Status
= AcpiTbVerifyTempTable (&NewTableDesc
, NULL
);
304 if (ACPI_FAILURE (Status
))
312 * Validate the incoming table signature.
314 * 1) Originally, we checked the table signature for "SSDT" or "PSDT".
315 * 2) We added support for OEMx tables, signature "OEM".
316 * 3) Valid tables were encountered with a null signature, so we just
317 * gave up on validating the signature, (05/2008).
318 * 4) We encountered non-AML tables such as the MADT, which caused
319 * interpreter errors and kernel faults. So now, we once again allow
320 * only "SSDT", "OEMx", and now, also a null signature. (05/2011).
322 if ((NewTableDesc
.Signature
.Ascii
[0] != 0x00) &&
323 (!ACPI_COMPARE_NAME (&NewTableDesc
.Signature
, ACPI_SIG_SSDT
)) &&
324 (strncmp (NewTableDesc
.Signature
.Ascii
, "OEM", 3)))
326 ACPI_BIOS_ERROR ((AE_INFO
,
327 "Table has invalid signature [%4.4s] (0x%8.8X), "
328 "must be SSDT or OEMx",
329 AcpiUtValidAcpiName (NewTableDesc
.Signature
.Ascii
) ?
330 NewTableDesc
.Signature
.Ascii
: "????",
331 NewTableDesc
.Signature
.Integer
));
333 Status
= AE_BAD_SIGNATURE
;
337 /* Check if table is already registered */
339 for (i
= 0; i
< AcpiGbl_RootTableList
.CurrentTableCount
; ++i
)
342 * Check for a table match on the entire table length,
343 * not just the header.
345 if (!AcpiTbCompareTables (&NewTableDesc
, i
))
351 * Note: the current mechanism does not unregister a table if it is
352 * dynamically unloaded. The related namespace entries are deleted,
353 * but the table remains in the root table list.
355 * The assumption here is that the number of different tables that
356 * will be loaded is actually small, and there is minimal overhead
357 * in just keeping the table in case it is needed again.
359 * If this assumption changes in the future (perhaps on large
360 * machines with many table load/unload operations), tables will
361 * need to be unregistered when they are unloaded, and slots in the
362 * root table list should be reused when empty.
364 if (AcpiGbl_RootTableList
.Tables
[i
].Flags
&
365 ACPI_TABLE_IS_LOADED
)
367 /* Table is still loaded, this is an error */
369 Status
= AE_ALREADY_EXISTS
;
375 * Table was unloaded, allow it to be reloaded.
376 * As we are going to return AE_OK to the caller, we should
377 * take the responsibility of freeing the input descriptor.
378 * Refill the input descriptor to ensure
379 * AcpiTbInstallTableWithOverride() can be called again to
380 * indicate the re-installation.
382 AcpiTbUninstallTable (&NewTableDesc
);
384 return_ACPI_STATUS (AE_OK
);
389 /* Add the table to the global root table list */
391 AcpiTbInstallTableWithOverride (&NewTableDesc
, Override
, TableIndex
);
395 /* Release the temporary table descriptor */
397 AcpiTbReleaseTempTable (&NewTableDesc
);
398 return_ACPI_STATUS (Status
);
402 /*******************************************************************************
404 * FUNCTION: AcpiTbOverrideTable
406 * PARAMETERS: OldTableDesc - Validated table descriptor to be
411 * DESCRIPTION: Attempt table override by calling the OSL override functions.
412 * Note: If the table is overridden, then the entire new table
413 * is acquired and returned by this function.
414 * Before/after invocation, the table descriptor is in a state
415 * that is "VALIDATED".
417 ******************************************************************************/
420 AcpiTbOverrideTable (
421 ACPI_TABLE_DESC
*OldTableDesc
)
425 ACPI_TABLE_DESC NewTableDesc
;
426 ACPI_TABLE_HEADER
*Table
;
427 ACPI_PHYSICAL_ADDRESS Address
;
431 /* (1) Attempt logical override (returns a logical address) */
433 Status
= AcpiOsTableOverride (OldTableDesc
->Pointer
, &Table
);
434 if (ACPI_SUCCESS (Status
) && Table
)
436 AcpiTbAcquireTempTable (&NewTableDesc
, ACPI_PTR_TO_PHYSADDR (Table
),
437 ACPI_TABLE_ORIGIN_EXTERNAL_VIRTUAL
);
438 OverrideType
= "Logical";
442 /* (2) Attempt physical override (returns a physical address) */
444 Status
= AcpiOsPhysicalTableOverride (OldTableDesc
->Pointer
,
446 if (ACPI_SUCCESS (Status
) && Address
&& Length
)
448 AcpiTbAcquireTempTable (&NewTableDesc
, Address
,
449 ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL
);
450 OverrideType
= "Physical";
454 return; /* There was no override */
459 /* Validate and verify a table before overriding */
461 Status
= AcpiTbVerifyTempTable (&NewTableDesc
, NULL
);
462 if (ACPI_FAILURE (Status
))
467 ACPI_INFO ((AE_INFO
, "%4.4s 0x%8.8X%8.8X"
468 " %s table override, new table: 0x%8.8X%8.8X",
469 OldTableDesc
->Signature
.Ascii
,
470 ACPI_FORMAT_UINT64 (OldTableDesc
->Address
),
471 OverrideType
, ACPI_FORMAT_UINT64 (NewTableDesc
.Address
)));
473 /* We can now uninstall the original table */
475 AcpiTbUninstallTable (OldTableDesc
);
478 * Replace the original table descriptor and keep its state as
481 AcpiTbInitTableDescriptor (OldTableDesc
, NewTableDesc
.Address
,
482 NewTableDesc
.Flags
, NewTableDesc
.Pointer
);
483 AcpiTbValidateTempTable (OldTableDesc
);
485 /* Release the temporary table descriptor */
487 AcpiTbReleaseTempTable (&NewTableDesc
);
491 /*******************************************************************************
493 * FUNCTION: AcpiTbUninstallTable
495 * PARAMETERS: TableDesc - Table descriptor
499 * DESCRIPTION: Delete one internal ACPI table
501 ******************************************************************************/
504 AcpiTbUninstallTable (
505 ACPI_TABLE_DESC
*TableDesc
)
508 ACPI_FUNCTION_TRACE (TbUninstallTable
);
511 /* Table must be installed */
513 if (!TableDesc
->Address
)
518 AcpiTbInvalidateTable (TableDesc
);
520 if ((TableDesc
->Flags
& ACPI_TABLE_ORIGIN_MASK
) ==
521 ACPI_TABLE_ORIGIN_INTERNAL_VIRTUAL
)
523 ACPI_FREE (ACPI_PHYSADDR_TO_PTR (TableDesc
->Address
));
526 TableDesc
->Address
= ACPI_PTR_TO_PHYSADDR (NULL
);