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 July 11, 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 cisproduct 248CIS-product. 249.It Li cisvendor 250CIS-vendor. 251.It Li class 252Device class. 253.It Li device 254Device ID. 255.It Li devclass 256Device Class (USB) 257.It Li devsubclass 258Device Sub-class (USB) 259.It Li device-name 260Name of attached/detached device. 261.It Li endpoints 262Endpoint count (USB) 263.It Li function 264Card functions. 265.It Li interface 266Interface ID (USB) 267.It Li intclass 268Interface Class (USB) 269.It Li intprotocol 270Interface Protocol (USB) 271.It Li intsubclass 272Interface Sub-class (USB) 273.It Li jail 274Jail name for the process triggering the rule (RCTL) 275.It Li manufacturer 276Manufacturer ID (pccard). 277.It Li mode 278Peripheral mode (USB) 279.It Li notify 280Match the value of the 281.Dq Li notify 282variable. 283.It Li parent 284Parent device 285.It Li pid 286PID of the process triggering the rule (RCTL) 287.It Li port 288Hub port number (USB) 289.It Li product 290Product ID (pccard/USB). 291.It Li release 292Hardware revision (USB) 293.It Li ruid 294Real UID of the process triggering the rule (RCTL) 295.It Li rule 296Rule (RCTL) 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 Resume 336Resume notification. 337.It Li Suspend 338Suspend notification. 339.It Li Thermal 340Thermal zone events. 341.El 342.Pp 343.It Li CARP 344Events related to the 345.Xr carp 8 346protocol. 347.Bl -tag -width ".Sy Subsystem" -compact 348.It Sy Subsystem 349.It Ar vhid@interface 350The 351.Dq subsystem 352contains the actual CARP vhid and the name of the network interface 353on which the event took place. 354.Bl -tag -width ".Li MASTER" -compact 355.It Sy Type 356.It Li MASTER 357Node become the master for a virtual host. 358.It Li BACKUP 359Node become the backup for a virtual host. 360.El 361.El 362.Pp 363.It Li IFNET 364Events related to the network subsystem. 365.Bl -tag -width ".Sy Subsystem" -compact 366.It Sy Subsystem 367.It Ar interface 368The 369.Dq subsystem 370is the actual name of the network interface on which the event 371took place. 372.Bl -tag -width ".Li LINK_DOWN" -compact 373.It Sy Type 374.It Li LINK_UP 375Carrier status changed to UP. 376.It Li LINK_DOWN 377Carrier status changed to DOWN. 378.It Li ATTACH 379The network interface is attached to the system. 380.It Li DETACH 381The network interface is detached from the system. 382.El 383.El 384.Pp 385.It Li DEVFS 386Events related to the 387.Xr devfs 5 388filesystem. 389.Bl -tag -width ".Sy Subsystem" -compact 390.It Sy Subsystem 391.It Li CDEV 392.Bl -tag -width ".Li DESTROY" -compact 393.It Sy Type 394.It Li CREATE 395The 396.Xr devfs 5 397node is created. 398.It Li DESTROY 399The 400.Xr devfs 5 401node is destroyed. 402.El 403.El 404.Pp 405.It Li GEOM 406Events related to the 407.Xr geom 4 408framework. 409The difference compared to 410.Li DEVFS 411is that 412.Li GEOM 413only includes disk-like devices. 414.Bl -tag -width ".Sy Subsystem" -compact 415.It Sy Subsystem 416.It Li DEV 417.Bl -tag -width ".Li MEDIACHANGE" -compact 418.It Sy Type 419.It Li CREATE 420A 421.Xr geom 4 422device node is created. 423.It Li DESTROY 424A 425.Xr geom 4 426device node is destroyed. 427.It Li MEDIACHANGE 428Physical media has changed. 429.El 430.El 431.Pp 432.It Li RCTL 433Events related to the 434.Xr rctl 8 435framework. 436.Bl -tag -width ".Sy Subsystem" -compact 437.It Sy Subsystem 438.It Li rule 439.Bl -tag -width ".Li matched" -compact 440.It Sy Type 441.It Li matched 442A rule with action specified as "devctl" was triggered. 443.El 444.El 445.Pp 446.It Li USB 447Events related to the USB subsystem. 448.Bl -tag -width ".Sy Subsystem" -compact 449.It Sy Subsystem 450.It Li DEVICE 451.Bl -tag -width ".Li DETACH" -compact 452.It Sy Type 453.It Li ATTACH 454USB device is attached to the system. 455.It Li DETACH 456USB device is detached from the system. 457.El 458.It Li INTERFACE 459.Bl -tag -width ".Li DETACH" -compact 460.It Sy Type 461.It Li ATTACH 462USB interface is attached to a device. 463.It Li DETACH 464USB interface is detached from a device. 465.El 466.El 467.Pp 468.It Li coretemp 469Events related to the 470.Xr coretemp 4 471device. 472.Bl -tag -width ".Sy Subsystem" -compact 473.It Sy Subsystem 474.It Li Thermal 475Notification that the CPU core has reached critical temperature. 476.Bl -tag -width ".Ar temperature" -compact 477.It Sy Type 478.It Ar temperature 479String containing the temperature of the core that has become too hot. 480.El 481.El 482.Pp 483.It Li kern 484Events related to the kernel. 485.Bl -tag -width ".Sy Subsystem" -compact 486.It Sy Subsystem 487.It Li power 488Information about the state of the system. 489.Bl -tag -width ".li resume" -compact 490.It Sy Type 491.It Li resume 492Notification that the system has woken from the suspended state. 493.El 494.El 495.El 496.Pp 497A link state change to UP on the interface 498.Dq Li fxp0 499would result in the following notify event: 500.Bd -literal -offset indent 501system=IFNET, subsystem=fxp0, type=LINK_UP 502.Ed 503.Pp 504An AC line state change to 505.Dq offline 506would result in the following event: 507.Bd -literal -offset indent 508system=ACPI, subsystem=ACAD, notify=0x00 509.Ed 510.Ss Comments 511Comments may appear anywhere that whitespace may appear in a 512configuration file. 513To appeal to programmers of all kinds, they can 514be written in C, C++, or shell/Perl constructs. 515.Pp 516C-style comments start with the two characters 517.Ql /* 518(slash, star) and end with 519.Ql */ 520(star, slash). 521Because they are completely delimited with these characters, 522they can be used to comment only a portion of a line or to span 523multiple lines. 524.Pp 525C-style comments cannot be nested. 526For example, the following is 527not valid because the entire comment ends with the first 528.Ql */ : 529.Bd -literal -offset indent 530/* This is the start of a comment. 531 This is still part of the comment. 532/* This is an incorrect attempt at nesting a comment. */ 533 This is no longer in any comment. */ 534.Ed 535.Pp 536C++-style comments start with the two characters 537.Ql // 538(slash, slash) and continue to the end of the physical line. 539They cannot be continued across multiple physical lines; to have 540one logical comment span multiple lines, each line must use the 541.Ql // 542pair. 543For example: 544.Bd -literal -offset indent 545// This is the start of a comment. The next line 546// is a new comment, even though it is logically 547// part of the previous comment. 548.Ed 549.Sh FILES 550.Bl -tag -width ".Pa /etc/devd.conf" -compact 551.It Pa /etc/devd.conf 552The 553.Xr devd 8 554configuration file. 555.El 556.Sh EXAMPLES 557.Bd -literal 558# 559# This will catch link down events on the interfaces fxp0 and ath0 560# 561notify 0 { 562 match "system" "IFNET"; 563 match "subsystem" "(fxp0|ath0)"; 564 match "type" "LINK_DOWN"; 565 action "logger $subsystem is DOWN"; 566}; 567 568# 569# Match lid open/close events 570# These can be combined to a single event, by passing the 571# value of $notify to the external script. 572# 573notify 0 { 574 match "system" "ACPI"; 575 match "subsystem" "Lid"; 576 match "notify" "0x00"; 577 action "logger Lid closed, we can sleep now!"; 578}; 579 580notify 0 { 581 match "system" "ACPI"; 582 match "subsystem" "Lid"; 583 match "notify" "0x01"; 584 action "logger Lid opened, the sleeper must awaken!"; 585}; 586 587# 588# Match a USB device type 589# 590notify 0 { 591 match "system" "USB"; 592 match "subsystem" "INTERFACE"; 593 match "type" "ATTACH"; 594 match "intclass" "0x0e"; 595 action "logger USB video device attached"; 596}; 597 598# 599# Try to configure ath and wi devices with pccard_ether 600# as they are attached. 601# 602attach 0 { 603 device-name "(ath|wi)[0-9]+"; 604 action "/etc/pccard_ether $device-name start"; 605}; 606 607# 608# Stop ath and wi devices as they are detached from 609# the system. 610# 611detach 0 { 612 device-name "(ath|wi)[0-9]+"; 613 action "/etc/pccard_ether $device-name stop"; 614}; 615.Ed 616.Pp 617The installed 618.Pa /etc/devd.conf 619has many additional examples. 620.Sh SEE ALSO 621.Xr coretemp 4 , 622.Xr devfs 5 , 623.Xr re_format 7 , 624.Xr devd 8 625