ACPICA: Store GPE number instead of bitmask
[linux-2.6] / drivers / acpi / utilities / utglobal.c
1 /******************************************************************************
2  *
3  * Module Name: utglobal - Global variables for the ACPI subsystem
4  *
5  *****************************************************************************/
6
7 /*
8  * Copyright (C) 2000 - 2006, R. Byron Moore
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions, and the following disclaimer,
16  *    without modification.
17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18  *    substantially similar to the "NO WARRANTY" disclaimer below
19  *    ("Disclaimer") and any redistribution must be conditioned upon
20  *    including a substantially similar Disclaimer requirement for further
21  *    binary redistribution.
22  * 3. Neither the names of the above-listed copyright holders nor the names
23  *    of any contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * Alternatively, this software may be distributed under the terms of the
27  * GNU General Public License ("GPL") version 2 as published by the Free
28  * Software Foundation.
29  *
30  * NO WARRANTY
31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41  * POSSIBILITY OF SUCH DAMAGES.
42  */
43
44 #define DEFINE_ACPI_GLOBALS
45
46 #include <acpi/acpi.h>
47 #include <acpi/acnamesp.h>
48
49 ACPI_EXPORT_SYMBOL(acpi_gbl_FADT)
50 #define _COMPONENT          ACPI_UTILITIES
51     ACPI_MODULE_NAME("utglobal")
52
53 /*******************************************************************************
54  *
55  * FUNCTION:    acpi_format_exception
56  *
57  * PARAMETERS:  Status       - The acpi_status code to be formatted
58  *
59  * RETURN:      A string containing the exception text. A valid pointer is
60  *              always returned.
61  *
62  * DESCRIPTION: This function translates an ACPI exception into an ASCII string.
63  *
64  ******************************************************************************/
65 const char *acpi_format_exception(acpi_status status)
66 {
67         acpi_status sub_status;
68         const char *exception = NULL;
69
70         ACPI_FUNCTION_ENTRY();
71
72         /*
73          * Status is composed of two parts, a "type" and an actual code
74          */
75         sub_status = (status & ~AE_CODE_MASK);
76
77         switch (status & AE_CODE_MASK) {
78         case AE_CODE_ENVIRONMENTAL:
79
80                 if (sub_status <= AE_CODE_ENV_MAX) {
81                         exception = acpi_gbl_exception_names_env[sub_status];
82                 }
83                 break;
84
85         case AE_CODE_PROGRAMMER:
86
87                 if (sub_status <= AE_CODE_PGM_MAX) {
88                         exception =
89                             acpi_gbl_exception_names_pgm[sub_status - 1];
90                 }
91                 break;
92
93         case AE_CODE_ACPI_TABLES:
94
95                 if (sub_status <= AE_CODE_TBL_MAX) {
96                         exception =
97                             acpi_gbl_exception_names_tbl[sub_status - 1];
98                 }
99                 break;
100
101         case AE_CODE_AML:
102
103                 if (sub_status <= AE_CODE_AML_MAX) {
104                         exception =
105                             acpi_gbl_exception_names_aml[sub_status - 1];
106                 }
107                 break;
108
109         case AE_CODE_CONTROL:
110
111                 if (sub_status <= AE_CODE_CTRL_MAX) {
112                         exception =
113                             acpi_gbl_exception_names_ctrl[sub_status - 1];
114                 }
115                 break;
116
117         default:
118                 break;
119         }
120
121         if (!exception) {
122
123                 /* Exception code was not recognized */
124
125                 ACPI_ERROR((AE_INFO,
126                             "Unknown exception code: 0x%8.8X", status));
127
128                 exception = "UNKNOWN_STATUS_CODE";
129         }
130
131         return (ACPI_CAST_PTR(const char, exception));
132 }
133
134 /*******************************************************************************
135  *
136  * Static global variable initialization.
137  *
138  ******************************************************************************/
139
140 /*
141  * We want the debug switches statically initialized so they
142  * are already set when the debugger is entered.
143  */
144
145 /* Debug switch - level and trace mask */
146 u32 acpi_dbg_level = ACPI_DEBUG_DEFAULT;
147
148 /* Debug switch - layer (component) mask */
149
150 u32 acpi_dbg_layer = ACPI_COMPONENT_DEFAULT | ACPI_ALL_DRIVERS;
151 u32 acpi_gbl_nesting_level = 0;
152
153 /* Debugger globals */
154
155 u8 acpi_gbl_db_terminate_threads = FALSE;
156 u8 acpi_gbl_abort_method = FALSE;
157 u8 acpi_gbl_method_executing = FALSE;
158
159 /* System flags */
160
161 u32 acpi_gbl_startup_flags = 0;
162
163 /* System starts uninitialized */
164
165 u8 acpi_gbl_shutdown = TRUE;
166
167 const char *acpi_gbl_sleep_state_names[ACPI_S_STATE_COUNT] = {
168         "\\_S0_",
169         "\\_S1_",
170         "\\_S2_",
171         "\\_S3_",
172         "\\_S4_",
173         "\\_S5_"
174 };
175
176 const char *acpi_gbl_highest_dstate_names[4] = {
177         "_S1D",
178         "_S2D",
179         "_S3D",
180         "_S4D"
181 };
182
183 /*******************************************************************************
184  *
185  * Namespace globals
186  *
187  ******************************************************************************/
188
189 /*
190  * Predefined ACPI Names (Built-in to the Interpreter)
191  *
192  * NOTES:
193  * 1) _SB_ is defined to be a device to allow \_SB_._INI to be run
194  *    during the initialization sequence.
195  * 2) _TZ_ is defined to be a thermal zone in order to allow ASL code to
196  *    perform a Notify() operation on it.
197  */
198 const struct acpi_predefined_names acpi_gbl_pre_defined_names[] = {
199         {"_GPE", ACPI_TYPE_LOCAL_SCOPE, NULL},
200         {"_PR_", ACPI_TYPE_LOCAL_SCOPE, NULL},
201         {"_SB_", ACPI_TYPE_DEVICE, NULL},
202         {"_SI_", ACPI_TYPE_LOCAL_SCOPE, NULL},
203         {"_TZ_", ACPI_TYPE_THERMAL, NULL},
204         {"_REV", ACPI_TYPE_INTEGER, (char *)ACPI_CA_SUPPORT_LEVEL},
205         {"_OS_", ACPI_TYPE_STRING, ACPI_OS_NAME},
206         {"_GL_", ACPI_TYPE_MUTEX, (char *)1},
207
208 #if !defined (ACPI_NO_METHOD_EXECUTION) || defined (ACPI_CONSTANT_EVAL_ONLY)
209         {"_OSI", ACPI_TYPE_METHOD, (char *)1},
210 #endif
211
212         /* Table terminator */
213
214         {NULL, ACPI_TYPE_ANY, NULL}
215 };
216
217 /*
218  * Properties of the ACPI Object Types, both internal and external.
219  * The table is indexed by values of acpi_object_type
220  */
221 const u8 acpi_gbl_ns_properties[] = {
222         ACPI_NS_NORMAL,         /* 00 Any              */
223         ACPI_NS_NORMAL,         /* 01 Number           */
224         ACPI_NS_NORMAL,         /* 02 String           */
225         ACPI_NS_NORMAL,         /* 03 Buffer           */
226         ACPI_NS_NORMAL,         /* 04 Package          */
227         ACPI_NS_NORMAL,         /* 05 field_unit       */
228         ACPI_NS_NEWSCOPE,       /* 06 Device           */
229         ACPI_NS_NORMAL,         /* 07 Event            */
230         ACPI_NS_NEWSCOPE,       /* 08 Method           */
231         ACPI_NS_NORMAL,         /* 09 Mutex            */
232         ACPI_NS_NORMAL,         /* 10 Region           */
233         ACPI_NS_NEWSCOPE,       /* 11 Power            */
234         ACPI_NS_NEWSCOPE,       /* 12 Processor        */
235         ACPI_NS_NEWSCOPE,       /* 13 Thermal          */
236         ACPI_NS_NORMAL,         /* 14 buffer_field     */
237         ACPI_NS_NORMAL,         /* 15 ddb_handle       */
238         ACPI_NS_NORMAL,         /* 16 Debug Object     */
239         ACPI_NS_NORMAL,         /* 17 def_field        */
240         ACPI_NS_NORMAL,         /* 18 bank_field       */
241         ACPI_NS_NORMAL,         /* 19 index_field      */
242         ACPI_NS_NORMAL,         /* 20 Reference        */
243         ACPI_NS_NORMAL,         /* 21 Alias            */
244         ACPI_NS_NORMAL,         /* 22 method_alias     */
245         ACPI_NS_NORMAL,         /* 23 Notify           */
246         ACPI_NS_NORMAL,         /* 24 Address Handler  */
247         ACPI_NS_NEWSCOPE | ACPI_NS_LOCAL,       /* 25 Resource Desc    */
248         ACPI_NS_NEWSCOPE | ACPI_NS_LOCAL,       /* 26 Resource Field   */
249         ACPI_NS_NEWSCOPE,       /* 27 Scope            */
250         ACPI_NS_NORMAL,         /* 28 Extra            */
251         ACPI_NS_NORMAL,         /* 29 Data             */
252         ACPI_NS_NORMAL          /* 30 Invalid          */
253 };
254
255 /* Hex to ASCII conversion table */
256
257 static const char acpi_gbl_hex_to_ascii[] = {
258         '0', '1', '2', '3', '4', '5', '6', '7',
259         '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'
260 };
261
262 /*******************************************************************************
263  *
264  * FUNCTION:    acpi_ut_hex_to_ascii_char
265  *
266  * PARAMETERS:  Integer             - Contains the hex digit
267  *              Position            - bit position of the digit within the
268  *                                    integer (multiple of 4)
269  *
270  * RETURN:      The converted Ascii character
271  *
272  * DESCRIPTION: Convert a hex digit to an Ascii character
273  *
274  ******************************************************************************/
275
276 char acpi_ut_hex_to_ascii_char(acpi_integer integer, u32 position)
277 {
278
279         return (acpi_gbl_hex_to_ascii[(integer >> position) & 0xF]);
280 }
281
282 /******************************************************************************
283  *
284  * Event and Hardware globals
285  *
286  ******************************************************************************/
287
288 struct acpi_bit_register_info acpi_gbl_bit_register_info[ACPI_NUM_BITREG] = {
289         /* Name                                     Parent Register             Register Bit Position                   Register Bit Mask       */
290
291         /* ACPI_BITREG_TIMER_STATUS         */ {ACPI_REGISTER_PM1_STATUS,
292                                                 ACPI_BITPOSITION_TIMER_STATUS,
293                                                 ACPI_BITMASK_TIMER_STATUS},
294         /* ACPI_BITREG_BUS_MASTER_STATUS    */ {ACPI_REGISTER_PM1_STATUS,
295                                                 ACPI_BITPOSITION_BUS_MASTER_STATUS,
296                                                 ACPI_BITMASK_BUS_MASTER_STATUS},
297         /* ACPI_BITREG_GLOBAL_LOCK_STATUS   */ {ACPI_REGISTER_PM1_STATUS,
298                                                 ACPI_BITPOSITION_GLOBAL_LOCK_STATUS,
299                                                 ACPI_BITMASK_GLOBAL_LOCK_STATUS},
300         /* ACPI_BITREG_POWER_BUTTON_STATUS  */ {ACPI_REGISTER_PM1_STATUS,
301                                                 ACPI_BITPOSITION_POWER_BUTTON_STATUS,
302                                                 ACPI_BITMASK_POWER_BUTTON_STATUS},
303         /* ACPI_BITREG_SLEEP_BUTTON_STATUS  */ {ACPI_REGISTER_PM1_STATUS,
304                                                 ACPI_BITPOSITION_SLEEP_BUTTON_STATUS,
305                                                 ACPI_BITMASK_SLEEP_BUTTON_STATUS},
306         /* ACPI_BITREG_RT_CLOCK_STATUS      */ {ACPI_REGISTER_PM1_STATUS,
307                                                 ACPI_BITPOSITION_RT_CLOCK_STATUS,
308                                                 ACPI_BITMASK_RT_CLOCK_STATUS},
309         /* ACPI_BITREG_WAKE_STATUS          */ {ACPI_REGISTER_PM1_STATUS,
310                                                 ACPI_BITPOSITION_WAKE_STATUS,
311                                                 ACPI_BITMASK_WAKE_STATUS},
312         /* ACPI_BITREG_PCIEXP_WAKE_STATUS   */ {ACPI_REGISTER_PM1_STATUS,
313                                                 ACPI_BITPOSITION_PCIEXP_WAKE_STATUS,
314                                                 ACPI_BITMASK_PCIEXP_WAKE_STATUS},
315
316         /* ACPI_BITREG_TIMER_ENABLE         */ {ACPI_REGISTER_PM1_ENABLE,
317                                                 ACPI_BITPOSITION_TIMER_ENABLE,
318                                                 ACPI_BITMASK_TIMER_ENABLE},
319         /* ACPI_BITREG_GLOBAL_LOCK_ENABLE   */ {ACPI_REGISTER_PM1_ENABLE,
320                                                 ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE,
321                                                 ACPI_BITMASK_GLOBAL_LOCK_ENABLE},
322         /* ACPI_BITREG_POWER_BUTTON_ENABLE  */ {ACPI_REGISTER_PM1_ENABLE,
323                                                 ACPI_BITPOSITION_POWER_BUTTON_ENABLE,
324                                                 ACPI_BITMASK_POWER_BUTTON_ENABLE},
325         /* ACPI_BITREG_SLEEP_BUTTON_ENABLE  */ {ACPI_REGISTER_PM1_ENABLE,
326                                                 ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE,
327                                                 ACPI_BITMASK_SLEEP_BUTTON_ENABLE},
328         /* ACPI_BITREG_RT_CLOCK_ENABLE      */ {ACPI_REGISTER_PM1_ENABLE,
329                                                 ACPI_BITPOSITION_RT_CLOCK_ENABLE,
330                                                 ACPI_BITMASK_RT_CLOCK_ENABLE},
331         /* ACPI_BITREG_WAKE_ENABLE          */ {ACPI_REGISTER_PM1_ENABLE, 0, 0},
332         /* ACPI_BITREG_PCIEXP_WAKE_DISABLE  */ {ACPI_REGISTER_PM1_ENABLE,
333                                                 ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE,
334                                                 ACPI_BITMASK_PCIEXP_WAKE_DISABLE},
335
336         /* ACPI_BITREG_SCI_ENABLE           */ {ACPI_REGISTER_PM1_CONTROL,
337                                                 ACPI_BITPOSITION_SCI_ENABLE,
338                                                 ACPI_BITMASK_SCI_ENABLE},
339         /* ACPI_BITREG_BUS_MASTER_RLD       */ {ACPI_REGISTER_PM1_CONTROL,
340                                                 ACPI_BITPOSITION_BUS_MASTER_RLD,
341                                                 ACPI_BITMASK_BUS_MASTER_RLD},
342         /* ACPI_BITREG_GLOBAL_LOCK_RELEASE  */ {ACPI_REGISTER_PM1_CONTROL,
343                                                 ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE,
344                                                 ACPI_BITMASK_GLOBAL_LOCK_RELEASE},
345         /* ACPI_BITREG_SLEEP_TYPE_A         */ {ACPI_REGISTER_PM1_CONTROL,
346                                                 ACPI_BITPOSITION_SLEEP_TYPE_X,
347                                                 ACPI_BITMASK_SLEEP_TYPE_X},
348         /* ACPI_BITREG_SLEEP_TYPE_B         */ {ACPI_REGISTER_PM1_CONTROL,
349                                                 ACPI_BITPOSITION_SLEEP_TYPE_X,
350                                                 ACPI_BITMASK_SLEEP_TYPE_X},
351         /* ACPI_BITREG_SLEEP_ENABLE         */ {ACPI_REGISTER_PM1_CONTROL,
352                                                 ACPI_BITPOSITION_SLEEP_ENABLE,
353                                                 ACPI_BITMASK_SLEEP_ENABLE},
354
355         /* ACPI_BITREG_ARB_DIS              */ {ACPI_REGISTER_PM2_CONTROL,
356                                                 ACPI_BITPOSITION_ARB_DISABLE,
357                                                 ACPI_BITMASK_ARB_DISABLE}
358 };
359
360 struct acpi_fixed_event_info acpi_gbl_fixed_event_info[ACPI_NUM_FIXED_EVENTS] = {
361         /* ACPI_EVENT_PMTIMER       */ {ACPI_BITREG_TIMER_STATUS,
362                                         ACPI_BITREG_TIMER_ENABLE,
363                                         ACPI_BITMASK_TIMER_STATUS,
364                                         ACPI_BITMASK_TIMER_ENABLE},
365         /* ACPI_EVENT_GLOBAL        */ {ACPI_BITREG_GLOBAL_LOCK_STATUS,
366                                         ACPI_BITREG_GLOBAL_LOCK_ENABLE,
367                                         ACPI_BITMASK_GLOBAL_LOCK_STATUS,
368                                         ACPI_BITMASK_GLOBAL_LOCK_ENABLE},
369         /* ACPI_EVENT_POWER_BUTTON  */ {ACPI_BITREG_POWER_BUTTON_STATUS,
370                                         ACPI_BITREG_POWER_BUTTON_ENABLE,
371                                         ACPI_BITMASK_POWER_BUTTON_STATUS,
372                                         ACPI_BITMASK_POWER_BUTTON_ENABLE},
373         /* ACPI_EVENT_SLEEP_BUTTON  */ {ACPI_BITREG_SLEEP_BUTTON_STATUS,
374                                         ACPI_BITREG_SLEEP_BUTTON_ENABLE,
375                                         ACPI_BITMASK_SLEEP_BUTTON_STATUS,
376                                         ACPI_BITMASK_SLEEP_BUTTON_ENABLE},
377         /* ACPI_EVENT_RTC           */ {ACPI_BITREG_RT_CLOCK_STATUS,
378                                         ACPI_BITREG_RT_CLOCK_ENABLE,
379                                         ACPI_BITMASK_RT_CLOCK_STATUS,
380                                         ACPI_BITMASK_RT_CLOCK_ENABLE},
381 };
382
383 /*******************************************************************************
384  *
385  * FUNCTION:    acpi_ut_get_region_name
386  *
387  * PARAMETERS:  None.
388  *
389  * RETURN:      Status
390  *
391  * DESCRIPTION: Translate a Space ID into a name string (Debug only)
392  *
393  ******************************************************************************/
394
395 /* Region type decoding */
396
397 const char *acpi_gbl_region_types[ACPI_NUM_PREDEFINED_REGIONS] = {
398         "SystemMemory",
399         "SystemIO",
400         "PCI_Config",
401         "EmbeddedControl",
402         "SMBus",
403         "CMOS",
404         "PCIBARTarget",
405         "DataTable"
406 };
407
408 char *acpi_ut_get_region_name(u8 space_id)
409 {
410
411         if (space_id >= ACPI_USER_REGION_BEGIN) {
412                 return ("UserDefinedRegion");
413         } else if (space_id >= ACPI_NUM_PREDEFINED_REGIONS) {
414                 return ("InvalidSpaceId");
415         }
416
417         return (ACPI_CAST_PTR(char, acpi_gbl_region_types[space_id]));
418 }
419
420 /*******************************************************************************
421  *
422  * FUNCTION:    acpi_ut_get_event_name
423  *
424  * PARAMETERS:  None.
425  *
426  * RETURN:      Status
427  *
428  * DESCRIPTION: Translate a Event ID into a name string (Debug only)
429  *
430  ******************************************************************************/
431
432 /* Event type decoding */
433
434 static const char *acpi_gbl_event_types[ACPI_NUM_FIXED_EVENTS] = {
435         "PM_Timer",
436         "GlobalLock",
437         "PowerButton",
438         "SleepButton",
439         "RealTimeClock",
440 };
441
442 char *acpi_ut_get_event_name(u32 event_id)
443 {
444
445         if (event_id > ACPI_EVENT_MAX) {
446                 return ("InvalidEventID");
447         }
448
449         return (ACPI_CAST_PTR(char, acpi_gbl_event_types[event_id]));
450 }
451
452 /*******************************************************************************
453  *
454  * FUNCTION:    acpi_ut_get_type_name
455  *
456  * PARAMETERS:  None.
457  *
458  * RETURN:      Status
459  *
460  * DESCRIPTION: Translate a Type ID into a name string (Debug only)
461  *
462  ******************************************************************************/
463
464 /*
465  * Elements of acpi_gbl_ns_type_names below must match
466  * one-to-one with values of acpi_object_type
467  *
468  * The type ACPI_TYPE_ANY (Untyped) is used as a "don't care" when searching;
469  * when stored in a table it really means that we have thus far seen no
470  * evidence to indicate what type is actually going to be stored for this entry.
471  */
472 static const char acpi_gbl_bad_type[] = "UNDEFINED";
473
474 /* Printable names of the ACPI object types */
475
476 static const char *acpi_gbl_ns_type_names[] = {
477         /* 00 */ "Untyped",
478         /* 01 */ "Integer",
479         /* 02 */ "String",
480         /* 03 */ "Buffer",
481         /* 04 */ "Package",
482         /* 05 */ "FieldUnit",
483         /* 06 */ "Device",
484         /* 07 */ "Event",
485         /* 08 */ "Method",
486         /* 09 */ "Mutex",
487         /* 10 */ "Region",
488         /* 11 */ "Power",
489         /* 12 */ "Processor",
490         /* 13 */ "Thermal",
491         /* 14 */ "BufferField",
492         /* 15 */ "DdbHandle",
493         /* 16 */ "DebugObject",
494         /* 17 */ "RegionField",
495         /* 18 */ "BankField",
496         /* 19 */ "IndexField",
497         /* 20 */ "Reference",
498         /* 21 */ "Alias",
499         /* 22 */ "MethodAlias",
500         /* 23 */ "Notify",
501         /* 24 */ "AddrHandler",
502         /* 25 */ "ResourceDesc",
503         /* 26 */ "ResourceFld",
504         /* 27 */ "Scope",
505         /* 28 */ "Extra",
506         /* 29 */ "Data",
507         /* 30 */ "Invalid"
508 };
509
510 char *acpi_ut_get_type_name(acpi_object_type type)
511 {
512
513         if (type > ACPI_TYPE_INVALID) {
514                 return (ACPI_CAST_PTR(char, acpi_gbl_bad_type));
515         }
516
517         return (ACPI_CAST_PTR(char, acpi_gbl_ns_type_names[type]));
518 }
519
520 char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc)
521 {
522
523         if (!obj_desc) {
524                 return ("[NULL Object Descriptor]");
525         }
526
527         return (acpi_ut_get_type_name(ACPI_GET_OBJECT_TYPE(obj_desc)));
528 }
529
530 /*******************************************************************************
531  *
532  * FUNCTION:    acpi_ut_get_node_name
533  *
534  * PARAMETERS:  Object               - A namespace node
535  *
536  * RETURN:      Pointer to a string
537  *
538  * DESCRIPTION: Validate the node and return the node's ACPI name.
539  *
540  ******************************************************************************/
541
542 char *acpi_ut_get_node_name(void *object)
543 {
544         struct acpi_namespace_node *node = (struct acpi_namespace_node *)object;
545
546         /* Must return a string of exactly 4 characters == ACPI_NAME_SIZE */
547
548         if (!object) {
549                 return ("NULL");
550         }
551
552         /* Check for Root node */
553
554         if ((object == ACPI_ROOT_OBJECT) || (object == acpi_gbl_root_node)) {
555                 return ("\"\\\" ");
556         }
557
558         /* Descriptor must be a namespace node */
559
560         if (ACPI_GET_DESCRIPTOR_TYPE(node) != ACPI_DESC_TYPE_NAMED) {
561                 return ("####");
562         }
563
564         /* Name must be a valid ACPI name */
565
566         if (!acpi_ut_valid_acpi_name(node->name.integer)) {
567                 node->name.integer = acpi_ut_repair_name(node->name.ascii);
568         }
569
570         /* Return the name */
571
572         return (node->name.ascii);
573 }
574
575 /*******************************************************************************
576  *
577  * FUNCTION:    acpi_ut_get_descriptor_name
578  *
579  * PARAMETERS:  Object               - An ACPI object
580  *
581  * RETURN:      Pointer to a string
582  *
583  * DESCRIPTION: Validate object and return the descriptor type
584  *
585  ******************************************************************************/
586
587 /* Printable names of object descriptor types */
588
589 static const char *acpi_gbl_desc_type_names[] = {
590         /* 00 */ "Invalid",
591         /* 01 */ "Cached",
592         /* 02 */ "State-Generic",
593         /* 03 */ "State-Update",
594         /* 04 */ "State-Package",
595         /* 05 */ "State-Control",
596         /* 06 */ "State-RootParseScope",
597         /* 07 */ "State-ParseScope",
598         /* 08 */ "State-WalkScope",
599         /* 09 */ "State-Result",
600         /* 10 */ "State-Notify",
601         /* 11 */ "State-Thread",
602         /* 12 */ "Walk",
603         /* 13 */ "Parser",
604         /* 14 */ "Operand",
605         /* 15 */ "Node"
606 };
607
608 char *acpi_ut_get_descriptor_name(void *object)
609 {
610
611         if (!object) {
612                 return ("NULL OBJECT");
613         }
614
615         if (ACPI_GET_DESCRIPTOR_TYPE(object) > ACPI_DESC_TYPE_MAX) {
616                 return (ACPI_CAST_PTR(char, acpi_gbl_bad_type));
617         }
618
619         return (ACPI_CAST_PTR(char,
620                               acpi_gbl_desc_type_names[ACPI_GET_DESCRIPTOR_TYPE
621                                                        (object)]));
622
623 }
624
625 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
626 /*
627  * Strings and procedures used for debug only
628  */
629
630 /*******************************************************************************
631  *
632  * FUNCTION:    acpi_ut_get_mutex_name
633  *
634  * PARAMETERS:  mutex_id        - The predefined ID for this mutex.
635  *
636  * RETURN:      String containing the name of the mutex. Always returns a valid
637  *              pointer.
638  *
639  * DESCRIPTION: Translate a mutex ID into a name string (Debug only)
640  *
641  ******************************************************************************/
642
643 char *acpi_ut_get_mutex_name(u32 mutex_id)
644 {
645
646         if (mutex_id > ACPI_MAX_MUTEX) {
647                 return ("Invalid Mutex ID");
648         }
649
650         return (acpi_gbl_mutex_names[mutex_id]);
651 }
652 #endif
653
654 /*******************************************************************************
655  *
656  * FUNCTION:    acpi_ut_valid_object_type
657  *
658  * PARAMETERS:  Type            - Object type to be validated
659  *
660  * RETURN:      TRUE if valid object type, FALSE otherwise
661  *
662  * DESCRIPTION: Validate an object type
663  *
664  ******************************************************************************/
665
666 u8 acpi_ut_valid_object_type(acpi_object_type type)
667 {
668
669         if (type > ACPI_TYPE_LOCAL_MAX) {
670
671                 /* Note: Assumes all TYPEs are contiguous (external/local) */
672
673                 return (FALSE);
674         }
675
676         return (TRUE);
677 }
678
679 /*******************************************************************************
680  *
681  * FUNCTION:    acpi_ut_init_globals
682  *
683  * PARAMETERS:  None
684  *
685  * RETURN:      None
686  *
687  * DESCRIPTION: Init library globals.  All globals that require specific
688  *              initialization should be initialized here!
689  *
690  ******************************************************************************/
691
692 void acpi_ut_init_globals(void)
693 {
694         acpi_status status;
695         u32 i;
696
697         ACPI_FUNCTION_TRACE(ut_init_globals);
698
699         /* Create all memory caches */
700
701         status = acpi_ut_create_caches();
702         if (ACPI_FAILURE(status)) {
703                 return;
704         }
705
706         /* Mutex locked flags */
707
708         for (i = 0; i < ACPI_NUM_MUTEX; i++) {
709                 acpi_gbl_mutex_info[i].mutex = NULL;
710                 acpi_gbl_mutex_info[i].thread_id = ACPI_MUTEX_NOT_ACQUIRED;
711                 acpi_gbl_mutex_info[i].use_count = 0;
712         }
713
714         for (i = 0; i < ACPI_NUM_OWNERID_MASKS; i++) {
715                 acpi_gbl_owner_id_mask[i] = 0;
716         }
717         acpi_gbl_owner_id_mask[ACPI_NUM_OWNERID_MASKS - 1] = 0x80000000;        /* Last ID is never valid */
718
719         /* GPE support */
720
721         acpi_gpe_count = 0;
722         acpi_gbl_gpe_xrupt_list_head = NULL;
723         acpi_gbl_gpe_fadt_blocks[0] = NULL;
724         acpi_gbl_gpe_fadt_blocks[1] = NULL;
725
726         /* Global notify handlers */
727
728         acpi_gbl_system_notify.handler = NULL;
729         acpi_gbl_device_notify.handler = NULL;
730         acpi_gbl_exception_handler = NULL;
731         acpi_gbl_init_handler = NULL;
732
733         /* Global Lock support */
734
735         acpi_gbl_global_lock_semaphore = NULL;
736         acpi_gbl_global_lock_mutex = NULL;
737         acpi_gbl_global_lock_acquired = FALSE;
738         acpi_gbl_global_lock_handle = 0;
739
740         /* Miscellaneous variables */
741
742         acpi_gbl_cm_single_step = FALSE;
743         acpi_gbl_db_terminate_threads = FALSE;
744         acpi_gbl_shutdown = FALSE;
745         acpi_gbl_ns_lookup_count = 0;
746         acpi_gbl_ps_find_count = 0;
747         acpi_gbl_acpi_hardware_present = TRUE;
748         acpi_gbl_last_owner_id_index = 0;
749         acpi_gbl_next_owner_id_offset = 0;
750         acpi_gbl_trace_method_name = 0;
751         acpi_gbl_trace_dbg_level = 0;
752         acpi_gbl_trace_dbg_layer = 0;
753         acpi_gbl_debugger_configuration = DEBUGGER_THREADING;
754         acpi_gbl_db_output_flags = ACPI_DB_CONSOLE_OUTPUT;
755
756         /* Hardware oriented */
757
758         acpi_gbl_events_initialized = FALSE;
759         acpi_gbl_system_awake_and_running = TRUE;
760
761         /* Namespace */
762
763         acpi_gbl_root_node = NULL;
764         acpi_gbl_root_node_struct.name.integer = ACPI_ROOT_NAME;
765         acpi_gbl_root_node_struct.descriptor_type = ACPI_DESC_TYPE_NAMED;
766         acpi_gbl_root_node_struct.type = ACPI_TYPE_DEVICE;
767         acpi_gbl_root_node_struct.child = NULL;
768         acpi_gbl_root_node_struct.peer = NULL;
769         acpi_gbl_root_node_struct.object = NULL;
770         acpi_gbl_root_node_struct.flags = ANOBJ_END_OF_PEER_LIST;
771
772 #ifdef ACPI_DEBUG_OUTPUT
773         acpi_gbl_lowest_stack_pointer = ACPI_SIZE_MAX;
774 #endif
775
776         return_VOID;
777 }
778
779 ACPI_EXPORT_SYMBOL(acpi_dbg_level)
780 ACPI_EXPORT_SYMBOL(acpi_dbg_layer)
781 ACPI_EXPORT_SYMBOL(acpi_gpe_count)