Timer Class Reference

#include <Timer.h>

Public Types
typedef void()	callback_fn()

Public Member Functions
	Timer ()
virtual	~Timer ()
void	init (uint32_t sig_id, uint32_t sim_freq, callback_fn *fn)
void	start (uint32_t frequency)
void	enable ()
bool	enabled ()
void	disable ()
void	setCompare (uint32_t compare)
uint32_t	getCount ()
uint32_t	getCompare ()
uint32_t	getOverruns ()
uint32_t	getAvgError ()
intptr_t	getID ()

Static Public Member Functions
static void	handler (int sig, siginfo_t *si, void *uc)

Detailed Description

Marlin 3D Printer Firmware Copyright (c) 2019 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]

Based on Sprinter and grbl. Copyright (c) 2011 Camiel Gubbels / Erik van der Zalm

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

This program 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 General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Member Typedef Documentation

callback_fn

typedef void() Timer::callback_fn()

Constructor & Destructor Documentation

Timer()

Timer::Timer

(

)

~Timer()

virtual Timer::~Timer ( )

virtual

Member Function Documentation

init()

void Timer::init	(	uint32_t	sig_id,
		uint32_t	sim_freq,
		callback_fn *	fn
	)

start()

void Timer::start

(

uint32_t

frequency

)

enable()

void Timer::enable

(

)

enabled()

bool Timer::enabled

(

)

{return active;}

disable()

void Timer::disable

(

)

setCompare()

void Timer::setCompare

(

uint32_t

compare

)

getCount()

uint32_t Timer::getCount

(

)

getCompare()

uint32_t Timer::getCompare

(

)

{return compare;}

getOverruns()

uint32_t Timer::getOverruns

(

)

{return overruns;}

getAvgError()

uint32_t Timer::getAvgError

(

)

{return avg_error;}

getID()

intptr_t Timer::getID

(

)

                   {
    return (*(intptr_t*)timerid);
  }

handler()

static void Timer::handler ( int  sig, siginfo_t *  si, void *  uc  )

static

                                                       {
    Timer* _this = (Timer*)si->si_value.sival_ptr;
    _this->avg_error += (Clock::nanos() - _this->start_time) - _this->period; //high_resolution_clock is also limited in precision, but best we have
    _this->avg_error /= 2; //very crude precision analysis (actually within +-500ns usually)
    _this->start_time = Clock::nanos(); // wrap
    _this->cbfn();
    _this->overruns += timer_getoverrun(_this->timerid); // even at 50Khz this doesn't stay zero, again demonstrating the limitations
                                                         // using a realtime linux kernel would help somewhat
  }

Here is the call graph for this function: