1 /******************************************************************************
3 * Module Name: utdecode - Utility decoding routines (value-to-string)
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2017, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
49 #define _COMPONENT ACPI_UTILITIES
50 ACPI_MODULE_NAME ("utdecode")
54 * Properties of the ACPI Object Types, both internal and external.
55 * The table is indexed by values of ACPI_OBJECT_TYPE
57 const UINT8 AcpiGbl_NsProperties
[ACPI_NUM_NS_TYPES
] =
59 ACPI_NS_NORMAL
, /* 00 Any */
60 ACPI_NS_NORMAL
, /* 01 Number */
61 ACPI_NS_NORMAL
, /* 02 String */
62 ACPI_NS_NORMAL
, /* 03 Buffer */
63 ACPI_NS_NORMAL
, /* 04 Package */
64 ACPI_NS_NORMAL
, /* 05 FieldUnit */
65 ACPI_NS_NEWSCOPE
, /* 06 Device */
66 ACPI_NS_NORMAL
, /* 07 Event */
67 ACPI_NS_NEWSCOPE
, /* 08 Method */
68 ACPI_NS_NORMAL
, /* 09 Mutex */
69 ACPI_NS_NORMAL
, /* 10 Region */
70 ACPI_NS_NEWSCOPE
, /* 11 Power */
71 ACPI_NS_NEWSCOPE
, /* 12 Processor */
72 ACPI_NS_NEWSCOPE
, /* 13 Thermal */
73 ACPI_NS_NORMAL
, /* 14 BufferField */
74 ACPI_NS_NORMAL
, /* 15 DdbHandle */
75 ACPI_NS_NORMAL
, /* 16 Debug Object */
76 ACPI_NS_NORMAL
, /* 17 DefField */
77 ACPI_NS_NORMAL
, /* 18 BankField */
78 ACPI_NS_NORMAL
, /* 19 IndexField */
79 ACPI_NS_NORMAL
, /* 20 Reference */
80 ACPI_NS_NORMAL
, /* 21 Alias */
81 ACPI_NS_NORMAL
, /* 22 MethodAlias */
82 ACPI_NS_NORMAL
, /* 23 Notify */
83 ACPI_NS_NORMAL
, /* 24 Address Handler */
84 ACPI_NS_NEWSCOPE
| ACPI_NS_LOCAL
, /* 25 Resource Desc */
85 ACPI_NS_NEWSCOPE
| ACPI_NS_LOCAL
, /* 26 Resource Field */
86 ACPI_NS_NEWSCOPE
, /* 27 Scope */
87 ACPI_NS_NORMAL
, /* 28 Extra */
88 ACPI_NS_NORMAL
, /* 29 Data */
89 ACPI_NS_NORMAL
/* 30 Invalid */
93 /*******************************************************************************
95 * FUNCTION: AcpiUtGetRegionName
97 * PARAMETERS: Space ID - ID for the region
99 * RETURN: Decoded region SpaceId name
101 * DESCRIPTION: Translate a Space ID into a name string (Debug only)
103 ******************************************************************************/
105 /* Region type decoding */
107 const char *AcpiGbl_RegionTypes
[ACPI_NUM_PREDEFINED_REGIONS
] =
109 "SystemMemory", /* 0x00 */
110 "SystemIO", /* 0x01 */
111 "PCI_Config", /* 0x02 */
112 "EmbeddedControl", /* 0x03 */
114 "SystemCMOS", /* 0x05 */
115 "PCIBARTarget", /* 0x06 */
117 "GeneralPurposeIo", /* 0x08 */
118 "GenericSerialBus", /* 0x09 */
124 AcpiUtGetRegionName (
128 if (SpaceId
>= ACPI_USER_REGION_BEGIN
)
130 return ("UserDefinedRegion");
132 else if (SpaceId
== ACPI_ADR_SPACE_DATA_TABLE
)
134 return ("DataTable");
136 else if (SpaceId
== ACPI_ADR_SPACE_FIXED_HARDWARE
)
138 return ("FunctionalFixedHW");
140 else if (SpaceId
>= ACPI_NUM_PREDEFINED_REGIONS
)
142 return ("InvalidSpaceId");
145 return (AcpiGbl_RegionTypes
[SpaceId
]);
149 /*******************************************************************************
151 * FUNCTION: AcpiUtGetEventName
153 * PARAMETERS: EventId - Fixed event ID
155 * RETURN: Decoded event ID name
157 * DESCRIPTION: Translate a Event ID into a name string (Debug only)
159 ******************************************************************************/
161 /* Event type decoding */
163 static const char *AcpiGbl_EventTypes
[ACPI_NUM_FIXED_EVENTS
] =
178 if (EventId
> ACPI_EVENT_MAX
)
180 return ("InvalidEventID");
183 return (AcpiGbl_EventTypes
[EventId
]);
187 /*******************************************************************************
189 * FUNCTION: AcpiUtGetTypeName
191 * PARAMETERS: Type - An ACPI object type
193 * RETURN: Decoded ACPI object type name
195 * DESCRIPTION: Translate a Type ID into a name string (Debug only)
197 ******************************************************************************/
200 * Elements of AcpiGbl_NsTypeNames below must match
201 * one-to-one with values of ACPI_OBJECT_TYPE
203 * The type ACPI_TYPE_ANY (Untyped) is used as a "don't care" when searching;
204 * when stored in a table it really means that we have thus far seen no
205 * evidence to indicate what type is actually going to be stored for this
208 static const char AcpiGbl_BadType
[] = "UNDEFINED";
210 /* Printable names of the ACPI object types */
212 static const char *AcpiGbl_NsTypeNames
[] =
219 /* 05 */ "FieldUnit",
226 /* 12 */ "Processor",
228 /* 14 */ "BufferField",
229 /* 15 */ "DdbHandle",
230 /* 16 */ "DebugObject",
231 /* 17 */ "RegionField",
232 /* 18 */ "BankField",
233 /* 19 */ "IndexField",
234 /* 20 */ "Reference",
236 /* 22 */ "MethodAlias",
238 /* 24 */ "AddrHandler",
239 /* 25 */ "ResourceDesc",
240 /* 26 */ "ResourceFld",
250 ACPI_OBJECT_TYPE Type
)
253 if (Type
> ACPI_TYPE_INVALID
)
255 return (AcpiGbl_BadType
);
258 return (AcpiGbl_NsTypeNames
[Type
]);
263 AcpiUtGetObjectTypeName (
264 ACPI_OPERAND_OBJECT
*ObjDesc
)
266 ACPI_FUNCTION_TRACE (UtGetObjectTypeName
);
271 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC
, "Null Object Descriptor\n"));
272 return_STR ("[NULL Object Descriptor]");
275 /* These descriptor types share a common area */
277 if ((ACPI_GET_DESCRIPTOR_TYPE (ObjDesc
) != ACPI_DESC_TYPE_OPERAND
) &&
278 (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc
) != ACPI_DESC_TYPE_NAMED
))
280 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC
,
281 "Invalid object descriptor type: 0x%2.2X [%s] (%p)\n",
282 ACPI_GET_DESCRIPTOR_TYPE (ObjDesc
),
283 AcpiUtGetDescriptorName (ObjDesc
), ObjDesc
));
285 return_STR ("Invalid object");
288 return_STR (AcpiUtGetTypeName (ObjDesc
->Common
.Type
));
292 /*******************************************************************************
294 * FUNCTION: AcpiUtGetNodeName
296 * PARAMETERS: Object - A namespace node
298 * RETURN: ASCII name of the node
300 * DESCRIPTION: Validate the node and return the node's ACPI name.
302 ******************************************************************************/
308 ACPI_NAMESPACE_NODE
*Node
= (ACPI_NAMESPACE_NODE
*) Object
;
311 /* Must return a string of exactly 4 characters == ACPI_NAME_SIZE */
318 /* Check for Root node */
320 if ((Object
== ACPI_ROOT_OBJECT
) ||
321 (Object
== AcpiGbl_RootNode
))
326 /* Descriptor must be a namespace node */
328 if (ACPI_GET_DESCRIPTOR_TYPE (Node
) != ACPI_DESC_TYPE_NAMED
)
334 * Ensure name is valid. The name was validated/repaired when the node
335 * was created, but make sure it has not been corrupted.
337 AcpiUtRepairName (Node
->Name
.Ascii
);
339 /* Return the name */
341 return (Node
->Name
.Ascii
);
345 /*******************************************************************************
347 * FUNCTION: AcpiUtGetDescriptorName
349 * PARAMETERS: Object - An ACPI object
351 * RETURN: Decoded name of the descriptor type
353 * DESCRIPTION: Validate object and return the descriptor type
355 ******************************************************************************/
357 /* Printable names of object descriptor types */
359 static const char *AcpiGbl_DescTypeNames
[] =
361 /* 00 */ "Not a Descriptor",
363 /* 02 */ "State-Generic",
364 /* 03 */ "State-Update",
365 /* 04 */ "State-Package",
366 /* 05 */ "State-Control",
367 /* 06 */ "State-RootParseScope",
368 /* 07 */ "State-ParseScope",
369 /* 08 */ "State-WalkScope",
370 /* 09 */ "State-Result",
371 /* 10 */ "State-Notify",
372 /* 11 */ "State-Thread",
381 AcpiUtGetDescriptorName (
387 return ("NULL OBJECT");
390 if (ACPI_GET_DESCRIPTOR_TYPE (Object
) > ACPI_DESC_TYPE_MAX
)
392 return ("Not a Descriptor");
395 return (AcpiGbl_DescTypeNames
[ACPI_GET_DESCRIPTOR_TYPE (Object
)]);
399 /*******************************************************************************
401 * FUNCTION: AcpiUtGetReferenceName
403 * PARAMETERS: Object - An ACPI reference object
405 * RETURN: Decoded name of the type of reference
407 * DESCRIPTION: Decode a reference object sub-type to a string.
409 ******************************************************************************/
411 /* Printable names of reference object sub-types */
413 static const char *AcpiGbl_RefClassNames
[] =
419 /* 04 */ "DdbHandle",
420 /* 05 */ "Named Object",
425 AcpiUtGetReferenceName (
426 ACPI_OPERAND_OBJECT
*Object
)
431 return ("NULL Object");
434 if (ACPI_GET_DESCRIPTOR_TYPE (Object
) != ACPI_DESC_TYPE_OPERAND
)
436 return ("Not an Operand object");
439 if (Object
->Common
.Type
!= ACPI_TYPE_LOCAL_REFERENCE
)
441 return ("Not a Reference object");
444 if (Object
->Reference
.Class
> ACPI_REFCLASS_MAX
)
446 return ("Unknown Reference class");
449 return (AcpiGbl_RefClassNames
[Object
->Reference
.Class
]);
453 /*******************************************************************************
455 * FUNCTION: AcpiUtGetMutexName
457 * PARAMETERS: MutexId - The predefined ID for this mutex.
459 * RETURN: Decoded name of the internal mutex
461 * DESCRIPTION: Translate a mutex ID into a name string (Debug only)
463 ******************************************************************************/
465 /* Names for internal mutex objects, used for debug output */
467 static const char *AcpiGbl_MutexNames
[ACPI_NUM_MUTEX
] =
469 "ACPI_MTX_Interpreter",
470 "ACPI_MTX_Namespace",
482 if (MutexId
> ACPI_MAX_MUTEX
)
484 return ("Invalid Mutex ID");
487 return (AcpiGbl_MutexNames
[MutexId
]);
491 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
494 * Strings and procedures used for debug only
497 /*******************************************************************************
499 * FUNCTION: AcpiUtGetNotifyName
501 * PARAMETERS: NotifyValue - Value from the Notify() request
503 * RETURN: Decoded name for the notify value
505 * DESCRIPTION: Translate a Notify Value to a notify namestring.
507 ******************************************************************************/
509 /* Names for Notify() values, used for debug output */
511 static const char *AcpiGbl_GenericNotify
[ACPI_GENERIC_NOTIFY_MAX
+ 1] =
513 /* 00 */ "Bus Check",
514 /* 01 */ "Device Check",
515 /* 02 */ "Device Wake",
516 /* 03 */ "Eject Request",
517 /* 04 */ "Device Check Light",
518 /* 05 */ "Frequency Mismatch",
519 /* 06 */ "Bus Mode Mismatch",
520 /* 07 */ "Power Fault",
521 /* 08 */ "Capabilities Check",
522 /* 09 */ "Device PLD Check",
524 /* 0B */ "System Locality Update",
525 /* 0C */ "Reserved (was previously Shutdown Request)", /* Reserved in ACPI 6.0 */
526 /* 0D */ "System Resource Affinity Update",
527 /* 0E */ "Heterogeneous Memory Attributes Update" /* ACPI 6.2 */
530 static const char *AcpiGbl_DeviceNotify
[5] =
532 /* 80 */ "Status Change",
533 /* 81 */ "Information Change",
534 /* 82 */ "Device-Specific Change",
535 /* 83 */ "Device-Specific Change",
539 static const char *AcpiGbl_ProcessorNotify
[5] =
541 /* 80 */ "Performance Capability Change",
542 /* 81 */ "C-State Change",
543 /* 82 */ "Throttling Capability Change",
544 /* 83 */ "Guaranteed Change",
545 /* 84 */ "Minimum Excursion"
548 static const char *AcpiGbl_ThermalNotify
[5] =
550 /* 80 */ "Thermal Status Change",
551 /* 81 */ "Thermal Trip Point Change",
552 /* 82 */ "Thermal Device List Change",
553 /* 83 */ "Thermal Relationship Change",
559 AcpiUtGetNotifyName (
561 ACPI_OBJECT_TYPE Type
)
564 /* 00 - 0D are "common to all object types" (from ACPI Spec) */
566 if (NotifyValue
<= ACPI_GENERIC_NOTIFY_MAX
)
568 return (AcpiGbl_GenericNotify
[NotifyValue
]);
571 /* 0E - 7F are reserved */
573 if (NotifyValue
<= ACPI_MAX_SYS_NOTIFY
)
578 /* 80 - 84 are per-object-type */
580 if (NotifyValue
<= ACPI_SPECIFIC_NOTIFY_MAX
)
585 case ACPI_TYPE_DEVICE
:
586 return (AcpiGbl_DeviceNotify
[NotifyValue
- 0x80]);
588 case ACPI_TYPE_PROCESSOR
:
589 return (AcpiGbl_ProcessorNotify
[NotifyValue
- 0x80]);
591 case ACPI_TYPE_THERMAL
:
592 return (AcpiGbl_ThermalNotify
[NotifyValue
- 0x80]);
595 return ("Target object type does not support notifies");
599 /* 84 - BF are device-specific */
601 if (NotifyValue
<= ACPI_MAX_DEVICE_SPECIFIC_NOTIFY
)
603 return ("Device-Specific");
606 /* C0 and above are hardware-specific */
608 return ("Hardware-Specific");
612 /*******************************************************************************
614 * FUNCTION: AcpiUtGetArgumentTypeName
616 * PARAMETERS: ArgType - an ARGP_* parser argument type
618 * RETURN: Decoded ARGP_* type
620 * DESCRIPTION: Decode an ARGP_* parser type, as defined in the amlcode.h file,
621 * and used in the acopcode.h file. For example, ARGP_TERMARG.
622 * Used for debug only.
624 ******************************************************************************/
626 static const char *AcpiGbl_ArgumentType
[20] =
628 /* 00 */ "Unknown ARGP",
632 /* 04 */ "DataObject",
633 /* 05 */ "DataObjectList",
634 /* 06 */ "DWordData",
635 /* 07 */ "FieldList",
637 /* 09 */ "NameString",
638 /* 0A */ "ObjectList",
639 /* 0B */ "PackageLength",
640 /* 0C */ "SuperName",
645 /* 11 */ "QWordData",
646 /* 12 */ "SimpleName",
651 AcpiUtGetArgumentTypeName (
655 if (ArgType
> ARGP_MAX
)
657 return ("Unknown ARGP");
660 return (AcpiGbl_ArgumentType
[ArgType
]);
666 /*******************************************************************************
668 * FUNCTION: AcpiUtValidObjectType
670 * PARAMETERS: Type - Object type to be validated
672 * RETURN: TRUE if valid object type, FALSE otherwise
674 * DESCRIPTION: Validate an object type
676 ******************************************************************************/
679 AcpiUtValidObjectType (
680 ACPI_OBJECT_TYPE Type
)
683 if (Type
> ACPI_TYPE_LOCAL_MAX
)
685 /* Note: Assumes all TYPEs are contiguous (external/local) */