From 3fdf8eba84baba0a1d740dedc17854472f12e56d Mon Sep 17 00:00:00 2001 From: Jiang Guang Ming Date: Wed, 6 May 2026 20:02:44 +0800 Subject: [PATCH] docs(mbedtls): update docs with CONFIG_MBEDTLS_USE_CRYPTO_ROM_IMPL --- docs/en/api-guides/performance/size.rst | 1 + docs/zh_CN/api-guides/performance/size.rst | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/en/api-guides/performance/size.rst b/docs/en/api-guides/performance/size.rst index 3ed85bed7b0..88156f6cbda 100644 --- a/docs/en/api-guides/performance/size.rst +++ b/docs/en/api-guides/performance/size.rst @@ -242,6 +242,7 @@ The help text for each option has some more information for reference. .. 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. + This option is available only when the selected target and minimum chip revision support the ROM mbedTLS crypto library. 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). diff --git a/docs/zh_CN/api-guides/performance/size.rst b/docs/zh_CN/api-guides/performance/size.rst index bb1f9bb38da..83d13208e55 100644 --- a/docs/zh_CN/api-guides/performance/size.rst +++ b/docs/zh_CN/api-guides/performance/size.rst @@ -241,8 +241,9 @@ MbedTLS 功能 .. only:: CONFIG_ESP_ROM_HAS_MBEDTLS_CRYPTO_LIB 启用配置选项 :ref:`CONFIG_MBEDTLS_USE_CRYPTO_ROM_IMPL` 时 mbedtls 使用由 ROM 提供的加密算法。 + 该选项仅在所选目标芯片和最低芯片版本支持 ROM mbedTLS 加密算法库时可用。 - 禁用配置选项 :ref:`CONFIG_MBEDTLS_USE_CRYPTO_ROM_IMPL` 时mbedtls 完全使用由 ESP-IDF 中提供的加密算法。这会导致二进制文件大小增加。 + 禁用配置选项 :ref:`CONFIG_MBEDTLS_USE_CRYPTO_ROM_IMPL` 时,mbedtls 完全使用由 ESP-IDF 中提供的加密算法。这会导致二进制文件大小增加。 .. note::