SFBTicker.h

Go to the documentation of this file.

/*                                             -*- mode:C++; fill-column:100 -*-
  SFBTicker.h - A basic 'where do the usec go?' profiling system
  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 SFBTICKER_H_
#define SFBTICKER_H_

#include "SFBTypes.h"
#include "SFBHWPins.h"
#include "SFBHWMisc.h"          // For suspendInterrupts

enum SFBTickerCategories {
  TICKER_BACKGROUND,      

  TICKER_SERIAL_ISR,      

  TICKER_OTHER_ISR,       

  TICKER_PACKET_HANDLER,  

  TICKER_ALARM_HANDLER,   

  TICKER_SKETCH0,         

  TICKER_SKETCH1,         

  TICKER_SKETCH2,         

  MAX_TICKERS
};

class SFBTicker {
 public:

  inline void pushTime(u32 code) {
    u32 var;
    suspendInterrupts(var);
    pushTimeISR(code);
    restoreInterrupts(var);
  }

  inline void popTime() {
    u32 var;
    suspendInterrupts(var);
    popTimeISR();
    restoreInterrupts(var);
  }

  inline void pushTimeISR(u32 code) {
    u32 was = top();
    push(code);
    switchCode(was,top());
  }

  inline void popTimeISR() {
    u32 was = top();
    pop();
    switchCode(was,top());
  }

  u32 getUsec(u32 category) ;

  u32 getTotalUsec() { return micros()-startUsec; }

  void reset(u32 intoState = TICKER_BACKGROUND) ;

private:
  u32 totalUsec[MAX_TICKERS];
  u32 enterUsec[MAX_TICKERS];
  u32 startUsec;
  u32 stack;
  enum {
    BITS = 3,
    MASK = (1<<BITS)-1
  };
  inline u32 crop(u32 code) { return code&MASK; }
  inline void push(u32 code) { stack = (stack<<BITS)|crop(code); }
  inline void pop() { stack >>= BITS; }
  inline u32 top() { return crop(stack); }
  inline void switchCode(u32 from, u32 to) {
    u32 now = micros();
    totalUsec[from] += now - enterUsec[from]; 
    enterUsec[to] = now;
  }
};

extern SFBTicker Ticker;

class SFBProfile {
public:

  u32 getMsec(u32 tickerCode) ;

  u32 getPPM(u32 tickerCode) ;

  u32 getTotalMsec() ;

  void begin() ;

  void end() ;

private:
  friend void updateProfile(u32 when, void * arg);
  void update(u32 when);
  u32 totalMsec[MAX_TICKERS];
  u32 totalTime;
  u8 alarmNumber;
};

extern SFBProfile Profile;
#endif /* SFBTICKER_H_ */