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