mirror
/
esp-idf
kopia lustrzana https://github.com/espressif/esp-idf
1
0
Forkuj 0
Kod Zgłoszenia Projekty Wydania Wiki Aktywność

driver/i2c: add notes to i2c deleteing function

pull/7130/head
laokaiyao 2021-05-07 18:03:10 +08:00
rodzic 33e8d1e0b0
commit b807f2a666
2 zmienionych plików z 4 dodań i 0 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

3
components/driver/include/driver/i2c.h
Wyświetl plik

@ -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 * @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 * @param i2c_num I2C port number
* *
* @return * @return

1
docs/en/api-reference/peripherals/i2c.rst
Wyświetl plik

@ -351,6 +351,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`. 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 Application Example
------------------- -------------------