dmutils.c revision 193267 
1/*******************************************************************************
2 *
3 * Module Name: dmutils - AML disassembler utilities
4 *
5 ******************************************************************************/
6
7/******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2009, 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
117#include "acpi.h"
118#include "accommon.h"
119#include "amlcode.h"
120#include "acdisasm.h"
121
122#ifdef ACPI_ASL_COMPILER
123#include <acnamesp.h>
124#endif
125
126#ifdef ACPI_DISASSEMBLER
127
128#define _COMPONENT          ACPI_CA_DEBUGGER
129        ACPI_MODULE_NAME    ("dmutils")
130
131
132ACPI_EXTERNAL_LIST              *AcpiGbl_ExternalList = NULL;
133
134
135/* Data used in keeping track of fields */
136#if 0
137const char                      *AcpiGbl_FENames[] =
138{
139    "skip",
140    "?access?"
141};              /* FE = Field Element */
142#endif
143
144/* Operators for Match() */
145
146const char                      *AcpiGbl_MatchOps[] =
147{
148    "MTR",
149    "MEQ",
150    "MLE",
151    "MLT",
152    "MGE",
153    "MGT"
154};
155
156/* Access type decoding */
157
158const char                      *AcpiGbl_AccessTypes[] =
159{
160    "AnyAcc",
161    "ByteAcc",
162    "WordAcc",
163    "DWordAcc",
164    "QWordAcc",
165    "BufferAcc",
166    "InvalidAccType",
167    "InvalidAccType"
168};
169
170/* Lock rule decoding */
171
172const char                      *AcpiGbl_LockRule[] =
173{
174    "NoLock",
175    "Lock"
176};
177
178/* Update rule decoding */
179
180const char                      *AcpiGbl_UpdateRules[] =
181{
182    "Preserve",
183    "WriteAsOnes",
184    "WriteAsZeros",
185    "InvalidUpdateRule"
186};
187
188/* Strings used to decode resource descriptors */
189
190const char                      *AcpiGbl_WordDecode[] =
191{
192    "Memory",
193    "IO",
194    "BusNumber",
195    "UnknownResourceType"
196};
197
198const char                      *AcpiGbl_IrqDecode[] =
199{
200    "IRQNoFlags",
201    "IRQ"
202};
203
204
205#ifdef ACPI_ASL_COMPILER
206/*******************************************************************************
207 *
208 * FUNCTION:    AcpiDmAddToExternalList
209 *
210 * PARAMETERS:  Path            - Internal (AML) path to the object
211 *
212 * RETURN:      None
213 *
214 * DESCRIPTION: Insert a new path into the list of Externals which will in
215 *              turn be emitted as an External() declaration in the disassembled
216 *              output.
217 *
218 ******************************************************************************/
219
220void
221AcpiDmAddToExternalList (
222    char                    *Path,
223    UINT8                   Type,
224    UINT32                  Value)
225{
226    char                    *ExternalPath;
227    ACPI_EXTERNAL_LIST      *NewExternal;
228    ACPI_EXTERNAL_LIST      *NextExternal;
229    ACPI_EXTERNAL_LIST      *PrevExternal = NULL;
230    ACPI_STATUS             Status;
231
232
233    if (!Path)
234    {
235        return;
236    }
237
238    /* Externalize the ACPI path */
239
240    Status = AcpiNsExternalizeName (ACPI_UINT32_MAX, Path,
241                    NULL, &ExternalPath);
242    if (ACPI_FAILURE (Status))
243    {
244        return;
245    }
246
247    /* Ensure that we don't have duplicate externals */
248
249    NextExternal = AcpiGbl_ExternalList;
250    while (NextExternal)
251    {
252        /* Allow upgrade of type from ANY */
253
254        if (!ACPI_STRCMP (ExternalPath, NextExternal->Path))
255        {
256            /* Duplicate method, check that the Value (ArgCount) is the same */
257
258            if ((NextExternal->Type == ACPI_TYPE_METHOD) &&
259                (NextExternal->Value != Value))
260            {
261                ACPI_ERROR ((AE_INFO, "Argument count mismatch for method %s %d %d",
262                    NextExternal->Path, NextExternal->Value, Value));
263            }
264            if (NextExternal->Type == ACPI_TYPE_ANY)
265            {
266                NextExternal->Type = Type;
267                NextExternal->Value = Value;
268            }
269            ACPI_FREE (ExternalPath);
270            return;
271        }
272        NextExternal = NextExternal->Next;
273    }
274
275    /* Allocate and init a new External() descriptor */
276
277    NewExternal = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_EXTERNAL_LIST));
278    NewExternal->InternalPath = Path;
279    NewExternal->Path = ExternalPath;
280    NewExternal->Type = Type;
281    NewExternal->Value = Value;
282    NewExternal->Length = (UINT16) ACPI_STRLEN (ExternalPath);
283
284    /* Link the new descriptor into the global list, ordered by string length */
285
286    NextExternal = AcpiGbl_ExternalList;
287    while (NextExternal)
288    {
289        if (NewExternal->Length <= NextExternal->Length)
290        {
291            if (PrevExternal)
292            {
293                PrevExternal->Next = NewExternal;
294            }
295            else
296            {
297                AcpiGbl_ExternalList = NewExternal;
298            }
299
300            NewExternal->Next = NextExternal;
301            return;
302        }
303
304        PrevExternal = NextExternal;
305        NextExternal = NextExternal->Next;
306    }
307
308    if (PrevExternal)
309    {
310        PrevExternal->Next = NewExternal;
311    }
312    else
313    {
314        AcpiGbl_ExternalList = NewExternal;
315    }
316}
317#endif
318
319
320/*******************************************************************************
321 *
322 * FUNCTION:    AcpiDmDecodeAttribute
323 *
324 * PARAMETERS:  Attribute       - Attribute field of AccessAs keyword
325 *
326 * RETURN:      None
327 *
328 * DESCRIPTION: Decode the AccessAs attribute byte.  (Mostly SMBus stuff)
329 *
330 ******************************************************************************/
331
332void
333AcpiDmDecodeAttribute (
334    UINT8                   Attribute)
335{
336
337    switch (Attribute)
338    {
339    case AML_FIELD_ATTRIB_SMB_QUICK:
340
341        AcpiOsPrintf ("SMBQuick");
342        break;
343
344    case AML_FIELD_ATTRIB_SMB_SEND_RCV:
345
346        AcpiOsPrintf ("SMBSendReceive");
347        break;
348
349    case AML_FIELD_ATTRIB_SMB_BYTE:
350
351        AcpiOsPrintf ("SMBByte");
352        break;
353
354    case AML_FIELD_ATTRIB_SMB_WORD:
355
356        AcpiOsPrintf ("SMBWord");
357        break;
358
359    case AML_FIELD_ATTRIB_SMB_WORD_CALL:
360
361        AcpiOsPrintf ("SMBProcessCall");
362        break;
363
364    case AML_FIELD_ATTRIB_SMB_BLOCK:
365
366        AcpiOsPrintf ("SMBBlock");
367        break;
368
369    case AML_FIELD_ATTRIB_SMB_BLOCK_CALL:
370
371        AcpiOsPrintf ("SMBBlockProcessCall");
372        break;
373
374    default:
375
376        AcpiOsPrintf ("0x%.2X", Attribute);
377        break;
378    }
379}
380
381
382/*******************************************************************************
383 *
384 * FUNCTION:    AcpiDmIndent
385 *
386 * PARAMETERS:  Level               - Current source code indentation level
387 *
388 * RETURN:      None
389 *
390 * DESCRIPTION: Indent 4 spaces per indentation level.
391 *
392 ******************************************************************************/
393
394void
395AcpiDmIndent (
396    UINT32                  Level)
397{
398
399    if (!Level)
400    {
401        return;
402    }
403
404    AcpiOsPrintf ("%*.s", ACPI_MUL_4 (Level), " ");
405}
406
407
408/*******************************************************************************
409 *
410 * FUNCTION:    AcpiDmCommaIfListMember
411 *
412 * PARAMETERS:  Op              - Current operator/operand
413 *
414 * RETURN:      TRUE if a comma was inserted
415 *
416 * DESCRIPTION: Insert a comma if this Op is a member of an argument list.
417 *
418 ******************************************************************************/
419
420BOOLEAN
421AcpiDmCommaIfListMember (
422    ACPI_PARSE_OBJECT       *Op)
423{
424
425    if (!Op->Common.Next)
426    {
427        return FALSE;
428    }
429
430    if (AcpiDmListType (Op->Common.Parent) & BLOCK_COMMA_LIST)
431    {
432        /* Check for a NULL target operand */
433
434        if ((Op->Common.Next->Common.AmlOpcode == AML_INT_NAMEPATH_OP) &&
435            (!Op->Common.Next->Common.Value.String))
436        {
437            /*
438             * To handle the Divide() case where there are two optional
439             * targets, look ahead one more op.  If null, this null target
440             * is the one and only target -- no comma needed.  Otherwise,
441             * we need a comma to prepare for the next target.
442             */
443            if (!Op->Common.Next->Common.Next)
444            {
445                return FALSE;
446            }
447        }
448
449        if ((Op->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST) &&
450            (!(Op->Common.Next->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST)))
451        {
452            return FALSE;
453        }
454
455        AcpiOsPrintf (", ");
456        return (TRUE);
457    }
458
459    else if ((Op->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST) &&
460             (Op->Common.Next->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST))
461    {
462        AcpiOsPrintf (", ");
463        return (TRUE);
464    }
465
466    return (FALSE);
467}
468
469
470/*******************************************************************************
471 *
472 * FUNCTION:    AcpiDmCommaIfFieldMember
473 *
474 * PARAMETERS:  Op              - Current operator/operand
475 *
476 * RETURN:      None
477 *
478 * DESCRIPTION: Insert a comma if this Op is a member of a Field argument list.
479 *
480 ******************************************************************************/
481
482void
483AcpiDmCommaIfFieldMember (
484    ACPI_PARSE_OBJECT       *Op)
485{
486
487    if (Op->Common.Next)
488    {
489        AcpiOsPrintf (", ");
490    }
491}
492
493#endif
494