SFBHWTimer.h

Go to the documentation of this file.

/*                                              -*- mode:C++; fill-column:100 -*-
  SFBHWTimer.h Support for h/w-based timer interrupts
  Copyright (C) 2009 The Regents of the University of New Mexico.  All rights reserved.

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
  USA
*/

#ifndef SFBHWTIMER_H_
#define SFBHWTIMER_H_

#include "SFBTypes.h"

typedef void (*HWTimerHandler)() ;

class SFBHWTimer {
public:
  void begin(u32 usecsPerTick = 1000, u32 ticksPerLap = 1000, bool running = false) ;

  void end();

  void setTickTime(u32 usecsPerTick) ;

  void setRunning(bool isRunning);

  void start() { setRunning(true); }

  void stop() { setRunning(false); }

  void reset(bool alsoStop = false) ;

  void setLap(u32 ticksPerLap) ;

  u32 getLap() ;

  void setLapHandler(HWTimerHandler handler) ;

  void setSplitHandler(u32 splitIndex, u32 ticks, HWTimerHandler handler) ;

  void setSplit(u32 splitIndex, u32 ticks) ;

  u32 getSplit(u32 splitIndex) ;

  HWTimerHandler getSplitHandler(u32 splitIndex) ;

  HWTimerHandler getLapHandler() ;

  static u32 getSplitIndex() { return currentMatchIndex; }

  u32 getLaps() { return lapCounter; }

  u32 getTicks() ;

  SFBHWTimer(u8 index) ;

  void reinitForPCLK() ;

private:
  void interruptHandler() ;
  void configurePCLK() ;
  static u32 currentMatchIndex;

  friend void Timer0Handler() ;
  friend void Timer1Handler() ;
  friend void Timer2Handler() ;
  friend void Timer3Handler() ;
  friend void Timer4Handler() ;

  /* \endcond */

  HWTimerHandler handlers[4];   // For each of the four match registers
  u32 usecsPerTick;             // Number of usecs per clock tick, or zero if timer not in use
  u32 lapCounter;               // Total number of clock laps since reset
  const u8 index;               // index of this timer into TimerInfo array
};

extern SFBHWTimer Timers[5];    
extern SFBHWTimer & Timer1;     
extern SFBHWTimer & Timer2;     
extern SFBHWTimer & Timer3;     
extern SFBHWTimer & Timer4;     

#endif /*SFBHWTIMER_H_*/