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