kernel.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
// Module:        kernel.h
// Description:   Main entry point for Pi_VT100, a VT100 emulator running
//                on Pi zero bare metal implementation based on Circle
// Author:        R. Zuehlsdorff, ralf.zuehlsdorff@t-online.de
// Created:       2026-01-18
// License:       MIT License (https://opensource.org/license/mit/)
//------------------------------------------------------------------------------
// Change Log:
// 2026-01-18     R. Zuehlsdorff        Initial creation
//------------------------------------------------------------------------------
 
#pragma once
 
// Include Circle core components
#include <circle/types.h>
#include <circle/koptions.h>
#include <circle/devicenameservice.h>
#include <circle/device.h>
#include <circle/exceptionhandler.h>
#include <circle/interrupt.h>
#include <circle/logger.h>
#include <circle/net/netsubsystem.h>
#include <circle/serial.h>
#include <circle/screen.h>
#include <circle/sched/scheduler.h>
#include <circle/timer.h>
#include <circle/usb/usbhcidevice.h>
#include <circle/nulldevice.h>
#include <SDCard/emmc.h>
#include <fatfs/ff.h>
#include <wlan/bcm4343.h>
#include <wlan/hostap/wpa_supplicant/wpasupplicant.h>
 
// Forward declarations for class references used in this module
class CTWlanLog;
class CTRenderer;
class CTFontConverter;
class CTKeyboard;
class CTConfig;
class CTUART;
class CTFileLog;
class CTSetup;
class CVTTest;
 
#include "hal.h"
 
enum TShutdownMode
{
    ShutdownNone,
    ShutdownHalt,
    ShutdownReboot
};
 
class CKernel
{
public:
    CKernel(void);
    ~CKernel(void);
 
    static CKernel *Get(void);
 
    boolean Initialize(void);
 
    TShutdownMode Run(void);
 
    bool IsTelnetReady() const;
    void MarkTelnetReady();
    void MarkTelnetWaiting();
    void ApplyRuntimeConfig();
 
    void ToggleSetupDialog();
    void ShowModernSetupDialog();
    bool IsLocalModeEnabled() const;
    void ToggleLocalMode();
 
    bool HandleVTTestKey(const char *pString);
 
    void RunVTTestTick();
 
    void SendHostOutput(const char *pData, size_t nLength);
    void HandleWlanHostRx(const char *pData, size_t nLength);
 
protected:
    boolean initFilesystem(void);
 
private:
    void EnsureSerialTaskStarted();
    void ProcessSerial();
 
    // do not change this order - some members depend on others
    CKernelOptions m_Options;
    CDeviceNameService m_DeviceNameService;
    CScreenDevice m_Screen;
    CInterruptSystem m_Interrupt;
    CLogger m_Logger;
    CTimer m_Timer;
    CScheduler m_Scheduler;
    CUSBHCIDevice m_USBHCI;
    CExceptionHandler m_ExceptionHandler;
    CEMMCDevice m_EMMC;
    FATFS m_FileSystem;
    CHAL m_HAL;
    CBcm4343Device m_WLAN;
    CNetSubSystem m_Net;
    CWPASupplicant m_WpaSupplicant;
 
    // Tasks are created inside constructor and
    // initialized in kernel::Initialize()
    CTRenderer *m_pRenderer;
    CTFontConverter *m_pFontConverter;
    CTKeyboard *m_pKeyboard;
    CTConfig *m_pConfig;
    CTUART *m_pUART;
    CTFileLog *m_pFileLog;
    CTWlanLog *m_pWlanLog;
    CTSetup *m_pSetup;
    CVTTest *m_pVTTest;
    CDevice *m_pLogTarget;
    CNullDevice *m_pNullLog;
 
    boolean m_bWlanLoggerEnabled;
    boolean m_bMDNSAdvertised;
    bool m_bSerialTaskStarted;
    bool m_bTelnetReady;
    bool m_bWaitingMessageActive;
    bool m_bWaitingMessageShowsIP;
    bool m_bScreenLoggerEnabled;
    bool m_bLocalModeEnabled;
};