LXR linux/drivers/acpi/acpica/acinterp.h

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