1 // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
2 /*******************************************************************************
4 * Module Name: dbmethod - Debug commands for control methods
6 ******************************************************************************/
16 #define _COMPONENT ACPI_CA_DEBUGGER
17 ACPI_MODULE_NAME("dbmethod")
19 /* Local prototypes */
21 acpi_db_walk_for_execute(acpi_handle obj_handle
,
22 u32 nesting_level
, void *context
, void **return_value
);
24 static acpi_status
acpi_db_evaluate_object(struct acpi_namespace_node
*node
);
26 /*******************************************************************************
28 * FUNCTION: acpi_db_set_method_breakpoint
30 * PARAMETERS: location - AML offset of breakpoint
31 * walk_state - Current walk info
32 * op - Current Op (from parse walk)
36 * DESCRIPTION: Set a breakpoint in a control method at the specified
39 ******************************************************************************/
42 acpi_db_set_method_breakpoint(char *location
,
43 struct acpi_walk_state
*walk_state
,
44 union acpi_parse_object
*op
)
50 acpi_os_printf("There is no method currently executing\n");
54 /* Get and verify the breakpoint address */
56 address
= strtoul(location
, NULL
, 16);
57 aml_offset
= (u32
)ACPI_PTR_DIFF(op
->common
.aml
,
58 walk_state
->parser_state
.aml_start
);
59 if (address
<= aml_offset
) {
60 acpi_os_printf("Breakpoint %X is beyond current address %X\n",
64 /* Save breakpoint in current walk */
66 walk_state
->user_breakpoint
= address
;
67 acpi_os_printf("Breakpoint set at AML offset %X\n", address
);
70 /*******************************************************************************
72 * FUNCTION: acpi_db_set_method_call_breakpoint
74 * PARAMETERS: op - Current Op (from parse walk)
78 * DESCRIPTION: Set a breakpoint in a control method at the specified
81 ******************************************************************************/
83 void acpi_db_set_method_call_breakpoint(union acpi_parse_object
*op
)
87 acpi_os_printf("There is no method currently executing\n");
91 acpi_gbl_step_to_next_call
= TRUE
;
94 /*******************************************************************************
96 * FUNCTION: acpi_db_set_method_data
98 * PARAMETERS: type_arg - L for local, A for argument
99 * index_arg - which one
100 * value_arg - Value to set.
104 * DESCRIPTION: Set a local or argument for the running control method.
105 * NOTE: only object supported is Number.
107 ******************************************************************************/
109 void acpi_db_set_method_data(char *type_arg
, char *index_arg
, char *value_arg
)
114 struct acpi_walk_state
*walk_state
;
115 union acpi_operand_object
*obj_desc
;
117 struct acpi_namespace_node
*node
;
119 /* Validate type_arg */
121 acpi_ut_strupr(type_arg
);
123 if ((type
!= 'L') && (type
!= 'A') && (type
!= 'N')) {
124 acpi_os_printf("Invalid SET operand: %s\n", type_arg
);
128 value
= strtoul(value_arg
, NULL
, 16);
131 node
= acpi_db_convert_to_node(index_arg
);
136 if (node
->type
!= ACPI_TYPE_INTEGER
) {
137 acpi_os_printf("Can only set Integer nodes\n");
140 obj_desc
= node
->object
;
141 obj_desc
->integer
.value
= value
;
145 /* Get the index and value */
147 index
= strtoul(index_arg
, NULL
, 16);
149 walk_state
= acpi_ds_get_current_walk_state(acpi_gbl_current_walk_list
);
151 acpi_os_printf("There is no method currently executing\n");
155 /* Create and initialize the new object */
157 obj_desc
= acpi_ut_create_integer_object((u64
)value
);
159 acpi_os_printf("Could not create an internal object\n");
163 /* Store the new object into the target */
168 /* Set a method argument */
170 if (index
> ACPI_METHOD_MAX_ARG
) {
171 acpi_os_printf("Arg%u - Invalid argument name\n",
176 status
= acpi_ds_store_object_to_local(ACPI_REFCLASS_ARG
,
179 if (ACPI_FAILURE(status
)) {
183 obj_desc
= walk_state
->arguments
[index
].object
;
185 acpi_os_printf("Arg%u: ", index
);
186 acpi_db_display_internal_object(obj_desc
, walk_state
);
191 /* Set a method local */
193 if (index
> ACPI_METHOD_MAX_LOCAL
) {
195 ("Local%u - Invalid local variable name\n", index
);
199 status
= acpi_ds_store_object_to_local(ACPI_REFCLASS_LOCAL
,
202 if (ACPI_FAILURE(status
)) {
206 obj_desc
= walk_state
->local_variables
[index
].object
;
208 acpi_os_printf("Local%u: ", index
);
209 acpi_db_display_internal_object(obj_desc
, walk_state
);
218 acpi_ut_remove_reference(obj_desc
);
221 #ifdef ACPI_DISASSEMBLER
222 /*******************************************************************************
224 * FUNCTION: acpi_db_disassemble_aml
226 * PARAMETERS: statements - Number of statements to disassemble
227 * op - Current Op (from parse walk)
231 * DESCRIPTION: Display disassembled AML (ASL) starting from Op for the number
232 * of statements specified.
234 ******************************************************************************/
236 void acpi_db_disassemble_aml(char *statements
, union acpi_parse_object
*op
)
238 u32 num_statements
= 8;
241 acpi_os_printf("There is no method currently executing\n");
246 num_statements
= strtoul(statements
, NULL
, 0);
249 acpi_dm_disassemble(NULL
, op
, num_statements
);
252 /*******************************************************************************
254 * FUNCTION: acpi_db_disassemble_method
256 * PARAMETERS: name - Name of control method
260 * DESCRIPTION: Display disassembled AML (ASL) starting from Op for the number
261 * of statements specified.
263 ******************************************************************************/
265 acpi_status
acpi_db_disassemble_method(char *name
)
268 union acpi_parse_object
*op
;
269 struct acpi_walk_state
*walk_state
;
270 union acpi_operand_object
*obj_desc
;
271 struct acpi_namespace_node
*method
;
273 method
= acpi_db_convert_to_node(name
);
275 return (AE_BAD_PARAMETER
);
278 if (method
->type
!= ACPI_TYPE_METHOD
) {
279 ACPI_ERROR((AE_INFO
, "%s (%s): Object must be a control method",
280 name
, acpi_ut_get_type_name(method
->type
)));
281 return (AE_BAD_PARAMETER
);
284 obj_desc
= method
->object
;
286 op
= acpi_ps_create_scope_op(obj_desc
->method
.aml_start
);
288 return (AE_NO_MEMORY
);
291 /* Create and initialize a new walk state */
293 walk_state
= acpi_ds_create_walk_state(0, op
, NULL
, NULL
);
295 return (AE_NO_MEMORY
);
298 status
= acpi_ds_init_aml_walk(walk_state
, op
, NULL
,
299 obj_desc
->method
.aml_start
,
300 obj_desc
->method
.aml_length
, NULL
,
301 ACPI_IMODE_LOAD_PASS1
);
302 if (ACPI_FAILURE(status
)) {
306 status
= acpi_ut_allocate_owner_id(&obj_desc
->method
.owner_id
);
307 if (ACPI_FAILURE(status
)) {
311 walk_state
->owner_id
= obj_desc
->method
.owner_id
;
313 /* Push start scope on scope stack and make it current */
315 status
= acpi_ds_scope_stack_push(method
, method
->type
, walk_state
);
316 if (ACPI_FAILURE(status
)) {
320 /* Parse the entire method AML including deferred operators */
322 walk_state
->parse_flags
&= ~ACPI_PARSE_DELETE_TREE
;
323 walk_state
->parse_flags
|= ACPI_PARSE_DISASSEMBLE
;
325 status
= acpi_ps_parse_aml(walk_state
);
326 if (ACPI_FAILURE(status
)) {
330 (void)acpi_dm_parse_deferred_ops(op
);
332 /* Now we can disassemble the method */
334 acpi_gbl_dm_opt_verbose
= FALSE
;
335 acpi_dm_disassemble(NULL
, op
, 0);
336 acpi_gbl_dm_opt_verbose
= TRUE
;
338 acpi_ps_delete_parse_tree(op
);
342 acpi_ns_delete_namespace_subtree(method
);
343 acpi_ns_delete_namespace_by_owner(obj_desc
->method
.owner_id
);
344 acpi_ut_release_owner_id(&obj_desc
->method
.owner_id
);
349 /*******************************************************************************
351 * FUNCTION: acpi_db_evaluate_object
353 * PARAMETERS: node - Namespace node for the object
357 * DESCRIPTION: Main execution function for the Evaluate/Execute/All debugger
360 ******************************************************************************/
362 static acpi_status
acpi_db_evaluate_object(struct acpi_namespace_node
*node
)
366 struct acpi_device_info
*obj_info
;
367 struct acpi_object_list param_objects
;
368 union acpi_object params
[ACPI_METHOD_NUM_ARGS
];
369 struct acpi_buffer return_obj
;
372 pathname
= acpi_ns_get_external_pathname(node
);
377 /* Get the object info for number of method parameters */
379 status
= acpi_get_object_info(node
, &obj_info
);
380 if (ACPI_FAILURE(status
)) {
385 param_objects
.pointer
= NULL
;
386 param_objects
.count
= 0;
388 if (obj_info
->type
== ACPI_TYPE_METHOD
) {
390 /* Setup default parameters */
392 for (i
= 0; i
< obj_info
->param_count
; i
++) {
393 params
[i
].type
= ACPI_TYPE_INTEGER
;
394 params
[i
].integer
.value
= 1;
397 param_objects
.pointer
= params
;
398 param_objects
.count
= obj_info
->param_count
;
402 return_obj
.pointer
= NULL
;
403 return_obj
.length
= ACPI_ALLOCATE_BUFFER
;
405 /* Do the actual method execution */
407 acpi_gbl_method_executing
= TRUE
;
409 status
= acpi_evaluate_object(node
, NULL
, ¶m_objects
, &return_obj
);
410 acpi_gbl_method_executing
= FALSE
;
412 acpi_os_printf("%-32s returned %s\n", pathname
,
413 acpi_format_exception(status
));
414 if (return_obj
.length
) {
415 acpi_os_printf("Evaluation of %s returned object %p, "
416 "external buffer length %X\n",
417 pathname
, return_obj
.pointer
,
418 (u32
)return_obj
.length
);
420 acpi_db_dump_external_object(return_obj
.pointer
, 1);
421 acpi_os_printf("\n");
426 /* Ignore status from method execution */
430 /* Update count, check if we have executed enough methods */
434 /*******************************************************************************
436 * FUNCTION: acpi_db_walk_for_execute
438 * PARAMETERS: Callback from walk_namespace
442 * DESCRIPTION: Batch execution function. Evaluates all "predefined" objects --
443 * the nameseg begins with an underscore.
445 ******************************************************************************/
448 acpi_db_walk_for_execute(acpi_handle obj_handle
,
449 u32 nesting_level
, void *context
, void **return_value
)
451 struct acpi_namespace_node
*node
=
452 (struct acpi_namespace_node
*)obj_handle
;
453 struct acpi_db_execute_walk
*info
=
454 (struct acpi_db_execute_walk
*)context
;
456 const union acpi_predefined_info
*predefined
;
458 predefined
= acpi_ut_match_predefined_method(node
->name
.ascii
);
463 if (node
->type
== ACPI_TYPE_LOCAL_SCOPE
) {
467 acpi_db_evaluate_object(node
);
469 /* Ignore status from object evaluation */
473 /* Update count, check if we have executed enough methods */
476 if (info
->count
>= info
->max_count
) {
477 status
= AE_CTRL_TERMINATE
;
483 /*******************************************************************************
485 * FUNCTION: acpi_db_walk_for_execute_all
487 * PARAMETERS: Callback from walk_namespace
491 * DESCRIPTION: Batch execution function. Evaluates all objects whose path ends
492 * with the nameseg "Info->NameSeg". Used for the "ALL" command.
494 ******************************************************************************/
497 acpi_db_walk_for_execute_all(acpi_handle obj_handle
,
499 void *context
, void **return_value
)
501 struct acpi_namespace_node
*node
=
502 (struct acpi_namespace_node
*)obj_handle
;
503 struct acpi_db_execute_walk
*info
=
504 (struct acpi_db_execute_walk
*)context
;
507 if (!ACPI_COMPARE_NAMESEG(node
->name
.ascii
, info
->name_seg
)) {
511 if (node
->type
== ACPI_TYPE_LOCAL_SCOPE
) {
515 /* Now evaluate the input object (node) */
517 acpi_db_evaluate_object(node
);
519 /* Ignore status from method execution */
523 /* Update count of executed methods/objects */
529 /*******************************************************************************
531 * FUNCTION: acpi_db_evaluate_predefined_names
537 * DESCRIPTION: Namespace batch execution. Execute predefined names in the
538 * namespace, up to the max count, if specified.
540 ******************************************************************************/
542 void acpi_db_evaluate_predefined_names(void)
544 struct acpi_db_execute_walk info
;
547 info
.max_count
= ACPI_UINT32_MAX
;
549 /* Search all nodes in namespace */
551 (void)acpi_walk_namespace(ACPI_TYPE_ANY
, ACPI_ROOT_OBJECT
,
552 ACPI_UINT32_MAX
, acpi_db_walk_for_execute
,
553 NULL
, (void *)&info
, NULL
);
555 acpi_os_printf("Evaluated %u predefined names in the namespace\n",
559 /*******************************************************************************
561 * FUNCTION: acpi_db_evaluate_all
563 * PARAMETERS: none_acpi_gbl_db_method_info
567 * DESCRIPTION: Namespace batch execution. Implements the "ALL" command.
568 * Execute all namepaths whose final nameseg matches the
571 ******************************************************************************/
573 void acpi_db_evaluate_all(char *name_seg
)
575 struct acpi_db_execute_walk info
;
578 info
.max_count
= ACPI_UINT32_MAX
;
579 ACPI_COPY_NAMESEG(info
.name_seg
, name_seg
);
580 info
.name_seg
[ACPI_NAMESEG_SIZE
] = 0;
582 /* Search all nodes in namespace */
584 (void)acpi_walk_namespace(ACPI_TYPE_ANY
, ACPI_ROOT_OBJECT
,
585 ACPI_UINT32_MAX
, acpi_db_walk_for_execute_all
,
586 NULL
, (void *)&info
, NULL
);
588 acpi_os_printf("Evaluated %u names in the namespace\n", info
.count
);