Espressif ESP32-C3 ESP32-C6 ESP32-S2 Hardware Acceleration #6990

gojimmypi · 2023-11-20T21:17:32Z

Description

Add Hardware Encryption Acceleration for ESP32-C3, ESP32-C6, and ESP32-S2.

Feature parity is with original ESP32. There are additional hardware accleration features for some targets to be addressed in a separate PR.

See Chip Series Comparison

This PR builds upon the prior work in #6624. Included is support for all of the current Espressif ESP-IDF v5.1 targets:

esp32 - HW acceleration included prior PR
esp32s2 - HW acceleration included this PR
esp32c3 - HW acceleration included this PR
esp32s3 - HW acceleration included prior PR
esp32c2 - no HW acceleration yet
esp32c6 - HW acceleration included this PR
esp32h2 - no HW acceleration yet

See idf.py --list-targets.

With the 5 examples and 7 different targets, there are now 35 builds to check. At some point we may consider moving some (all?) of the examples to wolfssl-examples.

In the meantime, I've been testing with a revised compileAllExamples.sh to test all the builds. I need to parallelize it before including it in a PR.

Not included in this PR:

Although this PR will work with all Espressif targets, not all wolfSSL examples work without some minor target-specific attention. Rather than muddy up this PR with changes to examples, I'll be submitting a separate PR soon for the minor changes needed. See also pending TLS1.3 examples update in #6844.

See #6234 for a roadmap of Espressif updates.

Fixes zd# n/a/

Testing

How did you test?

For testing wolfSSL from Linux or WSL:

git clone https://github.com/gojimmypi/wolfssl.git
cd wolfssl
git checkout PR-Espressif-C3-C6-S2-HW

# Testing Linux
./autogen.sh
./configure --enable-all
git fetch
git pull
git status
make clean && make && ./wolfcrypt/test/testwolfcrypt

# Testing ESP-IDF
cd IDE/Espressif/ESP-IDF
. /mnt/c/SysGCC/esp32/esp-idf/v5.1/export.sh

./compileAllExamples.sh

idf.py flash -p /dev/ttyS35 -b 115200 monitor

See espressif/esp-idf #10423 for ESP32-C6 development status.

See #6234 for Espressif Roadmap and related wolfSSL updates.

Checklist

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

bandi13 · 2023-11-20T21:38:50Z

wolfssl/wolfcrypt/port/Espressif/esp32-crypt.h


 /* MP_HW_FALLBACK: signal to caller to fall back to SW for math:
 *   algorithm not supported in SW
 *   known state needing only SW, (e.g. ctx copy)
 *   any other reason to force SW */
-#define MP_HW_FALLBACK (-108)
+#define MP_HW_FALLBACK ESP_MP_HW_FALLBACK  /* was -108 */


Having comments in macro definitions can have unusual unintended consequences. Recommend instead putting it into the comment block above.

Good point on the macro comments. I've updated those and adjusted some line lengths.

gojimmypi · 2023-11-20T22:03:52Z

Jenkins retest this please.

gojimmypi · 2023-11-21T04:09:02Z

Jenkins retest this please.

dgarske · 2023-11-21T18:57:53Z

wolfcrypt/src/port/Espressif/README.md


-* Uncomment out `#define WOLFSSL_ESPIDF` in `/path/to/wolfssl/wolfssl/wolfcrypt/settings.h`
-* Uncomment out `#define WOLFSSL_ESP32` in `/path/to/wolfssl/wolfssl/wolfcrypt/settings.h`
+Hardware acceleration is enabled by default.


Add note to where the build macro detection for HW acceleration is done.

Ah yes, I missed that README file. I've corrected that and added more detail.

dgarske · 2023-11-21T18:59:01Z

