デバイスドライバ実装の用語集（82語）

モジュールをカーネルに直接組み込んだ場合はアンロードが起きないため、__exitの付いた関数はバイナリから除外される。module_exitで指定するクリーンアップ関数に付けるのが定番の使い方。

この印が付いた関数は起動時またはモジュールロード時にしか呼ばれないため、実行後にカーネルがそのメモリを破棄できる。メモリの限られた組込み環境で特に効果がある。module_initと組で使う。

C言語のソースを make でビルドすると生成される。insmod に渡して組み込む。modprobe は /lib/modules 配下に配置済みの .ko を名前で探して読み込む。

アプリが close したときに呼ばれるハンドラを登録する。ファイルの最後の利用者が手を離したときの後始末という意味合いで release という語が使われる。

/dev/null（捨て場）、/dev/sda（ディスク）、/dev/ttyS0（シリアル）など。現代では udev が機器の接続に応じて中身を動的に作る。

alloc_chrdev_region(&dev, baseminor, count, name) で未使用の番号を割り当ててもらう。取り外し時は unregister_chrdev_region で対にして解放する。

メジャー番号を固定で指定するregister_chrdev_regionと違い、空いている番号をカーネルに割り当ててもらう現代的な方法。確保した番号はcdevの登録に使い、終了時はunregister_chrdev_regionで返す。

cdev_init で file_operations と結びつけ、cdev_add でデバイス番号とともにカーネルへ登録する。取り外しは cdev_del で行う。MKDEV / MAJOR / MINOR で番号を組み立て・分解する。

自作ドライバではcdev_initでfile_operationsと結びつけ、cdev_addでデバイス番号とともにカーネルへ登録する。この登録によって、/devのデバイスファイルへのopenやreadが自分のドライバの関数へ届くようになる。取り外し時はcdev_delで解除する。

cdev_initでfile_operationsと結び付けたcdevを、デバイス番号とともにシステムへ追加する。この呼び出しの直後からopen等が飛んでくる可能性があるため、初期化を全て済ませてから呼ぶのが鉄則。

ドライバのwrite処理で、アプリから渡されたデータを受け取るときに使う。ユーザ空間のポインタをカーネル側で直接参照するのは危険なため、アドレス検査付きのこの関数を経由する。copy_to_userと向きが逆になるだけで、役割は対になっている。

ドライバのread処理で、読み取った結果をアプリ側のバッファへ渡すときに使う。ユーザ空間のアドレスは不正な場合があるため、検査付きのこの関数を使い、memcpyで直接書き込んではいけない。戻り値はコピーできなかったバイト数で、0なら成功。

copy_to_user はカーネル→ユーザ、copy_from_user はユーザ→カーネル。戻り値はコピーできなかった残りバイト数で、0 なら全て成功。1バイトなら put_user / get_user を使う。

modprobeはこの依存情報を頼りに、必要なモジュールを正しい順序で自動ロードする。自作モジュールを/lib/modules配下に置いたらdepmodを実行しないとmodprobeで見つからない、という手順の要になる。

メジャー番号がドライバの種類を、マイナー番号が個々のデバイスを表す。MAJOR/MINORマクロで取り出し、MKDEVで合成する。キャラクタデバイスの登録やdevice_createの引数として頻出する。

managed(devm)系APIの代表で、デバイスの切り離し時に自動で解放されるため、probe失敗時やremoveでのkfree忘れを防げる。kzallocはゼロクリア付きのkmallocに相当する。

起動ログ、機器の認識、ドライバのエラー、printk の出力などが時系列で並ぶ。ドライバ開発では状態把握と原因切り分けの第一手になる。

起動時のハードウェア検出の記録や、ドライバのprintk出力がここに溜まる。自作モジュールの動作確認は「insmodしてdmesgを見る」が基本の流れ。メッセージが多いときは dmesg | tail で末尾だけ確認すると効率がよい。

カーネル内の名前(シンボル)は既定では自分のモジュール内でしか使えず、これで公開して初めて他のモジュールが参照できる。GPLモジュール限定で公開するEXPORT_SYMBOL_GPLという変種もある。公開されたシンボルはカーネルのシンボルテーブルで管理される。

.open・.read・.write などのメンバに自作関数を割り当てる。cdev に紐づけて登録すると、アプリの open/read/write がここ経由でドライバに届く。

open・read・write・releaseなどのメンバに自作関数のアドレスを設定して登録する。アプリがreadシステムコールを呼ぶと、対応するドライバの関数が呼び出される仕組み。キャラクタデバイスドライバ開発の中心になる構造体。

ユーザー空間のポインタは不正な場合があるため直接参照せず、アクセス検査付きのこのマクロを使う。整数など単純な値を1個取り出す用途で、まとまったデータの転送はcopy_from_userが担当する。

