Go to most recent revision | Details | Last modification | View Log | RSS feed
Rev | Author | Line No. | Line |
---|---|---|---|
434 | giacomo | 1 | |
2 | /****************************************************************************** |
||
3 | * |
||
4 | * Name: acobject.h - Definition of union acpi_operand_object (Internal object only) |
||
5 | * |
||
6 | *****************************************************************************/ |
||
7 | |||
8 | /* |
||
9 | * Copyright (C) 2000 - 2003, R. Byron Moore |
||
10 | * All rights reserved. |
||
11 | * |
||
12 | * Redistribution and use in source and binary forms, with or without |
||
13 | * modification, are permitted provided that the following conditions |
||
14 | * are met: |
||
15 | * 1. Redistributions of source code must retain the above copyright |
||
16 | * notice, this list of conditions, and the following disclaimer, |
||
17 | * without modification. |
||
18 | * 2. Redistributions in binary form must reproduce at minimum a disclaimer |
||
19 | * substantially similar to the "NO WARRANTY" disclaimer below |
||
20 | * ("Disclaimer") and any redistribution must be conditioned upon |
||
21 | * including a substantially similar Disclaimer requirement for further |
||
22 | * binary redistribution. |
||
23 | * 3. Neither the names of the above-listed copyright holders nor the names |
||
24 | * of any contributors may be used to endorse or promote products derived |
||
25 | * from this software without specific prior written permission. |
||
26 | * |
||
27 | * Alternatively, this software may be distributed under the terms of the |
||
28 | * GNU General Public License ("GPL") version 2 as published by the Free |
||
29 | * Software Foundation. |
||
30 | * |
||
31 | * NO WARRANTY |
||
32 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||
33 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||
34 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR |
||
35 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||
36 | * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
||
37 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
||
38 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
||
39 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, |
||
40 | * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING |
||
41 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
||
42 | * POSSIBILITY OF SUCH DAMAGES. |
||
43 | */ |
||
44 | |||
45 | #ifndef _ACOBJECT_H |
||
46 | #define _ACOBJECT_H |
||
47 | |||
48 | |||
49 | /* |
||
50 | * The union acpi_operand_object is used to pass AML operands from the dispatcher |
||
51 | * to the interpreter, and to keep track of the various handlers such as |
||
52 | * address space handlers and notify handlers. The object is a constant |
||
53 | * size in order to allow it to be cached and reused. |
||
54 | */ |
||
55 | |||
56 | /******************************************************************************* |
||
57 | * |
||
58 | * Common Descriptors |
||
59 | * |
||
60 | ******************************************************************************/ |
||
61 | |||
62 | /* |
||
63 | * Common area for all objects. |
||
64 | * |
||
65 | * data_type is used to differentiate between internal descriptors, and MUST |
||
66 | * be the first byte in this structure. |
||
67 | */ |
||
68 | #define ACPI_OBJECT_COMMON_HEADER /* SIZE/ALIGNMENT: 32 bits, one ptr plus trailing 8-bit flag */\ |
||
69 | u8 descriptor; /* To differentiate various internal objs */\ |
||
70 | u8 type; /* acpi_object_type */\ |
||
71 | u16 reference_count; /* For object deletion management */\ |
||
72 | union acpi_operand_object *next_object; /* Objects linked to parent NS node */\ |
||
73 | u8 flags; \ |
||
74 | |||
75 | /* Values for flag byte above */ |
||
76 | |||
77 | #define AOPOBJ_AML_CONSTANT 0x01 |
||
78 | #define AOPOBJ_STATIC_POINTER 0x02 |
||
79 | #define AOPOBJ_DATA_VALID 0x04 |
||
80 | #define AOPOBJ_OBJECT_INITIALIZED 0x08 |
||
81 | #define AOPOBJ_SETUP_COMPLETE 0x10 |
||
82 | #define AOPOBJ_SINGLE_DATUM 0x20 |
||
83 | |||
84 | |||
85 | /* |
||
86 | * Common bitfield for the field objects |
||
87 | * "Field Datum" -- a datum from the actual field object |
||
88 | * "Buffer Datum" -- a datum from a user buffer, read from or to be written to the field |
||
89 | */ |
||
90 | #define ACPI_COMMON_FIELD_INFO /* SIZE/ALIGNMENT: 24 bits + three 32-bit values */\ |
||
91 | u8 field_flags; /* Access, update, and lock bits */\ |
||
92 | u8 attribute; /* From access_as keyword */\ |
||
93 | u8 access_byte_width; /* Read/Write size in bytes */\ |
||
94 | u32 bit_length; /* Length of field in bits */\ |
||
95 | u32 base_byte_offset; /* Byte offset within containing object */\ |
||
96 | u8 start_field_bit_offset;/* Bit offset within first field datum (0-63) */\ |
||
97 | u8 datum_valid_bits; /* Valid bit in first "Field datum" */\ |
||
98 | u8 end_field_valid_bits; /* Valid bits in the last "field datum" */\ |
||
99 | u8 end_buffer_valid_bits; /* Valid bits in the last "buffer datum" */\ |
||
100 | u32 value; /* Value to store into the Bank or Index register */\ |
||
101 | struct acpi_namespace_node *node; /* Link back to parent node */ |
||
102 | |||
103 | |||
104 | /* |
||
105 | * Fields common to both Strings and Buffers |
||
106 | */ |
||
107 | #define ACPI_COMMON_BUFFER_INFO \ |
||
108 | u32 length; |
||
109 | |||
110 | |||
111 | /* |
||
112 | * Common fields for objects that support ASL notifications |
||
113 | */ |
||
114 | #define ACPI_COMMON_NOTIFY_INFO \ |
||
115 | union acpi_operand_object *system_notify; /* Handler for system notifies */\ |
||
116 | union acpi_operand_object *device_notify; /* Handler for driver notifies */\ |
||
117 | union acpi_operand_object *address_space; /* Handler for Address space */ |
||
118 | |||
119 | |||
120 | /****************************************************************************** |
||
121 | * |
||
122 | * Basic data types |
||
123 | * |
||
124 | *****************************************************************************/ |
||
125 | |||
126 | struct acpi_object_common |
||
127 | { |
||
128 | ACPI_OBJECT_COMMON_HEADER |
||
129 | }; |
||
130 | |||
131 | |||
132 | struct acpi_object_integer |
||
133 | { |
||
134 | ACPI_OBJECT_COMMON_HEADER |
||
135 | acpi_integer value; |
||
136 | }; |
||
137 | |||
138 | |||
139 | struct acpi_object_string /* Null terminated, ASCII characters only */ |
||
140 | { |
||
141 | ACPI_OBJECT_COMMON_HEADER |
||
142 | ACPI_COMMON_BUFFER_INFO |
||
143 | char *pointer; /* String in AML stream or allocated string */ |
||
144 | }; |
||
145 | |||
146 | |||
147 | struct acpi_object_buffer |
||
148 | { |
||
149 | ACPI_OBJECT_COMMON_HEADER |
||
150 | ACPI_COMMON_BUFFER_INFO |
||
151 | u8 *pointer; /* Buffer in AML stream or allocated buffer */ |
||
152 | struct acpi_namespace_node *node; /* Link back to parent node */ |
||
153 | u8 *aml_start; |
||
154 | u32 aml_length; |
||
155 | }; |
||
156 | |||
157 | |||
158 | struct acpi_object_package |
||
159 | { |
||
160 | ACPI_OBJECT_COMMON_HEADER |
||
161 | |||
162 | u32 count; /* # of elements in package */ |
||
163 | u32 aml_length; |
||
164 | u8 *aml_start; |
||
165 | struct acpi_namespace_node *node; /* Link back to parent node */ |
||
166 | union acpi_operand_object **elements; /* Array of pointers to acpi_objects */ |
||
167 | }; |
||
168 | |||
169 | |||
170 | /****************************************************************************** |
||
171 | * |
||
172 | * Complex data types |
||
173 | * |
||
174 | *****************************************************************************/ |
||
175 | |||
176 | struct acpi_object_event |
||
177 | { |
||
178 | ACPI_OBJECT_COMMON_HEADER |
||
179 | void *semaphore; |
||
180 | }; |
||
181 | |||
182 | |||
183 | #define INFINITE_CONCURRENCY 0xFF |
||
184 | |||
185 | struct acpi_object_method |
||
186 | { |
||
187 | ACPI_OBJECT_COMMON_HEADER |
||
188 | u8 method_flags; |
||
189 | u8 param_count; |
||
190 | u32 aml_length; |
||
191 | void *semaphore; |
||
192 | u8 *aml_start; |
||
193 | u8 concurrency; |
||
194 | u8 thread_count; |
||
195 | acpi_owner_id owning_id; |
||
196 | }; |
||
197 | |||
198 | |||
199 | struct acpi_object_mutex |
||
200 | { |
||
201 | ACPI_OBJECT_COMMON_HEADER |
||
202 | u16 sync_level; |
||
203 | u16 acquisition_depth; |
||
204 | struct acpi_thread_state *owner_thread; |
||
205 | void *semaphore; |
||
206 | union acpi_operand_object *prev; /* Link for list of acquired mutexes */ |
||
207 | union acpi_operand_object *next; /* Link for list of acquired mutexes */ |
||
208 | struct acpi_namespace_node *node; /* containing object */ |
||
209 | }; |
||
210 | |||
211 | |||
212 | struct acpi_object_region |
||
213 | { |
||
214 | ACPI_OBJECT_COMMON_HEADER |
||
215 | |||
216 | u8 space_id; |
||
217 | union acpi_operand_object *address_space; /* Handler for region access */ |
||
218 | struct acpi_namespace_node *node; /* containing object */ |
||
219 | union acpi_operand_object *next; |
||
220 | u32 length; |
||
221 | acpi_physical_address address; |
||
222 | }; |
||
223 | |||
224 | |||
225 | /****************************************************************************** |
||
226 | * |
||
227 | * Objects that can be notified. All share a common notify_info area. |
||
228 | * |
||
229 | *****************************************************************************/ |
||
230 | |||
231 | struct acpi_object_notify_common /* COMMON NOTIFY for POWER, PROCESSOR, DEVICE, and THERMAL */ |
||
232 | { |
||
233 | ACPI_OBJECT_COMMON_HEADER |
||
234 | ACPI_COMMON_NOTIFY_INFO |
||
235 | }; |
||
236 | |||
237 | |||
238 | struct acpi_object_device |
||
239 | { |
||
240 | ACPI_OBJECT_COMMON_HEADER |
||
241 | ACPI_COMMON_NOTIFY_INFO |
||
242 | struct acpi_gpe_block_info *gpe_block; |
||
243 | }; |
||
244 | |||
245 | |||
246 | struct acpi_object_power_resource |
||
247 | { |
||
248 | ACPI_OBJECT_COMMON_HEADER |
||
249 | ACPI_COMMON_NOTIFY_INFO |
||
250 | u32 system_level; |
||
251 | u32 resource_order; |
||
252 | }; |
||
253 | |||
254 | |||
255 | struct acpi_object_processor |
||
256 | { |
||
257 | ACPI_OBJECT_COMMON_HEADER |
||
258 | ACPI_COMMON_NOTIFY_INFO |
||
259 | u32 proc_id; |
||
260 | u32 length; |
||
261 | acpi_io_address address; |
||
262 | }; |
||
263 | |||
264 | |||
265 | struct acpi_object_thermal_zone |
||
266 | { |
||
267 | ACPI_OBJECT_COMMON_HEADER |
||
268 | ACPI_COMMON_NOTIFY_INFO |
||
269 | }; |
||
270 | |||
271 | |||
272 | /****************************************************************************** |
||
273 | * |
||
274 | * Fields. All share a common header/info field. |
||
275 | * |
||
276 | *****************************************************************************/ |
||
277 | |||
278 | struct acpi_object_field_common /* COMMON FIELD (for BUFFER, REGION, BANK, and INDEX fields) */ |
||
279 | { |
||
280 | ACPI_OBJECT_COMMON_HEADER |
||
281 | ACPI_COMMON_FIELD_INFO |
||
282 | union acpi_operand_object *region_obj; /* Containing Operation Region object */ |
||
283 | /* (REGION/BANK fields only) */ |
||
284 | }; |
||
285 | |||
286 | |||
287 | struct acpi_object_region_field |
||
288 | { |
||
289 | ACPI_OBJECT_COMMON_HEADER |
||
290 | ACPI_COMMON_FIELD_INFO |
||
291 | union acpi_operand_object *region_obj; /* Containing op_region object */ |
||
292 | }; |
||
293 | |||
294 | |||
295 | struct acpi_object_bank_field |
||
296 | { |
||
297 | ACPI_OBJECT_COMMON_HEADER |
||
298 | ACPI_COMMON_FIELD_INFO |
||
299 | union acpi_operand_object *region_obj; /* Containing op_region object */ |
||
300 | union acpi_operand_object *bank_obj; /* bank_select Register object */ |
||
301 | }; |
||
302 | |||
303 | |||
304 | struct acpi_object_index_field |
||
305 | { |
||
306 | ACPI_OBJECT_COMMON_HEADER |
||
307 | ACPI_COMMON_FIELD_INFO |
||
308 | |||
309 | /* |
||
310 | * No "region_obj" pointer needed since the Index and Data registers |
||
311 | * are each field definitions unto themselves. |
||
312 | */ |
||
313 | union acpi_operand_object *index_obj; /* Index register */ |
||
314 | union acpi_operand_object *data_obj; /* Data register */ |
||
315 | }; |
||
316 | |||
317 | |||
318 | /* The buffer_field is different in that it is part of a Buffer, not an op_region */ |
||
319 | |||
320 | struct acpi_object_buffer_field |
||
321 | { |
||
322 | ACPI_OBJECT_COMMON_HEADER |
||
323 | ACPI_COMMON_FIELD_INFO |
||
324 | union acpi_operand_object *buffer_obj; /* Containing Buffer object */ |
||
325 | }; |
||
326 | |||
327 | |||
328 | /****************************************************************************** |
||
329 | * |
||
330 | * Objects for handlers |
||
331 | * |
||
332 | *****************************************************************************/ |
||
333 | |||
334 | struct acpi_object_notify_handler |
||
335 | { |
||
336 | ACPI_OBJECT_COMMON_HEADER |
||
337 | struct acpi_namespace_node *node; /* Parent device */ |
||
338 | acpi_notify_handler handler; |
||
339 | void *context; |
||
340 | }; |
||
341 | |||
342 | |||
343 | /* Flags for address handler */ |
||
344 | |||
345 | #define ACPI_ADDR_HANDLER_DEFAULT_INSTALLED 0x1 |
||
346 | |||
347 | |||
348 | struct acpi_object_addr_handler |
||
349 | { |
||
350 | ACPI_OBJECT_COMMON_HEADER |
||
351 | u8 space_id; |
||
352 | u16 hflags; |
||
353 | acpi_adr_space_handler handler; |
||
354 | struct acpi_namespace_node *node; /* Parent device */ |
||
355 | void *context; |
||
356 | acpi_adr_space_setup setup; |
||
357 | union acpi_operand_object *region_list; /* regions using this handler */ |
||
358 | union acpi_operand_object *next; |
||
359 | }; |
||
360 | |||
361 | |||
362 | /****************************************************************************** |
||
363 | * |
||
364 | * Special internal objects |
||
365 | * |
||
366 | *****************************************************************************/ |
||
367 | |||
368 | /* |
||
369 | * The Reference object type is used for these opcodes: |
||
370 | * Arg[0-6], Local[0-7], index_op, name_op, zero_op, one_op, ones_op, debug_op |
||
371 | */ |
||
372 | struct acpi_object_reference |
||
373 | { |
||
374 | ACPI_OBJECT_COMMON_HEADER |
||
375 | u8 target_type; /* Used for index_op */ |
||
376 | u16 opcode; |
||
377 | u32 offset; /* Used for arg_op, local_op, and index_op */ |
||
378 | void *object; /* name_op=>HANDLE to obj, index_op=>union acpi_operand_object */ |
||
379 | struct acpi_namespace_node *node; |
||
380 | union acpi_operand_object **where; |
||
381 | }; |
||
382 | |||
383 | |||
384 | /* |
||
385 | * Extra object is used as additional storage for types that |
||
386 | * have AML code in their declarations (term_args) that must be |
||
387 | * evaluated at run time. |
||
388 | * |
||
389 | * Currently: Region and field_unit types |
||
390 | */ |
||
391 | struct acpi_object_extra |
||
392 | { |
||
393 | ACPI_OBJECT_COMMON_HEADER |
||
394 | u8 byte_fill1; |
||
395 | u16 word_fill1; |
||
396 | u32 aml_length; |
||
397 | u8 *aml_start; |
||
398 | struct acpi_namespace_node *method_REG; /* _REG method for this region (if any) */ |
||
399 | void *region_context; /* Region-specific data */ |
||
400 | }; |
||
401 | |||
402 | |||
403 | /* Additional data that can be attached to namespace nodes */ |
||
404 | |||
405 | struct acpi_object_data |
||
406 | { |
||
407 | ACPI_OBJECT_COMMON_HEADER |
||
408 | acpi_object_handler handler; |
||
409 | void *pointer; |
||
410 | }; |
||
411 | |||
412 | |||
413 | /* Structure used when objects are cached for reuse */ |
||
414 | |||
415 | struct acpi_object_cache_list |
||
416 | { |
||
417 | ACPI_OBJECT_COMMON_HEADER |
||
418 | union acpi_operand_object *next; /* Link for object cache and internal lists*/ |
||
419 | }; |
||
420 | |||
421 | |||
422 | /****************************************************************************** |
||
423 | * |
||
424 | * union acpi_operand_object Descriptor - a giant union of all of the above |
||
425 | * |
||
426 | *****************************************************************************/ |
||
427 | |||
428 | union acpi_operand_object |
||
429 | { |
||
430 | struct acpi_object_common common; |
||
431 | struct acpi_object_integer integer; |
||
432 | struct acpi_object_string string; |
||
433 | struct acpi_object_buffer buffer; |
||
434 | struct acpi_object_package package; |
||
435 | struct acpi_object_event event; |
||
436 | struct acpi_object_method method; |
||
437 | struct acpi_object_mutex mutex; |
||
438 | struct acpi_object_region region; |
||
439 | struct acpi_object_notify_common common_notify; |
||
440 | struct acpi_object_device device; |
||
441 | struct acpi_object_power_resource power_resource; |
||
442 | struct acpi_object_processor processor; |
||
443 | struct acpi_object_thermal_zone thermal_zone; |
||
444 | struct acpi_object_field_common common_field; |
||
445 | struct acpi_object_region_field field; |
||
446 | struct acpi_object_buffer_field buffer_field; |
||
447 | struct acpi_object_bank_field bank_field; |
||
448 | struct acpi_object_index_field index_field; |
||
449 | struct acpi_object_notify_handler notify; |
||
450 | struct acpi_object_addr_handler address_space; |
||
451 | struct acpi_object_reference reference; |
||
452 | struct acpi_object_extra extra; |
||
453 | struct acpi_object_data data; |
||
454 | struct acpi_object_cache_list cache; |
||
455 | }; |
||
456 | |||
457 | |||
458 | /****************************************************************************** |
||
459 | * |
||
460 | * union acpi_descriptor - objects that share a common descriptor identifier |
||
461 | * |
||
462 | *****************************************************************************/ |
||
463 | |||
464 | |||
465 | /* Object descriptor types */ |
||
466 | |||
467 | #define ACPI_DESC_TYPE_CACHED 0x11 /* Used only when object is cached */ |
||
468 | #define ACPI_DESC_TYPE_STATE 0x20 |
||
469 | #define ACPI_DESC_TYPE_STATE_UPDATE 0x21 |
||
470 | #define ACPI_DESC_TYPE_STATE_PACKAGE 0x22 |
||
471 | #define ACPI_DESC_TYPE_STATE_CONTROL 0x23 |
||
472 | #define ACPI_DESC_TYPE_STATE_RPSCOPE 0x24 |
||
473 | #define ACPI_DESC_TYPE_STATE_PSCOPE 0x25 |
||
474 | #define ACPI_DESC_TYPE_STATE_WSCOPE 0x26 |
||
475 | #define ACPI_DESC_TYPE_STATE_RESULT 0x27 |
||
476 | #define ACPI_DESC_TYPE_STATE_NOTIFY 0x28 |
||
477 | #define ACPI_DESC_TYPE_STATE_THREAD 0x29 |
||
478 | #define ACPI_DESC_TYPE_WALK 0x44 |
||
479 | #define ACPI_DESC_TYPE_PARSER 0x66 |
||
480 | #define ACPI_DESC_TYPE_OPERAND 0x88 |
||
481 | #define ACPI_DESC_TYPE_NAMED 0xAA |
||
482 | |||
483 | |||
484 | union acpi_descriptor |
||
485 | { |
||
486 | u8 descriptor_id; /* To differentiate various internal objs */\ |
||
487 | union acpi_operand_object object; |
||
488 | struct acpi_namespace_node node; |
||
489 | union acpi_parse_object op; |
||
490 | }; |
||
491 | |||
492 | |||
493 | #endif /* _ACOBJECT_H */ |