path: root/doc/user/signal.t
diff options
Diffstat (limited to 'doc/user/signal.t')
1 files changed, 25 insertions, 2 deletions
diff --git a/doc/user/signal.t b/doc/user/signal.t
index 1b9e34da3d..ead17bf520 100644
--- a/doc/user/signal.t
+++ b/doc/user/signal.t
@@ -8,6 +8,8 @@
@chapter Signal Manager
+@cindex signals
@section Introduction
The signal manager provides the capabilities required
@@ -23,6 +25,9 @@ signal manager are:
@subsection Signal Manager Definitions
+@cindex asynchronous signal routine
+@cindex ASR
The signal manager allows a task to optionally define
an asynchronous signal routine (ASR). An ASR is to a task what
an ISR is to an application's set of tasks. When the processor
@@ -43,6 +48,9 @@ with a valid ASR, but has not been processed by that task's ASR.
@subsection A Comparison of ASRs and ISRs
+@cindex ASR vs. ISR
+@cindex ISR vs. ASR
The format of an ASR is similar to that of an ISR
with the following exceptions:
@@ -65,6 +73,8 @@ result, does not have a task mode.
@subsection Building a Signal Set
+@cindex signal set, building
A signal set is built by a bitwise OR of the desired
signals. The set of valid signals is @code{@value{RPREFIX}SIGNAL_0} through
@code{@value{RPREFIX}SIGNAL_31}. If a signal is not explicitly specified in the
@@ -84,6 +94,8 @@ to the @code{@value{DIRPREFIX}signal_send} directive should be
@subsection Building an ASR Mode
+@cindex ASR mode, building
In general, an ASR's mode is built by a bitwise OR of
the desired mode components. The set of valid mode components
is the same as those allowed with the task_create and task_mode
@@ -230,13 +242,19 @@ A subsection is dedicated to each of this manager's directives
and describes the calling sequence, related constants, usage,
and status codes.
@subsection SIGNAL_CATCH - Establish an ASR
+@cindex establish an ASR
+@cindex install an ASR
@ifset is-C
-@c @findex rtems_signal_catch
+@findex rtems_signal_catch
rtems_status_code rtems_signal_catch(
rtems_asr_entry asr_handler,
@@ -302,13 +320,18 @@ The following task mode constants are defined by RTEMS:
@code{@value{RPREFIX}INTERRUPT_MASK} and sets interrupts level n
@end itemize
@subsection SIGNAL_SEND - Send signal set to a task
+@cindex send signal set
@ifset is-C
-@c @findex rtems_signal_send
+@findex rtems_signal_send
rtems_status_code rtems_signal_send(
rtems_id id,