diff options
Diffstat (limited to 'eng/req/items.rst')
| -rw-r--r-- | eng/req/items.rst | 2767 |
1 files changed, 2027 insertions, 740 deletions
diff --git a/eng/req/items.rst b/eng/req/items.rst index 42a439d..286e998 100644 --- a/eng/req/items.rst +++ b/eng/req/items.rst @@ -1,6 +1,21 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 -.. Copyright (C) 2019, 2020 embedded brains GmbH (http://www.embedded-brains.de) +.. Copyright (C) 2019, 2023 embedded brains GmbH & Co. KG + +.. This file is part of the RTEMS quality process and was automatically +.. generated. If you find something that needs to be fixed or +.. worded better please post a report or patch to an RTEMS mailing list +.. or raise a bug report: +.. +.. https://www.rtems.org/bugs.html +.. +.. For information on updating and regenerating please refer to the How-To +.. section in the Software Requirements Engineering chapter of the +.. RTEMS Software Engineering manual. The manual is provided as a part of +.. a release. For development sources please refer to the online +.. documentation at: +.. +.. https://docs.rtems.org .. _ReqEngSpecificationItems: @@ -62,8 +77,6 @@ The specification item types have the following hierarchy: * :ref:`SpecTypeInterfaceCompoundItemType` - * :ref:`SpecTypeInterfaceContainerItemType` - * :ref:`SpecTypeInterfaceDefineItemType` * :ref:`SpecTypeInterfaceDomainItemType` @@ -74,20 +87,24 @@ The specification item types have the following hierarchy: * :ref:`SpecTypeInterfaceForwardDeclarationItemType` - * :ref:`SpecTypeInterfaceFunctionItemType` + * :ref:`SpecTypeInterfaceFunctionOrMacroItemType` * :ref:`SpecTypeInterfaceGroupItemType` * :ref:`SpecTypeInterfaceHeaderFileItemType` - * :ref:`SpecTypeInterfaceMacroItemType` - * :ref:`SpecTypeInterfaceTypedefItemType` + * :ref:`SpecTypeInterfaceUnspecifiedHeaderFileItemType` + * :ref:`SpecTypeInterfaceUnspecifiedItemType` * :ref:`SpecTypeInterfaceVariableItemType` + * :ref:`SpecTypeRegisterBlockItemType` + + * :ref:`SpecTypeProxyItemTypes` + * :ref:`SpecTypeRequirementItemType` * :ref:`SpecTypeFunctionalRequirementItemType` @@ -98,8 +115,22 @@ The specification item types have the following hierarchy: * :ref:`SpecTypeNonFunctionalRequirementItemType` + * :ref:`SpecTypeDesignGroupRequirementItemType` + + * :ref:`SpecTypeDesignTargetItemType` + + * :ref:`SpecTypeGenericNonFunctionalRequirementItemType` + + * :ref:`SpecTypeRuntimeMeasurementEnvironmentItemType` + + * :ref:`SpecTypeRuntimePerformanceRequirementItemType` + * :ref:`SpecTypeRequirementValidationItemType` + * :ref:`SpecTypeRequirementValidationMethod` + + * :ref:`SpecTypeRuntimeMeasurementTestItemType` + * :ref:`SpecTypeSpecificationItemType` * :ref:`SpecTypeTestCaseItemType` @@ -168,10 +199,14 @@ This type is refined by the following types: * :ref:`SpecTypeInterfaceItemType` +* :ref:`SpecTypeProxyItemTypes` + * :ref:`SpecTypeRequirementItemType` * :ref:`SpecTypeRequirementValidationItemType` +* :ref:`SpecTypeRuntimeMeasurementTestItemType` + * :ref:`SpecTypeSpecificationItemType` * :ref:`SpecTypeTestCaseItemType` @@ -187,10 +222,10 @@ This type is refined by the following types: Build Item Type ^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeRootItemType` though the ``type`` attribute -if the value is ``build``. This set of attributes specifies a build item. All -explicit attributes shall be specified. The explicit attributes for this type -are: +This type refines the :ref:`SpecTypeRootItemType` through the ``type`` +attribute if the value is ``build``. This set of attributes specifies a build +item. All explicit attributes shall be specified. The explicit attributes for +this type are: build-type The attribute value shall be a :ref:`SpecTypeName`. It shall be the build @@ -225,7 +260,7 @@ This type is refined by the following types: Build Ada Test Program Item Type ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeBuildItemType` though the ``build-type`` +This type refines the :ref:`SpecTypeBuildItemType` through the ``build-type`` attribute if the value is ``ada-test-program``. This set of attributes specifies an Ada test program executable to build. Test programs may use additional objects provided by :ref:`SpecTypeBuildObjectsItemType` items. Test @@ -259,6 +294,10 @@ cppflags The attribute value shall be a list. Each list element shall be a :ref:`SpecTypeBuildCPreprocessorOption`. +cxxflags + The attribute value shall be a list. Each list element shall be a + :ref:`SpecTypeBuildCXXCompilerOption`. + includes The attribute value shall be a list. Each list element shall be a :ref:`SpecTypeBuildIncludePath`. @@ -272,9 +311,8 @@ source :ref:`SpecTypeBuildSource`. stlib - The attribute value shall be a list of strings. It shall be a list of - external static library identifiers used to link this test program, e.g. - ``m`` for ``libm.a``. + The attribute value shall be a list. Each list element shall be a + :ref:`SpecTypeBuildLinkStaticLibraryDirective`. target The attribute value shall be a :ref:`SpecTypeBuildTarget`. @@ -301,8 +339,9 @@ Please have a look at the following example: build-type: ada-test-program cflags: [] copyrights: - - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) + - Copyright (C) 2020 embedded brains GmbH & Co. KG cppflags: [] + cxxflags: [] enabled-by: true includes: [] ldflags: [] @@ -320,7 +359,7 @@ Please have a look at the following example: Build BSP Item Type ^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeBuildItemType` though the ``build-type`` +This type refines the :ref:`SpecTypeBuildItemType` through the ``build-type`` attribute if the value is ``bsp``. This set of attributes specifies a base BSP variant to build. All explicit attributes shall be specified. The explicit attributes for this type are: @@ -367,7 +406,7 @@ Please have a look at the following example: build-type: bsp cflags: [] copyrights: - - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) + - Copyright (C) 2020 embedded brains GmbH & Co. KG cppflags: [] enabled-by: true family: mybsp @@ -405,7 +444,7 @@ Please have a look at the following example: Build Configuration File Item Type ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeBuildItemType` though the ``build-type`` +This type refines the :ref:`SpecTypeBuildItemType` through the ``build-type`` attribute if the value is ``config-file``. This set of attributes specifies a configuration file placed in the build tree. The configuration file is generated during the configure command execution and is placed in the build @@ -437,7 +476,7 @@ Please have a look at the following example: Name: ${ARCH}-rtems${__RTEMS_MAJOR__}-${BSP_NAME} # ... copyrights: - - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) + - Copyright (C) 2020 embedded brains GmbH & Co. KG enabled-by: true install-path: ${PREFIX}/lib/pkgconfig links: [] @@ -449,7 +488,7 @@ Please have a look at the following example: Build Configuration Header Item Type ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeBuildItemType` though the ``build-type`` +This type refines the :ref:`SpecTypeBuildItemType` through the ``build-type`` attribute if the value is ``config-header``. This set of attributes specifies configuration header file. The configuration header file is generated during configure command execution and is placed in the build tree. All collected @@ -477,7 +516,7 @@ target Build Group Item Type ^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeBuildItemType` though the ``build-type`` +This type refines the :ref:`SpecTypeBuildItemType` through the ``build-type`` attribute if the value is ``group``. This set of attributes provides a means to aggregate other build items and modify the build item context which is used by referenced build items. The ``includes``, ``ldflags``, ``objects``, and @@ -485,6 +524,18 @@ referenced build items. The ``includes``, ``ldflags``, ``objects``, and attributes of the build group. All explicit attributes shall be specified. The explicit attributes for this type are: +cflags + The attribute value shall be a list. Each list element shall be a + :ref:`SpecTypeBuildCCompilerOption`. + +cppflags + The attribute value shall be a list. Each list element shall be a + :ref:`SpecTypeBuildCPreprocessorOption`. + +cxxflags + The attribute value shall be a list. Each list element shall be a + :ref:`SpecTypeBuildCXXCompilerOption`. + includes The attribute value shall be a list. Each list element shall be a :ref:`SpecTypeBuildIncludePath`. @@ -512,8 +563,11 @@ Please have a look at the following example: SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause build-type: group + cflags: [] copyrights: - - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) + - Copyright (C) 2020 embedded brains GmbH & Co. KG + cppflags: [] + cxxflags: [] enabled-by: - BUILD_TESTS - BUILD_SAMPLES @@ -536,7 +590,7 @@ Please have a look at the following example: Build Library Item Type ^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeBuildItemType` though the ``build-type`` +This type refines the :ref:`SpecTypeBuildItemType` through the ``build-type`` attribute if the value is ``library``. This set of attributes specifies a static library. Library items may use additional objects provided by :ref:`SpecTypeBuildObjectsItemType` items through the build dependency links of @@ -583,7 +637,7 @@ Please have a look at the following example: cflags: - -Wno-pointer-sign copyrights: - - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) + - Copyright (C) 2020 embedded brains GmbH & Co. KG cppflags: [] cxxflags: [] enabled-by: true @@ -605,10 +659,14 @@ Please have a look at the following example: Build Objects Item Type ^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeBuildItemType` though the ``build-type`` +This type refines the :ref:`SpecTypeBuildItemType` through the ``build-type`` attribute if the value is ``objects``. This set of attributes specifies a set -of object files used to build static libraries or test programs. All explicit -attributes shall be specified. The explicit attributes for this type are: +of object files used to build static libraries or test programs. Objects Items +must not be included on multiple paths through the build dependency graph with +identical build options. Violating this can cause race conditions in the build +system due to duplicate installs and multiple instances of build tasks. All +explicit attributes shall be specified. The explicit attributes for this type +are: cflags The attribute value shall be a list. Each list element shall be a @@ -642,7 +700,7 @@ Please have a look at the following example: build-type: objects cflags: [] copyrights: - - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) + - Copyright (C) 2020 embedded brains GmbH & Co. KG cppflags: [] cxxflags: [] enabled-by: true @@ -664,7 +722,7 @@ Please have a look at the following example: Build Option Item Type ^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeBuildItemType` though the ``build-type`` +This type refines the :ref:`SpecTypeBuildItemType` through the ``build-type`` attribute if the value is ``option``. This set of attributes specifies a build option. The following explicit attributes are mandatory: @@ -672,8 +730,6 @@ option. The following explicit attributes are mandatory: * ``default`` -* ``default-by-variant`` - * ``description`` The explicit attributes for this type are: @@ -687,16 +743,11 @@ actions actions are carried out during the configure command execution. default - The attribute value shall be a :ref:`SpecTypeBuildOptionValue`. It shall be - the default value of the option if no variant-specific default value is - specified. Use ``null`` to specify that no default value exits. The - variant-specific default values may be specified by the - ``default-by-variant`` attribute. - -default-by-variant The attribute value shall be a list. Each list element shall be a - :ref:`SpecTypeBuildOptionDefaultByVariant`. The list is processed from top - to bottom. If a matching variant is found, then the processing stops. + :ref:`SpecTypeBuildOptionDefaultValue`. It shall be the list of default + values of the option. When a default value is needed, the first value on + the list which is enabled according to the enabled set is choosen. If no + value is enabled, then the default value is ``null``. description The attribute value shall be an optional string. It shall be the @@ -721,16 +772,17 @@ Please have a look at the following example: - define: null build-type: option copyrights: - - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) - default: 115200 - default-by-variant: - - value: 9600 - variants: + - Copyright (C) 2020, 2022 embedded brains GmbH & Co. KG + default: + - enabled-by: + - bsps/powerpc/motorola_powerpc - m68k/m5484FireEngine - powerpc/hsc_cm01 - - value: 19200 - variants: - - m68k/COBRA5475 + value: 9600 + - enabled-by: m68k/COBRA5475 + value: 19200 + - enabled-by: true + value: 115200 description: | Default baud for console and other serial devices. enabled-by: true @@ -744,7 +796,7 @@ Please have a look at the following example: Build Script Item Type ^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeBuildItemType` though the ``build-type`` +This type refines the :ref:`SpecTypeBuildItemType` through the ``build-type`` attribute if the value is ``script``. This set of attributes specifies a build script. The optional attributes may be required by commands executed through the scripts. The following explicit attributes are mandatory: @@ -814,9 +866,11 @@ prepare-configure context. stlib - The attribute value shall be a list of strings. It shall be a list of - external static library identifiers used to link this test program, e.g. - ``m`` for ``libm.a``. + The attribute value shall be a list. Each list element shall be a + :ref:`SpecTypeBuildLinkStaticLibraryDirective`. + +target + The attribute value shall be a :ref:`SpecTypeBuildTarget`. use-after The attribute value shall be a list. Each list element shall be a @@ -833,7 +887,7 @@ Please have a look at the following example: SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause build-type: script copyrights: - - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) + - Copyright (C) 2020 embedded brains GmbH & Co. KG default: null default-by-variant: [] do-build: | @@ -858,7 +912,7 @@ Please have a look at the following example: Build Start File Item Type ^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeBuildItemType` though the ``build-type`` +This type refines the :ref:`SpecTypeBuildItemType` through the ``build-type`` attribute if the value is ``start-file``. This set of attributes specifies a start file to build. A start file is used to link an executable. All explicit attributes shall be specified. The explicit attributes for this type are: @@ -893,7 +947,7 @@ Please have a look at the following example: asflags: [] build-type: start-file copyrights: - - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) + - Copyright (C) 2020 embedded brains GmbH & Co. KG cppflags: [] enabled-by: true includes: [] @@ -909,7 +963,7 @@ Please have a look at the following example: Build Test Program Item Type ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeBuildItemType` though the ``build-type`` +This type refines the :ref:`SpecTypeBuildItemType` through the ``build-type`` attribute if the value is ``test-program``. This set of attributes specifies a test program executable to build. Test programs may use additional objects provided by :ref:`SpecTypeBuildObjectsItemType` items. Test programs have an @@ -947,9 +1001,8 @@ source :ref:`SpecTypeBuildSource`. stlib - The attribute value shall be a list of strings. It shall be a list of - external static library identifiers used to link this test program, e.g. - ``m`` for ``libm.a``. + The attribute value shall be a list. Each list element shall be a + :ref:`SpecTypeBuildLinkStaticLibraryDirective`. target The attribute value shall be a :ref:`SpecTypeBuildTarget`. @@ -970,7 +1023,7 @@ Please have a look at the following example: build-type: test-program cflags: [] copyrights: - - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) + - Copyright (C) 2020 embedded brains GmbH & Co. KG cppflags: [] cxxflags: [] enabled-by: true @@ -992,19 +1045,15 @@ Please have a look at the following example: Constraint Item Type ^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeRootItemType` though the ``type`` attribute -if the value is ``constraint``. This set of attributes specifies a constraint. -All explicit attributes shall be specified. The explicit attributes for this -type are: +This type refines the :ref:`SpecTypeRootItemType` through the ``type`` +attribute if the value is ``constraint``. This set of attributes specifies a +constraint. All explicit attributes shall be specified. The explicit attributes +for this type are: rationale The attribute value shall be an optional string. If the value is present, then it shall state the rationale or justification of the constraint. -scope - The attribute value shall be a string. It shall be the scope of the - constraint. - text The attribute value shall be a :ref:`SpecTypeRequirementText`. It shall state the constraint. @@ -1014,10 +1063,10 @@ text Glossary Item Type ^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeRootItemType` though the ``type`` attribute -if the value is ``glossary``. This set of attributes specifies a glossary item. -All explicit attributes shall be specified. The explicit attributes for this -type are: +This type refines the :ref:`SpecTypeRootItemType` through the ``type`` +attribute if the value is ``glossary``. This set of attributes specifies a +glossary item. All explicit attributes shall be specified. The explicit +attributes for this type are: glossary-type The attribute value shall be a :ref:`SpecTypeName`. It shall be the @@ -1034,7 +1083,7 @@ This type is refined by the following types: Glossary Group Item Type ^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeGlossaryItemType` though the +This type refines the :ref:`SpecTypeGlossaryItemType` through the ``glossary-type`` attribute if the value is ``group``. This set of attributes specifies a glossary group. All explicit attributes shall be specified. The explicit attributes for this type are: @@ -1052,7 +1101,7 @@ text Glossary Term Item Type ^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeGlossaryItemType` though the +This type refines the :ref:`SpecTypeGlossaryItemType` through the ``glossary-type`` attribute if the value is ``term``. This set of attributes specifies a glossary term. All explicit attributes shall be specified. The explicit attributes for this type are: @@ -1069,15 +1118,20 @@ text Interface Item Type ^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeRootItemType` though the ``type`` attribute -if the value is ``interface``. This set of attributes specifies an interface -specification item. Interface items shall specify the interface of the software -product to other software products and the hardware. Use +This type refines the :ref:`SpecTypeRootItemType` through the ``type`` +attribute if the value is ``interface``. This set of attributes specifies an +interface specification item. Interface items shall specify the interface of +the software product to other software products and the hardware. Use :ref:`SpecTypeInterfaceDomainItemType` items to specify interface domains, for example the :term:`API`, C language, compiler, interfaces to the implementation, and the hardware. All explicit attributes shall be specified. The explicit attributes for this type are: +index-entries + The attribute value shall be a list of strings. It shall be a list of + additional document index entries. A document index entry derived from the + interface name is added automatically. + interface-type The attribute value shall be a :ref:`SpecTypeName`. It shall be the interface item type. @@ -1090,8 +1144,6 @@ This type is refined by the following types: * :ref:`SpecTypeInterfaceCompoundItemType` -* :ref:`SpecTypeInterfaceContainerItemType` - * :ref:`SpecTypeInterfaceDefineItemType` * :ref:`SpecTypeInterfaceDomainItemType` @@ -1102,26 +1154,28 @@ This type is refined by the following types: * :ref:`SpecTypeInterfaceForwardDeclarationItemType` -* :ref:`SpecTypeInterfaceFunctionItemType` +* :ref:`SpecTypeInterfaceFunctionOrMacroItemType` * :ref:`SpecTypeInterfaceGroupItemType` * :ref:`SpecTypeInterfaceHeaderFileItemType` -* :ref:`SpecTypeInterfaceMacroItemType` - * :ref:`SpecTypeInterfaceTypedefItemType` +* :ref:`SpecTypeInterfaceUnspecifiedHeaderFileItemType` + * :ref:`SpecTypeInterfaceUnspecifiedItemType` * :ref:`SpecTypeInterfaceVariableItemType` +* :ref:`SpecTypeRegisterBlockItemType` + .. _SpecTypeApplicationConfigurationGroupItemType: Application Configuration Group Item Type ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeInterfaceItemType` though the +This type refines the :ref:`SpecTypeInterfaceItemType` through the ``interface-type`` attribute if the value is ``appl-config-group``. This set of attributes specifies an application configuration group. All explicit attributes shall be specified. The explicit attributes for this type are: @@ -1143,7 +1197,7 @@ text Application Configuration Option Item Type ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeInterfaceItemType` though the +This type refines the :ref:`SpecTypeInterfaceItemType` through the ``interface-type`` attribute if the value is ``appl-config-option``. This set of attributes specifies an application configuration option. All explicit attributes shall be specified. The explicit attributes for this type are: @@ -1153,15 +1207,7 @@ appl-config-option-type application configuration option type. description - The attribute value shall be an :ref:`SpecTypeInterfaceDescription`. The - :ref:`SpecTypeApplicationConfigurationValueOptionItemType` items have an - attribute for constraints. - -index-entries - The attribute value shall be a list of strings. It shall be a list of - additional application configuration option document index entries. The - application configuration option name is automatically added to the - document index. + The attribute value shall be an :ref:`SpecTypeInterfaceDescription`. name The attribute value shall be an @@ -1170,10 +1216,6 @@ name notes The attribute value shall be an :ref:`SpecTypeInterfaceNotes`. -text - The attribute value shall be a :ref:`SpecTypeRequirementText`. It shall - state the requirement for the application configuration option. - This type is refined by the following types: * :ref:`SpecTypeApplicationConfigurationFeatureEnableOptionItemType` @@ -1188,7 +1230,7 @@ Application Configuration Feature Enable Option Item Type ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This type refines the :ref:`SpecTypeApplicationConfigurationOptionItemType` -though the ``appl-config-option-type`` attribute if the value is +through the ``appl-config-option-type`` attribute if the value is ``feature-enable``. This set of attributes specifies an application configuration feature enable option. @@ -1198,7 +1240,7 @@ Application Configuration Feature Option Item Type ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This type refines the :ref:`SpecTypeApplicationConfigurationOptionItemType` -though the ``appl-config-option-type`` attribute if the value is ``feature``. +through the ``appl-config-option-type`` attribute if the value is ``feature``. This set of attributes specifies an application configuration feature option. All explicit attributes shall be specified. The explicit attributes for this type are: @@ -1214,23 +1256,19 @@ Application Configuration Value Option Item Type This type refines the following types: -* :ref:`SpecTypeApplicationConfigurationOptionItemType` though the +* :ref:`SpecTypeApplicationConfigurationOptionItemType` through the ``appl-config-option-type`` attribute if the value is ``initializer`` -* :ref:`SpecTypeApplicationConfigurationOptionItemType` though the +* :ref:`SpecTypeApplicationConfigurationOptionItemType` through the ``appl-config-option-type`` attribute if the value is ``integer`` This set of attributes specifies application configuration initializer or integer option. All explicit attributes shall be specified. The explicit attributes for this type are: -constraints - The attribute value shall be an - :ref:`SpecTypeApplicationConfigurationOptionConstraintSet`. - default-value The attribute value shall be an :ref:`SpecTypeIntegerOrString`. It shall - shall describe the default value of the application configuration option. + describe the default value of the application configuration option. .. _SpecTypeInterfaceCompoundItemType: @@ -1239,10 +1277,10 @@ Interface Compound Item Type This type refines the following types: -* :ref:`SpecTypeInterfaceItemType` though the ``interface-type`` attribute if +* :ref:`SpecTypeInterfaceItemType` through the ``interface-type`` attribute if the value is ``struct`` -* :ref:`SpecTypeInterfaceItemType` though the ``interface-type`` attribute if +* :ref:`SpecTypeInterfaceItemType` through the ``interface-type`` attribute if the value is ``union`` This set of attributes specifies a compound (struct or union). All explicit @@ -1269,24 +1307,12 @@ name notes The attribute value shall be an :ref:`SpecTypeInterfaceNotes`. -.. _SpecTypeInterfaceContainerItemType: - -Interface Container Item Type -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -This type refines the :ref:`SpecTypeInterfaceItemType` though the -``interface-type`` attribute if the value is ``container``. Items of this type -specify an interface container. The item shall have exactly one link with the -:ref:`SpecTypeInterfacePlacementLinkRole` to an -:ref:`SpecTypeInterfaceDomainItemType` item. This link defines the interface -domain of the container. - .. _SpecTypeInterfaceDefineItemType: Interface Define Item Type ^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeInterfaceItemType` though the +This type refines the :ref:`SpecTypeInterfaceItemType` through the ``interface-type`` attribute if the value is ``define``. This set of attributes specifies a define. All explicit attributes shall be specified. The explicit attributes for this type are: @@ -1312,11 +1338,9 @@ notes Interface Domain Item Type ^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeInterfaceItemType` though the +This type refines the :ref:`SpecTypeInterfaceItemType` through the ``interface-type`` attribute if the value is ``domain``. This set of attributes -specifies an interface domain. Items of the types -:ref:`SpecTypeInterfaceContainerItemType` and -:ref:`SpecTypeInterfaceHeaderFileItemType` are placed into domains through +specifies an interface domain. Interface items are placed into domains through links with the :ref:`SpecTypeInterfacePlacementLinkRole`. All explicit attributes shall be specified. The explicit attributes for this type are: @@ -1333,7 +1357,7 @@ name Interface Enum Item Type ^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeInterfaceItemType` though the +This type refines the :ref:`SpecTypeInterfaceItemType` through the ``interface-type`` attribute if the value is ``enum``. This set of attributes specifies an enum. All explicit attributes shall be specified. The explicit attributes for this type are: @@ -1358,7 +1382,7 @@ notes Interface Enumerator Item Type ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeInterfaceItemType` though the +This type refines the :ref:`SpecTypeInterfaceItemType` through the ``interface-type`` attribute if the value is ``enumerator``. This set of attributes specifies an enumerator. All explicit attributes shall be specified. The explicit attributes for this type are: @@ -1385,36 +1409,42 @@ notes Interface Forward Declaration Item Type ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeInterfaceItemType` though the +This type refines the :ref:`SpecTypeInterfaceItemType` through the ``interface-type`` attribute if the value is ``forward-declaration``. Items of this type specify a forward declaration. The item shall have exactly one link with the :ref:`SpecTypeInterfaceTargetLinkRole` to an :ref:`SpecTypeInterfaceCompoundItemType` item. This link defines the type declared by the forward declaration. -.. _SpecTypeInterfaceFunctionItemType: +.. _SpecTypeInterfaceFunctionOrMacroItemType: -Interface Function Item Type -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Interface Function or Macro Item Type +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeInterfaceItemType` though the -``interface-type`` attribute if the value is ``function``. This set of -attributes specifies a function. All explicit attributes shall be specified. -The explicit attributes for this type are: +This type refines the following types: + +* :ref:`SpecTypeInterfaceItemType` through the ``interface-type`` attribute if + the value is ``function`` + +* :ref:`SpecTypeInterfaceItemType` through the ``interface-type`` attribute if + the value is ``macro`` + +This set of attributes specifies a function or a macro. All explicit attributes +shall be specified. The explicit attributes for this type are: brief The attribute value shall be an :ref:`SpecTypeInterfaceBriefDescription`. definition The attribute value shall be an - :ref:`SpecTypeInterfaceFunctionDefinitionDirective`. + :ref:`SpecTypeInterfaceFunctionOrMacroDefinitionDirective`. description The attribute value shall be an :ref:`SpecTypeInterfaceDescription`. name - The attribute value shall be a string. It shall be the name of the - function. + The attribute value shall be a string. It shall be the name of the function + or macro. notes The attribute value shall be an :ref:`SpecTypeInterfaceNotes`. @@ -1431,7 +1461,7 @@ return Interface Group Item Type ^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeInterfaceItemType` though the +This type refines the :ref:`SpecTypeInterfaceItemType` through the ``interface-type`` attribute if the value is ``group``. This set of attributes specifies an interface group. All explicit attributes shall be specified. The explicit attributes for this type are: @@ -1449,12 +1479,16 @@ name The attribute value shall be a string. It shall be the human readable name of the interface group. +text + The attribute value shall be a :ref:`SpecTypeRequirementText`. It shall + state the requirement for the interface group. + .. _SpecTypeInterfaceHeaderFileItemType: Interface Header File Item Type ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeInterfaceItemType` though the +This type refines the :ref:`SpecTypeInterfaceItemType` through the ``interface-type`` attribute if the value is ``header-file``. This set of attributes specifies a header file. The item shall have exactly one link with the :ref:`SpecTypeInterfacePlacementLinkRole` to an @@ -1462,6 +1496,9 @@ the :ref:`SpecTypeInterfacePlacementLinkRole` to an domain of the header file. All explicit attributes shall be specified. The explicit attributes for this type are: +brief + The attribute value shall be an :ref:`SpecTypeInterfaceBriefDescription`. + path The attribute value shall be a string. It shall be the path used to include the header file. For example :file:`rtems/confdefs.h`. @@ -1471,15 +1508,15 @@ prefix path to the header file in the interface domain. For example :file:`cpukit/include`. -.. _SpecTypeInterfaceMacroItemType: +.. _SpecTypeInterfaceTypedefItemType: -Interface Macro Item Type -^^^^^^^^^^^^^^^^^^^^^^^^^ +Interface Typedef Item Type +^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeInterfaceItemType` though the -``interface-type`` attribute if the value is ``macro``. This set of attributes -specifies a macro. All explicit attributes shall be specified. The explicit -attributes for this type are: +This type refines the :ref:`SpecTypeInterfaceItemType` through the +``interface-type`` attribute if the value is ``typedef``. This set of +attributes specifies a typedef. All explicit attributes shall be specified. The +explicit attributes for this type are: brief The attribute value shall be an :ref:`SpecTypeInterfaceBriefDescription`. @@ -1492,7 +1529,7 @@ description The attribute value shall be an :ref:`SpecTypeInterfaceDescription`. name - The attribute value shall be a string. It shall be the name of the macro. + The attribute value shall be a string. It shall be the name of the typedef. notes The attribute value shall be an :ref:`SpecTypeInterfaceNotes`. @@ -1504,52 +1541,78 @@ params return The attribute value shall be an :ref:`SpecTypeInterfaceReturnDirective`. -.. _SpecTypeInterfaceTypedefItemType: - -Interface Typedef Item Type -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -This type refines the :ref:`SpecTypeInterfaceItemType` though the -``interface-type`` attribute if the value is ``typedef``. This set of -attributes specifies a typedef. All explicit attributes shall be specified. The -explicit attributes for this type are: - -brief - The attribute value shall be an :ref:`SpecTypeInterfaceBriefDescription`. +.. _SpecTypeInterfaceUnspecifiedHeaderFileItemType: -definition - The attribute value shall be an - :ref:`SpecTypeInterfaceDefinitionDirective`. +Interface Unspecified Header File Item Type +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -description - The attribute value shall be an :ref:`SpecTypeInterfaceDescription`. +This type refines the :ref:`SpecTypeInterfaceItemType` through the +``interface-type`` attribute if the value is ``unspecified-header-file``. This +set of attributes specifies an unspecified header file. All explicit attributes +shall be specified. The explicit attributes for this type are: -name - The attribute value shall be a string. It shall be the name of the typedef. +path + The attribute value shall be a string. It shall be the path used to include + the header file. For example :file:`rtems/confdefs.h`. -notes - The attribute value shall be an :ref:`SpecTypeInterfaceNotes`. +references + The attribute value shall be a list. Each list element shall be an + :ref:`SpecTypeExternalReference`. .. _SpecTypeInterfaceUnspecifiedItemType: Interface Unspecified Item Type ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeInterfaceItemType` though the -``interface-type`` attribute if the value is ``unspecified``. This set of -attributes specifies an unspecified interface. All explicit attributes shall be -specified. The explicit attributes for this type are: +This type refines the following types: + +* :ref:`SpecTypeInterfaceItemType` through the ``interface-type`` attribute if + the value is ``unspecified-define`` + +* :ref:`SpecTypeInterfaceItemType` through the ``interface-type`` attribute if + the value is ``unspecified-enum`` + +* :ref:`SpecTypeInterfaceItemType` through the ``interface-type`` attribute if + the value is ``unspecified-enumerator`` + +* :ref:`SpecTypeInterfaceItemType` through the ``interface-type`` attribute if + the value is ``unspecified-function`` + +* :ref:`SpecTypeInterfaceItemType` through the ``interface-type`` attribute if + the value is ``unspecified-group`` + +* :ref:`SpecTypeInterfaceItemType` through the ``interface-type`` attribute if + the value is ``unspecified-macro`` + +* :ref:`SpecTypeInterfaceItemType` through the ``interface-type`` attribute if + the value is ``unspecified-object`` + +* :ref:`SpecTypeInterfaceItemType` through the ``interface-type`` attribute if + the value is ``unspecified-struct`` + +* :ref:`SpecTypeInterfaceItemType` through the ``interface-type`` attribute if + the value is ``unspecified-typedef`` + +* :ref:`SpecTypeInterfaceItemType` through the ``interface-type`` attribute if + the value is ``unspecified-union`` + +This set of attributes specifies an unspecified interface. All explicit +attributes shall be specified. The explicit attributes for this type are: name The attribute value shall be a string. It shall be the name of the unspecified interface. +references + The attribute value shall be a list. Each list element shall be an + :ref:`SpecTypeExternalReference`. + .. _SpecTypeInterfaceVariableItemType: Interface Variable Item Type ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeInterfaceItemType` though the +This type refines the :ref:`SpecTypeInterfaceItemType` through the ``interface-type`` attribute if the value is ``variable``. This set of attributes specifies a variable. All explicit attributes shall be specified. The explicit attributes for this type are: @@ -1571,13 +1634,85 @@ name notes The attribute value shall be an :ref:`SpecTypeInterfaceNotes`. +.. _SpecTypeRegisterBlockItemType: + +Register Block Item Type +^^^^^^^^^^^^^^^^^^^^^^^^ + +This type refines the :ref:`SpecTypeInterfaceItemType` through the +``interface-type`` attribute if the value is ``register-block``. This set of +attributes specifies a register block. A register block may be used to specify +the interface of devices. Register blocks consist of register block members +specified by the ``definition`` attribute. Register block members are either +instances of registers specified by the ``registers`` attribute or instances of +other register blocks specified by links with the +:ref:`SpecTypeRegisterBlockIncludeRole`. Registers consists of bit fields (see +:ref:`SpecTypeRegisterBitsDefinition`. The register block members are placed +into the address space of the device relative to the base address of the +register block. Register member offsets and the register block size are +specified in units of the address space granule. All explicit attributes shall +be specified. The explicit attributes for this type are: + +brief + The attribute value shall be an :ref:`SpecTypeInterfaceBriefDescription`. + +definition + The attribute value shall be a list. Each list element shall be a + :ref:`SpecTypeRegisterBlockMemberDefinitionDirective`. + +description + The attribute value shall be an :ref:`SpecTypeInterfaceDescription`. + +identifier + The attribute value shall be an :ref:`SpecTypeInterfaceGroupIdentifier`. + +name + The attribute value shall be a string. It shall be the name of the register + block. + +notes + The attribute value shall be an :ref:`SpecTypeInterfaceNotes`. + +register-block-group + The attribute value shall be a string. It shall be the name of the + interface group defined for the register block. For the group identifier + see the ``identifier`` attribute. + +register-block-size + The attribute value shall be an :ref:`SpecTypeOptionalInteger`. If the + value is present, then it shall be the size of the register block in units + of the address space granule. + +register-prefix + The attribute value shall be an optional string. If the value is present, + then it will be used to prefix register bit field names, otherwise the + value of the ``name`` attribute will be used. + +registers + The attribute value shall be a list. Each list element shall be a + :ref:`SpecTypeRegisterDefinition`. + +.. _SpecTypeProxyItemTypes: + +Proxy Item Types +^^^^^^^^^^^^^^^^ + +This type refines the :ref:`SpecTypeRootItemType` through the ``type`` +attribute if the value is ``proxy``. Items of similar characteristics may link +to a proxy item through links with the :ref:`SpecTypeProxyMemberLinkRole`. A +proxy item resolves to the first member item which is enabled. Proxies may be +used to provide an interface with a common name and implementations which +depend on configuration options. For example, in one configuration a constant +could be a compile time constant and in another configuration it could be a +read-only object. + .. _SpecTypeRequirementItemType: Requirement Item Type ^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeRootItemType` though the ``type`` attribute -if the value is ``requirement``. This set of attributes specifies a +This type refines the :ref:`SpecTypeRootItemType` through the ``type`` +attribute if the value is ``requirement``. This set of attributes specifies a requirement. All explicit attributes shall be specified. The explicit attributes for this type are: @@ -1586,8 +1721,8 @@ rationale then it shall state the rationale or justification of the requirement. references - The attribute value shall be a list. Each list element shall be a - :ref:`SpecTypeRequirementReference`. + The attribute value shall be a list. Each list element shall be an + :ref:`SpecTypeExternalReference`. requirement-type The attribute value shall be a :ref:`SpecTypeName`. It shall be the @@ -1609,7 +1744,7 @@ Please have a look at the following example: SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause copyrights: - - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de + - Copyright (C) 2020 embedded brains GmbH & Co. KG enabled-by: true functional-type: capability links: [] @@ -1625,7 +1760,7 @@ Please have a look at the following example: Functional Requirement Item Type ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeRequirementItemType` though the +This type refines the :ref:`SpecTypeRequirementItemType` through the ``requirement-type`` attribute if the value is ``functional``. This set of attributes specifies a functional requirement. All explicit attributes shall be specified. The explicit attributes for this type are: @@ -1645,7 +1780,7 @@ This type is refined by the following types: Action Requirement Item Type ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeFunctionalRequirementItemType` though the +This type refines the :ref:`SpecTypeFunctionalRequirementItemType` through the ``functional-type`` attribute if the value is ``action``. This set of attributes specifies functional requirements and corresponding validation test code. The functional requirements of an action are specified. An action @@ -1682,6 +1817,10 @@ pre-conditions The attribute value shall be a list. Each list element shall be an :ref:`SpecTypeActionRequirementCondition`. +skip-reasons + The attribute value shall be an + :ref:`SpecTypeActionRequirementSkipReasons`. + test-action The attribute value shall be a string. It shall be the test action code. @@ -1689,16 +1828,26 @@ test-brief The attribute value shall be an optional string. If the value is present, then it shall be the test case brief description. +test-cleanup + The attribute value shall be an optional string. If the value is present, + then it shall be the test cleanup code. The code is placed in the test + action loop body after the test post-condition checks. + test-context - The attribute value shall be a list. Each list element shall be an - :ref:`SpecTypeActionRequirementTestContextMember`. + The attribute value shall be a list. Each list element shall be a + :ref:`SpecTypeTestContextMember`. + +test-context-support + The attribute value shall be an optional string. If the value is present, + then it shall be the test context support code. The context support code + is placed at file scope before the test context definition. test-description The attribute value shall be an optional string. If the value is present, then it shall be the test case description. test-header - The attribute value shall be an :ref:`SpecTypeActionRequirementTestHeader`. + The attribute value shall be a :ref:`SpecTypeTestHeader`. test-includes The attribute value shall be a list of strings. It shall be a list of @@ -1708,16 +1857,16 @@ test-local-includes The attribute value shall be a list of strings. It shall be a list of header files included via ``#include "..."``. -test-name - The attribute value shall be a :ref:`SpecTypeTestName`. +test-prepare + The attribute value shall be an optional string. If the value is present, + then it shall be the early test preparation code. The code is placed in + the test action loop body before the test pre-condition preparations. test-setup - The attribute value shall be an - :ref:`SpecTypeActionRequirementTestFixtureMethod`. + The attribute value shall be a :ref:`SpecTypeTestSupportMethod`. test-stop - The attribute value shall be an - :ref:`SpecTypeActionRequirementTestFixtureMethod`. + The attribute value shall be a :ref:`SpecTypeTestSupportMethod`. test-support The attribute value shall be an optional string. If the value is present, @@ -1729,8 +1878,7 @@ test-target generated test case source file. test-teardown - The attribute value shall be an - :ref:`SpecTypeActionRequirementTestFixtureMethod`. + The attribute value shall be a :ref:`SpecTypeTestSupportMethod`. transition-map The attribute value shall be a list. Each list element shall be an @@ -1742,7 +1890,7 @@ Please have a look at the following example: SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause copyrights: - - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) + - Copyright (C) 2020 embedded brains GmbH & Co. KG enabled-by: true functional-type: action links: [] @@ -1810,9 +1958,11 @@ Please have a look at the following example: test-epilogue: null test-prologue: null requirement-type: functional + skip-reasons: {} test-action: | /* Call the function of the action */ test-brief: null + test-cleanup: null test-context: - brief: null description: null @@ -1820,11 +1970,12 @@ Please have a look at the following example: - brief: null description: null member: option_type option + test-context-support: null test-description: null test-header: null test-includes: [] test-local-includes: [] - test-name: RedGreenData + test-prepare: null test-setup: null test-stop: null test-support: null @@ -1865,22 +2016,24 @@ Generic Functional Requirement Item Type This type refines the following types: -* :ref:`SpecTypeFunctionalRequirementItemType` though the ``functional-type`` +* :ref:`SpecTypeFunctionalRequirementItemType` through the ``functional-type`` attribute if the value is ``capability`` -* :ref:`SpecTypeFunctionalRequirementItemType` though the ``functional-type`` +* :ref:`SpecTypeFunctionalRequirementItemType` through the ``functional-type`` attribute if the value is ``dependability-function`` -* :ref:`SpecTypeFunctionalRequirementItemType` though the ``functional-type`` +* :ref:`SpecTypeFunctionalRequirementItemType` through the ``functional-type`` attribute if the value is ``function`` -* :ref:`SpecTypeFunctionalRequirementItemType` though the ``functional-type`` +* :ref:`SpecTypeFunctionalRequirementItemType` through the ``functional-type`` + attribute if the value is ``interface-define-not-defined`` + +* :ref:`SpecTypeFunctionalRequirementItemType` through the ``functional-type`` attribute if the value is ``operational`` -* :ref:`SpecTypeFunctionalRequirementItemType` though the ``functional-type`` +* :ref:`SpecTypeFunctionalRequirementItemType` through the ``functional-type`` attribute if the value is ``safety-function`` - Items of this type state a functional requirement with the functional type defined by the specification type refinement. @@ -1889,29 +2042,279 @@ defined by the specification type refinement. Non-Functional Requirement Item Type ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeRequirementItemType` though the +This type refines the :ref:`SpecTypeRequirementItemType` through the ``requirement-type`` attribute if the value is ``non-functional``. This set of attributes specifies a non-functional requirement. All explicit attributes shall be specified. The explicit attributes for this type are: non-functional-type - The attribute value shall be a :ref:`SpecTypeRequirementNonFunctionalType`. - It shall be the non-functional type of the requirement. + The attribute value shall be a :ref:`SpecTypeName`. It shall be the + non-functional type of the requirement. + +This type is refined by the following types: + +* :ref:`SpecTypeDesignGroupRequirementItemType` + +* :ref:`SpecTypeDesignTargetItemType` + +* :ref:`SpecTypeGenericNonFunctionalRequirementItemType` + +* :ref:`SpecTypeRuntimeMeasurementEnvironmentItemType` + +* :ref:`SpecTypeRuntimePerformanceRequirementItemType` + +.. _SpecTypeDesignGroupRequirementItemType: + +Design Group Requirement Item Type +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This type refines the :ref:`SpecTypeNonFunctionalRequirementItemType` through +the ``non-functional-type`` attribute if the value is ``design-group``. This +set of attributes specifies a design group requirement. Design group +requirements have an explicit reference to the associated Doxygen group +specified by the ``identifier`` attribute. Design group requirements have an +implicit validation by inspection method. The qualification toolchain shall +perform the inspection and check that the specified Doxygen group exists in the +software source code. All explicit attributes shall be specified. The explicit +attributes for this type are: + +identifier + The attribute value shall be a + :ref:`SpecTypeRequirementDesignGroupIdentifier`. + +.. _SpecTypeDesignTargetItemType: + +Design Target Item Type +^^^^^^^^^^^^^^^^^^^^^^^ + +This type refines the :ref:`SpecTypeNonFunctionalRequirementItemType` through +the ``non-functional-type`` attribute if the value is ``design-target``. This +set of attributes specifies a design :term:`target`. All explicit attributes +shall be specified. The explicit attributes for this type are: + +brief + The attribute value shall be an optional string. If the value is present, + then it shall briefly describe the target. + +description + The attribute value shall be an optional string. If the value is present, + then it shall thoroughly describe the target. + +name + The attribute value shall be a string. It shall be the target name. + +.. _SpecTypeGenericNonFunctionalRequirementItemType: + +Generic Non-Functional Requirement Item Type +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This type refines the following types: + +* :ref:`SpecTypeNonFunctionalRequirementItemType` through the + ``non-functional-type`` attribute if the value is ``build-configuration`` + +* :ref:`SpecTypeNonFunctionalRequirementItemType` through the + ``non-functional-type`` attribute if the value is ``constraint`` + +* :ref:`SpecTypeNonFunctionalRequirementItemType` through the + ``non-functional-type`` attribute if the value is ``design`` + +* :ref:`SpecTypeNonFunctionalRequirementItemType` through the + ``non-functional-type`` attribute if the value is ``documentation`` + +* :ref:`SpecTypeNonFunctionalRequirementItemType` through the + ``non-functional-type`` attribute if the value is ``interface`` + +* :ref:`SpecTypeNonFunctionalRequirementItemType` through the + ``non-functional-type`` attribute if the value is ``interface-requirement`` + +* :ref:`SpecTypeNonFunctionalRequirementItemType` through the + ``non-functional-type`` attribute if the value is ``maintainability`` + +* :ref:`SpecTypeNonFunctionalRequirementItemType` through the + ``non-functional-type`` attribute if the value is ``performance`` + +* :ref:`SpecTypeNonFunctionalRequirementItemType` through the + ``non-functional-type`` attribute if the value is + ``performance-runtime-limits`` + +* :ref:`SpecTypeNonFunctionalRequirementItemType` through the + ``non-functional-type`` attribute if the value is ``portability`` + +* :ref:`SpecTypeNonFunctionalRequirementItemType` through the + ``non-functional-type`` attribute if the value is ``quality`` + +* :ref:`SpecTypeNonFunctionalRequirementItemType` through the + ``non-functional-type`` attribute if the value is ``reliability`` + +* :ref:`SpecTypeNonFunctionalRequirementItemType` through the + ``non-functional-type`` attribute if the value is ``resource`` + +* :ref:`SpecTypeNonFunctionalRequirementItemType` through the + ``non-functional-type`` attribute if the value is ``safety`` + +Items of this type state a non-functional requirement with the non-functional +type defined by the specification type refinement. + +.. _SpecTypeRuntimeMeasurementEnvironmentItemType: + +Runtime Measurement Environment Item Type +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This type refines the :ref:`SpecTypeNonFunctionalRequirementItemType` through +the ``non-functional-type`` attribute if the value is +``performance-runtime-environment``. This set of attributes specifies a runtime +measurement environment. All explicit attributes shall be specified. The +explicit attributes for this type are: + +name + The attribute value shall be a string. It shall be the runtime measurement + environment name. See also + :ref:`SpecTypeRuntimeMeasurementEnvironmentName`. + +.. _SpecTypeRuntimePerformanceRequirementItemType: + +Runtime Performance Requirement Item Type +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This type refines the :ref:`SpecTypeNonFunctionalRequirementItemType` through +the ``non-functional-type`` attribute if the value is ``performance-runtime``. +The item shall have exactly one link with the +:ref:`SpecTypeRuntimeMeasurementRequestLinkRole`. A requirement text processor +shall support a substitution of ${.:/limit-kind}: + +* For a :ref:`SpecTypeRuntimeMeasurementValueKind` of ``min-lower-bound`` or + ``min-upper-bound``, the substitution of ${.:/limit-kind} shall be + ``"minimum"``. + +* For a :ref:`SpecTypeRuntimeMeasurementValueKind` of ``mean-lower-bound`` or + ``mean-upper-bound``, the substitution of ${.:/limit-kind} shall be + ``"mean"``. + +* For a :ref:`SpecTypeRuntimeMeasurementValueKind` of ``max-lower-bound`` or + ``max-upper-bound``, the substitution of ${.:/limit-kind} shall be + ``"maximum"``. + +A requirement text processor shall support a substitution of +${.:/limit-condition}: + +* For a :ref:`SpecTypeRuntimeMeasurementValueKind` of ``min-lower-bound``, + ``mean-lower-bound``, or ``max-lower-bound``, the substitution of + ${.:/limit-condition} shall be ``"greater than or equal to <value>"`` with + <value> being the value of the corresponding entry in the + :ref:`SpecTypeRuntimeMeasurementValueTable`. + +* For a :ref:`SpecTypeRuntimeMeasurementValueKind` of ``min-upper-bound``, + ``mean-upper-bound``, or ``max-upper-bound``, the substitution of + ${.:/limit-condition} shall be ``"less than or equal to <value>"`` with + <value> being the value of the corresponding entry in the + :ref:`SpecTypeRuntimeMeasurementValueTable`. + +A requirement text processor shall support a substitution of ${.:/environment}. +The value of the substitution shall be ``"<environment> environment"`` with +<environment> being the environment of the corresponding entry in the +:ref:`SpecTypeRuntimeMeasurementEnvironmentTable`. + +This set of attributes specifies a runtime performance requirement. Along with +the requirement, the validation test code to execute a measure runtime request +is specified. All explicit attributes shall be specified. The explicit +attributes for this type are: + +params + The attribute value shall be a + :ref:`SpecTypeRuntimePerformanceParameterSet`. + +test-body + The attribute value shall be a :ref:`SpecTypeTestSupportMethod`. It shall + provide the code of the measure runtime body handler. In contrast to other + methods, this method is mandatory. + +test-cleanup + The attribute value shall be a :ref:`SpecTypeTestSupportMethod`. It may + provide the code to clean up the measure runtime request. This method is + called before the cleanup method of the corresponding + :ref:`SpecTypeRuntimeMeasurementTestItemType` item and after the request. + +test-prepare + The attribute value shall be a :ref:`SpecTypeTestSupportMethod`. It may + provide the code to prepare the measure runtime request. This method is + called after the prepare method of the corresponding + :ref:`SpecTypeRuntimeMeasurementTestItemType` item and before the request. + +test-setup + The attribute value shall be a :ref:`SpecTypeTestSupportMethod`. It may + provide the code of the measure runtime setup handler. + +test-teardown + The attribute value shall be a :ref:`SpecTypeTestSupportMethod`. It may + provide the code of the measure runtime teardown handler. + +Please have a look at the following example: + +.. code-block:: yaml + + SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause + copyrights: + - Copyright (C) 2020 embedded brains GmbH & Co. KG + enabled-by: true + links: + - role: runtime-measurement-request + uid: ../val/perf + params: {} + rationale: null + references: [] + test-body: + brief: | + Get a buffer. + code: | + ctx->status = rtems_partition_get_buffer( ctx->part_many, &ctx->buffer ); + description: null + test-cleanup: null + test-prepare: null + test-setup: null + test-teardown: + brief: | + Return the buffer. + code: | + rtems_status_code sc; + + T_quiet_rsc_success( ctx->status ); + + sc = rtems_partition_return_buffer( ctx->part_many, ctx->buffer ); + T_quiet_rsc_success( sc ); + + return tic == toc; + description: null + text: | + When a partition has exactly ${../val/perf:/params/buffer-count} free + buffers, the ${.:/limit-kind} runtime of exactly + ${../val/perf:/params/sample-count} successful calls to + ${../if/get-buffer:/name} in the ${.:/environment} shall be + ${.:/limit-condition}. + non-functional-type: performance-runtime + requirement-type: non-functional + type: requirement .. _SpecTypeRequirementValidationItemType: Requirement Validation Item Type ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeRootItemType` though the ``type`` attribute -if the value is ``validation``. This set of attributes provides a requirement -validation evidence. The item shall have exactly one link to the validated -requirement with the :ref:`SpecTypeRequirementValidationLinkRole`. All explicit -attributes shall be specified. The explicit attributes for this type are: +This type refines the :ref:`SpecTypeRootItemType` through the ``type`` +attribute if the value is ``validation``. This set of attributes provides a +requirement validation evidence. The item shall have exactly one link to the +validated requirement with the :ref:`SpecTypeRequirementValidationLinkRole`. +All explicit attributes shall be specified. The explicit attributes for this +type are: method - The attribute value shall be a :ref:`SpecTypeRequirementValidationMethod`. - Validation by test is done through :ref:`SpecTypeTestCaseItemType` items. + The attribute value shall be a :ref:`SpecTypeName`. It shall specify the + requirement validation method (except validation by test). Validation by + test is done through :ref:`SpecTypeTestCaseItemType` items. + +references + The attribute value shall be a list. Each list element shall be an + :ref:`SpecTypeExternalReference`. text The attribute value shall be a string. It shall provide the validation @@ -1926,15 +2329,105 @@ text * *By review of design*: A rationale shall be provided to demonstrate how the requirement is satisfied implicitly by the software design. +This type is refined by the following types: + +* :ref:`SpecTypeRequirementValidationMethod` + +.. _SpecTypeRequirementValidationMethod: + +Requirement Validation Method +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This type refines the following types: + +* :ref:`SpecTypeRequirementValidationItemType` through the ``method`` attribute + if the value is ``by-analysis`` + +* :ref:`SpecTypeRequirementValidationItemType` through the ``method`` attribute + if the value is ``by-inspection`` + +* :ref:`SpecTypeRequirementValidationItemType` through the ``method`` attribute + if the value is ``by-review-of-design`` + +.. _SpecTypeRuntimeMeasurementTestItemType: + +Runtime Measurement Test Item Type +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This type refines the :ref:`SpecTypeRootItemType` through the ``type`` +attribute if the value is ``runtime-measurement-test``. This set of attributes +specifies a runtime measurement test case. All explicit attributes shall be +specified. The explicit attributes for this type are: + +params + The attribute value shall be a + :ref:`SpecTypeRuntimeMeasurementParameterSet`. + +test-brief + The attribute value shall be an optional string. If the value is present, + then it shall be the test case brief description. + +test-cleanup + The attribute value shall be a :ref:`SpecTypeTestSupportMethod`. If the + value is present, then it shall be the measure runtime request cleanup + method. The method is called after each measure runtime request. + +test-context + The attribute value shall be a list. Each list element shall be a + :ref:`SpecTypeTestContextMember`. + +test-context-support + The attribute value shall be an optional string. If the value is present, + then it shall be the test context support code. The context support code + is placed at file scope before the test context definition. + +test-description + The attribute value shall be an optional string. If the value is present, + then it shall be the test case description. + +test-includes + The attribute value shall be a list of strings. It shall be a list of + header files included via ``#include <...>``. + +test-local-includes + The attribute value shall be a list of strings. It shall be a list of + header files included via ``#include "..."``. + +test-prepare + The attribute value shall be a :ref:`SpecTypeTestSupportMethod`. If the + value is present, then it shall be the measure runtime request prepare + method. The method is called before each measure runtime request. + +test-setup + The attribute value shall be a :ref:`SpecTypeTestSupportMethod`. If the + value is present, then it shall be the test case setup fixture method. + +test-stop + The attribute value shall be a :ref:`SpecTypeTestSupportMethod`. If the + value is present, then it shall be the test case stop fixture method. + +test-support + The attribute value shall be an optional string. If the value is present, + then it shall be the test case support code. The support code is placed at + file scope before the test case code. + +test-target + The attribute value shall be a string. It shall be the path to the + generated test case source file. + +test-teardown + The attribute value shall be a :ref:`SpecTypeTestSupportMethod`. If the + value is present, then it shall be the test case teardown fixture method. + .. _SpecTypeSpecificationItemType: Specification Item Type ^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeRootItemType` though the ``type`` attribute -if the value is ``spec``. This set of attributes specifies specification types. -All explicit attributes shall be specified. The explicit attributes for this -type are: +This type refines the :ref:`SpecTypeRootItemType` through the ``type`` +attribute if the value is ``spec``. This set of attributes specifies +specification types. All explicit attributes shall be specified. The explicit +attributes for this type are: spec-description The attribute value shall be an optional string. It shall be the @@ -1961,7 +2454,7 @@ Please have a look at the following example: SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause copyrights: - - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) + - Copyright (C) 2020 embedded brains GmbH & Co. KG enabled-by: true links: - role: spec-member @@ -1995,67 +2488,68 @@ Please have a look at the following example: Test Case Item Type ^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeRootItemType` though the ``type`` attribute -if the value is ``test-case``. This set of attributes specifies a test case. -All explicit attributes shall be specified. The explicit attributes for this -type are: +This type refines the :ref:`SpecTypeRootItemType` through the ``type`` +attribute if the value is ``test-case``. This set of attributes specifies a +test case. All explicit attributes shall be specified. The explicit attributes +for this type are: -actions +test-actions The attribute value shall be a list. Each list element shall be a :ref:`SpecTypeTestCaseAction`. -brief +test-brief The attribute value shall be a string. It shall be the test case brief description. -description - The attribute value shall be an optional string. It shall be the test case - description. +test-context + The attribute value shall be a list. Each list element shall be a + :ref:`SpecTypeTestContextMember`. -epilogue +test-context-support The attribute value shall be an optional string. If the value is present, - then it shall be the test case epilogue code. The epilogue code is placed - in the test case body after the test case actions. + then it shall be the test context support code. The context support code + is placed at file scope before the test context definition. -fixture - The attribute value shall be an optional string. If the value is present, - then it shall be a pointer to the test case fixture. The test case fixture - pointer declaration may be provided by the test case support code or via an - included header file. +test-description + The attribute value shall be an optional string. It shall be the test case + description. -includes +test-header + The attribute value shall be a :ref:`SpecTypeTestHeader`. + +test-includes The attribute value shall be a list of strings. It shall be a list of header files included via ``#include <...>``. -local-includes +test-local-includes The attribute value shall be a list of strings. It shall be a list of header files included via ``#include "..."``. -name - The attribute value shall be a :ref:`SpecTypeTestName`. +test-setup + The attribute value shall be a :ref:`SpecTypeTestSupportMethod`. -prologue - The attribute value shall be an optional string. If the value is present, - then it shall be the test case prologue code. The prologue code is placed - in the test case body before the test case actions. A use case is the - declaration of local variables used by the test case actions. +test-stop + The attribute value shall be a :ref:`SpecTypeTestSupportMethod`. -support +test-support The attribute value shall be an optional string. If the value is present, then it shall be the test case support code. The support code is placed at file scope before the test case code. -target +test-target The attribute value shall be a string. It shall be the path to the generated target test case source file. +test-teardown + The attribute value shall be a :ref:`SpecTypeTestSupportMethod`. + .. _SpecTypeTestPlatformItemType: Test Platform Item Type ^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeRootItemType` though the ``type`` attribute -if the value is ``test-platform``. Please note: +This type refines the :ref:`SpecTypeRootItemType` through the ``type`` +attribute if the value is ``test-platform``. Please note: .. warning:: @@ -2077,8 +2571,8 @@ name Test Procedure Item Type ^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeRootItemType` though the ``type`` attribute -if the value is ``test-procedure``. Please note: +This type refines the :ref:`SpecTypeRootItemType` through the ``type`` +attribute if the value is ``test-procedure``. Please note: .. warning:: @@ -2104,35 +2598,38 @@ steps Test Suite Item Type ^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeRootItemType` though the ``type`` attribute -if the value is ``test-suite``. This set of attributes specifies a test suite. -All explicit attributes shall be specified. The explicit attributes for this -type are: +This type refines the following types: -brief +* :ref:`SpecTypeRootItemType` through the ``type`` attribute if the value is + ``memory-benchmark`` + +* :ref:`SpecTypeRootItemType` through the ``type`` attribute if the value is + ``test-suite`` + +This set of attributes specifies a test suite. All explicit attributes shall be +specified. The explicit attributes for this type are: + +test-brief The attribute value shall be a string. It shall be the test suite brief description. -code +test-code The attribute value shall be a string. It shall be the test suite code. The test suite code is placed at file scope in the target source file. -description +test-description The attribute value shall be an optional string. It shall be the test suite description. -includes +test-includes The attribute value shall be a list of strings. It shall be a list of header files included via ``#include <...>``. -local-includes +test-local-includes The attribute value shall be a list of strings. It shall be a list of header files included via ``#include "..."``. -name - The attribute value shall be a :ref:`SpecTypeTestName`. - -target +test-target The attribute value shall be a string. It shall be the path to the generated target test suite source file. @@ -2141,6 +2638,62 @@ target Specification Attribute Sets and Value Types -------------------------------------------- +.. _SpecTypeActionRequirementBooleanExpression: + +Action Requirement Boolean Expression +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +A value of this type is a boolean expression. + +A value of this type shall be of one of the following variants: + +* The value may be a set of attributes. Each attribute defines an operator. + Exactly one of the explicit attributes shall be specified. The explicit + attributes for this type are: + + and + The attribute value shall be a list. Each list element shall be an + :ref:`SpecTypeActionRequirementBooleanExpression`. The *and* operator + evaluates to the *logical and* of the evaluation results of the + expressions in the list. + + not + The attribute value shall be an + :ref:`SpecTypeActionRequirementBooleanExpression`. The *not* operator + evaluates to the *logical not* of the evaluation results of the + expression. + + or + The attribute value shall be a list. Each list element shall be an + :ref:`SpecTypeActionRequirementBooleanExpression`. The *or* operator + evaluates to the *logical or* of the evaluation results of the + expressions in the list. + + post-conditions + The attribute value shall be an + :ref:`SpecTypeActionRequirementExpressionConditionSet`. The + *post-conditions* operator evaluates to true, if the post-condition + states of the associated transition are contained in the specified + post-condition set, otherwise to false. + + pre-conditions + The attribute value shall be an + :ref:`SpecTypeActionRequirementExpressionConditionSet`. The + *pre-conditions* operator evaluates to true, if the pre-condition states + of the associated transition are contained in the specified pre-condition + set, otherwise to false. + +* The value may be a list. Each list element shall be an + :ref:`SpecTypeActionRequirementBooleanExpression`. This list of expressions + evaluates to the *logical or* of the evaluation results of the expressions in + the list. + +This type is used by the following types: + +* :ref:`SpecTypeActionRequirementBooleanExpression` + +* :ref:`SpecTypeActionRequirementExpression` + .. _SpecTypeActionRequirementCondition: Action Requirement Condition @@ -2162,201 +2715,189 @@ test-epilogue then it shall be the test epilogue code. The epilogue code is placed in the test condition preparation or check before the state-specific code. The code may use a local variable ``ctx`` which points to the test context, see - :ref:`SpecTypeActionRequirementTestContextMember`. + :ref:`SpecTypeTestContextMember`. test-prologue The attribute value shall be an optional string. If the value is present, then it shall be the test prologue code. The prologue code is placed in the test condition preparation or check after the state-specific code. The code may use a local variable ``ctx`` which points to the test context, see - :ref:`SpecTypeActionRequirementTestContextMember`. + :ref:`SpecTypeTestContextMember`. This type is used by the following types: * :ref:`SpecTypeActionRequirementItemType` -.. _SpecTypeActionRequirementName: +.. _SpecTypeActionRequirementExpression: -Action Requirement Name -^^^^^^^^^^^^^^^^^^^^^^^ +Action Requirement Expression +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The value shall be a string. It shall be the name of a condition or a state of -a condition used to define pre-conditions and post-conditions of an action -requirement. It shall be formatted in CamelCase. It should be brief and -abbreviated. The rationale for this is that the names are used in tables and -the horizontal space is limited by the page width. The more conditions you -have in an action requirement, the shorter the names should be. The value shall -match with the regular expression "``^[A-Z][a-zA-Z0-9]+$"``. +This set of attributes defines an expression which may define the state of a +post-condition. The ``else`` and ``specified-by`` shall be used individually. +The ``if`` and ``then`` or ``then-specified-by`` expressions shall be used +together. At least one of the explicit attributes shall be specified. The +explicit attributes for this type are: -This type is used by the following types: +else + The attribute value shall be an + :ref:`SpecTypeActionRequirementExpressionStateName`. It shall be the name + of the state of the post-condition. -* :ref:`SpecTypeActionRequirementCondition` +if + The attribute value shall be an + :ref:`SpecTypeActionRequirementBooleanExpression`. If the boolean + expression evaluates to true, then the state is defined according to the + ``then`` attribute value. -* :ref:`SpecTypeActionRequirementState` +specified-by + The attribute value shall be an :ref:`SpecTypeActionRequirementName`. It + shall be the name of a pre-condition. The name of the state of the + pre-condition in the associated transition defines the name of the state of + the post-condition. -* :ref:`SpecTypeActionRequirementTransitionPostConditions` +then + The attribute value shall be an + :ref:`SpecTypeActionRequirementExpressionStateName`. It shall be the name + of the state of the post-condition. -* :ref:`SpecTypeActionRequirementTransitionPreConditions` +then-specified-by + The attribute value shall be an :ref:`SpecTypeActionRequirementName`. It + shall be the name of a pre-condition. The name of the state of the + pre-condition in the associated transition defines the name of the state of + the post-condition. -.. _SpecTypeActionRequirementState: +.. _SpecTypeActionRequirementExpressionConditionSet: -Action Requirement State -^^^^^^^^^^^^^^^^^^^^^^^^ +Action Requirement Expression Condition Set +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This set of attributes defines an action pre-condition or post-condition state. -All explicit attributes shall be specified. The explicit attributes for this -type are: +This set of attributes defines for the specified conditions a set of states. +Generic attributes may be specified. Each generic attribute key shall be an +:ref:`SpecTypeActionRequirementName`. Each generic attribute value shall be an +:ref:`SpecTypeActionRequirementExpressionStateSet`. There shall be at most one +generic attribute key for each condition. The key name shall be the condition +name. The value of each generic attribute shall be a set of states of the +condition. -name - The attribute value shall be an :ref:`SpecTypeActionRequirementName`. +This type is used by the following types: -test-code - The attribute value shall be a string. It shall be the test code to prepare - or check the state of the condition. The code may use a local variable - ``ctx`` which points to the test context, see - :ref:`SpecTypeActionRequirementTestContextMember`. +* :ref:`SpecTypeActionRequirementBooleanExpression` -text - The attribute value shall be a :ref:`SpecTypeRequirementText`. It shall - define the state of the condition. +.. _SpecTypeActionRequirementExpressionStateName: -This type is used by the following types: +Action Requirement Expression State Name +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -* :ref:`SpecTypeActionRequirementCondition` +The value shall be a string. It shall be the name of a state of the condition +or ``N/A`` if the condition is not applicable. The value -.. _SpecTypeActionRequirementTestContextMember: +* shall match with the regular expression "``^[A-Z][a-zA-Z0-9]*$``", -Action Requirement Test Context Member -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +* or, shall be equal to "``N/A``". -A value of this type shall be of one of the following variants: +This type is used by the following types: -* The value may be a set of attributes. This set of attributes defines an - action requirement test context member. All explicit attributes shall be - specified. The explicit attributes for this type are: +* :ref:`SpecTypeActionRequirementExpression` - brief - The attribute value shall be an optional string. It shall be the test - context member brief description. +.. _SpecTypeActionRequirementExpressionStateSet: - description - The attribute value shall be an optional string. It shall be the test - context member description. +Action Requirement Expression State Set +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - member - The attribute value shall be a string. It shall be the test context - member definition. It shall be a valid C structure member definition - without a trailing ``;``. +A value of this type shall be of one of the following variants: -* There may by be no value (null). +* The value may be a list. Each list element shall be an + :ref:`SpecTypeActionRequirementExpressionStateName`. The list defines a set + of states of the condition. -This type is used by the following types: +* The value may be a string. It shall be the name of a state of the condition + or ``N/A`` if the condition is not applicable. The value -* :ref:`SpecTypeActionRequirementItemType` + * shall match with the regular expression "``^[A-Z][a-zA-Z0-9]*$``", -.. _SpecTypeActionRequirementTestFixtureMethod: + * or, shall be equal to "``N/A``". -Action Requirement Test Fixture Method -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +This type is used by the following types: -A value of this type shall be of one of the following variants: +* :ref:`SpecTypeActionRequirementExpressionConditionSet` -* The value may be a set of attributes. This set of attributes defines an - action requirement test fixture method. All explicit attributes shall be - specified. The explicit attributes for this type are: +.. _SpecTypeActionRequirementName: - brief - The attribute value shall be an optional string. It shall be the test - fixture method brief description. +Action Requirement Name +^^^^^^^^^^^^^^^^^^^^^^^ - code - The attribute value shall be a string. It shall be the test fixture - method code. The code may use a local variable ``ctx`` which points to - the test context, see :ref:`SpecTypeActionRequirementTestContextMember`. +The value shall be a string. It shall be the name of a condition or a state of +a condition used to define pre-conditions and post-conditions of an action +requirement. It shall be formatted in CamelCase. It should be brief and +abbreviated. The rationale for this is that the names are used in tables and +the horizontal space is limited by the page width. The more conditions you +have in an action requirement, the shorter the names should be. The name +``NA`` is reserved and indicates that a condition is not applicable. The value - description - The attribute value shall be an optional string. It shall be the test - fixture method description. +* shall match with the regular expression "``^[A-Z][a-zA-Z0-9]*$``", -* There may by be no value (null). +* and, shall be not equal to "``NA``". This type is used by the following types: -* :ref:`SpecTypeActionRequirementItemType` - -.. _SpecTypeActionRequirementTestHeader: +* :ref:`SpecTypeActionRequirementCondition` -Action Requirement Test Header -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +* :ref:`SpecTypeActionRequirementExpressionConditionSet` -A value of this type shall be of one of the following variants: +* :ref:`SpecTypeActionRequirementExpression` -* The value may be a set of attributes. This set of attributes specifies an - action requirement test header. In case a test header is specified, then - instead of a test case a test run function will be generated. The test run - function will be declared in the test header target file and defined in the - test source target file. The test run function can be used to compose test - cases. The test header file is not automatically included in the test source - file. It should be added to the includes or local includes of the test. All - explicit attributes shall be specified. The explicit attributes for this type - are: +* :ref:`SpecTypeActionRequirementSkipReasons` - code - The attribute value shall be an optional string. If the value is present, - then it shall be the test case header code. The header code is placed at - file scope after the test enum declarations and before the test run - function declaration. +* :ref:`SpecTypeActionRequirementState` - includes - The attribute value shall be a list of strings. It shall be a list of - header files included by the header file via ``#include <...>``. +* :ref:`SpecTypeActionRequirementTransitionPostConditions` - local-includes - The attribute value shall be a list of strings. It shall be a list of - header files included by the header file via ``#include "..."``. +* :ref:`SpecTypeActionRequirementTransitionPreConditions` - run-params - The attribute value shall be a list. Each list element shall be an - :ref:`SpecTypeActionRequirementTestRunParameter`. +.. _SpecTypeActionRequirementSkipReasons: - target - The attribute value shall be a string. It shall be the path to the - generated test header file. +Action Requirement Skip Reasons +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -* There may by be no value (null). +This set of attributes specifies skip reasons used to justify why transitions +in the transition map are skipped. Generic attributes may be specified. Each +generic attribute key shall be an :ref:`SpecTypeActionRequirementName`. Each +generic attribute value shall be a string. The key defines the name of a skip +reason. The name can be used in +:ref:`SpecTypeActionRequirementTransitionPostConditions` to skip the +corresponding transitions. The value shall give a reason why the transitions +are skipped. This type is used by the following types: * :ref:`SpecTypeActionRequirementItemType` -.. _SpecTypeActionRequirementTestRunParameter: - -Action Requirement Test Run Parameter -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -This set of attributes specifies a parameter for the test run function. The -parameter is also added as a member to the test context, see -:ref:`SpecTypeActionRequirementTestContextMember`. All explicit attributes -shall be specified. The explicit attributes for this type are: +.. _SpecTypeActionRequirementState: -description - The attribute value shall be a string. It shall be the description of the - parameter. +Action Requirement State +^^^^^^^^^^^^^^^^^^^^^^^^ -dir - The attribute value shall be an :ref:`SpecTypeInterfaceParameterDirection`. +This set of attributes defines an action pre-condition or post-condition state. +All explicit attributes shall be specified. The explicit attributes for this +type are: name - The attribute value shall be a string. It shall be the parameter name. + The attribute value shall be an :ref:`SpecTypeActionRequirementName`. -specifier - The attribute value shall be a string. It shall be the complete function - parameter specifier. Use ``${.:name}`` for the parameter name, for example - ``"int ${.:name}"``. +test-code + The attribute value shall be a string. It shall be the test code to prepare + or check the state of the condition. The code may use a local variable + ``ctx`` which points to the test context, see + :ref:`SpecTypeTestContextMember`. + +text + The attribute value shall be a :ref:`SpecTypeRequirementText`. It shall + define the state of the condition. This type is used by the following types: -* :ref:`SpecTypeActionRequirementTestHeader` +* :ref:`SpecTypeActionRequirementCondition` .. _SpecTypeActionRequirementTransition: @@ -2393,19 +2934,54 @@ This type is used by the following types: * :ref:`SpecTypeActionRequirementItemType` +.. _SpecTypeActionRequirementTransitionPostConditionState: + +Action Requirement Transition Post-Condition State +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +A value of this type shall be of one of the following variants: + +* The value may be a list. Each list element shall be an + :ref:`SpecTypeActionRequirementExpression`. The list contains expressions to + define the state of the corresponding post-condition. + +* The value may be a string. It shall be the name of a state of the + corresponding post-condition or ``N/A`` if the post-condition is not + applicable. The value + + * shall match with the regular expression "``^[A-Z][a-zA-Z0-9]*$``", + + * or, shall be equal to "``N/A``". + +This type is used by the following types: + +* :ref:`SpecTypeActionRequirementTransitionPostConditions` + .. _SpecTypeActionRequirementTransitionPostConditions: Action Requirement Transition Post-Conditions ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This set of attributes defines for each post-condition the state after the -action for a transition in an action requirement. Generic attributes may be -specified. Each generic attribute key shall be an -:ref:`SpecTypeActionRequirementName`. Each generic attribute value shall be an -:ref:`SpecTypeActionRequirementName`. There shall be exactly one generic -attribute key for each post-condition. The key name shall be the -post-condition name. The value of each generic attribute shall be the state of -the post-condition. +A value of this type shall be of one of the following variants: + +* The value may be a set of attributes. This set of attributes defines for each + post-condition the state after the action for a transition in an action + requirement. Generic attributes may be specified. Each generic attribute key + shall be an :ref:`SpecTypeActionRequirementName`. Each generic attribute + value shall be an + :ref:`SpecTypeActionRequirementTransitionPostConditionState`. There shall be + exactly one generic attribute key for each post-condition. The key name + shall be the post-condition name. The value of each generic attribute shall + be the state of the post-condition or ``N/A`` if the post-condition is not + applicable. + +* The value may be a string. It shall be the name of a skip reason. If a skip + reason is given instead of a listing of post-condition states, then this + transition is skipped and no test code runs for this transition. The value + + * shall match with the regular expression "``^[A-Z][a-zA-Z0-9]*$``", + + * and, shall be not equal to "``NA``". This type is used by the following types: @@ -2422,8 +2998,13 @@ A value of this type shall be of one of the following variants: :ref:`SpecTypeActionRequirementName`. The list defines the set of states of the pre-condition in the transition. -* The value may be a string. The value represents all states of the - pre-condition in the transition. The value shall be equal to "``all``". +* The value may be a string. The value ``all`` represents all states of the + pre-condition in this transition. The value ``N/A`` marks the pre-condition + as not applicable in this transition. The value shall be an element of + + * "``all``", and + + * "``N/A``". This type is used by the following types: @@ -2434,61 +3015,26 @@ This type is used by the following types: Action Requirement Transition Pre-Conditions ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This set of attributes defines for each pre-condition the set of states before -the action for a transition in an actin requirement. Generic attributes may be -specified. Each generic attribute key shall be an -:ref:`SpecTypeActionRequirementName`. Each generic attribute value shall be an -:ref:`SpecTypeActionRequirementTransitionPreConditionStateSet`. There shall be -exactly one generic attribute key for each pre-condition. The key name shall -be the pre-condition name. The value of each generic attribute shall be a set -of states of the pre-condition. - -This type is used by the following types: - -* :ref:`SpecTypeActionRequirementTransition` - -.. _SpecTypeApplicationConfigurationGroupMemberLinkRole: - -Application Configuration Group Member Link Role -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -This type refines the :ref:`SpecTypeLink` though the ``role`` attribute if the -value is ``appl-config-group-member``. It defines the application configuration -group membership role of links. - -.. _SpecTypeApplicationConfigurationOptionConstraintSet: - -Application Configuration Option Constraint Set -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -This set of attributes defines application configuration option constraints. -Additional constraints can be added through the links of the item using the -:ref:`SpecTypeConstraintLinkRole`. None of the explicit attributes is -mandatory, they are all are optional. The explicit attributes for this type -are: - -max - The attribute value shall be an :ref:`SpecTypeIntegerOrString`. It shall be - the maximum value of the application configuration option. +A value of this type shall be of one of the following variants: -min - The attribute value shall be an :ref:`SpecTypeIntegerOrString`. It shall be - the minimum value of the application configuration option. - -set - The attribute value shall be a list. Each list element shall be an - :ref:`SpecTypeIntegerOrString`. It shall be the set of valid values for the - application configuration option. - -texts - The attribute value shall be a list. Each list element shall be a - :ref:`SpecTypeRequirementText`. It shall be a list of constraints specific - to this application configuration option. For general constraints, use a - link with the :ref:`SpecTypeConstraintLinkRole` to a constraint item. +* The value may be a set of attributes. This set of attributes defines for each + pre-condition the set of states before the action for a transition in an + action requirement. Generic attributes may be specified. Each generic + attribute key shall be an :ref:`SpecTypeActionRequirementName`. Each generic + attribute value shall be an + :ref:`SpecTypeActionRequirementTransitionPreConditionStateSet`. There shall + be exactly one generic attribute key for each pre-condition. The key name + shall be the pre-condition name. The value of each generic attribute shall + be a set of states of the pre-condition. + +* The value may be a string. If this name is specified instead of explicit + pre-condition states, then the post-condition states of this entry are used + to define all remaining transitions of the map. The value shall be equal to + "``default``". This type is used by the following types: -* :ref:`SpecTypeApplicationConfigurationValueOptionItemType` +* :ref:`SpecTypeActionRequirementTransition` .. _SpecTypeApplicationConfigurationOptionName: @@ -2497,7 +3043,7 @@ Application Configuration Option Name The value shall be a string. It shall be the name of an application configuration option. The value shall match with the regular expression -"``^(CONFIGURE_|BSP_)[A-Z0-9_]+$"``. +"``^(CONFIGURE_|BSP_)[A-Z0-9_]+$``". This type is used by the following types: @@ -2554,6 +3100,8 @@ This type is used by the following types: * :ref:`SpecTypeBuildBSPItemType` +* :ref:`SpecTypeBuildGroupItemType` + * :ref:`SpecTypeBuildLibraryItemType` * :ref:`SpecTypeBuildObjectsItemType` @@ -2580,6 +3128,8 @@ This type is used by the following types: * :ref:`SpecTypeBuildBSPItemType` +* :ref:`SpecTypeBuildGroupItemType` + * :ref:`SpecTypeBuildLibraryItemType` * :ref:`SpecTypeBuildObjectsItemType` @@ -2602,6 +3152,10 @@ context. This type is used by the following types: +* :ref:`SpecTypeBuildAdaTestProgramItemType` + +* :ref:`SpecTypeBuildGroupItemType` + * :ref:`SpecTypeBuildLibraryItemType` * :ref:`SpecTypeBuildObjectsItemType` @@ -2612,12 +3166,26 @@ This type is used by the following types: * :ref:`SpecTypeBuildTestProgramItemType` +.. _SpecTypeBuildDependencyConditionalLinkRole: + +Build Dependency Conditional Link Role +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This type refines the :ref:`SpecTypeLink` through the ``role`` attribute if the +value is ``build-dependency-conditional``. It defines the build dependency +conditional role of links. All explicit attributes shall be specified. The +explicit attributes for this type are: + +enabled-by + The attribute value shall be an :ref:`SpecTypeEnabledByExpression`. It + shall define under which conditions the build dependency is enabled. + .. _SpecTypeBuildDependencyLinkRole: Build Dependency Link Role ^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeLink` though the ``role`` attribute if the +This type refines the :ref:`SpecTypeLink` through the ``role`` attribute if the value is ``build-dependency``. It defines the build dependency role of links. .. _SpecTypeBuildIncludePath: @@ -2688,7 +3256,7 @@ Build Install Path A value of this type shall be of one of the following variants: -* There may by be no value (null). +* There may be no value (null). * The value may be a string. It shall be the installation path of a :ref:`SpecTypeBuildTarget`. @@ -2703,6 +3271,26 @@ This type is used by the following types: * :ref:`SpecTypeBuildStartFileItemType` +.. _SpecTypeBuildLinkStaticLibraryDirective: + +Build Link Static Library Directive +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The value shall be a string. It shall be an external static library identifier. +The library is used to link programs referenced by this item, e.g. ``m`` for +``libm.a``. The library is added to the build command through the ``stlib`` +attribute. It shall not be used for internal static libraries. Internal static +libraries shall be specified through the ``use-after`` and ``use-before`` +attributes to enable a proper build dependency tracking. + +This type is used by the following types: + +* :ref:`SpecTypeBuildAdaTestProgramItemType` + +* :ref:`SpecTypeBuildScriptItemType` + +* :ref:`SpecTypeBuildTestProgramItemType` + .. _SpecTypeBuildLinkerOption: Build Linker Option @@ -2889,6 +3477,12 @@ get-string ``name`` attribute. If no such variable exists in the configuration file, then the default value is used. The value is converted to a string. +get-string-command-line + The attribute value shall be a string. The action gets the action value for + subsequent actions from the value of a command line option named by the + items ``name`` attribute. If no such command line option is present, then + the attribute value is used. The value is converted to a string. + script The attribute value shall be a string. The action executes the attribute value with the Python ``eval()`` function in the context of the script @@ -2906,7 +3500,7 @@ split The attribute shall have no value. The action splits the action value. substitute - The attribute shall have no value. The action Performs a ``${VARIABLE}`` + The attribute shall have no value. The action performs a ``${VARIABLE}`` substitution on the action value. Use ``$$`` for a plain ``$`` character. This type is used by the following types: @@ -2965,22 +3559,20 @@ This type is used by the following types: * :ref:`SpecTypeBuildOptionAction` -.. _SpecTypeBuildOptionDefaultByVariant: +.. _SpecTypeBuildOptionDefaultValue: -Build Option Default by Variant -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Build Option Default Value +^^^^^^^^^^^^^^^^^^^^^^^^^^ -This set of attributes specifies build option default values by variant. All -explicit attributes shall be specified. The explicit attributes for this type -are: +This set of attributes specifies a build option default value. All explicit +attributes shall be specified. The explicit attributes for this type are: -value - The attribute value shall be a :ref:`SpecTypeBuildOptionValue`. It value - shall be the default value for the matching variants. +enabled-by + The attribute value shall be an :ref:`SpecTypeEnabledByExpression`. -variants - The attribute value shall be a list of strings. It shall be a list of - Python regular expression matching with the desired variants. +value + The attribute value shall be a :ref:`SpecTypeBuildOptionValue`. Its value + shall be the default value for the associated enabled-by expression. This type is used by the following types: @@ -2992,7 +3584,7 @@ Build Option Name ^^^^^^^^^^^^^^^^^ The value shall be a string. It shall be the name of the build option. The -value shall match with the regular expression "``^[a-zA-Z_][a-zA-Z0-9_]*$"``. +value shall match with the regular expression "``^[a-zA-Z_][a-zA-Z0-9_]*$``". This type is used by the following types: @@ -3003,14 +3595,25 @@ This type is used by the following types: Build Option Set Test State Action ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This set of attributes specifies test states for a set of test programs. -Generic attributes may be specified. Each generic attribute key shall be a -:ref:`SpecTypeName`. Each generic attribute value shall be a -:ref:`SpecTypeBuildTestState`. The keys shall be test program names. The names -shall correspond to the name of a :ref:`SpecTypeBuildTestProgramItemType` or -:ref:`SpecTypeBuildAdaTestProgramItemType` item. Due to the processing order -of items, there is no way to check if the name specified by the attribute key -is valid. +This set of attributes specifies the test state for a set of test programs with +an optional reason. All explicit attributes shall be specified. The explicit +attributes for this type are: + +reason + The attribute value shall be an optional string. If the value is present, + then it shall be the reason for the test state definition. + +state + The attribute value shall be a :ref:`SpecTypeBuildTestState`. It shall be + the test state for the associated list of tests. + +tests + The attribute value shall be a list of strings. It shall be the list of + test program names associated with the test state. The names shall + correspond to the name of a :ref:`SpecTypeBuildTestProgramItemType` or + :ref:`SpecTypeBuildAdaTestProgramItemType` item. Due to the processing + order of items, there is no way to check if a specified test program name + is valid. This type is used by the following types: @@ -3029,7 +3632,7 @@ A value of this type shall be of one of the following variants: * The value may be a list. Each list element shall be a string. -* There may by be no value (null). +* There may be no value (null). * The value may be a string. @@ -3037,9 +3640,7 @@ This type is used by the following types: * :ref:`SpecTypeBuildOptionAction` -* :ref:`SpecTypeBuildOptionDefaultByVariant` - -* :ref:`SpecTypeBuildOptionItemType` +* :ref:`SpecTypeBuildOptionDefaultValue` .. _SpecTypeBuildSource: @@ -3082,6 +3683,8 @@ This type is used by the following types: * :ref:`SpecTypeBuildLibraryItemType` +* :ref:`SpecTypeBuildScriptItemType` + * :ref:`SpecTypeBuildStartFileItemType` * :ref:`SpecTypeBuildTestProgramItemType` @@ -3114,8 +3717,9 @@ Build Use After Directive ^^^^^^^^^^^^^^^^^^^^^^^^^ The value shall be a string. It shall be an internal static library identifier. -They are used to link programs referenced by this item, e.g. ``z`` for -``libz.a``. They are placed after the use items of the build item context. +The library is used to link programs referenced by this item, e.g. ``z`` for +``libz.a``. The library is placed after the use items of the build item +context. This type is used by the following types: @@ -3133,8 +3737,9 @@ Build Use Before Directive ^^^^^^^^^^^^^^^^^^^^^^^^^^ The value shall be a string. It shall be an internal static library identifier. -They are used to link programs referenced by this item, e.g. ``z`` for -``libz.a``. They are placed before the use items of the build item context. +The library is used to link programs referenced by this item, e.g. ``z`` for +``libz.a``. The library is placed before the use items of the build item +context. This type is used by the following types: @@ -3151,7 +3756,7 @@ This type is used by the following types: Constraint Link Role ^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeLink` though the ``role`` attribute if the +This type refines the :ref:`SpecTypeLink` through the ``role`` attribute if the value is ``constraint``. It defines the constraint role of links. The link target shall be a constraint. @@ -3164,13 +3769,13 @@ The value shall be a string. It shall be a copyright statement of a copyright holder of the specification item. The value * shall match with the regular expression - "``^\s*Copyright\s+\(C\)\s+[0-9]+,\s*[0-9]+\s+.+\s*$"``, + "``^\s*Copyright\s+\(C\)\s+[0-9]+,\s*[0-9]+\s+.+\s*$``", * or, shall match with the regular expression - "``^\s*Copyright\s+\(C\)\s+[0-9]+\s+.+\s*$"``, + "``^\s*Copyright\s+\(C\)\s+[0-9]+\s+.+\s*$``", * or, shall match with the regular expression - "``^\s*Copyright\s+\(C\)\s+.+\s*$"``. + "``^\s*Copyright\s+\(C\)\s+.+\s*$``". This type is used by the following types: @@ -3221,6 +3826,10 @@ This type is used by the following types: * :ref:`SpecTypeActionRequirementTransition` +* :ref:`SpecTypeBuildDependencyConditionalLinkRole` + +* :ref:`SpecTypeBuildOptionDefaultValue` + * :ref:`SpecTypeEnabledByExpression` * :ref:`SpecTypeInterfaceIncludeLinkRole` @@ -3236,12 +3845,117 @@ Please have a look at the following example: - RTEMS_NETWORKING - not: RTEMS_SMP +.. _SpecTypeExternalDocumentReference: + +External Document Reference +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This type refines the :ref:`SpecTypeExternalReference` through the ``type`` +attribute if the value is ``document``. It specifies a reference to a document. + +All explicit attributes shall be specified. The explicit attributes for this +type are: + +name + The attribute value shall be a string. It shall be the name of the + document. + +.. _SpecTypeExternalFileReference: + +External File Reference +^^^^^^^^^^^^^^^^^^^^^^^ + +This type refines the :ref:`SpecTypeExternalReference` through the ``type`` +attribute if the value is ``file``. It specifies a reference to a file. + +All explicit attributes shall be specified. The explicit attributes for this +type are: + +hash + The attribute value shall be a :ref:`SpecTypeSHA256HashValue`. It shall be + the SHA256 hash value of the content of the referenced file. + +.. _SpecTypeExternalReference: + +External Reference +^^^^^^^^^^^^^^^^^^ + +This set of attributes specifies a reference to some object external to the +specification. All explicit attributes shall be specified. The explicit +attributes for this type are: + +identifier + The attribute value shall be a string. It shall be the type-specific + identifier of the referenced object. For *group* references use the Doxygen + group identifier. For *file* references use a file system path to the + file. + +type + The attribute value shall be a :ref:`SpecTypeName`. It shall be the type of + the referenced object. + +This type is refined by the following types: + +* :ref:`SpecTypeExternalDocumentReference` + +* :ref:`SpecTypeExternalFileReference` + +* :ref:`SpecTypeGenericExternalReference` + +This type is used by the following types: + +* :ref:`SpecTypeInterfaceUnspecifiedHeaderFileItemType` + +* :ref:`SpecTypeInterfaceUnspecifiedItemType` + +* :ref:`SpecTypeRequirementItemType` + +* :ref:`SpecTypeRequirementValidationItemType` + +.. _SpecTypeFunctionImplementationLinkRole: + +Function Implementation Link Role +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This type refines the :ref:`SpecTypeLink` through the ``role`` attribute if the +value is ``function-implementation``. It defines the function implementation +role of links. It is used to indicate that a +:ref:`SpecTypeFunctionalRequirementItemType` item specifies parts of the +function. + +.. _SpecTypeGenericExternalReference: + +Generic External Reference +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This type refines the following types: + +* :ref:`SpecTypeExternalReference` through the ``type`` attribute if the value + is ``define`` + +* :ref:`SpecTypeExternalReference` through the ``type`` attribute if the value + is ``function`` + +* :ref:`SpecTypeExternalReference` through the ``type`` attribute if the value + is ``group`` + +* :ref:`SpecTypeExternalReference` through the ``type`` attribute if the value + is ``macro`` + +* :ref:`SpecTypeExternalReference` through the ``type`` attribute if the value + is ``url`` + +* :ref:`SpecTypeExternalReference` through the ``type`` attribute if the value + is ``variable`` + +It specifies a reference to an object of the specified type. + .. _SpecTypeGlossaryMembershipLinkRole: Glossary Membership Link Role ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeLink` though the ``role`` attribute if the +This type refines the :ref:`SpecTypeLink` through the ``role`` attribute if the value is ``glossary-member``. It defines the glossary membership role of links. .. _SpecTypeIntegerOrString: @@ -3257,8 +3971,6 @@ A value of this type shall be of one of the following variants: This type is used by the following types: -* :ref:`SpecTypeApplicationConfigurationOptionConstraintSet` - * :ref:`SpecTypeApplicationConfigurationValueOptionItemType` * :ref:`SpecTypeBuildOptionAction` @@ -3270,10 +3982,11 @@ Interface Brief Description A value of this type shall be of one of the following variants: -* There may by be no value (null). +* There may be no value (null). * The value may be a string. It shall be the brief description of the - interface. + interface. It should be a single sentence. The value shall not match with + the regular expression "``\n\n``". This type is used by the following types: @@ -3287,16 +4000,22 @@ This type is used by the following types: * :ref:`SpecTypeInterfaceEnumeratorItemType` -* :ref:`SpecTypeInterfaceFunctionItemType` +* :ref:`SpecTypeInterfaceFunctionOrMacroItemType` * :ref:`SpecTypeInterfaceGroupItemType` -* :ref:`SpecTypeInterfaceMacroItemType` +* :ref:`SpecTypeInterfaceHeaderFileItemType` * :ref:`SpecTypeInterfaceTypedefItemType` * :ref:`SpecTypeInterfaceVariableItemType` +* :ref:`SpecTypeRegisterBitsDefinition` + +* :ref:`SpecTypeRegisterBlockItemType` + +* :ref:`SpecTypeRegisterDefinition` + .. _SpecTypeInterfaceCompoundDefinitionKind: Interface Compound Definition Kind @@ -3327,10 +4046,10 @@ Interface Compound Member Compound This type refines the following types: -* :ref:`SpecTypeInterfaceCompoundMemberDefinition` though the ``kind`` +* :ref:`SpecTypeInterfaceCompoundMemberDefinition` through the ``kind`` attribute if the value is ``struct`` -* :ref:`SpecTypeInterfaceCompoundMemberDefinition` though the ``kind`` +* :ref:`SpecTypeInterfaceCompoundMemberDefinition` through the ``kind`` attribute if the value is ``union`` This set of attributes specifies an interface compound member compound. All @@ -3346,7 +4065,7 @@ definition Interface Compound Member Declaration ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeInterfaceCompoundMemberDefinition` though +This type refines the :ref:`SpecTypeInterfaceCompoundMemberDefinition` through the ``kind`` attribute if the value is ``member``. This set of attributes specifies an interface compound member declaration. All explicit attributes shall be specified. The explicit attributes for this type are: @@ -3361,23 +4080,27 @@ definition Interface Compound Member Definition ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This set of attributes specifies an interface compound member definition. All -explicit attributes shall be specified. The explicit attributes for this type -are: +A value of this type shall be of one of the following variants: -brief - The attribute value shall be an :ref:`SpecTypeInterfaceBriefDescription`. +* The value may be a set of attributes. This set of attributes specifies an + interface compound member definition. All explicit attributes shall be + specified. The explicit attributes for this type are: -description - The attribute value shall be an :ref:`SpecTypeInterfaceDescription`. + brief + The attribute value shall be an :ref:`SpecTypeInterfaceBriefDescription`. -kind - The attribute value shall be a string. It shall be the interface compound - member kind. + description + The attribute value shall be an :ref:`SpecTypeInterfaceDescription`. -name - The attribute value shall be a string. It shall be the interface compound - member name. + kind + The attribute value shall be a string. It shall be the interface compound + member kind. + + name + The attribute value shall be a string. It shall be the interface compound + member name. + +* There may be no value (null). This type is refined by the following types: @@ -3446,7 +4169,7 @@ Interface Definition A value of this type shall be of one of the following variants: -* There may by be no value (null). +* There may be no value (null). * The value may be a string. It shall be the definition. On the definition a context-sensitive substitution of item variables is performed. @@ -3481,8 +4204,6 @@ This type is used by the following types: * :ref:`SpecTypeInterfaceEnumeratorItemType` -* :ref:`SpecTypeInterfaceMacroItemType` - * :ref:`SpecTypeInterfaceTypedefItemType` * :ref:`SpecTypeInterfaceVariableItemType` @@ -3516,7 +4237,7 @@ Interface Description A value of this type shall be of one of the following variants: -* There may by be no value (null). +* There may be no value (null). * The value may be a string. It shall be the description of the interface. The description should be short and concentrate on the average case. All special @@ -3538,12 +4259,10 @@ This type is used by the following types: * :ref:`SpecTypeInterfaceEnumeratorItemType` -* :ref:`SpecTypeInterfaceFunctionItemType` +* :ref:`SpecTypeInterfaceFunctionOrMacroItemType` * :ref:`SpecTypeInterfaceGroupItemType` -* :ref:`SpecTypeInterfaceMacroItemType` - * :ref:`SpecTypeInterfaceParameter` * :ref:`SpecTypeInterfaceReturnValue` @@ -3552,6 +4271,12 @@ This type is used by the following types: * :ref:`SpecTypeInterfaceVariableItemType` +* :ref:`SpecTypeRegisterBitsDefinition` + +* :ref:`SpecTypeRegisterBlockItemType` + +* :ref:`SpecTypeRegisterDefinition` + .. _SpecTypeInterfaceEnabledByExpression: Interface Enabled-By Expression @@ -3599,7 +4324,11 @@ This type is used by the following types: * :ref:`SpecTypeInterfaceEnabledByExpression` -* :ref:`SpecTypeInterfaceFunctionDefinitionVariant` +* :ref:`SpecTypeInterfaceFunctionOrMacroDefinitionVariant` + +* :ref:`SpecTypeRegisterBitsDefinitionVariant` + +* :ref:`SpecTypeRegisterBlockMemberDefinitionVariant` .. _SpecTypeInterfaceEnumDefinitionKind: @@ -3625,76 +4354,102 @@ This type is used by the following types: Interface Enumerator Link Role ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeLink` though the ``role`` attribute if the +This type refines the :ref:`SpecTypeLink` through the ``role`` attribute if the value is ``interface-enumerator``. It defines the interface enumerator role of links. -.. _SpecTypeInterfaceFunctionDefinition: +.. _SpecTypeInterfaceFunctionLinkRole: -Interface Function Definition -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Interface Function Link Role +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This set of attributes specifies a function definition. All explicit attributes -shall be specified. The explicit attributes for this type are: +This type refines the :ref:`SpecTypeLink` through the ``role`` attribute if the +value is ``interface-function``. It defines the interface function role of +links. It is used to indicate that a :ref:`SpecTypeActionRequirementItemType` +item specifies functional requirements of an +:ref:`SpecTypeInterfaceFunctionOrMacroItemType` item. -body - The attribute value shall be an optional string. If the value is present, - then it shall be the definition of a static inline function. On the - function definition a context-sensitive substitution of item variables is - performed. If no value is present, then the function is declared as an - external function. +.. _SpecTypeInterfaceFunctionOrMacroDefinition: -params - The attribute value shall be a list of strings. It shall be the list of - parameter declarations of the function. On the function parameter - declarations a context-sensitive substitution of item variables is - performed. +Interface Function or Macro Definition +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -return - The attribute value shall be a string. It shall be the function return - type. On the return type a context-sensitive substitution of item - variables is performed. +A value of this type shall be of one of the following variants: + +* The value may be a set of attributes. This set of attributes specifies a + function definition. All explicit attributes shall be specified. The explicit + attributes for this type are: + + attributes + The attribute value shall be an optional string. If the value is present, + then it shall be the function attributes. On the attributes a + context-sensitive substitution of item variables is performed. A + function attribute is for example the indication that the function does + not return to the caller. + + body + The attribute value shall be an optional string. If the value is present, + then it shall be the definition of a static inline function. On the + function definition a context-sensitive substitution of item variables is + performed. If no value is present, then the function is declared as an + external function. + + params + The attribute value shall be a list of strings. It shall be the list of + parameter declarations of the function. On the function parameter + declarations a context-sensitive substitution of item variables is + performed. + + return + The attribute value shall be an optional string. If the value is present, + then it shall be the function return type. On the return type a + context-sensitive substitution of item variables is performed. + +* There may be no value (null). This type is used by the following types: -* :ref:`SpecTypeInterfaceFunctionDefinitionDirective` +* :ref:`SpecTypeInterfaceFunctionOrMacroDefinitionDirective` -* :ref:`SpecTypeInterfaceFunctionDefinitionVariant` +* :ref:`SpecTypeInterfaceFunctionOrMacroDefinitionVariant` -.. _SpecTypeInterfaceFunctionDefinitionDirective: +.. _SpecTypeInterfaceFunctionOrMacroDefinitionDirective: -Interface Function Definition Directive -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Interface Function or Macro Definition Directive +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This set of attributes specifies a function definition directive. All explicit -attributes shall be specified. The explicit attributes for this type are: +This set of attributes specifies a function or macro definition directive. All +explicit attributes shall be specified. The explicit attributes for this type +are: default - The attribute value shall be an :ref:`SpecTypeInterfaceFunctionDefinition`. - The default definition will be used if no variant-specific definition is - enabled. + The attribute value shall be an + :ref:`SpecTypeInterfaceFunctionOrMacroDefinition`. The default definition + will be used if no variant-specific definition is enabled. variants The attribute value shall be a list. Each list element shall be an - :ref:`SpecTypeInterfaceFunctionDefinitionVariant`. + :ref:`SpecTypeInterfaceFunctionOrMacroDefinitionVariant`. This type is used by the following types: -* :ref:`SpecTypeInterfaceFunctionItemType` +* :ref:`SpecTypeInterfaceFunctionOrMacroItemType` -.. _SpecTypeInterfaceFunctionDefinitionVariant: +.. _SpecTypeInterfaceFunctionOrMacroDefinitionVariant: -Interface Function Definition Variant -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Interface Function or Macro Definition Variant +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This set of attributes specifies a function definition variant. All explicit -attributes shall be specified. The explicit attributes for this type are: +This set of attributes specifies a function or macro definition variant. All +explicit attributes shall be specified. The explicit attributes for this type +are: definition - The attribute value shall be an :ref:`SpecTypeInterfaceFunctionDefinition`. - The definition will be used if the expression defined by the ``enabled-by`` - attribute evaluates to true. In generated header files, the expression is - evaluated by the C preprocessor. + The attribute value shall be an + :ref:`SpecTypeInterfaceFunctionOrMacroDefinition`. The definition will be + used if the expression defined by the ``enabled-by`` attribute evaluates to + true. In generated header files, the expression is evaluated by the C + preprocessor. enabled-by The attribute value shall be an @@ -3702,19 +4457,7 @@ enabled-by This type is used by the following types: -* :ref:`SpecTypeInterfaceFunctionDefinitionDirective` - -.. _SpecTypeInterfaceFunctionLinkRole: - -Interface Function Link Role -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -This type refines the :ref:`SpecTypeLink` though the ``role`` attribute if the -value is ``interface-function``. It defines the interface function role of -links. It is used to indicate that a :ref:`SpecTypeActionRequirementItemType` -item specifies functional requirements of an -:ref:`SpecTypeInterfaceFunctionItemType` or a -:ref:`SpecTypeInterfaceMacroItemType` item. +* :ref:`SpecTypeInterfaceFunctionOrMacroDefinitionDirective` .. _SpecTypeInterfaceGroupIdentifier: @@ -3722,27 +4465,41 @@ Interface Group Identifier ^^^^^^^^^^^^^^^^^^^^^^^^^^ The value shall be a string. It shall be the identifier of the interface group. -The value shall match with the regular expression "``^[A-Z][a-zA-Z0-9]*$"``. +The value shall match with the regular expression "``^[A-Z][a-zA-Z0-9]*$``". This type is used by the following types: * :ref:`SpecTypeInterfaceGroupItemType` +* :ref:`SpecTypeRegisterBlockItemType` + .. _SpecTypeInterfaceGroupMembershipLinkRole: Interface Group Membership Link Role ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeLink` though the ``role`` attribute if the +This type refines the :ref:`SpecTypeLink` through the ``role`` attribute if the value is ``interface-ingroup``. It defines the interface group membership role of links. +.. _SpecTypeInterfaceHiddenGroupMembershipLinkRole: + +Interface Hidden Group Membership Link Role +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This type refines the :ref:`SpecTypeLink` through the ``role`` attribute if the +value is ``interface-ingroup-hidden``. It defines the interface hidden group +membership role of links. This role may be used to make an interface a group +member and hide this relationship in the documentation. An example is an +optimized macro implementation of a directive which has the same name as the +corresponding directive. + .. _SpecTypeInterfaceIncludeLinkRole: Interface Include Link Role ^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeLink` though the ``role`` attribute if the +This type refines the :ref:`SpecTypeLink` through the ``role`` attribute if the value is ``interface-include``. It defines the interface include role of links and is used to indicate that an interface container includes another interface container. For example, one header file includes another header file. All @@ -3760,7 +4517,7 @@ Interface Notes A value of this type shall be of one of the following variants: -* There may by be no value (null). +* There may be no value (null). * The value may be a string. It shall be the notes for the interface. @@ -3774,14 +4531,14 @@ This type is used by the following types: * :ref:`SpecTypeInterfaceEnumeratorItemType` -* :ref:`SpecTypeInterfaceFunctionItemType` - -* :ref:`SpecTypeInterfaceMacroItemType` +* :ref:`SpecTypeInterfaceFunctionOrMacroItemType` * :ref:`SpecTypeInterfaceTypedefItemType` * :ref:`SpecTypeInterfaceVariableItemType` +* :ref:`SpecTypeRegisterBlockItemType` + .. _SpecTypeInterfaceParameter: Interface Parameter @@ -3802,9 +4559,9 @@ name This type is used by the following types: -* :ref:`SpecTypeInterfaceFunctionItemType` +* :ref:`SpecTypeInterfaceFunctionOrMacroItemType` -* :ref:`SpecTypeInterfaceMacroItemType` +* :ref:`SpecTypeInterfaceTypedefItemType` .. _SpecTypeInterfaceParameterDirection: @@ -3813,7 +4570,7 @@ Interface Parameter Direction A value of this type shall be of one of the following variants: -* There may by be no value (null). +* There may be no value (null). * The value may be a string. It specifies the interface parameter direction. The value shall be an element of @@ -3826,16 +4583,16 @@ A value of this type shall be of one of the following variants: This type is used by the following types: -* :ref:`SpecTypeActionRequirementTestRunParameter` - * :ref:`SpecTypeInterfaceParameter` +* :ref:`SpecTypeTestRunParameter` + .. _SpecTypeInterfacePlacementLinkRole: Interface Placement Link Role ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeLink` though the ``role`` attribute if the +This type refines the :ref:`SpecTypeLink` through the ``role`` attribute if the value is ``interface-placement``. It defines the interface placement role of links. It is used to indicate that an interface definition is placed into an interface container, for example a header file. @@ -3845,22 +4602,27 @@ interface container, for example a header file. Interface Return Directive ^^^^^^^^^^^^^^^^^^^^^^^^^^ -This set of attributes specifies an interface return. All explicit attributes -shall be specified. The explicit attributes for this type are: +A value of this type shall be of one of the following variants: -return - The attribute value shall be an optional string. It shall describe the - interface return for unspecified return values. +* The value may be a set of attributes. This set of attributes specifies an + interface return. All explicit attributes shall be specified. The explicit + attributes for this type are: -return-values - The attribute value shall be a list. Each list element shall be an - :ref:`SpecTypeInterfaceReturnValue`. + return + The attribute value shall be an optional string. It shall describe the + interface return for unspecified return values. + + return-values + The attribute value shall be a list. Each list element shall be an + :ref:`SpecTypeInterfaceReturnValue`. + +* There may be no value (null). This type is used by the following types: -* :ref:`SpecTypeInterfaceFunctionItemType` +* :ref:`SpecTypeInterfaceFunctionOrMacroItemType` -* :ref:`SpecTypeInterfaceMacroItemType` +* :ref:`SpecTypeInterfaceTypedefItemType` .. _SpecTypeInterfaceReturnValue: @@ -3886,7 +4648,7 @@ This type is used by the following types: Interface Target Link Role ^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeLink` though the ``role`` attribute if the +This type refines the :ref:`SpecTypeLink` through the ``role`` attribute if the value is ``interface-target``. It defines the interface target role of links. It is used for interface forward declarations. @@ -3910,12 +4672,14 @@ uid This type is refined by the following types: -* :ref:`SpecTypeApplicationConfigurationGroupMemberLinkRole` +* :ref:`SpecTypeBuildDependencyConditionalLinkRole` * :ref:`SpecTypeBuildDependencyLinkRole` * :ref:`SpecTypeConstraintLinkRole` +* :ref:`SpecTypeFunctionImplementationLinkRole` + * :ref:`SpecTypeGlossaryMembershipLinkRole` * :ref:`SpecTypeInterfaceEnumeratorLinkRole` @@ -3924,20 +4688,34 @@ This type is refined by the following types: * :ref:`SpecTypeInterfaceGroupMembershipLinkRole` +* :ref:`SpecTypeInterfaceHiddenGroupMembershipLinkRole` + * :ref:`SpecTypeInterfaceIncludeLinkRole` * :ref:`SpecTypeInterfacePlacementLinkRole` * :ref:`SpecTypeInterfaceTargetLinkRole` +* :ref:`SpecTypePerformanceRuntimeLimitsLinkRole` + +* :ref:`SpecTypePlacementOrderLinkRole` + +* :ref:`SpecTypeProxyMemberLinkRole` + +* :ref:`SpecTypeRegisterBlockIncludeRole` + * :ref:`SpecTypeRequirementRefinementLinkRole` * :ref:`SpecTypeRequirementValidationLinkRole` +* :ref:`SpecTypeRuntimeMeasurementRequestLinkRole` + * :ref:`SpecTypeSpecificationMemberLinkRole` * :ref:`SpecTypeSpecificationRefinementLinkRole` +* :ref:`SpecTypeUnitTestLinkRole` + This type is used by the following types: * :ref:`SpecTypeRootItemType` @@ -3960,7 +4738,7 @@ This type is used by the following types: * :ref:`SpecTypeBuildItemType` -* :ref:`SpecTypeBuildOptionSetTestStateAction` +* :ref:`SpecTypeExternalReference` * :ref:`SpecTypeFunctionalRequirementItemType` @@ -3970,10 +4748,20 @@ This type is used by the following types: * :ref:`SpecTypeLink` +* :ref:`SpecTypeNonFunctionalRequirementItemType` + +* :ref:`SpecTypeRegisterDefinition` + * :ref:`SpecTypeRequirementItemType` +* :ref:`SpecTypeRequirementValidationItemType` + * :ref:`SpecTypeRootItemType` +* :ref:`SpecTypeRuntimeMeasurementParameterSet` + +* :ref:`SpecTypeRuntimePerformanceParameterSet` + * :ref:`SpecTypeSpecificationAttributeValue` * :ref:`SpecTypeSpecificationExplicitAttributes` @@ -3986,6 +4774,32 @@ This type is used by the following types: * :ref:`SpecTypeSpecificationRefinementLinkRole` +.. _SpecTypeOptionalFloatingPointNumber: + +Optional Floating-Point Number +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +A value of this type shall be of one of the following variants: + +* The value may be a floating-point number. + +* There may be no value (null). + +.. _SpecTypeOptionalInteger: + +Optional Integer +^^^^^^^^^^^^^^^^ + +A value of this type shall be of one of the following variants: + +* The value may be an integer number. + +* There may be no value (null). + +This type is used by the following types: + +* :ref:`SpecTypeRegisterBlockItemType` + .. _SpecTypeOptionalString: Optional String @@ -3993,98 +4807,302 @@ Optional String A value of this type shall be of one of the following variants: -* There may by be no value (null). +* There may be no value (null). * The value may be a string. -.. _SpecTypeRequirementNonFunctionalType: +.. _SpecTypePerformanceRuntimeLimitsLinkRole: -Requirement Non-Functional Type -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Performance Runtime Limits Link Role +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This type refines the :ref:`SpecTypeLink` through the ``role`` attribute if the +value is ``performance-runtime-limits``. It defines the performance runtime +limits role of links. All explicit attributes shall be specified. The explicit +attributes for this type are: + +limits + The attribute value shall be a + :ref:`SpecTypeRuntimeMeasurementEnvironmentTable`. -The value shall be a string. This type shall be used for non-functional -requirement types. The value shall be an element of +.. _SpecTypePlacementOrderLinkRole: -* "``build-configuration``", +Placement Order Link Role +^^^^^^^^^^^^^^^^^^^^^^^^^ -* "``constraint``", +This type refines the :ref:`SpecTypeLink` through the ``role`` attribute if the +value is ``placement-order``. This link role defines the placement order of +items in a container item (for example an interface function in a header file +or a documentation section). -* "``design``", +.. _SpecTypeProxyMemberLinkRole: -* "``documentation``", +Proxy Member Link Role +^^^^^^^^^^^^^^^^^^^^^^ -* "``interface``", +This type refines the :ref:`SpecTypeLink` through the ``role`` attribute if the +value is ``proxy-member``. It defines the proxy member role of links. Items +may use this role to link to :ref:`SpecTypeProxyItemTypes` items. -* "``interface-requirement``", +.. _SpecTypeRegisterBitsDefinition: + +Register Bits Definition +^^^^^^^^^^^^^^^^^^^^^^^^ + +A value of this type shall be of one of the following variants: + +* The value may be a set of attributes. This set of attributes specifies a + register bit field. Single bits are bit fields with a width of one. All + explicit attributes shall be specified. The explicit attributes for this type + are: -* "``maintainability``", + brief + The attribute value shall be an :ref:`SpecTypeInterfaceBriefDescription`. -* "``performance``", + description + The attribute value shall be an :ref:`SpecTypeInterfaceDescription`. -* "``portability``", + name + The attribute value shall be a string. It shall be the name of the + register bit field. -* "``quality``", + properties + The attribute value shall be a list of strings. It shall be the list of + bit field properties. Properties are for example if the bit field can be + read or written, or an access has side-effects such as clearing a status. -* "``reliability``", + start + The attribute value shall be an integer number. It shall be the start bit + of the bit field. Bit ``0`` is the least-significant bit. -* "``resource``", and + width + The attribute value shall be an integer number. It shall be the width in + bits of the bit field. -* "``safety``". +* There may be no value (null). This type is used by the following types: -* :ref:`SpecTypeNonFunctionalRequirementItemType` +* :ref:`SpecTypeRegisterBitsDefinitionDirective` -.. _SpecTypeRequirementReference: +* :ref:`SpecTypeRegisterBitsDefinitionVariant` -Requirement Reference -^^^^^^^^^^^^^^^^^^^^^ +.. _SpecTypeRegisterBitsDefinitionDirective: -This set of attributes specifies a requirement reference. All explicit +Register Bits Definition Directive +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This set of attributes specifies a register bits directive. All explicit attributes shall be specified. The explicit attributes for this type are: -identifier - The attribute value shall be a string. It shall be the type-specific - identifier of the reference target. For *group* references use the Doxygen - group identifier. +default + The attribute value shall be a list. Each list element shall be a + :ref:`SpecTypeRegisterBitsDefinition`. The default definition will be used + if no variant-specific definition is enabled. -type - The attribute value shall be a :ref:`SpecTypeRequirementReferenceType`. +variants + The attribute value shall be a list. Each list element shall be a + :ref:`SpecTypeRegisterBitsDefinitionVariant`. This type is used by the following types: -* :ref:`SpecTypeRequirementItemType` +* :ref:`SpecTypeRegisterDefinition` -.. _SpecTypeRequirementReferenceType: +.. _SpecTypeRegisterBitsDefinitionVariant: -Requirement Reference Type -^^^^^^^^^^^^^^^^^^^^^^^^^^ +Register Bits Definition Variant +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This set of attributes specifies a register bits variant. All explicit +attributes shall be specified. The explicit attributes for this type are: + +definition + The attribute value shall be a list. Each list element shall be a + :ref:`SpecTypeRegisterBitsDefinition`. The definition will be used if the + expression defined by the ``enabled-by`` attribute evaluates to true. In + generated header files, the expression is evaluated by the C preprocessor. + +enabled-by + The attribute value shall be an + :ref:`SpecTypeInterfaceEnabledByExpression`. + +This type is used by the following types: + +* :ref:`SpecTypeRegisterBitsDefinitionDirective` + +.. _SpecTypeRegisterBlockIncludeRole: + +Register Block Include Role +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This type refines the :ref:`SpecTypeLink` through the ``role`` attribute if the +value is ``register-block-include``. It defines the register block include role +of links. Links of this role are used to build register blocks using other +register blocks. All explicit attributes shall be specified. The explicit +attributes for this type are: + +name + The attribute value shall be a string. It shall be a name to identify the + included register block within the item. The name shall be unique within + the scope of the item links of this role and the + :ref:`SpecTypeRegisterList`. + +.. _SpecTypeRegisterBlockMemberDefinition: + +Register Block Member Definition +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +A value of this type shall be of one of the following variants: + +* The value may be a set of attributes. This set of attributes specifies a + register block member definition. All explicit attributes shall be specified. + The explicit attributes for this type are: + + count + The attribute value shall be an integer number. It shall be the count of + registers of the register block member. + + name + The attribute value shall be a :ref:`SpecTypeRegisterName`. + +* There may be no value (null). + +This type is used by the following types: + +* :ref:`SpecTypeRegisterBlockMemberDefinitionDirective` -The value shall be a string. It specifies the type of a requirement reference. -The value shall be an element of +* :ref:`SpecTypeRegisterBlockMemberDefinitionVariant` -* "``define``", +.. _SpecTypeRegisterBlockMemberDefinitionDirective: -* "``file``", +Register Block Member Definition Directive +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -* "``function``", +This set of attributes specifies a register block member definition directive. +All explicit attributes shall be specified. The explicit attributes for this +type are: -* "``group``", +default + The attribute value shall be a + :ref:`SpecTypeRegisterBlockMemberDefinition`. The default definition will + be used if no variant-specific definition is enabled. -* "``macro``", and +offset + The attribute value shall be an integer number. It shall be the address of + the register block member relative to the base address of the register + block. -* "``variable``". +variants + The attribute value shall be a list. Each list element shall be a + :ref:`SpecTypeRegisterBlockMemberDefinitionVariant`. This type is used by the following types: -* :ref:`SpecTypeRequirementReference` +* :ref:`SpecTypeRegisterBlockItemType` + +.. _SpecTypeRegisterBlockMemberDefinitionVariant: + +Register Block Member Definition Variant +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This set of attributes specifies a register block member definition variant. +All explicit attributes shall be specified. The explicit attributes for this +type are: + +definition + The attribute value shall be a + :ref:`SpecTypeRegisterBlockMemberDefinition`. The definition will be used + if the expression defined by the ``enabled-by`` attribute evaluates to + true. In generated header files, the expression is evaluated by the C + preprocessor. + +enabled-by + The attribute value shall be an + :ref:`SpecTypeInterfaceEnabledByExpression`. + +This type is used by the following types: + +* :ref:`SpecTypeRegisterBlockMemberDefinitionDirective` + +.. _SpecTypeRegisterDefinition: + +Register Definition +^^^^^^^^^^^^^^^^^^^ + +This set of attributes specifies a register. All explicit attributes shall be +specified. The explicit attributes for this type are: + +bits + The attribute value shall be a list. Each list element shall be a + :ref:`SpecTypeRegisterBitsDefinitionDirective`. + +brief + The attribute value shall be an :ref:`SpecTypeInterfaceBriefDescription`. + +description + The attribute value shall be an :ref:`SpecTypeInterfaceDescription`. + +name + The attribute value shall be a string. It shall be the name to identify the + register definition. The name shall be unique within the scope of the + :ref:`SpecTypeRegisterBlockIncludeRole` links of the item and the + :ref:`SpecTypeRegisterList`. + +width + The attribute value shall be an integer number. It shall be the width of + the register in bits. + +In addition to the explicit attributes, generic attributes may be specified. +Each generic attribute key shall be a :ref:`SpecTypeName`. The attribute value +may have any type. + +This type is used by the following types: + +* :ref:`SpecTypeRegisterBlockItemType` + +.. _SpecTypeRegisterName: + +Register Name +^^^^^^^^^^^^^ + +The value shall be a string. The name consists either of an identifier, or an +identifier and an alias. The identifier and alias are separated by a colon +(``:``). The identifier shall match with the name of a register definition of +the item (see :ref:`SpecTypeRegisterDefinition`) or the name of a register +block include of the item (see :ref:`SpecTypeRegisterBlockIncludeRole`). If no +alias is specified, then the identifier is used for the register block member +name, otherwise the alias is used. If the register block member names are not +unique within the item, then a postfix number is appended to the names. The +number starts with zero for each set of names. The value shall match with the +regular expression "``^[a-zA-Z_][a-zA-Z0-9_]*(:[a-zA-Z_][a-zA-Z0-9_]*)?$``". + +This type is used by the following types: + +* :ref:`SpecTypeRegisterBlockMemberDefinition` + +.. _SpecTypeRequirementDesignGroupIdentifier: + +Requirement Design Group Identifier +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +A value of this type shall be of one of the following variants: + +* There may be no value (null). + +* The value may be a string. It shall be the identifier of the requirement + design group. The value shall match with the regular expression + "``^[a-zA-Z0-9_]*$``". + +This type is used by the following types: + +* :ref:`SpecTypeDesignGroupRequirementItemType` .. _SpecTypeRequirementRefinementLinkRole: Requirement Refinement Link Role ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeLink` though the ``role`` attribute if the +This type refines the :ref:`SpecTypeLink` through the ``role`` attribute if the value is ``requirement-refinement``. It defines the requirement refinement role of links. @@ -4093,130 +5111,130 @@ of links. Requirement Text ^^^^^^^^^^^^^^^^ -The value shall be a string. It shall state a requirement or constraint. The -value shall not contain an element of +The value shall be a string. It shall state a requirement or constraint. The +text should not use one of the following words or phrases: -* "``acceptable``", +* acceptable -* "``adequate``", +* adequate -* "``almost always``", +* almost always -* "``and/or``", +* and/or -* "``appropriate``", +* appropriate -* "``approximately``", +* approximately -* "``as far as possible``", +* as far as possible -* "``as much as practicable``", +* as much as practicable -* "``best``", +* best -* "``best possible``", +* best possible -* "``easy``", +* easy -* "``efficient``", +* efficient -* "``e.g.``", +* e.g. -* "``enable``", +* enable -* "``enough``", +* enough -* "``etc.``", +* etc. -* "``few``", +* few -* "``first rate``", +* first rate -* "``flexible``", +* flexible -* "``generally``", +* generally -* "``goal``", +* goal -* "``graceful``", +* graceful -* "``great``", +* great -* "``greatest``", +* greatest -* "``ideally``", +* ideally -* "``i.e.``", +* i.e. -* "``if possible``", +* if possible -* "``in most cases``", +* in most cases -* "``large``", +* large -* "``many``", +* many -* "``maximize``", +* maximize -* "``minimize``", +* minimize -* "``most``", +* most -* "``multiple``", +* multiple -* "``necessary``", +* necessary -* "``numerous``", +* numerous -* "``optimize``", +* optimize -* "``ought to``", +* ought to -* "``probably``", +* probably -* "``quick``", +* quick -* "``rapid``", +* rapid -* "``reasonably``", +* reasonably -* "``relevant``", +* relevant -* "``robust``", +* robust -* "``satisfactory``", +* satisfactory -* "``several``", +* several -* "``shall be included but not limited to``", +* shall be included but not limited to -* "``simple``", +* simple -* "``small``", +* small -* "``some``", +* some -* "``state of the art``", +* state of the art -* "``sufficient``", +* sufficient -* "``suitable``", +* suitable -* "``support``", +* support -* "``systematically``", +* systematically -* "``transparent``", +* transparent -* "``typical``", +* typical -* "``user friendly``", +* user friendly -* "``usually``", +* usually -* "``versatile``", and +* versatile -* "``when necessary``". +* when necessary This type is used by the following types: @@ -4224,12 +5242,10 @@ This type is used by the following types: * :ref:`SpecTypeApplicationConfigurationGroupItemType` -* :ref:`SpecTypeApplicationConfigurationOptionConstraintSet` - -* :ref:`SpecTypeApplicationConfigurationOptionItemType` - * :ref:`SpecTypeConstraintItemType` +* :ref:`SpecTypeInterfaceGroupItemType` + * :ref:`SpecTypeRequirementItemType` .. _SpecTypeRequirementValidationLinkRole: @@ -4237,26 +5253,144 @@ This type is used by the following types: Requirement Validation Link Role ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeLink` though the ``role`` attribute if the +This type refines the :ref:`SpecTypeLink` through the ``role`` attribute if the value is ``validation``. It defines the requirement validation role of links. -.. _SpecTypeRequirementValidationMethod: +.. _SpecTypeRuntimeMeasurementEnvironmentName: -Requirement Validation Method -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Runtime Measurement Environment Name +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The value shall be a string. It specifies the runtime measurement environment +name. The value + +* shall be an element of -The value shall be a string. This value type characterizes a requirement -validation method (except validation by test). The value shall be an element of + * "``FullCache``", -* "``by-analysis``", + * "``HotCache``", and -* "``by-inspection``", and + * "``DirtyCache``", -* "``by-review-of-design``". +* or, shall match with the regular expression "``^Load/[1-9][0-9]*$``". This type is used by the following types: -* :ref:`SpecTypeRequirementValidationItemType` +* :ref:`SpecTypeRuntimeMeasurementEnvironmentTable` + +.. _SpecTypeRuntimeMeasurementEnvironmentTable: + +Runtime Measurement Environment Table +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This set of attributes provides runtime performance limits for a set of runtime +measurement environments. Generic attributes may be specified. Each generic +attribute key shall be a :ref:`SpecTypeRuntimeMeasurementEnvironmentName`. Each +generic attribute value shall be a :ref:`SpecTypeRuntimeMeasurementValueTable`. + +This type is used by the following types: + +* :ref:`SpecTypePerformanceRuntimeLimitsLinkRole` + +.. _SpecTypeRuntimeMeasurementParameterSet: + +Runtime Measurement Parameter Set +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This set of attributes defines parameters of the runtime measurement test case. +All explicit attributes shall be specified. The explicit attributes for this +type are: + +sample-count + The attribute value shall be an integer number. It shall be the sample + count of the runtime measurement context. + +In addition to the explicit attributes, generic attributes may be specified. +Each generic attribute key shall be a :ref:`SpecTypeName`. The attribute value +may have any type. + +This type is used by the following types: + +* :ref:`SpecTypeRuntimeMeasurementTestItemType` + +.. _SpecTypeRuntimeMeasurementRequestLinkRole: + +Runtime Measurement Request Link Role +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This type refines the :ref:`SpecTypeLink` through the ``role`` attribute if the +value is ``runtime-measurement-request``. It defines the runtime measurement +request role of links. The link target shall be a +:ref:`SpecTypeRuntimeMeasurementTestItemType` item. + +.. _SpecTypeRuntimeMeasurementValueKind: + +Runtime Measurement Value Kind +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The value shall be a string. It specifies the kind of a runtime measurement +value. The value shall be an element of + +* "``max-lower-bound``", + +* "``max-upper-bound``", + +* "``mean-lower-bound``", + +* "``mean-upper-bound``", + +* "``median-lower-bound``", + +* "``median-upper-bound``", + +* "``min-lower-bound``", and + +* "``min-upper-bound``". + +This type is used by the following types: + +* :ref:`SpecTypeRuntimeMeasurementValueTable` + +.. _SpecTypeRuntimeMeasurementValueTable: + +Runtime Measurement Value Table +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This set of attributes provides a set of runtime measurement values each of a +specified kind. The unit of the values shall be one second. Generic attributes +may be specified. Each generic attribute key shall be a +:ref:`SpecTypeRuntimeMeasurementValueKind`. Each generic attribute value shall +be a floating-point number. + +This type is used by the following types: + +* :ref:`SpecTypeRuntimeMeasurementEnvironmentTable` + +.. _SpecTypeRuntimePerformanceParameterSet: + +Runtime Performance Parameter Set +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This set of attributes defines parameters of the runtime performance +requirement. Generic attributes may be specified. Each generic attribute key +shall be a :ref:`SpecTypeName`. The attribute value may have any type. + +This type is used by the following types: + +* :ref:`SpecTypeRuntimePerformanceRequirementItemType` + +.. _SpecTypeSHA256HashValue: + +SHA256 Hash Value +^^^^^^^^^^^^^^^^^ + +The value shall be a string. It shall be a SHA256 hash value encoded in +base64url. The value shall match with the regular expression +"``^[A-Za-z0-9+_=-]{44}$``". + +This type is used by the following types: + +* :ref:`SpecTypeExternalFileReference` .. _SpecTypeSPDXLicenseIdentifier: @@ -4688,7 +5822,7 @@ This type is used by the following types: Specification Member Link Role ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeLink` though the ``role`` attribute if the +This type refines the :ref:`SpecTypeLink` through the ``role`` attribute if the value is ``spec-member``. It defines the specification membership role of links. @@ -4697,7 +5831,7 @@ links. Specification Refinement Link Role ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This type refines the :ref:`SpecTypeLink` though the ``role`` attribute if the +This type refines the :ref:`SpecTypeLink` through the ``role`` attribute if the value is ``spec-refinement``. It defines the specification refinement role of links. All explicit attributes shall be specified. The explicit attributes for this type are: @@ -4833,7 +5967,11 @@ Test Case Action This set of attributes specifies a test case action. All explicit attributes shall be specified. The explicit attributes for this type are: -action +action-brief + The attribute value shall be an optional string. It shall be the test case + action brief description. + +action-code The attribute value shall be a string. It shall be the test case action code. @@ -4841,13 +5979,11 @@ checks The attribute value shall be a list. Each list element shall be a :ref:`SpecTypeTestCaseCheck`. -description - The attribute value shall be an optional string. It shall be the test case - action description. - links The attribute value shall be a list. Each list element shall be a - :ref:`SpecTypeLink`. + :ref:`SpecTypeLink`. The links should use the + :ref:`SpecTypeRequirementValidationLinkRole` for validation tests and the + :ref:`SpecTypeUnitTestLinkRole` for unit tests. This type is used by the following types: @@ -4861,39 +5997,175 @@ Test Case Check This set of attributes specifies a test case check. All explicit attributes shall be specified. The explicit attributes for this type are: -check +brief + The attribute value shall be an optional string. It shall be the test case + check brief description. + +code The attribute value shall be a string. It shall be the test case check code. -description - The attribute value shall be an optional string. It shall be the test case - check description. - links The attribute value shall be a list. Each list element shall be a - :ref:`SpecTypeLink`. + :ref:`SpecTypeLink`. The links should use the + :ref:`SpecTypeRequirementValidationLinkRole` for validation tests and the + :ref:`SpecTypeUnitTestLinkRole` for unit tests. This type is used by the following types: * :ref:`SpecTypeTestCaseAction` -.. _SpecTypeTestName: +.. _SpecTypeTestContextMember: -Test Name -^^^^^^^^^ +Test Context Member +^^^^^^^^^^^^^^^^^^^ -The value shall be a string. It shall be the name of a test suite or test case. -It shall be formatted in the style of a caption. If shall form a valid C -designator after removal of all white space characters. The value shall match -with the regular expression "``^[A-Z][a-zA-Z0-9 _]+$"``. +A value of this type shall be of one of the following variants: + +* The value may be a set of attributes. This set of attributes defines an + action requirement test context member. All explicit attributes shall be + specified. The explicit attributes for this type are: + + brief + The attribute value shall be an optional string. It shall be the test + context member brief description. + + description + The attribute value shall be an optional string. It shall be the test + context member description. + + member + The attribute value shall be a string. It shall be the test context + member definition. It shall be a valid C structure member definition + without a trailing ``;``. + +* There may be no value (null). This type is used by the following types: * :ref:`SpecTypeActionRequirementItemType` +* :ref:`SpecTypeRuntimeMeasurementTestItemType` + * :ref:`SpecTypeTestCaseItemType` -* :ref:`SpecTypeTestSuiteItemType` +.. _SpecTypeTestHeader: + +Test Header +^^^^^^^^^^^ + +A value of this type shall be of one of the following variants: + +* The value may be a set of attributes. This set of attributes specifies a test + header. In case a test header is specified, then instead of a test case a + test run function will be generated. The test run function will be declared + in the test header target file and defined in the test source target file. + The test run function can be used to compose test cases. The test header + file is not automatically included in the test source file. It should be + added to the includes or local includes of the test. All explicit attributes + shall be specified. The explicit attributes for this type are: + + code + The attribute value shall be an optional string. If the value is present, + then it shall be the test header code. The header code is placed at file + scope after the general test declarations and before the test run + function declaration. + + freestanding + The attribute value shall be a boolean. The value shall be ``true``, if + the test case is freestanding, otherwise ``false``. Freestanding test + cases are not statically registered. Instead the generated test runner + uses :c:func:`T_case_begin` and :c:func:`T_case_end`. + + includes + The attribute value shall be a list of strings. It shall be a list of + header files included by the header file via ``#include <...>``. + + local-includes + The attribute value shall be a list of strings. It shall be a list of + header files included by the header file via ``#include "..."``. + + run-params + The attribute value shall be a list. Each list element shall be a + :ref:`SpecTypeTestRunParameter`. + + target + The attribute value shall be a string. It shall be the path to the + generated test header file. + +* There may be no value (null). + +This type is used by the following types: + +* :ref:`SpecTypeActionRequirementItemType` + +* :ref:`SpecTypeTestCaseItemType` + +.. _SpecTypeTestRunParameter: + +Test Run Parameter +^^^^^^^^^^^^^^^^^^ + +This set of attributes specifies a parameter for the test run function. In case +this parameter is used in an :ref:`SpecTypeActionRequirementItemType` item, +then the parameter is also added as a member to the test context, see +:ref:`SpecTypeTestContextMember`. All explicit attributes shall be specified. +The explicit attributes for this type are: + +description + The attribute value shall be a string. It shall be the description of the + parameter. + +dir + The attribute value shall be an :ref:`SpecTypeInterfaceParameterDirection`. + +name + The attribute value shall be a string. It shall be the parameter name. + +specifier + The attribute value shall be a string. It shall be the complete function + parameter specifier. Use ``${.:name}`` for the parameter name, for example + ``"int ${.:name}"``. + +This type is used by the following types: + +* :ref:`SpecTypeTestHeader` + +.. _SpecTypeTestSupportMethod: + +Test Support Method +^^^^^^^^^^^^^^^^^^^ + +A value of this type shall be of one of the following variants: + +* The value may be a set of attributes. This set of attributes defines an + action requirement test support method. All explicit attributes shall be + specified. The explicit attributes for this type are: + + brief + The attribute value shall be an optional string. It shall be the test + support method brief description. + + code + The attribute value shall be a string. It shall be the test support + method code. The code may use a local variable ``ctx`` which points to + the test context, see :ref:`SpecTypeTestContextMember`. + + description + The attribute value shall be an optional string. It shall be the test + support method description. + +* There may be no value (null). + +This type is used by the following types: + +* :ref:`SpecTypeActionRequirementItemType` + +* :ref:`SpecTypeRuntimeMeasurementTestItemType` + +* :ref:`SpecTypeRuntimePerformanceRequirementItemType` + +* :ref:`SpecTypeTestCaseItemType` .. _SpecTypeUID: @@ -4906,3 +6178,18 @@ item UID. This type is used by the following types: * :ref:`SpecTypeLink` + +.. _SpecTypeUnitTestLinkRole: + +Unit Test Link Role +^^^^^^^^^^^^^^^^^^^ + +This type refines the :ref:`SpecTypeLink` through the ``role`` attribute if the +value is ``unit-test``. It defines the unit test role of links. For unit tests +the link target should be the :ref:`SpecTypeInterfaceDomainItemType` containing +the software unit. All explicit attributes shall be specified. The explicit +attributes for this type are: + +name + The attribute value shall be a string. It shall be the name of the tested + software unit. |