Commit Graph

176 Commits

Author SHA1 Message Date
Marius Vikhammer
d19600e0a7 ulp/lp-core: added docs describing the lp core 2023-06-06 17:42:03 +08:00
Laukik Hase
a06118012e
docs: Update nvs_flash docs for the HMAC-based NVS encr-keys protection scheme
- Also updated the `nvs_partition_generator` and `mass_mfg` tools
  documentation
2023-05-23 13:55:57 +05:30
KonstantinKondrashov
69838403f9 esp_bootloader_format: Adds bootloader description structure to read bootloader version from app
Closes https://github.com/espressif/esp-idf/issues/8800
Closes https://github.com/espressif/esp-idf/issues/9132
2023-05-10 21:39:52 +08:00
Song Ruo Jing
a4e8960ab4 esp_clk_tree: Rename clk_tree_xxx to esp_clk_tree_xxx, add compilation warning to clk_tree.h 2023-04-25 14:12:06 +08:00
laokaiyao
1f84f6c6ed esp32h4: remove esp32h4 target from ci 2023-04-20 15:19:47 +08:00
Darian Leung
4e7cd2e706 freertos: Add wrapper functions to create objects with capabilities
This commit adds various ...WithCaps() functions to create FreeRTOS objects
with specific memory capabilities.
2023-04-12 12:00:53 +08:00
Sudeep Mohanty
88e4c06028 ulp-riscv-i2c: Updated ULP RISC-V I2C driver to abort when met with errors
The current ULP RISC-V RTC I2C driver got stuck in an infinite loop if
there is a I2C transaction error. This commit amends the driver flow to
abort the read/write operation if met with errors. It also adds a loop
timeout to avoid getting stuck in an infinite loop.The commit also
updates the default bus timing parameters for RTC I2C to be faster.
This commit also adds documentation help to guide users when they meet
with issues while working with the RTC I2C driver on the ULP RISC-V coprocessor.
2023-03-29 13:25:46 +02:00
Armando
abb03b8dc4 doc: added memory management programming guides 2023-03-22 16:33:52 +08:00
laokaiyao
53584bb5a7 ana_cmpr: add programming guide 2023-03-17 14:35:55 +08:00
Jiang Jiang Jian
266a58f85b Merge branch 'bugfix/add_rf_test_lib' into 'master'
esp_phy: Update esp32c3/s3 phy lib and add test lib

Closes WIFI-5097

See merge request espressif/esp-idf!22058
2023-03-13 20:21:47 +08:00
xiehang
a85ff31f00 Add the esp_phy_cert_test.h file to Doxyfile 2023-03-13 14:15:37 +08:00
Nachiket Kukade
4c76af3f68 esp_wifi: Add support for NAN Discovery and Datapath
Update wifi lib with below -
1. Create NAN Discovery SM for beaconing & cluster formation
2. Create NAN interface for Tx/Rx of beacons & action frames
3. Add commands & events for NAN Services Publish/Subscribe/Followup
4. Add NAN Datapath definitions, Events, Peer structures
5. Support for forming and parsing of Datapath related attributes
6. Modules for NDP Req, Resp, Confirm, Term, Peer management
7. NAN Interface related additions in Datapath, Data Tx Q's

In addition include below changes -
1. Add netif and driver support for NAN Interface
2. Add simple examples for Publisher-Subscriber usecases
3. Add an advanced console example that supports commands
   for NAN Discovery, Services & Datapath
4. Add wifi_apps for providing better NAN API's and Peer management

Co-authored-by: Shyamal Khachane <shyamal.khachane@espressif.com>
2023-03-10 11:18:23 +05:30
morris
a7f5ff32ff doc: initial parallel IO programming guide
Also correct the GPIO information on esp32h2.
2023-03-01 00:43:14 +00:00
jingli
8f415a7f44 refactor: power management component use unified esp_pm_config_t 2023-02-23 11:36:07 +08:00
laokaiyao
f27cd67c00 driver: pack peripherals 2023-02-02 18:19:58 +08:00
David Čermák
2f1d30d155 Merge branch 'bugfix/lwip_core_locking' into 'master'
esp_netif/lwip: Fix core-locking config

Closes IDFGH-8445, IDFGH-9098, and IDFGH-9063

