仮想GPIOドライバひとまず完成

仮想GPIOドライバがひとまず完成しました。

GitHubの以下の場所にアップしています。
vgpio

動作確認は、ubuntu 18.04 (2019/05/06時点のupdate済)でしました。

●使い方
０．ビルドする。

cd vgpio
make

→vgpio.koができる。

１．ドライバをinsmodする。

sudo insmod vgpio.ko

→/sys/kernel/vgpioができる。

２．使いたいGPIOポートを作成する。
（例）GPIO23を作成する場合

echo 23 > /sys/kernel/vgpio/export

→GPIO23ができる。

あとは、通常のGPIOと同じ使い方です。

３．direction、value、edge、active_lowを読み書きする。
（例）GPIO23を入力モードにして、1回読み出す

echo "in" > /sys/kernel/vgpio/gpio23/direction
cat /sys/kernel/vgpio/gpio23/value

４．もう使わない場合は、vgpio.koをrmmodする

sudo rmmod vgpio.ko

→/sys/kernel下のvgpioと、作っていたgpio23が消える。
※作成したGPIOポートは、unexport操作しなくても
rmmodすると自動的にunexportします。

使い方は以上です。

●注意点
※１．本物のGPIOは、入力モードに設定しているので
書き込みはできませんが、この仮想GPIOでは、
入力モードでも書き込みができてしまいます。
デバッグで、GPIOの値を変える場合は、別コンソールで
echoなどでvalueの値を書き換えてください。

※２．select/pollのシステムコールが、現在使えません。
すぐできそうですですが、私がやりたいことは
現状でできたので、とりあえずこのままにします。

----------------------------------------------------------

この仮想GPIOドライバは、linuxカーネルのリポジトリの
以下のファイルを参考にしました。

v4.18
/samples/kobject/kobject-example.c
/drivers/gpio/gpiolib-sysfs.c

・アクセス権について
本物のGPIOでは、otherのアクセス権が読出しのみになっています。
これはカーネルレベルで制限かけられていました。
/include/linux/kernel.h VERIFY_OCTAL_PERMISSIONSマクロ
/fs/sysfs/group.c create_files関数

ラズベリーパイなどでは、GPIO操作用のGPIOグループがあり、
piユーザはGPIOグループに属しており、
GPIOの各属性にGPIOグループで読み書きしているようです。

PCでデバッグするとき、GPIOグループ作って、各属性を
GPIOグループに変えて、GPIOグループへの権限を変えて・・・
ということをいちいちするのは面倒なので、
仮想GPIOドライバではちょっと細工して、otherでも読み書き
できるようにしました。

・select/poll対応について
現在はできません。なので、edgeになにか書き込んでも
特に影響ありません。（書き込み自体はできます）
カーネルの以下の機能を使えばできそうであることはわかっています。
sysfs_get_dirent()　　edgeがnone以外が書き込まれたら、kernfs_nodeを取得する
sysfs_notify_dirent()　valueが変化したら、kernfs_nodeにイベント発生を通知する
sysfs_put() edge、active_lowが変化したら、kernfs_nodeを解放する

仮想GPIOを/sys/class以下に作ってみたものの

仮想GPIOドライバをとりあえず作ってみました。
設定値をメモリ上にとって、gpiochipへの読み書きを
メモリの値に置き換えるだけなので、とりあえず動くものは
すぐにできました。

gpiolib-sysfs.cを参考にして、/sys/class以下に
vgpioという名前のディレクトリを作って、
その配下にexport等を作るようにしました。
しかし、同時に/sys/devices/virtual/vgpioもできてしまう。

また、動作させてexportへ任意の番号を書き込むとgpioNができるが、
このエイリアスが/sys/devices/virtual/vgpio/gpioNになり、
direction、value、edge、active_low以外にpower、uevent等
よくわからないものがたくさんできていました。

ただ direction/value/edge/active_low だけ読み書きできれば
良いのですが・・他のはsysfsのclassAPIが作ってるものなので、
なにか意図しないことが起きるかもしれない・・

というわけで、別の方法を模索してみます。

linux kernelのリポジトリを見ると、/samples/kobject があります。
これは、/sys/kernel以下にアトリビュートというファイルのようなものを
作って読み書きするサンプルです。
（sysfsはファイルではなくアトリビュートと言う）
これが、ほぼやりたいことをしているので、これを参考にして作り直します。
こんなのがあったんだな。

GPIO操作のPCテスト環境について考える

GPIO操作のテスト環境は、ほぼ実機でのテストしかできません。
（と思ってるけど、実はあるのだろうか・・）

例えば、GPIO23に出力するとき、コンソールで以下のようにします。

> echo 23 > /sys/class/gpio/export
> echo "out" > /sys/class/gpio/gpio23/direction
> echo 1 > /sys/class/gpio/gpio23/value

この操作を、実機ではなくPC上で行おうとすると、
最初の exportへ23を書き込む ところで、引数エラーになります。

> echo 23 > /sys/class/gpio/export
echo: 書き込みエラー: 無効な引数です

dmesgで見ると、以下のメッセージが出力されています。

> dmesg
    ～省略～
[  955.6530668] export_store: invalid GPIO 23

これを出してるのは、linux v4.18.0 のカーネルソースを見ると、
以下の場所で出力しているようです。
/drivers/gpio/gpiolib-sysfs.c

453 static ssize_t export_store(struct class *class,
454    struct class_attribute *attr,
455    const char *buf, size_t len)
456 {
    ～省略～
465     desc = gpio_to_desc(gpio);
466     /* reject invalid GPIOs */
467     if (!desc) {
468         pr_warn("%s: invalid GPIO %ld\n", __func__, gpio);
469         return -EINVAL;
470     }

エラーになってるのはgpio_to_desc関数で、引数gpioに対応する
ディスクリプタを返すが、このディスクリプタはカーネルソース内で
チップ情報によって作成されています。つまり、この動作を変えるには、
カーネルソースの再ビルドが必要となりそうです。

なので、GPIO操作のテストには実機が必要だが、現場では数人で
実機を共有しているので、気軽にテストできません。
ようやく実機使えてテストしたら、「不等号の向き間違えた」なんかの
つまらないバグが出ると、時間の無駄だし、気が滅入ってきます。
なので、PC上でコーディングミスレベルの不具合は潰しておきたい。

PC上での方法を考えると、デバッグ時は/sys/class/gpio/gpioN/value を
mkfifo で作ったパイプで代替する方法をしている人が、私の職場でいました。
しかし、これは、書き込み側は動作は変わらないが、読み出し側がパイプを
readしたときに書き込みがあるまで関数がブロックしてしまいます。
また、読み出しが遅い場合、書き込みを、例えば2回１を書き込んだ場合、
読み出すと11になるので、一文字ずつ処理するなど、実機の場合には
不要な処理を足さなくてはならないので面倒です。

カーネルソースのgpiolib-sysfs.cを見ていると、実ポートには出力せず、
メモリ上の値を読み書きするだけの、GPIOの動作を模擬できる
仮想GPIOドライバが作れそうです。

というわけで、このゴールデンウィーク中に仮想GPIOドライバを
作ってみることにしました。