1108983Simp# $FreeBSD$
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 {
11225861Swblock	# Each "directory" directive adds a directory to the list of
12225861Swblock	# directories that we scan for files.  Files are loaded in the order
13225861Swblock	# that they are returned from readdir(3).  The rule-sets are combined
14225861Swblock	# to 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
35225861Swblock#     (routes, arp cache).  Beware of races against immediate create
36225861Swblock#     of a device with the same name; e.g.
37247660Sschweikh#     ifconfig bridge0 destroy; ifconfig bridge0 create
38187743Ssam#
39159126Sthompsanotify 0 {
40159126Sthompsa	match "system"		"IFNET";
41226775Shrs	match "subsystem"	"!usbus[0-9]+";
42159126Sthompsa	match "type"		"ATTACH";
43159126Sthompsa	action "/etc/pccard_ether $subsystem start";
44108983Simp};
45108983Simp
46147088Sbrooks#
47225861Swblock# Try to start dhclient on Ethernet-like interfaces when the link comes
48147088Sbrooks# up.  Only devices that are configured to support DHCP will actually
49216983Sjpaetzel# run it.  No link down rule exists because dhclient automatically 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
91225861Swblock# 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
101215195Semax# Firmware downloader for Atheros AR3011 based USB Bluetooth devices
102215195Semax#attach 100 {
103215195Semax#	match "vendor" "0x0cf3";
104215195Semax#	match "product" "0x3000";
105215195Semax#	action "sleep 2 && /usr/sbin/ath3kfw -d $device-name -f /usr/local/etc/ath3k-1.fw";
106215195Semax#};
107215195Semax
108139281Sbrueffer# When a USB keyboard arrives, attach it as the console keyboard.
109134584Sbrooksattach 100 {
110134584Sbrooks	device-name "ukbd0";
111156782Semax	action "/etc/rc.d/syscons setkeyboard /dev/ukbd0";
112134584Sbrooks};
113134584Sbrooksdetach 100 {
114134584Sbrooks	device-name "ukbd0";
115156331Semax	action "/etc/rc.d/syscons setkeyboard /dev/kbd0";
116134584Sbrooks};
117134584Sbrooks
118240891Shselaskynotify 100 {
119240891Shselasky	match "system" "DEVFS";
120240891Shselasky	match "subsystem" "CDEV";
121240891Shselasky	match "type" "CREATE";
122240891Shselasky	match "cdev" "ums[0-9]+";
123240891Shselasky
124240891Shselasky	action "/etc/rc.d/moused quietstart $cdev";
125138175Siedowse};
126138175Siedowse
127240891Shselaskynotify 100 {
128240891Shselasky	match "system" "DEVFS";
129240891Shselasky	match "subsystem" "CDEV";
130240891Shselasky	match "type" "DESTROY";
131240891Shselasky	match "cdev" "ums[0-9]+";
132240891Shselasky
133240891Shselasky	action "/etc/rc.d/moused stop $cdev";
134208060Sdougb};
135179804Skmacy
136153300Siedowse# Firmware download into the ActiveWire board. After the firmware download is
137225861Swblock# done, the device detaches and reappears as something new and shiny
138153300Siedowse# automatically.
139153300Siedowseattach 100 {
140153300Siedowse	match "vendor"	"0x0854";
141153300Siedowse	match "product"	"0x0100";
142153300Siedowse	match "release"	"0x0000";
143153300Siedowse	action "/usr/local/bin/ezdownload -f /usr/local/share/usb/firmware/0854.0100.0_01.hex $device-name";
144153300Siedowse};
145153300Siedowse
146153300Siedowse# Firmware download for Entrega Serial DB25 adapter.
147153300Siedowseattach 100 {
148153300Siedowse	match "vendor"	"0x1645";
149153300Siedowse	match "product"	"0x8001";
150153300Siedowse	match "release"	"0x0101";
151192198Smaxim	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";
152153300Siedowse};
153153300Siedowse
154153300Siedowse# This entry starts the ColdSync tool in daemon mode. Make sure you have an up
155153300Siedowse# to date /usr/local/etc/palms. We override the 'listen' settings for port and
156153300Siedowse# type in /usr/local/etc/coldsync.conf.
157207020Sthompsanotify 100 {
158207020Sthompsa	match "system"		"USB";
159207020Sthompsa	match "subsystem"	"DEVICE";
160207020Sthompsa	match "type"		"ATTACH";
161207020Sthompsa	match "vendor"		"0x082d";
162207020Sthompsa	match "product"		"0x0100";
163207020Sthompsa	match "release"		"0x0100";
164207020Sthompsa	action "/usr/local/bin/coldsync -md -p /dev/$cdev -t usb";
165153300Siedowse};
166153300Siedowse
167108983Simp#
168247660Sschweikh# Rescan SCSI device-names on attach, but not detach.  However, it is
169148471Simp# disabled by default due to reports of problems.
170108983Simp#
171108983Simpattach 0 {
172108983Simp	device-name "$scsi-controller-regex";
173131646Simp//	action "camcontrol rescan all";
174108983Simp};
175108983Simp
176108983Simp# Don't even try to second guess what to do about drivers that don't
177114799Simp# match here.  Instead, pass it off to syslog.  Commented out for the
178166754Simp# moment, as the pnpinfo variable isn't set in devd yet.  Individual
179166754Simp# variables within the bus supplied pnpinfo are set.
180119254Simpnomatch 0 {
181114852Simp#	action "logger Unknown device: $pnpinfo $location $bus";
182119254Simp};
183108983Simp
184166701Sjoerg# Various logging of unknown devices.
185166701Sjoergnomatch 10 {
186166701Sjoerg	match "bus" "uhub[0-9]+";
187166701Sjoerg	action "logger Unknown USB device: vendor $vendor product $product \
188166701Sjoerg		bus $bus";
189166701Sjoerg};
190166701Sjoerg
191166701Sjoerg# Some PC-CARDs don't offer numerical manufacturer/product IDs, just
192166701Sjoerg# show the CIS info there.
193166701Sjoergnomatch 20 {
194166701Sjoerg	match "bus" "pccard[0-9]+";
195166701Sjoerg	match "manufacturer" "0xffffffff";
196166701Sjoerg	match "product" "0xffffffff";
197166701Sjoerg	action "logger Unknown PCCARD device: CISproduct $cisproduct \
198166701Sjoerg		CIS-vendor $cisvendor bus $bus";
199166701Sjoerg};
200166701Sjoerg
201166701Sjoergnomatch 10 {
202166701Sjoerg	match "bus" "pccard[0-9]+";
203166701Sjoerg	action "logger Unknown PCCARD device: manufacturer $manufacturer \
204166701Sjoerg		product $product CISproduct $cisproduct CIS-vendor \
205166701Sjoerg		$cisvendor bus $bus";
206166701Sjoerg};
207166701Sjoerg
208166701Sjoergnomatch 10 {
209166701Sjoerg	match "bus" "cardbus[0-9]+";
210166701Sjoerg	action "logger Unknown Cardbus device: device $device class $class \
211166701Sjoerg		vendor $vendor bus $bus";
212166701Sjoerg};
213166701Sjoerg
214139281Sbrueffer# Switch power profiles when the AC line state changes.
215123626Snjlnotify 10 {
216123626Snjl	match "system"		"ACPI";
217123626Snjl	match "subsystem"	"ACAD";
218125366Snjl	action "/etc/rc.d/power_profile $notify";
219123626Snjl};
220123626Snjl
221125366Snjl# Notify all users before beginning emergency shutdown when we get
222125366Snjl# a _CRT or _HOT thermal event and we're going to power down the system
223125366Snjl# very soon.
224125366Snjlnotify 10 {
225125366Snjl	match "system"		"ACPI";
226125366Snjl	match "subsystem"	"Thermal";
227125366Snjl	match "notify"		"0xcc";
228125366Snjl	action "logger -p kern.emerg 'WARNING: system temperature too high, shutting down soon!'";
229125366Snjl};
230125366Snjl
231168495Spjd# Sample ZFS problem reports handling.
232168495Spjdnotify 10 {
233168495Spjd	match "system"		"ZFS";
234168495Spjd	match "type"		"zpool";
235168495Spjd	action "logger -p kern.err 'ZFS: failed to load zpool $pool'";
236168495Spjd};
237168495Spjd
238168495Spjdnotify 10 {
239168495Spjd	match "system"		"ZFS";
240168495Spjd	match "type"		"vdev";
241168497Spjd	action "logger -p kern.err 'ZFS: vdev failure, zpool=$pool type=$type'";
242168495Spjd};
243168495Spjd
244168495Spjdnotify 10 {
245168495Spjd	match "system"		"ZFS";
246168495Spjd	match "type"		"data";
247168495Spjd	action "logger -p kern.warn 'ZFS: zpool I/O failure, zpool=$pool error=$zio_err'";
248168495Spjd};
249168495Spjd
250168495Spjdnotify 10 {
251168495Spjd	match "system"		"ZFS";
252168495Spjd	match "type"		"io";
253168495Spjd	action "logger -p kern.warn 'ZFS: vdev I/O failure, zpool=$pool path=$vdev_path offset=$zio_offset size=$zio_size error=$zio_err'";
254168495Spjd};
255168495Spjd
256168495Spjdnotify 10 {
257168495Spjd	match "system"		"ZFS";
258168495Spjd	match "type"		"checksum";
259168495Spjd	action "logger -p kern.warn 'ZFS: checksum mismatch, zpool=$pool path=$vdev_path offset=$zio_offset size=$zio_size'";
260168495Spjd};
261168495Spjd
262170976Snjl# User requested suspend, so perform preparation steps and then execute
263170976Snjl# the actual suspend process.
264170976Snjlnotify 10 {
265170976Snjl	match "system"		"ACPI";
266170976Snjl	match "subsystem"	"Suspend";
267170976Snjl	action "/etc/rc.suspend acpi $notify";
268170976Snjl};
269170976Snjlnotify 10 {
270170976Snjl	match "system"		"ACPI";
271170976Snjl	match "subsystem"	"Resume";
272170976Snjl	action "/etc/rc.resume acpi $notify";
273170976Snjl};
274170976Snjl
275108983Simp/* EXAMPLES TO END OF FILE
276108983Simp
277225861Swblock# An example of something that a vendor might install if you were to
278225861Swblock# add their device.  This might reside in /usr/local/etc/devd/deqna.conf.
279225861Swblock# A deqna is, in this hypothetical example, a pccard ethernet-like device.
280225861Swblock# Students of history may know other devices by this name, and will get
281225861Swblock# the in-jokes in this entry.
282108983Simpnomatch 10 {
283108983Simp	match "bus" "pccard[0-9]+";
284108983Simp	match "manufacturer" "0x1234";
285108983Simp	match "product" "0x2323";
286108983Simp	action "kldload if_deqna";
287108983Simp};
288108983Simpattach 10 {
289108983Simp	device-name "deqna[0-9]+";
290108983Simp	action "/etc/pccard_ether $device-name start";
291108983Simp};
292108983Simpdetach 10 {
293108983Simp	device-name "deqna[0-9]+";
294108983Simp	action "/etc/pccard_ether $device-name stop";
295108983Simp};
296108983Simp
297121493Snjl# Examples of notify hooks.  A notify is a generic way for a kernel
298121493Snjl# subsystem to send event notification to userland.
299225861Swblock
300121493Snjl# Here are some examples of ACPI notify handlers.  ACPI subsystems that
301121493Snjl# generate notifies include the AC adapter, power/sleep buttons,
302121493Snjl# control method batteries, lid switch, and thermal zones.
303121493Snjl#
304121493Snjl# Information returned is not always the same as the ACPI notify
305121493Snjl# events.  See the ACPI specification for more information about
306121493Snjl# notifies.  Here is the information returned for each subsystem:
307121493Snjl#
308247660Sschweikh# ACAD:            AC line state (0 is offline, 1 is online)
309247660Sschweikh# Button:          Button pressed (0 for power, 1 for sleep)
310247660Sschweikh# CMBAT:           ACPI battery events
311247660Sschweikh# Lid:             Lid state (0 is closed, 1 is open)
312247660Sschweikh# RCTL:            Resource limits
313170976Snjl# Suspend, Resume: Suspend and resume notification
314247660Sschweikh# Thermal:         ACPI thermal zone events
315121493Snjl#
316121493Snjl# This example calls a script when the AC state changes, passing the
317121493Snjl# notify value as the first argument.  If the state is 0x00, it might
318121493Snjl# call some sysctls to implement economy mode.  If 0x01, it might set
319121493Snjl# the mode to performance.
320121493Snjlnotify 10 {
321121493Snjl	match "system"		"ACPI";
322121493Snjl	match "subsystem"	"ACAD";
323121493Snjl	action			"/etc/acpi_ac $notify";
324121493Snjl};
325220168Strasz
326220168Strasz# This example works around a memory leak in PostgreSQL, restarting
327225861Swblock# it when the "user:pgsql:swap:devctl=1G" rctl(8) rule gets triggered.
328220168Strasznotify 0 {
329220168Strasz	match "system"		"RCTL";
330220168Strasz	match "rule"		"user:70:swap:.*";
331238308Shrs	action			"/usr/local/etc/rc.d/postgresql restart";
332220168Strasz};
333220168Strasz
334108983Simp*/
335