espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-07-30 18:57:19 +02:00
Code Issues Packages Projects Releases Wiki Activity

perfmon: re-enable example for ESP32-S3, remove warning from the docs

Browse Source 
Includes minor fix for formatting of code blocks in the example readme
This commit is contained in:
Ivan Grokhotkov
2022-01-10 22:54:38 +01:00
parent 1e80a52de4
commit faac0e7589
2 changed files with 333 additions and 341 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/en/api-reference/system/perfmon.rst
View File

@ -1,15 +1,7 @@
Performance Monitor
===================
.. only:: esp32s3
.. warning::
This feature is not supported in v4.4
The Performance Monitor component provides APIs to use {IDF_TARGET_NAME} internal performance counters to profile functions and
applications.
The Performance Monitor component provides APIs to use {IDF_TARGET_NAME} internal performance counters to profile functions and applications.
Application Example
-------------------

24
examples/system/perfmon/README.md
View File

@ -1,5 +1,5 @@
| Supported Targets | ESP32 | ESP32-S2 |
| ----------------- | ----- | -------- |
| Supported Targets | ESP32 | ESP32-S2 | ESP32-S3 |
| ----------------- | ----- | -------- | -------- |
# Performance Monitor (`perfmon`) example
@ -16,13 +16,7 @@ The example contain test function that will be executed with perfmon component a
### Hardware Required
Example should be able to run on any commonly available ESP32 development board.
### Configure the project
```
idf.py menuconfig
```
Example should be able to run on any commonly available ESP32, ESP32-S2 or ESP32-S3 development board. `perfmon` component isn't supported on Espressif chips with RISC-V CPU architecture.
### Build and Flash
@ -36,9 +30,11 @@ See the [Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/l
## Example Output
1. Example starts and call first test. The first test call test function 'exec_test_function'
1. Example starts and calls the first test. This test calls the test function `exec_test_function` 200 times and collects all CPU performance metrics.
```bash
<details><summary>Example log output:</summary>
```
I (288) example: Start
I (288) example: Start test with printing all available statistic
Value = 750, select = 0, mask = 0001. Counts cycles.
@ -319,8 +315,11 @@ Value = 0, select = 28, mask = 2000. Length of Instructions.
Value = 0, select = 28, mask = 4000. Length of Instructions.
128-bit
```
</details>
2. Example calls second test.
2. Example calls the second test, which runs the same function under tests. This time, a user-provided list of metrics is measured.
<details><summary>Example log output:</summary>
```
I (1588) example: Start test with user defined statistic
@ -366,3 +365,4 @@ Value = 0, select = 1, mask = 0001. Overflow of counter.
I (1788) example: The End
```
</details>