fixing beginTransaction() by protecting _freq and _div by additional mutex

Author: smarq8

cores/esp32/esp32-hal-spi.c

@@ -1002,23 +1002,13 @@ void spiTransferBits(spi_t * spi, uint32_t data, uint32_t * out, uint8_t bits)
 #define MSB_24_SET(var, val) { uint8_t * d = (uint8_t *)&(val); (var) = d[2] | (d[1] << 8) | (d[0] << 16); }
 #define MSB_16_SET(var, val) { (var) = (((val) & 0xFF00) >> 8) | (((val) & 0xFF) << 8); }
 #define MSB_PIX_SET(var, val) { uint8_t * d = (uint8_t *)&(val); (var) = d[1] | (d[0] << 8) | (d[3] << 16) | (d[2] << 24); }
-void spiLock(spi_t * spi){
-    if(!spi) {
-        return;
-    }
-    SPI_MUTEX_LOCK();
-}
-void spiUnlock(spi_t * spi){
-    if(!spi) {
-        return;
-    }
-    SPI_MUTEX_UNLOCK();
-}
+
 void spiTransaction(spi_t * spi, uint32_t clockDiv, uint8_t dataMode, uint8_t bitOrder)
 {
     if(!spi) {
         return;
     }
+	SPI_MUTEX_LOCK();
     spi->dev->clock.val = clockDiv;
     switch (dataMode) {
     case SPI_MODE1:
@@ -1069,6 +1059,7 @@ void spiSimpleTransaction(spi_t * spi)
     if(!spi) {
         return;
     }
+	SPI_MUTEX_UNLOCK();
 }
 
 void spiEndTransaction(spi_t * spi)

cores/esp32/esp32-hal-spi.h

@@ -1,4 +1,4 @@
-// Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD
+SPI_MUTEX_LOCK();// Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -119,8 +119,6 @@ void spiTransferBits(spi_t * spi, uint32_t data, uint32_t * out, uint8_t bits);
 /*
  * New (EXPERIMENTAL) Transaction lock based API (lock once until endTransaction)
  * */
-void spiLock(spi_t * spi);
-void spiUnlock(spi_t * spi);
 void spiTransaction(spi_t * spi, uint32_t clockDiv, uint8_t dataMode, uint8_t bitOrder);
 void spiSimpleTransaction(spi_t * spi);
 void spiEndTransaction(spi_t * spi);

libraries/SPI/src/SPI.cpp

@@ -106,19 +106,23 @@ void SPIClass::setHwCs(bool use)
 
 void SPIClass::setFrequency(uint32_t freq)
 {
-    //check if last freq changed
+    SPI_PARAM_LOCK();
+	//check if last freq changed
     uint32_t cdiv = spiGetClockDiv(_spi);
     if(_freq != freq || _div != cdiv) {
         _freq = freq;
         _div = spiFrequencyToClockDiv(_freq);
         spiSetClockDiv(_spi, _div);
     }
+	SPI_PARAM_UNLOCK();
 }
 
 void SPIClass::setClockDivider(uint32_t clockDiv)
 {
-    _div = clockDiv;
+    SPI_PARAM_LOCK();
+	_div = clockDiv;
     spiSetClockDiv(_spi, _div);
+	SPI_PARAM_UNLOCK();
 }
 
 uint32_t SPIClass::getClockDivider()
@@ -138,23 +142,23 @@ void SPIClass::setBitOrder(uint8_t bitOrder)
 
 void SPIClass::beginTransaction(SPISettings settings)
 {
-    spiLock(_spi);
-    //check if last freq changed
+    SPI_PARAM_LOCK();
+	//check if last freq changed
     uint32_t cdiv = spiGetClockDiv(_spi);
     if(_freq != settings._clock || _div != cdiv) {
         _freq = settings._clock;
         _div = spiFrequencyToClockDiv(_freq);
     }
     spiTransaction(_spi, _div, settings._dataMode, settings._bitOrder);
     _inTransaction = true;
+    SPI_PARAM_UNLOCK();
 }
 
 void SPIClass::endTransaction()
 {
     if(_inTransaction){
         _inTransaction = false;
         spiEndTransaction(_spi);
-	spiUnlock(_spi);
     }
 }
 

libraries/SPI/src/SPI.h

@@ -25,6 +25,10 @@
 #include "pins_arduino.h"
 #include "esp32-hal-spi.h"
 
+#if !CONFIG_DISABLE_HAL_LOCKS
+#include "FreeRTOS.h"
+#endif
+
 #define SPI_HAS_TRANSACTION
 
 class SPISettings
@@ -49,6 +53,9 @@ class SPIClass
     int8_t _ss;
     uint32_t _div;
     uint32_t _freq;
+	#if !CONFIG_DISABLE_HAL_LOCKS
+    xSemaphoreHandle paramLock=NULL;
+    #endif
     bool _inTransaction;
     void writePattern_(const uint8_t * data, uint8_t size, uint8_t repeat);