<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<style type="text/css">
<!--
	.green { color: #003300; }
	.blue  { color: #0000CC; }
//-->
</style>
<title>Writing udev rules</title>
</head>

<body>

<h1>Writing udev rules</h1>
by Daniel Drake (dsd)<br />
Version 0.7<br /><br />

The most recent version of this document can always be found at: <br />

<a href="http://www.reactivated.net/writing_udev_rules.html">http://www.reactivated.net/writing_udev_rules.html</a>

<h2>Contents</h2>
<ul>
<li>Introduction
	<ul>
	<li><a href="#about">About this document</a></li>
	<li><a href="#history">History</a></li>
	</ul>
</li>
<li>The concepts
	<ul>
	<li><a href="#terminology">Terminology: devfs, sysfs, nodes, etc.</a></li>
	<li><a href="#why">Why?</a></li>
	<li><a href="#builtin">Built-in persistent naming schemes</a></li>
	</ul>
</li>
<li>Rule writing
	<ul>
	<li><a href="#syntax">Rule files and semantics</a></li>
	<li><a href="#syntax">Rule syntax</a></li>
	<li><a href="#basic">Basic rules</a></li>
	<li><a href="#sysfsmatch">Matching sysfs attributes</a></li>
	<li><a href="#strsubst">String substitutions</a></li>
	<li><a href="#strmatch">String matching</a></li>
	</ul>
</li>
<li>Finding suitable information from sysfs
	<ul>
	<li><a href="#sysfstree">The sysfs tree</a></li>
	<li><a href="#udevinfo">udevinfo</a></li>
	<li><a href="#sysfsalt">Alternative methods</a></li>
	</ul>
</li>
<li>Advanced topics
	<ul>
	<li><a href="#ownership">Controlling permissions and ownership</a></li>
	<li><a href="#external-naming">Using external programs to name devices</a></li>
	<li><a href="#external-run">Running external programs on certain events</a></li>
	<li><a href="#env">Environment interaction</a></li>
	<li><a href="options">Additional options</a></li>
	</ul>
</li>
<li>Examples
	<ul>
	<li><a href="#example-printer">USB Printer</a></li>
	<li><a href="#example-camera">USB Camera</a></li>
	<li><a href="#example-usbhdd">USB Hard Disk</a></li>
	<li><a href="#example-usbcardreader">USB Hard Disk</a></li>
	<li><a href="#example-pilot">USB Palm Pilot</a></li>
	<li><a href="#example-cdrom">CD/DVD drives</a></li>
	<li><a href="#example-netif">Network interfaces</a></li>
	</ul>
</li>
<li>Testing and debugging
	<ul>
	<li><a href="#testing">Putting your rules into action</a></li>
	<li><a href="#udevtest">udevtest</a></li>
	</ul>
</li>
<li><a href="#author">Author and contact</a></li>
</ul>

<h2>Introduction</h2>

<a name="about"></a>
<h3>About this document</h3>

<p>
udev is targeted 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.
</p>

<p>
Over the years, the things that you might use udev rules for has changed, as well as the flexibility of rules themselves. On a modern system, udev provides persistent naming for some device types out-of-the-box, eliminating the need for custom rules for those devices. However, some users will still require the extra level of customisation.
</p>

<p>
This document assumes that you have udev installed and running OK with default configurations. This is usually handled by your Linux distribution.
</p>

<p>
This document does not cover every single detail of rule writing, but does aim to introduce all of the main concepts. The finer details can be found in the udev man page.
</p>

<p>
This document uses various examples (many of which are entirely fictional) to illustrate ideas and concepts. Not all syntax is explicitly described in the accompanying text, be sure to look at the example rules to get a complete understanding.
</p>

<a name="history"></a>
<h3>History</h3>

<ul>
<li>June 10th 2006 v0.71: Misc changes based on recent feedback - thanks!</li>
<li>June 3rd 2006 v0.7: Complete rework, to be more suited for the modern-day udev.</li>
<li>May 9th 2005 v0.6: Misc updates, including information about udevinfo, groups and permissions, logging, and udevtest.</li>
<li>June 20th 2004 v0.55: Added info on multiple symlinks, and some minor changes/updates.</li>
<li>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.</li>
<li>April 15th 2004 v0.53: Minor corrections. Added info about NAME{all_partitions}. Added info about other udevinfo tricks.</li>
<li>April 14th 2004 v0.52: Reverted to suggesting using "udev.rules" until the udev defaults allow for other files. Minor work.</li>
<li>April 6th 2004 v0.51: I now write suggest users to use their own "local.rules" file rather than prepending "udev.rules".</li>
<li>April 3rd 2004 v0.5: Minor cleanups and preparations for possible inclusion in the udev distribution.</li>
<li>March 20th 2004 v0.4: General improvements, clarifications, and cleanups. Added more information about writing rules for usb-storage.</li>
<li>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.</li>
<li>February 18th 2004 v0.2: Fixed a small omission in an example. Updated section on identifying mass-storage devices. Updated section on nvidia.</li>
<li>February 15th 2004 v0.1: Initial publication.</li>
</ul>

<h2>The concepts</h2>

<a name="terminology"></a>
<h3>Terminology: devfs, sysfs, nodes, etc.</h3>

<p>
A basic introduction only, might not be totally accurate.
</p>

<p>
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, the X server will "listen to" /dev/input/mice so that it can relate the user's mouse movements to moving the visual mouse pointer.
</p>

<p>
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 manageable approach (noticeably, 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.
</p>

<p>
<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.
</p>

<p>
<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 browseable. 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.
</p>

<a name="why"></a>
<h3>Why?</h3>

<p>
udev rules are flexible and very powerful. Here are some of the things you can use rules to achieve:
</p>

<ul>
<li>Rename a device node from the default name to something else</li>
<li>Provide an alternative/persistent name for a device node by creating a symbolic link to the default device node</li>
<li>Name a device node based on the output of a program</li>
<li>Change permissions and ownership of a device node</li>
<li>Launch a script when a device node is created or deleted (typically when a device is attached or unplugged)</li>
<li>Rename network interfaces</li>
</ul>

<p>
Writing rules is <u>not</u> a workaround for the problem where no device nodes for your particular device exist. Even if there are no matching rules, udev will create the device node with the default name supplied by the kernel.
</p>

<p>
Having persistently named device nodes has several advantages. Assume you own two USB storage devices: a digital camera and a USB flash disk. These devices are typically assigned device nodes <em>/dev/sda</em> and <em>/dev/sdb</em> but the exact assignment depends on the order which they were originally connected. This may cause problems to some users, who would benefit greatly if each device could be named persistently every time, e.g. <em>/dev/camera</em> and <em>/dev/flashdisk</em>.
</p>

<a name="builtin"></a>
<h3>Built-in persistent naming schemes</h3>

<p>
udev provides persistent naming for some device types out of the box. This is a very useful feature, and in many circumstances means that your journey ends here: you do not have to write any rules.
</p>

<p>
udev provides out-of-the-box persistent naming for storage devices in the <em>/dev/disk</em> directory. To view the persistent names which have been created for your storage hardware, you can use the following command:
</p>

<blockquote><pre># ls -lR /dev/disk</pre></blockquote>

<p>
This works for all storage types. As an example, udev has created <em>/dev/disk/by-id/scsi-SATA_ST3120827AS_4MS1NDXZ-part3</em> which is a persistent-named symbolic link to my root partition. udev creates <em>/dev/disk/by-id/usb-Prolific_Technology_Inc._USB_Mass_Storage_Device-part1</em> when I plug my USB flash disk in, which is also a persistent name.
</p>

<!-- FIXME: document CDROM persistent naming when things settle down -->

<h2>Rule writing</h2>

<a name="files"></a>
<h3>Rule files and semantics</h3>

<p>
When deciding how to name a device and which additional actions to perform, udev reads a series of rules files. These files are kept in the <em>/etc/udev/rules.d</em> directory, and they all must have the <em>.rules</em> suffix.
</p>

<p>
Default udev rules are stored in <em>/etc/udev/rules.d/50-udev.rules</em>. 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.
</p>

<p>
Files in /etc/udev/rules.d/ are parsed in <b>lexical</b> order, and in some circumstances, the order in which rules are parsed is important. In general, you want your own rules to be parsed before the defaults, so I suggest you create a file at <em>/etc/udev/rules.d/10-local.rules</em> and write all your rules into this file.
</p>

<p>
In a rules file, lines starting with "#" are treated as comments. Every other non-blank line is a rule. Rules cannot span multiple lines.
</p>

<p>
One device can be matched by more than one rule. This has it's practical advantages, for example, we can write two rules which match the same device, where each one provides its own alternate name for the device. Both alternate names will be created, even if the rules are in separate files. It is important to understand that udev will <em>not</em> stop processing when it finds a matching rule, it will continue searching and attempt to apply every rule that it knows about.
</p>

<a name="syntax"></a>
<h3>Rule syntax</h3>

<p>
Each rule is constructed from a series of key-value pairs, which are separated by commas. <b>match</b> keys are conditions used to identify the device which the rule is acting upon. When <u>all</u> match keys in a rule correspond to the device being handled, then the rule is applied and the actions of the <b>assignment</b> keys are invoked. Every rule should consist of at least one match key and at least one assignment key.
</p>

<p>
Here is an example rule to illustrate the above:
</p>

<blockquote><pre>KERNEL=="hdb", NAME="my_spare_disk"</pre></blockquote>

<p>
The above rule includes one match key (<em>KERNEL</em>) and one assignment key (<em>NAME</em>). The semantics of these keys and their properties will be detailed later. It is important to note that the match key is related to its value through the equality operator (==), whereas the assignment key is related to its value through the assignment operator (=).
</p>

<!-- fixme udevstart? -->

<a name="basic"></a>
<h3>Basic Rules</h3>

<p>
udev provides several different match keys which can be used to write rules which match devices very precisely. Some of the most common keys are introduced below, others will be introduced later in this document. For a complete list, see the udev man page.
</p>

<ul>
<li><b>KERNEL</b> - match against the kernel name for the device</li>
<li><b>SUBSYSTEM</b> - match against the subsystem of the device</li>
<li><b>DRIVER</b> - match against the driver name for the device</li>
</ul>

<p>
After you have used a series of match keys to precisely match a device, udev gives you fine control over what happens next, through a range of assignment keys. For a complete list of possible assignment keys, see the udev man page. The most basic assignment keys are introduced below. Others will be introduced later in this document.
</p>

<ul>
<li><b>NAME</b> - the name that shall be used for the device node</li>
<li><b>SYMLINK</b> - a <b>list</b> of symbolic links which act as alternative names for the device node</li>
</ul>

<p>
As hinted above, udev only creates one true device node for one device. If you wish to provide alternate names for this device node, you use the symbolic link functionality. With the <em>SYMLINK</em> assignment, you are actually maintaining a <em>list</em> of symbolic links, all of which will be pointed at the real device node. To manipulate these links, we introduce a new operator for appending to lists: <b>+=</b>. You can append multiple symlinks to the list from any one rule by separating each one with a space.
</p>

<blockquote><pre>KERNEL=="hdb", NAME="my_spare_disk"</pre></blockquote>

<p>
The above rule says: <em>match a device which was named by the kernel as hdb, and instead of calling it hdb, name the device node as my_spare_disk</em>. The device node appears at <em>/dev/my_spare_disk</em>.
</p>

<blockquote><pre>KERNEL=="hdb", DRIVER=="ide-disk", SYMLINK+="sparedisk"</pre></blockquote>

<p>
The above rule says: <em>match a device which was named by the kernel as hdb AND where the driver is ide-disk. Name the device node with the default name and create a symbolic link to it named sparedisk</em>. Note that we did not specify a device node name, so udev uses the default. In order to preserve the standard <em>/dev</em> layout, your own rules will typically leave the NAME alone but create some SYMLINKs and/or perform other assignments.
</p>

<blockquote><pre>KERNEL=="hdc", SYMLINK+="cdrom cdrom0"</pre></blockquote>

<p>
The above rule is probably more typical of the types of rules you might be writing. It creates two symbolic links at <em>/dev/cdrom</em> and <em>/dev/cdrom0</em>, both of which point at <em>/dev/hdc</em>. Again, no NAME assignment was specified, so the default kernel name (hdc) is used.
</p>

<a name="sysfsmatch"></a>
<h3>Matching sysfs attributes</h3>

<p>
The match keys introduced so far only provide limited matching capabilities. Realistically we require much finer control: we want to identify devices based on advanced properties such as vendor codes, exact product numbers, serial numbers, storage capacities, number of partitions, etc.
</p>

<p>
Many drivers export information like this into sysfs, and udev allows us to incorporate sysfs-matching into our rules, using the <em>SYSFS</em> key with a slightly different syntax.
</p>

<p>
Here are some examples of rules which match data from sysfs. Further detail will be provided later in this document which will aid you in writing rules based on sysfs attributes.
</p>

<blockquote><pre>
KERNEL=="sda", SYSFS{model}=="ST3120827AS", SYMLINK+="my_hard_disk"
SUBSYSTEM=="block", SYSFS{size}=="234441648", SYMLINK+="my_disk"
BUS=="usb", SYSFS{manufacturer}=="OLYMPUS", SYSFS{product}=="X250,D560Z,C350Z", SYMLINK+="camera"
</pre></blockquote>

<a name="strsubst"></a>
<h3>String substitutions</h3>

<p>
When writing rules which will potentially handle multiple similar devices, udev's <em>printf-like string substitution operators</em> are very useful. You can simply include these operators in any assignments your rule makes, and udev will evaluate them when they are executed.
</p>

<p>
The most common operators are <b>%k</b> and <b>%n</b>. %k evaluates to the kernel name for the device, e.g. "sda3" for a device that would (by default) appear at <em>/dev/sda3</em>. <b>%n</b> evaluates to the kernel number for the device (the partition number for storage devices), e.g. "3" for <em>/dev/sda3</em>.
</p>

<p>
udev also provides several other substitution operators for more advanced functionality. Consult the udev man page after reading the rest of this document. There is also an alternative syntax for these operators - <b>$kernel</b> and <b>$number</b> for the examples above. For this reason, if you wish to match a literal % in a rule then you must write <b>%%</b>, and if you wish to match a literal $ then you must write <b>$$</b>.
</p>

<p>
To illustrate the concept of string substitution, some example rules are shown below.
</p>

<blockquote><pre>
KERNEL=="mice", NAME="input/%k"
KERNEL=="loop0", NAME="loop/%n", SYMLINK+="%k"
</pre></blockquote>

<p>
The first rule ensures that the mice device node appears exclusively in the <em>/dev/input</em> directory (by default it would be at <em>/dev/mice</em>). The second rule ensures that the device node named loop0 is created at <em>/dev/loop/0</em> but also creates a symbolic link at <em>/dev/loop0</em> as usual.
</p>

<p>
The use of the above rules is questionable, as they all could be rewritten without using any substitution operators. The true power of these substitutions will become apparent in the next section.
</p>

<a name="strmatch"></a>
<h3>String matching</h3>

<p>
As well as matching strings exactly, udev allows you to use shell-style pattern matching. There are 3 patterns supported:
</p>

<ul>
<li><b>*</b> - match any character, zero or more times</li>
<li><b>?</b> - match any character exactly once</li>
<li><b>[]</b> - match any single character specified in the brackets, ranges are also permitted</li>
</ul>

<p>
Here are some examples which incorporate the above patterns. Note the use of the string substitution operators.
</p>

<blockquote><pre>
KERNEL=="fd[0-9]*", NAME="floppy/%n", SYMLINK+="%k"
KERNEL=="hiddev*", NAME="usb/%k"
</pre></blockquote>

<p>
The first rule matches all floppy disk drives, and ensures that the device nodes are placed in the <em>/dev/floppy</em> directory, as well as creating a symbolic link from the default name. The second rule ensures that hiddev devices are only present in the <em>/dev/usb</em> directory.
</p>

<h2>Finding information from sysfs</h2>

<a name="sysfstree"></a>
<h3>The sysfs tree</h3>

<p>
The concept of using interesting information from sysfs was briefly touched upon above. In order to write rules based on this information, you first need to know the names of the attributes and their current values.
</p>

<p>
sysfs is actually a very simple structure. It is logically divided into directories. Each directory contains a number of files (<em>attributes</em>) which typically contain just one value. Some symbolic links are present, which link various parts of the tree together.
</p>

<p>
Some directories are referred to as <em>top-level device paths</em>. These directories act as the top-level glue which chain other parts of sysfs to the device in question. Top-level device paths can be classified as sysfs directories which contain a <em>dev</em> file, the following command will list these for you:
</p>

<blockquote><pre># find /sys -name dev</pre></blockquote>

<p>
For example, on my system, the <em>/sys/block/sda</em> directory is the device path for my hard disk. It is chained to the controller through the <em>/sys/block/sda/device/</em> symbolic link, which is in turn chained to the device driver through the <em>/sys/block/sda/device/driver/</em> symbolic link.
</p>

<p>
When you write rules based on sysfs information, you are simply matching attribute contents of some files in one part of the chain. For example, I can read the size of my hard disk as follows:
</p>

<blockquote><pre>
# cat /sys/block/sda/size
234441648
</pre></blockquote>

<p>
In a udev rule, I could use SYSFS{size}=="234441648" to identify this disk. As udev iterates through the entire device chain, I could alternatively opt to match attributes in another part of the chain (e.g. attributes in <em>/sys/class/block/sda/device/</em>), however there are some caveats when dealing with different parts of the chain which are described later.
</p>

<p>
Although this serves as a useful introduction as to the structure of sysfs and exactly how udev matches values, manually trawling through sysfs is both time consuming and unnecessary.
</p>

<a name="udevinfo"></a>
<h3>udevinfo</h3>

<p>
Enter <em>udevinfo</em>, which is probably the most straightforward tool you can use to construct rules. All you need to know is the sysfs device path of the device in question. A trimmed example is shown below:
</p>

<blockquote><pre>
# udevinfo -a -p /sys/block/sda

<span class="green">  looking at device '/block/sda':
    KERNEL=="sda"
    SUBSYSTEM=="block"
    SYSFS{stat}=="  128535     2246  2788977   766188    73998   317300  3132216  5735004        0   516516  6503316"
    SYSFS{size}=="234441648"
    SYSFS{removable}=="0"
    SYSFS{range}=="16"
    SYSFS{dev}=="8:0"</span>

<span class="blue">  looking at device '/devices/pci0000:00/0000:00:07.0/host0/target0:0:0/0:0:0:0':
    ID=="0:0:0:0"
    BUS=="scsi"
    DRIVER=="sd"
    SYSFS{ioerr_cnt}=="0x0"
    SYSFS{iodone_cnt}=="0x31737"
    SYSFS{iorequest_cnt}=="0x31737"
    SYSFS{iocounterbits}=="32"
    SYSFS{timeout}=="30"
    SYSFS{state}=="running"
    SYSFS{rev}=="3.42"
    SYSFS{model}=="ST3120827AS     "
    SYSFS{vendor}=="ATA     "
    SYSFS{scsi_level}=="6"
    SYSFS{type}=="0"
    SYSFS{queue_type}=="none"
    SYSFS{queue_depth}=="1"
    SYSFS{device_blocked}=="0"</span>
</pre></blockquote>

<p>
As you can see, udevinfo simply produces a list of attributes you can use as-is as match keys in your udev rules. From the above example, I could produce (e.g.) either of the following two rules for this device:
</p>

<blockquote><pre>
SUBSYSTEM=="block", <span class="green">SYSFS{size}=="234441648",</span> NAME="my_hard_disk"
BUS=="scsi", <span class="blue">SYSFS{model}=="ST3120827AS",</span> NAME="my_hard_disk"</pre></blockquote>

<p>
You may have noted the use of colour in the above examples. This is to demonstrate that you generally can <em>not</em> mix-and-match attributes from different sections of the udevinfo output - your rule will not work. For example, the following rule is <em>invalid</em>:
</p>

<blockquote><pre>
SUBSYSTEM=="block", <span class="green">SYSFS{size}=="234441648",</span> <span class="blue">SYSFS{model}=="ST3120827AS",</span> NAME="my_hard_disk"</pre></blockquote>

<p>
You are usually provided with a large number of attributes, and you must pick a number of them (from the same section) to construct your rule. In general, you want to choose attributes which identify your device in a persistent and human-recognisable way. In the examples above, I chose the size of my disk and its model number. I did not use meaningless numbers such as SYSFS{iodone_cnt}=="0x31737".
</p>

<p>
Another point to note is that it is common for text attributes to appear in the udevinfo output to be padded with spaces (e.g. see ST3120827AS above). In your rules, you can either specify the extra spaces, or you can cut them off as I have done.
</p>

<p>
The only complication with using udevinfo is that you are required to know the top-level device path (/sys/block/sda in the example above). This is not always obvious. However, as you are generally writing rules for device nodes which already exist, you can use udevinfo to look up the device path for you:
</p>

<blockquote><pre># udevinfo -a -p $(udevinfo -q path -n /dev/sda)</pre></blockquote>

<a name="sysfsalt"></a>
<h3>Alternative methods</h3>

<p>
Although udevinfo is almost certainly the most straightforward way of listing the exact attributes you can build rules from, some users are happier with other tools. Utilities such as <a href="http://www.kroah.com/linux/usb/">usbview</a> display a similar set of information, most of which can be used in rules.
</p>

<h2>Advanced topics</h2>

<a name="ownership"></a>
<h3>Controlling permissions and ownership</h3>

<p>
udev allows you to use additional assignments in rules to control ownership and permission attributes on each device.
</p>

<p>
The <em>GROUP</em> assignment allows you to define which Unix group should own the device node. Here is an example rule which defines that the <em>video</em> group will own the framebuffer devices:
</p>

<blockquote><pre>KERNEL=="fb[0-9]*", NAME="fb/%n", SYMLINK+="%k", GROUP="video"</pre></blockquote>

<p>
The <em>OWNER</em> key, perhaps less useful, allows you to define which Unix user should have ownership permissions on the device node. Assuming the slightly odd situation where you would want <em>john</em> to own your floppy devices, you could use:
</p>

<blockquote><pre>KERNEL=="fd[0-9]*", OWNER="john"</pre></blockquote>

<p>
udev defaults to creating nodes with Unix permissions of 0660 (read/write to owner and group). If you need to, you can override these defaults on certain devices using rules including the <em>MODE</em> assignment. As an example, the following rule defines that the inotify node shall be readable and writable to everyone:
</p>

<blockquote><pre>KERNEL=="inotify", NAME="misc/%k", SYMLINK+="%k", MODE="0666"</pre></blockquote>

<a name="external-naming"></a>
<h3>Using external programs to name devices</h3>

<p>
Under some circumstances, you may require more flexibility than standard udev rules can provide. In this case, you can ask udev to run a program and use the standard output from that program to provide device naming.
</p>

<p>
To use this functionality, you simply specify the absolute path of the program to run (and any parameters) in the <em>PROGRAM</em> assignment, and you then use some variant of the <em>%c</em> substitution in the NAME/SYMLINK assignments.
</p>

<p>
The following examples refer to a fictional program found at <em>/bin/device_namer</em>. device_namer takes one command line argument which is the kernel name for the device. Based upon this kernel name, device_namer does its magic and produces some output to the usual <em>stdout</em> pipe, split into several parts. Each part is just a single word, and parts are separated by a single space.
</p>

<p>
In our first example, we assume that device_namer outputs a number of parts, each one to form a symbolic link (alternative name) for the device in question.
</p>

<blockquote><pre>KERNEL=="hda", PROGRAM="/bin/device_namer %k", SYMLINK+="%c"</pre></blockquote>

<p>
The next example assumes that device_namer outputs two parts, the first being the device name, and the second being the name for an additional symbolic link. We now introduce the <em>%c{N}</em> substitution, which refers to part N of the output:
</p>

<blockquote><pre>KERNEL=="hda", PROGRAM="/bin/device_namer %k", NAME="%c{1}", SYMLINK+="%c{2}"</pre></blockquote>

<p>
The next example assumes that device_namer outputs one part for the device name, followed by any number of parts which will form additional symbolic links. We now introduce the <em>%c{N+}</em> substitution, which evaluates to part N, N+1, N+2, ... until the end of the output.
</p>

<blockquote><pre>KERNEL=="hda", PROGRAM="/bin/device_namer %k", NAME="%c{1}", SYMLINK+="%c{2+}"</pre></blockquote>

<p>
Output parts can be used in any assignment key, not only NAME and SYMLINK. The example below uses a fictional program to determine the Unix group which should own the device:
</p>

<blockquote><pre>KERNEL=="hda", PROGRAM="/bin/who_owns_device %k", GROUP="%c"</pre></blockquote>

<a name="external-run"></a>
<h3>Running external programs upon certain events</h3>

<p>
Yet another reason for writing udev rules is to run a particular program when a device is connected or disconnected. For example, you might want to execute a script to automatically download all of your photos from your digital camera when it is connected.
</p>

<p>
Do not confuse this with the <em>PROGRAM</em> functionality described above. <em>PROGRAM</em> is used for running programs which produce device names (and they shouldn't do anything other than that). When those programs are being executed, the device node has not yet been created, so acting upon the device in any way is not possible.
</p>

<p>
The functionality introduced here allows you to run a program after the device node is put in place. This program can act on the device, however it must not run for any extended period of time, because udev is effectively paused while these programs are running. One workaround for this limitation is to make sure your program immediately detaches itself.
</p>

<p>
Here is an example rule which demonstrates the use of the <em>RUN</em> list assignment:
</p>

<blockquote><pre>KERNEL=="sdb", RUN+="/usr/bin/my_program"</pre></blockquote>

<p>
When <em>/usr/bin/my_program</em> is executed, various parts of the udev environment are available as environment variables, including key values such as <em>SUBSYSTEM</em>. You can also use the <em>ACTION</em> environment variable to detect whether the device is being connected or disconnected - ACTION will be either "add" or "remove" respectively.
</p>

<a name="env"></a>
<h3>Environment interaction</h3>

<p>
udev provides an <em>ENV</em> key for environment variables which can be used for both matching and assignment.
</p>

<p>
In the assignment case, you can set environment variables which you can then match against later. You can also set environment variables which can be used by any external programs invoked using the techniques mentioned above. A fictional example rule which sets an environment variable is shown below.
</p>

<blockquote><pre>KERNEL=="fd0", SYMLINK+="floppy", ENV{some_var}="value"</pre></blockquote>

<p>
In the matching case, you can ensure that rules only run depending on the value of an environment variable. Note that the environment that udev sees will not be the same user environment as you get on the console. A fictional rule involving an environment match is shown below.
</p>

<blockquote><pre>KERNEL=="fd0", ENV{an_env_var}=="yes", SYMLINK+="floppy"</pre></blockquote>

<p>
The above rule only creates the <em>/dev/floppy</em> link if $an_env_var is set to "yes" in udev's environment.
</p>

<a name="options"></a>
<h3>Additional options</h3>

<p>
Another assignment which can prove useful is the <em>OPTIONS</em> list. A few options are available:
</p>

<ul>
<li><b>all_partitions</b> - create all possible partitions for a block device, rather than only those that were initially detected</li>
<li><b>ignore_device</b> - ignore the event completely</li>
<li><b>last_rule</b> - ensure that no later rules have any effect</li>
</ul>

<p>
For example, the rule below sets the group ownership on my hard disk node, and ensures that no later rule can have any effect:
</p>

<blockquote><pre>KERNEL=="sda", GROUP="disk", OPTIONS+="last_rule"</pre></blockquote>


<h2>Examples</h2>

<a name="example-printer"></a>
<h3>USB Printer</h3>

<p>
I power on my printer, and it is assigned device node <em>/dev/lp0</em>. Not satisfied with such a bland name, I decide to use udevinfo to aid me in writing a rule which will provide an alternative name:
</p>

<blockquote><pre>
# udevinfo -a -p $(udevinfo -q path -n /dev/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"
</pre></blockquote>

<p>
My rule becomes:
</p>

<blockquote><pre>BUS=="usb", SYSFS{serial}=="L72010011070626380", SYMLINK+="epson_680"</pre></blockquote>

<a name="example-camera"></a>
<h3>USB Camera</h3>

<p>
Like most, my camera identifies itself as an external hard disk connected over the USB bus, using the SCSI transport. To access my photos, I mount the drive and copy the image files onto my hard disk.
</p>

<p>
Not all cameras work in this way: some of them use a non-storage protocol such as cameras supported by <a href="http://www.gphoto.org/">gphoto2</a>. In the gphoto case, you do not want to be writing rules for your device, as is it controlled purely through userspace (rather than a specific kernel driver).
</p>

<p>
A common complication with USB camera devices is that they usually identify themselves as a disk with a single partition, in this case <em>/dev/sdb</em> with <em>/dev/sdb1</em>. The sdb node is useless to me, but sdb1 is interesting - this is the one I want to mount. There is a problem here that because sysfs is chained, the useful attributes which udevinfo produces for /dev/sdb1 are identical to the ones for /dev/sdb. This results in your rule potentially matching <u>both</u> the raw disk and the partition, which is not what you want, your rule should be <b>specific</b>.
</p>

<p>
To get around this, you simply need to think about what differs between sdb and sdb1. It is surprisingly simple: the name itself differs, so we can use a simple pattern match on the NAME field.
</p>

<blockquote><pre>
# udevinfo -a -p $(udevinfo -q path -n /dev/sdb1)
  looking at device '/devices/pci0000:00/0000:00:02.0/usb2/2-1/2-1:1.0/host6/target6:0:0/6:0:0:0':
    ID=="6:0:0:0"
    BUS=="scsi"
    DRIVER=="sd"
    SYSFS{rev}=="1.00"
    SYSFS{model}=="X250,D560Z,C350Z"
    SYSFS{vendor}=="OLYMPUS "
    SYSFS{scsi_level}=="3"
    SYSFS{type}=="0"
</pre></blockquote>

<p>
My rule:
</p>

<blockquote><pre>NAME=="sd?1", BUS=="scsi", SYSFS{model}=="X250,D560Z,C350Z", SYMLINK+="camera"</pre></blockquote>

<a name="example-usbhdd"></a>
<h3>USB Hard Disk</h3>

<p>
A USB hard disk is comparable to the USB camera I described above, however typical usage patterns are different. In the camera example, I explained that I am not interested in the sdb node - it's only real use is for partitioning (e.g. with fdisk), but why would I want to partition my camera!?
</p>

<p>
Of course, if you have a 100GB USB hard disk, it is perfectly understandable that you might want to partition it, in which case we can take advantage of udev's string substitutions:
</p>

<blockquote><pre>BUS=="usb", KERNEL=="sd*", SYSFS{product}=="USB 2.0 Storage Device", NAME="%k", SYMLINK+="usbhd%n"</pre></blockquote>

<p>
This rule creates symlinks such as:
</p>

<ul>
<li><em>/dev/usbhd</em> - The fdiskable node</li>
<li><em>/dev/usbhd1</em> - The first partition (mountable)</li>
<li><em>/dev/usbhd2</em> - The second partition (mountable)</li>
</ul>

<a name="example-usbcardreader"></a>
<h3>USB Card Reader</h3>

<p>
USB card readers (CompactFlash, SmartMedia, etc) are yet another range of USB storage devices which have different usage requirements.
</p>

<p>
These devices typically do not inform the host computer upon media change. So, if you plug in the device with no media, and then insert a card, the computer does not realise, and you do not have your mountable sdb1 partition node for the media.
</p>

<p>
One possible solution is to take advantage of the <em>all_partitions</em> option, which will create 16 partition nodes for every block device that the rule matches:
</p>

<blockquote><pre>BUS=="usb", SYSFS{product}=="USB 2.0 CompactFlash Reader", SYMLINK+="cfrdr%n", OPTIONS+="all_partitions"</pre></blockquote>

You will now have nodes named: cfrdr, cfrdr1, cfrdr2, cfrdr3, ..., cfrdr15.

<a name="example-pilot"></a>
<h3>USB Palm Pilot</h3>

<p>
These devices work as USB-serial devices, so by default, you only get the <em>ttyUSB1</em> device node. The palm utilities rely on <em>/dev/pilot</em>, so many users will want to use a rule to provide this.
</p>

<p>
<a href="http://www.clasohm.com/blog/one-entry?entry%5fid=12096">Carsten Clasohm's blog post</a> appears to be the definitive source for this. Carsten's rule is shown below:
</p>

<blockquote><pre>BUS=="usb", SYSFS{product}=="Palm Handheld", KERNEL=="ttyUSB*", SYMLINK+="pilot"</pre></blockquote>

<p>
Note that the product string seems to vary from product to product, so make sure that you check (using udevinfo) which one applies to you.
</p>

<a name="example-cdrom"></a>
<h3>CD/DVD drives</h3>

<p>
I have two optical drives in this computer: a DVD reader (hdc), and a DVD rewriter (hdd). I do not expect these device nodes to change, unless I physically rewire my system. However, many users like to have device nodes such as <em>/dev/dvd</em> for convenience.
</p>

<p>
As we know the KERNEL names for these devices, rule writing is simple. Here are some examples for my system:
</p>

<blockquote><pre>
BUS=="ide", KERNEL=="hdc", SYMLINK+="dvd", GROUP="cdrom"
BUS=="ide", KERNEL=="hdd", SYMLINK+="dvdrw", GROUP="cdrom"
</pre></blockquote>

<a name="example-netif"></a>
<h3>Network interfaces</h3>

<p>
Even though they are referenced by names, network interfaces typically do not have device nodes associated with them. Despite that, the rule writing process is almost identical.
</p>

<p>
It makes sense to simply match the MAC address of your interface in the rule, as this is unique. However, make sure that you use the <em>exact</em> MAC address as shown as udevinfo, because if you do not match the case exactly, your rule will not work.
</p>

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

<p>
Here is my rule:
</p>

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

<p>
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.
After that, you should be able to use "lan" instead of "eth0" in any calls to ifconfig or similar utilities.
</p>

<h2>Testing and debugging</h2>

<a name="testing"></a>
<h3>Putting your rules into action</h3>

<p>
Assuming you are on a recent kernel with <em>inotify</em> support, udev will automatically monitor your rules directory and automatically pick up any modifications you make to the rule files.
</p>

<p>
Despite this, udev will not automatically reprocess all devices and attempt to apply the new rule(s). For example, if you write a rule to add an extra symbolic link for your camera while your camera is plugged in, you cannot expect the extra symbolic link to show up right away.
</p>

<p>
To make the symbolic link show up, you can either disconnect and reconnect your camera, or alternatively in the case of non-removable devices, you can run <b>udevtrigger</b>.
</p>

<p>
If your kernel does not have inotify support, new rules will not be detected automatically. In this situation, you must run <b>udevcontrol reload_rules</b> after making any rule file modifications for those modifications to take effect.
</p>

<a name="udevtest"></a>
<h3>udevtest</h3>

<p>
If you know the top-level device path in sysfs, you can use <b>udevtest</b> to show the actions which udev would take. This may help you debug your rules. For example, assuming you want to debug a rule which acts on <em>/sys/class/sound/dsp</em>:
</p>

<blockquote><pre>
# udevtest /class/sound/dsp
main: looking at device '/class/sound/dsp' from subsystem 'sound'
udev_rules_get_name: add symlink 'dsp'
udev_rules_get_name: rule applied, 'dsp' becomes 'sound/dsp'
udev_device_event: device '/class/sound/dsp' already known, remove possible symlinks
udev_node_add: creating device node '/dev/sound/dsp', major = '14', minor = '3', mode = '0660', uid = '0', gid = '18'
udev_node_add: creating symlink '/dev/dsp' to 'sound/dsp'
</pre></blockquote>

<p>
Note the <em>/sys</em> prefix was removed from the udevtest command line argument, this is because udevtest operates on device paths. Also note that udevtest is purely a testing/debugging tool, it does not create any device nodes, despite what the output suggests!
</p>

<a name="author"></a>
<h2>Author and contact</h2>

<p>
This document is written by Daniel Drake &lt;<a href="mailto:dan@reactivated.net">dan@reactivated.net</a>&gt;. Feedback is appreciated.
</p>

<p>
For support, you should mail the linux-hotplug mailing list: <a href="mailto:linux-hotplug-devel@lists.sourceforge.net">linux-hotplug-devel@lists.sourceforge.net</a>.
</p>

<p>
Copyright (C) 2003-2006 Daniel Drake.<br />
This document is licensed under the <a href="http://www.gnu.org/licenses/gpl.html">GNU General Public License, Version 2</a>.
</p>

</body>
</html>

