Memory Leak, Reset() cleanup, add UserSelectable Timeout

Calling Wire.reset() would cause a heap memory leak, also, possible
failure because I did not release the ISR.  And not releasing the
EventGroup
Added a Wire.setTimeout(millis) to allow user selectable Gross Timeout
instead of the hardwired 50ms.

Author: Chuck Todd

cores/esp32/esp32-hal-i2c.c

@@ -906,7 +906,7 @@ for(uint32_t a=1;a<=INTBUFFMAX;a++){
   }
 }
 
-i2c_err_t i2cProcQueue(i2c_t * i2c, uint32_t *readCount){
+i2c_err_t i2cProcQueue(i2c_t * i2c, uint32_t *readCount, uint16_t timeOutMillis){
 /* do the hard stuff here
   install ISR if necessary
   setup EventGroup
@@ -1028,9 +1028,9 @@ if(!i2c->intr_handle){ // create ISR I2C_0 only,
 //hang until it completes.
 
 // how many ticks should it take to transfer totalBytes thru the I2C hardware,
-// add 50ms just for kicks
+// add user supplied timeOutMillis to Calc Value
 
-portTickType ticksTimeOut = ((totalBytes /(i2cGetFrequency(i2c)/(10*1000)))+50)/portTICK_PERIOD_MS;
+portTickType ticksTimeOut = ((totalBytes /(i2cGetFrequency(i2c)/(10*1000)))+timeOutMillis)/portTICK_PERIOD_MS;
 portTickType tBefore=xTaskGetTickCount();  
 
 //log_e("before startup @tick=%d will wait=%d",xTaskGetTickCount(),ticksTimeOut);
@@ -1052,7 +1052,7 @@ if(i2c->exitCode!=eBits){ // try to recover from O/S failure
   eBits=i2c->exitCode;
   }
 
-if(!(eBits==EVENT_DONE)&&(eBits&~(EVENT_ERROR_NAK|EVENT_ERROR|EVENT_DONE))){ // not only Done, therefore error, exclude ADDR NAK
+if(!(eBits==EVENT_DONE)&&(eBits&~(EVENT_ERROR_NAK|EVENT_ERROR_DATA_NAK|EVENT_ERROR|EVENT_DONE))){ // not only Done, therefore error, exclude ADDR NAK, DATA_NAK
   dumpI2c(i2c);
   i2cDumpInts();
   }
@@ -1087,7 +1087,7 @@ else { // GROSS timeout, shutdown ISR , report Timeout
   i2c->dev->int_clr.val = 0x1FFF;
   reason = I2C_ERROR_TIMEOUT;
   eBits = eBits | EVENT_ERROR_TIMEOUT|EVENT_ERROR|EVENT_DONE;
-  log_e(" Gross Timeout Dead st=%d, ed=%d, =%d, max=%d error=%d",tBefore,tAfter,(tAfter-tBefore),ticksTimeOut,i2c->error);
+  log_e(" Gross Timeout Dead st=0x%x, ed=0x%x, =%d, max=%d error=%d",tBefore,tAfter,(tAfter-tBefore),ticksTimeOut,i2c->error);
   dumpI2c(i2c);
   i2cDumpInts();
   }
@@ -1130,7 +1130,11 @@ if(i2c->intr_handle){
 //  log_e("released ISR=%d",error);
   i2c->intr_handle=NULL;
   }
-return I2C_ERROR_OK;
+if(i2c->i2c_event){
+  vEventGroupDelete(i2c->i2c_event);
+  i2c->i2c_event = NULL;
+  }
+return i2cFreeQueue(i2c);
 }
 
 /* todo

cores/esp32/esp32-hal-i2c.h

@@ -162,7 +162,7 @@ i2c_err_t i2cAttachSDA(i2c_t * i2c, int8_t sda);
 i2c_err_t i2cDetachSDA(i2c_t * i2c, int8_t sda);
 
 //Stickbreakers ISR Support
-i2c_err_t i2cProcQueue(i2c_t *i2c, uint32_t *readCount);
+i2c_err_t i2cProcQueue(i2c_t *i2c, uint32_t *readCount, uint16_t timeOutMillis);
 i2c_err_t i2cAddQueueWrite(i2c_t *i2c, uint16_t i2cDeviceAddr, uint8_t *dataPtr, uint16_t dataLen, bool SendStop, EventGroupHandle_t event);
 i2c_err_t i2cAddQueueRead(i2c_t *i2c, uint16_t i2cDeviceAddr, uint8_t *dataPtr, uint16_t dataLen, bool SendStop, EventGroupHandle_t event);
 i2c_err_t i2cFreeQueue(i2c_t *i2c);

libraries/Wire/src/Wire.cpp

@@ -69,6 +69,7 @@ TwoWire::TwoWire(uint8_t bus_num)
     ,transmitting(0)
     ,txQueued(0)
     ,rxQueued(0)
+    ,_timeOutMillis(50)
 		{}	
 /* slave Mode, no yet Stickbreaker
 void TwoWire::onRequestService(void){}
@@ -124,6 +125,14 @@ void TwoWire::begin(int sdaPin, int sclPin, uint32_t frequency)
     i2cInitFix(i2c);
 }
 
+void TwoWire::setTimeOut(uint16_t timeOutMillis){
+  _timeOutMillis = timeOutMillis;
+}
+  
+uint16_t TwoWire::getTimeOut(){
+  return _timeOutMillis;
+}
+
 void TwoWire::setClock(uint32_t frequency)
 {
     i2cSetFrequency(i2c, frequency);
@@ -146,7 +155,7 @@ size_t TwoWire::requestFrom(uint8_t address, size_t size, bool sendStop)
 /*@StickBreaker common handler for processing the queued commands
 */
 i2c_err_t TwoWire::processQueue(uint32_t * readCount){
-   last_error=i2cProcQueue(i2c,readCount);
+   last_error=i2cProcQueue(i2c,readCount,_timeOutMillis);
    rxIndex = 0;
    rxLength = rxQueued;
    rxQueued = 0;
@@ -484,6 +493,7 @@ void TwoWire::flush(void)
 
 void TwoWire::reset(void)
 {
+    i2cReleaseISR(i2c); // remove ISR from Interrupt chain,Delete EventGroup,Free Heap memory
     i2cReset( i2c );
     i2c = NULL;
     begin( sda, scl );

libraries/Wire/src/Wire.h

@@ -62,6 +62,7 @@ class TwoWire: public Stream
 */
 		i2c_err_t last_error; // @stickBreaker from esp32-hal-i2c.h
     i2c_err_t processQueue(uint32_t *readCount);
+    uint16_t _timeOutMillis;
 
 public:
     TwoWire(uint8_t bus_num);
@@ -81,6 +82,8 @@ class TwoWire: public Stream
     char * getErrorText(uint8_t err);
     void dumpInts();
     size_t getClock();
+    void setTimeOut(uint16_t timeOutMillis);
+    uint16_t getTimeOut();
 //		
     uint8_t requestFrom(uint8_t, uint8_t);
     uint8_t requestFrom(uint8_t, uint8_t, uint8_t);