DigitalPinCap.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
 */
#include <duds/hardware/interface/DigitalPinConfig.hpp>

namespace duds { namespace hardware { namespace interface {

struct DigitalPinCap {
    typedef duds::general::BitFlags<struct DigitalPinFlags, std::uint16_t>
        Flags;
    static constexpr Flags Input = Flags::Bit(0);
    static constexpr Flags OutputPushPull = Flags::Bit(1);
    static constexpr Flags OutputDriveLow = Flags::Bit(2);
    static constexpr Flags OutputDriveHigh = Flags::Bit(3);
    static constexpr Flags OutputDriveMask =
        OutputPushPull | OutputDriveLow | OutputDriveHigh;
    static constexpr Flags OutputHighImpedance = Flags::Bit(4);
    static constexpr Flags HasPulldown = Flags::Bit(5);
    static constexpr Flags ControllablePulldown = Flags::Bit(6);
    static constexpr Flags HasPullup = Flags::Bit(7);
    static constexpr Flags ControllablePullup = Flags::Bit(8);
    static constexpr Flags EventEdgeFalling = Flags::Bit(9);
    static constexpr Flags EventEdgeRising = Flags::Bit(10);
    static constexpr Flags EventEdgeChange = Flags::Bit(11);
    static constexpr Flags EventLevelLow = Flags::Bit(12);
    static constexpr Flags EventLevelHigh = Flags::Bit(13);
    static constexpr Flags InterruptOnEvent = Flags::Bit(14);
    Flags capabilities;
    std::uint16_t maxOutputCurrent;
    DigitalPinCap() = default;
    constexpr DigitalPinCap(const Flags cap, std::uint16_t cur = 0) :
        capabilities(cap),
        maxOutputCurrent(cur)
    { }
    constexpr bool exists() const {
        return (capabilities & (
            Input | OutputPushPull | OutputDriveHigh | OutputDriveLow |
            ControllablePulldown | ControllablePullup | InterruptOnEvent
        )) != Flags::Zero();
    }
    constexpr bool canOutput() const {
        return (capabilities & OutputDriveMask) != Flags::Zero();
    }
    Flags firstOutputDriveFlag() const;
    DigitalPinConfig::Flags firstOutputDriveConfigFlags() const;
    DigitalPinRejectedConfiguration::Reason compatible(
        const DigitalPinConfig &cfg
    ) const;
};

constexpr DigitalPinCap NonexistentDigitalPin =
    DigitalPinCap(DigitalPinCap::Flags::Zero(), 0);


typedef boost::error_info<
    struct Info_DigitalPinCap, DigitalPinCap
> DigitalPinCapInfo;

inline std::ostream &operator<<(std::ostream &os, const DigitalPinCap &c) {
    return os << '(' << c.capabilities.flags() << ',' <<
    c.maxOutputCurrent << ')';
}

constexpr DigitalPinCap::Flags operator & (
    const DigitalPinCap &cap,
    const DigitalPinCap::Flags &flg
) {
    return cap.capabilities & flg;
}

constexpr DigitalPinCap::Flags operator & (
    const DigitalPinCap::Flags &flg,
    const DigitalPinCap &cap
) {
    return flg & cap.capabilities;
}

constexpr DigitalPinCap::Flags operator | (
    const DigitalPinCap &cap,
    const DigitalPinCap::Flags &flg
) {
    return cap.capabilities | flg;
}

constexpr DigitalPinCap::Flags operator | (
    const DigitalPinCap::Flags &flg,
    const DigitalPinCap &cap
) {
    return flg | cap.capabilities;
}

constexpr DigitalPinCap::Flags operator ^ (
    const DigitalPinCap &cap,
    const DigitalPinCap::Flags &flg
) {
    return cap.capabilities ^ flg;
}

constexpr DigitalPinCap::Flags operator ^ (
    const DigitalPinCap::Flags &flg,
    const DigitalPinCap &cap
) {
    return flg ^ cap.capabilities;
}

constexpr bool operator == (
    const DigitalPinCap &cap,
    const DigitalPinCap::Flags &flg
) {
    return cap.capabilities == flg;
}

constexpr bool operator == (
    const DigitalPinCap::Flags &flg,
    const DigitalPinCap &cap
) {
    return flg == cap.capabilities;
}

constexpr bool operator != (
    const DigitalPinCap &cap,
    const DigitalPinCap::Flags &flg
) {
    return cap.capabilities != flg;
}

constexpr bool operator != (
    const DigitalPinCap::Flags &flg,
    const DigitalPinCap &cap
) {
    return flg != cap.capabilities;
}

} } }