sys/contrib/dev/acpica/acdisasm.h

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