DigitalIn.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 __DIGITALIN_H__
#define __DIGITALIN_H__
 
#include <stdint.h>
#include "Connector.h"
#include "InputManager.h"
#include "PeripheralRoute.h"
#include "ShiftRegister.h"
 
namespace ClearCore {
 
typedef void (*voidFuncPtr)(void);
 
class DigitalIn : public Connector {
    friend class SysManager;
    friend class TestIO;
 
public:
#ifndef HIDE_FROM_DOXYGEN
    DigitalIn() {};
#endif
 
    typedef enum {
        FILTER_UNIT_MS,
        FILTER_UNIT_SAMPLES,
    } FilterUnits;
 
    void FilterLength(uint16_t length,
                      FilterUnits units = FILTER_UNIT_SAMPLES) {
        // 1 ms = 1000 us = 5 * (200 us) = 5 sample times
        uint16_t samples = (units == FILTER_UNIT_MS) ? 5 * length : length;
        m_filterLength = samples;
        m_filterTicksLeft = samples;
    }
 
    uint16_t FilterLength() {
        return m_filterLength;
    }
 
    virtual ConnectorModes Mode() override {
        return Connector::Mode();
    }
 
    virtual bool Mode(ConnectorModes newMode) override {
        if (newMode == ConnectorModes::INPUT_DIGITAL) {
            m_mode = newMode;
            return true;
        }
        else {
            return false;
        }
    }
 
    Connector::ConnectorTypes Type() override {
        return Connector::DIGITAL_IN_TYPE;
    }
 
    bool IsWritable() override {
        return false;
    }
 
    int16_t State() override;
 
#ifndef HIDE_FROM_DOXYGEN
 
    int16_t StateRT();
 
    bool State(int16_t newState) override {
        (void)newState;
        return false;
    }
#endif
 
    bool InputRisen();
 
    bool InputFallen();
 
#ifndef HIDE_FROM_DOXYGEN
    bool IsInHwFault() override {
        return false;
    }
 
    int8_t ExternalInterrupt() override {
        return m_extInt;
    }
#endif
 
    bool InterruptHandlerSet(voidFuncPtr callback = nullptr,
                             InputManager::InterruptTrigger trigger =
                                 InputManager::InterruptTrigger::RISING,
                             bool enable = true);
 
    void InterruptEnable(bool enable);
 
protected:
    // LED associated with input
    ShiftRegister::Masks m_ledMask;
 
    // Register that contains the digital input
    uint32_t m_inputPort;
    uint32_t m_inputDataBit;
    uint32_t m_inputDataMask;
 
    // External interrupts
    uint8_t m_extInt;        // External interrupt line index
    bool m_interruptAvail;   // An external interrupt is available on this input
 
    uint32_t *m_changeRegPtr;
    uint32_t *m_inRegPtr;
    uint32_t *m_inputRegRTPtr;
 
    // Boolean state holders
    bool m_stateFiltered;
 
    // Stability filter
    uint16_t m_filterLength;
    // Set to filter length on input state change
    uint16_t m_filterTicksLeft;
 
    DigitalIn(enum ShiftRegister::Masks ledMask,
              const PeripheralRoute *inputInfo);
 
    void Refresh() override;
 
    void Initialize(ClearCorePins clearCorePin) override;
 
    void UpdateFilterState();
 
}; // DigitalIn
 
} // ClearCore namespace
 
#endif // __DIGITALIN_H__