actypes.h 41.5 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7
/******************************************************************************
 *
 * Name: actypes.h - Common data types for the entire ACPI subsystem
 *
 *****************************************************************************/

/*
8
 * Copyright (C) 2000 - 2015, Intel Corp.
L
Linus Torvalds 已提交
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions, and the following disclaimer,
 *    without modification.
 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 *    substantially similar to the "NO WARRANTY" disclaimer below
 *    ("Disclaimer") and any redistribution must be conditioned upon
 *    including a substantially similar Disclaimer requirement for further
 *    binary redistribution.
 * 3. Neither the names of the above-listed copyright holders nor the names
 *    of any contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * NO WARRANTY
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGES.
 */

#ifndef __ACTYPES_H__
#define __ACTYPES_H__

B
Bob Moore 已提交
47 48
/* acpisrc:struct_defs -- for acpisrc conversion */

B
Bob Moore 已提交
49 50
/*
 * ACPI_MACHINE_WIDTH must be specified in an OS- or compiler-dependent header
B
Bob Moore 已提交
51 52
 * and must be either 32 or 64. 16-bit ACPICA is no longer supported, as of
 * 12/2006.
B
Bob Moore 已提交
53 54 55 56 57
 */
#ifndef ACPI_MACHINE_WIDTH
#error ACPI_MACHINE_WIDTH not defined
#endif

L
Linus Torvalds 已提交
58 59 60 61 62 63
/*
 * Data type ranges
 * Note: These macros are designed to be compiler independent as well as
 * working around problems that some 32-bit compilers have with 64-bit
 * constants.
 */
64 65 66 67
#define ACPI_UINT8_MAX                  (u8) (~((u8)  0))	/* 0xFF               */
#define ACPI_UINT16_MAX                 (u16)(~((u16) 0))	/* 0xFFFF             */
#define ACPI_UINT32_MAX                 (u32)(~((u32) 0))	/* 0xFFFFFFFF         */
#define ACPI_UINT64_MAX                 (u64)(~((u64) 0))	/* 0xFFFFFFFFFFFFFFFF */
L
Linus Torvalds 已提交
68 69 70
#define ACPI_ASCII_MAX                  0x7F

/*
B
Bob Moore 已提交
71 72 73 74 75 76 77
 * Architecture-specific ACPICA Subsystem Data Types
 *
 * The goal of these types is to provide source code portability across
 * 16-bit, 32-bit, and 64-bit targets.
 *
 * 1) The following types are of fixed size for all targets (16/32/64):
 *
78
 * u8           Logical boolean
B
Bob Moore 已提交
79
 *
80 81 82 83
 * u8           8-bit  (1 byte) unsigned value
 * u16          16-bit (2 byte) unsigned value
 * u32          32-bit (4 byte) unsigned value
 * u64          64-bit (8 byte) unsigned value
B
Bob Moore 已提交
84
 *
85 86 87
 * s16          16-bit (2 byte) signed value
 * s32          32-bit (4 byte) signed value
 * s64          64-bit (8 byte) signed value
B
Bob Moore 已提交
88
 *
89
 * COMPILER_DEPENDENT_UINT64/s64 - These types are defined in the
B
Bob Moore 已提交
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
 * compiler-dependent header(s) and were introduced because there is no common
 * 64-bit integer type across the various compilation models, as shown in
 * the table below.
 *
 * Datatype  LP64 ILP64 LLP64 ILP32 LP32 16bit
 * char      8    8     8     8     8    8
 * short     16   16    16    16    16   16
 * _int32         32
 * int       32   64    32    32    16   16
 * long      64   64    32    32    32   32
 * long long            64    64
 * pointer   64   64    64    32    32   32
 *
 * Note: ILP64 and LP32 are currently not supported.
 *
 *
 * 2) These types represent the native word size of the target mode of the
 * processor, and may be 16-bit, 32-bit, or 64-bit as required. They are
 * usually used for memory allocation, efficient loop counters, and array
 * indexes. The types are similar to the size_t type in the C library and are
 * required because there is no C type that consistently represents the native
111
 * data width. acpi_size is needed because there is no guarantee that a
112
 * kernel-level C library is present.
B
Bob Moore 已提交
113
 *
114 115
 * acpi_size        16/32/64-bit unsigned value
 * acpi_native_int  16/32/64-bit signed value
L
Linus Torvalds 已提交
116 117
 */

B
Bob Moore 已提交
118
/*******************************************************************************
L
Linus Torvalds 已提交
119
 *
B
Bob Moore 已提交
120 121 122 123
 * Common types for all compilers, all targets
 *
 ******************************************************************************/

124 125 126 127 128
#ifndef ACPI_USE_SYSTEM_INTTYPES

typedef unsigned char u8;
typedef unsigned char u8;
typedef unsigned short u16;
129
typedef short s16;
130 131
typedef COMPILER_DEPENDENT_UINT64 u64;
typedef COMPILER_DEPENDENT_INT64 s64;
L
Linus Torvalds 已提交
132

133
#endif				/* ACPI_USE_SYSTEM_INTTYPES */
B
Bob Moore 已提交
134

135 136 137 138 139 140 141 142 143 144
/*
 * Value returned by acpi_os_get_thread_id. There is no standard "thread_id"
 * across operating systems or even the various UNIX systems. Since ACPICA
 * only needs the thread ID as a unique thread identifier, we use a u64
 * as the only common data type - it will accommodate any type of pointer or
 * any type of integer. It is up to the host-dependent OSL to cast the
 * native thread ID type to a u64 (in acpi_os_get_thread_id).
 */
#define acpi_thread_id                  u64

B
Bob Moore 已提交
145 146 147 148 149
/*******************************************************************************
 *
 * Types specific to 64-bit targets
 *
 ******************************************************************************/
L
Linus Torvalds 已提交
150 151 152

#if ACPI_MACHINE_WIDTH == 64

153
#ifndef ACPI_USE_SYSTEM_INTTYPES
L
Linus Torvalds 已提交
154

155 156
typedef unsigned int u32;
typedef int s32;
L
Linus Torvalds 已提交
157

158
#endif				/* ACPI_USE_SYSTEM_INTTYPES */
L
Linus Torvalds 已提交
159

B
Bob Moore 已提交
160 161
typedef s64 acpi_native_int;

162
typedef u64 acpi_size;
L
Len Brown 已提交
163 164
typedef u64 acpi_io_address;
typedef u64 acpi_physical_address;
L
Linus Torvalds 已提交
165 166 167 168

#define ACPI_MAX_PTR                    ACPI_UINT64_MAX
#define ACPI_SIZE_MAX                   ACPI_UINT64_MAX

B
Bob Moore 已提交
169 170
#define ACPI_USE_NATIVE_DIVIDE	/* Has native 64-bit integer support */

B
Bob Moore 已提交
171 172 173 174 175 176
/*
 * In the case of the Itanium Processor Family (IPF), the hardware does not
 * support misaligned memory transfers. Set the MISALIGNMENT_NOT_SUPPORTED flag
 * to indicate that special precautions must be taken to avoid alignment faults.
 * (IA64 or ia64 is currently used by existing compilers to indicate IPF.)
 *
177
 * Note: EM64T and other X86-64 processors support misaligned transfers,
B
Bob Moore 已提交
178 179 180 181 182 183
 * so there is no need to define this flag.
 */
#if defined (__IA64__) || defined (__ia64__)
#define ACPI_MISALIGNMENT_NOT_SUPPORTED
#endif

B
Bob Moore 已提交
184 185 186 187 188 189 190 191
/*******************************************************************************
 *
 * Types specific to 32-bit targets
 *
 ******************************************************************************/

#elif ACPI_MACHINE_WIDTH == 32

192
#ifndef ACPI_USE_SYSTEM_INTTYPES
B
Bob Moore 已提交
193

194 195
typedef unsigned int u32;
typedef int s32;
B
Bob Moore 已提交
196

