diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-05-14 08:29:58 +0200 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-05-28 10:38:23 +0200 |
| commit | cae542a3541dc5e34d4cf36bc37967e09d0661e2 (patch) | |
| tree | 3a26a37619a4248460e80e0bbaa7e7d90eb05440 /spec/if/rtems | |
| parent | f9cff66d1c1fe69e0814602403279cdf001d36cb (diff) | |
spec: Add more interface specification items
Diffstat (limited to 'spec/if/rtems')
133 files changed, 1978 insertions, 8 deletions
diff --git a/spec/if/rtems/basedefs/alias.yml b/spec/if/rtems/basedefs/alias.yml index 71b5e695..a87353bf 100644 --- a/spec/if/rtems/basedefs/alias.yml +++ b/spec/if/rtems/basedefs/alias.yml @@ -13,6 +13,7 @@ interface-definition: - defined(${/if/compiler/gnuc:/interface-name}) interface-description: null interface-name: RTEMS_ALIAS +interface-notes: null interface-params: - description: | is the target function name. diff --git a/spec/if/rtems/basedefs/aligned.yml b/spec/if/rtems/basedefs/aligned.yml index f9f91da8..17402774 100644 --- a/spec/if/rtems/basedefs/aligned.yml +++ b/spec/if/rtems/basedefs/aligned.yml @@ -14,6 +14,7 @@ interface-definition: - 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. diff --git a/spec/if/rtems/basedefs/alloc-align.yml b/spec/if/rtems/basedefs/alloc-align.yml index 7f88b298..b08bd791 100644 --- a/spec/if/rtems/basedefs/alloc-align.yml +++ b/spec/if/rtems/basedefs/alloc-align.yml @@ -14,6 +14,7 @@ interface-definition: - 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). diff --git a/spec/if/rtems/basedefs/alloc-size-2.yml b/spec/if/rtems/basedefs/alloc-size-2.yml index 83355529..e9b8bb62 100644 --- a/spec/if/rtems/basedefs/alloc-size-2.yml +++ b/spec/if/rtems/basedefs/alloc-size-2.yml @@ -14,6 +14,7 @@ interface-definition: - defined(${/if/compiler/gnuc:/interface-name}) interface-description: null interface-name: RTEMS_ALLOC_SIZE_2 +interface-notes: null interface-params: - description: | is the allocation item count parameter index (starting with one). diff --git a/spec/if/rtems/basedefs/alloc-size.yml b/spec/if/rtems/basedefs/alloc-size.yml index a8eb1075..68b3729f 100644 --- a/spec/if/rtems/basedefs/alloc-size.yml +++ b/spec/if/rtems/basedefs/alloc-size.yml @@ -14,6 +14,7 @@ interface-definition: - 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). diff --git a/spec/if/rtems/basedefs/array-size.yml b/spec/if/rtems/basedefs/array-size.yml index 0d061eb7..a8de4678 100644 --- a/spec/if/rtems/basedefs/array-size.yml +++ b/spec/if/rtems/basedefs/array-size.yml @@ -10,6 +10,7 @@ interface-definition: variants: [] interface-description: null interface-name: RTEMS_ARRAY_SIZE +interface-notes: null interface-params: - description: | is the name of the array. diff --git a/spec/if/rtems/basedefs/compiler-deprecated-attribute.yml b/spec/if/rtems/basedefs/compiler-deprecated-attribute.yml index fbfbab58..34b7f616 100644 --- a/spec/if/rtems/basedefs/compiler-deprecated-attribute.yml +++ b/spec/if/rtems/basedefs/compiler-deprecated-attribute.yml @@ -10,6 +10,7 @@ interface-definition: variants: [] interface-description: null interface-name: RTEMS_COMPILER_DEPRECATED_ATTRIBUTE +interface-notes: null interface-type: define links: - role: interface-placement diff --git a/spec/if/rtems/basedefs/compiler-memory-barrier.yml b/spec/if/rtems/basedefs/compiler-memory-barrier.yml index 823df984..36ad47bd 100644 --- a/spec/if/rtems/basedefs/compiler-memory-barrier.yml +++ b/spec/if/rtems/basedefs/compiler-memory-barrier.yml @@ -14,6 +14,7 @@ interface-definition: - defined(${/if/compiler/gnuc:/interface-name}) interface-description: null interface-name: RTEMS_COMPILER_MEMORY_BARRIER +interface-notes: null interface-params: [] interface-return: return: null diff --git a/spec/if/rtems/basedefs/compiler-no-return-attribute.yml b/spec/if/rtems/basedefs/compiler-no-return-attribute.yml index 36dece0a..c5bd8c83 100644 --- a/spec/if/rtems/basedefs/compiler-no-return-attribute.yml +++ b/spec/if/rtems/basedefs/compiler-no-return-attribute.yml @@ -10,6 +10,7 @@ interface-definition: variants: [] interface-description: null interface-name: RTEMS_COMPILER_NO_RETURN_ATTRIBUTE +interface-notes: null interface-type: define links: - role: interface-placement diff --git a/spec/if/rtems/basedefs/compiler-packed-attribute.yml b/spec/if/rtems/basedefs/compiler-packed-attribute.yml index a666ea86..d056d3d7 100644 --- a/spec/if/rtems/basedefs/compiler-packed-attribute.yml +++ b/spec/if/rtems/basedefs/compiler-packed-attribute.yml @@ -10,6 +10,7 @@ interface-definition: variants: [] interface-description: null interface-name: RTEMS_COMPILER_PACKED_ATTRIBUTE +interface-notes: null interface-type: define links: - role: interface-placement diff --git a/spec/if/rtems/basedefs/compiler-pure-attribute.yml b/spec/if/rtems/basedefs/compiler-pure-attribute.yml index bf843987..24178690 100644 --- a/spec/if/rtems/basedefs/compiler-pure-attribute.yml +++ b/spec/if/rtems/basedefs/compiler-pure-attribute.yml @@ -10,6 +10,7 @@ interface-definition: variants: [] interface-description: null interface-name: RTEMS_COMPILER_PURE_ATTRIBUTE +interface-notes: null interface-type: define links: - role: interface-placement diff --git a/spec/if/rtems/basedefs/compiler-used-attribute.yml b/spec/if/rtems/basedefs/compiler-used-attribute.yml index c12480ac..ec695e16 100644 --- a/spec/if/rtems/basedefs/compiler-used-attribute.yml +++ b/spec/if/rtems/basedefs/compiler-used-attribute.yml @@ -10,6 +10,7 @@ interface-definition: variants: [] interface-description: null interface-name: RTEMS_COMPILER_USED_ATTRIBUTE +interface-notes: null interface-type: define links: - role: interface-placement diff --git a/spec/if/rtems/basedefs/concat.yml b/spec/if/rtems/basedefs/concat.yml index 153bc682..5e73ceba 100644 --- a/spec/if/rtems/basedefs/concat.yml +++ b/spec/if/rtems/basedefs/concat.yml @@ -9,6 +9,7 @@ interface-definition: variants: [] interface-description: null interface-name: RTEMS_CONCAT +interface-notes: null interface-params: - description: | is the left hand side token of the concatenation. diff --git a/spec/if/rtems/basedefs/const.yml b/spec/if/rtems/basedefs/const.yml index 4de8c525..60378f74 100644 --- a/spec/if/rtems/basedefs/const.yml +++ b/spec/if/rtems/basedefs/const.yml @@ -15,6 +15,7 @@ interface-definition: - defined(${/if/compiler/gnuc:/interface-name}) interface-description: null interface-name: RTEMS_CONST +interface-notes: null interface-type: define links: - role: interface-placement diff --git a/spec/if/rtems/basedefs/container-of.yml b/spec/if/rtems/basedefs/container-of.yml index e7e7f136..7073634e 100644 --- a/spec/if/rtems/basedefs/container-of.yml +++ b/spec/if/rtems/basedefs/container-of.yml @@ -10,6 +10,7 @@ interface-definition: variants: [] interface-description: null interface-name: RTEMS_CONTAINER_OF +interface-notes: null interface-params: - description: | is the pointer to a member of the container. diff --git a/spec/if/rtems/basedefs/declare-global-symbol.yml b/spec/if/rtems/basedefs/declare-global-symbol.yml index 5036a305..d168393c 100644 --- a/spec/if/rtems/basedefs/declare-global-symbol.yml +++ b/spec/if/rtems/basedefs/declare-global-symbol.yml @@ -11,6 +11,7 @@ interface-definition: interface-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. diff --git a/spec/if/rtems/basedefs/deconst.yml b/spec/if/rtems/basedefs/deconst.yml index bc983583..92295f99 100644 --- a/spec/if/rtems/basedefs/deconst.yml +++ b/spec/if/rtems/basedefs/deconst.yml @@ -11,6 +11,7 @@ interface-definition: variants: [] interface-description: null interface-name: RTEMS_DECONST +interface-notes: null interface-params: - description: | is the target type of the cast. diff --git a/spec/if/rtems/basedefs/define-global-symbol.yml b/spec/if/rtems/basedefs/define-global-symbol.yml index 357439dc..157542d6 100644 --- a/spec/if/rtems/basedefs/define-global-symbol.yml +++ b/spec/if/rtems/basedefs/define-global-symbol.yml @@ -18,6 +18,7 @@ interface-definition: interface-description: | This macro shall be placed at file scope. interface-name: RTEMS_DEFINE_GLOBAL_SYMBOL +interface-notes: null interface-params: - description: | is the user defined name of the symbol. The name shall be a valid diff --git a/spec/if/rtems/basedefs/deprecated.yml b/spec/if/rtems/basedefs/deprecated.yml index d9f207f4..6b86ab43 100644 --- a/spec/if/rtems/basedefs/deprecated.yml +++ b/spec/if/rtems/basedefs/deprecated.yml @@ -14,6 +14,7 @@ interface-definition: - defined(${/if/compiler/gnuc:/interface-name}) interface-description: null interface-name: RTEMS_DEPRECATED +interface-notes: null interface-type: define links: - role: interface-placement diff --git a/spec/if/rtems/basedefs/dequalify-depthx.yml b/spec/if/rtems/basedefs/dequalify-depthx.yml index 8afbaf4b..43722948 100644 --- a/spec/if/rtems/basedefs/dequalify-depthx.yml +++ b/spec/if/rtems/basedefs/dequalify-depthx.yml @@ -24,6 +24,7 @@ interface-definition: - defined(${/if/compiler/gnuc:/interface-name}) interface-description: null interface-name: RTEMS_DEQUALIFY_DEPTHX +interface-notes: null interface-params: - description: | is the pointer indirection level expressed in *. diff --git a/spec/if/rtems/basedefs/dequalify.yml b/spec/if/rtems/basedefs/dequalify.yml index 0042a53d..b22fe060 100644 --- a/spec/if/rtems/basedefs/dequalify.yml +++ b/spec/if/rtems/basedefs/dequalify.yml @@ -11,6 +11,7 @@ interface-definition: variants: [] interface-description: null interface-name: RTEMS_DEQUALIFY +interface-notes: null interface-params: - description: | is the target type of the cast. diff --git a/spec/if/rtems/basedefs/devolatile.yml b/spec/if/rtems/basedefs/devolatile.yml index bd240f4d..100ea495 100644 --- a/spec/if/rtems/basedefs/devolatile.yml +++ b/spec/if/rtems/basedefs/devolatile.yml @@ -11,6 +11,7 @@ interface-definition: variants: [] interface-description: null interface-name: RTEMS_DEVOLATILE +interface-notes: null interface-params: - description: | is the target type of the cast. diff --git a/spec/if/rtems/basedefs/expand.yml b/spec/if/rtems/basedefs/expand.yml index c6bf2697..5423d2c1 100644 --- a/spec/if/rtems/basedefs/expand.yml +++ b/spec/if/rtems/basedefs/expand.yml @@ -9,6 +9,7 @@ interface-definition: variants: [] interface-description: null interface-name: RTEMS_EXPAND +interface-notes: null interface-params: - description: | is the token to expand. diff --git a/spec/if/rtems/basedefs/false.yml b/spec/if/rtems/basedefs/false.yml index b0fb90e0..ae2eb012 100644 --- a/spec/if/rtems/basedefs/false.yml +++ b/spec/if/rtems/basedefs/false.yml @@ -2,13 +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: - - not: "FALSE" +- not: 'FALSE' interface-brief: If FALSE is undefined, then FALSE is defined to 0. -interface-description: null -interface-name: "FALSE" interface-definition: - default: "0" + default: '0' variants: [] +interface-description: null +interface-name: 'FALSE' +interface-notes: null interface-type: define links: - role: interface-placement diff --git a/spec/if/rtems/basedefs/have-member-same-type.yml b/spec/if/rtems/basedefs/have-member-same-type.yml index 516ab639..50c0dbf5 100644 --- a/spec/if/rtems/basedefs/have-member-same-type.yml +++ b/spec/if/rtems/basedefs/have-member-same-type.yml @@ -18,6 +18,7 @@ interface-definition: - defined(${/if/compiler/gnuc:/interface-name}) interface-description: null interface-name: RTEMS_HAVE_MEMBER_SAME_TYPE +interface-notes: null interface-params: - description: | is the left hand side type. diff --git a/spec/if/rtems/basedefs/inline-routine.yml b/spec/if/rtems/basedefs/inline-routine.yml index bd8555a9..a041fe20 100644 --- a/spec/if/rtems/basedefs/inline-routine.yml +++ b/spec/if/rtems/basedefs/inline-routine.yml @@ -13,6 +13,7 @@ interface-definition: - defined(${/if/compiler/gnuc:/interface-name}) interface-description: null interface-name: RTEMS_INLINE_ROUTINE +interface-notes: null interface-type: define links: - role: interface-placement diff --git a/spec/if/rtems/basedefs/malloclike.yml b/spec/if/rtems/basedefs/malloclike.yml index 221ec5f1..9a27edce 100644 --- a/spec/if/rtems/basedefs/malloclike.yml +++ b/spec/if/rtems/basedefs/malloclike.yml @@ -14,6 +14,7 @@ interface-definition: - defined(${/if/compiler/gnuc:/interface-name}) interface-description: null interface-name: RTEMS_MALLOCLIKE +interface-notes: null interface-type: define links: - role: interface-placement diff --git a/spec/if/rtems/basedefs/no-inline.yml b/spec/if/rtems/basedefs/no-inline.yml index 4b6b85f2..72146d5f 100644 --- a/spec/if/rtems/basedefs/no-inline.yml +++ b/spec/if/rtems/basedefs/no-inline.yml @@ -13,6 +13,7 @@ interface-definition: - defined(${/if/compiler/gnuc:/interface-name}) interface-description: null interface-name: RTEMS_NO_INLINE +interface-notes: null interface-type: define links: - role: interface-placement diff --git a/spec/if/rtems/basedefs/no-return.yml b/spec/if/rtems/basedefs/no-return.yml index 408c86a2..943a2587 100644 --- a/spec/if/rtems/basedefs/no-return.yml +++ b/spec/if/rtems/basedefs/no-return.yml @@ -14,6 +14,7 @@ interface-definition: - defined(${/if/compiler/gnuc:/interface-name}) interface-description: null interface-name: RTEMS_NO_RETURN +interface-notes: null interface-type: define links: - role: interface-placement diff --git a/spec/if/rtems/basedefs/obfuscate-variable.yml b/spec/if/rtems/basedefs/obfuscate-variable.yml index 10e117aa..290a4060 100644 --- a/spec/if/rtems/basedefs/obfuscate-variable.yml +++ b/spec/if/rtems/basedefs/obfuscate-variable.yml @@ -16,6 +16,7 @@ interface-definition: interface-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. diff --git a/spec/if/rtems/basedefs/packed.yml b/spec/if/rtems/basedefs/packed.yml index 131b248d..9dde6cb6 100644 --- a/spec/if/rtems/basedefs/packed.yml +++ b/spec/if/rtems/basedefs/packed.yml @@ -14,6 +14,7 @@ interface-definition: - defined(${/if/compiler/gnuc:/interface-name}) interface-description: null interface-name: RTEMS_PACKED +interface-notes: null interface-type: define links: - role: interface-placement diff --git a/spec/if/rtems/basedefs/predict-false.yml b/spec/if/rtems/basedefs/predict-false.yml index 347b4114..332a639a 100644 --- a/spec/if/rtems/basedefs/predict-false.yml +++ b/spec/if/rtems/basedefs/predict-false.yml @@ -15,6 +15,7 @@ interface-definition: - defined(${/if/compiler/gnuc:/interface-name}) interface-description: null interface-name: RTEMS_PREDICT_FALSE +interface-notes: null interface-params: - description: | is the expression. diff --git a/spec/if/rtems/basedefs/predict-true.yml b/spec/if/rtems/basedefs/predict-true.yml index fb4d20c2..b8a1e7d2 100644 --- a/spec/if/rtems/basedefs/predict-true.yml +++ b/spec/if/rtems/basedefs/predict-true.yml @@ -15,6 +15,7 @@ interface-definition: - defined(${/if/compiler/gnuc:/interface-name}) interface-description: null interface-name: RTEMS_PREDICT_TRUE +interface-notes: null interface-params: - description: | is the expression. diff --git a/spec/if/rtems/basedefs/printflike.yml b/spec/if/rtems/basedefs/printflike.yml index b40c7456..e564ce21 100644 --- a/spec/if/rtems/basedefs/printflike.yml +++ b/spec/if/rtems/basedefs/printflike.yml @@ -14,6 +14,7 @@ interface-definition: - defined(${/if/compiler/gnuc:/interface-name}) interface-description: null interface-name: RTEMS_PRINTFLIKE +interface-notes: null interface-params: - description: | is the position of the format parameter index (starting with one). diff --git a/spec/if/rtems/basedefs/pure.yml b/spec/if/rtems/basedefs/pure.yml index 82fb0228..63f10204 100644 --- a/spec/if/rtems/basedefs/pure.yml +++ b/spec/if/rtems/basedefs/pure.yml @@ -15,6 +15,7 @@ interface-definition: - defined(${/if/compiler/gnuc:/interface-name}) interface-description: null interface-name: RTEMS_PURE +interface-notes: null interface-type: define links: - role: interface-placement diff --git a/spec/if/rtems/basedefs/return-address.yml b/spec/if/rtems/basedefs/return-address.yml index 7791b71c..6302589c 100644 --- a/spec/if/rtems/basedefs/return-address.yml +++ b/spec/if/rtems/basedefs/return-address.yml @@ -13,6 +13,7 @@ interface-definition: - 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. diff --git a/spec/if/rtems/basedefs/section.yml b/spec/if/rtems/basedefs/section.yml index f8236464..00e46544 100644 --- a/spec/if/rtems/basedefs/section.yml +++ b/spec/if/rtems/basedefs/section.yml @@ -14,6 +14,7 @@ interface-definition: - 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. diff --git a/spec/if/rtems/basedefs/static-assert.yml b/spec/if/rtems/basedefs/static-assert.yml index 27c05f4f..c31eafa8 100644 --- a/spec/if/rtems/basedefs/static-assert.yml +++ b/spec/if/rtems/basedefs/static-assert.yml @@ -19,6 +19,7 @@ interface-definition: - ${/if/compiler/stdc-version:/interface-name} >= 201112L interface-description: null interface-name: RTEMS_STATIC_ASSERT +interface-notes: null interface-params: - description: | is the condition this static assertion shall satisfy. diff --git a/spec/if/rtems/basedefs/string.yml b/spec/if/rtems/basedefs/string.yml index 73ceb85b..ac67e0d2 100644 --- a/spec/if/rtems/basedefs/string.yml +++ b/spec/if/rtems/basedefs/string.yml @@ -9,6 +9,7 @@ interface-definition: variants: [] interface-description: null interface-name: RTEMS_STRING +interface-notes: null interface-params: - description: | is the token to stringify. diff --git a/spec/if/rtems/basedefs/symbol-name.yml b/spec/if/rtems/basedefs/symbol-name.yml index 968b3830..44b49b04 100644 --- a/spec/if/rtems/basedefs/symbol-name.yml +++ b/spec/if/rtems/basedefs/symbol-name.yml @@ -14,6 +14,7 @@ interface-definition: - defined(${/if/compiler/user-label-prefix:/interface-name}) interface-description: null interface-name: RTEMS_SYMBOL_NAME +interface-notes: null interface-params: - description: | is the user defined name of the symbol. The name shall be a valid diff --git a/spec/if/rtems/basedefs/true.yml b/spec/if/rtems/basedefs/true.yml index 7ced1dd8..8b3ed397 100644 --- a/spec/if/rtems/basedefs/true.yml +++ b/spec/if/rtems/basedefs/true.yml @@ -2,13 +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: - - not: "TRUE" +- not: 'TRUE' interface-brief: If TRUE is undefined, then TRUE is defined to 1. -interface-description: null -interface-name: "TRUE" interface-definition: - default: "1" + default: '1' variants: [] +interface-description: null +interface-name: 'TRUE' +interface-notes: null interface-type: define links: - role: interface-placement diff --git a/spec/if/rtems/basedefs/typeof-refx.yml b/spec/if/rtems/basedefs/typeof-refx.yml index 5a96a325..00616b9c 100644 --- a/spec/if/rtems/basedefs/typeof-refx.yml +++ b/spec/if/rtems/basedefs/typeof-refx.yml @@ -15,6 +15,7 @@ interface-definition: interface-description: | The reference type idea is based on libHX by Jan Engelhardt. interface-name: RTEMS_TYPEOF_REFX +interface-notes: null interface-params: - description: | is the pointer indirection level expressed in *. diff --git a/spec/if/rtems/basedefs/unreachable.yml b/spec/if/rtems/basedefs/unreachable.yml index 76787629..b2600487 100644 --- a/spec/if/rtems/basedefs/unreachable.yml +++ b/spec/if/rtems/basedefs/unreachable.yml @@ -17,6 +17,7 @@ interface-definition: - defined(${/if/compiler/gnuc:/interface-name}) interface-description: null interface-name: RTEMS_UNREACHABLE +interface-notes: null interface-params: [] interface-return: return: null diff --git a/spec/if/rtems/basedefs/unused.yml b/spec/if/rtems/basedefs/unused.yml index 6caa5fbd..beef36d5 100644 --- a/spec/if/rtems/basedefs/unused.yml +++ b/spec/if/rtems/basedefs/unused.yml @@ -14,6 +14,7 @@ interface-definition: - defined(${/if/compiler/gnuc:/interface-name}) interface-description: null interface-name: RTEMS_UNUSED +interface-notes: null interface-type: define links: - role: interface-placement diff --git a/spec/if/rtems/basedefs/used.yml b/spec/if/rtems/basedefs/used.yml index d9d029aa..b2e7e6a1 100644 --- a/spec/if/rtems/basedefs/used.yml +++ b/spec/if/rtems/basedefs/used.yml @@ -13,6 +13,7 @@ interface-definition: - defined(${/if/compiler/gnuc:/interface-name}) interface-description: null interface-name: RTEMS_USED +interface-notes: null interface-type: define links: - role: interface-placement diff --git a/spec/if/rtems/basedefs/warn-unused-result.yml b/spec/if/rtems/basedefs/warn-unused-result.yml index b6f1c8d4..bb8871d1 100644 --- a/spec/if/rtems/basedefs/warn-unused-result.yml +++ b/spec/if/rtems/basedefs/warn-unused-result.yml @@ -14,6 +14,7 @@ interface-definition: - defined(${/if/compiler/gnuc:/interface-name}) interface-description: null interface-name: RTEMS_WARN_UNUSED_RESULT +interface-notes: null interface-type: define links: - role: interface-placement diff --git a/spec/if/rtems/basedefs/weak-alias.yml b/spec/if/rtems/basedefs/weak-alias.yml index fb497193..a73108fd 100644 --- a/spec/if/rtems/basedefs/weak-alias.yml +++ b/spec/if/rtems/basedefs/weak-alias.yml @@ -14,6 +14,7 @@ interface-definition: - 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. diff --git a/spec/if/rtems/basedefs/weak.yml b/spec/if/rtems/basedefs/weak.yml index 6b9cd64f..9ee84ab6 100644 --- a/spec/if/rtems/basedefs/weak.yml +++ b/spec/if/rtems/basedefs/weak.yml @@ -16,6 +16,7 @@ interface-description: | Use this attribute for function definitions. Do not use it for function declarations. interface-name: RTEMS_WEAK +interface-notes: null interface-type: define links: - role: interface-placement diff --git a/spec/if/rtems/basedefs/xconcat.yml b/spec/if/rtems/basedefs/xconcat.yml index 7f2ded39..283f531b 100644 --- a/spec/if/rtems/basedefs/xconcat.yml +++ b/spec/if/rtems/basedefs/xconcat.yml @@ -9,6 +9,7 @@ interface-definition: variants: [] interface-description: null interface-name: RTEMS_XCONCAT +interface-notes: null interface-params: - description: | is expanded first and then used as the left hand side token of the diff --git a/spec/if/rtems/basedefs/xstring.yml b/spec/if/rtems/basedefs/xstring.yml index f70fa9ef..0593c0a5 100644 --- a/spec/if/rtems/basedefs/xstring.yml +++ b/spec/if/rtems/basedefs/xstring.yml @@ -9,6 +9,7 @@ interface-definition: variants: [] interface-description: null interface-name: RTEMS_XSTRING +interface-notes: null interface-params: - description: | is the token expand and stringify. diff --git a/spec/if/rtems/basedefs/zero-length-array.yml b/spec/if/rtems/basedefs/zero-length-array.yml index 189fb0a3..fc507e6f 100644 --- a/spec/if/rtems/basedefs/zero-length-array.yml +++ b/spec/if/rtems/basedefs/zero-length-array.yml @@ -12,6 +12,7 @@ interface-description: | 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 interface-type: define links: - role: interface-placement diff --git a/spec/if/rtems/config/api-table.yml b/spec/if/rtems/config/api-table.yml new file mode 100644 index 00000000..74eccb12 --- /dev/null +++ b/spec/if/rtems/config/api-table.yml @@ -0,0 +1,117 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +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: +- 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 + description: null + kind: member + 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 + description: null + kind: member + 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 + description: null + kind: member + 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 + description: null + kind: member + 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 + description: null + kind: member + 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 + description: null + kind: member + 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 + description: null + kind: member + 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 + description: null + kind: member + 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 + description: null + kind: member + 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 + description: null + kind: member + 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 + description: null + kind: member + 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 + description: null + kind: member + variants: [] +interface-definition-kind: typedef-only +interface-description: | + Use ${get-api-configuration:/interface-name}() to get the configuration + table. +interface-name: rtems_api_configuration_table +interface-notes: null +interface-type: struct +links: +- role: interface-placement + uid: header-2 +- role: interface-ingroup + uid: /groups/api/config +type: interface diff --git a/spec/if/rtems/config/get-api-configuration.yml b/spec/if/rtems/config/get-api-configuration.yml new file mode 100644 index 00000000..077a84d2 --- /dev/null +++ b/spec/if/rtems/config/get-api-configuration.yml @@ -0,0 +1,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: | + Returns the pointer to the Classic API Configuration Table of this application. +interface-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: [] +interface-type: function +links: +- role: interface-placement + uid: header-2 +- role: interface-ingroup + uid: /groups/api/config +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 new file mode 100644 index 00000000..22d92764 --- /dev/null +++ b/spec/if/rtems/config/get-do-zero-of-workspace.yml @@ -0,0 +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: | + Returns true, if the workspace is zeroed during system initialization, + otherwise returns false. +interface-definition: + default: ${/if/impl/memory/zero-before-use:/interface-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: [] +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-idle-task-stack-size.yml b/spec/if/rtems/config/get-idle-task-stack-size.yml new file mode 100644 index 00000000..57ba76c3 --- /dev/null +++ b/spec/if/rtems/config/get-idle-task-stack-size.yml @@ -0,0 +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: | + Returns the configured IDLE task stack size in bytes of this application. +interface-definition: + default: ${/if/impl/thread/idle-stack-size:/interface-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: [] +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-idle-task.yml b/spec/if/rtems/config/get-idle-task.yml new file mode 100644 index 00000000..560d264c --- /dev/null +++ b/spec/if/rtems/config/get-idle-task.yml @@ -0,0 +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: | + Returns the configured IDLE task entry of this application. +interface-definition: + default: ${/if/impl/thread/idle-body:/interface-name} + variants: [] +interface-description: null +interface-name: rtems_configuration_get_idle_task +interface-notes: null +interface-params: [] +interface-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-interrupt-stack-size.yml b/spec/if/rtems/config/get-interrupt-stack-size.yml new file mode 100644 index 00000000..ca6bbaff --- /dev/null +++ b/spec/if/rtems/config/get-interrupt-stack-size.yml @@ -0,0 +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: | + 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}) + variants: [] +interface-description: null +interface-name: rtems_configuration_get_interrupt_stack_size +interface-notes: null +interface-params: [] +interface-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-barriers.yml b/spec/if/rtems/config/get-maximum-barriers.yml new file mode 100644 index 00000000..6b400041 --- /dev/null +++ b/spec/if/rtems/config/get-maximum-barriers.yml @@ -0,0 +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: | + Returns the maximum number of Classic API Barriers which are configured for + this application. +interface-definition: + default: + params: [] + return: ${/if/c/uint32_t:/interface-name} + variants: [] +interface-description: null +interface-name: rtems_configuration_get_maximum_barriers +interface-notes: null +interface-params: [] +interface-return: + return: null + return-values: [] +interface-type: function +links: +- role: interface-placement + uid: header-2 +- role: interface-ingroup + uid: /groups/api/config +type: interface diff --git a/spec/if/rtems/config/get-maximum-extensions.yml b/spec/if/rtems/config/get-maximum-extensions.yml new file mode 100644 index 00000000..be808032 --- /dev/null +++ b/spec/if/rtems/config/get-maximum-extensions.yml @@ -0,0 +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: | + Returns the maximum number of Classic API User Extensions which are + configured for this application. +interface-definition: + default: + params: [] + return: ${/if/c/uint32_t:/interface-name} + variants: [] +interface-description: null +interface-name: rtems_configuration_get_maximum_extensions +interface-notes: null +interface-params: [] +interface-return: + return: null + return-values: [] +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/config +type: interface diff --git a/spec/if/rtems/config/get-maximum-message-queues.yml b/spec/if/rtems/config/get-maximum-message-queues.yml new file mode 100644 index 00000000..dd2d367c --- /dev/null +++ b/spec/if/rtems/config/get-maximum-message-queues.yml @@ -0,0 +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: | + Returns the maximum number of Classic API Message Queues which are configured + for this application. +interface-definition: + default: + params: [] + return: ${/if/c/uint32_t:/interface-name} + variants: [] +interface-description: null +interface-name: rtems_configuration_get_maximum_message_queues +interface-notes: null +interface-params: [] +interface-return: + return: null + return-values: [] +interface-type: function +links: +- role: interface-placement + uid: header-2 +- role: interface-ingroup + uid: /groups/api/config +type: interface diff --git a/spec/if/rtems/config/get-maximum-partitions.yml b/spec/if/rtems/config/get-maximum-partitions.yml new file mode 100644 index 00000000..faa960b0 --- /dev/null +++ b/spec/if/rtems/config/get-maximum-partitions.yml @@ -0,0 +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: | + Returns the maximum number of Classic API Partitions which are configured for + this application. +interface-definition: + default: + params: [] + return: ${/if/c/uint32_t:/interface-name} + variants: [] +interface-description: null +interface-name: rtems_configuration_get_maximum_partitions +interface-notes: null +interface-params: [] +interface-return: + return: null + return-values: [] +interface-type: function +links: +- role: interface-placement + uid: header-2 +- role: interface-ingroup + uid: /groups/api/config +type: interface diff --git a/spec/if/rtems/config/get-maximum-periods.yml b/spec/if/rtems/config/get-maximum-periods.yml new file mode 100644 index 00000000..5b569cb6 --- /dev/null +++ b/spec/if/rtems/config/get-maximum-periods.yml @@ -0,0 +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: | + Returns the maximum number of Classic API Rate Monotonic Periods which are + configured for this application. +interface-definition: + default: + params: [] + return: ${/if/c/uint32_t:/interface-name} + variants: [] +interface-description: null +interface-name: rtems_configuration_get_maximum_periods +interface-notes: null +interface-params: [] +interface-return: + return: null + return-values: [] +interface-type: function +links: +- role: interface-placement + uid: header-2 +- role: interface-ingroup + uid: /groups/api/config +type: interface diff --git a/spec/if/rtems/config/get-maximum-ports.yml b/spec/if/rtems/config/get-maximum-ports.yml new file mode 100644 index 00000000..792deb79 --- /dev/null +++ b/spec/if/rtems/config/get-maximum-ports.yml @@ -0,0 +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: | + Returns the maximum number of Classic API Dual Ported Memory Areas which are + configured for this application. +interface-definition: + default: + params: [] + return: ${/if/c/uint32_t:/interface-name} + variants: [] +interface-description: null +interface-name: rtems_configuration_get_maximum_ports +interface-notes: null +interface-params: [] +interface-return: + return: null + return-values: [] +interface-type: function +links: +- role: interface-placement + uid: header-2 +- role: interface-ingroup + uid: /groups/api/config +type: interface diff --git a/spec/if/rtems/config/get-maximum-processors.yml b/spec/if/rtems/config/get-maximum-processors.yml new file mode 100644 index 00000000..a52a6e23 --- /dev/null +++ b/spec/if/rtems/config/get-maximum-processors.yml @@ -0,0 +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: | + Returns the maximum number of processors which are configured for this + application. +interface-definition: + default: ${/if/impl/smp/processor-configured-maximum:/interface-name} + variants: [] +interface-description: null +interface-name: rtems_configuration_get_maximum_processors +interface-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: + 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 new file mode 100644 index 00000000..efd251d2 --- /dev/null +++ b/spec/if/rtems/config/get-maximum-regions.yml @@ -0,0 +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: | + Returns the maximum number of Classic API Regions which are configured for + this application. +interface-definition: + default: + params: [] + return: ${/if/c/uint32_t:/interface-name} + variants: [] +interface-description: null +interface-name: rtems_configuration_get_maximum_regions +interface-notes: null +interface-params: [] +interface-return: + return: null + return-values: [] +interface-type: function +links: +- role: interface-placement + uid: header-2 +- role: interface-ingroup + uid: /groups/api/config +type: interface diff --git a/spec/if/rtems/config/get-maximum-semaphores.yml b/spec/if/rtems/config/get-maximum-semaphores.yml new file mode 100644 index 00000000..46fbec45 --- /dev/null +++ b/spec/if/rtems/config/get-maximum-semaphores.yml @@ -0,0 +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: | + Returns the maximum number of Classic API Semaphores which are configured for + this application. +interface-definition: + default: + params: [] + return: ${/if/c/uint32_t:/interface-name} + variants: [] +interface-description: null +interface-name: rtems_configuration_get_maximum_semaphores +interface-notes: null +interface-params: [] +interface-return: + return: null + return-values: [] +interface-type: function +links: +- role: interface-placement + uid: header-2 +- role: interface-ingroup + uid: /groups/api/config +type: interface diff --git a/spec/if/rtems/config/get-maximum-tasks.yml b/spec/if/rtems/config/get-maximum-tasks.yml new file mode 100644 index 00000000..6f855d9e --- /dev/null +++ b/spec/if/rtems/config/get-maximum-tasks.yml @@ -0,0 +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: | + Returns the maximum number of Classic API Tasks which are configured for this + application. +interface-definition: + default: + params: [] + return: ${/if/c/uint32_t:/interface-name} + variants: [] +interface-description: null +interface-name: rtems_configuration_get_maximum_tasks +interface-notes: null +interface-params: [] +interface-return: + return: null + return-values: [] +interface-type: function +links: +- role: interface-placement + uid: header-2 +- role: interface-ingroup + uid: /groups/api/config +type: interface diff --git a/spec/if/rtems/config/get-maximum-timers.yml b/spec/if/rtems/config/get-maximum-timers.yml new file mode 100644 index 00000000..43700c8e --- /dev/null +++ b/spec/if/rtems/config/get-maximum-timers.yml @@ -0,0 +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: | + Returns the maximum number of Classic API Timers which are configured for + this application. +interface-definition: + default: + params: [] + return: ${/if/c/uint32_t:/interface-name} + variants: [] +interface-description: null +interface-name: rtems_configuration_get_maximum_timers +interface-notes: null +interface-params: [] +interface-return: + return: null + return-values: [] +interface-type: function +links: +- role: interface-placement + uid: header-2 +- role: interface-ingroup + uid: /groups/api/config +type: interface diff --git a/spec/if/rtems/config/get-microseconds-per-tick.yml b/spec/if/rtems/config/get-microseconds-per-tick.yml new file mode 100644 index 00000000..bce672f7 --- /dev/null +++ b/spec/if/rtems/config/get-microseconds-per-tick.yml @@ -0,0 +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: | + Returns the number of microseconds per tick configured for this application. +interface-definition: + default: ${/if/impl/watchdog/microseconds-per-tick:/interface-name} + variants: [] +interface-description: null +interface-name: rtems_configuration_get_microseconds_per_tick +interface-notes: null +interface-params: [] +interface-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-milliseconds-per-tick.yml b/spec/if/rtems/config/get-milliseconds-per-tick.yml new file mode 100644 index 00000000..207d1a6b --- /dev/null +++ b/spec/if/rtems/config/get-milliseconds-per-tick.yml @@ -0,0 +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: | + Returns the number of milliseconds per tick configured for this application. +interface-definition: + default: (${/if/impl/watchdog/microseconds-per-tick:/interface-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: [] +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-nanoseconds-per-tick.yml b/spec/if/rtems/config/get-nanoseconds-per-tick.yml new file mode 100644 index 00000000..abca907a --- /dev/null +++ b/spec/if/rtems/config/get-nanoseconds-per-tick.yml @@ -0,0 +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: | + Returns the number of microseconds per tick configured for this application. +interface-definition: + default: ${/if/impl/watchdog/nanoseconds-per-tick:/interface-name} + variants: [] +interface-description: null +interface-name: rtems_configuration_get_nanoseconds_per_tick +interface-notes: null +interface-params: [] +interface-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-number-of-initial-extensions.yml b/spec/if/rtems/config/get-number-of-initial-extensions.yml new file mode 100644 index 00000000..283caa7d --- /dev/null +++ b/spec/if/rtems/config/get-number-of-initial-extensions.yml @@ -0,0 +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: | + 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}) + variants: [] +interface-description: null +interface-name: rtems_configuration_get_number_of_initial_extensions +interface-notes: null +interface-params: [] +interface-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-stack-allocate-hook.yml b/spec/if/rtems/config/get-stack-allocate-hook.yml new file mode 100644 index 00000000..9ad0dbdc --- /dev/null +++ b/spec/if/rtems/config/get-stack-allocate-hook.yml @@ -0,0 +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: | + Returns the thread stack allocator allocate hook. +interface-definition: + default: ${/if/impl/stack/allocator-allocate:/interface-name} + variants: [] +interface-description: null +interface-name: rtems_configuration_get_stack_allocate_hook +interface-notes: null +interface-params: [] +interface-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-stack-allocate-init-hook.yml b/spec/if/rtems/config/get-stack-allocate-init-hook.yml new file mode 100644 index 00000000..35519031 --- /dev/null +++ b/spec/if/rtems/config/get-stack-allocate-init-hook.yml @@ -0,0 +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: | + Returns the thread stack allocator initialization hook. +interface-definition: + default: ${/if/impl/stack/allocator-initialize:/interface-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: [] +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-stack-allocator-avoids-work-space.yml b/spec/if/rtems/config/get-stack-allocator-avoids-work-space.yml new file mode 100644 index 00000000..e8cd8554 --- /dev/null +++ b/spec/if/rtems/config/get-stack-allocator-avoids-work-space.yml @@ -0,0 +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: | + Returns true, if the thread stack allocator avoids the workspace, otherwise + returns false. +interface-definition: + default: ${/if/impl/stack/allocator-avoids-workspace:/interface-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: [] +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-stack-free-hook.yml b/spec/if/rtems/config/get-stack-free-hook.yml new file mode 100644 index 00000000..70bd32e0 --- /dev/null +++ b/spec/if/rtems/config/get-stack-free-hook.yml @@ -0,0 +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: | + Returns the thread stack allocator free hook. +interface-definition: + default: ${/if/impl/stack/allocator-free:/interface-name} + variants: [] +interface-description: null +interface-name: rtems_configuration_get_stack_free_hook +interface-notes: null +interface-params: [] +interface-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-stack-space-size.yml b/spec/if/rtems/config/get-stack-space-size.yml new file mode 100644 index 00000000..98b5b457 --- /dev/null +++ b/spec/if/rtems/config/get-stack-space-size.yml @@ -0,0 +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: | + Returns the thread stack space size in bytes of configured for this + application. +interface-definition: + default: + params: [] + return: ${/if/c/uintptr_t:/interface-name} + variants: [] +interface-description: null +interface-name: rtems_configuration_get_stack_space_size +interface-notes: null +interface-params: [] +interface-return: + return: null + return-values: [] +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/config +type: interface diff --git a/spec/if/rtems/config/get-ticks-per-timeslice.yml b/spec/if/rtems/config/get-ticks-per-timeslice.yml new file mode 100644 index 00000000..02c606b5 --- /dev/null +++ b/spec/if/rtems/config/get-ticks-per-timeslice.yml @@ -0,0 +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: | + Returns the ticks per timeslice configured for this application. +interface-definition: + default: ${/if/impl/watchdog/ticks-per-timeslice:/interface-name} + variants: [] +interface-description: null +interface-name: rtems_configuration_get_ticks_per_timeslice +interface-notes: null +interface-params: [] +interface-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-unified-work-area.yml b/spec/if/rtems/config/get-unified-work-area.yml new file mode 100644 index 00000000..c8e2a42c --- /dev/null +++ b/spec/if/rtems/config/get-unified-work-area.yml @@ -0,0 +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: | + 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} + variants: [] +interface-description: null +interface-name: rtems_configuration_get_unified_work_area +interface-notes: null +interface-params: [] +interface-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-user-extension-table.yml b/spec/if/rtems/config/get-user-extension-table.yml new file mode 100644 index 00000000..6dfda766 --- /dev/null +++ b/spec/if/rtems/config/get-user-extension-table.yml @@ -0,0 +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: | + Returns the pointer to the initial extensions table configured for this + application. +interface-definition: + default: ${/if/impl/userext/initial-extensions:/interface-name} + variants: [] +interface-description: null +interface-name: rtems_configuration_get_user_extension_table +interface-notes: null +interface-params: [] +interface-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-user-multiprocessing-table.yml b/spec/if/rtems/config/get-user-multiprocessing-table.yml new file mode 100644 index 00000000..c1f73588 --- /dev/null +++ b/spec/if/rtems/config/get-user-multiprocessing-table.yml @@ -0,0 +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: | + Returns the pointer to the MPCI configuration table configured for this + application. +interface-definition: + default: ${/if/c/null:/interface-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: [] +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-work-space-size.yml b/spec/if/rtems/config/get-work-space-size.yml new file mode 100644 index 00000000..47b7c6dd --- /dev/null +++ b/spec/if/rtems/config/get-work-space-size.yml @@ -0,0 +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: | + Returns the RTEMS Workspace size in bytes configured for this application. +interface-definition: + default: | + (${/if/impl/wkspace/size:/interface-name} + + (${get-stack-allocator-avoids-work-space:/interface-name}() ? + 0 : ${get-stack-space-size:/interface-name}())) + variants: [] +interface-description: null +interface-name: rtems_configuration_get_work_space_size +interface-notes: null +interface-params: [] +interface-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/header-2.yml b/spec/if/rtems/config/header-2.yml new file mode 100644 index 00000000..0e8757c9 --- /dev/null +++ b/spec/if/rtems/config/header-2.yml @@ -0,0 +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) +enabled-by: true +interface-domain: rtems +interface-path: rtems/rtems/config.h +interface-prefix: cpukit/include +interface-type: header-file +links: [] +type: interface diff --git a/spec/if/rtems/config/header.yml b/spec/if/rtems/config/header.yml new file mode 100644 index 00000000..8cd66f2f --- /dev/null +++ b/spec/if/rtems/config/header.yml @@ -0,0 +1,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-domain: rtems +interface-path: rtems/config.h +interface-prefix: cpukit/include +interface-type: header-file +links: +- enabled-by: RTEMS_MULTIPROCESSING + role: interface-include + uid: /if/impl/mpci/header +- enabled-by: RTEMS_MULTIPROCESSING + role: interface-include + uid: /if/rtems/types/header +type: interface diff --git a/spec/if/rtems/config/resource-is-unlimited.yml b/spec/if/rtems/config/resource-is-unlimited.yml new file mode 100644 index 00000000..b703e460 --- /dev/null +++ b/spec/if/rtems/config/resource-is-unlimited.yml @@ -0,0 +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: | + Returns true, if the resource is unlimited, otherwise returns false. +interface-definition: + default: ${/if/impl/object/is-unlimited:/interface-name}(${.:/interface-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: [] +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/resource-maximum-per-allocation.yml b/spec/if/rtems/config/resource-maximum-per-allocation.yml new file mode 100644 index 00000000..0e140ab2 --- /dev/null +++ b/spec/if/rtems/config/resource-maximum-per-allocation.yml @@ -0,0 +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: | + Returns the resource maximum number per allocation. +interface-definition: + default: ${/if/impl/object/maximum-per-allocation:/interface-name}(${.:/interface-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: [] +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/resource-unlimited.yml b/spec/if/rtems/config/resource-unlimited.yml new file mode 100644 index 00000000..43f5be14 --- /dev/null +++ b/spec/if/rtems/config/resource-unlimited.yml @@ -0,0 +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: | + Returns the specified resource number configured for unlimited resources. +interface-definition: + default: ((${.:/interface-params[0]/name}) | ${unlimited-objects:/interface-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: [] +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/stack-allocate-hook.yml b/spec/if/rtems/config/stack-allocate-hook.yml new file mode 100644 index 00000000..d4b980b5 --- /dev/null +++ b/spec/if/rtems/config/stack-allocate-hook.yml @@ -0,0 +1,19 @@ +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: | + The thread stack allocator allocate handler. +interface-definition: + default: ${/if/impl/stack/allocator-allocate-type:/interface-name} ${.:/interface-name} + variants: [] +interface-description: null +interface-name: rtems_stack_allocate_hook +interface-notes: null +interface-type: typedef +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/config +type: interface diff --git a/spec/if/rtems/config/stack-allocate-init-hook.yml b/spec/if/rtems/config/stack-allocate-init-hook.yml new file mode 100644 index 00000000..18abd6d7 --- /dev/null +++ b/spec/if/rtems/config/stack-allocate-init-hook.yml @@ -0,0 +1,19 @@ +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: | + The thread stack allocator initialization handler. +interface-definition: + default: ${/if/impl/stack/allocator-initialize-type:/interface-name} ${.:/interface-name} + variants: [] +interface-description: null +interface-name: rtems_stack_allocate_init_hook +interface-notes: null +interface-type: typedef +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/config +type: interface diff --git a/spec/if/rtems/config/stack-free-hook.yml b/spec/if/rtems/config/stack-free-hook.yml new file mode 100644 index 00000000..5b15e4f2 --- /dev/null +++ b/spec/if/rtems/config/stack-free-hook.yml @@ -0,0 +1,19 @@ +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: | + The thread stack allocator free handler. +interface-definition: + default: ${/if/impl/stack/allocator-free-type:/interface-name} ${.:/interface-name} + variants: [] +interface-description: null +interface-name: rtems_stack_free_hook +interface-notes: null +interface-type: typedef +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/config +type: interface diff --git a/spec/if/rtems/config/unlimited-objects.yml b/spec/if/rtems/config/unlimited-objects.yml new file mode 100644 index 00000000..ac92cec1 --- /dev/null +++ b/spec/if/rtems/config/unlimited-objects.yml @@ -0,0 +1,19 @@ +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: | + This flag is used in resource numbers to indicate an unlimited resource. +interface-definition: + default: ${/if/impl/object/unlimited-objects:/interface-name} + variants: [] +interface-description: null +interface-name: RTEMS_UNLIMITED_OBJECTS +interface-notes: null +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/config +type: interface diff --git a/spec/if/rtems/init/header.yml b/spec/if/rtems/init/header.yml new file mode 100644 index 00000000..64d108f2 --- /dev/null +++ b/spec/if/rtems/init/header.yml @@ -0,0 +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) +enabled-by: true +interface-domain: rtems +interface-path: rtems/init.h +interface-prefix: cpukit/include +interface-type: header-file +links: [] +type: interface diff --git a/spec/if/rtems/init/initialize-executive.yml b/spec/if/rtems/init/initialize-executive.yml new file mode 100644 index 00000000..b95c79a7 --- /dev/null +++ b/spec/if/rtems/init/initialize-executive.yml @@ -0,0 +1,31 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +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: + default: + params: [] + return: ${/if/rtems/basedefs/no-return:/interface-name} void + variants: [] +interface-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: [] +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/classic/init +type: interface diff --git a/spec/if/rtems/init/shutdown-executive.yml b/spec/if/rtems/init/shutdown-executive.yml new file mode 100644 index 00000000..c0f28ec4 --- /dev/null +++ b/spec/if/rtems/init/shutdown-executive.yml @@ -0,0 +1,34 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +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: + default: + params: + - ${/if/c/uint32_t:/interface-name} ${.:/interface-params[0]/name} + return: ${/if/rtems/basedefs/no-return:/interface-name} void + variants: [] +interface-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: [] +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/classic/init +type: interface diff --git a/spec/if/rtems/status/already-suspended.yml b/spec/if/rtems/status/already-suspended.yml new file mode 100644 index 00000000..4b72cd7d --- /dev/null +++ b/spec/if/rtems/status/already-suspended.yml @@ -0,0 +1,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) +- 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: + default: '15' + variants: [] +interface-description: null +interface-name: RTEMS_ALREADY_SUSPENDED +interface-notes: null +interface-type: enumerator +links: [] +type: interface diff --git a/spec/if/rtems/status/called-from-isr.yml b/spec/if/rtems/status/called-from-isr.yml new file mode 100644 index 00000000..3a8afaa6 --- /dev/null +++ b/spec/if/rtems/status/called-from-isr.yml @@ -0,0 +1,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) +- 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: + default: '18' + variants: [] +interface-description: null +interface-name: RTEMS_CALLED_FROM_ISR +interface-notes: null +interface-type: enumerator +links: [] +type: interface diff --git a/spec/if/rtems/status/code-to-errno.yml b/spec/if/rtems/status/code-to-errno.yml new file mode 100644 index 00000000..3bf138bb --- /dev/null +++ b/spec/if/rtems/status/code-to-errno.yml @@ -0,0 +1,73 @@ +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: | + Maps the specified RTEMS status code to a POSIX error number. +interface-definition: + default: + params: + - ${code:/interface-name} ${.:/interface-params[0]/name} + return: int + variants: [] +interface-description: null +interface-name: rtems_status_code_to_errno +interface-notes: null +interface-params: +- description: is the status code to map. + dir: null + name: status_code +interface-return: + return: null + return-values: + - description: | + The status code is ${successful:/interface-name}. + value: '0' + - description: | + The status code is ${invalid-number:/interface-name}. + value: EBADF + - description: | + The status code is ${resource-in-use:/interface-name}. + value: EBUSY + - description: | + The status code is ${interrupted:/interface-name}. + value: EINTR + - description: | + The status code is ${invalid-clock:/interface-name}, + ${invalid-name:/interface-name}, or ${invalid-node:/interface-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}. + value: EIO + - description: | + The status code is ${unsatisfied:/interface-name}. + value: ENODEV + - description: | + The status code is ${no-memory:/interface-name}. + value: ENOMEM + - description: | + The status code is ${not-configured:/interface-name} or + ${not-implemented:/interface-name}. + value: ENOSYS + - description: | + The status code is ${not-owner-of-resource:/interface-name}. + value: EPERM + - description: | + The status code is ${timeout:/interface-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 new file mode 100644 index 00000000..9a09e653 --- /dev/null +++ b/spec/if/rtems/status/code.yml @@ -0,0 +1,77 @@ +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: | + 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 + uid: header +- role: interface-ingroup + uid: /groups/api/classic/status +- role: interface-enumerator + uid: successful +- role: interface-enumerator + uid: task-exitted +- role: interface-enumerator + uid: mp-not-configured +- role: interface-enumerator + uid: invalid-name +- role: interface-enumerator + uid: invalid-id +- role: interface-enumerator + uid: too-many +- role: interface-enumerator + uid: timeout +- role: interface-enumerator + uid: object-was-deleted +- role: interface-enumerator + uid: invalid-size +- role: interface-enumerator + uid: invalid-address +- role: interface-enumerator + uid: invalid-number +- role: interface-enumerator + uid: not-defined +- role: interface-enumerator + uid: resource-in-use +- role: interface-enumerator + uid: unsatisfied +- role: interface-enumerator + uid: incorrect-state +- role: interface-enumerator + uid: already-suspended +- role: interface-enumerator + uid: illegal-on-self +- role: interface-enumerator + uid: illegal-on-remote-object +- role: interface-enumerator + uid: called-from-isr +- role: interface-enumerator + uid: invalid-priority +- role: interface-enumerator + uid: invalid-clock +- role: interface-enumerator + uid: invalid-node +- role: interface-enumerator + uid: not-configured +- role: interface-enumerator + uid: not-owner-of-resource +- role: interface-enumerator + uid: not-implemented +- role: interface-enumerator + uid: internal-error +- role: interface-enumerator + uid: no-memory +- role: interface-enumerator + uid: io-error +- role: interface-enumerator + uid: interrupted +- role: interface-enumerator + uid: proxy-blocking +type: interface diff --git a/spec/if/rtems/status/first.yml b/spec/if/rtems/status/first.yml new file mode 100644 index 00000000..2380936d --- /dev/null +++ b/spec/if/rtems/status/first.yml @@ -0,0 +1,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) +- 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} + variants: [] +interface-description: null +interface-name: RTEMS_STATUS_CODES_FIRST +interface-notes: null +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/classic/status +type: interface diff --git a/spec/if/rtems/status/header.yml b/spec/if/rtems/status/header.yml new file mode 100644 index 00000000..9662ff09 --- /dev/null +++ b/spec/if/rtems/status/header.yml @@ -0,0 +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) +enabled-by: true +interface-domain: rtems +interface-path: rtems/rtems/status.h +interface-prefix: cpukit/include +interface-type: header-file +links: [] +type: interface diff --git a/spec/if/rtems/status/illegal-on-remote-object.yml b/spec/if/rtems/status/illegal-on-remote-object.yml new file mode 100644 index 00000000..e27177b3 --- /dev/null +++ b/spec/if/rtems/status/illegal-on-remote-object.yml @@ -0,0 +1,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) +- 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: + default: '17' + variants: [] +interface-description: null +interface-name: RTEMS_ILLEGAL_ON_REMOTE_OBJECT +interface-notes: null +interface-type: enumerator +links: [] +type: interface diff --git a/spec/if/rtems/status/illegal-on-self.yml b/spec/if/rtems/status/illegal-on-self.yml new file mode 100644 index 00000000..c2876449 --- /dev/null +++ b/spec/if/rtems/status/illegal-on-self.yml @@ -0,0 +1,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) +- 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: + default: '16' + variants: [] +interface-description: null +interface-name: RTEMS_ILLEGAL_ON_SELF +interface-notes: null +interface-type: enumerator +links: [] +type: interface diff --git a/spec/if/rtems/status/incorrect-state.yml b/spec/if/rtems/status/incorrect-state.yml new file mode 100644 index 00000000..0f6ae8b0 --- /dev/null +++ b/spec/if/rtems/status/incorrect-state.yml @@ -0,0 +1,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) +- 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: + default: '14' + variants: [] +interface-description: null +interface-name: RTEMS_INCORRECT_STATE +interface-notes: null +interface-type: enumerator +links: [] +type: interface diff --git a/spec/if/rtems/status/internal-error.yml b/spec/if/rtems/status/internal-error.yml new file mode 100644 index 00000000..5d6616a5 --- /dev/null +++ b/spec/if/rtems/status/internal-error.yml @@ -0,0 +1,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) +- 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: + default: '25' + variants: [] +interface-description: null +interface-name: RTEMS_INTERNAL_ERROR +interface-notes: null +interface-type: enumerator +links: [] +type: interface diff --git a/spec/if/rtems/status/interrupted.yml b/spec/if/rtems/status/interrupted.yml new file mode 100644 index 00000000..f5833c7c --- /dev/null +++ b/spec/if/rtems/status/interrupted.yml @@ -0,0 +1,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) +- 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: + default: '28' + variants: [] +interface-description: null +interface-name: RTEMS_INTERRUPTED +interface-notes: null +interface-type: enumerator +links: [] +type: interface diff --git a/spec/if/rtems/status/invalid-address.yml b/spec/if/rtems/status/invalid-address.yml new file mode 100644 index 00000000..e6730ef6 --- /dev/null +++ b/spec/if/rtems/status/invalid-address.yml @@ -0,0 +1,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) +- 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: + default: '9' + variants: [] +interface-description: null +interface-name: RTEMS_INVALID_ADDRESS +interface-notes: null +interface-type: enumerator +links: [] +type: interface diff --git a/spec/if/rtems/status/invalid-clock.yml b/spec/if/rtems/status/invalid-clock.yml new file mode 100644 index 00000000..ff4bcecb --- /dev/null +++ b/spec/if/rtems/status/invalid-clock.yml @@ -0,0 +1,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) +- 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: + default: '20' + variants: [] +interface-description: null +interface-name: RTEMS_INVALID_CLOCK +interface-notes: null +interface-type: enumerator +links: [] +type: interface diff --git a/spec/if/rtems/status/invalid-id.yml b/spec/if/rtems/status/invalid-id.yml new file mode 100644 index 00000000..32b81d30 --- /dev/null +++ b/spec/if/rtems/status/invalid-id.yml @@ -0,0 +1,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) +- 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: + default: '4' + variants: [] +interface-description: null +interface-name: RTEMS_INVALID_ID +interface-notes: null +interface-type: enumerator +links: [] +type: interface diff --git a/spec/if/rtems/status/invalid-name.yml b/spec/if/rtems/status/invalid-name.yml new file mode 100644 index 00000000..14fe0325 --- /dev/null +++ b/spec/if/rtems/status/invalid-name.yml @@ -0,0 +1,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) +- 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: + default: '3' + variants: [] +interface-description: null +interface-name: RTEMS_INVALID_NAME +interface-notes: null +interface-type: enumerator +links: [] +type: interface diff --git a/spec/if/rtems/status/invalid-node.yml b/spec/if/rtems/status/invalid-node.yml new file mode 100644 index 00000000..3cfb2454 --- /dev/null +++ b/spec/if/rtems/status/invalid-node.yml @@ -0,0 +1,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) +- 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: + default: '21' + variants: [] +interface-description: null +interface-name: RTEMS_INVALID_NODE +interface-notes: null +interface-type: enumerator +links: [] +type: interface diff --git a/spec/if/rtems/status/invalid-number.yml b/spec/if/rtems/status/invalid-number.yml new file mode 100644 index 00000000..77aa3637 --- /dev/null +++ b/spec/if/rtems/status/invalid-number.yml @@ -0,0 +1,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) +- 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: + default: '10' + variants: [] +interface-description: null +interface-name: RTEMS_INVALID_NUMBER +interface-notes: null +interface-type: enumerator +links: [] +type: interface diff --git a/spec/if/rtems/status/invalid-priority.yml b/spec/if/rtems/status/invalid-priority.yml new file mode 100644 index 00000000..f50840eb --- /dev/null +++ b/spec/if/rtems/status/invalid-priority.yml @@ -0,0 +1,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) +- 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: + default: '19' + variants: [] +interface-description: null +interface-name: RTEMS_INVALID_PRIORITY +interface-notes: null +interface-type: enumerator +links: [] +type: interface diff --git a/spec/if/rtems/status/invalid-size.yml b/spec/if/rtems/status/invalid-size.yml new file mode 100644 index 00000000..db39f247 --- /dev/null +++ b/spec/if/rtems/status/invalid-size.yml @@ -0,0 +1,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) +- 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: + default: '8' + variants: [] +interface-description: null +interface-name: RTEMS_INVALID_SIZE +interface-notes: null +interface-type: enumerator +links: [] +type: interface diff --git a/spec/if/rtems/status/io-error.yml b/spec/if/rtems/status/io-error.yml new file mode 100644 index 00000000..c08c5777 --- /dev/null +++ b/spec/if/rtems/status/io-error.yml @@ -0,0 +1,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) +- 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: + default: '27' + variants: [] +interface-description: null +interface-name: RTEMS_IO_ERROR +interface-notes: null +interface-type: enumerator +links: [] +type: interface diff --git a/spec/if/rtems/status/is-equal.yml b/spec/if/rtems/status/is-equal.yml new file mode 100644 index 00000000..a9b43983 --- /dev/null +++ b/spec/if/rtems/status/is-equal.yml @@ -0,0 +1,37 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +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: + default: + body: | + return ${.:/interface-params[0]/name} == ${.:/interface-params[1]/name}; + params: + - ${code:/interface-name} ${.:/interface-params[0]/name} + - ${code:/interface-name} ${.:/interface-params[1]/name} + return: ${/if/c/bool:/interface-name} + variants: [] +interface-description: null +interface-name: rtems_are_statuses_equal +interface-notes: null +interface-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: 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 new file mode 100644 index 00000000..e871c8c3 --- /dev/null +++ b/spec/if/rtems/status/is-successful.yml @@ -0,0 +1,33 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +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: + default: + body: | + return ${.:/interface-params[0]/name} == ${successful:/interface-name}; + params: + - ${code:/interface-name} ${.:/interface-params[0]/name} + return: ${/if/c/bool:/interface-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: [] +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/last.yml b/spec/if/rtems/status/last.yml new file mode 100644 index 00000000..71ffcd57 --- /dev/null +++ b/spec/if/rtems/status/last.yml @@ -0,0 +1,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) +- 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} + variants: [] +interface-description: null +interface-name: RTEMS_STATUS_CODES_LAST +interface-notes: null +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/classic/status +type: interface diff --git a/spec/if/rtems/status/mp-not-configured.yml b/spec/if/rtems/status/mp-not-configured.yml new file mode 100644 index 00000000..4b617bc9 --- /dev/null +++ b/spec/if/rtems/status/mp-not-configured.yml @@ -0,0 +1,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) +- 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: + default: '2' + variants: [] +interface-description: null +interface-name: RTEMS_MP_NOT_CONFIGURED +interface-notes: null +interface-type: enumerator +links: [] +type: interface diff --git a/spec/if/rtems/status/no-memory.yml b/spec/if/rtems/status/no-memory.yml new file mode 100644 index 00000000..f1974354 --- /dev/null +++ b/spec/if/rtems/status/no-memory.yml @@ -0,0 +1,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) +- 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: + default: '26' + variants: [] +interface-description: null +interface-name: RTEMS_NO_MEMORY +interface-notes: null +interface-type: enumerator +links: [] +type: interface diff --git a/spec/if/rtems/status/not-configured.yml b/spec/if/rtems/status/not-configured.yml new file mode 100644 index 00000000..bad4aeeb --- /dev/null +++ b/spec/if/rtems/status/not-configured.yml @@ -0,0 +1,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) +- 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: + default: '22' + variants: [] +interface-description: null +interface-name: RTEMS_NOT_CONFIGURED +interface-notes: null +interface-type: enumerator +links: [] +type: interface diff --git a/spec/if/rtems/status/not-defined.yml b/spec/if/rtems/status/not-defined.yml new file mode 100644 index 00000000..2e1ef7f7 --- /dev/null +++ b/spec/if/rtems/status/not-defined.yml @@ -0,0 +1,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) +- 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: + default: '11' + variants: [] +interface-description: null +interface-name: RTEMS_NOT_DEFINED +interface-notes: null +interface-type: enumerator +links: [] +type: interface diff --git a/spec/if/rtems/status/not-implemented.yml b/spec/if/rtems/status/not-implemented.yml new file mode 100644 index 00000000..94001c87 --- /dev/null +++ b/spec/if/rtems/status/not-implemented.yml @@ -0,0 +1,19 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +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: + default: '24' + variants: [] +interface-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 +interface-type: enumerator +links: [] +type: interface diff --git a/spec/if/rtems/status/not-owner-of-resource.yml b/spec/if/rtems/status/not-owner-of-resource.yml new file mode 100644 index 00000000..528da17a --- /dev/null +++ b/spec/if/rtems/status/not-owner-of-resource.yml @@ -0,0 +1,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) +- 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: + default: '23' + variants: [] +interface-description: null +interface-name: RTEMS_NOT_OWNER_OF_RESOURCE +interface-notes: null +interface-type: enumerator +links: [] +type: interface diff --git a/spec/if/rtems/status/object-was-deleted.yml b/spec/if/rtems/status/object-was-deleted.yml new file mode 100644 index 00000000..608e5371 --- /dev/null +++ b/spec/if/rtems/status/object-was-deleted.yml @@ -0,0 +1,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) +- 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: + default: '7' + variants: [] +interface-description: null +interface-name: RTEMS_OBJECT_WAS_DELETED +interface-notes: null +interface-type: enumerator +links: [] +type: interface diff --git a/spec/if/rtems/status/proxy-blocking.yml b/spec/if/rtems/status/proxy-blocking.yml new file mode 100644 index 00000000..b70e4d3b --- /dev/null +++ b/spec/if/rtems/status/proxy-blocking.yml @@ -0,0 +1,21 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +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: + default: '29' + variants: [] +interface-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 +interface-type: enumerator +links: [] +type: interface diff --git a/spec/if/rtems/status/resource-in-use.yml b/spec/if/rtems/status/resource-in-use.yml new file mode 100644 index 00000000..ed87bfe6 --- /dev/null +++ b/spec/if/rtems/status/resource-in-use.yml @@ -0,0 +1,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) +- 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: + default: '12' + variants: [] +interface-description: null +interface-name: RTEMS_RESOURCE_IN_USE +interface-notes: null +interface-type: enumerator +links: [] +type: interface diff --git a/spec/if/rtems/status/successful.yml b/spec/if/rtems/status/successful.yml new file mode 100644 index 00000000..f7e1c9e6 --- /dev/null +++ b/spec/if/rtems/status/successful.yml @@ -0,0 +1,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) +- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR) +enabled-by: true +interface-brief: | + This status code indicates successful completion. +interface-definition: + default: '0' + variants: [] +interface-description: null +interface-name: RTEMS_SUCCESSFUL +interface-notes: null +interface-type: enumerator +links: [] +type: interface diff --git a/spec/if/rtems/status/task-exitted.yml b/spec/if/rtems/status/task-exitted.yml new file mode 100644 index 00000000..a0f8b0fc --- /dev/null +++ b/spec/if/rtems/status/task-exitted.yml @@ -0,0 +1,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) +- 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: + default: '1' + variants: [] +interface-description: null +interface-name: RTEMS_TASK_EXITTED +interface-notes: null +interface-type: enumerator +links: [] +type: interface diff --git a/spec/if/rtems/status/text.yml b/spec/if/rtems/status/text.yml new file mode 100644 index 00000000..8e441f1c --- /dev/null +++ b/spec/if/rtems/status/text.yml @@ -0,0 +1,31 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +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: + default: + params: + - ${code:/interface-name} ${.:/interface-params[0]/name} + return: const char * + variants: [] +interface-description: | + The text for each status code is the enumerator constant. +interface-name: rtems_status_text +interface-notes: null +interface-params: +- description: is the status code. + dir: null + name: status_code +interface-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 new file mode 100644 index 00000000..a33e115f --- /dev/null +++ b/spec/if/rtems/status/timeout.yml @@ -0,0 +1,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) +- 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: + default: '6' + variants: [] +interface-description: null +interface-name: RTEMS_TIMEOUT +interface-notes: null +interface-type: enumerator +links: [] +type: interface diff --git a/spec/if/rtems/status/too-many.yml b/spec/if/rtems/status/too-many.yml new file mode 100644 index 00000000..214d94fb --- /dev/null +++ b/spec/if/rtems/status/too-many.yml @@ -0,0 +1,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) +- 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: + default: '5' + variants: [] +interface-description: null +interface-name: RTEMS_TOO_MANY +interface-notes: null +interface-type: enumerator +links: [] +type: interface diff --git a/spec/if/rtems/status/unsatisfied.yml b/spec/if/rtems/status/unsatisfied.yml new file mode 100644 index 00000000..e702fc15 --- /dev/null +++ b/spec/if/rtems/status/unsatisfied.yml @@ -0,0 +1,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) +- 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: + default: '13' + variants: [] +interface-description: null +interface-name: RTEMS_UNSATISFIED +interface-notes: null +interface-type: enumerator +links: [] +type: interface diff --git a/spec/if/rtems/types/header.yml b/spec/if/rtems/types/header.yml new file mode 100644 index 00000000..f8553130 --- /dev/null +++ b/spec/if/rtems/types/header.yml @@ -0,0 +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) +enabled-by: true +interface-domain: rtems +interface-path: rtems/rtems/types.h +interface-prefix: cpukit/include +interface-type: header-file +links: [] +type: interface |