Skip to content

Commit 6654c2a

Browse files
sylvioalvesnashif
sylvioalves
authored and
nashif
committed
boards: esp32-based: update documentation
This PR updates all Espressif board names to meet its original value. It also update reference links, re-organize entries and removes unused content. This also fixes bootloader information regarding a few boards. IDF Bootloader was removed and these boards kept that info. This updated it accordingly with the Simpleboot Bootloader. Signed-off-by: Sylvio Alves <sylvio.alves@espressif.com>
1 parent c8161dc commit 6654c2a

File tree

25 files changed

+313
-273
lines changed

25 files changed

+313
-273
lines changed

‎boards/espressif/esp32_devkitc_wroom/doc/index.rst‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
.. _esp32_devkitc_wroom:
22

3-
ESP32-DEVKITC-WROOM
3+
ESP32-DevKitC-WROOM
44
###################
55

66
Overview
77
********
88

9-
ESP32-DEVKITC-WROOM is a series of low cost, low power system on a chip microcontrollers
10-
with integrated Wi-Fi & dual-mode Bluetooth. The ESP32 series employs a
9+
ESP32 is a series of low cost, low power system on a chip microcontrollers
10+
with integrated Wi-Fi & dual-mode Bluetooth. The ESP32 series employs a
1111
Tensilica Xtensa LX6 microprocessor in both dual-core and single-core
12-
variations. ESP32-WROOM is created and developed by Espressif Systems, a
12+
variations. ESP32 is created and developed by Espressif Systems, a
1313
Shanghai-based Chinese company, and is manufactured by TSMC using their 40nm
14-
process. [1]_
14+
process. For more information, check `ESP32-DevKitC-WROOM`_.
1515

1616
The features include the following:
1717

@@ -43,20 +43,23 @@ The features include the following:
4343

4444
.. figure:: img/esp32_devkitc_wroom.jpg
4545
:align: center
46-
:alt: ESP32-DEVKITC-WROOM
46+
:alt: ESP32-DevKitC-WROOM
4747

4848
ESP32-DevKitC-WROOM-32D DK
4949

50+
For more information, check the datasheet at `ESP32 Datasheet`_ or the technical reference
51+
manual at `ESP32 Technical Reference Manual`_.
52+
5053
Asymmetric Multiprocessing (AMP)
5154
********************************
5255

53-
ESP32-DEVKITC-WROOM allows 2 different applications to be executed in ESP32 SoC. Due to its dual-core architecture, each core can be enabled to execute customized tasks in stand-alone mode
56+
ESP32-DevKitC-WROOM allows 2 different applications to be executed in ESP32 SoC. Due to its dual-core architecture, each core can be enabled to execute customized tasks in stand-alone mode
5457
and/or exchanging data over OpenAMP framework. See :ref:`ipc_samples` folder as code reference.
5558

5659
Supported Features
5760
==================
5861

59-
Current Zephyr's ESP32-WROOM board supports the following features:
62+
Current Zephyr's ESP32-DevKitC-WROOM board supports the following features:
6063

6164
+------------+------------+-------------------------------------+
6265
| Interface | Controller | Driver/Component |
@@ -235,10 +238,9 @@ message in the monitor:
235238
Debugging
236239
*********
237240

238-
ESP32-DEVKITC-WROOM support on OpenOCD is available upstream as of version 0.12.0.
239-
Download and install OpenOCD from `OpenOCD`_.
241+
ESP32 support on OpenOCD is available at `OpenOCD ESP32`_.
240242

241-
On the ESP-WROOM-32 DevKitC board, the JTAG pins are not run to a
243+
On the ESP32-DevKitC-WROOM board, the JTAG pins are not run to a
242244
standard connector (e.g. ARM 20-pin) and need to be manually connected
243245
to the external programmer (e.g. a Flyswatter2):
244246

@@ -260,8 +262,7 @@ to the external programmer (e.g. a Flyswatter2):
260262
| IO15 | TDO |
261263
+------------+-----------+
262264

263-
Further documentation can be obtained from the SoC vendor in `JTAG debugging
264-
for ESP32`_.
265+
Further documentation can be obtained from the SoC vendor in `JTAG debugging for ESP32`_.
265266

