perfmon.rst 778 B

123456789101112131415161718192021222324252627282930313233
  1. Performance Monitor
  2. ===================
  3. .. only:: esp32s3
  4. .. warning::
  5. This feature is not supported in v4.4
  6. The Performance Monitor component provides APIs to use {IDF_TARGET_NAME} internal performance counters to profile functions and
  7. applications.
  8. Application Example
  9. -------------------
  10. An example which combines performance monitor is provided in ``examples/system/perfmon`` directory.
  11. This example initializes the performance monitor structure and execute them with printing the statistics.
  12. High level API Reference
  13. ------------------------
  14. Header Files
  15. ^^^^^^^^^^^^
  16. * :component_file:`perfmon/include/perfmon.h`
  17. API Reference
  18. -------------
  19. .. include-build-file:: inc/xtensa_perfmon_access.inc
  20. .. include-build-file:: inc/xtensa_perfmon_apis.inc