diff options
| author | Damien George <damien.p.george@gmail.com> | 2016-05-20 13:31:44 +0100 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2016-05-26 15:47:47 +0100 |
| commit | a3dc2c60312905f6732efab2cd2b5be4832dea73 (patch) | |
| tree | fce4f83f6861dc92e19d7923011aff6261313724 /docs/library/machine.rst | |
| parent | 9a368ae831143e1dd47eb302e85f39862de3a758 (diff) | |
| download | micropython-a3dc2c60312905f6732efab2cd2b5be4832dea73.tar.gz micropython-a3dc2c60312905f6732efab2cd2b5be4832dea73.zip | |
docs/machine: Make disable_irq and enable_irq docs available for all.
Diffstat (limited to 'docs/library/machine.rst')
| -rw-r--r-- | docs/library/machine.rst | 28 |
1 files changed, 13 insertions, 15 deletions
diff --git a/docs/library/machine.rst b/docs/library/machine.rst index 14d75cb466..7bf73248f6 100644 --- a/docs/library/machine.rst +++ b/docs/library/machine.rst @@ -18,25 +18,23 @@ Reset related functions Get the reset cause. See :ref:`constants <machine_constants>` for the possible return values. -.. only:: port_wipy - - Interrupt related functions - --------------------------- +Interrupt related functions +--------------------------- - .. function:: disable_irq() +.. function:: disable_irq() - Disable interrupt requests. - Returns the previous IRQ state: ``False``/``True`` for disabled/enabled IRQs - respectively. This return value can be passed to enable_irq to restore - the IRQ to its original state. + Disable interrupt requests. + Returns the previous IRQ state: ``False``/``True`` for disabled/enabled IRQs + respectively. This return value can be passed to enable_irq to restore + the IRQ to its original state. - .. function:: enable_irq(state=True) +.. function:: enable_irq(state=True) - Enable interrupt requests. - If ``state`` is ``True`` (the default value) then IRQs are enabled. - If ``state`` is ``False`` then IRQs are disabled. The most common use of - this function is to pass it the value returned by ``disable_irq`` to - exit a critical section. + Enable interrupt requests. + If ``state`` is ``True`` (the default value) then IRQs are enabled. + If ``state`` is ``False`` then IRQs are disabled. The most common use of + this function is to pass it the value returned by ``disable_irq`` to + exit a critical section. Power related functions ----------------------- |