summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDamien George <damien@micropython.org>2021-04-30 16:55:55 +1000
committerDamien George <damien@micropython.org>2021-04-30 16:55:55 +1000
commitdd5c831a0b0c960b638109f1886edc10178f51a1 (patch)
tree8dc51ceb99582d0d9ba16220c674d7c66f529885 /docs
parent9e1b25a99e9107619c6ed607c730ea2869582799 (diff)
docs/library/machine: Add machine.bootloader docs.
This is provide by a few ports now, and is very useful. Signed-off-by: Damien George <damien@micropython.org>
Diffstat (limited to 'docs')
-rw-r--r--docs/library/machine.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/library/machine.rst b/docs/library/machine.rst
index 5076dc30e..f831049f8 100644
--- a/docs/library/machine.rst
+++ b/docs/library/machine.rst
@@ -37,6 +37,14 @@ Reset related functions
Get the reset cause. See :ref:`constants <machine_constants>` for the possible return values.
+.. function:: bootloader([value])
+
+ Reset the device and enter its bootloader. This is typically used to put the
+ device into a state where it can be programmed with new firmware.
+
+ Some ports support passing in an optional *value* argument which can control
+ which bootloader to enter, what to pass to it, or other things.
+
Interrupt related functions
---------------------------