From the ''video4linux'' device we use {{ic|1=KERNEL=="video2"}} and {{ic|1=SUBSYSTEM=="video4linux"}}, then walking up two levels above, we match the webcam using vendor and product ID's from the usb parent {{ic|1=SUBSYSTEMS=="usb"}}, {{ic|1=ATTRS{idVendor}=="05a9"}} and {{ic|1=ATTRS{idProduct}=="4519"}}.

From the ''video4linux'' device we use {{ic|1=KERNEL=="video2"}} and {{ic|1=SUBSYSTEM=="video4linux"}}, then walking up two levels above, we match the webcam using vendor and product ID's from the usb parent {{ic|1=SUBSYSTEMS=="usb"}}, {{ic|1=ATTRS{idVendor}=="05a9"}} and {{ic|1=ATTRS{idProduct}=="4519"}}.

In the example above we create a symlink using {{ic|1=SYMLINK+="video-cam1"}} but we could easily set user {{ic|1=OWNER="john"}} or group using {{ic|1=GROUP="video"}} or set the permissions using {{ic|1=MODE="0660"}}. However, if you intend to write a rule to do something when a device is being removed, be aware that device attributes may not be accessible. In this case, you will have to work with preset device [[environment variables]]. To monitor those environment variables, execute the following command while unplugging your device:

+

Here we create a symlink using {{ic|1=SYMLINK+="video-cam1"}} but we could easily set user {{ic|1=OWNER="john"}} or group using {{ic|1=GROUP="video"}} or set the permissions using {{ic|1=MODE="0660"}}. However, if you intend to write a rule to do something when a device is being removed, be aware that device attributes may not be accessible. In this case, you will have to work with preset device [[environment variables]]. To monitor those environment variables, execute the following command while unplugging your device:

# udevadm monitor --environment --udev

# udevadm monitor --environment --udev

Revision as of 21:07, 12 June 2018

udev is a device manager for the Linux kernel. As the successor of devfsd and hotplug, udev primarily manages device nodes in the /dev directory. At the same time, udev also handles all user space events raised while hardware devices are added into the system or removed from it, including firmware loading as required by certain devices.

udev replaces the functionality of both hotplug and hwdetect.

udev loads kernel modules by utilizing coding parallelism to provide a potential performance advantage versus loading these modules serially. The modules are therefore loaded asynchronously. The inherent disadvantage of this method is that udev does not always load modules in the same order on each boot. If the machine has multiple block devices, this may manifest itself in the form of device nodes changing designations randomly. For example, if the machine has two hard drives, /dev/sda may randomly become /dev/sdb. See below for more info on this.

Installation

About udev rules

udev rules written by the administrator go in /etc/udev/rules.d/, their file name has to end with .rules. The udev rules shipped with various packages are found in /usr/lib/udev/rules.d/. If there are two files by the same name under /usr/lib and /etc, the ones in /etc take precedence.

udev rule example

Below is an example of a rule that places a symlink /dev/video-cam1 when a webcamera is connected.

Let say this camera is currently connected and has loaded with the device name /dev/video2. The reason for writing this rule is that at the next boot, the device could show up under a different name, like /dev/video0.

# udevadm info -a -p $(udevadm info -q path -n /dev/video2)

Udevadm info starts with the device specified by the devpath and then walks up the chain of parent devices.
It prints for every device found, all possible attributes in the udev rules key format.
A rule to match, can be composed by the attributes of the device and the attributes from one single parent device.
looking at device '/devices/pci0000:00/0000:00:04.1/usb3/3-2/3-2:1.0/video4linux/video2':
KERNEL=="video2"
SUBSYSTEM=="video4linux"
...
looking at parent device '/devices/pci0000:00/0000:00:04.1/usb3/3-2/3-2:1.0':
KERNELS=="3-2:1.0"
SUBSYSTEMS=="usb"
...
looking at parent device '/devices/pci0000:00/0000:00:04.1/usb3/3-2':
KERNELS=="3-2"
SUBSYSTEMS=="usb"
ATTRS{idVendor}=="05a9"
ATTRS{manufacturer}=="OmniVision Technologies, Inc."
ATTRS{removable}=="unknown"
ATTRS{idProduct}=="4519"
ATTRS{bDeviceClass}=="00"
ATTRS{product}=="USB Camera"
...

From the video4linux device we use KERNEL=="video2" and SUBSYSTEM=="video4linux", then walking up two levels above, we match the webcam using vendor and product ID's from the usb parent SUBSYSTEMS=="usb", ATTRS{idVendor}=="05a9" and ATTRS{idProduct}=="4519".

Here we create a symlink using SYMLINK+="video-cam1" but we could easily set user OWNER="john" or group using GROUP="video" or set the permissions using MODE="0660". However, if you intend to write a rule to do something when a device is being removed, be aware that device attributes may not be accessible. In this case, you will have to work with preset device environment variables. To monitor those environment variables, execute the following command while unplugging your device:

