Changeset 5a69fe3 in rtems

Timestamp:

10/25/99 16:36:50 (24 years ago)

Author:

Joel Sherrill <joel.sherrill@…>

Branches:

4.10, 4.11, 4.8, 4.9, 5, master

Children:

0d01c94b

Parents:

90d02e9

Message:

Formatting improvements.

Location:

doc/user

Files:

• Makefile (modified) (1 diff)
• conf.t (modified) (1 diff)
• sem.t (modified) (2 diffs)

doc/user/Makefile

@@ -117 +117 @@
 
 msg.texi: msg.t
-        $(BMENU) -p "Semaphore Manager SEMAPHORE_RELEASE - Release a semaphore" \
+        $(BMENU) -p "Semaphore Manager SEMAPHORE_FLUSH - Unblock all tasks waiting on a semaphore" \
             -u "Top" \
             -n "Event Manager" ${*}.t

doc/user/conf.t

@@ -862 +862 @@
 @ifset is-C
 @example
-typedef User_extensions_routine                   rtems_extension;
-typedef User_extensions_thread_create_extension   rtems_task_create_extension;
-typedef User_extensions_thread_delete_extension   rtems_task_delete_extension;
-typedef User_extensions_thread_start_extension    rtems_task_start_extension;
-typedef User_extensions_thread_restart_extension  rtems_task_restart_extension;
-typedef User_extensions_thread_switch_extension   rtems_task_switch_extension;
-typedef User_extensions_thread_begin_extension    rtems_task_begin_extension;
-typedef User_extensions_thread_exitted_extension  rtems_task_exitted_extension;
-typedef User_extensions_fatal_extension           rtems_fatal_extension;
-
-typedef User_extensions_Table                     rtems_extensions_table;
+typedef User_extensions_routine           rtems_extension;
+typedef User_extensions_thread_create_extension   
+           rtems_task_create_extension;
+typedef User_extensions_thread_delete_extension   
+           rtems_task_delete_extension;
+typedef User_extensions_thread_start_extension    
+           rtems_task_start_extension;
+typedef User_extensions_thread_restart_extension  
+           rtems_task_restart_extension;
+typedef User_extensions_thread_switch_extension   
+           rtems_task_switch_extension;
+typedef User_extensions_thread_begin_extension    
+           rtems_task_begin_extension;
+typedef User_extensions_thread_exitted_extension  
+           rtems_task_exitted_extension;
+typedef User_extensions_fatal_extension   rtems_fatal_extension;
+
+typedef User_extensions_Table             rtems_extensions_table;
 
 typedef struct @{

doc/user/sem.t

@@ -27 +27 @@
 @item @code{@value{DIRPREFIX}semaphore_obtain} - Acquire a semaphore
 @item @code{@value{DIRPREFIX}semaphore_release} - Release a semaphore
+@item @code{@value{DIRPREFIX}semaphore_flush} - Unblock all tasks waiting on a semaphore
 @end itemize
 
@@ -759 +760 @@
 inherited a higher priority.
 
+@c
+@c
+@c
+@page
+@subsection SEMAPHORE_FLUSH - Unblock all tasks waiting on a semaphore
+
+@cindex flush a semaphore
+@cindex unlock all tasks a semaphore
+
+@subheading CALLING SEQUENCE:
+
+@ifset is-C
+@findex rtems_semaphore_flush
+@example
+rtems_status_code rtems_semaphore_flush(
+  rtems_id id
+);
+@end example
+@end ifset
+
+@ifset is-Ada
+@example
+procedure Semaphore_Flush (
+   ID     : in     RTEMS.ID;
+   Result :    out RTEMS.Status_Codes
+);
+@end example
+@end ifset
+
+@subheading DIRECTIVE STATUS CODES:
+@code{@value{RPREFIX}SUCCESSFUL} - semaphore released successfully@*
+@code{@value{RPREFIX}INVALID_ID} - invalid semaphore id@*
+@code{@value{RPREFIX}ILLEGAL_ON_REMOTE_OBJECT} - not supported for remote semaphores
+
+@subheading DESCRIPTION:
+
+This directive unblocks all tasks waiting on the semaphore specified by
+id.  Since there are tasks blocked on the semaphore, the semaphore's
+count is not changed by this directive and thus is zero before and
+after this directive is executed.  Tasks which are unblocked as the
+result of this directive will return from the 
+@code{@value{DIRPREFIX}semaphore_release} directive with a
+status code of @code{@value{RPREFIX}UNSATISFIED} to indicate
+that the semaphore was not obtained.
+
+This directive may unblock any number of tasks.  Any of the unblocked
+tasks may preempt the running task if the running task's preemption mode is
+enabled and an unblocked task has a higher priority than the
+running task.
+
+@subheading NOTES:
+
+The calling task may be preempted if it causes a
+higher priority task to be made ready for execution.
+
+If the task to be unblocked resides on a different
+node from the semaphore, then the waiting task is
+unblocked, and the proxy used to represent the task is reclaimed.
+
+