From d5fda4a2865cb6f80182230003dc73e44f1690f2 Mon Sep 17 00:00:00 2001 From: Jiang Guang Ming Date: Wed, 9 Aug 2023 15:01:20 +0800 Subject: [PATCH] docs: add the description of CONFIG_MBEDTLS_USE_CRYPTO_ROM_IMPL --- docs/en/api-guides/performance/size.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/en/api-guides/performance/size.rst b/docs/en/api-guides/performance/size.rst index 55b200b342..8728456afc 100644 --- a/docs/en/api-guides/performance/size.rst +++ b/docs/en/api-guides/performance/size.rst @@ -408,6 +408,11 @@ The help text for each option has some more information. If depending on third party clients or servers, always pay attention to announcements about future changes to supported TLS features. If not, the {IDF_TARGET_NAME} device may become inaccessible if support changes. +.. only:: CONFIG_ESP_ROM_HAS_MBEDTLS_CRYPTO_LIB + + Enabling the config option :ref:`CONFIG_MBEDTLS_USE_CRYPTO_ROM_IMPL` will use the crypto algorithms from mbedTLS library inside the chip ROM. + Disabling the config option :ref:`CONFIG_MBEDTLS_USE_CRYPTO_ROM_IMPL` will use the crypto algorithms from the ESP-IDF mbedtls component library. This will increase the binary size (flash footprint). + .. note:: Not every combination of mbedTLS compile-time config is tested in ESP-IDF. If you find a combination that fails to compile or function as expected, please report the details on GitHub.