Commit Graph

5071 Commits

Author SHA1 Message Date
linruihao
1143fea119 docs: update rf coexistenct api guides
1. support esp32c2
2. fix inconsistency between CN and EN docs of rf coexistence
3. adjust the visibility of some contents based on soc_caps
2024-02-23 16:20:18 +08:00
morris
aa7d73c8a4 feat(i2c_lcd): use new i2c master driver in oled example
Closes https://github.com/espressif/esp-idf/issues/13201
2024-02-22 12:01:30 +08:00
morris
56c7df9fbd Merge branch 'feat/usb_host_set_device_config_v5.2' into 'release/v5.2'
USB Host: Add enumeration callback filter (backport v5.2)

See merge request espressif/esp-idf!28550
2024-02-22 11:07:43 +08:00
Erhan Kurubas
fdc6099961 feat(esp-coredump): add esp32p4 chip support and doc update 2024-02-21 21:26:39 +08:00
Peter Marcisovsky
fac5596767 feat(docs): added usb host enumeration filter description
- CN and EN docs
2024-02-21 12:34:15 +01:00
mofeifei
3e6adac5bf docs: update cn trans usb_host.rst 2024-02-21 11:33:07 +01:00
Roman Leonov
8d6167a9ab feat(docs): added USB Host Stack Configuration description 2024-02-21 11:33:07 +01:00
Marius Vikhammer
98cbd1fd72 Merge branch 'docs/esp_event_minor_update_v5.2' into 'release/v5.2'
fix(docs): Minor update to esp_event.rst for improved user experience (v5.2)

See merge request espressif/esp-idf!29122
2024-02-20 18:26:11 +08:00
Sudeep Mohanty
7801d5bad0 fix(docs): Minor update to esp_event.rst for improved user experience
This commit adds semicolons in c-code blocks in esp_event.rst for
improved user experience when directly copying and pasting code.

Closes https://github.com/espressif/esp-idf/issues/13156
2024-02-20 07:52:19 +01:00
Shu Chen
bec90ce050 docs(ieee802154): add migration note for the receive done handler feature 2024-02-20 10:31:29 +08:00
Jiang Jiang Jian
65d127da88 Merge branch 'feature/supplicant_bss_extmem_v5.2' into 'release/v5.2'
WiFi: Add support to move supplicant BSS to external memory (v5.2)

See merge request espressif/esp-idf!28743
2024-02-19 11:04:24 +08:00
Jiang Jiang Jian
2b084b1f6b Merge branch 'feature/support_gdma_retention_v5.2' into 'release/v5.2'
feature: support gdma retention in pd_top lightsleep (v5.2)

See merge request espressif/esp-idf!29090
2024-02-19 10:56:16 +08:00
wuzhenghui
eeed231304
ci: enable hardware crypto module for powersave tests 2024-02-18 15:57:19 +08:00
Roland Dobai
202c60bf6b Merge branch 'bugfix/kconcheck_file_checks_v5.2' into 'release/v5.2'
Bugfix/kconcheck file checks v5.2

See merge request espressif/esp-idf!28976
2024-02-18 15:33:12 +08:00
morris
18d0413087 Merge branch 'contrib/github_pr_12963_v5.2' into 'release/v5.2'
fix misformatted link (GitHub PR) (v5.2)

See merge request espressif/esp-idf!28754
2024-02-18 10:53:44 +08:00
Marius Vikhammer
b79cfdfb7d Merge branch 'docs/add_cannonical_url_v5.2' into 'release/v5.2'
docs(build): add cannonical stable url to all docs (v5.2)

See merge request espressif/esp-idf!28847
2024-02-18 10:39:46 +08:00
Jakub Kocka
80be245982 docs(kconfig): Updated config name lenght 2024-02-07 13:31:50 +01:00
Marius Vikhammer
e0355cd6a8 docs(build): add cannonical stable url to all docs 2024-02-02 10:36:19 +08:00
Gabor Kiss-Vamosi
7598f31cdd fix misformatted link 2024-01-29 13:14:54 +08:00
Kapil Gupta
d900eed440 fix(wifi): Add support to move supplicant BSS to external memory 2024-01-27 10:40:54 +05:30
liqigan
c6a2bdbfa1 docs(bt/bluedroid): Update migration docs for new version of API for Bluedroid host stack initialization 2024-01-22 14:19:39 +08:00
jgujarathi
40c03f95f8 docs(esp_wifi): Add docs for additional authmode incompatible situation
- Adds documentation for additional situations where authmode incompatible disconnect
  reason code will be reported
2024-01-15 11:24:37 +05:30
Kapil Gupta
ffd46a32f7 docs(wifi): Add documentation for ESP defined disconnect reasoncodes 2024-01-15 11:24:15 +05:30
Marius Vikhammer
a45478abc6 Merge branch 'feature/freertos_idf_smp_changes_doc_v5.2' into 'release/v5.2'
Docs: Update IDF FreeRTOS 10.5.1 docs and add migration notes (v5.2)

