HardwareTimer.h

/****
 * Sming Framework Project - Open Source framework for high efficiency native ESP8266 development.
 * Created 2015 by Skurydin Alexey
 * http://github.com/anakod/Sming
 * All files of the Sming Core are provided under the LGPL v3 license.
 *
 * HardwareTimer.h
 *
 * Created 23.11.2015 by johndoe
 *
 ****/

#ifndef _SMING_CORE_HARDWARE_TIMER_H_
#define _SMING_CORE_HARDWARE_TIMER_H_

#include "Interrupts.h"
#include "Delegate.h"

#define MAX_HW_TIMER_INTERVAL_US 0x7fffff 
#define MIN_HW_TIMER_INTERVAL_US 0x32    

// Hardware Timer operating mode
enum HardwareTimerMode {
    eHWT_Maskable,
    eHWT_NonMaskable,
};

uint32_t IRAM_ATTR usToTimerTicks(uint32_t us);

uint32_t IRAM_ATTR timerTicksToUs(uint32_t ticks);

class HardwareTimer
{
public:
    HardwareTimer(HardwareTimerMode mode = eHWT_NonMaskable);
    ~HardwareTimer();

    HardwareTimer& IRAM_ATTR initializeUs(uint32_t microseconds,
                                          InterruptCallback callback = nullptr); // Init in Microseconds.

    HardwareTimer& IRAM_ATTR initializeMs(uint32_t milliseconds,
                                          InterruptCallback callback = nullptr); // Init in Milliseconds.

    bool IRAM_ATTR start(bool repeating = true);

    __forceinline bool IRAM_ATTR startOnce()
    {
        return start(false);
    }

    void IRAM_ATTR stop();

    bool IRAM_ATTR restart();

    bool isStarted()
    {
        return started;
    }

    uint32_t getIntervalUs()
    {
        return interval;
    }

    uint32_t getIntervalMs()
    {
        return getIntervalUs() / 1000;
    }

    bool IRAM_ATTR setIntervalUs(uint32_t microseconds);

    __forceinline bool IRAM_ATTR setIntervalMs(uint32_t milliseconds)
    {
        return setIntervalUs(milliseconds * 1000);
    }

    void IRAM_ATTR setCallback(InterruptCallback callback);

    __forceinline void IRAM_ATTR call()
    {
        if(callback != nullptr) {
            callback();
        }
    }

private:
    uint32_t interval = 0;
    InterruptCallback callback = nullptr;
    bool repeating = false;
    bool started = false;
};

class Hardware_Timer : public HardwareTimer
{
};

#endif /* _SMING_CORE_HARDWARE_TIMER_H_ */