Appendix

正常に起動するが、拡張したいデバイスや今まで動いていたデバイスを認識しない場合

新規にDTSファイルに追加した記述が誤っている、既存の記述を削除や上書きしてしまったなど、作成したDTSファイルの記述に問題がある可能性が高いです。 そのような場合は再度at-dtwebなどでDTSファイルを修正し、新たに生成したDTBファイルをArmadilloに転送する手順からやり直してください。

Armadilloが正常に起動せず、Armadillo Base OSのロールバック機能が作動する場合

書き込んだDTBファイルが壊れている、DTSファイル内の起動に関わる重要な箇所に誤りがあるなどの可能性が高いです。

Armadillo Base OSは何らかの原因によってルートファイルシステムが破損し正常に起動できない場合に、前のバージョンに戻して再起動するロールバック機能が自動で働きます。 これによって起動したArmadilloは作成したDTBファイルを書き込む前の状態に戻っているので起動できるはずです。

Armadillo Base OSのロールバック機能の詳細については、Armadillo-IoT ゲートウェイ G4の製品マニュアルの「 Armadillo Base OSの操作」内の「ロールバック状態の確認」を参照してください。

ロールバック機能が働いたかどうかは起動ログでも確認できますが、以下のコマンドで確認できます。

[armadillo /]# abos-ctrl status
Currently booted on /dev/mmcblk2p1
WARNING: Currently running on non-latest version (expected /dev/mmcblk2p2 installed on Mon Apr  4 15:39:42 JST 2022)
rollback-status: rolled back 

このような場合は再度at-dtwebなどでDTSファイルを修正し、新たに生成したDTBファイルをArmadilloに転送する手順までをやり直してください。 修正したDTBファイルをArmadilloへ転送後、今起動していない方のルートファイルシステムに修正後のDTBファイルを配置します。

[armadillo /]# ls armadillo_iotg_g4-at-dtweb.dtb
armadillo_iotg_g4-at-dtweb.dtb
[armadillo /]# abos-ctrl mount-old && mount -o remount,rw /target 
[armadillo /]# cp armadillo_iotg_g4-at-dtweb.dtb /target/boot/armadillo.dtb 

その後、以下のコマンドを実行し、現在起動していない方のルートファイルシステムを用いて起動します。

[armadillo /]# abos-ctrl rollback
[armadillo /]# reboot

修正したDTBが誤りがなければ正常に起動します。 誤りが解消されなければ再度ロールバックしますので、再度同様の手順で復旧するまでDTBを修正してください。

Armadilloは起動しているが、シリアルコンソールに何も表示されず、何も入力できない場合

DTB内のシリアルコンソールを設定する記述に誤りがあり、起動こそしていても何も入出力できない状態になっている可能性が高いです。

この場合は一度Armadilloの電源を投入し直し、U-bootの環境変数を変更することで、Armadillo-IoT ゲートウェイ G4の標準のDTBで起動するように設定します。

電源投入後、U-bootにて以下のコマンドを実行します。

U-Boot 2020.04-at6 (Mar 25 2022 - 08:09:26 +0000)
:(省略)
Hit any key to stop autoboot:  0 
u-boot=> setenv fdt_file boot/armadillo_iot_g4.dtb 
u-boot=> boot 

起動後、再度at-dtwebなどでDTSファイルを修正し、新たに生成したDTBファイルをArmadilloに転送する手順からやり直してください。

次回以降の起動は、また/boot/armadillo.dtbを使用して起動するようになっています。

作成したDTBファイル配置用のswuイメージを作成する

まず、適当な作業用ディレクトリ(以下の例では~/mkswu/update-dtb-descs)を作成し、その中に作成したDTBファイルをarmadillo.dtbにリネームして配置します。 DTBファイルへのパスは適宜読み替えてください。 また、今回のswuイメージを作成時に使用するスクリプトファイルもあわせて配置します。

[ATDE ~/]$ cd mkswu
[ATDE ~/mkswu]$ mkdir -p update-dtb-descs && cd update-dtb-descs
[ATDE ~/mkswu/update-dtb-descs]$ cp /path/to/armadillo_iotg_g4-at-dtweb.dtb ./armadillo.dtb

次に、swuイメージ作成に用いるusb_dtb_sample.descを以下のように作成します。

[ATDE ~/mkswu/update-dtb-descs]$ cat usb_dtb_sample.desc
component=extra_os.dtb 
version=1 

swdesc_files --dest /boot \
        "armadillo.dtb" 

swdesc_script "$SCRIPT_DIR/examples/update_preserve_files.sh" -- \
        "/boot/armadillo.dtb" 

descファイルの詳細についてはArmadillo-IoT ゲートウェイ G4の製品マニュアルの「 mkswuのdescファイル」を参照してください。 /usr/share/mkswu/examples以下のdescファイルはサンプルですので、そちらも参考にしてください。

swuイメージを作成します。

[ATDE ~/mkswu/update-dtb-descs]$ mkswu usb_dtb_sample.desc
Enter pass phrase for /home/atmark/mkswu/swupdate.key: 
usb_dtb_sample.swu を作成しました。

これでDTBファイルをArmadilloの所定のディレクトリに配置するswuイメージが完成しました。

USBメモリにswuイメージを書き込む

mkswu実行時に表示された指示に従って、作成したswuイメージをUSBメモリに配置します。 ATDEにUSBメモリを接続して以下を実行してください。

[ATDE ~/mkswu/update-dtb-descs]$ df -h
Filesystem                  Size  Used Avail Use% Mounted on
: (省略)
/dev/sdb1                   15G   24K   14G    1% /media/atmark/USBDRIVE 

[ATDE ~/mkswu/update-dtb-descs]$ sudo cp usb_dtb_sample.swu /media/atmark/USBDRIVE/ 
[ATDE ~/mkswu/update-dtb-descs]$ umount /media/atmark/USBDRIVE/ 

SWUpdateの実行

initial_setupと同様に、ArmadilloにUSBメモリを挿入すると自動的にアップデートが実行され、コンテナイメージの組み込みとコンテナの自動実行設定が行われます。

自動的に再起動するので、再度Armadilloにログインし、DTBファイルが書き換わって起動していることをご確認ください。

以上で、作成したDTBファイルをSWUpdateを用いてArmadilloに配置することができました。

udevを用いてUSBメモリの挿入を検知しmountコマンドを実行する

udevは、Linuxカーネル用のデバイス管理ツールです。 デバイスが接続もしくは接続解除された時にカーネルはueventをudevに通知します。 この時udevは予め設定しておいたルールに従って、受け取ったueventに対応した処理を行います。

udevを活用することでデバイスの挿抜をトリガに任意のホストコマンドを実行できますので、コンテナ内で何かを設定する必要はありません。

以下ではUSBメモリの挿抜時にmountコマンドを実行し、/mntディレクトリにマウントする例を紹介します。

まず、/etc/udev/rules.d/に、99-usb-automount.rulesというファイルを作成して、以下のように内容を編集します。

[armadillo ~/]# cat /etc/udev/rules.d/99-usb-automount.rules
ACTION=="add", KERNEL=="sd*", SUBSYSTEM=="block", ENV{ID_FS_USAGE}=="filesystem", RUN+="/bin/mount /dev/%k /mnt"

その後、以下のコマンドを実行してudevルールの再読込みを行います。

[armadillo ~/]# udevadm control -R

以上で設定完了ですので、動作確認をしてみます。

[armadillo ~/]# mount | grep /mnt 
[armadillo ~/]# 
[84250.573893] usb 1-1: new high-speed USB device number 8 using xhci-hcd
[84250.732277] usb-storage 1-1:1.0: USB Mass Storage device detected
: (省略)
[84252.013348]  sda: sda1
[84252.020039] sd 0:0:0:0: [sda] Attached SCSI removable disk
[84252.214274] EXT4-fs (sda1): mounted filesystem with ordered data mode. Opts: (null)
[armadillo ~/]# mount | grep /mnt 
/dev/sda1 on /mnt type ext4 (rw,relatime)

動作確認後、persist_fileコマンドを実行して設定したudevルールを永続化します。 -p オプションでアップデートで保存するための /etc/swupdate_preserve_files にも記載します。

swupdate_preserve_files については Armadillo-IoT ゲートウェイ G4 の製品マニュアルの「 swupdate_preserve_files について」を参照してください。

[armadillo ~/]# persist_file -p /etc/udev/rules.d/99-usb-automount.rules

上記手順ではmountを例に紹介しましたが、他のコマンドやシェルスクリプトの実行なども可能です。

buttondを用いてユーザースイッチの押下を検知してホストコマンドを実行する

Armadillo Base OSには、ユーザースイッチや外付けのキーボードなどの入力をイベントとして検知し、予め定義したルールによってそのイベントに対応させた処理を実行できるbuttondという仕組みがあります。

buttondについての詳細は、Armadillo-IoT ゲートウェイ G4の製品マニュアルの「 Armadillo Base OSの操作」内の「ボタンやキーを扱う」を参照してしてください。

