projects/linux·blob v2.6.21 · refs

422 lines · 15.3 KiB

1
2/******************************************************************************
3 *
4 * Name: acobject.h - Definition of union acpi_operand_object (Internal object only)
5 *
6 *****************************************************************************/
7
8/*
9 * Copyright (C) 2000 - 2007, 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/* acpisrc:struct_defs -- for acpisrc conversion */
49
50/*
51 * The union acpi_operand_object is used to pass AML operands from the dispatcher
52 * to the interpreter, and to keep track of the various handlers such as
53 * address space handlers and notify handlers. The object is a constant
54 * size in order to allow it to be cached and reused.
55 *
56 * Note: The object is optimized to be aligned and will not work if it is
57 * byte-packed.
58 */
59#if ACPI_MACHINE_WIDTH == 64
60#pragma pack(8)
61#else
62#pragma pack(4)
63#endif
64
65/*******************************************************************************
66 *
67 * Common Descriptors
68 *
69 ******************************************************************************/
70
71/*
72 * Common area for all objects.
73 *
74 * descriptor_type is used to differentiate between internal descriptors, and
75 * must be in the same place across all descriptors
76 *
77 * Note: The descriptor_type and Type fields must appear in the identical
78 * position in both the struct acpi_namespace_node and union acpi_operand_object
79 * structures.
80 */
81#define ACPI_OBJECT_COMMON_HEADER \
82 union acpi_operand_object *next_object; /* Objects linked to parent NS node */\
83 u8 descriptor_type; /* To differentiate various internal objs */\
84 u8 type; /* acpi_object_type */\
85 u16 reference_count; /* For object deletion management */\
86 u8 flags;
87 /*
88 * Note: There are 3 bytes available here before the
89 * next natural alignment boundary (for both 32/64 cases)
90 */
91
92/* Values for Flag byte above */
93
94#define AOPOBJ_AML_CONSTANT 0x01
95#define AOPOBJ_STATIC_POINTER 0x02
96#define AOPOBJ_DATA_VALID 0x04
97#define AOPOBJ_OBJECT_INITIALIZED 0x08
98#define AOPOBJ_SETUP_COMPLETE 0x10
99#define AOPOBJ_SINGLE_DATUM 0x20
100#define AOPOBJ_INVALID 0x40 /* Used if host OS won't allow an op_region address */
101
102/******************************************************************************
103 *
104 * Basic data types
105 *
106 *****************************************************************************/
107
108struct acpi_object_common {
109ACPI_OBJECT_COMMON_HEADER};
110
111struct acpi_object_integer {
112 ACPI_OBJECT_COMMON_HEADER u8 fill[3]; /* Prevent warning on some compilers */
113 acpi_integer value;
114};
115
116/*
117 * Note: The String and Buffer object must be identical through the Pointer
118 * and length elements. There is code that depends on this.
119 *
120 * Fields common to both Strings and Buffers
121 */
122#define ACPI_COMMON_BUFFER_INFO(_type) \
123 _type *pointer; \
124 u32 length;
125
126struct acpi_object_string { /* Null terminated, ASCII characters only */
127 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_BUFFER_INFO(char) /* String in AML stream or allocated string */
128};
129
130struct acpi_object_buffer {
131 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_BUFFER_INFO(u8) /* Buffer in AML stream or allocated buffer */
132 u32 aml_length;
133 u8 *aml_start;
134 struct acpi_namespace_node *node; /* Link back to parent node */
135};
136
137struct acpi_object_package {
138 ACPI_OBJECT_COMMON_HEADER struct acpi_namespace_node *node; /* Link back to parent node */
139 union acpi_operand_object **elements; /* Array of pointers to acpi_objects */
140 u8 *aml_start;
141 u32 aml_length;
142 u32 count; /* # of elements in package */
143};
144
145/******************************************************************************
146 *
147 * Complex data types
148 *
149 *****************************************************************************/
150
151struct acpi_object_event {
152 ACPI_OBJECT_COMMON_HEADER acpi_semaphore os_semaphore; /* Actual OS synchronization object */
153};
154
155struct acpi_object_mutex {
156 ACPI_OBJECT_COMMON_HEADER u8 sync_level; /* 0-15, specified in Mutex() call */
157 u16 acquisition_depth; /* Allow multiple Acquires, same thread */
158 acpi_thread_id owner_thread_id; /* Current owner of the mutex */
159 acpi_mutex os_mutex; /* Actual OS synchronization object */
160 union acpi_operand_object *prev; /* Link for list of acquired mutexes */
161 union acpi_operand_object *next; /* Link for list of acquired mutexes */
162 struct acpi_namespace_node *node; /* Containing namespace node */
163 u8 original_sync_level; /* Owner's original sync level (0-15) */
164};
165
166struct acpi_object_region {
167 ACPI_OBJECT_COMMON_HEADER u8 space_id;
168 struct acpi_namespace_node *node; /* Containing namespace node */
169 union acpi_operand_object *handler; /* Handler for region access */
170 union acpi_operand_object *next;
171 acpi_physical_address address;
172 u32 length;
173};
174
175struct acpi_object_method {
176 ACPI_OBJECT_COMMON_HEADER u8 method_flags;
177 u8 param_count;
178 u8 sync_level;
179 union acpi_operand_object *mutex;
180 u8 *aml_start;
181 ACPI_INTERNAL_METHOD implementation;
182 u32 aml_length;
183 u8 thread_count;
184 acpi_owner_id owner_id;
185};
186
187/******************************************************************************
188 *
189 * Objects that can be notified. All share a common notify_info area.
190 *
191 *****************************************************************************/
192
193/*
194 * Common fields for objects that support ASL notifications
195 */
196#define ACPI_COMMON_NOTIFY_INFO \
197 union acpi_operand_object *system_notify; /* Handler for system notifies */\
198 union acpi_operand_object *device_notify; /* Handler for driver notifies */\
199 union acpi_operand_object *handler; /* Handler for Address space */
200
201struct acpi_object_notify_common { /* COMMON NOTIFY for POWER, PROCESSOR, DEVICE, and THERMAL */
202ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_NOTIFY_INFO};
203
204struct acpi_object_device {
205 ACPI_OBJECT_COMMON_HEADER
206 ACPI_COMMON_NOTIFY_INFO struct acpi_gpe_block_info *gpe_block;
207};
208
209struct acpi_object_power_resource {
210 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_NOTIFY_INFO u32 system_level;
211 u32 resource_order;
212};
213
214struct acpi_object_processor {
215 ACPI_OBJECT_COMMON_HEADER
216 /* The next two fields take advantage of the 3-byte space before NOTIFY_INFO */
217 u8 proc_id;
218 u8 length;
219 ACPI_COMMON_NOTIFY_INFO acpi_io_address address;
220};
221
222struct acpi_object_thermal_zone {
223ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_NOTIFY_INFO};
224
225/******************************************************************************
226 *
227 * Fields. All share a common header/info field.
228 *
229 *****************************************************************************/
230
231/*
232 * Common bitfield for the field objects
233 * "Field Datum" -- a datum from the actual field object
234 * "Buffer Datum" -- a datum from a user buffer, read from or to be written to the field
235 */
236#define ACPI_COMMON_FIELD_INFO \
237 u8 field_flags; /* Access, update, and lock bits */\
238 u8 attribute; /* From access_as keyword */\
239 u8 access_byte_width; /* Read/Write size in bytes */\
240 struct acpi_namespace_node *node; /* Link back to parent node */\
241 u32 bit_length; /* Length of field in bits */\
242 u32 base_byte_offset; /* Byte offset within containing object */\
243 u32 value; /* Value to store into the Bank or Index register */\
244 u8 start_field_bit_offset;/* Bit offset within first field datum (0-63) */\
245 u8 access_bit_width; /* Read/Write size in bits (8-64) */
246
247struct acpi_object_field_common { /* COMMON FIELD (for BUFFER, REGION, BANK, and INDEX fields) */
248 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO union acpi_operand_object *region_obj; /* Parent Operation Region object (REGION/BANK fields only) */
249};
250
251struct acpi_object_region_field {
252 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO union acpi_operand_object *region_obj; /* Containing op_region object */
253};
254
255struct acpi_object_bank_field {
256 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO union acpi_operand_object *region_obj; /* Containing op_region object */
257 union acpi_operand_object *bank_obj; /* bank_select Register object */
258};
259
260struct acpi_object_index_field {
261 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO
262 /*
263 * No "RegionObj" pointer needed since the Index and Data registers
264 * are each field definitions unto themselves.
265 */
266 union acpi_operand_object *index_obj; /* Index register */
267 union acpi_operand_object *data_obj; /* Data register */
268};
269
270/* The buffer_field is different in that it is part of a Buffer, not an op_region */
271
272struct acpi_object_buffer_field {
273 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO union acpi_operand_object *buffer_obj; /* Containing Buffer object */
274};
275
276/******************************************************************************
277 *
278 * Objects for handlers
279 *
280 *****************************************************************************/
281
282struct acpi_object_notify_handler {
283 ACPI_OBJECT_COMMON_HEADER struct acpi_namespace_node *node; /* Parent device */
284 acpi_notify_handler handler;
285 void *context;
286};
287
288struct acpi_object_addr_handler {
289 ACPI_OBJECT_COMMON_HEADER u8 space_id;
290 u8 handler_flags;
291 acpi_adr_space_handler handler;
292 struct acpi_namespace_node *node; /* Parent device */
293 void *context;
294 acpi_adr_space_setup setup;
295 union acpi_operand_object *region_list; /* regions using this handler */
296 union acpi_operand_object *next;
297};
298
299/* Flags for address handler (handler_flags) */
300
301#define ACPI_ADDR_HANDLER_DEFAULT_INSTALLED 0x01
302
303/******************************************************************************
304 *
305 * Special internal objects
306 *
307 *****************************************************************************/
308
309/*
310 * The Reference object type is used for these opcodes:
311 * Arg[0-6], Local[0-7], index_op, name_op, zero_op, one_op, ones_op, debug_op
312 */
313struct acpi_object_reference {
314 ACPI_OBJECT_COMMON_HEADER u8 target_type; /* Used for index_op */
315 u16 opcode;
316 void *object; /* name_op=>HANDLE to obj, index_op=>union acpi_operand_object */
317 struct acpi_namespace_node *node;
318 union acpi_operand_object **where;
319 u32 offset; /* Used for arg_op, local_op, and index_op */
320};
321
322/*
323 * Extra object is used as additional storage for types that
324 * have AML code in their declarations (term_args) that must be
325 * evaluated at run time.
326 *
327 * Currently: Region and field_unit types
328 */
329struct acpi_object_extra {
330 ACPI_OBJECT_COMMON_HEADER struct acpi_namespace_node *method_REG; /* _REG method for this region (if any) */
331 void *region_context; /* Region-specific data */
332 u8 *aml_start;
333 u32 aml_length;
334};
335
336/* Additional data that can be attached to namespace nodes */
337
338struct acpi_object_data {
339 ACPI_OBJECT_COMMON_HEADER acpi_object_handler handler;
340 void *pointer;
341};
342
343/* Structure used when objects are cached for reuse */
344
345struct acpi_object_cache_list {
346 ACPI_OBJECT_COMMON_HEADER union acpi_operand_object *next; /* Link for object cache and internal lists */
347};
348
349/******************************************************************************
350 *
351 * union acpi_operand_object Descriptor - a giant union of all of the above
352 *
353 *****************************************************************************/
354
355union acpi_operand_object {
356 struct acpi_object_common common;
357 struct acpi_object_integer integer;
358 struct acpi_object_string string;
359 struct acpi_object_buffer buffer;
360 struct acpi_object_package package;
361 struct acpi_object_event event;
362 struct acpi_object_method method;
363 struct acpi_object_mutex mutex;
364 struct acpi_object_region region;
365 struct acpi_object_notify_common common_notify;
366 struct acpi_object_device device;
367 struct acpi_object_power_resource power_resource;
368 struct acpi_object_processor processor;
369 struct acpi_object_thermal_zone thermal_zone;
370 struct acpi_object_field_common common_field;
371 struct acpi_object_region_field field;
372 struct acpi_object_buffer_field buffer_field;
373 struct acpi_object_bank_field bank_field;
374 struct acpi_object_index_field index_field;
375 struct acpi_object_notify_handler notify;
376 struct acpi_object_addr_handler address_space;
377 struct acpi_object_reference reference;
378 struct acpi_object_extra extra;
379 struct acpi_object_data data;
380 struct acpi_object_cache_list cache;
381};
382
383/******************************************************************************
384 *
385 * union acpi_descriptor - objects that share a common descriptor identifier
386 *
387 *****************************************************************************/
388
389/* Object descriptor types */
390
391#define ACPI_DESC_TYPE_CACHED 0x01 /* Used only when object is cached */
392#define ACPI_DESC_TYPE_STATE 0x02
393#define ACPI_DESC_TYPE_STATE_UPDATE 0x03
394#define ACPI_DESC_TYPE_STATE_PACKAGE 0x04
395#define ACPI_DESC_TYPE_STATE_CONTROL 0x05
396#define ACPI_DESC_TYPE_STATE_RPSCOPE 0x06
397#define ACPI_DESC_TYPE_STATE_PSCOPE 0x07
398#define ACPI_DESC_TYPE_STATE_WSCOPE 0x08
399#define ACPI_DESC_TYPE_STATE_RESULT 0x09
400#define ACPI_DESC_TYPE_STATE_NOTIFY 0x0A
401#define ACPI_DESC_TYPE_STATE_THREAD 0x0B
402#define ACPI_DESC_TYPE_WALK 0x0C
403#define ACPI_DESC_TYPE_PARSER 0x0D
404#define ACPI_DESC_TYPE_OPERAND 0x0E
405#define ACPI_DESC_TYPE_NAMED 0x0F
406#define ACPI_DESC_TYPE_MAX 0x0F
407
408struct acpi_common_descriptor {
409 void *common_pointer;
410 u8 descriptor_type; /* To differentiate various internal objs */
411};
412
413union acpi_descriptor {
414 struct acpi_common_descriptor common;
415 union acpi_operand_object object;
416 struct acpi_namespace_node node;
417 union acpi_parse_object op;
418};
419
420#pragma pack()
421
422#endif /* _ACOBJECT_H */