197
#endif				/* ACPI_USE_SYSTEM_INTTYPES */
B
Bob Moore 已提交
198 199 200

typedef s32 acpi_native_int;

201
typedef u32 acpi_size;
202 203 204 205 206 207 208 209

#ifdef ACPI_32BIT_PHYSICAL_ADDRESS

/*
 * OSPMs can define this to shrink the size of the structures for 32-bit
 * none PAE environment. ASL compiler may always define this to generate
 * 32-bit OSPM compliant tables.
 */
B
Bob Moore 已提交
210
typedef u32 acpi_io_address;
211
typedef u32 acpi_physical_address;
B
Bob Moore 已提交
212

213 214 215 216 217 218 219 220 221 222 223 224
#else				/* ACPI_32BIT_PHYSICAL_ADDRESS */

/*
 * It is reported that, after some calculations, the physical addresses can
 * wrap over the 32-bit boundary on 32-bit PAE environment.
 * https://bugzilla.kernel.org/show_bug.cgi?id=87971
 */
typedef u64 acpi_io_address;
typedef u64 acpi_physical_address;

#endif				/* ACPI_32BIT_PHYSICAL_ADDRESS */

B
Bob Moore 已提交
225 226 227 228
#define ACPI_MAX_PTR                    ACPI_UINT32_MAX
#define ACPI_SIZE_MAX                   ACPI_UINT32_MAX

#else
L
Linus Torvalds 已提交
229

B
Bob Moore 已提交
230
/* ACPI_MACHINE_WIDTH must be either 64 or 32 */
L
Linus Torvalds 已提交
231

B
Bob Moore 已提交
232 233
#error unknown ACPI_MACHINE_WIDTH
#endif
L
Linus Torvalds 已提交
234

B
Bob Moore 已提交
235 236
/*******************************************************************************
 *
237
 * OS-dependent types
B
Bob Moore 已提交
238
 *
B
Bob Moore 已提交
239
 * If the defaults below are not appropriate for the host system, they can
240
 * be defined in the OS-specific header, and this will take precedence.
B
Bob Moore 已提交
241
 *
B
Bob Moore 已提交
242
 ******************************************************************************/
L
Linus Torvalds 已提交
243

B
Bob Moore 已提交
244 245
/* Flags for acpi_os_acquire_lock/acpi_os_release_lock */

B
Bob Moore 已提交
246
#ifndef acpi_cpu_flags
247
#define acpi_cpu_flags			acpi_size
B
Bob Moore 已提交
248
#endif
B
Bob Moore 已提交
249

B
Bob Moore 已提交
250 251 252
/* Object returned from acpi_os_create_cache */

#ifndef acpi_cache_t
253
#ifdef ACPI_USE_LOCAL_CACHE
B
Bob Moore 已提交
254
#define acpi_cache_t                    struct acpi_memory_list
255 256 257
#else
#define acpi_cache_t                    void *
#endif
B
Bob Moore 已提交
258 259
#endif

260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
/*
 * Synchronization objects - Mutexes, Semaphores, and spin_locks
 */
#if (ACPI_MUTEX_TYPE == ACPI_BINARY_SEMAPHORE)
/*
 * These macros are used if the host OS does not support a mutex object.
 * Map the OSL Mutex interfaces to binary semaphores.
 */
#define acpi_mutex                      acpi_semaphore
#define acpi_os_create_mutex(out_handle) acpi_os_create_semaphore (1, 1, out_handle)
#define acpi_os_delete_mutex(handle)    (void) acpi_os_delete_semaphore (handle)
#define acpi_os_acquire_mutex(handle,time) acpi_os_wait_semaphore (handle, 1, time)
#define acpi_os_release_mutex(handle)   (void) acpi_os_signal_semaphore (handle, 1)
#endif

/* Configurable types for synchronization objects */

#ifndef acpi_spinlock
#define acpi_spinlock                   void *
#endif

#ifndef acpi_semaphore
#define acpi_semaphore                  void *
#endif

#ifndef acpi_mutex
#define acpi_mutex                      void *
#endif

/*******************************************************************************
 *
 * Compiler-dependent types
 *
 * If the defaults below are not appropriate for the host compiler, they can
 * be defined in the compiler-specific header, and this will take precedence.
 *
 ******************************************************************************/

B
Bob Moore 已提交
298 299 300 301 302 303
/* Use C99 uintptr_t for pointer casting if available, "void *" otherwise */

#ifndef acpi_uintptr_t
#define acpi_uintptr_t                  void *
#endif

B
Bob Moore 已提交
304 305 306 307 308 309 310 311 312 313 314
/*
 * ACPI_PRINTF_LIKE is used to tag functions as "printf-like" because
 * some compilers can catch printf format string problems
 */
#ifndef ACPI_PRINTF_LIKE
#define ACPI_PRINTF_LIKE(c)
#endif

/*
 * Some compilers complain about unused variables. Sometimes we don't want to
 * use all the variables (for example, _acpi_module_name). This allows us
315
 * to tell the compiler in a per-variable manner that a variable
B
Bob Moore 已提交
316 317 318 319 320
 * is unused
 */
#ifndef ACPI_UNUSED_VAR
#define ACPI_UNUSED_VAR
#endif
B
Bob Moore 已提交
321

B
Bob Moore 已提交
322
/*
323 324 325 326 327 328 329
 * All ACPICA external functions that are available to the rest of the kernel
 * are tagged with thes macros which can be defined as appropriate for the host.
 *
 * Notes:
 * ACPI_EXPORT_SYMBOL_INIT is used for initialization and termination
 * interfaces that may need special processing.
 * ACPI_EXPORT_SYMBOL is used for all other public external functions.
B
Bob Moore 已提交
330
 */
331 332 333 334
#ifndef ACPI_EXPORT_SYMBOL_INIT
#define ACPI_EXPORT_SYMBOL_INIT(symbol)
#endif

B
Bob Moore 已提交
335 336 337 338
#ifndef ACPI_EXPORT_SYMBOL
#define ACPI_EXPORT_SYMBOL(symbol)
#endif

339 340 341 342 343 344 345 346
/*
 * Compiler/Clibrary-dependent debug initialization. Used for ACPICA
 * utilities only.
 */
#ifndef ACPI_DEBUG_INITIALIZE
#define ACPI_DEBUG_INITIALIZE()
#endif

347 348 349 350 351 352
/*******************************************************************************
 *
 * Configuration
 *
 ******************************************************************************/

353 354 355 356 357 358 359 360 361
#ifdef ACPI_NO_MEM_ALLOCATIONS

#define ACPI_ALLOCATE(a)                NULL
#define ACPI_ALLOCATE_ZEROED(a)         NULL
#define ACPI_FREE(a)
#define ACPI_MEM_TRACKING(a)

#else				/* ACPI_NO_MEM_ALLOCATIONS */

362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
#ifdef ACPI_DBG_TRACK_ALLOCATIONS
/*
 * Memory allocation tracking (used by acpi_exec to detect memory leaks)
 */
#define ACPI_MEM_PARAMETERS             _COMPONENT, _acpi_module_name, __LINE__
#define ACPI_ALLOCATE(a)                acpi_ut_allocate_and_track ((acpi_size) (a), ACPI_MEM_PARAMETERS)
#define ACPI_ALLOCATE_ZEROED(a)         acpi_ut_allocate_zeroed_and_track ((acpi_size) (a), ACPI_MEM_PARAMETERS)
#define ACPI_FREE(a)                    acpi_ut_free_and_track (a, ACPI_MEM_PARAMETERS)
#define ACPI_MEM_TRACKING(a)            a

#else
/*
 * Normal memory allocation directly via the OS services layer
 */
