1 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */ 2 /****************************************************************************** 3 * 4 * Name: acinterp.h - Interpreter subcomponent prototypes and defines 5 * 6 * Copyright (C) 2000 - 2018, Intel Corp. 7 * 8 *****************************************************************************/ 9 10 #ifndef __ACINTERP_H__ 11 #define __ACINTERP_H__ 12 13 #define ACPI_WALK_OPERANDS (&(walk_state->operands [walk_state->num_operands -1])) 14 15 /* Macros for tables used for debug output */ 16 17 #define ACPI_EXD_OFFSET(f) (u8) ACPI_OFFSET (union acpi_operand_object,f) 18 #define ACPI_EXD_NSOFFSET(f) (u8) ACPI_OFFSET (struct acpi_namespace_node,f) 19 #define ACPI_EXD_TABLE_SIZE(name) (sizeof(name) / sizeof (struct acpi_exdump_info)) 20 21 /* 22 * If possible, pack the following structures to byte alignment, since we 23 * don't care about performance for debug output. Two cases where we cannot 24 * pack the structures: 25 * 26 * 1) Hardware does not support misaligned memory transfers 27 * 2) Compiler does not support pointers within packed structures 28 */ 29 #if (!defined(ACPI_MISALIGNMENT_NOT_SUPPORTED) && !defined(ACPI_PACKED_POINTERS_NOT_SUPPORTED)) 30 #pragma pack(1) 31 #endif 32 33 typedef const struct acpi_exdump_info { 34 u8 opcode; 35 u8 offset; 36 const char *name; 37 38 } acpi_exdump_info; 39 40 /* Values for the Opcode field above */ 41 42 #define ACPI_EXD_INIT 0 43 #define ACPI_EXD_TYPE 1 44 #define ACPI_EXD_UINT8 2 45 #define ACPI_EXD_UINT16 3 46 #define ACPI_EXD_UINT32 4 47 #define ACPI_EXD_UINT64 5 48 #define ACPI_EXD_LITERAL 6 49 #define ACPI_EXD_POINTER 7 50 #define ACPI_EXD_ADDRESS 8 51 #define ACPI_EXD_STRING 9 52 #define ACPI_EXD_BUFFER 10 53 #define ACPI_EXD_PACKAGE 11 54 #define ACPI_EXD_FIELD 12 55 #define ACPI_EXD_REFERENCE 13 56 #define ACPI_EXD_LIST 14 /* Operand object list */ 57 #define ACPI_EXD_HDLR_LIST 15 /* Address Handler list */ 58 #define ACPI_EXD_RGN_LIST 16 /* Region list */ 59 #define ACPI_EXD_NODE 17 /* Namespace Node */ 60 61 /* restore default alignment */ 62 63 #pragma pack() 64 65 /* 66 * exconvrt - object conversion 67 */ 68 acpi_status 69 acpi_ex_convert_to_integer(union acpi_operand_object *obj_desc, 70 union acpi_operand_object **result_desc, 71 u32 implicit_conversion); 72 73 acpi_status 74 acpi_ex_convert_to_buffer(union acpi_operand_object *obj_desc, 75 union acpi_operand_object **result_desc); 76 77 acpi_status 78 acpi_ex_convert_to_string(union acpi_operand_object *obj_desc, 79 union acpi_operand_object **result_desc, u32 type); 80 81 /* Types for ->String conversion */ 82 83 #define ACPI_EXPLICIT_BYTE_COPY 0x00000000 84 #define ACPI_EXPLICIT_CONVERT_HEX 0x00000001 85 #define ACPI_IMPLICIT_CONVERT_HEX 0x00000002 86 #define ACPI_EXPLICIT_CONVERT_DECIMAL 0x00000003 87 88 acpi_status 89 acpi_ex_convert_to_target_type(acpi_object_type destination_type, 90 union acpi_operand_object *source_desc, 91 union acpi_operand_object **result_desc, 92 struct acpi_walk_state *walk_state); 93 94 /* 95 * exdebug - AML debug object 96 */ 97 void 98 acpi_ex_do_debug_object(union acpi_operand_object *source_desc, 99 u32 level, u32 index); 100 101 void 102 acpi_ex_start_trace_method(struct acpi_namespace_node *method_node, 103 union acpi_operand_object *obj_desc, 104 struct acpi_walk_state *walk_state); 105 106 void 107 acpi_ex_stop_trace_method(struct acpi_namespace_node *method_node, 108 union acpi_operand_object *obj_desc, 109 struct acpi_walk_state *walk_state); 110 111 void 112 acpi_ex_start_trace_opcode(union acpi_parse_object *op, 113 struct acpi_walk_state *walk_state); 114 115 void 116 acpi_ex_stop_trace_opcode(union acpi_parse_object *op, 117 struct acpi_walk_state *walk_state); 118 119 void 120 acpi_ex_trace_point(acpi_trace_event_type type, 121 u8 begin, u8 *aml, char *pathname); 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_sleep(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 void 368 acpi_ex_dump_object_descriptor(union acpi_operand_object *object, u32 flags); 369 370 void acpi_ex_dump_namespace_node(struct acpi_namespace_node *node, u32 flags); 371 372 /* 373 * exnames - AML namestring support 374 */ 375 acpi_status 376 acpi_ex_get_name_string(acpi_object_type data_type, 377 u8 * in_aml_address, 378 char **out_name_string, u32 * out_name_length); 379 380 /* 381 * exstore - Object store support 382 */ 383 acpi_status 384 acpi_ex_store(union acpi_operand_object *val_desc, 385 union acpi_operand_object *dest_desc, 386 struct acpi_walk_state *walk_state); 387 388 acpi_status 389 acpi_ex_store_object_to_node(union acpi_operand_object *source_desc, 390 struct acpi_namespace_node *node, 391 struct acpi_walk_state *walk_state, 392 u8 implicit_conversion); 393 394 /* 395 * exstoren - resolve/store object 396 */ 397 acpi_status 398 acpi_ex_resolve_object(union acpi_operand_object **source_desc_ptr, 399 acpi_object_type target_type, 400 struct acpi_walk_state *walk_state); 401 402 acpi_status 403 acpi_ex_store_object_to_object(union acpi_operand_object *source_desc, 404 union acpi_operand_object *dest_desc, 405 union acpi_operand_object **new_desc, 406 struct acpi_walk_state *walk_state); 407 408 /* 409 * exstorob - store object - buffer/string 410 */ 411 acpi_status 412 acpi_ex_store_buffer_to_buffer(union acpi_operand_object *source_desc, 413 union acpi_operand_object *target_desc); 414 415 acpi_status 416 acpi_ex_store_string_to_string(union acpi_operand_object *source_desc, 417 union acpi_operand_object *target_desc); 418 419 /* 420 * excopy - object copy 421 */ 422 acpi_status 423 acpi_ex_copy_integer_to_index_field(union acpi_operand_object *source_desc, 424 union acpi_operand_object *target_desc); 425 426 acpi_status 427 acpi_ex_copy_integer_to_bank_field(union acpi_operand_object *source_desc, 428 union acpi_operand_object *target_desc); 429 430 acpi_status 431 acpi_ex_copy_data_to_named_field(union acpi_operand_object *source_desc, 432 struct acpi_namespace_node *node); 433 434 acpi_status 435 acpi_ex_copy_integer_to_buffer_field(union acpi_operand_object *source_desc, 436 union acpi_operand_object *target_desc); 437 438 /* 439 * exutils - interpreter/scanner utilities 440 */ 441 void acpi_ex_enter_interpreter(void); 442 443 void acpi_ex_exit_interpreter(void); 444 445 u8 acpi_ex_truncate_for32bit_table(union acpi_operand_object *obj_desc); 446 447 void acpi_ex_acquire_global_lock(u32 rule); 448 449 void acpi_ex_release_global_lock(u32 rule); 450 451 void acpi_ex_eisa_id_to_string(char *dest, u64 compressed_id); 452 453 void acpi_ex_integer_to_string(char *dest, u64 value); 454 455 void acpi_ex_pci_cls_to_string(char *dest, u8 class_code[3]); 456 457 u8 acpi_is_valid_space_id(u8 space_id); 458 459 /* 460 * exregion - default op_region handlers 461 */ 462 acpi_status 463 acpi_ex_system_memory_space_handler(u32 function, 464 acpi_physical_address address, 465 u32 bit_width, 466 u64 *value, 467 void *handler_context, 468 void *region_context); 469 470 acpi_status 471 acpi_ex_system_io_space_handler(u32 function, 472 acpi_physical_address address, 473 u32 bit_width, 474 u64 *value, 475 void *handler_context, void *region_context); 476 477 acpi_status 478 acpi_ex_pci_config_space_handler(u32 function, 479 acpi_physical_address address, 480 u32 bit_width, 481 u64 *value, 482 void *handler_context, void *region_context); 483 484 acpi_status 485 acpi_ex_cmos_space_handler(u32 function, 486 acpi_physical_address address, 487 u32 bit_width, 488 u64 *value, 489 void *handler_context, void *region_context); 490 491 acpi_status 492 acpi_ex_pci_bar_space_handler(u32 function, 493 acpi_physical_address address, 494 u32 bit_width, 495 u64 *value, 496 void *handler_context, void *region_context); 497 498 acpi_status 499 acpi_ex_embedded_controller_space_handler(u32 function, 500 acpi_physical_address address, 501 u32 bit_width, 502 u64 *value, 503 void *handler_context, 504 void *region_context); 505 506 acpi_status 507 acpi_ex_sm_bus_space_handler(u32 function, 508 acpi_physical_address address, 509 u32 bit_width, 510 u64 *value, 511 void *handler_context, void *region_context); 512 513 acpi_status 514 acpi_ex_data_table_space_handler(u32 function, 515 acpi_physical_address address, 516 u32 bit_width, 517 u64 *value, 518 void *handler_context, void *region_context); 519 520 #endif /* __INTERP_H__ */ 521