DigitalInOut.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Teknic, Inc.
 *
 * 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.
 */

#ifndef __DIGITALINOUT_H__
#define __DIGITALINOUT_H__

#include <stdint.h>
#include <sam.h>
#include "Connector.h"
#include "DigitalIn.h"
#include "ShiftRegister.h"
#include "SysUtils.h"

namespace ClearCore {

class DigitalInOut : public DigitalIn {
    friend class SysManager;

public:
#ifndef HIDE_FROM_DOXYGEN

    DigitalInOut() {};
#endif

    virtual ConnectorModes Mode() override {
        return Connector::Mode();
    }

    virtual bool Mode(ConnectorModes newMode) override;

    Connector::ConnectorTypes Type() override {
        return Connector::DIGITAL_IN_OUT_TYPE;
    }

    bool IsWritable() override {
        return m_mode == OUTPUT_DIGITAL || m_mode == OUTPUT_PWM;
    }

    int16_t State() override;

    bool State(int16_t newState) override;

    bool IsInHwFault() override {
        return (volatile bool &)m_isInFault;
    }

    void OutputPulsesStart(uint32_t onTime, uint32_t offTime,
                           uint16_t pulseCount = 0,
                           bool blockUntilDone = false);

    void OutputPulsesStop(bool stopImmediately = true);

    volatile const bool &OutputPulsesActive() {
        return m_pulseActive;
    }

    bool PwmDuty(uint8_t newDuty);

protected:
    // Port access
    uint32_t m_outputPort;
    uint32_t m_outputDataBit;
    uint32_t m_outputDataMask;
    bool m_logicInversion;

    bool m_isInFault;

    Tc *m_tc;
    uint8_t m_tcPadNum;

#ifndef HIDE_FROM_DOXYGEN

    DigitalInOut(enum ShiftRegister::Masks ledMask,
                 const PeripheralRoute *inputInfo,
                 const PeripheralRoute *outputInfo,
                 bool logicInversion);

    void Refresh() override;

    void Initialize(ClearCorePins clearCorePin) override;
#endif
private:
    bool m_outState;
    // Pulse control variables
    uint32_t m_pulseOnTicks;
    uint32_t m_pulseOffTicks;
    uint32_t m_pulseStart;
    uint16_t m_pulseStopCount;
    uint16_t m_pulseCounter;
    uint8_t m_overloadTripCnt;
    bool m_pulseActive;
    bool m_pulseValue;
    bool m_pulseStopPending;
    uint16_t m_overloadFoldbackCnt;

    void OutputPin(bool val) {
        DATA_OUTPUT_STATE(m_outputPort, m_outputDataMask,
                          val != m_logicInversion);
    }

    void IsInHwFault(bool inFault);
};

} // ClearCore namespace

#endif // __DIGITALINOUT_H__