include/acpi/acobject.h

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