1
/******************************************************************************
3
* Name: actypes.h - Common data types for the entire ACPI subsystem
5
*****************************************************************************/
8
* Copyright (C) 2000 - 2011, Intel Corp.
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
/* acpisrc:struct_defs -- for acpisrc conversion */
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
54
#ifndef ACPI_MACHINE_WIDTH
55
#error ACPI_MACHINE_WIDTH not defined
58
/*! [Begin] no source code translation */
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
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
73
* Architecture-specific ACPICA Subsystem Data Types
75
* The goal of these types is to provide source code portability across
76
* 16-bit, 32-bit, and 64-bit targets.
78
* 1) The following types are of fixed size for all targets (16/32/64):
80
* BOOLEAN Logical boolean
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
87
* INT16 16-bit (2 byte) signed value
88
* INT32 32-bit (4 byte) signed value
89
* INT64 64-bit (8 byte) signed value
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
96
* Datatype LP64 ILP64 LLP64 ILP32 LP32 16bit
98
* short 16 16 16 16 16 16
100
* int 32 64 32 32 16 16
101
* long 64 64 32 32 32 32
103
* pointer 64 64 64 32 32 32
105
* Note: ILP64 and LP32 are currently not supported.
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. ACPI_SIZE is needed because there is no guarantee that a
114
* kernel-level C library is present.
116
* ACPI_SIZE 16/32/64-bit unsigned value
117
* ACPI_NATIVE_INT 16/32/64-bit signed value
120
/*******************************************************************************
122
* Common types for all compilers, all targets
124
******************************************************************************/
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;
132
/*! [End] no source code translation !*/
135
* Value returned by acpi_os_get_thread_id. There is no standard "thread_id"
136
* across operating systems or even the various UNIX systems. Since ACPICA
137
* only needs the thread ID as a unique thread identifier, we use a u64
138
* as the only common data type - it will accommodate any type of pointer or
139
* any type of integer. It is up to the host-dependent OSL to cast the
140
* native thread ID type to a u64 (in acpi_os_get_thread_id).
142
#define acpi_thread_id u64
144
/*******************************************************************************
146
* Types specific to 64-bit targets
148
******************************************************************************/
150
#if ACPI_MACHINE_WIDTH == 64
152
/*! [Begin] no source code translation (keep the typedefs as-is) */
154
typedef unsigned int UINT32;
157
/*! [End] no source code translation !*/
159
typedef s64 acpi_native_int;
161
typedef u64 acpi_size;
162
typedef u64 acpi_io_address;
163
typedef u64 acpi_physical_address;
165
#define ACPI_MAX_PTR ACPI_UINT64_MAX
166
#define ACPI_SIZE_MAX ACPI_UINT64_MAX
168
#define ACPI_USE_NATIVE_DIVIDE /* Has native 64-bit integer support */
171
* In the case of the Itanium Processor Family (IPF), the hardware does not
172
* support misaligned memory transfers. Set the MISALIGNMENT_NOT_SUPPORTED flag
173
* to indicate that special precautions must be taken to avoid alignment faults.
174
* (IA64 or ia64 is currently used by existing compilers to indicate IPF.)
176
* Note: Em64_t and other X86-64 processors support misaligned transfers,
177
* so there is no need to define this flag.
179
#if defined (__IA64__) || defined (__ia64__)
180
#define ACPI_MISALIGNMENT_NOT_SUPPORTED
183
/*******************************************************************************
185
* Types specific to 32-bit targets
187
******************************************************************************/
189
#elif ACPI_MACHINE_WIDTH == 32
191
/*! [Begin] no source code translation (keep the typedefs as-is) */
193
typedef unsigned int UINT32;
196
/*! [End] no source code translation !*/
198
typedef s32 acpi_native_int;
200
typedef u32 acpi_size;
201
typedef u32 acpi_io_address;
202
typedef u32 acpi_physical_address;
204
#define ACPI_MAX_PTR ACPI_UINT32_MAX
205
#define ACPI_SIZE_MAX ACPI_UINT32_MAX
209
/* ACPI_MACHINE_WIDTH must be either 64 or 32 */
211
#error unknown ACPI_MACHINE_WIDTH
214
/*******************************************************************************
218
* If the defaults below are not appropriate for the host system, they can
219
* be defined in the OS-specific header, and this will take precedence.
221
******************************************************************************/
223
/* Flags for acpi_os_acquire_lock/acpi_os_release_lock */
225
#ifndef acpi_cpu_flags
226
#define acpi_cpu_flags acpi_size
229
/* Object returned from acpi_os_create_cache */
232
#ifdef ACPI_USE_LOCAL_CACHE
233
#define acpi_cache_t struct acpi_memory_list
235
#define acpi_cache_t void *
240
* Synchronization objects - Mutexes, Semaphores, and spin_locks
242
#if (ACPI_MUTEX_TYPE == ACPI_BINARY_SEMAPHORE)
244
* These macros are used if the host OS does not support a mutex object.
245
* Map the OSL Mutex interfaces to binary semaphores.
247
#define acpi_mutex acpi_semaphore
248
#define acpi_os_create_mutex(out_handle) acpi_os_create_semaphore (1, 1, out_handle)
249
#define acpi_os_delete_mutex(handle) (void) acpi_os_delete_semaphore (handle)
250
#define acpi_os_acquire_mutex(handle,time) acpi_os_wait_semaphore (handle, 1, time)
251
#define acpi_os_release_mutex(handle) (void) acpi_os_signal_semaphore (handle, 1)
254
/* Configurable types for synchronization objects */
256
#ifndef acpi_spinlock
257
#define acpi_spinlock void *
260
#ifndef acpi_semaphore
261
#define acpi_semaphore void *
265
#define acpi_mutex void *
268
/*******************************************************************************
270
* Compiler-dependent types
272
* If the defaults below are not appropriate for the host compiler, they can
273
* be defined in the compiler-specific header, and this will take precedence.
275
******************************************************************************/
277
/* Use C99 uintptr_t for pointer casting if available, "void *" otherwise */
279
#ifndef acpi_uintptr_t
280
#define acpi_uintptr_t void *
284
* ACPI_PRINTF_LIKE is used to tag functions as "printf-like" because
285
* some compilers can catch printf format string problems
287
#ifndef ACPI_PRINTF_LIKE
288
#define ACPI_PRINTF_LIKE(c)
292
* Some compilers complain about unused variables. Sometimes we don't want to
293
* use all the variables (for example, _acpi_module_name). This allows us
294
* to tell the compiler in a per-variable manner that a variable
297
#ifndef ACPI_UNUSED_VAR
298
#define ACPI_UNUSED_VAR
302
* All ACPICA functions that are available to the rest of the kernel are
303
* tagged with this macro which can be defined as appropriate for the host.
305
#ifndef ACPI_EXPORT_SYMBOL
306
#define ACPI_EXPORT_SYMBOL(symbol)
309
/******************************************************************************
311
* ACPI Specification constants (Do not change unless the specification changes)
313
*****************************************************************************/
315
/* Number of distinct FADT-based GPE register blocks (GPE0 and GPE1) */
317
#define ACPI_MAX_GPE_BLOCKS 2
319
/* Default ACPI register widths */
321
#define ACPI_GPE_REGISTER_WIDTH 8
322
#define ACPI_PM1_REGISTER_WIDTH 16
323
#define ACPI_PM2_REGISTER_WIDTH 8
324
#define ACPI_PM_TIMER_WIDTH 32
326
/* Names within the namespace are 4 bytes long */
328
#define ACPI_NAME_SIZE 4
329
#define ACPI_PATH_SEGMENT_LENGTH 5 /* 4 chars for name + 1 char for separator */
330
#define ACPI_PATH_SEPARATOR '.'
332
/* Sizes for ACPI table headers */
334
#define ACPI_OEM_ID_SIZE 6
335
#define ACPI_OEM_TABLE_ID_SIZE 8
337
/* ACPI/PNP hardware IDs */
339
#define PCI_ROOT_HID_STRING "PNP0A03"
340
#define PCI_EXPRESS_ROOT_HID_STRING "PNP0A08"
342
/* PM Timer ticks per second (HZ) */
344
#define PM_TIMER_FREQUENCY 3579545
346
/*******************************************************************************
350
******************************************************************************/
352
/* Logical defines and NULL */
357
#define FALSE (1 == 0)
362
#define TRUE (1 == 1)
365
#define NULL (void *) 0
369
* Miscellaneous types
371
typedef u32 acpi_status; /* All ACPI Exceptions */
372
typedef u32 acpi_name; /* 4-byte ACPI name */
373
typedef char *acpi_string; /* Null terminated ASCII string */
374
typedef void *acpi_handle; /* Actually a ptr to a NS Node */
376
/* Owner IDs are used to track namespace nodes for selective deletion */
378
typedef u8 acpi_owner_id;
379
#define ACPI_OWNER_ID_MAX 0xFF
381
#define ACPI_INTEGER_BIT_SIZE 64
382
#define ACPI_MAX_DECIMAL_DIGITS 20 /* 2^64 = 18,446,744,073,709,551,616 */
384
#if ACPI_MACHINE_WIDTH == 64
385
#define ACPI_USE_NATIVE_DIVIDE /* Use compiler native 64-bit divide */
388
#define ACPI_MAX64_DECIMAL_DIGITS 20
389
#define ACPI_MAX32_DECIMAL_DIGITS 10
390
#define ACPI_MAX16_DECIMAL_DIGITS 5
391
#define ACPI_MAX8_DECIMAL_DIGITS 3
393
/* PM Timer ticks per second (HZ) */
395
#define PM_TIMER_FREQUENCY 3579545
398
* Constants with special meanings
400
#define ACPI_ROOT_OBJECT ACPI_ADD_PTR (acpi_handle, NULL, ACPI_MAX_PTR)
401
#define ACPI_WAIT_FOREVER 0xFFFF /* u16, as per ACPI spec */
402
#define ACPI_DO_NOT_WAIT 0
405
* Obsolete: Acpi integer width. In ACPI version 1 (1996), integers are 32 bits.
406
* In ACPI version 2 (2000) and later, integers are 64 bits. Note that this
407
* pertains to the ACPI integer type only, not to other integers used in the
408
* implementation of the ACPICA subsystem.
410
* 01/2010: This type is obsolete and has been removed from the entire ACPICA
411
* code base. It remains here for compatibility with device drivers that use
412
* the type. However, it will be removed in the future.
414
typedef u64 acpi_integer;
415
#define ACPI_INTEGER_MAX ACPI_UINT64_MAX
417
/*******************************************************************************
419
* Commonly used macros
421
******************************************************************************/
423
/* Data manipulation */
425
#define ACPI_LOBYTE(integer) ((u8) (u16)(integer))
426
#define ACPI_HIBYTE(integer) ((u8) (((u16)(integer)) >> 8))
427
#define ACPI_LOWORD(integer) ((u16) (u32)(integer))
428
#define ACPI_HIWORD(integer) ((u16)(((u32)(integer)) >> 16))
429
#define ACPI_LODWORD(integer64) ((u32) (u64)(integer64))
430
#define ACPI_HIDWORD(integer64) ((u32)(((u64)(integer64)) >> 32))
432
#define ACPI_SET_BIT(target,bit) ((target) |= (bit))
433
#define ACPI_CLEAR_BIT(target,bit) ((target) &= ~(bit))
434
#define ACPI_MIN(a,b) (((a)<(b))?(a):(b))
435
#define ACPI_MAX(a,b) (((a)>(b))?(a):(b))
437
/* Size calculation */
439
#define ACPI_ARRAY_LENGTH(x) (sizeof(x) / sizeof((x)[0]))
441
/* Pointer manipulation */
443
#define ACPI_CAST_PTR(t, p) ((t *) (acpi_uintptr_t) (p))
444
#define ACPI_CAST_INDIRECT_PTR(t, p) ((t **) (acpi_uintptr_t) (p))
445
#define ACPI_ADD_PTR(t, a, b) ACPI_CAST_PTR (t, (ACPI_CAST_PTR (u8, (a)) + (acpi_size)(b)))
446
#define ACPI_PTR_DIFF(a, b) (acpi_size) (ACPI_CAST_PTR (u8, (a)) - ACPI_CAST_PTR (u8, (b)))
448
/* Pointer/Integer type conversions */
450
#define ACPI_TO_POINTER(i) ACPI_ADD_PTR (void, (void *) NULL,(acpi_size) i)
451
#define ACPI_TO_INTEGER(p) ACPI_PTR_DIFF (p, (void *) NULL)
452
#define ACPI_OFFSET(d, f) (acpi_size) ACPI_PTR_DIFF (&(((d *)0)->f), (void *) NULL)
453
#define ACPI_PHYSADDR_TO_PTR(i) ACPI_TO_POINTER(i)
454
#define ACPI_PTR_TO_PHYSADDR(i) ACPI_TO_INTEGER(i)
456
#ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
457
#define ACPI_COMPARE_NAME(a,b) (*ACPI_CAST_PTR (u32, (a)) == *ACPI_CAST_PTR (u32, (b)))
459
#define ACPI_COMPARE_NAME(a,b) (!ACPI_STRNCMP (ACPI_CAST_PTR (char, (a)), ACPI_CAST_PTR (char, (b)), ACPI_NAME_SIZE))
462
/*******************************************************************************
464
* Miscellaneous constants
466
******************************************************************************/
469
* Initialization sequence
471
#define ACPI_FULL_INITIALIZATION 0x00
472
#define ACPI_NO_ADDRESS_SPACE_INIT 0x01
473
#define ACPI_NO_EVENT_INIT 0x04
474
#define ACPI_NO_HANDLER_INIT 0x08
475
#define ACPI_NO_ACPI_ENABLE 0x10
476
#define ACPI_NO_DEVICE_INIT 0x20
477
#define ACPI_NO_OBJECT_INIT 0x40
480
* Initialization state
482
#define ACPI_SUBSYSTEM_INITIALIZE 0x01
483
#define ACPI_INITIALIZED_OK 0x02
488
#define ACPI_STATE_UNKNOWN (u8) 0xFF
490
#define ACPI_STATE_S0 (u8) 0
491
#define ACPI_STATE_S1 (u8) 1
492
#define ACPI_STATE_S2 (u8) 2
493
#define ACPI_STATE_S3 (u8) 3
494
#define ACPI_STATE_S4 (u8) 4
495
#define ACPI_STATE_S5 (u8) 5
496
#define ACPI_S_STATES_MAX ACPI_STATE_S5
497
#define ACPI_S_STATE_COUNT 6
499
#define ACPI_STATE_D0 (u8) 0
500
#define ACPI_STATE_D1 (u8) 1
501
#define ACPI_STATE_D2 (u8) 2
502
#define ACPI_STATE_D3 (u8) 3
503
#define ACPI_STATE_D3_COLD (u8) 4
504
#define ACPI_D_STATES_MAX ACPI_STATE_D3_COLD
505
#define ACPI_D_STATE_COUNT 5
507
#define ACPI_STATE_C0 (u8) 0
508
#define ACPI_STATE_C1 (u8) 1
509
#define ACPI_STATE_C2 (u8) 2
510
#define ACPI_STATE_C3 (u8) 3
511
#define ACPI_C_STATES_MAX ACPI_STATE_C3
512
#define ACPI_C_STATE_COUNT 4
515
* Sleep type invalid value
517
#define ACPI_SLEEP_TYPE_MAX 0x7
518
#define ACPI_SLEEP_TYPE_INVALID 0xFF
521
* Standard notify values
523
#define ACPI_NOTIFY_BUS_CHECK (u8) 0x00
524
#define ACPI_NOTIFY_DEVICE_CHECK (u8) 0x01
525
#define ACPI_NOTIFY_DEVICE_WAKE (u8) 0x02
526
#define ACPI_NOTIFY_EJECT_REQUEST (u8) 0x03
527
#define ACPI_NOTIFY_DEVICE_CHECK_LIGHT (u8) 0x04
528
#define ACPI_NOTIFY_FREQUENCY_MISMATCH (u8) 0x05
529
#define ACPI_NOTIFY_BUS_MODE_MISMATCH (u8) 0x06
530
#define ACPI_NOTIFY_POWER_FAULT (u8) 0x07
531
#define ACPI_NOTIFY_CAPABILITIES_CHECK (u8) 0x08
532
#define ACPI_NOTIFY_DEVICE_PLD_CHECK (u8) 0x09
533
#define ACPI_NOTIFY_RESERVED (u8) 0x0A
534
#define ACPI_NOTIFY_LOCALITY_UPDATE (u8) 0x0B
536
#define ACPI_NOTIFY_MAX 0x0B
539
* Types associated with ACPI names and objects. The first group of
540
* values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
541
* of the ACPI object_type() operator (See the ACPI Spec). Therefore,
542
* only add to the first group if the spec changes.
544
* NOTE: Types must be kept in sync with the global acpi_ns_properties
545
* and acpi_ns_type_names arrays.
547
typedef u32 acpi_object_type;
549
#define ACPI_TYPE_ANY 0x00
550
#define ACPI_TYPE_INTEGER 0x01 /* Byte/Word/Dword/Zero/One/Ones */
551
#define ACPI_TYPE_STRING 0x02
552
#define ACPI_TYPE_BUFFER 0x03
553
#define ACPI_TYPE_PACKAGE 0x04 /* byte_const, multiple data_term/Constant/super_name */
554
#define ACPI_TYPE_FIELD_UNIT 0x05
555
#define ACPI_TYPE_DEVICE 0x06 /* Name, multiple Node */
556
#define ACPI_TYPE_EVENT 0x07
557
#define ACPI_TYPE_METHOD 0x08 /* Name, byte_const, multiple Code */
558
#define ACPI_TYPE_MUTEX 0x09
559
#define ACPI_TYPE_REGION 0x0A
560
#define ACPI_TYPE_POWER 0x0B /* Name,byte_const,word_const,multi Node */
561
#define ACPI_TYPE_PROCESSOR 0x0C /* Name,byte_const,Dword_const,byte_const,multi nm_o */
562
#define ACPI_TYPE_THERMAL 0x0D /* Name, multiple Node */
563
#define ACPI_TYPE_BUFFER_FIELD 0x0E
564
#define ACPI_TYPE_DDB_HANDLE 0x0F
565
#define ACPI_TYPE_DEBUG_OBJECT 0x10
567
#define ACPI_TYPE_EXTERNAL_MAX 0x10
570
* These are object types that do not map directly to the ACPI
571
* object_type() operator. They are used for various internal purposes only.
572
* If new predefined ACPI_TYPEs are added (via the ACPI specification), these
573
* internal types must move upwards. (There is code that depends on these
574
* values being contiguous with the external types above.)
576
#define ACPI_TYPE_LOCAL_REGION_FIELD 0x11
577
#define ACPI_TYPE_LOCAL_BANK_FIELD 0x12
578
#define ACPI_TYPE_LOCAL_INDEX_FIELD 0x13
579
#define ACPI_TYPE_LOCAL_REFERENCE 0x14 /* Arg#, Local#, Name, Debug, ref_of, Index */
580
#define ACPI_TYPE_LOCAL_ALIAS 0x15
581
#define ACPI_TYPE_LOCAL_METHOD_ALIAS 0x16
582
#define ACPI_TYPE_LOCAL_NOTIFY 0x17
583
#define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
584
#define ACPI_TYPE_LOCAL_RESOURCE 0x19
585
#define ACPI_TYPE_LOCAL_RESOURCE_FIELD 0x1A
586
#define ACPI_TYPE_LOCAL_SCOPE 0x1B /* 1 Name, multiple object_list Nodes */
588
#define ACPI_TYPE_NS_NODE_MAX 0x1B /* Last typecode used within a NS Node */
591
* These are special object types that never appear in
592
* a Namespace node, only in a union acpi_operand_object
594
#define ACPI_TYPE_LOCAL_EXTRA 0x1C
595
#define ACPI_TYPE_LOCAL_DATA 0x1D
597
#define ACPI_TYPE_LOCAL_MAX 0x1D
599
/* All types above here are invalid */
601
#define ACPI_TYPE_INVALID 0x1E
602
#define ACPI_TYPE_NOT_FOUND 0xFF
604
#define ACPI_NUM_NS_TYPES (ACPI_TYPE_INVALID + 1)
611
#define ACPI_IO_MASK 1
614
* Event Types: Fixed & General Purpose
616
typedef u32 acpi_event_type;
621
#define ACPI_EVENT_PMTIMER 0
622
#define ACPI_EVENT_GLOBAL 1
623
#define ACPI_EVENT_POWER_BUTTON 2
624
#define ACPI_EVENT_SLEEP_BUTTON 3
625
#define ACPI_EVENT_RTC 4
626
#define ACPI_EVENT_MAX 4
627
#define ACPI_NUM_FIXED_EVENTS ACPI_EVENT_MAX + 1
630
* Event Status - Per event
632
* The encoding of acpi_event_status is illustrated below.
633
* Note that a set bit (1) indicates the property is TRUE
634
* (e.g. if bit 0 is set then the event is enabled).
635
* +-------------+-+-+-+
636
* | Bits 31:3 |2|1|0|
637
* +-------------+-+-+-+
640
* | | +--- Enabled for wake?
642
* +----------- <Reserved>
644
typedef u32 acpi_event_status;
646
#define ACPI_EVENT_FLAG_DISABLED (acpi_event_status) 0x00
647
#define ACPI_EVENT_FLAG_ENABLED (acpi_event_status) 0x01
648
#define ACPI_EVENT_FLAG_WAKE_ENABLED (acpi_event_status) 0x02
649
#define ACPI_EVENT_FLAG_SET (acpi_event_status) 0x04
650
#define ACPI_EVENT_FLAG_HANDLE (acpi_event_status) 0x08
653
* General Purpose Events (GPE)
655
#define ACPI_GPE_INVALID 0xFF
656
#define ACPI_GPE_MAX 0xFF
657
#define ACPI_NUM_GPE 256
659
/* Actions for acpi_set_gpe_wake_mask, acpi_hw_low_set_gpe */
661
#define ACPI_GPE_ENABLE 0
662
#define ACPI_GPE_DISABLE 1
663
#define ACPI_GPE_CONDITIONAL_ENABLE 2
666
* GPE info flags - Per GPE
671
* | | | +-- Type of dispatch:to method, handler, notify, or none
672
* | | +----- Interrupt type: edge or level triggered
673
* | +------- Is a Wake GPE
674
* +------------ <Reserved>
676
#define ACPI_GPE_DISPATCH_NONE (u8) 0x00
677
#define ACPI_GPE_DISPATCH_METHOD (u8) 0x01
678
#define ACPI_GPE_DISPATCH_HANDLER (u8) 0x02
679
#define ACPI_GPE_DISPATCH_NOTIFY (u8) 0x03
680
#define ACPI_GPE_DISPATCH_MASK (u8) 0x03
682
#define ACPI_GPE_LEVEL_TRIGGERED (u8) 0x04
683
#define ACPI_GPE_EDGE_TRIGGERED (u8) 0x00
684
#define ACPI_GPE_XRUPT_TYPE_MASK (u8) 0x04
686
#define ACPI_GPE_CAN_WAKE (u8) 0x08
689
* Flags for GPE and Lock interfaces
691
#define ACPI_NOT_ISR 0x1
696
#define ACPI_SYSTEM_NOTIFY 0x1
697
#define ACPI_DEVICE_NOTIFY 0x2
698
#define ACPI_ALL_NOTIFY (ACPI_SYSTEM_NOTIFY | ACPI_DEVICE_NOTIFY)
699
#define ACPI_MAX_NOTIFY_HANDLER_TYPE 0x3
701
#define ACPI_MAX_SYS_NOTIFY 0x7f
703
/* Address Space (Operation Region) Types */
705
typedef u8 acpi_adr_space_type;
707
#define ACPI_ADR_SPACE_SYSTEM_MEMORY (acpi_adr_space_type) 0
708
#define ACPI_ADR_SPACE_SYSTEM_IO (acpi_adr_space_type) 1
709
#define ACPI_ADR_SPACE_PCI_CONFIG (acpi_adr_space_type) 2
710
#define ACPI_ADR_SPACE_EC (acpi_adr_space_type) 3
711
#define ACPI_ADR_SPACE_SMBUS (acpi_adr_space_type) 4
712
#define ACPI_ADR_SPACE_CMOS (acpi_adr_space_type) 5
713
#define ACPI_ADR_SPACE_PCI_BAR_TARGET (acpi_adr_space_type) 6
714
#define ACPI_ADR_SPACE_IPMI (acpi_adr_space_type) 7
716
#define ACPI_NUM_PREDEFINED_REGIONS 8
719
* Special Address Spaces
721
* Note: A Data Table region is a special type of operation region
722
* that has its own AML opcode. However, internally, the AML
723
* interpreter simply creates an operation region with an an address
724
* space type of ACPI_ADR_SPACE_DATA_TABLE.
726
#define ACPI_ADR_SPACE_DATA_TABLE (acpi_adr_space_type) 0x7E /* Internal to ACPICA only */
727
#define ACPI_ADR_SPACE_FIXED_HARDWARE (acpi_adr_space_type) 0x7F
729
/* Values for _REG connection code */
731
#define ACPI_REG_DISCONNECT 0
732
#define ACPI_REG_CONNECT 1
737
* These values are intended to be used by the hardware interfaces
738
* and are mapped to individual bitfields defined within the ACPI
739
* registers. See the acpi_gbl_bit_register_info global table in utglobal.c
743
/* PM1 Status register */
745
#define ACPI_BITREG_TIMER_STATUS 0x00
746
#define ACPI_BITREG_BUS_MASTER_STATUS 0x01
747
#define ACPI_BITREG_GLOBAL_LOCK_STATUS 0x02
748
#define ACPI_BITREG_POWER_BUTTON_STATUS 0x03
749
#define ACPI_BITREG_SLEEP_BUTTON_STATUS 0x04
750
#define ACPI_BITREG_RT_CLOCK_STATUS 0x05
751
#define ACPI_BITREG_WAKE_STATUS 0x06
752
#define ACPI_BITREG_PCIEXP_WAKE_STATUS 0x07
754
/* PM1 Enable register */
756
#define ACPI_BITREG_TIMER_ENABLE 0x08
757
#define ACPI_BITREG_GLOBAL_LOCK_ENABLE 0x09
758
#define ACPI_BITREG_POWER_BUTTON_ENABLE 0x0A
759
#define ACPI_BITREG_SLEEP_BUTTON_ENABLE 0x0B
760
#define ACPI_BITREG_RT_CLOCK_ENABLE 0x0C
761
#define ACPI_BITREG_PCIEXP_WAKE_DISABLE 0x0D
763
/* PM1 Control register */
765
#define ACPI_BITREG_SCI_ENABLE 0x0E
766
#define ACPI_BITREG_BUS_MASTER_RLD 0x0F
767
#define ACPI_BITREG_GLOBAL_LOCK_RELEASE 0x10
768
#define ACPI_BITREG_SLEEP_TYPE 0x11
769
#define ACPI_BITREG_SLEEP_ENABLE 0x12
771
/* PM2 Control register */
773
#define ACPI_BITREG_ARB_DISABLE 0x13
775
#define ACPI_BITREG_MAX 0x13
776
#define ACPI_NUM_BITREG ACPI_BITREG_MAX + 1
778
/* Status register values. A 1 clears a status bit. 0 = no effect */
780
#define ACPI_CLEAR_STATUS 1
782
/* Enable and Control register values */
784
#define ACPI_ENABLE_EVENT 1
785
#define ACPI_DISABLE_EVENT 0
788
* External ACPI object definition
792
* Note: Type == ACPI_TYPE_ANY (0) is used to indicate a NULL package element
793
* or an unresolved named reference.
796
acpi_object_type type; /* See definition of acpi_ns_type for values */
798
acpi_object_type type; /* ACPI_TYPE_INTEGER */
799
u64 value; /* The actual number */
803
acpi_object_type type; /* ACPI_TYPE_STRING */
804
u32 length; /* # of bytes in string, excluding trailing null */
805
char *pointer; /* points to the string value */
809
acpi_object_type type; /* ACPI_TYPE_BUFFER */
810
u32 length; /* # of bytes in buffer */
811
u8 *pointer; /* points to the buffer */
815
acpi_object_type type; /* ACPI_TYPE_PACKAGE */
816
u32 count; /* # of elements in package */
817
union acpi_object *elements; /* Pointer to an array of ACPI_OBJECTs */
821
acpi_object_type type; /* ACPI_TYPE_LOCAL_REFERENCE */
822
acpi_object_type actual_type; /* Type associated with the Handle */
823
acpi_handle handle; /* object reference */
827
acpi_object_type type; /* ACPI_TYPE_PROCESSOR */
829
acpi_io_address pblk_address;
834
acpi_object_type type; /* ACPI_TYPE_POWER */
841
* List of objects, used as a parameter list for control method evaluation
843
struct acpi_object_list {
845
union acpi_object *pointer;
849
* Miscellaneous common Data Structures used by the interfaces
851
#define ACPI_NO_BUFFER 0
852
#define ACPI_ALLOCATE_BUFFER (acpi_size) (-1)
853
#define ACPI_ALLOCATE_LOCAL_BUFFER (acpi_size) (-2)
856
acpi_size length; /* Length in bytes of the buffer */
857
void *pointer; /* pointer to buffer */
861
* name_type for acpi_get_name
863
#define ACPI_FULL_PATHNAME 0
864
#define ACPI_SINGLE_NAME 1
865
#define ACPI_NAME_TYPE_MAX 1
868
* Predefined Namespace items
870
struct acpi_predefined_names {
877
* Structure and flags for acpi_get_system_info
879
#define ACPI_SYS_MODE_UNKNOWN 0x0000
880
#define ACPI_SYS_MODE_ACPI 0x0001
881
#define ACPI_SYS_MODE_LEGACY 0x0002
882
#define ACPI_SYS_MODES_MASK 0x0003
885
* System info returned by acpi_get_system_info()
887
struct acpi_system_info {
890
u32 timer_resolution;
897
/* Table Event Types */
899
#define ACPI_TABLE_EVENT_LOAD 0x0
900
#define ACPI_TABLE_EVENT_UNLOAD 0x1
901
#define ACPI_NUM_TABLE_EVENTS 2
904
* Types specific to the OS service interfaces
906
typedef u32(ACPI_SYSTEM_XFACE * acpi_osd_handler) (void *context);
909
(ACPI_SYSTEM_XFACE * acpi_osd_exec_callback) (void *context);
912
* Various handlers and callback procedures
915
void (*ACPI_GBL_EVENT_HANDLER) (u32 event_type,
917
u32 event_number, void *context);
919
#define ACPI_EVENT_TYPE_GPE 0
920
#define ACPI_EVENT_TYPE_FIXED 1
922
typedef u32(*acpi_event_handler) (void *context);
925
u32 (*acpi_gpe_handler) (acpi_handle gpe_device, u32 gpe_number, void *context);
928
void (*acpi_notify_handler) (acpi_handle device, u32 value, void *context);
931
void (*acpi_object_handler) (acpi_handle object, void *data);
933
typedef acpi_status(*acpi_init_handler) (acpi_handle object, u32 function);
935
#define ACPI_INIT_DEVICE_INI 1
938
acpi_status(*acpi_exception_handler) (acpi_status aml_status,
941
u32 aml_offset, void *context);
943
/* Table Event handler (Load, load_table, etc.) and types */
946
acpi_status(*acpi_tbl_handler) (u32 event, void *table, void *context);
948
/* Address Spaces (For Operation Regions) */
951
acpi_status(*acpi_adr_space_handler) (u32 function,
952
acpi_physical_address address,
955
void *handler_context,
956
void *region_context);
958
#define ACPI_DEFAULT_HANDLER NULL
961
acpi_status(*acpi_adr_space_setup) (acpi_handle region_handle,
963
void *handler_context,
964
void **region_context);
966
#define ACPI_REGION_ACTIVATE 0
967
#define ACPI_REGION_DEACTIVATE 1
970
acpi_status(*acpi_walk_callback) (acpi_handle object,
972
void *context, void **return_value);
975
u32 (*acpi_interface_handler) (acpi_string interface_name, u32 supported);
977
/* Interrupt handler return values */
979
#define ACPI_INTERRUPT_NOT_HANDLED 0x00
980
#define ACPI_INTERRUPT_HANDLED 0x01
982
/* GPE handler return values */
984
#define ACPI_REENABLE_GPE 0x80
986
/* Length of 32-bit EISAID values when converted back to a string */
988
#define ACPI_EISAID_STRING_SIZE 8 /* Includes null terminator */
990
/* Length of UUID (string) values */
992
#define ACPI_UUID_LENGTH 16
994
/* Structures used for device/processor HID, UID, CID */
996
struct acpica_device_id {
997
u32 length; /* Length of string + null */
1001
struct acpica_device_id_list {
1002
u32 count; /* Number of IDs in Ids array */
1003
u32 list_size; /* Size of list, including ID strings */
1004
struct acpica_device_id ids[1]; /* ID array */
1008
* Structure returned from acpi_get_object_info.
1009
* Optimized for both 32- and 64-bit builds
1011
struct acpi_device_info {
1012
u32 info_size; /* Size of info, including ID strings */
1013
u32 name; /* ACPI object Name */
1014
acpi_object_type type; /* ACPI object Type */
1015
u8 param_count; /* If a method, required parameter count */
1016
u8 valid; /* Indicates which optional fields are valid */
1017
u8 flags; /* Miscellaneous info */
1018
u8 highest_dstates[4]; /* _sx_d values: 0xFF indicates not valid */
1019
u8 lowest_dstates[5]; /* _sx_w values: 0xFF indicates not valid */
1020
u32 current_status; /* _STA value */
1021
u64 address; /* _ADR value */
1022
struct acpica_device_id hardware_id; /* _HID value */
1023
struct acpica_device_id unique_id; /* _UID value */
1024
struct acpica_device_id_list compatible_id_list; /* _CID list <must be last> */
1027
/* Values for Flags field above (acpi_get_object_info) */
1029
#define ACPI_PCI_ROOT_BRIDGE 0x01
1031
/* Flags for Valid field above (acpi_get_object_info) */
1033
#define ACPI_VALID_STA 0x01
1034
#define ACPI_VALID_ADR 0x02
1035
#define ACPI_VALID_HID 0x04
1036
#define ACPI_VALID_UID 0x08
1037
#define ACPI_VALID_CID 0x10
1038
#define ACPI_VALID_SXDS 0x20
1039
#define ACPI_VALID_SXWS 0x40
1041
/* Flags for _STA method */
1043
#define ACPI_STA_DEVICE_PRESENT 0x01
1044
#define ACPI_STA_DEVICE_ENABLED 0x02
1045
#define ACPI_STA_DEVICE_UI 0x04
1046
#define ACPI_STA_DEVICE_FUNCTIONING 0x08
1047
#define ACPI_STA_DEVICE_OK 0x08 /* Synonym */
1048
#define ACPI_STA_BATTERY_PRESENT 0x10
1050
/* Context structs for address space handlers */
1052
struct acpi_pci_id {
1059
struct acpi_mem_space_context {
1061
acpi_physical_address address;
1062
acpi_physical_address mapped_physical_address;
1063
u8 *mapped_logical_address;
1064
acpi_size mapped_length;
1068
* struct acpi_memory_list is used only if the ACPICA local cache is enabled
1070
struct acpi_memory_list {
1078
#ifdef ACPI_DBG_TRACK_ALLOCATIONS
1080
/* Statistics for debug memory tracking only */
1082
u32 total_allocated;
1086
u32 current_total_size;
1092
#endif /* __ACTYPES_H__ */