From dd5c831a0b0c960b638109f1886edc10178f51a1 Mon Sep 17 00:00:00 2001 From: Damien George Date: Fri, 30 Apr 2021 16:55:55 +1000 Subject: [PATCH] docs/library/machine: Add machine.bootloader docs. This is provide by a few ports now, and is very useful. Signed-off-by: Damien George --- docs/library/machine.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/library/machine.rst b/docs/library/machine.rst index 5076dc30e0..f831049f88 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 ` 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 ---------------------------