sbin/devd/devd.conf.5

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