driver/i2c: add notes to i2c deleteing function

2021-05-07 18:03:10 +08:00
parent 33e8d1e0b0
commit b807f2a666
2 changed files with 4 additions and 0 deletions
--- a/components/driver/include/driver/i2c.h
+++ b/components/driver/include/driver/i2c.h
@@ -97,6 +97,9 @@ esp_err_t i2c_driver_install(i2c_port_t i2c_num, i2c_mode_t mode, size_t slv_rx_
 /**
 * @brief I2C driver delete
 *
+ * @note This function does not guarantee thread safety.
+ *       Please make sure that no thread will continuously hold semaphores before calling the delete function.
+ *
 * @param i2c_num I2C port number
 *
 * @return