Changeset 5a1e7e8 in rtems


Ignore:
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:
2 edited

Legend:

Unmodified
Added
Removed
  • doc/ChangeLog

    re33e7b88 r5a1e7e8  
     12008-09-08      Joel Sherrill <joel.sherrill@oarcorp.com>
     2
     3        * bsp_howto/timer.t: Update documentation to reflect Timer Driver
     4        renaming.
     5
    162008-09-05      Joel Sherrill <joel.sherrill@OARcorp.com>
    27
  • doc/bsp_howto/timer.t

    re33e7b88 r5a1e7e8  
    3535
    3636@example
    37 void Timer_initialize(void)
     37void benchmark_timer_initialize(void)
    3838@{
    3939  initialize the benchmark timer
     
    4343@subsection Read_timer
    4444
    45 The @code{Read_timer} routine
    46 returns the number of benchmark time units (typically microseconds)
    47 that have elapsed since the last call to @code{Timer_initialize}.
     45The @code{benchmark_timer_read} routine returns the number of benchmark
     46time units (typically microseconds) that have elapsed since the last
     47call to @code{benchmark_timer_initialize}.
    4848
    4949@example
    50 int Read_timer(void)
     50int benchmark_timer_read(void)
    5151@{
    5252  stop time = read the hardware timer
     
    6565is below the resolution of the timer.
    6666
    67 @subsection An Empty Function
    68 
    69 This routine is invoked by the RTEMS Timing Test Suite to measure
    70 the cost of invoking a subroutine.
    71 
    72 @example
    73 rtems_status_code Empty_function (void)
    74 @{
    75   return RTEMS_SUCCESSFUL;
    76 @}
    77 @end example
    78 
    79 @subsection Set_find_average_overhead
     67@subsection benchmark_timer_disable_subtracting_average_overhead
    8068
    8169This routine is invoked by the "Check Timer" (@code{tmck}) test in the
    82 RTEMS Timing Test Suite.  It makes the @code{Read_timer}
     70RTEMS Timing Test Suite.  It makes the @code{benchmark_timer_read}
    8371routine NOT subtract the overhead required
    8472to initialize and read the benchmark timer.  This is used
     
    8775
    8876@example
    89 void Set_find_average_overhead(rtems_boolean find_flag)
     77void benchmark_timer_disable_subtracting_average_overhead(bool find_flag)
    9078@{
    9179    disable the subtract overhead feature
     
    9381@end example
    9482
    95 The @code{Timer_driver_Find_average_overhead} variable is usually
    96 used to indicate the state of the "subtract overhead feature".
     83The @code{benchmark_timer_find_average_overhead} variable is used to
     84indicate the state of the "subtract overhead feature".
    9785
    9886@section gen68340 UART FIFO Full Mode
     
    117105
    118106@end itemize
    119 
    120 
    121 
Note: See TracChangeset for help on using the changeset viewer.