spec: Add /if/rtems/ratemon/*

20 files changed, 593 insertions, 0 deletions

diff --git a/spec/if/rtems/ratemon/active.yml b/spec/if/rtems/ratemon/active.yml
new file mode 100644
index 00000000..845a0954
--- /dev/null
+++ b/spec/if/rtems/ratemon/active.yml
@@ -0,0 +1,15 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+  default: null
+  variants: []
+description: null
+enabled-by: true
+interface-type: enumerator
+links: []
+name: RATE_MONOTONIC_ACTIVE
+notes: null
+type: interface
diff --git a/spec/if/rtems/ratemon/cancel.yml b/spec/if/rtems/ratemon/cancel.yml
new file mode 100644
index 00000000..e2de1b85
--- /dev/null
+++ b/spec/if/rtems/ratemon/cancel.yml
@@ -0,0 +1,30 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+  default:
+    body: null
+    params:
+    - ${../types/id:/name} ${.:/params[0]/name}
+    return: ${../status/code:/name}
+  variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/ratemon
+name: rtems_rate_monotonic_cancel
+notes: null
+params:
+- description: '%'
+  dir: null
+  name: id
+return:
+  return: null
+  return-values: []
+type: interface
diff --git a/spec/if/rtems/ratemon/create.yml b/spec/if/rtems/ratemon/create.yml
new file mode 100644
index 00000000..d220b87f
--- /dev/null
+++ b/spec/if/rtems/ratemon/create.yml
@@ -0,0 +1,34 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+  default:
+    body: null
+    params:
+    - ${../types/name:/name} ${.:/params[0]/name}
+    - ${../types/id:/name} *${.:/params[1]/name}
+    return: ${../status/code:/name}
+  variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/ratemon
+name: rtems_rate_monotonic_create
+notes: null
+params:
+- description: '%'
+  dir: null
+  name: name
+- description: '%'
+  dir: null
+  name: id
+return:
+  return: null
+  return-values: []
+type: interface
diff --git a/spec/if/rtems/ratemon/delete.yml b/spec/if/rtems/ratemon/delete.yml
new file mode 100644
index 00000000..dab6ccd1
--- /dev/null
+++ b/spec/if/rtems/ratemon/delete.yml
@@ -0,0 +1,30 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+  default:
+    body: null
+    params:
+    - ${../types/id:/name} ${.:/params[0]/name}
+    return: ${../status/code:/name}
+  variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/ratemon
+name: rtems_rate_monotonic_delete
+notes: null
+params:
+- description: '%'
+  dir: null
+  name: id
+return:
+  return: null
+  return-values: []
+type: interface
diff --git a/spec/if/rtems/ratemon/expired.yml b/spec/if/rtems/ratemon/expired.yml
new file mode 100644
index 00000000..4f3c5dfb
--- /dev/null
+++ b/spec/if/rtems/ratemon/expired.yml
@@ -0,0 +1,15 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+  default: null
+  variants: []
+description: null
+enabled-by: true
+interface-type: enumerator
+links: []
+name: RATE_MONOTONIC_EXPIRED
+notes: null
+type: interface
diff --git a/spec/if/rtems/ratemon/get-statistics.yml b/spec/if/rtems/ratemon/get-statistics.yml
new file mode 100644
index 00000000..8f6484ec
--- /dev/null
+++ b/spec/if/rtems/ratemon/get-statistics.yml
@@ -0,0 +1,34 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+  default:
+    body: null
+    params:
+    - ${../types/id:/name} ${.:/params[0]/name}
+    - ${period-statistics:/name} *${.:/params[1]/name}
+    return: ${../status/code:/name}
+  variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/ratemon
+name: rtems_rate_monotonic_get_statistics
+notes: null
+params:
+- description: '%'
+  dir: null
+  name: id
+- description: '%'
+  dir: null
+  name: statistics
+return:
+  return: null
+  return-values: []
+type: interface
diff --git a/spec/if/rtems/ratemon/get-status.yml b/spec/if/rtems/ratemon/get-status.yml
new file mode 100644
index 00000000..b478fe8b
--- /dev/null
+++ b/spec/if/rtems/ratemon/get-status.yml
@@ -0,0 +1,34 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+  default:
+    body: null
+    params:
+    - ${../types/id:/name} ${.:/params[0]/name}
+    - ${period-status:/name} *${.:/params[1]/name}
+    return: ${../status/code:/name}
+  variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/ratemon
+name: rtems_rate_monotonic_get_status
+notes: null
+params:
+- description: '%'
+  dir: null
+  name: id
+- description: '%'
+  dir: null
+  name: status
+return:
+  return: null
+  return-values: []
+type: interface
diff --git a/spec/if/rtems/ratemon/header.yml b/spec/if/rtems/ratemon/header.yml
new file mode 100644
index 00000000..dc566451
--- /dev/null
+++ b/spec/if/rtems/ratemon/header.yml
@@ -0,0 +1,11 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+interface-type: header-file
+links:
+- role: interface-placement
+  uid: /if/domains/api
+path: rtems/rtems/ratemon.h
+prefix: cpukit/include
+type: interface
diff --git a/spec/if/rtems/ratemon/ident.yml b/spec/if/rtems/ratemon/ident.yml
new file mode 100644
index 00000000..ce67b9f6
--- /dev/null
+++ b/spec/if/rtems/ratemon/ident.yml
@@ -0,0 +1,34 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+  default:
+    body: null
+    params:
+    - ${../types/name:/name} ${.:/params[0]/name}
+    - ${../types/id:/name} *${.:/params[1]/name}
+    return: ${../status/code:/name}
+  variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/ratemon
+name: rtems_rate_monotonic_ident
+notes: null
+params:
+- description: '%'
+  dir: null
+  name: name
+- description: '%'
+  dir: null
+  name: id
+return:
+  return: null
+  return-values: []
+type: interface
diff --git a/spec/if/rtems/ratemon/inactive.yml b/spec/if/rtems/ratemon/inactive.yml
new file mode 100644
index 00000000..8608f7c0
--- /dev/null
+++ b/spec/if/rtems/ratemon/inactive.yml
@@ -0,0 +1,15 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+  default: null
+  variants: []
+description: null
+enabled-by: true
+interface-type: enumerator
+links: []
+name: RATE_MONOTONIC_INACTIVE
+notes: null
+type: interface
diff --git a/spec/if/rtems/ratemon/period-states.yml b/spec/if/rtems/ratemon/period-states.yml
new file mode 100644
index 00000000..758accce
--- /dev/null
+++ b/spec/if/rtems/ratemon/period-states.yml
@@ -0,0 +1,23 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition-kind: typedef-only
+description: null
+enabled-by: true
+interface-type: enum
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/ratemon
+- role: interface-enumerator
+  uid: inactive
+- role: interface-enumerator
+  uid: active
+- role: interface-enumerator
+  uid: expired
+name: rtems_rate_monotonic_period_states
+notes: null
+type: interface
diff --git a/spec/if/rtems/ratemon/period-statistics.yml b/spec/if/rtems/ratemon/period-statistics.yml
new file mode 100644
index 00000000..68b85c64
--- /dev/null
+++ b/spec/if/rtems/ratemon/period-statistics.yml
@@ -0,0 +1,82 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+- default:
+    brief: |
+      This member is
+    definition: ${/if/c/uint32_t:/name} ${.:name}
+    description: '%'
+    kind: member
+    name: count
+  variants: []
+- default:
+    brief: |
+      This member is
+    definition: ${/if/c/uint32_t:/name} ${.:name}
+    description: '%'
+    kind: member
+    name: missed_count
+  variants: []
+- default:
+    brief: |
+      This member is
+    definition: ${/if/c/timespec:/name} ${.:name}
+    description: '%'
+    kind: member
+    name: min_cpu_time
+  variants: []
+- default:
+    brief: |
+      This member is
+    definition: ${/if/c/timespec:/name} ${.:name}
+    description: '%'
+    kind: member
+    name: max_cpu_time
+  variants: []
+- default:
+    brief: |
+      This member is
+    definition: ${/if/c/timespec:/name} ${.:name}
+    description: '%'
+    kind: member
+    name: total_cpu_time
+  variants: []
+- default:
+    brief: |
+      This member is
+    definition: ${/if/c/timespec:/name} ${.:name}
+    description: '%'
+    kind: member
+    name: min_wall_time
+  variants: []
+- default:
+    brief: |
+      This member is
+    definition: ${/if/c/timespec:/name} ${.:name}
+    description: '%'
+    kind: member
+    name: max_wall_time
+  variants: []
+- default:
+    brief: |
+      This member is
+    definition: ${/if/c/timespec:/name} ${.:name}
+    description: '%'
+    kind: member
+    name: total_wall_time
+  variants: []
+definition-kind: typedef-only
+description: null
+enabled-by: true
+interface-type: struct
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/ratemon
+name: rtems_rate_monotonic_period_statistics
+notes: null
+type: interface
diff --git a/spec/if/rtems/ratemon/period-status-define.yml b/spec/if/rtems/ratemon/period-status-define.yml
new file mode 100644
index 00000000..acc08cc5
--- /dev/null
+++ b/spec/if/rtems/ratemon/period-status-define.yml
@@ -0,0 +1,21 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This constant is the interval passed to the ${period:/name} directive to
+ obtain status information.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+  default: ${/if/impl/watchdog/no-timeout:/name}
+  variants: []
+description: null
+enabled-by: true
+interface-type: define
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/ratemon
+name: RTEMS_PERIOD_STATUS
+notes: null
+type: interface
diff --git a/spec/if/rtems/ratemon/period-status.yml b/spec/if/rtems/ratemon/period-status.yml
new file mode 100644
index 00000000..eeccd13a
--- /dev/null
+++ b/spec/if/rtems/ratemon/period-status.yml
@@ -0,0 +1,58 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+- default:
+    brief: |
+      This member is
+    definition: ${../types/id:/name} ${.:name}
+    description: '%'
+    kind: member
+    name: owner
+  variants: []
+- default:
+    brief: |
+      This member is
+    definition: ${period-states:/name} ${.:name}
+    description: '%'
+    kind: member
+    name: state
+  variants: []
+- default:
+    brief: |
+      This member is
+    definition: ${/if/c/timespec:/name} ${.:name}
+    description: '%'
+    kind: member
+    name: since_last_period
+  variants: []
+- default:
+    brief: |
+      This member is
+    definition: ${/if/c/timespec:/name} ${.:name}
+    description: '%'
+    kind: member
+    name: executed_since_last_period
+  variants: []
+- default:
+    brief: |
+      This member is
+    definition: ${/if/c/uint32_t:/name} ${.:name}
+    description: '%'
+    kind: member
+    name: postponed_jobs_count
+  variants: []
+definition-kind: typedef-only
+description: null
+enabled-by: true
+interface-type: struct
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/ratemon
+name: rtems_rate_monotonic_period_status
+notes: null
+type: interface
diff --git a/spec/if/rtems/ratemon/period.yml b/spec/if/rtems/ratemon/period.yml
new file mode 100644
index 00000000..99f8b50d
--- /dev/null
+++ b/spec/if/rtems/ratemon/period.yml
@@ -0,0 +1,34 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+  default:
+    body: null
+    params:
+    - ${../types/id:/name} ${.:/params[0]/name}
+    - ${../types/interval:/name} ${.:/params[1]/name}
+    return: ${../status/code:/name}
+  variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/ratemon
+name: rtems_rate_monotonic_period
+notes: null
+params:
+- description: '%'
+  dir: null
+  name: id
+- description: '%'
+  dir: null
+  name: length
+return:
+  return: null
+  return-values: []
+type: interface
diff --git a/spec/if/rtems/ratemon/printer.yml b/spec/if/rtems/ratemon/printer.yml
new file mode 100644
index 00000000..38e939f1
--- /dev/null
+++ b/spec/if/rtems/ratemon/printer.yml
@@ -0,0 +1,11 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+interface-type: forward-declaration
+links:
+- role: interface-placement
+  uid: header
+- role: interface-target
+  uid: ../io/printer
+type: interface
diff --git a/spec/if/rtems/ratemon/report-statistics-with-plugin.yml b/spec/if/rtems/ratemon/report-statistics-with-plugin.yml
new file mode 100644
index 00000000..728eea88
--- /dev/null
+++ b/spec/if/rtems/ratemon/report-statistics-with-plugin.yml
@@ -0,0 +1,30 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+  default:
+    body: null
+    params:
+    - const ${printer:/name} *${.:/params[0]/name}
+    return: void
+  variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/ratemon
+name: rtems_rate_monotonic_report_statistics_with_plugin
+notes: null
+params:
+- description: '%'
+  dir: null
+  name: printer
+return:
+  return: null
+  return-values: []
+type: interface
diff --git a/spec/if/rtems/ratemon/report-statistics.yml b/spec/if/rtems/ratemon/report-statistics.yml
new file mode 100644
index 00000000..2096c4f4
--- /dev/null
+++ b/spec/if/rtems/ratemon/report-statistics.yml
@@ -0,0 +1,26 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+  default:
+    body: null
+    params: []
+    return: void
+  variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/ratemon
+name: rtems_rate_monotonic_report_statistics
+notes: null
+params: []
+return:
+  return: null
+  return-values: []
+type: interface
diff --git a/spec/if/rtems/ratemon/reset-all-statistics.yml b/spec/if/rtems/ratemon/reset-all-statistics.yml
new file mode 100644
index 00000000..a99fe73c
--- /dev/null
+++ b/spec/if/rtems/ratemon/reset-all-statistics.yml
@@ -0,0 +1,26 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+  default:
+    body: null
+    params: []
+    return: void
+  variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/ratemon
+name: rtems_rate_monotonic_reset_all_statistics
+notes: null
+params: []
+return:
+  return: null
+  return-values: []
+type: interface
diff --git a/spec/if/rtems/ratemon/reset-statistics.yml b/spec/if/rtems/ratemon/reset-statistics.yml
new file mode 100644
index 00000000..05de64be
--- /dev/null
+++ b/spec/if/rtems/ratemon/reset-statistics.yml
@@ -0,0 +1,30 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+  default:
+    body: null
+    params:
+    - ${../types/id:/name} ${.:/params[0]/name}
+    return: ${../status/code:/name}
+  variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/ratemon
+name: rtems_rate_monotonic_reset_statistics
+notes: null
+params:
+- description: '%'
+  dir: null
+  name: id
+return:
+  return: null
+  return-values: []
+type: interface