sys/contrib/dev/acpica/source/include/aclocal.h

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