ぷらっとホーム株式会社

Copyright (c) 2013-2023 Plat'Home CO., LTD.

このソフトウェアを使えばOpenBlocksのファームウェアを作成することができます。内容は、シェルスクリプトとファームウェアに含めるファイルです。

OpenBlocksのファームウェアは、機種(OpenBlocksシリーズ, OpenBlocks IoTシリーズ)とOS(Debian GNU/Linux)によって異なります。対応しているファームウェアは下の表をご覧ください。

BXn: BX0, BX1, BX1S, BX3, BX5

項目TARGETとDISTは、ファームウェアを作成するときに実行するシェルスクリプトに指定する文字列です。後節で参照します。

作成ホストのOSは、2. 対応ファームウェアの表を参照してください。ホストを用意して、そのOSをインストールします。ホストは物理マシンと仮想マシンのどちらでもよろしいです。インターネットに接続できるよう、ネッワークの設定をしてください。

このソフトウェアはGitリポジトリから取得できます。

作成ホストにgitパッケージをインストールします。

# apt update
# apt install git

Gitリポジトリを取得します。

$ git clone https://github.com/plathome/debian_based_firmware.git

以下では、ディレクトリdebian_based_firmwareに移動したものとして説明します。

リリースしたファームウェア毎にタグを付けています。以下のコマンド

$ git tag

でタグの一覧が表示されます。

ファームウェアのバージョンとタグの対応は、以下のコマンド

$ git show タグ名

や、以下のページ

https://github.com/plathome/debian_based_firmware/releases

から知ることができます。

タグ名を指定してファームウェアを作成するには以下のコマンドを実行します。

$ git checkout -b ブランチ名 タグ名

ここでブランチ名は、お好みの文字列を指定してください。

ファームウェアの作成に必要なパッケージをインストールします。

• 作成するホストのOSが、Debian GNU/Linux 8/amd64の場合。

# cd build_ramdisk
# ./build_crossenv.sh

• 作成するホストのOSが、Debian GNU/Linux 9/amd64の場合。

# cd build_ramdisk
# ./build_crossenv-stretch.sh

• 作成するホストのOSが、Debian GNU/Linux 10/amd64の場合。

# cd build_ramdisk
# ./build_crossenv-buster.sh

• 作成するホストのOSが、Debian GNU/Linux 11/amd64の場合。

# cd build_ramdisk
# ./build_crossenv-buster.sh

カーネルソースファイルをぷらっとホームのFTPサイトftp.plathome.co.jpからダウンロードしてディレクトリsourceにコピーします。

ファイルbuild_ramdisk/config.shのcase文中のKERNELとPATCHLEVELからカーネルソースファイルのFTPサイトに置いてある場所が分ります。

以下は場所の例です。

• TARGET=obsix9r, DIST=bullseye, KERNEL=4.9.198, PATCHLEVEL=100の場合
  https://ftp.plathome.co.jp/pub/OBSIX9R/bullseye/4.19.198-100/linux-4.19.198-obsiot-20211027.tar.xz

ディレクトリsourceには、TARGETをその名前としたディレクトリがあるので、そこにカーネルソースファイルを展開してください。その結果、ディレクトリsource/TARGET/linux-KERNEL(およびlinux-KERNEL.orig)が作成されます。TARGETとKERNELは、ご自身の文字列に置き換えてください。

# rm -rf source/TARGET/linux-KERNEL (存在するならば削除します。)
# rm -rf source/TARGET/linux-KERNEL.orig (存在するならば削除します。)
# tar xpf source/<カーネルソースファイル名> -C source/TARGET/

DebianのDVDイメージをDebianのミラーサイトからダウンロードしてディレクトリisofilesにコピーします。

ファイルbuild_ramdisk/config.shのcase文中のISOFILEからDVDイメージのファイル名が分ります。

以下はファイル名の例です。

• TARGET=obsix9r, DIST=bullseyeの場合
  debian-11.1.0-amd64-DVD-1.iso

これらのファイルは
https://ftp.plathome.co.jp/pub/cdimages/debian/
https://cdimage.debian.org/mirror/cdimage/archive/
からも取得できます。

ファームウェアを作成します。シェルスクリプトbuild_ramdisk/buildall.shのオプション-MにTARGET、-DにDISTを指定します。 ARGET=obsix9r、DIST=bullseyeの場合、

# cd build_ramdisk
# ./buildall.sh -M obsix9r -D bullseye

と実行します。

作成されたファームウェア一式は、ディレクトリrelease/TARGET/DIST/KERNEL-PATCHLEVELに置かれます。TARGET, DIST,KERNEL, PATCHLEVELは、ご自身の文字列に置き換えてください。

本節ではファームウェアのカスタマイズの手順を説明します。

シェルスクリプトbuild_ramdisk/buildall.shを実行することは、DIST=bullseye, TARGET=obsix9rの場合、以下の通り実行することと同じです。

