1 /*******************************************************************************
3 * Module Name: rsdump - AML debugger support for resource structures.
5 ******************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2018, 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 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
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.
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.
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.
150 *****************************************************************************/
152 #include <contrib/dev/acpica/include/acpi.h>
153 #include <contrib/dev/acpica/include/accommon.h>
154 #include <contrib/dev/acpica/include/acresrc.h>
156 #define _COMPONENT ACPI_RESOURCES
157 ACPI_MODULE_NAME ("rsdump")
160 * All functions in this module are used by the AML Debugger only
163 /* Local prototypes */
205 AcpiRsDumpDwordList (
210 AcpiRsDumpShortByteList (
215 AcpiRsDumpResourceSource (
216 ACPI_RESOURCE_SOURCE *ResourceSource);
219 AcpiRsDumpResourceLabel (
221 ACPI_RESOURCE_LABEL *ResourceLabel);
224 AcpiRsDumpAddressCommon (
225 ACPI_RESOURCE_DATA *Resource);
228 AcpiRsDumpDescriptor (
230 ACPI_RSDUMP_INFO *Table);
233 /*******************************************************************************
235 * FUNCTION: AcpiRsDumpResourceList
237 * PARAMETERS: ResourceList - Pointer to a resource descriptor list
241 * DESCRIPTION: Dispatches the structure to the correct dump routine.
243 ******************************************************************************/
246 AcpiRsDumpResourceList (
247 ACPI_RESOURCE *ResourceList)
253 ACPI_FUNCTION_ENTRY ();
256 /* Check if debug output enabled */
258 if (!ACPI_IS_DEBUG_ENABLED (ACPI_LV_RESOURCES, _COMPONENT))
263 /* Walk list and dump all resource descriptors (END_TAG terminates) */
267 AcpiOsPrintf ("\n[%02X] ", Count);
270 /* Validate Type before dispatch */
272 Type = ResourceList->Type;
273 if (Type > ACPI_RESOURCE_TYPE_MAX)
276 "Invalid descriptor type (%X) in resource list\n",
281 /* Sanity check the length. It must not be zero, or we loop forever */
283 if (!ResourceList->Length)
286 "Invalid zero length descriptor in resource list\n");
290 /* Dump the resource descriptor */
292 if (Type == ACPI_RESOURCE_TYPE_SERIAL_BUS)
294 AcpiRsDumpDescriptor (&ResourceList->Data,
295 AcpiGbl_DumpSerialBusDispatch[
296 ResourceList->Data.CommonSerialBus.Type]);
300 AcpiRsDumpDescriptor (&ResourceList->Data,
301 AcpiGbl_DumpResourceDispatch[Type]);
304 /* Point to the next resource structure */
306 ResourceList = ACPI_NEXT_RESOURCE (ResourceList);
308 /* Exit when END_TAG descriptor is reached */
310 } while (Type != ACPI_RESOURCE_TYPE_END_TAG);
314 /*******************************************************************************
316 * FUNCTION: AcpiRsDumpIrqList
318 * PARAMETERS: RouteTable - Pointer to the routing table to dump.
322 * DESCRIPTION: Print IRQ routing table
324 ******************************************************************************/
330 ACPI_PCI_ROUTING_TABLE *PrtElement;
334 ACPI_FUNCTION_ENTRY ();
337 /* Check if debug output enabled */
339 if (!ACPI_IS_DEBUG_ENABLED (ACPI_LV_RESOURCES, _COMPONENT))
344 PrtElement = ACPI_CAST_PTR (ACPI_PCI_ROUTING_TABLE, RouteTable);
346 /* Dump all table elements, Exit on zero length element */
348 for (Count = 0; PrtElement->Length; Count++)
350 AcpiOsPrintf ("\n[%02X] PCI IRQ Routing Table Package\n", Count);
351 AcpiRsDumpDescriptor (PrtElement, AcpiRsDumpPrt);
353 PrtElement = ACPI_ADD_PTR (ACPI_PCI_ROUTING_TABLE,
354 PrtElement, PrtElement->Length);
359 /*******************************************************************************
361 * FUNCTION: AcpiRsDumpDescriptor
363 * PARAMETERS: Resource - Buffer containing the resource
364 * Table - Table entry to decode the resource
368 * DESCRIPTION: Dump a resource descriptor based on a dump table entry.
370 ******************************************************************************/
373 AcpiRsDumpDescriptor (
375 ACPI_RSDUMP_INFO *Table)
377 UINT8 *Target = NULL;
378 UINT8 *PreviousTarget;
383 /* First table entry must contain the table length (# of table entries) */
385 Count = Table->Offset;
389 PreviousTarget = Target;
390 Target = ACPI_ADD_PTR (UINT8, Resource, Table->Offset);
393 switch (Table->Opcode)
397 * Optional resource title
401 AcpiOsPrintf ("%s Resource\n", Name);
407 case ACPI_RSD_LITERAL:
409 AcpiRsOutString (Name, ACPI_CAST_PTR (char, Table->Pointer));
412 case ACPI_RSD_STRING:
414 AcpiRsOutString (Name, ACPI_CAST_PTR (char, Target));
417 /* Data items, 8/16/32/64 bit */
423 AcpiRsOutString (Name, Table->Pointer [*Target]);
427 AcpiRsOutInteger8 (Name, ACPI_GET8 (Target));
431 case ACPI_RSD_UINT16:
433 AcpiRsOutInteger16 (Name, ACPI_GET16 (Target));
436 case ACPI_RSD_UINT32:
438 AcpiRsOutInteger32 (Name, ACPI_GET32 (Target));
441 case ACPI_RSD_UINT64:
443 AcpiRsOutInteger64 (Name, ACPI_GET64 (Target));
446 /* Flags: 1-bit and 2-bit flags supported */
448 case ACPI_RSD_1BITFLAG:
450 AcpiRsOutString (Name, Table->Pointer [*Target & 0x01]);
453 case ACPI_RSD_2BITFLAG:
455 AcpiRsOutString (Name, Table->Pointer [*Target & 0x03]);
458 case ACPI_RSD_3BITFLAG:
460 AcpiRsOutString (Name, Table->Pointer [*Target & 0x07]);
463 case ACPI_RSD_SHORTLIST:
465 * Short byte list (single line output) for DMA and IRQ resources
466 * Note: The list length is obtained from the previous table entry
470 AcpiRsOutTitle (Name);
471 AcpiRsDumpShortByteList (*PreviousTarget, Target);
475 case ACPI_RSD_SHORTLISTX:
477 * Short byte list (single line output) for GPIO vendor data
478 * Note: The list length is obtained from the previous table entry
482 AcpiRsOutTitle (Name);
483 AcpiRsDumpShortByteList (*PreviousTarget,
484 *(ACPI_CAST_INDIRECT_PTR (UINT8, Target)));
488 case ACPI_RSD_LONGLIST:
490 * Long byte list for Vendor resource data
491 * Note: The list length is obtained from the previous table entry
495 AcpiRsDumpByteList (ACPI_GET16 (PreviousTarget), Target);
499 case ACPI_RSD_DWORDLIST:
501 * Dword list for Extended Interrupt resources
502 * Note: The list length is obtained from the previous table entry
506 AcpiRsDumpDwordList (*PreviousTarget,
507 ACPI_CAST_PTR (UINT32, Target));
511 case ACPI_RSD_WORDLIST:
513 * Word list for GPIO Pin Table
514 * Note: The list length is obtained from the previous table entry
518 AcpiRsDumpWordList (*PreviousTarget,
519 *(ACPI_CAST_INDIRECT_PTR (UINT16, Target)));
523 case ACPI_RSD_ADDRESS:
525 * Common flags for all Address resources
527 AcpiRsDumpAddressCommon (ACPI_CAST_PTR (
528 ACPI_RESOURCE_DATA, Target));
531 case ACPI_RSD_SOURCE:
533 * Optional ResourceSource for Address resources
535 AcpiRsDumpResourceSource (ACPI_CAST_PTR (
536 ACPI_RESOURCE_SOURCE, Target));
543 AcpiRsDumpResourceLabel ("Resource Label", ACPI_CAST_PTR (
544 ACPI_RESOURCE_LABEL, Target));
547 case ACPI_RSD_SOURCE_LABEL:
549 * ResourceSourceLabel
551 AcpiRsDumpResourceLabel ("Resource Source Label", ACPI_CAST_PTR (
552 ACPI_RESOURCE_LABEL, Target));
557 AcpiOsPrintf ("**** Invalid table opcode [%X] ****\n",
568 /*******************************************************************************
570 * FUNCTION: AcpiRsDumpResourceSource
572 * PARAMETERS: ResourceSource - Pointer to a Resource Source struct
576 * DESCRIPTION: Common routine for dumping the optional ResourceSource and the
577 * corresponding ResourceSourceIndex.
579 ******************************************************************************/
582 AcpiRsDumpResourceSource (
583 ACPI_RESOURCE_SOURCE *ResourceSource)
585 ACPI_FUNCTION_ENTRY ();
588 if (ResourceSource->Index == 0xFF)
593 AcpiRsOutInteger8 ("Resource Source Index",
594 ResourceSource->Index);
596 AcpiRsOutString ("Resource Source",
597 ResourceSource->StringPtr ?
598 ResourceSource->StringPtr : "[Not Specified]");
602 /*******************************************************************************
604 * FUNCTION: AcpiRsDumpResourceLabel
606 * PARAMETERS: Title - Title of the dumped resource field
607 * ResourceLabel - Pointer to a Resource Label struct
611 * DESCRIPTION: Common routine for dumping the ResourceLabel
613 ******************************************************************************/
616 AcpiRsDumpResourceLabel (
618 ACPI_RESOURCE_LABEL *ResourceLabel)
620 ACPI_FUNCTION_ENTRY ();
622 AcpiRsOutString (Title,
623 ResourceLabel->StringPtr ?
624 ResourceLabel->StringPtr : "[Not Specified]");
628 /*******************************************************************************
630 * FUNCTION: AcpiRsDumpAddressCommon
632 * PARAMETERS: Resource - Pointer to an internal resource descriptor
636 * DESCRIPTION: Dump the fields that are common to all Address resource
639 ******************************************************************************/
642 AcpiRsDumpAddressCommon (
643 ACPI_RESOURCE_DATA *Resource)
645 ACPI_FUNCTION_ENTRY ();
648 /* Decode the type-specific flags */
650 switch (Resource->Address.ResourceType)
652 case ACPI_MEMORY_RANGE:
654 AcpiRsDumpDescriptor (Resource, AcpiRsDumpMemoryFlags);
659 AcpiRsDumpDescriptor (Resource, AcpiRsDumpIoFlags);
662 case ACPI_BUS_NUMBER_RANGE:
664 AcpiRsOutString ("Resource Type", "Bus Number Range");
669 AcpiRsOutInteger8 ("Resource Type",
670 (UINT8) Resource->Address.ResourceType);
674 /* Decode the general flags */
676 AcpiRsDumpDescriptor (Resource, AcpiRsDumpGeneralFlags);
680 /*******************************************************************************
682 * FUNCTION: AcpiRsOut*
684 * PARAMETERS: Title - Name of the resource field
685 * Value - Value of the resource field
689 * DESCRIPTION: Miscellaneous helper functions to consistently format the
690 * output of the resource dump routines
692 ******************************************************************************/
700 AcpiOsPrintf ("%27s : %s", Title, Value);
703 AcpiOsPrintf ("[NULL NAMESTRING]");
713 AcpiOsPrintf ("%27s : %2.2X\n", Title, Value);
722 AcpiOsPrintf ("%27s : %4.4X\n", Title, Value);
731 AcpiOsPrintf ("%27s : %8.8X\n", Title, Value);
740 AcpiOsPrintf ("%27s : %8.8X%8.8X\n", Title,
741 ACPI_FORMAT_UINT64 (Value));
749 AcpiOsPrintf ("%27s : ", Title);
753 /*******************************************************************************
755 * FUNCTION: AcpiRsDump*List
757 * PARAMETERS: Length - Number of elements in the list
758 * Data - Start of the list
762 * DESCRIPTION: Miscellaneous functions to dump lists of raw data
764 ******************************************************************************/
774 for (i = 0; i < Length; i++)
776 AcpiOsPrintf ("%25s%2.2X : %2.2X\n", "Byte", i, Data[i]);
781 AcpiRsDumpShortByteList (
788 for (i = 0; i < Length; i++)
790 AcpiOsPrintf ("%X ", Data[i]);
797 AcpiRsDumpDwordList (
804 for (i = 0; i < Length; i++)
806 AcpiOsPrintf ("%25s%2.2X : %8.8X\n", "Dword", i, Data[i]);
818 for (i = 0; i < Length; i++)
820 AcpiOsPrintf ("%25s%2.2X : %4.4X\n", "Word", i, Data[i]);