2 /******************************************************************************
4 * Module Name: exutils - interpreter/scanner utilities
7 *****************************************************************************/
9 /******************************************************************************
13 * Some or all of this work - Copyright (c) 1999 - 2007, Intel Corp.
14 * All rights reserved.
18 * 2.1. This is your license from Intel Corp. under its intellectual property
19 * rights. You may have additional license terms from the party that provided
20 * you this software, covering your right to use that party's intellectual
23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
24 * copy of the source code appearing in this file ("Covered Code") an
25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
26 * base code distributed originally by Intel ("Original Intel Code") to copy,
27 * make derivatives, distribute, use and display any portion of the Covered
28 * Code in any form, with the right to sublicense such rights; and
30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
31 * license (with the right to sublicense), under only those claims of Intel
32 * patents that are infringed by the Original Intel Code, to make, use, sell,
33 * offer to sell, and import the Covered Code and derivative works thereof
34 * solely to the minimum extent necessary to exercise the above copyright
35 * license, and in no event shall the patent license extend to any additions
36 * to or modifications of the Original Intel Code. No other license or right
37 * is granted directly or by implication, estoppel or otherwise;
39 * The above copyright and patent license is granted only if the following
44 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45 * Redistribution of source code of any substantial portion of the Covered
46 * Code or modification with rights to further distribute source must include
47 * the above Copyright Notice, the above License, this list of Conditions,
48 * and the following Disclaimer and Export Compliance provision. In addition,
49 * Licensee must cause all Covered Code to which Licensee contributes to
50 * contain a file documenting the changes Licensee made to create that Covered
51 * Code and the date of any change. Licensee must include in that file the
52 * documentation of any changes made by any predecessor Licensee. Licensee
53 * must include a prominent statement that the modification is derived,
54 * directly or indirectly, from Original Intel Code.
56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
57 * Redistribution of source code of any substantial portion of the Covered
58 * Code or modification without rights to further distribute source must
59 * include the following Disclaimer and Export Compliance provision in the
60 * documentation and/or other materials provided with distribution. In
61 * addition, Licensee may not authorize further sublicense of source of any
62 * portion of the Covered Code, and must include terms to the effect that the
63 * license from Licensee to its licensee is limited to the intellectual
64 * property embodied in the software Licensee provides to its licensee, and
65 * not to intellectual property embodied in modifications its licensee may
68 * 3.3. Redistribution of Executable. Redistribution in executable form of any
69 * substantial portion of the Covered Code or modification must reproduce the
70 * above Copyright Notice, and the following Disclaimer and Export Compliance
71 * provision in the documentation and/or other materials provided with the
74 * 3.4. Intel retains all right, title, and interest in and to the Original
77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78 * Intel shall be used in advertising or otherwise to promote the sale, use or
79 * other dealings in products derived from or relating to the Covered Code
80 * without prior written authorization from Intel.
82 * 4. Disclaimer and Export Compliance
84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
101 * 4.3. Licensee shall not export, either directly or indirectly, any of this
102 * software or system incorporating such software without first obtaining any
103 * required license or other approval from the U. S. Department of Commerce or
104 * any other agency or department of the United States Government. In the
105 * event Licensee exports any such software from the United States or
106 * re-exports any such software from a foreign destination, Licensee shall
107 * ensure that the distribution and export/re-export of the software is in
108 * compliance with all laws, regulations, orders, or other restrictions of the
109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110 * any of its subsidiaries will export/re-export any technical data, process,
111 * software, or service, directly or indirectly, to any country for which the
112 * United States government or any agency thereof requires an export license,
113 * other governmental approval, or letter of assurance, without first obtaining
114 * such license, approval or letter.
116 *****************************************************************************/
118 #define __EXUTILS_C__
121 * DEFINE_AML_GLOBALS is tested in amlcode.h
122 * to determine whether certain global names should be "defined" or only
123 * "declared" in the current compilation. This enhances maintainability
124 * by enabling a single header file to embody all knowledge of the names
127 * Exactly one module of any executable should #define DEFINE_GLOBALS
128 * before #including the header files which use this convention. The
129 * names in question will be defined and initialized in that module,
130 * and declared as extern in all other modules which #include those
134 #define DEFINE_AML_GLOBALS
136 #include <contrib/dev/acpica/acpi.h>
137 #include <contrib/dev/acpica/acinterp.h>
138 #include <contrib/dev/acpica/amlcode.h>
139 #include <contrib/dev/acpica/acevents.h>
141 #define _COMPONENT ACPI_EXECUTER
142 ACPI_MODULE_NAME ("exutils")
144 /* Local prototypes */
152 #ifndef ACPI_NO_METHOD_EXECUTION
153 /*******************************************************************************
155 * FUNCTION: AcpiExEnterInterpreter
161 * DESCRIPTION: Enter the interpreter execution region. Failure to enter
162 * the interpreter region is a fatal system error. Used in
163 * conjunction with ExitInterpreter.
165 ******************************************************************************/
168 AcpiExEnterInterpreter (
174 ACPI_FUNCTION_TRACE (ExEnterInterpreter);
177 Status = AcpiUtAcquireMutex (ACPI_MTX_INTERPRETER);
178 if (ACPI_FAILURE (Status))
180 ACPI_ERROR ((AE_INFO, "Could not acquire AML Interpreter mutex"));
187 /*******************************************************************************
189 * FUNCTION: AcpiExReacquireInterpreter
195 * DESCRIPTION: Reacquire the interpreter execution region from within the
196 * interpreter code. Failure to enter the interpreter region is a
197 * fatal system error. Used in conjuction with
198 * RelinquishInterpreter
200 ******************************************************************************/
203 AcpiExReacquireInterpreter (
206 ACPI_FUNCTION_TRACE (ExReacquireInterpreter);
210 * If the global serialized flag is set, do not release the interpreter,
211 * since it was not actually released by AcpiExRelinquishInterpreter.
212 * This forces the interpreter to be single threaded.
214 if (!AcpiGbl_AllMethodsSerialized)
216 AcpiExEnterInterpreter ();
223 /*******************************************************************************
225 * FUNCTION: AcpiExExitInterpreter
231 * DESCRIPTION: Exit the interpreter execution region. This is the top level
232 * routine used to exit the interpreter when all processing has
235 ******************************************************************************/
238 AcpiExExitInterpreter (
244 ACPI_FUNCTION_TRACE (ExExitInterpreter);
247 Status = AcpiUtReleaseMutex (ACPI_MTX_INTERPRETER);
248 if (ACPI_FAILURE (Status))
250 ACPI_ERROR ((AE_INFO, "Could not release AML Interpreter mutex"));
257 /*******************************************************************************
259 * FUNCTION: AcpiExRelinquishInterpreter
265 * DESCRIPTION: Exit the interpreter execution region, from within the
266 * interpreter - before attempting an operation that will possibly
267 * block the running thread.
269 * Cases where the interpreter is unlocked internally
270 * 1) Method to be blocked on a Sleep() AML opcode
271 * 2) Method to be blocked on an Acquire() AML opcode
272 * 3) Method to be blocked on a Wait() AML opcode
273 * 4) Method to be blocked to acquire the global lock
274 * 5) Method to be blocked waiting to execute a serialized control method
275 * that is currently executing
276 * 6) About to invoke a user-installed opregion handler
278 ******************************************************************************/
281 AcpiExRelinquishInterpreter (
284 ACPI_FUNCTION_TRACE (ExRelinquishInterpreter);
288 * If the global serialized flag is set, do not release the interpreter.
289 * This forces the interpreter to be single threaded.
291 if (!AcpiGbl_AllMethodsSerialized)
293 AcpiExExitInterpreter ();
300 /*******************************************************************************
302 * FUNCTION: AcpiExTruncateFor32bitTable
304 * PARAMETERS: ObjDesc - Object to be truncated
308 * DESCRIPTION: Truncate an ACPI Integer to 32 bits if the execution mode is
309 * 32-bit, as determined by the revision of the DSDT.
311 ******************************************************************************/
314 AcpiExTruncateFor32bitTable (
315 ACPI_OPERAND_OBJECT *ObjDesc)
318 ACPI_FUNCTION_ENTRY ();
322 * Object must be a valid number and we must be executing
323 * a control method. NS node could be there for AML_INT_NAMEPATH_OP.
326 (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc) != ACPI_DESC_TYPE_OPERAND) ||
327 (ACPI_GET_OBJECT_TYPE (ObjDesc) != ACPI_TYPE_INTEGER))
332 if (AcpiGbl_IntegerByteWidth == 4)
335 * We are running a method that exists in a 32-bit ACPI table.
336 * Truncate the value to 32 bits by zeroing out the upper 32-bit field
338 ObjDesc->Integer.Value &= (ACPI_INTEGER) ACPI_UINT32_MAX;
343 /*******************************************************************************
345 * FUNCTION: AcpiExAcquireGlobalLock
347 * PARAMETERS: FieldFlags - Flags with Lock rule:
348 * AlwaysLock or NeverLock
352 * DESCRIPTION: Obtain the ACPI hardware Global Lock, only if the field
353 * flags specifiy that it is to be obtained before field access.
355 ******************************************************************************/
358 AcpiExAcquireGlobalLock (
364 ACPI_FUNCTION_TRACE (ExAcquireGlobalLock);
367 /* Only use the lock if the AlwaysLock bit is set */
369 if (!(FieldFlags & AML_FIELD_LOCK_RULE_MASK))
374 /* Attempt to get the global lock, wait forever */
376 Status = AcpiExAcquireMutexObject (ACPI_WAIT_FOREVER,
377 AcpiGbl_GlobalLockMutex, AcpiOsGetThreadId ());
379 if (ACPI_FAILURE (Status))
381 ACPI_EXCEPTION ((AE_INFO, Status,
382 "Could not acquire Global Lock"));
389 /*******************************************************************************
391 * FUNCTION: AcpiExReleaseGlobalLock
393 * PARAMETERS: FieldFlags - Flags with Lock rule:
394 * AlwaysLock or NeverLock
398 * DESCRIPTION: Release the ACPI hardware Global Lock
400 ******************************************************************************/
403 AcpiExReleaseGlobalLock (
409 ACPI_FUNCTION_TRACE (ExReleaseGlobalLock);
412 /* Only use the lock if the AlwaysLock bit is set */
414 if (!(FieldFlags & AML_FIELD_LOCK_RULE_MASK))
419 /* Release the global lock */
421 Status = AcpiExReleaseMutexObject (AcpiGbl_GlobalLockMutex);
422 if (ACPI_FAILURE (Status))
424 /* Report the error, but there isn't much else we can do */
426 ACPI_EXCEPTION ((AE_INFO, Status,
427 "Could not release Global Lock"));
434 /*******************************************************************************
436 * FUNCTION: AcpiExDigitsNeeded
438 * PARAMETERS: Value - Value to be represented
439 * Base - Base of representation
441 * RETURN: The number of digits.
443 * DESCRIPTION: Calculate the number of digits needed to represent the Value
444 * in the given Base (Radix)
446 ******************************************************************************/
454 ACPI_INTEGER CurrentValue;
457 ACPI_FUNCTION_TRACE (ExDigitsNeeded);
460 /* ACPI_INTEGER is unsigned, so we don't worry about a '-' prefix */
467 CurrentValue = Value;
470 /* Count the digits in the requested base */
474 (void) AcpiUtShortDivide (CurrentValue, Base, &CurrentValue, NULL);
478 return_UINT32 (NumDigits);
482 /*******************************************************************************
484 * FUNCTION: AcpiExEisaIdToString
486 * PARAMETERS: NumericId - EISA ID to be converted
487 * OutString - Where to put the converted string (8 bytes)
491 * DESCRIPTION: Convert a numeric EISA ID to string representation
493 ******************************************************************************/
496 AcpiExEisaIdToString (
503 ACPI_FUNCTION_ENTRY ();
506 /* Swap ID to big-endian to get contiguous bits */
508 EisaId = AcpiUtDwordByteSwap (NumericId);
510 OutString[0] = (char) ('@' + (((unsigned long) EisaId >> 26) & 0x1f));
511 OutString[1] = (char) ('@' + ((EisaId >> 21) & 0x1f));
512 OutString[2] = (char) ('@' + ((EisaId >> 16) & 0x1f));
513 OutString[3] = AcpiUtHexToAsciiChar ((ACPI_INTEGER) EisaId, 12);
514 OutString[4] = AcpiUtHexToAsciiChar ((ACPI_INTEGER) EisaId, 8);
515 OutString[5] = AcpiUtHexToAsciiChar ((ACPI_INTEGER) EisaId, 4);
516 OutString[6] = AcpiUtHexToAsciiChar ((ACPI_INTEGER) EisaId, 0);
521 /*******************************************************************************
523 * FUNCTION: AcpiExUnsignedIntegerToString
525 * PARAMETERS: Value - Value to be converted
526 * OutString - Where to put the converted string (8 bytes)
528 * RETURN: None, string
530 * DESCRIPTION: Convert a number to string representation. Assumes string
531 * buffer is large enough to hold the string.
533 ******************************************************************************/
536 AcpiExUnsignedIntegerToString (
545 ACPI_FUNCTION_ENTRY ();
548 DigitsNeeded = AcpiExDigitsNeeded (Value, 10);
549 OutString[DigitsNeeded] = 0;
551 for (Count = DigitsNeeded; Count > 0; Count--)
553 (void) AcpiUtShortDivide (Value, 10, &Value, &Remainder);
554 OutString[Count-1] = (char) ('0' + Remainder);\