SPISoft.h

Go to the documentation of this file.

/****
 * Sming Framework Project - Open Source framework for high efficiency native ESP8266 development.
 * Created 2015 by Skurydin Alexey
 * http://github.com/SmingHub/Sming
 * All files of the Sming Core are provided under the LGPL v3 license.
 *
 * SPISoft.h
 *
 * Author: ADiea
 * Project: Sming for ESP8266
 * License: MIT
 * Date: 15.07.2015
 * Descr: Implement software SPI for HW configs other than hardware SPI pins(GPIO 12,13,14)
 * 
 * @author mikee47 January 2022
 *
 * Rewritten to implement bit ordering, modes, delays and transactions.
 *
 ****/

#pragma once

#include "SPIBase.h"

class SPISoft : public SPIBase
{
public:
    SPISoft();

    SPISoft(uint8_t miso, uint8_t mosi, uint8_t sck, uint8_t delay = 0) : SPISoft({sck, miso, mosi}, delay)
    {
    }

    SPISoft(const SpiPins& pins, uint8_t delay = 0) : SPIBase(pins), m_delay(delay)
    {
    }

    SPISoft(uint8_t delay);

    bool setup(SpiPins pins)
    {
        this->mPins = pins;
        return true;
    }

    bool begin() override;

    void end() override
    {
    }

    void endTransaction() override;

    using SPIBase::transfer;
    uint32_t transfer32(uint32_t val, uint8_t bits = 32) override;
    void transfer(uint8_t* buffer, size_t size) override;

    void setDelay(uint8_t delay)
    {
        m_delay = delay;
    }

    bool loopback(bool enable) override
    {
        (void)enable;
        return false;
    }

protected:
    void prepare(SPISettings& settings) override;

private:
    uint8_t transferByteLSB(uint8_t word);
    uint8_t transferByteMSB(uint8_t word);
    uint32_t transferWordLSB(uint32_t word, uint8_t bits);
    uint32_t transferWordMSB(uint32_t word, uint8_t bits);

    uint8_t m_delay{0};
    SpiMode dataMode{SPI_MODE0};
    uint8_t cpol{0};
    uint8_t cksample{0};
    bool lsbFirst{false};
};