diff options
Diffstat (limited to 'spec/rtems/config')
44 files changed, 1162 insertions, 0 deletions
diff --git a/spec/rtems/config/if/api-table.yml b/spec/rtems/config/if/api-table.yml new file mode 100644 index 00000000..ff00330a --- /dev/null +++ b/spec/rtems/config/if/api-table.yml @@ -0,0 +1,128 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This structure contains a summary of the Classic API configuration. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR) +definition: +- default: + brief: | + This field contains the maximum number of Classic API Tasks which are + configured for this application. + definition: ${/c/if/uint32_t:/name} ${.:name} + description: null + kind: member + name: maximum_tasks + variants: [] +- default: + brief: | + This field indicates if Classic API Notepads are enabled or disabled for + this application. + definition: ${/c/if/bool:/name} ${.:name} + description: null + kind: member + name: notepads_enabled + variants: [] +- default: + brief: | + This field contains the maximum number of Classic API Timers which are + configured for this application. + definition: ${/c/if/uint32_t:/name} ${.:name} + description: null + kind: member + name: maximum_timers + variants: [] +- default: + brief: | + This field contains the maximum number of Classic API Semaphores which + are configured for this application. + definition: ${/c/if/uint32_t:/name} ${.:name} + description: null + kind: member + name: maximum_semaphores + variants: [] +- default: + brief: | + This field contains the maximum number of Classic API Message Queues + which are configured for this application. + definition: ${/c/if/uint32_t:/name} ${.:name} + description: null + kind: member + name: maximum_message_queues + variants: [] +- default: + brief: | + This field contains the maximum number of Classic API Partitions which + are configured for this application. + definition: ${/c/if/uint32_t:/name} ${.:name} + description: null + kind: member + name: maximum_partitions + variants: [] +- default: + brief: | + This field contains the maximum number of Classic API Regions which are + configured for this application. + definition: ${/c/if/uint32_t:/name} ${.:name} + description: null + kind: member + name: maximum_regions + variants: [] +- default: + brief: | + This field contains the maximum number of Classic API Dual Ported Memory + Areas which are configured for this application. + definition: ${/c/if/uint32_t:/name} ${.:name} + description: null + kind: member + name: maximum_ports + variants: [] +- default: + brief: | + This field contains the maximum number of Classic API Rate Monotonic + Periods which are configured for this application. + definition: ${/c/if/uint32_t:/name} ${.:name} + description: null + kind: member + name: maximum_periods + variants: [] +- default: + brief: | + This field contains the maximum number of Classic API Barriers which are + configured for this application. + definition: ${/c/if/uint32_t:/name} ${.:name} + description: null + kind: member + name: maximum_barriers + variants: [] +- default: + brief: | + This field contains the number of Classic API Initialization + Tasks which are configured for this application. + definition: ${/c/if/uint32_t:/name} ${.:name} + description: null + kind: member + name: number_of_initialization_tasks + variants: [] +- default: + brief: | + This field contains the pointer to Classic API Initialization Tasks Table + of this application. + definition: const ${../../task/if/initialization-table:/name} *${.:name} + description: null + kind: member + name: User_initialization_tasks_table + variants: [] +definition-kind: typedef-only +description: | + Use ${get-api-configuration:/name} to get the configuration table. +enabled-by: true +interface-type: struct +links: +- role: interface-placement + uid: header-2 +- role: interface-ingroup + uid: group +name: rtems_api_configuration_table +notes: null +type: interface diff --git a/spec/rtems/config/if/get-api-configuration.yml b/spec/rtems/config/if/get-api-configuration.yml new file mode 100644 index 00000000..c2fbc28a --- /dev/null +++ b/spec/rtems/config/if/get-api-configuration.yml @@ -0,0 +1,26 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the pointer to the Classic API Configuration Table of this application. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: + body: null + params: [] + return: const ${api-table:/name} * + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header-2 +- role: interface-ingroup + uid: group +name: rtems_configuration_get_rtems_api_configuration +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-copyright-notice.yml b/spec/rtems/config/if/get-copyright-notice.yml new file mode 100644 index 00000000..debeaa70 --- /dev/null +++ b/spec/rtems/config/if/get-copyright-notice.yml @@ -0,0 +1,26 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: '%' +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +definition: + default: + body: null + params: [] + return: const char * + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_get_copyright_notice +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-do-zero-of-workspace.yml b/spec/rtems/config/if/get-do-zero-of-workspace.yml new file mode 100644 index 00000000..de1dd018 --- /dev/null +++ b/spec/rtems/config/if/get-do-zero-of-workspace.yml @@ -0,0 +1,24 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns true, if the workspace is zeroed during system initialization, + otherwise returns false. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: ${/score/memory/if/zero-before-use:/name} + variants: [] +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_configuration_get_do_zero_of_workspace +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-idle-task-stack-size.yml b/spec/rtems/config/if/get-idle-task-stack-size.yml new file mode 100644 index 00000000..7920a34d --- /dev/null +++ b/spec/rtems/config/if/get-idle-task-stack-size.yml @@ -0,0 +1,23 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the configured IDLE task stack size in bytes of this application. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: ${/score/thread/if/idle-stack-size:/name} + variants: [] +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_configuration_get_idle_task_stack_size +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-idle-task.yml b/spec/rtems/config/if/get-idle-task.yml new file mode 100644 index 00000000..7b14684d --- /dev/null +++ b/spec/rtems/config/if/get-idle-task.yml @@ -0,0 +1,23 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the configured IDLE task entry of this application. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: ${/score/thread/if/idle-body:/name} + variants: [] +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_configuration_get_idle_task +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-interrupt-stack-size.yml b/spec/rtems/config/if/get-interrupt-stack-size.yml new file mode 100644 index 00000000..78a94c02 --- /dev/null +++ b/spec/rtems/config/if/get-interrupt-stack-size.yml @@ -0,0 +1,23 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the configured interrupt stack size in bytes of this application. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: ((${/c/if/size_t:/name}) ${/score/isr/if/stack-size:/name}) + variants: [] +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_configuration_get_interrupt_stack_size +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-maximum-barriers.yml b/spec/rtems/config/if/get-maximum-barriers.yml new file mode 100644 index 00000000..3536322f --- /dev/null +++ b/spec/rtems/config/if/get-maximum-barriers.yml @@ -0,0 +1,27 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the maximum number of Classic API Barriers which are configured for + this application. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: + body: null + params: [] + return: ${/c/if/uint32_t:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header-2 +- role: interface-ingroup + uid: group +name: rtems_configuration_get_maximum_barriers +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-maximum-extensions.yml b/spec/rtems/config/if/get-maximum-extensions.yml new file mode 100644 index 00000000..0460126b --- /dev/null +++ b/spec/rtems/config/if/get-maximum-extensions.yml @@ -0,0 +1,27 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the maximum number of Classic API User Extensions which are + configured for this application. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: + body: null + params: [] + return: ${/c/if/uint32_t:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_configuration_get_maximum_extensions +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-maximum-message-queues.yml b/spec/rtems/config/if/get-maximum-message-queues.yml new file mode 100644 index 00000000..2d8f3b3b --- /dev/null +++ b/spec/rtems/config/if/get-maximum-message-queues.yml @@ -0,0 +1,27 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the maximum number of Classic API Message Queues which are configured + for this application. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: + body: null + params: [] + return: ${/c/if/uint32_t:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header-2 +- role: interface-ingroup + uid: group +name: rtems_configuration_get_maximum_message_queues +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-maximum-partitions.yml b/spec/rtems/config/if/get-maximum-partitions.yml new file mode 100644 index 00000000..dba034eb --- /dev/null +++ b/spec/rtems/config/if/get-maximum-partitions.yml @@ -0,0 +1,27 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the maximum number of Classic API Partitions which are configured for + this application. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: + body: null + params: [] + return: ${/c/if/uint32_t:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header-2 +- role: interface-ingroup + uid: group +name: rtems_configuration_get_maximum_partitions +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-maximum-periods.yml b/spec/rtems/config/if/get-maximum-periods.yml new file mode 100644 index 00000000..418ec2cc --- /dev/null +++ b/spec/rtems/config/if/get-maximum-periods.yml @@ -0,0 +1,27 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the maximum number of Classic API Rate Monotonic Periods which are + configured for this application. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: + body: null + params: [] + return: ${/c/if/uint32_t:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header-2 +- role: interface-ingroup + uid: group +name: rtems_configuration_get_maximum_periods +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-maximum-ports.yml b/spec/rtems/config/if/get-maximum-ports.yml new file mode 100644 index 00000000..c8dff653 --- /dev/null +++ b/spec/rtems/config/if/get-maximum-ports.yml @@ -0,0 +1,27 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the maximum number of Classic API Dual Ported Memory Areas which are + configured for this application. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: + body: null + params: [] + return: ${/c/if/uint32_t:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header-2 +- role: interface-ingroup + uid: group +name: rtems_configuration_get_maximum_ports +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-maximum-processors.yml b/spec/rtems/config/if/get-maximum-processors.yml new file mode 100644 index 00000000..6fb3bfe0 --- /dev/null +++ b/spec/rtems/config/if/get-maximum-processors.yml @@ -0,0 +1,29 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the maximum number of processors which are configured for this + application. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: ${/score/smp/if/processor-configured-maximum:/name} + variants: [] +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_configuration_get_maximum_processors +notes: | + The actual number of processors available for the application will be less + than or equal to the configured maximum number of processors. + + On uniprocessor configurations this macro is a compile time constant which + evaluates to one. +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-maximum-regions.yml b/spec/rtems/config/if/get-maximum-regions.yml new file mode 100644 index 00000000..0334c6f9 --- /dev/null +++ b/spec/rtems/config/if/get-maximum-regions.yml @@ -0,0 +1,27 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the maximum number of Classic API Regions which are configured for + this application. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: + body: null + params: [] + return: ${/c/if/uint32_t:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header-2 +- role: interface-ingroup + uid: group +name: rtems_configuration_get_maximum_regions +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-maximum-semaphores.yml b/spec/rtems/config/if/get-maximum-semaphores.yml new file mode 100644 index 00000000..88abdb0e --- /dev/null +++ b/spec/rtems/config/if/get-maximum-semaphores.yml @@ -0,0 +1,27 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the maximum number of Classic API Semaphores which are configured for + this application. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: + body: null + params: [] + return: ${/c/if/uint32_t:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header-2 +- role: interface-ingroup + uid: group +name: rtems_configuration_get_maximum_semaphores +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-maximum-tasks.yml b/spec/rtems/config/if/get-maximum-tasks.yml new file mode 100644 index 00000000..ad62a40a --- /dev/null +++ b/spec/rtems/config/if/get-maximum-tasks.yml @@ -0,0 +1,27 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the maximum number of Classic API Tasks which are configured for this + application. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: + body: null + params: [] + return: ${/c/if/uint32_t:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header-2 +- role: interface-ingroup + uid: group +name: rtems_configuration_get_maximum_tasks +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-maximum-timers.yml b/spec/rtems/config/if/get-maximum-timers.yml new file mode 100644 index 00000000..a65cbeba --- /dev/null +++ b/spec/rtems/config/if/get-maximum-timers.yml @@ -0,0 +1,27 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the maximum number of Classic API Timers which are configured for + this application. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: + body: null + params: [] + return: ${/c/if/uint32_t:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header-2 +- role: interface-ingroup + uid: group +name: rtems_configuration_get_maximum_timers +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-microseconds-per-tick.yml b/spec/rtems/config/if/get-microseconds-per-tick.yml new file mode 100644 index 00000000..7c4d8765 --- /dev/null +++ b/spec/rtems/config/if/get-microseconds-per-tick.yml @@ -0,0 +1,23 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the number of microseconds per tick configured for this application. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: ${/score/watchdog/if/microseconds-per-tick:/name} + variants: [] +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_configuration_get_microseconds_per_tick +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-milliseconds-per-tick.yml b/spec/rtems/config/if/get-milliseconds-per-tick.yml new file mode 100644 index 00000000..a0c4e42a --- /dev/null +++ b/spec/rtems/config/if/get-milliseconds-per-tick.yml @@ -0,0 +1,23 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the number of milliseconds per tick configured for this application. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: (${/score/watchdog/if/microseconds-per-tick:/name} / 1000) + variants: [] +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_configuration_get_milliseconds_per_tick +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-nanoseconds-per-tick.yml b/spec/rtems/config/if/get-nanoseconds-per-tick.yml new file mode 100644 index 00000000..2cd6d4b5 --- /dev/null +++ b/spec/rtems/config/if/get-nanoseconds-per-tick.yml @@ -0,0 +1,23 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the number of microseconds per tick configured for this application. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: ${/score/watchdog/if/nanoseconds-per-tick:/name} + variants: [] +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_configuration_get_nanoseconds_per_tick +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-number-of-initial-extensions.yml b/spec/rtems/config/if/get-number-of-initial-extensions.yml new file mode 100644 index 00000000..bee483bd --- /dev/null +++ b/spec/rtems/config/if/get-number-of-initial-extensions.yml @@ -0,0 +1,23 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the number of initial extensions configured for this application. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: ((${/c/if/uint32_t:/name}) ${/score/userext/if/initial-count:/name}) + variants: [] +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_configuration_get_number_of_initial_extensions +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-stack-allocate-hook.yml b/spec/rtems/config/if/get-stack-allocate-hook.yml new file mode 100644 index 00000000..4e02dcf9 --- /dev/null +++ b/spec/rtems/config/if/get-stack-allocate-hook.yml @@ -0,0 +1,23 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the thread stack allocator allocate hook. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: ${/score/stack/if/allocator-allocate:/name} + variants: [] +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_configuration_get_stack_allocate_hook +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-stack-allocate-init-hook.yml b/spec/rtems/config/if/get-stack-allocate-init-hook.yml new file mode 100644 index 00000000..dcdc6b8f --- /dev/null +++ b/spec/rtems/config/if/get-stack-allocate-init-hook.yml @@ -0,0 +1,23 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the thread stack allocator initialization hook. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: ${/score/stack/if/allocator-initialize:/name} + variants: [] +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_configuration_get_stack_allocate_init_hook +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-stack-allocator-avoids-work-space.yml b/spec/rtems/config/if/get-stack-allocator-avoids-work-space.yml new file mode 100644 index 00000000..106cca32 --- /dev/null +++ b/spec/rtems/config/if/get-stack-allocator-avoids-work-space.yml @@ -0,0 +1,24 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns true, if the thread stack allocator avoids the workspace, otherwise + returns false. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: ${/score/stack/if/allocator-avoids-workspace:/name} + variants: [] +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_configuration_get_stack_allocator_avoids_work_space +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-stack-free-hook.yml b/spec/rtems/config/if/get-stack-free-hook.yml new file mode 100644 index 00000000..57edf34b --- /dev/null +++ b/spec/rtems/config/if/get-stack-free-hook.yml @@ -0,0 +1,23 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the thread stack allocator free hook. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: ${/score/stack/if/allocator-free:/name} + variants: [] +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_configuration_get_stack_free_hook +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-stack-space-size.yml b/spec/rtems/config/if/get-stack-space-size.yml new file mode 100644 index 00000000..8f8e6ebd --- /dev/null +++ b/spec/rtems/config/if/get-stack-space-size.yml @@ -0,0 +1,27 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the thread stack space size in bytes of configured for this + application. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: + body: null + params: [] + return: ${/c/if/uintptr_t:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_configuration_get_stack_space_size +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-ticks-per-timeslice.yml b/spec/rtems/config/if/get-ticks-per-timeslice.yml new file mode 100644 index 00000000..8011de74 --- /dev/null +++ b/spec/rtems/config/if/get-ticks-per-timeslice.yml @@ -0,0 +1,23 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the ticks per timeslice configured for this application. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: ${/score/watchdog/if/ticks-per-timeslice:/name} + variants: [] +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_configuration_get_ticks_per_timeslice +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-unified-work-area.yml b/spec/rtems/config/if/get-unified-work-area.yml new file mode 100644 index 00000000..ced59175 --- /dev/null +++ b/spec/rtems/config/if/get-unified-work-area.yml @@ -0,0 +1,24 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns true, if the RTEMS Workspace and C Program Heap are unified, + otherwise returns false. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: ${/score/wkspace/if/is-unified:/name} + variants: [] +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_configuration_get_unified_work_area +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-user-extension-table.yml b/spec/rtems/config/if/get-user-extension-table.yml new file mode 100644 index 00000000..a6c3dd09 --- /dev/null +++ b/spec/rtems/config/if/get-user-extension-table.yml @@ -0,0 +1,24 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the pointer to the initial extensions table configured for this + application. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: ${/score/userext/if/initial-extensions:/name} + variants: [] +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_configuration_get_user_extension_table +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-user-multiprocessing-table.yml b/spec/rtems/config/if/get-user-multiprocessing-table.yml new file mode 100644 index 00000000..41ed5f9f --- /dev/null +++ b/spec/rtems/config/if/get-user-multiprocessing-table.yml @@ -0,0 +1,26 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the pointer to the MPCI configuration table configured for this + application. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: ${/c/if/null:/name} + variants: + - definition: ( &${/score/mpci/if/configuration:/name} ) + enabled-by: defined(${/build-options/if/multiprocessing:/name}) +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_configuration_get_user_multiprocessing_table +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-version-string.yml b/spec/rtems/config/if/get-version-string.yml new file mode 100644 index 00000000..2cca0f6a --- /dev/null +++ b/spec/rtems/config/if/get-version-string.yml @@ -0,0 +1,26 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: '%' +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +definition: + default: + body: null + params: [] + return: const char * + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_get_version_string +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/get-work-space-size.yml b/spec/rtems/config/if/get-work-space-size.yml new file mode 100644 index 00000000..535bd5fa --- /dev/null +++ b/spec/rtems/config/if/get-work-space-size.yml @@ -0,0 +1,26 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the RTEMS Workspace size in bytes configured for this application. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: | + (${/score/wkspace/if/size:/name} + + (${get-stack-allocator-avoids-work-space:/name}() ? + 0 : ${get-stack-space-size:/name}())) + variants: [] +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_configuration_get_work_space_size +notes: null +params: [] +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/group.yml b/spec/rtems/config/if/group.yml new file mode 100644 index 00000000..21c46cd8 --- /dev/null +++ b/spec/rtems/config/if/group.yml @@ -0,0 +1,19 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This group contains defines and macros to create an application configuration + as well as functions to get values of the application configuration. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +description: null +enabled-by: true +identifier: RTEMSAPIConfig +interface-type: group +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /if/api +name: Application Configuration +text: | + The API shall provide an interface to the application configuration. +type: interface diff --git a/spec/rtems/config/if/has-hardware-fp.yml b/spec/rtems/config/if/has-hardware-fp.yml new file mode 100644 index 00000000..b22d880c --- /dev/null +++ b/spec/rtems/config/if/has-hardware-fp.yml @@ -0,0 +1,19 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: '%' +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +definition: + default: ${/score/cpu/if/hardware-fp:/name} + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_HAS_HARDWARE_FP +notes: null +type: interface diff --git a/spec/rtems/config/if/header-2.yml b/spec/rtems/config/if/header-2.yml new file mode 100644 index 00000000..1c735809 --- /dev/null +++ b/spec/rtems/config/if/header-2.yml @@ -0,0 +1,14 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This header file defines parts of the application configuration information + API. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +enabled-by: true +interface-type: header-file +links: +- role: interface-placement + uid: /if/domain +path: rtems/rtems/config.h +prefix: cpukit/include +type: interface diff --git a/spec/rtems/config/if/header.yml b/spec/rtems/config/if/header.yml new file mode 100644 index 00000000..5ccaeaa3 --- /dev/null +++ b/spec/rtems/config/if/header.yml @@ -0,0 +1,23 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This header file defines parts of the application configuration information + API. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +enabled-by: true +interface-type: header-file +links: +- enabled-by: RTEMS_MULTIPROCESSING + role: interface-include + uid: /score/mpci/if/header +- enabled-by: RTEMS_MULTIPROCESSING + role: interface-include + uid: ../../type/if/header +- enabled-by: true + role: interface-include + uid: header-2 +- role: interface-placement + uid: /if/domain +path: rtems/config.h +prefix: cpukit/include +type: interface diff --git a/spec/rtems/config/if/resource-is-unlimited.yml b/spec/rtems/config/if/resource-is-unlimited.yml new file mode 100644 index 00000000..29c5448e --- /dev/null +++ b/spec/rtems/config/if/resource-is-unlimited.yml @@ -0,0 +1,26 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns true, if the resource is unlimited, otherwise returns false. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: ${/score/object/if/is-unlimited:/name}(${.:/params[0]/name}) + variants: [] +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_resource_is_unlimited +notes: null +params: +- description: is the resource number. + dir: null + name: _resource +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/resource-maximum-per-allocation.yml b/spec/rtems/config/if/resource-maximum-per-allocation.yml new file mode 100644 index 00000000..4fbbd13f --- /dev/null +++ b/spec/rtems/config/if/resource-maximum-per-allocation.yml @@ -0,0 +1,26 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the resource maximum number per allocation. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: ${/score/object/if/maximum-per-allocation:/name}(${.:/params[0]/name}) + variants: [] +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_resource_maximum_per_allocation +notes: null +params: +- description: is the resource number. + dir: null + name: _resource +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/resource-unlimited.yml b/spec/rtems/config/if/resource-unlimited.yml new file mode 100644 index 00000000..56661ec9 --- /dev/null +++ b/spec/rtems/config/if/resource-unlimited.yml @@ -0,0 +1,26 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Returns the specified resource number configured for unlimited resources. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: ((${.:/params[0]/name}) | ${unlimited-objects:/name}) + variants: [] +description: null +enabled-by: true +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_resource_unlimited +notes: null +params: +- description: is the resource number. + dir: null + name: _resource +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/config/if/stack-allocate-hook.yml b/spec/rtems/config/if/stack-allocate-hook.yml new file mode 100644 index 00000000..697d7c2c --- /dev/null +++ b/spec/rtems/config/if/stack-allocate-hook.yml @@ -0,0 +1,19 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + The thread stack allocator allocate handler. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: ${/score/stack/if/allocator-allocate-type:/name} ${.:/name} + variants: [] +description: null +enabled-by: true +interface-type: typedef +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_stack_allocate_hook +notes: null +type: interface diff --git a/spec/rtems/config/if/stack-allocate-init-hook.yml b/spec/rtems/config/if/stack-allocate-init-hook.yml new file mode 100644 index 00000000..15664afb --- /dev/null +++ b/spec/rtems/config/if/stack-allocate-init-hook.yml @@ -0,0 +1,19 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + The thread stack allocator initialization handler. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: ${/score/stack/if/allocator-initialize-type:/name} ${.:/name} + variants: [] +description: null +enabled-by: true +interface-type: typedef +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_stack_allocate_init_hook +notes: null +type: interface diff --git a/spec/rtems/config/if/stack-free-hook.yml b/spec/rtems/config/if/stack-free-hook.yml new file mode 100644 index 00000000..2156b9f4 --- /dev/null +++ b/spec/rtems/config/if/stack-free-hook.yml @@ -0,0 +1,19 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + The thread stack allocator free handler. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: ${/score/stack/if/allocator-free-type:/name} ${.:/name} + variants: [] +description: null +enabled-by: true +interface-type: typedef +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_stack_free_hook +notes: null +type: interface diff --git a/spec/rtems/config/if/unlimited-objects.yml b/spec/rtems/config/if/unlimited-objects.yml new file mode 100644 index 00000000..c7b697b5 --- /dev/null +++ b/spec/rtems/config/if/unlimited-objects.yml @@ -0,0 +1,19 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + This flag is used in resource numbers to indicate an unlimited resource. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: ${/score/object/if/unlimited-objects:/name} + variants: [] +description: null +enabled-by: true +interface-type: define +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: RTEMS_UNLIMITED_OBJECTS +notes: null +type: interface |