]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sbin/devd/devd.conf.5
GEOM::rotation_rate changes are also signaled via devctl.
[FreeBSD/FreeBSD.git] / sbin / devd / devd.conf.5
1 .\"
2 .\" Copyright (c) 2002 M. Warner Losh <imp@FreeBSD.org>
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. The name of the author may not be used to endorse or promote products
10 .\"    derived from this software without specific prior written permission.
11 .\"
12 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
13 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
14 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
15 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
16 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
17 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
18 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
19 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
20 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
21 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
22 .\" SUCH DAMAGE.
23 .\"
24 .\" $FreeBSD$
25 .\"
26 .\" The section on comments was taken from named.conf.5, which has the
27 .\" following copyright:
28 .\" Copyright (c) 1999-2000 by Internet Software Consortium
29 .\"
30 .\" Permission to use, copy, modify, and distribute this software for any
31 .\" purpose with or without fee is hereby granted, provided that the above
32 .\" copyright notice and this permission notice appear in all copies.
33 .\"
34 .\" THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
35 .\" ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
36 .\" OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
37 .\" CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
38 .\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
39 .\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
40 .\" ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
41 .\" SOFTWARE.
42 .\"
43 .Dd August 18, 2020
44 .Dt DEVD.CONF 5
45 .Os
46 .Sh NAME
47 .Nm devd.conf
48 .Nd configuration file for
49 .Xr devd 8
50 .Sh DESCRIPTION
51 .Ss General Syntax
52 A
53 .Xr devd 8
54 configuration consists of two general features, statements
55 and comments.
56 All statements end with a semicolon.
57 Many statements can contain substatements, which are also
58 terminated with a semicolon.
59 .Pp
60 The following statements are supported:
61 .Bl -tag -width ".Ic options"
62 .It Ic attach
63 Specifies various matching criteria and actions to perform when
64 a newly attached device matches said criteria.
65 .It Ic detach
66 Specifies various matching criteria and actions to perform when
67 a newly detached device matches said criteria.
68 .It Ic nomatch
69 Specifies various matching criteria and actions to perform when
70 no device driver currently loaded in the kernel claims a (new)
71 device.
72 .It Ic notify
73 Specifies various matching criteria and actions to perform when the kernel
74 sends an event notification to userland.
75 .It Ic options
76 Specifies various options and parameters for the operation of
77 .Xr devd 8 .
78 .El
79 .Pp
80 Statements may occur in any order in the configuration file, and may be
81 repeated as often as required.
82 Further details on the syntax and meaning of each statement and their
83 substatements are explained below.
84 .Pp
85 Each statement, except
86 .Ic options
87 has a priority (an arbitrary number) associated with it, where
88 .Ql 0
89 is defined as the lowest priority.
90 If two statements match the same event, only the action of the statement with
91 highest priority will be executed.
92 In this way generic statements can be overridden for devices or
93 notifications that require special attention.
94 .Pp
95 The general syntax of a statement is:
96 .Bd -literal -offset indent
97 statement priority {
98         substatement "value";
99         ...
100         substatement "value";
101 };
102 .Ed
103 .Ss Sub-statements
104 The following sub-statements are supported within the
105 .Ic options
106 statement.
107 .Bl -tag -width ".Ic directory"
108 .It Ic directory Qq Ar /some/path ;
109 Adds the given directory to the list of directories from which
110 .Xr devd 8
111 will read all files named "*.conf" as further
112 configuration files.
113 Any number of
114 .Ic directory
115 statements can be used.
116 .It Ic pid-file Qq Pa /var/run/devd.pid ;
117 Specifies PID file.
118 .It Ic set Ar regexp-name Qq Ar (some|regexp) ;
119 Creates a regular expression and assigns it to the variable
120 .Ar regexp-name .
121 The variable is available throughout the rest of
122 the configuration file.
123 If the string begins with
124 .Ql \&! ,
125 it matches if the regular expression formed by the rest of the string
126 does not match.
127 All regular expressions have an implicit
128 .Ql ^$
129 around them.
130 .El
131 .Pp
132 The following sub-statements are supported within the
133 .Ic attach
134 and
135 .Ic detach
136 statements.
137 .Bl -tag -width ".Ic directory"
138 .It Ic action Qq Ar command ;
139 Command to execute upon a successful match.
140 Example
141 .Dq Li "/etc/pccard_ether $device-name start" .
142 .It Ic class Qq Ar string ;
143 This is shorthand for
144 .Dq Ic match Qo Li class Qc Qq Ar string .
145 .It Ic device-name Qq string ;
146 This is shorthand for
147 .Dq Ic match Qo Li device-name Qc Qq Ar string .
148 This matches a device named
149 .Ar string ,
150 which is allowed to be a regular expression or a variable previously created
151 containing a regular expression.
152 The
153 .Dq Li device-name
154 variable
155 is available for later use with the
156 .Ic action
157 statement.
158 .It Ic match Qo Ar variable Qc Qq Ar value ;
159 Matches the content of
160 .Ar value
161 against
162 .Ar variable ;
163 the content of
164 .Ar value
165 may be a regular expression.
166 Not required during
167 .Ic attach
168 nor
169 .Ic detach
170 events since the
171 .Ic device-name
172 statement takes care of all device matching.
173 For a partial list of variables, see below.
174 .It Ic media-type Qq Ar string ;
175 For network devices,
176 .Ic media-type
177 will match devices that have the given media type.
178 Valid media types are:
179 .Dq Li Ethernet ,
180 .Dq Li Tokenring ,
181 .Dq Li FDDI ,
182 .Dq Li 802.11 ,
183 and
184 .Dq Li ATM .
185 .It Ic subdevice Qq Ar string ;
186 This is shorthand for
187 .Dq Ic match Qo Li subdevice Qc Qq Ar string .
188 .El
189 .Pp
190 The following sub-statements are supported within the
191 .Ic nomatch
192 statement.
193 .Bl -tag -width ".Ic directory"
194 .It Ic action Qq Ar command ;
195 Same as above.
196 .It Ic match Qo Ar variable Qc Qq Ar value ;
197 Matches the content of
198 .Ar value
199 against
200 .Ar variable ;
201 the content of
202 .Ar value
203 may be a regular expression.
204 For a partial list of variables, see below.
205 .El
206 .Pp
207 The following sub-statements are supported within the
208 .Ic notify
209 statement.
210 The
211 .Dq Li notify
212 variable is available inside this statement and contains, a value, depending
213 on which system and subsystem that delivered the event.
214 .Bl -tag -width ".Ic directory"
215 .It Ic action Qq Ar command ;
216 Command to execute upon a successful match.
217 Example
218 .Dq Li "/etc/rc.d/power_profile $notify" .
219 .It Ic match Qo Ar system | subsystem | type | notify Qc Qq Ar value ;
220 Any number of
221 .Ic match
222 statements can exist within a
223 .Ic notify
224 statement;
225 .Ar value
226 can be either a fixed string or a regular expression.
227 Below is a list of available systems, subsystems, and types.
228 .It Ic media-type Qq Ar string ;
229 See above.
230 .El
231 .Ss Variables that can be used with the match statement
232 A partial list of variables and their possible values that can be used together
233 with the
234 .Ic match
235 statement.
236 The variables are published by the bus based on characteristics of the device
237 that generated the event (for device events).
238 Variables for other classes of events are dependent on those events.
239 .Pp
240 .Bl -tag -width ".Li manufacturer" -compact
241 .It Ic Variable
242 .Ic Description
243 .It Li *
244 The entire message from the current event.
245 .It Li _
246 The entire message from the current event, after the initial type character.
247 .It Li timestamp
248 The time this event was processed, in seconds since 1970 dot fraction.
249 .It Li bus
250 Device name of parent bus.
251 .It Li cdev
252 Device node path if one is created by the
253 .Xr devfs 5
254 filesystem.
255 .It Li class
256 Device class.
257 .It Li comm
258 Executable name (kernel).
259 .It Li core
260 Path to core file (kernel).
261 .It Li device
262 Device ID.
263 .It Li devclass
264 Device Class (USB).
265 .It Li devsubclass
266 Device Sub-class (USB).
267 .It Li device-name
268 Name of attached/detached device.
269 .It Li endpoints
270 Endpoint count (USB).
271 .It Li function
272 Card functions.
273 .It Li interface
274 Interface ID (USB).
275 .It Li intclass
276 Interface Class (USB).
277 .It Li intprotocol
278 Interface Protocol (USB).
279 .It Li intsubclass
280 Interface Sub-class (USB).
281 .It Li jail
282 Jail name for the process triggering the rule (RCTL).
283 .It Li mode
284 Peripheral mode (USB).
285 .It Li notify
286 Match the value of the
287 .Dq Li notify
288 variable.
289 .It Li parent
290 Parent device.
291 .It Li pid
292 PID of the process triggering the rule (RCTL).
293 .It Li port
294 Hub port number (USB).
295 .It Li product
296 Product ID (USB).
297 .It Li release
298 Hardware revision (USB).
299 .It Li ruid
300 Real UID of the process triggering the rule (RCTL).
301 .It Li rule
302 Rule (RCTL).
303 .It Li sernum
304 Serial Number (USB).
305 .It Li slot
306 Card slot.
307 .It Li subvendor
308 Sub-vendor ID (PCI).
309 .It Li subdevice
310 Sub-device ID (PCI).
311 .It Li subsystem
312 Matches a subsystem of a system, see below.
313 .It Li system
314 Matches a system type, see below.
315 .It Li type
316 Type of notification, see below.
317 .It Li vendor
318 Vendor ID.
319 .El
320 .Ss Notify matching
321 A partial list of systems, subsystems, and types used within the
322 .Ic notify
323 mechanism.
324 .\"
325 .\" Please keep these tables sorted. Also, please use the same parameters
326 .\" for each of the tables so that things line up in columns nicely.
327 .\" Please do not omit the type column for notifiers that omit it.
328 .Pp
329 .Bl -column "System" "Subsystem" "1234567" -compact
330 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
331 .It Li ACPI Ta Ta Ta
332 Events related to the ACPI Sybsystem.
333 .It Li ACPI Ta Li ACAD Ta Ta
334 AC line state ($notify=0x00 is offline, 0x01 is online).
335 .It Li ACPI Ta Li Button Ta Ta
336 Button state ($notify=0x00 is power, 0x01 is sleep).
337 .It Li ACPI Ta Li CMBAT Ta Ta
338 Battery events.
339 .It Li ACPI Ta Li Dock Ta Ta
340 Dock state ($notify=0x00 is undocked, 0x01 is docked).
341 .It Li ACPI Ta Li Lid Ta Ta
342 Lid state ($notify=0x00 is closed, 0x01 is open).
343 .It Li ACPI Ta Li PROCESSOR Ta Ta
344 Processor state/configuration ($notify=0x81 is a change in available Cx states).
345 .It Li ACPI Ta Li Resume Ta Ta
346 Resume notification.
347 .It Li ACPI Ta Li Suspend Ta Ta
348 Suspend notification.
349 .It Li ACPI Ta Li Thermal Ta Ta
350 Thermal zone events.
351 .El
352 .Pp
353 .Bl -column "System" "Subsystem" "1234567" -compact
354 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
355 .It Li CAM Ta Ta Ta
356 Events related to the
357 .Xr cam 4
358 system.
359 .It Li CAM Ta Li periph Ta Ta
360 Events related to peripheral devices.
361 .It Li CAM Ta Li periph Ta Li error Ta
362 Generic errors.
363 .It Li CAM Ta Li periph Ta Li timeout Ta
364 Command timeouts.
365 .El
366 .Pp
367 .Bl -column "System" "Subsystem" "1234567" -compact
368 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
369 .It Li CARP Ta Ta Ta
370 Events related to the
371 .Xr carp 4
372 protocol.
373 .It CARP Ta Ar vhid@inet Ta Ta
374 The
375 .Dq subsystem
376 contains the actual CARP vhid and the name of the network interface
377 on which the event took place.
378 .It CARP Ta Ar vhid@inet Ta MASTER Ta
379 Node become the master for a virtual host.
380 .It CARP Ta Ar vhid@inet Ta BACKUP Ta
381 Node become the backup for a virtual host.
382 .El
383 .Pp
384 .Bl -column "System" "Subsystem" "1234567" -compact
385 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
386 .It Li coretemp Ta Ta Ta
387 Events related to the
388 .Xr coretemp 4
389 device.
390 .It Li coretemp Ta Li Thermal Ta Ta
391 Notification that the CPU core has reached critical temperature.
392 .It Li coretemp Ta Li Thermal Ta Li temperature Ta
393 String containing the temperature of the core that has become too hot.
394 .El
395 .Pp
396 .Bl -column "System" "Subsystem" "1234567" -compact
397 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
398 .It Li IFNET
399 .It Li IFNET Ta Ar inet Ta Ta
400 The
401 .Dq subsystem
402 is the actual name of the network interface on which the event
403 took place.
404 .It Li IFNET Ta Ar inet Ta Li LINK_UP Ta
405 Carrier status changed to UP.
406 .It Li IFNET Ta Ar inet Ta Li LINK_DOWN Ta
407 Carrier status changed to DOWN.
408 .It Li IFNET Ta Ar inet Ta Li ATTACH Ta
409 The network interface is attached to the system.
410 .It Li IFNET Ta Ar inet Ta Li DETACH Ta
411 The network interface is detached from the system.
412 .El
413 .Pp
414 .Bl -column "System" "Subsystem" "1234567" -compact
415 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
416 .It Li DEVFS
417 .It Li DEVFS Ta Li CDEV Ta Li CREATE Ta
418 The
419 .Xr devfs 5
420 node is created.
421 .It Li DEVFS Ta Li CDEV Ta Li DESTROY Ta
422 The
423 .Xr devfs 5
424 node is destroyed.
425 .El
426 .Pp
427 .Bl -column "System" "Subsystem" "1234567" -compact
428 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
429 .It Li GEOM Ta Ta Ta
430 Events related to the
431 .Xr geom 4
432 framework.
433 The difference compared to
434 .Li DEVFS
435 is that
436 .Li GEOM
437 only includes disk-like devices.
438 .It Li GEOM Ta Li DEV Ta Li CREATE Ta
439 A
440 .Xr geom 4
441 provider is created.
442 .It Li GEOM Ta Li DEV Ta Li DESTROY Ta
443 A
444 .Xr geom 4
445 provider is destroyed.
446 .It Li GEOM Ta Li DEV Ta Li GEOM::physpath Ta
447 The physical path of a device has changed.
448 .It Li GEOM Ta Li DEV Ta Li GEOM::rotation_rate Ta
449 The roation rate of the disk has changed.
450 .It Li GEOM Ta Li DEV Ta Li MEDIACHANGE Ta
451 Physical media has changed.
452 .It Li GEOM Ta Li DEV Ta Li SIZECHANGE Ta
453 A
454 .Xr geom 4
455 provider size has changed.
456 .El
457 .Pp
458 .Bl -column "System" "Subsystem" "1234567" -compact
459 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
460 .It Li kern Ta Li power Ta Li resume Ta
461 Notification that the system has woken from the suspended state.
462 .El
463 .Pp
464 .Pp
465 .Bl -column "System" "Subsystem" "1234567" -compact
466 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
467 .It Li kernel Ta Li signal Ta Li coredump Ta
468 Notification that a process has crashed and dumped core.
469 .El
470 .Pp
471 .Bl -column "System" "Subsystem" "1234567" -compact
472 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
473 .It Li RCTL Ta Ta Ta
474 Events related to the
475 .Xr rctl 8
476 framework.
477 .It Li RCTL Ta Li rule Ta Li matched Ta
478 A rule with action specified as "devctl" was triggered.
479 .El
480 .Pp
481 .Bl -column "System" "Subsystem" "1234567" -compact
482 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
483 .It Li USB Ta Ta Ta
484 Events related to the USB subsystem.
485 .It Li USB Ta Li DEVICE Ta Li ATTACH Ta
486 USB device is attached to the system.
487 .It Li USB Ta Li DEVICE Ta Li DETACH Ta
488 USB device is detached to the system.
489 .It Li USB Ta Li INTERFACE Ta Li ATTACH Ta
490 USB interface is attached to a device.
491 .It Li USB Ta Li INTERFACE Ta Li DETACH Ta
492 USB interface is detached from a device.
493 .El
494 .Pp
495
496 .\"
497 .\" End of tables
498 .\"
499 A link state change to UP on the interface
500 .Dq Li fxp0
501 would result in the following notify event:
502 .Bd -literal -offset indent
503 system=IFNET subsystem=fxp0 type=LINK_UP
504 .Ed
505 .Pp
506 An AC line state change to
507 .Dq offline
508 would result in the following event:
509 .Bd -literal -offset indent
510 system=ACPI subsystem=ACAD notify=0x00
511 .Ed
512 .Ss Comments
513 Comments may appear anywhere that whitespace may appear in a
514 configuration file.
515 To appeal to programmers of all kinds, they can
516 be written in C, C++, or shell/Perl constructs.
517 .Pp
518 C-style comments start with the two characters
519 .Ql /*
520 (slash, star) and end with
521 .Ql */
522 (star, slash).
523 Because they are completely delimited with these characters,
524 they can be used to comment only a portion of a line or to span
525 multiple lines.
526 .Pp
527 C-style comments cannot be nested.
528 For example, the following is
529 not valid because the entire comment ends with the first
530 .Ql */ :
531 .Bd -literal -offset indent
532 /* This is the start of a comment.
533    This is still part of the comment.
534 /* This is an incorrect attempt at nesting a comment. */
535    This is no longer in any comment. */
536 .Ed
537 .Pp
538 C++-style comments start with the two characters
539 .Ql //
540 (slash, slash) and continue to the end of the physical line.
541 They cannot be continued across multiple physical lines; to have
542 one logical comment span multiple lines, each line must use the
543 .Ql //
544 pair.
545 For example:
546 .Bd -literal -offset indent
547 // This is the start of a comment.  The next line
548 // is a new comment, even though it is logically
549 // part of the previous comment.
550 .Ed
551 .Sh FILES
552 .Bl -tag -width ".Pa /etc/devd.conf" -compact
553 .It Pa /etc/devd.conf
554 The
555 .Xr devd 8
556 configuration file.
557 .El
558 .Sh EXAMPLES
559 .Bd -literal
560 #
561 # This will catch link down events on the interfaces fxp0 and ath0
562 #
563 notify 0 {
564         match "system"                  "IFNET";
565         match "subsystem"               "(fxp0|ath0)";
566         match "type"                    "LINK_DOWN";
567         action "logger $subsystem is DOWN";
568 };
569
570 #
571 # Match lid open/close events
572 # These can be combined to a single event, by passing the
573 # value of $notify to the external script.
574 #
575 notify 0 {
576         match "system"                  "ACPI";
577         match "subsystem"               "Lid";
578         match "notify"                  "0x00";
579         action "logger Lid closed, we can sleep now!";
580 };
581
582 notify 0 {
583         match "system"                  "ACPI";
584         match "subsystem"               "Lid";
585         match "notify"                  "0x01";
586         action "logger Lid opened, the sleeper must awaken!";
587 };
588
589 #
590 # Match a USB device type
591 #
592 notify 0 {
593         match "system"                  "USB";
594         match "subsystem"               "INTERFACE";
595         match "type"                    "ATTACH";
596         match "intclass"                "0x0e";
597         action "logger USB video device attached";
598 };
599
600 #
601 # Try to configure ath and iwn devices with pccard_ether
602 # as they are attached.
603 #
604 attach 0 {
605         device-name "(ath|iwn)[0-9]+";
606         action "/etc/pccard_ether $device-name start";
607 };
608
609 #
610 # Stop ath and iwn devices as they are detached from
611 # the system.
612 #
613 detach 0 {
614         device-name "(ath|iwn)[0-9]+";
615         action "/etc/pccard_ether $device-name stop";
616 };
617 .Ed
618 .Pp
619 The installed
620 .Pa /etc/devd.conf
621 has many additional examples.
622 .Sh SEE ALSO
623 .Xr cam 4 ,
624 .Xr coretemp 4 ,
625 .Xr devfs 5 ,
626 .Xr re_format 7 ,
627 .Xr devd 8