summaryrefslogtreecommitdiffstats
path: root/spec/rtems/config/if/get-maximum-processors.yml
diff options
context:
space:
mode:
Diffstat (limited to 'spec/rtems/config/if/get-maximum-processors.yml')
-rw-r--r--spec/rtems/config/if/get-maximum-processors.yml29
1 files changed, 29 insertions, 0 deletions
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