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: head/sbin/devd/devd.conf.5 247134 2013-02-21 21:35:09Z pluknet $ 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 May 4, 2015 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.Bd -literal -offset indent 98statement priority { 99 substatement "value"; 100 ... 101 substatement "value"; 102}; 103.Ed 104.Ss Sub-statements 105The following sub-statements are supported within the 106.Ic options 107statement. 108.Bl -tag -width ".Ic directory" 109.It Ic directory Qq Ar /some/path ; 110Adds the given directory to the list of directories from which 111.Xr devd 8 112will read all files named "*.conf" as further 113configuration files. 114Any number of 115.Ic directory 116statements can be used. 117.It Ic pid-file Qq Pa /var/run/devd.pid ; 118Specifies PID file. 119.It Ic set Ar regexp-name Qq Ar (some|regexp) ; 120Creates a regular expression and assigns it to the variable 121.Ar regexp-name . 122The variable is available throughout the rest of 123the configuration file. 124If the string begins with 125.Ql \&! , 126it matches if the regular expression formed by the rest of the string 127does not match. 128All regular expressions have an implicit 129.Ql ^$ 130around them. 131.El 132.Pp 133The following sub-statements are supported within the 134.Ic attach 135and 136.Ic detach 137statements. 138.Bl -tag -width ".Ic directory" 139.It Ic action Qq Ar command ; 140Command to execute upon a successful match. 141Example 142.Dq Li "/etc/pccard_ether $device-name start" . 143.It Ic class Qq Ar string ; 144This is shorthand for 145.Dq Ic match Qo Li class Qc Qq Ar string . 146.It Ic device-name Qq string ; 147This is shorthand for 148.Dq Ic match Qo Li device-name Qc Qq Ar string . 149This matches a device named 150.Ar string , 151which is allowed to be a regular expression or a variable previously created 152containing a regular expression. 153The 154.Dq Li device-name 155variable 156is available for later use with the 157.Ic action 158statement. 159.It Ic match Qo Ar variable Qc Qq Ar value ; 160Matches the content of 161.Ar value 162against 163.Ar variable ; 164the content of 165.Ar value 166may be a regular expression. 167Not required during 168.Ic attach 169nor 170.Ic detach 171events since the 172.Ic device-name 173statement takes care of all device matching. 174For a partial list of variables, see below. 175.It Ic media-type Qq Ar string ; 176For network devices, 177.Ic media-type 178will match devices that have the given media type. 179Valid media types are: 180.Dq Li Ethernet , 181.Dq Li Tokenring , 182.Dq Li FDDI , 183.Dq Li 802.11 , 184and 185.Dq Li ATM . 186.It Ic subdevice Qq Ar string ; 187This is shorthand for 188.Dq Ic match Qo Li subdevice Qc Qq Ar string . 189.El 190.Pp 191The following sub-statements are supported within the 192.Ic nomatch 193statement. 194.Bl -tag -width ".Ic directory" 195.It Ic action Qq Ar command ; 196Same as above. 197.It Ic match Qo Ar variable Qc Qq Ar value ; 198Matches the content of 199.Ar value 200against 201.Ar variable ; 202the content of 203.Ar value 204may be a regular expression. 205For a partial list of variables, see below. 206.El 207.Pp 208The following sub-statements are supported within the 209.Ic notify 210statement. 211The 212.Dq Li notify 213variable is available inside this statement and contains, a value, depending 214on which system and subsystem that delivered the event. 215.Bl -tag -width ".Ic directory" 216.It Ic action Qq Ar command ; 217Command to execute upon a successful match. 218Example 219.Dq Li "/etc/rc.d/power_profile $notify" . 220.It Ic match Qo Ar system | subsystem | type | notify Qc Qq Ar value ; 221Any number of 222.Ic match 223statements can exist within a 224.Ic notify 225statement; 226.Ar value 227can be either a fixed string or a regular expression. 228Below is a list of available systems, subsystems, and types. 229.It Ic media-type Qq Ar string ; 230See above. 231.El 232.Ss Variables that can be used with the match statement 233A partial list of variables and their possible values that can be used together 234with the 235.Ic match 236statement. 237.Pp 238.Bl -tag -width ".Li manufacturer" -compact 239.It Ic Variable 240.Ic Description 241.It Li bus 242Device name of parent bus. 243.It Li cdev 244Device node path if one is created by the 245.Xr devfs 5 246filesystem. 247.It Li channel 248Channel of the DIMM (memtemp). 249.It Li cisproduct 250CIS-product. 251.It Li cisvendor 252CIS-vendor. 253.It Li class 254Device class. 255.It Li core 256CPU core (coretemp). 257.It Li device 258Device ID. 259.It Li devclass 260Device Class (USB) 261.It Li devsubclass 262Device Sub-class (USB) 263.It Li device-name 264Name of attached/detached device. 265.It Li dimm 266DIMM id within the channel and node (memtemp). 267.It Li endpoints 268Endpoint count (USB) 269.It Li function 270Card functions. 271.It Li interface 272Interface ID (USB) 273.It Li intclass 274Interface Class (USB) 275.It Li intprotocol 276Interface Protocol (USB) 277.It Li intsubclass 278Interface Sub-class (USB) 279.It Li manufacturer 280Manufacturer ID (pccard). 281.It Li mode 282Peripheral mode (USB) 283.It Li notify 284Match the value of the 285.Dq Li notify 286variable. 287.It Li node 288CPU node (coretemp/memtemp). 289.It Li parent 290Parent device 291.It Li port 292Hub port number (USB) 293.It Li product 294Product ID (pccard/USB). 295.It Li release 296Hardware revision (USB) 297.It Li sernum 298Serial Number (USB). 299.It Li slot 300Card slot. 301.It Li subvendor 302Sub-vendor ID. 303.It Li subdevice 304Sub-device ID. 305.It Li subsystem 306Matches a subsystem of a system, see below. 307.It Li system 308Matches a system type, see below. 309.It Li type 310Type of notification, see below. 311.It Li vendor 312Vendor ID. 313.El 314.Ss Notify matching 315A partial list of systems, subsystems, and types used within the 316.Ic notify 317mechanism. 318.Pp 319.Bl -tag -width ".Li coretemp" -compact 320.It Sy System 321.It Li ACPI 322Events related to the ACPI subsystem. 323.Bl -tag -width ".Sy Subsystem" -compact 324.It Sy Subsystem 325.It Li ACAD 326AC line state ($notify=0x00 is offline, 0x01 is online). 327.It Li Button 328Button state ($notify=0x00 is power, 0x01 is sleep). 329.It Li CMBAT 330Battery events. 331.It Li Lid 332Lid state ($notify=0x00 is closed, 0x01 is open). 333.It Li PROCESSOR 334Processor state/configuration ($notify=0x81 is a change in available Cx states). 335.It Li Thermal 336Thermal zone events. 337.El 338.Pp 339.It Li IFNET 340Events related to the network subsystem. 341.Bl -tag -width ".Sy Subsystem" -compact 342.It Sy Subsystem 343.It Ar interface 344The 345.Dq subsystem 346is the actual name of the network interface on which the event 347took place. 348.Bl -tag -width ".Li LINK_DOWN" -compact 349.It Sy Type 350.It Li LINK_UP 351Carrier status changed to UP. 352.It Li LINK_DOWN 353Carrier status changed to DOWN. 354.It Li ATTACH 355The network interface is attached to the system. 356.It Li DETACH 357The network interface is detached from the system. 358.El 359.El 360.Pp 361.It Li DEVFS 362Events related to the 363.Xr devfs 5 364filesystem. 365.Bl -tag -width ".Sy Subsystem" -compact 366.It Sy Subsystem 367.It Li CDEV 368.Bl -tag -width ".Li DESTROY" -compact 369.It Sy Type 370.It Li CREATE 371The 372.Xr devfs 5 373node is created. 374.It Li DESTROY 375The 376.Xr devfs 5 377node is destroyed. 378.El 379.El 380.Pp 381.It Li USB 382Events related to the USB subsystem. 383.Bl -tag -width ".Sy Subsystem" -compact 384.It Sy Subsystem 385.It Li DEVICE 386.Bl -tag -width ".Li DETACH" -compact 387.It Sy Type 388.It Li ATTACH 389USB device is attached to the system. 390.It Li DETACH 391USB device is detached from the system. 392.El 393.It Li INTERFACE 394.Bl -tag -width ".Li DETACH" -compact 395.It Sy Type 396.It Li ATTACH 397USB interface is attached to a device. 398.It Li DETACH 399USB interface is detached from a device. 400.El 401.El 402.Pp 403.It Li coretemp 404Events related to the 405.Xr coretemp 4 406device. 407.Bl -tag -width ".Sy Subsystem" -compact 408.It Sy Subsystem 409.It Li Thermal 410Notification that the CPU core has reached critical temperature. 411.Bl -tag -width ".Ar temperature" -compact 412.It Sy Type 413.It Ar temperature 414String containing the temperature of the core that has become too hot. 415.El 416.El 417.It Li memtemp 418Events related to the 419.Xr memtemp 4 420device. 421.Bl -tag -width ".Sy Subsystem" -compact 422.It Sy Subsystem 423.It Li Thermal 424Notification that the DIMM has reached critical temperature. 425.Bl -tag -width ".Ar temperature" -compact 426.It Sy Type 427.It Ar temperature 428String containing the temperature of the DIMM that has become too hot. 429.El 430.El 431.Pp 432.It Li kern 433Events related to the kernel. 434.Bl -tag -width ".Sy Subsystem" -compact 435.It Sy Subsystem 436.It Li power 437Information about the state of the system. 438.Bl -tag -width ".li resume" -compact 439.It Sy Type 440.It Li resume 441Notification that the system has woken from the suspended state. 442.El 443.El 444.El 445.Pp 446A link state change to UP on the interface 447.Dq Li fxp0 448would result in the following notify event: 449.Bd -literal -offset indent 450system=IFNET, subsystem=fxp0, type=LINK_UP 451.Ed 452.Pp 453An AC line state change to 454.Dq offline 455would result in the following event: 456.Bd -literal -offset indent 457system=ACPI, subsystem=ACAD, notify=0x00 458.Ed 459.Ss Comments 460Comments may appear anywhere that whitespace may appear in a 461configuration file. 462To appeal to programmers of all kinds, they can 463be written in C, C++, or shell/Perl constructs. 464.Pp 465C-style comments start with the two characters 466.Ql /* 467(slash, star) and end with 468.Ql */ 469(star, slash). 470Because they are completely delimited with these characters, 471they can be used to comment only a portion of a line or to span 472multiple lines. 473.Pp 474C-style comments cannot be nested. 475For example, the following is 476not valid because the entire comment ends with the first 477.Ql */ : 478.Bd -literal -offset indent 479/* This is the start of a comment. 480 This is still part of the comment. 481/* This is an incorrect attempt at nesting a comment. */ 482 This is no longer in any comment. */ 483.Ed 484.Pp 485C++-style comments start with the two characters 486.Ql // 487(slash, slash) and continue to the end of the physical line. 488They cannot be continued across multiple physical lines; to have 489one logical comment span multiple lines, each line must use the 490.Ql // 491pair. 492For example: 493.Bd -literal -offset indent 494// This is the start of a comment. The next line 495// is a new comment, even though it is logically 496// part of the previous comment. 497.Ed 498.Sh FILES 499.Bl -tag -width ".Pa /etc/devd.conf" -compact 500.It Pa /etc/devd.conf 501The 502.Xr devd 8 503configuration file. 504.El 505.Sh EXAMPLES 506.Bd -literal 507# 508# This will catch link down events on the interfaces fxp0 and ath0 509# 510notify 0 { 511 match "system" "IFNET"; 512 match "subsystem" "(fxp0|ath0)"; 513 match "type" "LINK_DOWN"; 514 action "logger $subsystem is DOWN"; 515}; 516 517# 518# Match lid open/close events 519# These can be combined to a single event, by passing the 520# value of $notify to the external script. 521# 522notify 0 { 523 match "system" "ACPI"; 524 match "subsystem" "Lid"; 525 match "notify" "0x00"; 526 action "logger Lid closed, we can sleep now!"; 527}; 528 529notify 0 { 530 match "system" "ACPI"; 531 match "subsystem" "Lid"; 532 match "notify" "0x01"; 533 action "logger Lid opened, the sleeper must awaken!"; 534}; 535 536# 537# Match a USB device type 538# 539notify 0 { 540 match "system" "USB"; 541 match "subsystem" "INTERFACE"; 542 match "type" "ATTACH"; 543 match "intclass" "0x0e"; 544 action "logger USB video device attached"; 545}; 546 547# 548# Try to configure ath and wi devices with pccard_ether 549# as they are attached. 550# 551attach 0 { 552 device-name "(ath|wi)[0-9]+"; 553 action "/etc/pccard_ether $device-name start"; 554}; 555 556# 557# Stop ath and wi devices as they are detached from 558# the system. 559# 560detach 0 { 561 device-name "(ath|wi)[0-9]+"; 562 action "/etc/pccard_ether $device-name stop"; 563}; 564.Ed 565.Pp 566The installed 567.Pa /etc/devd.conf 568has many additional examples. 569.Sh SEE ALSO 570.Xr coretemp 4 , 571.Xr memtemp 4 , 572.Xr devfs 5 , 573.Xr re_format 7 , 574.Xr devd 8 575