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