Method File Cleanup (#683)

src/internal/methods/Ws2801GenericMethod.h

@@ -0,0 +1,151 @@
+/*-------------------------------------------------------------------------
+NeoPixel library helper functions for WS2801
+
+Written by Michael C. Miller.
+
+I invest time and resources providing this open source code,
+please support me by dontating (see https://github.com/Makuna/NeoPixelBus)
+
+-------------------------------------------------------------------------
+This file is part of the Makuna/NeoPixelBus library.
+
+NeoPixelBus is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as
+published by the Free Software Foundation, either version 3 of
+the License, or (at your option) any later version.
+
+NeoPixelBus is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with NeoPixel.  If not, see
+<http://www.gnu.org/licenses/>.
+-------------------------------------------------------------------------*/
+
+#pragma once
+
+// must also check for arm due to Teensy incorrectly having ARDUINO_ARCH_AVR set
+#if defined(ARDUINO_ARCH_AVR) && !defined(__arm__)
+#include "TwoWireBitBangImpleAvr.h"
+#else
+#include "TwoWireBitBangImple.h"
+#endif
+
+
+template<typename T_TWOWIRE> class Ws2801MethodBase
+{
+public:
+    typedef typename T_TWOWIRE::SettingsObject SettingsObject;
+
+    Ws2801MethodBase(uint8_t pinClock, uint8_t pinData, uint16_t pixelCount, size_t elementSize, size_t settingsSize) :
+        _sizeData(pixelCount * elementSize + settingsSize),
+        _wire(pinClock, pinData)
+    {
+        _data = static_cast<uint8_t*>(malloc(_sizeData));
+        // data cleared later in Begin()
+    }
+
+#if !defined(__AVR_ATtiny85__) && !defined(ARDUINO_attiny)
+    Ws2801MethodBase(uint16_t pixelCount, size_t elementSize, size_t settingsSize) :
+        Ws2801MethodBase(SCK, MOSI, pixelCount, elementSize, settingsSize)
+    {
+    }
+#endif
+
+    ~Ws2801MethodBase()
+    {
+        free(_data);
+    }
+
+    bool IsReadyToUpdate() const
+    {
+        uint32_t delta = micros() - _endTime;
+
+        return (delta >= 500);
+    }
+
+#if defined(ARDUINO_ARCH_ESP32)
+    void Initialize(int8_t sck, int8_t miso, int8_t mosi, int8_t ss)
+    {
+        _wire.begin(sck, miso, mosi, ss);
+
+        _endTime = micros();
+    }
+#endif
+
+    void Initialize()
+    {
+        _wire.begin();
+
+        _endTime = micros();
+    }
+
+    void Update(bool)
+    {
+        while (!IsReadyToUpdate())
+        {
+#if !defined(ARDUINO_TEEONARDU_LEO) && !defined(ARDUINO_TEEONARDU_FLORA)
+            yield(); // allows for system yield if needed
+#endif
+        }
+
+        _wire.beginTransaction();
+        
+        // data
+        _wire.transmitBytes(_data, _sizeData);
+        
+        _wire.endTransaction();
+
+        // save EOD time for latch on next call
+        _endTime = micros();
+    }
+
+    bool AlwaysUpdate()
+    {
+        // this method requires update to be called only if changes to buffer
+        return false;
+    }
+
+    uint8_t* getData() const
+    {
+        return _data;
+    };
+
+    size_t getDataSize() const
+    {
+        return _sizeData;
+    };
+
+    void applySettings([[maybe_unused]] const SettingsObject& settings)
+    {
+        _wire.applySettings(settings);
+    }
+
+private:
+    const size_t  _sizeData;   // Size of '_data' buffer below
+
+    uint32_t _endTime;       // Latch timing reference
+    T_TWOWIRE _wire;
+    uint8_t* _data;       // Holds LED color values
+};
+
+typedef Ws2801MethodBase<TwoWireBitBangImple> Ws2801Method;
+
+#if !defined(__AVR_ATtiny85__) && !defined(ARDUINO_attiny)
+#include "TwoWireSpiImple.h"
+typedef Ws2801MethodBase<TwoWireSpiImple<SpiSpeed20Mhz>> Ws2801Spi20MhzMethod;
+typedef Ws2801MethodBase<TwoWireSpiImple<SpiSpeed10Mhz>> Ws2801Spi10MhzMethod;
+typedef Ws2801MethodBase<TwoWireSpiImple<SpiSpeed5Mhz>> Ws2801Spi5MhzMethod;
+typedef Ws2801MethodBase<TwoWireSpiImple<SpiSpeed2Mhz>> Ws2801Spi2MhzMethod;
+typedef Ws2801MethodBase<TwoWireSpiImple<SpiSpeed1Mhz>> Ws2801Spi1MhzMethod;
+typedef Ws2801MethodBase<TwoWireSpiImple<SpiSpeed500Khz>> Ws2801Spi500KhzMethod;
+
+typedef Ws2801MethodBase<TwoWireSpiImple<SpiSpeedHz>> Ws2801SpiHzMethod;
+
+typedef Ws2801Spi10MhzMethod Ws2801SpiMethod;
+#endif
+
+
+