5.2. Specification Items

5.2.2. Specification Item Types

5.2.2.1. Root Item Type

The technical specification of RTEMS will contain for example requirements, specializations of requirements, interface specifications, test suites, test cases, and requirement validations. These things will be called specification items or just items if it is clear from the context.

The specification items are stored in files in YAML format with a defined set of key-value pairs called attributes. Each attribute key name shall be a Name. In particular, key names which begin with an underscore (_) are reserved for internal use in tools.

This is the root specification item type. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

SPDX-License-Identifier

The attribute value shall be a SPDX License Identifier. It shall be the license of the item.

copyrights

The attribute value shall be a list. Each list element shall be a Copyright. It shall be the list of copyright statements of the item.

enabled-by

The attribute value shall be an Enabled-By Expression. It shall define the conditions under which the item is enabled.

links

The attribute value shall be a list. Each list element shall be a Link.

type

The attribute value shall be a Name. It shall be the item type. The selection of types and the level of detail depends on a particular standard and product model. We need enough flexibility to be in line with ECSS-E-ST-10-06 and possible future applications of other standards. The item type may be refined further with additional type-specific subtypes.

This type is refined by the following types:

5.2.2.2. Build Item Type

This type refines the Root Item Type though the type attribute if the value is build. This set of attributes specifies a build item. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

build-type

The attribute value shall be a Name. It shall be the build item type.

This type is refined by the following types:

5.2.2.3. Build Ada Test Program Item Type

This type refines the Build Item Type though 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 Build Objects Item Type items. Test programs have an implicit enabled-by attribute value which is controlled by the option action set-test-state. If the test state is set to exclude, then the test program is not built. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

ada-main

The attribute value shall be a string. It shall be the path to the Ada main body file.

ada-object-directory

The attribute value shall be a string. It shall be the path to the Ada object directory (-D option value for gnatmake).

adaflags

The attribute value shall be a list of strings. It shall be a list of options for the Ada compiler.

adaincludes

The attribute value shall be a list of strings. It shall be a list of Ada include paths.

cflags

The attribute value shall be a list. Each list element shall be a Build C Compiler Option.

cppflags

The attribute value shall be a list. Each list element shall be a Build C Preprocessor Option.

includes

The attribute value shall be a list. Each list element shall be a Build Include Path.

ldflags

The attribute value shall be a list. Each list element shall be a Build Linker Option.

source

The attribute value shall be a list. Each list element shall be a Build Source.

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.

target

The attribute value shall be a Build Target.

use-after

The attribute value shall be a list. Each list element shall be a Build Use After Directive.

use-before

The attribute value shall be a list. Each list element shall be a Build Use Before Directive.

Please have a look at the following example:

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
ada-main: testsuites/ada/samples/hello/hello.adb
ada-object-directory: testsuites/ada/samples/hello
adaflags: []
adaincludes:
- cpukit/include/adainclude
- testsuites/ada/support
build-type: ada-test-program
cflags: []
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
cppflags: []
enabled-by: true
includes: []
ldflags: []
links: []
source:
- testsuites/ada/samples/hello/init.c
stlib: []
target: testsuites/ada/ada_hello.exe
type: build
use-after: []
use-before: []

5.2.2.4. Build BSP Item Type

This type refines the Build Item Type though the build-type attribute if the value is bsp. This set of attributes specifies a base BSP variant to build. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

arch

The attribute value shall be a string. It shall be the target architecture of the BSP.

bsp

The attribute value shall be a string. It shall be the base BSP variant name.

cflags

The attribute value shall be a list. Each list element shall be a Build C Compiler Option.

cppflags

The attribute value shall be a list. Each list element shall be a Build C Preprocessor Option.

family

The attribute value shall be a string. It shall be the BSP family name. The name shall be the last directory of the path to the BSP sources.

includes

The attribute value shall be a list. Each list element shall be a Build Include Path.

install

The attribute value shall be a list. Each list element shall be a Build Install Directive.

source

The attribute value shall be a list. Each list element shall be a Build Source.

Please have a look at the following example:

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
arch: myarch
bsp: mybsp
build-type: bsp
cflags: []
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
cppflags: []
enabled-by: true
family: mybsp
includes: []
install:
- destination: ${BSP_INCLUDEDIR}
  source:
  - bsps/myarch/mybsp/include/bsp.h
  - bsps/myarch/mybsp/include/tm27.h
- destination: ${BSP_INCLUDEDIR}/bsp
  source:
  - bsps/myarch/mybsp/include/bsp/irq.h
- destination: ${BSP_LIBDIR}
  source:
  - bsps/myarch/mybsp/start/linkcmds
links:
- role: build-dependency
  uid: ../../obj
- role: build-dependency
  uid: ../../opto2
- role: build-dependency
  uid: abi
- role: build-dependency
  uid: obj
- role: build-dependency
  uid: ../start
- role: build-dependency
  uid: ../../bspopts
source:
- bsps/myarch/mybsp/start/bspstart.c
type: build

5.2.2.5. Build Configuration File Item Type

This type refines the Build Item Type though 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 are placed in the build tree. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

content

The attribute value shall be a string. It shall be the content of the configuration file. A ${VARIABLE} substitution is performed during the configure command execution using the variables of the configuration set. Use $$ for a plain $ character. To have all variables from sibling items available for substitution it is recommended to link them in the proper order.

install-path

The attribute value shall be a Build Install Path.

target

The attribute value shall be a Build Target.

Please have a look at the following example:

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
build-type: config-file
content: |
  # ...
  Name: ${ARCH}-rtems${__RTEMS_MAJOR__}-${BSP_NAME}
  # ...
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
install-path: ${PREFIX}/lib/pkgconfig
links: []
target: ${ARCH}-rtems${__RTEMS_MAJOR__}-${BSP_NAME}.pc
type: build

5.2.2.6. Build Configuration Header Item Type

This type refines the Build Item Type though 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 configuration defines are written to the configuration header file during the configure command execution. To have all configuration defines from sibling items available it is recommended to link them in the proper order. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

guard

The attribute value shall be a string. It shall be the header guard define.

include-headers

The attribute value shall be a list of strings. It shall be a list of header files to include via #include <...>.

install-path

The attribute value shall be a Build Install Path.

target

The attribute value shall be a Build Target.

5.2.2.7. Build Group Item Type

This type refines the Build Item Type though 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 use variables of the build item context are updated by the corresponding attributes of the build group. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

includes

The attribute value shall be a list. Each list element shall be a Build Include Path.

install

The attribute value shall be a list. Each list element shall be a Build Install Directive.

ldflags

The attribute value shall be a list of strings. It shall be a list of options for the linker. They are used to link executables referenced by this item.

use-after

The attribute value shall be a list. Each list element shall be a Build Use After Directive.

use-before

The attribute value shall be a list. Each list element shall be a Build Use Before Directive.

Please have a look at the following example:

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
build-type: group
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by:
- BUILD_TESTS
- BUILD_SAMPLES
includes:
- testsuites/support/include
install: []
ldflags:
- -Wl,--wrap=printf
- -Wl,--wrap=puts
links:
- role: build-dependency
  uid: ticker
type: build
use-after: []
use-before:
- rtemstest

5.2.2.8. Build Library Item Type

This type refines the Build Item Type though 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 Build Objects Item Type items through the build dependency links of the item. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

cflags

