From 89c1a21f9c46d7cb81ca060c43bd1059cbe3fd9b Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Wed, 16 Apr 2014 15:52:15 +0200 Subject: doc: rtems_scheduler_ident() --- doc/user/smp.t | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) (limited to 'doc/user/smp.t') 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 @@ -296,6 +297,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 -- cgit v1.2.3