# udevadm monitor --environment --udev

In this command's output, you will see value pairs such as ID_VENDOR_ID and ID_MODEL_ID, which match your previously used attributes "idVendor" and "idProduct". A rule that uses device environment variables may look like this:

List attributes of a device

To get a list of all of the attributes of a device you can use to write rules, run this command:

# udevadm info -a -n device_name

Replace device_name with the device present in the system, such as /dev/sda or /dev/ttyUSB0.

If you do not know the device name you can also list all attributes of a specific system path:

# udevadm info -a -p /sys/class/backlight/acpi_video0

Testing rules before loading

# udevadm test $(udevadm info -q path -n device_name) 2>&1

This will not perform all actions in your new rules but it will however process symlink rules on existing devices which might come in handy if you are unable to load them otherwise. You can also directly provide the path to the device you want to test the udev rule for:

# udevadm test /sys/class/backlight/acpi_video0/

Loading new rules

udev automatically detects changes to rules files, so changes take effect immediately without requiring udev to be restarted. However, the rules are not re-triggered automatically on already existing devices. Hot-pluggable devices, such as USB devices, will probably have to be reconnected for the new rules to take effect, or at least unloading and reloading the ohci-hcd and ehci-hcd kernel modules and thereby reloading all USB drivers.

Udisks

Tips and tricks

Mounting drives in rules

This article or section needs expansion.

Reason: You can workaround the FUSE errors (caused by udev killing the mount process) by using a systemd service [1][2] (Discuss in Talk:Udev#)

To mount removable drives, do not call mount from udev rules. In case of FUSE filesystems, you will get Transport endpoint not connected errors. Instead, you could use udisks that handles automount correctly or to make mount work inside udev rules, copy /usr/lib/systemd/system/systemd-udevd.service to /etc/systemd/system/systemd-udevd.service and replace MountFlags=slave to MountFlags=shared.[3] Keep in mind though that udev is not intended to invoke long-running processes.

Accessing firmware programmers and USB virtual comm devices

The following rule will allow users in the users group to access the USBtinyISP USB programmer for AVR microcontrollers.

Hopefully, your drive is now in /dev. If it is not, you could try the above commands while running:

# udevadm monitor

to see if anything is actually happening.

Mark internal SATA ports as eSATA

If you connected a eSATA bay or an other eSATA adapter the system will still recognize this disk as an internal SATA drive. GNOME and KDE will ask you for your root password all the time. The following rule will mark the specified SATA-Port as an external eSATA-Port. With that, a normal GNOME user can connect their eSATA drives to that port like a USB drive, without any root password and so on.

Identifying a disk by its serial

To perform some action on a specific disk device /dev/sdX identified permanently by its unique serial ID_SERIAL_SHORT as displayed with udevadm info -n /dev/sdX, one can use the below rule. It is passing as a parameter the device name found if any to illustrate:

Waking from suspend with USB device

A udev rule can be useful to enable the wake up functionality of a USB device, like a mouse or a keyboard, so that it can be used to wake from sleep the machine.

Note: By default, the USB host controllers are all enabled for wakeup. The status can be checked using cat /proc/acpi/wakeup. The rule below is in this case not necessary but can be used as a template to perform other actions, like disabling the wakeup functionality for example.

First, identify the vendor and product identifiers of the USB device. They will be used to recognize it in the udev rule. For example:

# lsusb | grep Logitech

Bus 007 Device 002: ID 046d:c52b Logitech, Inc. Unifying Receiver

Then, find where the device is connected to using:

# grep c52b /sys/bus/usb/devices/*/idProduct

/sys/bus/usb/devices/1-1.1.1.4/idProduct:c52b

Now create the rule to change the power/wakeup attribute of both the device and the USB controller it is connected to whenever it is added:

This command will trigger a USB remove event on all USB devices with vendor ID abcd.

Triggering desktop notifications from a udev rule

The factual accuracy of this article or section is disputed.

Reason: This is a lenghty monologue on how to hardcode variables (Discuss in Talk:Udev#)

Invoking an external script containing calls to notify-send via udevcan sometimes be challenging since the notification(s) never display on the Desktop. Here is an example of what commands and environmental variables need to be included in which files for notify-send to successfully be executed from a udev rule. NOTE: a number of variables are hardcoded in this example, thus consider making them portable (i.e., $USER rather than user's shortname) once you understand the example.

1) The following udev rule executes a script that plays a notification sound and sends a desktop notification when screen brightness is changed according to power state on a laptop. Create the file:

/etc/udev/rules.d/99-backlight_notification.rules

Play a notification sound and send a desktop notification when screen brightness is changed according to power state on a laptop (a second ''udev'' rule actually changes the screen brightness)
# Rule for when switching to battery
ACTION=="change", SUBSYSTEM=="power_supply", ATTR{type}=="Mains", ATTR{online}=="0", ENV{DISPLAY}=":0", ENV{XAUTHORITY}="/home/USERNAME/.Xauthority" RUN+="/usr/bin/su USERNAME_TO_RUN_SCRIPT_AS -c /usr/local/bin/brightness_notification.sh"
# Rule for when switching to AC
ACTION=="change", SUBSYSTEM=="power_supply", ATTR{type}=="Mains", ATTR{online}=="1", ENV{DISPLAY}=":0", ENV{XAUTHORITY}="/home/USERNAME/.Xauthority" RUN+="/usr/bin/su USERNAME_TO_RUN_SCRIPT_AS -c /usr/local/bin/brightness_notification.sh"

Note: 1) USERNAME_TO_RUN_SCRIPT_AS and USERNAME need to be changed to that of the shortname for the user of the graphical session where the notification will be displayed and 2) the script needs to be executed with /usr/bin/su, which will place its ownership under the user of the graphical session (rather than root/the system) where the notification will be displayed.

