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