alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-10-16 17:02:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update api-reference chapters for C3

Browse Source 
Checked and updated the following chapters:
 * api-reference/network
 * api-reference/protocols
 * api-reference/provisioning
 * api-reference/storage
 * api-reference/peripherals/ds
 * api-reference/peripherals/hmac
 * api-reference/peripherals/secure_element
This commit is contained in:
Marius Vikhammer
2021-02-23 09:31:29 +08:00
committed by No One
parent f12b571f82
commit fb82bdb9da
15 changed files with 110 additions and 108 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/en/api-reference/peripherals/ds.rst
View File

@@ -51,7 +51,7 @@ Once the calculation has finished, :cpp:func:`esp_ds_finish_sign` can be called
Configure the DS peripheral for a TLS connection
------------------------------------------------
The DS peripheral on ESP32-S2 chip must be configured before it can be used for a TLS connection.
The DS peripheral on {IDF_TARGET_NAME} chip must be configured before it can be used for a TLS connection.
The configuration involves the following steps -
1) Randomly generate a 256 bit value called the `Initialization Vector` (IV).

4
docs/en/api-reference/peripherals/hmac.rst
View File

@@ -58,7 +58,7 @@ Each key has a corresponding eFuse parameter *key purpose* determining for which
This is to prevent the usage of a key for a different function than originally intended.
To calculate an HMAC, the software has to provide the ID of the key block containing the secret key as well as the *key purpose* (see *{IDF_TARGET_NAME} Technical Reference Manual* > *eFuse Controller (eFuse)* [`PDF <{IDF_TARGET_TRM_EN_URL}#efuse>`__]).
Before the HMAC key calculation, the HMAC module looks up the purpose of the provided key block.
Before the HMAC key calculation, the HMAC module looks up the purpose of the provided key block.
The calculation only proceeds if the provided key purpose matches the purpose stored in the eFuses of the key block provided by the ID.
HMAC Generation for Software
@@ -115,7 +115,7 @@ We use `ets_efuse_write_key` to set physical key block 4 in the eFuse for the HM
.. code-block:: c
#include "esp32s2/rom/efuse.h"
#include "{IDF_TARGET_PATH_NAME}/rom/efuse.h"
const uint8_t key_data[32] = { ... };

4
docs/en/api-reference/peripherals/index.rst
View File

@@ -11,8 +11,8 @@ Peripherals API
:SOC_DAC_PERIPH_NUM: DAC <dac>
GPIO (including RTC low power I/O) <gpio>
:SOC_DEDICATED_GPIO_SUPPORTED: Dedicated GPIO <dedic_gpio>
:esp32s2: HMAC <hmac>
:esp32s2: Digital Signature <ds>
:SOC_HMAC_SUPPORTED: HMAC <hmac>
:SOC_DIG_SIGN_SUPPORTED: Digital Signature <ds>
I2C <i2c>
I2S <i2s>
LED Control <ledc>