nsload.c revision 104470
1/****************************************************************************** 2 * 3 * Module Name: nsload - namespace loading/expanding/contracting procedures 4 * $Revision: 59 $ 5 * 6 *****************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2002, 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 "acnamesp.h" 121#include "acparser.h" 122#include "acdispat.h" 123 124 125#define _COMPONENT ACPI_NAMESPACE 126 ACPI_MODULE_NAME ("nsload") 127 128 129/******************************************************************************* 130 * 131 * FUNCTION: NsOneCompleteParse 132 * 133 * PARAMETERS: PassNumber - 1 or 2 134 * TableDesc - The table to be parsed. 135 * 136 * RETURN: Status 137 * 138 * DESCRIPTION: Perform one complete parse of an ACPI/AML table. 139 * 140 ******************************************************************************/ 141 142ACPI_STATUS 143AcpiNsOneCompleteParse ( 144 UINT32 PassNumber, 145 ACPI_TABLE_DESC *TableDesc) 146{ 147 ACPI_PARSE_OBJECT *ParseRoot; 148 ACPI_STATUS Status; 149 ACPI_WALK_STATE *WalkState; 150 151 152 ACPI_FUNCTION_TRACE ("NsOneCompleteParse"); 153 154 155 /* Create and init a Root Node */ 156 157 ParseRoot = AcpiPsCreateScopeOp (); 158 if (!ParseRoot) 159 { 160 return_ACPI_STATUS (AE_NO_MEMORY); 161 } 162 163 164 /* Create and initialize a new walk state */ 165 166 WalkState = AcpiDsCreateWalkState (TABLE_ID_DSDT, 167 NULL, NULL, NULL); 168 if (!WalkState) 169 { 170 AcpiPsFreeOp (ParseRoot); 171 return_ACPI_STATUS (AE_NO_MEMORY); 172 } 173 174 Status = AcpiDsInitAmlWalk (WalkState, ParseRoot, NULL, TableDesc->AmlStart, 175 TableDesc->AmlLength, NULL, NULL, PassNumber); 176 if (ACPI_FAILURE (Status)) 177 { 178 AcpiDsDeleteWalkState (WalkState); 179 return_ACPI_STATUS (Status); 180 } 181 182 /* Parse the AML */ 183 184 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "*PARSE* pass %d parse\n", PassNumber)); 185 Status = AcpiPsParseAml (WalkState); 186 187 AcpiPsDeleteParseTree (ParseRoot); 188 return_ACPI_STATUS (Status); 189} 190 191 192/******************************************************************************* 193 * 194 * FUNCTION: AcpiNsParseTable 195 * 196 * PARAMETERS: TableDesc - An ACPI table descriptor for table to parse 197 * StartNode - Where to enter the table into the namespace 198 * 199 * RETURN: Status 200 * 201 * DESCRIPTION: Parse AML within an ACPI table and return a tree of ops 202 * 203 ******************************************************************************/ 204 205ACPI_STATUS 206AcpiNsParseTable ( 207 ACPI_TABLE_DESC *TableDesc, 208 ACPI_NAMESPACE_NODE *StartNode) 209{ 210 ACPI_STATUS Status; 211 212 213 ACPI_FUNCTION_TRACE ("NsParseTable"); 214 215 216 /* 217 * AML Parse, pass 1 218 * 219 * In this pass, we load most of the namespace. Control methods 220 * are not parsed until later. A parse tree is not created. Instead, 221 * each Parser Op subtree is deleted when it is finished. This saves 222 * a great deal of memory, and allows a small cache of parse objects 223 * to service the entire parse. The second pass of the parse then 224 * performs another complete parse of the AML.. 225 */ 226 Status = AcpiNsOneCompleteParse (1, TableDesc); 227 if (ACPI_FAILURE (Status)) 228 { 229 return_ACPI_STATUS (Status); 230 } 231 232 /* 233 * AML Parse, pass 2 234 * 235 * In this pass, we resolve forward references and other things 236 * that could not be completed during the first pass. 237 * Another complete parse of the AML is performed, but the 238 * overhead of this is compensated for by the fact that the 239 * parse objects are all cached. 240 */ 241 Status = AcpiNsOneCompleteParse (2, TableDesc); 242 if (ACPI_FAILURE (Status)) 243 { 244 return_ACPI_STATUS (Status); 245 } 246 247 return_ACPI_STATUS (Status); 248} 249 250#ifndef ACPI_NO_METHOD_EXECUTION 251 252/******************************************************************************* 253 * 254 * FUNCTION: AcpiNsLoadTable 255 * 256 * PARAMETERS: TableDesc - Descriptor for table to be loaded 257 * Node - Owning NS node 258 * 259 * RETURN: Status 260 * 261 * DESCRIPTION: Load one ACPI table into the namespace 262 * 263 ******************************************************************************/ 264 265ACPI_STATUS 266AcpiNsLoadTable ( 267 ACPI_TABLE_DESC *TableDesc, 268 ACPI_NAMESPACE_NODE *Node) 269{ 270 ACPI_STATUS Status; 271 272 273 ACPI_FUNCTION_TRACE ("NsLoadTable"); 274 275 276 /* Check if table contains valid AML (must be DSDT, PSDT, SSDT, etc.) */ 277 278 if (!(AcpiGbl_AcpiTableData[TableDesc->Type].Flags & ACPI_TABLE_EXECUTABLE)) 279 { 280 /* Just ignore this table */ 281 282 return_ACPI_STATUS (AE_OK); 283 } 284 285 /* Check validity of the AML start and length */ 286 287 if (!TableDesc->AmlStart) 288 { 289 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Null AML pointer\n")); 290 return_ACPI_STATUS (AE_BAD_PARAMETER); 291 } 292 293 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "AML block at %p\n", TableDesc->AmlStart)); 294 295 if (!TableDesc->AmlLength) 296 { 297 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Zero-length AML block\n")); 298 return_ACPI_STATUS (AE_BAD_PARAMETER); 299 } 300 301 /* 302 * Parse the table and load the namespace with all named 303 * objects found within. Control methods are NOT parsed 304 * at this time. In fact, the control methods cannot be 305 * parsed until the entire namespace is loaded, because 306 * if a control method makes a forward reference (call) 307 * to another control method, we can't continue parsing 308 * because we don't know how many arguments to parse next! 309 */ 310 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "**** Loading table into namespace ****\n")); 311 312 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 313 if (ACPI_FAILURE (Status)) 314 { 315 return_ACPI_STATUS (Status); 316 } 317 318 Status = AcpiNsParseTable (TableDesc, Node->Child); 319 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 320 321 if (ACPI_FAILURE (Status)) 322 { 323 return_ACPI_STATUS (Status); 324 } 325 326 /* 327 * Now we can parse the control methods. We always parse 328 * them here for a sanity check, and if configured for 329 * just-in-time parsing, we delete the control method 330 * parse trees. 331 */ 332 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, 333 "**** Begin Table Method Parsing and Object Initialization ****\n")); 334 335 Status = AcpiDsInitializeObjects (TableDesc, Node); 336 337 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, 338 "**** Completed Table Method Parsing and Object Initialization ****\n")); 339 340 return_ACPI_STATUS (Status); 341} 342 343 344/******************************************************************************* 345 * 346 * FUNCTION: AcpiNsLoadTableByType 347 * 348 * PARAMETERS: TableType - Id of the table type to load 349 * 350 * RETURN: Status 351 * 352 * DESCRIPTION: Load an ACPI table or tables into the namespace. All tables 353 * of the given type are loaded. The mechanism allows this 354 * routine to be called repeatedly. 355 * 356 ******************************************************************************/ 357 358ACPI_STATUS 359AcpiNsLoadTableByType ( 360 ACPI_TABLE_TYPE TableType) 361{ 362 UINT32 i; 363 ACPI_STATUS Status; 364 ACPI_TABLE_DESC *TableDesc; 365 366 367 ACPI_FUNCTION_TRACE ("NsLoadTableByType"); 368 369 370 Status = AcpiUtAcquireMutex (ACPI_MTX_TABLES); 371 if (ACPI_FAILURE (Status)) 372 { 373 return_ACPI_STATUS (Status); 374 } 375 376 /* 377 * Table types supported are: 378 * DSDT (one), SSDT/PSDT (multiple) 379 */ 380 switch (TableType) 381 { 382 case ACPI_TABLE_DSDT: 383 384 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Loading DSDT\n")); 385 386 TableDesc = &AcpiGbl_AcpiTables[ACPI_TABLE_DSDT]; 387 388 /* If table already loaded into namespace, just return */ 389 390 if (TableDesc->LoadedIntoNamespace) 391 { 392 goto UnlockAndExit; 393 } 394 395 TableDesc->TableId = TABLE_ID_DSDT; 396 397 /* Now load the single DSDT */ 398 399 Status = AcpiNsLoadTable (TableDesc, AcpiGbl_RootNode); 400 if (ACPI_SUCCESS (Status)) 401 { 402 TableDesc->LoadedIntoNamespace = TRUE; 403 } 404 405 break; 406 407 408 case ACPI_TABLE_SSDT: 409 410 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Loading %d SSDTs\n", 411 AcpiGbl_AcpiTables[ACPI_TABLE_SSDT].Count)); 412 413 /* 414 * Traverse list of SSDT tables 415 */ 416 TableDesc = &AcpiGbl_AcpiTables[ACPI_TABLE_SSDT]; 417 for (i = 0; i < AcpiGbl_AcpiTables[ACPI_TABLE_SSDT].Count; i++) 418 { 419 /* 420 * Only attempt to load table if it is not 421 * already loaded! 422 */ 423 if (!TableDesc->LoadedIntoNamespace) 424 { 425 Status = AcpiNsLoadTable (TableDesc, AcpiGbl_RootNode); 426 if (ACPI_FAILURE (Status)) 427 { 428 break; 429 } 430 431 TableDesc->LoadedIntoNamespace = TRUE; 432 } 433 434 TableDesc = TableDesc->Next; 435 } 436 break; 437 438 439 case ACPI_TABLE_PSDT: 440 441 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Loading %d PSDTs\n", 442 AcpiGbl_AcpiTables[ACPI_TABLE_PSDT].Count)); 443 444 /* 445 * Traverse list of PSDT tables 446 */ 447 TableDesc = &AcpiGbl_AcpiTables[ACPI_TABLE_PSDT]; 448 449 for (i = 0; i < AcpiGbl_AcpiTables[ACPI_TABLE_PSDT].Count; i++) 450 { 451 /* Only attempt to load table if it is not already loaded! */ 452 453 if (!TableDesc->LoadedIntoNamespace) 454 { 455 Status = AcpiNsLoadTable (TableDesc, AcpiGbl_RootNode); 456 if (ACPI_FAILURE (Status)) 457 { 458 break; 459 } 460 461 TableDesc->LoadedIntoNamespace = TRUE; 462 } 463 464 TableDesc = TableDesc->Next; 465 } 466 467 break; 468 469 470 default: 471 Status = AE_SUPPORT; 472 break; 473 } 474 475 476UnlockAndExit: 477 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES); 478 return_ACPI_STATUS (Status); 479} 480 481 482/******************************************************************************* 483 * 484 * FUNCTION: AcpiLoadNamespace 485 * 486 * PARAMETERS: None 487 * 488 * RETURN: Status 489 * 490 * DESCRIPTION: Load the name space from what ever is pointed to by DSDT. 491 * (DSDT points to either the BIOS or a buffer.) 492 * 493 ******************************************************************************/ 494 495ACPI_STATUS 496AcpiNsLoadNamespace ( 497 void) 498{ 499 ACPI_STATUS Status; 500 501 502 ACPI_FUNCTION_TRACE ("AcpiLoadNameSpace"); 503 504 505 /* There must be at least a DSDT installed */ 506 507 if (AcpiGbl_DSDT == NULL) 508 { 509 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "DSDT is not in memory\n")); 510 return_ACPI_STATUS (AE_NO_ACPI_TABLES); 511 } 512 513 /* 514 * Load the namespace. The DSDT is required, 515 * but the SSDT and PSDT tables are optional. 516 */ 517 Status = AcpiNsLoadTableByType (ACPI_TABLE_DSDT); 518 if (ACPI_FAILURE (Status)) 519 { 520 return_ACPI_STATUS (Status); 521 } 522 523 /* Ignore exceptions from these */ 524 525 (void) AcpiNsLoadTableByType (ACPI_TABLE_SSDT); 526 (void) AcpiNsLoadTableByType (ACPI_TABLE_PSDT); 527 528 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_OK, 529 "ACPI Namespace successfully loaded at root %p\n", 530 AcpiGbl_RootNode)); 531 532 return_ACPI_STATUS (Status); 533} 534 535 536/******************************************************************************* 537 * 538 * FUNCTION: AcpiNsDeleteSubtree 539 * 540 * PARAMETERS: StartHandle - Handle in namespace where search begins 541 * 542 * RETURNS Status 543 * 544 * DESCRIPTION: Walks the namespace starting at the given handle and deletes 545 * all objects, entries, and scopes in the entire subtree. 546 * 547 * Namespace/Interpreter should be locked or the subsystem should 548 * be in shutdown before this routine is called. 549 * 550 ******************************************************************************/ 551 552ACPI_STATUS 553AcpiNsDeleteSubtree ( 554 ACPI_HANDLE StartHandle) 555{ 556 ACPI_STATUS Status; 557 ACPI_HANDLE ChildHandle; 558 ACPI_HANDLE ParentHandle; 559 ACPI_HANDLE NextChildHandle; 560 ACPI_HANDLE Dummy; 561 UINT32 Level; 562 563 564 ACPI_FUNCTION_TRACE ("NsDeleteSubtree"); 565 566 567 ParentHandle = StartHandle; 568 ChildHandle = 0; 569 Level = 1; 570 571 /* 572 * Traverse the tree of objects until we bubble back up 573 * to where we started. 574 */ 575 while (Level > 0) 576 { 577 /* Attempt to get the next object in this scope */ 578 579 Status = AcpiGetNextObject (ACPI_TYPE_ANY, ParentHandle, 580 ChildHandle, &NextChildHandle); 581 582 ChildHandle = NextChildHandle; 583 584 /* Did we get a new object? */ 585 586 if (ACPI_SUCCESS (Status)) 587 { 588 /* Check if this object has any children */ 589 590 if (ACPI_SUCCESS (AcpiGetNextObject (ACPI_TYPE_ANY, ChildHandle, 591 0, &Dummy))) 592 { 593 /* 594 * There is at least one child of this object, 595 * visit the object 596 */ 597 Level++; 598 ParentHandle = ChildHandle; 599 ChildHandle = 0; 600 } 601 } 602 else 603 { 604 /* 605 * No more children in this object, go back up to 606 * the object's parent 607 */ 608 Level--; 609 610 /* Delete all children now */ 611 612 AcpiNsDeleteChildren (ChildHandle); 613 614 ChildHandle = ParentHandle; 615 Status = AcpiGetParent (ParentHandle, &ParentHandle); 616 if (ACPI_FAILURE (Status)) 617 { 618 return_ACPI_STATUS (Status); 619 } 620 } 621 } 622 623 /* Now delete the starting object, and we are done */ 624 625 AcpiNsDeleteNode (ChildHandle); 626 627 return_ACPI_STATUS (AE_OK); 628} 629 630 631/******************************************************************************* 632 * 633 * FUNCTION: AcpiNsUnloadNameSpace 634 * 635 * PARAMETERS: Handle - Root of namespace subtree to be deleted 636 * 637 * RETURN: Status 638 * 639 * DESCRIPTION: Shrinks the namespace, typically in response to an undocking 640 * event. Deletes an entire subtree starting from (and 641 * including) the given handle. 642 * 643 ******************************************************************************/ 644 645ACPI_STATUS 646AcpiNsUnloadNamespace ( 647 ACPI_HANDLE Handle) 648{ 649 ACPI_STATUS Status; 650 651 652 ACPI_FUNCTION_TRACE ("NsUnloadNameSpace"); 653 654 655 /* Parameter validation */ 656 657 if (!AcpiGbl_RootNode) 658 { 659 return_ACPI_STATUS (AE_NO_NAMESPACE); 660 } 661 662 if (!Handle) 663 { 664 return_ACPI_STATUS (AE_BAD_PARAMETER); 665 } 666 667 /* This function does the real work */ 668 669 Status = AcpiNsDeleteSubtree (Handle); 670 671 return_ACPI_STATUS (Status); 672} 673 674#endif 675 676