Libraries/USB/src/USB/VENDOR/Device.h

Go to the documentation of this file.

/****
 * VENDOR/Device.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 "../CDC/UsbSerial.h"
#include "../DeviceInterface.h"

namespace USB::VENDOR
{
class Device : public DeviceInterface, public USB::CDC::UsbSerial
{
public:
    Device(uint8_t idx, const char* name);

    size_t setRxBufferSize(size_t size) override
    {
        return CFG_TUD_CDC_RX_BUFSIZE;
    }

    virtual size_t setTxBufferSize(size_t size) override
    {
        return CFG_TUD_CDC_TX_BUFSIZE;
    }

    int available() override
    {
        return tud_vendor_n_available(inst);
    }

    bool isFinished() override
    {
        return !tud_vendor_n_mounted(inst);
    }

    int read() override
    {
        char c;
        return tud_vendor_n_read(inst, &c, sizeof(c)) ? c : -1;
    }

    size_t readBytes(char* buffer, size_t length) override
    {
        return tud_vendor_n_read(inst, buffer, length);
    }

    int peek() override
    {
        uint8_t c;
        return tud_vendor_n_peek(inst, &c) ? c : -1;
    }

    void clear(SerialMode mode = SERIAL_FULL) override
    {
        if(mode != SerialMode::TxOnly) {
            tud_vendor_n_read_flush(inst);
        }
        if(mode != SerialMode::RxOnly) {
            tud_vendor_n_flush(inst); // There's no 'clear' API
        }
    }

    void flush() override
    {
        tud_vendor_n_flush(inst);
    }

    using Stream::write;

    size_t write(const uint8_t* buffer, size_t size) override;
};

} // namespace USB::VENDOR