Commit Graph

496 Commits

Author SHA1 Message Date
Shang Zhou
a17b207e4f docs: Sync up EN and CN lines of ble-mesh, wifi, and i2c 2022-08-09 11:45:34 +08:00
daiziyan
966d18e4fd docs: add CN translation for debugging-examples 2022-07-27 11:36:14 +04:00
Alexey Lapshin
42a22f149a docs: add debugging freertos objects 2022-07-27 11:36:14 +04:00
daiziyan
b995b584bd docs: translated removed-components and build-system 2022-07-26 14:55:01 +08:00
Wang Fang
83a0cd33ce docs: updated documents related to wakeup source, ulp, flash-encryption and memory types 2022-07-25 10:57:40 +08:00
Ivan Grokhotkov
2ce10d44ab
docs: update JTAG related information for ESP32-C2 2022-07-14 15:57:43 +02:00
Linda
476f6d5e04 docs:update linker script generation 2022-07-13 16:35:03 +08:00
Jiang Jiang Jian
3630713e5f Merge branch 'docs/esp32c2_sys_feature_api_guides' into 'master'
docs: update system API-guides for ESP32-C2

Closes IDF-4202, IDF-4213, and IDF-4222

See merge request espressif/esp-idf!18979
2022-07-12 10:59:12 +08:00
Marius Vikhammer
d62421619c docs: update system API-guides for ESP32-C2 2022-07-12 09:32:43 +08:00
Jiang Jiang Jian
9873d4d138 Merge branch 'bugfix/s2_s3_stack_extmem_config' into 'master'
psram: make SPIRAM_ALLOW_STACK_EXTERNAL_MEMORY configurable on S2 and S3

See merge request espressif/esp-idf!18894
2022-07-11 10:54:59 +08:00
Wang Fang
a8aead1986 Merge branch 'docs/update_ide_documentation' into 'master'
docs: deleted IDE documentation and provided links to these IDE GitHub repos

Closes DOC-3254, DOC-2982, and DOC-2961

See merge request espressif/esp-idf!18627
2022-07-08 09:35:13 +08:00
Wang Fang
c69908e976 docs: deleted IDE documentation and provided links to these IDE GitHub repos 2022-07-07 18:14:26 +08:00
Mu Hai Dong
eb4421bf33 doc: esp32c2 wifi programming guide doc. 2022-07-07 14:13:11 +08:00
Marius Vikhammer
342f4f315c psram: make SPIRAM_ALLOW_STACK_EXTERNAL_MEMORY configurable on S2 and S3
SPIRAM_ALLOW_STACK_EXTERNAL_MEMORY was always enabled on S2 and S3, but this option is not
compatible with ESP_COREDUMP_ENABLE_TO_FLASH. Make it configurable to allow users to deactive
it so that ESP_COREDUMP_ENABLE_TO_FLASH can be used.
2022-07-06 12:11:15 +08:00
Jiang Jiang Jian
3d3447831a Merge branch 'docs/update_esp32c2_iperf_throughput' into 'master'
Docs/update esp32c2 iperf throughput

Closes IDFGH-7707

See merge request espressif/esp-idf!18732
2022-07-05 01:54:07 +08:00
Cao Sen Miao
d9b4b82edc spi_flash: Modify documentations 2022-07-01 10:59:34 +08:00
Mu Hai Dong
8078092fae Merge branch 'docs/update_wifi_beacon_timeout_doc' into 'master'
docs: update wifi beacon timeout docs

Closes WIFI-4427 and IDFGH-7496

See merge request espressif/esp-idf!18379
2022-06-29 21:54:29 +08:00
wang tao
2e036ea173 add esp32c2 iperf throughput 2022-06-29 14:55:22 +08:00
Shang Zhou
efdfb7ec61 docs: update BluFi documentation regarding misleading contents 2022-06-14 14:18:13 +08:00
Dai Zi Yan
b264d46d20 Merge branch 'docs/update_build_system' into 'master'
docs: udpate CN translation for build-system

See merge request espressif/esp-idf!18378
2022-06-09 14:09:07 +08:00
Jiang Jiang Jian
20ac5a8464 Merge branch 'docs/update_wifi_csi_sub_carrier_index_doc' into 'master'
docs:update wifi sci subcarrier index docs

Closes WIFI-3215

See merge request espressif/esp-idf!18125
2022-06-09 10:52:38 +08:00
daiziyan
e6a7fee2b4 docs: udpate CN translation for build-system 2022-06-08 19:40:04 +08:00
Dai Zi Yan
f173016d86 Merge branch 'docs/translate_dfu' into 'master'
docs: translate dfu.rst

Closes DOC-1958

