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