組込みでは100や250、デスクトップでは1000などに設定される。jiffiesを秒に換算する係数であり、HZの値を決め打ちしたコードは設定の違うカーネルで時間がずれる。msecs_to_jiffies等の変換関数を使うと安全。

マスタ(SoC側)が通信を主導し、各スレーブはアドレスで区別されるため、少ない配線でセンサや液晶などを複数ぶら下げられる。信号線にはプルアップ抵抗が必要。似た用途のSPIより配線が少ない代わりに速度は控えめ、という対比で覚えるとよい。

install moduleの略で、ファイルパスを直接指定して読み込む。依存する他のモジュールまでは自動で読み込まないため、依存解決までしてくれるmodprobeとの違いがよく問われる。自作ドライバの動作確認で最初に使う基本コマンド。

MMUのあるシステムではカーネルも仮想アドレスで動くため、GPIOなどペリフェラルの物理アドレスをそのままは触れない。ioremapで得た仮想アドレス経由でレジスタを読み書きする。使い終えたらiounmapで対応づけを解除する。

ioremapは物理アドレス上のペリフェラルレジスタをカーネル仮想空間に貼り付ける関数で、iounmapはその後始末。ドライバのremove処理やエラーパスで必ず対にして呼ぶ。解除漏れはアドレス空間のリークになる。

タイマ割り込みは1秒間にHZ回(例えば100回)発生し、jiffiesはそのたびに1ずつ増える。「jiffies + HZ」で1秒後を表すなど、カーネル内の時間管理やタイマ処理の基準として使う。単位が秒ではなく「割り込みの回数」である点を混同しやすい。

動作中のカーネルと噛み合う形で .ko を作る。モジュール側の Makefile から make -C /lib/modules/$(uname -r)/build M=$(pwd) modules で呼び出して使う。

KERN_INFO は通常の情報、KERN_ERR はエラーを表す。printk(KERN_ERR "...") のように本文の直前に続けて書く。付けなければ既定のレベルになる。

旧来の/sys/class/gpio(sysfs方式)が非推奨となり、/dev/gpiochipNを扱うこのライブラリと付属コマンド(gpioset・gpioget等)が後継になった。グローバルなGPIO番号ではなくチップとライン番号で指定するのが特徴。

モジュール名・サイズ・参照カウント・依存しているモジュール名が一覧される。自作ドライバが正しく組み込まれたかの確認や、rmmodできない原因(どこから使われているか)の調査に使う。実体は/proc/modulesの内容を整形したもの。

「mknod /dev/mydev c 240 0」のように、種別(cはキャラクタ、bはブロック)とメジャー・マイナー番号を指定して作る。現在はudevが自動生成するのが普通だが、ドライバ学習では番号との対応関係を理解するために手動作成を体験する。

ページテーブルに従ってアドレス変換とアクセス保護を行い、プロセスごとに独立したメモリ空間を実現する。LinuxはMMUを前提とするOSで、MMUなしのマイコン向けには派生のuClinuxが使われてきた。

MODULE_LICENSEやMODULE_DESCRIPTION等のマクロで埋め込まれた情報と、module_paramの一覧、依存関係を.koファイルから読み出して表示する。ロード前にモジュールの素性を確認する道具。

モジュールAがBを必要とするなら、Bも自動で先に読み込んでくれる。依存情報はdepmodが作るデータベースを参照するため、/lib/modules配下に正しく配置されたモジュールが対象。ファイルパス指定で単発読み込みするinsmodとの違いが定番の混同点。

ソースコードに MODULE_LICENSE("GPL") のように書く。宣言がない、またはGPLと非互換だとカーネルが「汚染(taint)」扱いになり、GPL限定で公開されているカーネル内関数が使えなくなる。モジュール作成の雛形に必ず入る1行。

変数名・型・sysfs上の権限を指定して宣言すると、「insmod mymod.ko value=10」のように組み込み時に値を渡せる。組み込み後も/sys/module配下のファイル経由で読み書きできる場合がある。ビルドし直さずに動作を調整したいときに便利。

obj-m := hello.o のように、ソース名の拡張子を .o にした形で書く。kbuild がこの .o をもとに最終的な .ko を生成する。

出力先はカーネルリングバッファで、dmesg や journalctl で読む。KERN_INFO・KERN_ERR などのログレベルを先頭に付けて重要度を示せる。

カーネル空間では標準Cライブラリが使えないため、printfの代わりにこれを使う。KERN_INFOなどのログレベルを付けて重要度を区別でき、出力はdmesgで確認する。printfと違って画面に直接出ないことに戸惑うのが初学者の定番のつまずき。

