utglobal.c revision 123315
1/******************************************************************************
2 *
3 * Module Name: utglobal - Global variables for the ACPI subsystem
4 *              $Revision: 191 $
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999 - 2003, 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
123#define _COMPONENT          ACPI_UTILITIES
124        ACPI_MODULE_NAME    ("utglobal")
125
126
127/******************************************************************************
128 *
129 * FUNCTION:    AcpiFormatException
130 *
131 * PARAMETERS:  Status       - The ACPI_STATUS code to be formatted
132 *
133 * RETURN:      A string containing the exception  text
134 *
135 * DESCRIPTION: This function translates an ACPI exception into an ASCII string.
136 *
137 ******************************************************************************/
138
139const char *
140AcpiFormatException (
141    ACPI_STATUS             Status)
142{
143    const char              *Exception = "UNKNOWN_STATUS_CODE";
144    ACPI_STATUS             SubStatus;
145
146
147    ACPI_FUNCTION_NAME ("FormatException");
148
149
150    SubStatus = (Status & ~AE_CODE_MASK);
151
152    switch (Status & AE_CODE_MASK)
153    {
154    case AE_CODE_ENVIRONMENTAL:
155
156        if (SubStatus <= AE_CODE_ENV_MAX)
157        {
158            Exception = AcpiGbl_ExceptionNames_Env [SubStatus];
159            break;
160        }
161        goto Unknown;
162
163    case AE_CODE_PROGRAMMER:
164
165        if (SubStatus <= AE_CODE_PGM_MAX)
166        {
167            Exception = AcpiGbl_ExceptionNames_Pgm [SubStatus -1];
168            break;
169        }
170        goto Unknown;
171
172    case AE_CODE_ACPI_TABLES:
173
174        if (SubStatus <= AE_CODE_TBL_MAX)
175        {
176            Exception = AcpiGbl_ExceptionNames_Tbl [SubStatus -1];
177            break;
178        }
179        goto Unknown;
180
181    case AE_CODE_AML:
182
183        if (SubStatus <= AE_CODE_AML_MAX)
184        {
185            Exception = AcpiGbl_ExceptionNames_Aml [SubStatus -1];
186            break;
187        }
188        goto Unknown;
189
190    case AE_CODE_CONTROL:
191
192        if (SubStatus <= AE_CODE_CTRL_MAX)
193        {
194            Exception = AcpiGbl_ExceptionNames_Ctrl [SubStatus -1];
195            break;
196        }
197        goto Unknown;
198
199    default:
200        goto Unknown;
201    }
202
203
204    return ((const char *) Exception);
205
206Unknown:
207
208    ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Unknown exception code: 0x%8.8X\n", Status));
209    return ((const char *) Exception);
210}
211
212
213/******************************************************************************
214 *
215 * Static global variable initialization.
216 *
217 ******************************************************************************/
218
219/*
220 * We want the debug switches statically initialized so they
221 * are already set when the debugger is entered.
222 */
223
224/* Debug switch - level and trace mask */
225
226#ifdef ACPI_DEBUG_OUTPUT
227UINT32                      AcpiDbgLevel = ACPI_DEBUG_DEFAULT;
228#else
229UINT32                      AcpiDbgLevel = ACPI_NORMAL_DEFAULT;
230#endif
231
232/* Debug switch - layer (component) mask */
233
234UINT32                      AcpiDbgLayer = ACPI_COMPONENT_DEFAULT;
235UINT32                      AcpiGbl_NestingLevel = 0;
236
237
238/* Debugger globals */
239
240BOOLEAN                     AcpiGbl_DbTerminateThreads = FALSE;
241BOOLEAN                     AcpiGbl_AbortMethod = 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 char                  *AcpiGbl_DbSleepStates[ACPI_S_STATE_COUNT] = {
255                                "\\_S0_",
256                                "\\_S1_",
257                                "\\_S2_",
258                                "\\_S3_",
259                                "\\_S4_",
260                                "\\_S5_"};
261
262
263/******************************************************************************
264 *
265 * Namespace globals
266 *
267 ******************************************************************************/
268
269
270/*
271 * Predefined ACPI Names (Built-in to the Interpreter)
272 *
273 * Initial values are currently supported only for types String and Number.
274 * Both are specified as strings in this table.
275 *
276 * NOTES:
277 * 1) _SB_ is defined to be a device to allow _SB_/_INI to be run
278 *    during the initialization sequence.
279 */
280
281const ACPI_PREDEFINED_NAMES     AcpiGbl_PreDefinedNames[] =
282{
283    {"_GPE",    ACPI_TYPE_LOCAL_SCOPE,      NULL},
284    {"_PR_",    ACPI_TYPE_LOCAL_SCOPE,      NULL},
285    {"_SB_",    ACPI_TYPE_DEVICE,           NULL},
286    {"_SI_",    ACPI_TYPE_LOCAL_SCOPE,      NULL},
287    {"_TZ_",    ACPI_TYPE_LOCAL_SCOPE,      NULL},
288    {"_REV",    ACPI_TYPE_INTEGER,          "2"},
289    {"_OS_",    ACPI_TYPE_STRING,           ACPI_OS_NAME},
290    {"_GL_",    ACPI_TYPE_MUTEX,            "0"},
291
292#if defined (ACPI_NO_METHOD_EXECUTION) || defined (ACPI_CONSTANT_EVAL_ONLY)
293    {"_OSI",    ACPI_TYPE_METHOD,           "1"},
294#endif
295    {NULL,      ACPI_TYPE_ANY,              NULL}              /* Table terminator */
296};
297
298
299/*
300 * Properties of the ACPI Object Types, both internal and external.
301 * The table is indexed by values of ACPI_OBJECT_TYPE
302 */
303
304const UINT8                     AcpiGbl_NsProperties[] =
305{
306    ACPI_NS_NORMAL,                     /* 00 Any              */
307    ACPI_NS_NORMAL,                     /* 01 Number           */
308    ACPI_NS_NORMAL,                     /* 02 String           */
309    ACPI_NS_NORMAL,                     /* 03 Buffer           */
310    ACPI_NS_NORMAL,                     /* 04 Package          */
311    ACPI_NS_NORMAL,                     /* 05 FieldUnit        */
312    ACPI_NS_NEWSCOPE,                   /* 06 Device           */
313    ACPI_NS_NORMAL,                     /* 07 Event            */
314    ACPI_NS_NEWSCOPE,                   /* 08 Method           */
315    ACPI_NS_NORMAL,                     /* 09 Mutex            */
316    ACPI_NS_NORMAL,                     /* 10 Region           */
317    ACPI_NS_NEWSCOPE,                   /* 11 Power            */
318    ACPI_NS_NEWSCOPE,                   /* 12 Processor        */
319    ACPI_NS_NEWSCOPE,                   /* 13 Thermal          */
320    ACPI_NS_NORMAL,                     /* 14 BufferField      */
321    ACPI_NS_NORMAL,                     /* 15 DdbHandle        */
322    ACPI_NS_NORMAL,                     /* 16 Debug Object     */
323    ACPI_NS_NORMAL,                     /* 17 DefField         */
324    ACPI_NS_NORMAL,                     /* 18 BankField        */
325    ACPI_NS_NORMAL,                     /* 19 IndexField       */
326    ACPI_NS_NORMAL,                     /* 20 Reference        */
327    ACPI_NS_NORMAL,                     /* 21 Alias            */
328    ACPI_NS_NORMAL,                     /* 22 Notify           */
329    ACPI_NS_NORMAL,                     /* 23 Address Handler  */
330    ACPI_NS_NEWSCOPE | ACPI_NS_LOCAL,   /* 24 Resource Desc    */
331    ACPI_NS_NEWSCOPE | ACPI_NS_LOCAL,   /* 25 Resource Field   */
332    ACPI_NS_NEWSCOPE,                   /* 26 Scope            */
333    ACPI_NS_NORMAL,                     /* 27 Extra            */
334    ACPI_NS_NORMAL,                     /* 28 Data             */
335    ACPI_NS_NORMAL                      /* 29 Invalid          */
336};
337
338
339/* Hex to ASCII conversion table */
340
341static const char           AcpiGbl_HexToAscii[] =
342                                {'0','1','2','3','4','5','6','7',
343                                 '8','9','A','B','C','D','E','F'};
344
345/*****************************************************************************
346 *
347 * FUNCTION:    AcpiUtHexToAsciiChar
348 *
349 * PARAMETERS:  Integer             - Contains the hex digit
350 *              Position            - bit position of the digit within the
351 *                                    integer
352 *
353 * RETURN:      Ascii character
354 *
355 * DESCRIPTION: Convert a hex digit to an ascii character
356 *
357 ****************************************************************************/
358
359char
360AcpiUtHexToAsciiChar (
361    ACPI_INTEGER            Integer,
362    UINT32                  Position)
363{
364
365    return (AcpiGbl_HexToAscii[(Integer >> Position) & 0xF]);
366}
367
368
369/******************************************************************************
370 *
371 * Table name globals
372 *
373 * NOTE: This table includes ONLY the ACPI tables that the subsystem consumes.
374 * it is NOT an exhaustive list of all possible ACPI tables.  All ACPI tables
375 * that are not used by the subsystem are simply ignored.
376 *
377 * Do NOT add any table to this list that is not consumed directly by this
378 * subsystem.
379 *
380 ******************************************************************************/
381
382
383ACPI_TABLE_LIST             AcpiGbl_TableLists[NUM_ACPI_TABLE_TYPES];
384
385
386ACPI_TABLE_SUPPORT          AcpiGbl_TableData[NUM_ACPI_TABLE_TYPES] =
387{
388    /***********    Name,   Signature, Global typed pointer     Signature size,      Type                  How many allowed?,    Contains valid AML? */
389
390    /* RSDP 0 */ {RSDP_NAME, RSDP_SIG, NULL,                    sizeof (RSDP_SIG)-1, ACPI_TABLE_ROOT     | ACPI_TABLE_SINGLE},
391    /* DSDT 1 */ {DSDT_SIG,  DSDT_SIG, (void *) &AcpiGbl_DSDT,  sizeof (DSDT_SIG)-1, ACPI_TABLE_SECONDARY| ACPI_TABLE_SINGLE   | ACPI_TABLE_EXECUTABLE},
392    /* FADT 2 */ {FADT_SIG,  FADT_SIG, (void *) &AcpiGbl_FADT,  sizeof (FADT_SIG)-1, ACPI_TABLE_PRIMARY  | ACPI_TABLE_SINGLE},
393    /* FACS 3 */ {FACS_SIG,  FACS_SIG, (void *) &AcpiGbl_FACS,  sizeof (FACS_SIG)-1, ACPI_TABLE_SECONDARY| ACPI_TABLE_SINGLE},
394    /* PSDT 4 */ {PSDT_SIG,  PSDT_SIG, NULL,                    sizeof (PSDT_SIG)-1, ACPI_TABLE_PRIMARY  | ACPI_TABLE_MULTIPLE | ACPI_TABLE_EXECUTABLE},
395    /* SSDT 5 */ {SSDT_SIG,  SSDT_SIG, NULL,                    sizeof (SSDT_SIG)-1, ACPI_TABLE_PRIMARY  | ACPI_TABLE_MULTIPLE | ACPI_TABLE_EXECUTABLE},
396    /* XSDT 6 */ {XSDT_SIG,  XSDT_SIG, NULL,                    sizeof (RSDT_SIG)-1, ACPI_TABLE_ROOT     | ACPI_TABLE_SINGLE},
397};
398
399
400/******************************************************************************
401 *
402 * Event and Hardware globals
403 *
404 ******************************************************************************/
405
406ACPI_BIT_REGISTER_INFO      AcpiGbl_BitRegisterInfo[ACPI_NUM_BITREG] =
407{
408    /* Name                                     Parent Register             Register Bit Position                   Register Bit Mask       */
409
410    /* ACPI_BITREG_TIMER_STATUS         */   {ACPI_REGISTER_PM1_STATUS,   ACPI_BITPOSITION_TIMER_STATUS,          ACPI_BITMASK_TIMER_STATUS},
411    /* ACPI_BITREG_BUS_MASTER_STATUS    */   {ACPI_REGISTER_PM1_STATUS,   ACPI_BITPOSITION_BUS_MASTER_STATUS,     ACPI_BITMASK_BUS_MASTER_STATUS},
412    /* ACPI_BITREG_GLOBAL_LOCK_STATUS   */   {ACPI_REGISTER_PM1_STATUS,   ACPI_BITPOSITION_GLOBAL_LOCK_STATUS,    ACPI_BITMASK_GLOBAL_LOCK_STATUS},
413    /* ACPI_BITREG_POWER_BUTTON_STATUS  */   {ACPI_REGISTER_PM1_STATUS,   ACPI_BITPOSITION_POWER_BUTTON_STATUS,   ACPI_BITMASK_POWER_BUTTON_STATUS},
414    /* ACPI_BITREG_SLEEP_BUTTON_STATUS  */   {ACPI_REGISTER_PM1_STATUS,   ACPI_BITPOSITION_SLEEP_BUTTON_STATUS,   ACPI_BITMASK_SLEEP_BUTTON_STATUS},
415    /* ACPI_BITREG_RT_CLOCK_STATUS      */   {ACPI_REGISTER_PM1_STATUS,   ACPI_BITPOSITION_RT_CLOCK_STATUS,       ACPI_BITMASK_RT_CLOCK_STATUS},
416    /* ACPI_BITREG_WAKE_STATUS          */   {ACPI_REGISTER_PM1_STATUS,   ACPI_BITPOSITION_WAKE_STATUS,           ACPI_BITMASK_WAKE_STATUS},
417
418    /* ACPI_BITREG_TIMER_ENABLE         */   {ACPI_REGISTER_PM1_ENABLE,   ACPI_BITPOSITION_TIMER_ENABLE,          ACPI_BITMASK_TIMER_ENABLE},
419    /* ACPI_BITREG_GLOBAL_LOCK_ENABLE   */   {ACPI_REGISTER_PM1_ENABLE,   ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE,    ACPI_BITMASK_GLOBAL_LOCK_ENABLE},
420    /* ACPI_BITREG_POWER_BUTTON_ENABLE  */   {ACPI_REGISTER_PM1_ENABLE,   ACPI_BITPOSITION_POWER_BUTTON_ENABLE,   ACPI_BITMASK_POWER_BUTTON_ENABLE},
421    /* ACPI_BITREG_SLEEP_BUTTON_ENABLE  */   {ACPI_REGISTER_PM1_ENABLE,   ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE,   ACPI_BITMASK_SLEEP_BUTTON_ENABLE},
422    /* ACPI_BITREG_RT_CLOCK_ENABLE      */   {ACPI_REGISTER_PM1_ENABLE,   ACPI_BITPOSITION_RT_CLOCK_ENABLE,       ACPI_BITMASK_RT_CLOCK_ENABLE},
423    /* ACPI_BITREG_WAKE_ENABLE          */   {ACPI_REGISTER_PM1_ENABLE,   0,                                      0},
424
425    /* ACPI_BITREG_SCI_ENABLE           */   {ACPI_REGISTER_PM1_CONTROL,  ACPI_BITPOSITION_SCI_ENABLE,            ACPI_BITMASK_SCI_ENABLE},
426    /* ACPI_BITREG_BUS_MASTER_RLD       */   {ACPI_REGISTER_PM1_CONTROL,  ACPI_BITPOSITION_BUS_MASTER_RLD,        ACPI_BITMASK_BUS_MASTER_RLD},
427    /* ACPI_BITREG_GLOBAL_LOCK_RELEASE  */   {ACPI_REGISTER_PM1_CONTROL,  ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE,   ACPI_BITMASK_GLOBAL_LOCK_RELEASE},
428    /* ACPI_BITREG_SLEEP_TYPE_A         */   {ACPI_REGISTER_PM1_CONTROL,  ACPI_BITPOSITION_SLEEP_TYPE_X,          ACPI_BITMASK_SLEEP_TYPE_X},
429    /* ACPI_BITREG_SLEEP_TYPE_B         */   {ACPI_REGISTER_PM1_CONTROL,  ACPI_BITPOSITION_SLEEP_TYPE_X,          ACPI_BITMASK_SLEEP_TYPE_X},
430    /* ACPI_BITREG_SLEEP_ENABLE         */   {ACPI_REGISTER_PM1_CONTROL,  ACPI_BITPOSITION_SLEEP_ENABLE,          ACPI_BITMASK_SLEEP_ENABLE},
431
432    /* ACPI_BITREG_ARB_DIS              */   {ACPI_REGISTER_PM2_CONTROL,  ACPI_BITPOSITION_ARB_DISABLE,           ACPI_BITMASK_ARB_DISABLE}
433};
434
435
436ACPI_FIXED_EVENT_INFO       AcpiGbl_FixedEventInfo[ACPI_NUM_FIXED_EVENTS] =
437{
438    /* ACPI_EVENT_PMTIMER       */  {ACPI_BITREG_TIMER_STATUS,          ACPI_BITREG_TIMER_ENABLE,        ACPI_BITMASK_TIMER_STATUS,          ACPI_BITMASK_TIMER_ENABLE},
439    /* ACPI_EVENT_GLOBAL        */  {ACPI_BITREG_GLOBAL_LOCK_STATUS,    ACPI_BITREG_GLOBAL_LOCK_ENABLE,  ACPI_BITMASK_GLOBAL_LOCK_STATUS,    ACPI_BITMASK_GLOBAL_LOCK_ENABLE},
440    /* ACPI_EVENT_POWER_BUTTON  */  {ACPI_BITREG_POWER_BUTTON_STATUS,   ACPI_BITREG_POWER_BUTTON_ENABLE, ACPI_BITMASK_POWER_BUTTON_STATUS,   ACPI_BITMASK_POWER_BUTTON_ENABLE},
441    /* ACPI_EVENT_SLEEP_BUTTON  */  {ACPI_BITREG_SLEEP_BUTTON_STATUS,   ACPI_BITREG_SLEEP_BUTTON_ENABLE, ACPI_BITMASK_SLEEP_BUTTON_STATUS,   ACPI_BITMASK_SLEEP_BUTTON_ENABLE},
442    /* ACPI_EVENT_RTC           */  {ACPI_BITREG_RT_CLOCK_STATUS,       ACPI_BITREG_RT_CLOCK_ENABLE,     ACPI_BITMASK_RT_CLOCK_STATUS,       ACPI_BITMASK_RT_CLOCK_ENABLE},
443};
444
445/*****************************************************************************
446 *
447 * FUNCTION:    AcpiUtGetRegionName
448 *
449 * PARAMETERS:  None.
450 *
451 * RETURN:      Status
452 *
453 * DESCRIPTION: Translate a Space ID into a name string (Debug only)
454 *
455 ****************************************************************************/
456
457/* Region type decoding */
458
459const char        *AcpiGbl_RegionTypes[ACPI_NUM_PREDEFINED_REGIONS] =
460{
461/*! [Begin] no source code translation (keep these ASL Keywords as-is) */
462    "SystemMemory",
463    "SystemIO",
464    "PCI_Config",
465    "EmbeddedControl",
466    "SMBus",
467    "CMOS",
468    "PCIBARTarget",
469    "DataTable"
470/*! [End] no source code translation !*/
471};
472
473
474char *
475AcpiUtGetRegionName (
476    UINT8                   SpaceId)
477{
478
479    if (SpaceId >= ACPI_USER_REGION_BEGIN)
480    {
481        return ("UserDefinedRegion");
482    }
483
484    else if (SpaceId >= ACPI_NUM_PREDEFINED_REGIONS)
485    {
486        return ("InvalidSpaceId");
487    }
488
489    return ((char *) AcpiGbl_RegionTypes[SpaceId]);
490}
491
492
493/*****************************************************************************
494 *
495 * FUNCTION:    AcpiUtGetEventName
496 *
497 * PARAMETERS:  None.
498 *
499 * RETURN:      Status
500 *
501 * DESCRIPTION: Translate a Event ID into a name string (Debug only)
502 *
503 ****************************************************************************/
504
505/* Event type decoding */
506
507static const char        *AcpiGbl_EventTypes[ACPI_NUM_FIXED_EVENTS] =
508{
509    "PM_Timer",
510    "GlobalLock",
511    "PowerButton",
512    "SleepButton",
513    "RealTimeClock",
514};
515
516
517char *
518AcpiUtGetEventName (
519    UINT32                  EventId)
520{
521
522    if (EventId > ACPI_EVENT_MAX)
523    {
524        return ("InvalidEventID");
525    }
526
527    return ((char *) AcpiGbl_EventTypes[EventId]);
528}
529
530
531/*****************************************************************************
532 *
533 * FUNCTION:    AcpiUtGetTypeName
534 *
535 * PARAMETERS:  None.
536 *
537 * RETURN:      Status
538 *
539 * DESCRIPTION: Translate a Type ID into a name string (Debug only)
540 *
541 ****************************************************************************/
542
543/*
544 * Elements of AcpiGbl_NsTypeNames below must match
545 * one-to-one with values of ACPI_OBJECT_TYPE
546 *
547 * The type ACPI_TYPE_ANY (Untyped) is used as a "don't care" when searching; when
548 * stored in a table it really means that we have thus far seen no evidence to
549 * indicatewhat type is actually going to be stored for this entry.
550 */
551
552static const char           AcpiGbl_BadType[] = "UNDEFINED";
553#define TYPE_NAME_LENGTH    12                           /* Maximum length of each string */
554
555static const char           *AcpiGbl_NsTypeNames[] =    /* printable names of ACPI types */
556{
557    /* 00 */ "Untyped",
558    /* 01 */ "Integer",
559    /* 02 */ "String",
560    /* 03 */ "Buffer",
561    /* 04 */ "Package",
562    /* 05 */ "FieldUnit",
563    /* 06 */ "Device",
564    /* 07 */ "Event",
565    /* 08 */ "Method",
566    /* 09 */ "Mutex",
567    /* 10 */ "Region",
568    /* 11 */ "Power",
569    /* 12 */ "Processor",
570    /* 13 */ "Thermal",
571    /* 14 */ "BufferField",
572    /* 15 */ "DdbHandle",
573    /* 16 */ "DebugObject",
574    /* 17 */ "RegionField",
575    /* 18 */ "BankField",
576    /* 19 */ "IndexField",
577    /* 20 */ "Reference",
578    /* 21 */ "Alias",
579    /* 22 */ "Notify",
580    /* 23 */ "AddrHandler",
581    /* 24 */ "ResourceDesc",
582    /* 25 */ "ResourceFld",
583    /* 26 */ "Scope",
584    /* 27 */ "Extra",
585    /* 28 */ "Data",
586    /* 39 */ "Invalid"
587};
588
589
590char *
591AcpiUtGetTypeName (
592    ACPI_OBJECT_TYPE        Type)
593{
594
595    if (Type > ACPI_TYPE_INVALID)
596    {
597        return ((char *) AcpiGbl_BadType);
598    }
599
600    return ((char *) AcpiGbl_NsTypeNames[Type]);
601}
602
603
604char *
605AcpiUtGetObjectTypeName (
606    ACPI_OPERAND_OBJECT     *ObjDesc)
607{
608
609    if (!ObjDesc)
610    {
611        return ("[NULL Object Descriptor]");
612    }
613
614    return (AcpiUtGetTypeName (ACPI_GET_OBJECT_TYPE (ObjDesc)));
615}
616
617
618/*****************************************************************************
619 *
620 * FUNCTION:    AcpiUtGetNodeName
621 *
622 * PARAMETERS:  Object               - A namespace node
623 *
624 * RETURN:      Pointer to a string
625 *
626 * DESCRIPTION: Validate the node and return the node's ACPI name.
627 *
628 ****************************************************************************/
629
630char *
631AcpiUtGetNodeName (
632    void                    *Object)
633{
634    ACPI_NAMESPACE_NODE     *Node;
635
636
637    if (!Object)
638    {
639        return ("NULL NODE");
640    }
641
642    Node = (ACPI_NAMESPACE_NODE *) Object;
643
644    if (Node->Descriptor != ACPI_DESC_TYPE_NAMED)
645    {
646        return ("****");
647    }
648
649    if (!AcpiUtValidAcpiName (* (UINT32 *) Node->Name.Ascii))
650    {
651        return ("----");
652    }
653
654    return (Node->Name.Ascii);
655}
656
657
658/*****************************************************************************
659 *
660 * FUNCTION:    AcpiUtGetDescriptorName
661 *
662 * PARAMETERS:  Object               - An ACPI object
663 *
664 * RETURN:      Pointer to a string
665 *
666 * DESCRIPTION: Validate object and return the descriptor type
667 *
668 ****************************************************************************/
669
670static const char           *AcpiGbl_DescTypeNames[] =    /* printable names of descriptor types */
671{
672    /* 00 */ "Invalid",
673    /* 01 */ "Cached",
674    /* 02 */ "State-Generic",
675    /* 03 */ "State-Update",
676    /* 04 */ "State-Package",
677    /* 05 */ "State-Control",
678    /* 06 */ "State-RootParseScope",
679    /* 07 */ "State-ParseScope",
680    /* 08 */ "State-WalkScope",
681    /* 09 */ "State-Result",
682    /* 10 */ "State-Notify",
683    /* 11 */ "State-Thread",
684    /* 12 */ "Walk",
685    /* 13 */ "Parser",
686    /* 14 */ "Operand",
687    /* 15 */ "Node"
688};
689
690
691char *
692AcpiUtGetDescriptorName (
693    void                    *Object)
694{
695
696    if (!Object)
697    {
698        return ("NULL OBJECT");
699    }
700
701    if (ACPI_GET_DESCRIPTOR_TYPE (Object) > ACPI_DESC_TYPE_MAX)
702    {
703        return ((char *) AcpiGbl_BadType);
704    }
705
706    return ((char *) AcpiGbl_DescTypeNames[ACPI_GET_DESCRIPTOR_TYPE (Object)]);
707
708}
709
710
711#if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
712/*
713 * Strings and procedures used for debug only
714 */
715
716/*****************************************************************************
717 *
718 * FUNCTION:    AcpiUtGetMutexName
719 *
720 * PARAMETERS:  None.
721 *
722 * RETURN:      Status
723 *
724 * DESCRIPTION: Translate a mutex ID into a name string (Debug only)
725 *
726 ****************************************************************************/
727
728char *
729AcpiUtGetMutexName (
730    UINT32                  MutexId)
731{
732
733    if (MutexId > MAX_MUTEX)
734    {
735        return ("Invalid Mutex ID");
736    }
737
738    return (AcpiGbl_MutexNames[MutexId]);
739}
740
741#endif
742
743
744/*****************************************************************************
745 *
746 * FUNCTION:    AcpiUtValidObjectType
747 *
748 * PARAMETERS:  Type            - Object type to be validated
749 *
750 * RETURN:      TRUE if valid object type
751 *
752 * DESCRIPTION: Validate an object type
753 *
754 ****************************************************************************/
755
756BOOLEAN
757AcpiUtValidObjectType (
758    ACPI_OBJECT_TYPE        Type)
759{
760
761    if (Type > ACPI_TYPE_LOCAL_MAX)
762    {
763        /* Note: Assumes all TYPEs are contiguous (external/local) */
764
765        return (FALSE);
766    }
767
768    return (TRUE);
769}
770
771
772/****************************************************************************
773 *
774 * FUNCTION:    AcpiUtAllocateOwnerId
775 *
776 * PARAMETERS:  IdType          - Type of ID (method or table)
777 *
778 * DESCRIPTION: Allocate a table or method owner id
779 *
780 ***************************************************************************/
781
782ACPI_OWNER_ID
783AcpiUtAllocateOwnerId (
784    UINT32                  IdType)
785{
786    ACPI_OWNER_ID           OwnerId = 0xFFFF;
787
788
789    ACPI_FUNCTION_TRACE ("UtAllocateOwnerId");
790
791
792    if (ACPI_FAILURE (AcpiUtAcquireMutex (ACPI_MTX_CACHES)))
793    {
794        return (0);
795    }
796
797    switch (IdType)
798    {
799    case ACPI_OWNER_TYPE_TABLE:
800
801        OwnerId = AcpiGbl_NextTableOwnerId;
802        AcpiGbl_NextTableOwnerId++;
803
804        /* Check for wraparound */
805
806        if (AcpiGbl_NextTableOwnerId == ACPI_FIRST_METHOD_ID)
807        {
808            AcpiGbl_NextTableOwnerId = ACPI_FIRST_TABLE_ID;
809            ACPI_REPORT_WARNING (("Table owner ID wraparound\n"));
810        }
811        break;
812
813
814    case ACPI_OWNER_TYPE_METHOD:
815
816        OwnerId = AcpiGbl_NextMethodOwnerId;
817        AcpiGbl_NextMethodOwnerId++;
818
819        if (AcpiGbl_NextMethodOwnerId == ACPI_FIRST_TABLE_ID)
820        {
821            /* Check for wraparound */
822
823            AcpiGbl_NextMethodOwnerId = ACPI_FIRST_METHOD_ID;
824        }
825        break;
826
827    default:
828        break;
829    }
830
831    (void) AcpiUtReleaseMutex (ACPI_MTX_CACHES);
832    return_VALUE (OwnerId);
833}
834
835
836/****************************************************************************
837 *
838 * FUNCTION:    AcpiUtInitGlobals
839 *
840 * PARAMETERS:  none
841 *
842 * DESCRIPTION: Init library globals.  All globals that require specific
843 *              initialization should be initialized here!
844 *
845 ***************************************************************************/
846
847void
848AcpiUtInitGlobals (
849    void)
850{
851    UINT32                  i;
852
853
854    ACPI_FUNCTION_TRACE ("UtInitGlobals");
855
856    /* Memory allocation and cache lists */
857
858    ACPI_MEMSET (AcpiGbl_MemoryLists, 0, sizeof (ACPI_MEMORY_LIST) * ACPI_NUM_MEM_LISTS);
859
860    AcpiGbl_MemoryLists[ACPI_MEM_LIST_STATE].LinkOffset         = (UINT16) ACPI_PTR_DIFF (&(((ACPI_GENERIC_STATE *) NULL)->Common.Next), NULL);
861    AcpiGbl_MemoryLists[ACPI_MEM_LIST_PSNODE].LinkOffset        = (UINT16) ACPI_PTR_DIFF (&(((ACPI_PARSE_OBJECT *) NULL)->Common.Next), NULL);
862    AcpiGbl_MemoryLists[ACPI_MEM_LIST_PSNODE_EXT].LinkOffset    = (UINT16) ACPI_PTR_DIFF (&(((ACPI_PARSE_OBJECT *) NULL)->Common.Next), NULL);
863    AcpiGbl_MemoryLists[ACPI_MEM_LIST_OPERAND].LinkOffset       = (UINT16) ACPI_PTR_DIFF (&(((ACPI_OPERAND_OBJECT *) NULL)->Cache.Next), NULL);
864    AcpiGbl_MemoryLists[ACPI_MEM_LIST_WALK].LinkOffset          = (UINT16) ACPI_PTR_DIFF (&(((ACPI_WALK_STATE *) NULL)->Next), NULL);
865
866    AcpiGbl_MemoryLists[ACPI_MEM_LIST_NSNODE].ObjectSize        = sizeof (ACPI_NAMESPACE_NODE);
867    AcpiGbl_MemoryLists[ACPI_MEM_LIST_STATE].ObjectSize         = sizeof (ACPI_GENERIC_STATE);
868    AcpiGbl_MemoryLists[ACPI_MEM_LIST_PSNODE].ObjectSize        = sizeof (ACPI_PARSE_OBJ_COMMON);
869    AcpiGbl_MemoryLists[ACPI_MEM_LIST_PSNODE_EXT].ObjectSize    = sizeof (ACPI_PARSE_OBJ_NAMED);
870    AcpiGbl_MemoryLists[ACPI_MEM_LIST_OPERAND].ObjectSize       = sizeof (ACPI_OPERAND_OBJECT);
871    AcpiGbl_MemoryLists[ACPI_MEM_LIST_WALK].ObjectSize          = sizeof (ACPI_WALK_STATE);
872
873    AcpiGbl_MemoryLists[ACPI_MEM_LIST_STATE].MaxCacheDepth      = ACPI_MAX_STATE_CACHE_DEPTH;
874    AcpiGbl_MemoryLists[ACPI_MEM_LIST_PSNODE].MaxCacheDepth     = ACPI_MAX_PARSE_CACHE_DEPTH;
875    AcpiGbl_MemoryLists[ACPI_MEM_LIST_PSNODE_EXT].MaxCacheDepth = ACPI_MAX_EXTPARSE_CACHE_DEPTH;
876    AcpiGbl_MemoryLists[ACPI_MEM_LIST_OPERAND].MaxCacheDepth    = ACPI_MAX_OBJECT_CACHE_DEPTH;
877    AcpiGbl_MemoryLists[ACPI_MEM_LIST_WALK].MaxCacheDepth       = ACPI_MAX_WALK_CACHE_DEPTH;
878
879    ACPI_MEM_TRACKING (AcpiGbl_MemoryLists[ACPI_MEM_LIST_GLOBAL].ListName       = "Global Memory Allocation");
880    ACPI_MEM_TRACKING (AcpiGbl_MemoryLists[ACPI_MEM_LIST_NSNODE].ListName       = "Namespace Nodes");
881    ACPI_MEM_TRACKING (AcpiGbl_MemoryLists[ACPI_MEM_LIST_STATE].ListName        = "State Object Cache");
882    ACPI_MEM_TRACKING (AcpiGbl_MemoryLists[ACPI_MEM_LIST_PSNODE].ListName       = "Parse Node Cache");
883    ACPI_MEM_TRACKING (AcpiGbl_MemoryLists[ACPI_MEM_LIST_PSNODE_EXT].ListName   = "Extended Parse Node Cache");
884    ACPI_MEM_TRACKING (AcpiGbl_MemoryLists[ACPI_MEM_LIST_OPERAND].ListName      = "Operand Object Cache");
885    ACPI_MEM_TRACKING (AcpiGbl_MemoryLists[ACPI_MEM_LIST_WALK].ListName         = "Tree Walk Node Cache");
886
887    /* ACPI table structure */
888
889    for (i = 0; i < NUM_ACPI_TABLE_TYPES; i++)
890    {
891        AcpiGbl_TableLists[i].Next          = NULL;
892        AcpiGbl_TableLists[i].Count         = 0;
893    }
894
895    /* Mutex locked flags */
896
897    for (i = 0; i < NUM_MUTEX; i++)
898    {
899        AcpiGbl_MutexInfo[i].Mutex          = NULL;
900        AcpiGbl_MutexInfo[i].OwnerId        = ACPI_MUTEX_NOT_ACQUIRED;
901        AcpiGbl_MutexInfo[i].UseCount       = 0;
902    }
903
904    /* GPE support */
905
906    AcpiGbl_GpeXruptListHead            = NULL;
907    AcpiGbl_GpeFadtBlocks[0]            = NULL;
908    AcpiGbl_GpeFadtBlocks[1]            = NULL;
909
910    /* Global notify handlers */
911
912    AcpiGbl_SystemNotify.Handler        = NULL;
913    AcpiGbl_DeviceNotify.Handler        = NULL;
914    AcpiGbl_InitHandler                 = NULL;
915
916    /* Global "typed" ACPI table pointers */
917
918    AcpiGbl_RSDP                        = NULL;
919    AcpiGbl_XSDT                        = NULL;
920    AcpiGbl_FACS                        = NULL;
921    AcpiGbl_FADT                        = NULL;
922    AcpiGbl_DSDT                        = NULL;
923
924    /* Global Lock support */
925
926    AcpiGbl_GlobalLockAcquired          = FALSE;
927    AcpiGbl_GlobalLockThreadCount       = 0;
928    AcpiGbl_GlobalLockHandle            = 0;
929
930    /* Miscellaneous variables */
931
932    AcpiGbl_TableFlags                  = ACPI_PHYSICAL_POINTER;
933    AcpiGbl_RsdpOriginalLocation        = 0;
934    AcpiGbl_CmSingleStep                = FALSE;
935    AcpiGbl_DbTerminateThreads          = FALSE;
936    AcpiGbl_Shutdown                    = FALSE;
937    AcpiGbl_NsLookupCount               = 0;
938    AcpiGbl_PsFindCount                 = 0;
939    AcpiGbl_AcpiHardwarePresent         = TRUE;
940    AcpiGbl_NextTableOwnerId            = ACPI_FIRST_TABLE_ID;
941    AcpiGbl_NextMethodOwnerId           = ACPI_FIRST_METHOD_ID;
942    AcpiGbl_DebuggerConfiguration       = DEBUGGER_THREADING;
943    AcpiGbl_DbOutputFlags               = ACPI_DB_CONSOLE_OUTPUT;
944
945    /* Hardware oriented */
946
947    AcpiGbl_EventsInitialized           = FALSE;
948
949    /* Namespace */
950
951    AcpiGbl_RootNode                    = NULL;
952
953    AcpiGbl_RootNodeStruct.Name.Integer = ACPI_ROOT_NAME;
954    AcpiGbl_RootNodeStruct.Descriptor   = ACPI_DESC_TYPE_NAMED;
955    AcpiGbl_RootNodeStruct.Type         = ACPI_TYPE_DEVICE;
956    AcpiGbl_RootNodeStruct.Child        = NULL;
957    AcpiGbl_RootNodeStruct.Peer         = NULL;
958    AcpiGbl_RootNodeStruct.Object       = NULL;
959    AcpiGbl_RootNodeStruct.Flags        = ANOBJ_END_OF_PEER_LIST;
960
961
962#ifdef ACPI_DEBUG_OUTPUT
963    AcpiGbl_LowestStackPointer          = ACPI_SIZE_MAX;
964#endif
965
966    return_VOID;
967}
968
969
970