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