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