alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'docs/i2c_thread_safety_backport_v4.4' into 'release/v4.4'

Browse Source 
docs: Fix I2C thread-safety (backport v4.4)

See merge request espressif/esp-idf!18186
This commit is contained in:
morris 2022-06-14 18:45:07 +08:00
commit 2b001daa78
1 changed files with 1 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
components/driver/include/driver/i2c.h
View File

@ -429,8 +429,7 @@ esp_err_t i2c_master_stop(i2c_cmd_handle_t cmd_handle);
/**
* @brief Send all the queued commands on the I2C bus, in master mode.
* The task will be blocked until all the commands have been sent out.
* The I2C APIs are not thread-safe, if you want to use one I2C port in different tasks,
* you need to take care of the multi-thread issue.
* The I2C port is protected by mutex, so this function is thread-safe.
* This function shall only be called in I2C master mode.
*
* @param i2c_num I2C port number