drivers/acpi/acpica/aclocal.h

   1 /******************************************************************************
   2  *
   3  * Name: aclocal.h - Internal data types used across the ACPI subsystem
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2013, Intel Corp.
   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_SERIALIZED                 0xFF
  50
  51 typedef u32 acpi_mutex_handle;
  52 #define ACPI_GLOBAL_LOCK                (acpi_semaphore) (-1)
  53
  54 /* Total number of aml opcodes defined */
  55
  56 #define AML_NUM_OPCODES                 0x81
  57
  58 /* Forward declarations */
  59
  60 struct acpi_walk_state;
  61 struct acpi_obj_mutex;
  62 union acpi_parse_object;
  63
  64 /*****************************************************************************
  65  *
  66  * Mutex typedefs and structs
  67  *
  68  ****************************************************************************/
  69
  70 /*
  71  * Predefined handles for the mutex objects used within the subsystem
  72  * All mutex objects are automatically created by acpi_ut_mutex_initialize.
  73  *
  74  * The acquire/release ordering protocol is implied via this list. Mutexes
  75  * with a lower value must be acquired before mutexes with a higher value.
  76  *
  77  * NOTE: any changes here must be reflected in the acpi_gbl_mutex_names
  78  * table below also!
  79  */
  80 #define ACPI_MTX_INTERPRETER            0       /* AML Interpreter, main lock */
  81 #define ACPI_MTX_NAMESPACE              1       /* ACPI Namespace */
  82 #define ACPI_MTX_TABLES                 2       /* Data for ACPI tables */
  83 #define ACPI_MTX_EVENTS                 3       /* Data for ACPI events */
  84 #define ACPI_MTX_CACHES                 4       /* Internal caches, general purposes */
  85 #define ACPI_MTX_MEMORY                 5       /* Debug memory tracking lists */
  86 #define ACPI_MTX_DEBUG_CMD_COMPLETE     6       /* AML debugger */
  87 #define ACPI_MTX_DEBUG_CMD_READY        7       /* AML debugger */
  88
  89 #define ACPI_MAX_MUTEX                  7
  90 #define ACPI_NUM_MUTEX                  ACPI_MAX_MUTEX+1
  91
  92 /* Lock structure for reader/writer interfaces */
  93
  94 struct acpi_rw_lock {
  95         acpi_mutex writer_mutex;
  96         acpi_mutex reader_mutex;
  97         u32 num_readers;
  98 };
  99
 100 /*
 101  * Predefined handles for spinlocks used within the subsystem.
 102  * These spinlocks are created by acpi_ut_mutex_initialize
 103  */
 104 #define ACPI_LOCK_GPES                  0
 105 #define ACPI_LOCK_HARDWARE              1
 106
 107 #define ACPI_MAX_LOCK                   1
 108 #define ACPI_NUM_LOCK                   ACPI_MAX_LOCK+1
 109
 110 /* This Thread ID means that the mutex is not in use (unlocked) */
 111
 112 #define ACPI_MUTEX_NOT_ACQUIRED         (acpi_thread_id) 0
 113
 114 /* Table for the global mutexes */
 115
 116 struct acpi_mutex_info {
 117         acpi_mutex mutex;
 118         u32 use_count;
 119         acpi_thread_id thread_id;
 120 };
 121
 122 /* Lock flag parameter for various interfaces */
 123
 124 #define ACPI_MTX_DO_NOT_LOCK            0
 125 #define ACPI_MTX_LOCK                   1
 126
 127 /* Field access granularities */
 128
 129 #define ACPI_FIELD_BYTE_GRANULARITY     1
 130 #define ACPI_FIELD_WORD_GRANULARITY     2
 131 #define ACPI_FIELD_DWORD_GRANULARITY    4
 132 #define ACPI_FIELD_QWORD_GRANULARITY    8
 133
 134 #define ACPI_ENTRY_NOT_FOUND            NULL
 135
 136 /*****************************************************************************
 137  *
 138  * Namespace typedefs and structs
 139  *
 140  ****************************************************************************/
 141
 142 /* Operational modes of the AML interpreter/scanner */
 143
 144 typedef enum {
 145         ACPI_IMODE_LOAD_PASS1 = 0x01,
 146         ACPI_IMODE_LOAD_PASS2 = 0x02,
 147         ACPI_IMODE_EXECUTE = 0x03
 148 } acpi_interpreter_mode;
 149
 150 /*
 151  * The Namespace Node describes a named object that appears in the AML.
 152  * descriptor_type is used to differentiate between internal descriptors.
 153  *
 154  * The node is optimized for both 32-bit and 64-bit platforms:
 155  * 20 bytes for the 32-bit case, 32 bytes for the 64-bit case.
 156  *
 157  * Note: The descriptor_type and Type fields must appear in the identical
 158  * position in both the struct acpi_namespace_node and union acpi_operand_object
 159  * structures.
 160  */
 161 struct acpi_namespace_node {
 162         union acpi_operand_object *object;      /* Interpreter object */
 163         u8 descriptor_type;     /* Differentiate object descriptor types */
 164         u8 type;                /* ACPI Type associated with this name */
 165         u8 flags;               /* Miscellaneous flags */
 166         acpi_owner_id owner_id; /* Node creator */
 167         union acpi_name_union name;     /* ACPI Name, always 4 chars per ACPI spec */
 168         struct acpi_namespace_node *parent;     /* Parent node */
 169         struct acpi_namespace_node *child;      /* First child */
 170         struct acpi_namespace_node *peer;       /* First peer */
 171
 172         /*
 173          * The following fields are used by the ASL compiler and disassembler only
 174          */
 175 #ifdef ACPI_LARGE_NAMESPACE_NODE
 176         union acpi_parse_object *op;
 177         u32 value;
 178         u32 length;
 179 #endif
 180 };
 181
 182 /* Namespace Node flags */
 183
 184 #define ANOBJ_RESERVED                  0x01    /* Available for use */
 185 #define ANOBJ_TEMPORARY                 0x02    /* Node is create by a method and is temporary */
 186 #define ANOBJ_METHOD_ARG                0x04    /* Node is a method argument */
 187 #define ANOBJ_METHOD_LOCAL              0x08    /* Node is a method local */
 188 #define ANOBJ_SUBTREE_HAS_INI           0x10    /* Used to optimize device initialization */
 189 #define ANOBJ_EVALUATED                 0x20    /* Set on first evaluation of node */
 190 #define ANOBJ_ALLOCATED_BUFFER          0x40    /* Method AML buffer is dynamic (install_method) */
 191
 192 #define ANOBJ_IS_EXTERNAL               0x08    /* iASL only: This object created via External() */
 193 #define ANOBJ_METHOD_NO_RETVAL          0x10    /* iASL only: Method has no return value */
 194 #define ANOBJ_METHOD_SOME_NO_RETVAL     0x20    /* iASL only: Method has at least one return value */
 195 #define ANOBJ_IS_REFERENCED             0x80    /* iASL only: Object was referenced */
 196
 197 /* Internal ACPI table management - master table list */
 198
 199 struct acpi_table_list {
 200         struct acpi_table_desc *tables; /* Table descriptor array */
 201         u32 current_table_count;        /* Tables currently in the array */
 202         u32 max_table_count;    /* Max tables array will hold */
 203         u8 flags;
 204 };
 205
 206 /* Flags for above */
 207
 208 #define ACPI_ROOT_ORIGIN_UNKNOWN        (0)     /* ~ORIGIN_ALLOCATED */
 209 #define ACPI_ROOT_ORIGIN_ALLOCATED      (1)
 210 #define ACPI_ROOT_ALLOW_RESIZE          (2)
 211
 212 /* Predefined (fixed) table indexes */
 213
 214 #define ACPI_TABLE_INDEX_DSDT           (0)
 215 #define ACPI_TABLE_INDEX_FACS           (1)
 216
 217 struct acpi_find_context {
 218         char *search_for;
 219         acpi_handle *list;
 220         u32 *count;
 221 };
 222
 223 struct acpi_ns_search_data {
 224         struct acpi_namespace_node *node;
 225 };
 226
 227 /* Object types used during package copies */
 228
 229 #define ACPI_COPY_TYPE_SIMPLE           0
 230 #define ACPI_COPY_TYPE_PACKAGE          1
 231
 232 /* Info structure used to convert external<->internal namestrings */
 233
 234 struct acpi_namestring_info {
 235         const char *external_name;
 236         const char *next_external_char;
 237         char *internal_name;
 238         u32 length;
 239         u32 num_segments;
 240         u32 num_carats;
 241         u8 fully_qualified;
 242 };
 243
 244 /* Field creation info */
 245
 246 struct acpi_create_field_info {
 247         struct acpi_namespace_node *region_node;
 248         struct acpi_namespace_node *field_node;
 249         struct acpi_namespace_node *register_node;
 250         struct acpi_namespace_node *data_register_node;
 251         struct acpi_namespace_node *connection_node;
 252         u8 *resource_buffer;
 253         u32 bank_value;
 254         u32 field_bit_position;
 255         u32 field_bit_length;
 256         u16 resource_length;
 257         u8 field_flags;
 258         u8 attribute;
 259         u8 field_type;
 260         u8 access_length;
 261 };
 262
 263 typedef
 264 acpi_status(*acpi_internal_method) (struct acpi_walk_state * walk_state);
 265
 266 /*
 267  * Bitmapped ACPI types. Used internally only
 268  */
 269 #define ACPI_BTYPE_ANY                  0x00000000
 270 #define ACPI_BTYPE_INTEGER              0x00000001
 271 #define ACPI_BTYPE_STRING               0x00000002
 272 #define ACPI_BTYPE_BUFFER               0x00000004
 273 #define ACPI_BTYPE_PACKAGE              0x00000008
 274 #define ACPI_BTYPE_FIELD_UNIT           0x00000010
 275 #define ACPI_BTYPE_DEVICE               0x00000020
 276 #define ACPI_BTYPE_EVENT                0x00000040
 277 #define ACPI_BTYPE_METHOD               0x00000080
 278 #define ACPI_BTYPE_MUTEX                0x00000100
 279 #define ACPI_BTYPE_REGION               0x00000200
 280 #define ACPI_BTYPE_POWER                0x00000400
 281 #define ACPI_BTYPE_PROCESSOR            0x00000800
 282 #define ACPI_BTYPE_THERMAL              0x00001000
 283 #define ACPI_BTYPE_BUFFER_FIELD         0x00002000
 284 #define ACPI_BTYPE_DDB_HANDLE           0x00004000
 285 #define ACPI_BTYPE_DEBUG_OBJECT         0x00008000
 286 #define ACPI_BTYPE_REFERENCE            0x00010000
 287 #define ACPI_BTYPE_RESOURCE             0x00020000
 288
 289 #define ACPI_BTYPE_COMPUTE_DATA         (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER)
 290
 291 #define ACPI_BTYPE_DATA                 (ACPI_BTYPE_COMPUTE_DATA  | ACPI_BTYPE_PACKAGE)
 292 #define ACPI_BTYPE_DATA_REFERENCE       (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE | ACPI_BTYPE_DDB_HANDLE)
 293 #define ACPI_BTYPE_DEVICE_OBJECTS       (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR)
 294 #define ACPI_BTYPE_OBJECTS_AND_REFS     0x0001FFFF      /* ARG or LOCAL */
 295 #define ACPI_BTYPE_ALL_OBJECTS          0x0000FFFF
 296
 297 #pragma pack(1)
 298
 299 /*
 300  * Information structure for ACPI predefined names.
 301  * Each entry in the table contains the following items:
 302  *
 303  * name                 - The ACPI reserved name
 304  * param_count          - Number of arguments to the method
 305  * expected_return_btypes - Allowed type(s) for the return value
 306  */
 307 struct acpi_name_info {
 308         char name[ACPI_NAME_SIZE];
 309         u16 argument_list;
 310         u8 expected_btypes;
 311 };
 312
 313 /*
 314  * Secondary information structures for ACPI predefined objects that return
 315  * package objects. This structure appears as the next entry in the table
 316  * after the NAME_INFO structure above.
 317  *
 318  * The reason for this is to minimize the size of the predefined name table.
 319  */
 320
 321 /*
 322  * Used for ACPI_PTYPE1_FIXED, ACPI_PTYPE1_VAR, ACPI_PTYPE2,
 323  * ACPI_PTYPE2_MIN, ACPI_PTYPE2_PKG_COUNT, ACPI_PTYPE2_COUNT,
 324  * ACPI_PTYPE2_FIX_VAR
 325  */
 326 struct acpi_package_info {
 327         u8 type;
 328         u8 object_type1;
 329         u8 count1;
 330         u8 object_type2;
 331         u8 count2;
 332         u16 reserved;
 333 };
 334
 335 /* Used for ACPI_PTYPE2_FIXED */
 336
 337 struct acpi_package_info2 {
 338         u8 type;
 339         u8 count;
 340         u8 object_type[4];
 341         u8 reserved;
 342 };
 343
 344 /* Used for ACPI_PTYPE1_OPTION */
 345
 346 struct acpi_package_info3 {
 347         u8 type;
 348         u8 count;
 349         u8 object_type[2];
 350         u8 tail_object_type;
 351         u16 reserved;
 352 };
 353
 354 union acpi_predefined_info {
 355         struct acpi_name_info info;
 356         struct acpi_package_info ret_info;
 357         struct acpi_package_info2 ret_info2;
 358         struct acpi_package_info3 ret_info3;
 359 };
 360
 361 /* Reset to default packing */
 362
 363 #pragma pack()
 364
 365 /* Return object auto-repair info */
 366
 367 typedef acpi_status(*acpi_object_converter) (union acpi_operand_object
 368                                              *original_object,
 369                                              union acpi_operand_object
 370                                              **converted_object);
 371
 372 struct acpi_simple_repair_info {
 373         char name[ACPI_NAME_SIZE];
 374         u32 unexpected_btypes;
 375         u32 package_index;
 376         acpi_object_converter object_converter;
 377 };
 378
 379 /*
 380  * Bitmapped return value types
 381  * Note: the actual data types must be contiguous, a loop in nspredef.c
 382  * depends on this.
 383  */
 384 #define ACPI_RTYPE_ANY                  0x00
 385 #define ACPI_RTYPE_NONE                 0x01
 386 #define ACPI_RTYPE_INTEGER              0x02
 387 #define ACPI_RTYPE_STRING               0x04
 388 #define ACPI_RTYPE_BUFFER               0x08
 389 #define ACPI_RTYPE_PACKAGE              0x10
 390 #define ACPI_RTYPE_REFERENCE            0x20
 391 #define ACPI_RTYPE_ALL                  0x3F
 392
 393 #define ACPI_NUM_RTYPES                 5       /* Number of actual object types */
 394
 395 /*****************************************************************************
 396  *
 397  * Event typedefs and structs
 398  *
 399  ****************************************************************************/
 400
 401 /* Dispatch info for each GPE -- either a method or handler, cannot be both */
 402
 403 struct acpi_gpe_handler_info {
 404         acpi_gpe_handler address;       /* Address of handler, if any */
 405         void *context;          /* Context to be passed to handler */
 406         struct acpi_namespace_node *method_node;        /* Method node for this GPE level (saved) */
 407         u8 original_flags;      /* Original (pre-handler) GPE info */
 408         u8 originally_enabled;  /* True if GPE was originally enabled */
 409 };
 410
 411 /* Notify info for implicit notify, multiple device objects */
 412
 413 struct acpi_gpe_notify_info {
 414         struct acpi_namespace_node *device_node;        /* Device to be notified */
 415         struct acpi_gpe_notify_info *next;
 416 };
 417
 418 /*
 419  * GPE dispatch info. At any time, the GPE can have at most one type
 420  * of dispatch - Method, Handler, or Implicit Notify.
 421  */
 422 union acpi_gpe_dispatch_info {
 423         struct acpi_namespace_node *method_node;        /* Method node for this GPE level */
 424         struct acpi_gpe_handler_info *handler;  /* Installed GPE handler */
 425         struct acpi_gpe_notify_info *notify_list;       /* List of _PRW devices for implicit notifies */
 426 };
 427
 428 /*
 429  * Information about a GPE, one per each GPE in an array.
 430  * NOTE: Important to keep this struct as small as possible.
 431  */
 432 struct acpi_gpe_event_info {
 433         union acpi_gpe_dispatch_info dispatch;  /* Either Method, Handler, or notify_list */
 434         struct acpi_gpe_register_info *register_info;   /* Backpointer to register info */
 435         u8 flags;               /* Misc info about this GPE */
 436         u8 gpe_number;          /* This GPE */
 437         u8 runtime_count;       /* References to a run GPE */
 438 };
 439
 440 /* Information about a GPE register pair, one per each status/enable pair in an array */
 441
 442 struct acpi_gpe_register_info {
 443         struct acpi_generic_address status_address;     /* Address of status reg */
 444         struct acpi_generic_address enable_address;     /* Address of enable reg */
 445         u8 enable_for_wake;     /* GPEs to keep enabled when sleeping */
 446         u8 enable_for_run;      /* GPEs to keep enabled when running */
 447         u8 base_gpe_number;     /* Base GPE number for this register */
 448 };
 449
 450 /*
 451  * Information about a GPE register block, one per each installed block --
 452  * GPE0, GPE1, and one per each installed GPE Block Device.
 453  */
 454 struct acpi_gpe_block_info {
 455         struct acpi_namespace_node *node;
 456         struct acpi_gpe_block_info *previous;
 457         struct acpi_gpe_block_info *next;
 458         struct acpi_gpe_xrupt_info *xrupt_block;        /* Backpointer to interrupt block */
 459         struct acpi_gpe_register_info *register_info;   /* One per GPE register pair */
 460         struct acpi_gpe_event_info *event_info; /* One for each GPE */
 461         struct acpi_generic_address block_address;      /* Base address of the block */
 462         u32 register_count;     /* Number of register pairs in block */
 463         u16 gpe_count;          /* Number of individual GPEs in block */
 464         u8 block_base_number;   /* Base GPE number for this block */
 465         u8 initialized;         /* TRUE if this block is initialized */
 466 };
 467
 468 /* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */
 469
 470 struct acpi_gpe_xrupt_info {
 471         struct acpi_gpe_xrupt_info *previous;
 472         struct acpi_gpe_xrupt_info *next;
 473         struct acpi_gpe_block_info *gpe_block_list_head;        /* List of GPE blocks for this xrupt */
 474         u32 interrupt_number;   /* System interrupt number */
 475 };
 476
 477 struct acpi_gpe_walk_info {
 478         struct acpi_namespace_node *gpe_device;
 479         struct acpi_gpe_block_info *gpe_block;
 480         u16 count;
 481         acpi_owner_id owner_id;
 482         u8 execute_by_owner_id;
 483 };
 484
 485 struct acpi_gpe_device_info {
 486         u32 index;
 487         u32 next_block_base_index;
 488         acpi_status status;
 489         struct acpi_namespace_node *gpe_device;
 490 };
 491
 492 typedef acpi_status(*acpi_gpe_callback) (struct acpi_gpe_xrupt_info *
 493                                          gpe_xrupt_info,
 494                                          struct acpi_gpe_block_info *gpe_block,
 495                                          void *context);
 496
 497 /* Information about each particular fixed event */
 498
 499 struct acpi_fixed_event_handler {
 500         acpi_event_handler handler;     /* Address of handler. */
 501         void *context;          /* Context to be passed to handler */
 502 };
 503
 504 struct acpi_fixed_event_info {
 505         u8 status_register_id;
 506         u8 enable_register_id;
 507         u16 status_bit_mask;
 508         u16 enable_bit_mask;
 509 };
 510
 511 /* Information used during field processing */
 512
 513 struct acpi_field_info {
 514         u8 skip_field;
 515         u8 field_flag;
 516         u32 pkg_length;
 517 };
 518
 519 /*****************************************************************************
 520  *
 521  * Generic "state" object for stacks
 522  *
 523  ****************************************************************************/
 524
 525 #define ACPI_CONTROL_NORMAL                  0xC0
 526 #define ACPI_CONTROL_CONDITIONAL_EXECUTING   0xC1
 527 #define ACPI_CONTROL_PREDICATE_EXECUTING     0xC2
 528 #define ACPI_CONTROL_PREDICATE_FALSE         0xC3
 529 #define ACPI_CONTROL_PREDICATE_TRUE          0xC4
 530
 531 #define ACPI_STATE_COMMON \
 532         void                            *next; \
 533         u8                              descriptor_type; /* To differentiate various internal objs */\
 534         u8                              flags; \
 535         u16                             value; \
 536         u16                             state;
 537
 538         /* There are 2 bytes available here until the next natural alignment boundary */
 539
 540 struct acpi_common_state {
 541 ACPI_STATE_COMMON};
 542
 543 /*
 544  * Update state - used to traverse complex objects such as packages
 545  */
 546 struct acpi_update_state {
 547         ACPI_STATE_COMMON union acpi_operand_object *object;
 548 };
 549
 550 /*
 551  * Pkg state - used to traverse nested package structures
 552  */
 553 struct acpi_pkg_state {
 554         ACPI_STATE_COMMON u16 index;
 555         union acpi_operand_object *source_object;
 556         union acpi_operand_object *dest_object;
 557         struct acpi_walk_state *walk_state;
 558         void *this_target_obj;
 559         u32 num_packages;
 560 };
 561
 562 /*
 563  * Control state - one per if/else and while constructs.
 564  * Allows nesting of these constructs
 565  */
 566 struct acpi_control_state {
 567         ACPI_STATE_COMMON u16 opcode;
 568         union acpi_parse_object *predicate_op;
 569         u8 *aml_predicate_start;        /* Start of if/while predicate */
 570         u8 *package_end;        /* End of if/while block */
 571         u32 loop_count;         /* While() loop counter */
 572 };
 573
 574 /*
 575  * Scope state - current scope during namespace lookups
 576  */
 577 struct acpi_scope_state {
 578         ACPI_STATE_COMMON struct acpi_namespace_node *node;
 579 };
 580
 581 struct acpi_pscope_state {
 582         ACPI_STATE_COMMON u32 arg_count;        /* Number of fixed arguments */
 583         union acpi_parse_object *op;    /* Current op being parsed */
 584         u8 *arg_end;            /* Current argument end */
 585         u8 *pkg_end;            /* Current package end */
 586         u32 arg_list;           /* Next argument to parse */
 587 };
 588
 589 /*
 590  * Thread state - one per thread across multiple walk states. Multiple walk
 591  * states are created when there are nested control methods executing.
 592  */
 593 struct acpi_thread_state {
 594         ACPI_STATE_COMMON u8 current_sync_level;        /* Mutex Sync (nested acquire) level */
 595         struct acpi_walk_state *walk_state_list;        /* Head of list of walk_states for this thread */
 596         union acpi_operand_object *acquired_mutex_list; /* List of all currently acquired mutexes */
 597         acpi_thread_id thread_id;       /* Running thread ID */
 598 };
 599
 600 /*
 601  * Result values - used to accumulate the results of nested
 602  * AML arguments
 603  */
 604 struct acpi_result_values {
 605         ACPI_STATE_COMMON
 606             union acpi_operand_object *obj_desc[ACPI_RESULTS_FRAME_OBJ_NUM];
 607 };
 608
 609 typedef
 610 acpi_status(*acpi_parse_downwards) (struct acpi_walk_state * walk_state,
 611                                     union acpi_parse_object ** out_op);
 612
 613 typedef acpi_status(*acpi_parse_upwards) (struct acpi_walk_state * walk_state);
 614
 615 /* Global handlers for AML Notifies */
 616
 617 struct acpi_global_notify_handler {
 618         acpi_notify_handler handler;
 619         void *context;
 620 };
 621
 622 /*
 623  * Notify info - used to pass info to the deferred notify
 624  * handler/dispatcher.
 625  */
 626 struct acpi_notify_info {
 627         ACPI_STATE_COMMON u8 handler_list_id;
 628         struct acpi_namespace_node *node;
 629         union acpi_operand_object *handler_list_head;
 630         struct acpi_global_notify_handler *global;
 631 };
 632
 633 /* Generic state is union of structs above */
 634
 635 union acpi_generic_state {
 636         struct acpi_common_state common;
 637         struct acpi_control_state control;
 638         struct acpi_update_state update;
 639         struct acpi_scope_state scope;
 640         struct acpi_pscope_state parse_scope;
 641         struct acpi_pkg_state pkg;
 642         struct acpi_thread_state thread;
 643         struct acpi_result_values results;
 644         struct acpi_notify_info notify;
 645 };
 646
 647 /*****************************************************************************
 648  *
 649  * Interpreter typedefs and structs
 650  *
 651  ****************************************************************************/
 652
 653 typedef acpi_status(*acpi_execute_op) (struct acpi_walk_state * walk_state);
 654
 655 /* Address Range info block */
 656
 657 struct acpi_address_range {
 658         struct acpi_address_range *next;
 659         struct acpi_namespace_node *region_node;
 660         acpi_physical_address start_address;
 661         acpi_physical_address end_address;
 662 };
 663
 664 /*****************************************************************************
 665  *
 666  * Parser typedefs and structs
 667  *
 668  ****************************************************************************/
 669
 670 /*
 671  * AML opcode, name, and argument layout
 672  */
 673 struct acpi_opcode_info {
 674 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
 675         char *name;             /* Opcode name (disassembler/debug only) */
 676 #endif
 677         u32 parse_args;         /* Grammar/Parse time arguments */
 678         u32 runtime_args;       /* Interpret time arguments */
 679         u16 flags;              /* Misc flags */
 680         u8 object_type;         /* Corresponding internal object type */
 681         u8 class;               /* Opcode class */
 682         u8 type;                /* Opcode type */
 683 };
 684
 685 /* Value associated with the parse object */
 686
 687 union acpi_parse_value {
 688         u64 integer;            /* Integer constant (Up to 64 bits) */
 689         u32 size;               /* bytelist or field size */
 690         char *string;           /* NULL terminated string */
 691         u8 *buffer;             /* buffer or string */
 692         char *name;             /* NULL terminated string */
 693         union acpi_parse_object *arg;   /* arguments and contained ops */
 694 };
 695
 696 #ifdef ACPI_DISASSEMBLER
 697 #define ACPI_DISASM_ONLY_MEMBERS(a)     a;
 698 #else
 699 #define ACPI_DISASM_ONLY_MEMBERS(a)
 700 #endif
 701
 702 #define ACPI_PARSE_COMMON \
 703         union acpi_parse_object         *parent;        /* Parent op */\
 704         u8                              descriptor_type; /* To differentiate various internal objs */\
 705         u8                              flags;          /* Type of Op */\
 706         u16                             aml_opcode;     /* AML opcode */\
 707         u32                             aml_offset;     /* Offset of declaration in AML */\
 708         union acpi_parse_object         *next;          /* Next op */\
 709         struct acpi_namespace_node      *node;          /* For use by interpreter */\
 710         union acpi_parse_value          value;          /* Value or args associated with the opcode */\
 711         u8                              arg_list_length; /* Number of elements in the arg list */\
 712         ACPI_DISASM_ONLY_MEMBERS (\
 713         u8                              disasm_flags;   /* Used during AML disassembly */\
 714         u8                              disasm_opcode;  /* Subtype used for disassembly */\
 715         char                            aml_op_name[16])        /* Op name (debug only) */
 716
 717 /* Flags for disasm_flags field above */
 718
 719 #define ACPI_DASM_BUFFER                0x00    /* Buffer is a simple data buffer */
 720 #define ACPI_DASM_RESOURCE              0x01    /* Buffer is a Resource Descriptor */
 721 #define ACPI_DASM_STRING                0x02    /* Buffer is a ASCII string */
 722 #define ACPI_DASM_UNICODE               0x03    /* Buffer is a Unicode string */
 723 #define ACPI_DASM_PLD_METHOD            0x04    /* Buffer is a _PLD method bit-packed buffer */
 724 #define ACPI_DASM_EISAID                0x05    /* Integer is an EISAID */
 725 #define ACPI_DASM_MATCHOP               0x06    /* Parent opcode is a Match() operator */
 726 #define ACPI_DASM_LNOT_PREFIX           0x07    /* Start of a Lnot_equal (etc.) pair of opcodes */
 727 #define ACPI_DASM_LNOT_SUFFIX           0x08    /* End  of a Lnot_equal (etc.) pair of opcodes */
 728 #define ACPI_DASM_IGNORE                0x09    /* Not used at this time */
 729
 730 /*
 731  * Generic operation (for example:  If, While, Store)
 732  */
 733 struct acpi_parse_obj_common {
 734 ACPI_PARSE_COMMON};
 735
 736 /*
 737  * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and op_regions),
 738  * and bytelists.
 739  */
 740 struct acpi_parse_obj_named {
 741         ACPI_PARSE_COMMON u8 *path;
 742         u8 *data;               /* AML body or bytelist data */
 743         u32 length;             /* AML length */
 744         u32 name;               /* 4-byte name or zero if no name */
 745 };
 746
 747 /* This version is used by the iASL compiler only */
 748
 749 #define ACPI_MAX_PARSEOP_NAME   20
 750
 751 struct acpi_parse_obj_asl {
 752         ACPI_PARSE_COMMON union acpi_parse_object *child;
 753         union acpi_parse_object *parent_method;
 754         char *filename;
 755         char *external_name;
 756         char *namepath;
 757         char name_seg[4];
 758         u32 extra_value;
 759         u32 column;
 760         u32 line_number;
 761         u32 logical_line_number;
 762         u32 logical_byte_offset;
 763         u32 end_line;
 764         u32 end_logical_line;
 765         u32 acpi_btype;
 766         u32 aml_length;
 767         u32 aml_subtree_length;
 768         u32 final_aml_length;
 769         u32 final_aml_offset;
 770         u32 compile_flags;
 771         u16 parse_opcode;
 772         u8 aml_opcode_length;
 773         u8 aml_pkg_len_bytes;
 774         u8 extra;
 775         char parse_op_name[ACPI_MAX_PARSEOP_NAME];
 776 };
 777
 778 union acpi_parse_object {
 779         struct acpi_parse_obj_common common;
 780         struct acpi_parse_obj_named named;
 781         struct acpi_parse_obj_asl asl;
 782 };
 783
 784 /*
 785  * Parse state - one state per parser invocation and each control
 786  * method.
 787  */
 788 struct acpi_parse_state {
 789         u8 *aml_start;          /* First AML byte */
 790         u8 *aml;                /* Next AML byte */
 791         u8 *aml_end;            /* (last + 1) AML byte */
 792         u8 *pkg_start;          /* Current package begin */
 793         u8 *pkg_end;            /* Current package end */
 794         union acpi_parse_object *start_op;      /* Root of parse tree */
 795         struct acpi_namespace_node *start_node;
 796         union acpi_generic_state *scope;        /* Current scope */
 797         union acpi_parse_object *start_scope;
 798         u32 aml_size;
 799 };
 800
 801 /* Parse object flags */
 802
 803 #define ACPI_PARSEOP_GENERIC            0x01
 804 #define ACPI_PARSEOP_NAMED              0x02
 805 #define ACPI_PARSEOP_DEFERRED           0x04
 806 #define ACPI_PARSEOP_BYTELIST           0x08
 807 #define ACPI_PARSEOP_IN_STACK           0x10
 808 #define ACPI_PARSEOP_TARGET             0x20
 809 #define ACPI_PARSEOP_IN_CACHE           0x80
 810
 811 /* Parse object disasm_flags */
 812
 813 #define ACPI_PARSEOP_IGNORE             0x01
 814 #define ACPI_PARSEOP_PARAMLIST          0x02
 815 #define ACPI_PARSEOP_EMPTY_TERMLIST     0x04
 816 #define ACPI_PARSEOP_PREDEF_CHECKED     0x08
 817 #define ACPI_PARSEOP_SPECIAL            0x10
 818
 819 /*****************************************************************************
 820  *
 821  * Hardware (ACPI registers) and PNP
 822  *
 823  ****************************************************************************/
 824
 825 struct acpi_bit_register_info {
 826         u8 parent_register;
 827         u8 bit_position;
 828         u16 access_bit_mask;
 829 };
 830
 831 /*
 832  * Some ACPI registers have bits that must be ignored -- meaning that they
 833  * must be preserved.
 834  */
 835 #define ACPI_PM1_STATUS_PRESERVED_BITS          0x0800  /* Bit 11 */
 836
 837 /* Write-only bits must be zeroed by software */
 838
 839 #define ACPI_PM1_CONTROL_WRITEONLY_BITS         0x2004  /* Bits 13, 2 */
 840
 841 /* For control registers, both ignored and reserved bits must be preserved */
 842
 843 /*
 844  * For PM1 control, the SCI enable bit (bit 0, SCI_EN) is defined by the
 845  * ACPI specification to be a "preserved" bit - "OSPM always preserves this
 846  * bit position", section 4.7.3.2.1. However, on some machines the OS must
 847  * write a one to this bit after resume for the machine to work properly.
 848  * To enable this, we no longer attempt to preserve this bit. No machines
 849  * are known to fail if the bit is not preserved. (May 2009)
 850  */
 851 #define ACPI_PM1_CONTROL_IGNORED_BITS           0x0200  /* Bit 9 */
 852 #define ACPI_PM1_CONTROL_RESERVED_BITS          0xC1F8  /* Bits 14-15, 3-8 */
 853 #define ACPI_PM1_CONTROL_PRESERVED_BITS \
 854                (ACPI_PM1_CONTROL_IGNORED_BITS | ACPI_PM1_CONTROL_RESERVED_BITS)
 855
 856 #define ACPI_PM2_CONTROL_PRESERVED_BITS         0xFFFFFFFE      /* All except bit 0 */
 857
 858 /*
 859  * Register IDs
 860  * These are the full ACPI registers
 861  */
 862 #define ACPI_REGISTER_PM1_STATUS                0x01
 863 #define ACPI_REGISTER_PM1_ENABLE                0x02
 864 #define ACPI_REGISTER_PM1_CONTROL               0x03
 865 #define ACPI_REGISTER_PM2_CONTROL               0x04
 866 #define ACPI_REGISTER_PM_TIMER                  0x05
 867 #define ACPI_REGISTER_PROCESSOR_BLOCK           0x06
 868 #define ACPI_REGISTER_SMI_COMMAND_BLOCK         0x07
 869
 870 /* Masks used to access the bit_registers */
 871
 872 #define ACPI_BITMASK_TIMER_STATUS               0x0001
 873 #define ACPI_BITMASK_BUS_MASTER_STATUS          0x0010
 874 #define ACPI_BITMASK_GLOBAL_LOCK_STATUS         0x0020
 875 #define ACPI_BITMASK_POWER_BUTTON_STATUS        0x0100
 876 #define ACPI_BITMASK_SLEEP_BUTTON_STATUS        0x0200
 877 #define ACPI_BITMASK_RT_CLOCK_STATUS            0x0400
 878 #define ACPI_BITMASK_PCIEXP_WAKE_STATUS         0x4000  /* ACPI 3.0 */
 879 #define ACPI_BITMASK_WAKE_STATUS                0x8000
 880
 881 #define ACPI_BITMASK_ALL_FIXED_STATUS           (\
 882         ACPI_BITMASK_TIMER_STATUS          | \
 883         ACPI_BITMASK_BUS_MASTER_STATUS     | \
 884         ACPI_BITMASK_GLOBAL_LOCK_STATUS    | \
 885         ACPI_BITMASK_POWER_BUTTON_STATUS   | \
 886         ACPI_BITMASK_SLEEP_BUTTON_STATUS   | \
 887         ACPI_BITMASK_RT_CLOCK_STATUS       | \
 888         ACPI_BITMASK_PCIEXP_WAKE_STATUS    | \
 889         ACPI_BITMASK_WAKE_STATUS)
 890
 891 #define ACPI_BITMASK_TIMER_ENABLE               0x0001
 892 #define ACPI_BITMASK_GLOBAL_LOCK_ENABLE         0x0020
 893 #define ACPI_BITMASK_POWER_BUTTON_ENABLE        0x0100
 894 #define ACPI_BITMASK_SLEEP_BUTTON_ENABLE        0x0200
 895 #define ACPI_BITMASK_RT_CLOCK_ENABLE            0x0400
 896 #define ACPI_BITMASK_PCIEXP_WAKE_DISABLE        0x4000  /* ACPI 3.0 */
 897
 898 #define ACPI_BITMASK_SCI_ENABLE                 0x0001
 899 #define ACPI_BITMASK_BUS_MASTER_RLD             0x0002
 900 #define ACPI_BITMASK_GLOBAL_LOCK_RELEASE        0x0004
 901 #define ACPI_BITMASK_SLEEP_TYPE                 0x1C00
 902 #define ACPI_BITMASK_SLEEP_ENABLE               0x2000
 903
 904 #define ACPI_BITMASK_ARB_DISABLE                0x0001
 905
 906 /* Raw bit position of each bit_register */
 907
 908 #define ACPI_BITPOSITION_TIMER_STATUS           0x00
 909 #define ACPI_BITPOSITION_BUS_MASTER_STATUS      0x04
 910 #define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS     0x05
 911 #define ACPI_BITPOSITION_POWER_BUTTON_STATUS    0x08
 912 #define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS    0x09
 913 #define ACPI_BITPOSITION_RT_CLOCK_STATUS        0x0A
 914 #define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS     0x0E    /* ACPI 3.0 */
 915 #define ACPI_BITPOSITION_WAKE_STATUS            0x0F
 916
 917 #define ACPI_BITPOSITION_TIMER_ENABLE           0x00
 918 #define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE     0x05
 919 #define ACPI_BITPOSITION_POWER_BUTTON_ENABLE    0x08
 920 #define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE    0x09
 921 #define ACPI_BITPOSITION_RT_CLOCK_ENABLE        0x0A
 922 #define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE    0x0E    /* ACPI 3.0 */
 923
 924 #define ACPI_BITPOSITION_SCI_ENABLE             0x00
 925 #define ACPI_BITPOSITION_BUS_MASTER_RLD         0x01
 926 #define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE    0x02
 927 #define ACPI_BITPOSITION_SLEEP_TYPE             0x0A
 928 #define ACPI_BITPOSITION_SLEEP_ENABLE           0x0D
 929
 930 #define ACPI_BITPOSITION_ARB_DISABLE            0x00
 931
 932 /* Structs and definitions for _OSI support and I/O port validation */
 933
 934 #define ACPI_ALWAYS_ILLEGAL             0x00
 935
 936 struct acpi_interface_info {
 937         char *name;
 938         struct acpi_interface_info *next;
 939         u8 flags;
 940         u8 value;
 941 };
 942
 943 #define ACPI_OSI_INVALID                0x01
 944 #define ACPI_OSI_DYNAMIC                0x02
 945
 946 struct acpi_port_info {
 947         char *name;
 948         u16 start;
 949         u16 end;
 950         u8 osi_dependency;
 951 };
 952
 953 /*****************************************************************************
 954  *
 955  * Resource descriptors
 956  *
 957  ****************************************************************************/
 958
 959 /* resource_type values */
 960
 961 #define ACPI_ADDRESS_TYPE_MEMORY_RANGE          0
 962 #define ACPI_ADDRESS_TYPE_IO_RANGE              1
 963 #define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE      2
 964
 965 /* Resource descriptor types and masks */
 966
 967 #define ACPI_RESOURCE_NAME_LARGE                0x80
 968 #define ACPI_RESOURCE_NAME_SMALL                0x00
 969
 970 #define ACPI_RESOURCE_NAME_SMALL_MASK           0x78    /* Bits 6:3 contain the type */
 971 #define ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK    0x07    /* Bits 2:0 contain the length */
 972 #define ACPI_RESOURCE_NAME_LARGE_MASK           0x7F    /* Bits 6:0 contain the type */
 973
 974 /*
 975  * Small resource descriptor "names" as defined by the ACPI specification.
 976  * Note: Bits 2:0 are used for the descriptor length
 977  */
 978 #define ACPI_RESOURCE_NAME_IRQ                  0x20
 979 #define ACPI_RESOURCE_NAME_DMA                  0x28
 980 #define ACPI_RESOURCE_NAME_START_DEPENDENT      0x30
 981 #define ACPI_RESOURCE_NAME_END_DEPENDENT        0x38
 982 #define ACPI_RESOURCE_NAME_IO                   0x40
 983 #define ACPI_RESOURCE_NAME_FIXED_IO             0x48
 984 #define ACPI_RESOURCE_NAME_FIXED_DMA            0x50
 985 #define ACPI_RESOURCE_NAME_RESERVED_S2          0x58
 986 #define ACPI_RESOURCE_NAME_RESERVED_S3          0x60
 987 #define ACPI_RESOURCE_NAME_RESERVED_S4          0x68
 988 #define ACPI_RESOURCE_NAME_VENDOR_SMALL         0x70
 989 #define ACPI_RESOURCE_NAME_END_TAG              0x78
 990
 991 /*
 992  * Large resource descriptor "names" as defined by the ACPI specification.
 993  * Note: includes the Large Descriptor bit in bit[7]
 994  */
 995 #define ACPI_RESOURCE_NAME_MEMORY24             0x81
 996 #define ACPI_RESOURCE_NAME_GENERIC_REGISTER     0x82
 997 #define ACPI_RESOURCE_NAME_RESERVED_L1          0x83
 998 #define ACPI_RESOURCE_NAME_VENDOR_LARGE         0x84
 999 #define ACPI_RESOURCE_NAME_MEMORY32             0x85
