nRF Connect SDK:USB DFU(Ver. 2.3)

# なんだかんだでやっぱり必要になった
過去にDFUのことを調べていたとき、最初に見つけたのがUSB経由のDFUでした。BLE経由のDFUを探していたので必要ないなと思いつつも、一度くらいは試しておいて損はないと思って検証したことがあります。
## 過去に実際に検証したUSB DFU
その時の検証結果がこちらの記事です。

https://qiita.com/yoshihiro0709/items/e6b43fdf49ef279a9fa9

今も動くのかどうか分からないです。というか、動かそうと思って読んだのですがどうすればいいのか全く分かりませんでした(笑)。
VSCodeベースになって以来、全然コマンドプロンプト触らないので当時の記事を見返してみてもさっぱり分かりません。改めて読んでみるといたるところを端折っていて、マジメに書いておかないとこういう時に困るんだなーというのを身をもって味わいました(笑)。

::: note
言い訳をするとUSB DFUは本当に使うつもりがなかったもので…
:::

# サンプルプロジェクトがある
いつからあるのかまでは把握していませんがUSB DFUに関してはSDKにサンプルプロジェクトがあります。ということでさっそくこのサンプルプロジェクトを実行していきたいと思います。プロジェクト名はdfuです。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/340602/06f82e7e-6fa4-79c1-6dcb-242a0ef05d25.png)
## なんか以前と全く違う気が…
サンプルプロジェクトを立ち上げてみてまず最初に思ったのは、なんだか以前に実装したものとは全く違うということでした。VSCodeベースになっているし全然違うものになっていてもそんなに不思議じゃないかな…とは思いつつ、どこから手を付けてよいのか全く分かりません。とりあえずREADME.rstを読んでみます。
全てを理解したあとであれば何が書いてあるのかが手に取るように理解できるのですが、全く理解度がない中でこのREADME.rstを読んで「なるほど、そういうことか！」と理解できる人ってどれくらいいるんでしょうね…少なくとも僕は全然理解できませんでした。

::: note warn
老化ですね(笑)
:::

## とりあえずコンパイルしてみる
よく分からないのでとりあえずコンパイルしてみます。普通にコンパイルできました、って当たり前ですよね(笑)。ちなみにREADME.rstの最初のほうに出てくるCONFIG_MCUBOOT_SIGNATURE_KEY_FILEについてはBLE版DFUと同様にそのままprj.confに記述しても無効です。詳細についてはBLE DFUの記述を参照してください。

https://qiita.com/yoshihiro0709/items/a3c4dc1778c6d048ae62

## Bootloaderはどうやって立ち上げるの？
nRF SDKにおけるUSB DFUはBootloaderモードに入ることで実施していました。その思い込みもあると思うのですが、まずここで躓きます。はて、どうやってBootloaderモードに入るのだろう？しかしREADME.rstを読んでみてもソースコードも眺めてみてもそれっぽい記述はどこにも見当たりません。nRF SDK時代にあった起動時にボタンを押しているとBootloaderが立ち上がるみたいなKconfigも見つかりません。

::: note
結論を言うとBootloaderモードというのはありません。
:::

## dfu-utilってなんだ…？
もう一つREADME.rstに謎の記述が現れます。linuxのdfu-utilがなんだかんだと書かれています。はて、これはいったいなんなのだろうか？とりあえずNCSのフォルダ内を漁ってみますがそれらしいものは見つからなかったのでWEB検索してみたところ…なにか引っかかりました。

https://dfu-util.sourceforge.net/

ん…？本当にこれのことなのだろうか？と半信半疑になりながらもWindows用の実行ファイルをダウンロードします。なお、執筆時点での最新バージョンは0.11です。
なおも半信半疑のままとりあえず動かしてみると…
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/340602/aa377913-0b1b-31f2-9a02-cf8ff0241d6d.png)
はて、何かエラーが出ているような気がするんだけど…なんだこりゃ？

::: note
このあたりはDevZoneでやり取りして解決しました
:::

## デバイスドライバーのインストール
コンパイルしたサンプルプロジェクトをフラッシュに書き込むとWindowsデバイスマネージャにドライバーのないデバイスが現れます。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/340602/897e9863-03f4-16bd-8f2a-8fa6db645b4a.png)
これが先ほどのエラーっぽいメッセージと関係あるのですが、要するにデバイスドライバーがなくて正常に動作していないことによるエラーのようです。いや、でもデバイスドライバーってどこにあるのさ！
結論としては汎用のUSBドライバーをインストールすればよいみたいです。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/340602/df5b6be2-d34c-f2e3-b853-7e4f6ea15fda.png)
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/340602/7b373460-c562-1a01-9c98-b89670e24de9.png)
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/340602/52baafd7-e09d-26b8-ba91-50812a867370.png)
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/340602/e8c79786-7590-7dcd-f2c3-c4d349524106.png)
ドライバーに互換性がないとか警告が出ますが無視します。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/340602/5bc08ad5-43d2-130d-361d-656e4cebc21a.png)
これでビックリマークが消えました。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/340602/4c677b45-54f6-7bc1-28c5-f28354be9b93.png)
再びコマンドプロンプトからdfu-utilコマンドを実行してみると…
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/340602/c6989aeb-3b71-f0cd-edde-4d600e0e4ba5.png)
お、ちゃんと認識しているようです。
# 別プロジェクトの作成
README.rstに記載されているようにDFUを実際に実行するにあたっては別のプロジェクトが必要になります。ここではhello_worldをベースにDFUが実行できる形にしたものを作成します。ちなみにREADME.rstに書かれているようにCONFIG_BOOTLOADER_MCUBOOTを含む最小限の変更でDFUをするとその次のDFUは実行できなくなります(笑)。