See merge request espressif/esp-idf!18238
2022-06-08 17:33:47 +08:00
muhaidong
1b496ed9e2 docs: add WIFI_EVENT_STA_BEACON_TIMEOUT event docs. 2022-06-07 17:59:40 +08:00
daiziyan
7344db748f docs: translate dfu.rst 2022-06-07 11:09:30 +08:00
muhaidong
9be681be35 docs: update wifi beacon timeout docs 2022-06-06 17:00:26 +08:00
Dai Zi Yan
e94435df22 Merge branch 'docs/update_idf_monitor' into 'master'
docs: update CN translation for idf-monitor.rst

Closes DOC-3082

See merge request espressif/esp-idf!18248
2022-06-06 15:45:24 +08:00
Mu Hai Dong
2905223889 Merge branch 'bugfix/fix_country_policy_issue' into 'master'
esp_wifi: fix country policy issue

Closes WIFI-3908, WIFI-4287, and WIFI-4279

See merge request espressif/esp-idf!17366
2022-06-02 20:01:07 +08:00
muhaidong
06fb6b2e32 esp_wifi: fix country policy issue
1. Fix not update phy according to country code.
    2. Update regdomain max channel according to country info from nvs and or AP.
    3. Change nvs default country from "CN" to "01".
    4. Channel 14 is allowed only 11b mode.
    5. Remove csa when switch channel from/to 14 channel.
    6. Update phy mode nvs when softap channel from 14 to other.
    7. Fix the bug that check whether channel parameter is valid.

Docs: change default country from "CN" to "01"
2022-06-02 16:15:48 +08:00
muhaidong
af04a58633 docs: modify some Chinese expressions related to CSI 2022-06-02 11:55:48 +08:00
muhaidong
ce37a2f205 docs:update wifi sci subcarrier index docs 2022-06-02 11:25:59 +08:00
Djordje Nedic
facab8c5a7 tools: Increase the minimal supported CMake version to 3.16
This updates the minimal supported version of CMake to 3.16, which in turn enables us to use more CMake features and have a cleaner build system.
This is the version that provides most new features and also the one we use in our latest docker image for CI.
2022-06-01 06:35:02 +00:00
daiziyan
59453d0e78 docs: update CN translation for idf-monitor.rst 2022-05-30 20:55:37 +08:00
Anton Maklakov
8f6534165a docs: fix linker-script-generation figure 2022-05-25 12:10:25 +07:00
Marius Vikhammer
0687daf2c8 kconfig: move remaining kconfig options out of target component
The kconfig options are moved to the component where they are used,
mostly esp_hw_support and esp_system.
2022-05-23 17:57:45 +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
daiziyan
ca57e121e2 docs: udpate CN translation for readme and build-system 2022-05-11 19:49:16 +08:00
Mu Hai Dong
1ce55c9267 Merge branch 'docs/update_wifi_multiple_antennas_doc' into 'master'
docs: update wifi multiple antennas docs

Closes WIFI-4034

See merge request espressif/esp-idf!17966
2022-05-10 15:58:28 +08:00
mofeifei
6b29118765 docs: sync up lines for api-guides and get-started 2022-05-09 02:10:06 +00:00
Dai Zi Yan
8d332b6bc4 Apply 1 suggestion(s) to 1 file(s) 2022-05-07 16:58:24 +08:00
Marius Vikhammer
030cb77597 docs: update redirected links 2022-05-07 13:09:41 +08:00
Marius Vikhammer
d7053c38cc docs: fix broken links 2022-05-07 13:09:41 +08:00
mofeifei
0746ba2b75 docs:update a command in partition-tables 2022-05-06 14:14:40 +08:00
Marius Vikhammer
3129c732a3 Apply 2 suggestions by Marius Vikhammer 2022-05-05 10:02:57 +08:00
muhaidong
832eed4b22 docs: update wifi multiple antennas docs 2022-05-03 14:50:39 +08:00
Ivan Grokhotkov
598e8db29c
docs: update build system reference and migration guides for lwip
Previous commit removes lwip from the common requirements.
This commit updates the documentation to describe the resulting
changes.
2022-05-02 20:47:18 +02:00
Roland Dobai
fdf784b7d7 Merge branch 'feature/add_gdb_as_a_tool' into 'master'
tools: add GDB v11.1 as a tool

Closes IDF-3880, IDF-4079, OCD-411, IDFGH-4510, and GCC-90

See merge request espressif/esp-idf!17100
2022-04-28 14:35:13 +08:00
Wang Fang
e6230c4143 docs: updated timer related documents 2022-04-28 10:41:15 +08:00
Ivan Grokhotkov
2ddcb13509
docs: add documentation about reproducible builds 2022-04-26 11:31:13 +02:00
Jiang Jiang Jian
e966af7237 Merge branch 'docs/update_wifi_api_doc' into 'master'
DOC: update wifi api docs

Closes DOC-2542, DOC-2672, DOC-743, and WIFI-3748

See merge request espressif/esp-idf!17552
2022-04-26 17:12:50 +08:00
zhangyanjiao
7e0090b029 modify API-reference using Sphinx directives 2022-04-26 10:18:41 +08:00
Roland Dobai
2448639245 Merge branch 'tidy_build_system_docs' into 'master'
Docs: Move the documentation about idf.py out from the build system documentation

