acdebug.h 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223
  1. /******************************************************************************
  2. *
  3. * Name: acdebug.h - ACPI/AML debugger
  4. *
  5. *****************************************************************************/
  6. /*
  7. * Copyright (C) 2000 - 2007, R. Byron Moore
  8. * All rights reserved.
  9. *
  10. * Redistribution and use in source and binary forms, with or without
  11. * modification, are permitted provided that the following conditions
  12. * are met:
  13. * 1. Redistributions of source code must retain the above copyright
  14. * notice, this list of conditions, and the following disclaimer,
  15. * without modification.
  16. * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  17. * substantially similar to the "NO WARRANTY" disclaimer below
  18. * ("Disclaimer") and any redistribution must be conditioned upon
  19. * including a substantially similar Disclaimer requirement for further
  20. * binary redistribution.
  21. * 3. Neither the names of the above-listed copyright holders nor the names
  22. * of any contributors may be used to endorse or promote products derived
  23. * from this software without specific prior written permission.
  24. *
  25. * Alternatively, this software may be distributed under the terms of the
  26. * GNU General Public License ("GPL") version 2 as published by the Free
  27. * Software Foundation.
  28. *
  29. * NO WARRANTY
  30. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  31. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  32. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  33. * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  34. * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  35. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  36. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  37. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  38. * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  39. * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  40. * POSSIBILITY OF SUCH DAMAGES.
  41. */
  42. #ifndef __ACDEBUG_H__
  43. #define __ACDEBUG_H__
  44. #define ACPI_DEBUG_BUFFER_SIZE 4196
  45. struct command_info {
  46. char *name; /* Command Name */
  47. u8 min_args; /* Minimum arguments required */
  48. };
  49. struct argument_info {
  50. char *name; /* Argument Name */
  51. };
  52. #define PARAM_LIST(pl) pl
  53. #define DBTEST_OUTPUT_LEVEL(lvl) if (acpi_gbl_db_opt_verbose)
  54. #define VERBOSE_PRINT(fp) DBTEST_OUTPUT_LEVEL(lvl) {\
  55. acpi_os_printf PARAM_LIST(fp);}
  56. #define EX_NO_SINGLE_STEP 1
  57. #define EX_SINGLE_STEP 2
  58. /*
  59. * dbxface - external debugger interfaces
  60. */
  61. acpi_status acpi_db_initialize(void);
  62. void acpi_db_terminate(void);
  63. acpi_status
  64. acpi_db_single_step(struct acpi_walk_state *walk_state,
  65. union acpi_parse_object *op, u32 op_type);
  66. /*
  67. * dbcmds - debug commands and output routines
  68. */
  69. acpi_status acpi_db_disassemble_method(char *name);
  70. void acpi_db_display_table_info(char *table_arg);
  71. void acpi_db_unload_acpi_table(char *table_arg, char *instance_arg);
  72. void
  73. acpi_db_set_method_breakpoint(char *location,
  74. struct acpi_walk_state *walk_state,
  75. union acpi_parse_object *op);
  76. void acpi_db_set_method_call_breakpoint(union acpi_parse_object *op);
  77. void acpi_db_get_bus_info(void);
  78. void acpi_db_disassemble_aml(char *statements, union acpi_parse_object *op);
  79. void acpi_db_dump_namespace(char *start_arg, char *depth_arg);
  80. void acpi_db_dump_namespace_by_owner(char *owner_arg, char *depth_arg);
  81. void acpi_db_send_notify(char *name, u32 value);
  82. void acpi_db_set_method_data(char *type_arg, char *index_arg, char *value_arg);
  83. acpi_status
  84. acpi_db_display_objects(char *obj_type_arg, char *display_count_arg);
  85. acpi_status acpi_db_find_name_in_namespace(char *name_arg);
  86. void acpi_db_set_scope(char *name);
  87. acpi_status acpi_db_sleep(char *object_arg);
  88. void acpi_db_find_references(char *object_arg);
  89. void acpi_db_display_locks(void);
  90. void acpi_db_display_resources(char *object_arg);
  91. void acpi_db_display_gpes(void);
  92. void acpi_db_check_integrity(void);
  93. void acpi_db_generate_gpe(char *gpe_arg, char *block_arg);
  94. /*
  95. * dbdisply - debug display commands
  96. */
  97. void acpi_db_display_method_info(union acpi_parse_object *op);
  98. void acpi_db_decode_and_display_object(char *target, char *output_type);
  99. void
  100. acpi_db_display_result_object(union acpi_operand_object *obj_desc,
  101. struct acpi_walk_state *walk_state);
  102. acpi_status acpi_db_display_all_methods(char *display_count_arg);
  103. void acpi_db_display_arguments(void);
  104. void acpi_db_display_locals(void);
  105. void acpi_db_display_results(void);
  106. void acpi_db_display_calling_tree(void);
  107. void acpi_db_display_object_type(char *object_arg);
  108. void
  109. acpi_db_display_argument_object(union acpi_operand_object *obj_desc,
  110. struct acpi_walk_state *walk_state);
  111. /*
  112. * dbexec - debugger control method execution
  113. */
  114. void acpi_db_execute(char *name, char **args, u32 flags);
  115. void
  116. acpi_db_create_execution_threads(char *num_threads_arg,
  117. char *num_loops_arg, char *method_name_arg);
  118. #ifdef ACPI_DBG_TRACK_ALLOCATIONS
  119. u32 acpi_db_get_cache_info(struct acpi_memory_list *cache);
  120. #endif
  121. /*
  122. * dbfileio - Debugger file I/O commands
  123. */
  124. acpi_object_type
  125. acpi_db_match_argument(char *user_argument, struct argument_info *arguments);
  126. void acpi_db_close_debug_file(void);
  127. void acpi_db_open_debug_file(char *name);
  128. acpi_status acpi_db_load_acpi_table(char *filename);
  129. acpi_status
  130. acpi_db_get_table_from_file(char *filename, struct acpi_table_header **table);
  131. acpi_status
  132. acpi_db_read_table_from_file(char *filename, struct acpi_table_header **table);
  133. /*
  134. * dbhistry - debugger HISTORY command
  135. */
  136. void acpi_db_add_to_history(char *command_line);
  137. void acpi_db_display_history(void);
  138. char *acpi_db_get_from_history(char *command_num_arg);
  139. /*
  140. * dbinput - user front-end to the AML debugger
  141. */
  142. acpi_status
  143. acpi_db_command_dispatch(char *input_buffer,
  144. struct acpi_walk_state *walk_state,
  145. union acpi_parse_object *op);
  146. void ACPI_SYSTEM_XFACE acpi_db_execute_thread(void *context);
  147. /*
  148. * dbstats - Generation and display of ACPI table statistics
  149. */
  150. void acpi_db_generate_statistics(union acpi_parse_object *root, u8 is_method);
  151. acpi_status acpi_db_display_statistics(char *type_arg);
  152. /*
  153. * dbutils - AML debugger utilities
  154. */
  155. void acpi_db_set_output_destination(u32 where);
  156. void acpi_db_dump_external_object(union acpi_object *obj_desc, u32 level);
  157. void acpi_db_prep_namestring(char *name);
  158. struct acpi_namespace_node *acpi_db_local_ns_lookup(char *name);
  159. void acpi_db_uint32_to_hex_string(u32 value, char *buffer);
  160. #endif /* __ACDEBUG_H__ */