266267
Here is an example for building the :ref:`hello_world` application.
267268

@@ -288,12 +289,11 @@ GDB stub is enabled on ESP32.
288289
This does not work as the code is on flash which cannot be randomly
289290
accessed for modification.
290291

291-
.. _`JTAG debugging for ESP32`: https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/index.html
292-
.. _`OpenOCD`: https://github.com/openocd-org/openocd
293-
294292
References
295293
**********
296294

297-
.. [1] https://en.wikipedia.org/wiki/ESP32
298-
.. _ESP32 Technical Reference Manual: https://espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf
299-
.. _Hardware Reference: https://docs.espressif.com/projects/esp-idf/en/latest/esp32/hw-reference/index.html
295+
.. _`ESP32-DevKitC-WROOM`: https://docs.espressif.com/projects/esp-idf/en/stable/esp32/hw-reference/esp32/get-started-devkitc.html#
296+
.. _`ESP32 Datasheet`: https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf
297+
.. _`ESP32 Technical Reference Manual`: https://espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf
298+
.. _`JTAG debugging for ESP32`: https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/index.html
299+
.. _`OpenOCD ESP32`: https://github.com/espressif/openocd-esp32/releases

‎boards/espressif/esp32_devkitc_wrover/doc/index.rst‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
.. _esp32_devkitc_wrover:
22

3-
ESP32-DEVKITC-WROVER
3+
ESP32-DevKitC-WROVER
44
####################
55

66
Overview
77
********
88

99
ESP32 is a series of low cost, low power system on a chip microcontrollers
10-
with integrated Wi-Fi & dual-mode Bluetooth. The ESP32 series employs a
10+
with integrated Wi-Fi & dual-mode Bluetooth. The ESP32 series employs a
1111
Tensilica Xtensa LX6 microprocessor in both dual-core and single-core
12-
variations. ESP32 is created and developed by Espressif Systems, a
12+
variations. ESP32 is created and developed by Espressif Systems, a
1313
Shanghai-based Chinese company, and is manufactured by TSMC using their 40nm
14-
process. [1]_
14+
process. For more information, check `ESP32-DevKitC-WROVER`_.
1515

1616
The features include the following:
1717

@@ -43,20 +43,23 @@ The features include the following:
4343

4444
.. figure:: img/esp32_devkitc_wrover.jpg
4545
:align: center
46-
:alt: ESP32-DEVKITC-WROVER
46+
:alt: ESP32-DevKitC-WROVER
4747

4848
ESP32-DevKitC-WROVER-IE
4949

50+
For more information, check the datasheet at `ESP32 Datasheet`_ or the technical reference
51+
manual at `ESP32 Technical Reference Manual`_.
52+
5053
Asymmetric Multiprocessing (AMP)
5154
********************************
5255

53-
ESP32-DEVKITC-WROVER allows 2 different applications to be executed in ESP32 SoC. Due to its dual-core architecture, each core can be enabled to execute customized tasks in stand-alone mode
56+
ESP32-DevKitC-WROVER allows 2 different applications to be executed in ESP32 SoC. Due to its dual-core architecture, each core can be enabled to execute customized tasks in stand-alone mode
5457
and/or exchanging data over OpenAMP framework. See :ref:`ipc_samples` folder as code reference.
5558

5659
Supported Features
5760
==================
5861

59-
Current Zephyr's ESP32-devkitc board supports the following features:
62+
Current Zephyr's ESP32-DevKitC-WROVER board supports the following features:
6063

6164
+------------+------------+-------------------------------------+
6265
| Interface | Controller | Driver/Component |
@@ -235,10 +238,9 @@ message in the monitor:
235238
Debugging
236239
*********
237240

238-
ESP32 support on OpenOCD is available upstream as of version 0.12.0.
239-
Download and install OpenOCD from `OpenOCD`_.
241+
ESP32 support on OpenOCD is available at `OpenOCD ESP32`_.
240242

241-
On the ESP-WROOM-32 DevKitC board, the JTAG pins are not run to a
243+
On the ESP32-DevKitC-WROVER board, the JTAG pins are not run to a
242244
standard connector (e.g. ARM 20-pin) and need to be manually connected
243245
to the external programmer (e.g. a Flyswatter2):
244246

