include/acpi/actypes.h

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