/**
* @file
*
* @ingroup ScoreTOD
*
* @brief Time of Day Handler API
*/
/*
* 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/tod.h>
#include <rtems/score/apimutex.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
/**
* @defgroup ScoreTOD Time of Day Handler
*
* @ingroup Score
*
* The following constants are related to the time of day and are
* independent of RTEMS.
*/
/**@{*/
/**
* This constant represents the number of seconds in a minute.
*/
#define TOD_SECONDS_PER_MINUTE (uint32_t)60
/**
* This constant represents the number of minutes per hour.
*/
#define TOD_MINUTES_PER_HOUR (uint32_t)60
/**
* This constant represents the number of months in a year.
*/
#define TOD_MONTHS_PER_YEAR (uint32_t)12
/**
* This constant represents the number of days in a non-leap year.
*/
#define TOD_DAYS_PER_YEAR (uint32_t)365
/**
* This constant represents the number of hours per day.
*/
#define TOD_HOURS_PER_DAY (uint32_t)24
/**
* This constant represents the number of seconds in a day which does
* not include a leap second.
*/
#define TOD_SECONDS_PER_DAY (uint32_t) (TOD_SECONDS_PER_MINUTE * \
TOD_MINUTES_PER_HOUR * \
TOD_HOURS_PER_DAY)
/**
* This constant represents the number of seconds in a non-leap year.
*/
#define TOD_SECONDS_PER_NON_LEAP_YEAR (365 * TOD_SECONDS_PER_DAY)
/**
* This constant represents the number of millisecond in a second.
*/
#define TOD_MILLISECONDS_PER_SECOND (uint32_t)1000
/**
* This constant represents the number of microseconds in a second.
*/
#define TOD_MICROSECONDS_PER_SECOND (uint32_t)1000000
/**
* This constant represents the number of nanoseconds in a second.
*/
#define TOD_NANOSECONDS_PER_SECOND (uint32_t)1000000000
/**
* This constant represents the number of nanoseconds in a mircosecond.
*/
#define TOD_NANOSECONDS_PER_MICROSECOND (uint32_t)1000
/**@}*/
/**
* Seconds from January 1, 1970 to January 1, 1988. Used to account for
* differences between POSIX API and RTEMS core. The timespec format time
* is kept in POSIX compliant form.
*/
#define TOD_SECONDS_1970_THROUGH_1988 \
(((1987 - 1970 + 1) * TOD_SECONDS_PER_NON_LEAP_YEAR) + \
(4 * TOD_SECONDS_PER_DAY))
/**
* @brief Earliest year to which an time of day can be initialized.
*
* The following constant define the earliest year to which an
* time of day can be initialized. This is considered the
* epoch.
*/
#define TOD_BASE_YEAR 1988
/**
* @defgroup ScoreTOD Time Of Day (TOD) Handler
*
* @ingroup Score
*
* This handler encapsulates functionality used to manage time of day.
*/
/**@{*/
/**
* @brief TOD control.
*/
typedef struct {
/**
* @brief Indicates if the time of day is set.
*
* This is true if the application has set the current
* time of day, and false otherwise.
*/
bool is_set;
} TOD_Control;
extern TOD_Control _TOD;
static inline void _TOD_Lock( void )
{
/* FIXME: https://devel.rtems.org/ticket/2630 */
_API_Mutex_Lock( _Once_Mutex );
}
static inline void _TOD_Unlock( void )
{
_API_Mutex_Unlock( _Once_Mutex );
}
static inline void _TOD_Acquire( ISR_lock_Context *lock_context )
{
_Timecounter_Acquire( lock_context );
}
/**
* @brief Sets the time of day.
*
* The caller must be the owner of the TOD lock.
*
* @param tod_as_timestamp The new time of day in timestamp format representing
* the time since UNIX Epoch.
* @param lock_context The ISR lock context used for the corresponding
* _TOD_Acquire(). The caller must be the owner of the TOD lock. This
* function will release the TOD lock.
*/
void _TOD_Set(
const Timestamp_Control *tod_as_timestamp,
ISR_lock_Context *lock_context
);
/**
* @brief Sets the time of day with timespec format.
*
* @param tod_as_timespec The new time of day in timespec format.
*
* @see _TOD_Set().
*/
static inline void _TOD_Set_with_timespec(
const struct timespec *tod_as_timespec
)
{
Timestamp_Control tod_as_timestamp;
ISR_lock_Context lock_context;
_Timestamp_Set(
&tod_as_timestamp,
tod_as_timespec->tv_sec,
tod_as_timespec->tv_nsec
);
_TOD_Lock();
_TOD_Acquire( &lock_context );
_TOD_Set( &tod_as_timestamp, &lock_context );
_TOD_Unlock();
}
/**
* @brief Gets the current time in the bintime format.
*
* @param[out] time is the value gathered by the bintime request
*/
static inline void _TOD_Get(
Timestamp_Control *time
)
{
_Timecounter_Bintime(time);
}
/**
* @brief Gets the current time in the timespec format.
*
* @param[out] time is the value gathered by the nanotime request
*/
static inline void _TOD_Get_as_timespec(
struct timespec *time
)
{
_Timecounter_Nanotime(time);
}
/**
* @brief Gets the system uptime with potential accuracy to the nanosecond.
*
* This routine returns the system uptime with potential accuracy
* to the nanosecond.
*
* The initial uptime value is undefined.
*
* @param[in] time is a pointer to the uptime to be returned
*/
static inline void _TOD_Get_uptime(
Timestamp_Control *time
)
{
_Timecounter_Binuptime( time );
}
/**
* @brief Gets the system uptime with potential accuracy to the nanosecond.
* to the nanosecond.
*
* The initial uptime value is zero.
*
* @param[in] time is a pointer to the uptime to be returned
*/
static inline void _TOD_Get_zero_based_uptime(
Timestamp_Control *time
)
{
_Timecounter_Binuptime( time );
--time->sec;
}
/**
* @brief Gets the system uptime with potential accuracy to the nanosecond.
*
* The initial uptime value is zero.
*
* @param[in] time is a pointer to the uptime to be returned
*/
static inline void _TOD_Get_zero_based_uptime_as_timespec(
struct timespec *time
)
{
_Timecounter_Nanouptime( time );
--time->tv_sec;
}
/**
* @brief Number of seconds Since RTEMS epoch.
*
* The following contains the number of seconds from 00:00:00
* January 1, TOD_BASE_YEAR until the current time of day.
*/
static inline uint32_t _TOD_Seconds_since_epoch( void )
{
return (uint32_t) _Timecounter_Time_second;
}
/**
* @brief Gets number of ticks in a second.
*
* This method returns the number of ticks in a second.
*
* @note If the clock tick value does not multiply evenly into a second
* then this number of ticks will be slightly shorter than a second.
*/
uint32_t TOD_TICKS_PER_SECOND_method(void);
/**
* @brief Gets number of ticks in a second.
*
* This method exists to hide the fact that TOD_TICKS_PER_SECOND can not
* be implemented as a macro in a .h file due to visibility issues.
* The Configuration Table is not available to SuperCore .h files but
* is available to their .c files.
*/
#define TOD_TICKS_PER_SECOND TOD_TICKS_PER_SECOND_method()
/**
* This routine returns a timeval based upon the internal timespec format TOD.
*/
RTEMS_INLINE_ROUTINE void _TOD_Get_timeval(
struct timeval *time
)
{
_Timecounter_Microtime( time );
}
/**
* @brief Adjust the Time of Time
*
* This method is used to adjust the current time of day by the
* specified amount.
*
* @param[in] delta is the amount to adjust
*/
void _TOD_Adjust(
const Timestamp_Control *delta
);
/**
* @brief Check if the TOD is Set
*
* @return TRUE is the time is set. FALSE otherwise.
*/
RTEMS_INLINE_ROUTINE bool _TOD_Is_set( void )
{
return _TOD.is_set;
}
/**
* @brief Absolute timeout conversion results.
*
* This enumeration defines the possible results of converting
* an absolute time used for timeouts to POSIX blocking calls to
* a number of ticks for example.
*/
typedef enum {
/** The timeout is invalid. */
TOD_ABSOLUTE_TIMEOUT_INVALID,
/** The timeout represents a time that is in the past. */
TOD_ABSOLUTE_TIMEOUT_IS_IN_PAST,
/** The timeout represents a time that is equal to the current time. */
TOD_ABSOLUTE_TIMEOUT_IS_NOW,
/** The timeout represents a time that is in the future. */
TOD_ABSOLUTE_TIMEOUT_IS_IN_FUTURE,
} TOD_Absolute_timeout_conversion_results;
/**
* @brief Convert absolute timeout to ticks.
*
* This method takes an absolute time being used as a timeout
* to a blocking directive, validates it and returns the number
* of corresponding clock ticks for use by the SuperCore.
*
* @param[in] abstime is a pointer to the timeout
* @param[out] ticks_out will contain the number of ticks
*
* @return This method returns the number of ticks in @a ticks_out
* and a status value indicating whether the absolute time
* is valid, in the past, equal to the current time or in
* the future as it should be.
*/
TOD_Absolute_timeout_conversion_results _TOD_Absolute_timeout_to_ticks(
const struct timespec *abstime,
Watchdog_Interval *ticks_out
);
/**@}*/
#ifdef __cplusplus
}
#endif
#endif
/* end of include file */
