Commit Graph
113 Commits
Author SHA1 Message Date
Erhan Kurubas 6c6490d54c docs(esp_trace): restructure tracing docs with esp_trace as master
Reorganize the tracing documentation so esp_trace is the master
component, with app_trace, SystemView, and Gcov referenced from it.
2026-07-23 08:58:30 +03:00
Frantisek Hrbata 4cc2d22c48 Merge branch 'docs/cmakev2-build-system-v2' into 'master'
docs(cmakev2): Restructure build system v2 documentation into a guide

Closes IDF-15079 and IDF-15475

See merge request espressif/esp-idf!49781
2026-06-29 07:36:01 +02:00
Frantisek Hrbata f8adfd176e docs(cmakev2): Restructure build system v2 documentation into a guide
Split the single build-system-v2 page into a landing page that dispatches
to focused how-to guides (creating a project, creating components,
configuring dependencies, third-party libraries, ESP-IDF as a library,
multiple binaries) and reference pages (design and architecture, breaking
changes, and the generated API reference). Mirror the new structure on
zh_CN and update the API Guides table of contents.

Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
2026-06-24 09:13:01 +02:00
Liu Linyan bade32f3eb docs(ble_audio): Adopt SIG product name and add LE Audio API guide entry 2026-06-17 14:51:17 +08:00
igor.masar d4d993c818 feat(soc): add USB DFU and OTG console caps
Add USB DFU and OTG console SOC capability flags for esp32s2, esp32s3, and esp32p4.

Use these caps in Kconfig, documentation conditionals, and idf.py DFU actions so USB support
is derived from SOC capabilities instead of hardcoded target names.
2026-05-27 10:58:50 +02:00
igor.masar 9ab7d5eb03 feat(usb): add ESP32-S31 DWC/UTMI support
Add ESP32-S31 USB DWC/UTMI LL headers, SoC register structures, peripheral
descriptors, capabilities, and linker mappings so the HS OTG controller and
UTMI PHY can be built in esp_hal_usb.

Introduce SOC_USB_FSLS_PHY_NUM on USB-OTG targets to separate FSLS USB_WRAP
support from OTG/UTMI support. Use it to gate usb_wrap, the USB PHY driver,
docs, and example build rules on targets without an FSLS PHY.

Also add UTMI data pulldown control to the HAL, clear the boot-time DWC
suspend state on ESP32-S31, alias the legacy internal PHY target to UTMI for
backward compatibility, and extend usb_phy tests for UTMI-only targets.
2026-04-08 16:01:28 +08:00
luweike 7a528c46f6 docs: remove old wifi.rst files after document split 2025-12-09 09:24:17 +08:00
Frantisek Hrbata 17d7507f29 feat(docs): add build system v2 documentation files
Add stump files for the build system v2 documentation with automatic API
generation from CMake files.

Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
2025-10-30 17:17:49 +08:00
igor.masar c74ce1c201 feat(usb/h4): Add USB OTG host support for ESP32-H4
- hal: add DWC OTG core LL (usb_dwc_ll.h) and USB wrap LL (usb_wrap_ll.h)
- soc: add DWC register map/cfg (usb_dwc_struct.h, usb_dwc_cfg.h) and caps
- soc/kconfig: enable SOC_USB_OTG_SUPPORTED=1, SOC_USB_OTG_PERIPH_NUM=1
- docs: add ESP32-H4 to usb_phy test app “Supported Targets”
- ld: export USB_WRAP symbol
- doxygen: include USB Host headers for H4 to emit .inc files
2025-10-02 23:21:08 +02:00
Marius Vikhammer c6f435f390 docs(misc): cleanup docs for C5 and C61 2025-08-18 10:55:01 +08:00
luweike d4fc63553d docs: Migrate ESP32 Bluetooth Architecture PDF content to ESP-IDF 2025-04-11 10:51:19 +08:00
Tomas Rezucha bf86ab3926 feat(dfu): Enable DFU on ESP32-P4 2024-12-11 09:23:32 +01:00
Jan Beran 1fcf006ec6 docs(kconfiglib): Add Project and Component configuration guide
* Project Configuration Guide: how to configure the project, purpose of
  sdkconfig.defaults, where is the configuration stored...
* Component configuration: how to write Kconfig files, how to ensure
  backward compatibility...

Also, general information about Kconfig and its files was added. Other parts of the
documentation (e.g. build-system) now point to these new guides in order
to provide more info.
2024-10-29 10:31:03 +01:00
David Cermak 5af61242d2 feat(wifi): Document WiFi expansion on wifi-less chips 2024-09-30 14:10:19 +08:00
Martin Vychodil e60f6d024e docs(storage): added File system considerations document into the API Guides 2024-08-08 15:57:35 +02:00
Wu Zheng Hui f2cf9a961b Merge branch 'doc/update_esp32p4_pm_programming_guide_docs' into 'master'
docs(pm): update power management related docs for esp32p4

Closes IDF-7672

