UsbSerial.h

Go to the documentation of this file.

/****
 * CDC/UsbSerial.h
 *
 * Copyright 2023 mikee47 <mike@sillyhouse.net>
 *
 * This file is part of the Sming USB Library
 *
 * This library is free software: you can redistribute it and/or modify it under the terms of the
 * GNU General Public License as published by the Free Software Foundation, version 3 or later.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with this library.
 * If not, see <https://www.gnu.org/licenses/>.
 *
 ****/
 
#pragma once
 
#include <HardwareSerial.h>
#include <SimpleTimer.h>
#include <Data/BitSet.h>
#include <memory>
 
namespace USB::CDC
{
enum class Event {
    rx_data,
    tx_done,
    line_break,
};
 
class UsbSerial : public ReadWriteStream
{
public:
    using DataReceived = StreamDataReceivedDelegate;
    using TransmitComplete = Delegate<void(UsbSerial& device)>;
 
    virtual size_t setRxBufferSize(size_t size) = 0;
 
    virtual size_t setTxBufferSize(size_t size) = 0;
 
    void setTxWait(bool wait)
    {
        bitWrite(options, UART_OPT_TXWAIT, wait);
    }
 
    uint16_t readMemoryBlock(char* buf, int max_len) override
    {
        return readBytes(buf, max_len);
    }
 
    bool seek(int) override
    {
        return false;
    }
 
    virtual void clear(SerialMode mode = SERIAL_FULL) = 0;
 
    void systemDebugOutput(bool enabled);
 
    bool onDataReceived(DataReceived callback)
    {
        receiveCallback = callback;
        return true;
    }
 
    bool onTransmitComplete(TransmitComplete callback)
    {
        transmitCompleteCallback = callback;
        return true;
    }
 
    unsigned getStatus();
 
    // Called internally
    void handleEvent(Event event);
 
protected:
    uart_options_t options{_BV(UART_OPT_TXWAIT)};
 
    void queueFlush();
 
private:
    void processEvents();
 
    SimpleTimer flushTimer;
    SimpleTimer eventTimer;
    DataReceived receiveCallback;
    TransmitComplete transmitCompleteCallback;
    uint16_t status{0};
    BitSet<uint8_t, Event> eventMask;
};
 
} // namespace USB::CDC