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