#define ACPI_ALLOCATE(a)                acpi_os_allocate ((acpi_size) (a))
#define ACPI_ALLOCATE_ZEROED(a)         acpi_os_allocate_zeroed ((acpi_size) (a))
#define ACPI_FREE(a)                    acpi_os_free (a)
#define ACPI_MEM_TRACKING(a)

#endif				/* ACPI_DBG_TRACK_ALLOCATIONS */

383 384
#endif				/* ACPI_NO_MEM_ALLOCATIONS */

385 386 387 388 389 390
/******************************************************************************
 *
 * ACPI Specification constants (Do not change unless the specification changes)
 *
 *****************************************************************************/

B
Bob Moore 已提交
391
/* Number of distinct FADT-based GPE register blocks (GPE0 and GPE1) */
392 393

#define ACPI_MAX_GPE_BLOCKS             2
B
Bob Moore 已提交
394 395 396

/* Default ACPI register widths */

397
#define ACPI_GPE_REGISTER_WIDTH         8
B
Bob Moore 已提交
398 399 400
#define ACPI_PM1_REGISTER_WIDTH         16
#define ACPI_PM2_REGISTER_WIDTH         8
#define ACPI_PM_TIMER_WIDTH             32
401
#define ACPI_RESET_REGISTER_WIDTH       8
402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420

/* Names within the namespace are 4 bytes long */

#define ACPI_NAME_SIZE                  4
#define ACPI_PATH_SEGMENT_LENGTH        5	/* 4 chars for name + 1 char for separator */
#define ACPI_PATH_SEPARATOR             '.'

/* Sizes for ACPI table headers */

#define ACPI_OEM_ID_SIZE                6
#define ACPI_OEM_TABLE_ID_SIZE          8

/* ACPI/PNP hardware IDs */

#define PCI_ROOT_HID_STRING             "PNP0A03"
#define PCI_EXPRESS_ROOT_HID_STRING     "PNP0A08"

/* PM Timer ticks per second (HZ) */

421
#define ACPI_PM_TIMER_FREQUENCY         3579545
422

B
Bob Moore 已提交
423 424 425 426 427
/*******************************************************************************
 *
 * Independent types
 *
 ******************************************************************************/
L
Linus Torvalds 已提交
428

B
Bob Moore 已提交
429
/* Logical defines and NULL */
L
Linus Torvalds 已提交
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445

#ifdef FALSE
#undef FALSE
#endif
#define FALSE                           (1 == 0)

#ifdef TRUE
#undef TRUE
#endif
#define TRUE                            (1 == 1)

#ifndef NULL
#define NULL                            (void *) 0
#endif

/*
446
 * Miscellaneous types
L
Linus Torvalds 已提交
447
 */
L
Len Brown 已提交
448 449 450
typedef u32 acpi_status;	/* All ACPI Exceptions */
typedef u32 acpi_name;		/* 4-byte ACPI name */
typedef char *acpi_string;	/* Null terminated ASCII string */
B
Bob Moore 已提交
451
typedef void *acpi_handle;	/* Actually a ptr to a NS Node */
L
Len Brown 已提交
452

453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
/* Time constants for timer calculations */

#define ACPI_MSEC_PER_SEC               1000L

#define ACPI_USEC_PER_MSEC              1000L
#define ACPI_USEC_PER_SEC               1000000L

#define ACPI_100NSEC_PER_USEC           10L
#define ACPI_100NSEC_PER_MSEC           10000L
#define ACPI_100NSEC_PER_SEC            10000000L

#define ACPI_NSEC_PER_USEC              1000L
#define ACPI_NSEC_PER_MSEC              1000000L
#define ACPI_NSEC_PER_SEC               1000000000L

468 469 470 471 472
/* Owner IDs are used to track namespace nodes for selective deletion */

typedef u8 acpi_owner_id;
#define ACPI_OWNER_ID_MAX               0xFF

L
Linus Torvalds 已提交
473
#define ACPI_INTEGER_BIT_SIZE           64
L
Len Brown 已提交
474
#define ACPI_MAX_DECIMAL_DIGITS         20	/* 2^64 = 18,446,744,073,709,551,616 */
L
Linus Torvalds 已提交
475 476

#if ACPI_MACHINE_WIDTH == 64
L
Len Brown 已提交
477
#define ACPI_USE_NATIVE_DIVIDE	/* Use compiler native 64-bit divide */
L
Linus Torvalds 已提交
478 479 480 481 482 483 484 485 486 487
#endif

#define ACPI_MAX64_DECIMAL_DIGITS       20
#define ACPI_MAX32_DECIMAL_DIGITS       10
#define ACPI_MAX16_DECIMAL_DIGITS        5
#define ACPI_MAX8_DECIMAL_DIGITS         3

/*
 * Constants with special meanings
 */
B
Bob Moore 已提交
488
#define ACPI_ROOT_OBJECT                ACPI_ADD_PTR (acpi_handle, NULL, ACPI_MAX_PTR)
489 490 491
#define ACPI_WAIT_FOREVER               0xFFFF	/* u16, as per ACPI spec */
#define ACPI_DO_NOT_WAIT                0

492 493 494 495 496 497 498 499 500 501 502 503 504
/*
 * Obsolete: Acpi integer width. In ACPI version 1 (1996), integers are 32 bits.
 * In ACPI version 2 (2000) and later, integers are 64 bits. Note that this
 * pertains to the ACPI integer type only, not to other integers used in the
 * implementation of the ACPICA subsystem.
 *
 * 01/2010: This type is obsolete and has been removed from the entire ACPICA
 * code base. It remains here for compatibility with device drivers that use
 * the type. However, it will be removed in the future.
 */
typedef u64 acpi_integer;
#define ACPI_INTEGER_MAX                ACPI_UINT64_MAX

505 506 507 508 509 510 511 512
/*******************************************************************************
 *
 * Commonly used macros
 *
 ******************************************************************************/

/* Data manipulation */

513 514 515 516 517 518
#define ACPI_LOBYTE(integer)            ((u8)   (u16)(integer))
#define ACPI_HIBYTE(integer)            ((u8) (((u16)(integer)) >> 8))
#define ACPI_LOWORD(integer)            ((u16)  (u32)(integer))
#define ACPI_HIWORD(integer)            ((u16)(((u32)(integer)) >> 16))
#define ACPI_LODWORD(integer64)         ((u32)  (u64)(integer64))
#define ACPI_HIDWORD(integer64)         ((u32)(((u64)(integer64)) >> 32))
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539

#define ACPI_SET_BIT(target,bit)        ((target) |= (bit))
#define ACPI_CLEAR_BIT(target,bit)      ((target) &= ~(bit))
#define ACPI_MIN(a,b)                   (((a)<(b))?(a):(b))
#define ACPI_MAX(a,b)                   (((a)>(b))?(a):(b))

/* Size calculation */

#define ACPI_ARRAY_LENGTH(x)            (sizeof(x) / sizeof((x)[0]))

/* Pointer manipulation */

#define ACPI_CAST_PTR(t, p)             ((t *) (acpi_uintptr_t) (p))
#define ACPI_CAST_INDIRECT_PTR(t, p)    ((t **) (acpi_uintptr_t) (p))
#define ACPI_ADD_PTR(t, a, b)           ACPI_CAST_PTR (t, (ACPI_CAST_PTR (u8, (a)) + (acpi_size)(b)))
#define ACPI_PTR_DIFF(a, b)             (acpi_size) (ACPI_CAST_PTR (u8, (a)) - ACPI_CAST_PTR (u8, (b)))

/* Pointer/Integer type conversions */

#define ACPI_TO_POINTER(i)              ACPI_ADD_PTR (void, (void *) NULL,(acpi_size) i)
#define ACPI_TO_INTEGER(p)              ACPI_PTR_DIFF (p, (void *) NULL)
540
#define ACPI_OFFSET(d, f)               ACPI_PTR_DIFF (&(((d *) 0)->f), (void *) NULL)
541 542 543
#define ACPI_PHYSADDR_TO_PTR(i)         ACPI_TO_POINTER(i)
#define ACPI_PTR_TO_PHYSADDR(i)         ACPI_TO_INTEGER(i)

