Changeset ed859d51 in rtems


Ignore:
Timestamp:
Apr 16, 2014, 1:39:34 PM (5 years ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
4.11, master
Children:
89c1a21
Parents:
2be51cc
git-author:
Sebastian Huber <sebastian.huber@…> (04/16/14 13:39:34)
git-committer:
Sebastian Huber <sebastian.huber@…> (04/17/14 06:06:38)
Message:

doc: rtems_task_set_affinity()

Location:
doc/user
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • doc/user/Makefile.am

    r2be51cc red859d51  
    170170
    171171stackchk.texi: stackchk.t
    172         $(BMENU2) -p "Symmetric Multiprocessing Services rtems_task_set_affinity - Set Task Affinity" \
     172        $(BMENU2) -p "Symmetric Multiprocessing Services TASK_SET_AFFINITY - Set task processor affinity" \
    173173            -u "Top" \
    174174            -n "CPU Usage Statistics" < $< > $@
  • doc/user/smp.t

    r2be51cc red859d51  
    1818@item @code{rtems_get_current_processor} - Get current processor index
    1919@item @code{rtems_task_get_affinity} - Get task processor affinity
    20 @item @code{rtems_task_set_affinity} - Set Task Affinity
     20@item @code{rtems_task_set_affinity} - Set task processor affinity
    2121@end itemize
    2222
     
    340340@c
    341341@page
    342 @subsection rtems_task_set_affinity - Set Task Affinity
     342@subsection TASK_SET_AFFINITY - Set task processor affinity
    343343
    344344@subheading CALLING SEQUENCE:
     
    346346@ifset is-C
    347347@example
    348 #include <rtems.h>
    349 
    350348rtems_status_code rtems_task_set_affinity(
    351   rtems_id             id,
    352   size_t               cpusetsize,
    353   cpu_set_t          *cpuset
     349  rtems_id         id,
     350  size_t           cpusetsize,
     351  const cpu_set_t *cpuset
    354352);
    355353@end example
     
    359357@end ifset
    360358
    361 @subheading STATUS CODES:
    362 
    363 @table @b
    364 @item RTEMS_UNSATISFIED
    365 The @code{cpuset} pointer argument is invalid.
    366 
    367 @item RTEMS_UNSATISFIED
    368 The @code{cpusetsize} does not match the value of @code{affinitysetsize}
    369 field in the thread attribute object.
    370 
    371 @item RTEMS_UNSATISFIED
    372 The @code{cpuset} did not select a valid cpu.
    373 
    374 @item RTEMS_UNSATISFIED
    375 The @code{cpuset} selected a cpu that was invalid.
    376 
    377 @item RTEMS_INVALID_ID
    378 The @code{id} is invalid.
    379 
    380 @end table
     359@subheading DIRECTIVE STATUS CODES:
     360
     361@code{@value{RPREFIX}SUCCESSFUL} - successful operation@*
     362@code{@value{RPREFIX}INVALID_ADDRESS} - @code{cpuset} is NULL@*
     363@code{@value{RPREFIX}INVALID_ID} - invalid task id@*
     364@code{@value{RPREFIX}INVALID_NUMBER} - invalid processor affinity set
    381365
    382366@subheading DESCRIPTION:
    383367
    384 The @code{rtems_task_set_affinity} routine is used to set the
    385 @code{affinity.set} field of the thread control object associated
    386 with @code{id}.  This value controls the @code{cpuset} that the task can
    387 execute on.
     368Sets the processor affinity set for the task specified by @code{cpuset}.  A set
     369bit in the affinity set means that the task can execute on this processor and a
     370cleared bit means the opposite.
    388371
    389372@subheading NOTES:
    390373
    391 NONE
     374None.
Note: See TracChangeset for help on using the changeset viewer.