Tidy up Espressif ESP32 test and benchmark examples #5800

gojimmypi · 2022-11-18T17:36:17Z

Description

This PR addresses #5795 and cleans up the benchmark and test Espressif examples.

Of particular interest:

Update wolfcrypt esp32_sha.c and sha256.c to now report unexpected reentry as verbose log rather than error message.
wolfcrypt/test.c now returns args.return_code when WOLFSSL_ESPIDF is defined. (here)
wolfcrypt/test.h now declares int wolf_test_task(void) when WOLFSSL_ESPIDF is defined. (here)

Other changes:

Benchmark example no longer runs tests; Each example is fully separate
Fixed Test example that was missing code files; No longer installed locally, uses latest installed version.
setup.sh no longer copies benchmark.c(.h) to local project directory.
Rename benchmark/main and test/main filenames from helper.c to main.c, cleaned up code.
Added main.h
Revised main/CMakeLists.txt to use only main.c
Set components main and wolfssl for project CMakeLists.txt
Added libs/Tigard.cfg file for Tigard JTAG debugger.
Update sdkconfig.defaults with compiler optimizations and stack check.
Added VisualGDB Project file & Visual Studio solution file.
Added optional time_helper for wolfssl_test
Exclude ssl_misc.c in component cmake to fix warning: #warning ssl_misc.c does not need to be compiled separately from ssl.c

Fixes zd# (n/a)

Testing

Delete wolfssl component in ESP-IDF components directory. Reminder: there may be multiple versions in esp32\esp-idf\vX.Y.Z

Install fresh wolfssl component with ./setup.sh from ESP-IDF directory.

Assuming Espressif ESP-IDF in /mnt/c/SysGCC/esp32/esp-idf (e.g. VisualGDB), ensure ESP-IDF environment is configured:

. /mnt/c/SysGCC/esp32/esp-idf/v4.4.1/export.sh

Assuming ESP32 on COM20 / ttyS20:

 idf.py clean build flash -p /dev/ttyS20 -b 921600 monitor

Observe output.

Successful output examples added to benchmark and test README.md files.

Checklist

added tests
updated/added doxygen
updated appropriate READMEs
Updated manual and documentation

miyazakh · 2022-11-22T06:24:47Z

Run crypt, bench, client and server on my MCU, ESP32-D0WDQ6-V3. Crypt and Bench work fine! On client and server, I am seeing many message like below:

I (208745) wolf_hw_sha: >>>> Hardware in use; Mode REVERT to ESP32_SHA_SW
I (208745) wolf_hw_sha: >>>> Hardware in use; Mode REVERT to ESP32_SHA_SW
I (208745) wolf_hw_sha: >>>> Hardware in use; Mode REVERT to ESP32_SHA_SW
I (208755) wolf_hw_sha: >>>> Hardware in use; Mode REVERT to ESP32_SHA_SW
I (208755) wolf_hw_sha: >>>> Hardware in use; Mode REVERT to ESP32_SHA_SW

We would want to display these message when user sets verbose to high?

IDE/Espressif/ESP-IDF/examples/wolfssl_benchmark/main/main.c

IDE/Espressif/ESP-IDF/examples/wolfssl_test/main/main.c

JacobBarthelmeh · 2022-11-22T17:38:15Z

IDE/Espressif/ESP-IDF/UPDATE.md

@@ -0,0 +1,23 @@
+# Espressif Updates


Do we want these new files to get bundled into the wolfSSL dist? They will need added to one of the include.am's if so.

That's a good question. I don't know. What are the benefits of including in wolfSSL dist?

It's a little subjective if this UPDATE.md would be helpful or not in the distribution, I'd recommend though giving the dist bundle a try and making sure all files wanted are in it. On a unix like system with autoconf this is doing something like "./configure && ./config.status && make dist-zip" which will make the wolfssl-X.X.X.zip distribution having similar files to what would be sent out in release bundles.

gojimmypi · 2022-11-23T01:04:46Z

We would want to display these message when user sets verbose to high?
@miyazakh yes, the ESP_LOGI has been changed to ESP_LOGV

@kaleb-himes I've added a few commits to address your suggestions.

I've also added 4 new files for VisualGDB projects created when I was testing the wolfssl_client and wolfssl_server examples.

Also - there's a new default stack size of 55,000 for the benchmark sdkconfig.

…essif_fix_5795

dgarske

Looks good, just a few small things.

wolfcrypt/test/test.c

dgarske · 2022-11-29T00:22:43Z

wolfcrypt/src/sha256.c

         */
        InitSha256(sha256); /* unlock mutex, set mode to ESP32_SHA_INIT */
-        ESP_LOGE("sha256", "ERROR: hardware unlock needed in wc_Sha256Free");
+        ESP_LOGV("sha256", "ERROR: hardware unlock needed in wc_Sha256Free");


This indicates "ERROR" but is flagged as verbose. Please fix the message or leave as LOGE.

The text of the message has been updated.

dgarske · 2022-11-29T00:25:24Z

