Path: blob/main/sys/contrib/dev/acpica/components/resources/rsdump.c
48406 views
/*******************************************************************************1*2* Module Name: rsdump - AML debugger support for resource structures.3*4******************************************************************************/56/******************************************************************************7*8* 1. Copyright Notice9*10* Some or all of this work - Copyright (c) 1999 - 2025, Intel Corp.11* All rights reserved.12*13* 2. License14*15* 2.1. This is your license from Intel Corp. under its intellectual property16* rights. You may have additional license terms from the party that provided17* you this software, covering your right to use that party's intellectual18* property rights.19*20* 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a21* copy of the source code appearing in this file ("Covered Code") an22* irrevocable, perpetual, worldwide license under Intel's copyrights in the23* base code distributed originally by Intel ("Original Intel Code") to copy,24* make derivatives, distribute, use and display any portion of the Covered25* Code in any form, with the right to sublicense such rights; and26*27* 2.3. Intel grants Licensee a non-exclusive and non-transferable patent28* license (with the right to sublicense), under only those claims of Intel29* patents that are infringed by the Original Intel Code, to make, use, sell,30* offer to sell, and import the Covered Code and derivative works thereof31* solely to the minimum extent necessary to exercise the above copyright32* license, and in no event shall the patent license extend to any additions33* to or modifications of the Original Intel Code. No other license or right34* is granted directly or by implication, estoppel or otherwise;35*36* The above copyright and patent license is granted only if the following37* conditions are met:38*39* 3. Conditions40*41* 3.1. Redistribution of Source with Rights to Further Distribute Source.42* Redistribution of source code of any substantial portion of the Covered43* Code or modification with rights to further distribute source must include44* the above Copyright Notice, the above License, this list of Conditions,45* and the following Disclaimer and Export Compliance provision. In addition,46* Licensee must cause all Covered Code to which Licensee contributes to47* contain a file documenting the changes Licensee made to create that Covered48* Code and the date of any change. Licensee must include in that file the49* documentation of any changes made by any predecessor Licensee. Licensee50* must include a prominent statement that the modification is derived,51* directly or indirectly, from Original Intel Code.52*53* 3.2. Redistribution of Source with no Rights to Further Distribute Source.54* Redistribution of source code of any substantial portion of the Covered55* Code or modification without rights to further distribute source must56* include the following Disclaimer and Export Compliance provision in the57* documentation and/or other materials provided with distribution. In58* addition, Licensee may not authorize further sublicense of source of any59* portion of the Covered Code, and must include terms to the effect that the60* license from Licensee to its licensee is limited to the intellectual61* property embodied in the software Licensee provides to its licensee, and62* not to intellectual property embodied in modifications its licensee may63* make.64*65* 3.3. Redistribution of Executable. Redistribution in executable form of any66* substantial portion of the Covered Code or modification must reproduce the67* above Copyright Notice, and the following Disclaimer and Export Compliance68* provision in the documentation and/or other materials provided with the69* distribution.70*71* 3.4. Intel retains all right, title, and interest in and to the Original72* Intel Code.73*74* 3.5. Neither the name Intel nor any other trademark owned or controlled by75* Intel shall be used in advertising or otherwise to promote the sale, use or76* other dealings in products derived from or relating to the Covered Code77* without prior written authorization from Intel.78*79* 4. Disclaimer and Export Compliance80*81* 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED82* HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE83* IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,84* INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY85* UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY86* IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A87* PARTICULAR PURPOSE.88*89* 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES90* OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR91* COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,92* SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY93* CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL94* HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS95* SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY96* LIMITED REMEDY.97*98* 4.3. Licensee shall not export, either directly or indirectly, any of this99* software or system incorporating such software without first obtaining any100* required license or other approval from the U. S. Department of Commerce or101* any other agency or department of the United States Government. In the102* event Licensee exports any such software from the United States or103* re-exports any such software from a foreign destination, Licensee shall104* ensure that the distribution and export/re-export of the software is in105* compliance with all laws, regulations, orders, or other restrictions of the106* U.S. Export Administration Regulations. Licensee agrees that neither it nor107* any of its subsidiaries will export/re-export any technical data, process,108* software, or service, directly or indirectly, to any country for which the109* United States government or any agency thereof requires an export license,110* other governmental approval, or letter of assurance, without first obtaining111* such license, approval or letter.112*113*****************************************************************************114*115* Alternatively, you may choose to be licensed under the terms of the116* following license:117*118* Redistribution and use in source and binary forms, with or without119* modification, are permitted provided that the following conditions120* are met:121* 1. Redistributions of source code must retain the above copyright122* notice, this list of conditions, and the following disclaimer,123* without modification.124* 2. Redistributions in binary form must reproduce at minimum a disclaimer125* substantially similar to the "NO WARRANTY" disclaimer below126* ("Disclaimer") and any redistribution must be conditioned upon127* including a substantially similar Disclaimer requirement for further128* binary redistribution.129* 3. Neither the names of the above-listed copyright holders nor the names130* of any contributors may be used to endorse or promote products derived131* from this software without specific prior written permission.132*133* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS134* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT135* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR136* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT137* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,138* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT139* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,140* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY141* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT142* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE143* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.144*145* Alternatively, you may choose to be licensed under the terms of the146* GNU General Public License ("GPL") version 2 as published by the Free147* Software Foundation.148*149*****************************************************************************/150151#include <contrib/dev/acpica/include/acpi.h>152#include <contrib/dev/acpica/include/accommon.h>153#include <contrib/dev/acpica/include/acresrc.h>154155#define _COMPONENT ACPI_RESOURCES156ACPI_MODULE_NAME ("rsdump")157158/*159* All functions in this module are used by the AML Debugger only160*/161162/* Local prototypes */163164static void165AcpiRsOutString (166const char *Title,167const char *Value);168169static void170AcpiRsOutInteger8 (171const char *Title,172UINT8 Value);173174static void175AcpiRsOutInteger16 (176const char *Title,177UINT16 Value);178179static void180AcpiRsOutInteger32 (181const char *Title,182UINT32 Value);183184static void185AcpiRsOutInteger64 (186const char *Title,187UINT64 Value);188189static void190AcpiRsOutTitle (191const char *Title);192193static void194AcpiRsDumpByteList (195UINT16 Length,196UINT8 *Data);197198static void199AcpiRsDumpWordList (200UINT16 Length,201UINT16 *Data);202203static void204AcpiRsDumpDwordList (205UINT8 Length,206UINT32 *Data);207208static void209AcpiRsDumpShortByteList (210UINT8 Length,211UINT8 *Data);212213static void214AcpiRsDumpResourceSource (215ACPI_RESOURCE_SOURCE *ResourceSource);216217static void218AcpiRsDumpResourceLabel (219char *Title,220ACPI_RESOURCE_LABEL *ResourceLabel);221222static void223AcpiRsDumpAddressCommon (224ACPI_RESOURCE_DATA *Resource);225226static void227AcpiRsDumpDescriptor (228void *Resource,229ACPI_RSDUMP_INFO *Table);230231232#ifdef ACPI_DEBUGGER233/*******************************************************************************234*235* FUNCTION: AcpiRsDumpResourceList236*237* PARAMETERS: ResourceList - Pointer to a resource descriptor list238*239* RETURN: None240*241* DESCRIPTION: Dispatches the structure to the correct dump routine.242*243******************************************************************************/244245void246AcpiRsDumpResourceList (247ACPI_RESOURCE *ResourceList)248{249UINT32 Count = 0;250UINT32 Type;251252253ACPI_FUNCTION_ENTRY ();254255256/* Check if debug output enabled */257258if (!ACPI_IS_DEBUG_ENABLED (ACPI_LV_RESOURCES, _COMPONENT))259{260return;261}262263/* Walk list and dump all resource descriptors (END_TAG terminates) */264265do266{267AcpiOsPrintf ("\n[%02X] ", Count);268Count++;269270/* Validate Type before dispatch */271272Type = ResourceList->Type;273if (Type > ACPI_RESOURCE_TYPE_MAX)274{275AcpiOsPrintf (276"Invalid descriptor type (%X) in resource list\n",277ResourceList->Type);278return;279}280else if (!ResourceList->Type)281{282ACPI_ERROR ((AE_INFO, "Invalid Zero Resource Type"));283return;284}285286/* Sanity check the length. It must not be zero, or we loop forever */287288if (!ResourceList->Length)289{290AcpiOsPrintf (291"Invalid zero length descriptor in resource list\n");292return;293}294295/* Dump the resource descriptor */296297if (Type == ACPI_RESOURCE_TYPE_SERIAL_BUS)298{299AcpiRsDumpDescriptor (&ResourceList->Data,300AcpiGbl_DumpSerialBusDispatch[301ResourceList->Data.CommonSerialBus.Type]);302}303else304{305AcpiRsDumpDescriptor (&ResourceList->Data,306AcpiGbl_DumpResourceDispatch[Type]);307}308309/* Point to the next resource structure */310311ResourceList = ACPI_NEXT_RESOURCE (ResourceList);312313/* Exit when END_TAG descriptor is reached */314315} while (Type != ACPI_RESOURCE_TYPE_END_TAG);316}317318319/*******************************************************************************320*321* FUNCTION: AcpiRsDumpIrqList322*323* PARAMETERS: RouteTable - Pointer to the routing table to dump.324*325* RETURN: None326*327* DESCRIPTION: Print IRQ routing table328*329******************************************************************************/330331void332AcpiRsDumpIrqList (333UINT8 *RouteTable)334{335ACPI_PCI_ROUTING_TABLE *PrtElement;336UINT8 Count;337338339ACPI_FUNCTION_ENTRY ();340341342/* Check if debug output enabled */343344if (!ACPI_IS_DEBUG_ENABLED (ACPI_LV_RESOURCES, _COMPONENT))345{346return;347}348349PrtElement = ACPI_CAST_PTR (ACPI_PCI_ROUTING_TABLE, RouteTable);350351/* Dump all table elements, Exit on zero length element */352353for (Count = 0; PrtElement->Length; Count++)354{355AcpiOsPrintf ("\n[%02X] PCI IRQ Routing Table Package\n", Count);356AcpiRsDumpDescriptor (PrtElement, AcpiRsDumpPrt);357358PrtElement = ACPI_ADD_PTR (ACPI_PCI_ROUTING_TABLE,359PrtElement, PrtElement->Length);360}361}362#endif363364/*******************************************************************************365*366* FUNCTION: AcpiRsDumpDescriptor367*368* PARAMETERS: Resource - Buffer containing the resource369* Table - Table entry to decode the resource370*371* RETURN: None372*373* DESCRIPTION: Dump a resource descriptor based on a dump table entry.374*375******************************************************************************/376377static void378AcpiRsDumpDescriptor (379void *Resource,380ACPI_RSDUMP_INFO *Table)381{382UINT8 *Target = NULL;383UINT8 *PreviousTarget;384const char *Name;385UINT8 Count;386387388/* First table entry must contain the table length (# of table entries) */389390Count = Table->Offset;391392while (Count)393{394PreviousTarget = Target;395Target = ACPI_ADD_PTR (UINT8, Resource, Table->Offset);396Name = Table->Name;397398switch (Table->Opcode)399{400case ACPI_RSD_TITLE:401/*402* Optional resource title403*/404if (Table->Name)405{406AcpiOsPrintf ("%s Resource\n", Name);407}408break;409410/* Strings */411412case ACPI_RSD_LITERAL:413414AcpiRsOutString (Name, ACPI_CAST_PTR (char, Table->Pointer));415break;416417case ACPI_RSD_STRING:418419AcpiRsOutString (Name, ACPI_CAST_PTR (char, Target));420break;421422/* Data items, 8/16/32/64 bit */423424case ACPI_RSD_UINT8:425426if (Table->Pointer)427{428AcpiRsOutString (Name, Table->Pointer [*Target]);429}430else431{432AcpiRsOutInteger8 (Name, ACPI_GET8 (Target));433}434break;435436case ACPI_RSD_UINT16:437438AcpiRsOutInteger16 (Name, ACPI_GET16 (Target));439break;440441case ACPI_RSD_UINT32:442443AcpiRsOutInteger32 (Name, ACPI_GET32 (Target));444break;445446case ACPI_RSD_UINT64:447448AcpiRsOutInteger64 (Name, ACPI_GET64 (Target));449break;450451/* Flags: 1-bit and 2-bit flags supported */452453case ACPI_RSD_1BITFLAG:454455AcpiRsOutString (Name, Table->Pointer [*Target & 0x01]);456break;457458case ACPI_RSD_2BITFLAG:459460AcpiRsOutString (Name, Table->Pointer [*Target & 0x03]);461break;462463case ACPI_RSD_3BITFLAG:464465AcpiRsOutString (Name, Table->Pointer [*Target & 0x07]);466break;467468case ACPI_RSD_6BITFLAG:469470AcpiRsOutInteger8 (Name, (ACPI_GET8 (Target) & 0x3F));471break;472473case ACPI_RSD_SHORTLIST:474/*475* Short byte list (single line output) for DMA and IRQ resources476* Note: The list length is obtained from the previous table entry477*/478if (PreviousTarget)479{480AcpiRsOutTitle (Name);481AcpiRsDumpShortByteList (*PreviousTarget, Target);482}483break;484485case ACPI_RSD_SHORTLISTX:486/*487* Short byte list (single line output) for GPIO vendor data488* Note: The list length is obtained from the previous table entry489*/490if (PreviousTarget)491{492AcpiRsOutTitle (Name);493AcpiRsDumpShortByteList (*PreviousTarget,494*(ACPI_CAST_INDIRECT_PTR (UINT8, Target)));495}496break;497498case ACPI_RSD_LONGLIST:499/*500* Long byte list for Vendor resource data501* Note: The list length is obtained from the previous table entry502*/503if (PreviousTarget)504{505AcpiRsDumpByteList (ACPI_GET16 (PreviousTarget), Target);506}507break;508509case ACPI_RSD_DWORDLIST:510/*511* Dword list for Extended Interrupt resources512* Note: The list length is obtained from the previous table entry513*/514if (PreviousTarget)515{516AcpiRsDumpDwordList (*PreviousTarget,517ACPI_CAST_PTR (UINT32, Target));518}519break;520521case ACPI_RSD_WORDLIST:522/*523* Word list for GPIO Pin Table524* Note: The list length is obtained from the previous table entry525*/526if (PreviousTarget)527{528AcpiRsDumpWordList (*PreviousTarget,529*(ACPI_CAST_INDIRECT_PTR (UINT16, Target)));530}531break;532533case ACPI_RSD_ADDRESS:534/*535* Common flags for all Address resources536*/537AcpiRsDumpAddressCommon (ACPI_CAST_PTR (538ACPI_RESOURCE_DATA, Target));539break;540541case ACPI_RSD_SOURCE:542/*543* Optional ResourceSource for Address resources544*/545AcpiRsDumpResourceSource (ACPI_CAST_PTR (546ACPI_RESOURCE_SOURCE, Target));547break;548549case ACPI_RSD_LABEL:550/*551* ResourceLabel552*/553AcpiRsDumpResourceLabel ("Resource Label", ACPI_CAST_PTR (554ACPI_RESOURCE_LABEL, Target));555break;556557case ACPI_RSD_SOURCE_LABEL:558/*559* ResourceSourceLabel560*/561AcpiRsDumpResourceLabel ("Resource Source Label", ACPI_CAST_PTR (562ACPI_RESOURCE_LABEL, Target));563break;564565default:566567AcpiOsPrintf ("**** Invalid table opcode [%X] ****\n",568Table->Opcode);569return;570}571572Table++;573Count--;574}575}576577578/*******************************************************************************579*580* FUNCTION: AcpiRsDumpResourceSource581*582* PARAMETERS: ResourceSource - Pointer to a Resource Source struct583*584* RETURN: None585*586* DESCRIPTION: Common routine for dumping the optional ResourceSource and the587* corresponding ResourceSourceIndex.588*589******************************************************************************/590591static void592AcpiRsDumpResourceSource (593ACPI_RESOURCE_SOURCE *ResourceSource)594{595ACPI_FUNCTION_ENTRY ();596597598if (ResourceSource->Index == 0xFF)599{600return;601}602603AcpiRsOutInteger8 ("Resource Source Index",604ResourceSource->Index);605606AcpiRsOutString ("Resource Source",607ResourceSource->StringPtr ?608ResourceSource->StringPtr : "[Not Specified]");609}610611612/*******************************************************************************613*614* FUNCTION: AcpiRsDumpResourceLabel615*616* PARAMETERS: Title - Title of the dumped resource field617* ResourceLabel - Pointer to a Resource Label struct618*619* RETURN: None620*621* DESCRIPTION: Common routine for dumping the ResourceLabel622*623******************************************************************************/624625static void626AcpiRsDumpResourceLabel (627char *Title,628ACPI_RESOURCE_LABEL *ResourceLabel)629{630ACPI_FUNCTION_ENTRY ();631632AcpiRsOutString (Title,633ResourceLabel->StringPtr ?634ResourceLabel->StringPtr : "[Not Specified]");635}636637638/*******************************************************************************639*640* FUNCTION: AcpiRsDumpAddressCommon641*642* PARAMETERS: Resource - Pointer to an internal resource descriptor643*644* RETURN: None645*646* DESCRIPTION: Dump the fields that are common to all Address resource647* descriptors648*649******************************************************************************/650651static void652AcpiRsDumpAddressCommon (653ACPI_RESOURCE_DATA *Resource)654{655ACPI_FUNCTION_ENTRY ();656657658/* Decode the type-specific flags */659660switch (Resource->Address.ResourceType)661{662case ACPI_MEMORY_RANGE:663664AcpiRsDumpDescriptor (Resource, AcpiRsDumpMemoryFlags);665break;666667case ACPI_IO_RANGE:668669AcpiRsDumpDescriptor (Resource, AcpiRsDumpIoFlags);670break;671672case ACPI_BUS_NUMBER_RANGE:673674AcpiRsOutString ("Resource Type", "Bus Number Range");675break;676677default:678679AcpiRsOutInteger8 ("Resource Type",680(UINT8) Resource->Address.ResourceType);681break;682}683684/* Decode the general flags */685686AcpiRsDumpDescriptor (Resource, AcpiRsDumpGeneralFlags);687}688689690/*******************************************************************************691*692* FUNCTION: AcpiRsOut*693*694* PARAMETERS: Title - Name of the resource field695* Value - Value of the resource field696*697* RETURN: None698*699* DESCRIPTION: Miscellaneous helper functions to consistently format the700* output of the resource dump routines701*702******************************************************************************/703704static void705AcpiRsOutString (706const char *Title,707const char *Value)708{709710AcpiOsPrintf ("%27s : %s", Title, Value);711if (!*Value)712{713AcpiOsPrintf ("[NULL NAMESTRING]");714}715AcpiOsPrintf ("\n");716}717718static void719AcpiRsOutInteger8 (720const char *Title,721UINT8 Value)722{723AcpiOsPrintf ("%27s : %2.2X\n", Title, Value);724}725726static void727AcpiRsOutInteger16 (728const char *Title,729UINT16 Value)730{731732AcpiOsPrintf ("%27s : %4.4X\n", Title, Value);733}734735static void736AcpiRsOutInteger32 (737const char *Title,738UINT32 Value)739{740741AcpiOsPrintf ("%27s : %8.8X\n", Title, Value);742}743744static void745AcpiRsOutInteger64 (746const char *Title,747UINT64 Value)748{749750AcpiOsPrintf ("%27s : %8.8X%8.8X\n", Title,751ACPI_FORMAT_UINT64 (Value));752}753754static void755AcpiRsOutTitle (756const char *Title)757{758759AcpiOsPrintf ("%27s : ", Title);760}761762763/*******************************************************************************764*765* FUNCTION: AcpiRsDump*List766*767* PARAMETERS: Length - Number of elements in the list768* Data - Start of the list769*770* RETURN: None771*772* DESCRIPTION: Miscellaneous functions to dump lists of raw data773*774******************************************************************************/775776static void777AcpiRsDumpByteList (778UINT16 Length,779UINT8 *Data)780{781UINT16 i;782783784for (i = 0; i < Length; i++)785{786AcpiOsPrintf ("%25s%2.2X : %2.2X\n", "Byte", i, Data[i]);787}788}789790static void791AcpiRsDumpShortByteList (792UINT8 Length,793UINT8 *Data)794{795UINT8 i;796797798for (i = 0; i < Length; i++)799{800AcpiOsPrintf ("%X ", Data[i]);801}802803AcpiOsPrintf ("\n");804}805806static void807AcpiRsDumpDwordList (808UINT8 Length,809UINT32 *Data)810{811UINT8 i;812813814for (i = 0; i < Length; i++)815{816AcpiOsPrintf ("%25s%2.2X : %8.8X\n", "Dword", i, Data[i]);817}818}819820static void821AcpiRsDumpWordList (822UINT16 Length,823UINT16 *Data)824{825UINT16 i;826827828for (i = 0; i < Length; i++)829{830AcpiOsPrintf ("%25s%2.2X : %4.4X\n", "Word", i, Data[i]);831}832}833834835