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