freertos_timer.hpp

Go to the documentation of this file.

 
#ifndef ELEC_C7222_UTILS_FREE_RTOS_TIMER_HPP
#define ELEC_C7222_UTILS_FREE_RTOS_TIMER_HPP
 
#include <cstdint>
#include <functional>
 
#include "non_copyable.hpp"
 
namespace c7222 {
 
void FreeRtosTimerCallback(void* timer);
 
class FreeRtosTimer : public NonCopyableNonMovable {
  public:
    enum class Type : uint8_t {
        kOneShot,
        kPeriodic
    };
 
    FreeRtosTimer() = default;
    FreeRtosTimer(const char* name,
                  std::uint32_t period_ticks,
                  Type type,
                  std::function<void(void*)> callback = nullptr);
 
    bool Initialize(const char* name,
                    std::uint32_t period_ticks,
                    Type type,
                    std::function<void(void*)> callback);
 
    ~FreeRtosTimer();
 
    bool Start(std::uint32_t ticks_to_wait = 0, void* callback_arg = nullptr);
    bool StartFromISR(void* callback_arg = nullptr);
    bool Stop(std::uint32_t ticks_to_wait = 0);
 
    bool StopFromISR();
    bool Reset(std::uint32_t ticks_to_wait = 0);
 
    bool ResetFromISR();
    bool ChangePeriod(std::uint32_t period_ticks, std::uint32_t ticks_to_wait = 0);
 
    bool ChangePeriodFromISR(std::uint32_t period_ticks);
 
    void SetCallback(std::function<void(void*)> callback);
 
    bool IsValid() const;
 
    bool IsActive() const;
 
  private:
    friend void FreeRtosTimerCallback(void* timer);
 
    void* handle_{nullptr};
    std::function<void(void*)> callback_{nullptr};
    void* callback_arg_{nullptr};
};
 
} // namespace c7222
 
#endif // ELEC_C7222_UTILS_FREE_RTOS_TIMER_HPP