Clock Manager

This group contains the Clock Manager implementation. More...

Files
file	clock.h
	This header file defines the Clock Manager API.
file	clockimpl.h
	This header file provides the implementation interfaces of the Clock Manager.
file	clockgetsecondssinceepoch.c
	This source file contains the implementation of rtems_clock_get_seconds_since_epoch().
file	clockgettickspersecond.c
	This source file contains the implementation of rtems_clock_get_ticks_per_second().
file	clockgettickssinceboot.c
	This source file contains the implementation of rtems_clock_get_ticks_since_boot().
file	clockgettod.c
	This source file contains the implementation of rtems_clock_get_tod().
file	clockgettodtimeval.c
	This source file contains the implementation of rtems_clock_get_tod_timeval().
file	clockgetuptime.c
	This source file contains the implementation of rtems_clock_get_uptime().
file	clockgetuptimenanoseconds.c
	This source file contains the implementation of rtems_clock_get_uptime_nanoseconds().
file	clockgetuptimeseconds.c
	This source file contains the implementation of rtems_clock_get_uptime_seconds().
file	clockgetuptimetimeval.c
	This source file contains the implementation of rtems_clock_get_uptime_timeval().
file	clockset.c
	This source file contains the implementation of rtems_clock_set().
file	clocktick.c
	This source file contains the implementation of rtems_clock_tick().
file	clocktodtoseconds.c
	This source file contains the implementation of _TOD_To_seconds().
file	clocktodvalidate.c
	This source file contains the implementation of _TOD_Validate().

Enumerations
enum	TOD_Ticks_validation { TOD_DISABLE_TICKS_VALIDATION = 0 , TOD_ENABLE_TICKS_VALIDATION = -1 }
	The enumerators of this type determine if the ticks member is validated in _TOD_Validate(). More...

Functions
rtems_status_code	_TOD_Validate (const rtems_time_of_day *the_tod, TOD_Ticks_validation ticks_validation)
	Validates the time of day.
Watchdog_Interval	_TOD_To_seconds (const rtems_time_of_day *the_tod)
	TOD to Seconds.

Detailed Description

This group contains the Clock Manager implementation.

Enumeration Type Documentation

TOD_Ticks_validation

enum TOD_Ticks_validation

The enumerators of this type determine if the ticks member is validated in _TOD_Validate().

Enumerator
TOD_DISABLE_TICKS_VALIDATION	Use this option to disable the validation of the ticks member in _TOD_Validate().
TOD_ENABLE_TICKS_VALIDATION	Use this option to enable the validation of the ticks member in _TOD_Validate().

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

_TOD_Validate()

rtems_status_code _TOD_Validate	(	const rtems_time_of_day *	the_tod,
		TOD_Ticks_validation	ticks_validation
	)

Validates the time of day.

Parameters

the_tod	is the reference to the time of day structure to validate or NULL.
ticks_validation	indicates if the ticks member of the time of day should be validated. Use TOD_ENABLE_TICKS_VALIDATION to validate the ticks member. Use TOD_DISABLE_TICKS_VALIDATION to skip the validation of the ticks member.

Return values

RTEMS_SUCCESSFUL	the_tod references a valid time of day.
RTEMS_INVALID_CLOCK	the_tod references an invalid time of day.
RTEMS_INVALID_ADDRESS	the_tod reference is NULL.