544 545
/* Optimizations for 4-character (32-bit) acpi_name manipulation */

546 547
#ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
#define ACPI_COMPARE_NAME(a,b)          (*ACPI_CAST_PTR (u32, (a)) == *ACPI_CAST_PTR (u32, (b)))
548
#define ACPI_MOVE_NAME(dest,src)        (*ACPI_CAST_PTR (u32, (dest)) = *ACPI_CAST_PTR (u32, (src)))
549 550
#else
#define ACPI_COMPARE_NAME(a,b)          (!ACPI_STRNCMP (ACPI_CAST_PTR (char, (a)), ACPI_CAST_PTR (char, (b)), ACPI_NAME_SIZE))
551
#define ACPI_MOVE_NAME(dest,src)        (ACPI_STRNCPY (ACPI_CAST_PTR (char, (dest)), ACPI_CAST_PTR (char, (src)), ACPI_NAME_SIZE))
552 553
#endif

554 555 556 557 558
/* Support for the special RSDP signature (8 characters) */

#define ACPI_VALIDATE_RSDP_SIG(a)       (!ACPI_STRNCMP (ACPI_CAST_PTR (char, (a)), ACPI_SIG_RSDP, 8))
#define ACPI_MAKE_RSDP_SIG(dest)        (ACPI_MEMCPY (ACPI_CAST_PTR (char, (dest)), ACPI_SIG_RSDP, 8))

559 560 561 562 563
/*******************************************************************************
 *
 * Miscellaneous constants
 *
 ******************************************************************************/
L
Linus Torvalds 已提交
564 565 566 567 568 569

/*
 * Initialization sequence
 */
#define ACPI_FULL_INITIALIZATION        0x00
#define ACPI_NO_ADDRESS_SPACE_INIT      0x01
570
#define ACPI_NO_HARDWARE_INIT           0x02
L
Linus Torvalds 已提交
571 572 573 574 575 576 577 578 579
#define ACPI_NO_EVENT_INIT              0x04
#define ACPI_NO_HANDLER_INIT            0x08
#define ACPI_NO_ACPI_ENABLE             0x10
#define ACPI_NO_DEVICE_INIT             0x20
#define ACPI_NO_OBJECT_INIT             0x40

/*
 * Initialization state
 */
580 581
#define ACPI_SUBSYSTEM_INITIALIZE       0x01
#define ACPI_INITIALIZED_OK             0x02
L
Linus Torvalds 已提交
582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599

/*
 * Power state values
 */
#define ACPI_STATE_UNKNOWN              (u8) 0xFF

#define ACPI_STATE_S0                   (u8) 0
#define ACPI_STATE_S1                   (u8) 1
#define ACPI_STATE_S2                   (u8) 2
#define ACPI_STATE_S3                   (u8) 3
#define ACPI_STATE_S4                   (u8) 4
#define ACPI_STATE_S5                   (u8) 5
#define ACPI_S_STATES_MAX               ACPI_STATE_S5
#define ACPI_S_STATE_COUNT              6

#define ACPI_STATE_D0                   (u8) 0
#define ACPI_STATE_D1                   (u8) 1
#define ACPI_STATE_D2                   (u8) 2
L
Lin Ming 已提交
600 601 602 603
#define ACPI_STATE_D3_HOT               (u8) 3
#define ACPI_STATE_D3                   (u8) 4
#define ACPI_STATE_D3_COLD              ACPI_STATE_D3
#define ACPI_D_STATES_MAX               ACPI_STATE_D3
L
Lin Ming 已提交
604
#define ACPI_D_STATE_COUNT              5
L
Linus Torvalds 已提交
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621

#define ACPI_STATE_C0                   (u8) 0
#define ACPI_STATE_C1                   (u8) 1
#define ACPI_STATE_C2                   (u8) 2
#define ACPI_STATE_C3                   (u8) 3
#define ACPI_C_STATES_MAX               ACPI_STATE_C3
#define ACPI_C_STATE_COUNT              4

/*
 * Sleep type invalid value
 */
#define ACPI_SLEEP_TYPE_MAX             0x7
#define ACPI_SLEEP_TYPE_INVALID         0xFF

/*
 * Standard notify values
 */
Z
Zhang Rui 已提交
622 623 624 625 626 627 628 629 630 631 632 633
#define ACPI_NOTIFY_BUS_CHECK           (u8) 0x00
#define ACPI_NOTIFY_DEVICE_CHECK        (u8) 0x01
#define ACPI_NOTIFY_DEVICE_WAKE         (u8) 0x02
#define ACPI_NOTIFY_EJECT_REQUEST       (u8) 0x03
#define ACPI_NOTIFY_DEVICE_CHECK_LIGHT  (u8) 0x04
#define ACPI_NOTIFY_FREQUENCY_MISMATCH  (u8) 0x05
#define ACPI_NOTIFY_BUS_MODE_MISMATCH   (u8) 0x06
#define ACPI_NOTIFY_POWER_FAULT         (u8) 0x07
#define ACPI_NOTIFY_CAPABILITIES_CHECK  (u8) 0x08
#define ACPI_NOTIFY_DEVICE_PLD_CHECK    (u8) 0x09
#define ACPI_NOTIFY_RESERVED            (u8) 0x0A
#define ACPI_NOTIFY_LOCALITY_UPDATE     (u8) 0x0B
634
#define ACPI_NOTIFY_SHUTDOWN_REQUEST    (u8) 0x0C
635
#define ACPI_NOTIFY_AFFINITY_UPDATE     (u8) 0x0D
Z
Zhang Rui 已提交
636

637
#define ACPI_NOTIFY_MAX                 0x0D
L
Linus Torvalds 已提交
638 639

/*
640
 * Types associated with ACPI names and objects. The first group of
L
Linus Torvalds 已提交
641 642 643 644 645 646 647
 * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
 * of the ACPI object_type() operator (See the ACPI Spec). Therefore,
 * only add to the first group if the spec changes.
 *
 * NOTE: Types must be kept in sync with the global acpi_ns_properties
 * and acpi_ns_type_names arrays.
 */
L
Len Brown 已提交
648
typedef u32 acpi_object_type;
L
Linus Torvalds 已提交
649 650

#define ACPI_TYPE_ANY                   0x00
L
Len Brown 已提交
651
#define ACPI_TYPE_INTEGER               0x01	/* Byte/Word/Dword/Zero/One/Ones */
L
Linus Torvalds 已提交
652 653
#define ACPI_TYPE_STRING                0x02
#define ACPI_TYPE_BUFFER                0x03
L
Len Brown 已提交
654
#define ACPI_TYPE_PACKAGE               0x04	/* byte_const, multiple data_term/Constant/super_name */
L
Linus Torvalds 已提交
655
#define ACPI_TYPE_FIELD_UNIT            0x05
L
Len Brown 已提交
656
#define ACPI_TYPE_DEVICE                0x06	/* Name, multiple Node */
L
Linus Torvalds 已提交
657
#define ACPI_TYPE_EVENT                 0x07
L
Len Brown 已提交
658
#define ACPI_TYPE_METHOD                0x08	/* Name, byte_const, multiple Code */
L
Linus Torvalds 已提交
659 660
#define ACPI_TYPE_MUTEX                 0x09
#define ACPI_TYPE_REGION                0x0A
L
Len Brown 已提交
661 662 663
#define ACPI_TYPE_POWER                 0x0B	/* Name,byte_const,word_const,multi Node */
#define ACPI_TYPE_PROCESSOR             0x0C	/* Name,byte_const,Dword_const,byte_const,multi nm_o */
#define ACPI_TYPE_THERMAL               0x0D	/* Name, multiple Node */
L
Linus Torvalds 已提交
664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
#define ACPI_TYPE_BUFFER_FIELD          0x0E
#define ACPI_TYPE_DDB_HANDLE            0x0F
#define ACPI_TYPE_DEBUG_OBJECT          0x10

