Documentation/esp32: Fix a couple of typos and add some notes.

Signed-off-by: Abdelatif Guettouche <abdelatif.guettouche@espressif.com>
This commit is contained in:
Abdelatif Guettouche
2021-04-08 23:36:14 +02:00
committed by Matias N
parent c4ed7361b7
commit 4f9b280987
@@ -19,8 +19,7 @@ two CPUs are interchangeable.
Toolchain Toolchain
========= =========
You must use the custom Xtensa toolchain in order to build the ESP32 Core You can use the prebuilt `toolchain <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-tools.html#xtensa-esp32-elf>`__
BSP. You can use the prebuilt `compiler <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-tools.html#xtensa-esp32-elf>`__
for Xtensa architecture and `OpenOCD <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-tools.html#openocd-esp32>`__ for Xtensa architecture and `OpenOCD <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-tools.html#openocd-esp32>`__
for ESP32 by Espressif. for ESP32 by Espressif.
@@ -32,7 +31,7 @@ Building from source
-------------------- --------------------
You can also build the toolchain yourself. The steps to You can also build the toolchain yourself. The steps to
build toolchain with crosstool-NG on Linux are as follows build the toolchain with crosstool-NG on Linux are as follows
.. code-block:: console .. code-block:: console
@@ -67,7 +66,7 @@ Bootloader and partitions
ESP32 requires a bootloader to be flashed as well as a set of FLASH partitions. This is only needed the first time ESP32 requires a bootloader to be flashed as well as a set of FLASH partitions. This is only needed the first time
(or any time you which to modify either of these). An easy way is to use prebuilt binaries for NuttX from `here <https://github.com/espressif/esp-nuttx-bootloader>`_. In there you will find instructions to rebuild these if necessary. (or any time you which to modify either of these). An easy way is to use prebuilt binaries for NuttX from `here <https://github.com/espressif/esp-nuttx-bootloader>`_. In there you will find instructions to rebuild these if necessary.
Once you downloaded both binaries, you can flash them by adding an ``ESPTOOL_BINDIR`` parameter, pointing to the directiry where these binaries were downloaded: Once you downloaded both binaries, you can flash them by adding an ``ESPTOOL_BINDIR`` parameter, pointing to the directory where these binaries were downloaded:
.. code-block:: console .. code-block:: console
@@ -174,7 +173,7 @@ Linker Segments
| - Constructors | | | | | | - Constructors | | | | |
| /destructors | | | | | | /destructors | | | | |
+---------------------+------------+------------+------+------------------------------+ +---------------------+------------+------------+------+------------------------------+
| COMMON data RAM: | 0x3ffb0000 | 0x40000000 | RW | dram0_0_seg (NOTE 1,2) | | COMMON data RAM: | 0x3ffb0000 | 0x40000000 | RW | dram0_0_seg (NOTE 1,2,3) |
| - .bss/.data | | | | | | - .bss/.data | | | | |
+---------------------+------------+------------+------+------------------------------+ +---------------------+------------+------------+------+------------------------------+
| IRAM for PRO cpu: | 0x40080000 | 0x400a0000 | RX | iram0_0_seg | | IRAM for PRO cpu: | 0x40080000 | 0x400a0000 | RX | iram0_0_seg |
@@ -191,7 +190,7 @@ Linker Segments
| FLASH: | 0x400d0018 | 0x40400018 | RX | iram0_2_seg (actually FLASH)| | FLASH: | 0x400d0018 | 0x40400018 | RX | iram0_2_seg (actually FLASH)|
| - .text | | | | | | - .text | | | | |
+---------------------+------------+------------+------+------------------------------+ +---------------------+------------+------------+------+------------------------------+
| RTC slow memory: | 0x50000000 | 0x50001000 | RW | rtc_slow_seg (NOTE 3) | | RTC slow memory: | 0x50000000 | 0x50001000 | RW | rtc_slow_seg (NOTE 4) |
| - .rtc.data/rodata | | | | | | - .rtc.data/rodata | | | | |
| (unused?) | | | | | | (unused?) | | | | |
+---------------------+------------+------------+------+------------------------------+ +---------------------+------------+------------+------+------------------------------+
@@ -200,8 +199,9 @@ Linker Segments
(1) Linker script will reserve space at the beginning of the segment (1) Linker script will reserve space at the beginning of the segment
for BT and at the end for trace memory. for BT and at the end for trace memory.
(2) Heap ends at the top of dram_0_seg (2) Heap ends at the top of dram_0_seg.
(3) Linker script will reserve space at the beginning of the segment (3) Parts of this region is reserved for the ROM bootloader.
(4) Linker script will reserve space at the beginning of the segment
for co-processor reserve memory and at the end for ULP coprocessor for co-processor reserve memory and at the end for ULP coprocessor
reserve memory. reserve memory.