以下では、buttondを用いてユーザースイッチを5秒以上長押しするとrebootコマンドを実行する例を紹介します。

まず、/etc/atmark/buttond.confを以下のように作成して、persist_fileコマンドで永続化します。 また、buttondサービスを再起動させます。

[armadillo ~/]# vi /etc/atmark/buttond.conf 
BUTTOND_ARGS="$BUTTOND_ARGS -l prog1 -t 5000 -a 'reboot'"
[armadillo ~/]# persist_file /etc/atmark/buttond.conf 
[armadillo ~/]# rc-service buttond restart 

その後、Armadillo-IoT ゲートウェイ G4のユーザースイッチ(SW1)を5秒長押しして再起動することを確認してください。

上記手順ではrebootを例に紹介しましたが、他のコマンドやシェルスクリプトの実行なども可能です。

Armadillo Base OS側の準備1

まず、sshサーバとなるArmadillo Base OS側の設定を行います。 以下のコマンドを実行して、sshサーバを自動的に起動するよう設定し、sshdサービスを再起動します。

[armadillo ~/]# rc-update add sshd
 * service sshd added to runlevel default
[armadillo ~/]# persist_file /etc/runlevels/default/sshd
[armadillo ~/]# rc-service sshd restart

コンテナの準備

以下では説明の為にat-debian-imageをベースとしたコンテナを作成します。 予め「サンプルコンテナをビルド」の手順に従って、at-debian-imageのDockerfileからイメージを生成しておく必要があります。

[armadillo ~/]# podman run -it --name=ssh_sample \
localhost/at-debian-image:latest /bin/bash
[container /]#

コンテナ内で以下のコマンドを実行してsshの準備をします。

[container /]# apt install -y openssh-client 
[container /]# ssh-keygen -t rsa -N "" -f /root/.ssh/id_rsa 
[container /]# ls /root/.ssh/id_rsa*    
/root/.ssh/id_rsa     /root/.ssh/id_rsa.pub
[container /]# <Ctrl+P> <Ctrl+Q> 
[armadillo ~/]#

Armadillo Base OS側の準備2

sshサーバであるArmadillo Base OSの方に、先程コンテナ内で生成した公開鍵を登録します。

[armadillo ~/]# mkdir /root/.ssh
[armadillo ~/]# chmod 600 /root/.ssh
[armadillo ~/]# podman exec -it ssh_sample /bin/cat /root/.ssh/id_rsa.pub >> /root/.ssh/authorized_keys

sshでコンテナ内からホストコマンドを実行

再度コンテナ側に戻り、ssh経由でホストコマンドであるrebootを実行してみます。 コンテナからArmadillo Base OSへはIPアドレス10.88.0.1でアクセスできます。

[armadillo ~/]# podman attach ssh_sample
[container /]# ssh root@10.88.0.1 reboot
: (省略)

初回ssh時に、「Are you sure you want to continue connecting (yes/no/[fingerprint])?」と表示される場合があります。 手動実行であればyを選択すれば問題ありませんが、シェルスクリプトなど非手動実行の場合はssh実行時に -o StrictHostKeyChecking=no オプションを指定すると上記質問を回避できます。

上記手順ではrebootを例に紹介しましたが、他のコマンドやシェルスクリプトの実行なども可能です。

nmcli

nmcli は NetworkManager を操作するためのコマンドラインツールです。

図11.27「nmcli のコマンド書式」に nmcli の書式を示します。このことから、 nmcli は「オブジェクト (OBJECT) というものが存在し、 それぞれのオブジェクトに対してコマンド (COMMAND) を実行する。」という書式でコマンドを入力することがわかります。 また、オブジェクトそれぞれに help が用意されていることもここから読み取れます。

nmcli [ OPTIONS ] OBJECT { COMMAND | help }

なお、基本的な使い方については、Armadillo-IoT ゲートウェイ G4の製品マニュアルの「ネットワーク」を参照してください。

nmtui

nmtui は NetworkManager を操作するためのユーザーフレンドリーなツールです。

NetworkManager を操作するための画面がテキストユーザーインターフェースで表示されるため、一つずつコマンドを入力する必要がなく、現在の設定項目を確認しながら設定することができます。 ただし、nmtui で設定できる項目には限りがあるため、設定する内容によっては nmcli を使用する必要があります。

図11.28 nmtui 起動後の画面

ブリッジモード

前述の通り、ブリッジモードがデフォルトとなります。

図11.29 ブリッジモードの構成

