1 /******************************************************************************
2  *
3  * Module Name: exutils - interpreter/scanner utilities
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
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
19  * property rights.
20  *
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
27  *
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;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
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.
53  *
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
64  * make.
65  *
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
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
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.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
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
88  * PARTICULAR PURPOSE.
89  *
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
97  * LIMITED REMEDY.
98  *
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.
113  *
114  *****************************************************************************
115  *
116  * Alternatively, you may choose to be licensed under the terms of the
117  * following license:
118  *
119  * Redistribution and use in source and binary forms, with or without
120  * modification, are permitted provided that the following conditions
121  * are met:
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.
133  *
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.
145  *
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.
149  *
150  *****************************************************************************/
151 
152 /*
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
157  * in question.
158  *
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
163  * header files.
164  */
165 
166 #define DEFINE_AML_GLOBALS
167 
168 #include "acpi.h"
169 #include "accommon.h"
170 #include "acinterp.h"
171 #include "amlcode.h"
172 
173 #define _COMPONENT          ACPI_EXECUTER
174         ACPI_MODULE_NAME    ("exutils")
175 
176 /* Local prototypes */
177 
178 static UINT32
179 AcpiExDigitsNeeded (
180     UINT64                  Value,
181     UINT32                  Base);
182 
183 
184 #ifndef ACPI_NO_METHOD_EXECUTION
185 /*******************************************************************************
186  *
187  * FUNCTION:    AcpiExEnterInterpreter
188  *
189  * PARAMETERS:  None
190  *
191  * RETURN:      None
192  *
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.
196  *
197  ******************************************************************************/
198 
199 void
AcpiExEnterInterpreter(void)200 AcpiExEnterInterpreter (
201     void)
202 {
203     ACPI_STATUS             Status;
204 
205 
206     ACPI_FUNCTION_TRACE (ExEnterInterpreter);
207 
208 
209     Status = AcpiUtAcquireMutex (ACPI_MTX_INTERPRETER);
210     if (ACPI_FAILURE (Status))
211     {
212         ACPI_ERROR ((AE_INFO, "Could not acquire AML Interpreter mutex"));
213     }
214     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
215     if (ACPI_FAILURE (Status))
216     {
217         ACPI_ERROR ((AE_INFO, "Could not acquire AML Namespace mutex"));
218     }
219 
220     return_VOID;
221 }
222 
223 
224 /*******************************************************************************
225  *
226  * FUNCTION:    AcpiExExitInterpreter
227  *
228  * PARAMETERS:  None
229  *
230  * RETURN:      None
231  *
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.
235  *
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
244  *
245  ******************************************************************************/
246 
247 void
AcpiExExitInterpreter(void)248 AcpiExExitInterpreter (
249     void)
250 {
251     ACPI_STATUS             Status;
252 
253 
254     ACPI_FUNCTION_TRACE (ExExitInterpreter);
255 
256 
257     Status = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
258     if (ACPI_FAILURE (Status))
259     {
260         ACPI_ERROR ((AE_INFO, "Could not release AML Namespace mutex"));
261     }
262     Status = AcpiUtReleaseMutex (ACPI_MTX_INTERPRETER);
263     if (ACPI_FAILURE (Status))
264     {
265         ACPI_ERROR ((AE_INFO, "Could not release AML Interpreter mutex"));
266     }
267 
268     return_VOID;
269 }
270 
271 
272 /*******************************************************************************
273  *
274  * FUNCTION:    AcpiExTruncateFor32bitTable
275  *
276  * PARAMETERS:  ObjDesc         - Object to be truncated
277  *
278  * RETURN:      TRUE if a truncation was performed, FALSE otherwise.
279  *
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.
282  *
283  ******************************************************************************/
284 
285 BOOLEAN
AcpiExTruncateFor32bitTable(ACPI_OPERAND_OBJECT * ObjDesc)286 AcpiExTruncateFor32bitTable (
287     ACPI_OPERAND_OBJECT     *ObjDesc)
288 {
289 
290     ACPI_FUNCTION_ENTRY ();
291 
292 
293     /*
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.
296      */
297     if ((!ObjDesc) ||
298         (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc) != ACPI_DESC_TYPE_OPERAND) ||
299         (ObjDesc->Common.Type != ACPI_TYPE_INTEGER))
300     {
301         return (FALSE);
302     }
303 
304     if ((AcpiGbl_IntegerByteWidth == 4) &&
305         (ObjDesc->Integer.Value > (UINT64) ACPI_UINT32_MAX))
306     {
307         /*
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
310          */
311         ObjDesc->Integer.Value &= (UINT64) ACPI_UINT32_MAX;
312         return (TRUE);
313     }
314 
315     return (FALSE);
316 }
317 
318 
319 /*******************************************************************************
320  *
321  * FUNCTION:    AcpiExAcquireGlobalLock
322  *
323  * PARAMETERS:  FieldFlags            - Flags with Lock rule:
324  *                                      AlwaysLock or NeverLock
325  *
326  * RETURN:      None
327  *
328  * DESCRIPTION: Obtain the ACPI hardware Global Lock, only if the field
329  *              flags specifiy that it is to be obtained before field access.
330  *
331  ******************************************************************************/
332 
333 void
AcpiExAcquireGlobalLock(UINT32 FieldFlags)334 AcpiExAcquireGlobalLock (
335     UINT32                  FieldFlags)
336 {
337     ACPI_STATUS             Status;
338 
339 
340     ACPI_FUNCTION_TRACE (ExAcquireGlobalLock);
341 
342 
343     /* Only use the lock if the AlwaysLock bit is set */
344 
345     if (!(FieldFlags & AML_FIELD_LOCK_RULE_MASK))
346     {
347         return_VOID;
348     }
349 
350     /* Attempt to get the global lock, wait forever */
351 
352     Status = AcpiExAcquireMutexObject (ACPI_WAIT_FOREVER,
353         AcpiGbl_GlobalLockMutex, AcpiOsGetThreadId ());
354 
355     if (ACPI_FAILURE (Status))
356     {
357         ACPI_EXCEPTION ((AE_INFO, Status,
358             "Could not acquire Global Lock"));
359     }
360 
361     return_VOID;
362 }
363 
364 
365 /*******************************************************************************
366  *
367  * FUNCTION:    AcpiExReleaseGlobalLock
368  *
369  * PARAMETERS:  FieldFlags            - Flags with Lock rule:
370  *                                      AlwaysLock or NeverLock
371  *
372  * RETURN:      None
373  *
374  * DESCRIPTION: Release the ACPI hardware Global Lock
375  *
376  ******************************************************************************/
377 
378 void
AcpiExReleaseGlobalLock(UINT32 FieldFlags)379 AcpiExReleaseGlobalLock (
380     UINT32                  FieldFlags)
381 {
382     ACPI_STATUS             Status;
383 
384 
385     ACPI_FUNCTION_TRACE (ExReleaseGlobalLock);
386 
387 
388     /* Only use the lock if the AlwaysLock bit is set */
389 
390     if (!(FieldFlags & AML_FIELD_LOCK_RULE_MASK))
391     {
392         return_VOID;
393     }
394 
395     /* Release the global lock */
396 
397     Status = AcpiExReleaseMutexObject (AcpiGbl_GlobalLockMutex);
398     if (ACPI_FAILURE (Status))
399     {
400         /* Report the error, but there isn't much else we can do */
401 
402         ACPI_EXCEPTION ((AE_INFO, Status,
403             "Could not release Global Lock"));
404     }
405 
406     return_VOID;
407 }
408 
409 
410 /*******************************************************************************
411  *
412  * FUNCTION:    AcpiExDigitsNeeded
413  *
414  * PARAMETERS:  Value           - Value to be represented
415  *              Base            - Base of representation
416  *
417  * RETURN:      The number of digits.
418  *
419  * DESCRIPTION: Calculate the number of digits needed to represent the Value
420  *              in the given Base (Radix)
421  *
422  ******************************************************************************/
423 
424 static UINT32
AcpiExDigitsNeeded(UINT64 Value,UINT32 Base)425 AcpiExDigitsNeeded (
426     UINT64                  Value,
427     UINT32                  Base)
428 {
429     UINT32                  NumDigits;
430     UINT64                  CurrentValue;
431 
432 
433     ACPI_FUNCTION_TRACE (ExDigitsNeeded);
434 
435 
436     /* UINT64 is unsigned, so we don't worry about a '-' prefix */
437 
438     if (Value == 0)
439     {
440         return_UINT32 (1);
441     }
442 
443     CurrentValue = Value;
444     NumDigits = 0;
445 
446     /* Count the digits in the requested base */
447 
448     while (CurrentValue)
449     {
450         (void) AcpiUtShortDivide (CurrentValue, Base, &CurrentValue, NULL);
451         NumDigits++;
452     }
453 
454     return_UINT32 (NumDigits);
455 }
456 
457 
458 /*******************************************************************************
459  *
460  * FUNCTION:    AcpiExEisaIdToString
461  *
462  * PARAMETERS:  OutString       - Where to put the converted string (8 bytes)
463  *              CompressedId    - EISAID to be converted
464  *
465  * RETURN:      None
466  *
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.
471  *
472  ******************************************************************************/
473 
474 void
AcpiExEisaIdToString(char * OutString,UINT64 CompressedId)475 AcpiExEisaIdToString (
476     char                    *OutString,
477     UINT64                  CompressedId)
478 {
479     UINT32                  SwappedId;
480 
481 
482     ACPI_FUNCTION_ENTRY ();
483 
484 
485     /* The EISAID should be a 32-bit integer */
486 
487     if (CompressedId > ACPI_UINT32_MAX)
488     {
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)));
493     }
494 
495     /* Swap ID to big-endian to get contiguous bits */
496 
497     SwappedId = AcpiUtDwordByteSwap ((UINT32) CompressedId);
498 
499     /* First 3 bytes are uppercase letters. Next 4 bytes are hexadecimal */
500 
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);
508     OutString[7] = 0;
509 }
510 
511 
512 /*******************************************************************************
513  *
514  * FUNCTION:    AcpiExIntegerToString
515  *
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
520  *
521  * RETURN:      Converted string in OutString
522  *
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).
526  *
527  ******************************************************************************/
528 
529 void
AcpiExIntegerToString(char * OutString,UINT64 Value)530 AcpiExIntegerToString (
531     char                    *OutString,
532     UINT64                  Value)
533 {
534     UINT32                  Count;
535     UINT32                  DigitsNeeded;
536     UINT32                  Remainder;
537 
538 
539     ACPI_FUNCTION_ENTRY ();
540 
541 
542     DigitsNeeded = AcpiExDigitsNeeded (Value, 10);
543     OutString[DigitsNeeded] = 0;
544 
545     for (Count = DigitsNeeded; Count > 0; Count--)
546     {
547         (void) AcpiUtShortDivide (Value, 10, &Value, &Remainder);
548         OutString[Count-1] = (char) ('0' + Remainder);\
549     }
550 }
551 
552 
553 /*******************************************************************************
554  *
555  * FUNCTION:    AcpiExPciClsToString
556  *
557  * PARAMETERS:  OutString       - Where to put the converted string (7 bytes)
558  *              ClassCode       - PCI class code to be converted (3 bytes)
559  *
560  * RETURN:      Converted string in OutString
561  *
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).
566  *
567  ******************************************************************************/
568 
569 void
AcpiExPciClsToString(char * OutString,UINT8 ClassCode[3])570 AcpiExPciClsToString (
571     char                    *OutString,
572     UINT8                   ClassCode[3])
573 {
574 
575     ACPI_FUNCTION_ENTRY ();
576 
577 
578     /* All 3 bytes are hexadecimal */
579 
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);
586     OutString[6] = 0;
587 }
588 
589 
590 /*******************************************************************************
591  *
592  * FUNCTION:    AcpiIsValidSpaceId
593  *
594  * PARAMETERS:  SpaceId             - ID to be validated
595  *
596  * RETURN:      TRUE if SpaceId is a valid/supported ID.
597  *
598  * DESCRIPTION: Validate an operation region SpaceID.
599  *
600  ******************************************************************************/
601 
602 BOOLEAN
AcpiIsValidSpaceId(UINT8 SpaceId)603 AcpiIsValidSpaceId (
604     UINT8                   SpaceId)
605 {
606 
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))
611     {
612         return (FALSE);
613     }
614 
615     return (TRUE);
616 }
617 
618 #endif
619