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