The attribute value shall be a list. Each list element shall be a Build C Compiler Option.

cppflags

The attribute value shall be a list. Each list element shall be a Build C Preprocessor Option.

cxxflags

The attribute value shall be a list. Each list element shall be a Build C++ Compiler Option.

includes

The attribute value shall be a list. Each list element shall be a Build Include Path.

install

The attribute value shall be a list. Each list element shall be a Build Install Directive.

install-path

The attribute value shall be a Build Install Path.

source

The attribute value shall be a list. Each list element shall be a Build Source.

target

The attribute value shall be a Build Target. It shall be the name of the static library, e.g. z for libz.a.

Please have a look at the following example:

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
build-type: library
cflags:
- -Wno-pointer-sign
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
cppflags: []
cxxflags: []
enabled-by: true
includes:
- cpukit/libfs/src/jffs2/include
install:
- destination: ${BSP_INCLUDEDIR}/rtems
  source:
  - cpukit/include/rtems/jffs2.h
install-path: ${BSP_LIBDIR}
links: []
source:
- cpukit/libfs/src/jffs2/src/build.c
target: jffs2
type: build

5.2.2.9. Build Objects Item Type

This type refines the Build Item Type though 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 explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

cflags

The attribute value shall be a list. Each list element shall be a Build C Compiler Option.

cppflags

The attribute value shall be a list. Each list element shall be a Build C Preprocessor Option.

cxxflags

The attribute value shall be a list. Each list element shall be a Build C++ Compiler Option.

includes

The attribute value shall be a list. Each list element shall be a Build Include Path.

install

The attribute value shall be a list. Each list element shall be a Build Install Directive.

source

The attribute value shall be a list. Each list element shall be a Build Source.

Please have a look at the following example:

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
build-type: objects
cflags: []
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
cppflags: []
cxxflags: []
enabled-by: true
includes: []
install:
- destination: ${BSP_INCLUDEDIR}/bsp
  source:
  - bsps/include/bsp/bootcard.h
  - bsps/include/bsp/default-initial-extension.h
  - bsps/include/bsp/fatal.h
links: []
source:
- bsps/shared/start/bootcard.c
- bsps/shared/rtems-version.c
type: build

5.2.2.10. Build Option Item Type

This type refines the Build Item Type though the build-type attribute if the value is option. This set of attributes specifies a build option. The following explicitly defined attributes are required:

  • actions

  • default

  • default-by-variant

  • description

The following attributes are explicitly defined for this type:

actions

The attribute value shall be a list. Each list element shall be a Build Option Action. Each action operates on the action value handed over by a previous action and action-specific attribute values. The actions pass the processed action value to the next action in the list. The first action starts with an action value of None. The actions are carried out during the configure command execution.

default

The attribute value shall be a Build Option Value. 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 Build Option Default by Variant. The list is processed from top to bottom. If a matching variant is found, then the processing stops.

description

The attribute value shall be an optional string. It shall be the description of the option.

format

The attribute value shall be an optional string. It shall be a Python format string, for example '{}' or '{:#010x}'.

name

The attribute value shall be a Build Option Name.

Please have a look at the following example:

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
actions:
- get-integer: null
- 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:
  - m68k/m5484FireEngine
  - powerpc/hsc_cm01
- value: 19200
  variants:
  - m68k/COBRA5475
description: |
  Default baud for console and other serial devices.
enabled-by: true
format: '{}'
links: []
name: BSP_CONSOLE_BAUD
type: build

5.2.2.11. Build Script Item Type

This type refines the Build Item Type though 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 explicitly defined attributes are required:

  • do-build

  • do-configure

  • prepare-build

  • prepare-configure

The following attributes are explicitly defined for this type:

asflags

The attribute value shall be a list. Each list element shall be a Build Assembler Option.

cflags

The attribute value shall be a list. Each list element shall be a Build C Compiler Option.

cppflags

The attribute value shall be a list. Each list element shall be a Build C Preprocessor Option.

cxxflags

The attribute value shall be a list. Each list element shall be a Build C++ Compiler Option.

do-build

The attribute value shall be an optional string. If this script shall execute, then it shall be Python code which is executed via exec() in the context of the do_build() method of the wscript. A local variable bld is available with the waf build context. A local variable bic is available with the build item context.

do-configure

The attribute value shall be an optional string. If this script shall execute, then it shall be Python code which is executed via exec() in the context of the do_configure() method of the wscript. A local variable conf is available with the waf configuration context. A local variable cic is available with the configuration item context.

includes

The attribute value shall be a list. Each list element shall be a Build Include Path.

ldflags

The attribute value shall be a list. Each list element shall be a Build Linker Option.

prepare-build

The attribute value shall be an optional string. If this script shall execute, then it shall be Python code which is executed via exec() in the context of the prepare_build() method of the wscript. A local variable bld is available with the waf build context. A local variable bic is available with the build item context.

prepare-configure

The attribute value shall be an optional string. If this script shall execute, then it shall be Python code which is executed via exec() in the context of the prepare_configure() method of the wscript. A local variable conf is available with the waf configuration context. A local variable cic is available with the configuration item 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.

use-after

The attribute value shall be a list. Each list element shall be a Build Use After Directive.

use-before

The attribute value shall be a list. Each list element shall be a Build Use Before Directive.

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)
default: null
default-by-variant: []
do-build: |
  bld.install_as(
      "${BSP_LIBDIR}/linkcmds",
      "bsps/" + bld.env.ARCH + "/" + bld.env.BSP_FAMILY +
      "/start/linkcmds." + bld.env.BSP_BASE
  )
do-configure: |
  conf.env.append_value(
      "LINKFLAGS",
      ["-qnolinkcmds", "-T", "linkcmds." + conf.env.BSP_BASE]
  )
enabled-by: true
links: []
prepare-build: null
prepare-configure: null
type: build

5.2.2.12. Build Start File Item Type

This type refines the Build Item Type though 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 explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

asflags

The attribute value shall be a list. Each list element shall be a Build Assembler Option.

cppflags

The attribute value shall be a list. Each list element shall be a Build C Preprocessor Option.

includes

The attribute value shall be a list. Each list element shall be a Build Include Path.

install-path

The attribute value shall be a Build Install Path.

source

The attribute value shall be a list. Each list element shall be a Build Source.

target

The attribute value shall be a Build Target.

Please have a look at the following example:

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
asflags: []
build-type: start-file
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
cppflags: []
enabled-by: true
includes: []
install-path: ${BSP_LIBDIR}
links: []
source:
- bsps/sparc/shared/start/start.S
target: start.o
type: build

5.2.2.13. Build Test Program Item Type

This type refines the Build Item Type though 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 Build Objects Item Type items. Test programs have an implicit enabled-by attribute value which is controlled by the option action set-test-state. If the test state is set to exclude, then the test program is not built. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

cflags

The attribute value shall be a list. Each list element shall be a Build C Compiler Option.

cppflags

The attribute value shall be a list. Each list element shall be a Build C Preprocessor Option.

cxxflags

The attribute value shall be a list. Each list element shall be a Build C++ Compiler Option.

features

The attribute value shall be a string. It shall be the waf build features for this test program.

includes

The attribute value shall be a list. Each list element shall be a Build Include Path.

ldflags

The attribute value shall be a list. Each list element shall be a Build Linker Option.

source

The attribute value shall be a list. Each list element shall be a Build Source.

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.

