dmutils.c revision 126372 
1/*******************************************************************************
2 *
3 * Module Name: dmutils - AML disassembler utilities
4 *              $Revision: 9 $
5 *
6 ******************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999 - 2004, Intel Corp.
13 * All rights reserved.
14 *
15 * 2. License
16 *
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights.  You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
20 * property rights.
21 *
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
28 *
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code.  No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
37 *
38 * The above copyright and patent license is granted only if the following
39 * conditions are met:
40 *
41 * 3. Conditions
42 *
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision.  In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change.  Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee.  Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
54 *
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution.  In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
65 * make.
66 *
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
71 * distribution.
72 *
73 * 3.4. Intel retains all right, title, and interest in and to the Original
74 * Intel Code.
75 *
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
80 *
81 * 4. Disclaimer and Export Compliance
82 *
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89 * PARTICULAR PURPOSE.
90 *
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
98 * LIMITED REMEDY.
99 *
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government.  In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
114 *
115 *****************************************************************************/
116
117
118#include "acpi.h"
119#include "amlcode.h"
120#include "acdisasm.h"
121
122
123#ifdef ACPI_DISASSEMBLER
124
125#define _COMPONENT          ACPI_CA_DEBUGGER
126        ACPI_MODULE_NAME    ("dmutils")
127
128
129/* Data used in keeping track of fields */
130#if 0
131const char                      *AcpiGbl_FENames[ACPI_NUM_FIELD_NAMES] =
132{
133    "skip",
134    "?access?"
135};              /* FE = Field Element */
136#endif
137
138
139const char                      *AcpiGbl_MatchOps[ACPI_NUM_MATCH_OPS] =
140{
141    "MTR",
142    "MEQ",
143    "MLE",
144    "MLT",
145    "MGE",
146    "MGT"
147};
148
149
150/* Access type decoding */
151
152const char                      *AcpiGbl_AccessTypes[ACPI_NUM_ACCESS_TYPES] =
153{
154    "AnyAcc",
155    "ByteAcc",
156    "WordAcc",
157    "DWordAcc",
158    "QWordAcc",
159    "BufferAcc",
160};
161
162
163/* Lock rule decoding */
164
165const char                      *AcpiGbl_LockRule[ACPI_NUM_LOCK_RULES] =
166{
167    "NoLock",
168    "Lock"
169};
170
171/* Update rule decoding */
172
173const char                      *AcpiGbl_UpdateRules[ACPI_NUM_UPDATE_RULES] =
174{
175    "Preserve",
176    "WriteAsOnes",
177    "WriteAsZeros"
178};
179
180/*
181 * Strings used to decode resource descriptors
182 */
183const char                      *AcpiGbl_IoDecode[2] =
184{
185    "Decode10",
186    "Decode16"
187};
188
189const char                      *AcpiGbl_WordDecode[4] =
190{
191    "WordMemory",
192    "WordIO",
193    "WordBusNumber",
194    "Unknown-resource-type"
195};
196
197const char                      *AcpiGbl_ConsumeDecode[2] =
198{
199    "ResourceProducer",
200    "ResourceConsumer"
201};
202
203const char                      *AcpiGbl_MinDecode[2] =
204{
205    "MinNotFixed",
206    "MinFixed"
207};
208
209const char                      *AcpiGbl_MaxDecode[2] =
210{
211    "MaxNotFixed",
212    "MaxFixed"
213};
214
215const char                      *AcpiGbl_DECDecode[2] =
216{
217    "PosDecode",
218    "SubDecode"
219};
220
221const char                      *AcpiGbl_RNGDecode[4] =
222{
223    "InvalidRanges",
224    "NonISAOnlyRanges",
225    "ISAOnlyRanges",
226    "EntireRange"
227};
228
229const char                      *AcpiGbl_MEMDecode[4] =
230{
231    "NonCacheable",
232    "Cacheable",
233    "WriteCombining",
234    "Prefetchable"
235};
236
237const char                      *AcpiGbl_RWDecode[2] =
238{
239    "ReadOnly",
240    "ReadWrite"
241};
242
243const char                      *AcpiGbl_IrqDecode[2] =
244{
245    "IRQNoFlags",
246    "IRQ"
247};
248
249const char                      *AcpiGbl_HEDecode[2] =
250{
251    "Level",
252    "Edge"
253};
254
255const char                      *AcpiGbl_LLDecode[2] =
256{
257    "ActiveHigh",
258    "ActiveLow"
259};
260
261const char                      *AcpiGbl_SHRDecode[2] =
262{
263    "Exclusive",
264    "Shared"
265};
266
267const char                      *AcpiGbl_TYPDecode[4] =
268{
269    "Compatibility",
270    "TypeA",
271    "TypeB",
272    "TypeF"
273};
274
275const char                      *AcpiGbl_BMDecode[2] =
276{
277    "NotBusMaster",
278    "BusMaster"
279};
280
281const char                      *AcpiGbl_SIZDecode[4] =
282{
283    "Transfer8",
284    "Transfer8_16",
285    "Transfer16",
286    "InvalidSize"
287};
288
289
290/*******************************************************************************
291 *
292 * FUNCTION:    AcpiDmDecodeAttribute
293 *
294 * PARAMETERS:  Attribute       - Attribute field of AccessAs keyword
295 *
296 * RETURN:      None
297 *
298 * DESCRIPTION: Decode the AccessAs attribute byte.  (Mostly SMBus stuff)
299 *
300 ******************************************************************************/
301
302void
303AcpiDmDecodeAttribute (
304    UINT8                   Attribute)
305{
306
307    switch (Attribute)
308    {
309    case AML_FIELD_ATTRIB_SMB_QUICK:
310
311        AcpiOsPrintf ("SMBQuick");
312        break;
313
314    case AML_FIELD_ATTRIB_SMB_SEND_RCV:
315
316        AcpiOsPrintf ("SMBSendReceive");
317        break;
318
319    case AML_FIELD_ATTRIB_SMB_BYTE:
320
321        AcpiOsPrintf ("SMBByte");
322        break;
323
324    case AML_FIELD_ATTRIB_SMB_WORD:
325
326        AcpiOsPrintf ("SMBWord");
327        break;
328
329    case AML_FIELD_ATTRIB_SMB_WORD_CALL:
330
331        AcpiOsPrintf ("SMBProcessCall");
332        break;
333
334    case AML_FIELD_ATTRIB_SMB_BLOCK:
335
336        AcpiOsPrintf ("SMBBlock");
337        break;
338
339    case AML_FIELD_ATTRIB_SMB_BLOCK_CALL:
340
341        AcpiOsPrintf ("SMBBlockProcessCall");
342        break;
343
344    default:
345
346        AcpiOsPrintf ("0x%.2X", Attribute);
347        break;
348    }
349}
350
351
352/*******************************************************************************
353 *
354 * FUNCTION:    AcpiDmIndent
355 *
356 * PARAMETERS:  Level               - Current source code indentation level
357 *
358 * RETURN:      None
359 *
360 * DESCRIPTION: Indent 4 spaces per indentation level.
361 *
362 ******************************************************************************/
363
364void
365AcpiDmIndent (
366    UINT32                  Level)
367{
368
369    if (!Level)
370    {
371        return;
372    }
373
374    AcpiOsPrintf ("%*.s", ACPI_MUL_4 (Level), " ");
375}
376
377
378/*******************************************************************************
379 *
380 * FUNCTION:    AcpiDmCommaIfListMember
381 *
382 * PARAMETERS:  Op              - Current operator/operand
383 *
384 * RETURN:      TRUE if a comma was inserted
385 *
386 * DESCRIPTION: Insert a comma if this Op is a member of an argument list.
387 *
388 ******************************************************************************/
389
390BOOLEAN
391AcpiDmCommaIfListMember (
392    ACPI_PARSE_OBJECT       *Op)
393{
394
395    if (!Op->Common.Next)
396    {
397        return FALSE;
398    }
399
400    if (AcpiDmListType (Op->Common.Parent) & BLOCK_COMMA_LIST)
401    {
402        /* Check for a NULL target operand */
403
404        if ((Op->Common.Next->Common.AmlOpcode == AML_INT_NAMEPATH_OP) &&
405            (!Op->Common.Next->Common.Value.String))
406        {
407            /*
408             * To handle the Divide() case where there are two optional
409             * targets, look ahead one more op.  If null, this null target
410             * is the one and only target -- no comma needed.  Otherwise,
411             * we need a comma to prepare for the next target.
412             */
413            if (!Op->Common.Next->Common.Next)
414            {
415                return FALSE;
416            }
417        }
418
419        if ((Op->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST) &&
420            (!(Op->Common.Next->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST)))
421        {
422            return FALSE;
423        }
424
425        AcpiOsPrintf (", ");
426        return (TRUE);
427    }
428
429    else if ((Op->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST) &&
430             (Op->Common.Next->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST))
431    {
432        AcpiOsPrintf (", ");
433        return (TRUE);
434    }
435
436    return (FALSE);
437}
438
439
440/*******************************************************************************
441 *
442 * FUNCTION:    AcpiDmCommaIfFieldMember
443 *
444 * PARAMETERS:  Op              - Current operator/operand
445 *
446 * RETURN:      None
447 *
448 * DESCRIPTION: Insert a comma if this Op is a member of a Field argument list.
449 *
450 ******************************************************************************/
451
452void
453AcpiDmCommaIfFieldMember (
454    ACPI_PARSE_OBJECT       *Op)
455{
456
457    if (Op->Common.Next)
458    {
459        AcpiOsPrintf (", ");
460    }
461}
462
463
464#endif
465