Smbus.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 SMBUS_HPP
#define SMBUS_HPP

#include <cstdint>
#include <vector>
#include <boost/noncopyable.hpp>

namespace duds { namespace hardware { namespace interface {

class Smbus : boost::noncopyable {
public:
    virtual ~Smbus() = 0;
    // PEC
    struct UsePec { };
    struct NoPec { };
    // some flag for big-endian data; standard is little
    virtual std::uint8_t receiveByte() = 0;
    virtual std::uint8_t receiveByte(std::uint8_t cmd) = 0;
    virtual std::uint16_t receiveWord(std::uint8_t cmd) = 0;
    std::uint16_t receiveWordBe(std::uint8_t cmd) {
        std::uint16_t result = receiveWord(cmd);
        return (result << 8) | (result >> 8);
    }
    virtual int receive(std::uint8_t cmd, std::uint8_t *in,
        const int maxlen) = 0;
    virtual void receive(std::uint8_t cmd, std::vector<std::uint8_t> &in) = 0;
    virtual void transmitBool(bool out) = 0;
    virtual void transmitByte(std::uint8_t byte) = 0;
    virtual void transmitByte(std::uint8_t cmd, std::uint8_t byte) = 0;
    virtual void transmitWord(std::uint8_t cmd, std::uint16_t word) = 0;
    void transmitWordBe(std::uint8_t cmd, std::uint16_t word) {
        transmitWord(cmd, (word << 8) | (word >> 8));
    }
    virtual void transmit(
        std::uint8_t cmd,
        const std::uint8_t *out,
        const int len
    ) = 0;
    void transmit(std::uint8_t cmd, const std::vector<std::uint8_t> &out) {
        transmit(cmd, &(out[0]), out.size());
    }
    virtual std::uint16_t call(std::uint8_t cmd, std::uint16_t word) = 0;
    virtual void call(
        std::uint8_t cmd,
        const std::vector<std::uint8_t> &out,
        std::vector<std::uint8_t> &in
    ) = 0;
    virtual int address() const = 0;
};

} } }

#endif        //  #ifndef SMBUS_HPP