Commit Graph

148 Commits

Author SHA1 Message Date
laokaiyao
8ef9fd4623 dac: optimize the dma stratege 2022-10-25 17:14:59 +08:00
laokaiyao
f9f9a09dfb dac: update unit-test docs and examples for driver-NG 2022-10-25 17:00:41 +08:00
Marius Vikhammer
952994347a docs: cleanup target specific doxygen files
Move all headers that can be common to the common Doxyfile. Reduces copy-paste
potential for errors when adding new targets.
2022-10-18 14:18:48 +08:00
Michael (XIAO Xufeng)
02a9de904a essl: move from esp-idf component to extra component 2022-09-26 12:26:55 +08:00
Laukik Hase
ae932c8c4e
docs: Added migration guide for app_update
- Deprecated functions and alternatives
2022-08-17 10:59:31 +05:30
KonstantinKondrashov
3f6a1625bb efuse: Adds missing header 2022-08-02 22:43:12 +08:00
morris
75d411a003 doc: update sdm api reference 2022-07-20 14:59:50 +08:00
Armando
5b523a3313 esp_adc: new esp_adc component and adc drivers 2022-07-15 18:31:00 +08:00
David Čermák
46fe7dbc8c Merge branch 'component/mdns_migration' into 'master'
mdns: Remove internal component, examples, test and docs

Closes IDF-4074

See merge request espressif/esp-idf!17683
2022-07-04 17:45:27 +08:00
Cao Sen Miao
d9b4b82edc spi_flash: Modify documentations 2022-07-01 10:59:34 +08:00
gabsuren
d413a71f61 mdns: Remove internal component, examples, test and docs 2022-06-29 17:30:34 +04:00
Ondrej Kosta
43f3904304 esp_eth: IEEE 802.3 PHY MII Management Interface functionality grouped to one common file 2022-06-24 05:51:44 +00:00
laokaiyao
28b8fc6a7e i2s: update documents for driver-NG 2022-06-15 10:30:04 +08:00
laokaiyao
0fe3bb8ab7 i2s: update examples and unit-tests 2022-06-15 10:29:06 +08:00
laokaiyao
621d0aa942 i2s: Introduced a brand new driver 2022-06-15 10:29:06 +08:00
Darian Leung
61eb7baa6b esp_hw_support: Add esp_cpu.h abstraction and API
This commit updates the esp_cpu.h API. The new API presents a new
abstraction of the CPU where CPU presents the following interfaces:

- CPU Control (to stall/unstall/reset the CPU)
- CPU Registers (to read registers commonly used in SW such as SP, PC)
- CPU Interrupts (to inquire/allocate/control the CPUs 32 interrupts)
- Memory Port (to configure the CPU's memory bus for memory protection)
- Debugging (to configure/control the CPU's debugging port)

Note: Also added FORCE_INLINE_ATTR to the DoxyFile in order to pass doc
        builds for esp_cpu.h
2022-06-14 14:30:58 +08:00
wangmengyang
1423d02cb0 Added BT_SDP API reference document 2022-05-28 23:34:21 +00:00
xiongweichao
b2987c1e94 Added BT_L2CAP API reference document 2022-05-28 23:34:21 +00:00
Darian Leung
eec3ac83f4 esp_system: Update watchdog documentation
This commit updates the watchdog documentation as follows:

- Removes IWDT API reference as it is now considered private API
- Rewrite IWDT section
- Fix headers, types, and formatting
2022-05-18 20:12:25 +08:00
Marius Vikhammer
c8617fe965 docs: fix all doxygen warnings
Doxygen warnings would previously not result in a failed pipeline.
Fixed this as well as all current warnings.
2022-05-12 14:50:03 +08:00
morris
a7f6f8677a doc: update api reference for new rmt driver 2022-05-07 10:34:50 +00:00
Jiang Jiang Jian
34211f898c Merge branch 'docs/update_esp_hid_device' into 'master'
[docs] fix documents for Bluetooth HID Device API reference and example

See merge request espressif/esp-idf!17558
2022-05-05 23:58:07 +08:00
Marius Vikhammer
197be02748 docs: update esp-docs 1.0.0
Update esp-docs to 1.0.0 and fix new warnings introduced from update
2022-04-25 12:07:11 +08:00
aleks
9fdf39651b freemodbus: remove component files from esp-idf (fix examples) 2022-04-19 07:23:17 +00:00
songruo
60bb5c913d clk_tree: prework of introducing clk subsystem control
1. Clean up clk usage in IDF, replace rtc_clk_xtal/apb_freq_get with
   upper level API esp_clk_xtal/apb_freq
2. Fix small errors and wrong comments related to clock
3. Add clk_tree_defs.h to provide an unified clock id for each chip
   Modify the NGed drivers to adopt new clock ids
2022-04-11 12:09:06 +08:00
wangmengyang
0760a969a8 component/docs: enable generation of API-reference documents for Bluetooth HID device 2022-04-11 02:50:50 +00:00
Marius Vikhammer
a6543f0d21 docs: fix broken references to misc API functions and types. 2022-03-27 16:46:57 +08:00
Mahavir Jain
19194f612d
docs: Add esp_tls_errors.h to API reference list
Closes DOC-2797
2022-03-25 07:31:41 +05:30
Jiang Jiang Jian
7c7e8a83b9 Merge branch 'refactor/wifi_remove_legacy_evts' into 'master'
Remove legacy system event framework.

Closes IDF-3608

See merge request espressif/esp-idf!16240
2022-03-10 10:30:10 +08:00
morris
b841332aa5 Merge branch 'component/esp_websocket_migration' into 'master'
websocket: Remove internal component, examples and test

Closes IDF-4076

See merge request espressif/esp-idf!17273
2022-03-09 19:12:55 +08:00
Sagar Bijwe
6501eff7f5 Remove legacy system event framework. 2022-03-09 15:53:45 +05:30
morris
4dfbc9ee7b rmt: remove deprecated functions 2022-03-09 10:58:14 +08:00
gabsuren
f3c7215565 websocket: Remove internal component, examples and test 2022-03-07 11:07:40 +04:00
Sudeep Mohanty
4067bc40fc docs: Updated ULP documentation
This commit updates documentation for ULP.
2022-03-01 09:02:41 +05:30
Marius Vikhammer
072554f761 docs: removed duplicate header includes in doxyfile 2022-02-22 09:55:18 +08:00
Sudeep Mohanty
2fc9bd61bf ulp: refactor ulp component
This commit refactors the ulp component.
Files are now divided based on type of ulp, viz., fsm or risc-v.
Files common to both are maintained in the ulp_common folder.

This commit also adds menuconfig options for ULP within the ulp
component instead of presenting target specific configuations for ulp.
2022-01-27 11:54:42 +05:30
morris
e36f47a153 doc: API reference for GPTimer 2022-01-07 14:59:09 +08:00
Shang Zhou
79f1e7b33a docs:Add esp_mac.h header file to Miscellaneous System APIs in API Reference 2021-12-22 14:10:21 +08:00
Armando
4dc0d6b2fe adc: support adc dma driver on all chips 2021-12-16 00:19:15 +00:00
Omar Chebib
9d5923a13e IPC: Move ipc sources to esp_system
IPC shall be put back into esp_system as it is an 'OS additions'.
2021-11-11 10:30:01 +08:00
Sudeep Mohanty
4846222102 freertos: update freertos folder structure to match upstream
The following changes have been made:
1. All FreeRTOS kernel source files are now placed in the
   freertos/FreeRTOS-Kernel folder to match with the upstream folder structure.
2. All kernel include files are now placed in freertos/FreeRTOS-Kernel/include.
3. All port files are now placed in freertos/FreeRTOS-Kernel/portable.
4. All additions/customizations are placed in freertos/esp_additions.
5. All other miscellaneous files (README, License files etc.) are moved to
   freertos/FreeRTOS-Kernel folder to match with the upstream.
6. Updated esp-cryptoauthlib to latest commit to resolve FreeRTOS
   include dependencies.

Signed-off-by: Sudeep Mohanty <sudeep.mohanty@espressif.com>
2021-10-29 12:05:13 +08:00
Marius Vikhammer
83554054c2 docs: define __DOXYGEN__ for doxygen builds
Some docs depended on __DOXYGEN__ but this was never defined anywhere.
2021-10-25 13:48:33 +08:00
Zim Kalinowski
53f47ab2fa Merge branch 'feature/add-conditional-section-tags-in-freertos-source-files' into 'master'
freertos: added doxygen section tags for conditional documentation

Closes IDF-3871 and IDF-3872

See merge request espressif/esp-idf!15442
2021-10-11 08:46:32 +00:00
Sudeep Mohanty
52050ed883 freertos: added doxygen section tags for conditional documentation
Added DOC_EXCLUDE_SECTION section tag to conditionally remove sections
from FreeRTOS source files which we don't want in IDF API docs.
Added DOC_SINGLE_GROUP section tag to enable a flat document for
FreeRTOS and removing groups.
With these conditional tags, we can upstream FreeRTOS files without
affecting the upstream documentation.

Signed-off-by: Sudeep Mohanty <sudeep.mohanty@espressif.com>
2021-10-11 09:24:41 +05:30
suda-morris
aa73e423d4 lcd: initial build of API docs 2021-10-02 14:23:31 +08:00
Shu Chen
e770817dc7 openthread: refine ot_rcp example documentation and APIs 2021-08-26 16:10:16 +08:00
zhangwenxu
4175aa0892 openthread: add ot_rcp example 2021-08-25 18:04:45 +08:00
Marius Vikhammer
7411321603 docs: update to use esp-docs 2021-08-24 08:56:48 +08:00