GpioDevPort.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) 2018  Jeff Jackowski
 */
#include <duds/hardware/interface/DigitalPortIndependentPins.hpp>
//#include <fstream>

// !@?!#?!#?
// It was bad enough to find an MS header had "#define interface struct".
// I was hoping such things wouldn't be here, but I was wrong.
#undef linux

namespace duds { namespace hardware { namespace interface {

class PinConfiguration;

namespace linux {

struct GpioDevPortError : PinError { };

struct GpioDevGetLinehandleError : GpioDevPortError { };

struct GpioDevGetLineValuesError : GpioDevPortError { };

struct GpioDevSetLineValuesError : GpioDevPortError { };

class GpioDevPort : public DigitalPortIndependentPins {
    std::string name;
    std::string consumer;
    std::string devpath;
    int chipFd;
    void initPin(std::uint32_t offset, unsigned int pid);
protected:
    virtual void madeAccess(DigitalPinAccess &acc);
    virtual void madeAccess(DigitalPinSetAccess &acc);
    virtual void retiredAccess(const DigitalPinAccess &acc) noexcept;
    virtual void retiredAccess(const DigitalPinSetAccess &acc) noexcept;
public:
    GpioDevPort(
        const std::string &path = "/dev/gpiochip0",
        unsigned int firstid = 0,
        const std::string &username = "DUDS"
    );
    GpioDevPort(
        const std::vector<unsigned int> &ids,
        const std::string &path = "/dev/gpiochip0",
        unsigned int firstid = 0,
        const std::string &username = "DUDS"
    );
    static std::shared_ptr<GpioDevPort> makeConfiguredPort(
        PinConfiguration &pc,
        const std::string &name = "default",
        const std::string &defaultPath = "/dev/gpiochip0",
        bool forceDefault = false
    );
    virtual ~GpioDevPort();
protected:
    // virtual functions required by Digitalport
    virtual void configurePort(
        unsigned int localPinId,
        const DigitalPinConfig &cfg,
        DigitalPinAccessBase::PortData *pdata
    );
    virtual bool inputImpl(
        unsigned int gid,
        DigitalPinAccessBase::PortData *pdata
    );
    virtual std::vector<bool> inputImpl(
        const std::vector<unsigned int> &pvec,
        DigitalPinAccessBase::PortData *pdata
    );
    virtual void outputImpl(
        unsigned int lid,
        bool state,
        DigitalPinAccessBase::PortData *pdata
    );
    virtual void outputImpl(
        const std::vector<unsigned int> &pvec,
        const std::vector<bool> &state,
        DigitalPinAccessBase::PortData *pdata
    );
public:
    virtual bool simultaneousOperations() const;
};

} } } } // namespaces