MasterSyncSerial.hpp

Go to the documentation of this file.

/*
 * This file is part of the DUDS project. It is subject to the BSD-style
 * license terms in the LICENSE file found in the top-level directory of this
 * distribution and at https://github.com/jjackowski/duds/blob/master/LICENSE.
 * No part of DUDS, including this file, may be copied, modified, propagated,
 * or distributed except according to the terms contained in the LICENSE file.
 *
 * Copyright (C) 2017  Jeff Jackowski
 */
#ifndef MASTERSYNCSERIAL_HPP
#define MASTERSYNCSERIAL_HPP

#include <cstdint>
#include <memory>
#include <boost/noncopyable.hpp>
#include <duds/general/BitFlags.hpp>
#include <duds/general/DataSize.hpp>
#include <duds/hardware/interface/Conversationalist.hpp>

namespace duds { namespace hardware { namespace interface {

class MasterSyncSerialAccess;

class MasterSyncSerial : public Conversationalist, boost::noncopyable,
public std::enable_shared_from_this<MasterSyncSerial> {
    friend class MasterSyncSerialAccess;
    MasterSyncSerialAccess *mssacc;
    void retire(MasterSyncSerialAccess *acc);
public:
    typedef duds::general::BitFlags<struct MssFlags> Flags;
    static constexpr Flags MssUseSelect = Flags(1);
    static constexpr Flags MssClockIdleHigh = Flags(2);
    static constexpr Flags MssOutFallInRise = Flags(4);
    static constexpr Flags MssMSbFirst = Flags(8);
    static constexpr Flags MssFullDuplex = Flags(16);
    static constexpr Flags MssConfigMask = Flags(31);
    static constexpr Flags MssReady = Flags(32);
    static constexpr Flags MssOpen = Flags(64);
    static constexpr Flags MssCommunicating = Flags(128);
    static constexpr Flags MssFirstDerivedClassFlag = Flags(256);
    static constexpr Flags MssSpiMode0 = MssMSbFirst | MssOutFallInRise
        | MssFullDuplex;
    static constexpr Flags MssSpiMode1 = MssMSbFirst | MssFullDuplex;
    static constexpr Flags MssSpiMode2 = MssMSbFirst | MssClockIdleHigh
        | MssFullDuplex;
    static constexpr Flags MssSpiMode3 = MssMSbFirst | MssClockIdleHigh |
        MssOutFallInRise | MssFullDuplex;
    static constexpr Flags MssSpiMode0LSb = MssOutFallInRise | MssFullDuplex;
    static constexpr Flags MssSpiMode1LSb = MssFullDuplex;
    static constexpr Flags MssSpiMode2LSb = MssClockIdleHigh | MssFullDuplex;
    static constexpr Flags MssSpiMode3LSb = MssClockIdleHigh
        | MssOutFallInRise | MssFullDuplex;
protected:
    unsigned int minHalfPeriod;
    Flags flags;
    void forceClose();
    virtual void open() = 0;
    virtual void close() = 0;
    virtual void start() = 0;
    virtual void stop() = 0;
    void condStart();
    void condStop();
    void clockFrequency(unsigned int freq);
    void clockPeriod(unsigned int nanos);
    virtual void transfer(
        const std::uint8_t * __restrict__ out,
        std::uint8_t * __restrict__ in,
        duds::general::Bits bits
    ) = 0;
    virtual void transmit(const std::uint8_t *buff, duds::general::Bits bits);
    virtual void receive(std::uint8_t *buff, duds::general::Bits bits);
    void converseAlreadyOpen(Conversation &conv);
public:
    MasterSyncSerial() : minHalfPeriod(0), flags(0)  { }
    MasterSyncSerial(Flags flags, int period);
    virtual ~MasterSyncSerial() = 0;
    Flags configFlags() const noexcept {
        return flags & MssConfigMask;
    }
    bool inUse() const noexcept {
        return mssacc != nullptr;
    }
    unsigned int clockPeriod() const noexcept {
        return minHalfPeriod << 1;
    }
    unsigned int clockFrequency() const noexcept;
    std::unique_ptr<MasterSyncSerialAccess> access();
    void access(MasterSyncSerialAccess &acc);
    std::unique_ptr<MasterSyncSerialAccess> accessStart();
    void accessStart(MasterSyncSerialAccess &acc);
    virtual void converse(Conversation &conv);
};

} } } // namespaces

#endif        //  #ifndef MASTERSYNCSERIAL_HPP