1000 #define ACPI_RESOURCE_NAME_FIXED_MEMORY32       0x86
1001 #define ACPI_RESOURCE_NAME_ADDRESS32            0x87
1002 #define ACPI_RESOURCE_NAME_ADDRESS16            0x88
1003 #define ACPI_RESOURCE_NAME_EXTENDED_IRQ         0x89
1004 #define ACPI_RESOURCE_NAME_ADDRESS64            0x8A
1005 #define ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64   0x8B
1006 #define ACPI_RESOURCE_NAME_GPIO                 0x8C
1007 #define ACPI_RESOURCE_NAME_SERIAL_BUS           0x8E
1008 #define ACPI_RESOURCE_NAME_LARGE_MAX            0x8E
1009
1010 /*****************************************************************************
1011  *
1012  * Miscellaneous
1013  *
1014  ****************************************************************************/
1015
1016 #define ACPI_ASCII_ZERO                 0x30
1017
1018 /*****************************************************************************
1019  *
1020  * Disassembler
1021  *
1022  ****************************************************************************/
1023
1024 struct acpi_external_list {
1025         char *path;
1026         char *internal_path;
1027         struct acpi_external_list *next;
1028         u32 value;
1029         u16 length;
1030         u8 type;
1031         u8 flags;
1032         u8 resolved;
1033 };
1034
1035 /* Values for Flags field above */
1036
1037 #define ACPI_IPATH_ALLOCATED    0x01
1038
1039 struct acpi_external_file {
1040         char *path;
1041         struct acpi_external_file *next;
1042 };
1043
1044 /*****************************************************************************
1045  *
1046  * Debugger
1047  *
1048  ****************************************************************************/
1049
1050 struct acpi_db_method_info {
1051         acpi_handle method;
1052         acpi_handle main_thread_gate;
1053         acpi_handle thread_complete_gate;
1054         acpi_handle info_gate;
1055         acpi_thread_id *threads;
1056         u32 num_threads;
1057         u32 num_created;
1058         u32 num_completed;
1059
1060         char *name;
1061         u32 flags;
1062         u32 num_loops;
1063         char pathname[128];
1064         char **args;
1065         acpi_object_type *types;
1066
1067         /*
1068          * Arguments to be passed to method for the command
1069          * Threads -
1070          *   the Number of threads, ID of current thread and
1071          *   Index of current thread inside all them created.
1072          */
1073         char init_args;
1074         char *arguments[4];
1075         char num_threads_str[11];
1076         char id_of_thread_str[11];
1077         char index_of_thread_str[11];
1078 };
1079
1080 struct acpi_integrity_info {
1081         u32 nodes;
1082         u32 objects;
1083 };
1084
1085 #define ACPI_DB_REDIRECTABLE_OUTPUT     0x01
1086 #define ACPI_DB_CONSOLE_OUTPUT          0x02
1087 #define ACPI_DB_DUPLICATE_OUTPUT        0x03
1088
1089 /*****************************************************************************
1090  *
1091  * Debug
1092  *
1093  ****************************************************************************/
1094
1095 /* Entry for a memory allocation (debug only) */
1096
1097 #define ACPI_MEM_MALLOC                 0
1098 #define ACPI_MEM_CALLOC                 1
1099 #define ACPI_MAX_MODULE_NAME            16
1100
1101 #define ACPI_COMMON_DEBUG_MEM_HEADER \
1102         struct acpi_debug_mem_block     *previous; \
1103         struct acpi_debug_mem_block     *next; \
1104         u32                             size; \
1105         u32                             component; \
1106         u32                             line; \
1107         char                            module[ACPI_MAX_MODULE_NAME]; \
1108         u8                              alloc_type;
1109
1110 struct acpi_debug_mem_header {
1111 ACPI_COMMON_DEBUG_MEM_HEADER};
1112
1113 struct acpi_debug_mem_block {
1114         ACPI_COMMON_DEBUG_MEM_HEADER u64 user_space;
1115 };
1116
1117 #define ACPI_MEM_LIST_GLOBAL            0
1118 #define ACPI_MEM_LIST_NSNODE            1
1119 #define ACPI_MEM_LIST_MAX               1
1120 #define ACPI_NUM_MEM_LISTS              2
1121
1122 /*****************************************************************************
1123  *
1124  * Info/help support
1125  *
1126  ****************************************************************************/
1127
1128 struct ah_predefined_name {
1129         char *name;
1130         char *description;
1131 #ifndef ACPI_ASL_COMPILER
1132         char *action;
1133 #endif
1134 };
1135
1136 #endif                          /* __ACLOCAL_H__ */