Commit Graph

4548 Commits

Author SHA1 Message Date
Sudeep Mohanty
57627f5883 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 08:45:38 +01:00
Shu Chen
1b4837fb24 docs(ieee802154): add migration note for the receive done handler feature 2024-01-26 17:00:38 +08:00
Krzysztof Budzynski
ccc8b274eb Merge branch 'docs/add_Chinese_translation_for_api-reference/peripherals/sdio_slave.rst_backport_v5.1' into 'release/v5.1'
docs: provide CN translation for api-reference/peripherals/sdio_slave.rst (Backport v5.1)

See merge request espressif/esp-idf!26109
2024-01-02 19:43:24 +08:00
Cai Xin Ying
8495a31f46 docs: provide CN translation for api-reference/peripherals/sdio_slave.rst (Backport v5.1) 2024-01-02 19:43:24 +08:00
Jiang Jiang Jian
503eccb261 Merge branch 'docs/Separate_low-power_documents_v5.1' into 'release/v5.1'
docs:separate low power documents (backport v5.1)

See merge request espressif/esp-idf!28021
2023-12-21 11:10:13 +08:00
Krzysztof Budzynski
6360246a29 Apply 2 suggestion(s) to 2 file(s) 2023-12-20 11:08:12 +08:00
wangtao@espressif.com
a56b523822 docs:Separate low-power documents(backprot v5.1) 2023-12-20 11:07:28 +08:00
muhaidong
13094f2216 change(wifi): update esp_coexist_internal.h and esp_modem_wrapper.h 2023-12-19 19:15:49 +08:00
muhaidong
7b3cee0dd8 update(esp_coexist): update esp coexist header file 2023-12-19 19:15:49 +08:00
muhaidong
5960284022 esp_supplicant: remove wpa supplicant ROM source code copyrights 2023-12-19 19:15:49 +08:00
morris
eb7022dd06 Merge branch 'contrib/github_pr_12559_v5.1' into 'release/v5.1'
fix(spi): Correct REG_SPI_BASE(i) macro for all targets (GitHub PR) (v5.1)

See merge request espressif/esp-idf!27714
2023-12-14 11:08:03 +08:00
Marius Vikhammer
9ad2c6f8df Merge branch 'docs/fix_dash_encoding_v5.1' into 'release/v5.1'
docs(programming_guide): turned off smartquotes (v5.1)

See merge request espressif/esp-idf!27819
2023-12-12 09:53:10 +08:00
timoxd7
b2250f31b9 feat(docker): Add Dockerfile argument for variable clone depth
Closes https://github.com/espressif/esp-idf/pull/12637
2023-12-11 09:03:46 +01:00
Marius Vikhammer
40241d4b68 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-11 14:06:32 +08:00
Jiang Jiang Jian
d52d82ee83 Merge branch 'doc/change_deepsleep_example_readme_v5.1' into 'release/v5.1'
Doc/change deepsleep example readme v5.1

See merge request espressif/esp-idf!27447
2023-12-08 11:20:50 +08:00
Jiang Jiang Jian
4caaabec9e Merge branch 'bugfix/lwip_dns_docs_v5.1' into 'release/v5.1'
fix(lwip): Document DNS limitation in lwIP (v5.1)

See merge request espressif/esp-idf!27562
2023-12-08 11:20:13 +08:00
wanlei
3486cf1b60 fix(spi): correct some signals and dummy bits docs 2023-12-06 16:15:23 +08:00
Mahavir Jain
d083a0e313 Merge branch 'support/add_srp_salt_ver_gen_api_v5.1' into 'release/v5.1'
Generate Salt and verifier pair for given username and password (v5.1)

See merge request espressif/esp-idf!27351
2023-12-04 21:10:51 +08:00
Lou Tianhao
9226c65c74 docs(pm):add uart wakeup description when pd top 2023-12-04 07:39:11 +00:00
Lou Tianhao
57787d1aae docs(pm):add gpio wakeup description when pd top 2023-12-04 07:39:11 +00:00
David Cermak
0f51b5da67 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 09:51:47 +01:00
Frantisek Hrbata
99f9dd4c07 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:23:16 +01:00
Shang Zhou
c14d05ff61 docs: Update CN translation for api-guides/tools/idf-monitor.rst 2023-11-27 09:38:39 +01:00
Peter Dragun
c0e8969afa fix(tools/monitor): fix PRINT_FILTER env variable usage 2023-11-27 09:37:36 +01:00
Jiang Jiang Jian
3ba577165c Merge branch 'bugfix/esp32s3_usb_otg_console_v5.1' into 'release/v5.1'
system: support USB_OTG CDC console on ESP32-S3 (v5.1)

See merge request espressif/esp-idf!24337
2023-11-24 10:19:02 +08:00
Vikram Dattu
8857082585
refactor(esp_srp): Expose esp_srp.h and add API docs
- Also added missing `protocomm_security2` reference in `protocomm.rst`
2023-11-23 12:01:10 +05:30
Marius Vikhammer
0feef5f2f3 Merge branch 'backport/add_docs_for_coex_v51' into 'release/v5.1'
feat(docs) Add RF Coexist docs for H2(BackportV5.1)

See merge request espressif/esp-idf!27236
2023-11-23 13:57:42 +08:00
zwx
f710a49680 feat(docs) Add RF Coexist docs for H2 2023-11-22 17:04:55 +08:00
Shu Chen
ecbbd3c3d9 Merge branch 'backport/add_ot_radio_stats_enable_config_5_1' into 'release/v5.1'
feat(openthread): backport some openthread features(BackportV5.1)

