[PATCH 5/8] doc: rtems_scheduler_ident()
Sebastian Huber
sebastian.huber at embedded-brains.de
Wed Apr 16 14:15:47 UTC 2014
---
doc/user/smp.t | 36 ++++++++++++++++++++++++++++++++++++
1 files changed, 36 insertions(+), 0 deletions(-)
diff --git a/doc/user/smp.t b/doc/user/smp.t
index ced8fdf..ebeb3bb 100644
--- a/doc/user/smp.t
+++ b/doc/user/smp.t
@@ -296,6 +296,42 @@ thread dispatching disabled.
None.
@c
+ at c rtems_scheduler_ident
+ at c
+ at page
+ at subsection SCHEDULER_IDENT - Get ID of a scheduler
+
+ at subheading CALLING SEQUENCE:
+
+ at ifset is-C
+ at example
+rtems_status_code rtems_scheduler_ident(
+ rtems_name name,
+ rtems_id *id
+);
+ 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{id} is NULL@*
+ at code{@value{RPREFIX}INVALID_NAME} - invalid scheduler name
+
+ at subheading DESCRIPTION:
+
+Identifies a scheduler by its name. The scheduler name is determined by the
+scheduler configuration. @xref{Configuring a System Configuring
+Clustered/Partitioned Schedulers}.
+
+ at subheading NOTES:
+
+None.
+
+ at c
@c rtems_task_get_affinity
@c
@page
--
1.7.7
More information about the devel
mailing list