1100966Siwasaki/******************************************************************************* 2100966Siwasaki * 3100966Siwasaki * Module Name: dmresrc.c - Resource Descriptor disassembly 4100966Siwasaki * 5100966Siwasaki ******************************************************************************/ 6100966Siwasaki 7217365Sjkim/* 8306536Sjkim * Copyright (C) 2000 - 2016, Intel Corp. 9100966Siwasaki * All rights reserved. 10100966Siwasaki * 11217365Sjkim * Redistribution and use in source and binary forms, with or without 12217365Sjkim * modification, are permitted provided that the following conditions 13217365Sjkim * are met: 14217365Sjkim * 1. Redistributions of source code must retain the above copyright 15217365Sjkim * notice, this list of conditions, and the following disclaimer, 16217365Sjkim * without modification. 17217365Sjkim * 2. Redistributions in binary form must reproduce at minimum a disclaimer 18217365Sjkim * substantially similar to the "NO WARRANTY" disclaimer below 19217365Sjkim * ("Disclaimer") and any redistribution must be conditioned upon 20217365Sjkim * including a substantially similar Disclaimer requirement for further 21217365Sjkim * binary redistribution. 22217365Sjkim * 3. Neither the names of the above-listed copyright holders nor the names 23217365Sjkim * of any contributors may be used to endorse or promote products derived 24217365Sjkim * from this software without specific prior written permission. 25100966Siwasaki * 26217365Sjkim * Alternatively, this software may be distributed under the terms of the 27217365Sjkim * GNU General Public License ("GPL") version 2 as published by the Free 28217365Sjkim * Software Foundation. 29100966Siwasaki * 30217365Sjkim * NO WARRANTY 31217365Sjkim * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 32217365Sjkim * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 33217365Sjkim * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 34217365Sjkim * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 35217365Sjkim * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 36217365Sjkim * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 37217365Sjkim * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 38217365Sjkim * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 39217365Sjkim * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 40217365Sjkim * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 41217365Sjkim * POSSIBILITY OF SUCH DAMAGES. 42217365Sjkim */ 43100966Siwasaki 44193341Sjkim#include <contrib/dev/acpica/include/acpi.h> 45193341Sjkim#include <contrib/dev/acpica/include/accommon.h> 46193341Sjkim#include <contrib/dev/acpica/include/amlcode.h> 47193341Sjkim#include <contrib/dev/acpica/include/acdisasm.h> 48100966Siwasaki 49100966Siwasaki 50102550Siwasaki#define _COMPONENT ACPI_CA_DEBUGGER 51100966Siwasaki ACPI_MODULE_NAME ("dbresrc") 52100966Siwasaki 53100966Siwasaki 54151937Sjkim/* Dispatch tables for Resource disassembly functions */ 55151937Sjkim 56193267Sjkimstatic ACPI_RESOURCE_HANDLER AcpiGbl_DmResourceDispatch [] = 57151937Sjkim{ 58167802Sjkim /* Small descriptors */ 59167802Sjkim 60151937Sjkim NULL, /* 0x00, Reserved */ 61151937Sjkim NULL, /* 0x01, Reserved */ 62151937Sjkim NULL, /* 0x02, Reserved */ 63151937Sjkim NULL, /* 0x03, Reserved */ 64151937Sjkim AcpiDmIrqDescriptor, /* 0x04, ACPI_RESOURCE_NAME_IRQ_FORMAT */ 65151937Sjkim AcpiDmDmaDescriptor, /* 0x05, ACPI_RESOURCE_NAME_DMA_FORMAT */ 66151937Sjkim AcpiDmStartDependentDescriptor, /* 0x06, ACPI_RESOURCE_NAME_START_DEPENDENT */ 67151937Sjkim AcpiDmEndDependentDescriptor, /* 0x07, ACPI_RESOURCE_NAME_END_DEPENDENT */ 68151937Sjkim AcpiDmIoDescriptor, /* 0x08, ACPI_RESOURCE_NAME_IO_PORT */ 69151937Sjkim AcpiDmFixedIoDescriptor, /* 0x09, ACPI_RESOURCE_NAME_FIXED_IO_PORT */ 70228110Sjkim AcpiDmFixedDmaDescriptor, /* 0x0A, ACPI_RESOURCE_NAME_FIXED_DMA */ 71151937Sjkim NULL, /* 0x0B, Reserved */ 72151937Sjkim NULL, /* 0x0C, Reserved */ 73151937Sjkim NULL, /* 0x0D, Reserved */ 74151937Sjkim AcpiDmVendorSmallDescriptor, /* 0x0E, ACPI_RESOURCE_NAME_SMALL_VENDOR */ 75167802Sjkim NULL, /* 0x0F, ACPI_RESOURCE_NAME_END_TAG (not used) */ 76151937Sjkim 77167802Sjkim /* Large descriptors */ 78167802Sjkim 79151937Sjkim NULL, /* 0x00, Reserved */ 80151937Sjkim AcpiDmMemory24Descriptor, /* 0x01, ACPI_RESOURCE_NAME_MEMORY_24 */ 81151937Sjkim AcpiDmGenericRegisterDescriptor,/* 0x02, ACPI_RESOURCE_NAME_GENERIC_REGISTER */ 82151937Sjkim NULL, /* 0x03, Reserved */ 83151937Sjkim AcpiDmVendorLargeDescriptor, /* 0x04, ACPI_RESOURCE_NAME_LARGE_VENDOR */ 84151937Sjkim AcpiDmMemory32Descriptor, /* 0x05, ACPI_RESOURCE_NAME_MEMORY_32 */ 85151937Sjkim AcpiDmFixedMemory32Descriptor, /* 0x06, ACPI_RESOURCE_NAME_FIXED_MEMORY_32 */ 86151937Sjkim AcpiDmDwordDescriptor, /* 0x07, ACPI_RESOURCE_NAME_DWORD_ADDRESS_SPACE */ 87151937Sjkim AcpiDmWordDescriptor, /* 0x08, ACPI_RESOURCE_NAME_WORD_ADDRESS_SPACE */ 88151937Sjkim AcpiDmInterruptDescriptor, /* 0x09, ACPI_RESOURCE_NAME_EXTENDED_XRUPT */ 89151937Sjkim AcpiDmQwordDescriptor, /* 0x0A, ACPI_RESOURCE_NAME_QWORD_ADDRESS_SPACE */ 90228110Sjkim AcpiDmExtendedDescriptor, /* 0x0B, ACPI_RESOURCE_NAME_EXTENDED_ADDRESS_SPACE */ 91228110Sjkim AcpiDmGpioDescriptor, /* 0x0C, ACPI_RESOURCE_NAME_GPIO */ 92228110Sjkim NULL, /* 0x0D, Reserved */ 93228110Sjkim AcpiDmSerialBusDescriptor /* 0x0E, ACPI_RESOURCE_NAME_SERIAL_BUS */ 94151937Sjkim}; 95151937Sjkim 96151937Sjkim 97167802Sjkim/* Only used for single-threaded applications */ 98167802Sjkim/* TBD: remove when name is passed as parameter to the dump functions */ 99151937Sjkim 100167802Sjkimstatic UINT32 ResourceName; 101151937Sjkim 102151937Sjkim 103100966Siwasaki/******************************************************************************* 104100966Siwasaki * 105167802Sjkim * FUNCTION: AcpiDmDescriptorName 106167802Sjkim * 107167802Sjkim * PARAMETERS: None 108167802Sjkim * 109167802Sjkim * RETURN: None 110167802Sjkim * 111167802Sjkim * DESCRIPTION: Emit a name for the descriptor if one is present (indicated 112167802Sjkim * by the name being changed from the default name.) A name is only 113167802Sjkim * emitted if a reference to the descriptor has been made somewhere 114167802Sjkim * in the original ASL code. 115167802Sjkim * 116167802Sjkim ******************************************************************************/ 117167802Sjkim 118167802Sjkimvoid 119167802SjkimAcpiDmDescriptorName ( 120167802Sjkim void) 121167802Sjkim{ 122167802Sjkim 123167802Sjkim if (ResourceName == ACPI_DEFAULT_RESNAME) 124167802Sjkim { 125167802Sjkim return; 126167802Sjkim } 127167802Sjkim 128167802Sjkim AcpiOsPrintf ("%4.4s", (char *) &ResourceName); 129167802Sjkim} 130167802Sjkim 131167802Sjkim 132167802Sjkim/******************************************************************************* 133167802Sjkim * 134151937Sjkim * FUNCTION: AcpiDmDumpInteger* 135151937Sjkim * 136151937Sjkim * PARAMETERS: Value - Value to emit 137151937Sjkim * Name - Associated name (emitted as a comment) 138151937Sjkim * 139151937Sjkim * RETURN: None 140151937Sjkim * 141151937Sjkim * DESCRIPTION: Integer output helper functions 142151937Sjkim * 143151937Sjkim ******************************************************************************/ 144151937Sjkim 145151937Sjkimvoid 146151937SjkimAcpiDmDumpInteger8 ( 147151937Sjkim UINT8 Value, 148306536Sjkim const char *Name) 149151937Sjkim{ 150151937Sjkim AcpiOsPrintf ("0x%2.2X, // %s\n", Value, Name); 151151937Sjkim} 152151937Sjkim 153151937Sjkimvoid 154151937SjkimAcpiDmDumpInteger16 ( 155151937Sjkim UINT16 Value, 156306536Sjkim const char *Name) 157151937Sjkim{ 158151937Sjkim AcpiOsPrintf ("0x%4.4X, // %s\n", Value, Name); 159151937Sjkim} 160151937Sjkim 161151937Sjkimvoid 162151937SjkimAcpiDmDumpInteger32 ( 163151937Sjkim UINT32 Value, 164306536Sjkim const char *Name) 165151937Sjkim{ 166151937Sjkim AcpiOsPrintf ("0x%8.8X, // %s\n", Value, Name); 167151937Sjkim} 168151937Sjkim 169151937Sjkimvoid 170151937SjkimAcpiDmDumpInteger64 ( 171151937Sjkim UINT64 Value, 172306536Sjkim const char *Name) 173151937Sjkim{ 174167802Sjkim AcpiOsPrintf ("0x%8.8X%8.8X, // %s\n", ACPI_FORMAT_UINT64 (Value), Name); 175151937Sjkim} 176151937Sjkim 177151937Sjkim 178151937Sjkim/******************************************************************************* 179151937Sjkim * 180100966Siwasaki * FUNCTION: AcpiDmBitList 181100966Siwasaki * 182100966Siwasaki * PARAMETERS: Mask - 16-bit value corresponding to 16 interrupt 183100966Siwasaki * or DMA values 184100966Siwasaki * 185100966Siwasaki * RETURN: None 186100966Siwasaki * 187123315Snjl * DESCRIPTION: Dump a bit mask as a list of individual interrupt/DMA levels. 188100966Siwasaki * 189100966Siwasaki ******************************************************************************/ 190100966Siwasaki 191100966Siwasakivoid 192100966SiwasakiAcpiDmBitList ( 193100966Siwasaki UINT16 Mask) 194100966Siwasaki{ 195100966Siwasaki UINT32 i; 196100966Siwasaki BOOLEAN Previous = FALSE; 197100966Siwasaki 198100966Siwasaki 199100966Siwasaki /* Open the initializer list */ 200100966Siwasaki 201151937Sjkim AcpiOsPrintf ("{"); 202100966Siwasaki 203100966Siwasaki /* Examine each bit */ 204100966Siwasaki 205100966Siwasaki for (i = 0; i < 16; i++) 206100966Siwasaki { 207100966Siwasaki /* Only interested in bits that are set to 1 */ 208100966Siwasaki 209100966Siwasaki if (Mask & 1) 210100966Siwasaki { 211100966Siwasaki if (Previous) 212100966Siwasaki { 213100966Siwasaki AcpiOsPrintf (","); 214100966Siwasaki } 215306536Sjkim 216100966Siwasaki Previous = TRUE; 217209746Sjkim AcpiOsPrintf ("%u", i); 218100966Siwasaki } 219100966Siwasaki 220100966Siwasaki Mask >>= 1; 221100966Siwasaki } 222100966Siwasaki 223100966Siwasaki /* Close list */ 224100966Siwasaki 225100966Siwasaki AcpiOsPrintf ("}\n"); 226100966Siwasaki} 227100966Siwasaki 228100966Siwasaki 229100966Siwasaki/******************************************************************************* 230100966Siwasaki * 231151937Sjkim * FUNCTION: AcpiDmResourceTemplate 232100966Siwasaki * 233100966Siwasaki * PARAMETERS: Info - Curent parse tree walk info 234100966Siwasaki * ByteData - Pointer to the byte list data 235100966Siwasaki * ByteCount - Length of the byte list 236100966Siwasaki * 237100966Siwasaki * RETURN: None 238100966Siwasaki * 239151937Sjkim * DESCRIPTION: Dump the contents of a Resource Template containing a set of 240151937Sjkim * Resource Descriptors. 241100966Siwasaki * 242100966Siwasaki ******************************************************************************/ 243100966Siwasaki 244100966Siwasakivoid 245151937SjkimAcpiDmResourceTemplate ( 246100966Siwasaki ACPI_OP_WALK_INFO *Info, 247167802Sjkim ACPI_PARSE_OBJECT *Op, 248100966Siwasaki UINT8 *ByteData, 249100966Siwasaki UINT32 ByteCount) 250100966Siwasaki{ 251167802Sjkim ACPI_STATUS Status; 252193267Sjkim UINT32 CurrentByteOffset; 253151937Sjkim UINT8 ResourceType; 254151937Sjkim UINT32 ResourceLength; 255167802Sjkim void *Aml; 256100966Siwasaki UINT32 Level; 257100966Siwasaki BOOLEAN DependentFns = FALSE; 258167802Sjkim UINT8 ResourceIndex; 259167802Sjkim ACPI_NAMESPACE_NODE *Node; 260100966Siwasaki 261100966Siwasaki 262281075Sdim if (Op->Asl.AmlOpcode != AML_FIELD_OP) 263281075Sdim { 264281075Sdim Info->MappingOp = Op; 265281075Sdim } 266281075Sdim 267100966Siwasaki Level = Info->Level; 268167802Sjkim ResourceName = ACPI_DEFAULT_RESNAME; 269167802Sjkim Node = Op->Common.Node; 270167802Sjkim if (Node) 271167802Sjkim { 272167802Sjkim Node = Node->Child; 273167802Sjkim } 274100966Siwasaki 275193267Sjkim for (CurrentByteOffset = 0; CurrentByteOffset < ByteCount;) 276100966Siwasaki { 277167802Sjkim Aml = &ByteData[CurrentByteOffset]; 278167802Sjkim 279151937Sjkim /* Get the descriptor type and length */ 280151937Sjkim 281167802Sjkim ResourceType = AcpiUtGetResourceType (Aml); 282167802Sjkim ResourceLength = AcpiUtGetResourceLength (Aml); 283100966Siwasaki 284167802Sjkim /* Validate the Resource Type and Resource Length */ 285100966Siwasaki 286243347Sjkim Status = AcpiUtValidateResource (NULL, Aml, &ResourceIndex); 287167802Sjkim if (ACPI_FAILURE (Status)) 288167802Sjkim { 289306536Sjkim AcpiOsPrintf ( 290306536Sjkim "/*** Could not validate Resource, type (%X) %s***/\n", 291167802Sjkim ResourceType, AcpiFormatException (Status)); 292167802Sjkim return; 293167802Sjkim } 294167802Sjkim 295151937Sjkim /* Point to next descriptor */ 296100966Siwasaki 297167802Sjkim CurrentByteOffset += AcpiUtGetDescriptorLength (Aml); 298100966Siwasaki 299151937Sjkim /* Descriptor pre-processing */ 300151937Sjkim 301151937Sjkim switch (ResourceType) 302100966Siwasaki { 303151937Sjkim case ACPI_RESOURCE_NAME_START_DEPENDENT: 304100966Siwasaki 305100966Siwasaki /* Finish a previous StartDependentFns */ 306100966Siwasaki 307100966Siwasaki if (DependentFns) 308100966Siwasaki { 309100966Siwasaki Level--; 310100966Siwasaki AcpiDmIndent (Level); 311100966Siwasaki AcpiOsPrintf ("}\n"); 312100966Siwasaki } 313100966Siwasaki break; 314100966Siwasaki 315151937Sjkim case ACPI_RESOURCE_NAME_END_DEPENDENT: 316100966Siwasaki 317100966Siwasaki Level--; 318100966Siwasaki DependentFns = FALSE; 319100966Siwasaki break; 320100966Siwasaki 321151937Sjkim case ACPI_RESOURCE_NAME_END_TAG: 322100966Siwasaki 323151937Sjkim /* Normal exit, the resource list is finished */ 324100966Siwasaki 325100966Siwasaki if (DependentFns) 326100966Siwasaki { 327100966Siwasaki /* 328151937Sjkim * Close an open StartDependentDescriptor. This indicates a 329151937Sjkim * missing EndDependentDescriptor. 330100966Siwasaki */ 331100966Siwasaki Level--; 332100966Siwasaki DependentFns = FALSE; 333100966Siwasaki 334151937Sjkim /* Go ahead and insert EndDependentFn() */ 335100966Siwasaki 336281075Sdim AcpiDmEndDependentDescriptor (Info, Aml, ResourceLength, Level); 337151937Sjkim 338151937Sjkim AcpiDmIndent (Level); 339151937Sjkim AcpiOsPrintf ( 340306536Sjkim "/*** Disassembler: inserted " 341306536Sjkim "missing EndDependentFn () ***/\n"); 342100966Siwasaki } 343100966Siwasaki return; 344100966Siwasaki 345151937Sjkim default: 346250838Sjkim 347100966Siwasaki break; 348151937Sjkim } 349100966Siwasaki 350167802Sjkim /* Disassemble the resource structure */ 351100966Siwasaki 352167802Sjkim if (Node) 353151937Sjkim { 354167802Sjkim ResourceName = Node->Name.Integer; 355167802Sjkim Node = Node->Peer; 356100966Siwasaki } 357151937Sjkim 358193267Sjkim AcpiGbl_DmResourceDispatch [ResourceIndex] ( 359281075Sdim Info, Aml, ResourceLength, Level); 360151937Sjkim 361151937Sjkim /* Descriptor post-processing */ 362151937Sjkim 363151937Sjkim if (ResourceType == ACPI_RESOURCE_NAME_START_DEPENDENT) 364151937Sjkim { 365151937Sjkim DependentFns = TRUE; 366151937Sjkim Level++; 367151937Sjkim } 368100966Siwasaki } 369100966Siwasaki} 370100966Siwasaki 371100966Siwasaki 372100966Siwasaki/******************************************************************************* 373100966Siwasaki * 374151937Sjkim * FUNCTION: AcpiDmIsResourceTemplate 375100966Siwasaki * 376243347Sjkim * PARAMETERS: WalkState - Current walk info 377243347Sjkim * Op - Buffer Op to be examined 378100966Siwasaki * 379167802Sjkim * RETURN: Status. AE_OK if valid template 380100966Siwasaki * 381100966Siwasaki * DESCRIPTION: Walk a byte list to determine if it consists of a valid set 382241973Sjkim * of resource descriptors. Nothing is output. 383100966Siwasaki * 384100966Siwasaki ******************************************************************************/ 385100966Siwasaki 386167802SjkimACPI_STATUS 387151937SjkimAcpiDmIsResourceTemplate ( 388243347Sjkim ACPI_WALK_STATE *WalkState, 389100966Siwasaki ACPI_PARSE_OBJECT *Op) 390100966Siwasaki{ 391167802Sjkim ACPI_STATUS Status; 392100966Siwasaki ACPI_PARSE_OBJECT *NextOp; 393167802Sjkim UINT8 *Aml; 394167802Sjkim UINT8 *EndAml; 395167802Sjkim ACPI_SIZE Length; 396100966Siwasaki 397100966Siwasaki 398100966Siwasaki /* This op must be a buffer */ 399100966Siwasaki 400100966Siwasaki if (Op->Common.AmlOpcode != AML_BUFFER_OP) 401100966Siwasaki { 402167802Sjkim return (AE_TYPE); 403100966Siwasaki } 404100966Siwasaki 405167802Sjkim /* Get the ByteData list and length */ 406100966Siwasaki 407100966Siwasaki NextOp = Op->Common.Value.Arg; 408243347Sjkim if (!NextOp) 409243347Sjkim { 410243347Sjkim AcpiOsPrintf ("NULL byte list in buffer\n"); 411243347Sjkim return (AE_TYPE); 412243347Sjkim } 413243347Sjkim 414100966Siwasaki NextOp = NextOp->Common.Next; 415100966Siwasaki if (!NextOp) 416100966Siwasaki { 417167802Sjkim return (AE_TYPE); 418100966Siwasaki } 419100966Siwasaki 420167802Sjkim Aml = NextOp->Named.Data; 421167802Sjkim Length = (ACPI_SIZE) NextOp->Common.Value.Integer; 422100966Siwasaki 423167802Sjkim /* Walk the byte list, abort on any invalid descriptor type or length */ 424100966Siwasaki 425245582Sjkim Status = AcpiUtWalkAmlResources (WalkState, Aml, Length, 426245636Sjkim NULL, ACPI_CAST_INDIRECT_PTR (void, &EndAml)); 427167802Sjkim if (ACPI_FAILURE (Status)) 428100966Siwasaki { 429167802Sjkim return (AE_TYPE); 430126372Snjl } 431126372Snjl 432167802Sjkim /* 433167802Sjkim * For the resource template to be valid, one EndTag must appear 434167802Sjkim * at the very end of the ByteList, not before. (For proper disassembly 435167802Sjkim * of a ResourceTemplate, the buffer must not have any extra data after 436167802Sjkim * the EndTag.) 437167802Sjkim */ 438167802Sjkim if ((Aml + Length - sizeof (AML_RESOURCE_END_TAG)) != EndAml) 439100966Siwasaki { 440167802Sjkim return (AE_AML_NO_RESOURCE_END_TAG); 441100966Siwasaki } 442100966Siwasaki 443167802Sjkim /* 444167802Sjkim * All resource descriptors are valid, therefore this list appears 445167802Sjkim * to be a valid resource template 446167802Sjkim */ 447167802Sjkim return (AE_OK); 448100966Siwasaki} 449