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