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