LXR linux/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 - 2012, 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
 126typedef unsigned char BOOLEAN;
 127typedef unsigned char UINT8;
 128typedef unsigned short UINT16;
 129typedef COMPILER_DEPENDENT_UINT64 UINT64;
 130typedef 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
 154typedef unsigned int UINT32;
 155typedef int INT32;
 156
 157/*! [End] no source code translation !*/
 158
 159typedef s64 acpi_native_int;
 160
 161typedef u64 acpi_size;
 162typedef u64 acpi_io_address;
 163typedef 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: EM64T 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
 193typedef unsigned int UINT32;
 194typedef int INT32;
 195
 196/*! [End] no source code translation !*/
 197
 198typedef s32 acpi_native_int;
 199
 200typedef u32 acpi_size;
 201typedef u32 acpi_io_address;
 202typedef u32 acpi_physical_address;
 203
 204#define ACPI_MAX_PTR                    ACPI_UINT32_MAX
 205#define ACPI_SIZE_MAX                   ACPI_UINT32_MAX
 206
 207#else
 208
 209/* ACPI_MACHINE_WIDTH must be either 64 or 32 */
 210
 211#error unknown ACPI_MACHINE_WIDTH
 212#endif
 213
 214/*******************************************************************************
 215 *
 216 * OS-dependent types
 217 *
 218 * If the defaults below are not appropriate for the host system, they can
 219 * be defined in the OS-specific header, and this will take precedence.
 220 *
 221 ******************************************************************************/
 222
 223/* Flags for acpi_os_acquire_lock/acpi_os_release_lock */
 224
 225#ifndef acpi_cpu_flags
 226#define acpi_cpu_flags                  acpi_size
 227#endif
 228
 229/* Object returned from acpi_os_create_cache */
 230
 231#ifndef acpi_cache_t
 232#ifdef ACPI_USE_LOCAL_CACHE
 233#define acpi_cache_t                    struct acpi_memory_list
 234#else
 235#define acpi_cache_t                    void *
 236#endif
 237#endif
 238
 239/*
 240 * Synchronization objects - Mutexes, Semaphores, and spin_locks
 241 */
 242#if (ACPI_MUTEX_TYPE == ACPI_BINARY_SEMAPHORE)
 243/*
 244 * These macros are used if the host OS does not support a mutex object.
 245 * Map the OSL Mutex interfaces to binary semaphores.
 246 */
 247#define acpi_mutex                      acpi_semaphore
 248#define acpi_os_create_mutex(out_handle) acpi_os_create_semaphore (1, 1, out_handle)
 249#define acpi_os_delete_mutex(handle)    (void) acpi_os_delete_semaphore (handle)
 250#define acpi_os_acquire_mutex(handle,time) acpi_os_wait_semaphore (handle, 1, time)
 251#define acpi_os_release_mutex(handle)   (void) acpi_os_signal_semaphore (handle, 1)
 252#endif
 253
 254/* Configurable types for synchronization objects */
 255
 256#ifndef acpi_spinlock
 257#define acpi_spinlock                   void *
 258#endif
 259
 260#ifndef acpi_semaphore
 261#define acpi_semaphore                  void *
 262#endif
 263
 264#ifndef acpi_mutex
 265#define acpi_mutex                      void *
 266#endif
 267
 268/*******************************************************************************
 269 *
 270 * Compiler-dependent types
 271 *
 272 * If the defaults below are not appropriate for the host compiler, they can
 273 * be defined in the compiler-specific header, and this will take precedence.
 274 *
 275 ******************************************************************************/
 276
 277/* Use C99 uintptr_t for pointer casting if available, "void *" otherwise */
 278
 279#ifndef acpi_uintptr_t
 280#define acpi_uintptr_t                  void *
 281#endif
 282
 283/*
 284 * ACPI_PRINTF_LIKE is used to tag functions as "printf-like" because
 285 * some compilers can catch printf format string problems
 286 */
 287#ifndef ACPI_PRINTF_LIKE
 288#define ACPI_PRINTF_LIKE(c)
 289#endif
 290
 291/*
 292 * Some compilers complain about unused variables. Sometimes we don't want to
 293 * use all the variables (for example, _acpi_module_name). This allows us
 294 * to tell the compiler in a per-variable manner that a variable
 295 * is unused
 296 */
 297#ifndef ACPI_UNUSED_VAR
 298#define ACPI_UNUSED_VAR
 299#endif
 300
 301/*
 302 * All ACPICA functions that are available to the rest of the kernel are
 303 * tagged with this macro which can be defined as appropriate for the host.
 304 */
 305#ifndef ACPI_EXPORT_SYMBOL
 306#define ACPI_EXPORT_SYMBOL(symbol)
 307#endif
 308
 309/******************************************************************************
 310 *
 311 * ACPI Specification constants (Do not change unless the specification changes)
 312 *
 313 *****************************************************************************/
 314
 315/* Number of distinct FADT-based GPE register blocks (GPE0 and GPE1) */
 316
 317#define ACPI_MAX_GPE_BLOCKS             2
 318
 319/* Default ACPI register widths */
 320
 321#define ACPI_GPE_REGISTER_WIDTH         8
 322#define ACPI_PM1_REGISTER_WIDTH         16
 323#define ACPI_PM2_REGISTER_WIDTH         8
 324#define ACPI_PM_TIMER_WIDTH             32
 325
 326/* Names within the namespace are 4 bytes long */
 327
 328#define ACPI_NAME_SIZE                  4
 329#define ACPI_PATH_SEGMENT_LENGTH        5       /* 4 chars for name + 1 char for separator */
 330#define ACPI_PATH_SEPARATOR             '.'
 331
 332/* Sizes for ACPI table headers */
 333
 334#define ACPI_OEM_ID_SIZE                6
 335#define ACPI_OEM_TABLE_ID_SIZE          8
 336
 337/* ACPI/PNP hardware IDs */
 338
 339#define PCI_ROOT_HID_STRING             "PNP0A03"
 340#define PCI_EXPRESS_ROOT_HID_STRING     "PNP0A08"
 341
 342/* PM Timer ticks per second (HZ) */
 343
 344#define PM_TIMER_FREQUENCY              3579545
 345
 346/*******************************************************************************
 347 *
 348 * Independent types
 349 *
 350 ******************************************************************************/
 351
 352/* Logical defines and NULL */
 353
 354#ifdef FALSE
 355#undef FALSE
 356#endif
 357#define FALSE                           (1 == 0)
 358
 359#ifdef TRUE
 360#undef TRUE
 361#endif
 362#define TRUE                            (1 == 1)
 363
 364#ifndef NULL
 365#define NULL                            (void *) 0
 366#endif
 367
 368/*
 369 * Miscellaneous types
 370 */
 371typedef u32 acpi_status;        /* All ACPI Exceptions */
 372typedef u32 acpi_name;          /* 4-byte ACPI name */
 373typedef char *acpi_string;      /* Null terminated ASCII string */
 374typedef void *acpi_handle;      /* Actually a ptr to a NS Node */
 375
 376/* Owner IDs are used to track namespace nodes for selective deletion */
 377
 378typedef u8 acpi_owner_id;
 379#define ACPI_OWNER_ID_MAX               0xFF
 380
 381#define ACPI_INTEGER_BIT_SIZE           64
 382#define ACPI_MAX_DECIMAL_DIGITS         20      /* 2^64 = 18,446,744,073,709,551,616 */
 383
 384#if ACPI_MACHINE_WIDTH == 64
 385#define ACPI_USE_NATIVE_DIVIDE  /* Use compiler native 64-bit divide */
 386#endif
 387
 388#define ACPI_MAX64_DECIMAL_DIGITS       20
 389#define ACPI_MAX32_DECIMAL_DIGITS       10
 390#define ACPI_MAX16_DECIMAL_DIGITS        5
 391#define ACPI_MAX8_DECIMAL_DIGITS         3
 392
 393/* PM Timer ticks per second (HZ) */
 394
 395#define PM_TIMER_FREQUENCY  3579545
 396
 397/*
 398 * Constants with special meanings
 399 */
 400#define ACPI_ROOT_OBJECT                ACPI_ADD_PTR (acpi_handle, NULL, ACPI_MAX_PTR)
 401#define ACPI_WAIT_FOREVER               0xFFFF  /* u16, as per ACPI spec */
 402#define ACPI_DO_NOT_WAIT                0
 403
 404/*
 405 * Obsolete: Acpi integer width. In ACPI version 1 (1996), integers are 32 bits.
 406 * In ACPI version 2 (2000) and later, integers are 64 bits. Note that this
 407 * pertains to the ACPI integer type only, not to other integers used in the
 408 * implementation of the ACPICA subsystem.
 409 *
 410 * 01/2010: This type is obsolete and has been removed from the entire ACPICA
 411 * code base. It remains here for compatibility with device drivers that use
 412 * the type. However, it will be removed in the future.
 413 */
 414typedef u64 acpi_integer;
 415#define ACPI_INTEGER_MAX                ACPI_UINT64_MAX
 416
 417/*******************************************************************************
 418 *
 419 * Commonly used macros
 420 *
 421 ******************************************************************************/
 422
 423/* Data manipulation */
 424
 425#define ACPI_LOBYTE(integer)            ((u8)   (u16)(integer))
 426#define ACPI_HIBYTE(integer)            ((u8) (((u16)(integer)) >> 8))
 427#define ACPI_LOWORD(integer)            ((u16)  (u32)(integer))
 428#define ACPI_HIWORD(integer)            ((u16)(((u32)(integer)) >> 16))
 429#define ACPI_LODWORD(integer64)         ((u32)  (u64)(integer64))
 430#define ACPI_HIDWORD(integer64)         ((u32)(((u64)(integer64)) >> 32))
 431
 432#define ACPI_SET_BIT(target,bit)        ((target) |= (bit))
 433#define ACPI_CLEAR_BIT(target,bit)      ((target) &= ~(bit))
 434#define ACPI_MIN(a,b)                   (((a)<(b))?(a):(b))
 435#define ACPI_MAX(a,b)                   (((a)>(b))?(a):(b))
 436
 437/* Size calculation */
 438
 439#define ACPI_ARRAY_LENGTH(x)            (sizeof(x) / sizeof((x)[0]))
 440
 441/* Pointer manipulation */
 442
 443#define ACPI_CAST_PTR(t, p)             ((t *) (acpi_uintptr_t) (p))
 444#define ACPI_CAST_INDIRECT_PTR(t, p)    ((t **) (acpi_uintptr_t) (p))
 445#define ACPI_ADD_PTR(t, a, b)           ACPI_CAST_PTR (t, (ACPI_CAST_PTR (u8, (a)) + (acpi_size)(b)))
 446#define ACPI_PTR_DIFF(a, b)             (acpi_size) (ACPI_CAST_PTR (u8, (a)) - ACPI_CAST_PTR (u8, (b)))
 447
 448/* Pointer/Integer type conversions */
 449
 450#define ACPI_TO_POINTER(i)              ACPI_ADD_PTR (void, (void *) NULL,(acpi_size) i)
 451#define ACPI_TO_INTEGER(p)              ACPI_PTR_DIFF (p, (void *) NULL)
 452#define ACPI_OFFSET(d, f)               (acpi_size) ACPI_PTR_DIFF (&(((d *)0)->f), (void *) NULL)
 453#define ACPI_PHYSADDR_TO_PTR(i)         ACPI_TO_POINTER(i)
 454#define ACPI_PTR_TO_PHYSADDR(i)         ACPI_TO_INTEGER(i)
 455
 456#ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
 457#define ACPI_COMPARE_NAME(a,b)          (*ACPI_CAST_PTR (u32, (a)) == *ACPI_CAST_PTR (u32, (b)))
 458#else
 459#define ACPI_COMPARE_NAME(a,b)          (!ACPI_STRNCMP (ACPI_CAST_PTR (char, (a)), ACPI_CAST_PTR (char, (b)), ACPI_NAME_SIZE))
 460#endif
 461
 462/*******************************************************************************
 463 *
 464 * Miscellaneous constants
 465 *
 466 ******************************************************************************/
 467
 468/*
 469 * Initialization sequence
 470 */
 471#define ACPI_FULL_INITIALIZATION        0x00
 472#define ACPI_NO_ADDRESS_SPACE_INIT      0x01
 473#define ACPI_NO_EVENT_INIT              0x04
 474#define ACPI_NO_HANDLER_INIT            0x08
 475#define ACPI_NO_ACPI_ENABLE             0x10
 476#define ACPI_NO_DEVICE_INIT             0x20
 477#define ACPI_NO_OBJECT_INIT             0x40
 478
 479/*
 480 * Initialization state
 481 */
 482#define ACPI_SUBSYSTEM_INITIALIZE       0x01
 483#define ACPI_INITIALIZED_OK             0x02
 484
 485/*
 486 * Power state values
 487 */
 488#define ACPI_STATE_UNKNOWN              (u8) 0xFF
 489
 490#define ACPI_STATE_S0                   (u8) 0
 491#define ACPI_STATE_S1                   (u8) 1
 492#define ACPI_STATE_S2                   (u8) 2
 493#define ACPI_STATE_S3                   (u8) 3
 494#define ACPI_STATE_S4                   (u8) 4
 495#define ACPI_STATE_S5                   (u8) 5
 496#define ACPI_S_STATES_MAX               ACPI_STATE_S5
 497#define ACPI_S_STATE_COUNT              6
 498
 499#define ACPI_STATE_D0                   (u8) 0
 500#define ACPI_STATE_D1                   (u8) 1
 501#define ACPI_STATE_D2                   (u8) 2
 502#define ACPI_STATE_D3_HOT               (u8) 3
 503#define ACPI_STATE_D3                   (u8) 4
 504#define ACPI_STATE_D3_COLD              ACPI_STATE_D3
 505#define ACPI_D_STATES_MAX               ACPI_STATE_D3
 506#define ACPI_D_STATE_COUNT              5
 507
 508#define ACPI_STATE_C0                   (u8) 0
 509#define ACPI_STATE_C1                   (u8) 1
 510#define ACPI_STATE_C2                   (u8) 2
 511#define ACPI_STATE_C3                   (u8) 3
 512#define ACPI_C_STATES_MAX               ACPI_STATE_C3
 513#define ACPI_C_STATE_COUNT              4
 514
 515/*
 516 * Sleep type invalid value
 517 */
 518#define ACPI_SLEEP_TYPE_MAX             0x7
 519#define ACPI_SLEEP_TYPE_INVALID         0xFF
 520
 521/*
 522 * Sleep/Wake flags
 523 */
 524#define ACPI_NO_OPTIONAL_METHODS        0x00    /* Do not execute any optional methods */
 525#define ACPI_EXECUTE_GTS                0x01    /* For enter sleep interface */
 526#define ACPI_EXECUTE_BFS                0x02    /* For leave sleep prep interface */
 527
 528/*
 529 * Standard notify values
 530 */
 531#define ACPI_NOTIFY_BUS_CHECK           (u8) 0x00
 532#define ACPI_NOTIFY_DEVICE_CHECK        (u8) 0x01
 533#define ACPI_NOTIFY_DEVICE_WAKE         (u8) 0x02
 534#define ACPI_NOTIFY_EJECT_REQUEST       (u8) 0x03
 535#define ACPI_NOTIFY_DEVICE_CHECK_LIGHT  (u8) 0x04
 536#define ACPI_NOTIFY_FREQUENCY_MISMATCH  (u8) 0x05
 537#define ACPI_NOTIFY_BUS_MODE_MISMATCH   (u8) 0x06
 538#define ACPI_NOTIFY_POWER_FAULT         (u8) 0x07
 539#define ACPI_NOTIFY_CAPABILITIES_CHECK  (u8) 0x08
 540#define ACPI_NOTIFY_DEVICE_PLD_CHECK    (u8) 0x09
 541#define ACPI_NOTIFY_RESERVED            (u8) 0x0A
 542#define ACPI_NOTIFY_LOCALITY_UPDATE     (u8) 0x0B
 543#define ACPI_NOTIFY_SHUTDOWN_REQUEST    (u8) 0x0C
 544
 545#define ACPI_NOTIFY_MAX                 0x0C
 546
 547/*
 548 * Types associated with ACPI names and objects. The first group of
 549 * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
 550 * of the ACPI object_type() operator (See the ACPI Spec). Therefore,
 551 * only add to the first group if the spec changes.
 552 *
 553 * NOTE: Types must be kept in sync with the global acpi_ns_properties
 554 * and acpi_ns_type_names arrays.
 555 */
 556typedef u32 acpi_object_type;
 557
 558#define ACPI_TYPE_ANY                   0x00
 559#define ACPI_TYPE_INTEGER               0x01    /* Byte/Word/Dword/Zero/One/Ones */
 560#define ACPI_TYPE_STRING                0x02
 561#define ACPI_TYPE_BUFFER                0x03
 562#define ACPI_TYPE_PACKAGE               0x04    /* byte_const, multiple data_term/Constant/super_name */
 563#define ACPI_TYPE_FIELD_UNIT            0x05
 564#define ACPI_TYPE_DEVICE                0x06    /* Name, multiple Node */
 565#define ACPI_TYPE_EVENT                 0x07
 566#define ACPI_TYPE_METHOD                0x08    /* Name, byte_const, multiple Code */
 567#define ACPI_TYPE_MUTEX                 0x09
 568#define ACPI_TYPE_REGION                0x0A
 569#define ACPI_TYPE_POWER                 0x0B    /* Name,byte_const,word_const,multi Node */
 570#define ACPI_TYPE_PROCESSOR             0x0C    /* Name,byte_const,Dword_const,byte_const,multi nm_o */
 571#define ACPI_TYPE_THERMAL               0x0D    /* Name, multiple Node */
 572#define ACPI_TYPE_BUFFER_FIELD          0x0E
 573#define ACPI_TYPE_DDB_HANDLE            0x0F
 574#define ACPI_TYPE_DEBUG_OBJECT          0x10
 575
 576#define ACPI_TYPE_EXTERNAL_MAX          0x10
 577
 578/*
 579 * These are object types that do not map directly to the ACPI
 580 * object_type() operator. They are used for various internal purposes only.
 581 * If new predefined ACPI_TYPEs are added (via the ACPI specification), these
 582 * internal types must move upwards. (There is code that depends on these
 583 * values being contiguous with the external types above.)
 584 */
 585#define ACPI_TYPE_LOCAL_REGION_FIELD    0x11
 586#define ACPI_TYPE_LOCAL_BANK_FIELD      0x12
 587#define ACPI_TYPE_LOCAL_INDEX_FIELD     0x13
 588#define ACPI_TYPE_LOCAL_REFERENCE       0x14    /* Arg#, Local#, Name, Debug, ref_of, Index */
 589#define ACPI_TYPE_LOCAL_ALIAS           0x15
 590#define ACPI_TYPE_LOCAL_METHOD_ALIAS    0x16
 591#define ACPI_TYPE_LOCAL_NOTIFY          0x17
 592#define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
 593#define ACPI_TYPE_LOCAL_RESOURCE        0x19
 594#define ACPI_TYPE_LOCAL_RESOURCE_FIELD  0x1A
 595#define ACPI_TYPE_LOCAL_SCOPE           0x1B    /* 1 Name, multiple object_list Nodes */
 596
 597#define ACPI_TYPE_NS_NODE_MAX           0x1B    /* Last typecode used within a NS Node */
 598
 599/*
 600 * These are special object types that never appear in
 601 * a Namespace node, only in a union acpi_operand_object
 602 */
 603#define ACPI_TYPE_LOCAL_EXTRA           0x1C
 604#define ACPI_TYPE_LOCAL_DATA            0x1D
 605
 606#define ACPI_TYPE_LOCAL_MAX             0x1D
 607
 608/* All types above here are invalid */
 609
 610#define ACPI_TYPE_INVALID               0x1E
 611#define ACPI_TYPE_NOT_FOUND             0xFF
 612
 613#define ACPI_NUM_NS_TYPES               (ACPI_TYPE_INVALID + 1)
 614
 615/*
 616 * All I/O
 617 */
 618#define ACPI_READ                       0
 619#define ACPI_WRITE                      1
 620#define ACPI_IO_MASK                    1
 621
 622/*
 623 * Event Types: Fixed & General Purpose
 624 */
 625typedef u32 acpi_event_type;
 626
 627/*
 628 * Fixed events
 629 */
 630#define ACPI_EVENT_PMTIMER              0
 631#define ACPI_EVENT_GLOBAL               1
 632#define ACPI_EVENT_POWER_BUTTON         2
 633#define ACPI_EVENT_SLEEP_BUTTON         3
 634#define ACPI_EVENT_RTC                  4
 635#define ACPI_EVENT_MAX                  4
 636#define ACPI_NUM_FIXED_EVENTS           ACPI_EVENT_MAX + 1
 637
 638/*
 639 * Event status - Per event
 640 * -------------
 641 * The encoding of acpi_event_status is illustrated below.
 642 * Note that a set bit (1) indicates the property is TRUE
 643 * (e.g. if bit 0 is set then the event is enabled).
 644 * +-------------+-+-+-+
 645 * |   Bits 31:3 |2|1|0|
 646 * +-------------+-+-+-+
 647 *          |     | | |
 648 *          |     | | +- Enabled?
 649 *          |     | +--- Enabled for wake?
 650 *          |     +----- Set?
 651 *          +----------- <Reserved>
 652 */
 653typedef u32 acpi_event_status;
 654
 655#define ACPI_EVENT_FLAG_DISABLED        (acpi_event_status) 0x00
 656#define ACPI_EVENT_FLAG_ENABLED         (acpi_event_status) 0x01
 657#define ACPI_EVENT_FLAG_WAKE_ENABLED    (acpi_event_status) 0x02
 658#define ACPI_EVENT_FLAG_SET             (acpi_event_status) 0x04
 659#define ACPI_EVENT_FLAG_HANDLE          (acpi_event_status) 0x08
 660
 661/*
 662 * General Purpose Events (GPE)
 663 */
 664#define ACPI_GPE_INVALID                0xFF
 665#define ACPI_GPE_MAX                    0xFF
 666#define ACPI_NUM_GPE                    256
 667
 668/* Actions for acpi_set_gpe_wake_mask, acpi_hw_low_set_gpe */
 669
 670#define ACPI_GPE_ENABLE                 0
 671#define ACPI_GPE_DISABLE                1
 672#define ACPI_GPE_CONDITIONAL_ENABLE     2
 673
 674/*
 675 * GPE info flags - Per GPE
 676 * +-------+-+-+---+
 677 * |  7:4  |3|2|1:0|
 678 * +-------+-+-+---+
 679 *     |    | |  |
 680 *     |    | |  +-- Type of dispatch:to method, handler, notify, or none
 681 *     |    | +----- Interrupt type: edge or level triggered
 682 *     |    +------- Is a Wake GPE
 683 *     +------------ <Reserved>
 684 */
 685#define ACPI_GPE_DISPATCH_NONE          (u8) 0x00
 686#define ACPI_GPE_DISPATCH_METHOD        (u8) 0x01
 687#define ACPI_GPE_DISPATCH_HANDLER       (u8) 0x02
 688#define ACPI_GPE_DISPATCH_NOTIFY        (u8) 0x03
 689#define ACPI_GPE_DISPATCH_MASK          (u8) 0x03
 690
 691#define ACPI_GPE_LEVEL_TRIGGERED        (u8) 0x04
 692#define ACPI_GPE_EDGE_TRIGGERED         (u8) 0x00
 693#define ACPI_GPE_XRUPT_TYPE_MASK        (u8) 0x04
 694
 695#define ACPI_GPE_CAN_WAKE               (u8) 0x08
 696
 697/*
 698 * Flags for GPE and Lock interfaces
 699 */
 700#define ACPI_NOT_ISR                    0x1
 701#define ACPI_ISR                        0x0
 702
 703/* Notify types */
 704
 705#define ACPI_SYSTEM_NOTIFY              0x1
 706#define ACPI_DEVICE_NOTIFY              0x2
 707#define ACPI_ALL_NOTIFY                 (ACPI_SYSTEM_NOTIFY | ACPI_DEVICE_NOTIFY)
 708#define ACPI_MAX_NOTIFY_HANDLER_TYPE    0x3
 709#define ACPI_NUM_NOTIFY_TYPES           2
 710
 711#define ACPI_MAX_SYS_NOTIFY             0x7F
 712#define ACPI_MAX_DEVICE_SPECIFIC_NOTIFY 0xBF
 713
 714#define ACPI_SYSTEM_HANDLER_LIST        0       /* Used as index, must be SYSTEM_NOTIFY -1 */
 715#define ACPI_DEVICE_HANDLER_LIST        1       /* Used as index, must be DEVICE_NOTIFY -1 */
 716
 717/* Address Space (Operation Region) Types */
 718
 719typedef u8 acpi_adr_space_type;
 720
 721#define ACPI_ADR_SPACE_SYSTEM_MEMORY    (acpi_adr_space_type) 0
 722#define ACPI_ADR_SPACE_SYSTEM_IO        (acpi_adr_space_type) 1
 723#define ACPI_ADR_SPACE_PCI_CONFIG       (acpi_adr_space_type) 2
 724#define ACPI_ADR_SPACE_EC               (acpi_adr_space_type) 3
 725#define ACPI_ADR_SPACE_SMBUS            (acpi_adr_space_type) 4
 726#define ACPI_ADR_SPACE_CMOS             (acpi_adr_space_type) 5
 727#define ACPI_ADR_SPACE_PCI_BAR_TARGET   (acpi_adr_space_type) 6
 728#define ACPI_ADR_SPACE_IPMI             (acpi_adr_space_type) 7
 729#define ACPI_ADR_SPACE_GPIO             (acpi_adr_space_type) 8
 730#define ACPI_ADR_SPACE_GSBUS            (acpi_adr_space_type) 9
 731#define ACPI_ADR_SPACE_PLATFORM_COMM    (acpi_adr_space_type) 10
 732
 733#define ACPI_NUM_PREDEFINED_REGIONS     11
 734
 735/*
 736 * Special Address Spaces
 737 *
 738 * Note: A Data Table region is a special type of operation region
 739 * that has its own AML opcode. However, internally, the AML
 740 * interpreter simply creates an operation region with an an address
 741 * space type of ACPI_ADR_SPACE_DATA_TABLE.
 742 */
 743#define ACPI_ADR_SPACE_DATA_TABLE       (acpi_adr_space_type) 0x7E      /* Internal to ACPICA only */
 744#define ACPI_ADR_SPACE_FIXED_HARDWARE   (acpi_adr_space_type) 0x7F
 745
 746/* Values for _REG connection code */
 747
 748#define ACPI_REG_DISCONNECT             0
 749#define ACPI_REG_CONNECT                1
 750
 751/*
 752 * bit_register IDs
 753 *
 754 * These values are intended to be used by the hardware interfaces
 755 * and are mapped to individual bitfields defined within the ACPI
 756 * registers. See the acpi_gbl_bit_register_info global table in utglobal.c
 757 * for this mapping.
 758 */
 759
 760/* PM1 Status register */
 761
 762#define ACPI_BITREG_TIMER_STATUS                0x00
 763#define ACPI_BITREG_BUS_MASTER_STATUS           0x01
 764#define ACPI_BITREG_GLOBAL_LOCK_STATUS          0x02
 765#define ACPI_BITREG_POWER_BUTTON_STATUS         0x03
 766#define ACPI_BITREG_SLEEP_BUTTON_STATUS         0x04
 767#define ACPI_BITREG_RT_CLOCK_STATUS             0x05
 768#define ACPI_BITREG_WAKE_STATUS                 0x06
 769#define ACPI_BITREG_PCIEXP_WAKE_STATUS          0x07
 770
 771/* PM1 Enable register */
 772
 773#define ACPI_BITREG_TIMER_ENABLE                0x08
 774#define ACPI_BITREG_GLOBAL_LOCK_ENABLE          0x09
 775#define ACPI_BITREG_POWER_BUTTON_ENABLE         0x0A
 776#define ACPI_BITREG_SLEEP_BUTTON_ENABLE         0x0B
 777#define ACPI_BITREG_RT_CLOCK_ENABLE             0x0C
 778#define ACPI_BITREG_PCIEXP_WAKE_DISABLE         0x0D
 779
 780/* PM1 Control register */
 781
 782#define ACPI_BITREG_SCI_ENABLE                  0x0E
 783#define ACPI_BITREG_BUS_MASTER_RLD              0x0F
 784#define ACPI_BITREG_GLOBAL_LOCK_RELEASE         0x10
 785#define ACPI_BITREG_SLEEP_TYPE                  0x11
 786#define ACPI_BITREG_SLEEP_ENABLE                0x12
 787
 788/* PM2 Control register */
 789
 790#define ACPI_BITREG_ARB_DISABLE                 0x13
 791
 792#define ACPI_BITREG_MAX                         0x13
 793#define ACPI_NUM_BITREG                         ACPI_BITREG_MAX + 1
 794
 795/* Status register values. A 1 clears a status bit. 0 = no effect */
 796
 797#define ACPI_CLEAR_STATUS                       1
 798
 799/* Enable and Control register values */
 800
 801#define ACPI_ENABLE_EVENT                       1
 802#define ACPI_DISABLE_EVENT                      0
 803
 804/* Sleep function dispatch */
 805
 806typedef acpi_status(*ACPI_SLEEP_FUNCTION) (u8 sleep_state);
 807
 808struct acpi_sleep_functions {
 809        ACPI_SLEEP_FUNCTION legacy_function;
 810        ACPI_SLEEP_FUNCTION extended_function;
 811};
 812
 813/*
 814 * External ACPI object definition
 815 */
 816
 817/*
 818 * Note: Type == ACPI_TYPE_ANY (0) is used to indicate a NULL package element
 819 * or an unresolved named reference.
 820 */
 821union acpi_object {
 822        acpi_object_type type;  /* See definition of acpi_ns_type for values */
 823        struct {
 824                acpi_object_type type;  /* ACPI_TYPE_INTEGER */
 825                u64 value;      /* The actual number */
 826        } integer;
 827
 828        struct {
 829                acpi_object_type type;  /* ACPI_TYPE_STRING */
 830                u32 length;     /* # of bytes in string, excluding trailing null */
 831                char *pointer;  /* points to the string value */
 832        } string;
 833
 834        struct {
 835                acpi_object_type type;  /* ACPI_TYPE_BUFFER */
 836                u32 length;     /* # of bytes in buffer */
 837                u8 *pointer;    /* points to the buffer */
 838        } buffer;
 839
 840        struct {
 841                acpi_object_type type;  /* ACPI_TYPE_PACKAGE */
 842                u32 count;      /* # of elements in package */
 843                union acpi_object *elements;    /* Pointer to an array of ACPI_OBJECTs */
 844        } package;
 845
 846        struct {
 847                acpi_object_type type;  /* ACPI_TYPE_LOCAL_REFERENCE */
 848                acpi_object_type actual_type;   /* Type associated with the Handle */
 849                acpi_handle handle;     /* object reference */
 850        } reference;
 851
 852        struct {
 853                acpi_object_type type;  /* ACPI_TYPE_PROCESSOR */
 854                u32 proc_id;
 855                acpi_io_address pblk_address;
 856                u32 pblk_length;
 857        } processor;
 858
 859        struct {
 860                acpi_object_type type;  /* ACPI_TYPE_POWER */
 861                u32 system_level;
 862                u32 resource_order;
 863        } power_resource;
 864};
 865
 866/*
 867 * List of objects, used as a parameter list for control method evaluation
 868 */
 869struct acpi_object_list {
 870        u32 count;
 871        union acpi_object *pointer;
 872};
 873
 874/*
 875 * Miscellaneous common Data Structures used by the interfaces
 876 */
 877#define ACPI_NO_BUFFER              0
 878#define ACPI_ALLOCATE_BUFFER        (acpi_size) (-1)
 879#define ACPI_ALLOCATE_LOCAL_BUFFER  (acpi_size) (-2)
 880
 881struct acpi_buffer {
 882        acpi_size length;       /* Length in bytes of the buffer */
 883        void *pointer;          /* pointer to buffer */
 884};
 885
 886/*
 887 * name_type for acpi_get_name
 888 */
 889#define ACPI_FULL_PATHNAME              0
 890#define ACPI_SINGLE_NAME                1
 891#define ACPI_NAME_TYPE_MAX              1
 892
 893/*
 894 * Predefined Namespace items
 895 */
 896struct acpi_predefined_names {
 897        char *name;
 898        u8 type;
 899        char *val;
 900};
 901
 902/*
 903 * Structure and flags for acpi_get_system_info
 904 */
 905#define ACPI_SYS_MODE_UNKNOWN           0x0000
 906#define ACPI_SYS_MODE_ACPI              0x0001
 907#define ACPI_SYS_MODE_LEGACY            0x0002
 908#define ACPI_SYS_MODES_MASK             0x0003
 909
 910/*
 911 * System info returned by acpi_get_system_info()
 912 */
 913struct acpi_system_info {
 914        u32 acpi_ca_version;
 915        u32 flags;
 916        u32 timer_resolution;
 917        u32 reserved1;
 918        u32 reserved2;
 919        u32 debug_level;
 920        u32 debug_layer;
 921};
 922
 923/* Table Event Types */
 924
 925#define ACPI_TABLE_EVENT_LOAD           0x0
 926#define ACPI_TABLE_EVENT_UNLOAD         0x1
 927#define ACPI_NUM_TABLE_EVENTS           2
 928
 929/*
 930 * Types specific to the OS service interfaces
 931 */
 932typedef u32(ACPI_SYSTEM_XFACE * acpi_osd_handler) (void *context);
 933
 934typedef void
 935 (ACPI_SYSTEM_XFACE * acpi_osd_exec_callback) (void *context);
 936
 937/*
 938 * Various handlers and callback procedures
 939 */
 940typedef
 941void (*ACPI_GBL_EVENT_HANDLER) (u32 event_type,
 942                               acpi_handle device,
 943                               u32 event_number, void *context);
 944
 945#define ACPI_EVENT_TYPE_GPE         0
 946#define ACPI_EVENT_TYPE_FIXED       1
 947
 948typedef u32(*acpi_event_handler) (void *context);
 949
 950typedef
 951u32 (*acpi_gpe_handler) (acpi_handle gpe_device, u32 gpe_number, void *context);
 952
 953typedef
 954void (*acpi_notify_handler) (acpi_handle device, u32 value, void *context);
 955
 956typedef
 957void (*acpi_object_handler) (acpi_handle object, void *data);
 958
 959typedef acpi_status(*acpi_init_handler) (acpi_handle object, u32 function);
 960
 961#define ACPI_INIT_DEVICE_INI        1
 962
 963typedef
 964acpi_status(*acpi_exception_handler) (acpi_status aml_status,
 965                                      acpi_name name,
 966                                      u16 opcode,
 967                                      u32 aml_offset, void *context);
 968
 969/* Table Event handler (Load, load_table, etc.) and types */
 970
 971typedef
 972acpi_status(*acpi_tbl_handler) (u32 event, void *table, void *context);
 973
 974/* Address Spaces (For Operation Regions) */
 975
 976typedef
 977acpi_status(*acpi_adr_space_handler) (u32 function,
 978                                      acpi_physical_address address,
 979                                      u32 bit_width,
 980                                      u64 *value,
 981                                      void *handler_context,
 982                                      void *region_context);
 983
 984#define ACPI_DEFAULT_HANDLER            NULL
 985
 986/* Special Context data for generic_serial_bus/general_purpose_io (ACPI 5.0) */
 987
 988struct acpi_connection_info {
 989        u8 *connection;
 990        u16 length;
 991        u8 access_length;
 992};
 993
 994typedef
 995acpi_status(*acpi_adr_space_setup) (acpi_handle region_handle,
 996                                    u32 function,
 997                                    void *handler_context,
 998                                    void **region_context);
 999