仮想ブリッジ podman0 がコンテナとホスト OS のネットワークインターフェースを繋ぐ役割を担い、コンテナは veth を経由して仮想ブリッジに接続します。 コンテナから外部に接続する場合は、仮想ブリッジで IPマスカレードが行われます。 そのため、ホスト OS 側で複数のネットワークインターフェースを持っていたとしても、コンテナ内のネットワークインターフェースは eth0(veth) となります。

ネットワークの設定が基本的に Armadillo Base OS の設定に帰結するのはこの仕組みによるものです。

実際にコンテナを podman run コマンドで作成し、ホスト OS 側のネットワークインターフェースを確認すると、 podman0 と veth が作成されています。

[armadillo ~]# podman run -itd --name=my_container --cap-add=NET_ADMIN --cap-add=NET_RAW docker.io/alpine:latest /bin/sh
eca23e90f6a59bbeee0a92edd88e3c3c24575f9ee061e43ae8a8238e27c2cd4e
[armadillo ~]# ip addr
1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN qlen 1000
    link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
    inet 127.0.0.1/8 scope host lo
       valid_lft forever preferred_lft forever
    inet6 ::1/128 scope host
       valid_lft forever preferred_lft forever
2: eth0: <NO-CARRIER,BROADCAST,MULTICAST,UP> mtu 1500 qdisc mq state DOWN qlen 1000
    link/ether 00:11:00:11:0c:00 brd ff:ff:ff:ff:ff:ff
3: eth1: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc mq state UP qlen 1000
    link/ether 0c:00:0a:c4:0a:c3 brd ff:ff:ff:ff:ff:ff
    inet 192.168.1.18/24 brd 192.168.1.255 scope global dynamic noprefixroute eth1
       valid_lft 86328sec preferred_lft 86328sec
    inet6 240d:18:38:cd00:2e4e:94c4:ce84:bc8/64 scope global dynamic noprefixroute
       valid_lft 9031sec preferred_lft 9031sec
    inet6 fe80::a61c:e27c:705a:4d96/64 scope link noprefixroute
       valid_lft forever preferred_lft forever
4: ppp0: <POINTOPOINT,MULTICAST,NOARP,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UNKNOWN qlen 3
    link/ppp
    inet 10.231.34.86/32 scope global noprefixroute ppp0
       valid_lft forever preferred_lft forever
5: podman0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue state UP qlen 1000
    link/ether 72:70:b6:93:a5:34 brd ff:ff:ff:ff:ff:ff
    inet 10.88.0.1/16 brd 10.88.255.255 scope global podman0
       valid_lft forever preferred_lft forever
    inet6 fe80::4a4:7dff:fe59:ddfe/64 scope link
       valid_lft forever preferred_lft forever
6: veth7b836e00@eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue master podman0 state UP qlen 1000
    link/ether 72:70:b6:93:a5:34 brd ff:ff:ff:ff:ff:ff
    inet6 fe80::7070:b6ff:fe93:a534/64 scope link
       valid_lft forever preferred_lft forever

コンテナ内のネットワークインターフェースはこのようになります。

[container /]# ip addr
1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN qlen 1000
    link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
    inet 127.0.0.1/8 scope host lo
       valid_lft forever preferred_lft forever
    inet6 ::1/128 scope host
       valid_lft forever preferred_lft forever
2: eth0@if5: <BROADCAST,MULTICAST,UP,LOWER_UP,M-DOWN> mtu 1500 qdisc noqueue state UP qlen 1000
    link/ether 3e:81:21:41:ed:f2 brd ff:ff:ff:ff:ff:ff
    inet 10.88.0.2/16 brd 10.88.255.255 scope global eth0
       valid_lft forever preferred_lft forever
    inet6 fe80::3c81:21ff:fe41:edf2/64 scope link
       valid_lft forever preferred_lft forever

host モード

コンテナ作成時に --net=host オプションをつけると host モードになり、 ホスト OS のネットワークインターフェースをそのままコンテナに渡すことができます。

図11.32 hostモードの構成

コンテナを podman run コマンドで作成した時に表示されるログを見ると、ブリッジモードとは異なり、ホスト OS 側に podman0 と veth は存在しません。

[armadillo ~]# podman run -itd --name=my_container --net=host --cap-add=NET_ADMIN --cap-add=NET_RAW docker.io/alpine:latest /bin/sh
3f9ce7adcf7c583b6cec0b82f7ec0f3ab134cef41550bd7f9514d48bd6a4986b
[armadillo ~]# ip addr
1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN qlen 1000
    link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
    inet 127.0.0.1/8 scope host lo
       valid_lft forever preferred_lft forever
    inet6 ::1/128 scope host
       valid_lft forever preferred_lft forever
