Back to home page

OSCL-LXR

 
 

    


0001 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
0002 /******************************************************************************
0003  *
0004  * Name: actypes.h - Common data types for the entire ACPI subsystem
0005  *
0006  * Copyright (C) 2000 - 2022, Intel Corp.
0007  *
0008  *****************************************************************************/
0009 
0010 #ifndef __ACTYPES_H__
0011 #define __ACTYPES_H__
0012 
0013 /* acpisrc:struct_defs -- for acpisrc conversion */
0014 
0015 /*
0016  * ACPI_MACHINE_WIDTH must be specified in an OS- or compiler-dependent
0017  * header and must be either 32 or 64. 16-bit ACPICA is no longer
0018  * supported, as of 12/2006.
0019  */
0020 #ifndef ACPI_MACHINE_WIDTH
0021 #error ACPI_MACHINE_WIDTH not defined
0022 #endif
0023 
0024 /*
0025  * Data type ranges
0026  * Note: These macros are designed to be compiler independent as well as
0027  * working around problems that some 32-bit compilers have with 64-bit
0028  * constants.
0029  */
0030 #define ACPI_UINT8_MAX                  (u8) (~((u8)  0))   /* 0xFF               */
0031 #define ACPI_UINT16_MAX                 (u16)(~((u16) 0))   /* 0xFFFF             */
0032 #define ACPI_UINT32_MAX                 (u32)(~((u32) 0))   /* 0xFFFFFFFF         */
0033 #define ACPI_UINT64_MAX                 (u64)(~((u64) 0))   /* 0xFFFFFFFFFFFFFFFF */
0034 #define ACPI_ASCII_MAX                  0x7F
0035 
0036 /*
0037  * Architecture-specific ACPICA Subsystem Data Types
0038  *
0039  * The goal of these types is to provide source code portability across
0040  * 16-bit, 32-bit, and 64-bit targets.
0041  *
0042  * 1) The following types are of fixed size for all targets (16/32/64):
0043  *
0044  * u8           Logical boolean
0045  *
0046  * u8           8-bit  (1 byte) unsigned value
0047  * u16          16-bit (2 byte) unsigned value
0048  * u32          32-bit (4 byte) unsigned value
0049  * u64          64-bit (8 byte) unsigned value
0050  *
0051  * s16          16-bit (2 byte) signed value
0052  * s32          32-bit (4 byte) signed value
0053  * s64          64-bit (8 byte) signed value
0054  *
0055  * COMPILER_DEPENDENT_UINT64/s64 - These types are defined in the
0056  * compiler-dependent header(s) and were introduced because there is no
0057  * common 64-bit integer type across the various compilation models, as
0058  * shown in the table below.
0059  *
0060  * Datatype  LP64 ILP64 LLP64 ILP32 LP32 16bit
0061  * char      8    8     8     8     8    8
0062  * short     16   16    16    16    16   16
0063  * _int32         32
0064  * int       32   64    32    32    16   16
0065  * long      64   64    32    32    32   32
0066  * long long            64    64
0067  * pointer   64   64    64    32    32   32
0068  *
0069  * Note: ILP64 and LP32 are currently not supported.
0070  *
0071  *
0072  * 2) These types represent the native word size of the target mode of the
0073  * processor, and may be 16-bit, 32-bit, or 64-bit as required. They are
0074  * usually used for memory allocation, efficient loop counters, and array
0075  * indexes. The types are similar to the size_t type in the C library and
0076  * are required because there is no C type that consistently represents the
0077  * native data width. acpi_size is needed because there is no guarantee
0078  * that a kernel-level C library is present.
0079  *
0080  * acpi_size        16/32/64-bit unsigned value
0081  * acpi_native_int  16/32/64-bit signed value
0082  */
0083 
0084 /*******************************************************************************
0085  *
0086  * Common types for all compilers, all targets
0087  *
0088  ******************************************************************************/
0089 
0090 #ifndef ACPI_USE_SYSTEM_INTTYPES
0091 
0092 typedef unsigned char u8;
0093 typedef unsigned short u16;
0094 typedef short s16;
0095 typedef COMPILER_DEPENDENT_UINT64 u64;
0096 typedef COMPILER_DEPENDENT_INT64 s64;
0097 
0098 #endif              /* ACPI_USE_SYSTEM_INTTYPES */
0099 
0100 /*
0101  * Value returned by acpi_os_get_thread_id. There is no standard "thread_id"
0102  * across operating systems or even the various UNIX systems. Since ACPICA
0103  * only needs the thread ID as a unique thread identifier, we use a u64
0104  * as the only common data type - it will accommodate any type of pointer or
0105  * any type of integer. It is up to the host-dependent OSL to cast the
0106  * native thread ID type to a u64 (in acpi_os_get_thread_id).
0107  */
0108 #define acpi_thread_id                  u64
0109 
0110 /*******************************************************************************
0111  *
0112  * Types specific to 64-bit targets
0113  *
0114  ******************************************************************************/
0115 
0116 #if ACPI_MACHINE_WIDTH == 64
0117 
0118 #ifndef ACPI_USE_SYSTEM_INTTYPES
0119 
0120 typedef unsigned int u32;
0121 typedef int s32;
0122 
0123 #endif              /* ACPI_USE_SYSTEM_INTTYPES */
0124 
0125 typedef s64 acpi_native_int;
0126 
0127 typedef u64 acpi_size;
0128 typedef u64 acpi_io_address;
0129 typedef u64 acpi_physical_address;
0130 
0131 #define ACPI_MAX_PTR                    ACPI_UINT64_MAX
0132 #define ACPI_SIZE_MAX                   ACPI_UINT64_MAX
0133 
0134 #define ACPI_USE_NATIVE_DIVIDE  /* Has native 64-bit integer support */
0135 #define ACPI_USE_NATIVE_MATH64  /* Has native 64-bit integer support */
0136 
0137 /*
0138  * In the case of the Itanium Processor Family (IPF), the hardware does not
0139  * support misaligned memory transfers. Set the MISALIGNMENT_NOT_SUPPORTED
0140  * flag to indicate that special precautions must be taken to avoid alignment
0141  * faults. (IA64 or ia64 is currently used by existing compilers to indicate
0142  * IPF.)
0143  *
0144  * Note: EM64T and other X86-64 processors support misaligned transfers,
0145  * so there is no need to define this flag.
0146  */
0147 #if defined (__IA64__) || defined (__ia64__)
0148 #define ACPI_MISALIGNMENT_NOT_SUPPORTED
0149 #endif
0150 
0151 /*******************************************************************************
0152  *
0153  * Types specific to 32-bit targets
0154  *
0155  ******************************************************************************/
0156 
0157 #elif ACPI_MACHINE_WIDTH == 32
0158 
0159 #ifndef ACPI_USE_SYSTEM_INTTYPES
0160 
0161 typedef unsigned int u32;
0162 typedef int s32;
0163 
0164 #endif              /* ACPI_USE_SYSTEM_INTTYPES */
0165 
0166 typedef s32 acpi_native_int;
0167 
0168 typedef u32 acpi_size;
0169 
0170 #ifdef ACPI_32BIT_PHYSICAL_ADDRESS
0171 
0172 /*
0173  * OSPMs can define this to shrink the size of the structures for 32-bit
0174  * none PAE environment. ASL compiler may always define this to generate
0175  * 32-bit OSPM compliant tables.
0176  */
0177 typedef u32 acpi_io_address;
0178 typedef u32 acpi_physical_address;
0179 
0180 #else               /* ACPI_32BIT_PHYSICAL_ADDRESS */
0181 
0182 /*
0183  * It is reported that, after some calculations, the physical addresses can
0184  * wrap over the 32-bit boundary on 32-bit PAE environment.
0185  * https://bugzilla.kernel.org/show_bug.cgi?id=87971
0186  */
0187 typedef u64 acpi_io_address;
0188 typedef u64 acpi_physical_address;
0189 
0190 #endif              /* ACPI_32BIT_PHYSICAL_ADDRESS */
0191 
0192 #define ACPI_MAX_PTR                    ACPI_UINT32_MAX
0193 #define ACPI_SIZE_MAX                   ACPI_UINT32_MAX
0194 
0195 #else
0196 
0197 /* ACPI_MACHINE_WIDTH must be either 64 or 32 */
0198 
0199 #error unknown ACPI_MACHINE_WIDTH
0200 #endif
0201 
0202 /*******************************************************************************
0203  *
0204  * OS-dependent types
0205  *
0206  * If the defaults below are not appropriate for the host system, they can
0207  * be defined in the OS-specific header, and this will take precedence.
0208  *
0209  ******************************************************************************/
0210 
0211 /* Flags for acpi_os_acquire_lock/acpi_os_release_lock */
0212 
0213 #ifndef acpi_cpu_flags
0214 #define acpi_cpu_flags          acpi_size
0215 #endif
0216 
0217 /* Object returned from acpi_os_create_cache */
0218 
0219 #ifndef acpi_cache_t
0220 #ifdef ACPI_USE_LOCAL_CACHE
0221 #define acpi_cache_t                    struct acpi_memory_list
0222 #else
0223 #define acpi_cache_t                    void *
0224 #endif
0225 #endif
0226 
0227 /*
0228  * Synchronization objects - Mutexes, Semaphores, and spin_locks
0229  */
0230 #if (ACPI_MUTEX_TYPE == ACPI_BINARY_SEMAPHORE)
0231 /*
0232  * These macros are used if the host OS does not support a mutex object.
0233  * Map the OSL Mutex interfaces to binary semaphores.
0234  */
0235 #define acpi_mutex                      acpi_semaphore
0236 #define acpi_os_create_mutex(out_handle) acpi_os_create_semaphore (1, 1, out_handle)
0237 #define acpi_os_delete_mutex(handle)    (void) acpi_os_delete_semaphore (handle)
0238 #define acpi_os_acquire_mutex(handle,time) acpi_os_wait_semaphore (handle, 1, time)
0239 #define acpi_os_release_mutex(handle)   (void) acpi_os_signal_semaphore (handle, 1)
0240 #endif
0241 
0242 /* Configurable types for synchronization objects */
0243 
0244 #ifndef acpi_spinlock
0245 #define acpi_spinlock                   void *
0246 #endif
0247 
0248 #ifndef acpi_raw_spinlock
0249 #define acpi_raw_spinlock       acpi_spinlock
0250 #endif
0251 
0252 #ifndef acpi_semaphore
0253 #define acpi_semaphore                  void *
0254 #endif
0255 
0256 #ifndef acpi_mutex
0257 #define acpi_mutex                      void *
0258 #endif
0259 
0260 /*******************************************************************************
0261  *
0262  * Compiler-dependent types
0263  *
0264  * If the defaults below are not appropriate for the host compiler, they can
0265  * be defined in the compiler-specific header, and this will take precedence.
0266  *
0267  ******************************************************************************/
0268 
0269 /* Use C99 uintptr_t for pointer casting if available, "void *" otherwise */
0270 
0271 #ifndef acpi_uintptr_t
0272 #define acpi_uintptr_t                  void *
0273 #endif
0274 
0275 /*
0276  * ACPI_PRINTF_LIKE is used to tag functions as "printf-like" because
0277  * some compilers can catch printf format string problems
0278  */
0279 #ifndef ACPI_PRINTF_LIKE
0280 #define ACPI_PRINTF_LIKE(c)
0281 #endif
0282 
0283 /*
0284  * Some compilers complain about unused variables. Sometimes we don't want
0285  * to use all the variables (for example, _acpi_module_name). This allows us
0286  * to tell the compiler in a per-variable manner that a variable
0287  * is unused
0288  */
0289 #ifndef ACPI_UNUSED_VAR
0290 #define ACPI_UNUSED_VAR
0291 #endif
0292 
0293 /*
0294  * All ACPICA external functions that are available to the rest of the
0295  * kernel are tagged with these macros which can be defined as appropriate
0296  * for the host.
0297  *
0298  * Notes:
0299  * ACPI_EXPORT_SYMBOL_INIT is used for initialization and termination
0300  * interfaces that may need special processing.
0301  * ACPI_EXPORT_SYMBOL is used for all other public external functions.
0302  */
0303 #ifndef ACPI_EXPORT_SYMBOL_INIT
0304 #define ACPI_EXPORT_SYMBOL_INIT(symbol)
0305 #endif
0306 
0307 #ifndef ACPI_EXPORT_SYMBOL
0308 #define ACPI_EXPORT_SYMBOL(symbol)
0309 #endif
0310 
0311 /*
0312  * Compiler/Clibrary-dependent debug initialization. Used for ACPICA
0313  * utilities only.
0314  */
0315 #ifndef ACPI_DEBUG_INITIALIZE
0316 #define ACPI_DEBUG_INITIALIZE()
0317 #endif
0318 
0319 /*******************************************************************************
0320  *
0321  * Configuration
0322  *
0323  ******************************************************************************/
0324 
0325 #ifdef ACPI_NO_MEM_ALLOCATIONS
0326 
0327 #define ACPI_ALLOCATE(a)                NULL
0328 #define ACPI_ALLOCATE_ZEROED(a)         NULL
0329 #define ACPI_FREE(a)
0330 #define ACPI_MEM_TRACKING(a)
0331 
0332 #else               /* ACPI_NO_MEM_ALLOCATIONS */
0333 
0334 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
0335 /*
0336  * Memory allocation tracking (used by acpi_exec to detect memory leaks)
0337  */
0338 #define ACPI_MEM_PARAMETERS             _COMPONENT, _acpi_module_name, __LINE__
0339 #define ACPI_ALLOCATE(a)                acpi_ut_allocate_and_track ((acpi_size) (a), ACPI_MEM_PARAMETERS)
0340 #define ACPI_ALLOCATE_ZEROED(a)         acpi_ut_allocate_zeroed_and_track ((acpi_size) (a), ACPI_MEM_PARAMETERS)
0341 #define ACPI_FREE(a)                    acpi_ut_free_and_track (a, ACPI_MEM_PARAMETERS)
0342 #define ACPI_MEM_TRACKING(a)            a
0343 
0344 #else
0345 /*
0346  * Normal memory allocation directly via the OS services layer
0347  */
0348 #define ACPI_ALLOCATE(a)                acpi_os_allocate ((acpi_size) (a))
0349 #define ACPI_ALLOCATE_ZEROED(a)         acpi_os_allocate_zeroed ((acpi_size) (a))
0350 #define ACPI_FREE(a)                    acpi_os_free (a)
0351 #define ACPI_MEM_TRACKING(a)
0352 
0353 #endif              /* ACPI_DBG_TRACK_ALLOCATIONS */
0354 
0355 #endif              /* ACPI_NO_MEM_ALLOCATIONS */
0356 
0357 /******************************************************************************
0358  *
0359  * ACPI Specification constants (Do not change unless the specification
0360  * changes)
0361  *
0362  *****************************************************************************/
0363 
0364 /* Number of distinct FADT-based GPE register blocks (GPE0 and GPE1) */
0365 
0366 #define ACPI_MAX_GPE_BLOCKS             2
0367 
0368 /* Default ACPI register widths */
0369 
0370 #define ACPI_GPE_REGISTER_WIDTH         8
0371 #define ACPI_PM1_REGISTER_WIDTH         16
0372 #define ACPI_PM2_REGISTER_WIDTH         8
0373 #define ACPI_PM_TIMER_WIDTH             32
0374 #define ACPI_RESET_REGISTER_WIDTH       8
0375 
0376 /* Names within the namespace are 4 bytes long */
0377 
0378 #define ACPI_NAMESEG_SIZE               4   /* Fixed by ACPI spec */
0379 #define ACPI_PATH_SEGMENT_LENGTH        5   /* 4 chars for name + 1 char for separator */
0380 #define ACPI_PATH_SEPARATOR             '.'
0381 
0382 /* Sizes for ACPI table headers */
0383 
0384 #define ACPI_OEM_ID_SIZE                6
0385 #define ACPI_OEM_TABLE_ID_SIZE          8
0386 
0387 /* ACPI/PNP hardware IDs */
0388 
0389 #define PCI_ROOT_HID_STRING             "PNP0A03"
0390 #define PCI_EXPRESS_ROOT_HID_STRING     "PNP0A08"
0391 
0392 /* PM Timer ticks per second (HZ) */
0393 
0394 #define ACPI_PM_TIMER_FREQUENCY         3579545
0395 
0396 /*******************************************************************************
0397  *
0398  * Independent types
0399  *
0400  ******************************************************************************/
0401 
0402 /* Logical defines and NULL */
0403 
0404 #ifdef FALSE
0405 #undef FALSE
0406 #endif
0407 #define FALSE                           (1 == 0)
0408 
0409 #ifdef TRUE
0410 #undef TRUE
0411 #endif
0412 #define TRUE                            (1 == 1)
0413 
0414 #ifndef NULL
0415 #define NULL                            (void *) 0
0416 #endif
0417 
0418 /*
0419  * Miscellaneous types
0420  */
0421 typedef u32 acpi_status;    /* All ACPI Exceptions */
0422 typedef u32 acpi_name;      /* 4-byte ACPI name */
0423 typedef char *acpi_string;  /* Null terminated ASCII string */
0424 typedef void *acpi_handle;  /* Actually a ptr to a NS Node */
0425 
0426 /* Time constants for timer calculations */
0427 
0428 #define ACPI_MSEC_PER_SEC               1000L
0429 
0430 #define ACPI_USEC_PER_MSEC              1000L
0431 #define ACPI_USEC_PER_SEC               1000000L
0432 
0433 #define ACPI_100NSEC_PER_USEC           10L
0434 #define ACPI_100NSEC_PER_MSEC           10000L
0435 #define ACPI_100NSEC_PER_SEC            10000000L
0436 
0437 #define ACPI_NSEC_PER_USEC              1000L
0438 #define ACPI_NSEC_PER_MSEC              1000000L
0439 #define ACPI_NSEC_PER_SEC               1000000000L
0440 
0441 #define ACPI_TIME_AFTER(a, b)           ((s64)((b) - (a)) < 0)
0442 
0443 /* Owner IDs are used to track namespace nodes for selective deletion */
0444 
0445 typedef u16 acpi_owner_id;
0446 #define ACPI_OWNER_ID_MAX               0xFFF   /* 4095 possible owner IDs */
0447 
0448 #define ACPI_INTEGER_BIT_SIZE           64
0449 #define ACPI_MAX_DECIMAL_DIGITS         20  /* 2^64 = 18,446,744,073,709,551,616 */
0450 #define ACPI_MAX64_DECIMAL_DIGITS       20
0451 #define ACPI_MAX32_DECIMAL_DIGITS       10
0452 #define ACPI_MAX16_DECIMAL_DIGITS        5
0453 #define ACPI_MAX8_DECIMAL_DIGITS         3
0454 
0455 /*
0456  * Constants with special meanings
0457  */
0458 #define ACPI_ROOT_OBJECT                ((acpi_handle) ACPI_TO_POINTER (ACPI_MAX_PTR))
0459 #define ACPI_WAIT_FOREVER               0xFFFF  /* u16, as per ACPI spec */
0460 #define ACPI_DO_NOT_WAIT                0
0461 
0462 /*
0463  * Obsolete: Acpi integer width. In ACPI version 1 (1996), integers are
0464  * 32 bits. In ACPI version 2 (2000) and later, integers are max 64 bits.
0465  * Note that this pertains to the ACPI integer type only, not to other
0466  * integers used in the implementation of the ACPICA subsystem.
0467  *
0468  * 01/2010: This type is obsolete and has been removed from the entire ACPICA
0469  * code base. It remains here for compatibility with device drivers that use
0470  * the type. However, it will be removed in the future.
0471  */
0472 typedef u64 acpi_integer;
0473 #define ACPI_INTEGER_MAX                ACPI_UINT64_MAX
0474 
0475 /*******************************************************************************
0476  *
0477  * Commonly used macros
0478  *
0479  ******************************************************************************/
0480 
0481 /* Data manipulation */
0482 
0483 #define ACPI_LOBYTE(integer)            ((u8)   (u16)(integer))
0484 #define ACPI_HIBYTE(integer)            ((u8) (((u16)(integer)) >> 8))
0485 #define ACPI_LOWORD(integer)            ((u16)  (u32)(integer))
0486 #define ACPI_HIWORD(integer)            ((u16)(((u32)(integer)) >> 16))
0487 #define ACPI_LODWORD(integer64)         ((u32)  (u64)(integer64))
0488 #define ACPI_HIDWORD(integer64)         ((u32)(((u64)(integer64)) >> 32))
0489 
0490 #define ACPI_SET_BIT(target,bit)        ((target) |= (bit))
0491 #define ACPI_CLEAR_BIT(target,bit)      ((target) &= ~(bit))
0492 #define ACPI_MIN(a,b)                   (((a)<(b))?(a):(b))
0493 #define ACPI_MAX(a,b)                   (((a)>(b))?(a):(b))
0494 
0495 /* Size calculation */
0496 
0497 #define ACPI_ARRAY_LENGTH(x)            (sizeof(x) / sizeof((x)[0]))
0498 
0499 /* Pointer manipulation */
0500 
0501 #define ACPI_CAST_PTR(t, p)             ((t *) (acpi_uintptr_t) (p))
0502 #define ACPI_CAST_INDIRECT_PTR(t, p)    ((t **) (acpi_uintptr_t) (p))
0503 #define ACPI_ADD_PTR(t, a, b)           ACPI_CAST_PTR (t, (ACPI_CAST_PTR (u8, (a)) + (acpi_size)(b)))
0504 #define ACPI_SUB_PTR(t, a, b)           ACPI_CAST_PTR (t, (ACPI_CAST_PTR (u8, (a)) - (acpi_size)(b)))
0505 #define ACPI_PTR_DIFF(a, b)             ((acpi_size) (ACPI_CAST_PTR (u8, (a)) - ACPI_CAST_PTR (u8, (b))))
0506 
0507 /* Pointer/Integer type conversions */
0508 
0509 #define ACPI_TO_POINTER(i)              ACPI_CAST_PTR (void, (acpi_size) (i))
0510 #ifndef ACPI_TO_INTEGER
0511 #define ACPI_TO_INTEGER(p)              ACPI_PTR_DIFF (p, (void *) 0)
0512 #endif
0513 #ifndef ACPI_OFFSET
0514 #define ACPI_OFFSET(d, f)               ACPI_PTR_DIFF (&(((d *) 0)->f), (void *) 0)
0515 #endif
0516 #define ACPI_PTR_TO_PHYSADDR(i)         ACPI_TO_INTEGER(i)
0517 
0518 /* Optimizations for 4-character (32-bit) acpi_name manipulation */
0519 
0520 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
0521 #define ACPI_COMPARE_NAMESEG(a,b)       (*ACPI_CAST_PTR (u32, (a)) == *ACPI_CAST_PTR (u32, (b)))
0522 #define ACPI_COPY_NAMESEG(dest,src)     (*ACPI_CAST_PTR (u32, (dest)) = *ACPI_CAST_PTR (u32, (src)))
0523 #else
0524 #define ACPI_COMPARE_NAMESEG(a,b)       (!strncmp (ACPI_CAST_PTR (char, (a)), ACPI_CAST_PTR (char, (b)), ACPI_NAMESEG_SIZE))
0525 #define ACPI_COPY_NAMESEG(dest,src)     (strncpy (ACPI_CAST_PTR (char, (dest)), ACPI_CAST_PTR (char, (src)), ACPI_NAMESEG_SIZE))
0526 #endif
0527 
0528 /* Support for the special RSDP signature (8 characters) */
0529 
0530 #define ACPI_VALIDATE_RSDP_SIG(a)       (!strncmp (ACPI_CAST_PTR (char, (a)), ACPI_SIG_RSDP, 8))
0531 #define ACPI_MAKE_RSDP_SIG(dest)        (memcpy (ACPI_CAST_PTR (char, (dest)), ACPI_SIG_RSDP, 8))
0532 
0533 /* Support for OEMx signature (x can be any character) */
0534 #define ACPI_IS_OEM_SIG(a)        (!strncmp (ACPI_CAST_PTR (char, (a)), ACPI_OEM_NAME, 3) &&\
0535      strnlen (a, ACPI_NAMESEG_SIZE) == ACPI_NAMESEG_SIZE)
0536 
0537 /*
0538  * Algorithm to obtain access bit or byte width.
0539  * Can be used with access_width of struct acpi_generic_address and access_size of
0540  * struct acpi_resource_generic_register.
0541  */
0542 #define ACPI_ACCESS_BIT_SHIFT           2
0543 #define ACPI_ACCESS_BYTE_SHIFT          -1
0544 #define ACPI_ACCESS_BIT_MAX             (31 - ACPI_ACCESS_BIT_SHIFT)
0545 #define ACPI_ACCESS_BYTE_MAX            (31 - ACPI_ACCESS_BYTE_SHIFT)
0546 #define ACPI_ACCESS_BIT_DEFAULT         (8 - ACPI_ACCESS_BIT_SHIFT)
0547 #define ACPI_ACCESS_BYTE_DEFAULT        (8 - ACPI_ACCESS_BYTE_SHIFT)
0548 #define ACPI_ACCESS_BIT_WIDTH(size)     (1 << ((size) + ACPI_ACCESS_BIT_SHIFT))
0549 #define ACPI_ACCESS_BYTE_WIDTH(size)    (1 << ((size) + ACPI_ACCESS_BYTE_SHIFT))
0550 
0551 /*******************************************************************************
0552  *
0553  * Miscellaneous constants
0554  *
0555  ******************************************************************************/
0556 
0557 /*
0558  * Initialization sequence options
0559  */
0560 #define ACPI_FULL_INITIALIZATION        0x0000
0561 #define ACPI_NO_FACS_INIT               0x0001
0562 #define ACPI_NO_ACPI_ENABLE             0x0002
0563 #define ACPI_NO_HARDWARE_INIT           0x0004
0564 #define ACPI_NO_EVENT_INIT              0x0008
0565 #define ACPI_NO_HANDLER_INIT            0x0010
0566 #define ACPI_NO_OBJECT_INIT             0x0020
0567 #define ACPI_NO_DEVICE_INIT             0x0040
0568 #define ACPI_NO_ADDRESS_SPACE_INIT      0x0080
0569 
0570 /*
0571  * Initialization state
0572  */
0573 #define ACPI_SUBSYSTEM_INITIALIZE       0x01
0574 #define ACPI_INITIALIZED_OK             0x02
0575 
0576 /*
0577  * Power state values
0578  */
0579 #define ACPI_STATE_UNKNOWN              (u8) 0xFF
0580 
0581 #define ACPI_STATE_S0                   (u8) 0
0582 #define ACPI_STATE_S1                   (u8) 1
0583 #define ACPI_STATE_S2                   (u8) 2
0584 #define ACPI_STATE_S3                   (u8) 3
0585 #define ACPI_STATE_S4                   (u8) 4
0586 #define ACPI_STATE_S5                   (u8) 5
0587 #define ACPI_S_STATES_MAX               ACPI_STATE_S5
0588 #define ACPI_S_STATE_COUNT              6
0589 
0590 #define ACPI_STATE_D0                   (u8) 0
0591 #define ACPI_STATE_D1                   (u8) 1
0592 #define ACPI_STATE_D2                   (u8) 2
0593 #define ACPI_STATE_D3_HOT               (u8) 3
0594 #define ACPI_STATE_D3                   (u8) 4
0595 #define ACPI_STATE_D3_COLD              ACPI_STATE_D3
0596 #define ACPI_D_STATES_MAX               ACPI_STATE_D3
0597 #define ACPI_D_STATE_COUNT              5
0598 
0599 #define ACPI_STATE_C0                   (u8) 0
0600 #define ACPI_STATE_C1                   (u8) 1
0601 #define ACPI_STATE_C2                   (u8) 2
0602 #define ACPI_STATE_C3                   (u8) 3
0603 #define ACPI_C_STATES_MAX               ACPI_STATE_C3
0604 #define ACPI_C_STATE_COUNT              4
0605 
0606 /*
0607  * Sleep type invalid value
0608  */
0609 #define ACPI_SLEEP_TYPE_MAX             0x7
0610 #define ACPI_SLEEP_TYPE_INVALID         0xFF
0611 
0612 /*
0613  * Standard notify values
0614  */
0615 #define ACPI_NOTIFY_BUS_CHECK           (u8) 0x00
0616 #define ACPI_NOTIFY_DEVICE_CHECK        (u8) 0x01
0617 #define ACPI_NOTIFY_DEVICE_WAKE         (u8) 0x02
0618 #define ACPI_NOTIFY_EJECT_REQUEST       (u8) 0x03
0619 #define ACPI_NOTIFY_DEVICE_CHECK_LIGHT  (u8) 0x04
0620 #define ACPI_NOTIFY_FREQUENCY_MISMATCH  (u8) 0x05
0621 #define ACPI_NOTIFY_BUS_MODE_MISMATCH   (u8) 0x06
0622 #define ACPI_NOTIFY_POWER_FAULT         (u8) 0x07
0623 #define ACPI_NOTIFY_CAPABILITIES_CHECK  (u8) 0x08
0624 #define ACPI_NOTIFY_DEVICE_PLD_CHECK    (u8) 0x09
0625 #define ACPI_NOTIFY_RESERVED            (u8) 0x0A
0626 #define ACPI_NOTIFY_LOCALITY_UPDATE     (u8) 0x0B
0627 #define ACPI_NOTIFY_SHUTDOWN_REQUEST    (u8) 0x0C
0628 #define ACPI_NOTIFY_AFFINITY_UPDATE     (u8) 0x0D
0629 #define ACPI_NOTIFY_MEMORY_UPDATE       (u8) 0x0E
0630 #define ACPI_NOTIFY_DISCONNECT_RECOVER  (u8) 0x0F
0631 
0632 #define ACPI_GENERIC_NOTIFY_MAX         0x0F
0633 #define ACPI_SPECIFIC_NOTIFY_MAX        0x84
0634 
0635 /*
0636  * Types associated with ACPI names and objects. The first group of
0637  * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
0638  * of the ACPI object_type() operator (See the ACPI Spec). Therefore,
0639  * only add to the first group if the spec changes.
0640  *
0641  * NOTE: Types must be kept in sync with the global acpi_ns_properties
0642  * and acpi_ns_type_names arrays.
0643  */
0644 typedef u32 acpi_object_type;
0645 
0646 #define ACPI_TYPE_ANY                   0x00
0647 #define ACPI_TYPE_INTEGER               0x01    /* Byte/Word/Dword/Zero/One/Ones */
0648 #define ACPI_TYPE_STRING                0x02
0649 #define ACPI_TYPE_BUFFER                0x03
0650 #define ACPI_TYPE_PACKAGE               0x04    /* byte_const, multiple data_term/Constant/super_name */
0651 #define ACPI_TYPE_FIELD_UNIT            0x05
0652 #define ACPI_TYPE_DEVICE                0x06    /* Name, multiple Node */
0653 #define ACPI_TYPE_EVENT                 0x07
0654 #define ACPI_TYPE_METHOD                0x08    /* Name, byte_const, multiple Code */
0655 #define ACPI_TYPE_MUTEX                 0x09
0656 #define ACPI_TYPE_REGION                0x0A
0657 #define ACPI_TYPE_POWER                 0x0B    /* Name,byte_const,word_const,multi Node */
0658 #define ACPI_TYPE_PROCESSOR             0x0C    /* Name,byte_const,Dword_const,byte_const,multi nm_o */
0659 #define ACPI_TYPE_THERMAL               0x0D    /* Name, multiple Node */
0660 #define ACPI_TYPE_BUFFER_FIELD          0x0E
0661 #define ACPI_TYPE_DDB_HANDLE            0x0F
0662 #define ACPI_TYPE_DEBUG_OBJECT          0x10
0663 
0664 #define ACPI_TYPE_EXTERNAL_MAX          0x10
0665 #define ACPI_NUM_TYPES                  (ACPI_TYPE_EXTERNAL_MAX + 1)
0666 
0667 /*
0668  * These are object types that do not map directly to the ACPI
0669  * object_type() operator. They are used for various internal purposes
0670  * only. If new predefined ACPI_TYPEs are added (via the ACPI
0671  * specification), these internal types must move upwards. (There
0672  * is code that depends on these values being contiguous with the
0673  * external types above.)
0674  */
0675 #define ACPI_TYPE_LOCAL_REGION_FIELD    0x11
0676 #define ACPI_TYPE_LOCAL_BANK_FIELD      0x12
0677 #define ACPI_TYPE_LOCAL_INDEX_FIELD     0x13
0678 #define ACPI_TYPE_LOCAL_REFERENCE       0x14    /* Arg#, Local#, Name, Debug, ref_of, Index */
0679 #define ACPI_TYPE_LOCAL_ALIAS           0x15
0680 #define ACPI_TYPE_LOCAL_METHOD_ALIAS    0x16
0681 #define ACPI_TYPE_LOCAL_NOTIFY          0x17
0682 #define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
0683 #define ACPI_TYPE_LOCAL_RESOURCE        0x19
0684 #define ACPI_TYPE_LOCAL_RESOURCE_FIELD  0x1A
0685 #define ACPI_TYPE_LOCAL_SCOPE           0x1B    /* 1 Name, multiple object_list Nodes */
0686 
0687 #define ACPI_TYPE_NS_NODE_MAX           0x1B    /* Last typecode used within a NS Node */
0688 #define ACPI_TOTAL_TYPES                (ACPI_TYPE_NS_NODE_MAX + 1)
0689 
0690 /*
0691  * These are special object types that never appear in
0692  * a Namespace node, only in an object of union acpi_operand_object
0693  */
0694 #define ACPI_TYPE_LOCAL_EXTRA           0x1C
0695 #define ACPI_TYPE_LOCAL_DATA            0x1D
0696 
0697 #define ACPI_TYPE_LOCAL_MAX             0x1D
0698 
0699 /* All types above here are invalid */
0700 
0701 #define ACPI_TYPE_INVALID               0x1E
0702 #define ACPI_TYPE_NOT_FOUND             0xFF
0703 
0704 #define ACPI_NUM_NS_TYPES               (ACPI_TYPE_INVALID + 1)
0705 
0706 /*
0707  * All I/O
0708  */
0709 #define ACPI_READ                       0
0710 #define ACPI_WRITE                      1
0711 #define ACPI_IO_MASK                    1
0712 
0713 /*
0714  * Event Types: Fixed & General Purpose
0715  */
0716 typedef u32 acpi_event_type;
0717 
0718 /*
0719  * Fixed events
0720  */
0721 #define ACPI_EVENT_PMTIMER              0
0722 #define ACPI_EVENT_GLOBAL               1
0723 #define ACPI_EVENT_POWER_BUTTON         2
0724 #define ACPI_EVENT_SLEEP_BUTTON         3
0725 #define ACPI_EVENT_RTC                  4
0726 #define ACPI_EVENT_MAX                  4
0727 #define ACPI_NUM_FIXED_EVENTS           ACPI_EVENT_MAX + 1
0728 
0729 /*
0730  * Event status - Per event
0731  * -------------
0732  * The encoding of acpi_event_status is illustrated below.
0733  * Note that a set bit (1) indicates the property is TRUE
0734  * (e.g. if bit 0 is set then the event is enabled).
0735  * +-------------+-+-+-+-+-+-+
0736  * |   Bits 31:6 |5|4|3|2|1|0|
0737  * +-------------+-+-+-+-+-+-+
0738  *          |     | | | | | |
0739  *          |     | | | | | +- Enabled?
0740  *          |     | | | | +--- Enabled for wake?
0741  *          |     | | | +----- Status bit set?
0742  *          |     | | +------- Enable bit set?
0743  *          |     | +--------- Has a handler?
0744  *          |     +----------- Masked?
0745  *          +----------------- <Reserved>
0746  */
0747 typedef u32 acpi_event_status;
0748 
0749 #define ACPI_EVENT_FLAG_DISABLED        (acpi_event_status) 0x00
0750 #define ACPI_EVENT_FLAG_ENABLED         (acpi_event_status) 0x01
0751 #define ACPI_EVENT_FLAG_WAKE_ENABLED    (acpi_event_status) 0x02
0752 #define ACPI_EVENT_FLAG_STATUS_SET      (acpi_event_status) 0x04
0753 #define ACPI_EVENT_FLAG_ENABLE_SET      (acpi_event_status) 0x08
0754 #define ACPI_EVENT_FLAG_HAS_HANDLER     (acpi_event_status) 0x10
0755 #define ACPI_EVENT_FLAG_MASKED          (acpi_event_status) 0x20
0756 #define ACPI_EVENT_FLAG_SET             ACPI_EVENT_FLAG_STATUS_SET
0757 
0758 /* Actions for acpi_set_gpe, acpi_gpe_wakeup, acpi_hw_low_set_gpe */
0759 
0760 #define ACPI_GPE_ENABLE                 0
0761 #define ACPI_GPE_DISABLE                1
0762 #define ACPI_GPE_CONDITIONAL_ENABLE     2
0763 
0764 /*
0765  * GPE info flags - Per GPE
0766  * +---+-+-+-+---+
0767  * |7:6|5|4|3|2:0|
0768  * +---+-+-+-+---+
0769  *   |  | | |  |
0770  *   |  | | |  +-- Type of dispatch:to method, handler, notify, or none
0771  *   |  | | +----- Interrupt type: edge or level triggered
0772  *   |  | +------- Is a Wake GPE
0773  *   |  +--------- Has been enabled automatically at init time
0774  *   +------------ <Reserved>
0775  */
0776 #define ACPI_GPE_DISPATCH_NONE          (u8) 0x00
0777 #define ACPI_GPE_DISPATCH_METHOD        (u8) 0x01
0778 #define ACPI_GPE_DISPATCH_HANDLER       (u8) 0x02
0779 #define ACPI_GPE_DISPATCH_NOTIFY        (u8) 0x03
0780 #define ACPI_GPE_DISPATCH_RAW_HANDLER   (u8) 0x04
0781 #define ACPI_GPE_DISPATCH_MASK          (u8) 0x07
0782 #define ACPI_GPE_DISPATCH_TYPE(flags)   ((u8) ((flags) & ACPI_GPE_DISPATCH_MASK))
0783 
0784 #define ACPI_GPE_LEVEL_TRIGGERED        (u8) 0x08
0785 #define ACPI_GPE_EDGE_TRIGGERED         (u8) 0x00
0786 #define ACPI_GPE_XRUPT_TYPE_MASK        (u8) 0x08
0787 
0788 #define ACPI_GPE_CAN_WAKE               (u8) 0x10
0789 #define ACPI_GPE_AUTO_ENABLED           (u8) 0x20
0790 #define ACPI_GPE_INITIALIZED            (u8) 0x40
0791 
0792 /*
0793  * Flags for GPE and Lock interfaces
0794  */
0795 #define ACPI_NOT_ISR                    0x1
0796 #define ACPI_ISR                        0x0
0797 
0798 /* Notify types */
0799 
0800 #define ACPI_SYSTEM_NOTIFY              0x1
0801 #define ACPI_DEVICE_NOTIFY              0x2
0802 #define ACPI_ALL_NOTIFY                 (ACPI_SYSTEM_NOTIFY | ACPI_DEVICE_NOTIFY)
0803 #define ACPI_MAX_NOTIFY_HANDLER_TYPE    0x3
0804 #define ACPI_NUM_NOTIFY_TYPES           2
0805 
0806 #define ACPI_MAX_SYS_NOTIFY             0x7F
0807 #define ACPI_MAX_DEVICE_SPECIFIC_NOTIFY 0xBF
0808 
0809 #define ACPI_SYSTEM_HANDLER_LIST        0   /* Used as index, must be SYSTEM_NOTIFY -1 */
0810 #define ACPI_DEVICE_HANDLER_LIST        1   /* Used as index, must be DEVICE_NOTIFY -1 */
0811 
0812 /* Address Space (Operation Region) Types */
0813 
0814 typedef u8 acpi_adr_space_type;
0815 
0816 #define ACPI_ADR_SPACE_SYSTEM_MEMORY    (acpi_adr_space_type) 0
0817 #define ACPI_ADR_SPACE_SYSTEM_IO        (acpi_adr_space_type) 1
0818 #define ACPI_ADR_SPACE_PCI_CONFIG       (acpi_adr_space_type) 2
0819 #define ACPI_ADR_SPACE_EC               (acpi_adr_space_type) 3
0820 #define ACPI_ADR_SPACE_SMBUS            (acpi_adr_space_type) 4
0821 #define ACPI_ADR_SPACE_CMOS             (acpi_adr_space_type) 5
0822 #define ACPI_ADR_SPACE_PCI_BAR_TARGET   (acpi_adr_space_type) 6
0823 #define ACPI_ADR_SPACE_IPMI             (acpi_adr_space_type) 7
0824 #define ACPI_ADR_SPACE_GPIO             (acpi_adr_space_type) 8
0825 #define ACPI_ADR_SPACE_GSBUS            (acpi_adr_space_type) 9
0826 #define ACPI_ADR_SPACE_PLATFORM_COMM    (acpi_adr_space_type) 10
0827 #define ACPI_ADR_SPACE_PLATFORM_RT      (acpi_adr_space_type) 11
0828 
0829 #define ACPI_NUM_PREDEFINED_REGIONS     12
0830 
0831 /*
0832  * Special Address Spaces
0833  *
0834  * Note: A Data Table region is a special type of operation region
0835  * that has its own AML opcode. However, internally, the AML
0836  * interpreter simply creates an operation region with an address
0837  * space type of ACPI_ADR_SPACE_DATA_TABLE.
0838  */
0839 #define ACPI_ADR_SPACE_DATA_TABLE       (acpi_adr_space_type) 0x7E  /* Internal to ACPICA only */
0840 #define ACPI_ADR_SPACE_FIXED_HARDWARE   (acpi_adr_space_type) 0x7F
0841 
0842 /* Values for _REG connection code */
0843 
0844 #define ACPI_REG_DISCONNECT             0
0845 #define ACPI_REG_CONNECT                1
0846 
0847 /*
0848  * bit_register IDs
0849  *
0850  * These values are intended to be used by the hardware interfaces
0851  * and are mapped to individual bitfields defined within the ACPI
0852  * registers. See the acpi_gbl_bit_register_info global table in utglobal.c
0853  * for this mapping.
0854  */
0855 
0856 /* PM1 Status register */
0857 
0858 #define ACPI_BITREG_TIMER_STATUS                0x00
0859 #define ACPI_BITREG_BUS_MASTER_STATUS           0x01
0860 #define ACPI_BITREG_GLOBAL_LOCK_STATUS          0x02
0861 #define ACPI_BITREG_POWER_BUTTON_STATUS         0x03
0862 #define ACPI_BITREG_SLEEP_BUTTON_STATUS         0x04
0863 #define ACPI_BITREG_RT_CLOCK_STATUS             0x05
0864 #define ACPI_BITREG_WAKE_STATUS                 0x06
0865 #define ACPI_BITREG_PCIEXP_WAKE_STATUS          0x07
0866 
0867 /* PM1 Enable register */
0868 
0869 #define ACPI_BITREG_TIMER_ENABLE                0x08
0870 #define ACPI_BITREG_GLOBAL_LOCK_ENABLE          0x09
0871 #define ACPI_BITREG_POWER_BUTTON_ENABLE         0x0A
0872 #define ACPI_BITREG_SLEEP_BUTTON_ENABLE         0x0B
0873 #define ACPI_BITREG_RT_CLOCK_ENABLE             0x0C
0874 #define ACPI_BITREG_PCIEXP_WAKE_DISABLE         0x0D
0875 
0876 /* PM1 Control register */
0877 
0878 #define ACPI_BITREG_SCI_ENABLE                  0x0E
0879 #define ACPI_BITREG_BUS_MASTER_RLD              0x0F
0880 #define ACPI_BITREG_GLOBAL_LOCK_RELEASE         0x10
0881 #define ACPI_BITREG_SLEEP_TYPE                  0x11
0882 #define ACPI_BITREG_SLEEP_ENABLE                0x12
0883 
0884 /* PM2 Control register */
0885 
0886 #define ACPI_BITREG_ARB_DISABLE                 0x13
0887 
0888 #define ACPI_BITREG_MAX                         0x13
0889 #define ACPI_NUM_BITREG                         ACPI_BITREG_MAX + 1
0890 
0891 /* Status register values. A 1 clears a status bit. 0 = no effect */
0892 
0893 #define ACPI_CLEAR_STATUS                       1
0894 
0895 /* Enable and Control register values */
0896 
0897 #define ACPI_ENABLE_EVENT                       1
0898 #define ACPI_DISABLE_EVENT                      0
0899 
0900 /*
0901  * External ACPI object definition
0902  */
0903 
0904 /*
0905  * Note: Type == ACPI_TYPE_ANY (0) is used to indicate a NULL package
0906  * element or an unresolved named reference.
0907  */
0908 union acpi_object {
0909     acpi_object_type type;  /* See definition of acpi_ns_type for values */
0910     struct {
0911         acpi_object_type type;  /* ACPI_TYPE_INTEGER */
0912         u64 value;  /* The actual number */
0913     } integer;
0914 
0915     struct {
0916         acpi_object_type type;  /* ACPI_TYPE_STRING */
0917         u32 length; /* # of bytes in string, excluding trailing null */
0918         char *pointer;  /* points to the string value */
0919     } string;
0920 
0921     struct {
0922         acpi_object_type type;  /* ACPI_TYPE_BUFFER */
0923         u32 length; /* # of bytes in buffer */
0924         u8 *pointer;    /* points to the buffer */
0925     } buffer;
0926 
0927     struct {
0928         acpi_object_type type;  /* ACPI_TYPE_PACKAGE */
0929         u32 count;  /* # of elements in package */
0930         union acpi_object *elements;    /* Pointer to an array of ACPI_OBJECTs */
0931     } package;
0932 
0933     struct {
0934         acpi_object_type type;  /* ACPI_TYPE_LOCAL_REFERENCE */
0935         acpi_object_type actual_type;   /* Type associated with the Handle */
0936         acpi_handle handle; /* object reference */
0937     } reference;
0938 
0939     struct {
0940         acpi_object_type type;  /* ACPI_TYPE_PROCESSOR */
0941         u32 proc_id;
0942         acpi_io_address pblk_address;
0943         u32 pblk_length;
0944     } processor;
0945 
0946     struct {
0947         acpi_object_type type;  /* ACPI_TYPE_POWER */
0948         u32 system_level;
0949         u32 resource_order;
0950     } power_resource;
0951 };
0952 
0953 /*
0954  * List of objects, used as a parameter list for control method evaluation
0955  */
0956 struct acpi_object_list {
0957     u32 count;
0958     union acpi_object *pointer;
0959 };
0960 
0961 /*
0962  * Miscellaneous common Data Structures used by the interfaces
0963  */
0964 #define ACPI_NO_BUFFER              0
0965 
0966 #ifdef ACPI_NO_MEM_ALLOCATIONS
0967 
0968 #define ACPI_ALLOCATE_BUFFER        (acpi_size) (0)
0969 #define ACPI_ALLOCATE_LOCAL_BUFFER  (acpi_size) (0)
0970 
0971 #else               /* ACPI_NO_MEM_ALLOCATIONS */
0972 
0973 #define ACPI_ALLOCATE_BUFFER        (acpi_size) (-1)    /* Let ACPICA allocate buffer */
0974 #define ACPI_ALLOCATE_LOCAL_BUFFER  (acpi_size) (-2)    /* For internal use only (enables tracking) */
0975 
0976 #endif              /* ACPI_NO_MEM_ALLOCATIONS */
0977 
0978 struct acpi_buffer {
0979     acpi_size length;   /* Length in bytes of the buffer */
0980     void *pointer;      /* pointer to buffer */
0981 };
0982 
0983 /*
0984  * name_type for acpi_get_name
0985  */
0986 #define ACPI_FULL_PATHNAME              0
0987 #define ACPI_SINGLE_NAME                1
0988 #define ACPI_FULL_PATHNAME_NO_TRAILING  2
0989 #define ACPI_NAME_TYPE_MAX              2
0990 
0991 /*
0992  * Predefined Namespace items
0993  */
0994 struct acpi_predefined_names {
0995     const char *name;
0996     u8 type;
0997     char *val;
0998 };
0999 
1000 /*
1001  * Structure and flags for acpi_get_system_info
1002  */
1003 #define ACPI_SYS_MODE_UNKNOWN           0x0000
1004 #define ACPI_SYS_MODE_ACPI              0x0001
1005 #define ACPI_SYS_MODE_LEGACY            0x0002
1006 #define ACPI_SYS_MODES_MASK             0x0003
1007 
1008 /*
1009  * System info returned by acpi_get_system_info()
1010  */
1011 struct acpi_system_info {
1012     u32 acpi_ca_version;
1013     u32 flags;
1014     u32 timer_resolution;
1015     u32 reserved1;
1016     u32 reserved2;
1017     u32 debug_level;
1018     u32 debug_layer;
1019 };
1020 
1021 /*
1022  * System statistics returned by acpi_get_statistics()
1023  */
1024 struct acpi_statistics {
1025     u32 sci_count;
1026     u32 gpe_count;
1027     u32 fixed_event_count[ACPI_NUM_FIXED_EVENTS];
1028     u32 method_count;
1029 };
1030 
1031 /*
1032  * Types specific to the OS service interfaces
1033  */
1034 typedef u32
1035  (ACPI_SYSTEM_XFACE * acpi_osd_handler) (void *context);
1036 
1037 typedef void
1038  (ACPI_SYSTEM_XFACE * acpi_osd_exec_callback) (void *context);
1039 
1040 /*
1041  * Various handlers and callback procedures
1042  */
1043 typedef
1044 u32 (*acpi_sci_handler) (void *context);
1045 
1046 typedef
1047 void (*acpi_gbl_event_handler) (u32 event_type,
1048                    acpi_handle device,
1049                    u32 event_number, void *context);
1050 
1051 #define ACPI_EVENT_TYPE_GPE         0
1052 #define ACPI_EVENT_TYPE_FIXED       1
1053 
1054 typedef
1055 u32(*acpi_event_handler) (void *context);
1056 
1057 typedef
1058 u32 (*acpi_gpe_handler) (acpi_handle gpe_device, u32 gpe_number, void *context);
1059 
1060 typedef
1061 void (*acpi_notify_handler) (acpi_handle device, u32 value, void *context);
1062 
1063 typedef
1064 void (*acpi_object_handler) (acpi_handle object, void *data);
1065 
1066 typedef
1067 acpi_status (*acpi_init_handler) (acpi_handle object, u32 function);
1068 
1069 #define ACPI_INIT_DEVICE_INI        1
1070 
1071 typedef
1072 acpi_status (*acpi_exception_handler) (acpi_status aml_status,
1073                        acpi_name name,
1074                        u16 opcode,
1075                        u32 aml_offset, void *context);
1076 
1077 /* Table Event handler (Load, load_table, etc.) and types */
1078 
1079 typedef
1080 acpi_status (*acpi_table_handler) (u32 event, void *table, void *context);
1081 
1082 /* Table Event Types */
1083 
1084 #define ACPI_TABLE_EVENT_LOAD           0x0
1085 #define ACPI_TABLE_EVENT_UNLOAD         0x1
1086 #define ACPI_TABLE_EVENT_INSTALL        0x2
1087 #define ACPI_TABLE_EVENT_UNINSTALL      0x3
1088 #define ACPI_NUM_TABLE_EVENTS           4
1089 
1090 /* Address Spaces (For Operation Regions) */
1091 
1092 typedef
1093 acpi_status (*acpi_adr_space_handler) (u32 function,
1094                        acpi_physical_address address,
1095                        u32 bit_width,
1096                        u64 *value,
1097                        void *handler_context,
1098                        void *region_context);
1099 
1100 #define ACPI_DEFAULT_HANDLER            NULL
1101 
1102 /* Special Context data for generic_serial_bus/general_purpose_io (ACPI 5.0) */
1103 
1104 struct acpi_connection_info {
1105     u8 *connection;
1106     u16 length;
1107     u8 access_length;
1108 };
1109 
1110 /* Special Context data for PCC Opregion (ACPI 6.3) */
1111 
1112 struct acpi_pcc_info {
1113     u8 subspace_id;
1114     u16 length;
1115     u8 *internal_buffer;
1116 };
1117 
1118 typedef
1119 acpi_status (*acpi_adr_space_setup) (acpi_handle region_handle,
1120                      u32 function,
1121                      void *handler_context,
1122                      void **region_context);
1123 
1124 #define ACPI_REGION_ACTIVATE    0
1125 #define ACPI_REGION_DEACTIVATE  1
1126 
1127 typedef
1128 acpi_status (*acpi_walk_callback) (acpi_handle object,
1129                    u32 nesting_level,
1130                    void *context, void **return_value);
1131 
1132 typedef
1133 u32 (*acpi_interface_handler) (acpi_string interface_name, u32 supported);
1134 
1135 /* Interrupt handler return values */
1136 
1137 #define ACPI_INTERRUPT_NOT_HANDLED      0x00
1138 #define ACPI_INTERRUPT_HANDLED          0x01
1139 
1140 /* GPE handler return values */
1141 
1142 #define ACPI_REENABLE_GPE               0x80
1143 
1144 /* Length of 32-bit EISAID values when converted back to a string */
1145 
1146 #define ACPI_EISAID_STRING_SIZE         8   /* Includes null terminator */
1147 
1148 /* Length of UUID (string) values */
1149 
1150 #define ACPI_UUID_LENGTH                16
1151 
1152 /* Length of 3-byte PCI class code values when converted back to a string */
1153 
1154 #define ACPI_PCICLS_STRING_SIZE         7   /* Includes null terminator */
1155 
1156 /* Structures used for device/processor HID, UID, CID */
1157 
1158 struct acpi_pnp_device_id {
1159     u32 length;     /* Length of string + null */
1160     char *string;
1161 };
1162 
1163 struct acpi_pnp_device_id_list {
1164     u32 count;      /* Number of IDs in Ids array */
1165     u32 list_size;      /* Size of list, including ID strings */
1166     struct acpi_pnp_device_id ids[];    /* ID array */
1167 };
1168 
1169 /*
1170  * Structure returned from acpi_get_object_info.
1171  * Optimized for both 32-bit and 64-bit builds.
1172  */
1173 struct acpi_device_info {
1174     u32 info_size;      /* Size of info, including ID strings */
1175     u32 name;       /* ACPI object Name */
1176     acpi_object_type type;  /* ACPI object Type */
1177     u8 param_count;     /* If a method, required parameter count */
1178     u16 valid;      /* Indicates which optional fields are valid */
1179     u8 flags;       /* Miscellaneous info */
1180     u8 highest_dstates[4];  /* _sx_d values: 0xFF indicates not valid */
1181     u8 lowest_dstates[5];   /* _sx_w values: 0xFF indicates not valid */
1182     u64 address;    /* _ADR value */
1183     struct acpi_pnp_device_id hardware_id;  /* _HID value */
1184     struct acpi_pnp_device_id unique_id;    /* _UID value */
1185     struct acpi_pnp_device_id class_code;   /* _CLS value */
1186     struct acpi_pnp_device_id_list compatible_id_list;  /* _CID list <must be last> */
1187 };
1188 
1189 /* Values for Flags field above (acpi_get_object_info) */
1190 
1191 #define ACPI_PCI_ROOT_BRIDGE            0x01
1192 
1193 /* Flags for Valid field above (acpi_get_object_info) */
1194 
1195 #define ACPI_VALID_ADR                  0x0002
1196 #define ACPI_VALID_HID                  0x0004
1197 #define ACPI_VALID_UID                  0x0008
1198 #define ACPI_VALID_CID                  0x0020
1199 #define ACPI_VALID_CLS                  0x0040
1200 #define ACPI_VALID_SXDS                 0x0100
1201 #define ACPI_VALID_SXWS                 0x0200
1202 
1203 /* Flags for _STA method */
1204 
1205 #define ACPI_STA_DEVICE_PRESENT         0x01
1206 #define ACPI_STA_DEVICE_ENABLED         0x02
1207 #define ACPI_STA_DEVICE_UI              0x04
1208 #define ACPI_STA_DEVICE_FUNCTIONING     0x08
1209 #define ACPI_STA_DEVICE_OK              0x08    /* Synonym */
1210 #define ACPI_STA_BATTERY_PRESENT        0x10
1211 
1212 /* Context structs for address space handlers */
1213 
1214 struct acpi_pci_id {
1215     u16 segment;
1216     u16 bus;
1217     u16 device;
1218     u16 function;
1219 };
1220 
1221 struct acpi_mem_mapping {
1222     acpi_physical_address physical_address;
1223     u8 *logical_address;
1224     acpi_size length;
1225     struct acpi_mem_mapping *next_mm;
1226 };
1227 
1228 struct acpi_mem_space_context {
1229     u32 length;
1230     acpi_physical_address address;
1231     struct acpi_mem_mapping *cur_mm;
1232     struct acpi_mem_mapping *first_mm;
1233 };
1234 
1235 struct acpi_data_table_space_context {
1236     void *pointer;
1237 };
1238 
1239 /*
1240  * struct acpi_memory_list is used only if the ACPICA local cache is enabled
1241  */
1242 struct acpi_memory_list {
1243     const char *list_name;
1244     void *list_head;
1245     u16 object_size;
1246     u16 max_depth;
1247     u16 current_depth;
1248 
1249 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
1250 
1251     /* Statistics for debug memory tracking only */
1252 
1253     u32 total_allocated;
1254     u32 total_freed;
1255     u32 max_occupied;
1256     u32 total_size;
1257     u32 current_total_size;
1258     u32 requests;
1259     u32 hits;
1260 #endif
1261 };
1262 
1263 /* Definitions of trace event types */
1264 
1265 typedef enum {
1266     ACPI_TRACE_AML_METHOD,
1267     ACPI_TRACE_AML_OPCODE,
1268     ACPI_TRACE_AML_REGION
1269 } acpi_trace_event_type;
1270 
1271 /* Definitions of _OSI support */
1272 
1273 #define ACPI_VENDOR_STRINGS                 0x01
1274 #define ACPI_FEATURE_STRINGS                0x02
1275 #define ACPI_ENABLE_INTERFACES              0x00
1276 #define ACPI_DISABLE_INTERFACES             0x04
1277 
1278 #define ACPI_DISABLE_ALL_VENDOR_STRINGS     (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS)
1279 #define ACPI_DISABLE_ALL_FEATURE_STRINGS    (ACPI_DISABLE_INTERFACES | ACPI_FEATURE_STRINGS)
1280 #define ACPI_DISABLE_ALL_STRINGS            (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS)
1281 #define ACPI_ENABLE_ALL_VENDOR_STRINGS      (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS)
1282 #define ACPI_ENABLE_ALL_FEATURE_STRINGS     (ACPI_ENABLE_INTERFACES | ACPI_FEATURE_STRINGS)
1283 #define ACPI_ENABLE_ALL_STRINGS             (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS)
1284 
1285 #define ACPI_OSI_WIN_2000               0x01
1286 #define ACPI_OSI_WIN_XP                 0x02
1287 #define ACPI_OSI_WIN_XP_SP1             0x03
1288 #define ACPI_OSI_WINSRV_2003            0x04
1289 #define ACPI_OSI_WIN_XP_SP2             0x05
1290 #define ACPI_OSI_WINSRV_2003_SP1        0x06
1291 #define ACPI_OSI_WIN_VISTA              0x07
1292 #define ACPI_OSI_WINSRV_2008            0x08
1293 #define ACPI_OSI_WIN_VISTA_SP1          0x09
1294 #define ACPI_OSI_WIN_VISTA_SP2          0x0A
1295 #define ACPI_OSI_WIN_7                  0x0B
1296 #define ACPI_OSI_WIN_8                  0x0C
1297 #define ACPI_OSI_WIN_8_1                0x0D
1298 #define ACPI_OSI_WIN_10                 0x0E
1299 #define ACPI_OSI_WIN_10_RS1             0x0F
1300 #define ACPI_OSI_WIN_10_RS2             0x10
1301 #define ACPI_OSI_WIN_10_RS3             0x11
1302 #define ACPI_OSI_WIN_10_RS4             0x12
1303 #define ACPI_OSI_WIN_10_RS5             0x13
1304 #define ACPI_OSI_WIN_10_19H1            0x14
1305 #define ACPI_OSI_WIN_10_20H1            0x15
1306 #define ACPI_OSI_WIN_11                 0x16
1307 
1308 /* Definitions of getopt */
1309 
1310 #define ACPI_OPT_END                    -1
1311 
1312 /* Definitions for explicit fallthrough */
1313 
1314 #ifndef ACPI_FALLTHROUGH
1315 #define ACPI_FALLTHROUGH do {} while(0)
1316 #endif
1317 
1318 #endif              /* __ACTYPES_H__ */