デバイスドライバのUbuntu Server 24.04への対応

[KuraZuzu]

What does this implement/fix?

Ubuntu Server 24.04上でデバイスドライバをビルドして動作するように修正しました。

Does this close any currently open issues?

#81 をクローズします。

How has this been tested?

以下の手順にしたがってビルドとサンプルプログラムの動作確認をしました。

環境

• Raspberry Pi Mouse V3
  • Raspberry Pi 4B
    • Ubuntu Server 24.04 (kernel: 6.8.0-1008-raspi)
    • Ubuntu Server 22.04 (kernel: 5.15.0-1061-raspi)
    • Raspberry Pi OS (32-bit) (kernel: 6.6.31+rpt-rpi-v8)
    • Raspberry Pi OS (64-bit) (kernel: 6.6.31+rpt-rpi-v8)
  • Raspberry Pi 3B v1.2
    • Ubuntu Server 24.04 (kernel: 6.8.0-1008-raspi)
    • Ubuntu Server 22.04 (kernel: 5.15.0-1061-raspi)
    • Raspberry Pi OS (32-bit) (kernel: 6.6.31+rpt-rpi-v8)
    • Raspberry Pi OS (64-bit) (kernel: 6.6.31+rpt-rpi-v8)

手順

以下の手順で動作確認まで行います。環境により、操作が違います。

Ubuntu Server 24.04

1. sudo apt update && sudo apt upgradeを実行します

2. /boot/firmware/config.txtを編集し、ファイル末尾に以下の記述を追加します

dtoverlay=anyspi:spi0-0,dev="microchip,mcp3204",speed=1000000
dtparam=i2c_baudrate=62500

3. Raspberry Pi を再起動します

4. 以下のコマンドを実行し、出力が62500になっていることを確認します

$ printf "%d\n" 0x$(xxd -ps /sys/class/i2c-adapter/i2c-1/of_node/clock-frequency)
62500

5. ラズパイマウスのデバイスドライバのコードをcloneし、本開発リポジトリにチェックアウトした後にインストールします

$ git clone -b spi-overlay https://github.com/rt-net/RaspberryPiMouse.git
$ cd RaspberryPiMouse/utils
$ sudo apt install linux-headers-$(uname -r) build-essential
$ ./build_install.bash

6. step1.shからstep6.shのサンプルプログラムの動作を確認します（この手順は、ラズパイマウスのマニュアルの通りです）

$ cd ../SampleProgram
$ bash step1.sh
$ bash step2.sh
.
.
.
$ bash step6.sh

Ubuntu Server 22.04

1. sudo apt update && sudo apt upgradeを実行します

2. /boot/firmware/config.txtを編集し、ファイル末尾に以下の記述を追加します

Ubuntu`dtparam=i2c_baudrate=62500`

5. Raspberry Pi を再起動します

6. ラズパイマウスのデバイスドライバのコードをcloneし、本開発リポジトリにチェックアウトした後にインストールします

$ git clone -b spi-overlay https://github.com/rt-net/RaspberryPiMouse.git
$ cd RaspberryPiMouse/utils
$ sudo apt install linux-headers-$(uname -r) build-essential
$ ./build_install.bash

7. step1.shからstep6.shのサンプルプログラムの動作を確認します（この手順は、ラズパイマウスのマニュアルの通りです）

$ cd ../SampleProgram
$ bash step1.sh
$ bash step2.sh
.
.
.
$ bash step6.sh

Raspberry Pi OS（32-bit, 64-bitで共通）

モニタとマウスをRaspberry Piに接続し、GUI上で操作します。

1. 起動したら、GUIからSPIとI2Cを有効化します

画像の通り、[画面左上のロゴマーク] -> [Preferences] -> [Raspberry Pi Configuration] とクリックしたら出てくるウィジェットから、SPIとI2CのトグルをONにします。

これ以降は、ターミナルを開いて操作します。

2. sudo apt updateを実行します

3. /boot/firmware/config.txtを編集し、ファイル末尾に以下の記述を追加します

arm_64bit=0の記述は、64-bit版では不要です。

arm_64bit=0  # 64-bit版では不要です
dtoverlay=anyspi:spi0-0,dev="microchip,mcp3204",speed=1000000
dtparam=i2c_baudrate=62500

4. Raspberry Pi を再起動します

5. 以下のコマンドを実行し、出力が62500になっていることを確認します（同時にxxdのインストールも行います）

$ sudo apt install xxd
$ printf "%d\n" 0x$(xxd -ps /sys/class/i2c-adapter/i2c-1/of_node/clock-frequency)
62500

6. ラズパイマウスのデバイスドライバのコードをcloneし、本開発リポジトリにチェックアウトした後にインストールします

$ git clone -b spi-overlay https://github.com/rt-net/RaspberryPiMouse.git
$ cd RaspberryPiMouse/utils
$ sudo apt install linux-headers-$(uname -r) build-essential
$ ./build_install.bash

7. step1.shからstep6.shのサンプルプログラムの動作を確認します（この手順は、ラズパイマウスのマニュアルの通りです）

$ cd ../SampleProgram
$ bash step1.sh
$ bash step2.sh
.
.
.
$ bash step6.sh

Any other comments?

Checklists

• I have read the CONTRIBUTING guidelines.
  • If there is no guideline in the repository, rt-net organization's guideline applies.
• I have checked to ensure there aren't other open Pull Requests for the same change.

[ShotaAk]

確認しました。実機動作ができているため良いと思います。
コメントを残したので、他のPRで対応お願いします。

#IF文の分岐が増えていたり、冗長なコードが増えていたり、可読性が落ちているのが懸念点です。

別のPRでリファクタリングを実施しましょう。

[ShotaAk]

現状の設定では、RasPi 4Bの環境でしかビルドテストできていません。

別のPRで、3Bの32bit版でもテストできるように項目を増やしてください。
参考：https://www.raspberrypi.com/documentation/computers/linux_kernel.html#cross-compile-the-kernel

[ShotaAk]

この行の末尾にコメントで、「カーネル〇〇 以下の場合は不要です」と追記してください。

また、これらを手動で追加するのは難しいので、自動で設定するスクリプトを追加してください。
別PRで良いです。

[KuraZuzu]

追加しました。マイナーバージョンを含めた場合分けを考慮して未満という表現にしました。

dtoverlay=anyspi:spi0-0,dev="microchip,mcp3204",speed=1000000 # カーネル5.16未満の場合は不要です

[ShotaAk]

LGTMです