Commit Graph

4017 Commits

Author SHA1 Message Date
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
Jakub Kocka
80be245982 docs(kconfig): Updated config name lenght 2024-02-07 13:31:50 +01: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
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
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
Shang Zhou
63ea519cbe docs: Update CN translation for api-guides/tools/idf-monitor.rst 2023-11-27 09:32:41 +01:00
Peter Dragun
c71ee4f78a fix(tools/monitor): fix PRINT_FILTER env variable usage 2023-11-27 09:32:41 +01:00
Vikram Dattu
ee65ea9fb7
refactor(esp_srp): Expose esp_srp.h and add API docs
- Also added missing `protocomm_security2` reference in `protocomm.rst`
2023-11-23 14:25:53 +05:30
Marius Vikhammer
b7ac980fbc Merge branch 'backport/add_docs_for_coex_v52' into 'release/v5.2'
feat(docs) Add RF Coexist docs for H2

See merge request espressif/esp-idf!27237
2023-11-23 13:57:40 +08:00
zwx
323f128228 feat(docs): Add RF Coexist docs for H2 2023-11-22 16:58:54 +08:00
Jiang Jiang Jian
f04854bb4a Merge branch 'docs/update_nan_docs_v5.2' into 'release/v5.2'
Fix inconsistency in NAN documentation (Backport v5.2)

See merge request espressif/esp-idf!27267
2023-11-21 11:48:31 +08:00
Shyamal Khachane
782eaa3c7e docs(esp_wifi): Fix inconsistency in NAN documentation 2023-11-20 15:07:45 +05:30
Mahavir Jain
bad8adfd59 docs(ecdsa): add a note about TRNG dependency for ECDSA peripheral 2023-11-17 07:13:53 +00:00
Mahavir Jain
2882b6f68b docs: add ECDSA peripheral chapter for H2/P4
- Add ECDSA peripheral chapter and instructions to program efuse key block
- Update security guide for ECDSA peripheral mention for device identity
- Link with ESP-TLS guide about using ECDSA peripheral in TLS connection
2023-11-17 07:13:53 +00:00
Jiang Jiang Jian
fc11d2ae72 Merge branch 'bugfix/secure_boot_v2_docs_v5.2' into 'release/v5.2'
fix(docs): correct the target specific macros for secure boot v2 guide (v5.2)

See merge request espressif/esp-idf!27169
2023-11-17 10:31:57 +08:00
muhaidong
d8b2b9e77f esp_supplicant: remove wpa supplicant ROM source code copyrights 2023-11-16 11:02:30 +08:00
Mahavir Jain
b4f6edecbc
fix(docs): correct the target specific macros for secure boot v2 guide
It appears that target specific or'ing is not supported through the
docs build. Actual text rendering on the docs site was still using
"default" field from the custom macro, rather than using target
specific.
2023-11-15 15:34:12 +05:30
Marius Vikhammer
1efaf83ef4 docs(esp32h2): updated misc docs with esp32h2 content 2023-11-15 09:54:05 +08:00
morris
621acc4d75 Merge branch 'feature/rmt_receive_in_isr_v5.2' into 'release/v5.2'
feat(rmt): support calling rmt_receive in ISR callback (v5.2)

See merge request espressif/esp-idf!26996
2023-11-13 12:22:33 +08:00
Jiang Jiang Jian
4331ae783a Merge branch 'feature/support_adc_calibration_on_h2_v5.2' into 'release/v5.2'
adc_cali: supported adc calibration v1 on ESP32H2 (v5.2)

See merge request espressif/esp-idf!26962
2023-11-09 12:14:40 +08:00
morris
02cacc6e05 Merge branch 'bugfix/fix_wrong_adc_attenuation_name_v5.2' into 'release/v5.2'
fix(adc): rename ADC_ATTEN_DB_11 to ADC_ATTEN_DB_12 (v5.2)

