RTEMS Benchmark Timer API for all Boards. More...

#include <stdbool.h>
#include <stdint.h>
#include <rtems/rtems/status.h>

Typedefs
typedef uint32_t	benchmark_timer_t
	This type is used to return a Benchmark Timer value.

Functions
void	benchmark_timer_initialize (void)
	Initialize the Benchmark Timer.

benchmark_timer_t	benchmark_timer_read (void)
	Read the Benchmark Timer.

rtems_status_code	benchmark_timer_empty_function (void)
	Benchmark Timer Empty Function.

void	benchmark_timer_disable_subtracting_average_overhead (bool find_flag)
	Disable Average Overhead Removal from the Benchmark Timer.

Detailed Description

RTEMS Benchmark Timer API for all Boards.

Typedef Documentation

◆ benchmark_timer_t

typedef uint32_t benchmark_timer_t

This type is used to return a Benchmark Timer value.

This type is used to contain benchmark times. The units are BSP specific.

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_empty_function()

rtems_status_code benchmark_timer_empty_function ( void )

Benchmark Timer Empty Function.

This method is used to determine loop overhead.

◆ 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.

Typedefs

Functions