1 /******************************************************************************
3 * Module Name: exutils - interpreter/scanner utilities
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2018, 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 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
150 *****************************************************************************/
153 * DEFINE_AML_GLOBALS is tested in amlcode.h
154 * to determine whether certain global names should be "defined" or only
155 * "declared" in the current compilation. This enhances maintainability
156 * by enabling a single header file to embody all knowledge of the names
159 * Exactly one module of any executable should #define DEFINE_GLOBALS
160 * before #including the header files which use this convention. The
161 * names in question will be defined and initialized in that module,
162 * and declared as extern in all other modules which #include those
166 #define DEFINE_AML_GLOBALS
169 #include "accommon.h"
170 #include "acinterp.h"
173 #define _COMPONENT ACPI_EXECUTER
174 ACPI_MODULE_NAME ("exutils")
176 /* Local prototypes */
184 #ifndef ACPI_NO_METHOD_EXECUTION
185 /*******************************************************************************
187 * FUNCTION: AcpiExEnterInterpreter
193 * DESCRIPTION: Enter the interpreter execution region. Failure to enter
194 * the interpreter region is a fatal system error. Used in
195 * conjunction with ExitInterpreter.
197 ******************************************************************************/
200 AcpiExEnterInterpreter (
206 ACPI_FUNCTION_TRACE (ExEnterInterpreter);
209 Status = AcpiUtAcquireMutex (ACPI_MTX_INTERPRETER);
210 if (ACPI_FAILURE (Status))
212 ACPI_ERROR ((AE_INFO, "Could not acquire AML Interpreter mutex"));
214 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
215 if (ACPI_FAILURE (Status))
217 ACPI_ERROR ((AE_INFO, "Could not acquire AML Namespace mutex"));
224 /*******************************************************************************
226 * FUNCTION: AcpiExExitInterpreter
232 * DESCRIPTION: Exit the interpreter execution region. This is the top level
233 * routine used to exit the interpreter when all processing has
234 * been completed, or when the method blocks.
236 * Cases where the interpreter is unlocked internally:
237 * 1) Method will be blocked on a Sleep() AML opcode
238 * 2) Method will be blocked on an Acquire() AML opcode
239 * 3) Method will be blocked on a Wait() AML opcode
240 * 4) Method will be blocked to acquire the global lock
241 * 5) Method will be blocked waiting to execute a serialized control
242 * method that is currently executing
243 * 6) About to invoke a user-installed opregion handler
245 ******************************************************************************/
248 AcpiExExitInterpreter (
254 ACPI_FUNCTION_TRACE (ExExitInterpreter);
257 Status = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
258 if (ACPI_FAILURE (Status))
260 ACPI_ERROR ((AE_INFO, "Could not release AML Namespace mutex"));
262 Status = AcpiUtReleaseMutex (ACPI_MTX_INTERPRETER);
263 if (ACPI_FAILURE (Status))
265 ACPI_ERROR ((AE_INFO, "Could not release AML Interpreter mutex"));
272 /*******************************************************************************
274 * FUNCTION: AcpiExTruncateFor32bitTable
276 * PARAMETERS: ObjDesc - Object to be truncated
278 * RETURN: TRUE if a truncation was performed, FALSE otherwise.
280 * DESCRIPTION: Truncate an ACPI Integer to 32 bits if the execution mode is
281 * 32-bit, as determined by the revision of the DSDT.
283 ******************************************************************************/
286 AcpiExTruncateFor32bitTable (
287 ACPI_OPERAND_OBJECT *ObjDesc)
290 ACPI_FUNCTION_ENTRY ();
294 * Object must be a valid number and we must be executing
295 * a control method. Object could be NS node for AML_INT_NAMEPATH_OP.
298 (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc) != ACPI_DESC_TYPE_OPERAND) ||
299 (ObjDesc->Common.Type != ACPI_TYPE_INTEGER))
304 if ((AcpiGbl_IntegerByteWidth == 4) &&
305 (ObjDesc->Integer.Value > (UINT64) ACPI_UINT32_MAX))
308 * We are executing in a 32-bit ACPI table. Truncate
309 * the value to 32 bits by zeroing out the upper 32-bit field
311 ObjDesc->Integer.Value &= (UINT64) ACPI_UINT32_MAX;
319 /*******************************************************************************
321 * FUNCTION: AcpiExAcquireGlobalLock
323 * PARAMETERS: FieldFlags - Flags with Lock rule:
324 * AlwaysLock or NeverLock
328 * DESCRIPTION: Obtain the ACPI hardware Global Lock, only if the field
329 * flags specifiy that it is to be obtained before field access.
331 ******************************************************************************/
334 AcpiExAcquireGlobalLock (
340 ACPI_FUNCTION_TRACE (ExAcquireGlobalLock);
343 /* Only use the lock if the AlwaysLock bit is set */
345 if (!(FieldFlags & AML_FIELD_LOCK_RULE_MASK))
350 /* Attempt to get the global lock, wait forever */
352 Status = AcpiExAcquireMutexObject (ACPI_WAIT_FOREVER,
353 AcpiGbl_GlobalLockMutex, AcpiOsGetThreadId ());
355 if (ACPI_FAILURE (Status))
357 ACPI_EXCEPTION ((AE_INFO, Status,
358 "Could not acquire Global Lock"));
365 /*******************************************************************************
367 * FUNCTION: AcpiExReleaseGlobalLock
369 * PARAMETERS: FieldFlags - Flags with Lock rule:
370 * AlwaysLock or NeverLock
374 * DESCRIPTION: Release the ACPI hardware Global Lock
376 ******************************************************************************/
379 AcpiExReleaseGlobalLock (
385 ACPI_FUNCTION_TRACE (ExReleaseGlobalLock);
388 /* Only use the lock if the AlwaysLock bit is set */
390 if (!(FieldFlags & AML_FIELD_LOCK_RULE_MASK))
395 /* Release the global lock */
397 Status = AcpiExReleaseMutexObject (AcpiGbl_GlobalLockMutex);
398 if (ACPI_FAILURE (Status))
400 /* Report the error, but there isn't much else we can do */
402 ACPI_EXCEPTION ((AE_INFO, Status,
403 "Could not release Global Lock"));
410 /*******************************************************************************
412 * FUNCTION: AcpiExDigitsNeeded
414 * PARAMETERS: Value - Value to be represented
415 * Base - Base of representation
417 * RETURN: The number of digits.
419 * DESCRIPTION: Calculate the number of digits needed to represent the Value
420 * in the given Base (Radix)
422 ******************************************************************************/
433 ACPI_FUNCTION_TRACE (ExDigitsNeeded);
436 /* UINT64 is unsigned, so we don't worry about a '-' prefix */
443 CurrentValue = Value;
446 /* Count the digits in the requested base */
450 (void) AcpiUtShortDivide (CurrentValue, Base, &CurrentValue, NULL);
454 return_UINT32 (NumDigits);
458 /*******************************************************************************
460 * FUNCTION: AcpiExEisaIdToString
462 * PARAMETERS: OutString - Where to put the converted string (8 bytes)
463 * CompressedId - EISAID to be converted
467 * DESCRIPTION: Convert a numeric EISAID to string representation. Return
468 * buffer must be large enough to hold the string. The string
469 * returned is always exactly of length ACPI_EISAID_STRING_SIZE
470 * (includes null terminator). The EISAID is always 32 bits.
472 ******************************************************************************/
475 AcpiExEisaIdToString (
482 ACPI_FUNCTION_ENTRY ();
485 /* The EISAID should be a 32-bit integer */
487 if (CompressedId > ACPI_UINT32_MAX)
489 ACPI_WARNING ((AE_INFO,
490 "Expected EISAID is larger than 32 bits: "
491 "0x%8.8X%8.8X, truncating",
492 ACPI_FORMAT_UINT64 (CompressedId)));
495 /* Swap ID to big-endian to get contiguous bits */
497 SwappedId = AcpiUtDwordByteSwap ((UINT32) CompressedId);
499 /* First 3 bytes are uppercase letters. Next 4 bytes are hexadecimal */
501 OutString[0] = (char) (0x40 + (((unsigned long) SwappedId >> 26) & 0x1F));
502 OutString[1] = (char) (0x40 + ((SwappedId >> 21) & 0x1F));
503 OutString[2] = (char) (0x40 + ((SwappedId >> 16) & 0x1F));
504 OutString[3] = AcpiUtHexToAsciiChar ((UINT64) SwappedId, 12);
505 OutString[4] = AcpiUtHexToAsciiChar ((UINT64) SwappedId, 8);
506 OutString[5] = AcpiUtHexToAsciiChar ((UINT64) SwappedId, 4);
507 OutString[6] = AcpiUtHexToAsciiChar ((UINT64) SwappedId, 0);
512 /*******************************************************************************
514 * FUNCTION: AcpiExIntegerToString
516 * PARAMETERS: OutString - Where to put the converted string. At least
517 * 21 bytes are needed to hold the largest
518 * possible 64-bit integer.
519 * Value - Value to be converted
521 * RETURN: Converted string in OutString
523 * DESCRIPTION: Convert a 64-bit integer to decimal string representation.
524 * Assumes string buffer is large enough to hold the string. The
525 * largest string is (ACPI_MAX64_DECIMAL_DIGITS + 1).
527 ******************************************************************************/
530 AcpiExIntegerToString (
539 ACPI_FUNCTION_ENTRY ();
542 DigitsNeeded = AcpiExDigitsNeeded (Value, 10);
543 OutString[DigitsNeeded] = 0;
545 for (Count = DigitsNeeded; Count > 0; Count--)
547 (void) AcpiUtShortDivide (Value, 10, &Value, &Remainder);
548 OutString[Count-1] = (char) ('0' + Remainder);\
553 /*******************************************************************************
555 * FUNCTION: AcpiExPciClsToString
557 * PARAMETERS: OutString - Where to put the converted string (7 bytes)
558 * ClassCode - PCI class code to be converted (3 bytes)
560 * RETURN: Converted string in OutString
562 * DESCRIPTION: Convert 3-bytes PCI class code to string representation.
563 * Return buffer must be large enough to hold the string. The
564 * string returned is always exactly of length
565 * ACPI_PCICLS_STRING_SIZE (includes null terminator).
567 ******************************************************************************/
570 AcpiExPciClsToString (
575 ACPI_FUNCTION_ENTRY ();
578 /* All 3 bytes are hexadecimal */
580 OutString[0] = AcpiUtHexToAsciiChar ((UINT64) ClassCode[0], 4);
581 OutString[1] = AcpiUtHexToAsciiChar ((UINT64) ClassCode[0], 0);
582 OutString[2] = AcpiUtHexToAsciiChar ((UINT64) ClassCode[1], 4);
583 OutString[3] = AcpiUtHexToAsciiChar ((UINT64) ClassCode[1], 0);
584 OutString[4] = AcpiUtHexToAsciiChar ((UINT64) ClassCode[2], 4);
585 OutString[5] = AcpiUtHexToAsciiChar ((UINT64) ClassCode[2], 0);
590 /*******************************************************************************
592 * FUNCTION: AcpiIsValidSpaceId
594 * PARAMETERS: SpaceId - ID to be validated
596 * RETURN: TRUE if SpaceId is a valid/supported ID.
598 * DESCRIPTION: Validate an operation region SpaceID.
600 ******************************************************************************/
607 if ((SpaceId >= ACPI_NUM_PREDEFINED_REGIONS) &&
608 (SpaceId < ACPI_USER_REGION_BEGIN) &&
609 (SpaceId != ACPI_ADR_SPACE_DATA_TABLE) &&
610 (SpaceId != ACPI_ADR_SPACE_FIXED_HARDWARE))