[rtems commit] doc: rtems_scheduler_get_processor_set()

[Sebastian Huber]

Module:    rtems
Branch:    master
Commit:    d1f2f222d298442ff23c732de01b28cbd039c4f0
Changeset: http://git.rtems.org/rtems/commit/?id=d1f2f222d298442ff23c732de01b28cbd039c4f0

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Wed Apr 16 15:59:21 2014 +0200

doc: rtems_scheduler_get_processor_set()

---

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

diff --git a/doc/user/smp.t b/doc/user/smp.t
index fd349ec..bd840c1 100644
--- a/doc/user/smp.t
+++ b/doc/user/smp.t
@@ -17,6 +17,7 @@ The application level services currently provided are:
 @item @code{rtems_get_processor_count} - Get processor count
 @item @code{rtems_get_current_processor} - Get current processor index
 @item @code{rtems_scheduler_ident} - Get ID of a scheduler
+ at item @code{rtems_scheduler_get_processor_set} - Get processor set of a scheduler
 @item @code{rtems_task_get_affinity} - Get task processor affinity
 @item @code{rtems_task_set_affinity} - Set task processor affinity
 @end itemize
@@ -334,6 +335,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