TUART.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
// Module:        CTUART
// Description:   Provides buffered UART handling as a Circle task abstraction.
// Author:        R. Zuehlsdorff, ralf.zuehlsdorff@t-online.de
// Created:       2026-01-27
// License:       MIT License (https://opensource.org/license/mit/)
//------------------------------------------------------------------------------
// Change Log:
// 2026-01-27     R. Zuehlsdorff        Initial creation
//------------------------------------------------------------------------------
 
#pragma once
 
#include <circle/sched/task.h>
#include <circle/spinlock.h>
#include <circle/serial.h>
 
class CTUART : public CTask
{
public:
    static CTUART *Get(void);
 
    CTUART();
 
    ~CTUART();
 
    typedef void (*ReceiveHandler)(const char*, size_t);
    bool Initialize(CInterruptSystem *pInterruptSystem, ReceiveHandler recvFunc);
 
    bool EnsureStarted();
 
    void SuspendTask();
 
    void Send(const char* buf, size_t len);
 
 
    void Run() override;
 
    int DrainSerialInput(char *dest, size_t maxLen);
 
private:
    class CSerialDeviceWithAccess : public CSerialDevice
    {
    public:
        using CSerialDevice::CSerialDevice;
        unsigned RxAvailable() { return AvailableForRead(); }
    };
 
    CSerialDeviceWithAccess *m_pSerial = nullptr;
    CInterruptSystem *m_pInterruptSystem = nullptr;
    bool m_bTaskRunning = false;
    bool m_bEverStarted = false;
    bool m_bSoftwareFlowControl = false;
    bool m_bFlowStopped = false;
    unsigned m_FlowHighThreshold = 0;
    unsigned m_FlowLowThreshold = 0;
 
    // Static receive handler pointer
    static ReceiveHandler g_ReceiveHandler;
};