drivers/acpi/acpica/acinterp.h

   1 /******************************************************************************
   2  *
   3  * Name: acinterp.h - Interpreter subcomponent prototypes and defines
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2010, Intel Corp.
   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                                u64 mask,
 133                                u64 field_value, u32 field_datum_byte_offset);
 134
 135 void
 136 acpi_ex_get_buffer_datum(u64 *datum,
 137                          void *buffer,
 138                          u32 buffer_length,
 139                          u32 byte_granularity, u32 buffer_offset);
 140
 141 void
 142 acpi_ex_set_buffer_datum(u64 merged_datum,
 143                          void *buffer,
 144                          u32 buffer_length,
 145                          u32 byte_granularity, u32 buffer_offset);
 146
 147 acpi_status
 148 acpi_ex_read_data_from_field(struct acpi_walk_state *walk_state,
 149                              union acpi_operand_object *obj_desc,
 150                              union acpi_operand_object **ret_buffer_desc);
 151
 152 acpi_status
 153 acpi_ex_write_data_to_field(union acpi_operand_object *source_desc,
 154                             union acpi_operand_object *obj_desc,
 155                             union acpi_operand_object **result_desc);
 156
 157 /*
 158  * exfldio - low level field I/O
 159  */
 160 acpi_status
 161 acpi_ex_extract_from_field(union acpi_operand_object *obj_desc,
 162                            void *buffer, u32 buffer_length);
 163
 164 acpi_status
 165 acpi_ex_insert_into_field(union acpi_operand_object *obj_desc,
 166                           void *buffer, u32 buffer_length);
 167
 168 acpi_status
 169 acpi_ex_access_region(union acpi_operand_object *obj_desc,
 170                       u32 field_datum_byte_offset, u64 *value, u32 read_write);
 171
 172 /*
 173  * exmisc - misc support routines
 174  */
 175 acpi_status
 176 acpi_ex_get_object_reference(union acpi_operand_object *obj_desc,
 177                              union acpi_operand_object **return_desc,
 178                              struct acpi_walk_state *walk_state);
 179
 180 acpi_status
 181 acpi_ex_concat_template(union acpi_operand_object *obj_desc,
 182                         union acpi_operand_object *obj_desc2,
 183                         union acpi_operand_object **actual_return_desc,
 184                         struct acpi_walk_state *walk_state);
 185
 186 acpi_status
 187 acpi_ex_do_concatenate(union acpi_operand_object *obj_desc,
 188                        union acpi_operand_object *obj_desc2,
 189                        union acpi_operand_object **actual_return_desc,
 190                        struct acpi_walk_state *walk_state);
 191
 192 acpi_status
 193 acpi_ex_do_logical_numeric_op(u16 opcode,
 194                               u64 integer0, u64 integer1, u8 *logical_result);
 195
 196 acpi_status
 197 acpi_ex_do_logical_op(u16 opcode,
 198                       union acpi_operand_object *operand0,
 199                       union acpi_operand_object *operand1, u8 *logical_result);
 200
 201 u64 acpi_ex_do_math_op(u16 opcode, u64 operand0, u64 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_event(struct acpi_walk_state *walk_state);
 215
 216 acpi_status acpi_ex_create_alias(struct acpi_walk_state *walk_state);
 217
 218 acpi_status
 219 acpi_ex_create_method(u8 * aml_start,
 220                       u32 aml_length, struct acpi_walk_state *walk_state);
 221
 222 /*
 223  * exconfig - dynamic table load/unload
 224  */
 225 acpi_status
 226 acpi_ex_load_op(union acpi_operand_object *obj_desc,
 227                 union acpi_operand_object *target,
 228                 struct acpi_walk_state *walk_state);
 229
 230 acpi_status
 231 acpi_ex_load_table_op(struct acpi_walk_state *walk_state,
 232                       union acpi_operand_object **return_desc);
 233
 234 acpi_status acpi_ex_unload_table(union acpi_operand_object *ddb_handle);
 235
 236 /*
 237  * exmutex - mutex support
 238  */
 239 acpi_status
 240 acpi_ex_acquire_mutex(union acpi_operand_object *time_desc,
 241                       union acpi_operand_object *obj_desc,
 242                       struct acpi_walk_state *walk_state);
 243
 244 acpi_status
 245 acpi_ex_acquire_mutex_object(u16 timeout,
 246                              union acpi_operand_object *obj_desc,
 247                              acpi_thread_id thread_id);
 248
 249 acpi_status
 250 acpi_ex_release_mutex(union acpi_operand_object *obj_desc,
 251                       struct acpi_walk_state *walk_state);
 252
 253 acpi_status acpi_ex_release_mutex_object(union acpi_operand_object *obj_desc);
 254
 255 void acpi_ex_release_all_mutexes(struct acpi_thread_state *thread);
 256
 257 void acpi_ex_unlink_mutex(union acpi_operand_object *obj_desc);
 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(u64 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                       const char *opcode_name, u32 num_opcodes);
 366
 367 #ifdef  ACPI_FUTURE_USAGE
 368 void
 369 acpi_ex_dump_object_descriptor(union acpi_operand_object *object, u32 flags);
 370
 371 void acpi_ex_dump_namespace_node(struct acpi_namespace_node *node, u32 flags);
 372 #endif                          /* ACPI_FUTURE_USAGE */
 373
 374 /*
 375  * exnames - AML namestring support
 376  */
 377 acpi_status
 378 acpi_ex_get_name_string(acpi_object_type data_type,
 379                         u8 * in_aml_address,
 380                         char **out_name_string, u32 * out_name_length);
 381
 382 /*
 383  * exstore - Object store support
 384  */
 385 acpi_status
 386 acpi_ex_store(union acpi_operand_object *val_desc,
 387               union acpi_operand_object *dest_desc,
 388               struct acpi_walk_state *walk_state);
 389
 390 acpi_status
 391 acpi_ex_store_object_to_node(union acpi_operand_object *source_desc,
 392                              struct acpi_namespace_node *node,
 393                              struct acpi_walk_state *walk_state,
 394                              u8 implicit_conversion);
 395
 396 #define ACPI_IMPLICIT_CONVERSION        TRUE
 397 #define ACPI_NO_IMPLICIT_CONVERSION     FALSE
 398
 399 /*
 400  * exstoren - resolve/store object
 401  */
 402 acpi_status
 403 acpi_ex_resolve_object(union acpi_operand_object **source_desc_ptr,
 404                        acpi_object_type target_type,
 405                        struct acpi_walk_state *walk_state);
 406
 407 acpi_status
 408 acpi_ex_store_object_to_object(union acpi_operand_object *source_desc,
 409                                union acpi_operand_object *dest_desc,
 410                                union acpi_operand_object **new_desc,
 411                                struct acpi_walk_state *walk_state);
 412
 413 /*
 414  * exstorob - store object - buffer/string
 415  */
 416 acpi_status
 417 acpi_ex_store_buffer_to_buffer(union acpi_operand_object *source_desc,
 418                                union acpi_operand_object *target_desc);
 419
 420 acpi_status
 421 acpi_ex_store_string_to_string(union acpi_operand_object *source_desc,
 422                                union acpi_operand_object *target_desc);
 423
 424 /*
 425  * excopy - object copy
 426  */
 427 acpi_status
 428 acpi_ex_copy_integer_to_index_field(union acpi_operand_object *source_desc,
 429                                     union acpi_operand_object *target_desc);
 430
 431 acpi_status
 432 acpi_ex_copy_integer_to_bank_field(union acpi_operand_object *source_desc,
 433                                    union acpi_operand_object *target_desc);
 434
 435 acpi_status
 436 acpi_ex_copy_data_to_named_field(union acpi_operand_object *source_desc,
 437                                  struct acpi_namespace_node *node);
 438
 439 acpi_status
 440 acpi_ex_copy_integer_to_buffer_field(union acpi_operand_object *source_desc,
 441                                      union acpi_operand_object *target_desc);
 442
 443 /*
 444  * exutils - interpreter/scanner utilities
 445  */
 446 void acpi_ex_enter_interpreter(void);
 447
 448 void acpi_ex_exit_interpreter(void);
 449
 450 void acpi_ex_reacquire_interpreter(void);
 451
 452 void acpi_ex_relinquish_interpreter(void);
 453
 454 void acpi_ex_truncate_for32bit_table(union acpi_operand_object *obj_desc);
 455
 456 void acpi_ex_acquire_global_lock(u32 rule);
 457
 458 void acpi_ex_release_global_lock(u32 rule);
 459
 460 void acpi_ex_eisa_id_to_string(char *dest, u64 compressed_id);
 461
 462 void acpi_ex_integer_to_string(char *dest, u64 value);
 463
 464 /*
 465  * exregion - default op_region handlers
 466  */
 467 acpi_status
 468 acpi_ex_system_memory_space_handler(u32 function,
 469                                     acpi_physical_address address,
 470                                     u32 bit_width,
 471                                     u64 *value,
 472                                     void *handler_context,
 473                                     void *region_context);
 474
 475 acpi_status
 476 acpi_ex_system_io_space_handler(u32 function,
 477                                 acpi_physical_address address,
 478                                 u32 bit_width,
 479                                 u64 *value,
 480                                 void *handler_context, void *region_context);
 481
 482 acpi_status
 483 acpi_ex_pci_config_space_handler(u32 function,
 484                                  acpi_physical_address address,
 485                                  u32 bit_width,
 486                                  u64 *value,
 487                                  void *handler_context, void *region_context);
 488
 489 acpi_status
 490 acpi_ex_cmos_space_handler(u32 function,
 491                            acpi_physical_address address,
 492                            u32 bit_width,
 493                            u64 *value,
 494                            void *handler_context, void *region_context);
 495
 496 acpi_status
 497 acpi_ex_pci_bar_space_handler(u32 function,
 498                               acpi_physical_address address,
 499                               u32 bit_width,
 500                               u64 *value,
 501                               void *handler_context, void *region_context);
 502
 503 acpi_status
 504 acpi_ex_embedded_controller_space_handler(u32 function,
 505                                           acpi_physical_address address,
 506                                           u32 bit_width,
 507                                           u64 *value,
 508                                           void *handler_context,
 509                                           void *region_context);
 510
 511 acpi_status
 512 acpi_ex_sm_bus_space_handler(u32 function,
 513                              acpi_physical_address address,
 514                              u32 bit_width,
 515                              u64 *value,
 516                              void *handler_context, void *region_context);
 517
 518 acpi_status
 519 acpi_ex_data_table_space_handler(u32 function,
 520                                  acpi_physical_address address,
 521                                  u32 bit_width,
 522                                  u64 *value,
 523                                  void *handler_context, void *region_context);
 524
 525 #endif                          /* __INTERP_H__ */