Linux Audio

Check our new training course

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