Skip to content

Commit 88444df

Browse files
committed
Merge branch 'docs/esp_tee_c5' into 'master'
docs(esp_tee): Enable ESP-TEE documentation for ESP32-C5 Closes IDF-10432 See merge request espressif/esp-idf!42390
2 parents 3b0d850 + afe8fea commit 88444df

File tree

11 files changed

+23
-15
lines changed

11 files changed

+23
-15
lines changed

docs/conf_common.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,7 @@
299299
'api-guides/phy.rst',
300300
'api-reference/peripherals/sd_pullup_requirements.rst',
301301
'api-guides/RF_calibration.rst',
302-
]
302+
] + ESP_TEE_DOCS
303303

304304
ESP32C61_DOCS = [
305305
'api-guides/phy.rst',

docs/doxygen/Doxyfile_esp32c5

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,7 @@ INPUT += \
1919
$(PROJECT_PATH)/components/bt/include/$(IDF_TARGET)/include/esp_bt_vs.h \
2020
$(PROJECT_PATH)/components/esp_phy/include/esp_phy_init.h \
2121
$(PROJECT_PATH)/components/esp_phy/include/esp_phy_cert_test.h \
22+
$(PROJECT_PATH)/components/esp_tee/include/esp_tee.h \
23+
$(PROJECT_PATH)/components/esp_tee/subproject/components/tee_sec_storage/include/esp_tee_sec_storage.h \
24+
$(PROJECT_PATH)/components/esp_tee/subproject/components/tee_attestation/esp_tee_attestation.h \
25+
$(PROJECT_PATH)/components/esp_tee/subproject/components/tee_ota_ops/include/esp_tee_ota_ops.h \

docs/en/security/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,6 @@ Security Guides
1010
flash-encryption
1111
:esp32: secure-boot-v1
1212
secure-boot-v2
13-
:esp32c6: tee/index
13+
:esp32c6 or esp32c5: tee/index
1414
security-features-enablement-workflows
1515
vulnerabilities

docs/en/security/tee/tee-advanced.rst

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The ESP-TEE framework on {IDF_TARGET_NAME} utilizes the inherent features of the
2020

2121
Together, these components enable the {IDF_TARGET_NAME} SoC to allocate the chip's hardware resources (internal memory, external memory, and peripherals) and software resources into two modes - Machine (M) mode and User (U) mode. The CPU can switch between these modes, with the TEE running in the higher privilege M-mode and the REE running in the lower privilege U-mode.
2222

23-
.. figure:: ../../../_static/esp_tee/{IDF_TARGET_PATH_NAME}/esp_tee_arch.png
23+
.. figure:: ../../../_static/esp_tee/esp_tee_arch.png
2424
:align: center
2525
:scale: 90%
2626
:alt: ESP TEE Architecture for {IDF_TARGET_NAME}
@@ -87,7 +87,7 @@ A region at the top of the HP SRAM is reserved for the TEE, allocated for TEE co
8787
The REE memory is partitioned into IRAM (text: Read/Execute) and DRAM (data: Read/Write) sections, with the division controlled by the PMP.
8888
However, the TEE memory is divided into IRAM and DRAM sections, with division enforced by the PMA.
8989

90-
.. figure:: ../../../_static/esp_tee/{IDF_TARGET_PATH_NAME}/esp_tee_memory_layout.png
90+
.. figure:: ../../../_static/esp_tee/esp_tee_memory_layout.png
9191
:align: center
9292
:scale: 80%
9393
:alt: ESP TEE Memory Map for {IDF_TARGET_NAME}
@@ -100,7 +100,7 @@ External Memory (Flash)
100100

101101
Designated partitions in the external flash are reserved for the TEE, serving various purposes, including TEE code execution via XIP, secure storage, and OTA data. The PMS safeguards these partitions from unauthorized access, with the APM module protecting the MMU and SPI1 controller registers, and the PMP securing the cache.
102102

103-
.. figure:: ../../../_static/esp_tee/{IDF_TARGET_PATH_NAME}/esp_tee_flash_layout.png
103+
.. figure:: ../../../_static/esp_tee/esp_tee_flash_layout.png
104104
:align: center
105105
:scale: 80%
106106
:alt: ESP TEE Flash Memory Map for {IDF_TARGET_NAME}
@@ -163,20 +163,24 @@ The following peripherals are protected using the APM module and accessible only
163163
.. list::
164164

165165
- Access Permission Management (APM) peripheral
166-
- AES, SHA accelerators
167-
- ECC accelerator
168-
- Hash-Based Message Authentication Code (HMAC) module
169-
- Digital Signature module
170-
- eFuse Controller
171166
- Interrupt Controller
167+
- eFuse Controller
172168
- Brownout Detector
173169
- Super Watchdog Timer (SWDT)
170+
:SOC_AES_SUPPORTED: - AES accelerator
171+
:SOC_SHA_SUPPORTED: - SHA accelerator
172+
:SOC_ECC_SUPPORTED: - ECC accelerator
173+
:SOC_HMAC_SUPPORTED: - Hash-Based Message Authentication Code (HMAC) module
174+
:SOC_DIG_SIGN_SUPPORTED: - Digital Signature module
174175

175176
.. note::
176177

177-
- The following peripherals will be secured in future releases -
178+
The following peripherals will be secured in future releases:
179+
180+
.. list::
178181

179-
- MPI accelerator (RSA)
182+
:SOC_MPI_SUPPORTED: - MPI accelerator (RSA)
183+
:SOC_ECDSA_SUPPORTED: - ECDSA accelerator
180184

181185
Firmware
182186
^^^^^^^^
@@ -245,7 +249,7 @@ Once the interrupt is handled in the other execution environment, execution retu
245249
}
246250

247251

248-
.. figure:: ../../../_static/esp_tee/{IDF_TARGET_PATH_NAME}/esp_tee_intr_handling.png
252+
.. figure:: ../../../_static/esp_tee/esp_tee_intr_handling.png
249253
:align: center
250254
:alt: ESP-TEE: Interrupt Handling
251255
:figclass: align-center

docs/en/security/tee/tee-ota.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The OTA update mechanism allows a device to update itself based on data received
88

99
TEE OTA requires configuring the partition table of the device with at least two TEE OTA app slot partitions (i.e., ``tee_0`` and ``tee_1``) and a TEE OTA Data Partition (type ``data`` and subtype ``tee_ota``).
1010

11-
.. figure:: ../../../_static/esp_tee/{IDF_TARGET_PATH_NAME}/esp_tee_ota_flash_partitions.png
11+
.. figure:: ../../../_static/esp_tee/esp_tee_ota_flash_partitions.png
1212
:align: center
1313
:scale: 75%
1414
:alt: ESP TEE OTA Flash Partition

0 commit comments

Comments
 (0)