See merge request espressif/esp-idf!31328
2024-08-01 19:05:15 +08:00
wuzhenghui 172402528d docs(pm): update power management related docs for esp32p4 2024-08-01 15:50:46 +08:00
Yuhan Wei 4b32ffb8a9 docs(ble): created an independent entry for classic bt 2024-07-25 17:05:45 +08:00
Yuhan Wei 8379a45f4d docs(ble): Moved blufi to ble folder 2024-07-25 17:05:45 +08:00
Yuhan Wei 48bf83416a docs(ble): Moved ble-mesh and blufi to ble section 2024-07-25 17:05:45 +08:00
Yuhan Wei c6f974e689 docs(ble): Created an independent BLE folder 2024-07-25 17:05:45 +08:00
Yuhan Wei e4b3fe2f46 docs(ble): Reorganized the bluetooth API guide structure 2024-07-25 17:05:45 +08:00
zhangshuxian 002c10d97b docs: Provide translationfor low power 2024-07-19 17:59:27 +08:00
Alexey Lapshin ed6e497c6f feat(build): add COMPILER_STATIC_ANALYZER option 2024-06-18 14:25:37 +08:00
Ivan Grokhotkov c565f9e028 docs(console): add an API guides page on standard I/O
Closes https://github.com/espressif/esp-idf/issues/13907
2024-06-13 10:40:20 +02:00
Marius Vikhammer 2eb4cd3d84 docs(c61): add docs build for C61 2024-06-03 10:24:27 +08:00
xuxiao 27f61966cd feat(wifi): add esp32c5 beta3 wifi support 2024-04-10 14:09:40 +08:00
alanmaxwell 565660db87 docs: disable build phy.rst for esp32p4 2024-04-01 14:59:57 +08:00
alanmaxwell 1d763691ea docs(phy): rewrite multi antenna docs 2024-04-01 14:59:57 +08:00
alanmaxwell a6cc70e6e7 docs: seperate multiple antennas from Wi-Fi to PHY 2024-04-01 14:59:27 +08:00
Tomas Rezucha f13ae0fc08 feat(esp32p4): Add USB-OTG support for ESP32-P4 2024-01-30 15:07:11 +01:00
wangtao@espressif.com 0d0de9da6b docs:Separate low-power documents 2023-12-01 10:13:19 +08:00
Jakob Hasse ed5a7dfa82 docs: Added C documentation page
Closes https://github.com/espressif/esp-idf/issues/12439
Closes https://github.com/espressif/esp-idf/issues/12001
2023-11-13 10:47:15 +08:00
Yi Ying d8b34c739a Merge branch 'docs/add_bluetooth_overview_page' into 'master'
docs: add bluetooth overview

Closes DOC-5644

See merge request espressif/esp-idf!25030
2023-08-16 19:02:16 +08:00
Marius Vikhammer 27baef2424 docs(esp32p4): added building docs for ESP32-P4 2023-08-16 10:13:47 +08:00
Yi Ying eafbd37e8f docs (Bluetooth): add bluetooth overview document 2023-08-15 11:13:14 +08:00
Aditya Patwardhan 253d80f560 docs/security: Move security related docs in a separate section 2023-06-17 10:04:01 +05:30
Aditya Patwardhan 6d4a116625 docs: Added documentation about enabling the Security Features
externally with help of espefuse tool

flash_encryption_doc: Fix the document to also inform users about what
happens in case of host generated private key in the Flash encryption process
2023-06-17 10:04:01 +05:30
Zhang Xiao Yan 60441881a5 Merge branch 'docs/add_power_measure_module_deep_sleep_mode' into 'master'
docs: add a chapter to describe how to measure current of modules in deep sleep mode

Closes DOC-517

See merge request espressif/esp-idf!21438
2023-06-06 18:29:41 +08:00
Linda af65960d1c docs: add a chapter to describe how to measure current of modules in deep sleep mode 2023-05-30 18:11:53 +08:00
Shen Weilong 2900ed4858 ble docs: Update the ble docs for esp32c6 and esp32h2 2023-05-19 11:01:11 +08:00
Jakob Hasse a44671c11a doc: remove left-over legacy event loop docs 2023-03-17 15:37:26 +08:00
Darian Leung 69433a9660 freertos: Rename SMP changes document to ESP-IDF FreeRTOS
This commit renames "freertos-smp" docuemnt to "freertos_idf". This fits better
with the current dual FreeRTOS implementation (i.e., IDF FreeRTOS and Amazon
SMP FreeRTOS), both of which are SMP capable.
2023-02-15 12:42:04 +08:00
Marius Vikhammer 7100b7d1ff docs: add support for building H2 docs 2023-01-17 10:04:26 +08:00
Jakob Hasse b718c7182c docs(linux): refactored and updated Linux target docs 2022-12-21 17:12:42 +08:00
wuzhenghui 5822cdf93b esp_phy: enable for esp32c6 2022-12-16 15:47:56 +08:00
Mahavir Jain 11f2683c27 docs: add chapter about overall "security" area guide
List down considerations for the following areas:

- Hardware security
- Network security
- Product security

Also added brief explanation about "Security Policy" for ESP-IDF.

Closes IDF-1565
2022-11-25 03:17:05 +00:00
Ivan Grokhotkov 80d3dc9ac5 docs: add C++ support chapter to the API guides 2022-11-04 18:37:03 +01:00
Marius Vikhammer ca4ad3ce7c docs: add support for building C6 docs 2022-10-13 04:39:16 +00:00
wangjialiang 6e79d05814 ble_mesh: docs: Remove BLE Mesh related reference for C2 2022-09-16 19:39:51 +08:00