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