@@ -260,8 +262,7 @@ to the external programmer (e.g. a Flyswatter2):
260262
| IO15 | TDO |
261263
+------------+-----------+
262264

263-
Further documentation can be obtained from the SoC vendor in `JTAG debugging
264-
for ESP32`_.
265+
Further documentation can be obtained from the SoC vendor in `JTAG debugging for ESP32`_.
265266

266267
Here is an example for building the :ref:`hello_world` application.
267268

@@ -288,12 +289,11 @@ GDB stub is enabled on ESP32.
288289
This does not work as the code is on flash which cannot be randomly
289290
accessed for modification.
290291

291-
.. _`JTAG debugging for ESP32`: https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/index.html
292-
.. _`OpenOCD`: https://github.com/openocd-org/openocd
293-
294292
References
295293
**********
296294

297-
.. [1] https://en.wikipedia.org/wiki/ESP32
298-
.. _ESP32 Technical Reference Manual: https://espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf
299-
.. _Hardware Reference: https://docs.espressif.com/projects/esp-idf/en/latest/esp32/hw-reference/index.html
295+
.. _`ESP32-DevKitC-WROVER`: https://docs.espressif.com/projects/esp-idf/en/stable/esp32/hw-reference/esp32/get-started-devkitc.html#
296+
.. _`ESP32 Datasheet`: https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf
297+
.. _`ESP32 Technical Reference Manual`: https://espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf
298+
.. _`JTAG debugging for ESP32`: https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/index.html
299+
.. _`OpenOCD ESP32`: https://github.com/espressif/openocd-esp32/releases

‎boards/espressif/esp32_ethernet_kit/doc/index.rst‎

Lines changed: 31 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
.. _esp32_ethernet_kit:
22

3-
ESP32-ETHERNET-KIT
3+
ESP32-Ethernet-Kit
44
##################
55

6+
Overview
7+
********
8+
69
The ESP32-Ethernet-Kit is an Ethernet-to-Wi-Fi development board that enables
710
Ethernet devices to be interconnected over Wi-Fi. At the same time, to provide
811
more flexible power supply options, the ESP32-Ethernet-Kit also supports power
@@ -17,16 +20,13 @@ over Ethernet (PoE).
1720

1821
ESP32-Ethernet-Kit V1.2 Overview
1922

20-
Overview
21-
********
22-
23-
ESP32-Ethernet-Kit is an ESP32-based development board produced by
24-
`Espressif <https://espressif.com>`_.
23+
ESP32-Ethernet-Kit is an ESP32-WROVER-E based development.
24+
For more information, check the datasheet at `ESP32-WROVER-E Datasheet`_.
2525

26-
It consists of two development boards, the Ethernet board A and the PoE
27-
board B. The `Ethernet board (A)`_ contains Bluetooth/Wi-Fi dual-mode
26+
It consists of two development boards, the Ethernet Board A and the PoE
27+
board B. The `Ethernet Board (A)`_ contains Bluetooth/Wi-Fi dual-mode
2828
ESP32-WROVER-E module and IP101GRI, a Single Port 10/100 Fast Ethernet
29-
Transceiver (PHY). The `PoE board (B)`_ provides power over Ethernet
29+
Transceiver (PHY). The `PoE Board (B)`_ provides power over Ethernet
3030
functionality. The A board can work independently, without the board B
3131
installed.
3232

@@ -39,7 +39,7 @@ installed.
3939

4040
ESP32-Ethernet-Kit V1.2
4141

42-
For the application loading and monitoring, the Ethernet board (A) also
42+
For the application loading and monitoring, the Ethernet Board (A) also
4343
features FTDI FT2232H chip - an advanced multi-interface USB bridge.
4444
This chip enables to use JTAG for direct debugging of ESP32 through the
4545
USB interface without a separate JTAG debugger.
@@ -76,7 +76,7 @@ Ethernet Board (A)
7676
:alt: ESP32-Ethernet-Kit V1.2
7777
:figclass: align-center
7878

79-
ESP32-Ethernet-Kit - Ethernet board (A) layout
79+
ESP32-Ethernet-Kit - Ethernet Board (A) layout
8080

