summaryrefslogtreecommitdiff
path: root/spec/if/rtems
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-05-25 09:52:00 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-05-28 10:38:23 +0200
commit8821c7d4313148585caaf6f93e85346537746587 (patch)
tree6eedae16d1e957de7a3628d78c4e053d92ea1ec7 /spec/if/rtems
parent37d648b805563bc20bc296414ed3f086da190306 (diff)
Rename interface attributes
Diffstat (limited to 'spec/if/rtems')
-rw-r--r--spec/if/rtems/basedefs/alias.yml32
-rw-r--r--spec/if/rtems/basedefs/aligned.yml34
-rw-r--r--spec/if/rtems/basedefs/alloc-align.yml34
-rw-r--r--spec/if/rtems/basedefs/alloc-size-2.yml34
-rw-r--r--spec/if/rtems/basedefs/alloc-size.yml34
-rw-r--r--spec/if/rtems/basedefs/array-size.yml30
-rw-r--r--spec/if/rtems/basedefs/compiler-deprecated-attribute.yml16
-rw-r--r--spec/if/rtems/basedefs/compiler-memory-barrier.yml24
-rw-r--r--spec/if/rtems/basedefs/compiler-no-return-attribute.yml16
-rw-r--r--spec/if/rtems/basedefs/compiler-packed-attribute.yml16
-rw-r--r--spec/if/rtems/basedefs/compiler-pure-attribute.yml16
-rw-r--r--spec/if/rtems/basedefs/compiler-used-attribute.yml16
-rw-r--r--spec/if/rtems/basedefs/concat.yml30
-rw-r--r--spec/if/rtems/basedefs/const.yml18
-rw-r--r--spec/if/rtems/basedefs/container-of.yml32
-rw-r--r--spec/if/rtems/basedefs/declare-global-symbol.yml30
-rw-r--r--spec/if/rtems/basedefs/deconst.yml34
-rw-r--r--spec/if/rtems/basedefs/define-global-symbol.yml38
-rw-r--r--spec/if/rtems/basedefs/deprecated.yml18
-rw-r--r--spec/if/rtems/basedefs/dequalify-depthx.yml48
-rw-r--r--spec/if/rtems/basedefs/dequalify.yml34
-rw-r--r--spec/if/rtems/basedefs/devolatile.yml34
-rw-r--r--spec/if/rtems/basedefs/expand.yml30
-rw-r--r--spec/if/rtems/basedefs/false.yml14
-rw-r--r--spec/if/rtems/basedefs/have-member-same-type.yml42
-rw-r--r--spec/if/rtems/basedefs/header.yml6
-rw-r--r--spec/if/rtems/basedefs/inline-routine.yml18
-rw-r--r--spec/if/rtems/basedefs/malloclike.yml18
-rw-r--r--spec/if/rtems/basedefs/no-inline.yml16
-rw-r--r--spec/if/rtems/basedefs/no-return.yml18
-rw-r--r--spec/if/rtems/basedefs/obfuscate-variable.yml34
-rw-r--r--spec/if/rtems/basedefs/packed.yml18
-rw-r--r--spec/if/rtems/basedefs/predict-false.yml36
-rw-r--r--spec/if/rtems/basedefs/predict-true.yml36
-rw-r--r--spec/if/rtems/basedefs/printflike.yml34
-rw-r--r--spec/if/rtems/basedefs/pure.yml18
-rw-r--r--spec/if/rtems/basedefs/return-address.yml28
-rw-r--r--spec/if/rtems/basedefs/section.yml34
-rw-r--r--spec/if/rtems/basedefs/static-assert.yml34
-rw-r--r--spec/if/rtems/basedefs/string.yml30
-rw-r--r--spec/if/rtems/basedefs/symbol-name.yml36
-rw-r--r--spec/if/rtems/basedefs/true.yml14
-rw-r--r--spec/if/rtems/basedefs/typeof-refx.yml34
-rw-r--r--spec/if/rtems/basedefs/unreachable.yml30
-rw-r--r--spec/if/rtems/basedefs/unused.yml18
-rw-r--r--spec/if/rtems/basedefs/used.yml16
-rw-r--r--spec/if/rtems/basedefs/warn-unused-result.yml18
-rw-r--r--spec/if/rtems/basedefs/weak-alias.yml34
-rw-r--r--spec/if/rtems/basedefs/weak.yml18
-rw-r--r--spec/if/rtems/basedefs/xconcat.yml32
-rw-r--r--spec/if/rtems/basedefs/xstring.yml32
-rw-r--r--spec/if/rtems/basedefs/zero-length-array.yml14
-rw-r--r--spec/if/rtems/config/api-table.yml54
-rw-r--r--spec/if/rtems/config/get-api-configuration.yml22
-rw-r--r--spec/if/rtems/config/get-do-zero-of-workspace.yml26
-rw-r--r--spec/if/rtems/config/get-idle-task-stack-size.yml24
-rw-r--r--spec/if/rtems/config/get-idle-task.yml24
-rw-r--r--spec/if/rtems/config/get-interrupt-stack-size.yml24
-rw-r--r--spec/if/rtems/config/get-maximum-barriers.yml26
-rw-r--r--spec/if/rtems/config/get-maximum-extensions.yml26
-rw-r--r--spec/if/rtems/config/get-maximum-message-queues.yml26
-rw-r--r--spec/if/rtems/config/get-maximum-partitions.yml26
-rw-r--r--spec/if/rtems/config/get-maximum-periods.yml26
-rw-r--r--spec/if/rtems/config/get-maximum-ports.yml26
-rw-r--r--spec/if/rtems/config/get-maximum-processors.yml34
-rw-r--r--spec/if/rtems/config/get-maximum-regions.yml26
-rw-r--r--spec/if/rtems/config/get-maximum-semaphores.yml26
-rw-r--r--spec/if/rtems/config/get-maximum-tasks.yml26
-rw-r--r--spec/if/rtems/config/get-maximum-timers.yml26
-rw-r--r--spec/if/rtems/config/get-microseconds-per-tick.yml24
-rw-r--r--spec/if/rtems/config/get-milliseconds-per-tick.yml24
-rw-r--r--spec/if/rtems/config/get-nanoseconds-per-tick.yml24
-rw-r--r--spec/if/rtems/config/get-number-of-initial-extensions.yml24
-rw-r--r--spec/if/rtems/config/get-stack-allocate-hook.yml24
-rw-r--r--spec/if/rtems/config/get-stack-allocate-init-hook.yml24
-rw-r--r--spec/if/rtems/config/get-stack-allocator-avoids-work-space.yml26
-rw-r--r--spec/if/rtems/config/get-stack-free-hook.yml24
-rw-r--r--spec/if/rtems/config/get-stack-space-size.yml26
-rw-r--r--spec/if/rtems/config/get-ticks-per-timeslice.yml24
-rw-r--r--spec/if/rtems/config/get-unified-work-area.yml26
-rw-r--r--spec/if/rtems/config/get-user-extension-table.yml26
-rw-r--r--spec/if/rtems/config/get-user-multiprocessing-table.yml30
-rw-r--r--spec/if/rtems/config/get-work-space-size.yml28
-rw-r--r--spec/if/rtems/config/header-2.yml6
-rw-r--r--spec/if/rtems/config/header.yml6
-rw-r--r--spec/if/rtems/config/resource-is-unlimited.yml30
-rw-r--r--spec/if/rtems/config/resource-maximum-per-allocation.yml30
-rw-r--r--spec/if/rtems/config/resource-unlimited.yml30
-rw-r--r--spec/if/rtems/config/stack-allocate-hook.yml16
-rw-r--r--spec/if/rtems/config/stack-allocate-init-hook.yml16
-rw-r--r--spec/if/rtems/config/stack-free-hook.yml16
-rw-r--r--spec/if/rtems/config/unlimited-objects.yml16
-rw-r--r--spec/if/rtems/init/header.yml6
-rw-r--r--spec/if/rtems/init/initialize-executive.yml32
-rw-r--r--spec/if/rtems/init/shutdown-executive.yml34
-rw-r--r--spec/if/rtems/status/already-suspended.yml14
-rw-r--r--spec/if/rtems/status/called-from-isr.yml16
-rw-r--r--spec/if/rtems/status/code-to-errno.yml76
-rw-r--r--spec/if/rtems/status/code.yml12
-rw-r--r--spec/if/rtems/status/first.yml16
-rw-r--r--spec/if/rtems/status/header.yml6
-rw-r--r--spec/if/rtems/status/illegal-on-remote-object.yml14
-rw-r--r--spec/if/rtems/status/illegal-on-self.yml16
-rw-r--r--spec/if/rtems/status/incorrect-state.yml16
-rw-r--r--spec/if/rtems/status/internal-error.yml14
-rw-r--r--spec/if/rtems/status/interrupted.yml16
-rw-r--r--spec/if/rtems/status/invalid-address.yml14
-rw-r--r--spec/if/rtems/status/invalid-clock.yml14
-rw-r--r--spec/if/rtems/status/invalid-id.yml14
-rw-r--r--spec/if/rtems/status/invalid-name.yml14
-rw-r--r--spec/if/rtems/status/invalid-node.yml14
-rw-r--r--spec/if/rtems/status/invalid-number.yml14
-rw-r--r--spec/if/rtems/status/invalid-priority.yml14
-rw-r--r--spec/if/rtems/status/invalid-size.yml14
-rw-r--r--spec/if/rtems/status/io-error.yml14
-rw-r--r--spec/if/rtems/status/is-equal.yml40
-rw-r--r--spec/if/rtems/status/is-successful.yml36
-rw-r--r--spec/if/rtems/status/last.yml16
-rw-r--r--spec/if/rtems/status/mp-not-configured.yml14
-rw-r--r--spec/if/rtems/status/no-memory.yml16
-rw-r--r--spec/if/rtems/status/not-configured.yml14
-rw-r--r--spec/if/rtems/status/not-defined.yml14
-rw-r--r--spec/if/rtems/status/not-implemented.yml16
-rw-r--r--spec/if/rtems/status/not-owner-of-resource.yml14
-rw-r--r--spec/if/rtems/status/object-was-deleted.yml16
-rw-r--r--spec/if/rtems/status/proxy-blocking.yml19
-rw-r--r--spec/if/rtems/status/resource-in-use.yml14
-rw-r--r--spec/if/rtems/status/successful.yml14
-rw-r--r--spec/if/rtems/status/task-exitted.yml14
-rw-r--r--spec/if/rtems/status/text.yml30
-rw-r--r--spec/if/rtems/status/timeout.yml14
-rw-r--r--spec/if/rtems/status/too-many.yml16
-rw-r--r--spec/if/rtems/status/unsatisfied.yml14
-rw-r--r--spec/if/rtems/types/header.yml6
134 files changed, 1564 insertions, 1553 deletions
diff --git a/spec/if/rtems/basedefs/alias.yml b/spec/if/rtems/basedefs/alias.yml
index a87353bf..57fe55b7 100644
--- a/spec/if/rtems/basedefs/alias.yml
+++ b/spec/if/rtems/basedefs/alias.yml
@@ -1,31 +1,31 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Instructs the compiler to generate an alias to the specified target function.
copyrights:
- Copyright (C) 2016 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Instructs the compiler to generate an alias to the specified target function.
-interface-definition:
+definition:
default: ''
variants:
- definition: |
__attribute__((__alias__(#_target)))
enabled-by:
- - defined(${/if/compiler/gnuc:/interface-name})
-interface-description: null
-interface-name: RTEMS_ALIAS
-interface-notes: null
-interface-params:
-- description: |
- is the target function name.
- dir: null
- name: _target
-interface-return:
- return: null
- return-values: []
+ - defined(${/if/compiler/gnuc:/name})
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_ALIAS
+notes: null
+params:
+- description: |
+ is the target function name.
+ dir: null
+ name: _target
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/basedefs/aligned.yml b/spec/if/rtems/basedefs/aligned.yml
index 17402774..7090f924 100644
--- a/spec/if/rtems/basedefs/aligned.yml
+++ b/spec/if/rtems/basedefs/aligned.yml
@@ -1,32 +1,32 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2016 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Instructs the compiler in a declaration or definition to enforce the
specified alignment.
-interface-definition:
+copyrights:
+- Copyright (C) 2016 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default: ''
variants:
- definition: |
__attribute__((__aligned__(_alignment)))
enabled-by:
- - defined(${/if/compiler/gnuc:/interface-name})
-interface-description: null
-interface-name: RTEMS_ALIGNED
-interface-notes: null
-interface-params:
-- description: |
- is the desired alignment in bytes.
- dir: null
- name: _alignment
-interface-return:
- return: null
- return-values: []
+ - defined(${/if/compiler/gnuc:/name})
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_ALIGNED
+notes: null
+params:
+- description: |
+ is the desired alignment in bytes.
+ dir: null
+ name: _alignment
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/basedefs/alloc-align.yml b/spec/if/rtems/basedefs/alloc-align.yml
index b08bd791..d7d45571 100644
--- a/spec/if/rtems/basedefs/alloc-align.yml
+++ b/spec/if/rtems/basedefs/alloc-align.yml
@@ -1,32 +1,32 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Tells the compiler in a declaration that the memory allocation alignment
parameter of this function is similar to aligned_alloc().
-interface-definition:
+copyrights:
+- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default: ''
variants:
- definition: |
__attribute__((__alloc_align__(_index)))
enabled-by:
- - defined(${/if/compiler/gnuc:/interface-name})
-interface-description: null
-interface-name: RTEMS_ALLOC_ALIGN
-interface-notes: null
-interface-params:
-- description: |
- is the allocation alignment parameter index (starting with one).
- dir: null
- name: _index
-interface-return:
- return: null
- return-values: []
+ - defined(${/if/compiler/gnuc:/name})
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_ALLOC_ALIGN
+notes: null
+params:
+- description: |
+ is the allocation alignment parameter index (starting with one).
+ dir: null
+ name: _index
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/basedefs/alloc-size-2.yml b/spec/if/rtems/basedefs/alloc-size-2.yml
index e9b8bb62..851a8c8b 100644
--- a/spec/if/rtems/basedefs/alloc-size-2.yml
+++ b/spec/if/rtems/basedefs/alloc-size-2.yml
@@ -1,21 +1,27 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Tells the compiler in a declaration that the memory allocation item count and
item size parameter of this function is similar to calloc().
-interface-definition:
+copyrights:
+- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default: ''
variants:
- definition: |
__attribute__((__alloc_size__(_count_index, _size_index)))
enabled-by:
- - defined(${/if/compiler/gnuc:/interface-name})
-interface-description: null
-interface-name: RTEMS_ALLOC_SIZE_2
-interface-notes: null
-interface-params:
+ - defined(${/if/compiler/gnuc:/name})
+description: null
+enabled-by: true
+interface-type: macro
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: /groups/api/basedefs
+name: RTEMS_ALLOC_SIZE_2
+notes: null
+params:
- description: |
is the allocation item count parameter index (starting with one).
dir: null
@@ -24,13 +30,7 @@ interface-params:
is the allocation item size parameter index (starting with one).
dir: null
name: _size_index
-interface-return:
+return:
return: null
return-values: []
-interface-type: macro
-links:
-- role: interface-placement
- uid: header
-- role: interface-ingroup
- uid: /groups/api/basedefs
type: interface
diff --git a/spec/if/rtems/basedefs/alloc-size.yml b/spec/if/rtems/basedefs/alloc-size.yml
index 68b3729f..3c889153 100644
--- a/spec/if/rtems/basedefs/alloc-size.yml
+++ b/spec/if/rtems/basedefs/alloc-size.yml
@@ -1,32 +1,32 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Tells the compiler in a declaration that the memory allocation size parameter
of this function is similar to malloc().
-interface-definition:
+copyrights:
+- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default: ''
variants:
- definition: |
__attribute__((__alloc_size__(_index)))
enabled-by:
- - defined(${/if/compiler/gnuc:/interface-name})
-interface-description: null
-interface-name: RTEMS_ALLOC_SIZE
-interface-notes: null
-interface-params:
-- description: |
- is the allocation size parameter index (starting with one).
- dir: null
- name: _index
-interface-return:
- return: null
- return-values: []
+ - defined(${/if/compiler/gnuc:/name})
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_ALLOC_SIZE
+notes: null
+params:
+- description: |
+ is the allocation size parameter index (starting with one).
+ dir: null
+ name: _index
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/basedefs/array-size.yml b/spec/if/rtems/basedefs/array-size.yml
index a8de4678..5dea464a 100644
--- a/spec/if/rtems/basedefs/array-size.yml
+++ b/spec/if/rtems/basedefs/array-size.yml
@@ -1,28 +1,28 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the element count of the specified array.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the element count of the specified array.
-interface-definition:
+definition:
default: |
(sizeof(_array) / sizeof((_array)[0]))
variants: []
-interface-description: null
-interface-name: RTEMS_ARRAY_SIZE
-interface-notes: null
-interface-params:
-- description: |
- is the name of the array.
- dir: null
- name: _array
-interface-return:
- return: The element count of the specified array.
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_ARRAY_SIZE
+notes: null
+params:
+- description: |
+ is the name of the array.
+ dir: null
+ name: _array
+return:
+ return: The element count of the specified array.
+ return-values: []
type: interface
diff --git a/spec/if/rtems/basedefs/compiler-deprecated-attribute.yml b/spec/if/rtems/basedefs/compiler-deprecated-attribute.yml
index 34b7f616..c0e6dc58 100644
--- a/spec/if/rtems/basedefs/compiler-deprecated-attribute.yml
+++ b/spec/if/rtems/basedefs/compiler-deprecated-attribute.yml
@@ -1,20 +1,20 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Provided for backward compatibility.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Provided for backward compatibility.
-interface-definition:
+definition:
default: |
- ${deprecated:/interface-name}
+ ${deprecated:/name}
variants: []
-interface-description: null
-interface-name: RTEMS_COMPILER_DEPRECATED_ATTRIBUTE
-interface-notes: null
+description: null
+enabled-by: true
interface-type: define
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_COMPILER_DEPRECATED_ATTRIBUTE
+notes: null
type: interface
diff --git a/spec/if/rtems/basedefs/compiler-memory-barrier.yml b/spec/if/rtems/basedefs/compiler-memory-barrier.yml
index 36ad47bd..31ed5eb8 100644
--- a/spec/if/rtems/basedefs/compiler-memory-barrier.yml
+++ b/spec/if/rtems/basedefs/compiler-memory-barrier.yml
@@ -1,28 +1,28 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This macro forbids the compiler to reorder read and write commands around it.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- This macro forbids the compiler to reorder read and write commands around it.
-interface-definition:
+definition:
default: |
do { } while ( 0 )
variants:
- definition: |
__asm__ volatile( "" ::: "memory" )
enabled-by:
- - defined(${/if/compiler/gnuc:/interface-name})
-interface-description: null
-interface-name: RTEMS_COMPILER_MEMORY_BARRIER
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+ - defined(${/if/compiler/gnuc:/name})
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_COMPILER_MEMORY_BARRIER
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/basedefs/compiler-no-return-attribute.yml b/spec/if/rtems/basedefs/compiler-no-return-attribute.yml
index c5bd8c83..93cf22ac 100644
--- a/spec/if/rtems/basedefs/compiler-no-return-attribute.yml
+++ b/spec/if/rtems/basedefs/compiler-no-return-attribute.yml
@@ -1,20 +1,20 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Provided for backward compatibility.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Provided for backward compatibility.
-interface-definition:
+definition:
default: |
- ${no-return:/interface-name}
+ ${no-return:/name}
variants: []
-interface-description: null
-interface-name: RTEMS_COMPILER_NO_RETURN_ATTRIBUTE
-interface-notes: null
+description: null
+enabled-by: true
interface-type: define
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_COMPILER_NO_RETURN_ATTRIBUTE
+notes: null
type: interface
diff --git a/spec/if/rtems/basedefs/compiler-packed-attribute.yml b/spec/if/rtems/basedefs/compiler-packed-attribute.yml
index d056d3d7..0bd81429 100644
--- a/spec/if/rtems/basedefs/compiler-packed-attribute.yml
+++ b/spec/if/rtems/basedefs/compiler-packed-attribute.yml
@@ -1,20 +1,20 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Provided for backward compatibility.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Provided for backward compatibility.
-interface-definition:
+definition:
default: |
- ${packed:/interface-name}
+ ${packed:/name}
variants: []
-interface-description: null
-interface-name: RTEMS_COMPILER_PACKED_ATTRIBUTE
-interface-notes: null
+description: null
+enabled-by: true
interface-type: define
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_COMPILER_PACKED_ATTRIBUTE
+notes: null
type: interface
diff --git a/spec/if/rtems/basedefs/compiler-pure-attribute.yml b/spec/if/rtems/basedefs/compiler-pure-attribute.yml
index 24178690..70b47c7f 100644
--- a/spec/if/rtems/basedefs/compiler-pure-attribute.yml
+++ b/spec/if/rtems/basedefs/compiler-pure-attribute.yml
@@ -1,20 +1,20 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Provided for backward compatibility.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Provided for backward compatibility.
-interface-definition:
+definition:
default: |
- ${pure:/interface-name}
+ ${pure:/name}
variants: []
-interface-description: null
-interface-name: RTEMS_COMPILER_PURE_ATTRIBUTE
-interface-notes: null
+description: null
+enabled-by: true
interface-type: define
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_COMPILER_PURE_ATTRIBUTE
+notes: null
type: interface
diff --git a/spec/if/rtems/basedefs/compiler-used-attribute.yml b/spec/if/rtems/basedefs/compiler-used-attribute.yml
index ec695e16..e5c0a9e5 100644
--- a/spec/if/rtems/basedefs/compiler-used-attribute.yml
+++ b/spec/if/rtems/basedefs/compiler-used-attribute.yml
@@ -1,20 +1,20 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Provided for backward compatibility.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Provided for backward compatibility.
-interface-definition:
+definition:
default: |
- ${used:/interface-name}
+ ${used:/name}
variants: []
-interface-description: null
-interface-name: RTEMS_COMPILER_USED_ATTRIBUTE
-interface-notes: null
+description: null
+enabled-by: true
interface-type: define
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_COMPILER_USED_ATTRIBUTE
+notes: null
type: interface
diff --git a/spec/if/rtems/basedefs/concat.yml b/spec/if/rtems/basedefs/concat.yml
index 5e73ceba..12ef9d21 100644
--- a/spec/if/rtems/basedefs/concat.yml
+++ b/spec/if/rtems/basedefs/concat.yml
@@ -1,16 +1,22 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Concatenates _x and _y without expanding.
copyrights:
- Copyright (C) 2015 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Concatenates _x and _y without expanding.
-interface-definition:
+definition:
default: _x##_y
variants: []
-interface-description: null
-interface-name: RTEMS_CONCAT
-interface-notes: null
-interface-params:
+description: null
+enabled-by: true
+interface-type: macro
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: /groups/api/basedefs
+name: RTEMS_CONCAT
+notes: null
+params:
- description: |
is the left hand side token of the concatenation.
dir: null
@@ -19,14 +25,8 @@ interface-params:
is the right hand side token of the concatenation.
dir: null
name: _y
-interface-return:
+return:
return: |
The concatenation of the tokens _x and _y.
return-values: []
-interface-type: macro
-links:
-- role: interface-placement
- uid: header
-- role: interface-ingroup
- uid: /groups/api/basedefs
type: interface
diff --git a/spec/if/rtems/basedefs/const.yml b/spec/if/rtems/basedefs/const.yml
index 60378f74..39dc20ee 100644
--- a/spec/if/rtems/basedefs/const.yml
+++ b/spec/if/rtems/basedefs/const.yml
@@ -1,25 +1,25 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2019 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Tells the compiler in a function declaration that this function has no effect
except the return value and that the return value depends only on the value
of parameters.
-interface-definition:
+copyrights:
+- Copyright (C) 2019 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default: ''
variants:
- definition: |
__attribute__((__const__))
enabled-by:
- - defined(${/if/compiler/gnuc:/interface-name})
-interface-description: null
-interface-name: RTEMS_CONST
-interface-notes: null
+ - defined(${/if/compiler/gnuc:/name})
+description: null
+enabled-by: true
interface-type: define
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_CONST
+notes: null
type: interface
diff --git a/spec/if/rtems/basedefs/container-of.yml b/spec/if/rtems/basedefs/container-of.yml
index 7073634e..c51e9edf 100644
--- a/spec/if/rtems/basedefs/container-of.yml
+++ b/spec/if/rtems/basedefs/container-of.yml
@@ -1,17 +1,23 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the pointer to the container of a specified member pointer.
copyrights:
- Copyright (C) 2014 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the pointer to the container of a specified member pointer.
-interface-definition:
+definition:
default: |
- ( (_type *) ( (${/if/c/uintptr_t:/interface-name}) ( _m ) - ${/if/c/offsetof:/interface-name}( _type, _member_name ) ) )
+ ( (_type *) ( (${/if/c/uintptr_t:/name}) ( _m ) - ${/if/c/offsetof:/name}( _type, _member_name ) ) )
variants: []
-interface-description: null
-interface-name: RTEMS_CONTAINER_OF
-interface-notes: null
-interface-params:
+description: null
+enabled-by: true
+interface-type: macro
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: /groups/api/basedefs
+name: RTEMS_CONTAINER_OF
+notes: null
+params:
- description: |
is the pointer to a member of the container.
dir: null
@@ -24,14 +30,8 @@ interface-params:
is the designator name of the container member.
dir: null
name: _member_name
-interface-return:
+return:
return: |
Returns the pointer to the container of a specified member pointer.
return-values: []
-interface-type: macro
-links:
-- role: interface-placement
- uid: header
-- role: interface-ingroup
- uid: /groups/api/basedefs
type: interface
diff --git a/spec/if/rtems/basedefs/declare-global-symbol.yml b/spec/if/rtems/basedefs/declare-global-symbol.yml
index d168393c..cecb7259 100644
--- a/spec/if/rtems/basedefs/declare-global-symbol.yml
+++ b/spec/if/rtems/basedefs/declare-global-symbol.yml
@@ -1,29 +1,29 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Declares a global symbol with the specified name.
copyrights:
- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Declares a global symbol with the specified name.
-interface-definition:
+definition:
default: |
extern char _name[]
variants: []
-interface-description: |
+description: |
This macro must be placed at file scope.
-interface-name: RTEMS_DECLARE_GLOBAL_SYMBOL
-interface-notes: null
-interface-params:
-- description: |
- is the name of the global symbol. It shall be a valid designator.
- dir: null
- name: _name
-interface-return:
- return: null
- return-values: []
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_DECLARE_GLOBAL_SYMBOL
+notes: null
+params:
+- description: |
+ is the name of the global symbol. It shall be a valid designator.
+ dir: null
+ name: _name
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/basedefs/deconst.yml b/spec/if/rtems/basedefs/deconst.yml
index 92295f99..599e0fa9 100644
--- a/spec/if/rtems/basedefs/deconst.yml
+++ b/spec/if/rtems/basedefs/deconst.yml
@@ -1,18 +1,24 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Performs a type cast which removes const qualifiers without warnings to the
+ specified type for the specified pointer variable.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2014 Paval Pisa
-enabled-by: true
-interface-brief: |
- Performs a type cast which removes const qualifiers without warnings to the
- specified type for the specified pointer variable.
-interface-definition:
- default: ${dequalify-depthx:/interface-name}(*, _type, _var)
+definition:
+ default: ${dequalify-depthx:/name}(*, _type, _var)
variants: []
-interface-description: null
-interface-name: RTEMS_DECONST
-interface-notes: null
-interface-params:
+description: null
+enabled-by: true
+interface-type: macro
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: /groups/api/basedefs
+name: RTEMS_DECONST
+notes: null
+params:
- description: |
is the target type of the cast.
dir: null
@@ -21,13 +27,7 @@ interface-params:
is the pointer variable.
dir: null
name: _var
-interface-return:
+return:
return: null
return-values: []
-interface-type: macro
-links:
-- role: interface-placement
- uid: header
-- role: interface-ingroup
- uid: /groups/api/basedefs
type: interface
diff --git a/spec/if/rtems/basedefs/define-global-symbol.yml b/spec/if/rtems/basedefs/define-global-symbol.yml
index 157542d6..d506195b 100644
--- a/spec/if/rtems/basedefs/define-global-symbol.yml
+++ b/spec/if/rtems/basedefs/define-global-symbol.yml
@@ -1,25 +1,31 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Defines a global symbol with the specified name and value.
copyrights:
- Copyright (C) 2018, 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Defines a global symbol with the specified name and value.
-interface-definition:
+definition:
default: ''
variants:
- definition: |
__asm__(
- "\t.globl " ${xstring:/interface-name}( ${symbol-name:/interface-name}( _name ) )
- "\n\t.set " ${xstring:/interface-name}( ${symbol-name:/interface-name}( _name ) )
- ", " ${string:/interface-name}( _value ) "\n"
+ "\t.globl " ${xstring:/name}( ${symbol-name:/name}( _name ) )
+ "\n\t.set " ${xstring:/name}( ${symbol-name:/name}( _name ) )
+ ", " ${string:/name}( _value ) "\n"
)
enabled-by:
- - defined(${/if/compiler/user-label-prefix:/interface-name})
-interface-description: |
+ - defined(${/if/compiler/user-label-prefix:/name})
+description: |
This macro shall be placed at file scope.
-interface-name: RTEMS_DEFINE_GLOBAL_SYMBOL
-interface-notes: null
-interface-params:
+enabled-by: true
+interface-type: macro
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: /groups/api/basedefs
+name: RTEMS_DEFINE_GLOBAL_SYMBOL
+notes: null
+params:
- description: |
is the user defined name of the symbol. The name shall be a valid
designator. On the name a macro expansion is performed and afterwards it
@@ -32,13 +38,7 @@ interface-params:
understood by the assembler.
dir: null
name: _value
-interface-return:
+return:
return: null
return-values: []
-interface-type: macro
-links:
-- role: interface-placement
- uid: header
-- role: interface-ingroup
- uid: /groups/api/basedefs
type: interface
diff --git a/spec/if/rtems/basedefs/deprecated.yml b/spec/if/rtems/basedefs/deprecated.yml
index 6b86ab43..f7fc3346 100644
--- a/spec/if/rtems/basedefs/deprecated.yml
+++ b/spec/if/rtems/basedefs/deprecated.yml
@@ -1,24 +1,24 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2009 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Instructs the compiler in a declaration to issue a warning whenever a
variable, function, or type using this declaration will be used.
-interface-definition:
+copyrights:
+- Copyright (C) 2009 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default: ''
variants:
- definition: |
__attribute__((__deprecated__))
enabled-by:
- - defined(${/if/compiler/gnuc:/interface-name})
-interface-description: null
-interface-name: RTEMS_DEPRECATED
-interface-notes: null
+ - defined(${/if/compiler/gnuc:/name})
+description: null
+enabled-by: true
interface-type: define
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_DEPRECATED
+notes: null
type: interface
diff --git a/spec/if/rtems/basedefs/dequalify-depthx.yml b/spec/if/rtems/basedefs/dequalify-depthx.yml
index 43722948..8c107526 100644
--- a/spec/if/rtems/basedefs/dequalify-depthx.yml
+++ b/spec/if/rtems/basedefs/dequalify-depthx.yml
@@ -1,31 +1,37 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Performs a type cast which removes qualifiers without warnings to the
+ specified type for the specified variable.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2014 Paval Pisa
-enabled-by: true
-interface-brief: |
- Performs a type cast which removes qualifiers without warnings to the
- specified type for the specified variable.
-interface-definition:
- default: ((_type)(${/if/c/uintptr_t:/interface-name})(const volatile void *)(_var))
+definition:
+ default: ((_type)(${/if/c/uintptr_t:/name})(const volatile void *)(_var))
variants:
- definition: |
(const_cast<_type>(_var))
enabled-by:
- - defined(${/if/compiler/cplusplus:/interface-name})
+ - defined(${/if/compiler/cplusplus:/name})
- definition: |
- ${/if/compiler/builtin-choose-expr:/interface-name}(${/if/compiler/builtin-types-compatible-p:/interface-name}(
- ${typeof-refx:/interface-name}(_ptr_level, _var),
- ${typeof-refx:/interface-name}(_ptr_level, _type)
- ) || ${/if/compiler/builtin-types-compatible-p:/interface-name}(_type, void *),
+ ${/if/compiler/builtin-choose-expr:/name}(${/if/compiler/builtin-types-compatible-p:/name}(
+ ${typeof-refx:/name}(_ptr_level, _var),
+ ${typeof-refx:/name}(_ptr_level, _type)
+ ) || ${/if/compiler/builtin-types-compatible-p:/name}(_type, void *),
(_type)(_var),
- ${/if/impl/dequalify-types-not-compatible:/interface-name}())
+ ${/if/impl/dequalify-types-not-compatible:/name}())
enabled-by:
- - defined(${/if/compiler/gnuc:/interface-name})
-interface-description: null
-interface-name: RTEMS_DEQUALIFY_DEPTHX
-interface-notes: null
-interface-params:
+ - defined(${/if/compiler/gnuc:/name})
+description: null
+enabled-by: true
+interface-type: macro
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: /groups/api/basedefs
+name: RTEMS_DEQUALIFY_DEPTHX
+notes: null
+params:
- description: |
is the pointer indirection level expressed in *.
dir: null
@@ -38,13 +44,7 @@ interface-params:
is the variable.
dir: null
name: _var
-interface-return:
+return:
return: null
return-values: []
-interface-type: macro
-links:
-- role: interface-placement
- uid: header
-- role: interface-ingroup
- uid: /groups/api/basedefs
type: interface
diff --git a/spec/if/rtems/basedefs/dequalify.yml b/spec/if/rtems/basedefs/dequalify.yml
index b22fe060..4d1c4e76 100644
--- a/spec/if/rtems/basedefs/dequalify.yml
+++ b/spec/if/rtems/basedefs/dequalify.yml
@@ -1,18 +1,24 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Performs a type cast which removes all qualifiers without warnings to the
+ specified type for the specified pointer variable.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2014 Paval Pisa
-enabled-by: true
-interface-brief: |
- Performs a type cast which removes all qualifiers without warnings to the
- specified type for the specified pointer variable.
-interface-definition:
- default: ${dequalify-depthx:/interface-name}(*, _type, _var)
+definition:
+ default: ${dequalify-depthx:/name}(*, _type, _var)
variants: []
-interface-description: null
-interface-name: RTEMS_DEQUALIFY
-interface-notes: null
-interface-params:
+description: null
+enabled-by: true
+interface-type: macro
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: /groups/api/basedefs
+name: RTEMS_DEQUALIFY
+notes: null
+params:
- description: |
is the target type of the cast.
dir: null
@@ -21,13 +27,7 @@ interface-params:
is the pointer variable.
dir: null
name: _var
-interface-return:
+return:
return: null
return-values: []
-interface-type: macro
-links:
-- role: interface-placement
- uid: header
-- role: interface-ingroup
- uid: /groups/api/basedefs
type: interface
diff --git a/spec/if/rtems/basedefs/devolatile.yml b/spec/if/rtems/basedefs/devolatile.yml
index 100ea495..baf4c628 100644
--- a/spec/if/rtems/basedefs/devolatile.yml
+++ b/spec/if/rtems/basedefs/devolatile.yml
@@ -1,18 +1,24 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Performs a type cast which removes volatile qualifiers without warnings to
+ the specified type for the specified pointer variable.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2014 Paval Pisa
-enabled-by: true
-interface-brief: |
- Performs a type cast which removes volatile qualifiers without warnings to
- the specified type for the specified pointer variable.
-interface-definition:
- default: ${dequalify-depthx:/interface-name}(*, _type, _var)
+definition:
+ default: ${dequalify-depthx:/name}(*, _type, _var)
variants: []
-interface-description: null
-interface-name: RTEMS_DEVOLATILE
-interface-notes: null
-interface-params:
+description: null
+enabled-by: true
+interface-type: macro
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: /groups/api/basedefs
+name: RTEMS_DEVOLATILE
+notes: null
+params:
- description: |
is the target type of the cast.
dir: null
@@ -21,13 +27,7 @@ interface-params:
is the pointer variable.
dir: null
name: _var
-interface-return:
+return:
return: null
return-values: []
-interface-type: macro
-links:
-- role: interface-placement
- uid: header
-- role: interface-ingroup
- uid: /groups/api/basedefs
type: interface
diff --git a/spec/if/rtems/basedefs/expand.yml b/spec/if/rtems/basedefs/expand.yml
index 5423d2c1..79689785 100644
--- a/spec/if/rtems/basedefs/expand.yml
+++ b/spec/if/rtems/basedefs/expand.yml
@@ -1,27 +1,27 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Helper macro to perform a macro expansion on the specified token.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Helper macro to perform a macro expansion on the specified token.
-interface-definition:
+definition:
default: _token
variants: []
-interface-description: null
-interface-name: RTEMS_EXPAND
-interface-notes: null
-interface-params:
-- description: |
- is the token to expand.
- dir: null
- name: _token
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_EXPAND
+notes: null
+params:
+- description: |
+ is the token to expand.
+ dir: null
+ name: _token
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/basedefs/false.yml b/spec/if/rtems/basedefs/false.yml
index ae2eb012..57d16f60 100644
--- a/spec/if/rtems/basedefs/false.yml
+++ b/spec/if/rtems/basedefs/false.yml
@@ -1,19 +1,19 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: If FALSE is undefined, then FALSE is defined to 0.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by:
-- not: 'FALSE'
-interface-brief: If FALSE is undefined, then FALSE is defined to 0.
-interface-definition:
+definition:
default: '0'
variants: []
-interface-description: null
-interface-name: 'FALSE'
-interface-notes: null
+description: null
+enabled-by:
+- not: 'FALSE'
interface-type: define
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: 'FALSE'
+notes: null
type: interface
diff --git a/spec/if/rtems/basedefs/have-member-same-type.yml b/spec/if/rtems/basedefs/have-member-same-type.yml
index 50c0dbf5..22346cca 100644
--- a/spec/if/rtems/basedefs/have-member-same-type.yml
+++ b/spec/if/rtems/basedefs/have-member-same-type.yml
@@ -1,25 +1,31 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2017 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Evaluates to true if the specified members of two types have compatible
types, otherwise to false.
-interface-definition:
+copyrights:
+- Copyright (C) 2017 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default: |
- ${/if/c/true:/interface-name}
+ ${/if/c/true:/name}
variants:
- definition: |
- ${/if/compiler/builtin-types-compatible-p:/interface-name}(
- ${/if/compiler/typeof:/interface-name}( ( (_t_lhs *) 0 )->_m_lhs ),
- ${/if/compiler/typeof:/interface-name}( ( (_t_rhs *) 0 )->_m_rhs )
+ ${/if/compiler/builtin-types-compatible-p:/name}(
+ ${/if/compiler/typeof:/name}( ( (_t_lhs *) 0 )->_m_lhs ),
+ ${/if/compiler/typeof:/name}( ( (_t_rhs *) 0 )->_m_rhs )
)
enabled-by:
- - defined(${/if/compiler/gnuc:/interface-name})
-interface-description: null
-interface-name: RTEMS_HAVE_MEMBER_SAME_TYPE
-interface-notes: null
-interface-params:
+ - defined(${/if/compiler/gnuc:/name})
+description: null
+enabled-by: true
+interface-type: macro
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: /groups/api/basedefs
+name: RTEMS_HAVE_MEMBER_SAME_TYPE
+notes: null
+params:
- description: |
is the left hand side type.
dir: null
@@ -36,13 +42,7 @@ interface-params:
is the right hand side member.
dir: null
name: _m_rhs
-interface-return:
+return:
return: null
return-values: []
-interface-type: macro
-links:
-- role: interface-placement
- uid: header
-- role: interface-ingroup
- uid: /groups/api/basedefs
type: interface
diff --git a/spec/if/rtems/basedefs/header.yml b/spec/if/rtems/basedefs/header.yml
index fdb4ff9e..760ce111 100644
--- a/spec/if/rtems/basedefs/header.yml
+++ b/spec/if/rtems/basedefs/header.yml
@@ -1,10 +1,8 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+domain: rtems
enabled-by: true
-interface-domain: rtems
-interface-path: rtems/score/basedefs.h
-interface-prefix: cpukit/include
interface-type: header-file
links:
- enabled-by: []
@@ -22,4 +20,6 @@ links:
not: ASM
role: interface-include
uid: /if/c/stdint
+path: rtems/score/basedefs.h
+prefix: cpukit/include
type: interface
diff --git a/spec/if/rtems/basedefs/inline-routine.yml b/spec/if/rtems/basedefs/inline-routine.yml
index a041fe20..b26b7fcf 100644
--- a/spec/if/rtems/basedefs/inline-routine.yml
+++ b/spec/if/rtems/basedefs/inline-routine.yml
@@ -1,23 +1,23 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Gives a hint to the compiler in a function declaration to inline this
function.
-interface-definition:
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default: static inline
variants:
- definition: static __inline__
enabled-by:
- - defined(${/if/compiler/gnuc:/interface-name})
-interface-description: null
-interface-name: RTEMS_INLINE_ROUTINE
-interface-notes: null
+ - defined(${/if/compiler/gnuc:/name})
+description: null
+enabled-by: true
interface-type: define
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_INLINE_ROUTINE
+notes: null
type: interface
diff --git a/spec/if/rtems/basedefs/malloclike.yml b/spec/if/rtems/basedefs/malloclike.yml
index 9a27edce..3608e444 100644
--- a/spec/if/rtems/basedefs/malloclike.yml
+++ b/spec/if/rtems/basedefs/malloclike.yml
@@ -1,24 +1,24 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Tells the compiler in a declaration that this function is a memory allocation
function similar to malloc().
-interface-definition:
+copyrights:
+- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default: ''
variants:
- definition: |
__attribute__((__malloc__))
enabled-by:
- - defined(${/if/compiler/gnuc:/interface-name})
-interface-description: null
-interface-name: RTEMS_MALLOCLIKE
-interface-notes: null
+ - defined(${/if/compiler/gnuc:/name})
+description: null
+enabled-by: true
interface-type: define
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_MALLOCLIKE
+notes: null
type: interface
diff --git a/spec/if/rtems/basedefs/no-inline.yml b/spec/if/rtems/basedefs/no-inline.yml
index 72146d5f..9d70a151 100644
--- a/spec/if/rtems/basedefs/no-inline.yml
+++ b/spec/if/rtems/basedefs/no-inline.yml
@@ -1,23 +1,23 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Instructs the compiler in a function declaration to not inline this function.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Instructs the compiler in a function declaration to not inline this function.
-interface-definition:
+definition:
default: ''
variants:
- definition: |
__attribute__((__noinline__))
enabled-by:
- - defined(${/if/compiler/gnuc:/interface-name})
-interface-description: null
-interface-name: RTEMS_NO_INLINE
-interface-notes: null
+ - defined(${/if/compiler/gnuc:/name})
+description: null
+enabled-by: true
interface-type: define
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_NO_INLINE
+notes: null
type: interface
diff --git a/spec/if/rtems/basedefs/no-return.yml b/spec/if/rtems/basedefs/no-return.yml
index 943a2587..fa71b2d5 100644
--- a/spec/if/rtems/basedefs/no-return.yml
+++ b/spec/if/rtems/basedefs/no-return.yml
@@ -1,24 +1,24 @@
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-brief: |
+brief: |
Tells the compiler in a function declaration that this function does not
return.
-interface-definition:
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default: ''
variants:
- definition: |
__attribute__((__noreturn__))
enabled-by:
- - defined(${/if/compiler/gnuc:/interface-name})
-interface-description: null
-interface-name: RTEMS_NO_RETURN
-interface-notes: null
+ - defined(${/if/compiler/gnuc:/name})
+description: null
+enabled-by: true
interface-type: define
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_NO_RETURN
+notes: null
type: interface
diff --git a/spec/if/rtems/basedefs/obfuscate-variable.yml b/spec/if/rtems/basedefs/obfuscate-variable.yml
index 290a4060..2f943a2d 100644
--- a/spec/if/rtems/basedefs/obfuscate-variable.yml
+++ b/spec/if/rtems/basedefs/obfuscate-variable.yml
@@ -1,34 +1,34 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2016, 2018 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Obfuscates the variable so that the compiler cannot perform optimizations
based on the variable value.
-interface-definition:
+copyrights:
+- Copyright (C) 2016, 2018 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default: |
(void) (_var)
variants:
- definition: |
__asm__("" : "+r" (_var))
enabled-by:
- - defined(${/if/compiler/gnuc:/interface-name})
-interface-description: |
+ - defined(${/if/compiler/gnuc:/name})
+description: |
The variable must be simple enough to fit into a register.
-interface-name: RTEMS_OBFUSCATE_VARIABLE
-interface-notes: null
-interface-params:
-- description: |
- is the variable to obfuscate.
- dir: null
- name: _var
-interface-return:
- return: null
- return-values: []
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_OBFUSCATE_VARIABLE
+notes: null
+params:
+- description: |
+ is the variable to obfuscate.
+ dir: null
+ name: _var
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/basedefs/packed.yml b/spec/if/rtems/basedefs/packed.yml
index 9dde6cb6..91b543da 100644
--- a/spec/if/rtems/basedefs/packed.yml
+++ b/spec/if/rtems/basedefs/packed.yml
@@ -1,24 +1,24 @@
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-brief: |
+brief: |
Instructs the compiler in a type definition to place members of a structure
or union so that the memory required is minimized.
-interface-definition:
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default: ''
variants:
- definition: |
__attribute__((__packed__))
enabled-by:
- - defined(${/if/compiler/gnuc:/interface-name})
-interface-description: null
-interface-name: RTEMS_PACKED
-interface-notes: null
+ - defined(${/if/compiler/gnuc:/name})
+description: null
+enabled-by: true
interface-type: define
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_PACKED
+notes: null
type: interface
diff --git a/spec/if/rtems/basedefs/predict-false.yml b/spec/if/rtems/basedefs/predict-false.yml
index 332a639a..6ed00a71 100644
--- a/spec/if/rtems/basedefs/predict-false.yml
+++ b/spec/if/rtems/basedefs/predict-false.yml
@@ -1,33 +1,33 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Returns the value of the specified integral expression and tells the compiler
that the predicted value is false (1).
-interface-definition:
+copyrights:
+- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default: |
( _exp )
variants:
- definition: |
- ${/if/compiler/builtin-expect:/interface-name}( ( _exp ), 0 )
+ ${/if/compiler/builtin-expect:/name}( ( _exp ), 0 )
enabled-by:
- - defined(${/if/compiler/gnuc:/interface-name})
-interface-description: null
-interface-name: RTEMS_PREDICT_FALSE
-interface-notes: null
-interface-params:
-- description: |
- is the expression.
- dir: null
- name: _exp
-interface-return:
- return: The value of the expression.
- return-values: []
+ - defined(${/if/compiler/gnuc:/name})
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_PREDICT_FALSE
+notes: null
+params:
+- description: |
+ is the expression.
+ dir: null
+ name: _exp
+return:
+ return: The value of the expression.
+ return-values: []
type: interface
diff --git a/spec/if/rtems/basedefs/predict-true.yml b/spec/if/rtems/basedefs/predict-true.yml
index b8a1e7d2..e8a3beaa 100644
--- a/spec/if/rtems/basedefs/predict-true.yml
+++ b/spec/if/rtems/basedefs/predict-true.yml
@@ -1,33 +1,33 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Returns the value of the specified integral expression and tells the compiler
that the predicted value is true (1).
-interface-definition:
+copyrights:
+- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default: |
( _exp )
variants:
- definition: |
- ${/if/compiler/builtin-expect:/interface-name}( ( _exp ), 1 )
+ ${/if/compiler/builtin-expect:/name}( ( _exp ), 1 )
enabled-by:
- - defined(${/if/compiler/gnuc:/interface-name})
-interface-description: null
-interface-name: RTEMS_PREDICT_TRUE
-interface-notes: null
-interface-params:
-- description: |
- is the expression.
- dir: null
- name: _exp
-interface-return:
- return: The value of the expression.
- return-values: []
+ - defined(${/if/compiler/gnuc:/name})
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_PREDICT_TRUE
+notes: null
+params:
+- description: |
+ is the expression.
+ dir: null
+ name: _exp
+return:
+ return: The value of the expression.
+ return-values: []
type: interface
diff --git a/spec/if/rtems/basedefs/printflike.yml b/spec/if/rtems/basedefs/printflike.yml
index e564ce21..90eec733 100644
--- a/spec/if/rtems/basedefs/printflike.yml
+++ b/spec/if/rtems/basedefs/printflike.yml
@@ -1,21 +1,27 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2016 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Tells the compiler in a declaration that this function expects printf()-like
arguments.
-interface-definition:
+copyrights:
+- Copyright (C) 2016 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default: ''
variants:
- definition: |
__attribute__((__format__(__printf__, _format_pos, _ap_pos)))
enabled-by:
- - defined(${/if/compiler/gnuc:/interface-name})
-interface-description: null
-interface-name: RTEMS_PRINTFLIKE
-interface-notes: null
-interface-params:
+ - defined(${/if/compiler/gnuc:/name})
+description: null
+enabled-by: true
+interface-type: macro
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: /groups/api/basedefs
+name: RTEMS_PRINTFLIKE
+notes: null
+params:
- description: |
is the position of the format parameter index (starting with one).
dir: null
@@ -25,13 +31,7 @@ interface-params:
one).
dir: null
name: _ap_pos
-interface-return:
+return:
return: null
return-values: []
-interface-type: macro
-links:
-- role: interface-placement
- uid: header
-- role: interface-ingroup
- uid: /groups/api/basedefs
type: interface
diff --git a/spec/if/rtems/basedefs/pure.yml b/spec/if/rtems/basedefs/pure.yml
index 63f10204..82b2fa13 100644
--- a/spec/if/rtems/basedefs/pure.yml
+++ b/spec/if/rtems/basedefs/pure.yml
@@ -1,25 +1,25 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2011 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
+brief: |
Tells the compiler in a function declaration that this function has no effect
except the return value and that the return value depends only on the value
of parameters and/or global variables.
-interface-definition:
+copyrights:
+- Copyright (C) 2011 On-Line Applications Research Corporation (OAR)
+definition:
default: ''
variants:
- definition: |
__attribute__((__pure__))
enabled-by:
- - defined(${/if/compiler/gnuc:/interface-name})
-interface-description: null
-interface-name: RTEMS_PURE
-interface-notes: null
+ - defined(${/if/compiler/gnuc:/name})
+description: null
+enabled-by: true
interface-type: define
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_PURE
+notes: null
type: interface
diff --git a/spec/if/rtems/basedefs/return-address.yml b/spec/if/rtems/basedefs/return-address.yml
index 6302589c..9102f3b6 100644
--- a/spec/if/rtems/basedefs/return-address.yml
+++ b/spec/if/rtems/basedefs/return-address.yml
@@ -1,27 +1,27 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the return address of the current function.
copyrights:
- Copyright (C) 2019 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the return address of the current function.
-interface-definition:
- default: ${/if/c/null:/interface-name}
+definition:
+ default: ${/if/c/null:/name}
variants:
- definition: |
- ${/if/compiler/builtin-return-address:/interface-name}(0)
+ ${/if/compiler/builtin-return-address:/name}(0)
enabled-by:
- - defined(${/if/compiler/gnuc:/interface-name})
-interface-description: null
-interface-name: RTEMS_RETURN_ADDRESS
-interface-notes: null
-interface-params: []
-interface-return:
- return: The return address of the current function.
- return-values: []
+ - defined(${/if/compiler/gnuc:/name})
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_RETURN_ADDRESS
+notes: null
+params: []
+return:
+ return: The return address of the current function.
+ return-values: []
type: interface
diff --git a/spec/if/rtems/basedefs/section.yml b/spec/if/rtems/basedefs/section.yml
index 00e46544..4f5cc9ad 100644
--- a/spec/if/rtems/basedefs/section.yml
+++ b/spec/if/rtems/basedefs/section.yml
@@ -1,32 +1,32 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2015 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Instructs the compiler to place a specific variable or function in the
specified section.
-interface-definition:
+copyrights:
+- Copyright (C) 2015 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default: ''
variants:
- definition: |
__attribute__((__section__(_section)))
enabled-by:
- - defined(${/if/compiler/gnuc:/interface-name})
-interface-description: null
-interface-name: RTEMS_SECTION
-interface-notes: null
-interface-params:
-- description: |
- is the section name as a string.
- dir: null
- name: _section
-interface-return:
- return: null
- return-values: []
+ - defined(${/if/compiler/gnuc:/name})
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_SECTION
+notes: null
+params:
+- description: |
+ is the section name as a string.
+ dir: null
+ name: _section
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/basedefs/static-assert.yml b/spec/if/rtems/basedefs/static-assert.yml
index c31eafa8..c7950523 100644
--- a/spec/if/rtems/basedefs/static-assert.yml
+++ b/spec/if/rtems/basedefs/static-assert.yml
@@ -1,10 +1,9 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Asserts at compile time that the specified condition is satisfied.
copyrights:
- Copyright (C) 2011, 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Asserts at compile time that the specified condition is satisfied.
-interface-definition:
+definition:
default: |
struct rtems_static_assert_ ## _msg
{ int rtems_static_assert_ ## _msg : (_cond) ? 1 : -1; }
@@ -12,15 +11,22 @@ interface-definition:
- definition: |
static_assert(_cond, # _msg)
enabled-by:
- - ${/if/compiler/cplusplus:/interface-name} >= 201103L
+ - ${/if/compiler/cplusplus:/name} >= 201103L
- definition: |
_Static_assert(_cond, # _msg)
enabled-by:
- - ${/if/compiler/stdc-version:/interface-name} >= 201112L
-interface-description: null
-interface-name: RTEMS_STATIC_ASSERT
-interface-notes: null
-interface-params:
+ - ${/if/compiler/stdc-version:/name} >= 201112L
+description: null
+enabled-by: true
+interface-type: macro
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: /groups/api/basedefs
+name: RTEMS_STATIC_ASSERT
+notes: null
+params:
- description: |
is the condition this static assertion shall satisfy.
dir: null
@@ -29,13 +35,7 @@ interface-params:
is the error message in case the static assertion fails.
dir: null
name: _msg
-interface-return:
+return:
return: null
return-values: []
-interface-type: macro
-links:
-- role: interface-placement
- uid: header
-- role: interface-ingroup
- uid: /groups/api/basedefs
type: interface
diff --git a/spec/if/rtems/basedefs/string.yml b/spec/if/rtems/basedefs/string.yml
index ac67e0d2..8fbfa1ef 100644
--- a/spec/if/rtems/basedefs/string.yml
+++ b/spec/if/rtems/basedefs/string.yml
@@ -1,28 +1,28 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Stringifies _x without expanding.
copyrights:
- Copyright (C) 2015 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Stringifies _x without expanding.
-interface-definition:
+definition:
default: '#_x'
variants: []
-interface-description: null
-interface-name: RTEMS_STRING
-interface-notes: null
-interface-params:
+description: null
+enabled-by: true
+interface-type: macro
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: /groups/api/basedefs
+name: RTEMS_STRING
+notes: null
+params:
- description: |
is the token to stringify.
dir: null
name: _x
-interface-return:
+return:
return: |
The stringification of the token _x.
return-values: []
-interface-type: macro
-links:
-- role: interface-placement
- uid: header
-- role: interface-ingroup
- uid: /groups/api/basedefs
type: interface
diff --git a/spec/if/rtems/basedefs/symbol-name.yml b/spec/if/rtems/basedefs/symbol-name.yml
index 44b49b04..6e095ad7 100644
--- a/spec/if/rtems/basedefs/symbol-name.yml
+++ b/spec/if/rtems/basedefs/symbol-name.yml
@@ -1,33 +1,33 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Constructs a symbol name.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Constructs a symbol name.
-interface-definition:
+definition:
default: |
- ${expand:/interface-name}(_name)
+ ${expand:/name}(_name)
variants:
- definition: |
- ${xconcat:/interface-name}(${/if/compiler/user-label-prefix:/interface-name}, _name)
+ ${xconcat:/name}(${/if/compiler/user-label-prefix:/name}, _name)
enabled-by:
- - defined(${/if/compiler/user-label-prefix:/interface-name})
-interface-description: null
-interface-name: RTEMS_SYMBOL_NAME
-interface-notes: null
-interface-params:
+ - defined(${/if/compiler/user-label-prefix:/name})
+description: null
+enabled-by: true
+interface-type: macro
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: /groups/api/basedefs
+name: RTEMS_SYMBOL_NAME
+notes: null
+params:
- description: |
is the user defined name of the symbol. The name shall be a valid
designator. On the name a macro expansion is performed.
dir: null
name: _name
-interface-return:
+return:
return: null
return-values: []
-interface-type: macro
-links:
-- role: interface-placement
- uid: header
-- role: interface-ingroup
- uid: /groups/api/basedefs
type: interface
diff --git a/spec/if/rtems/basedefs/true.yml b/spec/if/rtems/basedefs/true.yml
index 8b3ed397..77931f23 100644
--- a/spec/if/rtems/basedefs/true.yml
+++ b/spec/if/rtems/basedefs/true.yml
@@ -1,19 +1,19 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: If TRUE is undefined, then TRUE is defined to 1.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by:
-- not: 'TRUE'
-interface-brief: If TRUE is undefined, then TRUE is defined to 1.
-interface-definition:
+definition:
default: '1'
variants: []
-interface-description: null
-interface-name: 'TRUE'
-interface-notes: null
+description: null
+enabled-by:
+- not: 'TRUE'
interface-type: define
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: 'TRUE'
+notes: null
type: interface
diff --git a/spec/if/rtems/basedefs/typeof-refx.yml b/spec/if/rtems/basedefs/typeof-refx.yml
index 00616b9c..15299927 100644
--- a/spec/if/rtems/basedefs/typeof-refx.yml
+++ b/spec/if/rtems/basedefs/typeof-refx.yml
@@ -1,22 +1,28 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the type of a pointer reference of the specified level to the specified type.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2014 Paval Pisa
-enabled-by: true
-interface-brief: |
- Returns the type of a pointer reference of the specified level to the specified type.
-interface-definition:
+definition:
default: ''
variants:
- definition: |
- ${/if/compiler/typeof:/interface-name}(_level(union { int z; ${/if/compiler/typeof:/interface-name}(_target) x; }){0}.x)
+ ${/if/compiler/typeof:/name}(_level(union { int z; ${/if/compiler/typeof:/name}(_target) x; }){0}.x)
enabled-by:
- - defined(${/if/compiler/gnuc:/interface-name})
-interface-description: |
+ - defined(${/if/compiler/gnuc:/name})
+description: |
The reference type idea is based on libHX by Jan Engelhardt.
-interface-name: RTEMS_TYPEOF_REFX
-interface-notes: null
-interface-params:
+enabled-by: true
+interface-type: macro
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: /groups/api/basedefs
+name: RTEMS_TYPEOF_REFX
+notes: null
+params:
- description: |
is the pointer indirection level expressed in *.
dir: null
@@ -25,13 +31,7 @@ interface-params:
is the reference target type.
dir: null
name: _target
-interface-return:
+return:
return: null
return-values: []
-interface-type: macro
-links:
-- role: interface-placement
- uid: header
-- role: interface-ingroup
- uid: /groups/api/basedefs
type: interface
diff --git a/spec/if/rtems/basedefs/unreachable.yml b/spec/if/rtems/basedefs/unreachable.yml
index b2600487..97cbd4ae 100644
--- a/spec/if/rtems/basedefs/unreachable.yml
+++ b/spec/if/rtems/basedefs/unreachable.yml
@@ -1,29 +1,29 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Tells the compiler that this program point is unreachable.
copyrights:
- Copyright (C) 2016 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Tells the compiler that this program point is unreachable.
-interface-definition:
+definition:
default: |
- ${/if/impl/assert-unreachable:/interface-name}()
+ ${/if/impl/assert-unreachable:/name}()
variants:
- definition: |
do {
- ${/if/compiler/builtin-unreachable:/interface-name}();
- ${/if/impl/assert-unreachable:/interface-name}();
+ ${/if/compiler/builtin-unreachable:/name}();
+ ${/if/impl/assert-unreachable:/name}();
} while ( 0 )
enabled-by:
- - defined(${/if/compiler/gnuc:/interface-name})
-interface-description: null
-interface-name: RTEMS_UNREACHABLE
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+ - defined(${/if/compiler/gnuc:/name})
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
+name: RTEMS_UNREACHABLE
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/basedefs/unused.yml b/spec/if/rtems/basedefs/unused.yml
index beef36d5..5c0ae9c4 100644
--- a/spec/if/rtems/basedefs/unused.yml
+++ b/spec/if/rtems/basedefs/unused.yml
@@ -1,24 +1,24 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2013 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
+brief: |
Tells the compiler that a specific variable or function is deliberately
unused.
-interface-definition:
+copyrights:
+- Copyright (C) 2013 On-Line Applications Research Corporation (OAR)
+definition:
default: ''
variants:
- definition: |
__attribute__((__unused__))
enabled-by:
- - defined(${/if/compiler/gnuc:/interface-name})
-interface-description: null
-interface-name: RTEMS_UNUSED
-interface-notes: null
+ - defined(${/if/compiler/gnuc:/name})
+description: null
+enabled-by: true
interface-type: define
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_UNUSED
+notes: null
type: interface
diff --git a/spec/if/rtems/basedefs/used.yml b/spec/if/rtems/basedefs/used.yml
index b2e7e6a1..cac6c57a 100644
--- a/spec/if/rtems/basedefs/used.yml
+++ b/spec/if/rtems/basedefs/used.yml
@@ -1,23 +1,23 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Tells the compiler that a specific variable or function is used.
copyrights:
- Copyright (C) 2009 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Tells the compiler that a specific variable or function is used.
-interface-definition:
+definition:
default: ''
variants:
- definition: |
__attribute__((__used__))
enabled-by:
- - defined(${/if/compiler/gnuc:/interface-name})
-interface-description: null
-interface-name: RTEMS_USED
-interface-notes: null
+ - defined(${/if/compiler/gnuc:/name})
+description: null
+enabled-by: true
interface-type: define
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_USED
+notes: null
type: interface
diff --git a/spec/if/rtems/basedefs/warn-unused-result.yml b/spec/if/rtems/basedefs/warn-unused-result.yml
index bb8871d1..85fa2d3a 100644
--- a/spec/if/rtems/basedefs/warn-unused-result.yml
+++ b/spec/if/rtems/basedefs/warn-unused-result.yml
@@ -1,24 +1,24 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Tells the compiler in a declaration that the result of this function should
be used.
-interface-definition:
+copyrights:
+- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default: ''
variants:
- definition: |
__attribute__((__warn_unused_result__))
enabled-by:
- - defined(${/if/compiler/gnuc:/interface-name})
-interface-description: null
-interface-name: RTEMS_WARN_UNUSED_RESULT
-interface-notes: null
+ - defined(${/if/compiler/gnuc:/name})
+description: null
+enabled-by: true
interface-type: define
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_WARN_UNUSED_RESULT
+notes: null
type: interface
diff --git a/spec/if/rtems/basedefs/weak-alias.yml b/spec/if/rtems/basedefs/weak-alias.yml
index a73108fd..774cee32 100644
--- a/spec/if/rtems/basedefs/weak-alias.yml
+++ b/spec/if/rtems/basedefs/weak-alias.yml
@@ -1,32 +1,32 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2017 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Instructs the compiler to generate a weak alias to the specified target
function.
-interface-definition:
+copyrights:
+- Copyright (C) 2017 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default: ''
variants:
- definition: |
__attribute__((__weak__, __alias__(#_target)))
enabled-by:
- - defined(${/if/compiler/gnuc:/interface-name})
-interface-description: null
-interface-name: RTEMS_WEAK_ALIAS
-interface-notes: null
-interface-params:
-- description: |
- is the target function name.
- dir: null
- name: _target
-interface-return:
- return: null
- return-values: []
+ - defined(${/if/compiler/gnuc:/name})
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_WEAK_ALIAS
+notes: null
+params:
+- description: |
+ is the target function name.
+ dir: null
+ name: _target
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/basedefs/weak.yml b/spec/if/rtems/basedefs/weak.yml
index 9ee84ab6..efb679f4 100644
--- a/spec/if/rtems/basedefs/weak.yml
+++ b/spec/if/rtems/basedefs/weak.yml
@@ -1,26 +1,26 @@
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-brief: |
+brief: |
Tells the compiler in a function definition that this function should be
weak.
-interface-definition:
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default: ''
variants:
- definition: |
__attribute__((__weak__))
enabled-by:
- - defined(${/if/compiler/gnuc:/interface-name})
-interface-description: |
+ - defined(${/if/compiler/gnuc:/name})
+description: |
Use this attribute for function definitions. Do not use it for function
declarations.
-interface-name: RTEMS_WEAK
-interface-notes: null
+enabled-by: true
interface-type: define
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_WEAK
+notes: null
type: interface
diff --git a/spec/if/rtems/basedefs/xconcat.yml b/spec/if/rtems/basedefs/xconcat.yml
index 283f531b..1b8b7591 100644
--- a/spec/if/rtems/basedefs/xconcat.yml
+++ b/spec/if/rtems/basedefs/xconcat.yml
@@ -1,16 +1,22 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Concatenates expansion of _x and expansion of _y.
copyrights:
- Copyright (C) 2015 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Concatenates expansion of _x and expansion of _y.
-interface-definition:
- default: ${concat:/interface-name}( _x, _y )
+definition:
+ default: ${concat:/name}( _x, _y )
variants: []
-interface-description: null
-interface-name: RTEMS_XCONCAT
-interface-notes: null
-interface-params:
+description: null
+enabled-by: true
+interface-type: macro
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: /groups/api/basedefs
+name: RTEMS_XCONCAT
+notes: null
+params:
- description: |
is expanded first and then used as the left hand side token of the
concatenation.
@@ -21,14 +27,8 @@ interface-params:
concatenation.
dir: null
name: _y
-interface-return:
+return:
return: |
The concatenation of the expansions of tokens _x and _y.
return-values: []
-interface-type: macro
-links:
-- role: interface-placement
- uid: header
-- role: interface-ingroup
- uid: /groups/api/basedefs
type: interface
diff --git a/spec/if/rtems/basedefs/xstring.yml b/spec/if/rtems/basedefs/xstring.yml
index 0593c0a5..0a01ab68 100644
--- a/spec/if/rtems/basedefs/xstring.yml
+++ b/spec/if/rtems/basedefs/xstring.yml
@@ -1,28 +1,28 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Stringifies the expansion of _x.
copyrights:
- Copyright (C) 2015 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Stringifies the expansion of _x.
-interface-definition:
- default: ${string:/interface-name}( _x )
+definition:
+ default: ${string:/name}( _x )
variants: []
-interface-description: null
-interface-name: RTEMS_XSTRING
-interface-notes: null
-interface-params:
+description: null
+enabled-by: true
+interface-type: macro
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: /groups/api/basedefs
+name: RTEMS_XSTRING
+notes: null
+params:
- description: |
is the token expand and stringify.
dir: null
name: _x
-interface-return:
+return:
return: |
The stringification of the expansion of token _x.
return-values: []
-interface-type: macro
-links:
-- role: interface-placement
- uid: header
-- role: interface-ingroup
- uid: /groups/api/basedefs
type: interface
diff --git a/spec/if/rtems/basedefs/zero-length-array.yml b/spec/if/rtems/basedefs/zero-length-array.yml
index fc507e6f..2dc6639d 100644
--- a/spec/if/rtems/basedefs/zero-length-array.yml
+++ b/spec/if/rtems/basedefs/zero-length-array.yml
@@ -1,22 +1,22 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This is a constant to declare zero-length arrays.
copyrights:
- Copyright (C) 2014 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- This is a constant to declare zero-length arrays.
-interface-definition:
+definition:
default: '0'
variants: []
-interface-description: |
+description: |
Zero-length arrays are valid in C99 as flexible array members. C++11 does
not allow flexible array members. Use the GNU extension which is also
supported by other compilers.
-interface-name: RTEMS_ZERO_LENGTH_ARRAY
-interface-notes: null
+enabled-by: true
interface-type: define
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/basedefs
+name: RTEMS_ZERO_LENGTH_ARRAY
+notes: null
type: interface
diff --git a/spec/if/rtems/config/api-table.yml b/spec/if/rtems/config/api-table.yml
index 74eccb12..32f1eb06 100644
--- a/spec/if/rtems/config/api-table.yml
+++ b/spec/if/rtems/config/api-table.yml
@@ -1,117 +1,129 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This structure contains a summary of the Classic API configuration.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This structure contains a summary of the Classic API configuration.
-interface-definition:
+definition:
- default:
brief: |
This field contains the maximum number of Classic API Tasks which are
configured for this application.
- definition: ${/if/c/uint32_t:/interface-name} maximum_tasks
+ definition: ${/if/c/uint32_t:/name} ${.:name}
description: null
kind: member
+ name: maximum_tasks
variants: []
- default:
brief: |
This field indicates if Classic API Notepads are enabled or disabled for
this application.
- definition: ${/if/c/bool:/interface-name} notepads_enabled
+ definition: ${/if/c/bool:/name} ${.:name}
description: null
kind: member
+ name: notepads_enabled
variants: []
- default:
brief: |
This field contains the maximum number of Classic API Timers which are
configured for this application.
- definition: ${/if/c/uint32_t:/interface-name} maximum_timers
+ definition: ${/if/c/uint32_t:/name} ${.:name}
description: null
kind: member
+ name: maximum_timers
variants: []
- default:
brief: |
This field contains the maximum number of Classic API Semaphores which
are configured for this application.
- definition: ${/if/c/uint32_t:/interface-name} maximum_semaphores
+ definition: ${/if/c/uint32_t:/name} ${.:name}
description: null
kind: member
+ name: maximum_semaphores
variants: []
- default:
brief: |
This field contains the maximum number of Classic API Message Queues
which are configured for this application.
- definition: ${/if/c/uint32_t:/interface-name} maximum_message_queues
+ definition: ${/if/c/uint32_t:/name} ${.:name}
description: null
kind: member
+ name: maximum_message_queues
variants: []
- default:
brief: |
This field contains the maximum number of Classic API Partitions which
are configured for this application.
- definition: ${/if/c/uint32_t:/interface-name} maximum_partitions
+ definition: ${/if/c/uint32_t:/name} ${.:name}
description: null
kind: member
+ name: maximum_partitions
variants: []
- default:
brief: |
This field contains the maximum number of Classic API Regions which are
configured for this application.
- definition: ${/if/c/uint32_t:/interface-name} maximum_regions
+ definition: ${/if/c/uint32_t:/name} ${.:name}
description: null
kind: member
+ name: maximum_regions
variants: []
- default:
brief: |
This field contains the maximum number of Classic API Dual Ported Memory
Areas which are configured for this application.
- definition: ${/if/c/uint32_t:/interface-name} maximum_ports
+ definition: ${/if/c/uint32_t:/name} ${.:name}
description: null
kind: member
+ name: maximum_ports
variants: []
- default:
brief: |
This field contains the maximum number of Classic API Rate Monotonic
Periods which are configured for this application.
- definition: ${/if/c/uint32_t:/interface-name} maximum_periods
+ definition: ${/if/c/uint32_t:/name} ${.:name}
description: null
kind: member
+ name: maximum_periods
variants: []
- default:
brief: |
This field contains the maximum number of Classic API Barriers which are
configured for this application.
- definition: ${/if/c/uint32_t:/interface-name} maximum_barriers
+ definition: ${/if/c/uint32_t:/name} ${.:name}
description: null
kind: member
+ name: maximum_barriers
variants: []
- default:
brief: |
This field contains the number of Classic API Initialization
Tasks which are configured for this application.
- definition: ${/if/c/uint32_t:/interface-name} number_of_initialization_tasks
+ definition: ${/if/c/uint32_t:/name} ${.:name}
description: null
kind: member
+ name: number_of_initialization_tasks
variants: []
- default:
brief: |
This field contains the pointer to Classic API Initialization Tasks Table
of this application.
- definition: const rtems_initialization_tasks_table *User_initialization_tasks_table
+ definition: const rtems_initialization_tasks_table *${.:name}
description: null
kind: member
+ name: User_initialization_tasks_table
variants: []
-interface-definition-kind: typedef-only
-interface-description: |
- Use ${get-api-configuration:/interface-name}() to get the configuration
+definition-kind: typedef-only
+description: |
+ Use ${get-api-configuration:/name}() to get the configuration
table.
-interface-name: rtems_api_configuration_table
-interface-notes: null
+enabled-by: true
interface-type: struct
links:
- role: interface-placement
uid: header-2
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_api_configuration_table
+notes: null
type: interface
diff --git a/spec/if/rtems/config/get-api-configuration.yml b/spec/if/rtems/config/get-api-configuration.yml
index 077a84d2..4f6ce3a7 100644
--- a/spec/if/rtems/config/get-api-configuration.yml
+++ b/spec/if/rtems/config/get-api-configuration.yml
@@ -1,25 +1,25 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the pointer to the Classic API Configuration Table of this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the pointer to the Classic API Configuration Table of this application.
-interface-definition:
+definition:
default:
params: []
return: const rtems_api_configuration_table *
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_rtems_api_configuration
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header-2
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_rtems_api_configuration
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-do-zero-of-workspace.yml b/spec/if/rtems/config/get-do-zero-of-workspace.yml
index 22d92764..d3e4e29b 100644
--- a/spec/if/rtems/config/get-do-zero-of-workspace.yml
+++ b/spec/if/rtems/config/get-do-zero-of-workspace.yml
@@ -1,24 +1,24 @@
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-brief: |
+brief: |
Returns true, if the workspace is zeroed during system initialization,
otherwise returns false.
-interface-definition:
- default: ${/if/impl/memory/zero-before-use:/interface-name}
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
+ default: ${/if/impl/memory/zero-before-use:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_do_zero_of_workspace
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_do_zero_of_workspace
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-idle-task-stack-size.yml b/spec/if/rtems/config/get-idle-task-stack-size.yml
index 57ba76c3..04618bf2 100644
--- a/spec/if/rtems/config/get-idle-task-stack-size.yml
+++ b/spec/if/rtems/config/get-idle-task-stack-size.yml
@@ -1,23 +1,23 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the configured IDLE task stack size in bytes of this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the configured IDLE task stack size in bytes of this application.
-interface-definition:
- default: ${/if/impl/thread/idle-stack-size:/interface-name}
+definition:
+ default: ${/if/impl/thread/idle-stack-size:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_idle_task_stack_size
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_idle_task_stack_size
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-idle-task.yml b/spec/if/rtems/config/get-idle-task.yml
index 560d264c..5ad43ab7 100644
--- a/spec/if/rtems/config/get-idle-task.yml
+++ b/spec/if/rtems/config/get-idle-task.yml
@@ -1,23 +1,23 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the configured IDLE task entry of this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the configured IDLE task entry of this application.
-interface-definition:
- default: ${/if/impl/thread/idle-body:/interface-name}
+definition:
+ default: ${/if/impl/thread/idle-body:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_idle_task
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_idle_task
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-interrupt-stack-size.yml b/spec/if/rtems/config/get-interrupt-stack-size.yml
index ca6bbaff..06e0c275 100644
--- a/spec/if/rtems/config/get-interrupt-stack-size.yml
+++ b/spec/if/rtems/config/get-interrupt-stack-size.yml
@@ -1,23 +1,23 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the configured interrupt stack size in bytes of this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the configured interrupt stack size in bytes of this application.
-interface-definition:
- default: ((${/if/c/size_t:/interface-name}) ${/if/impl/isr/stack-size:/interface-name})
+definition:
+ default: ((${/if/c/size_t:/name}) ${/if/impl/isr/stack-size:/name})
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_interrupt_stack_size
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_interrupt_stack_size
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-maximum-barriers.yml b/spec/if/rtems/config/get-maximum-barriers.yml
index 6b400041..ef4a519f 100644
--- a/spec/if/rtems/config/get-maximum-barriers.yml
+++ b/spec/if/rtems/config/get-maximum-barriers.yml
@@ -1,26 +1,26 @@
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-brief: |
+brief: |
Returns the maximum number of Classic API Barriers which are configured for
this application.
-interface-definition:
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default:
params: []
- return: ${/if/c/uint32_t:/interface-name}
+ return: ${/if/c/uint32_t:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_maximum_barriers
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header-2
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_maximum_barriers
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-maximum-extensions.yml b/spec/if/rtems/config/get-maximum-extensions.yml
index be808032..dcfc17bb 100644
--- a/spec/if/rtems/config/get-maximum-extensions.yml
+++ b/spec/if/rtems/config/get-maximum-extensions.yml
@@ -1,26 +1,26 @@
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-brief: |
+brief: |
Returns the maximum number of Classic API User Extensions which are
configured for this application.
-interface-definition:
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default:
params: []
- return: ${/if/c/uint32_t:/interface-name}
+ return: ${/if/c/uint32_t:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_maximum_extensions
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_maximum_extensions
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-maximum-message-queues.yml b/spec/if/rtems/config/get-maximum-message-queues.yml
index dd2d367c..1eeb35f7 100644
--- a/spec/if/rtems/config/get-maximum-message-queues.yml
+++ b/spec/if/rtems/config/get-maximum-message-queues.yml
@@ -1,26 +1,26 @@
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-brief: |
+brief: |
Returns the maximum number of Classic API Message Queues which are configured
for this application.
-interface-definition:
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default:
params: []
- return: ${/if/c/uint32_t:/interface-name}
+ return: ${/if/c/uint32_t:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_maximum_message_queues
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header-2
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_maximum_message_queues
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-maximum-partitions.yml b/spec/if/rtems/config/get-maximum-partitions.yml
index faa960b0..1d2c5e8c 100644
--- a/spec/if/rtems/config/get-maximum-partitions.yml
+++ b/spec/if/rtems/config/get-maximum-partitions.yml
@@ -1,26 +1,26 @@
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-brief: |
+brief: |
Returns the maximum number of Classic API Partitions which are configured for
this application.
-interface-definition:
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default:
params: []
- return: ${/if/c/uint32_t:/interface-name}
+ return: ${/if/c/uint32_t:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_maximum_partitions
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header-2
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_maximum_partitions
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-maximum-periods.yml b/spec/if/rtems/config/get-maximum-periods.yml
index 5b569cb6..2a66e63c 100644
--- a/spec/if/rtems/config/get-maximum-periods.yml
+++ b/spec/if/rtems/config/get-maximum-periods.yml
@@ -1,26 +1,26 @@
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-brief: |
+brief: |
Returns the maximum number of Classic API Rate Monotonic Periods which are
configured for this application.
-interface-definition:
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default:
params: []
- return: ${/if/c/uint32_t:/interface-name}
+ return: ${/if/c/uint32_t:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_maximum_periods
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header-2
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_maximum_periods
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-maximum-ports.yml b/spec/if/rtems/config/get-maximum-ports.yml
index 792deb79..ccc0a8f5 100644
--- a/spec/if/rtems/config/get-maximum-ports.yml
+++ b/spec/if/rtems/config/get-maximum-ports.yml
@@ -1,26 +1,26 @@
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-brief: |
+brief: |
Returns the maximum number of Classic API Dual Ported Memory Areas which are
configured for this application.
-interface-definition:
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default:
params: []
- return: ${/if/c/uint32_t:/interface-name}
+ return: ${/if/c/uint32_t:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_maximum_ports
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header-2
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_maximum_ports
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-maximum-processors.yml b/spec/if/rtems/config/get-maximum-processors.yml
index a52a6e23..594fece3 100644
--- a/spec/if/rtems/config/get-maximum-processors.yml
+++ b/spec/if/rtems/config/get-maximum-processors.yml
@@ -1,29 +1,29 @@
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-brief: |
+brief: |
Returns the maximum number of processors which are configured for this
application.
-interface-definition:
- default: ${/if/impl/smp/processor-configured-maximum:/interface-name}
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
+ default: ${/if/impl/smp/processor-configured-maximum:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_maximum_processors
-interface-notes: |
+description: null
+enabled-by: true
+interface-type: macro
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: /groups/api/config
+name: rtems_configuration_get_maximum_processors
+notes: |
The actual number of processors available for the application will be less
than or equal to the configured maximum number of processors.
On uniprocessor configurations this macro is a compile time constant which
evaluates to one.
-interface-params: []
-interface-return:
+params: []
+return:
return: null
return-values: []
-interface-type: macro
-links:
-- role: interface-placement
- uid: header
-- role: interface-ingroup
- uid: /groups/api/config
type: interface
diff --git a/spec/if/rtems/config/get-maximum-regions.yml b/spec/if/rtems/config/get-maximum-regions.yml
index efd251d2..4f5d8715 100644
--- a/spec/if/rtems/config/get-maximum-regions.yml
+++ b/spec/if/rtems/config/get-maximum-regions.yml
@@ -1,26 +1,26 @@
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-brief: |
+brief: |
Returns the maximum number of Classic API Regions which are configured for
this application.
-interface-definition:
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default:
params: []
- return: ${/if/c/uint32_t:/interface-name}
+ return: ${/if/c/uint32_t:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_maximum_regions
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header-2
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_maximum_regions
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-maximum-semaphores.yml b/spec/if/rtems/config/get-maximum-semaphores.yml
index 46fbec45..f0506c50 100644
--- a/spec/if/rtems/config/get-maximum-semaphores.yml
+++ b/spec/if/rtems/config/get-maximum-semaphores.yml
@@ -1,26 +1,26 @@
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-brief: |
+brief: |
Returns the maximum number of Classic API Semaphores which are configured for
this application.
-interface-definition:
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default:
params: []
- return: ${/if/c/uint32_t:/interface-name}
+ return: ${/if/c/uint32_t:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_maximum_semaphores
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header-2
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_maximum_semaphores
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-maximum-tasks.yml b/spec/if/rtems/config/get-maximum-tasks.yml
index 6f855d9e..4e027e0f 100644
--- a/spec/if/rtems/config/get-maximum-tasks.yml
+++ b/spec/if/rtems/config/get-maximum-tasks.yml
@@ -1,26 +1,26 @@
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-brief: |
+brief: |
Returns the maximum number of Classic API Tasks which are configured for this
application.
-interface-definition:
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default:
params: []
- return: ${/if/c/uint32_t:/interface-name}
+ return: ${/if/c/uint32_t:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_maximum_tasks
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header-2
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_maximum_tasks
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-maximum-timers.yml b/spec/if/rtems/config/get-maximum-timers.yml
index 43700c8e..1961ed63 100644
--- a/spec/if/rtems/config/get-maximum-timers.yml
+++ b/spec/if/rtems/config/get-maximum-timers.yml
@@ -1,26 +1,26 @@
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-brief: |
+brief: |
Returns the maximum number of Classic API Timers which are configured for
this application.
-interface-definition:
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default:
params: []
- return: ${/if/c/uint32_t:/interface-name}
+ return: ${/if/c/uint32_t:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_maximum_timers
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header-2
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_maximum_timers
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-microseconds-per-tick.yml b/spec/if/rtems/config/get-microseconds-per-tick.yml
index bce672f7..8ddf1636 100644
--- a/spec/if/rtems/config/get-microseconds-per-tick.yml
+++ b/spec/if/rtems/config/get-microseconds-per-tick.yml
@@ -1,23 +1,23 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the number of microseconds per tick configured for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the number of microseconds per tick configured for this application.
-interface-definition:
- default: ${/if/impl/watchdog/microseconds-per-tick:/interface-name}
+definition:
+ default: ${/if/impl/watchdog/microseconds-per-tick:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_microseconds_per_tick
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_microseconds_per_tick
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-milliseconds-per-tick.yml b/spec/if/rtems/config/get-milliseconds-per-tick.yml
index 207d1a6b..3a5a5b15 100644
--- a/spec/if/rtems/config/get-milliseconds-per-tick.yml
+++ b/spec/if/rtems/config/get-milliseconds-per-tick.yml
@@ -1,23 +1,23 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the number of milliseconds per tick configured for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the number of milliseconds per tick configured for this application.
-interface-definition:
- default: (${/if/impl/watchdog/microseconds-per-tick:/interface-name} / 1000)
+definition:
+ default: (${/if/impl/watchdog/microseconds-per-tick:/name} / 1000)
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_milliseconds_per_tick
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_milliseconds_per_tick
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-nanoseconds-per-tick.yml b/spec/if/rtems/config/get-nanoseconds-per-tick.yml
index abca907a..63155fd6 100644
--- a/spec/if/rtems/config/get-nanoseconds-per-tick.yml
+++ b/spec/if/rtems/config/get-nanoseconds-per-tick.yml
@@ -1,23 +1,23 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the number of microseconds per tick configured for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the number of microseconds per tick configured for this application.
-interface-definition:
- default: ${/if/impl/watchdog/nanoseconds-per-tick:/interface-name}
+definition:
+ default: ${/if/impl/watchdog/nanoseconds-per-tick:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_nanoseconds_per_tick
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_nanoseconds_per_tick
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-number-of-initial-extensions.yml b/spec/if/rtems/config/get-number-of-initial-extensions.yml
index 283caa7d..9a3d84f1 100644
--- a/spec/if/rtems/config/get-number-of-initial-extensions.yml
+++ b/spec/if/rtems/config/get-number-of-initial-extensions.yml
@@ -1,23 +1,23 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the number of initial extensions configured for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the number of initial extensions configured for this application.
-interface-definition:
- default: ((${/if/c/uint32_t:/interface-name}) ${/if/impl/userext/initial-count:/interface-name})
+definition:
+ default: ((${/if/c/uint32_t:/name}) ${/if/impl/userext/initial-count:/name})
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_number_of_initial_extensions
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_number_of_initial_extensions
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-stack-allocate-hook.yml b/spec/if/rtems/config/get-stack-allocate-hook.yml
index 9ad0dbdc..0a6b236b 100644
--- a/spec/if/rtems/config/get-stack-allocate-hook.yml
+++ b/spec/if/rtems/config/get-stack-allocate-hook.yml
@@ -1,23 +1,23 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the thread stack allocator allocate hook.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the thread stack allocator allocate hook.
-interface-definition:
- default: ${/if/impl/stack/allocator-allocate:/interface-name}
+definition:
+ default: ${/if/impl/stack/allocator-allocate:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_stack_allocate_hook
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_stack_allocate_hook
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-stack-allocate-init-hook.yml b/spec/if/rtems/config/get-stack-allocate-init-hook.yml
index 35519031..ddf7dc98 100644
--- a/spec/if/rtems/config/get-stack-allocate-init-hook.yml
+++ b/spec/if/rtems/config/get-stack-allocate-init-hook.yml
@@ -1,23 +1,23 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the thread stack allocator initialization hook.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the thread stack allocator initialization hook.
-interface-definition:
- default: ${/if/impl/stack/allocator-initialize:/interface-name}
+definition:
+ default: ${/if/impl/stack/allocator-initialize:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_stack_allocate_init_hook
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_stack_allocate_init_hook
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-stack-allocator-avoids-work-space.yml b/spec/if/rtems/config/get-stack-allocator-avoids-work-space.yml
index e8cd8554..9e40c8fb 100644
--- a/spec/if/rtems/config/get-stack-allocator-avoids-work-space.yml
+++ b/spec/if/rtems/config/get-stack-allocator-avoids-work-space.yml
@@ -1,24 +1,24 @@
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-brief: |
+brief: |
Returns true, if the thread stack allocator avoids the workspace, otherwise
returns false.
-interface-definition:
- default: ${/if/impl/stack/allocator-avoids-workspace:/interface-name}
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
+ default: ${/if/impl/stack/allocator-avoids-workspace:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_stack_allocator_avoids_work_space
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_stack_allocator_avoids_work_space
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-stack-free-hook.yml b/spec/if/rtems/config/get-stack-free-hook.yml
index 70bd32e0..112428ab 100644
--- a/spec/if/rtems/config/get-stack-free-hook.yml
+++ b/spec/if/rtems/config/get-stack-free-hook.yml
@@ -1,23 +1,23 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the thread stack allocator free hook.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the thread stack allocator free hook.
-interface-definition:
- default: ${/if/impl/stack/allocator-free:/interface-name}
+definition:
+ default: ${/if/impl/stack/allocator-free:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_stack_free_hook
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_stack_free_hook
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-stack-space-size.yml b/spec/if/rtems/config/get-stack-space-size.yml
index 98b5b457..5b17cbea 100644
--- a/spec/if/rtems/config/get-stack-space-size.yml
+++ b/spec/if/rtems/config/get-stack-space-size.yml
@@ -1,26 +1,26 @@
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-brief: |
+brief: |
Returns the thread stack space size in bytes of configured for this
application.
-interface-definition:
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default:
params: []
- return: ${/if/c/uintptr_t:/interface-name}
+ return: ${/if/c/uintptr_t:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_stack_space_size
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_stack_space_size
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-ticks-per-timeslice.yml b/spec/if/rtems/config/get-ticks-per-timeslice.yml
index 02c606b5..84d05311 100644
--- a/spec/if/rtems/config/get-ticks-per-timeslice.yml
+++ b/spec/if/rtems/config/get-ticks-per-timeslice.yml
@@ -1,23 +1,23 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the ticks per timeslice configured for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the ticks per timeslice configured for this application.
-interface-definition:
- default: ${/if/impl/watchdog/ticks-per-timeslice:/interface-name}
+definition:
+ default: ${/if/impl/watchdog/ticks-per-timeslice:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_ticks_per_timeslice
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_ticks_per_timeslice
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-unified-work-area.yml b/spec/if/rtems/config/get-unified-work-area.yml
index c8e2a42c..fcc0e323 100644
--- a/spec/if/rtems/config/get-unified-work-area.yml
+++ b/spec/if/rtems/config/get-unified-work-area.yml
@@ -1,24 +1,24 @@
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-brief: |
+brief: |
Returns true, if the RTEMS Workspace and C Program Heap are unified,
otherwise returns false.
-interface-definition:
- default: ${/if/impl/wkspace/is-unified:/interface-name}
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
+ default: ${/if/impl/wkspace/is-unified:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_unified_work_area
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_unified_work_area
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-user-extension-table.yml b/spec/if/rtems/config/get-user-extension-table.yml
index 6dfda766..79d53048 100644
--- a/spec/if/rtems/config/get-user-extension-table.yml
+++ b/spec/if/rtems/config/get-user-extension-table.yml
@@ -1,24 +1,24 @@
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-brief: |
+brief: |
Returns the pointer to the initial extensions table configured for this
application.
-interface-definition:
- default: ${/if/impl/userext/initial-extensions:/interface-name}
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
+ default: ${/if/impl/userext/initial-extensions:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_user_extension_table
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_user_extension_table
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-user-multiprocessing-table.yml b/spec/if/rtems/config/get-user-multiprocessing-table.yml
index c1f73588..f08a7da7 100644
--- a/spec/if/rtems/config/get-user-multiprocessing-table.yml
+++ b/spec/if/rtems/config/get-user-multiprocessing-table.yml
@@ -1,26 +1,26 @@
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-brief: |
+brief: |
Returns the pointer to the MPCI configuration table configured for this
application.
-interface-definition:
- default: ${/if/c/null:/interface-name}
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
+ default: ${/if/c/null:/name}
variants:
- - definition: ${/if/impl/mpci/configuration:/interface-name}
- enabled-by: defined(${/if/build-options/multiprocessing:/interface-name})
-interface-description: null
-interface-name: rtems_configuration_get_user_multiprocessing_table
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+ - definition: ${/if/impl/mpci/configuration:/name}
+ enabled-by: defined(${/if/build-options/multiprocessing:/name})
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_user_multiprocessing_table
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-work-space-size.yml b/spec/if/rtems/config/get-work-space-size.yml
index 47b7c6dd..fbadf78c 100644
--- a/spec/if/rtems/config/get-work-space-size.yml
+++ b/spec/if/rtems/config/get-work-space-size.yml
@@ -1,26 +1,26 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the RTEMS Workspace size in bytes configured for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the RTEMS Workspace size in bytes configured for this application.
-interface-definition:
+definition:
default: |
- (${/if/impl/wkspace/size:/interface-name} +
- (${get-stack-allocator-avoids-work-space:/interface-name}() ?
- 0 : ${get-stack-space-size:/interface-name}()))
+ (${/if/impl/wkspace/size:/name} +
+ (${get-stack-allocator-avoids-work-space:/name}() ?
+ 0 : ${get-stack-space-size:/name}()))
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_work_space_size
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_work_space_size
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/header-2.yml b/spec/if/rtems/config/header-2.yml
index 0e8757c9..22e77a43 100644
--- a/spec/if/rtems/config/header-2.yml
+++ b/spec/if/rtems/config/header-2.yml
@@ -1,10 +1,10 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+domain: rtems
enabled-by: true
-interface-domain: rtems
-interface-path: rtems/rtems/config.h
-interface-prefix: cpukit/include
interface-type: header-file
links: []
+path: rtems/rtems/config.h
+prefix: cpukit/include
type: interface
diff --git a/spec/if/rtems/config/header.yml b/spec/if/rtems/config/header.yml
index 8cd66f2f..1e1041d6 100644
--- a/spec/if/rtems/config/header.yml
+++ b/spec/if/rtems/config/header.yml
@@ -1,10 +1,8 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+domain: rtems
enabled-by: true
-interface-domain: rtems
-interface-path: rtems/config.h
-interface-prefix: cpukit/include
interface-type: header-file
links:
- enabled-by: RTEMS_MULTIPROCESSING
@@ -13,4 +11,6 @@ links:
- enabled-by: RTEMS_MULTIPROCESSING
role: interface-include
uid: /if/rtems/types/header
+path: rtems/config.h
+prefix: cpukit/include
type: interface
diff --git a/spec/if/rtems/config/resource-is-unlimited.yml b/spec/if/rtems/config/resource-is-unlimited.yml
index b703e460..8bf0b34f 100644
--- a/spec/if/rtems/config/resource-is-unlimited.yml
+++ b/spec/if/rtems/config/resource-is-unlimited.yml
@@ -1,26 +1,26 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns true, if the resource is unlimited, otherwise returns false.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns true, if the resource is unlimited, otherwise returns false.
-interface-definition:
- default: ${/if/impl/object/is-unlimited:/interface-name}(${.:/interface-params[0]/name})
+definition:
+ default: ${/if/impl/object/is-unlimited:/name}(${.:/params[0]/name})
variants: []
-interface-description: null
-interface-name: rtems_resource_is_unlimited
-interface-notes: null
-interface-params:
-- description: is the resource number.
- dir: null
- name: _resource
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_resource_is_unlimited
+notes: null
+params:
+- description: is the resource number.
+ dir: null
+ name: _resource
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/resource-maximum-per-allocation.yml b/spec/if/rtems/config/resource-maximum-per-allocation.yml
index 0e140ab2..5af1e5f7 100644
--- a/spec/if/rtems/config/resource-maximum-per-allocation.yml
+++ b/spec/if/rtems/config/resource-maximum-per-allocation.yml
@@ -1,26 +1,26 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the resource maximum number per allocation.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the resource maximum number per allocation.
-interface-definition:
- default: ${/if/impl/object/maximum-per-allocation:/interface-name}(${.:/interface-params[0]/name})
+definition:
+ default: ${/if/impl/object/maximum-per-allocation:/name}(${.:/params[0]/name})
variants: []
-interface-description: null
-interface-name: rtems_resource_maximum_per_allocation
-interface-notes: null
-interface-params:
-- description: is the resource number.
- dir: null
- name: _resource
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_resource_maximum_per_allocation
+notes: null
+params:
+- description: is the resource number.
+ dir: null
+ name: _resource
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/resource-unlimited.yml b/spec/if/rtems/config/resource-unlimited.yml
index 43f5be14..c0f36e0d 100644
--- a/spec/if/rtems/config/resource-unlimited.yml
+++ b/spec/if/rtems/config/resource-unlimited.yml
@@ -1,26 +1,26 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the specified resource number configured for unlimited resources.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the specified resource number configured for unlimited resources.
-interface-definition:
- default: ((${.:/interface-params[0]/name}) | ${unlimited-objects:/interface-name})
+definition:
+ default: ((${.:/params[0]/name}) | ${unlimited-objects:/name})
variants: []
-interface-description: null
-interface-name: rtems_resource_unlimited
-interface-notes: null
-interface-params:
-- description: is the resource number.
- dir: null
- name: _resource
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_resource_unlimited
+notes: null
+params:
+- description: is the resource number.
+ dir: null
+ name: _resource
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/stack-allocate-hook.yml b/spec/if/rtems/config/stack-allocate-hook.yml
index d4b980b5..66147d2e 100644
--- a/spec/if/rtems/config/stack-allocate-hook.yml
+++ b/spec/if/rtems/config/stack-allocate-hook.yml
@@ -1,19 +1,19 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ The thread stack allocator allocate handler.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- The thread stack allocator allocate handler.
-interface-definition:
- default: ${/if/impl/stack/allocator-allocate-type:/interface-name} ${.:/interface-name}
+definition:
+ default: ${/if/impl/stack/allocator-allocate-type:/name} ${.:/name}
variants: []
-interface-description: null
-interface-name: rtems_stack_allocate_hook
-interface-notes: null
+description: null
+enabled-by: true
interface-type: typedef
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_stack_allocate_hook
+notes: null
type: interface
diff --git a/spec/if/rtems/config/stack-allocate-init-hook.yml b/spec/if/rtems/config/stack-allocate-init-hook.yml
index 18abd6d7..a762d99e 100644
--- a/spec/if/rtems/config/stack-allocate-init-hook.yml
+++ b/spec/if/rtems/config/stack-allocate-init-hook.yml
@@ -1,19 +1,19 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ The thread stack allocator initialization handler.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- The thread stack allocator initialization handler.
-interface-definition:
- default: ${/if/impl/stack/allocator-initialize-type:/interface-name} ${.:/interface-name}
+definition:
+ default: ${/if/impl/stack/allocator-initialize-type:/name} ${.:/name}
variants: []
-interface-description: null
-interface-name: rtems_stack_allocate_init_hook
-interface-notes: null
+description: null
+enabled-by: true
interface-type: typedef
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_stack_allocate_init_hook
+notes: null
type: interface
diff --git a/spec/if/rtems/config/stack-free-hook.yml b/spec/if/rtems/config/stack-free-hook.yml
index 5b15e4f2..d67e9ec1 100644
--- a/spec/if/rtems/config/stack-free-hook.yml
+++ b/spec/if/rtems/config/stack-free-hook.yml
@@ -1,19 +1,19 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ The thread stack allocator free handler.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- The thread stack allocator free handler.
-interface-definition:
- default: ${/if/impl/stack/allocator-free-type:/interface-name} ${.:/interface-name}
+definition:
+ default: ${/if/impl/stack/allocator-free-type:/name} ${.:/name}
variants: []
-interface-description: null
-interface-name: rtems_stack_free_hook
-interface-notes: null
+description: null
+enabled-by: true
interface-type: typedef
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_stack_free_hook
+notes: null
type: interface
diff --git a/spec/if/rtems/config/unlimited-objects.yml b/spec/if/rtems/config/unlimited-objects.yml
index ac92cec1..779f16d9 100644
--- a/spec/if/rtems/config/unlimited-objects.yml
+++ b/spec/if/rtems/config/unlimited-objects.yml
@@ -1,19 +1,19 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This flag is used in resource numbers to indicate an unlimited resource.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- This flag is used in resource numbers to indicate an unlimited resource.
-interface-definition:
- default: ${/if/impl/object/unlimited-objects:/interface-name}
+definition:
+ default: ${/if/impl/object/unlimited-objects:/name}
variants: []
-interface-description: null
-interface-name: RTEMS_UNLIMITED_OBJECTS
-interface-notes: null
+description: null
+enabled-by: true
interface-type: define
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: RTEMS_UNLIMITED_OBJECTS
+notes: null
type: interface
diff --git a/spec/if/rtems/init/header.yml b/spec/if/rtems/init/header.yml
index 64d108f2..6128dace 100644
--- a/spec/if/rtems/init/header.yml
+++ b/spec/if/rtems/init/header.yml
@@ -1,10 +1,10 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+domain: rtems
enabled-by: true
-interface-domain: rtems
-interface-path: rtems/init.h
-interface-prefix: cpukit/include
interface-type: header-file
links: []
+path: rtems/init.h
+prefix: cpukit/include
type: interface
diff --git a/spec/if/rtems/init/initialize-executive.yml b/spec/if/rtems/init/initialize-executive.yml
index b95c79a7..dd5a4c48 100644
--- a/spec/if/rtems/init/initialize-executive.yml
+++ b/spec/if/rtems/init/initialize-executive.yml
@@ -1,31 +1,31 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Initializes the system and starts multitasking.
copyrights:
- Copyright (C) 2015, 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Initializes the system and starts multitasking.
-interface-definition:
+definition:
default:
params: []
- return: ${/if/rtems/basedefs/no-return:/interface-name} void
+ return: ${/if/rtems/basedefs/no-return:/name} void
variants: []
-interface-description: |
+description: |
Iterates through the system initialization linker set and invokes the
registered handlers. The final step is to start multitasking.
-interface-name: rtems_initialize_executive
-interface-notes: |
- This directive should be called by boot_card() only.
-
- This directive does not return to the caller. Errors in the initialization
- sequence are usually fatal and lead to a system termination.
-interface-params: []
-interface-return:
- return: null
- return-values: []
+enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/classic/init
+name: rtems_initialize_executive
+notes: |
+ This directive should be called by boot_card() only.
+
+ This directive does not return to the caller. Errors in the initialization
+ sequence are usually fatal and lead to a system termination.
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/init/shutdown-executive.yml b/spec/if/rtems/init/shutdown-executive.yml
index c0f28ec4..bab3153f 100644
--- a/spec/if/rtems/init/shutdown-executive.yml
+++ b/spec/if/rtems/init/shutdown-executive.yml
@@ -1,34 +1,34 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Shuts down the RTEMS environment.
copyrights:
- Copyright (C) 2015, 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- Shuts down the RTEMS environment.
-interface-definition:
+definition:
default:
params:
- - ${/if/c/uint32_t:/interface-name} ${.:/interface-params[0]/name}
- return: ${/if/rtems/basedefs/no-return:/interface-name} void
+ - ${/if/c/uint32_t:/name} ${.:/params[0]/name}
+ return: ${/if/rtems/basedefs/no-return:/name} void
variants: []
-interface-description: |
+description: |
The invocation of this directive results in the RTEMS environment being
shutdown and multitasking halted. The system is terminated with a fatal
source of RTEMS_FATAL_SOURCE_EXIT and the specified result code.
-interface-name: rtems_shutdown_executive
-interface-notes: |
- This directive does not return to the caller.
-interface-params:
-- description: is the result code.
- dir: null
- name: result
-interface-return:
- return: null
- return-values: []
+enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/classic/init
+name: rtems_shutdown_executive
+notes: |
+ This directive does not return to the caller.
+params:
+- description: is the result code.
+ dir: null
+ name: result
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/status/already-suspended.yml b/spec/if/rtems/status/already-suspended.yml
index 4b72cd7d..30b0ae3a 100644
--- a/spec/if/rtems/status/already-suspended.yml
+++ b/spec/if/rtems/status/already-suspended.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the thread was already suspended.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the thread was already suspended.
-interface-definition:
+definition:
default: '15'
variants: []
-interface-description: null
-interface-name: RTEMS_ALREADY_SUSPENDED
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_ALREADY_SUSPENDED
+notes: null
type: interface
diff --git a/spec/if/rtems/status/called-from-isr.yml b/spec/if/rtems/status/called-from-isr.yml
index 3a8afaa6..6092755a 100644
--- a/spec/if/rtems/status/called-from-isr.yml
+++ b/spec/if/rtems/status/called-from-isr.yml
@@ -1,17 +1,17 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the operation should not be called from this
+ execution environment.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the operation should not be called from this
- execution environment.
-interface-definition:
+definition:
default: '18'
variants: []
-interface-description: null
-interface-name: RTEMS_CALLED_FROM_ISR
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_CALLED_FROM_ISR
+notes: null
type: interface
diff --git a/spec/if/rtems/status/code-to-errno.yml b/spec/if/rtems/status/code-to-errno.yml
index 3bf138bb..054f2ea3 100644
--- a/spec/if/rtems/status/code-to-errno.yml
+++ b/spec/if/rtems/status/code-to-errno.yml
@@ -1,73 +1,73 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Maps the specified RTEMS status code to a POSIX error number.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Maps the specified RTEMS status code to a POSIX error number.
-interface-definition:
+definition:
default:
params:
- - ${code:/interface-name} ${.:/interface-params[0]/name}
+ - ${code:/name} ${.:/params[0]/name}
return: int
variants: []
-interface-description: null
-interface-name: rtems_status_code_to_errno
-interface-notes: null
-interface-params:
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: /groups/api/classic/status
+name: rtems_status_code_to_errno
+notes: null
+params:
- description: is the status code to map.
dir: null
name: status_code
-interface-return:
+return:
return: null
return-values:
- description: |
- The status code is ${successful:/interface-name}.
+ The status code is ${successful:/name}.
value: '0'
- description: |
- The status code is ${invalid-number:/interface-name}.
+ The status code is ${invalid-number:/name}.
value: EBADF
- description: |
- The status code is ${resource-in-use:/interface-name}.
+ The status code is ${resource-in-use:/name}.
value: EBUSY
- description: |
- The status code is ${interrupted:/interface-name}.
+ The status code is ${interrupted:/name}.
value: EINTR
- description: |
- The status code is ${invalid-clock:/interface-name},
- ${invalid-name:/interface-name}, or ${invalid-node:/interface-name}.
+ The status code is ${invalid-clock:/name},
+ ${invalid-name:/name}, or ${invalid-node:/name}.
value: EINVAL
- description: |
- The status code is ${already-suspended:/interface-name},
- ${called-from-isr:/interface-name},
- ${illegal-on-remote-object:/interface-name},
- ${illegal-on-self:/interface-name}, ${incorrect-state:/interface-name},
- ${internal-error:/interface-name}, ${invalid-address:/interface-name},
- ${invalid-id:/interface-name}, ${invalid-priority:/interface-name},
- ${invalid-size:/interface-name}, ${io-error:/interface-name},
- ${mp-not-configured:/interface-name}, ${not-defined:/interface-name},
- ${object-was-deleted:/interface-name}, ${proxy-blocking:/interface-name},
- ${task-exitted:/interface-name}, or ${too-many:/interface-name}.
+ The status code is ${already-suspended:/name},
+ ${called-from-isr:/name},
+ ${illegal-on-remote-object:/name},
+ ${illegal-on-self:/name}, ${incorrect-state:/name},
+ ${internal-error:/name}, ${invalid-address:/name},
+ ${invalid-id:/name}, ${invalid-priority:/name},
+ ${invalid-size:/name}, ${io-error:/name},
+ ${mp-not-configured:/name}, ${not-defined:/name},
+ ${object-was-deleted:/name}, ${proxy-blocking:/name},
+ ${task-exitted:/name}, or ${too-many:/name}.
value: EIO
- description: |
- The status code is ${unsatisfied:/interface-name}.
+ The status code is ${unsatisfied:/name}.
value: ENODEV
- description: |
- The status code is ${no-memory:/interface-name}.
+ The status code is ${no-memory:/name}.
value: ENOMEM
- description: |
- The status code is ${not-configured:/interface-name} or
- ${not-implemented:/interface-name}.
+ The status code is ${not-configured:/name} or
+ ${not-implemented:/name}.
value: ENOSYS
- description: |
- The status code is ${not-owner-of-resource:/interface-name}.
+ The status code is ${not-owner-of-resource:/name}.
value: EPERM
- description: |
- The status code is ${timeout:/interface-name}.
+ The status code is ${timeout:/name}.
value: ETIMEDOUT
-interface-type: function
-links:
-- role: interface-placement
- uid: header
-- role: interface-ingroup
- uid: /groups/api/classic/status
type: interface
diff --git a/spec/if/rtems/status/code.yml b/spec/if/rtems/status/code.yml
index 9a09e653..0e86a34a 100644
--- a/spec/if/rtems/status/code.yml
+++ b/spec/if/rtems/status/code.yml
@@ -1,13 +1,11 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This enumeration provides status codes for directives of the Classic API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition-kind: typedef-only
+description: null
enabled-by: true
-interface-brief: |
- This enumeration provides status codes for directives of the Classic API.
-interface-definition-kind: typedef-only
-interface-description: null
-interface-name: rtems_status_code
-interface-notes: null
interface-type: enum
links:
- role: interface-placement
@@ -74,4 +72,6 @@ links:
uid: interrupted
- role: interface-enumerator
uid: proxy-blocking
+name: rtems_status_code
+notes: null
type: interface
diff --git a/spec/if/rtems/status/first.yml b/spec/if/rtems/status/first.yml
index 2380936d..52faaf9f 100644
--- a/spec/if/rtems/status/first.yml
+++ b/spec/if/rtems/status/first.yml
@@ -1,20 +1,20 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This is the lowest valid value for a Classic API status code.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This is the lowest valid value for a Classic API status code.
-interface-definition:
- default: ${successful:/interface-name}
+definition:
+ default: ${successful:/name}
variants: []
-interface-description: null
-interface-name: RTEMS_STATUS_CODES_FIRST
-interface-notes: null
+description: null
+enabled-by: true
interface-type: define
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/classic/status
+name: RTEMS_STATUS_CODES_FIRST
+notes: null
type: interface
diff --git a/spec/if/rtems/status/header.yml b/spec/if/rtems/status/header.yml
index 9662ff09..54ce85e3 100644
--- a/spec/if/rtems/status/header.yml
+++ b/spec/if/rtems/status/header.yml
@@ -1,10 +1,10 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+domain: rtems
enabled-by: true
-interface-domain: rtems
-interface-path: rtems/rtems/status.h
-interface-prefix: cpukit/include
interface-type: header-file
links: []
+path: rtems/rtems/status.h
+prefix: cpukit/include
type: interface
diff --git a/spec/if/rtems/status/illegal-on-remote-object.yml b/spec/if/rtems/status/illegal-on-remote-object.yml
index e27177b3..924c6e16 100644
--- a/spec/if/rtems/status/illegal-on-remote-object.yml
+++ b/spec/if/rtems/status/illegal-on-remote-object.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the operation is illegal on a remote object.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the operation is illegal on a remote object.
-interface-definition:
+definition:
default: '17'
variants: []
-interface-description: null
-interface-name: RTEMS_ILLEGAL_ON_REMOTE_OBJECT
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_ILLEGAL_ON_REMOTE_OBJECT
+notes: null
type: interface
diff --git a/spec/if/rtems/status/illegal-on-self.yml b/spec/if/rtems/status/illegal-on-self.yml
index c2876449..d7479333 100644
--- a/spec/if/rtems/status/illegal-on-self.yml
+++ b/spec/if/rtems/status/illegal-on-self.yml
@@ -1,17 +1,17 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the operation is illegal on the calling
+ thread.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the operation is illegal on the calling
- thread.
-interface-definition:
+definition:
default: '16'
variants: []
-interface-description: null
-interface-name: RTEMS_ILLEGAL_ON_SELF
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_ILLEGAL_ON_SELF
+notes: null
type: interface
diff --git a/spec/if/rtems/status/incorrect-state.yml b/spec/if/rtems/status/incorrect-state.yml
index 0f6ae8b0..9c30f28b 100644
--- a/spec/if/rtems/status/incorrect-state.yml
+++ b/spec/if/rtems/status/incorrect-state.yml
@@ -1,17 +1,17 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that an object is in wrong state for the requested
+ operation.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that an object is in wrong state for the requested
- operation.
-interface-definition:
+definition:
default: '14'
variants: []
-interface-description: null
-interface-name: RTEMS_INCORRECT_STATE
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_INCORRECT_STATE
+notes: null
type: interface
diff --git a/spec/if/rtems/status/internal-error.yml b/spec/if/rtems/status/internal-error.yml
index 5d6616a5..fed91daa 100644
--- a/spec/if/rtems/status/internal-error.yml
+++ b/spec/if/rtems/status/internal-error.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that an internal RTEMS inconsistency was detected.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that an internal RTEMS inconsistency was detected.
-interface-definition:
+definition:
default: '25'
variants: []
-interface-description: null
-interface-name: RTEMS_INTERNAL_ERROR
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_INTERNAL_ERROR
+notes: null
type: interface
diff --git a/spec/if/rtems/status/interrupted.yml b/spec/if/rtems/status/interrupted.yml
index f5833c7c..c79fa7fb 100644
--- a/spec/if/rtems/status/interrupted.yml
+++ b/spec/if/rtems/status/interrupted.yml
@@ -1,17 +1,17 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code is used internally to indicate a blocking device driver call
+ has been interrupted and should be reflected to the caller as interrupted.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2019 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code is used internally to indicate a blocking device driver call
- has been interrupted and should be reflected to the caller as interrupted.
-interface-definition:
+definition:
default: '28'
variants: []
-interface-description: null
-interface-name: RTEMS_INTERRUPTED
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_INTERRUPTED
+notes: null
type: interface
diff --git a/spec/if/rtems/status/invalid-address.yml b/spec/if/rtems/status/invalid-address.yml
index e6730ef6..e6cb9212 100644
--- a/spec/if/rtems/status/invalid-address.yml
+++ b/spec/if/rtems/status/invalid-address.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the specified address is invalid.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the specified address is invalid.
-interface-definition:
+definition:
default: '9'
variants: []
-interface-description: null
-interface-name: RTEMS_INVALID_ADDRESS
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_INVALID_ADDRESS
+notes: null
type: interface
diff --git a/spec/if/rtems/status/invalid-clock.yml b/spec/if/rtems/status/invalid-clock.yml
index ff4bcecb..6bcd7284 100644
--- a/spec/if/rtems/status/invalid-clock.yml
+++ b/spec/if/rtems/status/invalid-clock.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the specified date/time was invalid.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the specified date/time was invalid.
-interface-definition:
+definition:
default: '20'
variants: []
-interface-description: null
-interface-name: RTEMS_INVALID_CLOCK
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_INVALID_CLOCK
+notes: null
type: interface
diff --git a/spec/if/rtems/status/invalid-id.yml b/spec/if/rtems/status/invalid-id.yml
index 32b81d30..d51875ea 100644
--- a/spec/if/rtems/status/invalid-id.yml
+++ b/spec/if/rtems/status/invalid-id.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the object identifier was invalid.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the object identifier was invalid.
-interface-definition:
+definition:
default: '4'
variants: []
-interface-description: null
-interface-name: RTEMS_INVALID_ID
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_INVALID_ID
+notes: null
type: interface
diff --git a/spec/if/rtems/status/invalid-name.yml b/spec/if/rtems/status/invalid-name.yml
index 14fe0325..980951fb 100644
--- a/spec/if/rtems/status/invalid-name.yml
+++ b/spec/if/rtems/status/invalid-name.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the object name was invalid.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the object name was invalid.
-interface-definition:
+definition:
default: '3'
variants: []
-interface-description: null
-interface-name: RTEMS_INVALID_NAME
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_INVALID_NAME
+notes: null
type: interface
diff --git a/spec/if/rtems/status/invalid-node.yml b/spec/if/rtems/status/invalid-node.yml
index 3cfb2454..98bce397 100644
--- a/spec/if/rtems/status/invalid-node.yml
+++ b/spec/if/rtems/status/invalid-node.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the specified node identifier was invalid.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the specified node identifier was invalid.
-interface-definition:
+definition:
default: '21'
variants: []
-interface-description: null
-interface-name: RTEMS_INVALID_NODE
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_INVALID_NODE
+notes: null
type: interface
diff --git a/spec/if/rtems/status/invalid-number.yml b/spec/if/rtems/status/invalid-number.yml
index 77aa3637..f4c3bd00 100644
--- a/spec/if/rtems/status/invalid-number.yml
+++ b/spec/if/rtems/status/invalid-number.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the specified number was invalid.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the specified number was invalid.
-interface-definition:
+definition:
default: '10'
variants: []
-interface-description: null
-interface-name: RTEMS_INVALID_NUMBER
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_INVALID_NUMBER
+notes: null
type: interface
diff --git a/spec/if/rtems/status/invalid-priority.yml b/spec/if/rtems/status/invalid-priority.yml
index f50840eb..4a4dbcb5 100644
--- a/spec/if/rtems/status/invalid-priority.yml
+++ b/spec/if/rtems/status/invalid-priority.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that an invalid thread priority was provided.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that an invalid thread priority was provided.
-interface-definition:
+definition:
default: '19'
variants: []
-interface-description: null
-interface-name: RTEMS_INVALID_PRIORITY
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_INVALID_PRIORITY
+notes: null
type: interface
diff --git a/spec/if/rtems/status/invalid-size.yml b/spec/if/rtems/status/invalid-size.yml
index db39f247..fc42cae7 100644
--- a/spec/if/rtems/status/invalid-size.yml
+++ b/spec/if/rtems/status/invalid-size.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the specified size was invalid.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the specified size was invalid.
-interface-definition:
+definition:
default: '8'
variants: []
-interface-description: null
-interface-name: RTEMS_INVALID_SIZE
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_INVALID_SIZE
+notes: null
type: interface
diff --git a/spec/if/rtems/status/io-error.yml b/spec/if/rtems/status/io-error.yml
index c08c5777..f75a11e6 100644
--- a/spec/if/rtems/status/io-error.yml
+++ b/spec/if/rtems/status/io-error.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates an driver IO error.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates an driver IO error.
-interface-definition:
+definition:
default: '27'
variants: []
-interface-description: null
-interface-name: RTEMS_IO_ERROR
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_IO_ERROR
+notes: null
type: interface
diff --git a/spec/if/rtems/status/is-equal.yml b/spec/if/rtems/status/is-equal.yml
index a9b43983..e3fd89c1 100644
--- a/spec/if/rtems/status/is-equal.yml
+++ b/spec/if/rtems/status/is-equal.yml
@@ -1,37 +1,37 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns true, if the left hand side status code is equal to the right hand
+ side status code, otherwise returns false.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- Returns true, if the left hand side status code is equal to the right hand
- side status code, otherwise returns false.
-interface-definition:
+definition:
default:
body: |
- return ${.:/interface-params[0]/name} == ${.:/interface-params[1]/name};
+ return ${.:/params[0]/name} == ${.:/params[1]/name};
params:
- - ${code:/interface-name} ${.:/interface-params[0]/name}
- - ${code:/interface-name} ${.:/interface-params[1]/name}
- return: ${/if/c/bool:/interface-name}
+ - ${code:/name} ${.:/params[0]/name}
+ - ${code:/name} ${.:/params[1]/name}
+ return: ${/if/c/bool:/name}
variants: []
-interface-description: null
-interface-name: rtems_are_statuses_equal
-interface-notes: null
-interface-params:
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: /groups/api/classic/status
+name: rtems_are_statuses_equal
+notes: null
+params:
- description: is the left hand side status code.
dir: null
name: left_status_code
- description: is the right hand side status code.
dir: null
name: right_status_code
-interface-return:
+return:
return: null
return-values: []
-interface-type: function
-links:
-- role: interface-placement
- uid: header
-- role: interface-ingroup
- uid: /groups/api/classic/status
type: interface
diff --git a/spec/if/rtems/status/is-successful.yml b/spec/if/rtems/status/is-successful.yml
index e871c8c3..281757c6 100644
--- a/spec/if/rtems/status/is-successful.yml
+++ b/spec/if/rtems/status/is-successful.yml
@@ -1,33 +1,33 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns true, if the status code is ${successful:/name}, otherwise
+ returns false.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- Returns true, if the status code is ${successful:/interface-name}, otherwise
- returns false.
-interface-definition:
+definition:
default:
body: |
- return ${.:/interface-params[0]/name} == ${successful:/interface-name};
+ return ${.:/params[0]/name} == ${successful:/name};
params:
- - ${code:/interface-name} ${.:/interface-params[0]/name}
- return: ${/if/c/bool:/interface-name}
+ - ${code:/name} ${.:/params[0]/name}
+ return: ${/if/c/bool:/name}
variants: []
-interface-description: null
-interface-name: rtems_is_status_successful
-interface-notes: null
-interface-params:
-- description: is the status code.
- dir: null
- name: status_code
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/classic/status
+name: rtems_is_status_successful
+notes: null
+params:
+- description: is the status code.
+ dir: null
+ name: status_code
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/status/last.yml b/spec/if/rtems/status/last.yml
index 71ffcd57..ec378a52 100644
--- a/spec/if/rtems/status/last.yml
+++ b/spec/if/rtems/status/last.yml
@@ -1,20 +1,20 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This is the highest valid value for a Classic API status code.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This is the highest valid value for a Classic API status code.
-interface-definition:
- default: ${proxy-blocking:/interface-name}
+definition:
+ default: ${proxy-blocking:/name}
variants: []
-interface-description: null
-interface-name: RTEMS_STATUS_CODES_LAST
-interface-notes: null
+description: null
+enabled-by: true
interface-type: define
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/classic/status
+name: RTEMS_STATUS_CODES_LAST
+notes: null
type: interface
diff --git a/spec/if/rtems/status/mp-not-configured.yml b/spec/if/rtems/status/mp-not-configured.yml
index 4b617bc9..47f3c259 100644
--- a/spec/if/rtems/status/mp-not-configured.yml
+++ b/spec/if/rtems/status/mp-not-configured.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that multiprocessing is not configured.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that multiprocessing is not configured.
-interface-definition:
+definition:
default: '2'
variants: []
-interface-description: null
-interface-name: RTEMS_MP_NOT_CONFIGURED
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_MP_NOT_CONFIGURED
+notes: null
type: interface
diff --git a/spec/if/rtems/status/no-memory.yml b/spec/if/rtems/status/no-memory.yml
index f1974354..00fbf207 100644
--- a/spec/if/rtems/status/no-memory.yml
+++ b/spec/if/rtems/status/no-memory.yml
@@ -1,17 +1,17 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the directive attempted to allocate memory
+ but was unable to do so.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the directive attempted to allocate memory
- but was unable to do so.
-interface-definition:
+definition:
default: '26'
variants: []
-interface-description: null
-interface-name: RTEMS_NO_MEMORY
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_NO_MEMORY
+notes: null
type: interface
diff --git a/spec/if/rtems/status/not-configured.yml b/spec/if/rtems/status/not-configured.yml
index bad4aeeb..4ab79cb9 100644
--- a/spec/if/rtems/status/not-configured.yml
+++ b/spec/if/rtems/status/not-configured.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the directive was not configured.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the directive was not configured.
-interface-definition:
+definition:
default: '22'
variants: []
-interface-description: null
-interface-name: RTEMS_NOT_CONFIGURED
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_NOT_CONFIGURED
+notes: null
type: interface
diff --git a/spec/if/rtems/status/not-defined.yml b/spec/if/rtems/status/not-defined.yml
index 2e1ef7f7..8f3b93d6 100644
--- a/spec/if/rtems/status/not-defined.yml
+++ b/spec/if/rtems/status/not-defined.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the item has not been initialized.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the item has not been initialized.
-interface-definition:
+definition:
default: '11'
variants: []
-interface-description: null
-interface-name: RTEMS_NOT_DEFINED
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_NOT_DEFINED
+notes: null
type: interface
diff --git a/spec/if/rtems/status/not-implemented.yml b/spec/if/rtems/status/not-implemented.yml
index 94001c87..d344da20 100644
--- a/spec/if/rtems/status/not-implemented.yml
+++ b/spec/if/rtems/status/not-implemented.yml
@@ -1,19 +1,19 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates the directive or requested portion of the
+ directive is not implemented.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates the directive or requested portion of the
- directive is not implemented.
-interface-definition:
+definition:
default: '24'
variants: []
-interface-description: |
+description: |
This is a hint that you have stumbled across an opportunity to submit code to
the RTEMS Project.
-interface-name: RTEMS_NOT_IMPLEMENTED
-interface-notes: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_NOT_IMPLEMENTED
+notes: null
type: interface
diff --git a/spec/if/rtems/status/not-owner-of-resource.yml b/spec/if/rtems/status/not-owner-of-resource.yml
index 528da17a..bd0697c8 100644
--- a/spec/if/rtems/status/not-owner-of-resource.yml
+++ b/spec/if/rtems/status/not-owner-of-resource.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the caller is not the owner of the resource.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the caller is not the owner of the resource.
-interface-definition:
+definition:
default: '23'
variants: []
-interface-description: null
-interface-name: RTEMS_NOT_OWNER_OF_RESOURCE
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_NOT_OWNER_OF_RESOURCE
+notes: null
type: interface
diff --git a/spec/if/rtems/status/object-was-deleted.yml b/spec/if/rtems/status/object-was-deleted.yml
index 608e5371..56d3035a 100644
--- a/spec/if/rtems/status/object-was-deleted.yml
+++ b/spec/if/rtems/status/object-was-deleted.yml
@@ -1,17 +1,17 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates the object was deleted while the thread was
+ blocked waiting.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates the object was deleted while the thread was
- blocked waiting.
-interface-definition:
+definition:
default: '7'
variants: []
-interface-description: null
-interface-name: RTEMS_OBJECT_WAS_DELETED
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_OBJECT_WAS_DELETED
+notes: null
type: interface
diff --git a/spec/if/rtems/status/proxy-blocking.yml b/spec/if/rtems/status/proxy-blocking.yml
index b70e4d3b..f588a6e9 100644
--- a/spec/if/rtems/status/proxy-blocking.yml
+++ b/spec/if/rtems/status/proxy-blocking.yml
@@ -1,21 +1,20 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This is the status is used internally to RTEMS when performing
+ operations on behalf of remote tasks.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This is the status is used internally to RTEMS when performing
- operations on behalf of remote tasks.
-interface-definition:
+definition:
default: '29'
variants: []
-interface-description: |
+description: |
This is referred to as proxying operations and this status indicates that the
operation could not be completed immediately and the proxy is blocking.
-interface-name: RTEMS_PROXY_BLOCKING
-interface-note: |
- This status will not be returned to the user.
-interface-notes: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_PROXY_BLOCKING
+notes: |
+ This status will not be returned to the user.
type: interface
diff --git a/spec/if/rtems/status/resource-in-use.yml b/spec/if/rtems/status/resource-in-use.yml
index ed87bfe6..21d609ed 100644
--- a/spec/if/rtems/status/resource-in-use.yml
+++ b/spec/if/rtems/status/resource-in-use.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the object still has resources in use.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the object still has resources in use.
-interface-definition:
+definition:
default: '12'
variants: []
-interface-description: null
-interface-name: RTEMS_RESOURCE_IN_USE
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_RESOURCE_IN_USE
+notes: null
type: interface
diff --git a/spec/if/rtems/status/successful.yml b/spec/if/rtems/status/successful.yml
index f7e1c9e6..93ccda45 100644
--- a/spec/if/rtems/status/successful.yml
+++ b/spec/if/rtems/status/successful.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates successful completion.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates successful completion.
-interface-definition:
+definition:
default: '0'
variants: []
-interface-description: null
-interface-name: RTEMS_SUCCESSFUL
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_SUCCESSFUL
+notes: null
type: interface
diff --git a/spec/if/rtems/status/task-exitted.yml b/spec/if/rtems/status/task-exitted.yml
index a0f8b0fc..30e0df9c 100644
--- a/spec/if/rtems/status/task-exitted.yml
+++ b/spec/if/rtems/status/task-exitted.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that a thread exited.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that a thread exited.
-interface-definition:
+definition:
default: '1'
variants: []
-interface-description: null
-interface-name: RTEMS_TASK_EXITTED
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_TASK_EXITTED
+notes: null
type: interface
diff --git a/spec/if/rtems/status/text.yml b/spec/if/rtems/status/text.yml
index 8e441f1c..eec9aac7 100644
--- a/spec/if/rtems/status/text.yml
+++ b/spec/if/rtems/status/text.yml
@@ -1,31 +1,31 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: Returns a text describing the specified status code.
copyrights:
- Copyright (C) 2014, 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: Returns a text describing the specified status code.
-interface-definition:
+definition:
default:
params:
- - ${code:/interface-name} ${.:/interface-params[0]/name}
+ - ${code:/name} ${.:/params[0]/name}
return: const char *
variants: []
-interface-description: |
+description: |
The text for each status code is the enumerator constant.
-interface-name: rtems_status_text
-interface-notes: null
-interface-params:
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: /groups/api/classic/status
+name: rtems_status_text
+notes: null
+params:
- description: is the status code.
dir: null
name: status_code
-interface-return:
+return:
return: Otherwise, a text describing the status code.
return-values:
- description: The passed status code is invalid.
value: '"?"'
-interface-type: function
-links:
-- role: interface-placement
- uid: header
-- role: interface-ingroup
- uid: /groups/api/classic/status
type: interface
diff --git a/spec/if/rtems/status/timeout.yml b/spec/if/rtems/status/timeout.yml
index a33e115f..3693682e 100644
--- a/spec/if/rtems/status/timeout.yml
+++ b/spec/if/rtems/status/timeout.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that a blocking directive timed out.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that a blocking directive timed out.
-interface-definition:
+definition:
default: '6'
variants: []
-interface-description: null
-interface-name: RTEMS_TIMEOUT
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_TIMEOUT
+notes: null
type: interface
diff --git a/spec/if/rtems/status/too-many.yml b/spec/if/rtems/status/too-many.yml
index 214d94fb..ccdaa6f1 100644
--- a/spec/if/rtems/status/too-many.yml
+++ b/spec/if/rtems/status/too-many.yml
@@ -1,17 +1,17 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates you have attempted to create too many instances of
+ a particular object class.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates you have attempted to create too many instances of
- a particular object class.
-interface-definition:
+definition:
default: '5'
variants: []
-interface-description: null
-interface-name: RTEMS_TOO_MANY
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_TOO_MANY
+notes: null
type: interface
diff --git a/spec/if/rtems/status/unsatisfied.yml b/spec/if/rtems/status/unsatisfied.yml
index e702fc15..95d2a3af 100644
--- a/spec/if/rtems/status/unsatisfied.yml
+++ b/spec/if/rtems/status/unsatisfied.yml
@@ -1,16 +1,16 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This status code indicates that the request was not satisfied.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This status code indicates that the request was not satisfied.
-interface-definition:
+definition:
default: '13'
variants: []
-interface-description: null
-interface-name: RTEMS_UNSATISFIED
-interface-notes: null
+description: null
+enabled-by: true
interface-type: enumerator
links: []
+name: RTEMS_UNSATISFIED
+notes: null
type: interface
diff --git a/spec/if/rtems/types/header.yml b/spec/if/rtems/types/header.yml
index f8553130..2aa7e185 100644
--- a/spec/if/rtems/types/header.yml
+++ b/spec/if/rtems/types/header.yml
@@ -1,10 +1,10 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+domain: rtems
enabled-by: true
-interface-domain: rtems
-interface-path: rtems/rtems/types.h
-interface-prefix: cpukit/include
interface-type: header-file
links: []
+path: rtems/rtems/types.h
+prefix: cpukit/include
type: interface