1 /******************************************************************************* 2 * 3 * Module Name: dmresrc.c - Resource Descriptor disassembly 4 * 5 ******************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2017, 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 "acpi.h" 153 #include "accommon.h" 154 #include "amlcode.h" 155 #include "acdisasm.h" 156 157 #ifdef ACPI_DISASSEMBLER 158 159 #define _COMPONENT ACPI_CA_DEBUGGER 160 ACPI_MODULE_NAME ("dbresrc") 161 162 163 /* Dispatch tables for Resource disassembly functions */ 164 165 static ACPI_RESOURCE_HANDLER AcpiGbl_DmResourceDispatch [] = 166 { 167 /* Small descriptors */ 168 169 NULL, /* 0x00, Reserved */ 170 NULL, /* 0x01, Reserved */ 171 NULL, /* 0x02, Reserved */ 172 NULL, /* 0x03, Reserved */ 173 AcpiDmIrqDescriptor, /* 0x04, ACPI_RESOURCE_NAME_IRQ_FORMAT */ 174 AcpiDmDmaDescriptor, /* 0x05, ACPI_RESOURCE_NAME_DMA_FORMAT */ 175 AcpiDmStartDependentDescriptor, /* 0x06, ACPI_RESOURCE_NAME_START_DEPENDENT */ 176 AcpiDmEndDependentDescriptor, /* 0x07, ACPI_RESOURCE_NAME_END_DEPENDENT */ 177 AcpiDmIoDescriptor, /* 0x08, ACPI_RESOURCE_NAME_IO_PORT */ 178 AcpiDmFixedIoDescriptor, /* 0x09, ACPI_RESOURCE_NAME_FIXED_IO_PORT */ 179 AcpiDmFixedDmaDescriptor, /* 0x0A, ACPI_RESOURCE_NAME_FIXED_DMA */ 180 NULL, /* 0x0B, Reserved */ 181 NULL, /* 0x0C, Reserved */ 182 NULL, /* 0x0D, Reserved */ 183 AcpiDmVendorSmallDescriptor, /* 0x0E, ACPI_RESOURCE_NAME_SMALL_VENDOR */ 184 NULL, /* 0x0F, ACPI_RESOURCE_NAME_END_TAG (not used) */ 185 186 /* Large descriptors */ 187 188 NULL, /* 0x00, Reserved */ 189 AcpiDmMemory24Descriptor, /* 0x01, ACPI_RESOURCE_NAME_MEMORY_24 */ 190 AcpiDmGenericRegisterDescriptor,/* 0x02, ACPI_RESOURCE_NAME_GENERIC_REGISTER */ 191 NULL, /* 0x03, Reserved */ 192 AcpiDmVendorLargeDescriptor, /* 0x04, ACPI_RESOURCE_NAME_LARGE_VENDOR */ 193 AcpiDmMemory32Descriptor, /* 0x05, ACPI_RESOURCE_NAME_MEMORY_32 */ 194 AcpiDmFixedMemory32Descriptor, /* 0x06, ACPI_RESOURCE_NAME_FIXED_MEMORY_32 */ 195 AcpiDmDwordDescriptor, /* 0x07, ACPI_RESOURCE_NAME_DWORD_ADDRESS_SPACE */ 196 AcpiDmWordDescriptor, /* 0x08, ACPI_RESOURCE_NAME_WORD_ADDRESS_SPACE */ 197 AcpiDmInterruptDescriptor, /* 0x09, ACPI_RESOURCE_NAME_EXTENDED_XRUPT */ 198 AcpiDmQwordDescriptor, /* 0x0A, ACPI_RESOURCE_NAME_QWORD_ADDRESS_SPACE */ 199 AcpiDmExtendedDescriptor, /* 0x0B, ACPI_RESOURCE_NAME_EXTENDED_ADDRESS_SPACE */ 200 AcpiDmGpioDescriptor, /* 0x0C, ACPI_RESOURCE_NAME_GPIO */ 201 NULL, /* 0x0D, Reserved */ 202 AcpiDmSerialBusDescriptor /* 0x0E, ACPI_RESOURCE_NAME_SERIAL_BUS */ 203 }; 204 205 206 /* Only used for single-threaded applications */ 207 /* TBD: remove when name is passed as parameter to the dump functions */ 208 209 static UINT32 ResourceName; 210 211 212 /******************************************************************************* 213 * 214 * FUNCTION: AcpiDmDescriptorName 215 * 216 * PARAMETERS: None 217 * 218 * RETURN: None 219 * 220 * DESCRIPTION: Emit a name for the descriptor if one is present (indicated 221 * by the name being changed from the default name.) A name is only 222 * emitted if a reference to the descriptor has been made somewhere 223 * in the original ASL code. 224 * 225 ******************************************************************************/ 226 227 void 228 AcpiDmDescriptorName ( 229 void) 230 { 231 232 if (ResourceName == ACPI_DEFAULT_RESNAME) 233 { 234 return; 235 } 236 237 AcpiOsPrintf ("%4.4s", (char *) &ResourceName); 238 } 239 240 241 /******************************************************************************* 242 * 243 * FUNCTION: AcpiDmDumpInteger* 244 * 245 * PARAMETERS: Value - Value to emit 246 * Name - Associated name (emitted as a comment) 247 * 248 * RETURN: None 249 * 250 * DESCRIPTION: Integer output helper functions 251 * 252 ******************************************************************************/ 253 254 void 255 AcpiDmDumpInteger8 ( 256 UINT8 Value, 257 const char *Name) 258 { 259 AcpiOsPrintf ("0x%2.2X, // %s\n", Value, Name); 260 } 261 262 void 263 AcpiDmDumpInteger16 ( 264 UINT16 Value, 265 const char *Name) 266 { 267 AcpiOsPrintf ("0x%4.4X, // %s\n", Value, Name); 268 } 269 270 void 271 AcpiDmDumpInteger32 ( 272 UINT32 Value, 273 const char *Name) 274 { 275 AcpiOsPrintf ("0x%8.8X, // %s\n", Value, Name); 276 } 277 278 void 279 AcpiDmDumpInteger64 ( 280 UINT64 Value, 281 const char *Name) 282 { 283 AcpiOsPrintf ("0x%8.8X%8.8X, // %s\n", ACPI_FORMAT_UINT64 (Value), Name); 284 } 285 286 287 /******************************************************************************* 288 * 289 * FUNCTION: AcpiDmBitList 290 * 291 * PARAMETERS: Mask - 16-bit value corresponding to 16 interrupt 292 * or DMA values 293 * 294 * RETURN: None 295 * 296 * DESCRIPTION: Dump a bit mask as a list of individual interrupt/DMA levels. 297 * 298 ******************************************************************************/ 299 300 void 301 AcpiDmBitList ( 302 UINT16 Mask) 303 { 304 UINT32 i; 305 BOOLEAN Previous = FALSE; 306 307 308 /* Open the initializer list */ 309 310 AcpiOsPrintf ("{"); 311 312 /* Examine each bit */ 313 314 for (i = 0; i < 16; i++) 315 { 316 /* Only interested in bits that are set to 1 */ 317 318 if (Mask & 1) 319 { 320 if (Previous) 321 { 322 AcpiOsPrintf (","); 323 } 324 325 Previous = TRUE; 326 AcpiOsPrintf ("%u", i); 327 } 328 329 Mask >>= 1; 330 } 331 332 /* Close list */ 333 334 AcpiOsPrintf ("}\n"); 335 } 336 337 338 /******************************************************************************* 339 * 340 * FUNCTION: AcpiDmResourceTemplate 341 * 342 * PARAMETERS: Info - Curent parse tree walk info 343 * ByteData - Pointer to the byte list data 344 * ByteCount - Length of the byte list 345 * 346 * RETURN: None 347 * 348 * DESCRIPTION: Dump the contents of a Resource Template containing a set of 349 * Resource Descriptors. 350 * 351 ******************************************************************************/ 352 353 void 354 AcpiDmResourceTemplate ( 355 ACPI_OP_WALK_INFO *Info, 356 ACPI_PARSE_OBJECT *Op, 357 UINT8 *ByteData, 358 UINT32 ByteCount) 359 { 360 ACPI_STATUS Status; 361 UINT32 CurrentByteOffset; 362 UINT8 ResourceType; 363 UINT32 ResourceLength; 364 void *Aml; 365 UINT32 Level; 366 BOOLEAN DependentFns = FALSE; 367 UINT8 ResourceIndex; 368 ACPI_NAMESPACE_NODE *Node; 369 370 371 if (Op->Asl.AmlOpcode != AML_FIELD_OP) 372 { 373 Info->MappingOp = Op; 374 } 375 376 Level = Info->Level; 377 ResourceName = ACPI_DEFAULT_RESNAME; 378 Node = Op->Common.Node; 379 if (Node) 380 { 381 Node = Node->Child; 382 } 383 384 for (CurrentByteOffset = 0; CurrentByteOffset < ByteCount;) 385 { 386 Aml = &ByteData[CurrentByteOffset]; 387 388 /* Get the descriptor type and length */ 389 390 ResourceType = AcpiUtGetResourceType (Aml); 391 ResourceLength = AcpiUtGetResourceLength (Aml); 392 393 /* Validate the Resource Type and Resource Length */ 394 395 Status = AcpiUtValidateResource (NULL, Aml, &ResourceIndex); 396 if (ACPI_FAILURE (Status)) 397 { 398 AcpiOsPrintf ( 399 "/*** Could not validate Resource, type (%X) %s***/\n", 400 ResourceType, AcpiFormatException (Status)); 401 return; 402 } 403 404 /* Point to next descriptor */ 405 406 CurrentByteOffset += AcpiUtGetDescriptorLength (Aml); 407 408 /* Descriptor pre-processing */ 409 410 switch (ResourceType) 411 { 412 case ACPI_RESOURCE_NAME_START_DEPENDENT: 413 414 /* Finish a previous StartDependentFns */ 415 416 if (DependentFns) 417 { 418 Level--; 419 AcpiDmIndent (Level); 420 AcpiOsPrintf ("}\n"); 421 } 422 break; 423 424 case ACPI_RESOURCE_NAME_END_DEPENDENT: 425 426 Level--; 427 DependentFns = FALSE; 428 break; 429 430 case ACPI_RESOURCE_NAME_END_TAG: 431 432 /* Normal exit, the resource list is finished */ 433 434 if (DependentFns) 435 { 436 /* 437 * Close an open StartDependentDescriptor. This indicates a 438 * missing EndDependentDescriptor. 439 */ 440 Level--; 441 DependentFns = FALSE; 442 443 /* Go ahead and insert EndDependentFn() */ 444 445 AcpiDmEndDependentDescriptor (Info, Aml, ResourceLength, Level); 446 447 AcpiDmIndent (Level); 448 AcpiOsPrintf ( 449 "/*** Disassembler: inserted " 450 "missing EndDependentFn () ***/\n"); 451 } 452 return; 453 454 default: 455 456 break; 457 } 458 459 /* Disassemble the resource structure */ 460 461 if (Node) 462 { 463 ResourceName = Node->Name.Integer; 464 Node = Node->Peer; 465 } 466 467 AcpiGbl_DmResourceDispatch [ResourceIndex] ( 468 Info, Aml, ResourceLength, Level); 469 470 /* Descriptor post-processing */ 471 472 if (ResourceType == ACPI_RESOURCE_NAME_START_DEPENDENT) 473 { 474 DependentFns = TRUE; 475 Level++; 476 } 477 } 478 } 479 480 481 /******************************************************************************* 482 * 483 * FUNCTION: AcpiDmIsResourceTemplate 484 * 485 * PARAMETERS: WalkState - Current walk info 486 * Op - Buffer Op to be examined 487 * 488 * RETURN: Status. AE_OK if valid template 489 * 490 * DESCRIPTION: Walk a byte list to determine if it consists of a valid set 491 * of resource descriptors. Nothing is output. 492 * 493 ******************************************************************************/ 494 495 ACPI_STATUS 496 AcpiDmIsResourceTemplate ( 497 ACPI_WALK_STATE *WalkState, 498 ACPI_PARSE_OBJECT *Op) 499 { 500 ACPI_STATUS Status; 501 ACPI_PARSE_OBJECT *NextOp; 502 UINT8 *Aml; 503 UINT8 *EndAml; 504 UINT32 BufferLength; 505 UINT32 DeclaredBufferLength; 506 507 508 /* This op must be a buffer */ 509 510 if (Op->Common.AmlOpcode != AML_BUFFER_OP) 511 { 512 return (AE_TYPE); 513 } 514 515 /* 516 * Get the declared length of the buffer. 517 * This is the nn in "Buffer (nn)" 518 */ 519 NextOp = Op->Common.Value.Arg; 520 if (!NextOp) 521 { 522 AcpiOsPrintf ("NULL byte list in buffer\n"); 523 return (AE_TYPE); 524 } 525 526 DeclaredBufferLength = NextOp->Common.Value.Size; 527 528 /* Get the length of the raw initialization byte list */ 529 530 NextOp = NextOp->Common.Next; 531 if (!NextOp) 532 { 533 return (AE_TYPE); 534 } 535 536 Aml = NextOp->Named.Data; 537 BufferLength = NextOp->Common.Value.Size; 538 539 /* 540 * Not a template if declared buffer length != actual length of the 541 * intialization byte list. Because the resource macros will create 542 * a buffer of the exact required length (buffer length will be equal 543 * to the actual length). 544 */ 545 if (DeclaredBufferLength != BufferLength) 546 { 547 return (AE_TYPE); 548 } 549 550 /* Walk the byte list, abort on any invalid descriptor type or length */ 551 552 Status = AcpiUtWalkAmlResources (WalkState, Aml, BufferLength, 553 NULL, ACPI_CAST_INDIRECT_PTR (void, &EndAml)); 554 if (ACPI_FAILURE (Status)) 555 { 556 return (AE_TYPE); 557 } 558 559 /* 560 * For the resource template to be valid, one EndTag must appear 561 * at the very end of the ByteList, not before. (For proper disassembly 562 * of a ResourceTemplate, the buffer must not have any extra data after 563 * the EndTag.) 564 */ 565 if ((Aml + BufferLength - sizeof (AML_RESOURCE_END_TAG)) != EndAml) 566 { 567 return (AE_AML_NO_RESOURCE_END_TAG); 568 } 569 570 /* 571 * All resource descriptors are valid, therefore this list appears 572 * to be a valid resource template 573 */ 574 return (AE_OK); 575 } 576 577 #endif 578