source: rtems/cpukit/rtems/src/clockgetuptime.c @ cfe8f7a

5
Last change on this file since cfe8f7a was cfe8f7a, checked in by Sebastian Huber <sebastian.huber@…>, on 04/27/20 at 14:14:06

doxygen: Switch @brief and @ingroup

This order change fixes the Latex documentation build via Doxygen.

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