source: rtems/cpukit/rtems/src/clockgetuptime.c @ 6b5f22dc

Last change on this file since 6b5f22dc was 6b5f22dc, checked in by Sebastian Huber <sebastian.huber@…>, on 11/26/20 at 10:45:47

rtems: Canonicalize Doxygen @file comments

Use common phrases for the file brief descriptions.

Update #3706.

  • Property mode set to 100644
File size: 1.0 KB
Line 
1/**
2 * @file
3 *
4 * @ingroup RTEMSImplClassicClock
5 *
6 * @brief This source file contains the implementation of
7 *   rtems_clock_get_uptime().
8 */
9
10/*
11 *  COPYRIGHT (c) 1989-2007.
12 *  On-Line Applications Research Corporation (OAR).
13 *
14 *  The license and distribution terms for this file may be
15 *  found in the file LICENSE in this distribution or at
16 *  http://www.rtems.org/license/LICENSE.
17 */
18
19#ifdef HAVE_CONFIG_H
20#include "config.h"
21#endif
22
23#include <rtems/rtems/clock.h>
24#include <rtems/score/todimpl.h>
25
26/*
27 *  rtems_clock_get_uptime
28 *
29 *  This directive obtains the system uptime.  A timestamp is the seconds
30 *  and nanoseconds since boot.
31 *
32 *  Input parameters:
33 *    timestamp - pointer to the timestamp
34 *
35 *  Output parameters:
36 *    *uptime           - filled in
37 *    RTEMS_SUCCESSFUL - if successful
38 *    error code       - if unsuccessful
39 */
40rtems_status_code rtems_clock_get_uptime(
41  struct timespec *uptime
42)
43{
44  if ( !uptime )
45    return RTEMS_INVALID_ADDRESS;
46
47  _TOD_Get_zero_based_uptime_as_timespec( uptime );
48  return RTEMS_SUCCESSFUL;
49}
Note: See TracBrowser for help on using the repository browser.