summaryrefslogtreecommitdiffstats
path: root/cpukit
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2014-04-16 15:10:10 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2014-04-17 08:06:38 +0200
commit6809383d76966a01ef48642943a910f2c6bb6ea9 (patch)
tree3381fb5334fa34d0508ab8d73ef6651482419fe2 /cpukit
parentsapi: Fix CONFIGURE_UNLIMITED_OBJECTS (diff)
downloadrtems-6809383d76966a01ef48642943a910f2c6bb6ea9.tar.bz2
doc: rtems_get_processor_count()
Diffstat (limited to 'cpukit')
-rw-r--r--cpukit/rtems/include/rtems/rtems/smp.h13
1 files changed, 5 insertions, 8 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/smp.h b/cpukit/rtems/include/rtems/rtems/smp.h
index fa4d5d6e75..aeb0df6f46 100644
--- a/cpukit/rtems/include/rtems/rtems/smp.h
+++ b/cpukit/rtems/include/rtems/rtems/smp.h
@@ -31,9 +31,6 @@ extern "C" {
*
* This encapsulates functionality which is useful for SMP applications.
*
- * This API is also available on uni-processor configurations. Here compile
- * time constants are used whenever possible.
- *
* @{
*/
@@ -43,12 +40,12 @@ extern "C" {
* On uni-processor configurations a value of one will be returned.
*
* On SMP configurations this returns the value of a global variable set during
- * system initialization to indicate the count of processors. The processor
- * count depends on the hardware and application configuration. The value will
- * always be less than or equal to the maximum count of application configured
- * processors.
+ * system initialization to indicate the count of utilized processors. The
+ * processor count depends on the physically or virtually available processors
+ * and application configuration. The value will always be less than or equal
+ * to the maximum count of application configured processors.
*
- * @return The count of processors in the system.
+ * @return The count of processors being utilized.
*/
uint32_t rtems_get_processor_count(void);