Commit Graph

497 Commits

Author SHA1 Message Date
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
Marius Vikhammer
67ea59d605 docs: fix check_docs not working for multiple builders
When building docs with multiple builders the warning logs are now checked after
each run. Solves the issue where the logs would be overwritten by next builder before checking.

Closes IDF-1659
2020-05-29 20:10:18 +08:00
Krzysztof Budzynski
95ed99671b Merge branch 'feature/coredump_data_in_elf_format_doc_update' into 'master'
espcoredump: apply documentation changes in core_dump.rst file

See merge request espressif/esp-idf!5697
2020-05-28 02:25:47 +08:00
Alex Lisitsyn
e649a4f017 espcoredump: apply temporary documentation changes in core_dump.rst file
added picture to describe bin and elf format of core dump
added link to core_dump_internals.rst file from main one
added the diagram to describe logic structure of core dump modules and dependencies
2020-05-28 02:25:46 +08:00
Island
fbf2088fc8 Merge branch 'example/ble_mesh_structural_adjust' into 'master'
Example/ble mesh structural adjustment

Closes BLEMESH-200

See merge request espressif/esp-idf!8719
2020-05-21 15:11:23 +08:00
lly
88eb4a0820 ble_mesh: Rename the folders ble_mesh_fast_prov_* to fast_prov_* 2020-05-20 11:33:46 +00:00
Marius Vikhammer
fbb54184ef doc: add generation of tags from sdkconfig and x_caps.h headers
Also updates the way we handle exclude_patterns to use the new tags

Closes IDF-1484
2020-05-13 07:09:01 +00:00
Alexey Gerenkov
b441df7cf1 docs: Fixes OpenOCD debug level option 2020-05-07 16:02:13 +03:00
Angus Gratton
f9552baf97 Merge branch 'feature/dfu_build_flash_s2' into 'master'
Add build system support for programming ESP32-S2 using DFU utils

Closes IDF-579

See merge request espressif/esp-idf!8294
2020-05-04 14:57:51 +08:00
Krzysztof Budzynski
39c5db4c38 Merge branch 'bugfix/make_docs_ldgen' into 'master'
docs: remove quotes in ldgen documentation for adding fragment file

See merge request espressif/esp-idf!8501
2020-05-04 03:22:59 +08:00
Roland Dobai
ab9f714248 Add build system support for programming ESP32-S2 using DFU utils 2020-04-30 07:59:18 +02:00
Renz Bagaporo
da91172616 docs: remove quotes in ldgen documentation for adding fragment file
Closes https://github.com/espressif/esp-idf/issues/5142
2020-04-27 15:22:38 +08:00
lly
2f6a4140fa doc: Fix some ble mesh description 2020-04-26 06:22:33 +00:00
Angus Gratton
4358f3b573 doc: Add warnings about using JTAG debugging with hardware security features
This is related to the following issues but is not a fix, just documentation of a workaround until we can
improve the support:
https://github.com/espressif/esp-idf/issues/4878
https://github.com/espressif/esp-idf/issues/4734
2020-04-01 17:36:08 +11:00
liying
572ef008a9 Provide translation for the updates in 7637 and 8095, and correct a format issue in documenting-code 2020-03-29 16:50:40 +00:00
Wang Ning
168a623a07 Add translation for linker script generation 2020-03-26 00:48:58 +08:00
Wang Ning
3784d499af Add translation for ota tool and partation tool 2020-03-25 21:44:33 +08:00
Ivan Grokhotkov
35560cb538 Merge branch 'doc/fix_example_links' into 'master'
doc: Fix invalid links

Closes DOC-67 and DOC-69

See merge request espressif/esp-idf!8065
2020-03-23 21:17:20 +08:00
Angus Gratton
52d888a68b docs: Fix broken URLs & permanent redirects 2020-03-23 18:11:23 +11:00
Anton Maklakov
8046df875e docs: Fixup format of a command line to build unit tests 2020-03-19 19:28:46 +07:00
Angus Gratton
207914a13a Merge branch 'refactor/common_code_panic_handler' into 'master'
Panic handling common code refactor

