c-user: Clarify rtems_interrupt_flash()

This commit is contained in:
Sebastian Huber 2017-11-17 13:46:52 +01:00
parent 6efb6fadbe
commit e2a1a3ab2a

View File

@ -404,18 +404,22 @@ DIRECTIVE STATUS CODES:
NONE NONE
DESCRIPTION: DESCRIPTION:
This directive temporarily enables maskable interrupts to the ``level`` This directive is functionally equivalent to a
which was returned by a previous call to ``rtems_interrupt_disable``. ``rtems_interrupt_enable( level )`` immediately followed by a
Immediately prior to invoking this directive, maskable interrupts should be ``rtems_interrupt_disable( level )``. On some
disabled by a call to ``rtems_interrupt_disable`` and will be redisabled architectures it is possible to provide an optimized implementation for
when this directive returns to the caller. this sequence.
NOTES: NOTES:
This directive will not cause the calling task to be preempted. This directive will not cause the calling task to be preempted.
This directive is only available on uni-processor configurations. The This directive is only available in uni-processor configurations. The
directives ``rtems_interrupt_local_disable`` and directives ``rtems_interrupt_local_disable`` and
``rtems_interrupt_local_enable`` is available on all configurations. ``rtems_interrupt_local_enable`` are available in all configurations.
Historically, the interrupt flash directive was heavily used in the
operating system implementation. However, this is no longer the case. The
interrupt flash directive is provided for backward compatibility reasons.
.. raw:: latex .. raw:: latex