acdebug.h 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290
  1. /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
  2. /******************************************************************************
  3. *
  4. * Name: acdebug.h - ACPI/AML debugger
  5. *
  6. * Copyright (C) 2000 - 2022, Intel Corp.
  7. *
  8. *****************************************************************************/
  9. #ifndef __ACDEBUG_H__
  10. #define __ACDEBUG_H__
  11. /* The debugger is used in conjunction with the disassembler most of time */
  12. #ifdef ACPI_DISASSEMBLER
  13. #include "acdisasm.h"
  14. #endif
  15. #define ACPI_DEBUG_BUFFER_SIZE 0x4000 /* 16K buffer for return objects */
  16. #define ACPI_DEBUG_LENGTH_FORMAT " (%.4X bits, %.3X bytes)"
  17. struct acpi_db_command_info {
  18. const char *name; /* Command Name */
  19. u8 min_args; /* Minimum arguments required */
  20. };
  21. struct acpi_db_command_help {
  22. u8 line_count; /* Number of help lines */
  23. char *invocation; /* Command Invocation */
  24. char *description; /* Command Description */
  25. };
  26. struct acpi_db_argument_info {
  27. const char *name; /* Argument Name */
  28. };
  29. struct acpi_db_execute_walk {
  30. u32 count;
  31. u32 max_count;
  32. char name_seg[ACPI_NAMESEG_SIZE + 1];
  33. };
  34. #define PARAM_LIST(pl) pl
  35. #define EX_NO_SINGLE_STEP 1
  36. #define EX_SINGLE_STEP 2
  37. #define EX_ALL 4
  38. /*
  39. * dbxface - external debugger interfaces
  40. */
  41. ACPI_DBR_DEPENDENT_RETURN_OK(acpi_status
  42. acpi_db_single_step(struct acpi_walk_state
  43. *walk_state,
  44. union acpi_parse_object *op,
  45. u32 op_type))
  46. ACPI_DBR_DEPENDENT_RETURN_VOID(void
  47. acpi_db_signal_break_point(struct
  48. acpi_walk_state
  49. *walk_state))
  50. /*
  51. * dbcmds - debug commands and output routines
  52. */
  53. struct acpi_namespace_node *acpi_db_convert_to_node(char *in_string);
  54. void acpi_db_display_table_info(char *table_arg);
  55. void acpi_db_display_template(char *buffer_arg);
  56. void acpi_db_unload_acpi_table(char *name);
  57. void acpi_db_send_notify(char *name, u32 value);
  58. void acpi_db_display_interfaces(char *action_arg, char *interface_name_arg);
  59. acpi_status acpi_db_sleep(char *object_arg);
  60. void acpi_db_trace(char *enable_arg, char *method_arg, char *once_arg);
  61. void acpi_db_display_locks(void);
  62. void acpi_db_display_resources(char *object_arg);
  63. ACPI_HW_DEPENDENT_RETURN_VOID(void acpi_db_display_gpes(void))
  64. void acpi_db_display_handlers(void);
  65. ACPI_HW_DEPENDENT_RETURN_VOID(void
  66. acpi_db_generate_gpe(char *gpe_arg,
  67. char *block_arg))
  68. ACPI_HW_DEPENDENT_RETURN_VOID(void acpi_db_generate_sci(void))
  69. void acpi_db_execute_test(char *type_arg);
  70. /*
  71. * dbconvert - miscellaneous conversion routines
  72. */
  73. acpi_status acpi_db_hex_char_to_value(int hex_char, u8 *return_value);
  74. acpi_status acpi_db_convert_to_package(char *string, union acpi_object *object);
  75. acpi_status
  76. acpi_db_convert_to_object(acpi_object_type type,
  77. char *string, union acpi_object *object);
  78. u8 *acpi_db_encode_pld_buffer(struct acpi_pld_info *pld_info);
  79. void acpi_db_dump_pld_buffer(union acpi_object *obj_desc);
  80. /*
  81. * dbmethod - control method commands
  82. */
  83. void
  84. acpi_db_set_method_breakpoint(char *location,
  85. struct acpi_walk_state *walk_state,
  86. union acpi_parse_object *op);
  87. void acpi_db_set_method_call_breakpoint(union acpi_parse_object *op);
  88. void acpi_db_set_method_data(char *type_arg, char *index_arg, char *value_arg);
  89. acpi_status acpi_db_disassemble_method(char *name);
  90. void acpi_db_disassemble_aml(char *statements, union acpi_parse_object *op);
  91. void acpi_db_evaluate_predefined_names(void);
  92. void acpi_db_evaluate_all(char *name_seg);
  93. /*
  94. * dbnames - namespace commands
  95. */
  96. void acpi_db_set_scope(char *name);
  97. void acpi_db_dump_namespace(char *start_arg, char *depth_arg);
  98. void acpi_db_dump_namespace_paths(void);
  99. void acpi_db_dump_namespace_by_owner(char *owner_arg, char *depth_arg);
  100. acpi_status acpi_db_find_name_in_namespace(char *name_arg);
  101. void acpi_db_check_predefined_names(void);
  102. acpi_status
  103. acpi_db_display_objects(char *obj_type_arg, char *display_count_arg);
  104. void acpi_db_check_integrity(void);
  105. void acpi_db_find_references(char *object_arg);
  106. void acpi_db_get_bus_info(void);
  107. acpi_status acpi_db_display_fields(u32 address_space_id);
  108. /*
  109. * dbdisply - debug display commands
  110. */
  111. void acpi_db_display_method_info(union acpi_parse_object *op);
  112. void acpi_db_decode_and_display_object(char *target, char *output_type);
  113. ACPI_DBR_DEPENDENT_RETURN_VOID(void
  114. acpi_db_display_result_object(union
  115. acpi_operand_object
  116. *obj_desc,
  117. struct
  118. acpi_walk_state
  119. *walk_state))
  120. acpi_status acpi_db_display_all_methods(char *display_count_arg);
  121. void acpi_db_display_arguments(void);
  122. void acpi_db_display_locals(void);
  123. void acpi_db_display_results(void);
  124. void acpi_db_display_calling_tree(void);
  125. void acpi_db_display_object_type(char *object_arg);
  126. ACPI_DBR_DEPENDENT_RETURN_VOID(void
  127. acpi_db_display_argument_object(union
  128. acpi_operand_object
  129. *obj_desc,
  130. struct
  131. acpi_walk_state
  132. *walk_state))
  133. /*
  134. * dbexec - debugger control method execution
  135. */
  136. void
  137. acpi_db_execute(char *name, char **args, acpi_object_type *types, u32 flags);
  138. void
  139. acpi_db_create_execution_thread(char *method_name_arg,
  140. char **arguments, acpi_object_type *types);
  141. void
  142. acpi_db_create_execution_threads(char *num_threads_arg,
  143. char *num_loops_arg, char *method_name_arg);
  144. void acpi_db_delete_objects(u32 count, union acpi_object *objects);
  145. #ifdef ACPI_DBG_TRACK_ALLOCATIONS
  146. u32 acpi_db_get_cache_info(struct acpi_memory_list *cache);
  147. #endif
  148. /*
  149. * dbfileio - Debugger file I/O commands
  150. */
  151. acpi_object_type
  152. acpi_db_match_argument(char *user_argument,
  153. struct acpi_db_argument_info *arguments);
  154. void acpi_db_close_debug_file(void);
  155. void acpi_db_open_debug_file(char *name);
  156. acpi_status acpi_db_load_acpi_table(char *filename);
  157. acpi_status acpi_db_load_tables(struct acpi_new_table_desc *list_head);
  158. /*
  159. * dbhistry - debugger HISTORY command
  160. */
  161. void acpi_db_add_to_history(char *command_line);
  162. void acpi_db_display_history(void);
  163. char *acpi_db_get_from_history(char *command_num_arg);
  164. char *acpi_db_get_history_by_index(u32 commandd_num);
  165. /*
  166. * dbinput - user front-end to the AML debugger
  167. */
  168. acpi_status
  169. acpi_db_command_dispatch(char *input_buffer,
  170. struct acpi_walk_state *walk_state,
  171. union acpi_parse_object *op);
  172. void ACPI_SYSTEM_XFACE acpi_db_execute_thread(void *context);
  173. acpi_status acpi_db_user_commands(void);
  174. char *acpi_db_get_next_token(char *string,
  175. char **next, acpi_object_type *return_type);
  176. /*
  177. * dbobject
  178. */
  179. void acpi_db_decode_internal_object(union acpi_operand_object *obj_desc);
  180. void
  181. acpi_db_display_internal_object(union acpi_operand_object *obj_desc,
  182. struct acpi_walk_state *walk_state);
  183. void acpi_db_decode_arguments(struct acpi_walk_state *walk_state);
  184. void acpi_db_decode_locals(struct acpi_walk_state *walk_state);
  185. void
  186. acpi_db_dump_method_info(acpi_status status,
  187. struct acpi_walk_state *walk_state);
  188. /*
  189. * dbstats - Generation and display of ACPI table statistics
  190. */
  191. void acpi_db_generate_statistics(union acpi_parse_object *root, u8 is_method);
  192. acpi_status acpi_db_display_statistics(char *type_arg);
  193. /*
  194. * dbutils - AML debugger utilities
  195. */
  196. void acpi_db_set_output_destination(u32 where);
  197. void acpi_db_dump_external_object(union acpi_object *obj_desc, u32 level);
  198. void acpi_db_prep_namestring(char *name);
  199. struct acpi_namespace_node *acpi_db_local_ns_lookup(char *name);
  200. void acpi_db_uint32_to_hex_string(u32 value, char *buffer);
  201. #endif /* __ACDEBUG_H__ */