8181
The table below provides description starting from the picture's top right
8282
corner and going clockwise.
@@ -104,8 +104,7 @@ corner and going clockwise.
104104
ESP32. FT2232H also features USB-to-JTAG interface which is available
105105
on channel A of the chip, while USB-to-serial is on channel B.
106106
The FT2232H chip enhances user-friendliness in terms of application
107-
development and debugging. See
108-
`ESP32-Ethernet-Kit V1.2 Ethernet board (A) Schematic <https://dl.espressif.com/dl/schematics/SCH_ESP32-Ethernet-Kit_A_V1.2_20200528.pdf>`_.
107+
development and debugging. See `ESP32-Ethernet-Kit V1.2 Ethernet Board (A) Schematic`_
109108
* - USB Port
110109
- USB interface. Power supply for the board as well as the communication
111110
interface between a computer and the board.
@@ -121,7 +120,7 @@ corner and going clockwise.
121120
* - DC/DC Converter
122121
- Provided DC 5 V to 3.3 V conversion, output current up to 2 A.
123122
* - Board B Connectors
124-
- A pair male and female header pins for mounting the `PoE board (B)`_
123+
- A pair male and female header pins for mounting the `PoE Board (B)`_
125124
* - IP101GRI (PHY)
126125
- The physical layer (PHY) connection to the Ethernet cable is
127126
implemented using the
@@ -155,39 +154,39 @@ PoE Board (B)
155154
^^^^^^^^^^^^^
156155

157156
This board coverts power delivered over the Ethernet cable (PoE) to provide a
158-
power supply for the Ethernet board (A). The main components of the PoE board
157+
power supply for the Ethernet Board (A). The main components of the PoE Board
159158
(B) are shown on the block diagram under `Functionality Overview`_.
160159

161-
The PoE board (B) has the following features:
160+
The PoE Board (B) has the following features:
162161

163162
* Support for IEEE 802.3at
164163
* Power output: 5 V, 1.4 A
165164

166165
To take advantage of the PoE functionality the **RJ45 Port** of the Ethernet
167166
board (A) should be connected with an Ethernet cable to a switch that supports
168-
PoE. When the Ethernet board (A) detects 5 V power output from the PoE board
167+
PoE. When the Ethernet Board (A) detects 5 V power output from the PoE Board
169168
(B), the USB power will be automatically cut off.
170169

171170
.. figure:: img/esp32-ethernet-kit-b-v1.0-layout.jpg
172171
:align: center
173-
:alt: ESP32-Ethernet-Kit - PoE board (B)
172+
:alt: ESP32-Ethernet-Kit - PoE Board (B)
174173
:figclass: align-center
175174

176-
ESP32-Ethernet-Kit - PoE board (B) layout
175+
ESP32-Ethernet-Kit - PoE Board (B) layout
177176

178-
.. list-table:: Table PoE board (B)
177+
.. list-table:: Table PoE Board (B)
179178
:widths: 40 150
180179
:header-rows: 1
181180

182181
* - Key Component
183182
- Description
184183
* - Board A Connector
185184
- Four female (left) and four male (right) header pins for connecting the
186-
PoE board (B) to `Ethernet board (A)`_. The pins on the left accept
185+
PoE Board (B) to `Ethernet Board (A)`_. The pins on the left accept
187186
power coming from a PoE switch. The pins on the right deliver 5 V power
188-
supply to the Ethernet board (A).
187+
supply to the Ethernet Board (A).
189188
* - External Power Terminals
190-
- Optional power supply (26.6 ~ 54 V) to the PoE board (B).
189+
- Optional power supply (26.6 ~ 54 V) to the PoE Board (B).
191190

192191
.. _get-started-esp32-ethernet-kit-v1.2-setup-options:
193192

@@ -225,9 +224,7 @@ or generated from internal ESP32 APLL (not recommended).
225224
.. note::
226225

227226
For additional information on the RMII clock selection, please refer to
228-
`ESP32-Ethernet-Kit V1.2 Ethernet board (A) Schematic <https://dl.espressif.com/dl/schematics/SCH_ESP32-Ethernet-Kit_A_V1.2_20200528.pdf>`_,
229-
sheet 2, location D2.
230-
227+
`ESP32-Ethernet-Kit V1.2 Ethernet Board (A) Schematic`_, sheet 2, location D2.
231228

