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