target

The attribute value shall be a Build Target.

use-after

The attribute value shall be a list. Each list element shall be a Build Use After Directive.

use-before

The attribute value shall be a list. Each list element shall be a Build Use Before Directive.

Please have a look at the following example:

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
build-type: test-program
cflags: []
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
cppflags: []
cxxflags: []
enabled-by: true
features: c cprogram
includes: []
ldflags: []
links: []
source:
- testsuites/samples/ticker/init.c
- testsuites/samples/ticker/tasks.c
stlib: []
target: testsuites/samples/ticker.exe
type: build
use-after: []
use-before: []

5.2.2.14. Constraint Item Type

This type refines the Root Item Type though the type attribute if the value is constraint. This set of attributes specifies a constraint. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

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 Requirement Text. It shall state the constraint.

5.2.2.15. Glossary Item Type

This type refines the Root Item Type though the type attribute if the value is glossary. This set of attributes specifies a glossary item. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

glossary-type

The attribute value shall be a Name. It shall be the glossary item type.

This type is refined by the following types:

5.2.2.16. Glossary Group Item Type

This type refines the Glossary Item Type though the glossary-type attribute if the value is group. This set of attributes specifies a glossary group. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

name

The attribute value shall be a string. It shall be the human readable name of the glossary group.

text

The attribute value shall be a string. It shall state the requirement for the glossary group.

5.2.2.17. Glossary Term Item Type

This type refines the Glossary Item Type though the glossary-type attribute if the value is term. This set of attributes specifies a glossary term. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

term

The attribute value shall be a string. It shall be the glossary term.

text

The attribute value shall be a string. It shall be the definition of the glossary term.

5.2.2.18. Interface Item Type

This type refines the Root Item Type 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 Interface Domain Item Type items to specify interface domains, for example the API, C language, compiler, interfaces to the implementation, and the hardware. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

interface-type

The attribute value shall be a Name. It shall be the interface item type.

This type is refined by the following types:

5.2.2.19. Application Configuration Group Item Type

This type refines the Interface Item Type though the interface-type attribute if the value is appl-config-group. This set of attributes specifies an application configuration group. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

description

The attribute value shall be a string. It shall be the description of the application configuration group.

name

The attribute value shall be a string. It shall be human readable name of the application configuration group.

text

The attribute value shall be a Requirement Text. It shall state the requirement for the application configuration group.

5.2.2.20. Application Configuration Option Item Type

This type refines the Interface Item Type though the interface-type attribute if the value is appl-config-option. This set of attributes specifies an application configuration option. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

appl-config-option-type

The attribute value shall be a Name. It shall be the application configuration option type.

description

The attribute value shall be an Interface Description. The Application Configuration Value Option Item Type 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.

name

The attribute value shall be an Application Configuration Option Name.

notes

The attribute value shall be an Interface Notes.

text

The attribute value shall be a Requirement Text. It shall state the requirement for the application configuration option.

This type is refined by the following types:

5.2.2.21. Application Configuration Feature Enable Option Item Type

This type refines the Application Configuration Option Item Type though the appl-config-option-type attribute if the value is feature-enable. This set of attributes specifies an application configuration feature enable option.

5.2.2.22. Application Configuration Feature Option Item Type

This type refines the Application Configuration Option Item Type though the appl-config-option-type attribute if the value is feature. This set of attributes specifies an application configuration feature option. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

default

The attribute value shall be a string. It shall describe what happens if the configuration option is undefined.

5.2.2.23. Application Configuration Value Option Item Type

This type refines the following types:

This set of attributes specifies application configuration initializer or integer option. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

constraints

The attribute value shall be an Application Configuration Option Constraint Set.

default-value

The attribute value shall be an Integer or String. It shall shall describe the default value of the application configuration option.

5.2.2.24. Interface Compound Item Type

This type refines the following types:

This set of attributes specifies a compound (struct or union). All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

brief

The attribute value shall be an Interface Brief Description.

definition

The attribute value shall be a list. Each list element shall be an Interface Compound Member Definition Directive.

definition-kind

The attribute value shall be an Interface Compound Definition Kind.

description

The attribute value shall be an Interface Description.

name

The attribute value shall be a string. It shall be the name of the compound (struct or union).

notes

The attribute value shall be an Interface Notes.

5.2.2.25. Interface Container Item Type

This type refines the Interface Item Type 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 Interface Placement Link Role to an Interface Domain Item Type item. This link defines the interface domain of the container.

5.2.2.26. Interface Define Item Type

This type refines the Interface Item Type though the interface-type attribute if the value is define. This set of attributes specifies a define. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

brief

The attribute value shall be an Interface Brief Description.

definition

The attribute value shall be an Interface Definition Directive.

description

The attribute value shall be an Interface Description.

name

The attribute value shall be a string. It shall be the name of the define.

notes

The attribute value shall be an Interface Notes.

5.2.2.27. Interface Domain Item Type

This type refines the Interface Item Type though the interface-type attribute if the value is domain. This set of attributes specifies an interface domain. Items of the types Interface Container Item Type and Interface Header File Item Type are placed into domains through links with the Interface Placement Link Role. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

description

The attribute value shall be a string. It shall be the description of the domain

name

The attribute value shall be a string. It shall be the human readable name of the domain.

5.2.2.28. Interface Enum Item Type

This type refines the Interface Item Type though the interface-type attribute if the value is enum. This set of attributes specifies an enum. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

brief

The attribute value shall be an Interface Brief Description.

definition-kind

The attribute value shall be an Interface Enum Definition Kind.

description

The attribute value shall be an Interface Description.

name

The attribute value shall be a string. It shall be the name of the enum.

notes

The attribute value shall be an Interface Description.

5.2.2.29. Interface Enumerator Item Type

This type refines the Interface Item Type though the interface-type attribute if the value is enumerator. This set of attributes specifies an enumerator. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

brief

The attribute value shall be an Interface Brief Description.

definition

The attribute value shall be an Interface Definition Directive.

description

The attribute value shall be an Interface Description.

name

The attribute value shall be a string. It shall be the name of the enumerator.

notes

The attribute value shall be an Interface Notes.

5.2.2.30. Interface Forward Declaration Item Type

This type refines the Interface Item Type though 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 Interface Target Link Role to an Interface Compound Item Type item. This link defines the type declared by the forward declaration.

5.2.2.31. Interface Function Item Type

This type refines the Interface Item Type though the interface-type attribute if the value is function. This set of attributes specifies a function. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

brief

The attribute value shall be an Interface Brief Description.

definition

The attribute value shall be an Interface Function Definition Directive.

description

The attribute value shall be an Interface Description.

name

The attribute value shall be a string. It shall be the name of the function.

notes

The attribute value shall be an Interface Notes.

params

The attribute value shall be a list. Each list element shall be an Interface Parameter.

return

The attribute value shall be an Interface Return Directive.

5.2.2.32. Interface Group Item Type

This type refines the Interface Item Type though the interface-type attribute if the value is group. This set of attributes specifies an interface group. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

brief

The attribute value shall be an Interface Brief Description.

description

The attribute value shall be an Interface Description.

identifier

The attribute value shall be an Interface Group Identifier.

name

The attribute value shall be a string. It shall be the human readable name of the interface group.

5.2.2.33. Interface Header File Item Type

