summaryrefslogtreecommitdiffstats
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
parentspec: Add specification of interface group items (diff)
downloadrtems-central-8821c7d4313148585caaf6f93e85346537746587.tar.bz2
Rename interface attributes
-rw-r--r--config.yml2
-rw-r--r--rtemsqual/interface.py65
-rw-r--r--rtemsqual/tests/spec-interface/asm.yml10
-rw-r--r--rtemsqual/tests/spec-interface/command-line.yml2
-rw-r--r--rtemsqual/tests/spec-interface/define-a.yml10
-rw-r--r--rtemsqual/tests/spec-interface/define-b.yml10
-rw-r--r--rtemsqual/tests/spec-interface/define-c.yml10
-rw-r--r--rtemsqual/tests/spec-interface/define.yml20
-rw-r--r--rtemsqual/tests/spec-interface/enum.yml10
-rw-r--r--rtemsqual/tests/spec-interface/enum2.yml10
-rw-r--r--rtemsqual/tests/spec-interface/enum3.yml10
-rw-r--r--rtemsqual/tests/spec-interface/enum4.yml10
-rw-r--r--rtemsqual/tests/spec-interface/enumerator-0.yml10
-rw-r--r--rtemsqual/tests/spec-interface/enumerator-1.yml10
-rw-r--r--rtemsqual/tests/spec-interface/enumerator-2.yml10
-rw-r--r--rtemsqual/tests/spec-interface/enumerator-a.yml10
-rw-r--r--rtemsqual/tests/spec-interface/enumerator-b.yml12
-rw-r--r--rtemsqual/tests/spec-interface/float_t.yml2
-rw-r--r--rtemsqual/tests/spec-interface/func.yml20
-rw-r--r--rtemsqual/tests/spec-interface/func2.yml30
-rw-r--r--rtemsqual/tests/spec-interface/func3.yml14
-rw-r--r--rtemsqual/tests/spec-interface/func4.yml14
-rw-r--r--rtemsqual/tests/spec-interface/h.yml6
-rw-r--r--rtemsqual/tests/spec-interface/h2.yml6
-rw-r--r--rtemsqual/tests/spec-interface/h3.yml6
-rw-r--r--rtemsqual/tests/spec-interface/h4.yml6
-rw-r--r--rtemsqual/tests/spec-interface/macro.yml22
-rw-r--r--rtemsqual/tests/spec-interface/macro2.yml16
-rw-r--r--rtemsqual/tests/spec-interface/math.yml6
-rw-r--r--rtemsqual/tests/spec-interface/s.yml20
-rw-r--r--rtemsqual/tests/spec-interface/smp.yml2
-rw-r--r--rtemsqual/tests/spec-interface/stdint.yml6
-rw-r--r--rtemsqual/tests/spec-interface/td.yml12
-rw-r--r--rtemsqual/tests/spec-interface/td3.yml12
-rw-r--r--rtemsqual/tests/spec-interface/uint32_t.yml2
-rw-r--r--rtemsqual/tests/spec-interface/var.yml12
-rw-r--r--rtemsqual/tests/test_interface.py2
-rw-r--r--spec/if/build-options/ada.yml2
-rw-r--r--spec/if/build-options/cpuopts.yml6
-rw-r--r--spec/if/build-options/debug.yml2
-rw-r--r--spec/if/build-options/domain.yml2
-rw-r--r--spec/if/build-options/drvmgr.yml2
-rw-r--r--spec/if/build-options/multiprocessing.yml2
-rw-r--r--spec/if/build-options/networking.yml2
-rw-r--r--spec/if/build-options/paravirt.yml2
-rw-r--r--spec/if/build-options/posix.yml2
-rw-r--r--spec/if/build-options/profiling.yml2
-rw-r--r--spec/if/build-options/smp.yml2
-rw-r--r--spec/if/c/bool.yml4
-rw-r--r--spec/if/c/false.yml4
-rw-r--r--spec/if/c/int16_t.yml4
-rw-r--r--spec/if/c/int32_t.yml4
-rw-r--r--spec/if/c/int64_t.yml4
-rw-r--r--spec/if/c/int8_t.yml4
-rw-r--r--spec/if/c/intmax_t.yml4
-rw-r--r--spec/if/c/intptr_t.yml4
-rw-r--r--spec/if/c/null.yml4
-rw-r--r--spec/if/c/offsetof.yml2
-rw-r--r--spec/if/c/size_t.yml4
-rw-r--r--spec/if/c/stdatomic.yml6
-rw-r--r--spec/if/c/stdbool.yml6
-rw-r--r--spec/if/c/stddef.yml6
-rw-r--r--spec/if/c/stdint.yml6
-rw-r--r--spec/if/c/string.yml6
-rw-r--r--spec/if/c/sys-types.yml6
-rw-r--r--spec/if/c/time.yml6
-rw-r--r--spec/if/c/time_t.yml4
-rw-r--r--spec/if/c/true.yml4
-rw-r--r--spec/if/c/uint16_t.yml4
-rw-r--r--spec/if/c/uint32_t.yml4
-rw-r--r--spec/if/c/uint64_t.yml4
-rw-r--r--spec/if/c/uint8_t.yml4
-rw-r--r--spec/if/c/uintmax_t.yml4
-rw-r--r--spec/if/c/uintptr_t.yml4
-rw-r--r--spec/if/compiler/builtin-choose-expr.yml2
-rw-r--r--spec/if/compiler/builtin-expect.yml2
-rw-r--r--spec/if/compiler/builtin-return-address.yml2
-rw-r--r--spec/if/compiler/builtin-types-compatible-p.yml2
-rw-r--r--spec/if/compiler/builtin-unreachable.yml2
-rw-r--r--spec/if/compiler/cplusplus.yml2
-rw-r--r--spec/if/compiler/domain.yml2
-rw-r--r--spec/if/compiler/gnuc.yml2
-rw-r--r--spec/if/compiler/stdc-version.yml2
-rw-r--r--spec/if/compiler/typeof.yml2
-rw-r--r--spec/if/compiler/user-label-prefix.yml2
-rw-r--r--spec/if/impl/assert-unreachable.yml24
-rw-r--r--spec/if/impl/dequalify-types-not-compatible.yml28
-rw-r--r--spec/if/impl/isr/header.yml6
-rw-r--r--spec/if/impl/isr/stack-size.yml2
-rw-r--r--spec/if/impl/memory/header.yml6
-rw-r--r--spec/if/impl/memory/zero-before-use.yml2
-rw-r--r--spec/if/impl/mpci/configuration.yml2
-rw-r--r--spec/if/impl/mpci/header.yml6
-rw-r--r--spec/if/impl/object/header.yml6
-rw-r--r--spec/if/impl/object/is-unlimited.yml2
-rw-r--r--spec/if/impl/object/maximum-per-allocation.yml2
-rw-r--r--spec/if/impl/object/unlimited-objects.yml2
-rw-r--r--spec/if/impl/smp/header.yml6
-rw-r--r--spec/if/impl/smp/processor-configured-maximum.yml2
-rw-r--r--spec/if/impl/stack/allocator-allocate-type.yml2
-rw-r--r--spec/if/impl/stack/allocator-allocate.yml2
-rw-r--r--spec/if/impl/stack/allocator-avoids-workspace.yml2
-rw-r--r--spec/if/impl/stack/allocator-free-type.yml2
-rw-r--r--spec/if/impl/stack/allocator-free.yml2
-rw-r--r--spec/if/impl/stack/allocator-initialize-type.yml2
-rw-r--r--spec/if/impl/stack/allocator-initialize.yml2
-rw-r--r--spec/if/impl/stack/header.yml6
-rw-r--r--spec/if/impl/thread/header.yml6
-rw-r--r--spec/if/impl/thread/idle-body.yml2
-rw-r--r--spec/if/impl/thread/idle-stack-size.yml2
-rw-r--r--spec/if/impl/userext/header.yml6
-rw-r--r--spec/if/impl/userext/initial-count.yml2
-rw-r--r--spec/if/impl/userext/initial-extensions.yml2
-rw-r--r--spec/if/impl/watchdog/header.yml6
-rw-r--r--spec/if/impl/watchdog/microseconds-per-tick.yml2
-rw-r--r--spec/if/impl/watchdog/nanoseconds-per-tick.yml2
-rw-r--r--spec/if/impl/watchdog/ticks-per-timeslice.yml2
-rw-r--r--spec/if/impl/wkspace/header.yml6
-rw-r--r--spec/if/impl/wkspace/is-unified.yml2
-rw-r--r--spec/if/impl/wkspace/size.yml2
-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
-rw-r--r--spec/if/use/asm.yml2
-rw-r--r--spec/if/use/domain.yml2
-rw-r--r--spec/if/use/false.yml2
-rw-r--r--spec/if/use/true.yml2
258 files changed, 1946 insertions, 1938 deletions
diff --git a/config.yml b/config.yml
index 7b7853ea..49df14cc 100644
--- a/config.yml
+++ b/config.yml
@@ -84,7 +84,7 @@ interface:
- /if/build-options/domain
- /if/compiler/domain
- /if/use/domain
- interface-domains:
+ domains:
rtems: external/rtems
spec-verification:
root-type: /spec/root
diff --git a/rtemsqual/interface.py b/rtemsqual/interface.py
index 050c4dfc..9f3fa465 100644
--- a/rtemsqual/interface.py
+++ b/rtemsqual/interface.py
@@ -51,7 +51,7 @@ def _get_group_identifiers(groups: ItemMap) -> List[str]:
def _forward_declaration(item: Item) -> str:
target = item.map(item["interface-target"])
- return target["interface-type"] + " " + target["interface-name"]
+ return target["interface-type"] + " " + target["name"]
class _InterfaceMapper(ItemMapper):
@@ -76,7 +76,7 @@ class _InterfaceMapper(ItemMapper):
def get_value(self, item: Item, _path: str, _value: Any, key: str,
_index: Optional[int]) -> Any:
# pylint: disable=no-self-use
- if key == "interface-name" and item["type"] == "interface" and item[
+ if key == "name" and item["type"] == "interface" and item[
"interface-type"] == "forward-declaration":
return _forward_declaration(item)
raise KeyError
@@ -173,9 +173,9 @@ class Node:
@contextmanager
def _enum_struct_or_union(self) -> Iterator[None]:
self.content.add(self._get_description(self.item, self.ingroups))
- name = self.item["interface-name"]
+ name = self.item["name"]
typename = self.item["interface-type"]
- kind = self.item["interface-definition-kind"]
+ kind = self.item["definition-kind"]
if kind == f"{typename}-only":
self.content.append(f"{typename} {name} {{")
elif kind == "typedef-only":
@@ -209,10 +209,9 @@ class Node:
""" Generates a compound (struct or union). """
with self._enum_struct_or_union():
index = 0
- for definition in self.item["interface-definition"]:
+ for definition in self.item["definition"]:
self.content.add(
- _add_definition(self, self.item,
- f"interface-definition[{index}]",
+ _add_definition(self, self.item, f"definition[{index}]",
definition, Node._get_compound_definition))
index += 1
@@ -225,8 +224,8 @@ class Node:
continue
enumerator = self._get_description(link.item, {})
enumerator.append(
- _add_definition(self, link.item, "interface-definition",
- link.item["interface-definition"],
+ _add_definition(self, link.item, "definition",
+ link.item["definition"],
Node._get_enumerator_definition))
enumerators.append(enumerator)
for enumerator in enumerators[0:-1]:
@@ -307,13 +306,13 @@ class Node:
return content.lines
def _get_enumerator_definition(self, item: Item, definition: Any) -> Lines:
- name = item["interface-name"]
+ name = item["name"]
if definition:
return f"{name} = {self.substitute(definition)}"
return f"{name}"
def _get_define_definition(self, item: Item, definition: Any) -> Lines:
- name = item["interface-name"]
+ name = item["name"]
value = self.substitute(definition)
if value:
return f"#define {name} {value}".split("\n")
@@ -323,7 +322,7 @@ class Node:
ret = self.substitute(definition["return"])
if "body" in definition:
ret = "static inline " + ret
- name = item["interface-name"]
+ name = item["name"]
space = "" if ret.endswith("*") else " "
if definition["params"]:
params = [self.substitute(param) for param in definition["params"]]
@@ -349,8 +348,8 @@ class Node:
return line
def _get_macro_definition(self, item: Item, definition: Any) -> Lines:
- name = item["interface-name"]
- params = [param["name"] for param in item["interface-params"]]
+ name = item["name"]
+ params = [param["name"] for param in item["params"]]
param_line = ", ".join(params)
line = f"#define {name}({param_line})"
if len(line) > 79:
@@ -376,17 +375,16 @@ class Node:
content = CContent()
with content.doxygen_block():
content.add_ingroup(_get_group_identifiers(ingroups))
- content.add_brief_description(
- self.substitute(item["interface-brief"]))
- content.wrap(self.substitute(item["interface-description"]))
- content.wrap(self.substitute(item["interface-notes"]))
- if "interface-params" in item:
- for param in item["interface-params"]:
+ content.add_brief_description(self.substitute(item["brief"]))
+ content.wrap(self.substitute(item["description"]))
+ content.wrap(self.substitute(item["notes"]))
+ if "params" in item:
+ for param in item["params"]:
content.wrap(param["name"] + " " +
self.substitute(param["description"]),
initial_indent=_PARAM[param["dir"]])
- if "interface-return" in item:
- ret = item["interface-return"]
+ if "return" in item:
+ ret = item["return"]
for retval in ret["return-values"]:
content.wrap(self.substitute(retval["description"]),
initial_indent=f"@retval {retval['value']} ")
@@ -396,8 +394,8 @@ class Node:
def _add_generic_definition(self, get_lines: GetLines) -> None:
self.content.add(self._get_description(self.item, self.ingroups))
self.content.append(
- _add_definition(self, self.item, "interface-definition",
- self.item["interface-definition"], get_lines))
+ _add_definition(self, self.item, "definition",
+ self.item["definition"], get_lines))
_NODE_GENERATORS = {
@@ -504,16 +502,16 @@ class _HeaderFile:
with self._content.file_block():
self._content.add_ingroup(_get_group_identifiers(self._ingroups))
self._content.add_copyrights_and_licenses()
- with self._content.header_guard(self._item["interface-path"]):
+ with self._content.header_guard(self._item["path"]):
exp_mapper = _HeaderExpressionMapper(self._item,
self.enabled_by_defined)
includes = [
- CInclude(item["interface-path"],
+ CInclude(item["path"],
enabled_by_to_exp(item["enabled-by"], exp_mapper))
for item in self._includes if item != self._item
]
includes.extend([
- CInclude(link.item["interface-path"],
+ CInclude(link.item["path"],
enabled_by_to_exp(link["enabled-by"], exp_mapper))
for link in self._item.links_to_parents()
if link.role == "interface-include"
@@ -526,13 +524,13 @@ class _HeaderFile:
def write(self, domain_path: str) -> None:
""" Writes the header file. """
self._content.write(
- os.path.join(domain_path, self._item["interface-prefix"],
- self._item["interface-path"]))
+ os.path.join(domain_path, self._item["prefix"],
+ self._item["path"]))
def _generate_header_file(item: Item, domains: Dict[str, str],
enabled_by_defined: Dict[str, str]) -> None:
- domain_path = domains.get(item["interface-domain"], None)
+ domain_path = domains.get(item["domain"], None)
if domain_path is None:
return
header_file = _HeaderFile(item, enabled_by_defined)
@@ -555,8 +553,8 @@ def _gather_enabled_by_defined(item_level_interfaces: List[str],
for uid in item_level_interfaces:
for link in item_cache[uid].links_to_children():
if link.role == "interface-placement":
- define = f"defined(${{{link.item.uid}:/interface-name}})"
- enabled_by_defined[link.item["interface-name"]] = define
+ define = f"defined(${{{link.item.uid}:/name}})"
+ enabled_by_defined[link.item["name"]] = define
return enabled_by_defined
@@ -570,5 +568,4 @@ def generate(config: dict, item_cache: ItemCache) -> None:
enabled_by_defined = _gather_enabled_by_defined(
config["item-level-interfaces"], item_cache)
for item in item_cache.top_level.values():
- _visit_header_files(item, config["interface-domains"],
- enabled_by_defined)
+ _visit_header_files(item, config["domains"], enabled_by_defined)
diff --git a/rtemsqual/tests/spec-interface/asm.yml b/rtemsqual/tests/spec-interface/asm.yml
index 19d65c4c..2d4fe860 100644
--- a/rtemsqual/tests/spec-interface/asm.yml
+++ b/rtemsqual/tests/spec-interface/asm.yml
@@ -2,13 +2,13 @@ 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: null
-interface-definition:
+brief: null
+definition:
defaults: null
variants: []
-interface-description: null
-interface-name: ASM
-interface-notes: null
+description: null
+name: ASM
+notes: null
interface-type: define
links:
- role: interface-placement
diff --git a/rtemsqual/tests/spec-interface/command-line.yml b/rtemsqual/tests/spec-interface/command-line.yml
index 1a8fa7d7..c45ba3dc 100644
--- a/rtemsqual/tests/spec-interface/command-line.yml
+++ b/rtemsqual/tests/spec-interface/command-line.yml
@@ -2,7 +2,7 @@ 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-domain: command-line
+domain: command-line
interface-type: command-line
links: []
type: interface
diff --git a/rtemsqual/tests/spec-interface/define-a.yml b/rtemsqual/tests/spec-interface/define-a.yml
index ee139de1..6078f749 100644
--- a/rtemsqual/tests/spec-interface/define-a.yml
+++ b/rtemsqual/tests/spec-interface/define-a.yml
@@ -2,13 +2,13 @@ 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: null
-interface-definition:
+brief: null
+definition:
default: ''
variants: []
-interface-description: null
-interface-name: A
-interface-notes: null
+description: null
+name: A
+notes: null
interface-type: define
links:
- role: interface-placement
diff --git a/rtemsqual/tests/spec-interface/define-b.yml b/rtemsqual/tests/spec-interface/define-b.yml
index 3a050bd2..3136db5e 100644
--- a/rtemsqual/tests/spec-interface/define-b.yml
+++ b/rtemsqual/tests/spec-interface/define-b.yml
@@ -2,13 +2,13 @@ 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: null
-interface-definition:
+brief: null
+definition:
default: '1'
variants: []
-interface-description: null
-interface-name: B
-interface-notes: null
+description: null
+name: B
+notes: null
interface-type: define
links:
- role: interface-placement
diff --git a/rtemsqual/tests/spec-interface/define-c.yml b/rtemsqual/tests/spec-interface/define-c.yml
index b75dff8d..1a515a29 100644
--- a/rtemsqual/tests/spec-interface/define-c.yml
+++ b/rtemsqual/tests/spec-interface/define-c.yml
@@ -2,13 +2,13 @@ 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: null
-interface-definition:
+brief: null
+definition:
default: '2'
variants: []
-interface-description: null
-interface-name: C
-interface-notes: null
+description: null
+name: C
+notes: null
interface-type: define
links:
- role: interface-placement
diff --git a/rtemsqual/tests/spec-interface/define.yml b/rtemsqual/tests/spec-interface/define.yml
index bc9c1a93..2f72c770 100644
--- a/rtemsqual/tests/spec-interface/define.yml
+++ b/rtemsqual/tests/spec-interface/define.yml
@@ -2,24 +2,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: null
-interface-definition:
+brief: null
+definition:
default: |
\
- ((${float_t:/interface-name}) 123)
+ ((${float_t:/name}) 123)
variants:
- - definition: ((${float_t:/interface-name}) 456)
+ - definition: ((${float_t:/name}) 456)
enabled-by:
- - defined(${define-a:/interface-name})
- - (${define-b:/interface-name} > ${define-c:/interface-name})
- - definition: ((${float_t:/interface-name}) 789)
+ - defined(${define-a:/name})
+ - (${define-b:/name} > ${define-c:/name})
+ - definition: ((${float_t:/name}) 789)
enabled-by:
and:
- defined(C)
- defined(D)
-interface-description: null
-interface-name: DEFINE
-interface-notes: null
+description: null
+name: DEFINE
+notes: null
interface-type: define
links:
- role: interface-placement
diff --git a/rtemsqual/tests/spec-interface/enum.yml b/rtemsqual/tests/spec-interface/enum.yml
index c5676d6a..f3bcbc17 100644
--- a/rtemsqual/tests/spec-interface/enum.yml
+++ b/rtemsqual/tests/spec-interface/enum.yml
@@ -2,11 +2,11 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
-interface-brief: Enum brief description.
-interface-definition-kind: typedef-only
-interface-description: Enum description.
-interface-name: Enum
-interface-notes: null
+brief: Enum brief description.
+definition-kind: typedef-only
+description: Enum description.
+name: Enum
+notes: null
interface-type: enum
links:
- role: interface-placement
diff --git a/rtemsqual/tests/spec-interface/enum2.yml b/rtemsqual/tests/spec-interface/enum2.yml
index 4536097b..54ac9c21 100644
--- a/rtemsqual/tests/spec-interface/enum2.yml
+++ b/rtemsqual/tests/spec-interface/enum2.yml
@@ -2,11 +2,11 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
-interface-brief: Enum A brief description.
-interface-definition-kind: enum-only
-interface-description: null
-interface-name: EnumA
-interface-notes: null
+brief: Enum A brief description.
+definition-kind: enum-only
+description: null
+name: EnumA
+notes: null
interface-type: enum
links:
- role: interface-placement
diff --git a/rtemsqual/tests/spec-interface/enum3.yml b/rtemsqual/tests/spec-interface/enum3.yml
index e8972db1..eaaf1400 100644
--- a/rtemsqual/tests/spec-interface/enum3.yml
+++ b/rtemsqual/tests/spec-interface/enum3.yml
@@ -2,11 +2,11 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
-interface-brief: Enum B brief description.
-interface-definition-kind: typedef-and-enum
-interface-description: null
-interface-name: EnumB
-interface-notes: null
+brief: Enum B brief description.
+definition-kind: typedef-and-enum
+description: null
+name: EnumB
+notes: null
interface-type: enum
links:
- role: interface-enumerator
diff --git a/rtemsqual/tests/spec-interface/enum4.yml b/rtemsqual/tests/spec-interface/enum4.yml
index 5d3a5256..94297498 100644
--- a/rtemsqual/tests/spec-interface/enum4.yml
+++ b/rtemsqual/tests/spec-interface/enum4.yml
@@ -2,11 +2,11 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
-interface-brief: Enum C brief description.
-interface-definition-kind: typedef-and-enum
-interface-description: null
-interface-name: EnumC
-interface-notes: null
+brief: Enum C brief description.
+definition-kind: typedef-and-enum
+description: null
+name: EnumC
+notes: null
interface-type: enum
links:
- role: interface-placement
diff --git a/rtemsqual/tests/spec-interface/enumerator-0.yml b/rtemsqual/tests/spec-interface/enumerator-0.yml
index 0cb2b42a..7937340e 100644
--- a/rtemsqual/tests/spec-interface/enumerator-0.yml
+++ b/rtemsqual/tests/spec-interface/enumerator-0.yml
@@ -2,13 +2,13 @@ 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: Enumerator 0 brief description.
-interface-definition:
+brief: Enumerator 0 brief description.
+definition:
default: null
variants: []
-interface-description: null
-interface-name: ENUMERATOR_0
-interface-notes: null
+description: null
+name: ENUMERATOR_0
+notes: null
interface-type: enumerator
links: []
type: interface
diff --git a/rtemsqual/tests/spec-interface/enumerator-1.yml b/rtemsqual/tests/spec-interface/enumerator-1.yml
index 4efd22dc..83840471 100644
--- a/rtemsqual/tests/spec-interface/enumerator-1.yml
+++ b/rtemsqual/tests/spec-interface/enumerator-1.yml
@@ -2,13 +2,13 @@ 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: Enumerator 1 brief description.
-interface-definition:
+brief: Enumerator 1 brief description.
+definition:
default: null
variants: []
-interface-description: null
-interface-name: ENUMERATOR_1
-interface-notes: null
+description: null
+name: ENUMERATOR_1
+notes: null
interface-type: enumerator
links: []
type: interface
diff --git a/rtemsqual/tests/spec-interface/enumerator-2.yml b/rtemsqual/tests/spec-interface/enumerator-2.yml
index f015fad5..7dd4e7b1 100644
--- a/rtemsqual/tests/spec-interface/enumerator-2.yml
+++ b/rtemsqual/tests/spec-interface/enumerator-2.yml
@@ -2,13 +2,13 @@ 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: Enumerator 2 brief description.
-interface-definition:
+brief: Enumerator 2 brief description.
+definition:
default: null
variants: []
-interface-description: null
-interface-name: ENUMERATOR_2
-interface-notes: null
+description: null
+name: ENUMERATOR_2
+notes: null
interface-type: enumerator
links: []
type: interface
diff --git a/rtemsqual/tests/spec-interface/enumerator-a.yml b/rtemsqual/tests/spec-interface/enumerator-a.yml
index b5f8fb0e..c5018b70 100644
--- a/rtemsqual/tests/spec-interface/enumerator-a.yml
+++ b/rtemsqual/tests/spec-interface/enumerator-a.yml
@@ -2,13 +2,13 @@ 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: Enumerator A brief description.
-interface-definition:
+brief: Enumerator A brief description.
+definition:
default: '17'
variants: []
-interface-description: null
-interface-name: ENUMERATOR_A
-interface-notes: null
+description: null
+name: ENUMERATOR_A
+notes: null
interface-type: enumerator
links: []
type: interface
diff --git a/rtemsqual/tests/spec-interface/enumerator-b.yml b/rtemsqual/tests/spec-interface/enumerator-b.yml
index 618e89b1..9bcac74f 100644
--- a/rtemsqual/tests/spec-interface/enumerator-b.yml
+++ b/rtemsqual/tests/spec-interface/enumerator-b.yml
@@ -2,13 +2,13 @@ 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: Enumerator B brief description.
-interface-definition:
- default: ${enumerator-a:/interface-name}
+brief: Enumerator B brief description.
+definition:
+ default: ${enumerator-a:/name}
variants: []
-interface-description: null
-interface-name: ENUMERATOR_B
-interface-notes: null
+description: null
+name: ENUMERATOR_B
+notes: null
interface-type: enumerator
links: []
type: interface
diff --git a/rtemsqual/tests/spec-interface/float_t.yml b/rtemsqual/tests/spec-interface/float_t.yml
index b0620009..b390553d 100644
--- a/rtemsqual/tests/spec-interface/float_t.yml
+++ b/rtemsqual/tests/spec-interface/float_t.yml
@@ -2,7 +2,7 @@ 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-name: float_t
+name: float_t
interface-type: typedef
links:
- role: interface-placement
diff --git a/rtemsqual/tests/spec-interface/func.yml b/rtemsqual/tests/spec-interface/func.yml
index 016f6db6..5c287b8f 100644
--- a/rtemsqual/tests/spec-interface/func.yml
+++ b/rtemsqual/tests/spec-interface/func.yml
@@ -2,20 +2,20 @@ 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: Function brief description.
-interface-definition:
+brief: Function brief description.
+definition:
default:
params:
- - int ${.:/interface-params[0]/name}
- - const int *${.:/interface-params[1]/name}
- - int *${.:/interface-params[2]/name}
- - int *${.:/interface-params[3]/name}
+ - int ${.:/params[0]/name}
+ - const int *${.:/params[1]/name}
+ - int *${.:/params[2]/name}
+ - int *${.:/params[3]/name}
return: void
variants: []
-interface-description: Function description.
-interface-name: Function
-interface-notes: null
-interface-params:
+description: Function description.
+name: Function
+notes: null
+params:
- description: is parameter 0.
dir: null
name: Param0
diff --git a/rtemsqual/tests/spec-interface/func2.yml b/rtemsqual/tests/spec-interface/func2.yml
index 63258909..04abb820 100644
--- a/rtemsqual/tests/spec-interface/func2.yml
+++ b/rtemsqual/tests/spec-interface/func2.yml
@@ -2,25 +2,25 @@ 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: Very long function brief description.
-interface-definition:
+brief: Very long function brief description.
+definition:
default:
body: |
- (void) ${.:/interface-params[1]/name};
- (void) ${.:/interface-params[2]/name};
- (void) ${.:/interface-params[3]/name};
- return ${.:/interface-params[0]/name} + 1;
+ (void) ${.:/params[1]/name};
+ (void) ${.:/params[2]/name};
+ (void) ${.:/params[3]/name};
+ return ${.:/params[0]/name} + 1;
params:
- - int ${.:/interface-params[0]/name}
- - const ${forward-decl:/interface-name} *${.:/interface-params[1]/name}
- - ${forward-decl:/interface-name} *${.:/interface-params[2]/name}
- - ${forward-decl:/interface-name} *${.:/interface-params[3]/name}
+ - int ${.:/params[0]/name}
+ - const ${forward-decl:/name} *${.:/params[1]/name}
+ - ${forward-decl:/name} *${.:/params[2]/name}
+ - ${forward-decl:/name} *${.:/params[3]/name}
return: int
variants: []
-interface-description: null
-interface-name: VeryLongFunction
-interface-notes: null
-interface-params:
+description: null
+name: VeryLongFunction
+notes: null
+params:
- description: |
is very long parameter 0 with some super important and extra very long
description which makes a lot of sense.
@@ -35,7 +35,7 @@ interface-params:
- description: is very long parameter 3.
dir: inout
name: VeryLongParam3
-interface-return:
+return:
return: Sometimes some value.
return-values:
- description: is returned, in case A.
diff --git a/rtemsqual/tests/spec-interface/func3.yml b/rtemsqual/tests/spec-interface/func3.yml
index bc751d65..9bee4821 100644
--- a/rtemsqual/tests/spec-interface/func3.yml
+++ b/rtemsqual/tests/spec-interface/func3.yml
@@ -2,17 +2,17 @@ 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: Void function brief description.
-interface-definition:
+brief: Void function brief description.
+definition:
default:
params: []
return: void
variants: []
-interface-description: null
-interface-name: VoidFunction
-interface-notes: null
-interface-params: []
-interface-return:
+description: null
+name: VoidFunction
+notes: null
+params: []
+return:
return: null
return-values: []
interface-type: function
diff --git a/rtemsqual/tests/spec-interface/func4.yml b/rtemsqual/tests/spec-interface/func4.yml
index 37bca013..4f5032fa 100644
--- a/rtemsqual/tests/spec-interface/func4.yml
+++ b/rtemsqual/tests/spec-interface/func4.yml
@@ -2,17 +2,17 @@ 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: Void function brief description with very long return type.
-interface-definition:
+brief: Void function brief description with very long return type.
+definition:
default:
params: []
return: VeryLongLongLongLongLongLongLongLongLongLongLongLongLongLongLongType
variants: []
-interface-description: null
-interface-name: VoidFunction
-interface-notes: null
-interface-params: []
-interface-return:
+description: null
+name: VoidFunction
+notes: null
+params: []
+return:
return: null
return-values: []
interface-type: function
diff --git a/rtemsqual/tests/spec-interface/h.yml b/rtemsqual/tests/spec-interface/h.yml
index 50f969b6..d6198d2a 100644
--- a/rtemsqual/tests/spec-interface/h.yml
+++ b/rtemsqual/tests/spec-interface/h.yml
@@ -2,9 +2,9 @@ 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: []
-interface-domain: abc
-interface-path: h.h
-interface-prefix: include
+domain: abc
+path: h.h
+prefix: include
interface-type: header-file
links:
- role: interface-include
diff --git a/rtemsqual/tests/spec-interface/h2.yml b/rtemsqual/tests/spec-interface/h2.yml
index c0adda60..4872b4b6 100644
--- a/rtemsqual/tests/spec-interface/h2.yml
+++ b/rtemsqual/tests/spec-interface/h2.yml
@@ -3,9 +3,9 @@ copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by:
not: ASM
-interface-domain: abc
-interface-path: h2.h
-interface-prefix: include
+domain: abc
+path: h2.h
+prefix: include
interface-type: header-file
links: []
type: interface
diff --git a/rtemsqual/tests/spec-interface/h3.yml b/rtemsqual/tests/spec-interface/h3.yml
index fb5d0435..f8cdd99a 100644
--- a/rtemsqual/tests/spec-interface/h3.yml
+++ b/rtemsqual/tests/spec-interface/h3.yml
@@ -2,9 +2,9 @@ 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-domain: abc
-interface-path: h3.h
-interface-prefix: include
+domain: abc
+path: h3.h
+prefix: include
interface-type: header-file
links: []
type: interface
diff --git a/rtemsqual/tests/spec-interface/h4.yml b/rtemsqual/tests/spec-interface/h4.yml
index 47301dcd..e6c89d69 100644
--- a/rtemsqual/tests/spec-interface/h4.yml
+++ b/rtemsqual/tests/spec-interface/h4.yml
@@ -2,9 +2,9 @@ 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-domain: abc
-interface-path: h4.h
-interface-prefix: include
+domain: abc
+path: h4.h
+prefix: include
interface-type: header-file
links: []
type: interface
diff --git a/rtemsqual/tests/spec-interface/macro.yml b/rtemsqual/tests/spec-interface/macro.yml
index 1d49c659..a1e0e788 100644
--- a/rtemsqual/tests/spec-interface/macro.yml
+++ b/rtemsqual/tests/spec-interface/macro.yml
@@ -2,20 +2,20 @@ 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: Very long macro brief description.
-interface-definition:
+brief: Very long macro brief description.
+definition:
default: |
do {
- (void) ${.:/interface-params[1]/name};
- (void) ${.:/interface-params[2]/name};
- (void) ${.:/interface-params[3]/name};
+ (void) ${.:/params[1]/name};
+ (void) ${.:/params[2]/name};
+ (void) ${.:/params[3]/name};
} while ( 0 );
- ${.:/interface-params[0]/name} + 1;
+ ${.:/params[0]/name} + 1;
variants: []
-interface-description: null
-interface-name: VERY_LONG_MACRO
-interface-notes: null
-interface-params:
+description: null
+name: VERY_LONG_MACRO
+notes: null
+params:
- description: |
is very long parameter 0 with some super important and extra very long
description which makes a lot of sense.
@@ -30,7 +30,7 @@ interface-params:
- description: is very long parameter 3.
dir: inout
name: VeryLongParam3
-interface-return:
+return:
return: Sometimes some value.
return-values:
- description: is returned, in case A.
diff --git a/rtemsqual/tests/spec-interface/macro2.yml b/rtemsqual/tests/spec-interface/macro2.yml
index b59dd03d..36e05169 100644
--- a/rtemsqual/tests/spec-interface/macro2.yml
+++ b/rtemsqual/tests/spec-interface/macro2.yml
@@ -2,22 +2,22 @@ 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: Short macro brief description.
-interface-definition:
+brief: Short macro brief description.
+definition:
default: |
- ( ( ${.:/interface-params[0]/name} ) + 1 )
+ ( ( ${.:/params[0]/name} ) + 1 )
variants:
- definition: ''
enabled-by: '0'
-interface-description: null
-interface-name: MACRO
-interface-notes: null
-interface-params:
+description: null
+name: MACRO
+notes: null
+params:
- description: |
is parameter 0.
dir: null
name: Param0
-interface-return:
+return:
return: Sometimes some value.
return-values: []
interface-type: macro
diff --git a/rtemsqual/tests/spec-interface/math.yml b/rtemsqual/tests/spec-interface/math.yml
index fbb9cdbb..b99493f1 100644
--- a/rtemsqual/tests/spec-interface/math.yml
+++ b/rtemsqual/tests/spec-interface/math.yml
@@ -2,9 +2,9 @@ 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-domain: c
-interface-path: math.h
-interface-prefix: null
+domain: c
+path: math.h
+prefix: null
interface-type: header-file
links: []
type: interface
diff --git a/rtemsqual/tests/spec-interface/s.yml b/rtemsqual/tests/spec-interface/s.yml
index 27812ac4..bd040ed9 100644
--- a/rtemsqual/tests/spec-interface/s.yml
+++ b/rtemsqual/tests/spec-interface/s.yml
@@ -2,14 +2,14 @@ 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: null
-interface-definition:
+brief: null
+definition:
- default:
brief: Brief union description.
definition:
- default:
brief: Brief member description.
- definition: ${uint32_t:/interface-name} ${.:name}
+ definition: ${uint32_t:/name} ${.:name}
description: Member description.
kind: member
name: some_member
@@ -19,14 +19,14 @@ interface-definition:
definition:
- default:
brief: Brief member 2 description.
- definition: ${uint32_t:/interface-name} ${.:name}
+ definition: ${uint32_t:/name} ${.:name}
description: Member 2 description.
kind: member
name: some_member_2
variants: []
- default:
brief: Brief member 3 description.
- definition: ${enum:/interface-name} ${.:name}
+ definition: ${enum:/name} ${.:name}
description: Member 3 description.
kind: member
name: some_member_3
@@ -41,15 +41,15 @@ interface-definition:
variants: []
- default:
brief: Brief member 4 description.
- definition: ${enum:/interface-name} ${.:name}
+ definition: ${enum:/name} ${.:name}
description: Member 4 description.
kind: member
name: some_member_4
variants: []
-interface-definition-kind: struct-only
-interface-description: null
-interface-name: Struct
-interface-notes: null
+definition-kind: struct-only
+description: null
+name: Struct
+notes: null
interface-type: struct
links:
- role: interface-placement
diff --git a/rtemsqual/tests/spec-interface/smp.yml b/rtemsqual/tests/spec-interface/smp.yml
index 56137171..dcf41bc0 100644
--- a/rtemsqual/tests/spec-interface/smp.yml
+++ b/rtemsqual/tests/spec-interface/smp.yml
@@ -2,7 +2,7 @@ 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-name: RTEMS_SMP
+name: RTEMS_SMP
interface-type: define
links:
- role: interface-placement
diff --git a/rtemsqual/tests/spec-interface/stdint.yml b/rtemsqual/tests/spec-interface/stdint.yml
index cc587330..961a6232 100644
--- a/rtemsqual/tests/spec-interface/stdint.yml
+++ b/rtemsqual/tests/spec-interface/stdint.yml
@@ -2,9 +2,9 @@ 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-domain: c
-interface-path: stdint.h
-interface-prefix: null
+domain: c
+path: stdint.h
+prefix: null
interface-type: header-file
links: []
type: interface
diff --git a/rtemsqual/tests/spec-interface/td.yml b/rtemsqual/tests/spec-interface/td.yml
index 37ee4dae..42f6305e 100644
--- a/rtemsqual/tests/spec-interface/td.yml
+++ b/rtemsqual/tests/spec-interface/td.yml
@@ -2,14 +2,14 @@ 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: Typedef Integer brief description.
-interface-definition:
+brief: Typedef Integer brief description.
+definition:
default: |
- ${uint32_t:/interface-name} ${.:/interface-name} /* ${other:/comment} */
+ ${uint32_t:/name} ${.:/name} /* ${other:/comment} */
variants: []
-interface-description: Typedef Integer description.
-interface-name: Integer
-interface-notes: null
+description: Typedef Integer description.
+name: Integer
+notes: null
interface-type: typedef
links:
- role: other
diff --git a/rtemsqual/tests/spec-interface/td3.yml b/rtemsqual/tests/spec-interface/td3.yml
index 85e864a2..533976b2 100644
--- a/rtemsqual/tests/spec-interface/td3.yml
+++ b/rtemsqual/tests/spec-interface/td3.yml
@@ -2,16 +2,16 @@ 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: null
-interface-definition:
+brief: null
+definition:
default: null
variants:
- definition: |
- ${uint32_t:/interface-name} ${.:/interface-name}
+ ${uint32_t:/name} ${.:/name}
enabled-by: defined(RTEMS_SMP)
-interface-description: null
-interface-name: Integer3
-interface-notes: null
+description: null
+name: Integer3
+notes: null
interface-type: typedef
links:
- role: interface-placement
diff --git a/rtemsqual/tests/spec-interface/uint32_t.yml b/rtemsqual/tests/spec-interface/uint32_t.yml
index 0777f743..a15c93a6 100644
--- a/rtemsqual/tests/spec-interface/uint32_t.yml
+++ b/rtemsqual/tests/spec-interface/uint32_t.yml
@@ -2,7 +2,7 @@ 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-name: uint32_t
+name: uint32_t
interface-type: typedef
links:
- role: other
diff --git a/rtemsqual/tests/spec-interface/var.yml b/rtemsqual/tests/spec-interface/var.yml
index 1bd5fb8b..191dbfa3 100644
--- a/rtemsqual/tests/spec-interface/var.yml
+++ b/rtemsqual/tests/spec-interface/var.yml
@@ -3,14 +3,14 @@ copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by:
not: ASM
-interface-brief: Variable brief description.
-interface-definition:
+brief: Variable brief description.
+definition:
default: |
- ${forward-decl:/interface-name} *${.:/interface-name}
+ ${forward-decl:/name} *${.:/name}
variants: []
-interface-description: Variable description.
-interface-name: Variable
-interface-notes: null
+description: Variable description.
+name: Variable
+notes: null
interface-type: variable
links:
- role: interface-ingroup
diff --git a/rtemsqual/tests/test_interface.py b/rtemsqual/tests/test_interface.py
index 46886815..657f9ce5 100644
--- a/rtemsqual/tests/test_interface.py
+++ b/rtemsqual/tests/test_interface.py
@@ -40,7 +40,7 @@ def test_interface(tmpdir):
interface_config["item-level-interfaces"] = []
base_directory = os.path.join(tmpdir, "base")
interface_domains = {"abc": base_directory}
- interface_config["interface-domains"] = interface_domains
+ interface_config["domains"] = interface_domains
item_cache_config["paths"] = [os.path.normpath(tmpdir)]
generate(interface_config, ItemCache(item_cache_config))
diff --git a/spec/if/build-options/ada.yml b/spec/if/build-options/ada.yml
index d2df7a4c..3fddde5d 100644
--- a/spec/if/build-options/ada.yml
+++ b/spec/if/build-options/ada.yml
@@ -2,9 +2,9 @@ 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-name: __RTEMS_ADA__
interface-type: define
links:
- role: interface-placement
uid: domain
+name: __RTEMS_ADA__
type: interface
diff --git a/spec/if/build-options/cpuopts.yml b/spec/if/build-options/cpuopts.yml
index 8de6d90c..7cc95f30 100644
--- a/spec/if/build-options/cpuopts.yml
+++ b/spec/if/build-options/cpuopts.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: build-options
enabled-by: true
-interface-domain: build-options
-interface-path: rtems/score/cpuopts.h
-interface-prefix: ''
interface-type: header-file
links: []
+path: rtems/score/cpuopts.h
+prefix: ''
type: interface
diff --git a/spec/if/build-options/debug.yml b/spec/if/build-options/debug.yml
index 70a1e94c..6154269c 100644
--- a/spec/if/build-options/debug.yml
+++ b/spec/if/build-options/debug.yml
@@ -2,9 +2,9 @@ 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-name: RTEMS_DEBUG
interface-type: define
links:
- role: interface-placement
uid: domain
+name: RTEMS_DEBUG
type: interface
diff --git a/spec/if/build-options/domain.yml b/spec/if/build-options/domain.yml
index 2377ec2f..c72dacb3 100644
--- a/spec/if/build-options/domain.yml
+++ b/spec/if/build-options/domain.yml
@@ -1,8 +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: build-options
enabled-by: true
-interface-domain: build-options
interface-type: container
links: []
type: interface
diff --git a/spec/if/build-options/drvmgr.yml b/spec/if/build-options/drvmgr.yml
index d48b85d5..84a84c3c 100644
--- a/spec/if/build-options/drvmgr.yml
+++ b/spec/if/build-options/drvmgr.yml
@@ -2,9 +2,9 @@ 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-name: RTEMS_DRVMGR_STARTUP
interface-type: define
links:
- role: interface-placement
uid: domain
+name: RTEMS_DRVMGR_STARTUP
type: interface
diff --git a/spec/if/build-options/multiprocessing.yml b/spec/if/build-options/multiprocessing.yml
index d26fc7e6..43236695 100644
--- a/spec/if/build-options/multiprocessing.yml
+++ b/spec/if/build-options/multiprocessing.yml
@@ -2,9 +2,9 @@ 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-name: RTEMS_MULTIPROCESSING
interface-type: define
links:
- role: interface-placement
uid: domain
+name: RTEMS_MULTIPROCESSING
type: interface
diff --git a/spec/if/build-options/networking.yml b/spec/if/build-options/networking.yml
index 1f2cb69d..a4b36b3f 100644
--- a/spec/if/build-options/networking.yml
+++ b/spec/if/build-options/networking.yml
@@ -2,9 +2,9 @@ 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-name: RTEMS_NETWORKING
interface-type: define
links:
- role: interface-placement
uid: domain
+name: RTEMS_NETWORKING
type: interface
diff --git a/spec/if/build-options/paravirt.yml b/spec/if/build-options/paravirt.yml
index daa24d44..a4022f3c 100644
--- a/spec/if/build-options/paravirt.yml
+++ b/spec/if/build-options/paravirt.yml
@@ -2,9 +2,9 @@ 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-name: RTEMS_PARAVIRT
interface-type: define
links:
- role: interface-placement
uid: domain
+name: RTEMS_PARAVIRT
type: interface
diff --git a/spec/if/build-options/posix.yml b/spec/if/build-options/posix.yml
index 50b51aa7..9cab31f8 100644
--- a/spec/if/build-options/posix.yml
+++ b/spec/if/build-options/posix.yml
@@ -2,9 +2,9 @@ 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-name: RTEMS_POSIX_API
interface-type: define
links:
- role: interface-placement
uid: domain
+name: RTEMS_POSIX_API
type: interface
diff --git a/spec/if/build-options/profiling.yml b/spec/if/build-options/profiling.yml
index ace93b5d..a99aa47f 100644
--- a/spec/if/build-options/profiling.yml
+++ b/spec/if/build-options/profiling.yml
@@ -2,9 +2,9 @@ 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-name: RTEMS_PROFILING
interface-type: define
links:
- role: interface-placement
uid: domain
+name: RTEMS_PROFILING
type: interface
diff --git a/spec/if/build-options/smp.yml b/spec/if/build-options/smp.yml
index 4fc3590a..01345fa6 100644
--- a/spec/if/build-options/smp.yml
+++ b/spec/if/build-options/smp.yml
@@ -2,9 +2,9 @@ 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-name: RTEMS_SMP
interface-type: define
links:
- role: interface-placement
uid: domain
+name: RTEMS_SMP
type: interface
diff --git a/spec/if/c/bool.yml b/spec/if/c/bool.yml
index 828ea53d..4ce8ea82 100644
--- a/spec/if/c/bool.yml
+++ b/spec/if/c/bool.yml
@@ -1,11 +1,11 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+domain: c
enabled-by: true
-interface-domain: c
-interface-name: bool
interface-type: typedef
links:
- role: interface-placement
uid: stdbool
+name: bool
type: interface
diff --git a/spec/if/c/false.yml b/spec/if/c/false.yml
index 9e3d0c50..7122a35a 100644
--- a/spec/if/c/false.yml
+++ b/spec/if/c/false.yml
@@ -1,11 +1,11 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+domain: c
enabled-by: true
-interface-domain: c
-interface-name: 'false'
interface-type: define
links:
- role: interface-placement
uid: stdbool
+name: 'false'
type: interface
diff --git a/spec/if/c/int16_t.yml b/spec/if/c/int16_t.yml
index 0f7f86f9..8e391fc2 100644
--- a/spec/if/c/int16_t.yml
+++ b/spec/if/c/int16_t.yml
@@ -1,11 +1,11 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+domain: c
enabled-by: true
-interface-domain: c
-interface-name: int16_t
interface-type: typedef
links:
- role: interface-placement
uid: stdint
+name: int16_t
type: interface
diff --git a/spec/if/c/int32_t.yml b/spec/if/c/int32_t.yml
index 3d1816f3..f2d46283 100644
--- a/spec/if/c/int32_t.yml
+++ b/spec/if/c/int32_t.yml
@@ -1,11 +1,11 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+domain: c
enabled-by: true
-interface-domain: c
-interface-name: int32_t
interface-type: typedef
links:
- role: interface-placement
uid: stdint
+name: int32_t
type: interface
diff --git a/spec/if/c/int64_t.yml b/spec/if/c/int64_t.yml
index f2af1c44..1b3cee3a 100644
--- a/spec/if/c/int64_t.yml
+++ b/spec/if/c/int64_t.yml
@@ -1,11 +1,11 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+domain: c
enabled-by: true
-interface-domain: c
-interface-name: int64_t
interface-type: typedef
links:
- role: interface-placement
uid: stdint
+name: int64_t
type: interface
diff --git a/spec/if/c/int8_t.yml b/spec/if/c/int8_t.yml
index 2d16f4ec..97daa5bd 100644
--- a/spec/if/c/int8_t.yml
+++ b/spec/if/c/int8_t.yml
@@ -1,11 +1,11 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+domain: c
enabled-by: true
-interface-domain: c
-interface-name: int8_t
interface-type: typedef
links:
- role: interface-placement
uid: stdint
+name: int8_t
type: interface
diff --git a/spec/if/c/intmax_t.yml b/spec/if/c/intmax_t.yml
index 5d5eb068..a21bfa2e 100644
--- a/spec/if/c/intmax_t.yml
+++ b/spec/if/c/intmax_t.yml
@@ -1,11 +1,11 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+domain: c
enabled-by: true
-interface-domain: c
-interface-name: intmax_t
interface-type: typedef
links:
- role: interface-placement
uid: stdint
+name: intmax_t
type: interface
diff --git a/spec/if/c/intptr_t.yml b/spec/if/c/intptr_t.yml
index 33f6935b..2cebd49a 100644
--- a/spec/if/c/intptr_t.yml
+++ b/spec/if/c/intptr_t.yml
@@ -1,11 +1,11 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+domain: c
enabled-by: true
-interface-domain: c
-interface-name: intptr_t
interface-type: typedef
links:
- role: interface-placement
uid: stdint
+name: intptr_t
type: interface
diff --git a/spec/if/c/null.yml b/spec/if/c/null.yml
index 9fedc1aa..feaf8434 100644
--- a/spec/if/c/null.yml
+++ b/spec/if/c/null.yml
@@ -1,11 +1,11 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+domain: c
enabled-by: true
-interface-domain: c
-interface-name: 'NULL'
interface-type: define
links:
- role: interface-placement
uid: stddef
+name: 'NULL'
type: interface
diff --git a/spec/if/c/offsetof.yml b/spec/if/c/offsetof.yml
index fabbb6d2..73cab71e 100644
--- a/spec/if/c/offsetof.yml
+++ b/spec/if/c/offsetof.yml
@@ -2,9 +2,9 @@ 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-name: offsetof
interface-type: macro
links:
- role: interface-placement
uid: stddef
+name: offsetof
type: interface
diff --git a/spec/if/c/size_t.yml b/spec/if/c/size_t.yml
index a15c2c06..b7fa3f51 100644
--- a/spec/if/c/size_t.yml
+++ b/spec/if/c/size_t.yml
@@ -1,11 +1,11 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+domain: c
enabled-by: true
-interface-domain: c
-interface-name: size_t
interface-type: typedef
links:
- role: interface-placement
uid: stddef
+name: size_t
type: interface
diff --git a/spec/if/c/stdatomic.yml b/spec/if/c/stdatomic.yml
index 87566959..408c9841 100644
--- a/spec/if/c/stdatomic.yml
+++ b/spec/if/c/stdatomic.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: c
enabled-by: true
-interface-domain: c
-interface-path: stdatomic.h
-interface-prefix: ''
interface-type: header-file
links: []
+path: stdatomic.h
+prefix: ''
type: interface
diff --git a/spec/if/c/stdbool.yml b/spec/if/c/stdbool.yml
index 411c4d8f..90b188ab 100644
--- a/spec/if/c/stdbool.yml
+++ b/spec/if/c/stdbool.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: c
enabled-by: true
-interface-domain: c
-interface-path: stdbool.h
-interface-prefix: ''
interface-type: header-file
links: []
+path: stdbool.h
+prefix: ''
type: interface
diff --git a/spec/if/c/stddef.yml b/spec/if/c/stddef.yml
index e51c1037..fd3a0289 100644
--- a/spec/if/c/stddef.yml
+++ b/spec/if/c/stddef.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: c
enabled-by: true
-interface-domain: c
-interface-path: stddef.h
-interface-prefix: ''
interface-type: header-file
links: []
+path: stddef.h
+prefix: ''
type: interface
diff --git a/spec/if/c/stdint.yml b/spec/if/c/stdint.yml
index 6d0e2ab1..2a299a3d 100644
--- a/spec/if/c/stdint.yml
+++ b/spec/if/c/stdint.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: c
enabled-by: true
-interface-domain: c
-interface-path: stdint.h
-interface-prefix: ''
interface-type: header-file
links: []
+path: stdint.h
+prefix: ''
type: interface
diff --git a/spec/if/c/string.yml b/spec/if/c/string.yml
index bc91dc15..c8ff3315 100644
--- a/spec/if/c/string.yml
+++ b/spec/if/c/string.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: c
enabled-by: true
-interface-domain: c
-interface-path: string.h
-interface-prefix: ''
interface-type: header-file
links: []
+path: string.h
+prefix: ''
type: interface
diff --git a/spec/if/c/sys-types.yml b/spec/if/c/sys-types.yml
index 84363f29..d31c2214 100644
--- a/spec/if/c/sys-types.yml
+++ b/spec/if/c/sys-types.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: c
enabled-by: true
-interface-domain: c
-interface-path: sys/types.h
-interface-prefix: ''
interface-type: header-file
links: []
+path: sys/types.h
+prefix: ''
type: interface
diff --git a/spec/if/c/time.yml b/spec/if/c/time.yml
index 46d6aff9..d003e84d 100644
--- a/spec/if/c/time.yml
+++ b/spec/if/c/time.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: c
enabled-by: true
-interface-domain: c
-interface-path: time.h
-interface-prefix: ''
interface-type: header-file
links: []
+path: time.h
+prefix: ''
type: interface
diff --git a/spec/if/c/time_t.yml b/spec/if/c/time_t.yml
index 3a55becd..ad460e27 100644
--- a/spec/if/c/time_t.yml
+++ b/spec/if/c/time_t.yml
@@ -1,11 +1,11 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+domain: c
enabled-by: true
-interface-domain: c
-interface-name: time_t
interface-type: typedef
links:
- role: interface-placement
uid: time
+name: time_t
type: interface
diff --git a/spec/if/c/true.yml b/spec/if/c/true.yml
index a93173bd..68b60536 100644
--- a/spec/if/c/true.yml
+++ b/spec/if/c/true.yml
@@ -1,11 +1,11 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+domain: c
enabled-by: true
-interface-domain: c
-interface-name: 'true'
interface-type: define
links:
- role: interface-placement
uid: stdbool
+name: 'true'
type: interface
diff --git a/spec/if/c/uint16_t.yml b/spec/if/c/uint16_t.yml
index 35255b6e..3ca1572d 100644
--- a/spec/if/c/uint16_t.yml
+++ b/spec/if/c/uint16_t.yml
@@ -1,11 +1,11 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+domain: c
enabled-by: true
-interface-domain: c
-interface-name: uint16_t
interface-type: typedef
links:
- role: interface-placement
uid: stdint
+name: uint16_t
type: interface
diff --git a/spec/if/c/uint32_t.yml b/spec/if/c/uint32_t.yml
index 24a04f63..bbb79911 100644
--- a/spec/if/c/uint32_t.yml
+++ b/spec/if/c/uint32_t.yml
@@ -1,11 +1,11 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+domain: c
enabled-by: true
-interface-domain: c
-interface-name: uint32_t
interface-type: typedef
links:
- role: interface-placement
uid: stdint
+name: uint32_t
type: interface
diff --git a/spec/if/c/uint64_t.yml b/spec/if/c/uint64_t.yml
index b2dd0e21..65c04776 100644
--- a/spec/if/c/uint64_t.yml
+++ b/spec/if/c/uint64_t.yml
@@ -1,11 +1,11 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+domain: c
enabled-by: true
-interface-domain: c
-interface-name: uint64_t
interface-type: typedef
links:
- role: interface-placement
uid: stdint
+name: uint64_t
type: interface
diff --git a/spec/if/c/uint8_t.yml b/spec/if/c/uint8_t.yml
index 80cc9e63..a02f768b 100644
--- a/spec/if/c/uint8_t.yml
+++ b/spec/if/c/uint8_t.yml
@@ -1,11 +1,11 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+domain: c
enabled-by: true
-interface-domain: c
-interface-name: uint8_t
interface-type: typedef
links:
- role: interface-placement
uid: stdint
+name: uint8_t
type: interface
diff --git a/spec/if/c/uintmax_t.yml b/spec/if/c/uintmax_t.yml
index 1c43a752..128db501 100644
--- a/spec/if/c/uintmax_t.yml
+++ b/spec/if/c/uintmax_t.yml
@@ -1,11 +1,11 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+domain: c
enabled-by: true
-interface-domain: c
-interface-name: uintmax_t
interface-type: typedef
links:
- role: interface-placement
uid: stdint
+name: uintmax_t
type: interface
diff --git a/spec/if/c/uintptr_t.yml b/spec/if/c/uintptr_t.yml
index 8c607be3..ee4dd3d4 100644
--- a/spec/if/c/uintptr_t.yml
+++ b/spec/if/c/uintptr_t.yml
@@ -1,11 +1,11 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+domain: c
enabled-by: true
-interface-domain: c
-interface-name: uintptr_t
interface-type: typedef
links:
- role: interface-placement
uid: stdint
+name: uintptr_t
type: interface
diff --git a/spec/if/compiler/builtin-choose-expr.yml b/spec/if/compiler/builtin-choose-expr.yml
index ee3331c7..51e54ab8 100644
--- a/spec/if/compiler/builtin-choose-expr.yml
+++ b/spec/if/compiler/builtin-choose-expr.yml
@@ -2,9 +2,9 @@ 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-name: __builtin_choose_expr
interface-type: macro
links:
- role: interface-placement
uid: domain
+name: __builtin_choose_expr
type: interface
diff --git a/spec/if/compiler/builtin-expect.yml b/spec/if/compiler/builtin-expect.yml
index 79991476..7cc46924 100644
--- a/spec/if/compiler/builtin-expect.yml
+++ b/spec/if/compiler/builtin-expect.yml
@@ -2,9 +2,9 @@ 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-name: __builtin_expect
interface-type: function
links:
- role: interface-placement
uid: domain
+name: __builtin_expect
type: interface
diff --git a/spec/if/compiler/builtin-return-address.yml b/spec/if/compiler/builtin-return-address.yml
index 292c8067..901a80c8 100644
--- a/spec/if/compiler/builtin-return-address.yml
+++ b/spec/if/compiler/builtin-return-address.yml
@@ -2,9 +2,9 @@ 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-name: __builtin_return_address
interface-type: function
links:
- role: interface-placement
uid: domain
+name: __builtin_return_address
type: interface
diff --git a/spec/if/compiler/builtin-types-compatible-p.yml b/spec/if/compiler/builtin-types-compatible-p.yml
index 20ca005f..adc7f26b 100644
--- a/spec/if/compiler/builtin-types-compatible-p.yml
+++ b/spec/if/compiler/builtin-types-compatible-p.yml
@@ -2,9 +2,9 @@ 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-name: __builtin_types_compatible_p
interface-type: macro
links:
- role: interface-placement
uid: domain
+name: __builtin_types_compatible_p
type: interface
diff --git a/spec/if/compiler/builtin-unreachable.yml b/spec/if/compiler/builtin-unreachable.yml
index 88baa8db..16c7678e 100644
--- a/spec/if/compiler/builtin-unreachable.yml
+++ b/spec/if/compiler/builtin-unreachable.yml
@@ -2,9 +2,9 @@ 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-name: __builtin_unreachable
interface-type: function
links:
- role: interface-placement
uid: domain
+name: __builtin_unreachable
type: interface
diff --git a/spec/if/compiler/cplusplus.yml b/spec/if/compiler/cplusplus.yml
index 94ac8c70..2f9b4ccf 100644
--- a/spec/if/compiler/cplusplus.yml
+++ b/spec/if/compiler/cplusplus.yml
@@ -2,9 +2,9 @@ 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-name: __cplusplus
interface-type: define
links:
- role: interface-placement
uid: domain
+name: __cplusplus
type: interface
diff --git a/spec/if/compiler/domain.yml b/spec/if/compiler/domain.yml
index af97bbd5..ec7a6e9f 100644
--- a/spec/if/compiler/domain.yml
+++ b/spec/if/compiler/domain.yml
@@ -1,8 +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: compiler
enabled-by: true
-interface-domain: compiler
interface-type: container
links: []
type: interface
diff --git a/spec/if/compiler/gnuc.yml b/spec/if/compiler/gnuc.yml
index fe2b72a1..a197bddb 100644
--- a/spec/if/compiler/gnuc.yml
+++ b/spec/if/compiler/gnuc.yml
@@ -2,9 +2,9 @@ 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-name: __GNUC__
interface-type: define
links:
- role: interface-placement
uid: domain
+name: __GNUC__
type: interface
diff --git a/spec/if/compiler/stdc-version.yml b/spec/if/compiler/stdc-version.yml
index 0438ac24..5e3491de 100644
--- a/spec/if/compiler/stdc-version.yml
+++ b/spec/if/compiler/stdc-version.yml
@@ -2,9 +2,9 @@ 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-name: __STDC_VERSION__
interface-type: define
links:
- role: interface-placement
uid: domain
+name: __STDC_VERSION__
type: interface
diff --git a/spec/if/compiler/typeof.yml b/spec/if/compiler/typeof.yml
index 46f37bec..54155d4f 100644
--- a/spec/if/compiler/typeof.yml
+++ b/spec/if/compiler/typeof.yml
@@ -2,9 +2,9 @@ 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-name: __typeof__
interface-type: macro
links:
- role: interface-placement
uid: domain
+name: __typeof__
type: interface
diff --git a/spec/if/compiler/user-label-prefix.yml b/spec/if/compiler/user-label-prefix.yml
index 6070fcbb..40d394cf 100644
--- a/spec/if/compiler/user-label-prefix.yml
+++ b/spec/if/compiler/user-label-prefix.yml
@@ -2,9 +2,9 @@ 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-name: __USER_LABEL_PREFIX__
interface-type: define
links:
- role: interface-placement
uid: domain
+name: __USER_LABEL_PREFIX__
type: interface
diff --git a/spec/if/impl/assert-unreachable.yml b/spec/if/impl/assert-unreachable.yml
index 0319544b..01dce6d9 100644
--- a/spec/if/impl/assert-unreachable.yml
+++ b/spec/if/impl/assert-unreachable.yml
@@ -1,26 +1,26 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Asserts that this program point is unreachable.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Asserts that this program point is unreachable.
-interface-definition:
+definition:
default: |
do { } while ( 0 )
variants:
- definition: |
_Assert( 0 )
enabled-by:
- - defined(${/if/build-options/debug:/interface-name})
-interface-description: null
-interface-name: _Assert_Unreachable
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+ - defined(${/if/build-options/debug:/name})
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: /if/rtems/basedefs/header
+name: _Assert_Unreachable
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/impl/dequalify-types-not-compatible.yml b/spec/if/impl/dequalify-types-not-compatible.yml
index 7be3ae49..136e1b3a 100644
--- a/spec/if/impl/dequalify-types-not-compatible.yml
+++ b/spec/if/impl/dequalify-types-not-compatible.yml
@@ -1,13 +1,11 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ A not implemented function to trigger compile time errors with an error
+ message.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2014 Paval Pisa
-enabled-by:
- not: ASM
-interface-brief: |
- A not implemented function to trigger compile time errors with an error
- message.
-interface-definition:
+definition:
default:
params: []
return: void *
@@ -17,16 +15,18 @@ interface-definition:
return: __attribute__((__error__("RTEMS_DEQUALIFY() types differ not only by
volatile and const"))) void *
enabled-by:
- - defined(${/if/compiler/gnuc:/interface-name})
-interface-description: null
-interface-name: RTEMS_DEQUALIFY_types_not_compatible
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+ - defined(${/if/compiler/gnuc:/name})
+description: null
+enabled-by:
+ not: ASM
interface-type: function
links:
- role: interface-placement
uid: /if/rtems/basedefs/header
+name: RTEMS_DEQUALIFY_types_not_compatible
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/impl/isr/header.yml b/spec/if/impl/isr/header.yml
index d292fc66..d3c749df 100644
--- a/spec/if/impl/isr/header.yml
+++ b/spec/if/impl/isr/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: implementation
enabled-by: true
-interface-domain: implementation
-interface-path: rtems/score/isr.h
-interface-prefix: cpukit/include
interface-type: header-file
links: []
+path: rtems/score/isr.h
+prefix: cpukit/include
type: interface
diff --git a/spec/if/impl/isr/stack-size.yml b/spec/if/impl/isr/stack-size.yml
index e53b5d75..4e23e5ba 100644
--- a/spec/if/impl/isr/stack-size.yml
+++ b/spec/if/impl/isr/stack-size.yml
@@ -2,9 +2,9 @@ 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-name: _ISR_Stack_size
interface-type: variable
links:
- role: interface-placement
uid: header
+name: _ISR_Stack_size
type: interface
diff --git a/spec/if/impl/memory/header.yml b/spec/if/impl/memory/header.yml
index 0a348859..a84a546c 100644
--- a/spec/if/impl/memory/header.yml
+++ b/spec/if/impl/memory/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: implementation
enabled-by: true
-interface-domain: implementation
-interface-path: rtems/score/memory.h
-interface-prefix: cpukit/include
interface-type: header-file
links: []
+path: rtems/score/memory.h
+prefix: cpukit/include
type: interface
diff --git a/spec/if/impl/memory/zero-before-use.yml b/spec/if/impl/memory/zero-before-use.yml
index 700d92ef..c342322b 100644
--- a/spec/if/impl/memory/zero-before-use.yml
+++ b/spec/if/impl/memory/zero-before-use.yml
@@ -2,9 +2,9 @@ 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-name: _Memory_Zero_before_use
interface-type: variable
links:
- role: interface-placement
uid: header
+name: _Memory_Zero_before_use
type: interface
diff --git a/spec/if/impl/mpci/configuration.yml b/spec/if/impl/mpci/configuration.yml
index a14a72c5..fd5cda91 100644
--- a/spec/if/impl/mpci/configuration.yml
+++ b/spec/if/impl/mpci/configuration.yml
@@ -2,9 +2,9 @@ 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-name: _MPCI_Configuration
interface-type: variable
links:
- role: interface-placement
uid: header
+name: _MPCI_Configuration
type: interface
diff --git a/spec/if/impl/mpci/header.yml b/spec/if/impl/mpci/header.yml
index 23ae40d4..c96fec45 100644
--- a/spec/if/impl/mpci/header.yml
+++ b/spec/if/impl/mpci/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: implementation
enabled-by: true
-interface-domain: implementation
-interface-path: rtems/score/mpci.h
-interface-prefix: cpukit/include
interface-type: header-file
links: []
+path: rtems/score/mpci.h
+prefix: cpukit/include
type: interface
diff --git a/spec/if/impl/object/header.yml b/spec/if/impl/object/header.yml
index e064886e..7ca6f731 100644
--- a/spec/if/impl/object/header.yml
+++ b/spec/if/impl/object/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: implementation
enabled-by: true
-interface-domain: implementation
-interface-path: rtems/score/object.h
-interface-prefix: cpukit/include
interface-type: header-file
links: []
+path: rtems/score/object.h
+prefix: cpukit/include
type: interface
diff --git a/spec/if/impl/object/is-unlimited.yml b/spec/if/impl/object/is-unlimited.yml
index d6afae26..a3c99b07 100644
--- a/spec/if/impl/object/is-unlimited.yml
+++ b/spec/if/impl/object/is-unlimited.yml
@@ -2,9 +2,9 @@ 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-name: _Objects_Is_unlimited
interface-type: macro
links:
- role: interface-placement
uid: header
+name: _Objects_Is_unlimited
type: interface
diff --git a/spec/if/impl/object/maximum-per-allocation.yml b/spec/if/impl/object/maximum-per-allocation.yml
index 18615045..0ecb3e64 100644
--- a/spec/if/impl/object/maximum-per-allocation.yml
+++ b/spec/if/impl/object/maximum-per-allocation.yml
@@ -2,9 +2,9 @@ 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-name: _Objects_Maximum_per_allocation
interface-type: macro
links:
- role: interface-placement
uid: header
+name: _Objects_Maximum_per_allocation
type: interface
diff --git a/spec/if/impl/object/unlimited-objects.yml b/spec/if/impl/object/unlimited-objects.yml
index c5c63300..7ef5f4f9 100644
--- a/spec/if/impl/object/unlimited-objects.yml
+++ b/spec/if/impl/object/unlimited-objects.yml
@@ -2,9 +2,9 @@ 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-name: OBJECTS_UNLIMITED_OBJECTS
interface-type: define
links:
- role: interface-placement
uid: header
+name: OBJECTS_UNLIMITED_OBJECTS
type: interface
diff --git a/spec/if/impl/smp/header.yml b/spec/if/impl/smp/header.yml
index bc4f6e9a..738565eb 100644
--- a/spec/if/impl/smp/header.yml
+++ b/spec/if/impl/smp/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: implementation
enabled-by: true
-interface-domain: implementation
-interface-path: rtems/score/smp.h
-interface-prefix: cpukit/include
interface-type: header-file
links: []
+path: rtems/score/smp.h
+prefix: cpukit/include
type: interface
diff --git a/spec/if/impl/smp/processor-configured-maximum.yml b/spec/if/impl/smp/processor-configured-maximum.yml
index 19f05d72..8381e6e3 100644
--- a/spec/if/impl/smp/processor-configured-maximum.yml
+++ b/spec/if/impl/smp/processor-configured-maximum.yml
@@ -2,9 +2,9 @@ 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-name: _SMP_Processor_configured_maximum
interface-type: variable
links:
- role: interface-placement
uid: header
+name: _SMP_Processor_configured_maximum
type: interface
diff --git a/spec/if/impl/stack/allocator-allocate-type.yml b/spec/if/impl/stack/allocator-allocate-type.yml
index f66afb88..c6703ff1 100644
--- a/spec/if/impl/stack/allocator-allocate-type.yml
+++ b/spec/if/impl/stack/allocator-allocate-type.yml
@@ -2,9 +2,9 @@ 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-name: Stack_Allocator_allocate
interface-type: typedef
links:
- role: interface-placement
uid: header
+name: Stack_Allocator_allocate
type: interface
diff --git a/spec/if/impl/stack/allocator-allocate.yml b/spec/if/impl/stack/allocator-allocate.yml
index 8e9a4f0a..931551e3 100644
--- a/spec/if/impl/stack/allocator-allocate.yml
+++ b/spec/if/impl/stack/allocator-allocate.yml
@@ -2,9 +2,9 @@ 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-name: _Stack_Allocator_allocate
interface-type: variable
links:
- role: interface-placement
uid: header
+name: _Stack_Allocator_allocate
type: interface
diff --git a/spec/if/impl/stack/allocator-avoids-workspace.yml b/spec/if/impl/stack/allocator-avoids-workspace.yml
index 0d15ae92..c19be850 100644
--- a/spec/if/impl/stack/allocator-avoids-workspace.yml
+++ b/spec/if/impl/stack/allocator-avoids-workspace.yml
@@ -2,9 +2,9 @@ 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-name: _Stack_Allocator_avoids_workspace
interface-type: variable
links:
- role: interface-placement
uid: header
+name: _Stack_Allocator_avoids_workspace
type: interface
diff --git a/spec/if/impl/stack/allocator-free-type.yml b/spec/if/impl/stack/allocator-free-type.yml
index 82929857..ff6e7077 100644
--- a/spec/if/impl/stack/allocator-free-type.yml
+++ b/spec/if/impl/stack/allocator-free-type.yml
@@ -2,9 +2,9 @@ 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-name: Stack_Allocator_free
interface-type: typedef
links:
- role: interface-placement
uid: header
+name: Stack_Allocator_free
type: interface
diff --git a/spec/if/impl/stack/allocator-free.yml b/spec/if/impl/stack/allocator-free.yml
index 74cf4314..80240ad0 100644
--- a/spec/if/impl/stack/allocator-free.yml
+++ b/spec/if/impl/stack/allocator-free.yml
@@ -2,9 +2,9 @@ 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-name: _Stack_Allocator_free
interface-type: variable
links:
- role: interface-placement
uid: header
+name: _Stack_Allocator_free
type: interface
diff --git a/spec/if/impl/stack/allocator-initialize-type.yml b/spec/if/impl/stack/allocator-initialize-type.yml
index c35aec9e..b0b05b15 100644
--- a/spec/if/impl/stack/allocator-initialize-type.yml
+++ b/spec/if/impl/stack/allocator-initialize-type.yml
@@ -2,9 +2,9 @@ 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-name: Stack_Allocator_initialize
interface-type: typedef
links:
- role: interface-placement
uid: header
+name: Stack_Allocator_initialize
type: interface
diff --git a/spec/if/impl/stack/allocator-initialize.yml b/spec/if/impl/stack/allocator-initialize.yml
index 99d6b329..19717dbc 100644
--- a/spec/if/impl/stack/allocator-initialize.yml
+++ b/spec/if/impl/stack/allocator-initialize.yml
@@ -2,9 +2,9 @@ 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-name: _Stack_Allocator_initialize
interface-type: variable
links:
- role: interface-placement
uid: header
+name: _Stack_Allocator_initialize
type: interface
diff --git a/spec/if/impl/stack/header.yml b/spec/if/impl/stack/header.yml
index 92e3c1ec..77de362a 100644
--- a/spec/if/impl/stack/header.yml
+++ b/spec/if/impl/stack/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: implementation
enabled-by: true
-interface-domain: implementation
-interface-path: rtems/score/stack.h
-interface-prefix: cpukit/include
interface-type: header-file
links: []
+path: rtems/score/stack.h
+prefix: cpukit/include
type: interface
diff --git a/spec/if/impl/thread/header.yml b/spec/if/impl/thread/header.yml
index a5173259..2e94df49 100644
--- a/spec/if/impl/thread/header.yml
+++ b/spec/if/impl/thread/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: implementation
enabled-by: true
-interface-domain: implementation
-interface-path: rtems/score/threadidledata.h
-interface-prefix: cpukit/include
interface-type: header-file
links: []
+path: rtems/score/threadidledata.h
+prefix: cpukit/include
type: interface
diff --git a/spec/if/impl/thread/idle-body.yml b/spec/if/impl/thread/idle-body.yml
index bad99dd6..c486f468 100644
--- a/spec/if/impl/thread/idle-body.yml
+++ b/spec/if/impl/thread/idle-body.yml
@@ -2,9 +2,9 @@ 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-name: _Thread_Idle_body
interface-type: variable
links:
- role: interface-placement
uid: header
+name: _Thread_Idle_body
type: interface
diff --git a/spec/if/impl/thread/idle-stack-size.yml b/spec/if/impl/thread/idle-stack-size.yml
index 091fa617..54606173 100644
--- a/spec/if/impl/thread/idle-stack-size.yml
+++ b/spec/if/impl/thread/idle-stack-size.yml
@@ -2,9 +2,9 @@ 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-name: _Thread_Idle_stack_size
interface-type: variable
links:
- role: interface-placement
uid: header
+name: _Thread_Idle_stack_size
type: interface
diff --git a/spec/if/impl/userext/header.yml b/spec/if/impl/userext/header.yml
index b8d0d42f..39c8c3bd 100644
--- a/spec/if/impl/userext/header.yml
+++ b/spec/if/impl/userext/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: implementation
enabled-by: true
-interface-domain: implementation
-interface-path: rtems/score/userextdata.h
-interface-prefix: cpukit/include
interface-type: header-file
links: []
+path: rtems/score/userextdata.h
+prefix: cpukit/include
type: interface
diff --git a/spec/if/impl/userext/initial-count.yml b/spec/if/impl/userext/initial-count.yml
index 2f45993f..33eceb8d 100644
--- a/spec/if/impl/userext/initial-count.yml
+++ b/spec/if/impl/userext/initial-count.yml
@@ -2,9 +2,9 @@ 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-name: _User_extensions_Initial_count
interface-type: variable
links:
- role: interface-placement
uid: header
+name: _User_extensions_Initial_count
type: interface
diff --git a/spec/if/impl/userext/initial-extensions.yml b/spec/if/impl/userext/initial-extensions.yml
index 3119175d..3faa0cb2 100644
--- a/spec/if/impl/userext/initial-extensions.yml
+++ b/spec/if/impl/userext/initial-extensions.yml
@@ -2,9 +2,9 @@ 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-name: _User_extensions_Initial_extensions
interface-type: variable
links:
- role: interface-placement
uid: header
+name: _User_extensions_Initial_extensions
type: interface
diff --git a/spec/if/impl/watchdog/header.yml b/spec/if/impl/watchdog/header.yml
index 3fb783f2..fc20cc9c 100644
--- a/spec/if/impl/watchdog/header.yml
+++ b/spec/if/impl/watchdog/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: implementation
enabled-by: true
-interface-domain: implementation
-interface-path: rtems/score/watchdogticks.h
-interface-prefix: cpukit/include
interface-type: header-file
links: []
+path: rtems/score/watchdogticks.h
+prefix: cpukit/include
type: interface
diff --git a/spec/if/impl/watchdog/microseconds-per-tick.yml b/spec/if/impl/watchdog/microseconds-per-tick.yml
index 217082e3..0536243a 100644
--- a/spec/if/impl/watchdog/microseconds-per-tick.yml
+++ b/spec/if/impl/watchdog/microseconds-per-tick.yml
@@ -2,9 +2,9 @@ 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-name: _Watchdog_Microseconds_per_tick
interface-type: variable
links:
- role: interface-placement
uid: header
+name: _Watchdog_Microseconds_per_tick
type: interface
diff --git a/spec/if/impl/watchdog/nanoseconds-per-tick.yml b/spec/if/impl/watchdog/nanoseconds-per-tick.yml
index d8624514..bb0c1a09 100644
--- a/spec/if/impl/watchdog/nanoseconds-per-tick.yml
+++ b/spec/if/impl/watchdog/nanoseconds-per-tick.yml
@@ -2,9 +2,9 @@ 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-name: _Watchdog_Nanoseconds_per_tick
interface-type: variable
links:
- role: interface-placement
uid: header
+name: _Watchdog_Nanoseconds_per_tick
type: interface
diff --git a/spec/if/impl/watchdog/ticks-per-timeslice.yml b/spec/if/impl/watchdog/ticks-per-timeslice.yml
index 4661e2c8..c5c0db07 100644
--- a/spec/if/impl/watchdog/ticks-per-timeslice.yml
+++ b/spec/if/impl/watchdog/ticks-per-timeslice.yml
@@ -2,9 +2,9 @@ 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-name: _Watchdog_Ticks_per_timeslice
interface-type: variable
links:
- role: interface-placement
uid: header
+name: _Watchdog_Ticks_per_timeslice
type: interface
diff --git a/spec/if/impl/wkspace/header.yml b/spec/if/impl/wkspace/header.yml
index d0d0ab26..86ede892 100644
--- a/spec/if/impl/wkspace/header.yml
+++ b/spec/if/impl/wkspace/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: implementation
enabled-by: true
-interface-domain: implementation
-interface-path: rtems/score/wkspacedata.h
-interface-prefix: cpukit/include
interface-type: header-file
links: []
+path: rtems/score/wkspacedata.h
+prefix: cpukit/include
type: interface
diff --git a/spec/if/impl/wkspace/is-unified.yml b/spec/if/impl/wkspace/is-unified.yml
index 59acd4bc..8dff1722 100644
--- a/spec/if/impl/wkspace/is-unified.yml
+++ b/spec/if/impl/wkspace/is-unified.yml
@@ -2,9 +2,9 @@ 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-name: _Workspace_Is_unified
interface-type: variable
links:
- role: interface-placement
uid: header
+name: _Workspace_Is_unified
type: interface
diff --git a/spec/if/impl/wkspace/size.yml b/spec/if/impl/wkspace/size.yml
index f817280c..bd528cab 100644
--- a/spec/if/impl/wkspace/size.yml
+++ b/spec/if/impl/wkspace/size.yml
@@ -2,9 +2,9 @@ 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-name: _Workspace_Size
interface-type: variable
links:
- role: interface-placement
uid: header
+name: _Workspace_Size
type: interface
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
diff --git a/spec/if/use/asm.yml b/spec/if/use/asm.yml
index 71901106..82a6d37c 100644
--- a/spec/if/use/asm.yml
+++ b/spec/if/use/asm.yml
@@ -2,9 +2,9 @@ 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-name: ASM
interface-type: define
links:
- role: interface-placement
uid: domain
+name: ASM
type: interface
diff --git a/spec/if/use/domain.yml b/spec/if/use/domain.yml
index 370a8390..2ac89c2e 100644
--- a/spec/if/use/domain.yml
+++ b/spec/if/use/domain.yml
@@ -1,8 +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: use
enabled-by: true
-interface-domain: use
interface-type: container
links: []
type: interface
diff --git a/spec/if/use/false.yml b/spec/if/use/false.yml
index bd90542b..534620e8 100644
--- a/spec/if/use/false.yml
+++ b/spec/if/use/false.yml
@@ -2,9 +2,9 @@ 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-name: 'FALSE'
interface-type: define
links:
- role: interface-placement
uid: domain
+name: 'FALSE'
type: interface
diff --git a/spec/if/use/true.yml b/spec/if/use/true.yml
index a4de4669..de99a5a0 100644
--- a/spec/if/use/true.yml
+++ b/spec/if/use/true.yml
@@ -2,9 +2,9 @@ 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-name: 'TRUE'
interface-type: define
links:
- role: interface-placement
uid: domain
+name: 'TRUE'
type: interface