Timer.h

Go to the documentation of this file.

#include <stddef.h>
#include <stdint.h>
 
typedef uint32_t clk_t;
typedef uint16_t pre_t;
 
#ifndef ssize_t
typedef int32_t ssize_t;
#endif
 
enum struct TimerRc : uint8_t {
    Okay,            /* !< Operation successful. */
    ImpossibleClock, /* !< Clock rate cannot be achieved with parameters.*/
    ZeroDiv,         /* !< Operation would cause divide by zero error. */
    ErrorRange,      /* !< Invalid range of values.  */
    TooLow,          /* !< Value is too hgih for range. */
    TooHigh,         /* !< Value is too low for range. */
};
 
const char* error_str(TimerRc rc);
 
enum struct Skew : uint8_t {
    Low,  /* !< Prefer a lower clock rate. */
    High, /* !< Prefer a higher clock rate. */
    None, /* !< No preference. */
};
 
struct TimerConfig {
    pre_t prescaler;
    clk_t compare;
    clk_t src;
    clk_t desired;
    Skew skew;
    clk_t actual;
    double error;
 
    TimerConfig(clk_t src_clock, clk_t desired_clock, Skew preference)
        : src(src_clock), desired(desired_clock), skew(preference) {}
 
    TimerRc compute(size_t nprescalers, pre_t* prescalers, clk_t max_compare,
                    double max_error);
 
    void pprint();
};
 
TimerRc activate_t1(TimerConfig& cfg);
 
void deactivate_t1();