RTEMS: cpukit/include/rtems/rtems/clock.h File Reference

| RTEMS 5.4-rc2

Loading...
Searching...
No Matches
Macros | Functions
clock.h File Reference
API » Classic » Clocks
`#include <rtems/rtems/status.h>`
`#include <rtems/rtems/types.h>`
`#include <rtems/config.h>`

Go to the source code of this file.

## Macros
#define | rtems_clock_get_ticks_per_second(void) ( _Watchdog_Ticks_per_second )
| Obtain Ticks Per Seconds.

## Functions
rtems_status_code | rtems_clock_get_tod (rtems_time_of_day *time_buffer)
| Obtain Current Time of Day (Classic TOD)
rtems_status_code | rtems_clock_get_tod_timeval (struct timeval *time)
| Obtain TOD in struct timeval Format.
rtems_status_code | rtems_clock_get_seconds_since_epoch (rtems_interval *the_interval)
| Obtain Seconds Since Epoch.
RTEMS_INLINE_ROUTINE rtems_interval | rtems_clock_get_ticks_since_boot (void)
| Gets the current ticks counter value.
RTEMS_INLINE_ROUTINE rtems_interval | rtems_clock_tick_later (rtems_interval delta)
| Returns the ticks counter value delta ticks in the future.
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.
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.
rtems_status_code | rtems_clock_set (const rtems_time_of_day *time_buffer)
| Set the Current TOD.
rtems_status_code | rtems_clock_tick (void)
| Announce a Clock Tick.
rtems_status_code | rtems_clock_get_uptime (struct timespec *uptime)
| Obtain the System Uptime.
void | rtems_clock_get_uptime_timeval (struct timeval *uptime)
| Gets the System Uptime in the Struct Timeval Format.
time_t | rtems_clock_get_uptime_seconds (void)
| Returns the system uptime in seconds.
uint64_t | rtems_clock_get_uptime_nanoseconds (void)
| Returns the system uptime in nanoseconds.
bool | _TOD_Validate (const rtems_time_of_day *the_tod)
| TOD Validate.
Watchdog_Interval | _TOD_To_seconds (const rtems_time_of_day *the_tod)
| TOD to Seconds.

## Detailed Description

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