Naming conflics with ESP32

Author: pschatzmann

src/Common.h

@@ -69,15 +69,15 @@ typedef enum {
 } output_device_t;
 
 /**
- * @enum i2s_mode_t
+ * @enum i2s_master_slave_t
  * @brief Select I2S interface operating mode i.e. master or slave for audio
  * codec chip
  * @ingroup enumerations
  */
 typedef enum {
   MODE_SLAVE = 0x00,  /*!< set slave mode */
   MODE_MASTER = 0x01, /*!< set master mode */
-} i2s_mode_t;
+} i2s_master_slave_t;
 
 /**
  * @enum samplerate_t
@@ -164,7 +164,7 @@ typedef enum {
  */
 typedef struct {
   /*!< Audio codec chip mode: if the microcontroller is master the codec must be slave! */
-  i2s_mode_t mode;
+  i2s_master_slave_t mode;
   /*!< I2S interface format */
   i2s_format_t fmt;
   /*!< I2S sample rate in samples per second */

src/Driver.h

@@ -189,7 +189,7 @@ class AudioDriver {
 
   /// Sets the PA Power pin to active or inactive
   bool setPAPower(bool enable) {
-    Pin pin = pins().getPinID(PinFunction::PA);
+    GpioPin  pin = pins().getPinID(PinFunction::PA);
     if (pin == -1)
       return false;
     AD_LOGI("setPAPower pin %d -> %d", pin, enable);

src/DriverPins.h

@@ -10,7 +10,7 @@ namespace audio_driver {
 
 /** @file */
 
-using Pin = int16_t;
+using GpioPin = int16_t;
 
 /**
  * @enum PinLogic
@@ -49,8 +49,8 @@ enum class PinFunction {
  */
 struct PinsI2S {
   PinsI2S() = default;
-  PinsI2S(PinFunction function, Pin mclk, Pin bck, Pin ws, Pin data_out,
-          Pin data_in = -1, int port = 0) {
+  PinsI2S(PinFunction function, GpioPin mclk, GpioPin bck, GpioPin ws, GpioPin data_out,
+          GpioPin data_in = -1, int port = 0) {
     this->function = function;
     this->mclk = mclk;
     this->bck = bck;
@@ -60,11 +60,11 @@ struct PinsI2S {
     this->port = port;
   }
   PinFunction function;
-  Pin mclk;
-  Pin bck;
-  Pin ws;
-  Pin data_out;
-  Pin data_in;
+  GpioPin mclk;
+  GpioPin bck;
+  GpioPin ws;
+  GpioPin data_out;
+  GpioPin data_in;
   int port; // port number
 };
 
@@ -75,7 +75,7 @@ struct PinsI2S {
  */
 struct PinsSPI {
   PinsSPI() = default;
-  PinsSPI(PinFunction function, Pin clk, Pin miso, Pin mosi, Pin cs,
+  PinsSPI(PinFunction function, GpioPin clk, GpioPin miso, GpioPin mosi, GpioPin cs,
           SPIClass &spi = SPI) {
     this->function = function;
     this->clk = clk;
@@ -87,10 +87,10 @@ struct PinsSPI {
 
   PinFunction function;
   SPIClass *p_spi = &SPI;
-  Pin clk = -1;
-  Pin miso = -1;
-  Pin mosi = -1;
-  Pin cs = -1;
+  GpioPin clk = -1;
+  GpioPin miso = -1;
+  GpioPin mosi = -1;
+  GpioPin cs = -1;
   bool set_active = true;
   bool pinsAvailable() { return clk != -1 && miso != -1 && mosi != -1; }
   operator bool() { return pinsAvailable(); }
@@ -142,7 +142,7 @@ PinsSPI ESP32PinsSD{PinFunction::SD, 14, 2, 15, 13, SPI};
  */
 struct PinsI2C {
   PinsI2C() = default;
-  PinsI2C(PinFunction function, Pin scl, Pin sda, int port = -1,
+  PinsI2C(PinFunction function, GpioPin scl, GpioPin sda, int port = -1,
           uint32_t frequency = 100000, TwoWire &wire = Wire) {
     this->function = function;
     this->scl = scl;
@@ -155,8 +155,8 @@ struct PinsI2C {
   PinFunction function;
   uint32_t frequency = 100000;
   int port = -1;
-  Pin scl = -1;
-  Pin sda = -1;
+  GpioPin scl = -1;
+  GpioPin sda = -1;
   bool set_active = true;
   TwoWire *p_wire;
   bool pinsAvailable() { return scl != -1 && sda != -1 && frequency != 0; }
@@ -198,7 +198,7 @@ struct PinsI2C {
  */
 struct PinsFunction {
   PinsFunction() = default;
-  PinsFunction(PinFunction function, Pin pin, PinLogic logic,
+  PinsFunction(PinFunction function, GpioPin pin, PinLogic logic,
                int index = 0) {
     this->function = function;
     this->pin = pin;
@@ -220,28 +220,28 @@ struct PinsFunction {
 class DriverPins {
 public:
   void addI2S(PinsI2S pin) { i2s.push_back(pin); }
-  void addI2S(PinFunction function, Pin mclk, Pin bck, Pin ws, Pin data_out,
-              Pin data_in = -1, int port = 0) {
+  void addI2S(PinFunction function, GpioPin mclk, GpioPin bck, GpioPin ws, GpioPin data_out,
+              GpioPin data_in = -1, int port = 0) {
     PinsI2S pin{function, mclk, bck, ws, data_out, data_in, port};
     addI2S(pin);
   }
   void addSPI(PinsSPI pin) { spi.push_back(pin); }
-  void addSPI(PinFunction function, Pin clk, Pin miso, Pin mosi, Pin cs,
+  void addSPI(PinFunction function, GpioPin clk, GpioPin miso, GpioPin mosi, GpioPin cs,
               SPIClass &spi = SPI) {
     PinsSPI pin(function, clk, miso, mosi, cs, spi);
     addSPI(pin);
   }
 
   void addI2C(PinsI2C pin) { i2c.push_back(pin); }
-  void addI2C(PinFunction function, Pin scl, Pin sda, int port = -1,
+  void addI2C(PinFunction function, GpioPin scl, GpioPin sda, int port = -1,
               uint32_t frequency = 100000, TwoWire &wire = Wire) {
     PinsI2C pin(function, scl, sda, port, frequency);
     addI2C(pin);
   }
 
   void addPin(PinsFunction pin) { pins.push_back(pin); }
 
-  void addPin(PinFunction function, Pin pinNo, PinLogic logic,
+  void addPin(PinFunction function, GpioPin pinNo, PinLogic logic,
               int index = 0) {
     PinsFunction pin(function, pinNo, logic, index);
     addPin(pin);
@@ -256,15 +256,15 @@ class DriverPins {
   }
 
   /// Get pin information by pin ID
-  Optional<PinsFunction> getPin(Pin pinId) {
+  Optional<PinsFunction> getPin(GpioPin pinId) {
     for (PinsFunction &pin : pins) {
       if (pin.pin == pinId)
         return pin;
     }
     return {};
   }
 
-  Pin getPinID(PinFunction function, int pos = 0) {
+  GpioPin getPinID(PinFunction function, int pos = 0) {
     auto pin = getPin(function, pos);
     if (pin)
       return pin.value().pin;
@@ -354,13 +354,21 @@ class DriverPins {
     }
   }
 
+  /// Defines if SPI for SD should be started (by default true)
   void setSPIActiveForSD(bool active){
     sd_active = active;
   }
+
+  /// Check if SPI for SD should be started automatically
   bool isSPIActiveForSD(){
     return sd_active;
   }
 
+  /// Returns true if some function pins have been defined
+  bool hasPins(){
+    return !pins.empty();
+  }
+
 protected:
   Vector<PinsI2S> i2s{0};
   Vector<PinsSPI> spi{0};