alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'fix/docs_nvs_encryption_update_v5.1' into 'release/v5.1'

Browse Source 
docs(nvs_encryption): Updated the docs of nvs_encryption (v5.1)

See merge request espressif/esp-idf!32911
This commit is contained in:
Mahavir Jain 2024-08-22 11:38:03 +08:00
commit d4acd61a8a
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/en/api-reference/storage/nvs_flash.rst
View File

@ -89,7 +89,7 @@ For using NVS encryption, the partition table must contain the :ref:`nvs_key_par
NVS Key Partition NVS Key Partition
^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^
An application requiring NVS encryption support needs to be compiled with a key-partition of the type `data` and subtype `key`. This partition should be marked as `encrypted` and its size should be the minimum partition size (4KB). Refer to :doc:`Partition Tables <../../api-guides/partition-tables>` for more details. Two additional partition tables which contain the :ref:`nvs_key_partition` are provided under the partition table option (``menuconfig`` > ``Partition Table``). They can be directly used for :ref:`nvs_encryption`. The structure of these partitions is depicted below. An application requiring NVS encryption support needs to be compiled with a key-partition of the type `data` and subtype `nvs_keys`. This partition should be marked as `encrypted` and its size should be the minimum partition size (4KB). Refer to :doc:`Partition Tables <../../api-guides/partition-tables>` for more details. Two additional partition tables which contain the :ref:`nvs_key_partition` are provided under the partition table option (``menuconfig`` > ``Partition Table``). They can be directly used for :ref:`nvs_encryption`. The structure of these partitions is depicted below.
.. highlight:: none .. highlight:: none

2
docs/zh_CN/api-reference/storage/nvs_flash.rst
View File

@ -89,7 +89,7 @@ NVS 分区内存储的数据可使用 AES-XTS 进行加密，类似于 IEEE P161
NVS 密钥分区 NVS 密钥分区
^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^
应用程序如果想使用 NVS 加密，则需要编译进一个类型为 `data`，子类型为 `key` 的密钥分区。该分区应标记为 `已加密` 且最小为 4096 字节。如需了解更多详细信息，请参考 :doc:`分区表 <../../api-guides/partition-tables>`。在分区表选项 (``menuconfig`` > ``Partition Table``) 下提供了两个包含 :ref:`nvs_key_partition` 的额外分区表，可以直接用于 :ref:`nvs_encryption`。这些分区的具体结构见下表： 应用程序如果想使用 NVS 加密，则需要编译进一个类型为 `data`，子类型为 `nvs_keys` 的密钥分区。该分区应标记为 `已加密` 且最小为 4096 字节。如需了解更多详细信息，请参考 :doc:`分区表 <../../api-guides/partition-tables>`。在分区表选项 (``menuconfig`` > ``Partition Table``) 下提供了两个包含 :ref:`nvs_key_partition` 的额外分区表，可以直接用于 :ref:`nvs_encryption`。这些分区的具体结构见下表：
.. highlight:: none .. highlight:: none