Merge branch 'docs/i2c_thread_safety' into 'master'

docs: Fix I2C thread-safety

Closes IDF-5034

See merge request espressif/esp-idf!18172
pull/9068/head
Tomas Rezucha 2022-05-27 08:24:13 +08:00
commit 3b7018923e
1 zmienionych plików z 1 dodań i 2 usunięć

Wyświetl plik

@ -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.
* 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