Commit Graph

196 Commits

Author SHA1 Message Date
laokaiyao
45a094367d change(doxyfile): move soc files to target specific doxygen
soc files relies on target variable, which not correct while there are multiple versions for one target
2024-03-01 10:16:45 +08:00
Cao Sen Miao
d11030ade6 docs(jpeg): Add basic programming guide for jpeg decoder 2024-02-29 17:20:09 +08:00
Marius Vikhammer
4d28524bdb docs(esp32c5): add support for building C5 docs 2024-02-01 10:06:41 +08:00
Tomas Rezucha
49f3dae095 Merge branch 'ci/add_p4_usb_host_to_ci' into 'master'
feature(usb): Add USB support for ESP32-P4

Closes IDF-6873

See merge request espressif/esp-idf!28585
2024-01-31 22:04:23 +08:00
Tomas Rezucha
f13ae0fc08 feat(esp32p4): Add USB-OTG support for ESP32-P4 2024-01-30 15:07:11 +01:00
Marius Vikhammer
85fdca43b7 docs(build): add cannonical stable url to all docs 2024-01-29 11:30:59 +08:00
Shu Chen
6bc666064a docs(ieee802154): add migration note for the receive done handler feature 2024-01-25 20:27:14 +08:00
Mahavir Jain
01f50ee7f5
refactor: migrate atecc608a_ecdsa example to crypto authlib repository
- ESP32-WROOM-32SE has been discontinued and marked as NRND
- This change removes all references to ESP32-WROOM-32SE from IDF
- The example has been migrated to esp-cryptoauthlib repository and it
  can be used through the component manager
  (https://components.espressif.com/components/espressif/esp-cryptoauthlib)
2023-12-22 09:11:41 +05:30
Marius Vikhammer
ac3915f092 docs(esp32p4): update misc docs for esp32p4 2023-12-09 09:09:55 +08:00
Marius Vikhammer
30870c819f Merge branch 'docs/fix_dash_encoding' into 'master'
docs(programming_guide): turned off smartquotes

See merge request espressif/esp-idf!27659
2023-12-05 16:47:45 +08:00
Ivan Grokhotkov
b20332535b Merge branch 'feature/idf_qemu_ext' into 'master'
feat(tools): add 'idf.py qemu' extension

Closes IDFGH-817

See merge request espressif/esp-idf!26034
2023-12-05 14:15:57 +08:00
Marius Vikhammer
fd03f1da1f docs(programming_guide): turned off smartquotes
Sphinx would "smartly" format e.g. double dashes into typographically correct entities,
i.e. a long dash unicode character.

This doesnt always work well for our docs were sometimes a double dash could be a python
argument, which when copied would no longer work.
2023-12-05 12:19:15 +08:00
Zhang Xiao Yan
4cd0a6a4b1 Merge branch 'docs/remove_wifi_related_documentation_for_esp32h2' into 'master'
docs: remove WiFi related documentation for ESP32-H2

See merge request espressif/esp-idf!27026
2023-12-05 09:58:06 +08:00
Linda
bd1825f9b1 docs: remove WiFi related documentation for ESP32-H2 2023-12-04 11:12:39 +08:00
Ivan Grokhotkov
71153c7dbb
feat(tools): add 'idf.py qemu' extension
This extension allows running programs in QEMU similar to running
them on a real chip:

- 'idf.py qemu' — builds and runs the program in QEMU. User gets
  a QEMU instance launched, and can work with it as a normal QEMU
  instance.
- 'idf.py qemu monitor' — same, but QEMU is launched in the
  background, and idf_monitor runs in the foreground, showing QEMU
  output. Compared to only running 'idf.py qemu' this enables, for
  example, automatic backtrace decoding.
- 'idf.py qemu gdb' — launches QEMU in the background and opens an
  interactive GDB prompt, connecting it to QEMU.
- 'idf.py qemu --gdb monitor' and 'idf.py gdb' in another shell:
  launches QEMU in the background, keeps it suspended until GDB is
  connected, and opens idf_monitor. GDB can be used in another shell
  to debug the application.
2023-12-03 07:45:19 +01:00
Mahavir Jain
7bb29086df
docs: add ECDSA peripheral chapter for H2/P4
- Add ECDSA peripheral chapter and instructions to program efuse key block
- Update security guide for ECDSA peripheral mention for device identity
- Link with ESP-TLS guide about using ECDSA peripheral in TLS connection
2023-11-15 09:42:26 +05:30
Shyamal Khachane
77aee65708 docs(esp_wifi): Fix inconsistency in NAN documentation 2023-11-01 12:50:12 +05:30
Armando
70314b56d5 feat(sdmmc): supported sd2.0 on esp32p4 2023-10-18 11:57:55 +00:00
Marius Vikhammer
d27dd4d9cb Merge branch 'docs/show_include_path' into 'master'
docs: show include path and require component as part of API header

Closes IDF-3134, DOC-1032, and DOC-3629

See merge request espressif/esp-idf!25092
2023-10-11 09:36:14 +08:00
Marius Vikhammer
ebe68c3ee3 docs(build): add header include path and component require to api reference 2023-10-07 11:47:45 +08:00
Armando
4215adcdb4 feat(cache): added cache msync doc 2023-09-28 15:53:19 +08:00
xuxiao
4701aa1589 feat(doc): update wifi sections for H2 2023-08-31 19:27:51 +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
wangmengyang
d4ac2380e7 component/docs: enable generation of API-reference documents for Bluetooth HID host 2023-06-21 12:02:58 +08:00
Marius Vikhammer
d19600e0a7 ulp/lp-core: added docs describing the lp core 2023-06-06 17:42:03 +08:00
xuxiao
843107e9d6 docs: update esp32c6 api guides about wifi part 2023-05-31 15:20:40 +08:00
Marius Vikhammer
3da38a603a docs: updated misc C6 programming guide docs with minor changes. 2023-05-31 11:17:24 +08:00
Shen Weilong
2900ed4858 ble docs: Update the ble docs for esp32c6 and esp32h2 2023-05-19 11:01:11 +08:00
Marius Vikhammer
359b237cc5 ulp: added sleep support for lp core
Added support for running LP core while hp core sleeps, as well
as waking up the hp core.
2023-04-25 11:51:35 +08:00
laokaiyao
53584bb5a7 ana_cmpr: add programming guide 2023-03-17 14:35:55 +08:00
Marius Vikhammer
24e0d91cd0 docs: fix broken links 2023-03-06 17:29:10 +08:00
morris
a7f5ff32ff doc: initial parallel IO programming guide
Also correct the GPIO information on esp32h2.
2023-03-01 00:43:14 +00:00
Darian Leung
a57496acfe usb_host: Add maintainer's notes (Design, Architecture)
This commit adds some parts of the USB Host Stack's maintainers notes
(specifically "Design" and "Architecture").
2023-01-24 02:49:35 +08:00
Armando
e80e1450ac sdio: c6 doc update 2023-01-18 02:34:46 +00:00
Marius Vikhammer
fd4cadd8a1 docs: ignore xtensa isa-summary during linkcheck 2023-01-17 12:53:38 +08:00
Marius Vikhammer
70d1dbccd8 Merge branch 'docs/enable_h2_build' into 'master'
docs: add support for building H2 docs

Closes IDF-6259

See merge request espressif/esp-idf!21933
2023-01-17 12:11:29 +08:00
Marius Vikhammer
7100b7d1ff docs: add support for building H2 docs 2023-01-17 10:04:26 +08:00
Darian Leung
a52aff81a8 usb_host: Add maintainer's notes (Introduction and DWC_OTG Controller)
This commit adds some parts of the USB Host Stack's maintainers notes
(specifically "Introduction" and "DWC_OTG Controller" chapters).
2023-01-13 20:00:18 +08:00
wuzhenghui
5822cdf93b esp_phy: enable for esp32c6 2022-12-16 15:47:56 +08:00
morris
4019e307f1 doc: add api reference for etm driver 2022-11-23 15:32:34 +08:00
Wang Ning
b757eb6ce4 Docs: Update folder structure for 5.1 migration 2022-10-25 15:16:27 +08:00
Marius Vikhammer
ca4ad3ce7c docs: add support for building C6 docs 2022-10-13 04:39:16 +00:00
Alexey Lapshin
e6f7b1a3a0 tools: cmake: check tool supported version with idf_tools.py 2022-10-03 19:01:32 +04:00
wangjialiang
6e79d05814 ble_mesh: docs: Remove BLE Mesh related reference for C2 2022-09-16 19:39:51 +08:00
Alexey Lapshin
8abef173a1 docs: update link for ESP ROM ELF releases 2022-09-01 15:05:26 +04:00
Zim Kalinowski
e80d4c8f76 Merge branch 'docs/update_linkcheck_ignore_c2' into 'master'
docs: remove C2 datasheet from link check ignore

Closes IDF-4950

See merge request espressif/esp-idf!19514
2022-08-21 16:28:31 +08:00
Marius Vikhammer
8b756f071c docs: remove C2 datasheet from link check ignore 2022-08-11 18:08:00 +08:00
Geng Yuchao
f070ac4da8 Update BLE documentation scope 2022-08-08 20:51:58 +08:00