i8253 PIT をアクセスするデバイスドライバ

i8253 PIT をアクセスするデバイスドライバ †

デバイスをアクセスするドライバを作ります。Windows そして古くは MS-DOS を実行できる PC ならば備わっていると考えられる i8253 Programmable Interval Timer (PIT) にアクセスします。今時の PC ならばほぼ使われていないはずの Channel 1 (D-RAM Refresh conter あるいは D-RAM Refresh timer) のレジスタにアクセスします。

今時の PC の i8253 Channel1 は D-RAM 制御に使われていないの？

今どきの完全な PC の回路が公開されていないので、断言はできません。30pin SIMM, 72pin DIMM を使用するのであれば、i8253-i8237 (PIT-DMAC) の組あるいは i8253(i8254) を timer として容易に Refresh 回路を構成できます。これより機能が増えた DIMM を使用する回路になると i8253 を使用する利点が無くなります。North bridge または CPU に統合された D-RAM controller であれは i8253 を D-RAM controller の一部に組み込むのを止めていると考えられます。i8253, i8237, 440BX North Bridge

次に示す左側の図が PC の構成で i8253 PIT が存在する位置、右側の図が i8253 PIT とその周辺の図です。

↑

仕様 †

おおよその仕様は次の通りです。

項目	仕様
動作環境	PC-AT 仕様のパソコン、PentiumIII あるいはこれより新しいプロセッサを使用している
対象デバイス	i8253 PIT channel1
デバイスの形態	platform device
ドライバの機能	read counter, write rate, readback rate (ドライバ内部に保存した値を読み出し)
ドライバの種類	platform device driver
ドライバ実装形態	kernel に直接組み込む部分とモジュール部分に分割
user space API	sysfs node

割り込み処理は実装しません。物足りないかもしれません。

仕様に書かれた内容を見ていきます。

↑

platform device †

platform device とは実行環境に固定的に接続され、ほかのデバイスの初期化をしなくても使えるデバイスです。多くの場合、プロセッサから出ているバスに直接接続されているか、初期化が不要または boot loader などで初期化が済んでしまっている BUS bridge を通して接続されているデバイスです。platform_device_register() で kernel に登録します。

on board の PCI 接続デバイスはどの様な扱いになるの？

/drivers/pci にある PCI bus ドライバ群で扱います。PCI bus bridge の初期化が必要なため PCI device として扱います。PCI bus のアドレス空間配置などを Linux kernel で都合よく扱えるように初期化し管理しています(pci_assign_resource()、pci_reassign_resource())。PCI デバイスを発見して登録する処理 pci_device_add()、PCI デバイスのためのドライバを登録する処理 pci_register_driver() 辺りを手掛かりにコードを追いかけてみてください。

↑

platform driver †

platform driver は platform device のためのドライバです。platform_driver_register() で kernel に登録します。platform_device_register()、platform_driver_register() それぞれの呼び出しでデバイスとドライバの組み合わせが見つかったならばドライバの probe 処理が呼ばれます。

↑

kernel と module に組み込み場所を分割する †

kernel に静的にリンクするコードと module として構成し動的にリンクするコードに分割して実装します。それぞれは次のように機能します。

↑

kernel に静的にリンクするコード †

kernel を修正するパッチと構築する方法は kernel に組み込む - i8253 PIT をアクセスするデバイスドライバを参照して下さい。

実装	機能
kernel に静的にリンクするコード i8253_ref_setup.c	i8253 channel 1 を platform device として登録します。 /arch/x86/kernel に配置
kernel の Makefile	i8253_ref_setup.c を kernel に静的に結合します。 /arch/x86/kernel/Makefile を修正
kernel の Kconfig	i8253_ref_setup.c を組み込むかどうか make menuconfig で選択する。*_defconfig チェックします。 /arch/x86/Kconfig を修正
device header file i8253_control.h	i8253 のレジスタを定義します。 include/linux に配置
driver header file i8253_ref.h	platform device の IO 空間配置と初期設定をドライバに渡す定義です。 include/linux に配置

↑

module として構成し動的にリンクするコード †

module として構築するソースは i8253_ref.tar.gz からダウンロードして下さい。前節の「kernel に静的にリンクするコード」を kernel に組み込んで再起動した後に構築を行って下さい。構築と kernel への組み込みは HelloWorld ページの Makefile を参考に行って下さい。

