Skip to content

Commit

Permalink
docs/library/machine: Add machine.bootloader docs.
Browse files Browse the repository at this point in the history
This is provide by a few ports now, and is very useful.

Signed-off-by: Damien George <[email protected]>
  • Loading branch information
dpgeorge committed Apr 30, 2021
1 parent 9e1b25a commit dd5c831
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/library/machine.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------------------------

Expand Down

0 comments on commit dd5c831

Please sign in to comment.