1 /******************************************************************************
3 * Module Name: psxface - Parser external interfaces
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************/
116 #define __PSXFACE_C__
119 #include "accommon.h"
120 #include "acparser.h"
121 #include "acdispat.h"
122 #include "acinterp.h"
123 #include "actables.h"
127 #define _COMPONENT ACPI_PARSER
128 ACPI_MODULE_NAME ("psxface")
130 /* Local Prototypes */
134 ACPI_EVALUATE_INFO
*Info
);
138 ACPI_EVALUATE_INFO
*Info
);
141 AcpiPsUpdateParameterList (
142 ACPI_EVALUATE_INFO
*Info
,
146 /*******************************************************************************
148 * FUNCTION: AcpiDebugTrace
150 * PARAMETERS: MethodName - Valid ACPI name string
151 * DebugLevel - Optional level mask. 0 to use default
152 * DebugLayer - Optional layer mask. 0 to use default
153 * Flags - bit 1: one shot(1) or persistent(0)
157 * DESCRIPTION: External interface to enable debug tracing during control
160 ******************************************************************************/
172 Status
= AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE
);
173 if (ACPI_FAILURE (Status
))
178 /* TBDs: Validate name, allow full path or just nameseg */
180 AcpiGbl_TraceMethodName
= *ACPI_CAST_PTR (UINT32
, Name
);
181 AcpiGbl_TraceFlags
= Flags
;
185 AcpiGbl_TraceDbgLevel
= DebugLevel
;
189 AcpiGbl_TraceDbgLayer
= DebugLayer
;
192 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE
);
197 /*******************************************************************************
199 * FUNCTION: AcpiPsStartTrace
201 * PARAMETERS: Info - Method info struct
205 * DESCRIPTION: Start control method execution trace
207 ******************************************************************************/
211 ACPI_EVALUATE_INFO
*Info
)
216 ACPI_FUNCTION_ENTRY ();
219 Status
= AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE
);
220 if (ACPI_FAILURE (Status
))
225 if ((!AcpiGbl_TraceMethodName
) ||
226 (AcpiGbl_TraceMethodName
!= Info
->ResolvedNode
->Name
.Integer
))
231 AcpiGbl_OriginalDbgLevel
= AcpiDbgLevel
;
232 AcpiGbl_OriginalDbgLayer
= AcpiDbgLayer
;
234 AcpiDbgLevel
= 0x00FFFFFF;
235 AcpiDbgLayer
= ACPI_UINT32_MAX
;
237 if (AcpiGbl_TraceDbgLevel
)
239 AcpiDbgLevel
= AcpiGbl_TraceDbgLevel
;
241 if (AcpiGbl_TraceDbgLayer
)
243 AcpiDbgLayer
= AcpiGbl_TraceDbgLayer
;
248 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE
);
252 /*******************************************************************************
254 * FUNCTION: AcpiPsStopTrace
256 * PARAMETERS: Info - Method info struct
260 * DESCRIPTION: Stop control method execution trace
262 ******************************************************************************/
266 ACPI_EVALUATE_INFO
*Info
)
271 ACPI_FUNCTION_ENTRY ();
274 Status
= AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE
);
275 if (ACPI_FAILURE (Status
))
280 if ((!AcpiGbl_TraceMethodName
) ||
281 (AcpiGbl_TraceMethodName
!= Info
->ResolvedNode
->Name
.Integer
))
286 /* Disable further tracing if type is one-shot */
288 if (AcpiGbl_TraceFlags
& 1)
290 AcpiGbl_TraceMethodName
= 0;
291 AcpiGbl_TraceDbgLevel
= 0;
292 AcpiGbl_TraceDbgLayer
= 0;
295 AcpiDbgLevel
= AcpiGbl_OriginalDbgLevel
;
296 AcpiDbgLayer
= AcpiGbl_OriginalDbgLayer
;
299 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE
);
303 /*******************************************************************************
305 * FUNCTION: AcpiPsExecuteMethod
307 * PARAMETERS: Info - Method info block, contains:
308 * Node - Method Node to execute
309 * ObjDesc - Method object
310 * Parameters - List of parameters to pass to the method,
311 * terminated by NULL. Params itself may be
312 * NULL if no parameters are being passed.
313 * ReturnObject - Where to put method's return value (if
314 * any). If NULL, no value is returned.
315 * ParameterType - Type of Parameter list
316 * ReturnObject - Where to put method's return value (if
317 * any). If NULL, no value is returned.
318 * PassNumber - Parse or execute pass
322 * DESCRIPTION: Execute a control method
324 ******************************************************************************/
327 AcpiPsExecuteMethod (
328 ACPI_EVALUATE_INFO
*Info
)
331 ACPI_PARSE_OBJECT
*Op
;
332 ACPI_WALK_STATE
*WalkState
;
335 ACPI_FUNCTION_TRACE (PsExecuteMethod
);
338 /* Quick validation of DSDT header */
340 AcpiTbCheckDsdtHeader ();
342 /* Validate the Info and method Node */
344 if (!Info
|| !Info
->ResolvedNode
)
346 return_ACPI_STATUS (AE_NULL_ENTRY
);
349 /* Init for new method, wait on concurrency semaphore */
351 Status
= AcpiDsBeginMethodExecution (Info
->ResolvedNode
, Info
->ObjDesc
, NULL
);
352 if (ACPI_FAILURE (Status
))
354 return_ACPI_STATUS (Status
);
358 * The caller "owns" the parameters, so give each one an extra reference
360 AcpiPsUpdateParameterList (Info
, REF_INCREMENT
);
362 /* Begin tracing if requested */
364 AcpiPsStartTrace (Info
);
367 * Execute the method. Performs parse simultaneously
369 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE
,
370 "**** Begin Method Parse/Execute [%4.4s] **** Node=%p Obj=%p\n",
371 Info
->ResolvedNode
->Name
.Ascii
, Info
->ResolvedNode
, Info
->ObjDesc
));
373 /* Create and init a Root Node */
375 Op
= AcpiPsCreateScopeOp ();
378 Status
= AE_NO_MEMORY
;
382 /* Create and initialize a new walk state */
384 Info
->PassNumber
= ACPI_IMODE_EXECUTE
;
385 WalkState
= AcpiDsCreateWalkState (
386 Info
->ObjDesc
->Method
.OwnerId
, NULL
, NULL
, NULL
);
389 Status
= AE_NO_MEMORY
;
393 Status
= AcpiDsInitAmlWalk (WalkState
, Op
, Info
->ResolvedNode
,
394 Info
->ObjDesc
->Method
.AmlStart
,
395 Info
->ObjDesc
->Method
.AmlLength
, Info
, Info
->PassNumber
);
396 if (ACPI_FAILURE (Status
))
398 AcpiDsDeleteWalkState (WalkState
);
402 if (Info
->ObjDesc
->Method
.Flags
& AOPOBJ_MODULE_LEVEL
)
404 WalkState
->ParseFlags
|= ACPI_PARSE_MODULE_LEVEL
;
407 /* Invoke an internal method if necessary */
409 if (Info
->ObjDesc
->Method
.MethodFlags
& AML_METHOD_INTERNAL_ONLY
)
411 Status
= Info
->ObjDesc
->Method
.Extra
.Implementation (WalkState
);
412 Info
->ReturnObject
= WalkState
->ReturnDesc
;
416 AcpiDsScopeStackClear (WalkState
);
417 AcpiPsCleanupScope (&WalkState
->ParserState
);
418 AcpiDsTerminateControlMethod (WalkState
->MethodDesc
, WalkState
);
419 AcpiDsDeleteWalkState (WalkState
);
424 * Start method evaluation with an implicit return of zero. This is done
425 * for Windows compatibility.
427 if (AcpiGbl_EnableInterpreterSlack
)
429 WalkState
->ImplicitReturnObj
=
430 AcpiUtCreateIntegerObject ((UINT64
) 0);
431 if (!WalkState
->ImplicitReturnObj
)
433 Status
= AE_NO_MEMORY
;
434 AcpiDsDeleteWalkState (WalkState
);
441 Status
= AcpiPsParseAml (WalkState
);
443 /* WalkState was deleted by ParseAml */
446 AcpiPsDeleteParseTree (Op
);
448 /* End optional tracing */
450 AcpiPsStopTrace (Info
);
452 /* Take away the extra reference that we gave the parameters above */
454 AcpiPsUpdateParameterList (Info
, REF_DECREMENT
);
456 /* Exit now if error above */
458 if (ACPI_FAILURE (Status
))
460 return_ACPI_STATUS (Status
);
464 * If the method has returned an object, signal this to the caller with
465 * a control exception code
467 if (Info
->ReturnObject
)
469 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE
, "Method returned ObjDesc=%p\n",
470 Info
->ReturnObject
));
471 ACPI_DUMP_STACK_ENTRY (Info
->ReturnObject
);
473 Status
= AE_CTRL_RETURN_VALUE
;
476 return_ACPI_STATUS (Status
);
480 /*******************************************************************************
482 * FUNCTION: AcpiPsUpdateParameterList
484 * PARAMETERS: Info - See ACPI_EVALUATE_INFO
485 * (Used: ParameterType and Parameters)
486 * Action - Add or Remove reference
490 * DESCRIPTION: Update reference count on all method parameter objects
492 ******************************************************************************/
495 AcpiPsUpdateParameterList (
496 ACPI_EVALUATE_INFO
*Info
,
502 if (Info
->Parameters
)
504 /* Update reference count for each parameter */
506 for (i
= 0; Info
->Parameters
[i
]; i
++)
508 /* Ignore errors, just do them all */
510 (void) AcpiUtUpdateObjectReference (Info
->Parameters
[i
], Action
);