1 /****************************************************************************** 2 * 3 * Module Name: aetables - ACPI table setup/install for acpiexec utility 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2015, 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 "aecommon.h" 45 #include "aetables.h" 46 47 #define _COMPONENT ACPI_TOOLS 48 ACPI_MODULE_NAME ("aetables") 49 50 /* Local prototypes */ 51 52 static void 53 AeInitializeTableHeader ( 54 ACPI_TABLE_HEADER *Header, 55 char *Signature, 56 UINT32 Length); 57 58 void 59 AeTableOverride ( 60 ACPI_TABLE_HEADER *ExistingTable, 61 ACPI_TABLE_HEADER **NewTable); 62 63 /* User table (DSDT) */ 64 65 static ACPI_TABLE_HEADER *DsdtToInstallOverride; 66 67 /* Non-AML tables that are constructed locally and installed */ 68 69 static ACPI_TABLE_RSDP LocalRSDP; 70 static ACPI_TABLE_FACS LocalFACS; 71 static ACPI_TABLE_HEADER LocalTEST; 72 static ACPI_TABLE_HEADER LocalBADTABLE; 73 74 /* 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. 77 */ 78 static ACPI_TABLE_FADT LocalFADT; 79 80 /* 81 * Use XSDT so that both 32- and 64-bit versions of this utility will 82 * function automatically. 83 */ 84 static ACPI_TABLE_XSDT *LocalXSDT; 85 86 #define BASE_XSDT_TABLES 9 87 #define BASE_XSDT_SIZE ((BASE_XSDT_TABLES) * sizeof (UINT64)) 88 89 #define ACPI_MAX_INIT_TABLES (32) 90 91 92 /****************************************************************************** 93 * 94 * FUNCTION: AeTableOverride 95 * 96 * DESCRIPTION: Local implementation of AcpiOsTableOverride. 97 * Exercise the override mechanism 98 * 99 *****************************************************************************/ 100 101 void 102 AeTableOverride ( 103 ACPI_TABLE_HEADER *ExistingTable, 104 ACPI_TABLE_HEADER **NewTable) 105 { 106 107 if (!AcpiGbl_LoadTestTables) 108 { 109 *NewTable = NULL; 110 return; 111 } 112 113 /* This code exercises the table override mechanism in the core */ 114 115 if (ACPI_COMPARE_NAME (ExistingTable->Signature, ACPI_SIG_DSDT)) 116 { 117 *NewTable = DsdtToInstallOverride; 118 } 119 120 /* This code tests override of dynamically loaded tables */ 121 122 else if (ACPI_COMPARE_NAME (ExistingTable->Signature, "OEM9")) 123 { 124 *NewTable = ACPI_CAST_PTR (ACPI_TABLE_HEADER, Ssdt3Code); 125 } 126 } 127 128 129 /****************************************************************************** 130 * 131 * FUNCTION: AeInitializeTableHeader 132 * 133 * PARAMETERS: Header - A valid standard ACPI table header 134 * Signature - Signature to insert 135 * Length - Length of the table 136 * 137 * RETURN: None. Header is modified. 138 * 139 * DESCRIPTION: Initialize the table header for a local ACPI table. 140 * 141 *****************************************************************************/ 142 143 static void 144 AeInitializeTableHeader ( 145 ACPI_TABLE_HEADER *Header, 146 char *Signature, 147 UINT32 Length) 148 { 149 150 ACPI_MOVE_NAME (Header->Signature, Signature); 151 Header->Length = Length; 152 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; 158 159 /* Set the checksum, must set to zero first */ 160 161 Header->Checksum = 0; 162 Header->Checksum = (UINT8) -AcpiTbChecksum ( 163 (void *) Header, Header->Length); 164 } 165 166 167 /****************************************************************************** 168 * 169 * FUNCTION: AeBuildLocalTables 170 * 171 * PARAMETERS: TableCount - Number of tables on the command line 172 * TableList - List of actual tables from files 173 * 174 * RETURN: Status 175 * 176 * DESCRIPTION: Build a complete ACPI table chain, with a local RSDP, XSDT, 177 * FADT, and several other test tables. 178 * 179 *****************************************************************************/ 180 181 ACPI_STATUS 182 AeBuildLocalTables ( 183 UINT32 TableCount, 184 AE_TABLE_DESC *TableList) 185 { 186 ACPI_PHYSICAL_ADDRESS DsdtAddress = 0; 187 UINT32 XsdtSize; 188 AE_TABLE_DESC *NextTable; 189 UINT32 NextIndex; 190 ACPI_TABLE_FADT *ExternalFadt = NULL; 191 192 193 /* 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. 197 */ 198 NextTable = TableList; 199 while (NextTable) 200 { 201 if (ACPI_COMPARE_NAME (NextTable->Table->Signature, ACPI_SIG_DSDT) || 202 ACPI_COMPARE_NAME (NextTable->Table->Signature, ACPI_SIG_FADT)) 203 { 204 TableCount--; 205 } 206 NextTable = NextTable->Next; 207 } 208 209 XsdtSize = (((TableCount + 1) * sizeof (UINT64)) + sizeof (ACPI_TABLE_HEADER)); 210 if (AcpiGbl_LoadTestTables) 211 { 212 XsdtSize += BASE_XSDT_SIZE; 213 } 214 215 /* Build an XSDT */ 216 217 LocalXSDT = AcpiOsAllocate (XsdtSize); 218 if (!LocalXSDT) 219 { 220 return (AE_NO_MEMORY); 221 } 222 223 memset (LocalXSDT, 0, XsdtSize); 224 LocalXSDT->TableOffsetEntry[0] = ACPI_PTR_TO_PHYSADDR (&LocalFADT); 225 NextIndex = 1; 226 227 /* 228 * Install the user tables. The DSDT must be installed in the FADT. 229 * All other tables are installed directly into the XSDT. 230 * 231 * Note: The tables are loaded in reverse order from the incoming 232 * input, which makes it match the command line order. 233 */ 234 NextTable = TableList; 235 while (NextTable) 236 { 237 /* 238 * Incoming DSDT or FADT are special cases. All other tables are 239 * just immediately installed into the XSDT. 240 */ 241 if (ACPI_COMPARE_NAME (NextTable->Table->Signature, ACPI_SIG_DSDT)) 242 { 243 if (DsdtAddress) 244 { 245 printf ("Already found a DSDT, only one allowed\n"); 246 return (AE_ALREADY_EXISTS); 247 } 248 249 /* The incoming user table is a DSDT */ 250 251 DsdtAddress = ACPI_PTR_TO_PHYSADDR (NextTable->Table); 252 DsdtToInstallOverride = NextTable->Table; 253 } 254 else if (ACPI_COMPARE_NAME (NextTable->Table->Signature, ACPI_SIG_FADT)) 255 { 256 ExternalFadt = ACPI_CAST_PTR (ACPI_TABLE_FADT, NextTable->Table); 257 LocalXSDT->TableOffsetEntry[0] = ACPI_PTR_TO_PHYSADDR (NextTable->Table); 258 } 259 else 260 { 261 /* Install the table in the XSDT */ 262 263 LocalXSDT->TableOffsetEntry[TableCount - NextIndex + 1] = 264 ACPI_PTR_TO_PHYSADDR (NextTable->Table); 265 NextIndex++; 266 } 267 268 NextTable = NextTable->Next; 269 } 270 271 /* Install the optional extra local tables */ 272 273 if (AcpiGbl_LoadTestTables) 274 { 275 LocalXSDT->TableOffsetEntry[NextIndex++] = ACPI_PTR_TO_PHYSADDR (&LocalTEST); 276 LocalXSDT->TableOffsetEntry[NextIndex++] = ACPI_PTR_TO_PHYSADDR (&LocalBADTABLE); 277 278 /* Install two SSDTs to test multiple table support */ 279 280 LocalXSDT->TableOffsetEntry[NextIndex++] = ACPI_PTR_TO_PHYSADDR (&Ssdt1Code); 281 LocalXSDT->TableOffsetEntry[NextIndex++] = ACPI_PTR_TO_PHYSADDR (&Ssdt2Code); 282 283 /* Install the OEM1 table to test LoadTable */ 284 285 LocalXSDT->TableOffsetEntry[NextIndex++] = ACPI_PTR_TO_PHYSADDR (&Oem1Code); 286 287 /* Install the OEMx table to test LoadTable */ 288 289 LocalXSDT->TableOffsetEntry[NextIndex++] = ACPI_PTR_TO_PHYSADDR (&OemxCode); 290 291 /* Install the ECDT table to test _REG */ 292 293 LocalXSDT->TableOffsetEntry[NextIndex++] = ACPI_PTR_TO_PHYSADDR (&EcdtCode); 294 295 /* Install two UEFIs to test multiple table support */ 296 297 LocalXSDT->TableOffsetEntry[NextIndex++] = ACPI_PTR_TO_PHYSADDR (&Uefi1Code); 298 LocalXSDT->TableOffsetEntry[NextIndex++] = ACPI_PTR_TO_PHYSADDR (&Uefi2Code); 299 } 300 301 /* Build an RSDP. Contains a valid XSDT only, no RSDT */ 302 303 memset (&LocalRSDP, 0, sizeof (ACPI_TABLE_RSDP)); 304 ACPI_MAKE_RSDP_SIG (LocalRSDP.Signature); 305 memcpy (LocalRSDP.OemId, "Intel", 6); 306 307 LocalRSDP.Revision = 2; 308 LocalRSDP.XsdtPhysicalAddress = ACPI_PTR_TO_PHYSADDR (LocalXSDT); 309 LocalRSDP.Length = sizeof (ACPI_TABLE_RSDP); 310 311 /* Set checksums for both XSDT and RSDP */ 312 313 AeInitializeTableHeader ((void *) LocalXSDT, ACPI_SIG_XSDT, XsdtSize); 314 315 LocalRSDP.Checksum = 0; 316 LocalRSDP.Checksum = (UINT8) -AcpiTbChecksum ( 317 (void *) &LocalRSDP, ACPI_RSDP_CHECKSUM_LENGTH); 318 319 if (!DsdtAddress) 320 { 321 /* Use the local DSDT because incoming table(s) are all SSDT(s) */ 322 323 DsdtAddress = ACPI_PTR_TO_PHYSADDR (LocalDsdtCode); 324 DsdtToInstallOverride = ACPI_CAST_PTR (ACPI_TABLE_HEADER, LocalDsdtCode); 325 } 326 327 /* 328 * Build an FADT. There are three options for the FADT: 329 * 1) Incoming external FADT specified on the command line 330 * 2) A "hardware reduced" local FADT 331 * 3) A fully featured local FADT 332 */ 333 memset (&LocalFADT, 0, sizeof (ACPI_TABLE_FADT)); 334 335 if (ExternalFadt) 336 { 337 /* 338 * Use the external FADT, but we must update the DSDT/FACS 339 * addresses as well as the checksum 340 */ 341 ExternalFadt->Dsdt = (UINT32) DsdtAddress; 342 if (!AcpiGbl_ReducedHardware) 343 { 344 ExternalFadt->Facs = ACPI_PTR_TO_PHYSADDR (&LocalFACS); 345 } 346 347 /* 348 * If there room in the FADT for the XDsdt and XFacs 64-bit 349 * pointers, use them. 350 */ 351 if (ExternalFadt->Header.Length > ACPI_PTR_DIFF ( 352 &ExternalFadt->XDsdt, ExternalFadt)) 353 { 354 ExternalFadt->Dsdt = 0; 355 ExternalFadt->Facs = 0; 356 357 ExternalFadt->XDsdt = DsdtAddress; 358 if (!AcpiGbl_ReducedHardware) 359 { 360 ExternalFadt->XFacs = ACPI_PTR_TO_PHYSADDR (&LocalFACS); 361 } 362 } 363 364 /* Complete the external FADT with the checksum */ 365 366 ExternalFadt->Header.Checksum = 0; 367 ExternalFadt->Header.Checksum = (UINT8) -AcpiTbChecksum ( 368 (void *) ExternalFadt, ExternalFadt->Header.Length); 369 } 370 else if (AcpiGbl_UseHwReducedFadt) 371 { 372 memcpy (&LocalFADT, HwReducedFadtCode, ACPI_FADT_V5_SIZE); 373 LocalFADT.Dsdt = 0; 374 LocalFADT.XDsdt = DsdtAddress; 375 } 376 else 377 { 378 /* 379 * Build a local FADT so we can test the hardware/event init 380 */ 381 LocalFADT.Header.Revision = 5; 382 383 /* Setup FADT header and DSDT/FACS addresses */ 384 385 LocalFADT.Dsdt = 0; 386 LocalFADT.Facs = 0; 387 388 LocalFADT.XDsdt = DsdtAddress; 389 LocalFADT.XFacs = ACPI_PTR_TO_PHYSADDR (&LocalFACS); 390 391 /* Miscellaneous FADT fields */ 392 393 LocalFADT.Gpe0BlockLength = 0x08; 394 LocalFADT.Gpe0Block = 0x00001234; 395 396 LocalFADT.Gpe1BlockLength = 0x80; 397 LocalFADT.Gpe1Block = 0x00005678; 398 LocalFADT.Gpe1Base = 100; 399 400 LocalFADT.Pm1EventLength = 4; 401 LocalFADT.Pm1aEventBlock = 0x00001aaa; 402 LocalFADT.Pm1bEventBlock = 0x00001bbb; 403 404 LocalFADT.Pm1ControlLength = 2; 405 LocalFADT.Pm1aControlBlock = 0xB0; 406 407 LocalFADT.PmTimerLength = 4; 408 LocalFADT.PmTimerBlock = 0xA0; 409 410 LocalFADT.Pm2ControlBlock = 0xC0; 411 LocalFADT.Pm2ControlLength = 1; 412 413 /* Setup one example X-64 GAS field */ 414 415 LocalFADT.XPm1bEventBlock.SpaceId = ACPI_ADR_SPACE_SYSTEM_IO; 416 LocalFADT.XPm1bEventBlock.Address = LocalFADT.Pm1bEventBlock; 417 LocalFADT.XPm1bEventBlock.BitWidth = (UINT8) 418 ACPI_MUL_8 (LocalFADT.Pm1EventLength); 419 } 420 421 AeInitializeTableHeader ((void *) &LocalFADT, 422 ACPI_SIG_FADT, sizeof (ACPI_TABLE_FADT)); 423 424 /* Build a FACS */ 425 426 memset (&LocalFACS, 0, sizeof (ACPI_TABLE_FACS)); 427 ACPI_MOVE_NAME (LocalFACS.Signature, ACPI_SIG_FACS); 428 429 LocalFACS.Length = sizeof (ACPI_TABLE_FACS); 430 LocalFACS.GlobalLock = 0x11AA0011; 431 432 /* Build the optional local tables */ 433 434 if (AcpiGbl_LoadTestTables) 435 { 436 /* 437 * Build a fake table [TEST] so that we make sure that the 438 * ACPICA core ignores it 439 */ 440 memset (&LocalTEST, 0, sizeof (ACPI_TABLE_HEADER)); 441 ACPI_MOVE_NAME (LocalTEST.Signature, "TEST"); 442 443 LocalTEST.Revision = 1; 444 LocalTEST.Length = sizeof (ACPI_TABLE_HEADER); 445 446 LocalTEST.Checksum = 0; 447 LocalTEST.Checksum = (UINT8) -AcpiTbChecksum ( 448 (void *) &LocalTEST, LocalTEST.Length); 449 450 /* 451 * Build a fake table with a bad signature [BAD!] so that we make 452 * sure that the ACPICA core ignores it 453 */ 454 memset (&LocalBADTABLE, 0, sizeof (ACPI_TABLE_HEADER)); 455 ACPI_MOVE_NAME (LocalBADTABLE.Signature, "BAD!"); 456 457 LocalBADTABLE.Revision = 1; 458 LocalBADTABLE.Length = sizeof (ACPI_TABLE_HEADER); 459 460 LocalBADTABLE.Checksum = 0; 461 LocalBADTABLE.Checksum = (UINT8) -AcpiTbChecksum ( 462 (void *) &LocalBADTABLE, LocalBADTABLE.Length); 463 } 464 465 return (AE_OK); 466 } 467 468 469 /****************************************************************************** 470 * 471 * FUNCTION: AeInstallTables 472 * 473 * PARAMETERS: None 474 * 475 * RETURN: Status 476 * 477 * DESCRIPTION: Install the various ACPI tables 478 * 479 *****************************************************************************/ 480 481 ACPI_STATUS 482 AeInstallTables ( 483 void) 484 { 485 ACPI_STATUS Status; 486 ACPI_TABLE_HEADER Header; 487 ACPI_TABLE_HEADER *Table; 488 UINT32 i; 489 490 491 Status = AcpiInitializeTables (NULL, ACPI_MAX_INIT_TABLES, TRUE); 492 AE_CHECK_OK (AcpiInitializeTables, Status); 493 494 Status = AcpiLoadTables (); 495 AE_CHECK_OK (AcpiLoadTables, Status); 496 497 /* 498 * Test run-time control method installation. Do it twice to test code 499 * for an existing name. 500 */ 501 Status = AcpiInstallMethod (MethodCode); 502 if (ACPI_FAILURE (Status)) 503 { 504 AcpiOsPrintf ("%s, Could not install method\n", 505 AcpiFormatException (Status)); 506 } 507 508 Status = AcpiInstallMethod (MethodCode); 509 if (ACPI_FAILURE (Status)) 510 { 511 AcpiOsPrintf ("%s, Could not install method\n", 512 AcpiFormatException (Status)); 513 } 514 515 if (AcpiGbl_LoadTestTables) 516 { 517 /* Test multiple table/UEFI support. First, get the headers */ 518 519 Status = AcpiGetTableHeader (ACPI_SIG_UEFI, 1, &Header); 520 AE_CHECK_OK (AcpiGetTableHeader, Status); 521 522 Status = AcpiGetTableHeader (ACPI_SIG_UEFI, 2, &Header); 523 AE_CHECK_OK (AcpiGetTableHeader, Status); 524 525 Status = AcpiGetTableHeader (ACPI_SIG_UEFI, 3, &Header); 526 AE_CHECK_STATUS (AcpiGetTableHeader, Status, AE_NOT_FOUND); 527 528 /* Now get the actual tables */ 529 530 Status = AcpiGetTable (ACPI_SIG_UEFI, 1, &Table); 531 AE_CHECK_OK (AcpiGetTable, Status); 532 533 Status = AcpiGetTable (ACPI_SIG_UEFI, 2, &Table); 534 AE_CHECK_OK (AcpiGetTable, Status); 535 536 Status = AcpiGetTable (ACPI_SIG_UEFI, 3, &Table); 537 AE_CHECK_STATUS (AcpiGetTable, Status, AE_NOT_FOUND); 538 } 539 540 /* Check that we can get all of the ACPI tables */ 541 542 for (i = 0; ; i++) 543 { 544 Status = AcpiGetTableByIndex (i, &Table); 545 if ((Status == AE_BAD_PARAMETER) || !Table) 546 { 547 break; 548 } 549 AE_CHECK_OK (AcpiGetTableByIndex, Status); 550 } 551 552 return (AE_OK); 553 } 554 555 556 /****************************************************************************** 557 * 558 * FUNCTION: AcpiOsGetRootPointer 559 * 560 * PARAMETERS: Flags - not used 561 * Address - Where the root pointer is returned 562 * 563 * RETURN: Status 564 * 565 * DESCRIPTION: Return a local RSDP, used to dynamically load tables via the 566 * standard ACPI mechanism. 567 * 568 *****************************************************************************/ 569 570 ACPI_PHYSICAL_ADDRESS 571 AcpiOsGetRootPointer ( 572 void) 573 { 574 575 return (ACPI_PTR_TO_PHYSADDR (&LocalRSDP)); 576 } 577