1 /****************************************************************************** 2 * 3 * Module Name: nsparse - namespace interface to AML parser 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2018, 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 "acparser.h" 156 #include "acdispat.h" 157 #include "actables.h" 158 #include "acinterp.h" 159 160 161 #define _COMPONENT ACPI_NAMESPACE 162 ACPI_MODULE_NAME ("nsparse") 163 164 165 /******************************************************************************* 166 * 167 * FUNCTION: NsExecuteTable 168 * 169 * PARAMETERS: TableDesc - An ACPI table descriptor for table to parse 170 * StartNode - Where to enter the table into the namespace 171 * 172 * RETURN: Status 173 * 174 * DESCRIPTION: Load ACPI/AML table by executing the entire table as a single 175 * large control method. 176 * 177 * NOTE: The point of this is to execute any module-level code in-place 178 * as the table is parsed. Some AML code depends on this behavior. 179 * 180 * It is a run-time option at this time, but will eventually become 181 * the default. 182 * 183 * Note: This causes the table to only have a single-pass parse. 184 * However, this is compatible with other ACPI implementations. 185 * 186 ******************************************************************************/ 187 188 ACPI_STATUS 189 AcpiNsExecuteTable ( 190 UINT32 TableIndex, 191 ACPI_NAMESPACE_NODE *StartNode) 192 { 193 ACPI_STATUS Status; 194 ACPI_TABLE_HEADER *Table; 195 ACPI_OWNER_ID OwnerId; 196 ACPI_EVALUATE_INFO *Info = NULL; 197 UINT32 AmlLength; 198 UINT8 *AmlStart; 199 ACPI_OPERAND_OBJECT *MethodObj = NULL; 200 201 202 ACPI_FUNCTION_TRACE (NsExecuteTable); 203 204 205 Status = AcpiGetTableByIndex (TableIndex, &Table); 206 if (ACPI_FAILURE (Status)) 207 { 208 return_ACPI_STATUS (Status); 209 } 210 211 /* Table must consist of at least a complete header */ 212 213 if (Table->Length < sizeof (ACPI_TABLE_HEADER)) 214 { 215 return_ACPI_STATUS (AE_BAD_HEADER); 216 } 217 218 AmlStart = (UINT8 *) Table + sizeof (ACPI_TABLE_HEADER); 219 AmlLength = Table->Length - sizeof (ACPI_TABLE_HEADER); 220 221 Status = AcpiTbGetOwnerId (TableIndex, &OwnerId); 222 if (ACPI_FAILURE (Status)) 223 { 224 return_ACPI_STATUS (Status); 225 } 226 227 /* Create, initialize, and link a new temporary method object */ 228 229 MethodObj = AcpiUtCreateInternalObject (ACPI_TYPE_METHOD); 230 if (!MethodObj) 231 { 232 return_ACPI_STATUS (AE_NO_MEMORY); 233 } 234 235 /* Allocate the evaluation information block */ 236 237 Info = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_EVALUATE_INFO)); 238 if (!Info) 239 { 240 Status = AE_NO_MEMORY; 241 goto Cleanup; 242 } 243 244 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_PARSE, 245 "%s: Create table pseudo-method for [%4.4s] @%p, method %p\n", 246 ACPI_GET_FUNCTION_NAME, Table->Signature, Table, MethodObj)); 247 248 MethodObj->Method.AmlStart = AmlStart; 249 MethodObj->Method.AmlLength = AmlLength; 250 MethodObj->Method.OwnerId = OwnerId; 251 MethodObj->Method.InfoFlags |= ACPI_METHOD_MODULE_LEVEL; 252 253 Info->PassNumber = ACPI_IMODE_EXECUTE; 254 Info->Node = StartNode; 255 Info->ObjDesc = MethodObj; 256 Info->NodeFlags = Info->Node->Flags; 257 Info->FullPathname = AcpiNsGetNormalizedPathname (Info->Node, TRUE); 258 if (!Info->FullPathname) 259 { 260 Status = AE_NO_MEMORY; 261 goto Cleanup; 262 } 263 264 Status = AcpiPsExecuteTable (Info); 265 266 Cleanup: 267 if (Info) 268 { 269 ACPI_FREE (Info->FullPathname); 270 Info->FullPathname = NULL; 271 } 272 ACPI_FREE (Info); 273 AcpiUtRemoveReference (MethodObj); 274 return_ACPI_STATUS (Status); 275 } 276 277 278 /******************************************************************************* 279 * 280 * FUNCTION: NsOneCompleteParse 281 * 282 * PARAMETERS: PassNumber - 1 or 2 283 * TableDesc - The table to be parsed. 284 * 285 * RETURN: Status 286 * 287 * DESCRIPTION: Perform one complete parse of an ACPI/AML table. 288 * 289 ******************************************************************************/ 290 291 ACPI_STATUS 292 AcpiNsOneCompleteParse ( 293 UINT32 PassNumber, 294 UINT32 TableIndex, 295 ACPI_NAMESPACE_NODE *StartNode) 296 { 297 ACPI_PARSE_OBJECT *ParseRoot; 298 ACPI_STATUS Status; 299 UINT32 AmlLength; 300 UINT8 *AmlStart; 301 ACPI_WALK_STATE *WalkState; 302 ACPI_TABLE_HEADER *Table; 303 ACPI_OWNER_ID OwnerId; 304 305 306 ACPI_FUNCTION_TRACE (NsOneCompleteParse); 307 308 309 Status = AcpiGetTableByIndex (TableIndex, &Table); 310 if (ACPI_FAILURE (Status)) 311 { 312 return_ACPI_STATUS (Status); 313 } 314 315 /* Table must consist of at least a complete header */ 316 317 if (Table->Length < sizeof (ACPI_TABLE_HEADER)) 318 { 319 return_ACPI_STATUS (AE_BAD_HEADER); 320 } 321 322 AmlStart = (UINT8 *) Table + sizeof (ACPI_TABLE_HEADER); 323 AmlLength = Table->Length - sizeof (ACPI_TABLE_HEADER); 324 325 Status = AcpiTbGetOwnerId (TableIndex, &OwnerId); 326 if (ACPI_FAILURE (Status)) 327 { 328 return_ACPI_STATUS (Status); 329 } 330 331 /* Create and init a Root Node */ 332 333 ParseRoot = AcpiPsCreateScopeOp (AmlStart); 334 if (!ParseRoot) 335 { 336 return_ACPI_STATUS (AE_NO_MEMORY); 337 } 338 339 /* Create and initialize a new walk state */ 340 341 WalkState = AcpiDsCreateWalkState (OwnerId, NULL, NULL, NULL); 342 if (!WalkState) 343 { 344 AcpiPsFreeOp (ParseRoot); 345 return_ACPI_STATUS (AE_NO_MEMORY); 346 } 347 348 Status = AcpiDsInitAmlWalk (WalkState, ParseRoot, NULL, 349 AmlStart, AmlLength, NULL, (UINT8) PassNumber); 350 if (ACPI_FAILURE (Status)) 351 { 352 AcpiDsDeleteWalkState (WalkState); 353 goto Cleanup; 354 } 355 356 /* Found OSDT table, enable the namespace override feature */ 357 358 if (ACPI_COMPARE_NAME(Table->Signature, ACPI_SIG_OSDT) && 359 PassNumber == ACPI_IMODE_LOAD_PASS1) 360 { 361 WalkState->NamespaceOverride = TRUE; 362 } 363 364 /* StartNode is the default location to load the table */ 365 366 if (StartNode && StartNode != AcpiGbl_RootNode) 367 { 368 Status = AcpiDsScopeStackPush ( 369 StartNode, ACPI_TYPE_METHOD, WalkState); 370 if (ACPI_FAILURE (Status)) 371 { 372 AcpiDsDeleteWalkState (WalkState); 373 goto Cleanup; 374 } 375 } 376 377 /* Parse the AML */ 378 379 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, 380 "*PARSE* pass %u parse\n", PassNumber)); 381 AcpiExEnterInterpreter (); 382 Status = AcpiPsParseAml (WalkState); 383 AcpiExExitInterpreter (); 384 385 Cleanup: 386 AcpiPsDeleteParseTree (ParseRoot); 387 return_ACPI_STATUS (Status); 388 } 389 390 391 /******************************************************************************* 392 * 393 * FUNCTION: AcpiNsParseTable 394 * 395 * PARAMETERS: TableDesc - An ACPI table descriptor for table to parse 396 * StartNode - Where to enter the table into the namespace 397 * 398 * RETURN: Status 399 * 400 * DESCRIPTION: Parse AML within an ACPI table and return a tree of ops 401 * 402 ******************************************************************************/ 403 404 ACPI_STATUS 405 AcpiNsParseTable ( 406 UINT32 TableIndex, 407 ACPI_NAMESPACE_NODE *StartNode) 408 { 409 ACPI_STATUS Status; 410 411 412 ACPI_FUNCTION_TRACE (NsParseTable); 413 414 415 if (AcpiGbl_ExecuteTablesAsMethods) 416 { 417 /* 418 * This case executes the AML table as one large control method. 419 * The point of this is to execute any module-level code in-place 420 * as the table is parsed. Some AML code depends on this behavior. 421 * 422 * It is a run-time option at this time, but will eventually become 423 * the default. 424 * 425 * Note: This causes the table to only have a single-pass parse. 426 * However, this is compatible with other ACPI implementations. 427 */ 428 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_PARSE, 429 "%s: **** Start table execution pass\n", ACPI_GET_FUNCTION_NAME)); 430 431 Status = AcpiNsExecuteTable (TableIndex, StartNode); 432 if (ACPI_FAILURE (Status)) 433 { 434 return_ACPI_STATUS (Status); 435 } 436 } 437 else 438 { 439 /* 440 * AML Parse, pass 1 441 * 442 * In this pass, we load most of the namespace. Control methods 443 * are not parsed until later. A parse tree is not created. 444 * Instead, each Parser Op subtree is deleted when it is finished. 445 * This saves a great deal of memory, and allows a small cache of 446 * parse objects to service the entire parse. The second pass of 447 * the parse then performs another complete parse of the AML. 448 */ 449 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "**** Start pass 1\n")); 450 451 Status = AcpiNsOneCompleteParse (ACPI_IMODE_LOAD_PASS1, 452 TableIndex, StartNode); 453 if (ACPI_FAILURE (Status)) 454 { 455 return_ACPI_STATUS (Status); 456 } 457 458 /* 459 * AML Parse, pass 2 460 * 461 * In this pass, we resolve forward references and other things 462 * that could not be completed during the first pass. 463 * Another complete parse of the AML is performed, but the 464 * overhead of this is compensated for by the fact that the 465 * parse objects are all cached. 466 */ 467 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "**** Start pass 2\n")); 468 Status = AcpiNsOneCompleteParse (ACPI_IMODE_LOAD_PASS2, 469 TableIndex, StartNode); 470 if (ACPI_FAILURE (Status)) 471 { 472 return_ACPI_STATUS (Status); 473 } 474 } 475 476 return_ACPI_STATUS (Status); 477 } 478