IDE/Espressif/ESP-IDF/examples/wolfssl_test/main/time_helper.h

@@ -0,0 +1,30 @@
+#pragma once


I am okay with pragma, but the #ifndef _TIME_HELPER_H syntax is more portable.

I was not aware of portability issues. Noted and changed.

dgarske · 2022-11-29T00:25:35Z

IDE/Espressif/ESP-IDF/examples/wolfssl_test/main/time_helper.h

+
+#ifdef __cplusplus
+} /* extern "C" */
+#endif


Make sure you have a new line at end.

dgarske · 2022-11-29T00:25:52Z

IDE/Espressif/ESP-IDF/examples/wolfssl_test/main/time_helper.c

+
+#ifndef TIME_ZONE
+    #define TIME_ZONE "PST-8"
+#endif // !#define TIME_ZONE


Use C style /* */ comments. Thanks!

IDE/Espressif/ESP-IDF/examples/wolfssl_test/main/main.c

dgarske · 2022-11-29T00:28:39Z

IDE/Espressif/ESP-IDF/examples/wolfssl_test/main/main.c

+/* free slot array       */
+void my_atmel_free(int slotId)
+{
+    if(slotId >= 0 && slotId < ATECC_MAX_SLOT){


if ( and ) {

dgarske · 2022-11-29T00:28:58Z

IDE/Espressif/ESP-IDF/examples/wolfssl_test/main/main.c

+/* allocate slot depending on slotType */
+int my_atmel_alloc(int slotType)
+{
+    int i, slot = -1;


Use ATECC_INVALID_SLOT, not -1.

ah yes, much better.

Tidy up Espressif ESP32 test and benchmark examples

07ceb86

gojimmypi requested review from cconlon, dgarske, kaleb-himes and miyazakh November 18, 2022 17:36

gojimmypi self-assigned this Nov 18, 2022

dgarske self-assigned this Nov 21, 2022

gojimmypi linked an issue Nov 21, 2022 that may be closed by this pull request

[Bug]: Espressif benchmark and test examples fail to compile #5795

Closed

dgarske requested review from JacobBarthelmeh and removed request for cconlon and kaleb-himes November 21, 2022 18:18

dgarske assigned JacobBarthelmeh and unassigned dgarske and gojimmypi Nov 21, 2022

JacobBarthelmeh requested changes Nov 22, 2022

View reviewed changes

JacobBarthelmeh assigned gojimmypi and unassigned JacobBarthelmeh Nov 22, 2022

gojimmypi added 6 commits November 22, 2022 15:46

add VisualGDB project and solution files for server and client

4287e61

"hardware in use revert to software" is now verbose level message

2b5bde2

Remove (void) TAG; - not needed to appease compiler

05ab72c

include esp_log.h lib with defined(WOLFSSL_ESPIDF)

d2cae2a

large ESP32 default stack size

3380545

check for max number of arguments assembled into array

8a4193b

gojimmypi assigned JacobBarthelmeh and unassigned gojimmypi Nov 23, 2022

gojimmypi requested a review from JacobBarthelmeh November 23, 2022 01:07

Merge branch 'master' of https://github.com/wolfSSL/wolfssl into Espr…

75488c5

…essif_fix_5795

gojimmypi mentioned this pull request Nov 23, 2022

[Bug]: Compile-time error when defining GENERATE_MACHINE_PARSEABLE_REPORT #5814

Closed

miyazakh approved these changes Nov 24, 2022

View reviewed changes

JacobBarthelmeh approved these changes Nov 28, 2022

View reviewed changes

JacobBarthelmeh assigned dgarske and unassigned JacobBarthelmeh Nov 28, 2022

dgarske requested changes Nov 29, 2022

View reviewed changes

dgarske assigned gojimmypi and unassigned dgarske Nov 29, 2022

gojimmypi added 3 commits November 29, 2022 19:12

cleanup & comments per code review

865a32a

wolfssl_test VisualGDB updates

cb94f7c

Espressif wolfssl_test default stack 55,000 bytes

d3e93e8

gojimmypi assigned dgarske Nov 30, 2022

dgarske approved these changes Nov 30, 2022

View reviewed changes

dgarske merged commit fec7469 into wolfSSL:master Nov 30, 2022

gojimmypi mentioned this pull request Dec 8, 2022

Benchmark Enhancements and Code Cleanup #5871

Merged

4 tasks

gojimmypi mentioned this pull request Jun 17, 2025

change(esp-tls): Improve support for wolfssl (IDFGH-15505) espressif/esp-idf#16145

Open

6 tasks

Tidy up Espressif ESP32 test and benchmark examples #5800

Tidy up Espressif ESP32 test and benchmark examples #5800

Uh oh!

Conversation

gojimmypi commented Nov 18, 2022

Description

Testing

Checklist

Uh oh!

miyazakh commented Nov 22, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gojimmypi commented Nov 23, 2022

Uh oh!

dgarske left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

miyazakh commented Nov 22, 2022 •

edited

Loading