CcioPin.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 __CCIOPIN_H__
#define __CCIOPIN_H__

#include <sam.h>
#include <stdint.h>

#include "Connector.h"
#include "SysConnectors.h"

namespace ClearCore {

class CcioPin : public Connector {
    friend class CcioBoardManager;

public:

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

    virtual bool Mode(ConnectorModes newMode) override;

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

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

    int16_t State() override;
    bool State(int16_t newState) override;

    void FilterLength(uint16_t samples) {
        m_filterLength = samples;
        m_filterTicksLeft = samples;
    }

    void Filter_ms(uint16_t len);

    bool IsInHwFault() override;

    bool InputRisen();

    bool InputFallen();

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

    void OutputPulsesStop(bool stopImmediately = true);

protected:
#ifndef HIDE_FROM_DOXYGEN

    CcioPin();

    void Initialize(ClearCorePins ccioPin) override;

    void Refresh() override {}
#endif

private:
    // Port access
    uint64_t m_dataBit;

    // Stability filter
    uint16_t m_filterLength;
    // Set to filter length on input change
    uint16_t m_filterTicksLeft;
    // Consecutive sample filter for tripping overload conditions
    uint16_t m_overloadTripCnt;
    // Overload condition output throttling
    uint16_t m_overloadFoldbackCnt;

    uint32_t m_pulseOnTicks;
    uint32_t m_pulseOffTicks;
    uint32_t m_pulseTicksRemaining;
    uint16_t m_pulseStopCount;
    uint16_t m_pulseCounter;
};

} // ClearCore namespace

#endif // __CCIOPIN_H__