summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-05-27 10:51:43 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-05-28 10:38:23 +0200
commitea176558fc14f46096e45f58cd858062acbcd150 (patch)
treeb55eb79f94330814261f541e7fb964cd02880d35
parent7f83e7fb5910f9c3f3c458dee28cfc555c0f9732 (diff)
spec: Add dedicated constraint items
-rw-r--r--spec/acfg/opt/constraintbspappmin.yml5
-rw-r--r--spec/acfg/opt/constraintidlestackarea.yml5
-rw-r--r--spec/acfg/opt/constraintisrstackalign.yml5
-rw-r--r--spec/acfg/opt/constraintisrstackarea.yml5
-rw-r--r--spec/acfg/opt/constraintmemsz.yml5
-rw-r--r--spec/acfg/opt/constraintposix.yml5
-rw-r--r--spec/acfg/opt/constraintprioclassic.yml5
-rw-r--r--spec/acfg/opt/constraintstackspace.yml5
-rw-r--r--spec/acfg/opt/constraintunlimited.yml5
-rw-r--r--spec/acfg/opt/constraintwkspace.yml5
-rw-r--r--spec/spec/constraint-role.yml23
-rw-r--r--spec/spec/constraint.yml24
12 files changed, 61 insertions, 36 deletions
diff --git a/spec/acfg/opt/constraintbspappmin.yml b/spec/acfg/opt/constraintbspappmin.yml
index 8bf21c11..6fd21648 100644
--- a/spec/acfg/opt/constraintbspappmin.yml
+++ b/spec/acfg/opt/constraintbspappmin.yml
@@ -3,10 +3,9 @@ copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
links: []
-non-functional-type: constraint
rationale: null
-requirement-type: non-functional
+scope: user
text: |
The value of this configuration option shall be greater than or equal to a
BSP-specific and application-specific minimum value.
-type: requirement
+type: constraint
diff --git a/spec/acfg/opt/constraintidlestackarea.yml b/spec/acfg/opt/constraintidlestackarea.yml
index faf99ba3..859f7dba 100644
--- a/spec/acfg/opt/constraintidlestackarea.yml
+++ b/spec/acfg/opt/constraintidlestackarea.yml
@@ -3,11 +3,10 @@ copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
links: []
-non-functional-type: constraint
rationale: null
-requirement-type: non-functional
+scope: user
text: |
The value of this configuration option shall be small enough so that the IDLE
task stack area calculation carried out by ``<rtems/confdefs.h>`` does not
overflow an integer of type ``size_t``.
-type: requirement
+type: constraint
diff --git a/spec/acfg/opt/constraintisrstackalign.yml b/spec/acfg/opt/constraintisrstackalign.yml
index e8b933bb..646313ea 100644
--- a/spec/acfg/opt/constraintisrstackalign.yml
+++ b/spec/acfg/opt/constraintisrstackalign.yml
@@ -3,10 +3,9 @@ copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
links: []
-non-functional-type: constraint
rationale: null
-requirement-type: non-functional
+scope: user
text: |
The value of this configuration option shall be aligned according to
``CPU_INTERRUPT_STACK_ALIGNMENT``.
-type: requirement
+type: constraint
diff --git a/spec/acfg/opt/constraintisrstackarea.yml b/spec/acfg/opt/constraintisrstackarea.yml
index 9100f986..7de6e162 100644
--- a/spec/acfg/opt/constraintisrstackarea.yml
+++ b/spec/acfg/opt/constraintisrstackarea.yml
@@ -3,11 +3,10 @@ copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
links: []
-non-functional-type: constraint
rationale: null
-requirement-type: non-functional
+scope: user
text: |
The value of this configuration option shall be small enough so that the
interrupt stack area calculation carried out by ``<rtems/confdefs.h>`` does
not overflow an integer of type ``size_t``.
-type: requirement
+type: constraint
diff --git a/spec/acfg/opt/constraintmemsz.yml b/spec/acfg/opt/constraintmemsz.yml
index 8fa00639..b2ebe079 100644
--- a/spec/acfg/opt/constraintmemsz.yml
+++ b/spec/acfg/opt/constraintmemsz.yml
@@ -3,11 +3,10 @@ copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
links: []
-non-functional-type: constraint
rationale: null
-requirement-type: non-functional
+scope: user
text: |
The value of this configuration option shall be less than or equal to a
BSP-specific and application-specific value which depends on the size of the
memory available to the application.
-type: requirement
+type: constraint
diff --git a/spec/acfg/opt/constraintposix.yml b/spec/acfg/opt/constraintposix.yml
index 1720d109..5602b848 100644
--- a/spec/acfg/opt/constraintposix.yml
+++ b/spec/acfg/opt/constraintposix.yml
@@ -3,12 +3,11 @@ copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
links: []
-non-functional-type: constraint
rationale: null
-requirement-type: non-functional
+scope: user
text: |
The value of this configuration option shall be zero if the POSIX API is not
enabled (e.g. RTEMS was built without the ``--enable-posix`` build
configuration option). Otherwise a compile time error in the configuration
file will occur.
-type: requirement
+type: constraint
diff --git a/spec/acfg/opt/constraintprioclassic.yml b/spec/acfg/opt/constraintprioclassic.yml
index a0f861ba..7eb9f639 100644
--- a/spec/acfg/opt/constraintprioclassic.yml
+++ b/spec/acfg/opt/constraintprioclassic.yml
@@ -3,10 +3,9 @@ copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
links: []
-non-functional-type: constraint
rationale: null
-requirement-type: non-functional
+scope: user
text: |
The value of this configuration option shall be a valid Classic API task
priority. The set of valid task priorities is scheduler-specific.
-type: requirement
+type: constraint
diff --git a/spec/acfg/opt/constraintstackspace.yml b/spec/acfg/opt/constraintstackspace.yml
index 7d444195..3a2acb07 100644
--- a/spec/acfg/opt/constraintstackspace.yml
+++ b/spec/acfg/opt/constraintstackspace.yml
@@ -3,11 +3,10 @@ copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
links: []
-non-functional-type: constraint
rationale: null
-requirement-type: non-functional
+scope: user
text: |
The value of this configuration option shall be small enough so that the task
stack space calculation carried out by ``<rtems/confdefs.h>`` does not
overflow an integer of type ``uintptr_t``.
-type: requirement
+type: constraint
diff --git a/spec/acfg/opt/constraintunlimited.yml b/spec/acfg/opt/constraintunlimited.yml
index f1cba5ff..282468f1 100644
--- a/spec/acfg/opt/constraintunlimited.yml
+++ b/spec/acfg/opt/constraintunlimited.yml
@@ -3,12 +3,11 @@ copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
links: []
-non-functional-type: constraint
rationale: null
-requirement-type: non-functional
+scope: user
text: |
The value of this configuration option may be defined through
:c:func:`rtems_resource_unlimited` the enable unlimited objects for this
object class, if the value passed to :c:func:`rtems_resource_unlimited`
satisfies all other constraints of this configuration option.
-type: requirement
+type: constraint
diff --git a/spec/acfg/opt/constraintwkspace.yml b/spec/acfg/opt/constraintwkspace.yml
index 64a8a130..4f20e1ca 100644
--- a/spec/acfg/opt/constraintwkspace.yml
+++ b/spec/acfg/opt/constraintwkspace.yml
@@ -3,11 +3,10 @@ copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
links: []
-non-functional-type: constraint
rationale: null
-requirement-type: non-functional
+scope: user
text: |
The value of this configuration option shall be small enough so that the
RTEMS Workspace size calculation carried out by ``<rtems/confdefs.h>`` does
not overflow an integer of type ``uintptr_t``.
-type: requirement
+type: constraint
diff --git a/spec/spec/constraint-role.yml b/spec/spec/constraint-role.yml
new file mode 100644
index 00000000..c57cf17f
--- /dev/null
+++ b/spec/spec/constraint-role.yml
@@ -0,0 +1,23 @@
+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
+links:
+- role: spec-member
+ uid: root
+- role: spec-refinement
+ spec-key: role
+ spec-value: constraint
+ uid: link
+spec-description: null
+spec-example: null
+spec-info:
+ dict:
+ attributes: {}
+ description: |
+ It defines the constraint role of links. The link target shall be a
+ constraint.
+ required-attributes: all
+spec-name: Constraint Link Role
+spec-type: constraint-role
+type: spec
diff --git a/spec/spec/constraint.yml b/spec/spec/constraint.yml
index 446c97f8..aa00f51f 100644
--- a/spec/spec/constraint.yml
+++ b/spec/spec/constraint.yml
@@ -6,18 +6,30 @@ links:
- role: spec-member
uid: root
- role: spec-refinement
- spec-key: role
+ spec-key: type
spec-value: constraint
- uid: link
+ uid: root
spec-description: null
spec-example: null
spec-info:
dict:
- attributes: {}
+ attributes:
+ rationale:
+ description: |
+ If the value is present, then it shall state the rationale or
+ justification of the constraint.
+ spec-type: optional-str
+ scope:
+ description: |
+ It shall be the scope of the constraint.
+ spec-type: str
+ text:
+ description: |
+ It shall state the constraint.
+ spec-type: requirement-text
description: |
- It defines the constraint role of links. The link target shall be a
- constraint.
+ This set of attributes specifies a constraint.
required-attributes: all
-spec-name: Constraint Link Role
+spec-name: Constraint Item Type
spec-type: constraint
type: spec