]> git.karo-electronics.de Git - karo-tx-linux.git/blob - include/acpi/actypes.h
ACPICA: Update version to 20070320
[karo-tx-linux.git] / include / acpi / actypes.h
1 /******************************************************************************
2  *
3  * Name: actypes.h - Common data types for the entire ACPI subsystem
4  *
5  *****************************************************************************/
6
7 /*
8  * Copyright (C) 2000 - 2007, 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 /* 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
127 typedef unsigned char BOOLEAN;
128 typedef unsigned char UINT8;
129 typedef unsigned short UINT16;
130 typedef COMPILER_DEPENDENT_UINT64 UINT64;
131 typedef 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
145 typedef unsigned int UINT32;
146 typedef int INT32;
147
148 /*! [End] no source code translation !*/
149
150 typedef u64 acpi_native_uint;
151 typedef s64 acpi_native_int;
152
153 typedef u64 acpi_io_address;
154 typedef 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
184 typedef unsigned int UINT32;
185 typedef int INT32;
186
187 /*! [End] no source code translation !*/
188
189 typedef u32 acpi_native_uint;
190 typedef s32 acpi_native_int;
191
192 typedef u32 acpi_io_address;
193 typedef 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
207 typedef 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  */
300 typedef u32 acpi_status;        /* All ACPI Exceptions */
301 typedef u32 acpi_name;          /* 4-byte ACPI name */
302 typedef char *acpi_string;      /* Null terminated ASCII string */
303 typedef void *acpi_handle;      /* Actually a ptr to a NS Node */
304
305 struct uint64_struct {
306         u32 lo;
307         u32 hi;
308 };
309
310 union uint64_overlay {
311         u64 full;
312         struct uint64_struct part;
313 };
314
315 struct 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  */
331 typedef 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) 0
406 #define ACPI_NOTIFY_DEVICE_CHECK        (u8) 1
407 #define ACPI_NOTIFY_DEVICE_WAKE         (u8) 2
408 #define ACPI_NOTIFY_EJECT_REQUEST       (u8) 3
409 #define ACPI_NOTIFY_DEVICE_CHECK_LIGHT  (u8) 4
410 #define ACPI_NOTIFY_FREQUENCY_MISMATCH  (u8) 5
411 #define ACPI_NOTIFY_BUS_MODE_MISMATCH   (u8) 6
412 #define ACPI_NOTIFY_POWER_FAULT         (u8) 7
413
414 /*
415  * Types associated with ACPI names and objects.  The first group of
416  * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
417  * of the ACPI object_type() operator (See the ACPI Spec). Therefore,
418  * only add to the first group if the spec changes.
419  *
420  * NOTE: Types must be kept in sync with the global acpi_ns_properties
421  * and acpi_ns_type_names arrays.
422  */
423 typedef u32 acpi_object_type;
424
425 #define ACPI_TYPE_ANY                   0x00
426 #define ACPI_TYPE_INTEGER               0x01    /* Byte/Word/Dword/Zero/One/Ones */
427 #define ACPI_TYPE_STRING                0x02
428 #define ACPI_TYPE_BUFFER                0x03
429 #define ACPI_TYPE_PACKAGE               0x04    /* byte_const, multiple data_term/Constant/super_name */
430 #define ACPI_TYPE_FIELD_UNIT            0x05
431 #define ACPI_TYPE_DEVICE                0x06    /* Name, multiple Node */
432 #define ACPI_TYPE_EVENT                 0x07
433 #define ACPI_TYPE_METHOD                0x08    /* Name, byte_const, multiple Code */
434 #define ACPI_TYPE_MUTEX                 0x09
435 #define ACPI_TYPE_REGION                0x0A
436 #define ACPI_TYPE_POWER                 0x0B    /* Name,byte_const,word_const,multi Node */
437 #define ACPI_TYPE_PROCESSOR             0x0C    /* Name,byte_const,Dword_const,byte_const,multi nm_o */
438 #define ACPI_TYPE_THERMAL               0x0D    /* Name, multiple Node */
439 #define ACPI_TYPE_BUFFER_FIELD          0x0E
440 #define ACPI_TYPE_DDB_HANDLE            0x0F
441 #define ACPI_TYPE_DEBUG_OBJECT          0x10
442
443 #define ACPI_TYPE_EXTERNAL_MAX          0x10
444
445 /*
446  * These are object types that do not map directly to the ACPI
447  * object_type() operator. They are used for various internal purposes only.
448  * If new predefined ACPI_TYPEs are added (via the ACPI specification), these
449  * internal types must move upwards. (There is code that depends on these
450  * values being contiguous with the external types above.)
451  */
452 #define ACPI_TYPE_LOCAL_REGION_FIELD    0x11
453 #define ACPI_TYPE_LOCAL_BANK_FIELD      0x12
454 #define ACPI_TYPE_LOCAL_INDEX_FIELD     0x13
455 #define ACPI_TYPE_LOCAL_REFERENCE       0x14    /* Arg#, Local#, Name, Debug, ref_of, Index */
456 #define ACPI_TYPE_LOCAL_ALIAS           0x15
457 #define ACPI_TYPE_LOCAL_METHOD_ALIAS    0x16
458 #define ACPI_TYPE_LOCAL_NOTIFY          0x17
459 #define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
460 #define ACPI_TYPE_LOCAL_RESOURCE        0x19
461 #define ACPI_TYPE_LOCAL_RESOURCE_FIELD  0x1A
462 #define ACPI_TYPE_LOCAL_SCOPE           0x1B    /* 1 Name, multiple object_list Nodes */
463
464 #define ACPI_TYPE_NS_NODE_MAX           0x1B    /* Last typecode used within a NS Node */
465
466 /*
467  * These are special object types that never appear in
468  * a Namespace node, only in an union acpi_operand_object
469  */
470 #define ACPI_TYPE_LOCAL_EXTRA           0x1C
471 #define ACPI_TYPE_LOCAL_DATA            0x1D
472
473 #define ACPI_TYPE_LOCAL_MAX             0x1D
474
475 /* All types above here are invalid */
476
477 #define ACPI_TYPE_INVALID               0x1E
478 #define ACPI_TYPE_NOT_FOUND             0xFF
479
480 /*
481  * All I/O
482  */
483 #define ACPI_READ                       0
484 #define ACPI_WRITE                      1
485 #define ACPI_IO_MASK                    1
486
487 /*
488  * Event Types: Fixed & General Purpose
489  */
490 typedef u32 acpi_event_type;
491
492 /*
493  * Fixed events
494  */
495 #define ACPI_EVENT_PMTIMER              0
496 #define ACPI_EVENT_GLOBAL               1
497 #define ACPI_EVENT_POWER_BUTTON         2
498 #define ACPI_EVENT_SLEEP_BUTTON         3
499 #define ACPI_EVENT_RTC                  4
500 #define ACPI_EVENT_MAX                  4
501 #define ACPI_NUM_FIXED_EVENTS           ACPI_EVENT_MAX + 1
502
503 /*
504  * Event Status - Per event
505  * -------------
506  * The encoding of acpi_event_status is illustrated below.
507  * Note that a set bit (1) indicates the property is TRUE
508  * (e.g. if bit 0 is set then the event is enabled).
509  * +-------------+-+-+-+
510  * |   Bits 31:3 |2|1|0|
511  * +-------------+-+-+-+
512  *          |     | | |
513  *          |     | | +- Enabled?
514  *          |     | +--- Enabled for wake?
515  *          |     +----- Set?
516  *          +----------- <Reserved>
517  */
518 typedef u32 acpi_event_status;
519
520 #define ACPI_EVENT_FLAG_DISABLED        (acpi_event_status) 0x00
521 #define ACPI_EVENT_FLAG_ENABLED         (acpi_event_status) 0x01
522 #define ACPI_EVENT_FLAG_WAKE_ENABLED    (acpi_event_status) 0x02
523 #define ACPI_EVENT_FLAG_SET             (acpi_event_status) 0x04
524
525 /*
526  * General Purpose Events (GPE)
527  */
528 #define ACPI_GPE_INVALID                0xFF
529 #define ACPI_GPE_MAX                    0xFF
530 #define ACPI_NUM_GPE                    256
531
532 #define ACPI_GPE_ENABLE                 0
533 #define ACPI_GPE_DISABLE                1
534
535 /*
536  * GPE info flags - Per GPE
537  * +-+-+-+---+---+-+
538  * |7|6|5|4:3|2:1|0|
539  * +-+-+-+---+---+-+
540  *  | | |  |   |  |
541  *  | | |  |   |  +--- Interrupt type: Edge or Level Triggered
542  *  | | |  |   +--- Type: Wake-only, Runtime-only, or wake/runtime
543  *  | | |  +--- Type of dispatch -- to method, handler, or none
544  *  | | +--- Enabled for runtime?
545  *  | +--- Enabled for wake?
546  *  +--- Unused
547  */
548 #define ACPI_GPE_XRUPT_TYPE_MASK        (u8) 0x01
549 #define ACPI_GPE_LEVEL_TRIGGERED        (u8) 0x01
550 #define ACPI_GPE_EDGE_TRIGGERED         (u8) 0x00
551
552 #define ACPI_GPE_TYPE_MASK              (u8) 0x06
553 #define ACPI_GPE_TYPE_WAKE_RUN          (u8) 0x06
554 #define ACPI_GPE_TYPE_WAKE              (u8) 0x02
555 #define ACPI_GPE_TYPE_RUNTIME           (u8) 0x04       /* Default */
556
557 #define ACPI_GPE_DISPATCH_MASK          (u8) 0x18
558 #define ACPI_GPE_DISPATCH_HANDLER       (u8) 0x08
559 #define ACPI_GPE_DISPATCH_METHOD        (u8) 0x10
560 #define ACPI_GPE_DISPATCH_NOT_USED      (u8) 0x00       /* Default */
561
562 #define ACPI_GPE_RUN_ENABLE_MASK        (u8) 0x20
563 #define ACPI_GPE_RUN_ENABLED            (u8) 0x20
564 #define ACPI_GPE_RUN_DISABLED           (u8) 0x00       /* Default */
565
566 #define ACPI_GPE_WAKE_ENABLE_MASK       (u8) 0x40
567 #define ACPI_GPE_WAKE_ENABLED           (u8) 0x40
568 #define ACPI_GPE_WAKE_DISABLED          (u8) 0x00       /* Default */
569
570 #define ACPI_GPE_ENABLE_MASK            (u8) 0x60       /* Both run/wake */
571
572 /*
573  * Flags for GPE and Lock interfaces
574  */
575 #define ACPI_EVENT_WAKE_ENABLE          0x2     /* acpi_gpe_enable */
576 #define ACPI_EVENT_WAKE_DISABLE         0x2     /* acpi_gpe_disable */
577
578 #define ACPI_NOT_ISR                    0x1
579 #define ACPI_ISR                        0x0
580
581 /* Notify types */
582
583 #define ACPI_SYSTEM_NOTIFY              0x1
584 #define ACPI_DEVICE_NOTIFY              0x2
585 #define ACPI_ALL_NOTIFY                 0x3
586 #define ACPI_MAX_NOTIFY_HANDLER_TYPE    0x3
587
588 #define ACPI_MAX_SYS_NOTIFY             0x7f
589
590 /* Address Space (Operation Region) Types */
591
592 typedef u8 acpi_adr_space_type;
593
594 #define ACPI_ADR_SPACE_SYSTEM_MEMORY    (acpi_adr_space_type) 0
595 #define ACPI_ADR_SPACE_SYSTEM_IO        (acpi_adr_space_type) 1
596 #define ACPI_ADR_SPACE_PCI_CONFIG       (acpi_adr_space_type) 2
597 #define ACPI_ADR_SPACE_EC               (acpi_adr_space_type) 3
598 #define ACPI_ADR_SPACE_SMBUS            (acpi_adr_space_type) 4
599 #define ACPI_ADR_SPACE_CMOS             (acpi_adr_space_type) 5
600 #define ACPI_ADR_SPACE_PCI_BAR_TARGET   (acpi_adr_space_type) 6
601 #define ACPI_ADR_SPACE_DATA_TABLE       (acpi_adr_space_type) 7
602 #define ACPI_ADR_SPACE_FIXED_HARDWARE   (acpi_adr_space_type) 127
603
604 /*
605  * bit_register IDs
606  * These are bitfields defined within the full ACPI registers
607  */
608 #define ACPI_BITREG_TIMER_STATUS                0x00
609 #define ACPI_BITREG_BUS_MASTER_STATUS           0x01
610 #define ACPI_BITREG_GLOBAL_LOCK_STATUS          0x02
611 #define ACPI_BITREG_POWER_BUTTON_STATUS         0x03
612 #define ACPI_BITREG_SLEEP_BUTTON_STATUS         0x04
613 #define ACPI_BITREG_RT_CLOCK_STATUS             0x05
614 #define ACPI_BITREG_WAKE_STATUS                 0x06
615 #define ACPI_BITREG_PCIEXP_WAKE_STATUS          0x07
616
617 #define ACPI_BITREG_TIMER_ENABLE                0x08
618 #define ACPI_BITREG_GLOBAL_LOCK_ENABLE          0x09
619 #define ACPI_BITREG_POWER_BUTTON_ENABLE         0x0A
620 #define ACPI_BITREG_SLEEP_BUTTON_ENABLE         0x0B
621 #define ACPI_BITREG_RT_CLOCK_ENABLE             0x0C
622 #define ACPI_BITREG_WAKE_ENABLE                 0x0D
623 #define ACPI_BITREG_PCIEXP_WAKE_DISABLE         0x0E
624
625 #define ACPI_BITREG_SCI_ENABLE                  0x0F
626 #define ACPI_BITREG_BUS_MASTER_RLD              0x10
627 #define ACPI_BITREG_GLOBAL_LOCK_RELEASE         0x11
628 #define ACPI_BITREG_SLEEP_TYPE_A                0x12
629 #define ACPI_BITREG_SLEEP_TYPE_B                0x13
630 #define ACPI_BITREG_SLEEP_ENABLE                0x14
631
632 #define ACPI_BITREG_ARB_DISABLE                 0x15
633
634 #define ACPI_BITREG_MAX                         0x15
635 #define ACPI_NUM_BITREG                         ACPI_BITREG_MAX + 1
636
637 /*
638  * External ACPI object definition
639  */
640 union acpi_object {
641         acpi_object_type type;  /* See definition of acpi_ns_type for values */
642         struct {
643                 acpi_object_type type;
644                 acpi_integer value;     /* The actual number */
645         } integer;
646
647         struct {
648                 acpi_object_type type;
649                 u32 length;     /* # of bytes in string, excluding trailing null */
650                 char *pointer;  /* points to the string value */
651         } string;
652
653         struct {
654                 acpi_object_type type;
655                 u32 length;     /* # of bytes in buffer */
656                 u8 *pointer;    /* points to the buffer */
657         } buffer;
658
659         struct {
660                 acpi_object_type type;
661                 u32 fill1;
662                 acpi_handle handle;     /* object reference */
663         } reference;
664
665         struct {
666                 acpi_object_type type;
667                 u32 count;      /* # of elements in package */
668                 union acpi_object *elements;    /* Pointer to an array of ACPI_OBJECTs */
669         } package;
670
671         struct {
672                 acpi_object_type type;
673                 u32 proc_id;
674                 acpi_io_address pblk_address;
675                 u32 pblk_length;
676         } processor;
677
678         struct {
679                 acpi_object_type type;
680                 u32 system_level;
681                 u32 resource_order;
682         } power_resource;
683 };
684
685 /*
686  * List of objects, used as a parameter list for control method evaluation
687  */
688 struct acpi_object_list {
689         u32 count;
690         union acpi_object *pointer;
691 };
692
693 /*
694  * Miscellaneous common Data Structures used by the interfaces
695  */
696 #define ACPI_NO_BUFFER              0
697 #define ACPI_ALLOCATE_BUFFER        (acpi_size) (-1)
698 #define ACPI_ALLOCATE_LOCAL_BUFFER  (acpi_size) (-2)
699
700 struct acpi_buffer {
701         acpi_size length;       /* Length in bytes of the buffer */
702         void *pointer;          /* pointer to buffer */
703 };
704
705 /*
706  * name_type for acpi_get_name
707  */
708 #define ACPI_FULL_PATHNAME              0
709 #define ACPI_SINGLE_NAME                1
710 #define ACPI_NAME_TYPE_MAX              1
711
712 /*
713  * Structure and flags for acpi_get_system_info
714  */
715 #define ACPI_SYS_MODE_UNKNOWN           0x0000
716 #define ACPI_SYS_MODE_ACPI              0x0001
717 #define ACPI_SYS_MODE_LEGACY            0x0002
718 #define ACPI_SYS_MODES_MASK             0x0003
719
720 /*
721  * System info returned by acpi_get_system_info()
722  */
723 struct acpi_system_info {
724         u32 acpi_ca_version;
725         u32 flags;
726         u32 timer_resolution;
727         u32 reserved1;
728         u32 reserved2;
729         u32 debug_level;
730         u32 debug_layer;
731 };
732
733 /*
734  * Types specific to the OS service interfaces
735  */
736 typedef u32(ACPI_SYSTEM_XFACE * acpi_osd_handler) (void *context);
737
738 typedef void
739  (ACPI_SYSTEM_XFACE * acpi_osd_exec_callback) (void *context);
740
741 /*
742  * Various handlers and callback procedures
743  */
744 typedef u32(*acpi_event_handler) (void *context);
745
746 typedef
747 void (*acpi_notify_handler) (acpi_handle device, u32 value, void *context);
748
749 typedef
750 void (*acpi_object_handler) (acpi_handle object, u32 function, void *data);
751
752 typedef acpi_status(*acpi_init_handler) (acpi_handle object, u32 function);
753
754 #define ACPI_INIT_DEVICE_INI        1
755
756 typedef
757 acpi_status(*acpi_exception_handler) (acpi_status aml_status,
758                                       acpi_name name,
759                                       u16 opcode,
760                                       u32 aml_offset, void *context);
761
762 /* Address Spaces (For Operation Regions) */
763
764 typedef
765 acpi_status(*acpi_adr_space_handler) (u32 function,
766                                       acpi_physical_address address,
767                                       u32 bit_width,
768                                       acpi_integer * value,
769                                       void *handler_context,
770                                       void *region_context);
771
772 #define ACPI_DEFAULT_HANDLER            NULL
773
774 typedef
775 acpi_status(*acpi_adr_space_setup) (acpi_handle region_handle,
776                                     u32 function,
777                                     void *handler_context,
778                                     void **region_context);
779
780 #define ACPI_REGION_ACTIVATE    0
781 #define ACPI_REGION_DEACTIVATE  1
782
783 typedef
784 acpi_status(*acpi_walk_callback) (acpi_handle obj_handle,
785                                   u32 nesting_level,
786                                   void *context, void **return_value);
787
788 /* Interrupt handler return values */
789
790 #define ACPI_INTERRUPT_NOT_HANDLED      0x00
791 #define ACPI_INTERRUPT_HANDLED          0x01
792
793 /* Common string version of device HIDs and UIDs */
794
795 struct acpica_device_id {
796         char value[ACPI_DEVICE_ID_LENGTH];
797 };
798
799 /* Common string version of device CIDs */
800
801 struct acpi_compatible_id {
802         char value[ACPI_MAX_CID_LENGTH];
803 };
804
805 struct acpi_compatible_id_list {
806         u32 count;
807         u32 size;
808         struct acpi_compatible_id id[1];
809 };
810
811 /* Structure and flags for acpi_get_object_info */
812
813 #define ACPI_VALID_STA                  0x0001
814 #define ACPI_VALID_ADR                  0x0002
815 #define ACPI_VALID_HID                  0x0004
816 #define ACPI_VALID_UID                  0x0008
817 #define ACPI_VALID_CID                  0x0010
818 #define ACPI_VALID_SXDS                 0x0020
819
820 /* Flags for _STA method */
821
822 #define ACPI_STA_DEVICE_PRESENT         0x01
823 #define ACPI_STA_DEVICE_ENABLED         0x02
824 #define ACPI_STA_DEVICE_UI              0x04
825 #define ACPI_STA_DEVICE_FUNCTIONING     0x08
826 #define ACPI_STA_DEVICE_OK              0x08    /* Synonym */
827 #define ACPI_STA_BATTERY_PRESENT        0x10
828
829 #define ACPI_COMMON_OBJ_INFO \
830         acpi_object_type                type;           /* ACPI object type */ \
831         acpi_name                       name    /* ACPI object Name */
832
833 struct acpi_obj_info_header {
834         ACPI_COMMON_OBJ_INFO;
835 };
836
837 /* Structure returned from Get Object Info */
838
839 struct acpi_device_info {
840         ACPI_COMMON_OBJ_INFO;
841
842         u32 valid;              /* Indicates which fields below are valid */
843         u32 current_status;     /* _STA value */
844         acpi_integer address;   /* _ADR value if any */
845         struct acpica_device_id hardware_id;    /* _HID value if any */
846         struct acpica_device_id unique_id;      /* _UID value if any */
847         u8 highest_dstates[4];  /* _sx_d values: 0xFF indicates not valid */
848         struct acpi_compatible_id_list compatibility_id;        /* List of _CIDs if any */
849 };
850
851 /* Context structs for address space handlers */
852
853 struct acpi_pci_id {
854         u16 segment;
855         u16 bus;
856         u16 device;
857         u16 function;
858 };
859
860 struct acpi_mem_space_context {
861         u32 length;
862         acpi_physical_address address;
863         acpi_physical_address mapped_physical_address;
864         u8 *mapped_logical_address;
865         acpi_size mapped_length;
866 };
867
868 /*
869  * Definitions for Resource Attributes
870  */
871 typedef u16 acpi_rs_length;     /* Resource Length field is fixed at 16 bits */
872 typedef u32 acpi_rsdesc_size;   /* Max Resource Descriptor size is (Length+3) = (64_k-1)+3 */
873
874 /*
875  *  Memory Attributes
876  */
877 #define ACPI_READ_ONLY_MEMORY           (u8) 0x00
878 #define ACPI_READ_WRITE_MEMORY          (u8) 0x01
879
880 #define ACPI_NON_CACHEABLE_MEMORY       (u8) 0x00
881 #define ACPI_CACHABLE_MEMORY            (u8) 0x01
882 #define ACPI_WRITE_COMBINING_MEMORY     (u8) 0x02
883 #define ACPI_PREFETCHABLE_MEMORY        (u8) 0x03
884
885 /*
886  *  IO Attributes
887  *  The ISA IO ranges are:     n000-n0_fFh, n400-n4_fFh, n800-n8_fFh, n_c00-n_cFFh.
888  *  The non-ISA IO ranges are: n100-n3_fFh, n500-n7_fFh, n900-n_bFFh, n_cd0-n_fFFh.
889  */
890 #define ACPI_NON_ISA_ONLY_RANGES        (u8) 0x01
891 #define ACPI_ISA_ONLY_RANGES            (u8) 0x02
892 #define ACPI_ENTIRE_RANGE               (ACPI_NON_ISA_ONLY_RANGES | ACPI_ISA_ONLY_RANGES)
893
894 /* Type of translation - 1=Sparse, 0=Dense */
895
896 #define ACPI_SPARSE_TRANSLATION         (u8) 0x01
897
898 /*
899  *  IO Port Descriptor Decode
900  */
901 #define ACPI_DECODE_10                  (u8) 0x00       /* 10-bit IO address decode */
902 #define ACPI_DECODE_16                  (u8) 0x01       /* 16-bit IO address decode */
903
904 /*
905  *  IRQ Attributes
906  */
907 #define ACPI_LEVEL_SENSITIVE            (u8) 0x00
908 #define ACPI_EDGE_SENSITIVE             (u8) 0x01
909
910 #define ACPI_ACTIVE_HIGH                (u8) 0x00
911 #define ACPI_ACTIVE_LOW                 (u8) 0x01
912
913 #define ACPI_EXCLUSIVE                  (u8) 0x00
914 #define ACPI_SHARED                     (u8) 0x01
915
916 /*
917  *  DMA Attributes
918  */
919 #define ACPI_COMPATIBILITY              (u8) 0x00
920 #define ACPI_TYPE_A                     (u8) 0x01
921 #define ACPI_TYPE_B                     (u8) 0x02
922 #define ACPI_TYPE_F                     (u8) 0x03
923
924 #define ACPI_NOT_BUS_MASTER             (u8) 0x00
925 #define ACPI_BUS_MASTER                 (u8) 0x01
926
927 #define ACPI_TRANSFER_8                 (u8) 0x00
928 #define ACPI_TRANSFER_8_16              (u8) 0x01
929 #define ACPI_TRANSFER_16                (u8) 0x02
930
931 /*
932  * Start Dependent Functions Priority definitions
933  */
934 #define ACPI_GOOD_CONFIGURATION         (u8) 0x00
935 #define ACPI_ACCEPTABLE_CONFIGURATION   (u8) 0x01
936 #define ACPI_SUB_OPTIMAL_CONFIGURATION  (u8) 0x02
937
938 /*
939  *  16, 32 and 64-bit Address Descriptor resource types
940  */
941 #define ACPI_MEMORY_RANGE               (u8) 0x00
942 #define ACPI_IO_RANGE                   (u8) 0x01
943 #define ACPI_BUS_NUMBER_RANGE           (u8) 0x02
944
945 #define ACPI_ADDRESS_NOT_FIXED          (u8) 0x00
946 #define ACPI_ADDRESS_FIXED              (u8) 0x01
947
948 #define ACPI_POS_DECODE                 (u8) 0x00
949 #define ACPI_SUB_DECODE                 (u8) 0x01
950
951 #define ACPI_PRODUCER                   (u8) 0x00
952 #define ACPI_CONSUMER                   (u8) 0x01
953
954 /*
955  * If possible, pack the following structures to byte alignment
956  */
957 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
958 #pragma pack(1)
959 #endif
960
961 /* UUID data structures for use in vendor-defined resource descriptors */
962
963 struct acpi_uuid {
964         u8 data[ACPI_UUID_LENGTH];
965 };
966
967 struct acpi_vendor_uuid {
968         u8 subtype;
969         u8 data[ACPI_UUID_LENGTH];
970 };
971
972 /*
973  *  Structures used to describe device resources
974  */
975 struct acpi_resource_irq {
976         u8 triggering;
977         u8 polarity;
978         u8 sharable;
979         u8 interrupt_count;
980         u8 interrupts[1];
981 };
982
983 struct acpi_resource_dma {
984         u8 type;
985         u8 bus_master;
986         u8 transfer;
987         u8 channel_count;
988         u8 channels[1];
989 };
990
991 struct acpi_resource_start_dependent {
992         u8 compatibility_priority;
993         u8 performance_robustness;
994 };
995
996 /*
997  * END_DEPENDENT_FUNCTIONS_RESOURCE struct is not
998  * needed because it has no fields
999  */
1000
1001 struct acpi_resource_io {
1002         u8 io_decode;
1003         u8 alignment;
1004         u8 address_length;
1005         u16 minimum;
1006         u16 maximum;
1007 };
1008
1009 struct acpi_resource_fixed_io {
1010         u16 address;
1011         u8 address_length;
1012 };
1013
1014 struct acpi_resource_vendor {
1015         u16 byte_length;
1016         u8 byte_data[1];
1017 };
1018
1019 /* Vendor resource with UUID info (introduced in ACPI 3.0) */
1020
1021 struct acpi_resource_vendor_typed {
1022         u16 byte_length;
1023         u8 uuid_subtype;
1024         u8 uuid[ACPI_UUID_LENGTH];
1025         u8 byte_data[1];
1026 };
1027
1028 struct acpi_resource_end_tag {
1029         u8 checksum;
1030 };
1031
1032 struct acpi_resource_memory24 {
1033         u8 write_protect;
1034         u16 minimum;
1035         u16 maximum;
1036         u16 alignment;
1037         u16 address_length;
1038 };
1039
1040 struct acpi_resource_memory32 {
1041         u8 write_protect;
1042         u32 minimum;
1043         u32 maximum;
1044         u32 alignment;
1045         u32 address_length;
1046 };
1047
1048 struct acpi_resource_fixed_memory32 {
1049         u8 write_protect;
1050         u32 address;
1051         u32 address_length;
1052 };
1053
1054 struct acpi_memory_attribute {
1055         u8 write_protect;
1056         u8 caching;
1057         u8 range_type;
1058         u8 translation;
1059 };
1060
1061 struct acpi_io_attribute {
1062         u8 range_type;
1063         u8 translation;
1064         u8 translation_type;
1065         u8 reserved1;
1066 };
1067
1068 union acpi_resource_attribute {
1069         struct acpi_memory_attribute mem;
1070         struct acpi_io_attribute io;
1071
1072         /* Used for the *word_space macros */
1073
1074         u8 type_specific;
1075 };
1076
1077 struct acpi_resource_source {
1078         u8 index;
1079         u16 string_length;
1080         char *string_ptr;
1081 };
1082
1083 /* Fields common to all address descriptors, 16/32/64 bit */
1084
1085 #define ACPI_RESOURCE_ADDRESS_COMMON \
1086         u8                              resource_type; \
1087         u8                              producer_consumer; \
1088         u8                              decode; \
1089         u8                              min_address_fixed; \
1090         u8                              max_address_fixed; \
1091         union acpi_resource_attribute   info;
1092
1093 struct acpi_resource_address {
1094 ACPI_RESOURCE_ADDRESS_COMMON};
1095
1096 struct acpi_resource_address16 {
1097         ACPI_RESOURCE_ADDRESS_COMMON u16 granularity;
1098         u16 minimum;
1099         u16 maximum;
1100         u16 translation_offset;
1101         u16 address_length;
1102         struct acpi_resource_source resource_source;
1103 };
1104
1105 struct acpi_resource_address32 {
1106         ACPI_RESOURCE_ADDRESS_COMMON u32 granularity;
1107         u32 minimum;
1108         u32 maximum;
1109         u32 translation_offset;
1110         u32 address_length;
1111         struct acpi_resource_source resource_source;
1112 };
1113
1114 struct acpi_resource_address64 {
1115         ACPI_RESOURCE_ADDRESS_COMMON u64 granularity;
1116         u64 minimum;
1117         u64 maximum;
1118         u64 translation_offset;
1119         u64 address_length;
1120         struct acpi_resource_source resource_source;
1121 };
1122
1123 struct acpi_resource_extended_address64 {
1124         ACPI_RESOURCE_ADDRESS_COMMON u8 revision_iD;
1125         u64 granularity;
1126         u64 minimum;
1127         u64 maximum;
1128         u64 translation_offset;
1129         u64 address_length;
1130         u64 type_specific;
1131 };
1132
1133 struct acpi_resource_extended_irq {
1134         u8 producer_consumer;
1135         u8 triggering;
1136         u8 polarity;
1137         u8 sharable;
1138         u8 interrupt_count;
1139         struct acpi_resource_source resource_source;
1140         u32 interrupts[1];
1141 };
1142
1143 struct acpi_resource_generic_register {
1144         u8 space_id;
1145         u8 bit_width;
1146         u8 bit_offset;
1147         u8 access_size;
1148         u64 address;
1149 };
1150
1151 /* ACPI_RESOURCE_TYPEs */
1152
1153 #define ACPI_RESOURCE_TYPE_IRQ                  0
1154 #define ACPI_RESOURCE_TYPE_DMA                  1
1155 #define ACPI_RESOURCE_TYPE_START_DEPENDENT      2
1156 #define ACPI_RESOURCE_TYPE_END_DEPENDENT        3
1157 #define ACPI_RESOURCE_TYPE_IO                   4
1158 #define ACPI_RESOURCE_TYPE_FIXED_IO             5
1159 #define ACPI_RESOURCE_TYPE_VENDOR               6
1160 #define ACPI_RESOURCE_TYPE_END_TAG              7
1161 #define ACPI_RESOURCE_TYPE_MEMORY24             8
1162 #define ACPI_RESOURCE_TYPE_MEMORY32             9
1163 #define ACPI_RESOURCE_TYPE_FIXED_MEMORY32       10
1164 #define ACPI_RESOURCE_TYPE_ADDRESS16            11
1165 #define ACPI_RESOURCE_TYPE_ADDRESS32            12
1166 #define ACPI_RESOURCE_TYPE_ADDRESS64            13
1167 #define ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64   14      /* ACPI 3.0 */
1168 #define ACPI_RESOURCE_TYPE_EXTENDED_IRQ         15
1169 #define ACPI_RESOURCE_TYPE_GENERIC_REGISTER     16
1170 #define ACPI_RESOURCE_TYPE_MAX                  16
1171
1172 union acpi_resource_data {
1173         struct acpi_resource_irq irq;
1174         struct acpi_resource_dma dma;
1175         struct acpi_resource_start_dependent start_dpf;
1176         struct acpi_resource_io io;
1177         struct acpi_resource_fixed_io fixed_io;
1178         struct acpi_resource_vendor vendor;
1179         struct acpi_resource_vendor_typed vendor_typed;
1180         struct acpi_resource_end_tag end_tag;
1181         struct acpi_resource_memory24 memory24;
1182         struct acpi_resource_memory32 memory32;
1183         struct acpi_resource_fixed_memory32 fixed_memory32;
1184         struct acpi_resource_address16 address16;
1185         struct acpi_resource_address32 address32;
1186         struct acpi_resource_address64 address64;
1187         struct acpi_resource_extended_address64 ext_address64;
1188         struct acpi_resource_extended_irq extended_irq;
1189         struct acpi_resource_generic_register generic_reg;
1190
1191         /* Common fields */
1192
1193         struct acpi_resource_address address;   /* Common 16/32/64 address fields */
1194 };
1195
1196 struct acpi_resource {
1197         u32 type;
1198         u32 length;
1199         union acpi_resource_data data;
1200 };
1201
1202 /* restore default alignment */
1203
1204 #pragma pack()
1205
1206 #define ACPI_RS_SIZE_MIN                    12
1207 #define ACPI_RS_SIZE_NO_DATA                8   /* Id + Length fields */
1208 #define ACPI_RS_SIZE(type)                  (u32) (ACPI_RS_SIZE_NO_DATA + sizeof (type))
1209
1210 #define ACPI_NEXT_RESOURCE(res)             (struct acpi_resource *)((u8 *) res + res->length)
1211
1212 struct acpi_pci_routing_table {
1213         u32 length;
1214         u32 pin;
1215         acpi_integer address;   /* here for 64-bit alignment */
1216         u32 source_index;
1217         char source[4];         /* pad to 64 bits so sizeof() works in all cases */
1218 };
1219
1220 #endif                          /* __ACTYPES_H__ */