1 files changed, 108 insertions, 0 deletions
diff --git a/include/rtems/btimer.h b/include/rtems/btimer.h
new file mode 100644
index 0000000000..78f8d9c185
--- /dev/null
+++ b/include/rtems/btimer.h
@@ -0,0 +1,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