HiResTimer.h

/*NB_REVISION*/
 
/*NB_COPYRIGHT*/
 
/* Select the card type */
#ifndef _HIRESTIMER_H
#define _HIRESTIMER_H
 
#include <limits.h>
#include <nbrtos.h>
#include <sim.h>
#include <stdio.h>
 
#define LOGME                                                        \
    iprintf("We got to line %d in file %s\r\n", __LINE__, __FILE__); \
    OSTimeDly(2);
 
#define DEFAULT_TIMER -1
#define TIMER_COUNT 4
#define TIMER_RELEASED 2
 
// Clock speed macros
extern unsigned long CPU_CLOCK;
#define NB_CPU_CLK (CPU_CLOCK / 2)
 
#define TIME_PER_CLK (1.0 / NB_CPU_CLK)
 
class HiResTimer
{
    static HiResTimer timers[TIMER_COUNT];
    static uint8_t timerCreated[TIMER_COUNT];
 
    int timer_;                        // Timer number
    volatile timerstruct *simTimer_;   // Timer struct from sim.h
    volatile int prescaler_;           // The value of the hardware prescaler
    volatile uint32_t resetCount_;     // Holds the count of the timer resets
    OS_SEM delaySem_;                  // OS semaphore struct
    uint32_t firstInit_;               // Have we set up this timer before ?
    volatile uint32_t delayCalled_;    // Is the timer being used for a delay?
 
    // The method that will be called when the timer triggers an interupt
    void (*interruptFunction_)();
 
    // Disable construction and copy construction
    HiResTimer(){};
    HiResTimer(const HiResTimer &from){};
    HiResTimer &operator=(const HiResTimer &from);
    // Only actual constructor
    HiResTimer(int timer);
    ~HiResTimer(){};
 
    // Fire the object's interrupt method
    void fireInterrupt();
 
   public:
    // class function to fire the interrupt function for the given timer
    // called by the Interrupt macro routine
    static void fireInterrupt(int timer);
 
    void init(double InterruptTime = 0);   // Initializes the timer for use
    void init_ticks(uint32_t ReferenceTicks, int prescale = 0);
 
    /*
     * Starts the selected timer. The user MUST call HiResTimerInit for the given timer
     * before calling this method.
     */
    inline void start()
    {
        // Setting the CLK bits to 01 on the DTMR register, starting the timer
#ifdef MOD5213
        simTimer_->dtmr |= 0x2;
#else
        simTimer_->tmr |= 0x2;
#endif
    };
 
    inline uint32_t readHigh() { return resetCount_; };   // Reads the number of timer overflows/resets/interrupts
    inline uint32_t readLow()
    {
        // Reads the timer register value
#ifdef MOD5213
        return simTimer_->dtcn;
#else
        return simTimer_->tcn;
#endif
    };
    inline int getPrescaler() { return prescaler_; };   // Returns the value of the prescaler
    double readTime();                                  // Ouputs the number of seconds since the timer was started
 
    inline void stop()
    {
        // Stops the timer
        simTimer_->tmr &= ~(0x6);
    };
 
    inline void stopClear()
    {
        simTimer_->tmr &= ~(0x6);
        simTimer_->tcn = 0x0;
        simTimer_->ter = 0x3;
        resetCount_ = 0;
    }
 
    void delay(
        double DelayTime);   // Starts a precise delay that will switch tasks while waiting (Do not use for shorter than ~150 useconds)
    void delay_uSec(uint32_t DelayTime);   // Starts a precise delay that will switch tasks while waiting
    void pollingDelay(double DelayTime);   // Starts a precise delay that will busy wait
    inline void pollingDelay_uSec(uint32_t delayTime)
    {
        if (delayTime < (INT_MAX / NB_CPU_CLK)) { pollingDelay_refTicks(delayTime * NB_CPU_CLK / 1000000UL); }
        else
        {
            pollingDelay_refTicks(delayTime >> 2 * (NB_CPU_CLK / 250000UL));
        }
    }
    void pollingDelay_refTicks(uint32_t ticks);
 
    void clockGenerator(double Frequency);   // Set up a clock at the chosen frequency
 
    inline void setInterruptFunction(void (*interruptFunction)())
    {
        interruptFunction_ = interruptFunction;
    };                                                                     // Set the method to be called on interrupt triggers
    inline void clearInterruptFunction() { interruptFunction_ = NULL; };   // Clear the interrupt method
 
    char *toString();   // Converts the timer object to a printable c string
 
    // Returns a pointer for the given timer number, returns NULL if the timer does not exist
    static HiResTimer *getHiResTimer(int timer = DEFAULT_TIMER);
    void releaseTimer();
 
    int getTimerNumber() { return timer_; }
};
 
#endif /* _HIRESTIMER_H */