summaryrefslogtreecommitdiffstats
path: root/spec/rtems/config/if/get-maximum-processors.yml
blob: 3b6c3392cb57253ff1982b470f6d0a3b70972b88 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
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 to the application is returned by
  ${../../scheduler/if/get-processor-maximum:/name}.  It will be less than or
  equal to the configured maximum number of processors.

  In uniprocessor configurations, this macro is a compile time constant which
  evaluates to one.
params: []
return:
  return: null
  return-values: []
type: interface