See merge request espressif/esp-idf!28227
2024-01-04 11:20:53 +08:00
Marius Vikhammer
b5785b41eb docs(esp32p4): update misc docs for esp32p4 2024-01-03 18:26:55 +08:00
mofeifei
53be71f8f2 docs: Update cn trans for freertos docs 2024-01-02 22:51:25 +08:00
Darian Leung
95a5d3ff36 docs(freertos/idf): Add IDF FreeRTOS upgarde migration notes for v5.2 2024-01-02 22:51:25 +08:00
Darian Leung
912f6c527c docs(freertos/idf): Update IDF FreeRTOS documentation
This commit updates the IDF FreeRTOS documentation as follows:

- Update terminology ("CPU" to "Core", "ESP-IDF FreeRTOS" to "IDF FreeRTOS")
- Fixed some inconsistent formatting
- Rearranged some sub sections
- Updated section regarding single-core mode to be coherent with v10.5.1 update.
2024-01-02 22:51:24 +08:00
Jiang Jiang Jian
17f2bceeb7 Merge branch 'contrib/github_pr_12637_v5.2' into 'release/v5.2'
Dockerfile with variable depth parameter (GitHub PR) (v5.2)

See merge request espressif/esp-idf!27827
2023-12-26 10:37:48 +08:00
Jiang Jiang Jian
000c70b3a1 Merge branch 'docs/fix_dash_encoding_v5.2' into 'release/v5.2'
docs(programming_guide): turned off smartquotes (v5.2)

See merge request espressif/esp-idf!27818
2023-12-26 10:36:38 +08:00
Jiang Jiang Jian
03211c7024 Merge branch 'docs/Separate_low-power_documents_v5.2' into 'release/v5.2'
docs:separate low power documents (backport v5.2)

See merge request espressif/esp-idf!28022
2023-12-25 20:37:53 +08:00
Mo Fei Fei
d1efa0d869
docs(nvs_flash): Update CN translation for nvs_encryption.rst 2023-12-21 19:22:56 +05:30
Laukik Hase
6a216ca839
fix(nvs_flash): Remove the forceful selection of NVS_ENCRYPTION with flash encryption
- This change will introduce a breaking change for SoCs with the HMAC
  peripheral. Turning on flash encryption will no longer enable NVS
  encryption automatically.

Closes https://github.com/espressif/esp-idf/issues/12549
2023-12-21 19:22:56 +05:30
Marius Vikhammer
cff4d95568 docs(programming_guide): turned off smartquotes
Sphinx would "smartly" format e.g. double dashes into typographically correct entities,
i.e. a long dash unicode character.

This doesnt always work well for our docs were sometimes a double dash could be a python
argument, which when copied would no longer work.
2023-12-20 13:09:17 +08:00
Krzysztof Budzynski
15f1425f67 Apply 2 suggestion(s) to 2 file(s) 2023-12-20 11:10:35 +08:00
wangtao@espressif.com
0d60862933 docs:Separate low-power documents 2023-12-20 11:10:13 +08:00
daiziyan
579bda6b49 docs: add CN trans for idf-docker-image.rst 2023-12-18 17:37:20 +08:00
timoxd7
ae2120cdcd feat(docker): Add Dockerfile argument for variable clone depth
Closes https://github.com/espressif/esp-idf/pull/12637
2023-12-18 17:37:20 +08:00
Jiang Jiang Jian
6a34106488 Merge branch 'contrib/github_pr_12559_v5.2' into 'release/v5.2'
fix(spi): correct macro REG_SPI_BASE(i) for all targets (GitHub PR) (v5.2)

See merge request espressif/esp-idf!27708
2023-12-11 16:01:48 +08:00
Darian Leung
3c8cccc73b 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. 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-07 17:59:44 +08:00
wanlei
572a66b62e fix(spi): correct some signals and dummy bits docs 2023-12-06 16:05:36 +08:00
Darian Leung
a75cf3effd change(xtensa): Add migration guide for depreacted include paths 2023-12-05 18:37:33 +08:00
Jiang Jiang Jian
8c86ccc2c6 Merge branch 'bugfix/lwip_dns_docs_v5.2' into 'release/v5.2'
fix(lwip): Document DNS limitation in lwIP (v5.2)

See merge request espressif/esp-idf!27558
2023-12-04 11:05:15 +08:00
Jiang Jiang Jian
821d82f04e Merge branch 'support/add_srp_salt_ver_gen_api_v5.2' into 'release/v5.2'
Generate Salt and verifier pair for given username and password (v5.2)

See merge request espressif/esp-idf!27360
2023-12-04 11:00:50 +08:00
David Cermak
b05cfb4eb1 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-12-01 08:19:26 +01:00
mofeifei
1ef33e12a4 docs: update cn trans idf-docker-image 2023-12-01 08:09:05 +01:00
Frantisek Hrbata
720985250b 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-12-01 08:09:05 +01:00
Jiang Jiang Jian
264284e0de Merge branch 'doc/change_deepsleep_example_readme_v5.2' into 'release/v5.2'
Doc/change deepsleep example readme v5.2

See merge request espressif/esp-idf!27446
2023-12-01 14:01:07 +08:00
Lou Tianhao
09a3d068d9 docs(pm):add uart wakeup description when pd top 2023-11-28 19:39:53 +08:00
Lou Tianhao
70e83a5871 docs(pm):add gpio wakeup description when pd top 2023-11-28 19:39:53 +08:00