todimpl.h

Go to the documentation of this file.

/*
 *  COPYRIGHT (c) 1989-2009.
 *  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_SCORE_TODIMPL_H
#define _RTEMS_SCORE_TODIMPL_H

#include <rtems/score/status.h>
#include <rtems/score/timestamp.h>
#include <rtems/score/timecounterimpl.h>
#include <rtems/score/watchdog.h>

#include <sys/time.h>
#include <time.h>

#ifdef __cplusplus
extern "C" {
#endif

#define TOD_SECONDS_PER_MINUTE (uint32_t)60

#define TOD_MINUTES_PER_HOUR   (uint32_t)60

#define TOD_MONTHS_PER_YEAR    (uint32_t)12

#define TOD_DAYS_PER_YEAR      (uint32_t)365

#define TOD_HOURS_PER_DAY      (uint32_t)24

#define TOD_SECONDS_PER_DAY    (uint32_t) (TOD_SECONDS_PER_MINUTE * \
                                TOD_MINUTES_PER_HOUR   * \
                                TOD_HOURS_PER_DAY)

#define TOD_SECONDS_PER_NON_LEAP_YEAR (365 * TOD_SECONDS_PER_DAY)

#define TOD_MILLISECONDS_PER_SECOND     (uint32_t)1000

#define TOD_MICROSECONDS_PER_SECOND     (uint32_t)1000000

#define TOD_NANOSECONDS_PER_SECOND      (uint32_t)1000000000

#define TOD_NANOSECONDS_PER_MICROSECOND (uint32_t)1000

#define TOD_SECONDS_1970_THROUGH_1988 \
  (((1987 - 1970 + 1)  * TOD_SECONDS_PER_NON_LEAP_YEAR) + \
  (4 * TOD_SECONDS_PER_DAY))

#define TOD_BASE_YEAR 1988

typedef struct {
  bool is_set;
} TOD_Control;

extern TOD_Control _TOD;

void _TOD_Lock( void );

void _TOD_Unlock( void );

#if defined(RTEMS_DEBUG)
bool _TOD_Is_owner( void );
#endif

static inline void _TOD_Acquire( ISR_lock_Context *lock_context )
{
  _Timecounter_Acquire( lock_context );
}

static inline void _TOD_Release( ISR_lock_Context *lock_context )
{
  _Timecounter_Release( lock_context );
}

Status_Control _TOD_Set(
  const struct timespec *tod,
  ISR_lock_Context      *lock_context
);

static inline void _TOD_Get(
  struct timespec *tod
)
{
  _Timecounter_Nanotime( tod );
}

static inline void _TOD_Get_uptime(
  Timestamp_Control *time
)
{
  *time = _Timecounter_Sbinuptime();
}

static inline void _TOD_Get_zero_based_uptime(
  Timestamp_Control *time
)
{
  *time = _Timecounter_Sbinuptime() - SBT_1S;
}

static inline void _TOD_Get_zero_based_uptime_as_timespec(
  struct timespec *time
)
{
  _Timecounter_Nanouptime( time );
  --time->tv_sec;
}

static inline uint32_t _TOD_Seconds_since_epoch( void )
{
  return (uint32_t) _Timecounter_Time_second;
}

uint32_t TOD_TICKS_PER_SECOND_method(void);

#define TOD_TICKS_PER_SECOND TOD_TICKS_PER_SECOND_method()

RTEMS_INLINE_ROUTINE void _TOD_Get_timeval(
  struct timeval *time
)
{
  _Timecounter_Microtime( time );
}

void _TOD_Adjust(
  const struct timespec *delta
);

RTEMS_INLINE_ROUTINE bool _TOD_Is_set( void )
{
  return _TOD.is_set;
}

typedef enum {
  TOD_ACTION_SET_CLOCK
} TOD_Action;

typedef struct TOD_Hook {
  Chain_Node Node;

  Status_Control ( *handler )( TOD_Action, const struct timespec * );
} TOD_Hook;

extern Chain_Control _TOD_Hooks;

void _TOD_Hook_Register(
  TOD_Hook *hook
);

void _TOD_Hook_Unregister(
  TOD_Hook *hook
);

Status_Control _TOD_Hook_Run(
  TOD_Action             action,
  const struct timespec *tod
);


#ifdef __cplusplus
}
#endif

#endif
/* end of include file */