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