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