SPIBusInterface.h

Go to the documentation of this file.

/* Copyright (c) 2019-2021 Skyward Experimental Rocketry
 * Authors: Luca Erbetta, Alberto Nidasio
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
 
#pragma once
 
#include <interfaces-impl/gpio_impl.h>
#include <stddef.h>
 
#include "SPIDefs.h"
 
#ifndef USE_MOCK_PERIPHERALS
using GpioType = miosix::GpioPin;
#else
#include <utils/TestUtils/MockGpioPin.h>
using GpioType = Boardcore::MockGpioPin;
#endif
 
namespace Boardcore
{
 
struct SPIBusConfig
{
    SPI::ClockDivider clockDivider;
 
    SPI::Mode mode;
 
    SPI::Order bitOrder;
 
    SPI::Order byteOrder;
 
    SPI::WriteBit writeBit;
 
    unsigned int csSetupTimeUs;
 
    unsigned int csHoldTimeUs;
 
    SPIBusConfig(SPI::ClockDivider clockDivider = SPI::ClockDivider::DIV_256,
                 SPI::Mode mode                 = SPI::Mode::MODE_0,
                 SPI::Order bitOrder            = SPI::Order::MSB_FIRST,
                 SPI::Order byteOrder           = SPI::Order::MSB_FIRST,
                 SPI::WriteBit writeBit         = SPI::WriteBit::NORMAL,
                 unsigned int csSetupTimeUs = 0, unsigned int csHoldTimeUs = 0)
        : clockDivider(clockDivider), mode(mode), bitOrder(bitOrder),
          byteOrder(byteOrder), writeBit(writeBit),
          csSetupTimeUs(csSetupTimeUs), csHoldTimeUs(csHoldTimeUs)
    {
    }
 
    bool operator==(const SPIBusConfig& other) const
    {
        return clockDivider == other.clockDivider && mode == other.mode &&
               bitOrder == other.bitOrder &&
               csSetupTimeUs == other.csSetupTimeUs &&
               csHoldTimeUs == other.csHoldTimeUs;
    }
 
    bool operator!=(const SPIBusConfig& other) const
    {
        return !(*this == other);
    }
};
 
class SPIBusInterface
{
public:
    SPIBusInterface() {}
 
    SPIBusInterface(const SPIBusInterface&)            = delete;
    SPIBusInterface& operator=(const SPIBusInterface&) = delete;
    SPIBusInterface(SPIBusInterface&&)                 = delete;
    SPIBusInterface& operator=(SPIBusInterface&&)      = delete;
 
    virtual void configure(SPIBusConfig config) = 0;
 
    virtual void select(GpioType cs) = 0;
 
    virtual void deselect(GpioType cs) = 0;
 
    // Read, write and transfer operations
 
    virtual uint8_t read() = 0;
 
    virtual uint16_t read16() = 0;
 
    virtual uint32_t read24() = 0;
 
    virtual uint32_t read32() = 0;
 
    virtual void read(uint8_t* data, size_t size) = 0;
 
    virtual void read16(uint16_t* data, size_t size) = 0;
 
    virtual void write(uint8_t data) = 0;
 
    virtual void write16(uint16_t data) = 0;
 
    virtual void write24(uint32_t data) = 0;
 
    virtual void write32(uint32_t data) = 0;
 
    virtual void write(const uint8_t* data, size_t size) = 0;
 
    virtual void write16(const uint16_t* data, size_t size) = 0;
 
    virtual uint8_t transfer(uint8_t data) = 0;
 
    virtual uint16_t transfer16(uint16_t data) = 0;
 
    virtual uint32_t transfer24(uint32_t data) = 0;
 
    virtual uint32_t transfer32(uint32_t data) = 0;
 
    virtual void transfer(uint8_t* data, size_t size) = 0;
 
    virtual void transfer16(uint16_t* data, size_t size) = 0;
};
 
struct SPISlave
{
    SPIBusInterface& bus;  
    SPIBusConfig config;   
    GpioType cs;           
 
    SPISlave(SPIBusInterface& bus, GpioType cs, SPIBusConfig config = {})
        : bus(bus), config(config), cs(cs)
    {
    }
};
 
class SPIAcquireLock
{
public:
    explicit SPIAcquireLock(SPISlave slave)
        : SPIAcquireLock(slave.bus, slave.config)
    {
    }
 
    SPIAcquireLock(SPIBusInterface& bus, SPIBusConfig cfg) : bus(bus)
    {
        bus.configure(cfg);
    }
 
private:
    SPIBusInterface& bus;
};
 
class SPISelectLock
{
public:
    explicit SPISelectLock(SPISlave slave) : SPISelectLock(slave.bus, slave.cs)
    {
    }
 
    SPISelectLock(SPIBusInterface& bus, GpioType cs) : bus(bus), cs(cs)
    {
        bus.select(cs);
    }
 
    ~SPISelectLock() { bus.deselect(cs); }
 
private:
    SPIBusInterface& bus;
    GpioType& cs;
};
 
}  // namespace Boardcore