See merge request espressif/esp-idf!26885
2023-11-22 12:23:53 +08:00
Ivan Grokhotkov
22dd730a7c
esp_rom: convert USB related headers to SPDX, update COPYRIGHTS.rst 2023-11-21 17:33:30 +01:00
Aditya Patwardhan
514cd783a3 Merge branch 'bugfix/esp32h2_ecdsa_hardware_k_v5.1' into 'release/v5.1'
fix(esp32h2): program use_hardware_k efuse bit for ECDSA key purpose (v5.1)

See merge request espressif/esp-idf!27271
2023-11-21 13:57:38 +08:00
Jiang Jiang Jian
d578395041 Merge branch 'bugfix/secure_boot_v2_docs_v5.1' into 'release/v5.1'
fix(docs): correct the target specific macros for secure boot v2 guide (v5.1)

See merge request espressif/esp-idf!27170
2023-11-21 11:10:41 +08:00
Jiang Jiang Jian
b3479b3164 Merge branch 'bugfix/docs_hw_breakpoints_num_v5.1' into 'release/v5.1'
fix(docs/jtag): Fix hard-coded HW breakpoints/watchpoints number (v5.1)

See merge request espressif/esp-idf!26500
2023-11-21 11:07:13 +08:00
morris
6bc8a025d5 Merge branch 'bugfix/ledc_max_duty_cycle_v5.1' into 'release/v5.1'
fix(ledc): fix ledc driver 100% duty cycle configuration (backport v5.1)

See merge request espressif/esp-idf!27179
2023-11-21 10:58:16 +08:00
Mahavir Jain
78453c8918
docs(ecdsa): add a note about TRNG dependency for ECDSA peripheral 2023-11-20 16:17:51 +05:30
Mahavir Jain
d9abb44049
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-20 16:13:35 +05:30
Harshit Malpani
7d6ef329d7
docs: Add documentation for using ECDSA peripheral with TLS 2023-11-17 16:25:58 +05:30
morris
1b3713f7cd Merge branch 'feature/support_adc_calibration_on_h2_v5.1' into 'release/v5.1'
adc_cali: supported adc calibration v1 on ESP32H2 (v5.1)

See merge request espressif/esp-idf!26963
2023-11-17 16:41:00 +08:00
morris
ddb6d22468 Merge branch 'feature/gpio_dump_io_info_v5.1' into 'release/v5.1'
feat(gpio): add a dump API to dump IO configurations (v5.1)

See merge request espressif/esp-idf!26870
2023-11-17 16:30:22 +08:00
morris
ceb0aec0cc Merge branch 'bugfix/rmt_stop_issue_v5.1' into 'release/v5.1'
fix(rmt): a disabled channel may pick up a pending transaction (v5.1)

See merge request espressif/esp-idf!26779
2023-11-17 16:27:21 +08:00
morris
a32f0cf11e Merge branch 'feature/mcpwm_trigger_driver_v5.1' into 'release/v5.1'
feature(MCPWM): Add MCPWM trigger driver (v5.1)

See merge request espressif/esp-idf!26787
2023-11-17 16:17:34 +08:00
Song Ruo Jing
03299962f6 fix(ledc): fix ledc driver 100% duty cycle configuration
Update ledc duty cycle value range in doxygen.
Fix duty configuration error at 100% duty cycle for ESP32.
Improve LEDC API doxygen.

Closes https://github.com/espressif/esp-idf/pull/11516
Closes https://github.com/espressif/esp-idf/issues/12593
Closes https://github.com/espressif/esp-idf/issues/12083
2023-11-17 12:38:32 +08:00
Roland Dobai
53aaf3462f Merge branch 'feature/add_qemu_to_tools-json_v5.1' into 'release/v5.1'
Add QEMU to tools.json (v5.1)

See merge request espressif/esp-idf!26407
2023-11-16 18:54:46 +08:00
Mahavir Jain
5f9f8ac068
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:37:59 +05:30
morris
bfeae3857c feat(rmt): support calling rmt_receive in ISR callback 2023-11-15 05:57:45 +00:00
morris
d260d43168 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-15 05:57:45 +00:00
Chen Jichang
0ce2683d81 feature(MCPWM): Add MCPWM trigger driver and test
Each MCPWM operator has two Trigger (named T0 and T1), and they can be
routed to GPIO fault signal or timer sync event.Generator can be set up
to perform different action on Trigger event.
This commit add a trigger driver and a test for the driver.
2023-11-15 05:57:37 +00:00
Marius Vikhammer
3d296723f3 Merge branch 'bugfix/fix_freertos_system_task_names_v5.1' into 'release/v5.1'
fix(freertos): Updated IDLE task names for each core to have the coreID as a suffix (v5.1)

See merge request espressif/esp-idf!26118
2023-11-14 16:35:25 +08:00
Jiang Jiang Jian
822aa69a4b Merge branch 'feature/support_esp32c2_rom_mbedtls_v5.1' into 'release/v5.1'
feat(mbedtls): support c2 mbedtls can use crypto algorithm in ROM (backport v5.1)

See merge request espressif/esp-idf!26698
2023-11-14 15:10:20 +08:00
morris
efafacae40 Merge branch 'feature/mcpwm_timer_change_freq_v5.1' into 'release/v5.1'
feat(mcpwm): support update timer period dynamically (v5.1)

See merge request espressif/esp-idf!26624
2023-11-13 17:55:52 +08:00