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