SerialUsb.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 __SERIALUSB_H__
#define __SERIALUSB_H__

#include <inttypes.h>
#include "Connector.h"
#include "ISerial.h"

#ifdef DEC
#undef DEC
#endif
#define DEC 10

#ifdef HEX
#undef HEX
#endif
#define HEX 16

#ifdef OCT
#undef OCT
#endif
#define OCT 8

#ifdef BIN
#undef BIN
#endif
#define BIN 2

#define USB_SERIAL_TIMEOUT 5000 // milliseconds

namespace ClearCore {

class SerialUsb : public ISerial, public Connector {
    friend class SysManager;

public:
#ifndef HIDE_FROM_DOXYGEN

    SerialUsb() {};
#endif


    void Flush() override;

    void FlushInput() override;

    void PortOpen() override;

    void PortClose() override;

#ifndef HIDE_FROM_DOXYGEN

    bool Speed(uint32_t bitsPerSecond) override;

    uint32_t Speed() override;
#endif

    int16_t CharGet() override;

    int16_t CharPeek() override;

    bool SendChar(uint8_t charToSend) override;

    int32_t AvailableForRead() override;

    int32_t AvailableForWrite() override;

    void WaitForTransmitIdle() override;

    bool PortIsOpen() override;

    bool Parity(Parities newParity) override {
        return newParity == Parities::PARITY_N;
    }

    Parities Parity() override {
        return Parities::PARITY_N;
    }

    bool StopBits(uint8_t bits) override {
        return bits == 1;
    }

    bool CharSize(uint8_t size) override {
        return size == 8;
    }


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

    bool Mode(ConnectorModes newMode) override {
        return (m_mode == newMode);
    }

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

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

    operator bool() override;

#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

private:
    // Index of this instance
    uint16_t m_index;

#ifndef HIDE_FROM_DOXYGEN
    explicit SerialUsb(uint16_t index);

    void Initialize(ClearCorePins clearCorePin) override {
        m_index = clearCorePin;
        m_mode = USB_CDC;
    }

    void Refresh() override {};
#endif
}; // SerialUsb

} // ClearCore namespace

#endif // __SERIALDRIVER_H__