::: note warn
USBを有効にするKconfigとソースコードがないためです。
:::

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/340602/10f50fcb-b96a-9088-08ad-35c67ed5fcef.png)

``` prj.conf
CONFIG_BOOTLOADER_MCUBOOT=y
CONFIG_FLASH=y
CONFIG_USB_DEVICE_STACK=y
CONFIG_USB_DFU_CLASS=y
CONFIG_USB_DFU_ENABLE_UPLOAD=y
CONFIG_IMG_MANAGER=y
```

::: note warn
DFU関連のKconfigを入れないとDFU用のapp_update.binを生成してくれません。
:::

## いざアップデート…？
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/340602/9c3e93d0-b9d6-8a99-dfc8-d9dccda3dafc.png)
これでイケる！と思ったら…
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/340602/4e3e22e6-828a-64d9-faf5-5ade97d9dc40.png)
More than one DFU capable USB device found!ってなんですか？！さっきデバイス一つしかなかったと思うんですけど…？と不思議に思いながらdfu-util --listと打ち込んでみると…
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/340602/add16c9c-6019-fcca-c5c4-3dc4148a4eae.png)
ふぁーーー！なんで増えてるの？？？確信が持てませんがおそらくSLOT 0とSLOT 1の2つを示しているのではないかと思います。長くなるので省略しますがSLOT 0には書き込みができません。
ということでSLOT 1に書き込みます。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/340602/a212bfce-3af7-98fa-c31a-4811a8bb9a9b.png)
お、ちゃんと書き込みできたようです。リセットしてみると…
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/340602/115ce2ad-1faa-eb75-f647-b811fc3cc94f.png)
ちゃんとHello Worldプロジェクトに書き換わっています。よっしゃー！
## と思ったのも束の間…
何気なくもう一度リセットしてみたんですよね。そしたら…
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/340602/cdca44da-9620-ec63-ba36-a6f077d0cb70.png)
えっ？どういうこと？元に戻った？表示されている情報をよく見てみるとrevertという表示もあります。何度やってみても書き込んだ直後のみ新しいファームウェアに書き換わるものの、2回目のリセットで最初のファームウェアに戻されます。なんだこれ…？
## 追加のKconfigが必要
DFUのサンプルアプリケーションにはよく分からないoverlayファイルが1個あります。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/340602/01827ec8-847e-50ba-98cc-2ea4f6d9f68b.png)
任意追加のオプションのようですが、中身を見てみると…
``` prj.conf
CONFIG_USB_DFU_REBOOT=y
CONFIG_USB_DFU_PERMANENT_DOWNLOAD=y
```
調べてみたところ、どうもこれがファームウェアを元に戻さないようにする追加のKconfigのようです。README.rstを読んでみると同様のことが書いてあるのですが、何も知らない状態で読んでみても何のことかさっぱり分からんっつーの！(笑)
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/340602/321376a2-5445-681a-7f4d-1be6a8341020.png)
先ほどのOverlayファイルを追加して再びコンパイルします。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/340602/5db45a6d-2fbc-aa43-3702-685cc1576ffd.png)
先ほどまでswap typeのところにtestと表示されていたものがpermに変わっています。もう一度リセットしてみると…
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/340602/11d8cdd9-717a-4bc6-ca14-9a2954dd1eef.png)
Hello Worldのままです！よっしゃー！
# Secure DFU
USB DFUではまだ試しておりません。実は検証するのって意外とめんどくさいんですよ、ええ…。

::: note warn
README.rstではRSA-2048の記載がありますが、実際に使えるのはBLE DFUと同様にECDSA-256です。
:::

# 総評(という名のAppendix)
ちなみに今回のDFUに関しては全然分からなかったし情報も見つからなかったのでDevZoneでやり取りしました。いや、DevZoneすごいね！
英語でのやり取りもDeepLのおかげで全然苦にならなくなってきました。もちろん丸ごとコピーではなくて少し書き直したりはするのですが、自分で最初から最後まで英文を考える必要がなくなったのでとても楽ちんです(笑)。

https://devzone.nordicsemi.com/f/nordic-q-a/99910/usb-dfu-in-sdk-2-0-or-later

ちなみにここ読んでと教えてもらったNordicのホームページはこちら

https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/zephyr/samples/subsys/usb/dfu/README.html

でも、これ古い気がするんですよね…だって、途中でzephyr.signed.binっていうファイルが出てくるんですが、そんなものは生成されませんし…。