diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-05-14 08:29:58 +0200 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-05-28 10:38:23 +0200 |
commit | cae542a3541dc5e34d4cf36bc37967e09d0661e2 (patch) | |
tree | 3a26a37619a4248460e80e0bbaa7e7d90eb05440 /spec/if/rtems/config/get-maximum-processors.yml | |
parent | spec: Add specification of glossary items (diff) | |
download | rtems-central-cae542a3541dc5e34d4cf36bc37967e09d0661e2.tar.bz2 |
spec: Add more interface specification items
Diffstat (limited to 'spec/if/rtems/config/get-maximum-processors.yml')
-rw-r--r-- | spec/if/rtems/config/get-maximum-processors.yml | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/spec/if/rtems/config/get-maximum-processors.yml b/spec/if/rtems/config/get-maximum-processors.yml new file mode 100644 index 00000000..a52a6e23 --- /dev/null +++ b/spec/if/rtems/config/get-maximum-processors.yml @@ -0,0 +1,29 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +enabled-by: true +interface-brief: | + Returns the maximum number of processors which are configured for this + application. +interface-definition: + default: ${/if/impl/smp/processor-configured-maximum:/interface-name} + variants: [] +interface-description: null +interface-name: rtems_configuration_get_maximum_processors +interface-notes: | + The actual number of processors available for the application will be less + than or equal to the configured maximum number of processors. + + On uniprocessor configurations this macro is a compile time constant which + evaluates to one. +interface-params: [] +interface-return: + return: null + return-values: [] +interface-type: macro +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: /groups/api/config +type: interface |