Closes IDF-2431

See merge request espressif/esp-idf!17789
2022-04-25 16:09:08 +08:00
Alexey Lapshin
b5bafae596 tools: add GDB v11.1 as a tool
GDB now is standalone tool separated from toolchain due to frequent updates.

Added installation tests for the new tool.

Tests are changed because they were wrong, see explanation:
esp32 objdump:
    40084290 <esp_crosscore_int_send_yield>:
    ......
    /builds/espressif/esp-idf/components/esp_system/crosscore_int.c:145
    4008429c:    000090            retw

With previous GDB backtrace was:
    #0  0x4008429c in esp_crosscore_int_send_yield (core_id=0) at /builds/espressif/esp-idf/components/esp_system/crosscore_int.c:144

This commit fixes the backtrace with the right line number:
    #0  0x4008429c in esp_crosscore_int_send_yield (core_id=0) at /builds/espressif/esp-idf/components/esp_system/crosscore_int.c:145

Other tests changes have the same cause of fixing.

Closes https://github.com/espressif/esp-idf/issues/6334
2022-04-25 11:21:48 +07:00
zhangyanjiao
e3b8f59867 update wifi api docs 2022-04-24 23:55:54 +08:00
daiziyan
406f5c6b78 docs: fix the format for DPP 2022-04-24 21:20:54 +08:00
Djordje Nedic
181618ab70 docs: Move the documentation about idf.py out from the build system documentation
This moves all the documentation relating to using idf.py out of the build system documentation in order to declutter and more logically group the documentation.
It is now present in the tools page under IDF Frontend - idf.py.
Additionally there has been lots of rewriting and some minor fixes on the way.
2022-04-22 17:38:04 +02:00
Armando (Dou Yiwen)
5bb59b00e7 Merge branch 'feature/support_bss_on_psram' into 'master'
psram: support .bss on psram on esp32s3

Closes IDF-4814, IDF-4396, IDFGH-7148, and IDFGH-7153

See merge request espressif/esp-idf!17557
2022-04-20 11:16:28 +08:00
Armando
b5de3ec953 esp_common: rename EXT_RAM_ATTR to EXT_RAM_BSS_ATTR to make it clearer
EXT_RAM_ATTR is deprecated. To put .bss on PSRAM, use this new macro EXT_RAM_BSS_ATTR
2022-04-19 19:48:00 +08:00
Wang Fang
e1ce61ea91 docs: updated hardware-related documents 2022-04-14 11:08:13 +08:00
mofeifei
4bd411d254 docs: update app trace cn trans 2022-04-12 03:17:12 +00:00
morris
32464d2fcb Merge branch 'docs/update_api-guides' into 'master'
docs: updated CN trans for fatal-errors and unit-tests

Closes DOC-2773

See merge request espressif/esp-idf!17505
2022-04-08 16:30:17 +08:00
Dai Zi Yan
3bcef014b9 docs: updated CN trans for fatal-errors and unit-tests 2022-04-08 16:30:16 +08:00
morris
df18bc03c9 Merge branch 'docs/update_CN_trans_api-guides' into 'master'
docs: updated CN trans for linker-script-generation and external-ram

Closes DOC-2803

See merge request espressif/esp-idf!17510
2022-04-07 11:15:16 +08:00
Dai Zi Yan
0896e19840 docs: updated CN trans for linker-script-generation and external-ram 2022-04-07 11:15:16 +08:00
Anton Maklakov
a2c8a676a0 Merge branch 'bugfix/explicit_use_bsd_string_in_linux_target' into 'master'
docs, spi_flash: explicit use bsd string in linux target

Closes IDF-3267

See merge request espressif/esp-idf!17635
2022-04-06 14:00:36 +08:00
Anton Maklakov
5213ec8b33 docs: add libbsd-dev to linux host requirements list 2022-03-29 13:59:53 +07:00
Marius Vikhammer
a6543f0d21 docs: fix broken references to misc API functions and types. 2022-03-27 16:46:57 +08:00
Dmitry
1ee7953ebe app_trace: add support for UART to the app trace module.
Add support for UART to the SystemView.
2022-03-23 17:51:14 +03:00
intern
9a28504eea docs:update cn trans for jtag-debugging 2022-03-15 02:40:36 +00:00
Jack Farley
1273353f70 DOC:Correct IP_EVENT_STA_LOST_IP name
Fix the name of the IP_EVENT_STA_LOST_IP event (was IP_STA_LOST_IP)

Signed-off-by: xueyunfei <xueyunfei@espressif.com>

Closes https://github.com/espressif/esp-idf/pull/8347
2022-03-10 17:54:40 +08:00
xiongweichao
6514f9e94c docs: translate coexist from CN to EN 2022-03-09 02:50:00 +00:00
Sudeep Mohanty
bc82613847 Merge branch 'docs/ulp_documentation_updates' into 'master'
docs: Updated ULP documentation

