Clock Manager API. More...

Collaboration diagram for Clocks:

Files
file	clockget.c
	Obtain Current Time of Day.

file	clockgetsecondssinceepoch.c
	Obtain Seconds Since Epoch.

file	clockgettickspersecond.c
	Obtain Ticks Per Seconds.

file	clockgettod.c
	Obtain Current Time of Day (Classic TOD)

file	clockgettodtimeval.c
	Obtain TOD in struct timeval Format.

file	clockgetuptime.c
	Obtain the System Uptime.

file	clockgetuptimenanoseconds.c
	Returns the system uptime in seconds.

file	clockgetuptimetimeval.c
	Gets the System Uptime in the Struct Timeval Format.

file	clockset.c
	Set the Current TOD.

file	clocktick.c
	Announce a Clock Tick.

file	clocktodtoseconds.c
	TOD to Seconds.

file	clocktodvalidate.c
	TOD Validate.

file	rtclock.c
	No Initialization Routine.

Enumerations
enum	rtems_clock_get_options { 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 }
	List of things which can be returned by the rtems_clock_get directive. More...

Functions
rtems_status_code	rtems_clock_get (rtems_clock_get_options option, void *time_buffer)
	Obtain Current Time of Day. More...

rtems_status_code	rtems_clock_get_tod (rtems_time_of_day *time_buffer)
	Obtain Current Time of Day (Classic TOD) More...

rtems_status_code	rtems_clock_get_tod_timeval (struct timeval *time)
	Obtain TOD in struct timeval Format. More...

rtems_status_code	rtems_clock_get_seconds_since_epoch (rtems_interval *the_interval)
	Obtain Seconds Since Epoch. More...

RTEMS_INLINE_ROUTINE rtems_interval	rtems_clock_get_ticks_since_boot (void)
	Gets the current ticks counter value. More...

RTEMS_INLINE_ROUTINE rtems_interval	rtems_clock_tick_later (rtems_interval delta)
	Returns the ticks counter value delta ticks in the future. More...

RTEMS_INLINE_ROUTINE rtems_interval	rtems_clock_tick_later_usec (rtems_interval delta_in_usec)
	Returns the ticks counter value at least delta microseconds in the future. More...

RTEMS_INLINE_ROUTINE bool	rtems_clock_tick_before (rtems_interval tick)
	Returns true if the current ticks counter value indicates a time before the time specified by the tick value and false otherwise. More...

rtems_interval	rtems_clock_get_ticks_per_second (void)
	Obtain Ticks Per Seconds. More...

rtems_status_code	rtems_clock_set (const rtems_time_of_day *time_buffer)
	Set the Current TOD. More...

rtems_status_code	rtems_clock_tick (void)
	Announce a Clock Tick. More...

rtems_status_code	rtems_clock_get_uptime (struct timespec *uptime)
	Obtain the System Uptime. More...

void	rtems_clock_get_uptime_timeval (struct timeval *uptime)
	Gets the System Uptime in the Struct Timeval Format. More...

RTEMS_INLINE_ROUTINE time_t	rtems_clock_get_uptime_seconds (void)
	Returns the system uptime in seconds. More...

uint64_t	rtems_clock_get_uptime_nanoseconds (void)
	Returns the system uptime in nanoseconds. More...

bool	_TOD_Validate (const rtems_time_of_day *the_tod)
	TOD Validate. More...

Watchdog_Interval	_TOD_To_seconds (const rtems_time_of_day *the_tod)
	TOD to Seconds. More...

Detailed Description

Clock Manager API.

This encapsulates functionality related to the Classic API Clock Manager.

This include file contains all the constants and structures associated with the Clock Manager. This manager provides facilities to set, obtain, and continually update the current date and time.

This manager provides directives to:

set the current date and time
obtain the current date and time
announce a clock tick
obtain the system uptime

Enumeration Type Documentation

◆ rtems_clock_get_options

enum rtems_clock_get_options

List of things which can be returned by the rtems_clock_get directive.

Enumerator
RTEMS_CLOCK_GET_TOD	This value indicates obtain TOD in Classic API format.
RTEMS_CLOCK_GET_SECONDS_SINCE_EPOCH	This value indicates obtain the number of seconds since the epoch.
RTEMS_CLOCK_GET_TICKS_SINCE_BOOT	This value indicates obtain the number of ticks since system boot.
RTEMS_CLOCK_GET_TICKS_PER_SECOND	This value indicates obtain the number of ticks per second.
RTEMS_CLOCK_GET_TIME_VALUE	This value indicates obtain the TOD in struct timeval format.

Function Documentation

◆ _TOD_To_seconds()

Watchdog_Interval _TOD_To_seconds ( const rtems_time_of_day * the_tod )

TOD to Seconds.

This function returns the number seconds between the epoch and the_tod.

Parameters

