clock.h

Go to the documentation of this file.

/* COPYRIGHT (c) 1989-2013.
 * On-Line Applications Research Corporation (OAR).
 *
 * The license and distribution terms for this file may be
 * found in the file LICENSE in this distribution or at
 * http://www.rtems.org/license/LICENSE.
 */

#ifndef _RTEMS_RTEMS_CLOCK_H
#define _RTEMS_RTEMS_CLOCK_H

#include <rtems/score/watchdog.h>
#include <rtems/score/tod.h>
#include <rtems/rtems/status.h>
#include <rtems/rtems/types.h>
#include <rtems/config.h>
#include <rtems/score/timecounterimpl.h>

#include <sys/time.h> /* struct timeval */

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
  RTEMS_CLOCK_GET_TOD,
  RTEMS_CLOCK_GET_SECONDS_SINCE_EPOCH,
  RTEMS_CLOCK_GET_TICKS_SINCE_BOOT,
  RTEMS_CLOCK_GET_TICKS_PER_SECOND,
  RTEMS_CLOCK_GET_TIME_VALUE
} rtems_clock_get_options;

rtems_status_code rtems_clock_get(
  rtems_clock_get_options  option,
  void                    *time_buffer
) RTEMS_COMPILER_DEPRECATED_ATTRIBUTE;

rtems_status_code rtems_clock_get_tod(
  rtems_time_of_day *time_buffer
);

rtems_status_code rtems_clock_get_tod_timeval(
  struct timeval *time
);

rtems_status_code rtems_clock_get_seconds_since_epoch(
  rtems_interval *the_interval
);

RTEMS_INLINE_ROUTINE rtems_interval rtems_clock_get_ticks_since_boot(void)
{
  return _Watchdog_Ticks_since_boot;
}

RTEMS_INLINE_ROUTINE rtems_interval rtems_clock_tick_later(
  rtems_interval delta
)
{
  return _Watchdog_Ticks_since_boot + delta;
}

RTEMS_INLINE_ROUTINE rtems_interval rtems_clock_tick_later_usec(
  rtems_interval delta_in_usec
)
{
  rtems_interval us_per_tick = rtems_configuration_get_microseconds_per_tick();

  /*
   * Add one additional tick, since we don't know the time to the clock next
   * tick.
   */
  return _Watchdog_Ticks_since_boot
    + (delta_in_usec + us_per_tick - 1) / us_per_tick + 1;
}

RTEMS_INLINE_ROUTINE bool rtems_clock_tick_before(
  rtems_interval tick
)
{
  return (int32_t) ( tick - _Watchdog_Ticks_since_boot ) > 0;
}

rtems_interval rtems_clock_get_ticks_per_second(void);

rtems_status_code rtems_clock_set(
  const rtems_time_of_day *time_buffer
);

rtems_status_code rtems_clock_tick( void );

rtems_status_code rtems_clock_get_uptime(
  struct timespec *uptime
);

void rtems_clock_get_uptime_timeval( struct timeval *uptime );

RTEMS_INLINE_ROUTINE time_t rtems_clock_get_uptime_seconds( void )
{
  return _Timecounter_Time_uptime - 1;
}

uint64_t rtems_clock_get_uptime_nanoseconds( void );

bool _TOD_Validate(
  const rtems_time_of_day *the_tod
);

Watchdog_Interval _TOD_To_seconds(
  const rtems_time_of_day *the_tod
);

#ifdef __cplusplus
}
#endif

#endif
/* end of include file */