実装	機能
module として構成したドライバ i8253_ref.c	i8253 channel 1 をアクセスします。
上の Makefile	i8253_ref.c を kernel object として構築します。

急に大規模な開発になった様に感じるかもしれません。Linux kernel はデバイスとドライバを分けて扱っています。デバイスのためのコードとドライバのためのコードをそれぞれ書きます。

デバイスとドライバを一つのモジュール(ソースファイル)で同時に登録してはいけないの？

ドライバを作ろうとするデバイスのレジスタアドレスが固定的なのにわざわざファイルを分割してまで書くか？ kernel の中を見回すと platform_create_bundle() の様に kernel にデバイスとドライバを同時に登録する処理が用意されています。/drivers/block/floppy.c の様にデバイスとドライバを同一のファイル内で kernel に登録する記述も見られます。ドライバを分割して作るまでもないと判断したら、手を抜いても良いかもしれません。

↑

sysfs node を API にする †

DEVICE_ATTR() を使い sysfs node を user space から操作するための API にします。可能な操作は限定的です。単純な open-read-close, または open-write-close の流れに限定されます。一度の read, write で転送できる長さは read: PAGE_SIZE - 1 以下, write: PAGE_SIZE 以下です。i8253 のカウンタは単純な機能なのでこれで十分です。

i8253_ref_setup.c と i8253_ref.c を組み込んだことで新しく作られた sysfs ノードは /sys/devices/platform/i8253_ref.0.auto に作成されます。リンク先を参考にして下さい。

別のページ sysfs ノードからデバイスをアクセスするで PC に既に備わっている i8042 キーボード・マウス・デバイスの sysfs ノードを探っているので参考にして下さい。

汎用性が高い mknod(1)、mknod(2) で作成した major, minor 番号を持ったファイルシステム上のノードを使った API は別の機会で扱おうと考えています。

↑

実行してみる †

kernel への組み込みとドライバモジュールの構築が終了した所で実行してみます。次は実行例です。カレント・ディレクトリの移動、super user への昇格等の操作は省略してあります。

/home/furuta/work/i8253_ref # insmod i8253_ref.ko
/home/furuta/work/i8253_ref # dmesg | tail
-- snip --
[   83.406414] i8253_ref: module verification failed: signature and/or required key missing - tainting kernel
[   83.406646] i8253_ref_init: Called.
[   83.406672] i8253_ref_probe: Called. pdev=0xffffffff81c2d7e0, dev=0xffffffff81c2d7f0
[   83.406679] i8253_ref i8253_ref.0.auto: Probed. refresh_counter=0x41, control_word=0x43, channel=0x1
[   83.406692] i8253_ref i8253_ref.0.auto: Current state. rate_default=0xffffffff, counter=0x03fd
/home/furuta/work/i8253_ref # cd /sys/devices/platform/i8253_ref.0.auto
/sys/devices/platform/i8253_ref.0.auto # ls -la
total 0
drwxr-xr-x  3 root root    0  9月 14 13:51 .
drwxr-xr-x 13 root root    0  9月 10 16:11 ..
-r--r--r--  1 root root 4096  9月 14 13:52 counter
lrwxrwxrwx  1 root root    0  9月 14 13:52 driver -> ../../../bus/platform/drivers/i8253_ref
-rw-r--r--  1 root root 4096  9月 10 16:11 driver_override
-r--r--r--  1 root root 4096  9月 10 16:11 modalias
drwxr-xr-x  2 root root    0  9月 10 16:11 power
-rw-r--r--  1 root root 4096  9月 14 13:52 rate
lrwxrwxrwx  1 root root    0  9月 10 16:11 subsystem -> ../../../bus/platform
-rw-r--r--  1 root root 4096  9月 10 16:11 uevent
/sys/devices/platform/i8253_ref.0.auto # cat rate
-1
/sys/devices/platform/i8253_ref.0.auto # function counter10()
> {
> i=10
> while (( $i > 0 )); do cat counter | tr $"\n" " "
> i=$(( $i - 1 ))
> done
> echo
> }
/sys/devices/platform/i8253_ref.0.auto # echo 1024 > rate
/sys/devices/platform/i8253_ref.0.auto # cat rate
1024
/sys/devices/platform/i8253_ref.0.auto # counter10
231 130 182 138 279 244 333 347 454 478 
/sys/devices/platform/i8253_ref.0.auto # echo 4096 > rate
/sys/devices/platform/i8253_ref.0.auto # counter10
4077 3004 1975 1019 3989 2732 1812 48 3057 3589 
/sys/devices/platform/i8253_ref.0.auto # echo 16384 > rate
/sys/devices/platform/i8253_ref.0.auto # counter10
10136 5012 16161 10961 6046 814 12356 7081 2149 11508 
/sys/devices/platform/i8253_ref.0.auto # echo 32768 > rate
/sys/devices/platform/i8253_ref.0.auto # counter10
24422 19127 13902 8937 3789 31305 26177 20952 15912 8919 
/sys/devices/platform/i8253_ref.0.auto # echo 0 > rate
/sys/devices/platform/i8253_ref.0.auto # counter10
59635 52731 47698 42600 37532 32366 27360 22063 17032 11880 
/sys/devices/platform/i8253_ref.0.auto # rmmod ~furuta/work/i8253_ref/i8253_ref.ko
/sys/devices/platform/i8253_ref.0.auto # dmesg | tail
--snip--
[  259.205029] i8253_ref_exit: Called.
[  259.205075] i8253_ref i8253_ref.0.auto: Remove. dev=0xffffffff81c2d7f0

