Modify the I2S config naming scheme

Author: JosipKuci

src/boards/Inkplate5V2/Inkplate5V2Driver.h

@@ -30,13 +30,13 @@
 
 #include "../../system/defines.h"
 
-#include "../../system/esp32/Esp.h"
+#include "../../system/UtilI2S/UtilI2S.h"
 
 
 class Inkplate;
 
 
-class EPDDriver : public Esp
+class EPDDriver : public UtilI2S
 {
   public:
     void writePixelInternal(int16_t x, int16_t y, uint16_t color);

src/boards/Inkplate6/Inkplate6Driver.h

@@ -30,13 +30,13 @@
 
 #include "../../system/defines.h"
 
-#include "../../system/esp32/Esp.h"
+#include "../../system/UtilI2S/UtilI2S.h"
 
 
 class Inkplate;
 
 
-class EPDDriver : public Esp
+class EPDDriver : public UtilI2S
 {
   public:
     void writePixelInternal(int16_t x, int16_t y, uint16_t color);

src/boards/Inkplate6FLICK/Inkplate6FLICKDriver.h

@@ -30,13 +30,13 @@
 
 #include "../../system/defines.h"
 
-#include "../../system/esp32/Esp.h"
+#include "../../system/UtilI2S/UtilI2S.h"
 
 
 class Inkplate;
 
 
-class EPDDriver : public Esp
+class EPDDriver : public UtilI2S
 {
   public:
     void writePixelInternal(int16_t x, int16_t y, uint16_t color);

src/system/esp32/Esp.cpp src/system/UtilI2S/UtilI2S.cppsrc/system/esp32/Esp.cpp renamed to src/system/UtilI2S/UtilI2S.cpp

@@ -1,7 +1,7 @@
 /**
  **************************************************
- * @file        Esp.cpp
- * @brief       File for ESP, currently empty
+ * @file        UtilI2S.cpp
+ * @brief       File for utilizing the I2S peripheral to send data to the panel.
  *
  *              https://github.com/e-radionicacom/Inkplate-Arduino-library
  *              For support, please reach over forums: forum.e-radionica.com/en
@@ -16,7 +16,7 @@
  * @authors     Soldered
  ***************************************************/
 
-#include "Esp.h"
+#include "UtilI2S.h"
 #include "../../boardSelect.h"
 #ifdef USES_I2S
 /**
@@ -25,9 +25,9 @@
  * @param       i2s_dev_t *_i2sDev
  *              Pointer of the selected I2S driver
  *
- * @note        Function must be declared static to fit into Instruction RAM of the ESP32.
+ * @note        Function must be declared IRAM_ATTR to fit into Instruction RAM of the ESP32.
  */
-void IRAM_ATTR I2SInit(i2s_dev_t *_i2sDev, uint8_t _clockDivider)
+void IRAM_ATTR UtilI2S::I2SInit(i2s_dev_t *_i2sDev, uint8_t _clockDivider)
 {
     // Enable I2S peripheral and reset it.
     periph_module_enable(PERIPH_I2S1_MODULE);
@@ -104,10 +104,10 @@ void IRAM_ATTR I2SInit(i2s_dev_t *_i2sDev, uint8_t _clockDivider)
  *              lldesc_s *_dmaDecs
  *              Pointer to the DMA descriptor.
  *
- * @note        Function must be declared static to fit into Instruction RAM of the ESP32. Also, DMA descriptor must be
+ * @note        Function must be declared IRAM_ATTR to fit into Instruction RAM of the ESP32. Also, DMA descriptor must be
  * already configured!
  */
-void IRAM_ATTR sendDataI2S(i2s_dev_t *_i2sDev, volatile lldesc_s *_dmaDecs)
+void IRAM_ATTR UtilI2S::sendDataI2S(i2s_dev_t *_i2sDev, volatile lldesc_s *_dmaDecs)
 {
     // Stop any on-going transmission (just in case).
     _i2sDev->out_link.stop = 1;
@@ -153,7 +153,7 @@ void IRAM_ATTR sendDataI2S(i2s_dev_t *_i2sDev, volatile lldesc_s *_dmaDecs)
     _i2sDev->out_link.start = 0;
 }
 
-void IRAM_ATTR setI2S1pin(uint32_t _pin, uint32_t _function, uint32_t _inv)
+void IRAM_ATTR UtilI2S::setI2S1pin(uint32_t _pin, uint32_t _function, uint32_t _inv)
 {
     // Check if valid pin is selected
     if (_pin > 39)

src/system/esp32/Esp.h src/system/UtilI2S/UtilI2S.hsrc/system/esp32/Esp.h renamed to src/system/UtilI2S/UtilI2S.h

@@ -16,8 +16,8 @@
  * @authors     Soldered
  ***************************************************/
 
-#ifndef __ESP_H__
-#define __ESP_H__
+#ifndef __UTILI2S_H__
+#define __UTILI2S_H__
 
 #include "Arduino.h"
 #include "driver/periph_ctrl.h"
@@ -29,16 +29,15 @@
 #include "soc/rtc.h"
 #include "soc/soc.h"
 
-void IRAM_ATTR I2SInit(volatile i2s_dev_t *_i2sDev, uint8_t _clockDivider = 5);
-void IRAM_ATTR sendDataI2S(volatile i2s_dev_t *_i2sDev, volatile lldesc_s *_dmaDecs);
-void IRAM_ATTR setI2S1pin(uint32_t _pin, uint32_t _function, uint32_t _inv);
-
 /**
- * @brief       Esp class
+ * @brief       I2S class used to send data to the panel.
  */
-class Esp
+class UtilI2S
 {
   public:
+    void IRAM_ATTR I2SInit(volatile i2s_dev_t *_i2sDev, uint8_t _clockDivider = 5);
+    void IRAM_ATTR sendDataI2S(volatile i2s_dev_t *_i2sDev, volatile lldesc_s *_dmaDecs);
+    void IRAM_ATTR setI2S1pin(uint32_t _pin, uint32_t _function, uint32_t _inv);
   protected:
     volatile uint8_t *_dmaLineBuffer;
     volatile lldesc_s *_dmaI2SDesc;