#define ACPI_TYPE_EXTERNAL_MAX          0x10

/*
 * These are object types that do not map directly to the ACPI
 * object_type() operator. They are used for various internal purposes only.
 * If new predefined ACPI_TYPEs are added (via the ACPI specification), these
 * internal types must move upwards. (There is code that depends on these
 * values being contiguous with the external types above.)
 */
#define ACPI_TYPE_LOCAL_REGION_FIELD    0x11
#define ACPI_TYPE_LOCAL_BANK_FIELD      0x12
#define ACPI_TYPE_LOCAL_INDEX_FIELD     0x13
L
Len Brown 已提交
680
#define ACPI_TYPE_LOCAL_REFERENCE       0x14	/* Arg#, Local#, Name, Debug, ref_of, Index */
L
Linus Torvalds 已提交
681 682 683 684 685 686
#define ACPI_TYPE_LOCAL_ALIAS           0x15
#define ACPI_TYPE_LOCAL_METHOD_ALIAS    0x16
#define ACPI_TYPE_LOCAL_NOTIFY          0x17
#define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
#define ACPI_TYPE_LOCAL_RESOURCE        0x19
#define ACPI_TYPE_LOCAL_RESOURCE_FIELD  0x1A
L
Len Brown 已提交
687
#define ACPI_TYPE_LOCAL_SCOPE           0x1B	/* 1 Name, multiple object_list Nodes */
L
Linus Torvalds 已提交
688

L
Len Brown 已提交
689
#define ACPI_TYPE_NS_NODE_MAX           0x1B	/* Last typecode used within a NS Node */
L
Linus Torvalds 已提交
690 691 692

/*
 * These are special object types that never appear in
L
Lv Zheng 已提交
693
 * a Namespace node, only in an object of union acpi_operand_object
L
Linus Torvalds 已提交
694 695 696 697 698 699 700 701 702 703 704
 */
#define ACPI_TYPE_LOCAL_EXTRA           0x1C
#define ACPI_TYPE_LOCAL_DATA            0x1D

#define ACPI_TYPE_LOCAL_MAX             0x1D

/* All types above here are invalid */

#define ACPI_TYPE_INVALID               0x1E
#define ACPI_TYPE_NOT_FOUND             0xFF

705 706
#define ACPI_NUM_NS_TYPES               (ACPI_TYPE_INVALID + 1)

L
Linus Torvalds 已提交
707 708 709 710 711 712 713 714 715 716
/*
 * All I/O
 */
#define ACPI_READ                       0
#define ACPI_WRITE                      1
#define ACPI_IO_MASK                    1

/*
 * Event Types: Fixed & General Purpose
 */
L
Len Brown 已提交
717
typedef u32 acpi_event_type;
L
Linus Torvalds 已提交
718 719 720 721 722 723 724 725 726 727 728 729 730

/*
 * Fixed events
 */
#define ACPI_EVENT_PMTIMER              0
#define ACPI_EVENT_GLOBAL               1
#define ACPI_EVENT_POWER_BUTTON         2
#define ACPI_EVENT_SLEEP_BUTTON         3
#define ACPI_EVENT_RTC                  4
#define ACPI_EVENT_MAX                  4
#define ACPI_NUM_FIXED_EVENTS           ACPI_EVENT_MAX + 1

/*
731
 * Event status - Per event
L
Linus Torvalds 已提交
732 733 734 735
 * -------------
 * The encoding of acpi_event_status is illustrated below.
 * Note that a set bit (1) indicates the property is TRUE
 * (e.g. if bit 0 is set then the event is enabled).
736 737 738 739 740 741 742 743 744 745
 * +-------------+-+-+-+-+-+
 * |   Bits 31:5 |4|3|2|1|0|
 * +-------------+-+-+-+-+-+
 *          |     | | | | |
 *          |     | | | | +- Enabled?
 *          |     | | | +--- Enabled for wake?
 *          |     | | +----- Status bit set?
 *          |     | +------- Enable bit set?
 *          |     +--------- Has a handler?
 *          +--------------- <Reserved>
L
Linus Torvalds 已提交
746
 */
L
Len Brown 已提交
747
typedef u32 acpi_event_status;
L
Linus Torvalds 已提交
748 749 750 751

#define ACPI_EVENT_FLAG_DISABLED        (acpi_event_status) 0x00
#define ACPI_EVENT_FLAG_ENABLED         (acpi_event_status) 0x01
#define ACPI_EVENT_FLAG_WAKE_ENABLED    (acpi_event_status) 0x02
752 753 754 755
#define ACPI_EVENT_FLAG_STATUS_SET      (acpi_event_status) 0x04
#define ACPI_EVENT_FLAG_ENABLE_SET      (acpi_event_status) 0x08
#define ACPI_EVENT_FLAG_HAS_HANDLER     (acpi_event_status) 0x10
#define ACPI_EVENT_FLAG_SET             ACPI_EVENT_FLAG_STATUS_SET
L
Linus Torvalds 已提交
756

L
Lv Zheng 已提交
757
/* Actions for acpi_set_gpe, acpi_gpe_wakeup, acpi_hw_low_set_gpe */
758

L
Linus Torvalds 已提交
759 760
#define ACPI_GPE_ENABLE                 0
#define ACPI_GPE_DISABLE                1
761
#define ACPI_GPE_CONDITIONAL_ENABLE     2
762 763 764 765
#define ACPI_GPE_SAVE_MASK              4

#define ACPI_GPE_ENABLE_SAVE            (ACPI_GPE_ENABLE | ACPI_GPE_SAVE_MASK)
#define ACPI_GPE_DISABLE_SAVE           (ACPI_GPE_DISABLE | ACPI_GPE_SAVE_MASK)
L
Linus Torvalds 已提交
766 767 768

/*
 * GPE info flags - Per GPE
L
Lin Ming 已提交
769
 * +-------+-+-+---+
770
 * |  7:5  |4|3|2:0|
L
Lin Ming 已提交
771 772 773 774 775 776 777 778 779 780 781
 * +-------+-+-+---+
 *     |    | |  |
 *     |    | |  +-- Type of dispatch:to method, handler, notify, or none
 *     |    | +----- Interrupt type: edge or level triggered
 *     |    +------- Is a Wake GPE
 *     +------------ <Reserved>
 */
#define ACPI_GPE_DISPATCH_NONE          (u8) 0x00
#define ACPI_GPE_DISPATCH_METHOD        (u8) 0x01
#define ACPI_GPE_DISPATCH_HANDLER       (u8) 0x02
#define ACPI_GPE_DISPATCH_NOTIFY        (u8) 0x03
782 783
#define ACPI_GPE_DISPATCH_RAW_HANDLER   (u8) 0x04
#define ACPI_GPE_DISPATCH_MASK          (u8) 0x07
784
#define ACPI_GPE_DISPATCH_TYPE(flags)   ((u8) ((flags) & ACPI_GPE_DISPATCH_MASK))
L
Lin Ming 已提交
785

786
#define ACPI_GPE_LEVEL_TRIGGERED        (u8) 0x08
L
Linus Torvalds 已提交
787
#define ACPI_GPE_EDGE_TRIGGERED         (u8) 0x00
788
#define ACPI_GPE_XRUPT_TYPE_MASK        (u8) 0x08
L
Linus Torvalds 已提交
789

790
#define ACPI_GPE_CAN_WAKE               (u8) 0x10
L
Linus Torvalds 已提交
791 792 793 794 795 796 797 798 799 800 801

/*
 * Flags for GPE and Lock interfaces
 */
#define ACPI_NOT_ISR                    0x1
#define ACPI_ISR                        0x0

/* Notify types */