↑

i8253_ref 全体のデータ構造 †

次の図は i8253 PIT channel1 デバイスとこれを操作するためのドライバに関係するデータ構造です。デバイスとドライバのために最低限扱う必要がある範囲です。構造体のメンバに含まれるポインタ、内包する構造体を追えばもっと範囲は広がります。

うす青の構造体は Linux kernel で定義された構造体です。うす橙の構造体はこのページに書かれた i8253 ドライバのために定義した構造体です。

"Prepared in i8253_ref_setup.c" と書かれた囲みの中が kernel の初期化処理に追加した静的なデータ構造です。ドライバを作る立場から見て platform device の仕様・特性を保持する構造体になります。

"Allocated in i8253_ref.c" と書かれた囲みの中がドライバの状態維持のため i8253_ref.c で動的確保するデータ構造です。ドライバ自身の状態、デバイスの状態のコピーなどを保持します。より多くの機能と処理を行うドライバは排他制御・同期・参照カウンタなどをメンバーとして持ちます。

device 構造体の driver_data メンバ getter/setter

device 構造体の driver_data メンバは getter (dev_get_drvdata()) と setter (dev_set_drvdata()) を使ってアクセスします。珍しく排他制御などの付加的な機能がない getter/setter があるメンバです。

↑

i8253_ref_setup.c: kernel に platform device を登録する †

kernel の初期化処理で i8253 を platform device として登録します。/arch/x86/kernel の下に i8253_ref_setup.c を新しく作成し、この中に実装します。

ディレクトリの下に配置したソースをコンパイル対象にする

C 言語で書いたソースをディレクトリに置いただけではコンパイルされません。少なくともそのディレクトリの Makefile を編集してコンパイル対象に加える様にします (/Documentation/kbuild/makefiles.txt)。Makefile の位置は一部例外的に上位ディレクトリに有るかもしれません。多くの場合、Kconfig ファイルを編集して make menuconfig または *_defconfig ファイルの指定にてコンパイル対象にするか選択できる様にします (/Documentation/kbuild/kconfig-language.txt)。詳細は kernel に静的にソースを結合する方法を見て下さい。

↑

initcall †

次のコード片は i8253_ref_setup.c の初期化処理部分です。

i8253_ref_setup.c

-
|
!
 
-
|
|
|
-
|
|
|
|
!
|
!

/*
 * Register i8253 PIT platform device.
 */
static int __init i8253_ref_device_initcall(void)
{       int             ret;
 
        /* Register i8253 as platform device. */
        ret = platform_device_register(&i8253_ref_platform_device);
        if (ret != 0) {
                pr_err("%s: Can not register platform %s device. "
                       "ret=%d\n",
                        __func__, I8253_REF_DEVICE_NAME, ret
                );
        }
        return ret;
}
 
/* Add i8253_ref_device_initcall() to initialize function table. */
arch_initcall(i8253_ref_device_initcall);

kernel 初期化処理の時に呼ぶ関数を arch_initcall() で指定します。呼び出す順番を気にする場合は loader script (.lds) で厳密に制御する、既に存在する他の初期化処理コードを修正するなどして都合の良さそうな前後順になる様にして下さい。

