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