app_trace.rst 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. Application Level Tracing
  2. =========================
  3. Overview
  4. --------
  5. IDF provides useful feature for program behaviour analysis: application level tracing. It is implemented in the corresponding library and can be enabled via menuconfig. This feature allows to transfer arbitrary data between host and ESP32 via JTAG interface with small overhead on program execution.
  6. Developers can use this library to send application specific state of execution to the host and receive commands or other type of info in the opposite direction at runtime. The main use cases of this library are:
  7. 1. System behaviour analysis.
  8. 2. Lightweight logging to the host.
  9. 3. Collecting application specific data.
  10. API Reference
  11. -------------
  12. Header Files
  13. ^^^^^^^^^^^^
  14. * :component_file:`app_trace/include/esp_app_trace.h`
  15. Macros
  16. ^^^^^^
  17. .. doxygendefine:: ESP_APPTRACE_TMO_INFINITE
  18. Enumerations
  19. ^^^^^^^^^^^^
  20. .. doxygenenum:: esp_apptrace_dest_t
  21. Functions
  22. ^^^^^^^^^
  23. .. doxygenfunction:: esp_apptrace_init
  24. .. doxygenfunction:: esp_apptrace_buffer_get
  25. .. doxygenfunction:: esp_apptrace_buffer_put
  26. .. doxygenfunction:: esp_apptrace_write
  27. .. doxygenfunction:: esp_apptrace_vprintf_to
  28. .. doxygenfunction:: esp_apptrace_vprintf
  29. .. doxygenfunction:: esp_apptrace_read
  30. .. doxygenfunction:: esp_apptrace_flush
  31. .. doxygenfunction:: esp_apptrace_flush_nolock