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

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