Closes IDF-3306

See merge request espressif/esp-idf!17225
2022-03-03 19:16:27 +08:00
Shang Zhou
dc8ec7904c Merge branch 'docs/add_note_for_malloc_cap_dma' into 'master'
docs: add note for MALLOC_CAP_DMA for ESP32-S2 according to customer feedback

Closes DOC-2476

See merge request espressif/esp-idf!16751
2022-03-03 16:32:16 +08:00
Marius Vikhammer
29db173536 Merge branch 'feature/move_target_kconfig' into 'master'
system: move kconfig options out of target component

See merge request espressif/esp-idf!16893
2022-03-03 09:39:54 +08:00
Shang Zhou
4d9db3382e docs: add note for MALLOC_CAP_DMA for ESP32-S2 according to customer feedback 2022-03-02 16:57:21 +08:00
Omar Chebib
2571aaf3c9 G0: target component (components/esp32*) doesn't depend on driver anymore 2022-03-02 04:21:00 +00:00
Marius Vikhammer
bb88338118 system: move kconfig options out of target component
Moved the following kconfig options out of the target component:
 * ESP32_X_BROWNOUT_* -> esp_system
 * ESP32_X_DEBUG_OCDAWARE -> esp_system
 * APP_NO_BLOBS -> build type (main kconfig)
2022-03-02 01:22:26 +00:00
Sudeep Mohanty
4067bc40fc docs: Updated ULP documentation
This commit updates documentation for ULP.
2022-03-01 09:02:41 +05:30
daiziyan
6b8420e877 docs: updated CN translation for using-debugger, windows-setup, resources and index 2022-02-25 10:44:22 +00:00
Shang Zhou
33a00cf197 docs: Updated CN translation for index files in api-guides and api-reference 2022-02-23 14:48:26 +08:00
Sudeep Mohanty
4d8a0cce29 ulp: Added support for ULP FSM on esp32s3 and fixed bugs for esp32s2
This commit enables ULP FSM support for esp32s3 and updates ULP FSM code
flow for other chips.
It adds C Macro support for the ULP FSM instruction set on esp32s2 and
esp32s3.
The unit tests are also updated to test ULP FSM on ep32s2 and esp32s3.
2022-02-22 12:25:57 +05:30
daiziyan
60741e3be8 docs: make line number consistent for build-system, configure-ft2232h-jtag, ble-mesh-architecture, building-openocd-macos, error-handling" 2022-02-18 11:18:40 +08:00
pedro.minatel
e4a766051c [Docs] Rebase conlicts fixed
[Docs] New getting started based on the ide and os selection
Missing file on zh_CN folder added
Added hidden toctree for missing files in CN version
docs: Added steps summary to the macOS procedures
[Docs] Changes on the titles and heading levels
[Docs] Review according to MR 15432
[Docs] Fixed the start a new project secction
2022-02-17 10:50:51 +00:00
Darian Leung
57fd78f5ba freertos: Remove legacy data types
This commit removes the usage of all legacy FreeRTOS data types that
are exposed via configENABLE_BACKWARD_COMPATIBILITY. Legacy types can
still be used by enabling CONFIG_FREERTOS_ENABLE_BACKWARD_COMPATIBILITY.
2022-02-09 23:05:45 +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
Fu Hanxi
60c5b37bfe Merge branch 'refactor/ldgen' into 'master'
refactor: ldgen

Closes IDF-605 and IDFGH-6271

See merge request espressif/esp-idf!16509
2022-01-10 09:15:44 +00:00
Marius Vikhammer
cf123b2071 docs: fix invalid symbol in chinese translation 2022-01-10 14:42:07 +08:00
daiziyan
9e7f31337d docs: updated CN trans for memory-types and external-ram 2022-01-08 15:21:17 +08:00
Fu Hanxi
0282cedd0b docs: drop support for v3.x grammar 2022-01-07 16:18:32 +08:00
daiziyan
20374161a6 docs: Updated CN translation for esp-ble-mesh, wifi, spi_flash and fata-errors; And keep line number consistency for en/index and versions 2022-01-07 16:05:16 +08:00
xueyunfei
ec993af322 update s3 doc 2022-01-04 17:50:37 +08:00
Marius Vikhammer
82325f6037 docs: update docs to be able to build with esp8684 2021-12-20 10:32:49 +08:00
daiziyan
c642661411 docs: update CN translation for esp_wifi and jtag-dubugging/index, and fix typos in esp_spi_slave_protocol 2021-12-07 15:36:50 +08:00
Fu Hanxi
a081a67f8e docs(idf.py): add IDF Clang Tidy chapter 2021-11-16 14:43:39 +08:00
Roland Dobai
9c1d4f5b54 Build & config: Remove the "make" build system
The "make" build system was deprecated in v4.0 in favor of idf.py
(cmake). The remaining support is removed in v5.0.
2021-11-10 09:53:53 +01:00
daiziyan
e79b8c1b6a docs: update CN trans for external-ram and flash-encryption 2021-11-05 19:23:10 +08:00
daiziyan
8db579e716 docs:update CN translation for wifi 2021-11-03 14:11:53 +08:00
Armando
d41da2792a doc: add flash and psram configuration doc in programming guide 2021-10-26 11:49:36 +08:00
Alexey Gerenkov
3af4c22f29 Merge branch 'bugfix/oocd_config_file_for_esp32s3' into 'master'
docs/esp32s3: Fixes OpenOCD configuration files names

