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