diff options
author | Joel Sherrill <joel.sherrill@OARcorp.com> | 2006-08-23 19:23:30 +0000 |
---|---|---|
committer | Joel Sherrill <joel.sherrill@OARcorp.com> | 2006-08-23 19:23:30 +0000 |
commit | d8f0aa16bc4fb1db2ca0cffb0df9b497092ffc91 (patch) | |
tree | c8416ee60fa013cc5fbb4d499eee3708e9200537 /doc/common | |
parent | 2006-08-23 Joel Sherrill <joel@OARcorp.com> (diff) | |
download | rtems-d8f0aa16bc4fb1db2ca0cffb0df9b497092ffc91.tar.bz2 |
2006-08-23 Joel Sherrill <joel@OARcorp.com>
* Makefile.am, configure.ac, index.html.in: FAQ should now be
completely in the Wiki.
* FAQ/.cvsignore, FAQ/FAQ.texi, FAQ/Makefile.am, FAQ/basic.t,
FAQ/bsp.t, FAQ/build45.t, FAQ/concepts.t, FAQ/debug.t,
FAQ/endoftime.t, FAQ/entry, FAQ/freesw.t, FAQ/hwdebugaids.t,
FAQ/projects.t, FAQ/stamp-vti, FAQ/tools.t, FAQ/version.texi,
common/timemac.texi, common/timetbl.t, common/timing.t: Removed.
Diffstat (limited to 'doc/common')
-rw-r--r-- | doc/common/timemac.texi | 36 | ||||
-rw-r--r-- | doc/common/timetbl.t | 1330 | ||||
-rw-r--r-- | doc/common/timing.t | 396 |
3 files changed, 0 insertions, 1762 deletions
diff --git a/doc/common/timemac.texi b/doc/common/timemac.texi deleted file mode 100644 index 7c327a6075..0000000000 --- a/doc/common/timemac.texi +++ /dev/null @@ -1,36 +0,0 @@ -@c -@c COPYRIGHT (c) 1988-2002. -@c On-Line Applications Research Corporation (OAR). -@c All rights reserved. -@c -@c $Id$ -@c -@c -@c Macros to help with the tables in this file -@c - -@tex -\global\advance \smallskipamount by -4pt - -\global\def\rtemstimetable{ -\vrule\strut##& -\hbox to 3.0in{\enskip##\hfil}& -\hbox to 0.75in{\enskip##\hfil}& -\vrule##\cr -\noalign{\hrule} -} - -\global\def\rtemsendtimetable{} -\global\def\rtemsonecase#1#2{ -& \bf #1\hfil& #2 & \cr\noalign{\hrule} -} - -\global\def\rtemsdirective#1{ -& \bf #1 \hfil& & \cr\noalign{\hrule} -} - -\global\def\rtemscase#1#2{ -& \hskip 0.3in #1\hfil& #2 & \cr\noalign{\hrule} -} - -@end tex diff --git a/doc/common/timetbl.t b/doc/common/timetbl.t deleted file mode 100644 index 32df2a898c..0000000000 --- a/doc/common/timetbl.t +++ /dev/null @@ -1,1330 +0,0 @@ -@c ****** This comment is here to remind you not to edit the timetbl.t -@c ****** in any directory but common. -@c -@c Time Table Template -@c -@c COPYRIGHT (c) 1988-2002. -@c On-Line Applications Research Corporation (OAR). -@c All rights reserved. -@c -@c $Id$ -@c - -@ifset use-tex -@sp 1 -@tex -\centerline{\vbox{\offinterlineskip\halign{ -\span\rtemstimetable -\rtemsonecase{No Floating Point Contexts}{RTEMS_NO_FP_CONTEXTS} -\rtemsdirective{Floating Point Contexts} -\rtemscase{restore first FP task}{RTEMS_RESTORE_1ST_FP_TASK} -\rtemscase{save initialized, restore initialized}{RTEMS_SAVE_INIT_RESTORE_INIT} -\rtemscase{save idle, restore initialized}{RTEMS_SAVE_IDLE_RESTORE_INIT} -\rtemscase{save idle, restore idle}{RTEMS_SAVE_IDLE_RESTORE_IDLE} -\rtemsendtimetable -}}\hfil} -@end tex -@end ifset - -@ifset use-ascii -@ifinfo -@itemize @bullet -@item No Floating Point Contexts -@itemize - -@item only case: RTEMS_NO_FP_CONTEXTS -@end itemize -@item Floating Point Contexts -@itemize - -@item restore first FP task: RTEMS_RESTORE_1ST_FP_TASK -@item save initialized, restore initialized: RTEMS_SAVE_INIT_RESTORE_INIT -@item save idle, restore initialized: RTEMS_SAVE_IDLE_RESTORE_INIT -@item save idle, restore idle: RTEMS_SAVE_IDLE_RESTORE_INIT -@end itemize -@end itemize -@end ifinfo -@end ifset - -@ifset use-html -@html -<CENTER> - <TABLE COLS=2 WIDTH="80%" BORDER=2> -<TR><TD ALIGN=left><STRONG>No Floating Point Contexts</STRONG></TD> - <TD ALIGN=center>RTEMS_NO_FP_CONTEXTS</TD></TR> -<TR><TD ALIGN=left COLSPAN=2><STRONG>Floating Point Contexts</TR> - <TR><TD ALIGN=left><dd>restore first FP task</TD> - <TD ALIGN=center>RTEMS_RESTORE_1ST_FP_TASK</TD> - <TR><TD ALIGN=left><dd>save initialized, restore initialized</TD> - <TD ALIGN=center>RTEMS_SAVE_INIT_RESTORE_INIT</TD> - <TR><TD ALIGN=left><dd>save idle, restore initialized</TD> - <TD ALIGN=center>RTEMS_SAVE_IDLE_RESTORE_INIT</TD> - <TR><TD ALIGN=left><dd>save idle, restore idle</TD> - <TD ALIGN=center>RTEMS_SAVE_IDLE_RESTORE_IDLE</TD> - </TABLE> -</CENTER> -@end html -@end ifset - -@section Directive Times - -This sections is divided into a number of -subsections, each of which contains a table listing the -execution times of that manager's directives. - -@page -@section Task Manager - -@ifset use-tex -@tex -\centerline{\vbox{\offinterlineskip\halign{ -\span\rtemstimetable -\rtemsonecase{TASK\_CREATE}{RTEMS_TASK_CREATE_ONLY} -\rtemsonecase{TASK\_IDENT}{RTEMS_TASK_IDENT_ONLY} -\rtemsonecase{TASK\_START}{RTEMS_TASK_START_ONLY} -\rtemsdirective{TASK\_RESTART} -\rtemscase{calling task}{RTEMS_TASK_RESTART_CALLING_TASK} -\rtemscase{suspended task -- returns to caller} - {RTEMS_TASK_RESTART_SUSPENDED_RETURNS_TO_CALLER} -\rtemscase{blocked task -- returns to caller} - {RTEMS_TASK_RESTART_BLOCKED_RETURNS_TO_CALLER} -\rtemscase{ready task -- returns to caller} - {RTEMS_TASK_RESTART_READY_RETURNS_TO_CALLER} -\rtemscase{suspended task -- preempts caller} - {RTEMS_TASK_RESTART_SUSPENDED_PREEMPTS_CALLER} -\rtemscase{blocked task -- preempts caller} - {RTEMS_TASK_RESTART_BLOCKED_PREEMPTS_CALLER} -\rtemscase{ready task -- preempts caller} - {RTEMS_TASK_RESTART_READY_PREEMPTS_CALLER} -\rtemsdirective{TASK\_DELETE} -\rtemscase{calling task}{RTEMS_TASK_DELETE_CALLING_TASK} -\rtemscase{suspended task}{RTEMS_TASK_DELETE_SUSPENDED_TASK} -\rtemscase{blocked task}{RTEMS_TASK_DELETE_BLOCKED_TASK} -\rtemscase{ready task}{RTEMS_TASK_DELETE_READY_TASK} -\rtemsdirective{TASK\_SUSPEND} -\rtemscase{calling task}{RTEMS_TASK_SUSPEND_CALLING_TASK} -\rtemscase{returns to caller}{RTEMS_TASK_SUSPEND_RETURNS_TO_CALLER} -\rtemsdirective{TASK\_RESUME} -\rtemscase{task readied -- returns to caller} - {RTEMS_TASK_RESUME_TASK_READIED_RETURNS_TO_CALLER} -\rtemscase{task readied -- preempts caller} - {RTEMS_TASK_RESUME_TASK_READIED_PREEMPTS_CALLER} -\rtemsdirective{TASK\_SET\_PRIORITY} -\rtemscase{obtain current priority} - {RTEMS_TASK_SET_PRIORITY_OBTAIN_CURRENT_PRIORITY} -\rtemscase{returns to caller}{RTEMS_TASK_SET_PRIORITY_RETURNS_TO_CALLER} -\rtemscase{preempts caller}{RTEMS_TASK_SET_PRIORITY_PREEMPTS_CALLER} -\rtemsdirective{TASK\_MODE} -\rtemscase{obtain current mode}{RTEMS_TASK_MODE_OBTAIN_CURRENT_MODE} -\rtemscase{no reschedule}{RTEMS_TASK_MODE_NO_RESCHEDULE} -\rtemscase{reschedule -- returns to caller} - {RTEMS_TASK_MODE_RESCHEDULE_RETURNS_TO_CALLER} -\rtemscase{reschedule -- preempts caller} - {RTEMS_TASK_MODE_RESCHEDULE_PREEMPTS_CALLER} -\rtemsonecase{TASK\_GET\_NOTE}{RTEMS_TASK_GET_NOTE_ONLY} -\rtemsonecase{TASK\_SET\_NOTE}{RTEMS_TASK_SET_NOTE_ONLY} -\rtemsdirective{TASK\_WAKE\_AFTER} -\rtemscase{yield -- returns to caller} - {RTEMS_TASK_WAKE_AFTER_YIELD_RETURNS_TO_CALLER} -\rtemscase{yield -- preempts caller} - {RTEMS_TASK_WAKE_AFTER_YIELD_PREEMPTS_CALLER} -\rtemsonecase{TASK\_WAKE\_WHEN}{RTEMS_TASK_WAKE_WHEN_ONLY} -\rtemsendtimetable -}}\hfil} -@end tex -@end ifset - -@ifset use-ascii -@ifinfo -@itemize @bullet - -@item TASK_CREATE -@itemize - -@item only case: RTEMS_TASK_CREATE_ONLY -@end itemize - -@item TASK_IDENT -@itemize - -@item only case: RTEMS_TASK_IDENT_ONLY -@end itemize - -@item TASK_START -@itemize - -@item only case: RTEMS_TASK_START_ONLY -@end itemize - -@item TASK_RESTART -@itemize - -@item calling task: RTEMS_TASK_RESTART_CALLING_TASK -@item suspended task -- returns to caller: RTEMS_TASK_RESTART_SUSPENDED_RETURNS_TO_CALLER -@item blocked task -- returns to caller: RTEMS_TASK_RESTART_BLOCKED_RETURNS_TO_CALLER -@item ready task -- returns to caller: RTEMS_TASK_RESTART_READY_RETURNS_TO_CALLER -@item suspended task -- preempts caller: RTEMS_TASK_RESTART_SUSPENDED_PREEMPTS_CALLER -@item blocked task -- preempts caller: RTEMS_TASK_RESTART_BLOCKED_PREEMPTS_CALLER -@item ready task -- preempts caller: RTEMS_TASK_RESTART_READY_PREEMPTS_CALLER -@end itemize - -@item TASK_DELETE -@itemize - -@item calling task: RTEMS_TASK_DELETE_CALLING_TASK -@item suspended task: RTEMS_TASK_DELETE_SUSPENDED_TASK -@item blocked task: RTEMS_TASK_DELETE_BLOCKED_TASK -@item ready task: RTEMS_TASK_DELETE_READY_TASK -@end itemize - -@item TASK_SUSPEND -@itemize - -@item calling task: RTEMS_TASK_SUSPEND_CALLING_TASK -@item returns to caller: RTEMS_TASK_SUSPEND_RETURNS_TO_CALLER -@end itemize - -@item TASK_RESUME -@itemize - -@item task readied -- returns to caller: RTEMS_TASK_RESUME_TASK_READIED_RETURNS_TO_CALLER -@item task readied -- preempts caller: RTEMS_TASK_RESUME_TASK_READIED_PREEMPTS_CALLER -@end itemize - -@item TASK_SET_PRIORITY -@itemize - -@item obtain current priority: RTEMS_TASK_SET_PRIORITY_OBTAIN_CURRENT_PRIORITY -@item returns to caller: RTEMS_TASK_SET_PRIORITY_RETURNS_TO_CALLER -@item preempts caller: RTEMS_TASK_SET_PRIORITY_PREEMPTS_CALLER -@end itemize - -@item TASK_MODE -@itemize - -@item obtain current mode: RTEMS_TASK_MODE_OBTAIN_CURRENT_MODE -@item no reschedule: RTEMS_TASK_MODE_NO_RESCHEDULE -@item reschedule -- returns to caller: RTEMS_TASK_MODE_RESCHEDULE_RETURNS_TO_CALLER -@item reschedule -- preempts caller: RTEMS_TASK_MODE_RESCHEDULE_PREEMPTS_CALLER -@end itemize - -@item TASK_GET_NOTE -@itemize - -@item only case: RTEMS_TASK_GET_NOTE_ONLY -@end itemize - -@item TASK_SET_NOTE -@itemize - -@item only case: RTEMS_TASK_SET_NOTE_ONLY -@end itemize - -@item TASK_WAKE_AFTER -@itemize - -@item yield -- returns to caller: RTEMS_TASK_WAKE_AFTER_YIELD_RETURNS_TO_CALLER -@item yield -- preempts caller: RTEMS_TASK_WAKE_AFTER_YIELD_PREEMPTS_CALLER -@end itemize - -@item TASK_WAKE_WHEN -@itemize - -@item only case: RTEMS_TASK_WAKE_WHEN_ONLY -@end itemize - -@end itemize -@end ifinfo -@end ifset - -@ifset use-html -@html -<CENTER> - <TABLE COLS=2 WIDTH="80%" BORDER=2> -<TR><TD ALIGN=left><STRONG>TASK_CREATE</STRONG></TD> - <TD ALIGN=center>RTEMS_TASK_CREATE_ONLY</TD></TR> -<TR><TD ALIGN=left><STRONG>TASK_IDENT</STRONG></TD> - <TD ALIGN=center>RTEMS_TASK_IDENT_ONLY</TD></TR> -<TR><TD ALIGN=left><STRONG>TASK_START</STRONG></TD> - <TD ALIGN=center>RTEMS_TASK_START_ONLY</TD></TR> -<TR><TD ALIGN=left COLSPAN=2><STRONG>TASK_RESTART</STRONG></TD></TR> - <TR><TD ALIGN=left><dd>calling task</TD> - <TD ALIGN=center>RTEMS_TASK_RESTART_CALLING_TASK</TD></TR> - <TR><TD ALIGN=left><dd>suspended task -- returns to caller</TD> - <TD ALIGN=center>RTEMS_TASK_RESTART_SUSPENDED_RETURNS_TO_CALLER</TD></TR> - <TR><TD ALIGN=left><dd>blocked task -- returns to caller</TD> - <TD ALIGN=center>RTEMS_TASK_RESTART_BLOCKED_RETURNS_TO_CALLER</TD></TR> - <TR><TD ALIGN=left><dd>ready task -- returns to caller</TD> - <TD ALIGN=center>RTEMS_TASK_RESTART_READY_RETURNS_TO_CALLER</TD></TR> - <TR><TD ALIGN=left><dd>suspended task -- preempts caller</TD> - <TD ALIGN=center>RTEMS_TASK_RESTART_SUSPENDED_PREEMPTS_CALLER</TD></TR> - <TR><TD ALIGN=left><dd>blocked task -- preempts caller</TD> - <TD ALIGN=center>RTEMS_TASK_RESTART_BLOCKED_PREEMPTS_CALLER</TD></TR> - <TR><TD ALIGN=left><dd>ready task -- preempts caller</TD> - <TD ALIGN=center>RTEMS_TASK_RESTART_READY_PREEMPTS_CALLER</TD></TR> -<TR><TD ALIGN=left COLSPAN=2><STRONG>TASK_DELETE</STRONG></TD></TR> - <TR><TD ALIGN=left><dd>calling task</TD> - <TD ALIGN=center>RTEMS_TASK_DELETE_CALLING_TASK</TD></TR> - <TR><TD ALIGN=left><dd>suspended task</TD> - <TD ALIGN=center>RTEMS_TASK_DELETE_SUSPENDED_TASK</TD></TR> - <TR><TD ALIGN=left><dd>blocked task</TD> - <TD ALIGN=center>RTEMS_TASK_DELETE_BLOCKED_TASK</TD></TR> - <TR><TD ALIGN=left><dd>ready task</TD> - <TD ALIGN=center>RTEMS_TASK_DELETE_READY_TASK</TD></TR> -<TR><TD ALIGN=left COLSPAN=2><STRONG>TASK_SUSPEND</STRONG></TD></TR> - <TR><TD ALIGN=left><dd>calling task</TD> - <TD ALIGN=center>RTEMS_TASK_SUSPEND_CALLING_TASK</TD></TR> - <TR><TD ALIGN=left><dd>returns to caller</TD> - <TD ALIGN=center>RTEMS_TASK_SUSPEND_RETURNS_TO_CALLER</TD></TR> -<TR><TD ALIGN=left COLSPAN=2><STRONG>TASK_RESUME</STRONG></TD></TR> - <TR><TD ALIGN=left><dd>task readied -- returns to caller</TD> - <TD ALIGN=center>RTEMS_TASK_RESUME_TASK_READIED_RETURNS_TO_CALLER</TD></TR> - <TR><TD ALIGN=left><dd>task readied -- preempts caller</TD> - <TD ALIGN=center>RTEMS_TASK_RESUME_TASK_READIED_PREEMPTS_CALLER</TD></TR> -<TR><TD ALIGN=left COLSPAN=2><STRONG>TASK_SET_PRIORITY</STRONG></TD></TR> - <TR><TD ALIGN=left><dd>obtain current priority</TD> - <TD ALIGN=center>RTEMS_TASK_SET_PRIORITY_OBTAIN_CURRENT_PRIORITY</TD></TR> - <TR><TD ALIGN=left><dd>returns to caller</TD> - <TD ALIGN=center>RTEMS_TASK_SET_PRIORITY_RETURNS_TO_CALLER</TD></TR> - <TR><TD ALIGN=left><dd>preempts caller</TD> - <TD ALIGN=center>RTEMS_TASK_SET_PRIORITY_PREEMPTS_CALLER</TD></TR> -<TR><TD ALIGN=left COLSPAN=2><STRONG>TASK_MODE</STRONG></TD></TR> - <TR><TD ALIGN=left><dd>obtain current mode</TD> - <TD ALIGN=center>RTEMS_TASK_MODE_OBTAIN_CURRENT_MODE</TD></TR> - <TR><TD ALIGN=left><dd>no reschedule</TD> - <TD ALIGN=center>RTEMS_TASK_MODE_NO_RESCHEDULE</TD></TR> - <TR><TD ALIGN=left><dd>reschedule -- returns to caller</TD> - <TD ALIGN=center>RTEMS_TASK_MODE_RESCHEDULE_RETURNS_TO_CALLER</TD></TR> - <TR><TD ALIGN=left><dd>reschedule -- preempts caller</TD> - <TD ALIGN=center>RTEMS_TASK_MODE_RESCHEDULE_PREEMPTS_CALLER</TD></TR> -<TR><TD ALIGN=left><STRONG>TASK_GET_NOTE</STRONG></TD> - <TD ALIGN=center>RTEMS_TASK_GET_NOTE_ONLY</TD></TR> -<TR><TD ALIGN=left><STRONG>TASK_SET_NOTE</STRONG></TD> - <TD ALIGN=center>RTEMS_TASK_SET_NOTE_ONLY</TD></TR> -<TR><TD ALIGN=left COLSPAN=2><STRONG>TASK_WAKE_AFTER</STRONG></TD></TR> - <TR><TD ALIGN=left><dd>yield -- returns to caller</TD> - <TD ALIGN=center>RTEMS_TASK_WAKE_AFTER_YIELD_RETURNS_TO_CALLER</TD></TR> - <TR><TD ALIGN=left><dd>yield -- preempts caller</TD> - <TD ALIGN=center>RTEMS_TASK_WAKE_AFTER_YIELD_PREEMPTS_CALLER</TD></TR> -<TR><TD ALIGN=left><STRONG>TASK_WAKE_WHEN</STRONG></TD> - <TD ALIGN=center>RTEMS_TASK_WAKE_WHEN_ONLY</TD></TR> - </TABLE> -</CENTER> -@end html -@end ifset - -@page -@section Interrupt Manager - -It should be noted that the interrupt entry times -include vectoring the interrupt handler. - -@ifset use-tex -@sp 1 -@tex -\centerline{\vbox{\offinterlineskip\halign{ -\span\rtemstimetable -\rtemsdirective{Interrupt Entry Overhead} -\rtemscase{returns to nested interrupt}{RTEMS_INTR_ENTRY_RETURNS_TO_NESTED} -\rtemscase{returns to interrupted task} - {RTEMS_INTR_ENTRY_RETURNS_TO_INTERRUPTED_TASK} -\rtemscase{returns to preempting task} - {RTEMS_INTR_ENTRY_RETURNS_TO_PREEMPTING_TASK} -\rtemsdirective{Interrupt Exit Overhead} -\rtemscase{returns to nested interrupt}{RTEMS_INTR_EXIT_RETURNS_TO_NESTED} -\rtemscase{returns to interrupted task} - {RTEMS_INTR_EXIT_RETURNS_TO_INTERRUPTED_TASK} -\rtemscase{returns to preempting task} - {RTEMS_INTR_EXIT_RETURNS_TO_PREEMPTING_TASK} -\rtemsendtimetable -}}\hfil} -@end tex -@end ifset - -@ifset use-ascii -@ifinfo -@itemize @bullet - -@item Interrupt Entry Overhead -@itemize - -@item returns to nested interrupt: RTEMS_INTR_ENTRY_RETURNS_TO_NESTED -@item returns to interrupted task: RTEMS_INTR_ENTRY_RETURNS_TO_INTERRUPTED_TASK -@item returns to preempting task: RTEMS_INTR_ENTRY_RETURNS_TO_PREEMPTING_TASK -@end itemize - -@item Interrupt Exit Overhead -@itemize - -@item returns to nested interrupt: RTEMS_INTR_EXIT_RETURNS_TO_NESTED -@item returns to interrupted task: RTEMS_INTR_EXIT_RETURNS_TO_INTERRUPTED_TASK -@item returns to preempting task: RTEMS_INTR_EXIT_RETURNS_TO_PREEMPTING_TASK -@end itemize - -@end itemize -@end ifinfo -@end ifset - -@ifset use-html -@html -<CENTER> - <TABLE COLS=2 WIDTH="80%" BORDER=2> -<TR><TD ALIGN=left COLSPAN=2><STRONG>Interrupt Entry Overhead</STRONG></TD></TR> - <TR><TD ALIGN=left><dd>returns to nested interrupt</TD> - <TD ALIGN=center>RTEMS_INTR_ENTRY_RETURNS_TO_NESTED</TD></TR> - <TR><TD ALIGN=left><dd>returns to interrupted task</TD> - <TD ALIGN=center>RTEMS_INTR_ENTRY_RETURNS_TO_INTERRUPTED_TASK</TD></TR> - <TR><TD ALIGN=left><dd>returns to preempting task</TD> - <TD ALIGN=center>RTEMS_INTR_ENTRY_RETURNS_TO_PREEMPTING_TASK</TD></TR> -<TR><TD ALIGN=left COLSPAN=2><STRONG>Interrupt Exit Overhead</STRONG></TD></TR> - <TR><TD ALIGN=left><dd>returns to nested interrupt</TD> - <TD ALIGN=center>RTEMS_INTR_EXIT_RETURNS_TO_NESTED</TD></TR> - <TR><TD ALIGN=left><dd>returns to interrupted task</TD> - <TD ALIGN=center>RTEMS_INTR_EXIT_RETURNS_TO_INTERRUPTED_TASK</TD></TR> - <TR><TD ALIGN=left><dd>returns to preempting task</TD> - <TD ALIGN=center>RTEMS_INTR_EXIT_RETURNS_TO_PREEMPTING_TASK</TD></TR> - </TABLE> -</CENTER> -@end html -@end ifset - - -@section Clock Manager - -@ifset use-tex -@tex -\centerline{\vbox{\offinterlineskip\halign{ -\span\rtemstimetable -\rtemsonecase{CLOCK\_SET}{RTEMS_CLOCK_SET_ONLY} -\rtemsonecase{CLOCK\_GET}{RTEMS_CLOCK_GET_ONLY} -\rtemsonecase{CLOCK\_TICK}{RTEMS_CLOCK_TICK_ONLY} -\rtemsendtimetable -}}\hfil} -@end tex -@end ifset - -@ifset use-ascii -@ifinfo -@itemize @bullet - -@item CLOCK_SET -@itemize - -@item only case: RTEMS_CLOCK_SET_ONLY -@end itemize - -@item CLOCK_GET -@itemize - -@item only case: RTEMS_CLOCK_GET_ONLY -@end itemize - -@item CLOCK_TICK -@itemize - -@item only case: RTEMS_CLOCK_TICK_ONLY -@end itemize - -@end itemize -@end ifinfo -@end ifset - -@ifset use-html -@html -<CENTER> - <TABLE COLS=2 WIDTH="80%" BORDER=2> -<TR><TD ALIGN=left><STRONG>CLOCK_SET</STRONG></TD> - <TD ALIGN=center>RTEMS_CLOCK_SET_ONLY</TD></TR> -<TR><TD ALIGN=left><STRONG>CLOCK_GET</STRONG></TD> - <TD ALIGN=center>RTEMS_CLOCK_GET_ONLY</TD></TR> -<TR><TD ALIGN=left><STRONG>CLOCK_TICK</STRONG></TD> - <TD ALIGN=center>RTEMS_CLOCK_TICK_ONLY</TD></TR> - </TABLE> -</CENTER> -@end html -@end ifset - -@section Timer Manager - -@ifset use-tex -@tex -\centerline{\vbox{\offinterlineskip\halign{ -\span\rtemstimetable -\rtemsonecase{TIMER\_CREATE}{RTEMS_TIMER_CREATE_ONLY} -\rtemsonecase{TIMER\_IDENT}{RTEMS_TIMER_IDENT_ONLY} -\rtemsdirective{TIMER\_DELETE} -\rtemscase{inactive}{RTEMS_TIMER_DELETE_INACTIVE} -\rtemscase{active}{RTEMS_TIMER_DELETE_ACTIVE} -\rtemsdirective{TIMER\_FIRE\_AFTER} -\rtemscase{inactive}{RTEMS_TIMER_FIRE_AFTER_INACTIVE} -\rtemscase{active}{RTEMS_TIMER_FIRE_AFTER_ACTIVE} -\rtemsdirective{TIMER\_FIRE\_WHEN} -\rtemscase{inactive}{RTEMS_TIMER_FIRE_WHEN_INACTIVE} -\rtemscase{active}{RTEMS_TIMER_FIRE_WHEN_ACTIVE} -\rtemsdirective{TIMER\_RESET} -\rtemscase{inactive}{RTEMS_TIMER_RESET_INACTIVE} -\rtemscase{active}{RTEMS_TIMER_RESET_ACTIVE} -\rtemsdirective{TIMER\_CANCEL} -\rtemscase{inactive}{RTEMS_TIMER_CANCEL_INACTIVE} -\rtemscase{active}{RTEMS_TIMER_CANCEL_ACTIVE} -\rtemsendtimetable -}}\hfil} -@end tex -@end ifset - -@ifset use-ascii -@ifinfo -@itemize @bullet - -@item TIMER_CREATE -@itemize - -@item only case: RTEMS_TIMER_CREATE_ONLY -@end itemize - -@item TIMER_IDENT -@itemize - -@item only case: RTEMS_TIMER_IDENT_ONLY -@end itemize - -@item TIMER_DELETE -@itemize - -@item inactive: RTEMS_TIMER_DELETE_INACTIVE -@item active: RTEMS_TIMER_DELETE_ACTIVE -@end itemize - -@item TIMER_FIRE_AFTER -@itemize - -@item inactive: RTEMS_TIMER_FIRE_AFTER_INACTIVE -@item active: RTEMS_TIMER_FIRE_AFTER_ACTIVE -@end itemize - -@item TIMER_FIRE_WHEN -@itemize - -@item inactive: TIMER_FIRE_WHEN_INACTIVE -@item active: TIMER_FIRE_WHEN_ACTIVE -@end itemize - -@item TIMER_RESET -@itemize - -@item inactive: TIMER_RESET_INACTIVE -@item active: TIMER_RESET_ACTIVE -@end itemize - -@item TIMER_CANCEL -@itemize - -@item inactive: TIMER_CANCEL_INACTIVE -@item active: TIMER_CANCEL_ACTIVE -@end itemize - -@end itemize -@end ifinfo -@end ifset - -@ifset use-html -@html -<CENTER> - <TABLE COLS=2 WIDTH="80%" BORDER=2> -<TR><TD ALIGN=left><STRONG>TIMER_CREATE</STRONG></TD> - <TD ALIGN=center>RTEMS_TIMER_CREATE_ONLY</TD></TR> -<TR><TD ALIGN=left><STRONG>TIMER_IDENT</STRONG></TD> - <TD ALIGN=center>RTEMS_TIMER_IDENT_ONLY</TD></TR> -<TR><TD ALIGN=left COLSPAN=2><STRONG>TIMER_DELETE</STRONG></TD></TR> - <TR><TD ALIGN=left><dd>inactive</TD> - <TD ALIGN=center>RTEMS_TIMER_DELETE_INACTIVE</TD></TR> - <TR><TD ALIGN=left><dd>active</TD> - <TD ALIGN=center>RTEMS_TIMER_DELETE_ACTIVE</TD></TR> -<TR><TD ALIGN=left COLSPAN=2><STRONG>TIMER_FIRE_AFTER</STRONG></TD></TR> - <TR><TD ALIGN=left><dd>inactive</TD> - <TD ALIGN=center>RTEMS_TIMER_FIRE_AFTER_INACTIVE</TD></TR> - <TR><TD ALIGN=left><dd>active</TD> - <TD ALIGN=center>RTEMS_TIMER_FIRE_AFTER_ACTIVE</TD></TR> -<TR><TD ALIGN=left COLSPAN=2><STRONG>TIMER_FIRE_WHEN</STRONG></TD></TR> - <TR><TD ALIGN=left><dd>inactive</TD> - <TD ALIGN=center>RTEMS_TIMER_FIRE_WHEN_INACTIVE</TD></TR> - <TR><TD ALIGN=left><dd>active</TD> - <TD ALIGN=center>RTEMS_TIMER_FIRE_WHEN_ACTIVE</TD></TR> -<TR><TD ALIGN=left COLSPAN=2><STRONG>TIMER_RESET</STRONG></TD></TR> - <TR><TD ALIGN=left><dd>inactive</TD> - <TD ALIGN=center>RTEMS_TIMER_RESET_INACTIVE</TD></TR> - <TR><TD ALIGN=left><dd>active</TD> - <TD ALIGN=center>RTEMS_TIMER_RESET_ACTIVE</TD></TR> -<TR><TD ALIGN=left COLSPAN=2><STRONG>TIMER_CANCEL</STRONG></TD></TR> - <TR><TD ALIGN=left><dd>inactive</TD> - <TD ALIGN=center>RTEMS_TIMER_CANCEL_INACTIVE</TD></TR> - <TR><TD ALIGN=left><dd>active</TD> - <TD ALIGN=center>RTEMS_TIMER_CANCEL_ACTIVE</TD></TR> - </TABLE> -</CENTER> -@end html -@end ifset - -@page -@section Semaphore Manager - -@ifset use-tex -@tex -\centerline{\vbox{\offinterlineskip\halign{ -\span\rtemstimetable -\rtemsonecase{SEMAPHORE\_CREATE}{RTEMS_SEMAPHORE_CREATE_ONLY} -\rtemsonecase{SEMAPHORE\_IDENT}{RTEMS_SEMAPHORE_IDENT_ONLY} -\rtemsonecase{SEMAPHORE\_DELETE}{RTEMS_SEMAPHORE_DELETE_ONLY} -\rtemsdirective{SEMAPHORE\_OBTAIN} -\rtemscase{available}{RTEMS_SEMAPHORE_OBTAIN_AVAILABLE} -\rtemscase{not available -- NO\_WAIT} - {RTEMS_SEMAPHORE_OBTAIN_NOT_AVAILABLE_NO_WAIT} -\rtemscase{not available -- caller blocks} - {RTEMS_SEMAPHORE_OBTAIN_NOT_AVAILABLE_CALLER_BLOCKS} -\rtemsdirective{SEMAPHORE\_RELEASE} -\rtemscase{no waiting tasks}{RTEMS_SEMAPHORE_RELEASE_NO_WAITING_TASKS} -\rtemscase{task readied -- returns to caller} - {RTEMS_SEMAPHORE_RELEASE_TASK_READIED_RETURNS_TO_CALLER} -\rtemscase{task readied -- preempts caller} - {RTEMS_SEMAPHORE_RELEASE_TASK_READIED_PREEMPTS_CALLER} -\rtemsendtimetable -}}\hfil} -@end tex -@end ifset - -@ifset use-ascii -@ifinfo -@itemize @bullet - -@item SEMAPHORE_CREATE -@itemize - -@item only case: RTEMS_SEMAPHORE_CREATE_ONLY -@end itemize - -@item SEMAPHORE_IDENT -@itemize - -@item only case: RTEMS_SEMAPHORE_IDENT_ONLY -@end itemize - -@item SEMAPHORE_DELETE -@itemize - -@item only case: RTEMS_SEMAPHORE_DELETE_ONLY -@end itemize - -@item SEMAPHORE_OBTAIN -@itemize - -@item available: RTEMS_SEMAPHORE_OBTAIN_AVAILABLE -@item not available -- NO_WAIT: RTEMS_SEMAPHORE_OBTAIN_NOT_AVAILABLE_NO_WAIT -@item not available -- caller blocks: RTEMS_SEMAPHORE_OBTAIN_NOT_AVAILABLE_CALLER_BLOCKS -@end itemize - -@item SEMAPHORE_RELEASE -@itemize - -@item no waiting tasks: RTEMS_SEMAPHORE_RELEASE_NO_WAITING_TASKS -@item task readied -- returns to caller: RTEMS_SEMAPHORE_RELEASE_TASK_READIED_RETURNS_TO_CALLER -@item task readied -- preempts caller: RTEMS_SEMAPHORE_RELEASE_TASK_READIED_PREEMPTS_CALLER -@end itemize - -@end itemize -@end ifinfo -@end ifset - -@ifset use-html -@html -<CENTER> - <TABLE COLS=2 WIDTH="80%" BORDER=2> -<TR><TD ALIGN=left><STRONG>SEMAPHORE_CREATE</STRONG></TD> - <TD ALIGN=center>RTEMS_SEMAPHORE_CREATE_ONLY</TD></TR> -<TR><TD ALIGN=left><STRONG>SEMAPHORE_IDENT</STRONG></TD> - <TD ALIGN=center>RTEMS_SEMAPHORE_IDENT_ONLY</TD></TR> -<TR><TD ALIGN=left><STRONG>SEMAPHORE_DELETE</STRONG></TD> - <TD ALIGN=center>RTEMS_SEMAPHORE_DELETE_ONLY</TD></TR> -<TR><TD ALIGN=left COLSPAN=2><STRONG>SEMAPHORE_OBTAIN</STRONG></TD></TR> - <TR><TD ALIGN=left><dd>available</TD> - <TD ALIGN=center>RTEMS_SEMAPHORE_OBTAIN_AVAILABLE</TD></TR> - <TR><TD ALIGN=left><dd>not available -- NO_WAIT</TD> - <TD ALIGN=center>RTEMS_SEMAPHORE_OBTAIN_NOT_AVAILABLE_NO_WAIT</TD></TR> - <TR><TD ALIGN=left><dd>not available -- caller blocks</TD> - <TD ALIGN=center>RTEMS_SEMAPHORE_OBTAIN_NOT_AVAILABLE_CALLER_BLOCKS</TD></TR> -<TR><TD ALIGN=left COLSPAN=2><STRONG>SEMAPHORE_RELEASE</STRONG></TD></TR> - <TR><TD ALIGN=left><dd>no waiting tasks</TD> - <TD ALIGN=center>RTEMS_SEMAPHORE_RELEASE_NO_WAITING_TASKS</TD></TR> - <TR><TD ALIGN=left><dd>task readied -- returns to caller</TD> - <TD ALIGN=center>RTEMS_SEMAPHORE_RELEASE_TASK_READIED_RETURNS_TO_CALLER</TD></TR> - <TR><TD ALIGN=left><dd>task readied -- preempts caller</TD> - <TD ALIGN=center>RTEMS_SEMAPHORE_RELEASE_TASK_READIED_PREEMPTS_CALLER</TD></TR> - </TABLE> -</CENTER> -@end html -@end ifset - -@section Message Manager - -@ifset use-tex -@tex -\centerline{\vbox{\offinterlineskip\halign{ -\span\rtemstimetable -\rtemsonecase{MESSAGE\_QUEUE\_CREATE}{RTEMS_MESSAGE_QUEUE_CREATE_ONLY} -\rtemsonecase{MESSAGE\_QUEUE\_IDENT}{RTEMS_MESSAGE_QUEUE_IDENT_ONLY} -\rtemsonecase{MESSAGE\_QUEUE\_DELETE}{RTEMS_MESSAGE_QUEUE_DELETE_ONLY} -\rtemsdirective{MESSAGE\_QUEUE\_SEND} -\rtemscase{no waiting tasks} - {RTEMS_MESSAGE_QUEUE_SEND_NO_WAITING_TASKS} -\rtemscase{task readied -- returns to caller} - {RTEMS_MESSAGE_QUEUE_SEND_TASK_READIED_RETURNS_TO_CALLER} -\rtemscase{task readied -- preempts caller} - {RTEMS_MESSAGE_QUEUE_SEND_TASK_READIED_PREEMPTS_CALLER} -\rtemsdirective{MESSAGE\_QUEUE\_URGENT} -\rtemscase{no waiting tasks}{RTEMS_MESSAGE_QUEUE_URGENT_NO_WAITING_TASKS} -\rtemscase{task readied -- returns to caller} - {RTEMS_MESSAGE_QUEUE_URGENT_TASK_READIED_RETURNS_TO_CALLER} -\rtemscase{task readied -- preempts caller} - {RTEMS_MESSAGE_QUEUE_URGENT_TASK_READIED_PREEMPTS_CALLER} -\rtemsdirective{MESSAGE\_QUEUE\_BROADCAST} -\rtemscase{no waiting tasks}{RTEMS_MESSAGE_QUEUE_BROADCAST_NO_WAITING_TASKS} -\rtemscase{task readied -- returns to caller} - {RTEMS_MESSAGE_QUEUE_BROADCAST_TASK_READIED_RETURNS_TO_CALLER} -\rtemscase{task readied -- preempts caller} - {RTEMS_MESSAGE_QUEUE_BROADCAST_TASK_READIED_PREEMPTS_CALLER} -\rtemsdirective{MESSAGE\_QUEUE\_RECEIVE} -\rtemscase{available}{RTEMS_MESSAGE_QUEUE_RECEIVE_AVAILABLE} -\rtemscase{not available -- NO\_WAIT} - {RTEMS_MESSAGE_QUEUE_RECEIVE_NOT_AVAILABLE_NO_WAIT} -\rtemscase{not available -- caller blocks} - {RTEMS_MESSAGE_QUEUE_RECEIVE_NOT_AVAILABLE_CALLER_BLOCKS} -\rtemsdirective{MESSAGE\_QUEUE\_FLUSH} -\rtemscase{no messages flushed}{RTEMS_MESSAGE_QUEUE_FLUSH_NO_MESSAGES_FLUSHED} -\rtemscase{messages flushed}{RTEMS_MESSAGE_QUEUE_FLUSH_MESSAGES_FLUSHED} -\rtemsendtimetable -}}\hfil} -@end tex -@end ifset - -@ifset use-ascii -@ifinfo -@itemize @bullet - -@item MESSAGE_QUEUE_CREATE -@itemize - -@item only case: RTEMS_MESSAGE_QUEUE_CREATE_ONLY -@end itemize - -@item MESSAGE_QUEUE_IDENT -@itemize - -@item only case: RTEMS_MESSAGE_QUEUE_IDENT_ONLY -@end itemize - -@item MESSAGE_QUEUE_DELETE -@itemize - -@item only case: RTEMS_MESSAGE_QUEUE_DELETE_ONLY -@end itemize - -@item MESSAGE_QUEUE_SEND -@itemize - -@item no waiting tasks: RTEMS_MESSAGE_QUEUE_SEND_NO_WAITING_TASKS -@item task readied -- returns to caller: RTEMS_MESSAGE_QUEUE_SEND_TASK_READIED_RETURNS_TO_CALLER -@item task readied -- preempts caller: RTEMS_MESSAGE_QUEUE_SEND_TASK_READIED_PREEMPTS_CALLER -@end itemize - -@item MESSAGE_QUEUE_URGENT -@itemize - -@item no waiting tasks: RTEMS_MESSAGE_QUEUE_URGENT_NO_WAITING_TASKS -@item task readied -- returns to caller: RTEMS_MESSAGE_QUEUE_URGENT_TASK_READIED_RETURNS_TO_CALLER -@item task readied -- preempts caller: RTEMS_MESSAGE_QUEUE_URGENT_TASK_READIED_PREEMPTS_CALLER -@end itemize - -@item MESSAGE_QUEUE_BROADCAST -@itemize - -@item no waiting tasks: RTEMS_MESSAGE_QUEUE_BROADCAST_NO_WAITING_TASKS -@item task readied -- returns to caller: RTEMS_MESSAGE_QUEUE_BROADCAST_TASK_READIED_RETURNS_TO_CALLER -@item task readied -- preempts caller: RTEMS_MESSAGE_QUEUE_BROADCAST_TASK_READIED_PREEMPTS_CALLER -@end itemize - -@item MESSAGE_QUEUE_RECEIVE -@itemize - -@item available: RTEMS_MESSAGE_QUEUE_RECEIVE_AVAILABLE -@item not available -- NO_WAIT: RTEMS_MESSAGE_QUEUE_RECEIVE_NOT_AVAILABLE_NO_WAIT -@item not available -- caller blocks: RTEMS_MESSAGE_QUEUE_RECEIVE_NOT_AVAILABLE_CALLER_BLOCKS -@end itemize - -@item MESSAGE_QUEUE_FLUSH -@itemize - -@item no messages flushed: RTEMS_MESSAGE_QUEUE_FLUSH_NO_MESSAGES_FLUSHED -@item messages flushed: RTEMS_MESSAGE_QUEUE_FLUSH_MESSAGES_FLUSHED -@end itemize - -@end itemize -@end ifinfo -@end ifset - -@ifset use-html -@html -<CENTER> - <TABLE COLS=2 WIDTH="80%" BORDER=2> -<TR><TD ALIGN=left><STRONG>MESSAGE_QUEUE_CREATE</STRONG></TD> - <TD ALIGN=center>RTEMS_MESSAGE_QUEUE_CREATE_ONLY</TD></TR> -<TR><TD ALIGN=left><STRONG>MESSAGE_QUEUE_IDENT</STRONG></TD> - <TD ALIGN=center>RTEMS_MESSAGE_QUEUE_IDENT_ONLY</TD></TR> -<TR><TD ALIGN=left><STRONG>MESSAGE_QUEUE_DELETE</STRONG></TD> - <TD ALIGN=center>RTEMS_MESSAGE_QUEUE_DELETE_ONLY</TD></TR> -<TR><TD ALIGN=left COLSPAN=2><STRONG>MESSAGE_QUEUE_SEND</STRONG></TD></TR> - <TR><TD ALIGN=left><dd>no waiting tasks</TD> - <TD ALIGN=center>RTEMS_MESSAGE_QUEUE_SEND_NO_WAITING_TASKS</TD></TR> - <TR><TD ALIGN=left><dd>task readied -- returns to caller</TD> - <TD ALIGN=center>RTEMS_MESSAGE_QUEUE_SEND_TASK_READIED_RETURNS_TO_CALLER</TD></TR> - <TR><TD ALIGN=left><dd>task readied -- preempts caller</TD> - <TD ALIGN=center>RTEMS_MESSAGE_QUEUE_SEND_TASK_READIED_PREEMPTS_CALLER</TD></TR> -<TR><TD ALIGN=left COLSPAN=2><STRONG>MESSAGE_QUEUE_URGENT</STRONG></TD></TR> - <TR><TD ALIGN=left><dd>no waiting tasks</TD> - <TD ALIGN=center>RTEMS_MESSAGE_QUEUE_URGENT_NO_WAITING_TASKS</TD></TR> - <TR><TD ALIGN=left><dd>task readied -- returns to caller</TD> - <TD ALIGN=center>RTEMS_MESSAGE_QUEUE_URGENT_TASK_READIED_RETURNS_TO_CALLER</TD></TR> - <TR><TD ALIGN=left><dd>task readied -- preempts caller</TD> - <TD ALIGN=center>RTEMS_MESSAGE_QUEUE_URGENT_TASK_READIED_PREEMPTS_CALLER</TD></TR> -<TR><TD ALIGN=left COLSPAN=2><STRONG>MESSAGE_QUEUE_BROADCAST</STRONG></TD></TR> - <TR><TD ALIGN=left><dd>no waiting tasks</TD> - <TD ALIGN=center>RTEMS_MESSAGE_QUEUE_BROADCAST_NO_WAITING_TASKS</TD></TR> - <TR><TD ALIGN=left><dd>task readied -- returns to caller</TD> - <TD ALIGN=center>RTEMS_MESSAGE_QUEUE_BROADCAST_TASK_READIED_RETURNS_TO_CALLER</TD></TR> - <TR><TD ALIGN=left><dd>task readied -- preempts caller</TD> - <TD ALIGN=center>RTEMS_MESSAGE_QUEUE_BROADCAST_TASK_READIED_PREEMPTS_CALLER</TD></TR> -<TR><TD ALIGN=left COLSPAN=2><STRONG>MESSAGE_QUEUE_RECEIVE</STRONG></TD></TR> - <TR><TD ALIGN=left><dd>available</TD> - <TD ALIGN=center>RTEMS_MESSAGE_QUEUE_RECEIVE_AVAILABLE</TD></TR> - <TR><TD ALIGN=left><dd>not available -- NO_WAIT</TD> - <TD ALIGN=center>RTEMS_MESSAGE_QUEUE_RECEIVE_NOT_AVAILABLE_NO_WAIT</TD></TR> - <TR><TD ALIGN=left><dd>not available -- caller blocks</TD> - <TD ALIGN=center>RTEMS_MESSAGE_QUEUE_RECEIVE_NOT_AVAILABLE_CALLER_BLOCKS</TD></TR> -<TR><TD ALIGN=left COLSPAN=2><STRONG>MESSAGE_QUEUE_FLUSH</STRONG></TD></TR> - <TR><TD ALIGN=left><dd>no messages flushed</TD> - <TD ALIGN=center>RTEMS_MESSAGE_QUEUE_FLUSH_NO_MESSAGES_FLUSHED</TD></TR> - <TR><TD ALIGN=left><dd>messages flushed</TD> - <TD ALIGN=center>RTEMS_MESSAGE_QUEUE_FLUSH_MESSAGES_FLUSHED</TD></TR> - - </TABLE> -</CENTER> -@end html -@end ifset - -@page -@section Event Manager - -@ifset use-tex -@tex -\centerline{\vbox{\offinterlineskip\halign{ -\span\rtemstimetable -\rtemsdirective{EVENT\_SEND} -\rtemscase{no task readied}{RTEMS_EVENT_SEND_NO_TASK_READIED} -\rtemscase{task readied -- returns to caller} - {RTEMS_EVENT_SEND_TASK_READIED_RETURNS_TO_CALLER} -\rtemscase{task readied -- preempts caller} - {RTEMS_EVENT_SEND_TASK_READIED_PREEMPTS_CALLER} -\rtemsdirective{EVENT\_RECEIVE} -\rtemscase{obtain current events}{RTEMS_EVENT_RECEIVE_OBTAIN_CURRENT_EVENTS} -\rtemscase{available}{RTEMS_EVENT_RECEIVE_AVAILABLE} -\rtemscase{not available -- NO\_WAIT}{RTEMS_EVENT_RECEIVE_NOT_AVAILABLE_NO_WAIT} -\rtemscase{not available -- caller blocks} - {RTEMS_EVENT_RECEIVE_NOT_AVAILABLE_CALLER_BLOCKS} -\rtemsendtimetable -}}\hfil} -@end tex -@end ifset - -@ifset use-ascii -@ifinfo -@itemize @bullet - -@item EVENT_SEND -@itemize - -@item no task readied: RTEMS_EVENT_SEND_NO_TASK_READIED -@item task readied -- returns to caller: RTEMS_EVENT_SEND_TASK_READIED_RETURNS_TO_CALLER -@item task readied -- preempts caller: RTEMS_EVENT_SEND_TASK_READIED_PREEMPTS_CALLER -@end itemize - -@item EVENT_RECEIVE -@itemize - -@item obtain current events: RTEMS_EVENT_RECEIVE_OBTAIN_CURRENT_EVENTS -@item available: RTEMS_EVENT_RECEIVE_AVAILABLE -@item not available -- NO_WAIT: RTEMS_EVENT_RECEIVE_NOT_AVAILABLE_NO_WAIT -@item not available -- caller blocks: RTEMS_EVENT_RECEIVE_NOT_AVAILABLE_CALLER_BLOCKS -@end itemize - -@end itemize -@end ifinfo -@end ifset - -@ifset use-html -@html -<CENTER> - <TABLE COLS=2 WIDTH="80%" BORDER=2> -<TR><TD ALIGN=left COLSPAN=2><STRONG>EVENT_SEND</STRONG></TD></TR> - <TR><TD ALIGN=left><dd>no task readied</TD> - <TD ALIGN=center>RTEMS_EVENT_SEND_NO_TASK_READIED</TD></TR> - <TR><TD ALIGN=left><dd>task readied -- returns to caller</TD> - <TD ALIGN=center>RTEMS_EVENT_SEND_TASK_READIED_RETURNS_TO_CALLER</TD></TR> - <TR><TD ALIGN=left><dd>task readied -- preempts caller</TD> - <TD ALIGN=center>RTEMS_EVENT_SEND_TASK_READIED_PREEMPTS_CALLER</TD></TR> -<TR><TD ALIGN=left COLSPAN=2><STRONG>EVENT_RECEIVE</STRONG></TD></TR> - <TR><TD ALIGN=left><dd>obtain current events</TD> - <TD ALIGN=center>RTEMS_EVENT_RECEIVE_OBTAIN_CURRENT_EVENTS</TD></TR> - <TR><TD ALIGN=left><dd>available</TD> - <TD ALIGN=center>RTEMS_EVENT_RECEIVE_AVAILABLE</TD></TR> - <TR><TD ALIGN=left><dd>not available -- NO_WAIT</TD> - <TD ALIGN=center>RTEMS_EVENT_RECEIVE_NOT_AVAILABLE_NO_WAIT</TD></TR> - <TR><TD ALIGN=left><dd>not available -- caller blocks</TD> - <TD ALIGN=center>RTEMS_EVENT_RECEIVE_NOT_AVAILABLE_CALLER_BLOCKS</TD></TR> - - </TABLE> -</CENTER> -@end html -@end ifset -@section Signal Manager - -@ifset use-tex -@tex -\centerline{\vbox{\offinterlineskip\halign{ -\span\rtemstimetable -\rtemsonecase{SIGNAL\_CATCH}{RTEMS_SIGNAL_CATCH_ONLY} -\rtemsdirective{SIGNAL\_SEND} -\rtemscase{returns to caller}{RTEMS_SIGNAL_SEND_RETURNS_TO_CALLER} -\rtemscase{signal to self}{RTEMS_SIGNAL_SEND_SIGNAL_TO_SELF} -\rtemsdirective{EXIT ASR OVERHEAD} -\rtemscase{returns to calling task} - {RTEMS_SIGNAL_EXIT_ASR_OVERHEAD_RETURNS_TO_CALLING_TASK} -\rtemscase{returns to preempting task} - {RTEMS_SIGNAL_EXIT_ASR_OVERHEAD_RETURNS_TO_PREEMPTING_TASK} -\rtemsendtimetable -}}\hfil} -@end tex -@end ifset - -@ifset use-ascii -@ifinfo -@itemize @bullet -@item SIGNAL_CATCH -@itemize - -@item only case: RTEMS_SIGNAL_CATCH_ONLY -@end itemize - -@item SIGNAL_SEND -@itemize - -@item returns to caller: RTEMS_SIGNAL_SEND_RETURNS_TO_CALLER -@item signal to self: RTEMS_SIGNAL_SEND_SIGNAL_TO_SELF -@end itemize - -@item EXIT ASR OVERHEAD -@itemize - -@item returns to calling task: RTEMS_SIGNAL_EXIT_ASR_OVERHEAD_RETURNS_TO_CALLING_TASK -@item returns to preempting task: RTEMS_SIGNAL_EXIT_ASR_OVERHEAD_RETURNS_TO_PREEMPTING_TASK -@end itemize - -@end itemize -@end ifinfo -@end ifset - -@ifset use-html -@html -<CENTER> - <TABLE COLS=2 WIDTH="80%" BORDER=2> -<TR><TD ALIGN=left><STRONG>SIGNAL_CATCH</STRONG></TD> - <TD ALIGN=center>RTEMS_SIGNAL_CATCH_ONLY</TD></TR> -<TR><TD ALIGN=left COLSPAN=2><STRONG>SIGNAL_SEND</TD></TR> - <TR><TD ALIGN=left><dd>returns to caller</TD> - <TD ALIGN=center>RTEMS_SIGNAL_SEND_RETURNS_TO_CALLER</TD></TR> - <TR><TD ALIGN=left><dd>signal to self</TD> - <TD ALIGN=center>RTEMS_SIGNAL_SEND_SIGNAL_TO_SELF</TD></TR> -<TR><TD ALIGN=left COLSPAN=2><STRONG>EXIT ASR OVERHEAD</TD></TR> - <TR><TD ALIGN=left><dd>returns to calling task</TD> - <TD ALIGN=center> - RTEMS_SIGNAL_EXIT_ASR_OVERHEAD_RETURNS_TO_CALLING_TASK</TD></TR> - <TR><TD ALIGN=left><dd>returns to preempting task</TD> - <TD ALIGN=center> - RTEMS_SIGNAL_EXIT_ASR_OVERHEAD_RETURNS_TO_PREEMPTING_TASK</TD></TR> - </TABLE> -</CENTER> -@end html -@end ifset - -@section Partition Manager - -@ifset use-tex -@tex -\centerline{\vbox{\offinterlineskip\halign{ -\span\rtemstimetable -\rtemsonecase{PARTITION\_CREATE}{RTEMS_PARTITION_CREATE_ONLY} -\rtemsonecase{PARTITION\_IDENT}{RTEMS_PARTITION_IDENT_ONLY} -\rtemsonecase{PARTITION\_DELETE}{RTEMS_PARTITION_DELETE_ONLY} -\rtemsdirective{PARTITION\_GET\_BUFFER} -\rtemscase{available}{RTEMS_PARTITION_GET_BUFFER_AVAILABLE} -\rtemscase{not available}{RTEMS_PARTITION_GET_BUFFER_NOT_AVAILABLE} -\rtemsonecase{PARTITION\_RETURN\_BUFFER} - {RTEMS_PARTITION_GET_BUFFER_NOT_AVAILABLE} -\rtemsendtimetable -}}\hfil} -@end tex -@end ifset - -@ifset use-ascii -@ifinfo -@itemize @bullet - -@item PARTITION_CREATE -@itemize - -@item only case: RTEMS_PARTITION_CREATE_ONLY -@end itemize - -@item PARTITION_IDENT -@itemize - -@item only case: RTEMS_PARTITION_IDENT_ONLY -@end itemize - -@item PARTITION_DELETE -@itemize - -@item only case: RTEMS_PARTITION_DELETE_ONLY -@end itemize - -@item PARTITION_GET_BUFFER -@itemize - -@item available: RTEMS_PARTITION_GET_BUFFER_AVAILABLE -@item not available: RTEMS_PARTITION_GET_BUFFER_NOT_AVAILABLE -@end itemize - -@item PARTITION_RETURN_BUFFER -@itemize - -@item only case: RTEMS_PARTITION_RETURN_BUFFER_ONLY -@end itemize - -@end itemize -@end ifinfo -@end ifset - -@ifset use-html -@html -<CENTER> - <TABLE COLS=2 WIDTH="80%" BORDER=2> -<TR><TD ALIGN=left><STRONG>PARTITION_CREATE</STRONG></TD> - <TD ALIGN=center>RTEMS_PARTITION_CREATE_ONLY</TD></TR> -<TR><TD ALIGN=left><STRONG>PARTITION_IDENT</STRONG></TD> - <TD ALIGN=center>RTEMS_PARTITION_IDENT_ONLY</TD></TR> -<TR><TD ALIGN=left><STRONG>PARTITION_DELETE</STRONG></TD> - <TD ALIGN=center>RTEMS_PARTITION_DELETE_ONLY</TD></TR> -<TR><TD ALIGN=left COLSPAN=2><STRONG>PARTITION_GET_BUFFER</STRONG></TD></TR> - <TR><TD ALIGN=left><dd>available</TD> - <TD ALIGN=center>RTEMS_PARTITION_GET_BUFFER_AVAILABLE</TD></TR> - <TR><TD ALIGN=left><dd>not available</TD> - <TD ALIGN=center>RTEMS_PARTITION_GET_BUFFER_NOT_AVAILABLE</TD></TR> - <TR><TD ALIGN=left><STRONG>PARTITION_RETURN_BUFFER</STRONG></TD> - <TD ALIGN=center>RTEMS_PARTITION_GET_BUFFER_NOT_AVAILABLE</TD></TR> - </TABLE> -</CENTER> -@end html -@end ifset - -@page -@section Region Manager - -@ifset use-tex -@tex -\centerline{\vbox{\offinterlineskip\halign{ -\span\rtemstimetable -\rtemsonecase{REGION\_CREATE}{RTEMS_REGION_CREATE_ONLY} -\rtemsonecase{REGION\_IDENT}{RTEMS_REGION_IDENT_ONLY} -\rtemsonecase{REGION\_DELETE}{RTEMS_REGION_DELETE_ONLY} -\rtemsdirective{REGION\_GET\_SEGMENT} -\rtemscase{available}{RTEMS_REGION_GET_SEGMENT_AVAILABLE} -\rtemscase{not available -- NO\_WAIT} - {RTEMS_REGION_GET_SEGMENT_NOT_AVAILABLE_NO_WAIT} -\rtemscase{not available -- caller blocks} - {RTEMS_REGION_GET_SEGMENT_NOT_AVAILABLE_CALLER_BLOCKS} -\rtemsdirective{REGION\_RETURN\_SEGMENT} -\rtemscase{no waiting tasks}{RTEMS_REGION_RETURN_SEGMENT_NO_WAITING_TASKS} -\rtemscase{task readied -- returns to caller} - {RTEMS_REGION_RETURN_SEGMENT_TASK_READIED_RETURNS_TO_CALLER} -\rtemscase{task readied -- preempts caller} - {RTEMS_REGION_RETURN_SEGMENT_TASK_READIED_PREEMPTS_CALLER} -\rtemsendtimetable -}}\hfil} -@end tex -@end ifset - -@ifset use-ascii -@ifinfo -@itemize @bullet - -@item REGION_CREATE -@itemize - -@item only case: RTEMS_REGION_CREATE_ONLY -@end itemize - -@item REGION_IDENT -@itemize - -@item only case: RTEMS_REGION_IDENT_ONLY -@end itemize - -@item REGION_DELETE -@itemize - -@item only case: RTEMS_REGION_DELETE_ONLY -@end itemize - -@item REGION_GET_SEGMENT -@itemize - -@item available: RTEMS_REGION_GET_SEGMENT_AVAILABLE -@item not available -- NO_WAIT: RTEMS_REGION_GET_SEGMENT_NOT_AVAILABLE_NO_WAIT -@item not available -- caller blocks: RTEMS_REGION_GET_SEGMENT_NOT_AVAILABLE_CALLER_BLOCKS -@end itemize - -@item REGION_RETURN_SEGMENT -@itemize - -@item no waiting tasks: RTEMS_REGION_RETURN_SEGMENT_NO_WAITING_TASKS -@item task readied -- returns to caller: RTEMS_REGION_RETURN_SEGMENT_TASK_READIED_RETURNS_TO_CALLER -@item task readied -- preempts caller: RTEMS_REGION_RETURN_SEGMENT_TASK_READIED_PREEMPTS_CALLER -@end itemize - -@end itemize -@end ifinfo -@end ifset - -@ifset use-html -@html -<CENTER> - <TABLE COLS=2 WIDTH="80%" BORDER=2> -<TR><TD ALIGN=left><STRONG>REGION_CREATE</STRONG></TD> - <TD ALIGN=center>RTEMS_REGION_CREATE_ONLY</TD></TR> -<TR><TD ALIGN=left><STRONG>REGION_IDENT</STRONG></TD> - <TD ALIGN=center>RTEMS_REGION_IDENT_ONLY</TD></TR> -<TR><TD ALIGN=left><STRONG>REGION_DELETE</STRONG></TD> - <TD ALIGN=center>RTEMS_REGION_DELETE_ONLY</TD></TR> -<TR><TD ALIGN=left COLSPAN=2><STRONG>REGION_GET_SEGMENT</TD></TR> - <TR><TD ALIGN=left><dd>available</TD> - <TD ALIGN=center>RTEMS_REGION_GET_SEGMENT_AVAILABLE</TD></TR> - <TR><TD ALIGN=left><dd>not available -- NO_WAIT</TD> - <TD ALIGN=center> - RTEMS_REGION_GET_SEGMENT_NOT_AVAILABLE_NO_WAIT</TD></TR> - <TR><TD ALIGN=left><dd>not available -- caller blocks</TD> - <TD ALIGN=center> - RTEMS_REGION_GET_SEGMENT_NOT_AVAILABLE_CALLER_BLOCKS</TD></TR> -<TR><TD ALIGN=left COLSPAN=2><STRONG>REGION_RETURN_SEGMENT</TD></TR> - <TR><TD ALIGN=left><dd>no waiting tasks</TD> - <TD ALIGN=center>RTEMS_REGION_RETURN_SEGMENT_NO_WAITING_TASKS</TD></TR> - <TR><TD ALIGN=left><dd>task readied -- returns to caller</TD> - <TD ALIGN=center> - RTEMS_REGION_RETURN_SEGMENT_TASK_READIED_RETURNS_TO_CALLER</TD></TR> - <TR><TD ALIGN=left><dd>task readied -- preempts caller</TD> - <TD ALIGN=center> - RTEMS_REGION_RETURN_SEGMENT_TASK_READIED_PREEMPTS_CALLER</TD></TR> - </TABLE> -</CENTER> -@end html -@end ifset - -@section Dual-Ported Memory Manager - -@ifset use-tex -@tex -\centerline{\vbox{\offinterlineskip\halign{ -\span\rtemstimetable -\rtemsonecase{PORT\_CREATE}{RTEMS_PORT_CREATE_ONLY} -\rtemsonecase{PORT\_IDENT}{RTEMS_PORT_IDENT_ONLY} -\rtemsonecase{PORT\_DELETE}{RTEMS_PORT_DELETE_ONLY} -\rtemsonecase{PORT\_INTERNAL\_TO\_EXTERNAL} - {RTEMS_PORT_INTERNAL_TO_EXTERNAL_ONLY} -\rtemsonecase{PORT\_EXTERNAL\_TO\_INTERNAL} - {RTEMS_PORT_EXTERNAL_TO_INTERNAL_ONLY} -\rtemsendtimetable -}}\hfil} -@end tex -@end ifset - -@ifset use-ascii -@ifinfo -@itemize @bullet - -@item PORT_CREATE -@itemize - -@item only case: RTEMS_PORT_CREATE_ONLY -@end itemize - -@item PORT_IDENT -@itemize - -@item only case: RTEMS_PORT_IDENT_ONLY -@end itemize - -@item PORT_DELETE -@itemize - -@item only case: RTEMS_PORT_DELETE_ONLY -@end itemize - -@item PORT_INTERNAL_TO_EXTERNAL -@itemize - -@item only case: RTEMS_PORT_INTERNAL_TO_EXTERNAL_ONLY -@end itemize - -@item PORT_EXTERNAL_TO_INTERNAL -@itemize - -@item only case: RTEMS_PORT_EXTERNAL_TO_INTERNAL_ONLY -@end itemize - -@end itemize -@end ifinfo -@end ifset - -@ifset use-html -@html -<CENTER> - <TABLE COLS=2 WIDTH="80%" BORDER=2> -<TR><TD ALIGN=left><STRONG>PORT_CREATE</STRONG></TD> - <TD ALIGN=center>RTEMS_PORT_CREATE_ONLY</TD></TR> -<TR><TD ALIGN=left><STRONG>PORT_IDENT</STRONG></TD> - <TD ALIGN=center>RTEMS_PORT_IDENT_ONLY</TD></TR> -<TR><TD ALIGN=left><STRONG>PORT_DELETE</STRONG></TD> - <TD ALIGN=center>RTEMS_PORT_DELETE_ONLY</TD></TR> -<TR><TD ALIGN=left><STRONG>PORT_INTERNAL_TO_EXTERNAL</STRONG></TD> - <TD ALIGN=center>RTEMS_PORT_INTERNAL_TO_EXTERNAL_ONLY</TD></TR> -<TR><TD ALIGN=left><STRONG>PORT_EXTERNAL_TO_INTERNAL</STRONG></TD> - <TD ALIGN=center>RTEMS_PORT_EXTERNAL_TO_INTERNAL_ONLY</TD></TR> - - </TABLE> -</CENTER> -@end html -@end ifset - -@section I/O Manager - -@ifset use-tex -@tex -\centerline{\vbox{\offinterlineskip\halign{ -\span\rtemstimetable -\rtemsonecase{IO\_INITIALIZE}{RTEMS_IO_INITIALIZE_ONLY} -\rtemsonecase{IO\_OPEN}{RTEMS_IO_OPEN_ONLY} -\rtemsonecase{IO\_CLOSE}{RTEMS_IO_CLOSE_ONLY} -\rtemsonecase{IO\_READ}{RTEMS_IO_READ_ONLY} -\rtemsonecase{IO\_WRITE}{RTEMS_IO_WRITE_ONLY} -\rtemsonecase{IO\_CONTROL}{RTEMS_IO_CONTROL_ONLY} -\rtemsendtimetable -}}\hfil} -@end tex -@end ifset - -@ifset use-ascii -@ifinfo -@itemize @bullet - -@item IO_INITIALIZE -@itemize - -@item only case: RTEMS_IO_INITIALIZE_ONLY -@end itemize - -@item IO_OPEN -@itemize - -@item only case: RTEMS_IO_OPEN_ONLY -@end itemize - -@item IO_CLOSE -@itemize - -@item only case: RTEMS_IO_CLOSE_ONLY -@end itemize - -@item IO_READ -@itemize - -@item only case: RTEMS_IO_READ_ONLY -@end itemize - -@item IO_WRITE -@itemize - -@item only case: RTEMS_IO_WRITE_ONLY -@end itemize - -@item IO_CONTROL -@itemize - -@item only case: RTEMS_IO_CONTROL_ONLY -@end itemize - -@end itemize -@end ifinfo -@end ifset - -@ifset use-html -@html -<CENTER> - <TABLE COLS=2 WIDTH="80%" BORDER=2> -<TR><TD ALIGN=left><STRONG>IO_INITIALIZE</STRONG></TD> - <TD ALIGN=center>RTEMS_IO_INITIALIZE_ONLY</TD></TR> -<TR><TD ALIGN=left><STRONG>IO_OPEN</STRONG></TD> - <TD ALIGN=center>RTEMS_IO_OPEN_ONLY</TD></TR> -<TR><TD ALIGN=left><STRONG>IO_CLOSE</STRONG></TD> - <TD ALIGN=center>RTEMS_IO_CLOSE_ONLY</TD></TR> -<TR><TD ALIGN=left><STRONG>IO_READ</STRONG></TD> - <TD ALIGN=center>RTEMS_IO_READ_ONLY</TD></TR> -<TR><TD ALIGN=left><STRONG>IO_WRITE</STRONG></TD> - <TD ALIGN=center>RTEMS_IO_WRITE_ONLY</TD></TR> -<TR><TD ALIGN=left><STRONG>IO_CONTROL</STRONG></TD> - <TD ALIGN=center>RTEMS_IO_CONTROL_ONLY</TD></TR> - </TABLE> -</CENTER> -@end html -@end ifset - -@section Rate Monotonic Manager - -@ifset use-tex -@tex -\centerline{\vbox{\offinterlineskip\halign{ -\span\rtemstimetable -\rtemsonecase{RATE\_MONOTONIC\_CREATE}{RTEMS_RATE_MONOTONIC_CREATE_ONLY} -\rtemsonecase{RATE\_MONOTONIC\_IDENT}{RTEMS_RATE_MONOTONIC_IDENT_ONLY} -\rtemsonecase{RATE\_MONOTONIC\_CANCEL}{RTEMS_RATE_MONOTONIC_CANCEL_ONLY} -\rtemsdirective{RATE\_MONOTONIC\_DELETE} -\rtemscase{active}{RTEMS_RATE_MONOTONIC_DELETE_ACTIVE} -\rtemscase{inactive}{RTEMS_RATE_MONOTONIC_DELETE_INACTIVE} -\rtemsdirective{RATE\_MONOTONIC\_PERIOD} -\rtemscase{initiate period -- returns to caller} - {RTEMS_RATE_MONOTONIC_PERIOD_INITIATE_PERIOD_RETURNS_TO_CALLER} -\rtemscase{conclude period -- caller blocks} - {RTEMS_RATE_MONOTONIC_PERIOD_CONCLUDE_PERIOD_CALLER_BLOCKS} -\rtemscase{obtain status}{RTEMS_RATE_MONOTONIC_PERIOD_OBTAIN_STATUS} -\rtemsendtimetable -}}\hfil} -@end tex -@end ifset - -@ifset use-ascii -@ifinfo -@itemize @bullet - -@item RATE_MONOTONIC_CREATE -@itemize - -@item only case: RTEMS_RATE_MONOTONIC_CREATE_ONLY -@end itemize - -@item RATE_MONOTONIC_IDENT -@itemize - -@item only case: RTEMS_RATE_MONOTONIC_IDENT_ONLY -@end itemize - -@item RATE_MONOTONIC_CANCEL -@itemize - -@item only case: RTEMS_RATE_MONOTONIC_CANCEL_ONLY -@end itemize - -@item RATE_MONOTONIC_DELETE -@itemize - -@item active: RTEMS_RATE_MONOTONIC_DELETE_ACTIVE -@item inactive: RTEMS_RATE_MONOTONIC_DELETE_INACTIVE -@end itemize - -@item RATE_MONOTONIC_PERIOD -@itemize - -@item initiate period -- returns to caller: RTEMS_RATE_MONOTONIC_PERIOD_INITIATE_PERIOD_RETURNS_TO_CALLER -@item conclude period -- caller blocks: RTEMS_RATE_MONOTONIC_PERIOD_CONCLUDE_PERIOD_CALLER_BLOCKS -@item obtain status: RTEMS_RATE_MONOTONIC_PERIOD_OBTAIN_STATUS -@end itemize - -@end itemize -@end ifinfo -@end ifset - -@ifset use-html -@html -<CENTER> - <TABLE COLS=2 WIDTH="80%" BORDER=2> -<TR><TD ALIGN=left><STRONG>RATE_MONOTONIC_CREATE</STRONG></TD> - <TD ALIGN=center>RTEMS_RATE_MONOTONIC_CREATE_ONLY</TD></TR> -<TR><TD ALIGN=left><STRONG>RATE_MONOTONIC_IDENT</STRONG></TD> - <TD ALIGN=center>RTEMS_RATE_MONOTONIC_IDENT_ONLY</TD></TR> -<TR><TD ALIGN=left><STRONG>RATE_MONOTONIC_CANCEL</STRONG></TD> - <TD ALIGN=center>RTEMS_RATE_MONOTONIC_CANCEL_ONLY</TD></TR> -<TR><TD ALIGN=left COLSPAN=2><STRONG>RATE_MONOTONIC_DELETE</TD></TR> - <TR><TD ALIGN=left><dd>active</TD> - <TD ALIGN=center>RTEMS_RATE_MONOTONIC_DELETE_ACTIVE</TD></TR> - <TR><TD ALIGN=left><dd>inactive</TD> - <TD ALIGN=center>RTEMS_RATE_MONOTONIC_DELETE_INACTIVE</TD></TR> -<TR><TD ALIGN=left COLSPAN=2><STRONG>RATE_MONOTONIC_PERIOD</TD></TR> - <TR><TD ALIGN=left><dd>initiate period -- returns to caller</TD> - <TD ALIGN=center> - RTEMS_RATE_MONOTONIC_PERIOD_INITIATE_PERIOD_RETURNS_TO_CALLER</TD></TR> - <TR><TD ALIGN=left><dd>conclude period -- caller blocks</TD> - <TD ALIGN=center> - RTEMS_RATE_MONOTONIC_PERIOD_CONCLUDE_PERIOD_CALLER_BLOCKS</TD></TR> - <TR><TD ALIGN=left><dd>obtain status</TD> - <TD ALIGN=center>RTEMS_RATE_MONOTONIC_PERIOD_OBTAIN_STATUS</TD></TR> - </TABLE> -</CENTER> -@end html -@end ifset - -@tex -\global\advance \smallskipamount by 4pt -@end tex diff --git a/doc/common/timing.t b/doc/common/timing.t deleted file mode 100644 index 7d9f9a415f..0000000000 --- a/doc/common/timing.t +++ /dev/null @@ -1,396 +0,0 @@ -@c -@c COPYRIGHT (c) 1988-2002. -@c On-Line Applications Research Corporation (OAR). -@c All rights reserved. -@c -@c $Id$ -@c - -@chapter Timing Specification - -@section Introduction - -This chapter provides information pertaining to the -measurement of the performance of RTEMS, the methods of -gathering the timing data, and the usefulness of the data. Also -discussed are other time critical aspects of RTEMS that affect -an applications design and ultimate throughput. These aspects -include determinancy, interrupt latency and context switch times. - -@section Philosophy - -Benchmarks are commonly used to evaluate the -performance of software and hardware. Benchmarks can be an -effective tool when comparing systems. Unfortunately, -benchmarks can also be manipulated to justify virtually any -claim. Benchmarks of real-time executives are difficult to -evaluate for a variety of reasons. Executives vary in the -robustness of features and options provided. Even when -executives compare favorably in functionality, it is quite -likely that different methodologies were used to obtain the -timing data. Another problem is that some executives provide -times for only a small subset of directives, This is typically -justified by claiming that these are the only time-critical -directives. The performance of some executives is also very -sensitive to the number of objects in the system. To obtain any -measure of usefulness, the performance information provided for -an executive should address each of these issues. - -When evaluating the performance of a real-time -executive, one typically considers the following areas: -determinancy, directive times, worst case interrupt latency, and -context switch time. Unfortunately, these areas do not have -standard measurement methodologies. This allows vendors to -manipulate the results such that their product is favorably -represented. We have attempted to provide useful and meaningful -timing information for RTEMS. To insure the usefulness of our -data, the methodology and definitions used to obtain and -describe the data are also documented. - -@subsection Determinancy - -The correctness of data in a real-time system must -always be judged by its timeliness. In many real-time systems, -obtaining the correct answer does not necessarily solve the -problem. For example, in a nuclear reactor it is not enough to -determine that the core is overheating. This situation must be -detected and acknowledged early enough that corrective action -can be taken and a meltdown avoided. - -Consequently, a system designer must be able to -predict the worst-case behavior of the application running under -the selected executive. In this light, it is important that a -real-time system perform consistently regardless of the number -of tasks, semaphores, or other resources allocated. An -important design goal of a real-time executive is that all -internal algorithms be fixed-cost. Unfortunately, this goal is -difficult to completely meet without sacrificing the robustness -of the executive's feature set. - -Many executives use the term deterministic to mean -that the execution times of their services can be predicted. -However, they often provide formulas to modify execution times -based upon the number of objects in the system. This usage is -in sharp contrast to the notion of deterministic meaning fixed -cost. - -Almost all RTEMS directives execute in a fixed amount -of time regardless of the number of objects present in the -system. The primary exception occurs when a task blocks while -acquiring a resource and specifies a non-zero timeout interval. - -Other exceptions are message queue broadcast, -obtaining a variable length memory block, object name to ID -translation, and deleting a resource upon which tasks are -waiting. In addition, the time required to service a clock tick -interrupt is based upon the number of timeouts and other -"events" which must be processed at that tick. This second -group is composed primarily of capabilities which are inherently -non-deterministic but are infrequently used in time critical -situations. The major exception is that of servicing a clock -tick. However, most applications have a very small number of -timeouts which expire at exactly the same millisecond (usually -none, but occasionally two or three). - -@subsection Interrupt Latency - -Interrupt latency is the delay between the CPU's -receipt of an interrupt request and the execution of the first -application-specific instruction in an interrupt service -routine. Interrupts are a critical component of most real-time -applications and it is critical that they be acted upon as -quickly as possible. - -Knowledge of the worst case interrupt latency of an -executive aids the application designer in determining the -maximum period of time between the generation of an interrupt -and an interrupt handler responding to that interrupt. The -interrupt latency of an system is the greater of the executive's -and the applications's interrupt latency. If the application -disables interrupts longer than the executive, then the -application's interrupt latency is the system's worst case -interrupt disable period. - -The worst case interrupt latency for a real-time -executive is based upon the following components: - -@itemize @bullet -@item the longest period of time interrupts are disabled -by the executive, - -@item the overhead required by the executive at the -beginning of each ISR, - -@item the time required for the CPU to vector the -interrupt, and - -@item for some microprocessors, the length of the longest -instruction. -@end itemize - -The first component is irrelevant if an interrupt -occurs when interrupts are enabled, although it must be included -in a worst case analysis. The third and fourth components are -particular to a CPU implementation and are not dependent on the -executive. The fourth component is ignored by this document -because most applications use only a subset of a -microprocessor's instruction set. Because of this the longest -instruction actually executed is application dependent. The -worst case interrupt latency of an executive is typically -defined as the sum of components (1) and (2). The second -component includes the time necessry for RTEMS to save registers -and vector to the user-defined handler. RTEMS includes the -third component, the time required for the CPU to vector the -interrupt, because it is a required part of any interrupt. - -Many executives report the maximum interrupt disable -period as their interrupt latency and ignore the other -components. This results in very low worst-case interrupt -latency times which are not indicative of actual application -performance. The definition used by RTEMS results in a higher -interrupt latency being reported, but accurately reflects the -longest delay between the CPU's receipt of an interrupt request -and the execution of the first application-specific instruction -in an interrupt service routine. - -The actual interrupt latency times are reported in -the Timing Data chapter of this supplement. - -@subsection Context Switch Time - -An RTEMS context switch is defined as the act of -taking the CPU from the currently executing task and giving it -to another task. This process involves the following components: - -@itemize @bullet -@item Saving the hardware state of the current task. - -@item Optionally, invoking the TASK_SWITCH user extension. - -@item Restoring the hardware state of the new task. -@end itemize - -RTEMS defines the hardware state of a task to include -the CPU's data registers, address registers, and, optionally, -floating point registers. - -Context switch time is often touted as a performance -measure of real-time executives. However, a context switch is -performed as part of a directive's actions and should be viewed -as such when designing an application. For example, if a task -is unable to acquire a semaphore and blocks, a context switch is -required to transfer control from the blocking task to a new -task. From the application's perspective, the context switch is -a direct result of not acquiring the semaphore. In this light, -the context switch time is no more relevant than the performance -of any other of the executive's subroutines which are not -directly accessible by the application. - -In spite of the inappropriateness of using the -context switch time as a performance metric, RTEMS context -switch times for floating point and non-floating points tasks -are provided for comparison purposes. Of the executives which -actually support floating point operations, many do not report -context switch times for floating point context switch time. -This results in a reported context switch time which is -meaningless for an application with floating point tasks. - -The actual context switch times are reported in the -Timing Data chapter of this supplement. - -@subsection Directive Times - -Directives are the application's interface to the -executive, and as such their execution times are critical in -determining the performance of the application. For example, an -application using a semaphore to protect a critical data -structure should be aware of the time required to acquire and -release a semaphore. In addition, the application designer can -utilize the directive execution times to evaluate the -performance of different synchronization and communication -mechanisms. - -The actual directive execution times are reported in -the Timing Data chapter of this supplement. - -@section Methodology - -@subsection Software Platform - -The RTEMS timing suite is written in C. The overhead -of passing arguments to RTEMS by C is not timed. The times -reported represent the amount of time from entering to exiting -RTEMS. - -The tests are based upon one of two execution models: -(1) single invocation times, and (2) average times of repeated -invocations. Single invocation times are provided for -directives which cannot easily be invoked multiple times in the -same scenario. For example, the times reported for entering and -exiting an interrupt service routine are single invocation -times. The second model is used for directives which can easily -be invoked multiple times in the same scenario. For example, -the times reported for semaphore obtain and semaphore release -are averages of multiple invocations. At least 100 invocations -are used to obtain the average. - -@subsection Hardware Platform - -Since RTEMS supports a variety of processors, the -hardware platform used to gather the benchmark times must also -vary. Therefore, for each processor supported the hardware -platform must be defined. Each definition will include a brief -description of the target hardware platform including the clock -speed, memory wait states encountered, and any other pertinent -information. This definition may be found in the processor -dependent timing data chapter within this supplement. - -@subsection What is measured? - -An effort was made to provide execution times for a -large portion of RTEMS. Times were provided for most directives -regardless of whether or not they are typically used in time -critical code. For example, execution times are provided for -all object create and delete directives, even though these are -typically part of application initialization. - -The times include all RTEMS actions necessary in a -particular scenario. For example, all times for blocking -directives include the context switch necessary to transfer -control to a new task. Under no circumstances is it necessary -to add context switch time to the reported times. - -The following list describes the objects created by -the timing suite: - -@itemize @bullet -@item All tasks are non-floating point. - -@item All tasks are created as local objects. - -@item No timeouts are used on blocking directives. - -@item All tasks wait for objects in FIFO order. - -@end itemize - -In addition, no user extensions are configured. - -@subsection What is not measured? - -The times presented in this document are not intended -to represent best or worst case times, nor are all directives -included. For example, no times are provided for the initialize -executive and fatal_error_occurred directives. Other than the -exceptions detailed in the Determinancy section, all directives -will execute in the fixed length of time given. - -Other than entering and exiting an interrupt service -routine, all directives were executed from tasks and not from -interrupt service routines. Directives invoked from ISRs, when -allowable, will execute in slightly less time than when invoked -from a task because rescheduling is delayed until the interrupt -exits. - -@subsection Terminology - -The following is a list of phrases which are used to -distinguish individual execution paths of the directives taken -during the RTEMS performance analysis: - -@table @b -@item another task -The directive was performed -on a task other than the calling task. - -@item available -A task attempted to obtain a resource and -immediately acquired it. - -@item blocked task -The task operated upon by the -directive was blocked waiting for a resource. - -@item caller blocks -The requested resoure was not -immediately available and the calling task chose to wait. - -@item calling task -The task invoking the directive. - -@item messages flushed -One or more messages was flushed -from the message queue. - -@item no messages flushed -No messages were flushed from -the message queue. - -@item not available -A task attempted to obtain a resource -and could not immediately acquire it. - -@item no reschedule -The directive did not require a -rescheduling operation. - -@item NO_WAIT -A resource was not available and the -calling task chose to return immediately via the NO_WAIT option -with an error. - -@item obtain current -The current value of something was -requested by the calling task. - -@item preempts caller -The release of a resource caused a -task of higher priority than the calling to be readied and it -became the executing task. - -@item ready task -The task operated upon by the directive -was in the ready state. - -@item reschedule -The actions of the directive -necessitated a rescheduling operation. - -@item returns to caller -The directive succeeded and -immediately returned to the calling task. - -@item returns to interrupted task -The instructions -executed immediately following this interrupt will be in the -interrupted task. - -@item returns to nested interrupt -The instructions -executed immediately following this interrupt will be in a -previously interrupted ISR. - -@item returns to preempting task -The instructions -executed immediately following this interrupt or signal handler -will be in a task other than the interrupted task. - -@item signal to self -The signal set was sent to the -calling task and signal processing was enabled. - -@item suspended task -The task operated upon by the -directive was in the suspended state. - -@item task readied -The release of a resource caused a -task of lower or equal priority to be readied and the calling -task remained the executing task. - -@item yield -The act of attempting to voluntarily release -the CPU. - -@end table - |