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 - 2005, R. Byron Moore
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/*! [Begin] no source code translation (keep the typedefs) */
48
49/*
50 * Data type ranges
51 * Note: These macros are designed to be compiler independent as well as
52 * working around problems that some 32-bit compilers have with 64-bit
53 * constants.
54 */
55#define ACPI_UINT8_MAX (UINT8) (~((UINT8) 0)) /* 0xFF */
56#define ACPI_UINT16_MAX (UINT16)(~((UINT16) 0)) /* 0xFFFF */
57#define ACPI_UINT32_MAX (UINT32)(~((UINT32) 0)) /* 0xFFFFFFFF */
58#define ACPI_UINT64_MAX (UINT64)(~((UINT64) 0)) /* 0xFFFFFFFFFFFFFFFF */
59#define ACPI_ASCII_MAX 0x7F
60
61#ifdef DEFINE_ALTERNATE_TYPES
62/*
63 * Types used only in translated source, defined here to enable
64 * cross-platform compilation only.
65 */
66typedef int s32;
67typedef unsigned char u8;
68typedef unsigned short u16;
69typedef unsigned int u32;
70typedef COMPILER_DEPENDENT_UINT64 u64;
71
72#endif
73
74/*
75 * Data types - Fixed across all compilation models (16/32/64)
76 *
77 * BOOLEAN Logical Boolean.
78 * INT8 8-bit (1 byte) signed value
79 * UINT8 8-bit (1 byte) unsigned value
80 * INT16 16-bit (2 byte) signed value
81 * UINT16 16-bit (2 byte) unsigned value
82 * INT32 32-bit (4 byte) signed value
83 * UINT32 32-bit (4 byte) unsigned value
84 * INT64 64-bit (8 byte) signed value
85 * UINT64 64-bit (8 byte) unsigned value
86 * ACPI_NATIVE_INT 32-bit on IA-32, 64-bit on IA-64 signed value
87 * ACPI_NATIVE_UINT 32-bit on IA-32, 64-bit on IA-64 unsigned value
88 */
89
90#ifndef ACPI_MACHINE_WIDTH
91#error ACPI_MACHINE_WIDTH not defined
92#endif
93
94#if ACPI_MACHINE_WIDTH == 64
95
96/*! [Begin] no source code translation (keep the typedefs) */
97
98/*
99 * 64-bit type definitions
100 */
101typedef unsigned char UINT8;
102typedef unsigned char BOOLEAN;
103typedef unsigned short UINT16;
104typedef int INT32;
105typedef unsigned int UINT32;
106typedef COMPILER_DEPENDENT_INT64 INT64;
107typedef COMPILER_DEPENDENT_UINT64 UINT64;
108
109/*! [End] no source code translation !*/
110
111typedef s64 acpi_native_int;
112typedef u64 acpi_native_uint;
113
114typedef u64 acpi_table_ptr;
115typedef u64 acpi_io_address;
116typedef u64 acpi_physical_address;
117typedef u64 acpi_size;
118
119#define ALIGNED_ADDRESS_BOUNDARY 0x00000008 /* No hardware alignment support in IA64 */
120#define ACPI_USE_NATIVE_DIVIDE /* Native 64-bit integer support */
121#define ACPI_MAX_PTR ACPI_UINT64_MAX
122#define ACPI_SIZE_MAX ACPI_UINT64_MAX
123
124#elif ACPI_MACHINE_WIDTH == 16
125
126/*! [Begin] no source code translation (keep the typedefs) */
127
128/*
129 * 16-bit type definitions
130 */
131typedef unsigned char UINT8;
132typedef unsigned char BOOLEAN;
133typedef unsigned int UINT16;
134typedef long INT32;
135typedef int INT16;
136typedef unsigned long UINT32;
137
138struct {
139 UINT32 Lo;
140 UINT32 Hi;
141};
142
143/*! [End] no source code translation !*/
144
145typedef u16 acpi_native_uint;
146typedef s16 acpi_native_int;
147
148typedef u32 acpi_table_ptr;
149typedef u32 acpi_io_address;
150typedef char *acpi_physical_address;
151typedef u16 acpi_size;
152
153#define ALIGNED_ADDRESS_BOUNDARY 0x00000002
154#define ACPI_MISALIGNED_TRANSFERS
155#define ACPI_USE_NATIVE_DIVIDE /* No 64-bit integers, ok to use native divide */
156#define ACPI_MAX_PTR ACPI_UINT16_MAX
157#define ACPI_SIZE_MAX ACPI_UINT16_MAX
158
159/*
160 * (16-bit only) internal integers must be 32-bits, so
161 * 64-bit integers cannot be supported
162 */
163#define ACPI_NO_INTEGER64_SUPPORT
164
165#elif ACPI_MACHINE_WIDTH == 32
166
167/*! [Begin] no source code translation (keep the typedefs) */
168
169/*
170 * 32-bit type definitions (default)
171 */
172typedef unsigned char UINT8;
173typedef unsigned char BOOLEAN;
174typedef unsigned short UINT16;
175typedef int INT32;
176typedef unsigned int UINT32;
177typedef COMPILER_DEPENDENT_INT64 INT64;
178typedef COMPILER_DEPENDENT_UINT64 UINT64;
179
180/*! [End] no source code translation !*/
181
182typedef s32 acpi_native_int;
183typedef u32 acpi_native_uint;
184
185typedef u64 acpi_table_ptr;
186typedef u32 acpi_io_address;
187typedef u64 acpi_physical_address;
188typedef u32 acpi_size;
189
190#define ALIGNED_ADDRESS_BOUNDARY 0x00000004
191#define ACPI_MISALIGNED_TRANSFERS
192#define ACPI_MAX_PTR ACPI_UINT32_MAX
193#define ACPI_SIZE_MAX ACPI_UINT32_MAX
194
195#else
196#error unknown ACPI_MACHINE_WIDTH
197#endif
198
199/*
200 * This type is used for bitfields in ACPI tables. The only type that is
201 * even remotely portable is u8. Anything else is not portable, so
202 * do not add any more bitfield types.
203 */
204typedef u8 UINT8_BIT;
205typedef acpi_native_uint ACPI_PTRDIFF;
206
207/*
208 * Pointer overlays to avoid lots of typecasting for
209 * code that accepts both physical and logical pointers.
210 */
211union acpi_pointers {
212 acpi_physical_address physical;
213 void *logical;
214 acpi_table_ptr value;
215};
216
217struct acpi_pointer {
218 u32 pointer_type;
219 union acpi_pointers pointer;
220};
221
222/* pointer_types for above */
223
224#define ACPI_PHYSICAL_POINTER 0x01
225#define ACPI_LOGICAL_POINTER 0x02
226
227/* Processor mode */
228
229#define ACPI_PHYSICAL_ADDRESSING 0x04
230#define ACPI_LOGICAL_ADDRESSING 0x08
231#define ACPI_MEMORY_MODE 0x0C
232
233#define ACPI_PHYSMODE_PHYSPTR ACPI_PHYSICAL_ADDRESSING | ACPI_PHYSICAL_POINTER
234#define ACPI_LOGMODE_PHYSPTR ACPI_LOGICAL_ADDRESSING | ACPI_PHYSICAL_POINTER
235#define ACPI_LOGMODE_LOGPTR ACPI_LOGICAL_ADDRESSING | ACPI_LOGICAL_POINTER
236
237/*
238 * If acpi_cache_t was not defined in the OS-dependent header,
239 * define it now. This is typically the case where the local cache
240 * manager implementation is to be used (ACPI_USE_LOCAL_CACHE)
241 */
242#ifndef acpi_cache_t
243#define acpi_cache_t struct acpi_memory_list
244#endif
245
246/*
247 * Useful defines
248 */
249#ifdef FALSE
250#undef FALSE
251#endif
252#define FALSE (1 == 0)
253
254#ifdef TRUE
255#undef TRUE
256#endif
257#define TRUE (1 == 1)
258
259#ifndef NULL
260#define NULL (void *) 0
261#endif
262
263/*
264 * Local datatypes
265 */
266typedef u32 acpi_status; /* All ACPI Exceptions */
267typedef u32 acpi_name; /* 4-byte ACPI name */
268typedef char *acpi_string; /* Null terminated ASCII string */
269typedef void *acpi_handle; /* Actually a ptr to an Node */
270
271struct uint64_struct {
272 u32 lo;
273 u32 hi;
274};
275
276union uint64_overlay {
277 u64 full;
278 struct uint64_struct part;
279};
280
281struct uint32_struct {
282 u32 lo;
283 u32 hi;
284};
285
286/*
287 * Acpi integer width. In ACPI version 1, integers are
288 * 32 bits. In ACPI version 2, integers are 64 bits.
289 * Note that this pertains to the ACPI integer type only, not
290 * other integers used in the implementation of the ACPI CA
291 * subsystem.
292 */
293#ifdef ACPI_NO_INTEGER64_SUPPORT
294
295/* 32-bit integers only, no 64-bit support */
296
297typedef u32 acpi_integer;
298#define ACPI_INTEGER_MAX ACPI_UINT32_MAX
299#define ACPI_INTEGER_BIT_SIZE 32
300#define ACPI_MAX_DECIMAL_DIGITS 10 /* 2^32 = 4,294,967,296 */
301
302#define ACPI_USE_NATIVE_DIVIDE /* Use compiler native 32-bit divide */
303
304#else
305
306/* 64-bit integers */
307
308typedef u64 acpi_integer;
309#define ACPI_INTEGER_MAX ACPI_UINT64_MAX
310#define ACPI_INTEGER_BIT_SIZE 64
311#define ACPI_MAX_DECIMAL_DIGITS 20 /* 2^64 = 18,446,744,073,709,551,616 */
312
313#if ACPI_MACHINE_WIDTH == 64
314#define ACPI_USE_NATIVE_DIVIDE /* Use compiler native 64-bit divide */
315#endif
316#endif
317
318#define ACPI_MAX64_DECIMAL_DIGITS 20
319#define ACPI_MAX32_DECIMAL_DIGITS 10
320#define ACPI_MAX16_DECIMAL_DIGITS 5
321#define ACPI_MAX8_DECIMAL_DIGITS 3
322
323/*
324 * Constants with special meanings
325 */
326#define ACPI_ROOT_OBJECT (acpi_handle) ACPI_PTR_ADD (char, NULL, ACPI_MAX_PTR)
327
328/*
329 * Initialization sequence
330 */
331#define ACPI_FULL_INITIALIZATION 0x00
332#define ACPI_NO_ADDRESS_SPACE_INIT 0x01
333#define ACPI_NO_HARDWARE_INIT 0x02
334#define ACPI_NO_EVENT_INIT 0x04
335#define ACPI_NO_HANDLER_INIT 0x08
336#define ACPI_NO_ACPI_ENABLE 0x10
337#define ACPI_NO_DEVICE_INIT 0x20
338#define ACPI_NO_OBJECT_INIT 0x40
339
340/*
341 * Initialization state
342 */
343#define ACPI_INITIALIZED_OK 0x01
344
345/*
346 * Power state values
347 */
348#define ACPI_STATE_UNKNOWN (u8) 0xFF
349
350#define ACPI_STATE_S0 (u8) 0
351#define ACPI_STATE_S1 (u8) 1
352#define ACPI_STATE_S2 (u8) 2
353#define ACPI_STATE_S3 (u8) 3
354#define ACPI_STATE_S4 (u8) 4
355#define ACPI_STATE_S5 (u8) 5
356#define ACPI_S_STATES_MAX ACPI_STATE_S5
357#define ACPI_S_STATE_COUNT 6
358
359#define ACPI_STATE_D0 (u8) 0
360#define ACPI_STATE_D1 (u8) 1
361#define ACPI_STATE_D2 (u8) 2
362#define ACPI_STATE_D3 (u8) 3
363#define ACPI_D_STATES_MAX ACPI_STATE_D3
364#define ACPI_D_STATE_COUNT 4
365
366#define ACPI_STATE_C0 (u8) 0
367#define ACPI_STATE_C1 (u8) 1
368#define ACPI_STATE_C2 (u8) 2
369#define ACPI_STATE_C3 (u8) 3
370#define ACPI_C_STATES_MAX ACPI_STATE_C3
371#define ACPI_C_STATE_COUNT 4
372
373/*
374 * Sleep type invalid value
375 */
376#define ACPI_SLEEP_TYPE_MAX 0x7
377#define ACPI_SLEEP_TYPE_INVALID 0xFF
378
379/*
380 * Standard notify values
381 */
382#define ACPI_NOTIFY_BUS_CHECK (u8) 0
383#define ACPI_NOTIFY_DEVICE_CHECK (u8) 1
384#define ACPI_NOTIFY_DEVICE_WAKE (u8) 2
385#define ACPI_NOTIFY_EJECT_REQUEST (u8) 3
386#define ACPI_NOTIFY_DEVICE_CHECK_LIGHT (u8) 4
387#define ACPI_NOTIFY_FREQUENCY_MISMATCH (u8) 5
388#define ACPI_NOTIFY_BUS_MODE_MISMATCH (u8) 6
389#define ACPI_NOTIFY_POWER_FAULT (u8) 7
390
391/*
392 * Table types. These values are passed to the table related APIs
393 */
394typedef u32 acpi_table_type;
395
396#define ACPI_TABLE_RSDP (acpi_table_type) 0
397#define ACPI_TABLE_DSDT (acpi_table_type) 1
398#define ACPI_TABLE_FADT (acpi_table_type) 2
399#define ACPI_TABLE_FACS (acpi_table_type) 3
400#define ACPI_TABLE_PSDT (acpi_table_type) 4
401#define ACPI_TABLE_SSDT (acpi_table_type) 5
402#define ACPI_TABLE_XSDT (acpi_table_type) 6
403#define ACPI_TABLE_MAX 6
404#define NUM_ACPI_TABLE_TYPES (ACPI_TABLE_MAX+1)
405
406/*
407 * Types associated with ACPI names and objects. The first group of
408 * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
409 * of the ACPI object_type() operator (See the ACPI Spec). Therefore,
410 * only add to the first group if the spec changes.
411 *
412 * NOTE: Types must be kept in sync with the global acpi_ns_properties
413 * and acpi_ns_type_names arrays.
414 */
415typedef u32 acpi_object_type;
416
417#define ACPI_TYPE_ANY 0x00
418#define ACPI_TYPE_INTEGER 0x01 /* Byte/Word/Dword/Zero/One/Ones */
419#define ACPI_TYPE_STRING 0x02
420#define ACPI_TYPE_BUFFER 0x03
421#define ACPI_TYPE_PACKAGE 0x04 /* byte_const, multiple data_term/Constant/super_name */
422#define ACPI_TYPE_FIELD_UNIT 0x05
423#define ACPI_TYPE_DEVICE 0x06 /* Name, multiple Node */
424#define ACPI_TYPE_EVENT 0x07
425#define ACPI_TYPE_METHOD 0x08 /* Name, byte_const, multiple Code */
426#define ACPI_TYPE_MUTEX 0x09
427#define ACPI_TYPE_REGION 0x0A
428#define ACPI_TYPE_POWER 0x0B /* Name,byte_const,word_const,multi Node */
429#define ACPI_TYPE_PROCESSOR 0x0C /* Name,byte_const,Dword_const,byte_const,multi nm_o */
430#define ACPI_TYPE_THERMAL 0x0D /* Name, multiple Node */
431#define ACPI_TYPE_BUFFER_FIELD 0x0E
432#define ACPI_TYPE_DDB_HANDLE 0x0F
433#define ACPI_TYPE_DEBUG_OBJECT 0x10
434
435#define ACPI_TYPE_EXTERNAL_MAX 0x10
436
437/*
438 * These are object types that do not map directly to the ACPI
439 * object_type() operator. They are used for various internal purposes only.
440 * If new predefined ACPI_TYPEs are added (via the ACPI specification), these
441 * internal types must move upwards. (There is code that depends on these
442 * values being contiguous with the external types above.)
443 */
444#define ACPI_TYPE_LOCAL_REGION_FIELD 0x11
445#define ACPI_TYPE_LOCAL_BANK_FIELD 0x12
446#define ACPI_TYPE_LOCAL_INDEX_FIELD 0x13
447#define ACPI_TYPE_LOCAL_REFERENCE 0x14 /* Arg#, Local#, Name, Debug, ref_of, Index */
448#define ACPI_TYPE_LOCAL_ALIAS 0x15
449#define ACPI_TYPE_LOCAL_METHOD_ALIAS 0x16
450#define ACPI_TYPE_LOCAL_NOTIFY 0x17
451#define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
452#define ACPI_TYPE_LOCAL_RESOURCE 0x19
453#define ACPI_TYPE_LOCAL_RESOURCE_FIELD 0x1A
454#define ACPI_TYPE_LOCAL_SCOPE 0x1B /* 1 Name, multiple object_list Nodes */
455
456#define ACPI_TYPE_NS_NODE_MAX 0x1B /* Last typecode used within a NS Node */
457
458/*
459 * These are special object types that never appear in
460 * a Namespace node, only in an union acpi_operand_object
461 */
462#define ACPI_TYPE_LOCAL_EXTRA 0x1C
463#define ACPI_TYPE_LOCAL_DATA 0x1D
464
465#define ACPI_TYPE_LOCAL_MAX 0x1D
466
467/* All types above here are invalid */
468
469#define ACPI_TYPE_INVALID 0x1E
470#define ACPI_TYPE_NOT_FOUND 0xFF
471
472/*
473 * Bitmapped ACPI types. Used internally only
474 */
475#define ACPI_BTYPE_ANY 0x00000000
476#define ACPI_BTYPE_INTEGER 0x00000001
477#define ACPI_BTYPE_STRING 0x00000002
478#define ACPI_BTYPE_BUFFER 0x00000004
479#define ACPI_BTYPE_PACKAGE 0x00000008
480#define ACPI_BTYPE_FIELD_UNIT 0x00000010
481#define ACPI_BTYPE_DEVICE 0x00000020
482#define ACPI_BTYPE_EVENT 0x00000040
483#define ACPI_BTYPE_METHOD 0x00000080
484#define ACPI_BTYPE_MUTEX 0x00000100
485#define ACPI_BTYPE_REGION 0x00000200
486#define ACPI_BTYPE_POWER 0x00000400
487#define ACPI_BTYPE_PROCESSOR 0x00000800
488#define ACPI_BTYPE_THERMAL 0x00001000
489#define ACPI_BTYPE_BUFFER_FIELD 0x00002000
490#define ACPI_BTYPE_DDB_HANDLE 0x00004000
491#define ACPI_BTYPE_DEBUG_OBJECT 0x00008000
492#define ACPI_BTYPE_REFERENCE 0x00010000
493#define ACPI_BTYPE_RESOURCE 0x00020000
494
495#define ACPI_BTYPE_COMPUTE_DATA (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER)
496
497#define ACPI_BTYPE_DATA (ACPI_BTYPE_COMPUTE_DATA | ACPI_BTYPE_PACKAGE)
498#define ACPI_BTYPE_DATA_REFERENCE (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE | ACPI_BTYPE_DDB_HANDLE)
499#define ACPI_BTYPE_DEVICE_OBJECTS (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR)
500#define ACPI_BTYPE_OBJECTS_AND_REFS 0x0001FFFF /* ARG or LOCAL */
501#define ACPI_BTYPE_ALL_OBJECTS 0x0000FFFF
502
503/*
504 * All I/O
505 */
506#define ACPI_READ 0
507#define ACPI_WRITE 1
508#define ACPI_IO_MASK 1
509
510/*
511 * Event Types: Fixed & General Purpose
512 */
513typedef u32 acpi_event_type;
514
515/*
516 * Fixed events
517 */
518#define ACPI_EVENT_PMTIMER 0
519#define ACPI_EVENT_GLOBAL 1
520#define ACPI_EVENT_POWER_BUTTON 2
521#define ACPI_EVENT_SLEEP_BUTTON 3
522#define ACPI_EVENT_RTC 4
523#define ACPI_EVENT_MAX 4
524#define ACPI_NUM_FIXED_EVENTS ACPI_EVENT_MAX + 1
525
526/*
527 * Event Status - Per event
528 * -------------
529 * The encoding of acpi_event_status is illustrated below.
530 * Note that a set bit (1) indicates the property is TRUE
531 * (e.g. if bit 0 is set then the event is enabled).
532 * +-------------+-+-+-+
533 * | Bits 31:3 |2|1|0|
534 * +-------------+-+-+-+
535 * | | | |
536 * | | | +- Enabled?
537 * | | +--- Enabled for wake?
538 * | +----- Set?
539 * +----------- <Reserved>
540 */
541typedef u32 acpi_event_status;
542
543#define ACPI_EVENT_FLAG_DISABLED (acpi_event_status) 0x00
544#define ACPI_EVENT_FLAG_ENABLED (acpi_event_status) 0x01
545#define ACPI_EVENT_FLAG_WAKE_ENABLED (acpi_event_status) 0x02
546#define ACPI_EVENT_FLAG_SET (acpi_event_status) 0x04
547
548/*
549 * General Purpose Events (GPE)
550 */
551#define ACPI_GPE_INVALID 0xFF
552#define ACPI_GPE_MAX 0xFF
553#define ACPI_NUM_GPE 256
554
555#define ACPI_GPE_ENABLE 0
556#define ACPI_GPE_DISABLE 1
557
558/*
559 * GPE info flags - Per GPE
560 * +-+-+-+---+---+-+
561 * |7|6|5|4:3|2:1|0|
562 * +-+-+-+---+---+-+
563 * | | | | | |
564 * | | | | | +--- Interrupt type: Edge or Level Triggered
565 * | | | | +--- Type: Wake-only, Runtime-only, or wake/runtime
566 * | | | +--- Type of dispatch -- to method, handler, or none
567 * | | +--- Enabled for runtime?
568 * | +--- Enabled for wake?
569 * +--- System state when GPE ocurred (running/waking)
570 */
571#define ACPI_GPE_XRUPT_TYPE_MASK (u8) 0x01
572#define ACPI_GPE_LEVEL_TRIGGERED (u8) 0x01
573#define ACPI_GPE_EDGE_TRIGGERED (u8) 0x00
574
575#define ACPI_GPE_TYPE_MASK (u8) 0x06
576#define ACPI_GPE_TYPE_WAKE_RUN (u8) 0x06
577#define ACPI_GPE_TYPE_WAKE (u8) 0x02
578#define ACPI_GPE_TYPE_RUNTIME (u8) 0x04 /* Default */
579
580#define ACPI_GPE_DISPATCH_MASK (u8) 0x18
581#define ACPI_GPE_DISPATCH_HANDLER (u8) 0x08
582#define ACPI_GPE_DISPATCH_METHOD (u8) 0x10
583#define ACPI_GPE_DISPATCH_NOT_USED (u8) 0x00 /* Default */
584
585#define ACPI_GPE_RUN_ENABLE_MASK (u8) 0x20
586#define ACPI_GPE_RUN_ENABLED (u8) 0x20
587#define ACPI_GPE_RUN_DISABLED (u8) 0x00 /* Default */
588
589#define ACPI_GPE_WAKE_ENABLE_MASK (u8) 0x40
590#define ACPI_GPE_WAKE_ENABLED (u8) 0x40
591#define ACPI_GPE_WAKE_DISABLED (u8) 0x00 /* Default */
592
593#define ACPI_GPE_ENABLE_MASK (u8) 0x60 /* Both run/wake */
594
595#define ACPI_GPE_SYSTEM_MASK (u8) 0x80
596#define ACPI_GPE_SYSTEM_RUNNING (u8) 0x80
597#define ACPI_GPE_SYSTEM_WAKING (u8) 0x00
598
599/*
600 * Flags for GPE and Lock interfaces
601 */
602#define ACPI_EVENT_WAKE_ENABLE 0x2 /* acpi_gpe_enable */
603#define ACPI_EVENT_WAKE_DISABLE 0x2 /* acpi_gpe_disable */
604
605#define ACPI_NOT_ISR 0x1
606#define ACPI_ISR 0x0
607
608/* Notify types */
609
610#define ACPI_SYSTEM_NOTIFY 0x1
611#define ACPI_DEVICE_NOTIFY 0x2
612#define ACPI_ALL_NOTIFY 0x3
613#define ACPI_MAX_NOTIFY_HANDLER_TYPE 0x3
614
615#define ACPI_MAX_SYS_NOTIFY 0x7f
616
617/* Address Space (Operation Region) Types */
618
619typedef u8 acpi_adr_space_type;
620
621#define ACPI_ADR_SPACE_SYSTEM_MEMORY (acpi_adr_space_type) 0
622#define ACPI_ADR_SPACE_SYSTEM_IO (acpi_adr_space_type) 1
623#define ACPI_ADR_SPACE_PCI_CONFIG (acpi_adr_space_type) 2
624#define ACPI_ADR_SPACE_EC (acpi_adr_space_type) 3
625#define ACPI_ADR_SPACE_SMBUS (acpi_adr_space_type) 4
626#define ACPI_ADR_SPACE_CMOS (acpi_adr_space_type) 5
627#define ACPI_ADR_SPACE_PCI_BAR_TARGET (acpi_adr_space_type) 6
628#define ACPI_ADR_SPACE_DATA_TABLE (acpi_adr_space_type) 7
629#define ACPI_ADR_SPACE_FIXED_HARDWARE (acpi_adr_space_type) 127
630
631/*
632 * bit_register IDs
633 * These are bitfields defined within the full ACPI registers
634 */
635#define ACPI_BITREG_TIMER_STATUS 0x00
636#define ACPI_BITREG_BUS_MASTER_STATUS 0x01
637#define ACPI_BITREG_GLOBAL_LOCK_STATUS 0x02
638#define ACPI_BITREG_POWER_BUTTON_STATUS 0x03
639#define ACPI_BITREG_SLEEP_BUTTON_STATUS 0x04
640#define ACPI_BITREG_RT_CLOCK_STATUS 0x05
641#define ACPI_BITREG_WAKE_STATUS 0x06
642#define ACPI_BITREG_PCIEXP_WAKE_STATUS 0x07
643
644#define ACPI_BITREG_TIMER_ENABLE 0x08
645#define ACPI_BITREG_GLOBAL_LOCK_ENABLE 0x09
646#define ACPI_BITREG_POWER_BUTTON_ENABLE 0x0A
647#define ACPI_BITREG_SLEEP_BUTTON_ENABLE 0x0B
648#define ACPI_BITREG_RT_CLOCK_ENABLE 0x0C
649#define ACPI_BITREG_WAKE_ENABLE 0x0D
650#define ACPI_BITREG_PCIEXP_WAKE_DISABLE 0x0E
651
652#define ACPI_BITREG_SCI_ENABLE 0x0F
653#define ACPI_BITREG_BUS_MASTER_RLD 0x10
654#define ACPI_BITREG_GLOBAL_LOCK_RELEASE 0x11
655#define ACPI_BITREG_SLEEP_TYPE_A 0x12
656#define ACPI_BITREG_SLEEP_TYPE_B 0x13
657#define ACPI_BITREG_SLEEP_ENABLE 0x14
658
659#define ACPI_BITREG_ARB_DISABLE 0x15
660
661#define ACPI_BITREG_MAX 0x15
662#define ACPI_NUM_BITREG ACPI_BITREG_MAX + 1
663
664/*
665 * External ACPI object definition
666 */
667union acpi_object {
668 acpi_object_type type; /* See definition of acpi_ns_type for values */
669 struct {
670 acpi_object_type type;
671 acpi_integer value; /* The actual number */
672 } integer;
673
674 struct {
675 acpi_object_type type;
676 u32 length; /* # of bytes in string, excluding trailing null */
677 char *pointer; /* points to the string value */
678 } string;
679
680 struct {
681 acpi_object_type type;
682 u32 length; /* # of bytes in buffer */
683 u8 *pointer; /* points to the buffer */
684 } buffer;
685
686 struct {
687 acpi_object_type type;
688 u32 fill1;
689 acpi_handle handle; /* object reference */
690 } reference;
691
692 struct {
693 acpi_object_type type;
694 u32 count; /* # of elements in package */
695 union acpi_object *elements; /* Pointer to an array of ACPI_OBJECTs */
696 } package;
697
698 struct {
699 acpi_object_type type;
700 u32 proc_id;
701 acpi_io_address pblk_address;
702 u32 pblk_length;
703 } processor;
704
705 struct {
706 acpi_object_type type;
707 u32 system_level;
708 u32 resource_order;
709 } power_resource;
710};
711
712/*
713 * List of objects, used as a parameter list for control method evaluation
714 */
715struct acpi_object_list {
716 u32 count;
717 union acpi_object *pointer;
718};
719
720/*
721 * Miscellaneous common Data Structures used by the interfaces
722 */
723#define ACPI_NO_BUFFER 0
724#define ACPI_ALLOCATE_BUFFER (acpi_size) (-1)
725#define ACPI_ALLOCATE_LOCAL_BUFFER (acpi_size) (-2)
726
727struct acpi_buffer {
728 acpi_size length; /* Length in bytes of the buffer */
729 void *pointer; /* pointer to buffer */
730};
731
732/*
733 * name_type for acpi_get_name
734 */
735#define ACPI_FULL_PATHNAME 0
736#define ACPI_SINGLE_NAME 1
737#define ACPI_NAME_TYPE_MAX 1
738
739/*
740 * Structure and flags for acpi_get_system_info
741 */
742#define ACPI_SYS_MODE_UNKNOWN 0x0000
743#define ACPI_SYS_MODE_ACPI 0x0001
744#define ACPI_SYS_MODE_LEGACY 0x0002
745#define ACPI_SYS_MODES_MASK 0x0003
746
747/*
748 * ACPI Table Info. One per ACPI table _type_
749 */
750struct acpi_table_info {
751 u32 count;
752};
753
754/*
755 * System info returned by acpi_get_system_info()
756 */
757struct acpi_system_info {
758 u32 acpi_ca_version;
759 u32 flags;
760 u32 timer_resolution;
761 u32 reserved1;
762 u32 reserved2;
763 u32 debug_level;
764 u32 debug_layer;
765 u32 num_table_types;
766 struct acpi_table_info table_info[NUM_ACPI_TABLE_TYPES];
767};
768
769/*
770 * Types specific to the OS service interfaces
771 */
772typedef u32(ACPI_SYSTEM_XFACE * acpi_osd_handler) (void *context);
773
774typedef void
775 (ACPI_SYSTEM_XFACE * acpi_osd_exec_callback) (void *context);
776
777/*
778 * Various handlers and callback procedures
779 */
780typedef u32(*acpi_event_handler) (void *context);
781
782typedef
783void (*acpi_notify_handler) (acpi_handle device, u32 value, void *context);
784
785typedef
786void (*acpi_object_handler) (acpi_handle object, u32 function, void *data);
787
788typedef acpi_status(*acpi_init_handler) (acpi_handle object, u32 function);
789
790#define ACPI_INIT_DEVICE_INI 1
791
792typedef
793acpi_status(*acpi_exception_handler) (acpi_status aml_status,
794 acpi_name name,
795 u16 opcode,
796 u32 aml_offset, void *context);
797
798/* Address Spaces (For Operation Regions) */
799
800typedef
801acpi_status(*acpi_adr_space_handler) (u32 function,
802 acpi_physical_address address,
803 u32 bit_width,
804 acpi_integer * value,
805 void *handler_context,
806 void *region_context);
807
808#define ACPI_DEFAULT_HANDLER NULL
809
810typedef
811acpi_status(*acpi_adr_space_setup) (acpi_handle region_handle,
812 u32 function,
813 void *handler_context,
814 void **region_context);
815
816#define ACPI_REGION_ACTIVATE 0
817#define ACPI_REGION_DEACTIVATE 1
818
819typedef
820acpi_status(*acpi_walk_callback) (acpi_handle obj_handle,
821 u32 nesting_level,
822 void *context, void **return_value);
823
824/* Interrupt handler return values */
825
826#define ACPI_INTERRUPT_NOT_HANDLED 0x00
827#define ACPI_INTERRUPT_HANDLED 0x01
828
829/* Common string version of device HIDs and UIDs */
830
831struct acpi_device_id {
832 char value[ACPI_DEVICE_ID_LENGTH];
833};
834
835/* Common string version of device CIDs */
836
837struct acpi_compatible_id {
838 char value[ACPI_MAX_CID_LENGTH];
839};
840
841struct acpi_compatible_id_list {
842 u32 count;
843 u32 size;
844 struct acpi_compatible_id id[1];
845};
846
847/* Structure and flags for acpi_get_object_info */
848
849#define ACPI_VALID_STA 0x0001
850#define ACPI_VALID_ADR 0x0002
851#define ACPI_VALID_HID 0x0004
852#define ACPI_VALID_UID 0x0008
853#define ACPI_VALID_CID 0x0010
854#define ACPI_VALID_SXDS 0x0020
855
856#define ACPI_COMMON_OBJ_INFO \
857 acpi_object_type type; /* ACPI object type */ \
858 acpi_name name /* ACPI object Name */
859
860struct acpi_obj_info_header {
861 ACPI_COMMON_OBJ_INFO;
862};
863
864/* Structure returned from Get Object Info */
865
866struct acpi_device_info {
867 ACPI_COMMON_OBJ_INFO;
868
869 u32 valid; /* Indicates which fields below are valid */
870 u32 current_status; /* _STA value */
871 acpi_integer address; /* _ADR value if any */
872 struct acpi_device_id hardware_id; /* _HID value if any */
873 struct acpi_device_id unique_id; /* _UID value if any */
874 u8 highest_dstates[4]; /* _sx_d values: 0xFF indicates not valid */
875 struct acpi_compatible_id_list compatibility_id; /* List of _CIDs if any */
876};
877
878/* Context structs for address space handlers */
879
880struct acpi_pci_id {
881 u16 segment;
882 u16 bus;
883 u16 device;
884 u16 function;
885};
886
887struct acpi_mem_space_context {
888 u32 length;
889 acpi_physical_address address;
890 acpi_physical_address mapped_physical_address;
891 u8 *mapped_logical_address;
892 acpi_size mapped_length;
893};
894
895/*
896 * Definitions for Resource Attributes
897 */
898
899/*
900 * Memory Attributes
901 */
902#define ACPI_READ_ONLY_MEMORY (u8) 0x00
903#define ACPI_READ_WRITE_MEMORY (u8) 0x01
904
905#define ACPI_NON_CACHEABLE_MEMORY (u8) 0x00
906#define ACPI_CACHABLE_MEMORY (u8) 0x01
907#define ACPI_WRITE_COMBINING_MEMORY (u8) 0x02
908#define ACPI_PREFETCHABLE_MEMORY (u8) 0x03
909
910/*
911 * IO Attributes
912 * The ISA Io ranges are: n000-n0_ffh, n400-n4_ffh, n800-n8_ffh, n_c00-n_cFFh.
913 * The non-ISA Io ranges are: n100-n3_ffh, n500-n7_ffh, n900-n_bFfh, n_cd0-n_fFFh.
914 */
915#define ACPI_NON_ISA_ONLY_RANGES (u8) 0x01
916#define ACPI_ISA_ONLY_RANGES (u8) 0x02
917#define ACPI_ENTIRE_RANGE (ACPI_NON_ISA_ONLY_RANGES | ACPI_ISA_ONLY_RANGES)
918
919#define ACPI_SPARSE_TRANSLATION (u8) 0x03
920
921/*
922 * IO Port Descriptor Decode
923 */
924#define ACPI_DECODE_10 (u8) 0x00 /* 10-bit IO address decode */
925#define ACPI_DECODE_16 (u8) 0x01 /* 16-bit IO address decode */
926
927/*
928 * IRQ Attributes
929 */
930#define ACPI_EDGE_SENSITIVE (u8) 0x00
931#define ACPI_LEVEL_SENSITIVE (u8) 0x01
932
933#define ACPI_ACTIVE_HIGH (u8) 0x00
934#define ACPI_ACTIVE_LOW (u8) 0x01
935
936#define ACPI_EXCLUSIVE (u8) 0x00
937#define ACPI_SHARED (u8) 0x01
938
939/*
940 * DMA Attributes
941 */
942#define ACPI_COMPATIBILITY (u8) 0x00
943#define ACPI_TYPE_A (u8) 0x01
944#define ACPI_TYPE_B (u8) 0x02
945#define ACPI_TYPE_F (u8) 0x03
946
947#define ACPI_NOT_BUS_MASTER (u8) 0x00
948#define ACPI_BUS_MASTER (u8) 0x01
949
950#define ACPI_TRANSFER_8 (u8) 0x00
951#define ACPI_TRANSFER_8_16 (u8) 0x01
952#define ACPI_TRANSFER_16 (u8) 0x02
953
954/*
955 * Start Dependent Functions Priority definitions
956 */
957#define ACPI_GOOD_CONFIGURATION (u8) 0x00
958#define ACPI_ACCEPTABLE_CONFIGURATION (u8) 0x01
959#define ACPI_SUB_OPTIMAL_CONFIGURATION (u8) 0x02
960
961/*
962 * 16, 32 and 64-bit Address Descriptor resource types
963 */
964#define ACPI_MEMORY_RANGE (u8) 0x00
965#define ACPI_IO_RANGE (u8) 0x01
966#define ACPI_BUS_NUMBER_RANGE (u8) 0x02
967
968#define ACPI_ADDRESS_NOT_FIXED (u8) 0x00
969#define ACPI_ADDRESS_FIXED (u8) 0x01
970
971#define ACPI_POS_DECODE (u8) 0x00
972#define ACPI_SUB_DECODE (u8) 0x01
973
974#define ACPI_PRODUCER (u8) 0x00
975#define ACPI_CONSUMER (u8) 0x01
976
977/*
978 * Structures used to describe device resources
979 */
980struct acpi_resource_irq {
981 u32 edge_level;
982 u32 active_high_low;
983 u32 shared_exclusive;
984 u32 number_of_interrupts;
985 u32 interrupts[1];
986};
987
988struct acpi_resource_dma {
989 u32 type;
990 u32 bus_master;
991 u32 transfer;
992 u32 number_of_channels;
993 u32 channels[1];
994};
995
996struct acpi_resource_start_dpf {
997 u32 compatibility_priority;
998 u32 performance_robustness;
999};
1000
1001/*
1002 * END_DEPENDENT_FUNCTIONS_RESOURCE struct is not
1003 * needed because it has no fields
1004 */
1005
1006struct acpi_resource_io {
1007 u32 io_decode;
1008 u32 min_base_address;
1009 u32 max_base_address;
1010 u32 alignment;
1011 u32 range_length;
1012};
1013
1014struct acpi_resource_fixed_io {
1015 u32 base_address;
1016 u32 range_length;
1017};
1018
1019struct acpi_resource_vendor {
1020 u32 length;
1021 u8 reserved[1];
1022};
1023
1024struct acpi_resource_end_tag {
1025 u8 checksum;
1026};
1027
1028struct acpi_resource_mem24 {
1029 u32 read_write_attribute;
1030 u32 min_base_address;
1031 u32 max_base_address;
1032 u32 alignment;
1033 u32 range_length;
1034};
1035
1036struct acpi_resource_mem32 {
1037 u32 read_write_attribute;
1038 u32 min_base_address;
1039 u32 max_base_address;
1040 u32 alignment;
1041 u32 range_length;
1042};
1043
1044struct acpi_resource_fixed_mem32 {
1045 u32 read_write_attribute;
1046 u32 range_base_address;
1047 u32 range_length;
1048};
1049
1050struct acpi_memory_attribute {
1051 u16 cache_attribute;
1052 u16 read_write_attribute;
1053};
1054
1055struct acpi_io_attribute {
1056 u16 range_attribute;
1057 u16 translation_attribute;
1058};
1059
1060struct acpi_bus_attribute {
1061 u16 reserved1;
1062 u16 reserved2;
1063};
1064
1065union acpi_resource_attribute {
1066 struct acpi_memory_attribute memory;
1067 struct acpi_io_attribute io;
1068 struct acpi_bus_attribute bus;
1069};
1070
1071struct acpi_resource_source {
1072 u32 index;
1073 u32 string_length;
1074 char *string_ptr;
1075};
1076
1077/* Fields common to all address descriptors, 16/32/64 bit */
1078
1079#define ACPI_RESOURCE_ADDRESS_COMMON \
1080 u32 resource_type; \
1081 u32 producer_consumer; \
1082 u32 decode; \
1083 u32 min_address_fixed; \
1084 u32 max_address_fixed; \
1085 union acpi_resource_attribute attribute;
1086
1087struct acpi_resource_address {
1088ACPI_RESOURCE_ADDRESS_COMMON};
1089
1090struct acpi_resource_address16 {
1091 ACPI_RESOURCE_ADDRESS_COMMON u32 granularity;
1092 u32 min_address_range;
1093 u32 max_address_range;
1094 u32 address_translation_offset;
1095 u32 address_length;
1096 struct acpi_resource_source resource_source;
1097};
1098
1099struct acpi_resource_address32 {
1100 ACPI_RESOURCE_ADDRESS_COMMON u32 granularity;
1101 u32 min_address_range;
1102 u32 max_address_range;
1103 u32 address_translation_offset;
1104 u32 address_length;
1105 struct acpi_resource_source resource_source;
1106};
1107
1108struct acpi_resource_address64 {
1109 ACPI_RESOURCE_ADDRESS_COMMON u64 granularity;
1110 u64 min_address_range;
1111 u64 max_address_range;
1112 u64 address_translation_offset;
1113 u64 address_length;
1114 u64 type_specific_attributes;
1115 struct acpi_resource_source resource_source;
1116};
1117
1118struct acpi_resource_ext_irq {
1119 u32 producer_consumer;
1120 u32 edge_level;
1121 u32 active_high_low;
1122 u32 shared_exclusive;
1123 u32 number_of_interrupts;
1124 struct acpi_resource_source resource_source;
1125 u32 interrupts[1];
1126};
1127
1128/* ACPI_RESOURCE_TYPEs */
1129
1130#define ACPI_RSTYPE_IRQ 0
1131#define ACPI_RSTYPE_DMA 1
1132#define ACPI_RSTYPE_START_DPF 2
1133#define ACPI_RSTYPE_END_DPF 3
1134#define ACPI_RSTYPE_IO 4
1135#define ACPI_RSTYPE_FIXED_IO 5
1136#define ACPI_RSTYPE_VENDOR 6
1137#define ACPI_RSTYPE_END_TAG 7
1138#define ACPI_RSTYPE_MEM24 8
1139#define ACPI_RSTYPE_MEM32 9
1140#define ACPI_RSTYPE_FIXED_MEM32 10
1141#define ACPI_RSTYPE_ADDRESS16 11
1142#define ACPI_RSTYPE_ADDRESS32 12
1143#define ACPI_RSTYPE_ADDRESS64 13
1144#define ACPI_RSTYPE_EXT_IRQ 14
1145
1146typedef u32 acpi_resource_type;
1147
1148union acpi_resource_data {
1149 struct acpi_resource_irq irq;
1150 struct acpi_resource_dma dma;
1151 struct acpi_resource_start_dpf start_dpf;
1152 struct acpi_resource_io io;
1153 struct acpi_resource_fixed_io fixed_io;
1154 struct acpi_resource_vendor vendor_specific;
1155 struct acpi_resource_end_tag end_tag;
1156 struct acpi_resource_mem24 memory24;
1157 struct acpi_resource_mem32 memory32;
1158 struct acpi_resource_fixed_mem32 fixed_memory32;
1159 struct acpi_resource_address address; /* Common 16/32/64 address fields */
1160 struct acpi_resource_address16 address16;
1161 struct acpi_resource_address32 address32;
1162 struct acpi_resource_address64 address64;
1163 struct acpi_resource_ext_irq extended_irq;
1164};
1165
1166struct acpi_resource {
1167 acpi_resource_type id;
1168 u32 length;
1169 union acpi_resource_data data;
1170};
1171
1172#define ACPI_RESOURCE_LENGTH 12
1173#define ACPI_RESOURCE_LENGTH_NO_DATA 8 /* Id + Length fields */
1174
1175#define ACPI_SIZEOF_RESOURCE(type) (ACPI_RESOURCE_LENGTH_NO_DATA + sizeof (type))
1176
1177#define ACPI_NEXT_RESOURCE(res) (struct acpi_resource *)((u8 *) res + res->length)
1178
1179#ifdef ACPI_MISALIGNED_TRANSFERS
1180#define ACPI_ALIGN_RESOURCE_SIZE(length) (length)
1181#else
1182#define ACPI_ALIGN_RESOURCE_SIZE(length) ACPI_ROUND_UP_TO_NATIVE_WORD(length)
1183#endif
1184
1185/*
1186 * END: of definitions for Resource Attributes
1187 */
1188
1189struct acpi_pci_routing_table {
1190 u32 length;
1191 u32 pin;
1192 acpi_integer address; /* here for 64-bit alignment */
1193 u32 source_index;
1194 char source[4]; /* pad to 64 bits so sizeof() works in all cases */
1195};
1196
1197/*
1198 * END: of definitions for PCI Routing tables
1199 */
1200
1201#endif /* __ACTYPES_H__ */