PikeAero::CBinaryInputOutputTimer Class Reference

Implements a binary input / output pin wired to a timer. More...

#include <cbinaryinputoutputtimer.h>

Inheritance diagram for PikeAero::CBinaryInputOutputTimer:

[legend]

Collaboration diagram for PikeAero::CBinaryInputOutputTimer:

[legend]

Public Member Functions
	CBinaryInputOutputTimer (CMachine::InterruptVector vector, TIM_TypeDef *TIMx, CMachine::ubit32 freqency=BASE_TIMER_FREQUENCY)
CMachine::ubit16	durationToTicks (CMachine::ubit32 duration)
	Convert a duration in microseconds to a timer duration (compare) value - e.g. nuber of timer ticks.
CMachine::ubit32	frequency ()
	Frequency.
bool	running ()
	Is the timer running.
CMachine::ubit16	setFrequency (CMachine::ubit32 frequency=2000000)
	Calculate the prescaler requred to get the target frequency. Default is 2MHz.
void	start ()
	Start the timer.
void	stop ()
	Stop the timer.
CMachine::real	ticksPerMicroSecond ()
	Retrieve the number of ticks per microsecond.
CMachine::ubit32	ticksToDuration (CMachine::ubit16 ticks)
	Convert ticks to microseconds.
TIM_TypeDef *	tim ()
virtual	~CBinaryInputOutputTimer ()
Private Attributes
CMachine::ubit32	mFrequency
CMachine::ubit32	mFrequencyDiv1K
TIM_TypeDef *	mTIM

---

Detailed Description

Implements a binary input / output pin wired to a timer.

Author:

Michael Sharkey <mike@pikeaero.com>

Definition at line 31 of file cbinaryinputoutputtimer.h.

---

Constructor & Destructor Documentation

PikeAero::CBinaryInputOutputTimer::CBinaryInputOutputTimer	(	CMachine::InterruptVector	vector,
		TIM_TypeDef *	TIMx,
		CMachine::ubit32	freqency = BASE_TIMER_FREQUENCY
	)

Initialize the control registers

Set the Prescaler

Definition at line 24 of file cbinaryinputoutputtimer.cpp.

References PikeAero::TIM_TypeDef::CR1, PikeAero::TIM_TypeDef::CR2, setFrequency(), and tim().

: CObject()
, mFrequency(frequency)
, mTIM(TIMx)
{
    /** Initialize the control registers */
    tim()->CR2 = 0;
    tim()->CR1 = 0;

    /** Set the Prescaler */
    setFrequency( frequency );

}

Here is the call graph for this function:

PikeAero::CBinaryInputOutputTimer::~CBinaryInputOutputTimer

(

)

[virtual]

Definition at line 43 of file cbinaryinputoutputtimer.cpp.

{
}

---

Member Function Documentation

CMachine::ubit16 PikeAero::CBinaryInputOutputTimer::durationToTicks

(

CMachine::ubit32

duration

)

[inline]

Convert a duration in microseconds to a timer duration (compare) value - e.g. nuber of timer ticks.

Definition at line 66 of file cbinaryinputoutputtimer.h.

References ticksPerMicroSecond().

Referenced by PikeAero::CFuelInjector::setOnTime(), and PikeAero::CFuelInjector::setTurnOnTime().

{return (CMachine::ubit16)(((CMachine::real)duration)/ticksPerMicroSecond());}

Here is the call graph for this function:

Here is the caller graph for this function:

CMachine::ubit32 PikeAero::CBinaryInputOutputTimer::frequency

(

)

[inline]

Frequency.

Definition at line 60 of file cbinaryinputoutputtimer.h.

References mFrequency.

Referenced by PikeAero::CTaskAggregator::calculateRPM(), and ticksPerMicroSecond().

{return mFrequency;}

Here is the caller graph for this function:

bool PikeAero::CBinaryInputOutputTimer::running

(

)

[inline]

Is the timer running.

Definition at line 50 of file cbinaryinputoutputtimer.h.

References tim(), and TIM_EN.

{return (tim()->CR1 & TIM_EN) != 0;}

Here is the call graph for this function:

CMachine::ubit16 PikeAero::CBinaryInputOutputTimer::setFrequency

(

CMachine::ubit32

frequency = 2000000

)

Calculate the prescaler requred to get the target frequency. Default is 2MHz.

