drivers/acpi/acpica/aclocal.h

   1 /******************************************************************************
   2  *
   3  * Name: aclocal.h - Internal data types used across the ACPI subsystem
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2011, 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 /* acpisrc:struct_defs -- for acpisrc conversion */
  48
  49 #define ACPI_SERIALIZED                 0xFF
  50
  51 typedef u32 acpi_mutex_handle;
  52 #define ACPI_GLOBAL_LOCK                (acpi_semaphore) (-1)
  53
  54 /* Total number of aml opcodes defined */
  55
  56 #define AML_NUM_OPCODES                 0x7F
  57
  58 /* Forward declarations */
  59
  60 struct acpi_walk_state;
  61 struct acpi_obj_mutex;
  62 union acpi_parse_object;
  63
  64 /*****************************************************************************
  65  *
  66  * Mutex typedefs and structs
  67  *
  68  ****************************************************************************/
  69
  70 /*
  71  * Predefined handles for the mutex objects used within the subsystem
  72  * All mutex objects are automatically created by acpi_ut_mutex_initialize.
  73  *
  74  * The acquire/release ordering protocol is implied via this list. Mutexes
  75  * with a lower value must be acquired before mutexes with a higher value.
  76  *
  77  * NOTE: any changes here must be reflected in the acpi_gbl_mutex_names
  78  * table below also!
  79  */
  80 #define ACPI_MTX_INTERPRETER            0       /* AML Interpreter, main lock */
  81 #define ACPI_MTX_NAMESPACE              1       /* ACPI Namespace */
  82 #define ACPI_MTX_TABLES                 2       /* Data for ACPI tables */
  83 #define ACPI_MTX_EVENTS                 3       /* Data for ACPI events */
  84 #define ACPI_MTX_CACHES                 4       /* Internal caches, general purposes */
  85 #define ACPI_MTX_MEMORY                 5       /* Debug memory tracking lists */
  86 #define ACPI_MTX_DEBUG_CMD_COMPLETE     6       /* AML debugger */
  87 #define ACPI_MTX_DEBUG_CMD_READY        7       /* AML debugger */
  88
  89 #define ACPI_MAX_MUTEX                  7
  90 #define ACPI_NUM_MUTEX                  ACPI_MAX_MUTEX+1
  91
  92 /* Lock structure for reader/writer interfaces */
  93
  94 struct acpi_rw_lock {
  95         acpi_mutex writer_mutex;
  96         acpi_mutex reader_mutex;
  97         u32 num_readers;
  98 };
  99
 100 /*
 101  * Predefined handles for spinlocks used within the subsystem.
 102  * These spinlocks are created by acpi_ut_mutex_initialize
 103  */
 104 #define ACPI_LOCK_GPES                  0
 105 #define ACPI_LOCK_HARDWARE              1
 106
 107 #define ACPI_MAX_LOCK                   1
 108 #define ACPI_NUM_LOCK                   ACPI_MAX_LOCK+1
 109
 110 /* This Thread ID means that the mutex is not in use (unlocked) */
 111
 112 #define ACPI_MUTEX_NOT_ACQUIRED         (acpi_thread_id) 0
 113
 114 /* Table for the global mutexes */
 115
 116 struct acpi_mutex_info {
 117         acpi_mutex mutex;
 118         u32 use_count;
 119         acpi_thread_id thread_id;
 120 };
 121
 122 /* Lock flag parameter for various interfaces */
 123
 124 #define ACPI_MTX_DO_NOT_LOCK            0
 125 #define ACPI_MTX_LOCK                   1
 126
 127 /* Field access granularities */
 128
 129 #define ACPI_FIELD_BYTE_GRANULARITY     1
 130 #define ACPI_FIELD_WORD_GRANULARITY     2
 131 #define ACPI_FIELD_DWORD_GRANULARITY    4
 132 #define ACPI_FIELD_QWORD_GRANULARITY    8
 133
 134 #define ACPI_ENTRY_NOT_FOUND            NULL
 135
 136 /*****************************************************************************
 137  *
 138  * Namespace typedefs and structs
 139  *
 140  ****************************************************************************/
 141
 142 /* Operational modes of the AML interpreter/scanner */
 143
 144 typedef enum {
 145         ACPI_IMODE_LOAD_PASS1 = 0x01,
 146         ACPI_IMODE_LOAD_PASS2 = 0x02,
 147         ACPI_IMODE_EXECUTE = 0x03
 148 } acpi_interpreter_mode;
 149
 150 /*
 151  * The Namespace Node describes a named object that appears in the AML.
 152  * descriptor_type is used to differentiate between internal descriptors.
 153  *
 154  * The node is optimized for both 32-bit and 64-bit platforms:
 155  * 20 bytes for the 32-bit case, 32 bytes for the 64-bit case.
 156  *
 157  * Note: The descriptor_type and Type fields must appear in the identical
 158  * position in both the struct acpi_namespace_node and union acpi_operand_object
 159  * structures.
 160  */
 161 struct acpi_namespace_node {
 162         union acpi_operand_object *object;      /* Interpreter object */
 163         u8 descriptor_type;     /* Differentiate object descriptor types */
 164         u8 type;                /* ACPI Type associated with this name */
 165         u8 flags;               /* Miscellaneous flags */
 166         acpi_owner_id owner_id; /* Node creator */
 167         union acpi_name_union name;     /* ACPI Name, always 4 chars per ACPI spec */
 168         struct acpi_namespace_node *parent;     /* Parent node */
 169         struct acpi_namespace_node *child;      /* First child */
 170         struct acpi_namespace_node *peer;       /* First peer */
 171
 172         /*
 173          * The following fields are used by the ASL compiler and disassembler only
 174          */
 175 #ifdef ACPI_LARGE_NAMESPACE_NODE
 176         union acpi_parse_object *op;
 177         u32 value;
 178         u32 length;
 179 #endif
 180 };
 181
 182 /* Namespace Node flags */
 183
 184 #define ANOBJ_RESERVED                  0x01    /* Available for use */
 185 #define ANOBJ_TEMPORARY                 0x02    /* Node is create by a method and is temporary */
 186 #define ANOBJ_METHOD_ARG                0x04    /* Node is a method argument */
 187 #define ANOBJ_METHOD_LOCAL              0x08    /* Node is a method local */
 188 #define ANOBJ_SUBTREE_HAS_INI           0x10    /* Used to optimize device initialization */
 189 #define ANOBJ_EVALUATED                 0x20    /* Set on first evaluation of node */
 190 #define ANOBJ_ALLOCATED_BUFFER          0x40    /* Method AML buffer is dynamic (install_method) */
 191
 192 #define ANOBJ_IS_EXTERNAL               0x08    /* i_aSL only: This object created via External() */
 193 #define ANOBJ_METHOD_NO_RETVAL          0x10    /* i_aSL only: Method has no return value */
 194 #define ANOBJ_METHOD_SOME_NO_RETVAL     0x20    /* i_aSL only: Method has at least one return value */
 195 #define ANOBJ_IS_BIT_OFFSET             0x40    /* i_aSL only: Reference is a bit offset */
 196 #define ANOBJ_IS_REFERENCED             0x80    /* i_aSL only: Object was referenced */
 197
 198 /* Internal ACPI table management - master table list */
 199
 200 struct acpi_table_list {
 201         struct acpi_table_desc *tables; /* Table descriptor array */
 202         u32 current_table_count;        /* Tables currently in the array */
 203         u32 max_table_count;    /* Max tables array will hold */
 204         u8 flags;
 205 };
 206
 207 /* Flags for above */
 208
 209 #define ACPI_ROOT_ORIGIN_UNKNOWN        (0)     /* ~ORIGIN_ALLOCATED */
 210 #define ACPI_ROOT_ORIGIN_ALLOCATED      (1)
 211 #define ACPI_ROOT_ALLOW_RESIZE          (2)
 212
 213 /* Predefined (fixed) table indexes */
 214
 215 #define ACPI_TABLE_INDEX_DSDT           (0)
 216 #define ACPI_TABLE_INDEX_FACS           (1)
 217
 218 struct acpi_find_context {
 219         char *search_for;
 220         acpi_handle *list;
 221         u32 *count;
 222 };
 223
 224 struct acpi_ns_search_data {
 225         struct acpi_namespace_node *node;
 226 };
 227
 228 /* Object types used during package copies */
 229
 230 #define ACPI_COPY_TYPE_SIMPLE           0
 231 #define ACPI_COPY_TYPE_PACKAGE          1
 232
 233 /* Info structure used to convert external<->internal namestrings */
 234
 235 struct acpi_namestring_info {
 236         const char *external_name;
 237         const char *next_external_char;
 238         char *internal_name;
 239         u32 length;
 240         u32 num_segments;
 241         u32 num_carats;
 242         u8 fully_qualified;
 243 };
 244
 245 /* Field creation info */
 246
 247 struct acpi_create_field_info {
 248         struct acpi_namespace_node *region_node;
 249         struct acpi_namespace_node *field_node;
 250         struct acpi_namespace_node *register_node;
 251         struct acpi_namespace_node *data_register_node;
 252         u32 bank_value;
 253         u32 field_bit_position;
 254         u32 field_bit_length;
 255         u8 field_flags;
 256         u8 attribute;
 257         u8 field_type;
 258 };
 259
 260 typedef
 261 acpi_status(*ACPI_INTERNAL_METHOD) (struct acpi_walk_state * walk_state);
 262
 263 /*
 264  * Bitmapped ACPI types.  Used internally only
 265  */
 266 #define ACPI_BTYPE_ANY                  0x00000000
 267 #define ACPI_BTYPE_INTEGER              0x00000001
 268 #define ACPI_BTYPE_STRING               0x00000002
 269 #define ACPI_BTYPE_BUFFER               0x00000004
 270 #define ACPI_BTYPE_PACKAGE              0x00000008
 271 #define ACPI_BTYPE_FIELD_UNIT           0x00000010
 272 #define ACPI_BTYPE_DEVICE               0x00000020
 273 #define ACPI_BTYPE_EVENT                0x00000040
 274 #define ACPI_BTYPE_METHOD               0x00000080
 275 #define ACPI_BTYPE_MUTEX                0x00000100
 276 #define ACPI_BTYPE_REGION               0x00000200
 277 #define ACPI_BTYPE_POWER                0x00000400
 278 #define ACPI_BTYPE_PROCESSOR            0x00000800
 279 #define ACPI_BTYPE_THERMAL              0x00001000
 280 #define ACPI_BTYPE_BUFFER_FIELD         0x00002000
 281 #define ACPI_BTYPE_DDB_HANDLE           0x00004000
 282 #define ACPI_BTYPE_DEBUG_OBJECT         0x00008000
 283 #define ACPI_BTYPE_REFERENCE            0x00010000
 284 #define ACPI_BTYPE_RESOURCE             0x00020000
 285
 286 #define ACPI_BTYPE_COMPUTE_DATA         (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER)
 287
 288 #define ACPI_BTYPE_DATA                 (ACPI_BTYPE_COMPUTE_DATA  | ACPI_BTYPE_PACKAGE)
 289 #define ACPI_BTYPE_DATA_REFERENCE       (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE | ACPI_BTYPE_DDB_HANDLE)
 290 #define ACPI_BTYPE_DEVICE_OBJECTS       (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR)
 291 #define ACPI_BTYPE_OBJECTS_AND_REFS     0x0001FFFF      /* ARG or LOCAL */
 292 #define ACPI_BTYPE_ALL_OBJECTS          0x0000FFFF
 293
 294 /*
 295  * Information structure for ACPI predefined names.
 296  * Each entry in the table contains the following items:
 297  *
 298  * Name                 - The ACPI reserved name
 299  * param_count          - Number of arguments to the method
 300  * expected_return_btypes - Allowed type(s) for the return value
 301  */
 302 struct acpi_name_info {
 303         char name[ACPI_NAME_SIZE];
 304         u8 param_count;
 305         u8 expected_btypes;
 306 };
 307
 308 /*
 309  * Secondary information structures for ACPI predefined objects that return
 310  * package objects. This structure appears as the next entry in the table
 311  * after the NAME_INFO structure above.
 312  *
 313  * The reason for this is to minimize the size of the predefined name table.
 314  */
 315
 316 /*
 317  * Used for ACPI_PTYPE1_FIXED, ACPI_PTYPE1_VAR, ACPI_PTYPE2,
 318  * ACPI_PTYPE2_MIN, ACPI_PTYPE2_PKG_COUNT, ACPI_PTYPE2_COUNT
 319  */
 320 struct acpi_package_info {
 321         u8 type;
 322         u8 object_type1;
 323         u8 count1;
 324         u8 object_type2;
 325         u8 count2;
 326         u8 reserved;
 327 };
 328
 329 /* Used for ACPI_PTYPE2_FIXED */
 330
 331 struct acpi_package_info2 {
 332         u8 type;
 333         u8 count;
 334         u8 object_type[4];
 335 };
 336
 337 /* Used for ACPI_PTYPE1_OPTION */
 338
 339 struct acpi_package_info3 {
 340         u8 type;
 341         u8 count;
 342         u8 object_type[2];
 343         u8 tail_object_type;
 344         u8 reserved;
 345 };
 346
 347 union acpi_predefined_info {
 348         struct acpi_name_info info;
 349         struct acpi_package_info ret_info;
 350         struct acpi_package_info2 ret_info2;
 351         struct acpi_package_info3 ret_info3;
 352 };
 353
 354 /* Data block used during object validation */
 355
 356 struct acpi_predefined_data {
 357         char *pathname;
 358         const union acpi_predefined_info *predefined;
 359         union acpi_operand_object *parent_package;
 360         u32 flags;
 361         u8 node_flags;
 362 };
 363
 364 /* Defines for Flags field above */
 365
 366 #define ACPI_OBJECT_REPAIRED    1
 367
 368 /*
 369  * Bitmapped return value types
 370  * Note: the actual data types must be contiguous, a loop in nspredef.c
 371  * depends on this.
 372  */
 373 #define ACPI_RTYPE_ANY                  0x00
 374 #define ACPI_RTYPE_NONE                 0x01
 375 #define ACPI_RTYPE_INTEGER              0x02
 376 #define ACPI_RTYPE_STRING               0x04
 377 #define ACPI_RTYPE_BUFFER               0x08
 378 #define ACPI_RTYPE_PACKAGE              0x10
 379 #define ACPI_RTYPE_REFERENCE            0x20
 380 #define ACPI_RTYPE_ALL                  0x3F
 381
 382 #define ACPI_NUM_RTYPES                 5       /* Number of actual object types */
 383
 384 /*****************************************************************************
 385  *
 386  * Event typedefs and structs
 387  *
 388  ****************************************************************************/
 389
 390 /* Dispatch info for each GPE -- either a method or handler, cannot be both */
 391
 392 struct acpi_gpe_handler_info {
 393         acpi_gpe_handler address;       /* Address of handler, if any */
 394         void *context;          /* Context to be passed to handler */
 395         struct acpi_namespace_node *method_node;        /* Method node for this GPE level (saved) */
 396         u8 original_flags;      /* Original (pre-handler) GPE info */
 397         u8 originally_enabled;  /* True if GPE was originally enabled */
 398 };
 399
 400 struct acpi_gpe_notify_object {
 401         struct acpi_namespace_node *node;
 402         struct acpi_gpe_notify_object *next;
 403 };
 404
 405 union acpi_gpe_dispatch_info {
 406         struct acpi_namespace_node *method_node;        /* Method node for this GPE level */
 407         struct acpi_gpe_handler_info *handler;  /* Installed GPE handler */
 408         struct acpi_gpe_notify_object device;   /* List of _PRW devices for implicit notify */
 409 };
 410
 411 /*
 412  * Information about a GPE, one per each GPE in an array.
 413  * NOTE: Important to keep this struct as small as possible.
 414  */
 415 struct acpi_gpe_event_info {
 416         union acpi_gpe_dispatch_info dispatch;  /* Either Method or Handler */
 417         struct acpi_gpe_register_info *register_info;   /* Backpointer to register info */
 418         u8 flags;               /* Misc info about this GPE */
 419         u8 gpe_number;          /* This GPE */
 420         u8 runtime_count;       /* References to a run GPE */
 421 };
 422
 423 /* Information about a GPE register pair, one per each status/enable pair in an array */
 424
 425 struct acpi_gpe_register_info {
 426         struct acpi_generic_address status_address;     /* Address of status reg */
 427         struct acpi_generic_address enable_address;     /* Address of enable reg */
 428         u8 enable_for_wake;     /* GPEs to keep enabled when sleeping */
 429         u8 enable_for_run;      /* GPEs to keep enabled when running */
 430         u8 base_gpe_number;     /* Base GPE number for this register */
 431 };
 432
 433 /*
 434  * Information about a GPE register block, one per each installed block --
 435  * GPE0, GPE1, and one per each installed GPE Block Device.
 436  */
 437 struct acpi_gpe_block_info {
 438         struct acpi_namespace_node *node;
 439         struct acpi_gpe_block_info *previous;
 440         struct acpi_gpe_block_info *next;
 441         struct acpi_gpe_xrupt_info *xrupt_block;        /* Backpointer to interrupt block */
 442         struct acpi_gpe_register_info *register_info;   /* One per GPE register pair */
 443         struct acpi_gpe_event_info *event_info; /* One for each GPE */
 444         struct acpi_generic_address block_address;      /* Base address of the block */
 445         u32 register_count;     /* Number of register pairs in block */
 446         u16 gpe_count;          /* Number of individual GPEs in block */
 447         u8 block_base_number;   /* Base GPE number for this block */
 448         u8 initialized;         /* TRUE if this block is initialized */
 449 };
 450
 451 /* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */
 452
 453 struct acpi_gpe_xrupt_info {
 454         struct acpi_gpe_xrupt_info *previous;
 455         struct acpi_gpe_xrupt_info *next;
 456         struct acpi_gpe_block_info *gpe_block_list_head;        /* List of GPE blocks for this xrupt */
 457         u32 interrupt_number;   /* System interrupt number */
 458 };
 459
 460 struct acpi_gpe_walk_info {
 461         struct acpi_namespace_node *gpe_device;
 462         struct acpi_gpe_block_info *gpe_block;
 463         u16 count;
 464         acpi_owner_id owner_id;
 465         u8 execute_by_owner_id;
 466 };
 467
 468 struct acpi_gpe_device_info {
 469         u32 index;
 470         u32 next_block_base_index;
 471         acpi_status status;
 472         struct acpi_namespace_node *gpe_device;
 473 };
 474
 475 typedef acpi_status(*acpi_gpe_callback) (struct acpi_gpe_xrupt_info *gpe_xrupt_info,
 476                 struct acpi_gpe_block_info *gpe_block, void *context);
 477
 478 /* Information about each particular fixed event */
 479
 480 struct acpi_fixed_event_handler {
 481         acpi_event_handler handler;     /* Address of handler. */
 482         void *context;          /* Context to be passed to handler */
 483 };
 484
 485 struct acpi_fixed_event_info {
 486         u8 status_register_id;
 487         u8 enable_register_id;
 488         u16 status_bit_mask;
 489         u16 enable_bit_mask;
 490 };
 491
 492 /* Information used during field processing */
 493
 494 struct acpi_field_info {
 495         u8 skip_field;
 496         u8 field_flag;
 497         u32 pkg_length;
 498 };
 499
 500 /*****************************************************************************
 501  *
 502  * Generic "state" object for stacks
 503  *
 504  ****************************************************************************/
 505
 506 #define ACPI_CONTROL_NORMAL                  0xC0
 507 #define ACPI_CONTROL_CONDITIONAL_EXECUTING   0xC1
 508 #define ACPI_CONTROL_PREDICATE_EXECUTING     0xC2
 509 #define ACPI_CONTROL_PREDICATE_FALSE         0xC3
 510 #define ACPI_CONTROL_PREDICATE_TRUE          0xC4
 511
 512 #define ACPI_STATE_COMMON \
 513         void                            *next; \
 514         u8                              descriptor_type; /* To differentiate various internal objs */\
 515         u8                              flags; \
 516         u16                             value; \
 517         u16                             state;
 518
 519         /* There are 2 bytes available here until the next natural alignment boundary */
 520
 521 struct acpi_common_state {
 522 ACPI_STATE_COMMON};
 523
 524 /*
 525  * Update state - used to traverse complex objects such as packages
 526  */
 527 struct acpi_update_state {
 528         ACPI_STATE_COMMON union acpi_operand_object *object;
 529 };
 530
 531 /*
 532  * Pkg state - used to traverse nested package structures
 533  */
 534 struct acpi_pkg_state {
 535         ACPI_STATE_COMMON u16 index;
 536         union acpi_operand_object *source_object;
 537         union acpi_operand_object *dest_object;
 538         struct acpi_walk_state *walk_state;
 539         void *this_target_obj;
 540         u32 num_packages;
 541 };
 542
 543 /*
 544  * Control state - one per if/else and while constructs.
 545  * Allows nesting of these constructs
 546  */
 547 struct acpi_control_state {
 548         ACPI_STATE_COMMON u16 opcode;
 549         union acpi_parse_object *predicate_op;
 550         u8 *aml_predicate_start;        /* Start of if/while predicate */
 551         u8 *package_end;        /* End of if/while block */
 552         u32 loop_count;         /* While() loop counter */
 553 };
 554
 555 /*
 556  * Scope state - current scope during namespace lookups
 557  */
 558 struct acpi_scope_state {
 559         ACPI_STATE_COMMON struct acpi_namespace_node *node;
 560 };
 561
 562 struct acpi_pscope_state {
 563         ACPI_STATE_COMMON u32 arg_count;        /* Number of fixed arguments */
 564         union acpi_parse_object *op;    /* Current op being parsed */
 565         u8 *arg_end;            /* Current argument end */
 566         u8 *pkg_end;            /* Current package end */
 567         u32 arg_list;           /* Next argument to parse */
 568 };
 569
 570 /*
 571  * Thread state - one per thread across multiple walk states.  Multiple walk
 572  * states are created when there are nested control methods executing.
 573  */
 574 struct acpi_thread_state {
 575         ACPI_STATE_COMMON u8 current_sync_level;        /* Mutex Sync (nested acquire) level */
 576         struct acpi_walk_state *walk_state_list;        /* Head of list of walk_states for this thread */
 577         union acpi_operand_object *acquired_mutex_list; /* List of all currently acquired mutexes */
 578         acpi_thread_id thread_id;       /* Running thread ID */
 579 };
 580
 581 /*
 582  * Result values - used to accumulate the results of nested
 583  * AML arguments
 584  */
 585 struct acpi_result_values {
 586         ACPI_STATE_COMMON
 587             union acpi_operand_object *obj_desc[ACPI_RESULTS_FRAME_OBJ_NUM];
 588 };
 589
 590 typedef
 591 acpi_status(*acpi_parse_downwards) (struct acpi_walk_state * walk_state,
 592                                     union acpi_parse_object ** out_op);
 593
 594 typedef acpi_status(*acpi_parse_upwards) (struct acpi_walk_state * walk_state);
 595
 596 /*
 597  * Notify info - used to pass info to the deferred notify
 598  * handler/dispatcher.
 599  */
 600 struct acpi_notify_info {
 601         ACPI_STATE_COMMON struct acpi_namespace_node *node;
 602         union acpi_operand_object *handler_obj;
 603 };
 604
 605 /* Generic state is union of structs above */
 606
 607 union acpi_generic_state {
 608         struct acpi_common_state common;
 609         struct acpi_control_state control;
 610         struct acpi_update_state update;
 611         struct acpi_scope_state scope;
 612         struct acpi_pscope_state parse_scope;
 613         struct acpi_pkg_state pkg;
 614         struct acpi_thread_state thread;
 615         struct acpi_result_values results;
 616         struct acpi_notify_info notify;
 617 };
 618
 619 /*****************************************************************************
 620  *
 621  * Interpreter typedefs and structs
 622  *
 623  ****************************************************************************/
 624
 625 typedef acpi_status(*ACPI_EXECUTE_OP) (struct acpi_walk_state * walk_state);
 626
 627 /*****************************************************************************
 628  *
 629  * Parser typedefs and structs
 630  *
 631  ****************************************************************************/
 632
 633 /*
 634  * AML opcode, name, and argument layout
 635  */
 636 struct acpi_opcode_info {
 637 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
 638         char *name;             /* Opcode name (disassembler/debug only) */
 639 #endif
 640         u32 parse_args;         /* Grammar/Parse time arguments */
 641         u32 runtime_args;       /* Interpret time arguments */
 642         u16 flags;              /* Misc flags */
 643         u8 object_type;         /* Corresponding internal object type */
 644         u8 class;               /* Opcode class */
 645         u8 type;                /* Opcode type */
 646 };
 647
 648 union acpi_parse_value {
 649         u64 integer;            /* Integer constant (Up to 64 bits) */
 650         u32 size;               /* bytelist or field size */
 651         char *string;           /* NULL terminated string */
 652         u8 *buffer;             /* buffer or string */
 653         char *name;             /* NULL terminated string */
 654         union acpi_parse_object *arg;   /* arguments and contained ops */
 655 };
 656
 657 #ifdef ACPI_DISASSEMBLER
 658 #define ACPI_DISASM_ONLY_MEMBERS(a)     a;
 659 #else
 660 #define ACPI_DISASM_ONLY_MEMBERS(a)
 661 #endif
 662
 663 #define ACPI_PARSE_COMMON \
 664         union acpi_parse_object         *parent;        /* Parent op */\
 665         u8                              descriptor_type; /* To differentiate various internal objs */\
 666         u8                              flags;          /* Type of Op */\
 667         u16                             aml_opcode;     /* AML opcode */\
 668         u32                             aml_offset;     /* Offset of declaration in AML */\
 669         union acpi_parse_object         *next;          /* Next op */\
 670         struct acpi_namespace_node      *node;          /* For use by interpreter */\
 671         union acpi_parse_value          value;          /* Value or args associated with the opcode */\
 672         u8                              arg_list_length; /* Number of elements in the arg list */\
 673         ACPI_DISASM_ONLY_MEMBERS (\
 674         u8                              disasm_flags;   /* Used during AML disassembly */\
 675         u8                              disasm_opcode;  /* Subtype used for disassembly */\
 676         char                            aml_op_name[16])        /* Op name (debug only) */
 677
 678 #define ACPI_DASM_BUFFER                0x00
 679 #define ACPI_DASM_RESOURCE              0x01
 680 #define ACPI_DASM_STRING                0x02
 681 #define ACPI_DASM_UNICODE               0x03
 682 #define ACPI_DASM_EISAID                0x04
 683 #define ACPI_DASM_MATCHOP               0x05
 684 #define ACPI_DASM_LNOT_PREFIX           0x06
 685 #define ACPI_DASM_LNOT_SUFFIX           0x07
 686 #define ACPI_DASM_IGNORE                0x08
 687
 688 /*
 689  * Generic operation (for example:  If, While, Store)
 690  */
 691 struct acpi_parse_obj_common {
 692 ACPI_PARSE_COMMON};
 693
 694 /*
 695  * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and op_regions),
 696  * and bytelists.
 697  */
 698 struct acpi_parse_obj_named {
 699         ACPI_PARSE_COMMON u8 *path;
 700         u8 *data;               /* AML body or bytelist data */
 701         u32 length;             /* AML length */
 702         u32 name;               /* 4-byte name or zero if no name */
 703 };
 704
 705 /* This version is used by the i_aSL compiler only */
 706
 707 #define ACPI_MAX_PARSEOP_NAME   20
 708
 709 struct acpi_parse_obj_asl {
 710         ACPI_PARSE_COMMON union acpi_parse_object *child;
 711         union acpi_parse_object *parent_method;
 712         char *filename;
 713         char *external_name;
 714         char *namepath;
 715         char name_seg[4];
 716         u32 extra_value;
 717         u32 column;
 718         u32 line_number;
 719         u32 logical_line_number;
 720         u32 logical_byte_offset;
 721         u32 end_line;
 722         u32 end_logical_line;
 723         u32 acpi_btype;
 724         u32 aml_length;
 725         u32 aml_subtree_length;
 726         u32 final_aml_length;
 727         u32 final_aml_offset;
 728         u32 compile_flags;
 729         u16 parse_opcode;
 730         u8 aml_opcode_length;
 731         u8 aml_pkg_len_bytes;
 732         u8 extra;
 733         char parse_op_name[ACPI_MAX_PARSEOP_NAME];
 734 };
 735
 736 union acpi_parse_object {
 737         struct acpi_parse_obj_common common;
 738         struct acpi_parse_obj_named named;
 739         struct acpi_parse_obj_asl asl;
 740 };
 741
 742 /*
 743  * Parse state - one state per parser invocation and each control
 744  * method.
 745  */
 746 struct acpi_parse_state {
 747         u8 *aml_start;          /* First AML byte */
 748         u8 *aml;                /* Next AML byte */
 749         u8 *aml_end;            /* (last + 1) AML byte */
 750         u8 *pkg_start;          /* Current package begin */
 751         u8 *pkg_end;            /* Current package end */
 752         union acpi_parse_object *start_op;      /* Root of parse tree */
 753         struct acpi_namespace_node *start_node;
 754         union acpi_generic_state *scope;        /* Current scope */
 755         union acpi_parse_object *start_scope;
 756         u32 aml_size;
 757 };
 758
 759 /* Parse object flags */
 760
 761 #define ACPI_PARSEOP_GENERIC            0x01
 762 #define ACPI_PARSEOP_NAMED              0x02
 763 #define ACPI_PARSEOP_DEFERRED           0x04
 764 #define ACPI_PARSEOP_BYTELIST           0x08
 765 #define ACPI_PARSEOP_IN_STACK           0x10
 766 #define ACPI_PARSEOP_TARGET             0x20
 767 #define ACPI_PARSEOP_IN_CACHE           0x80
 768
 769 /* Parse object disasm_flags */
 770
 771 #define ACPI_PARSEOP_IGNORE             0x01
 772 #define ACPI_PARSEOP_PARAMLIST          0x02
 773 #define ACPI_PARSEOP_EMPTY_TERMLIST     0x04
 774 #define ACPI_PARSEOP_SPECIAL            0x10
 775
 776 /*****************************************************************************
 777  *
 778  * Hardware (ACPI registers) and PNP
 779  *
 780  ****************************************************************************/
 781
 782 struct acpi_bit_register_info {
 783         u8 parent_register;
 784         u8 bit_position;
 785         u16 access_bit_mask;
 786 };
 787
 788 /*
 789  * Some ACPI registers have bits that must be ignored -- meaning that they
 790  * must be preserved.
 791  */
 792 #define ACPI_PM1_STATUS_PRESERVED_BITS          0x0800  /* Bit 11 */
 793
 794 /* Write-only bits must be zeroed by software */
 795
 796 #define ACPI_PM1_CONTROL_WRITEONLY_BITS         0x2004  /* Bits 13, 2 */
 797
 798 /* For control registers, both ignored and reserved bits must be preserved */
 799
 800 /*
 801  * For PM1 control, the SCI enable bit (bit 0, SCI_EN) is defined by the
 802  * ACPI specification to be a "preserved" bit - "OSPM always preserves this
 803  * bit position", section 4.7.3.2.1. However, on some machines the OS must
 804  * write a one to this bit after resume for the machine to work properly.
 805  * To enable this, we no longer attempt to preserve this bit. No machines
 806  * are known to fail if the bit is not preserved. (May 2009)
 807  */
 808 #define ACPI_PM1_CONTROL_IGNORED_BITS           0x0200  /* Bit 9 */
 809 #define ACPI_PM1_CONTROL_RESERVED_BITS          0xC1F8  /* Bits 14-15, 3-8 */
 810 #define ACPI_PM1_CONTROL_PRESERVED_BITS \
 811                (ACPI_PM1_CONTROL_IGNORED_BITS | ACPI_PM1_CONTROL_RESERVED_BITS)
 812
 813 #define ACPI_PM2_CONTROL_PRESERVED_BITS         0xFFFFFFFE      /* All except bit 0 */
 814
 815 /*
 816  * Register IDs
 817  * These are the full ACPI registers
 818  */
 819 #define ACPI_REGISTER_PM1_STATUS                0x01
 820 #define ACPI_REGISTER_PM1_ENABLE                0x02
 821 #define ACPI_REGISTER_PM1_CONTROL               0x03
 822 #define ACPI_REGISTER_PM2_CONTROL               0x04
 823 #define ACPI_REGISTER_PM_TIMER                  0x05
 824 #define ACPI_REGISTER_PROCESSOR_BLOCK           0x06
 825 #define ACPI_REGISTER_SMI_COMMAND_BLOCK         0x07
 826
 827 /* Masks used to access the bit_registers */
 828
 829 #define ACPI_BITMASK_TIMER_STATUS               0x0001
 830 #define ACPI_BITMASK_BUS_MASTER_STATUS          0x0010
 831 #define ACPI_BITMASK_GLOBAL_LOCK_STATUS         0x0020
 832 #define ACPI_BITMASK_POWER_BUTTON_STATUS        0x0100
 833 #define ACPI_BITMASK_SLEEP_BUTTON_STATUS        0x0200
 834 #define ACPI_BITMASK_RT_CLOCK_STATUS            0x0400
 835 #define ACPI_BITMASK_PCIEXP_WAKE_STATUS         0x4000  /* ACPI 3.0 */
 836 #define ACPI_BITMASK_WAKE_STATUS                0x8000
 837
 838 #define ACPI_BITMASK_ALL_FIXED_STATUS           (\
 839         ACPI_BITMASK_TIMER_STATUS          | \
 840         ACPI_BITMASK_BUS_MASTER_STATUS     | \
 841         ACPI_BITMASK_GLOBAL_LOCK_STATUS    | \
 842         ACPI_BITMASK_POWER_BUTTON_STATUS   | \
 843         ACPI_BITMASK_SLEEP_BUTTON_STATUS   | \
 844         ACPI_BITMASK_RT_CLOCK_STATUS       | \
 845         ACPI_BITMASK_PCIEXP_WAKE_STATUS    | \
 846         ACPI_BITMASK_WAKE_STATUS)
 847
 848 #define ACPI_BITMASK_TIMER_ENABLE               0x0001
 849 #define ACPI_BITMASK_GLOBAL_LOCK_ENABLE         0x0020
 850 #define ACPI_BITMASK_POWER_BUTTON_ENABLE        0x0100
 851 #define ACPI_BITMASK_SLEEP_BUTTON_ENABLE        0x0200
 852 #define ACPI_BITMASK_RT_CLOCK_ENABLE            0x0400
 853 #define ACPI_BITMASK_PCIEXP_WAKE_DISABLE        0x4000  /* ACPI 3.0 */
 854
 855 #define ACPI_BITMASK_SCI_ENABLE                 0x0001
 856 #define ACPI_BITMASK_BUS_MASTER_RLD             0x0002
 857 #define ACPI_BITMASK_GLOBAL_LOCK_RELEASE        0x0004
 858 #define ACPI_BITMASK_SLEEP_TYPE                 0x1C00
 859 #define ACPI_BITMASK_SLEEP_ENABLE               0x2000
 860
 861 #define ACPI_BITMASK_ARB_DISABLE                0x0001
 862
 863 /* Raw bit position of each bit_register */
 864
 865 #define ACPI_BITPOSITION_TIMER_STATUS           0x00
 866 #define ACPI_BITPOSITION_BUS_MASTER_STATUS      0x04
 867 #define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS     0x05
 868 #define ACPI_BITPOSITION_POWER_BUTTON_STATUS    0x08
 869 #define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS    0x09
 870 #define ACPI_BITPOSITION_RT_CLOCK_STATUS        0x0A
 871 #define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS     0x0E    /* ACPI 3.0 */
 872 #define ACPI_BITPOSITION_WAKE_STATUS            0x0F
 873
 874 #define ACPI_BITPOSITION_TIMER_ENABLE           0x00
 875 #define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE     0x05
 876 #define ACPI_BITPOSITION_POWER_BUTTON_ENABLE    0x08
 877 #define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE    0x09
 878 #define ACPI_BITPOSITION_RT_CLOCK_ENABLE        0x0A
 879 #define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE    0x0E    /* ACPI 3.0 */
 880
 881 #define ACPI_BITPOSITION_SCI_ENABLE             0x00
 882 #define ACPI_BITPOSITION_BUS_MASTER_RLD         0x01
 883 #define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE    0x02
 884 #define ACPI_BITPOSITION_SLEEP_TYPE             0x0A
 885 #define ACPI_BITPOSITION_SLEEP_ENABLE           0x0D
 886
 887 #define ACPI_BITPOSITION_ARB_DISABLE            0x00
 888
 889 /* Structs and definitions for _OSI support and I/O port validation */
 890
 891 #define ACPI_OSI_WIN_2000               0x01
 892 #define ACPI_OSI_WIN_XP                 0x02
 893 #define ACPI_OSI_WIN_XP_SP1             0x03
 894 #define ACPI_OSI_WINSRV_2003            0x04
 895 #define ACPI_OSI_WIN_XP_SP2             0x05
 896 #define ACPI_OSI_WINSRV_2003_SP1        0x06
 897 #define ACPI_OSI_WIN_VISTA              0x07
 898 #define ACPI_OSI_WINSRV_2008            0x08
 899 #define ACPI_OSI_WIN_VISTA_SP1          0x09
 900 #define ACPI_OSI_WIN_VISTA_SP2          0x0A
 901 #define ACPI_OSI_WIN_7                  0x0B
 902
 903 #define ACPI_ALWAYS_ILLEGAL             0x00
 904
 905 struct acpi_interface_info {
 906         char *name;
 907         struct acpi_interface_info *next;
 908         u8 flags;
 909         u8 value;
 910 };
 911
 912 #define ACPI_OSI_INVALID                0x01
 913 #define ACPI_OSI_DYNAMIC                0x02
 914
 915 struct acpi_port_info {
 916         char *name;
 917         u16 start;
 918         u16 end;
 919         u8 osi_dependency;
 920 };
 921
 922 /*****************************************************************************
 923  *
 924  * Resource descriptors
 925  *
 926  ****************************************************************************/
 927
 928 /* resource_type values */
 929
 930 #define ACPI_ADDRESS_TYPE_MEMORY_RANGE          0
 931 #define ACPI_ADDRESS_TYPE_IO_RANGE              1
 932 #define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE      2
 933
 934 /* Resource descriptor types and masks */
 935
 936 #define ACPI_RESOURCE_NAME_LARGE                0x80
 937 #define ACPI_RESOURCE_NAME_SMALL                0x00
 938
 939 #define ACPI_RESOURCE_NAME_SMALL_MASK           0x78    /* Bits 6:3 contain the type */
 940 #define ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK    0x07    /* Bits 2:0 contain the length */
 941 #define ACPI_RESOURCE_NAME_LARGE_MASK           0x7F    /* Bits 6:0 contain the type */
 942
 943 /*
 944  * Small resource descriptor "names" as defined by the ACPI specification.
 945  * Note: Bits 2:0 are used for the descriptor length
 946  */
 947 #define ACPI_RESOURCE_NAME_IRQ                  0x20
 948 #define ACPI_RESOURCE_NAME_DMA                  0x28
 949 #define ACPI_RESOURCE_NAME_START_DEPENDENT      0x30
 950 #define ACPI_RESOURCE_NAME_END_DEPENDENT        0x38
 951 #define ACPI_RESOURCE_NAME_IO                   0x40
 952 #define ACPI_RESOURCE_NAME_FIXED_IO             0x48
 953 #define ACPI_RESOURCE_NAME_RESERVED_S1          0x50
 954 #define ACPI_RESOURCE_NAME_RESERVED_S2          0x58
 955 #define ACPI_RESOURCE_NAME_RESERVED_S3          0x60
 956 #define ACPI_RESOURCE_NAME_RESERVED_S4          0x68
 957 #define ACPI_RESOURCE_NAME_VENDOR_SMALL         0x70
 958 #define ACPI_RESOURCE_NAME_END_TAG              0x78
 959
 960 /*
 961  * Large resource descriptor "names" as defined by the ACPI specification.
 962  * Note: includes the Large Descriptor bit in bit[7]
 963  */
 964 #define ACPI_RESOURCE_NAME_MEMORY24             0x81
 965 #define ACPI_RESOURCE_NAME_GENERIC_REGISTER     0x82
 966 #define ACPI_RESOURCE_NAME_RESERVED_L1          0x83
 967 #define ACPI_RESOURCE_NAME_VENDOR_LARGE         0x84
 968 #define ACPI_RESOURCE_NAME_MEMORY32             0x85
 969 #define ACPI_RESOURCE_NAME_FIXED_MEMORY32       0x86
 970 #define ACPI_RESOURCE_NAME_ADDRESS32            0x87
 971 #define ACPI_RESOURCE_NAME_ADDRESS16            0x88
 972 #define ACPI_RESOURCE_NAME_EXTENDED_IRQ         0x89
 973 #define ACPI_RESOURCE_NAME_ADDRESS64            0x8A
 974 #define ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64   0x8B
 975 #define ACPI_RESOURCE_NAME_LARGE_MAX            0x8B
 976
 977 /*****************************************************************************
 978  *
 979  * Miscellaneous
 980  *
 981  ****************************************************************************/
 982
 983 #define ACPI_ASCII_ZERO                 0x30
 984
 985 /*****************************************************************************
 986  *
 987  * Debugger
 988  *
 989  ****************************************************************************/
 990
 991 struct acpi_db_method_info {
 992         acpi_handle main_thread_gate;
 993         acpi_handle thread_complete_gate;
 994         acpi_thread_id *threads;
 995         u32 num_threads;
 996         u32 num_created;
 997         u32 num_completed;
 998
 999         char *name;
1000         u32 flags;
1001         u32 num_loops;
1002         char pathname[128];
1003         char **args;
1004
1005         /*
1006          * Arguments to be passed to method for the command
1007          * Threads -
1008          *   the Number of threads, ID of current thread and
1009          *   Index of current thread inside all them created.
1010          */
1011         char init_args;
1012         char *arguments[4];
1013         char num_threads_str[11];
1014         char id_of_thread_str[11];
1015         char index_of_thread_str[11];
1016 };
1017
1018 struct acpi_integrity_info {
1019         u32 nodes;
1020         u32 objects;
1021 };
1022
1023 #define ACPI_DB_REDIRECTABLE_OUTPUT     0x01
1024 #define ACPI_DB_CONSOLE_OUTPUT          0x02
1025 #define ACPI_DB_DUPLICATE_OUTPUT        0x03
1026
1027 /*****************************************************************************
1028  *
1029  * Debug
1030  *
1031  ****************************************************************************/
1032
1033 /* Entry for a memory allocation (debug only) */
1034
1035 #define ACPI_MEM_MALLOC                 0
1036 #define ACPI_MEM_CALLOC                 1
1037 #define ACPI_MAX_MODULE_NAME            16
1038
1039 #define ACPI_COMMON_DEBUG_MEM_HEADER \
1040         struct acpi_debug_mem_block     *previous; \
1041         struct acpi_debug_mem_block     *next; \
1042         u32                             size; \
1043         u32                             component; \
1044         u32                             line; \
1045         char                            module[ACPI_MAX_MODULE_NAME]; \
1046         u8                              alloc_type;
1047
1048 struct acpi_debug_mem_header {
1049 ACPI_COMMON_DEBUG_MEM_HEADER};
1050
1051 struct acpi_debug_mem_block {
1052         ACPI_COMMON_DEBUG_MEM_HEADER u64 user_space;
1053 };
1054
1055 #define ACPI_MEM_LIST_GLOBAL            0
1056 #define ACPI_MEM_LIST_NSNODE            1
1057 #define ACPI_MEM_LIST_MAX               1
1058 #define ACPI_NUM_MEM_LISTS              2
1059
1060 #endif                          /* __ACLOCAL_H__ */