1 /****************************************************************************** 2 * 3 * Name: actypes.h - Common data types for the entire 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 __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 /* 59 * Data type ranges 60 * Note: These macros are designed to be compiler independent as well as 61 * working around problems that some 32-bit compilers have with 64-bit 62 * constants. 63 */ 64 #define ACPI_UINT8_MAX (u8) (~((u8) 0)) /* 0xFF */ 65 #define ACPI_UINT16_MAX (u16)(~((u16) 0)) /* 0xFFFF */ 66 #define ACPI_UINT32_MAX (u32)(~((u32) 0)) /* 0xFFFFFFFF */ 67 #define ACPI_UINT64_MAX (u64)(~((u64) 0)) /* 0xFFFFFFFFFFFFFFFF */ 68 #define ACPI_ASCII_MAX 0x7F 69 70 /* 71 * Architecture-specific ACPICA Subsystem Data Types 72 * 73 * The goal of these types is to provide source code portability across 74 * 16-bit, 32-bit, and 64-bit targets. 75 * 76 * 1) The following types are of fixed size for all targets (16/32/64): 77 * 78 * u8 Logical boolean 79 * 80 * u8 8-bit (1 byte) unsigned value 81 * u16 16-bit (2 byte) unsigned value 82 * u32 32-bit (4 byte) unsigned value 83 * u64 64-bit (8 byte) unsigned value 84 * 85 * s16 16-bit (2 byte) signed value 86 * s32 32-bit (4 byte) signed value 87 * s64 64-bit (8 byte) signed value 88 * 89 * COMPILER_DEPENDENT_UINT64/s64 - These types are defined in the 90 * compiler-dependent header(s) and were introduced because there is no common 91 * 64-bit integer type across the various compilation models, as shown in 92 * the table below. 93 * 94 * Datatype LP64 ILP64 LLP64 ILP32 LP32 16bit 95 * char 8 8 8 8 8 8 96 * short 16 16 16 16 16 16 97 * _int32 32 98 * int 32 64 32 32 16 16 99 * long 64 64 32 32 32 32 100 * long long 64 64 101 * pointer 64 64 64 32 32 32 102 * 103 * Note: ILP64 and LP32 are currently not supported. 104 * 105 * 106 * 2) These types represent the native word size of the target mode of the 107 * processor, and may be 16-bit, 32-bit, or 64-bit as required. They are 108 * usually used for memory allocation, efficient loop counters, and array 109 * indexes. The types are similar to the size_t type in the C library and are 110 * required because there is no C type that consistently represents the native 111 * data width. acpi_size is needed because there is no guarantee that a 112 * kernel-level C library is present. 113 * 114 * acpi_size 16/32/64-bit unsigned value 115 * acpi_native_int 16/32/64-bit signed value 116 */ 117 118 /******************************************************************************* 119 * 120 * Common types for all compilers, all targets 121 * 122 ******************************************************************************/ 123 124 #ifndef ACPI_USE_SYSTEM_INTTYPES 125 126 typedef unsigned char u8; 127 typedef unsigned char u8; 128 typedef unsigned short u16; 129 typedef short s16; 130 typedef COMPILER_DEPENDENT_UINT64 u64; 131 typedef COMPILER_DEPENDENT_INT64 s64; 132 133 #endif /* ACPI_USE_SYSTEM_INTTYPES */ 134 135 /* 136 * Value returned by acpi_os_get_thread_id. There is no standard "thread_id" 137 * across operating systems or even the various UNIX systems. Since ACPICA 138 * only needs the thread ID as a unique thread identifier, we use a u64 139 * as the only common data type - it will accommodate any type of pointer or 140 * any type of integer. It is up to the host-dependent OSL to cast the 141 * native thread ID type to a u64 (in acpi_os_get_thread_id). 142 */ 143 #define acpi_thread_id u64 144 145 /******************************************************************************* 146 * 147 * Types specific to 64-bit targets 148 * 149 ******************************************************************************/ 150 151 #if ACPI_MACHINE_WIDTH == 64 152 153 #ifndef ACPI_USE_SYSTEM_INTTYPES 154 155 typedef unsigned int u32; 156 typedef int s32; 157 158 #endif /* ACPI_USE_SYSTEM_INTTYPES */ 159 160 typedef s64 acpi_native_int; 161 162 typedef u64 acpi_size; 163 typedef u64 acpi_io_address; 164 typedef u64 acpi_physical_address; 165 166 #define ACPI_MAX_PTR ACPI_UINT64_MAX 167 #define ACPI_SIZE_MAX ACPI_UINT64_MAX 168 169 #define ACPI_USE_NATIVE_DIVIDE /* Has native 64-bit integer support */ 170 171 /* 172 * In the case of the Itanium Processor Family (IPF), the hardware does not 173 * support misaligned memory transfers. Set the MISALIGNMENT_NOT_SUPPORTED flag 174 * to indicate that special precautions must be taken to avoid alignment faults. 175 * (IA64 or ia64 is currently used by existing compilers to indicate IPF.) 176 * 177 * Note: EM64T and other X86-64 processors support misaligned transfers, 178 * so there is no need to define this flag. 179 */ 180 #if defined (__IA64__) || defined (__ia64__) 181 #define ACPI_MISALIGNMENT_NOT_SUPPORTED 182 #endif 183 184 /******************************************************************************* 185 * 186 * Types specific to 32-bit targets 187 * 188 ******************************************************************************/ 189 190 #elif ACPI_MACHINE_WIDTH == 32 191 192 #ifndef ACPI_USE_SYSTEM_INTTYPES 193 194 typedef unsigned int u32; 195 typedef int s32; 196 197 #endif /* ACPI_USE_SYSTEM_INTTYPES */ 198 199 typedef s32 acpi_native_int; 200 201 typedef u32 acpi_size; 202 203 #ifdef ACPI_32BIT_PHYSICAL_ADDRESS 204 205 /* 206 * OSPMs can define this to shrink the size of the structures for 32-bit 207 * none PAE environment. ASL compiler may always define this to generate 208 * 32-bit OSPM compliant tables. 209 */ 210 typedef u32 acpi_io_address; 211 typedef u32 acpi_physical_address; 212 213 #else /* ACPI_32BIT_PHYSICAL_ADDRESS */ 214 215 /* 216 * It is reported that, after some calculations, the physical addresses can 217 * wrap over the 32-bit boundary on 32-bit PAE environment. 218 * https://bugzilla.kernel.org/show_bug.cgi?id=87971 219 */ 220 typedef u64 acpi_io_address; 221 typedef u64 acpi_physical_address; 222 223 #endif /* ACPI_32BIT_PHYSICAL_ADDRESS */ 224 225 #define ACPI_MAX_PTR ACPI_UINT32_MAX 226 #define ACPI_SIZE_MAX ACPI_UINT32_MAX 227 228 #else 229 230 /* ACPI_MACHINE_WIDTH must be either 64 or 32 */ 231 232 #error unknown ACPI_MACHINE_WIDTH 233 #endif 234 235 /******************************************************************************* 236 * 237 * OS-dependent types 238 * 239 * If the defaults below are not appropriate for the host system, they can 240 * be defined in the OS-specific header, and this will take precedence. 241 * 242 ******************************************************************************/ 243 244 /* Flags for acpi_os_acquire_lock/acpi_os_release_lock */ 245 246 #ifndef acpi_cpu_flags 247 #define acpi_cpu_flags acpi_size 248 #endif 249 250 /* Object returned from acpi_os_create_cache */ 251 252 #ifndef acpi_cache_t 253 #ifdef ACPI_USE_LOCAL_CACHE 254 #define acpi_cache_t struct acpi_memory_list 255 #else 256 #define acpi_cache_t void * 257 #endif 258 #endif 259 260 /* 261 * Synchronization objects - Mutexes, Semaphores, and spin_locks 262 */ 263 #if (ACPI_MUTEX_TYPE == ACPI_BINARY_SEMAPHORE) 264 /* 265 * These macros are used if the host OS does not support a mutex object. 266 * Map the OSL Mutex interfaces to binary semaphores. 267 */ 268 #define acpi_mutex acpi_semaphore 269 #define acpi_os_create_mutex(out_handle) acpi_os_create_semaphore (1, 1, out_handle) 270 #define acpi_os_delete_mutex(handle) (void) acpi_os_delete_semaphore (handle) 271 #define acpi_os_acquire_mutex(handle,time) acpi_os_wait_semaphore (handle, 1, time) 272 #define acpi_os_release_mutex(handle) (void) acpi_os_signal_semaphore (handle, 1) 273 #endif 274 275 /* Configurable types for synchronization objects */ 276 277 #ifndef acpi_spinlock 278 #define acpi_spinlock void * 279 #endif 280 281 #ifndef acpi_semaphore 282 #define acpi_semaphore void * 283 #endif 284 285 #ifndef acpi_mutex 286 #define acpi_mutex void * 287 #endif 288 289 /******************************************************************************* 290 * 291 * Compiler-dependent types 292 * 293 * If the defaults below are not appropriate for the host compiler, they can 294 * be defined in the compiler-specific header, and this will take precedence. 295 * 296 ******************************************************************************/ 297 298 /* Use C99 uintptr_t for pointer casting if available, "void *" otherwise */ 299 300 #ifndef acpi_uintptr_t 301 #define acpi_uintptr_t void * 302 #endif 303 304 /* 305 * ACPI_PRINTF_LIKE is used to tag functions as "printf-like" because 306 * some compilers can catch printf format string problems 307 */ 308 #ifndef ACPI_PRINTF_LIKE 309 #define ACPI_PRINTF_LIKE(c) 310 #endif 311 312 /* 313 * Some compilers complain about unused variables. Sometimes we don't want to 314 * use all the variables (for example, _acpi_module_name). This allows us 315 * to tell the compiler in a per-variable manner that a variable 316 * is unused 317 */ 318 #ifndef ACPI_UNUSED_VAR 319 #define ACPI_UNUSED_VAR 320 #endif 321 322 /* 323 * All ACPICA external functions that are available to the rest of the kernel 324 * are tagged with thes macros which can be defined as appropriate for the host. 325 * 326 * Notes: 327 * ACPI_EXPORT_SYMBOL_INIT is used for initialization and termination 328 * interfaces that may need special processing. 329 * ACPI_EXPORT_SYMBOL is used for all other public external functions. 330 */ 331 #ifndef ACPI_EXPORT_SYMBOL_INIT 332 #define ACPI_EXPORT_SYMBOL_INIT(symbol) 333 #endif 334 335 #ifndef ACPI_EXPORT_SYMBOL 336 #define ACPI_EXPORT_SYMBOL(symbol) 337 #endif 338 339 /* 340 * Compiler/Clibrary-dependent debug initialization. Used for ACPICA 341 * utilities only. 342 */ 343 #ifndef ACPI_DEBUG_INITIALIZE 344 #define ACPI_DEBUG_INITIALIZE() 345 #endif 346 347 /******************************************************************************* 348 * 349 * Configuration 350 * 351 ******************************************************************************/ 352 353 #ifdef ACPI_NO_MEM_ALLOCATIONS 354 355 #define ACPI_ALLOCATE(a) NULL 356 #define ACPI_ALLOCATE_ZEROED(a) NULL 357 #define ACPI_FREE(a) 358 #define ACPI_MEM_TRACKING(a) 359 360 #else /* ACPI_NO_MEM_ALLOCATIONS */ 361 362 #ifdef ACPI_DBG_TRACK_ALLOCATIONS 363 /* 364 * Memory allocation tracking (used by acpi_exec to detect memory leaks) 365 */ 366 #define ACPI_MEM_PARAMETERS _COMPONENT, _acpi_module_name, __LINE__ 367 #define ACPI_ALLOCATE(a) acpi_ut_allocate_and_track ((acpi_size) (a), ACPI_MEM_PARAMETERS) 368 #define ACPI_ALLOCATE_ZEROED(a) acpi_ut_allocate_zeroed_and_track ((acpi_size) (a), ACPI_MEM_PARAMETERS) 369 #define ACPI_FREE(a) acpi_ut_free_and_track (a, ACPI_MEM_PARAMETERS) 370 #define ACPI_MEM_TRACKING(a) a 371 372 #else 373 /* 374 * Normal memory allocation directly via the OS services layer 375 */ 376 #define ACPI_ALLOCATE(a) acpi_os_allocate ((acpi_size) (a)) 377 #define ACPI_ALLOCATE_ZEROED(a) acpi_os_allocate_zeroed ((acpi_size) (a)) 378 #define ACPI_FREE(a) acpi_os_free (a) 379 #define ACPI_MEM_TRACKING(a) 380 381 #endif /* ACPI_DBG_TRACK_ALLOCATIONS */ 382 383 #endif /* ACPI_NO_MEM_ALLOCATIONS */ 384 385 /****************************************************************************** 386 * 387 * ACPI Specification constants (Do not change unless the specification changes) 388 * 389 *****************************************************************************/ 390 391 /* Number of distinct FADT-based GPE register blocks (GPE0 and GPE1) */ 392 393 #define ACPI_MAX_GPE_BLOCKS 2 394 395 /* Default ACPI register widths */ 396 397 #define ACPI_GPE_REGISTER_WIDTH 8 398 #define ACPI_PM1_REGISTER_WIDTH 16 399 #define ACPI_PM2_REGISTER_WIDTH 8 400 #define ACPI_PM_TIMER_WIDTH 32 401 #define ACPI_RESET_REGISTER_WIDTH 8 402 403 /* Names within the namespace are 4 bytes long */ 404 405 #define ACPI_NAME_SIZE 4 406 #define ACPI_PATH_SEGMENT_LENGTH 5 /* 4 chars for name + 1 char for separator */ 407 #define ACPI_PATH_SEPARATOR '.' 408 409 /* Sizes for ACPI table headers */ 410 411 #define ACPI_OEM_ID_SIZE 6 412 #define ACPI_OEM_TABLE_ID_SIZE 8 413 414 /* ACPI/PNP hardware IDs */ 415 416 #define PCI_ROOT_HID_STRING "PNP0A03" 417 #define PCI_EXPRESS_ROOT_HID_STRING "PNP0A08" 418 419 /* PM Timer ticks per second (HZ) */ 420 421 #define ACPI_PM_TIMER_FREQUENCY 3579545 422 423 /******************************************************************************* 424 * 425 * Independent types 426 * 427 ******************************************************************************/ 428 429 /* Logical defines and NULL */ 430 431 #ifdef FALSE 432 #undef FALSE 433 #endif 434 #define FALSE (1 == 0) 435 436 #ifdef TRUE 437 #undef TRUE 438 #endif 439 #define TRUE (1 == 1) 440 441 #ifndef NULL 442 #define NULL (void *) 0 443 #endif 444 445 /* 446 * Miscellaneous types 447 */ 448 typedef u32 acpi_status; /* All ACPI Exceptions */ 449 typedef u32 acpi_name; /* 4-byte ACPI name */ 450 typedef char *acpi_string; /* Null terminated ASCII string */ 451 typedef void *acpi_handle; /* Actually a ptr to a NS Node */ 452 453 /* Time constants for timer calculations */ 454 455 #define ACPI_MSEC_PER_SEC 1000L 456 457 #define ACPI_USEC_PER_MSEC 1000L 458 #define ACPI_USEC_PER_SEC 1000000L 459 460 #define ACPI_100NSEC_PER_USEC 10L 461 #define ACPI_100NSEC_PER_MSEC 10000L 462 #define ACPI_100NSEC_PER_SEC 10000000L 463 464 #define ACPI_NSEC_PER_USEC 1000L 465 #define ACPI_NSEC_PER_MSEC 1000000L 466 #define ACPI_NSEC_PER_SEC 1000000000L 467 468 /* Owner IDs are used to track namespace nodes for selective deletion */ 469 470 typedef u8 acpi_owner_id; 471 #define ACPI_OWNER_ID_MAX 0xFF 472 473 #define ACPI_INTEGER_BIT_SIZE 64 474 #define ACPI_MAX_DECIMAL_DIGITS 20 /* 2^64 = 18,446,744,073,709,551,616 */ 475 476 #if ACPI_MACHINE_WIDTH == 64 477 #define ACPI_USE_NATIVE_DIVIDE /* Use compiler native 64-bit divide */ 478 #endif 479 480 #define ACPI_MAX64_DECIMAL_DIGITS 20 481 #define ACPI_MAX32_DECIMAL_DIGITS 10 482 #define ACPI_MAX16_DECIMAL_DIGITS 5 483 #define ACPI_MAX8_DECIMAL_DIGITS 3 484 485 /* 486 * Constants with special meanings 487 */ 488 #define ACPI_ROOT_OBJECT ACPI_ADD_PTR (acpi_handle, NULL, ACPI_MAX_PTR) 489 #define ACPI_WAIT_FOREVER 0xFFFF /* u16, as per ACPI spec */ 490 #define ACPI_DO_NOT_WAIT 0 491 492 /* 493 * Obsolete: Acpi integer width. In ACPI version 1 (1996), integers are 32 bits. 494 * In ACPI version 2 (2000) and later, integers are 64 bits. Note that this 495 * pertains to the ACPI integer type only, not to other integers used in the 496 * implementation of the ACPICA subsystem. 497 * 498 * 01/2010: This type is obsolete and has been removed from the entire ACPICA 499 * code base. It remains here for compatibility with device drivers that use 500 * the type. However, it will be removed in the future. 501 */ 502 typedef u64 acpi_integer; 503 #define ACPI_INTEGER_MAX ACPI_UINT64_MAX 504 505 /******************************************************************************* 506 * 507 * Commonly used macros 508 * 509 ******************************************************************************/ 510 511 /* Data manipulation */ 512 513 #define ACPI_LOBYTE(integer) ((u8) (u16)(integer)) 514 #define ACPI_HIBYTE(integer) ((u8) (((u16)(integer)) >> 8)) 515 #define ACPI_LOWORD(integer) ((u16) (u32)(integer)) 516 #define ACPI_HIWORD(integer) ((u16)(((u32)(integer)) >> 16)) 517 #define ACPI_LODWORD(integer64) ((u32) (u64)(integer64)) 518 #define ACPI_HIDWORD(integer64) ((u32)(((u64)(integer64)) >> 32)) 519 520 #define ACPI_SET_BIT(target,bit) ((target) |= (bit)) 521 #define ACPI_CLEAR_BIT(target,bit) ((target) &= ~(bit)) 522 #define ACPI_MIN(a,b) (((a)<(b))?(a):(b)) 523 #define ACPI_MAX(a,b) (((a)>(b))?(a):(b)) 524 525 /* Size calculation */ 526 527 #define ACPI_ARRAY_LENGTH(x) (sizeof(x) / sizeof((x)[0])) 528 529 /* Pointer manipulation */ 530 531 #define ACPI_CAST_PTR(t, p) ((t *) (acpi_uintptr_t) (p)) 532 #define ACPI_CAST_INDIRECT_PTR(t, p) ((t **) (acpi_uintptr_t) (p)) 533 #define ACPI_ADD_PTR(t, a, b) ACPI_CAST_PTR (t, (ACPI_CAST_PTR (u8, (a)) + (acpi_size)(b))) 534 #define ACPI_PTR_DIFF(a, b) (acpi_size) (ACPI_CAST_PTR (u8, (a)) - ACPI_CAST_PTR (u8, (b))) 535 536 /* Pointer/Integer type conversions */ 537 538 #define ACPI_TO_POINTER(i) ACPI_ADD_PTR (void, (void *) NULL,(acpi_size) i) 539 #define ACPI_TO_INTEGER(p) ACPI_PTR_DIFF (p, (void *) NULL) 540 #define ACPI_OFFSET(d, f) ACPI_PTR_DIFF (&(((d *) 0)->f), (void *) NULL) 541 #define ACPI_PHYSADDR_TO_PTR(i) ACPI_TO_POINTER(i) 542 #define ACPI_PTR_TO_PHYSADDR(i) ACPI_TO_INTEGER(i) 543 544 /* Optimizations for 4-character (32-bit) acpi_name manipulation */ 545 546 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED 547 #define ACPI_COMPARE_NAME(a,b) (*ACPI_CAST_PTR (u32, (a)) == *ACPI_CAST_PTR (u32, (b))) 548 #define ACPI_MOVE_NAME(dest,src) (*ACPI_CAST_PTR (u32, (dest)) = *ACPI_CAST_PTR (u32, (src))) 549 #else 550 #define ACPI_COMPARE_NAME(a,b) (!ACPI_STRNCMP (ACPI_CAST_PTR (char, (a)), ACPI_CAST_PTR (char, (b)), ACPI_NAME_SIZE)) 551 #define ACPI_MOVE_NAME(dest,src) (ACPI_STRNCPY (ACPI_CAST_PTR (char, (dest)), ACPI_CAST_PTR (char, (src)), ACPI_NAME_SIZE)) 552 #endif 553 554 /* Support for the special RSDP signature (8 characters) */ 555 556 #define ACPI_VALIDATE_RSDP_SIG(a) (!ACPI_STRNCMP (ACPI_CAST_PTR (char, (a)), ACPI_SIG_RSDP, 8)) 557 #define ACPI_MAKE_RSDP_SIG(dest) (ACPI_MEMCPY (ACPI_CAST_PTR (char, (dest)), ACPI_SIG_RSDP, 8)) 558 559 /******************************************************************************* 560 * 561 * Miscellaneous constants 562 * 563 ******************************************************************************/ 564 565 /* 566 * Initialization sequence 567 */ 568 #define ACPI_FULL_INITIALIZATION 0x00 569 #define ACPI_NO_ADDRESS_SPACE_INIT 0x01 570 #define ACPI_NO_HARDWARE_INIT 0x02 571 #define ACPI_NO_EVENT_INIT 0x04 572 #define ACPI_NO_HANDLER_INIT 0x08 573 #define ACPI_NO_ACPI_ENABLE 0x10 574 #define ACPI_NO_DEVICE_INIT 0x20 575 #define ACPI_NO_OBJECT_INIT 0x40 576 577 /* 578 * Initialization state 579 */ 580 #define ACPI_SUBSYSTEM_INITIALIZE 0x01 581 #define ACPI_INITIALIZED_OK 0x02 582 583 /* 584 * Power state values 585 */ 586 #define ACPI_STATE_UNKNOWN (u8) 0xFF 587 588 #define ACPI_STATE_S0 (u8) 0 589 #define ACPI_STATE_S1 (u8) 1 590 #define ACPI_STATE_S2 (u8) 2 591 #define ACPI_STATE_S3 (u8) 3 592 #define ACPI_STATE_S4 (u8) 4 593 #define ACPI_STATE_S5 (u8) 5 594 #define ACPI_S_STATES_MAX ACPI_STATE_S5 595 #define ACPI_S_STATE_COUNT 6 596 597 #define ACPI_STATE_D0 (u8) 0 598 #define ACPI_STATE_D1 (u8) 1 599 #define ACPI_STATE_D2 (u8) 2 600 #define ACPI_STATE_D3_HOT (u8) 3 601 #define ACPI_STATE_D3 (u8) 4 602 #define ACPI_STATE_D3_COLD ACPI_STATE_D3 603 #define ACPI_D_STATES_MAX ACPI_STATE_D3 604 #define ACPI_D_STATE_COUNT 5 605 606 #define ACPI_STATE_C0 (u8) 0 607 #define ACPI_STATE_C1 (u8) 1 608 #define ACPI_STATE_C2 (u8) 2 609 #define ACPI_STATE_C3 (u8) 3 610 #define ACPI_C_STATES_MAX ACPI_STATE_C3 611 #define ACPI_C_STATE_COUNT 4 612 613 /* 614 * Sleep type invalid value 615 */ 616 #define ACPI_SLEEP_TYPE_MAX 0x7 617 #define ACPI_SLEEP_TYPE_INVALID 0xFF 618 619 /* 620 * Standard notify values 621 */ 622 #define ACPI_NOTIFY_BUS_CHECK (u8) 0x00 623 #define ACPI_NOTIFY_DEVICE_CHECK (u8) 0x01 624 #define ACPI_NOTIFY_DEVICE_WAKE (u8) 0x02 625 #define ACPI_NOTIFY_EJECT_REQUEST (u8) 0x03 626 #define ACPI_NOTIFY_DEVICE_CHECK_LIGHT (u8) 0x04 627 #define ACPI_NOTIFY_FREQUENCY_MISMATCH (u8) 0x05 628 #define ACPI_NOTIFY_BUS_MODE_MISMATCH (u8) 0x06 629 #define ACPI_NOTIFY_POWER_FAULT (u8) 0x07 630 #define ACPI_NOTIFY_CAPABILITIES_CHECK (u8) 0x08 631 #define ACPI_NOTIFY_DEVICE_PLD_CHECK (u8) 0x09 632 #define ACPI_NOTIFY_RESERVED (u8) 0x0A 633 #define ACPI_NOTIFY_LOCALITY_UPDATE (u8) 0x0B 634 #define ACPI_NOTIFY_SHUTDOWN_REQUEST (u8) 0x0C 635 #define ACPI_NOTIFY_AFFINITY_UPDATE (u8) 0x0D 636 637 #define ACPI_NOTIFY_MAX 0x0D 638 639 /* 640 * Types associated with ACPI names and objects. The first group of 641 * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition 642 * of the ACPI object_type() operator (See the ACPI Spec). Therefore, 643 * only add to the first group if the spec changes. 644 * 645 * NOTE: Types must be kept in sync with the global acpi_ns_properties 646 * and acpi_ns_type_names arrays. 647 */ 648 typedef u32 acpi_object_type; 649 650 #define ACPI_TYPE_ANY 0x00 651 #define ACPI_TYPE_INTEGER 0x01 /* Byte/Word/Dword/Zero/One/Ones */ 652 #define ACPI_TYPE_STRING 0x02 653 #define ACPI_TYPE_BUFFER 0x03 654 #define ACPI_TYPE_PACKAGE 0x04 /* byte_const, multiple data_term/Constant/super_name */ 655 #define ACPI_TYPE_FIELD_UNIT 0x05 656 #define ACPI_TYPE_DEVICE 0x06 /* Name, multiple Node */ 657 #define ACPI_TYPE_EVENT 0x07 658 #define ACPI_TYPE_METHOD 0x08 /* Name, byte_const, multiple Code */ 659 #define ACPI_TYPE_MUTEX 0x09 660 #define ACPI_TYPE_REGION 0x0A 661 #define ACPI_TYPE_POWER 0x0B /* Name,byte_const,word_const,multi Node */ 662 #define ACPI_TYPE_PROCESSOR 0x0C /* Name,byte_const,Dword_const,byte_const,multi nm_o */ 663 #define ACPI_TYPE_THERMAL 0x0D /* Name, multiple Node */ 664 #define ACPI_TYPE_BUFFER_FIELD 0x0E 665 #define ACPI_TYPE_DDB_HANDLE 0x0F 666 #define ACPI_TYPE_DEBUG_OBJECT 0x10 667 668 #define ACPI_TYPE_EXTERNAL_MAX 0x10 669 670 /* 671 * These are object types that do not map directly to the ACPI 672 * object_type() operator. They are used for various internal purposes only. 673 * If new predefined ACPI_TYPEs are added (via the ACPI specification), these 674 * internal types must move upwards. (There is code that depends on these 675 * values being contiguous with the external types above.) 676 */ 677 #define ACPI_TYPE_LOCAL_REGION_FIELD 0x11 678 #define ACPI_TYPE_LOCAL_BANK_FIELD 0x12 679 #define ACPI_TYPE_LOCAL_INDEX_FIELD 0x13 680 #define ACPI_TYPE_LOCAL_REFERENCE 0x14 /* Arg#, Local#, Name, Debug, ref_of, Index */ 681 #define ACPI_TYPE_LOCAL_ALIAS 0x15 682 #define ACPI_TYPE_LOCAL_METHOD_ALIAS 0x16 683 #define ACPI_TYPE_LOCAL_NOTIFY 0x17 684 #define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18 685 #define ACPI_TYPE_LOCAL_RESOURCE 0x19 686 #define ACPI_TYPE_LOCAL_RESOURCE_FIELD 0x1A 687 #define ACPI_TYPE_LOCAL_SCOPE 0x1B /* 1 Name, multiple object_list Nodes */ 688 689 #define ACPI_TYPE_NS_NODE_MAX 0x1B /* Last typecode used within a NS Node */ 690 691 /* 692 * These are special object types that never appear in 693 * a Namespace node, only in an object of union acpi_operand_object 694 */ 695 #define ACPI_TYPE_LOCAL_EXTRA 0x1C 696 #define ACPI_TYPE_LOCAL_DATA 0x1D 697 698 #define ACPI_TYPE_LOCAL_MAX 0x1D 699 700 /* All types above here are invalid */ 701 702 #define ACPI_TYPE_INVALID 0x1E 703 #define ACPI_TYPE_NOT_FOUND 0xFF 704 705 #define ACPI_NUM_NS_TYPES (ACPI_TYPE_INVALID + 1) 706 707 /* 708 * All I/O 709 */ 710 #define ACPI_READ 0 711 #define ACPI_WRITE 1 712 #define ACPI_IO_MASK 1 713 714 /* 715 * Event Types: Fixed & General Purpose 716 */ 717 typedef u32 acpi_event_type; 718 719 /* 720 * Fixed events 721 */ 722 #define ACPI_EVENT_PMTIMER 0 723 #define ACPI_EVENT_GLOBAL 1 724 #define ACPI_EVENT_POWER_BUTTON 2 725 #define ACPI_EVENT_SLEEP_BUTTON 3 726 #define ACPI_EVENT_RTC 4 727 #define ACPI_EVENT_MAX 4 728 #define ACPI_NUM_FIXED_EVENTS ACPI_EVENT_MAX + 1 729 730 /* 731 * Event status - Per event 732 * ------------- 733 * The encoding of acpi_event_status is illustrated below. 734 * Note that a set bit (1) indicates the property is TRUE 735 * (e.g. if bit 0 is set then the event is enabled). 736 * +-------------+-+-+-+-+-+ 737 * | Bits 31:5 |4|3|2|1|0| 738 * +-------------+-+-+-+-+-+ 739 * | | | | | | 740 * | | | | | +- Enabled? 741 * | | | | +--- Enabled for wake? 742 * | | | +----- Status bit set? 743 * | | +------- Enable bit set? 744 * | +--------- Has a handler? 745 * +--------------- <Reserved> 746 */ 747 typedef u32 acpi_event_status; 748 749 #define ACPI_EVENT_FLAG_DISABLED (acpi_event_status) 0x00 750 #define ACPI_EVENT_FLAG_ENABLED (acpi_event_status) 0x01 751 #define ACPI_EVENT_FLAG_WAKE_ENABLED (acpi_event_status) 0x02 752 #define ACPI_EVENT_FLAG_STATUS_SET (acpi_event_status) 0x04 753 #define ACPI_EVENT_FLAG_ENABLE_SET (acpi_event_status) 0x08 754 #define ACPI_EVENT_FLAG_HAS_HANDLER (acpi_event_status) 0x10 755 #define ACPI_EVENT_FLAG_SET ACPI_EVENT_FLAG_STATUS_SET 756 757 /* Actions for acpi_set_gpe, acpi_gpe_wakeup, acpi_hw_low_set_gpe */ 758 759 #define ACPI_GPE_ENABLE 0 760 #define ACPI_GPE_DISABLE 1 761 #define ACPI_GPE_CONDITIONAL_ENABLE 2 762 763 /* 764 * GPE info flags - Per GPE 765 * +-------+-+-+---+ 766 * | 7:5 |4|3|2:0| 767 * +-------+-+-+---+ 768 * | | | | 769 * | | | +-- Type of dispatch:to method, handler, notify, or none 770 * | | +----- Interrupt type: edge or level triggered 771 * | +------- Is a Wake GPE 772 * +------------ <Reserved> 773 */ 774 #define ACPI_GPE_DISPATCH_NONE (u8) 0x00 775 #define ACPI_GPE_DISPATCH_METHOD (u8) 0x01 776 #define ACPI_GPE_DISPATCH_HANDLER (u8) 0x02 777 #define ACPI_GPE_DISPATCH_NOTIFY (u8) 0x03 778 #define ACPI_GPE_DISPATCH_RAW_HANDLER (u8) 0x04 779 #define ACPI_GPE_DISPATCH_MASK (u8) 0x07 780 #define ACPI_GPE_DISPATCH_TYPE(flags) ((u8) ((flags) & ACPI_GPE_DISPATCH_MASK)) 781 782 #define ACPI_GPE_LEVEL_TRIGGERED (u8) 0x08 783 #define ACPI_GPE_EDGE_TRIGGERED (u8) 0x00 784 #define ACPI_GPE_XRUPT_TYPE_MASK (u8) 0x08 785 786 #define ACPI_GPE_CAN_WAKE (u8) 0x10 787 788 /* 789 * Flags for GPE and Lock interfaces 790 */ 791 #define ACPI_NOT_ISR 0x1 792 #define ACPI_ISR 0x0 793 794 /* Notify types */ 795 796 #define ACPI_SYSTEM_NOTIFY 0x1 797 #define ACPI_DEVICE_NOTIFY 0x2 798 #define ACPI_ALL_NOTIFY (ACPI_SYSTEM_NOTIFY | ACPI_DEVICE_NOTIFY) 799 #define ACPI_MAX_NOTIFY_HANDLER_TYPE 0x3 800 #define ACPI_NUM_NOTIFY_TYPES 2 801 802 #define ACPI_MAX_SYS_NOTIFY 0x7F 803 #define ACPI_MAX_DEVICE_SPECIFIC_NOTIFY 0xBF 804 805 #define ACPI_SYSTEM_HANDLER_LIST 0 /* Used as index, must be SYSTEM_NOTIFY -1 */ 806 #define ACPI_DEVICE_HANDLER_LIST 1 /* Used as index, must be DEVICE_NOTIFY -1 */ 807 808 /* Address Space (Operation Region) Types */ 809 810 typedef u8 acpi_adr_space_type; 811 812 #define ACPI_ADR_SPACE_SYSTEM_MEMORY (acpi_adr_space_type) 0 813 #define ACPI_ADR_SPACE_SYSTEM_IO (acpi_adr_space_type) 1 814 #define ACPI_ADR_SPACE_PCI_CONFIG (acpi_adr_space_type) 2 815 #define ACPI_ADR_SPACE_EC (acpi_adr_space_type) 3 816 #define ACPI_ADR_SPACE_SMBUS (acpi_adr_space_type) 4 817 #define ACPI_ADR_SPACE_CMOS (acpi_adr_space_type) 5 818 #define ACPI_ADR_SPACE_PCI_BAR_TARGET (acpi_adr_space_type) 6 819 #define ACPI_ADR_SPACE_IPMI (acpi_adr_space_type) 7 820 #define ACPI_ADR_SPACE_GPIO (acpi_adr_space_type) 8 821 #define ACPI_ADR_SPACE_GSBUS (acpi_adr_space_type) 9 822 #define ACPI_ADR_SPACE_PLATFORM_COMM (acpi_adr_space_type) 10 823 824 #define ACPI_NUM_PREDEFINED_REGIONS 11 825 826 /* 827 * Special Address Spaces 828 * 829 * Note: A Data Table region is a special type of operation region 830 * that has its own AML opcode. However, internally, the AML 831 * interpreter simply creates an operation region with an an address 832 * space type of ACPI_ADR_SPACE_DATA_TABLE. 833 */ 834 #define ACPI_ADR_SPACE_DATA_TABLE (acpi_adr_space_type) 0x7E /* Internal to ACPICA only */ 835 #define ACPI_ADR_SPACE_FIXED_HARDWARE (acpi_adr_space_type) 0x7F 836 837 /* Values for _REG connection code */ 838 839 #define ACPI_REG_DISCONNECT 0 840 #define ACPI_REG_CONNECT 1 841 842 /* 843 * bit_register IDs 844 * 845 * These values are intended to be used by the hardware interfaces 846 * and are mapped to individual bitfields defined within the ACPI 847 * registers. See the acpi_gbl_bit_register_info global table in utglobal.c 848 * for this mapping. 849 */ 850 851 /* PM1 Status register */ 852 853 #define ACPI_BITREG_TIMER_STATUS 0x00 854 #define ACPI_BITREG_BUS_MASTER_STATUS 0x01 855 #define ACPI_BITREG_GLOBAL_LOCK_STATUS 0x02 856 #define ACPI_BITREG_POWER_BUTTON_STATUS 0x03 857 #define ACPI_BITREG_SLEEP_BUTTON_STATUS 0x04 858 #define ACPI_BITREG_RT_CLOCK_STATUS 0x05 859 #define ACPI_BITREG_WAKE_STATUS 0x06 860 #define ACPI_BITREG_PCIEXP_WAKE_STATUS 0x07 861 862 /* PM1 Enable register */ 863 864 #define ACPI_BITREG_TIMER_ENABLE 0x08 865 #define ACPI_BITREG_GLOBAL_LOCK_ENABLE 0x09 866 #define ACPI_BITREG_POWER_BUTTON_ENABLE 0x0A 867 #define ACPI_BITREG_SLEEP_BUTTON_ENABLE 0x0B 868 #define ACPI_BITREG_RT_CLOCK_ENABLE 0x0C 869 #define ACPI_BITREG_PCIEXP_WAKE_DISABLE 0x0D 870 871 /* PM1 Control register */ 872 873 #define ACPI_BITREG_SCI_ENABLE 0x0E 874 #define ACPI_BITREG_BUS_MASTER_RLD 0x0F 875 #define ACPI_BITREG_GLOBAL_LOCK_RELEASE 0x10 876 #define ACPI_BITREG_SLEEP_TYPE 0x11 877 #define ACPI_BITREG_SLEEP_ENABLE 0x12 878 879 /* PM2 Control register */ 880 881 #define ACPI_BITREG_ARB_DISABLE 0x13 882 883 #define ACPI_BITREG_MAX 0x13 884 #define ACPI_NUM_BITREG ACPI_BITREG_MAX + 1 885 886 /* Status register values. A 1 clears a status bit. 0 = no effect */ 887 888 #define ACPI_CLEAR_STATUS 1 889 890 /* Enable and Control register values */ 891 892 #define ACPI_ENABLE_EVENT 1 893 #define ACPI_DISABLE_EVENT 0 894 895 /* Sleep function dispatch */ 896 897 typedef acpi_status(*acpi_sleep_function) (u8 sleep_state); 898 899 struct acpi_sleep_functions { 900 acpi_sleep_function legacy_function; 901 acpi_sleep_function extended_function; 902 }; 903 904 /* 905 * External ACPI object definition 906 */ 907 908 /* 909 * Note: Type == ACPI_TYPE_ANY (0) is used to indicate a NULL package element 910 * or an unresolved named reference. 911 */ 912 union acpi_object { 913 acpi_object_type type; /* See definition of acpi_ns_type for values */ 914 struct { 915 acpi_object_type type; /* ACPI_TYPE_INTEGER */ 916 u64 value; /* The actual number */ 917 } integer; 918 919 struct { 920 acpi_object_type type; /* ACPI_TYPE_STRING */ 921 u32 length; /* # of bytes in string, excluding trailing null */ 922 char *pointer; /* points to the string value */ 923 } string; 924 925 struct { 926 acpi_object_type type; /* ACPI_TYPE_BUFFER */ 927 u32 length; /* # of bytes in buffer */ 928 u8 *pointer; /* points to the buffer */ 929 } buffer; 930 931 struct { 932 acpi_object_type type; /* ACPI_TYPE_PACKAGE */ 933 u32 count; /* # of elements in package */ 934 union acpi_object *elements; /* Pointer to an array of ACPI_OBJECTs */ 935 } package; 936 937 struct { 938 acpi_object_type type; /* ACPI_TYPE_LOCAL_REFERENCE */ 939 acpi_object_type actual_type; /* Type associated with the Handle */ 940 acpi_handle handle; /* object reference */ 941 } reference; 942 943 struct { 944 acpi_object_type type; /* ACPI_TYPE_PROCESSOR */ 945 u32 proc_id; 946 acpi_io_address pblk_address; 947 u32 pblk_length; 948 } processor; 949 950 struct { 951 acpi_object_type type; /* ACPI_TYPE_POWER */ 952 u32 system_level; 953 u32 resource_order; 954 } power_resource; 955 }; 956 957 /* 958 * List of objects, used as a parameter list for control method evaluation 959 */ 960 struct acpi_object_list { 961 u32 count; 962 union acpi_object *pointer; 963 }; 964 965 /* 966 * Miscellaneous common Data Structures used by the interfaces 967 */ 968 #define ACPI_NO_BUFFER 0 969 970 #ifdef ACPI_NO_MEM_ALLOCATIONS 971 972 #define ACPI_ALLOCATE_BUFFER (acpi_size) (0) 973 #define ACPI_ALLOCATE_LOCAL_BUFFER (acpi_size) (0) 974 975 #else /* ACPI_NO_MEM_ALLOCATIONS */ 976 977 #define ACPI_ALLOCATE_BUFFER (acpi_size) (-1) /* Let ACPICA allocate buffer */ 978 #define ACPI_ALLOCATE_LOCAL_BUFFER (acpi_size) (-2) /* For internal use only (enables tracking) */ 979 980 #endif /* ACPI_NO_MEM_ALLOCATIONS */ 981 982 struct acpi_buffer { 983 acpi_size length; /* Length in bytes of the buffer */ 984 void *pointer; /* pointer to buffer */ 985 }; 986 987 /* 988 * name_type for acpi_get_name 989 */ 990 #define ACPI_FULL_PATHNAME 0 991 #define ACPI_SINGLE_NAME 1 992 #define ACPI_NAME_TYPE_MAX 1 993 994 /* 995 * Predefined Namespace items 996 */ 997 struct acpi_predefined_names { 998 char *name; 999 u8 type; 1000 char *val; 1001 }; 1002 1003 /* 1004 * Structure and flags for acpi_get_system_info 1005 */ 1006 #define ACPI_SYS_MODE_UNKNOWN 0x0000 1007 #define ACPI_SYS_MODE_ACPI 0x0001 1008 #define ACPI_SYS_MODE_LEGACY 0x0002 1009 #define ACPI_SYS_MODES_MASK 0x0003 1010 1011 /* 1012 * System info returned by acpi_get_system_info() 1013 */ 1014 struct acpi_system_info { 1015 u32 acpi_ca_version; 1016 u32 flags; 1017 u32 timer_resolution; 1018 u32 reserved1; 1019 u32 reserved2; 1020 u32 debug_level; 1021 u32 debug_layer; 1022 }; 1023 1024 /* 1025 * System statistics returned by acpi_get_statistics() 1026 */ 1027 struct acpi_statistics { 1028 u32 sci_count; 1029 u32 gpe_count; 1030 u32 fixed_event_count[ACPI_NUM_FIXED_EVENTS]; 1031 u32 method_count; 1032 }; 1033 1034 /* Table Event Types */ 1035 1036 #define ACPI_TABLE_EVENT_LOAD 0x0 1037 #define ACPI_TABLE_EVENT_UNLOAD 0x1 1038 #define ACPI_NUM_TABLE_EVENTS 2 1039 1040 /* 1041 * Types specific to the OS service interfaces 1042 */ 1043 typedef u32 1044 (ACPI_SYSTEM_XFACE * acpi_osd_handler) (void *context); 1045 1046 typedef void 1047 (ACPI_SYSTEM_XFACE * acpi_osd_exec_callback) (void *context); 1048 1049 /* 1050 * Various handlers and callback procedures 1051 */ 1052 typedef 1053 u32 (*acpi_sci_handler) (void *context); 1054 1055 typedef 1056 void (*acpi_gbl_event_handler) (u32 event_type, 1057 acpi_handle device, 1058 u32 event_number, void *context); 1059 1060 #define ACPI_EVENT_TYPE_GPE 0 1061 #define ACPI_EVENT_TYPE_FIXED 1 1062 1063 typedef 1064 u32(*acpi_event_handler) (void *context); 1065 1066 typedef 1067 u32 (*acpi_gpe_handler) (acpi_handle gpe_device, u32 gpe_number, void *context); 1068 1069 typedef 1070 void (*acpi_notify_handler) (acpi_handle device, u32 value, void *context); 1071 1072 typedef 1073 void (*acpi_object_handler) (acpi_handle object, void *data); 1074 1075 typedef acpi_status(*acpi_init_handler) (acpi_handle object, u32 function); 1076 1077 #define ACPI_INIT_DEVICE_INI 1 1078 1079 typedef 1080 acpi_status(*acpi_exception_handler) (acpi_status aml_status, 1081 acpi_name name, 1082 u16 opcode, 1083 u32 aml_offset, void *context); 1084 1085 /* Table Event handler (Load, load_table, etc.) and types */ 1086 1087 typedef 1088 acpi_status(*acpi_table_handler) (u32 event, void *table, void *context); 1089 1090 #define ACPI_TABLE_LOAD 0x0 1091 #define ACPI_TABLE_UNLOAD 0x1 1092 #define ACPI_NUM_TABLE_EVENTS 2 1093 1094 /* Address Spaces (For Operation Regions) */ 1095 1096 typedef 1097 acpi_status(*acpi_adr_space_handler) (u32 function, 1098 acpi_physical_address address, 1099 u32 bit_width, 1100 u64 *value, 1101 void *handler_context, 1102 void *region_context); 1103 1104 #define ACPI_DEFAULT_HANDLER NULL 1105 1106 /* Special Context data for generic_serial_bus/general_purpose_io (ACPI 5.0) */ 1107 1108 struct acpi_connection_info { 1109 u8 *connection; 1110 u16 length; 1111 u8 access_length; 1112 }; 1113 1114 typedef 1115 acpi_status(*acpi_adr_space_setup) (acpi_handle region_handle, 1116 u32 function, 1117 void *handler_context, 1118 void **region_context); 1119 1120 #define ACPI_REGION_ACTIVATE 0 1121 #define ACPI_REGION_DEACTIVATE 1 1122 1123 typedef 1124 acpi_status(*acpi_walk_callback) (acpi_handle object, 1125 u32 nesting_level, 1126 void *context, void **return_value); 1127 1128 typedef 1129 u32 (*acpi_interface_handler) (acpi_string interface_name, u32 supported); 1130 1131 /* Interrupt handler return values */ 1132 1133 #define ACPI_INTERRUPT_NOT_HANDLED 0x00 1134 #define ACPI_INTERRUPT_HANDLED 0x01 1135 1136 /* GPE handler return values */ 1137 1138 #define ACPI_REENABLE_GPE 0x80 1139 1140 /* Length of 32-bit EISAID values when converted back to a string */ 1141 1142 #define ACPI_EISAID_STRING_SIZE 8 /* Includes null terminator */ 1143 1144 /* Length of UUID (string) values */ 1145 1146 #define ACPI_UUID_LENGTH 16 1147 1148 /* Structures used for device/processor HID, UID, CID, and SUB */ 1149 1150 struct acpi_pnp_device_id { 1151 u32 length; /* Length of string + null */ 1152 char *string; 1153 }; 1154 1155 struct acpi_pnp_device_id_list { 1156 u32 count; /* Number of IDs in Ids array */ 1157 u32 list_size; /* Size of list, including ID strings */ 1158 struct acpi_pnp_device_id ids[1]; /* ID array */ 1159 }; 1160 1161 /* 1162 * Structure returned from acpi_get_object_info. 1163 * Optimized for both 32- and 64-bit builds 1164 */ 1165 struct acpi_device_info { 1166 u32 info_size; /* Size of info, including ID strings */ 1167 u32 name; /* ACPI object Name */ 1168 acpi_object_type type; /* ACPI object Type */ 1169 u8 param_count; /* If a method, required parameter count */ 1170 u8 valid; /* Indicates which optional fields are valid */ 1171 u8 flags; /* Miscellaneous info */ 1172 u8 highest_dstates[4]; /* _sx_d values: 0xFF indicates not valid */ 1173 u8 lowest_dstates[5]; /* _sx_w values: 0xFF indicates not valid */ 1174 u32 current_status; /* _STA value */ 1175 u64 address; /* _ADR value */ 1176 struct acpi_pnp_device_id hardware_id; /* _HID value */ 1177 struct acpi_pnp_device_id unique_id; /* _UID value */ 1178 struct acpi_pnp_device_id subsystem_id; /* _SUB value */ 1179 struct acpi_pnp_device_id_list compatible_id_list; /* _CID list <must be last> */ 1180 }; 1181 1182 /* Values for Flags field above (acpi_get_object_info) */ 1183 1184 #define ACPI_PCI_ROOT_BRIDGE 0x01 1185 1186 /* Flags for Valid field above (acpi_get_object_info) */ 1187 1188 #define ACPI_VALID_STA 0x01 1189 #define ACPI_VALID_ADR 0x02 1190 #define ACPI_VALID_HID 0x04 1191 #define ACPI_VALID_UID 0x08 1192 #define ACPI_VALID_SUB 0x10 1193 #define ACPI_VALID_CID 0x20 1194 #define ACPI_VALID_SXDS 0x40 1195 #define ACPI_VALID_SXWS 0x80 1196 1197 /* Flags for _STA return value (current_status above) */ 1198 1199 #define ACPI_STA_DEVICE_PRESENT 0x01 1200 #define ACPI_STA_DEVICE_ENABLED 0x02 1201 #define ACPI_STA_DEVICE_UI 0x04 1202 #define ACPI_STA_DEVICE_FUNCTIONING 0x08 1203 #define ACPI_STA_DEVICE_OK 0x08 /* Synonym */ 1204 #define ACPI_STA_BATTERY_PRESENT 0x10 1205 1206 /* Context structs for address space handlers */ 1207 1208 struct acpi_pci_id { 1209 u16 segment; 1210 u16 bus; 1211 u16 device; 1212 u16 function; 1213 }; 1214 1215 struct acpi_mem_space_context { 1216 u32 length; 1217 acpi_physical_address address; 1218 acpi_physical_address mapped_physical_address; 1219 u8 *mapped_logical_address; 1220 acpi_size mapped_length; 1221 }; 1222 1223 /* 1224 * struct acpi_memory_list is used only if the ACPICA local cache is enabled 1225 */ 1226 struct acpi_memory_list { 1227 char *list_name; 1228 void *list_head; 1229 u16 object_size; 1230 u16 max_depth; 1231 u16 current_depth; 1232 1233 #ifdef ACPI_DBG_TRACK_ALLOCATIONS 1234 1235 /* Statistics for debug memory tracking only */ 1236 1237 u32 total_allocated; 1238 u32 total_freed; 1239 u32 max_occupied; 1240 u32 total_size; 1241 u32 current_total_size; 1242 u32 requests; 1243 u32 hits; 1244 #endif 1245 }; 1246 1247 /* Definitions of _OSI support */ 1248 1249 #define ACPI_VENDOR_STRINGS 0x01 1250 #define ACPI_FEATURE_STRINGS 0x02 1251 #define ACPI_ENABLE_INTERFACES 0x00 1252 #define ACPI_DISABLE_INTERFACES 0x04 1253 1254 #define ACPI_DISABLE_ALL_VENDOR_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS) 1255 #define ACPI_DISABLE_ALL_FEATURE_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_FEATURE_STRINGS) 1256 #define ACPI_DISABLE_ALL_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS) 1257 #define ACPI_ENABLE_ALL_VENDOR_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS) 1258 #define ACPI_ENABLE_ALL_FEATURE_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_FEATURE_STRINGS) 1259 #define ACPI_ENABLE_ALL_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS) 1260 1261 #define ACPI_OSI_WIN_2000 0x01 1262 #define ACPI_OSI_WIN_XP 0x02 1263 #define ACPI_OSI_WIN_XP_SP1 0x03 1264 #define ACPI_OSI_WINSRV_2003 0x04 1265 #define ACPI_OSI_WIN_XP_SP2 0x05 1266 #define ACPI_OSI_WINSRV_2003_SP1 0x06 1267 #define ACPI_OSI_WIN_VISTA 0x07 1268 #define ACPI_OSI_WINSRV_2008 0x08 1269 #define ACPI_OSI_WIN_VISTA_SP1 0x09 1270 #define ACPI_OSI_WIN_VISTA_SP2 0x0A 1271 #define ACPI_OSI_WIN_7 0x0B 1272 #define ACPI_OSI_WIN_8 0x0C 1273 #define ACPI_OSI_WIN_10 0x0D 1274 1275 /* Definitions of file IO */ 1276 1277 #define ACPI_FILE_READING 0x01 1278 #define ACPI_FILE_WRITING 0x02 1279 #define ACPI_FILE_BINARY 0x04 1280 1281 #define ACPI_FILE_BEGIN 0x01 1282 #define ACPI_FILE_END 0x02 1283 1284 /* Definitions of getopt */ 1285 1286 #define ACPI_OPT_END -1 1287 1288 #endif /* __ACTYPES_H__ */ 1289