xref: /freebsd/sys/contrib/dev/acpica/components/utilities/utdecode.c (revision f5147e312f43a9050468de539aeafa072caa1a60)
1 /******************************************************************************
2  *
3  * Module Name: utdecode - Utility decoding routines (value-to-string)
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
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
19  * property rights.
20  *
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
27  *
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;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
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.
53  *
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
64  * make.
65  *
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
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
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.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
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
88  * PARTICULAR PURPOSE.
89  *
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
97  * LIMITED REMEDY.
98  *
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.
113  *
114  *****************************************************************************
115  *
116  * Alternatively, you may choose to be licensed under the terms of the
117  * following license:
118  *
119  * Redistribution and use in source and binary forms, with or without
120  * modification, are permitted provided that the following conditions
121  * are met:
122  * 1. Redistributions of source code must retain the above copyright
123  *    notice, this list of conditions, and the following disclaimer,
124  *    without modification.
125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126  *    substantially similar to the "NO WARRANTY" disclaimer below
127  *    ("Disclaimer") and any redistribution must be conditioned upon
128  *    including a substantially similar Disclaimer requirement for further
129  *    binary redistribution.
130  * 3. Neither the names of the above-listed copyright holders nor the names
131  *    of any contributors may be used to endorse or promote products derived
132  *    from this software without specific prior written permission.
133  *
134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145  *
146  * Alternatively, you may choose to be licensed under the terms of the
147  * GNU General Public License ("GPL") version 2 as published by the Free
148  * Software Foundation.
149  *
150  *****************************************************************************/
151 
152 #include <contrib/dev/acpica/include/acpi.h>
153 #include <contrib/dev/acpica/include/accommon.h>
154 #include <contrib/dev/acpica/include/acnamesp.h>
155 #include <contrib/dev/acpica/include/amlcode.h>
156 
157 #define _COMPONENT          ACPI_UTILITIES
158         ACPI_MODULE_NAME    ("utdecode")
159 
160 
161 /*
162  * Properties of the ACPI Object Types, both internal and external.
163  * The table is indexed by values of ACPI_OBJECT_TYPE
164  */
165 const UINT8                     AcpiGbl_NsProperties[ACPI_NUM_NS_TYPES] =
166 {
167     ACPI_NS_NORMAL,                     /* 00 Any              */
168     ACPI_NS_NORMAL,                     /* 01 Number           */
169     ACPI_NS_NORMAL,                     /* 02 String           */
170     ACPI_NS_NORMAL,                     /* 03 Buffer           */
171     ACPI_NS_NORMAL,                     /* 04 Package          */
172     ACPI_NS_NORMAL,                     /* 05 FieldUnit        */
173     ACPI_NS_NEWSCOPE,                   /* 06 Device           */
174     ACPI_NS_NORMAL,                     /* 07 Event            */
175     ACPI_NS_NEWSCOPE,                   /* 08 Method           */
176     ACPI_NS_NORMAL,                     /* 09 Mutex            */
177     ACPI_NS_NORMAL,                     /* 10 Region           */
178     ACPI_NS_NEWSCOPE,                   /* 11 Power            */
179     ACPI_NS_NEWSCOPE,                   /* 12 Processor        */
180     ACPI_NS_NEWSCOPE,                   /* 13 Thermal          */
181     ACPI_NS_NORMAL,                     /* 14 BufferField      */
182     ACPI_NS_NORMAL,                     /* 15 DdbHandle        */
183     ACPI_NS_NORMAL,                     /* 16 Debug Object     */
184     ACPI_NS_NORMAL,                     /* 17 DefField         */
185     ACPI_NS_NORMAL,                     /* 18 BankField        */
186     ACPI_NS_NORMAL,                     /* 19 IndexField       */
187     ACPI_NS_NORMAL,                     /* 20 Reference        */
188     ACPI_NS_NORMAL,                     /* 21 Alias            */
189     ACPI_NS_NORMAL,                     /* 22 MethodAlias      */
190     ACPI_NS_NORMAL,                     /* 23 Notify           */
191     ACPI_NS_NORMAL,                     /* 24 Address Handler  */
192     ACPI_NS_NEWSCOPE | ACPI_NS_LOCAL,   /* 25 Resource Desc    */
193     ACPI_NS_NEWSCOPE | ACPI_NS_LOCAL,   /* 26 Resource Field   */
194     ACPI_NS_NEWSCOPE,                   /* 27 Scope            */
195     ACPI_NS_NORMAL,                     /* 28 Extra            */
196     ACPI_NS_NORMAL,                     /* 29 Data             */
197     ACPI_NS_NORMAL                      /* 30 Invalid          */
198 };
199 
200 
201 /*******************************************************************************
202  *
203  * FUNCTION:    AcpiUtGetRegionName
204  *
205  * PARAMETERS:  Space ID            - ID for the region
206  *
207  * RETURN:      Decoded region SpaceId name
208  *
209  * DESCRIPTION: Translate a Space ID into a name string (Debug only)
210  *
211  ******************************************************************************/
212 
213 /* Region type decoding */
214 
215 const char        *AcpiGbl_RegionTypes[ACPI_NUM_PREDEFINED_REGIONS] =
216 {
217     "SystemMemory",     /* 0x00 */
218     "SystemIO",         /* 0x01 */
219     "PCI_Config",       /* 0x02 */
220     "EmbeddedControl",  /* 0x03 */
221     "SMBus",            /* 0x04 */
222     "SystemCMOS",       /* 0x05 */
223     "PCIBARTarget",     /* 0x06 */
224     "IPMI",             /* 0x07 */
225     "GeneralPurposeIo", /* 0x08 */
226     "GenericSerialBus", /* 0x09 */
227     "PCC"               /* 0x0A */
228 };
229 
230 
231 const char *
232 AcpiUtGetRegionName (
233     UINT8                   SpaceId)
234 {
235 
236     if (SpaceId >= ACPI_USER_REGION_BEGIN)
237     {
238         return ("UserDefinedRegion");
239     }
240     else if (SpaceId == ACPI_ADR_SPACE_DATA_TABLE)
241     {
242         return ("DataTable");
243     }
244     else if (SpaceId == ACPI_ADR_SPACE_FIXED_HARDWARE)
245     {
246         return ("FunctionalFixedHW");
247     }
248     else if (SpaceId >= ACPI_NUM_PREDEFINED_REGIONS)
249     {
250         return ("InvalidSpaceId");
251     }
252 
253     return (AcpiGbl_RegionTypes[SpaceId]);
254 }
255 
256 
257 /*******************************************************************************
258  *
259  * FUNCTION:    AcpiUtGetEventName
260  *
261  * PARAMETERS:  EventId             - Fixed event ID
262  *
263  * RETURN:      Decoded event ID name
264  *
265  * DESCRIPTION: Translate a Event ID into a name string (Debug only)
266  *
267  ******************************************************************************/
268 
269 /* Event type decoding */
270 
271 static const char        *AcpiGbl_EventTypes[ACPI_NUM_FIXED_EVENTS] =
272 {
273     "PM_Timer",
274     "GlobalLock",
275     "PowerButton",
276     "SleepButton",
277     "RealTimeClock",
278 };
279 
280 
281 const char *
282 AcpiUtGetEventName (
283     UINT32                  EventId)
284 {
285 
286     if (EventId > ACPI_EVENT_MAX)
287     {
288         return ("InvalidEventID");
289     }
290 
291     return (AcpiGbl_EventTypes[EventId]);
292 }
293 
294 
295 /*******************************************************************************
296  *
297  * FUNCTION:    AcpiUtGetTypeName
298  *
299  * PARAMETERS:  Type                - An ACPI object type
300  *
301  * RETURN:      Decoded ACPI object type name
302  *
303  * DESCRIPTION: Translate a Type ID into a name string (Debug only)
304  *
305  ******************************************************************************/
306 
307 /*
308  * Elements of AcpiGbl_NsTypeNames below must match
309  * one-to-one with values of ACPI_OBJECT_TYPE
310  *
311  * The type ACPI_TYPE_ANY (Untyped) is used as a "don't care" when searching;
312  * when stored in a table it really means that we have thus far seen no
313  * evidence to indicate what type is actually going to be stored for this
314  & entry.
315  */
316 static const char           AcpiGbl_BadType[] = "UNDEFINED";
317 
318 /* Printable names of the ACPI object types */
319 
320 static const char           *AcpiGbl_NsTypeNames[] =
321 {
322     /* 00 */ "Untyped",
323     /* 01 */ "Integer",
324     /* 02 */ "String",
325     /* 03 */ "Buffer",
326     /* 04 */ "Package",
327     /* 05 */ "FieldUnit",
328     /* 06 */ "Device",
329     /* 07 */ "Event",
330     /* 08 */ "Method",
331     /* 09 */ "Mutex",
332     /* 10 */ "Region",
333     /* 11 */ "Power",
334     /* 12 */ "Processor",
335     /* 13 */ "Thermal",
336     /* 14 */ "BufferField",
337     /* 15 */ "DdbHandle",
338     /* 16 */ "DebugObject",
339     /* 17 */ "RegionField",
340     /* 18 */ "BankField",
341     /* 19 */ "IndexField",
342     /* 20 */ "Reference",
343     /* 21 */ "Alias",
344     /* 22 */ "MethodAlias",
345     /* 23 */ "Notify",
346     /* 24 */ "AddrHandler",
347     /* 25 */ "ResourceDesc",
348     /* 26 */ "ResourceFld",
349     /* 27 */ "Scope",
350     /* 28 */ "Extra",
351     /* 29 */ "Data",
352     /* 30 */ "Invalid"
353 };
354 
355 
356 const char *
357 AcpiUtGetTypeName (
358     ACPI_OBJECT_TYPE        Type)
359 {
360 
361     if (Type > ACPI_TYPE_INVALID)
362     {
363         return (AcpiGbl_BadType);
364     }
365 
366     return (AcpiGbl_NsTypeNames[Type]);
367 }
368 
369 
370 const char *
371 AcpiUtGetObjectTypeName (
372     ACPI_OPERAND_OBJECT     *ObjDesc)
373 {
374     ACPI_FUNCTION_TRACE (UtGetObjectTypeName);
375 
376 
377     if (!ObjDesc)
378     {
379         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Null Object Descriptor\n"));
380         return_STR ("[NULL Object Descriptor]");
381     }
382 
383     /* These descriptor types share a common area */
384 
385     if ((ACPI_GET_DESCRIPTOR_TYPE (ObjDesc) != ACPI_DESC_TYPE_OPERAND) &&
386         (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc) != ACPI_DESC_TYPE_NAMED))
387     {
388         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
389             "Invalid object descriptor type: 0x%2.2X [%s] (%p)\n",
390             ACPI_GET_DESCRIPTOR_TYPE (ObjDesc),
391             AcpiUtGetDescriptorName (ObjDesc), ObjDesc));
392 
393         return_STR ("Invalid object");
394     }
395 
396     return_STR (AcpiUtGetTypeName (ObjDesc->Common.Type));
397 }
398 
399 
400 /*******************************************************************************
401  *
402  * FUNCTION:    AcpiUtGetNodeName
403  *
404  * PARAMETERS:  Object               - A namespace node
405  *
406  * RETURN:      ASCII name of the node
407  *
408  * DESCRIPTION: Validate the node and return the node's ACPI name.
409  *
410  ******************************************************************************/
411 
412 const char *
413 AcpiUtGetNodeName (
414     void                    *Object)
415 {
416     ACPI_NAMESPACE_NODE     *Node = (ACPI_NAMESPACE_NODE *) Object;
417 
418 
419     /* Must return a string of exactly 4 characters == ACPI_NAME_SIZE */
420 
421     if (!Object)
422     {
423         return ("NULL");
424     }
425 
426     /* Check for Root node */
427 
428     if ((Object == ACPI_ROOT_OBJECT) ||
429         (Object == AcpiGbl_RootNode))
430     {
431         return ("\"\\\" ");
432     }
433 
434     /* Descriptor must be a namespace node */
435 
436     if (ACPI_GET_DESCRIPTOR_TYPE (Node) != ACPI_DESC_TYPE_NAMED)
437     {
438         return ("####");
439     }
440 
441     /*
442      * Ensure name is valid. The name was validated/repaired when the node
443      * was created, but make sure it has not been corrupted.
444      */
445     AcpiUtRepairName (Node->Name.Ascii);
446 
447     /* Return the name */
448 
449     return (Node->Name.Ascii);
450 }
451 
452 
453 /*******************************************************************************
454  *
455  * FUNCTION:    AcpiUtGetDescriptorName
456  *
457  * PARAMETERS:  Object               - An ACPI object
458  *
459  * RETURN:      Decoded name of the descriptor type
460  *
461  * DESCRIPTION: Validate object and return the descriptor type
462  *
463  ******************************************************************************/
464 
465 /* Printable names of object descriptor types */
466 
467 static const char           *AcpiGbl_DescTypeNames[] =
468 {
469     /* 00 */ "Not a Descriptor",
470     /* 01 */ "Cached",
471     /* 02 */ "State-Generic",
472     /* 03 */ "State-Update",
473     /* 04 */ "State-Package",
474     /* 05 */ "State-Control",
475     /* 06 */ "State-RootParseScope",
476     /* 07 */ "State-ParseScope",
477     /* 08 */ "State-WalkScope",
478     /* 09 */ "State-Result",
479     /* 10 */ "State-Notify",
480     /* 11 */ "State-Thread",
481     /* 12 */ "Walk",
482     /* 13 */ "Parser",
483     /* 14 */ "Operand",
484     /* 15 */ "Node"
485 };
486 
487 
488 const char *
489 AcpiUtGetDescriptorName (
490     void                    *Object)
491 {
492 
493     if (!Object)
494     {
495         return ("NULL OBJECT");
496     }
497 
498     if (ACPI_GET_DESCRIPTOR_TYPE (Object) > ACPI_DESC_TYPE_MAX)
499     {
500         return ("Not a Descriptor");
501     }
502 
503     return (AcpiGbl_DescTypeNames[ACPI_GET_DESCRIPTOR_TYPE (Object)]);
504 }
505 
506 
507 /*******************************************************************************
508  *
509  * FUNCTION:    AcpiUtGetReferenceName
510  *
511  * PARAMETERS:  Object               - An ACPI reference object
512  *
513  * RETURN:      Decoded name of the type of reference
514  *
515  * DESCRIPTION: Decode a reference object sub-type to a string.
516  *
517  ******************************************************************************/
518 
519 /* Printable names of reference object sub-types */
520 
521 static const char           *AcpiGbl_RefClassNames[] =
522 {
523     /* 00 */ "Local",
524     /* 01 */ "Argument",
525     /* 02 */ "RefOf",
526     /* 03 */ "Index",
527     /* 04 */ "DdbHandle",
528     /* 05 */ "Named Object",
529     /* 06 */ "Debug"
530 };
531 
532 const char *
533 AcpiUtGetReferenceName (
534     ACPI_OPERAND_OBJECT     *Object)
535 {
536 
537     if (!Object)
538     {
539         return ("NULL Object");
540     }
541 
542     if (ACPI_GET_DESCRIPTOR_TYPE (Object) != ACPI_DESC_TYPE_OPERAND)
543     {
544         return ("Not an Operand object");
545     }
546 
547     if (Object->Common.Type != ACPI_TYPE_LOCAL_REFERENCE)
548     {
549         return ("Not a Reference object");
550     }
551 
552     if (Object->Reference.Class > ACPI_REFCLASS_MAX)
553     {
554         return ("Unknown Reference class");
555     }
556 
557     return (AcpiGbl_RefClassNames[Object->Reference.Class]);
558 }
559 
560 
561 /*******************************************************************************
562  *
563  * FUNCTION:    AcpiUtGetMutexName
564  *
565  * PARAMETERS:  MutexId         - The predefined ID for this mutex.
566  *
567  * RETURN:      Decoded name of the internal mutex
568  *
569  * DESCRIPTION: Translate a mutex ID into a name string (Debug only)
570  *
571  ******************************************************************************/
572 
573 /* Names for internal mutex objects, used for debug output */
574 
575 static const char           *AcpiGbl_MutexNames[ACPI_NUM_MUTEX] =
576 {
577     "ACPI_MTX_Interpreter",
578     "ACPI_MTX_Namespace",
579     "ACPI_MTX_Tables",
580     "ACPI_MTX_Events",
581     "ACPI_MTX_Caches",
582     "ACPI_MTX_Memory",
583 };
584 
585 const char *
586 AcpiUtGetMutexName (
587     UINT32                  MutexId)
588 {
589 
590     if (MutexId > ACPI_MAX_MUTEX)
591     {
592         return ("Invalid Mutex ID");
593     }
594 
595     return (AcpiGbl_MutexNames[MutexId]);
596 }
597 
598 
599 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
600 
601 /*
602  * Strings and procedures used for debug only
603  */
604 
605 /*******************************************************************************
606  *
607  * FUNCTION:    AcpiUtGetNotifyName
608  *
609  * PARAMETERS:  NotifyValue     - Value from the Notify() request
610  *
611  * RETURN:      Decoded name for the notify value
612  *
613  * DESCRIPTION: Translate a Notify Value to a notify namestring.
614  *
615  ******************************************************************************/
616 
617 /* Names for Notify() values, used for debug output */
618 
619 static const char           *AcpiGbl_GenericNotify[ACPI_GENERIC_NOTIFY_MAX + 1] =
620 {
621     /* 00 */ "Bus Check",
622     /* 01 */ "Device Check",
623     /* 02 */ "Device Wake",
624     /* 03 */ "Eject Request",
625     /* 04 */ "Device Check Light",
626     /* 05 */ "Frequency Mismatch",
627     /* 06 */ "Bus Mode Mismatch",
628     /* 07 */ "Power Fault",
629     /* 08 */ "Capabilities Check",
630     /* 09 */ "Device PLD Check",
631     /* 0A */ "Reserved",
632     /* 0B */ "System Locality Update",
633     /* 0C */ "Reserved (was previously Shutdown Request)",  /* Reserved in ACPI 6.0 */
634     /* 0D */ "System Resource Affinity Update",
635     /* 0E */ "Heterogeneous Memory Attributes Update"       /* ACPI 6.2 */
636 };
637 
638 static const char           *AcpiGbl_DeviceNotify[5] =
639 {
640     /* 80 */ "Status Change",
641     /* 81 */ "Information Change",
642     /* 82 */ "Device-Specific Change",
643     /* 83 */ "Device-Specific Change",
644     /* 84 */ "Reserved"
645 };
646 
647 static const char           *AcpiGbl_ProcessorNotify[5] =
648 {
649     /* 80 */ "Performance Capability Change",
650     /* 81 */ "C-State Change",
651     /* 82 */ "Throttling Capability Change",
652     /* 83 */ "Guaranteed Change",
653     /* 84 */ "Minimum Excursion"
654 };
655 
656 static const char           *AcpiGbl_ThermalNotify[5] =
657 {
658     /* 80 */ "Thermal Status Change",
659     /* 81 */ "Thermal Trip Point Change",
660     /* 82 */ "Thermal Device List Change",
661     /* 83 */ "Thermal Relationship Change",
662     /* 84 */ "Reserved"
663 };
664 
665 
666 const char *
667 AcpiUtGetNotifyName (
668     UINT32                  NotifyValue,
669     ACPI_OBJECT_TYPE        Type)
670 {
671 
672     /* 00 - 0D are "common to all object types" (from ACPI Spec) */
673 
674     if (NotifyValue <= ACPI_GENERIC_NOTIFY_MAX)
675     {
676         return (AcpiGbl_GenericNotify[NotifyValue]);
677     }
678 
679     /* 0E - 7F are reserved */
680 
681     if (NotifyValue <= ACPI_MAX_SYS_NOTIFY)
682     {
683         return ("Reserved");
684     }
685 
686     /* 80 - 84 are per-object-type */
687 
688     if (NotifyValue <= ACPI_SPECIFIC_NOTIFY_MAX)
689     {
690         switch (Type)
691         {
692         case ACPI_TYPE_ANY:
693         case ACPI_TYPE_DEVICE:
694             return (AcpiGbl_DeviceNotify [NotifyValue - 0x80]);
695 
696         case ACPI_TYPE_PROCESSOR:
697             return (AcpiGbl_ProcessorNotify [NotifyValue - 0x80]);
698 
699         case ACPI_TYPE_THERMAL:
700             return (AcpiGbl_ThermalNotify [NotifyValue - 0x80]);
701 
702         default:
703             return ("Target object type does not support notifies");
704         }
705     }
706 
707     /* 84 - BF are device-specific */
708 
709     if (NotifyValue <= ACPI_MAX_DEVICE_SPECIFIC_NOTIFY)
710     {
711         return ("Device-Specific");
712     }
713 
714     /* C0 and above are hardware-specific */
715 
716     return ("Hardware-Specific");
717 }
718 
719 
720 /*******************************************************************************
721  *
722  * FUNCTION:    AcpiUtGetArgumentTypeName
723  *
724  * PARAMETERS:  ArgType             - an ARGP_* parser argument type
725  *
726  * RETURN:      Decoded ARGP_* type
727  *
728  * DESCRIPTION: Decode an ARGP_* parser type, as defined in the amlcode.h file,
729  *              and used in the acopcode.h file. For example, ARGP_TERMARG.
730  *              Used for debug only.
731  *
732  ******************************************************************************/
733 
734 static const char           *AcpiGbl_ArgumentType[20] =
735 {
736     /* 00 */ "Unknown ARGP",
737     /* 01 */ "ByteData",
738     /* 02 */ "ByteList",
739     /* 03 */ "CharList",
740     /* 04 */ "DataObject",
741     /* 05 */ "DataObjectList",
742     /* 06 */ "DWordData",
743     /* 07 */ "FieldList",
744     /* 08 */ "Name",
745     /* 09 */ "NameString",
746     /* 0A */ "ObjectList",
747     /* 0B */ "PackageLength",
748     /* 0C */ "SuperName",
749     /* 0D */ "Target",
750     /* 0E */ "TermArg",
751     /* 0F */ "TermList",
752     /* 10 */ "WordData",
753     /* 11 */ "QWordData",
754     /* 12 */ "SimpleName",
755     /* 13 */ "NameOrRef"
756 };
757 
758 const char *
759 AcpiUtGetArgumentTypeName (
760     UINT32                  ArgType)
761 {
762 
763     if (ArgType > ARGP_MAX)
764     {
765         return ("Unknown ARGP");
766     }
767 
768     return (AcpiGbl_ArgumentType[ArgType]);
769 }
770 
771 #endif
772 
773 
774 /*******************************************************************************
775  *
776  * FUNCTION:    AcpiUtValidObjectType
777  *
778  * PARAMETERS:  Type            - Object type to be validated
779  *
780  * RETURN:      TRUE if valid object type, FALSE otherwise
781  *
782  * DESCRIPTION: Validate an object type
783  *
784  ******************************************************************************/
785 
786 BOOLEAN
787 AcpiUtValidObjectType (
788     ACPI_OBJECT_TYPE        Type)
789 {
790 
791     if (Type > ACPI_TYPE_LOCAL_MAX)
792     {
793         /* Note: Assumes all TYPEs are contiguous (external/local) */
794 
795         return (FALSE);
796     }
797 
798     return (TRUE);
799 }
800