Commit Graph

3942 Commits

Author SHA1 Message Date
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
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