sys/contrib/dev/acpica/acdisasm.h

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