InputManager.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 __INPUTMANAGER_H__
#define __INPUTMANAGER_H__

#include "PeripheralRoute.h"
#include "SysConnectors.h"

namespace ClearCore {

typedef void (*voidFuncPtr)(void);

class InputManager {
    friend class DigitalIn;
    friend class SerialBase;
    friend class TestIO;
public:
    typedef enum {
        NONE = -1,
        LOW = 0,
        HIGH = 1,
        CHANGE = 2,
        FALLING = 3,
        RISING = 4,
    } InterruptTrigger;

#ifndef HIDE_FROM_DOXYGEN

    static InputManager &Instance();
#endif

    SysConnectorState InputsRisen(SysConnectorState mask = UINT32_MAX);

    SysConnectorState InputsFallen(SysConnectorState mask = UINT32_MAX);

    SysConnectorState InputsRT(SysConnectorState mask = UINT32_MAX);

#ifndef HIDE_FROM_DOXYGEN

    void InterruptEnable(int8_t extInt, bool enable, bool clearPending = false);
#endif

    void InterruptsEnabled(bool enable);

    bool InterruptsEnabled() {
        return m_interruptsEnabled;
    }

#ifndef HIDE_FROM_DOXYGEN

    bool InterruptHandlerSet(int8_t extInt,
                             voidFuncPtr callback = nullptr,
                             InterruptTrigger trigger = RISING,
                             bool enable = true,
                             bool oneTime = false);

    void Initialize();

    void UpdateBegin();

    void UpdateEnd();

    void EIC_Handler(uint8_t index);
#endif
private:
    // State of the unfiltered input port registers from the DSP.
    volatile uint32_t *m_inputPtrs[CLEARCORE_PORT_MAX];
    uint32_t m_inputsUnfiltered[CLEARCORE_PORT_MAX];
    uint32_t m_inputsUnfilteredChanges[CLEARCORE_PORT_MAX];

    // Filtered input registers
    // Real Time register for FILTERED values
    SysConnectorState m_inputRegRT;
    // Last sample time register for FILTERED values
    SysConnectorState m_inputRegLast;
    // Rising Edge register for FILTERED values
    SysConnectorState m_inputRegRisen;
    // Falling Edge register for FILTERED values
    SysConnectorState m_inputRegFallen;
    // End input registers

    // A mask representing all connectors with registered ISRs.
    uint32_t m_interruptsMask;
    // Are interrupts enabled across the board?
    bool m_interruptsEnabled;
    // Registered interrupt service routines
    voidFuncPtr m_interruptServiceRoutines[EIC_NUMBER_OF_INTERRUPTS];
    // Bitmask indicating which interrupt handlers disable after triggerring
    uint16_t m_oneTimeFlags;

#ifndef HIDE_FROM_DOXYGEN

    InputManager();

    // Configure the addresses to read the inputs from
    void SetInputRegisters(volatile uint32_t *a,
                           volatile uint32_t *b,
                           volatile uint32_t *c);

    uint32_t EicSense(InterruptTrigger trigger);

#endif // !HIDE_FROM_DOXYGEN
}; // InputManager

} // ClearCore namespace

#endif /* __INPUTMANAGER_H__ */