Changeset 5a69fe3 in rtems


Ignore:
Timestamp:
Oct 25, 1999, 4:36:50 PM (20 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.8, 4.9, master
Children:
0d01c94b
Parents:
90d02e9
Message:

Formatting improvements.

Location:
doc/user
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • doc/user/Makefile

    r90d02e9 r5a69fe3  
    117117
    118118msg.texi: msg.t
    119         $(BMENU) -p "Semaphore Manager SEMAPHORE_RELEASE - Release a semaphore" \
     119        $(BMENU) -p "Semaphore Manager SEMAPHORE_FLUSH - Unblock all tasks waiting on a semaphore" \
    120120            -u "Top" \
    121121            -n "Event Manager" ${*}.t
  • doc/user/conf.t

    r90d02e9 r5a69fe3  
    862862@ifset is-C
    863863@example
    864 typedef User_extensions_routine                   rtems_extension;
    865 typedef User_extensions_thread_create_extension   rtems_task_create_extension;
    866 typedef User_extensions_thread_delete_extension   rtems_task_delete_extension;
    867 typedef User_extensions_thread_start_extension    rtems_task_start_extension;
    868 typedef User_extensions_thread_restart_extension  rtems_task_restart_extension;
    869 typedef User_extensions_thread_switch_extension   rtems_task_switch_extension;
    870 typedef User_extensions_thread_begin_extension    rtems_task_begin_extension;
    871 typedef User_extensions_thread_exitted_extension  rtems_task_exitted_extension;
    872 typedef User_extensions_fatal_extension           rtems_fatal_extension;
    873 
    874 typedef User_extensions_Table                     rtems_extensions_table;
     864typedef User_extensions_routine           rtems_extension;
     865typedef User_extensions_thread_create_extension   
     866           rtems_task_create_extension;
     867typedef User_extensions_thread_delete_extension   
     868           rtems_task_delete_extension;
     869typedef User_extensions_thread_start_extension   
     870           rtems_task_start_extension;
     871typedef User_extensions_thread_restart_extension 
     872           rtems_task_restart_extension;
     873typedef User_extensions_thread_switch_extension   
     874           rtems_task_switch_extension;
     875typedef User_extensions_thread_begin_extension   
     876           rtems_task_begin_extension;
     877typedef User_extensions_thread_exitted_extension 
     878           rtems_task_exitted_extension;
     879typedef User_extensions_fatal_extension   rtems_fatal_extension;
     880
     881typedef User_extensions_Table             rtems_extensions_table;
    875882
    876883typedef struct @{
  • doc/user/sem.t

    r90d02e9 r5a69fe3  
    2727@item @code{@value{DIRPREFIX}semaphore_obtain} - Acquire a semaphore
    2828@item @code{@value{DIRPREFIX}semaphore_release} - Release a semaphore
     29@item @code{@value{DIRPREFIX}semaphore_flush} - Unblock all tasks waiting on a semaphore
    2930@end itemize
    3031
     
    759760inherited a higher priority.
    760761
     762@c
     763@c
     764@c
     765@page
     766@subsection SEMAPHORE_FLUSH - Unblock all tasks waiting on a semaphore
     767
     768@cindex flush a semaphore
     769@cindex unlock all tasks a semaphore
     770
     771@subheading CALLING SEQUENCE:
     772
     773@ifset is-C
     774@findex rtems_semaphore_flush
     775@example
     776rtems_status_code rtems_semaphore_flush(
     777  rtems_id id
     778);
     779@end example
     780@end ifset
     781
     782@ifset is-Ada
     783@example
     784procedure Semaphore_Flush (
     785   ID     : in     RTEMS.ID;
     786   Result :    out RTEMS.Status_Codes
     787);
     788@end example
     789@end ifset
     790
     791@subheading DIRECTIVE STATUS CODES:
     792@code{@value{RPREFIX}SUCCESSFUL} - semaphore released successfully@*
     793@code{@value{RPREFIX}INVALID_ID} - invalid semaphore id@*
     794@code{@value{RPREFIX}ILLEGAL_ON_REMOTE_OBJECT} - not supported for remote semaphores
     795
     796@subheading DESCRIPTION:
     797
     798This directive unblocks all tasks waiting on the semaphore specified by
     799id.  Since there are tasks blocked on the semaphore, the semaphore's
     800count is not changed by this directive and thus is zero before and
     801after this directive is executed.  Tasks which are unblocked as the
     802result of this directive will return from the
     803@code{@value{DIRPREFIX}semaphore_release} directive with a
     804status code of @code{@value{RPREFIX}UNSATISFIED} to indicate
     805that the semaphore was not obtained.
     806
     807This directive may unblock any number of tasks.  Any of the unblocked
     808tasks may preempt the running task if the running task's preemption mode is
     809enabled and an unblocked task has a higher priority than the
     810running task.
     811
     812@subheading NOTES:
     813
     814The calling task may be preempted if it causes a
     815higher priority task to be made ready for execution.
     816
     817If the task to be unblocked resides on a different
     818node from the semaphore, then the waiting task is
     819unblocked, and the proxy used to represent the task is reclaimed.
     820
     821
Note: See TracChangeset for help on using the changeset viewer.