diff options
Diffstat (limited to 'cpukit/include/rtems/rtems/clock.h')
| -rw-r--r-- | cpukit/include/rtems/rtems/clock.h | 663 |
1 files changed, 639 insertions, 24 deletions
diff --git a/cpukit/include/rtems/rtems/clock.h b/cpukit/include/rtems/rtems/clock.h index 3e94a1f609..5a8d0a44f9 100644 --- a/cpukit/include/rtems/rtems/clock.h +++ b/cpukit/include/rtems/rtems/clock.h @@ -3,11 +3,13 @@ /** * @file * + * @ingroup RTEMSImplClassicClock + * * @brief This header file defines the Clock Manager API. */ /* - * Copyright (C) 2014, 2021 embedded brains GmbH (http://www.embedded-brains.de) + * Copyright (C) 2014, 2021 embedded brains GmbH & Co. KG * Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) * * Redistribution and use in source and binary forms, with or without @@ -79,6 +81,11 @@ extern "C" { * related capabilities. */ +/* Generated from spec:/rtems/clock/if/bintime */ + +/* Forward declaration */ +struct bintime; + /* Generated from spec:/rtems/clock/if/set */ /** @@ -101,13 +108,16 @@ extern "C" { * range-checked, and an error is returned if any one is out of its valid * range. * - * RTEMS can represent time points of this clock in nanoseconds ranging from - * 1988-01-01T00:00:00.000000000Z to 2514-05-31T01:53:03.999999999Z. The - * future uptime of the system shall be in this range, otherwise the system - * behaviour is undefined. + * RTEMS can represent time points of the CLOCK_REALTIME clock in nanoseconds + * ranging from 1988-01-01T00:00:00.000000000Z to + * 2514-05-31T01:53:03.999999999Z. The future uptime of the system shall be in + * this range, otherwise the system behaviour is undefined. Due to + * implementation constraints, the time of day set by the directive shall be + * before 2100-01-01:00:00.000000000Z. The latest valid time of day accepted + * by the POSIX clock_settime() is 2400-01-01T00:00:00.999999999Z. * - * The specified time is based on the configured clock tick rate, see the - * #CONFIGURE_MICROSECONDS_PER_TICK application configuration option. + * The specified time is based on the configured clock tick rate, see the @ref + * CONFIGURE_MICROSECONDS_PER_TICK application configuration option. * * Setting the time forward will fire all CLOCK_REALTIME timers which are * scheduled at a time point before or at the time set by the directive. This @@ -133,6 +143,12 @@ extern "C" { * * * The directive may unblock a task. This may cause the calling task to be * preempted. + * + * * The time of day set by the directive shall be + * 1988-01-01T00:00:00.000000000Z or later. + * + * * The time of day set by the directive shall be before + * 2100-01-01T00:00:00.000000000Z. * @endparblock */ rtems_status_code rtems_clock_set( const rtems_time_of_day *time_of_day ); @@ -144,10 +160,10 @@ rtems_status_code rtems_clock_set( const rtems_time_of_day *time_of_day ); * * @brief Gets the time of day associated with the current CLOCK_REALTIME. * - * @param time_of_day is the pointer to a RTEMS time of day variable. When the + * @param time_of_day is the pointer to an rtems_time_of_day object. When the * directive call is successful, the time of day associated with the * CLOCK_REALTIME at some point during the directive call will be stored in - * this variable. + * this object. * * @retval ::RTEMS_SUCCESSFUL The requested operation was successful. * @@ -177,10 +193,10 @@ rtems_status_code rtems_clock_get_tod( rtems_time_of_day *time_of_day ); * @brief Gets the seconds and microseconds elapsed since the Unix epoch and * the current CLOCK_REALTIME. * - * @param[out] time_of_day is the pointer to a timeval structure variable. - * When the directive call is successful, the seconds and microseconds - * elapsed since the Unix epoch and the CLOCK_REALTIME at some point during - * the directive call will be stored in this variable. + * @param[out] time_of_day is the pointer to a struct timeval object. When the + * directive call is successful, the seconds and microseconds elapsed since + * the Unix epoch and the CLOCK_REALTIME at some point during the directive + * call will be stored in this object. * * @retval ::RTEMS_SUCCESSFUL The requested operation was successful. * @@ -202,6 +218,593 @@ rtems_status_code rtems_clock_get_tod( rtems_time_of_day *time_of_day ); */ rtems_status_code rtems_clock_get_tod_timeval( struct timeval *time_of_day ); +/* Generated from spec:/rtems/clock/if/get-realtime */ + +/** + * @ingroup RTEMSAPIClassicClock + * + * @brief Gets the time elapsed since the Unix epoch measured using + * CLOCK_REALTIME in seconds and nanoseconds format. + * + * @param[out] time_snapshot is the pointer to a struct timespec object. The + * time elapsed since the Unix epoch measured using the CLOCK_REALTIME at + * some time point during the directive call will be stored in this object. + * Calling the directive with a pointer equal to NULL is undefined behaviour. + * + * @par Notes + * @parblock + * The directive accesses a device provided by the Clock Driver to get the time + * in the highest resolution available to the system. Alternatively, the + * rtems_clock_get_realtime_coarse() directive may be used to get the time in a + * lower resolution and with less runtime overhead. + * + * See rtems_clock_get_realtime_bintime() and + * rtems_clock_get_realtime_timeval() to get the time in alternative formats. + * @endparblock + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive may be called from within any runtime context. + * + * * The directive will not cause the calling task to be preempted. + * + * * The directive requires a Clock Driver. + * @endparblock + */ +void rtems_clock_get_realtime( struct timespec *time_snapshot ); + +/* Generated from spec:/rtems/clock/if/get-realtime-bintime */ + +/** + * @ingroup RTEMSAPIClassicClock + * + * @brief Gets the time elapsed since the Unix epoch measured using + * CLOCK_REALTIME in binary time format. + * + * @param[out] time_snapshot is the pointer to a bintime object. The time + * elapsed since the Unix epoch measured using the CLOCK_REALTIME at some + * time point during the directive call will be stored in this object. + * Calling the directive with a pointer equal to NULL is undefined behaviour. + * + * @par Notes + * @parblock + * The directive accesses a device provided by the Clock Driver to get the time + * in the highest resolution available to the system. Alternatively, the + * rtems_clock_get_realtime_coarse_bintime() directive may be used to get the + * time in a lower resolution and with less runtime overhead. + * + * See rtems_clock_get_realtime() and rtems_clock_get_realtime_timeval() to get + * the time in alternative formats. + * @endparblock + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive may be called from within any runtime context. + * + * * The directive will not cause the calling task to be preempted. + * + * * The directive requires a Clock Driver. + * @endparblock + */ +void rtems_clock_get_realtime_bintime( struct bintime *time_snapshot ); + +/* Generated from spec:/rtems/clock/if/get-realtime-timeval */ + +/** + * @ingroup RTEMSAPIClassicClock + * + * @brief Gets the time elapsed since the Unix epoch measured using + * CLOCK_REALTIME in seconds and microseconds format. + * + * @param[out] time_snapshot is the pointer to a struct timeval object. The + * time elapsed since the Unix epoch measured using the CLOCK_REALTIME at + * some time point during the directive call will be stored in this object. + * Calling the directive with a pointer equal to NULL is undefined behaviour. + * + * @par Notes + * @parblock + * The directive accesses a device provided by the Clock Driver to get the time + * in the highest resolution available to the system. Alternatively, the + * rtems_clock_get_realtime_coarse_timeval() directive may be used to get the + * time in a lower resolution and with less runtime overhead. + * + * See rtems_clock_get_realtime() and rtems_clock_get_realtime_bintime() to get + * the time in alternative formats. + * @endparblock + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive may be called from within any runtime context. + * + * * The directive will not cause the calling task to be preempted. + * + * * The directive requires a Clock Driver. + * @endparblock + */ +void rtems_clock_get_realtime_timeval( struct timeval *time_snapshot ); + +/* Generated from spec:/rtems/clock/if/get-realtime-coarse */ + +/** + * @ingroup RTEMSAPIClassicClock + * + * @brief Gets the time elapsed since the Unix epoch measured using + * CLOCK_REALTIME in coarse resolution in seconds and nanoseconds format. + * + * @param[out] time_snapshot is the pointer to a struct timespec object. The + * time elapsed since the Unix epoch measured using the CLOCK_REALTIME at + * some time point close to the directive call will be stored in this object. + * Calling the directive with a pointer equal to NULL is undefined behaviour. + * + * @par Notes + * @parblock + * The directive does not access a device to get the time. It uses a recent + * snapshot provided by the Clock Driver. Alternatively, the + * rtems_clock_get_realtime() directive may be used to get the time in a higher + * resolution and with a higher runtime overhead. + * + * See rtems_clock_get_realtime_coarse_bintime() and + * rtems_clock_get_realtime_coarse_timeval() to get the time in alternative + * formats. + * @endparblock + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive may be called from within any runtime context. + * + * * The directive will not cause the calling task to be preempted. + * + * * The directive requires a Clock Driver. + * @endparblock + */ +void rtems_clock_get_realtime_coarse( struct timespec *time_snapshot ); + +/* Generated from spec:/rtems/clock/if/get-realtime-coarse-bintime */ + +/** + * @ingroup RTEMSAPIClassicClock + * + * @brief Gets the time elapsed since the Unix epoch measured using + * CLOCK_REALTIME in coarse resolution in binary time format. + * + * @param[out] time_snapshot is the pointer to a bintime object. The time + * elapsed since the Unix epoch measured using the CLOCK_REALTIME at some + * time point close to the directive call will be stored in this object. + * Calling the directive with a pointer equal to NULL is undefined behaviour. + * + * @par Notes + * @parblock + * The directive does not access a device to get the time. It uses a recent + * snapshot provided by the Clock Driver. Alternatively, the + * rtems_clock_get_realtime_bintime() directive may be used to get the time in + * a higher resolution and with a higher runtime overhead. + * + * See rtems_clock_get_realtime_coarse() and + * rtems_clock_get_realtime_coarse_timeval() to get the time in alternative + * formats. + * @endparblock + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive may be called from within any runtime context. + * + * * The directive will not cause the calling task to be preempted. + * + * * The directive requires a Clock Driver. + * @endparblock + */ +void rtems_clock_get_realtime_coarse_bintime( struct bintime *time_snapshot ); + +/* Generated from spec:/rtems/clock/if/get-realtime-coarse-timeval */ + +/** + * @ingroup RTEMSAPIClassicClock + * + * @brief Gets the time elapsed since the Unix epoch measured using + * CLOCK_REALTIME in coarse resolution in seconds and microseconds format. + * + * @param[out] time_snapshot is the pointer to a struct timeval object. The + * time elapsed since the Unix epoch measured using the CLOCK_REALTIME at + * some time point close to the directive call will be stored in this object. + * Calling the directive with a pointer equal to NULL is undefined behaviour. + * + * @par Notes + * @parblock + * The directive does not access a device to get the time. It uses a recent + * snapshot provided by the Clock Driver. Alternatively, the + * rtems_clock_get_realtime_timeval() directive may be used to get the time in + * a higher resolution and with a higher runtime overhead. + * + * See rtems_clock_get_realtime_coarse() and + * rtems_clock_get_realtime_coarse_timeval() to get the time in alternative + * formats. + * @endparblock + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive may be called from within any runtime context. + * + * * The directive will not cause the calling task to be preempted. + * + * * The directive requires a Clock Driver. + * @endparblock + */ +void rtems_clock_get_realtime_coarse_timeval( struct timeval *time_snapshot ); + +/* Generated from spec:/rtems/clock/if/get-monotonic */ + +/** + * @ingroup RTEMSAPIClassicClock + * + * @brief Gets the time elapsed since some fixed time point in the past + * measured using the CLOCK_MONOTONIC in seconds and nanoseconds format. + * + * @param[out] time_snapshot is the pointer to a struct timespec object. The + * time elapsed since some fixed time point in the past measured using the + * CLOCK_MONOTONIC at some time point during the directive call will be + * stored in this object. Calling the directive with a pointer equal to NULL + * is undefined behaviour. + * + * @par Notes + * @parblock + * The directive accesses a device provided by the Clock Driver to get the time + * in the highest resolution available to the system. Alternatively, the + * rtems_clock_get_monotonic_coarse() directive may be used to get the time + * with in a lower resolution and with less runtime overhead. + * + * See rtems_clock_get_monotonic_bintime(), + * rtems_clock_get_monotonic_sbintime(), and + * rtems_clock_get_monotonic_timeval() to get the time in alternative formats. + * @endparblock + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive may be called from within any runtime context. + * + * * The directive will not cause the calling task to be preempted. + * + * * The directive requires a Clock Driver. + * @endparblock + */ +void rtems_clock_get_monotonic( struct timespec *time_snapshot ); + +/* Generated from spec:/rtems/clock/if/get-monotonic-bintime */ + +/** + * @ingroup RTEMSAPIClassicClock + * + * @brief Gets the time elapsed since some fixed time point in the past + * measured using the CLOCK_MONOTONIC in binary time format. + * + * @param[out] time_snapshot is the pointer to a bintime object. The time + * elapsed since some fixed time point in the past measured using the + * CLOCK_MONOTONIC at some time point during the directive call will be + * stored in this object. Calling the directive with a pointer equal to NULL + * is undefined behaviour. + * + * @par Notes + * @parblock + * The directive accesses a device provided by the Clock Driver to get the time + * in the highest resolution available to the system. Alternatively, the + * rtems_clock_get_monotonic_coarse_bintime() directive may be used to get the + * time in a lower resolution and with less runtime overhead. + * + * See rtems_clock_get_monotonic(), rtems_clock_get_monotonic_sbintime(), and + * rtems_clock_get_monotonic_timeval() to get the time in alternative formats. + * @endparblock + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive may be called from within any runtime context. + * + * * The directive will not cause the calling task to be preempted. + * + * * The directive requires a Clock Driver. + * @endparblock + */ +void rtems_clock_get_monotonic_bintime( struct bintime *time_snapshot ); + +/* Generated from spec:/rtems/clock/if/get-monotonic-sbintime */ + +/** + * @ingroup RTEMSAPIClassicClock + * + * @brief Gets the time elapsed since some fixed time point in the past + * measured using the CLOCK_MONOTONIC in signed binary time format. + * + * @return Returns the time elapsed since some fixed time point in the past + * measured using the CLOCK_MONOTONIC at some time point during the directive + * call. + * + * @par Notes + * @parblock + * The directive accesses a device provided by the Clock Driver to get the time + * in the highest resolution available to the system. + * + * See rtems_clock_get_monotonic(), rtems_clock_get_monotonic_bintime(), and + * rtems_clock_get_monotonic_timeval() to get the time in alternative formats. + * @endparblock + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive may be called from within any runtime context. + * + * * The directive will not cause the calling task to be preempted. + * + * * The directive requires a Clock Driver. + * @endparblock + */ +int64_t rtems_clock_get_monotonic_sbintime( void ); + +/* Generated from spec:/rtems/clock/if/get-monotonic-timeval */ + +/** + * @ingroup RTEMSAPIClassicClock + * + * @brief Gets the time elapsed since some fixed time point in the past + * measured using the CLOCK_MONOTONIC in seconds and microseconds format. + * + * @param[out] time_snapshot is the pointer to a struct timeval object. The + * time elapsed since some fixed time point in the past measured using the + * CLOCK_MONOTONIC at some time point during the directive call will be + * stored in this object. Calling the directive with a pointer equal to NULL + * is undefined behaviour. + * + * @par Notes + * @parblock + * The directive accesses a device provided by the Clock Driver to get the time + * in the highest resolution available to the system. Alternatively, the + * rtems_clock_get_monotonic_coarse_timeval() directive may be used to get the + * time in a lower resolution and with less runtime overhead. + * + * See rtems_clock_get_monotonic(), rtems_clock_get_monotonic_bintime(), and + * rtems_clock_get_monotonic_sbintime() to get the time in alternative formats. + * @endparblock + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive may be called from within any runtime context. + * + * * The directive will not cause the calling task to be preempted. + * + * * The directive requires a Clock Driver. + * @endparblock + */ +void rtems_clock_get_monotonic_timeval( struct timeval *time_snapshot ); + +/* Generated from spec:/rtems/clock/if/get-monotonic-coarse */ + +/** + * @ingroup RTEMSAPIClassicClock + * + * @brief Gets the time elapsed since some fixed time point in the past + * measured using the CLOCK_MONOTONIC in coarse resolution in seconds and + * nanoseconds format. + * + * @param[out] time_snapshot is the pointer to a struct timespec object. The + * time elapsed since some fixed time point in the past measured using the + * CLOCK_MONOTONIC at some time point close to the directive call will be + * stored in this object. Calling the directive with a pointer equal to NULL + * is undefined behaviour. + * + * @par Notes + * @parblock + * The directive does not access a device to get the time. It uses a recent + * snapshot provided by the Clock Driver. Alternatively, the + * rtems_clock_get_monotonic() directive may be used to get the time in a + * higher resolution and with a higher runtime overhead. + * + * See rtems_clock_get_monotonic_coarse_bintime() and + * rtems_clock_get_monotonic_coarse_timeval() to get the time in alternative + * formats. + * @endparblock + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive may be called from within any runtime context. + * + * * The directive will not cause the calling task to be preempted. + * + * * The directive requires a Clock Driver. + * @endparblock + */ +void rtems_clock_get_monotonic_coarse( struct timespec *time_snapshot ); + +/* Generated from spec:/rtems/clock/if/get-monotonic-coarse-bintime */ + +/** + * @ingroup RTEMSAPIClassicClock + * + * @brief Gets the time elapsed since some fixed time point in the past + * measured using the CLOCK_MONOTONIC in coarse resolution in binary time + * format. + * + * @param[out] time_snapshot is the pointer to a bintime object. The time + * elapsed since some fixed time point in the past measured using the + * CLOCK_MONOTONIC at some time point close to the directive call will be + * stored in this object. Calling the directive with a pointer equal to NULL + * is undefined behaviour. + * + * @par Notes + * @parblock + * The directive does not access a device to get the time. It uses a recent + * snapshot provided by the Clock Driver. Alternatively, the + * rtems_clock_get_monotonic_bintime() directive may be used to get the time in + * a higher resolution and with a higher runtime overhead. + * + * See rtems_clock_get_monotonic_coarse() and + * rtems_clock_get_monotonic_coarse_timeval() to get the time in alternative + * formats. + * @endparblock + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive may be called from within any runtime context. + * + * * The directive will not cause the calling task to be preempted. + * + * * The directive requires a Clock Driver. + * @endparblock + */ +void rtems_clock_get_monotonic_coarse_bintime( struct bintime *time_snapshot ); + +/* Generated from spec:/rtems/clock/if/get-monotonic-coarse-timeval */ + +/** + * @ingroup RTEMSAPIClassicClock + * + * @brief Gets the time elapsed since some fixed time point in the past + * measured using the CLOCK_MONOTONIC in coarse resolution in seconds and + * microseconds format. + * + * @param[out] time_snapshot is the pointer to a struct timeval object. The + * time elapsed since some fixed time point in the past measured using the + * CLOCK_MONOTONIC at some time point close to the directive call will be + * stored in this object. Calling the directive with a pointer equal to NULL + * is undefined behaviour. + * + * @par Notes + * @parblock + * The directive does not access a device to get the time. It uses a recent + * snapshot provided by the Clock Driver. Alternatively, the + * rtems_clock_get_monotonic_timeval() directive may be used to get the time in + * a higher resolution and with a higher runtime overhead. + * + * See rtems_clock_get_monotonic_coarse() and + * rtems_clock_get_monotonic_coarse_bintime() to get the time in alternative + * formats. + * @endparblock + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive may be called from within any runtime context. + * + * * The directive will not cause the calling task to be preempted. + * + * * The directive requires a Clock Driver. + * @endparblock + */ +void rtems_clock_get_monotonic_coarse_timeval( struct timeval *time_snapshot ); + +/* Generated from spec:/rtems/clock/if/get-boot-time */ + +/** + * @ingroup RTEMSAPIClassicClock + * + * @brief Gets the time elapsed since the Unix epoch at some time point during + * system initialization in seconds and nanoseconds format. + * + * @param[out] boot_time is the pointer to a struct timespec object. The time + * elapsed since the Unix epoch at some time point during system + * initialization call will be stored in this object. Calling the directive + * with a pointer equal to NULL is undefined behaviour. + * + * @par Notes + * See rtems_clock_get_boot_time_bintime() and + * rtems_clock_get_boot_time_timeval() to get the boot time in alternative + * formats. Setting the CLOCK_REALTIME will also set the boot time. + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive may be called from within any runtime context. + * + * * The directive will not cause the calling task to be preempted. + * + * * The directive requires a Clock Driver. + * @endparblock + */ +void rtems_clock_get_boot_time( struct timespec *boot_time ); + +/* Generated from spec:/rtems/clock/if/get-boot-time-bintime */ + +/** + * @ingroup RTEMSAPIClassicClock + * + * @brief Gets the time elapsed since the Unix epoch at some time point during + * system initialization in binary time format. + * + * @param[out] boot_time is the pointer to a bintime object. The time elapsed + * since the Unix epoch at some time point during system initialization call + * will be stored in this object. Calling the directive with a pointer equal + * to NULL is undefined behaviour. + * + * @par Notes + * See rtems_clock_get_boot_time() and rtems_clock_get_boot_time_timeval() to + * get the boot time in alternative formats. Setting the CLOCK_REALTIME will + * also set the boot time. + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive may be called from within any runtime context. + * + * * The directive will not cause the calling task to be preempted. + * + * * The directive requires a Clock Driver. + * @endparblock + */ +void rtems_clock_get_boot_time_bintime( struct bintime *boot_time ); + +/* Generated from spec:/rtems/clock/if/get-boot-time-timeval */ + +/** + * @ingroup RTEMSAPIClassicClock + * + * @brief Gets the time elapsed since the Unix epoch at some time point during + * system initialization in seconds and microseconds format. + * + * @param[out] boot_time is the pointer to a struct timeval object. The time + * elapsed since the Unix epoch at some time point during system + * initialization call will be stored in this object. Calling the directive + * with a pointer equal to NULL is undefined behaviour. + * + * @par Notes + * See rtems_clock_get_boot_time() and rtems_clock_get_boot_time_bintime() to + * get the boot time in alternative formats. Setting the CLOCK_REALTIME will + * also set the boot time. + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive may be called from within any runtime context. + * + * * The directive will not cause the calling task to be preempted. + * + * * The directive requires a Clock Driver. + * @endparblock + */ +void rtems_clock_get_boot_time_timeval( struct timeval *boot_time ); + /* Generated from spec:/rtems/clock/if/get-seconds-since-epoch */ /** @@ -210,10 +813,10 @@ rtems_status_code rtems_clock_get_tod_timeval( struct timeval *time_of_day ); * @brief Gets the seconds elapsed since the RTEMS epoch and the current * CLOCK_REALTIME. * - * @param[out] seconds_since_rtems_epoch is the pointer to an interval - * variable. When the directive call is successful, the seconds elapsed - * since the RTEMS epoch and the CLOCK_REALTIME at some point during the - * directive call will be stored in this variable. + * @param[out] seconds_since_rtems_epoch is the pointer to an ::rtems_interval + * object. When the directive call is successful, the seconds elapsed since + * the RTEMS epoch and the CLOCK_REALTIME at some point during the directive + * call will be stored in this object. * * @retval ::RTEMS_SUCCESSFUL The requested operation was successful. * @@ -250,8 +853,8 @@ rtems_status_code rtems_clock_get_seconds_since_epoch( * application. * * @par Notes - * The number of clock ticks per second is defined indirectly by the - * #CONFIGURE_MICROSECONDS_PER_TICK configuration option. + * The number of clock ticks per second is defined indirectly by the @ref + * CONFIGURE_MICROSECONDS_PER_TICK configuration option. * * @par Constraints * @parblock @@ -306,10 +909,10 @@ rtems_interval rtems_clock_get_ticks_since_boot( void ); * @brief Gets the seconds and nanoseconds elapsed since some time point during * the system initialization using CLOCK_MONOTONIC. * - * @param[out] uptime is the pointer to a timeval structure variable. When the + * @param[out] uptime is the pointer to a struct timespec object. When the * directive call is successful, the seconds and nanoseconds elapsed since * some time point during the system initialization and some point during the - * directive call using CLOCK_MONOTONIC will be stored in this variable. + * directive call using CLOCK_MONOTONIC will be stored in this object. * * @retval ::RTEMS_SUCCESSFUL The requested operation was successful. * @@ -336,10 +939,10 @@ rtems_status_code rtems_clock_get_uptime( struct timespec *uptime ); * @brief Gets the seconds and microseconds elapsed since some time point * during the system initialization using CLOCK_MONOTONIC. * - * @param[out] uptime is the pointer to a timeval structure variable. The - * seconds and microseconds elapsed since some time point during the system + * @param[out] uptime is the pointer to a struct timeval object. The seconds + * and microseconds elapsed since some time point during the system * initialization and some point during the directive call using - * CLOCK_MONOTONIC will be stored in this variable. The pointer shall be + * CLOCK_MONOTONIC will be stored in this object. The pointer shall be * valid, otherwise the behaviour is undefined. * * @par Constraints @@ -532,6 +1135,18 @@ static inline bool rtems_clock_tick_before( rtems_interval ticks ) * @par Notes * The directive is a legacy interface. It should not be called by * applications directly. A Clock Driver may call this directive. + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive may be called from within interrupt context. + * + * * The directive may be called from within device driver initialization + * context. + * + * * The directive may be called from within task context. + * @endparblock */ rtems_status_code rtems_clock_tick( void ); |