utglobal.c revision 102550
1/******************************************************************************
2 *
3 * Module Name: utglobal - Global variables for the ACPI subsystem
4 *              $Revision: 168 $
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999 - 2002, Intel Corp.
13 * All rights reserved.
14 *
15 * 2. License
16 *
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights.  You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
20 * property rights.
21 *
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
28 *
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code.  No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
37 *
38 * The above copyright and patent license is granted only if the following
39 * conditions are met:
40 *
41 * 3. Conditions
42 *
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision.  In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change.  Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee.  Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
54 *
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution.  In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
65 * make.
66 *
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
71 * distribution.
72 *
73 * 3.4. Intel retains all right, title, and interest in and to the Original
74 * Intel Code.
75 *
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
80 *
81 * 4. Disclaimer and Export Compliance
82 *
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89 * PARTICULAR PURPOSE.
90 *
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
98 * LIMITED REMEDY.
99 *
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government.  In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
114 *
115 *****************************************************************************/
116
117#define __UTGLOBAL_C__
118#define DEFINE_ACPI_GLOBALS
119
120#include "acpi.h"
121#include "acnamesp.h"
122#include "amlcode.h"
123
124#define _COMPONENT          ACPI_UTILITIES
125        ACPI_MODULE_NAME    ("utglobal")
126
127
128/******************************************************************************
129 *
130 * FUNCTION:    AcpiFormatException
131 *
132 * PARAMETERS:  Status       - The ACPI_STATUS code to be formatted
133 *
134 * RETURN:      A string containing the exception  text
135 *
136 * DESCRIPTION: This function translates an ACPI exception into an ASCII string.
137 *
138 ******************************************************************************/
139
140const char *
141AcpiFormatException (
142    ACPI_STATUS             Status)
143{
144    const char              *Exception = "UNKNOWN_STATUS_CODE";
145    ACPI_STATUS             SubStatus;
146
147
148    ACPI_FUNCTION_NAME ("FormatException");
149
150
151    SubStatus = (Status & ~AE_CODE_MASK);
152
153    switch (Status & AE_CODE_MASK)
154    {
155    case AE_CODE_ENVIRONMENTAL:
156
157        if (SubStatus <= AE_CODE_ENV_MAX)
158        {
159            Exception = AcpiGbl_ExceptionNames_Env [SubStatus];
160            break;
161        }
162        goto Unknown;
163
164    case AE_CODE_PROGRAMMER:
165
166        if (SubStatus <= AE_CODE_PGM_MAX)
167        {
168            Exception = AcpiGbl_ExceptionNames_Pgm [SubStatus -1];
169            break;
170        }
171        goto Unknown;
172
173    case AE_CODE_ACPI_TABLES:
174
175        if (SubStatus <= AE_CODE_TBL_MAX)
176        {
177            Exception = AcpiGbl_ExceptionNames_Tbl [SubStatus -1];
178            break;
179        }
180        goto Unknown;
181
182    case AE_CODE_AML:
183
184        if (SubStatus <= AE_CODE_AML_MAX)
185        {
186            Exception = AcpiGbl_ExceptionNames_Aml [SubStatus -1];
187            break;
188        }
189        goto Unknown;
190
191    case AE_CODE_CONTROL:
192
193        if (SubStatus <= AE_CODE_CTRL_MAX)
194        {
195            Exception = AcpiGbl_ExceptionNames_Ctrl [SubStatus -1];
196            break;
197        }
198        goto Unknown;
199
200    default:
201        goto Unknown;
202    }
203
204
205    return ((const char *) Exception);
206
207Unknown:
208
209    ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Unknown exception code: 0x%8.8X\n", Status));
210    return ((const char *) Exception);
211}
212
213
214/******************************************************************************
215 *
216 * Static global variable initialization.
217 *
218 ******************************************************************************/
219
220/*
221 * We want the debug switches statically initialized so they
222 * are already set when the debugger is entered.
223 */
224
225/* Debug switch - level and trace mask */
226
227#ifdef ACPI_DEBUG_OUTPUT
228UINT32                      AcpiDbgLevel = DEBUG_DEFAULT;
229#else
230UINT32                      AcpiDbgLevel = NORMAL_DEFAULT;
231#endif
232
233/* Debug switch - layer (component) mask */
234
235UINT32                      AcpiDbgLayer = ACPI_COMPONENT_DEFAULT;
236UINT32                      AcpiGbl_NestingLevel = 0;
237
238
239/* Debugger globals */
240
241BOOLEAN                     AcpiGbl_DbTerminateThreads = FALSE;
242BOOLEAN                     AcpiGbl_MethodExecuting = FALSE;
243
244/* System flags */
245
246UINT32                      AcpiGbl_StartupFlags = 0;
247
248/* System starts uninitialized */
249
250BOOLEAN                     AcpiGbl_Shutdown = TRUE;
251
252const UINT8                 AcpiGbl_DecodeTo8bit [8] = {1,2,4,8,16,32,64,128};
253
254const NATIVE_CHAR           *AcpiGbl_DbSleepStates[ACPI_NUM_SLEEP_STATES] = {
255                                "\\_S0_","\\_S1_","\\_S2_","\\_S3_",
256                                "\\_S4_","\\_S5_","\\_S4B"};
257
258
259/******************************************************************************
260 *
261 * Namespace globals
262 *
263 ******************************************************************************/
264
265
266/*
267 * Names built-in to the interpreter
268 *
269 * Initial values are currently supported only for types String and Number.
270 * To avoid type punning, both are specified as strings in this table.
271 *
272 * NOTES:
273 * 1) _SB_ is defined to be a device to allow _SB_/_INI to be run
274 *    during the initialization sequence.
275 */
276
277const ACPI_PREDEFINED_NAMES     AcpiGbl_PreDefinedNames[] =
278{
279    {"_GPE",    INTERNAL_TYPE_DEF_ANY,      NULL},
280    {"_PR_",    INTERNAL_TYPE_DEF_ANY,      NULL},
281    {"_SB_",    ACPI_TYPE_DEVICE,           NULL},
282    {"_SI_",    INTERNAL_TYPE_DEF_ANY,      NULL},
283    {"_TZ_",    INTERNAL_TYPE_DEF_ANY,      NULL},
284    {"_REV",    ACPI_TYPE_INTEGER,          "2"},
285    {"_OS_",    ACPI_TYPE_STRING,           ACPI_OS_NAME},
286    {"_GL_",    ACPI_TYPE_MUTEX,            "0"},
287
288#if defined (ACPI_NO_METHOD_EXECUTION) || defined (ACPI_CONSTANT_EVAL_ONLY)
289    {"_OSI",    ACPI_TYPE_METHOD,           "1"},
290#endif
291    {NULL,      ACPI_TYPE_ANY,              NULL}              /* Table terminator */
292};
293
294
295/*
296 * Properties of the ACPI Object Types, both internal and external.
297 *
298 * Elements of AcpiNsProperties are bit significant
299 * and the table is indexed by values of ACPI_OBJECT_TYPE
300 */
301
302const UINT8                     AcpiGbl_NsProperties[] =
303{
304    ACPI_NS_NORMAL,                     /* 00 Any              */
305    ACPI_NS_NORMAL,                     /* 01 Number           */
306    ACPI_NS_NORMAL,                     /* 02 String           */
307    ACPI_NS_NORMAL,                     /* 03 Buffer           */
308    ACPI_NS_NORMAL,                     /* 04 Package          */
309    ACPI_NS_NORMAL,                     /* 05 FieldUnit        */
310    ACPI_NS_NEWSCOPE,                   /* 06 Device           */
311    ACPI_NS_NORMAL,                     /* 07 Event            */
312    ACPI_NS_NEWSCOPE,                   /* 08 Method           */
313    ACPI_NS_NORMAL,                     /* 09 Mutex            */
314    ACPI_NS_NORMAL,                     /* 10 Region           */
315    ACPI_NS_NEWSCOPE,                   /* 11 Power            */
316    ACPI_NS_NEWSCOPE,                   /* 12 Processor        */
317    ACPI_NS_NEWSCOPE,                   /* 13 Thermal          */
318    ACPI_NS_NORMAL,                     /* 14 BufferField      */
319    ACPI_NS_NORMAL,                     /* 15 DdbHandle        */
320    ACPI_NS_NORMAL,                     /* 16 Debug Object     */
321    ACPI_NS_NORMAL,                     /* 17 DefField         */
322    ACPI_NS_NORMAL,                     /* 18 BankField        */
323    ACPI_NS_NORMAL,                     /* 19 IndexField       */
324    ACPI_NS_NORMAL,                     /* 20 Reference        */
325    ACPI_NS_NORMAL,                     /* 21 Alias            */
326    ACPI_NS_NORMAL,                     /* 22 Notify           */
327    ACPI_NS_NORMAL,                     /* 23 Address Handler  */
328    ACPI_NS_NEWSCOPE | ACPI_NS_LOCAL,   /* 24 Resource Desc    */
329    ACPI_NS_NEWSCOPE | ACPI_NS_LOCAL,   /* 25 Resource Field   */
330    ACPI_NS_NORMAL,                     /* 26 DefFieldDefn     */
331    ACPI_NS_NORMAL,                     /* 27 BankFieldDefn    */
332    ACPI_NS_NORMAL,                     /* 28 IndexFieldDefn   */
333    ACPI_NS_NORMAL,                     /* 29 If               */
334    ACPI_NS_NORMAL,                     /* 30 Else             */
335    ACPI_NS_NORMAL,                     /* 31 While            */
336    ACPI_NS_NEWSCOPE,                   /* 32 Scope            */
337    ACPI_NS_LOCAL,                      /* 33 DefAny           */
338    ACPI_NS_NORMAL,                     /* 34 Extra            */
339    ACPI_NS_NORMAL,                     /* 35 Data             */
340    ACPI_NS_NORMAL                      /* 36 Invalid          */
341};
342
343
344/* Hex to ASCII conversion table */
345
346static const NATIVE_CHAR    AcpiGbl_HexToAscii[] =
347                                {'0','1','2','3','4','5','6','7',
348                                 '8','9','A','B','C','D','E','F'};
349
350/*****************************************************************************
351 *
352 * FUNCTION:    AcpiUtHexToAsciiChar
353 *
354 * PARAMETERS:  Integer             - Contains the hex digit
355 *              Position            - bit position of the digit within the
356 *                                    integer
357 *
358 * RETURN:      Ascii character
359 *
360 * DESCRIPTION: Convert a hex digit to an ascii character
361 *
362 ****************************************************************************/
363
364char
365AcpiUtHexToAsciiChar (
366    ACPI_INTEGER            Integer,
367    UINT32                  Position)
368{
369
370    return (AcpiGbl_HexToAscii[(Integer >> Position) & 0xF]);
371}
372
373
374/******************************************************************************
375 *
376 * Table name globals
377 *
378 * NOTE: This table includes ONLY the ACPI tables that the subsystem consumes.
379 * it is NOT an exhaustive list of all possible ACPI tables.  All ACPI tables
380 * that are not used by the subsystem are simply ignored.
381 *
382 * Do NOT add any table to this list that is not consumed directly by this
383 * subsystem.
384 *
385 ******************************************************************************/
386
387
388ACPI_TABLE_DESC             AcpiGbl_AcpiTables[NUM_ACPI_TABLES];
389
390
391ACPI_TABLE_SUPPORT          AcpiGbl_AcpiTableData[NUM_ACPI_TABLES] =
392{
393    /***********    Name,   Signature, Global typed pointer     Signature size,      Type                  How many allowed?,    Contains valid AML? */
394
395    /* RSDP 0 */ {RSDP_NAME, RSDP_SIG, NULL,                    sizeof (RSDP_SIG)-1, ACPI_TABLE_ROOT     | ACPI_TABLE_SINGLE},
396    /* DSDT 1 */ {DSDT_SIG,  DSDT_SIG, (void **) &AcpiGbl_DSDT, sizeof (DSDT_SIG)-1, ACPI_TABLE_SECONDARY| ACPI_TABLE_SINGLE   | ACPI_TABLE_EXECUTABLE},
397    /* FADT 2 */ {FADT_SIG,  FADT_SIG, (void **) &AcpiGbl_FADT, sizeof (FADT_SIG)-1, ACPI_TABLE_PRIMARY  | ACPI_TABLE_SINGLE},
398    /* FACS 3 */ {FACS_SIG,  FACS_SIG, (void **) &AcpiGbl_FACS, sizeof (FACS_SIG)-1, ACPI_TABLE_SECONDARY| ACPI_TABLE_SINGLE},
399    /* PSDT 4 */ {PSDT_SIG,  PSDT_SIG, NULL,                    sizeof (PSDT_SIG)-1, ACPI_TABLE_PRIMARY  | ACPI_TABLE_MULTIPLE | ACPI_TABLE_EXECUTABLE},
400    /* SSDT 5 */ {SSDT_SIG,  SSDT_SIG, NULL,                    sizeof (SSDT_SIG)-1, ACPI_TABLE_PRIMARY  | ACPI_TABLE_MULTIPLE | ACPI_TABLE_EXECUTABLE},
401    /* XSDT 6 */ {XSDT_SIG,  XSDT_SIG, NULL,                    sizeof (RSDT_SIG)-1, ACPI_TABLE_ROOT     | ACPI_TABLE_SINGLE},
402};
403
404
405/******************************************************************************
406 *
407 * Event and Hardware globals
408 *
409 ******************************************************************************/
410
411ACPI_BIT_REGISTER_INFO      AcpiGbl_BitRegisterInfo[ACPI_NUM_BITREG] =
412{
413    /* Name                                     Parent Register             Register Bit Position                   Register Bit Mask       */
414
415    /* ACPI_BITREG_TIMER_STATUS         */   {ACPI_REGISTER_PM1_STATUS,   ACPI_BITPOSITION_TIMER_STATUS,          ACPI_BITMASK_TIMER_STATUS},
416    /* ACPI_BITREG_BUS_MASTER_STATUS    */   {ACPI_REGISTER_PM1_STATUS,   ACPI_BITPOSITION_BUS_MASTER_STATUS,     ACPI_BITMASK_BUS_MASTER_STATUS},
417    /* ACPI_BITREG_GLOBAL_LOCK_STATUS   */   {ACPI_REGISTER_PM1_STATUS,   ACPI_BITPOSITION_GLOBAL_LOCK_STATUS,    ACPI_BITMASK_GLOBAL_LOCK_STATUS},
418    /* ACPI_BITREG_POWER_BUTTON_STATUS  */   {ACPI_REGISTER_PM1_STATUS,   ACPI_BITPOSITION_POWER_BUTTON_STATUS,   ACPI_BITMASK_POWER_BUTTON_STATUS},
419    /* ACPI_BITREG_SLEEP_BUTTON_STATUS  */   {ACPI_REGISTER_PM1_STATUS,   ACPI_BITPOSITION_SLEEP_BUTTON_STATUS,   ACPI_BITMASK_SLEEP_BUTTON_STATUS},
420    /* ACPI_BITREG_RT_CLOCK_STATUS      */   {ACPI_REGISTER_PM1_STATUS,   ACPI_BITPOSITION_RT_CLOCK_STATUS,       ACPI_BITMASK_RT_CLOCK_STATUS},
421    /* ACPI_BITREG_WAKE_STATUS          */   {ACPI_REGISTER_PM1_STATUS,   ACPI_BITPOSITION_WAKE_STATUS,           ACPI_BITMASK_WAKE_STATUS},
422
423    /* ACPI_BITREG_TIMER_ENABLE         */   {ACPI_REGISTER_PM1_ENABLE,   ACPI_BITPOSITION_TIMER_ENABLE,          ACPI_BITMASK_TIMER_ENABLE},
424    /* ACPI_BITREG_GLOBAL_LOCK_ENABLE   */   {ACPI_REGISTER_PM1_ENABLE,   ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE,    ACPI_BITMASK_GLOBAL_LOCK_ENABLE},
425    /* ACPI_BITREG_POWER_BUTTON_ENABLE  */   {ACPI_REGISTER_PM1_ENABLE,   ACPI_BITPOSITION_POWER_BUTTON_ENABLE,   ACPI_BITMASK_POWER_BUTTON_ENABLE},
426    /* ACPI_BITREG_SLEEP_BUTTON_ENABLE  */   {ACPI_REGISTER_PM1_ENABLE,   ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE,   ACPI_BITMASK_SLEEP_BUTTON_ENABLE},
427    /* ACPI_BITREG_RT_CLOCK_ENABLE      */   {ACPI_REGISTER_PM1_ENABLE,   ACPI_BITPOSITION_RT_CLOCK_ENABLE,       ACPI_BITMASK_RT_CLOCK_ENABLE},
428    /* ACPI_BITREG_WAKE_ENABLE          */   {ACPI_REGISTER_PM1_ENABLE,   0,                                      0},
429
430    /* ACPI_BITREG_SCI_ENABLE           */   {ACPI_REGISTER_PM1_CONTROL,  ACPI_BITPOSITION_SCI_ENABLE,            ACPI_BITMASK_SCI_ENABLE},
431    /* ACPI_BITREG_BUS_MASTER_RLD       */   {ACPI_REGISTER_PM1_CONTROL,  ACPI_BITPOSITION_BUS_MASTER_RLD,        ACPI_BITMASK_BUS_MASTER_RLD},
432    /* ACPI_BITREG_GLOBAL_LOCK_RELEASE  */   {ACPI_REGISTER_PM1_CONTROL,  ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE,   ACPI_BITMASK_GLOBAL_LOCK_RELEASE},
433    /* ACPI_BITREG_SLEEP_TYPE_A         */   {ACPI_REGISTER_PM1_CONTROL,  ACPI_BITPOSITION_SLEEP_TYPE_X,          ACPI_BITMASK_SLEEP_TYPE_X},
434    /* ACPI_BITREG_SLEEP_TYPE_B         */   {ACPI_REGISTER_PM1_CONTROL,  ACPI_BITPOSITION_SLEEP_TYPE_X,          ACPI_BITMASK_SLEEP_TYPE_X},
435    /* ACPI_BITREG_SLEEP_ENABLE         */   {ACPI_REGISTER_PM1_CONTROL,  ACPI_BITPOSITION_SLEEP_ENABLE,          ACPI_BITMASK_SLEEP_ENABLE},
436
437    /* ACPI_BITREG_ARB_DIS              */   {ACPI_REGISTER_PM2_CONTROL,  ACPI_BITPOSITION_ARB_DISABLE,           ACPI_BITMASK_ARB_DISABLE}
438};
439
440
441ACPI_FIXED_EVENT_INFO       AcpiGbl_FixedEventInfo[ACPI_NUM_FIXED_EVENTS] =
442{
443    /* ACPI_EVENT_PMTIMER       */  {ACPI_BITREG_TIMER_STATUS,          ACPI_BITREG_TIMER_ENABLE,        ACPI_BITMASK_TIMER_STATUS,          ACPI_BITMASK_TIMER_ENABLE},
444    /* ACPI_EVENT_GLOBAL        */  {ACPI_BITREG_GLOBAL_LOCK_STATUS,    ACPI_BITREG_GLOBAL_LOCK_ENABLE,  ACPI_BITMASK_GLOBAL_LOCK_STATUS,    ACPI_BITMASK_GLOBAL_LOCK_ENABLE},
445    /* ACPI_EVENT_POWER_BUTTON  */  {ACPI_BITREG_POWER_BUTTON_STATUS,   ACPI_BITREG_POWER_BUTTON_ENABLE, ACPI_BITMASK_POWER_BUTTON_STATUS,   ACPI_BITMASK_POWER_BUTTON_ENABLE},
446    /* ACPI_EVENT_SLEEP_BUTTON  */  {ACPI_BITREG_SLEEP_BUTTON_STATUS,   ACPI_BITREG_SLEEP_BUTTON_ENABLE, ACPI_BITMASK_SLEEP_BUTTON_STATUS,   ACPI_BITMASK_SLEEP_BUTTON_ENABLE},
447    /* ACPI_EVENT_RTC           */  {ACPI_BITREG_RT_CLOCK_STATUS,       ACPI_BITREG_RT_CLOCK_ENABLE,     0,                                  0},
448};
449
450/*****************************************************************************
451 *
452 * FUNCTION:    AcpiUtGetRegionName
453 *
454 * PARAMETERS:  None.
455 *
456 * RETURN:      Status
457 *
458 * DESCRIPTION: Translate a Space ID into a name string (Debug only)
459 *
460 ****************************************************************************/
461
462/* Region type decoding */
463
464const NATIVE_CHAR *AcpiGbl_RegionTypes[ACPI_NUM_PREDEFINED_REGIONS] =
465{
466    "SystemMemory",
467    "SystemIO",
468    "PCI_Config",
469    "EmbeddedControl",
470    "SMBus",
471    "CMOS",
472    "PCIBARTarget",
473    "DataTable",
474};
475
476
477NATIVE_CHAR *
478AcpiUtGetRegionName (
479    UINT8                   SpaceId)
480{
481
482    if (SpaceId >= ACPI_USER_REGION_BEGIN)
483    {
484        return ("UserDefinedRegion");
485    }
486
487    else if (SpaceId >= ACPI_NUM_PREDEFINED_REGIONS)
488    {
489        return ("InvalidSpaceID");
490    }
491
492    return ((NATIVE_CHAR *) AcpiGbl_RegionTypes[SpaceId]);
493}
494
495
496/*****************************************************************************
497 *
498 * FUNCTION:    AcpiUtGetEventName
499 *
500 * PARAMETERS:  None.
501 *
502 * RETURN:      Status
503 *
504 * DESCRIPTION: Translate a Event ID into a name string (Debug only)
505 *
506 ****************************************************************************/
507
508/* Event type decoding */
509
510static const NATIVE_CHAR *AcpiGbl_EventTypes[ACPI_NUM_FIXED_EVENTS] =
511{
512    "PM_Timer",
513    "GlobalLock",
514    "PowerButton",
515    "SleepButton",
516    "RealTimeClock",
517};
518
519
520NATIVE_CHAR *
521AcpiUtGetEventName (
522    UINT32                  EventId)
523{
524
525    if (EventId > ACPI_EVENT_MAX)
526    {
527        return ("InvalidEventID");
528    }
529
530    return ((NATIVE_CHAR *) AcpiGbl_EventTypes[EventId]);
531}
532
533
534/*****************************************************************************
535 *
536 * FUNCTION:    AcpiUtGetTypeName
537 *
538 * PARAMETERS:  None.
539 *
540 * RETURN:      Status
541 *
542 * DESCRIPTION: Translate a Type ID into a name string (Debug only)
543 *
544 ****************************************************************************/
545
546/*
547 * Elements of AcpiGbl_NsTypeNames below must match
548 * one-to-one with values of ACPI_OBJECT_TYPE
549 *
550 * The type ACPI_TYPE_ANY (Untyped) is used as a "don't care" when searching; when
551 * stored in a table it really means that we have thus far seen no evidence to
552 * indicatewhat type is actually going to be stored for this entry.
553 */
554
555static const NATIVE_CHAR    AcpiGbl_BadType[] = "UNDEFINED";
556#define TYPE_NAME_LENGTH    12                           /* Maximum length of each string */
557
558static const NATIVE_CHAR    *AcpiGbl_NsTypeNames[] =    /* printable names of ACPI types */
559{
560    /* 00 */ "Untyped",
561    /* 01 */ "Integer",
562    /* 02 */ "String",
563    /* 03 */ "Buffer",
564    /* 04 */ "Package",
565    /* 05 */ "FieldUnit",
566    /* 06 */ "Device",
567    /* 07 */ "Event",
568    /* 08 */ "Method",
569    /* 09 */ "Mutex",
570    /* 10 */ "Region",
571    /* 11 */ "Power",
572    /* 12 */ "Processor",
573    /* 13 */ "Thermal",
574    /* 14 */ "BufferField",
575    /* 15 */ "DdbHandle",
576    /* 16 */ "DebugObject",
577    /* 17 */ "RegionField",
578    /* 18 */ "BankField",
579    /* 19 */ "IndexField",
580    /* 20 */ "Reference",
581    /* 21 */ "Alias",
582    /* 22 */ "Notify",
583    /* 23 */ "AddrHandler",
584    /* 24 */ "ResourceDesc",
585    /* 25 */ "ResourceFld",
586    /* 26 */ "RegionFldDfn",
587    /* 27 */ "BankFldDfn",
588    /* 28 */ "IndexFldDfn",
589    /* 29 */ "If",
590    /* 30 */ "Else",
591    /* 31 */ "While",
592    /* 32 */ "Scope",
593    /* 33 */ "DefAny",
594    /* 34 */ "Extra",
595    /* 35 */ "Data",
596    /* 36 */ "Invalid"
597};
598
599
600NATIVE_CHAR *
601AcpiUtGetTypeName (
602    ACPI_OBJECT_TYPE        Type)
603{
604
605    if (Type > INTERNAL_TYPE_INVALID)
606    {
607        return ((NATIVE_CHAR *) AcpiGbl_BadType);
608    }
609
610    return ((NATIVE_CHAR *) AcpiGbl_NsTypeNames[Type]);
611}
612
613
614NATIVE_CHAR *
615AcpiUtGetObjectTypeName (
616    ACPI_OPERAND_OBJECT     *ObjDesc)
617{
618
619    if (!ObjDesc)
620    {
621        return ("[NULL Object Descriptor]");
622    }
623
624    return (AcpiUtGetTypeName (ACPI_GET_OBJECT_TYPE (ObjDesc)));
625}
626
627
628#if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
629
630/*
631 * Strings and procedures used for debug only
632 *
633 */
634
635
636/*****************************************************************************
637 *
638 * FUNCTION:    AcpiUtGetMutexName
639 *
640 * PARAMETERS:  None.
641 *
642 * RETURN:      Status
643 *
644 * DESCRIPTION: Translate a mutex ID into a name string (Debug only)
645 *
646 ****************************************************************************/
647
648NATIVE_CHAR *
649AcpiUtGetMutexName (
650    UINT32                  MutexId)
651{
652
653    if (MutexId > MAX_MTX)
654    {
655        return ("Invalid Mutex ID");
656    }
657
658    return (AcpiGbl_MutexNames[MutexId]);
659}
660
661
662#endif
663
664
665/*****************************************************************************
666 *
667 * FUNCTION:    AcpiUtValidObjectType
668 *
669 * PARAMETERS:  None.
670 *
671 * RETURN:      TRUE if valid object type
672 *
673 * DESCRIPTION: Validate an object type
674 *
675 ****************************************************************************/
676
677BOOLEAN
678AcpiUtValidObjectType (
679    ACPI_OBJECT_TYPE        Type)
680{
681
682    if (Type > ACPI_TYPE_MAX)
683    {
684        if ((Type < INTERNAL_TYPE_BEGIN) ||
685            (Type > INTERNAL_TYPE_MAX))
686        {
687            return (FALSE);
688        }
689    }
690
691    return (TRUE);
692}
693
694
695/****************************************************************************
696 *
697 * FUNCTION:    AcpiUtAllocateOwnerId
698 *
699 * PARAMETERS:  IdType          - Type of ID (method or table)
700 *
701 * DESCRIPTION: Allocate a table or method owner id
702 *
703 ***************************************************************************/
704
705ACPI_OWNER_ID
706AcpiUtAllocateOwnerId (
707    UINT32                  IdType)
708{
709    ACPI_OWNER_ID           OwnerId = 0xFFFF;
710
711
712    ACPI_FUNCTION_TRACE ("UtAllocateOwnerId");
713
714
715    if (ACPI_FAILURE (AcpiUtAcquireMutex (ACPI_MTX_CACHES)))
716    {
717        return (0);
718    }
719
720    switch (IdType)
721    {
722    case ACPI_OWNER_TYPE_TABLE:
723
724        OwnerId = AcpiGbl_NextTableOwnerId;
725        AcpiGbl_NextTableOwnerId++;
726
727        if (AcpiGbl_NextTableOwnerId == ACPI_FIRST_METHOD_ID)
728        {
729            AcpiGbl_NextTableOwnerId = ACPI_FIRST_TABLE_ID;
730        }
731        break;
732
733
734    case ACPI_OWNER_TYPE_METHOD:
735
736        OwnerId = AcpiGbl_NextMethodOwnerId;
737        AcpiGbl_NextMethodOwnerId++;
738
739        if (AcpiGbl_NextMethodOwnerId == ACPI_FIRST_TABLE_ID)
740        {
741            AcpiGbl_NextMethodOwnerId = ACPI_FIRST_METHOD_ID;
742        }
743        break;
744
745    default:
746        break;
747    }
748
749    (void) AcpiUtReleaseMutex (ACPI_MTX_CACHES);
750    return_VALUE (OwnerId);
751}
752
753
754/****************************************************************************
755 *
756 * FUNCTION:    AcpiUtInitGlobals
757 *
758 * PARAMETERS:  none
759 *
760 * DESCRIPTION: Init library globals.  All globals that require specific
761 *              initialization should be initialized here!
762 *
763 ***************************************************************************/
764
765void
766AcpiUtInitGlobals (
767    void)
768{
769    UINT32                  i;
770
771
772    ACPI_FUNCTION_TRACE ("UtInitGlobals");
773
774    /* Memory allocation and cache lists */
775
776    ACPI_MEMSET (AcpiGbl_MemoryLists, 0, sizeof (ACPI_MEMORY_LIST) * ACPI_NUM_MEM_LISTS);
777
778    AcpiGbl_MemoryLists[ACPI_MEM_LIST_STATE].LinkOffset         = (UINT16) ACPI_PTR_DIFF (&(((ACPI_GENERIC_STATE *) NULL)->Common.Next), NULL);
779    AcpiGbl_MemoryLists[ACPI_MEM_LIST_PSNODE].LinkOffset        = (UINT16) ACPI_PTR_DIFF (&(((ACPI_PARSE_OBJECT *) NULL)->Common.Next), NULL);
780    AcpiGbl_MemoryLists[ACPI_MEM_LIST_PSNODE_EXT].LinkOffset    = (UINT16) ACPI_PTR_DIFF (&(((ACPI_PARSE_OBJECT *) NULL)->Common.Next), NULL);
781    AcpiGbl_MemoryLists[ACPI_MEM_LIST_OPERAND].LinkOffset       = (UINT16) ACPI_PTR_DIFF (&(((ACPI_OPERAND_OBJECT *) NULL)->Cache.Next), NULL);
782    AcpiGbl_MemoryLists[ACPI_MEM_LIST_WALK].LinkOffset          = (UINT16) ACPI_PTR_DIFF (&(((ACPI_WALK_STATE *) NULL)->Next), NULL);
783
784    AcpiGbl_MemoryLists[ACPI_MEM_LIST_NSNODE].ObjectSize        = sizeof (ACPI_NAMESPACE_NODE);
785    AcpiGbl_MemoryLists[ACPI_MEM_LIST_STATE].ObjectSize         = sizeof (ACPI_GENERIC_STATE);
786    AcpiGbl_MemoryLists[ACPI_MEM_LIST_PSNODE].ObjectSize        = sizeof (ACPI_PARSE_OBJ_COMMON);
787    AcpiGbl_MemoryLists[ACPI_MEM_LIST_PSNODE_EXT].ObjectSize    = sizeof (ACPI_PARSE_OBJ_NAMED);
788    AcpiGbl_MemoryLists[ACPI_MEM_LIST_OPERAND].ObjectSize       = sizeof (ACPI_OPERAND_OBJECT);
789    AcpiGbl_MemoryLists[ACPI_MEM_LIST_WALK].ObjectSize          = sizeof (ACPI_WALK_STATE);
790
791    AcpiGbl_MemoryLists[ACPI_MEM_LIST_STATE].MaxCacheDepth      = MAX_STATE_CACHE_DEPTH;
792    AcpiGbl_MemoryLists[ACPI_MEM_LIST_PSNODE].MaxCacheDepth     = MAX_PARSE_CACHE_DEPTH;
793    AcpiGbl_MemoryLists[ACPI_MEM_LIST_PSNODE_EXT].MaxCacheDepth = MAX_EXTPARSE_CACHE_DEPTH;
794    AcpiGbl_MemoryLists[ACPI_MEM_LIST_OPERAND].MaxCacheDepth    = MAX_OBJECT_CACHE_DEPTH;
795    AcpiGbl_MemoryLists[ACPI_MEM_LIST_WALK].MaxCacheDepth       = MAX_WALK_CACHE_DEPTH;
796
797    ACPI_MEM_TRACKING (AcpiGbl_MemoryLists[ACPI_MEM_LIST_GLOBAL].ListName       = "Global Memory Allocation");
798    ACPI_MEM_TRACKING (AcpiGbl_MemoryLists[ACPI_MEM_LIST_NSNODE].ListName       = "Namespace Nodes");
799    ACPI_MEM_TRACKING (AcpiGbl_MemoryLists[ACPI_MEM_LIST_STATE].ListName        = "State Object Cache");
800    ACPI_MEM_TRACKING (AcpiGbl_MemoryLists[ACPI_MEM_LIST_PSNODE].ListName       = "Parse Node Cache");
801    ACPI_MEM_TRACKING (AcpiGbl_MemoryLists[ACPI_MEM_LIST_PSNODE_EXT].ListName   = "Extended Parse Node Cache");
802    ACPI_MEM_TRACKING (AcpiGbl_MemoryLists[ACPI_MEM_LIST_OPERAND].ListName      = "Operand Object Cache");
803    ACPI_MEM_TRACKING (AcpiGbl_MemoryLists[ACPI_MEM_LIST_WALK].ListName         = "Tree Walk Node Cache");
804
805    /* ACPI table structure */
806
807    for (i = 0; i < NUM_ACPI_TABLES; i++)
808    {
809        AcpiGbl_AcpiTables[i].Prev          = &AcpiGbl_AcpiTables[i];
810        AcpiGbl_AcpiTables[i].Next          = &AcpiGbl_AcpiTables[i];
811        AcpiGbl_AcpiTables[i].Pointer       = NULL;
812        AcpiGbl_AcpiTables[i].Length        = 0;
813        AcpiGbl_AcpiTables[i].Allocation    = ACPI_MEM_NOT_ALLOCATED;
814        AcpiGbl_AcpiTables[i].Count         = 0;
815    }
816
817    /* Mutex locked flags */
818
819    for (i = 0; i < NUM_MTX; i++)
820    {
821        AcpiGbl_AcpiMutexInfo[i].Mutex      = NULL;
822        AcpiGbl_AcpiMutexInfo[i].OwnerId    = ACPI_MUTEX_NOT_ACQUIRED;
823        AcpiGbl_AcpiMutexInfo[i].UseCount   = 0;
824    }
825
826    /* Global notify handlers */
827
828    AcpiGbl_SysNotify.Handler           = NULL;
829    AcpiGbl_DrvNotify.Handler           = NULL;
830    AcpiGbl_InitHandler                 = NULL;
831
832    /* Global "typed" ACPI table pointers */
833
834    AcpiGbl_RSDP                        = NULL;
835    AcpiGbl_XSDT                        = NULL;
836    AcpiGbl_FACS                        = NULL;
837    AcpiGbl_FADT                        = NULL;
838    AcpiGbl_DSDT                        = NULL;
839
840    /* Global Lock support */
841
842    AcpiGbl_GlobalLockAcquired          = FALSE;
843    AcpiGbl_GlobalLockThreadCount       = 0;
844    AcpiGbl_GlobalLockHandle            = 0;
845
846    /* Miscellaneous variables */
847
848    AcpiGbl_TableFlags                  = ACPI_PHYSICAL_POINTER;
849    AcpiGbl_RsdpOriginalLocation        = 0;
850    AcpiGbl_CmSingleStep                = FALSE;
851    AcpiGbl_DbTerminateThreads          = FALSE;
852    AcpiGbl_Shutdown                    = FALSE;
853    AcpiGbl_NsLookupCount               = 0;
854    AcpiGbl_PsFindCount                 = 0;
855    AcpiGbl_AcpiHardwarePresent         = TRUE;
856    AcpiGbl_NextTableOwnerId            = ACPI_FIRST_TABLE_ID;
857    AcpiGbl_NextMethodOwnerId           = ACPI_FIRST_METHOD_ID;
858    AcpiGbl_DebuggerConfiguration       = DEBUGGER_THREADING;
859    AcpiGbl_DbOutputFlags               = ACPI_DB_CONSOLE_OUTPUT;
860
861    /* Hardware oriented */
862
863    AcpiGbl_GpeRegisterInfo             = NULL;
864    AcpiGbl_GpeNumberInfo               = NULL;
865
866    /* Namespace */
867
868    AcpiGbl_RootNode                    = NULL;
869
870    AcpiGbl_RootNodeStruct.Name.Integer = ACPI_ROOT_NAME;
871    AcpiGbl_RootNodeStruct.Descriptor   = ACPI_DESC_TYPE_NAMED;
872    AcpiGbl_RootNodeStruct.Type         = ACPI_TYPE_ANY;
873    AcpiGbl_RootNodeStruct.Child        = NULL;
874    AcpiGbl_RootNodeStruct.Peer         = NULL;
875    AcpiGbl_RootNodeStruct.Object       = NULL;
876    AcpiGbl_RootNodeStruct.Flags        = ANOBJ_END_OF_PEER_LIST;
877
878
879#ifdef ACPI_DEBUG_OUTPUT
880    AcpiGbl_LowestStackPointer          = ACPI_SIZE_MAX;
881#endif
882
883    return_VOID;
884}
885
886
887