summaryrefslogtreecommitdiffstats
path: root/c-user/symmetric_multiprocessing_services.rst
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2017-09-14 10:32:28 +1000
committerChris Johns <chrisj@rtems.org>2017-09-14 10:32:28 +1000
commit794eb1b786995b1aa18a1af15d4e6966f16ae8c4 (patch)
treeb29f2f1a4566e88344c513ddb6f7b3a16b0f0118 /c-user/symmetric_multiprocessing_services.rst
parentAdd PAX to the Ubuntu packages to install. (diff)
downloadrtems-docs-794eb1b786995b1aa18a1af15d4e6966f16ae8c4.tar.bz2
c-user: Clarify SMP's rtems_get_processor_count.
Diffstat (limited to 'c-user/symmetric_multiprocessing_services.rst')
-rw-r--r--c-user/symmetric_multiprocessing_services.rst5
1 files changed, 4 insertions, 1 deletions
diff --git a/c-user/symmetric_multiprocessing_services.rst b/c-user/symmetric_multiprocessing_services.rst
index 16005f3..930be83 100644
--- a/c-user/symmetric_multiprocessing_services.rst
+++ b/c-user/symmetric_multiprocessing_services.rst
@@ -510,7 +510,10 @@ CALLING SEQUENCE:
uint32_t rtems_get_processor_count(void);
DIRECTIVE STATUS CODES:
- The count of processors in the system.
+
+ The count of processors in the system that can be run. The value returned
+ is the highest numbered processor index of all processors available to the
+ application (if a scheduler is assigned) plus one.
DESCRIPTION:
In uni-processor configurations, a value of one will be returned.