espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-07-31 19:24:33 +02:00
Code Issues Packages Projects Releases Wiki Activity

driver/i2c: add notes to i2c deleteing function v4.3

Browse Source
This commit is contained in:
laokaiyao
2021-05-07 18:08:54 +08:00
committed by bot
parent b6826d8878
commit 5f184c6556
2 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -67,6 +67,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

1
docs/en/api-reference/peripherals/i2c.rst
View File

@@ -358,6 +358,7 @@ Delete Driver
When the I2C communication is established with the function :cpp:func:`i2c_driver_install` and is not required for some substantial amount of time, the driver may be deinitialized to release allocated resources by calling :cpp:func:`i2c_driver_delete`.
Before calling :cpp:func:`i2c_driver_delete` to remove i2c driver, please make sure that all threads have stopped using the driver in any way, because this function does not guarantee thread safety.
Application Example
-------------------