1 /******************************************************************************* 2 * 3 * Module Name: nseval - Object evaluation, includes control method execution 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 * 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 * Alternatively, you may choose to be licensed under the terms of the 118 * following license: 119 * 120 * Redistribution and use in source and binary forms, with or without 121 * modification, are permitted provided that the following conditions 122 * are met: 123 * 1. Redistributions of source code must retain the above copyright 124 * notice, this list of conditions, and the following disclaimer, 125 * without modification. 126 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 127 * substantially similar to the "NO WARRANTY" disclaimer below 128 * ("Disclaimer") and any redistribution must be conditioned upon 129 * including a substantially similar Disclaimer requirement for further 130 * binary redistribution. 131 * 3. Neither the names of the above-listed copyright holders nor the names 132 * of any contributors may be used to endorse or promote products derived 133 * from this software without specific prior written permission. 134 * 135 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 136 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 137 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 138 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 139 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 140 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 141 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 142 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 143 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 144 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 145 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 146 * 147 * Alternatively, you may choose to be licensed under the terms of the 148 * GNU General Public License ("GPL") version 2 as published by the Free 149 * Software Foundation. 150 * 151 *****************************************************************************/ 152 153 #include <contrib/dev/acpica/include/acpi.h> 154 #include <contrib/dev/acpica/include/accommon.h> 155 #include <contrib/dev/acpica/include/acparser.h> 156 #include <contrib/dev/acpica/include/acinterp.h> 157 #include <contrib/dev/acpica/include/acnamesp.h> 158 159 160 #define _COMPONENT ACPI_NAMESPACE 161 ACPI_MODULE_NAME ("nseval") 162 163 /* Local prototypes */ 164 165 static void 166 AcpiNsExecModuleCode ( 167 ACPI_OPERAND_OBJECT *MethodObj, 168 ACPI_EVALUATE_INFO *Info); 169 170 171 /******************************************************************************* 172 * 173 * FUNCTION: AcpiNsEvaluate 174 * 175 * PARAMETERS: Info - Evaluation info block, contains these fields 176 * and more: 177 * PrefixNode - Prefix or Method/Object Node to execute 178 * RelativePath - Name of method to execute, If NULL, the 179 * Node is the object to execute 180 * Parameters - List of parameters to pass to the method, 181 * terminated by NULL. Params itself may be 182 * NULL if no parameters are being passed. 183 * ParameterType - Type of Parameter list 184 * ReturnObject - Where to put method's return value (if 185 * any). If NULL, no value is returned. 186 * Flags - ACPI_IGNORE_RETURN_VALUE to delete return 187 * 188 * RETURN: Status 189 * 190 * DESCRIPTION: Execute a control method or return the current value of an 191 * ACPI namespace object. 192 * 193 * MUTEX: Locks interpreter 194 * 195 ******************************************************************************/ 196 197 ACPI_STATUS 198 AcpiNsEvaluate ( 199 ACPI_EVALUATE_INFO *Info) 200 { 201 ACPI_STATUS Status; 202 203 204 ACPI_FUNCTION_TRACE (NsEvaluate); 205 206 207 if (!Info) 208 { 209 return_ACPI_STATUS (AE_BAD_PARAMETER); 210 } 211 212 if (!Info->Node) 213 { 214 /* 215 * Get the actual namespace node for the target object if we 216 * need to. Handles these cases: 217 * 218 * 1) Null node, valid pathname from root (absolute path) 219 * 2) Node and valid pathname (path relative to Node) 220 * 3) Node, Null pathname 221 */ 222 Status = AcpiNsGetNode (Info->PrefixNode, Info->RelativePathname, 223 ACPI_NS_NO_UPSEARCH, &Info->Node); 224 if (ACPI_FAILURE (Status)) 225 { 226 return_ACPI_STATUS (Status); 227 } 228 } 229 230 /* 231 * For a method alias, we must grab the actual method node so that 232 * proper scoping context will be established before execution. 233 */ 234 if (AcpiNsGetType (Info->Node) == ACPI_TYPE_LOCAL_METHOD_ALIAS) 235 { 236 Info->Node = ACPI_CAST_PTR ( 237 ACPI_NAMESPACE_NODE, Info->Node->Object); 238 } 239 240 /* Complete the info block initialization */ 241 242 Info->ReturnObject = NULL; 243 Info->NodeFlags = Info->Node->Flags; 244 Info->ObjDesc = AcpiNsGetAttachedObject (Info->Node); 245 246 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "%s [%p] Value %p\n", 247 Info->RelativePathname, Info->Node, 248 AcpiNsGetAttachedObject (Info->Node))); 249 250 /* Get info if we have a predefined name (_HID, etc.) */ 251 252 Info->Predefined = AcpiUtMatchPredefinedMethod (Info->Node->Name.Ascii); 253 254 /* Get the full pathname to the object, for use in warning messages */ 255 256 Info->FullPathname = AcpiNsGetNormalizedPathname (Info->Node, TRUE); 257 if (!Info->FullPathname) 258 { 259 return_ACPI_STATUS (AE_NO_MEMORY); 260 } 261 262 /* Count the number of arguments being passed in */ 263 264 Info->ParamCount = 0; 265 if (Info->Parameters) 266 { 267 while (Info->Parameters[Info->ParamCount]) 268 { 269 Info->ParamCount++; 270 } 271 272 /* Warn on impossible argument count */ 273 274 if (Info->ParamCount > ACPI_METHOD_NUM_ARGS) 275 { 276 ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, ACPI_WARN_ALWAYS, 277 "Excess arguments (%u) - using only %u", 278 Info->ParamCount, ACPI_METHOD_NUM_ARGS)); 279 280 Info->ParamCount = ACPI_METHOD_NUM_ARGS; 281 } 282 } 283 284 /* 285 * For predefined names: Check that the declared argument count 286 * matches the ACPI spec -- otherwise this is a BIOS error. 287 */ 288 AcpiNsCheckAcpiCompliance (Info->FullPathname, Info->Node, 289 Info->Predefined); 290 291 /* 292 * For all names: Check that the incoming argument count for 293 * this method/object matches the actual ASL/AML definition. 294 */ 295 AcpiNsCheckArgumentCount (Info->FullPathname, Info->Node, 296 Info->ParamCount, Info->Predefined); 297 298 /* For predefined names: Typecheck all incoming arguments */ 299 300 AcpiNsCheckArgumentTypes (Info); 301 302 /* 303 * Three major evaluation cases: 304 * 305 * 1) Object types that cannot be evaluated by definition 306 * 2) The object is a control method -- execute it 307 * 3) The object is not a method -- just return it's current value 308 */ 309 switch (AcpiNsGetType (Info->Node)) 310 { 311 case ACPI_TYPE_ANY: 312 case ACPI_TYPE_DEVICE: 313 case ACPI_TYPE_EVENT: 314 case ACPI_TYPE_MUTEX: 315 case ACPI_TYPE_REGION: 316 case ACPI_TYPE_THERMAL: 317 case ACPI_TYPE_LOCAL_SCOPE: 318 /* 319 * 1) Disallow evaluation of these object types. For these, 320 * object evaluation is undefined. 321 */ 322 ACPI_ERROR ((AE_INFO, 323 "%s: This object type [%s] " 324 "never contains data and cannot be evaluated", 325 Info->FullPathname, AcpiUtGetTypeName (Info->Node->Type))); 326 327 Status = AE_TYPE; 328 goto Cleanup; 329 330 case ACPI_TYPE_METHOD: 331 /* 332 * 2) Object is a control method - execute it 333 */ 334 335 /* Verify that there is a method object associated with this node */ 336 337 if (!Info->ObjDesc) 338 { 339 ACPI_ERROR ((AE_INFO, "%s: Method has no attached sub-object", 340 Info->FullPathname)); 341 Status = AE_NULL_OBJECT; 342 goto Cleanup; 343 } 344 345 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, 346 "**** Execute method [%s] at AML address %p length %X\n", 347 Info->FullPathname, 348 Info->ObjDesc->Method.AmlStart + 1, 349 Info->ObjDesc->Method.AmlLength - 1)); 350 351 /* 352 * Any namespace deletion must acquire both the namespace and 353 * interpreter locks to ensure that no thread is using the portion of 354 * the namespace that is being deleted. 355 * 356 * Execute the method via the interpreter. The interpreter is locked 357 * here before calling into the AML parser 358 */ 359 AcpiExEnterInterpreter (); 360 Status = AcpiPsExecuteMethod (Info); 361 AcpiExExitInterpreter (); 362 break; 363 364 default: 365 /* 366 * 3) All other non-method objects -- get the current object value 367 */ 368 369 /* 370 * Some objects require additional resolution steps (e.g., the Node 371 * may be a field that must be read, etc.) -- we can't just grab 372 * the object out of the node. 373 * 374 * Use ResolveNodeToValue() to get the associated value. 375 * 376 * NOTE: we can get away with passing in NULL for a walk state because 377 * the Node is guaranteed to not be a reference to either a method 378 * local or a method argument (because this interface is never called 379 * from a running method.) 380 * 381 * Even though we do not directly invoke the interpreter for object 382 * resolution, we must lock it because we could access an OpRegion. 383 * The OpRegion access code assumes that the interpreter is locked. 384 */ 385 AcpiExEnterInterpreter (); 386 387 /* TBD: ResolveNodeToValue has a strange interface, fix */ 388 389 Info->ReturnObject = ACPI_CAST_PTR (ACPI_OPERAND_OBJECT, Info->Node); 390 391 Status = AcpiExResolveNodeToValue (ACPI_CAST_INDIRECT_PTR ( 392 ACPI_NAMESPACE_NODE, &Info->ReturnObject), NULL); 393 AcpiExExitInterpreter (); 394 395 if (ACPI_FAILURE (Status)) 396 { 397 Info->ReturnObject = NULL; 398 goto Cleanup; 399 } 400 401 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "Returned object %p [%s]\n", 402 Info->ReturnObject, 403 AcpiUtGetObjectTypeName (Info->ReturnObject))); 404 405 Status = AE_CTRL_RETURN_VALUE; /* Always has a "return value" */ 406 break; 407 } 408 409 /* 410 * For predefined names, check the return value against the ACPI 411 * specification. Some incorrect return value types are repaired. 412 */ 413 (void) AcpiNsCheckReturnValue (Info->Node, Info, Info->ParamCount, 414 Status, &Info->ReturnObject); 415 416 /* Check if there is a return value that must be dealt with */ 417 418 if (Status == AE_CTRL_RETURN_VALUE) 419 { 420 /* If caller does not want the return value, delete it */ 421 422 if (Info->Flags & ACPI_IGNORE_RETURN_VALUE) 423 { 424 AcpiUtRemoveReference (Info->ReturnObject); 425 Info->ReturnObject = NULL; 426 } 427 428 /* Map AE_CTRL_RETURN_VALUE to AE_OK, we are done with it */ 429 430 Status = AE_OK; 431 } 432 433 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, 434 "*** Completed evaluation of object %s ***\n", 435 Info->RelativePathname)); 436 437 Cleanup: 438 /* 439 * Namespace was unlocked by the handling AcpiNs* function, so we 440 * just free the pathname and return 441 */ 442 ACPI_FREE (Info->FullPathname); 443 Info->FullPathname = NULL; 444 return_ACPI_STATUS (Status); 445 } 446 447 448 /******************************************************************************* 449 * 450 * FUNCTION: AcpiNsExecModuleCodeList 451 * 452 * PARAMETERS: None 453 * 454 * RETURN: None. Exceptions during method execution are ignored, since 455 * we cannot abort a table load. 456 * 457 * DESCRIPTION: Execute all elements of the global module-level code list. 458 * Each element is executed as a single control method. 459 * 460 ******************************************************************************/ 461 462 void 463 AcpiNsExecModuleCodeList ( 464 void) 465 { 466 ACPI_OPERAND_OBJECT *Prev; 467 ACPI_OPERAND_OBJECT *Next; 468 ACPI_EVALUATE_INFO *Info; 469 UINT32 MethodCount = 0; 470 471 472 ACPI_FUNCTION_TRACE (NsExecModuleCodeList); 473 474 475 /* Exit now if the list is empty */ 476 477 Next = AcpiGbl_ModuleCodeList; 478 if (!Next) 479 { 480 return_VOID; 481 } 482 483 /* Allocate the evaluation information block */ 484 485 Info = ACPI_ALLOCATE (sizeof (ACPI_EVALUATE_INFO)); 486 if (!Info) 487 { 488 return_VOID; 489 } 490 491 /* Walk the list, executing each "method" */ 492 493 while (Next) 494 { 495 Prev = Next; 496 Next = Next->Method.Mutex; 497 498 /* Clear the link field and execute the method */ 499 500 Prev->Method.Mutex = NULL; 501 AcpiNsExecModuleCode (Prev, Info); 502 MethodCount++; 503 504 /* Delete the (temporary) method object */ 505 506 AcpiUtRemoveReference (Prev); 507 } 508 509 ACPI_INFO (( 510 "Executed %u blocks of module-level executable AML code", 511 MethodCount)); 512 513 ACPI_FREE (Info); 514 AcpiGbl_ModuleCodeList = NULL; 515 return_VOID; 516 } 517 518 519 /******************************************************************************* 520 * 521 * FUNCTION: AcpiNsExecModuleCode 522 * 523 * PARAMETERS: MethodObj - Object container for the module-level code 524 * Info - Info block for method evaluation 525 * 526 * RETURN: None. Exceptions during method execution are ignored, since 527 * we cannot abort a table load. 528 * 529 * DESCRIPTION: Execute a control method containing a block of module-level 530 * executable AML code. The control method is temporarily 531 * installed to the root node, then evaluated. 532 * 533 ******************************************************************************/ 534 535 static void 536 AcpiNsExecModuleCode ( 537 ACPI_OPERAND_OBJECT *MethodObj, 538 ACPI_EVALUATE_INFO *Info) 539 { 540 ACPI_OPERAND_OBJECT *ParentObj; 541 ACPI_NAMESPACE_NODE *ParentNode; 542 ACPI_OBJECT_TYPE Type; 543 ACPI_STATUS Status; 544 545 546 ACPI_FUNCTION_TRACE (NsExecModuleCode); 547 548 549 /* 550 * Get the parent node. We cheat by using the NextObject field 551 * of the method object descriptor. 552 */ 553 ParentNode = ACPI_CAST_PTR ( 554 ACPI_NAMESPACE_NODE, MethodObj->Method.NextObject); 555 Type = AcpiNsGetType (ParentNode); 556 557 /* 558 * Get the region handler and save it in the method object. We may need 559 * this if an operation region declaration causes a _REG method to be run. 560 * 561 * We can't do this in AcpiPsLinkModuleCode because 562 * AcpiGbl_RootNode->Object is NULL at PASS1. 563 */ 564 if ((Type == ACPI_TYPE_DEVICE) && ParentNode->Object) 565 { 566 MethodObj->Method.Dispatch.Handler = 567 ParentNode->Object->Device.Handler; 568 } 569 570 /* Must clear NextObject (AcpiNsAttachObject needs the field) */ 571 572 MethodObj->Method.NextObject = NULL; 573 574 /* Initialize the evaluation information block */ 575 576 memset (Info, 0, sizeof (ACPI_EVALUATE_INFO)); 577 Info->PrefixNode = ParentNode; 578 579 /* 580 * Get the currently attached parent object. Add a reference, 581 * because the ref count will be decreased when the method object 582 * is installed to the parent node. 583 */ 584 ParentObj = AcpiNsGetAttachedObject (ParentNode); 585 if (ParentObj) 586 { 587 AcpiUtAddReference (ParentObj); 588 } 589 590 /* Install the method (module-level code) in the parent node */ 591 592 Status = AcpiNsAttachObject (ParentNode, MethodObj, ACPI_TYPE_METHOD); 593 if (ACPI_FAILURE (Status)) 594 { 595 goto Exit; 596 } 597 598 /* Execute the parent node as a control method */ 599 600 Status = AcpiNsEvaluate (Info); 601 602 ACPI_DEBUG_PRINT ((ACPI_DB_INIT_NAMES, 603 "Executed module-level code at %p\n", 604 MethodObj->Method.AmlStart)); 605 606 /* Delete a possible implicit return value (in slack mode) */ 607 608 if (Info->ReturnObject) 609 { 610 AcpiUtRemoveReference (Info->ReturnObject); 611 } 612 613 /* Detach the temporary method object */ 614 615 AcpiNsDetachObject (ParentNode); 616 617 /* Restore the original parent object */ 618 619 if (ParentObj) 620 { 621 Status = AcpiNsAttachObject (ParentNode, ParentObj, Type); 622 } 623 else 624 { 625 ParentNode->Type = (UINT8) Type; 626 } 627 628 Exit: 629 if (ParentObj) 630 { 631 AcpiUtRemoveReference (ParentObj); 632 } 633 return_VOID; 634 } 635