17c478bd9Sstevel@tonic-gate /******************************************************************************
27c478bd9Sstevel@tonic-gate *
37c478bd9Sstevel@tonic-gate * Module Name: exutils - interpreter/scanner utilities
47c478bd9Sstevel@tonic-gate *
57c478bd9Sstevel@tonic-gate *****************************************************************************/
67c478bd9Sstevel@tonic-gate
7*35786f68SRobert Mustacchi /******************************************************************************
8*35786f68SRobert Mustacchi *
9*35786f68SRobert Mustacchi * 1. Copyright Notice
10*35786f68SRobert Mustacchi *
11*35786f68SRobert Mustacchi * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
127c478bd9Sstevel@tonic-gate * All rights reserved.
137c478bd9Sstevel@tonic-gate *
14*35786f68SRobert Mustacchi * 2. License
15*35786f68SRobert Mustacchi *
16*35786f68SRobert Mustacchi * 2.1. This is your license from Intel Corp. under its intellectual property
17*35786f68SRobert Mustacchi * rights. You may have additional license terms from the party that provided
18*35786f68SRobert Mustacchi * you this software, covering your right to use that party's intellectual
19*35786f68SRobert Mustacchi * property rights.
20*35786f68SRobert Mustacchi *
21*35786f68SRobert Mustacchi * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22*35786f68SRobert Mustacchi * copy of the source code appearing in this file ("Covered Code") an
23*35786f68SRobert Mustacchi * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24*35786f68SRobert Mustacchi * base code distributed originally by Intel ("Original Intel Code") to copy,
25*35786f68SRobert Mustacchi * make derivatives, distribute, use and display any portion of the Covered
26*35786f68SRobert Mustacchi * Code in any form, with the right to sublicense such rights; and
27*35786f68SRobert Mustacchi *
28*35786f68SRobert Mustacchi * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29*35786f68SRobert Mustacchi * license (with the right to sublicense), under only those claims of Intel
30*35786f68SRobert Mustacchi * patents that are infringed by the Original Intel Code, to make, use, sell,
31*35786f68SRobert Mustacchi * offer to sell, and import the Covered Code and derivative works thereof
32*35786f68SRobert Mustacchi * solely to the minimum extent necessary to exercise the above copyright
33*35786f68SRobert Mustacchi * license, and in no event shall the patent license extend to any additions
34*35786f68SRobert Mustacchi * to or modifications of the Original Intel Code. No other license or right
35*35786f68SRobert Mustacchi * is granted directly or by implication, estoppel or otherwise;
36*35786f68SRobert Mustacchi *
37*35786f68SRobert Mustacchi * The above copyright and patent license is granted only if the following
38*35786f68SRobert Mustacchi * conditions are met:
39*35786f68SRobert Mustacchi *
40*35786f68SRobert Mustacchi * 3. Conditions
41*35786f68SRobert Mustacchi *
42*35786f68SRobert Mustacchi * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43*35786f68SRobert Mustacchi * Redistribution of source code of any substantial portion of the Covered
44*35786f68SRobert Mustacchi * Code or modification with rights to further distribute source must include
45*35786f68SRobert Mustacchi * the above Copyright Notice, the above License, this list of Conditions,
46*35786f68SRobert Mustacchi * and the following Disclaimer and Export Compliance provision. In addition,
47*35786f68SRobert Mustacchi * Licensee must cause all Covered Code to which Licensee contributes to
48*35786f68SRobert Mustacchi * contain a file documenting the changes Licensee made to create that Covered
49*35786f68SRobert Mustacchi * Code and the date of any change. Licensee must include in that file the
50*35786f68SRobert Mustacchi * documentation of any changes made by any predecessor Licensee. Licensee
51*35786f68SRobert Mustacchi * must include a prominent statement that the modification is derived,
52*35786f68SRobert Mustacchi * directly or indirectly, from Original Intel Code.
53*35786f68SRobert Mustacchi *
54*35786f68SRobert Mustacchi * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55*35786f68SRobert Mustacchi * Redistribution of source code of any substantial portion of the Covered
56*35786f68SRobert Mustacchi * Code or modification without rights to further distribute source must
57*35786f68SRobert Mustacchi * include the following Disclaimer and Export Compliance provision in the
58*35786f68SRobert Mustacchi * documentation and/or other materials provided with distribution. In
59*35786f68SRobert Mustacchi * addition, Licensee may not authorize further sublicense of source of any
60*35786f68SRobert Mustacchi * portion of the Covered Code, and must include terms to the effect that the
61*35786f68SRobert Mustacchi * license from Licensee to its licensee is limited to the intellectual
62*35786f68SRobert Mustacchi * property embodied in the software Licensee provides to its licensee, and
63*35786f68SRobert Mustacchi * not to intellectual property embodied in modifications its licensee may
64*35786f68SRobert Mustacchi * make.
65*35786f68SRobert Mustacchi *
66*35786f68SRobert Mustacchi * 3.3. Redistribution of Executable. Redistribution in executable form of any
67*35786f68SRobert Mustacchi * substantial portion of the Covered Code or modification must reproduce the
68*35786f68SRobert Mustacchi * above Copyright Notice, and the following Disclaimer and Export Compliance
69*35786f68SRobert Mustacchi * provision in the documentation and/or other materials provided with the
70*35786f68SRobert Mustacchi * distribution.
71*35786f68SRobert Mustacchi *
72*35786f68SRobert Mustacchi * 3.4. Intel retains all right, title, and interest in and to the Original
73*35786f68SRobert Mustacchi * Intel Code.
74*35786f68SRobert Mustacchi *
75*35786f68SRobert Mustacchi * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76*35786f68SRobert Mustacchi * Intel shall be used in advertising or otherwise to promote the sale, use or
77*35786f68SRobert Mustacchi * other dealings in products derived from or relating to the Covered Code
78*35786f68SRobert Mustacchi * without prior written authorization from Intel.
79*35786f68SRobert Mustacchi *
80*35786f68SRobert Mustacchi * 4. Disclaimer and Export Compliance
81*35786f68SRobert Mustacchi *
82*35786f68SRobert Mustacchi * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83*35786f68SRobert Mustacchi * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84*35786f68SRobert Mustacchi * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85*35786f68SRobert Mustacchi * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86*35786f68SRobert Mustacchi * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87*35786f68SRobert Mustacchi * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88*35786f68SRobert Mustacchi * PARTICULAR PURPOSE.
89*35786f68SRobert Mustacchi *
90*35786f68SRobert Mustacchi * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91*35786f68SRobert Mustacchi * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92*35786f68SRobert Mustacchi * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93*35786f68SRobert Mustacchi * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94*35786f68SRobert Mustacchi * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95*35786f68SRobert Mustacchi * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96*35786f68SRobert Mustacchi * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97*35786f68SRobert Mustacchi * LIMITED REMEDY.
98*35786f68SRobert Mustacchi *
99*35786f68SRobert Mustacchi * 4.3. Licensee shall not export, either directly or indirectly, any of this
100*35786f68SRobert Mustacchi * software or system incorporating such software without first obtaining any
101*35786f68SRobert Mustacchi * required license or other approval from the U. S. Department of Commerce or
102*35786f68SRobert Mustacchi * any other agency or department of the United States Government. In the
103*35786f68SRobert Mustacchi * event Licensee exports any such software from the United States or
104*35786f68SRobert Mustacchi * re-exports any such software from a foreign destination, Licensee shall
105*35786f68SRobert Mustacchi * ensure that the distribution and export/re-export of the software is in
106*35786f68SRobert Mustacchi * compliance with all laws, regulations, orders, or other restrictions of the
107*35786f68SRobert Mustacchi * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108*35786f68SRobert Mustacchi * any of its subsidiaries will export/re-export any technical data, process,
109*35786f68SRobert Mustacchi * software, or service, directly or indirectly, to any country for which the
110*35786f68SRobert Mustacchi * United States government or any agency thereof requires an export license,
111*35786f68SRobert Mustacchi * other governmental approval, or letter of assurance, without first obtaining
112*35786f68SRobert Mustacchi * such license, approval or letter.
113*35786f68SRobert Mustacchi *
114*35786f68SRobert Mustacchi *****************************************************************************
115*35786f68SRobert Mustacchi *
116*35786f68SRobert Mustacchi * Alternatively, you may choose to be licensed under the terms of the
117*35786f68SRobert Mustacchi * following license:
118*35786f68SRobert Mustacchi *
11926f3cdf0SGordon Ross * Redistribution and use in source and binary forms, with or without
12026f3cdf0SGordon Ross * modification, are permitted provided that the following conditions
12126f3cdf0SGordon Ross * are met:
12226f3cdf0SGordon Ross * 1. Redistributions of source code must retain the above copyright
12326f3cdf0SGordon Ross * notice, this list of conditions, and the following disclaimer,
12426f3cdf0SGordon Ross * without modification.
12526f3cdf0SGordon Ross * 2. Redistributions in binary form must reproduce at minimum a disclaimer
12626f3cdf0SGordon Ross * substantially similar to the "NO WARRANTY" disclaimer below
12726f3cdf0SGordon Ross * ("Disclaimer") and any redistribution must be conditioned upon
12826f3cdf0SGordon Ross * including a substantially similar Disclaimer requirement for further
12926f3cdf0SGordon Ross * binary redistribution.
13026f3cdf0SGordon Ross * 3. Neither the names of the above-listed copyright holders nor the names
13126f3cdf0SGordon Ross * of any contributors may be used to endorse or promote products derived
13226f3cdf0SGordon Ross * from this software without specific prior written permission.
13326f3cdf0SGordon Ross *
13426f3cdf0SGordon Ross * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
13526f3cdf0SGordon Ross * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136*35786f68SRobert Mustacchi * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
13726f3cdf0SGordon Ross * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138*35786f68SRobert Mustacchi * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139*35786f68SRobert Mustacchi * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140*35786f68SRobert Mustacchi * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141*35786f68SRobert Mustacchi * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142*35786f68SRobert Mustacchi * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143*35786f68SRobert Mustacchi * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144*35786f68SRobert Mustacchi * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145*35786f68SRobert Mustacchi *
146*35786f68SRobert Mustacchi * Alternatively, you may choose to be licensed under the terms of the
147*35786f68SRobert Mustacchi * GNU General Public License ("GPL") version 2 as published by the Free
148*35786f68SRobert Mustacchi * Software Foundation.
149*35786f68SRobert Mustacchi *
150*35786f68SRobert Mustacchi *****************************************************************************/
1517c478bd9Sstevel@tonic-gate
1527c478bd9Sstevel@tonic-gate /*
1537c478bd9Sstevel@tonic-gate * DEFINE_AML_GLOBALS is tested in amlcode.h
1547c478bd9Sstevel@tonic-gate * to determine whether certain global names should be "defined" or only
1557b1019a6SJerry Jelinek * "declared" in the current compilation. This enhances maintainability
1567c478bd9Sstevel@tonic-gate * by enabling a single header file to embody all knowledge of the names
1577c478bd9Sstevel@tonic-gate * in question.
1587c478bd9Sstevel@tonic-gate *
1597c478bd9Sstevel@tonic-gate * Exactly one module of any executable should #define DEFINE_GLOBALS
1607b1019a6SJerry Jelinek * before #including the header files which use this convention. The
1617c478bd9Sstevel@tonic-gate * names in question will be defined and initialized in that module,
1627c478bd9Sstevel@tonic-gate * and declared as extern in all other modules which #include those
1637c478bd9Sstevel@tonic-gate * header files.
1647c478bd9Sstevel@tonic-gate */
1657c478bd9Sstevel@tonic-gate
1667c478bd9Sstevel@tonic-gate #define DEFINE_AML_GLOBALS
1677c478bd9Sstevel@tonic-gate
1687c478bd9Sstevel@tonic-gate #include "acpi.h"
169aa2aa9a6SDana Myers #include "accommon.h"
1707c478bd9Sstevel@tonic-gate #include "acinterp.h"
1717c478bd9Sstevel@tonic-gate #include "amlcode.h"
1727c478bd9Sstevel@tonic-gate
1737c478bd9Sstevel@tonic-gate #define _COMPONENT ACPI_EXECUTER
1747c478bd9Sstevel@tonic-gate ACPI_MODULE_NAME ("exutils")
1757c478bd9Sstevel@tonic-gate
1767c478bd9Sstevel@tonic-gate /* Local prototypes */
1777c478bd9Sstevel@tonic-gate
1787c478bd9Sstevel@tonic-gate static UINT32
1797c478bd9Sstevel@tonic-gate AcpiExDigitsNeeded (
18026f3cdf0SGordon Ross UINT64 Value,
1817c478bd9Sstevel@tonic-gate UINT32 Base);
1827c478bd9Sstevel@tonic-gate
1837c478bd9Sstevel@tonic-gate
1847c478bd9Sstevel@tonic-gate #ifndef ACPI_NO_METHOD_EXECUTION
1857c478bd9Sstevel@tonic-gate /*******************************************************************************
1867c478bd9Sstevel@tonic-gate *
1877c478bd9Sstevel@tonic-gate * FUNCTION: AcpiExEnterInterpreter
1887c478bd9Sstevel@tonic-gate *
1897c478bd9Sstevel@tonic-gate * PARAMETERS: None
1907c478bd9Sstevel@tonic-gate *
191db2bae30SDana Myers * RETURN: None
1927c478bd9Sstevel@tonic-gate *
193db2bae30SDana Myers * DESCRIPTION: Enter the interpreter execution region. Failure to enter
194db2bae30SDana Myers * the interpreter region is a fatal system error. Used in
195db2bae30SDana Myers * conjunction with ExitInterpreter.
1967c478bd9Sstevel@tonic-gate *
1977c478bd9Sstevel@tonic-gate ******************************************************************************/
1987c478bd9Sstevel@tonic-gate
199db2bae30SDana Myers void
AcpiExEnterInterpreter(void)2007c478bd9Sstevel@tonic-gate AcpiExEnterInterpreter (
2017c478bd9Sstevel@tonic-gate void)
2027c478bd9Sstevel@tonic-gate {
2037c478bd9Sstevel@tonic-gate ACPI_STATUS Status;
2047c478bd9Sstevel@tonic-gate
205db2bae30SDana Myers
20627f7c583Smyers ACPI_FUNCTION_TRACE (ExEnterInterpreter);
2077c478bd9Sstevel@tonic-gate
2087c478bd9Sstevel@tonic-gate
20927f7c583Smyers Status = AcpiUtAcquireMutex (ACPI_MTX_INTERPRETER);
2107c478bd9Sstevel@tonic-gate if (ACPI_FAILURE (Status))
2117c478bd9Sstevel@tonic-gate {
212db2bae30SDana Myers ACPI_ERROR ((AE_INFO, "Could not acquire AML Interpreter mutex"));
2137c478bd9Sstevel@tonic-gate }
214*35786f68SRobert Mustacchi Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
215*35786f68SRobert Mustacchi if (ACPI_FAILURE (Status))
216*35786f68SRobert Mustacchi {
217*35786f68SRobert Mustacchi ACPI_ERROR ((AE_INFO, "Could not acquire AML Namespace mutex"));
218*35786f68SRobert Mustacchi }
2197c478bd9Sstevel@tonic-gate
220db2bae30SDana Myers return_VOID;
2217c478bd9Sstevel@tonic-gate }
2227c478bd9Sstevel@tonic-gate
2237c478bd9Sstevel@tonic-gate
224db2bae30SDana Myers /*******************************************************************************
225db2bae30SDana Myers *
226db2bae30SDana Myers * FUNCTION: AcpiExExitInterpreter
227db2bae30SDana Myers *
228db2bae30SDana Myers * PARAMETERS: None
229db2bae30SDana Myers *
230db2bae30SDana Myers * RETURN: None
231db2bae30SDana Myers *
232db2bae30SDana Myers * DESCRIPTION: Exit the interpreter execution region. This is the top level
233db2bae30SDana Myers * routine used to exit the interpreter when all processing has
2347b1019a6SJerry Jelinek * been completed, or when the method blocks.
2357b1019a6SJerry Jelinek *
2367b1019a6SJerry Jelinek * Cases where the interpreter is unlocked internally:
2377b1019a6SJerry Jelinek * 1) Method will be blocked on a Sleep() AML opcode
2387b1019a6SJerry Jelinek * 2) Method will be blocked on an Acquire() AML opcode
2397b1019a6SJerry Jelinek * 3) Method will be blocked on a Wait() AML opcode
2407b1019a6SJerry Jelinek * 4) Method will be blocked to acquire the global lock
2417b1019a6SJerry Jelinek * 5) Method will be blocked waiting to execute a serialized control
2427b1019a6SJerry Jelinek * method that is currently executing
2437b1019a6SJerry Jelinek * 6) About to invoke a user-installed opregion handler
2447c478bd9Sstevel@tonic-gate *
2457c478bd9Sstevel@tonic-gate ******************************************************************************/
2467c478bd9Sstevel@tonic-gate
2477c478bd9Sstevel@tonic-gate void
AcpiExExitInterpreter(void)2487c478bd9Sstevel@tonic-gate AcpiExExitInterpreter (
2497c478bd9Sstevel@tonic-gate void)
2507c478bd9Sstevel@tonic-gate {
2517c478bd9Sstevel@tonic-gate ACPI_STATUS Status;
2527c478bd9Sstevel@tonic-gate
2537c478bd9Sstevel@tonic-gate
25427f7c583Smyers ACPI_FUNCTION_TRACE (ExExitInterpreter);
2557c478bd9Sstevel@tonic-gate
2567c478bd9Sstevel@tonic-gate
257*35786f68SRobert Mustacchi Status = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
258*35786f68SRobert Mustacchi if (ACPI_FAILURE (Status))
259*35786f68SRobert Mustacchi {
260*35786f68SRobert Mustacchi ACPI_ERROR ((AE_INFO, "Could not release AML Namespace mutex"));
261*35786f68SRobert Mustacchi }
26227f7c583Smyers Status = AcpiUtReleaseMutex (ACPI_MTX_INTERPRETER);
2637c478bd9Sstevel@tonic-gate if (ACPI_FAILURE (Status))
2647c478bd9Sstevel@tonic-gate {
265db2bae30SDana Myers ACPI_ERROR ((AE_INFO, "Could not release AML Interpreter mutex"));
266db2bae30SDana Myers }
267db2bae30SDana Myers
268db2bae30SDana Myers return_VOID;
269db2bae30SDana Myers }
270db2bae30SDana Myers
271db2bae30SDana Myers
2727c478bd9Sstevel@tonic-gate /*******************************************************************************
2737c478bd9Sstevel@tonic-gate *
2747c478bd9Sstevel@tonic-gate * FUNCTION: AcpiExTruncateFor32bitTable
2757c478bd9Sstevel@tonic-gate *
2767c478bd9Sstevel@tonic-gate * PARAMETERS: ObjDesc - Object to be truncated
2777c478bd9Sstevel@tonic-gate *
2787b1019a6SJerry Jelinek * RETURN: TRUE if a truncation was performed, FALSE otherwise.
2797c478bd9Sstevel@tonic-gate *
280db2bae30SDana Myers * DESCRIPTION: Truncate an ACPI Integer to 32 bits if the execution mode is
281db2bae30SDana Myers * 32-bit, as determined by the revision of the DSDT.
2827c478bd9Sstevel@tonic-gate *
2837c478bd9Sstevel@tonic-gate ******************************************************************************/
2847c478bd9Sstevel@tonic-gate
2857b1019a6SJerry Jelinek BOOLEAN
AcpiExTruncateFor32bitTable(ACPI_OPERAND_OBJECT * ObjDesc)2867c478bd9Sstevel@tonic-gate AcpiExTruncateFor32bitTable (
2877c478bd9Sstevel@tonic-gate ACPI_OPERAND_OBJECT *ObjDesc)
2887c478bd9Sstevel@tonic-gate {
2897c478bd9Sstevel@tonic-gate
2907c478bd9Sstevel@tonic-gate ACPI_FUNCTION_ENTRY ();
2917c478bd9Sstevel@tonic-gate
2927c478bd9Sstevel@tonic-gate
2937c478bd9Sstevel@tonic-gate /*
2947c478bd9Sstevel@tonic-gate * Object must be a valid number and we must be executing
2957b1019a6SJerry Jelinek * a control method. Object could be NS node for AML_INT_NAMEPATH_OP.
2967c478bd9Sstevel@tonic-gate */
2977c478bd9Sstevel@tonic-gate if ((!ObjDesc) ||
298db2bae30SDana Myers (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc) != ACPI_DESC_TYPE_OPERAND) ||
299aa2aa9a6SDana Myers (ObjDesc->Common.Type != ACPI_TYPE_INTEGER))
3007c478bd9Sstevel@tonic-gate {
3017b1019a6SJerry Jelinek return (FALSE);
3027c478bd9Sstevel@tonic-gate }
3037c478bd9Sstevel@tonic-gate
3047b1019a6SJerry Jelinek if ((AcpiGbl_IntegerByteWidth == 4) &&
3057b1019a6SJerry Jelinek (ObjDesc->Integer.Value > (UINT64) ACPI_UINT32_MAX))
3067c478bd9Sstevel@tonic-gate {
3077c478bd9Sstevel@tonic-gate /*
3087b1019a6SJerry Jelinek * We are executing in a 32-bit ACPI table. Truncate
3097b1019a6SJerry Jelinek * the value to 32 bits by zeroing out the upper 32-bit field
3107c478bd9Sstevel@tonic-gate */
31126f3cdf0SGordon Ross ObjDesc->Integer.Value &= (UINT64) ACPI_UINT32_MAX;
3127b1019a6SJerry Jelinek return (TRUE);
3137c478bd9Sstevel@tonic-gate }
3147b1019a6SJerry Jelinek
3157b1019a6SJerry Jelinek return (FALSE);
3167c478bd9Sstevel@tonic-gate }
3177c478bd9Sstevel@tonic-gate
3187c478bd9Sstevel@tonic-gate
3197c478bd9Sstevel@tonic-gate /*******************************************************************************
3207c478bd9Sstevel@tonic-gate *
3217c478bd9Sstevel@tonic-gate * FUNCTION: AcpiExAcquireGlobalLock
3227c478bd9Sstevel@tonic-gate *
3237c478bd9Sstevel@tonic-gate * PARAMETERS: FieldFlags - Flags with Lock rule:
3247c478bd9Sstevel@tonic-gate * AlwaysLock or NeverLock
3257c478bd9Sstevel@tonic-gate *
326db2bae30SDana Myers * RETURN: None
3277c478bd9Sstevel@tonic-gate *
328db2bae30SDana Myers * DESCRIPTION: Obtain the ACPI hardware Global Lock, only if the field
329db2bae30SDana Myers * flags specifiy that it is to be obtained before field access.
3307c478bd9Sstevel@tonic-gate *
3317c478bd9Sstevel@tonic-gate ******************************************************************************/
3327c478bd9Sstevel@tonic-gate
333db2bae30SDana Myers void
AcpiExAcquireGlobalLock(UINT32 FieldFlags)3347c478bd9Sstevel@tonic-gate AcpiExAcquireGlobalLock (
3357c478bd9Sstevel@tonic-gate UINT32 FieldFlags)
3367c478bd9Sstevel@tonic-gate {
3377c478bd9Sstevel@tonic-gate ACPI_STATUS Status;
3387c478bd9Sstevel@tonic-gate
3397c478bd9Sstevel@tonic-gate
34027f7c583Smyers ACPI_FUNCTION_TRACE (ExAcquireGlobalLock);
3417c478bd9Sstevel@tonic-gate
3427c478bd9Sstevel@tonic-gate
343db2bae30SDana Myers /* Only use the lock if the AlwaysLock bit is set */
3447c478bd9Sstevel@tonic-gate
345db2bae30SDana Myers if (!(FieldFlags & AML_FIELD_LOCK_RULE_MASK))
3467c478bd9Sstevel@tonic-gate {
347db2bae30SDana Myers return_VOID;
3487c478bd9Sstevel@tonic-gate }
3497c478bd9Sstevel@tonic-gate
350db2bae30SDana Myers /* Attempt to get the global lock, wait forever */
351db2bae30SDana Myers
352db2bae30SDana Myers Status = AcpiExAcquireMutexObject (ACPI_WAIT_FOREVER,
3537b1019a6SJerry Jelinek AcpiGbl_GlobalLockMutex, AcpiOsGetThreadId ());
354db2bae30SDana Myers
355db2bae30SDana Myers if (ACPI_FAILURE (Status))
356db2bae30SDana Myers {
357db2bae30SDana Myers ACPI_EXCEPTION ((AE_INFO, Status,
358db2bae30SDana Myers "Could not acquire Global Lock"));
359db2bae30SDana Myers }
360db2bae30SDana Myers
361db2bae30SDana Myers return_VOID;
3627c478bd9Sstevel@tonic-gate }
3637c478bd9Sstevel@tonic-gate
3647c478bd9Sstevel@tonic-gate
3657c478bd9Sstevel@tonic-gate /*******************************************************************************
3667c478bd9Sstevel@tonic-gate *
3677c478bd9Sstevel@tonic-gate * FUNCTION: AcpiExReleaseGlobalLock
3687c478bd9Sstevel@tonic-gate *
369db2bae30SDana Myers * PARAMETERS: FieldFlags - Flags with Lock rule:
370db2bae30SDana Myers * AlwaysLock or NeverLock
3717c478bd9Sstevel@tonic-gate *
3727c478bd9Sstevel@tonic-gate * RETURN: None
3737c478bd9Sstevel@tonic-gate *
374db2bae30SDana Myers * DESCRIPTION: Release the ACPI hardware Global Lock
3757c478bd9Sstevel@tonic-gate *
3767c478bd9Sstevel@tonic-gate ******************************************************************************/
3777c478bd9Sstevel@tonic-gate
3787c478bd9Sstevel@tonic-gate void
AcpiExReleaseGlobalLock(UINT32 FieldFlags)3797c478bd9Sstevel@tonic-gate AcpiExReleaseGlobalLock (
380db2bae30SDana Myers UINT32 FieldFlags)
3817c478bd9Sstevel@tonic-gate {
3827c478bd9Sstevel@tonic-gate ACPI_STATUS Status;
3837c478bd9Sstevel@tonic-gate
3847c478bd9Sstevel@tonic-gate
38527f7c583Smyers ACPI_FUNCTION_TRACE (ExReleaseGlobalLock);
3867c478bd9Sstevel@tonic-gate
3877c478bd9Sstevel@tonic-gate
388db2bae30SDana Myers /* Only use the lock if the AlwaysLock bit is set */
3897c478bd9Sstevel@tonic-gate
390db2bae30SDana Myers if (!(FieldFlags & AML_FIELD_LOCK_RULE_MASK))
3917c478bd9Sstevel@tonic-gate {
392db2bae30SDana Myers return_VOID;
393db2bae30SDana Myers }
3947c478bd9Sstevel@tonic-gate
395db2bae30SDana Myers /* Release the global lock */
3967c478bd9Sstevel@tonic-gate
397db2bae30SDana Myers Status = AcpiExReleaseMutexObject (AcpiGbl_GlobalLockMutex);
398db2bae30SDana Myers if (ACPI_FAILURE (Status))
399db2bae30SDana Myers {
400db2bae30SDana Myers /* Report the error, but there isn't much else we can do */
401db2bae30SDana Myers
402db2bae30SDana Myers ACPI_EXCEPTION ((AE_INFO, Status,
403db2bae30SDana Myers "Could not release Global Lock"));
4047c478bd9Sstevel@tonic-gate }
4057c478bd9Sstevel@tonic-gate
4067c478bd9Sstevel@tonic-gate return_VOID;
4077c478bd9Sstevel@tonic-gate }
4087c478bd9Sstevel@tonic-gate
4097c478bd9Sstevel@tonic-gate
4107c478bd9Sstevel@tonic-gate /*******************************************************************************
4117c478bd9Sstevel@tonic-gate *
4127c478bd9Sstevel@tonic-gate * FUNCTION: AcpiExDigitsNeeded
4137c478bd9Sstevel@tonic-gate *
4147c478bd9Sstevel@tonic-gate * PARAMETERS: Value - Value to be represented
4157c478bd9Sstevel@tonic-gate * Base - Base of representation
4167c478bd9Sstevel@tonic-gate *
4177c478bd9Sstevel@tonic-gate * RETURN: The number of digits.
4187c478bd9Sstevel@tonic-gate *
4197c478bd9Sstevel@tonic-gate * DESCRIPTION: Calculate the number of digits needed to represent the Value
4207c478bd9Sstevel@tonic-gate * in the given Base (Radix)
4217c478bd9Sstevel@tonic-gate *
4227c478bd9Sstevel@tonic-gate ******************************************************************************/
4237c478bd9Sstevel@tonic-gate
4247c478bd9Sstevel@tonic-gate static UINT32
AcpiExDigitsNeeded(UINT64 Value,UINT32 Base)4257c478bd9Sstevel@tonic-gate AcpiExDigitsNeeded (
42626f3cdf0SGordon Ross UINT64 Value,
4277c478bd9Sstevel@tonic-gate UINT32 Base)
4287c478bd9Sstevel@tonic-gate {
4297c478bd9Sstevel@tonic-gate UINT32 NumDigits;
43026f3cdf0SGordon Ross UINT64 CurrentValue;
4317c478bd9Sstevel@tonic-gate
4327c478bd9Sstevel@tonic-gate
43327f7c583Smyers ACPI_FUNCTION_TRACE (ExDigitsNeeded);
4347c478bd9Sstevel@tonic-gate
4357c478bd9Sstevel@tonic-gate
43626f3cdf0SGordon Ross /* UINT64 is unsigned, so we don't worry about a '-' prefix */
4377c478bd9Sstevel@tonic-gate
4387c478bd9Sstevel@tonic-gate if (Value == 0)
4397c478bd9Sstevel@tonic-gate {
440186507a7Smyers return_UINT32 (1);
4417c478bd9Sstevel@tonic-gate }
4427c478bd9Sstevel@tonic-gate
4437c478bd9Sstevel@tonic-gate CurrentValue = Value;
4447c478bd9Sstevel@tonic-gate NumDigits = 0;
4457c478bd9Sstevel@tonic-gate
4467c478bd9Sstevel@tonic-gate /* Count the digits in the requested base */
4477c478bd9Sstevel@tonic-gate
4487c478bd9Sstevel@tonic-gate while (CurrentValue)
4497c478bd9Sstevel@tonic-gate {
4507c478bd9Sstevel@tonic-gate (void) AcpiUtShortDivide (CurrentValue, Base, &CurrentValue, NULL);
4517c478bd9Sstevel@tonic-gate NumDigits++;
4527c478bd9Sstevel@tonic-gate }
4537c478bd9Sstevel@tonic-gate
454186507a7Smyers return_UINT32 (NumDigits);
4557c478bd9Sstevel@tonic-gate }
4567c478bd9Sstevel@tonic-gate
4577c478bd9Sstevel@tonic-gate
4587c478bd9Sstevel@tonic-gate /*******************************************************************************
4597c478bd9Sstevel@tonic-gate *
4607c478bd9Sstevel@tonic-gate * FUNCTION: AcpiExEisaIdToString
4617c478bd9Sstevel@tonic-gate *
4627b1019a6SJerry Jelinek * PARAMETERS: OutString - Where to put the converted string (8 bytes)
4637b1019a6SJerry Jelinek * CompressedId - EISAID to be converted
4647c478bd9Sstevel@tonic-gate *
4657c478bd9Sstevel@tonic-gate * RETURN: None
4667c478bd9Sstevel@tonic-gate *
46757190917SDana Myers * DESCRIPTION: Convert a numeric EISAID to string representation. Return
46857190917SDana Myers * buffer must be large enough to hold the string. The string
46957190917SDana Myers * returned is always exactly of length ACPI_EISAID_STRING_SIZE
47057190917SDana Myers * (includes null terminator). The EISAID is always 32 bits.
4717c478bd9Sstevel@tonic-gate *
4727c478bd9Sstevel@tonic-gate ******************************************************************************/
4737c478bd9Sstevel@tonic-gate
4747c478bd9Sstevel@tonic-gate void
AcpiExEisaIdToString(char * OutString,UINT64 CompressedId)4757c478bd9Sstevel@tonic-gate AcpiExEisaIdToString (
47657190917SDana Myers char *OutString,
47726f3cdf0SGordon Ross UINT64 CompressedId)
4787c478bd9Sstevel@tonic-gate {
47957190917SDana Myers UINT32 SwappedId;
4807c478bd9Sstevel@tonic-gate
4817c478bd9Sstevel@tonic-gate
4827c478bd9Sstevel@tonic-gate ACPI_FUNCTION_ENTRY ();
4837c478bd9Sstevel@tonic-gate
4847c478bd9Sstevel@tonic-gate
48557190917SDana Myers /* The EISAID should be a 32-bit integer */
48657190917SDana Myers
48757190917SDana Myers if (CompressedId > ACPI_UINT32_MAX)
48857190917SDana Myers {
48957190917SDana Myers ACPI_WARNING ((AE_INFO,
4907b1019a6SJerry Jelinek "Expected EISAID is larger than 32 bits: "
4917b1019a6SJerry Jelinek "0x%8.8X%8.8X, truncating",
49257190917SDana Myers ACPI_FORMAT_UINT64 (CompressedId)));
49357190917SDana Myers }
49457190917SDana Myers
4957c478bd9Sstevel@tonic-gate /* Swap ID to big-endian to get contiguous bits */
4967c478bd9Sstevel@tonic-gate
49757190917SDana Myers SwappedId = AcpiUtDwordByteSwap ((UINT32) CompressedId);
4987c478bd9Sstevel@tonic-gate
49957190917SDana Myers /* First 3 bytes are uppercase letters. Next 4 bytes are hexadecimal */
50057190917SDana Myers
50157190917SDana Myers OutString[0] = (char) (0x40 + (((unsigned long) SwappedId >> 26) & 0x1F));
50257190917SDana Myers OutString[1] = (char) (0x40 + ((SwappedId >> 21) & 0x1F));
50357190917SDana Myers OutString[2] = (char) (0x40 + ((SwappedId >> 16) & 0x1F));
50426f3cdf0SGordon Ross OutString[3] = AcpiUtHexToAsciiChar ((UINT64) SwappedId, 12);
50526f3cdf0SGordon Ross OutString[4] = AcpiUtHexToAsciiChar ((UINT64) SwappedId, 8);
50626f3cdf0SGordon Ross OutString[5] = AcpiUtHexToAsciiChar ((UINT64) SwappedId, 4);
50726f3cdf0SGordon Ross OutString[6] = AcpiUtHexToAsciiChar ((UINT64) SwappedId, 0);
5087c478bd9Sstevel@tonic-gate OutString[7] = 0;
5097c478bd9Sstevel@tonic-gate }
5107c478bd9Sstevel@tonic-gate
5117c478bd9Sstevel@tonic-gate
5127c478bd9Sstevel@tonic-gate /*******************************************************************************
5137c478bd9Sstevel@tonic-gate *
51457190917SDana Myers * FUNCTION: AcpiExIntegerToString
5157c478bd9Sstevel@tonic-gate *
51657190917SDana Myers * PARAMETERS: OutString - Where to put the converted string. At least
51757190917SDana Myers * 21 bytes are needed to hold the largest
51857190917SDana Myers * possible 64-bit integer.
51957190917SDana Myers * Value - Value to be converted
5207c478bd9Sstevel@tonic-gate *
5217b1019a6SJerry Jelinek * RETURN: Converted string in OutString
5227c478bd9Sstevel@tonic-gate *
52357190917SDana Myers * DESCRIPTION: Convert a 64-bit integer to decimal string representation.
52457190917SDana Myers * Assumes string buffer is large enough to hold the string. The
52557190917SDana Myers * largest string is (ACPI_MAX64_DECIMAL_DIGITS + 1).
5267c478bd9Sstevel@tonic-gate *
5277c478bd9Sstevel@tonic-gate ******************************************************************************/
5287c478bd9Sstevel@tonic-gate
5297c478bd9Sstevel@tonic-gate void
AcpiExIntegerToString(char * OutString,UINT64 Value)53057190917SDana Myers AcpiExIntegerToString (
53157190917SDana Myers char *OutString,
53226f3cdf0SGordon Ross UINT64 Value)
5337c478bd9Sstevel@tonic-gate {
5347c478bd9Sstevel@tonic-gate UINT32 Count;
5357c478bd9Sstevel@tonic-gate UINT32 DigitsNeeded;
5367c478bd9Sstevel@tonic-gate UINT32 Remainder;
5377c478bd9Sstevel@tonic-gate
5387c478bd9Sstevel@tonic-gate
5397c478bd9Sstevel@tonic-gate ACPI_FUNCTION_ENTRY ();
5407c478bd9Sstevel@tonic-gate
5417c478bd9Sstevel@tonic-gate
5427c478bd9Sstevel@tonic-gate DigitsNeeded = AcpiExDigitsNeeded (Value, 10);
5437c478bd9Sstevel@tonic-gate OutString[DigitsNeeded] = 0;
5447c478bd9Sstevel@tonic-gate
5457c478bd9Sstevel@tonic-gate for (Count = DigitsNeeded; Count > 0; Count--)
5467c478bd9Sstevel@tonic-gate {
5477c478bd9Sstevel@tonic-gate (void) AcpiUtShortDivide (Value, 10, &Value, &Remainder);
5487c478bd9Sstevel@tonic-gate OutString[Count-1] = (char) ('0' + Remainder);\
5497c478bd9Sstevel@tonic-gate }
5507c478bd9Sstevel@tonic-gate }
5517c478bd9Sstevel@tonic-gate
5527b1019a6SJerry Jelinek
5537b1019a6SJerry Jelinek /*******************************************************************************
5547b1019a6SJerry Jelinek *
5557b1019a6SJerry Jelinek * FUNCTION: AcpiExPciClsToString
5567b1019a6SJerry Jelinek *
5577b1019a6SJerry Jelinek * PARAMETERS: OutString - Where to put the converted string (7 bytes)
5587b1019a6SJerry Jelinek * ClassCode - PCI class code to be converted (3 bytes)
5597b1019a6SJerry Jelinek *
5607b1019a6SJerry Jelinek * RETURN: Converted string in OutString
5617b1019a6SJerry Jelinek *
5627b1019a6SJerry Jelinek * DESCRIPTION: Convert 3-bytes PCI class code to string representation.
5637b1019a6SJerry Jelinek * Return buffer must be large enough to hold the string. The
5647b1019a6SJerry Jelinek * string returned is always exactly of length
5657b1019a6SJerry Jelinek * ACPI_PCICLS_STRING_SIZE (includes null terminator).
5667b1019a6SJerry Jelinek *
5677b1019a6SJerry Jelinek ******************************************************************************/
5687b1019a6SJerry Jelinek
5697b1019a6SJerry Jelinek void
AcpiExPciClsToString(char * OutString,UINT8 ClassCode[3])5707b1019a6SJerry Jelinek AcpiExPciClsToString (
5717b1019a6SJerry Jelinek char *OutString,
5727b1019a6SJerry Jelinek UINT8 ClassCode[3])
5737b1019a6SJerry Jelinek {
5747b1019a6SJerry Jelinek
5757b1019a6SJerry Jelinek ACPI_FUNCTION_ENTRY ();
5767b1019a6SJerry Jelinek
5777b1019a6SJerry Jelinek
5787b1019a6SJerry Jelinek /* All 3 bytes are hexadecimal */
5797b1019a6SJerry Jelinek
5807b1019a6SJerry Jelinek OutString[0] = AcpiUtHexToAsciiChar ((UINT64) ClassCode[0], 4);
5817b1019a6SJerry Jelinek OutString[1] = AcpiUtHexToAsciiChar ((UINT64) ClassCode[0], 0);
5827b1019a6SJerry Jelinek OutString[2] = AcpiUtHexToAsciiChar ((UINT64) ClassCode[1], 4);
5837b1019a6SJerry Jelinek OutString[3] = AcpiUtHexToAsciiChar ((UINT64) ClassCode[1], 0);
5847b1019a6SJerry Jelinek OutString[4] = AcpiUtHexToAsciiChar ((UINT64) ClassCode[2], 4);
5857b1019a6SJerry Jelinek OutString[5] = AcpiUtHexToAsciiChar ((UINT64) ClassCode[2], 0);
5867b1019a6SJerry Jelinek OutString[6] = 0;
5877b1019a6SJerry Jelinek }
5887b1019a6SJerry Jelinek
5897b1019a6SJerry Jelinek
5907b1019a6SJerry Jelinek /*******************************************************************************
5917b1019a6SJerry Jelinek *
5927b1019a6SJerry Jelinek * FUNCTION: AcpiIsValidSpaceId
5937b1019a6SJerry Jelinek *
5947b1019a6SJerry Jelinek * PARAMETERS: SpaceId - ID to be validated
5957b1019a6SJerry Jelinek *
5967b1019a6SJerry Jelinek * RETURN: TRUE if SpaceId is a valid/supported ID.
5977b1019a6SJerry Jelinek *
5987b1019a6SJerry Jelinek * DESCRIPTION: Validate an operation region SpaceID.
5997b1019a6SJerry Jelinek *
6007b1019a6SJerry Jelinek ******************************************************************************/
6017b1019a6SJerry Jelinek
6027b1019a6SJerry Jelinek BOOLEAN
AcpiIsValidSpaceId(UINT8 SpaceId)6037b1019a6SJerry Jelinek AcpiIsValidSpaceId (
6047b1019a6SJerry Jelinek UINT8 SpaceId)
6057b1019a6SJerry Jelinek {
6067b1019a6SJerry Jelinek
6077b1019a6SJerry Jelinek if ((SpaceId >= ACPI_NUM_PREDEFINED_REGIONS) &&
6087b1019a6SJerry Jelinek (SpaceId < ACPI_USER_REGION_BEGIN) &&
6097b1019a6SJerry Jelinek (SpaceId != ACPI_ADR_SPACE_DATA_TABLE) &&
6107b1019a6SJerry Jelinek (SpaceId != ACPI_ADR_SPACE_FIXED_HARDWARE))
6117b1019a6SJerry Jelinek {
6127b1019a6SJerry Jelinek return (FALSE);
6137b1019a6SJerry Jelinek }
6147b1019a6SJerry Jelinek
6157b1019a6SJerry Jelinek return (TRUE);
6167b1019a6SJerry Jelinek }
6177b1019a6SJerry Jelinek
6187c478bd9Sstevel@tonic-gate #endif
619