Loading...
1/******************************************************************************
2 *
3 * Module Name: utdecode - Utility decoding routines (value-to-string)
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2012, Intel Corp.
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#include <linux/export.h>
45#include <acpi/acpi.h>
46#include "accommon.h"
47#include "acnamesp.h"
48
49#define _COMPONENT ACPI_UTILITIES
50ACPI_MODULE_NAME("utdecode")
51
52/*******************************************************************************
53 *
54 * FUNCTION: acpi_format_exception
55 *
56 * PARAMETERS: Status - The acpi_status code to be formatted
57 *
58 * RETURN: A string containing the exception text. A valid pointer is
59 * always returned.
60 *
61 * DESCRIPTION: This function translates an ACPI exception into an ASCII string
62 * It is here instead of utxface.c so it is always present.
63 *
64 ******************************************************************************/
65const char *acpi_format_exception(acpi_status status)
66{
67 const char *exception = NULL;
68
69 ACPI_FUNCTION_ENTRY();
70
71 exception = acpi_ut_validate_exception(status);
72 if (!exception) {
73
74 /* Exception code was not recognized */
75
76 ACPI_ERROR((AE_INFO,
77 "Unknown exception code: 0x%8.8X", status));
78
79 exception = "UNKNOWN_STATUS_CODE";
80 }
81
82 return (ACPI_CAST_PTR(const char, exception));
83}
84
85ACPI_EXPORT_SYMBOL(acpi_format_exception)
86
87/*
88 * Properties of the ACPI Object Types, both internal and external.
89 * The table is indexed by values of acpi_object_type
90 */
91const u8 acpi_gbl_ns_properties[ACPI_NUM_NS_TYPES] = {
92 ACPI_NS_NORMAL, /* 00 Any */
93 ACPI_NS_NORMAL, /* 01 Number */
94 ACPI_NS_NORMAL, /* 02 String */
95 ACPI_NS_NORMAL, /* 03 Buffer */
96 ACPI_NS_NORMAL, /* 04 Package */
97 ACPI_NS_NORMAL, /* 05 field_unit */
98 ACPI_NS_NEWSCOPE, /* 06 Device */
99 ACPI_NS_NORMAL, /* 07 Event */
100 ACPI_NS_NEWSCOPE, /* 08 Method */
101 ACPI_NS_NORMAL, /* 09 Mutex */
102 ACPI_NS_NORMAL, /* 10 Region */
103 ACPI_NS_NEWSCOPE, /* 11 Power */
104 ACPI_NS_NEWSCOPE, /* 12 Processor */
105 ACPI_NS_NEWSCOPE, /* 13 Thermal */
106 ACPI_NS_NORMAL, /* 14 buffer_field */
107 ACPI_NS_NORMAL, /* 15 ddb_handle */
108 ACPI_NS_NORMAL, /* 16 Debug Object */
109 ACPI_NS_NORMAL, /* 17 def_field */
110 ACPI_NS_NORMAL, /* 18 bank_field */
111 ACPI_NS_NORMAL, /* 19 index_field */
112 ACPI_NS_NORMAL, /* 20 Reference */
113 ACPI_NS_NORMAL, /* 21 Alias */
114 ACPI_NS_NORMAL, /* 22 method_alias */
115 ACPI_NS_NORMAL, /* 23 Notify */
116 ACPI_NS_NORMAL, /* 24 Address Handler */
117 ACPI_NS_NEWSCOPE | ACPI_NS_LOCAL, /* 25 Resource Desc */
118 ACPI_NS_NEWSCOPE | ACPI_NS_LOCAL, /* 26 Resource Field */
119 ACPI_NS_NEWSCOPE, /* 27 Scope */
120 ACPI_NS_NORMAL, /* 28 Extra */
121 ACPI_NS_NORMAL, /* 29 Data */
122 ACPI_NS_NORMAL /* 30 Invalid */
123};
124
125/*******************************************************************************
126 *
127 * FUNCTION: acpi_ut_hex_to_ascii_char
128 *
129 * PARAMETERS: Integer - Contains the hex digit
130 * Position - bit position of the digit within the
131 * integer (multiple of 4)
132 *
133 * RETURN: The converted Ascii character
134 *
135 * DESCRIPTION: Convert a hex digit to an Ascii character
136 *
137 ******************************************************************************/
138
139/* Hex to ASCII conversion table */
140
141static const char acpi_gbl_hex_to_ascii[] = {
142 '0', '1', '2', '3', '4', '5', '6', '7',
143 '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'
144};
145
146char acpi_ut_hex_to_ascii_char(u64 integer, u32 position)
147{
148
149 return (acpi_gbl_hex_to_ascii[(integer >> position) & 0xF]);
150}
151
152/*******************************************************************************
153 *
154 * FUNCTION: acpi_ut_get_region_name
155 *
156 * PARAMETERS: Space ID - ID for the region
157 *
158 * RETURN: Decoded region space_id name
159 *
160 * DESCRIPTION: Translate a Space ID into a name string (Debug only)
161 *
162 ******************************************************************************/
163
164/* Region type decoding */
165
166const char *acpi_gbl_region_types[ACPI_NUM_PREDEFINED_REGIONS] = {
167 "SystemMemory",
168 "SystemIO",
169 "PCI_Config",
170 "EmbeddedControl",
171 "SMBus",
172 "SystemCMOS",
173 "PCIBARTarget",
174 "IPMI",
175 "GeneralPurposeIo",
176 "GenericSerialBus"
177};
178
179char *acpi_ut_get_region_name(u8 space_id)
180{
181
182 if (space_id >= ACPI_USER_REGION_BEGIN) {
183 return ("UserDefinedRegion");
184 } else if (space_id == ACPI_ADR_SPACE_DATA_TABLE) {
185 return ("DataTable");
186 } else if (space_id == ACPI_ADR_SPACE_FIXED_HARDWARE) {
187 return ("FunctionalFixedHW");
188 } else if (space_id >= ACPI_NUM_PREDEFINED_REGIONS) {
189 return ("InvalidSpaceId");
190 }
191
192 return (ACPI_CAST_PTR(char, acpi_gbl_region_types[space_id]));
193}
194
195/*******************************************************************************
196 *
197 * FUNCTION: acpi_ut_get_event_name
198 *
199 * PARAMETERS: event_id - Fixed event ID
200 *
201 * RETURN: Decoded event ID name
202 *
203 * DESCRIPTION: Translate a Event ID into a name string (Debug only)
204 *
205 ******************************************************************************/
206
207/* Event type decoding */
208
209static const char *acpi_gbl_event_types[ACPI_NUM_FIXED_EVENTS] = {
210 "PM_Timer",
211 "GlobalLock",
212 "PowerButton",
213 "SleepButton",
214 "RealTimeClock",
215};
216
217char *acpi_ut_get_event_name(u32 event_id)
218{
219
220 if (event_id > ACPI_EVENT_MAX) {
221 return ("InvalidEventID");
222 }
223
224 return (ACPI_CAST_PTR(char, acpi_gbl_event_types[event_id]));
225}
226
227/*******************************************************************************
228 *
229 * FUNCTION: acpi_ut_get_type_name
230 *
231 * PARAMETERS: Type - An ACPI object type
232 *
233 * RETURN: Decoded ACPI object type name
234 *
235 * DESCRIPTION: Translate a Type ID into a name string (Debug only)
236 *
237 ******************************************************************************/
238
239/*
240 * Elements of acpi_gbl_ns_type_names below must match
241 * one-to-one with values of acpi_object_type
242 *
243 * The type ACPI_TYPE_ANY (Untyped) is used as a "don't care" when searching;
244 * when stored in a table it really means that we have thus far seen no
245 * evidence to indicate what type is actually going to be stored for this entry.
246 */
247static const char acpi_gbl_bad_type[] = "UNDEFINED";
248
249/* Printable names of the ACPI object types */
250
251static const char *acpi_gbl_ns_type_names[] = {
252 /* 00 */ "Untyped",
253 /* 01 */ "Integer",
254 /* 02 */ "String",
255 /* 03 */ "Buffer",
256 /* 04 */ "Package",
257 /* 05 */ "FieldUnit",
258 /* 06 */ "Device",
259 /* 07 */ "Event",
260 /* 08 */ "Method",
261 /* 09 */ "Mutex",
262 /* 10 */ "Region",
263 /* 11 */ "Power",
264 /* 12 */ "Processor",
265 /* 13 */ "Thermal",
266 /* 14 */ "BufferField",
267 /* 15 */ "DdbHandle",
268 /* 16 */ "DebugObject",
269 /* 17 */ "RegionField",
270 /* 18 */ "BankField",
271 /* 19 */ "IndexField",
272 /* 20 */ "Reference",
273 /* 21 */ "Alias",
274 /* 22 */ "MethodAlias",
275 /* 23 */ "Notify",
276 /* 24 */ "AddrHandler",
277 /* 25 */ "ResourceDesc",
278 /* 26 */ "ResourceFld",
279 /* 27 */ "Scope",
280 /* 28 */ "Extra",
281 /* 29 */ "Data",
282 /* 30 */ "Invalid"
283};
284
285char *acpi_ut_get_type_name(acpi_object_type type)
286{
287
288 if (type > ACPI_TYPE_INVALID) {
289 return (ACPI_CAST_PTR(char, acpi_gbl_bad_type));
290 }
291
292 return (ACPI_CAST_PTR(char, acpi_gbl_ns_type_names[type]));
293}
294
295char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc)
296{
297
298 if (!obj_desc) {
299 return ("[NULL Object Descriptor]");
300 }
301
302 return (acpi_ut_get_type_name(obj_desc->common.type));
303}
304
305/*******************************************************************************
306 *
307 * FUNCTION: acpi_ut_get_node_name
308 *
309 * PARAMETERS: Object - A namespace node
310 *
311 * RETURN: ASCII name of the node
312 *
313 * DESCRIPTION: Validate the node and return the node's ACPI name.
314 *
315 ******************************************************************************/
316
317char *acpi_ut_get_node_name(void *object)
318{
319 struct acpi_namespace_node *node = (struct acpi_namespace_node *)object;
320
321 /* Must return a string of exactly 4 characters == ACPI_NAME_SIZE */
322
323 if (!object) {
324 return ("NULL");
325 }
326
327 /* Check for Root node */
328
329 if ((object == ACPI_ROOT_OBJECT) || (object == acpi_gbl_root_node)) {
330 return ("\"\\\" ");
331 }
332
333 /* Descriptor must be a namespace node */
334
335 if (ACPI_GET_DESCRIPTOR_TYPE(node) != ACPI_DESC_TYPE_NAMED) {
336 return ("####");
337 }
338
339 /*
340 * Ensure name is valid. The name was validated/repaired when the node
341 * was created, but make sure it has not been corrupted.
342 */
343 acpi_ut_repair_name(node->name.ascii);
344
345 /* Return the name */
346
347 return (node->name.ascii);
348}
349
350/*******************************************************************************
351 *
352 * FUNCTION: acpi_ut_get_descriptor_name
353 *
354 * PARAMETERS: Object - An ACPI object
355 *
356 * RETURN: Decoded name of the descriptor type
357 *
358 * DESCRIPTION: Validate object and return the descriptor type
359 *
360 ******************************************************************************/
361
362/* Printable names of object descriptor types */
363
364static const char *acpi_gbl_desc_type_names[] = {
365 /* 00 */ "Not a Descriptor",
366 /* 01 */ "Cached",
367 /* 02 */ "State-Generic",
368 /* 03 */ "State-Update",
369 /* 04 */ "State-Package",
370 /* 05 */ "State-Control",
371 /* 06 */ "State-RootParseScope",
372 /* 07 */ "State-ParseScope",
373 /* 08 */ "State-WalkScope",
374 /* 09 */ "State-Result",
375 /* 10 */ "State-Notify",
376 /* 11 */ "State-Thread",
377 /* 12 */ "Walk",
378 /* 13 */ "Parser",
379 /* 14 */ "Operand",
380 /* 15 */ "Node"
381};
382
383char *acpi_ut_get_descriptor_name(void *object)
384{
385
386 if (!object) {
387 return ("NULL OBJECT");
388 }
389
390 if (ACPI_GET_DESCRIPTOR_TYPE(object) > ACPI_DESC_TYPE_MAX) {
391 return ("Not a Descriptor");
392 }
393
394 return (ACPI_CAST_PTR(char,
395 acpi_gbl_desc_type_names[ACPI_GET_DESCRIPTOR_TYPE
396 (object)]));
397
398}
399
400/*******************************************************************************
401 *
402 * FUNCTION: acpi_ut_get_reference_name
403 *
404 * PARAMETERS: Object - An ACPI reference object
405 *
406 * RETURN: Decoded name of the type of reference
407 *
408 * DESCRIPTION: Decode a reference object sub-type to a string.
409 *
410 ******************************************************************************/
411
412/* Printable names of reference object sub-types */
413
414static const char *acpi_gbl_ref_class_names[] = {
415 /* 00 */ "Local",
416 /* 01 */ "Argument",
417 /* 02 */ "RefOf",
418 /* 03 */ "Index",
419 /* 04 */ "DdbHandle",
420 /* 05 */ "Named Object",
421 /* 06 */ "Debug"
422};
423
424const char *acpi_ut_get_reference_name(union acpi_operand_object *object)
425{
426
427 if (!object) {
428 return ("NULL Object");
429 }
430
431 if (ACPI_GET_DESCRIPTOR_TYPE(object) != ACPI_DESC_TYPE_OPERAND) {
432 return ("Not an Operand object");
433 }
434
435 if (object->common.type != ACPI_TYPE_LOCAL_REFERENCE) {
436 return ("Not a Reference object");
437 }
438
439 if (object->reference.class > ACPI_REFCLASS_MAX) {
440 return ("Unknown Reference class");
441 }
442
443 return (acpi_gbl_ref_class_names[object->reference.class]);
444}
445
446#if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
447/*
448 * Strings and procedures used for debug only
449 */
450
451/*******************************************************************************
452 *
453 * FUNCTION: acpi_ut_get_mutex_name
454 *
455 * PARAMETERS: mutex_id - The predefined ID for this mutex.
456 *
457 * RETURN: Decoded name of the internal mutex
458 *
459 * DESCRIPTION: Translate a mutex ID into a name string (Debug only)
460 *
461 ******************************************************************************/
462
463/* Names for internal mutex objects, used for debug output */
464
465static char *acpi_gbl_mutex_names[ACPI_NUM_MUTEX] = {
466 "ACPI_MTX_Interpreter",
467 "ACPI_MTX_Namespace",
468 "ACPI_MTX_Tables",
469 "ACPI_MTX_Events",
470 "ACPI_MTX_Caches",
471 "ACPI_MTX_Memory",
472 "ACPI_MTX_CommandComplete",
473 "ACPI_MTX_CommandReady"
474};
475
476char *acpi_ut_get_mutex_name(u32 mutex_id)
477{
478
479 if (mutex_id > ACPI_MAX_MUTEX) {
480 return ("Invalid Mutex ID");
481 }
482
483 return (acpi_gbl_mutex_names[mutex_id]);
484}
485
486/*******************************************************************************
487 *
488 * FUNCTION: acpi_ut_get_notify_name
489 *
490 * PARAMETERS: notify_value - Value from the Notify() request
491 *
492 * RETURN: Decoded name for the notify value
493 *
494 * DESCRIPTION: Translate a Notify Value to a notify namestring.
495 *
496 ******************************************************************************/
497
498/* Names for Notify() values, used for debug output */
499
500static const char *acpi_gbl_notify_value_names[ACPI_NOTIFY_MAX + 1] = {
501 /* 00 */ "Bus Check",
502 /* 01 */ "Device Check",
503 /* 02 */ "Device Wake",
504 /* 03 */ "Eject Request",
505 /* 04 */ "Device Check Light",
506 /* 05 */ "Frequency Mismatch",
507 /* 06 */ "Bus Mode Mismatch",
508 /* 07 */ "Power Fault",
509 /* 08 */ "Capabilities Check",
510 /* 09 */ "Device PLD Check",
511 /* 10 */ "Reserved",
512 /* 11 */ "System Locality Update",
513 /* 12 */ "Shutdown Request"
514};
515
516const char *acpi_ut_get_notify_name(u32 notify_value)
517{
518
519 if (notify_value <= ACPI_NOTIFY_MAX) {
520 return (acpi_gbl_notify_value_names[notify_value]);
521 } else if (notify_value <= ACPI_MAX_SYS_NOTIFY) {
522 return ("Reserved");
523 } else if (notify_value <= ACPI_MAX_DEVICE_SPECIFIC_NOTIFY) {
524 return ("Device Specific");
525 } else {
526 return ("Hardware Specific");
527 }
528}
529#endif
530
531/*******************************************************************************
532 *
533 * FUNCTION: acpi_ut_valid_object_type
534 *
535 * PARAMETERS: Type - Object type to be validated
536 *
537 * RETURN: TRUE if valid object type, FALSE otherwise
538 *
539 * DESCRIPTION: Validate an object type
540 *
541 ******************************************************************************/
542
543u8 acpi_ut_valid_object_type(acpi_object_type type)
544{
545
546 if (type > ACPI_TYPE_LOCAL_MAX) {
547
548 /* Note: Assumes all TYPEs are contiguous (external/local) */
549
550 return (FALSE);
551 }
552
553 return (TRUE);
554}
1// SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
2/******************************************************************************
3 *
4 * Module Name: utdecode - Utility decoding routines (value-to-string)
5 *
6 * Copyright (C) 2000 - 2018, Intel Corp.
7 *
8 *****************************************************************************/
9
10#include <acpi/acpi.h>
11#include "accommon.h"
12#include "acnamesp.h"
13#include "amlcode.h"
14
15#define _COMPONENT ACPI_UTILITIES
16ACPI_MODULE_NAME("utdecode")
17
18/*
19 * Properties of the ACPI Object Types, both internal and external.
20 * The table is indexed by values of acpi_object_type
21 */
22const u8 acpi_gbl_ns_properties[ACPI_NUM_NS_TYPES] = {
23 ACPI_NS_NORMAL, /* 00 Any */
24 ACPI_NS_NORMAL, /* 01 Number */
25 ACPI_NS_NORMAL, /* 02 String */
26 ACPI_NS_NORMAL, /* 03 Buffer */
27 ACPI_NS_NORMAL, /* 04 Package */
28 ACPI_NS_NORMAL, /* 05 field_unit */
29 ACPI_NS_NEWSCOPE, /* 06 Device */
30 ACPI_NS_NORMAL, /* 07 Event */
31 ACPI_NS_NEWSCOPE, /* 08 Method */
32 ACPI_NS_NORMAL, /* 09 Mutex */
33 ACPI_NS_NORMAL, /* 10 Region */
34 ACPI_NS_NEWSCOPE, /* 11 Power */
35 ACPI_NS_NEWSCOPE, /* 12 Processor */
36 ACPI_NS_NEWSCOPE, /* 13 Thermal */
37 ACPI_NS_NORMAL, /* 14 buffer_field */
38 ACPI_NS_NORMAL, /* 15 ddb_handle */
39 ACPI_NS_NORMAL, /* 16 Debug Object */
40 ACPI_NS_NORMAL, /* 17 def_field */
41 ACPI_NS_NORMAL, /* 18 bank_field */
42 ACPI_NS_NORMAL, /* 19 index_field */
43 ACPI_NS_NORMAL, /* 20 Reference */
44 ACPI_NS_NORMAL, /* 21 Alias */
45 ACPI_NS_NORMAL, /* 22 method_alias */
46 ACPI_NS_NORMAL, /* 23 Notify */
47 ACPI_NS_NORMAL, /* 24 Address Handler */
48 ACPI_NS_NEWSCOPE | ACPI_NS_LOCAL, /* 25 Resource Desc */
49 ACPI_NS_NEWSCOPE | ACPI_NS_LOCAL, /* 26 Resource Field */
50 ACPI_NS_NEWSCOPE, /* 27 Scope */
51 ACPI_NS_NORMAL, /* 28 Extra */
52 ACPI_NS_NORMAL, /* 29 Data */
53 ACPI_NS_NORMAL /* 30 Invalid */
54};
55
56/*******************************************************************************
57 *
58 * FUNCTION: acpi_ut_get_region_name
59 *
60 * PARAMETERS: Space ID - ID for the region
61 *
62 * RETURN: Decoded region space_id name
63 *
64 * DESCRIPTION: Translate a Space ID into a name string (Debug only)
65 *
66 ******************************************************************************/
67
68/* Region type decoding */
69
70const char *acpi_gbl_region_types[ACPI_NUM_PREDEFINED_REGIONS] = {
71 "SystemMemory", /* 0x00 */
72 "SystemIO", /* 0x01 */
73 "PCI_Config", /* 0x02 */
74 "EmbeddedControl", /* 0x03 */
75 "SMBus", /* 0x04 */
76 "SystemCMOS", /* 0x05 */
77 "PCIBARTarget", /* 0x06 */
78 "IPMI", /* 0x07 */
79 "GeneralPurposeIo", /* 0x08 */
80 "GenericSerialBus", /* 0x09 */
81 "PCC" /* 0x0A */
82};
83
84const char *acpi_ut_get_region_name(u8 space_id)
85{
86
87 if (space_id >= ACPI_USER_REGION_BEGIN) {
88 return ("UserDefinedRegion");
89 } else if (space_id == ACPI_ADR_SPACE_DATA_TABLE) {
90 return ("DataTable");
91 } else if (space_id == ACPI_ADR_SPACE_FIXED_HARDWARE) {
92 return ("FunctionalFixedHW");
93 } else if (space_id >= ACPI_NUM_PREDEFINED_REGIONS) {
94 return ("InvalidSpaceId");
95 }
96
97 return (acpi_gbl_region_types[space_id]);
98}
99
100/*******************************************************************************
101 *
102 * FUNCTION: acpi_ut_get_event_name
103 *
104 * PARAMETERS: event_id - Fixed event ID
105 *
106 * RETURN: Decoded event ID name
107 *
108 * DESCRIPTION: Translate a Event ID into a name string (Debug only)
109 *
110 ******************************************************************************/
111
112/* Event type decoding */
113
114static const char *acpi_gbl_event_types[ACPI_NUM_FIXED_EVENTS] = {
115 "PM_Timer",
116 "GlobalLock",
117 "PowerButton",
118 "SleepButton",
119 "RealTimeClock",
120};
121
122const char *acpi_ut_get_event_name(u32 event_id)
123{
124
125 if (event_id > ACPI_EVENT_MAX) {
126 return ("InvalidEventID");
127 }
128
129 return (acpi_gbl_event_types[event_id]);
130}
131
132/*******************************************************************************
133 *
134 * FUNCTION: acpi_ut_get_type_name
135 *
136 * PARAMETERS: type - An ACPI object type
137 *
138 * RETURN: Decoded ACPI object type name
139 *
140 * DESCRIPTION: Translate a Type ID into a name string (Debug only)
141 *
142 ******************************************************************************/
143
144/*
145 * Elements of acpi_gbl_ns_type_names below must match
146 * one-to-one with values of acpi_object_type
147 *
148 * The type ACPI_TYPE_ANY (Untyped) is used as a "don't care" when searching;
149 * when stored in a table it really means that we have thus far seen no
150 * evidence to indicate what type is actually going to be stored for this
151 & entry.
152 */
153static const char acpi_gbl_bad_type[] = "UNDEFINED";
154
155/* Printable names of the ACPI object types */
156
157static const char *acpi_gbl_ns_type_names[] = {
158 /* 00 */ "Untyped",
159 /* 01 */ "Integer",
160 /* 02 */ "String",
161 /* 03 */ "Buffer",
162 /* 04 */ "Package",
163 /* 05 */ "FieldUnit",
164 /* 06 */ "Device",
165 /* 07 */ "Event",
166 /* 08 */ "Method",
167 /* 09 */ "Mutex",
168 /* 10 */ "Region",
169 /* 11 */ "Power",
170 /* 12 */ "Processor",
171 /* 13 */ "Thermal",
172 /* 14 */ "BufferField",
173 /* 15 */ "DdbHandle",
174 /* 16 */ "DebugObject",
175 /* 17 */ "RegionField",
176 /* 18 */ "BankField",
177 /* 19 */ "IndexField",
178 /* 20 */ "Reference",
179 /* 21 */ "Alias",
180 /* 22 */ "MethodAlias",
181 /* 23 */ "Notify",
182 /* 24 */ "AddrHandler",
183 /* 25 */ "ResourceDesc",
184 /* 26 */ "ResourceFld",
185 /* 27 */ "Scope",
186 /* 28 */ "Extra",
187 /* 29 */ "Data",
188 /* 30 */ "Invalid"
189};
190
191const char *acpi_ut_get_type_name(acpi_object_type type)
192{
193
194 if (type > ACPI_TYPE_INVALID) {
195 return (acpi_gbl_bad_type);
196 }
197
198 return (acpi_gbl_ns_type_names[type]);
199}
200
201const char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc)
202{
203 ACPI_FUNCTION_TRACE(ut_get_object_type_name);
204
205 if (!obj_desc) {
206 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Null Object Descriptor\n"));
207 return_STR("[NULL Object Descriptor]");
208 }
209
210 /* These descriptor types share a common area */
211
212 if ((ACPI_GET_DESCRIPTOR_TYPE(obj_desc) != ACPI_DESC_TYPE_OPERAND) &&
213 (ACPI_GET_DESCRIPTOR_TYPE(obj_desc) != ACPI_DESC_TYPE_NAMED)) {
214 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
215 "Invalid object descriptor type: 0x%2.2X [%s] (%p)\n",
216 ACPI_GET_DESCRIPTOR_TYPE(obj_desc),
217 acpi_ut_get_descriptor_name(obj_desc),
218 obj_desc));
219
220 return_STR("Invalid object");
221 }
222
223 return_STR(acpi_ut_get_type_name(obj_desc->common.type));
224}
225
226/*******************************************************************************
227 *
228 * FUNCTION: acpi_ut_get_node_name
229 *
230 * PARAMETERS: object - A namespace node
231 *
232 * RETURN: ASCII name of the node
233 *
234 * DESCRIPTION: Validate the node and return the node's ACPI name.
235 *
236 ******************************************************************************/
237
238const char *acpi_ut_get_node_name(void *object)
239{
240 struct acpi_namespace_node *node = (struct acpi_namespace_node *)object;
241
242 /* Must return a string of exactly 4 characters == ACPI_NAME_SIZE */
243
244 if (!object) {
245 return ("NULL");
246 }
247
248 /* Check for Root node */
249
250 if ((object == ACPI_ROOT_OBJECT) || (object == acpi_gbl_root_node)) {
251 return ("\"\\\" ");
252 }
253
254 /* Descriptor must be a namespace node */
255
256 if (ACPI_GET_DESCRIPTOR_TYPE(node) != ACPI_DESC_TYPE_NAMED) {
257 return ("####");
258 }
259
260 /*
261 * Ensure name is valid. The name was validated/repaired when the node
262 * was created, but make sure it has not been corrupted.
263 */
264 acpi_ut_repair_name(node->name.ascii);
265
266 /* Return the name */
267
268 return (node->name.ascii);
269}
270
271/*******************************************************************************
272 *
273 * FUNCTION: acpi_ut_get_descriptor_name
274 *
275 * PARAMETERS: object - An ACPI object
276 *
277 * RETURN: Decoded name of the descriptor type
278 *
279 * DESCRIPTION: Validate object and return the descriptor type
280 *
281 ******************************************************************************/
282
283/* Printable names of object descriptor types */
284
285static const char *acpi_gbl_desc_type_names[] = {
286 /* 00 */ "Not a Descriptor",
287 /* 01 */ "Cached",
288 /* 02 */ "State-Generic",
289 /* 03 */ "State-Update",
290 /* 04 */ "State-Package",
291 /* 05 */ "State-Control",
292 /* 06 */ "State-RootParseScope",
293 /* 07 */ "State-ParseScope",
294 /* 08 */ "State-WalkScope",
295 /* 09 */ "State-Result",
296 /* 10 */ "State-Notify",
297 /* 11 */ "State-Thread",
298 /* 12 */ "Walk",
299 /* 13 */ "Parser",
300 /* 14 */ "Operand",
301 /* 15 */ "Node"
302};
303
304const char *acpi_ut_get_descriptor_name(void *object)
305{
306
307 if (!object) {
308 return ("NULL OBJECT");
309 }
310
311 if (ACPI_GET_DESCRIPTOR_TYPE(object) > ACPI_DESC_TYPE_MAX) {
312 return ("Not a Descriptor");
313 }
314
315 return (acpi_gbl_desc_type_names[ACPI_GET_DESCRIPTOR_TYPE(object)]);
316}
317
318/*******************************************************************************
319 *
320 * FUNCTION: acpi_ut_get_reference_name
321 *
322 * PARAMETERS: object - An ACPI reference object
323 *
324 * RETURN: Decoded name of the type of reference
325 *
326 * DESCRIPTION: Decode a reference object sub-type to a string.
327 *
328 ******************************************************************************/
329
330/* Printable names of reference object sub-types */
331
332static const char *acpi_gbl_ref_class_names[] = {
333 /* 00 */ "Local",
334 /* 01 */ "Argument",
335 /* 02 */ "RefOf",
336 /* 03 */ "Index",
337 /* 04 */ "DdbHandle",
338 /* 05 */ "Named Object",
339 /* 06 */ "Debug"
340};
341
342const char *acpi_ut_get_reference_name(union acpi_operand_object *object)
343{
344
345 if (!object) {
346 return ("NULL Object");
347 }
348
349 if (ACPI_GET_DESCRIPTOR_TYPE(object) != ACPI_DESC_TYPE_OPERAND) {
350 return ("Not an Operand object");
351 }
352
353 if (object->common.type != ACPI_TYPE_LOCAL_REFERENCE) {
354 return ("Not a Reference object");
355 }
356
357 if (object->reference.class > ACPI_REFCLASS_MAX) {
358 return ("Unknown Reference class");
359 }
360
361 return (acpi_gbl_ref_class_names[object->reference.class]);
362}
363
364/*******************************************************************************
365 *
366 * FUNCTION: acpi_ut_get_mutex_name
367 *
368 * PARAMETERS: mutex_id - The predefined ID for this mutex.
369 *
370 * RETURN: Decoded name of the internal mutex
371 *
372 * DESCRIPTION: Translate a mutex ID into a name string (Debug only)
373 *
374 ******************************************************************************/
375
376/* Names for internal mutex objects, used for debug output */
377
378static const char *acpi_gbl_mutex_names[ACPI_NUM_MUTEX] = {
379 "ACPI_MTX_Interpreter",
380 "ACPI_MTX_Namespace",
381 "ACPI_MTX_Tables",
382 "ACPI_MTX_Events",
383 "ACPI_MTX_Caches",
384 "ACPI_MTX_Memory",
385};
386
387const char *acpi_ut_get_mutex_name(u32 mutex_id)
388{
389
390 if (mutex_id > ACPI_MAX_MUTEX) {
391 return ("Invalid Mutex ID");
392 }
393
394 return (acpi_gbl_mutex_names[mutex_id]);
395}
396
397#if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
398
399/*
400 * Strings and procedures used for debug only
401 */
402
403/*******************************************************************************
404 *
405 * FUNCTION: acpi_ut_get_notify_name
406 *
407 * PARAMETERS: notify_value - Value from the Notify() request
408 *
409 * RETURN: Decoded name for the notify value
410 *
411 * DESCRIPTION: Translate a Notify Value to a notify namestring.
412 *
413 ******************************************************************************/
414
415/* Names for Notify() values, used for debug output */
416
417static const char *acpi_gbl_generic_notify[ACPI_GENERIC_NOTIFY_MAX + 1] = {
418 /* 00 */ "Bus Check",
419 /* 01 */ "Device Check",
420 /* 02 */ "Device Wake",
421 /* 03 */ "Eject Request",
422 /* 04 */ "Device Check Light",
423 /* 05 */ "Frequency Mismatch",
424 /* 06 */ "Bus Mode Mismatch",
425 /* 07 */ "Power Fault",
426 /* 08 */ "Capabilities Check",
427 /* 09 */ "Device PLD Check",
428 /* 0A */ "Reserved",
429 /* 0B */ "System Locality Update",
430 /* 0C */ "Reserved (was previously Shutdown Request)",
431 /* Reserved in ACPI 6.0 */
432 /* 0D */ "System Resource Affinity Update",
433 /* 0E */ "Heterogeneous Memory Attributes Update"
434 /* ACPI 6.2 */
435};
436
437static const char *acpi_gbl_device_notify[5] = {
438 /* 80 */ "Status Change",
439 /* 81 */ "Information Change",
440 /* 82 */ "Device-Specific Change",
441 /* 83 */ "Device-Specific Change",
442 /* 84 */ "Reserved"
443};
444
445static const char *acpi_gbl_processor_notify[5] = {
446 /* 80 */ "Performance Capability Change",
447 /* 81 */ "C-State Change",
448 /* 82 */ "Throttling Capability Change",
449 /* 83 */ "Guaranteed Change",
450 /* 84 */ "Minimum Excursion"
451};
452
453static const char *acpi_gbl_thermal_notify[5] = {
454 /* 80 */ "Thermal Status Change",
455 /* 81 */ "Thermal Trip Point Change",
456 /* 82 */ "Thermal Device List Change",
457 /* 83 */ "Thermal Relationship Change",
458 /* 84 */ "Reserved"
459};
460
461const char *acpi_ut_get_notify_name(u32 notify_value, acpi_object_type type)
462{
463
464 /* 00 - 0D are "common to all object types" (from ACPI Spec) */
465
466 if (notify_value <= ACPI_GENERIC_NOTIFY_MAX) {
467 return (acpi_gbl_generic_notify[notify_value]);
468 }
469
470 /* 0E - 7F are reserved */
471
472 if (notify_value <= ACPI_MAX_SYS_NOTIFY) {
473 return ("Reserved");
474 }
475
476 /* 80 - 84 are per-object-type */
477
478 if (notify_value <= ACPI_SPECIFIC_NOTIFY_MAX) {
479 switch (type) {
480 case ACPI_TYPE_ANY:
481 case ACPI_TYPE_DEVICE:
482 return (acpi_gbl_device_notify[notify_value - 0x80]);
483
484 case ACPI_TYPE_PROCESSOR:
485 return (acpi_gbl_processor_notify[notify_value - 0x80]);
486
487 case ACPI_TYPE_THERMAL:
488 return (acpi_gbl_thermal_notify[notify_value - 0x80]);
489
490 default:
491 return ("Target object type does not support notifies");
492 }
493 }
494
495 /* 84 - BF are device-specific */
496
497 if (notify_value <= ACPI_MAX_DEVICE_SPECIFIC_NOTIFY) {
498 return ("Device-Specific");
499 }
500
501 /* C0 and above are hardware-specific */
502
503 return ("Hardware-Specific");
504}
505
506/*******************************************************************************
507 *
508 * FUNCTION: acpi_ut_get_argument_type_name
509 *
510 * PARAMETERS: arg_type - an ARGP_* parser argument type
511 *
512 * RETURN: Decoded ARGP_* type
513 *
514 * DESCRIPTION: Decode an ARGP_* parser type, as defined in the amlcode.h file,
515 * and used in the acopcode.h file. For example, ARGP_TERMARG.
516 * Used for debug only.
517 *
518 ******************************************************************************/
519
520static const char *acpi_gbl_argument_type[20] = {
521 /* 00 */ "Unknown ARGP",
522 /* 01 */ "ByteData",
523 /* 02 */ "ByteList",
524 /* 03 */ "CharList",
525 /* 04 */ "DataObject",
526 /* 05 */ "DataObjectList",
527 /* 06 */ "DWordData",
528 /* 07 */ "FieldList",
529 /* 08 */ "Name",
530 /* 09 */ "NameString",
531 /* 0A */ "ObjectList",
532 /* 0B */ "PackageLength",
533 /* 0C */ "SuperName",
534 /* 0D */ "Target",
535 /* 0E */ "TermArg",
536 /* 0F */ "TermList",
537 /* 10 */ "WordData",
538 /* 11 */ "QWordData",
539 /* 12 */ "SimpleName",
540 /* 13 */ "NameOrRef"
541};
542
543const char *acpi_ut_get_argument_type_name(u32 arg_type)
544{
545
546 if (arg_type > ARGP_MAX) {
547 return ("Unknown ARGP");
548 }
549
550 return (acpi_gbl_argument_type[arg_type]);
551}
552
553#endif
554
555/*******************************************************************************
556 *
557 * FUNCTION: acpi_ut_valid_object_type
558 *
559 * PARAMETERS: type - Object type to be validated
560 *
561 * RETURN: TRUE if valid object type, FALSE otherwise
562 *
563 * DESCRIPTION: Validate an object type
564 *
565 ******************************************************************************/
566
567u8 acpi_ut_valid_object_type(acpi_object_type type)
568{
569
570 if (type > ACPI_TYPE_LOCAL_MAX) {
571
572 /* Note: Assumes all TYPEs are contiguous (external/local) */
573
574 return (FALSE);
575 }
576
577 return (TRUE);
578}