Changeset 5a1e7e8 in rtems

Timestamp:

Sep 8, 2008, 2:48:06 PM (11 years ago)

Author:

Joel Sherrill <joel.sherrill@…>

Branches:

4.10, 4.11, 4.9, master

Children:

edb1810e

Parents:

e33e7b88

Message:

2008-09-08 Joel Sherrill <joel.sherrill@…>

• bsp_howto/timer.t: Update documentation to reflect Timer Driver renaming.

Location:

doc

Files:

• ChangeLog (modified) (1 diff)
• bsp_howto/timer.t (modified) (6 diffs)

doc/ChangeLog

@@ +1 @@
+2008-09-08      Joel Sherrill <joel.sherrill@oarcorp.com>
+
+        * bsp_howto/timer.t: Update documentation to reflect Timer Driver
+        renaming.
+
 2008-09-05      Joel Sherrill <joel.sherrill@OARcorp.com>
 

doc/bsp_howto/timer.t

@@ -35 +35 @@
 
 @example
-void Timer_initialize(void)
+void benchmark_timer_initialize(void)
 @{
   initialize the benchmark timer
@@ -43 +43 @@
 @subsection Read_timer
 
-The @code{Read_timer} routine 
-returns the number of benchmark time units (typically microseconds)
-that have elapsed since the last call to @code{Timer_initialize}. 
+The @code{benchmark_timer_read} routine returns the number of benchmark
+time units (typically microseconds) that have elapsed since the last
+call to @code{benchmark_timer_initialize}.
 
 @example
-int Read_timer(void)
+int benchmark_timer_read(void)
 @{
   stop time = read the hardware timer
@@ -65 +65 @@
 is below the resolution of the timer.
 
-@subsection An Empty Function
-
-This routine is invoked by the RTEMS Timing Test Suite to measure 
-the cost of invoking a subroutine.
-
-@example
-rtems_status_code Empty_function (void)
-@{
-  return RTEMS_SUCCESSFUL;
-@}
-@end example
-
-@subsection Set_find_average_overhead
+@subsection benchmark_timer_disable_subtracting_average_overhead
 
 This routine is invoked by the "Check Timer" (@code{tmck}) test in the 
-RTEMS Timing Test Suite.  It makes the @code{Read_timer}
+RTEMS Timing Test Suite.  It makes the @code{benchmark_timer_read}
 routine NOT subtract the overhead required
 to initialize and read the benchmark timer.  This is used
@@ -87 +75 @@
 
 @example
-void Set_find_average_overhead(rtems_boolean find_flag)
+void benchmark_timer_disable_subtracting_average_overhead(bool find_flag)
 @{
     disable the subtract overhead feature
@@ -93 +81 @@
 @end example
 
-The @code{Timer_driver_Find_average_overhead} variable is usually
-used to indicate the state of the "subtract overhead feature".
+The @code{benchmark_timer_find_average_overhead} variable is used to
+indicate the state of the "subtract overhead feature".
 
 @section gen68340 UART FIFO Full Mode
@@ -117 +105 @@
 
 @end itemize
-
-
-