xref: /freebsd/sys/contrib/dev/acpica/components/disassembler/dmresrcs.c (revision 722b16673c40aedf280895f2f2f676bb494518d7)
1 /*******************************************************************************
2  *
3  * Module Name: dmresrcs.c - "Small" Resource Descriptor disassembly
4  *
5  ******************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2023, 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/acdisasm.h>
155 
156 
157 #define _COMPONENT          ACPI_CA_DEBUGGER
158         ACPI_MODULE_NAME    ("dbresrcs")
159 
160 
161 /*******************************************************************************
162  *
163  * FUNCTION:    AcpiDmIrqDescriptor
164  *
165  * PARAMETERS:  Info                - Extra resource info
166  *              Resource            - Pointer to the resource descriptor
167  *              Length              - Length of the descriptor in bytes
168  *              Level               - Current source code indentation level
169  *
170  * RETURN:      None
171  *
172  * DESCRIPTION: Decode a IRQ descriptor, either Irq() or IrqNoFlags()
173  *
174  ******************************************************************************/
175 
176 void
AcpiDmIrqDescriptor(ACPI_OP_WALK_INFO * Info,AML_RESOURCE * Resource,UINT32 Length,UINT32 Level)177 AcpiDmIrqDescriptor (
178     ACPI_OP_WALK_INFO       *Info,
179     AML_RESOURCE            *Resource,
180     UINT32                  Length,
181     UINT32                  Level)
182 {
183 
184     AcpiDmIndent (Level);
185     AcpiOsPrintf ("%s (",
186         AcpiGbl_IrqDecode [ACPI_GET_1BIT_FLAG (Length)]);
187 
188     /* Decode flags byte if present */
189 
190     if (Length & 1)
191     {
192         AcpiOsPrintf ("%s, %s, %s, ",
193             AcpiGbl_HeDecode [ACPI_GET_1BIT_FLAG (Resource->Irq.Flags)],
194             AcpiGbl_LlDecode [ACPI_EXTRACT_1BIT_FLAG (Resource->Irq.Flags, 3)],
195             AcpiGbl_ShrDecode [ACPI_EXTRACT_2BIT_FLAG (Resource->Irq.Flags, 4)]);
196     }
197 
198     /* Insert a descriptor name */
199 
200     AcpiDmDescriptorName ();
201     AcpiOsPrintf (")\n");
202 
203     AcpiDmIndent (Level + 1);
204     AcpiDmBitList (Resource->Irq.IrqMask);
205 }
206 
207 
208 /*******************************************************************************
209  *
210  * FUNCTION:    AcpiDmDmaDescriptor
211  *
212  * PARAMETERS:  Info                - Extra resource info
213  *              Resource            - Pointer to the resource descriptor
214  *              Length              - Length of the descriptor in bytes
215  *              Level               - Current source code indentation level
216  *
217  * RETURN:      None
218  *
219  * DESCRIPTION: Decode a DMA descriptor
220  *
221  ******************************************************************************/
222 
223 void
AcpiDmDmaDescriptor(ACPI_OP_WALK_INFO * Info,AML_RESOURCE * Resource,UINT32 Length,UINT32 Level)224 AcpiDmDmaDescriptor (
225     ACPI_OP_WALK_INFO       *Info,
226     AML_RESOURCE            *Resource,
227     UINT32                  Length,
228     UINT32                  Level)
229 {
230 
231     AcpiDmIndent (Level);
232     AcpiOsPrintf ("DMA (%s, %s, %s, ",
233         AcpiGbl_TypDecode [ACPI_EXTRACT_2BIT_FLAG (Resource->Dma.Flags, 5)],
234         AcpiGbl_BmDecode  [ACPI_EXTRACT_1BIT_FLAG (Resource->Dma.Flags, 2)],
235         AcpiGbl_SizDecode [ACPI_GET_2BIT_FLAG (Resource->Dma.Flags)]);
236 
237     /* Insert a descriptor name */
238 
239     AcpiDmDescriptorName ();
240     AcpiOsPrintf (")\n");
241 
242     AcpiDmIndent (Level + 1);
243     AcpiDmBitList (Resource->Dma.DmaChannelMask);
244 }
245 
246 
247 /*******************************************************************************
248  *
249  * FUNCTION:    AcpiDmFixedDmaDescriptor
250  *
251  * PARAMETERS:  Info                - Extra resource info
252  *              Resource            - Pointer to the resource descriptor
253  *              Length              - Length of the descriptor in bytes
254  *              Level               - Current source code indentation level
255  *
256  * RETURN:      None
257  *
258  * DESCRIPTION: Decode a FixedDMA descriptor
259  *
260  ******************************************************************************/
261 
262 void
AcpiDmFixedDmaDescriptor(ACPI_OP_WALK_INFO * Info,AML_RESOURCE * Resource,UINT32 Length,UINT32 Level)263 AcpiDmFixedDmaDescriptor (
264     ACPI_OP_WALK_INFO       *Info,
265     AML_RESOURCE            *Resource,
266     UINT32                  Length,
267     UINT32                  Level)
268 {
269 
270     AcpiDmIndent (Level);
271     AcpiOsPrintf ("FixedDMA (0x%4.4X, 0x%4.4X, ",
272         Resource->FixedDma.RequestLines,
273         Resource->FixedDma.Channels);
274 
275     if (Resource->FixedDma.Width <= 5)
276     {
277         AcpiOsPrintf ("%s, ",
278             AcpiGbl_DtsDecode [Resource->FixedDma.Width]);
279     }
280     else
281     {
282         AcpiOsPrintf ("%X /* INVALID DMA WIDTH */, ",
283             Resource->FixedDma.Width);
284     }
285 
286     /* Insert a descriptor name */
287 
288     AcpiDmDescriptorName ();
289     AcpiOsPrintf (")\n");
290 }
291 
292 
293 /*******************************************************************************
294  *
295  * FUNCTION:    AcpiDmIoDescriptor
296  *
297  * PARAMETERS:  Info                - Extra resource info
298  *              Resource            - Pointer to the resource descriptor
299  *              Length              - Length of the descriptor in bytes
300  *              Level               - Current source code indentation level
301  *
302  * RETURN:      None
303  *
304  * DESCRIPTION: Decode an IO descriptor
305  *
306  ******************************************************************************/
307 
308 void
AcpiDmIoDescriptor(ACPI_OP_WALK_INFO * Info,AML_RESOURCE * Resource,UINT32 Length,UINT32 Level)309 AcpiDmIoDescriptor (
310     ACPI_OP_WALK_INFO       *Info,
311     AML_RESOURCE            *Resource,
312     UINT32                  Length,
313     UINT32                  Level)
314 {
315 
316     AcpiDmIndent (Level);
317     AcpiOsPrintf ("IO (%s,\n",
318         AcpiGbl_IoDecode [ACPI_GET_1BIT_FLAG (Resource->Io.Flags)]);
319 
320     AcpiDmIndent (Level + 1);
321     AcpiDmDumpInteger16 (Resource->Io.Minimum, "Range Minimum");
322 
323     AcpiDmIndent (Level + 1);
324     AcpiDmDumpInteger16 (Resource->Io.Maximum, "Range Maximum");
325 
326     AcpiDmIndent (Level + 1);
327     AcpiDmDumpInteger8 (Resource->Io.Alignment, "Alignment");
328 
329     AcpiDmIndent (Level + 1);
330     AcpiDmDumpInteger8 (Resource->Io.AddressLength, "Length");
331 
332     /* Insert a descriptor name */
333 
334     AcpiDmIndent (Level + 1);
335     AcpiDmDescriptorName ();
336     AcpiOsPrintf (")\n");
337 }
338 
339 
340 /*******************************************************************************
341  *
342  * FUNCTION:    AcpiDmFixedIoDescriptor
343  *
344  * PARAMETERS:  Info                - Extra resource info
345  *              Resource            - Pointer to the resource descriptor
346  *              Length              - Length of the descriptor in bytes
347  *              Level               - Current source code indentation level
348  *
349  * RETURN:      None
350  *
351  * DESCRIPTION: Decode a Fixed IO descriptor
352  *
353  ******************************************************************************/
354 
355 void
AcpiDmFixedIoDescriptor(ACPI_OP_WALK_INFO * Info,AML_RESOURCE * Resource,UINT32 Length,UINT32 Level)356 AcpiDmFixedIoDescriptor (
357     ACPI_OP_WALK_INFO       *Info,
358     AML_RESOURCE            *Resource,
359     UINT32                  Length,
360     UINT32                  Level)
361 {
362 
363     AcpiDmIndent (Level);
364     AcpiOsPrintf ("FixedIO (\n");
365 
366     AcpiDmIndent (Level + 1);
367     AcpiDmDumpInteger16 (Resource->FixedIo.Address, "Address");
368 
369     AcpiDmIndent (Level + 1);
370     AcpiDmDumpInteger8 (Resource->FixedIo.AddressLength, "Length");
371 
372     /* Insert a descriptor name */
373 
374     AcpiDmIndent (Level + 1);
375     AcpiDmDescriptorName ();
376     AcpiOsPrintf (")\n");
377 }
378 
379 
380 /*******************************************************************************
381  *
382  * FUNCTION:    AcpiDmStartDependentDescriptor
383  *
384  * PARAMETERS:  Info                - Extra resource info
385  *              Resource            - Pointer to the resource descriptor
386  *              Length              - Length of the descriptor in bytes
387  *              Level               - Current source code indentation level
388  *
389  * RETURN:      None
390  *
391  * DESCRIPTION: Decode a Start Dependent functions descriptor
392  *
393  ******************************************************************************/
394 
395 void
AcpiDmStartDependentDescriptor(ACPI_OP_WALK_INFO * Info,AML_RESOURCE * Resource,UINT32 Length,UINT32 Level)396 AcpiDmStartDependentDescriptor (
397     ACPI_OP_WALK_INFO       *Info,
398     AML_RESOURCE            *Resource,
399     UINT32                  Length,
400     UINT32                  Level)
401 {
402 
403     AcpiDmIndent (Level);
404 
405     if (Length & 1)
406     {
407         AcpiOsPrintf ("StartDependentFn (0x%2.2X, 0x%2.2X)\n",
408             (UINT32) ACPI_GET_2BIT_FLAG (Resource->StartDpf.Flags),
409             (UINT32) ACPI_EXTRACT_2BIT_FLAG (Resource->StartDpf.Flags, 2));
410     }
411     else
412     {
413         AcpiOsPrintf ("StartDependentFnNoPri ()\n");
414     }
415 
416     AcpiDmIndent (Level);
417     AcpiOsPrintf ("{\n");
418 }
419 
420 
421 /*******************************************************************************
422  *
423  * FUNCTION:    AcpiDmEndDependentDescriptor
424  *
425  * PARAMETERS:  Info                - Extra resource info
426  *              Resource            - Pointer to the resource descriptor
427  *              Length              - Length of the descriptor in bytes
428  *              Level               - Current source code indentation level
429  *
430  * RETURN:      None
431  *
432  * DESCRIPTION: Decode an End Dependent functions descriptor
433  *
434  ******************************************************************************/
435 
436 void
AcpiDmEndDependentDescriptor(ACPI_OP_WALK_INFO * Info,AML_RESOURCE * Resource,UINT32 Length,UINT32 Level)437 AcpiDmEndDependentDescriptor (
438     ACPI_OP_WALK_INFO       *Info,
439     AML_RESOURCE            *Resource,
440     UINT32                  Length,
441     UINT32                  Level)
442 {
443 
444     AcpiDmIndent (Level);
445     AcpiOsPrintf ("}\n");
446     AcpiDmIndent (Level);
447     AcpiOsPrintf ("EndDependentFn ()\n");
448 }
449 
450 
451 /*******************************************************************************
452  *
453  * FUNCTION:    AcpiDmVendorSmallDescriptor
454  *
455  * PARAMETERS:  Info                - Extra resource info
456  *              Resource            - Pointer to the resource descriptor
457  *              Length              - Length of the descriptor in bytes
458  *              Level               - Current source code indentation level
459  *
460  * RETURN:      None
461  *
462  * DESCRIPTION: Decode a Vendor Small Descriptor
463  *
464  ******************************************************************************/
465 
466 void
AcpiDmVendorSmallDescriptor(ACPI_OP_WALK_INFO * Info,AML_RESOURCE * Resource,UINT32 Length,UINT32 Level)467 AcpiDmVendorSmallDescriptor (
468     ACPI_OP_WALK_INFO       *Info,
469     AML_RESOURCE            *Resource,
470     UINT32                  Length,
471     UINT32                  Level)
472 {
473 
474     AcpiDmVendorCommon ("Short",
475         ACPI_ADD_PTR (UINT8, Resource, sizeof (AML_RESOURCE_SMALL_HEADER)),
476         Length, Level);
477 }
478