Use correct prototype of benchmark_timer_read()

This change starts with removing the effectively empty file
timerdrv.h. The prototypes for benchmark_timer_XXX() were in
btimer.h which was not universally used. Thus every use of
timerdrv.h had to be changed to btimer.h. Then the prototypes
for benchmark_timer_read() had to be adjusted to return
benchmark_timer_t rather than int or uint32_t.

I took this opportunity to also correct the file headers to
separate the copyright from the file description comments which
is needed to ensure the copyright isn't propagated into Doxygen
output.

5 files changed, 58 insertions, 80 deletions

diff --git a/c/src/lib/libcpu/arm/at91rm9200/timer/timer.c b/c/src/lib/libcpu/arm/at91rm9200/timer/timer.c
index 2ae7bb6517..c65dd8096a 100644
--- a/c/src/lib/libcpu/arm/at91rm9200/timer/timer.c
+++ b/c/src/lib/libcpu/arm/at91rm9200/timer/timer.c
@@ -1,26 +1,21 @@
-/*
- * Cogent CSB337 Timer driver
+/**
+ * @file
+ * @brief Cogent CSB337 Timer driver
  *
  * This uses timer 0 for timing measurments.
- *
- * Copyright (c) 2004 by Jay Monkman <jtm@lopingdog.com>
+ */
+
+/*
+ *  Copyright (c) 2004 by Jay Monkman <jtm@lopingdog.com>
  *
  *  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.
- *
- * Notes:
- *  This file manages the benchmark timer used by the RTEMS Timing Test
- *  Suite.  Each measured time period is demarcated by calls to
- *  benchmark_timer_initialize() and benchmark_timer_read().  benchmark_timer_read() usually returns
- *  the number of microseconds since benchmark_timer_initialize() exitted.
- *
- *  It is important that the timer start/stop overhead be determined
- *  when porting or modifying this code.
  */
 
-#include <rtems.h>
 #include <bsp.h>
+#include <rtems.h>
+#include <rtems/btimer.h>
 #include <at91rm9200.h>
 #include <at91rm9200_pmc.h>
 
@@ -63,7 +58,7 @@ void benchmark_timer_initialize( void )
                              /* This value is in microseconds. */
 #define LEAST_VALID       1  /* Don't trust a clicks value lower than this */
 