ドライバ登録の瞬間ではなく「デバイスとドライバが結び付いた瞬間」に呼ばれるのが要点。ここでレジスタの初期化や資源の確保を行う。Device Treeのcompatible文字列との一致がマッチングの典型条件。

get_userの書き込み版で、アドレスが不正なら-EFAULTを返す。ioctlハンドラで結果の数値を1個だけ返す場面などで使う。まとまったサイズの転送はcopy_to_userが担当する。

同じレジスタ領域を複数のドライバが触る事故を防ぐための登録制度で、予約状況は/proc/iomemに載る。ioremapの前に呼び、解放はrelease_mem_region。ハード的な保護ではなく、あくまで登録による排他である。

remove moduleの略で、取り外すときにモジュールの終了処理(exit関数)が呼ばれる。デバイスを開いているプロセスがいるなど使用中のモジュールは外せずエラーになる。insmodとセットで、自作ドライバを直しては入れ直す反復テストに使う。

Raspberry PiのBCMシリーズのように、CPU・メモリコントローラ・GPIO・I2Cコントローラ等が1チップに収まる。同じARMコアでも周辺回路の構成はSoCごとに違うため、Device Treeで構成をカーネルへ伝える。

SCLK・MOSI・MISO・CSの4線を使い、I2Cより高速な代わりに配線が多い。通信相手の選択はアドレスではなくCS線の電気的な選択で行う。Linuxではspidevや、spi_sync等のカーネルAPI経由で扱う。

デバイスやドライバの状態がディレクトリ構造で整理され、catやechoで読み書きできる。ドライバに属性ファイルを追加すれば、専用ツールなしで動作パラメータを操作できる。実体はメモリ上にあり、ディスク上のファイルではない点に注意。

昔は /dev に全デバイスファイルを静的に並べていたが、今は udev が実際に存在する機器の分だけ作る。ルールで名前付けや権限を制御できる。

ユーザ空間で動くデーモンで、カーネルからのイベント(uevent)を受けて動作する。ルールファイルを書けばデバイスファイルの名前や権限を自由に決められる。USB機器を挿すと/devにファイルが現れるのはこの働きで、mknodによる手動作成を置き換えた。

Userspace I/Oの略。カーネル側は割込みの通知とレジスタ領域のメモリマップ提供だけを担い、実際の制御はmmapしたユーザープログラムが行う。本格的なドライバを書くまでもない独自ハードの制御に向く。

EXPORT_SYMBOLで公開されたシンボルだけが他のモジュールから利用できる。EXPORT_SYMBOL_GPLはGPL互換ライセンスのモジュール限定になる。現在の一覧は/proc/kallsymsで確認できる。

kthread_run等で生成し、ドライバのポーリング処理やワークキューの実行役として働く。psコマンドで[kworker]のように角括弧付きで表示されるのがこれ。通常のプロセスと違いユーザー空間のメモリを持たない。

拡張子は .ko。insmod / modprobe で組み込み、rmmod / modprobe -r で外す。カーネルを再ビルドせずに機能を追加でき、ドライバ開発の基本単位になる。

デバイスドライバの多くはこの形式で作られ、insmodやmodprobeで動作中のカーネルへ組み込める。再起動やカーネル本体の作り直しなしに機能を追加できるのが利点。ただしカーネル空間で動くため、バグがあるとシステム全体を巻き込んで停止することがある。

ハードウェアへ直接アクセスできる強い権限を持つ反面、ここでの不具合はシステム全体を巻き込みやすい。モジュールはこのカーネル空間で実行される。

ハードウェアやメモリ全体へアクセスできる強い権限を持つ反面、バグがシステム全体の停止(カーネルパニック)に直結する。ユーザ空間とはメモリが分離されており、データの受け渡しにはcopy_to_userなどの専用関数を使う必要がある。

キーボード・シリアルポート・端末などが該当。バッファ単位ではなくストリーム的に読み書きする。自作ドライバの最初の題材として扱いやすい。

シリアルポートやキーボードなどが該当し、ls -lで見ると行の先頭が「c」と表示される。自作ドライバの入門はほぼキャラクタデバイスから始まる。ブロック単位でランダムアクセスするストレージ系のブロックデバイスとの対比で覚える。

グローバル変数jiffiesは1秒間にHZ回増える。「今から100ms後」はjiffies + HZ/10のように計算し、カーネルタイマやタイムアウト判定に使う。オーバーフロー対策としてtime_after等の比較マクロを使うのが作法。

機械接点のバウンドが原因で、数ミリ秒の間に複数回のエッジが発生する。GPIO割込みでボタン押下を数えると1回の操作が多重カウントされる典型的な要因であり、デバウンス処理で取り除く。

