third_party.pigweed.src/pw_interrupt/docs.rst

.. _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!
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-11-11 21:42:13 +00:00			`.. _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()`
docs: Update Sphinx; remove Markdown; add CSS This completes the update of Sphinx and RST by removing the legacy Markdown support. It also adds custom CSS skeleton. Change-Id: I398a21208772cf2d2dd32dee0adac768630dd575 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/40621 Commit-Queue: Keir Mierle <keir@google.com> Pigweed-Auto-Submit: Keir Mierle <keir@google.com> Reviewed-by: Anthony DiGirolamo <tonymd@google.com> Reviewed-by: Ewout van Bekkum <ewout@google.com> 2021-04-12 16:08:33 +00:00
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-11-11 21:42:13 +00:00			`Returns true if currently executing within an interrupt service routine`
			`handling an IRQ or NMI.:w!`