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