diff options
Diffstat (limited to 'spec/rtems/attr/if')
24 files changed, 495 insertions, 0 deletions
diff --git a/spec/rtems/attr/if/application-task.yml b/spec/rtems/attr/if/application-task.yml new file mode 100644 index 00000000..b33293e2 --- /dev/null +++ b/spec/rtems/attr/if/application-task.yml @@ -0,0 +1,21 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This attribute constant indicates that the task was created by the + application using normal Classic API methods. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_APPLICATION_TASK +notes: null +type: interface diff --git a/spec/rtems/attr/if/attribute.yml b/spec/rtems/attr/if/attribute.yml new file mode 100644 index 00000000..18054d55 --- /dev/null +++ b/spec/rtems/attr/if/attribute.yml @@ -0,0 +1,21 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This type is used to represent Classic API attributes. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: ${/c/if/uint32_t:/name} ${.:/name} + variants: [] +description: null +enabled-by: true +interface-type: typedef +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_attribute +notes: | + Attributes are primarily used when creating objects. +type: interface diff --git a/spec/rtems/attr/if/barrier-automatic-release.yml b/spec/rtems/attr/if/barrier-automatic-release.yml new file mode 100644 index 00000000..f60760d0 --- /dev/null +++ b/spec/rtems/attr/if/barrier-automatic-release.yml @@ -0,0 +1,21 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This attribute constant indicates that the Classic API Barrier instance + created will use an automatic release protocol. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000200' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_BARRIER_AUTOMATIC_RELEASE +notes: null +type: interface diff --git a/spec/rtems/attr/if/barrier-manual-release.yml b/spec/rtems/attr/if/barrier-manual-release.yml new file mode 100644 index 00000000..27c3d02b --- /dev/null +++ b/spec/rtems/attr/if/barrier-manual-release.yml @@ -0,0 +1,21 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This attribute constant indicates that the Classic API Barrier instance + created will use the manual release protocol. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_BARRIER_MANUAL_RELEASE +notes: null +type: interface diff --git a/spec/rtems/attr/if/binary-semaphore.yml b/spec/rtems/attr/if/binary-semaphore.yml new file mode 100644 index 00000000..f994060e --- /dev/null +++ b/spec/rtems/attr/if/binary-semaphore.yml @@ -0,0 +1,21 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This attribute constant indicates that the Classic API Semaphore instance + created will be a proper binary semaphore or mutex. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000010' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_BINARY_SEMAPHORE +notes: null +type: interface diff --git a/spec/rtems/attr/if/counting-semaphore.yml b/spec/rtems/attr/if/counting-semaphore.yml new file mode 100644 index 00000000..9d7c69ad --- /dev/null +++ b/spec/rtems/attr/if/counting-semaphore.yml @@ -0,0 +1,21 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This attribute constant indicates that the Classic API Semaphore instance + created will be a counting semaphore. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_COUNTING_SEMAPHORE +notes: null +type: interface diff --git a/spec/rtems/attr/if/default.yml b/spec/rtems/attr/if/default.yml new file mode 100644 index 00000000..1c4985fa --- /dev/null +++ b/spec/rtems/attr/if/default.yml @@ -0,0 +1,20 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This is the default value for an attribute set. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_DEFAULT_ATTRIBUTES +notes: null +type: interface diff --git a/spec/rtems/attr/if/fifo.yml b/spec/rtems/attr/if/fifo.yml new file mode 100644 index 00000000..4df3d6e7 --- /dev/null +++ b/spec/rtems/attr/if/fifo.yml @@ -0,0 +1,21 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This is the attribute constant which reflects that blocking tasks will be + managed using FIFO discipline. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_FIFO +notes: null +type: interface diff --git a/spec/rtems/attr/if/floating-point.yml b/spec/rtems/attr/if/floating-point.yml new file mode 100644 index 00000000..40b8ea94 --- /dev/null +++ b/spec/rtems/attr/if/floating-point.yml @@ -0,0 +1,23 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This attribute constant indicates that the task will use the floating point + hardware. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000001' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_FLOATING_POINT +notes: | + On some architectures, there will be a floating point context associated with + this task. +type: interface diff --git a/spec/rtems/attr/if/global.yml b/spec/rtems/attr/if/global.yml new file mode 100644 index 00000000..a88b886c --- /dev/null +++ b/spec/rtems/attr/if/global.yml @@ -0,0 +1,20 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This is the attribute constant to indicate global resource. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000002' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_GLOBAL +notes: null +type: interface diff --git a/spec/rtems/attr/if/group.yml b/spec/rtems/attr/if/group.yml new file mode 100644 index 00000000..d28fd5d4 --- /dev/null +++ b/spec/rtems/attr/if/group.yml @@ -0,0 +1,18 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This group contains the Classic API directive attributes. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +description: null +enabled-by: true +identifier: RTEMSAPIClassicAttr +interface-type: group +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: ../../if/group +name: Directive Attributes +text: | + The Classic API shall provide an interface to directive attributes. +type: interface diff --git a/spec/rtems/attr/if/header.yml b/spec/rtems/attr/if/header.yml new file mode 100644 index 00000000..ae4340e8 --- /dev/null +++ b/spec/rtems/attr/if/header.yml @@ -0,0 +1,12 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: This header file defines attributes provided by the API. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +enabled-by: true +interface-type: header-file +links: +- role: interface-placement + uid: /if/domain +path: rtems/rtems/attr.h +prefix: cpukit/include +type: interface diff --git a/spec/rtems/attr/if/inherit-priority.yml b/spec/rtems/attr/if/inherit-priority.yml new file mode 100644 index 00000000..161472d2 --- /dev/null +++ b/spec/rtems/attr/if/inherit-priority.yml @@ -0,0 +1,22 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This attribute constant indicates that the Classic API Semaphore instance + created will use the Priority Inheritance Protocol. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000040' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_INHERIT_PRIORITY +notes: | + The semaphore instance must be a binary semaphore. +type: interface diff --git a/spec/rtems/attr/if/local.yml b/spec/rtems/attr/if/local.yml new file mode 100644 index 00000000..9147f3cf --- /dev/null +++ b/spec/rtems/attr/if/local.yml @@ -0,0 +1,20 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This is the attribute constant to indicate local resource. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_LOCAL +notes: null +type: interface diff --git a/spec/rtems/attr/if/multiprocessor-resource-sharing.yml b/spec/rtems/attr/if/multiprocessor-resource-sharing.yml new file mode 100644 index 00000000..3cb4c0c6 --- /dev/null +++ b/spec/rtems/attr/if/multiprocessor-resource-sharing.yml @@ -0,0 +1,21 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This attribute constant indicates that the Classic API Semaphore instance + created will use the Multiprocessor Resource Sharing Protocol. +copyrights: +- Copyright (C) 2014, 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: '0x00000100' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_MULTIPROCESSOR_RESOURCE_SHARING +notes: | + The semaphore instance must be a binary semaphore. +type: interface diff --git a/spec/rtems/attr/if/no-floating-point.yml b/spec/rtems/attr/if/no-floating-point.yml new file mode 100644 index 00000000..0d97cab4 --- /dev/null +++ b/spec/rtems/attr/if/no-floating-point.yml @@ -0,0 +1,23 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This attribute constant indicates that the task will not use the floating + point hardware. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_NO_FLOATING_POINT +notes: | + If the architecture permits it, then the FPU will be disabled when the task + is executing. +type: interface diff --git a/spec/rtems/attr/if/no-inherit-priority.yml b/spec/rtems/attr/if/no-inherit-priority.yml new file mode 100644 index 00000000..c3d8656f --- /dev/null +++ b/spec/rtems/attr/if/no-inherit-priority.yml @@ -0,0 +1,21 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This attribute constant indicates that the Classic API Semaphore instance + created will not use the Priority Inheritance Protocol. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_NO_INHERIT_PRIORITY +notes: null +type: interface diff --git a/spec/rtems/attr/if/no-multiprocessor-resource-sharing.yml b/spec/rtems/attr/if/no-multiprocessor-resource-sharing.yml new file mode 100644 index 00000000..050627d5 --- /dev/null +++ b/spec/rtems/attr/if/no-multiprocessor-resource-sharing.yml @@ -0,0 +1,21 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This attribute constant indicates that the Classic API Semaphore instance + created will not use the Multiprocessor Resource Sharing Protocol. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_NO_MULTIPROCESSOR_RESOURCE_SHARING +notes: null +type: interface diff --git a/spec/rtems/attr/if/no-priority-ceiling.yml b/spec/rtems/attr/if/no-priority-ceiling.yml new file mode 100644 index 00000000..ee71f3f3 --- /dev/null +++ b/spec/rtems/attr/if/no-priority-ceiling.yml @@ -0,0 +1,21 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This attribute constant indicates that the Classic API Semaphore instance + created will not use the Priority Ceiling Protocol. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_NO_PRIORITY_CEILING +notes: null +type: interface diff --git a/spec/rtems/attr/if/priority-ceiling.yml b/spec/rtems/attr/if/priority-ceiling.yml new file mode 100644 index 00000000..c5e8ba7b --- /dev/null +++ b/spec/rtems/attr/if/priority-ceiling.yml @@ -0,0 +1,22 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This attribute constant indicates that the Classic API Semaphore instance + created will use the Priority Ceiling Protocol. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000080' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_PRIORITY_CEILING +notes: | + The semaphore instance must be a binary semaphore. +type: interface diff --git a/spec/rtems/attr/if/priority.yml b/spec/rtems/attr/if/priority.yml new file mode 100644 index 00000000..363b548c --- /dev/null +++ b/spec/rtems/attr/if/priority.yml @@ -0,0 +1,21 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This is the attribute constant which reflects that blocking tasks will be + managed using task priority discipline. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000004' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_PRIORITY +notes: null +type: interface diff --git a/spec/rtems/attr/if/semaphore-class.yml b/spec/rtems/attr/if/semaphore-class.yml new file mode 100644 index 00000000..d719886b --- /dev/null +++ b/spec/rtems/attr/if/semaphore-class.yml @@ -0,0 +1,21 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This is the mask for the attribute bits associated with the Classic API + Semaphore Manager. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000030' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_SEMAPHORE_CLASS +notes: null +type: interface diff --git a/spec/rtems/attr/if/simple-binary-semaphore.yml b/spec/rtems/attr/if/simple-binary-semaphore.yml new file mode 100644 index 00000000..4853914e --- /dev/null +++ b/spec/rtems/attr/if/simple-binary-semaphore.yml @@ -0,0 +1,21 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This attribute constant indicates that the Classic API Semaphore instance + created will be a simple binary semaphore. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00000020' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_SIMPLE_BINARY_SEMAPHORE +notes: null +type: interface diff --git a/spec/rtems/attr/if/system-task.yml b/spec/rtems/attr/if/system-task.yml new file mode 100644 index 00000000..f3e775ca --- /dev/null +++ b/spec/rtems/attr/if/system-task.yml @@ -0,0 +1,21 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This attribute constant indicates that the task was created by RTEMS as a + support task. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 2008 On-Line Applications Research Corporation (OAR) +definition: + default: '0x00008000' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_SYSTEM_TASK +notes: null +type: interface |