See merge request espressif/esp-idf!7489
2020-03-19 11:23:57 +08:00
Natasha
ee0ae607da Add translation for mesh document under api guide 2020-03-17 01:02:36 +08:00
Ivan Grokhotkov
b497819667 docs: update esp32s2 summary page
- Refer to the toolchain links on IDF Tools page
- Update the wording around v4.1/v4.2 releases
- Remove the section about 3 different versions (of S2-beta)
- Add link to the list of features maintained externally
2020-03-16 14:40:37 +11:00
Renz Christian Bagaporo
20cfc2ecdd docs: update docs with panic handler changes 2020-03-10 19:56:24 +08:00
morris
46ea7d815d parttool: don't print target name 2020-03-09 15:05:04 +08:00
Marius Vikhammer
9b56892bfe doc: fix broken .. only:: in JTAG guide
Added note about .. only:: limitations to guide
2020-03-03 15:30:37 +08:00
Mahavir Jain
5f897fd33c Merge branch 'feat/secure_boot_v2_v41' into 'master'
feat/secure_boot_v2: Adding secure boot v2 support to ESP32-ECO3

Closes IDF-799

See merge request espressif/esp-idf!6778
2020-02-27 18:54:08 +08:00
lly
7cd08b5824 ble_mesh: Miscellaneous modifications
1. Add an API to set Provisioner static oob value
2. Add an API to deinit BLE Mesh stack
3. Add an API to set Provisioner unicast address
4. Add an API to provision devices with fixed address
5. Add an API to store node composition data
6. Add an API to get node with device uuid
7. Add an API to get node with unicast address
8. Add an API to delete node with device uuid
9. Add an API to delete node with unicast address
10. Add an API for Provisioner to update local AppKey
11. Add an API for Provisioner to update local NetKey
12. Support Provisioner persistent functionality
13. Fix Provisioner entering IV Update procedure
14. Fix an issue which may cause client failing to send msg
15. Use bt_mesh.flags to indicate device role
16. Remove several useless macros
17. Callback RSSI of received mesh provisioning packets
18. Modify the Provisioner disable function
19. Change some log level from debug to info
20. Add parameters to Provisioner bind AppKey completion event
21. Fix node ignoring relay messages issue
22. Support using a specific partition for BLE Mesh
23. Fix compile warning when proxy related macros are disabled
24. Clean up BLE Mesh stack included header files
25. NULL can be input if client message needs no parameters
26. Fix compile warning when BT log is disabled
27. Initilize BLE Mesh stack local variables
28. Support using PSRAM for BLE Mesh mutex, queue and task
29. Add a menuconfig option to enable using memory from PSRAM
30. Clean up sdkconfig.defaults of BLE Mesh examples
2020-02-26 17:37:44 +08:00
Supreet Deshpande
073ba0a608 feat/secure_boot_v2: Adding docs for secure boot v2 ESP32-ECO3 2020-02-25 01:28:22 +05:30
Angus Gratton
3b498a0576 Merge branch 'bugfix/confserver_hex_types' into 'master'
confserver: Standardize and document the handling of hex values

See merge request espressif/esp-idf!7437
2020-02-20 14:48:15 +08:00
Ivan Grokhotkov
75d0f38108 Merge branch 'doc/unit_test_multiple_targets' into 'master'
doc: add multi-target rules for writing unit tests

See merge request espressif/esp-idf!7438
2020-02-18 23:30:02 +08:00
Angus Gratton
e95ba301d8 Merge branch 'bugfix/use_quotes_in_embedding_ulp_apps' into 'master'
ulp: use quotes when specifying files for embedding ulp binaries