See merge request espressif/esp-idf!20840
2023-01-18 20:31:25 +08:00
David Cermak
a71fa82177 esp_netif/lwip: Fix core-locking config
* Fix thread safety issues in non-core locking
* Add option to verify thread safety issues in lwip (core-lock assertion)
* Make esp_sntp.h thread safe API
* Fix sntp examples
* Fix openthread libs

Closes https://github.com/espressif/esp-idf/issues/9908
Closes https://github.com/espressif/esp-idf/issues/10502
Closes https://github.com/espressif/esp-idf/issues/10466
2023-01-17 16:15:58 +01:00
morris
d9825f5165 Merge branch 'feature/add_clk_tree_get_frequency_api' into 'master'
clk_tree: Stage 4 - Add a general API to get the frequency of different clocks

Closes IDF-6569

See merge request espressif/esp-idf!21830
2023-01-17 17:08:23 +08:00
Song Ruo Jing
2c9aa4559c clk_tree: Add a general API to get the frequency of different clocks
Add basic clk_tree driver and hal implementation.
2023-01-17 11:30:24 +08:00
Marius Vikhammer
7100b7d1ff docs: add support for building H2 docs 2023-01-17 10:04:26 +08:00
Darian Leung
c318c89453 freertos(IDF): Remove dependency on portUSING_MPU_WRAPPERS
This commit removes the dependency on portUSING_MPU_WRAPPERS on the Xtensa port
of IDF FreeRTOS. This dependency was added due to a hack implemented in the
upstream port that required the usage of the "xMPUSettings" member of the TCB.
The "xMPUSettings" would be used as a pointer to the task's coprocessor save
area on the stack, even though FreeRTOS MPU support was not available.

The hack has now been removed, and the CPSA pointer is now calculated using
a combination of constant offsets values and the pxEndOfStack member of the
TCB.

Note: This impelemtation was copied from the Xtensa port of Amazon SMP FreeRTOS.
2022-12-23 15:29:17 +08:00
morris
8277a8e8df doc: gpio glitch filter 2022-12-09 11:33:42 +08:00
Aditya Patwardhan
9bb74d8b07 docs: Fix Doxyfile after esp_ds.h is merged 2022-11-24 16:03:30 +05:30
morris
4019e307f1 doc: add api reference for etm driver 2022-11-23 15:32:34 +08:00
Omar Chebib
cd21058097 C/Cxx: unify static assertions with the macro ESP_STATIC_ASSERT
Closes https://github.com/espressif/esp-idf/issues/9938
2022-11-21 16:18:08 +08:00
wanlei
45cf44e5c8 test: move 'driver/test/esp_serial_slave_link' to 'driver/test-apps/components' and make it be a component 2022-11-10 16:02:03 +08:00
laokaiyao
8677216576 esp32h2: renaming esp32h2 to esp32h4 2022-11-08 17:05:33 +08:00
Michael (XIAO Xufeng)
c546de8d82 Merge branch 'feature/apply_new_version_logic' into 'master'
all: Apply new version logic (major * 100 + minor)

Closes IDF-4932 and IDF-4939

See merge request espressif/esp-idf!18787
2022-11-04 16:01:32 +08:00
Ivan Grokhotkov
b14116ff95 Merge branch 'feature/partition_api_new_component_2' into 'master'
Storage: Partition APIs moved to the new component 'esp_partition'

Closes IDF-1234

See merge request espressif/esp-idf!20747
2022-11-04 14:59:08 +08:00
KonstantinKondrashov
1f9260d790 all: Apply new version logic (major * 100 + minor) 2022-11-03 08:36:23 +00:00
laokaiyao
2cccf3a804 dac: update API and file format aligning to the rule 2022-11-03 13:04:50 +08:00
Martin Vychodil
c9c7573f71 Storage: Partition APIs moved to the new component 'esp_partition'
All the partition handling API functions and data-types were moved from the 'spi_flash' component to the new one named 'esp_partition'. See Storage 5.x migration guide for more details
2022-11-02 21:54:45 +01:00
Tomas Rezucha
94a00bda0f tinyusb: Use TinyUSB from component registry 2022-11-02 08:24:43 +01:00
Aditya Patwardhan
4100874282 docs: Update esp_hmac references from doxyfile 2022-10-27 11:11:21 +05:30
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
Marius Vikhammer
ca4ad3ce7c docs: add support for building C6 docs 2022-10-13 04:39:16 +00:00
Michael (XIAO Xufeng)
02a9de904a essl: move from esp-idf component to extra component 2022-09-26 12:26:55 +08:00
Zim Kalinowski
f54972d95d Merge branch 'feature/ulp_mutex' into 'master'
ulp-riscv: mutex/lock

