Commit Graph

1298 Commits

Author SHA1 Message Date
Darian Leung
024eb7218d change(docs): Update multicore tags to SOC_HP_CPU_HAS_MULTIPLE_CORES
Previously, documentation sections that were only meant for multicore ESP
targets would use tags that depend on CONFIG_FREERTOS_UNICORE or
CONFIG_ESP_SYSTEM_SINGLE_CORE_MODE. This is not ideal as project configuration
can be changed by the user.

This commit updates those tags to use SOC_HP_CPU_HAS_MULTIPLE_CORES which is
always defined in multicore targets regardless of project configuration.
2023-12-05 10:56:48 +08:00
Ivan Grokhotkov
71153c7dbb
feat(tools): add 'idf.py qemu' extension
This extension allows running programs in QEMU similar to running
them on a real chip:

- 'idf.py qemu' — builds and runs the program in QEMU. User gets
  a QEMU instance launched, and can work with it as a normal QEMU
  instance.
- 'idf.py qemu monitor' — same, but QEMU is launched in the
  background, and idf_monitor runs in the foreground, showing QEMU
  output. Compared to only running 'idf.py qemu' this enables, for
  example, automatic backtrace decoding.
- 'idf.py qemu gdb' — launches QEMU in the background and opens an
  interactive GDB prompt, connecting it to QEMU.
- 'idf.py qemu --gdb monitor' and 'idf.py gdb' in another shell:
  launches QEMU in the background, keeps it suspended until GDB is
  connected, and opens idf_monitor. GDB can be used in another shell
  to debug the application.
2023-12-03 07:45:19 +01:00
Darian
cc34c4fc08 Merge branch 'contrib/github_pr_12481' into 'master'
Many places in the ESP_SYSTEM are using CONFIG_FREERTOS_UNICORE instead of CONFIG_ESP_SYSTEM_SINGLE_CORE_MODE (GitHub PR)

Closes IDFGH-11333

See merge request espressif/esp-idf!27435
2023-12-01 19:33:19 +08:00
wangtao@espressif.com
0d0de9da6b docs:Separate low-power documents 2023-12-01 10:13:19 +08:00
mofeifei
43bfffd85e docs: update cn trans idf-docker-image 2023-11-30 12:18:40 +01:00
Frantisek Hrbata
647c485a76 feat(docker): allow to add paths into git's safe.directory
With 8959555cee7e[1] ("setup_git_directory(): add an owner check for the top..")
git added an ownership check of the git directory and refuses to
run any git commands, even parsing the config file, if the git directory
is not owned by the current user. The "fatal: detected dubious ownership in repository"
is reported.

This fixes CVE-2022-24765[2], which allows to compromise user account. On a
multi-user system or e.g. on a shared file system, one user may create a "rogue"
git repository with e.g. core.fsmonitor set to an arbitrary command. Other user
may unwillingly execute this command by running e.g. git-diff or
git-status within the "rogue" git repository, which may be in one of the parent
directories. If e.g. PS1 is set to display information about a git
repository in CWD, as suggested in Git in Bash[3], the user do not need to run
any git command to trigger this, just entering some subdirectory under
this "rogue" git repository is enough, because the git command will be
started transparently through the script used in PS1. The core.fsmonitor
can be set to arbitrary command. It's purpose is to help git to identify changed files
and speed up the scanning for changed files.

rogue
├── .git     # owned by user1
└── dir1     # owned by user2
    ├── dir2 # owned by user2
    └── .git # owned by user2

user1 sets core.fsmonitor for git repository in rogue directory
$ git config --add core.fsmonitor "bash -c 'rm -rf \$HOME'"

user2 enters dir1 and runs e.g. git diff and triggers the core.fsmonitor command.

The ownership check may cause problems when running git commands in
ESP-IDF Docker container. For example user may run the container as
root, but the mounted project may be owned by a particular user.

In this case git will refuse to execute any git command within the
"/project" directory, because it's not owned by root. To overcome this,
git allows to set safe.directories, for which the ownership check is
skipped. The security check may be completely disabled by setting
safe.directories to "*". This solution was proposed in PR 12636[4], but
it would allow make it possible to exploit this vulnerability again.

This fix allows user to specify git's safe.directory in IDF_GIT_SAFE_DIR
environmental variable, which may be set during container startup.

