dmresrc.c revision 281075 
1/*******************************************************************************
2 *
3 * Module Name: dmresrc.c - Resource Descriptor disassembly
4 *
5 ******************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2015, Intel Corp.
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 *    notice, this list of conditions, and the following disclaimer,
16 *    without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 *    substantially similar to the "NO WARRANTY" disclaimer below
19 *    ("Disclaimer") and any redistribution must be conditioned upon
20 *    including a substantially similar Disclaimer requirement for further
21 *    binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 *    of any contributors may be used to endorse or promote products derived
24 *    from this software without specific prior written permission.
25 *
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
29 *
30 * NO WARRANTY
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
42 */
43
44#include <contrib/dev/acpica/include/acpi.h>
45#include <contrib/dev/acpica/include/accommon.h>
46#include <contrib/dev/acpica/include/amlcode.h>
47#include <contrib/dev/acpica/include/acdisasm.h>
48
49#ifdef ACPI_DISASSEMBLER
50
51#define _COMPONENT          ACPI_CA_DEBUGGER
52        ACPI_MODULE_NAME    ("dbresrc")
53
54
55/* Dispatch tables for Resource disassembly functions */
56
57static ACPI_RESOURCE_HANDLER    AcpiGbl_DmResourceDispatch [] =
58{
59    /* Small descriptors */
60
61    NULL,                           /* 0x00, Reserved */
62    NULL,                           /* 0x01, Reserved */
63    NULL,                           /* 0x02, Reserved */
64    NULL,                           /* 0x03, Reserved */
65    AcpiDmIrqDescriptor,            /* 0x04, ACPI_RESOURCE_NAME_IRQ_FORMAT */
66    AcpiDmDmaDescriptor,            /* 0x05, ACPI_RESOURCE_NAME_DMA_FORMAT */
67    AcpiDmStartDependentDescriptor, /* 0x06, ACPI_RESOURCE_NAME_START_DEPENDENT */
68    AcpiDmEndDependentDescriptor,   /* 0x07, ACPI_RESOURCE_NAME_END_DEPENDENT */
69    AcpiDmIoDescriptor,             /* 0x08, ACPI_RESOURCE_NAME_IO_PORT */
70    AcpiDmFixedIoDescriptor,        /* 0x09, ACPI_RESOURCE_NAME_FIXED_IO_PORT */
71    AcpiDmFixedDmaDescriptor,       /* 0x0A, ACPI_RESOURCE_NAME_FIXED_DMA */
72    NULL,                           /* 0x0B, Reserved */
73    NULL,                           /* 0x0C, Reserved */
74    NULL,                           /* 0x0D, Reserved */
75    AcpiDmVendorSmallDescriptor,    /* 0x0E, ACPI_RESOURCE_NAME_SMALL_VENDOR */
76    NULL,                           /* 0x0F, ACPI_RESOURCE_NAME_END_TAG (not used) */
77
78    /* Large descriptors */
79
80    NULL,                           /* 0x00, Reserved */
81    AcpiDmMemory24Descriptor,       /* 0x01, ACPI_RESOURCE_NAME_MEMORY_24 */
82    AcpiDmGenericRegisterDescriptor,/* 0x02, ACPI_RESOURCE_NAME_GENERIC_REGISTER */
83    NULL,                           /* 0x03, Reserved */
84    AcpiDmVendorLargeDescriptor,    /* 0x04, ACPI_RESOURCE_NAME_LARGE_VENDOR */
85    AcpiDmMemory32Descriptor,       /* 0x05, ACPI_RESOURCE_NAME_MEMORY_32 */
86    AcpiDmFixedMemory32Descriptor,  /* 0x06, ACPI_RESOURCE_NAME_FIXED_MEMORY_32 */
87    AcpiDmDwordDescriptor,          /* 0x07, ACPI_RESOURCE_NAME_DWORD_ADDRESS_SPACE */
88    AcpiDmWordDescriptor,           /* 0x08, ACPI_RESOURCE_NAME_WORD_ADDRESS_SPACE */
89    AcpiDmInterruptDescriptor,      /* 0x09, ACPI_RESOURCE_NAME_EXTENDED_XRUPT */
90    AcpiDmQwordDescriptor,          /* 0x0A, ACPI_RESOURCE_NAME_QWORD_ADDRESS_SPACE */
91    AcpiDmExtendedDescriptor,       /* 0x0B, ACPI_RESOURCE_NAME_EXTENDED_ADDRESS_SPACE */
92    AcpiDmGpioDescriptor,           /* 0x0C, ACPI_RESOURCE_NAME_GPIO */
93    NULL,                           /* 0x0D, Reserved */
94    AcpiDmSerialBusDescriptor       /* 0x0E, ACPI_RESOURCE_NAME_SERIAL_BUS */
95};
96
97
98/* Only used for single-threaded applications */
99/* TBD: remove when name is passed as parameter to the dump functions */
100
101static UINT32               ResourceName;
102
103
104/*******************************************************************************
105 *
106 * FUNCTION:    AcpiDmDescriptorName
107 *
108 * PARAMETERS:  None
109 *
110 * RETURN:      None
111 *
112 * DESCRIPTION: Emit a name for the descriptor if one is present (indicated
113 *              by the name being changed from the default name.) A name is only
114 *              emitted if a reference to the descriptor has been made somewhere
115 *              in the original ASL code.
116 *
117 ******************************************************************************/
118
119void
120AcpiDmDescriptorName (
121    void)
122{
123
124    if (ResourceName == ACPI_DEFAULT_RESNAME)
125    {
126        return;
127    }
128
129    AcpiOsPrintf ("%4.4s", (char *) &ResourceName);
130}
131
132
133/*******************************************************************************
134 *
135 * FUNCTION:    AcpiDmDumpInteger*
136 *
137 * PARAMETERS:  Value               - Value to emit
138 *              Name                - Associated name (emitted as a comment)
139 *
140 * RETURN:      None
141 *
142 * DESCRIPTION: Integer output helper functions
143 *
144 ******************************************************************************/
145
146void
147AcpiDmDumpInteger8 (
148    UINT8                   Value,
149    char                    *Name)
150{
151    AcpiOsPrintf ("0x%2.2X,               // %s\n", Value, Name);
152}
153
154void
155AcpiDmDumpInteger16 (
156    UINT16                  Value,
157    char                    *Name)
158{
159    AcpiOsPrintf ("0x%4.4X,             // %s\n", Value, Name);
160}
161
162void
163AcpiDmDumpInteger32 (
164    UINT32                  Value,
165    char                    *Name)
166{
167    AcpiOsPrintf ("0x%8.8X,         // %s\n", Value, Name);
168}
169
170void
171AcpiDmDumpInteger64 (
172    UINT64                  Value,
173    char                    *Name)
174{
175    AcpiOsPrintf ("0x%8.8X%8.8X, // %s\n", ACPI_FORMAT_UINT64 (Value), Name);
176}
177
178
179/*******************************************************************************
180 *
181 * FUNCTION:    AcpiDmBitList
182 *
183 * PARAMETERS:  Mask            - 16-bit value corresponding to 16 interrupt
184 *                                or DMA values
185 *
186 * RETURN:      None
187 *
188 * DESCRIPTION: Dump a bit mask as a list of individual interrupt/DMA levels.
189 *
190 ******************************************************************************/
191
192void
193AcpiDmBitList (
194    UINT16                  Mask)
195{
196    UINT32                  i;
197    BOOLEAN                 Previous = FALSE;
198
199
200    /* Open the initializer list */
201
202    AcpiOsPrintf ("{");
203
204    /* Examine each bit */
205
206    for (i = 0; i < 16; i++)
207    {
208        /* Only interested in bits that are set to 1 */
209
210        if (Mask & 1)
211        {
212            if (Previous)
213            {
214                AcpiOsPrintf (",");
215            }
216            Previous = TRUE;
217            AcpiOsPrintf ("%u", i);
218        }
219
220        Mask >>= 1;
221    }
222
223    /* Close list */
224
225    AcpiOsPrintf ("}\n");
226}
227
228
229/*******************************************************************************
230 *
231 * FUNCTION:    AcpiDmResourceTemplate
232 *
233 * PARAMETERS:  Info            - Curent parse tree walk info
234 *              ByteData        - Pointer to the byte list data
235 *              ByteCount       - Length of the byte list
236 *
237 * RETURN:      None
238 *
239 * DESCRIPTION: Dump the contents of a Resource Template containing a set of
240 *              Resource Descriptors.
241 *
242 ******************************************************************************/
243
244void
245AcpiDmResourceTemplate (
246    ACPI_OP_WALK_INFO       *Info,
247    ACPI_PARSE_OBJECT       *Op,
248    UINT8                   *ByteData,
249    UINT32                  ByteCount)
250{
251    ACPI_STATUS             Status;
252    UINT32                  CurrentByteOffset;
253    UINT8                   ResourceType;
254    UINT32                  ResourceLength;
255    void                    *Aml;
256    UINT32                  Level;
257    BOOLEAN                 DependentFns = FALSE;
258    UINT8                   ResourceIndex;
259    ACPI_NAMESPACE_NODE     *Node;
260
261
262    if (Op->Asl.AmlOpcode != AML_FIELD_OP)
263    {
264        Info->MappingOp = Op;
265    }
266
267    Level = Info->Level;
268    ResourceName = ACPI_DEFAULT_RESNAME;
269    Node = Op->Common.Node;
270    if (Node)
271    {
272        Node = Node->Child;
273    }
274
275    for (CurrentByteOffset = 0; CurrentByteOffset < ByteCount;)
276    {
277        Aml = &ByteData[CurrentByteOffset];
278
279        /* Get the descriptor type and length */
280
281        ResourceType = AcpiUtGetResourceType (Aml);
282        ResourceLength = AcpiUtGetResourceLength (Aml);
283
284        /* Validate the Resource Type and Resource Length */
285
286        Status = AcpiUtValidateResource (NULL, Aml, &ResourceIndex);
287        if (ACPI_FAILURE (Status))
288        {
289            AcpiOsPrintf ("/*** Could not validate Resource, type (%X) %s***/\n",
290                ResourceType, AcpiFormatException (Status));
291            return;
292        }
293
294        /* Point to next descriptor */
295
296        CurrentByteOffset += AcpiUtGetDescriptorLength (Aml);
297
298        /* Descriptor pre-processing */
299
300        switch (ResourceType)
301        {
302        case ACPI_RESOURCE_NAME_START_DEPENDENT:
303
304            /* Finish a previous StartDependentFns */
305
306            if (DependentFns)
307            {
308                Level--;
309                AcpiDmIndent (Level);
310                AcpiOsPrintf ("}\n");
311            }
312            break;
313
314        case ACPI_RESOURCE_NAME_END_DEPENDENT:
315
316            Level--;
317            DependentFns = FALSE;
318            break;
319
320        case ACPI_RESOURCE_NAME_END_TAG:
321
322            /* Normal exit, the resource list is finished */
323
324            if (DependentFns)
325            {
326                /*
327                 * Close an open StartDependentDescriptor. This indicates a
328                 * missing EndDependentDescriptor.
329                 */
330                Level--;
331                DependentFns = FALSE;
332
333                /* Go ahead and insert EndDependentFn() */
334
335                AcpiDmEndDependentDescriptor (Info, Aml, ResourceLength, Level);
336
337                AcpiDmIndent (Level);
338                AcpiOsPrintf (
339                    "/*** Disassembler: inserted missing EndDependentFn () ***/\n");
340            }
341            return;
342
343        default:
344
345            break;
346        }
347
348        /* Disassemble the resource structure */
349
350        if (Node)
351        {
352            ResourceName = Node->Name.Integer;
353            Node = Node->Peer;
354        }
355
356        AcpiGbl_DmResourceDispatch [ResourceIndex] (
357            Info, Aml, ResourceLength, Level);
358
359        /* Descriptor post-processing */
360
361        if (ResourceType == ACPI_RESOURCE_NAME_START_DEPENDENT)
362        {
363            DependentFns = TRUE;
364            Level++;
365        }
366    }
367}
368
369
370/*******************************************************************************
371 *
372 * FUNCTION:    AcpiDmIsResourceTemplate
373 *
374 * PARAMETERS:  WalkState           - Current walk info
375 *              Op                  - Buffer Op to be examined
376 *
377 * RETURN:      Status. AE_OK if valid template
378 *
379 * DESCRIPTION: Walk a byte list to determine if it consists of a valid set
380 *              of resource descriptors. Nothing is output.
381 *
382 ******************************************************************************/
383
384ACPI_STATUS
385AcpiDmIsResourceTemplate (
386    ACPI_WALK_STATE         *WalkState,
387    ACPI_PARSE_OBJECT       *Op)
388{
389    ACPI_STATUS             Status;
390    ACPI_PARSE_OBJECT       *NextOp;
391    UINT8                   *Aml;
392    UINT8                   *EndAml;
393    ACPI_SIZE               Length;
394
395
396    /* This op must be a buffer */
397
398    if (Op->Common.AmlOpcode != AML_BUFFER_OP)
399    {
400        return (AE_TYPE);
401    }
402
403    /* Get the ByteData list and length */
404
405    NextOp = Op->Common.Value.Arg;
406    if (!NextOp)
407    {
408        AcpiOsPrintf ("NULL byte list in buffer\n");
409        return (AE_TYPE);
410    }
411
412    NextOp = NextOp->Common.Next;
413    if (!NextOp)
414    {
415        return (AE_TYPE);
416    }
417
418    Aml = NextOp->Named.Data;
419    Length = (ACPI_SIZE) NextOp->Common.Value.Integer;
420
421    /* Walk the byte list, abort on any invalid descriptor type or length */
422
423    Status = AcpiUtWalkAmlResources (WalkState, Aml, Length,
424        NULL, ACPI_CAST_INDIRECT_PTR (void, &EndAml));
425    if (ACPI_FAILURE (Status))
426    {
427        return (AE_TYPE);
428    }
429
430    /*
431     * For the resource template to be valid, one EndTag must appear
432     * at the very end of the ByteList, not before. (For proper disassembly
433     * of a ResourceTemplate, the buffer must not have any extra data after
434     * the EndTag.)
435     */
436    if ((Aml + Length - sizeof (AML_RESOURCE_END_TAG)) != EndAml)
437    {
438        return (AE_AML_NO_RESOURCE_END_TAG);
439    }
440
441    /*
442     * All resource descriptors are valid, therefore this list appears
443     * to be a valid resource template
444     */
445    return (AE_OK);
446}
447
448#endif
449