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