PageRenderTime 153ms CodeModel.GetById 26ms app.highlight 14ms RepoModel.GetById 0ms app.codeStats 1ms

/include/acpi/actypes.h

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