See merge request espressif/esp-idf!15478
2021-10-19 19:07:54 +00:00
Juraj Sadel
eb86d39136 Merge branch 'feature/xtensa-esp32-elf-clang' into 'master'
tools: LLVM for Xtensa (ESP32-S2) based on clang

See merge request espressif/esp-idf!15094
2021-10-14 06:40:48 +00:00
Marek Fiala
582a39126a Merge branch 'feature/idfpy_dashes_replace' into 'master'
tools: replace _ with - in idf.py

Closes IDFGH-3105

See merge request espressif/esp-idf!14752
2021-10-13 13:14:06 +00:00
Juraj Sadel
1a88d5a736 LLVM for Xtensa (ESP32, ESP32-S2) based on clang 2021-10-13 13:45:56 +02:00
Marek Fiala
ff18a96f7d tools: replace _ with - in idf.py
Closes https://github.com/espressif/esp-idf/issues/5126
2021-10-13 17:30:38 +08:00
chenjianxing
2a09234957 esp_phy: rename esp_phy component prefix 2021-10-13 13:10:49 +08:00
Alexey Gerenkov
6d9fbc3726 docs/esp32s3: Fixes OpenOCD configuration files names 2021-10-11 22:15:31 +03:00
WangShichang
9f37cfc7fc add docs "How to improve Wi-Fi performance" in api-guides for esp32s3. 2021-10-11 15:08:02 +08:00
daiziyan
aca4a18c50 docs:update CN translation for bootloader, partition-tables, i2c, and ledc 2021-09-18 19:25:38 +08:00
Marius Vikhammer
0daa30c02c docs: remove "invisible" unicode character that failed PDF build. 2021-09-13 10:11:08 +08:00
daiziyan
c9e5b02c18 docs: update CN trans for blufi and build-system 2021-09-10 15:09:50 +08:00
Sergei Silnov
8202c12a83 docs: Add component manager documentation 2021-08-30 13:23:23 +02:00
intern
45925c28fd docs: update translation for jtag-debugging/index.rst and power_management.rst 2021-08-26 12:21:19 +08:00
daiziyan
65961ea892 docs: update CN trans for fatal-errors and unit-tests 2021-08-18 19:28:16 +08:00
Nachiket Kukade
f38b18f046 docs: Separate Doc on WiFi security, added DPP Doc
1. Add new Doc on WiFi security
2. Add DPP related Doc under WiFi
3. Add Supplicant public headers in Doxyfile
2021-08-10 12:35:43 +05:30
Shu Chen
ee6b1736c6 Merge branch 'feature/add-openthread-docs' into 'master'
docs: add OpenThread docs

See merge request espressif/esp-idf!14488
2021-08-05 03:56:43 +00:00
Jiacheng Guo
ba5b7ddded docs: add OpenThread docs 2021-08-02 17:17:38 +08:00
Armando
e0acefbb78 docs: add docs to .bss and .noinit segments on spiram 2021-07-31 11:02:13 +08:00
morris
2218204aa7 doc: update tinyusb document to support esp32s3
1. Renamed SOC_USB_SUPPORTED to SOC_USB_OTG_SUPPORTED for the reason of
   another USB related peripheral: USB_JTAG_SERIAL
2. correct related document
2021-07-22 10:43:10 +08:00
Hao Ning
54e1c52beb docs:fix wrong event names in wifi driver 2021-07-20 19:21:43 +08:00
Angus Gratton
c1ca7a35b0 ldgen: Remove some remaining references to TARGET.project.ld.in 2021-07-16 20:14:27 +08:00
Angus Gratton
c01da712f6 docs: Move the bootloader size section into the Bootloader guide 2021-07-13 17:35:04 +10:00
morris
1560d6f1ba soc: add reset reasons in soc component 2021-07-13 10:45:38 +08:00
daiziyan
e95893bb1b docs: rename ESP-MESH to ESP-WIFI-MESH 2021-07-12 19:25:18 +08:00
Alexey Gerenkov
821869d98d apptrace: Refactors apptrace for better support various tracing HW 2021-06-24 13:16:13 +03:00
Marius Vikhammer
2b995a37eb docs: fix table in WifI guide not being rendered 2021-06-24 14:54:38 +08:00
daiziyan
e1ad9a1d20 docs:update CN translation for fatal-errors, external-ram, and idf-monitor 2021-06-21 18:05:18 +08:00
Martin Gaňo
330d1cf2ae Fix autocomplete for bash 2021-06-11 01:59:36 +02:00
Marius Vikhammer
fbd6e9e320 docs: remove duplicate label 2021-06-09 09:30:42 +08:00
Marius Vikhammer
bdfda351bd build docs: enable building of S3 docs
* Added suport for building esp32s3 docs
 * Fixed all related warnings
 * Activated building of S3 docs for build HTML fast CI job
