Merge branch 'docs/c2_storage_update' into 'master'
docs: update storage and sleep docs for C2 Closes IDF-4207 See merge request espressif/esp-idf!19453
This commit is contained in:
Marius Vikhammer
@@ -82,14 +82,14 @@ Data stored in NVS partitions can be encrypted using AES-XTS in the manner simil
|
||||
|
||||
The NVS Encryption is enabled by default when :doc:`Flash Encryption <../../security/flash-encryption>` is enabled. This is done because Wi-Fi driver stores credentials (like SSID and passphrase) in the default NVS partition. It is important to encrypt them as default choice if platform level encryption is already enabled.
|
||||
|
||||
For using NVS encryption, the partition table must contain the :ref:`nvs_key_partition`. Two partition tables containing the :ref:`nvs_key_partition` are provided for NVS encryption under the partition table option (menuconfig->Partition Table). They can be selected with the project configuration menu (``idf.py menuconfig``). Please refer to the example :example:`security/flash_encryption` for how to configure and use NVS encryption feature.
|
||||
For using NVS encryption, the partition table must contain the :ref:`nvs_key_partition`. Two partition tables containing the :ref:`nvs_key_partition` are provided for NVS encryption under the partition table option (``menuconfig`` > ``Partition Table``). They can be selected with the project configuration menu (``idf.py menuconfig``). Please refer to the example :example:`security/flash_encryption` for how to configure and use NVS encryption feature.
|
||||
|
||||
.. _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 `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.
|
||||
|
||||
.. highlight:: none
|
||||
|
||||
|
||||
@@ -153,7 +153,7 @@ Refer to the :doc:`Flash Encryption documentation </security/flash-encryption>`
|
||||
Memory Mapping API
|
||||
------------------
|
||||
|
||||
{IDF_TARGET_CACHE_SIZE:default="64 KB"}
|
||||
{IDF_TARGET_CACHE_SIZE:default="64 KB",esp32c2=16~64 KB}
|
||||
|
||||
{IDF_TARGET_NAME} features memory hardware which allows regions of flash memory to be mapped into instruction and data address spaces. This mapping works only for read operations. It is not possible to modify contents of flash memory by writing to a mapped memory region.
|
||||
|
||||
@@ -286,4 +286,5 @@ API Reference - Partition Table
|
||||
API Reference - Flash Encrypt
|
||||
-----------------------------
|
||||
|
||||
.. include-build-file:: inc/esp_flash_encrypt.inc
|
||||
.. include-build-file:: inc/esp_flash_encrypt.inc
|
||||
|
||||
@@ -17,7 +17,7 @@ Notes
|
||||
- SPIFFS is able to reliably utilize only around 75% of assigned partition space.
|
||||
- When the filesystem is running out of space, the garbage collector is trying to find free space by scanning the filesystem multiple times, which can take up to several seconds per write function call, depending on required space. This is caused by the SPIFFS design and the issue has been reported multiple times (e.g. `here <https://github.com/espressif/esp-idf/issues/1737>`_) and in the official `SPIFFS github repository <https://github.com/pellepl/spiffs/issues/>`_. The issue can be partially mitigated by the `SPIFFS configuration <https://github.com/pellepl/spiffs/wiki/Configure-spiffs>`_.
|
||||
- Deleting a file does not always remove the whole file, which leaves unusable sections throughout the filesystem.
|
||||
- When ESP32 experiences a power loss during a file system operation it could result in SPIFFS corruption. However the file system still might be recovered via ``esp_spiffs_check`` function. More details in the official SPIFFS `FAQ <https://github.com/pellepl/spiffs/wiki/FAQ>`.
|
||||
- When the chip experiences a power loss during a file system operation it could result in SPIFFS corruption. However the file system still might be recovered via ``esp_spiffs_check`` function. More details in the official SPIFFS `FAQ <https://github.com/pellepl/spiffs/wiki/FAQ>`.
|
||||
|
||||
Tools
|
||||
-----
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
+---------------+---------------------------------------+-------------------------------------+
|
||||
| Max CPU | Lock Acquisition | CPU and APB Frequncies |
|
||||
| Max CPU | Lock Acquisition | CPU and APB Frequencies |
|
||||
| Frequency Set | | |
|
||||
+---------------+---------------------------------------+-------------------------------------+
|
||||
| 240 | | Any of ``ESP_PM_CPU_FREQ_MAX`` | |
|
||||
|
||||
@@ -1,27 +1,29 @@
|
||||
{IDF_TARGET_APB_FREQ: default="80 Mhz", esp32c2="40 MHz"}
|
||||
|
||||
+---------------+---------------------------------------+-------------------------------------+
|
||||
| Max CPU | Lock Acquisition | CPU and APB Frequncies |
|
||||
| Max CPU | Lock Acquisition | CPU and APB Frequencies |
|
||||
| Frequency Set | | |
|
||||
+---------------+---------------------------------------+-------------------------------------+
|
||||
| 240 | ``ESP_PM_CPU_FREQ_MAX`` acquired | | CPU: 240 MHz |
|
||||
| | | | APB: 80 MHz |
|
||||
| | | | APB: {IDF_TARGET_APB_FREQ} |
|
||||
+ +---------------------------------------+-------------------------------------+
|
||||
| | ``ESP_PM_APB_FREQ_MAX`` acquired, | | CPU: 80 MHz |
|
||||
| | ``ESP_PM_CPU_FREQ_MAX`` not acquired | | APB: 80 MHz |
|
||||
| | ``ESP_PM_CPU_FREQ_MAX`` not acquired | | APB: {IDF_TARGET_APB_FREQ} |
|
||||
+ +---------------------------------------+-------------------------------------+
|
||||
| | None | Min values for both frequencies set |
|
||||
| | | with :cpp:func:`esp_pm_configure` |
|
||||
+---------------+---------------------------------------+-------------------------------------+
|
||||
| 160 | ``ESP_PM_CPU_FREQ_MAX`` acquired | | CPU: 160 MHz |
|
||||
| | | | APB: 80 MHz |
|
||||
| | | | APB: {IDF_TARGET_APB_FREQ} |
|
||||
+ +---------------------------------------+-------------------------------------+
|
||||
| | ``ESP_PM_APB_FREQ_MAX`` acquired, | | CPU: 80 MHz |
|
||||
| | ``ESP_PM_CPU_FREQ_MAX`` not acquired | | APB: 80 MHz |
|
||||
| | ``ESP_PM_CPU_FREQ_MAX`` not acquired | | APB: {IDF_TARGET_APB_FREQ} |
|
||||
+ +---------------------------------------+-------------------------------------+
|
||||
| | None | Min values for both frequencies set |
|
||||
| | | with :cpp:func:`esp_pm_configure` |
|
||||
+---------------+---------------------------------------+-------------------------------------+
|
||||
| 80 | | Any of ``ESP_PM_CPU_FREQ_MAX`` | | CPU: 80 MHz |
|
||||
| | | or ``ESP_PM_APB_FREQ_MAX`` acquired | | APB: 80 MHz |
|
||||
| | | or ``ESP_PM_APB_FREQ_MAX`` acquired | | APB: {IDF_TARGET_APB_FREQ} |
|
||||
+ +---------------------------------------+-------------------------------------+
|
||||
| | None | Min values for both frequencies set |
|
||||
| | | with :cpp:func:`esp_pm_configure` |
|
||||
|
||||
@@ -16,9 +16,8 @@ In Deep-sleep mode, the CPUs, most of the RAM, and all digital peripherals that
|
||||
.. list::
|
||||
|
||||
- RTC controller
|
||||
- RTC peripherals
|
||||
:SOC_ULP_SUPPORTED: - ULP coprocessor
|
||||
- RTC fast memory
|
||||
:SOC_RTC_FAST_MEM_SUPPORTED: - RTC fast memory
|
||||
:SOC_RTC_SLOW_MEM_SUPPORTED: - RTC slow memory
|
||||
|
||||
There are several wakeup sources in Deep-sleep and Light-sleep modes. These sources can also be combined so that the chip will wake up when any of the sources are triggered. Wakeup sources can be enabled using ``esp_sleep_enable_X_wakeup`` APIs and can be disabled using :cpp:func:`esp_sleep_disable_wakeup_source` API. Next section describes these APIs in detail. Wakeup sources can be configured at any moment before entering Light-sleep or Deep-sleep mode.
|
||||
@@ -164,7 +163,7 @@ By default, :cpp:func:`esp_deep_sleep_start` and :cpp:func:`esp_light_sleep_star
|
||||
|
||||
If some variables in the program are placed into RTC slow memory (for example, using ``RTC_DATA_ATTR`` attribute), RTC slow memory will be kept powered on by default. This can be overridden using :cpp:func:`esp_sleep_pd_config` function, if desired.
|
||||
|
||||
.. only:: not SOC_RTC_SLOW_MEM_SUPPORTED
|
||||
.. only:: not SOC_RTC_SLOW_MEM_SUPPORTED and SOC_RTC_FAST_MEM_SUPPORTED
|
||||
|
||||
In {IDF_TARGET_NAME}, there is only RTC fast memory, so if some variables in the program are marked by ``RTC_DATA_ATTR``, ``RTC_SLOW_ATTR`` or ``RTC_FAST_ATTR`` attributes, all of them go to RTC fast memory. It will be kept powered on by default. This can be overridden using :cpp:func:`esp_sleep_pd_config` function, if desired.
|
||||
|
||||
@@ -213,7 +212,7 @@ Configuring IOs
|
||||
|
||||
Some {IDF_TARGET_NAME} IOs have internal pullups or pulldowns, which are enabled by default. If an external circuit drives this pin in Deep-sleep mode, current consumption may increase due to current flowing through these pullups and pulldowns.
|
||||
|
||||
.. only:: not esp32c3
|
||||
.. only:: SOC_RTCIO_HOLD_SUPPORTED
|
||||
|
||||
To isolate a pin to prevent extra current draw, call :cpp:func:`rtc_gpio_isolate` function.
|
||||
|
||||
@@ -223,7 +222,7 @@ Some {IDF_TARGET_NAME} IOs have internal pullups or pulldowns, which are enabled
|
||||
|
||||
rtc_gpio_isolate(GPIO_NUM_12);
|
||||
|
||||
.. only:: esp32c3
|
||||
.. only:: esp32c2 or esp32c3
|
||||
|
||||
In Deep-sleep mode:
|
||||
- digital GPIOs (GPIO6 ~ 21) are in a high impedance state.
|
||||
@@ -267,7 +266,7 @@ Application Example
|
||||
|
||||
- :example:`system/deep_sleep`: the usage of various Deep-sleep wakeup triggers and ULP coprocessor programming.
|
||||
|
||||
.. only:: esp32c3
|
||||
.. only:: esp32c3 or esp32c2
|
||||
|
||||
- :example:`system/deep_sleep`: the usage of Deep-sleep wakeup triggered by timer.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user