#define ACPI_SYSTEM_NOTIFY              0x1
#define ACPI_DEVICE_NOTIFY              0x2
Z
Zhang Rui 已提交
802
#define ACPI_ALL_NOTIFY                 (ACPI_SYSTEM_NOTIFY | ACPI_DEVICE_NOTIFY)
L
Linus Torvalds 已提交
803
#define ACPI_MAX_NOTIFY_HANDLER_TYPE    0x3
804
#define ACPI_NUM_NOTIFY_TYPES           2
L
Linus Torvalds 已提交
805

806 807
#define ACPI_MAX_SYS_NOTIFY             0x7F
#define ACPI_MAX_DEVICE_SPECIFIC_NOTIFY 0xBF
L
Linus Torvalds 已提交
808

809 810 811
#define ACPI_SYSTEM_HANDLER_LIST        0	/* Used as index, must be SYSTEM_NOTIFY -1 */
#define ACPI_DEVICE_HANDLER_LIST        1	/* Used as index, must be DEVICE_NOTIFY -1 */

L
Linus Torvalds 已提交
812 813
/* Address Space (Operation Region) Types */

L
Len Brown 已提交
814
typedef u8 acpi_adr_space_type;
L
Linus Torvalds 已提交
815 816 817 818 819 820 821 822

#define ACPI_ADR_SPACE_SYSTEM_MEMORY    (acpi_adr_space_type) 0
#define ACPI_ADR_SPACE_SYSTEM_IO        (acpi_adr_space_type) 1
#define ACPI_ADR_SPACE_PCI_CONFIG       (acpi_adr_space_type) 2
#define ACPI_ADR_SPACE_EC               (acpi_adr_space_type) 3
#define ACPI_ADR_SPACE_SMBUS            (acpi_adr_space_type) 4
#define ACPI_ADR_SPACE_CMOS             (acpi_adr_space_type) 5
#define ACPI_ADR_SPACE_PCI_BAR_TARGET   (acpi_adr_space_type) 6
823
#define ACPI_ADR_SPACE_IPMI             (acpi_adr_space_type) 7
824 825
#define ACPI_ADR_SPACE_GPIO             (acpi_adr_space_type) 8
#define ACPI_ADR_SPACE_GSBUS            (acpi_adr_space_type) 9
826
#define ACPI_ADR_SPACE_PLATFORM_COMM    (acpi_adr_space_type) 10
827

828
#define ACPI_NUM_PREDEFINED_REGIONS     11
829

830
/*
831
 * Special Address Spaces
832 833 834 835 836 837 838 839
 *
 * Note: A Data Table region is a special type of operation region
 * that has its own AML opcode. However, internally, the AML
 * interpreter simply creates an operation region with an an address
 * space type of ACPI_ADR_SPACE_DATA_TABLE.
 */
#define ACPI_ADR_SPACE_DATA_TABLE       (acpi_adr_space_type) 0x7E	/* Internal to ACPICA only */
#define ACPI_ADR_SPACE_FIXED_HARDWARE   (acpi_adr_space_type) 0x7F
L
Linus Torvalds 已提交
840

841 842 843 844 845
/* Values for _REG connection code */

#define ACPI_REG_DISCONNECT             0
#define ACPI_REG_CONNECT                1

L
Linus Torvalds 已提交
846 847
/*
 * bit_register IDs
848 849 850 851 852
 *
 * These values are intended to be used by the hardware interfaces
 * and are mapped to individual bitfields defined within the ACPI
 * registers. See the acpi_gbl_bit_register_info global table in utglobal.c
 * for this mapping.
L
Linus Torvalds 已提交
853
 */
854 855 856

/* PM1 Status register */

L
Linus Torvalds 已提交
857 858 859 860 861 862 863 864 865
#define ACPI_BITREG_TIMER_STATUS                0x00
#define ACPI_BITREG_BUS_MASTER_STATUS           0x01
#define ACPI_BITREG_GLOBAL_LOCK_STATUS          0x02
#define ACPI_BITREG_POWER_BUTTON_STATUS         0x03
#define ACPI_BITREG_SLEEP_BUTTON_STATUS         0x04
#define ACPI_BITREG_RT_CLOCK_STATUS             0x05
#define ACPI_BITREG_WAKE_STATUS                 0x06
#define ACPI_BITREG_PCIEXP_WAKE_STATUS          0x07

866 867
/* PM1 Enable register */

L
Linus Torvalds 已提交
868 869 870 871 872
#define ACPI_BITREG_TIMER_ENABLE                0x08
#define ACPI_BITREG_GLOBAL_LOCK_ENABLE          0x09
#define ACPI_BITREG_POWER_BUTTON_ENABLE         0x0A
#define ACPI_BITREG_SLEEP_BUTTON_ENABLE         0x0B
#define ACPI_BITREG_RT_CLOCK_ENABLE             0x0C
873 874 875 876 877 878 879
#define ACPI_BITREG_PCIEXP_WAKE_DISABLE         0x0D

/* PM1 Control register */

#define ACPI_BITREG_SCI_ENABLE                  0x0E
#define ACPI_BITREG_BUS_MASTER_RLD              0x0F
#define ACPI_BITREG_GLOBAL_LOCK_RELEASE         0x10
880 881
#define ACPI_BITREG_SLEEP_TYPE                  0x11
#define ACPI_BITREG_SLEEP_ENABLE                0x12
L
Linus Torvalds 已提交
882

883
/* PM2 Control register */
L
Linus Torvalds 已提交
884

885
#define ACPI_BITREG_ARB_DISABLE                 0x13
L
Linus Torvalds 已提交
886

887
#define ACPI_BITREG_MAX                         0x13
L
Linus Torvalds 已提交
888 889
#define ACPI_NUM_BITREG                         ACPI_BITREG_MAX + 1

890 891 892 893 894 895 896 897 898
/* Status register values. A 1 clears a status bit. 0 = no effect */

#define ACPI_CLEAR_STATUS                       1

/* Enable and Control register values */

#define ACPI_ENABLE_EVENT                       1
#define ACPI_DISABLE_EVENT                      0

899 900
/* Sleep function dispatch */

L
Lv Zheng 已提交
901
typedef acpi_status(*acpi_sleep_function) (u8 sleep_state);
902 903

struct acpi_sleep_functions {
L
Lv Zheng 已提交
904 905
	acpi_sleep_function legacy_function;
	acpi_sleep_function extended_function;
906 907
};

L
Linus Torvalds 已提交
908 909 910
/*
 * External ACPI object definition
 */
911 912 913 914 915

/*
 * Note: Type == ACPI_TYPE_ANY (0) is used to indicate a NULL package element
 * or an unresolved named reference.
 */
L
Len Brown 已提交
916 917 918
union acpi_object {
	acpi_object_type type;	/* See definition of acpi_ns_type for values */
	struct {
919
		acpi_object_type type;	/* ACPI_TYPE_INTEGER */
920
		u64 value;	/* The actual number */
L
Linus Torvalds 已提交
921 922
	} integer;

L
Len Brown 已提交
923
	struct {
924
		acpi_object_type type;	/* ACPI_TYPE_STRING */
L
Len Brown 已提交
925 926
		u32 length;	/* # of bytes in string, excluding trailing null */
		char *pointer;	/* points to the string value */
L
Linus Torvalds 已提交
927 928
	} string;

L
Len Brown 已提交
929
	struct {
930
		acpi_object_type type;	/* ACPI_TYPE_BUFFER */
L
Len Brown 已提交
931 932
		u32 length;	/* # of bytes in buffer */
		u8 *pointer;	/* points to the buffer */
L
Linus Torvalds 已提交
933 934
	} buffer;

L
Len Brown 已提交
935
	struct {
936
		acpi_object_type type;	/* ACPI_TYPE_PACKAGE */
L
Len Brown 已提交
937 938
		u32 count;	/* # of elements in package */
		union acpi_object *elements;	/* Pointer to an array of ACPI_OBJECTs */
L
Linus Torvalds 已提交
939 940
	} package;

L
Len Brown 已提交
941
	struct {
942 943 944 945 946 947 948
		acpi_object_type type;	/* ACPI_TYPE_LOCAL_REFERENCE */
		acpi_object_type actual_type;	/* Type associated with the Handle */
		acpi_handle handle;	/* object reference */
	} reference;

