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