third_party.pigweed.src/pw_interrupt/docs.rst
Ewout van Bekkum bd4906ce52 pw_interrupt: Adds a basic interrupt module
Adds a basic interrupt module which for now only gives you the
ability to determine if you're executing in an interrupt
context.

In addition this also adds the first two backends of this module's
context facade (pw_interrupt_cortex_m:context_{armv7m,armv8m}).

Change-Id: If0056997f814b0ac33cb0209fc9b247c2599594e
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/24421
Commit-Queue: Ewout van Bekkum <ewout@google.com>
Reviewed-by: Keir Mierle <keir@google.com>
Reviewed-by: Armando Montanez <amontanez@google.com>
2020-12-01 21:44:44 +00:00

13 lines
368 B
ReStructuredText

.. _module-pw_interrupt:
------------
pw_interrupt
------------
Pigweed's interrupt module provides a consistent interface for to determine
whether one is currently executing in an interrupt context (IRQ or NMI) or not.
.. c:function:: bool InInterruptContext()
Returns true if currently executing within an interrupt service routine
handling an IRQ or NMI.:w!