summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/include/rtems/rtems/tasks.h
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2014-05-28 18:11:51 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2014-06-02 08:28:42 +0200
commit25f5730fe515911e42591f66294baff0369d9883 (patch)
treea6ab2d7c98499ec959d4272a2ec9bd6069589e09 /cpukit/rtems/include/rtems/rtems/tasks.h
parentscore: _Scheduler_Get_affinity() (diff)
downloadrtems-25f5730fe515911e42591f66294baff0369d9883.tar.bz2
score: _Scheduler_Set_affinity()
Do not change the scheduler with this function. Documentation. Coding style.
Diffstat (limited to '')
-rw-r--r--cpukit/rtems/include/rtems/rtems/tasks.h11
1 files changed, 11 insertions, 0 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/tasks.h b/cpukit/rtems/include/rtems/rtems/tasks.h
index 76653fd7c4..e0fa27e16f 100644
--- a/cpukit/rtems/include/rtems/rtems/tasks.h
+++ b/cpukit/rtems/include/rtems/rtems/tasks.h
@@ -521,6 +521,17 @@ rtems_status_code rtems_task_get_affinity(
/**
* @brief Sets the processor affinity set of a task.
*
+ * This function will not change the scheduler of the task. The intersection
+ * of the processor affinity set and the set of processors owned by the
+ * scheduler of the task must be non-empty. It is not an error if the
+ * processor affinity set contains processors that are not part of the set of
+ * processors owned by the scheduler instance of the task. A task will simply
+ * not run under normal circumstances on these processors since the scheduler
+ * ignores them. Some locking protocols may temporarily use processors that
+ * are not included in the processor affinity set of the task. It is also not
+ * an error if the processor affinity set contains processors that are not part
+ * of the system.
+ *
* @param[in] id Identifier of the task. Use @ref RTEMS_SELF to select the
* executing task.
* @param[in] cpusetsize Size of the specified affinity set buffer in