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