2) Contents of the executable script to be run on trigger of the udev rule:

Note: 1) USERNAME_TO_RUN_SCRIPT_AS, UID_OF_USER_TO_RUN_SCRIPT_AS and USERNAME needs to be changed to that of the shortname for the user and user's UID of the graphical session where the notification will be displayed; 2) /usr/bin/sudo is needed when playing audio via pulseaudio; and, 3) three environmental variables (i.e., XAUTHORITY, DISPLAY and DBUS_SESSION_BUS_ADDRESS) for the user of the graphical session where the notification will be displayed need to be defined and exported.

Note: The XAUTHORITY, DISPLAY and DBUS_SESSION_BUS_ADDRESS environment variables must be defined correctly.

3) Load/reload the new udev rule (see above) and test it by unplugging the power supply to the laptop.

Tip: See also xpub as a method for getting the user's display environment variables and exporting the last into udev rules via IMPORT key.

Troubleshooting

Blacklisting modules

In rare cases, udev can make mistakes and load the wrong modules. To prevent it from doing this, you can blacklist modules. Once blacklisted, udev will never load that module. See blacklisting. Not at boot-time or later on when a hotplug event is received (eg, you plug in your USB flash drive).

Debug output

To get hardware debug info, use the kernel parameterudev.log-priority=debug. Alternatively you can set

/etc/udev/udev.conf

udev_log="debug"

This option can also be compiled into your initramfs by adding the config file to your FILES array

udevd hangs at boot

After migrating to LDAP or updating an LDAP-backed system udevd can hang at boot at the message "Starting UDev Daemon". This is usually caused by udevd trying to look up a name from LDAP but failing, because the network is not up yet. The solution is to ensure that all system group names are present locally.

Extract the group names referenced in udev rules and the group names actually present on the system:

In this case, the pcscd group is for some reason not present in the system. Add the missing groups. Also, make sure that local resources are looked up before resorting to LDAP. /etc/nsswitch.conf should contain the following line:

group: files ldap

BusLogic devices can be broken and will cause a freeze during startup

This is a kernel bug and no fix has been provided yet.

Some devices, that should be treated as removable, are not

You need to create a custom udev rule for that particular device. To get definitive information of the device you can use either ID_SERIAL or ID_SERIAL_SHORT (remember to change /dev/sdb if needed):

$ udevadm info /dev/sdb | grep ID_SERIAL

Then we create a rule in /etc/udev/rules.d/ and set variables for either udisks or udisks2.

For udisks, set UDISKS_SYSTEM_INTERNAL="0", which will mark the device as "removable" and thus "eligible for automounting". See udisks(7) for details.

Remember to reload udev rules with udevadm control --reload. Next time you plug your device in, it will be treated as an external drive.

Sound problems with some modules not loaded automatically

Some users have traced this problem to old entries in /etc/modprobe.d/sound.conf. Try cleaning that file out and trying again.

Note: Since udev>=171, the OSS emulation modules (snd_seq_oss, snd_pcm_oss, snd_mixer_oss) are not automatically loaded by default.

IDE CD/DVD-drive support

Starting with version 170, udev does not support CD-ROM/DVD-ROM drives that are loaded as traditional IDE drives with the ide_cd_mod module and show up as /dev/hd*. The drive remains usable for tools which access the hardware directly, like cdparanoia, but is invisible for higher userspace programs, like KDE.

A cause for the loading of the ide_cd_mod module prior to others, like sr_mod, could be e.g. that you have for some reason the module piix loaded with your initramfs. In that case you can just replace it with ata_piix in your /etc/mkinitcpio.conf.

Optical drives have group ID set to "disk"

If the group ID of your optical drive is set to disk and you want to have it set to optical, you have to create a custom udev rule: