acdisasm.h revision 107325 
1/******************************************************************************
2 *
3 * Name: acdisasm.h - AML disassembler
4 *       $Revision: 5 $
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999 - 2002, 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#ifndef __ACDISASM_H__
118#define __ACDISASM_H__
119
120#include "amlresrc.h"
121
122
123#define BLOCK_NONE              0
124#define BLOCK_PAREN             1
125#define BLOCK_BRACE             2
126#define BLOCK_COMMA_LIST        4
127
128extern const char               *AcpiGbl_IoDecode[2];
129extern const char               *AcpiGbl_WordDecode[4];
130extern const char               *AcpiGbl_ConsumeDecode[2];
131extern const char               *AcpiGbl_MinDecode[2];
132extern const char               *AcpiGbl_MaxDecode[2];
133extern const char               *AcpiGbl_DECDecode[2];
134extern const char               *AcpiGbl_RNGDecode[4];
135extern const char               *AcpiGbl_MEMDecode[4];
136extern const char               *AcpiGbl_RWDecode[2];
137extern const char               *AcpiGbl_IrqDecode[2];
138extern const char               *AcpiGbl_HEDecode[2];
139extern const char               *AcpiGbl_LLDecode[2];
140extern const char               *AcpiGbl_SHRDecode[2];
141extern const char               *AcpiGbl_TYPDecode[4];
142extern const char               *AcpiGbl_BMDecode[2];
143extern const char               *AcpiGbl_SIZDecode[4];
144extern const NATIVE_CHAR        *AcpiGbl_LockRule[NUM_LOCK_RULES];
145extern const NATIVE_CHAR        *AcpiGbl_AccessTypes[NUM_ACCESS_TYPES];
146extern const NATIVE_CHAR        *AcpiGbl_UpdateRules[NUM_UPDATE_RULES];
147extern const NATIVE_CHAR        *AcpiGbl_MatchOps[NUM_MATCH_OPS];
148
149
150typedef struct acpi_op_walk_info
151{
152    UINT32                  Level;
153    UINT32                  BitOffset;
154
155} ACPI_OP_WALK_INFO;
156
157typedef
158ACPI_STATUS (*ASL_WALK_CALLBACK) (
159    ACPI_PARSE_OBJECT           *Op,
160    UINT32                      Level,
161    void                        *Context);
162
163
164/*
165 * dmwalk
166 */
167
168void
169AcpiDmWalkParseTree (
170    ACPI_PARSE_OBJECT       *Op,
171    ASL_WALK_CALLBACK       DescendingCallback,
172    ASL_WALK_CALLBACK       AscendingCallback,
173    void                    *Context);
174
175ACPI_STATUS
176AcpiDmDescendingOp (
177    ACPI_PARSE_OBJECT       *Op,
178    UINT32                  Level,
179    void                    *Context);
180
181ACPI_STATUS
182AcpiDmAscendingOp (
183    ACPI_PARSE_OBJECT       *Op,
184    UINT32                  Level,
185    void                    *Context);
186
187
188/*
189 * dmopcode
190 */
191
192void
193AcpiDmValidateName (
194    char                    *Name,
195    ACPI_PARSE_OBJECT       *Op);
196
197UINT32
198AcpiDmDumpName (
199    char                    *Name);
200
201void
202AcpiDmUnicode (
203    ACPI_PARSE_OBJECT       *Op);
204
205void
206AcpiDmDisassemble (
207    ACPI_WALK_STATE         *WalkState,
208    ACPI_PARSE_OBJECT       *Origin,
209    UINT32                  NumOpcodes);
210
211void
212AcpiDmNamestring (
213    NATIVE_CHAR             *Name);
214
215void
216AcpiDmDisplayPath (
217    ACPI_PARSE_OBJECT       *Op);
218
219void
220AcpiDmDisassembleOneOp (
221    ACPI_WALK_STATE         *WalkState,
222    ACPI_OP_WALK_INFO       *Info,
223    ACPI_PARSE_OBJECT       *Op);
224
225void
226AcpiDmDecodeInternalObject (
227    ACPI_OPERAND_OBJECT     *ObjDesc);
228
229void
230AcpiDmDecodeNode (
231    ACPI_NAMESPACE_NODE     *Node);
232
233UINT32
234AcpiDmBlockType (
235    ACPI_PARSE_OBJECT       *Op);
236
237UINT32
238AcpiDmListType (
239    ACPI_PARSE_OBJECT       *Op);
240
241ACPI_STATUS
242AcpiPsDisplayObjectPathname (
243    ACPI_WALK_STATE         *WalkState,
244    ACPI_PARSE_OBJECT       *Op);
245
246void
247AcpiDmMethodFlags (
248    ACPI_PARSE_OBJECT       *Op);
249
250void
251AcpiDmFieldFlags (
252    ACPI_PARSE_OBJECT       *Op);
253
254void
255AcpiDmAddressSpace (
256    UINT8                   SpaceId);
257
258void
259AcpiDmRegionFlags (
260    ACPI_PARSE_OBJECT       *Op);
261
262void
263AcpiDmMatchOp (
264    ACPI_PARSE_OBJECT       *Op);
265
266void
267AcpiDmMatchKeyword (
268    ACPI_PARSE_OBJECT       *Op);
269
270BOOLEAN
271AcpiDmCommaIfListMember (
272    ACPI_PARSE_OBJECT       *Op);
273
274void
275AcpiDmCommaIfFieldMember (
276    ACPI_PARSE_OBJECT       *Op);
277
278
279/*
280 * dmbuffer
281 */
282
283void
284AcpiIsEisaId (
285    ACPI_PARSE_OBJECT       *Op);
286
287void
288AcpiDmEisaId (
289    UINT32                  EncodedId);
290
291BOOLEAN
292AcpiDmIsUnicodeBuffer (
293    ACPI_PARSE_OBJECT       *Op);
294
295BOOLEAN
296AcpiDmIsStringBuffer (
297    ACPI_PARSE_OBJECT       *Op);
298
299
300/*
301 * dmresrc
302 */
303
304void
305AcpiDmDisasmByteList (
306    UINT32                  Level,
307    UINT8                   *ByteData,
308    UINT32                  ByteCount);
309
310void
311AcpiDmByteList (
312    ACPI_OP_WALK_INFO       *Info,
313    ACPI_PARSE_OBJECT       *Op);
314
315void
316AcpiDmResourceDescriptor (
317    ACPI_OP_WALK_INFO       *Info,
318    UINT8                   *ByteData,
319    UINT32                  ByteCount);
320
321BOOLEAN
322AcpiDmIsResourceDescriptor (
323    ACPI_PARSE_OBJECT       *Op);
324
325void
326AcpiDmIndent (
327    UINT32                  Level);
328
329void
330AcpiDmBitList (
331    UINT16                  Mask);
332
333void
334AcpiDmDecodeAttribute (
335    UINT8                   Attribute);
336
337/*
338 * dmresrcl
339 */
340
341void
342AcpiDmIoFlags (
343        UINT8               Flags);
344
345void
346AcpiDmMemoryFlags (
347    UINT8                   Flags,
348    UINT8                   SpecificFlags);
349
350void
351AcpiDmWordDescriptor (
352    ASL_WORD_ADDRESS_DESC   *Resource,
353    UINT32                  Length,
354    UINT32                  Level);
355
356void
357AcpiDmDwordDescriptor (
358    ASL_DWORD_ADDRESS_DESC  *Resource,
359    UINT32                  Length,
360    UINT32                  Level);
361
362void
363AcpiDmQwordDescriptor (
364    ASL_QWORD_ADDRESS_DESC  *Resource,
365    UINT32                  Length,
366    UINT32                  Level);
367
368void
369AcpiDmMemory24Descriptor (
370    ASL_MEMORY_24_DESC      *Resource,
371    UINT32                  Length,
372    UINT32                  Level);
373
374void
375AcpiDmMemory32Descriptor (
376    ASL_MEMORY_32_DESC      *Resource,
377    UINT32                  Length,
378    UINT32                  Level);
379
380void
381AcpiDmFixedMem32Descriptor (
382    ASL_FIXED_MEMORY_32_DESC *Resource,
383    UINT32                  Length,
384    UINT32                  Level);
385
386void
387AcpiDmGenericRegisterDescriptor (
388    ASL_GENERAL_REGISTER_DESC *Resource,
389    UINT32                  Length,
390    UINT32                  Level);
391
392void
393AcpiDmInterruptDescriptor (
394    ASL_EXTENDED_XRUPT_DESC *Resource,
395    UINT32                  Length,
396    UINT32                  Level);
397
398void
399AcpiDmVendorLargeDescriptor (
400    ASL_LARGE_VENDOR_DESC   *Resource,
401    UINT32                  Length,
402    UINT32                  Level);
403
404
405/*
406 * dmresrcs
407 */
408
409void
410AcpiDmIrqDescriptor (
411    ASL_IRQ_FORMAT_DESC     *Resource,
412    UINT32                  Length,
413    UINT32                  Level);
414
415void
416AcpiDmDmaDescriptor (
417    ASL_DMA_FORMAT_DESC     *Resource,
418    UINT32                  Length,
419    UINT32                  Level);
420
421void
422AcpiDmIoDescriptor (
423    ASL_IO_PORT_DESC        *Resource,
424    UINT32                  Length,
425    UINT32                  Level);
426
427void
428AcpiDmFixedIoDescriptor (
429    ASL_FIXED_IO_PORT_DESC  *Resource,
430    UINT32                  Length,
431    UINT32                  Level);
432
433void
434AcpiDmStartDependentDescriptor (
435    ASL_START_DEPENDENT_DESC *Resource,
436    UINT32                  Length,
437    UINT32                  Level);
438
439void
440AcpiDmEndDependentDescriptor (
441    ASL_START_DEPENDENT_DESC *Resource,
442    UINT32                  Length,
443    UINT32                  Level);
444
445void
446AcpiDmVendorSmallDescriptor (
447    ASL_SMALL_VENDOR_DESC   *Resource,
448    UINT32                  Length,
449    UINT32                  Level);
450
451
452#endif  /* __ACDISASM_H__ */
453