udevルールの書き方

内容

1. この文書について
2. 更新履歴
3. 執筆時に使用したソフトウェアのバージョン
4. 用語紹介: devfs、sysfs、ノードなど
5. なぜルールを書く必要がありますか? (この文書の目的)
6. ルールを書く上での基本事項
7. NAMEとSYMLINKパラメータでの設定自動化のための付加機能
8. キーでのシェル形式パターン照合の使い方
9. キーを書く上での基本事項
10. 基本キーによるデバイス識別方法
11. SYSFSファイルによるデバイス識別方法
12. 複数SYMLINK形式の使い方
13. 所有権とパーミッション制御
14. 例: 著者所有のUSBプリンタ向けのルールの書き方
15. 例: USBストレージ方式対応デジカメ向けのルールの書き方
16. USBストレージ向けルールの書き方に関する追記
17. 例: 著者所有のCDドライブに便利なルールの書き方
18. 例: 著者所有のネットワークインターフェースに名前を付けるルールの書き方
19. SYSFS内におけるudevinfoを実行すべき場所を探し出すコツ
20. ルールのデバッグ方法
21. 著者と謝辞

この文書について

更新履歴

執筆時に使用したソフトウェアのバージョン

用語紹介: devfs、sysfs、ノードなど

なぜルールを書く必要がありますか?

ルールを書く上での基本事項

1. システムにあるいろいろなデバイスに一致する、少なくとも一つの識別キー(identification key)を指定する必要があります。 識別キーついては、後にある基本キーによるデバイス識別方法セクションに記載されています。
2. 結果としてデバイスノードがどのようにして作成されるかを制御するための、少なくとも一つの割当てキー(assignment key)を指定する必要があります。 割当てキーには、NAME、SYMLINK、OWNER、GROUP、MODEがあり、このドキュメントですべて説明しています。

BUS="usb", SYSFS{serial}="HXOLL0012202323480", NAME="lp_epson", SYMLINK="printers/epson_stylus"

# udevstart

NAMEとSYMLINKパラメータでの設定自動化のための付加機能

BUS="usb", SYSFS{vendor}="FUJIFILM", SYSFS{model}="M100", NAME="camera%n"

キーでのシェル形式パターン照合の使い方

KERNEL="ts*", NAME="input/%k"

"ts"の文字列で始まり、その後に任意で何かの文字が続くKERNEL名によって識別されるデバイスに一致し、指定ディレクトリの下にKERNEL名(%k)で名前をつけます。

例えば, パターン文字列"tty[SR]"は、"ttyS"か"ttyR"に一致します。

KERNEL="fd[0-9]*", NAME="floppy/%n"

"fd"で始まり、それに一文字の何かの数字が続き、その後に任意で何かの文字が続くKERNEL名によって識別されるデバイスに一致します。フロッピーのディレクトリの下にデバイスのカーネル番号(%n)でデバイスに名前をつけます。

キーを書く上での基本事項

基本キーによるデバイス識別方法

• BUS - デバイスのバスの種類と照合されます。
• KERNEL - カーネルデバイス名と照合されます。
• DRIVER - カーネルドライバの名前と照合されます。
• SUBSYSTEM -カーネルサブシステム名と照合されます。
• ID - バス上のデバイスナンバー(PCIバスIDなど)と照合されます。
• PLACE - デバイスが接続された物理的な位置と照合されます(USBに役に立ちます)。

SYSFSファイルによるデバイス識別方法

# udevinfo -a -p /sys/path/to/hardware/info

# udevinfo -q path -n /dev/sda

/block/sda

# udevinfo -a -p $(udevinfo -q path -n /dev/sda)

follow the class device's "device"
  looking at the device chain at '/sys/devices/pci0000:00/0000:00:02.1/usb3/3-3/3-3:1.0/host0/0:0:0:0':
    BUS="scsi"
    ID="0:0:0:0"
    SYSFS{detach_state}="0"
    SYSFS{type}="0"
    SYSFS{max_sectors}="240"
    SYSFS{device_blocked}="0"
    SYSFS{queue_depth}="1"
    SYSFS{scsi_level}="3"
    SYSFS{vendor}="        "
    SYSFS{model}="USB 2.0M DSC    "
    SYSFS{rev}="1.00"
    SYSFS{online}="1"

  looking at the device chain at '/sys/devices/pci0000:00/0000:00:02.1/usb3/3-3':
    BUS="usb"
    ID="3-3"
    SYSFS{detach_state}="0"
    SYSFS{bNumInterfaces}=" 1"
    SYSFS{bConfigurationValue}="1"
    SYSFS{bmAttributes}="c0"
    SYSFS{bMaxPower}="  0mA"
    SYSFS{idVendor}="052b"
    SYSFS{idProduct}="1514"
    SYSFS{bcdDevice}="0100"
    SYSFS{bDeviceClass}="00"
    SYSFS{bDeviceSubClass}="00"
    SYSFS{bDeviceProtocol}="00"
    SYSFS{bNumConfigurations}="1"
    SYSFS{speed}="12"
    SYSFS{manufacturer}="Tekom Technologies, Inc"
    SYSFS{product}="USB 2.0M DSC"