See merge request espressif/esp-idf!26966
2023-11-08 14:50:30 +08:00
morris
2e8cc61af7 feat(rmt): support calling rmt_receive in ISR callback 2023-11-08 14:32:26 +08:00
Cao Sen Miao
614aed7409 docs(i2c): Add new programming guide for new I2C driver 2023-11-08 09:57:25 +08:00
Armando
f01a40afe2 fix(adc): rename ADC_ATTEN_DB_11 to ADC_ATTEN_DB_12
By design, it's 12 dB. There're errors among chips, so the actual
attenuation will be 11dB more or less
2023-11-07 14:11:10 +08:00
gaoxu
1b07551997 docs(adc): added adc calibration doc on h2 2023-11-07 09:30:56 +08:00
morris
8dda17e3a3 fix(rmt): a disabled channel may pick up a pending transaction
because in the trans_done interrupt, the driver didn't check the channel FSM
2023-11-02 11:30:42 +08:00
Mo Fei Fei
a82b6f5c0b Merge branch 'docs/update_cn_trans_nvs_part_gen_readme' into 'master'
Docs: Update CN trans for components/nvs_flash/nvs_partition_generator/README.rst

Closes DOC-6449

See merge request espressif/esp-idf!26589
2023-10-26 12:19:26 +08:00
Mo Fei Fei
4f24d3a39c Docs: Update CN trans for components/nvs_flash/nvs_partition_generator/README.rst 2023-10-26 12:19:25 +08:00
Laukik Hase
340fda1cd6 Merge branch 'fix/nvs_encr_docs' into 'master'
fix(docs): Hide the NVS encryption HMAC scheme section for unsupported SoCs

See merge request espressif/esp-idf!26568
2023-10-25 16:24:57 +08:00
Laukik Hase
81665b27c3 fix(docs): Disable the NVS encryption HMAC scheme section for unsupported SoCs 2023-10-25 13:07:14 +08:00
Wang Zi Yan
d2931274ba docs: Update CN for gcc.rst 2023-10-24 16:28:08 +08:00
Xiao Xufeng
88954841b1 doc(spi_flash): hide unsupported optional features 2023-10-24 10:38:11 +08:00
Xiao Xufeng
1f5fb3f921 spi_flash: fixed issue that enabling HPM-DC by default may cause app unable to restart 2023-10-24 10:38:08 +08:00
Jiang Jiang Jian
345565d8c1 Merge branch 'feature/support_esp32c2_rom_mbedtls' into 'master'
feat(mbedtls): support c2 mbedtls can use crypto algorithm in ROM

See merge request espressif/esp-idf!25272
2023-10-24 09:30:15 +08:00
Marius Vikhammer
679b1dc4bb Merge branch 'docs/ulp_lp_uart' into 'master'
docs(ulp): add info about lp-uart to lp-core docs

See merge request espressif/esp-idf!26405
2023-10-24 08:30:29 +08:00
morris
767595a22f Merge branch 'feature/mcpwm_timer_change_freq' into 'master'
feat(mcpwm): support update timer period dynamically

Closes IDFGH-11145

See merge request espressif/esp-idf!26419
2023-10-23 15:51:14 +08:00
Jiang Guang Ming
a3efe503e8 docs: Update COPYRIGHT.rst since mbedtls supported in C2 ROM 2023-10-23 13:10:44 +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
Marius Vikhammer
789a8b3446 docs(ulp): add info about lp-uart to lp-core docs 2023-10-23 12:11:34 +08:00
Darian Leung
82ad04e3ba change(freertos/idf): Update version number, licenses, and sbom to v10.5.1
Following the upgrade to FreeRTOS kernel v10.5.1, this commit updates the
version numbers, licenses, and SBOM files of FreeRTOS files to reflect v10.5.1.

Note:

- Updated licenses as v10.5.1 now uses SPDX format
- Removed CVE-2021-43997 as it was fixed post v10.4.5
2023-10-21 04:39:16 +08:00
morris
0cbcb9f5ea feat(mcpwm): support update timer period dynamically
Implement the requirement asked in
https://www.esp32.com/viewtopic.php?f=13&t=35919
2023-10-20 16:57:25 +08:00
Roland Dobai
91da72ef95 Merge branch 'docs/dialout_group_linux' into 'master'
docs(get-started): Adjusteded docs flashing part to be more user friendly

Closes IDFGH-11199

See merge request espressif/esp-idf!26411
2023-10-20 16:36:12 +08:00
Armando (Dou Yiwen)
471f1f61ae Merge branch 'feature/support_sdmmc_ver2_on_p4' into 'master'
sdmmc: esp32p4 support

