feat: updated security docs for ESP32C5

This commit modified document files for ESP32C5. This revised chnages for security components, RNG, provisioning and some minor changes in sample output for flash encryption example.
espressif · Sep 2, 2024 · 3550e36 · 3550e36
1 parent 53b7d63
commit 3550e36
Show file tree

Hide file tree

Showing 5 changed files with 2 additions and 14 deletions.
diff --git a/docs/docs_not_updated/esp32c5.txt b/docs/docs_not_updated/esp32c5.txt
@@ -45,10 +45,6 @@ libraries-and-frameworks/index.rst
 libraries-and-frameworks/cloud-frameworks.rst
 versions.rst
 api-reference/template.rst
-api-reference/provisioning/protocomm.rst
-api-reference/provisioning/provisioning.rst
-api-reference/provisioning/index.rst
-api-reference/provisioning/wifi_provisioning.rst
 api-reference/storage/vfs.rst
 api-reference/storage/spiffs.rst
 api-reference/storage/nvs_encryption.rst
@@ -92,14 +88,11 @@ api-reference/network/index.rst
 api-reference/network/esp_netif.rst
 api-reference/system/sleep_modes.rst
 api-reference/system/mm_sync.rst
-api-reference/system/ota.rst
 api-reference/system/chip_revision.rst
 api-reference/system/async_memcpy.rst
-api-reference/system/random.rst
 api-reference/system/power_management.rst
 api-reference/system/inc/power_management_esp32c5.rst
 api-reference/system/mm.rst
-api-reference/system/esp_https_ota.rst
 api-reference/bluetooth/esp_spp.rst
 api-reference/bluetooth/esp_l2cap_bt.rst
 api-reference/bluetooth/esp_hidd.rst
@@ -132,7 +125,6 @@ api-reference/protocols/esp_serial_slave_link.rst
 api-reference/protocols/mqtt.rst
 api-reference/protocols/esp_crt_bundle.rst
 api-reference/protocols/modbus.rst
-api-reference/protocols/esp_tls.rst
 api-reference/protocols/mdns.rst
 api-reference/protocols/index.rst
 api-reference/protocols/asio.rst

diff --git a/docs/en/api-reference/system/random.rst b/docs/en/api-reference/system/random.rst
@@ -3,7 +3,7 @@ Random Number Generation
 
 :link_to_translation:`zh_CN:[中文]`
 
-{IDF_TARGET_RF_NAME: default="Wi-Fi or Bluetooth", esp32s2="Wi-Fi", esp32h2="Bluetooth or 802.15.4 Thread/Zigbee", esp32c6="Wi-Fi or Bluetooth or 802.15.4 Thread/Zigbee"}
+{IDF_TARGET_RF_NAME: default="Wi-Fi or Bluetooth", esp32s2="Wi-Fi", esp32h2="Bluetooth or 802.15.4 Thread/Zigbee", esp32c6="Wi-Fi or Bluetooth or 802.15.4 Thread/Zigbee", esp32c5="Wi-Fi or Bluetooth or 802.15.4 Thread/Zigbee"}
 {IDF_TARGET_RF_IS: default="are", esp32s2="is"}
 
 {IDF_TARGET_NAME} contains a hardware random number generator (RNG). You can use the APIs :cpp:func:`esp_random` and :cpp:func:`esp_fill_random` to obtained random values from it.

diff --git a/docs/en/security/esp32c5_log.inc b/docs/en/security/esp32c5_log.inc
@@ -92,7 +92,6 @@
     I (104) boot:  4 custom_nvs       WiFi data        01 02 00121000 00006000
     I (113) boot: End of partition table
     I (116) esp_image: segment 0: paddr=00020020 vaddr=42010020 size=095c4h ( 38340) map
-    E (125) fpga_rng: Project configuration is for internal FPGA use, RNG will not work
     I (169) esp_image: segment 1: paddr=000295ec vaddr=40800000 size=06a2ch ( 27180) load
     I (197) esp_image: segment 2: paddr=00030020 vaddr=42000020 size=0f4d4h ( 62676) map
     I (256) esp_image: segment 3: paddr=0003f4fc vaddr=40806a2c size=00b78h (  2936) load
@@ -101,7 +100,6 @@
     I (270) boot: Checking flash encryption...
     I (273) efuse: Batch mode of writing fields is enabled
     I (278) flash_encrypt: Generating new flash encryption key...
-    E (285) fpga_rng: Project configuration is for internal FPGA use, RNG will not work
     I (295) efuse: Writing EFUSE_BLK_KEY0 with purpose 4
     W (300) flash_encrypt: Not disabling UART bootloader encryption
     I (305) flash_encrypt: Disable JTAG...

diff --git a/docs/zh_CN/api-reference/system/random.rst b/docs/zh_CN/api-reference/system/random.rst
@@ -3,7 +3,7 @@
 
 :link_to_translation:`en:[English]`
 
-{IDF_TARGET_RF_NAME: default="Wi-Fi 或蓝牙", esp32s2="Wi-Fi", esp32h2="蓝牙或 802.15.4 Thread/Zigbee", esp32c6="Wi-Fi 或蓝牙或 802.15.4 Thread/Zigbee"}
+{IDF_TARGET_RF_NAME: default="Wi-Fi 或蓝牙", esp32s2="Wi-Fi", esp32h2="蓝牙或 802.15.4 Thread/Zigbee", esp32c6="Wi-Fi 或蓝牙或 802.15.4 Thread/Zigbee", esp32c5="Wi-Fi 或蓝牙或 802.15.4 Thread/Zigbee"}
 {IDF_TARGET_RF_IS: default="已启用", esp32s2="已启用"}
 
 {IDF_TARGET_NAME} 中包含一个硬件随机数发生器 (RNG)，可以调用 API :cpp:func:`esp_random` 和 :cpp:func:`esp_fill_random` 从中获取随机数值。

diff --git a/docs/zh_CN/security/esp32c5_log.inc b/docs/zh_CN/security/esp32c5_log.inc
@@ -92,7 +92,6 @@
     I (104) boot:  4 custom_nvs       WiFi data        01 02 00121000 00006000
     I (113) boot: End of partition table
     I (116) esp_image: segment 0: paddr=00020020 vaddr=42010020 size=095c4h ( 38340) map
-    E (125) fpga_rng: Project configuration is for internal FPGA use, RNG will not work
     I (169) esp_image: segment 1: paddr=000295ec vaddr=40800000 size=06a2ch ( 27180) load
     I (197) esp_image: segment 2: paddr=00030020 vaddr=42000020 size=0f4d4h ( 62676) map
     I (256) esp_image: segment 3: paddr=0003f4fc vaddr=40806a2c size=00b78h (  2936) load
@@ -101,7 +100,6 @@
     I (270) boot: Checking flash encryption...
     I (273) efuse: Batch mode of writing fields is enabled
     I (278) flash_encrypt: Generating new flash encryption key...
-    E (285) fpga_rng: Project configuration is for internal FPGA use, RNG will not work
     I (295) efuse: Writing EFUSE_BLK_KEY0 with purpose 4
     W (300) flash_encrypt: Not disabling UART bootloader encryption
     I (305) flash_encrypt: Disable JTAG...