Commit eeb9d993 authored by Damien George's avatar Damien George
Browse files

docs/library/machine: Update description of disable/enable IRQ funcs.

parent 7df9291b
...@@ -24,17 +24,15 @@ Interrupt related functions ...@@ -24,17 +24,15 @@ Interrupt related functions
.. function:: disable_irq() .. function:: disable_irq()
Disable interrupt requests. Disable interrupt requests.
Returns the previous IRQ state: ``False``/``True`` for disabled/enabled IRQs Returns the previous IRQ state which should be considered an opaque value.
respectively. This return value can be passed to enable_irq to restore This return value should be passed to the ``enable_irq`` function to restore
the IRQ to its original state. interrupts to their original state, before ``disable_irq`` was called.
.. function:: enable_irq(state=True) .. function:: enable_irq(state)
Enable interrupt requests. Re-enable interrupt requests.
If ``state`` is ``True`` (the default value) then IRQs are enabled. The ``state`` parameter should be the value that was returned from the most
If ``state`` is ``False`` then IRQs are disabled. The most common use of recent call to the ``disable_irq`` function.
this function is to pass it the value returned by ``disable_irq`` to
exit a critical section.
Power related functions Power related functions
----------------------- -----------------------
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment