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