1 /*******************************************************************************
3 * Module Name: dmresrc.c - Resource Descriptor disassembly
5 ******************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2017, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
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.
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.
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.
150 *****************************************************************************/
153 #include "accommon.h"
155 #include "acdisasm.h"
157 #ifdef ACPI_DISASSEMBLER
159 #define _COMPONENT ACPI_CA_DEBUGGER
160 ACPI_MODULE_NAME ("dbresrc")
163 /* Dispatch tables for Resource disassembly functions */
165 static ACPI_RESOURCE_HANDLER AcpiGbl_DmResourceDispatch
[] =
167 /* Small descriptors */
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) */
186 /* Large descriptors */
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 AcpiDmPinFunctionDescriptor
, /* 0x0D, ACPI_RESOURCE_NAME_PIN_FUNCTION */
202 AcpiDmSerialBusDescriptor
, /* 0x0E, ACPI_RESOURCE_NAME_SERIAL_BUS */
203 AcpiDmPinConfigDescriptor
, /* 0x0F, ACPI_RESOURCE_NAME_PIN_CONFIG */
204 AcpiDmPinGroupDescriptor
, /* 0x10, ACPI_RESOURCE_NAME_PIN_GROUP */
205 AcpiDmPinGroupFunctionDescriptor
, /* 0x11, ACPI_RESOURCE_NAME_PIN_GROUP_FUNCTION */
206 AcpiDmPinGroupConfigDescriptor
, /* 0x12, ACPI_RESOURCE_NAME_PIN_GROUP_CONFIG */
210 /* Only used for single-threaded applications */
211 /* TBD: remove when name is passed as parameter to the dump functions */
213 static UINT32 ResourceName
;
216 /*******************************************************************************
218 * FUNCTION: AcpiDmDescriptorName
224 * DESCRIPTION: Emit a name for the descriptor if one is present (indicated
225 * by the name being changed from the default name.) A name is only
226 * emitted if a reference to the descriptor has been made somewhere
227 * in the original ASL code.
229 ******************************************************************************/
232 AcpiDmDescriptorName (
236 if (ResourceName
== ACPI_DEFAULT_RESNAME
)
241 AcpiOsPrintf ("%4.4s", (char *) &ResourceName
);
245 /*******************************************************************************
247 * FUNCTION: AcpiDmDumpInteger*
249 * PARAMETERS: Value - Value to emit
250 * Name - Associated name (emitted as a comment)
254 * DESCRIPTION: Integer output helper functions
256 ******************************************************************************/
263 AcpiOsPrintf ("0x%2.2X, // %s\n", Value
, Name
);
267 AcpiDmDumpInteger16 (
271 AcpiOsPrintf ("0x%4.4X, // %s\n", Value
, Name
);
275 AcpiDmDumpInteger32 (
279 AcpiOsPrintf ("0x%8.8X, // %s\n", Value
, Name
);
283 AcpiDmDumpInteger64 (
287 AcpiOsPrintf ("0x%8.8X%8.8X, // %s\n", ACPI_FORMAT_UINT64 (Value
), Name
);
291 /*******************************************************************************
293 * FUNCTION: AcpiDmBitList
295 * PARAMETERS: Mask - 16-bit value corresponding to 16 interrupt
300 * DESCRIPTION: Dump a bit mask as a list of individual interrupt/DMA levels.
302 ******************************************************************************/
309 BOOLEAN Previous
= FALSE
;
312 /* Open the initializer list */
316 /* Examine each bit */
318 for (i
= 0; i
< 16; i
++)
320 /* Only interested in bits that are set to 1 */
330 AcpiOsPrintf ("%u", i
);
338 AcpiOsPrintf ("}\n");
342 /*******************************************************************************
344 * FUNCTION: AcpiDmResourceTemplate
346 * PARAMETERS: Info - Curent parse tree walk info
347 * ByteData - Pointer to the byte list data
348 * ByteCount - Length of the byte list
352 * DESCRIPTION: Dump the contents of a Resource Template containing a set of
353 * Resource Descriptors.
355 ******************************************************************************/
358 AcpiDmResourceTemplate (
359 ACPI_OP_WALK_INFO
*Info
,
360 ACPI_PARSE_OBJECT
*Op
,
365 UINT32 CurrentByteOffset
;
367 UINT32 ResourceLength
;
370 BOOLEAN DependentFns
= FALSE
;
372 ACPI_NAMESPACE_NODE
*Node
;
375 if (Op
->Asl
.AmlOpcode
!= AML_FIELD_OP
)
377 Info
->MappingOp
= Op
;
381 ResourceName
= ACPI_DEFAULT_RESNAME
;
382 Node
= Op
->Common
.Node
;
388 for (CurrentByteOffset
= 0; CurrentByteOffset
< ByteCount
;)
390 Aml
= &ByteData
[CurrentByteOffset
];
392 /* Get the descriptor type and length */
394 ResourceType
= AcpiUtGetResourceType (Aml
);
395 ResourceLength
= AcpiUtGetResourceLength (Aml
);
397 /* Validate the Resource Type and Resource Length */
399 Status
= AcpiUtValidateResource (NULL
, Aml
, &ResourceIndex
);
400 if (ACPI_FAILURE (Status
))
403 "/*** Could not validate Resource, type (%X) %s***/\n",
404 ResourceType
, AcpiFormatException (Status
));
408 /* Point to next descriptor */
410 CurrentByteOffset
+= AcpiUtGetDescriptorLength (Aml
);
412 /* Descriptor pre-processing */
414 switch (ResourceType
)
416 case ACPI_RESOURCE_NAME_START_DEPENDENT
:
418 /* Finish a previous StartDependentFns */
423 AcpiDmIndent (Level
);
424 AcpiOsPrintf ("}\n");
428 case ACPI_RESOURCE_NAME_END_DEPENDENT
:
431 DependentFns
= FALSE
;
434 case ACPI_RESOURCE_NAME_END_TAG
:
436 /* Normal exit, the resource list is finished */
441 * Close an open StartDependentDescriptor. This indicates a
442 * missing EndDependentDescriptor.
445 DependentFns
= FALSE
;
447 /* Go ahead and insert EndDependentFn() */
449 AcpiDmEndDependentDescriptor (Info
, Aml
, ResourceLength
, Level
);
451 AcpiDmIndent (Level
);
453 "/*** Disassembler: inserted "
454 "missing EndDependentFn () ***/\n");
463 /* Disassemble the resource structure */
467 ResourceName
= Node
->Name
.Integer
;
471 AcpiGbl_DmResourceDispatch
[ResourceIndex
] (
472 Info
, Aml
, ResourceLength
, Level
);
474 /* Descriptor post-processing */
476 if (ResourceType
== ACPI_RESOURCE_NAME_START_DEPENDENT
)
485 /*******************************************************************************
487 * FUNCTION: AcpiDmIsResourceTemplate
489 * PARAMETERS: WalkState - Current walk info
490 * Op - Buffer Op to be examined
492 * RETURN: Status. AE_OK if valid template
494 * DESCRIPTION: Walk a byte list to determine if it consists of a valid set
495 * of resource descriptors. Nothing is output.
497 ******************************************************************************/
500 AcpiDmIsResourceTemplate (
501 ACPI_WALK_STATE
*WalkState
,
502 ACPI_PARSE_OBJECT
*Op
)
505 ACPI_PARSE_OBJECT
*NextOp
;
509 UINT32 DeclaredBufferLength
;
512 /* This op must be a buffer */
514 if (Op
->Common
.AmlOpcode
!= AML_BUFFER_OP
)
520 * Get the declared length of the buffer.
521 * This is the nn in "Buffer (nn)"
523 NextOp
= Op
->Common
.Value
.Arg
;
526 AcpiOsPrintf ("NULL byte list in buffer\n");
530 DeclaredBufferLength
= NextOp
->Common
.Value
.Size
;
532 /* Get the length of the raw initialization byte list */
534 NextOp
= NextOp
->Common
.Next
;
540 Aml
= NextOp
->Named
.Data
;
541 BufferLength
= NextOp
->Common
.Value
.Size
;
544 * Any buffer smaller than one byte cannot possibly be a resource
545 * template. Two bytes could possibly be a "NULL" resource template
546 * with a lone end tag descriptor (as generated via
547 * "ResourceTemplate(){}"), but this would be an extremely unusual
548 * case, as the template would be essentially useless. The disassembler
549 * therefore does not recognize any two-byte buffer as a resource
552 if (BufferLength
<= 2)
558 * Not a template if declared buffer length != actual length of the
559 * intialization byte list. Because the resource macros will create
560 * a buffer of the exact required length (buffer length will be equal
561 * to the actual length).
563 * NOTE (April 2017): Resource templates with this issue have been
564 * seen in the field. We still don't want to attempt to disassemble
565 * a buffer like this to a resource template because this output
566 * would not match the original input buffer (it would be shorter
567 * than the original when the disassembled code is recompiled).
568 * Basically, a buffer like this appears to be hand crafted in the
569 * first place, so just emitting a buffer object instead of a
570 * resource template more closely resembles the original ASL code.
572 if (DeclaredBufferLength
!= BufferLength
)
577 /* Walk the byte list, abort on any invalid descriptor type or length */
579 Status
= AcpiUtWalkAmlResources (WalkState
, Aml
, BufferLength
,
580 NULL
, ACPI_CAST_INDIRECT_PTR (void, &EndAml
));
581 if (ACPI_FAILURE (Status
))
587 * For the resource template to be valid, one EndTag must appear
588 * at the very end of the ByteList, not before. (For proper disassembly
589 * of a ResourceTemplate, the buffer must not have any extra data after
592 if ((Aml
+ BufferLength
- sizeof (AML_RESOURCE_END_TAG
)) != EndAml
)
594 return (AE_AML_NO_RESOURCE_END_TAG
);
598 * All resource descriptors are valid, therefore this list appears
599 * to be a valid resource template