devd.conf revision 175683
1108983Simp# $FreeBSD: head/etc/devd.conf 175683 2008-01-26 13:50:38Z mtm $
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#
34159126Sthompsanotify 0 {
35159126Sthompsa	match "system"		"IFNET";
36159126Sthompsa	match "type"		"ATTACH";
37159126Sthompsa	action "/etc/pccard_ether $subsystem start";
38108983Simp};
39108983Simp
40159126Sthompsanotify 0 {
41159126Sthompsa	match "system"		"IFNET";
42159126Sthompsa	match "type"		"DETACH";
43159126Sthompsa	action "/etc/pccard_ether $subsystem stop";
44108983Simp};
45108983Simp
46147088Sbrooks#
47147088Sbrooks# Try to start dhclient on Ethernet like interfaces when the link comes
48147088Sbrooks# up.  Only devices that are configured to support DHCP will actually
49147088Sbrooks# run it.  No link down rule exists because dhclient automaticly exits
50147088Sbrooks# when the link goes down.
51147088Sbrooks#
52147088Sbrooksnotify 0 {
53147088Sbrooks	match "system"		"IFNET";
54147088Sbrooks	match "type"		"LINK_UP";
55148642Ssam	media-type		"ethernet";
56175683Smtm	action "/etc/rc.d/dhclient quietstart $subsystem";
57147088Sbrooks};
58147088Sbrooks
59148642Ssam#
60148642Ssam# Like Ethernet devices, but separate because
61148642Ssam# they have a different media type.  We may want
62148642Ssam# to exploit this later.
63148642Ssam#
64148642Ssamdetach 0 {
65148642Ssam	media-type "802.11";
66148642Ssam	action "/etc/pccard_ether $device-name stop";
67148642Ssam};
68148642Ssamattach 0 {
69148642Ssam	media-type "802.11";
70148642Ssam	action "/etc/pccard_ether $device-name start";
71148642Ssam};
72148642Ssamnotify 0 {
73148642Ssam	match "system"		"IFNET";
74148642Ssam	match "type"		"LINK_UP";
75148642Ssam	media-type		"802.11";
76175683Smtm	action "/etc/rc.d/dhclient quietstart $subsystem";
77148642Ssam};
78148642Ssam
79108983Simp# An entry like this might be in a different file, but is included here
80108983Simp# as an example of how to override things.  Normally 'ed50' would match
81108983Simp# the above attach/detach stuff, but the value of 100 makes it
82139281Sbrueffer# hard wired to 1.2.3.4.
83108983Simpattach 100 {
84108983Simp	device-name "ed50";
85108983Simp	action "ifconfig $device-name inet 1.2.3.4 netmask 0xffff0000";
86108983Simp};
87108983Simpdetach 100 {
88108983Simp	device-name "ed50";
89108983Simp};
90108983Simp
91152326Semax# When a USB Bluetooth dongle appears activate it
92152326Semaxattach 100 {
93152326Semax	device-name "ubt[0-9]+";
94175683Smtm	action "/etc/rc.d/bluetooth quietstart $device-name";
95152326Semax};
96152326Semaxdetach 100 {
97152326Semax	device-name "ubt[0-9]+";
98175683Smtm	action "/etc/rc.d/bluetooth quietstop $device-name";
99152326Semax};
100152326Semax
101139281Sbrueffer# When a USB keyboard arrives, attach it as the console keyboard.
102134584Sbrooksattach 100 {
103134584Sbrooks	device-name "ukbd0";
104156782Semax	action "/etc/rc.d/syscons setkeyboard /dev/ukbd0";
105134584Sbrooks};
106134584Sbrooksdetach 100 {
107134584Sbrooks	device-name "ukbd0";
108156331Semax	action "/etc/rc.d/syscons setkeyboard /dev/kbd0";
109134584Sbrooks};
110134584Sbrooks
111138175Siedowse# The entry below starts moused when a mouse is plugged in. Moused
112138175Siedowse# stops automatically (actually it bombs :) when the device disappears.
113138175Siedowseattach 100 {
114138175Siedowse	device-name "ums[0-9]+";
115175683Smtm	action "/etc/rc.d/moused quietstart $device-name";
116138175Siedowse};
117138175Siedowse
118153300Siedowse# Firmware download into the ActiveWire board. After the firmware download is
119153300Siedowse# done the device detaches and reappears as something new and shiny
120153300Siedowse# automatically.
121153300Siedowseattach 100 {
122153300Siedowse	match "vendor"	"0x0854";
123153300Siedowse	match "product"	"0x0100";
124153300Siedowse	match "release"	"0x0000";
125153300Siedowse	action "/usr/local/bin/ezdownload -f /usr/local/share/usb/firmware/0854.0100.0_01.hex $device-name";
126153300Siedowse};
127153300Siedowse
128153300Siedowse# Firmware download for Entrega Serial DB25 adapter.
129153300Siedowseattach 100 {
130153300Siedowse	match "vendor"	"0x1645";
131153300Siedowse	match "product"	"0x8001";
132153300Siedowse	match "release"	"0x0101";
133153300Siedowse	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";
134153300Siedowse};
135153300Siedowse
136153300Siedowse# This entry starts the ColdSync tool in daemon mode. Make sure you have an up
137153300Siedowse# to date /usr/local/etc/palms. We override the 'listen' settings for port and
138153300Siedowse# type in /usr/local/etc/coldsync.conf.
139153300Siedowseattach 100 {
140153300Siedowse	device-name "ugen[0-9]+";
141153300Siedowse	match "vendor" "0x082d";
142153300Siedowse	match "product" "0x0100";
143153300Siedowse	match "release" "0x0100";
144153300Siedowse	action "/usr/local/bin/coldsync -md -p /dev/$device-name -t usb";
145153300Siedowse};
146153300Siedowse
147108983Simp#
148148471Simp# Rescan scsi device-names on attach, but not detach.  However, it is
149148471Simp# disabled by default due to reports of problems.
150108983Simp#
151108983Simpattach 0 {
152108983Simp	device-name "$scsi-controller-regex";
153131646Simp//	action "camcontrol rescan all";
154108983Simp};
155108983Simp
156108983Simp# Don't even try to second guess what to do about drivers that don't
157114799Simp# match here.  Instead, pass it off to syslog.  Commented out for the
158166754Simp# moment, as the pnpinfo variable isn't set in devd yet.  Individual
159166754Simp# variables within the bus supplied pnpinfo are set.
160119254Simpnomatch 0 {
161114852Simp#	action "logger Unknown device: $pnpinfo $location $bus";
162119254Simp};
163108983Simp
164166701Sjoerg# Various logging of unknown devices.
165166701Sjoergnomatch 10 {
166166701Sjoerg	match "bus" "uhub[0-9]+";
167166701Sjoerg	action "logger Unknown USB device: vendor $vendor product $product \
168166701Sjoerg		bus $bus";
169166701Sjoerg};
170166701Sjoerg
171166701Sjoerg# Some PC-CARDs don't offer numerical manufacturer/product IDs, just
172166701Sjoerg# show the CIS info there.
173166701Sjoergnomatch 20 {
174166701Sjoerg	match "bus" "pccard[0-9]+";
175166701Sjoerg	match "manufacturer" "0xffffffff";
176166701Sjoerg	match "product" "0xffffffff";
177166701Sjoerg	action "logger Unknown PCCARD device: CISproduct $cisproduct \
178166701Sjoerg		CIS-vendor $cisvendor bus $bus";
179166701Sjoerg};
180166701Sjoerg
181166701Sjoergnomatch 10 {
182166701Sjoerg	match "bus" "pccard[0-9]+";
183166701Sjoerg	action "logger Unknown PCCARD device: manufacturer $manufacturer \
184166701Sjoerg		product $product CISproduct $cisproduct CIS-vendor \
185166701Sjoerg		$cisvendor bus $bus";
186166701Sjoerg};
187166701Sjoerg
188166701Sjoergnomatch 10 {
189166701Sjoerg	match "bus" "cardbus[0-9]+";
190166701Sjoerg	action "logger Unknown Cardbus device: device $device class $class \
191166701Sjoerg		vendor $vendor bus $bus";
192166701Sjoerg};
193166701Sjoerg
194139281Sbrueffer# Switch power profiles when the AC line state changes.
195123626Snjlnotify 10 {
196123626Snjl	match "system"		"ACPI";
197123626Snjl	match "subsystem"	"ACAD";
198125366Snjl	action "/etc/rc.d/power_profile $notify";
199123626Snjl};
200123626Snjl
201125366Snjl# Notify all users before beginning emergency shutdown when we get
202125366Snjl# a _CRT or _HOT thermal event and we're going to power down the system
203125366Snjl# very soon.
204125366Snjlnotify 10 {
205125366Snjl	match "system"		"ACPI";
206125366Snjl	match "subsystem"	"Thermal";
207125366Snjl	match "notify"		"0xcc";
208125366Snjl	action "logger -p kern.emerg 'WARNING: system temperature too high, shutting down soon!'";
209125366Snjl};
210125366Snjl
211168495Spjd# Sample ZFS problem reports handling.
212168495Spjdnotify 10 {
213168495Spjd	match "system"		"ZFS";
214168495Spjd	match "type"		"zpool";
215168495Spjd	action "logger -p kern.err 'ZFS: failed to load zpool $pool'";
216168495Spjd};
217168495Spjd
218168495Spjdnotify 10 {
219168495Spjd	match "system"		"ZFS";
220168495Spjd	match "type"		"vdev";
221168497Spjd	action "logger -p kern.err 'ZFS: vdev failure, zpool=$pool type=$type'";
222168495Spjd};
223168495Spjd
224168495Spjdnotify 10 {
225168495Spjd	match "system"		"ZFS";
226168495Spjd	match "type"		"data";
227168495Spjd	action "logger -p kern.warn 'ZFS: zpool I/O failure, zpool=$pool error=$zio_err'";
228168495Spjd};
229168495Spjd
230168495Spjdnotify 10 {
231168495Spjd	match "system"		"ZFS";
232168495Spjd	match "type"		"io";
233168495Spjd	action "logger -p kern.warn 'ZFS: vdev I/O failure, zpool=$pool path=$vdev_path offset=$zio_offset size=$zio_size error=$zio_err'";
234168495Spjd};
235168495Spjd
236168495Spjdnotify 10 {
237168495Spjd	match "system"		"ZFS";
238168495Spjd	match "type"		"checksum";
239168495Spjd	action "logger -p kern.warn 'ZFS: checksum mismatch, zpool=$pool path=$vdev_path offset=$zio_offset size=$zio_size'";
240168495Spjd};
241168495Spjd
242170976Snjl# User requested suspend, so perform preparation steps and then execute
243170976Snjl# the actual suspend process.
244170976Snjlnotify 10 {
245170976Snjl	match "system"		"ACPI";
246170976Snjl	match "subsystem"	"Suspend";
247170976Snjl	action "/etc/rc.suspend acpi $notify";
248170976Snjl};
249170976Snjlnotify 10 {
250170976Snjl	match "system"		"ACPI";
251170976Snjl	match "subsystem"	"Resume";
252170976Snjl	action "/etc/rc.resume acpi $notify";
253170976Snjl};
254170976Snjl
255108983Simp/* EXAMPLES TO END OF FILE
256108983Simp
257108983Simp# The following might be an example of something that a vendor might
258108983Simp# install if you were to add their device.  This might reside in
259108983Simp# /usr/local/etc/devd/deqna.conf.  A deqna is, in this hypothetical
260108983Simp# example, a pccard ethernet-like device.  Students of history may
261108983Simp# know other devices by this name, and will get the in-jokes in this
262108983Simp# entry.
263108983Simpnomatch 10 {
264108983Simp	match "bus" "pccard[0-9]+";
265108983Simp	match "manufacturer" "0x1234";
266108983Simp	match "product" "0x2323";
267108983Simp	action "kldload if_deqna";
268108983Simp};
269108983Simpattach 10 {
270108983Simp	device-name "deqna[0-9]+";
271108983Simp	action "/etc/pccard_ether $device-name start";
272108983Simp};
273108983Simpdetach 10 {
274108983Simp	device-name "deqna[0-9]+";
275108983Simp	action "/etc/pccard_ether $device-name stop";
276108983Simp};
277108983Simp
278121493Snjl# Examples of notify hooks.  A notify is a generic way for a kernel
279121493Snjl# subsystem to send event notification to userland.
280121493Snjl#
281121493Snjl# Here are some examples of ACPI notify handlers.  ACPI subsystems that
282121493Snjl# generate notifies include the AC adapter, power/sleep buttons,
283121493Snjl# control method batteries, lid switch, and thermal zones.
284121493Snjl#
285121493Snjl# Information returned is not always the same as the ACPI notify
286121493Snjl# events.  See the ACPI specification for more information about
287121493Snjl# notifies.  Here is the information returned for each subsystem:
288121493Snjl#
289121493Snjl# ACAD:		AC line state (0 is offline, 1 is online)
290121493Snjl# Button:	Button pressed (0 for power, 1 for sleep)
291121493Snjl# CMBAT:	ACPI battery events
292121493Snjl# Lid:		Lid state (0 is closed, 1 is open)
293170976Snjl# Suspend, Resume: Suspend and resume notification
294121493Snjl# Thermal:	ACPI thermal zone events
295121493Snjl#
296121493Snjl# This example calls a script when the AC state changes, passing the
297121493Snjl# notify value as the first argument.  If the state is 0x00, it might
298121493Snjl# call some sysctls to implement economy mode.  If 0x01, it might set
299121493Snjl# the mode to performance.
300121493Snjlnotify 10 {
301121493Snjl	match "system"		"ACPI";
302121493Snjl	match "subsystem"	"ACAD";
303121493Snjl	action			"/etc/acpi_ac $notify";
304121493Snjl};
305108983Simp*/
306