量産用swuイメージの作成

Armadillo Base OSは、SWUpdateというアップデート機能を持っており、Armadillo内のLinuxカーネルイメージやユーザーランドなどを容易に書き換えることが可能です。 swuイメージは、SWUpdateを行なうために必要なアップデート先のイメージなどが組み込まれたパッケージファイルを指します。

swuイメージをArmadilloに適用する方法として、swuイメージが書き込まれたUSBメモリやSDカードをArmadilloに挿入する方法や、ネットワーク経由でswuイメージを取得する方法などがあります。 詳しくはArmadillo-IoT ゲートウェイ G4 製品マニュアルの「Armadilloのソフトウェアをアップデートする」を参照してください。 今回の例ではUSBメモリを用いた方法で進めていきます。

アットマークテクノから出荷された量産向けのArmadilloは通常、標準イメージが初めから書き込まれています。 これをSWUpdateによってアップデートする形で、ユーザー製品の量産用のイメージを書き込みます。

SWUpdateを用いて量産時にイメージ書き込みを行なう際の、一般的な作業の流れは以下の通りです。

各手順については、以下で順番に説明します。

まず初めに、SWUpdateの初回アップデートの準備を行ないます。

一度もSWUpdateを実行していないArmadilloは、第三者が作ったswuイメージであっても受け付けてアップデートを実行してしまいます。 そのため、初回アップデートを行なっていないArmadilloを使用した製品を量産して出荷することはとても危険です。 SWUpdateによる初回アップデートでは、Armadillo内に専用の認証鍵を配置し、自分が作成したswuイメージ以外を受け付けなくするように設定しますので、必ず実行してください。

初回アップデート用swuイメージの作成手順については、「SWUpdateによる初回アップデート」を参照して「2. mkswu の初期設定」までを実行してください。 今回は量産時に初回アップデートとソフトウェア書き込みを1度のSWUpdateで行なうため、今の段階ではinitial_setup.swuを生成した後にSWUpdateを実行する必要はありません。

次に、開発したソフトウェアをswuイメージにしていきます。

swuイメージはATDE上で作成するので、swuイメージに組み込むファイルをATDE内に配置しておいてください。

以下では6章サンプルアプリケーションの作成で作成したソフトウェアをArmadilloに組み込むことを例として考えます。 最低限以下の2つをArmadilloに書き込むことで、起動時にアプリケーションを含むコンテナが自動的に実行されます。

ここでは、これらのファイルをATDEに/home/atmark/mkswu/abos-dev-guideディレクトリを作成して配置しておきます。

[ATDE ~/mkswu/abos-dev-guide]$ ls
abos-dev-guide-v1.0.0.tar  sample_container.conf

descファイルの記述方法などの詳細については、Armadillo-IoT ゲートウェイ G4 製品マニュアルの「mkswu の desc ファイル」を参照してください。

SWUpdate実行時に、「書き込むイメージの準備」で挙げたファイルをArmadilloに書き込むようなswuイメージを生成します。

swuイメージを作成するためには、SWUpdate時に実行する処理等を示したdescファイルを記述し、そのdescファイルを入力として mkswu コマンドを実行することで、swuイメージが出来上がります。

本書のサンプルアプリケーションを例とすると、Armadillo-IoT ゲートウェイ G4においては以下のようなabos-dev-guide.descファイルを作成します。

[ATDE ~/mkswu/abos-dev-guide]$ cat abos-dev-guide.desc
swdesc_option component=abos-dev-container
swdesc_option version=1
swdesc_option POST_ACTION=poweroff 

starting_cmd="cd /sys/class/leds/led1 && echo timer > trigger && echo 111 | tee delay_on > delay_off"
success_cmd="cd /sys/class/leds/led1 && echo none > trigger && cat max_brightness > brightness"
fail_cmd="cd /sys/class/leds/led1 && echo heartbeat > trigger"

swdesc_option NOTIFY_STARTING_CMD="$starting_cmd" 
swdesc_option NOTIFY_SUCCESS_CMD="$success_cmd" 
swdesc_option NOTIFY_FAIL_CMD="$fail_cmd" 

swdesc_embed_container "abos-dev-guide-v1.0.0.tar" 
swdesc_files --extra-os --dest /etc/atmark/containers/ "sample_container.conf" 

Armadillo-IoT ゲートウェイ A6Eの場合は、初めからSWUpdateの実行時にLEDが点滅する設定がされており、descファイルでLEDの設定を行なう必要がないため、以下のようなabos-dev-guide.descファイルとなります。

[ATDE ~/mkswu/abos-dev-guide]$ cat abos-dev-guide.desc
swdesc_option component=abos-dev-container
swdesc_option version=1
swdesc_option POST_ACTION=poweroff 

swdesc_embed_container "abos-dev-guide-v1.0.0.tar" 
swdesc_files --extra-os --dest /etc/atmark/containers/ "sample_container.conf" 

[ATDE ~/mkswu/abos-dev-guide]$ cat abos-dev-guide.desc
swdesc_option component=abos-dev-container
swdesc_option version=1
swdesc_option POST_ACTION=poweroff