# DIST=bullseye TARGET=obsix9r ./build_debootstrap.sh
# DIST=bullseye TARGET=obsix9r ./build_kernel.sh
# DIST=bullseye TARGET=obsix9r ./build_ramdisk.sh
# DIST=bullseye TARGET=obsix9r ./release_firmware.sh

TARGETとDISTについては、予め次のように設定することで、毎回の指定は不要になります。

# export DIST=bullseye TARGET=obsix9r

内容の詳細は各シェルスクリプトを読んでいただくことにして、簡単に説明しておきます。以下のTARGETとDISTは、ご自身の文字列に置き換えてください。

• build_debootstrap.sh
  debootstrapを実行し、ディレクトリrootfs/DIST_TARGET以下にDebianを仮インストールしています。
• build_kernel.sh
  カーネルとカーネルモジュールのコンパイルをしています。
• build_ramdisk.sh
  ディレクトリrootfs/DIST_TARGET以下に仮インストールしたDebianをOpenBlocks用に変更して、RAMディスクイメージを作成しています。
• release_firmware.sh
  ファームウェア一式を作成しています。

上記のシェルスクリプトを手動で実行すれば、その途中で、カーネルとRAMディスクイメージのカスタマイズができます。

ファイルbuild_ramdisk/config.shのcase文中のPATCHLEVELには文字列などを追加、例えば3customとすることをお勧めします。公式ファームウェアとの区別がはっきりします。

カスタマイズの前に、その準備として、シェルスクリプトbuild_ramdisk/buildall.shを実行しておいてください。

カーネルのコンフィグレーションを変更してカーネルをカスタマイズすることができます。カーネルをカスタマイズしない場合には、「5.2. RAMディスクイメージ」節に進んでください。

次のコマンドを実行して、カーネルのコンフィグレーションを変更します。TARGETとDISTは、ご自身の文字列に置き換えてください。

# DIST=bullseye TARGET=obsix9r ./kernel_menuconfig.sh

変更したコンフィグレーションファイルはsource/TARGET/linux-KERNEL.dot.configにコピーされます。TARGETとKERNELは、ご自身の文字列に置き換えてください。

シェルスクリプトbuild_ramdisk/build_kernel.shから順番に実行するか、シェルスクリプトbuild_ramdisk/buildall.shを実行してください。RAMディスクイメージをカスタマイズする場合、シェルスクリプトbuild_ramdisk/build_kernel.shを実行して、次節に進んでください。

シェルスクリプトbuild_ramdisk/build_ramdisk.shの実行が終了すると、ディレクトリrootfs/DIST_TARGETに、RAMディスクに含まれるファイルが仮インストールされます。ディレクトリrootfs/DIST_TARGET以下のファイルを変更したり、パッケージを追加すれば、RAMディスクイメージのカスタマイズができます。DISTとTARGETは、ご自身のものに置き換えてください。

追加するパッケージをDebianのミラーサイトからダウンロードして、ディレクトリextradebs/DISTにコピーします。DISTは、ご自身の文字列に置き換えてください。

次のコマンドを実行してパッケージを追加します。DIST=bullseye,TARGET=obsix9rの場合、

# DIST=bullseye TARGET=obsix9r ./06_add_extra_packages.sh

と実行します。

パッケージが追加されたかは、ファイルrootfs/DIST_TARGET/var/lib/dpkg/statusで確認できます。TARGETとDISTは、ご自身の文字列に置き換えてください。

ディレクトリrootfs/DIST_TARGET以下のファイルをもとにRAMディスクイメージを作成します。TARGETとDISTは、ご自身の文字列に置き換えてください。DIST=bullseye, TARGET=obsix9rの場合、

# DIST=bullseye TARGET=obsix9r ./99_create_ramdisk.sh

と実行します。

ファームウェアを作成します。DIST=bullseye, TARGET=obsix9rの場合、

# DIST=bullseye TARGET=obsix9r ./release_firmware.sh

と実行します。

一度「5.1.1. コンフィグレーションの変更」と「5.2.1. パッケージの取得」をすませておけば、シェルスクリプトbuild_ramdisk/buildall.shを実行するだけでカスタマイズのすんだファームウェアが作成できます。

ファームウェアパッケージkernel-image-KERNEL-PATCHLEVEL-TARGET.debをOpenBlocksにネットワーク経由もしくはUSBメモリでコピーしてください。KERNEL，PATCHLEVELとTARGETは、ご自身の文字列に置き換えてください。

次のコマンド

# dpkg -i kernel-image-KERNEL-PATCHLEVEL-TARGET.deb

を実行してください。

RAMディスクモードの場合はflashcfgコマンドを実行することをお勧めします。ファームウェアのバージョンとパッケージに関する情報内のバージョンが合わなくなる場合があります。（合わなくても動作に影響はありません。）

# flashcfg -S

再起動すれば、ファームウェアの更新は終了です。