	struct {
		acpi_object_type type;	/* ACPI_TYPE_PROCESSOR */
L
Len Brown 已提交
949 950 951
		u32 proc_id;
		acpi_io_address pblk_address;
		u32 pblk_length;
L
Linus Torvalds 已提交
952 953
	} processor;

L
Len Brown 已提交
954
	struct {
955
		acpi_object_type type;	/* ACPI_TYPE_POWER */
L
Len Brown 已提交
956 957
		u32 system_level;
		u32 resource_order;
L
Linus Torvalds 已提交
958 959 960 961 962 963
	} power_resource;
};

/*
 * List of objects, used as a parameter list for control method evaluation
 */
L
Len Brown 已提交
964 965 966
struct acpi_object_list {
	u32 count;
	union acpi_object *pointer;
L
Linus Torvalds 已提交
967 968 969 970 971 972
};

/*
 * Miscellaneous common Data Structures used by the interfaces
 */
#define ACPI_NO_BUFFER              0
973 974 975 976 977 978 979 980

#ifdef ACPI_NO_MEM_ALLOCATIONS

#define ACPI_ALLOCATE_BUFFER        (acpi_size) (0)
#define ACPI_ALLOCATE_LOCAL_BUFFER  (acpi_size) (0)

#else				/* ACPI_NO_MEM_ALLOCATIONS */

981 982
#define ACPI_ALLOCATE_BUFFER        (acpi_size) (-1)	/* Let ACPICA allocate buffer */
#define ACPI_ALLOCATE_LOCAL_BUFFER  (acpi_size) (-2)	/* For internal use only (enables tracking) */
L
Linus Torvalds 已提交
983

984 985
#endif				/* ACPI_NO_MEM_ALLOCATIONS */

L
Len Brown 已提交
986 987 988
struct acpi_buffer {
	acpi_size length;	/* Length in bytes of the buffer */
	void *pointer;		/* pointer to buffer */
L
Linus Torvalds 已提交
989 990 991 992 993 994 995 996 997
};

/*
 * name_type for acpi_get_name
 */
#define ACPI_FULL_PATHNAME              0
#define ACPI_SINGLE_NAME                1
#define ACPI_NAME_TYPE_MAX              1

998 999 1000 1001 1002 1003 1004 1005 1006
/*
 * Predefined Namespace items
 */
struct acpi_predefined_names {
	char *name;
	u8 type;
	char *val;
};

L
Linus Torvalds 已提交
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
/*
 * Structure and flags for acpi_get_system_info
 */
#define ACPI_SYS_MODE_UNKNOWN           0x0000
#define ACPI_SYS_MODE_ACPI              0x0001
#define ACPI_SYS_MODE_LEGACY            0x0002
#define ACPI_SYS_MODES_MASK             0x0003

/*
 * System info returned by acpi_get_system_info()
 */
L
Len Brown 已提交
1018 1019 1020 1021 1022 1023 1024 1025
struct acpi_system_info {
	u32 acpi_ca_version;
	u32 flags;
	u32 timer_resolution;
	u32 reserved1;
	u32 reserved2;
	u32 debug_level;
	u32 debug_layer;
L
Linus Torvalds 已提交
1026 1027
};

L
Lv Zheng 已提交
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037
/*
 * System statistics returned by acpi_get_statistics()
 */
struct acpi_statistics {
	u32 sci_count;
	u32 gpe_count;
	u32 fixed_event_count[ACPI_NUM_FIXED_EVENTS];
	u32 method_count;
};

1038 1039 1040 1041 1042 1043
/* Table Event Types */

#define ACPI_TABLE_EVENT_LOAD           0x0
#define ACPI_TABLE_EVENT_UNLOAD         0x1
#define ACPI_NUM_TABLE_EVENTS           2

L
Linus Torvalds 已提交
1044 1045 1046
/*
 * Types specific to the OS service interfaces
 */
L
Lv Zheng 已提交
1047 1048
typedef u32
 (ACPI_SYSTEM_XFACE * acpi_osd_handler) (void *context);
L
Linus Torvalds 已提交
1049 1050

typedef void
L
Len Brown 已提交
1051
 (ACPI_SYSTEM_XFACE * acpi_osd_exec_callback) (void *context);
L
Linus Torvalds 已提交
1052 1053 1054 1055

/*
 * Various handlers and callback procedures
 */
1056
typedef
1057
u32 (*acpi_sci_handler) (void *context);
1058

L
Lin Ming 已提交
1059
typedef
L
Lv Zheng 已提交
1060
void (*acpi_gbl_event_handler) (u32 event_type,
L
Lin Ming 已提交
1061 1062 1063 1064 1065 1066
			       acpi_handle device,
			       u32 event_number, void *context);

#define ACPI_EVENT_TYPE_GPE         0
#define ACPI_EVENT_TYPE_FIXED       1

L
Lv Zheng 已提交
1067 1068
typedef
u32(*acpi_event_handler) (void *context);
L
Linus Torvalds 已提交
1069

1070 1071 1072
typedef
u32 (*acpi_gpe_handler) (acpi_handle gpe_device, u32 gpe_number, void *context);

L
Linus Torvalds 已提交
1073
typedef
L
Len Brown 已提交
1074
void (*acpi_notify_handler) (acpi_handle device, u32 value, void *context);
L
Linus Torvalds 已提交
1075 1076

typedef
1077
void (*acpi_object_handler) (acpi_handle object, void *data);
L
Linus Torvalds 已提交
1078

L
Len Brown 已提交
1079
typedef acpi_status(*acpi_init_handler) (acpi_handle object, u32 function);
L
Linus Torvalds 已提交
1080 1081 1082 1083

#define ACPI_INIT_DEVICE_INI        1

typedef
L
Len Brown 已提交
1084 1085 1086 1087
acpi_status(*acpi_exception_handler) (acpi_status aml_status,
				      acpi_name name,
				      u16 opcode,
				      u32 aml_offset, void *context);
L
Linus Torvalds 已提交
1088

1089
/* Table Event handler (Load, load_table, etc.) and types */
1090 1091

typedef
1092
acpi_status(*acpi_table_handler) (u32 event, void *table, void *context);
1093

1094 1095 1096 1097
#define ACPI_TABLE_LOAD             0x0
#define ACPI_TABLE_UNLOAD           0x1
#define ACPI_NUM_TABLE_EVENTS       2

L
Linus Torvalds 已提交
1098 1099 1100
/* Address Spaces (For Operation Regions) */

typedef
L
Len Brown 已提交
1101 1102 1103
acpi_status(*acpi_adr_space_handler) (u32 function,
				      acpi_physical_address address,
				      u32 bit_width,
1104
				      u64 *value,
L
Len Brown 已提交
1105 1106
				      void *handler_context,
				      void *region_context);
L
Linus Torvalds 已提交
1107

B
Bob Moore 已提交
1108
#define ACPI_DEFAULT_HANDLER            NULL
L
Linus Torvalds 已提交
1109

1110 1111 1112 1113 1114 1115 1116 1117
/* Special Context data for generic_serial_bus/general_purpose_io (ACPI 5.0) */

struct acpi_connection_info {
	u8 *connection;
	u16 length;
	u8 access_length;
};

L
Linus Torvalds 已提交
1118
typedef
L
Len Brown 已提交
1119 1120 1121 1122
acpi_status(*acpi_adr_space_setup) (acpi_handle region_handle,
				    u32 function,
				    void *handler_context,
				    void **region_context);
