doc: rtems_scheduler_ident()

1 files changed, 37 insertions, 0 deletions

diff --git a/doc/user/smp.t b/doc/user/smp.t
index d0bb240431..fd349ec57a 100644
--- a/doc/user/smp.t
+++ b/doc/user/smp.t
@@ -16,6 +16,7 @@ The application level services currently provided are:
 @itemize @bullet
 @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
 @item @code{rtems_task_get_affinity} - Get task processor affinity
 @item @code{rtems_task_set_affinity} - Set task processor affinity
 @end itemize
@@ -297,6 +298,42 @@ thread dispatching disabled.
 None.
 
 @c
+@c rtems_scheduler_ident
+@c
+@page
+@subsection SCHEDULER_IDENT - Get ID of a scheduler
+
+@subheading CALLING SEQUENCE:
+
+@ifset is-C
+@example
+rtems_status_code rtems_scheduler_ident(
+  rtems_name  name,
+  rtems_id   *id
+);
+@end example
+@end ifset
+
+@ifset is-Ada
+@end ifset
+
+@subheading DIRECTIVE STATUS CODES:
+
+@code{@value{RPREFIX}SUCCESSFUL} - successful operation@*
+@code{@value{RPREFIX}INVALID_ADDRESS} - @code{id} is NULL@*
+@code{@value{RPREFIX}INVALID_NAME} - invalid scheduler name
+
+@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}.
+
+@subheading NOTES:
+
+None.
+
+@c
 @c rtems_task_get_affinity
 @c
 @page