This type refines the Interface Item Type though 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 Interface Placement Link Role to an Interface Domain Item Type item. This link defines the interface domain of the header file. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

path

The attribute value shall be a string. It shall be the path used to include the header file. For example rtems/confdefs.h.

prefix

The attribute value shall be a string. It shall be the prefix directory path to the header file in the interface domain. For example cpukit/include.

5.2.2.34. Interface Macro Item Type

This type refines the Interface Item Type though the interface-type attribute if the value is macro. This set of attributes specifies a macro. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

brief

The attribute value shall be an Interface Brief Description.

definition

The attribute value shall be an Interface Definition Directive.

description

The attribute value shall be an Interface Description.

name

The attribute value shall be a string. It shall be the name of the macro.

notes

The attribute value shall be an Interface Notes.

params

The attribute value shall be a list. Each list element shall be an Interface Parameter.

return

The attribute value shall be an Interface Return Directive.

5.2.2.35. Interface Typedef Item Type

This type refines the Interface Item Type though the interface-type attribute if the value is typedef. This set of attributes specifies a typedef. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

brief

The attribute value shall be an Interface Brief Description.

definition

The attribute value shall be an Interface Definition Directive.

description

The attribute value shall be an Interface Description.

name

The attribute value shall be a string. It shall be the name of the typedef.

notes

The attribute value shall be an Interface Notes.

5.2.2.36. Interface Unspecified Item Type

This type refines the Interface Item Type though the interface-type attribute if the value is unspecified. This set of attributes specifies an unspecified interface. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

name

The attribute value shall be a string. It shall be the name of the unspecified interface.

5.2.2.37. Interface Variable Item Type

This type refines the Interface Item Type though the interface-type attribute if the value is variable. This set of attributes specifies a variable. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

brief

The attribute value shall be an Interface Brief Description.

definition

The attribute value shall be an Interface Definition Directive.

description

The attribute value shall be an Interface Description.

name

The attribute value shall be a string. It shall be the name of the variable.

notes

The attribute value shall be an Interface Notes.

5.2.2.38. Requirement Item Type

This type refines the Root Item Type though the type attribute if the value is requirement. This set of attributes specifies a requirement. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

rationale

The attribute value shall be an optional string. If the value is present, 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 Requirement Reference.

requirement-type

The attribute value shall be a Name. It shall be the requirement item type.

text

The attribute value shall be a Requirement Text. It shall state the requirement.

This type is refined by the following types:

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
enabled-by: true
functional-type: capability
links: []
rationale: |
  It keeps you busy.
requirement-type: functional
text: |
  The system shall do crazy things.
type: requirement

5.2.2.39. Functional Requirement Item Type

This type refines the Requirement Item Type though the requirement-type attribute if the value is functional. This set of attributes specifies a functional requirement. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

functional-type

The attribute value shall be a Requirement Functional Type. It shall be the functional type of the requirement.

5.2.2.40. Non-Functional Requirement Item Type

This type refines the Requirement Item Type though the requirement-type attribute if the value is non-functional. This set of attributes specifies a non-functional requirement. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

non-functional-type

The attribute value shall be a Requirement Non-Functional Type. It shall be the non-functional type of the requirement.

5.2.2.41. Requirement Validation Item Type

This type refines the Root Item Type 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 Requirement Validation Link Role. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

method

The attribute value shall be a Requirement Validation Method. Validation by test is done through Test Case Item Type items.

text

The attribute value shall be a string. It shall provide the validation evidence depending on the validation method:

  • By analysis: A statement shall be provided how the requirement is met, by analysing static properties of the software product.

  • By inspection: A statement shall be provided how the requirement is met, by inspection of the source code.

  • By review of design: A rationale shall be provided to demonstrate how the requirement is satisfied implicitly by the software design.

5.2.2.42. Specification Item Type

This type refines the Root Item Type though the type attribute if the value is spec. This set of attributes specifies specification types. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

spec-description

The attribute value shall be an optional string. It shall be the description of the specification type.

spec-example

The attribute value shall be an optional string. If this value is present, then tt shall be an example of the specification type.

spec-info

The attribute value shall be a Specification Information.

spec-name

The attribute value shall be an optional string. It shall be the human readable name of the specification type.

spec-type

The attribute value shall be a Name. It shall the specification type.

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)
enabled-by: true
links:
- role: spec-member
  uid: root
- role: spec-refinement
  spec-key: type
  spec-value: example
  uid: root
spec-description: null
spec-example: null
spec-info:
  dict:
    attributes:
      an-example-attribute:
        description: |
          It shall be an example.
        spec-type: optional-str
      example-number:
        description: |
          It shall be the example number.
        spec-type: int
    description: |
      This set of attributes specifies an example.
    required-attributes: all
spec-name: Example Item Type
spec-type: spec
type: spec

5.2.2.43. Test Case Item Type

This type refines the Root Item Type though the type attribute if the value is test-case. This set of attributes specifies a test case. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

actions

The attribute value shall be a list. Each list element shall be a Test Case Action.

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.

epilogue

The attribute value shall be an optional string. If the attribute 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.

fixture

The attribute value shall be an optional string. If the attribute 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.

includes

The attribute value shall be a list of strings. It shall be a list of header files included via #include <...>.

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 Test Name.

prologue

The attribute value shall be an optional string. If the attribute 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.

support

The attribute value shall be an optional string. If the attribute 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

The attribute value shall be a string. It shall be the path to the generated target test case source file.

5.2.2.44. Test Platform Item Type

This type refines the Root Item Type though the type attribute if the value is test-platform. Please note:

Warning

This item type is work in progress.

This set of attributes specifies a test platform. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

description

The attribute value shall be a string. It shall be the description of the test platform.

name

The attribute value shall be a string. It shall be the human readable name of the test platform.

5.2.2.45. Test Procedure Item Type

This type refines the Root Item Type though the type attribute if the value is test-procedure. Please note:

Warning

This item type is work in progress.

This set of attributes specifies a test procedure. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

name

The attribute value shall be a string. It shall be the human readable name of the test procedure.

purpose

The attribute value shall be a string. It shall state the purpose of the test procedure.

steps

The attribute value shall be a string. It shall describe the steps of the test procedure execution.

5.2.2.46. Test Suite Item Type

This type refines the Root Item Type though the type attribute if the value is test-suite. This set of attributes specifies a test suite. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

brief

The attribute value shall be a string. It shall be the test suite brief description.

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

The attribute value shall be an optional string. It shall be the test suite description.

includes

The attribute value shall be a list of strings. It shall be a list of header files included via #include <...>.

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 Test Name.

target

The attribute value shall be a string. It shall be the path to the generated target test suite source file.

5.2.3. Specification Attribute Sets and Value Types

5.2.3.2. 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 Constraint Link Role. None of the explicitly defined attributes are required. The following attributes are explicitly defined for this type:

max

The attribute value shall be an Integer or String. It shall be the maximum value of the application configuration option.

min

The attribute value shall be an Integer or String. 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 Integer or String. 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 Requirement Text. It shall be a list of constraints specific to this application configuration option. For general constraints, use a link with the Constraint Link Role to a constraint item.

This type is used by the following types:

5.2.3.3. 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_]+$".

This type is used by the following types:

5.2.3.4. Boolean or Integer or String

A value of this type shall be of one of the following variants:

  • The value may be a boolean.

  • The value may be an integer number.

  • The value may be a string.

