1 /****************************************************************************** 2 * 3 * Module Name: nsload - namespace loading/expanding/contracting procedures 4 * $Revision: 1.78 $ 5 * 6 *****************************************************************************/ 7 8 /****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2006, 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 "acdispat.h" 122 123 124 #define _COMPONENT ACPI_NAMESPACE 125 ACPI_MODULE_NAME ("nsload") 126 127 /* Local prototypes */ 128 129 static ACPI_STATUS 130 AcpiNsLoadTableByType ( 131 ACPI_TABLE_TYPE TableType); 132 133 #ifdef ACPI_FUTURE_IMPLEMENTATION 134 ACPI_STATUS 135 AcpiNsUnloadNamespace ( 136 ACPI_HANDLE Handle); 137 138 static ACPI_STATUS 139 AcpiNsDeleteSubtree ( 140 ACPI_HANDLE StartHandle); 141 #endif 142 143 144 #ifndef ACPI_NO_METHOD_EXECUTION 145 /******************************************************************************* 146 * 147 * FUNCTION: AcpiNsLoadTable 148 * 149 * PARAMETERS: TableDesc - Descriptor for table to be loaded 150 * Node - Owning NS node 151 * 152 * RETURN: Status 153 * 154 * DESCRIPTION: Load one ACPI table into the namespace 155 * 156 ******************************************************************************/ 157 158 ACPI_STATUS 159 AcpiNsLoadTable ( 160 ACPI_TABLE_DESC *TableDesc, 161 ACPI_NAMESPACE_NODE *Node) 162 { 163 ACPI_STATUS Status; 164 165 166 ACPI_FUNCTION_TRACE (NsLoadTable); 167 168 169 /* Check if table contains valid AML (must be DSDT, PSDT, SSDT, etc.) */ 170 171 if (!(AcpiGbl_TableData[TableDesc->Type].Flags & ACPI_TABLE_EXECUTABLE)) 172 { 173 /* Just ignore this table */ 174 175 return_ACPI_STATUS (AE_OK); 176 } 177 178 /* Check validity of the AML start and length */ 179 180 if (!TableDesc->AmlStart) 181 { 182 ACPI_ERROR ((AE_INFO, "Null AML pointer")); 183 return_ACPI_STATUS (AE_BAD_PARAMETER); 184 } 185 186 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "AML block at %p\n", 187 TableDesc->AmlStart)); 188 189 /* Ignore table if there is no AML contained within */ 190 191 if (!TableDesc->AmlLength) 192 { 193 ACPI_WARNING ((AE_INFO, "Zero-length AML block in table [%4.4s]", 194 TableDesc->Pointer->Signature)); 195 return_ACPI_STATUS (AE_OK); 196 } 197 198 /* 199 * Parse the table and load the namespace with all named 200 * objects found within. Control methods are NOT parsed 201 * at this time. In fact, the control methods cannot be 202 * parsed until the entire namespace is loaded, because 203 * if a control method makes a forward reference (call) 204 * to another control method, we can't continue parsing 205 * because we don't know how many arguments to parse next! 206 */ 207 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, 208 "**** Loading table into namespace ****\n")); 209 210 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 211 if (ACPI_FAILURE (Status)) 212 { 213 return_ACPI_STATUS (Status); 214 } 215 216 Status = AcpiNsParseTable (TableDesc, Node->Child); 217 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 218 219 if (ACPI_FAILURE (Status)) 220 { 221 return_ACPI_STATUS (Status); 222 } 223 224 /* 225 * Now we can parse the control methods. We always parse 226 * them here for a sanity check, and if configured for 227 * just-in-time parsing, we delete the control method 228 * parse trees. 229 */ 230 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, 231 "**** Begin Table Method Parsing and Object Initialization ****\n")); 232 233 Status = AcpiDsInitializeObjects (TableDesc, Node); 234 235 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, 236 "**** Completed Table Method Parsing and Object Initialization ****\n")); 237 238 return_ACPI_STATUS (Status); 239 } 240 241 242 /******************************************************************************* 243 * 244 * FUNCTION: AcpiNsLoadTableByType 245 * 246 * PARAMETERS: TableType - Id of the table type to load 247 * 248 * RETURN: Status 249 * 250 * DESCRIPTION: Load an ACPI table or tables into the namespace. All tables 251 * of the given type are loaded. The mechanism allows this 252 * routine to be called repeatedly. 253 * 254 ******************************************************************************/ 255 256 static ACPI_STATUS 257 AcpiNsLoadTableByType ( 258 ACPI_TABLE_TYPE TableType) 259 { 260 UINT32 i; 261 ACPI_STATUS Status; 262 ACPI_TABLE_DESC *TableDesc; 263 264 265 ACPI_FUNCTION_TRACE (NsLoadTableByType); 266 267 268 Status = AcpiUtAcquireMutex (ACPI_MTX_TABLES); 269 if (ACPI_FAILURE (Status)) 270 { 271 return_ACPI_STATUS (Status); 272 } 273 274 /* 275 * Table types supported are: 276 * DSDT (one), SSDT/PSDT (multiple) 277 */ 278 switch (TableType) 279 { 280 case ACPI_TABLE_ID_DSDT: 281 282 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Namespace load: DSDT\n")); 283 284 TableDesc = AcpiGbl_TableLists[ACPI_TABLE_ID_DSDT].Next; 285 286 /* If table already loaded into namespace, just return */ 287 288 if (TableDesc->LoadedIntoNamespace) 289 { 290 goto UnlockAndExit; 291 } 292 293 /* Now load the single DSDT */ 294 295 Status = AcpiNsLoadTable (TableDesc, AcpiGbl_RootNode); 296 if (ACPI_SUCCESS (Status)) 297 { 298 TableDesc->LoadedIntoNamespace = TRUE; 299 } 300 break; 301 302 303 case ACPI_TABLE_ID_SSDT: 304 case ACPI_TABLE_ID_PSDT: 305 306 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Namespace load: %d SSDT or PSDTs\n", 307 AcpiGbl_TableLists[TableType].Count)); 308 309 /* 310 * Traverse list of SSDT or PSDT tables 311 */ 312 TableDesc = AcpiGbl_TableLists[TableType].Next; 313 for (i = 0; i < AcpiGbl_TableLists[TableType].Count; i++) 314 { 315 /* 316 * Only attempt to load table into namespace if it is not 317 * already loaded! 318 */ 319 if (!TableDesc->LoadedIntoNamespace) 320 { 321 Status = AcpiNsLoadTable (TableDesc, AcpiGbl_RootNode); 322 if (ACPI_FAILURE (Status)) 323 { 324 break; 325 } 326 327 TableDesc->LoadedIntoNamespace = TRUE; 328 } 329 330 TableDesc = TableDesc->Next; 331 } 332 break; 333 334 335 default: 336 Status = AE_SUPPORT; 337 break; 338 } 339 340 341 UnlockAndExit: 342 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES); 343 return_ACPI_STATUS (Status); 344 } 345 346 347 /******************************************************************************* 348 * 349 * FUNCTION: AcpiLoadNamespace 350 * 351 * PARAMETERS: None 352 * 353 * RETURN: Status 354 * 355 * DESCRIPTION: Load the name space from what ever is pointed to by DSDT. 356 * (DSDT points to either the BIOS or a buffer.) 357 * 358 ******************************************************************************/ 359 360 ACPI_STATUS 361 AcpiNsLoadNamespace ( 362 void) 363 { 364 ACPI_STATUS Status; 365 366 367 ACPI_FUNCTION_TRACE (AcpiLoadNameSpace); 368 369 370 /* There must be at least a DSDT installed */ 371 372 if (AcpiGbl_DSDT == NULL) 373 { 374 ACPI_ERROR ((AE_INFO, "DSDT is not in memory")); 375 return_ACPI_STATUS (AE_NO_ACPI_TABLES); 376 } 377 378 /* 379 * Load the namespace. The DSDT is required, 380 * but the SSDT and PSDT tables are optional. 381 */ 382 Status = AcpiNsLoadTableByType (ACPI_TABLE_ID_DSDT); 383 if (ACPI_FAILURE (Status)) 384 { 385 return_ACPI_STATUS (Status); 386 } 387 388 /* Ignore exceptions from these */ 389 390 (void) AcpiNsLoadTableByType (ACPI_TABLE_ID_SSDT); 391 (void) AcpiNsLoadTableByType (ACPI_TABLE_ID_PSDT); 392 393 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT, 394 "ACPI Namespace successfully loaded at root %p\n", 395 AcpiGbl_RootNode)); 396 397 return_ACPI_STATUS (Status); 398 } 399 400 401 #ifdef ACPI_FUTURE_IMPLEMENTATION 402 /******************************************************************************* 403 * 404 * FUNCTION: AcpiNsDeleteSubtree 405 * 406 * PARAMETERS: StartHandle - Handle in namespace where search begins 407 * 408 * RETURNS Status 409 * 410 * DESCRIPTION: Walks the namespace starting at the given handle and deletes 411 * all objects, entries, and scopes in the entire subtree. 412 * 413 * Namespace/Interpreter should be locked or the subsystem should 414 * be in shutdown before this routine is called. 415 * 416 ******************************************************************************/ 417 418 static ACPI_STATUS 419 AcpiNsDeleteSubtree ( 420 ACPI_HANDLE StartHandle) 421 { 422 ACPI_STATUS Status; 423 ACPI_HANDLE ChildHandle; 424 ACPI_HANDLE ParentHandle; 425 ACPI_HANDLE NextChildHandle; 426 ACPI_HANDLE Dummy; 427 UINT32 Level; 428 429 430 ACPI_FUNCTION_TRACE (NsDeleteSubtree); 431 432 433 ParentHandle = StartHandle; 434 ChildHandle = NULL; 435 Level = 1; 436 437 /* 438 * Traverse the tree of objects until we bubble back up 439 * to where we started. 440 */ 441 while (Level > 0) 442 { 443 /* Attempt to get the next object in this scope */ 444 445 Status = AcpiGetNextObject (ACPI_TYPE_ANY, ParentHandle, 446 ChildHandle, &NextChildHandle); 447 448 ChildHandle = NextChildHandle; 449 450 /* Did we get a new object? */ 451 452 if (ACPI_SUCCESS (Status)) 453 { 454 /* Check if this object has any children */ 455 456 if (ACPI_SUCCESS (AcpiGetNextObject (ACPI_TYPE_ANY, ChildHandle, 457 NULL, &Dummy))) 458 { 459 /* 460 * There is at least one child of this object, 461 * visit the object 462 */ 463 Level++; 464 ParentHandle = ChildHandle; 465 ChildHandle = NULL; 466 } 467 } 468 else 469 { 470 /* 471 * No more children in this object, go back up to 472 * the object's parent 473 */ 474 Level--; 475 476 /* Delete all children now */ 477 478 AcpiNsDeleteChildren (ChildHandle); 479 480 ChildHandle = ParentHandle; 481 Status = AcpiGetParent (ParentHandle, &ParentHandle); 482 if (ACPI_FAILURE (Status)) 483 { 484 return_ACPI_STATUS (Status); 485 } 486 } 487 } 488 489 /* Now delete the starting object, and we are done */ 490 491 AcpiNsDeleteNode (ChildHandle); 492 493 return_ACPI_STATUS (AE_OK); 494 } 495 496 497 /******************************************************************************* 498 * 499 * FUNCTION: AcpiNsUnloadNameSpace 500 * 501 * PARAMETERS: Handle - Root of namespace subtree to be deleted 502 * 503 * RETURN: Status 504 * 505 * DESCRIPTION: Shrinks the namespace, typically in response to an undocking 506 * event. Deletes an entire subtree starting from (and 507 * including) the given handle. 508 * 509 ******************************************************************************/ 510 511 ACPI_STATUS 512 AcpiNsUnloadNamespace ( 513 ACPI_HANDLE Handle) 514 { 515 ACPI_STATUS Status; 516 517 518 ACPI_FUNCTION_TRACE (NsUnloadNameSpace); 519 520 521 /* Parameter validation */ 522 523 if (!AcpiGbl_RootNode) 524 { 525 return_ACPI_STATUS (AE_NO_NAMESPACE); 526 } 527 528 if (!Handle) 529 { 530 return_ACPI_STATUS (AE_BAD_PARAMETER); 531 } 532 533 /* This function does the real work */ 534 535 Status = AcpiNsDeleteSubtree (Handle); 536 537 return_ACPI_STATUS (Status); 538 } 539 #endif 540 #endif 541 542