spec: Document clock manager

9 files changed, 134 insertions, 0 deletions

diff --git a/spec-glossary/glossary/clock-driver.yml b/spec-glossary/glossary/clock-driver.yml
new file mode 100644
index 00000000..391661ef
--- /dev/null
+++ b/spec-glossary/glossary/clock-driver.yml
@@ -0,0 +1,16 @@
+SPDX-License-Identifier: CC-BY-SA-4.0
+copyrights:
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+glossary-type: term
+links:
+- role: glossary-member
+  uid: ../glossary-general
+term: Clock Driver
+text: |
+  The Clock Driver is a driver which provides the ${clock-tick:/term} and a
+  time counter.  The time counter is used to drive the ${clock-realtime:/term}
+  and ${clock-monotonic:/term}.  The Clock Driver can be initialized by the
+  application with the ${/acfg/if/appl-needs-clock-driver:/name} and
+  ${/acfg/if/microseconds-per-tick:/name} application configuration options.
+type: glossary
diff --git a/spec-glossary/glossary/clock-monotonic.yml b/spec-glossary/glossary/clock-monotonic.yml
new file mode 100644
index 00000000..85e26d49
--- /dev/null
+++ b/spec-glossary/glossary/clock-monotonic.yml
@@ -0,0 +1,17 @@
+SPDX-License-Identifier: CC-BY-SA-4.0
+copyrights:
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+glossary-type: term
+links:
+- role: glossary-member
+  uid: ../glossary-general
+term: CLOCK_MONOTONIC
+text: |
+  The CLOCK_MONOTONIC is a clock provided by RTEMS which measures the time
+  since an unspecified starting point.  In contrast to ${clock-realtime:/term},
+  this clock cannot be set.  It may be affected by incremental adjustments for
+  example carried out by the ${ntp:/term} or the use of a ${pps:/term} signal.
+  See also ${clock-realtime:/term}, ${clock-tick:/term}, and
+  ${clock-driver:/term}.
+type: glossary
diff --git a/spec-glossary/glossary/clock-realtime.yml b/spec-glossary/glossary/clock-realtime.yml
new file mode 100644
index 00000000..ff991d38
--- /dev/null
+++ b/spec-glossary/glossary/clock-realtime.yml
@@ -0,0 +1,20 @@
+SPDX-License-Identifier: CC-BY-SA-4.0
+copyrights:
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+glossary-type: term
+links:
+- role: glossary-member
+  uid: ../glossary-general
+term: CLOCK_REALTIME
+text: |
+  The CLOCK_REALTIME is a clock provided by RTEMS which measures the real time
+  (also known as wall-clock time).  It is defined by ${posix:/term}.  In
+  particular, every day is treated as if it contains exactly 86400 seconds and
+  leap seconds are ignored.  This clock can be set by the application which may
+  result in time jumps.  It may be affected by incremental adjustments for
+  example carried out by the ${ntp:/term} or the use of a ${pps:/term} signal.
+  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.  See also
+  ${clock-monotonic:/term}, ${clock-tick:/term}, and ${clock-driver:/term}.
+type: glossary
diff --git a/spec-glossary/glossary/clock-tick.yml b/spec-glossary/glossary/clock-tick.yml
new file mode 100644
index 00000000..6e008d57
--- /dev/null
+++ b/spec-glossary/glossary/clock-tick.yml
@@ -0,0 +1,16 @@
+SPDX-License-Identifier: CC-BY-SA-4.0
+copyrights:
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+glossary-type: term
+links:
+- role: glossary-member
+  uid: ../glossary-general
+term: clock tick
+text: |
+  The clock tick is a coarse time measure provided by RTEMS.  The
+  ${clock-driver:/term} emits clock ticks at rate specified by the
+  ${/acfg/if/microseconds-per-tick:/name} application configuration option.  In
+  contrast to ${clock-realtime:/term} and ${clock-monotonic:/term}, the clock
+  tick rate is not affected by incremental adjustments.
+type: glossary
diff --git a/spec-glossary/glossary/ntp.yml b/spec-glossary/glossary/ntp.yml
new file mode 100644
index 00000000..b69272a0
--- /dev/null
+++ b/spec-glossary/glossary/ntp.yml
@@ -0,0 +1,13 @@
+SPDX-License-Identifier: CC-BY-SA-4.0
+copyrights:
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+glossary-type: term
+links:
+- role: glossary-member
+  uid: ../glossary-general
+term: NTP
+text: |
+  This term is an acronym for
+  `Network Time Protocol <https://en.wikipedia.org/wiki/Network_Time_Protocol>`_.
+type: glossary
diff --git a/spec-glossary/glossary/posix.yml b/spec-glossary/glossary/posix.yml
new file mode 100644
index 00000000..73e503a6
--- /dev/null
+++ b/spec-glossary/glossary/posix.yml
@@ -0,0 +1,13 @@
+SPDX-License-Identifier: CC-BY-SA-4.0
+copyrights:
+- Copyright (C) 2019 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+glossary-type: term
+links:
+- role: glossary-member
+  uid: ../glossary-general
+term: POSIX
+text: |
+  This term is an acronym for
+  `Portable Operating System Interface <https://en.wikipedia.org/wiki/POSIX>`_.
+type: glossary
diff --git a/spec-glossary/glossary/pps.yml b/spec-glossary/glossary/pps.yml
new file mode 100644
index 00000000..540e88d6
--- /dev/null
+++ b/spec-glossary/glossary/pps.yml
@@ -0,0 +1,13 @@
+SPDX-License-Identifier: CC-BY-SA-4.0
+copyrights:
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+glossary-type: term
+links:
+- role: glossary-member
+  uid: ../glossary-general
+term: PPS
+text: |
+  This term is an acronym for
+  `Pulse-Per-Second <https://en.wikipedia.org/wiki/Pulse-per-second_signal>`_.
+type: glossary
diff --git a/spec-glossary/glossary/rtems-epoch.yml b/spec-glossary/glossary/rtems-epoch.yml
new file mode 100644
index 00000000..e5a6e008
--- /dev/null
+++ b/spec-glossary/glossary/rtems-epoch.yml
@@ -0,0 +1,13 @@
+SPDX-License-Identifier: CC-BY-SA-4.0
+copyrights:
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+glossary-type: term
+links:
+- role: glossary-member
+  uid: ../glossary-general
+term: RTEMS epoch
+text: |
+  The RTEMS epoch is a point in time.  It is 1988-01-01T00:00:00Z in
+  `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_ time format.
+type: glossary
diff --git a/spec-glossary/glossary/unix-epoch.yml b/spec-glossary/glossary/unix-epoch.yml
new file mode 100644
index 00000000..c61c4cdf
--- /dev/null
+++ b/spec-glossary/glossary/unix-epoch.yml
@@ -0,0 +1,13 @@
+SPDX-License-Identifier: CC-BY-SA-4.0
+copyrights:
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+glossary-type: term
+links:
+- role: glossary-member
+  uid: ../glossary-general
+term: Unix epoch
+text: |
+  The Unix epoch is a point in time.  It is 1970-01-01T00:00:00Z in
+  `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_ time format.
+type: glossary