devd.conf revision 220168
1108983Simp# $FreeBSD: head/etc/devd.conf 220168 2011-03-30 18:35:02Z trasz $
2108983Simp#
3108983Simp# Refer to devd.conf(5) and devd(8) man pages for the details on how to
4108983Simp# run and configure devd.
5108983Simp#
6108983Simp
7108983Simp# NB: All regular expressions have an implicit ^$ around them.
8108983Simp# NB: device-name is shorthand for 'match device-name'
9108983Simp
10108983Simpoptions {
11108983Simp	# Each directory directive adds a directory the list of directories
12108983Simp	# that we scan for files.  Files are read-in in the order that they
13108983Simp	# are returned from readdir(3).  The rule-sets are combined to
14108983Simp	# create a DFA that's used to match events to actions.
15108983Simp	directory "/etc/devd";
16108983Simp	directory "/usr/local/etc/devd";
17108983Simp	pid-file "/var/run/devd.pid";
18108983Simp
19108983Simp	# Setup some shorthand for regex that we use later in the file.
20148471Simp	#XXX Yes, these are gross -- imp
21108983Simp	set scsi-controller-regex
22139027Sbrueffer		"(aac|adv|adw|aha|ahb|ahc|ahd|aic|amd|amr|asr|bt|ciss|ct|dpt|\
23146969Smarius		esp|ida|iir|ips|isp|mlx|mly|mpt|ncr|ncv|nsp|stg|sym|trm|wds)\
24139027Sbrueffer		[0-9]+";
25108983Simp};
26108983Simp
27108983Simp# Note that the attach/detach with the highest value wins, so that one can
28108983Simp# override these general rules.
29108983Simp
30108983Simp#
31159126Sthompsa# Configure the interface on attach.  Due to a historical accident, this
32159126Sthompsa# script is called pccard_ether.
33108983Simp#
34187743Ssam# NB: DETACH events are ignored; the kernel should handle all cleanup
35187743Ssam#     (routes, arp cache) if you need to do something beware of races
36187743Ssam#     against immediate create of a device w/ the same name; e.g.
37187743Ssam#	ifconfig bridge0 destroy; ifconfig bridge0 create
38187743Ssam#
39159126Sthompsanotify 0 {
40159126Sthompsa	match "system"		"IFNET";
41159126Sthompsa	match "type"		"ATTACH";
42159126Sthompsa	action "/etc/pccard_ether $subsystem start";
43108983Simp};
44108983Simp
45147088Sbrooks#
46147088Sbrooks# Try to start dhclient on Ethernet like interfaces when the link comes
47147088Sbrooks# up.  Only devices that are configured to support DHCP will actually
48216983Sjpaetzel# run it.  No link down rule exists because dhclient automatically exits
49147088Sbrooks# when the link goes down.
50147088Sbrooks#
51147088Sbrooksnotify 0 {
52147088Sbrooks	match "system"		"IFNET";
53147088Sbrooks	match "type"		"LINK_UP";
54148642Ssam	media-type		"ethernet";
55175683Smtm	action "/etc/rc.d/dhclient quietstart $subsystem";
56147088Sbrooks};
57147088Sbrooks
58148642Ssam#
59148642Ssam# Like Ethernet devices, but separate because
60148642Ssam# they have a different media type.  We may want
61148642Ssam# to exploit this later.
62148642Ssam#
63148642Ssamdetach 0 {
64148642Ssam	media-type "802.11";
65148642Ssam	action "/etc/pccard_ether $device-name stop";
66148642Ssam};
67148642Ssamattach 0 {
68148642Ssam	media-type "802.11";
69148642Ssam	action "/etc/pccard_ether $device-name start";
70148642Ssam};
71148642Ssamnotify 0 {
72148642Ssam	match "system"		"IFNET";
73148642Ssam	match "type"		"LINK_UP";
74148642Ssam	media-type		"802.11";
75175683Smtm	action "/etc/rc.d/dhclient quietstart $subsystem";
76148642Ssam};
77148642Ssam
78108983Simp# An entry like this might be in a different file, but is included here
79108983Simp# as an example of how to override things.  Normally 'ed50' would match
80108983Simp# the above attach/detach stuff, but the value of 100 makes it
81139281Sbrueffer# hard wired to 1.2.3.4.
82108983Simpattach 100 {
83108983Simp	device-name "ed50";
84108983Simp	action "ifconfig $device-name inet 1.2.3.4 netmask 0xffff0000";
85108983Simp};
86108983Simpdetach 100 {
87108983Simp	device-name "ed50";
88108983Simp};
89108983Simp
90152326Semax# When a USB Bluetooth dongle appears activate it
91152326Semaxattach 100 {
92152326Semax	device-name "ubt[0-9]+";
93175683Smtm	action "/etc/rc.d/bluetooth quietstart $device-name";
94152326Semax};
95152326Semaxdetach 100 {
96152326Semax	device-name "ubt[0-9]+";
97175683Smtm	action "/etc/rc.d/bluetooth quietstop $device-name";
98152326Semax};
99152326Semax
100215195Semax# Firmware downloader for Atheros AR3011 based USB Bluetooth devices
101215195Semax#attach 100 {
102215195Semax#	match "vendor" "0x0cf3";
103215195Semax#	match "product" "0x3000";
104215195Semax#	action "sleep 2 && /usr/sbin/ath3kfw -d $device-name -f /usr/local/etc/ath3k-1.fw";
105215195Semax#};
106215195Semax
107139281Sbrueffer# When a USB keyboard arrives, attach it as the console keyboard.
108134584Sbrooksattach 100 {
109134584Sbrooks	device-name "ukbd0";
110156782Semax	action "/etc/rc.d/syscons setkeyboard /dev/ukbd0";
111134584Sbrooks};
112134584Sbrooksdetach 100 {
113134584Sbrooks	device-name "ukbd0";
114156331Semax	action "/etc/rc.d/syscons setkeyboard /dev/kbd0";
115134584Sbrooks};
116134584Sbrooks
117138175Siedowseattach 100 {
118138175Siedowse	device-name "ums[0-9]+";
119175683Smtm	action "/etc/rc.d/moused quietstart $device-name";
120138175Siedowse};
121138175Siedowse
122208060Sdougbdetach 100 {
123208060Sdougb        device-name "ums[0-9]+";
124208060Sdougb        action "/etc/rc.d/moused stop $device-name";
125208060Sdougb};
126179804Skmacy
127153300Siedowse# Firmware download into the ActiveWire board. After the firmware download is
128153300Siedowse# done the device detaches and reappears as something new and shiny
129153300Siedowse# automatically.
130153300Siedowseattach 100 {
131153300Siedowse	match "vendor"	"0x0854";
132153300Siedowse	match "product"	"0x0100";
133153300Siedowse	match "release"	"0x0000";
134153300Siedowse	action "/usr/local/bin/ezdownload -f /usr/local/share/usb/firmware/0854.0100.0_01.hex $device-name";
135153300Siedowse};
136153300Siedowse
137153300Siedowse# Firmware download for Entrega Serial DB25 adapter.
138153300Siedowseattach 100 {
139153300Siedowse	match "vendor"	"0x1645";
140153300Siedowse	match "product"	"0x8001";
141153300Siedowse	match "release"	"0x0101";
142192198Smaxim	action "if ! kldstat -n usio > /dev/null 2>&1 ; then kldload usio; fi; /usr/sbin/ezdownload -v -f /usr/share/usb/firmware/1645.8001.0101 /dev/$device-name";
143153300Siedowse};
144153300Siedowse
145153300Siedowse# This entry starts the ColdSync tool in daemon mode. Make sure you have an up
146153300Siedowse# to date /usr/local/etc/palms. We override the 'listen' settings for port and
147153300Siedowse# type in /usr/local/etc/coldsync.conf.
148207020Sthompsanotify 100 {
149207020Sthompsa	match "system"		"USB";
150207020Sthompsa	match "subsystem"	"DEVICE";
151207020Sthompsa	match "type"		"ATTACH";
152207020Sthompsa	match "vendor"		"0x082d";
153207020Sthompsa	match "product"		"0x0100";
154207020Sthompsa	match "release"		"0x0100";
155207020Sthompsa	action "/usr/local/bin/coldsync -md -p /dev/$cdev -t usb";
156153300Siedowse};
157153300Siedowse
158108983Simp#
159148471Simp# Rescan scsi device-names on attach, but not detach.  However, it is
160148471Simp# disabled by default due to reports of problems.
161108983Simp#
162108983Simpattach 0 {
163108983Simp	device-name "$scsi-controller-regex";
164131646Simp//	action "camcontrol rescan all";
165108983Simp};
166108983Simp
167108983Simp# Don't even try to second guess what to do about drivers that don't
168114799Simp# match here.  Instead, pass it off to syslog.  Commented out for the
169166754Simp# moment, as the pnpinfo variable isn't set in devd yet.  Individual
170166754Simp# variables within the bus supplied pnpinfo are set.
171119254Simpnomatch 0 {
172114852Simp#	action "logger Unknown device: $pnpinfo $location $bus";
173119254Simp};
174108983Simp
175166701Sjoerg# Various logging of unknown devices.
176166701Sjoergnomatch 10 {
177166701Sjoerg	match "bus" "uhub[0-9]+";
178166701Sjoerg	action "logger Unknown USB device: vendor $vendor product $product \
179166701Sjoerg		bus $bus";
180166701Sjoerg};
181166701Sjoerg
182166701Sjoerg# Some PC-CARDs don't offer numerical manufacturer/product IDs, just
183166701Sjoerg# show the CIS info there.
184166701Sjoergnomatch 20 {
185166701Sjoerg	match "bus" "pccard[0-9]+";
186166701Sjoerg	match "manufacturer" "0xffffffff";
187166701Sjoerg	match "product" "0xffffffff";
188166701Sjoerg	action "logger Unknown PCCARD device: CISproduct $cisproduct \
189166701Sjoerg		CIS-vendor $cisvendor bus $bus";
190166701Sjoerg};
191166701Sjoerg
192166701Sjoergnomatch 10 {
193166701Sjoerg	match "bus" "pccard[0-9]+";
194166701Sjoerg	action "logger Unknown PCCARD device: manufacturer $manufacturer \
195166701Sjoerg		product $product CISproduct $cisproduct CIS-vendor \
196166701Sjoerg		$cisvendor bus $bus";
197166701Sjoerg};
198166701Sjoerg
199166701Sjoergnomatch 10 {
200166701Sjoerg	match "bus" "cardbus[0-9]+";
201166701Sjoerg	action "logger Unknown Cardbus device: device $device class $class \
202166701Sjoerg		vendor $vendor bus $bus";
203166701Sjoerg};
204166701Sjoerg
205139281Sbrueffer# Switch power profiles when the AC line state changes.
206123626Snjlnotify 10 {
207123626Snjl	match "system"		"ACPI";
208123626Snjl	match "subsystem"	"ACAD";
209125366Snjl	action "/etc/rc.d/power_profile $notify";
210123626Snjl};
211123626Snjl
212125366Snjl# Notify all users before beginning emergency shutdown when we get
213125366Snjl# a _CRT or _HOT thermal event and we're going to power down the system
214125366Snjl# very soon.
215125366Snjlnotify 10 {
216125366Snjl	match "system"		"ACPI";
217125366Snjl	match "subsystem"	"Thermal";
218125366Snjl	match "notify"		"0xcc";
219125366Snjl	action "logger -p kern.emerg 'WARNING: system temperature too high, shutting down soon!'";
220125366Snjl};
221125366Snjl
222168495Spjd# Sample ZFS problem reports handling.
223168495Spjdnotify 10 {
224168495Spjd	match "system"		"ZFS";
225168495Spjd	match "type"		"zpool";
226168495Spjd	action "logger -p kern.err 'ZFS: failed to load zpool $pool'";
227168495Spjd};
228168495Spjd
229168495Spjdnotify 10 {
230168495Spjd	match "system"		"ZFS";
231168495Spjd	match "type"		"vdev";
232168497Spjd	action "logger -p kern.err 'ZFS: vdev failure, zpool=$pool type=$type'";
233168495Spjd};
234168495Spjd
235168495Spjdnotify 10 {
236168495Spjd	match "system"		"ZFS";
237168495Spjd	match "type"		"data";
238168495Spjd	action "logger -p kern.warn 'ZFS: zpool I/O failure, zpool=$pool error=$zio_err'";
239168495Spjd};
240168495Spjd
241168495Spjdnotify 10 {
242168495Spjd	match "system"		"ZFS";
243168495Spjd	match "type"		"io";
244168495Spjd	action "logger -p kern.warn 'ZFS: vdev I/O failure, zpool=$pool path=$vdev_path offset=$zio_offset size=$zio_size error=$zio_err'";
245168495Spjd};
246168495Spjd
247168495Spjdnotify 10 {
248168495Spjd	match "system"		"ZFS";
249168495Spjd	match "type"		"checksum";
250168495Spjd	action "logger -p kern.warn 'ZFS: checksum mismatch, zpool=$pool path=$vdev_path offset=$zio_offset size=$zio_size'";
251168495Spjd};
252168495Spjd
253170976Snjl# User requested suspend, so perform preparation steps and then execute
254170976Snjl# the actual suspend process.
255170976Snjlnotify 10 {
256170976Snjl	match "system"		"ACPI";
257170976Snjl	match "subsystem"	"Suspend";
258170976Snjl	action "/etc/rc.suspend acpi $notify";
259170976Snjl};
260170976Snjlnotify 10 {
261170976Snjl	match "system"		"ACPI";
262170976Snjl	match "subsystem"	"Resume";
263170976Snjl	action "/etc/rc.resume acpi $notify";
264170976Snjl};
265170976Snjl
266108983Simp/* EXAMPLES TO END OF FILE
267108983Simp
268108983Simp# The following might be an example of something that a vendor might
269108983Simp# install if you were to add their device.  This might reside in
270108983Simp# /usr/local/etc/devd/deqna.conf.  A deqna is, in this hypothetical
271108983Simp# example, a pccard ethernet-like device.  Students of history may
272108983Simp# know other devices by this name, and will get the in-jokes in this
273108983Simp# entry.
274108983Simpnomatch 10 {
275108983Simp	match "bus" "pccard[0-9]+";
276108983Simp	match "manufacturer" "0x1234";
277108983Simp	match "product" "0x2323";
278108983Simp	action "kldload if_deqna";
279108983Simp};
280108983Simpattach 10 {
281108983Simp	device-name "deqna[0-9]+";
282108983Simp	action "/etc/pccard_ether $device-name start";
283108983Simp};
284108983Simpdetach 10 {
285108983Simp	device-name "deqna[0-9]+";
286108983Simp	action "/etc/pccard_ether $device-name stop";
287108983Simp};
288108983Simp
289121493Snjl# Examples of notify hooks.  A notify is a generic way for a kernel
290121493Snjl# subsystem to send event notification to userland.
291121493Snjl#
292121493Snjl# Here are some examples of ACPI notify handlers.  ACPI subsystems that
293121493Snjl# generate notifies include the AC adapter, power/sleep buttons,
294121493Snjl# control method batteries, lid switch, and thermal zones.
295121493Snjl#
296121493Snjl# Information returned is not always the same as the ACPI notify
297121493Snjl# events.  See the ACPI specification for more information about
298121493Snjl# notifies.  Here is the information returned for each subsystem:
299121493Snjl#
300121493Snjl# ACAD:		AC line state (0 is offline, 1 is online)
301121493Snjl# Button:	Button pressed (0 for power, 1 for sleep)
302121493Snjl# CMBAT:	ACPI battery events
303121493Snjl# Lid:		Lid state (0 is closed, 1 is open)
304220168Strasz# RCTL:		Resource limits
305170976Snjl# Suspend, Resume: Suspend and resume notification
306121493Snjl# Thermal:	ACPI thermal zone events
307121493Snjl#
308121493Snjl# This example calls a script when the AC state changes, passing the
309121493Snjl# notify value as the first argument.  If the state is 0x00, it might
310121493Snjl# call some sysctls to implement economy mode.  If 0x01, it might set
311121493Snjl# the mode to performance.
312121493Snjlnotify 10 {
313121493Snjl	match "system"		"ACPI";
314121493Snjl	match "subsystem"	"ACAD";
315121493Snjl	action			"/etc/acpi_ac $notify";
316121493Snjl};
317220168Strasz
318220168Strasz# This example works around a memory leak in PostgreSQL, restarting
319220168Strasz# it when "user:pgsql:swap:devctl=1G" rctl(8) rule gets triggered.
320220168Strasznotify 0 {
321220168Strasz	match "system"		"RCTL";
322220168Strasz	match "rule"		"user:70:swap:.*";
323220168Strasz	action			"/usr/local/etc/rc.d/postgresql restart"
324220168Strasz};
325220168Strasz
326108983Simp*/
327