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