[PATCH 6/8] doc: rtems_scheduler_get_processor_set()

Sebastian Huber sebastian.huber at embedded-brains.de
Wed Apr 16 14:15:48 UTC 2014


---
 doc/user/smp.t |   39 +++++++++++++++++++++++++++++++++++++++
 1 files changed, 39 insertions(+), 0 deletions(-)

diff --git a/doc/user/smp.t b/doc/user/smp.t
index ebeb3bb..4ed2735 100644
--- a/doc/user/smp.t
+++ b/doc/user/smp.t
@@ -332,6 +332,45 @@ Clustered/Partitioned Schedulers}.
 None.
 
 @c
+ at c rtems_scheduler_get_processor_set
+ at c
+ at page
+ at subsection SCHEDULER_GET_PROCESSOR_SET - Get processor set of a scheduler
+
+ at subheading CALLING SEQUENCE:
+
+ at ifset is-C
+ at example
+rtems_status_code rtems_scheduler_get_processor_set(
+  rtems_id   scheduler_id,
+  size_t     cpusetsize,
+  cpu_set_t *cpuset
+);
+ at end example
+ at end ifset
+
+ at ifset is-Ada
+ at end ifset
+
+ at subheading DIRECTIVE STATUS CODES:
+
+ at code{@value{RPREFIX}SUCCESSFUL} - successful operation@*
+ at code{@value{RPREFIX}INVALID_ADDRESS} - @code{cpuset} is NULL@*
+ at code{@value{RPREFIX}INVALID_ID} - invalid scheduler id@*
+ at code{@value{RPREFIX}INVALID_NUMBER} - the affinity set buffer is too small for
+set of processors owned by the scheduler
+
+ at subheading DESCRIPTION:
+
+Returns the processor set owned by the scheduler in @code{cpuset}.  A set bit
+in the processor set means that this processor is owned by the scheduler and a
+cleared bit means the opposite.
+
+ at subheading NOTES:
+
+None.
+
+ at c
 @c rtems_task_get_affinity
 @c
 @page
-- 
1.7.7




More information about the devel mailing list