See merge request espressif/esp-idf!7606
2020-02-18 09:15:50 +08:00
Renz Christian Bagaporo
bb639bb91d ulp: use quotes when specifying files for embedding ulp binaries 2020-02-18 00:12:56 +00:00
Angus Gratton
99cdddeb63 docs: Fix broken or incorrect link roles to IDF files & directories 2020-02-18 10:34:11 +11:00
Angus Gratton
d9d7a906b1 confserver docs: Merge the build-system docs info about confserver into the README
Add link into the README from the docs
2020-02-17 17:21:22 +11:00
Tian Yang Min
63ed8a4aed docs: Add Chinese translation for esp-ble-mesh-faq
This commit adds the Chinese translation for the
esp-ble-mesh-faq document.
2020-02-17 04:58:56 +08:00
Michael (XIAO Xufeng)
699c6db836 doc: add multi-target rules for writing unit tests 2020-02-14 14:54:30 +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
Angus Gratton
eb85cfb9f6 docs: Temporarily mark RF calibration chapter as ESP32 only
Can be re-enabled once ESP32-S2 calibration support is added
2020-02-07 16:37:45 +11:00
Angus Gratton
11fac8637a docs: Resolve doxygen & Sphinx warnings 2020-02-07 16:37:45 +11:00
Marius Vikhammer
268816649c Replace all TRM urls will generic template variable and remove duplicate sections
All references to TRM had the section duplicated for both targets using .. only:: , replaced these with a generic template url
2020-02-07 16:37:45 +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
Marius Vikhammer
a7bac4721a doc: Add external ram note link to CN translation 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
Ivan Grokhotkov
1cd6f67679 docs: add API guide page about IDF Tools 2020-01-24 14:02:21 +01:00
Krzysztof Budzynski
ac27ab29fd doc: Fix broken links to examples 2020-01-20 12:10:18 +08:00
Angus Gratton
13f67d4279 doc: Remove duplicate ulp-cmake
This file was renamed in 62ed221 when CMake became default, but 8fe3ecd accidentally reintroduced it.

A redirect is still generated from ulp-cmake to ulp, so the old URL continues to work.
2020-01-10 16:38:06 +11:00
Tian Yang Min
666337eb7a Add Chinese translation for ble-mesh-architecture; add a link for ble-mesh-architecture-en. 2019-12-18 14:37:09 +08:00
Tian Yang Min
2b589fbabd Add Chinese translation for esp-ble-mesh-index. 2019-12-18 14:34:56 +08:00
Tian Yang Min
ee93da1826 Add Chinese translation for esp-ble-mesh-terminology. Add link to Chinese version in English original text. 2019-12-18 14:34:01 +08:00
Dmitry Yakovlev
8fe3ecd000 Added description for difference between ESP32 ULP and ESP32-S2 ULP
Jumpr instruction updated.
2019-12-13 18:38:57 +08:00
Hao Ning
8070746530 add updates to some files in api guides
modified errors in making html

add modifications based on the first review

modified grammar problems of the original text
2019-12-05 15:12:12 +08:00
Anton Maklakov
def05480b8 docs: Fix up some OpenOCD cmdline-s 2019-11-26 19:44:22 +08:00
Ivan Grokhotkov
477e66103c Merge branch 'feature/esp32s2beta_apptrace_port' into 'master'
esp32s2: Adds apptrace support

Closes IDF-510 and IDF-1032

See merge request espressif/esp-idf!5610
2019-11-22 05:33:35 +08:00
Alexey Gerenkov
1626f827d3 docs: Updates OpenOCD configuration file names 2019-11-18 13:33:32 +03:00
Alexey Gerenkov
30ff7198b8 apptrace: Renames Kconfig options 2019-11-13 15:24:01 +03:00
lly
7fde866d8c doc: fix wrong title of ble mesh terminology 2019-10-31 17:06:17 +08:00
Krzysztof Budzynski
2c3548b65e Provide BLE Mesh documentation 2019-10-30 17:01:18 +08:00
Angus Gratton
7016cb8864 Merge branch 'doc/add_doc_for_socket_error_usage' into 'master'
doc: add LW-IP socket error usage

