]> granicus.if.org Git - esp-idf/commit
bugfix(i2c): add I2C hardware reset if the hw FSM get stuck
authorWangjialin <wangjialin@espressif.com>
Fri, 15 Sep 2017 11:18:50 +0000 (19:18 +0800)
committerWangjialin <wangjialin@espressif.com>
Fri, 20 Oct 2017 18:10:59 +0000 (02:10 +0800)
commited1e32f583980d2fefcd47690b77d5b0e1896667
treed79c5d18d58e0a49a151e3078a6b760986cdfca0
parent22756b6c023adb87705f18b049786a523c6622e8
bugfix(i2c): add I2C hardware reset if the hw FSM get stuck

Reported from different sources from github or bbs:

https://github.com/espressif/esp-idf/issues/680

https://github.com/espressif/esp-idf/issues/922

We tested reading several sensor or other I2C slave devices, if the power and SDA/SCL wires are in proper condition, everything works find with reading the slave.
If we remove the power supply for the slave during I2C is reading, or directly connect SDA or SCL to ground, this would  cause the I2C FSM get stuck in wrong state, all we can do is the reset the I2C hardware in this case.
After this commit, no matter whether the power supply of I2C slave is removed or SDA / SCL are shorted to ground, the driver can recover from wrong state.

We are not sure whether this the save issue with the reported one yet, but to make the driver more robust.

Further information:

1. For I2C master mode, we have tested different situations, e.g., to short the SDA/SCL directly to GND/VCC, to short the SDA to SCL, to un-plug the slave device, to power off the slave device. Under all of those situations, this version of driver can recover and keep working.
2. Some slave device will die by accident and keep the SDA in low level, in this case, master should send several clock to make the slave release the bus.
3. Slave mode of ESP32 might also get in wrong state that held the SDA low, in this case, master device could send a stop signal to make esp32 slave release the bus.

Modifications:

1. Disable I2C_MASTER_TRAN_COMP interrupt to void extra interrupt.
2. Disable un-used timeout interrupt for slave.
3. Add bus reset if error detected for master mode.
4. Add bus clear if SDA level is low when error detected.
5. Modify the argument type of i2c_set_pin.
6. add API to set timeout value
7. add parameter check for timing APIs
components/driver/i2c.c
components/driver/include/driver/i2c.h
examples/peripherals/i2c/main/i2c_example_main.c