[in] the_tod is the TOD structure to convert to seconds

Return values

This	method returns the number of seconds since epoch represented by the_tod

References rtems_time_of_day::day, and rtems_time_of_day::year.

Referenced by rtems_clock_get_uptime_seconds(), rtems_clock_set(), rtems_task_wake_when(), rtems_timer_fire_when(), and rtems_timer_server_fire_when().

◆ _TOD_Validate()

bool _TOD_Validate ( const rtems_time_of_day * the_tod )

TOD Validate.

This support function returns true if the_tod contains a valid time of day, and false otherwise.

Parameters

[in] the_tod is the TOD structure to validate

Return values

This	method returns true if the TOD is valid and false otherwise.

Note: This routine only works for leap-years through 2099.

References TOD_MICROSECONDS_PER_SECOND.

Referenced by rtems_clock_get_uptime_seconds(), rtems_clock_set(), rtems_task_wake_when(), rtems_timer_fire_when(), and rtems_timer_server_fire_when().

◆ rtems_clock_get()

rtems_status_code rtems_clock_get	(	rtems_clock_get_options	option,
		void *	time_buffer
	)

Obtain Current Time of Day.

Deprecated:: rtems_clock_get() is deprecated. Use the more explicit function calls rtems_clock_get_xxx().

This routine implements the rtems_clock_get directive. It returns one of the following:

current time of day
seconds since epoch
ticks since boot
ticks per second

Parameters

[in]	option	is the format of time to return
[in]	time_buffer	points to the output area

Return values

This	method returns RTEMS_SUCCESSFUL if there was not an error. Otherwise, a status code is returned indicating the source of the error.

References RTEMS_CLOCK_GET_SECONDS_SINCE_EPOCH, rtems_clock_get_seconds_since_epoch(), RTEMS_CLOCK_GET_TICKS_SINCE_BOOT, RTEMS_CLOCK_GET_TOD, rtems_clock_get_tod(), and RTEMS_INVALID_ADDRESS.

◆ rtems_clock_get_seconds_since_epoch()

rtems_status_code rtems_clock_get_seconds_since_epoch ( rtems_interval * the_interval )

Obtain Seconds Since Epoch.

This routine implements the rtems_clock_get_seconds_since_epoch directive.

Parameters

[in] the_interval points to the interval variable to fill in

Return values

This	method returns RTEMS_SUCCESSFUL if there was not an error. Otherwise, a status code is returned indicating the source of the error. If successful, the time_buffer will be filled in with the current time of day.

References _TOD_Is_set(), RTEMS_INVALID_ADDRESS, and RTEMS_NOT_DEFINED.

Referenced by rtems_clock_get().

◆ rtems_clock_get_ticks_per_second()

rtems_interval rtems_clock_get_ticks_per_second ( void )

Obtain Ticks Per Seconds.

This routine implements the rtems_clock_get_ticks_per_second directive.

Return values

This	method returns the number of ticks per second. It cannot fail since RTEMS is always configured to know the number of ticks per second.

References TOD_MICROSECONDS_PER_SECOND.

◆ rtems_clock_get_ticks_since_boot()

RTEMS_INLINE_ROUTINE rtems_interval rtems_clock_get_ticks_since_boot ( void )

Gets the current ticks counter value.

Returns: The current tick counter value. With a 1ms clock tick, this counter overflows after 50 days since boot.

References _Watchdog_Ticks_since_boot.

Referenced by _times().

◆ rtems_clock_get_tod()

rtems_status_code rtems_clock_get_tod ( rtems_time_of_day * time_buffer )

Obtain Current Time of Day (Classic TOD)

This routine implements the rtems_clock_get_tod directive. It returns the current time of day in the format defined by RTEID.

Clock Manager - rtems_clock_get_tod

Parameters

[in] time_buffer points to the time of day structure

Return values

This	method returns RTEMS_SUCCESSFUL if there was not an error. Otherwise, a status code is returned indicating the source of the error. If successful, the time_buffer will be filled in with the current time of day.

References _TOD_Get_timeval(), _TOD_Is_set(), RTEMS_INVALID_ADDRESS, and RTEMS_NOT_DEFINED.

Referenced by rtems_clock_get().

◆ rtems_clock_get_tod_timeval()

rtems_status_code rtems_clock_get_tod_timeval ( struct timeval * time )

Obtain TOD in struct timeval Format.

This routine implements the rtems_clock_get_tod_timeval directive.

Parameters

[in] time points to the struct timeval variable to fill in

Return values

This	method returns RTEMS_SUCCESSFUL if there was not an error. Otherwise, a status code is returned indicating the source of the error. If successful, the time will be filled in with the current time of day.

References _TOD_Get_timeval(), _TOD_Is_set(), RTEMS_INVALID_ADDRESS, RTEMS_NOT_DEFINED, and RTEMS_SUCCESSFUL.

