RTOS/rtems
1
0
Fork 0
forked from Imagelibrary/rtems
Code Pull Requests Activity

doc: rtems_task_get_affinity()

Browse Source
This commit is contained in:
Sebastian Huber
2014-04-16 15:25:42 +02:00
parent 4a93980a14
commit 2be51ccf6e
1 changed files with 15 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
doc/user/smp.t
View File

@@ -16,7 +16,7 @@ The application level services currently provided are:
@itemize @bullet @itemize @bullet
@item @code{rtems_get_processor_count} - Get processor count @item @code{rtems_get_processor_count} - Get processor count
@item @code{rtems_get_current_processor} - Get current processor index @item @code{rtems_get_current_processor} - Get current processor index
@item @code{rtems_task_get_affinity} - Obtain Task Affinity @item @code{rtems_task_get_affinity} - Get task processor affinity
@item @code{rtems_task_set_affinity} - Set Task Affinity @item @code{rtems_task_set_affinity} - Set Task Affinity
@end itemize @end itemize
@@ -300,14 +300,12 @@ None.
@c rtems_task_get_affinity @c rtems_task_get_affinity
@c @c
@page @page
@subsection rtems_task_get_affinity - Obtain Task Affinity @subsection TASK_GET_AFFINITY - Get task processor affinity
@subheading CALLING SEQUENCE: @subheading CALLING SEQUENCE:
@ifset is-C @ifset is-C
@example @example
#include <rtems.h>
rtems_status_code rtems_task_get_affinity( rtems_status_code rtems_task_get_affinity(
rtems_id id, rtems_id id,
size_t cpusetsize, size_t cpusetsize,
@@ -319,30 +317,23 @@ rtems_status_code rtems_task_get_affinity(
@ifset is-Ada @ifset is-Ada
@end ifset @end ifset
@subheading STATUS CODES: @subheading DIRECTIVE STATUS CODES:
@table @b @code{@value{RPREFIX}SUCCESSFUL} - successful operation@*
@item RTEMS_UNSATISFIED @code{@value{RPREFIX}INVALID_ADDRESS} - @code{cpuset} is NULL@*
The @code{cpuset} pointer argument is invalid. @code{@value{RPREFIX}INVALID_ID} - invalid task id@*
@code{@value{RPREFIX}INVALID_NUMBER} - the affinity set buffer is too small for
@item RTEMS_UNSATISFIED the current processor affinity set of the task
The @code{cpusetsize} does not match the value of @code{affinitysetsize}
field in the thread attribute object.
@item RTEMS_INVALID_ID
The @code{id} is invalid.
@end table
@subheading DESCRIPTION: @subheading DESCRIPTION:
The @code{rtems_task_get_affinity} routine is used to obtain the Returns the current processor affinity set of the task in @code{cpuset}. A set
@code{affinityset} field from the thread object @code{id}. bit in the affinity set means that the task can execute on this processor and a
The value of this field is returned in @code{cpuset} cleared bit means the opposite.
@subheading NOTES: @subheading NOTES:
NONE None.
@c @c
@c rtems_task_set_affinity @c rtems_task_set_affinity