spimasterhardware.h

Go to the documentation of this file.

 
#ifndef SEMF_COMMUNICATION_SPIMASTERHARDWARE_H_
#define SEMF_COMMUNICATION_SPIMASTERHARDWARE_H_
 
#include <semf/communication/communicationhardwaresynchronousmaster.h>
#include <semf/communication/spi.h>
 
namespace semf
{
class SpiMasterHardware : public Spi, public CommunicationHardwareSynchronousMaster
{
public:
    enum class ErrorCode : uint8_t
    {
        Write_IsBusy = 0,
        Write_DataIsNullptr,
        Write_DataSizeIsZero,
        Read_IsBusy,
        Read_BufferIsNullptr,
        Read_BufferSizeIsZero,
        SetFormat_IsBusy,
        StopWrite_IsReadOnly,
        StopRead_IsWriteOnly,
        WriteRead_IsBusy,
        WriteRead_WriteDataIsNullptr,
        WriteRead_ReadBufferIsNullptr,
        WriteRead_SizeIsZero,
        SetChipSelectPin_IsBusy
    };
 
    SpiMasterHardware() = default;
    explicit SpiMasterHardware(Gpio& chipSelectPin);
    virtual ~SpiMasterHardware() = default;
 
    void write(const uint8_t data[], size_t dataSize) override;
    void read(uint8_t buffer[], size_t bufferSize) override;
    bool isBusyReading() const override;
    bool isBusyWriting() const override;
    void setFrame(CommunicationHardware::Frame frame) override;
    void setFormat(uint8_t bits, TransmissionMode transmission, WireMode wire) override;
    void stopWrite() override;
    void stopRead() override;
    void writeRead(const uint8_t writeData[], uint8_t readBuffer[], size_t size) override;
    virtual void setChipSelectPin(Gpio& chipSelectPin);
    void enableChipSelect();
    void disableChipSelect();
    virtual void setFrequency(uint32_t hz) = 0;
 
protected:
    void setBusy(bool isBusy);
    CommunicationHardware::Frame frame() const;
    virtual void writeHardware(const uint8_t data[], size_t dataSize) = 0;
    virtual void readHardware(uint8_t buffer[], size_t bufferSize) = 0;
    virtual void writeReadHardware(const uint8_t writeData[], uint8_t readBuffer[], size_t size) = 0;
    virtual void setFormatHardware(uint8_t bits, TransmissionMode transmission, WireMode wire) = 0;
    virtual void stopWriteHardware() = 0;
    virtual void stopReadHardware() = 0;
    void onDataWritten();
    void onDataAvailable();
    void onError(Error thrown);
    void setTransmissionMode(TransmissionMode mode);
    void setWireMode(WireMode mode);
 
private:
    Gpio* m_chipSelectPin = nullptr;
    bool m_isBusy = false;
    CommunicationHardware::Frame m_frame = Frame::FirstAndLast;
    TransmissionMode m_transmission;
    WireMode m_wire;
    static constexpr Error::ClassID kSemfClassId = Error::ClassID::SpiMasterHardware;
};
} /* namespace semf */
#endif /* SEMF_COMMUNICATION_SPIMASTERHARDWARE_H_ */