BUS="scsi", SYSFS{manufacturer}="Tekom Technologies, Inc", NAME="%k"

複数SYMLINK形式の使い方

KERNEL="hdc", SYMLINK="dvd"

所有権とパーミッション制御

KERNEL="fb[0-9]*", NAME="fb/%n", SYMLINK="%k", GROUP="video"

KERNEL="fd[0-9]*", OWNER="john"

SUBSYSTEM="sound", GROUP="audio"

KERNEL="inotify", NAME="misc/%k", SYMLINK="%k", MODE="0666"

例: 著者所有のUSBプリンタ向けのルールの書き方

# udevinfo -q path -n /dev/lp0
/class/usb/lp0

looking at the device chain at '/sys/devices/pci0000:00/0000:00:02.1/usb3/3-3':
BUS="usb"
SYSFS{manufacturer}="EPSON"
SYSFS{product}="USB Printer"
SYSFS{serial}="L72010011070626380"

BUS="usb", SYSFS{serial}="L72010011070626380", NAME="%k", SYMLINK="epson_680"

例: 著者所有のUSBストレージ方式対応デジカメ向けのルールの書き方

# udevinfo -a -p /sys/block/sda/sda1

SYSFS{product}="USB 2.0M DSC"

BUS="usb", SYSFS{product}="USB 2.0M DSC", KERNEL="sd?1", NAME="%k", SYMLINK="camera"

USBストレージ向けルールの書き方に関する追記

BUS="usb", KERNEL="sd*", SYSFS{product}="USB 2.0 Storage Device", NAME="%k", SYMLINK="usbhd%n"

• /dev/usbhd - fdiskすることができるノード
• /dev/usbhd1 - 一つ目のパーティション (マウント可能)
• /dev/usbhd2 - 二つ目のパーティション (マウント可能)

BUS="usb", SYSFS{product}="USB 2.0 Storage Device", NAME{all_partitions}="usbhd"

例: 著者所有のCDドライブ向けの有用なルールの書き方

BUS="ide", KERNEL="hdc", NAME="%k", SYMLINK="dvd cdroms/cdrom%n"
BUS="ide", KERNEL="hdd", NAME="%k", SYMLINK="cdrw cdroms/cdrom%n"

例: USB Visor Palm Pilot向けのルールの書き方

BUS="usb", SYSFS{product}="Palm Handheld", KERNEL="ttyUSB*", SYMLINK="pilot"

例: 著者所有のネットワークインターフェースに名前を付けるルールの書き方

# udevinfo -a -p /sys/class/net/eth0/
  looking at class device '/sys/class/net/eth0':
    SYSFS{address}="00:52:8b:d5:04:48"

KERNEL="eth*", SYSFS{address}="00:52:8b:d5:04:48", NAME="lan"

SYSFS内におけるudevinfoを実行すべき場所を探すためのコツ

• ルールを書こうとしているデバイスに対し、すでに/devの下にデバイスノードが作成されているなら、運がよいです! 適切な/sysのパスを得るために、次のコマンドを実行してください。udevinfo -q path -n /dev/ノード名
• ルールを書く手間を軽くするために、常にudevinfoを使用してください。 /sys/blockや/sys/classの下を参照するために、常にudevinfoを使用してください(別のところから、チェイン情報を読むことはありません)。
• 何も手がかりがなければ、/sysの下のすべて"dev"ファイルを探すために、次のコマンドを使用してくだい(udevinfoは、このファイルがあるディレクトリ上でのみ動作します。)。find /sys -iname dev
• 対象のデバイスが、フラッシュカードリーダや、USBフラッシュドライブ、/dev/sdXが作成されるUSBストレージとして振舞うデジタルカメラの場合、/sys/block/sdXを探してみてください。
• 上記の状況に該当する場合、必ずsdXとsdX1とを区別して下さい。sdX1に一致するキーKERNEL="sd?1"もしくは、sdXに一致するKERNEL="sd?"で区別できます。
• /dev/lpXとして作成されるUSBプリンタについては、/sys/class/usb/lpXから探すべきです。
• USBスキャナドライバは、最近カーネルから削除され、(SANEパッケージの一部として)ユーザスペースで再実装されました。 特定のカーネルドライバに依存しないように、この種のハードウェア用のルールを書いてはいけません(し、書けないでしょう)。
• あいにくカーネルはsysfsですべてのデバイスの情報を開示するわけではありません。 よって、まだ一部のデバイスに対してはルールを簡単に書くことができません。 2004年2月20日時点で、udevの作者はsysfsに未対応のドライバが162個残っていると言っています。

ルールのデバッグ方法

# udevtest /sys/class/sound/dsp/
version 056
looking at '/class/sound/dsp/'
opened class_dev->name='dsp'
configured rule in '/etc/udev/rules.d/50-udev.rules[132]' applied, added symlink '%k'
configured rule in '/etc/udev/rules.d/50-udev.rules[132]' applied, 'dsp' becomes 'sound/%k'
creating device node '/dev/sound/dsp', major = '14', minor = '3', mode = '0660', uid = '0', gid = '18'

著者と謝辞