diff options
Diffstat (limited to 'c-user/clock/directives.rst')
| -rw-r--r-- | c-user/clock/directives.rst | 57 |
1 files changed, 30 insertions, 27 deletions
diff --git a/c-user/clock/directives.rst b/c-user/clock/directives.rst index 080968e..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. @@ -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 @@ -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 @@ -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 @@ -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 @@ -719,11 +720,12 @@ 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: @@ -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 @@ -827,7 +830,7 @@ the :term:`CLOCK_MONOTONIC` in coarse resolution 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 @@ -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: @@ -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: |