-int benchmark_timer_read( void )
+benchmark_timer_t benchmark_timer_read( void )
 {
   uint16_t t;
   uint32_t total;
diff --git a/c/src/lib/libcpu/arm/lpc22xx/timer/timer.c b/c/src/lib/libcpu/arm/lpc22xx/timer/timer.c
index 10449ee87f..ad73aeda3c 100644
--- a/c/src/lib/libcpu/arm/lpc22xx/timer/timer.c
+++ b/c/src/lib/libcpu/arm/lpc22xx/timer/timer.c
@@ -1,28 +1,24 @@
-/*
- * RTL22xx board Timer driver
+/**
+ * @file
+ * @brief RTL22xx board Timer driver
  *
  * This uses Timer1 for timing measurments.
+ */
+
+/*
+ * By Ray Xu <rayx.cn@gmail.com>, modify form Mc9328mxl RTEMS DSP
  *
- *  By Ray xu<rayx.cn@gmail.com>, modify form Mc9328mxl	RTEMS DSP
- *
- *  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.
- *
- * Notes:
- *  This file manages the benchmark timer used by the RTEMS Timing Test
- *  Suite.  Each measured time period is demarcated by calls to
- *  benchmark_timer_initialize() and benchmark_timer_read().  benchmark_timer_read() usually returns
- *  the number of microseconds since benchmark_timer_initialize() exitted.
- *
- *  It is important that the timer start/stop overhead be determined
- *  when porting or modifying this code.
-*/
+ * 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.
+ */
 
-#include <rtems.h>
 #include <bsp.h>
+#include <rtems.h>
+#include <rtems/btimer.h>
 #include <lpc22xx.h>
 #include "lpc_timer.h"
+
 uint32_t g_start;
 uint32_t g_freq;
 
@@ -52,7 +48,7 @@ void benchmark_timer_initialize( void )
                              /* This value is in microseconds. */
 #define LEAST_VALID       1  /* Don't trust a clicks value lower than this */
 
-int benchmark_timer_read( void )
+benchmark_timer_t benchmark_timer_read( void )
 {
   return (T0TC/(LPC22xx_Fpclk/1000000));
   /*
diff --git a/c/src/lib/libcpu/arm/mc9328mxl/timer/timer.c b/c/src/lib/libcpu/arm/mc9328mxl/timer/timer.c
index 4ddd289e83..66ff4a0bf4 100644
--- a/c/src/lib/libcpu/arm/mc9328mxl/timer/timer.c
+++ b/c/src/lib/libcpu/arm/mc9328mxl/timer/timer.c
@@ -1,27 +1,22 @@
-/*
- * Cogent CSB336 Timer driver
+/**
+ *  @file
+ *  @brief Cogent CSB336 Timer driver
  *
  * This uses timer 2 for timing measurments.
- *
+ */
+
+/*
  * Copyright (c) 2004 Cogent Computer Systems
  *        Written by Jay Monkman <jtm@lopingdog.com>
  *
  *  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.
- *
- * Notes:
- *  This file manages the benchmark timer used by the RTEMS Timing Test
- *  Suite.  Each measured time period is demarcated by calls to
- *  benchmark_timer_initialize() and benchmark_timer_read().  benchmark_timer_read() usually returns
- *  the number of microseconds since benchmark_timer_initialize() exitted.
- *
- *  It is important that the timer start/stop overhead be determined
- *  when porting or modifying this code.
-*/
+ */
 
 #include <rtems.h>
 #include <bsp.h>
+#include <rtems/btimer.h>
 #include <mc9328mxl.h>
 
 uint32_t g_start;
@@ -62,7 +57,7 @@ void benchmark_timer_initialize( void )
                              /* This value is in microseconds. */
 #define LEAST_VALID       1  /* Don't trust a clicks value lower than this */
 
-int benchmark_timer_read( void )
+benchmark_timer_t benchmark_timer_read( void )
 {
   uint32_t t;
   unsigned long long total;
diff --git a/c/src/lib/libcpu/arm/pxa255/timer/timer.c b/c/src/lib/libcpu/arm/pxa255/timer/timer.c
index de555b4587..7eb3d5b811 100644
--- a/c/src/lib/libcpu/arm/pxa255/timer/timer.c
+++ b/c/src/lib/libcpu/arm/pxa255/timer/timer.c
@@ -1,23 +1,20 @@
+/**
+ * @file
+ * @brief PXA255 timer
+ */
+
 /*
  * PXA255 timer by Yang Xi <hiyangxi@gmail.com>
  * Copyright (c) 2004 by Jay Monkman <jtm@lopingdog.com>
  *
- * Notes:
- *  This file manages the benchmark timer used by the RTEMS Timing Test
- *  Suite.  Each measured time period is demarcated by calls to
- *  Timer_initialize() and Read_timer().  Read_timer() usually returns
- *  the number of microseconds since Timer_initialize() exitted.
- *
- *  It is important that the timer start/stop overhead be determined
- *  when porting or modifying this code.
- *
- *  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.
+ * 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.
  */
 
-#include <rtems.h>
 #include <bsp.h>
+#include <rtems.h>
+#include <rtems/btimer.h>
 #include <pxa255.h>
 
 uint32_t tstart;
@@ -51,7 +48,7 @@ void benchmark_timer_initialize(void)
                              /* This value is in microseconds. */
 #define LEAST_VALID       1  /* Don't trust a clicks value lower than this */
 
-int benchmark_timer_read(void)
+benchmark_timer_t benchmark_timer_read(void)
 {
 
   uint32_t total;
diff --git a/c/src/lib/libcpu/arm/s3c24xx/timer/timer.c b/c/src/lib/libcpu/arm/s3c24xx/timer/timer.c
index 6166c745eb..2bc599df75 100644
--- a/c/src/lib/libcpu/arm/s3c24xx/timer/timer.c
+++ b/c/src/lib/libcpu/arm/s3c24xx/timer/timer.c
@@ -1,24 +1,19 @@
-/*
- * S3C2400 Timer driver
+/**
+ * @file
+ * @brief S3C2400 Timer driver
  *
  * This uses timer 1 for timing measurments.
- *
- *  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.
- *
- * Notes:
- *  This file manages the benchmark timer used by the RTEMS Timing Test
- *  Suite.  Each measured time period is demarcated by calls to
- *  benchmark_timer_initialize() and benchmark_timer_read().  benchmark_timer_read() usually returns
- *  the number of microseconds since benchmark_timer_initialize() exitted.
- *
- *  It is important that the timer start/stop overhead be determined
- *  when porting or modifying this code.
-*/
+ */
+
+/*
+ * 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.
+ */
 
-#include <rtems.h>
 #include <bsp.h>
+#include <rtems.h>
+#include <rtems/btimer.h>
 #include <s3c24xx.h>
 
 uint32_t g_start;
@@ -69,7 +64,7 @@ void benchmark_timer_initialize( void )
                              /* This value is in microseconds. */
 #define LEAST_VALID       1  /* Don't trust a clicks value lower than this */
 
-int benchmark_timer_read( void )
+benchmark_timer_t benchmark_timer_read( void )
 {
     uint32_t t;
     unsigned long long total;