See merge request espressif/esp-idf!5856
2019-10-17 06:17:34 +08:00
ronghulin
4e1ccd8b6f doc: add LWIP socket error usage 2019-10-11 12:09:10 +08:00
Angus Gratton
f44d99b509 app_update: Remove deprecated "make erase_ota" target
Deprecated in v3.2
2019-09-13 09:44:07 +10:00
suda-morris
43b29e4f4d doc: update translation of ulp install instuctions 2019-08-21 21:52:48 +08:00
Ivan Grokhotkov
02c7c3885e Merge branch 'bugfix/openocd_ulp_install_instructions' into 'master'
docs: jtag-debugging: update for IDF Tools installation method

Closes IDF-824

See merge request espressif/esp-idf!5803
2019-08-20 21:34:45 +08:00
suda-morris
7237e6fab7 docs: jtag-debugging: update translation 2019-08-20 14:49:48 +02:00
Ivan Grokhotkov
209fdc1e05 docs: jtag-debugging: update for IDF Tools installation method
- rely on OPENOCD_SCRIPTS variable in all cases, remove -s flags
- replace installation section with a reference to the Getting Started
  guides
- add Windows-specific commands in a few cases
2019-08-20 14:49:48 +02:00
suda-morris
ab406f8429 zh_CN translation of bootloader document 2019-08-19 11:37:59 +08:00
Ivan Grokhotkov
83277fe0f2 docs: add tools section and IDF docker image page 2019-07-18 06:18:04 +00:00
Angus Gratton
05ac8cfb6d docs: Update description for Eclipse+Cmake support not ready yet 2019-07-09 14:32:26 +10:00
Angus Gratton
222146845c docs: Make CMake build system default, mark GNU Make as legacy option
All `-cmake` suffixes are removed
Where a GNU Make option is renamed, the `-legacy` suffix is used
2019-07-09 14:32:26 +10:00
Angus Gratton
47bbb107a8 build system: Use CMake-based build system as default when describing commands 2019-07-08 17:31:27 +10:00
suda-morris
471f4b2f0e zh_CN translation of fatal_error 2019-07-04 14:01:53 +08:00
Wang Fang
b24341a664 Merge make-related documents:
1. Moved get-started files, 7 documents in total, from get-started-cmake folder to hw-reference folder;
2. Deleted get-started files, 7 documents in total, in get-started folder;
3. Updated links in get-started-cmake/index.rst and in get-started/index.rst;
4. Modified descriptions for build system in these files.
2019-07-04 13:16:18 +08:00
Roland Dobai
f56b7d4a1d tools: Accept CTRL-T + A for app-flash in idf_monitor
"CTRL-A" cannot be captured in Windows command line, so "A" can be used
instead.
2019-06-27 12:21:09 +02:00
Wang Fang
9fbb27b194 Add Chinese translation for exteral-ram.rst in api-guides:
- The draft should be first reviewed by Technical Reviewers;
- Then by Language Reviewer.
2019-06-26 19:59:21 +08:00
Jiang Jiang Jian
291e25baa6 Merge branch 'bugfix/btdm_add_readme_for_BLE_demos' into 'master'
Component/bt: add readme doc for BLE demos

See merge request idf/esp-idf!4890
2019-06-26 16:04:28 +08:00
Angus Gratton
a54a3fc92e Merge branch 'bugfix/idfpy_print_filter' into 'master'
tools: Port the filtering option of IDF Monitor to the idf.py toolchain

Closes IDF-543

See merge request idf/esp-idf!4416
2019-06-25 13:36:03 +08:00
zhiweijian
4d8a46b376 component/bt: add readme doc for BLE demos
- Closes:https://github.com/espressif/esp-idf/issues/3341
2019-06-17 07:05:41 +00:00
Sergei Silnov
a77f01ec9d Update order of arguments for idf.py in docs 2019-06-14 19:51:39 +02:00
Roland Dobai
da978bc5a1 tools: Port the filtering option of IDF Monitor to the idf.py toolchain 2019-06-14 17:45:20 +02:00
Angus Gratton
eac356ef4a Merge branch 'feature/idf_version_header' into 'master'
esp_common: add esp_idf_version.h header to define IDF version

