1 /******************************************************************************
3 * Module Name: utdecode - Utility decoding routines (value-to-string)
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2015, Intel Corp.
12 * All rights reserved.
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
37 * The above copyright and patent license is granted only if the following
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
72 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
80 * 4. Disclaimer and Export Compliance
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
114 *****************************************************************************/
117 #include "accommon.h"
118 #include "acnamesp.h"
120 #define _COMPONENT ACPI_UTILITIES
121 ACPI_MODULE_NAME ("utdecode")
125 * Properties of the ACPI Object Types, both internal and external.
126 * The table is indexed by values of ACPI_OBJECT_TYPE
128 const UINT8 AcpiGbl_NsProperties
[ACPI_NUM_NS_TYPES
] =
130 ACPI_NS_NORMAL
, /* 00 Any */
131 ACPI_NS_NORMAL
, /* 01 Number */
132 ACPI_NS_NORMAL
, /* 02 String */
133 ACPI_NS_NORMAL
, /* 03 Buffer */
134 ACPI_NS_NORMAL
, /* 04 Package */
135 ACPI_NS_NORMAL
, /* 05 FieldUnit */
136 ACPI_NS_NEWSCOPE
, /* 06 Device */
137 ACPI_NS_NORMAL
, /* 07 Event */
138 ACPI_NS_NEWSCOPE
, /* 08 Method */
139 ACPI_NS_NORMAL
, /* 09 Mutex */
140 ACPI_NS_NORMAL
, /* 10 Region */
141 ACPI_NS_NEWSCOPE
, /* 11 Power */
142 ACPI_NS_NEWSCOPE
, /* 12 Processor */
143 ACPI_NS_NEWSCOPE
, /* 13 Thermal */
144 ACPI_NS_NORMAL
, /* 14 BufferField */
145 ACPI_NS_NORMAL
, /* 15 DdbHandle */
146 ACPI_NS_NORMAL
, /* 16 Debug Object */
147 ACPI_NS_NORMAL
, /* 17 DefField */
148 ACPI_NS_NORMAL
, /* 18 BankField */
149 ACPI_NS_NORMAL
, /* 19 IndexField */
150 ACPI_NS_NORMAL
, /* 20 Reference */
151 ACPI_NS_NORMAL
, /* 21 Alias */
152 ACPI_NS_NORMAL
, /* 22 MethodAlias */
153 ACPI_NS_NORMAL
, /* 23 Notify */
154 ACPI_NS_NORMAL
, /* 24 Address Handler */
155 ACPI_NS_NEWSCOPE
| ACPI_NS_LOCAL
, /* 25 Resource Desc */
156 ACPI_NS_NEWSCOPE
| ACPI_NS_LOCAL
, /* 26 Resource Field */
157 ACPI_NS_NEWSCOPE
, /* 27 Scope */
158 ACPI_NS_NORMAL
, /* 28 Extra */
159 ACPI_NS_NORMAL
, /* 29 Data */
160 ACPI_NS_NORMAL
/* 30 Invalid */
164 /*******************************************************************************
166 * FUNCTION: AcpiUtGetRegionName
168 * PARAMETERS: Space ID - ID for the region
170 * RETURN: Decoded region SpaceId name
172 * DESCRIPTION: Translate a Space ID into a name string (Debug only)
174 ******************************************************************************/
176 /* Region type decoding */
178 const char *AcpiGbl_RegionTypes
[ACPI_NUM_PREDEFINED_REGIONS
] =
180 "SystemMemory", /* 0x00 */
181 "SystemIO", /* 0x01 */
182 "PCI_Config", /* 0x02 */
183 "EmbeddedControl", /* 0x03 */
185 "SystemCMOS", /* 0x05 */
186 "PCIBARTarget", /* 0x06 */
188 "GeneralPurposeIo", /* 0x08 */
189 "GenericSerialBus", /* 0x09 */
195 AcpiUtGetRegionName (
199 if (SpaceId
>= ACPI_USER_REGION_BEGIN
)
201 return ("UserDefinedRegion");
203 else if (SpaceId
== ACPI_ADR_SPACE_DATA_TABLE
)
205 return ("DataTable");
207 else if (SpaceId
== ACPI_ADR_SPACE_FIXED_HARDWARE
)
209 return ("FunctionalFixedHW");
211 else if (SpaceId
>= ACPI_NUM_PREDEFINED_REGIONS
)
213 return ("InvalidSpaceId");
216 return (AcpiGbl_RegionTypes
[SpaceId
]);
220 /*******************************************************************************
222 * FUNCTION: AcpiUtGetEventName
224 * PARAMETERS: EventId - Fixed event ID
226 * RETURN: Decoded event ID name
228 * DESCRIPTION: Translate a Event ID into a name string (Debug only)
230 ******************************************************************************/
232 /* Event type decoding */
234 static const char *AcpiGbl_EventTypes
[ACPI_NUM_FIXED_EVENTS
] =
249 if (EventId
> ACPI_EVENT_MAX
)
251 return ("InvalidEventID");
254 return (AcpiGbl_EventTypes
[EventId
]);
258 /*******************************************************************************
260 * FUNCTION: AcpiUtGetTypeName
262 * PARAMETERS: Type - An ACPI object type
264 * RETURN: Decoded ACPI object type name
266 * DESCRIPTION: Translate a Type ID into a name string (Debug only)
268 ******************************************************************************/
271 * Elements of AcpiGbl_NsTypeNames below must match
272 * one-to-one with values of ACPI_OBJECT_TYPE
274 * The type ACPI_TYPE_ANY (Untyped) is used as a "don't care" when searching;
275 * when stored in a table it really means that we have thus far seen no
276 * evidence to indicate what type is actually going to be stored for this
279 static const char AcpiGbl_BadType
[] = "UNDEFINED";
281 /* Printable names of the ACPI object types */
283 static const char *AcpiGbl_NsTypeNames
[] =
290 /* 05 */ "FieldUnit",
297 /* 12 */ "Processor",
299 /* 14 */ "BufferField",
300 /* 15 */ "DdbHandle",
301 /* 16 */ "DebugObject",
302 /* 17 */ "RegionField",
303 /* 18 */ "BankField",
304 /* 19 */ "IndexField",
305 /* 20 */ "Reference",
307 /* 22 */ "MethodAlias",
309 /* 24 */ "AddrHandler",
310 /* 25 */ "ResourceDesc",
311 /* 26 */ "ResourceFld",
321 ACPI_OBJECT_TYPE Type
)
324 if (Type
> ACPI_TYPE_INVALID
)
326 return (AcpiGbl_BadType
);
329 return (AcpiGbl_NsTypeNames
[Type
]);
334 AcpiUtGetObjectTypeName (
335 ACPI_OPERAND_OBJECT
*ObjDesc
)
337 ACPI_FUNCTION_TRACE (UtGetObjectTypeName
);
342 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC
, "Null Object Descriptor\n"));
343 return_PTR ("[NULL Object Descriptor]");
346 /* These descriptor types share a common area */
348 if ((ACPI_GET_DESCRIPTOR_TYPE (ObjDesc
) != ACPI_DESC_TYPE_OPERAND
) &&
349 (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc
) != ACPI_DESC_TYPE_NAMED
))
351 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC
,
352 "Invalid object descriptor type: 0x%2.2X [%s] (%p)\n",
353 ACPI_GET_DESCRIPTOR_TYPE (ObjDesc
),
354 AcpiUtGetDescriptorName (ObjDesc
), ObjDesc
));
356 return_PTR ("Invalid object");
359 return_PTR (AcpiUtGetTypeName (ObjDesc
->Common
.Type
));
363 /*******************************************************************************
365 * FUNCTION: AcpiUtGetNodeName
367 * PARAMETERS: Object - A namespace node
369 * RETURN: ASCII name of the node
371 * DESCRIPTION: Validate the node and return the node's ACPI name.
373 ******************************************************************************/
379 ACPI_NAMESPACE_NODE
*Node
= (ACPI_NAMESPACE_NODE
*) Object
;
382 /* Must return a string of exactly 4 characters == ACPI_NAME_SIZE */
389 /* Check for Root node */
391 if ((Object
== ACPI_ROOT_OBJECT
) ||
392 (Object
== AcpiGbl_RootNode
))
397 /* Descriptor must be a namespace node */
399 if (ACPI_GET_DESCRIPTOR_TYPE (Node
) != ACPI_DESC_TYPE_NAMED
)
405 * Ensure name is valid. The name was validated/repaired when the node
406 * was created, but make sure it has not been corrupted.
408 AcpiUtRepairName (Node
->Name
.Ascii
);
410 /* Return the name */
412 return (Node
->Name
.Ascii
);
416 /*******************************************************************************
418 * FUNCTION: AcpiUtGetDescriptorName
420 * PARAMETERS: Object - An ACPI object
422 * RETURN: Decoded name of the descriptor type
424 * DESCRIPTION: Validate object and return the descriptor type
426 ******************************************************************************/
428 /* Printable names of object descriptor types */
430 static const char *AcpiGbl_DescTypeNames
[] =
432 /* 00 */ "Not a Descriptor",
434 /* 02 */ "State-Generic",
435 /* 03 */ "State-Update",
436 /* 04 */ "State-Package",
437 /* 05 */ "State-Control",
438 /* 06 */ "State-RootParseScope",
439 /* 07 */ "State-ParseScope",
440 /* 08 */ "State-WalkScope",
441 /* 09 */ "State-Result",
442 /* 10 */ "State-Notify",
443 /* 11 */ "State-Thread",
452 AcpiUtGetDescriptorName (
458 return ("NULL OBJECT");
461 if (ACPI_GET_DESCRIPTOR_TYPE (Object
) > ACPI_DESC_TYPE_MAX
)
463 return ("Not a Descriptor");
466 return (AcpiGbl_DescTypeNames
[ACPI_GET_DESCRIPTOR_TYPE (Object
)]);
470 /*******************************************************************************
472 * FUNCTION: AcpiUtGetReferenceName
474 * PARAMETERS: Object - An ACPI reference object
476 * RETURN: Decoded name of the type of reference
478 * DESCRIPTION: Decode a reference object sub-type to a string.
480 ******************************************************************************/
482 /* Printable names of reference object sub-types */
484 static const char *AcpiGbl_RefClassNames
[] =
490 /* 04 */ "DdbHandle",
491 /* 05 */ "Named Object",
496 AcpiUtGetReferenceName (
497 ACPI_OPERAND_OBJECT
*Object
)
502 return ("NULL Object");
505 if (ACPI_GET_DESCRIPTOR_TYPE (Object
) != ACPI_DESC_TYPE_OPERAND
)
507 return ("Not an Operand object");
510 if (Object
->Common
.Type
!= ACPI_TYPE_LOCAL_REFERENCE
)
512 return ("Not a Reference object");
515 if (Object
->Reference
.Class
> ACPI_REFCLASS_MAX
)
517 return ("Unknown Reference class");
520 return (AcpiGbl_RefClassNames
[Object
->Reference
.Class
]);
524 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
526 * Strings and procedures used for debug only
529 /*******************************************************************************
531 * FUNCTION: AcpiUtGetMutexName
533 * PARAMETERS: MutexId - The predefined ID for this mutex.
535 * RETURN: Decoded name of the internal mutex
537 * DESCRIPTION: Translate a mutex ID into a name string (Debug only)
539 ******************************************************************************/
541 /* Names for internal mutex objects, used for debug output */
543 static const char *AcpiGbl_MutexNames
[ACPI_NUM_MUTEX
] =
545 "ACPI_MTX_Interpreter",
546 "ACPI_MTX_Namespace",
558 if (MutexId
> ACPI_MAX_MUTEX
)
560 return ("Invalid Mutex ID");
563 return (AcpiGbl_MutexNames
[MutexId
]);
567 /*******************************************************************************
569 * FUNCTION: AcpiUtGetNotifyName
571 * PARAMETERS: NotifyValue - Value from the Notify() request
573 * RETURN: Decoded name for the notify value
575 * DESCRIPTION: Translate a Notify Value to a notify namestring.
577 ******************************************************************************/
579 /* Names for Notify() values, used for debug output */
581 static const char *AcpiGbl_GenericNotify
[ACPI_NOTIFY_MAX
+ 1] =
583 /* 00 */ "Bus Check",
584 /* 01 */ "Device Check",
585 /* 02 */ "Device Wake",
586 /* 03 */ "Eject Request",
587 /* 04 */ "Device Check Light",
588 /* 05 */ "Frequency Mismatch",
589 /* 06 */ "Bus Mode Mismatch",
590 /* 07 */ "Power Fault",
591 /* 08 */ "Capabilities Check",
592 /* 09 */ "Device PLD Check",
594 /* 0B */ "System Locality Update",
595 /* 0C */ "Shutdown Request",
596 /* 0D */ "System Resource Affinity Update"
599 static const char *AcpiGbl_DeviceNotify
[4] =
601 /* 80 */ "Status Change",
602 /* 81 */ "Information Change",
603 /* 82 */ "Device-Specific Change",
604 /* 83 */ "Device-Specific Change"
607 static const char *AcpiGbl_ProcessorNotify
[4] =
609 /* 80 */ "Performance Capability Change",
610 /* 81 */ "C-State Change",
611 /* 82 */ "Throttling Capability Change",
612 /* 83 */ "Device-Specific Change"
615 static const char *AcpiGbl_ThermalNotify
[4] =
617 /* 80 */ "Thermal Status Change",
618 /* 81 */ "Thermal Trip Point Change",
619 /* 82 */ "Thermal Device List Change",
620 /* 83 */ "Thermal Relationship Change"
625 AcpiUtGetNotifyName (
627 ACPI_OBJECT_TYPE Type
)
630 /* 00 - 0D are common to all object types */
632 if (NotifyValue
<= ACPI_NOTIFY_MAX
)
634 return (AcpiGbl_GenericNotify
[NotifyValue
]);
637 /* 0D - 7F are reserved */
639 if (NotifyValue
<= ACPI_MAX_SYS_NOTIFY
)
644 /* 80 - 83 are per-object-type */
646 if (NotifyValue
<= 0x83)
651 case ACPI_TYPE_DEVICE
:
652 return (AcpiGbl_DeviceNotify
[NotifyValue
- 0x80]);
654 case ACPI_TYPE_PROCESSOR
:
655 return (AcpiGbl_ProcessorNotify
[NotifyValue
- 0x80]);
657 case ACPI_TYPE_THERMAL
:
658 return (AcpiGbl_ThermalNotify
[NotifyValue
- 0x80]);
661 return ("Target object type does not support notifies");
665 /* 84 - BF are device-specific */
667 if (NotifyValue
<= ACPI_MAX_DEVICE_SPECIFIC_NOTIFY
)
669 return ("Device-Specific");
672 /* C0 and above are hardware-specific */
674 return ("Hardware-Specific");
679 /*******************************************************************************
681 * FUNCTION: AcpiUtValidObjectType
683 * PARAMETERS: Type - Object type to be validated
685 * RETURN: TRUE if valid object type, FALSE otherwise
687 * DESCRIPTION: Validate an object type
689 ******************************************************************************/
692 AcpiUtValidObjectType (
693 ACPI_OBJECT_TYPE Type
)
696 if (Type
> ACPI_TYPE_LOCAL_MAX
)
698 /* Note: Assumes all TYPEs are contiguous (external/local) */