◆ rtems_clock_get_uptime()

rtems_status_code rtems_clock_get_uptime ( struct timespec * uptime )

Obtain the System Uptime.

This directive returns the system uptime.

Parameters

[in] uptime is a pointer to the time structure

Return values

This	method returns RTEMS_SUCCESSFUL if there was not an error. Otherwise, a status code is returned indicating the source of the error. If successful, the uptime will be filled in.

References RTEMS_INVALID_ADDRESS.

◆ rtems_clock_get_uptime_nanoseconds()

uint64_t rtems_clock_get_uptime_nanoseconds ( void )

Returns the system uptime in nanoseconds.

Return values

The	system uptime in nanoseconds.

Referenced by rtems_clock_get_uptime_seconds().

◆ rtems_clock_get_uptime_seconds()

RTEMS_INLINE_ROUTINE time_t rtems_clock_get_uptime_seconds ( void )

Returns the system uptime in seconds.

Return values

The	system uptime in seconds.

References _Timecounter_Time_uptime, _TOD_To_seconds(), _TOD_Validate(), and rtems_clock_get_uptime_nanoseconds().

◆ rtems_clock_get_uptime_timeval()

void rtems_clock_get_uptime_timeval ( struct timeval * uptime )

Gets the System Uptime in the Struct Timeval Format.

Parameters

[out] uptime is a pointer to a struct timeval structure.

Return values

This	methods returns the system uptime.

Note: Pointer must not be NULL.

◆ rtems_clock_set()

rtems_status_code rtems_clock_set ( const rtems_time_of_day * time_buffer )

Set the Current TOD.

This routine implements the rtems_clock_set directive. It sets the current time of day to that in the time_buffer record.

Parameters

[in] time_buffer points to the new TOD

Return values

This	method returns RTEMS_SUCCESSFUL if there was not an error. Otherwise, a status code is returned indicating the source of the error.

Note: Activities scheduled based upon the current time of day may be executed immediately if the time is moved forward.

References _TOD_To_seconds(), _TOD_Validate(), RTEMS_INVALID_ADDRESS, and rtems_time_of_day::ticks.

◆ rtems_clock_tick()

rtems_status_code rtems_clock_tick ( void )

Announce a Clock Tick.

This routine implements the rtems_clock_tick directive. It is invoked to inform RTEMS of the occurrence of a clock tick.

Return values

This	directive always returns RTEMS_SUCCESSFUL.

Note: This method is typically called from an ISR and is the basis for all timeouts and delays. This routine only works for leap-years through 2099.

References _Timecounter_Acquire, and _Timecounter_Tick_simple().

◆ rtems_clock_tick_before()

RTEMS_INLINE_ROUTINE bool rtems_clock_tick_before ( rtems_interval tick )

Returns true if the current ticks counter value indicates a time before the time specified by the tick value and false otherwise.

Parameters

[in] tick The tick value.

This can be used to write busy loops with a timeout.

status busy( void )
{
  rtems_interval timeout = rtems_clock_tick_later_usec( 10000 );
  do {
    if ( ok() ) {
      return success;
    }
  } while ( rtems_clock_tick_before( timeout ) );
  return timeout;
}

Return values

true	The current ticks counter value indicates a time before the time specified by the tick value.
false	Otherwise.

◆ rtems_clock_tick_later()

RTEMS_INLINE_ROUTINE rtems_interval rtems_clock_tick_later ( rtems_interval delta )

Returns the ticks counter value delta ticks in the future.

Parameters

[in] delta The ticks delta value.

Returns: The tick counter value delta ticks in the future.

References _Watchdog_Ticks_since_boot.

◆ rtems_clock_tick_later_usec()

RTEMS_INLINE_ROUTINE rtems_interval rtems_clock_tick_later_usec ( rtems_interval delta_in_usec )

Returns the ticks counter value at least delta microseconds in the future.

Parameters

[in] delta_in_usec The delta value in microseconds.

Returns: The tick counter value at least delta microseconds in the future.

Files

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ rtems_clock_get_options

Function Documentation

◆ _TOD_To_seconds()

◆ _TOD_Validate()

◆ rtems_clock_get()

◆ rtems_clock_get_seconds_since_epoch()

◆ rtems_clock_get_ticks_per_second()

◆ rtems_clock_get_ticks_since_boot()

◆ rtems_clock_get_tod()

◆ rtems_clock_get_tod_timeval()

◆ rtems_clock_get_uptime()

◆ rtems_clock_get_uptime_nanoseconds()

◆ rtems_clock_get_uptime_seconds()

◆ rtems_clock_get_uptime_timeval()

◆ rtems_clock_set()

◆ rtems_clock_tick()

◆ rtems_clock_tick_before()

◆ rtems_clock_tick_later()

◆ rtems_clock_tick_later_usec()