This type is used by the following types:

5.2.3.5. Build Assembler Option

The value shall be a string. It shall be an option for the assembler. The options are used to assemble the sources of this item. The options defined by this attribute succeed the options presented to the item by the build item context.

This type is used by the following types:

5.2.3.6. Build C Compiler Option

The value shall be a string. It shall be an option for the C compiler. The options are used to compile the sources of this item. The options defined by this attribute succeed the options presented to the item by the build item context.

This type is used by the following types:

5.2.3.7. Build C Preprocessor Option

The value shall be a string. It shall be an option for the C preprocessor. The options are used to preprocess the sources of this item. The options defined by this attribute succeed the options presented to the item by the build item context.

This type is used by the following types:

5.2.3.8. Build C++ Compiler Option

The value shall be a string. It shall be an option for the C++ compiler. The options are used to compile the sources of this item. The options defined by this attribute succeed the options presented to the item by the build item context.

This type is used by the following types:

5.2.3.10. Build Include Path

The value shall be a string. It shall be a path to header files. The path is used by the C preprocessor to search for header files. It succeeds the includes presented to the item by the build item context. For an Build Group Item Type item the includes are visible to all items referenced by the group item. For Build BSP Item Type, Build Objects Item Type, Build Library Item Type, Build Start File Item Type, and Build Test Program Item Type items the includes are only visible to the sources specified by the item itself and they do not propagate to referenced items.

This type is used by the following types:

5.2.3.11. Build Install Directive

This set of attributes specifies files installed by a build item. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

destination

The attribute value shall be a string. It shall be the install destination directory.

source

The attribute value shall be a list of strings. It shall be the list of source files to be installed in the destination directory. The path to a source file shall be relative to the directory of the wscript.

This type is used by the following types:

5.2.3.12. Build Install Path

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 string. It shall be the installation path of a Build Target.

This type is used by the following types:

5.2.3.13. Build Linker Option

The value shall be a string. It shall be an option for the linker. The options are used to link executables. The options defined by this attribute succeed the options presented to the item by the build item context.

This type is used by the following types:

5.2.3.14. Build Option Action

This set of attributes specifies a build option action. Exactly one of the explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

append-test-cppflags

The attribute value shall be a string. It shall be the name of a test program. The action appends the action value to the CPPFLAGS of the test program. The name shall correspond to the name of a Build Test Program Item Type item. Due to the processing order of items, there is no way to check if the name specified by the attribute value is valid.

assert-aligned

The attribute value shall be an integer number. The action asserts that the action value is aligned according to the attribute value.

assert-eq

The attribute value shall be a Boolean or Integer or String. The action asserts that the action value is equal to the attribute value.

assert-ge

The attribute value shall be an Integer or String. The action asserts that the action value is greater than or equal to the attribute value.

assert-gt

The attribute value shall be an Integer or String. The action asserts that the action value is greater than the attribute value.

assert-int16

The attribute shall have no value. The action asserts that the action value is a valid signed 16-bit integer.

assert-int32

The attribute shall have no value. The action asserts that the action value is a valid signed 32-bit integer.

assert-int64

The attribute shall have no value. The action asserts that the action value is a valid signed 64-bit integer.

assert-int8

The attribute shall have no value. The action asserts that the action value is a valid signed 8-bit integer.

assert-le

The attribute value shall be an Integer or String. The action asserts that the action value is less than or equal to the attribute value.

assert-lt

The attribute value shall be an Integer or String. The action asserts that the action value is less than the attribute value.

assert-ne

The attribute value shall be a Boolean or Integer or String. The action asserts that the action value is not equal to the attribute value.

assert-power-of-two

The attribute shall have no value. The action asserts that the action value is a power of two.

assert-uint16

The attribute shall have no value. The action asserts that the action value is a valid unsigned 16-bit integer.

assert-uint32

The attribute shall have no value. The action asserts that the action value is a valid unsigned 32-bit integer.

assert-uint64

The attribute shall have no value. The action asserts that the action value is a valid unsigned 64-bit integer.

assert-uint8

The attribute shall have no value. The action asserts that the action value is a valid unsigned 8-bit integer.

check-cc

The attribute value shall be a Build Option C Compiler Check Action.

check-cxx

The attribute value shall be a Build Option C++ Compiler Check Action.

define

The attribute value shall be an optional string. The action adds a define to the configuration set. If the attribute value is present, then it is used as the name of the define, otherwise the name of the item is used. The value of the define is the action value. If the action value is a string, then it is quoted.

define-condition

The attribute value shall be an optional string. The action adds a conditional define to the configuration set. If the attribute value is present, then it is used as the name of the define, otherwise the name of the item is used. The value of the define is the action value.

define-unquoted

The attribute value shall be an optional string. The action adds a define to the configuration set. If the attribute value is present, then it is used as the name of the define, otherwise the name of the item is used. The value of the define is the action value. If the action value is a string, then it is not quoted.

env-append

The attribute value shall be an optional string. The action appends the action value to an environment of the configuration set. If the attribute value is present, then it is used as the name of the environment variable, otherwise the name of the item is used.

env-assign

The attribute value shall be an optional string. The action assigns the action value to an environment of the configuration set. If the attribute value is present, then it is used as the name of the environment variable, otherwise the name of the item is used.

env-enable

The attribute value shall be an optional string. If the action value is true, then a name is appended to the ENABLE environment variable of the configuration set. If the attribute value is present, then it is used as the name, otherwise the name of the item is used.

find-program

The attribute shall have no value. The action tries to find the program specified by the action value. Uses the ${PATH} to find the program. Returns the result of the find operation, e.g. a path to the program.

find-tool

The attribute shall have no value. The action tries to find the tool specified by the action value. Uses the tool paths specified by the --rtems-tools command line option. Returns the result of the find operation, e.g. a path to the program.

format-and-define

The attribute value shall be an optional string. The action adds a define to the configuration set. If the attribute value is present, then it is used as the name of the define, otherwise the name of the item is used. The value of the define is the action value. The value is formatted according to the format attribute value.

get-boolean

The attribute shall have no value. The action gets the action value for subsequent actions from a configuration file variable named by the items name attribute. If no such variable exists in the configuration file, then the default value is used. The value is converted to a boolean.

get-env

The attribute value shall be a string. The action gets the action value for subsequent actions from the environment variable of the configuration set named by the attribute value.

get-integer

The attribute shall have no value. The action gets the action value for subsequent actions from a configuration file variable named by the items name attribute. If no such variable exists in the configuration file, then the default value is used. The value is converted to an integer.

get-string

The attribute shall have no value. The action gets the action value for subsequent actions from a configuration file variable named by the items name attribute. If no such variable exists in the configuration file, then the default 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 action handler.

set-test-state

The attribute value shall be a Build Option Set Test State Action.

set-value

The attribute value shall be a Build Option Value. The action sets the action value for subsequent actions to the attribute value.

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} substitution on the action value. Use $$ for a plain $ character.

This type is used by the following types:

5.2.3.15. Build Option C Compiler Check Action

This set of attributes specifies a check done using the C compiler. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

cflags

The attribute value shall be a list. Each list element shall be a Build C Compiler Option.

fragment

The attribute value shall be a string. It shall be a code fragment used to check the availability of a certain feature through compilation with the C compiler. The resulting object is not linked to an executable.

message