232229
RMII Clock Sourced Externally by PHY
233230
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -267,7 +264,7 @@ for transmission line delay, and then supplied to the PHY.
267264

268265
To implement this option, users need to remove or add some RC components on
269266
the board. For details please refer to
270-
`ESP32-Ethernet-Kit V1.2 Ethernet board (A) Schematic <https://dl.espressif.com/dl/schematics/SCH_ESP32-Ethernet-Kit_A_V1.2_20200528.pdf>`_,
267+
`ESP32-Ethernet-Kit V1.2 Ethernet Board (A) Schematic`_,
271268
sheet 2, location D2. Please note that if the APLL is already used for other
272269
purposes (e.g. I2S peripheral), then you have no choice but use an external
273270
RMII clock.
@@ -411,7 +408,7 @@ GPIO Allocation Summary
411408
module that can be disabled/enabled externally. Similarly like when
412409
using RESET_N, the oscillator module should be disabled by default and
413410
turned on by ESP32 after power-up. For a reference design please see
414-
`ESP32-Ethernet-Kit V1.2 Ethernet board (A) Schematic <https://dl.espressif.com/dl/schematics/SCH_ESP32-Ethernet-Kit_A_V1.2_20200528.pdf>`_.
411+
`ESP32-Ethernet-Kit V1.2 Ethernet Board (A) Schematic`_.
415412

416413
2. The ESP32 pins GPIO16 and GPIO17 are not broken out to the
417414
ESP32-WROVER-E module and therefore not available for use. If you need
@@ -560,7 +557,7 @@ Debugging
560557

561558
As with much custom hardware, the ESP32 modules require patches to
562559
OpenOCD that are not upstreamed yet. Espressif maintains their own fork of
563-
the project. The custom OpenOCD can be obtained at `OpenOCD ESP32`_
560+
the project. The custom OpenOCD can be obtained at `OpenOCD ESP32`_.
564561

565562
The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite that behavior by adding the
566563
``-DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>``
@@ -615,13 +612,9 @@ Board Init
615612
RESET_N (GPIO5) is automatically set high to enable the Ethernet PHY
616613
during board initialization (board_init.c)
617614

618-
Related Documents
619-
*****************
615+
References
616+
**********
620617

621-
* `ESP32-Ethernet-Kit V1.2 Ethernet Board (A) Schematic <https://dl.espressif.com/dl/schematics/SCH_ESP32-Ethernet-Kit_A_V1.2_20200528.pdf>`_ (PDF)
622-
* `ESP32-Ethernet-Kit PoE Board (B) Schematic <https://dl.espressif.com/dl/schematics/SCH_ESP32-ETHERNET-KIT_B_V1.0_20190517.pdf>`_ (PDF)
623-
* `ESP32-Ethernet-Kit V1.2 Ethernet Board (A) PCB Layout <https://dl.espressif.com/dl/schematics/PCB_ESP32-Ethernet-Kit_A_V1_2_20190829.pdf>`_ (PDF)
624-
* `ESP32-Ethernet-Kit PoE Board (B) PCB Layout <https://dl.espressif.com/dl/schematics/PCB_ESP32-Ethernet-Kit_B_V1_0_20190306.pdf>`_ (PDF)
625-
* `ESP32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
626-
* `ESP32-WROVER-E Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-wrover-e_esp32-wrover-ie_datasheet_en.pdf>`_ (PDF)
627-
* `OpenOCD ESP32 <https://github.com/espressif/openocd-esp32/releases>`_
618+
.. _`ESP32-Ethernet-Kit V1.2 Ethernet Board (A) Schematic`: https://dl.espressif.com/dl/schematics/SCH_ESP32-Ethernet-Kit_A_V1.2_20200528.pdf
619+
.. _`ESP32-WROVER-E Datasheet`: https://www.espressif.com/sites/default/files/documentation/esp32-wrover-e_esp32-wrover-ie_datasheet_en.pdf
620+
.. _`OpenOCD ESP32`: https://github.com/espressif/openocd-esp32/releases

0 commit comments

Comments
 (0)