1 /****************************************************************************** 2 * 3 * Name: acobject.h - Definition of union acpi_operand_object (Internal object only) 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2017, 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 /* Null terminated, ASCII characters only */ 126 127 struct acpi_object_string { 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 info_flags; 179 u8 param_count; 180 u8 sync_level; 181 union acpi_operand_object *mutex; 182 union acpi_operand_object *node; 183 u8 *aml_start; 184 union { 185 acpi_internal_method implementation; 186 union acpi_operand_object *handler; 187 } dispatch; 188 189 u32 aml_length; 190 u8 thread_count; 191 acpi_owner_id owner_id; 192 }; 193 194 /* Flags for info_flags field above */ 195 196 #define ACPI_METHOD_MODULE_LEVEL 0x01 /* Method is actually module-level code */ 197 #define ACPI_METHOD_INTERNAL_ONLY 0x02 /* Method is implemented internally (_OSI) */ 198 #define ACPI_METHOD_SERIALIZED 0x04 /* Method is serialized */ 199 #define ACPI_METHOD_SERIALIZED_PENDING 0x08 /* Method is to be marked serialized */ 200 #define ACPI_METHOD_IGNORE_SYNC_LEVEL 0x10 /* Method was auto-serialized at table load time */ 201 #define ACPI_METHOD_MODIFIED_NAMESPACE 0x20 /* Method modified the namespace */ 202 203 /****************************************************************************** 204 * 205 * Objects that can be notified. All share a common notify_info area. 206 * 207 *****************************************************************************/ 208 209 /* 210 * Common fields for objects that support ASL notifications 211 */ 212 #define ACPI_COMMON_NOTIFY_INFO \ 213 union acpi_operand_object *notify_list[2]; /* Handlers for system/device notifies */\ 214 union acpi_operand_object *handler; /* Handler for Address space */ 215 216 /* COMMON NOTIFY for POWER, PROCESSOR, DEVICE, and THERMAL */ 217 218 struct acpi_object_notify_common { 219 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_NOTIFY_INFO}; 220 221 struct acpi_object_device { 222 ACPI_OBJECT_COMMON_HEADER 223 ACPI_COMMON_NOTIFY_INFO struct acpi_gpe_block_info *gpe_block; 224 }; 225 226 struct acpi_object_power_resource { 227 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_NOTIFY_INFO u32 system_level; 228 u32 resource_order; 229 }; 230 231 struct acpi_object_processor { 232 ACPI_OBJECT_COMMON_HEADER 233 /* The next two fields take advantage of the 3-byte space before NOTIFY_INFO */ 234 u8 proc_id; 235 u8 length; 236 ACPI_COMMON_NOTIFY_INFO acpi_io_address address; 237 }; 238 239 struct acpi_object_thermal_zone { 240 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_NOTIFY_INFO}; 241 242 /****************************************************************************** 243 * 244 * Fields. All share a common header/info field. 245 * 246 *****************************************************************************/ 247 248 /* 249 * Common bitfield for the field objects 250 * "Field Datum" -- a datum from the actual field object 251 * "Buffer Datum" -- a datum from a user buffer, read from or to be written to the field 252 */ 253 #define ACPI_COMMON_FIELD_INFO \ 254 u8 field_flags; /* Access, update, and lock bits */\ 255 u8 attribute; /* From access_as keyword */\ 256 u8 access_byte_width; /* Read/Write size in bytes */\ 257 struct acpi_namespace_node *node; /* Link back to parent node */\ 258 u32 bit_length; /* Length of field in bits */\ 259 u32 base_byte_offset; /* Byte offset within containing object */\ 260 u32 value; /* Value to store into the Bank or Index register */\ 261 u8 start_field_bit_offset;/* Bit offset within first field datum (0-63) */\ 262 u8 access_length; /* For serial regions/fields */ 263 264 265 /* COMMON FIELD (for BUFFER, REGION, BANK, and INDEX fields) */ 266 267 struct acpi_object_field_common { 268 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO union acpi_operand_object *region_obj; /* Parent Operation Region object (REGION/BANK fields only) */ 269 }; 270 271 struct acpi_object_region_field { 272 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO u16 resource_length; 273 union acpi_operand_object *region_obj; /* Containing op_region object */ 274 u8 *resource_buffer; /* resource_template for serial regions/fields */ 275 u16 pin_number_index; /* Index relative to previous Connection/Template */ 276 }; 277 278 struct acpi_object_bank_field { 279 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO union acpi_operand_object *region_obj; /* Containing op_region object */ 280 union acpi_operand_object *bank_obj; /* bank_select Register object */ 281 }; 282 283 struct acpi_object_index_field { 284 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO 285 /* 286 * No "RegionObj" pointer needed since the Index and Data registers 287 * are each field definitions unto themselves. 288 */ 289 union acpi_operand_object *index_obj; /* Index register */ 290 union acpi_operand_object *data_obj; /* Data register */ 291 }; 292 293 /* The buffer_field is different in that it is part of a Buffer, not an op_region */ 294 295 struct acpi_object_buffer_field { 296 ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO union acpi_operand_object *buffer_obj; /* Containing Buffer object */ 297 }; 298 299 /****************************************************************************** 300 * 301 * Objects for handlers 302 * 303 *****************************************************************************/ 304 305 struct acpi_object_notify_handler { 306 ACPI_OBJECT_COMMON_HEADER struct acpi_namespace_node *node; /* Parent device */ 307 u32 handler_type; /* Type: Device/System/Both */ 308 acpi_notify_handler handler; /* Handler address */ 309 void *context; 310 union acpi_operand_object *next[2]; /* Device and System handler lists */ 311 }; 312 313 struct acpi_object_addr_handler { 314 ACPI_OBJECT_COMMON_HEADER u8 space_id; 315 u8 handler_flags; 316 acpi_adr_space_handler handler; 317 struct acpi_namespace_node *node; /* Parent device */ 318 void *context; 319 acpi_adr_space_setup setup; 320 union acpi_operand_object *region_list; /* Regions using this handler */ 321 union acpi_operand_object *next; 322 }; 323 324 /* Flags for address handler (handler_flags) */ 325 326 #define ACPI_ADDR_HANDLER_DEFAULT_INSTALLED 0x01 327 328 /****************************************************************************** 329 * 330 * Special internal objects 331 * 332 *****************************************************************************/ 333 334 /* 335 * The Reference object is used for these opcodes: 336 * Arg[0-6], Local[0-7], index_op, name_op, ref_of_op, load_op, load_table_op, debug_op 337 * The Reference.Class differentiates these types. 338 */ 339 struct acpi_object_reference { 340 ACPI_OBJECT_COMMON_HEADER u8 class; /* Reference Class */ 341 u8 target_type; /* Used for Index Op */ 342 u8 resolved; /* Reference has been resolved to a value */ 343 void *object; /* name_op=>HANDLE to obj, index_op=>union acpi_operand_object */ 344 struct acpi_namespace_node *node; /* ref_of or Namepath */ 345 union acpi_operand_object **where; /* Target of Index */ 346 u8 *index_pointer; /* Used for Buffers and Strings */ 347 u8 *aml; /* Used for deferred resolution of the ref */ 348 u32 value; /* Used for Local/Arg/Index/ddb_handle */ 349 }; 350 351 /* Values for Reference.Class above */ 352 353 typedef enum { 354 ACPI_REFCLASS_LOCAL = 0, /* Method local */ 355 ACPI_REFCLASS_ARG = 1, /* Method argument */ 356 ACPI_REFCLASS_REFOF = 2, /* Result of ref_of() TBD: Split to Ref/Node and Ref/operand_obj? */ 357 ACPI_REFCLASS_INDEX = 3, /* Result of Index() */ 358 ACPI_REFCLASS_TABLE = 4, /* ddb_handle - Load(), load_table() */ 359 ACPI_REFCLASS_NAME = 5, /* Reference to a named object */ 360 ACPI_REFCLASS_DEBUG = 6, /* Debug object */ 361 362 ACPI_REFCLASS_MAX = 6 363 } ACPI_REFERENCE_CLASSES; 364 365 /* 366 * Extra object is used as additional storage for types that 367 * have AML code in their declarations (term_args) that must be 368 * evaluated at run time. 369 * 370 * Currently: Region and field_unit types 371 */ 372 struct acpi_object_extra { 373 ACPI_OBJECT_COMMON_HEADER struct acpi_namespace_node *method_REG; /* _REG method for this region (if any) */ 374 struct acpi_namespace_node *scope_node; 375 void *region_context; /* Region-specific data */ 376 u8 *aml_start; 377 u32 aml_length; 378 }; 379 380 /* Additional data that can be attached to namespace nodes */ 381 382 struct acpi_object_data { 383 ACPI_OBJECT_COMMON_HEADER acpi_object_handler handler; 384 void *pointer; 385 }; 386 387 /* Structure used when objects are cached for reuse */ 388 389 struct acpi_object_cache_list { 390 ACPI_OBJECT_COMMON_HEADER union acpi_operand_object *next; /* Link for object cache and internal lists */ 391 }; 392 393 /****************************************************************************** 394 * 395 * union acpi_operand_object descriptor - a giant union of all of the above 396 * 397 *****************************************************************************/ 398 399 union acpi_operand_object { 400 struct acpi_object_common common; 401 struct acpi_object_integer integer; 402 struct acpi_object_string string; 403 struct acpi_object_buffer buffer; 404 struct acpi_object_package package; 405 struct acpi_object_event event; 406 struct acpi_object_method method; 407 struct acpi_object_mutex mutex; 408 struct acpi_object_region region; 409 struct acpi_object_notify_common common_notify; 410 struct acpi_object_device device; 411 struct acpi_object_power_resource power_resource; 412 struct acpi_object_processor processor; 413 struct acpi_object_thermal_zone thermal_zone; 414 struct acpi_object_field_common common_field; 415 struct acpi_object_region_field field; 416 struct acpi_object_buffer_field buffer_field; 417 struct acpi_object_bank_field bank_field; 418 struct acpi_object_index_field index_field; 419 struct acpi_object_notify_handler notify; 420 struct acpi_object_addr_handler address_space; 421 struct acpi_object_reference reference; 422 struct acpi_object_extra extra; 423 struct acpi_object_data data; 424 struct acpi_object_cache_list cache; 425 426 /* 427 * Add namespace node to union in order to simplify code that accepts both 428 * ACPI_OPERAND_OBJECTs and ACPI_NAMESPACE_NODEs. The structures share 429 * a common descriptor_type field in order to differentiate them. 430 */ 431 struct acpi_namespace_node node; 432 }; 433 434 /****************************************************************************** 435 * 436 * union acpi_descriptor - objects that share a common descriptor identifier 437 * 438 *****************************************************************************/ 439 440 /* Object descriptor types */ 441 442 #define ACPI_DESC_TYPE_CACHED 0x01 /* Used only when object is cached */ 443 #define ACPI_DESC_TYPE_STATE 0x02 444 #define ACPI_DESC_TYPE_STATE_UPDATE 0x03 445 #define ACPI_DESC_TYPE_STATE_PACKAGE 0x04 446 #define ACPI_DESC_TYPE_STATE_CONTROL 0x05 447 #define ACPI_DESC_TYPE_STATE_RPSCOPE 0x06 448 #define ACPI_DESC_TYPE_STATE_PSCOPE 0x07 449 #define ACPI_DESC_TYPE_STATE_WSCOPE 0x08 450 #define ACPI_DESC_TYPE_STATE_RESULT 0x09 451 #define ACPI_DESC_TYPE_STATE_NOTIFY 0x0A 452 #define ACPI_DESC_TYPE_STATE_THREAD 0x0B 453 #define ACPI_DESC_TYPE_WALK 0x0C 454 #define ACPI_DESC_TYPE_PARSER 0x0D 455 #define ACPI_DESC_TYPE_OPERAND 0x0E 456 #define ACPI_DESC_TYPE_NAMED 0x0F 457 #define ACPI_DESC_TYPE_MAX 0x0F 458 459 struct acpi_common_descriptor { 460 void *common_pointer; 461 u8 descriptor_type; /* To differentiate various internal objs */ 462 }; 463 464 union acpi_descriptor { 465 struct acpi_common_descriptor common; 466 union acpi_operand_object object; 467 struct acpi_namespace_node node; 468 union acpi_parse_object op; 469 }; 470 471 #pragma pack() 472 473 #endif /* _ACOBJECT_H */ 474