1 /******************************************************************************* 2 * 3 * Module Name: dmresrc.c - Resource Descriptor disassembly 4 * $Revision: 1.36 $ 5 * 6 ******************************************************************************/ 7 8 /****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2008, Intel Corp. 13 * All rights reserved. 14 * 15 * 2. License 16 * 17 * 2.1. This is your license from Intel Corp. under its intellectual property 18 * rights. You may have additional license terms from the party that provided 19 * you this software, covering your right to use that party's intellectual 20 * property rights. 21 * 22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 23 * copy of the source code appearing in this file ("Covered Code") an 24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 25 * base code distributed originally by Intel ("Original Intel Code") to copy, 26 * make derivatives, distribute, use and display any portion of the Covered 27 * Code in any form, with the right to sublicense such rights; and 28 * 29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 30 * license (with the right to sublicense), under only those claims of Intel 31 * patents that are infringed by the Original Intel Code, to make, use, sell, 32 * offer to sell, and import the Covered Code and derivative works thereof 33 * solely to the minimum extent necessary to exercise the above copyright 34 * license, and in no event shall the patent license extend to any additions 35 * to or modifications of the Original Intel Code. No other license or right 36 * is granted directly or by implication, estoppel or otherwise; 37 * 38 * The above copyright and patent license is granted only if the following 39 * conditions are met: 40 * 41 * 3. Conditions 42 * 43 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 44 * Redistribution of source code of any substantial portion of the Covered 45 * Code or modification with rights to further distribute source must include 46 * the above Copyright Notice, the above License, this list of Conditions, 47 * and the following Disclaimer and Export Compliance provision. In addition, 48 * Licensee must cause all Covered Code to which Licensee contributes to 49 * contain a file documenting the changes Licensee made to create that Covered 50 * Code and the date of any change. Licensee must include in that file the 51 * documentation of any changes made by any predecessor Licensee. Licensee 52 * must include a prominent statement that the modification is derived, 53 * directly or indirectly, from Original Intel Code. 54 * 55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 56 * Redistribution of source code of any substantial portion of the Covered 57 * Code or modification without rights to further distribute source must 58 * include the following Disclaimer and Export Compliance provision in the 59 * documentation and/or other materials provided with distribution. In 60 * addition, Licensee may not authorize further sublicense of source of any 61 * portion of the Covered Code, and must include terms to the effect that the 62 * license from Licensee to its licensee is limited to the intellectual 63 * property embodied in the software Licensee provides to its licensee, and 64 * not to intellectual property embodied in modifications its licensee may 65 * make. 66 * 67 * 3.3. Redistribution of Executable. Redistribution in executable form of any 68 * substantial portion of the Covered Code or modification must reproduce the 69 * above Copyright Notice, and the following Disclaimer and Export Compliance 70 * provision in the documentation and/or other materials provided with the 71 * distribution. 72 * 73 * 3.4. Intel retains all right, title, and interest in and to the Original 74 * Intel Code. 75 * 76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 77 * Intel shall be used in advertising or otherwise to promote the sale, use or 78 * other dealings in products derived from or relating to the Covered Code 79 * without prior written authorization from Intel. 80 * 81 * 4. Disclaimer and Export Compliance 82 * 83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 89 * PARTICULAR PURPOSE. 90 * 91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 98 * LIMITED REMEDY. 99 * 100 * 4.3. Licensee shall not export, either directly or indirectly, any of this 101 * software or system incorporating such software without first obtaining any 102 * required license or other approval from the U. S. Department of Commerce or 103 * any other agency or department of the United States Government. In the 104 * event Licensee exports any such software from the United States or 105 * re-exports any such software from a foreign destination, Licensee shall 106 * ensure that the distribution and export/re-export of the software is in 107 * compliance with all laws, regulations, orders, or other restrictions of the 108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 109 * any of its subsidiaries will export/re-export any technical data, process, 110 * software, or service, directly or indirectly, to any country for which the 111 * United States government or any agency thereof requires an export license, 112 * other governmental approval, or letter of assurance, without first obtaining 113 * such license, approval or letter. 114 * 115 *****************************************************************************/ 116 117 118 #include "acpi.h" 119 #include "amlcode.h" 120 #include "acdisasm.h" 121 122 #ifdef ACPI_DISASSEMBLER 123 124 #define _COMPONENT ACPI_CA_DEBUGGER 125 ACPI_MODULE_NAME ("dbresrc") 126 127 128 /* Dispatch tables for Resource disassembly functions */ 129 130 typedef 131 void (*ACPI_RESOURCE_HANDLER) ( 132 AML_RESOURCE *Resource, 133 UINT32 Length, 134 UINT32 Level); 135 136 static ACPI_RESOURCE_HANDLER AcpiGbl_DmResourceDispatch [] = 137 { 138 /* Small descriptors */ 139 140 NULL, /* 0x00, Reserved */ 141 NULL, /* 0x01, Reserved */ 142 NULL, /* 0x02, Reserved */ 143 NULL, /* 0x03, Reserved */ 144 AcpiDmIrqDescriptor, /* 0x04, ACPI_RESOURCE_NAME_IRQ_FORMAT */ 145 AcpiDmDmaDescriptor, /* 0x05, ACPI_RESOURCE_NAME_DMA_FORMAT */ 146 AcpiDmStartDependentDescriptor, /* 0x06, ACPI_RESOURCE_NAME_START_DEPENDENT */ 147 AcpiDmEndDependentDescriptor, /* 0x07, ACPI_RESOURCE_NAME_END_DEPENDENT */ 148 AcpiDmIoDescriptor, /* 0x08, ACPI_RESOURCE_NAME_IO_PORT */ 149 AcpiDmFixedIoDescriptor, /* 0x09, ACPI_RESOURCE_NAME_FIXED_IO_PORT */ 150 NULL, /* 0x0A, Reserved */ 151 NULL, /* 0x0B, Reserved */ 152 NULL, /* 0x0C, Reserved */ 153 NULL, /* 0x0D, Reserved */ 154 AcpiDmVendorSmallDescriptor, /* 0x0E, ACPI_RESOURCE_NAME_SMALL_VENDOR */ 155 NULL, /* 0x0F, ACPI_RESOURCE_NAME_END_TAG (not used) */ 156 157 /* Large descriptors */ 158 159 NULL, /* 0x00, Reserved */ 160 AcpiDmMemory24Descriptor, /* 0x01, ACPI_RESOURCE_NAME_MEMORY_24 */ 161 AcpiDmGenericRegisterDescriptor,/* 0x02, ACPI_RESOURCE_NAME_GENERIC_REGISTER */ 162 NULL, /* 0x03, Reserved */ 163 AcpiDmVendorLargeDescriptor, /* 0x04, ACPI_RESOURCE_NAME_LARGE_VENDOR */ 164 AcpiDmMemory32Descriptor, /* 0x05, ACPI_RESOURCE_NAME_MEMORY_32 */ 165 AcpiDmFixedMemory32Descriptor, /* 0x06, ACPI_RESOURCE_NAME_FIXED_MEMORY_32 */ 166 AcpiDmDwordDescriptor, /* 0x07, ACPI_RESOURCE_NAME_DWORD_ADDRESS_SPACE */ 167 AcpiDmWordDescriptor, /* 0x08, ACPI_RESOURCE_NAME_WORD_ADDRESS_SPACE */ 168 AcpiDmInterruptDescriptor, /* 0x09, ACPI_RESOURCE_NAME_EXTENDED_XRUPT */ 169 AcpiDmQwordDescriptor, /* 0x0A, ACPI_RESOURCE_NAME_QWORD_ADDRESS_SPACE */ 170 AcpiDmExtendedDescriptor /* 0x0B, ACPI_RESOURCE_NAME_EXTENDED_ADDRESS_SPACE */ 171 }; 172 173 174 /* Only used for single-threaded applications */ 175 /* TBD: remove when name is passed as parameter to the dump functions */ 176 177 static UINT32 ResourceName; 178 179 180 /******************************************************************************* 181 * 182 * FUNCTION: AcpiDmDescriptorName 183 * 184 * PARAMETERS: None 185 * 186 * RETURN: None 187 * 188 * DESCRIPTION: Emit a name for the descriptor if one is present (indicated 189 * by the name being changed from the default name.) A name is only 190 * emitted if a reference to the descriptor has been made somewhere 191 * in the original ASL code. 192 * 193 ******************************************************************************/ 194 195 void 196 AcpiDmDescriptorName ( 197 void) 198 { 199 200 if (ResourceName == ACPI_DEFAULT_RESNAME) 201 { 202 return; 203 } 204 205 AcpiOsPrintf ("%4.4s", (char *) &ResourceName); 206 } 207 208 209 /******************************************************************************* 210 * 211 * FUNCTION: AcpiDmDumpInteger* 212 * 213 * PARAMETERS: Value - Value to emit 214 * Name - Associated name (emitted as a comment) 215 * 216 * RETURN: None 217 * 218 * DESCRIPTION: Integer output helper functions 219 * 220 ******************************************************************************/ 221 222 void 223 AcpiDmDumpInteger8 ( 224 UINT8 Value, 225 char *Name) 226 { 227 AcpiOsPrintf ("0x%2.2X, // %s\n", Value, Name); 228 } 229 230 void 231 AcpiDmDumpInteger16 ( 232 UINT16 Value, 233 char *Name) 234 { 235 AcpiOsPrintf ("0x%4.4X, // %s\n", Value, Name); 236 } 237 238 void 239 AcpiDmDumpInteger32 ( 240 UINT32 Value, 241 char *Name) 242 { 243 AcpiOsPrintf ("0x%8.8X, // %s\n", Value, Name); 244 } 245 246 void 247 AcpiDmDumpInteger64 ( 248 UINT64 Value, 249 char *Name) 250 { 251 AcpiOsPrintf ("0x%8.8X%8.8X, // %s\n", ACPI_FORMAT_UINT64 (Value), Name); 252 } 253 254 255 /******************************************************************************* 256 * 257 * FUNCTION: AcpiDmBitList 258 * 259 * PARAMETERS: Mask - 16-bit value corresponding to 16 interrupt 260 * or DMA values 261 * 262 * RETURN: None 263 * 264 * DESCRIPTION: Dump a bit mask as a list of individual interrupt/DMA levels. 265 * 266 ******************************************************************************/ 267 268 void 269 AcpiDmBitList ( 270 UINT16 Mask) 271 { 272 UINT32 i; 273 BOOLEAN Previous = FALSE; 274 275 276 /* Open the initializer list */ 277 278 AcpiOsPrintf ("{"); 279 280 /* Examine each bit */ 281 282 for (i = 0; i < 16; i++) 283 { 284 /* Only interested in bits that are set to 1 */ 285 286 if (Mask & 1) 287 { 288 if (Previous) 289 { 290 AcpiOsPrintf (","); 291 } 292 Previous = TRUE; 293 AcpiOsPrintf ("%d", i); 294 } 295 296 Mask >>= 1; 297 } 298 299 /* Close list */ 300 301 AcpiOsPrintf ("}\n"); 302 } 303 304 305 /******************************************************************************* 306 * 307 * FUNCTION: AcpiDmResourceTemplate 308 * 309 * PARAMETERS: Info - Curent parse tree walk info 310 * ByteData - Pointer to the byte list data 311 * ByteCount - Length of the byte list 312 * 313 * RETURN: None 314 * 315 * DESCRIPTION: Dump the contents of a Resource Template containing a set of 316 * Resource Descriptors. 317 * 318 ******************************************************************************/ 319 320 void 321 AcpiDmResourceTemplate ( 322 ACPI_OP_WALK_INFO *Info, 323 ACPI_PARSE_OBJECT *Op, 324 UINT8 *ByteData, 325 UINT32 ByteCount) 326 { 327 ACPI_STATUS Status; 328 UINT32 CurrentByteOffset; 329 UINT8 ResourceType; 330 UINT32 ResourceLength; 331 void *Aml; 332 UINT32 Level; 333 BOOLEAN DependentFns = FALSE; 334 UINT8 ResourceIndex; 335 ACPI_NAMESPACE_NODE *Node; 336 337 338 Level = Info->Level; 339 ResourceName = ACPI_DEFAULT_RESNAME; 340 Node = Op->Common.Node; 341 if (Node) 342 { 343 Node = Node->Child; 344 } 345 346 for (CurrentByteOffset = 0; CurrentByteOffset < ByteCount;) 347 { 348 Aml = &ByteData[CurrentByteOffset]; 349 350 /* Get the descriptor type and length */ 351 352 ResourceType = AcpiUtGetResourceType (Aml); 353 ResourceLength = AcpiUtGetResourceLength (Aml); 354 355 /* Validate the Resource Type and Resource Length */ 356 357 Status = AcpiUtValidateResource (Aml, &ResourceIndex); 358 if (ACPI_FAILURE (Status)) 359 { 360 AcpiOsPrintf ("/*** Could not validate Resource, type (%X) %s***/\n", 361 ResourceType, AcpiFormatException (Status)); 362 return; 363 } 364 365 /* Point to next descriptor */ 366 367 CurrentByteOffset += AcpiUtGetDescriptorLength (Aml); 368 369 /* Descriptor pre-processing */ 370 371 switch (ResourceType) 372 { 373 case ACPI_RESOURCE_NAME_START_DEPENDENT: 374 375 /* Finish a previous StartDependentFns */ 376 377 if (DependentFns) 378 { 379 Level--; 380 AcpiDmIndent (Level); 381 AcpiOsPrintf ("}\n"); 382 } 383 break; 384 385 case ACPI_RESOURCE_NAME_END_DEPENDENT: 386 387 Level--; 388 DependentFns = FALSE; 389 break; 390 391 case ACPI_RESOURCE_NAME_END_TAG: 392 393 /* Normal exit, the resource list is finished */ 394 395 if (DependentFns) 396 { 397 /* 398 * Close an open StartDependentDescriptor. This indicates a 399 * missing EndDependentDescriptor. 400 */ 401 Level--; 402 DependentFns = FALSE; 403 404 /* Go ahead and insert EndDependentFn() */ 405 406 AcpiDmEndDependentDescriptor (Aml, ResourceLength, Level); 407 408 AcpiDmIndent (Level); 409 AcpiOsPrintf ( 410 "/*** Disassembler: inserted missing EndDependentFn () ***/\n"); 411 } 412 return; 413 414 default: 415 break; 416 } 417 418 /* Disassemble the resource structure */ 419 420 if (Node) 421 { 422 ResourceName = Node->Name.Integer; 423 Node = Node->Peer; 424 } 425 426 AcpiGbl_DmResourceDispatch [ResourceIndex] ( 427 Aml, ResourceLength, Level); 428 429 /* Descriptor post-processing */ 430 431 if (ResourceType == ACPI_RESOURCE_NAME_START_DEPENDENT) 432 { 433 DependentFns = TRUE; 434 Level++; 435 } 436 } 437 } 438 439 440 /******************************************************************************* 441 * 442 * FUNCTION: AcpiDmIsResourceTemplate 443 * 444 * PARAMETERS: Op - Buffer Op to be examined 445 * 446 * RETURN: Status. AE_OK if valid template 447 * 448 * DESCRIPTION: Walk a byte list to determine if it consists of a valid set 449 * of resource descriptors. Nothing is output. 450 * 451 ******************************************************************************/ 452 453 ACPI_STATUS 454 AcpiDmIsResourceTemplate ( 455 ACPI_PARSE_OBJECT *Op) 456 { 457 ACPI_STATUS Status; 458 ACPI_PARSE_OBJECT *NextOp; 459 UINT8 *Aml; 460 UINT8 *EndAml; 461 ACPI_SIZE Length; 462 463 464 /* This op must be a buffer */ 465 466 if (Op->Common.AmlOpcode != AML_BUFFER_OP) 467 { 468 return (AE_TYPE); 469 } 470 471 /* Get the ByteData list and length */ 472 473 NextOp = Op->Common.Value.Arg; 474 NextOp = NextOp->Common.Next; 475 if (!NextOp) 476 { 477 return (AE_TYPE); 478 } 479 480 Aml = NextOp->Named.Data; 481 Length = (ACPI_SIZE) NextOp->Common.Value.Integer; 482 483 /* Walk the byte list, abort on any invalid descriptor type or length */ 484 485 Status = AcpiUtWalkAmlResources (Aml, Length, NULL, &EndAml); 486 if (ACPI_FAILURE (Status)) 487 { 488 return (AE_TYPE); 489 } 490 491 /* 492 * For the resource template to be valid, one EndTag must appear 493 * at the very end of the ByteList, not before. (For proper disassembly 494 * of a ResourceTemplate, the buffer must not have any extra data after 495 * the EndTag.) 496 */ 497 if ((Aml + Length - sizeof (AML_RESOURCE_END_TAG)) != EndAml) 498 { 499 return (AE_AML_NO_RESOURCE_END_TAG); 500 } 501 502 /* 503 * All resource descriptors are valid, therefore this list appears 504 * to be a valid resource template 505 */ 506 return (AE_OK); 507 } 508 509 #endif 510