1 /****************************************************************************** 2 * 3 * Name: actypes.h - Common data types for the entire ACPI subsystem 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2007, R. Byron Moore 9 * All rights reserved. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions, and the following disclaimer, 16 * without modification. 17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 18 * substantially similar to the "NO WARRANTY" disclaimer below 19 * ("Disclaimer") and any redistribution must be conditioned upon 20 * including a substantially similar Disclaimer requirement for further 21 * binary redistribution. 22 * 3. Neither the names of the above-listed copyright holders nor the names 23 * of any contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * Alternatively, this software may be distributed under the terms of the 27 * GNU General Public License ("GPL") version 2 as published by the Free 28 * Software Foundation. 29 * 30 * NO WARRANTY 31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 41 * POSSIBILITY OF SUCH DAMAGES. 42 */ 43 44 #ifndef __ACTYPES_H__ 45 #define __ACTYPES_H__ 46 47 /* acpisrc:struct_defs -- for acpisrc conversion */ 48 49 /* 50 * ACPI_MACHINE_WIDTH must be specified in an OS- or compiler-dependent header 51 * and must be either 32 or 64. 16-bit ACPICA is no longer supported, as of 52 * 12/2006. 53 */ 54 #ifndef ACPI_MACHINE_WIDTH 55 #error ACPI_MACHINE_WIDTH not defined 56 #endif 57 58 /*! [Begin] no source code translation */ 59 60 /* 61 * Data type ranges 62 * Note: These macros are designed to be compiler independent as well as 63 * working around problems that some 32-bit compilers have with 64-bit 64 * constants. 65 */ 66 #define ACPI_UINT8_MAX (UINT8) (~((UINT8) 0)) /* 0xFF */ 67 #define ACPI_UINT16_MAX (UINT16)(~((UINT16) 0)) /* 0xFFFF */ 68 #define ACPI_UINT32_MAX (UINT32)(~((UINT32) 0)) /* 0xFFFFFFFF */ 69 #define ACPI_UINT64_MAX (UINT64)(~((UINT64) 0)) /* 0xFFFFFFFFFFFFFFFF */ 70 #define ACPI_ASCII_MAX 0x7F 71 72 /* 73 * Architecture-specific ACPICA Subsystem Data Types 74 * 75 * The goal of these types is to provide source code portability across 76 * 16-bit, 32-bit, and 64-bit targets. 77 * 78 * 1) The following types are of fixed size for all targets (16/32/64): 79 * 80 * BOOLEAN Logical boolean 81 * 82 * UINT8 8-bit (1 byte) unsigned value 83 * UINT16 16-bit (2 byte) unsigned value 84 * UINT32 32-bit (4 byte) unsigned value 85 * UINT64 64-bit (8 byte) unsigned value 86 * 87 * INT16 16-bit (2 byte) signed value 88 * INT32 32-bit (4 byte) signed value 89 * INT64 64-bit (8 byte) signed value 90 * 91 * COMPILER_DEPENDENT_UINT64/INT64 - These types are defined in the 92 * compiler-dependent header(s) and were introduced because there is no common 93 * 64-bit integer type across the various compilation models, as shown in 94 * the table below. 95 * 96 * Datatype LP64 ILP64 LLP64 ILP32 LP32 16bit 97 * char 8 8 8 8 8 8 98 * short 16 16 16 16 16 16 99 * _int32 32 100 * int 32 64 32 32 16 16 101 * long 64 64 32 32 32 32 102 * long long 64 64 103 * pointer 64 64 64 32 32 32 104 * 105 * Note: ILP64 and LP32 are currently not supported. 106 * 107 * 108 * 2) These types represent the native word size of the target mode of the 109 * processor, and may be 16-bit, 32-bit, or 64-bit as required. They are 110 * usually used for memory allocation, efficient loop counters, and array 111 * indexes. The types are similar to the size_t type in the C library and are 112 * required because there is no C type that consistently represents the native 113 * data width. 114 * 115 * ACPI_SIZE 16/32/64-bit unsigned value 116 * ACPI_NATIVE_UINT 16/32/64-bit unsigned value 117 * ACPI_NATIVE_INT 16/32/64-bit signed value 118 * 119 */ 120 121 /******************************************************************************* 122 * 123 * Common types for all compilers, all targets 124 * 125 ******************************************************************************/ 126 127 typedef unsigned char BOOLEAN; 128 typedef unsigned char UINT8; 129 typedef unsigned short UINT16; 130 typedef COMPILER_DEPENDENT_UINT64 UINT64; 131 typedef COMPILER_DEPENDENT_INT64 INT64; 132 133 /*! [End] no source code translation !*/ 134 135 /******************************************************************************* 136 * 137 * Types specific to 64-bit targets 138 * 139 ******************************************************************************/ 140 141 #if ACPI_MACHINE_WIDTH == 64 142 143 /*! [Begin] no source code translation (keep the typedefs as-is) */ 144 145 typedef unsigned int UINT32; 146 typedef int INT32; 147 148 /*! [End] no source code translation !*/ 149 150 typedef u64 acpi_native_uint; 151 typedef s64 acpi_native_int; 152 153 typedef u64 acpi_io_address; 154 typedef u64 acpi_physical_address; 155 156 #define ACPI_MAX_PTR ACPI_UINT64_MAX 157 #define ACPI_SIZE_MAX ACPI_UINT64_MAX 158 159 #define ACPI_USE_NATIVE_DIVIDE /* Has native 64-bit integer support */ 160 161 /* 162 * In the case of the Itanium Processor Family (IPF), the hardware does not 163 * support misaligned memory transfers. Set the MISALIGNMENT_NOT_SUPPORTED flag 164 * to indicate that special precautions must be taken to avoid alignment faults. 165 * (IA64 or ia64 is currently used by existing compilers to indicate IPF.) 166 * 167 * Note: Em64_t and other X86-64 processors support misaligned transfers, 168 * so there is no need to define this flag. 169 */ 170 #if defined (__IA64__) || defined (__ia64__) 171 #define ACPI_MISALIGNMENT_NOT_SUPPORTED 172 #endif 173 174 /******************************************************************************* 175 * 176 * Types specific to 32-bit targets 177 * 178 ******************************************************************************/ 179 180 #elif ACPI_MACHINE_WIDTH == 32 181 182 /*! [Begin] no source code translation (keep the typedefs as-is) */ 183 184 typedef unsigned int UINT32; 185 typedef int INT32; 186 187 /*! [End] no source code translation !*/ 188 189 typedef u32 acpi_native_uint; 190 typedef s32 acpi_native_int; 191 192 typedef u32 acpi_io_address; 193 typedef u32 acpi_physical_address; 194 195 #define ACPI_MAX_PTR ACPI_UINT32_MAX 196 #define ACPI_SIZE_MAX ACPI_UINT32_MAX 197 198 #else 199 200 /* ACPI_MACHINE_WIDTH must be either 64 or 32 */ 201 202 #error unknown ACPI_MACHINE_WIDTH 203 #endif 204 205 /* Variable-width type, used instead of clib size_t */ 206 207 typedef acpi_native_uint acpi_size; 208 209 /******************************************************************************* 210 * 211 * OS-dependent and compiler-dependent types 212 * 213 * If the defaults below are not appropriate for the host system, they can 214 * be defined in the compiler-specific or OS-specific header, and this will 215 * take precedence. 216 * 217 ******************************************************************************/ 218 219 /* Value returned by acpi_os_get_thread_id */ 220 221 #ifndef acpi_thread_id 222 #define acpi_thread_id acpi_native_uint 223 #endif 224 225 /* Object returned from acpi_os_create_lock */ 226 227 #ifndef acpi_spinlock 228 #define acpi_spinlock void * 229 #endif 230 231 /* Flags for acpi_os_acquire_lock/acpi_os_release_lock */ 232 233 #ifndef acpi_cpu_flags 234 #define acpi_cpu_flags acpi_native_uint 235 #endif 236 237 /* Object returned from acpi_os_create_cache */ 238 239 #ifndef acpi_cache_t 240 #define acpi_cache_t struct acpi_memory_list 241 #endif 242 243 /* Use C99 uintptr_t for pointer casting if available, "void *" otherwise */ 244 245 #ifndef acpi_uintptr_t 246 #define acpi_uintptr_t void * 247 #endif 248 249 /* 250 * ACPI_PRINTF_LIKE is used to tag functions as "printf-like" because 251 * some compilers can catch printf format string problems 252 */ 253 #ifndef ACPI_PRINTF_LIKE 254 #define ACPI_PRINTF_LIKE(c) 255 #endif 256 257 /* 258 * Some compilers complain about unused variables. Sometimes we don't want to 259 * use all the variables (for example, _acpi_module_name). This allows us 260 * to to tell the compiler in a per-variable manner that a variable 261 * is unused 262 */ 263 #ifndef ACPI_UNUSED_VAR 264 #define ACPI_UNUSED_VAR 265 #endif 266 267 /* 268 * All ACPICA functions that are available to the rest of the kernel are 269 * tagged with this macro which can be defined as appropriate for the host. 270 */ 271 #ifndef ACPI_EXPORT_SYMBOL 272 #define ACPI_EXPORT_SYMBOL(symbol) 273 #endif 274 275 /******************************************************************************* 276 * 277 * Independent types 278 * 279 ******************************************************************************/ 280 281 /* Logical defines and NULL */ 282 283 #ifdef FALSE 284 #undef FALSE 285 #endif 286 #define FALSE (1 == 0) 287 288 #ifdef TRUE 289 #undef TRUE 290 #endif 291 #define TRUE (1 == 1) 292 293 #ifndef NULL 294 #define NULL (void *) 0 295 #endif 296 297 /* 298 * Mescellaneous types 299 */ 300 typedef u32 acpi_status; /* All ACPI Exceptions */ 301 typedef u32 acpi_name; /* 4-byte ACPI name */ 302 typedef char *acpi_string; /* Null terminated ASCII string */ 303 typedef void *acpi_handle; /* Actually a ptr to a NS Node */ 304 305 struct uint64_struct { 306 u32 lo; 307 u32 hi; 308 }; 309 310 union uint64_overlay { 311 u64 full; 312 struct uint64_struct part; 313 }; 314 315 struct uint32_struct { 316 u32 lo; 317 u32 hi; 318 }; 319 320 /* Synchronization objects */ 321 322 #define acpi_mutex void * 323 #define acpi_semaphore void * 324 325 /* 326 * Acpi integer width. In ACPI version 1, integers are 327 * 32 bits. In ACPI version 2, integers are 64 bits. 328 * Note that this pertains to the ACPI integer type only, not 329 * other integers used in the implementation of the ACPI CA 330 * subsystem. 331 */ 332 #ifdef ACPI_NO_INTEGER64_SUPPORT 333 334 /* 32-bit integers only, no 64-bit support */ 335 336 typedef u32 acpi_integer; 337 #define ACPI_INTEGER_MAX ACPI_UINT32_MAX 338 #define ACPI_INTEGER_BIT_SIZE 32 339 #define ACPI_MAX_DECIMAL_DIGITS 10 /* 2^32 = 4,294,967,296 */ 340 341 #define ACPI_USE_NATIVE_DIVIDE /* Use compiler native 32-bit divide */ 342 343 #else 344 345 /* 64-bit integers */ 346 347 typedef unsigned long long acpi_integer; 348 #define ACPI_INTEGER_MAX ACPI_UINT64_MAX 349 #define ACPI_INTEGER_BIT_SIZE 64 350 #define ACPI_MAX_DECIMAL_DIGITS 20 /* 2^64 = 18,446,744,073,709,551,616 */ 351 352 #if ACPI_MACHINE_WIDTH == 64 353 #define ACPI_USE_NATIVE_DIVIDE /* Use compiler native 64-bit divide */ 354 #endif 355 #endif 356 357 #define ACPI_MAX64_DECIMAL_DIGITS 20 358 #define ACPI_MAX32_DECIMAL_DIGITS 10 359 #define ACPI_MAX16_DECIMAL_DIGITS 5 360 #define ACPI_MAX8_DECIMAL_DIGITS 3 361 362 /* 363 * Constants with special meanings 364 */ 365 #define ACPI_ROOT_OBJECT ACPI_ADD_PTR (acpi_handle, NULL, ACPI_MAX_PTR) 366 367 /* 368 * Initialization sequence 369 */ 370 #define ACPI_FULL_INITIALIZATION 0x00 371 #define ACPI_NO_ADDRESS_SPACE_INIT 0x01 372 #define ACPI_NO_HARDWARE_INIT 0x02 373 #define ACPI_NO_EVENT_INIT 0x04 374 #define ACPI_NO_HANDLER_INIT 0x08 375 #define ACPI_NO_ACPI_ENABLE 0x10 376 #define ACPI_NO_DEVICE_INIT 0x20 377 #define ACPI_NO_OBJECT_INIT 0x40 378 379 /* 380 * Initialization state 381 */ 382 #define ACPI_SUBSYSTEM_INITIALIZE 0x01 383 #define ACPI_INITIALIZED_OK 0x02 384 385 /* 386 * Power state values 387 */ 388 #define ACPI_STATE_UNKNOWN (u8) 0xFF 389 390 #define ACPI_STATE_S0 (u8) 0 391 #define ACPI_STATE_S1 (u8) 1 392 #define ACPI_STATE_S2 (u8) 2 393 #define ACPI_STATE_S3 (u8) 3 394 #define ACPI_STATE_S4 (u8) 4 395 #define ACPI_STATE_S5 (u8) 5 396 #define ACPI_S_STATES_MAX ACPI_STATE_S5 397 #define ACPI_S_STATE_COUNT 6 398 399 #define ACPI_STATE_D0 (u8) 0 400 #define ACPI_STATE_D1 (u8) 1 401 #define ACPI_STATE_D2 (u8) 2 402 #define ACPI_STATE_D3 (u8) 3 403 #define ACPI_D_STATES_MAX ACPI_STATE_D3 404 #define ACPI_D_STATE_COUNT 4 405 406 #define ACPI_STATE_C0 (u8) 0 407 #define ACPI_STATE_C1 (u8) 1 408 #define ACPI_STATE_C2 (u8) 2 409 #define ACPI_STATE_C3 (u8) 3 410 #define ACPI_C_STATES_MAX ACPI_STATE_C3 411 #define ACPI_C_STATE_COUNT 4 412 413 /* 414 * Sleep type invalid value 415 */ 416 #define ACPI_SLEEP_TYPE_MAX 0x7 417 #define ACPI_SLEEP_TYPE_INVALID 0xFF 418 419 /* 420 * Standard notify values 421 */ 422 #define ACPI_NOTIFY_BUS_CHECK (u8) 0 423 #define ACPI_NOTIFY_DEVICE_CHECK (u8) 1 424 #define ACPI_NOTIFY_DEVICE_WAKE (u8) 2 425 #define ACPI_NOTIFY_EJECT_REQUEST (u8) 3 426 #define ACPI_NOTIFY_DEVICE_CHECK_LIGHT (u8) 4 427 #define ACPI_NOTIFY_FREQUENCY_MISMATCH (u8) 5 428 #define ACPI_NOTIFY_BUS_MODE_MISMATCH (u8) 6 429 #define ACPI_NOTIFY_POWER_FAULT (u8) 7 430 431 /* 432 * Types associated with ACPI names and objects. The first group of 433 * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition 434 * of the ACPI object_type() operator (See the ACPI Spec). Therefore, 435 * only add to the first group if the spec changes. 436 * 437 * NOTE: Types must be kept in sync with the global acpi_ns_properties 438 * and acpi_ns_type_names arrays. 439 */ 440 typedef u32 acpi_object_type; 441 442 #define ACPI_TYPE_ANY 0x00 443 #define ACPI_TYPE_INTEGER 0x01 /* Byte/Word/Dword/Zero/One/Ones */ 444 #define ACPI_TYPE_STRING 0x02 445 #define ACPI_TYPE_BUFFER 0x03 446 #define ACPI_TYPE_PACKAGE 0x04 /* byte_const, multiple data_term/Constant/super_name */ 447 #define ACPI_TYPE_FIELD_UNIT 0x05 448 #define ACPI_TYPE_DEVICE 0x06 /* Name, multiple Node */ 449 #define ACPI_TYPE_EVENT 0x07 450 #define ACPI_TYPE_METHOD 0x08 /* Name, byte_const, multiple Code */ 451 #define ACPI_TYPE_MUTEX 0x09 452 #define ACPI_TYPE_REGION 0x0A 453 #define ACPI_TYPE_POWER 0x0B /* Name,byte_const,word_const,multi Node */ 454 #define ACPI_TYPE_PROCESSOR 0x0C /* Name,byte_const,Dword_const,byte_const,multi nm_o */ 455 #define ACPI_TYPE_THERMAL 0x0D /* Name, multiple Node */ 456 #define ACPI_TYPE_BUFFER_FIELD 0x0E 457 #define ACPI_TYPE_DDB_HANDLE 0x0F 458 #define ACPI_TYPE_DEBUG_OBJECT 0x10 459 460 #define ACPI_TYPE_EXTERNAL_MAX 0x10 461 462 /* 463 * These are object types that do not map directly to the ACPI 464 * object_type() operator. They are used for various internal purposes only. 465 * If new predefined ACPI_TYPEs are added (via the ACPI specification), these 466 * internal types must move upwards. (There is code that depends on these 467 * values being contiguous with the external types above.) 468 */ 469 #define ACPI_TYPE_LOCAL_REGION_FIELD 0x11 470 #define ACPI_TYPE_LOCAL_BANK_FIELD 0x12 471 #define ACPI_TYPE_LOCAL_INDEX_FIELD 0x13 472 #define ACPI_TYPE_LOCAL_REFERENCE 0x14 /* Arg#, Local#, Name, Debug, ref_of, Index */ 473 #define ACPI_TYPE_LOCAL_ALIAS 0x15 474 #define ACPI_TYPE_LOCAL_METHOD_ALIAS 0x16 475 #define ACPI_TYPE_LOCAL_NOTIFY 0x17 476 #define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18 477 #define ACPI_TYPE_LOCAL_RESOURCE 0x19 478 #define ACPI_TYPE_LOCAL_RESOURCE_FIELD 0x1A 479 #define ACPI_TYPE_LOCAL_SCOPE 0x1B /* 1 Name, multiple object_list Nodes */ 480 481 #define ACPI_TYPE_NS_NODE_MAX 0x1B /* Last typecode used within a NS Node */ 482 483 /* 484 * These are special object types that never appear in 485 * a Namespace node, only in an union acpi_operand_object 486 */ 487 #define ACPI_TYPE_LOCAL_EXTRA 0x1C 488 #define ACPI_TYPE_LOCAL_DATA 0x1D 489 490 #define ACPI_TYPE_LOCAL_MAX 0x1D 491 492 /* All types above here are invalid */ 493 494 #define ACPI_TYPE_INVALID 0x1E 495 #define ACPI_TYPE_NOT_FOUND 0xFF 496 497 /* 498 * All I/O 499 */ 500 #define ACPI_READ 0 501 #define ACPI_WRITE 1 502 #define ACPI_IO_MASK 1 503 504 /* 505 * Event Types: Fixed & General Purpose 506 */ 507 typedef u32 acpi_event_type; 508 509 /* 510 * Fixed events 511 */ 512 #define ACPI_EVENT_PMTIMER 0 513 #define ACPI_EVENT_GLOBAL 1 514 #define ACPI_EVENT_POWER_BUTTON 2 515 #define ACPI_EVENT_SLEEP_BUTTON 3 516 #define ACPI_EVENT_RTC 4 517 #define ACPI_EVENT_MAX 4 518 #define ACPI_NUM_FIXED_EVENTS ACPI_EVENT_MAX + 1 519 520 /* 521 * Event Status - Per event 522 * ------------- 523 * The encoding of acpi_event_status is illustrated below. 524 * Note that a set bit (1) indicates the property is TRUE 525 * (e.g. if bit 0 is set then the event is enabled). 526 * +-------------+-+-+-+ 527 * | Bits 31:3 |2|1|0| 528 * +-------------+-+-+-+ 529 * | | | | 530 * | | | +- Enabled? 531 * | | +--- Enabled for wake? 532 * | +----- Set? 533 * +----------- <Reserved> 534 */ 535 typedef u32 acpi_event_status; 536 537 #define ACPI_EVENT_FLAG_DISABLED (acpi_event_status) 0x00 538 #define ACPI_EVENT_FLAG_ENABLED (acpi_event_status) 0x01 539 #define ACPI_EVENT_FLAG_WAKE_ENABLED (acpi_event_status) 0x02 540 #define ACPI_EVENT_FLAG_SET (acpi_event_status) 0x04 541 542 /* 543 * General Purpose Events (GPE) 544 */ 545 #define ACPI_GPE_INVALID 0xFF 546 #define ACPI_GPE_MAX 0xFF 547 #define ACPI_NUM_GPE 256 548 549 #define ACPI_GPE_ENABLE 0 550 #define ACPI_GPE_DISABLE 1 551 552 /* 553 * GPE info flags - Per GPE 554 * +-+-+-+---+---+-+ 555 * |7|6|5|4:3|2:1|0| 556 * +-+-+-+---+---+-+ 557 * | | | | | | 558 * | | | | | +--- Interrupt type: Edge or Level Triggered 559 * | | | | +--- Type: Wake-only, Runtime-only, or wake/runtime 560 * | | | +--- Type of dispatch -- to method, handler, or none 561 * | | +--- Enabled for runtime? 562 * | +--- Enabled for wake? 563 * +--- Unused 564 */ 565 #define ACPI_GPE_XRUPT_TYPE_MASK (u8) 0x01 566 #define ACPI_GPE_LEVEL_TRIGGERED (u8) 0x01 567 #define ACPI_GPE_EDGE_TRIGGERED (u8) 0x00 568 569 #define ACPI_GPE_TYPE_MASK (u8) 0x06 570 #define ACPI_GPE_TYPE_WAKE_RUN (u8) 0x06 571 #define ACPI_GPE_TYPE_WAKE (u8) 0x02 572 #define ACPI_GPE_TYPE_RUNTIME (u8) 0x04 /* Default */ 573 574 #define ACPI_GPE_DISPATCH_MASK (u8) 0x18 575 #define ACPI_GPE_DISPATCH_HANDLER (u8) 0x08 576 #define ACPI_GPE_DISPATCH_METHOD (u8) 0x10 577 #define ACPI_GPE_DISPATCH_NOT_USED (u8) 0x00 /* Default */ 578 579 #define ACPI_GPE_RUN_ENABLE_MASK (u8) 0x20 580 #define ACPI_GPE_RUN_ENABLED (u8) 0x20 581 #define ACPI_GPE_RUN_DISABLED (u8) 0x00 /* Default */ 582 583 #define ACPI_GPE_WAKE_ENABLE_MASK (u8) 0x40 584 #define ACPI_GPE_WAKE_ENABLED (u8) 0x40 585 #define ACPI_GPE_WAKE_DISABLED (u8) 0x00 /* Default */ 586 587 #define ACPI_GPE_ENABLE_MASK (u8) 0x60 /* Both run/wake */ 588 589 /* 590 * Flags for GPE and Lock interfaces 591 */ 592 #define ACPI_EVENT_WAKE_ENABLE 0x2 /* acpi_gpe_enable */ 593 #define ACPI_EVENT_WAKE_DISABLE 0x2 /* acpi_gpe_disable */ 594 595 #define ACPI_NOT_ISR 0x1 596 #define ACPI_ISR 0x0 597 598 /* Notify types */ 599 600 #define ACPI_SYSTEM_NOTIFY 0x1 601 #define ACPI_DEVICE_NOTIFY 0x2 602 #define ACPI_ALL_NOTIFY 0x3 603 #define ACPI_MAX_NOTIFY_HANDLER_TYPE 0x3 604 605 #define ACPI_MAX_SYS_NOTIFY 0x7f 606 607 /* Address Space (Operation Region) Types */ 608 609 typedef u8 acpi_adr_space_type; 610 611 #define ACPI_ADR_SPACE_SYSTEM_MEMORY (acpi_adr_space_type) 0 612 #define ACPI_ADR_SPACE_SYSTEM_IO (acpi_adr_space_type) 1 613 #define ACPI_ADR_SPACE_PCI_CONFIG (acpi_adr_space_type) 2 614 #define ACPI_ADR_SPACE_EC (acpi_adr_space_type) 3 615 #define ACPI_ADR_SPACE_SMBUS (acpi_adr_space_type) 4 616 #define ACPI_ADR_SPACE_CMOS (acpi_adr_space_type) 5 617 #define ACPI_ADR_SPACE_PCI_BAR_TARGET (acpi_adr_space_type) 6 618 #define ACPI_ADR_SPACE_DATA_TABLE (acpi_adr_space_type) 7 619 #define ACPI_ADR_SPACE_FIXED_HARDWARE (acpi_adr_space_type) 127 620 621 /* 622 * bit_register IDs 623 * These are bitfields defined within the full ACPI registers 624 */ 625 #define ACPI_BITREG_TIMER_STATUS 0x00 626 #define ACPI_BITREG_BUS_MASTER_STATUS 0x01 627 #define ACPI_BITREG_GLOBAL_LOCK_STATUS 0x02 628 #define ACPI_BITREG_POWER_BUTTON_STATUS 0x03 629 #define ACPI_BITREG_SLEEP_BUTTON_STATUS 0x04 630 #define ACPI_BITREG_RT_CLOCK_STATUS 0x05 631 #define ACPI_BITREG_WAKE_STATUS 0x06 632 #define ACPI_BITREG_PCIEXP_WAKE_STATUS 0x07 633 634 #define ACPI_BITREG_TIMER_ENABLE 0x08 635 #define ACPI_BITREG_GLOBAL_LOCK_ENABLE 0x09 636 #define ACPI_BITREG_POWER_BUTTON_ENABLE 0x0A 637 #define ACPI_BITREG_SLEEP_BUTTON_ENABLE 0x0B 638 #define ACPI_BITREG_RT_CLOCK_ENABLE 0x0C 639 #define ACPI_BITREG_WAKE_ENABLE 0x0D 640 #define ACPI_BITREG_PCIEXP_WAKE_DISABLE 0x0E 641 642 #define ACPI_BITREG_SCI_ENABLE 0x0F 643 #define ACPI_BITREG_BUS_MASTER_RLD 0x10 644 #define ACPI_BITREG_GLOBAL_LOCK_RELEASE 0x11 645 #define ACPI_BITREG_SLEEP_TYPE_A 0x12 646 #define ACPI_BITREG_SLEEP_TYPE_B 0x13 647 #define ACPI_BITREG_SLEEP_ENABLE 0x14 648 649 #define ACPI_BITREG_ARB_DISABLE 0x15 650 651 #define ACPI_BITREG_MAX 0x15 652 #define ACPI_NUM_BITREG ACPI_BITREG_MAX + 1 653 654 /* 655 * External ACPI object definition 656 */ 657 union acpi_object { 658 acpi_object_type type; /* See definition of acpi_ns_type for values */ 659 struct { 660 acpi_object_type type; 661 acpi_integer value; /* The actual number */ 662 } integer; 663 664 struct { 665 acpi_object_type type; 666 u32 length; /* # of bytes in string, excluding trailing null */ 667 char *pointer; /* points to the string value */ 668 } string; 669 670 struct { 671 acpi_object_type type; 672 u32 length; /* # of bytes in buffer */ 673 u8 *pointer; /* points to the buffer */ 674 } buffer; 675 676 struct { 677 acpi_object_type type; 678 u32 fill1; 679 acpi_handle handle; /* object reference */ 680 } reference; 681 682 struct { 683 acpi_object_type type; 684 u32 count; /* # of elements in package */ 685 union acpi_object *elements; /* Pointer to an array of ACPI_OBJECTs */ 686 } package; 687 688 struct { 689 acpi_object_type type; 690 u32 proc_id; 691 acpi_io_address pblk_address; 692 u32 pblk_length; 693 } processor; 694 695 struct { 696 acpi_object_type type; 697 u32 system_level; 698 u32 resource_order; 699 } power_resource; 700 }; 701 702 /* 703 * List of objects, used as a parameter list for control method evaluation 704 */ 705 struct acpi_object_list { 706 u32 count; 707 union acpi_object *pointer; 708 }; 709 710 /* 711 * Miscellaneous common Data Structures used by the interfaces 712 */ 713 #define ACPI_NO_BUFFER 0 714 #define ACPI_ALLOCATE_BUFFER (acpi_size) (-1) 715 #define ACPI_ALLOCATE_LOCAL_BUFFER (acpi_size) (-2) 716 717 struct acpi_buffer { 718 acpi_size length; /* Length in bytes of the buffer */ 719 void *pointer; /* pointer to buffer */ 720 }; 721 722 /* 723 * name_type for acpi_get_name 724 */ 725 #define ACPI_FULL_PATHNAME 0 726 #define ACPI_SINGLE_NAME 1 727 #define ACPI_NAME_TYPE_MAX 1 728 729 /* 730 * Structure and flags for acpi_get_system_info 731 */ 732 #define ACPI_SYS_MODE_UNKNOWN 0x0000 733 #define ACPI_SYS_MODE_ACPI 0x0001 734 #define ACPI_SYS_MODE_LEGACY 0x0002 735 #define ACPI_SYS_MODES_MASK 0x0003 736 737 /* 738 * System info returned by acpi_get_system_info() 739 */ 740 struct acpi_system_info { 741 u32 acpi_ca_version; 742 u32 flags; 743 u32 timer_resolution; 744 u32 reserved1; 745 u32 reserved2; 746 u32 debug_level; 747 u32 debug_layer; 748 }; 749 750 /* 751 * Types specific to the OS service interfaces 752 */ 753 typedef u32(ACPI_SYSTEM_XFACE * acpi_osd_handler) (void *context); 754 755 typedef void 756 (ACPI_SYSTEM_XFACE * acpi_osd_exec_callback) (void *context); 757 758 /* 759 * Various handlers and callback procedures 760 */ 761 typedef u32(*acpi_event_handler) (void *context); 762 763 typedef 764 void (*acpi_notify_handler) (acpi_handle device, u32 value, void *context); 765 766 typedef 767 void (*acpi_object_handler) (acpi_handle object, u32 function, void *data); 768 769 typedef acpi_status(*acpi_init_handler) (acpi_handle object, u32 function); 770 771 #define ACPI_INIT_DEVICE_INI 1 772 773 typedef 774 acpi_status(*acpi_exception_handler) (acpi_status aml_status, 775 acpi_name name, 776 u16 opcode, 777 u32 aml_offset, void *context); 778 779 /* Address Spaces (For Operation Regions) */ 780 781 typedef 782 acpi_status(*acpi_adr_space_handler) (u32 function, 783 acpi_physical_address address, 784 u32 bit_width, 785 acpi_integer * value, 786 void *handler_context, 787 void *region_context); 788 789 #define ACPI_DEFAULT_HANDLER NULL 790 791 typedef 792 acpi_status(*acpi_adr_space_setup) (acpi_handle region_handle, 793 u32 function, 794 void *handler_context, 795 void **region_context); 796 797 #define ACPI_REGION_ACTIVATE 0 798 #define ACPI_REGION_DEACTIVATE 1 799 800 typedef 801 acpi_status(*acpi_walk_callback) (acpi_handle obj_handle, 802 u32 nesting_level, 803 void *context, void **return_value); 804 805 /* Interrupt handler return values */ 806 807 #define ACPI_INTERRUPT_NOT_HANDLED 0x00 808 #define ACPI_INTERRUPT_HANDLED 0x01 809 810 /* Common string version of device HIDs and UIDs */ 811 812 struct acpi_device_id { 813 char value[ACPI_DEVICE_ID_LENGTH]; 814 }; 815 816 /* Common string version of device CIDs */ 817 818 struct acpi_compatible_id { 819 char value[ACPI_MAX_CID_LENGTH]; 820 }; 821 822 struct acpi_compatible_id_list { 823 u32 count; 824 u32 size; 825 struct acpi_compatible_id id[1]; 826 }; 827 828 /* Structure and flags for acpi_get_object_info */ 829 830 #define ACPI_VALID_STA 0x0001 831 #define ACPI_VALID_ADR 0x0002 832 #define ACPI_VALID_HID 0x0004 833 #define ACPI_VALID_UID 0x0008 834 #define ACPI_VALID_CID 0x0010 835 #define ACPI_VALID_SXDS 0x0020 836 837 /* Flags for _STA method */ 838 839 #define ACPI_STA_DEVICE_PRESENT 0x01 840 #define ACPI_STA_DEVICE_ENABLED 0x02 841 #define ACPI_STA_DEVICE_UI 0x04 842 #define ACPI_STA_DEVICE_FUNCTIONING 0x08 843 #define ACPI_STA_DEVICE_OK 0x08 /* Synonym */ 844 #define ACPI_STA_BATTERY_PRESENT 0x10 845 846 #define ACPI_COMMON_OBJ_INFO \ 847 acpi_object_type type; /* ACPI object type */ \ 848 acpi_name name /* ACPI object Name */ 849 850 struct acpi_obj_info_header { 851 ACPI_COMMON_OBJ_INFO; 852 }; 853 854 /* Structure returned from Get Object Info */ 855 856 struct acpi_device_info { 857 ACPI_COMMON_OBJ_INFO; 858 859 u32 valid; /* Indicates which fields below are valid */ 860 u32 current_status; /* _STA value */ 861 acpi_integer address; /* _ADR value if any */ 862 struct acpi_device_id hardware_id; /* _HID value if any */ 863 struct acpi_device_id unique_id; /* _UID value if any */ 864 u8 highest_dstates[4]; /* _sx_d values: 0xFF indicates not valid */ 865 struct acpi_compatible_id_list compatibility_id; /* List of _CIDs if any */ 866 }; 867 868 /* Context structs for address space handlers */ 869 870 struct acpi_pci_id { 871 u16 segment; 872 u16 bus; 873 u16 device; 874 u16 function; 875 }; 876 877 struct acpi_mem_space_context { 878 u32 length; 879 acpi_physical_address address; 880 acpi_physical_address mapped_physical_address; 881 u8 *mapped_logical_address; 882 acpi_size mapped_length; 883 }; 884 885 /* 886 * Definitions for Resource Attributes 887 */ 888 typedef u16 acpi_rs_length; /* Resource Length field is fixed at 16 bits */ 889 typedef u32 acpi_rsdesc_size; /* Max Resource Descriptor size is (Length+3) = (64_k-1)+3 */ 890 891 /* 892 * Memory Attributes 893 */ 894 #define ACPI_READ_ONLY_MEMORY (u8) 0x00 895 #define ACPI_READ_WRITE_MEMORY (u8) 0x01 896 897 #define ACPI_NON_CACHEABLE_MEMORY (u8) 0x00 898 #define ACPI_CACHABLE_MEMORY (u8) 0x01 899 #define ACPI_WRITE_COMBINING_MEMORY (u8) 0x02 900 #define ACPI_PREFETCHABLE_MEMORY (u8) 0x03 901 902 /* 903 * IO Attributes 904 * The ISA IO ranges are: n000-n0_fFh, n400-n4_fFh, n800-n8_fFh, n_c00-n_cFFh. 905 * The non-ISA IO ranges are: n100-n3_fFh, n500-n7_fFh, n900-n_bFFh, n_cd0-n_fFFh. 906 */ 907 #define ACPI_NON_ISA_ONLY_RANGES (u8) 0x01 908 #define ACPI_ISA_ONLY_RANGES (u8) 0x02 909 #define ACPI_ENTIRE_RANGE (ACPI_NON_ISA_ONLY_RANGES | ACPI_ISA_ONLY_RANGES) 910 911 /* Type of translation - 1=Sparse, 0=Dense */ 912 913 #define ACPI_SPARSE_TRANSLATION (u8) 0x01 914 915 /* 916 * IO Port Descriptor Decode 917 */ 918 #define ACPI_DECODE_10 (u8) 0x00 /* 10-bit IO address decode */ 919 #define ACPI_DECODE_16 (u8) 0x01 /* 16-bit IO address decode */ 920 921 /* 922 * IRQ Attributes 923 */ 924 #define ACPI_LEVEL_SENSITIVE (u8) 0x00 925 #define ACPI_EDGE_SENSITIVE (u8) 0x01 926 927 #define ACPI_ACTIVE_HIGH (u8) 0x00 928 #define ACPI_ACTIVE_LOW (u8) 0x01 929 930 #define ACPI_EXCLUSIVE (u8) 0x00 931 #define ACPI_SHARED (u8) 0x01 932 933 /* 934 * DMA Attributes 935 */ 936 #define ACPI_COMPATIBILITY (u8) 0x00 937 #define ACPI_TYPE_A (u8) 0x01 938 #define ACPI_TYPE_B (u8) 0x02 939 #define ACPI_TYPE_F (u8) 0x03 940 941 #define ACPI_NOT_BUS_MASTER (u8) 0x00 942 #define ACPI_BUS_MASTER (u8) 0x01 943 944 #define ACPI_TRANSFER_8 (u8) 0x00 945 #define ACPI_TRANSFER_8_16 (u8) 0x01 946 #define ACPI_TRANSFER_16 (u8) 0x02 947 948 /* 949 * Start Dependent Functions Priority definitions 950 */ 951 #define ACPI_GOOD_CONFIGURATION (u8) 0x00 952 #define ACPI_ACCEPTABLE_CONFIGURATION (u8) 0x01 953 #define ACPI_SUB_OPTIMAL_CONFIGURATION (u8) 0x02 954 955 /* 956 * 16, 32 and 64-bit Address Descriptor resource types 957 */ 958 #define ACPI_MEMORY_RANGE (u8) 0x00 959 #define ACPI_IO_RANGE (u8) 0x01 960 #define ACPI_BUS_NUMBER_RANGE (u8) 0x02 961 962 #define ACPI_ADDRESS_NOT_FIXED (u8) 0x00 963 #define ACPI_ADDRESS_FIXED (u8) 0x01 964 965 #define ACPI_POS_DECODE (u8) 0x00 966 #define ACPI_SUB_DECODE (u8) 0x01 967 968 #define ACPI_PRODUCER (u8) 0x00 969 #define ACPI_CONSUMER (u8) 0x01 970 971 /* 972 * If possible, pack the following structures to byte alignment 973 */ 974 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED 975 #pragma pack(1) 976 #endif 977 978 /* UUID data structures for use in vendor-defined resource descriptors */ 979 980 struct acpi_uuid { 981 u8 data[ACPI_UUID_LENGTH]; 982 }; 983 984 struct acpi_vendor_uuid { 985 u8 subtype; 986 u8 data[ACPI_UUID_LENGTH]; 987 }; 988 989 /* 990 * Structures used to describe device resources 991 */ 992 struct acpi_resource_irq { 993 u8 triggering; 994 u8 polarity; 995 u8 sharable; 996 u8 interrupt_count; 997 u8 interrupts[1]; 998 }; 999 1000 struct acpi_resource_dma { 1001 u8 type; 1002 u8 bus_master; 1003 u8 transfer; 1004 u8 channel_count; 1005 u8 channels[1]; 1006 }; 1007 1008 struct acpi_resource_start_dependent { 1009 u8 compatibility_priority; 1010 u8 performance_robustness; 1011 }; 1012 1013 /* 1014 * END_DEPENDENT_FUNCTIONS_RESOURCE struct is not 1015 * needed because it has no fields 1016 */ 1017 1018 struct acpi_resource_io { 1019 u8 io_decode; 1020 u8 alignment; 1021 u8 address_length; 1022 u16 minimum; 1023 u16 maximum; 1024 }; 1025 1026 struct acpi_resource_fixed_io { 1027 u16 address; 1028 u8 address_length; 1029 }; 1030 1031 struct acpi_resource_vendor { 1032 u16 byte_length; 1033 u8 byte_data[1]; 1034 }; 1035 1036 /* Vendor resource with UUID info (introduced in ACPI 3.0) */ 1037 1038 struct acpi_resource_vendor_typed { 1039 u16 byte_length; 1040 u8 uuid_subtype; 1041 u8 uuid[ACPI_UUID_LENGTH]; 1042 u8 byte_data[1]; 1043 }; 1044 1045 struct acpi_resource_end_tag { 1046 u8 checksum; 1047 }; 1048 1049 struct acpi_resource_memory24 { 1050 u8 write_protect; 1051 u16 minimum; 1052 u16 maximum; 1053 u16 alignment; 1054 u16 address_length; 1055 }; 1056 1057 struct acpi_resource_memory32 { 1058 u8 write_protect; 1059 u32 minimum; 1060 u32 maximum; 1061 u32 alignment; 1062 u32 address_length; 1063 }; 1064 1065 struct acpi_resource_fixed_memory32 { 1066 u8 write_protect; 1067 u32 address; 1068 u32 address_length; 1069 }; 1070 1071 struct acpi_memory_attribute { 1072 u8 write_protect; 1073 u8 caching; 1074 u8 range_type; 1075 u8 translation; 1076 }; 1077 1078 struct acpi_io_attribute { 1079 u8 range_type; 1080 u8 translation; 1081 u8 translation_type; 1082 u8 reserved1; 1083 }; 1084 1085 union acpi_resource_attribute { 1086 struct acpi_memory_attribute mem; 1087 struct acpi_io_attribute io; 1088 1089 /* Used for the *word_space macros */ 1090 1091 u8 type_specific; 1092 }; 1093 1094 struct acpi_resource_source { 1095 u8 index; 1096 u16 string_length; 1097 char *string_ptr; 1098 }; 1099 1100 /* Fields common to all address descriptors, 16/32/64 bit */ 1101 1102 #define ACPI_RESOURCE_ADDRESS_COMMON \ 1103 u8 resource_type; \ 1104 u8 producer_consumer; \ 1105 u8 decode; \ 1106 u8 min_address_fixed; \ 1107 u8 max_address_fixed; \ 1108 union acpi_resource_attribute info; 1109 1110 struct acpi_resource_address { 1111 ACPI_RESOURCE_ADDRESS_COMMON}; 1112 1113 struct acpi_resource_address16 { 1114 ACPI_RESOURCE_ADDRESS_COMMON u16 granularity; 1115 u16 minimum; 1116 u16 maximum; 1117 u16 translation_offset; 1118 u16 address_length; 1119 struct acpi_resource_source resource_source; 1120 }; 1121 1122 struct acpi_resource_address32 { 1123 ACPI_RESOURCE_ADDRESS_COMMON u32 granularity; 1124 u32 minimum; 1125 u32 maximum; 1126 u32 translation_offset; 1127 u32 address_length; 1128 struct acpi_resource_source resource_source; 1129 }; 1130 1131 struct acpi_resource_address64 { 1132 ACPI_RESOURCE_ADDRESS_COMMON u64 granularity; 1133 u64 minimum; 1134 u64 maximum; 1135 u64 translation_offset; 1136 u64 address_length; 1137 struct acpi_resource_source resource_source; 1138 }; 1139 1140 struct acpi_resource_extended_address64 { 1141 ACPI_RESOURCE_ADDRESS_COMMON u8 revision_iD; 1142 u64 granularity; 1143 u64 minimum; 1144 u64 maximum; 1145 u64 translation_offset; 1146 u64 address_length; 1147 u64 type_specific; 1148 }; 1149 1150 struct acpi_resource_extended_irq { 1151 u8 producer_consumer; 1152 u8 triggering; 1153 u8 polarity; 1154 u8 sharable; 1155 u8 interrupt_count; 1156 struct acpi_resource_source resource_source; 1157 u32 interrupts[1]; 1158 }; 1159 1160 struct acpi_resource_generic_register { 1161 u8 space_id; 1162 u8 bit_width; 1163 u8 bit_offset; 1164 u8 access_size; 1165 u64 address; 1166 }; 1167 1168 /* ACPI_RESOURCE_TYPEs */ 1169 1170 #define ACPI_RESOURCE_TYPE_IRQ 0 1171 #define ACPI_RESOURCE_TYPE_DMA 1 1172 #define ACPI_RESOURCE_TYPE_START_DEPENDENT 2 1173 #define ACPI_RESOURCE_TYPE_END_DEPENDENT 3 1174 #define ACPI_RESOURCE_TYPE_IO 4 1175 #define ACPI_RESOURCE_TYPE_FIXED_IO 5 1176 #define ACPI_RESOURCE_TYPE_VENDOR 6 1177 #define ACPI_RESOURCE_TYPE_END_TAG 7 1178 #define ACPI_RESOURCE_TYPE_MEMORY24 8 1179 #define ACPI_RESOURCE_TYPE_MEMORY32 9 1180 #define ACPI_RESOURCE_TYPE_FIXED_MEMORY32 10 1181 #define ACPI_RESOURCE_TYPE_ADDRESS16 11 1182 #define ACPI_RESOURCE_TYPE_ADDRESS32 12 1183 #define ACPI_RESOURCE_TYPE_ADDRESS64 13 1184 #define ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64 14 /* ACPI 3.0 */ 1185 #define ACPI_RESOURCE_TYPE_EXTENDED_IRQ 15 1186 #define ACPI_RESOURCE_TYPE_GENERIC_REGISTER 16 1187 #define ACPI_RESOURCE_TYPE_MAX 16 1188 1189 union acpi_resource_data { 1190 struct acpi_resource_irq irq; 1191 struct acpi_resource_dma dma; 1192 struct acpi_resource_start_dependent start_dpf; 1193 struct acpi_resource_io io; 1194 struct acpi_resource_fixed_io fixed_io; 1195 struct acpi_resource_vendor vendor; 1196 struct acpi_resource_vendor_typed vendor_typed; 1197 struct acpi_resource_end_tag end_tag; 1198 struct acpi_resource_memory24 memory24; 1199 struct acpi_resource_memory32 memory32; 1200 struct acpi_resource_fixed_memory32 fixed_memory32; 1201 struct acpi_resource_address16 address16; 1202 struct acpi_resource_address32 address32; 1203 struct acpi_resource_address64 address64; 1204 struct acpi_resource_extended_address64 ext_address64; 1205 struct acpi_resource_extended_irq extended_irq; 1206 struct acpi_resource_generic_register generic_reg; 1207 1208 /* Common fields */ 1209 1210 struct acpi_resource_address address; /* Common 16/32/64 address fields */ 1211 }; 1212 1213 struct acpi_resource { 1214 u32 type; 1215 u32 length; 1216 union acpi_resource_data data; 1217 }; 1218 1219 /* restore default alignment */ 1220 1221 #pragma pack() 1222 1223 #define ACPI_RS_SIZE_MIN 12 1224 #define ACPI_RS_SIZE_NO_DATA 8 /* Id + Length fields */ 1225 #define ACPI_RS_SIZE(type) (u32) (ACPI_RS_SIZE_NO_DATA + sizeof (type)) 1226 1227 #define ACPI_NEXT_RESOURCE(res) (struct acpi_resource *)((u8 *) res + res->length) 1228 1229 struct acpi_pci_routing_table { 1230 u32 length; 1231 u32 pin; 1232 acpi_integer address; /* here for 64-bit alignment */ 1233 u32 source_index; 1234 char source[4]; /* pad to 64 bits so sizeof() works in all cases */ 1235 }; 1236 1237 #endif /* __ACTYPES_H__ */ 1238