1000#define ACPI_REGION_ACTIVATE    0

1001#define ACPI_REGION_DEACTIVATE  1
1002
1003typedef
1004acpi_status(*acpi_walk_callback) (acpi_handle object,
1005                                  u32 nesting_level,
1006                                  void *context, void **return_value);
1007
1008typedef
1009u32 (*acpi_interface_handler) (acpi_string interface_name, u32 supported);
1010
1011/* Interrupt handler return values */
1012
1013#define ACPI_INTERRUPT_NOT_HANDLED      0x00
1014#define ACPI_INTERRUPT_HANDLED          0x01
1015
1016/* GPE handler return values */
1017
1018#define ACPI_REENABLE_GPE               0x80
1019
1020/* Length of 32-bit EISAID values when converted back to a string */
1021
1022#define ACPI_EISAID_STRING_SIZE         8       /* Includes null terminator */
1023
1024/* Length of UUID (string) values */
1025
1026#define ACPI_UUID_LENGTH                16
1027
1028/* Structures used for device/processor HID, UID, CID */
1029
1030struct acpica_device_id {
1031        u32 length;             /* Length of string + null */
1032        char *string;
1033};
1034
1035struct acpica_device_id_list {
1036        u32 count;              /* Number of IDs in Ids array */
1037        u32 list_size;          /* Size of list, including ID strings */
1038        struct acpica_device_id ids[1]; /* ID array */
1039};
1040
1041/*
1042 * Structure returned from acpi_get_object_info.
1043 * Optimized for both 32- and 64-bit builds
1044 */
1045struct acpi_device_info {
1046        u32 info_size;          /* Size of info, including ID strings */
1047        u32 name;               /* ACPI object Name */
1048        acpi_object_type type;  /* ACPI object Type */
1049        u8 param_count;         /* If a method, required parameter count */
1050        u8 valid;               /* Indicates which optional fields are valid */
1051        u8 flags;               /* Miscellaneous info */
1052        u8 highest_dstates[4];  /* _sx_d values: 0xFF indicates not valid */
1053        u8 lowest_dstates[5];   /* _sx_w values: 0xFF indicates not valid */
1054        u32 current_status;     /* _STA value */
1055        u64 address;    /* _ADR value */
1056        struct acpica_device_id hardware_id;    /* _HID value */
1057        struct acpica_device_id unique_id;      /* _UID value */
1058        struct acpica_device_id_list compatible_id_list;        /* _CID list <must be last> */
1059};
1060
1061/* Values for Flags field above (acpi_get_object_info) */
1062
1063#define ACPI_PCI_ROOT_BRIDGE            0x01
1064
1065/* Flags for Valid field above (acpi_get_object_info) */
1066
1067#define ACPI_VALID_STA                  0x01
1068#define ACPI_VALID_ADR                  0x02
1069#define ACPI_VALID_HID                  0x04
1070#define ACPI_VALID_UID                  0x08
1071#define ACPI_VALID_CID                  0x10
1072#define ACPI_VALID_SXDS                 0x20
1073#define ACPI_VALID_SXWS                 0x40
1074
1075/* Flags for _STA method */
1076
1077#define ACPI_STA_DEVICE_PRESENT         0x01
1078#define ACPI_STA_DEVICE_ENABLED         0x02
1079#define ACPI_STA_DEVICE_UI              0x04
1080#define ACPI_STA_DEVICE_FUNCTIONING     0x08
1081#define ACPI_STA_DEVICE_OK              0x08    /* Synonym */
1082#define ACPI_STA_BATTERY_PRESENT        0x10
1083
1084/* Context structs for address space handlers */
1085
1086struct acpi_pci_id {
1087        u16 segment;
1088        u16 bus;
1089        u16 device;
1090        u16 function;
1091};
1092
1093struct acpi_mem_space_context {
1094        u32 length;
1095        acpi_physical_address address;
1096        acpi_physical_address mapped_physical_address;
1097        u8 *mapped_logical_address;
1098        acpi_size mapped_length;
1099};
1100
1101/*
1102 * struct acpi_memory_list is used only if the ACPICA local cache is enabled
1103 */
1104struct acpi_memory_list {
1105        char *list_name;
1106        void *list_head;
1107        u16 object_size;
1108        u16 max_depth;
1109        u16 current_depth;
1110        u16 link_offset;
1111
1112#ifdef ACPI_DBG_TRACK_ALLOCATIONS
1113
1114        /* Statistics for debug memory tracking only */
1115
1116        u32 total_allocated;
1117        u32 total_freed;
1118        u32 max_occupied;
1119        u32 total_size;
1120        u32 current_total_size;
1121        u32 requests;
1122        u32 hits;
1123#endif
1124};
1125
1126#endif                          /* __ACTYPES_H__ */
1127