Closes IDF-6502

See merge request espressif/esp-idf!25405
2023-10-19 22:00:40 +08:00
Jakub Kocka
9cc213289d docs(get-started): Adjusteded docs flashing part to be more user friendly
Closes https://github.com/espressif/esp-idf/issues/12366
2023-10-19 15:11:34 +02: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
Ren Pei Ying
143a9a1678 Merge branch 'docs/Provide_CN_trans_for_api-reference/system/chip_revision.rst' into 'master'
docs: Provide Chinese translation for api-reference/system/chip_revision.rst

Closes DOC-6204

See merge request espressif/esp-idf!25756
2023-10-18 22:56:52 +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
Armando
70314b56d5 feat(sdmmc): supported sd2.0 on esp32p4 2023-10-18 11:57:55 +00:00
Zhang Xiao Yan
1685dbc985 Merge branch 'docs/update_front_page_for_esp32p4' into 'master'
docs: update front page for esp32p4

See merge request espressif/esp-idf!26479
2023-10-18 19:18:19 +08:00
renpeiying
cd1133df82 docs: Provide Chinese translation for api-reference/system/chip_revision.rst 2023-10-18 16:18:04 +08:00
renpeiying
f341f04146 docs: Update Chinese translation for external-ram.rst and kconfig.rst 2023-10-18 16:02:04 +08:00
Guillaume Souchere
d6def6c06e Merge branch 'fix/check_integrity_on_used_blocks' into 'master'
heap: fix integrity check on used blocks by the tlsf component

Closes IDFGH-11050

See merge request espressif/esp-idf!26289
2023-10-18 15:47:25 +08:00
Wan Lei
9f413d5d8d Merge branch 'feature/esp32p4_hp_ledc_support' into 'master'
feat(ledc): support ledc on esp32p4

Closes IDF-6510

See merge request espressif/esp-idf!25356
2023-10-18 15:27:54 +08:00
Mahavir Jain
0fd70974e4 Merge branch 'contrib/github_pr_12262' into 'master'
Update host-based-security-workflows.rst (GitHub PR)

Closes IDFGH-11090

See merge request espressif/esp-idf!26521
2023-10-18 12:11:35 +08:00
Adam Múdry
d019bf0e32 Merge branch 'docs/remove_envvar_from_spi_flash_docs' into 'master'
docs: Remove :envvar: form spi_flash documentation

Closes IDF-2497

See merge request espressif/esp-idf!26528
2023-10-18 06:01:01 +08:00
Martin Vychodil
a61c6cf2c1 Merge branch 'docs/delete_sys_types.h_from_description_vfs.rst' into 'master'
docs: update the file of defining FD_SETSIZE in vfs.rst

See merge request espressif/esp-idf!25942
2023-10-18 00:04:54 +08:00
Adam Múdry
a64f216737 docs: Remove :envvar: form spi_flash documentation 2023-10-17 13:35:42 +02:00
walerii
478879ab0d Update host-based-security-workflows.rst
Fixed typos in the code examples which caused troubles when trying to follow the secure boot workflow and improved the grammar.

Closes https://github.com/espressif/esp-idf/pull/12262
2023-10-17 14:27:30 +05:30
Ren Pei Ying
15da1a0fb5 Merge branch 'docs/add_CN_trans_for_api-reference/system/pthread.rst' into 'master'
docs: Provide Chinese translation for api-reference/system/pthread.rst

Closes DOC-6331

See merge request espressif/esp-idf!26022
2023-10-17 16:55:10 +08:00
wanlei
57614bbad2 feat(ledc): support ledc on esp32p4 2023-10-17 16:40:04 +08:00
renpeiying
2dd0d9f330 docs: Provide Chinese translation for api-reference/system/pthread.rst 2023-10-17 14:03:36 +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
Kevin (Lao Kaiyao)
fcc4827e88 Merge branch 'contrib/github_pr_12384' into 'master'
docs: fix i2s section formatting (GitHub PR)

Closes IDFGH-11218

See merge request espressif/esp-idf!26408
2023-10-17 12:34:18 +08:00