1 // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
2 /******************************************************************************
4 * Module Name: psxface - Parser external interfaces
6 * Copyright (C) 2000 - 2018, Intel Corp.
8 *****************************************************************************/
10 #include <acpi/acpi.h>
18 #define _COMPONENT ACPI_PARSER
19 ACPI_MODULE_NAME("psxface")
21 /* Local Prototypes */
23 acpi_ps_update_parameter_list(struct acpi_evaluate_info *info, u16 action);
25 /*******************************************************************************
27 * FUNCTION: acpi_debug_trace
29 * PARAMETERS: method_name - Valid ACPI name string
30 * debug_level - Optional level mask. 0 to use default
31 * debug_layer - Optional layer mask. 0 to use default
32 * flags - bit 1: one shot(1) or persistent(0)
36 * DESCRIPTION: External interface to enable debug tracing during control
39 ******************************************************************************/
42 acpi_debug_trace(const char *name, u32 debug_level, u32 debug_layer, u32 flags)
46 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
47 if (ACPI_FAILURE(status)) {
51 acpi_gbl_trace_method_name = name;
52 acpi_gbl_trace_flags = flags;
53 acpi_gbl_trace_dbg_level = debug_level;
54 acpi_gbl_trace_dbg_layer = debug_layer;
57 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
61 /*******************************************************************************
63 * FUNCTION: acpi_ps_execute_method
65 * PARAMETERS: info - Method info block, contains:
66 * node - Method Node to execute
67 * obj_desc - Method object
68 * parameters - List of parameters to pass to the method,
69 * terminated by NULL. Params itself may be
70 * NULL if no parameters are being passed.
71 * return_object - Where to put method's return value (if
72 * any). If NULL, no value is returned.
73 * parameter_type - Type of Parameter list
74 * return_object - Where to put method's return value (if
75 * any). If NULL, no value is returned.
76 * pass_number - Parse or execute pass
80 * DESCRIPTION: Execute a control method
82 ******************************************************************************/
84 acpi_status acpi_ps_execute_method(struct acpi_evaluate_info *info)
87 union acpi_parse_object *op;
88 struct acpi_walk_state *walk_state;
90 ACPI_FUNCTION_TRACE(ps_execute_method);
92 /* Quick validation of DSDT header */
94 acpi_tb_check_dsdt_header();
96 /* Validate the Info and method Node */
98 if (!info || !info->node) {
99 return_ACPI_STATUS(AE_NULL_ENTRY);
102 /* Init for new method, wait on concurrency semaphore */
105 acpi_ds_begin_method_execution(info->node, info->obj_desc, NULL);
106 if (ACPI_FAILURE(status)) {
107 return_ACPI_STATUS(status);
111 * The caller "owns" the parameters, so give each one an extra reference
113 acpi_ps_update_parameter_list(info, REF_INCREMENT);
116 * Execute the method. Performs parse simultaneously
118 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
119 "**** Begin Method Parse/Execute [%4.4s] **** Node=%p Obj=%p\n",
120 info->node->name.ascii, info->node, info->obj_desc));
122 /* Create and init a Root Node */
124 op = acpi_ps_create_scope_op(info->obj_desc->method.aml_start);
126 status = AE_NO_MEMORY;
130 /* Create and initialize a new walk state */
132 info->pass_number = ACPI_IMODE_EXECUTE;
134 acpi_ds_create_walk_state(info->obj_desc->method.owner_id, NULL,
137 status = AE_NO_MEMORY;
141 status = acpi_ds_init_aml_walk(walk_state, op, info->node,
142 info->obj_desc->method.aml_start,
143 info->obj_desc->method.aml_length, info,
145 if (ACPI_FAILURE(status)) {
146 acpi_ds_delete_walk_state(walk_state);
150 if (info->obj_desc->method.info_flags & ACPI_METHOD_MODULE_LEVEL) {
151 walk_state->parse_flags |= ACPI_PARSE_MODULE_LEVEL;
154 /* Invoke an internal method if necessary */
156 if (info->obj_desc->method.info_flags & ACPI_METHOD_INTERNAL_ONLY) {
158 info->obj_desc->method.dispatch.implementation(walk_state);
159 info->return_object = walk_state->return_desc;
163 acpi_ds_scope_stack_clear(walk_state);
164 acpi_ps_cleanup_scope(&walk_state->parser_state);
165 acpi_ds_terminate_control_method(walk_state->method_desc,
167 acpi_ds_delete_walk_state(walk_state);
172 * Start method evaluation with an implicit return of zero.
173 * This is done for Windows compatibility.
175 if (acpi_gbl_enable_interpreter_slack) {
176 walk_state->implicit_return_obj =
177 acpi_ut_create_integer_object((u64) 0);
178 if (!walk_state->implicit_return_obj) {
179 status = AE_NO_MEMORY;
180 acpi_ds_delete_walk_state(walk_state);
187 status = acpi_ps_parse_aml(walk_state);
189 /* walk_state was deleted by parse_aml */
192 acpi_ps_delete_parse_tree(op);
194 /* Take away the extra reference that we gave the parameters above */
196 acpi_ps_update_parameter_list(info, REF_DECREMENT);
198 /* Exit now if error above */
200 if (ACPI_FAILURE(status)) {
201 return_ACPI_STATUS(status);
205 * If the method has returned an object, signal this to the caller with
206 * a control exception code
208 if (info->return_object) {
209 ACPI_DEBUG_PRINT((ACPI_DB_PARSE, "Method returned ObjDesc=%p\n",
210 info->return_object));
211 ACPI_DUMP_STACK_ENTRY(info->return_object);
213 status = AE_CTRL_RETURN_VALUE;
216 return_ACPI_STATUS(status);
219 /*******************************************************************************
221 * FUNCTION: acpi_ps_execute_table
223 * PARAMETERS: info - Method info block, contains:
224 * node - Node to where the is entered into the
226 * obj_desc - Pseudo method object describing the AML
227 * code of the entire table
228 * pass_number - Parse or execute pass
232 * DESCRIPTION: Execute a table
234 ******************************************************************************/
236 acpi_status acpi_ps_execute_table(struct acpi_evaluate_info *info)
239 union acpi_parse_object *op = NULL;
240 struct acpi_walk_state *walk_state = NULL;
242 ACPI_FUNCTION_TRACE(ps_execute_table);
244 /* Create and init a Root Node */
246 op = acpi_ps_create_scope_op(info->obj_desc->method.aml_start);
248 status = AE_NO_MEMORY;
252 /* Create and initialize a new walk state */
255 acpi_ds_create_walk_state(info->obj_desc->method.owner_id, NULL,
258 status = AE_NO_MEMORY;
262 status = acpi_ds_init_aml_walk(walk_state, op, info->node,
263 info->obj_desc->method.aml_start,
264 info->obj_desc->method.aml_length, info,
266 if (ACPI_FAILURE(status)) {
270 if (info->obj_desc->method.info_flags & ACPI_METHOD_MODULE_LEVEL) {
271 walk_state->parse_flags |= ACPI_PARSE_MODULE_LEVEL;
274 /* Info->Node is the default location to load the table */
276 if (info->node && info->node != acpi_gbl_root_node) {
278 acpi_ds_scope_stack_push(info->node, ACPI_TYPE_METHOD,
280 if (ACPI_FAILURE(status)) {
286 * Parse the AML, walk_state will be deleted by parse_aml
288 acpi_ex_enter_interpreter();
289 status = acpi_ps_parse_aml(walk_state);
290 acpi_ex_exit_interpreter();
295 acpi_ds_delete_walk_state(walk_state);
298 acpi_ps_delete_parse_tree(op);
300 return_ACPI_STATUS(status);
303 /*******************************************************************************
305 * FUNCTION: acpi_ps_update_parameter_list
307 * PARAMETERS: info - See struct acpi_evaluate_info
308 * (Used: parameter_type and Parameters)
309 * action - Add or Remove reference
313 * DESCRIPTION: Update reference count on all method parameter objects
315 ******************************************************************************/
318 acpi_ps_update_parameter_list(struct acpi_evaluate_info *info, u16 action)
322 if (info->parameters) {
324 /* Update reference count for each parameter */
326 for (i = 0; info->parameters[i]; i++) {
328 /* Ignore errors, just do them all */
330 (void)acpi_ut_update_object_reference(info->