1 /******************************************************************************
3 * Module Name: psxface - Parser external interfaces
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp.
13 * All rights reserved.
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
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
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;
38 * The above copyright and patent license is granted only if the following
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.
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
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
73 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
81 * 4. Disclaimer and Export Compliance
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
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
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.
115 *****************************************************************************/
117 #define __PSXFACE_C__
119 #include <contrib/dev/acpica/acpi.h>
120 #include <contrib/dev/acpica/acparser.h>
121 #include <contrib/dev/acpica/acdispat.h>
122 #include <contrib/dev/acpica/acinterp.h>
125 #define _COMPONENT ACPI_PARSER
126 ACPI_MODULE_NAME ("psxface")
128 /* Local Prototypes */
132 ACPI_PARAMETER_INFO *Info);
136 ACPI_PARAMETER_INFO *Info);
140 ACPI_PARAMETER_INFO *Info);
143 AcpiPsUpdateParameterList (
144 ACPI_PARAMETER_INFO *Info,
148 /*******************************************************************************
150 * FUNCTION: AcpiDebugTrace
152 * PARAMETERS: MethodName - Valid ACPI name string
153 * DebugLevel - Optional level mask. 0 to use default
154 * DebugLayer - Optional layer mask. 0 to use default
155 * Flags - bit 1: one shot(1) or persistent(0)
159 * DESCRIPTION: External interface to enable debug tracing during control
162 ******************************************************************************/
174 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
175 if (ACPI_FAILURE (Status))
180 /* TBDs: Validate name, allow full path or just nameseg */
182 AcpiGbl_TraceMethodName = *(UINT32 *) Name;
183 AcpiGbl_TraceFlags = Flags;
187 AcpiGbl_TraceDbgLevel = DebugLevel;
191 AcpiGbl_TraceDbgLayer = DebugLayer;
194 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
199 /*******************************************************************************
201 * FUNCTION: AcpiPsStartTrace
203 * PARAMETERS: Info - Method info struct
207 * DESCRIPTION: Start control method execution trace
209 ******************************************************************************/
213 ACPI_PARAMETER_INFO *Info)
218 ACPI_FUNCTION_ENTRY ();
221 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
222 if (ACPI_FAILURE (Status))
227 if ((!AcpiGbl_TraceMethodName) ||
228 (AcpiGbl_TraceMethodName != Info->Node->Name.Integer))
233 AcpiGbl_OriginalDbgLevel = AcpiDbgLevel;
234 AcpiGbl_OriginalDbgLayer = AcpiDbgLayer;
236 AcpiDbgLevel = 0x00FFFFFF;
237 AcpiDbgLayer = ACPI_UINT32_MAX;
239 if (AcpiGbl_TraceDbgLevel)
241 AcpiDbgLevel = AcpiGbl_TraceDbgLevel;
243 if (AcpiGbl_TraceDbgLayer)
245 AcpiDbgLayer = AcpiGbl_TraceDbgLayer;
250 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
254 /*******************************************************************************
256 * FUNCTION: AcpiPsStopTrace
258 * PARAMETERS: Info - Method info struct
262 * DESCRIPTION: Stop control method execution trace
264 ******************************************************************************/
268 ACPI_PARAMETER_INFO *Info)
273 ACPI_FUNCTION_ENTRY ();
276 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
277 if (ACPI_FAILURE (Status))
282 if ((!AcpiGbl_TraceMethodName) ||
283 (AcpiGbl_TraceMethodName != Info->Node->Name.Integer))
288 /* Disable further tracing if type is one-shot */
290 if (AcpiGbl_TraceFlags & 1)
292 AcpiGbl_TraceMethodName = 0;
293 AcpiGbl_TraceDbgLevel = 0;
294 AcpiGbl_TraceDbgLayer = 0;
297 AcpiDbgLevel = AcpiGbl_OriginalDbgLevel;
298 AcpiDbgLayer = AcpiGbl_OriginalDbgLayer;
301 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
305 /*******************************************************************************
307 * FUNCTION: AcpiPsExecuteMethod
309 * PARAMETERS: Info - Method info block, contains:
310 * Node - Method Node to execute
311 * ObjDesc - Method object
312 * Parameters - List of parameters to pass to the method,
313 * terminated by NULL. Params itself may be
314 * NULL if no parameters are being passed.
315 * ReturnObject - Where to put method's return value (if
316 * any). If NULL, no value is returned.
317 * ParameterType - Type of Parameter list
318 * ReturnObject - Where to put method's return value (if
319 * any). If NULL, no value is returned.
320 * PassNumber - Parse or execute pass
324 * DESCRIPTION: Execute a control method
326 ******************************************************************************/
329 AcpiPsExecuteMethod (
330 ACPI_PARAMETER_INFO *Info)
335 ACPI_FUNCTION_TRACE ("PsExecuteMethod");
338 /* Validate the Info and method Node */
340 if (!Info || !Info->Node)
342 return_ACPI_STATUS (AE_NULL_ENTRY);
345 /* Init for new method, wait on concurrency semaphore */
347 Status = AcpiDsBeginMethodExecution (Info->Node, Info->ObjDesc, NULL);
348 if (ACPI_FAILURE (Status))
350 return_ACPI_STATUS (Status);
354 * The caller "owns" the parameters, so give each one an extra
357 AcpiPsUpdateParameterList (Info, REF_INCREMENT);
359 /* Begin tracing if requested */
361 AcpiPsStartTrace (Info);
364 * 1) Perform the first pass parse of the method to enter any
365 * named objects that it creates into the namespace
367 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
368 "**** Begin Method Parse **** Entry=%p obj=%p\n",
369 Info->Node, Info->ObjDesc));
371 Info->PassNumber = 1;
372 Status = AcpiPsExecutePass (Info);
373 if (ACPI_FAILURE (Status))
379 * 2) Execute the method. Performs second pass parse simultaneously
381 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
382 "**** Begin Method Execution **** Entry=%p obj=%p\n",
383 Info->Node, Info->ObjDesc));
385 Info->PassNumber = 3;
386 Status = AcpiPsExecutePass (Info);
390 /* End optional tracing */
392 AcpiPsStopTrace (Info);
394 /* Take away the extra reference that we gave the parameters above */
396 AcpiPsUpdateParameterList (Info, REF_DECREMENT);
398 /* Exit now if error above */
400 if (ACPI_FAILURE (Status))
402 return_ACPI_STATUS (Status);
406 * If the method has returned an object, signal this to the caller with
407 * a control exception code
409 if (Info->ReturnObject)
411 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "Method returned ObjDesc=%p\n",
412 Info->ReturnObject));
413 ACPI_DUMP_STACK_ENTRY (Info->ReturnObject);
415 Status = AE_CTRL_RETURN_VALUE;
418 return_ACPI_STATUS (Status);
422 /*******************************************************************************
424 * FUNCTION: AcpiPsUpdateParameterList
426 * PARAMETERS: Info - See ACPI_PARAMETER_INFO
427 * (Used: ParameterType and Parameters)
428 * Action - Add or Remove reference
432 * DESCRIPTION: Update reference count on all method parameter objects
434 ******************************************************************************/
437 AcpiPsUpdateParameterList (
438 ACPI_PARAMETER_INFO *Info,
444 if ((Info->ParameterType == ACPI_PARAM_ARGS) &&
447 /* Update reference count for each parameter */
449 for (i = 0; Info->Parameters[i]; i++)
451 /* Ignore errors, just do them all */
453 (void) AcpiUtUpdateObjectReference (Info->Parameters[i], Action);
459 /*******************************************************************************
461 * FUNCTION: AcpiPsExecutePass
463 * PARAMETERS: Info - See ACPI_PARAMETER_INFO
464 * (Used: PassNumber, Node, and ObjDesc)
468 * DESCRIPTION: Single AML pass: Parse or Execute a control method
470 ******************************************************************************/
474 ACPI_PARAMETER_INFO *Info)
477 ACPI_PARSE_OBJECT *Op;
478 ACPI_WALK_STATE *WalkState;
481 ACPI_FUNCTION_TRACE ("PsExecutePass");
484 /* Create and init a Root Node */
486 Op = AcpiPsCreateScopeOp ();
489 return_ACPI_STATUS (AE_NO_MEMORY);
492 /* Create and initialize a new walk state */
494 WalkState = AcpiDsCreateWalkState (
495 Info->ObjDesc->Method.OwnerId, NULL, NULL, NULL);
498 Status = AE_NO_MEMORY;
502 Status = AcpiDsInitAmlWalk (WalkState, Op, Info->Node,
503 Info->ObjDesc->Method.AmlStart,
504 Info->ObjDesc->Method.AmlLength,
505 Info->PassNumber == 1 ? NULL : Info,
507 if (ACPI_FAILURE (Status))
509 AcpiDsDeleteWalkState (WalkState);
515 Status = AcpiPsParseAml (WalkState);
517 /* Walk state was deleted by ParseAml */
520 AcpiPsDeleteParseTree (Op);
521 return_ACPI_STATUS (Status);