TWlanLog.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
// Module:        CTWlanLog
// Description:   Provides a WLAN-backed logging sink and telnet-style mirror.
// Author:        R. Zuehlsdorff, ralf.zuehlsdorff@t-online.de
// Created:       2026-02-02
// License:       MIT License (https://opensource.org/license/mit/)
//------------------------------------------------------------------------------
// Change Log:
// 2026-02-02     R. Zuehlsdorff        Initial creation
//------------------------------------------------------------------------------
 
#pragma once
 
// Circle core components
#include <circle/device.h>
#include <circle/net/ipaddress.h>
#include <circle/net/netsubsystem.h>
#include <circle/net/socket.h>
#include <circle/sched/task.h>
#include <circle/spinlock.h>
#include <circle/string.h>
#include <circle/types.h>
 
// Forward declarations
class CLogger;
class CBcm4343Device;
class CWPASupplicant;
 
class CTWlanLog : public CDevice, public CTask
{
public:
    static CTWlanLog *Get();
 
    CTWlanLog();
    ~CTWlanLog() override;
 
    bool Initialize(CBcm4343Device &wlan,
                    CNetSubSystem &net,
                    CWPASupplicant &supplicant,
                    CLogger &logger,
                    unsigned port,
                    CDevice *fallback);
 
    void SetFallback(CDevice *fallback);
 
    bool Start();
    void Stop();
    bool IsClientConnected() const;
    bool IsHostModeActive() const;
 
    void Send(const char *buffer, size_t length);
    bool SendHostData(const char *buffer, size_t length);
    void SendLine(const char *line);
    void SendCommandPrompt();
 
    int Write(const void *buffer, size_t count) override;
 
    void Run() override;
 
protected:
    virtual void ProcessLine(const char *line);
 
private:
    enum ETelnetRxState
    {
        TelnetStateData,
        TelnetStateIAC,
        TelnetStateCommand,
        TelnetStateSubnegotiation,
        TelnetStateSubnegotiationIAC
    };
 
    bool EnsureListenSocket();
    void AcceptClient();
    void CloseClient(const char *reason, bool sendLocked = false);
    void HandleIncomingData();
    void HandleIncomingByte(u8 byte);
    void HandleCommandChar(char ch);
    bool HandleTelnetByte(u8 byte);
    void SendTelnetCommand(u8 verb, u8 option);
    void SendTelnetNegotiation();
    void AnnounceConnection(const CIPAddress &remoteIP, u16 remotePort);
    void ResetConnectionState();
 
private:
    static CTWlanLog *s_pInstance;
 
    CBcm4343Device *m_pWlan;
    CNetSubSystem *m_pNet;
    CLogger *m_pLogger;
    CWPASupplicant *m_pSupplicant;
    CDevice *m_pFallback;
    unsigned m_Port;
 
    CSocket *m_pListenSocket;
    CSocket *m_pClientSocket;
 
    bool m_Initialized;
    bool m_Activated;
    bool m_StopRequested;
    bool m_LoggerAttached;
    bool m_RemoteLoggingActive;
    bool m_HostModeActive;
    bool m_CommandPromptVisible;
    bool m_LogLastWasCR;
    bool m_CloseRequested;
    bool m_LastRxWasCR;
    bool m_TelnetNegotiated;
    ETelnetRxState m_TelnetRxState;
    u8 m_TelnetCommand;
 
    CString m_RxLineBuffer;
    mutable CSpinLock m_ConnectionLock;
    mutable CSpinLock m_SendLock;
};