Skip to content

README: update instructions for using USB DFU to match the new defaults #167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
henrikbrixandersen merged 1 commit into from
Mar 15, 2026
Merged

README: update instructions for using USB DFU to match the new defaults #167

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,20 +122,22 @@ west build -b frdm_k64f/mk64f12 --sysbuild cannectivity/app/ -- -DSB_CONF_FILE=
After building, MCUboot and the CANnectivity firmware can be flashed to the board by running the
`west flash` command.

Subsequent CANnectivity firmware updates can be applied via USB DFU. In order to do so, the board
must first be booted into USB DFU mode. If your board has a dedicated DFU button (identified by the
`mcuboot-button0` devicetree alias) press and hold it for 5 seconds or press and hold the button
while powering up the board. If your board has a DFU LED (identified by the `mcuboot-led0`
devicetree alias), the LED will flash while the DFU button is being held and change to constant on
once DFU mode is activated. Refer to your board documentation for further details.

Once in DFU mode, the CANnectivity firmware can be updated using
Subsequent CANnectivity firmware updates can be applied via USB DFU using
[dfu-util](https://dfu-util.sourceforge.net/):

```shell
dfu-util -a 1 -D build/app/zephyr/zephyr.signed.bin.dfu
dfu-util -D build/app/zephyr/zephyr.signed.bin.dfu
```

The `dfu-util` command will automatically switch the firmware into DFU mode and reboot into the new
firmware once completed.

If your board has a dedicated DFU button (identified by the `mcuboot-button0` devicetree alias), it
can also be used to force the firmware into DFU mode by pressing and holding it for 5 seconds. If
your board has a DFU LED (identified by the `mcuboot-led0` devicetree alias), the LED will flash
while the DFU button is being held and change to constant on once DFU mode is activated. Refer to
your board documentation for further details.

## CANnectivity as a Zephyr Module

The CANnectivity firmware repository is a [Zephyr
Expand Down
21 changes: 11 additions & 10 deletions doc/building.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,19 +57,20 @@ To build CANnectivity with MCUboot integration for USB DFU use :external+zephyr:
After building, MCUboot and the CANnectivity firmware can be flashed to the board by running the
``west flash`` command.

Subsequent CANnectivity firmware updates can be applied via USB DFU. In order to do so, the board
must first be booted into USB DFU mode. If your board has a dedicated DFU button (identified by the
``mcuboot-button0`` devicetree alias) press and hold it for 5 seconds or press and hold the button
while powering up the board. If your board has a DFU LED (identified by the ``mcuboot-led0``
devicetree alias), the LED will flash while the DFU button is being held and change to constant on
once DFU mode is activated. Refer to your board documentation for further details.

Once in DFU mode, the CANnectivity firmware can be updated using
`dfu-util`_:
Subsequent CANnectivity firmware updates can be applied via USB DFU using `dfu-util`_:

.. code-block:: console

dfu-util -a 1 -D build/app/zephyr/zephyr.signed.bin.dfu
dfu-util -D build/app/zephyr/zephyr.signed.bin.dfu

The ``dfu-util`` command will automatically switch the firmware into DFU mode and reboot into the
new firmware once completed.

If your board has a dedicated DFU button (identified by the ``mcuboot-button0`` devicetree alias),
it can also be used to force the firmware into DFU mode by pressing and holding it for 5 seconds. If
your board has a DFU LED (identified by the ``mcuboot-led0`` devicetree alias), the LED will flash
while the DFU button is being held and change to constant on once DFU mode is activated. Refer to
your board documentation for further details.

.. _MCUboot:
https://www.trustedfirmware.org/projects/mcuboot/
Expand Down
Loading