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