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