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