1 2 /****************************************************************************** 3 * 4 * Name: acobject.h - Definition of union acpi_operand_object (Internal object only) 5 * 6 *****************************************************************************/ 7 8 /* 9 * Copyright (C) 2000 - 2008, Intel Corp. 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 #define AOPOBJ_MODULE_LEVEL 0x80 102 103 /****************************************************************************** 104 * 105 * Basic data types 106 * 107 *****************************************************************************/ 108 109 struct acpi_object_common { 110 ACPI_OBJECT_COMMON_HEADER}; 111 112 struct acpi_object_integer { 113 ACPI_OBJECT_COMMON_HEADER u8 fill[3]; /* Prevent warning on some compilers */ 114 acpi_integer value; 115 }; 116 117 /* 118 * Note: The String and Buffer object must be identical through the Pointer 119 * and length elements. There is code that depends on this. 120 * 121 * Fields common to both Strings and Buffers 122 */ 123 #define ACPI_COMMON_BUFFER_INFO(_type) \ 124 _type *pointer; \ 125 u32 length; 126 127 struct acpi_object_string { /* Null terminated, ASCII characters only */ 128 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_BUFFER_INFO(char) /* String in AML stream or allocated string */ 129 }; 130 131 struct acpi_object_buffer { 132 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_BUFFER_INFO(u8) /* Buffer in AML stream or allocated buffer */ 133 u32 aml_length; 134 u8 *aml_start; 135 struct acpi_namespace_node *node; /* Link back to parent node */ 136 }; 137 138 struct acpi_object_package { 139 ACPI_OBJECT_COMMON_HEADER struct acpi_namespace_node *node; /* Link back to parent node */ 140 union acpi_operand_object **elements; /* Array of pointers to acpi_objects */ 141 u8 *aml_start; 142 u32 aml_length; 143 u32 count; /* # of elements in package */ 144 }; 145 146 /****************************************************************************** 147 * 148 * Complex data types 149 * 150 *****************************************************************************/ 151 152 struct acpi_object_event { 153 ACPI_OBJECT_COMMON_HEADER acpi_semaphore os_semaphore; /* Actual OS synchronization object */ 154 }; 155 156 struct acpi_object_mutex { 157 ACPI_OBJECT_COMMON_HEADER u8 sync_level; /* 0-15, specified in Mutex() call */ 158 u16 acquisition_depth; /* Allow multiple Acquires, same thread */ 159 acpi_mutex os_mutex; /* Actual OS synchronization object */ 160 acpi_thread_id thread_id; /* Current owner of the mutex */ 161 struct acpi_thread_state *owner_thread; /* Current owner of the mutex */ 162 union acpi_operand_object *prev; /* Link for list of acquired mutexes */ 163 union acpi_operand_object *next; /* Link for list of acquired mutexes */ 164 struct acpi_namespace_node *node; /* Containing namespace node */ 165 u8 original_sync_level; /* Owner's original sync level (0-15) */ 166 }; 167 168 struct acpi_object_region { 169 ACPI_OBJECT_COMMON_HEADER u8 space_id; 170 struct acpi_namespace_node *node; /* Containing namespace node */ 171 union acpi_operand_object *handler; /* Handler for region access */ 172 union acpi_operand_object *next; 173 acpi_physical_address address; 174 u32 length; 175 }; 176 177 struct acpi_object_method { 178 ACPI_OBJECT_COMMON_HEADER u8 method_flags; 179 u8 param_count; 180 u8 sync_level; 181 union acpi_operand_object *mutex; 182 u8 *aml_start; 183 ACPI_INTERNAL_METHOD implementation; 184 u32 aml_length; 185 u8 thread_count; 186 acpi_owner_id owner_id; 187 }; 188 189 /****************************************************************************** 190 * 191 * Objects that can be notified. All share a common notify_info area. 192 * 193 *****************************************************************************/ 194 195 /* 196 * Common fields for objects that support ASL notifications 197 */ 198 #define ACPI_COMMON_NOTIFY_INFO \ 199 union acpi_operand_object *system_notify; /* Handler for system notifies */\ 200 union acpi_operand_object *device_notify; /* Handler for driver notifies */\ 201 union acpi_operand_object *handler; /* Handler for Address space */ 202 203 struct acpi_object_notify_common { /* COMMON NOTIFY for POWER, PROCESSOR, DEVICE, and THERMAL */ 204 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_NOTIFY_INFO}; 205 206 struct acpi_object_device { 207 ACPI_OBJECT_COMMON_HEADER 208 ACPI_COMMON_NOTIFY_INFO struct acpi_gpe_block_info *gpe_block; 209 }; 210 211 struct acpi_object_power_resource { 212 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_NOTIFY_INFO u32 system_level; 213 u32 resource_order; 214 }; 215 216 struct acpi_object_processor { 217 ACPI_OBJECT_COMMON_HEADER 218 /* The next two fields take advantage of the 3-byte space before NOTIFY_INFO */ 219 u8 proc_id; 220 u8 length; 221 ACPI_COMMON_NOTIFY_INFO acpi_io_address address; 222 }; 223 224 struct acpi_object_thermal_zone { 225 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_NOTIFY_INFO}; 226 227 /****************************************************************************** 228 * 229 * Fields. All share a common header/info field. 230 * 231 *****************************************************************************/ 232 233 /* 234 * Common bitfield for the field objects 235 * "Field Datum" -- a datum from the actual field object 236 * "Buffer Datum" -- a datum from a user buffer, read from or to be written to the field 237 */ 238 #define ACPI_COMMON_FIELD_INFO \ 239 u8 field_flags; /* Access, update, and lock bits */\ 240 u8 attribute; /* From access_as keyword */\ 241 u8 access_byte_width; /* Read/Write size in bytes */\ 242 struct acpi_namespace_node *node; /* Link back to parent node */\ 243 u32 bit_length; /* Length of field in bits */\ 244 u32 base_byte_offset; /* Byte offset within containing object */\ 245 u32 value; /* Value to store into the Bank or Index register */\ 246 u8 start_field_bit_offset;/* Bit offset within first field datum (0-63) */\ 247 u8 access_bit_width; /* Read/Write size in bits (8-64) */ 248 249 struct acpi_object_field_common { /* COMMON FIELD (for BUFFER, REGION, BANK, and INDEX fields) */ 250 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO union acpi_operand_object *region_obj; /* Parent Operation Region object (REGION/BANK fields only) */ 251 }; 252 253 struct acpi_object_region_field { 254 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO union acpi_operand_object *region_obj; /* Containing op_region object */ 255 }; 256 257 struct acpi_object_bank_field { 258 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO union acpi_operand_object *region_obj; /* Containing op_region object */ 259 union acpi_operand_object *bank_obj; /* bank_select Register object */ 260 }; 261 262 struct acpi_object_index_field { 263 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO 264 /* 265 * No "RegionObj" pointer needed since the Index and Data registers 266 * are each field definitions unto themselves. 267 */ 268 union acpi_operand_object *index_obj; /* Index register */ 269 union acpi_operand_object *data_obj; /* Data register */ 270 }; 271 272 /* The buffer_field is different in that it is part of a Buffer, not an op_region */ 273 274 struct acpi_object_buffer_field { 275 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO union acpi_operand_object *buffer_obj; /* Containing Buffer object */ 276 }; 277 278 /****************************************************************************** 279 * 280 * Objects for handlers 281 * 282 *****************************************************************************/ 283 284 struct acpi_object_notify_handler { 285 ACPI_OBJECT_COMMON_HEADER struct acpi_namespace_node *node; /* Parent device */ 286 acpi_notify_handler handler; 287 void *context; 288 }; 289 290 struct acpi_object_addr_handler { 291 ACPI_OBJECT_COMMON_HEADER u8 space_id; 292 u8 handler_flags; 293 acpi_adr_space_handler handler; 294 struct acpi_namespace_node *node; /* Parent device */ 295 void *context; 296 acpi_adr_space_setup setup; 297 union acpi_operand_object *region_list; /* regions using this handler */ 298 union acpi_operand_object *next; 299 }; 300 301 /* Flags for address handler (handler_flags) */ 302 303 #define ACPI_ADDR_HANDLER_DEFAULT_INSTALLED 0x01 304 305 /****************************************************************************** 306 * 307 * Special internal objects 308 * 309 *****************************************************************************/ 310 311 /* 312 * The Reference object is used for these opcodes: 313 * Arg[0-6], Local[0-7], index_op, name_op, ref_of_op, load_op, load_table_op, debug_op 314 * The Reference.Class differentiates these types. 315 */ 316 struct acpi_object_reference { 317 ACPI_OBJECT_COMMON_HEADER u8 class; /* Reference Class */ 318 u8 target_type; /* Used for Index Op */ 319 u8 reserved; 320 void *object; /* name_op=>HANDLE to obj, index_op=>union acpi_operand_object */ 321 struct acpi_namespace_node *node; /* ref_of or Namepath */ 322 union acpi_operand_object **where; /* Target of Index */ 323 u32 value; /* Used for Local/Arg/Index/ddb_handle */ 324 }; 325 326 /* Values for Reference.Class above */ 327 328 typedef enum { 329 ACPI_REFCLASS_LOCAL = 0, /* Method local */ 330 ACPI_REFCLASS_ARG = 1, /* Method argument */ 331 ACPI_REFCLASS_REFOF = 2, /* Result of ref_of() TBD: Split to Ref/Node and Ref/operand_obj? */ 332 ACPI_REFCLASS_INDEX = 3, /* Result of Index() */ 333 ACPI_REFCLASS_TABLE = 4, /* ddb_handle - Load(), load_table() */ 334 ACPI_REFCLASS_NAME = 5, /* Reference to a named object */ 335 ACPI_REFCLASS_DEBUG = 6, /* Debug object */ 336 337 ACPI_REFCLASS_MAX = 6 338 } ACPI_REFERENCE_CLASSES; 339 340 /* 341 * Extra object is used as additional storage for types that 342 * have AML code in their declarations (term_args) that must be 343 * evaluated at run time. 344 * 345 * Currently: Region and field_unit types 346 */ 347 struct acpi_object_extra { 348 ACPI_OBJECT_COMMON_HEADER struct acpi_namespace_node *method_REG; /* _REG method for this region (if any) */ 349 void *region_context; /* Region-specific data */ 350 u8 *aml_start; 351 u32 aml_length; 352 }; 353 354 /* Additional data that can be attached to namespace nodes */ 355 356 struct acpi_object_data { 357 ACPI_OBJECT_COMMON_HEADER acpi_object_handler handler; 358 void *pointer; 359 }; 360 361 /* Structure used when objects are cached for reuse */ 362 363 struct acpi_object_cache_list { 364 ACPI_OBJECT_COMMON_HEADER union acpi_operand_object *next; /* Link for object cache and internal lists */ 365 }; 366 367 /****************************************************************************** 368 * 369 * union acpi_operand_object Descriptor - a giant union of all of the above 370 * 371 *****************************************************************************/ 372 373 union acpi_operand_object { 374 struct acpi_object_common common; 375 struct acpi_object_integer integer; 376 struct acpi_object_string string; 377 struct acpi_object_buffer buffer; 378 struct acpi_object_package package; 379 struct acpi_object_event event; 380 struct acpi_object_method method; 381 struct acpi_object_mutex mutex; 382 struct acpi_object_region region; 383 struct acpi_object_notify_common common_notify; 384 struct acpi_object_device device; 385 struct acpi_object_power_resource power_resource; 386 struct acpi_object_processor processor; 387 struct acpi_object_thermal_zone thermal_zone; 388 struct acpi_object_field_common common_field; 389 struct acpi_object_region_field field; 390 struct acpi_object_buffer_field buffer_field; 391 struct acpi_object_bank_field bank_field; 392 struct acpi_object_index_field index_field; 393 struct acpi_object_notify_handler notify; 394 struct acpi_object_addr_handler address_space; 395 struct acpi_object_reference reference; 396 struct acpi_object_extra extra; 397 struct acpi_object_data data; 398 struct acpi_object_cache_list cache; 399 400 /* 401 * Add namespace node to union in order to simplify code that accepts both 402 * ACPI_OPERAND_OBJECTs and ACPI_NAMESPACE_NODEs. The structures share 403 * a common descriptor_type field in order to differentiate them. 404 */ 405 struct acpi_namespace_node node; 406 }; 407 408 /****************************************************************************** 409 * 410 * union acpi_descriptor - objects that share a common descriptor identifier 411 * 412 *****************************************************************************/ 413 414 /* Object descriptor types */ 415 416 #define ACPI_DESC_TYPE_CACHED 0x01 /* Used only when object is cached */ 417 #define ACPI_DESC_TYPE_STATE 0x02 418 #define ACPI_DESC_TYPE_STATE_UPDATE 0x03 419 #define ACPI_DESC_TYPE_STATE_PACKAGE 0x04 420 #define ACPI_DESC_TYPE_STATE_CONTROL 0x05 421 #define ACPI_DESC_TYPE_STATE_RPSCOPE 0x06 422 #define ACPI_DESC_TYPE_STATE_PSCOPE 0x07 423 #define ACPI_DESC_TYPE_STATE_WSCOPE 0x08 424 #define ACPI_DESC_TYPE_STATE_RESULT 0x09 425 #define ACPI_DESC_TYPE_STATE_NOTIFY 0x0A 426 #define ACPI_DESC_TYPE_STATE_THREAD 0x0B 427 #define ACPI_DESC_TYPE_WALK 0x0C 428 #define ACPI_DESC_TYPE_PARSER 0x0D 429 #define ACPI_DESC_TYPE_OPERAND 0x0E 430 #define ACPI_DESC_TYPE_NAMED 0x0F 431 #define ACPI_DESC_TYPE_MAX 0x0F 432 433 struct acpi_common_descriptor { 434 void *common_pointer; 435 u8 descriptor_type; /* To differentiate various internal objs */ 436 }; 437 438 union acpi_descriptor { 439 struct acpi_common_descriptor common; 440 union acpi_operand_object object; 441 struct acpi_namespace_node node; 442 union acpi_parse_object op; 443 }; 444 445 #pragma pack() 446 447 #endif /* _ACOBJECT_H */ 448