The attribute value shall be a string. It shall be a description of the feature to check.

This type is used by the following types:

5.2.3.16. Build Option C++ Compiler Check Action

This set of attributes specifies a check done using the C++ compiler. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

cxxflags

The attribute value shall be a list. Each list element shall be a Build C++ Compiler Option.

fragment

The attribute value shall be a string. It shall be a code fragment used to check the availability of a certain feature through compilation with the C++ compiler. The resulting object is not linked to an executable.

message

The attribute value shall be a string. It shall be a description of the feature to check.

This type is used by the following types:

5.2.3.17. Build Option Default by Variant

This set of attributes specifies build option default values by variant. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

value

The attribute value shall be a Build Option Value. It value shall be the default value for the matching variants.

variants

The attribute value shall be a list of strings. It shall be a list of Python regular expression matching with the desired variants.

This type is used by the following types:

5.2.3.18. 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_]*$".

This type is used by the following types:

5.2.3.19. Build Option Set Test State Action

This set of attributes specifies test states for a set of test programs. Generic attributes may be defined. Each attribute key shall be a Name. The attribute value shall be a Build Test State. The keys shall be test program names. The names shall correspond to the name of a Build Test Program Item Type or Build Ada Test Program Item Type 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 type is used by the following types:

5.2.3.20. Build Option Value

A value of this type shall be of one of the following variants:

  • The value may be a boolean.

  • The value may be an integer number.

  • The value may be a list. Each list element shall be a string.

  • There may by be no value (null).

  • The value may be a string.

This type is used by the following types:

5.2.3.21. Build Source

The value shall be a string. It shall be a source file. The path to a source file shall be relative to the directory of the wscript.

This type is used by the following types:

5.2.3.22. Build Target

The value shall be a string. It shall be the target file path. The path to the target file shall be relative to the directory of the wscript. The target file is located in the build tree.

This type is used by the following types:

5.2.3.23. Build Test State

The value shall be a string. This string defines a test state. The value shall be an element of

  • benchmark”,

  • exclude”,

  • expected-fail”,

  • indeterminate”, and

  • user-input”.

This type is used by the following types:

5.2.3.24. 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.

This type is used by the following types:

5.2.3.25. 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.

This type is used by the following types:

5.2.3.28. Enabled-By Expression

A value of this type shall be an expression which defines under which conditions the specification item or parts of it are enabled. The expression is evaluated with the use of an enabled set. This is a set of strings which indicate enabled features.

A value of this type shall be of one of the following variants:

  • The value may be a boolean. This expression evaluates directly to the boolean value.

  • The value may be a set of attributes. Each attribute defines an operator. Exactly one of the explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

    and

    The attribute value shall be a list. Each list element shall be an Enabled-By Expression. 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 Enabled-By Expression. 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 Enabled-By Expression. The or operator evaluates to the logical or of the evaluation results of the expressions in the list.

  • The value may be a list. Each list element shall be an Enabled-By Expression. This list of expressions evaluates to the logical or of the evaluation results of the expressions in the list.

  • The value may be a string. If the value is in the enabled set, this expression evaluates to true, otherwise to false.

This type is used by the following types:

Please have a look at the following example:

enabled-by:
  and:
  - RTEMS_NETWORKING
  - not: RTEMS_SMP

5.2.3.30. Integer or String

A value of this type shall be of one of the following variants:

  • The value may be an integer number.

  • The value may be a string.

This type is used by the following types:

5.2.3.31. Interface Brief Description

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 string. It shall be the brief description of the interface.

This type is used by the following types:

5.2.3.32. Interface Compound Definition Kind

The value shall be a string. It specifies how the interface compound is defined. It may be a typedef only, the struct or union only, or a typedef with a struct or union definition. The value shall be an element of

  • struct-only”,

  • typedef-and-struct”,

  • typedef-and-union”,

  • typedef-only”, and

  • union-only”.

This type is used by the following types:

5.2.3.33. Interface Compound Member Compound

This type refines the following types:

This set of attributes specifies an interface compound member compound. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

definition

The attribute value shall be a list. Each list element shall be an Interface Compound Member Definition Directive.

5.2.3.34. Interface Compound Member Declaration

This type refines the Interface Compound Member Definition though the kind attribute if the value is member. This set of attributes specifies an interface compound member declaration. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

definition

The attribute value shall be a string. It shall be the interface compound member declaration. On the declaration a context-sensitive substitution of item variables is performed.

5.2.3.35. Interface Compound Member Definition

This set of attributes specifies an interface compound member definition. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

brief

The attribute value shall be an Interface Brief Description.

description

The attribute value shall be an Interface Description.

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.

This type is refined by the following types:

This type is used by the following types:

5.2.3.36. Interface Compound Member Definition Directive

This set of attributes specifies an interface compound member definition directive. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

default

The attribute value shall be an Interface Compound Member Definition. 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 Interface Compound Member Definition Variant.

This type is used by the following types:

5.2.3.37. Interface Compound Member Definition Variant

This set of attributes specifies an interface compound member definition variant. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

definition

The attribute value shall be an Interface Compound Member Definition. 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 Interface Enabled-By Expression.

This type is used by the following types:

5.2.3.38. Interface Definition

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 string. It shall be the definition. On the definition a context-sensitive substitution of item variables is performed.

This type is used by the following types:

5.2.3.39. Interface Definition Directive

This set of attributes specifies an interface definition directive. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

default

The attribute value shall be an Interface Definition. 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 Interface Definition Variant.

This type is used by the following types:

5.2.3.40. Interface Definition Variant

This set of attributes specifies an interface definition variant. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

definition

The attribute value shall be an Interface Definition. 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 Interface Enabled-By Expression.

This type is used by the following types:

5.2.3.41. Interface Description

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 string. It shall be the description of the interface. The description should be short and concentrate on the average case. All special cases, usage notes, constraints, error conditions, configuration dependencies, references, etc. should be described in the Interface Notes.

This type is used by the following types:

5.2.3.42. Interface Enabled-By Expression

A value of this type shall be an expression which defines under which conditions an interface definition is enabled. In generated header files, the expression is evaluated by the C preprocessor.

A value of this type shall be of one of the following variants:

  • The value may be a boolean. It is converted to 0 or 1. It defines a symbol in the expression.

  • The value may be a set of attributes. Each attribute defines an operator. Exactly one of the explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

    and

    The attribute value shall be a list. Each list element shall be an Interface Enabled-By Expression. The and operator defines a logical and of the expressions in the list.

    not

    The attribute value shall be an Interface Enabled-By Expression. The not operator defines a logical not of the expression.

    or

    The attribute value shall be a list. Each list element shall be an Interface Enabled-By Expression. The or operator defines a logical or of the expressions in the list.

  • The value may be a list. Each list element shall be an Interface Enabled-By Expression. It defines a logical or of the expressions in the list.

  • The value may be a string. It defines a symbol in the expression.

This type is used by the following types:

5.2.3.43. Interface Enum Definition Kind

The value shall be a string. It specifies how the enum is defined. It may be a typedef only, the enum only, or a typedef with an enum definition. The value shall be an element of

  • enum-only”,

  • typedef-and-enum”, and

  • typedef-only”.

This type is used by the following types:

5.2.3.45. Interface Function Definition

This set of attributes specifies a function definition. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

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 a string. It shall be the function return type. On the return type a context-sensitive substitution of item variables is performed.

