sys/contrib/dev/acpica-unix-20031203/include/acdisasm.h

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