Changeset 6809383d in rtems


Ignore:
Timestamp:
Apr 16, 2014, 1:10:10 PM (5 years ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
4.11, master
Children:
4a93980
Parents:
0e98970
git-author:
Sebastian Huber <sebastian.huber@…> (04/16/14 13:10:10)
git-committer:
Sebastian Huber <sebastian.huber@…> (04/17/14 06:06:38)
Message:

doc: rtems_get_processor_count()

Files:
2 edited

Legend:

Unmodified
Added
Removed
  • cpukit/rtems/include/rtems/rtems/smp.h

    r0e98970 r6809383d  
    3232 * This encapsulates functionality which is useful for SMP applications.
    3333 *
    34  * This API is also available on uni-processor configurations.  Here compile
    35  * time constants are used whenever possible.
    36  *
    3734 * @{
    3835 */
     
    4441 *
    4542 * On SMP configurations this returns the value of a global variable set during
    46  * system initialization to indicate the count of processors.  The processor
    47  * count depends on the hardware and application configuration.  The value will
    48  * always be less than or equal to the maximum count of application configured
    49  * processors.
     43 * system initialization to indicate the count of utilized processors.  The
     44 * processor count depends on the physically or virtually available processors
     45 * and application configuration.  The value will always be less than or equal
     46 * to the maximum count of application configured processors.
    5047 *
    51  * @return The count of processors in the system.
     48 * @return The count of processors being utilized.
    5249 */
    5350uint32_t rtems_get_processor_count(void);
  • doc/user/smp.t

    r0e98970 r6809383d  
    1515
    1616@itemize @bullet
    17 @item @code{rtems_smp_get_processor_count} - Obtain Number of CPUs
     17@item @code{rtems_get_processor_count} - Get processor count
    1818@item @code{rtems_task_get_affinity} - Obtain Task Affinity
    1919@item @code{rtems_task_set_affinity} - Set Task Affinity
     
    224224
    225225@c
    226 @c rtems_smp_get_processor_count
     226@c rtems_get_processor_count
    227227@c
    228228@page
    229 @subsection rtems_smp_get_processor_count - Obtain Number of CPUs
     229@subsection GET_PROCESSOR_COUNT - Get processor count
    230230
    231231@subheading CALLING SEQUENCE:
     
    233233@ifset is-C
    234234@example
    235 #include <rtems.h>
    236 
    237 int rtems_smp_get_processor_count(void);
     235uint32_t rtems_get_processor_count(void);
    238236@end example
    239237@end ifset
     
    242240@end ifset
    243241
    244 @subheading STATUS CODES:
    245 
    246 Returns the number of processors being utilized.
     242@subheading DIRECTIVE STATUS CODES:
     243
     244The count of processors in the system.
    247245
    248246@subheading DESCRIPTION:
    249247
    250 The @code{rtems_smp_get_processor_count} routine is used to obtain the
    251 number of processor cores being utilized.
     248On uni-processor configurations a value of one will be returned.
     249
     250On SMP configurations this returns the value of a global variable set during
     251system initialization to indicate the count of utilized processors.  The
     252processor count depends on the physically or virtually available processors and
     253application configuration.  The value will always be less than or equal to the
     254maximum count of application configured processors.
    252255
    253256@subheading NOTES:
    254257
    255 NONE
     258None.
    256259
    257260@c
Note: See TracChangeset for help on using the changeset viewer.