blob: 78f8d9c1853bd0ed56a71e3a2005cb9384f9c241 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
/**
* @file rtems/btimer.h
*
* @brief RTEMS Benchmark Timer API for all Boards
*/
/*
* COPYRIGHT (c) 2011 Ralf Corsépius Ulm/Germany
*
* Derived from libcsupport/include/timerdrv.h:
*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.org/license/LICENSE.
*/
/*
* All the functions declared as extern after this comment
* MUST be implemented in each BSP.
*/
#ifndef _RTEMS_BTIMER_H
#define _RTEMS_BTIMER_H
#include <stdbool.h>
#include <stdint.h>
#include <rtems/rtems/status.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @defgroup BenchmarkTimer Benchmark Timer Driver Interface
*
* This module defines the interface for the Benchmark Timer Driver.
*
* The following methods in this module must be provided by each BSP:
*
* - benchmark_timer_initialize
* - benchmark_timer_read
* - benchmark_timer_disable_subtracting_average_overhead
*
* The units measured are BSP specific but should be at the highest
* granularity possible.
*
* The Benchmark Timer may use the same hardware as the Clock Driver.
* No RTEMS Timing Tests will use both drivers at the same time.
*/
/**
* @brief This type is used to return a Benchmark Timer value.
*
* This type is used to contain benchmark times. The units are BSP specific.
*/
typedef uint32_t benchmark_timer_t;
/**
* @brief Initialize the Benchmark Timer
*
* This method initializes the benchmark timer and resets it to begin
* counting.
*/
extern void benchmark_timer_initialize( void );
/**
* @brief Read the Benchmark Timer
*
* This method stops the benchmark timer and returns the number of
* units that have passed since @a benchmark_timer_initialize was invoked.
*
* @return This method returns the number of units with the average overhead
* removed. If the value is below the minimum trusted value, zero
* is returned.
*/
extern benchmark_timer_t benchmark_timer_read( void );
/**
* @brief Benchmark Timer Empty Function
*
* This method is used to determine loop overhead.
*/
extern rtems_status_code benchmark_timer_empty_function( void );
/**
* @brief 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 @a benchmark_timer_initialize and @a benchmark_timer_read
* counting.
*
* @param[in] find_flag indicates to enable or disable the mode
*/
extern void benchmark_timer_disable_subtracting_average_overhead(
bool find_flag
);
/**@}*/
#ifdef __cplusplus
}
#endif
#endif
|
