diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-09-16 11:48:29 +0200 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-09-16 16:33:00 +0200 |
commit | 3bdf817950eadd75a2785b62220eb0b04533b9fd (patch) | |
tree | ed221c6de813e7a473e2882af6326bf2e5b44bd1 /spec/if/rtems/ratemon | |
parent | 724df1c5ef711c9399cd8c33b23aee40304d0332 (diff) |
spec: Group items by component
Diffstat (limited to 'spec/if/rtems/ratemon')
21 files changed, 0 insertions, 642 deletions
diff --git a/spec/if/rtems/ratemon/active.yml b/spec/if/rtems/ratemon/active.yml deleted file mode 100644 index 845a0954..00000000 --- a/spec/if/rtems/ratemon/active.yml +++ /dev/null @@ -1,15 +0,0 @@ -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 deleted file mode 100644 index f69899ef..00000000 --- a/spec/if/rtems/ratemon/cancel.yml +++ /dev/null @@ -1,30 +0,0 @@ -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: group -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 deleted file mode 100644 index 3d201c44..00000000 --- a/spec/if/rtems/ratemon/create.yml +++ /dev/null @@ -1,34 +0,0 @@ -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: group -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 deleted file mode 100644 index 11de97e2..00000000 --- a/spec/if/rtems/ratemon/delete.yml +++ /dev/null @@ -1,30 +0,0 @@ -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: group -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 deleted file mode 100644 index 4f3c5dfb..00000000 --- a/spec/if/rtems/ratemon/expired.yml +++ /dev/null @@ -1,15 +0,0 @@ -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 deleted file mode 100644 index 3451cc13..00000000 --- a/spec/if/rtems/ratemon/get-statistics.yml +++ /dev/null @@ -1,34 +0,0 @@ -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: group -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 deleted file mode 100644 index 35d672f8..00000000 --- a/spec/if/rtems/ratemon/get-status.yml +++ /dev/null @@ -1,34 +0,0 @@ -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: group -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/group.yml b/spec/if/rtems/ratemon/group.yml deleted file mode 100644 index 32ca9283..00000000 --- a/spec/if/rtems/ratemon/group.yml +++ /dev/null @@ -1,22 +0,0 @@ -SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: | - The Rate-Monotonic Manager provides facilities to implement tasks which - execute in a periodic fashion. Critically, it also gathers information about - the execution of those periods and can provide important statistics to the - user which can be used to analyze and tune the application. -copyrights: -- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -description: null -enabled-by: true -identifier: RTEMSAPIClassicRatemon -interface-type: group -links: -- role: interface-placement - uid: header -- role: interface-ingroup - uid: ../group -name: Rate-Monotonic Manager -text: | - The Classic API shall provide an interface to the Rate-Monotonic Manager. -type: interface diff --git a/spec/if/rtems/ratemon/header.yml b/spec/if/rtems/ratemon/header.yml deleted file mode 100644 index f6d0236f..00000000 --- a/spec/if/rtems/ratemon/header.yml +++ /dev/null @@ -1,12 +0,0 @@ -SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: This header file defines the Rate-Monotonic Manager API. -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 deleted file mode 100644 index 40d0bf95..00000000 --- a/spec/if/rtems/ratemon/ident.yml +++ /dev/null @@ -1,60 +0,0 @@ -SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: | - Identifies a period object by the specified object name. -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: | - This directive obtains the period identifier associated with the period name - specified in ``${.:/params[0]/name}``. -enabled-by: true -interface-type: function -links: -- role: interface-placement - uid: header -- role: interface-ingroup - uid: group -name: rtems_rate_monotonic_ident -notes: | - If the period name is not unique, then the period identifier will match the - first period with that name in the search order. However, this period - identifier is not guaranteed to correspond to the desired period. The period - identifier is used with other rate monotonic related directives to access the - period. - - The objects are searched from lowest to the highest index. Only the local - node is searched. -params: -- description: is the object name to look up. - dir: null - name: name -- description: | - is the pointer to an object identifier variable. The object identifier of - an object with the specified name will be stored in this variable, in case - of a successful operation. - dir: out - name: id -return: - return: null - return-values: - - description: | - The requested operation was successful. - value: ${../status/successful:/name} - - description: | - The ${.:/params[1]/name} parameter was ${/if/c/null:/name}. - value: ${../status/invalid-address:/name} - - description: | - The ${.:/params[0]/name} parameter was 0. - value: ${../status/invalid-name:/name} - - description: | - There was no object with the specified name on the local node. - value: ${../status/invalid-name:/name} -type: interface diff --git a/spec/if/rtems/ratemon/inactive.yml b/spec/if/rtems/ratemon/inactive.yml deleted file mode 100644 index 8608f7c0..00000000 --- a/spec/if/rtems/ratemon/inactive.yml +++ /dev/null @@ -1,15 +0,0 @@ -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 deleted file mode 100644 index 1b06a560..00000000 --- a/spec/if/rtems/ratemon/period-states.yml +++ /dev/null @@ -1,23 +0,0 @@ -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: group -- 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 deleted file mode 100644 index 515cb0dc..00000000 --- a/spec/if/rtems/ratemon/period-statistics.yml +++ /dev/null @@ -1,82 +0,0 @@ -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: group -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 deleted file mode 100644 index adebb068..00000000 --- a/spec/if/rtems/ratemon/period-status-define.yml +++ /dev/null @@ -1,21 +0,0 @@ -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: group -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 deleted file mode 100644 index 5b1fd956..00000000 --- a/spec/if/rtems/ratemon/period-status.yml +++ /dev/null @@ -1,58 +0,0 @@ -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: group -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 deleted file mode 100644 index 991c2bab..00000000 --- a/spec/if/rtems/ratemon/period.yml +++ /dev/null @@ -1,34 +0,0 @@ -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: group -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 deleted file mode 100644 index 38e939f1..00000000 --- a/spec/if/rtems/ratemon/printer.yml +++ /dev/null @@ -1,11 +0,0 @@ -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 deleted file mode 100644 index 0078fdce..00000000 --- a/spec/if/rtems/ratemon/report-statistics-with-plugin.yml +++ /dev/null @@ -1,30 +0,0 @@ -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: group -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 deleted file mode 100644 index 3a7a2702..00000000 --- a/spec/if/rtems/ratemon/report-statistics.yml +++ /dev/null @@ -1,26 +0,0 @@ -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: group -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 deleted file mode 100644 index 39a03f3b..00000000 --- a/spec/if/rtems/ratemon/reset-all-statistics.yml +++ /dev/null @@ -1,26 +0,0 @@ -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: group -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 deleted file mode 100644 index 77656624..00000000 --- a/spec/if/rtems/ratemon/reset-statistics.yml +++ /dev/null @@ -1,30 +0,0 @@ -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: group -name: rtems_rate_monotonic_reset_statistics -notes: null -params: -- description: '%' - dir: null - name: id -return: - return: null - return-values: [] -type: interface |