This type is used by the following types:

5.2.3.46. Interface Function Definition Directive

This set of attributes specifies a function definition directive. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

default

The attribute value shall be an Interface Function Definition. 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 Interface Function Definition Variant.

This type is used by the following types:

5.2.3.47. Interface Function Definition Variant

This set of attributes specifies a function definition variant. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

definition

The attribute value shall be an Interface Function Definition. 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 Interface Enabled-By Expression.

This type is used by the following types:

5.2.3.48. 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]*$".

This type is used by the following types:

5.2.3.51. Interface Notes

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 string. It shall be the notes for the interface.

This type is used by the following types:

5.2.3.52. Interface Parameter

This set of attributes specifies an interface parameter. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

description

The attribute value shall be an Interface Description.

dir

The attribute value shall be an Interface Parameter Direction.

name

The attribute value shall be a string. It shall be the interface parameter name.

This type is used by the following types:

5.2.3.53. Interface Parameter Direction

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 string. It specifies the interface parameter direction. The value shall be an element of

    • in”,

    • out”, and

    • inout”.

This type is used by the following types:

5.2.3.55. Interface Return Directive

This set of attributes specifies an interface return. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

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 Interface Return Value.

This type is used by the following types:

5.2.3.56. Interface Return Value

This set of attributes specifies an interface return value. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

description

The attribute value shall be an Interface Description.

value

The attribute value shall be a Boolean or Integer or String. It shall be the described interface return value.

This type is used by the following types:

5.2.3.59. Name

The value shall be a string. A string is a valid name if it matches with the ^([a-z][a-z0-9-]*|SPDX-License-Identifier)$ regular expression.

This type is used by the following types:

5.2.3.60. Optional String

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 string.

5.2.3.61. Requirement Functional Type

The value shall be a string. This type shall be used for functional requirement types. The value shall be an element of

  • capability”,

  • dependability-function”,

  • function”,

  • operational”, and

  • safety-function”.

This type is used by the following types:

5.2.3.62. Requirement Non-Functional Type

The value shall be a string. This type shall be used for non-functional requirement types. The value shall be an element of

  • build-configuration”,

  • constraint”,

  • design”,

  • documentation”,

  • interface”,

  • interface-requirement”,

  • maintainability”,

  • performance”,

  • portability”,

  • quality”,

  • reliability”,

  • resource”, and

  • safety”.

This type is used by the following types:

5.2.3.63. Requirement Reference

This set of attributes specifies a requirement reference. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

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.

type

The attribute value shall be a Requirement Reference Type.

This type is used by the following types:

5.2.3.64. Requirement Reference Type

The value shall be a string. It specifies the type of a requirement reference. The value shall be an element of

  • define”,

  • file”,

  • function”,

  • group”,

  • macro”, and

  • variable”.

This type is used by the following types:

5.2.3.66. Requirement Text

The value shall be a string. It shall state a requirement or constraint. The value shall not contain an element of

  • acceptable”,

  • adequate”,

  • almost always”,

  • and/or”,

  • appropriate”,

  • approximately”,

  • as far as possible”,

  • as much as practicable”,

  • best”,

  • best possible”,

  • easy”,

  • efficient”,

  • e.g.”,

  • enable”,

  • enough”,

  • etc.”,

  • few”,

  • first rate”,

  • flexible”,

  • generally”,

  • goal”,

  • graceful”,

  • great”,

  • greatest”,

  • ideally”,

  • i.e.”,

  • if possible”,

  • in most cases”,

  • large”,

  • many”,

  • maximize”,

  • minimize”,

  • most”,

  • multiple”,

  • necessary”,

  • numerous”,

  • optimize”,

  • ought to”,

  • probably”,

  • quick”,

  • rapid”,

  • reasonably”,

  • relevant”,

  • robust”,

  • satisfactory”,

  • several”,

  • shall be included but not limited to”,

  • simple”,

  • small”,

  • some”,

  • state of the art”,

  • sufficient”,

  • suitable”,

  • support”,

  • systematically”,

  • transparent”,

  • typical”,

  • user friendly”,

  • usually”,

  • versatile”, and

  • when necessary”.

This type is used by the following types:

5.2.3.68. Requirement Validation Method

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

  • by-analysis”,

  • by-inspection”, and

  • by-review-of-design”.

This type is used by the following types:

5.2.3.69. SPDX License Identifier

The value shall be a string. It defines the license of the item expressed though an SPDX License Identifier. The value

  • shall be equal to “CC-BY-SA-4.0 OR BSD-2-Clause”,

  • or, shall be equal to “BSD-2-Clause”,

  • or, shall be equal to “CC-BY-SA-4.0”.

This type is used by the following types:

5.2.3.70. Specification Attribute

Generic attributes may be defined. Each attribute key shall be a Name. The attribute value shall be a Specification Attribute Value. The generic attributes specify an attribute set.

This type is used by the following types:

5.2.3.71. Specification Attribute Set

This set of attributes specifies a set of attributes. The following explicitly defined attributes are required:

  • attributes

  • description

  • required-attributes

The following attributes are explicitly defined for this type:

attributes

The attribute value shall be a Specification Attribute. It shall be the specification of the set of explicitly defined attributes.

description

The attribute value shall be an optional string. It shall be the description of the attribute set.

generic-attributes

The attribute value shall be a Specification Generic Attributes. It shall be the specification of the generic attributes of the attribute set.

required-attributes

The attribute value shall be a Specification Required Attributes. It shall be the set of required attributes of the attribute set.

This type is used by the following types:

5.2.3.72. Specification Attribute Value

This set of attributes specifies an attribute value. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

description

The attribute value shall be an optional string. It shall be the description of the attribute value.

spec-type

The attribute value shall be a Name. It shall be the specification type of the attribute value.

This type is used by the following types:

5.2.3.73. Specification Boolean Value

This attribute set specifies a boolean value. Only the description attribute is required. The following attributes are explicitly defined for this type:

assert

The attribute value shall be a boolean. This optional attribute defines the value constraint of the specified boolean value. If the value of the assert attribute is true, then the value of the specified boolean value shall be true. If the value of the assert attribute is false, then the value of the specified boolean value shall be false. In case the assert attribute is not present, then the value of the specified boolean value may be true or false.

description

The attribute value shall be an optional string. It shall be the description of the specified boolean value.

This type is used by the following types:

5.2.3.74. Specification Floating-Point Assert

A value of this type shall be an expression which asserts that the floating-point value of the specified attribute satisfies the required constraints.

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 explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

    and

    The attribute value shall be a list. Each list element shall be a Specification Floating-Point Assert. The and operator evaluates to the logical and of the evaluation results of the expressions in the list.

    eq

    The attribute value shall be a floating-point number. The eq operator evaluates to true, if the value to check is equal to the value of this attribute, otherwise to false.

    ge

    The attribute value shall be a floating-point number. The ge operator evaluates to true, if the value to check is greater than or equal to the value of this attribute, otherwise to false.

    gt

    The attribute value shall be a floating-point number. The gt operator evaluates to true, if the value to check is greater than the value of this attribute, otherwise to false.

    le

    The attribute value shall be a floating-point number. The le operator evaluates to true, if the value to check is less than or equal to the value of this attribute, otherwise to false.

    lt

    The attribute value shall be a floating-point number. The lt operator evaluates to true, if the value to check is less than the value of this attribute, otherwise to false.

    ne

    The attribute value shall be a floating-point number. The ne operator evaluates to true, if the value to check is not equal to the value of this attribute, otherwise to false.

    not

    The attribute value shall be a Specification Floating-Point Assert. 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 a Specification Floating-Point Assert. The or operator evaluates to the logical or of the evaluation results of the expressions in the list.

  • The value may be a list. Each list element shall be a Specification Floating-Point Assert. 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:

