SerialDriver.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 __SERIALDRIVER_H__
#define __SERIALDRIVER_H__

#include <stdint.h>
#include "Connector.h"
#include "SerialBase.h"
#include "ShiftRegister.h"

namespace ClearCore {

class SerialDriver : public SerialBase, public Connector {
    friend class SysManager;
    friend class CcioBoardManager;
    friend class TestIO;

public:
#ifndef HIDE_FROM_DOXYGEN

    SerialDriver() {};
#endif

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

    bool Mode(ConnectorModes newMode) override;

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

    bool IsWritable() override {
        return PortIsOpen();
    };

#ifndef HIDE_FROM_DOXYGEN

    int16_t State() override {
        return PortIsOpen();
    }

    bool State(int16_t newState) override {
        if (newState) {
            PortOpen();
        }
        else {
            PortClose();
        }
        return true;
    }

    bool IsInHwFault() override {
        return false;
    }
#endif

    bool Speed(uint32_t bitsPerSecond) override {
        bool retVal = SerialBase::Speed(bitsPerSecond);
        // Delay to allow the port polarity to be written to the shift
        // register and settle for a full character time before sending data
        if (m_portOpen) {
            WaitOneCharTime();
        }
        return retVal;
    }

    void PortOpen() override;

    void PortClose() override;

private:
    // Index of this instance
    uint8_t m_index;
    // Feedback LED
    ShiftRegister::Masks m_ledMask;
    // Control bit in shift register
    ShiftRegister::Masks m_controlMask;
    // Inverter bit in shift register
    ShiftRegister::Masks m_polarityMask;

#ifndef HIDE_FROM_DOXYGEN

    SerialDriver(uint16_t index,
                 ShiftRegister::Masks feedBackLedMask,
                 ShiftRegister::Masks controlMask,
                 ShiftRegister::Masks polarityMask,
                 const PeripheralRoute *ctsMisoInfo,
                 const PeripheralRoute *rtsSsInfo,
                 const PeripheralRoute *rxSckInfo,
                 const PeripheralRoute *txMosiInfo,
                 uint8_t peripheral);
#endif

    void Initialize(ClearCorePins clearCorePin) override;

    void Refresh() override {};
}; // SerialDriver

} // ClearCore namespace

#endif // __SERIALDRIVER_H__