include/acpi/acinterp.h

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