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