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