chiark / gitweb /
[PATCH] Writing udev rules doc update
[elogind.git] / docs / writing_udev_rules / index.html
1 <html>
2 <head>
3 <title>Writing udev rules</title>
4 <META name="resource-type" content="document">
5 </head>
6
7 <body>
8
9 <h1>Writing udev rules</h1>
10 by Daniel Drake (dsd)<br />
11 Version 0.55<br /><br />
12
13 The most recent version of this document can always be found at: <br />
14 <a href="http://www.reactivated.net/udevrules.php">http://www.reactivated.net/udevrules.php</a>
15
16 <h2>Contents</h2>
17 <ol>
18 <li><a href="#about">About this document</a></li>
19 <li><a href="#history">History</a></li>
20 <li><a href="#versions">Software versions used at time of writing</a></li>
21 <li><a href="#terminology">Terminology: devfs, sysfs, nodes, etc.</a></li>
22
23 <li><a href="#why">Why? (The purpose of this document)</a></li>
24 <li><a href="#basics">The basics of writing rules</a></li>
25 <li><a href="#operators">Additional automated customisation for NAME and SYMLINK parameters</a></li>
26 <li><a href="#regexp">Using shell-style pattern matching in keys</a></li>
27 <li><a href="#keys">Key-writing basics</a></li>
28 <li><a href="#identify-keys">Identifying devices through basic keys</a></li>
29 <li><a href="#identify-sysfs">Identifying devices through SYSFS files</a></li>
30 <li><a href="#example-printer">Example: Writing a rule for my USB printer</a></li>
31 <li><a href="#example-camera">Example: Writing a rule for my USB-Storage digital camera</a></li>
32
33 <li><a href="#usbstorage-extra">Additional notes on writing rules for USB storage</a></li>
34 <li><a href="#example-cdrom">Example: Writing convenience rules for my CD drives</a></li>
35 <li><a href="#example-iface">Example: Writing a rule to name my network interface</a></li>
36 <li><a href="#tips">Tips for finding the appropriate places in SYSFS</a></li>
37 <li><a href="#multiple-symlinks">Using multiple SYMLINK style rules</a></li>
38 <li><a href="#nvidia">udev vs Nvidia's graphics drivers</a></li>
39 <li><a href="#author">Author and credits</a></li>
40 </ol>
41
42 <a name="about"></a>
43 <h2>About this document</h2>
44 udev is targetted at Linux kernels 2.6 and beyond to provide a userspace solution for a dynamic /dev directory, with persistent device naming. The previous /dev implementation, <i>devfs</i>, is now deprecated, and udev is seen as the successor. udev vs devfs is a sensitive area of conversation - you should read <a href="http://kernel.org/pub/linux/utils/kernel/hotplug/udev_vs_devfs">this document</a> before making comparisons.<br /><br />
45
46 udev is a well thought out solution, but I was initially very confused how I might customise it for my system. This document attempts to make the process of rule writing a little bit clearer.<br /><br />
47
48 I'm all open to feedback - please <a href="#author">contact me</a></b> with any comments, problems, and suggested improvements.<br /><br />
49
50 This document assumes that you have udev/hotplug installed and running OK with default configurations. If you do not yet have udev configured and running, I would suggest that you follow <a href="http://webpages.charter.net/decibelshelp/LinuxHelp_UDEVPrimer.html#UDEV">Decibels udev Primer</a> to get to this stage (contains some Gentoo Linux specifics, but should be useful for other distro's too).<br /><br />
51
52 <a name="history"></a>
53
54 <h2>History</h2>
55
56 June 20th 2004 v0.55: Added info on multiple symlinks, and some minor changes/updates.<br /><br />
57 April 26th 2004 v0.54: Added some Debian info. Minor corrections. Re-reverted information about what to call your rule file. Added info about naming network interfaces.<br /><br />
58 April 15th 2004 v0.53: Minor corrections. Added info about NAME{all_partitions}. Added info about other udevinfo tricks.<br /><br />
59 April 14th 2004 v0.52: Reverted to suggesting using "udev.rules" until the udev defaults allow for other files. Minor work.<br /><br />
60 April 6th 2004 v0.51: I now write suggest users to use their own "local.rules" file rather than prepending "udev.rules".<br /><br />
61 April 3rd 2004 v0.5: Minor cleanups and preparations for possible inclusion in the udev distribution.<br /><br />
62 March 20th 2004 v0.4: General improvements, clarifications, and cleanups. Added more information about writing rules for usb-storage.<br /><br />
63 February 23rd 2004 v0.3: Rewrote some parts to emphasise how sysfs naming works, and how it can be matched. Updated rule-writing parts to represent udev 018s new SYSFS{filename} naming scheme. Improved sectioning, and clarified many points. Added info about KDE.<br /><br />
64 February 18th 2004 v0.2: Fixed a small omission in an example. Updated section on identifying mass-storage devices. Updated section on nvidia.<br /><br />
65 February 15th 2004 v0.1: Initial publication.<br /><br />
66
67 <a name="versions"></a>
68 <h2>Software versions used at time of writing</h2>
69 Linux Kernel 2.6.7<br />
70 udev 027<br />
71 hotplug 20040401<br /><br />
72
73 <a name="terminology"></a>
74 <h2>Terminology: devfs, sysfs, nodes, etc.</h2>
75 <font size=2>A basic introduction only, might not be totally accurate.</font><br /><br />
76
77 On typical linux-based systems, the <i>/dev</i> directory is used to store file-like device <b>nodes</b> which refer to certain devices in the system. Each node points to a part of the system (a device), which might or might not exist. Userspace applications can use these device nodes to interface with the systems hardware, for example, XFree86 will "listen to" /dev/input/mice so that it can relate the users mouse movements to moving the visual mouse pointer.<br /><br />
78
79 The original <i>/dev</i> directories were just populated with every device that might possibly appear in the system. /dev directories were typically very large because of this. <b>devfs</b> came along to provide a more managable approach (noticably, it only populated /dev with hardware that is plugged into the system), as well as some other functionality, but the system proved to have problems which could not be easily fixed.<br /><br />
80
81 <b>udev</b> is the "new" way of managing <i>/dev</i> directories, designed to clear up some issues with previous <i>/dev</i> implementations, and provide a robust path forward. In order to create and name <i>/dev</i> device nodes corresponding to devices that are present in the system, udev relies on matching information provided by <i>sysfs</i> with <i>rules</i> provided by the user. This documentation aims to detail the process of rule-writing, one of the only udev-related tasks that must (optionally) be performed by the user.<br /><br />
82
83 <b>sysfs</b> is a new filesystem to the 2.6 kernels. It is managed by the kernel, and exports basic information about the devices currently plugged into your system. udev can use this information to create device nodes corresponding to your hardware. sysfs is mounted at <i>/sys</i> and is browsable. You may wish to investigate some of the files stored there before getting to grips with udev. Throughout this document, I will use the terms <i>/sys</i> and <i>SYSFS</i> interchangeably.<br /><br /><br />
84
85 <a name="why"></a>
86 <h2>Why?</h2>
87
88 As stated above, writing rules for udev is an optional process. By default, you can plug a device in, and the a relevant node (e.g. <i>/dev/sda</i> for a mass-storage device) will be there, just like in previous <i>/dev</i> implementations.<br /><br />
89
90 However, udev allows you to customise the naming of device nodes. There are two reasons why you might want to do this: convenience, and persistent naming.<br /><br />
91
92 Take the example of using udev, so that when your printer is plugged in, it gets named as <i>/dev/printer</i> and also as the usual <i>/dev/lp0</i>. It's not only convenience (e.g. reading and interpreting "printer" as opposed to "lp0"), its a solution for non-persistent naming. Say that I have two printers - a HP laser printer and an Epson inkjet. When they are both plugged in and on, I have /dev/lp0 and /dev/lp1.<br />
93
94 How do I know which node refers to which printer? There is no easy way. The first printer that got connected was assigned name "lp0", and the second "lp1". Plugging in my printers in a different order would swap the names here, and that would mess up my scripts that always expect my HP laser printer to be lp1.<br /><br />
95
96 However, if my HP laser printer got named lp_hp (as well as lpX) and my other printer got named lp_epson (as well as lpY), then my scripts could just refer to those names. udev magic can control this and ensure that these <b>persistent names</b> always point to the device that I intended.<br /><br />
97
98 For external mass-storage devices (e.g. usb hard disks), persistent naming is very helpful in that it allows you to hardcode accurate device paths into your <i>/etc/fstab</i>.<br /><br />
99
100 <a name="basics"></a>
101 <h2>The basics of writing rules</h2>
102
103 When populating <i>/dev</i>, udev decides which nodes to include, and how to name them, by reading a series of rules files.<br /><br />
104
105 Default udev rules are stored in <i>/etc/udev/rules.d/50-udev.rules</i>. You may find it interesting to look over this file - it includes a few examples, and then some default rules proving a devfs-style /dev layout. However, you should not write rules into this file directly, to reduce hassle while updating your udev installation in the future.<br /><br />
106
107 Files in <i>/etc/udev/rules.d/</i> are parsed in <b>lexical</b> order. udev will stop processing rules as soon as it finds a matching rule in a file for the new item of hardware that has been detected. It is important that your own rules get processed before the udev defaults, otherwise your own naming schemes will not take effect! I suggest that you keep your own rules in a file at <i>/etc/udev/rules.d/10-local.rules</i> (this doesn't exist by default - create it). As 10 comes before 50, you know that your rules will be looked at first.<br /><br />
108
109 As your own rules will effectively mask out the udev defaults which create the base /dev layout, it is recommended that you also specify devfs-style names/symlinks for the rules you write, so that you get the sensible defaults plus your own names.<br /><br />
110
111 In rule files, lines starting with a "#" are treated as comments. Every uncommented line in the file corresponds to a rule.<br /><br />
112
113 The basic form for a rule is:
114 <pre>key,[key,...] name [, symlink]</pre>
115
116 <ol>
117 <li>At least one key must be specified. Keys are used to identify which devices the rule matches.</li>
118 <li>The name parameter is required. It tells udev what that device should be named as in the /dev tree. It is written in the format NAME="<i>X</i>", where <i>X</i> is what the node will be named. You can specify multiple symlinks here, seperate them with a space.</li>
119 <li>The symlink parameter (optional) allows for you to specify additional places where this node will be linked.</li>
120 </ol>
121
122 Remember that udev will only create one node for one device. If you want it to be accessible through multiple nodes, then you have to specify the other nodes in the SYMLINK parameter.<br /><br />
123
124 I'll take a slightly modified udev example rule to illustrate this:
125 <blockquote><pre>BUS="usb", SYSFS{serial}="HXOLL0012202323480", NAME="lp_epson", SYMLINK="printers/epson_stylus"</pre></blockquote>
126
127 The keys here are the <i>BUS</i> and <i>SYSFS{serial}</i> parameters. udev will match this rule against a device that is connected through the USB bus <u>and</u> with a serial number of HXOLL0012202323480. <b>Note that <u>all</u> (as opposed to any) specified keys must be matched for udev to use the rule to name a device.</b><br />
128
129 udev will name this node <i>lp_epson</i>, and it will be located at <i>/dev/lp_epson</i>.<br />
130 udev will also create a symlink to <i>/dev/lp_epson</i>, located at <i>/dev/printers/epson_stylus</i> (the printers directory will be automatically created). You can now print to your Epson printer by sending data to <i>/dev/printers/epson_stylus</i> or <i>/dev/lp_epson</i>.<br /><br />
131
132 <a name="operators"></a>
133 <h2>Additional automated customisation for NAME and SYMLINK parameters</h2>
134
135 In the NAME and SYMLINK parameters of your rules, you are able to use basic operators to assist the naming of devices. Hackers will know this sort of thing as <i>printf-like string substitution</i>.
136
137 There are a number of operators which can compose some or all of your NAME/SYMLINK parameters. These operators refer to kernel-data relating to the device. Take this example:
138
139 <blockquote><pre>BUS="usb", SYSFS{vendor}="FUJIFILM", SYSFS{model}="M100", NAME="camera%n"</pre></blockquote>
140
141 The <i>%n</i> operator will be replaced with the "kernel number" for the camera device, to produce a NAME such as camera0, camera1, etc.<br /><br />
142
143 Another common operator is <i>%k</i>. This represents what the kernel would name the device, e.g. "hda1". You may often see rules which have NAME="%k" to produce the default names for the hardware. In these rules, customisation is usually done through the SYMLINK parameter.<br /><br />
144
145 <font size="2">A full list of operators, with explanations, can be found in the udev man page.</font><br /><br />
146
147 <a name="regexp"></a>
148 <h2>Using shell-style pattern matching in keys</h2>
149
150 You can use shell style pattern matching to provide even more flexibility when writing keys. Taking a default udev rule:
151
152 <blockquote><pre>KERNEL="ts*", NAME="input/%k"</pre></blockquote>
153
154 The * operator is used here, which matches literally anything - zero, one, or more characters of any kind. The rule literally says:<br />
155
156 <blockquote>Match a device identified by a KERNEL name starting with the letters "ts" optionally followed by anything at all, and name it with the KERNEL name (%k) under the input directory.</blockquote>
157
158 The ? operator is similar, and matches any single character (but not zero characters).<br /><br />
159
160 You can also use square brackets [ ] to match any single character. Direct quote from udev man page:<br />
161 <blockquote>For example,  the pattern string "tty[SR]" would match either "ttyS" or "ttyR".</blockquote>
162
163 You can also specify ranges that can be matched, e.g. [0-9] would match any single digit. Using an example rule from a default udev installation:
164
165 <blockquote><pre>KERNEL="fd[0-9]*", NAME="floppy/%n"</pre></blockquote>
166
167 This rule says:<br />
168
169 <blockquote>Match a device identified by a KERNEL name starting with the letters "fd", followed by any single digit, optionally followed by anything at all. Name the device with the kernel number of the device (%n) under the floppy directory.</blockquote>
170
171 You can use these wildcards/pattern matches in any type of key, including both basic keys and sysfs-based identification (see below for explanations of these key types).<br /><br />
172
173 <font size="2">I have purposely left out some information on this topic (particularly the flexibility of using [ ] operators) that is out of the scope of basic rule-writing documentation. More information on this topic can be found in the udev man page.</font><br /><br />
174
175 <a name="keys"></a>
176 <h2>Key-writing basics</h2>
177
178 udev provides a few basic key matching methods, and also provides flexible ways of matching information in SYSFS. A typical rule will match both normal keys (e.g. BUS and KERNEL), as well as SYSFS keys to differentiate between different hardware plugged in throught the same port.<br /><br />
179
180 You may be wondering, "How do I find the serial number of my printer? What is the model of my camera?". Rule writing isn't as hard as it sounds. The trickiest bit is finding your device in /sys, and deciding which info to use.<br /><br />
181
182 <a name="identify-keys"></a>
183 <h2>Identifying devices through basic keys</h2>
184
185 <font size="2">See the udev man page for more info on these keys.</font><br /><br />
186
187 The valid keys are:
188 <ul><li>BUS - match the bus type of the device.</li>
189 <li>KERNEL - match the kernel device name.</li>
190 <li>ID - match the device number on the bus (e.g. PCI bus ID).</li>
191 <li>PLACE - match the physical position where the device is plugged into (useful for USB).</li>
192
193 </ul>
194
195 The ID and PLACE keys do have their uses, but they are not commonly used in rules. This document focuses on using BUS and KERNEL keys, as well as SYSFS{...} keys (detailed in the next section). I will show how to use these keys by example.<br /><br />
196
197 <font size="2">For extra flexibility, udev also provides keys to call external scripts and examine their result. This is out of scope of this document. Look at the udev man page for more details.</font>
198
199 <a name="identify-sysfs"></a>
200 <h2>Identifying devices through SYSFS files</h2>
201
202 <font size="2">Background information: SYSFS stores many small files under a tree of directories which provide information about your hardware. One file typically contains just one "data item" - e.g. device name, manufacturer, or product ID.<br /><br />
203 Note that SYSFS{...} keys can be combined with the basic keys described in the previous section.</font><br /><br />
204
205 You can use keys in the format SYSFS{<i>filename</i>} to match specific info from SYSFS, where <i>filename</i> corresponds to a file in your SYSFS tree.  For example, when my camera is connected, there is a file located at <i>/sys/block/sda/device/model</i> which contains "USB 2.0M DSC". To match this, I could use the following key: SYSFS{model} = "USB 2.0M DSC"<br /><br />
206
207 <b>Note that <u>any</u> file in sysfs can be matched in this manner, but if you match more than one file (through multiple keys), then you must only match files that exist in the same directory.</b> Typically, there will be several directories giving information about one device. You cannot mix and match (as shown by example below).<br /><br />
208
209 Luckily, the process of rule writing does not entail hunting through millions of files in SYSFS, the <i>udevinfo</i> utility does the hard work. This program is included in the udev distribution.</b><br /><br />
210
211 The first thing you need to do is find a directory somewhere in /sys that corresponds to your hardware, and includes a file named "<i>dev</i>", as udevinfo can only work on directories of this type. These directories are all found under either <i>/sys/block</i> or <i>/sys/class</i> - there is no point looking anywhere else! However, udevinfo will follow links through this directory and read info found from other sections of sysfs.<br /><br />
212
213 Once you have found a directory of this type, you can use the following command to assist you in the creation of writing keys for udev rules:
214 <blockquote><pre># udevinfo -a -p /sys/path/to/hardware/info</pre></blockquote>
215
216 You may find that finding the correct place in <i>/sys</i> to run udevinfo on is not obvious. Chances are the device you just plugged in has already careted a device node (e.g. <i>/dev/sda</i>), in which case, udevinfo can be helpful! Taking the example of my <i>/dev/sda</i> node, running the following command will point you to the appropriate area of sysfs:
217 <blockquote><pre>
218 # udevinfo -q path -n /dev/sda
219
220 /block/sda
221 </pre></blockquote>
222
223 The output of the command (shown above) is telling me that the sysfs path to start at is <i>/sys/block/sda</i>. I would now run "udevinfo -a -p /sys/block/sda". These two commands can be stringed together, like so:
224
225 <blockquote><pre># udevinfo -a -p `udevinfo -q path -n /dev/sda`</pre></blockquote>
226
227 Moving on to rule-writing, some snipped output of the results of my "udevinfo -a -p /sys/block/sda" command is shown below, with colour added.<br />
228
229 <pre><font color="#003300">
230 follow the class device's "device"
231   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':
232     BUS="scsi"
233     ID="0:0:0:0"
234     SYSFS{detach_state}="0"
235     SYSFS{type}="0"
236     SYSFS{max_sectors}="240"
237     SYSFS{device_blocked}="0"
238     SYSFS{queue_depth}="1"
239     SYSFS{scsi_level}="3"
240     SYSFS{vendor}="        "
241     SYSFS{model}="USB 2.0M DSC    "
242     SYSFS{rev}="1.00"
243     SYSFS{online}="1"</font>
244 <font color="#0000FF">
245   looking at the device chain at '/sys/devices/pci0000:00/0000:00:02.1/usb3/3-3':
246     BUS="usb"
247     ID="3-3"
248     SYSFS{detach_state}="0"
249     SYSFS{bNumInterfaces}=" 1"
250     SYSFS{bConfigurationValue}="1"
251     SYSFS{bmAttributes}="c0"
252     SYSFS{bMaxPower}="  0mA"
253     SYSFS{idVendor}="052b"
254     SYSFS{idProduct}="1514"
255     SYSFS{bcdDevice}="0100"
256     SYSFS{bDeviceClass}="00"
257     SYSFS{bDeviceSubClass}="00"
258     SYSFS{bDeviceProtocol}="00"
259     SYSFS{bNumConfigurations}="1"
260     SYSFS{speed}="12"
261     SYSFS{manufacturer}="Tekom Technologies, Inc"
262     SYSFS{product}="USB 2.0M DSC"</font>
263 </pre>
264
265 The <i>udevinfo</i> tool provides a lot of information which you can simply copy-paste as udev rules. The reason that I have colour coded the above output is to point out that <b>you generally cannot mix and match information from different parts of the udevinfo output</b>. In the above output, I could not combine information from the different coloured sections - this is because each section of output refers to a different directory in SYSFS. For example, the following rule would not work:
266 <blockquote><pre><font color="#003300">BUS="scsi"</font>, <font color="#0000FF">SYSFS{manufacturer}="Tekom Technologies, Inc"</font>, NAME="%k"</pre></blockquote>
267 This rule would not work because I am combining information found in the section beginning with BUS="scsi" (green) with information only found in the blue section. The rule would work if I used BUS="usb", sticking only to information found in the blue section above.<br /><br />
268
269 You will notice that a lot of information is not relevant for writing basic rules (there is so much of it!), you should generally be looking for information that you recognise and know will not change (e.g. model name).<br /><br />
270
271 <b>Note that if you write your own rule to identify a device, the default devfs-style rules will not take effect!</b> It is usually sensible to use NAME="%k" and specify your own extra names in the SYMLINK parameter so that you do not lose the default sensible names.<br /><br />
272
273 I will show three examples of this <i>rule writing based on udevinfo output</i> process below. I will then attempt to list some device-dependant tips and tricks for locating the correct info.<br /><br />
274
275 <font size=2>A reader wrote to me and informed me that he found KDE's control centre useful for writing rules. Apparently, information about USB devices (and others) can be found in the "Info Centre" section of the KDE Control Centre. This interface shows information such as serial number, vendor ID, etc. If you prefer a GUI-like approach, you might want to investigate this.<br /><br />
276
277 The current releases of gnome-volume-manager are unable to treat symlink-nodes as real devices. Conversely as described above, you may wish to specify your own naming in the <i>NAME</i> parameter and specify %k in the <i>SYMLINK</i> parameter.<br /><br />
278
279 The behaviour of your own rules masking the defaults can be overcome if you write <a href="#multiple-symlinks">multiple-SYMLINK style rules</a>.
280
281 </font>
282
283 <a name="example-printer"></a>
284 <h2>Example: Writing a rule for my USB printer</h2>
285
286 After plugging in my printer, I started looking around some /sys directories for a relevant place to start. I didn't get anywhere, but I noticed that my printer had been given device node <i>/dev/lp0</i>. udevinfo was able to provide me with a useful path:
287 <blockquote><pre>
288 # udevinfo -q path -n /dev/lp0
289 /class/usb/lp0
290 </pre></blockquote>
291
292 Running "udevinfo -a -p /sys/class/usb/lp0" provided me with a heap of info, as usual. I picked out the relevant bits for unique device identification:
293 <blockquote><pre>
294 looking at the device chain at '/sys/devices/pci0000:00/0000:00:02.1/usb3/3-3':
295 BUS="usb"
296 SYSFS{manufacturer}="EPSON"
297 SYSFS{product}="USB Printer"
298 SYSFS{serial}="L72010011070626380"
299 </pre></blockquote>
300
301 My udev rule becomes:
302 <blockquote><pre>BUS="usb", SYSFS{serial}="L72010011070626380", NAME="%k", SYMLINK="epson_680"</pre></blockquote>
303
304 And my printer nodes exist at <i>/dev/lp0</i> (or <i>/dev/lp1</i> if another printer was plugged in beforehand) and <i>/dev/epson_680</i> <b>always</b> points at the device node for that particular printer.<br /><br />
305
306 <a name="example-camera"></a>
307 <h2>Example: Writing a rule for my USB-Storage digital camera</h2>
308
309 <font size="2">Quick Intro: My camera identifies itself as an external SCSI hard disk (it uses the usb-storage driver which is also used by devices such as USB hard disks and flash-card readers). I can then mount the partition on that disk and copy images over. Not all cameras work like this - many require external software (e.g. gphoto2) to be able to access photos.</font><br /><br />
310
311 This one is a bit tricky. Several nodes are created by default when my camera is connected : <i>/dev/sda</i> and <i>/dev/sda1</i>, and possibly even <i>/dev/sg1</i>. <b>This is an example where specifity is important - if your rule is not specific enough, it could match any of the above 3 nodes.</b><br /><br />
312
313 sda1 is the node that I would like as my <i>/dev/camera</i>, as that is what gets mounted. udevinfo did not point out any useful differences between sda, sda1, and sg1. I decided that a reliable way to differentiate between these 3 nodes would be to look at the <i>KERNEL</i> name.<br /><br />
314
315 A key such as <i>KERNEL="sd?1"</i> would match KERNEL names such as "sda1", "sdb1", "sdc1", and equally importantly, it will <b>not</b> match KERNEL names such as sda, sdb, or sg1. The purpose of this key is to ignore the <i>/dev/sda</i> and <i>/dev/sg1</i> nodes. The device is a digital camera - I would not dream of fdisking it or anything like that, so these 2 nodes are pretty useless to me. The key attempts to capture the <i>/dev/sda1</i> node, which is mountable and therefore useful!<br /><br />
316
317 As this node (sda1) is treated as a block device, looking in <i>/sys/block</i> would be a good place to start.<br /><br />
318
319 In my <i>/sys/block</i>, I have a directory named <i>sda</i>. In my <i>/sys/block/sda</i>, I have a directory named <i>sda1</i>. Both of these directories have <i>dev</i> files in, so they are OK to run <i>udevinfo</i> on. Running the following dumps a lot of information about my camera and the USB port it is connected through.
320
321 <blockquote><pre># udevinfo -a -p /sys/block/sda/sda1</pre></blockquote>
322
323 In the udevinfo output, I also noticed this bit of useful and understandable information:
324 <blockquote><pre>SYSFS{product}="USB 2.0M DSC"</pre></blockquote>
325
326 So that gives me my rule. For completeness, I also include a BUS key (this was also found in the udevinfo output).
327 <blockquote><pre>BUS="usb", SYSFS{product}="USB 2.0M DSC", KERNEL="sd?1", NAME="%k", SYMLINK="camera"</pre></blockquote>
328
329 Now, when my camera is plugged in, it will be named <i>/dev/sda1</i> (or, if sda1 isnt available, it might be called <i>/dev/sdb1</i>) and will <b>always</b> be correctly linked to from <i>/dev/camera</i>. The /dev/sda (or sdb) node still appears as normal, but the important thing is that my custom persistent "camera" symlink points to the mountable partition.<br /><br />
330
331 <a name="usbstorage-extra"></a>
332 <h2>Additional notes on writing rules for USB storage</h2>
333
334 <i>Carl Streeter</i>, the owner of a large USB hard disk, wrote to me and explained that unlike in my digital camera example, the <i>/dev/sda</i> node is useful to him. He pointed out that he does occasionally need to use tools such as <i>fdisk</i> and <i>hdparm</i> on that node.<br /><br />
335
336 Carl's rule is:
337 <blockquote><pre>BUS="usb", KERNEL="sd*", SYSFS{product}="USB 2.0 Storage Device", NAME="%k", SYMLINK="usbhd%n"</pre></blockquote>
338
339 This rule creates symlinks such as:
340 <ul>
341 <li><i>/dev/usbhd</i> - The fdiskable node</li>
342 <li><i>/dev/usbhd1</i> - The first partition (mountable)</li>
343 <li><i>/dev/usbhd2</i> - The second partition (mountable)</li>
344
345 </ul>
346
347 We agreed that depending on the situation and device in question, there are reasons for both wanting and not wanting the non-mountable <i>/dev/sda</i> node. Use whichever setup suits you best.<br /><br />
348
349 Another difficult situation is having a multiple-slot USB-storage card reader. These types of device generally do not inform the host when new cards are plugged in or out, so plugging a card into an unused slot while the reader is plugged in will not create the extra device node needed for mounting!<br />
350 This problem also applies to other USB disks - e.g. if you create a new partition, the new partition node will not appear until you re-plug the device.<br /><br />
351
352 udev provides a solution here - it is able to create nodes for all partitions of a block device. For every rule that you specify, the block device will have all 16 partition nodes created. To achieve this, you can simply modify the NAME key, as shown below:<br />
353
354 <blockquote><pre>BUS="usb", SYSFS{product}="USB 2.0 Storage Device", NAME{all_partitions}="usbhd"</pre></blockquote>
355
356 You will now have nodes named: usbhd, usbhd1, usbhd2, usbhd3, ..., usbhd15.<br /><br />
357
358 <a name="example-cdrom"></a>
359 <h2>Example: Writing convenience rules for my CD drives</h2>
360 I have two CD drives in my PC - a DVD reader, and a CD rewriter. My DVD is hdc and my CDRW is hdd. I would not expect this to change, unless I manually changed the cabling of my system.<br /><br />
361
362 Still, some people (myself included) like to have nodes such as <i>/dev/dvd</i> and <i>/dev/cdrw</i> for convenience. Since we know the "hdX" values for these drives, writing rules is simple. The examples below should be self explanatory.
363
364 <blockquote><pre>
365 BUS="ide", KERNEL="hdc", NAME="%k", SYMLINK="dvd cdroms/cdrom%n"
366 BUS="ide", KERNEL="hdd", NAME="%k", SYMLINK="cdrw cdroms/cdrom%n"
367 </pre></blockquote>
368
369 <font size="2">You may have noticed that the default 50-udev.rules file contains a rule which runs a script to produces names for block devices. Do not be confused by this - as usual, because your own rules are located in a file which is processed <b>before</b> the default rules, the defaults will not be used when naming the hardware you have written rules for.</font><br /><br />
370
371 <a name="example-iface"></a>
372 <h2>Example: Writing a rule to name my network interface</h2>
373 An interesting new feature in recent udev versions is the ability to write rules to name your network interfaces. Network interfaces do not show up in <i>/dev</i>, but they are generally referenced by names (e.g. with <i>ifconfig</i>). Despite the differences, the rule writing process is almost identical.<br /><br />
374
375 As usual, udevinfo comes to our aid in rule-writing. In my example, I wish to rename my "eth0" network device (the following output is snipped):
376
377 <blockquote><pre>
378 # udevinfo -a -p /sys/class/net/eth0/
379   looking at class device '/sys/class/net/eth0':
380     SYSFS{address}="00:52:8b:d5:04:48"
381 </pre></blockquote>
382
383 Every network adapter has its own unique MAC-address, so I chose to use this when writing my rule. This will not change, unless you change your network card. An example rule is shown below:
384
385 <blockquote><pre>KERNEL="eth*", SYSFS{address}="00:52:8b:d5:04:48", NAME="lan"</pre></blockquote>
386
387 You will need to reload the net driver for this rule to take effect. You can either unload and reload the module, or simply reboot the system. You will also need to reconfigure your system to use "lan" rather than "eth0". I had some troubles getting this going (the interface wasn't being renamed) until I had completely dropped all references to eth0.<br />
388 After that, you should be able to use "lan" instead of "eth0" in any calls to <i>ifconfig</i> or similar utilities.<br /><br />
389
390 <a name="tips"></a>
391 <h2>Tips for finding the appropriate places in SYSFS</h2>
392 <font size=2>I'm looking for some more device specific tips here. Please <a href="#author">contact me</a> with any you can provide.</font>
393
394 <ul>
395 <li>If the device you are looking to write rules for has created a device node under /dev, then you are in luck! Run the following command to get an appropriate /sys path: <i>udevinfo -q path -n /dev/yournode</i></li>
396 <li>Always use udevinfo to assist the rule-writing process. Always use udevinfo to look under /sys/block or /sys/class (it will not start reading a chain from anywhere else).</li>
397 <li>If you get totally stuck, use the following command to find all "dev" files under /sys (udevinfo can work on directories containing this file): find /sys -iname dev</li>
398 <li>If your device is a flash-card reader, usb flash-drive, or digital camera that acts as usb-storage, that is created as /dev/sdX, then start looking in /sys/block/sdX.</li>
399 <li>If applicable, make sure you identify the difference between sdX and sdX1 in the above situation. This can be done with the key <i>KERNEL="sd?1"</i> to match sdX1, or <i>KERNEL="sd?"</i> to match sdX.</li>
400 <li>For USB printers that are created as /dev/lpX, then you should start looking in /sys/class/usb/lpX.</li>
401
402 <li>The usb scanner driver has recently been removed from the kernel and re-implemented in userspace (as part of the SANE package). You do not (and can not) write rules for this hardware as it does not rely on specific kernel drivers.</li>
403 <li>Remember that unfortunately, the kernel does not export information for all devices into sysfs, meaning that you simply can't write rules for some devices yet. On 20/02/04, the udev author stated that there are 162 drivers left to convert to sysfs.</li>
404 </ul>
405
406 <a name="multiple-symlinks"></a>
407 <h2>Using multiple SYMLINK style rules</h2>
408 Another recent feature is the ability to write rules that do not specify a <i>NAME</i>, but instead they simply specify <i>SYMLINK</i> keys. This allows you to avoid the issue where your own rules effectively mask the udev defaults.<br /><br />
409
410 Take the rule:<br />
411 <blockquote><pre>KERNEL="hdc", SYMLINK="dvd"</pre></blockquote>
412
413 When udev finds this rule, it will take a mental note of it. Upon finding another rule matching the same device which also includes a <i>NAME</i> parameter, udev will create the node as specified by the <i>NAME</i> parameter, plus symbolic links as specified by the <i>SYMLINK</i> parameters of both rules.<br />
414 To put it into practical terms, when udev is naming nodes for my <i>hdc</i> device, it will use the default rules for block devices as usual, with the addition of my personal symlink "dvd".<br /><br />
415
416 Similarly to normal rules, rules of this type will only take effect if udev is able to find them <i>before</i> it finds a rule specifying a <i>NAME</i> parameter.<br /><br />
417
418 <a name="nvidia"></a>
419 <h2>udev vs Nvidia's graphics drivers</h2>
420
421 <font size="2">This section isn't really relevant to the purpose of this document, but judging from the hits I get from google, this is a hot topic. I will leave it here for now.</font><br /><br />
422
423 Nvidia's graphics drivers (the closed-source ones, not the ones that come with XFree) do not work with a default installation of udev - you are unable to start X. This is because the <i>nvidia</i> module is loaded by X, but the <i>/dev/nvidia*</i> nodes are not created quick enough, so X bails out.<br /><br />
424
425 The solution to this problem is to autoload the <i>nvidia</i> module on bootup. Yes - you are *supposed* to do this - the <a href="ftp://download.nvidia.com/XFree86/Linux-x86/1.0-5336/README">NVidia FAQ</a> confirms this! On devfs-based systems, devfs did this automatically at bootup anyway. Your linux distribution will have created a file which you can list modules to be loaded on bootup (e.g. <i>/etc/modules.autoload.d/kernel-2.6</i> for Gentoo, <i>/etc/modules</i> for Debian).<br /><br />
426
427 This isn't all - you will also need to patch the nvidia kernel interface to export some basic info to SYSFS so that udev will create the devices. Martin Schlemmer has written a patch against the 1.0.5336 version of the nvidia drivers, which can be found <a href="http://www.gentoo.org/cgi-bin/viewcvs.cgi/*checkout*/media-video/nvidia-kernel/files/1.0.5336/NVIDIA_kernel-1.0-5336-basic-sysfs-support-v2.patch?rev=HEAD&content-type=text/plain">here</a>. The Gentoo package <i>nvidia-kernel-1.0.5336-r4</i> contains this patch.<br /><br />
428
429 Another solution is to simply create the nvidia specific nodes on bootup. X will then load the module when required, and as the nodes are already in existance, you will not run into the problem described above. Place these commands in a file that is automatically executed on bootup (e.g. <i>/etc/conf.d/local.start</i> for Gentoo):
430 <blockquote><pre>
431 mknod /dev/nvidia0 c 195 0
432 mknod /dev/nvidiactl c 195 255
433 </pre></blockquote>
434
435 You should now be able to get into X with no problems.<br /><br />
436
437 <a name="author"></a>
438 <h2>Author and Credits</h2>
439 This document is written by Daniel Drake &lt;<a href="mailto:dan@reactivated.net">dan@reactivated.net</a>&gt;<br />
440 Please do not hesitate to send feedback!<br /><br />
441
442 Additional thanks to:
443 <ul>
444 <li>The udev developers!</li>
445 <li>agrippa_cash (usb-storage info)</li>
446 <li>Carl Streeter (usb-storage info)</li>
447 <li>David Watson</li>
448 <li>Decibels</li>
449 <li>Frank Pieczynski</li>
450 <li>Feth Arezki</li>
451 <li>Jim (KDE info)</li>
452 <li>Johannes Jordens</li>
453 <li>Kay Sievers</li>
454 <li>Patrick Dreker</li>
455 <li>Todd Musall</li>
456 <li>Tuna</li>
457 <li>Ueli Schl├Ąpfer</li>
458 <li>...and anyone else who provided information or feedback</li>
459 </ul>
460
461 <br /><br />Copyright (C) 2003-2004 Daniel Drake<br />
462 This document is licensed under the <a href="http://www.gnu.org/licenses/gpl.html">GNU General Public License, Version 2</a>.
463
464 </body>
465 </html>