arch_initcall() で指定した i8253_ref_device_initcall() の処理は platform_device_register() で i8253 デバイスを登録するだけです。エラーチェックをしています。しかし、エラーは発生しないはずです。ここでエラーになる場合は resource が衝突しているか、メモリが kernel 起動時から少ない場合です。

↑

platform device と platform driver の繋がり †

次のコード片は i8253_ref_device_initcall() で kernel に登録した i8253 device の情報です。IO ポート番号は resource を使って宣言し、i8253 デバイスの詳細な設定情報は platform_device のメンバ dev.platform_data で指した i8253_ref.h で定義した構造体 i8253_ref_platfrom_data に格納しています。 kernel のデータ構造 resource, platform_device とドライバで定義したマクロとデータ構造 i8253_ref.h を参考に読んで見て下さい。

i8253_ref_setup.c

-
|
!
-
-
|
|
|
!
-
|
|
|
!
!
 
-
|
!
-
|
|
!
 
-
|
|
!
-
|
|
|
|
|
-
|
!
!
 
-
|

/* i8253 PIT Refresh counter and control port resource.
 * @note name(s) are compared with argument name of platform_get_resource_byname().
 */
static struct resource i8253_ref_ports[] = {
        {       .name =         I8253_REF_RESOURCE_REFRESH_COUNTER,
                .start =        PIT_CH1,
                .end =          PIT_CH1,
                .flags =        IORESOURCE_IO,
        },
        {       .name =         I8253_REF_RESOURCE_CONTROL_WORD,
                .start =        PIT_MODE,
                .end =          PIT_MODE,
                .flags =        IORESOURCE_IO,
        },
};
 
/*
 * Platform parameters will be passed to driver.
 */
static struct i8253_ref_platfrom_data i8253_ref_ch1 = {
        .channel =      1,      /*!< Refresh counter channel. */
        .rate_default = I8253_REF_RATE_DEFAULT_KEEP,    /*!< Initial rate value. */
};
 
/*
 * Define i8253 PIT channel 1, refresh counter as platform device.
 * 
 */
static struct platform_device i8253_ref_platform_device = {
        .name =          I8253_REF_DEVICE_NAME, /*!< device name match to driver name. */
        .id =            PLATFORM_DEVID_AUTO,   /*!< automatic id numbering. */
        .id_auto =       true,                  /*!< automatic id numbering. */
        .num_resources = ARRAY_SIZE(i8253_ref_ports),
        .resource =      i8253_ref_ports,
        .dev = {        /*!< struct device. */
                .platform_data = &i8253_ref_ch1, /*!< pass platform parameter to driver. */
        },
};
 
/*
 * Register i8253 PIT platform device.

kernel に登録した情報の中に device と driver を結びつけるための情報が含まれています。I8253_REF_DEVICE_NAME です。この文字列をキーにして platform device と platform driver を対応づけます。resource 構造体の配列にも文字列 I8253_REF_RESOURCE_REFRESH_COUNTER, I8253_REF_RESOURCE_CONTROL_WORD が含まれています。これは $ cat /proc/ioports で表示される様になります。文字列をキーにして driver 側で I/O ポート番号を platform_get_resource_byname()で取得できます。デバイス固有のパラメータは platform_device.dev.platform_data で指した先に構造体 i8253_ref_platfrom_data を配置し、driver に渡します。

i8253_ref.h

#define I8253_REF_DEVICE_NAME   "i8253_ref"
 
#define I8253_REF_RATE_DEFAULT_KEEP             (~(uint32_t)0)
#define I8253_REF_RESOURCE_REFRESH_COUNTER      "refresh_counter"
#define I8253_REF_RESOURCE_CONTROL_WORD         "control_word"

↑

i8253_ref.c: i8253 をアクセスするドライバ †

i8253_ref.c がソースコード全体です。

↑

init †

モジュールを初期化する処理から見ていきましょう。module_init() マクロに初期化処理関数 i8253_ref_init() を指定します。これは HelloWorld モジュールと同じです。printk() で関数が呼び出されたことを表示します。デバッグ目的です。platform_driver_register() で platform driver を登録します。

Linux Kernel Driver Quest

主ページ

副ページ

OpenGrok Link

管理ページ

最新の20件