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