diff options
Diffstat (limited to 'cpukit/include/rtems/rtems/clock.h')
| -rw-r--r-- | cpukit/include/rtems/rtems/clock.h | 40 |
1 files changed, 26 insertions, 14 deletions
diff --git a/cpukit/include/rtems/rtems/clock.h b/cpukit/include/rtems/rtems/clock.h index 6cdc8d68e3..5a8d0a44f9 100644 --- a/cpukit/include/rtems/rtems/clock.h +++ b/cpukit/include/rtems/rtems/clock.h @@ -9,7 +9,7 @@ */ /* - * 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 @@ -116,8 +116,8 @@ struct bintime; * 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 @@ -451,8 +451,8 @@ void rtems_clock_get_realtime_coarse_timeval( struct timeval *time_snapshot ); * @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 bintime object. The time - * elapsed since some fixed time point in the past measured using the + * @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. @@ -562,8 +562,8 @@ int64_t rtems_clock_get_monotonic_sbintime( void ); * @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 bintime object. The time - * elapsed since some fixed time point in the past measured using the + * @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. @@ -601,8 +601,8 @@ void rtems_clock_get_monotonic_timeval( struct timeval *time_snapshot ); * measured using the CLOCK_MONOTONIC in coarse resolution in seconds and * nanoseconds 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 + * @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. @@ -681,8 +681,8 @@ void rtems_clock_get_monotonic_coarse_bintime( struct bintime *time_snapshot ); * measured using the CLOCK_MONOTONIC in coarse resolution in seconds and * microseconds 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 + * @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. @@ -853,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 @@ -909,7 +909,7 @@ 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 struct timeval object. 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 object. @@ -1135,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 ); |