1 /*******************************************************************************
3 * Module Name: rsdump - AML debugger support for resource structures.
5 ******************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2021, 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 *****************************************************************************/
153 #include "accommon.h"
156 #define _COMPONENT ACPI_RESOURCES
157 ACPI_MODULE_NAME ("rsdump")
160 * All functions in this module are used by the AML Debugger only
162 #if defined(ACPI_DEBUGGER)
164 /* Local prototypes */
206 AcpiRsDumpDwordList (
211 AcpiRsDumpShortByteList (
216 AcpiRsDumpResourceSource (
217 ACPI_RESOURCE_SOURCE *ResourceSource);
220 AcpiRsDumpResourceLabel (
222 ACPI_RESOURCE_LABEL *ResourceLabel);
225 AcpiRsDumpAddressCommon (
226 ACPI_RESOURCE_DATA *Resource);
229 AcpiRsDumpDescriptor (
231 ACPI_RSDUMP_INFO *Table);
234 /*******************************************************************************
236 * FUNCTION: AcpiRsDumpResourceList
238 * PARAMETERS: ResourceList - Pointer to a resource descriptor list
242 * DESCRIPTION: Dispatches the structure to the correct dump routine.
244 ******************************************************************************/
247 AcpiRsDumpResourceList (
248 ACPI_RESOURCE *ResourceList)
254 ACPI_FUNCTION_ENTRY ();
257 /* Check if debug output enabled */
259 if (!ACPI_IS_DEBUG_ENABLED (ACPI_LV_RESOURCES, _COMPONENT))
264 /* Walk list and dump all resource descriptors (END_TAG terminates) */
268 AcpiOsPrintf ("\n[%02X] ", Count);
271 /* Validate Type before dispatch */
273 Type = ResourceList->Type;
274 if (Type > ACPI_RESOURCE_TYPE_MAX)
277 "Invalid descriptor type (%X) in resource list\n",
281 else if (!ResourceList->Type)
283 ACPI_ERROR ((AE_INFO, "Invalid Zero Resource Type"));
287 /* Sanity check the length. It must not be zero, or we loop forever */
289 if (!ResourceList->Length)
292 "Invalid zero length descriptor in resource list\n");
296 /* Dump the resource descriptor */
298 if (Type == ACPI_RESOURCE_TYPE_SERIAL_BUS)
300 AcpiRsDumpDescriptor (&ResourceList->Data,
301 AcpiGbl_DumpSerialBusDispatch[
302 ResourceList->Data.CommonSerialBus.Type]);
306 AcpiRsDumpDescriptor (&ResourceList->Data,
307 AcpiGbl_DumpResourceDispatch[Type]);
310 /* Point to the next resource structure */
312 ResourceList = ACPI_NEXT_RESOURCE (ResourceList);
314 /* Exit when END_TAG descriptor is reached */
316 } while (Type != ACPI_RESOURCE_TYPE_END_TAG);
320 /*******************************************************************************
322 * FUNCTION: AcpiRsDumpIrqList
324 * PARAMETERS: RouteTable - Pointer to the routing table to dump.
328 * DESCRIPTION: Print IRQ routing table
330 ******************************************************************************/
336 ACPI_PCI_ROUTING_TABLE *PrtElement;
340 ACPI_FUNCTION_ENTRY ();
343 /* Check if debug output enabled */
345 if (!ACPI_IS_DEBUG_ENABLED (ACPI_LV_RESOURCES, _COMPONENT))
350 PrtElement = ACPI_CAST_PTR (ACPI_PCI_ROUTING_TABLE, RouteTable);
352 /* Dump all table elements, Exit on zero length element */
354 for (Count = 0; PrtElement->Length; Count++)
356 AcpiOsPrintf ("\n[%02X] PCI IRQ Routing Table Package\n", Count);
357 AcpiRsDumpDescriptor (PrtElement, AcpiRsDumpPrt);
359 PrtElement = ACPI_ADD_PTR (ACPI_PCI_ROUTING_TABLE,
360 PrtElement, PrtElement->Length);
365 /*******************************************************************************
367 * FUNCTION: AcpiRsDumpDescriptor
369 * PARAMETERS: Resource - Buffer containing the resource
370 * Table - Table entry to decode the resource
374 * DESCRIPTION: Dump a resource descriptor based on a dump table entry.
376 ******************************************************************************/
379 AcpiRsDumpDescriptor (
381 ACPI_RSDUMP_INFO *Table)
383 UINT8 *Target = NULL;
384 UINT8 *PreviousTarget;
389 /* First table entry must contain the table length (# of table entries) */
391 Count = Table->Offset;
395 PreviousTarget = Target;
396 Target = ACPI_ADD_PTR (UINT8, Resource, Table->Offset);
399 switch (Table->Opcode)
403 * Optional resource title
407 AcpiOsPrintf ("%s Resource\n", Name);
413 case ACPI_RSD_LITERAL:
415 AcpiRsOutString (Name, ACPI_CAST_PTR (char, Table->Pointer));
418 case ACPI_RSD_STRING:
420 AcpiRsOutString (Name, ACPI_CAST_PTR (char, Target));
423 /* Data items, 8/16/32/64 bit */
429 AcpiRsOutString (Name, Table->Pointer [*Target]);
433 AcpiRsOutInteger8 (Name, ACPI_GET8 (Target));
437 case ACPI_RSD_UINT16:
439 AcpiRsOutInteger16 (Name, ACPI_GET16 (Target));
442 case ACPI_RSD_UINT32:
444 AcpiRsOutInteger32 (Name, ACPI_GET32 (Target));
447 case ACPI_RSD_UINT64:
449 AcpiRsOutInteger64 (Name, ACPI_GET64 (Target));
452 /* Flags: 1-bit and 2-bit flags supported */
454 case ACPI_RSD_1BITFLAG:
456 AcpiRsOutString (Name, Table->Pointer [*Target & 0x01]);
459 case ACPI_RSD_2BITFLAG:
461 AcpiRsOutString (Name, Table->Pointer [*Target & 0x03]);
464 case ACPI_RSD_3BITFLAG:
466 AcpiRsOutString (Name, Table->Pointer [*Target & 0x07]);
469 case ACPI_RSD_6BITFLAG:
471 AcpiRsOutInteger8 (Name, (ACPI_GET8 (Target) & 0x3F));
474 case ACPI_RSD_SHORTLIST:
476 * Short byte list (single line output) for DMA and IRQ resources
477 * Note: The list length is obtained from the previous table entry
481 AcpiRsOutTitle (Name);
482 AcpiRsDumpShortByteList (*PreviousTarget, Target);
486 case ACPI_RSD_SHORTLISTX:
488 * Short byte list (single line output) for GPIO vendor data
489 * Note: The list length is obtained from the previous table entry
493 AcpiRsOutTitle (Name);
494 AcpiRsDumpShortByteList (*PreviousTarget,
495 *(ACPI_CAST_INDIRECT_PTR (UINT8, Target)));
499 case ACPI_RSD_LONGLIST:
501 * Long byte list for Vendor resource data
502 * Note: The list length is obtained from the previous table entry
506 AcpiRsDumpByteList (ACPI_GET16 (PreviousTarget), Target);
510 case ACPI_RSD_DWORDLIST:
512 * Dword list for Extended Interrupt resources
513 * Note: The list length is obtained from the previous table entry
517 AcpiRsDumpDwordList (*PreviousTarget,
518 ACPI_CAST_PTR (UINT32, Target));
522 case ACPI_RSD_WORDLIST:
524 * Word list for GPIO Pin Table
525 * Note: The list length is obtained from the previous table entry
529 AcpiRsDumpWordList (*PreviousTarget,
530 *(ACPI_CAST_INDIRECT_PTR (UINT16, Target)));
534 case ACPI_RSD_ADDRESS:
536 * Common flags for all Address resources
538 AcpiRsDumpAddressCommon (ACPI_CAST_PTR (
539 ACPI_RESOURCE_DATA, Target));
542 case ACPI_RSD_SOURCE:
544 * Optional ResourceSource for Address resources
546 AcpiRsDumpResourceSource (ACPI_CAST_PTR (
547 ACPI_RESOURCE_SOURCE, Target));
554 AcpiRsDumpResourceLabel ("Resource Label", ACPI_CAST_PTR (
555 ACPI_RESOURCE_LABEL, Target));
558 case ACPI_RSD_SOURCE_LABEL:
560 * ResourceSourceLabel
562 AcpiRsDumpResourceLabel ("Resource Source Label", ACPI_CAST_PTR (
563 ACPI_RESOURCE_LABEL, Target));
568 AcpiOsPrintf ("**** Invalid table opcode [%X] ****\n",
579 /*******************************************************************************
581 * FUNCTION: AcpiRsDumpResourceSource
583 * PARAMETERS: ResourceSource - Pointer to a Resource Source struct
587 * DESCRIPTION: Common routine for dumping the optional ResourceSource and the
588 * corresponding ResourceSourceIndex.
590 ******************************************************************************/
593 AcpiRsDumpResourceSource (
594 ACPI_RESOURCE_SOURCE *ResourceSource)
596 ACPI_FUNCTION_ENTRY ();
599 if (ResourceSource->Index == 0xFF)
604 AcpiRsOutInteger8 ("Resource Source Index",
605 ResourceSource->Index);
607 AcpiRsOutString ("Resource Source",
608 ResourceSource->StringPtr ?
609 ResourceSource->StringPtr : "[Not Specified]");
613 /*******************************************************************************
615 * FUNCTION: AcpiRsDumpResourceLabel
617 * PARAMETERS: Title - Title of the dumped resource field
618 * ResourceLabel - Pointer to a Resource Label struct
622 * DESCRIPTION: Common routine for dumping the ResourceLabel
624 ******************************************************************************/
627 AcpiRsDumpResourceLabel (
629 ACPI_RESOURCE_LABEL *ResourceLabel)
631 ACPI_FUNCTION_ENTRY ();
633 AcpiRsOutString (Title,
634 ResourceLabel->StringPtr ?
635 ResourceLabel->StringPtr : "[Not Specified]");
639 /*******************************************************************************
641 * FUNCTION: AcpiRsDumpAddressCommon
643 * PARAMETERS: Resource - Pointer to an internal resource descriptor
647 * DESCRIPTION: Dump the fields that are common to all Address resource
650 ******************************************************************************/
653 AcpiRsDumpAddressCommon (
654 ACPI_RESOURCE_DATA *Resource)
656 ACPI_FUNCTION_ENTRY ();
659 /* Decode the type-specific flags */
661 switch (Resource->Address.ResourceType)
663 case ACPI_MEMORY_RANGE:
665 AcpiRsDumpDescriptor (Resource, AcpiRsDumpMemoryFlags);
670 AcpiRsDumpDescriptor (Resource, AcpiRsDumpIoFlags);
673 case ACPI_BUS_NUMBER_RANGE:
675 AcpiRsOutString ("Resource Type", "Bus Number Range");
680 AcpiRsOutInteger8 ("Resource Type",
681 (UINT8) Resource->Address.ResourceType);
685 /* Decode the general flags */
687 AcpiRsDumpDescriptor (Resource, AcpiRsDumpGeneralFlags);
691 /*******************************************************************************
693 * FUNCTION: AcpiRsOut*
695 * PARAMETERS: Title - Name of the resource field
696 * Value - Value of the resource field
700 * DESCRIPTION: Miscellaneous helper functions to consistently format the
701 * output of the resource dump routines
703 ******************************************************************************/
711 AcpiOsPrintf ("%27s : %s", Title, Value);
714 AcpiOsPrintf ("[NULL NAMESTRING]");
724 AcpiOsPrintf ("%27s : %2.2X\n", Title, Value);
733 AcpiOsPrintf ("%27s : %4.4X\n", Title, Value);
742 AcpiOsPrintf ("%27s : %8.8X\n", Title, Value);
751 AcpiOsPrintf ("%27s : %8.8X%8.8X\n", Title,
752 ACPI_FORMAT_UINT64 (Value));
760 AcpiOsPrintf ("%27s : ", Title);
764 /*******************************************************************************
766 * FUNCTION: AcpiRsDump*List
768 * PARAMETERS: Length - Number of elements in the list
769 * Data - Start of the list
773 * DESCRIPTION: Miscellaneous functions to dump lists of raw data
775 ******************************************************************************/
785 for (i = 0; i < Length; i++)
787 AcpiOsPrintf ("%25s%2.2X : %2.2X\n", "Byte", i, Data[i]);
792 AcpiRsDumpShortByteList (
799 for (i = 0; i < Length; i++)
801 AcpiOsPrintf ("%X ", Data[i]);
808 AcpiRsDumpDwordList (
815 for (i = 0; i < Length; i++)
817 AcpiOsPrintf ("%25s%2.2X : %8.8X\n", "Dword", i, Data[i]);
829 for (i = 0; i < Length; i++)
831 AcpiOsPrintf ("%25s%2.2X : %4.4X\n", "Word", i, Data[i]);