btimer.c File Reference

Implement a benchmark timer using timer 2. More...

#include <bsp.h>
#include <rtems/btimer.h>

Macros
#define	AVG_OVERHEAD   3 /* It typically takes 3.0 microseconds */
#define	LEAST_VALID   2 /* Don't trust a value lower than this */

Functions
void	benchmark_timer_initialize (void)
	Initialize the Benchmark Timer.
benchmark_timer_t	benchmark_timer_read (void)
	Read the Benchmark Timer.
void	benchmark_timer_disable_subtracting_average_overhead (bool find_flag)
	Disable Average Overhead Removal from the Benchmark Timer.

Variables
bool	benchmark_timer_find_average_overhead
bool	benchmark_timer_is_initialized = false

Detailed Description

Implement a benchmark timer using timer 2.

Function Documentation

benchmark_timer_disable_subtracting_average_overhead()

void benchmark_timer_disable_subtracting_average_overhead

(

bool

find_flag

)

Disable Average Overhead Removal from the Benchmark Timer.

This method places the benchmark timer in a "raw" mode where it returns the actual number of units which have passed between calls to benchmark_timer_initialize and benchmark_timer_read counting.

Parameters

[in]

find_flag

indicates to enable or disable the mode

benchmark_timer_initialize()

void benchmark_timer_initialize

(

void

)

Initialize the Benchmark Timer.

This method initializes the benchmark timer and resets it to begin counting.

benchmark_timer_read()

benchmark_timer_t benchmark_timer_read

(

void

)

Read the Benchmark Timer.

This method stops the benchmark timer and returns the number of units that have passed since benchmark_timer_initialize was invoked.

Returns

This method returns the number of units with the average overhead removed. If the value is below the minimum trusted value, zero is returned.