SPITransaction.h

Go to the documentation of this file.

/* Copyright (c) 2020 Skyward Experimental Rocketry
 * Author: Luca Erbetta
 *
 * 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 "SPIBusInterface.h"
 
namespace Boardcore
{
 
class SPITransaction
{
public:
    explicit SPITransaction(const SPISlave& slave);
 
    // /**
    //  * @brief Instantiates a new SPITransaction, configuring the bus with the
    //  * provided parameters.
    //  *
    //  * @param bus Bus to communicate on.
    //  * @param cs Chip select of the slave to communicate to.
    //  * @param config Configuration of the bus for the selected slave.
    //  */
    // SPITransaction(SPIBusInterface &bus, GpioType cs, SPIBusConfig config);
 
    SPITransaction(const SPITransaction&)            = delete;
    SPITransaction& operator=(const SPITransaction&) = delete;
    SPITransaction(SPITransaction&&)                 = delete;
    SPITransaction& operator=(SPITransaction&&)      = delete;
 
    SPIBusInterface& getBus();
 
    // Read, write and transfer operations
 
    uint8_t read();
 
    uint16_t read16();
 
    virtual uint32_t read24();
 
    virtual uint32_t read32();
 
    void read(uint8_t* data, size_t size);
 
    void read16(uint16_t* data, size_t size);
 
    void write(uint8_t data);
 
    void write16(uint16_t data);
 
    virtual void write24(uint32_t data);
 
    virtual void write32(uint32_t data);
 
    void write(uint8_t* data, size_t size);
 
    void write16(uint16_t* data, size_t size);
 
    uint8_t transfer(uint8_t data);
 
    uint16_t transfer16(uint16_t data);
 
    virtual uint32_t transfer24(uint32_t data);
 
    virtual uint32_t transfer32(uint32_t data);
 
    void transfer(uint8_t* data, size_t size);
 
    void transfer16(uint16_t* data, size_t size);
 
    // Read, write and transfer operations with registers
 
    uint8_t readRegister(uint8_t reg);
 
    uint16_t readRegister16(uint8_t reg);
 
    uint32_t readRegister24(uint8_t reg);
 
    uint32_t readRegister32(uint8_t reg);
 
    void readRegisters(uint8_t reg, uint8_t* data, size_t size);
 
    void writeRegister(uint8_t reg, uint8_t data);
 
    void writeRegister16(uint8_t reg, uint16_t data);
 
    void writeRegister24(uint8_t reg, uint32_t data);
 
    void writeRegister32(uint8_t reg, uint32_t data);
 
    void writeRegisters(uint8_t reg, uint8_t* data, size_t size);
 
private:
    const SPISlave& slave;
};
 
}  // namespace Boardcore