2021-06-09 09:30:36 +08:00
Krzysztof Budzynski
93334ea73a Merge branch 'docs/update_CN_trans_startup_debugging-example' into 'master'
docs:update CN translation for startup and debugging-example

See merge request espressif/esp-idf!13791
2021-06-08 07:09:27 +00:00
daiziyan
bb6a02ae53 docs:update CN translation for startup and debugging-example 2021-06-08 11:18:27 +08:00
Angus Gratton
dc6b950257 doc: Add performance guides for execuion speed, binary size, RAM usage
Closes https://github.com/espressif/esp-idf/issues/7007
Closes https://github.com/espressif/esp-idf/issues/6715
Closes https://github.com/espressif/esp-idf/issues/3781
Closes https://github.com/espressif/esp-idf/issues/2566
2021-06-03 13:55:34 +10:00
Krzysztof Budzynski
c07f21a467 Merge branch 'doc/remove_modules_and_boards_section_from_hw_reference' into 'master'
remove modules and boards section

Closes DOC-45 and DOC-355

See merge request espressif/esp-idf!12846
2021-05-31 11:12:51 +00:00
Hao Ning
fc0eba4101 remove modules and boards section
doc: add redirections

docs: rebase master and add redirect links

docs: delete invalid links labeled in modules-and-boards

docs:installed pre-commit config

docs:retry

docs: separate links of modules and boards

docs: removed original files and added one more redirection

docs:deleted invalid links in jtag-debugging

docs:replaced old links in jtag-debugging

docs:fixd pipeline failures
2021-05-31 16:19:15 +08:00
Marius Vikhammer
0c17973d54 docs: add rf calibration docs for S2 and C3 2021-05-26 10:09:50 +08:00
Wang Fang
71141a326d docs: clarified esp32 timer clk source, updated the flash encryption table and esptrace doc 2021-05-24 03:46:40 +00:00
Angus Gratton
e928d57663 Merge branch 'doc/include_bootloader_random' into 'master'
docs: Add RNG functions to API reference

See merge request espressif/esp-idf!13519
2021-05-20 09:14:55 +00:00
Wang Ning
19a407ed1a doc/remove_romconsole_since_it_is_no_longer_supported_from_ESP32_ECO3 2021-05-18 07:51:56 +00:00
Angus Gratton
e14edecf5f docs: Add random number generation to the API Reference System section 2021-05-18 16:05:42 +10:00
Roland Dobai
c68781c269 docs: Generate JTAG debugging guide based on feature instead of chip
It is better to check feature SOC_USB_SERIAL_JTAG_SUPPORTED which will
support other chip targets beside ESP32-C3.
2021-05-11 11:01:53 +02:00
Jeroen Domburg
644f430a31 Merge branch 'feature/esp32c3_usbjtagserial_console' into 'master'
USB serial/jtag controller: Add vfs (logging/printf), panic handler, gdb support.

See merge request espressif/esp-idf!12925
2021-04-28 08:38:31 +00:00
Jeroen Domburg
2c75f63f89 * ets_delay_us(1) has too much overhead; change logic
* Fix MR comments
2021-04-28 16:38:24 +08:00
chenjianxing
c66b1aeda7 update esp32c3 iperf config 2021-04-27 14:41:08 +08:00
Jakob Hasse
68393c41c4 doc: linux host test documentation 2021-04-23 09:27:35 +08:00
Krzysztof Budzynski
58424ccebf Merge branch 'bugfix/doc_jtag_c3' into 'master'
docs: Update JTAG debugging guides for ESP32-C3

Closes IDF-2133

See merge request espressif/esp-idf!13102
2021-04-22 11:58:34 +00:00
Dai Zi Yan
e91861253f docs:updated CN tranlation for build-system, ulp, unit-tests, idf-monitor and linker-script-generation 2021-04-22 16:08:31 +08:00
Roland Dobai
a2cf1a7d38 docs: Update JTAG debugging guides for ESP32-C3 2021-04-13 12:48:50 +02:00
Eli
9ec19163ed docs: jtag debugging: add macOS 10.15 FTDI details
Merges https://github.com/espressif/esp-idf/pull/5949
2021-04-12 09:15:08 +02:00
Marius Vikhammer
0633ee3e18 docs: fix doxygen compile warnings for doxygen 1.9.1
Newer versions of doxygen will give warnings for comments in
INPUT lists

