デバイスドライバのUbuntu Server 24.04への対応 (#84)

Author: KuraZuzu

.github/workflows/driver-cross-build.yml

@@ -39,8 +39,8 @@ jobs:
           - { HOST: 20.04, KERNEL_VER: rpi-5.4.y, OS_BIT: armhf }  # Debian 10 (Buster)
           - { HOST: 20.04, KERNEL_VER: rpi-5.10.y, OS_BIT: armhf }  # Debian 11 (Bullseye)
           - { HOST: 22.04, KERNEL_VER: rpi-5.15.y, OS_BIT: armhf }  # Debian 11 (Bullseye)
-          # - { HOST: 24.04, KERNEL_VER: rpi-6.6.y, OS_BIT: armhf }  # Debian 12 (Bookworm) 32-bit
-          # - { HOST: 24.04, KERNEL_VER: rpi-6.6.y, OS_BIT: arm64 }  # Debian 12 (Bookworm) 64-bit
+          - { HOST: 24.04, KERNEL_VER: rpi-6.6.y, OS_BIT: armhf }  # Debian 12 (Bookworm) 32-bit
+          - { HOST: 24.04, KERNEL_VER: rpi-6.6.y, OS_BIT: arm64 }  # Debian 12 (Bookworm) 64-bit
 
     runs-on: ubuntu-${{ matrix.env.HOST }}
 
@@ -76,7 +76,7 @@ jobs:
       run: |
         cd linux
         if [ "${{ matrix.env.OS_BIT }}" == "armhf" ]; then
-          make ARCH=arm CROSS_COMPILE=arm-linux-gnueabihf- M=$GITHUB_WORKSPACE/src/drivers V=1 modules
+          make ARCH=arm CROSS_COMPILE=arm-linux-gnueabihf- M=$GITHUB_WORKSPACE/src/drivers V=1 KBUILD_MODPOST_WARN=1 modules
         else
-          make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- M=$GITHUB_WORKSPACE/src/drivers V=1 modules
+          make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- M=$GITHUB_WORKSPACE/src/drivers V=1 KBUILD_MODPOST_WARN=1 modules
         fi

README.md

@@ -11,7 +11,19 @@ Run the installation script ([`./utils/build_install.bash`](https://github.com/r
 
 インストール用のシェルスクリプト（[`./utils/build_install.bash`](https://github.com/rt-net/RaspberryPiMouse/blob/master/utils/build_install.bash)）を実行します。
 
-### for Raspbian
+### for Raspberry Pi OS
+
+`/boot/firmware/config.txt`を編集し、ファイル末尾に以下の設定を追加します。
+
+```sh
+arm_64bit=0  # "64-bit"版では不要です
+dtoverlay=anyspi:spi0-0,dev="microchip,mcp3204",speed=1000000  # カーネル5.16未満の場合は不要です
+dtparam=i2c_baudrate=62500
+```
+
+Raspberry Piを再起動します。
+
+以下のコマンドでインストールを実行します。
 
 ```sh
 $ git clone https://github.com/rt-net/RaspberryPiMouse.git
@@ -22,6 +34,17 @@ $ ./build_install.bash
 
 ### for Ubuntu
 
+`/boot/firmware/config.txt`を編集し、ファイル末尾に以下の設定を追加します。
+
+```sh
+dtoverlay=anyspi:spi0-0,dev="microchip,mcp3204",speed=1000000 # "Ubuntu Server 22.04"では不要です
+dtparam=i2c_baudrate=62500
+```
+
+Raspberry Piを再起動します。
+
+以下のコマンドでインストールを実行します。
+
 ```sh
 $ git clone https://github.com/rt-net/RaspberryPiMouse.git
 $ cd RaspberryPiMouse/utils
@@ -40,7 +63,7 @@ $ sudo insmod rtmouse.ko
 
 ## Notes for the installation (ドライバの導入の際の注意)
 
-### for Raspbian
+### for Raspberry Pi OS
 
 Enable SPI and I2C functions via `raspi-config` command.
 
@@ -50,17 +73,13 @@ Enable SPI and I2C functions via `raspi-config` command.
 * SPI機能を「入」にする。
 * I2C機能を「入」にする。
 
-2017年1月現在、以下の設定は不要です。  
-rtmouseをインストールして不具合が出た場合のみ以下の設定を追加で行ってください。
-
-* Device Tree機能を「切」にする。
 
 ### for Raspberry Pi 4
 
 Edit [`rtmouse.c`](https://github.com/rt-net/RaspberryPiMouse/blob/dd0343449951a99b067e24aef3c03ae5ed9ab936/src/drivers/rtmouse.c#L54) to change the defined value `RASPBERRYPI` from '2' to '4'.
 
-Raspberry Pi 4ではCPUのレジスタがそれまでのRaspberry Piとは異なります（[issues#21](https://github.com/rt-net/RaspberryPiMouse/issues/21)）。  
-Raspberry Pi 4で本ドライバを使用する際には`rtmouse.c`の以下の行（2020年4月13日現在の最新版のv2.1.0では[54行目](https://github.com/rt-net/RaspberryPiMouse/blob/dd0343449951a99b067e24aef3c03ae5ed9ab936/src/drivers/rtmouse.c#L54)）を`RASPBERRYPI 4`に書き換えてビルドする必要があります。  
+Raspberry Pi 4ではCPUのレジスタがそれまでのRaspberry Piとは異なります（[issues#21](https://github.com/rt-net/RaspberryPiMouse/issues/21)）。
+Raspberry Pi 4で本ドライバを使用する際には`rtmouse.c`の以下の行（2020年4月13日現在の最新版のv2.1.0では[54行目](https://github.com/rt-net/RaspberryPiMouse/blob/dd0343449951a99b067e24aef3c03ae5ed9ab936/src/drivers/rtmouse.c#L54)）を`RASPBERRYPI 4`に書き換えてビルドする必要があります。
 ※[`./utils/build_install.bash`](./utils/build_install.bash)を実行すると、Raspberry Piのモデルに合わせて[`rtmouse.c`](./src/drivers/rtmouse.c)が[自動で書き換わります](https://github.com/rt-net/RaspberryPiMouse/blob/a9af4fa2b2a8e34c0f93a6ce5cf88ebd50ff39c2/utils/build_install.raspi4ubuntu.bash#L13-L14)。
 
 ```c
@@ -74,7 +93,7 @@ Raspberry Pi 4で本ドライバを使用する際には`rtmouse.c`の以下の
 
 ### パルスカウンタについて
 
-パルスカウンタは値の読み取りにI2Cを使用しています。仕様上は400kHzまでbaudrateを上げることができます（※1）。  
+パルスカウンタは値の読み取りにI2Cを使用しています。仕様上は400kHzまでbaudrateを上げることができます（※1）。
 I2Cのbaudrateを上げると通信に失敗する場合がある（[issues#13](https://github.com/rt-net/RaspberryPiMouse/issues/13)）ので、基本的にはI2Cのbaudrateはデフォルト値（※2）から変更して62.5kHzに固定してください。
 
 According to
@@ -86,7 +105,7 @@ Add a following new line in `/boot/firmware/config.txt` to change the i2c_baudra
 ```
 dtparam=i2c_baudrate=62500
 ```
-※1　Raspberry Pi 4 Model B（Ubuntu 18.04とUbuntu 20.04）を搭載して400kHzで通信できることを確認しています。  
+※1　Raspberry Pi 4 Model B（Ubuntu Server `18.04` / `20.04` / `22.04` / `24.04`）を搭載して400kHzで通信できることを確認しています。
 ※2　現在設定されているI2Cのbaudrateは以下のコマンドを実行することで確認できます。
 ```
 $ printf "%d\n" 0x$(xxd -ps /sys/class/i2c-adapter/i2c-1/of_node/clock-frequency)