The IDF_GIT_SAFE_DIR has same format as PATH and multiple directories can be
specified by using a ":" separator. To entirely disable this git security check
within the container, user may set IDF_GIT_SAFE_DIR='*'. This might be
heplfull in CI.

Closes https://github.com/espressif/esp-idf/pull/12636

[1] - 8959555cee
[2] - https://nvd.nist.gov/vuln/detail/cve-2022-24765
[3] - https://git-scm.com/book/en/v2/Appendix-A%3A-Git-in-Other-Environments-Git-in-Bash
[4] - https://github.com/espressif/esp-idf/pull/12636

Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
2023-11-30 12:18:40 +01:00
Omar Chebib
dc8fdae31b docs(freertos): revert usage of hidden option CONFIG_ESP_SYSTEM_SINGLE_CORE_MODE when :ref: is used 2023-11-30 16:33:28 +08:00
fl0wl0w
d149c1b26f Use configuration option instead of in components not related to FreeRTOS
Mergeshttps://github.com/espressif/esp-idf/pull/12481
2023-11-28 07:49:20 +00:00
Jeroen Domburg
3f08e5c91a fix(driver): Add docs and driver fix for the case where a full EP does not cause the host to pickup the data 2023-11-27 12:04:30 +08:00
Shu Chen
db84b88d14 Merge branch 'fix/add_docs_for_coex' into 'master'
feat(docs) Add RF Coexist docs for H2

Closes IDF-8550

See merge request espressif/esp-idf!27150
2023-11-22 21:23:33 +08:00
David Čermák
17f6528718 Merge branch 'bugfix/lwip_dns_docs' into 'master'
fix(lwip): Document DNS limitation in lwIP

See merge request espressif/esp-idf!27099
2023-11-22 20:39:22 +08:00
zwx
da9972183c feat(docs): Add RF Coexist docs for H2 2023-11-22 16:54:55 +08:00
David Cermak
1f6a927e33 fix(lwip): Document DNS limitation in lwIP
* Add a note that DNS server config is global in lwIP
* Add a section about defining LWIP config macros from CMake
* Mention the DNS limitation in ESP-IDF additions to lwIP
* Update CN for lwIP DNS limitation

Co-Authored-By: Wang Ziyan <wangziyan@espressif.com>
2023-11-22 08:48:33 +01:00
Shang Zhou
a0edece25a docs: Update CN translation for api-guides/tools/idf-monitor.rst 2023-11-16 09:20:48 +01:00
Peter Dragun
18ddb86c7f fix(tools/monitor): fix PRINT_FILTER env variable usage 2023-11-16 09:20:48 +01:00
Roland Dobai
dd1247f313 Merge branch 'fix/docs_tools' into 'master'
fix(tools): Remove idf.py dependencies from documentation

See merge request espressif/esp-idf!27101
2023-11-14 16:37:44 +08:00
Roland Dobai
6f50b02a3a fix(tools): Remove idf.py dependencies from documentation
Those dependencies are always satisfied because:
- ESP-IDF supports Python 3.8+ at this moment,
- click version is checked and ensured by the install scripts.
2023-11-13 14:33:54 +01:00
Jakob Hasse
ed5a7dfa82 docs: Added C documentation page
Closes https://github.com/espressif/esp-idf/issues/12439
Closes https://github.com/espressif/esp-idf/issues/12001
2023-11-13 10:47:15 +08:00
Sudeep Mohanty
348206fc65 fix(docs/build_system): Remove duplication about project_include.cmake usage
This commit fixes a duplication regarding the usage of the
project_include.cmake file in the build_system.rst doc.
2023-11-10 16:12:59 +01:00
Song Ruo Jing
9461993ec5 refactor(gpio): make gpio driver as component, and fix astyle 2023-11-03 15:42:23 +08:00
Shang Zhou
8b1a494cd3 docs: Fix typo in get-started/index.rst and thread-local-storage.rst based on customer feedback 2023-11-02 14:10:34 +08:00
Armando (Dou Yiwen)
100ba9f375 Merge branch 'doc/added_adc_calibration_efuse_error_info' into 'master'
doc(adc): added efuse related failure doc

Closes IDFGH-11205

