IWatchdog.hpp

Go to the documentation of this file.

/**************************************************************************************
 * @file IWatchdog.hpp
 * 
 * Interface for watchdog peripherals in the ZephyrCppToolkit library.
 *  
 **************************************************************************************
 * 
 * Copyright 2025 Electronic Timers Ltd.
 * 
 **************************************************************************************/
 
#pragma once
 
// System includes
#include <functional>
#include <cstdint>
 
namespace zct {
 
class IWatchdog {
public:
    enum class Option : uint8_t {
        None = 0,
        PauseInSleep = 1,           
        PauseHaltedByDebug = 2      
    };
 
    enum class ResetFlag : uint8_t {
        None = 0,
        ResetCpuCore = 1,           
        ResetSoc = 2                
    };
 
    using CallbackFn = std::function<void(int channelId, void* userData)>;
 
    IWatchdog(const char* name);
 
    virtual ~IWatchdog() = default;
 
    virtual int installTimeout(uint32_t timeoutMs, 
                              CallbackFn callback = nullptr,
                              void* userData = nullptr,
                              ResetFlag flags = ResetFlag::ResetSoc) = 0;
 
    virtual int setup(Option options = Option::None) = 0;
 
    virtual int feed(int channelId) = 0;
 
    virtual int disable() = 0;
 
    const char* getName() const { return m_name; }
 
    virtual const struct device* getRawDevice() const = 0;
 
protected:
    const char* m_name;     
};
 
constexpr IWatchdog::Option operator|(IWatchdog::Option lhs, IWatchdog::Option rhs) {
    return static_cast<IWatchdog::Option>(static_cast<uint8_t>(lhs) | static_cast<uint8_t>(rhs));
}
 
constexpr IWatchdog::Option operator&(IWatchdog::Option lhs, IWatchdog::Option rhs) {
    return static_cast<IWatchdog::Option>(static_cast<uint8_t>(lhs) & static_cast<uint8_t>(rhs));
}
 
} // namespace zct