---
doc/user/smp.t | 37 ++++++++++++++-----------------------
1 files changed, 14 insertions(+), 23 deletions(-)
diff --git a/doc/user/smp.t b/doc/user/smp.t
index 3d565ef..649aaf1 100644
--- a/doc/user/smp.t
+++ b/doc/user/smp.t
@@ -299,18 +299,16 @@ None.
@c rtems_task_get_affinity
@c
@page
-@subsection rtems_task_get_affinity - Obtain Task Affinity
+@subsection TASK_GET_AFFINITY - Get task processor affinity
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-#include <rtems.h>
-
rtems_status_code rtems_task_get_affinity(
- rtems_id id,
- size_t cpusetsize,
- cpu_set_t *cpuset
+ rtems_id id,
+ size_t cpusetsize,
+ cpu_set_t *cpuset
);
@end example
@end ifset
@@ -318,30 +316,23 @@ rtems_status_code rtems_task_get_affinity(
@ifset is-Ada
@end ifset
-@subheading STATUS CODES:
-
-@table @b
-@item RTEMS_UNSATISFIED
-The @code{cpuset} pointer argument is invalid.
-
-@item RTEMS_UNSATISFIED
-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.
+@subheading DIRECTIVE STATUS CODES:
-@end table
+@code{@value{RPREFIX}SUCCESSFUL} - successful operation@*
+@code{@value{RPREFIX}INVALID_ADDRESS} - @code{cpuset} is NULL@*
+@code{@value{RPREFIX}INVALID_ID} - invalid task id@*
+@code{@value{RPREFIX}INVALID_NUMBER} - the affinity set buffer is too small for
+the current processor affinity set of the task
@subheading DESCRIPTION:
-The @code{rtems_task_get_affinity} routine is used to obtain the
-@code{affinityset} field from the thread object @code{id}.
-The value of this field is returned in @code{cpuset}
+Returns the current processor affinity set of the task in @code{cpuset}. A set
+bit in the affinity set means that the task can execute on this processor and a
+cleared bit means the opposite.
@subheading NOTES:
-NONE
+None.
@c
@c rtems_task_set_affinity
--
1.7.7
_______________________________________________
rtems-devel mailing list
[email protected]
http://www.rtems.org/mailman/listinfo/rtems-devel
