source: rtems/cpukit/include/rtems/score/timestamp.h @ 5803f37

5
Last change on this file since 5803f37 was 1b5ba76, checked in by Andreas Dachsberger <andreas.dachsberger@…>, on 04/17/19 at 15:51:55

doxygen: score: adjust doc in timestamp.h to doxygen guidelines

Update #3706.

  • Property mode set to 100644
File size: 1.6 KB
Line 
1/**
2 * @file
3 *
4 * @ingroup SuperCoreTimeStamp
5 *
6 * @brief Helpers for Manipulating Timestamps
7 *
8 * This include file contains helpers for manipulating timestamps.
9 */
10
11/*
12 *  COPYRIGHT (c) 1989-2009.
13 *  On-Line Applications Research Corporation (OAR).
14 *
15 *  The license and distribution terms for this file may be
16 *  found in the file LICENSE in this distribution or at
17 *  http://www.rtems.org/license/LICENSE.
18 */
19
20#ifndef _RTEMS_SCORE_TIMESTAMP_H
21#define _RTEMS_SCORE_TIMESTAMP_H
22
23/**
24 * @defgroup SuperCoreTimeStamp Score Timestamp
25 *
26 * @ingroup RTEMSScore
27 *
28 * @brief Score Timestamp
29 *
30 * This handler encapsulates functionality related to manipulating
31 * SuperCore Timestamps.  SuperCore Timestamps may be used to
32 * represent time of day, uptime, or intervals.
33 *
34 * The key attribute of the SuperCore Timestamp handler is that it
35 * is a completely opaque handler.  There can be multiple implementations
36 * of the required functionality and with a recompile, RTEMS can use
37 * any implementation.  It is intended to be a simple wrapper.
38 *
39 * This handler can be implemented as either struct timespec or
40 * unsigned64 bit numbers.  The use of a wrapper class allows the
41 * the implementation of timestamps to change on a per architecture
42 * basis.  This is an important option as the performance of this
43 * handler is critical.
44 *
45 * @{
46 */
47
48#include <rtems/score/timespec.h>
49
50#ifdef __cplusplus
51extern "C" {
52#endif
53
54/**
55 *   Define the Timestamp control type.
56 */
57typedef int64_t Timestamp_Control;
58
59#ifdef __cplusplus
60}
61#endif
62
63/** @} */
64
65#endif
66/* end of include file */
Note: See TracBrowser for help on using the repository browser.