DigitalInOutHBridge.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 __DIGITALINOUTHBRIDGE_H__
#define __DIGITALINOUTHBRIDGE_H__

#include <stdint.h>
#include "Connector.h"
#include "DigitalInOut.h"
#include "PeripheralRoute.h"
#include "ShiftRegister.h"
#include "StatusManager.h"

namespace ClearCore {

class DigitalInOutHBridge : public DigitalInOut {
    friend class StatusManager;
    friend class SysManager;

public:
    typedef enum {
        TONE_OFF = 0,
        TONE_CONTINUOUS,
        TONE_TIMED,
        TONE_PERIODIC_ON,
        TONE_PERIODIC_OFF,
    } ToneState;

#ifndef HIDE_FROM_DOXYGEN

    DigitalInOutHBridge() {};
#endif

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

    bool Mode(ConnectorModes newMode) override;

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

    void ToneAmplitude(int16_t amplitude);

    void ToneContinuous(uint16_t frequency);

    void ToneTimed(uint16_t frequency, uint32_t duration,
                   bool blocking = false, bool forceDuration = false);

    void TonePeriodic(uint16_t frequency, uint32_t timeOn, uint32_t timeOff);

    void ToneStop();

    volatile const ToneState &ToneActiveState() {
        return m_toneState;
    }

    int16_t State() override;

    bool State(int16_t newState) override;

    bool IsWritable() override;

#ifndef HIDE_FROM_DOXYGEN

    void ToneUpdate();
#endif

private:
    // Tone values
    int16_t m_amplitude;
    int16_t m_sinStep;
    int16_t m_angle;
    uint32_t m_toneStartTick;
    uint32_t m_toneOnTicks;
    uint32_t m_toneOffTicks;
    ToneState m_toneState;

    //Port, Pin, and Timer/Counter values
    const PeripheralRoute *m_pwmAInfo;
    const PeripheralRoute *m_pwmBInfo;

    Tcc *m_tcc;
    IRQn_Type m_tccIrq;

    bool m_inFault;
    bool m_forceToneDuration;

    void Initialize(ClearCorePins clearCorePin) override;

    void Refresh() override;

    inline void ToneFrequency(uint16_t frequency);

    void FaultState(bool isFaulted);

    DigitalInOutHBridge(ShiftRegister::Masks ledMask,
                        const PeripheralRoute *inputInfo,
                        const PeripheralRoute *outputInfo,
                        const PeripheralRoute *pwmAInfo,
                        const PeripheralRoute *pwmBInfo,
                        IRQn_Type tccIrq,
                        bool invertDigitalLogic);
}; // DigitalInOutHBridge

} // ClearCore namespace

#endif // __HBRIDGE_H__