diff options
Diffstat (limited to 'c-user/clock/directives.rst')
| -rw-r--r-- | c-user/clock/directives.rst | 111 |
1 files changed, 57 insertions, 54 deletions
diff --git a/c-user/clock/directives.rst b/c-user/clock/directives.rst index b6a1069..a6e00ca 100644 --- a/c-user/clock/directives.rst +++ b/c-user/clock/directives.rst @@ -1,6 +1,6 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 -.. 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) .. This file is part of the RTEMS quality process and was automatically @@ -137,7 +137,7 @@ Gets the time of day associated with the current :term:`CLOCK_REALTIME`. .. rubric:: PARAMETERS: ``time_of_day`` - This parameter is the pointer to an :c:type:`rtems_time_of_day` object. + This parameter is the pointer to an :ref:`InterfaceRtemsTimeOfDay` object. When the directive call is successful, the time of day associated with the :term:`CLOCK_REALTIME` at some point during the directive call will be stored in this object. @@ -255,9 +255,9 @@ Gets the time elapsed since the :term:`Unix epoch` measured using .. rubric:: NOTES: The directive accesses a device provided by the :term:`Clock Driver` to get the -time in the highest precision available to the system. Alternatively, the +time in the highest resolution available to the system. Alternatively, the :ref:`InterfaceRtemsClockGetRealtimeCoarse` directive may be used to get the -time with less precision and less runtime overhead. +time in a lower resolution and with less runtime overhead. See :ref:`InterfaceRtemsClockGetRealtimeBintime` and :ref:`InterfaceRtemsClockGetRealtimeTimeval` to get the time in alternative @@ -298,7 +298,7 @@ Gets the time elapsed since the :term:`Unix epoch` measured using .. rubric:: PARAMETERS: ``time_snapshot`` - This parameter is the pointer to a :c:type:`bintime` object. The time + This parameter is the pointer to a ``struct bintime`` object. The time elapsed since the :term:`Unix epoch` measured using the :term:`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 @@ -307,9 +307,9 @@ Gets the time elapsed since the :term:`Unix epoch` measured using .. rubric:: NOTES: The directive accesses a device provided by the :term:`Clock Driver` to get the -time in the highest precision available to the system. Alternatively, the +time in the highest resolution available to the system. Alternatively, the :ref:`InterfaceRtemsClockGetRealtimeCoarseBintime` directive may be used to get -the time with less precision and less runtime overhead. +the time in a lower resolution and with less runtime overhead. See :ref:`InterfaceRtemsClockGetRealtime` and :ref:`InterfaceRtemsClockGetRealtimeTimeval` to get the time in alternative @@ -360,9 +360,9 @@ Gets the time elapsed since the :term:`Unix epoch` measured using .. rubric:: NOTES: The directive accesses a device provided by the :term:`Clock Driver` to get the -time in the highest precision available to the system. Alternatively, the +time in the highest resolution available to the system. Alternatively, the :ref:`InterfaceRtemsClockGetRealtimeCoarseTimeval` directive may be used to get -the time with less precision and less runtime overhead. +the time in a lower resolution and with less runtime overhead. See :ref:`InterfaceRtemsClockGetRealtime` and :ref:`InterfaceRtemsClockGetRealtimeBintime` to get the time in alternative @@ -392,7 +392,7 @@ rtems_clock_get_realtime_coarse() --------------------------------- Gets the time elapsed since the :term:`Unix epoch` measured using -:term:`CLOCK_REALTIME` in coarse precision in seconds and nanoseconds format. +:term:`CLOCK_REALTIME` in coarse resolution in seconds and nanoseconds format. .. rubric:: CALLING SEQUENCE: @@ -415,8 +415,8 @@ Gets the time elapsed since the :term:`Unix epoch` measured using The directive does not access a device to get the time. It uses a recent snapshot provided by the :term:`Clock Driver`. Alternatively, the -:ref:`InterfaceRtemsClockGetRealtime` directive may be used to get the time -with higher precision and higher runtime overhead. +:ref:`InterfaceRtemsClockGetRealtime` directive may be used to get the time in +a higher resolution and with a higher runtime overhead. See :ref:`InterfaceRtemsClockGetRealtimeCoarseBintime` and :ref:`InterfaceRtemsClockGetRealtimeCoarseTimeval` to get the time in @@ -446,7 +446,7 @@ rtems_clock_get_realtime_coarse_bintime() ----------------------------------------- Gets the time elapsed since the :term:`Unix epoch` measured using -:term:`CLOCK_REALTIME` in coarse precision in binary time format. +:term:`CLOCK_REALTIME` in coarse resolution in binary time format. .. rubric:: CALLING SEQUENCE: @@ -457,7 +457,7 @@ Gets the time elapsed since the :term:`Unix epoch` measured using .. rubric:: PARAMETERS: ``time_snapshot`` - This parameter is the pointer to a :c:type:`bintime` object. The time + This parameter is the pointer to a ``struct bintime`` object. The time elapsed since the :term:`Unix epoch` measured using the :term:`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 @@ -469,7 +469,7 @@ Gets the time elapsed since the :term:`Unix epoch` measured using The directive does not access a device to get the time. It uses a recent snapshot provided by the :term:`Clock Driver`. Alternatively, the :ref:`InterfaceRtemsClockGetRealtimeBintime` directive may be used to get the -time with higher precision and higher runtime overhead. +time in a higher resolution and with a higher runtime overhead. See :ref:`InterfaceRtemsClockGetRealtimeCoarse` and :ref:`InterfaceRtemsClockGetRealtimeCoarseTimeval` to get the time in @@ -499,7 +499,7 @@ rtems_clock_get_realtime_coarse_timeval() ----------------------------------------- Gets the time elapsed since the :term:`Unix epoch` measured using -:term:`CLOCK_REALTIME` in coarse precision in seconds and microseconds format. +:term:`CLOCK_REALTIME` in coarse resolution in seconds and microseconds format. .. rubric:: CALLING SEQUENCE: @@ -523,7 +523,7 @@ Gets the time elapsed since the :term:`Unix epoch` measured using The directive does not access a device to get the time. It uses a recent snapshot provided by the :term:`Clock Driver`. Alternatively, the :ref:`InterfaceRtemsClockGetRealtimeTimeval` directive may be used to get the -time with higher precision and higher runtime overhead. +time in a higher resolution and with a higher runtime overhead. See :ref:`InterfaceRtemsClockGetRealtimeCoarse` and :ref:`InterfaceRtemsClockGetRealtimeCoarseTimeval` to get the time in @@ -564,7 +564,8 @@ the :term:`CLOCK_MONOTONIC` in seconds and nanoseconds format. .. rubric:: PARAMETERS: ``time_snapshot`` - This parameter is the pointer to a :c:type:`bintime` object. The time + This parameter is the pointer to a `struct timespec + <https://en.cppreference.com/w/c/chrono/timespec>`_ object. The time elapsed since some fixed time point in the past measured using the :term:`CLOCK_MONOTONIC` at some time point during the directive call will be stored in this object. Calling the directive with a pointer equal to @@ -574,9 +575,9 @@ the :term:`CLOCK_MONOTONIC` in seconds and nanoseconds format. .. rubric:: NOTES: The directive accesses a device provided by the :term:`Clock Driver` to get the -time in the highest precision available to the system. Alternatively, the +time in the highest resolution available to the system. Alternatively, the :ref:`InterfaceRtemsClockGetMonotonicCoarse` directive may be used to get the -time with less precision and less runtime overhead. +time with in a lower resolution and with less runtime overhead. See :ref:`InterfaceRtemsClockGetMonotonicBintime`, :ref:`InterfaceRtemsClockGetMonotonicSbintime`, and @@ -618,7 +619,7 @@ the :term:`CLOCK_MONOTONIC` in binary time format. .. rubric:: PARAMETERS: ``time_snapshot`` - This parameter is the pointer to a :c:type:`bintime` object. The time + This parameter is the pointer to a ``struct bintime`` object. The time elapsed since some fixed time point in the past measured using the :term:`CLOCK_MONOTONIC` at some time point during the directive call will be stored in this object. Calling the directive with a pointer equal to @@ -628,9 +629,9 @@ the :term:`CLOCK_MONOTONIC` in binary time format. .. rubric:: NOTES: The directive accesses a device provided by the :term:`Clock Driver` to get the -time in the highest precision available to the system. Alternatively, the +time in the highest resolution available to the system. Alternatively, the :ref:`InterfaceRtemsClockGetMonotonicCoarseBintime` directive may be used to -get the time with less precision and less runtime overhead. +get the time in a lower resolution and with less runtime overhead. See :ref:`InterfaceRtemsClockGetMonotonic`, :ref:`InterfaceRtemsClockGetMonotonicSbintime`, and @@ -677,7 +678,7 @@ the :term:`CLOCK_MONOTONIC` at some time point during the directive call. .. rubric:: NOTES: The directive accesses a device provided by the :term:`Clock Driver` to get the -time in the highest precision available to the system. +time in the highest resolution available to the system. See :ref:`InterfaceRtemsClockGetMonotonic`, :ref:`InterfaceRtemsClockGetMonotonicBintime`, and @@ -719,19 +720,20 @@ the :term:`CLOCK_MONOTONIC` in seconds and microseconds format. .. rubric:: PARAMETERS: ``time_snapshot`` - This parameter is the pointer to a :c:type:`bintime` object. The time - elapsed since some fixed time point in the past measured using the - :term:`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 <https://en.cppreference.com/w/c/types/NULL>`_ is undefined + This parameter is the pointer to a `struct timeval + <https://pubs.opengroup.org/onlinepubs/009695399/basedefs/sys/time.h.html>`_ + object. The time elapsed since some fixed time point in the past measured + using the :term:`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 <https://en.cppreference.com/w/c/types/NULL>`_ is undefined behaviour. .. rubric:: NOTES: The directive accesses a device provided by the :term:`Clock Driver` to get the -time in the highest precision available to the system. Alternatively, the +time in the highest resolution available to the system. Alternatively, the :ref:`InterfaceRtemsClockGetMonotonicCoarseTimeval` directive may be used to -get the time with less precision and less runtime overhead. +get the time in a lower resolution and with less runtime overhead. See :ref:`InterfaceRtemsClockGetMonotonic`, :ref:`InterfaceRtemsClockGetMonotonicBintime`, and @@ -762,7 +764,7 @@ rtems_clock_get_monotonic_coarse() ---------------------------------- Gets the time elapsed since some fixed time point in the past measured using -the :term:`CLOCK_MONOTONIC` in coarse precision in seconds and nanoseconds +the :term:`CLOCK_MONOTONIC` in coarse resolution in seconds and nanoseconds format. .. rubric:: CALLING SEQUENCE: @@ -774,7 +776,8 @@ format. .. rubric:: PARAMETERS: ``time_snapshot`` - This parameter is the pointer to a :c:type:`bintime` object. The time + This parameter is the pointer to a `struct timespec + <https://en.cppreference.com/w/c/chrono/timespec>`_ object. The time elapsed since some fixed time point in the past measured using the :term:`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 @@ -785,8 +788,8 @@ format. The directive does not access a device to get the time. It uses a recent snapshot provided by the :term:`Clock Driver`. Alternatively, the -:ref:`InterfaceRtemsClockGetMonotonic` directive may be used to get the time -with higher precision and higher runtime overhead. +:ref:`InterfaceRtemsClockGetMonotonic` directive may be used to get the time in +a higher resolution and with a higher runtime overhead. See :ref:`InterfaceRtemsClockGetMonotonicCoarseBintime` and :ref:`InterfaceRtemsClockGetMonotonicCoarseTimeval` to get the time in @@ -816,7 +819,7 @@ rtems_clock_get_monotonic_coarse_bintime() ------------------------------------------ Gets the time elapsed since some fixed time point in the past measured using -the :term:`CLOCK_MONOTONIC` in coarse precision in binary time format. +the :term:`CLOCK_MONOTONIC` in coarse resolution in binary time format. .. rubric:: CALLING SEQUENCE: @@ -827,7 +830,7 @@ the :term:`CLOCK_MONOTONIC` in coarse precision in binary time format. .. rubric:: PARAMETERS: ``time_snapshot`` - This parameter is the pointer to a :c:type:`bintime` object. The time + This parameter is the pointer to a ``struct bintime`` object. The time elapsed since some fixed time point in the past measured using the :term:`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 @@ -839,7 +842,7 @@ the :term:`CLOCK_MONOTONIC` in coarse precision in binary time format. The directive does not access a device to get the time. It uses a recent snapshot provided by the :term:`Clock Driver`. Alternatively, the :ref:`InterfaceRtemsClockGetMonotonicBintime` directive may be used to get the -time with higher precision and higher runtime overhead. +time in a higher resolution and with a higher runtime overhead. See :ref:`InterfaceRtemsClockGetMonotonicCoarse` and :ref:`InterfaceRtemsClockGetMonotonicCoarseTimeval` to get the time in @@ -869,7 +872,7 @@ rtems_clock_get_monotonic_coarse_timeval() ------------------------------------------ Gets the time elapsed since some fixed time point in the past measured using -the :term:`CLOCK_MONOTONIC` in coarse precision in seconds and microseconds +the :term:`CLOCK_MONOTONIC` in coarse resolution in seconds and microseconds format. .. rubric:: CALLING SEQUENCE: @@ -881,11 +884,12 @@ format. .. rubric:: PARAMETERS: ``time_snapshot`` - This parameter is the pointer to a :c:type:`bintime` object. The time - elapsed since some fixed time point in the past measured using the - :term:`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 <https://en.cppreference.com/w/c/types/NULL>`_ is undefined + This parameter is the pointer to a `struct timeval + <https://pubs.opengroup.org/onlinepubs/009695399/basedefs/sys/time.h.html>`_ + object. The time elapsed since some fixed time point in the past measured + using the :term:`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 <https://en.cppreference.com/w/c/types/NULL>`_ is undefined behaviour. .. rubric:: NOTES: @@ -893,7 +897,7 @@ format. The directive does not access a device to get the time. It uses a recent snapshot provided by the :term:`Clock Driver`. Alternatively, the :ref:`InterfaceRtemsClockGetMonotonicTimeval` directive may be used to get the -time with higher precision and higher runtime overhead. +time in a higher resolution and with a higher runtime overhead. See :ref:`InterfaceRtemsClockGetMonotonicCoarse` and :ref:`InterfaceRtemsClockGetMonotonicCoarseBintime` to get the time in @@ -983,7 +987,7 @@ system initialization in binary time format. .. rubric:: PARAMETERS: ``boot_time`` - This parameter is the pointer to a :c:type:`bintime` object. The time + This parameter is the pointer to a ``struct bintime`` object. The time elapsed since the :term:`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 @@ -1082,8 +1086,8 @@ Gets the seconds elapsed since the :term:`RTEMS epoch` and the current .. rubric:: PARAMETERS: ``seconds_since_rtems_epoch`` - This parameter is the pointer to an :c:type:`rtems_interval` object. When - the directive call is successful, the seconds elapsed since the + This parameter is the pointer to an :ref:`InterfaceRtemsInterval` object. + When the directive call is successful, the seconds elapsed since the :term:`RTEMS epoch` and the :term:`CLOCK_REALTIME` at some point during the directive call will be stored in this object. @@ -1218,12 +1222,11 @@ system initialization using :term:`CLOCK_MONOTONIC`. .. rubric:: PARAMETERS: ``uptime`` - This parameter is the pointer to a `struct timeval - <https://pubs.opengroup.org/onlinepubs/009695399/basedefs/sys/time.h.html>`_ - 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 :term:`CLOCK_MONOTONIC` will be - stored in this object. + This parameter is the pointer to a `struct timespec + <https://en.cppreference.com/w/c/chrono/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 :term:`CLOCK_MONOTONIC` will be stored in this object. .. rubric:: RETURN VALUES: |