2: eth0: <NO-CARRIER,BROADCAST,MULTICAST,UP> mtu 1500 qdisc mq state DOWN qlen 1000
    link/ether 00:11:00:11:0c:00 brd ff:ff:ff:ff:ff:ff
3: eth1: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc mq state UP qlen 1000
    link/ether 0c:00:0a:c4:0a:c3 brd ff:ff:ff:ff:ff:ff
    inet 192.168.1.18/24 brd 192.168.1.255 scope global dynamic noprefixroute eth1
       valid_lft 85893sec preferred_lft 85893sec
    inet6 240d:18:38:cd00:a5a3:440a:4c47:a41c/64 scope global dynamic noprefixroute
       valid_lft 7850sec preferred_lft 7850sec
    inet6 fe80::648f:5ec2:82fb:f291/64 scope link noprefixroute
       valid_lft forever preferred_lft forever
4: ppp0: <POINTOPOINT,MULTICAST,NOARP,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UNKNOWN qlen 3
    link/ppp
    inet 10.231.34.86/32 scope global noprefixroute ppp0
       valid_lft forever preferred_lft forever

コンテナ内のネットワークインターフェースは以下の通り、ホスト OS と同じ内容になります。

[container /]#  ip addr
1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN qlen 1000
    link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
    inet 127.0.0.1/8 scope host lo
       valid_lft forever preferred_lft forever
    inet6 ::1/128 scope host
       valid_lft forever preferred_lft forever
2: eth0: <NO-CARRIER,BROADCAST,MULTICAST,UP> mtu 1500 qdisc mq state DOWN qlen 1000
    link/ether 00:11:00:11:0c:00 brd ff:ff:ff:ff:ff:ff
3: eth1: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc mq state UP qlen 1000
    link/ether 0c:00:0a:c4:0a:c3 brd ff:ff:ff:ff:ff:ff
    inet 192.168.1.18/24 brd 192.168.1.255 scope global dynamic noprefixroute eth1
       valid_lft 85621sec preferred_lft 85621sec
    inet6 240d:18:38:cd00:a5a3:440a:4c47:a41c/64 scope global dynamic noprefixroute
       valid_lft 7578sec preferred_lft 7578sec
    inet6 fe80::648f:5ec2:82fb:f291/64 scope link noprefixroute
       valid_lft forever preferred_lft forever
4: ppp0: <POINTOPOINT,MULTICAST,NOARP,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UNKNOWN qlen 3
    link/ppp
    inet 10.231.34.86/32 scope global noprefixroute ppp0
       valid_lft forever preferred_lft forever

host モードは、コンテナからホスト OS のネットワークインターフェースの設定を行いたい場合に適しています。

swu イメージの作成

swu イメージの作成は、 ATDE 上で実施します。

ATDE 上にコネクションファイルをコピーし、パーミッションを 600 に設定します。

[ATDE ~/mkswu]# mkdir network-setting && cd network-setting
[ATDE ~/mkswu/network-setting]# cp /path/to/ethernet-eth0.nmconnection . 
[ATDE ~/mkswu/network-setting]# ls
ethernet-eth0.nmconnection
[ATDE ~/mkswu/network-setting]# chmod 600 ethernet-eth0.nmconnection 

swu イメージ作成に用いる network-setting.desc ファイルを以下の通り作成します。

[ATDE ~/mkswu/network-setting]$ cat network-setting.desc
component=extra_os.nw_eth0
version=1

swdesc_files --dest /etc/NetworkManager/system-connections "ethernet-eth0.nmconnection" 

mkswu を実行して swu イメージを作成します。

[ATDE ~/mkswu/network-setting]# mkswu network-setting.desc
Enter pass phrase for /home/atmark/mkswu/swupdate.key: 
network-setting.swu を作成しました。

[ATDE ~/mkswu/network-setting]# ls
ethernet-eth0.nmconnection  network-setting.desc  network-setting.swu

swu イメージのインストール

swu イメージの Armadillo-IoT ゲートウェイ G4 への転送方法ですが、既にネットワークに接続されている場合はリモートアップデートで実施、ネットワーク接続していない機器に対し設定を行う場合は USBメモリを用いて実施するなど、 それぞれの環境に応じて選択してください。

インストール方法については、Armadillo-IoT ゲートウェイ G4 の製品マニュアルの「Armadilloのソフトウェアをアップデートする」を参照してください。