diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-06-05 14:19:45 +0200 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-07-03 10:22:45 +0200 |
commit | 54e2231a9274bf15faa99261ad0d4878fb90f7c8 (patch) | |
tree | f316206a19bb38ba2f3d56eb5282995544c0b9ae /spec/if/rtems | |
parent | 94f668f1fc0335e3482cd8264c60901056d2a80f (diff) |
spec: Add /if/rtems/attr/*
Diffstat (limited to 'spec/if/rtems')
23 files changed, 476 insertions, 0 deletions
diff --git a/spec/if/rtems/attr/application-task.yml b/spec/if/rtems/attr/application-task.yml new file mode 100644 index 00000000..314585b9 --- /dev/null +++ b/spec/if/rtems/attr/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: /groups/api/classic/attr +name: RTEMS_APPLICATION_TASK +notes: null +type: interface diff --git a/spec/if/rtems/attr/attribute.yml b/spec/if/rtems/attr/attribute.yml new file mode 100644 index 00000000..66ac460c --- /dev/null +++ b/spec/if/rtems/attr/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: ${/if/c/uint32_t:/name} ${.:/name} + variants: [] +description: null +enabled-by: true +interface-type: typedef +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/classic/attr +name: rtems_attribute +notes: | + Attributes are primarily used when creating objects. +type: interface diff --git a/spec/if/rtems/attr/barrier-automatic-release.yml b/spec/if/rtems/attr/barrier-automatic-release.yml new file mode 100644 index 00000000..7bd4437a --- /dev/null +++ b/spec/if/rtems/attr/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: '0x00000010' + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/classic/attr +name: RTEMS_BARRIER_AUTOMATIC_RELEASE +notes: null +type: interface diff --git a/spec/if/rtems/attr/barrier-manual-release.yml b/spec/if/rtems/attr/barrier-manual-release.yml new file mode 100644 index 00000000..ddd6ec76 --- /dev/null +++ b/spec/if/rtems/attr/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: /groups/api/classic/attr +name: RTEMS_BARRIER_MANUAL_RELEASE +notes: null +type: interface diff --git a/spec/if/rtems/attr/binary-semaphore.yml b/spec/if/rtems/attr/binary-semaphore.yml new file mode 100644 index 00000000..6ef08053 --- /dev/null +++ b/spec/if/rtems/attr/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: /groups/api/classic/attr +name: RTEMS_BINARY_SEMAPHORE +notes: null +type: interface diff --git a/spec/if/rtems/attr/counting-semaphore.yml b/spec/if/rtems/attr/counting-semaphore.yml new file mode 100644 index 00000000..b8556b83 --- /dev/null +++ b/spec/if/rtems/attr/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: /groups/api/classic/attr +name: RTEMS_COUNTING_SEMAPHORE +notes: null +type: interface diff --git a/spec/if/rtems/attr/default-attributes.yml b/spec/if/rtems/attr/default-attributes.yml new file mode 100644 index 00000000..85755790 --- /dev/null +++ b/spec/if/rtems/attr/default-attributes.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: /groups/api/classic/attr +name: RTEMS_DEFAULT_ATTRIBUTES +notes: null +type: interface diff --git a/spec/if/rtems/attr/fifo.yml b/spec/if/rtems/attr/fifo.yml new file mode 100644 index 00000000..e9a66ab8 --- /dev/null +++ b/spec/if/rtems/attr/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: /groups/api/classic/attr +name: RTEMS_FIFO +notes: null +type: interface diff --git a/spec/if/rtems/attr/floating-point.yml b/spec/if/rtems/attr/floating-point.yml new file mode 100644 index 00000000..0a862bc7 --- /dev/null +++ b/spec/if/rtems/attr/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: /groups/api/classic/attr +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/if/rtems/attr/global.yml b/spec/if/rtems/attr/global.yml new file mode 100644 index 00000000..efafb2da --- /dev/null +++ b/spec/if/rtems/attr/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: /groups/api/classic/attr +name: RTEMS_GLOBAL +notes: null +type: interface diff --git a/spec/if/rtems/attr/header.yml b/spec/if/rtems/attr/header.yml new file mode 100644 index 00000000..06680c9f --- /dev/null +++ b/spec/if/rtems/attr/header.yml @@ -0,0 +1,11 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +enabled-by: true +interface-type: header-file +links: +- role: interface-placement + uid: /if/domains/api +path: rtems/rtems/attr.h +prefix: cpukit/include +type: interface diff --git a/spec/if/rtems/attr/inherit-priority.yml b/spec/if/rtems/attr/inherit-priority.yml new file mode 100644 index 00000000..143aa0b8 --- /dev/null +++ b/spec/if/rtems/attr/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: /groups/api/classic/attr +name: RTEMS_INHERIT_PRIORITY +notes: | + The semaphore instance must be a binary semaphore. +type: interface diff --git a/spec/if/rtems/attr/local.yml b/spec/if/rtems/attr/local.yml new file mode 100644 index 00000000..810bf7dc --- /dev/null +++ b/spec/if/rtems/attr/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: /groups/api/classic/attr +name: RTEMS_LOCAL +notes: null +type: interface diff --git a/spec/if/rtems/attr/multiprocessor-resource-sharing.yml b/spec/if/rtems/attr/multiprocessor-resource-sharing.yml new file mode 100644 index 00000000..fc478c70 --- /dev/null +++ b/spec/if/rtems/attr/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: /groups/api/classic/attr +name: RTEMS_MULTIPROCESSOR_RESOURCE_SHARING +notes: | + The semaphore instance must be a binary semaphore. +type: interface diff --git a/spec/if/rtems/attr/no-floating-point.yml b/spec/if/rtems/attr/no-floating-point.yml new file mode 100644 index 00000000..7e0585a0 --- /dev/null +++ b/spec/if/rtems/attr/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: /groups/api/classic/attr +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/if/rtems/attr/no-inherit-priority.yml b/spec/if/rtems/attr/no-inherit-priority.yml new file mode 100644 index 00000000..bf749463 --- /dev/null +++ b/spec/if/rtems/attr/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: /groups/api/classic/attr +name: RTEMS_NO_INHERIT_PRIORITY +notes: null +type: interface diff --git a/spec/if/rtems/attr/no-multiprocessor-resource-sharing.yml b/spec/if/rtems/attr/no-multiprocessor-resource-sharing.yml new file mode 100644 index 00000000..6c3d0c28 --- /dev/null +++ b/spec/if/rtems/attr/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: /groups/api/classic/attr +name: RTEMS_NO_MULTIPROCESSOR_RESOURCE_SHARING +notes: null +type: interface diff --git a/spec/if/rtems/attr/no-priority-ceiling.yml b/spec/if/rtems/attr/no-priority-ceiling.yml new file mode 100644 index 00000000..d9765a35 --- /dev/null +++ b/spec/if/rtems/attr/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: /groups/api/classic/attr +name: RTEMS_NO_PRIORITY_CEILING +notes: null +type: interface diff --git a/spec/if/rtems/attr/priority-ceiling.yml b/spec/if/rtems/attr/priority-ceiling.yml new file mode 100644 index 00000000..a6d94d12 --- /dev/null +++ b/spec/if/rtems/attr/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: /groups/api/classic/attr +name: RTEMS_PRIORITY_CEILING +notes: | + The semaphore instance must be a binary semaphore. +type: interface diff --git a/spec/if/rtems/attr/priority.yml b/spec/if/rtems/attr/priority.yml new file mode 100644 index 00000000..5c950d9f --- /dev/null +++ b/spec/if/rtems/attr/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: /groups/api/classic/attr +name: RTEMS_PRIORITY +notes: null +type: interface diff --git a/spec/if/rtems/attr/semaphore-class.yml b/spec/if/rtems/attr/semaphore-class.yml new file mode 100644 index 00000000..bf14811b --- /dev/null +++ b/spec/if/rtems/attr/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: /groups/api/classic/attr +name: RTEMS_SEMAPHORE_CLASS +notes: null +type: interface diff --git a/spec/if/rtems/attr/simple-binary-semaphore.yml b/spec/if/rtems/attr/simple-binary-semaphore.yml new file mode 100644 index 00000000..805a29a3 --- /dev/null +++ b/spec/if/rtems/attr/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: /groups/api/classic/attr +name: RTEMS_SIMPLE_BINARY_SEMAPHORE +notes: null +type: interface diff --git a/spec/if/rtems/attr/system-task.yml b/spec/if/rtems/attr/system-task.yml new file mode 100644 index 00000000..7d6e28f8 --- /dev/null +++ b/spec/if/rtems/attr/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: /groups/api/classic/attr +name: RTEMS_SYSTEM_TASK +notes: null +type: interface |