starting_cmd="cd /sys/class/leds/led1 && echo timer > trigger && echo 111 | tee delay_on > delay_off"
success_cmd="mount -o rw,remount /dev/sda1 && 
             cp /var/log/messages /mnt/messages.\$(date +%Y%m%d-%H%M%S).log && 
             cd /sys/class/leds/led1 && echo none > trigger && cat max_brightness > brightness"
fail_cmd="cd /sys/class/leds/led1 && echo heartbeat > trigger"

swdesc_option NOTIFY_STARTING_CMD="$starting_cmd"
swdesc_option NOTIFY_SUCCESS_CMD="$success_cmd"
swdesc_option NOTIFY_FAIL_CMD="$fail_cmd"

swdesc_embed_container "abos-dev-guide-v1.0.0.tar"
swdesc_files --extra-os --dest /etc/atmark/containers/ "sample_container.conf"

[ATDE ~/mkswu/abos-dev-guide]$ cat abos-dev-guide.desc
swdesc_option component=abos-dev-container
swdesc_option version=1
swdesc_option POST_ACTION=poweroff

success_cmd="mount -o rw,remount /dev/sda1 && 
             cp /var/log/messages /mnt/messages.\$(date +%Y%m%d-%H%M%S).log && 
             cd /sys/class/leds/sys && echo none > trigger && cat max_brightness > brightness" 

swdesc_option NOTIFY_SUCCESS_CMD="$success_cmd"

swdesc_embed_container "abos-dev-guide-v1.0.0.tar"
swdesc_files --extra-os --dest /etc/atmark/containers/ "sample_container.conf"

「descファイルの記述」で作成したdescファイルと、initial_setup.descファイルからswuイメージを生成し、USBメモリに書き込みます。

descファイルからswuイメージを生成するには、 mkswu コマンドを実行します。 図9.6「mkswuコマンドの実行」は、initial_setup.descとabos-dev-guide.descからabos-dev-guide_setup.swuを生成をする例です。

[ATDE ~/mkswu/abos-dev-guide]$ mkswu -o abos-dev-guide_setup.swu \
../initial_setup.desc abos-dev-guide.desc

../initial_setup.desc を組み込みました。
abos-dev-guide.desc を組み込みました。
abos-dev-guide_setup.swu を作成しました。

このように、複数のdescファイルをまとめてひとつのswuイメージを作成することが可能です。 SWUpdate時には mkswu コマンドで指定した順番に実行されるので、図9.6「mkswuコマンドの実行」の例では、initial_setupの処理の後にabos-dev-guideの処理が実行されます。

生成されたabos-dev-guide_setup.swuをUSBメモリに書き込みます。 コマンド実行例を図9.7「各イメージをUSBメモリに配置」に示します。 書き込み先であるUSBメモリは/media/atmark/USBDRIVEにマウントされているものとします。

[ATDE ~/mkswu/abos-dev-guide]$ cp abos-dev-guide_setup.swu /media/atmark/USBDRIVE/

USBメモリをアンマウントした後に、ATDEからUSBメモリを取り外します。

[ATDE ~/]$ sudo umount /media/atmark/USBDRIVE
// 完了後にATDEからUSBメモリを取り外す

ここまでの手順で作成したswuイメージを実際に量産工程で使用する前に、誤ったイメージを書きこんでいないか、書き込んだイメージが正しく動作するかなどを確認するための十分なテストを必ず実施してください。 そのために一度初期状態のArmadilloを1台用意し、それに作成したswuイメージを用いてSWUpdateを実際に実行してみることで、動作確認をしてみます。

9.7.1. SWUpdateの実行

標準イメージが書き込まれた初期状態のArmadillo-IoT ゲートウェイ G4を1台用意し、実際にSWUpdateを実行してみます。

Armadilloに電源ケーブルとswuイメージが書き込まれたUSBメモリを接続します。

	量産時に行なう処理によっては他にも接続すべきものがある場合があります。 例えば、SWUpdate中にネットワーク経由でファイルを取得する処理がある場合にネットワークに接続するためにEthernetケーブルを接続しておく必要がある、シリアルインターフェースからのログを残す為にmicroUSBケーブルを接続する必要があるなど、実際の量産時の動きに合わせて必要なものを接続しておいてください。

USBメモリと電源ケーブルを接続し、電源を投入すると自動で起動してSWUpdateが開始されます。

「descファイルの記述」で紹介したdescファイルをもとに作成されたswuイメージでは、SWUpdateの進捗によってLED3の状態が変化します。

SWUpdateの進捗とLED3の状態の対応表を表9.1「SWUpdateの進捗とLED3の状態の対応表」に示します。

表9.1 SWUpdateの進捗とLED3の状態の対応表

SWUpdateの進捗	LED3の状態
電源投入〜SWUpdate開始前	点灯
SWUpdate中	等間隔の点滅
SWUpdate成功	消灯(Armadilloの電源OFF)
SWUpdate失敗	周期的な2回の短点灯

SWUpdateが成功した場合、Armadilloの電源がOFFになりLED3が消灯します。 ArmadilloからUSBメモリを抜去してください。

SWUpdateが失敗した場合、LED3は周期的な2回の短点灯状態になり、電源は自動的にOFFになりません。 シリアルインターフェース経由でArmadilloを操作し、SWUpdateの実行ログから失敗原因を調査・修正して、再度お試しください。