diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-10-19 17:00:28 +0200 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-10-28 19:51:56 +0200 |
| commit | a312b2b0bbbaf87e7d08af74288cecdb3be3db68 (patch) | |
| tree | e26b585aebdd5e83cb8a14f1b7ab8aa7a42bd0e4 | |
| parent | spec: Add idle task stack allocator option (diff) | |
| download | rtems-central-a312b2b0bbbaf87e7d08af74288cecdb3be3db68.tar.bz2 | |
spec: Clarify boot time
| -rw-r--r-- | spec/rtems/clock/if/get-boot-time-bintime.yml | 15 | ||||
| -rw-r--r-- | spec/rtems/clock/if/get-boot-time-timeval.yml | 15 | ||||
| -rw-r--r-- | spec/rtems/clock/if/get-boot-time.yml | 15 |
3 files changed, 24 insertions, 21 deletions
diff --git a/spec/rtems/clock/if/get-boot-time-bintime.yml b/spec/rtems/clock/if/get-boot-time-bintime.yml index e45d6579..b1abe80f 100644 --- a/spec/rtems/clock/if/get-boot-time-bintime.yml +++ b/spec/rtems/clock/if/get-boot-time-bintime.yml @@ -1,7 +1,7 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause brief: | - Gets a time point during system initialization used by - ${/glossary/clock-realtime:/term} in binary time format. + Gets the time elapsed since the ${/glossary/unix-epoch:/term} at some time + point during system initialization in binary time format. copyrights: - Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de) definition: @@ -30,13 +30,14 @@ links: name: rtems_clock_get_boot_time_bintime notes: | See ${get-boot-time:/name} and ${get-boot-time-timeval:/name} to get the boot - time in alternative formats. + time in alternative formats. Setting the ${/glossary/clock-realtime:/term} + will also set the boot time. params: - description: | - is the pointer to a ${/c/if/bintime:/name} object. A time point during - system initialization used by ${/glossary/clock-realtime:/term} will be - stored in this object. Calling the directive with a pointer equal to - ${/c/if/null:/name} is undefined behaviour. + is the pointer to a ${/c/if/bintime:/name} object. The time elapsed since + the ${/glossary/unix-epoch:/term} at some time point during system + initialization call will be stored in this object. Calling the directive + with a pointer equal to ${/c/if/null:/name} is undefined behaviour. dir: out name: boot_time return: null diff --git a/spec/rtems/clock/if/get-boot-time-timeval.yml b/spec/rtems/clock/if/get-boot-time-timeval.yml index ef94b3ee..1bf51633 100644 --- a/spec/rtems/clock/if/get-boot-time-timeval.yml +++ b/spec/rtems/clock/if/get-boot-time-timeval.yml @@ -1,7 +1,7 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause brief: | - Gets a time point during system initialization used by - ${/glossary/clock-realtime:/term} in seconds and microseconds format. + Gets the time elapsed since the ${/glossary/unix-epoch:/term} at some time + point during system initialization in seconds and microseconds format. copyrights: - Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de) definition: @@ -30,13 +30,14 @@ links: name: rtems_clock_get_boot_time_timeval notes: | See ${get-boot-time:/name} and ${get-boot-time-bintime:/name} to get the boot - time in alternative formats. + time in alternative formats. Setting the ${/glossary/clock-realtime:/term} + will also set the boot time. params: - description: | - is the pointer to a ${/c/if/timeval:/name} object. A time point during - system initialization used by ${/glossary/clock-realtime:/term} will be - stored in this object. Calling the directive with a pointer equal to - ${/c/if/null:/name} is undefined behaviour. + is the pointer to a ${/c/if/timeval:/name} object. The time elapsed since + the ${/glossary/unix-epoch:/term} at some time point during system + initialization call will be stored in this object. Calling the directive + with a pointer equal to ${/c/if/null:/name} is undefined behaviour. dir: out name: boot_time return: null diff --git a/spec/rtems/clock/if/get-boot-time.yml b/spec/rtems/clock/if/get-boot-time.yml index b56d10ac..6b008a3c 100644 --- a/spec/rtems/clock/if/get-boot-time.yml +++ b/spec/rtems/clock/if/get-boot-time.yml @@ -1,7 +1,7 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause brief: | - Gets a time point during system initialization used by - ${/glossary/clock-realtime:/term} in seconds and nanoseconds format. + Gets the time elapsed since the ${/glossary/unix-epoch:/term} at some time + point during system initialization in seconds and nanoseconds format. copyrights: - Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de) definition: @@ -30,13 +30,14 @@ links: name: rtems_clock_get_boot_time notes: | See ${get-boot-time-bintime:/name} and ${get-boot-time-timeval:/name} to get - the boot time in alternative formats. + the boot time in alternative formats. Setting the + ${/glossary/clock-realtime:/term} will also set the boot time. params: - description: | - is the pointer to a ${/c/if/timespec:/name} object. A time point during - system initialization used by ${/glossary/clock-realtime:/term} will be - stored in this object. Calling the directive with a pointer equal to - ${/c/if/null:/name} is undefined behaviour. + is the pointer to a ${/c/if/timespec:/name} object. The time elapsed since + the ${/glossary/unix-epoch:/term} at some time point during system + initialization call will be stored in this object. Calling the directive + with a pointer equal to ${/c/if/null:/name} is undefined behaviour. dir: out name: boot_time return: null |