See merge request espressif/esp-idf!26741
2023-10-31 11:11:32 +08:00
Armando
95b0152637 doc(adc): added efuse related failure doc
Closes https://github.com/espressif/esp-idf/issues/12372
2023-10-30 14:20:24 +08:00
radim.karnis
0349f471af docs(idf-clang-tidy): Mention the need for a clang based toolchain
Closes https://github.com/espressif/clang-tidy-runner/issues/32
2023-10-30 11:10:11 +08:00
Jiang Guang Ming
ff17d16821 docs: add the description of CONFIG_MBEDTLS_USE_CRYPTO_ROM_IMPL 2023-10-23 13:10:44 +08:00
Ren Pei Ying
fa13977275 Merge branch 'docs/update_format_for_kconfig_and_external-ram.rst' into 'master'
docs: Update Chinese translation for external-ram.rst and kconfig.rst

See merge request espressif/esp-idf!26517
2023-10-19 18:05:32 +08:00
Zim Kalinowski
fa1a3ce0b5 Merge branch 'refactor/components_linux_compatible' into 'master'
Exclude all currently incompatible components from Linux build

Closes IDF-8318 and IDF-5996

See merge request espressif/esp-idf!25598
2023-10-18 20:17:49 +08:00
renpeiying
f341f04146 docs: Update Chinese translation for external-ram.rst and kconfig.rst 2023-10-18 16:02:04 +08:00
Xu Xiao
ed9f9021cc Merge branch 'revert_tcpip_task_priority_macro' into 'master'
revert(lwip): Revert changes to LWIP task priority macro from MR 25020

See merge request espressif/esp-idf!26420
2023-10-17 13:28:19 +08:00
Jakob Hasse
548022fbe6 refactor(linux): excluded all non-Linux components from build
* All components which won't build (yet) on Linux are excluded.
  This enables switching to Linux in an application without
  explicitly setting COMPONENTS to main in the main
  CMakeLists.txt.
* ESP Timer provides headers for Linux now
* automatically disabling LWIP in Kconfig if it is not available

doc(linux): brought section
  "Component Linux/Mock Support Overview" up to date
2023-10-16 17:06:54 +08:00
Cai Xin Ying
01209e459c docs: update document format issues 2023-10-14 03:55:41 +08:00
Armando (Dou Yiwen)
f57dd0a815 Merge branch 'doc/esp32p4_psram_programming_guide' into 'master'
psram: updated psram programming guide to esp32p4

Closes IDF-7711

See merge request espressif/esp-idf!26434
2023-10-13 14:20:52 +08:00
Martin Vychodil
64befdca3a Merge branch 'feature/partition_readonly_flag' into 'master'
feat(partition_table): Add read-only partition flag and functionality

Closes IDF-6421

See merge request espressif/esp-idf!24855
2023-10-13 11:11:07 +08:00
Armando
f519e036eb doc(psram): updated psram programming guide to esp32p4 2023-10-12 19:36:21 +08:00
Jiang Jiang Jian
59417a4049 Merge branch 'feature/free_bt_memory' into 'master'
feat(bt): Frees BLE memory when no longer in use

See merge request espressif/esp-idf!22795
2023-10-12 18:35:15 +08:00
Peter Dragun
aa9f81cfc6 Merge branch 'feat/monitor-config' into 'master'
docs(tools/idf-monitor): add info about custom keystrokes

See merge request espressif/esp-idf!26129
2023-10-12 16:02:34 +08:00
Shang Zhou
37dbce301e docs: Provide CN translation for partition-tables.rst 2023-10-11 12:03:12 +02:00
xuxiao
31bb66813a revert(lwip): Revert changes to LWIP task priority macro from MR 25020 2023-10-11 17:54:27 +08:00
Adam Múdry
ab1eb37fe8 feat(partition_table): Add read-only partition flag and functionality 2023-10-11 00:01:05 +02:00
renpeiying
c744d3d5fd docs: Update Chinese translation for idf-monitor 2023-10-10 12:07:36 +08:00
Anton Maklakov
02802ea20a feat(tools): Add QEMU 8.0.0_20230522 to tools.json
Process wildcards in the install and download lists of idf_tools
    Fix the install and download handlers to get common behaviour
2023-10-10 09:59:38 +07:00
Alexey Lapshin
2585e53d54 Merge branch 'feature/update-toolchain-to-esp-13.1.0_new_newlib' into 'master'
Update toolchain to esp-13.2.0_20230919

