spec: Update /rtems/ratemon/* documentation

16 files changed, 350 insertions, 87 deletions

diff --git a/spec/constraint/directive-creator-only.yml b/spec/constraint/directive-creator-only.yml
new file mode 100644
index 00000000..f185d773
--- /dev/null
+++ b/spec/constraint/directive-creator-only.yml
@@ -0,0 +1,11 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+links: []
+rationale: null
+scope: user
+text: |
+  The directive may be used exclusively by the task which created the
+  associated object.
+type: constraint
diff --git a/spec/rtems/ratemon/if/active.yml b/spec/rtems/ratemon/if/active.yml
index b027f96a..74580efd 100644
--- a/spec/rtems/ratemon/if/active.yml
+++ b/spec/rtems/ratemon/if/active.yml
@@ -1,7 +1,9 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: '%'
+brief: |
+  This status indicates the period is on the watchdog chain, and running.  The
+  owner may be executing or blocked waiting on another object.
 copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
 definition:
   default: null
diff --git a/spec/rtems/ratemon/if/cancel.yml b/spec/rtems/ratemon/if/cancel.yml
index 7a8dc0e5..19f2b557 100644
--- a/spec/rtems/ratemon/if/cancel.yml
+++ b/spec/rtems/ratemon/if/cancel.yml
@@ -1,7 +1,8 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: '%'
+brief: |
+  Cancels the period.
 copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
 definition:
   default:
@@ -11,22 +12,43 @@ definition:
     - ${../../type/if/id:/name} ${.:/params[0]/name}
     return: ${../../status/if/code:/name}
   variants: []
-description: null
+description: |
+  This directive cancels the rate monotonic period specified by
+  ${.:/params[0]/name}.  This period may be reinitiated by the next invocation
+  of ${period:/name}.
 enabled-by: true
-index-entries: []
+index-entries:
+- cancel a period
 interface-type: function
 links:
 - role: interface-placement
   uid: header
 - role: interface-ingroup
   uid: group
+- role: constraint
+  uid: /constraint/directive-ctx-task
+- role: constraint
+  uid: /constraint/directive-no-preempt
+- role: constraint
+  uid: /constraint/directive-creator-only
 name: rtems_rate_monotonic_cancel
 notes: null
 params:
-- description: '%'
+- description: |
+    is the rate monotonic period identifier.
   dir: null
   name: id
 return:
   return: null
-  return-values: []
+  return-values:
+  - description: |
+      The requested operation was successful.
+    value: ${../../status/if/successful:/name}
+  - description: |
+      There was no rate monotonic period associated with the identifier
+      specified by ${.:/params[0]/name}.
+    value: ${../../status/if/invalid-id:/name}
+  - description: |
+      The rate monotonic period was not created by the calling task.
+    value: ${../../status/if/not-owner-of-resource:/name}
 type: interface
diff --git a/spec/rtems/ratemon/if/expired.yml b/spec/rtems/ratemon/if/expired.yml
index f2439cc4..5c12d846 100644
--- a/spec/rtems/ratemon/if/expired.yml
+++ b/spec/rtems/ratemon/if/expired.yml
@@ -1,7 +1,10 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: '%'
+brief: |
+  This status indicates the period is off the watchdog chain, and has expired.
+  The owner may still execute and has taken too much time to complete this
+  iteration of the period.
 copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
 definition:
   default: null
diff --git a/spec/rtems/ratemon/if/get-statistics.yml b/spec/rtems/ratemon/if/get-statistics.yml
index ef05c9f6..ea2bab31 100644
--- a/spec/rtems/ratemon/if/get-statistics.yml
+++ b/spec/rtems/ratemon/if/get-statistics.yml
@@ -1,7 +1,8 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: '%'
+brief: |
+  Gets the statistics of the period.
 copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
 definition:
   default:
@@ -12,25 +13,73 @@ definition:
     - ${period-statistics:/name} *${.:/params[1]/name}
     return: ${../../status/if/code:/name}
   variants: []
-description: null
+description: |
+  This directive returns the statistics of the rate monotonic period specified
+  by ${.:/params[0]/name}.  The statistics of the period will be returned in
+  the members of the period statistics object referenced by
+  ${.:/params[1]/name}:
+
+  * The ``count`` member is set to the number of periods executed.
+
+  * The ``missed_count`` member is set to the number of periods missed.
+
+  * The ``min_cpu_time`` member is set to the least amount of processor time
+    used in the period.
+
+  * The ``max_cpu_time`` member is set to the highest amount of processor time
+    used in the period.
+
+  * The ``total_cpu_time`` member is set to the total amount of processor time
+    used in the period.
+
+  * The ``min_wall_time`` member is set to the least amount of
+    ${/glossary/clock-monotonic:/term} time used in the period.
+
+  * The ``max_wall_time`` member is set to the highest amount of
+    ${/glossary/clock-monotonic:/term} time used in the period.
+
+  * The ``total_wall_time`` member is set to the total amount of
+    ${/glossary/clock-monotonic:/term} time used in the period.
 enabled-by: true
-index-entries: []
+index-entries:
+- get statistics of period
+- obtain statistics of period
 interface-type: function
 links:
 - role: interface-placement
   uid: header
 - role: interface-ingroup
   uid: group
+- role: constraint
+  uid: /constraint/directive-ctx-task
+- role: constraint
+  uid: /constraint/directive-ctx-isr
+- role: constraint
+  uid: /constraint/directive-no-preempt
 name: rtems_rate_monotonic_get_statistics
 notes: null
 params:
-- description: '%'
+- description: |
+    is the rate monotonic period identifier.
   dir: null
   name: id
-- description: '%'
-  dir: null
-  name: statistics
+- description: |
+    is the pointer to a ${period-statistics:/name} variable.  When the
+    directive call is successful, the period statistics will be stored in this
+    variable.
+  dir: out
+  name: status
 return:
   return: null
-  return-values: []
+  return-values:
+  - description: |
+      The requested operation was successful.
+    value: ${../../status/if/successful:/name}
+  - description: |
+      There was no rate monotonic period associated with the identifier
+      specified by ${.:/params[0]/name}.
+    value: ${../../status/if/invalid-id:/name}
+  - description: |
+      The ${.:/params[1]/name} parameter was ${/c/if/null:/name}.
+    value: ${../../status/if/invalid-address:/name}
 type: interface
diff --git a/spec/rtems/ratemon/if/get-status.yml b/spec/rtems/ratemon/if/get-status.yml
index 2faff1b8..56684d05 100644
--- a/spec/rtems/ratemon/if/get-status.yml
+++ b/spec/rtems/ratemon/if/get-status.yml
@@ -1,7 +1,9 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: '%'
+brief: |
+  Gets the detailed status of the period.
 copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 2017 Kuan-Hsun Chen
 - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
 definition:
   default:
@@ -12,25 +14,72 @@ definition:
     - ${period-status:/name} *${.:/params[1]/name}
     return: ${../../status/if/code:/name}
   variants: []
-description: null
+description: |
+  This directive returns the detailed status of the rate monotonic period
+  specified by ${.:/params[0]/name}.  The detailed status of the period will be
+  returned in the members of the period status object referenced by
+  ${.:/params[1]/name}:
+
+  * The ``owner`` member is set to the identifier of the owner task of the
+    period.
+
+  * The ``state`` member is set to the current state of the period.
+
+  * The ``postponed_jobs_count`` member is set to the count of jobs which are
+    not released yet.
+
+  * If the current state of the period is ${inactive:/name}, the
+    ``since_last_period`` and ``executed_since_last_period`` members will be
+    set to zero.  Otherwise, both members will contain time information since
+    the last successful invocation of the ${period:/name} directive by the
+    owner task.  More specifically, the ``since_last_period`` member will be
+    set to the time elapsed since the last successful invocation.  The
+    ``executed_since_last_period`` member will be set to the processor time
+    consumed by the owner task since the last successful invocation.
 enabled-by: true
-index-entries: []
+index-entries:
+- get status of period
+- obtain status of period
 interface-type: function
 links:
 - role: interface-placement
   uid: header
 - role: interface-ingroup
   uid: group
+- role: constraint
+  uid: /constraint/directive-ctx-task
+- role: constraint
+  uid: /constraint/directive-ctx-isr
+- role: constraint
+  uid: /constraint/directive-no-preempt
 name: rtems_rate_monotonic_get_status
 notes: null
 params:
-- description: '%'
+- description: |
+    is the rate monotonic period identifier.
   dir: null
   name: id
-- description: '%'
-  dir: null
+- description: |
+    is the pointer to a ${period-status:/name} variable.  When the directive
+    call is successful, the detailed period status will be stored in this
+    variable.
+  dir: out
   name: status
 return:
   return: null
-  return-values: []
+  return-values:
+  - description: |
+      The requested operation was successful.
+    value: ${../../status/if/successful:/name}
+  - description: |
+      There was no rate monotonic period associated with the identifier
+      specified by ${.:/params[0]/name}.
+    value: ${../../status/if/invalid-id:/name}
+  - description: |
+      The ${.:/params[1]/name} parameter was ${/c/if/null:/name}.
+    value: ${../../status/if/invalid-address:/name}
+  - description: |
+      There was no status available due to a reset of the processor time usage
+      of the owner task of the period.
+    value: ${../../status/if/not-defined:/name}
 type: interface
diff --git a/spec/rtems/ratemon/if/group.yml b/spec/rtems/ratemon/if/group.yml
index 850aba31..8b044a5a 100644
--- a/spec/rtems/ratemon/if/group.yml
+++ b/spec/rtems/ratemon/if/group.yml
@@ -17,6 +17,28 @@ links:
   uid: header
 - role: interface-ingroup
   uid: ../../if/group
+- role: placement-order
+  uid: create
+- role: placement-order
+  uid: ident
+- role: placement-order
+  uid: cancel
+- role: placement-order
+  uid: delete
+- role: placement-order
+  uid: period
+- role: placement-order
+  uid: get-status
+- role: placement-order
+  uid: get-statistics
+- role: placement-order
+  uid: reset-statistics
+- role: placement-order
+  uid: reset-all-statistics
+- role: placement-order
+  uid: report-statistics
+- role: placement-order
+  uid: report-statistics-with-plugin
 name: Rate-Monotonic Manager
 text: |
   The Classic API shall provide an interface to the Rate-Monotonic Manager.
diff --git a/spec/rtems/ratemon/if/inactive.yml b/spec/rtems/ratemon/if/inactive.yml
index bbed252b..dc4af671 100644
--- a/spec/rtems/ratemon/if/inactive.yml
+++ b/spec/rtems/ratemon/if/inactive.yml
@@ -1,7 +1,9 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: '%'
+brief: |
+  This status indicates the period is off the watchdog chain, and has never
+  been initialized.
 copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
 definition:
   default: null
diff --git a/spec/rtems/ratemon/if/period-states.yml b/spec/rtems/ratemon/if/period-states.yml
index ffd40fe3..ec4a3b7b 100644
--- a/spec/rtems/ratemon/if/period-states.yml
+++ b/spec/rtems/ratemon/if/period-states.yml
@@ -1,7 +1,8 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: '%'
+brief: |
+  This enumeration defines the states in which a period may be.
 copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
 definition-kind: typedef-only
 description: null
diff --git a/spec/rtems/ratemon/if/period-statistics.yml b/spec/rtems/ratemon/if/period-statistics.yml
index 4d1bb6b2..8d1166e2 100644
--- a/spec/rtems/ratemon/if/period-statistics.yml
+++ b/spec/rtems/ratemon/if/period-statistics.yml
@@ -1,70 +1,75 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: '%'
+brief: |
+  This structure provides the statistics of a period.
 copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
 definition:
 - default:
     brief: |
-      This member is
+      This member contains the number of periods executed.
     definition: ${/c/if/uint32_t:/name} ${.:name}
-    description: '%'
+    description: null
     kind: member
     name: count
   variants: []
 - default:
     brief: |
-      This member is
+      This member contains the number of periods missed.
     definition: ${/c/if/uint32_t:/name} ${.:name}
-    description: '%'
+    description: null
     kind: member
     name: missed_count
   variants: []
 - default:
     brief: |
-      This member is
+      This member contains the least amount of processor time used in a period.
     definition: ${/c/if/timespec:/name} ${.:name}
-    description: '%'
+    description: null
     kind: member
     name: min_cpu_time
   variants: []
 - default:
     brief: |
-      This member is
+      This member contains the highest amount of processor time used in a
+      period.
     definition: ${/c/if/timespec:/name} ${.:name}
-    description: '%'
+    description: null
     kind: member
     name: max_cpu_time
   variants: []
 - default:
     brief: |
-      This member is
+      This member contains the total amount of processor time used in a period.
     definition: ${/c/if/timespec:/name} ${.:name}
-    description: '%'
+    description: null
     kind: member
     name: total_cpu_time
   variants: []
 - default:
     brief: |
-      This member is
+      This member contains the least amount of
+      ${/glossary/clock-monotonic:/term} time used in a period.
     definition: ${/c/if/timespec:/name} ${.:name}
-    description: '%'
+    description: null
     kind: member
     name: min_wall_time
   variants: []
 - default:
     brief: |
-      This member is
+      This member contains the highest amount of
+      ${/glossary/clock-monotonic:/term} time used in a period.
     definition: ${/c/if/timespec:/name} ${.:name}
-    description: '%'
+    description: null
     kind: member
     name: max_wall_time
   variants: []
 - default:
     brief: |
-      This member is
+      This member contains the total amount of
+      ${/glossary/clock-monotonic:/term} time used in a period.
     definition: ${/c/if/timespec:/name} ${.:name}
-    description: '%'
+    description: null
     kind: member
     name: total_wall_time
   variants: []
diff --git a/spec/rtems/ratemon/if/period-status.yml b/spec/rtems/ratemon/if/period-status.yml
index c6f52877..dea2ad13 100644
--- a/spec/rtems/ratemon/if/period-status.yml
+++ b/spec/rtems/ratemon/if/period-status.yml
@@ -1,46 +1,53 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: '%'
+brief: |
+  This structure provides the detailed status of a period.
 copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
 definition:
 - default:
     brief: |
-      This member is
+      This member contains the identifier of the owner task of the period.
     definition: ${../../type/if/id:/name} ${.:name}
-    description: '%'
+    description: null
     kind: member
     name: owner
   variants: []
 - default:
     brief: |
-      This member is
+      This member contains the state of the period.
     definition: ${period-states:/name} ${.:name}
-    description: '%'
+    description: null
     kind: member
     name: state
   variants: []
 - default:
     brief: |
-      This member is
+      This member contains the time elapsed since the last successful invocation
+      ${period:/name} using ${/glossary/clock-monotonic:/term}.
     definition: ${/c/if/timespec:/name} ${.:name}
-    description: '%'
+    description: |
+      If the period is expired or has not been initiated, then this value has
+      no meaning.
     kind: member
     name: since_last_period
   variants: []
 - default:
     brief: |
-      This member is
+      This member contains the processor time consumed by the owner task since
+      the last successful invocation ${period:/name}.
     definition: ${/c/if/timespec:/name} ${.:name}
-    description: '%'
+    description: |
+      If the period is expired or has not been initiated, then this value has
+      no meaning.
     kind: member
     name: executed_since_last_period
   variants: []
 - default:
     brief: |
-      This member is
+      This member contains the count of jobs which are not released yet.
     definition: ${/c/if/uint32_t:/name} ${.:name}
-    description: '%'
+    description: null
     kind: member
     name: postponed_jobs_count
   variants: []
diff --git a/spec/rtems/ratemon/if/period.yml b/spec/rtems/ratemon/if/period.yml
index d69aff2c..ed8c4469 100644
--- a/spec/rtems/ratemon/if/period.yml
+++ b/spec/rtems/ratemon/if/period.yml
@@ -1,7 +1,10 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: '%'
+brief: |
+  Concludes the current period and start the next period, or gets the period
+  status.
 copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 2017 Kuan-Hsun Chen
 - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
 definition:
   default:
@@ -12,25 +15,67 @@ definition:
     - ${../../type/if/interval:/name} ${.:/params[1]/name}
     return: ${../../status/if/code:/name}
   variants: []
-description: null
+description: |
+  This directive initiates the rate monotonic period specified by
+  ${.:/params[0]/name}  with a length of period ticks specified by
+  ${.:/params[1]/name}.  If the period is running, then the calling task will
+  block for the remainder of the period before reinitiating the period with the
+  specified period length.  If the period was not running (either expired or
+  never initiated), the period is immediately initiated and the directive
+  returns immediately.  If the period has expired, the postponed job will be
+  released immediately and the following calls of this directive will release
+  postponed jobs until there is no more deadline miss.
+
+  If invoked with a period length of ${period-status-define:/name} ticks, the
+  current state of the period will be returned.  The directive status indicates
+  the current state of the period.  This does not alter the state or period
+  length of the period.
 enabled-by: true
-index-entries: []
+index-entries:
+- conclude current period
+- start current period
+- period initiation
 interface-type: function
 links:
 - role: interface-placement
   uid: header
 - role: interface-ingroup
   uid: group
+- role: constraint
+  uid: /constraint/directive-ctx-task
+- role: constraint
+  uid: /constraint/directive-creator-only
 name: rtems_rate_monotonic_period
 notes: null
 params:
-- description: '%'
+- description: |
+    is the rate monotonic period identifier.
   dir: null
   name: id
-- description: '%'
+- description: |
+    is the period length in ${/glossary/clock-tick:/plural} or
+    ${period-status-define:/name} to get the period status.
   dir: null
   name: length
 return:
   return: null
-  return-values: []
+  return-values:
+  - description: |
+      The requested operation was successful.
+    value: ${../../status/if/successful:/name}
+  - description: |
+      There was no rate monotonic period associated with the identifier
+      specified by ${.:/params[0]/name}.
+    value: ${../../status/if/invalid-id:/name}
+  - description: |
+      The rate monotonic period was not created by the calling task.
+    value: ${../../status/if/not-owner-of-resource:/name}
+  - description: |
+      The rate monotonic period has never been initiated (only possible when
+      the ${.:/params[1]/name} parameter was equal to
+      ${period-status-define:/name}).
+    value: ${../../status/if/not-defined:/name}
+  - description: |
+      The rate monotonic period has expired.
+    value: ${../../status/if/timeout:/name}
 type: interface
diff --git a/spec/rtems/ratemon/if/report-statistics-with-plugin.yml b/spec/rtems/ratemon/if/report-statistics-with-plugin.yml
index dedff410..d0627908 100644
--- a/spec/rtems/ratemon/if/report-statistics-with-plugin.yml
+++ b/spec/rtems/ratemon/if/report-statistics-with-plugin.yml
@@ -1,7 +1,8 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: '%'
+brief: |
+  Reports the period statistics using the printer plugin.
 copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
 definition:
   default:
@@ -11,19 +12,28 @@ definition:
     - const ${printer:/name} *${.:/params[0]/name}
     return: void
   variants: []
-description: null
+description: |
+  This directive prints a report on all active periods which have executed at
+  least one period using the printer plugin specified by ${.:/params[0]/name}.
 enabled-by: true
-index-entries: []
+index-entries:
+- print period statistics report
+- period statistics report
 interface-type: function
 links:
 - role: interface-placement
   uid: header
 - role: interface-ingroup
   uid: group
+- role: constraint
+  uid: /constraint/directive-ctx-task
+- role: constraint
+  uid: /constraint/object-allocator
 name: rtems_rate_monotonic_report_statistics_with_plugin
 notes: null
 params:
-- description: '%'
+- description: |
+    is the printer plugin to output the report.
   dir: null
   name: printer
 return:
diff --git a/spec/rtems/ratemon/if/report-statistics.yml b/spec/rtems/ratemon/if/report-statistics.yml
index d58807ae..45683c32 100644
--- a/spec/rtems/ratemon/if/report-statistics.yml
+++ b/spec/rtems/ratemon/if/report-statistics.yml
@@ -1,7 +1,8 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: '%'
+brief: |
+  Reports the period statistics using the ${../../io/if/printk:/name} printer.
 copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
 definition:
   default:
@@ -10,15 +11,23 @@ definition:
     params: []
     return: void
   variants: []
-description: null
+description: |
+  This directive prints a report on all active periods which have executed at
+  least one period using the ${../../io/if/printk:/name} printer.
 enabled-by: true
-index-entries: []
+index-entries:
+- print period statistics report
+- period statistics report
 interface-type: function
 links:
 - role: interface-placement
   uid: header
 - role: interface-ingroup
   uid: group
+- role: constraint
+  uid: /constraint/directive-ctx-task
+- role: constraint
+  uid: /constraint/object-allocator
 name: rtems_rate_monotonic_report_statistics
 notes: null
 params: []
diff --git a/spec/rtems/ratemon/if/reset-all-statistics.yml b/spec/rtems/ratemon/if/reset-all-statistics.yml
index 896a6988..81eead70 100644
--- a/spec/rtems/ratemon/if/reset-all-statistics.yml
+++ b/spec/rtems/ratemon/if/reset-all-statistics.yml
@@ -1,7 +1,8 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: '%'
+brief: |
+  Resets the statistics of all periods.
 copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
 definition:
   default:
@@ -10,15 +11,22 @@ definition:
     params: []
     return: void
   variants: []
-description: null
+description: |
+  This directive resets the statistics information associated with all rate
+  monotonic period instances.
 enabled-by: true
-index-entries: []
+index-entries:
+- reset statistics of all periods
 interface-type: function
 links:
 - role: interface-placement
   uid: header
 - role: interface-ingroup
   uid: group
+- role: constraint
+  uid: /constraint/directive-ctx-task
+- role: constraint
+  uid: /constraint/object-allocator
 name: rtems_rate_monotonic_reset_all_statistics
 notes: null
 params: []
diff --git a/spec/rtems/ratemon/if/reset-statistics.yml b/spec/rtems/ratemon/if/reset-statistics.yml
index d2cea3cf..14e57577 100644
--- a/spec/rtems/ratemon/if/reset-statistics.yml
+++ b/spec/rtems/ratemon/if/reset-statistics.yml
@@ -1,7 +1,8 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: '%'
+brief: |
+  Resets the statistics of the period.
 copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
 definition:
   default:
@@ -11,22 +12,39 @@ definition:
     - ${../../type/if/id:/name} ${.:/params[0]/name}
     return: ${../../status/if/code:/name}
   variants: []
-description: null
+description: |
+  This directive resets the statistics of the rate monotonic period specified
+  by ${.:/params[0]/name}.
 enabled-by: true
-index-entries: []
+index-entries:
+- reset statistics of period
 interface-type: function
 links:
 - role: interface-placement
   uid: header
 - role: interface-ingroup
   uid: group
+- role: constraint
+  uid: /constraint/directive-ctx-task
+- role: constraint
+  uid: /constraint/directive-ctx-isr
+- role: constraint
+  uid: /constraint/directive-no-preempt
 name: rtems_rate_monotonic_reset_statistics
 notes: null
 params:
-- description: '%'
+- description: |
+    is the rate monotonic period identifier.
   dir: null
   name: id
 return:
   return: null
-  return-values: []
+  return-values:
+  - description: |
+      The requested operation was successful.
+    value: ${../../status/if/successful:/name}
+  - description: |
+      There was no rate monotonic period associated with the identifier
+      specified by ${.:/params[0]/name}.
+    value: ${../../status/if/invalid-id:/name}
 type: interface