Closes IDF-253

See merge request idf/esp-idf!4596
2019-06-13 09:41:35 +08:00
Wang Fang
a37ec9bae6 add translation for ulp cmake
fix formatting

update translation

update translation

formatting
2019-06-11 01:48:36 +08:00
Natasha
96db6f906a Docs/update idf monitor 2019-05-29 18:11:40 +08:00
Renz Christian Bagaporo
b3b6ce2eea docs: remove reference of using link groups 2019-05-28 13:01:43 +08:00
Roland Dobai
6c0a7a66f3 Rename Kconfig options (components/app_trace) 2019-05-21 09:32:55 +02:00
Roland Dobai
c5000c83d2 Rename Kconfig options (root) 2019-05-21 09:09:01 +02:00
Ivan Grokhotkov
6ca07eca68 esp_common: add version definitions in code and build system
Closes https://github.com/espressif/esp-idf/issues/2482
Closes IDF-253
2019-05-20 13:14:56 +08:00
Renz Christian Bagaporo
ee92352bf8 docs: update with build system changes 2019-05-13 19:57:39 +08:00
Renz Christian Bagaporo
c6dc47b3e2 cmake: build system changes 2019-05-13 19:57:39 +08:00
Ivan Grokhotkov
6890ea09cd docs: add event handling API guide 2019-04-11 12:04:58 +08:00
Kirill Chalov
a1c39e4a53 Doc/review get st wrover kit 2019-03-26 16:12:42 +08:00
Ivan Grokhotkov
bf5e3de955 Merge branch 'doc/app_trace_zh_CN' into 'master'
zh_CN translation of app_trace

See merge request idf/esp-idf!4087
2019-03-21 18:58:32 +08:00
Ivan Grokhotkov
416b756ea4 Merge branch 'bugfix/name_conflict_esp32_project_ld' into 'master'
esp32: Rename esp32.common.ld to esp32.project.ld to avoid build errors when downgrading

See merge request idf/esp-idf!4484
2019-03-15 11:42:20 +08:00
Angus Gratton
a79c5b8271 esp32: Rename esp32.common.ld to esp32.project.ld to avoid build errors when downgrading
Linker script generator produces build/esp32/esp32.common.ld from
components/esp32/ld/esp32.common.ld.in

This works fine until IDF is downgraded to V3.1 which uses components/esp32/ld/esp32.common.ld and
doesn't track build/esp32/esp32.common.ld at all.

At this point, the linker runs in the build/esp32 directory and "-T esp32.common.ld" picks up the
linker script generated .ld file, which causes mis-builds.

As reported on forums: https://esp32.com/viewtopic.php?f=13&t=9684&p=40105
2019-03-14 09:59:31 +11:00
Kirill Chalov
49cca9288f Update IDF getting started sections for make and cmake as well as IDF monitor… 2019-03-14 00:10:26 +08:00
Angus Gratton
79ca95ddf6 Merge branch 'doc/jtag_debug_zh_CN' into 'master'
zh_CN translation of JTAG debugging

See merge request idf/esp-idf!3709
2019-03-11 16:35:04 +08:00
Wang Fang
19939e5b60 zh_CN translation of build system (cmake version) 2019-03-05 15:02:48 +08:00
morris
94e5fba46b doc: zh_CN translation of linker script generation
Translate linker-script-generation to zh_CN.
2019-02-26 10:22:30 +08:00
zhuying
61839fc4a5 esp-idf | revise app_trace EN version 2019-01-30 11:39:23 +08:00
morris
fb2ebb19c6 translate app_trace to zh_CN 2019-01-30 11:35:15 +08:00