組込み機器ではPCと違いハードウェアを自動検出できないことが多く、どのアドレスに何がつながっているかを記述して起動時にカーネルへ渡す。ソース(.dts)をコンパイルしたバイナリ(.dtb)が使われる。Raspberry Piの周辺機器設定でも登場する。

「すべてはファイル」の思想に基づく入口。read / write するとドライバ経由で機器を操作できる。メジャー・マイナー番号で担当ドライバと結びつく。

アプリが/dev/xxxを開くと、カーネルはこの番号を手がかりに担当ドライバの処理関数を呼び出す。ls -lでデバイスファイルを見ると、サイズの位置に2つの番号が表示される。プログラム上はdev_t型で表し、上位がメジャー・下位がマイナーに対応する。

一定時間内の再変化を無視する、タイマで信号が安定してから再サンプルするなどの方式がある。ドライバではカーネルタイマやワークキューで実装するほか、GPIOサブシステムのデバウンス設定を使える場合もある。

ディスクやSSDが代表。ブロック単位で読み書きし、キャッシュやスケジューラを介して効率化される。ファイルシステムはこの上に構築される。

ストレージ類が該当し、好きな位置へのランダムアクセスとバッファリングを前提とする。ls -lで見ると行の先頭が「b」と表示される。1バイトずつ順番に流れるキャラクタデバイスとの区別は、デバイス分類の基本として頻出する。

それぞれが物理アドレス上のレジスタ群として見え、レジスタへの読み書きで制御する。データシートのペリフェラル章とレジスタマップを読み解くことが、デバイスドライバ開発の出発点になる。

作りが単純で確実だが、変化がない間も確認し続けるためCPU時間を消費する。対になるのが、イベント発生時にだけ動く割り込み方式。変化が非常に頻繁な場合や割り込みが使えない場面ではポーリングが有利なこともあり、使い分けが設計の要点になる。

例えば同じ種類のシリアルポートが4つあれば、メジャー番号は共通でマイナー番号0〜3で区別する。ドライバはopen時に渡される情報からマイナー番号を取り出し、どの装置への操作なのかを判定して処理を切り替える。

1つのドライバが1つのメジャー番号を受け持つのが基本形。自作ドライバでは、alloc_chrdev_regionで空き番号を動的に確保する方法が推奨される。個々の装置を区別するのはマイナー番号の役目で、両者の分担を混同しやすい。

ls -l /dev でサイズの位置に「8, 0」のように表示される。同じドライバ配下の複数機器をマイナー番号で区別する。mknod で番号を指定してファイルを作ることもできる。

module_paramマクロで宣言すると「insmod mydrv.ko debug=1」のように指定でき、/sys/module/以下から実行中に参照できる。再コンパイルせずにドライバの動作を切り替える定番の手段。

modprobe はこの依存を depmod が作った一覧をもとに自動でたどり、必要なモジュールを先に読み込む。insmod は依存を解決しないため、単体で扱うとき以外は modprobe が安全。

ハードウェアへの直接アクセスは許されず、必要ならシステムコールを通じてカーネルに依頼する。プログラムが暴走しても他のプロセスやカーネルに波及しにくい。ドライバ開発では「ユーザ空間のポインタはカーネルから直接触れない」点が重要になる。

カーネル空間で動くドライバがこのアドレスをそのまま読み書きすると事故につながる。put_user / get_user / copy_to_user / copy_from_user を介して安全にやり取りする。

0=EMERG が最も深刻、7=DEBUG が最も軽い。数字が小さいほど緊急度が高い。/proc/sys/kernel/printk のしきい値で、どのレベルまでコンソールに出すかが決まる。

レベルによってコンソールへ即時表示されるかが決まり、dmesgでは全て確認できる。pr_infoやdev_errなどレベル込みのラッパーを使うのが現代の作法。表示の閾値は/proc/sys/kernel/printkで調整する。

割込みハンドラでは時間のかかる処理やスリープする処理ができないため、work_structを積んでおきカーネルスレッドの文脈で後から実行させる。スリープできる点がタスクレットやsoftirqとの大きな違い。

各プロセスは同じ番地でも別々の物理メモリを指す独立した空間を持つ。ドライバでペリフェラルを触るときも物理アドレスを直接は使えず、ioremapで仮想アドレスへ変換してからアクセスする。

ボタン押下やデータ到着の瞬間にだけ処理を走らせるため、常に監視し続けるポーリングよりCPUを無駄にしない。ドライバでは割り込みハンドラを登録して応答するが、ハンドラの中では長い処理や待ち(スリープ)が許されないという制約がある。

SoCのデータシートに載っているレジスタアドレスはこの物理アドレス。MMUが有効なカーネルやアプリからは直接触れないため、ioremapやmmapで仮想アドレスへ対応付けてからアクセスする。