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 - 2008, 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 header
51 * and must be either 32 or 64. 16-bit ACPICA is no longer supported, as of
52 * 12/2006.
53 */
54#ifndef ACPI_MACHINE_WIDTH
55#error ACPI_MACHINE_WIDTH not defined
56#endif
57
58/*! [Begin] no source code translation */
59
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 */
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 */
70#define ACPI_ASCII_MAX 0x7F
71
72/*
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
113 * data width.
114 *
115 * ACPI_SIZE 16/32/64-bit unsigned value
116 * ACPI_NATIVE_UINT 16/32/64-bit unsigned value
117 * ACPI_NATIVE_INT 16/32/64-bit signed value
118 *
119 */
120
121/*******************************************************************************
122 *
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;
132
133/*! [End] no source code translation !*/
134
135/*******************************************************************************
136 *
137 * Types specific to 64-bit targets
138 *
139 ******************************************************************************/
140
141#if ACPI_MACHINE_WIDTH == 64
142
143/*! [Begin] no source code translation (keep the typedefs as-is) */
144
145typedef unsigned int UINT32;
146typedef int INT32;
147
148/*! [End] no source code translation !*/
149
150typedef u64 acpi_native_uint;
151typedef s64 acpi_native_int;
152
153typedef u64 acpi_io_address;
154typedef u64 acpi_physical_address;
155
156#define ACPI_MAX_PTR ACPI_UINT64_MAX
157#define ACPI_SIZE_MAX ACPI_UINT64_MAX
158
159#define ACPI_USE_NATIVE_DIVIDE /* Has native 64-bit integer support */
160
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 *
167 * Note: Em64_t and other X86-64 processors support misaligned transfers,
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
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
189typedef u32 acpi_native_uint;
190typedef s32 acpi_native_int;
191
192typedef u32 acpi_io_address;
193typedef u32 acpi_physical_address;
194
195#define ACPI_MAX_PTR ACPI_UINT32_MAX
196#define ACPI_SIZE_MAX ACPI_UINT32_MAX
197
198#else
199
200/* ACPI_MACHINE_WIDTH must be either 64 or 32 */
201
202#error unknown ACPI_MACHINE_WIDTH
203#endif
204
205/* Variable-width type, used instead of clib size_t */
206
207typedef acpi_native_uint acpi_size;
208
209/*******************************************************************************
210 *
211 * OS-dependent and compiler-dependent types
212 *
213 * If the defaults below are not appropriate for the host system, they can
214 * be defined in the compiler-specific or OS-specific header, and this will
215 * take precedence.
216 *
217 ******************************************************************************/
218
219/* Value returned by acpi_os_get_thread_id */
220
221#ifndef acpi_thread_id
222#define acpi_thread_id acpi_native_uint
223#endif
224
225/* Object returned from acpi_os_create_lock */
226
227#ifndef acpi_spinlock
228#define acpi_spinlock void *
229#endif
230
231/* Flags for acpi_os_acquire_lock/acpi_os_release_lock */
232
233#ifndef acpi_cpu_flags
234#define acpi_cpu_flags acpi_native_uint
235#endif
236
237/* Object returned from acpi_os_create_cache */
238
239#ifndef acpi_cache_t
240#define acpi_cache_t struct acpi_memory_list
241#endif
242
243/* Use C99 uintptr_t for pointer casting if available, "void *" otherwise */
244
245#ifndef acpi_uintptr_t
246#define acpi_uintptr_t void *
247#endif
248
249/*
250 * ACPI_PRINTF_LIKE is used to tag functions as "printf-like" because
251 * some compilers can catch printf format string problems
252 */
253#ifndef ACPI_PRINTF_LIKE
254#define ACPI_PRINTF_LIKE(c)
255#endif
256
257/*
258 * Some compilers complain about unused variables. Sometimes we don't want to
259 * use all the variables (for example, _acpi_module_name). This allows us
260 * to to tell the compiler in a per-variable manner that a variable
261 * is unused
262 */
263#ifndef ACPI_UNUSED_VAR
264#define ACPI_UNUSED_VAR
265#endif
266
267/*
268 * All ACPICA functions that are available to the rest of the kernel are
269 * tagged with this macro which can be defined as appropriate for the host.
270 */
271#ifndef ACPI_EXPORT_SYMBOL
272#define ACPI_EXPORT_SYMBOL(symbol)
273#endif
274
275/*******************************************************************************
276 *
277 * Independent types
278 *
279 ******************************************************************************/
280
281/* Logical defines and NULL */
282
283#ifdef FALSE
284#undef FALSE
285#endif
286#define FALSE (1 == 0)
287
288#ifdef TRUE
289#undef TRUE
290#endif
291#define TRUE (1 == 1)
292
293#ifndef NULL
294#define NULL (void *) 0
295#endif
296
297/*
298 * Mescellaneous types
299 */
300typedef u32 acpi_status; /* All ACPI Exceptions */
301typedef u32 acpi_name; /* 4-byte ACPI name */
302typedef char *acpi_string; /* Null terminated ASCII string */
303typedef void *acpi_handle; /* Actually a ptr to a NS Node */
304
305struct uint64_struct {
306 u32 lo;
307 u32 hi;
308};
309
310union uint64_overlay {
311 u64 full;
312 struct uint64_struct part;
313};
314
315struct uint32_struct {
316 u32 lo;
317 u32 hi;
318};
319
320/* Synchronization objects */
321
322#define acpi_mutex void *
323#define acpi_semaphore void *
324
325/*
326 * Acpi integer width. In ACPI version 1, integers are 32 bits. In ACPI
327 * version 2, integers are 64 bits. Note that this pertains to the ACPI integer
328 * type only, not other integers used in the implementation of the ACPI CA
329 * subsystem.
330 */
331typedef unsigned long long acpi_integer;
332#define ACPI_INTEGER_MAX ACPI_UINT64_MAX
333#define ACPI_INTEGER_BIT_SIZE 64
334#define ACPI_MAX_DECIMAL_DIGITS 20 /* 2^64 = 18,446,744,073,709,551,616 */
335
336#if ACPI_MACHINE_WIDTH == 64
337#define ACPI_USE_NATIVE_DIVIDE /* Use compiler native 64-bit divide */
338#endif
339
340#define ACPI_MAX64_DECIMAL_DIGITS 20
341#define ACPI_MAX32_DECIMAL_DIGITS 10
342#define ACPI_MAX16_DECIMAL_DIGITS 5
343#define ACPI_MAX8_DECIMAL_DIGITS 3
344
345/*
346 * Constants with special meanings
347 */
348#define ACPI_ROOT_OBJECT ACPI_ADD_PTR (acpi_handle, NULL, ACPI_MAX_PTR)
349
350/*
351 * Initialization sequence
352 */
353#define ACPI_FULL_INITIALIZATION 0x00
354#define ACPI_NO_ADDRESS_SPACE_INIT 0x01
355#define ACPI_NO_HARDWARE_INIT 0x02
356#define ACPI_NO_EVENT_INIT 0x04
357#define ACPI_NO_HANDLER_INIT 0x08
358#define ACPI_NO_ACPI_ENABLE 0x10
359#define ACPI_NO_DEVICE_INIT 0x20
360#define ACPI_NO_OBJECT_INIT 0x40
361
362/*
363 * Initialization state
364 */
365#define ACPI_SUBSYSTEM_INITIALIZE 0x01
366#define ACPI_INITIALIZED_OK 0x02
367
368/*
369 * Power state values
370 */
371#define ACPI_STATE_UNKNOWN (u8) 0xFF
372
373#define ACPI_STATE_S0 (u8) 0
374#define ACPI_STATE_S1 (u8) 1
375#define ACPI_STATE_S2 (u8) 2
376#define ACPI_STATE_S3 (u8) 3
377#define ACPI_STATE_S4 (u8) 4
378#define ACPI_STATE_S5 (u8) 5
379#define ACPI_S_STATES_MAX ACPI_STATE_S5
380#define ACPI_S_STATE_COUNT 6
381
382#define ACPI_STATE_D0 (u8) 0
383#define ACPI_STATE_D1 (u8) 1
384#define ACPI_STATE_D2 (u8) 2
385#define ACPI_STATE_D3 (u8) 3
386#define ACPI_D_STATES_MAX ACPI_STATE_D3
387#define ACPI_D_STATE_COUNT 4
388
389#define ACPI_STATE_C0 (u8) 0
390#define ACPI_STATE_C1 (u8) 1
391#define ACPI_STATE_C2 (u8) 2
392#define ACPI_STATE_C3 (u8) 3
393#define ACPI_C_STATES_MAX ACPI_STATE_C3
394#define ACPI_C_STATE_COUNT 4
395
396/*
397 * Sleep type invalid value
398 */
399#define ACPI_SLEEP_TYPE_MAX 0x7
400#define ACPI_SLEEP_TYPE_INVALID 0xFF
401
402/*
403 * Standard notify values
404 */
405#define ACPI_NOTIFY_BUS_CHECK (u8) 0x00
406#define ACPI_NOTIFY_DEVICE_CHECK (u8) 0x01
407#define ACPI_NOTIFY_DEVICE_WAKE (u8) 0x02
408#define ACPI_NOTIFY_EJECT_REQUEST (u8) 0x03
409#define ACPI_NOTIFY_DEVICE_CHECK_LIGHT (u8) 0x04
410#define ACPI_NOTIFY_FREQUENCY_MISMATCH (u8) 0x05
411#define ACPI_NOTIFY_BUS_MODE_MISMATCH (u8) 0x06
412#define ACPI_NOTIFY_POWER_FAULT (u8) 0x07
413#define ACPI_NOTIFY_CAPABILITIES_CHECK (u8) 0x08
414#define ACPI_NOTIFY_DEVICE_PLD_CHECK (u8) 0x09
415#define ACPI_NOTIFY_RESERVED (u8) 0x0A
416#define ACPI_NOTIFY_LOCALITY_UPDATE (u8) 0x0B
417
418#define ACPI_NOTIFY_MAX 0x0B
419
420/*
421 * Types associated with ACPI names and objects. The first group of
422 * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
423 * of the ACPI object_type() operator (See the ACPI Spec). Therefore,
424 * only add to the first group if the spec changes.
425 *
426 * NOTE: Types must be kept in sync with the global acpi_ns_properties
427 * and acpi_ns_type_names arrays.
428 */
429typedef u32 acpi_object_type;
430
431#define ACPI_TYPE_ANY 0x00
432#define ACPI_TYPE_INTEGER 0x01 /* Byte/Word/Dword/Zero/One/Ones */
433#define ACPI_TYPE_STRING 0x02
434#define ACPI_TYPE_BUFFER 0x03
435#define ACPI_TYPE_PACKAGE 0x04 /* byte_const, multiple data_term/Constant/super_name */
436#define ACPI_TYPE_FIELD_UNIT 0x05
437#define ACPI_TYPE_DEVICE 0x06 /* Name, multiple Node */
438#define ACPI_TYPE_EVENT 0x07
439#define ACPI_TYPE_METHOD 0x08 /* Name, byte_const, multiple Code */
440#define ACPI_TYPE_MUTEX 0x09
441#define ACPI_TYPE_REGION 0x0A
442#define ACPI_TYPE_POWER 0x0B /* Name,byte_const,word_const,multi Node */
443#define ACPI_TYPE_PROCESSOR 0x0C /* Name,byte_const,Dword_const,byte_const,multi nm_o */
444#define ACPI_TYPE_THERMAL 0x0D /* Name, multiple Node */
445#define ACPI_TYPE_BUFFER_FIELD 0x0E
446#define ACPI_TYPE_DDB_HANDLE 0x0F
447#define ACPI_TYPE_DEBUG_OBJECT 0x10
448
449#define ACPI_TYPE_EXTERNAL_MAX 0x10
450
451/*
452 * These are object types that do not map directly to the ACPI
453 * object_type() operator. They are used for various internal purposes only.
454 * If new predefined ACPI_TYPEs are added (via the ACPI specification), these
455 * internal types must move upwards. (There is code that depends on these
456 * values being contiguous with the external types above.)
457 */
458#define ACPI_TYPE_LOCAL_REGION_FIELD 0x11
459#define ACPI_TYPE_LOCAL_BANK_FIELD 0x12
460#define ACPI_TYPE_LOCAL_INDEX_FIELD 0x13
461#define ACPI_TYPE_LOCAL_REFERENCE 0x14 /* Arg#, Local#, Name, Debug, ref_of, Index */
462#define ACPI_TYPE_LOCAL_ALIAS 0x15
463#define ACPI_TYPE_LOCAL_METHOD_ALIAS 0x16
464#define ACPI_TYPE_LOCAL_NOTIFY 0x17
465#define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
466#define ACPI_TYPE_LOCAL_RESOURCE 0x19
467#define ACPI_TYPE_LOCAL_RESOURCE_FIELD 0x1A
468#define ACPI_TYPE_LOCAL_SCOPE 0x1B /* 1 Name, multiple object_list Nodes */
469
470#define ACPI_TYPE_NS_NODE_MAX 0x1B /* Last typecode used within a NS Node */
471
472/*
473 * These are special object types that never appear in
474 * a Namespace node, only in an union acpi_operand_object
475 */
476#define ACPI_TYPE_LOCAL_EXTRA 0x1C
477#define ACPI_TYPE_LOCAL_DATA 0x1D
478
479#define ACPI_TYPE_LOCAL_MAX 0x1D
480
481/* All types above here are invalid */
482
483#define ACPI_TYPE_INVALID 0x1E
484#define ACPI_TYPE_NOT_FOUND 0xFF
485
486#define ACPI_NUM_NS_TYPES (ACPI_TYPE_INVALID + 1)
487
488/*
489 * All I/O
490 */
491#define ACPI_READ 0
492#define ACPI_WRITE 1
493#define ACPI_IO_MASK 1
494
495/*
496 * Event Types: Fixed & General Purpose
497 */
498typedef u32 acpi_event_type;
499
500/*
501 * Fixed events
502 */
503#define ACPI_EVENT_PMTIMER 0
504#define ACPI_EVENT_GLOBAL 1
505#define ACPI_EVENT_POWER_BUTTON 2
506#define ACPI_EVENT_SLEEP_BUTTON 3
507#define ACPI_EVENT_RTC 4
508#define ACPI_EVENT_MAX 4
509#define ACPI_NUM_FIXED_EVENTS ACPI_EVENT_MAX + 1
510
511/*
512 * Event Status - Per event
513 * -------------
514 * The encoding of acpi_event_status is illustrated below.
515 * Note that a set bit (1) indicates the property is TRUE
516 * (e.g. if bit 0 is set then the event is enabled).
517 * +-------------+-+-+-+
518 * | Bits 31:3 |2|1|0|
519 * +-------------+-+-+-+
520 * | | | |
521 * | | | +- Enabled?
522 * | | +--- Enabled for wake?
523 * | +----- Set?
524 * +----------- <Reserved>
525 */
526typedef u32 acpi_event_status;
527
528#define ACPI_EVENT_FLAG_DISABLED (acpi_event_status) 0x00
529#define ACPI_EVENT_FLAG_ENABLED (acpi_event_status) 0x01
530#define ACPI_EVENT_FLAG_WAKE_ENABLED (acpi_event_status) 0x02
531#define ACPI_EVENT_FLAG_SET (acpi_event_status) 0x04
532
533/*
534 * General Purpose Events (GPE)
535 */
536#define ACPI_GPE_INVALID 0xFF
537#define ACPI_GPE_MAX 0xFF
538#define ACPI_NUM_GPE 256
539
540#define ACPI_GPE_ENABLE 0
541#define ACPI_GPE_DISABLE 1
542
543/*
544 * GPE info flags - Per GPE
545 * +-+-+-+---+---+-+
546 * |7|6|5|4:3|2:1|0|
547 * +-+-+-+---+---+-+
548 * | | | | | |
549 * | | | | | +--- Interrupt type: Edge or Level Triggered
550 * | | | | +--- Type: Wake-only, Runtime-only, or wake/runtime
551 * | | | +--- Type of dispatch -- to method, handler, or none
552 * | | +--- Enabled for runtime?
553 * | +--- Enabled for wake?
554 * +--- Unused
555 */
556#define ACPI_GPE_XRUPT_TYPE_MASK (u8) 0x01
557#define ACPI_GPE_LEVEL_TRIGGERED (u8) 0x01
558#define ACPI_GPE_EDGE_TRIGGERED (u8) 0x00
559
560#define ACPI_GPE_TYPE_MASK (u8) 0x06
561#define ACPI_GPE_TYPE_WAKE_RUN (u8) 0x06
562#define ACPI_GPE_TYPE_WAKE (u8) 0x02
563#define ACPI_GPE_TYPE_RUNTIME (u8) 0x04 /* Default */
564
565#define ACPI_GPE_DISPATCH_MASK (u8) 0x18
566#define ACPI_GPE_DISPATCH_HANDLER (u8) 0x08
567#define ACPI_GPE_DISPATCH_METHOD (u8) 0x10
568#define ACPI_GPE_DISPATCH_NOT_USED (u8) 0x00 /* Default */
569
570#define ACPI_GPE_RUN_ENABLE_MASK (u8) 0x20
571#define ACPI_GPE_RUN_ENABLED (u8) 0x20
572#define ACPI_GPE_RUN_DISABLED (u8) 0x00 /* Default */
573
574#define ACPI_GPE_WAKE_ENABLE_MASK (u8) 0x40
575#define ACPI_GPE_WAKE_ENABLED (u8) 0x40
576#define ACPI_GPE_WAKE_DISABLED (u8) 0x00 /* Default */
577
578#define ACPI_GPE_ENABLE_MASK (u8) 0x60 /* Both run/wake */
579
580/*
581 * Flags for GPE and Lock interfaces
582 */
583#define ACPI_EVENT_WAKE_ENABLE 0x2 /* acpi_gpe_enable */
584#define ACPI_EVENT_WAKE_DISABLE 0x2 /* acpi_gpe_disable */
585
586#define ACPI_NOT_ISR 0x1
587#define ACPI_ISR 0x0
588
589/* Notify types */
590
591#define ACPI_SYSTEM_NOTIFY 0x1
592#define ACPI_DEVICE_NOTIFY 0x2
593#define ACPI_ALL_NOTIFY (ACPI_SYSTEM_NOTIFY | ACPI_DEVICE_NOTIFY)
594#define ACPI_MAX_NOTIFY_HANDLER_TYPE 0x3
595
596#define ACPI_MAX_SYS_NOTIFY 0x7f
597
598/* Address Space (Operation Region) Types */
599
600typedef u8 acpi_adr_space_type;
601
602#define ACPI_ADR_SPACE_SYSTEM_MEMORY (acpi_adr_space_type) 0
603#define ACPI_ADR_SPACE_SYSTEM_IO (acpi_adr_space_type) 1
604#define ACPI_ADR_SPACE_PCI_CONFIG (acpi_adr_space_type) 2
605#define ACPI_ADR_SPACE_EC (acpi_adr_space_type) 3
606#define ACPI_ADR_SPACE_SMBUS (acpi_adr_space_type) 4
607#define ACPI_ADR_SPACE_CMOS (acpi_adr_space_type) 5
608#define ACPI_ADR_SPACE_PCI_BAR_TARGET (acpi_adr_space_type) 6
609#define ACPI_ADR_SPACE_DATA_TABLE (acpi_adr_space_type) 7
610#define ACPI_ADR_SPACE_FIXED_HARDWARE (acpi_adr_space_type) 127
611
612/*
613 * bit_register IDs
614 * These are bitfields defined within the full ACPI registers
615 */
616#define ACPI_BITREG_TIMER_STATUS 0x00
617#define ACPI_BITREG_BUS_MASTER_STATUS 0x01
618#define ACPI_BITREG_GLOBAL_LOCK_STATUS 0x02
619#define ACPI_BITREG_POWER_BUTTON_STATUS 0x03
620#define ACPI_BITREG_SLEEP_BUTTON_STATUS 0x04
621#define ACPI_BITREG_RT_CLOCK_STATUS 0x05
622#define ACPI_BITREG_WAKE_STATUS 0x06
623#define ACPI_BITREG_PCIEXP_WAKE_STATUS 0x07
624
625#define ACPI_BITREG_TIMER_ENABLE 0x08
626#define ACPI_BITREG_GLOBAL_LOCK_ENABLE 0x09
627#define ACPI_BITREG_POWER_BUTTON_ENABLE 0x0A
628#define ACPI_BITREG_SLEEP_BUTTON_ENABLE 0x0B
629#define ACPI_BITREG_RT_CLOCK_ENABLE 0x0C
630#define ACPI_BITREG_WAKE_ENABLE 0x0D
631#define ACPI_BITREG_PCIEXP_WAKE_DISABLE 0x0E
632
633#define ACPI_BITREG_SCI_ENABLE 0x0F
634#define ACPI_BITREG_BUS_MASTER_RLD 0x10
635#define ACPI_BITREG_GLOBAL_LOCK_RELEASE 0x11
636#define ACPI_BITREG_SLEEP_TYPE_A 0x12
637#define ACPI_BITREG_SLEEP_TYPE_B 0x13
638#define ACPI_BITREG_SLEEP_ENABLE 0x14
639
640#define ACPI_BITREG_ARB_DISABLE 0x15
641
642#define ACPI_BITREG_MAX 0x15
643#define ACPI_NUM_BITREG ACPI_BITREG_MAX + 1
644
645/*
646 * External ACPI object definition
647 */
648
649/*
650 * Note: Type == ACPI_TYPE_ANY (0) is used to indicate a NULL package element
651 * or an unresolved named reference.
652 */
653union acpi_object {
654 acpi_object_type type; /* See definition of acpi_ns_type for values */
655 struct {
656 acpi_object_type type; /* ACPI_TYPE_INTEGER */
657 acpi_integer value; /* The actual number */
658 } integer;
659
660 struct {
661 acpi_object_type type; /* ACPI_TYPE_STRING */
662 u32 length; /* # of bytes in string, excluding trailing null */
663 char *pointer; /* points to the string value */
664 } string;
665
666 struct {
667 acpi_object_type type; /* ACPI_TYPE_BUFFER */
668 u32 length; /* # of bytes in buffer */
669 u8 *pointer; /* points to the buffer */
670 } buffer;
671
672 struct {
673 acpi_object_type type; /* ACPI_TYPE_PACKAGE */
674 u32 count; /* # of elements in package */
675 union acpi_object *elements; /* Pointer to an array of ACPI_OBJECTs */
676 } package;
677
678 struct {
679 acpi_object_type type; /* ACPI_TYPE_LOCAL_REFERENCE */
680 acpi_object_type actual_type; /* Type associated with the Handle */
681 acpi_handle handle; /* object reference */
682 } reference;
683
684 struct {
685 acpi_object_type type; /* ACPI_TYPE_PROCESSOR */
686 u32 proc_id;
687 acpi_io_address pblk_address;
688 u32 pblk_length;
689 } processor;
690
691 struct {
692 acpi_object_type type; /* ACPI_TYPE_POWER */
693 u32 system_level;
694 u32 resource_order;
695 } power_resource;
696};
697
698/*
699 * List of objects, used as a parameter list for control method evaluation
700 */
701struct acpi_object_list {
702 u32 count;
703 union acpi_object *pointer;
704};
705
706/*
707 * Miscellaneous common Data Structures used by the interfaces
708 */
709#define ACPI_NO_BUFFER 0
710#define ACPI_ALLOCATE_BUFFER (acpi_size) (-1)
711#define ACPI_ALLOCATE_LOCAL_BUFFER (acpi_size) (-2)
712
713struct acpi_buffer {
714 acpi_size length; /* Length in bytes of the buffer */
715 void *pointer; /* pointer to buffer */
716};
717
718/*
719 * name_type for acpi_get_name
720 */
721#define ACPI_FULL_PATHNAME 0
722#define ACPI_SINGLE_NAME 1
723#define ACPI_NAME_TYPE_MAX 1
724
725/*
726 * Structure and flags for acpi_get_system_info
727 */
728#define ACPI_SYS_MODE_UNKNOWN 0x0000
729#define ACPI_SYS_MODE_ACPI 0x0001
730#define ACPI_SYS_MODE_LEGACY 0x0002
731#define ACPI_SYS_MODES_MASK 0x0003
732
733/*
734 * System info returned by acpi_get_system_info()
735 */
736struct acpi_system_info {
737 u32 acpi_ca_version;
738 u32 flags;
739 u32 timer_resolution;
740 u32 reserved1;
741 u32 reserved2;
742 u32 debug_level;
743 u32 debug_layer;
744};
745
746/* Table Event Types */
747
748#define ACPI_TABLE_EVENT_LOAD 0x0
749#define ACPI_TABLE_EVENT_UNLOAD 0x1
750#define ACPI_NUM_TABLE_EVENTS 2
751
752/*
753 * Types specific to the OS service interfaces
754 */
755typedef u32(ACPI_SYSTEM_XFACE * acpi_osd_handler) (void *context);
756
757typedef void
758 (ACPI_SYSTEM_XFACE * acpi_osd_exec_callback) (void *context);
759
760/*
761 * Various handlers and callback procedures
762 */
763typedef u32(*acpi_event_handler) (void *context);
764
765typedef
766void (*acpi_notify_handler) (acpi_handle device, u32 value, void *context);
767
768typedef
769void (*acpi_object_handler) (acpi_handle object, u32 function, void *data);
770
771typedef acpi_status(*acpi_init_handler) (acpi_handle object, u32 function);
772
773#define ACPI_INIT_DEVICE_INI 1
774
775typedef
776acpi_status(*acpi_exception_handler) (acpi_status aml_status,
777 acpi_name name,
778 u16 opcode,
779 u32 aml_offset, void *context);
780
781/* Table Event handler (Load, load_table etc) and types */
782
783typedef
784acpi_status(*acpi_tbl_handler) (u32 event, void *table, void *context);
785
786/* Address Spaces (For Operation Regions) */
787
788typedef
789acpi_status(*acpi_adr_space_handler) (u32 function,
790 acpi_physical_address address,
791 u32 bit_width,
792 acpi_integer * value,
793 void *handler_context,
794 void *region_context);
795
796#define ACPI_DEFAULT_HANDLER NULL
797
798typedef
799acpi_status(*acpi_adr_space_setup) (acpi_handle region_handle,
800 u32 function,
801 void *handler_context,
802 void **region_context);
803
804#define ACPI_REGION_ACTIVATE 0
805#define ACPI_REGION_DEACTIVATE 1
806
807typedef
808acpi_status(*acpi_walk_callback) (acpi_handle obj_handle,
809 u32 nesting_level,
810 void *context, void **return_value);
811
812/* Interrupt handler return values */
813
814#define ACPI_INTERRUPT_NOT_HANDLED 0x00
815#define ACPI_INTERRUPT_HANDLED 0x01
816
817/* Common string version of device HIDs and UIDs */
818
819struct acpica_device_id {
820 char value[ACPI_DEVICE_ID_LENGTH];
821};
822
823/* Common string version of device CIDs */
824
825struct acpi_compatible_id {
826 char value[ACPI_MAX_CID_LENGTH];
827};
828
829struct acpi_compatible_id_list {
830 u32 count;
831 u32 size;
832 struct acpi_compatible_id id[1];
833};
834
835/* Structure and flags for acpi_get_object_info */
836
837#define ACPI_VALID_STA 0x0001
838#define ACPI_VALID_ADR 0x0002
839#define ACPI_VALID_HID 0x0004
840#define ACPI_VALID_UID 0x0008
841#define ACPI_VALID_CID 0x0010
842#define ACPI_VALID_SXDS 0x0020
843
844/* Flags for _STA method */
845
846#define ACPI_STA_DEVICE_PRESENT 0x01
847#define ACPI_STA_DEVICE_ENABLED 0x02
848#define ACPI_STA_DEVICE_UI 0x04
849#define ACPI_STA_DEVICE_FUNCTIONING 0x08
850#define ACPI_STA_DEVICE_OK 0x08 /* Synonym */
851#define ACPI_STA_BATTERY_PRESENT 0x10
852
853#define ACPI_COMMON_OBJ_INFO \
854 acpi_object_type type; /* ACPI object type */ \
855 acpi_name name /* ACPI object Name */
856
857struct acpi_obj_info_header {
858 ACPI_COMMON_OBJ_INFO;
859};
860
861/* Structure returned from Get Object Info */
862
863struct acpi_device_info {
864 ACPI_COMMON_OBJ_INFO;
865
866 u32 valid; /* Indicates which fields below are valid */
867 u32 current_status; /* _STA value */
868 acpi_integer address; /* _ADR value if any */
869 struct acpica_device_id hardware_id; /* _HID value if any */
870 struct acpica_device_id unique_id; /* _UID value if any */
871 u8 highest_dstates[4]; /* _sx_d values: 0xFF indicates not valid */
872 struct acpi_compatible_id_list compatibility_id; /* List of _CIDs if any */
873};
874
875/* Context structs for address space handlers */
876
877struct acpi_pci_id {
878 u16 segment;
879 u16 bus;
880 u16 device;
881 u16 function;
882};
883
884struct acpi_mem_space_context {
885 u32 length;
886 acpi_physical_address address;
887 acpi_physical_address mapped_physical_address;
888 u8 *mapped_logical_address;
889 acpi_size mapped_length;
890};
891
892/*
893 * Definitions for Resource Attributes
894 */
895typedef u16 acpi_rs_length; /* Resource Length field is fixed at 16 bits */
896typedef u32 acpi_rsdesc_size; /* Max Resource Descriptor size is (Length+3) = (64_k-1)+3 */
897
898/*
899 * Memory Attributes
900 */
901#define ACPI_READ_ONLY_MEMORY (u8) 0x00
902#define ACPI_READ_WRITE_MEMORY (u8) 0x01
903
904#define ACPI_NON_CACHEABLE_MEMORY (u8) 0x00
905#define ACPI_CACHABLE_MEMORY (u8) 0x01
906#define ACPI_WRITE_COMBINING_MEMORY (u8) 0x02
907#define ACPI_PREFETCHABLE_MEMORY (u8) 0x03
908
909/*
910 * IO Attributes
911 * The ISA IO ranges are: n000-n0_fFh, n400-n4_fFh, n800-n8_fFh, n_c00-n_cFFh.
912 * The non-ISA IO ranges are: n100-n3_fFh, n500-n7_fFh, n900-n_bFFh, n_cd0-n_fFFh.
913 */
914#define ACPI_NON_ISA_ONLY_RANGES (u8) 0x01
915#define ACPI_ISA_ONLY_RANGES (u8) 0x02
916#define ACPI_ENTIRE_RANGE (ACPI_NON_ISA_ONLY_RANGES | ACPI_ISA_ONLY_RANGES)
917
918/* Type of translation - 1=Sparse, 0=Dense */
919
920#define ACPI_SPARSE_TRANSLATION (u8) 0x01
921
922/*
923 * IO Port Descriptor Decode
924 */
925#define ACPI_DECODE_10 (u8) 0x00 /* 10-bit IO address decode */
926#define ACPI_DECODE_16 (u8) 0x01 /* 16-bit IO address decode */
927
928/*
929 * IRQ Attributes
930 */
931#define ACPI_LEVEL_SENSITIVE (u8) 0x00
932#define ACPI_EDGE_SENSITIVE (u8) 0x01
933
934#define ACPI_ACTIVE_HIGH (u8) 0x00
935#define ACPI_ACTIVE_LOW (u8) 0x01
936
937#define ACPI_EXCLUSIVE (u8) 0x00
938#define ACPI_SHARED (u8) 0x01
939
940/*
941 * DMA Attributes
942 */
943#define ACPI_COMPATIBILITY (u8) 0x00
944#define ACPI_TYPE_A (u8) 0x01
945#define ACPI_TYPE_B (u8) 0x02
946#define ACPI_TYPE_F (u8) 0x03
947
948#define ACPI_NOT_BUS_MASTER (u8) 0x00
949#define ACPI_BUS_MASTER (u8) 0x01
950
951#define ACPI_TRANSFER_8 (u8) 0x00
952#define ACPI_TRANSFER_8_16 (u8) 0x01
953#define ACPI_TRANSFER_16 (u8) 0x02
954
955/*
956 * Start Dependent Functions Priority definitions
957 */
958#define ACPI_GOOD_CONFIGURATION (u8) 0x00
959#define ACPI_ACCEPTABLE_CONFIGURATION (u8) 0x01
960#define ACPI_SUB_OPTIMAL_CONFIGURATION (u8) 0x02
961
962/*
963 * 16, 32 and 64-bit Address Descriptor resource types
964 */
965#define ACPI_MEMORY_RANGE (u8) 0x00
966#define ACPI_IO_RANGE (u8) 0x01
967#define ACPI_BUS_NUMBER_RANGE (u8) 0x02
968
969#define ACPI_ADDRESS_NOT_FIXED (u8) 0x00
970#define ACPI_ADDRESS_FIXED (u8) 0x01
971
972#define ACPI_POS_DECODE (u8) 0x00
973#define ACPI_SUB_DECODE (u8) 0x01
974
975#define ACPI_PRODUCER (u8) 0x00
976#define ACPI_CONSUMER (u8) 0x01
977
978/*
979 * If possible, pack the following structures to byte alignment
980 */
981#ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
982#pragma pack(1)
983#endif
984
985/* UUID data structures for use in vendor-defined resource descriptors */
986
987struct acpi_uuid {
988 u8 data[ACPI_UUID_LENGTH];
989};
990
991struct acpi_vendor_uuid {
992 u8 subtype;
993 u8 data[ACPI_UUID_LENGTH];
994};
995
996/*
997 * Structures used to describe device resources
998 */
999struct acpi_resource_irq {
1000 u8 descriptor_length;
1001 u8 triggering;
1002 u8 polarity;
1003 u8 sharable;
1004 u8 interrupt_count;
1005 u8 interrupts[1];
1006};
1007
1008struct acpi_resource_dma {
1009 u8 type;
1010 u8 bus_master;
1011 u8 transfer;
1012 u8 channel_count;
1013 u8 channels[1];
1014};
1015
1016struct acpi_resource_start_dependent {
1017 u8 descriptor_length;
1018 u8 compatibility_priority;
1019 u8 performance_robustness;
1020};
1021
1022/*
1023 * END_DEPENDENT_FUNCTIONS_RESOURCE struct is not
1024 * needed because it has no fields
1025 */
1026
1027struct acpi_resource_io {
1028 u8 io_decode;
1029 u8 alignment;
1030 u8 address_length;
1031 u16 minimum;
1032 u16 maximum;
1033};
1034
1035struct acpi_resource_fixed_io {
1036 u16 address;
1037 u8 address_length;
1038};
1039
1040struct acpi_resource_vendor {
1041 u16 byte_length;
1042 u8 byte_data[1];
1043};
1044
1045/* Vendor resource with UUID info (introduced in ACPI 3.0) */
1046
1047struct acpi_resource_vendor_typed {
1048 u16 byte_length;
1049 u8 uuid_subtype;
1050 u8 uuid[ACPI_UUID_LENGTH];
1051 u8 byte_data[1];
1052};
1053
1054struct acpi_resource_end_tag {
1055 u8 checksum;
1056};
1057
1058struct acpi_resource_memory24 {
1059 u8 write_protect;
1060 u16 minimum;
1061 u16 maximum;
1062 u16 alignment;
1063 u16 address_length;
1064};
1065
1066struct acpi_resource_memory32 {
1067 u8 write_protect;
1068 u32 minimum;
1069 u32 maximum;
1070 u32 alignment;
1071 u32 address_length;
1072};
1073
1074struct acpi_resource_fixed_memory32 {
1075 u8 write_protect;
1076 u32 address;
1077 u32 address_length;
1078};
1079
1080struct acpi_memory_attribute {
1081 u8 write_protect;
1082 u8 caching;
1083 u8 range_type;
1084 u8 translation;
1085};
1086
1087struct acpi_io_attribute {
1088 u8 range_type;
1089 u8 translation;
1090 u8 translation_type;
1091 u8 reserved1;
1092};
1093
1094union acpi_resource_attribute {
1095 struct acpi_memory_attribute mem;
1096 struct acpi_io_attribute io;
1097
1098 /* Used for the *word_space macros */
1099
1100 u8 type_specific;
1101};
1102
1103struct acpi_resource_source {
1104 u8 index;
1105 u16 string_length;
1106 char *string_ptr;
1107};
1108
1109/* Fields common to all address descriptors, 16/32/64 bit */
1110
1111#define ACPI_RESOURCE_ADDRESS_COMMON \
1112 u8 resource_type; \
1113 u8 producer_consumer; \
1114 u8 decode; \
1115 u8 min_address_fixed; \
1116 u8 max_address_fixed; \
1117 union acpi_resource_attribute info;
1118
1119struct acpi_resource_address {
1120ACPI_RESOURCE_ADDRESS_COMMON};
1121
1122struct acpi_resource_address16 {
1123 ACPI_RESOURCE_ADDRESS_COMMON u16 granularity;
1124 u16 minimum;
1125 u16 maximum;
1126 u16 translation_offset;
1127 u16 address_length;
1128 struct acpi_resource_source resource_source;
1129};
1130
1131struct acpi_resource_address32 {
1132 ACPI_RESOURCE_ADDRESS_COMMON u32 granularity;
1133 u32 minimum;
1134 u32 maximum;
1135 u32 translation_offset;
1136 u32 address_length;
1137 struct acpi_resource_source resource_source;
1138};
1139
1140struct acpi_resource_address64 {
1141 ACPI_RESOURCE_ADDRESS_COMMON u64 granularity;
1142 u64 minimum;
1143 u64 maximum;
1144 u64 translation_offset;
1145 u64 address_length;
1146 struct acpi_resource_source resource_source;
1147};
1148
1149struct acpi_resource_extended_address64 {
1150 ACPI_RESOURCE_ADDRESS_COMMON u8 revision_iD;
1151 u64 granularity;
1152 u64 minimum;
1153 u64 maximum;
1154 u64 translation_offset;
1155 u64 address_length;
1156 u64 type_specific;
1157};
1158
1159struct acpi_resource_extended_irq {
1160 u8 producer_consumer;
1161 u8 triggering;
1162 u8 polarity;
1163 u8 sharable;
1164 u8 interrupt_count;
1165 struct acpi_resource_source resource_source;
1166 u32 interrupts[1];
1167};
1168
1169struct acpi_resource_generic_register {
1170 u8 space_id;
1171 u8 bit_width;
1172 u8 bit_offset;
1173 u8 access_size;
1174 u64 address;
1175};
1176
1177/* ACPI_RESOURCE_TYPEs */
1178
1179#define ACPI_RESOURCE_TYPE_IRQ 0
1180#define ACPI_RESOURCE_TYPE_DMA 1
1181#define ACPI_RESOURCE_TYPE_START_DEPENDENT 2
1182#define ACPI_RESOURCE_TYPE_END_DEPENDENT 3
1183#define ACPI_RESOURCE_TYPE_IO 4
1184#define ACPI_RESOURCE_TYPE_FIXED_IO 5
1185#define ACPI_RESOURCE_TYPE_VENDOR 6
1186#define ACPI_RESOURCE_TYPE_END_TAG 7
1187#define ACPI_RESOURCE_TYPE_MEMORY24 8
1188#define ACPI_RESOURCE_TYPE_MEMORY32 9
1189#define ACPI_RESOURCE_TYPE_FIXED_MEMORY32 10
1190#define ACPI_RESOURCE_TYPE_ADDRESS16 11
1191#define ACPI_RESOURCE_TYPE_ADDRESS32 12
1192#define ACPI_RESOURCE_TYPE_ADDRESS64 13
1193#define ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64 14 /* ACPI 3.0 */
1194#define ACPI_RESOURCE_TYPE_EXTENDED_IRQ 15
1195#define ACPI_RESOURCE_TYPE_GENERIC_REGISTER 16
1196#define ACPI_RESOURCE_TYPE_MAX 16
1197
1198union acpi_resource_data {
1199 struct acpi_resource_irq irq;
1200 struct acpi_resource_dma dma;
1201 struct acpi_resource_start_dependent start_dpf;
1202 struct acpi_resource_io io;
1203 struct acpi_resource_fixed_io fixed_io;
1204 struct acpi_resource_vendor vendor;
1205 struct acpi_resource_vendor_typed vendor_typed;
1206 struct acpi_resource_end_tag end_tag;
1207 struct acpi_resource_memory24 memory24;
1208 struct acpi_resource_memory32 memory32;
1209 struct acpi_resource_fixed_memory32 fixed_memory32;
1210 struct acpi_resource_address16 address16;
1211 struct acpi_resource_address32 address32;
1212 struct acpi_resource_address64 address64;
1213 struct acpi_resource_extended_address64 ext_address64;
1214 struct acpi_resource_extended_irq extended_irq;
1215 struct acpi_resource_generic_register generic_reg;
1216
1217 /* Common fields */
1218
1219 struct acpi_resource_address address; /* Common 16/32/64 address fields */
1220};
1221
1222struct acpi_resource {
1223 u32 type;
1224 u32 length;
1225 union acpi_resource_data data;
1226};
1227
1228/* restore default alignment */
1229
1230#pragma pack()
1231
1232#define ACPI_RS_SIZE_MIN 12
1233#define ACPI_RS_SIZE_NO_DATA 8 /* Id + Length fields */
1234#define ACPI_RS_SIZE(type) (u32) (ACPI_RS_SIZE_NO_DATA + sizeof (type))
1235
1236#define ACPI_NEXT_RESOURCE(res) (struct acpi_resource *)((u8 *) res + res->length)
1237
1238struct acpi_pci_routing_table {
1239 u32 length;
1240 u32 pin;
1241 acpi_integer address; /* here for 64-bit alignment */
1242 u32 source_index;
1243 char source[4]; /* pad to 64 bits so sizeof() works in all cases */
1244};
1245
1246#endif /* __ACTYPES_H__ */