1 /****************************************************************************** 2 * 3 * Module Name: psxface - Parser external interfaces 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2014, 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 #define __PSXFACE_C__ 117 118 #include "acpi.h" 119 #include "accommon.h" 120 #include "acparser.h" 121 #include "acdispat.h" 122 #include "acinterp.h" 123 #include "actables.h" 124 125 126 #define _COMPONENT ACPI_PARSER 127 ACPI_MODULE_NAME ("psxface") 128 129 /* Local Prototypes */ 130 131 static void 132 AcpiPsStartTrace ( 133 ACPI_EVALUATE_INFO *Info); 134 135 static void 136 AcpiPsStopTrace ( 137 ACPI_EVALUATE_INFO *Info); 138 139 static void 140 AcpiPsUpdateParameterList ( 141 ACPI_EVALUATE_INFO *Info, 142 UINT16 Action); 143 144 145 /******************************************************************************* 146 * 147 * FUNCTION: AcpiDebugTrace 148 * 149 * PARAMETERS: MethodName - Valid ACPI name string 150 * DebugLevel - Optional level mask. 0 to use default 151 * DebugLayer - Optional layer mask. 0 to use default 152 * Flags - bit 1: one shot(1) or persistent(0) 153 * 154 * RETURN: Status 155 * 156 * DESCRIPTION: External interface to enable debug tracing during control 157 * method execution 158 * 159 ******************************************************************************/ 160 161 ACPI_STATUS 162 AcpiDebugTrace ( 163 char *Name, 164 UINT32 DebugLevel, 165 UINT32 DebugLayer, 166 UINT32 Flags) 167 { 168 ACPI_STATUS Status; 169 170 171 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 172 if (ACPI_FAILURE (Status)) 173 { 174 return (Status); 175 } 176 177 /* TBDs: Validate name, allow full path or just nameseg */ 178 179 AcpiGbl_TraceMethodName = *ACPI_CAST_PTR (UINT32, Name); 180 AcpiGbl_TraceFlags = Flags; 181 182 if (DebugLevel) 183 { 184 AcpiGbl_TraceDbgLevel = DebugLevel; 185 } 186 if (DebugLayer) 187 { 188 AcpiGbl_TraceDbgLayer = DebugLayer; 189 } 190 191 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 192 return (AE_OK); 193 } 194 195 196 /******************************************************************************* 197 * 198 * FUNCTION: AcpiPsStartTrace 199 * 200 * PARAMETERS: Info - Method info struct 201 * 202 * RETURN: None 203 * 204 * DESCRIPTION: Start control method execution trace 205 * 206 ******************************************************************************/ 207 208 static void 209 AcpiPsStartTrace ( 210 ACPI_EVALUATE_INFO *Info) 211 { 212 ACPI_STATUS Status; 213 214 215 ACPI_FUNCTION_ENTRY (); 216 217 218 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 219 if (ACPI_FAILURE (Status)) 220 { 221 return; 222 } 223 224 if ((!AcpiGbl_TraceMethodName) || 225 (AcpiGbl_TraceMethodName != Info->Node->Name.Integer)) 226 { 227 goto Exit; 228 } 229 230 AcpiGbl_OriginalDbgLevel = AcpiDbgLevel; 231 AcpiGbl_OriginalDbgLayer = AcpiDbgLayer; 232 233 AcpiDbgLevel = 0x00FFFFFF; 234 AcpiDbgLayer = ACPI_UINT32_MAX; 235 236 if (AcpiGbl_TraceDbgLevel) 237 { 238 AcpiDbgLevel = AcpiGbl_TraceDbgLevel; 239 } 240 if (AcpiGbl_TraceDbgLayer) 241 { 242 AcpiDbgLayer = AcpiGbl_TraceDbgLayer; 243 } 244 245 246 Exit: 247 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 248 } 249 250 251 /******************************************************************************* 252 * 253 * FUNCTION: AcpiPsStopTrace 254 * 255 * PARAMETERS: Info - Method info struct 256 * 257 * RETURN: None 258 * 259 * DESCRIPTION: Stop control method execution trace 260 * 261 ******************************************************************************/ 262 263 static void 264 AcpiPsStopTrace ( 265 ACPI_EVALUATE_INFO *Info) 266 { 267 ACPI_STATUS Status; 268 269 270 ACPI_FUNCTION_ENTRY (); 271 272 273 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 274 if (ACPI_FAILURE (Status)) 275 { 276 return; 277 } 278 279 if ((!AcpiGbl_TraceMethodName) || 280 (AcpiGbl_TraceMethodName != Info->Node->Name.Integer)) 281 { 282 goto Exit; 283 } 284 285 /* Disable further tracing if type is one-shot */ 286 287 if (AcpiGbl_TraceFlags & 1) 288 { 289 AcpiGbl_TraceMethodName = 0; 290 AcpiGbl_TraceDbgLevel = 0; 291 AcpiGbl_TraceDbgLayer = 0; 292 } 293 294 AcpiDbgLevel = AcpiGbl_OriginalDbgLevel; 295 AcpiDbgLayer = AcpiGbl_OriginalDbgLayer; 296 297 Exit: 298 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 299 } 300 301 302 /******************************************************************************* 303 * 304 * FUNCTION: AcpiPsExecuteMethod 305 * 306 * PARAMETERS: Info - Method info block, contains: 307 * Node - Method Node to execute 308 * ObjDesc - Method object 309 * Parameters - List of parameters to pass to the method, 310 * terminated by NULL. Params itself may be 311 * NULL if no parameters are being passed. 312 * ReturnObject - Where to put method's return value (if 313 * any). If NULL, no value is returned. 314 * ParameterType - Type of Parameter list 315 * ReturnObject - Where to put method's return value (if 316 * any). If NULL, no value is returned. 317 * PassNumber - Parse or execute pass 318 * 319 * RETURN: Status 320 * 321 * DESCRIPTION: Execute a control method 322 * 323 ******************************************************************************/ 324 325 ACPI_STATUS 326 AcpiPsExecuteMethod ( 327 ACPI_EVALUATE_INFO *Info) 328 { 329 ACPI_STATUS Status; 330 ACPI_PARSE_OBJECT *Op; 331 ACPI_WALK_STATE *WalkState; 332 333 334 ACPI_FUNCTION_TRACE (PsExecuteMethod); 335 336 337 /* Quick validation of DSDT header */ 338 339 AcpiTbCheckDsdtHeader (); 340 341 /* Validate the Info and method Node */ 342 343 if (!Info || !Info->Node) 344 { 345 return_ACPI_STATUS (AE_NULL_ENTRY); 346 } 347 348 /* Init for new method, wait on concurrency semaphore */ 349 350 Status = AcpiDsBeginMethodExecution (Info->Node, Info->ObjDesc, NULL); 351 if (ACPI_FAILURE (Status)) 352 { 353 return_ACPI_STATUS (Status); 354 } 355 356 /* 357 * The caller "owns" the parameters, so give each one an extra reference 358 */ 359 AcpiPsUpdateParameterList (Info, REF_INCREMENT); 360 361 /* Begin tracing if requested */ 362 363 AcpiPsStartTrace (Info); 364 365 /* 366 * Execute the method. Performs parse simultaneously 367 */ 368 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, 369 "**** Begin Method Parse/Execute [%4.4s] **** Node=%p Obj=%p\n", 370 Info->Node->Name.Ascii, Info->Node, Info->ObjDesc)); 371 372 /* Create and init a Root Node */ 373 374 Op = AcpiPsCreateScopeOp (); 375 if (!Op) 376 { 377 Status = AE_NO_MEMORY; 378 goto Cleanup; 379 } 380 381 /* Create and initialize a new walk state */ 382 383 Info->PassNumber = ACPI_IMODE_EXECUTE; 384 WalkState = AcpiDsCreateWalkState ( 385 Info->ObjDesc->Method.OwnerId, NULL, NULL, NULL); 386 if (!WalkState) 387 { 388 Status = AE_NO_MEMORY; 389 goto Cleanup; 390 } 391 392 Status = AcpiDsInitAmlWalk (WalkState, Op, Info->Node, 393 Info->ObjDesc->Method.AmlStart, 394 Info->ObjDesc->Method.AmlLength, Info, Info->PassNumber); 395 if (ACPI_FAILURE (Status)) 396 { 397 AcpiDsDeleteWalkState (WalkState); 398 goto Cleanup; 399 } 400 401 if (Info->ObjDesc->Method.InfoFlags & ACPI_METHOD_MODULE_LEVEL) 402 { 403 WalkState->ParseFlags |= ACPI_PARSE_MODULE_LEVEL; 404 } 405 406 /* Invoke an internal method if necessary */ 407 408 if (Info->ObjDesc->Method.InfoFlags & ACPI_METHOD_INTERNAL_ONLY) 409 { 410 Status = Info->ObjDesc->Method.Dispatch.Implementation (WalkState); 411 Info->ReturnObject = WalkState->ReturnDesc; 412 413 /* Cleanup states */ 414 415 AcpiDsScopeStackClear (WalkState); 416 AcpiPsCleanupScope (&WalkState->ParserState); 417 AcpiDsTerminateControlMethod (WalkState->MethodDesc, WalkState); 418 AcpiDsDeleteWalkState (WalkState); 419 goto Cleanup; 420 } 421 422 /* 423 * Start method evaluation with an implicit return of zero. 424 * This is done for Windows compatibility. 425 */ 426 if (AcpiGbl_EnableInterpreterSlack) 427 { 428 WalkState->ImplicitReturnObj = 429 AcpiUtCreateIntegerObject ((UINT64) 0); 430 if (!WalkState->ImplicitReturnObj) 431 { 432 Status = AE_NO_MEMORY; 433 AcpiDsDeleteWalkState (WalkState); 434 goto Cleanup; 435 } 436 } 437 438 /* Parse the AML */ 439 440 Status = AcpiPsParseAml (WalkState); 441 442 /* WalkState was deleted by ParseAml */ 443 444 Cleanup: 445 AcpiPsDeleteParseTree (Op); 446 447 /* End optional tracing */ 448 449 AcpiPsStopTrace (Info); 450 451 /* Take away the extra reference that we gave the parameters above */ 452 453 AcpiPsUpdateParameterList (Info, REF_DECREMENT); 454 455 /* Exit now if error above */ 456 457 if (ACPI_FAILURE (Status)) 458 { 459 return_ACPI_STATUS (Status); 460 } 461 462 /* 463 * If the method has returned an object, signal this to the caller with 464 * a control exception code 465 */ 466 if (Info->ReturnObject) 467 { 468 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "Method returned ObjDesc=%p\n", 469 Info->ReturnObject)); 470 ACPI_DUMP_STACK_ENTRY (Info->ReturnObject); 471 472 Status = AE_CTRL_RETURN_VALUE; 473 } 474 475 return_ACPI_STATUS (Status); 476 } 477 478 479 /******************************************************************************* 480 * 481 * FUNCTION: AcpiPsUpdateParameterList 482 * 483 * PARAMETERS: Info - See ACPI_EVALUATE_INFO 484 * (Used: ParameterType and Parameters) 485 * Action - Add or Remove reference 486 * 487 * RETURN: Status 488 * 489 * DESCRIPTION: Update reference count on all method parameter objects 490 * 491 ******************************************************************************/ 492 493 static void 494 AcpiPsUpdateParameterList ( 495 ACPI_EVALUATE_INFO *Info, 496 UINT16 Action) 497 { 498 UINT32 i; 499 500 501 if (Info->Parameters) 502 { 503 /* Update reference count for each parameter */ 504 505 for (i = 0; Info->Parameters[i]; i++) 506 { 507 /* Ignore errors, just do them all */ 508 509 (void) AcpiUtUpdateObjectReference (Info->Parameters[i], Action); 510 } 511 } 512 } 513