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