Changeset 2be51cc in rtems


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

doc: rtems_task_get_affinity()

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/user/smp.t

    r4a93980 r2be51cc  
    1717@item @code{rtems_get_processor_count} - Get processor count
    1818@item @code{rtems_get_current_processor} - Get current processor index
    19 @item @code{rtems_task_get_affinity} - Obtain Task Affinity
     19@item @code{rtems_task_get_affinity} - Get task processor affinity
    2020@item @code{rtems_task_set_affinity} - Set Task Affinity
    2121@end itemize
     
    301301@c
    302302@page
    303 @subsection rtems_task_get_affinity - Obtain Task Affinity
     303@subsection TASK_GET_AFFINITY - Get task processor affinity
    304304
    305305@subheading CALLING SEQUENCE:
     
    307307@ifset is-C
    308308@example
    309 #include <rtems.h>
    310 
    311309rtems_status_code rtems_task_get_affinity(
    312   rtems_id             id,
    313   size_t               cpusetsize,
    314   cpu_set_t           *cpuset
     310  rtems_id   id,
     311  size_t     cpusetsize,
     312  cpu_set_t *cpuset
    315313);
    316314@end example
     
    320318@end ifset
    321319
    322 @subheading STATUS CODES:
    323 
    324 @table @b
    325 @item RTEMS_UNSATISFIED
    326 The @code{cpuset} pointer argument is invalid.
    327 
    328 @item RTEMS_UNSATISFIED
    329 The @code{cpusetsize} does not match the value of @code{affinitysetsize}
    330 field in the thread attribute object.
    331 
    332 @item RTEMS_INVALID_ID
    333 The @code{id} is invalid.
    334 
    335 @end table
     320@subheading DIRECTIVE STATUS CODES:
     321
     322@code{@value{RPREFIX}SUCCESSFUL} - successful operation@*
     323@code{@value{RPREFIX}INVALID_ADDRESS} - @code{cpuset} is NULL@*
     324@code{@value{RPREFIX}INVALID_ID} - invalid task id@*
     325@code{@value{RPREFIX}INVALID_NUMBER} - the affinity set buffer is too small for
     326the current processor affinity set of the task
    336327
    337328@subheading DESCRIPTION:
    338329
    339 The @code{rtems_task_get_affinity} routine is used to obtain the
    340 @code{affinityset} field from the thread object @code{id}.
    341 The value of this field is returned in @code{cpuset}
     330Returns the current processor affinity set of the task in @code{cpuset}.  A set
     331bit in the affinity set means that the task can execute on this processor and a
     332cleared bit means the opposite.
    342333
    343334@subheading NOTES:
    344335
    345 NONE
     336None.
    346337
    347338@c
Note: See TracChangeset for help on using the changeset viewer.