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 - 2006, R. Byron Moore
   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_INFINITE_CONCURRENCY       0xFF
  51
  52 typedef void *acpi_mutex;
  53 typedef u32 acpi_mutex_handle;
  54
  55 /* Total number of aml opcodes defined */
  56
  57 #define AML_NUM_OPCODES                 0x7F
  58
  59 /* Forward declarations */
  60
  61 struct acpi_walk_state;
  62 struct acpi_obj_mutex;
  63 union acpi_parse_object;
  64
  65 /*****************************************************************************
  66  *
  67  * Mutex typedefs and structs
  68  *
  69  ****************************************************************************/
  70
  71 /*
  72  * Predefined handles for the mutex objects used within the subsystem
  73  * All mutex objects are automatically created by acpi_ut_mutex_initialize.
  74  *
  75  * The acquire/release ordering protocol is implied via this list. Mutexes
  76  * with a lower value must be acquired before mutexes with a higher value.
  77  *
  78  * NOTE: any changes here must be reflected in the acpi_gbl_mutex_names
  79  * table below also!
  80  */
  81 #define ACPI_MTX_INTERPRETER            0       /* AML Interpreter, main lock */
  82 #define ACPI_MTX_CONTROL_METHOD         1       /* Control method termination [TBD: may no longer be necessary] */
  83 #define ACPI_MTX_TABLES                 2       /* Data for ACPI tables */
  84 #define ACPI_MTX_NAMESPACE              3       /* ACPI Namespace */
  85 #define ACPI_MTX_EVENTS                 4       /* Data for ACPI events */
  86 #define ACPI_MTX_CACHES                 5       /* Internal caches, general purposes */
  87 #define ACPI_MTX_MEMORY                 6       /* Debug memory tracking lists */
  88 #define ACPI_MTX_DEBUG_CMD_COMPLETE     7       /* AML debugger */
  89 #define ACPI_MTX_DEBUG_CMD_READY        8       /* AML debugger */
  90
  91 #define ACPI_MAX_MUTEX                  8
  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_Method",
 102         "ACPI_MTX_Tables",
 103         "ACPI_MTX_Namespace",
 104         "ACPI_MTX_Events",
 105         "ACPI_MTX_Caches",
 106         "ACPI_MTX_Memory",
 107         "ACPI_MTX_DebugCmdComplete",
 108         "ACPI_MTX_DebugCmdReady"
 109 };
 110
 111 #endif
 112 #endif
 113
 114 /*
 115  * Predefined handles for spinlocks used within the subsystem.
 116  * These spinlocks are created by acpi_ut_mutex_initialize
 117  */
 118 #define ACPI_LOCK_GPES                  0
 119 #define ACPI_LOCK_HARDWARE              1
 120
 121 #define ACPI_MAX_LOCK                   1
 122 #define ACPI_NUM_LOCK                   ACPI_MAX_LOCK+1
 123
 124 /* Owner IDs are used to track namespace nodes for selective deletion */
 125
 126 typedef u8 acpi_owner_id;
 127 #define ACPI_OWNER_ID_MAX               0xFF
 128
 129 /* This Thread ID means that the mutex is not in use (unlocked) */
 130
 131 #define ACPI_MUTEX_NOT_ACQUIRED         (u32) -1
 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 = 0x0E
 167 } acpi_interpreter_mode;
 168
 169 union acpi_name_union {
 170         u32 integer;
 171         char ascii[4];
 172 };
 173
 174 /*
 175  * The Namespace Node describes a named object that appears in the AML.
 176  * descriptor_type is used to differentiate between internal descriptors.
 177  *
 178  * The node is optimized for both 32-bit and 64-bit platforms:
 179  * 20 bytes for the 32-bit case, 32 bytes for the 64-bit case.
 180  *
 181  * Note: The descriptor_type and Type fields must appear in the identical
 182  * position in both the struct acpi_namespace_node and union acpi_operand_object
 183  * structures.
 184  */
 185 struct acpi_namespace_node {
 186         union acpi_operand_object *object;      /* Interpreter object */
 187         u8 descriptor_type;     /* Differentiate object descriptor types */
 188         u8 type;                /* ACPI Type associated with this name */
 189         u8 flags;               /* Miscellaneous flags */
 190         acpi_owner_id owner_id; /* Node creator */
 191         union acpi_name_union name;     /* ACPI Name, always 4 chars per ACPI spec */
 192         struct acpi_namespace_node *child;      /* First child */
 193         struct acpi_namespace_node *peer;       /* Peer. Parent if ANOBJ_END_OF_PEER_LIST set */
 194
 195         /*
 196          * The following fields are used by the ASL compiler and disassembler only
 197          */
 198 #ifdef ACPI_LARGE_NAMESPACE_NODE
 199         union acpi_parse_object *op;
 200         u32 value;
 201         u32 length;
 202 #endif
 203 };
 204
 205 /* Namespace Node flags */
 206
 207 #define ANOBJ_END_OF_PEER_LIST          0x01    /* End-of-list, Peer field points to parent */
 208 #define ANOBJ_DATA_WIDTH_32             0x02    /* Parent table uses 32-bit math */
 209 #define ANOBJ_METHOD_ARG                0x04    /* Node is a method argument */
 210 #define ANOBJ_METHOD_LOCAL              0x08    /* Node is a method local */
 211 #define ANOBJ_SUBTREE_HAS_INI           0x10    /* Used to optimize device initialization */
 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         struct acpi_table_desc *prev;
 224         struct acpi_table_desc *next;
 225         struct acpi_table_desc *installed_desc;
 226         struct acpi_table_header *pointer;
 227         u8 *aml_start;
 228         u64 physical_address;
 229         acpi_size length;
 230         u32 aml_length;
 231         acpi_owner_id owner_id;
 232         u8 type;
 233         u8 allocation;
 234         u8 loaded_into_namespace;
 235 };
 236
 237 struct acpi_table_list {
 238         struct acpi_table_desc *next;
 239         u32 count;
 240 };
 241
 242 struct acpi_find_context {
 243         char *search_for;
 244         acpi_handle *list;
 245         u32 *count;
 246 };
 247
 248 struct acpi_ns_search_data {
 249         struct acpi_namespace_node *node;
 250 };
 251
 252 /*
 253  * Predefined Namespace items
 254  */
 255 struct acpi_predefined_names {
 256         char *name;
 257         u8 type;
 258         char *val;
 259 };
 260
 261 /* Object types used during package copies */
 262
 263 #define ACPI_COPY_TYPE_SIMPLE           0
 264 #define ACPI_COPY_TYPE_PACKAGE          1
 265
 266 /* Info structure used to convert external<->internal namestrings */
 267
 268 struct acpi_namestring_info {
 269         char *external_name;
 270         char *next_external_char;
 271         char *internal_name;
 272         u32 length;
 273         u32 num_segments;
 274         u32 num_carats;
 275         u8 fully_qualified;
 276 };
 277
 278 /* Field creation info */
 279
 280 struct acpi_create_field_info {
 281         struct acpi_namespace_node *region_node;
 282         struct acpi_namespace_node *field_node;
 283         struct acpi_namespace_node *register_node;
 284         struct acpi_namespace_node *data_register_node;
 285         u32 bank_value;
 286         u32 field_bit_position;
 287         u32 field_bit_length;
 288         u8 field_flags;
 289         u8 attribute;
 290         u8 field_type;
 291 };
 292
 293 typedef
 294 acpi_status(*ACPI_INTERNAL_METHOD) (struct acpi_walk_state * walk_state);
 295
 296 /*
 297  * Bitmapped ACPI types.  Used internally only
 298  */
 299 #define ACPI_BTYPE_ANY                  0x00000000
 300 #define ACPI_BTYPE_INTEGER              0x00000001
 301 #define ACPI_BTYPE_STRING               0x00000002
 302 #define ACPI_BTYPE_BUFFER               0x00000004
 303 #define ACPI_BTYPE_PACKAGE              0x00000008
 304 #define ACPI_BTYPE_FIELD_UNIT           0x00000010
 305 #define ACPI_BTYPE_DEVICE               0x00000020
 306 #define ACPI_BTYPE_EVENT                0x00000040
 307 #define ACPI_BTYPE_METHOD               0x00000080
 308 #define ACPI_BTYPE_MUTEX                0x00000100
 309 #define ACPI_BTYPE_REGION               0x00000200
 310 #define ACPI_BTYPE_POWER                0x00000400
 311 #define ACPI_BTYPE_PROCESSOR            0x00000800
 312 #define ACPI_BTYPE_THERMAL              0x00001000
 313 #define ACPI_BTYPE_BUFFER_FIELD         0x00002000
 314 #define ACPI_BTYPE_DDB_HANDLE           0x00004000
 315 #define ACPI_BTYPE_DEBUG_OBJECT         0x00008000
 316 #define ACPI_BTYPE_REFERENCE            0x00010000
 317 #define ACPI_BTYPE_RESOURCE             0x00020000
 318
 319 #define ACPI_BTYPE_COMPUTE_DATA         (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER)
 320
 321 #define ACPI_BTYPE_DATA                 (ACPI_BTYPE_COMPUTE_DATA  | ACPI_BTYPE_PACKAGE)
 322 #define ACPI_BTYPE_DATA_REFERENCE       (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE | ACPI_BTYPE_DDB_HANDLE)
 323 #define ACPI_BTYPE_DEVICE_OBJECTS       (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR)
 324 #define ACPI_BTYPE_OBJECTS_AND_REFS     0x0001FFFF      /* ARG or LOCAL */
 325 #define ACPI_BTYPE_ALL_OBJECTS          0x0000FFFF
 326
 327 /*****************************************************************************
 328  *
 329  * Event typedefs and structs
 330  *
 331  ****************************************************************************/
 332
 333 /* Dispatch info for each GPE -- either a method or handler, cannot be both */
 334
 335 struct acpi_handler_info {
 336         acpi_event_handler address;     /* Address of handler, if any */
 337         void *context;          /* Context to be passed to handler */
 338         struct acpi_namespace_node *method_node;        /* Method node for this GPE level (saved) */
 339 };
 340
 341 union acpi_gpe_dispatch_info {
 342         struct acpi_namespace_node *method_node;        /* Method node for this GPE level */
 343         struct acpi_handler_info *handler;
 344 };
 345
 346 /*
 347  * Information about a GPE, one per each GPE in an array.
 348  * NOTE: Important to keep this struct as small as possible.
 349  */
 350 struct acpi_gpe_event_info {
 351         union acpi_gpe_dispatch_info dispatch;  /* Either Method or Handler */
 352         struct acpi_gpe_register_info *register_info;   /* Backpointer to register info */
 353         u8 flags;               /* Misc info about this GPE */
 354         u8 register_bit;        /* This GPE bit within the register */
 355 };
 356
 357 /* Information about a GPE register pair, one per each status/enable pair in an array */
 358
 359 struct acpi_gpe_register_info {
 360         struct acpi_generic_address status_address;     /* Address of status reg */
 361         struct acpi_generic_address enable_address;     /* Address of enable reg */
 362         u8 enable_for_wake;     /* GPEs to keep enabled when sleeping */
 363         u8 enable_for_run;      /* GPEs to keep enabled when running */
 364         u8 base_gpe_number;     /* Base GPE number for this register */
 365 };
 366
 367 /*
 368  * Information about a GPE register block, one per each installed block --
 369  * GPE0, GPE1, and one per each installed GPE Block Device.
 370  */
 371 struct acpi_gpe_block_info {
 372         struct acpi_namespace_node *node;
 373         struct acpi_gpe_block_info *previous;
 374         struct acpi_gpe_block_info *next;
 375         struct acpi_gpe_xrupt_info *xrupt_block;        /* Backpointer to interrupt block */
 376         struct acpi_gpe_register_info *register_info;   /* One per GPE register pair */
 377         struct acpi_gpe_event_info *event_info; /* One for each GPE */
 378         struct acpi_generic_address block_address;      /* Base address of the block */
 379         u32 register_count;     /* Number of register pairs in block */
 380         u8 block_base_number;   /* Base GPE number for this block */
 381 };
 382
 383 /* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */
 384
 385 struct acpi_gpe_xrupt_info {
 386         struct acpi_gpe_xrupt_info *previous;
 387         struct acpi_gpe_xrupt_info *next;
 388         struct acpi_gpe_block_info *gpe_block_list_head;        /* List of GPE blocks for this xrupt */
 389         u32 interrupt_number;   /* System interrupt number */
 390 };
 391
 392 struct acpi_gpe_walk_info {
 393         struct acpi_namespace_node *gpe_device;
 394         struct acpi_gpe_block_info *gpe_block;
 395 };
 396
 397 typedef acpi_status(*acpi_gpe_callback) (struct acpi_gpe_xrupt_info *
 398                                          gpe_xrupt_info,
 399                                          struct acpi_gpe_block_info *
 400                                          gpe_block);
 401
 402 /* Information about each particular fixed event */
 403
 404 struct acpi_fixed_event_handler {
 405         acpi_event_handler handler;     /* Address of handler. */
 406         void *context;          /* Context to be passed to handler */
 407 };
 408
 409 struct acpi_fixed_event_info {
 410         u8 status_register_id;
 411         u8 enable_register_id;
 412         u16 status_bit_mask;
 413         u16 enable_bit_mask;
 414 };
 415
 416 /* Information used during field processing */
 417
 418 struct acpi_field_info {
 419         u8 skip_field;
 420         u8 field_flag;
 421         u32 pkg_length;
 422 };
 423
 424 /*****************************************************************************
 425  *
 426  * Generic "state" object for stacks
 427  *
 428  ****************************************************************************/
 429
 430 #define ACPI_CONTROL_NORMAL                  0xC0
 431 #define ACPI_CONTROL_CONDITIONAL_EXECUTING   0xC1
 432 #define ACPI_CONTROL_PREDICATE_EXECUTING     0xC2
 433 #define ACPI_CONTROL_PREDICATE_FALSE         0xC3
 434 #define ACPI_CONTROL_PREDICATE_TRUE          0xC4
 435
 436 #define ACPI_STATE_COMMON \
 437         void                            *next; \
 438         u8                              descriptor_type; /* To differentiate various internal objs */\
 439         u8                              flags; \
 440         u16                             value; \
 441         u16                             state;
 442
 443         /* There are 2 bytes available here until the next natural alignment boundary */
 444
 445 struct acpi_common_state {
 446 ACPI_STATE_COMMON};
 447
 448 /*
 449  * Update state - used to traverse complex objects such as packages
 450  */
 451 struct acpi_update_state {
 452         ACPI_STATE_COMMON union acpi_operand_object *object;
 453 };
 454
 455 /*
 456  * Pkg state - used to traverse nested package structures
 457  */
 458 struct acpi_pkg_state {
 459         ACPI_STATE_COMMON u16 index;
 460         union acpi_operand_object *source_object;
 461         union acpi_operand_object *dest_object;
 462         struct acpi_walk_state *walk_state;
 463         void *this_target_obj;
 464         u32 num_packages;
 465 };
 466
 467 /*
 468  * Control state - one per if/else and while constructs.
 469  * Allows nesting of these constructs
 470  */
 471 struct acpi_control_state {
 472         ACPI_STATE_COMMON u16 opcode;
 473         union acpi_parse_object *predicate_op;
 474         u8 *aml_predicate_start;        /* Start of if/while predicate */
 475         u8 *package_end;        /* End of if/while block */
 476 };
 477
 478 /*
 479  * Scope state - current scope during namespace lookups
 480  */
 481 struct acpi_scope_state {
 482         ACPI_STATE_COMMON struct acpi_namespace_node *node;
 483 };
 484
 485 struct acpi_pscope_state {
 486         ACPI_STATE_COMMON u32 arg_count;        /* Number of fixed arguments */
 487         union acpi_parse_object *op;    /* Current op being parsed */
 488         u8 *arg_end;            /* Current argument end */
 489         u8 *pkg_end;            /* Current package end */
 490         u32 arg_list;           /* Next argument to parse */
 491 };
 492
 493 /*
 494  * Thread state - one per thread across multiple walk states.  Multiple walk
 495  * states are created when there are nested control methods executing.
 496  */
 497 struct acpi_thread_state {
 498         ACPI_STATE_COMMON u8 current_sync_level;        /* Mutex Sync (nested acquire) level */
 499         struct acpi_walk_state *walk_state_list;        /* Head of list of walk_states for this thread */
 500         union acpi_operand_object *acquired_mutex_list; /* List of all currently acquired mutexes */
 501         acpi_thread_id thread_id;       /* Running thread ID */
 502 };
 503
 504 /*
 505  * Result values - used to accumulate the results of nested
 506  * AML arguments
 507  */
 508 struct acpi_result_values {
 509         ACPI_STATE_COMMON u8 num_results;
 510         u8 last_insert;
 511         union acpi_operand_object *obj_desc[ACPI_OBJ_NUM_OPERANDS];
 512 };
 513
 514 typedef
 515 acpi_status(*acpi_parse_downwards) (struct acpi_walk_state * walk_state,
 516                                     union acpi_parse_object ** out_op);
 517
 518 typedef acpi_status(*acpi_parse_upwards) (struct acpi_walk_state * walk_state);
 519
 520 /*
 521  * Notify info - used to pass info to the deferred notify
 522  * handler/dispatcher.
 523  */
 524 struct acpi_notify_info {
 525         ACPI_STATE_COMMON struct acpi_namespace_node *node;
 526         union acpi_operand_object *handler_obj;
 527 };
 528
 529 /* Generic state is union of structs above */
 530
 531 union acpi_generic_state {
 532         struct acpi_common_state common;
 533         struct acpi_control_state control;
 534         struct acpi_update_state update;
 535         struct acpi_scope_state scope;
 536         struct acpi_pscope_state parse_scope;
 537         struct acpi_pkg_state pkg;
 538         struct acpi_thread_state thread;
 539         struct acpi_result_values results;
 540         struct acpi_notify_info notify;
 541 };
 542
 543 /*****************************************************************************
 544  *
 545  * Interpreter typedefs and structs
 546  *
 547  ****************************************************************************/
 548
 549 typedef acpi_status(*ACPI_EXECUTE_OP) (struct acpi_walk_state * walk_state);
 550
 551 /*****************************************************************************
 552  *
 553  * Parser typedefs and structs
 554  *
 555  ****************************************************************************/
 556
 557 /*
 558  * AML opcode, name, and argument layout
 559  */
 560 struct acpi_opcode_info {
 561 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
 562         char *name;             /* Opcode name (disassembler/debug only) */
 563 #endif
 564         u32 parse_args;         /* Grammar/Parse time arguments */
 565         u32 runtime_args;       /* Interpret time arguments */
 566         u16 flags;              /* Misc flags */
 567         u8 object_type;         /* Corresponding internal object type */
 568         u8 class;               /* Opcode class */
 569         u8 type;                /* Opcode type */
 570 };
 571
 572 union acpi_parse_value {
 573         acpi_integer integer;   /* Integer constant (Up to 64 bits) */
 574         struct uint64_struct integer64; /* Structure overlay for 2 32-bit Dwords */
 575         u32 size;               /* bytelist or field size */
 576         char *string;           /* NULL terminated string */
 577         u8 *buffer;             /* buffer or string */
 578         char *name;             /* NULL terminated string */
 579         union acpi_parse_object *arg;   /* arguments and contained ops */
 580 };
 581
 582 #define ACPI_PARSE_COMMON \
 583         union acpi_parse_object         *parent;        /* Parent op */\
 584         u8                              descriptor_type; /* To differentiate various internal objs */\
 585         u8                              flags;          /* Type of Op */\
 586         u16                             aml_opcode;     /* AML opcode */\
 587         u32                             aml_offset;     /* Offset of declaration in AML */\
 588         union acpi_parse_object         *next;          /* Next op */\
 589         struct acpi_namespace_node      *node;          /* For use by interpreter */\
 590         union acpi_parse_value          value;          /* Value or args associated with the opcode */\
 591         ACPI_DISASM_ONLY_MEMBERS (\
 592         u8                              disasm_flags;   /* Used during AML disassembly */\
 593         u8                              disasm_opcode;  /* Subtype used for disassembly */\
 594         char                            aml_op_name[16])        /* Op name (debug only) */
 595
 596 #define ACPI_DASM_BUFFER                0x00
 597 #define ACPI_DASM_RESOURCE              0x01
 598 #define ACPI_DASM_STRING                0x02
 599 #define ACPI_DASM_UNICODE               0x03
 600 #define ACPI_DASM_EISAID                0x04
 601 #define ACPI_DASM_MATCHOP               0x05
 602 #define ACPI_DASM_LNOT_PREFIX           0x06
 603 #define ACPI_DASM_LNOT_SUFFIX           0x07
 604 #define ACPI_DASM_IGNORE                0x08
 605
 606 /*
 607  * Generic operation (for example:  If, While, Store)
 608  */
 609 struct acpi_parse_obj_common {
 610 ACPI_PARSE_COMMON};
 611
 612 /*
 613  * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and op_regions),
 614  * and bytelists.
 615  */
 616 struct acpi_parse_obj_named {
 617         ACPI_PARSE_COMMON u8 * path;
 618         u8 *data;               /* AML body or bytelist data */
 619         u32 length;             /* AML length */
 620         u32 name;               /* 4-byte name or zero if no name */
 621 };
 622
 623 /* This version is used by the i_aSL compiler only */
 624
 625 #define ACPI_MAX_PARSEOP_NAME   20
 626
 627 struct acpi_parse_obj_asl {
 628         ACPI_PARSE_COMMON union acpi_parse_object *child;
 629         union acpi_parse_object *parent_method;
 630         char *filename;
 631         char *external_name;
 632         char *namepath;
 633         char name_seg[4];
 634         u32 extra_value;
 635         u32 column;
 636         u32 line_number;
 637         u32 logical_line_number;
 638         u32 logical_byte_offset;
 639         u32 end_line;
 640         u32 end_logical_line;
 641         u32 acpi_btype;
 642         u32 aml_length;
 643         u32 aml_subtree_length;
 644         u32 final_aml_length;
 645         u32 final_aml_offset;
 646         u32 compile_flags;
 647         u16 parse_opcode;
 648         u8 aml_opcode_length;
 649         u8 aml_pkg_len_bytes;
 650         u8 extra;
 651         char parse_op_name[ACPI_MAX_PARSEOP_NAME];
 652 };
 653
 654 union acpi_parse_object {
 655         struct acpi_parse_obj_common common;
 656         struct acpi_parse_obj_named named;
 657         struct acpi_parse_obj_asl asl;
 658 };
 659
 660 /*
 661  * Parse state - one state per parser invocation and each control
 662  * method.
 663  */
 664 struct acpi_parse_state {
 665         u8 *aml_start;          /* First AML byte */
 666         u8 *aml;                /* Next AML byte */
 667         u8 *aml_end;            /* (last + 1) AML byte */
 668         u8 *pkg_start;          /* Current package begin */
 669         u8 *pkg_end;            /* Current package end */
 670         union acpi_parse_object *start_op;      /* Root of parse tree */
 671         struct acpi_namespace_node *start_node;
 672         union acpi_generic_state *scope;        /* Current scope */
 673         union acpi_parse_object *start_scope;
 674         u32 aml_size;
 675 };
 676
 677 /* Parse object flags */
 678
 679 #define ACPI_PARSEOP_GENERIC            0x01
 680 #define ACPI_PARSEOP_NAMED              0x02
 681 #define ACPI_PARSEOP_DEFERRED           0x04
 682 #define ACPI_PARSEOP_BYTELIST           0x08
 683 #define ACPI_PARSEOP_IN_CACHE           0x80
 684
 685 /* Parse object disasm_flags */
 686
 687 #define ACPI_PARSEOP_IGNORE             0x01
 688 #define ACPI_PARSEOP_PARAMLIST          0x02
 689 #define ACPI_PARSEOP_EMPTY_TERMLIST     0x04
 690 #define ACPI_PARSEOP_SPECIAL            0x10
 691
 692 /*****************************************************************************
 693  *
 694  * Hardware (ACPI registers) and PNP
 695  *
 696  ****************************************************************************/
 697
 698 #define PCI_ROOT_HID_STRING             "PNP0A03"
 699 #define PCI_EXPRESS_ROOT_HID_STRING     "PNP0A08"
 700
 701 struct acpi_bit_register_info {
 702         u8 parent_register;
 703         u8 bit_position;
 704         u16 access_bit_mask;
 705 };
 706
 707 /*
 708  * Register IDs
 709  * These are the full ACPI registers
 710  */
 711 #define ACPI_REGISTER_PM1_STATUS                0x01
 712 #define ACPI_REGISTER_PM1_ENABLE                0x02
 713 #define ACPI_REGISTER_PM1_CONTROL               0x03
 714 #define ACPI_REGISTER_PM1A_CONTROL              0x04
 715 #define ACPI_REGISTER_PM1B_CONTROL              0x05
 716 #define ACPI_REGISTER_PM2_CONTROL               0x06
 717 #define ACPI_REGISTER_PM_TIMER                  0x07
 718 #define ACPI_REGISTER_PROCESSOR_BLOCK           0x08
 719 #define ACPI_REGISTER_SMI_COMMAND_BLOCK         0x09
 720
 721 /* Masks used to access the bit_registers */
 722
 723 #define ACPI_BITMASK_TIMER_STATUS               0x0001
 724 #define ACPI_BITMASK_BUS_MASTER_STATUS          0x0010
 725 #define ACPI_BITMASK_GLOBAL_LOCK_STATUS         0x0020
 726 #define ACPI_BITMASK_POWER_BUTTON_STATUS        0x0100
 727 #define ACPI_BITMASK_SLEEP_BUTTON_STATUS        0x0200
 728 #define ACPI_BITMASK_RT_CLOCK_STATUS            0x0400
 729 #define ACPI_BITMASK_PCIEXP_WAKE_STATUS         0x4000  /* ACPI 3.0 */
 730 #define ACPI_BITMASK_WAKE_STATUS                0x8000
 731
 732 #define ACPI_BITMASK_ALL_FIXED_STATUS           (\
 733         ACPI_BITMASK_TIMER_STATUS          | \
 734         ACPI_BITMASK_BUS_MASTER_STATUS     | \
 735         ACPI_BITMASK_GLOBAL_LOCK_STATUS    | \
 736         ACPI_BITMASK_POWER_BUTTON_STATUS   | \
 737         ACPI_BITMASK_SLEEP_BUTTON_STATUS   | \
 738         ACPI_BITMASK_RT_CLOCK_STATUS       | \
 739         ACPI_BITMASK_WAKE_STATUS)
 740
 741 #define ACPI_BITMASK_TIMER_ENABLE               0x0001
 742 #define ACPI_BITMASK_GLOBAL_LOCK_ENABLE         0x0020
 743 #define ACPI_BITMASK_POWER_BUTTON_ENABLE        0x0100
 744 #define ACPI_BITMASK_SLEEP_BUTTON_ENABLE        0x0200
 745 #define ACPI_BITMASK_RT_CLOCK_ENABLE            0x0400
 746 #define ACPI_BITMASK_PCIEXP_WAKE_DISABLE        0x4000  /* ACPI 3.0 */
 747
 748 #define ACPI_BITMASK_SCI_ENABLE                 0x0001
 749 #define ACPI_BITMASK_BUS_MASTER_RLD             0x0002
 750 #define ACPI_BITMASK_GLOBAL_LOCK_RELEASE        0x0004
 751 #define ACPI_BITMASK_SLEEP_TYPE_X               0x1C00
 752 #define ACPI_BITMASK_SLEEP_ENABLE               0x2000
 753
 754 #define ACPI_BITMASK_ARB_DISABLE                0x0001
 755
 756 /* Raw bit position of each bit_register */
 757
 758 #define ACPI_BITPOSITION_TIMER_STATUS           0x00
 759 #define ACPI_BITPOSITION_BUS_MASTER_STATUS      0x04
 760 #define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS     0x05
 761 #define ACPI_BITPOSITION_POWER_BUTTON_STATUS    0x08
 762 #define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS    0x09
 763 #define ACPI_BITPOSITION_RT_CLOCK_STATUS        0x0A
 764 #define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS     0x0E    /* ACPI 3.0 */
 765 #define ACPI_BITPOSITION_WAKE_STATUS            0x0F
 766
 767 #define ACPI_BITPOSITION_TIMER_ENABLE           0x00
 768 #define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE     0x05
 769 #define ACPI_BITPOSITION_POWER_BUTTON_ENABLE    0x08
 770 #define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE    0x09
 771 #define ACPI_BITPOSITION_RT_CLOCK_ENABLE        0x0A
 772 #define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE    0x0E    /* ACPI 3.0 */
 773
 774 #define ACPI_BITPOSITION_SCI_ENABLE             0x00
 775 #define ACPI_BITPOSITION_BUS_MASTER_RLD         0x01
 776 #define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE    0x02
 777 #define ACPI_BITPOSITION_SLEEP_TYPE_X           0x0A
 778 #define ACPI_BITPOSITION_SLEEP_ENABLE           0x0D
 779
 780 #define ACPI_BITPOSITION_ARB_DISABLE            0x00
 781
 782 /*****************************************************************************
 783  *
 784  * Resource descriptors
 785  *
 786  ****************************************************************************/
 787
 788 /* resource_type values */
 789
 790 #define ACPI_ADDRESS_TYPE_MEMORY_RANGE          0
 791 #define ACPI_ADDRESS_TYPE_IO_RANGE              1
 792 #define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE      2
 793
 794 /* Resource descriptor types and masks */
 795
 796 #define ACPI_RESOURCE_NAME_LARGE                0x80
 797 #define ACPI_RESOURCE_NAME_SMALL                0x00
 798
 799 #define ACPI_RESOURCE_NAME_SMALL_MASK           0x78    /* Bits 6:3 contain the type */
 800 #define ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK    0x07    /* Bits 2:0 contain the length */
 801 #define ACPI_RESOURCE_NAME_LARGE_MASK           0x7F    /* Bits 6:0 contain the type */
 802
 803 /*
 804  * Small resource descriptor "names" as defined by the ACPI specification.
 805  * Note: Bits 2:0 are used for the descriptor length
 806  */
 807 #define ACPI_RESOURCE_NAME_IRQ                  0x20
 808 #define ACPI_RESOURCE_NAME_DMA                  0x28
 809 #define ACPI_RESOURCE_NAME_START_DEPENDENT      0x30
 810 #define ACPI_RESOURCE_NAME_END_DEPENDENT        0x38
 811 #define ACPI_RESOURCE_NAME_IO                   0x40
 812 #define ACPI_RESOURCE_NAME_FIXED_IO             0x48
 813 #define ACPI_RESOURCE_NAME_RESERVED_S1          0x50
 814 #define ACPI_RESOURCE_NAME_RESERVED_S2          0x58
 815 #define ACPI_RESOURCE_NAME_RESERVED_S3          0x60
 816 #define ACPI_RESOURCE_NAME_RESERVED_S4          0x68
 817 #define ACPI_RESOURCE_NAME_VENDOR_SMALL         0x70
 818 #define ACPI_RESOURCE_NAME_END_TAG              0x78
 819
 820 /*
 821  * Large resource descriptor "names" as defined by the ACPI specification.
 822  * Note: includes the Large Descriptor bit in bit[7]
 823  */
 824 #define ACPI_RESOURCE_NAME_MEMORY24             0x81
 825 #define ACPI_RESOURCE_NAME_GENERIC_REGISTER     0x82
 826 #define ACPI_RESOURCE_NAME_RESERVED_L1          0x83
 827 #define ACPI_RESOURCE_NAME_VENDOR_LARGE         0x84
 828 #define ACPI_RESOURCE_NAME_MEMORY32             0x85
 829 #define ACPI_RESOURCE_NAME_FIXED_MEMORY32       0x86
 830 #define ACPI_RESOURCE_NAME_ADDRESS32            0x87
 831 #define ACPI_RESOURCE_NAME_ADDRESS16            0x88
 832 #define ACPI_RESOURCE_NAME_EXTENDED_IRQ         0x89
 833 #define ACPI_RESOURCE_NAME_ADDRESS64            0x8A
 834 #define ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64   0x8B
 835 #define ACPI_RESOURCE_NAME_LARGE_MAX            0x8B
 836
 837 /*****************************************************************************
 838  *
 839  * Miscellaneous
 840  *
 841  ****************************************************************************/
 842
 843 #define ACPI_ASCII_ZERO                 0x30
 844
 845 /*****************************************************************************
 846  *
 847  * Debugger
 848  *
 849  ****************************************************************************/
 850
 851 struct acpi_db_method_info {
 852         acpi_handle thread_gate;
 853         char *name;
 854         char **args;
 855         u32 flags;
 856         u32 num_loops;
 857         char pathname[128];
 858 };
 859
 860 struct acpi_integrity_info {
 861         u32 nodes;
 862         u32 objects;
 863 };
 864
 865 #define ACPI_DB_REDIRECTABLE_OUTPUT     0x01
 866 #define ACPI_DB_CONSOLE_OUTPUT          0x02
 867 #define ACPI_DB_DUPLICATE_OUTPUT        0x03
 868
 869 /*****************************************************************************
 870  *
 871  * Debug
 872  *
 873  ****************************************************************************/
 874
 875 /* Entry for a memory allocation (debug only) */
 876
 877 #define ACPI_MEM_MALLOC                 0
 878 #define ACPI_MEM_CALLOC                 1
 879 #define ACPI_MAX_MODULE_NAME            16
 880
 881 #define ACPI_COMMON_DEBUG_MEM_HEADER \
 882         struct acpi_debug_mem_block     *previous; \
 883         struct acpi_debug_mem_block     *next; \
 884         u32                             size; \
 885         u32                             component; \
 886         u32                             line; \
 887         char                            module[ACPI_MAX_MODULE_NAME]; \
 888         u8                              alloc_type;
 889
 890 struct acpi_debug_mem_header {
 891 ACPI_COMMON_DEBUG_MEM_HEADER};
 892
 893 struct acpi_debug_mem_block {
 894         ACPI_COMMON_DEBUG_MEM_HEADER u64 user_space;
 895 };
 896
 897 #define ACPI_MEM_LIST_GLOBAL            0
 898 #define ACPI_MEM_LIST_NSNODE            1
 899 #define ACPI_MEM_LIST_MAX               1
 900 #define ACPI_NUM_MEM_LISTS              2
 901
 902 struct acpi_memory_list {
 903         char *list_name;
 904         void *list_head;
 905         u16 object_size;
 906         u16 max_depth;
 907         u16 current_depth;
 908         u16 link_offset;
 909
 910 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
 911
 912         /* Statistics for debug memory tracking only */
 913
 914         u32 total_allocated;
 915         u32 total_freed;
 916         u32 current_total_size;
 917         u32 requests;
 918         u32 hits;
 919 #endif
 920 };
 921
 922 #endif                          /* __ACLOCAL_H__ */