Skip to content

cpu/esp*: migrate doc files to Markdown files *.md #21589

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jul 10, 2025
Merged

cpu/esp*: migrate doc files to Markdown files *.md #21589

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
797d35f
cpu/esp_common: rename doc.txt to doc.md
gschorcht Jun 24, 2025
d977668
cpu/esp8266: rename doc.txt to doc.md
gschorcht Jun 24, 2025
5c8d29c
cpu/esp32: rename doc*.txt to doc*.md
gschorcht Jun 24, 2025
cad7144
cpu/esp_common: migrate doc*.md to Markdown
gschorcht Jul 9, 2025
6122ba8
cpu/esp8266: migrate doc*.md to Markdown
gschorcht Jul 9, 2025
68ef117
cpu/esp32: migrate doc*.md to Markdown
gschorcht Jul 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 20 additions & 26 deletions cpu/esp32/doc.txt → cpu/esp32/doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,23 @@
/*
* Copyright (C) 2022 Gunar Schorcht
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/

/**
* @defgroup stdio_usb_serial_jtag STDIO over ESP32 Debug Serial/JTAG
* @ingroup sys_stdio
* @brief STDIO via the USB Serial/JTAG debug interface found on some ESP32 SoCs
*
* Some members of the ESP32 family (ESP32-C3, ESP32-H2, ESP32-S3) provide a on-chip
* debug interface that provides a serial console and JTAG via USB.
*
* To route STDIO to this debug console, enable this module.
*
* USEMODULE += stdio_usb_serial_jtag
*
* @see cpu_esp32
*/

/**
<!--
Copyright (C) 2025 Gunar Schorcht

This file is subject to the terms and conditions of the GNU Lesser
General Public License v2.1. See the file LICENSE in the top level
directory for more details.
-->

@defgroup stdio_usb_serial_jtag STDIO over ESP32 Debug Serial/JTAG
@ingroup sys_stdio
@brief STDIO via the USB Serial/JTAG debug interface found on some ESP32 SoCs

Some members of the ESP32 family (ESP32-C3, ESP32-H2, ESP32-S3) provide a on-chip
debug interface that provides a serial console and JTAG via USB.
To route STDIO to this debug console, enable this module.

USEMODULE += stdio_usb_serial_jtag

@see cpu_esp32

@defgroup cpu_esp32 ESP32 SoC Series
@ingroup cpu
@brief Implementation for Espressif ESP32 SoC Series
Expand Down Expand Up @@ -2269,5 +2265,3 @@ pm_set (mode=2) at cpu/esp32/periph/pm.c:117
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

[Back to table of contents](#esp32_toc)

*/
19 changes: 8 additions & 11 deletions cpu/esp32/doc_esp32.txt → cpu/esp32/doc_esp32.doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
/*
* Copyright (C) 2022 Gunar Schorcht
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/

/**
<!--
Copyright (C) 2025 Gunar Schorcht

This file is subject to the terms and conditions of the GNU Lesser
General Public License v2.1. See the file LICENSE in the top level
directory for more details.
-->

@defgroup cpu_esp32_esp32 ESP32 family
@ingroup cpu_esp32
@brief Specific properties of ESP32 variant (family)
Expand Down Expand Up @@ -289,5 +288,3 @@ TMS | GPIO14 (MTMS)
GND | GND

</center><br>

*/
19 changes: 8 additions & 11 deletions cpu/esp32/doc_esp32c3.txt → cpu/esp32/doc_esp32c3.doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
/*
* Copyright (C) 2022 Gunar Schorcht
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/

/**
<!--
Copyright (C) 2025 Gunar Schorcht

This file is subject to the terms and conditions of the GNU Lesser
General Public License v2.1. See the file LICENSE in the top level
directory for more details.
-->

@defgroup cpu_esp32_esp32c3 ESP32-C3 family
@ingroup cpu_esp32
@brief Specific properties of ESP32-C3 variant (family)
Expand Down Expand Up @@ -235,5 +234,3 @@ For more information about JTAG configuration for ESP32-C3, refer to the
section [Configure Other JTAG Interface]
(https://docs.espressif.com/projects/esp-idf/en/latest/esp32c3/api-guides/jtag-debugging/configure-other-jtag.html)
in the ESP-IDF documentation.

*/
19 changes: 8 additions & 11 deletions cpu/esp32/doc_esp32s2.txt → cpu/esp32/doc_esp32s2.doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
/*
* Copyright (C) 2022 Gunar Schorcht
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/

/**
<!--
Copyright (C) 2025 Gunar Schorcht

This file is subject to the terms and conditions of the GNU Lesser
General Public License v2.1. See the file LICENSE in the top level
directory for more details.
-->

@defgroup cpu_esp32_esp32s2 ESP32-S2 family
@ingroup cpu_esp32
@brief Specific properties of ESP32-S2 variant (family)
Expand Down Expand Up @@ -330,5 +329,3 @@ For more information about JTAG configuration for ESP32-S2, refer to the
section [Configure Other JTAG Interface]
(https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/api-guides/jtag-debugging/configure-other-jtag.html)
in the ESP-IDF documentation.

*/
19 changes: 8 additions & 11 deletions cpu/esp32/doc_esp32s3.txt → cpu/esp32/doc_esp32s3.doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
/*
* Copyright (C) 2022 Gunar Schorcht
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/

/**
<!--
Copyright (C) 2025 Gunar Schorcht

This file is subject to the terms and conditions of the GNU Lesser
General Public License v2.1. See the file LICENSE in the top level
directory for more details.
-->

@defgroup cpu_esp32_esp32s3 ESP32-S3 family
@ingroup cpu_esp32
@brief Specific properties of ESP32-S3 variant (family)
Expand Down Expand Up @@ -386,5 +385,3 @@ For more information about JTAG configuration for ESP32-S3, refer to the
section [Configure Other JTAG Interface]
(https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/api-guides/jtag-debugging/configure-other-jtag.html)
in the ESP-IDF documentation.

*/
11 changes: 8 additions & 3 deletions cpu/esp8266/doc.txt → cpu/esp8266/doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
/**
<!--
Copyright (C) 2025 Gunar Schorcht

This file is subject to the terms and conditions of the GNU Lesser
General Public License v2.1. See the file LICENSE in the top level
directory for more details.
-->

@defgroup cpu_esp8266 ESP8266 / ESP8285
@ingroup cpu
@brief RIOT-OS port for Espressif's ESP8266 / ESP8285 MCUs
Expand Down Expand Up @@ -1305,5 +1312,3 @@ execution. If you know where you want to break before downloading the program
to the target, you can use `gdbstub_do_break()` as much as you want.

[Back to table of contents](#esp8266_toc)

*/
11 changes: 11 additions & 0 deletions cpu/esp_common/doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!--
Copyright (C) 2025 Gunar Schorcht

This file is subject to the terms and conditions of the GNU Lesser
General Public License v2.1. See the file LICENSE in the top level
directory for more details.
-->

@defgroup cpu_esp_common ESP Common
@brief Common modules for Espressif ESP SoCs
@ingroup cpu
5 changes: 0 additions & 5 deletions cpu/esp_common/doc.txt
View file
Open in desktop

This file was deleted.