L
Linus Torvalds 已提交
1123 1124 1125 1126 1127

#define ACPI_REGION_ACTIVATE    0
#define ACPI_REGION_DEACTIVATE  1

typedef
1128
acpi_status(*acpi_walk_callback) (acpi_handle object,
L
Len Brown 已提交
1129 1130
				  u32 nesting_level,
				  void *context, void **return_value);
L
Linus Torvalds 已提交
1131

1132 1133 1134
typedef
u32 (*acpi_interface_handler) (acpi_string interface_name, u32 supported);

L
Linus Torvalds 已提交
1135 1136 1137 1138 1139
/* Interrupt handler return values */

#define ACPI_INTERRUPT_NOT_HANDLED      0x00
#define ACPI_INTERRUPT_HANDLED          0x01

L
Lin Ming 已提交
1140 1141 1142 1143
/* GPE handler return values */

#define ACPI_REENABLE_GPE               0x80

1144 1145 1146 1147 1148
/* Length of 32-bit EISAID values when converted back to a string */

#define ACPI_EISAID_STRING_SIZE         8	/* Includes null terminator */

/* Length of UUID (string) values */
1149 1150 1151

#define ACPI_UUID_LENGTH                16

1152
/* Structures used for device/processor HID, UID, CID, and SUB */
L
Linus Torvalds 已提交
1153

1154
struct acpi_pnp_device_id {
1155 1156
	u32 length;		/* Length of string + null */
	char *string;
L
Linus Torvalds 已提交
1157 1158
};

1159
struct acpi_pnp_device_id_list {
1160 1161
	u32 count;		/* Number of IDs in Ids array */
	u32 list_size;		/* Size of list, including ID strings */
1162
	struct acpi_pnp_device_id ids[1];	/* ID array */
L
Linus Torvalds 已提交
1163 1164
};

1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178
/*
 * Structure returned from acpi_get_object_info.
 * Optimized for both 32- and 64-bit builds
 */
struct acpi_device_info {
	u32 info_size;		/* Size of info, including ID strings */
	u32 name;		/* ACPI object Name */
	acpi_object_type type;	/* ACPI object Type */
	u8 param_count;		/* If a method, required parameter count */
	u8 valid;		/* Indicates which optional fields are valid */
	u8 flags;		/* Miscellaneous info */
	u8 highest_dstates[4];	/* _sx_d values: 0xFF indicates not valid */
	u8 lowest_dstates[5];	/* _sx_w values: 0xFF indicates not valid */
	u32 current_status;	/* _STA value */
1179
	u64 address;	/* _ADR value */
1180 1181
	struct acpi_pnp_device_id hardware_id;	/* _HID value */
	struct acpi_pnp_device_id unique_id;	/* _UID value */
1182
	struct acpi_pnp_device_id subsystem_id;	/* _SUB value */
1183
	struct acpi_pnp_device_id_list compatible_id_list;	/* _CID list <must be last> */
L
Linus Torvalds 已提交
1184 1185
};

1186 1187 1188
/* Values for Flags field above (acpi_get_object_info) */

#define ACPI_PCI_ROOT_BRIDGE            0x01
L
Linus Torvalds 已提交
1189

1190 1191 1192 1193 1194 1195
/* Flags for Valid field above (acpi_get_object_info) */

#define ACPI_VALID_STA                  0x01
#define ACPI_VALID_ADR                  0x02
#define ACPI_VALID_HID                  0x04
#define ACPI_VALID_UID                  0x08
1196 1197 1198 1199
#define ACPI_VALID_SUB                  0x10
#define ACPI_VALID_CID                  0x20
#define ACPI_VALID_SXDS                 0x40
#define ACPI_VALID_SXWS                 0x80
L
Linus Torvalds 已提交
1200

1201
/* Flags for _STA return value (current_status above) */
B
Bob Moore 已提交
1202 1203 1204 1205

#define ACPI_STA_DEVICE_PRESENT         0x01
#define ACPI_STA_DEVICE_ENABLED         0x02
#define ACPI_STA_DEVICE_UI              0x04
B
Bob Moore 已提交
1206 1207
#define ACPI_STA_DEVICE_FUNCTIONING     0x08
#define ACPI_STA_DEVICE_OK              0x08	/* Synonym */
B
Bob Moore 已提交
1208 1209
#define ACPI_STA_BATTERY_PRESENT        0x10

L
Linus Torvalds 已提交
1210 1211
/* Context structs for address space handlers */

L
Len Brown 已提交
1212 1213 1214 1215 1216
struct acpi_pci_id {
	u16 segment;
	u16 bus;
	u16 device;
	u16 function;
L
Linus Torvalds 已提交
1217 1218
};

L
Len Brown 已提交
1219 1220 1221 1222 1223 1224
struct acpi_mem_space_context {
	u32 length;
	acpi_physical_address address;
	acpi_physical_address mapped_physical_address;
	u8 *mapped_logical_address;
	acpi_size mapped_length;
L
Linus Torvalds 已提交
1225 1226 1227
};

/*
1228
 * struct acpi_memory_list is used only if the ACPICA local cache is enabled
L
Linus Torvalds 已提交
1229
 */
1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247
struct acpi_memory_list {
	char *list_name;
	void *list_head;
	u16 object_size;
	u16 max_depth;
	u16 current_depth;

#ifdef ACPI_DBG_TRACK_ALLOCATIONS

	/* Statistics for debug memory tracking only */

	u32 total_allocated;
	u32 total_freed;
	u32 max_occupied;
	u32 total_size;
	u32 current_total_size;
	u32 requests;
	u32 hits;
B
Bob Moore 已提交
1248
#endif
L
Linus Torvalds 已提交
1249 1250
};

1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263
/* Definitions of _OSI support */

#define ACPI_VENDOR_STRINGS                 0x01
#define ACPI_FEATURE_STRINGS                0x02
#define ACPI_ENABLE_INTERFACES              0x00
#define ACPI_DISABLE_INTERFACES             0x04

#define ACPI_DISABLE_ALL_VENDOR_STRINGS     (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS)
#define ACPI_DISABLE_ALL_FEATURE_STRINGS    (ACPI_DISABLE_INTERFACES | ACPI_FEATURE_STRINGS)
#define ACPI_DISABLE_ALL_STRINGS            (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS)
#define ACPI_ENABLE_ALL_VENDOR_STRINGS      (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS)
#define ACPI_ENABLE_ALL_FEATURE_STRINGS     (ACPI_ENABLE_INTERFACES | ACPI_FEATURE_STRINGS)
#define ACPI_ENABLE_ALL_STRINGS             (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS)
A
Aaron Lu 已提交
1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277

#define ACPI_OSI_WIN_2000               0x01
#define ACPI_OSI_WIN_XP                 0x02
#define ACPI_OSI_WIN_XP_SP1             0x03
#define ACPI_OSI_WINSRV_2003            0x04
#define ACPI_OSI_WIN_XP_SP2             0x05
#define ACPI_OSI_WINSRV_2003_SP1        0x06
#define ACPI_OSI_WIN_VISTA              0x07
#define ACPI_OSI_WINSRV_2008            0x08
#define ACPI_OSI_WIN_VISTA_SP1          0x09
#define ACPI_OSI_WIN_VISTA_SP2          0x0A
#define ACPI_OSI_WIN_7                  0x0B
#define ACPI_OSI_WIN_8                  0x0C

1278 1279 1280 1281 1282 1283 1284 1285 1286
/* Definitions of file IO */

#define ACPI_FILE_READING               0x01
#define ACPI_FILE_WRITING               0x02
#define ACPI_FILE_BINARY                0x04

#define ACPI_FILE_BEGIN                 0x01
#define ACPI_FILE_END                   0x02

1287 1288 1289 1290
/* Definitions of getopt */

#define ACPI_OPT_END                    -1

L
Len Brown 已提交
1291
#endif				/* __ACTYPES_H__ */