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