Parameters:

frequency

The target frequency expressed in Hz.

Returns:

The prescaler value.

Definition at line 52 of file cbinaryinputoutputtimer.cpp.

References PikeAero::TIM_TypeDef::CR2, PikeAero::CMachine::fMCLK(), mFrequency, mFrequencyDiv1K, and tim().

Referenced by CBinaryInputOutputTimer().

{
    mFrequency = frequency;
    mFrequencyDiv1K = mFrequency/1000;
    tim()->CR2 &= 0xFF00;
    tim()->CR2 |= ( 0x00FF &  ( ( CMachine::fMCLK() / mFrequency ) - 1 ) );
    return (tim()->CR2 & 0x00FF);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void PikeAero::CBinaryInputOutputTimer::start

(

)

[inline]

Start the timer.

Definition at line 44 of file cbinaryinputoutputtimer.h.

References PikeAero::TIM_TypeDef::CR1, tim(), and TIM_EN.

Referenced by PikeAero::CBinaryInputCapture::CBinaryInputCapture(), PikeAero::CFuelInjector::fire(), and PikeAero::CFuelInjector::irq().

{tim()->CR1 |= TIM_EN;}

Here is the call graph for this function:

Here is the caller graph for this function:

void PikeAero::CBinaryInputOutputTimer::stop

(

)

[inline]

Stop the timer.

Definition at line 47 of file cbinaryinputoutputtimer.h.

References PikeAero::TIM_TypeDef::CR1, tim(), and TIM_EN.

Referenced by PikeAero::CFuelInjector::irq().

{tim()->CR1 &= ~TIM_EN;}

Here is the call graph for this function:

Here is the caller graph for this function:

CMachine::real PikeAero::CBinaryInputOutputTimer::ticksPerMicroSecond

(

)

[inline]

Retrieve the number of ticks per microsecond.

Definition at line 63 of file cbinaryinputoutputtimer.h.

References frequency().

Referenced by durationToTicks().

{return (CMachine::real)frequency() / 1000000.0;}

Here is the call graph for this function:

Here is the caller graph for this function:

CMachine::ubit32 PikeAero::CBinaryInputOutputTimer::ticksToDuration

(

CMachine::ubit16

ticks

)

[inline]

Convert ticks to microseconds.

Definition at line 69 of file cbinaryinputoutputtimer.h.

References mFrequencyDiv1K.

Referenced by PikeAero::CInputTimingToothCounter::irq().

{return ((mFrequencyDiv1K*ticks)/1000);}

Here is the caller graph for this function:

TIM_TypeDef* PikeAero::CBinaryInputOutputTimer::tim

(

)

[inline]

Definition at line 41 of file cbinaryinputoutputtimer.h.

References mTIM.

Referenced by PikeAero::CBinaryInputCapture::CBinaryInputCapture(), CBinaryInputOutputTimer(), PikeAero::CFuelInjector::CFuelInjector(), PikeAero::CBinaryInputCapture::disableInterruptsA(), PikeAero::CBinaryInputCapture::disableInterruptsB(), PikeAero::CBinaryInputCapture::enableInterruptsA(), PikeAero::CBinaryInputCapture::enableInterruptsB(), PikeAero::CFuelInjector::fire(), PikeAero::CFuelInjector::irq(), PikeAero::CBinaryInputCapture::irq(), running(), setFrequency(), start(), and stop().

{return mTIM;}

Here is the caller graph for this function:

---

Field Documentation

CMachine::ubit32 PikeAero::CBinaryInputOutputTimer::mFrequency [private]

Definition at line 72 of file cbinaryinputoutputtimer.h.

Referenced by frequency(), and setFrequency().

CMachine::ubit32 PikeAero::CBinaryInputOutputTimer::mFrequencyDiv1K [private]

Timer frequency

Definition at line 73 of file cbinaryinputoutputtimer.h.

Referenced by setFrequency(), and ticksToDuration().

TIM_TypeDef* PikeAero::CBinaryInputOutputTimer::mTIM [private]

Frequency divided by 1000 [optimization so we don't divide each time ]

Definition at line 74 of file cbinaryinputoutputtimer.h.

Referenced by tim().

---

The documentation for this class was generated from the following files:

• cbinaryinputoutputtimer.h
• cbinaryinputoutputtimer.cpp