Delete all comment lines to fix these warnings, our folder structure
stil gives an OK overview of what we are including
2021-04-09 11:57:03 +08:00
Michael (XIAO Xufeng)
925dacd7fb Merge branch 'bugfix/remove_HSPI_macro_on_c3' into 'master'
spi: remove HSPI macros on esp32c3 and esp32s3

Closes IDF-2535

See merge request espressif/esp-idf!12637
2021-04-08 09:33:18 +00:00
Armando
9b9ea71ff9 spi: remove HSPI macro on esp32c3 and esp32s3 2021-04-06 13:42:49 +08:00
Angus Gratton
94ac251091 Merge branch 'doc/general_notes' into 'master'
doc: Update docs about startup sequence and memory types

Closes IDF-2321, IDF-2409, and IDFGH-1540

See merge request espressif/esp-idf!12636
2021-04-05 23:51:25 +00:00
Renz Bagaporo
bbc599493e esp32: move common fragment definitions 2021-03-31 19:17:33 +08:00
Angus Gratton
793771e744 Merge branch 'feature/esp_error_check_return' into 'master'
esp_common: add generic check macros

Closes IDF-2271

See merge request espressif/esp-idf!12602
2021-03-31 07:08:27 +00:00
Wang Fang
c303333f52 docs: Correct uart default pin names and provid more information about ESP-Prog board 2021-03-29 14:04:13 +08:00
Angus Gratton
2e98a5d796 docs: split the 'general notes' page into two 2021-03-29 16:32:54 +11:00
Krzysztof Budzynski
15c3a42dcf Merge branch 'doc/update_CN_translation_for_API_guides_and_Contribute' into 'master'
update CN translation for api-guides and contribute

See merge request espressif/esp-idf!12662
2021-03-23 08:05:28 +00:00
daiziyan
abb89b9a9c docs: update CN translation for app_trace,linker-script-generation and add-ons-reference.rst 2021-03-23 11:24:23 +08:00
Dai Zi Yan
85a016dbf6 api-guides: updated CN translation for unit-tests, jtag-debugging/index, and jtag-debugging/using-debugger 2021-03-15 13:01:15 +08:00
Shu Chen
6792024add esp_common: add generic check macros
Add four check maros:
* ESP_RETURN_ON_ERROR()
* ESP_GOTO_ON_ERROR()
* ESP_RETURN_ON_FALSE()
* ESP_GOTO_ON_FALSE()

Also add a `xx_ISR` version for each of them, which can be used in ISR.
2021-03-11 17:38:22 +08:00
daiziyan
123e540b2f update CN translation based on reviewers' comments 2021-03-09 10:28:52 +11:00
daiziyan
8c7fd31984 api-guides: update CN translation for build-system and build-system-legacy,and fix line break in the EN version 2021-03-09 10:28:52 +11:00
Angus Gratton
a0eb455ec3 Merge branch 'refactor/misc_move_from_esp_common' into 'master'
Movements from esp_common

Closes IDF-1947

See merge request espressif/esp-idf!9692
2021-02-24 23:16:52 +00:00
Renz Bagaporo
f2561f6360 docs: update list of common component requirements 2021-02-24 12:16:37 +08:00
Omar Chebib
33deabb3ab doc: update "Fatal Errors" chapter for ESP32C3 board 2021-02-23 14:54:26 +08:00
Marius Vikhammer
8c729fb55b docs: fix broken ref in external-ram.rst 2021-02-20 12:37:59 +08:00
Marius Vikhammer
548fd02d10 docs: initial update of programming guide for C3
Updates "front page" content, get-started, and api-guides with C3 content

Enable building and publishing of C3 docs in CI
2021-02-01 15:40:02 +08:00
daiziyan
3d2d0e2247 update CN translation for ulp-risc-v partition-table tips-and-quirks and idf-monitor for api-guides 2021-01-28 19:42:54 +08:00
Krzysztof Budzynski
1faff89ff6 Merge branch 'feature/update_jtag_translation' into 'master'
doc: update JTAG translation

Closes IDF-2069

See merge request espressif/esp-idf!12107
2021-01-27 10:37:10 +08:00
Wang Fang
7df1cad1d6 docs: This MR does the following updates:
1. Provided more information regarding I2S_COMM_FORMAT_STAND_PCM_SHORT and I2S_COMM_FORMAT_STAND_PCM_LONG
2. Added --output flag for partition table read instructions
3. Reordered the header files for esp-ble-mesh
4. Reordered the setup instructions for Ubuntu and CentOS
2021-01-25 11:10:08 +00:00
morris
9788721de6 doc: update JTAG translation 2021-01-25 18:59:19 +08:00
Ivan Grokhotkov
76acc8ddde Merge branch 'feature/win_inst_embedded_python' into 'master'
tools: support for embedded Python

Closes IDF-322

