1 /****************************************************************************** 2 * 3 * Module Name: nsload - namespace loading/expanding/contracting procedures 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2017, Intel Corp. 12 * All rights reserved. 13 * 14 * 2. License 15 * 16 * 2.1. This is your license from Intel Corp. under its intellectual property 17 * rights. You may have additional license terms from the party that provided 18 * you this software, covering your right to use that party's intellectual 19 * property rights. 20 * 21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 22 * copy of the source code appearing in this file ("Covered Code") an 23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 24 * base code distributed originally by Intel ("Original Intel Code") to copy, 25 * make derivatives, distribute, use and display any portion of the Covered 26 * Code in any form, with the right to sublicense such rights; and 27 * 28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 29 * license (with the right to sublicense), under only those claims of Intel 30 * patents that are infringed by the Original Intel Code, to make, use, sell, 31 * offer to sell, and import the Covered Code and derivative works thereof 32 * solely to the minimum extent necessary to exercise the above copyright 33 * license, and in no event shall the patent license extend to any additions 34 * to or modifications of the Original Intel Code. No other license or right 35 * is granted directly or by implication, estoppel or otherwise; 36 * 37 * The above copyright and patent license is granted only if the following 38 * conditions are met: 39 * 40 * 3. Conditions 41 * 42 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 43 * Redistribution of source code of any substantial portion of the Covered 44 * Code or modification with rights to further distribute source must include 45 * the above Copyright Notice, the above License, this list of Conditions, 46 * and the following Disclaimer and Export Compliance provision. In addition, 47 * Licensee must cause all Covered Code to which Licensee contributes to 48 * contain a file documenting the changes Licensee made to create that Covered 49 * Code and the date of any change. Licensee must include in that file the 50 * documentation of any changes made by any predecessor Licensee. Licensee 51 * must include a prominent statement that the modification is derived, 52 * directly or indirectly, from Original Intel Code. 53 * 54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 55 * Redistribution of source code of any substantial portion of the Covered 56 * Code or modification without rights to further distribute source must 57 * include the following Disclaimer and Export Compliance provision in the 58 * documentation and/or other materials provided with distribution. In 59 * addition, Licensee may not authorize further sublicense of source of any 60 * portion of the Covered Code, and must include terms to the effect that the 61 * license from Licensee to its licensee is limited to the intellectual 62 * property embodied in the software Licensee provides to its licensee, and 63 * not to intellectual property embodied in modifications its licensee may 64 * make. 65 * 66 * 3.3. Redistribution of Executable. Redistribution in executable form of any 67 * substantial portion of the Covered Code or modification must reproduce the 68 * above Copyright Notice, and the following Disclaimer and Export Compliance 69 * provision in the documentation and/or other materials provided with the 70 * distribution. 71 * 72 * 3.4. Intel retains all right, title, and interest in and to the Original 73 * Intel Code. 74 * 75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 76 * Intel shall be used in advertising or otherwise to promote the sale, use or 77 * other dealings in products derived from or relating to the Covered Code 78 * without prior written authorization from Intel. 79 * 80 * 4. Disclaimer and Export Compliance 81 * 82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 88 * PARTICULAR PURPOSE. 89 * 90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 97 * LIMITED REMEDY. 98 * 99 * 4.3. Licensee shall not export, either directly or indirectly, any of this 100 * software or system incorporating such software without first obtaining any 101 * required license or other approval from the U. S. Department of Commerce or 102 * any other agency or department of the United States Government. In the 103 * event Licensee exports any such software from the United States or 104 * re-exports any such software from a foreign destination, Licensee shall 105 * ensure that the distribution and export/re-export of the software is in 106 * compliance with all laws, regulations, orders, or other restrictions of the 107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 108 * any of its subsidiaries will export/re-export any technical data, process, 109 * software, or service, directly or indirectly, to any country for which the 110 * United States government or any agency thereof requires an export license, 111 * other governmental approval, or letter of assurance, without first obtaining 112 * such license, approval or letter. 113 * 114 ***************************************************************************** 115 * 116 * Alternatively, you may choose to be licensed under the terms of the 117 * following license: 118 * 119 * Redistribution and use in source and binary forms, with or without 120 * modification, are permitted provided that the following conditions 121 * are met: 122 * 1. Redistributions of source code must retain the above copyright 123 * notice, this list of conditions, and the following disclaimer, 124 * without modification. 125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 126 * substantially similar to the "NO WARRANTY" disclaimer below 127 * ("Disclaimer") and any redistribution must be conditioned upon 128 * including a substantially similar Disclaimer requirement for further 129 * binary redistribution. 130 * 3. Neither the names of the above-listed copyright holders nor the names 131 * of any contributors may be used to endorse or promote products derived 132 * from this software without specific prior written permission. 133 * 134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 145 * 146 * Alternatively, you may choose to be licensed under the terms of the 147 * GNU General Public License ("GPL") version 2 as published by the Free 148 * Software Foundation. 149 * 150 *****************************************************************************/ 151 152 #include "acpi.h" 153 #include "accommon.h" 154 #include "acnamesp.h" 155 #include "acdispat.h" 156 #include "actables.h" 157 #include "acinterp.h" 158 159 160 #define _COMPONENT ACPI_NAMESPACE 161 ACPI_MODULE_NAME ("nsload") 162 163 /* Local prototypes */ 164 165 #ifdef ACPI_FUTURE_IMPLEMENTATION 166 ACPI_STATUS 167 AcpiNsUnloadNamespace ( 168 ACPI_HANDLE Handle); 169 170 static ACPI_STATUS 171 AcpiNsDeleteSubtree ( 172 ACPI_HANDLE StartHandle); 173 #endif 174 175 176 #ifndef ACPI_NO_METHOD_EXECUTION 177 /******************************************************************************* 178 * 179 * FUNCTION: AcpiNsLoadTable 180 * 181 * PARAMETERS: TableIndex - Index for table to be loaded 182 * Node - Owning NS node 183 * 184 * RETURN: Status 185 * 186 * DESCRIPTION: Load one ACPI table into the namespace 187 * 188 ******************************************************************************/ 189 190 ACPI_STATUS 191 AcpiNsLoadTable ( 192 UINT32 TableIndex, 193 ACPI_NAMESPACE_NODE *Node) 194 { 195 ACPI_STATUS Status; 196 197 198 ACPI_FUNCTION_TRACE (NsLoadTable); 199 200 201 /* If table already loaded into namespace, just return */ 202 203 if (AcpiTbIsTableLoaded (TableIndex)) 204 { 205 Status = AE_ALREADY_EXISTS; 206 goto Unlock; 207 } 208 209 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, 210 "**** Loading table into namespace ****\n")); 211 212 Status = AcpiTbAllocateOwnerId (TableIndex); 213 if (ACPI_FAILURE (Status)) 214 { 215 goto Unlock; 216 } 217 218 /* 219 * Parse the table and load the namespace with all named 220 * objects found within. Control methods are NOT parsed 221 * at this time. In fact, the control methods cannot be 222 * parsed until the entire namespace is loaded, because 223 * if a control method makes a forward reference (call) 224 * to another control method, we can't continue parsing 225 * because we don't know how many arguments to parse next! 226 */ 227 Status = AcpiNsParseTable (TableIndex, Node); 228 if (ACPI_SUCCESS (Status)) 229 { 230 AcpiTbSetTableLoadedFlag (TableIndex, TRUE); 231 } 232 else 233 { 234 /* 235 * On error, delete any namespace objects created by this table. 236 * We cannot initialize these objects, so delete them. There are 237 * a couple of expecially bad cases: 238 * AE_ALREADY_EXISTS - namespace collision. 239 * AE_NOT_FOUND - the target of a Scope operator does not 240 * exist. This target of Scope must already exist in the 241 * namespace, as per the ACPI specification. 242 */ 243 AcpiNsDeleteNamespaceByOwner ( 244 AcpiGbl_RootTableList.Tables[TableIndex].OwnerId); 245 246 AcpiTbReleaseOwnerId (TableIndex); 247 return_ACPI_STATUS (Status); 248 } 249 250 Unlock: 251 if (ACPI_FAILURE (Status)) 252 { 253 return_ACPI_STATUS (Status); 254 } 255 256 /* 257 * Now we can parse the control methods. We always parse 258 * them here for a sanity check, and if configured for 259 * just-in-time parsing, we delete the control method 260 * parse trees. 261 */ 262 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, 263 "**** Begin Table Object Initialization\n")); 264 265 AcpiExEnterInterpreter (); 266 Status = AcpiDsInitializeObjects (TableIndex, Node); 267 AcpiExExitInterpreter (); 268 269 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, 270 "**** Completed Table Object Initialization\n")); 271 272 /* 273 * Execute any module-level code that was detected during the table load 274 * phase. Although illegal since ACPI 2.0, there are many machines that 275 * contain this type of code. Each block of detected executable AML code 276 * outside of any control method is wrapped with a temporary control 277 * method object and placed on a global list. The methods on this list 278 * are executed below. 279 * 280 * This case executes the module-level code for each table immediately 281 * after the table has been loaded. This provides compatibility with 282 * other ACPI implementations. Optionally, the execution can be deferred 283 * until later, see AcpiInitializeObjects. 284 */ 285 if (!AcpiGbl_ParseTableAsTermList && !AcpiGbl_GroupModuleLevelCode) 286 { 287 AcpiNsExecModuleCodeList (); 288 } 289 290 return_ACPI_STATUS (Status); 291 } 292 293 294 #ifdef ACPI_OBSOLETE_FUNCTIONS 295 /******************************************************************************* 296 * 297 * FUNCTION: AcpiLoadNamespace 298 * 299 * PARAMETERS: None 300 * 301 * RETURN: Status 302 * 303 * DESCRIPTION: Load the name space from what ever is pointed to by DSDT. 304 * (DSDT points to either the BIOS or a buffer.) 305 * 306 ******************************************************************************/ 307 308 ACPI_STATUS 309 AcpiNsLoadNamespace ( 310 void) 311 { 312 ACPI_STATUS Status; 313 314 315 ACPI_FUNCTION_TRACE (AcpiLoadNameSpace); 316 317 318 /* There must be at least a DSDT installed */ 319 320 if (AcpiGbl_DSDT == NULL) 321 { 322 ACPI_ERROR ((AE_INFO, "DSDT is not in memory")); 323 return_ACPI_STATUS (AE_NO_ACPI_TABLES); 324 } 325 326 /* 327 * Load the namespace. The DSDT is required, 328 * but the SSDT and PSDT tables are optional. 329 */ 330 Status = AcpiNsLoadTableByType (ACPI_TABLE_ID_DSDT); 331 if (ACPI_FAILURE (Status)) 332 { 333 return_ACPI_STATUS (Status); 334 } 335 336 /* Ignore exceptions from these */ 337 338 (void) AcpiNsLoadTableByType (ACPI_TABLE_ID_SSDT); 339 (void) AcpiNsLoadTableByType (ACPI_TABLE_ID_PSDT); 340 341 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT, 342 "ACPI Namespace successfully loaded at root %p\n", 343 AcpiGbl_RootNode)); 344 345 return_ACPI_STATUS (Status); 346 } 347 #endif 348 349 #ifdef ACPI_FUTURE_IMPLEMENTATION 350 /******************************************************************************* 351 * 352 * FUNCTION: AcpiNsDeleteSubtree 353 * 354 * PARAMETERS: StartHandle - Handle in namespace where search begins 355 * 356 * RETURNS Status 357 * 358 * DESCRIPTION: Walks the namespace starting at the given handle and deletes 359 * all objects, entries, and scopes in the entire subtree. 360 * 361 * Namespace/Interpreter should be locked or the subsystem should 362 * be in shutdown before this routine is called. 363 * 364 ******************************************************************************/ 365 366 static ACPI_STATUS 367 AcpiNsDeleteSubtree ( 368 ACPI_HANDLE StartHandle) 369 { 370 ACPI_STATUS Status; 371 ACPI_HANDLE ChildHandle; 372 ACPI_HANDLE ParentHandle; 373 ACPI_HANDLE NextChildHandle; 374 ACPI_HANDLE Dummy; 375 UINT32 Level; 376 377 378 ACPI_FUNCTION_TRACE (NsDeleteSubtree); 379 380 381 ParentHandle = StartHandle; 382 ChildHandle = NULL; 383 Level = 1; 384 385 /* 386 * Traverse the tree of objects until we bubble back up 387 * to where we started. 388 */ 389 while (Level > 0) 390 { 391 /* Attempt to get the next object in this scope */ 392 393 Status = AcpiGetNextObject (ACPI_TYPE_ANY, ParentHandle, 394 ChildHandle, &NextChildHandle); 395 396 ChildHandle = NextChildHandle; 397 398 /* Did we get a new object? */ 399 400 if (ACPI_SUCCESS (Status)) 401 { 402 /* Check if this object has any children */ 403 404 if (ACPI_SUCCESS (AcpiGetNextObject (ACPI_TYPE_ANY, ChildHandle, 405 NULL, &Dummy))) 406 { 407 /* 408 * There is at least one child of this object, 409 * visit the object 410 */ 411 Level++; 412 ParentHandle = ChildHandle; 413 ChildHandle = NULL; 414 } 415 } 416 else 417 { 418 /* 419 * No more children in this object, go back up to 420 * the object's parent 421 */ 422 Level--; 423 424 /* Delete all children now */ 425 426 AcpiNsDeleteChildren (ChildHandle); 427 428 ChildHandle = ParentHandle; 429 Status = AcpiGetParent (ParentHandle, &ParentHandle); 430 if (ACPI_FAILURE (Status)) 431 { 432 return_ACPI_STATUS (Status); 433 } 434 } 435 } 436 437 /* Now delete the starting object, and we are done */ 438 439 AcpiNsRemoveNode (ChildHandle); 440 return_ACPI_STATUS (AE_OK); 441 } 442 443 444 /******************************************************************************* 445 * 446 * FUNCTION: AcpiNsUnloadNameSpace 447 * 448 * PARAMETERS: Handle - Root of namespace subtree to be deleted 449 * 450 * RETURN: Status 451 * 452 * DESCRIPTION: Shrinks the namespace, typically in response to an undocking 453 * event. Deletes an entire subtree starting from (and 454 * including) the given handle. 455 * 456 ******************************************************************************/ 457 458 ACPI_STATUS 459 AcpiNsUnloadNamespace ( 460 ACPI_HANDLE Handle) 461 { 462 ACPI_STATUS Status; 463 464 465 ACPI_FUNCTION_TRACE (NsUnloadNameSpace); 466 467 468 /* Parameter validation */ 469 470 if (!AcpiGbl_RootNode) 471 { 472 return_ACPI_STATUS (AE_NO_NAMESPACE); 473 } 474 475 if (!Handle) 476 { 477 return_ACPI_STATUS (AE_BAD_PARAMETER); 478 } 479 480 /* This function does the real work */ 481 482 Status = AcpiNsDeleteSubtree (Handle); 483 return_ACPI_STATUS (Status); 484 } 485 #endif 486 #endif 487