Closes GCC-250, GCC-322, GCC-324, GCC-327, GCC-330, and IDF-8287

See merge request espressif/esp-idf!25073
2023-10-10 08:18:33 +08:00
Darian
a10121491f Merge branch 'change/freertos_make_task_snapshot_private' into 'master'
refactor(freertos/task_snapshot): Make task snapshot private

Closes IDF-8182

See merge request espressif/esp-idf!26115
2023-10-09 16:32:18 +08:00
Alexey Lapshin
98199d50d6 change(tools): update gcc toolchain version to 13.2.0
Add Kconfig option to supress new gcc warnings
Update docs with migration guide
2023-10-09 12:13:00 +04:00
Ren Pei Ying
8dbff6a5fe docs: Update translations for ESP-IDF unsynchronized files 2023-10-09 10:25:19 +08:00
zhaokeke
a39869416c feat(bt): Frees BLE memory when no longer in use
It will free libble.a & libbt all txt, data and bss segment memory.
This memory is combined into one large memory and put into the heap
pool.
2023-10-08 16:08:47 +08:00
Darian Leung
9968a48c36 refactor(freertos/task_snapshot): Make task snapshot private
Task snapshot API were never intended to be called from user code. This commit
makes task snapshot a private API thus moves `#include "freertos/task_snapshot.h"`
to `#include "esp_private/freertos_debug.h"`.

Task snapshot related Kconfig options have also been hidden.

Note: Added 'freertos_common' mapping to ldgen mapping execptions lists due to
inlining of 'freertos_debug.h' functions.
2023-10-07 13:14:55 +08:00
Alexey Gerenkov
acc04fc2cf Merge branch 'doc/refer_gdbstub_indebug_section' into 'master'
docs(jtag-debugging): Add links to gdbstub for convenience

Closes IDFGH-10898

See merge request espressif/esp-idf!25751
2023-10-04 17:09:12 +08:00
Peter Dragun
000266c417 docs(tools/idf-monitor): add info about custom keystrokes 2023-10-03 15:48:25 +02:00
Fu Hanxi
4dbe541f80
ci: replace internal clang-tidy runner with the pypi project 2023-09-27 10:25:49 +02:00
Alexey Gerenkov
3b23dc8792 Merge branch 'bugfix/docs_hw_breakpoints_num' into 'master'
fix(docs/jtag): Fix hard-coded HW breakpoints/watchpoints number

Closes IDFGH-10772

See merge request espressif/esp-idf!25750
2023-09-27 14:57:29 +08:00
Wang Zi Yan
7729144f1a docs: Update CN for speed.rst 2023-09-25 11:20:30 +08:00
Jiang Jiang Jian
d42306c317 Merge branch 'docs/eth_opt' into 'master'
docs(esp_eth): added Ethernet to Improving Network Speed section

See merge request espressif/esp-idf!25839
2023-09-25 10:09:28 +08:00
renpeiying
c17d9ff684 docs: Update Chinese translation for api-guides/jtag-debugging/index.rst 2023-09-20 10:47:42 +08:00
Chip Weinberger
195524efa8 docs(jtag-debugging): Add links to gdbstub for convenience
Closes https://github.com/espressif/esp-idf/pull/12097
2023-09-20 10:31:09 +08:00
wangjialiang
8eed3a2467 fix(ble_mesh): Miscellaneous update for ble mesh 2023-09-16 15:58:14 +08:00
caixinying-git
b07ada6e94 docs: update format issues left in EN docs 2023-09-15 10:46:25 +00:00
zhangwenxu
60bb5b0d99 feat(openthread): Add support to allocate message pool from PSRAM 2023-09-14 15:14:07 +08:00
renpeiying
9a96be7aef docs: Update CN translation for api-guides/build-system.rst 2023-09-13 15:11:26 +08:00
Jakob Hasse
19f0c873cb docs(build system): Clarified target-specific sdkconfig.defaults usage 2023-09-13 14:11:43 +08:00
Jiang Jiang Jian
5933779f2d Merge branch 'feature/configurable_wpa2_ent' into 'master'
esp_wifi: Make enterprise support configurable to save binary size.

Closes WIFI-3597