Closes IDF-5754

See merge request espressif/esp-idf!19377
2022-08-21 16:27:53 +08:00
Laukik Hase
ae932c8c4e
docs: Added migration guide for app_update
- Deprecated functions and alternatives
2022-08-17 10:59:31 +05:30
Marius Vikhammer
ffed60cc93 ulp-riscv: added lock API to provide mutual exclusion when sharing variables between the main CPU and the ULP. 2022-08-05 18:16:31 +08:00
KonstantinKondrashov
3f6a1625bb efuse: Adds missing header 2022-08-02 22:43:12 +08:00
morris
e4868548c7 doc: update MCPWM api reference with new driver API 2022-07-27 15:22:24 +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
Armando (Dou Yiwen)
0b80546f8e Merge branch 'feature/new_esp_psram_component' into 'master'
esp_psram: new esp psram component

Closes IDF-4318, IDF-4382, IDF-4841, and IDFGH-7192

See merge request espressif/esp-idf!18050
2022-06-15 19:16:56 +08: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
Armando
38e5043ae8 esp_psram: new psram component 2022-06-14 15:44:27 +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
Zim Kalinowski
0440aca4e3 Merge branch 'feature/reevaluate_headers_include_dirs' into 'master'
esp_hw_support/esp_system: Re-evaluate header inclusions and include directories

See merge request espressif/esp-idf!16763
2022-03-08 01:32:24 +08:00
gabsuren
f3c7215565 websocket: Remove internal component, examples and test 2022-03-07 11:07:40 +04:00
Sudeep Mohanty
a9fda54d39 esp_hw_support/esp_system: Re-evaluate header inclusions and include directories
This commit updates the visibility of various header files and cleans up
some unnecessary inclusions. Also, this commit removes certain header
include paths which were maintained for backward compatibility.
2022-03-07 11:18:08 +05:30
Cao Sen Miao
d25feba1bf Temperature_sensor: update temperature sensor documents 2022-03-04 18:13:27 +08:00
morris
2c8e206e50 doc: update API reference for pulse_cnt driver 2022-03-03 22:38:32 +08: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
laokaiyao
cf049e15ed esp8684: rename target to esp32c2 2022-01-19 11:08:57 +08:00
Sudeep Mohanty
2ed15d8b1e ulp: Added ULP RISC-V support for esp32s3
This commit adds support for ULP RISC-V for esp32s3.

Signed-off-by: Sudeep Mohanty <sudeep.mohanty@espressif.com>
2022-01-18 10:58:00 +05:30
morris
e36f47a153 doc: API reference for GPTimer 2022-01-07 14:59:09 +08:00
morris
3b371d2d64 ci: check unstable soc headers wont be leaked by public api 2022-01-06 21:43:12 +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
Marius Vikhammer
82325f6037 docs: update docs to be able to build with esp8684 2021-12-20 10:32:49 +08:00
Armando
4dc0d6b2fe adc: support adc dma driver on all chips 2021-12-16 00:19:15 +00:00
KonstantinKondrashov
209702d055 esp_ipc: Update documentation and API descriptions
This commit updates the documentation and API descriptions of
the esp_ipc and esp_ipc_isr features.
2021-11-18 21:34:50 +08: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
Sachin Billore
81391fb18c Merge branch 'feature/esp_ds_s3' into 'master'
[esp_hw_support]: Digital Signature support for S3

Closes IDF-1791

See merge request espressif/esp-idf!14955
2021-09-03 07:57:26 +00:00
Darian Leung
963836f491 Add USB Host Library API docs
- This commit adds the API documentation for the USB Host Library.
- Warnings about the beta API are also added.
- usb_host_misc.h renamed to usb_helpers.h
2021-09-02 18:40:24 +08:00
Sachin Billore
f80d6f8c21 Digital Signature support for S3
Closes IDF-1791
2021-09-02 11:59:24 +05:30
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