1 /****************************************************************************** 2 * 3 * Name: actypes.h - Common data types for the entire ACPI subsystem 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2017, Intel Corp. 12 * All rights reserved. 13 * 14 * 2. License 15 * 16 * 2.1. This is your license from Intel Corp. under its intellectual property 17 * rights. You may have additional license terms from the party that provided 18 * you this software, covering your right to use that party's intellectual 19 * property rights. 20 * 21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 22 * copy of the source code appearing in this file ("Covered Code") an 23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 24 * base code distributed originally by Intel ("Original Intel Code") to copy, 25 * make derivatives, distribute, use and display any portion of the Covered 26 * Code in any form, with the right to sublicense such rights; and 27 * 28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 29 * license (with the right to sublicense), under only those claims of Intel 30 * patents that are infringed by the Original Intel Code, to make, use, sell, 31 * offer to sell, and import the Covered Code and derivative works thereof 32 * solely to the minimum extent necessary to exercise the above copyright 33 * license, and in no event shall the patent license extend to any additions 34 * to or modifications of the Original Intel Code. No other license or right 35 * is granted directly or by implication, estoppel or otherwise; 36 * 37 * The above copyright and patent license is granted only if the following 38 * conditions are met: 39 * 40 * 3. Conditions 41 * 42 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 43 * Redistribution of source code of any substantial portion of the Covered 44 * Code or modification with rights to further distribute source must include 45 * the above Copyright Notice, the above License, this list of Conditions, 46 * and the following Disclaimer and Export Compliance provision. In addition, 47 * Licensee must cause all Covered Code to which Licensee contributes to 48 * contain a file documenting the changes Licensee made to create that Covered 49 * Code and the date of any change. Licensee must include in that file the 50 * documentation of any changes made by any predecessor Licensee. Licensee 51 * must include a prominent statement that the modification is derived, 52 * directly or indirectly, from Original Intel Code. 53 * 54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 55 * Redistribution of source code of any substantial portion of the Covered 56 * Code or modification without rights to further distribute source must 57 * include the following Disclaimer and Export Compliance provision in the 58 * documentation and/or other materials provided with distribution. In 59 * addition, Licensee may not authorize further sublicense of source of any 60 * portion of the Covered Code, and must include terms to the effect that the 61 * license from Licensee to its licensee is limited to the intellectual 62 * property embodied in the software Licensee provides to its licensee, and 63 * not to intellectual property embodied in modifications its licensee may 64 * make. 65 * 66 * 3.3. Redistribution of Executable. Redistribution in executable form of any 67 * substantial portion of the Covered Code or modification must reproduce the 68 * above Copyright Notice, and the following Disclaimer and Export Compliance 69 * provision in the documentation and/or other materials provided with the 70 * distribution. 71 * 72 * 3.4. Intel retains all right, title, and interest in and to the Original 73 * Intel Code. 74 * 75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 76 * Intel shall be used in advertising or otherwise to promote the sale, use or 77 * other dealings in products derived from or relating to the Covered Code 78 * without prior written authorization from Intel. 79 * 80 * 4. Disclaimer and Export Compliance 81 * 82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 88 * PARTICULAR PURPOSE. 89 * 90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 97 * LIMITED REMEDY. 98 * 99 * 4.3. Licensee shall not export, either directly or indirectly, any of this 100 * software or system incorporating such software without first obtaining any 101 * required license or other approval from the U. S. Department of Commerce or 102 * any other agency or department of the United States Government. In the 103 * event Licensee exports any such software from the United States or 104 * re-exports any such software from a foreign destination, Licensee shall 105 * ensure that the distribution and export/re-export of the software is in 106 * compliance with all laws, regulations, orders, or other restrictions of the 107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 108 * any of its subsidiaries will export/re-export any technical data, process, 109 * software, or service, directly or indirectly, to any country for which the 110 * United States government or any agency thereof requires an export license, 111 * other governmental approval, or letter of assurance, without first obtaining 112 * such license, approval or letter. 113 * 114 ***************************************************************************** 115 * 116 * Alternatively, you may choose to be licensed under the terms of the 117 * following license: 118 * 119 * Redistribution and use in source and binary forms, with or without 120 * modification, are permitted provided that the following conditions 121 * are met: 122 * 1. Redistributions of source code must retain the above copyright 123 * notice, this list of conditions, and the following disclaimer, 124 * without modification. 125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 126 * substantially similar to the "NO WARRANTY" disclaimer below 127 * ("Disclaimer") and any redistribution must be conditioned upon 128 * including a substantially similar Disclaimer requirement for further 129 * binary redistribution. 130 * 3. Neither the names of the above-listed copyright holders nor the names 131 * of any contributors may be used to endorse or promote products derived 132 * from this software without specific prior written permission. 133 * 134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 145 * 146 * Alternatively, you may choose to be licensed under the terms of the 147 * GNU General Public License ("GPL") version 2 as published by the Free 148 * Software Foundation. 149 * 150 *****************************************************************************/ 151 152 #ifndef __ACTYPES_H__ 153 #define __ACTYPES_H__ 154 155 /* acpisrc:StructDefs -- for acpisrc conversion */ 156 157 /* 158 * ACPI_MACHINE_WIDTH must be specified in an OS- or compiler-dependent 159 * header and must be either 32 or 64. 16-bit ACPICA is no longer 160 * supported, as of 12/2006. 161 */ 162 #ifndef ACPI_MACHINE_WIDTH 163 #error ACPI_MACHINE_WIDTH not defined 164 #endif 165 166 /* 167 * Data type ranges 168 * Note: These macros are designed to be compiler independent as well as 169 * working around problems that some 32-bit compilers have with 64-bit 170 * constants. 171 */ 172 #define ACPI_UINT8_MAX (UINT8) (~((UINT8) 0)) /* 0xFF */ 173 #define ACPI_UINT16_MAX (UINT16)(~((UINT16) 0)) /* 0xFFFF */ 174 #define ACPI_UINT32_MAX (UINT32)(~((UINT32) 0)) /* 0xFFFFFFFF */ 175 #define ACPI_UINT64_MAX (UINT64)(~((UINT64) 0)) /* 0xFFFFFFFFFFFFFFFF */ 176 #define ACPI_ASCII_MAX 0x7F 177 178 179 /* 180 * Architecture-specific ACPICA Subsystem Data Types 181 * 182 * The goal of these types is to provide source code portability across 183 * 16-bit, 32-bit, and 64-bit targets. 184 * 185 * 1) The following types are of fixed size for all targets (16/32/64): 186 * 187 * BOOLEAN Logical boolean 188 * 189 * UINT8 8-bit (1 byte) unsigned value 190 * UINT16 16-bit (2 byte) unsigned value 191 * UINT32 32-bit (4 byte) unsigned value 192 * UINT64 64-bit (8 byte) unsigned value 193 * 194 * INT16 16-bit (2 byte) signed value 195 * INT32 32-bit (4 byte) signed value 196 * INT64 64-bit (8 byte) signed value 197 * 198 * COMPILER_DEPENDENT_UINT64/INT64 - These types are defined in the 199 * compiler-dependent header(s) and were introduced because there is no 200 * common 64-bit integer type across the various compilation models, as 201 * shown in the table below. 202 * 203 * Datatype LP64 ILP64 LLP64 ILP32 LP32 16bit 204 * char 8 8 8 8 8 8 205 * short 16 16 16 16 16 16 206 * _int32 32 207 * int 32 64 32 32 16 16 208 * long 64 64 32 32 32 32 209 * long long 64 64 210 * pointer 64 64 64 32 32 32 211 * 212 * Note: ILP64 and LP32 are currently not supported. 213 * 214 * 215 * 2) These types represent the native word size of the target mode of the 216 * processor, and may be 16-bit, 32-bit, or 64-bit as required. They are 217 * usually used for memory allocation, efficient loop counters, and array 218 * indexes. The types are similar to the size_t type in the C library and 219 * are required because there is no C type that consistently represents the 220 * native data width. ACPI_SIZE is needed because there is no guarantee 221 * that a kernel-level C library is present. 222 * 223 * ACPI_SIZE 16/32/64-bit unsigned value 224 * ACPI_NATIVE_INT 16/32/64-bit signed value 225 */ 226 227 /******************************************************************************* 228 * 229 * Common types for all compilers, all targets 230 * 231 ******************************************************************************/ 232 233 #ifndef ACPI_USE_SYSTEM_INTTYPES 234 235 typedef unsigned char BOOLEAN; 236 typedef unsigned char UINT8; 237 typedef unsigned short UINT16; 238 typedef short INT16; 239 typedef COMPILER_DEPENDENT_UINT64 UINT64; 240 typedef COMPILER_DEPENDENT_INT64 INT64; 241 242 #endif /* ACPI_USE_SYSTEM_INTTYPES */ 243 244 /* 245 * Value returned by AcpiOsGetThreadId. There is no standard "thread_id" 246 * across operating systems or even the various UNIX systems. Since ACPICA 247 * only needs the thread ID as a unique thread identifier, we use a UINT64 248 * as the only common data type - it will accommodate any type of pointer or 249 * any type of integer. It is up to the host-dependent OSL to cast the 250 * native thread ID type to a UINT64 (in AcpiOsGetThreadId). 251 */ 252 #define ACPI_THREAD_ID UINT64 253 254 255 /******************************************************************************* 256 * 257 * Types specific to 64-bit targets 258 * 259 ******************************************************************************/ 260 261 #if ACPI_MACHINE_WIDTH == 64 262 263 #ifndef ACPI_USE_SYSTEM_INTTYPES 264 265 typedef unsigned int UINT32; 266 typedef int INT32; 267 268 #endif /* ACPI_USE_SYSTEM_INTTYPES */ 269 270 271 typedef INT64 ACPI_NATIVE_INT; 272 typedef UINT64 ACPI_SIZE; 273 typedef UINT64 ACPI_IO_ADDRESS; 274 typedef UINT64 ACPI_PHYSICAL_ADDRESS; 275 276 #define ACPI_MAX_PTR ACPI_UINT64_MAX 277 #define ACPI_SIZE_MAX ACPI_UINT64_MAX 278 #define ACPI_USE_NATIVE_DIVIDE /* Has native 64-bit integer support */ 279 280 /* 281 * In the case of the Itanium Processor Family (IPF), the hardware does not 282 * support misaligned memory transfers. Set the MISALIGNMENT_NOT_SUPPORTED 283 * flag to indicate that special precautions must be taken to avoid alignment 284 * faults. (IA64 or ia64 is currently used by existing compilers to indicate 285 * IPF.) 286 * 287 * Note: EM64T and other X86-64 processors support misaligned transfers, 288 * so there is no need to define this flag. 289 */ 290 #if defined (__IA64__) || defined (__ia64__) 291 #define ACPI_MISALIGNMENT_NOT_SUPPORTED 292 #endif 293 294 295 /******************************************************************************* 296 * 297 * Types specific to 32-bit targets 298 * 299 ******************************************************************************/ 300 301 #elif ACPI_MACHINE_WIDTH == 32 302 303 #ifndef ACPI_USE_SYSTEM_INTTYPES 304 305 typedef unsigned int UINT32; 306 typedef int INT32; 307 308 #endif /* ACPI_USE_SYSTEM_INTTYPES */ 309 310 311 typedef INT32 ACPI_NATIVE_INT; 312 typedef UINT32 ACPI_SIZE; 313 314 #ifdef ACPI_32BIT_PHYSICAL_ADDRESS 315 316 /* 317 * OSPMs can define this to shrink the size of the structures for 32-bit 318 * none PAE environment. ASL compiler may always define this to generate 319 * 32-bit OSPM compliant tables. 320 */ 321 typedef UINT32 ACPI_IO_ADDRESS; 322 typedef UINT32 ACPI_PHYSICAL_ADDRESS; 323 324 #else /* ACPI_32BIT_PHYSICAL_ADDRESS */ 325 326 /* 327 * It is reported that, after some calculations, the physical addresses can 328 * wrap over the 32-bit boundary on 32-bit PAE environment. 329 * https://bugzilla.kernel.org/show_bug.cgi?id=87971 330 */ 331 typedef UINT64 ACPI_IO_ADDRESS; 332 typedef UINT64 ACPI_PHYSICAL_ADDRESS; 333 334 #endif /* ACPI_32BIT_PHYSICAL_ADDRESS */ 335 336 #define ACPI_MAX_PTR ACPI_UINT32_MAX 337 #define ACPI_SIZE_MAX ACPI_UINT32_MAX 338 339 #else 340 341 /* ACPI_MACHINE_WIDTH must be either 64 or 32 */ 342 343 #error unknown ACPI_MACHINE_WIDTH 344 #endif 345 346 347 /******************************************************************************* 348 * 349 * OS-dependent types 350 * 351 * If the defaults below are not appropriate for the host system, they can 352 * be defined in the OS-specific header, and this will take precedence. 353 * 354 ******************************************************************************/ 355 356 /* Flags for AcpiOsAcquireLock/AcpiOsReleaseLock */ 357 358 #ifndef ACPI_CPU_FLAGS 359 #define ACPI_CPU_FLAGS ACPI_SIZE 360 #endif 361 362 /* Object returned from AcpiOsCreateCache */ 363 364 #ifndef ACPI_CACHE_T 365 #ifdef ACPI_USE_LOCAL_CACHE 366 #define ACPI_CACHE_T ACPI_MEMORY_LIST 367 #else 368 #define ACPI_CACHE_T void * 369 #endif 370 #endif 371 372 /* 373 * Synchronization objects - Mutexes, Semaphores, and SpinLocks 374 */ 375 #if (ACPI_MUTEX_TYPE == ACPI_BINARY_SEMAPHORE) 376 /* 377 * These macros are used if the host OS does not support a mutex object. 378 * Map the OSL Mutex interfaces to binary semaphores. 379 */ 380 #define ACPI_MUTEX ACPI_SEMAPHORE 381 #define AcpiOsCreateMutex(OutHandle) AcpiOsCreateSemaphore (1, 1, OutHandle) 382 #define AcpiOsDeleteMutex(Handle) (void) AcpiOsDeleteSemaphore (Handle) 383 #define AcpiOsAcquireMutex(Handle,Time) AcpiOsWaitSemaphore (Handle, 1, Time) 384 #define AcpiOsReleaseMutex(Handle) (void) AcpiOsSignalSemaphore (Handle, 1) 385 #endif 386 387 /* Configurable types for synchronization objects */ 388 389 #ifndef ACPI_SPINLOCK 390 #define ACPI_SPINLOCK void * 391 #endif 392 393 #ifndef ACPI_SEMAPHORE 394 #define ACPI_SEMAPHORE void * 395 #endif 396 397 #ifndef ACPI_MUTEX 398 #define ACPI_MUTEX void * 399 #endif 400 401 402 /******************************************************************************* 403 * 404 * Compiler-dependent types 405 * 406 * If the defaults below are not appropriate for the host compiler, they can 407 * be defined in the compiler-specific header, and this will take precedence. 408 * 409 ******************************************************************************/ 410 411 /* Use C99 uintptr_t for pointer casting if available, "void *" otherwise */ 412 413 #ifndef ACPI_UINTPTR_T 414 #define ACPI_UINTPTR_T void * 415 #endif 416 417 /* 418 * ACPI_PRINTF_LIKE is used to tag functions as "printf-like" because 419 * some compilers can catch printf format string problems 420 */ 421 #ifndef ACPI_PRINTF_LIKE 422 #define ACPI_PRINTF_LIKE(c) 423 #endif 424 425 /* 426 * Some compilers complain about unused variables. Sometimes we don't want 427 * to use all the variables (for example, _AcpiModuleName). This allows us 428 * to tell the compiler in a per-variable manner that a variable 429 * is unused 430 */ 431 #ifndef ACPI_UNUSED_VAR 432 #define ACPI_UNUSED_VAR 433 #endif 434 435 /* 436 * All ACPICA external functions that are available to the rest of the 437 * kernel are tagged with these macros which can be defined as appropriate 438 * for the host. 439 * 440 * Notes: 441 * ACPI_EXPORT_SYMBOL_INIT is used for initialization and termination 442 * interfaces that may need special processing. 443 * ACPI_EXPORT_SYMBOL is used for all other public external functions. 444 */ 445 #ifndef ACPI_EXPORT_SYMBOL_INIT 446 #define ACPI_EXPORT_SYMBOL_INIT(Symbol) 447 #endif 448 449 #ifndef ACPI_EXPORT_SYMBOL 450 #define ACPI_EXPORT_SYMBOL(Symbol) 451 #endif 452 453 /* 454 * Compiler/Clibrary-dependent debug initialization. Used for ACPICA 455 * utilities only. 456 */ 457 #ifndef ACPI_DEBUG_INITIALIZE 458 #define ACPI_DEBUG_INITIALIZE() 459 #endif 460 461 462 /******************************************************************************* 463 * 464 * Configuration 465 * 466 ******************************************************************************/ 467 468 #ifdef ACPI_NO_MEM_ALLOCATIONS 469 470 #define ACPI_ALLOCATE(a) NULL 471 #define ACPI_ALLOCATE_ZEROED(a) NULL 472 #define ACPI_FREE(a) 473 #define ACPI_MEM_TRACKING(a) 474 475 #else /* ACPI_NO_MEM_ALLOCATIONS */ 476 477 #ifdef ACPI_DBG_TRACK_ALLOCATIONS 478 /* 479 * Memory allocation tracking (used by AcpiExec to detect memory leaks) 480 */ 481 #define ACPI_MEM_PARAMETERS _COMPONENT, _AcpiModuleName, __LINE__ 482 #define ACPI_ALLOCATE(a) AcpiUtAllocateAndTrack ((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS) 483 #define ACPI_ALLOCATE_ZEROED(a) AcpiUtAllocateZeroedAndTrack ((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS) 484 #define ACPI_FREE(a) AcpiUtFreeAndTrack (a, ACPI_MEM_PARAMETERS) 485 #define ACPI_MEM_TRACKING(a) a 486 487 #else 488 /* 489 * Normal memory allocation directly via the OS services layer 490 */ 491 #define ACPI_ALLOCATE(a) AcpiOsAllocate ((ACPI_SIZE) (a)) 492 #define ACPI_ALLOCATE_ZEROED(a) AcpiOsAllocateZeroed ((ACPI_SIZE) (a)) 493 #define ACPI_FREE(a) AcpiOsFree (a) 494 #define ACPI_MEM_TRACKING(a) 495 496 #endif /* ACPI_DBG_TRACK_ALLOCATIONS */ 497 498 #endif /* ACPI_NO_MEM_ALLOCATIONS */ 499 500 501 /****************************************************************************** 502 * 503 * ACPI Specification constants (Do not change unless the specification 504 * changes) 505 * 506 *****************************************************************************/ 507 508 /* Number of distinct FADT-based GPE register blocks (GPE0 and GPE1) */ 509 510 #define ACPI_MAX_GPE_BLOCKS 2 511 512 /* Default ACPI register widths */ 513 514 #define ACPI_GPE_REGISTER_WIDTH 8 515 #define ACPI_PM1_REGISTER_WIDTH 16 516 #define ACPI_PM2_REGISTER_WIDTH 8 517 #define ACPI_PM_TIMER_WIDTH 32 518 #define ACPI_RESET_REGISTER_WIDTH 8 519 520 /* Names within the namespace are 4 bytes long */ 521 522 #define ACPI_NAME_SIZE 4 523 #define ACPI_PATH_SEGMENT_LENGTH 5 /* 4 chars for name + 1 char for separator */ 524 #define ACPI_PATH_SEPARATOR '.' 525 526 /* Sizes for ACPI table headers */ 527 528 #define ACPI_OEM_ID_SIZE 6 529 #define ACPI_OEM_TABLE_ID_SIZE 8 530 531 /* ACPI/PNP hardware IDs */ 532 533 #define PCI_ROOT_HID_STRING "PNP0A03" 534 #define PCI_EXPRESS_ROOT_HID_STRING "PNP0A08" 535 536 /* PM Timer ticks per second (HZ) */ 537 538 #define ACPI_PM_TIMER_FREQUENCY 3579545 539 540 541 /******************************************************************************* 542 * 543 * Independent types 544 * 545 ******************************************************************************/ 546 547 /* Logical defines and NULL */ 548 549 #ifdef FALSE 550 #undef FALSE 551 #endif 552 #define FALSE (1 == 0) 553 554 #ifdef TRUE 555 #undef TRUE 556 #endif 557 #define TRUE (1 == 1) 558 559 #ifndef NULL 560 #define NULL (void *) 0 561 #endif 562 563 564 /* 565 * Miscellaneous types 566 */ 567 typedef UINT32 ACPI_STATUS; /* All ACPI Exceptions */ 568 typedef UINT32 ACPI_NAME; /* 4-byte ACPI name */ 569 typedef char * ACPI_STRING; /* Null terminated ASCII string */ 570 typedef void * ACPI_HANDLE; /* Actually a ptr to a NS Node */ 571 572 573 /* Time constants for timer calculations */ 574 575 #define ACPI_MSEC_PER_SEC 1000L 576 577 #define ACPI_USEC_PER_MSEC 1000L 578 #define ACPI_USEC_PER_SEC 1000000L 579 580 #define ACPI_100NSEC_PER_USEC 10L 581 #define ACPI_100NSEC_PER_MSEC 10000L 582 #define ACPI_100NSEC_PER_SEC 10000000L 583 584 #define ACPI_NSEC_PER_USEC 1000L 585 #define ACPI_NSEC_PER_MSEC 1000000L 586 #define ACPI_NSEC_PER_SEC 1000000000L 587 588 589 /* Owner IDs are used to track namespace nodes for selective deletion */ 590 591 typedef UINT8 ACPI_OWNER_ID; 592 #define ACPI_OWNER_ID_MAX 0xFF 593 594 595 #define ACPI_INTEGER_BIT_SIZE 64 596 #define ACPI_MAX_DECIMAL_DIGITS 20 /* 2^64 = 18,446,744,073,709,551,616 */ 597 #define ACPI_MAX64_DECIMAL_DIGITS 20 598 #define ACPI_MAX32_DECIMAL_DIGITS 10 599 #define ACPI_MAX16_DECIMAL_DIGITS 5 600 #define ACPI_MAX8_DECIMAL_DIGITS 3 601 602 /* 603 * Constants with special meanings 604 */ 605 #define ACPI_ROOT_OBJECT ACPI_ADD_PTR (ACPI_HANDLE, NULL, ACPI_MAX_PTR) 606 #define ACPI_WAIT_FOREVER 0xFFFF /* UINT16, as per ACPI spec */ 607 #define ACPI_DO_NOT_WAIT 0 608 609 /* 610 * Obsolete: Acpi integer width. In ACPI version 1 (1996), integers are 611 * 32 bits. In ACPI version 2 (2000) and later, integers are max 64 bits. 612 * Note that this pertains to the ACPI integer type only, not to other 613 * integers used in the implementation of the ACPICA subsystem. 614 * 615 * 01/2010: This type is obsolete and has been removed from the entire ACPICA 616 * code base. It remains here for compatibility with device drivers that use 617 * the type. However, it will be removed in the future. 618 */ 619 typedef UINT64 ACPI_INTEGER; 620 #define ACPI_INTEGER_MAX ACPI_UINT64_MAX 621 622 623 /******************************************************************************* 624 * 625 * Commonly used macros 626 * 627 ******************************************************************************/ 628 629 /* Data manipulation */ 630 631 #define ACPI_LOBYTE(Integer) ((UINT8) (UINT16)(Integer)) 632 #define ACPI_HIBYTE(Integer) ((UINT8) (((UINT16)(Integer)) >> 8)) 633 #define ACPI_LOWORD(Integer) ((UINT16) (UINT32)(Integer)) 634 #define ACPI_HIWORD(Integer) ((UINT16)(((UINT32)(Integer)) >> 16)) 635 #define ACPI_LODWORD(Integer64) ((UINT32) (UINT64)(Integer64)) 636 #define ACPI_HIDWORD(Integer64) ((UINT32)(((UINT64)(Integer64)) >> 32)) 637 638 #define ACPI_SET_BIT(target,bit) ((target) |= (bit)) 639 #define ACPI_CLEAR_BIT(target,bit) ((target) &= ~(bit)) 640 #define ACPI_MIN(a,b) (((a)<(b))?(a):(b)) 641 #define ACPI_MAX(a,b) (((a)>(b))?(a):(b)) 642 643 /* Size calculation */ 644 645 #define ACPI_ARRAY_LENGTH(x) (sizeof(x) / sizeof((x)[0])) 646 647 /* Pointer manipulation */ 648 649 #define ACPI_CAST_PTR(t, p) ((t *) (ACPI_UINTPTR_T) (p)) 650 #define ACPI_CAST_INDIRECT_PTR(t, p) ((t **) (ACPI_UINTPTR_T) (p)) 651 #define ACPI_ADD_PTR(t, a, b) ACPI_CAST_PTR (t, (ACPI_CAST_PTR (UINT8, (a)) + (ACPI_SIZE)(b))) 652 #define ACPI_SUB_PTR(t, a, b) ACPI_CAST_PTR (t, (ACPI_CAST_PTR (UINT8, (a)) - (ACPI_SIZE)(b))) 653 #define ACPI_PTR_DIFF(a, b) (ACPI_SIZE) (ACPI_CAST_PTR (UINT8, (a)) - ACPI_CAST_PTR (UINT8, (b))) 654 655 /* Pointer/Integer type conversions */ 656 657 #define ACPI_TO_POINTER(i) ACPI_ADD_PTR (void, (void *) NULL,(ACPI_SIZE) i) 658 #define ACPI_TO_INTEGER(p) ACPI_PTR_DIFF (p, (void *) NULL) 659 #define ACPI_OFFSET(d, f) ACPI_PTR_DIFF (&(((d *) 0)->f), (void *) NULL) 660 #define ACPI_PHYSADDR_TO_PTR(i) ACPI_TO_POINTER(i) 661 #define ACPI_PTR_TO_PHYSADDR(i) ACPI_TO_INTEGER(i) 662 663 /* Optimizations for 4-character (32-bit) ACPI_NAME manipulation */ 664 665 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED 666 #define ACPI_COMPARE_NAME(a,b) (*ACPI_CAST_PTR (UINT32, (a)) == *ACPI_CAST_PTR (UINT32, (b))) 667 #define ACPI_MOVE_NAME(dest,src) (*ACPI_CAST_PTR (UINT32, (dest)) = *ACPI_CAST_PTR (UINT32, (src))) 668 #else 669 #define ACPI_COMPARE_NAME(a,b) (!strncmp (ACPI_CAST_PTR (char, (a)), ACPI_CAST_PTR (char, (b)), ACPI_NAME_SIZE)) 670 #define ACPI_MOVE_NAME(dest,src) (strncpy (ACPI_CAST_PTR (char, (dest)), ACPI_CAST_PTR (char, (src)), ACPI_NAME_SIZE)) 671 #endif 672 673 /* Support for the special RSDP signature (8 characters) */ 674 675 #define ACPI_VALIDATE_RSDP_SIG(a) (!strncmp (ACPI_CAST_PTR (char, (a)), ACPI_SIG_RSDP, 8)) 676 #define ACPI_MAKE_RSDP_SIG(dest) (memcpy (ACPI_CAST_PTR (char, (dest)), ACPI_SIG_RSDP, 8)) 677 678 679 /******************************************************************************* 680 * 681 * Miscellaneous constants 682 * 683 ******************************************************************************/ 684 685 /* 686 * Initialization sequence 687 */ 688 #define ACPI_FULL_INITIALIZATION 0x00 689 #define ACPI_NO_ADDRESS_SPACE_INIT 0x01 690 #define ACPI_NO_HARDWARE_INIT 0x02 691 #define ACPI_NO_EVENT_INIT 0x04 692 #define ACPI_NO_HANDLER_INIT 0x08 693 #define ACPI_NO_ACPI_ENABLE 0x10 694 #define ACPI_NO_DEVICE_INIT 0x20 695 #define ACPI_NO_OBJECT_INIT 0x40 696 #define ACPI_NO_FACS_INIT 0x80 697 698 /* 699 * Initialization state 700 */ 701 #define ACPI_SUBSYSTEM_INITIALIZE 0x01 702 #define ACPI_INITIALIZED_OK 0x02 703 704 /* 705 * Power state values 706 */ 707 #define ACPI_STATE_UNKNOWN (UINT8) 0xFF 708 709 #define ACPI_STATE_S0 (UINT8) 0 710 #define ACPI_STATE_S1 (UINT8) 1 711 #define ACPI_STATE_S2 (UINT8) 2 712 #define ACPI_STATE_S3 (UINT8) 3 713 #define ACPI_STATE_S4 (UINT8) 4 714 #define ACPI_STATE_S5 (UINT8) 5 715 #define ACPI_S_STATES_MAX ACPI_STATE_S5 716 #define ACPI_S_STATE_COUNT 6 717 718 #define ACPI_STATE_D0 (UINT8) 0 719 #define ACPI_STATE_D1 (UINT8) 1 720 #define ACPI_STATE_D2 (UINT8) 2 721 #define ACPI_STATE_D3 (UINT8) 3 722 #define ACPI_D_STATES_MAX ACPI_STATE_D3 723 #define ACPI_D_STATE_COUNT 4 724 725 #define ACPI_STATE_C0 (UINT8) 0 726 #define ACPI_STATE_C1 (UINT8) 1 727 #define ACPI_STATE_C2 (UINT8) 2 728 #define ACPI_STATE_C3 (UINT8) 3 729 #define ACPI_C_STATES_MAX ACPI_STATE_C3 730 #define ACPI_C_STATE_COUNT 4 731 732 /* 733 * Sleep type invalid value 734 */ 735 #define ACPI_SLEEP_TYPE_MAX 0x7 736 #define ACPI_SLEEP_TYPE_INVALID 0xFF 737 738 /* 739 * Standard notify values 740 */ 741 #define ACPI_NOTIFY_BUS_CHECK (UINT8) 0x00 742 #define ACPI_NOTIFY_DEVICE_CHECK (UINT8) 0x01 743 #define ACPI_NOTIFY_DEVICE_WAKE (UINT8) 0x02 744 #define ACPI_NOTIFY_EJECT_REQUEST (UINT8) 0x03 745 #define ACPI_NOTIFY_DEVICE_CHECK_LIGHT (UINT8) 0x04 746 #define ACPI_NOTIFY_FREQUENCY_MISMATCH (UINT8) 0x05 747 #define ACPI_NOTIFY_BUS_MODE_MISMATCH (UINT8) 0x06 748 #define ACPI_NOTIFY_POWER_FAULT (UINT8) 0x07 749 #define ACPI_NOTIFY_CAPABILITIES_CHECK (UINT8) 0x08 750 #define ACPI_NOTIFY_DEVICE_PLD_CHECK (UINT8) 0x09 751 #define ACPI_NOTIFY_RESERVED (UINT8) 0x0A 752 #define ACPI_NOTIFY_LOCALITY_UPDATE (UINT8) 0x0B 753 #define ACPI_NOTIFY_SHUTDOWN_REQUEST (UINT8) 0x0C 754 #define ACPI_NOTIFY_AFFINITY_UPDATE (UINT8) 0x0D 755 #define ACPI_NOTIFY_MEMORY_UPDATE (UINT8) 0x0E 756 757 #define ACPI_GENERIC_NOTIFY_MAX 0x0E 758 #define ACPI_SPECIFIC_NOTIFY_MAX 0x84 759 760 /* 761 * Types associated with ACPI names and objects. The first group of 762 * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition 763 * of the ACPI ObjectType() operator (See the ACPI Spec). Therefore, 764 * only add to the first group if the spec changes. 765 * 766 * NOTE: Types must be kept in sync with the global AcpiNsProperties 767 * and AcpiNsTypeNames arrays. 768 */ 769 typedef UINT32 ACPI_OBJECT_TYPE; 770 771 #define ACPI_TYPE_ANY 0x00 772 #define ACPI_TYPE_INTEGER 0x01 /* Byte/Word/Dword/Zero/One/Ones */ 773 #define ACPI_TYPE_STRING 0x02 774 #define ACPI_TYPE_BUFFER 0x03 775 #define ACPI_TYPE_PACKAGE 0x04 /* ByteConst, multiple DataTerm/Constant/SuperName */ 776 #define ACPI_TYPE_FIELD_UNIT 0x05 777 #define ACPI_TYPE_DEVICE 0x06 /* Name, multiple Node */ 778 #define ACPI_TYPE_EVENT 0x07 779 #define ACPI_TYPE_METHOD 0x08 /* Name, ByteConst, multiple Code */ 780 #define ACPI_TYPE_MUTEX 0x09 781 #define ACPI_TYPE_REGION 0x0A 782 #define ACPI_TYPE_POWER 0x0B /* Name,ByteConst,WordConst,multi Node */ 783 #define ACPI_TYPE_PROCESSOR 0x0C /* Name,ByteConst,DWordConst,ByteConst,multi NmO */ 784 #define ACPI_TYPE_THERMAL 0x0D /* Name, multiple Node */ 785 #define ACPI_TYPE_BUFFER_FIELD 0x0E 786 #define ACPI_TYPE_DDB_HANDLE 0x0F 787 #define ACPI_TYPE_DEBUG_OBJECT 0x10 788 789 #define ACPI_TYPE_EXTERNAL_MAX 0x10 790 #define ACPI_NUM_TYPES (ACPI_TYPE_EXTERNAL_MAX + 1) 791 792 /* 793 * These are object types that do not map directly to the ACPI 794 * ObjectType() operator. They are used for various internal purposes 795 * only. If new predefined ACPI_TYPEs are added (via the ACPI 796 * specification), these internal types must move upwards. (There 797 * is code that depends on these values being contiguous with the 798 * external types above.) 799 */ 800 #define ACPI_TYPE_LOCAL_REGION_FIELD 0x11 801 #define ACPI_TYPE_LOCAL_BANK_FIELD 0x12 802 #define ACPI_TYPE_LOCAL_INDEX_FIELD 0x13 803 #define ACPI_TYPE_LOCAL_REFERENCE 0x14 /* Arg#, Local#, Name, Debug, RefOf, Index */ 804 #define ACPI_TYPE_LOCAL_ALIAS 0x15 805 #define ACPI_TYPE_LOCAL_METHOD_ALIAS 0x16 806 #define ACPI_TYPE_LOCAL_NOTIFY 0x17 807 #define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18 808 #define ACPI_TYPE_LOCAL_RESOURCE 0x19 809 #define ACPI_TYPE_LOCAL_RESOURCE_FIELD 0x1A 810 #define ACPI_TYPE_LOCAL_SCOPE 0x1B /* 1 Name, multiple ObjectList Nodes */ 811 812 #define ACPI_TYPE_NS_NODE_MAX 0x1B /* Last typecode used within a NS Node */ 813 #define ACPI_TOTAL_TYPES (ACPI_TYPE_NS_NODE_MAX + 1) 814 815 /* 816 * These are special object types that never appear in 817 * a Namespace node, only in an object of ACPI_OPERAND_OBJECT 818 */ 819 #define ACPI_TYPE_LOCAL_EXTRA 0x1C 820 #define ACPI_TYPE_LOCAL_DATA 0x1D 821 822 #define ACPI_TYPE_LOCAL_MAX 0x1D 823 824 /* All types above here are invalid */ 825 826 #define ACPI_TYPE_INVALID 0x1E 827 #define ACPI_TYPE_NOT_FOUND 0xFF 828 829 #define ACPI_NUM_NS_TYPES (ACPI_TYPE_INVALID + 1) 830 831 832 /* 833 * All I/O 834 */ 835 #define ACPI_READ 0 836 #define ACPI_WRITE 1 837 #define ACPI_IO_MASK 1 838 839 /* 840 * Event Types: Fixed & General Purpose 841 */ 842 typedef UINT32 ACPI_EVENT_TYPE; 843 844 /* 845 * Fixed events 846 */ 847 #define ACPI_EVENT_PMTIMER 0 848 #define ACPI_EVENT_GLOBAL 1 849 #define ACPI_EVENT_POWER_BUTTON 2 850 #define ACPI_EVENT_SLEEP_BUTTON 3 851 #define ACPI_EVENT_RTC 4 852 #define ACPI_EVENT_MAX 4 853 #define ACPI_NUM_FIXED_EVENTS ACPI_EVENT_MAX + 1 854 855 /* 856 * Event Status - Per event 857 * ------------- 858 * The encoding of ACPI_EVENT_STATUS is illustrated below. 859 * Note that a set bit (1) indicates the property is TRUE 860 * (e.g. if bit 0 is set then the event is enabled). 861 * +-------------+-+-+-+-+-+-+ 862 * | Bits 31:6 |5|4|3|2|1|0| 863 * +-------------+-+-+-+-+-+-+ 864 * | | | | | | | 865 * | | | | | | +- Enabled? 866 * | | | | | +--- Enabled for wake? 867 * | | | | +----- Status bit set? 868 * | | | +------- Enable bit set? 869 * | | +--------- Has a handler? 870 * | +----------- Masked? 871 * +----------------- <Reserved> 872 */ 873 typedef UINT32 ACPI_EVENT_STATUS; 874 875 #define ACPI_EVENT_FLAG_DISABLED (ACPI_EVENT_STATUS) 0x00 876 #define ACPI_EVENT_FLAG_ENABLED (ACPI_EVENT_STATUS) 0x01 877 #define ACPI_EVENT_FLAG_WAKE_ENABLED (ACPI_EVENT_STATUS) 0x02 878 #define ACPI_EVENT_FLAG_STATUS_SET (ACPI_EVENT_STATUS) 0x04 879 #define ACPI_EVENT_FLAG_ENABLE_SET (ACPI_EVENT_STATUS) 0x08 880 #define ACPI_EVENT_FLAG_HAS_HANDLER (ACPI_EVENT_STATUS) 0x10 881 #define ACPI_EVENT_FLAG_MASKED (ACPI_EVENT_STATUS) 0x20 882 #define ACPI_EVENT_FLAG_SET ACPI_EVENT_FLAG_STATUS_SET 883 884 /* Actions for AcpiSetGpe, AcpiGpeWakeup, AcpiHwLowSetGpe */ 885 886 #define ACPI_GPE_ENABLE 0 887 #define ACPI_GPE_DISABLE 1 888 #define ACPI_GPE_CONDITIONAL_ENABLE 2 889 890 /* 891 * GPE info flags - Per GPE 892 * +---+-+-+-+---+ 893 * |7:6|5|4|3|2:0| 894 * +---+-+-+-+---+ 895 * | | | | | 896 * | | | | +-- Type of dispatch:to method, handler, notify, or none 897 * | | | +----- Interrupt type: edge or level triggered 898 * | | +------- Is a Wake GPE 899 * | +--------- Is GPE masked by the software GPE masking mechanism 900 * +------------ <Reserved> 901 */ 902 #define ACPI_GPE_DISPATCH_NONE (UINT8) 0x00 903 #define ACPI_GPE_DISPATCH_METHOD (UINT8) 0x01 904 #define ACPI_GPE_DISPATCH_HANDLER (UINT8) 0x02 905 #define ACPI_GPE_DISPATCH_NOTIFY (UINT8) 0x03 906 #define ACPI_GPE_DISPATCH_RAW_HANDLER (UINT8) 0x04 907 #define ACPI_GPE_DISPATCH_MASK (UINT8) 0x07 908 #define ACPI_GPE_DISPATCH_TYPE(flags) ((UINT8) ((flags) & ACPI_GPE_DISPATCH_MASK)) 909 910 #define ACPI_GPE_LEVEL_TRIGGERED (UINT8) 0x08 911 #define ACPI_GPE_EDGE_TRIGGERED (UINT8) 0x00 912 #define ACPI_GPE_XRUPT_TYPE_MASK (UINT8) 0x08 913 914 #define ACPI_GPE_CAN_WAKE (UINT8) 0x10 915 916 /* 917 * Flags for GPE and Lock interfaces 918 */ 919 #define ACPI_NOT_ISR 0x1 920 #define ACPI_ISR 0x0 921 922 923 /* Notify types */ 924 925 #define ACPI_SYSTEM_NOTIFY 0x1 926 #define ACPI_DEVICE_NOTIFY 0x2 927 #define ACPI_ALL_NOTIFY (ACPI_SYSTEM_NOTIFY | ACPI_DEVICE_NOTIFY) 928 #define ACPI_MAX_NOTIFY_HANDLER_TYPE 0x3 929 #define ACPI_NUM_NOTIFY_TYPES 2 930 931 #define ACPI_MAX_SYS_NOTIFY 0x7F 932 #define ACPI_MAX_DEVICE_SPECIFIC_NOTIFY 0xBF 933 934 #define ACPI_SYSTEM_HANDLER_LIST 0 /* Used as index, must be SYSTEM_NOTIFY -1 */ 935 #define ACPI_DEVICE_HANDLER_LIST 1 /* Used as index, must be DEVICE_NOTIFY -1 */ 936 937 938 /* Address Space (Operation Region) Types */ 939 940 typedef UINT8 ACPI_ADR_SPACE_TYPE; 941 942 #define ACPI_ADR_SPACE_SYSTEM_MEMORY (ACPI_ADR_SPACE_TYPE) 0 943 #define ACPI_ADR_SPACE_SYSTEM_IO (ACPI_ADR_SPACE_TYPE) 1 944 #define ACPI_ADR_SPACE_PCI_CONFIG (ACPI_ADR_SPACE_TYPE) 2 945 #define ACPI_ADR_SPACE_EC (ACPI_ADR_SPACE_TYPE) 3 946 #define ACPI_ADR_SPACE_SMBUS (ACPI_ADR_SPACE_TYPE) 4 947 #define ACPI_ADR_SPACE_CMOS (ACPI_ADR_SPACE_TYPE) 5 948 #define ACPI_ADR_SPACE_PCI_BAR_TARGET (ACPI_ADR_SPACE_TYPE) 6 949 #define ACPI_ADR_SPACE_IPMI (ACPI_ADR_SPACE_TYPE) 7 950 #define ACPI_ADR_SPACE_GPIO (ACPI_ADR_SPACE_TYPE) 8 951 #define ACPI_ADR_SPACE_GSBUS (ACPI_ADR_SPACE_TYPE) 9 952 #define ACPI_ADR_SPACE_PLATFORM_COMM (ACPI_ADR_SPACE_TYPE) 10 953 954 #define ACPI_NUM_PREDEFINED_REGIONS 11 955 956 /* 957 * Special Address Spaces 958 * 959 * Note: A Data Table region is a special type of operation region 960 * that has its own AML opcode. However, internally, the AML 961 * interpreter simply creates an operation region with an an address 962 * space type of ACPI_ADR_SPACE_DATA_TABLE. 963 */ 964 #define ACPI_ADR_SPACE_DATA_TABLE (ACPI_ADR_SPACE_TYPE) 0x7E /* Internal to ACPICA only */ 965 #define ACPI_ADR_SPACE_FIXED_HARDWARE (ACPI_ADR_SPACE_TYPE) 0x7F 966 967 /* Values for _REG connection code */ 968 969 #define ACPI_REG_DISCONNECT 0 970 #define ACPI_REG_CONNECT 1 971 972 /* 973 * BitRegister IDs 974 * 975 * These values are intended to be used by the hardware interfaces 976 * and are mapped to individual bitfields defined within the ACPI 977 * registers. See the AcpiGbl_BitRegisterInfo global table in utglobal.c 978 * for this mapping. 979 */ 980 981 /* PM1 Status register */ 982 983 #define ACPI_BITREG_TIMER_STATUS 0x00 984 #define ACPI_BITREG_BUS_MASTER_STATUS 0x01 985 #define ACPI_BITREG_GLOBAL_LOCK_STATUS 0x02 986 #define ACPI_BITREG_POWER_BUTTON_STATUS 0x03 987 #define ACPI_BITREG_SLEEP_BUTTON_STATUS 0x04 988 #define ACPI_BITREG_RT_CLOCK_STATUS 0x05 989 #define ACPI_BITREG_WAKE_STATUS 0x06 990 #define ACPI_BITREG_PCIEXP_WAKE_STATUS 0x07 991 992 /* PM1 Enable register */ 993 994 #define ACPI_BITREG_TIMER_ENABLE 0x08 995 #define ACPI_BITREG_GLOBAL_LOCK_ENABLE 0x09 996 #define ACPI_BITREG_POWER_BUTTON_ENABLE 0x0A 997 #define ACPI_BITREG_SLEEP_BUTTON_ENABLE 0x0B 998 #define ACPI_BITREG_RT_CLOCK_ENABLE 0x0C 999 #define ACPI_BITREG_PCIEXP_WAKE_DISABLE 0x0D 1000 1001 /* PM1 Control register */ 1002 1003 #define ACPI_BITREG_SCI_ENABLE 0x0E 1004 #define ACPI_BITREG_BUS_MASTER_RLD 0x0F 1005 #define ACPI_BITREG_GLOBAL_LOCK_RELEASE 0x10 1006 #define ACPI_BITREG_SLEEP_TYPE 0x11 1007 #define ACPI_BITREG_SLEEP_ENABLE 0x12 1008 1009 /* PM2 Control register */ 1010 1011 #define ACPI_BITREG_ARB_DISABLE 0x13 1012 1013 #define ACPI_BITREG_MAX 0x13 1014 #define ACPI_NUM_BITREG ACPI_BITREG_MAX + 1 1015 1016 1017 /* Status register values. A 1 clears a status bit. 0 = no effect */ 1018 1019 #define ACPI_CLEAR_STATUS 1 1020 1021 /* Enable and Control register values */ 1022 1023 #define ACPI_ENABLE_EVENT 1 1024 #define ACPI_DISABLE_EVENT 0 1025 1026 1027 /* Sleep function dispatch */ 1028 1029 typedef ACPI_STATUS (*ACPI_SLEEP_FUNCTION) ( 1030 UINT8 SleepState); 1031 1032 typedef struct acpi_sleep_functions 1033 { 1034 ACPI_SLEEP_FUNCTION LegacyFunction; 1035 ACPI_SLEEP_FUNCTION ExtendedFunction; 1036 1037 } ACPI_SLEEP_FUNCTIONS; 1038 1039 1040 /* 1041 * External ACPI object definition 1042 */ 1043 1044 /* 1045 * Note: Type == ACPI_TYPE_ANY (0) is used to indicate a NULL package 1046 * element or an unresolved named reference. 1047 */ 1048 typedef union acpi_object 1049 { 1050 ACPI_OBJECT_TYPE Type; /* See definition of AcpiNsType for values */ 1051 struct 1052 { 1053 ACPI_OBJECT_TYPE Type; /* ACPI_TYPE_INTEGER */ 1054 UINT64 Value; /* The actual number */ 1055 } Integer; 1056 1057 struct 1058 { 1059 ACPI_OBJECT_TYPE Type; /* ACPI_TYPE_STRING */ 1060 UINT32 Length; /* # of bytes in string, excluding trailing null */ 1061 char *Pointer; /* points to the string value */ 1062 } String; 1063 1064 struct 1065 { 1066 ACPI_OBJECT_TYPE Type; /* ACPI_TYPE_BUFFER */ 1067 UINT32 Length; /* # of bytes in buffer */ 1068 UINT8 *Pointer; /* points to the buffer */ 1069 } Buffer; 1070 1071 struct 1072 { 1073 ACPI_OBJECT_TYPE Type; /* ACPI_TYPE_PACKAGE */ 1074 UINT32 Count; /* # of elements in package */ 1075 union acpi_object *Elements; /* Pointer to an array of ACPI_OBJECTs */ 1076 } Package; 1077 1078 struct 1079 { 1080 ACPI_OBJECT_TYPE Type; /* ACPI_TYPE_LOCAL_REFERENCE */ 1081 ACPI_OBJECT_TYPE ActualType; /* Type associated with the Handle */ 1082 ACPI_HANDLE Handle; /* object reference */ 1083 } Reference; 1084 1085 struct 1086 { 1087 ACPI_OBJECT_TYPE Type; /* ACPI_TYPE_PROCESSOR */ 1088 UINT32 ProcId; 1089 ACPI_IO_ADDRESS PblkAddress; 1090 UINT32 PblkLength; 1091 } Processor; 1092 1093 struct 1094 { 1095 ACPI_OBJECT_TYPE Type; /* ACPI_TYPE_POWER */ 1096 UINT32 SystemLevel; 1097 UINT32 ResourceOrder; 1098 } PowerResource; 1099 1100 } ACPI_OBJECT; 1101 1102 1103 /* 1104 * List of objects, used as a parameter list for control method evaluation 1105 */ 1106 typedef struct acpi_object_list 1107 { 1108 UINT32 Count; 1109 ACPI_OBJECT *Pointer; 1110 1111 } ACPI_OBJECT_LIST; 1112 1113 1114 /* 1115 * Miscellaneous common Data Structures used by the interfaces 1116 */ 1117 #define ACPI_NO_BUFFER 0 1118 1119 #ifdef ACPI_NO_MEM_ALLOCATIONS 1120 1121 #define ACPI_ALLOCATE_BUFFER (ACPI_SIZE) (0) 1122 #define ACPI_ALLOCATE_LOCAL_BUFFER (ACPI_SIZE) (0) 1123 1124 #else /* ACPI_NO_MEM_ALLOCATIONS */ 1125 1126 #define ACPI_ALLOCATE_BUFFER (ACPI_SIZE) (-1) /* Let ACPICA allocate buffer */ 1127 #define ACPI_ALLOCATE_LOCAL_BUFFER (ACPI_SIZE) (-2) /* For internal use only (enables tracking) */ 1128 1129 #endif /* ACPI_NO_MEM_ALLOCATIONS */ 1130 1131 typedef struct acpi_buffer 1132 { 1133 ACPI_SIZE Length; /* Length in bytes of the buffer */ 1134 void *Pointer; /* pointer to buffer */ 1135 1136 } ACPI_BUFFER; 1137 1138 1139 /* 1140 * NameType for AcpiGetName 1141 */ 1142 #define ACPI_FULL_PATHNAME 0 1143 #define ACPI_SINGLE_NAME 1 1144 #define ACPI_FULL_PATHNAME_NO_TRAILING 2 1145 #define ACPI_NAME_TYPE_MAX 2 1146 1147 1148 /* 1149 * Predefined Namespace items 1150 */ 1151 typedef struct acpi_predefined_names 1152 { 1153 const char *Name; 1154 UINT8 Type; 1155 char *Val; 1156 1157 } ACPI_PREDEFINED_NAMES; 1158 1159 1160 /* 1161 * Structure and flags for AcpiGetSystemInfo 1162 */ 1163 #define ACPI_SYS_MODE_UNKNOWN 0x0000 1164 #define ACPI_SYS_MODE_ACPI 0x0001 1165 #define ACPI_SYS_MODE_LEGACY 0x0002 1166 #define ACPI_SYS_MODES_MASK 0x0003 1167 1168 1169 /* 1170 * System info returned by AcpiGetSystemInfo() 1171 */ 1172 typedef struct acpi_system_info 1173 { 1174 UINT32 AcpiCaVersion; 1175 UINT32 Flags; 1176 UINT32 TimerResolution; 1177 UINT32 Reserved1; 1178 UINT32 Reserved2; 1179 UINT32 DebugLevel; 1180 UINT32 DebugLayer; 1181 1182 } ACPI_SYSTEM_INFO; 1183 1184 1185 /* 1186 * System statistics returned by AcpiGetStatistics() 1187 */ 1188 typedef struct acpi_statistics 1189 { 1190 UINT32 SciCount; 1191 UINT32 GpeCount; 1192 UINT32 FixedEventCount[ACPI_NUM_FIXED_EVENTS]; 1193 UINT32 MethodCount; 1194 1195 } ACPI_STATISTICS; 1196 1197 1198 /* 1199 * Types specific to the OS service interfaces 1200 */ 1201 typedef UINT32 1202 (ACPI_SYSTEM_XFACE *ACPI_OSD_HANDLER) ( 1203 void *Context); 1204 1205 typedef void 1206 (ACPI_SYSTEM_XFACE *ACPI_OSD_EXEC_CALLBACK) ( 1207 void *Context); 1208 1209 /* 1210 * Various handlers and callback procedures 1211 */ 1212 typedef 1213 UINT32 (*ACPI_SCI_HANDLER) ( 1214 void *Context); 1215 1216 typedef 1217 void (*ACPI_GBL_EVENT_HANDLER) ( 1218 UINT32 EventType, 1219 ACPI_HANDLE Device, 1220 UINT32 EventNumber, 1221 void *Context); 1222 1223 #define ACPI_EVENT_TYPE_GPE 0 1224 #define ACPI_EVENT_TYPE_FIXED 1 1225 1226 typedef 1227 UINT32 (*ACPI_EVENT_HANDLER) ( 1228 void *Context); 1229 1230 typedef 1231 UINT32 (*ACPI_GPE_HANDLER) ( 1232 ACPI_HANDLE GpeDevice, 1233 UINT32 GpeNumber, 1234 void *Context); 1235 1236 typedef 1237 void (*ACPI_NOTIFY_HANDLER) ( 1238 ACPI_HANDLE Device, 1239 UINT32 Value, 1240 void *Context); 1241 1242 typedef 1243 void (*ACPI_OBJECT_HANDLER) ( 1244 ACPI_HANDLE Object, 1245 void *Data); 1246 1247 typedef 1248 ACPI_STATUS (*ACPI_INIT_HANDLER) ( 1249 ACPI_HANDLE Object, 1250 UINT32 Function); 1251 1252 #define ACPI_INIT_DEVICE_INI 1 1253 1254 typedef 1255 ACPI_STATUS (*ACPI_EXCEPTION_HANDLER) ( 1256 ACPI_STATUS AmlStatus, 1257 ACPI_NAME Name, 1258 UINT16 Opcode, 1259 UINT32 AmlOffset, 1260 void *Context); 1261 1262 /* Table Event handler (Load, LoadTable, etc.) and types */ 1263 1264 typedef 1265 ACPI_STATUS (*ACPI_TABLE_HANDLER) ( 1266 UINT32 Event, 1267 void *Table, 1268 void *Context); 1269 1270 1271 /* Table Event Types */ 1272 1273 #define ACPI_TABLE_EVENT_LOAD 0x0 1274 #define ACPI_TABLE_EVENT_UNLOAD 0x1 1275 #define ACPI_TABLE_EVENT_INSTALL 0x2 1276 #define ACPI_TABLE_EVENT_UNINSTALL 0x3 1277 #define ACPI_NUM_TABLE_EVENTS 4 1278 1279 1280 /* Address Spaces (For Operation Regions) */ 1281 1282 typedef 1283 ACPI_STATUS (*ACPI_ADR_SPACE_HANDLER) ( 1284 UINT32 Function, 1285 ACPI_PHYSICAL_ADDRESS Address, 1286 UINT32 BitWidth, 1287 UINT64 *Value, 1288 void *HandlerContext, 1289 void *RegionContext); 1290 1291 #define ACPI_DEFAULT_HANDLER NULL 1292 1293 /* Special Context data for GenericSerialBus/GeneralPurposeIo (ACPI 5.0) */ 1294 1295 typedef struct acpi_connection_info 1296 { 1297 UINT8 *Connection; 1298 UINT16 Length; 1299 UINT8 AccessLength; 1300 1301 } ACPI_CONNECTION_INFO; 1302 1303 1304 typedef 1305 ACPI_STATUS (*ACPI_ADR_SPACE_SETUP) ( 1306 ACPI_HANDLE RegionHandle, 1307 UINT32 Function, 1308 void *HandlerContext, 1309 void **RegionContext); 1310 1311 #define ACPI_REGION_ACTIVATE 0 1312 #define ACPI_REGION_DEACTIVATE 1 1313 1314 typedef 1315 ACPI_STATUS (*ACPI_WALK_CALLBACK) ( 1316 ACPI_HANDLE Object, 1317 UINT32 NestingLevel, 1318 void *Context, 1319 void **ReturnValue); 1320 1321 typedef 1322 UINT32 (*ACPI_INTERFACE_HANDLER) ( 1323 ACPI_STRING InterfaceName, 1324 UINT32 Supported); 1325 1326 1327 /* Interrupt handler return values */ 1328 1329 #define ACPI_INTERRUPT_NOT_HANDLED 0x00 1330 #define ACPI_INTERRUPT_HANDLED 0x01 1331 1332 /* GPE handler return values */ 1333 1334 #define ACPI_REENABLE_GPE 0x80 1335 1336 1337 /* Length of 32-bit EISAID values when converted back to a string */ 1338 1339 #define ACPI_EISAID_STRING_SIZE 8 /* Includes null terminator */ 1340 1341 /* Length of UUID (string) values */ 1342 1343 #define ACPI_UUID_LENGTH 16 1344 1345 /* Length of 3-byte PCI class code values when converted back to a string */ 1346 1347 #define ACPI_PCICLS_STRING_SIZE 7 /* Includes null terminator */ 1348 1349 1350 /* Structures used for device/processor HID, UID, CID */ 1351 1352 typedef struct acpi_pnp_device_id 1353 { 1354 UINT32 Length; /* Length of string + null */ 1355 char *String; 1356 1357 } ACPI_PNP_DEVICE_ID; 1358 1359 typedef struct acpi_pnp_device_id_list 1360 { 1361 UINT32 Count; /* Number of IDs in Ids array */ 1362 UINT32 ListSize; /* Size of list, including ID strings */ 1363 ACPI_PNP_DEVICE_ID Ids[1]; /* ID array */ 1364 1365 } ACPI_PNP_DEVICE_ID_LIST; 1366 1367 /* 1368 * Structure returned from AcpiGetObjectInfo. 1369 * Optimized for both 32-bit and 64-bit builds. 1370 */ 1371 typedef struct acpi_device_info 1372 { 1373 UINT32 InfoSize; /* Size of info, including ID strings */ 1374 UINT32 Name; /* ACPI object Name */ 1375 ACPI_OBJECT_TYPE Type; /* ACPI object Type */ 1376 UINT8 ParamCount; /* If a method, required parameter count */ 1377 UINT16 Valid; /* Indicates which optional fields are valid */ 1378 UINT8 Flags; /* Miscellaneous info */ 1379 UINT8 HighestDstates[4]; /* _SxD values: 0xFF indicates not valid */ 1380 UINT8 LowestDstates[5]; /* _SxW values: 0xFF indicates not valid */ 1381 UINT32 CurrentStatus; /* _STA value */ 1382 UINT64 Address; /* _ADR value */ 1383 ACPI_PNP_DEVICE_ID HardwareId; /* _HID value */ 1384 ACPI_PNP_DEVICE_ID UniqueId; /* _UID value */ 1385 ACPI_PNP_DEVICE_ID ClassCode; /* _CLS value */ 1386 ACPI_PNP_DEVICE_ID_LIST CompatibleIdList; /* _CID list <must be last> */ 1387 1388 } ACPI_DEVICE_INFO; 1389 1390 /* Values for Flags field above (AcpiGetObjectInfo) */ 1391 1392 #define ACPI_PCI_ROOT_BRIDGE 0x01 1393 1394 /* Flags for Valid field above (AcpiGetObjectInfo) */ 1395 1396 #define ACPI_VALID_STA 0x0001 1397 #define ACPI_VALID_ADR 0x0002 1398 #define ACPI_VALID_HID 0x0004 1399 #define ACPI_VALID_UID 0x0008 1400 #define ACPI_VALID_CID 0x0020 1401 #define ACPI_VALID_CLS 0x0040 1402 #define ACPI_VALID_SXDS 0x0100 1403 #define ACPI_VALID_SXWS 0x0200 1404 1405 /* Flags for _STA method */ 1406 1407 #define ACPI_STA_DEVICE_PRESENT 0x01 1408 #define ACPI_STA_DEVICE_ENABLED 0x02 1409 #define ACPI_STA_DEVICE_UI 0x04 1410 #define ACPI_STA_DEVICE_FUNCTIONING 0x08 1411 #define ACPI_STA_DEVICE_OK 0x08 /* Synonym */ 1412 #define ACPI_STA_BATTERY_PRESENT 0x10 1413 1414 1415 /* Context structs for address space handlers */ 1416 1417 typedef struct acpi_pci_id 1418 { 1419 UINT16 Segment; 1420 UINT16 Bus; 1421 UINT16 Device; 1422 UINT16 Function; 1423 1424 } ACPI_PCI_ID; 1425 1426 typedef struct acpi_mem_space_context 1427 { 1428 UINT32 Length; 1429 ACPI_PHYSICAL_ADDRESS Address; 1430 ACPI_PHYSICAL_ADDRESS MappedPhysicalAddress; 1431 UINT8 *MappedLogicalAddress; 1432 ACPI_SIZE MappedLength; 1433 1434 } ACPI_MEM_SPACE_CONTEXT; 1435 1436 1437 /* 1438 * ACPI_MEMORY_LIST is used only if the ACPICA local cache is enabled 1439 */ 1440 typedef struct acpi_memory_list 1441 { 1442 const char *ListName; 1443 void *ListHead; 1444 UINT16 ObjectSize; 1445 UINT16 MaxDepth; 1446 UINT16 CurrentDepth; 1447 1448 #ifdef ACPI_DBG_TRACK_ALLOCATIONS 1449 1450 /* Statistics for debug memory tracking only */ 1451 1452 UINT32 TotalAllocated; 1453 UINT32 TotalFreed; 1454 UINT32 MaxOccupied; 1455 UINT32 TotalSize; 1456 UINT32 CurrentTotalSize; 1457 UINT32 Requests; 1458 UINT32 Hits; 1459 #endif 1460 1461 } ACPI_MEMORY_LIST; 1462 1463 1464 /* Definitions of trace event types */ 1465 1466 typedef enum 1467 { 1468 ACPI_TRACE_AML_METHOD, 1469 ACPI_TRACE_AML_OPCODE, 1470 ACPI_TRACE_AML_REGION 1471 1472 } ACPI_TRACE_EVENT_TYPE; 1473 1474 1475 /* Definitions of _OSI support */ 1476 1477 #define ACPI_VENDOR_STRINGS 0x01 1478 #define ACPI_FEATURE_STRINGS 0x02 1479 #define ACPI_ENABLE_INTERFACES 0x00 1480 #define ACPI_DISABLE_INTERFACES 0x04 1481 1482 #define ACPI_DISABLE_ALL_VENDOR_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS) 1483 #define ACPI_DISABLE_ALL_FEATURE_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_FEATURE_STRINGS) 1484 #define ACPI_DISABLE_ALL_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS) 1485 #define ACPI_ENABLE_ALL_VENDOR_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS) 1486 #define ACPI_ENABLE_ALL_FEATURE_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_FEATURE_STRINGS) 1487 #define ACPI_ENABLE_ALL_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS) 1488 1489 #define ACPI_OSI_WIN_2000 0x01 1490 #define ACPI_OSI_WIN_XP 0x02 1491 #define ACPI_OSI_WIN_XP_SP1 0x03 1492 #define ACPI_OSI_WINSRV_2003 0x04 1493 #define ACPI_OSI_WIN_XP_SP2 0x05 1494 #define ACPI_OSI_WINSRV_2003_SP1 0x06 1495 #define ACPI_OSI_WIN_VISTA 0x07 1496 #define ACPI_OSI_WINSRV_2008 0x08 1497 #define ACPI_OSI_WIN_VISTA_SP1 0x09 1498 #define ACPI_OSI_WIN_VISTA_SP2 0x0A 1499 #define ACPI_OSI_WIN_7 0x0B 1500 #define ACPI_OSI_WIN_8 0x0C 1501 #define ACPI_OSI_WIN_10 0x0D 1502 1503 1504 /* Definitions of getopt */ 1505 1506 #define ACPI_OPT_END -1 1507 1508 1509 #endif /* __ACTYPES_H__ */ 1510