See merge request espressif/esp-idf!24345
2023-09-13 10:17:44 +08:00
Ren Pei Ying
c56ca136f6 Merge branch 'docs/Update_translation_for_synchronization' into 'master'
docs: Update translation for ESP-IDF docs for syncronization

Closes DOC-6155

See merge request espressif/esp-idf!25769
2023-09-11 12:16:35 +08:00
Liu Linyan
5bab168b0e feat(ble_mesh): Support Bluetooth Mesh Protocol v1.1 (Preview) 2023-09-08 21:37:33 +08:00
Liu Linyan
fd451f5856 feat(ble_mesh): Misc updates for BLE Mesh examples 2023-09-08 21:37:33 +08:00
Liu Linyan
0e63bfcddc feat(ble_mesh): Remove ble_mesh_console example 2023-09-08 21:37:33 +08:00
Liu Linyan
bf51fb965b feat(ble_mesh): Bluetooth Mesh folder and file misc updates 2023-09-08 21:37:33 +08:00
renpeiying
9b447664db docs: Update translation for ESP-IDF docs for syncronization 2023-09-08 15:43:29 +08:00
Cai Xin Ying
b642987ff6 Merge branch 'docs/add_Chinese_translation_for_api-guides/wifi-security.rst' into 'master'
docs: provide CN translation for api-guides/wifi-security.rst

Closes DOC-5459

See merge request espressif/esp-idf!24211
2023-09-07 21:20:05 +08:00
Roland Dobai
5f74dd2bb3 Merge branch 'docs/docker_image_flashing' into 'master'
docs(docker): Update Using Remote Serial Port chapter

Closes IDFGH-10856

