sys/contrib/dev/acpica-unix/include/aclocal.h

   1 /******************************************************************************
   2  *
   3  * Name: aclocal.h - Internal data types used across the ACPI subsystem
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2011, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  16  * 2.1. This is your license from Intel Corp. under its intellectual property
  17  * rights.  You may have additional license terms from the party that provided
  18  * you this software, covering your right to use that party's intellectual
  19  * property rights.
  20  *
  21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  22  * copy of the source code appearing in this file ("Covered Code") an
  23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  24  * base code distributed originally by Intel ("Original Intel Code") to copy,
  25  * make derivatives, distribute, use and display any portion of the Covered
  26  * Code in any form, with the right to sublicense such rights; and
  27  *
  28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  29  * license (with the right to sublicense), under only those claims of Intel
  30  * patents that are infringed by the Original Intel Code, to make, use, sell,
  31  * offer to sell, and import the Covered Code and derivative works thereof
  32  * solely to the minimum extent necessary to exercise the above copyright
  33  * license, and in no event shall the patent license extend to any additions
  34  * to or modifications of the Original Intel Code.  No other license or right
  35  * is granted directly or by implication, estoppel or otherwise;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  43  * Redistribution of source code of any substantial portion of the Covered
  44  * Code or modification with rights to further distribute source must include
  45  * the above Copyright Notice, the above License, this list of Conditions,
  46  * and the following Disclaimer and Export Compliance provision.  In addition,
  47  * Licensee must cause all Covered Code to which Licensee contributes to
  48  * contain a file documenting the changes Licensee made to create that Covered
  49  * Code and the date of any change.  Licensee must include in that file the
  50  * documentation of any changes made by any predecessor Licensee.  Licensee
  51  * must include a prominent statement that the modification is derived,
  52  * directly or indirectly, from Original Intel Code.
  53  *
  54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  55  * Redistribution of source code of any substantial portion of the Covered
  56  * Code or modification without rights to further distribute source must
  57  * include the following Disclaimer and Export Compliance provision in the
  58  * documentation and/or other materials provided with distribution.  In
  59  * addition, Licensee may not authorize further sublicense of source of any
  60  * portion of the Covered Code, and must include terms to the effect that the
  61  * license from Licensee to its licensee is limited to the intellectual
  62  * property embodied in the software Licensee provides to its licensee, and
  63  * not to intellectual property embodied in modifications its licensee may
  64  * make.
  65  *
  66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  67  * substantial portion of the Covered Code or modification must reproduce the
  68  * above Copyright Notice, and the following Disclaimer and Export Compliance
  69  * provision in the documentation and/or other materials provided with the
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  76  * Intel shall be used in advertising or otherwise to promote the sale, use or
  77  * other dealings in products derived from or relating to the Covered Code
  78  * without prior written authorization from Intel.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  83  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  85  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  86  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  88  * PARTICULAR PURPOSE.
  89  *
  90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  97  * LIMITED REMEDY.
  98  *
  99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 100  * software or system incorporating such software without first obtaining any
 101  * required license or other approval from the U. S. Department of Commerce or
 102  * any other agency or department of the United States Government.  In the
 103  * event Licensee exports any such software from the United States or
 104  * re-exports any such software from a foreign destination, Licensee shall
 105  * ensure that the distribution and export/re-export of the software is in
 106  * compliance with all laws, regulations, orders, or other restrictions of the
 107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 108  * any of its subsidiaries will export/re-export any technical data, process,
 109  * software, or service, directly or indirectly, to any country for which the
 110  * United States government or any agency thereof requires an export license,
 111  * other governmental approval, or letter of assurance, without first obtaining
 112  * such license, approval or letter.
 113  *
 114  *****************************************************************************/
 115
 116 #ifndef __ACLOCAL_H__
 117 #define __ACLOCAL_H__
 118
 119
 120 /* acpisrc:StructDefs -- for acpisrc conversion */
 121
 122 #define ACPI_SERIALIZED                 0xFF
 123
 124 typedef UINT32                          ACPI_MUTEX_HANDLE;
 125 #define ACPI_GLOBAL_LOCK                (ACPI_SEMAPHORE) (-1)
 126
 127 /* Total number of aml opcodes defined */
 128
 129 #define AML_NUM_OPCODES                 0x7F
 130
 131
 132 /* Forward declarations */
 133
 134 struct acpi_walk_state;
 135 struct acpi_obj_mutex;
 136 union acpi_parse_object;
 137
 138
 139 /*****************************************************************************
 140  *
 141  * Mutex typedefs and structs
 142  *
 143  ****************************************************************************/
 144
 145
 146 /*
 147  * Predefined handles for the mutex objects used within the subsystem
 148  * All mutex objects are automatically created by AcpiUtMutexInitialize.
 149  *
 150  * The acquire/release ordering protocol is implied via this list. Mutexes
 151  * with a lower value must be acquired before mutexes with a higher value.
 152  *
 153  * NOTE: any changes here must be reflected in the AcpiGbl_MutexNames
 154  * table below also!
 155  */
 156 #define ACPI_MTX_INTERPRETER            0   /* AML Interpreter, main lock */
 157 #define ACPI_MTX_NAMESPACE              1   /* ACPI Namespace */
 158 #define ACPI_MTX_TABLES                 2   /* Data for ACPI tables */
 159 #define ACPI_MTX_EVENTS                 3   /* Data for ACPI events */
 160 #define ACPI_MTX_CACHES                 4   /* Internal caches, general purposes */
 161 #define ACPI_MTX_MEMORY                 5   /* Debug memory tracking lists */
 162 #define ACPI_MTX_DEBUG_CMD_COMPLETE     6   /* AML debugger */
 163 #define ACPI_MTX_DEBUG_CMD_READY        7   /* AML debugger */
 164
 165 #define ACPI_MAX_MUTEX                  7
 166 #define ACPI_NUM_MUTEX                  ACPI_MAX_MUTEX+1
 167
 168
 169 /* Lock structure for reader/writer interfaces */
 170
 171 typedef struct acpi_rw_lock
 172 {
 173     ACPI_MUTEX              WriterMutex;
 174     ACPI_MUTEX              ReaderMutex;
 175     UINT32                  NumReaders;
 176
 177 } ACPI_RW_LOCK;
 178
 179
 180 /*
 181  * Predefined handles for spinlocks used within the subsystem.
 182  * These spinlocks are created by AcpiUtMutexInitialize
 183  */
 184 #define ACPI_LOCK_GPES                  0
 185 #define ACPI_LOCK_HARDWARE              1
 186
 187 #define ACPI_MAX_LOCK                   1
 188 #define ACPI_NUM_LOCK                   ACPI_MAX_LOCK+1
 189
 190
 191 /* This Thread ID means that the mutex is not in use (unlocked) */
 192
 193 #define ACPI_MUTEX_NOT_ACQUIRED         (ACPI_THREAD_ID) -1
 194
 195 /* Table for the global mutexes */
 196
 197 typedef struct acpi_mutex_info
 198 {
 199     ACPI_MUTEX                      Mutex;
 200     UINT32                          UseCount;
 201     ACPI_THREAD_ID                  ThreadId;
 202
 203 } ACPI_MUTEX_INFO;
 204
 205
 206 /* Lock flag parameter for various interfaces */
 207
 208 #define ACPI_MTX_DO_NOT_LOCK            0
 209 #define ACPI_MTX_LOCK                   1
 210
 211
 212 /* Field access granularities */
 213
 214 #define ACPI_FIELD_BYTE_GRANULARITY     1
 215 #define ACPI_FIELD_WORD_GRANULARITY     2
 216 #define ACPI_FIELD_DWORD_GRANULARITY    4
 217 #define ACPI_FIELD_QWORD_GRANULARITY    8
 218
 219
 220 #define ACPI_ENTRY_NOT_FOUND            NULL
 221
 222
 223 /*****************************************************************************
 224  *
 225  * Namespace typedefs and structs
 226  *
 227  ****************************************************************************/
 228
 229 /* Operational modes of the AML interpreter/scanner */
 230
 231 typedef enum
 232 {
 233     ACPI_IMODE_LOAD_PASS1           = 0x01,
 234     ACPI_IMODE_LOAD_PASS2           = 0x02,
 235     ACPI_IMODE_EXECUTE              = 0x03
 236
 237 } ACPI_INTERPRETER_MODE;
 238
 239
 240 /*
 241  * The Namespace Node describes a named object that appears in the AML.
 242  * DescriptorType is used to differentiate between internal descriptors.
 243  *
 244  * The node is optimized for both 32-bit and 64-bit platforms:
 245  * 20 bytes for the 32-bit case, 32 bytes for the 64-bit case.
 246  *
 247  * Note: The DescriptorType and Type fields must appear in the identical
 248  * position in both the ACPI_NAMESPACE_NODE and ACPI_OPERAND_OBJECT
 249  * structures.
 250  */
 251 typedef struct acpi_namespace_node
 252 {
 253     union acpi_operand_object       *Object;        /* Interpreter object */
 254     UINT8                           DescriptorType; /* Differentiate object descriptor types */
 255     UINT8                           Type;           /* ACPI Type associated with this name */
 256     UINT8                           Flags;          /* Miscellaneous flags */
 257     ACPI_OWNER_ID                   OwnerId;        /* Node creator */
 258     ACPI_NAME_UNION                 Name;           /* ACPI Name, always 4 chars per ACPI spec */
 259     struct acpi_namespace_node      *Parent;        /* Parent node */
 260     struct acpi_namespace_node      *Child;         /* First child */
 261     struct acpi_namespace_node      *Peer;          /* First peer */
 262
 263     /*
 264      * The following fields are used by the ASL compiler and disassembler only
 265      */
 266 #ifdef ACPI_LARGE_NAMESPACE_NODE
 267     union acpi_parse_object         *Op;
 268     UINT32                          Value;
 269     UINT32                          Length;
 270 #endif
 271
 272 } ACPI_NAMESPACE_NODE;
 273
 274
 275 /* Namespace Node flags */
 276
 277 #define ANOBJ_RESERVED                  0x01    /* Available for use */
 278 #define ANOBJ_TEMPORARY                 0x02    /* Node is create by a method and is temporary */
 279 #define ANOBJ_METHOD_ARG                0x04    /* Node is a method argument */
 280 #define ANOBJ_METHOD_LOCAL              0x08    /* Node is a method local */
 281 #define ANOBJ_SUBTREE_HAS_INI           0x10    /* Used to optimize device initialization */
 282 #define ANOBJ_EVALUATED                 0x20    /* Set on first evaluation of node */
 283 #define ANOBJ_ALLOCATED_BUFFER          0x40    /* Method AML buffer is dynamic (InstallMethod) */
 284
 285 #define ANOBJ_IS_EXTERNAL               0x08    /* iASL only: This object created via External() */
 286 #define ANOBJ_METHOD_NO_RETVAL          0x10    /* iASL only: Method has no return value */
 287 #define ANOBJ_METHOD_SOME_NO_RETVAL     0x20    /* iASL only: Method has at least one return value */
 288 #define ANOBJ_IS_BIT_OFFSET             0x40    /* iASL only: Reference is a bit offset */
 289 #define ANOBJ_IS_REFERENCED             0x80    /* iASL only: Object was referenced */
 290
 291
 292 /* Internal ACPI table management - master table list */
 293
 294 typedef struct acpi_table_list
 295 {
 296     ACPI_TABLE_DESC                 *Tables;            /* Table descriptor array */
 297     UINT32                          CurrentTableCount;  /* Tables currently in the array */
 298     UINT32                          MaxTableCount;      /* Max tables array will hold */
 299     UINT8                           Flags;
 300
 301 } ACPI_TABLE_LIST;
 302
 303 /* Flags for above */
 304
 305 #define ACPI_ROOT_ORIGIN_UNKNOWN        (0)     /* ~ORIGIN_ALLOCATED */
 306 #define ACPI_ROOT_ORIGIN_ALLOCATED      (1)
 307 #define ACPI_ROOT_ALLOW_RESIZE          (2)
 308
 309
 310 /* Predefined (fixed) table indexes */
 311
 312 #define ACPI_TABLE_INDEX_DSDT           (0)
 313 #define ACPI_TABLE_INDEX_FACS           (1)
 314
 315
 316 typedef struct acpi_find_context
 317 {
 318     char                            *SearchFor;
 319     ACPI_HANDLE                     *List;
 320     UINT32                          *Count;
 321
 322 } ACPI_FIND_CONTEXT;
 323
 324
 325 typedef struct acpi_ns_search_data
 326 {
 327     ACPI_NAMESPACE_NODE             *Node;
 328
 329 } ACPI_NS_SEARCH_DATA;
 330
 331
 332 /* Object types used during package copies */
 333
 334 #define ACPI_COPY_TYPE_SIMPLE           0
 335 #define ACPI_COPY_TYPE_PACKAGE          1
 336
 337
 338 /* Info structure used to convert external<->internal namestrings */
 339
 340 typedef struct acpi_namestring_info
 341 {
 342     const char                      *ExternalName;
 343     const char                      *NextExternalChar;
 344     char                            *InternalName;
 345     UINT32                          Length;
 346     UINT32                          NumSegments;
 347     UINT32                          NumCarats;
 348     BOOLEAN                         FullyQualified;
 349
 350 } ACPI_NAMESTRING_INFO;
 351
 352
 353 /* Field creation info */
 354
 355 typedef struct acpi_create_field_info
 356 {
 357     ACPI_NAMESPACE_NODE             *RegionNode;
 358     ACPI_NAMESPACE_NODE             *FieldNode;
 359     ACPI_NAMESPACE_NODE             *RegisterNode;
 360     ACPI_NAMESPACE_NODE             *DataRegisterNode;
 361     UINT32                          BankValue;
 362     UINT32                          FieldBitPosition;
 363     UINT32                          FieldBitLength;
 364     UINT8                           FieldFlags;
 365     UINT8                           Attribute;
 366     UINT8                           FieldType;
 367
 368 } ACPI_CREATE_FIELD_INFO;
 369
 370
 371 typedef
 372 ACPI_STATUS (*ACPI_INTERNAL_METHOD) (
 373     struct acpi_walk_state          *WalkState);
 374
 375
 376 /*
 377  * Bitmapped ACPI types.  Used internally only
 378  */
 379 #define ACPI_BTYPE_ANY                  0x00000000
 380 #define ACPI_BTYPE_INTEGER              0x00000001
 381 #define ACPI_BTYPE_STRING               0x00000002
 382 #define ACPI_BTYPE_BUFFER               0x00000004
 383 #define ACPI_BTYPE_PACKAGE              0x00000008
 384 #define ACPI_BTYPE_FIELD_UNIT           0x00000010
 385 #define ACPI_BTYPE_DEVICE               0x00000020
 386 #define ACPI_BTYPE_EVENT                0x00000040
 387 #define ACPI_BTYPE_METHOD               0x00000080
 388 #define ACPI_BTYPE_MUTEX                0x00000100
 389 #define ACPI_BTYPE_REGION               0x00000200
 390 #define ACPI_BTYPE_POWER                0x00000400
 391 #define ACPI_BTYPE_PROCESSOR            0x00000800
 392 #define ACPI_BTYPE_THERMAL              0x00001000
 393 #define ACPI_BTYPE_BUFFER_FIELD         0x00002000
 394 #define ACPI_BTYPE_DDB_HANDLE           0x00004000
 395 #define ACPI_BTYPE_DEBUG_OBJECT         0x00008000
 396 #define ACPI_BTYPE_REFERENCE            0x00010000
 397 #define ACPI_BTYPE_RESOURCE             0x00020000
 398
 399 #define ACPI_BTYPE_COMPUTE_DATA         (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER)
 400
 401 #define ACPI_BTYPE_DATA                 (ACPI_BTYPE_COMPUTE_DATA  | ACPI_BTYPE_PACKAGE)
 402 #define ACPI_BTYPE_DATA_REFERENCE       (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE | ACPI_BTYPE_DDB_HANDLE)
 403 #define ACPI_BTYPE_DEVICE_OBJECTS       (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR)
 404 #define ACPI_BTYPE_OBJECTS_AND_REFS     0x0001FFFF  /* ARG or LOCAL */
 405 #define ACPI_BTYPE_ALL_OBJECTS          0x0000FFFF
 406
 407
 408 /*
 409  * Information structure for ACPI predefined names.
 410  * Each entry in the table contains the following items:
 411  *
 412  * Name                 - The ACPI reserved name
 413  * ParamCount           - Number of arguments to the method
 414  * ExpectedReturnBtypes - Allowed type(s) for the return value
 415  */
 416 typedef struct acpi_name_info
 417 {
 418     char                        Name[ACPI_NAME_SIZE];
 419     UINT8                       ParamCount;
 420     UINT8                       ExpectedBtypes;
 421
 422 } ACPI_NAME_INFO;
 423
 424 /*
 425  * Secondary information structures for ACPI predefined objects that return
 426  * package objects. This structure appears as the next entry in the table
 427  * after the NAME_INFO structure above.
 428  *
 429  * The reason for this is to minimize the size of the predefined name table.
 430  */
 431
 432 /*
 433  * Used for ACPI_PTYPE1_FIXED, ACPI_PTYPE1_VAR, ACPI_PTYPE2,
 434  * ACPI_PTYPE2_MIN, ACPI_PTYPE2_PKG_COUNT, ACPI_PTYPE2_COUNT
 435  */
 436 typedef struct acpi_package_info
 437 {
 438     UINT8                       Type;
 439     UINT8                       ObjectType1;
 440     UINT8                       Count1;
 441     UINT8                       ObjectType2;
 442     UINT8                       Count2;
 443     UINT8                       Reserved;
 444
 445 } ACPI_PACKAGE_INFO;
 446
 447 /* Used for ACPI_PTYPE2_FIXED */
 448
 449 typedef struct acpi_package_info2
 450 {
 451     UINT8                       Type;
 452     UINT8                       Count;
 453     UINT8                       ObjectType[4];
 454
 455 } ACPI_PACKAGE_INFO2;
 456
 457 /* Used for ACPI_PTYPE1_OPTION */
 458
 459 typedef struct acpi_package_info3
 460 {
 461     UINT8                       Type;
 462     UINT8                       Count;
 463     UINT8                       ObjectType[2];
 464     UINT8                       TailObjectType;
 465     UINT8                       Reserved;
 466
 467 } ACPI_PACKAGE_INFO3;
 468
 469 typedef union acpi_predefined_info
 470 {
 471     ACPI_NAME_INFO              Info;
 472     ACPI_PACKAGE_INFO           RetInfo;
 473     ACPI_PACKAGE_INFO2          RetInfo2;
 474     ACPI_PACKAGE_INFO3          RetInfo3;
 475
 476 } ACPI_PREDEFINED_INFO;
 477
 478
 479 /* Data block used during object validation */
 480
 481 typedef struct acpi_predefined_data
 482 {
 483     char                        *Pathname;
 484     const ACPI_PREDEFINED_INFO  *Predefined;
 485     union acpi_operand_object   *ParentPackage;
 486     UINT32                      Flags;
 487     UINT8                       NodeFlags;
 488
 489 } ACPI_PREDEFINED_DATA;
 490
 491 /* Defines for Flags field above */
 492
 493 #define ACPI_OBJECT_REPAIRED    1
 494
 495
 496 /*
 497  * Bitmapped return value types
 498  * Note: the actual data types must be contiguous, a loop in nspredef.c
 499  * depends on this.
 500  */
 501 #define ACPI_RTYPE_ANY                  0x00
 502 #define ACPI_RTYPE_NONE                 0x01
 503 #define ACPI_RTYPE_INTEGER              0x02
 504 #define ACPI_RTYPE_STRING               0x04
 505 #define ACPI_RTYPE_BUFFER               0x08
 506 #define ACPI_RTYPE_PACKAGE              0x10
 507 #define ACPI_RTYPE_REFERENCE            0x20
 508 #define ACPI_RTYPE_ALL                  0x3F
 509
 510 #define ACPI_NUM_RTYPES                 5   /* Number of actual object types */
 511
 512
 513 /*****************************************************************************
 514  *
 515  * Event typedefs and structs
 516  *
 517  ****************************************************************************/
 518
 519 /* Dispatch info for each GPE -- either a method or handler, cannot be both */
 520
 521 typedef struct acpi_gpe_handler_info
 522 {
 523     ACPI_GPE_HANDLER                Address;        /* Address of handler, if any */
 524     void                            *Context;       /* Context to be passed to handler */
 525     ACPI_NAMESPACE_NODE             *MethodNode;    /* Method node for this GPE level (saved) */
 526     UINT8                           OriginalFlags;  /* Original (pre-handler) GPE info */
 527     BOOLEAN                         OriginallyEnabled; /* True if GPE was originally enabled */
 528
 529 } ACPI_GPE_HANDLER_INFO;
 530
 531 /*
 532  * GPE dispatch info. At any time, the GPE can have at most one type
 533  * of dispatch - Method, Handler, or Implicit Notify.
 534  */
 535 typedef union acpi_gpe_dispatch_info
 536 {
 537     ACPI_NAMESPACE_NODE             *MethodNode;    /* Method node for this GPE level */
 538     struct acpi_gpe_handler_info    *Handler;       /* Installed GPE handler */
 539     ACPI_NAMESPACE_NODE             *DeviceNode;    /* Parent _PRW device for implicit notify */
 540
 541 } ACPI_GPE_DISPATCH_INFO;
 542
 543 /*
 544  * Information about a GPE, one per each GPE in an array.
 545  * NOTE: Important to keep this struct as small as possible.
 546  */
 547 typedef struct acpi_gpe_event_info
 548 {
 549     union acpi_gpe_dispatch_info    Dispatch;       /* Either Method or Handler */
 550     struct acpi_gpe_register_info   *RegisterInfo;  /* Backpointer to register info */
 551     UINT8                           Flags;          /* Misc info about this GPE */
 552     UINT8                           GpeNumber;      /* This GPE */
 553     UINT8                           RuntimeCount;   /* References to a run GPE */
 554
 555 } ACPI_GPE_EVENT_INFO;
 556
 557 /* Information about a GPE register pair, one per each status/enable pair in an array */
 558
 559 typedef struct acpi_gpe_register_info
 560 {
 561     ACPI_GENERIC_ADDRESS            StatusAddress;  /* Address of status reg */
 562     ACPI_GENERIC_ADDRESS            EnableAddress;  /* Address of enable reg */
 563     UINT8                           EnableForWake;  /* GPEs to keep enabled when sleeping */
 564     UINT8                           EnableForRun;   /* GPEs to keep enabled when running */
 565     UINT8                           BaseGpeNumber;  /* Base GPE number for this register */
 566
 567 } ACPI_GPE_REGISTER_INFO;
 568
 569 /*
 570  * Information about a GPE register block, one per each installed block --
 571  * GPE0, GPE1, and one per each installed GPE Block Device.
 572  */
 573 typedef struct acpi_gpe_block_info
 574 {
 575     ACPI_NAMESPACE_NODE             *Node;
 576     struct acpi_gpe_block_info      *Previous;
 577     struct acpi_gpe_block_info      *Next;
 578     struct acpi_gpe_xrupt_info      *XruptBlock;    /* Backpointer to interrupt block */
 579     ACPI_GPE_REGISTER_INFO          *RegisterInfo;  /* One per GPE register pair */
 580     ACPI_GPE_EVENT_INFO             *EventInfo;     /* One for each GPE */
 581     ACPI_GENERIC_ADDRESS            BlockAddress;   /* Base address of the block */
 582     UINT32                          RegisterCount;  /* Number of register pairs in block */
 583     UINT16                          GpeCount;       /* Number of individual GPEs in block */
 584     UINT8                           BlockBaseNumber;/* Base GPE number for this block */
 585     BOOLEAN                         Initialized;    /* TRUE if this block is initialized */
 586
 587 } ACPI_GPE_BLOCK_INFO;
 588
 589 /* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */
 590
 591 typedef struct acpi_gpe_xrupt_info
 592 {
 593     struct acpi_gpe_xrupt_info      *Previous;
 594     struct acpi_gpe_xrupt_info      *Next;
 595     ACPI_GPE_BLOCK_INFO             *GpeBlockListHead;  /* List of GPE blocks for this xrupt */
 596     UINT32                          InterruptNumber;    /* System interrupt number */
 597
 598 } ACPI_GPE_XRUPT_INFO;
 599
 600 typedef struct acpi_gpe_walk_info
 601 {
 602     ACPI_NAMESPACE_NODE             *GpeDevice;
 603     ACPI_GPE_BLOCK_INFO             *GpeBlock;
 604     UINT16                          Count;
 605     ACPI_OWNER_ID                   OwnerId;
 606     BOOLEAN                         ExecuteByOwnerId;
 607
 608 } ACPI_GPE_WALK_INFO;
 609
 610 typedef struct acpi_gpe_device_info
 611 {
 612     UINT32                          Index;
 613     UINT32                          NextBlockBaseIndex;
 614     ACPI_STATUS                     Status;
 615     ACPI_NAMESPACE_NODE             *GpeDevice;
 616
 617 } ACPI_GPE_DEVICE_INFO;
 618
 619 typedef ACPI_STATUS (*ACPI_GPE_CALLBACK) (
 620     ACPI_GPE_XRUPT_INFO             *GpeXruptInfo,
 621     ACPI_GPE_BLOCK_INFO             *GpeBlock,
 622     void                            *Context);
 623
 624
 625 /* Information about each particular fixed event */
 626
 627 typedef struct acpi_fixed_event_handler
 628 {
 629     ACPI_EVENT_HANDLER              Handler;        /* Address of handler. */
 630     void                            *Context;       /* Context to be passed to handler */
 631
 632 } ACPI_FIXED_EVENT_HANDLER;
 633
 634 typedef struct acpi_fixed_event_info
 635 {
 636     UINT8                           StatusRegisterId;
 637     UINT8                           EnableRegisterId;
 638     UINT16                          StatusBitMask;
 639     UINT16                          EnableBitMask;
 640
 641 } ACPI_FIXED_EVENT_INFO;
 642
 643 /* Information used during field processing */
 644
 645 typedef struct acpi_field_info
 646 {
 647     UINT8                           SkipField;
 648     UINT8                           FieldFlag;
 649     UINT32                          PkgLength;
 650
 651 } ACPI_FIELD_INFO;
 652
 653
 654 /*****************************************************************************
 655  *
 656  * Generic "state" object for stacks
 657  *
 658  ****************************************************************************/
 659
 660 #define ACPI_CONTROL_NORMAL                  0xC0
 661 #define ACPI_CONTROL_CONDITIONAL_EXECUTING   0xC1
 662 #define ACPI_CONTROL_PREDICATE_EXECUTING     0xC2
 663 #define ACPI_CONTROL_PREDICATE_FALSE         0xC3
 664 #define ACPI_CONTROL_PREDICATE_TRUE          0xC4
 665
 666
 667 #define ACPI_STATE_COMMON \
 668     void                            *Next; \
 669     UINT8                           DescriptorType; /* To differentiate various internal objs */\
 670     UINT8                           Flags; \
 671     UINT16                          Value; \
 672     UINT16                          State;
 673
 674     /* There are 2 bytes available here until the next natural alignment boundary */
 675
 676 typedef struct acpi_common_state
 677 {
 678     ACPI_STATE_COMMON
 679 } ACPI_COMMON_STATE;
 680
 681
 682 /*
 683  * Update state - used to traverse complex objects such as packages
 684  */
 685 typedef struct acpi_update_state
 686 {
 687     ACPI_STATE_COMMON
 688     union acpi_operand_object       *Object;
 689
 690 } ACPI_UPDATE_STATE;
 691
 692
 693 /*
 694  * Pkg state - used to traverse nested package structures
 695  */
 696 typedef struct acpi_pkg_state
 697 {
 698     ACPI_STATE_COMMON
 699     UINT16                          Index;
 700     union acpi_operand_object       *SourceObject;
 701     union acpi_operand_object       *DestObject;
 702     struct acpi_walk_state          *WalkState;
 703     void                            *ThisTargetObj;
 704     UINT32                          NumPackages;
 705
 706 } ACPI_PKG_STATE;
 707
 708
 709 /*
 710  * Control state - one per if/else and while constructs.
 711  * Allows nesting of these constructs
 712  */
 713 typedef struct acpi_control_state
 714 {
 715     ACPI_STATE_COMMON
 716     UINT16                          Opcode;
 717     union acpi_parse_object         *PredicateOp;
 718     UINT8                           *AmlPredicateStart;     /* Start of if/while predicate */
 719     UINT8                           *PackageEnd;            /* End of if/while block */
 720     UINT32                          LoopCount;              /* While() loop counter */
 721
 722 } ACPI_CONTROL_STATE;
 723
 724
 725 /*
 726  * Scope state - current scope during namespace lookups
 727  */
 728 typedef struct acpi_scope_state
 729 {
 730     ACPI_STATE_COMMON
 731     ACPI_NAMESPACE_NODE             *Node;
 732
 733 } ACPI_SCOPE_STATE;
 734
 735
 736 typedef struct acpi_pscope_state
 737 {
 738     ACPI_STATE_COMMON
 739     UINT32                          ArgCount;               /* Number of fixed arguments */
 740     union acpi_parse_object         *Op;                    /* Current op being parsed */
 741     UINT8                           *ArgEnd;                /* Current argument end */
 742     UINT8                           *PkgEnd;                /* Current package end */
 743     UINT32                          ArgList;                /* Next argument to parse */
 744
 745 } ACPI_PSCOPE_STATE;
 746
 747
 748 /*
 749  * Thread state - one per thread across multiple walk states.  Multiple walk
 750  * states are created when there are nested control methods executing.
 751  */
 752 typedef struct acpi_thread_state
 753 {
 754     ACPI_STATE_COMMON
 755     UINT8                           CurrentSyncLevel;       /* Mutex Sync (nested acquire) level */
 756     struct acpi_walk_state          *WalkStateList;         /* Head of list of WalkStates for this thread */
 757     union acpi_operand_object       *AcquiredMutexList;     /* List of all currently acquired mutexes */
 758     ACPI_THREAD_ID                  ThreadId;               /* Running thread ID */
 759
 760 } ACPI_THREAD_STATE;
 761
 762
 763 /*
 764  * Result values - used to accumulate the results of nested
 765  * AML arguments
 766  */
 767 typedef struct acpi_result_values
 768 {
 769     ACPI_STATE_COMMON
 770     union acpi_operand_object       *ObjDesc [ACPI_RESULTS_FRAME_OBJ_NUM];
 771
 772 } ACPI_RESULT_VALUES;
 773
 774
 775 typedef
 776 ACPI_STATUS (*ACPI_PARSE_DOWNWARDS) (
 777     struct acpi_walk_state          *WalkState,
 778     union acpi_parse_object         **OutOp);
 779
 780 typedef
 781 ACPI_STATUS (*ACPI_PARSE_UPWARDS) (
 782     struct acpi_walk_state          *WalkState);
 783
 784
 785 /*
 786  * Notify info - used to pass info to the deferred notify
 787  * handler/dispatcher.
 788  */
 789 typedef struct acpi_notify_info
 790 {
 791     ACPI_STATE_COMMON
 792     ACPI_NAMESPACE_NODE             *Node;
 793     union acpi_operand_object       *HandlerObj;
 794
 795 } ACPI_NOTIFY_INFO;
 796
 797
 798 /* Generic state is union of structs above */
 799
 800 typedef union acpi_generic_state
 801 {
 802     ACPI_COMMON_STATE               Common;
 803     ACPI_CONTROL_STATE              Control;
 804     ACPI_UPDATE_STATE               Update;
 805     ACPI_SCOPE_STATE                Scope;
 806     ACPI_PSCOPE_STATE               ParseScope;
 807     ACPI_PKG_STATE                  Pkg;
 808     ACPI_THREAD_STATE               Thread;
 809     ACPI_RESULT_VALUES              Results;
 810     ACPI_NOTIFY_INFO                Notify;
 811
 812 } ACPI_GENERIC_STATE;
 813
 814
 815 /*****************************************************************************
 816  *
 817  * Interpreter typedefs and structs
 818  *
 819  ****************************************************************************/
 820
 821 typedef
 822 ACPI_STATUS (*ACPI_EXECUTE_OP) (
 823     struct acpi_walk_state          *WalkState);
 824
 825
 826 /*****************************************************************************
 827  *
 828  * Parser typedefs and structs
 829  *
 830  ****************************************************************************/
 831
 832 /*
 833  * AML opcode, name, and argument layout
 834  */
 835 typedef struct acpi_opcode_info
 836 {
 837 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
 838     char                            *Name;          /* Opcode name (disassembler/debug only) */
 839 #endif
 840     UINT32                          ParseArgs;      /* Grammar/Parse time arguments */
 841     UINT32                          RuntimeArgs;    /* Interpret time arguments */
 842     UINT16                          Flags;          /* Misc flags */
 843     UINT8                           ObjectType;     /* Corresponding internal object type */
 844     UINT8                           Class;          /* Opcode class */
 845     UINT8                           Type;           /* Opcode type */
 846
 847 } ACPI_OPCODE_INFO;
 848
 849 typedef union acpi_parse_value
 850 {
 851     UINT64                          Integer;        /* Integer constant (Up to 64 bits) */
 852     UINT32                          Size;           /* bytelist or field size */
 853     char                            *String;        /* NULL terminated string */
 854     UINT8                           *Buffer;        /* buffer or string */
 855     char                            *Name;          /* NULL terminated string */
 856     union acpi_parse_object         *Arg;           /* arguments and contained ops */
 857
 858 } ACPI_PARSE_VALUE;
 859
 860
 861 #ifdef ACPI_DISASSEMBLER
 862 #define ACPI_DISASM_ONLY_MEMBERS(a)     a;
 863 #else
 864 #define ACPI_DISASM_ONLY_MEMBERS(a)
 865 #endif
 866
 867 #define ACPI_PARSE_COMMON \
 868     union acpi_parse_object         *Parent;        /* Parent op */\
 869     UINT8                           DescriptorType; /* To differentiate various internal objs */\
 870     UINT8                           Flags;          /* Type of Op */\
 871     UINT16                          AmlOpcode;      /* AML opcode */\
 872     UINT32                          AmlOffset;      /* Offset of declaration in AML */\
 873     union acpi_parse_object         *Next;          /* Next op */\
 874     ACPI_NAMESPACE_NODE             *Node;          /* For use by interpreter */\
 875     ACPI_PARSE_VALUE                Value;          /* Value or args associated with the opcode */\
 876     UINT8                           ArgListLength;  /* Number of elements in the arg list */\
 877     ACPI_DISASM_ONLY_MEMBERS (\
 878     UINT8                           DisasmFlags;    /* Used during AML disassembly */\
 879     UINT8                           DisasmOpcode;   /* Subtype used for disassembly */\
 880     char                            AmlOpName[16])  /* Op name (debug only) */
 881
 882
 883 #define ACPI_DASM_BUFFER                0x00
 884 #define ACPI_DASM_RESOURCE              0x01
 885 #define ACPI_DASM_STRING                0x02
 886 #define ACPI_DASM_UNICODE               0x03
 887 #define ACPI_DASM_EISAID                0x04
 888 #define ACPI_DASM_MATCHOP               0x05
 889 #define ACPI_DASM_LNOT_PREFIX           0x06
 890 #define ACPI_DASM_LNOT_SUFFIX           0x07
 891 #define ACPI_DASM_IGNORE                0x08
 892
 893 /*
 894  * Generic operation (for example:  If, While, Store)
 895  */
 896 typedef struct acpi_parse_obj_common
 897 {
 898     ACPI_PARSE_COMMON
 899 } ACPI_PARSE_OBJ_COMMON;
 900
 901
 902 /*
 903  * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and OpRegions),
 904  * and bytelists.
 905  */
 906 typedef struct acpi_parse_obj_named
 907 {
 908     ACPI_PARSE_COMMON
 909     UINT8                           *Path;
 910     UINT8                           *Data;          /* AML body or bytelist data */
 911     UINT32                          Length;         /* AML length */
 912     UINT32                          Name;           /* 4-byte name or zero if no name */
 913
 914 } ACPI_PARSE_OBJ_NAMED;
 915
 916
 917 /* This version is used by the iASL compiler only */
 918
 919 #define ACPI_MAX_PARSEOP_NAME   20
 920
 921 typedef struct acpi_parse_obj_asl
 922 {
 923     ACPI_PARSE_COMMON
 924     union acpi_parse_object         *Child;
 925     union acpi_parse_object         *ParentMethod;
 926     char                            *Filename;
 927     char                            *ExternalName;
 928     char                            *Namepath;
 929     char                            NameSeg[4];
 930     UINT32                          ExtraValue;
 931     UINT32                          Column;
 932     UINT32                          LineNumber;
 933     UINT32                          LogicalLineNumber;
 934     UINT32                          LogicalByteOffset;
 935     UINT32                          EndLine;
 936     UINT32                          EndLogicalLine;
 937     UINT32                          AcpiBtype;
 938     UINT32                          AmlLength;
 939     UINT32                          AmlSubtreeLength;
 940     UINT32                          FinalAmlLength;
 941     UINT32                          FinalAmlOffset;
 942     UINT32                          CompileFlags;
 943     UINT16                          ParseOpcode;
 944     UINT8                           AmlOpcodeLength;
 945     UINT8                           AmlPkgLenBytes;
 946     UINT8                           Extra;
 947     char                            ParseOpName[ACPI_MAX_PARSEOP_NAME];
 948
 949 } ACPI_PARSE_OBJ_ASL;
 950
 951 typedef union acpi_parse_object
 952 {
 953     ACPI_PARSE_OBJ_COMMON           Common;
 954     ACPI_PARSE_OBJ_NAMED            Named;
 955     ACPI_PARSE_OBJ_ASL              Asl;
 956
 957 } ACPI_PARSE_OBJECT;
 958
 959
 960 /*
 961  * Parse state - one state per parser invocation and each control
 962  * method.
 963  */
 964 typedef struct acpi_parse_state
 965 {
 966     UINT8                           *AmlStart;      /* First AML byte */
 967     UINT8                           *Aml;           /* Next AML byte */
 968     UINT8                           *AmlEnd;        /* (last + 1) AML byte */
 969     UINT8                           *PkgStart;      /* Current package begin */
 970     UINT8                           *PkgEnd;        /* Current package end */
 971     union acpi_parse_object         *StartOp;       /* Root of parse tree */
 972     struct acpi_namespace_node      *StartNode;
 973     union acpi_generic_state        *Scope;         /* Current scope */
 974     union acpi_parse_object         *StartScope;
 975     UINT32                          AmlSize;
 976
 977 } ACPI_PARSE_STATE;
 978
 979
 980 /* Parse object flags */
 981
 982 #define ACPI_PARSEOP_GENERIC            0x01
 983 #define ACPI_PARSEOP_NAMED              0x02
 984 #define ACPI_PARSEOP_DEFERRED           0x04
 985 #define ACPI_PARSEOP_BYTELIST           0x08
 986 #define ACPI_PARSEOP_IN_STACK           0x10
 987 #define ACPI_PARSEOP_TARGET             0x20
 988 #define ACPI_PARSEOP_IN_CACHE           0x80
 989
 990 /* Parse object DisasmFlags */
 991
 992 #define ACPI_PARSEOP_IGNORE             0x01
 993 #define ACPI_PARSEOP_PARAMLIST          0x02
 994 #define ACPI_PARSEOP_EMPTY_TERMLIST     0x04
 995 #define ACPI_PARSEOP_SPECIAL            0x10
 996
 997
 998 /*****************************************************************************
 999  *
1000  * Hardware (ACPI registers) and PNP
1001  *
1002  ****************************************************************************/
1003
1004 typedef struct acpi_bit_register_info
1005 {
1006     UINT8                           ParentRegister;
1007     UINT8                           BitPosition;
1008     UINT16                          AccessBitMask;
1009
1010 } ACPI_BIT_REGISTER_INFO;
1011
1012
1013 /*
1014  * Some ACPI registers have bits that must be ignored -- meaning that they
1015  * must be preserved.
1016  */
1017 #define ACPI_PM1_STATUS_PRESERVED_BITS          0x0800  /* Bit 11 */
1018
1019 /* Write-only bits must be zeroed by software */
1020
1021 #define ACPI_PM1_CONTROL_WRITEONLY_BITS         0x2004  /* Bits 13, 2 */
1022
1023 /* For control registers, both ignored and reserved bits must be preserved */
1024
1025 /*
1026  * For PM1 control, the SCI enable bit (bit 0, SCI_EN) is defined by the
1027  * ACPI specification to be a "preserved" bit - "OSPM always preserves this
1028  * bit position", section 4.7.3.2.1. However, on some machines the OS must
1029  * write a one to this bit after resume for the machine to work properly.
1030  * To enable this, we no longer attempt to preserve this bit. No machines
1031  * are known to fail if the bit is not preserved. (May 2009)
1032  */
1033 #define ACPI_PM1_CONTROL_IGNORED_BITS           0x0200  /* Bit 9 */
1034 #define ACPI_PM1_CONTROL_RESERVED_BITS          0xC1F8  /* Bits 14-15, 3-8 */
1035 #define ACPI_PM1_CONTROL_PRESERVED_BITS \
1036          (ACPI_PM1_CONTROL_IGNORED_BITS | ACPI_PM1_CONTROL_RESERVED_BITS)
1037
1038 #define ACPI_PM2_CONTROL_PRESERVED_BITS         0xFFFFFFFE /* All except bit 0 */
1039
1040 /*
1041  * Register IDs
1042  * These are the full ACPI registers
1043  */
1044 #define ACPI_REGISTER_PM1_STATUS                0x01
1045 #define ACPI_REGISTER_PM1_ENABLE                0x02
1046 #define ACPI_REGISTER_PM1_CONTROL               0x03
1047 #define ACPI_REGISTER_PM2_CONTROL               0x04
1048 #define ACPI_REGISTER_PM_TIMER                  0x05
1049 #define ACPI_REGISTER_PROCESSOR_BLOCK           0x06
1050 #define ACPI_REGISTER_SMI_COMMAND_BLOCK         0x07
1051
1052
1053 /* Masks used to access the BitRegisters */
1054
1055 #define ACPI_BITMASK_TIMER_STATUS               0x0001
1056 #define ACPI_BITMASK_BUS_MASTER_STATUS          0x0010
1057 #define ACPI_BITMASK_GLOBAL_LOCK_STATUS         0x0020
1058 #define ACPI_BITMASK_POWER_BUTTON_STATUS        0x0100
1059 #define ACPI_BITMASK_SLEEP_BUTTON_STATUS        0x0200
1060 #define ACPI_BITMASK_RT_CLOCK_STATUS            0x0400
1061 #define ACPI_BITMASK_PCIEXP_WAKE_STATUS         0x4000    /* ACPI 3.0 */
1062 #define ACPI_BITMASK_WAKE_STATUS                0x8000
1063
1064 #define ACPI_BITMASK_ALL_FIXED_STATUS           (\
1065     ACPI_BITMASK_TIMER_STATUS          | \
1066     ACPI_BITMASK_BUS_MASTER_STATUS     | \
1067     ACPI_BITMASK_GLOBAL_LOCK_STATUS    | \
1068     ACPI_BITMASK_POWER_BUTTON_STATUS   | \
1069     ACPI_BITMASK_SLEEP_BUTTON_STATUS   | \
1070     ACPI_BITMASK_RT_CLOCK_STATUS       | \
1071     ACPI_BITMASK_PCIEXP_WAKE_STATUS    | \
1072     ACPI_BITMASK_WAKE_STATUS)
1073
1074 #define ACPI_BITMASK_TIMER_ENABLE               0x0001
1075 #define ACPI_BITMASK_GLOBAL_LOCK_ENABLE         0x0020
1076 #define ACPI_BITMASK_POWER_BUTTON_ENABLE        0x0100
1077 #define ACPI_BITMASK_SLEEP_BUTTON_ENABLE        0x0200
1078 #define ACPI_BITMASK_RT_CLOCK_ENABLE            0x0400
1079 #define ACPI_BITMASK_PCIEXP_WAKE_DISABLE        0x4000    /* ACPI 3.0 */
1080
1081 #define ACPI_BITMASK_SCI_ENABLE                 0x0001
1082 #define ACPI_BITMASK_BUS_MASTER_RLD             0x0002
1083 #define ACPI_BITMASK_GLOBAL_LOCK_RELEASE        0x0004
1084 #define ACPI_BITMASK_SLEEP_TYPE                 0x1C00
1085 #define ACPI_BITMASK_SLEEP_ENABLE               0x2000
1086
1087 #define ACPI_BITMASK_ARB_DISABLE                0x0001
1088
1089
1090 /* Raw bit position of each BitRegister */
1091
1092 #define ACPI_BITPOSITION_TIMER_STATUS           0x00
1093 #define ACPI_BITPOSITION_BUS_MASTER_STATUS      0x04
1094 #define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS     0x05
1095 #define ACPI_BITPOSITION_POWER_BUTTON_STATUS    0x08
1096 #define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS    0x09
1097 #define ACPI_BITPOSITION_RT_CLOCK_STATUS        0x0A
1098 #define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS     0x0E    /* ACPI 3.0 */
1099 #define ACPI_BITPOSITION_WAKE_STATUS            0x0F
1100
1101 #define ACPI_BITPOSITION_TIMER_ENABLE           0x00
1102 #define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE     0x05
1103 #define ACPI_BITPOSITION_POWER_BUTTON_ENABLE    0x08
1104 #define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE    0x09
1105 #define ACPI_BITPOSITION_RT_CLOCK_ENABLE        0x0A
1106 #define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE    0x0E    /* ACPI 3.0 */
1107
1108 #define ACPI_BITPOSITION_SCI_ENABLE             0x00
1109 #define ACPI_BITPOSITION_BUS_MASTER_RLD         0x01
1110 #define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE    0x02
1111 #define ACPI_BITPOSITION_SLEEP_TYPE             0x0A
1112 #define ACPI_BITPOSITION_SLEEP_ENABLE           0x0D
1113
1114 #define ACPI_BITPOSITION_ARB_DISABLE            0x00
1115
1116
1117 /* Structs and definitions for _OSI support and I/O port validation */
1118
1119 #define ACPI_OSI_WIN_2000               0x01
1120 #define ACPI_OSI_WIN_XP                 0x02
1121 #define ACPI_OSI_WIN_XP_SP1             0x03
1122 #define ACPI_OSI_WINSRV_2003            0x04
1123 #define ACPI_OSI_WIN_XP_SP2             0x05
1124 #define ACPI_OSI_WINSRV_2003_SP1        0x06
1125 #define ACPI_OSI_WIN_VISTA              0x07
1126 #define ACPI_OSI_WINSRV_2008            0x08
1127 #define ACPI_OSI_WIN_VISTA_SP1          0x09
1128 #define ACPI_OSI_WIN_VISTA_SP2          0x0A
1129 #define ACPI_OSI_WIN_7                  0x0B
1130
1131 #define ACPI_ALWAYS_ILLEGAL             0x00
1132
1133 typedef struct acpi_interface_info
1134 {
1135     char                        *Name;
1136     struct acpi_interface_info  *Next;
1137     UINT8                       Flags;
1138     UINT8                       Value;
1139
1140 } ACPI_INTERFACE_INFO;
1141
1142 #define ACPI_OSI_INVALID                0x01
1143 #define ACPI_OSI_DYNAMIC                0x02
1144
1145 typedef struct acpi_port_info
1146 {
1147     char                    *Name;
1148     UINT16                  Start;
1149     UINT16                  End;
1150     UINT8                   OsiDependency;
1151
1152 } ACPI_PORT_INFO;
1153
1154
1155 /*****************************************************************************
1156  *
1157  * Resource descriptors
1158  *
1159  ****************************************************************************/
1160
1161 /* ResourceType values */
1162
1163 #define ACPI_ADDRESS_TYPE_MEMORY_RANGE          0
1164 #define ACPI_ADDRESS_TYPE_IO_RANGE              1
1165 #define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE      2
1166
1167 /* Resource descriptor types and masks */
1168
1169 #define ACPI_RESOURCE_NAME_LARGE                0x80
1170 #define ACPI_RESOURCE_NAME_SMALL                0x00
1171
1172 #define ACPI_RESOURCE_NAME_SMALL_MASK           0x78 /* Bits 6:3 contain the type */
1173 #define ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK    0x07 /* Bits 2:0 contain the length */
1174 #define ACPI_RESOURCE_NAME_LARGE_MASK           0x7F /* Bits 6:0 contain the type */
1175
1176
1177 /*
1178  * Small resource descriptor "names" as defined by the ACPI specification.
1179  * Note: Bits 2:0 are used for the descriptor length
1180  */
1181 #define ACPI_RESOURCE_NAME_IRQ                  0x20
1182 #define ACPI_RESOURCE_NAME_DMA                  0x28
1183 #define ACPI_RESOURCE_NAME_START_DEPENDENT      0x30
1184 #define ACPI_RESOURCE_NAME_END_DEPENDENT        0x38
1185 #define ACPI_RESOURCE_NAME_IO                   0x40
1186 #define ACPI_RESOURCE_NAME_FIXED_IO             0x48
1187 #define ACPI_RESOURCE_NAME_RESERVED_S1          0x50
1188 #define ACPI_RESOURCE_NAME_RESERVED_S2          0x58
1189 #define ACPI_RESOURCE_NAME_RESERVED_S3          0x60
1190 #define ACPI_RESOURCE_NAME_RESERVED_S4          0x68
1191 #define ACPI_RESOURCE_NAME_VENDOR_SMALL         0x70
1192 #define ACPI_RESOURCE_NAME_END_TAG              0x78
1193
1194 /*
1195  * Large resource descriptor "names" as defined by the ACPI specification.
1196  * Note: includes the Large Descriptor bit in bit[7]
1197  */
1198 #define ACPI_RESOURCE_NAME_MEMORY24             0x81
1199 #define ACPI_RESOURCE_NAME_GENERIC_REGISTER     0x82
1200 #define ACPI_RESOURCE_NAME_RESERVED_L1          0x83
1201 #define ACPI_RESOURCE_NAME_VENDOR_LARGE         0x84
1202 #define ACPI_RESOURCE_NAME_MEMORY32             0x85
1203 #define ACPI_RESOURCE_NAME_FIXED_MEMORY32       0x86
1204 #define ACPI_RESOURCE_NAME_ADDRESS32            0x87
1205 #define ACPI_RESOURCE_NAME_ADDRESS16            0x88
1206 #define ACPI_RESOURCE_NAME_EXTENDED_IRQ         0x89
1207 #define ACPI_RESOURCE_NAME_ADDRESS64            0x8A
1208 #define ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64   0x8B
1209 #define ACPI_RESOURCE_NAME_LARGE_MAX            0x8B
1210
1211
1212 /*****************************************************************************
1213  *
1214  * Miscellaneous
1215  *
1216  ****************************************************************************/
1217
1218 #define ACPI_ASCII_ZERO                 0x30
1219
1220
1221 /*****************************************************************************
1222  *
1223  * Disassembler
1224  *
1225  ****************************************************************************/
1226
1227 typedef struct acpi_external_list
1228 {
1229     char                        *Path;
1230     char                        *InternalPath;
1231     struct acpi_external_list   *Next;
1232     UINT32                      Value;
1233     UINT16                      Length;
1234     UINT8                       Type;
1235     UINT8                       Flags;
1236
1237 } ACPI_EXTERNAL_LIST;
1238
1239 /* Values for Flags field above */
1240
1241 #define ACPI_IPATH_ALLOCATED    0x01
1242
1243
1244 typedef struct acpi_external_file
1245 {
1246     char                        *Path;
1247     struct acpi_external_file   *Next;
1248
1249 } ACPI_EXTERNAL_FILE;
1250
1251
1252 /*****************************************************************************
1253  *
1254  * Debugger
1255  *
1256  ****************************************************************************/
1257
1258 typedef struct acpi_db_method_info
1259 {
1260     ACPI_HANDLE                     MainThreadGate;
1261     ACPI_HANDLE                     ThreadCompleteGate;
1262     ACPI_HANDLE                     InfoGate;
1263     ACPI_THREAD_ID                  *Threads;
1264     UINT32                          NumThreads;
1265     UINT32                          NumCreated;
1266     UINT32                          NumCompleted;
1267
1268     char                            *Name;
1269     UINT32                          Flags;
1270     UINT32                          NumLoops;
1271     char                            Pathname[128];
1272     char                            **Args;
1273
1274     /*
1275      * Arguments to be passed to method for the command
1276      * Threads -
1277      *   the Number of threads, ID of current thread and
1278      *   Index of current thread inside all them created.
1279      */
1280     char                            InitArgs;
1281     char                            *Arguments[4];
1282     char                            NumThreadsStr[11];
1283     char                            IdOfThreadStr[11];
1284     char                            IndexOfThreadStr[11];
1285
1286 } ACPI_DB_METHOD_INFO;
1287
1288 typedef struct acpi_integrity_info
1289 {
1290     UINT32                          Nodes;
1291     UINT32                          Objects;
1292
1293 } ACPI_INTEGRITY_INFO;
1294
1295
1296 #define ACPI_DB_REDIRECTABLE_OUTPUT     0x01
1297 #define ACPI_DB_CONSOLE_OUTPUT          0x02
1298 #define ACPI_DB_DUPLICATE_OUTPUT        0x03
1299
1300
1301 /*****************************************************************************
1302  *
1303  * Debug
1304  *
1305  ****************************************************************************/
1306
1307 /* Entry for a memory allocation (debug only) */
1308
1309 #define ACPI_MEM_MALLOC                 0
1310 #define ACPI_MEM_CALLOC                 1
1311 #define ACPI_MAX_MODULE_NAME            16
1312
1313 #define ACPI_COMMON_DEBUG_MEM_HEADER \
1314     struct acpi_debug_mem_block     *Previous; \
1315     struct acpi_debug_mem_block     *Next; \
1316     UINT32                          Size; \
1317     UINT32                          Component; \
1318     UINT32                          Line; \
1319     char                            Module[ACPI_MAX_MODULE_NAME]; \
1320     UINT8                           AllocType;
1321
1322 typedef struct acpi_debug_mem_header
1323 {
1324     ACPI_COMMON_DEBUG_MEM_HEADER
1325
1326 } ACPI_DEBUG_MEM_HEADER;
1327
1328 typedef struct acpi_debug_mem_block
1329 {
1330     ACPI_COMMON_DEBUG_MEM_HEADER
1331     UINT64                          UserSpace;
1332
1333 } ACPI_DEBUG_MEM_BLOCK;
1334
1335
1336 #define ACPI_MEM_LIST_GLOBAL            0
1337 #define ACPI_MEM_LIST_NSNODE            1
1338 #define ACPI_MEM_LIST_MAX               1
1339 #define ACPI_NUM_MEM_LISTS              2
1340
1341
1342 #endif /* __ACLOCAL_H__ */