include/acpi/acinterp.h

   1 /******************************************************************************
   2  *
   3  * Name: acinterp.h - Interpreter subcomponent prototypes and defines
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2006, R. Byron Moore
   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 __ACINTERP_H__
  45 #define __ACINTERP_H__
  46
  47 #define ACPI_WALK_OPERANDS          (&(walk_state->operands [walk_state->num_operands -1]))
  48
  49 /* Macros for tables used for debug output */
  50
  51 #define ACPI_EXD_OFFSET(f)          (u8) ACPI_OFFSET (union acpi_operand_object,f)
  52 #define ACPI_EXD_NSOFFSET(f)        (u8) ACPI_OFFSET (struct acpi_namespace_node,f)
  53 #define ACPI_EXD_TABLE_SIZE(name)   (sizeof(name) / sizeof (struct acpi_exdump_info))
  54
  55 /*
  56  * If possible, pack the following structure to byte alignment, since we
  57  * don't care about performance for debug output
  58  */
  59 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
  60 #pragma pack(1)
  61 #endif
  62
  63 typedef const struct acpi_exdump_info {
  64         u8 opcode;
  65         u8 offset;
  66         char *name;
  67
  68 } acpi_exdump_info;
  69
  70 /* Values for the Opcode field above */
  71
  72 #define ACPI_EXD_INIT                   0
  73 #define ACPI_EXD_TYPE                   1
  74 #define ACPI_EXD_UINT8                  2
  75 #define ACPI_EXD_UINT16                 3
  76 #define ACPI_EXD_UINT32                 4
  77 #define ACPI_EXD_UINT64                 5
  78 #define ACPI_EXD_LITERAL                6
  79 #define ACPI_EXD_POINTER                7
  80 #define ACPI_EXD_ADDRESS                8
  81 #define ACPI_EXD_STRING                 9
  82 #define ACPI_EXD_BUFFER                 10
  83 #define ACPI_EXD_PACKAGE                11
  84 #define ACPI_EXD_FIELD                  12
  85 #define ACPI_EXD_REFERENCE              13
  86
  87 /* restore default alignment */
  88
  89 #pragma pack()
  90
  91 /*
  92  * exconvrt - object conversion
  93  */
  94 acpi_status
  95 acpi_ex_convert_to_integer(union acpi_operand_object *obj_desc,
  96                            union acpi_operand_object **result_desc, u32 flags);
  97
  98 acpi_status
  99 acpi_ex_convert_to_buffer(union acpi_operand_object *obj_desc,
 100                           union acpi_operand_object **result_desc);
 101
 102 acpi_status
 103 acpi_ex_convert_to_string(union acpi_operand_object *obj_desc,
 104                           union acpi_operand_object **result_desc, u32 type);
 105
 106 /* Types for ->String conversion */
 107
 108 #define ACPI_EXPLICIT_BYTE_COPY         0x00000000
 109 #define ACPI_EXPLICIT_CONVERT_HEX       0x00000001
 110 #define ACPI_IMPLICIT_CONVERT_HEX       0x00000002
 111 #define ACPI_EXPLICIT_CONVERT_DECIMAL   0x00000003
 112
 113 acpi_status
 114 acpi_ex_convert_to_target_type(acpi_object_type destination_type,
 115                                union acpi_operand_object *source_desc,
 116                                union acpi_operand_object **result_desc,
 117                                struct acpi_walk_state *walk_state);
 118
 119 /*
 120  * exfield - ACPI AML (p-code) execution - field manipulation
 121  */
 122 acpi_status
 123 acpi_ex_common_buffer_setup(union acpi_operand_object *obj_desc,
 124                             u32 buffer_length, u32 * datum_count);
 125
 126 acpi_status
 127 acpi_ex_write_with_update_rule(union acpi_operand_object *obj_desc,
 128                                acpi_integer mask,
 129                                acpi_integer field_value,
 130                                u32 field_datum_byte_offset);
 131
 132 void
 133 acpi_ex_get_buffer_datum(acpi_integer * datum,
 134                          void *buffer,
 135                          u32 buffer_length,
 136                          u32 byte_granularity, u32 buffer_offset);
 137
 138 void
 139 acpi_ex_set_buffer_datum(acpi_integer merged_datum,
 140                          void *buffer,
 141                          u32 buffer_length,
 142                          u32 byte_granularity, u32 buffer_offset);
 143
 144 acpi_status
 145 acpi_ex_read_data_from_field(struct acpi_walk_state *walk_state,
 146                              union acpi_operand_object *obj_desc,
 147                              union acpi_operand_object **ret_buffer_desc);
 148
 149 acpi_status
 150 acpi_ex_write_data_to_field(union acpi_operand_object *source_desc,
 151                             union acpi_operand_object *obj_desc,
 152                             union acpi_operand_object **result_desc);
 153
 154 /*
 155  * exfldio - low level field I/O
 156  */
 157 acpi_status
 158 acpi_ex_extract_from_field(union acpi_operand_object *obj_desc,
 159                            void *buffer, u32 buffer_length);
 160
 161 acpi_status
 162 acpi_ex_insert_into_field(union acpi_operand_object *obj_desc,
 163                           void *buffer, u32 buffer_length);
 164
 165 acpi_status
 166 acpi_ex_access_region(union acpi_operand_object *obj_desc,
 167                       u32 field_datum_byte_offset,
 168                       acpi_integer * value, u32 read_write);
 169
 170 /*
 171  * exmisc - misc support routines
 172  */
 173 acpi_status
 174 acpi_ex_get_object_reference(union acpi_operand_object *obj_desc,
 175                              union acpi_operand_object **return_desc,
 176                              struct acpi_walk_state *walk_state);
 177
 178 acpi_status
 179 acpi_ex_concat_template(union acpi_operand_object *obj_desc,
 180                         union acpi_operand_object *obj_desc2,
 181                         union acpi_operand_object **actual_return_desc,
 182                         struct acpi_walk_state *walk_state);
 183
 184 acpi_status
 185 acpi_ex_do_concatenate(union acpi_operand_object *obj_desc,
 186                        union acpi_operand_object *obj_desc2,
 187                        union acpi_operand_object **actual_return_desc,
 188                        struct acpi_walk_state *walk_state);
 189
 190 acpi_status
 191 acpi_ex_do_logical_numeric_op(u16 opcode,
 192                               acpi_integer integer0,
 193                               acpi_integer integer1, u8 * logical_result);
 194
 195 acpi_status
 196 acpi_ex_do_logical_op(u16 opcode,
 197                       union acpi_operand_object *operand0,
 198                       union acpi_operand_object *operand1, u8 * logical_result);
 199
 200 acpi_integer
 201 acpi_ex_do_math_op(u16 opcode, acpi_integer operand0, acpi_integer operand1);
 202
 203 acpi_status acpi_ex_create_mutex(struct acpi_walk_state *walk_state);
 204
 205 acpi_status acpi_ex_create_processor(struct acpi_walk_state *walk_state);
 206
 207 acpi_status acpi_ex_create_power_resource(struct acpi_walk_state *walk_state);
 208
 209 acpi_status
 210 acpi_ex_create_region(u8 * aml_start,
 211                       u32 aml_length,
 212                       u8 region_space, struct acpi_walk_state *walk_state);
 213
 214 acpi_status acpi_ex_create_table_region(struct acpi_walk_state *walk_state);
 215
 216 acpi_status acpi_ex_create_event(struct acpi_walk_state *walk_state);
 217
 218 acpi_status acpi_ex_create_alias(struct acpi_walk_state *walk_state);
 219
 220 acpi_status
 221 acpi_ex_create_method(u8 * aml_start,
 222                       u32 aml_length, struct acpi_walk_state *walk_state);
 223
 224 /*
 225  * exconfig - dynamic table load/unload
 226  */
 227 acpi_status
 228 acpi_ex_load_op(union acpi_operand_object *obj_desc,
 229                 union acpi_operand_object *target,
 230                 struct acpi_walk_state *walk_state);
 231
 232 acpi_status
 233 acpi_ex_load_table_op(struct acpi_walk_state *walk_state,
 234                       union acpi_operand_object **return_desc);
 235
 236 acpi_status acpi_ex_unload_table(union acpi_operand_object *ddb_handle);
 237
 238 /*
 239  * exmutex - mutex support
 240  */
 241 acpi_status
 242 acpi_ex_acquire_mutex(union acpi_operand_object *time_desc,
 243                       union acpi_operand_object *obj_desc,
 244                       struct acpi_walk_state *walk_state);
 245
 246 acpi_status
 247 acpi_ex_release_mutex(union acpi_operand_object *obj_desc,
 248                       struct acpi_walk_state *walk_state);
 249
 250 void acpi_ex_release_all_mutexes(struct acpi_thread_state *thread);
 251
 252 void acpi_ex_unlink_mutex(union acpi_operand_object *obj_desc);
 253
 254 /*
 255  * exprep - ACPI AML execution - prep utilities
 256  */
 257 acpi_status
 258 acpi_ex_prep_common_field_object(union acpi_operand_object *obj_desc,
 259                                  u8 field_flags,
 260                                  u8 field_attribute,
 261                                  u32 field_bit_position, u32 field_bit_length);
 262
 263 acpi_status acpi_ex_prep_field_value(struct acpi_create_field_info *info);
 264
 265 /*
 266  * exsystem - Interface to OS services
 267  */
 268 acpi_status
 269 acpi_ex_system_do_notify_op(union acpi_operand_object *value,
 270                             union acpi_operand_object *obj_desc);
 271
 272 acpi_status acpi_ex_system_do_suspend(acpi_integer time);
 273
 274 acpi_status acpi_ex_system_do_stall(u32 time);
 275
 276 acpi_status
 277 acpi_ex_system_acquire_mutex(union acpi_operand_object *time,
 278                              union acpi_operand_object *obj_desc);
 279
 280 acpi_status acpi_ex_system_release_mutex(union acpi_operand_object *obj_desc);
 281
 282 acpi_status acpi_ex_system_signal_event(union acpi_operand_object *obj_desc);
 283
 284 acpi_status
 285 acpi_ex_system_wait_event(union acpi_operand_object *time,
 286                           union acpi_operand_object *obj_desc);
 287
 288 acpi_status acpi_ex_system_reset_event(union acpi_operand_object *obj_desc);
 289
 290 acpi_status acpi_ex_system_wait_semaphore(acpi_handle semaphore, u16 timeout);
 291
 292 /*
 293  * exoparg1 - ACPI AML execution, 1 operand
 294  */
 295 acpi_status acpi_ex_opcode_0A_0T_1R(struct acpi_walk_state *walk_state);
 296
 297 acpi_status acpi_ex_opcode_1A_0T_0R(struct acpi_walk_state *walk_state);
 298
 299 acpi_status acpi_ex_opcode_1A_0T_1R(struct acpi_walk_state *walk_state);
 300
 301 acpi_status acpi_ex_opcode_1A_1T_1R(struct acpi_walk_state *walk_state);
 302
 303 acpi_status acpi_ex_opcode_1A_1T_0R(struct acpi_walk_state *walk_state);
 304
 305 /*
 306  * exoparg2 - ACPI AML execution, 2 operands
 307  */
 308 acpi_status acpi_ex_opcode_2A_0T_0R(struct acpi_walk_state *walk_state);
 309
 310 acpi_status acpi_ex_opcode_2A_0T_1R(struct acpi_walk_state *walk_state);
 311
 312 acpi_status acpi_ex_opcode_2A_1T_1R(struct acpi_walk_state *walk_state);
 313
 314 acpi_status acpi_ex_opcode_2A_2T_1R(struct acpi_walk_state *walk_state);
 315
 316 /*
 317  * exoparg3 - ACPI AML execution, 3 operands
 318  */
 319 acpi_status acpi_ex_opcode_3A_0T_0R(struct acpi_walk_state *walk_state);
 320
 321 acpi_status acpi_ex_opcode_3A_1T_1R(struct acpi_walk_state *walk_state);
 322
 323 /*
 324  * exoparg6 - ACPI AML execution, 6 operands
 325  */
 326 acpi_status acpi_ex_opcode_6A_0T_1R(struct acpi_walk_state *walk_state);
 327
 328 /*
 329  * exresolv - Object resolution and get value functions
 330  */
 331 acpi_status
 332 acpi_ex_resolve_to_value(union acpi_operand_object **stack_ptr,
 333                          struct acpi_walk_state *walk_state);
 334
 335 acpi_status
 336 acpi_ex_resolve_multiple(struct acpi_walk_state *walk_state,
 337                          union acpi_operand_object *operand,
 338                          acpi_object_type * return_type,
 339                          union acpi_operand_object **return_desc);
 340
 341 /*
 342  * exresnte - resolve namespace node
 343  */
 344 acpi_status
 345 acpi_ex_resolve_node_to_value(struct acpi_namespace_node **stack_ptr,
 346                               struct acpi_walk_state *walk_state);
 347
 348 /*
 349  * exresop - resolve operand to value
 350  */
 351 acpi_status
 352 acpi_ex_resolve_operands(u16 opcode,
 353                          union acpi_operand_object **stack_ptr,
 354                          struct acpi_walk_state *walk_state);
 355
 356 /*
 357  * exdump - Interpreter debug output routines
 358  */
 359 void acpi_ex_dump_operand(union acpi_operand_object *obj_desc, u32 depth);
 360
 361 void
 362 acpi_ex_dump_operands(union acpi_operand_object **operands,
 363                       acpi_interpreter_mode interpreter_mode,
 364                       char *ident,
 365                       u32 num_levels,
 366                       char *note, char *module_name, u32 line_number);
 367
 368 #ifdef  ACPI_FUTURE_USAGE
 369 void
 370 acpi_ex_dump_object_descriptor(union acpi_operand_object *object, u32 flags);
 371
 372 void acpi_ex_dump_namespace_node(struct acpi_namespace_node *node, u32 flags);
 373 #endif                          /* ACPI_FUTURE_USAGE */
 374
 375 /*
 376  * exnames - AML namestring support
 377  */
 378 acpi_status
 379 acpi_ex_get_name_string(acpi_object_type data_type,
 380                         u8 * in_aml_address,
 381                         char **out_name_string, u32 * out_name_length);
 382
 383 /*
 384  * exstore - Object store support
 385  */
 386 acpi_status
 387 acpi_ex_store(union acpi_operand_object *val_desc,
 388               union acpi_operand_object *dest_desc,
 389               struct acpi_walk_state *walk_state);
 390
 391 acpi_status
 392 acpi_ex_store_object_to_node(union acpi_operand_object *source_desc,
 393                              struct acpi_namespace_node *node,
 394                              struct acpi_walk_state *walk_state,
 395                              u8 implicit_conversion);
 396
 397 #define ACPI_IMPLICIT_CONVERSION        TRUE
 398 #define ACPI_NO_IMPLICIT_CONVERSION     FALSE
 399
 400 /*
 401  * exstoren - resolve/store object
 402  */
 403 acpi_status
 404 acpi_ex_resolve_object(union acpi_operand_object **source_desc_ptr,
 405                        acpi_object_type target_type,
 406                        struct acpi_walk_state *walk_state);
 407
 408 acpi_status
 409 acpi_ex_store_object_to_object(union acpi_operand_object *source_desc,
 410                                union acpi_operand_object *dest_desc,
 411                                union acpi_operand_object **new_desc,
 412                                struct acpi_walk_state *walk_state);
 413
 414 /*
 415  * exstorob - store object - buffer/string
 416  */
 417 acpi_status
 418 acpi_ex_store_buffer_to_buffer(union acpi_operand_object *source_desc,
 419                                union acpi_operand_object *target_desc);
 420
 421 acpi_status
 422 acpi_ex_store_string_to_string(union acpi_operand_object *source_desc,
 423                                union acpi_operand_object *target_desc);
 424
 425 /*
 426  * excopy - object copy
 427  */
 428 acpi_status
 429 acpi_ex_copy_integer_to_index_field(union acpi_operand_object *source_desc,
 430                                     union acpi_operand_object *target_desc);
 431
 432 acpi_status
 433 acpi_ex_copy_integer_to_bank_field(union acpi_operand_object *source_desc,
 434                                    union acpi_operand_object *target_desc);
 435
 436 acpi_status
 437 acpi_ex_copy_data_to_named_field(union acpi_operand_object *source_desc,
 438                                  struct acpi_namespace_node *node);
 439
 440 acpi_status
 441 acpi_ex_copy_integer_to_buffer_field(union acpi_operand_object *source_desc,
 442                                      union acpi_operand_object *target_desc);
 443
 444 /*
 445  * exutils - interpreter/scanner utilities
 446  */
 447 acpi_status acpi_ex_enter_interpreter(void);
 448
 449 void acpi_ex_exit_interpreter(void);
 450
 451 void acpi_ex_truncate_for32bit_table(union acpi_operand_object *obj_desc);
 452
 453 u8 acpi_ex_acquire_global_lock(u32 rule);
 454
 455 void acpi_ex_release_global_lock(u8 locked);
 456
 457 void acpi_ex_eisa_id_to_string(u32 numeric_id, char *out_string);
 458
 459 void acpi_ex_unsigned_integer_to_string(acpi_integer value, char *out_string);
 460
 461 /*
 462  * exregion - default op_region handlers
 463  */
 464 acpi_status
 465 acpi_ex_system_memory_space_handler(u32 function,
 466                                     acpi_physical_address address,
 467                                     u32 bit_width,
 468                                     acpi_integer * value,
 469                                     void *handler_context,
 470                                     void *region_context);
 471
 472 acpi_status
 473 acpi_ex_system_io_space_handler(u32 function,
 474                                 acpi_physical_address address,
 475                                 u32 bit_width,
 476                                 acpi_integer * value,
 477                                 void *handler_context, void *region_context);
 478
 479 acpi_status
 480 acpi_ex_pci_config_space_handler(u32 function,
 481                                  acpi_physical_address address,
 482                                  u32 bit_width,
 483                                  acpi_integer * value,
 484                                  void *handler_context, void *region_context);
 485
 486 acpi_status
 487 acpi_ex_cmos_space_handler(u32 function,
 488                            acpi_physical_address address,
 489                            u32 bit_width,
 490                            acpi_integer * value,
 491                            void *handler_context, void *region_context);
 492
 493 acpi_status
 494 acpi_ex_pci_bar_space_handler(u32 function,
 495                               acpi_physical_address address,
 496                               u32 bit_width,
 497                               acpi_integer * value,
 498                               void *handler_context, void *region_context);
 499
 500 acpi_status
 501 acpi_ex_embedded_controller_space_handler(u32 function,
 502                                           acpi_physical_address address,
 503                                           u32 bit_width,
 504                                           acpi_integer * value,
 505                                           void *handler_context,
 506                                           void *region_context);
 507
 508 acpi_status
 509 acpi_ex_sm_bus_space_handler(u32 function,
 510                              acpi_physical_address address,
 511                              u32 bit_width,
 512                              acpi_integer * value,
 513                              void *handler_context, void *region_context);
 514
 515 acpi_status
 516 acpi_ex_data_table_space_handler(u32 function,
 517                                  acpi_physical_address address,
 518                                  u32 bit_width,
 519                                  acpi_integer * value,
 520                                  void *handler_context, void *region_context);
 521
 522 #endif                          /* __INTERP_H__ */