wolfcrypt/src/sha.c

        #if defined(WOLFSSL_USE_ESP32_CRYPT_HASH_HW)
            if (sha->ctx.mode == ESP32_SHA_INIT) {
-                ESP_LOGV(TAG, "wc_ShaUpdate try hardware");
+                #if defined(DEBUG_WOLFSSL_SHA_MUTEX)


I don't like adding another new macro just for this. Can we use an existing macro or use a more generic name?

Agreed. I could not find a similar "mutex tracking" macro, so I renamed this one to a generic WOLFSSL_DEBUG_MUTEX.

dgarske · 2023-11-21T19:02:39Z

wolfcrypt/src/sha.c

+#if (defined(CONFIG_IDF_TARGET_ESP32C3) || defined(CONFIG_IDF_TARGET_ESP32C6)) && \
+     defined(WOLFSSL_ESP32_CRYPT) && !defined(NO_WOLFSSL_ESP32_CRYPT_HASH)
+if (sha->ctx.mode == ESP32_SHA_HW) {
+    /* TODO is this the proper way to reverse endianness for the 64bit Espressif value?


Can you use ByteReverseWord64 and fix this?

Good question! I dug a bit more on that & no: in the ByteReverseWord64 the "64" is meant for 64-bit architectures, not so much to just byte reverse a 64 bit word. The implementation fall back to the regular ByteReverseWords (a 32 bit-optimized function, perfect for the 32-bit Xtensa / RISC-V).

I removed the comment.

dgarske · 2023-11-21T19:03:17Z

wolfcrypt/src/sha256.c

+     */
+    static int set_default_digest256(wc_Sha256* sha256)
+    {
+        return 0;  /* TODO not used? */


Red flag... This is all dead code below. Please cleanup/fix.

Oops. My bad, That's code meant for future optimizations. Removed.

dgarske · 2023-11-21T19:05:02Z

wolfssl/wolfcrypt/settings.h

+            #error "WOLFSSL_SP_RISCV32 can only be used on RISC-V architecture"
+        #endif
+    #endif
+    #if defined(WOLFSSL_SM2) || defined(WOLFSSL_SM3) || defined(WOLFSSL_SM4)


@SparkiDev is there value in doing this globally in settings.h? Seems like this could be refined a bit as some of the options are just SM4 specific.

dgarske

Looks good to me.

gojimmypi · 2023-11-22T01:19:38Z

Jenkins retest this please.

wolfcrypt/src/port/Espressif/esp32_sha.c

JacobBarthelmeh · 2023-11-22T21:03:53Z

Assigning to @gojimmypi for merge conflict and had one question. Looks good otherwise, thanks!

gojimmypi · 2023-11-22T21:20:11Z

Back to you @JacobBarthelmeh :) merge conflict resolved. Thank you

gojimmypi · 2023-11-23T00:14:48Z

See #6844 for Espressif example updates to fully utilize this PR.

gojimmypi self-assigned this Nov 20, 2023

gojimmypi added enhancement New Chipset labels Nov 20, 2023

gojimmypi requested a review from dgarske November 20, 2023 21:26

gojimmypi mentioned this pull request Nov 20, 2023

ESP32-C6 support status (IDFGH-9013) espressif/esp-idf#10423

Closed

96 tasks

bandi13 reviewed Nov 20, 2023

View reviewed changes

Espressif ESP32-C3 ESP32-C6 ESP32-S2 Hardware Acceleration

7e69030

gojimmypi force-pushed the PR-Espressif-C3-C6-S2-HW branch from ca41df5 to 7e69030 Compare November 21, 2023 02:05

dgarske requested changes Nov 21, 2023

View reviewed changes

code review updates for ESP32 C3/C6/S2 HW Acceleration

9227020

gojimmypi requested a review from dgarske November 22, 2023 00:23

gojimmypi assigned dgarske Nov 22, 2023

dgarske previously approved these changes Nov 22, 2023

View reviewed changes

dgarske assigned wolfSSL-Bot and unassigned dgarske and gojimmypi Nov 22, 2023

gojimmypi added a commit to gojimmypi/wolfssl that referenced this pull request Nov 22, 2023

Update all Expressif examples, ready for PR wolfSSL#6990

5b01270

gojimmypi mentioned this pull request Nov 22, 2023

Espressif ESP32 Benchmark, Test, TLS 1.3 Client & Server Updates #6844

Merged

4 tasks

JacobBarthelmeh previously approved these changes Nov 22, 2023

View reviewed changes

wolfcrypt/src/port/Espressif/esp32_sha.c Show resolved Hide resolved

JacobBarthelmeh assigned gojimmypi and unassigned wolfSSL-Bot Nov 22, 2023

Upstream merge + resolve conflict.

2da8811

gojimmypi dismissed stale reviews from JacobBarthelmeh and dgarske via 2da8811 November 22, 2023 21:17

gojimmypi requested a review from JacobBarthelmeh November 22, 2023 21:19

gojimmypi assigned JacobBarthelmeh Nov 22, 2023

JacobBarthelmeh approved these changes Nov 22, 2023

View reviewed changes

JacobBarthelmeh merged commit 2e89e46 into wolfSSL:master Nov 22, 2023
106 checks passed

This was referenced Dec 6, 2023

ESP32 Espressif Improvements - Roadmap Summary #6234

Open

Add wolfSSL Encryption Library Support for Espressif ESP32-C6 #6163

Closed

gojimmypi mentioned this pull request Dec 31, 2023

Missing explicit support for Espressif ESP32 WROVER, C3, S3 #5215

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Espressif ESP32-C3 ESP32-C6 ESP32-S2 Hardware Acceleration #6990

Espressif ESP32-C3 ESP32-C6 ESP32-S2 Hardware Acceleration #6990

gojimmypi commented Nov 20, 2023 •

edited

Loading

bandi13 Nov 20, 2023

gojimmypi Nov 21, 2023

gojimmypi commented Nov 20, 2023

gojimmypi commented Nov 21, 2023

dgarske Nov 21, 2023

gojimmypi Nov 22, 2023

dgarske Nov 21, 2023

gojimmypi Nov 22, 2023

dgarske Nov 21, 2023

gojimmypi Nov 22, 2023

dgarske Nov 21, 2023

gojimmypi Nov 22, 2023

dgarske Nov 21, 2023

dgarske left a comment

gojimmypi commented Nov 22, 2023 •

edited by JacobBarthelmeh

Loading

JacobBarthelmeh commented Nov 22, 2023

gojimmypi commented Nov 22, 2023

gojimmypi commented Nov 23, 2023

Espressif ESP32-C3 ESP32-C6 ESP32-S2 Hardware Acceleration #6990

Espressif ESP32-C3 ESP32-C6 ESP32-S2 Hardware Acceleration #6990

Conversation

gojimmypi commented Nov 20, 2023 • edited Loading

Description

Not included in this PR:

Testing

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gojimmypi commented Nov 20, 2023

gojimmypi commented Nov 21, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dgarske left a comment

Choose a reason for hiding this comment

gojimmypi commented Nov 22, 2023 • edited by JacobBarthelmeh Loading

JacobBarthelmeh commented Nov 22, 2023

gojimmypi commented Nov 22, 2023

gojimmypi commented Nov 23, 2023

gojimmypi commented Nov 20, 2023 •

edited

Loading

gojimmypi commented Nov 22, 2023 •

edited by JacobBarthelmeh

Loading