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