acobject.h revision 1.1.1.2.2.2 1 1.1.1.2.2.2 bouyer
2 1.1.1.2.2.2 bouyer /******************************************************************************
3 1.1.1.2.2.2 bouyer *
4 1.1.1.2.2.2 bouyer * Name: acobject.h - Definition of ACPI_OPERAND_OBJECT (Internal object only)
5 1.1.1.2.2.2 bouyer *
6 1.1.1.2.2.2 bouyer *****************************************************************************/
7 1.1.1.2.2.2 bouyer
8 1.1.1.2.2.2 bouyer /*
9 1.1.1.2.2.2 bouyer * Copyright (C) 2000 - 2011, Intel Corp.
10 1.1.1.2.2.2 bouyer * All rights reserved.
11 1.1.1.2.2.2 bouyer *
12 1.1.1.2.2.2 bouyer * Redistribution and use in source and binary forms, with or without
13 1.1.1.2.2.2 bouyer * modification, are permitted provided that the following conditions
14 1.1.1.2.2.2 bouyer * are met:
15 1.1.1.2.2.2 bouyer * 1. Redistributions of source code must retain the above copyright
16 1.1.1.2.2.2 bouyer * notice, this list of conditions, and the following disclaimer,
17 1.1.1.2.2.2 bouyer * without modification.
18 1.1.1.2.2.2 bouyer * 2. Redistributions in binary form must reproduce at minimum a disclaimer
19 1.1.1.2.2.2 bouyer * substantially similar to the "NO WARRANTY" disclaimer below
20 1.1.1.2.2.2 bouyer * ("Disclaimer") and any redistribution must be conditioned upon
21 1.1.1.2.2.2 bouyer * including a substantially similar Disclaimer requirement for further
22 1.1.1.2.2.2 bouyer * binary redistribution.
23 1.1.1.2.2.2 bouyer * 3. Neither the names of the above-listed copyright holders nor the names
24 1.1.1.2.2.2 bouyer * of any contributors may be used to endorse or promote products derived
25 1.1.1.2.2.2 bouyer * from this software without specific prior written permission.
26 1.1.1.2.2.2 bouyer *
27 1.1.1.2.2.2 bouyer * Alternatively, this software may be distributed under the terms of the
28 1.1.1.2.2.2 bouyer * GNU General Public License ("GPL") version 2 as published by the Free
29 1.1.1.2.2.2 bouyer * Software Foundation.
30 1.1.1.2.2.2 bouyer *
31 1.1.1.2.2.2 bouyer * NO WARRANTY
32 1.1.1.2.2.2 bouyer * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33 1.1.1.2.2.2 bouyer * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34 1.1.1.2.2.2 bouyer * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
35 1.1.1.2.2.2 bouyer * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36 1.1.1.2.2.2 bouyer * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37 1.1.1.2.2.2 bouyer * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38 1.1.1.2.2.2 bouyer * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39 1.1.1.2.2.2 bouyer * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 1.1.1.2.2.2 bouyer * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41 1.1.1.2.2.2 bouyer * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42 1.1.1.2.2.2 bouyer * POSSIBILITY OF SUCH DAMAGES.
43 1.1.1.2.2.2 bouyer */
44 1.1.1.2.2.2 bouyer
45 1.1.1.2.2.2 bouyer #ifndef _ACOBJECT_H
46 1.1.1.2.2.2 bouyer #define _ACOBJECT_H
47 1.1.1.2.2.2 bouyer
48 1.1.1.2.2.2 bouyer /* acpisrc:StructDefs -- for acpisrc conversion */
49 1.1.1.2.2.2 bouyer
50 1.1.1.2.2.2 bouyer
51 1.1.1.2.2.2 bouyer /*
52 1.1.1.2.2.2 bouyer * The ACPI_OPERAND_OBJECT is used to pass AML operands from the dispatcher
53 1.1.1.2.2.2 bouyer * to the interpreter, and to keep track of the various handlers such as
54 1.1.1.2.2.2 bouyer * address space handlers and notify handlers. The object is a constant
55 1.1.1.2.2.2 bouyer * size in order to allow it to be cached and reused.
56 1.1.1.2.2.2 bouyer *
57 1.1.1.2.2.2 bouyer * Note: The object is optimized to be aligned and will not work if it is
58 1.1.1.2.2.2 bouyer * byte-packed.
59 1.1.1.2.2.2 bouyer */
60 1.1.1.2.2.2 bouyer #if ACPI_MACHINE_WIDTH == 64
61 1.1.1.2.2.2 bouyer #pragma pack(8)
62 1.1.1.2.2.2 bouyer #else
63 1.1.1.2.2.2 bouyer #pragma pack(4)
64 1.1.1.2.2.2 bouyer #endif
65 1.1.1.2.2.2 bouyer
66 1.1.1.2.2.2 bouyer /*******************************************************************************
67 1.1.1.2.2.2 bouyer *
68 1.1.1.2.2.2 bouyer * Common Descriptors
69 1.1.1.2.2.2 bouyer *
70 1.1.1.2.2.2 bouyer ******************************************************************************/
71 1.1.1.2.2.2 bouyer
72 1.1.1.2.2.2 bouyer /*
73 1.1.1.2.2.2 bouyer * Common area for all objects.
74 1.1.1.2.2.2 bouyer *
75 1.1.1.2.2.2 bouyer * DescriptorType is used to differentiate between internal descriptors, and
76 1.1.1.2.2.2 bouyer * must be in the same place across all descriptors
77 1.1.1.2.2.2 bouyer *
78 1.1.1.2.2.2 bouyer * Note: The DescriptorType and Type fields must appear in the identical
79 1.1.1.2.2.2 bouyer * position in both the ACPI_NAMESPACE_NODE and ACPI_OPERAND_OBJECT
80 1.1.1.2.2.2 bouyer * structures.
81 1.1.1.2.2.2 bouyer */
82 1.1.1.2.2.2 bouyer #define ACPI_OBJECT_COMMON_HEADER \
83 1.1.1.2.2.2 bouyer union acpi_operand_object *NextObject; /* Objects linked to parent NS node */\
84 1.1.1.2.2.2 bouyer UINT8 DescriptorType; /* To differentiate various internal objs */\
85 1.1.1.2.2.2 bouyer UINT8 Type; /* ACPI_OBJECT_TYPE */\
86 1.1.1.2.2.2 bouyer UINT16 ReferenceCount; /* For object deletion management */\
87 1.1.1.2.2.2 bouyer UINT8 Flags;
88 1.1.1.2.2.2 bouyer /*
89 1.1.1.2.2.2 bouyer * Note: There are 3 bytes available here before the
90 1.1.1.2.2.2 bouyer * next natural alignment boundary (for both 32/64 cases)
91 1.1.1.2.2.2 bouyer */
92 1.1.1.2.2.2 bouyer
93 1.1.1.2.2.2 bouyer /* Values for Flag byte above */
94 1.1.1.2.2.2 bouyer
95 1.1.1.2.2.2 bouyer #define AOPOBJ_AML_CONSTANT 0x01 /* Integer is an AML constant */
96 1.1.1.2.2.2 bouyer #define AOPOBJ_STATIC_POINTER 0x02 /* Data is part of an ACPI table, don't delete */
97 1.1.1.2.2.2 bouyer #define AOPOBJ_DATA_VALID 0x04 /* Object is intialized and data is valid */
98 1.1.1.2.2.2 bouyer #define AOPOBJ_OBJECT_INITIALIZED 0x08 /* Region is initialized, _REG was run */
99 1.1.1.2.2.2 bouyer #define AOPOBJ_SETUP_COMPLETE 0x10 /* Region setup is complete */
100 1.1.1.2.2.2 bouyer #define AOPOBJ_INVALID 0x20 /* Host OS won't allow a Region address */
101 1.1.1.2.2.2 bouyer
102 1.1.1.2.2.2 bouyer
103 1.1.1.2.2.2 bouyer /******************************************************************************
104 1.1.1.2.2.2 bouyer *
105 1.1.1.2.2.2 bouyer * Basic data types
106 1.1.1.2.2.2 bouyer *
107 1.1.1.2.2.2 bouyer *****************************************************************************/
108 1.1.1.2.2.2 bouyer
109 1.1.1.2.2.2 bouyer typedef struct acpi_object_common
110 1.1.1.2.2.2 bouyer {
111 1.1.1.2.2.2 bouyer ACPI_OBJECT_COMMON_HEADER
112 1.1.1.2.2.2 bouyer
113 1.1.1.2.2.2 bouyer } ACPI_OBJECT_COMMON;
114 1.1.1.2.2.2 bouyer
115 1.1.1.2.2.2 bouyer
116 1.1.1.2.2.2 bouyer typedef struct acpi_object_integer
117 1.1.1.2.2.2 bouyer {
118 1.1.1.2.2.2 bouyer ACPI_OBJECT_COMMON_HEADER
119 1.1.1.2.2.2 bouyer UINT8 Fill[3]; /* Prevent warning on some compilers */
120 1.1.1.2.2.2 bouyer UINT64 Value;
121 1.1.1.2.2.2 bouyer
122 1.1.1.2.2.2 bouyer } ACPI_OBJECT_INTEGER;
123 1.1.1.2.2.2 bouyer
124 1.1.1.2.2.2 bouyer
125 1.1.1.2.2.2 bouyer /*
126 1.1.1.2.2.2 bouyer * Note: The String and Buffer object must be identical through the Pointer
127 1.1.1.2.2.2 bouyer * and length elements. There is code that depends on this.
128 1.1.1.2.2.2 bouyer *
129 1.1.1.2.2.2 bouyer * Fields common to both Strings and Buffers
130 1.1.1.2.2.2 bouyer */
131 1.1.1.2.2.2 bouyer #define ACPI_COMMON_BUFFER_INFO(_Type) \
132 1.1.1.2.2.2 bouyer _Type *Pointer; \
133 1.1.1.2.2.2 bouyer UINT32 Length;
134 1.1.1.2.2.2 bouyer
135 1.1.1.2.2.2 bouyer
136 1.1.1.2.2.2 bouyer typedef struct acpi_object_string /* Null terminated, ASCII characters only */
137 1.1.1.2.2.2 bouyer {
138 1.1.1.2.2.2 bouyer ACPI_OBJECT_COMMON_HEADER
139 1.1.1.2.2.2 bouyer ACPI_COMMON_BUFFER_INFO (char) /* String in AML stream or allocated string */
140 1.1.1.2.2.2 bouyer
141 1.1.1.2.2.2 bouyer } ACPI_OBJECT_STRING;
142 1.1.1.2.2.2 bouyer
143 1.1.1.2.2.2 bouyer
144 1.1.1.2.2.2 bouyer typedef struct acpi_object_buffer
145 1.1.1.2.2.2 bouyer {
146 1.1.1.2.2.2 bouyer ACPI_OBJECT_COMMON_HEADER
147 1.1.1.2.2.2 bouyer ACPI_COMMON_BUFFER_INFO (UINT8) /* Buffer in AML stream or allocated buffer */
148 1.1.1.2.2.2 bouyer UINT32 AmlLength;
149 1.1.1.2.2.2 bouyer UINT8 *AmlStart;
150 1.1.1.2.2.2 bouyer ACPI_NAMESPACE_NODE *Node; /* Link back to parent node */
151 1.1.1.2.2.2 bouyer
152 1.1.1.2.2.2 bouyer } ACPI_OBJECT_BUFFER;
153 1.1.1.2.2.2 bouyer
154 1.1.1.2.2.2 bouyer
155 1.1.1.2.2.2 bouyer typedef struct acpi_object_package
156 1.1.1.2.2.2 bouyer {
157 1.1.1.2.2.2 bouyer ACPI_OBJECT_COMMON_HEADER
158 1.1.1.2.2.2 bouyer ACPI_NAMESPACE_NODE *Node; /* Link back to parent node */
159 1.1.1.2.2.2 bouyer union acpi_operand_object **Elements; /* Array of pointers to AcpiObjects */
160 1.1.1.2.2.2 bouyer UINT8 *AmlStart;
161 1.1.1.2.2.2 bouyer UINT32 AmlLength;
162 1.1.1.2.2.2 bouyer UINT32 Count; /* # of elements in package */
163 1.1.1.2.2.2 bouyer
164 1.1.1.2.2.2 bouyer } ACPI_OBJECT_PACKAGE;
165 1.1.1.2.2.2 bouyer
166 1.1.1.2.2.2 bouyer
167 1.1.1.2.2.2 bouyer /******************************************************************************
168 1.1.1.2.2.2 bouyer *
169 1.1.1.2.2.2 bouyer * Complex data types
170 1.1.1.2.2.2 bouyer *
171 1.1.1.2.2.2 bouyer *****************************************************************************/
172 1.1.1.2.2.2 bouyer
173 1.1.1.2.2.2 bouyer typedef struct acpi_object_event
174 1.1.1.2.2.2 bouyer {
175 1.1.1.2.2.2 bouyer ACPI_OBJECT_COMMON_HEADER
176 1.1.1.2.2.2 bouyer ACPI_SEMAPHORE OsSemaphore; /* Actual OS synchronization object */
177 1.1.1.2.2.2 bouyer
178 1.1.1.2.2.2 bouyer } ACPI_OBJECT_EVENT;
179 1.1.1.2.2.2 bouyer
180 1.1.1.2.2.2 bouyer
181 1.1.1.2.2.2 bouyer typedef struct acpi_object_mutex
182 1.1.1.2.2.2 bouyer {
183 1.1.1.2.2.2 bouyer ACPI_OBJECT_COMMON_HEADER
184 1.1.1.2.2.2 bouyer UINT8 SyncLevel; /* 0-15, specified in Mutex() call */
185 1.1.1.2.2.2 bouyer UINT16 AcquisitionDepth; /* Allow multiple Acquires, same thread */
186 1.1.1.2.2.2 bouyer ACPI_MUTEX OsMutex; /* Actual OS synchronization object */
187 1.1.1.2.2.2 bouyer ACPI_THREAD_ID ThreadId; /* Current owner of the mutex */
188 1.1.1.2.2.2 bouyer struct acpi_thread_state *OwnerThread; /* Current owner of the mutex */
189 1.1.1.2.2.2 bouyer union acpi_operand_object *Prev; /* Link for list of acquired mutexes */
190 1.1.1.2.2.2 bouyer union acpi_operand_object *Next; /* Link for list of acquired mutexes */
191 1.1.1.2.2.2 bouyer ACPI_NAMESPACE_NODE *Node; /* Containing namespace node */
192 1.1.1.2.2.2 bouyer UINT8 OriginalSyncLevel; /* Owner's original sync level (0-15) */
193 1.1.1.2.2.2 bouyer
194 1.1.1.2.2.2 bouyer } ACPI_OBJECT_MUTEX;
195 1.1.1.2.2.2 bouyer
196 1.1.1.2.2.2 bouyer
197 1.1.1.2.2.2 bouyer typedef struct acpi_object_region
198 1.1.1.2.2.2 bouyer {
199 1.1.1.2.2.2 bouyer ACPI_OBJECT_COMMON_HEADER
200 1.1.1.2.2.2 bouyer UINT8 SpaceId;
201 1.1.1.2.2.2 bouyer ACPI_NAMESPACE_NODE *Node; /* Containing namespace node */
202 1.1.1.2.2.2 bouyer union acpi_operand_object *Handler; /* Handler for region access */
203 1.1.1.2.2.2 bouyer union acpi_operand_object *Next;
204 1.1.1.2.2.2 bouyer ACPI_PHYSICAL_ADDRESS Address;
205 1.1.1.2.2.2 bouyer UINT32 Length;
206 1.1.1.2.2.2 bouyer
207 1.1.1.2.2.2 bouyer } ACPI_OBJECT_REGION;
208 1.1.1.2.2.2 bouyer
209 1.1.1.2.2.2 bouyer
210 1.1.1.2.2.2 bouyer typedef struct acpi_object_method
211 1.1.1.2.2.2 bouyer {
212 1.1.1.2.2.2 bouyer ACPI_OBJECT_COMMON_HEADER
213 1.1.1.2.2.2 bouyer UINT8 InfoFlags;
214 1.1.1.2.2.2 bouyer UINT8 ParamCount;
215 1.1.1.2.2.2 bouyer UINT8 SyncLevel;
216 1.1.1.2.2.2 bouyer union acpi_operand_object *Mutex;
217 1.1.1.2.2.2 bouyer UINT8 *AmlStart;
218 1.1.1.2.2.2 bouyer union
219 1.1.1.2.2.2 bouyer {
220 1.1.1.2.2.2 bouyer ACPI_INTERNAL_METHOD Implementation;
221 1.1.1.2.2.2 bouyer union acpi_operand_object *Handler;
222 1.1.1.2.2.2 bouyer } Dispatch;
223 1.1.1.2.2.2 bouyer
224 1.1.1.2.2.2 bouyer UINT32 AmlLength;
225 1.1.1.2.2.2 bouyer UINT8 ThreadCount;
226 1.1.1.2.2.2 bouyer ACPI_OWNER_ID OwnerId;
227 1.1.1.2.2.2 bouyer
228 1.1.1.2.2.2 bouyer } ACPI_OBJECT_METHOD;
229 1.1.1.2.2.2 bouyer
230 1.1.1.2.2.2 bouyer /* Flags for InfoFlags field above */
231 1.1.1.2.2.2 bouyer
232 1.1.1.2.2.2 bouyer #define ACPI_METHOD_MODULE_LEVEL 0x01 /* Method is actually module-level code */
233 1.1.1.2.2.2 bouyer #define ACPI_METHOD_INTERNAL_ONLY 0x02 /* Method is implemented internally (_OSI) */
234 1.1.1.2.2.2 bouyer #define ACPI_METHOD_SERIALIZED 0x04 /* Method is serialized */
235 1.1.1.2.2.2 bouyer #define ACPI_METHOD_SERIALIZED_PENDING 0x08 /* Method is to be marked serialized */
236 1.1.1.2.2.2 bouyer #define ACPI_METHOD_MODIFIED_NAMESPACE 0x10 /* Method modified the namespace */
237 1.1.1.2.2.2 bouyer
238 1.1.1.2.2.2 bouyer
239 1.1.1.2.2.2 bouyer /******************************************************************************
240 1.1.1.2.2.2 bouyer *
241 1.1.1.2.2.2 bouyer * Objects that can be notified. All share a common NotifyInfo area.
242 1.1.1.2.2.2 bouyer *
243 1.1.1.2.2.2 bouyer *****************************************************************************/
244 1.1.1.2.2.2 bouyer
245 1.1.1.2.2.2 bouyer /*
246 1.1.1.2.2.2 bouyer * Common fields for objects that support ASL notifications
247 1.1.1.2.2.2 bouyer */
248 1.1.1.2.2.2 bouyer #define ACPI_COMMON_NOTIFY_INFO \
249 1.1.1.2.2.2 bouyer union acpi_operand_object *SystemNotify; /* Handler for system notifies */\
250 1.1.1.2.2.2 bouyer union acpi_operand_object *DeviceNotify; /* Handler for driver notifies */\
251 1.1.1.2.2.2 bouyer union acpi_operand_object *Handler; /* Handler for Address space */
252 1.1.1.2.2.2 bouyer
253 1.1.1.2.2.2 bouyer
254 1.1.1.2.2.2 bouyer typedef struct acpi_object_notify_common /* COMMON NOTIFY for POWER, PROCESSOR, DEVICE, and THERMAL */
255 1.1.1.2.2.2 bouyer {
256 1.1.1.2.2.2 bouyer ACPI_OBJECT_COMMON_HEADER
257 1.1.1.2.2.2 bouyer ACPI_COMMON_NOTIFY_INFO
258 1.1.1.2.2.2 bouyer
259 1.1.1.2.2.2 bouyer } ACPI_OBJECT_NOTIFY_COMMON;
260 1.1.1.2.2.2 bouyer
261 1.1.1.2.2.2 bouyer
262 1.1.1.2.2.2 bouyer typedef struct acpi_object_device
263 1.1.1.2.2.2 bouyer {
264 1.1.1.2.2.2 bouyer ACPI_OBJECT_COMMON_HEADER
265 1.1.1.2.2.2 bouyer ACPI_COMMON_NOTIFY_INFO
266 1.1.1.2.2.2 bouyer ACPI_GPE_BLOCK_INFO *GpeBlock;
267 1.1.1.2.2.2 bouyer
268 1.1.1.2.2.2 bouyer } ACPI_OBJECT_DEVICE;
269 1.1.1.2.2.2 bouyer
270 1.1.1.2.2.2 bouyer
271 1.1.1.2.2.2 bouyer typedef struct acpi_object_power_resource
272 1.1.1.2.2.2 bouyer {
273 1.1.1.2.2.2 bouyer ACPI_OBJECT_COMMON_HEADER
274 1.1.1.2.2.2 bouyer ACPI_COMMON_NOTIFY_INFO
275 1.1.1.2.2.2 bouyer UINT32 SystemLevel;
276 1.1.1.2.2.2 bouyer UINT32 ResourceOrder;
277 1.1.1.2.2.2 bouyer
278 1.1.1.2.2.2 bouyer } ACPI_OBJECT_POWER_RESOURCE;
279 1.1.1.2.2.2 bouyer
280 1.1.1.2.2.2 bouyer
281 1.1.1.2.2.2 bouyer typedef struct acpi_object_processor
282 1.1.1.2.2.2 bouyer {
283 1.1.1.2.2.2 bouyer ACPI_OBJECT_COMMON_HEADER
284 1.1.1.2.2.2 bouyer
285 1.1.1.2.2.2 bouyer /* The next two fields take advantage of the 3-byte space before NOTIFY_INFO */
286 1.1.1.2.2.2 bouyer
287 1.1.1.2.2.2 bouyer UINT8 ProcId;
288 1.1.1.2.2.2 bouyer UINT8 Length;
289 1.1.1.2.2.2 bouyer ACPI_COMMON_NOTIFY_INFO
290 1.1.1.2.2.2 bouyer ACPI_IO_ADDRESS Address;
291 1.1.1.2.2.2 bouyer
292 1.1.1.2.2.2 bouyer } ACPI_OBJECT_PROCESSOR;
293 1.1.1.2.2.2 bouyer
294 1.1.1.2.2.2 bouyer
295 1.1.1.2.2.2 bouyer typedef struct acpi_object_thermal_zone
296 1.1.1.2.2.2 bouyer {
297 1.1.1.2.2.2 bouyer ACPI_OBJECT_COMMON_HEADER
298 1.1.1.2.2.2 bouyer ACPI_COMMON_NOTIFY_INFO
299 1.1.1.2.2.2 bouyer
300 1.1.1.2.2.2 bouyer } ACPI_OBJECT_THERMAL_ZONE;
301 1.1.1.2.2.2 bouyer
302 1.1.1.2.2.2 bouyer
303 1.1.1.2.2.2 bouyer /******************************************************************************
304 1.1.1.2.2.2 bouyer *
305 1.1.1.2.2.2 bouyer * Fields. All share a common header/info field.
306 1.1.1.2.2.2 bouyer *
307 1.1.1.2.2.2 bouyer *****************************************************************************/
308 1.1.1.2.2.2 bouyer
309 1.1.1.2.2.2 bouyer /*
310 1.1.1.2.2.2 bouyer * Common bitfield for the field objects
311 1.1.1.2.2.2 bouyer * "Field Datum" -- a datum from the actual field object
312 1.1.1.2.2.2 bouyer * "Buffer Datum" -- a datum from a user buffer, read from or to be written to the field
313 1.1.1.2.2.2 bouyer */
314 1.1.1.2.2.2 bouyer #define ACPI_COMMON_FIELD_INFO \
315 1.1.1.2.2.2 bouyer UINT8 FieldFlags; /* Access, update, and lock bits */\
316 1.1.1.2.2.2 bouyer UINT8 Attribute; /* From AccessAs keyword */\
317 1.1.1.2.2.2 bouyer UINT8 AccessByteWidth; /* Read/Write size in bytes */\
318 1.1.1.2.2.2 bouyer ACPI_NAMESPACE_NODE *Node; /* Link back to parent node */\
319 1.1.1.2.2.2 bouyer UINT32 BitLength; /* Length of field in bits */\
320 1.1.1.2.2.2 bouyer UINT32 BaseByteOffset; /* Byte offset within containing object */\
321 1.1.1.2.2.2 bouyer UINT32 Value; /* Value to store into the Bank or Index register */\
322 1.1.1.2.2.2 bouyer UINT8 StartFieldBitOffset;/* Bit offset within first field datum (0-63) */\
323 1.1.1.2.2.2 bouyer
324 1.1.1.2.2.2 bouyer
325 1.1.1.2.2.2 bouyer typedef struct acpi_object_field_common /* COMMON FIELD (for BUFFER, REGION, BANK, and INDEX fields) */
326 1.1.1.2.2.2 bouyer {
327 1.1.1.2.2.2 bouyer ACPI_OBJECT_COMMON_HEADER
328 1.1.1.2.2.2 bouyer ACPI_COMMON_FIELD_INFO
329 1.1.1.2.2.2 bouyer union acpi_operand_object *RegionObj; /* Parent Operation Region object (REGION/BANK fields only) */
330 1.1.1.2.2.2 bouyer
331 1.1.1.2.2.2 bouyer } ACPI_OBJECT_FIELD_COMMON;
332 1.1.1.2.2.2 bouyer
333 1.1.1.2.2.2 bouyer
334 1.1.1.2.2.2 bouyer typedef struct acpi_object_region_field
335 1.1.1.2.2.2 bouyer {
336 1.1.1.2.2.2 bouyer ACPI_OBJECT_COMMON_HEADER
337 1.1.1.2.2.2 bouyer ACPI_COMMON_FIELD_INFO
338 1.1.1.2.2.2 bouyer union acpi_operand_object *RegionObj; /* Containing OpRegion object */
339 1.1.1.2.2.2 bouyer
340 1.1.1.2.2.2 bouyer } ACPI_OBJECT_REGION_FIELD;
341 1.1.1.2.2.2 bouyer
342 1.1.1.2.2.2 bouyer
343 1.1.1.2.2.2 bouyer typedef struct acpi_object_bank_field
344 1.1.1.2.2.2 bouyer {
345 1.1.1.2.2.2 bouyer ACPI_OBJECT_COMMON_HEADER
346 1.1.1.2.2.2 bouyer ACPI_COMMON_FIELD_INFO
347 1.1.1.2.2.2 bouyer union acpi_operand_object *RegionObj; /* Containing OpRegion object */
348 1.1.1.2.2.2 bouyer union acpi_operand_object *BankObj; /* BankSelect Register object */
349 1.1.1.2.2.2 bouyer
350 1.1.1.2.2.2 bouyer } ACPI_OBJECT_BANK_FIELD;
351 1.1.1.2.2.2 bouyer
352 1.1.1.2.2.2 bouyer
353 1.1.1.2.2.2 bouyer typedef struct acpi_object_index_field
354 1.1.1.2.2.2 bouyer {
355 1.1.1.2.2.2 bouyer ACPI_OBJECT_COMMON_HEADER
356 1.1.1.2.2.2 bouyer ACPI_COMMON_FIELD_INFO
357 1.1.1.2.2.2 bouyer
358 1.1.1.2.2.2 bouyer /*
359 1.1.1.2.2.2 bouyer * No "RegionObj" pointer needed since the Index and Data registers
360 1.1.1.2.2.2 bouyer * are each field definitions unto themselves.
361 1.1.1.2.2.2 bouyer */
362 1.1.1.2.2.2 bouyer union acpi_operand_object *IndexObj; /* Index register */
363 1.1.1.2.2.2 bouyer union acpi_operand_object *DataObj; /* Data register */
364 1.1.1.2.2.2 bouyer
365 1.1.1.2.2.2 bouyer } ACPI_OBJECT_INDEX_FIELD;
366 1.1.1.2.2.2 bouyer
367 1.1.1.2.2.2 bouyer
368 1.1.1.2.2.2 bouyer /* The BufferField is different in that it is part of a Buffer, not an OpRegion */
369 1.1.1.2.2.2 bouyer
370 1.1.1.2.2.2 bouyer typedef struct acpi_object_buffer_field
371 1.1.1.2.2.2 bouyer {
372 1.1.1.2.2.2 bouyer ACPI_OBJECT_COMMON_HEADER
373 1.1.1.2.2.2 bouyer ACPI_COMMON_FIELD_INFO
374 1.1.1.2.2.2 bouyer union acpi_operand_object *BufferObj; /* Containing Buffer object */
375 1.1.1.2.2.2 bouyer
376 1.1.1.2.2.2 bouyer } ACPI_OBJECT_BUFFER_FIELD;
377 1.1.1.2.2.2 bouyer
378 1.1.1.2.2.2 bouyer
379 1.1.1.2.2.2 bouyer /******************************************************************************
380 1.1.1.2.2.2 bouyer *
381 1.1.1.2.2.2 bouyer * Objects for handlers
382 1.1.1.2.2.2 bouyer *
383 1.1.1.2.2.2 bouyer *****************************************************************************/
384 1.1.1.2.2.2 bouyer
385 1.1.1.2.2.2 bouyer typedef struct acpi_object_notify_handler
386 1.1.1.2.2.2 bouyer {
387 1.1.1.2.2.2 bouyer ACPI_OBJECT_COMMON_HEADER
388 1.1.1.2.2.2 bouyer ACPI_NAMESPACE_NODE *Node; /* Parent device */
389 1.1.1.2.2.2 bouyer ACPI_NOTIFY_HANDLER Handler;
390 1.1.1.2.2.2 bouyer void *Context;
391 1.1.1.2.2.2 bouyer
392 1.1.1.2.2.2 bouyer } ACPI_OBJECT_NOTIFY_HANDLER;
393 1.1.1.2.2.2 bouyer
394 1.1.1.2.2.2 bouyer
395 1.1.1.2.2.2 bouyer typedef struct acpi_object_addr_handler
396 1.1.1.2.2.2 bouyer {
397 1.1.1.2.2.2 bouyer ACPI_OBJECT_COMMON_HEADER
398 1.1.1.2.2.2 bouyer UINT8 SpaceId;
399 1.1.1.2.2.2 bouyer UINT8 HandlerFlags;
400 1.1.1.2.2.2 bouyer ACPI_ADR_SPACE_HANDLER Handler;
401 1.1.1.2.2.2 bouyer ACPI_NAMESPACE_NODE *Node; /* Parent device */
402 1.1.1.2.2.2 bouyer void *Context;
403 1.1.1.2.2.2 bouyer ACPI_ADR_SPACE_SETUP Setup;
404 1.1.1.2.2.2 bouyer union acpi_operand_object *RegionList; /* regions using this handler */
405 1.1.1.2.2.2 bouyer union acpi_operand_object *Next;
406 1.1.1.2.2.2 bouyer
407 1.1.1.2.2.2 bouyer } ACPI_OBJECT_ADDR_HANDLER;
408 1.1.1.2.2.2 bouyer
409 1.1.1.2.2.2 bouyer /* Flags for address handler (HandlerFlags) */
410 1.1.1.2.2.2 bouyer
411 1.1.1.2.2.2 bouyer #define ACPI_ADDR_HANDLER_DEFAULT_INSTALLED 0x01
412 1.1.1.2.2.2 bouyer
413 1.1.1.2.2.2 bouyer
414 1.1.1.2.2.2 bouyer /******************************************************************************
415 1.1.1.2.2.2 bouyer *
416 1.1.1.2.2.2 bouyer * Special internal objects
417 1.1.1.2.2.2 bouyer *
418 1.1.1.2.2.2 bouyer *****************************************************************************/
419 1.1.1.2.2.2 bouyer
420 1.1.1.2.2.2 bouyer /*
421 1.1.1.2.2.2 bouyer * The Reference object is used for these opcodes:
422 1.1.1.2.2.2 bouyer * Arg[0-6], Local[0-7], IndexOp, NameOp, RefOfOp, LoadOp, LoadTableOp, DebugOp
423 1.1.1.2.2.2 bouyer * The Reference.Class differentiates these types.
424 1.1.1.2.2.2 bouyer */
425 1.1.1.2.2.2 bouyer typedef struct acpi_object_reference
426 1.1.1.2.2.2 bouyer {
427 1.1.1.2.2.2 bouyer ACPI_OBJECT_COMMON_HEADER
428 1.1.1.2.2.2 bouyer UINT8 Class; /* Reference Class */
429 1.1.1.2.2.2 bouyer UINT8 TargetType; /* Used for Index Op */
430 1.1.1.2.2.2 bouyer UINT8 Reserved;
431 1.1.1.2.2.2 bouyer void *Object; /* NameOp=>HANDLE to obj, IndexOp=>ACPI_OPERAND_OBJECT */
432 1.1.1.2.2.2 bouyer ACPI_NAMESPACE_NODE *Node; /* RefOf or Namepath */
433 1.1.1.2.2.2 bouyer union acpi_operand_object **Where; /* Target of Index */
434 1.1.1.2.2.2 bouyer UINT32 Value; /* Used for Local/Arg/Index/DdbHandle */
435 1.1.1.2.2.2 bouyer
436 1.1.1.2.2.2 bouyer } ACPI_OBJECT_REFERENCE;
437 1.1.1.2.2.2 bouyer
438 1.1.1.2.2.2 bouyer /* Values for Reference.Class above */
439 1.1.1.2.2.2 bouyer
440 1.1.1.2.2.2 bouyer typedef enum
441 1.1.1.2.2.2 bouyer {
442 1.1.1.2.2.2 bouyer ACPI_REFCLASS_LOCAL = 0, /* Method local */
443 1.1.1.2.2.2 bouyer ACPI_REFCLASS_ARG = 1, /* Method argument */
444 1.1.1.2.2.2 bouyer ACPI_REFCLASS_REFOF = 2, /* Result of RefOf() TBD: Split to Ref/Node and Ref/OperandObj? */
445 1.1.1.2.2.2 bouyer ACPI_REFCLASS_INDEX = 3, /* Result of Index() */
446 1.1.1.2.2.2 bouyer ACPI_REFCLASS_TABLE = 4, /* DdbHandle - Load(), LoadTable() */
447 1.1.1.2.2.2 bouyer ACPI_REFCLASS_NAME = 5, /* Reference to a named object */
448 1.1.1.2.2.2 bouyer ACPI_REFCLASS_DEBUG = 6, /* Debug object */
449 1.1.1.2.2.2 bouyer
450 1.1.1.2.2.2 bouyer ACPI_REFCLASS_MAX = 6
451 1.1.1.2.2.2 bouyer
452 1.1.1.2.2.2 bouyer } ACPI_REFERENCE_CLASSES;
453 1.1.1.2.2.2 bouyer
454 1.1.1.2.2.2 bouyer
455 1.1.1.2.2.2 bouyer /*
456 1.1.1.2.2.2 bouyer * Extra object is used as additional storage for types that
457 1.1.1.2.2.2 bouyer * have AML code in their declarations (TermArgs) that must be
458 1.1.1.2.2.2 bouyer * evaluated at run time.
459 1.1.1.2.2.2 bouyer *
460 1.1.1.2.2.2 bouyer * Currently: Region and FieldUnit types
461 1.1.1.2.2.2 bouyer */
462 1.1.1.2.2.2 bouyer typedef struct acpi_object_extra
463 1.1.1.2.2.2 bouyer {
464 1.1.1.2.2.2 bouyer ACPI_OBJECT_COMMON_HEADER
465 1.1.1.2.2.2 bouyer ACPI_NAMESPACE_NODE *Method_REG; /* _REG method for this region (if any) */
466 1.1.1.2.2.2 bouyer void *RegionContext; /* Region-specific data */
467 1.1.1.2.2.2 bouyer UINT8 *AmlStart;
468 1.1.1.2.2.2 bouyer UINT32 AmlLength;
469 1.1.1.2.2.2 bouyer
470 1.1.1.2.2.2 bouyer } ACPI_OBJECT_EXTRA;
471 1.1.1.2.2.2 bouyer
472 1.1.1.2.2.2 bouyer
473 1.1.1.2.2.2 bouyer /* Additional data that can be attached to namespace nodes */
474 1.1.1.2.2.2 bouyer
475 1.1.1.2.2.2 bouyer typedef struct acpi_object_data
476 1.1.1.2.2.2 bouyer {
477 1.1.1.2.2.2 bouyer ACPI_OBJECT_COMMON_HEADER
478 1.1.1.2.2.2 bouyer ACPI_OBJECT_HANDLER Handler;
479 1.1.1.2.2.2 bouyer void *Pointer;
480 1.1.1.2.2.2 bouyer
481 1.1.1.2.2.2 bouyer } ACPI_OBJECT_DATA;
482 1.1.1.2.2.2 bouyer
483 1.1.1.2.2.2 bouyer
484 1.1.1.2.2.2 bouyer /* Structure used when objects are cached for reuse */
485 1.1.1.2.2.2 bouyer
486 1.1.1.2.2.2 bouyer typedef struct acpi_object_cache_list
487 1.1.1.2.2.2 bouyer {
488 1.1.1.2.2.2 bouyer ACPI_OBJECT_COMMON_HEADER
489 1.1.1.2.2.2 bouyer union acpi_operand_object *Next; /* Link for object cache and internal lists*/
490 1.1.1.2.2.2 bouyer
491 1.1.1.2.2.2 bouyer } ACPI_OBJECT_CACHE_LIST;
492 1.1.1.2.2.2 bouyer
493 1.1.1.2.2.2 bouyer
494 1.1.1.2.2.2 bouyer /******************************************************************************
495 1.1.1.2.2.2 bouyer *
496 1.1.1.2.2.2 bouyer * ACPI_OPERAND_OBJECT Descriptor - a giant union of all of the above
497 1.1.1.2.2.2 bouyer *
498 1.1.1.2.2.2 bouyer *****************************************************************************/
499 1.1.1.2.2.2 bouyer
500 1.1.1.2.2.2 bouyer typedef union acpi_operand_object
501 1.1.1.2.2.2 bouyer {
502 1.1.1.2.2.2 bouyer ACPI_OBJECT_COMMON Common;
503 1.1.1.2.2.2 bouyer ACPI_OBJECT_INTEGER Integer;
504 1.1.1.2.2.2 bouyer ACPI_OBJECT_STRING String;
505 1.1.1.2.2.2 bouyer ACPI_OBJECT_BUFFER Buffer;
506 1.1.1.2.2.2 bouyer ACPI_OBJECT_PACKAGE Package;
507 1.1.1.2.2.2 bouyer ACPI_OBJECT_EVENT Event;
508 1.1.1.2.2.2 bouyer ACPI_OBJECT_METHOD Method;
509 1.1.1.2.2.2 bouyer ACPI_OBJECT_MUTEX Mutex;
510 1.1.1.2.2.2 bouyer ACPI_OBJECT_REGION Region;
511 1.1.1.2.2.2 bouyer ACPI_OBJECT_NOTIFY_COMMON CommonNotify;
512 1.1.1.2.2.2 bouyer ACPI_OBJECT_DEVICE Device;
513 1.1.1.2.2.2 bouyer ACPI_OBJECT_POWER_RESOURCE PowerResource;
514 1.1.1.2.2.2 bouyer ACPI_OBJECT_PROCESSOR Processor;
515 1.1.1.2.2.2 bouyer ACPI_OBJECT_THERMAL_ZONE ThermalZone;
516 1.1.1.2.2.2 bouyer ACPI_OBJECT_FIELD_COMMON CommonField;
517 1.1.1.2.2.2 bouyer ACPI_OBJECT_REGION_FIELD Field;
518 1.1.1.2.2.2 bouyer ACPI_OBJECT_BUFFER_FIELD BufferField;
519 1.1.1.2.2.2 bouyer ACPI_OBJECT_BANK_FIELD BankField;
520 1.1.1.2.2.2 bouyer ACPI_OBJECT_INDEX_FIELD IndexField;
521 1.1.1.2.2.2 bouyer ACPI_OBJECT_NOTIFY_HANDLER Notify;
522 1.1.1.2.2.2 bouyer ACPI_OBJECT_ADDR_HANDLER AddressSpace;
523 1.1.1.2.2.2 bouyer ACPI_OBJECT_REFERENCE Reference;
524 1.1.1.2.2.2 bouyer ACPI_OBJECT_EXTRA Extra;
525 1.1.1.2.2.2 bouyer ACPI_OBJECT_DATA Data;
526 1.1.1.2.2.2 bouyer ACPI_OBJECT_CACHE_LIST Cache;
527 1.1.1.2.2.2 bouyer
528 1.1.1.2.2.2 bouyer /*
529 1.1.1.2.2.2 bouyer * Add namespace node to union in order to simplify code that accepts both
530 1.1.1.2.2.2 bouyer * ACPI_OPERAND_OBJECTs and ACPI_NAMESPACE_NODEs. The structures share
531 1.1.1.2.2.2 bouyer * a common DescriptorType field in order to differentiate them.
532 1.1.1.2.2.2 bouyer */
533 1.1.1.2.2.2 bouyer ACPI_NAMESPACE_NODE Node;
534 1.1.1.2.2.2 bouyer
535 1.1.1.2.2.2 bouyer } ACPI_OPERAND_OBJECT;
536 1.1.1.2.2.2 bouyer
537 1.1.1.2.2.2 bouyer
538 1.1.1.2.2.2 bouyer /******************************************************************************
539 1.1.1.2.2.2 bouyer *
540 1.1.1.2.2.2 bouyer * ACPI_DESCRIPTOR - objects that share a common descriptor identifier
541 1.1.1.2.2.2 bouyer *
542 1.1.1.2.2.2 bouyer *****************************************************************************/
543 1.1.1.2.2.2 bouyer
544 1.1.1.2.2.2 bouyer /* Object descriptor types */
545 1.1.1.2.2.2 bouyer
546 1.1.1.2.2.2 bouyer #define ACPI_DESC_TYPE_CACHED 0x01 /* Used only when object is cached */
547 1.1.1.2.2.2 bouyer #define ACPI_DESC_TYPE_STATE 0x02
548 1.1.1.2.2.2 bouyer #define ACPI_DESC_TYPE_STATE_UPDATE 0x03
549 1.1.1.2.2.2 bouyer #define ACPI_DESC_TYPE_STATE_PACKAGE 0x04
550 1.1.1.2.2.2 bouyer #define ACPI_DESC_TYPE_STATE_CONTROL 0x05
551 1.1.1.2.2.2 bouyer #define ACPI_DESC_TYPE_STATE_RPSCOPE 0x06
552 1.1.1.2.2.2 bouyer #define ACPI_DESC_TYPE_STATE_PSCOPE 0x07
553 1.1.1.2.2.2 bouyer #define ACPI_DESC_TYPE_STATE_WSCOPE 0x08
554 1.1.1.2.2.2 bouyer #define ACPI_DESC_TYPE_STATE_RESULT 0x09
555 1.1.1.2.2.2 bouyer #define ACPI_DESC_TYPE_STATE_NOTIFY 0x0A
556 1.1.1.2.2.2 bouyer #define ACPI_DESC_TYPE_STATE_THREAD 0x0B
557 1.1.1.2.2.2 bouyer #define ACPI_DESC_TYPE_WALK 0x0C
558 1.1.1.2.2.2 bouyer #define ACPI_DESC_TYPE_PARSER 0x0D
559 1.1.1.2.2.2 bouyer #define ACPI_DESC_TYPE_OPERAND 0x0E
560 1.1.1.2.2.2 bouyer #define ACPI_DESC_TYPE_NAMED 0x0F
561 1.1.1.2.2.2 bouyer #define ACPI_DESC_TYPE_MAX 0x0F
562 1.1.1.2.2.2 bouyer
563 1.1.1.2.2.2 bouyer
564 1.1.1.2.2.2 bouyer typedef struct acpi_common_descriptor
565 1.1.1.2.2.2 bouyer {
566 1.1.1.2.2.2 bouyer void *CommonPointer;
567 1.1.1.2.2.2 bouyer UINT8 DescriptorType; /* To differentiate various internal objs */
568 1.1.1.2.2.2 bouyer
569 1.1.1.2.2.2 bouyer } ACPI_COMMON_DESCRIPTOR;
570 1.1.1.2.2.2 bouyer
571 1.1.1.2.2.2 bouyer typedef union acpi_descriptor
572 1.1.1.2.2.2 bouyer {
573 1.1.1.2.2.2 bouyer ACPI_COMMON_DESCRIPTOR Common;
574 1.1.1.2.2.2 bouyer ACPI_OPERAND_OBJECT Object;
575 1.1.1.2.2.2 bouyer ACPI_NAMESPACE_NODE Node;
576 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT Op;
577 1.1.1.2.2.2 bouyer
578 1.1.1.2.2.2 bouyer } ACPI_DESCRIPTOR;
579 1.1.1.2.2.2 bouyer
580 1.1.1.2.2.2 bouyer #pragma pack()
581 1.1.1.2.2.2 bouyer
582 1.1.1.2.2.2 bouyer #endif /* _ACOBJECT_H */
583