See merge request espressif/esp-idf!25778
2023-09-07 18:05:48 +08:00
Ondrej Kosta
219e4646f8 docs(esp_eth): added Ethernet to Improving Network Speed section 2023-09-07 09:36:01 +02:00
Cai Xin Ying
2fac98d2e0 docs:update format issues for files under api-guides 2023-09-07 15:26:05 +08:00
caixinying-git
d0abcaf0ad docs: provide CN translation for api-guides/wifi-security.rst 2023-09-07 14:21:07 +08:00
Jakub Kocka
e265c1f387 docs(docker): Update Using Remote Serial Port chapter
By default some shells such as zsh has NOMATCH option set (https://zsh.sourceforge.io/Doc/Release/Options.html).
The root cause of the problem is that while bash expands the parameter to itself if it does not match any filename, the zsh reports an error. IOW if we do % setopt nonomatch it will work even in zsh.

Closes https://github.com/espressif/esp-idf/issues/12060
2023-09-06 11:26:47 +02:00
Adam Múdry
2b5d12858d Merge branch 'docs/partition_table_api_guide_update_data_subtypes' into 'master'
docs(storage): Add supported data partition subtypes

Closes IDF-818

See merge request espressif/esp-idf!25614
2023-09-06 15:31:39 +08:00
Mo Fei Fei
e4b7dd371c Docs: update Chinese translation for partition table data subtypes 2023-09-06 11:19:54 +08:00
Jiang Jiang Jian
72a8f37723 Merge branch 'feature/update_h2_wifi_docs' into 'master'
feat(doc): update wifi sections for H2

See merge request espressif/esp-idf!25662
2023-09-06 10:20:46 +08:00
Roland Dobai
f28daac734 Merge branch 'feature/add_cn_to_idf_github_assets' into 'master'
feat(tools): Add dl.espressif.cn IDF_GITHUB_ASSET to documentation

Closes IDF-8065

See merge request espressif/esp-idf!25613
2023-09-05 18:01:27 +08:00
Krzysztof Budzynski
5325cb5a9f Apply 1 suggestion(s) to 1 file(s) 2023-09-05 17:26:52 +08:00
morris
b4c7b13ce9 Merge branch 'docs/add_Chinese_translation_for_api-guides/lwip.rst' into 'master'
docs: provide CN translation for api-guides/lwip.rst

Closes DOC-5300

See merge request espressif/esp-idf!24002
2023-09-05 11:15:48 +08:00
Cai Xin Ying
065307fb84 Merge branch 'docs/add_Chinese_translation_for_api-guides/cplusplus.rst' into 'master'
docs: provide CN translation for api-guides/cplusplus.rst

Closes DOC-5460

See merge request espressif/esp-idf!24239
2023-09-04 22:14:10 +08:00
Nic Ballinger
f5450ca530 fix(docs/jtag): Fix hard-coded HW breakpoints/watchpoints number
Closes https://github.com/espressif/esp-idf/pull/11986
2023-09-04 15:40:04 +03:00
caixinying-git
6ee5bbf3a6 docs: provide CN translation for api-guides/lwip.rst 2023-09-04 17:46:22 +08:00
Xu Xiao
8847eeec0c feat(wifi): optimize esp32c6 iperf performance 2023-09-04 14:34:54 +08:00
caixinying-git
7c560c61c3 docs: provide CN translation for api-guides/cplusplus.rst 2023-09-01 11:02:36 +08:00
xuxiao
4701aa1589 feat(doc): update wifi sections for H2 2023-08-31 19:27:51 +08:00
Cai Xin Ying
e0f5d3c527 Merge branch 'docs/add_Chinese_translation_for_api-guides/core_dump.rst' into 'master'
docs:provide CN translation for api-guides/core_dump.rst and api-guides/core_dump_internals.rst

Closes DOC-5457

See merge request espressif/esp-idf!24197
2023-08-31 16:50:52 +08:00
Cai Xin Ying
18c2bb0a6f docs:provide CN translation for api-guides/core_dump.rst and api-guides/core_dump_internals.rst 2023-08-31 16:50:52 +08:00
Rocha Euripedes
acbcdc0487 Merge branch 'clarification_on_rtc_fast' into 'master'
docs: Makes the description for RTC fast as heap explicit

See merge request espressif/esp-idf!25103
2023-08-31 16:21:21 +08:00
Marek Fiala
608b6e5480 feat(tools): Add dl.espressif.cn IDF_GITHUB_ASSET to documentation 2023-08-31 07:46:36 +00:00
Cai Xin Ying
9684acc482 Docs: provide CN translation for the rest docs of api-guides/tools 2023-08-29 23:10:06 +08:00
Adam Múdry
087de4c77a docs(storage): Add supported data partition subtypes 2023-08-29 11:28:28 +02:00
Sudeep Mohanty
ec4cd2bb19 docs(freertos): Updated FreeRTOS documentation for ESP32-P4 2023-08-28 10:07:43 +08:00
aditi_lonkar
c88e7106ec esp_wifi: Make enterprise support configurable to save binary size. 2023-08-25 11:00:54 +05:30
mofeifei
3035856381 docs: update cn trans for memory-types 2023-08-25 11:43:39 +08:00
Radim Karniš
e3eb2ea9cc Merge branch 'docs/uninstall_idf' into 'master'
docs(idf-tools): Add uninstallation instructions

Closes IDFGH-9768

See merge request espressif/esp-idf!25313
2023-08-23 05:03:51 +08:00
Jiang Jiang Jian
514d9a8594 Merge branch 'docs/update_wifi_and_wpa_supplicant_documentation' into 'master'
Docs: Update wifi and wpa_supplicant documentation

See merge request espressif/esp-idf!24029
2023-08-22 19:29:37 +08:00
caixinying-git
a876c2d888 docs: provide CN translation for api-guides/usb-serial-jtag-console.rst 2023-08-22 11:06:12 +08:00
Shang Zhou
00fe2a6166 docs: Update CN translation for idf-tools.rst and get-started/index.rst 2023-08-21 15:34:26 +02:00
radim.karnis
e2638a2af0 docs(idf-tools): Add uninstallation instructions
Closes https://github.com/espressif/esp-idf/issues/11102
2023-08-21 15:32:27 +02:00
Shreyas Sheth
043b8b55a1 docs(wifi): Update wifi and wifi security documentation
1. Update documentation for WPA3 Enterprise and WPA3 Enterprise 192-bit
mode
2. Update documentation for WPA3 OWE and OWE transition mode
3. Update documentation related to SAE PK, SAE PWE and Transition Disable
4. Update documnetation for wifi connect API
5. Fix config paramter information for wifi scan start
6. Fix documentation related to scan threshold config setting
7. Replace ESP_ERR_WIFI_ARG error code as ESP_ERR_INVALID_ARG
8. Update documentation for 802.11R Fast transition
2023-08-21 12:29:11 +00:00