include/acpi/actypes.h

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