See merge request espressif/esp-idf!11682
2021-01-18 16:54:47 +08:00
Juraj Michálek
1427b3a6d8 tools: support for embedded python 2021-01-18 08:10:56 +01:00
daiziyan
2e3367b97e update api-guides/build-system.rst to keep EN and CN in sync 2021-01-13 19:23:30 +08:00
Dai Zi Yan
694dd2767a update CN translation for ulp.rst index.rst bootloader.rst and external-ram.rst under api-guides section 2021-01-08 17:49:09 +08:00
Marius Vikhammer
7fe16bae25 tools: merge C3 changes into master 2020-12-30 07:04:12 +08:00
Ivan Grokhotkov
de798541dc tools: use riscv32-esp-elf toolchain for ESP32-S2 RISC-V ULP
riscv32-esp-elf toolchain (used for ESP32-C3) can also be used for
ESP32-S2 RISC-V ULP coprocessor.

This removes the riscv-none-embed-gcc toolchain which was originally
used for the ULP, and updates the docs and CMake files to use
riscv32-esp-elf.

Some flags are cleaned up and workarounds removed from CMake toolchain
file.
2020-12-29 19:19:18 +00:00
Marius Vikhammer
da947d736f Docs: Add C3 support to build_docs 2020-12-28 12:25:03 +08:00
Ivan Grokhotkov
11ae1dcebe docs: fatal errors: mention another reason for LoadStoreError 2020-12-02 11:58:56 +01:00
Hao Ning
720e228dde add a chinese translation for wifi driver
add the first part translated by joy

add the last part translated by huizi

solved some formatting issues and typos in en text

add updated cn translation based on peer review comments

updated based on technical review comments

add links to api functions

solve pipeline errors

convert line endings in cn file

solve some build errors

reedit a table
2020-11-20 10:33:04 +08:00
Angus Gratton
66fb5a29bb Whitespace: Automated whitespace fixes (large commit)
Apply the pre-commit hook whitespace fixes to all files in the repo.

(Line endings, blank lines at end of file, trailing whitespace)
2020-11-11 07:36:35 +00:00
Mahavir Jain
20af94ff53 Coredump config option rename throughout IDF 2020-09-30 20:22:27 +05:30
Krzysztof Budzynski
068690e604 Merge branch 'docs/fix_formatting_issues_in_idf_monitor' into 'master'
docs: fix formatting issues in api-guides

Closes DOC-489, DOC-406, and DOC-487

See merge request espressif/esp-idf!10459
2020-09-24 15:30:33 +08:00
Wang Fang
00a99cfb9d docs: fix formatting issues in api-guides 2020-09-24 15:30:28 +08:00
Angus Gratton
50e79e6763 Merge branch 'feature/switch_to_kconfiglib_package' into 'master'
tools: Use kconfiglib from package

Closes IDF-989

See merge request espressif/esp-idf!10535
2020-09-24 12:27:31 +08:00
Roland Dobai
883cbc416e tools: Use kconfiglib from package 2020-09-22 11:29:30 +02:00
morris
9fa06719fa global: enable build uinit test for esp32-s3 2020-09-22 15:15:03 +08:00
Lu Chang Jie
cd3cf630a5 Test: merge ble mesh node and provioner in console 2020-08-21 11:01:37 +08:00
He Hui Zi
dfa59e3d22 docs: translate api-guides/ulp-risc-v from EN to CN 2020-08-13 19:44:46 +08:00
Angus Gratton
a2dc60b254 Merge branch 'feature/secure_boot_esp32s2' into 'master'
Feature/secure boot esp32s2

See merge request espressif/esp-idf!8254
2020-07-28 16:39:34 +08:00
Supreet Deshpande
33979a9361 Docs: Secure boot v2 support for ESP32-S2 2020-07-27 00:01:10 +00:00
morris
e6a94e982c docs: translate idf.py debug target 2020-07-24 15:59:11 +02:00
Ivan Grokhotkov
a3eb4d85d4 docs: jtag-debugging: update Chinese version 2020-07-24 15:58:59 +02:00
Ivan Grokhotkov
4ff2750d9f docs: add placeholders for {esp32,esp32s2}.inc in JTAG debugging guide 2020-07-24 15:54:47 +02:00
Ivan Grokhotkov
962ea8b9f2 docs: repurpose WROVER-KIT debugging guide for Kaluga-1 2020-07-24 15:54:47 +02:00
Felipe Neves
b6dba84323 ulp: added support to building code for riscv ULP coprocessor 2020-07-15 15:28:49 -03:00
Ivan Grokhotkov
5985c07ab7 docs: add section about USB CDC console 2020-06-26 15:38:49 +02:00
Wang Fang
256571a4f4 fix the formatting issues described in DOC-257 2020-06-24 02:47:12 +00:00
Darian Leung
e61bbbcb61 Add HAL and LL documentation
This commit adds docuemntation regarding Hardware
Abstraction in ESP-IDF.
2020-06-04 15:02:49 +08:00