nsload.c revision 83174
1/****************************************************************************** 2 * 3 * Module Name: nsload - namespace loading/expanding/contracting procedures 4 * $Revision: 43 $ 5 * 6 *****************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999, 2000, 2001, Intel Corp. 13 * All rights reserved. 14 * 15 * 2. License 16 * 17 * 2.1. This is your license from Intel Corp. under its intellectual property 18 * rights. You may have additional license terms from the party that provided 19 * you this software, covering your right to use that party's intellectual 20 * property rights. 21 * 22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 23 * copy of the source code appearing in this file ("Covered Code") an 24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 25 * base code distributed originally by Intel ("Original Intel Code") to copy, 26 * make derivatives, distribute, use and display any portion of the Covered 27 * Code in any form, with the right to sublicense such rights; and 28 * 29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 30 * license (with the right to sublicense), under only those claims of Intel 31 * patents that are infringed by the Original Intel Code, to make, use, sell, 32 * offer to sell, and import the Covered Code and derivative works thereof 33 * solely to the minimum extent necessary to exercise the above copyright 34 * license, and in no event shall the patent license extend to any additions 35 * to or modifications of the Original Intel Code. No other license or right 36 * is granted directly or by implication, estoppel or otherwise; 37 * 38 * The above copyright and patent license is granted only if the following 39 * conditions are met: 40 * 41 * 3. Conditions 42 * 43 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 44 * Redistribution of source code of any substantial portion of the Covered 45 * Code or modification with rights to further distribute source must include 46 * the above Copyright Notice, the above License, this list of Conditions, 47 * and the following Disclaimer and Export Compliance provision. In addition, 48 * Licensee must cause all Covered Code to which Licensee contributes to 49 * contain a file documenting the changes Licensee made to create that Covered 50 * Code and the date of any change. Licensee must include in that file the 51 * documentation of any changes made by any predecessor Licensee. Licensee 52 * must include a prominent statement that the modification is derived, 53 * directly or indirectly, from Original Intel Code. 54 * 55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 56 * Redistribution of source code of any substantial portion of the Covered 57 * Code or modification without rights to further distribute source must 58 * include the following Disclaimer and Export Compliance provision in the 59 * documentation and/or other materials provided with distribution. In 60 * addition, Licensee may not authorize further sublicense of source of any 61 * portion of the Covered Code, and must include terms to the effect that the 62 * license from Licensee to its licensee is limited to the intellectual 63 * property embodied in the software Licensee provides to its licensee, and 64 * not to intellectual property embodied in modifications its licensee may 65 * make. 66 * 67 * 3.3. Redistribution of Executable. Redistribution in executable form of any 68 * substantial portion of the Covered Code or modification must reproduce the 69 * above Copyright Notice, and the following Disclaimer and Export Compliance 70 * provision in the documentation and/or other materials provided with the 71 * distribution. 72 * 73 * 3.4. Intel retains all right, title, and interest in and to the Original 74 * Intel Code. 75 * 76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 77 * Intel shall be used in advertising or otherwise to promote the sale, use or 78 * other dealings in products derived from or relating to the Covered Code 79 * without prior written authorization from Intel. 80 * 81 * 4. Disclaimer and Export Compliance 82 * 83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 89 * PARTICULAR PURPOSE. 90 * 91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 98 * LIMITED REMEDY. 99 * 100 * 4.3. Licensee shall not export, either directly or indirectly, any of this 101 * software or system incorporating such software without first obtaining any 102 * required license or other approval from the U. S. Department of Commerce or 103 * any other agency or department of the United States Government. In the 104 * event Licensee exports any such software from the United States or 105 * re-exports any such software from a foreign destination, Licensee shall 106 * ensure that the distribution and export/re-export of the software is in 107 * compliance with all laws, regulations, orders, or other restrictions of the 108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 109 * any of its subsidiaries will export/re-export any technical data, process, 110 * software, or service, directly or indirectly, to any country for which the 111 * United States government or any agency thereof requires an export license, 112 * other governmental approval, or letter of assurance, without first obtaining 113 * such license, approval or letter. 114 * 115 *****************************************************************************/ 116 117#define __NSLOAD_C__ 118 119#include "acpi.h" 120#include "acinterp.h" 121#include "acnamesp.h" 122#include "amlcode.h" 123#include "acparser.h" 124#include "acdispat.h" 125#include "acdebug.h" 126 127 128#define _COMPONENT ACPI_NAMESPACE 129 MODULE_NAME ("nsload") 130 131 132/******************************************************************************* 133 * 134 * FUNCTION: AcpiLoadNamespace 135 * 136 * PARAMETERS: DisplayAmlDuringLoad 137 * 138 * RETURN: Status 139 * 140 * DESCRIPTION: Load the name space from what ever is pointed to by DSDT. 141 * (DSDT points to either the BIOS or a buffer.) 142 * 143 ******************************************************************************/ 144 145ACPI_STATUS 146AcpiNsLoadNamespace ( 147 void) 148{ 149 ACPI_STATUS Status; 150 151 152 FUNCTION_TRACE ("AcpiLoadNameSpace"); 153 154 155 /* There must be at least a DSDT installed */ 156 157 if (AcpiGbl_DSDT == NULL) 158 { 159 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "DSDT is not in memory\n")); 160 return_ACPI_STATUS (AE_NO_ACPI_TABLES); 161 } 162 163 164 /* 165 * Load the namespace. The DSDT is required, 166 * but the SSDT and PSDT tables are optional. 167 */ 168 Status = AcpiNsLoadTableByType (ACPI_TABLE_DSDT); 169 if (ACPI_FAILURE (Status)) 170 { 171 return_ACPI_STATUS (Status); 172 } 173 174 /* Ignore exceptions from these */ 175 176 AcpiNsLoadTableByType (ACPI_TABLE_SSDT); 177 AcpiNsLoadTableByType (ACPI_TABLE_PSDT); 178 179 180 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_OK, 181 "ACPI Namespace successfully loaded at root %p\n", 182 AcpiGbl_RootNode)); 183 184 185 return_ACPI_STATUS (Status); 186} 187 188 189/******************************************************************************* 190 * 191 * FUNCTION: AcpiNsOneParsePass 192 * 193 * PARAMETERS: 194 * 195 * RETURN: Status 196 * 197 * DESCRIPTION: 198 * 199 ******************************************************************************/ 200 201ACPI_STATUS 202AcpiNsOneCompleteParse ( 203 UINT32 PassNumber, 204 ACPI_TABLE_DESC *TableDesc) 205{ 206 ACPI_PARSE_DOWNWARDS DescendingCallback; 207 ACPI_PARSE_UPWARDS AscendingCallback; 208 ACPI_PARSE_OBJECT *ParseRoot; 209 ACPI_STATUS Status; 210 211 212 FUNCTION_TRACE ("NsOneCompleteParse"); 213 214 215 switch (PassNumber) 216 { 217 case 1: 218 DescendingCallback = AcpiDsLoad1BeginOp; 219 AscendingCallback = AcpiDsLoad1EndOp; 220 break; 221 222 case 2: 223 DescendingCallback = AcpiDsLoad2BeginOp; 224 AscendingCallback = AcpiDsLoad2EndOp; 225 break; 226 227 case 3: 228 DescendingCallback = AcpiDsExecBeginOp; 229 AscendingCallback = AcpiDsExecEndOp; 230 break; 231 232 default: 233 return (AE_BAD_PARAMETER); 234 } 235 236 /* Create and init a Root Node */ 237 238 ParseRoot = AcpiPsAllocOp (AML_SCOPE_OP); 239 if (!ParseRoot) 240 { 241 return_ACPI_STATUS (AE_NO_MEMORY); 242 } 243 244 ((ACPI_PARSE2_OBJECT *) ParseRoot)->Name = ACPI_ROOT_NAME; 245 246 247 /* Pass 1: Parse everything except control method bodies */ 248 249 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "*PARSE* pass %d parse\n", PassNumber)); 250 251 Status = AcpiPsParseAml (ParseRoot, TableDesc->AmlPointer, 252 TableDesc->AmlLength, 253 ACPI_PARSE_LOAD_PASS1 | ACPI_PARSE_DELETE_TREE, 254 NULL, NULL, NULL, DescendingCallback, 255 AscendingCallback); 256 257 AcpiPsDeleteParseTree (ParseRoot); 258 return_ACPI_STATUS (Status); 259} 260 261 262/******************************************************************************* 263 * 264 * FUNCTION: AcpiNsParseTable 265 * 266 * PARAMETERS: TableDesc - An ACPI table descriptor for table to parse 267 * StartNode - Where to enter the table into the namespace 268 * 269 * RETURN: Status 270 * 271 * DESCRIPTION: Parse AML within an ACPI table and return a tree of ops 272 * 273 ******************************************************************************/ 274 275ACPI_STATUS 276AcpiNsParseTable ( 277 ACPI_TABLE_DESC *TableDesc, 278 ACPI_NAMESPACE_NODE *StartNode) 279{ 280 ACPI_STATUS Status; 281 282 283 FUNCTION_TRACE ("NsParseTable"); 284 285 286 /* 287 * AML Parse, pass 1 288 * 289 * In this pass, we load most of the namespace. Control methods 290 * are not parsed until later. A parse tree is not created. Instead, 291 * each Parser Op subtree is deleted when it is finished. This saves 292 * a great deal of memory, and allows a small cache of parse objects 293 * to service the entire parse. The second pass of the parse then 294 * performs another complete parse of the AML.. 295 */ 296 Status = AcpiNsOneCompleteParse (1, TableDesc); 297 if (ACPI_FAILURE (Status)) 298 { 299 return_ACPI_STATUS (Status); 300 } 301 302 303 /* 304 * AML Parse, pass 2 305 * 306 * In this pass, we resolve forward references and other things 307 * that could not be completed during the first pass. 308 * Another complete parse of the AML is performed, but the 309 * overhead of this is compensated for by the fact that the 310 * parse objects are all cached. 311 */ 312 Status = AcpiNsOneCompleteParse (2, TableDesc); 313 if (ACPI_FAILURE (Status)) 314 { 315 return_ACPI_STATUS (Status); 316 } 317 318 return_ACPI_STATUS (Status); 319} 320 321 322/******************************************************************************* 323 * 324 * FUNCTION: AcpiNsLoadTable 325 * 326 * PARAMETERS: *PcodeAddr - Address of pcode block 327 * PcodeLength - Length of pcode block 328 * 329 * RETURN: Status 330 * 331 * DESCRIPTION: Load one ACPI table into the namespace 332 * 333 ******************************************************************************/ 334 335ACPI_STATUS 336AcpiNsLoadTable ( 337 ACPI_TABLE_DESC *TableDesc, 338 ACPI_NAMESPACE_NODE *Node) 339{ 340 ACPI_STATUS Status; 341 342 343 FUNCTION_TRACE ("NsLoadTable"); 344 345 346 if (!TableDesc->AmlPointer) 347 { 348 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Null AML pointer\n")); 349 return_ACPI_STATUS (AE_BAD_PARAMETER); 350 } 351 352 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "AML block at %p\n", TableDesc->AmlPointer)); 353 354 355 if (!TableDesc->AmlLength) 356 { 357 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Zero-length AML block\n")); 358 return_ACPI_STATUS (AE_BAD_PARAMETER); 359 } 360 361 362 /* 363 * Parse the table and load the namespace with all named 364 * objects found within. Control methods are NOT parsed 365 * at this time. In fact, the control methods cannot be 366 * parsed until the entire namespace is loaded, because 367 * if a control method makes a forward reference (call) 368 * to another control method, we can't continue parsing 369 * because we don't know how many arguments to parse next! 370 */ 371 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "**** Loading table into namespace ****\n")); 372 373 AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 374 Status = AcpiNsParseTable (TableDesc, Node->Child); 375 AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 376 377 if (ACPI_FAILURE (Status)) 378 { 379 return_ACPI_STATUS (Status); 380 } 381 382 /* 383 * Now we can parse the control methods. We always parse 384 * them here for a sanity check, and if configured for 385 * just-in-time parsing, we delete the control method 386 * parse trees. 387 */ 388 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, 389 "**** Begin Table Method Parsing and Object Initialization ****\n")); 390 391 Status = AcpiDsInitializeObjects (TableDesc, Node); 392 393 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, 394 "**** Completed Table Method Parsing and Object Initialization ****\n")); 395 396 return_ACPI_STATUS (Status); 397} 398 399 400/******************************************************************************* 401 * 402 * FUNCTION: AcpiNsLoadTableByType 403 * 404 * PARAMETERS: TableType - Id of the table type to load 405 * 406 * RETURN: Status 407 * 408 * DESCRIPTION: Load an ACPI table or tables into the namespace. All tables 409 * of the given type are loaded. The mechanism allows this 410 * routine to be called repeatedly. 411 * 412 ******************************************************************************/ 413 414ACPI_STATUS 415AcpiNsLoadTableByType ( 416 ACPI_TABLE_TYPE TableType) 417{ 418 UINT32 i; 419 ACPI_STATUS Status = AE_OK; 420 ACPI_TABLE_DESC *TableDesc; 421 422 423 FUNCTION_TRACE ("NsLoadTableByType"); 424 425 426 AcpiUtAcquireMutex (ACPI_MTX_TABLES); 427 428 429 /* 430 * Table types supported are: 431 * DSDT (one), SSDT/PSDT (multiple) 432 */ 433 switch (TableType) 434 { 435 436 case ACPI_TABLE_DSDT: 437 438 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Loading DSDT\n")); 439 440 TableDesc = &AcpiGbl_AcpiTables[ACPI_TABLE_DSDT]; 441 442 /* If table already loaded into namespace, just return */ 443 444 if (TableDesc->LoadedIntoNamespace) 445 { 446 goto UnlockAndExit; 447 } 448 449 TableDesc->TableId = TABLE_ID_DSDT; 450 451 /* Now load the single DSDT */ 452 453 Status = AcpiNsLoadTable (TableDesc, AcpiGbl_RootNode); 454 if (ACPI_SUCCESS (Status)) 455 { 456 TableDesc->LoadedIntoNamespace = TRUE; 457 } 458 459 break; 460 461 462 case ACPI_TABLE_SSDT: 463 464 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Loading %d SSDTs\n", 465 AcpiGbl_AcpiTables[ACPI_TABLE_SSDT].Count)); 466 467 /* 468 * Traverse list of SSDT tables 469 */ 470 TableDesc = &AcpiGbl_AcpiTables[ACPI_TABLE_SSDT]; 471 for (i = 0; i < AcpiGbl_AcpiTables[ACPI_TABLE_SSDT].Count; i++) 472 { 473 /* 474 * Only attempt to load table if it is not 475 * already loaded! 476 */ 477 if (!TableDesc->LoadedIntoNamespace) 478 { 479 Status = AcpiNsLoadTable (TableDesc, AcpiGbl_RootNode); 480 if (ACPI_FAILURE (Status)) 481 { 482 break; 483 } 484 485 TableDesc->LoadedIntoNamespace = TRUE; 486 } 487 488 TableDesc = TableDesc->Next; 489 } 490 break; 491 492 493 case ACPI_TABLE_PSDT: 494 495 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Loading %d PSDTs\n", 496 AcpiGbl_AcpiTables[ACPI_TABLE_PSDT].Count)); 497 498 /* 499 * Traverse list of PSDT tables 500 */ 501 TableDesc = &AcpiGbl_AcpiTables[ACPI_TABLE_PSDT]; 502 503 for (i = 0; i < AcpiGbl_AcpiTables[ACPI_TABLE_PSDT].Count; i++) 504 { 505 /* Only attempt to load table if it is not already loaded! */ 506 507 if (!TableDesc->LoadedIntoNamespace) 508 { 509 Status = AcpiNsLoadTable (TableDesc, AcpiGbl_RootNode); 510 if (ACPI_FAILURE (Status)) 511 { 512 break; 513 } 514 515 TableDesc->LoadedIntoNamespace = TRUE; 516 } 517 518 TableDesc = TableDesc->Next; 519 } 520 521 break; 522 523 524 default: 525 Status = AE_SUPPORT; 526 break; 527 } 528 529 530UnlockAndExit: 531 532 AcpiUtReleaseMutex (ACPI_MTX_TABLES); 533 534 return_ACPI_STATUS (Status); 535 536} 537 538 539/******************************************************************************* 540 * 541 * FUNCTION: AcpiNsDeleteSubtree 542 * 543 * PARAMETERS: StartHandle - Handle in namespace where search begins 544 * 545 * RETURNS Status 546 * 547 * DESCRIPTION: Walks the namespace starting at the given handle and deletes 548 * all objects, entries, and scopes in the entire subtree. 549 * 550 * TBD: [Investigate] What if any part of this subtree is in use? 551 * (i.e. on one of the object stacks?) 552 * 553 ******************************************************************************/ 554 555ACPI_STATUS 556AcpiNsDeleteSubtree ( 557 ACPI_HANDLE StartHandle) 558{ 559 ACPI_STATUS Status; 560 ACPI_HANDLE ChildHandle; 561 ACPI_HANDLE ParentHandle; 562 ACPI_HANDLE NextChildHandle; 563 ACPI_HANDLE Dummy; 564 UINT32 Level; 565 566 567 FUNCTION_TRACE ("NsDeleteSubtree"); 568 569 570 ParentHandle = StartHandle; 571 ChildHandle = 0; 572 Level = 1; 573 574 /* 575 * Traverse the tree of objects until we bubble back up 576 * to where we started. 577 */ 578 while (Level > 0) 579 { 580 /* Attempt to get the next object in this scope */ 581 582 Status = AcpiGetNextObject (ACPI_TYPE_ANY, ParentHandle, 583 ChildHandle, &NextChildHandle); 584 585 ChildHandle = NextChildHandle; 586 587 588 /* Did we get a new object? */ 589 590 if (ACPI_SUCCESS (Status)) 591 { 592 /* Check if this object has any children */ 593 594 if (ACPI_SUCCESS (AcpiGetNextObject (ACPI_TYPE_ANY, ChildHandle, 595 0, &Dummy))) 596 { 597 /* 598 * There is at least one child of this object, 599 * visit the object 600 */ 601 Level++; 602 ParentHandle = ChildHandle; 603 ChildHandle = 0; 604 } 605 } 606 607 else 608 { 609 /* 610 * No more children in this object, go back up to 611 * the object's parent 612 */ 613 Level--; 614 615 /* Delete all children now */ 616 617 AcpiNsDeleteChildren (ChildHandle); 618 619 ChildHandle = ParentHandle; 620 AcpiGetParent (ParentHandle, &ParentHandle); 621 } 622 } 623 624 /* Now delete the starting object, and we are done */ 625 626 AcpiNsDeleteNode (ChildHandle); 627 628 return_ACPI_STATUS (AE_OK); 629} 630 631 632/******************************************************************************* 633 * 634 * FUNCTION: AcpiNsUnloadNameSpace 635 * 636 * PARAMETERS: Handle - Root of namespace subtree to be deleted 637 * 638 * RETURN: Status 639 * 640 * DESCRIPTION: Shrinks the namespace, typically in response to an undocking 641 * event. Deletes an entire subtree starting from (and 642 * including) the given handle. 643 * 644 ******************************************************************************/ 645 646ACPI_STATUS 647AcpiNsUnloadNamespace ( 648 ACPI_HANDLE Handle) 649{ 650 ACPI_STATUS Status; 651 652 653 FUNCTION_TRACE ("NsUnloadNameSpace"); 654 655 656 /* Parameter validation */ 657 658 if (!AcpiGbl_RootNode) 659 { 660 return_ACPI_STATUS (AE_NO_NAMESPACE); 661 } 662 663 if (!Handle) 664 { 665 return_ACPI_STATUS (AE_BAD_PARAMETER); 666 } 667 668 669 /* This function does the real work */ 670 671 Status = AcpiNsDeleteSubtree (Handle); 672 673 return_ACPI_STATUS (Status); 674} 675 676 677