1 /****************************************************************************** 2 * 3 * Module Name: psxface - Parser external interfaces 4 * $Revision: 1.94 $ 5 * 6 *****************************************************************************/ 7 8 /****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2008, Intel Corp. 13 * All rights reserved. 14 * 15 * 2. License 16 * 17 * 2.1. This is your license from Intel Corp. under its intellectual property 18 * rights. You may have additional license terms from the party that provided 19 * you this software, covering your right to use that party's intellectual 20 * property rights. 21 * 22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 23 * copy of the source code appearing in this file ("Covered Code") an 24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 25 * base code distributed originally by Intel ("Original Intel Code") to copy, 26 * make derivatives, distribute, use and display any portion of the Covered 27 * Code in any form, with the right to sublicense such rights; and 28 * 29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 30 * license (with the right to sublicense), under only those claims of Intel 31 * patents that are infringed by the Original Intel Code, to make, use, sell, 32 * offer to sell, and import the Covered Code and derivative works thereof 33 * solely to the minimum extent necessary to exercise the above copyright 34 * license, and in no event shall the patent license extend to any additions 35 * to or modifications of the Original Intel Code. No other license or right 36 * is granted directly or by implication, estoppel or otherwise; 37 * 38 * The above copyright and patent license is granted only if the following 39 * conditions are met: 40 * 41 * 3. Conditions 42 * 43 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 44 * Redistribution of source code of any substantial portion of the Covered 45 * Code or modification with rights to further distribute source must include 46 * the above Copyright Notice, the above License, this list of Conditions, 47 * and the following Disclaimer and Export Compliance provision. In addition, 48 * Licensee must cause all Covered Code to which Licensee contributes to 49 * contain a file documenting the changes Licensee made to create that Covered 50 * Code and the date of any change. Licensee must include in that file the 51 * documentation of any changes made by any predecessor Licensee. Licensee 52 * must include a prominent statement that the modification is derived, 53 * directly or indirectly, from Original Intel Code. 54 * 55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 56 * Redistribution of source code of any substantial portion of the Covered 57 * Code or modification without rights to further distribute source must 58 * include the following Disclaimer and Export Compliance provision in the 59 * documentation and/or other materials provided with distribution. In 60 * addition, Licensee may not authorize further sublicense of source of any 61 * portion of the Covered Code, and must include terms to the effect that the 62 * license from Licensee to its licensee is limited to the intellectual 63 * property embodied in the software Licensee provides to its licensee, and 64 * not to intellectual property embodied in modifications its licensee may 65 * make. 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 __PSXFACE_C__ 118 119 #include "acpi.h" 120 #include "acparser.h" 121 #include "acdispat.h" 122 #include "acinterp.h" 123 124 125 #define _COMPONENT ACPI_PARSER 126 ACPI_MODULE_NAME ("psxface") 127 128 /* Local Prototypes */ 129 130 static void 131 AcpiPsStartTrace ( 132 ACPI_EVALUATE_INFO *Info); 133 134 static void 135 AcpiPsStopTrace ( 136 ACPI_EVALUATE_INFO *Info); 137 138 static void 139 AcpiPsUpdateParameterList ( 140 ACPI_EVALUATE_INFO *Info, 141 UINT16 Action); 142 143 144 /******************************************************************************* 145 * 146 * FUNCTION: AcpiDebugTrace 147 * 148 * PARAMETERS: MethodName - Valid ACPI name string 149 * DebugLevel - Optional level mask. 0 to use default 150 * DebugLayer - Optional layer mask. 0 to use default 151 * Flags - bit 1: one shot(1) or persistent(0) 152 * 153 * RETURN: Status 154 * 155 * DESCRIPTION: External interface to enable debug tracing during control 156 * method execution 157 * 158 ******************************************************************************/ 159 160 ACPI_STATUS 161 AcpiDebugTrace ( 162 char *Name, 163 UINT32 DebugLevel, 164 UINT32 DebugLayer, 165 UINT32 Flags) 166 { 167 ACPI_STATUS Status; 168 169 170 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 171 if (ACPI_FAILURE (Status)) 172 { 173 return (Status); 174 } 175 176 /* TBDs: Validate name, allow full path or just nameseg */ 177 178 AcpiGbl_TraceMethodName = *ACPI_CAST_PTR (UINT32, Name); 179 AcpiGbl_TraceFlags = Flags; 180 181 if (DebugLevel) 182 { 183 AcpiGbl_TraceDbgLevel = DebugLevel; 184 } 185 if (DebugLayer) 186 { 187 AcpiGbl_TraceDbgLayer = DebugLayer; 188 } 189 190 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 191 return (AE_OK); 192 } 193 194 195 /******************************************************************************* 196 * 197 * FUNCTION: AcpiPsStartTrace 198 * 199 * PARAMETERS: Info - Method info struct 200 * 201 * RETURN: None 202 * 203 * DESCRIPTION: Start control method execution trace 204 * 205 ******************************************************************************/ 206 207 static void 208 AcpiPsStartTrace ( 209 ACPI_EVALUATE_INFO *Info) 210 { 211 ACPI_STATUS Status; 212 213 214 ACPI_FUNCTION_ENTRY (); 215 216 217 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 218 if (ACPI_FAILURE (Status)) 219 { 220 return; 221 } 222 223 if ((!AcpiGbl_TraceMethodName) || 224 (AcpiGbl_TraceMethodName != Info->ResolvedNode->Name.Integer)) 225 { 226 goto Exit; 227 } 228 229 AcpiGbl_OriginalDbgLevel = AcpiDbgLevel; 230 AcpiGbl_OriginalDbgLayer = AcpiDbgLayer; 231 232 AcpiDbgLevel = 0x00FFFFFF; 233 AcpiDbgLayer = ACPI_UINT32_MAX; 234 235 if (AcpiGbl_TraceDbgLevel) 236 { 237 AcpiDbgLevel = AcpiGbl_TraceDbgLevel; 238 } 239 if (AcpiGbl_TraceDbgLayer) 240 { 241 AcpiDbgLayer = AcpiGbl_TraceDbgLayer; 242 } 243 244 245 Exit: 246 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 247 } 248 249 250 /******************************************************************************* 251 * 252 * FUNCTION: AcpiPsStopTrace 253 * 254 * PARAMETERS: Info - Method info struct 255 * 256 * RETURN: None 257 * 258 * DESCRIPTION: Stop control method execution trace 259 * 260 ******************************************************************************/ 261 262 static void 263 AcpiPsStopTrace ( 264 ACPI_EVALUATE_INFO *Info) 265 { 266 ACPI_STATUS Status; 267 268 269 ACPI_FUNCTION_ENTRY (); 270 271 272 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 273 if (ACPI_FAILURE (Status)) 274 { 275 return; 276 } 277 278 if ((!AcpiGbl_TraceMethodName) || 279 (AcpiGbl_TraceMethodName != Info->ResolvedNode->Name.Integer)) 280 { 281 goto Exit; 282 } 283 284 /* Disable further tracing if type is one-shot */ 285 286 if (AcpiGbl_TraceFlags & 1) 287 { 288 AcpiGbl_TraceMethodName = 0; 289 AcpiGbl_TraceDbgLevel = 0; 290 AcpiGbl_TraceDbgLayer = 0; 291 } 292 293 AcpiDbgLevel = AcpiGbl_OriginalDbgLevel; 294 AcpiDbgLayer = AcpiGbl_OriginalDbgLayer; 295 296 Exit: 297 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 298 } 299 300 301 /******************************************************************************* 302 * 303 * FUNCTION: AcpiPsExecuteMethod 304 * 305 * PARAMETERS: Info - Method info block, contains: 306 * Node - Method Node to execute 307 * ObjDesc - Method object 308 * Parameters - List of parameters to pass to the method, 309 * terminated by NULL. Params itself may be 310 * NULL if no parameters are being passed. 311 * ReturnObject - Where to put method's return value (if 312 * any). If NULL, no value is returned. 313 * ParameterType - Type of Parameter list 314 * ReturnObject - Where to put method's return value (if 315 * any). If NULL, no value is returned. 316 * PassNumber - Parse or execute pass 317 * 318 * RETURN: Status 319 * 320 * DESCRIPTION: Execute a control method 321 * 322 ******************************************************************************/ 323 324 ACPI_STATUS 325 AcpiPsExecuteMethod ( 326 ACPI_EVALUATE_INFO *Info) 327 { 328 ACPI_STATUS Status; 329 ACPI_PARSE_OBJECT *Op; 330 ACPI_WALK_STATE *WalkState; 331 332 333 ACPI_FUNCTION_TRACE (PsExecuteMethod); 334 335 336 /* Validate the Info and method Node */ 337 338 if (!Info || !Info->ResolvedNode) 339 { 340 return_ACPI_STATUS (AE_NULL_ENTRY); 341 } 342 343 /* Init for new method, wait on concurrency semaphore */ 344 345 Status = AcpiDsBeginMethodExecution (Info->ResolvedNode, Info->ObjDesc, NULL); 346 if (ACPI_FAILURE (Status)) 347 { 348 return_ACPI_STATUS (Status); 349 } 350 351 /* 352 * The caller "owns" the parameters, so give each one an extra reference 353 */ 354 AcpiPsUpdateParameterList (Info, REF_INCREMENT); 355 356 /* Begin tracing if requested */ 357 358 AcpiPsStartTrace (Info); 359 360 /* 361 * Execute the method. Performs parse simultaneously 362 */ 363 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, 364 "**** Begin Method Parse/Execute [%4.4s] **** Node=%p Obj=%p\n", 365 Info->ResolvedNode->Name.Ascii, Info->ResolvedNode, Info->ObjDesc)); 366 367 /* Create and init a Root Node */ 368 369 Op = AcpiPsCreateScopeOp (); 370 if (!Op) 371 { 372 Status = AE_NO_MEMORY; 373 goto Cleanup; 374 } 375 376 /* Create and initialize a new walk state */ 377 378 Info->PassNumber = ACPI_IMODE_EXECUTE; 379 WalkState = AcpiDsCreateWalkState ( 380 Info->ObjDesc->Method.OwnerId, NULL, NULL, NULL); 381 if (!WalkState) 382 { 383 Status = AE_NO_MEMORY; 384 goto Cleanup; 385 } 386 387 Status = AcpiDsInitAmlWalk (WalkState, Op, Info->ResolvedNode, 388 Info->ObjDesc->Method.AmlStart, 389 Info->ObjDesc->Method.AmlLength, Info, Info->PassNumber); 390 if (ACPI_FAILURE (Status)) 391 { 392 AcpiDsDeleteWalkState (WalkState); 393 goto Cleanup; 394 } 395 396 /* Parse the AML */ 397 398 Status = AcpiPsParseAml (WalkState); 399 400 /* WalkState was deleted by ParseAml */ 401 402 Cleanup: 403 AcpiPsDeleteParseTree (Op); 404 405 /* End optional tracing */ 406 407 AcpiPsStopTrace (Info); 408 409 /* Take away the extra reference that we gave the parameters above */ 410 411 AcpiPsUpdateParameterList (Info, REF_DECREMENT); 412 413 /* Exit now if error above */ 414 415 if (ACPI_FAILURE (Status)) 416 { 417 return_ACPI_STATUS (Status); 418 } 419 420 /* 421 * If the method has returned an object, signal this to the caller with 422 * a control exception code 423 */ 424 if (Info->ReturnObject) 425 { 426 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "Method returned ObjDesc=%p\n", 427 Info->ReturnObject)); 428 ACPI_DUMP_STACK_ENTRY (Info->ReturnObject); 429 430 Status = AE_CTRL_RETURN_VALUE; 431 } 432 433 return_ACPI_STATUS (Status); 434 } 435 436 437 /******************************************************************************* 438 * 439 * FUNCTION: AcpiPsUpdateParameterList 440 * 441 * PARAMETERS: Info - See ACPI_EVALUATE_INFO 442 * (Used: ParameterType and Parameters) 443 * Action - Add or Remove reference 444 * 445 * RETURN: Status 446 * 447 * DESCRIPTION: Update reference count on all method parameter objects 448 * 449 ******************************************************************************/ 450 451 static void 452 AcpiPsUpdateParameterList ( 453 ACPI_EVALUATE_INFO *Info, 454 UINT16 Action) 455 { 456 UINT32 i; 457 458 459 if (Info->Parameters) 460 { 461 /* Update reference count for each parameter */ 462 463 for (i = 0; Info->Parameters[i]; i++) 464 { 465 /* Ignore errors, just do them all */ 466 467 (void) AcpiUtUpdateObjectReference (Info->Parameters[i], Action); 468 } 469 } 470 } 471 472 473