Changeset a2fe43b in rtems


Ignore:
Timestamp:
Mar 10, 2015, 9:56:14 PM (5 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.11, master
Children:
78d5448
Parents:
a575af8
git-author:
Joel Sherrill <joel.sherrill@…> (03/10/15 21:56:14)
git-committer:
Joel Sherrill <joel.sherrill@…> (03/11/15 21:18:29)
Message:

cpukit/include/rtems/btimer.h: Add DOxygen comments

File:
1 edited

Legend:

Unmodified
Added
Removed
  • cpukit/include/rtems/btimer.h

    ra575af8 ra2fe43b  
    3434#endif
    3535
     36/**
     37 * @defgroup BenchmarkTimer Benchmark Timer Driver Interface
     38 *
     39 * This module defines the interface for the Benchmark Timer Driver.
     40 *
     41 * The following methods in this module must be provided by each BSP:
     42 *
     43 *   - benchmark_timer_initialize
     44 *   - benchmark_timer_read
     45 *   - benchmark_timer_disable_subtracting_average_overhead
     46 *
     47 * The units measured are BSP specific but should be at the highest
     48 * granularity possible.
     49 *
     50 * The Benchmark Timer may use the same hardware as the Clock Driver.
     51 * No RTEMS Timing Tests will use both drivers at the same time.
     52 */
     53
     54/**
     55 * @brief Benchmark Timer Value Type
     56 *
     57 * This type is used to contain benchmark times. The units are BSP specific.
     58 */
    3659typedef uint32_t benchmark_timer_t;
    3760
    38 /* functions */
    39 
     61/**
     62 * @brief Initialize the Benchmark Timer
     63 *
     64 * This method initializes the benchmark timer and resets it to begin
     65 * counting.
     66 */
    4067extern void benchmark_timer_initialize( void );
    4168
     69/**
     70 * @brief Read the Benchmark Timer
     71 *
     72 * This method stops the benchmark timer and returns the number of
     73 * units that have passed since @a benchmark_timer_initialize was invoked.
     74 *
     75 * @return This method returns the number of units with the average overhead
     76 *          removed. If the value is below the minimum trusted value, zero
     77 *          is returned.
     78 */
    4279extern benchmark_timer_t benchmark_timer_read( void );
    4380
     81/**
     82 * @brief Benchmark Timer Empty Function
     83 *
     84 * This method is used to determine loop overhead.
     85 */
    4486extern rtems_status_code benchmark_timer_empty_function( void );
    4587
     88/**
     89 * @brief Disable Average Overhead Removal from the Benchmark Timer
     90 *
     91 * This method places the benchmark timer in a "raw" mode where it
     92 * returns the actual number of units which have passed between
     93 * calls to @a benchmark_timer_initialize and @a benchmark_timer_read
     94 * counting.
     95 *
     96 * @param[in] find_flag indicates to enable or disable the mode
     97 */
    4698extern void benchmark_timer_disable_subtracting_average_overhead(
    4799  bool find_flag
    48100);
     101
     102/**@}*/
    49103
    50104#ifdef __cplusplus
Note: See TracChangeset for help on using the changeset viewer.