シングルバンクでOTAアップデートする
はじめに
Raspberry Pi Pico2 を搭載した マイコン を、現地に設置したあとでもファームウェア更新できるように、シングルバンク方式の OTA(Over The Air)アップデートを実装したときの構成を備忘録がてらにまとめます。
本記事では、リンカスクリプトで領域を分ける→ブートローダーでアプリ領域へ書き込み→アプリへジャンプして起動までをまとめています。
忙しい人のために
- フラッシュを BOOT(ブートローダー) / APP(アプリ) / LFS(ファイルシステム) / PKCS11 に分割する(例:BOOT 256KB / APP 768KB / LFS 768KB / PKCS11 256KB)。
- 新しいファームは /firmware.bin としてファイルシステム側に置き、再起動後ブートローダーが APP 領域へ転写する。
- ブートローダーはAPP先頭のベクターテーブル を読んで妥当性をチェックする。
- 問題がなければAPP先頭のベクターテーブルから取得した初期MSPとリセットハンドラをVTORとMSPに設定しリセットハンドラにジャンプする(=メインアプリの実行)。
環境
- Raspberry Pi Pico2 搭載マイコン
- picoSDK v2.1.1
- VSCode
背景
デバイスを現場に設置した後も、バグ修正や新機能の提供ができるように OTA 機能が必要でした。
ただしデュアルバンクをやるほどのフラッシュ余裕がなく将来のファームウェアサイズの確保もしたい、という理由で今回はシングルバンクを採用しています。
どうやるのか
メモリセクション(リンカスクリプト)
今回のマイコンのフラッシュサイズは2MBです。
まずはフラッシュを用途別に分割します。
FLASH_BASE = 0x10000000;
BOOTCTL_LENGTH = 256K;
APP_LENGTH = 768K;
LFS_LENGTH = 768K;
PKCS11_LENGTH = 256K;
BOOTCTL_ORIGIN = FLASH_BASE;
APP_ORIGIN = BOOTCTL_ORIGIN + BOOTCTL_LENGTH;
LFS_ORIGIN = APP_ORIGIN + APP_LENGTH;
PKCS11_ORIGIN = LFS_ORIGIN + LFS_LENGTH;
__flash_app_start__ = APP_ORIGIN;
__flash_app_end__ = APP_ORIGIN + APP_LENGTH;
MEMORY
{
BOOT_MEM (rx) : ORIGIN = BOOTCTL_ORIGIN, LENGTH = BOOTCTL_LENGTH
FLASH_APP (rx) : ORIGIN = APP_ORIGIN, LENGTH = APP_LENGTH
LFS_MEM (rx) : ORIGIN = LFS_ORIGIN, LENGTH = LFS_LENGTH
PKCS11_MEM (rx) : ORIGIN = PKCS11_ORIGIN, LENGTH = PKCS11_LENGTH
RAM(rwx) : ORIGIN = 0x20000000, LENGTH = 512k
SCRATCH_X(rwx) : ORIGIN = 0x20080000, LENGTH = 4k
SCRATCH_Y(rwx) : ORIGIN = 0x20081000, LENGTH = 4k
}
REGION_ALIAS("FLASH", @FLASH_REGION@)
...
実装上のポイントは2つです。
-
APP領域の境界をリンカシンボルで公開
ブートローダー内で
__flash_app_start__/__flash_app_end__を参照して、書き込み先・ジャンプ先の範囲チェックに使います。 -
ブートローダー/アプリで同じリンカスクリプトを使ってどの領域に配置するかを切り替えられるようにする
REGION_ALIAS("FLASH", @FLASH_REGION@)はエイリアスです。CMakeLists.txtでFLASHに相当する領域を切り替える作りにしておくことでpicoSDKデフォルトの定義を両方に適用しつつ任意の場所にファームウェアを配置することができます
ブートローダーの責務
マイコン起動時に最初に実行されるユーザー定義のファームウェアであり、今回実装したブートローダーは以下の責務を担います。
- 起動したらファイルシステム内にファームウェアがあるか確認し、あればAPP領域へ書き込む。
- その後APP領域先頭のベクターテーブルに従ってアプリへジャンプする
1) ファームウェアをAPP領域へ書き込む
- LFS_MEMにファームウェアがあるかを確認
- ファームウェアとFLASH_APP領域双方に問題がなければブロック単位で書き込み
2) アプリへジャンプして実行する
APP先頭から
- 初期メインスタックポインタ
- リセットハンドラ
を読み出してチェックが通ったら
- 割り込み禁止
- VTOR(Vector Table Offset Register)をAPP先頭に指定する
- MSPをAPPの初期値に指定する
- リセットハンドラに関数ポインタとしてジャンプ
という順でメインアプリをロードします。
ユースケース
弊社ではマイコン・エッジをAWS IoTで管理しています。
実際のOTAアップデートでは
- AWS IoT JobsでOTAタスク発行
- マイコン側でタスク受信
- MQTT File Streamsでファームウェアをブロック単位でダウンロード
- 再起動してブートローダーでファームウェアを書き込み&メインアプリにジャンプ
の手順で実行しています。
まとめ
- リンカスクリプトで領域を分割し、APPの境界をシンボルで公開して、ブートローダーから書き込み・ジャンプを扱えるようにする
- シングルバンクはデュアルバンクに比べるとシンプルでファームウェアサイズを取りやすい反面、更新中のダウンタイムというデメリットがあります。
- アプリ起動はVTOR/MSP/ResetHandlerをブートローダーから切り替えることによって行われる。
Discussion