acpi/acpica/acdispat.h

0001 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
0002 /******************************************************************************
0003  *
0004  * Name: acdispat.h - dispatcher (parser to interpreter interface)
0005  *
0006  * Copyright (C) 2000 - 2022, Intel Corp.
0007  *
0008  *****************************************************************************/
0009
0010 #ifndef _ACDISPAT_H_
0011 #define _ACDISPAT_H_
0012
0013 #define NAMEOF_LOCAL_NTE    "__L0"
0014 #define NAMEOF_ARG_NTE      "__A0"
0015
0016 /*
0017  * dsargs - execution of dynamic arguments for static objects
0018  */
0019 acpi_status
0020 acpi_ds_get_buffer_field_arguments(union acpi_operand_object *obj_desc);
0021
0022 acpi_status
0023 acpi_ds_get_bank_field_arguments(union acpi_operand_object *obj_desc);
0024
0025 acpi_status acpi_ds_get_region_arguments(union acpi_operand_object *rgn_desc);
0026
0027 acpi_status acpi_ds_get_buffer_arguments(union acpi_operand_object *obj_desc);
0028
0029 acpi_status acpi_ds_get_package_arguments(union acpi_operand_object *obj_desc);
0030
0031 /*
0032  * dscontrol - support for execution control opcodes
0033  */
0034 acpi_status
0035 acpi_ds_exec_begin_control_op(struct acpi_walk_state *walk_state,
0036                   union acpi_parse_object *op);
0037
0038 acpi_status
0039 acpi_ds_exec_end_control_op(struct acpi_walk_state *walk_state,
0040                 union acpi_parse_object *op);
0041
0042 /*
0043  * dsopcode - support for late operand evaluation
0044  */
0045 acpi_status
0046 acpi_ds_eval_buffer_field_operands(struct acpi_walk_state *walk_state,
0047                    union acpi_parse_object *op);
0048
0049 acpi_status
0050 acpi_ds_eval_region_operands(struct acpi_walk_state *walk_state,
0051                  union acpi_parse_object *op);
0052
0053 acpi_status
0054 acpi_ds_eval_table_region_operands(struct acpi_walk_state *walk_state,
0055                    union acpi_parse_object *op);
0056
0057 acpi_status
0058 acpi_ds_eval_data_object_operands(struct acpi_walk_state *walk_state,
0059                   union acpi_parse_object *op,
0060                   union acpi_operand_object *obj_desc);
0061
0062 acpi_status
0063 acpi_ds_eval_bank_field_operands(struct acpi_walk_state *walk_state,
0064                  union acpi_parse_object *op);
0065
0066 acpi_status acpi_ds_initialize_region(acpi_handle obj_handle);
0067
0068 /*
0069  * dsexec - Parser/Interpreter interface, method execution callbacks
0070  */
0071 acpi_status
0072 acpi_ds_get_predicate_value(struct acpi_walk_state *walk_state,
0073                 union acpi_operand_object *result_obj);
0074
0075 acpi_status
0076 acpi_ds_exec_begin_op(struct acpi_walk_state *walk_state,
0077               union acpi_parse_object **out_op);
0078
0079 acpi_status acpi_ds_exec_end_op(struct acpi_walk_state *state);
0080
0081 /*
0082  * dsfield - Parser/Interpreter interface for AML fields
0083  */
0084 acpi_status
0085 acpi_ds_create_field(union acpi_parse_object *op,
0086              struct acpi_namespace_node *region_node,
0087              struct acpi_walk_state *walk_state);
0088
0089 acpi_status
0090 acpi_ds_create_bank_field(union acpi_parse_object *op,
0091               struct acpi_namespace_node *region_node,
0092               struct acpi_walk_state *walk_state);
0093
0094 acpi_status
0095 acpi_ds_create_index_field(union acpi_parse_object *op,
0096                struct acpi_namespace_node *region_node,
0097                struct acpi_walk_state *walk_state);
0098
0099 acpi_status
0100 acpi_ds_create_buffer_field(union acpi_parse_object *op,
0101                 struct acpi_walk_state *walk_state);
0102
0103 acpi_status
0104 acpi_ds_init_field_objects(union acpi_parse_object *op,
0105                struct acpi_walk_state *walk_state);
0106
0107 /*
0108  * dsload - Parser/Interpreter interface
0109  */
0110 acpi_status
0111 acpi_ds_init_callbacks(struct acpi_walk_state *walk_state, u32 pass_number);
0112
0113 /* dsload - pass 1 namespace load callbacks */
0114
0115 acpi_status
0116 acpi_ds_load1_begin_op(struct acpi_walk_state *walk_state,
0117                union acpi_parse_object **out_op);
0118
0119 acpi_status acpi_ds_load1_end_op(struct acpi_walk_state *walk_state);
0120
0121 /* dsload - pass 2 namespace load callbacks */
0122
0123 acpi_status
0124 acpi_ds_load2_begin_op(struct acpi_walk_state *walk_state,
0125                union acpi_parse_object **out_op);
0126
0127 acpi_status acpi_ds_load2_end_op(struct acpi_walk_state *walk_state);
0128
0129 /*
0130  * dsmthdat - method data (locals/args)
0131  */
0132 acpi_status
0133 acpi_ds_store_object_to_local(u8 type,
0134                   u32 index,
0135                   union acpi_operand_object *src_desc,
0136                   struct acpi_walk_state *walk_state);
0137
0138 acpi_status
0139 acpi_ds_method_data_get_entry(u16 opcode,
0140                   u32 index,
0141                   struct acpi_walk_state *walk_state,
0142                   union acpi_operand_object ***node);
0143
0144 void acpi_ds_method_data_delete_all(struct acpi_walk_state *walk_state);
0145
0146 u8 acpi_ds_is_method_value(union acpi_operand_object *obj_desc);
0147
0148 acpi_status
0149 acpi_ds_method_data_get_value(u8 type,
0150                   u32 index,
0151                   struct acpi_walk_state *walk_state,
0152                   union acpi_operand_object **dest_desc);
0153
0154 acpi_status
0155 acpi_ds_method_data_init_args(union acpi_operand_object **params,
0156                   u32 max_param_count,
0157                   struct acpi_walk_state *walk_state);
0158
0159 acpi_status
0160 acpi_ds_method_data_get_node(u8 type,
0161                  u32 index,
0162                  struct acpi_walk_state *walk_state,
0163                  struct acpi_namespace_node **node);
0164
0165 void acpi_ds_method_data_init(struct acpi_walk_state *walk_state);
0166
0167 /*
0168  * dsmethod - Parser/Interpreter interface - control method parsing
0169  */
0170 acpi_status
0171 acpi_ds_auto_serialize_method(struct acpi_namespace_node *node,
0172                   union acpi_operand_object *obj_desc);
0173
0174 acpi_status
0175 acpi_ds_call_control_method(struct acpi_thread_state *thread,
0176                 struct acpi_walk_state *walk_state,
0177                 union acpi_parse_object *op);
0178
0179 acpi_status
0180 acpi_ds_restart_control_method(struct acpi_walk_state *walk_state,
0181                    union acpi_operand_object *return_desc);
0182
0183 void
0184 acpi_ds_terminate_control_method(union acpi_operand_object *method_desc,
0185                  struct acpi_walk_state *walk_state);
0186
0187 acpi_status
0188 acpi_ds_begin_method_execution(struct acpi_namespace_node *method_node,
0189                    union acpi_operand_object *obj_desc,
0190                    struct acpi_walk_state *walk_state);
0191
0192 acpi_status
0193 acpi_ds_method_error(acpi_status status, struct acpi_walk_state *walk_state);
0194
0195 /*
0196  * dsinit
0197  */
0198 acpi_status
0199 acpi_ds_initialize_objects(u32 table_index,
0200                struct acpi_namespace_node *start_node);
0201
0202 /*
0203  * dsobject - Parser/Interpreter interface - object initialization and conversion
0204  */
0205 acpi_status
0206 acpi_ds_build_internal_object(struct acpi_walk_state *walk_state,
0207                   union acpi_parse_object *op,
0208                   union acpi_operand_object **obj_desc_ptr);
0209
0210 acpi_status
0211 acpi_ds_build_internal_buffer_obj(struct acpi_walk_state *walk_state,
0212                   union acpi_parse_object *op,
0213                   u32 buffer_length,
0214                   union acpi_operand_object **obj_desc_ptr);
0215
0216 acpi_status
0217 acpi_ds_build_internal_package_obj(struct acpi_walk_state *walk_state,
0218                    union acpi_parse_object *op,
0219                    u32 package_length,
0220                    union acpi_operand_object **obj_desc);
0221
0222 acpi_status
0223 acpi_ds_init_object_from_op(struct acpi_walk_state *walk_state,
0224                 union acpi_parse_object *op,
0225                 u16 opcode, union acpi_operand_object **obj_desc);
0226
0227 acpi_status
0228 acpi_ds_create_node(struct acpi_walk_state *walk_state,
0229             struct acpi_namespace_node *node,
0230             union acpi_parse_object *op);
0231
0232 /*
0233  * dspkginit - Package object initialization
0234  */
0235 acpi_status
0236 acpi_ds_init_package_element(u8 object_type,
0237                  union acpi_operand_object *source_object,
0238                  union acpi_generic_state *state, void *context);
0239
0240 /*
0241  * dsutils - Parser/Interpreter interface utility routines
0242  */
0243 void acpi_ds_clear_implicit_return(struct acpi_walk_state *walk_state);
0244
0245 u8
0246 acpi_ds_do_implicit_return(union acpi_operand_object *return_desc,
0247                struct acpi_walk_state *walk_state,
0248                u8 add_reference);
0249
0250 u8
0251 acpi_ds_is_result_used(union acpi_parse_object *op,
0252                struct acpi_walk_state *walk_state);
0253
0254 void
0255 acpi_ds_delete_result_if_not_used(union acpi_parse_object *op,
0256                   union acpi_operand_object *result_obj,
0257                   struct acpi_walk_state *walk_state);
0258
0259 acpi_status
0260 acpi_ds_create_operand(struct acpi_walk_state *walk_state,
0261                union acpi_parse_object *arg, u32 args_remaining);
0262
0263 acpi_status
0264 acpi_ds_create_operands(struct acpi_walk_state *walk_state,
0265             union acpi_parse_object *first_arg);
0266
0267 acpi_status acpi_ds_resolve_operands(struct acpi_walk_state *walk_state);
0268
0269 void acpi_ds_clear_operands(struct acpi_walk_state *walk_state);
0270
0271 acpi_status acpi_ds_evaluate_name_path(struct acpi_walk_state *walk_state);
0272
0273 /*
0274  * dswscope - Scope Stack manipulation
0275  */
0276 acpi_status
0277 acpi_ds_scope_stack_push(struct acpi_namespace_node *node,
0278              acpi_object_type type,
0279              struct acpi_walk_state *walk_state);
0280
0281 acpi_status acpi_ds_scope_stack_pop(struct acpi_walk_state *walk_state);
0282
0283 void acpi_ds_scope_stack_clear(struct acpi_walk_state *walk_state);
0284
0285 /*
0286  * dswstate - parser WALK_STATE management routines
0287  */
0288 acpi_status
0289 acpi_ds_obj_stack_push(void *object, struct acpi_walk_state *walk_state);
0290
0291 acpi_status
0292 acpi_ds_obj_stack_pop(u32 pop_count, struct acpi_walk_state *walk_state);
0293
0294 struct acpi_walk_state * acpi_ds_create_walk_state(acpi_owner_id owner_id,
0295                            union acpi_parse_object
0296                            *origin,
0297                            union acpi_operand_object
0298                            *mth_desc,
0299                            struct acpi_thread_state
0300                            *thread);
0301
0302 acpi_status
0303 acpi_ds_init_aml_walk(struct acpi_walk_state *walk_state,
0304               union acpi_parse_object *op,
0305               struct acpi_namespace_node *method_node,
0306               u8 * aml_start,
0307               u32 aml_length,
0308               struct acpi_evaluate_info *info, u8 pass_number);
0309
0310 void
0311 acpi_ds_obj_stack_pop_and_delete(u32 pop_count,
0312                  struct acpi_walk_state *walk_state);
0313
0314 void acpi_ds_delete_walk_state(struct acpi_walk_state *walk_state);
0315
0316 struct acpi_walk_state *acpi_ds_pop_walk_state(struct acpi_thread_state
0317                            *thread);
0318
0319 void
0320 acpi_ds_push_walk_state(struct acpi_walk_state *walk_state,
0321             struct acpi_thread_state *thread);
0322
0323 acpi_status acpi_ds_result_stack_clear(struct acpi_walk_state *walk_state);
0324
0325 struct acpi_walk_state *acpi_ds_get_current_walk_state(struct acpi_thread_state
0326                                *thread);
0327
0328 acpi_status
0329 acpi_ds_result_pop(union acpi_operand_object **object,
0330            struct acpi_walk_state *walk_state);
0331
0332 acpi_status
0333 acpi_ds_result_push(union acpi_operand_object *object,
0334             struct acpi_walk_state *walk_state);
0335
0336 /*
0337  * dsdebug - parser debugging routines
0338  */
0339 void
0340 acpi_ds_dump_method_stack(acpi_status status,
0341               struct acpi_walk_state *walk_state,
0342               union acpi_parse_object *op);
0343
0344 #endif              /* _ACDISPAT_H_ */