DeviceBeginCommon.hpp

Go to the documentation of this file.

 
#pragma once
#include "../../SensorPlatform.hpp"
#include "../SensorCommWrapper.hpp"
 
class DeviceBeginCommon : public SensorCommWrapper
{
public:
    virtual ~DeviceBeginCommon()
    {
        if (comm) {
            comm->deinit();
        }
    }
 
    uint8_t getAddress() const
    {
        return _addr;
    }
    uint8_t getInterface() const
    {
        return _iface;
    }
 
protected:
    DeviceBeginCommon() = default;
 
    virtual bool initImpl(uint8_t param) = 0;
 
    virtual bool ensureValid() const override
    {
        if (!comm) return false;
        return true;
    }
 
    virtual SensorCommBase *getComm() const override
    {
        return comm.get();
    }
 
    // ---- Hooks functions  ----
 
    // 1) Before comm/hal/staticComm is created (some parameters can be prepared).
    virtual void beforeBegin() {}
 
    // 2) comm/hal/staticComm has been created + comm->init() has been completed,
    //    but initImpl has not yet run
    //    Typical use case: Touch driver sets hal->setCustomMode/Read/Write
    virtual void afterCommReady() {}
 
    // 3) initImpl has succeeded (default register configuration, cache reset, etc. can be done here)
    virtual void afterInitSuccess(uint8_t param) {}
 
    // 4) If any begin operation fails (error code can be logged).
    virtual void onBeginFail() {}
 
    // 5) Unified fail handling to ensure consistent error paths for each begin branch
    bool fail()
    {
        onBeginFail();
        return false;
    }
 
    void clearCommState()
    {
        staticComm.reset();
        if (comm) {
            comm->deinit();
        }
        comm.reset();
        hal.reset();
        _addr = 0;
        _iface = COMM_CUSTOM;
    }
 
    template<typename CreateComm>
    bool beginLifecycle(uint8_t addr, uint8_t iface, uint8_t initParam, CreateComm createComm)
    {
        beforeBegin();
        if (!createComm()) {
            clearCommState();
            return fail();
        }
 
        _addr = addr;
        _iface = iface;
        afterCommReady();
 
        if (!initImpl(initParam)) {
            clearCommState();
            return fail();
        }
 
        afterInitSuccess(initParam);
        return true;
    }
 
protected:
    std::unique_ptr<SensorCommBase>   comm;
    std::unique_ptr<SensorHal>        hal;
    std::unique_ptr<SensorCommStatic> staticComm;
 
    uint8_t _addr  = 0;
    uint8_t _iface = COMM_CUSTOM;
};