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