feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

docs: Fix I2C thread-safety

Browse Source
This commit is contained in:
Tomas Rezucha
2022-05-19 12:49:33 +02:00
committed by BOT
parent 7642be45ef
commit b6771b7f83
1 changed files with 1 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -404,8 +404,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. * @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 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, * The I2C port is protected by mutex, so this function is thread-safe.
* you need to take care of the multi-thread issue.
* This function shall only be called in I2C master mode. * This function shall only be called in I2C master mode.
* *
* @param i2c_num I2C port number * @param i2c_num I2C port number