1 /******************************************************************************
3 * Name: actypes.h - Common data types for the entire ACPI subsystem
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2005, R. Byron Moore
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
47 /*! [Begin] no source code translation (keep the typedefs) */
53 * Note: These macros are designed to be compiler independent as well as
54 * working around problems that some 32-bit compilers have with 64-bit
57 #define ACPI_UINT8_MAX (UINT8) (~((UINT8) 0)) /* 0xFF */
58 #define ACPI_UINT16_MAX (UINT16)(~((UINT16) 0)) /* 0xFFFF */
59 #define ACPI_UINT32_MAX (UINT32)(~((UINT32) 0)) /* 0xFFFFFFFF */
60 #define ACPI_UINT64_MAX (UINT64)(~((UINT64) 0)) /* 0xFFFFFFFFFFFFFFFF */
61 #define ACPI_ASCII_MAX 0x7F
64 #ifdef DEFINE_ALTERNATE_TYPES
66 * Types used only in translated source, defined here to enable
67 * cross-platform compilation only.
70 typedef unsigned char u8
;
71 typedef unsigned short u16
;
72 typedef unsigned int u32
;
73 typedef COMPILER_DEPENDENT_UINT64 u64
;
79 * Data types - Fixed across all compilation models (16/32/64)
81 * BOOLEAN Logical Boolean.
82 * INT8 8-bit (1 byte) signed value
83 * UINT8 8-bit (1 byte) unsigned value
84 * INT16 16-bit (2 byte) signed value
85 * UINT16 16-bit (2 byte) unsigned value
86 * INT32 32-bit (4 byte) signed value
87 * UINT32 32-bit (4 byte) unsigned value
88 * INT64 64-bit (8 byte) signed value
89 * UINT64 64-bit (8 byte) unsigned value
90 * ACPI_NATIVE_INT 32-bit on IA-32, 64-bit on IA-64 signed value
91 * ACPI_NATIVE_UINT 32-bit on IA-32, 64-bit on IA-64 unsigned value
94 #ifndef ACPI_MACHINE_WIDTH
95 #error ACPI_MACHINE_WIDTH not defined
98 #if ACPI_MACHINE_WIDTH == 64
100 /*! [Begin] no source code translation (keep the typedefs) */
103 * 64-bit type definitions
105 typedef unsigned char UINT8
;
106 typedef unsigned char BOOLEAN
;
107 typedef unsigned short UINT16
;
109 typedef unsigned int UINT32
;
110 typedef COMPILER_DEPENDENT_INT64 INT64
;
111 typedef COMPILER_DEPENDENT_UINT64 UINT64
;
113 /*! [End] no source code translation !*/
115 typedef s64 acpi_native_int
;
116 typedef u64 acpi_native_uint
;
118 typedef u64 acpi_table_ptr
;
119 typedef u64 acpi_io_address
;
120 typedef u64 acpi_physical_address
;
121 typedef u64 acpi_size
;
123 #define ALIGNED_ADDRESS_BOUNDARY 0x00000008 /* No hardware alignment support in IA64 */
124 #define ACPI_USE_NATIVE_DIVIDE /* Native 64-bit integer support */
125 #define ACPI_MAX_PTR ACPI_UINT64_MAX
126 #define ACPI_SIZE_MAX ACPI_UINT64_MAX
129 #elif ACPI_MACHINE_WIDTH == 16
131 /*! [Begin] no source code translation (keep the typedefs) */
134 * 16-bit type definitions
136 typedef unsigned char UINT8
;
137 typedef unsigned char BOOLEAN
;
138 typedef unsigned int UINT16
;
141 typedef unsigned long UINT32
;
149 /*! [End] no source code translation !*/
151 typedef u16 acpi_native_uint
;
152 typedef s16 acpi_native_int
;
154 typedef u32 acpi_table_ptr
;
155 typedef u32 acpi_io_address
;
156 typedef char *acpi_physical_address
;
157 typedef u16 acpi_size
;
159 #define ALIGNED_ADDRESS_BOUNDARY 0x00000002
160 #define ACPI_MISALIGNED_TRANSFERS
161 #define ACPI_USE_NATIVE_DIVIDE /* No 64-bit integers, ok to use native divide */
162 #define ACPI_MAX_PTR ACPI_UINT16_MAX
163 #define ACPI_SIZE_MAX ACPI_UINT16_MAX
166 * (16-bit only) internal integers must be 32-bits, so
167 * 64-bit integers cannot be supported
169 #define ACPI_NO_INTEGER64_SUPPORT
172 #elif ACPI_MACHINE_WIDTH == 32
174 /*! [Begin] no source code translation (keep the typedefs) */
177 * 32-bit type definitions (default)
179 typedef unsigned char UINT8
;
180 typedef unsigned char BOOLEAN
;
181 typedef unsigned short UINT16
;
183 typedef unsigned int UINT32
;
184 typedef COMPILER_DEPENDENT_INT64 INT64
;
185 typedef COMPILER_DEPENDENT_UINT64 UINT64
;
187 /*! [End] no source code translation !*/
189 typedef s32 acpi_native_int
;
190 typedef u32 acpi_native_uint
;
192 typedef u64 acpi_table_ptr
;
193 typedef u32 acpi_io_address
;
194 typedef u64 acpi_physical_address
;
195 typedef u32 acpi_size
;
197 #define ALIGNED_ADDRESS_BOUNDARY 0x00000004
198 #define ACPI_MISALIGNED_TRANSFERS
199 #define ACPI_MAX_PTR ACPI_UINT32_MAX
200 #define ACPI_SIZE_MAX ACPI_UINT32_MAX
203 #error unknown ACPI_MACHINE_WIDTH
208 * Miscellaneous common types
210 typedef u16 UINT16_BIT
;
211 typedef u32 UINT32_BIT
;
212 typedef acpi_native_uint ACPI_PTRDIFF
;
215 * Pointer overlays to avoid lots of typecasting for
216 * code that accepts both physical and logical pointers.
220 acpi_physical_address physical
;
222 acpi_table_ptr value
;
228 union acpi_pointers pointer
;
231 /* pointer_types for above */
233 #define ACPI_PHYSICAL_POINTER 0x01
234 #define ACPI_LOGICAL_POINTER 0x02
238 #define ACPI_PHYSICAL_ADDRESSING 0x04
239 #define ACPI_LOGICAL_ADDRESSING 0x08
240 #define ACPI_MEMORY_MODE 0x0C
242 #define ACPI_PHYSMODE_PHYSPTR ACPI_PHYSICAL_ADDRESSING | ACPI_PHYSICAL_POINTER
243 #define ACPI_LOGMODE_PHYSPTR ACPI_LOGICAL_ADDRESSING | ACPI_PHYSICAL_POINTER
244 #define ACPI_LOGMODE_LOGPTR ACPI_LOGICAL_ADDRESSING | ACPI_LOGICAL_POINTER
253 #define FALSE (1 == 0)
258 #define TRUE (1 == 1)
261 #define NULL (void *) 0
268 typedef u32 acpi_status
; /* All ACPI Exceptions */
269 typedef u32 acpi_name
; /* 4-byte ACPI name */
270 typedef char * acpi_string
; /* Null terminated ASCII string */
271 typedef void * acpi_handle
; /* Actually a ptr to an Node */
282 struct uint64_struct part
;
293 * Acpi integer width. In ACPI version 1, integers are
294 * 32 bits. In ACPI version 2, integers are 64 bits.
295 * Note that this pertains to the ACPI integer type only, not
296 * other integers used in the implementation of the ACPI CA
299 #ifdef ACPI_NO_INTEGER64_SUPPORT
301 /* 32-bit integers only, no 64-bit support */
303 typedef u32 acpi_integer
;
304 #define ACPI_INTEGER_MAX ACPI_UINT32_MAX
305 #define ACPI_INTEGER_BIT_SIZE 32
306 #define ACPI_MAX_DECIMAL_DIGITS 10 /* 2^32 = 4,294,967,296 */
308 #define ACPI_USE_NATIVE_DIVIDE /* Use compiler native 32-bit divide */
313 /* 64-bit integers */
315 typedef u64 acpi_integer
;
316 #define ACPI_INTEGER_MAX ACPI_UINT64_MAX
317 #define ACPI_INTEGER_BIT_SIZE 64
318 #define ACPI_MAX_DECIMAL_DIGITS 20 /* 2^64 = 18,446,744,073,709,551,616 */
321 #if ACPI_MACHINE_WIDTH == 64
322 #define ACPI_USE_NATIVE_DIVIDE /* Use compiler native 64-bit divide */
326 #define ACPI_MAX64_DECIMAL_DIGITS 20
327 #define ACPI_MAX32_DECIMAL_DIGITS 10
328 #define ACPI_MAX16_DECIMAL_DIGITS 5
329 #define ACPI_MAX8_DECIMAL_DIGITS 3
332 * Constants with special meanings
334 #define ACPI_ROOT_OBJECT (acpi_handle) ACPI_PTR_ADD (char, NULL, ACPI_MAX_PTR)
338 * Initialization sequence
340 #define ACPI_FULL_INITIALIZATION 0x00
341 #define ACPI_NO_ADDRESS_SPACE_INIT 0x01
342 #define ACPI_NO_HARDWARE_INIT 0x02
343 #define ACPI_NO_EVENT_INIT 0x04
344 #define ACPI_NO_HANDLER_INIT 0x08
345 #define ACPI_NO_ACPI_ENABLE 0x10
346 #define ACPI_NO_DEVICE_INIT 0x20
347 #define ACPI_NO_OBJECT_INIT 0x40
350 * Initialization state
352 #define ACPI_INITIALIZED_OK 0x01
357 #define ACPI_STATE_UNKNOWN (u8) 0xFF
359 #define ACPI_STATE_S0 (u8) 0
360 #define ACPI_STATE_S1 (u8) 1
361 #define ACPI_STATE_S2 (u8) 2
362 #define ACPI_STATE_S3 (u8) 3
363 #define ACPI_STATE_S4 (u8) 4
364 #define ACPI_STATE_S5 (u8) 5
365 #define ACPI_S_STATES_MAX ACPI_STATE_S5
366 #define ACPI_S_STATE_COUNT 6
368 #define ACPI_STATE_D0 (u8) 0
369 #define ACPI_STATE_D1 (u8) 1
370 #define ACPI_STATE_D2 (u8) 2
371 #define ACPI_STATE_D3 (u8) 3
372 #define ACPI_D_STATES_MAX ACPI_STATE_D3
373 #define ACPI_D_STATE_COUNT 4
375 #define ACPI_STATE_C0 (u8) 0
376 #define ACPI_STATE_C1 (u8) 1
377 #define ACPI_STATE_C2 (u8) 2
378 #define ACPI_STATE_C3 (u8) 3
379 #define ACPI_C_STATES_MAX ACPI_STATE_C3
380 #define ACPI_C_STATE_COUNT 4
383 * Sleep type invalid value
385 #define ACPI_SLEEP_TYPE_MAX 0x7
386 #define ACPI_SLEEP_TYPE_INVALID 0xFF
389 * Standard notify values
391 #define ACPI_NOTIFY_BUS_CHECK (u8) 0
392 #define ACPI_NOTIFY_DEVICE_CHECK (u8) 1
393 #define ACPI_NOTIFY_DEVICE_WAKE (u8) 2
394 #define ACPI_NOTIFY_EJECT_REQUEST (u8) 3
395 #define ACPI_NOTIFY_DEVICE_CHECK_LIGHT (u8) 4
396 #define ACPI_NOTIFY_FREQUENCY_MISMATCH (u8) 5
397 #define ACPI_NOTIFY_BUS_MODE_MISMATCH (u8) 6
398 #define ACPI_NOTIFY_POWER_FAULT (u8) 7
401 * Table types. These values are passed to the table related APIs
403 typedef u32 acpi_table_type
;
405 #define ACPI_TABLE_RSDP (acpi_table_type) 0
406 #define ACPI_TABLE_DSDT (acpi_table_type) 1
407 #define ACPI_TABLE_FADT (acpi_table_type) 2
408 #define ACPI_TABLE_FACS (acpi_table_type) 3
409 #define ACPI_TABLE_PSDT (acpi_table_type) 4
410 #define ACPI_TABLE_SSDT (acpi_table_type) 5
411 #define ACPI_TABLE_XSDT (acpi_table_type) 6
412 #define ACPI_TABLE_MAX 6
413 #define NUM_ACPI_TABLE_TYPES (ACPI_TABLE_MAX+1)
416 * Types associated with ACPI names and objects. The first group of
417 * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
418 * of the ACPI object_type() operator (See the ACPI Spec). Therefore,
419 * only add to the first group if the spec changes.
421 * NOTE: Types must be kept in sync with the global acpi_ns_properties
422 * and acpi_ns_type_names arrays.
424 typedef u32 acpi_object_type
;
426 #define ACPI_TYPE_ANY 0x00
427 #define ACPI_TYPE_INTEGER 0x01 /* Byte/Word/Dword/Zero/One/Ones */
428 #define ACPI_TYPE_STRING 0x02
429 #define ACPI_TYPE_BUFFER 0x03
430 #define ACPI_TYPE_PACKAGE 0x04 /* byte_const, multiple data_term/Constant/super_name */
431 #define ACPI_TYPE_FIELD_UNIT 0x05
432 #define ACPI_TYPE_DEVICE 0x06 /* Name, multiple Node */
433 #define ACPI_TYPE_EVENT 0x07
434 #define ACPI_TYPE_METHOD 0x08 /* Name, byte_const, multiple Code */
435 #define ACPI_TYPE_MUTEX 0x09
436 #define ACPI_TYPE_REGION 0x0A
437 #define ACPI_TYPE_POWER 0x0B /* Name,byte_const,word_const,multi Node */
438 #define ACPI_TYPE_PROCESSOR 0x0C /* Name,byte_const,Dword_const,byte_const,multi nm_o */
439 #define ACPI_TYPE_THERMAL 0x0D /* Name, multiple Node */
440 #define ACPI_TYPE_BUFFER_FIELD 0x0E
441 #define ACPI_TYPE_DDB_HANDLE 0x0F
442 #define ACPI_TYPE_DEBUG_OBJECT 0x10
444 #define ACPI_TYPE_EXTERNAL_MAX 0x10
447 * These are object types that do not map directly to the ACPI
448 * object_type() operator. They are used for various internal purposes only.
449 * If new predefined ACPI_TYPEs are added (via the ACPI specification), these
450 * internal types must move upwards. (There is code that depends on these
451 * values being contiguous with the external types above.)
453 #define ACPI_TYPE_LOCAL_REGION_FIELD 0x11
454 #define ACPI_TYPE_LOCAL_BANK_FIELD 0x12
455 #define ACPI_TYPE_LOCAL_INDEX_FIELD 0x13
456 #define ACPI_TYPE_LOCAL_REFERENCE 0x14 /* Arg#, Local#, Name, Debug, ref_of, Index */
457 #define ACPI_TYPE_LOCAL_ALIAS 0x15
458 #define ACPI_TYPE_LOCAL_METHOD_ALIAS 0x16
459 #define ACPI_TYPE_LOCAL_NOTIFY 0x17
460 #define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
461 #define ACPI_TYPE_LOCAL_RESOURCE 0x19
462 #define ACPI_TYPE_LOCAL_RESOURCE_FIELD 0x1A
463 #define ACPI_TYPE_LOCAL_SCOPE 0x1B /* 1 Name, multiple object_list Nodes */
465 #define ACPI_TYPE_NS_NODE_MAX 0x1B /* Last typecode used within a NS Node */
468 * These are special object types that never appear in
469 * a Namespace node, only in an union acpi_operand_object
471 #define ACPI_TYPE_LOCAL_EXTRA 0x1C
472 #define ACPI_TYPE_LOCAL_DATA 0x1D
474 #define ACPI_TYPE_LOCAL_MAX 0x1D
476 /* All types above here are invalid */
478 #define ACPI_TYPE_INVALID 0x1E
479 #define ACPI_TYPE_NOT_FOUND 0xFF
482 * Bitmapped ACPI types. Used internally only
484 #define ACPI_BTYPE_ANY 0x00000000
485 #define ACPI_BTYPE_INTEGER 0x00000001
486 #define ACPI_BTYPE_STRING 0x00000002
487 #define ACPI_BTYPE_BUFFER 0x00000004
488 #define ACPI_BTYPE_PACKAGE 0x00000008
489 #define ACPI_BTYPE_FIELD_UNIT 0x00000010
490 #define ACPI_BTYPE_DEVICE 0x00000020
491 #define ACPI_BTYPE_EVENT 0x00000040
492 #define ACPI_BTYPE_METHOD 0x00000080
493 #define ACPI_BTYPE_MUTEX 0x00000100
494 #define ACPI_BTYPE_REGION 0x00000200
495 #define ACPI_BTYPE_POWER 0x00000400
496 #define ACPI_BTYPE_PROCESSOR 0x00000800
497 #define ACPI_BTYPE_THERMAL 0x00001000
498 #define ACPI_BTYPE_BUFFER_FIELD 0x00002000
499 #define ACPI_BTYPE_DDB_HANDLE 0x00004000
500 #define ACPI_BTYPE_DEBUG_OBJECT 0x00008000
501 #define ACPI_BTYPE_REFERENCE 0x00010000
502 #define ACPI_BTYPE_RESOURCE 0x00020000
504 #define ACPI_BTYPE_COMPUTE_DATA (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER)
506 #define ACPI_BTYPE_DATA (ACPI_BTYPE_COMPUTE_DATA | ACPI_BTYPE_PACKAGE)
507 #define ACPI_BTYPE_DATA_REFERENCE (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE | ACPI_BTYPE_DDB_HANDLE)
508 #define ACPI_BTYPE_DEVICE_OBJECTS (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR)
509 #define ACPI_BTYPE_OBJECTS_AND_REFS 0x0001FFFF /* ARG or LOCAL */
510 #define ACPI_BTYPE_ALL_OBJECTS 0x0000FFFF
517 #define ACPI_IO_MASK 1
520 * Event Types: Fixed & General Purpose
522 typedef u32 acpi_event_type
;
527 #define ACPI_EVENT_PMTIMER 0
528 #define ACPI_EVENT_GLOBAL 1
529 #define ACPI_EVENT_POWER_BUTTON 2
530 #define ACPI_EVENT_SLEEP_BUTTON 3
531 #define ACPI_EVENT_RTC 4
532 #define ACPI_EVENT_MAX 4
533 #define ACPI_NUM_FIXED_EVENTS ACPI_EVENT_MAX + 1
536 * Event Status - Per event
538 * The encoding of acpi_event_status is illustrated below.
539 * Note that a set bit (1) indicates the property is TRUE
540 * (e.g. if bit 0 is set then the event is enabled).
541 * +-------------+-+-+-+
542 * | Bits 31:3 |2|1|0|
543 * +-------------+-+-+-+
546 * | | +--- Enabled for wake?
548 * +----------- <Reserved>
550 typedef u32 acpi_event_status
;
552 #define ACPI_EVENT_FLAG_DISABLED (acpi_event_status) 0x00
553 #define ACPI_EVENT_FLAG_ENABLED (acpi_event_status) 0x01
554 #define ACPI_EVENT_FLAG_WAKE_ENABLED (acpi_event_status) 0x02
555 #define ACPI_EVENT_FLAG_SET (acpi_event_status) 0x04
558 * General Purpose Events (GPE)
560 #define ACPI_GPE_INVALID 0xFF
561 #define ACPI_GPE_MAX 0xFF
562 #define ACPI_NUM_GPE 256
564 #define ACPI_GPE_ENABLE 0
565 #define ACPI_GPE_DISABLE 1
569 * GPE info flags - Per GPE
574 * | | | | | +--- Interrupt type: Edge or Level Triggered
575 * | | | | +--- Type: Wake-only, Runtime-only, or wake/runtime
576 * | | | +--- Type of dispatch -- to method, handler, or none
577 * | | +--- Enabled for runtime?
578 * | +--- Enabled for wake?
579 * +--- System state when GPE ocurred (running/waking)
581 #define ACPI_GPE_XRUPT_TYPE_MASK (u8) 0x01
582 #define ACPI_GPE_LEVEL_TRIGGERED (u8) 0x01
583 #define ACPI_GPE_EDGE_TRIGGERED (u8) 0x00
585 #define ACPI_GPE_TYPE_MASK (u8) 0x06
586 #define ACPI_GPE_TYPE_WAKE_RUN (u8) 0x06
587 #define ACPI_GPE_TYPE_WAKE (u8) 0x02
588 #define ACPI_GPE_TYPE_RUNTIME (u8) 0x04 /* Default */
590 #define ACPI_GPE_DISPATCH_MASK (u8) 0x18
591 #define ACPI_GPE_DISPATCH_HANDLER (u8) 0x08
592 #define ACPI_GPE_DISPATCH_METHOD (u8) 0x10
593 #define ACPI_GPE_DISPATCH_NOT_USED (u8) 0x00 /* Default */
595 #define ACPI_GPE_RUN_ENABLE_MASK (u8) 0x20
596 #define ACPI_GPE_RUN_ENABLED (u8) 0x20
597 #define ACPI_GPE_RUN_DISABLED (u8) 0x00 /* Default */
599 #define ACPI_GPE_WAKE_ENABLE_MASK (u8) 0x40
600 #define ACPI_GPE_WAKE_ENABLED (u8) 0x40
601 #define ACPI_GPE_WAKE_DISABLED (u8) 0x00 /* Default */
603 #define ACPI_GPE_ENABLE_MASK (u8) 0x60 /* Both run/wake */
605 #define ACPI_GPE_SYSTEM_MASK (u8) 0x80
606 #define ACPI_GPE_SYSTEM_RUNNING (u8) 0x80
607 #define ACPI_GPE_SYSTEM_WAKING (u8) 0x00
610 * Flags for GPE and Lock interfaces
612 #define ACPI_EVENT_WAKE_ENABLE 0x2 /* acpi_gpe_enable */
613 #define ACPI_EVENT_WAKE_DISABLE 0x2 /* acpi_gpe_disable */
615 #define ACPI_NOT_ISR 0x1
621 #define ACPI_SYSTEM_NOTIFY 0x1
622 #define ACPI_DEVICE_NOTIFY 0x2
623 #define ACPI_ALL_NOTIFY 0x3
624 #define ACPI_MAX_NOTIFY_HANDLER_TYPE 0x3
626 #define ACPI_MAX_SYS_NOTIFY 0x7f
629 /* Address Space (Operation Region) Types */
631 typedef u8 acpi_adr_space_type
;
633 #define ACPI_ADR_SPACE_SYSTEM_MEMORY (acpi_adr_space_type) 0
634 #define ACPI_ADR_SPACE_SYSTEM_IO (acpi_adr_space_type) 1
635 #define ACPI_ADR_SPACE_PCI_CONFIG (acpi_adr_space_type) 2
636 #define ACPI_ADR_SPACE_EC (acpi_adr_space_type) 3
637 #define ACPI_ADR_SPACE_SMBUS (acpi_adr_space_type) 4
638 #define ACPI_ADR_SPACE_CMOS (acpi_adr_space_type) 5
639 #define ACPI_ADR_SPACE_PCI_BAR_TARGET (acpi_adr_space_type) 6
640 #define ACPI_ADR_SPACE_DATA_TABLE (acpi_adr_space_type) 7
641 #define ACPI_ADR_SPACE_FIXED_HARDWARE (acpi_adr_space_type) 127
646 * These are bitfields defined within the full ACPI registers
648 #define ACPI_BITREG_TIMER_STATUS 0x00
649 #define ACPI_BITREG_BUS_MASTER_STATUS 0x01
650 #define ACPI_BITREG_GLOBAL_LOCK_STATUS 0x02
651 #define ACPI_BITREG_POWER_BUTTON_STATUS 0x03
652 #define ACPI_BITREG_SLEEP_BUTTON_STATUS 0x04
653 #define ACPI_BITREG_RT_CLOCK_STATUS 0x05
654 #define ACPI_BITREG_WAKE_STATUS 0x06
655 #define ACPI_BITREG_PCIEXP_WAKE_STATUS 0x07
657 #define ACPI_BITREG_TIMER_ENABLE 0x08
658 #define ACPI_BITREG_GLOBAL_LOCK_ENABLE 0x09
659 #define ACPI_BITREG_POWER_BUTTON_ENABLE 0x0A
660 #define ACPI_BITREG_SLEEP_BUTTON_ENABLE 0x0B
661 #define ACPI_BITREG_RT_CLOCK_ENABLE 0x0C
662 #define ACPI_BITREG_WAKE_ENABLE 0x0D
663 #define ACPI_BITREG_PCIEXP_WAKE_DISABLE 0x0E
665 #define ACPI_BITREG_SCI_ENABLE 0x0F
666 #define ACPI_BITREG_BUS_MASTER_RLD 0x10
667 #define ACPI_BITREG_GLOBAL_LOCK_RELEASE 0x11
668 #define ACPI_BITREG_SLEEP_TYPE_A 0x12
669 #define ACPI_BITREG_SLEEP_TYPE_B 0x13
670 #define ACPI_BITREG_SLEEP_ENABLE 0x14
672 #define ACPI_BITREG_ARB_DISABLE 0x15
674 #define ACPI_BITREG_MAX 0x15
675 #define ACPI_NUM_BITREG ACPI_BITREG_MAX + 1
679 * External ACPI object definition
683 acpi_object_type type
; /* See definition of acpi_ns_type for values */
686 acpi_object_type type
;
687 acpi_integer value
; /* The actual number */
692 acpi_object_type type
;
693 u32 length
; /* # of bytes in string, excluding trailing null */
694 char *pointer
; /* points to the string value */
699 acpi_object_type type
;
700 u32 length
; /* # of bytes in buffer */
701 u8
*pointer
; /* points to the buffer */
706 acpi_object_type type
;
708 acpi_handle handle
; /* object reference */
713 acpi_object_type type
;
714 u32 count
; /* # of elements in package */
715 union acpi_object
*elements
; /* Pointer to an array of ACPI_OBJECTs */
720 acpi_object_type type
;
722 acpi_io_address pblk_address
;
728 acpi_object_type type
;
736 * List of objects, used as a parameter list for control method evaluation
738 struct acpi_object_list
741 union acpi_object
*pointer
;
746 * Miscellaneous common Data Structures used by the interfaces
748 #define ACPI_NO_BUFFER 0
749 #define ACPI_ALLOCATE_BUFFER (acpi_size) (-1)
750 #define ACPI_ALLOCATE_LOCAL_BUFFER (acpi_size) (-2)
754 acpi_size length
; /* Length in bytes of the buffer */
755 void *pointer
; /* pointer to buffer */
760 * name_type for acpi_get_name
762 #define ACPI_FULL_PATHNAME 0
763 #define ACPI_SINGLE_NAME 1
764 #define ACPI_NAME_TYPE_MAX 1
768 * Structure and flags for acpi_get_system_info
770 #define ACPI_SYS_MODE_UNKNOWN 0x0000
771 #define ACPI_SYS_MODE_ACPI 0x0001
772 #define ACPI_SYS_MODE_LEGACY 0x0002
773 #define ACPI_SYS_MODES_MASK 0x0003
777 * ACPI Table Info. One per ACPI table _type_
779 struct acpi_table_info
786 * System info returned by acpi_get_system_info()
788 struct acpi_system_info
792 u32 timer_resolution
;
798 struct acpi_table_info table_info
[NUM_ACPI_TABLE_TYPES
];
803 * Types specific to the OS service interfaces
806 (ACPI_SYSTEM_XFACE
*acpi_osd_handler
) (
810 (ACPI_SYSTEM_XFACE
*acpi_osd_exec_callback
) (
814 * Various handlers and callback procedures
817 u32 (*acpi_event_handler
) (
821 void (*acpi_notify_handler
) (
827 void (*acpi_object_handler
) (
833 acpi_status (*acpi_init_handler
) (
837 #define ACPI_INIT_DEVICE_INI 1
840 acpi_status (*acpi_exception_handler
) (
841 acpi_status aml_status
,
848 /* Address Spaces (For Operation Regions) */
851 acpi_status (*acpi_adr_space_handler
) (
853 acpi_physical_address address
,
856 void *handler_context
,
857 void *region_context
);
859 #define ACPI_DEFAULT_HANDLER NULL
863 acpi_status (*acpi_adr_space_setup
) (
864 acpi_handle region_handle
,
866 void *handler_context
,
867 void **region_context
);
869 #define ACPI_REGION_ACTIVATE 0
870 #define ACPI_REGION_DEACTIVATE 1
873 acpi_status (*acpi_walk_callback
) (
874 acpi_handle obj_handle
,
877 void **return_value
);
880 /* Interrupt handler return values */
882 #define ACPI_INTERRUPT_NOT_HANDLED 0x00
883 #define ACPI_INTERRUPT_HANDLED 0x01
886 /* Common string version of device HIDs and UIDs */
888 struct acpi_device_id
890 char value
[ACPI_DEVICE_ID_LENGTH
];
893 /* Common string version of device CIDs */
895 struct acpi_compatible_id
897 char value
[ACPI_MAX_CID_LENGTH
];
900 struct acpi_compatible_id_list
904 struct acpi_compatible_id id
[1];
908 /* Structure and flags for acpi_get_object_info */
910 #define ACPI_VALID_STA 0x0001
911 #define ACPI_VALID_ADR 0x0002
912 #define ACPI_VALID_HID 0x0004
913 #define ACPI_VALID_UID 0x0008
914 #define ACPI_VALID_CID 0x0010
915 #define ACPI_VALID_SXDS 0x0020
918 #define ACPI_COMMON_OBJ_INFO \
919 acpi_object_type type; /* ACPI object type */ \
920 acpi_name name /* ACPI object Name */
923 struct acpi_obj_info_header
925 ACPI_COMMON_OBJ_INFO
;
929 /* Structure returned from Get Object Info */
931 struct acpi_device_info
933 ACPI_COMMON_OBJ_INFO
;
935 u32 valid
; /* Indicates which fields below are valid */
936 u32 current_status
; /* _STA value */
937 acpi_integer address
; /* _ADR value if any */
938 struct acpi_device_id hardware_id
; /* _HID value if any */
939 struct acpi_device_id unique_id
; /* _UID value if any */
940 u8 highest_dstates
[4]; /* _sx_d values: 0xFF indicates not valid */
941 struct acpi_compatible_id_list compatibility_id
; /* List of _CIDs if any */
945 /* Context structs for address space handlers */
956 struct acpi_mem_space_context
959 acpi_physical_address address
;
960 acpi_physical_address mapped_physical_address
;
961 u8
*mapped_logical_address
;
962 acpi_size mapped_length
;
967 * Definitions for Resource Attributes
973 #define ACPI_READ_ONLY_MEMORY (u8) 0x00
974 #define ACPI_READ_WRITE_MEMORY (u8) 0x01
976 #define ACPI_NON_CACHEABLE_MEMORY (u8) 0x00
977 #define ACPI_CACHABLE_MEMORY (u8) 0x01
978 #define ACPI_WRITE_COMBINING_MEMORY (u8) 0x02
979 #define ACPI_PREFETCHABLE_MEMORY (u8) 0x03
983 * The ISA Io ranges are: n000-n0_ffh, n400-n4_ffh, n800-n8_ffh, n_c00-n_cFFh.
984 * The non-ISA Io ranges are: n100-n3_ffh, n500-n7_ffh, n900-n_bFfh, n_cd0-n_fFFh.
986 #define ACPI_NON_ISA_ONLY_RANGES (u8) 0x01
987 #define ACPI_ISA_ONLY_RANGES (u8) 0x02
988 #define ACPI_ENTIRE_RANGE (ACPI_NON_ISA_ONLY_RANGES | ACPI_ISA_ONLY_RANGES)
990 #define ACPI_SPARSE_TRANSLATION (u8) 0x03
993 * IO Port Descriptor Decode
995 #define ACPI_DECODE_10 (u8) 0x00 /* 10-bit IO address decode */
996 #define ACPI_DECODE_16 (u8) 0x01 /* 16-bit IO address decode */
1001 #define ACPI_EDGE_SENSITIVE (u8) 0x00
1002 #define ACPI_LEVEL_SENSITIVE (u8) 0x01
1004 #define ACPI_ACTIVE_HIGH (u8) 0x00
1005 #define ACPI_ACTIVE_LOW (u8) 0x01
1007 #define ACPI_EXCLUSIVE (u8) 0x00
1008 #define ACPI_SHARED (u8) 0x01
1013 #define ACPI_COMPATIBILITY (u8) 0x00
1014 #define ACPI_TYPE_A (u8) 0x01
1015 #define ACPI_TYPE_B (u8) 0x02
1016 #define ACPI_TYPE_F (u8) 0x03
1018 #define ACPI_NOT_BUS_MASTER (u8) 0x00
1019 #define ACPI_BUS_MASTER (u8) 0x01
1021 #define ACPI_TRANSFER_8 (u8) 0x00
1022 #define ACPI_TRANSFER_8_16 (u8) 0x01
1023 #define ACPI_TRANSFER_16 (u8) 0x02
1026 * Start Dependent Functions Priority definitions
1028 #define ACPI_GOOD_CONFIGURATION (u8) 0x00
1029 #define ACPI_ACCEPTABLE_CONFIGURATION (u8) 0x01
1030 #define ACPI_SUB_OPTIMAL_CONFIGURATION (u8) 0x02
1033 * 16, 32 and 64-bit Address Descriptor resource types
1035 #define ACPI_MEMORY_RANGE (u8) 0x00
1036 #define ACPI_IO_RANGE (u8) 0x01
1037 #define ACPI_BUS_NUMBER_RANGE (u8) 0x02
1039 #define ACPI_ADDRESS_NOT_FIXED (u8) 0x00
1040 #define ACPI_ADDRESS_FIXED (u8) 0x01
1042 #define ACPI_POS_DECODE (u8) 0x00
1043 #define ACPI_SUB_DECODE (u8) 0x01
1045 #define ACPI_PRODUCER (u8) 0x00
1046 #define ACPI_CONSUMER (u8) 0x01
1050 * Structures used to describe device resources
1052 struct acpi_resource_irq
1055 u32 active_high_low
;
1056 u32 shared_exclusive
;
1057 u32 number_of_interrupts
;
1061 struct acpi_resource_dma
1066 u32 number_of_channels
;
1070 struct acpi_resource_start_dpf
1072 u32 compatibility_priority
;
1073 u32 performance_robustness
;
1077 * END_DEPENDENT_FUNCTIONS_RESOURCE struct is not
1078 * needed because it has no fields
1081 struct acpi_resource_io
1084 u32 min_base_address
;
1085 u32 max_base_address
;
1090 struct acpi_resource_fixed_io
1096 struct acpi_resource_vendor
1102 struct acpi_resource_end_tag
1107 struct acpi_resource_mem24
1109 u32 read_write_attribute
;
1110 u32 min_base_address
;
1111 u32 max_base_address
;
1116 struct acpi_resource_mem32
1118 u32 read_write_attribute
;
1119 u32 min_base_address
;
1120 u32 max_base_address
;
1125 struct acpi_resource_fixed_mem32
1127 u32 read_write_attribute
;
1128 u32 range_base_address
;
1132 struct acpi_memory_attribute
1134 u16 cache_attribute
;
1135 u16 read_write_attribute
;
1138 struct acpi_io_attribute
1140 u16 range_attribute
;
1141 u16 translation_attribute
;
1144 struct acpi_bus_attribute
1150 union acpi_resource_attribute
1152 struct acpi_memory_attribute memory
;
1153 struct acpi_io_attribute io
;
1154 struct acpi_bus_attribute bus
;
1157 struct acpi_resource_source
1164 struct acpi_resource_address16
1167 u32 producer_consumer
;
1169 u32 min_address_fixed
;
1170 u32 max_address_fixed
;
1171 union acpi_resource_attribute attribute
;
1173 u32 min_address_range
;
1174 u32 max_address_range
;
1175 u32 address_translation_offset
;
1177 struct acpi_resource_source resource_source
;
1180 struct acpi_resource_address32
1183 u32 producer_consumer
;
1185 u32 min_address_fixed
;
1186 u32 max_address_fixed
;
1187 union acpi_resource_attribute attribute
;
1189 u32 min_address_range
;
1190 u32 max_address_range
;
1191 u32 address_translation_offset
;
1193 struct acpi_resource_source resource_source
;
1196 struct acpi_resource_address64
1199 u32 producer_consumer
;
1201 u32 min_address_fixed
;
1202 u32 max_address_fixed
;
1203 union acpi_resource_attribute attribute
;
1205 u64 min_address_range
;
1206 u64 max_address_range
;
1207 u64 address_translation_offset
;
1209 u64 type_specific_attributes
;
1210 struct acpi_resource_source resource_source
;
1213 struct acpi_resource_ext_irq
1215 u32 producer_consumer
;
1217 u32 active_high_low
;
1218 u32 shared_exclusive
;
1219 u32 number_of_interrupts
;
1220 struct acpi_resource_source resource_source
;
1225 /* ACPI_RESOURCE_TYPEs */
1227 #define ACPI_RSTYPE_IRQ 0
1228 #define ACPI_RSTYPE_DMA 1
1229 #define ACPI_RSTYPE_START_DPF 2
1230 #define ACPI_RSTYPE_END_DPF 3
1231 #define ACPI_RSTYPE_IO 4
1232 #define ACPI_RSTYPE_FIXED_IO 5
1233 #define ACPI_RSTYPE_VENDOR 6
1234 #define ACPI_RSTYPE_END_TAG 7
1235 #define ACPI_RSTYPE_MEM24 8
1236 #define ACPI_RSTYPE_MEM32 9
1237 #define ACPI_RSTYPE_FIXED_MEM32 10
1238 #define ACPI_RSTYPE_ADDRESS16 11
1239 #define ACPI_RSTYPE_ADDRESS32 12
1240 #define ACPI_RSTYPE_ADDRESS64 13
1241 #define ACPI_RSTYPE_EXT_IRQ 14
1243 typedef u32 acpi_resource_type
;
1245 union acpi_resource_data
1247 struct acpi_resource_irq irq
;
1248 struct acpi_resource_dma dma
;
1249 struct acpi_resource_start_dpf start_dpf
;
1250 struct acpi_resource_io io
;
1251 struct acpi_resource_fixed_io fixed_io
;
1252 struct acpi_resource_vendor vendor_specific
;
1253 struct acpi_resource_end_tag end_tag
;
1254 struct acpi_resource_mem24 memory24
;
1255 struct acpi_resource_mem32 memory32
;
1256 struct acpi_resource_fixed_mem32 fixed_memory32
;
1257 struct acpi_resource_address16 address16
;
1258 struct acpi_resource_address32 address32
;
1259 struct acpi_resource_address64 address64
;
1260 struct acpi_resource_ext_irq extended_irq
;
1263 struct acpi_resource
1265 acpi_resource_type id
;
1267 union acpi_resource_data data
;
1270 #define ACPI_RESOURCE_LENGTH 12
1271 #define ACPI_RESOURCE_LENGTH_NO_DATA 8 /* Id + Length fields */
1273 #define ACPI_SIZEOF_RESOURCE(type) (ACPI_RESOURCE_LENGTH_NO_DATA + sizeof (type))
1275 #define ACPI_NEXT_RESOURCE(res) (struct acpi_resource *)((u8 *) res + res->length)
1277 #ifdef ACPI_MISALIGNED_TRANSFERS
1278 #define ACPI_ALIGN_RESOURCE_SIZE(length) (length)
1280 #define ACPI_ALIGN_RESOURCE_SIZE(length) ACPI_ROUND_UP_TO_NATIVE_WORD(length)
1284 * END: of definitions for Resource Attributes
1288 struct acpi_pci_routing_table
1292 acpi_integer address
; /* here for 64-bit alignment */
1294 char source
[4]; /* pad to 64 bits so sizeof() works in all cases */
1298 * END: of definitions for PCI Routing tables
1302 #endif /* __ACTYPES_H__ */