5.2.3.75. Specification Floating-Point Value

This set of attributes specifies a floating-point value. Only the description attribute is required. The following attributes are explicitly defined for this type:

assert

The attribute value shall be a Specification Floating-Point Assert. This optional attribute defines the value constraints of the specified floating-point value. In case the assert attribute is not present, then the value of the specified floating-point value may be every valid floating-point number.

description

The attribute value shall be an optional string. It shall be the description of the specified floating-point value.

This type is used by the following types:

5.2.3.76. Specification Generic Attributes

This set of attributes specifies generic attributes. Generic attributes are attributes which are not explicitly defined. They are restricted to a uniform attribute value type. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

description

The attribute value shall be an optional string. It shall be the description of the generic attributes.

spec-type

The attribute value shall be a Name. It shall be the specification type of the generic attribute values.

This type is used by the following types:

5.2.3.77. Specification Information

This set of attributes specifies attribute values. At least one of the explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

bool

The attribute value shall be a Specification Boolean Value. It shall specify a boolean value.

dict

The attribute value shall be a Specification Attribute Set. It shall specify a set of attributes.

float

The attribute value shall be a Specification Floating-Point Value. It shall specify a floating-point value.

int

The attribute value shall be a Specification Integer Value. It shall specify an integer value.

list

The attribute value shall be a Specification List. It shall specify a list of attributes or values.

none

The attribute shall have no value. It specifies that no value is required.

str

The attribute value shall be a Specification String Value. It shall specify a string.

This type is used by the following types:

5.2.3.78. Specification Integer Assert

A value of this type shall be an expression which asserts that the integer value of the specified attribute satisfies the required constraints.

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 explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

    and

    The attribute value shall be a list. Each list element shall be a Specification Integer Assert. The and operator evaluates to the logical and of the evaluation results of the expressions in the list.

    eq

    The attribute value shall be an integer number. The eq operator evaluates to true, if the value to check is equal to the value of this attribute, otherwise to false.

    ge

    The attribute value shall be an integer number. The ge operator evaluates to true, if the value to check is greater than or equal to the value of this attribute, otherwise to false.

    gt

    The attribute value shall be an integer number. The gt operator evaluates to true, if the value to check is greater than the value of this attribute, otherwise to false.

    le

    The attribute value shall be an integer number. The le operator evaluates to true, if the value to check is less than or equal to the value of this attribute, otherwise to false.

    lt

    The attribute value shall be an integer number. The lt operator evaluates to true, if the value to check is less than the value of this attribute, otherwise to false.

    ne

    The attribute value shall be an integer number. The ne operator evaluates to true, if the value to check is not equal to the value of this attribute, otherwise to false.

    not

    The attribute value shall be a Specification Integer Assert. 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 a Specification Integer Assert. The or operator evaluates to the logical or of the evaluation results of the expressions in the list.

  • The value may be a list. Each list element shall be a Specification Integer Assert. 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:

5.2.3.79. Specification Integer Value

This set of attributes specifies an integer value. Only the description attribute is required. The following attributes are explicitly defined for this type:

assert

The attribute value shall be a Specification Integer Assert. This optional attribute defines the value constraints of the specified integer value. In case the assert attribute is not present, then the value of the specified integer value may be every valid integer number.

description

The attribute value shall be an optional string. It shall be the description of the specified integer value.

This type is used by the following types:

5.2.3.80. Specification List

This set of attributes specifies a list of attributes or values. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

description

The attribute value shall be an optional string. It shall be the description of the list.

spec-type

The attribute value shall be a Name. It shall be the specification type of elements of the list.

This type is used by the following types:

5.2.3.83. Specification Required Attributes

This attribute value defines which of the explicitly defined attributes are required.

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 Name. This list defines the required attributes through their keys.

  • The value may be a string. This string defines the how many explicitly defined attributes are required. The value shall be an element of

    • all”,

    • at-least-one”,

    • at-most-one”,

    • exactly-one”, and

    • none”.

This type is used by the following types:

5.2.3.84. Specification String Assert

A value of this type shall be an expression which asserts that the string of the specified attribute satisfies the required constraints.

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 explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

    and

    The attribute value shall be a list. Each list element shall be a Specification String Assert. The and operator evaluates to the logical and of the evaluation results of the expressions in the list.

    contains

    The attribute value shall be a list of strings. The contains operator evaluates to true, if the string to check converted to lower case with all white space characters converted to a single space character contains a string of the list of strings of this attribute, otherwise to false.

    eq

    The attribute value shall be a string. The eq operator evaluates to true, if the string to check is equal to the value of this attribute, otherwise to false.

    ge

    The attribute value shall be a string. The ge operator evaluates to true, if the string to check is greater than or equal to the value of this attribute, otherwise to false.

    gt

    The attribute value shall be a string. The gt operator evaluates to true, if the string to check is greater than the value of this attribute, otherwise to false.

    in

    The attribute value shall be a list of strings. The in operator evaluates to true, if the string to check is contained in the list of strings of this attribute, otherwise to false.

    le

    The attribute value shall be a string. The le operator evaluates to true, if the string to check is less than or equal to the value of this attribute, otherwise to false.

    lt

    The attribute value shall be a string. The lt operator evaluates to true, if the string to check is less than the value of this attribute, otherwise to false.

    ne

    The attribute value shall be a string. The ne operator evaluates to true, if the string to check is not equal to the value of this attribute, otherwise to false.

    not

    The attribute value shall be a Specification String Assert. 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 a Specification String Assert. The or operator evaluates to the logical or of the evaluation results of the expressions in the list.

    re

    The attribute value shall be a string. The re operator evaluates to true, if the string to check matches with the regular expression of this attribute, otherwise to false.

    uid

    The attribute shall have no value. The uid operator evaluates to true, if the string is a valid UID, otherwise to false.

  • The value may be a list. Each list element shall be a Specification String Assert. 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:

5.2.3.85. Specification String Value

This set of attributes specifies a string. Only the description attribute is required. The following attributes are explicitly defined for this type:

assert

The attribute value shall be a Specification String Assert. This optional attribute defines the constraints of the specified string. In case the assert attribute is not present, then the specified string may be every valid string.

description

The attribute value shall be an optional string. It shall be the description of the specified string attribute.

This type is used by the following types:

5.2.3.86. Test Case Action

This set of attributes specifies a test case action. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

action

The attribute value shall be a string. It shall be the test case action code.

checks

The attribute value shall be a list. Each list element shall be a Test Case Check.

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 Link.

This type is used by the following types:

5.2.3.87. Test Case Check

This set of attributes specifies a test case check. All explicitly defined attributes shall be specified. The following attributes are explicitly defined for this type:

check

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 Link.

This type is used by the following types:

5.2.3.88. Test Name

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 _]+$".

This type is used by the following types:

5.2.3.89. UID

The value shall be a string. The string shall be a valid absolute or relative item UID.

This type is used by the following types: