diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-05-25 09:52:00 +0200 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-05-28 10:38:23 +0200 |
commit | 8821c7d4313148585caaf6f93e85346537746587 (patch) | |
tree | 6eedae16d1e957de7a3628d78c4e053d92ea1ec7 /spec/if/rtems/basedefs | |
parent | 37d648b805563bc20bc296414ed3f086da190306 (diff) |
Rename interface attributes
Diffstat (limited to 'spec/if/rtems/basedefs')
52 files changed, 689 insertions, 689 deletions
diff --git a/spec/if/rtems/basedefs/alias.yml b/spec/if/rtems/basedefs/alias.yml index a87353bf..57fe55b7 100644 --- a/spec/if/rtems/basedefs/alias.yml +++ b/spec/if/rtems/basedefs/alias.yml @@ -1,31 +1,31 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Instructs the compiler to generate an alias to the specified target function. copyrights: - Copyright (C) 2016 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | - Instructs the compiler to generate an alias to the specified target function. -interface-definition: +definition: default: '' variants: - definition: | __attribute__((__alias__(#_target))) enabled-by: - - defined(${/if/compiler/gnuc:/interface-name}) -interface-description: null -interface-name: RTEMS_ALIAS -interface-notes: null -interface-params: -- description: | - is the target function name. - dir: null - name: _target -interface-return: - return: null - return-values: [] + - defined(${/if/compiler/gnuc:/name}) +description: null +enabled-by: true interface-type: macro links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_ALIAS +notes: null +params: +- description: | + is the target function name. + dir: null + name: _target +return: + return: null + return-values: [] type: interface diff --git a/spec/if/rtems/basedefs/aligned.yml b/spec/if/rtems/basedefs/aligned.yml index 17402774..7090f924 100644 --- a/spec/if/rtems/basedefs/aligned.yml +++ b/spec/if/rtems/basedefs/aligned.yml @@ -1,32 +1,32 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -copyrights: -- Copyright (C) 2016 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | +brief: | Instructs the compiler in a declaration or definition to enforce the specified alignment. -interface-definition: +copyrights: +- Copyright (C) 2016 embedded brains GmbH (http://www.embedded-brains.de) +definition: default: '' variants: - definition: | __attribute__((__aligned__(_alignment))) enabled-by: - - defined(${/if/compiler/gnuc:/interface-name}) -interface-description: null -interface-name: RTEMS_ALIGNED -interface-notes: null -interface-params: -- description: | - is the desired alignment in bytes. - dir: null - name: _alignment -interface-return: - return: null - return-values: [] + - defined(${/if/compiler/gnuc:/name}) +description: null +enabled-by: true interface-type: macro links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_ALIGNED +notes: null +params: +- description: | + is the desired alignment in bytes. + dir: null + name: _alignment +return: + return: null + return-values: [] type: interface diff --git a/spec/if/rtems/basedefs/alloc-align.yml b/spec/if/rtems/basedefs/alloc-align.yml index b08bd791..d7d45571 100644 --- a/spec/if/rtems/basedefs/alloc-align.yml +++ b/spec/if/rtems/basedefs/alloc-align.yml @@ -1,32 +1,32 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -copyrights: -- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | +brief: | Tells the compiler in a declaration that the memory allocation alignment parameter of this function is similar to aligned_alloc(). -interface-definition: +copyrights: +- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de) +definition: default: '' variants: - definition: | __attribute__((__alloc_align__(_index))) enabled-by: - - defined(${/if/compiler/gnuc:/interface-name}) -interface-description: null -interface-name: RTEMS_ALLOC_ALIGN -interface-notes: null -interface-params: -- description: | - is the allocation alignment parameter index (starting with one). - dir: null - name: _index -interface-return: - return: null - return-values: [] + - defined(${/if/compiler/gnuc:/name}) +description: null +enabled-by: true interface-type: macro links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_ALLOC_ALIGN +notes: null +params: +- description: | + is the allocation alignment parameter index (starting with one). + dir: null + name: _index +return: + return: null + return-values: [] type: interface diff --git a/spec/if/rtems/basedefs/alloc-size-2.yml b/spec/if/rtems/basedefs/alloc-size-2.yml index e9b8bb62..851a8c8b 100644 --- a/spec/if/rtems/basedefs/alloc-size-2.yml +++ b/spec/if/rtems/basedefs/alloc-size-2.yml @@ -1,21 +1,27 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -copyrights: -- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | +brief: | Tells the compiler in a declaration that the memory allocation item count and item size parameter of this function is similar to calloc(). -interface-definition: +copyrights: +- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de) +definition: default: '' variants: - definition: | __attribute__((__alloc_size__(_count_index, _size_index))) enabled-by: - - defined(${/if/compiler/gnuc:/interface-name}) -interface-description: null -interface-name: RTEMS_ALLOC_SIZE_2 -interface-notes: null -interface-params: + - defined(${/if/compiler/gnuc:/name}) +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/basedefs +name: RTEMS_ALLOC_SIZE_2 +notes: null +params: - description: | is the allocation item count parameter index (starting with one). dir: null @@ -24,13 +30,7 @@ interface-params: is the allocation item size parameter index (starting with one). dir: null name: _size_index -interface-return: +return: return: null return-values: [] -interface-type: macro -links: -- role: interface-placement - uid: header -- role: interface-ingroup - uid: /groups/api/basedefs type: interface diff --git a/spec/if/rtems/basedefs/alloc-size.yml b/spec/if/rtems/basedefs/alloc-size.yml index 68b3729f..3c889153 100644 --- a/spec/if/rtems/basedefs/alloc-size.yml +++ b/spec/if/rtems/basedefs/alloc-size.yml @@ -1,32 +1,32 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -copyrights: -- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | +brief: | Tells the compiler in a declaration that the memory allocation size parameter of this function is similar to malloc(). -interface-definition: +copyrights: +- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de) +definition: default: '' variants: - definition: | __attribute__((__alloc_size__(_index))) enabled-by: - - defined(${/if/compiler/gnuc:/interface-name}) -interface-description: null -interface-name: RTEMS_ALLOC_SIZE -interface-notes: null -interface-params: -- description: | - is the allocation size parameter index (starting with one). - dir: null - name: _index -interface-return: - return: null - return-values: [] + - defined(${/if/compiler/gnuc:/name}) +description: null +enabled-by: true interface-type: macro links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_ALLOC_SIZE +notes: null +params: +- description: | + is the allocation size parameter index (starting with one). + dir: null + name: _index +return: + return: null + return-values: [] type: interface diff --git a/spec/if/rtems/basedefs/array-size.yml b/spec/if/rtems/basedefs/array-size.yml index a8de4678..5dea464a 100644 --- a/spec/if/rtems/basedefs/array-size.yml +++ b/spec/if/rtems/basedefs/array-size.yml @@ -1,28 +1,28 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the element count of the specified array. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | - Returns the element count of the specified array. -interface-definition: +definition: default: | (sizeof(_array) / sizeof((_array)[0])) variants: [] -interface-description: null -interface-name: RTEMS_ARRAY_SIZE -interface-notes: null -interface-params: -- description: | - is the name of the array. - dir: null - name: _array -interface-return: - return: The element count of the specified array. - return-values: [] +description: null +enabled-by: true interface-type: macro links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_ARRAY_SIZE +notes: null +params: +- description: | + is the name of the array. + dir: null + name: _array +return: + return: The element count of the specified array. + return-values: [] type: interface diff --git a/spec/if/rtems/basedefs/compiler-deprecated-attribute.yml b/spec/if/rtems/basedefs/compiler-deprecated-attribute.yml index 34b7f616..c0e6dc58 100644 --- a/spec/if/rtems/basedefs/compiler-deprecated-attribute.yml +++ b/spec/if/rtems/basedefs/compiler-deprecated-attribute.yml @@ -1,20 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Provided for backward compatibility. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | - Provided for backward compatibility. -interface-definition: +definition: default: | - ${deprecated:/interface-name} + ${deprecated:/name} variants: [] -interface-description: null -interface-name: RTEMS_COMPILER_DEPRECATED_ATTRIBUTE -interface-notes: null +description: null +enabled-by: true interface-type: define links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_COMPILER_DEPRECATED_ATTRIBUTE +notes: null type: interface diff --git a/spec/if/rtems/basedefs/compiler-memory-barrier.yml b/spec/if/rtems/basedefs/compiler-memory-barrier.yml index 36ad47bd..31ed5eb8 100644 --- a/spec/if/rtems/basedefs/compiler-memory-barrier.yml +++ b/spec/if/rtems/basedefs/compiler-memory-barrier.yml @@ -1,28 +1,28 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This macro forbids the compiler to reorder read and write commands around it. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | - This macro forbids the compiler to reorder read and write commands around it. -interface-definition: +definition: default: | do { } while ( 0 ) variants: - definition: | __asm__ volatile( "" ::: "memory" ) enabled-by: - - defined(${/if/compiler/gnuc:/interface-name}) -interface-description: null -interface-name: RTEMS_COMPILER_MEMORY_BARRIER -interface-notes: null -interface-params: [] -interface-return: - return: null - return-values: [] + - defined(${/if/compiler/gnuc:/name}) +description: null +enabled-by: true interface-type: macro links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_COMPILER_MEMORY_BARRIER +notes: null +params: [] +return: + return: null + return-values: [] type: interface diff --git a/spec/if/rtems/basedefs/compiler-no-return-attribute.yml b/spec/if/rtems/basedefs/compiler-no-return-attribute.yml index c5bd8c83..93cf22ac 100644 --- a/spec/if/rtems/basedefs/compiler-no-return-attribute.yml +++ b/spec/if/rtems/basedefs/compiler-no-return-attribute.yml @@ -1,20 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Provided for backward compatibility. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | - Provided for backward compatibility. -interface-definition: +definition: default: | - ${no-return:/interface-name} + ${no-return:/name} variants: [] -interface-description: null -interface-name: RTEMS_COMPILER_NO_RETURN_ATTRIBUTE -interface-notes: null +description: null +enabled-by: true interface-type: define links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_COMPILER_NO_RETURN_ATTRIBUTE +notes: null type: interface diff --git a/spec/if/rtems/basedefs/compiler-packed-attribute.yml b/spec/if/rtems/basedefs/compiler-packed-attribute.yml index d056d3d7..0bd81429 100644 --- a/spec/if/rtems/basedefs/compiler-packed-attribute.yml +++ b/spec/if/rtems/basedefs/compiler-packed-attribute.yml @@ -1,20 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Provided for backward compatibility. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | - Provided for backward compatibility. -interface-definition: +definition: default: | - ${packed:/interface-name} + ${packed:/name} variants: [] -interface-description: null -interface-name: RTEMS_COMPILER_PACKED_ATTRIBUTE -interface-notes: null +description: null +enabled-by: true interface-type: define links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_COMPILER_PACKED_ATTRIBUTE +notes: null type: interface diff --git a/spec/if/rtems/basedefs/compiler-pure-attribute.yml b/spec/if/rtems/basedefs/compiler-pure-attribute.yml index 24178690..70b47c7f 100644 --- a/spec/if/rtems/basedefs/compiler-pure-attribute.yml +++ b/spec/if/rtems/basedefs/compiler-pure-attribute.yml @@ -1,20 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Provided for backward compatibility. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | - Provided for backward compatibility. -interface-definition: +definition: default: | - ${pure:/interface-name} + ${pure:/name} variants: [] -interface-description: null -interface-name: RTEMS_COMPILER_PURE_ATTRIBUTE -interface-notes: null +description: null +enabled-by: true interface-type: define links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_COMPILER_PURE_ATTRIBUTE +notes: null type: interface diff --git a/spec/if/rtems/basedefs/compiler-used-attribute.yml b/spec/if/rtems/basedefs/compiler-used-attribute.yml index ec695e16..e5c0a9e5 100644 --- a/spec/if/rtems/basedefs/compiler-used-attribute.yml +++ b/spec/if/rtems/basedefs/compiler-used-attribute.yml @@ -1,20 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Provided for backward compatibility. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | - Provided for backward compatibility. -interface-definition: +definition: default: | - ${used:/interface-name} + ${used:/name} variants: [] -interface-description: null -interface-name: RTEMS_COMPILER_USED_ATTRIBUTE -interface-notes: null +description: null +enabled-by: true interface-type: define links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_COMPILER_USED_ATTRIBUTE +notes: null type: interface diff --git a/spec/if/rtems/basedefs/concat.yml b/spec/if/rtems/basedefs/concat.yml index 5e73ceba..12ef9d21 100644 --- a/spec/if/rtems/basedefs/concat.yml +++ b/spec/if/rtems/basedefs/concat.yml @@ -1,16 +1,22 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Concatenates _x and _y without expanding. copyrights: - Copyright (C) 2015 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | - Concatenates _x and _y without expanding. -interface-definition: +definition: default: _x##_y variants: [] -interface-description: null -interface-name: RTEMS_CONCAT -interface-notes: null -interface-params: +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/basedefs +name: RTEMS_CONCAT +notes: null +params: - description: | is the left hand side token of the concatenation. dir: null @@ -19,14 +25,8 @@ interface-params: is the right hand side token of the concatenation. dir: null name: _y -interface-return: +return: return: | The concatenation of the tokens _x and _y. return-values: [] -interface-type: macro -links: -- role: interface-placement - uid: header -- role: interface-ingroup - uid: /groups/api/basedefs type: interface diff --git a/spec/if/rtems/basedefs/const.yml b/spec/if/rtems/basedefs/const.yml index 60378f74..39dc20ee 100644 --- a/spec/if/rtems/basedefs/const.yml +++ b/spec/if/rtems/basedefs/const.yml @@ -1,25 +1,25 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -copyrights: -- Copyright (C) 2019 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | +brief: | Tells the compiler in a function declaration that this function has no effect except the return value and that the return value depends only on the value of parameters. -interface-definition: +copyrights: +- Copyright (C) 2019 embedded brains GmbH (http://www.embedded-brains.de) +definition: default: '' variants: - definition: | __attribute__((__const__)) enabled-by: - - defined(${/if/compiler/gnuc:/interface-name}) -interface-description: null -interface-name: RTEMS_CONST -interface-notes: null + - defined(${/if/compiler/gnuc:/name}) +description: null +enabled-by: true interface-type: define links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_CONST +notes: null type: interface diff --git a/spec/if/rtems/basedefs/container-of.yml b/spec/if/rtems/basedefs/container-of.yml index 7073634e..c51e9edf 100644 --- a/spec/if/rtems/basedefs/container-of.yml +++ b/spec/if/rtems/basedefs/container-of.yml @@ -1,17 +1,23 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the pointer to the container of a specified member pointer. copyrights: - Copyright (C) 2014 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | - Returns the pointer to the container of a specified member pointer. -interface-definition: +definition: default: | - ( (_type *) ( (${/if/c/uintptr_t:/interface-name}) ( _m ) - ${/if/c/offsetof:/interface-name}( _type, _member_name ) ) ) + ( (_type *) ( (${/if/c/uintptr_t:/name}) ( _m ) - ${/if/c/offsetof:/name}( _type, _member_name ) ) ) variants: [] -interface-description: null -interface-name: RTEMS_CONTAINER_OF -interface-notes: null -interface-params: +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/basedefs +name: RTEMS_CONTAINER_OF +notes: null +params: - description: | is the pointer to a member of the container. dir: null @@ -24,14 +30,8 @@ interface-params: is the designator name of the container member. dir: null name: _member_name -interface-return: +return: return: | Returns the pointer to the container of a specified member pointer. return-values: [] -interface-type: macro -links: -- role: interface-placement - uid: header -- role: interface-ingroup - uid: /groups/api/basedefs type: interface diff --git a/spec/if/rtems/basedefs/declare-global-symbol.yml b/spec/if/rtems/basedefs/declare-global-symbol.yml index d168393c..cecb7259 100644 --- a/spec/if/rtems/basedefs/declare-global-symbol.yml +++ b/spec/if/rtems/basedefs/declare-global-symbol.yml @@ -1,29 +1,29 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Declares a global symbol with the specified name. copyrights: - Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | - Declares a global symbol with the specified name. -interface-definition: +definition: default: | extern char _name[] variants: [] -interface-description: | +description: | This macro must be placed at file scope. -interface-name: RTEMS_DECLARE_GLOBAL_SYMBOL -interface-notes: null -interface-params: -- description: | - is the name of the global symbol. It shall be a valid designator. - dir: null - name: _name -interface-return: - return: null - return-values: [] +enabled-by: true interface-type: macro links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_DECLARE_GLOBAL_SYMBOL +notes: null +params: +- description: | + is the name of the global symbol. It shall be a valid designator. + dir: null + name: _name +return: + return: null + return-values: [] type: interface diff --git a/spec/if/rtems/basedefs/deconst.yml b/spec/if/rtems/basedefs/deconst.yml index 92295f99..599e0fa9 100644 --- a/spec/if/rtems/basedefs/deconst.yml +++ b/spec/if/rtems/basedefs/deconst.yml @@ -1,18 +1,24 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Performs a type cast which removes const qualifiers without warnings to the + specified type for the specified pointer variable. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) - Copyright (C) 2014 Paval Pisa -enabled-by: true -interface-brief: | - Performs a type cast which removes const qualifiers without warnings to the - specified type for the specified pointer variable. -interface-definition: - default: ${dequalify-depthx:/interface-name}(*, _type, _var) +definition: + default: ${dequalify-depthx:/name}(*, _type, _var) variants: [] -interface-description: null -interface-name: RTEMS_DECONST -interface-notes: null -interface-params: +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/basedefs +name: RTEMS_DECONST +notes: null +params: - description: | is the target type of the cast. dir: null @@ -21,13 +27,7 @@ interface-params: is the pointer variable. dir: null name: _var -interface-return: +return: return: null return-values: [] -interface-type: macro -links: -- role: interface-placement - uid: header -- role: interface-ingroup - uid: /groups/api/basedefs type: interface diff --git a/spec/if/rtems/basedefs/define-global-symbol.yml b/spec/if/rtems/basedefs/define-global-symbol.yml index 157542d6..d506195b 100644 --- a/spec/if/rtems/basedefs/define-global-symbol.yml +++ b/spec/if/rtems/basedefs/define-global-symbol.yml @@ -1,25 +1,31 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Defines a global symbol with the specified name and value. copyrights: - Copyright (C) 2018, 2020 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | - Defines a global symbol with the specified name and value. -interface-definition: +definition: default: '' variants: - definition: | __asm__( - "\t.globl " ${xstring:/interface-name}( ${symbol-name:/interface-name}( _name ) ) - "\n\t.set " ${xstring:/interface-name}( ${symbol-name:/interface-name}( _name ) ) - ", " ${string:/interface-name}( _value ) "\n" + "\t.globl " ${xstring:/name}( ${symbol-name:/name}( _name ) ) + "\n\t.set " ${xstring:/name}( ${symbol-name:/name}( _name ) ) + ", " ${string:/name}( _value ) "\n" ) enabled-by: - - defined(${/if/compiler/user-label-prefix:/interface-name}) -interface-description: | + - defined(${/if/compiler/user-label-prefix:/name}) +description: | This macro shall be placed at file scope. -interface-name: RTEMS_DEFINE_GLOBAL_SYMBOL -interface-notes: null -interface-params: +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/basedefs +name: RTEMS_DEFINE_GLOBAL_SYMBOL +notes: null +params: - description: | is the user defined name of the symbol. The name shall be a valid designator. On the name a macro expansion is performed and afterwards it @@ -32,13 +38,7 @@ interface-params: understood by the assembler. dir: null name: _value -interface-return: +return: return: null return-values: [] -interface-type: macro -links: -- role: interface-placement - uid: header -- role: interface-ingroup - uid: /groups/api/basedefs type: interface diff --git a/spec/if/rtems/basedefs/deprecated.yml b/spec/if/rtems/basedefs/deprecated.yml index 6b86ab43..f7fc3346 100644 --- a/spec/if/rtems/basedefs/deprecated.yml +++ b/spec/if/rtems/basedefs/deprecated.yml @@ -1,24 +1,24 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -copyrights: -- Copyright (C) 2009 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | +brief: | Instructs the compiler in a declaration to issue a warning whenever a variable, function, or type using this declaration will be used. -interface-definition: +copyrights: +- Copyright (C) 2009 embedded brains GmbH (http://www.embedded-brains.de) +definition: default: '' variants: - definition: | __attribute__((__deprecated__)) enabled-by: - - defined(${/if/compiler/gnuc:/interface-name}) -interface-description: null -interface-name: RTEMS_DEPRECATED -interface-notes: null + - defined(${/if/compiler/gnuc:/name}) +description: null +enabled-by: true interface-type: define links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_DEPRECATED +notes: null type: interface diff --git a/spec/if/rtems/basedefs/dequalify-depthx.yml b/spec/if/rtems/basedefs/dequalify-depthx.yml index 43722948..8c107526 100644 --- a/spec/if/rtems/basedefs/dequalify-depthx.yml +++ b/spec/if/rtems/basedefs/dequalify-depthx.yml @@ -1,31 +1,37 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Performs a type cast which removes qualifiers without warnings to the + specified type for the specified variable. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) - Copyright (C) 2014 Paval Pisa -enabled-by: true -interface-brief: | - Performs a type cast which removes qualifiers without warnings to the - specified type for the specified variable. -interface-definition: - default: ((_type)(${/if/c/uintptr_t:/interface-name})(const volatile void *)(_var)) +definition: + default: ((_type)(${/if/c/uintptr_t:/name})(const volatile void *)(_var)) variants: - definition: | (const_cast<_type>(_var)) enabled-by: - - defined(${/if/compiler/cplusplus:/interface-name}) + - defined(${/if/compiler/cplusplus:/name}) - definition: | - ${/if/compiler/builtin-choose-expr:/interface-name}(${/if/compiler/builtin-types-compatible-p:/interface-name}( - ${typeof-refx:/interface-name}(_ptr_level, _var), - ${typeof-refx:/interface-name}(_ptr_level, _type) - ) || ${/if/compiler/builtin-types-compatible-p:/interface-name}(_type, void *), + ${/if/compiler/builtin-choose-expr:/name}(${/if/compiler/builtin-types-compatible-p:/name}( + ${typeof-refx:/name}(_ptr_level, _var), + ${typeof-refx:/name}(_ptr_level, _type) + ) || ${/if/compiler/builtin-types-compatible-p:/name}(_type, void *), (_type)(_var), - ${/if/impl/dequalify-types-not-compatible:/interface-name}()) + ${/if/impl/dequalify-types-not-compatible:/name}()) enabled-by: - - defined(${/if/compiler/gnuc:/interface-name}) -interface-description: null -interface-name: RTEMS_DEQUALIFY_DEPTHX -interface-notes: null -interface-params: + - defined(${/if/compiler/gnuc:/name}) +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/basedefs +name: RTEMS_DEQUALIFY_DEPTHX +notes: null +params: - description: | is the pointer indirection level expressed in *. dir: null @@ -38,13 +44,7 @@ interface-params: is the variable. dir: null name: _var -interface-return: +return: return: null return-values: [] -interface-type: macro -links: -- role: interface-placement - uid: header -- role: interface-ingroup - uid: /groups/api/basedefs type: interface diff --git a/spec/if/rtems/basedefs/dequalify.yml b/spec/if/rtems/basedefs/dequalify.yml index b22fe060..4d1c4e76 100644 --- a/spec/if/rtems/basedefs/dequalify.yml +++ b/spec/if/rtems/basedefs/dequalify.yml @@ -1,18 +1,24 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Performs a type cast which removes all qualifiers without warnings to the + specified type for the specified pointer variable. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) - Copyright (C) 2014 Paval Pisa -enabled-by: true -interface-brief: | - Performs a type cast which removes all qualifiers without warnings to the - specified type for the specified pointer variable. -interface-definition: - default: ${dequalify-depthx:/interface-name}(*, _type, _var) +definition: + default: ${dequalify-depthx:/name}(*, _type, _var) variants: [] -interface-description: null -interface-name: RTEMS_DEQUALIFY -interface-notes: null -interface-params: +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/basedefs +name: RTEMS_DEQUALIFY +notes: null +params: - description: | is the target type of the cast. dir: null @@ -21,13 +27,7 @@ interface-params: is the pointer variable. dir: null name: _var -interface-return: +return: return: null return-values: [] -interface-type: macro -links: -- role: interface-placement - uid: header -- role: interface-ingroup - uid: /groups/api/basedefs type: interface diff --git a/spec/if/rtems/basedefs/devolatile.yml b/spec/if/rtems/basedefs/devolatile.yml index 100ea495..baf4c628 100644 --- a/spec/if/rtems/basedefs/devolatile.yml +++ b/spec/if/rtems/basedefs/devolatile.yml @@ -1,18 +1,24 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Performs a type cast which removes volatile qualifiers without warnings to + the specified type for the specified pointer variable. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) - Copyright (C) 2014 Paval Pisa -enabled-by: true -interface-brief: | - Performs a type cast which removes volatile qualifiers without warnings to - the specified type for the specified pointer variable. -interface-definition: - default: ${dequalify-depthx:/interface-name}(*, _type, _var) +definition: + default: ${dequalify-depthx:/name}(*, _type, _var) variants: [] -interface-description: null -interface-name: RTEMS_DEVOLATILE -interface-notes: null -interface-params: +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/basedefs +name: RTEMS_DEVOLATILE +notes: null +params: - description: | is the target type of the cast. dir: null @@ -21,13 +27,7 @@ interface-params: is the pointer variable. dir: null name: _var -interface-return: +return: return: null return-values: [] -interface-type: macro -links: -- role: interface-placement - uid: header -- role: interface-ingroup - uid: /groups/api/basedefs type: interface diff --git a/spec/if/rtems/basedefs/expand.yml b/spec/if/rtems/basedefs/expand.yml index 5423d2c1..79689785 100644 --- a/spec/if/rtems/basedefs/expand.yml +++ b/spec/if/rtems/basedefs/expand.yml @@ -1,27 +1,27 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Helper macro to perform a macro expansion on the specified token. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | - Helper macro to perform a macro expansion on the specified token. -interface-definition: +definition: default: _token variants: [] -interface-description: null -interface-name: RTEMS_EXPAND -interface-notes: null -interface-params: -- description: | - is the token to expand. - dir: null - name: _token -interface-return: - return: null - return-values: [] +description: null +enabled-by: true interface-type: macro links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_EXPAND +notes: null +params: +- description: | + is the token to expand. + dir: null + name: _token +return: + return: null + return-values: [] type: interface diff --git a/spec/if/rtems/basedefs/false.yml b/spec/if/rtems/basedefs/false.yml index ae2eb012..57d16f60 100644 --- a/spec/if/rtems/basedefs/false.yml +++ b/spec/if/rtems/basedefs/false.yml @@ -1,19 +1,19 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: If FALSE is undefined, then FALSE is defined to 0. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: -- not: 'FALSE' -interface-brief: If FALSE is undefined, then FALSE is defined to 0. -interface-definition: +definition: default: '0' variants: [] -interface-description: null -interface-name: 'FALSE' -interface-notes: null +description: null +enabled-by: +- not: 'FALSE' interface-type: define links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: 'FALSE' +notes: null type: interface diff --git a/spec/if/rtems/basedefs/have-member-same-type.yml b/spec/if/rtems/basedefs/have-member-same-type.yml index 50c0dbf5..22346cca 100644 --- a/spec/if/rtems/basedefs/have-member-same-type.yml +++ b/spec/if/rtems/basedefs/have-member-same-type.yml @@ -1,25 +1,31 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -copyrights: -- Copyright (C) 2017 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | +brief: | Evaluates to true if the specified members of two types have compatible types, otherwise to false. -interface-definition: +copyrights: +- Copyright (C) 2017 embedded brains GmbH (http://www.embedded-brains.de) +definition: default: | - ${/if/c/true:/interface-name} + ${/if/c/true:/name} variants: - definition: | - ${/if/compiler/builtin-types-compatible-p:/interface-name}( - ${/if/compiler/typeof:/interface-name}( ( (_t_lhs *) 0 )->_m_lhs ), - ${/if/compiler/typeof:/interface-name}( ( (_t_rhs *) 0 )->_m_rhs ) + ${/if/compiler/builtin-types-compatible-p:/name}( + ${/if/compiler/typeof:/name}( ( (_t_lhs *) 0 )->_m_lhs ), + ${/if/compiler/typeof:/name}( ( (_t_rhs *) 0 )->_m_rhs ) ) enabled-by: - - defined(${/if/compiler/gnuc:/interface-name}) -interface-description: null -interface-name: RTEMS_HAVE_MEMBER_SAME_TYPE -interface-notes: null -interface-params: + - defined(${/if/compiler/gnuc:/name}) +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/basedefs +name: RTEMS_HAVE_MEMBER_SAME_TYPE +notes: null +params: - description: | is the left hand side type. dir: null @@ -36,13 +42,7 @@ interface-params: is the right hand side member. dir: null name: _m_rhs -interface-return: +return: return: null return-values: [] -interface-type: macro -links: -- role: interface-placement - uid: header -- role: interface-ingroup - uid: /groups/api/basedefs type: interface diff --git a/spec/if/rtems/basedefs/header.yml b/spec/if/rtems/basedefs/header.yml index fdb4ff9e..760ce111 100644 --- a/spec/if/rtems/basedefs/header.yml +++ b/spec/if/rtems/basedefs/header.yml @@ -1,10 +1,8 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +domain: rtems enabled-by: true -interface-domain: rtems -interface-path: rtems/score/basedefs.h -interface-prefix: cpukit/include interface-type: header-file links: - enabled-by: [] @@ -22,4 +20,6 @@ links: not: ASM role: interface-include uid: /if/c/stdint +path: rtems/score/basedefs.h +prefix: cpukit/include type: interface diff --git a/spec/if/rtems/basedefs/inline-routine.yml b/spec/if/rtems/basedefs/inline-routine.yml index a041fe20..b26b7fcf 100644 --- a/spec/if/rtems/basedefs/inline-routine.yml +++ b/spec/if/rtems/basedefs/inline-routine.yml @@ -1,23 +1,23 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -copyrights: -- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | +brief: | Gives a hint to the compiler in a function declaration to inline this function. -interface-definition: +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: default: static inline variants: - definition: static __inline__ enabled-by: - - defined(${/if/compiler/gnuc:/interface-name}) -interface-description: null -interface-name: RTEMS_INLINE_ROUTINE -interface-notes: null + - defined(${/if/compiler/gnuc:/name}) +description: null +enabled-by: true interface-type: define links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_INLINE_ROUTINE +notes: null type: interface diff --git a/spec/if/rtems/basedefs/malloclike.yml b/spec/if/rtems/basedefs/malloclike.yml index 9a27edce..3608e444 100644 --- a/spec/if/rtems/basedefs/malloclike.yml +++ b/spec/if/rtems/basedefs/malloclike.yml @@ -1,24 +1,24 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -copyrights: -- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | +brief: | Tells the compiler in a declaration that this function is a memory allocation function similar to malloc(). -interface-definition: +copyrights: +- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de) +definition: default: '' variants: - definition: | __attribute__((__malloc__)) enabled-by: - - defined(${/if/compiler/gnuc:/interface-name}) -interface-description: null -interface-name: RTEMS_MALLOCLIKE -interface-notes: null + - defined(${/if/compiler/gnuc:/name}) +description: null +enabled-by: true interface-type: define links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_MALLOCLIKE +notes: null type: interface diff --git a/spec/if/rtems/basedefs/no-inline.yml b/spec/if/rtems/basedefs/no-inline.yml index 72146d5f..9d70a151 100644 --- a/spec/if/rtems/basedefs/no-inline.yml +++ b/spec/if/rtems/basedefs/no-inline.yml @@ -1,23 +1,23 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Instructs the compiler in a function declaration to not inline this function. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | - Instructs the compiler in a function declaration to not inline this function. -interface-definition: +definition: default: '' variants: - definition: | __attribute__((__noinline__)) enabled-by: - - defined(${/if/compiler/gnuc:/interface-name}) -interface-description: null -interface-name: RTEMS_NO_INLINE -interface-notes: null + - defined(${/if/compiler/gnuc:/name}) +description: null +enabled-by: true interface-type: define links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_NO_INLINE +notes: null type: interface diff --git a/spec/if/rtems/basedefs/no-return.yml b/spec/if/rtems/basedefs/no-return.yml index 943a2587..fa71b2d5 100644 --- a/spec/if/rtems/basedefs/no-return.yml +++ b/spec/if/rtems/basedefs/no-return.yml @@ -1,24 +1,24 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -copyrights: -- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | +brief: | Tells the compiler in a function declaration that this function does not return. -interface-definition: +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: default: '' variants: - definition: | __attribute__((__noreturn__)) enabled-by: - - defined(${/if/compiler/gnuc:/interface-name}) -interface-description: null -interface-name: RTEMS_NO_RETURN -interface-notes: null + - defined(${/if/compiler/gnuc:/name}) +description: null +enabled-by: true interface-type: define links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_NO_RETURN +notes: null type: interface diff --git a/spec/if/rtems/basedefs/obfuscate-variable.yml b/spec/if/rtems/basedefs/obfuscate-variable.yml index 290a4060..2f943a2d 100644 --- a/spec/if/rtems/basedefs/obfuscate-variable.yml +++ b/spec/if/rtems/basedefs/obfuscate-variable.yml @@ -1,34 +1,34 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -copyrights: -- Copyright (C) 2016, 2018 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | +brief: | Obfuscates the variable so that the compiler cannot perform optimizations based on the variable value. -interface-definition: +copyrights: +- Copyright (C) 2016, 2018 embedded brains GmbH (http://www.embedded-brains.de) +definition: default: | (void) (_var) variants: - definition: | __asm__("" : "+r" (_var)) enabled-by: - - defined(${/if/compiler/gnuc:/interface-name}) -interface-description: | + - defined(${/if/compiler/gnuc:/name}) +description: | The variable must be simple enough to fit into a register. -interface-name: RTEMS_OBFUSCATE_VARIABLE -interface-notes: null -interface-params: -- description: | - is the variable to obfuscate. - dir: null - name: _var -interface-return: - return: null - return-values: [] +enabled-by: true interface-type: macro links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_OBFUSCATE_VARIABLE +notes: null +params: +- description: | + is the variable to obfuscate. + dir: null + name: _var +return: + return: null + return-values: [] type: interface diff --git a/spec/if/rtems/basedefs/packed.yml b/spec/if/rtems/basedefs/packed.yml index 9dde6cb6..91b543da 100644 --- a/spec/if/rtems/basedefs/packed.yml +++ b/spec/if/rtems/basedefs/packed.yml @@ -1,24 +1,24 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -copyrights: -- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | +brief: | Instructs the compiler in a type definition to place members of a structure or union so that the memory required is minimized. -interface-definition: +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: default: '' variants: - definition: | __attribute__((__packed__)) enabled-by: - - defined(${/if/compiler/gnuc:/interface-name}) -interface-description: null -interface-name: RTEMS_PACKED -interface-notes: null + - defined(${/if/compiler/gnuc:/name}) +description: null +enabled-by: true interface-type: define links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_PACKED +notes: null type: interface diff --git a/spec/if/rtems/basedefs/predict-false.yml b/spec/if/rtems/basedefs/predict-false.yml index 332a639a..6ed00a71 100644 --- a/spec/if/rtems/basedefs/predict-false.yml +++ b/spec/if/rtems/basedefs/predict-false.yml @@ -1,33 +1,33 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -copyrights: -- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | +brief: | Returns the value of the specified integral expression and tells the compiler that the predicted value is false (1). -interface-definition: +copyrights: +- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de) +definition: default: | ( _exp ) variants: - definition: | - ${/if/compiler/builtin-expect:/interface-name}( ( _exp ), 0 ) + ${/if/compiler/builtin-expect:/name}( ( _exp ), 0 ) enabled-by: - - defined(${/if/compiler/gnuc:/interface-name}) -interface-description: null -interface-name: RTEMS_PREDICT_FALSE -interface-notes: null -interface-params: -- description: | - is the expression. - dir: null - name: _exp -interface-return: - return: The value of the expression. - return-values: [] + - defined(${/if/compiler/gnuc:/name}) +description: null +enabled-by: true interface-type: macro links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_PREDICT_FALSE +notes: null +params: +- description: | + is the expression. + dir: null + name: _exp +return: + return: The value of the expression. + return-values: [] type: interface diff --git a/spec/if/rtems/basedefs/predict-true.yml b/spec/if/rtems/basedefs/predict-true.yml index b8a1e7d2..e8a3beaa 100644 --- a/spec/if/rtems/basedefs/predict-true.yml +++ b/spec/if/rtems/basedefs/predict-true.yml @@ -1,33 +1,33 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -copyrights: -- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | +brief: | Returns the value of the specified integral expression and tells the compiler that the predicted value is true (1). -interface-definition: +copyrights: +- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de) +definition: default: | ( _exp ) variants: - definition: | - ${/if/compiler/builtin-expect:/interface-name}( ( _exp ), 1 ) + ${/if/compiler/builtin-expect:/name}( ( _exp ), 1 ) enabled-by: - - defined(${/if/compiler/gnuc:/interface-name}) -interface-description: null -interface-name: RTEMS_PREDICT_TRUE -interface-notes: null -interface-params: -- description: | - is the expression. - dir: null - name: _exp -interface-return: - return: The value of the expression. - return-values: [] + - defined(${/if/compiler/gnuc:/name}) +description: null +enabled-by: true interface-type: macro links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_PREDICT_TRUE +notes: null +params: +- description: | + is the expression. + dir: null + name: _exp +return: + return: The value of the expression. + return-values: [] type: interface diff --git a/spec/if/rtems/basedefs/printflike.yml b/spec/if/rtems/basedefs/printflike.yml index e564ce21..90eec733 100644 --- a/spec/if/rtems/basedefs/printflike.yml +++ b/spec/if/rtems/basedefs/printflike.yml @@ -1,21 +1,27 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -copyrights: -- Copyright (C) 2016 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | +brief: | Tells the compiler in a declaration that this function expects printf()-like arguments. -interface-definition: +copyrights: +- Copyright (C) 2016 embedded brains GmbH (http://www.embedded-brains.de) +definition: default: '' variants: - definition: | __attribute__((__format__(__printf__, _format_pos, _ap_pos))) enabled-by: - - defined(${/if/compiler/gnuc:/interface-name}) -interface-description: null -interface-name: RTEMS_PRINTFLIKE -interface-notes: null -interface-params: + - defined(${/if/compiler/gnuc:/name}) +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/basedefs +name: RTEMS_PRINTFLIKE +notes: null +params: - description: | is the position of the format parameter index (starting with one). dir: null @@ -25,13 +31,7 @@ interface-params: one). dir: null name: _ap_pos -interface-return: +return: return: null return-values: [] -interface-type: macro -links: -- role: interface-placement - uid: header -- role: interface-ingroup - uid: /groups/api/basedefs type: interface diff --git a/spec/if/rtems/basedefs/pure.yml b/spec/if/rtems/basedefs/pure.yml index 63f10204..82b2fa13 100644 --- a/spec/if/rtems/basedefs/pure.yml +++ b/spec/if/rtems/basedefs/pure.yml @@ -1,25 +1,25 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -copyrights: -- Copyright (C) 2011 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-brief: | +brief: | Tells the compiler in a function declaration that this function has no effect except the return value and that the return value depends only on the value of parameters and/or global variables. -interface-definition: +copyrights: +- Copyright (C) 2011 On-Line Applications Research Corporation (OAR) +definition: default: '' variants: - definition: | __attribute__((__pure__)) enabled-by: - - defined(${/if/compiler/gnuc:/interface-name}) -interface-description: null -interface-name: RTEMS_PURE -interface-notes: null + - defined(${/if/compiler/gnuc:/name}) +description: null +enabled-by: true interface-type: define links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_PURE +notes: null type: interface diff --git a/spec/if/rtems/basedefs/return-address.yml b/spec/if/rtems/basedefs/return-address.yml index 6302589c..9102f3b6 100644 --- a/spec/if/rtems/basedefs/return-address.yml +++ b/spec/if/rtems/basedefs/return-address.yml @@ -1,27 +1,27 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the return address of the current function. copyrights: - Copyright (C) 2019 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | - Returns the return address of the current function. -interface-definition: - default: ${/if/c/null:/interface-name} +definition: + default: ${/if/c/null:/name} variants: - definition: | - ${/if/compiler/builtin-return-address:/interface-name}(0) + ${/if/compiler/builtin-return-address:/name}(0) enabled-by: - - defined(${/if/compiler/gnuc:/interface-name}) -interface-description: null -interface-name: RTEMS_RETURN_ADDRESS -interface-notes: null -interface-params: [] -interface-return: - return: The return address of the current function. - return-values: [] + - defined(${/if/compiler/gnuc:/name}) +description: null +enabled-by: true interface-type: macro links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_RETURN_ADDRESS +notes: null +params: [] +return: + return: The return address of the current function. + return-values: [] type: interface diff --git a/spec/if/rtems/basedefs/section.yml b/spec/if/rtems/basedefs/section.yml index 00e46544..4f5cc9ad 100644 --- a/spec/if/rtems/basedefs/section.yml +++ b/spec/if/rtems/basedefs/section.yml @@ -1,32 +1,32 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -copyrights: -- Copyright (C) 2015 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | +brief: | Instructs the compiler to place a specific variable or function in the specified section. -interface-definition: +copyrights: +- Copyright (C) 2015 embedded brains GmbH (http://www.embedded-brains.de) +definition: default: '' variants: - definition: | __attribute__((__section__(_section))) enabled-by: - - defined(${/if/compiler/gnuc:/interface-name}) -interface-description: null -interface-name: RTEMS_SECTION -interface-notes: null -interface-params: -- description: | - is the section name as a string. - dir: null - name: _section -interface-return: - return: null - return-values: [] + - defined(${/if/compiler/gnuc:/name}) +description: null +enabled-by: true interface-type: macro links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_SECTION +notes: null +params: +- description: | + is the section name as a string. + dir: null + name: _section +return: + return: null + return-values: [] type: interface diff --git a/spec/if/rtems/basedefs/static-assert.yml b/spec/if/rtems/basedefs/static-assert.yml index c31eafa8..c7950523 100644 --- a/spec/if/rtems/basedefs/static-assert.yml +++ b/spec/if/rtems/basedefs/static-assert.yml @@ -1,10 +1,9 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Asserts at compile time that the specified condition is satisfied. copyrights: - Copyright (C) 2011, 2020 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | - Asserts at compile time that the specified condition is satisfied. -interface-definition: +definition: default: | struct rtems_static_assert_ ## _msg { int rtems_static_assert_ ## _msg : (_cond) ? 1 : -1; } @@ -12,15 +11,22 @@ interface-definition: - definition: | static_assert(_cond, # _msg) enabled-by: - - ${/if/compiler/cplusplus:/interface-name} >= 201103L + - ${/if/compiler/cplusplus:/name} >= 201103L - definition: | _Static_assert(_cond, # _msg) enabled-by: - - ${/if/compiler/stdc-version:/interface-name} >= 201112L -interface-description: null -interface-name: RTEMS_STATIC_ASSERT -interface-notes: null -interface-params: + - ${/if/compiler/stdc-version:/name} >= 201112L +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/basedefs +name: RTEMS_STATIC_ASSERT +notes: null +params: - description: | is the condition this static assertion shall satisfy. dir: null @@ -29,13 +35,7 @@ interface-params: is the error message in case the static assertion fails. dir: null name: _msg -interface-return: +return: return: null return-values: [] -interface-type: macro -links: -- role: interface-placement - uid: header -- role: interface-ingroup - uid: /groups/api/basedefs type: interface diff --git a/spec/if/rtems/basedefs/string.yml b/spec/if/rtems/basedefs/string.yml index ac67e0d2..8fbfa1ef 100644 --- a/spec/if/rtems/basedefs/string.yml +++ b/spec/if/rtems/basedefs/string.yml @@ -1,28 +1,28 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Stringifies _x without expanding. copyrights: - Copyright (C) 2015 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | - Stringifies _x without expanding. -interface-definition: +definition: default: '#_x' variants: [] -interface-description: null -interface-name: RTEMS_STRING -interface-notes: null -interface-params: +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/basedefs +name: RTEMS_STRING +notes: null +params: - description: | is the token to stringify. dir: null name: _x -interface-return: +return: return: | The stringification of the token _x. return-values: [] -interface-type: macro -links: -- role: interface-placement - uid: header -- role: interface-ingroup - uid: /groups/api/basedefs type: interface diff --git a/spec/if/rtems/basedefs/symbol-name.yml b/spec/if/rtems/basedefs/symbol-name.yml index 44b49b04..6e095ad7 100644 --- a/spec/if/rtems/basedefs/symbol-name.yml +++ b/spec/if/rtems/basedefs/symbol-name.yml @@ -1,33 +1,33 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Constructs a symbol name. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | - Constructs a symbol name. -interface-definition: +definition: default: | - ${expand:/interface-name}(_name) + ${expand:/name}(_name) variants: - definition: | - ${xconcat:/interface-name}(${/if/compiler/user-label-prefix:/interface-name}, _name) + ${xconcat:/name}(${/if/compiler/user-label-prefix:/name}, _name) enabled-by: - - defined(${/if/compiler/user-label-prefix:/interface-name}) -interface-description: null -interface-name: RTEMS_SYMBOL_NAME -interface-notes: null -interface-params: + - defined(${/if/compiler/user-label-prefix:/name}) +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/basedefs +name: RTEMS_SYMBOL_NAME +notes: null +params: - description: | is the user defined name of the symbol. The name shall be a valid designator. On the name a macro expansion is performed. dir: null name: _name -interface-return: +return: return: null return-values: [] -interface-type: macro -links: -- role: interface-placement - uid: header -- role: interface-ingroup - uid: /groups/api/basedefs type: interface diff --git a/spec/if/rtems/basedefs/true.yml b/spec/if/rtems/basedefs/true.yml index 8b3ed397..77931f23 100644 --- a/spec/if/rtems/basedefs/true.yml +++ b/spec/if/rtems/basedefs/true.yml @@ -1,19 +1,19 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: If TRUE is undefined, then TRUE is defined to 1. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: -- not: 'TRUE' -interface-brief: If TRUE is undefined, then TRUE is defined to 1. -interface-definition: +definition: default: '1' variants: [] -interface-description: null -interface-name: 'TRUE' -interface-notes: null +description: null +enabled-by: +- not: 'TRUE' interface-type: define links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: 'TRUE' +notes: null type: interface diff --git a/spec/if/rtems/basedefs/typeof-refx.yml b/spec/if/rtems/basedefs/typeof-refx.yml index 00616b9c..15299927 100644 --- a/spec/if/rtems/basedefs/typeof-refx.yml +++ b/spec/if/rtems/basedefs/typeof-refx.yml @@ -1,22 +1,28 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the type of a pointer reference of the specified level to the specified type. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) - Copyright (C) 2014 Paval Pisa -enabled-by: true -interface-brief: | - Returns the type of a pointer reference of the specified level to the specified type. -interface-definition: +definition: default: '' variants: - definition: | - ${/if/compiler/typeof:/interface-name}(_level(union { int z; ${/if/compiler/typeof:/interface-name}(_target) x; }){0}.x) + ${/if/compiler/typeof:/name}(_level(union { int z; ${/if/compiler/typeof:/name}(_target) x; }){0}.x) enabled-by: - - defined(${/if/compiler/gnuc:/interface-name}) -interface-description: | + - defined(${/if/compiler/gnuc:/name}) +description: | The reference type idea is based on libHX by Jan Engelhardt. -interface-name: RTEMS_TYPEOF_REFX -interface-notes: null -interface-params: +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/basedefs +name: RTEMS_TYPEOF_REFX +notes: null +params: - description: | is the pointer indirection level expressed in *. dir: null @@ -25,13 +31,7 @@ interface-params: is the reference target type. dir: null name: _target -interface-return: +return: return: null return-values: [] -interface-type: macro -links: -- role: interface-placement - uid: header -- role: interface-ingroup - uid: /groups/api/basedefs type: interface diff --git a/spec/if/rtems/basedefs/unreachable.yml b/spec/if/rtems/basedefs/unreachable.yml index b2600487..97cbd4ae 100644 --- a/spec/if/rtems/basedefs/unreachable.yml +++ b/spec/if/rtems/basedefs/unreachable.yml @@ -1,29 +1,29 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Tells the compiler that this program point is unreachable. copyrights: - Copyright (C) 2016 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | - Tells the compiler that this program point is unreachable. -interface-definition: +definition: default: | - ${/if/impl/assert-unreachable:/interface-name}() + ${/if/impl/assert-unreachable:/name}() variants: - definition: | do { - ${/if/compiler/builtin-unreachable:/interface-name}(); - ${/if/impl/assert-unreachable:/interface-name}(); + ${/if/compiler/builtin-unreachable:/name}(); + ${/if/impl/assert-unreachable:/name}(); } while ( 0 ) enabled-by: - - defined(${/if/compiler/gnuc:/interface-name}) -interface-description: null -interface-name: RTEMS_UNREACHABLE -interface-notes: null -interface-params: [] -interface-return: - return: null - return-values: [] + - defined(${/if/compiler/gnuc:/name}) +description: null +enabled-by: true interface-type: macro links: - role: interface-placement uid: header +name: RTEMS_UNREACHABLE +notes: null +params: [] +return: + return: null + return-values: [] type: interface diff --git a/spec/if/rtems/basedefs/unused.yml b/spec/if/rtems/basedefs/unused.yml index beef36d5..5c0ae9c4 100644 --- a/spec/if/rtems/basedefs/unused.yml +++ b/spec/if/rtems/basedefs/unused.yml @@ -1,24 +1,24 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -copyrights: -- Copyright (C) 2013 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-brief: | +brief: | Tells the compiler that a specific variable or function is deliberately unused. -interface-definition: +copyrights: +- Copyright (C) 2013 On-Line Applications Research Corporation (OAR) +definition: default: '' variants: - definition: | __attribute__((__unused__)) enabled-by: - - defined(${/if/compiler/gnuc:/interface-name}) -interface-description: null -interface-name: RTEMS_UNUSED -interface-notes: null + - defined(${/if/compiler/gnuc:/name}) +description: null +enabled-by: true interface-type: define links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_UNUSED +notes: null type: interface diff --git a/spec/if/rtems/basedefs/used.yml b/spec/if/rtems/basedefs/used.yml index b2e7e6a1..cac6c57a 100644 --- a/spec/if/rtems/basedefs/used.yml +++ b/spec/if/rtems/basedefs/used.yml @@ -1,23 +1,23 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Tells the compiler that a specific variable or function is used. copyrights: - Copyright (C) 2009 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | - Tells the compiler that a specific variable or function is used. -interface-definition: +definition: default: '' variants: - definition: | __attribute__((__used__)) enabled-by: - - defined(${/if/compiler/gnuc:/interface-name}) -interface-description: null -interface-name: RTEMS_USED -interface-notes: null + - defined(${/if/compiler/gnuc:/name}) +description: null +enabled-by: true interface-type: define links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_USED +notes: null type: interface diff --git a/spec/if/rtems/basedefs/warn-unused-result.yml b/spec/if/rtems/basedefs/warn-unused-result.yml index bb8871d1..85fa2d3a 100644 --- a/spec/if/rtems/basedefs/warn-unused-result.yml +++ b/spec/if/rtems/basedefs/warn-unused-result.yml @@ -1,24 +1,24 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -copyrights: -- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | +brief: | Tells the compiler in a declaration that the result of this function should be used. -interface-definition: +copyrights: +- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de) +definition: default: '' variants: - definition: | __attribute__((__warn_unused_result__)) enabled-by: - - defined(${/if/compiler/gnuc:/interface-name}) -interface-description: null -interface-name: RTEMS_WARN_UNUSED_RESULT -interface-notes: null + - defined(${/if/compiler/gnuc:/name}) +description: null +enabled-by: true interface-type: define links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_WARN_UNUSED_RESULT +notes: null type: interface diff --git a/spec/if/rtems/basedefs/weak-alias.yml b/spec/if/rtems/basedefs/weak-alias.yml index a73108fd..774cee32 100644 --- a/spec/if/rtems/basedefs/weak-alias.yml +++ b/spec/if/rtems/basedefs/weak-alias.yml @@ -1,32 +1,32 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -copyrights: -- Copyright (C) 2017 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | +brief: | Instructs the compiler to generate a weak alias to the specified target function. -interface-definition: +copyrights: +- Copyright (C) 2017 embedded brains GmbH (http://www.embedded-brains.de) +definition: default: '' variants: - definition: | __attribute__((__weak__, __alias__(#_target))) enabled-by: - - defined(${/if/compiler/gnuc:/interface-name}) -interface-description: null -interface-name: RTEMS_WEAK_ALIAS -interface-notes: null -interface-params: -- description: | - is the target function name. - dir: null - name: _target -interface-return: - return: null - return-values: [] + - defined(${/if/compiler/gnuc:/name}) +description: null +enabled-by: true interface-type: macro links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_WEAK_ALIAS +notes: null +params: +- description: | + is the target function name. + dir: null + name: _target +return: + return: null + return-values: [] type: interface diff --git a/spec/if/rtems/basedefs/weak.yml b/spec/if/rtems/basedefs/weak.yml index 9ee84ab6..efb679f4 100644 --- a/spec/if/rtems/basedefs/weak.yml +++ b/spec/if/rtems/basedefs/weak.yml @@ -1,26 +1,26 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -copyrights: -- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | +brief: | Tells the compiler in a function definition that this function should be weak. -interface-definition: +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: default: '' variants: - definition: | __attribute__((__weak__)) enabled-by: - - defined(${/if/compiler/gnuc:/interface-name}) -interface-description: | + - defined(${/if/compiler/gnuc:/name}) +description: | Use this attribute for function definitions. Do not use it for function declarations. -interface-name: RTEMS_WEAK -interface-notes: null +enabled-by: true interface-type: define links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_WEAK +notes: null type: interface diff --git a/spec/if/rtems/basedefs/xconcat.yml b/spec/if/rtems/basedefs/xconcat.yml index 283f531b..1b8b7591 100644 --- a/spec/if/rtems/basedefs/xconcat.yml +++ b/spec/if/rtems/basedefs/xconcat.yml @@ -1,16 +1,22 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Concatenates expansion of _x and expansion of _y. copyrights: - Copyright (C) 2015 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | - Concatenates expansion of _x and expansion of _y. -interface-definition: - default: ${concat:/interface-name}( _x, _y ) +definition: + default: ${concat:/name}( _x, _y ) variants: [] -interface-description: null -interface-name: RTEMS_XCONCAT -interface-notes: null -interface-params: +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/basedefs +name: RTEMS_XCONCAT +notes: null +params: - description: | is expanded first and then used as the left hand side token of the concatenation. @@ -21,14 +27,8 @@ interface-params: concatenation. dir: null name: _y -interface-return: +return: return: | The concatenation of the expansions of tokens _x and _y. return-values: [] -interface-type: macro -links: -- role: interface-placement - uid: header -- role: interface-ingroup - uid: /groups/api/basedefs type: interface diff --git a/spec/if/rtems/basedefs/xstring.yml b/spec/if/rtems/basedefs/xstring.yml index 0593c0a5..0a01ab68 100644 --- a/spec/if/rtems/basedefs/xstring.yml +++ b/spec/if/rtems/basedefs/xstring.yml @@ -1,28 +1,28 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Stringifies the expansion of _x. copyrights: - Copyright (C) 2015 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | - Stringifies the expansion of _x. -interface-definition: - default: ${string:/interface-name}( _x ) +definition: + default: ${string:/name}( _x ) variants: [] -interface-description: null -interface-name: RTEMS_XSTRING -interface-notes: null -interface-params: +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/basedefs +name: RTEMS_XSTRING +notes: null +params: - description: | is the token expand and stringify. dir: null name: _x -interface-return: +return: return: | The stringification of the expansion of token _x. return-values: [] -interface-type: macro -links: -- role: interface-placement - uid: header -- role: interface-ingroup - uid: /groups/api/basedefs type: interface diff --git a/spec/if/rtems/basedefs/zero-length-array.yml b/spec/if/rtems/basedefs/zero-length-array.yml index fc507e6f..2dc6639d 100644 --- a/spec/if/rtems/basedefs/zero-length-array.yml +++ b/spec/if/rtems/basedefs/zero-length-array.yml @@ -1,22 +1,22 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This is a constant to declare zero-length arrays. copyrights: - Copyright (C) 2014 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-brief: | - This is a constant to declare zero-length arrays. -interface-definition: +definition: default: '0' variants: [] -interface-description: | +description: | Zero-length arrays are valid in C99 as flexible array members. C++11 does not allow flexible array members. Use the GNU extension which is also supported by other compilers. -interface-name: RTEMS_ZERO_LENGTH_ARRAY -interface-notes: null +enabled-by: true interface-type: define links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/basedefs +name: RTEMS_ZERO_LENGTH_ARRAY +notes: null type: interface |