1 /******************************************************************************
3 * Module Name: aetables - ACPI table setup/install for acpiexec utility
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2016, 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.
47 #define _COMPONENT ACPI_TOOLS
48 ACPI_MODULE_NAME ("aetables")
50 /* Local prototypes */
53 AeInitializeTableHeader (
54 ACPI_TABLE_HEADER *Header,
60 ACPI_TABLE_HEADER *ExistingTable,
61 ACPI_TABLE_HEADER **NewTable);
63 /* User table (DSDT) */
65 static ACPI_TABLE_HEADER *DsdtToInstallOverride;
67 /* Non-AML tables that are constructed locally and installed */
69 static ACPI_TABLE_RSDP LocalRSDP;
70 static ACPI_TABLE_FACS LocalFACS;
71 static ACPI_TABLE_HEADER LocalTEST;
72 static ACPI_TABLE_HEADER LocalBADTABLE;
75 * We need a local FADT so that the hardware subcomponent will function,
76 * even though the underlying OSD HW access functions don't do anything.
78 static ACPI_TABLE_FADT LocalFADT;
81 * Use XSDT so that both 32- and 64-bit versions of this utility will
82 * function automatically.
84 static ACPI_TABLE_XSDT *LocalXSDT;
86 #define BASE_XSDT_TABLES 9
87 #define BASE_XSDT_SIZE ((BASE_XSDT_TABLES) * sizeof (UINT64))
89 #define ACPI_MAX_INIT_TABLES (32)
92 /******************************************************************************
94 * FUNCTION: AeTableOverride
96 * DESCRIPTION: Local implementation of AcpiOsTableOverride.
97 * Exercise the override mechanism
99 *****************************************************************************/
103 ACPI_TABLE_HEADER *ExistingTable,
104 ACPI_TABLE_HEADER **NewTable)
107 if (!AcpiGbl_LoadTestTables)
113 /* This code exercises the table override mechanism in the core */
115 if (ACPI_COMPARE_NAME (ExistingTable->Signature, ACPI_SIG_DSDT))
117 *NewTable = DsdtToInstallOverride;
120 /* This code tests override of dynamically loaded tables */
122 else if (ACPI_COMPARE_NAME (ExistingTable->Signature, "OEM9"))
124 *NewTable = ACPI_CAST_PTR (ACPI_TABLE_HEADER, Ssdt3Code);
129 /******************************************************************************
131 * FUNCTION: AeInitializeTableHeader
133 * PARAMETERS: Header - A valid standard ACPI table header
134 * Signature - Signature to insert
135 * Length - Length of the table
137 * RETURN: None. Header is modified.
139 * DESCRIPTION: Initialize the table header for a local ACPI table.
141 *****************************************************************************/
144 AeInitializeTableHeader (
145 ACPI_TABLE_HEADER *Header,
150 ACPI_MOVE_NAME (Header->Signature, Signature);
151 Header->Length = Length;
153 Header->OemRevision = 0x1001;
154 strncpy (Header->OemId, "Intel", ACPI_OEM_ID_SIZE);
155 strncpy (Header->OemTableId, "AcpiExec", ACPI_OEM_TABLE_ID_SIZE);
156 strncpy (Header->AslCompilerId, "INTL", ACPI_NAME_SIZE);
157 Header->AslCompilerRevision = ACPI_CA_VERSION;
159 /* Set the checksum, must set to zero first */
161 Header->Checksum = 0;
162 Header->Checksum = (UINT8) -AcpiTbChecksum (
163 (void *) Header, Header->Length);
167 /******************************************************************************
169 * FUNCTION: AeBuildLocalTables
171 * PARAMETERS: TableCount - Number of tables on the command line
172 * ListHead - List of actual tables from files
176 * DESCRIPTION: Build a complete ACPI table chain, with a local RSDP, XSDT,
177 * FADT, and several other test tables.
179 *****************************************************************************/
183 ACPI_NEW_TABLE_DESC *ListHead)
185 UINT32 TableCount = 1;
186 ACPI_PHYSICAL_ADDRESS DsdtAddress = 0;
188 ACPI_NEW_TABLE_DESC *NextTable;
190 ACPI_TABLE_FADT *ExternalFadt = NULL;
194 * Update the table count. For the DSDT, it is not put into the XSDT.
195 * For the FADT, this table is already accounted for since we usually
196 * install a local FADT.
198 NextTable = ListHead;
201 if (!ACPI_COMPARE_NAME (NextTable->Table->Signature, ACPI_SIG_DSDT) &&
202 !ACPI_COMPARE_NAME (NextTable->Table->Signature, ACPI_SIG_FADT))
207 NextTable = NextTable->Next;
210 XsdtSize = (((TableCount + 1) * sizeof (UINT64)) +
211 sizeof (ACPI_TABLE_HEADER));
212 if (AcpiGbl_LoadTestTables)
214 XsdtSize += BASE_XSDT_SIZE;
219 LocalXSDT = AcpiOsAllocate (XsdtSize);
222 return (AE_NO_MEMORY);
225 memset (LocalXSDT, 0, XsdtSize);
226 LocalXSDT->TableOffsetEntry[0] = ACPI_PTR_TO_PHYSADDR (&LocalFADT);
230 * Install the user tables. The DSDT must be installed in the FADT.
231 * All other tables are installed directly into the XSDT.
233 NextTable = ListHead;
237 * Incoming DSDT or FADT are special cases. All other tables are
238 * just immediately installed into the XSDT.
240 if (ACPI_COMPARE_NAME (NextTable->Table->Signature, ACPI_SIG_DSDT))
244 printf ("Already found a DSDT, only one allowed\n");
245 return (AE_ALREADY_EXISTS);
248 /* The incoming user table is a DSDT */
250 DsdtAddress = ACPI_PTR_TO_PHYSADDR (NextTable->Table);
251 DsdtToInstallOverride = NextTable->Table;
253 else if (ACPI_COMPARE_NAME (NextTable->Table->Signature, ACPI_SIG_FADT))
255 ExternalFadt = ACPI_CAST_PTR (ACPI_TABLE_FADT, NextTable->Table);
256 LocalXSDT->TableOffsetEntry[0] = ACPI_PTR_TO_PHYSADDR (NextTable->Table);
260 /* Install the table in the XSDT */
262 LocalXSDT->TableOffsetEntry[NextIndex] =
263 ACPI_PTR_TO_PHYSADDR (NextTable->Table);
267 NextTable = NextTable->Next;
270 /* Install the optional extra local tables */
272 if (AcpiGbl_LoadTestTables)
274 LocalXSDT->TableOffsetEntry[NextIndex++] = ACPI_PTR_TO_PHYSADDR (&LocalTEST);
275 LocalXSDT->TableOffsetEntry[NextIndex++] = ACPI_PTR_TO_PHYSADDR (&LocalBADTABLE);
277 /* Install two SSDTs to test multiple table support */
279 LocalXSDT->TableOffsetEntry[NextIndex++] = ACPI_PTR_TO_PHYSADDR (&Ssdt1Code);
280 LocalXSDT->TableOffsetEntry[NextIndex++] = ACPI_PTR_TO_PHYSADDR (&Ssdt2Code);
282 /* Install the OEM1 table to test LoadTable */
284 LocalXSDT->TableOffsetEntry[NextIndex++] = ACPI_PTR_TO_PHYSADDR (&Oem1Code);
286 /* Install the OEMx table to test LoadTable */
288 LocalXSDT->TableOffsetEntry[NextIndex++] = ACPI_PTR_TO_PHYSADDR (&OemxCode);
290 /* Install the ECDT table to test _REG */
292 LocalXSDT->TableOffsetEntry[NextIndex++] = ACPI_PTR_TO_PHYSADDR (&EcdtCode);
294 /* Install two UEFIs to test multiple table support */
296 LocalXSDT->TableOffsetEntry[NextIndex++] = ACPI_PTR_TO_PHYSADDR (&Uefi1Code);
297 LocalXSDT->TableOffsetEntry[NextIndex++] = ACPI_PTR_TO_PHYSADDR (&Uefi2Code);
300 /* Build an RSDP. Contains a valid XSDT only, no RSDT */
302 memset (&LocalRSDP, 0, sizeof (ACPI_TABLE_RSDP));
303 ACPI_MAKE_RSDP_SIG (LocalRSDP.Signature);
304 memcpy (LocalRSDP.OemId, "Intel", 6);
306 LocalRSDP.Revision = 2;
307 LocalRSDP.XsdtPhysicalAddress = ACPI_PTR_TO_PHYSADDR (LocalXSDT);
308 LocalRSDP.Length = sizeof (ACPI_TABLE_RSDP);
310 /* Set checksums for both XSDT and RSDP */
312 AeInitializeTableHeader ((void *) LocalXSDT, ACPI_SIG_XSDT, XsdtSize);
314 LocalRSDP.Checksum = 0;
315 LocalRSDP.Checksum = (UINT8) -AcpiTbChecksum (
316 (void *) &LocalRSDP, ACPI_RSDP_CHECKSUM_LENGTH);
320 /* Use the local DSDT because incoming table(s) are all SSDT(s) */
322 DsdtAddress = ACPI_PTR_TO_PHYSADDR (LocalDsdtCode);
323 DsdtToInstallOverride = ACPI_CAST_PTR (ACPI_TABLE_HEADER, LocalDsdtCode);
327 * Build an FADT. There are three options for the FADT:
328 * 1) Incoming external FADT specified on the command line
329 * 2) A "hardware reduced" local FADT
330 * 3) A fully featured local FADT
332 memset (&LocalFADT, 0, sizeof (ACPI_TABLE_FADT));
337 * Use the external FADT, but we must update the DSDT/FACS
338 * addresses as well as the checksum
340 ExternalFadt->Dsdt = (UINT32) DsdtAddress;
341 if (!AcpiGbl_ReducedHardware)
343 ExternalFadt->Facs = ACPI_PTR_TO_PHYSADDR (&LocalFACS);
347 * If there room in the FADT for the XDsdt and XFacs 64-bit
348 * pointers, use them.
350 if (ExternalFadt->Header.Length > ACPI_PTR_DIFF (
351 &ExternalFadt->XDsdt, ExternalFadt))
353 ExternalFadt->Dsdt = 0;
354 ExternalFadt->Facs = 0;
356 ExternalFadt->XDsdt = DsdtAddress;
357 if (!AcpiGbl_ReducedHardware)
359 ExternalFadt->XFacs = ACPI_PTR_TO_PHYSADDR (&LocalFACS);
363 /* Complete the external FADT with the checksum */
365 ExternalFadt->Header.Checksum = 0;
366 ExternalFadt->Header.Checksum = (UINT8) -AcpiTbChecksum (
367 (void *) ExternalFadt, ExternalFadt->Header.Length);
369 else if (AcpiGbl_UseHwReducedFadt)
371 memcpy (&LocalFADT, HwReducedFadtCode, ACPI_FADT_V5_SIZE);
373 LocalFADT.XDsdt = DsdtAddress;
378 * Build a local FADT so we can test the hardware/event init
380 LocalFADT.Header.Revision = 5;
382 /* Setup FADT header and DSDT/FACS addresses */
387 LocalFADT.XDsdt = DsdtAddress;
388 LocalFADT.XFacs = ACPI_PTR_TO_PHYSADDR (&LocalFACS);
390 /* Miscellaneous FADT fields */
392 LocalFADT.Gpe0BlockLength = 0x08;
393 LocalFADT.Gpe0Block = 0x00001234;
395 LocalFADT.Gpe1BlockLength = 0x80;
396 LocalFADT.Gpe1Block = 0x00005678;
397 LocalFADT.Gpe1Base = 100;
399 LocalFADT.Pm1EventLength = 4;
400 LocalFADT.Pm1aEventBlock = 0x00001aaa;
401 LocalFADT.Pm1bEventBlock = 0x00001bbb;
403 LocalFADT.Pm1ControlLength = 2;
404 LocalFADT.Pm1aControlBlock = 0xB0;
406 LocalFADT.PmTimerLength = 4;
407 LocalFADT.PmTimerBlock = 0xA0;
409 LocalFADT.Pm2ControlBlock = 0xC0;
410 LocalFADT.Pm2ControlLength = 1;
412 /* Setup one example X-64 GAS field */
414 LocalFADT.XPm1bEventBlock.SpaceId = ACPI_ADR_SPACE_SYSTEM_IO;
415 LocalFADT.XPm1bEventBlock.Address = LocalFADT.Pm1bEventBlock;
416 LocalFADT.XPm1bEventBlock.BitWidth = (UINT8)
417 ACPI_MUL_8 (LocalFADT.Pm1EventLength);
420 AeInitializeTableHeader ((void *) &LocalFADT,
421 ACPI_SIG_FADT, sizeof (ACPI_TABLE_FADT));
425 memset (&LocalFACS, 0, sizeof (ACPI_TABLE_FACS));
426 ACPI_MOVE_NAME (LocalFACS.Signature, ACPI_SIG_FACS);
428 LocalFACS.Length = sizeof (ACPI_TABLE_FACS);
429 LocalFACS.GlobalLock = 0x11AA0011;
431 /* Build the optional local tables */
433 if (AcpiGbl_LoadTestTables)
436 * Build a fake table [TEST] so that we make sure that the
437 * ACPICA core ignores it
439 memset (&LocalTEST, 0, sizeof (ACPI_TABLE_HEADER));
440 ACPI_MOVE_NAME (LocalTEST.Signature, "TEST");
442 LocalTEST.Revision = 1;
443 LocalTEST.Length = sizeof (ACPI_TABLE_HEADER);
445 LocalTEST.Checksum = 0;
446 LocalTEST.Checksum = (UINT8) -AcpiTbChecksum (
447 (void *) &LocalTEST, LocalTEST.Length);
450 * Build a fake table with a bad signature [BAD!] so that we make
451 * sure that the ACPICA core ignores it
453 memset (&LocalBADTABLE, 0, sizeof (ACPI_TABLE_HEADER));
454 ACPI_MOVE_NAME (LocalBADTABLE.Signature, "BAD!");
456 LocalBADTABLE.Revision = 1;
457 LocalBADTABLE.Length = sizeof (ACPI_TABLE_HEADER);
459 LocalBADTABLE.Checksum = 0;
460 LocalBADTABLE.Checksum = (UINT8) -AcpiTbChecksum (
461 (void *) &LocalBADTABLE, LocalBADTABLE.Length);
468 /******************************************************************************
470 * FUNCTION: AeInstallTables
476 * DESCRIPTION: Install the various ACPI tables
478 *****************************************************************************/
485 ACPI_TABLE_HEADER Header;
486 ACPI_TABLE_HEADER *Table;
490 Status = AcpiInitializeTables (NULL, ACPI_MAX_INIT_TABLES, TRUE);
491 ACPI_CHECK_OK (AcpiInitializeTables, Status);
493 if (AcpiGbl_LoadTestTables)
495 /* Test multiple table/UEFI support. First, get the headers */
497 Status = AcpiGetTableHeader (ACPI_SIG_UEFI, 1, &Header);
498 ACPI_CHECK_OK (AcpiGetTableHeader, Status);
500 Status = AcpiGetTableHeader (ACPI_SIG_UEFI, 2, &Header);
501 ACPI_CHECK_OK (AcpiGetTableHeader, Status);
503 Status = AcpiGetTableHeader (ACPI_SIG_UEFI, 3, &Header);
504 ACPI_CHECK_STATUS (AcpiGetTableHeader, Status, AE_NOT_FOUND);
506 /* Now get the actual tables */
508 Status = AcpiGetTable (ACPI_SIG_UEFI, 1, &Table);
509 ACPI_CHECK_OK (AcpiGetTable, Status);
511 Status = AcpiGetTable (ACPI_SIG_UEFI, 2, &Table);
512 ACPI_CHECK_OK (AcpiGetTable, Status);
514 Status = AcpiGetTable (ACPI_SIG_UEFI, 3, &Table);
515 ACPI_CHECK_STATUS (AcpiGetTable, Status, AE_NOT_FOUND);
518 /* Check that we can get all of the ACPI tables */
522 Status = AcpiGetTableByIndex (i, &Table);
523 if ((Status == AE_BAD_PARAMETER) || !Table)
528 ACPI_CHECK_OK (AcpiGetTableByIndex, Status);
535 /******************************************************************************
537 * FUNCTION: AeLoadTables
543 * DESCRIPTION: Load the definition block ACPI tables
545 *****************************************************************************/
554 Status = AcpiLoadTables ();
555 ACPI_CHECK_OK (AcpiLoadTables, Status);
558 * Test run-time control method installation. Do it twice to test code
559 * for an existing name.
561 Status = AcpiInstallMethod (MethodCode);
562 if (ACPI_FAILURE (Status))
564 AcpiOsPrintf ("%s, Could not install method\n",
565 AcpiFormatException (Status));
568 Status = AcpiInstallMethod (MethodCode);
569 if (ACPI_FAILURE (Status))
571 AcpiOsPrintf ("%s, Could not install method\n",
572 AcpiFormatException (Status));
579 /******************************************************************************
581 * FUNCTION: AcpiOsGetRootPointer
583 * PARAMETERS: Flags - not used
584 * Address - Where the root pointer is returned
588 * DESCRIPTION: Return a local RSDP, used to dynamically load tables via the
589 * standard ACPI mechanism.
591 *****************************************************************************/
593 ACPI_PHYSICAL_ADDRESS
594 AcpiOsGetRootPointer (
598 return (ACPI_PTR_TO_PHYSADDR (&LocalRSDP));