Wang Zi Yan
d7cdcfb76b
docs: update out-of-sync api reference docs
2023-04-18 08:00:39 +00:00
Linda
528bc7b35a
fix a typo in api-reference/system/ota
2023-04-14 17:21:36 +08:00
wuzhenghui
fcf0498da8
esp_pm: update doc for PM_POWER_DOWN_PERIPHERAL_IN_LIGHT_SLEEP
2023-03-30 10:33:47 +08:00
Armando
abb03b8dc4
doc: added memory management programming guides
2023-03-22 16:33:52 +08:00
daiziyan
9ba9dc04b0
docs: updated flash-encryption, startup, memory-types and misc_system_api
2023-03-07 18:06:52 +08:00
Wu Zheng Hui
2066977b48
Merge branch 'feature/bringup_esp32c6_deepsleep_support_master' into 'master'
...
esp32c6: bringup deepsleep examples
Closes IDF-6051, IDF-6052, IDF-5349, IDF-5924, and WIFI-5352
See merge request espressif/esp-idf!22300
2023-03-03 23:53:10 +08:00
wuzhenghui
709adaaa37
soc_caps: since esp32c6 only support one ext wakeup src, split SOC_PM_SUPPORT_EXT_WAKEUP
...
Close IDF-5924
2023-03-02 15:06:05 +08:00
Wang Zi Yan
c490c3a183
docs: update CN for index/spi_slave/system_time
2023-03-02 07:04:49 +00:00
Sudeep Mohanty
6c1a544782
Merge branch 'docs/ulp_docs_incorrect_notes' into 'master'
...
docs: Ulpdated ULP docs to have the correct notes directive
Closes IDF-2522
See merge request espressif/esp-idf!22415
2023-02-24 18:17:31 +08:00
jingli
8f415a7f44
refactor: power management component use unified esp_pm_config_t
2023-02-23 11:36:07 +08:00
Jakob Hasse
603fc32e24
Merge branch 'docs/fix_broken_link_format' into 'master'
...
docs: fix rst external links with wrong format
See merge request espressif/esp-idf!22335
2023-02-20 14:28:07 +08:00
Sudeep Mohanty
449ea7cab7
docs: Ulpdated ULP docs to have the correct notes directive
...
This commit updates the ULP .rst files to have the correct notes
directive format. The notes directives were missing a colon.
2023-02-17 12:55:25 +01: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
98c55f29d1
docs: fix rst external links with wrong format
2023-02-13 11:51:31 +08:00
Mo Fei Fei
6d4313f414
Docs: update CN trans for idf_monitor.rst
2023-02-03 11:20:18 +01: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
Wang Zi Yan
9d80d981b5
docs: CN translation for system_time.rst and migration-guides: 5.1/networking.rst
2023-01-17 16:16:03 +01: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
Wang Zi Yan
1568f9b7ef
docs: remove outdated section on custom toolchain for 64-bit time_t
...
Co-authored-by: Ivan Grokhotkov <ivan@espressif.com>
2023-01-16 14:19:56 +08:00
Michael (XIAO Xufeng)
57a9c67c01
index
2022-12-29 01:00:31 +08:00
Michael (XIAO Xufeng)
daa4af1b1f
docs: split spi_flash api-reference documents to peripherals folder
2022-12-29 00:59:03 +08:00
Linda
8eeeb895f1
update CN translation of api-reference/system/ota
2022-12-21 16:59:43 +08:00
Mo Fei Fei
689c2f46e2
Docs: update CN trans for sleep_modes.rst, misc_system_api.rst, migration_guides/peripherals.rst
2022-12-20 10:35:49 +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
morris
aeaef08f0e
doc: update twai api reference for esp32c6
2022-11-04 17:40:29 +08:00
KonstantinKondrashov
1f9260d790
all: Apply new version logic (major * 100 + minor)
2022-11-03 08:36:23 +00:00
Marius Vikhammer
ca4ad3ce7c
docs: add support for building C6 docs
2022-10-13 04:39:16 +00:00
Mo Fei Fei
7edf5090ab
Docs: Update cn trans for migration-guides/system.rst and api-reference/system/ulp-risc-v.rst
2022-09-14 21:33:50 +08:00
Alexey Lapshin
a9bd454529
tools: update esp32ulp-elf to v2.35_20220830
...
Closes https://github.com/espressif/esp-idf/issues/6432
Closes https://github.com/espressif/binutils-esp32ulp/issues/23
2022-09-13 12:55:48 +04:00
Marius Vikhammer
8bf4af572b
Merge branch 'docs/c2_storage_update' into 'master'
...
docs: update storage and sleep docs for C2
Closes IDF-4207
See merge request espressif/esp-idf!19453
2022-08-23 23:56:56 +08:00
Laukik Hase
ae932c8c4e
docs: Added migration guide for app_update
...
- Deprecated functions and alternatives
2022-08-17 10:59:31 +05:30
Shang Zhou
ea26e6a635
docs: Update CN version for MR19453
2022-08-15 16:14:14 +08:00
Marius Vikhammer
26dc5fe188
docs: update storage and sleep docs for C2
2022-08-15 07:04:28 +00:00
daiziyan
d422e2e7fa
docs: updated trans for ulp-risc-v,fatfs and sleep_modes
2022-08-10 16:53:51 +08:00
morris
741b031e83
soc: added SOC_TOUCH_SENSE_SUPPORTED macro
2022-07-22 00:12:36 +00:00
Jing Li
66395a5c00
system/sleep: further fix spi flash/ram current leakage
2022-07-21 19:14:26 +08:00
jingli
d3c6fff25a
improve docs about flash power-down
2022-07-05 19:25:21 +08:00
KonstantinKondrashov
7b9d1eaf31
doc(efuse): Updates efuse article
2022-06-07 20:44:27 +08:00
songruojing
729d70129a
clk_tree: add initial docs for clock tree
2022-05-24 22:59:51 +08:00
Marius Vikhammer
030e52f5d4
Merge branch 'feature/improve_doc_link_check' into 'master'
...
docs: fix broken links and re-enable linkchecker
Closes IDF-2640
See merge request espressif/esp-idf!17919
2022-05-19 15:52:17 +08:00
morris
8138f8bb02
driver: remove deprecated code
...
that declared as deprecated in the previous release
2022-05-19 11:31:53 +08:00
mofeifei
4be8497391
docs: add cn trans for system_time
2022-05-13 14:10:35 +08:00
Marius Vikhammer
030cb77597
docs: update redirected links
2022-05-07 13:09:41 +08:00
Marius Vikhammer
45c1d1cba2
Merge branch 'feature/move_target_kconfig_2' into 'master'
...
system: move kconfig options out of target component
See merge request espressif/esp-idf!17321
2022-04-24 13:29:43 +08:00
Marius Vikhammer
d2872095f9
soc: moved kconfig options out of the target component.
...
Moved the following kconfig options out of the target component:
* CONFIG_ESP*_DEFAULT_CPU_FREQ* -> esp_system
* ESP*_REV_MIN -> esp_hw_support
* ESP*_TIME_SYSCALL -> newlib
* ESP*_RTC_* -> esp_hw_support
Where applicable these target specific konfig names were merged into
a single common config, e.g;
CONFIG_ESP*_DEFAULT_CPU_FREQ -> CONFIG_ESP_DEFAULT_CPU_FREQ_MHZ
2022-04-21 12:09:43 +08:00
mofeifei
3a35ed7cfa
docs:change system.rst name
2022-04-20 13:11:02 +08:00
mofeifei
485cdd9a74
docs: add cn trans for system.rst
2022-04-20 13:07:38 +08:00
mofeifei
6b2d551ecc
docs: add cn trans for sleep-modes
2022-04-13 10:37:59 +00:00
Marius Vikhammer
a6543f0d21
docs: fix broken references to misc API functions and types.
2022-03-27 16:46:57 +08:00
Sagar Bijwe
6501eff7f5
Remove legacy system event framework.
2022-03-09 15:53:45 +05:30
intern
e43bf8510b
docs: update readme and power management cn trans
2022-03-09 14:22:36 +08:00
intern
6151cc8b68
docs: update cn trans for upl docs
2022-03-02 19:03:20 +08:00
Sudeep Mohanty
4067bc40fc
docs: Updated ULP documentation
...
This commit updates documentation for ULP.
2022-03-01 09:02:41 +05:30
Shang Zhou
33a00cf197
docs: Updated CN translation for index files in api-guides and api-reference
2022-02-23 14:48:26 +08:00
laokaiyao
cf049e15ed
esp8684: rename target to esp32c2
2022-01-19 11:08:57 +08:00
Darian Leung
3b29030e10
docs: Update Power Management and Sleep Modes docs for ESP32-S3
2022-01-06 10:04:29 +08:00
Marius Vikhammer
82325f6037
docs: update docs to be able to build with esp8684
2021-12-20 10:32:49 +08:00
Simon
fc14d3f9aa
Merge branch 'doc/update_usj_docs' into 'master'
...
docs: update usb_serial_jtag documents
Closes IDF-3202 and DOC-2301
See merge request espressif/esp-idf!15922
2021-11-23 07:41:53 +00:00
Dai Zi Yan
1ca83a5bc9
Update CN trans for timers.rst and ota.rst
2021-11-23 07:16:11 +00:00
Cao Sen Miao
4ae714c43c
docs: update using usb_serial_jtag documents
2021-11-23 14:12:13 +08:00
Marius Vikhammer
b6a06b7533
docs: remove invalid symbol from ota.rst file
2021-11-18 11:37:09 +08:00
daiziyan
0ff2776b1e
docs: update CN translation for ota.rst and console.rst
2021-11-16 19:23:09 +08:00
intern
45925c28fd
docs: update translation for jtag-debugging/index.rst and power_management.rst
2021-08-26 12:21:19 +08:00
Wang Ning
2c31ac24c1
docs/add_how_to_debug_ota_failure_to_api_references
2021-06-16 19:28:01 +08:00
Angus Gratton
e14edecf5f
docs: Add random number generation to the API Reference System section
2021-05-18 16:05:42 +10:00
Angus Gratton
e6d15a0975
docs: Rename esp_pthread docs to pthread, expand details of supported APIs
...
- Move the code that was in the document out to an example
2021-05-14 10:03:11 +10:00
Marius Vikhammer
91439e3818
docs: updated system api-reference chapters for C3
2021-03-15 18:51:12 +08:00
KonstantinKondrashov
b7155a161b
otatool: Fixes read_ota_partition cmd, required output arg
...
Closes: https://github.com/espressif/esp-idf/issues/6559
2021-03-04 06:02:54 +00:00
KonstantinKondrashov
5a5f5ad031
doc/efuse: Adds efuse doc for ESP32-C3
2021-02-22 15:51:45 +08:00
morris
1be923acb4
rmt: rename always_on to aware_dfs
2020-11-05 19:00:55 +08:00
Ivan Grokhotkov
840efc2f54
docs: describe power management logic for ESP32-S2, fix translation
2020-10-14 09:05:10 +02:00
Krzysztof
db0c6d7921
docs: Add esp_rom_printf to API Reference
2020-09-10 22:55:43 +08:00
morris
b30bd7a2ef
esp32s2: add CP_DMA driver
2020-08-04 15:28:32 +08:00
Felipe Neves
938a73756c
esp_common/shared_stack: modifed the stack switch procedure to a simpler way
...
esp_common/shared_stack: refactored the implemenation of shared stack function (still not working properly)
esp_expression_with_stack: refactored the shared stack function calling mechanism and updated the documentation
2020-07-14 12:56:02 +00:00
morris
29f8aecfc0
console_repl: change config structure to support different devices
2020-07-02 07:39:46 +00:00
Darian Leung
97721d469c
TWAI: Add ESP32-S2 support
...
This commit adds TWAI driver support for the
ESP32-S2. The following features were added:
- Expanded BRP support
- Expanded CLKOUT Divider Support
- Updated example READMEs
2020-06-30 16:56:03 +08:00
Wang Ning
3784d499af
Add translation for ota tool and partation tool
2020-03-25 21:44:33 +08:00
Angus Gratton
a9854f7085
Merge branch 'feature/rmt_clock_support_ref_tick' into 'master'
...
rmt: support ref tick && refactor unit test && re-enable unit test on ESP32-S2
Closes IDFGH-1715
See merge request espressif/esp-idf!7614
2020-03-06 15:03:52 +08:00
morris
0e4d82bc55
rmt: support REF_TICK as channel clock source
...
Closes https://github.com/espressif/esp-idf/pull/3952
2020-03-03 20:14:46 +08:00
Marius Vikhammer
c26a765a37
doc: remove uncessary .. only:: dirs
...
Removed some only directives that are no longer needed with include being processed correctly
2020-03-03 11:37:42 +08:00
suda-morris
75cadc2e41
console: simplify examples
...
1. simplify console examples
2. add "quit" command
3. support console command overwrite
4. add API reference
2020-02-07 20:15:06 +08:00
Anton Maklakov
a2516c6188
doc: Add a link to CN translation for power_management_esp32
2020-02-07 16:37:44 +11:00
Marius Vikhammer
1a90470f02
doc: Split HW-Reference into seperate files/folders for different chips
2020-02-07 16:37:44 +11:00
Marius Vikhammer
cfeb9e68cb
doc: Changed Chinese doc to use dynamic chip name
2020-02-07 16:37:43 +11:00
Angus Gratton
66462ca26f
docs: Apply the same basic ESP32/ESP32-S2 warning filters to Chinese docs
2020-02-07 16:37:43 +11:00
Angus Gratton
e6211c7864
docs: add new top-level docs builder that builds docs for a single chip
2020-02-07 16:37:43 +11:00
KonstantinKondrashov
c23549c04f
docs: Add System time chapter and for sntp a description about using CONFIG_LWIP_SNTP_UPDATE_DELAY option
...
Closes: https://github.com/espressif/esp-idf/issues/4386
Closes: IDFGH-2237
Closes: IDF-1199
2020-01-10 14:49:07 +11:00
Felipe Neves
88dd15c806
docs: synchronized the contents of en with cn folders adding the esp-expression-with-stack documentation
2019-12-20 13:18:13 -03:00
morris
57ef88a91f
ethernet: add pm lock
2019-12-03 16:10:20 +08:00
Dmitry
a0730fec2a
Performance monitor component. The component contains APIs, example and
...
documentation.
2019-08-23 11:20:12 +03:00
Wang Fang
32954e5f90
Add Chinese translation to api-reference/system/power-management.rst
...
1. Add translation to docs/zh_CN/api-reference/system/power_management.rst
2. Add a link to docs/en/api-reference/system/power_management.rst
2019-06-26 20:42:56 +08:00
Konstantin Kondrashov
12a7d39ed6
docs: Add description
2019-06-24 12:33:33 +08:00
Ivan Grokhotkov
6890ea09cd
docs: add event handling API guide
2019-04-11 12:04:58 +08:00
Konstantin Kondrashov
ba903e7618
docs: Add efuse
2019-02-28 07:31:29 +00:00
Renz Christian Bagaporo
5a83347bec
event: Implement event loop library
2018-10-26 13:14:19 +08:00
Jeroen Domburg
81e35a142a
Spiram: Add option to reserve MMU banks; add himem API to make use of those banks
2018-10-15 14:32:58 +08:00
Ivan Grokhotkov
8403adf4e0
docs: add API reference section for esp_system.h
2018-08-20 16:49:20 +08:00
Jitin George
1fecdc3891
esp_https_ota: Add support for HTTPS based ota feature
2018-08-03 16:47:07 +05:30
Ivan Grokhotkov
d9f8311b9d
docs: add error codes reference
2018-06-15 15:49:24 +08:00
Darian Leung
4bfa30967f
freeRTOS/Re-factor ring buffers
...
This fixes multiple bugs with ring buffers and re-factors the code. The public
API has not changed, however the underlying implementation have various private
functions have been changed. The following behavioral changes have been made
- Size of ring buffers for No-Split/Allow-Split buffers will not be rounded
up to the nearest 32-bit aligned size. This was done to simplify the
implementation
- Item size for No-Split/Allow-Split buffers will also be rounded up to the
nearest 32-bit aligned size.
The following bugs have been fixed
- In copyItemToRingbufAllowSplit(), when copying an item where the aligned
size is smaller than the remaining length, the function does not consider
the case where the true size of the item is less than 4 bytes.
- The copy functions will automatically wrap around the write pointers when
the remaining length of the buffer is not large enough to fit a header, but
does not consider if wrapping around will cause an overlap with the read
pointer. This will make a full buffer be mistaken for an empty buffer
closes #1711
- xRingbufferSend() can get stuck in a infinite loop when the size of the
free memory is larger than the needed_size, but too small to fit in the ring
buffer due to alignment and extra overhead of wrapping around.
closes #1846
- Fixed documentation with ring buffer queue set API
- Adding and removing from queue set does not consider the case where the
read/write semaphores actually hold a value.
The following functions have been deprecated
- xRingbufferIsNextItemWrapped() due to lack of thread safety
- xRingbufferAddToQueueSetWrite() and xRingbufferRemoveFromQueueSetWrite()
as adding the queue sets only work under receive operations.
The following functions have been added
- xRingbufferReceiveSplit() and xRingbufferReceiveSplitFromISR() as a thread
safe way to receive from allow-split buffers
- vRingbufferGetInfo()
Documentation for ring buffers has also been added.
2018-05-21 01:04:58 +00:00
Kedar Sovani
7a0cab0a5b
pthread: Allow configuration of priority and stacksize
...
The expected usage is:
esp_pthread_set_cfg(cfg);
pthread_create()
If the inherit flag is set, then all subsequent threads forked by this
thread will also inherit this configuration. This avoids having to
change/prefix this for each and every pthread_create() call.
2018-03-20 18:06:32 +05:30
krzychb
097adc3a33
Moved files into separate folders per 'en' and 'zh_CN' language version and linked 'zh_CN' files back to 'en' files if translation is not yet available
2018-03-13 21:57:08 +01:00