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
 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 device-name
 254 Name of attached/detached device.
 255 .It Li function
 256 Card functions.
 257 .It Li manufacturer
 258 Manufacturer ID (pccard).
 259 .It Li notify
 260 Match the value of the
 261 .Dq Li notify
 262 variable.
 263 .It Li product
 264 Product ID (pccard).
 265 .It Li serial
 266 Serial Number (USB).
 267 .It Li slot
 268 Card slot.
 269 .It Li subvendor
 270 Sub-vendor ID.
 271 .It Li subdevice
 272 Sub-device ID.
 273 .It Li subsystem
 274 Matches a subsystem of a system, see below.
 275 .It Li system
 276 Matches a system type, see below.
 277 .It Li type
 278 Type of notification, see below.
 279 .It Li vendor
 280 Vendor ID.
 281 .El
 282 .Ss Notify matching
 283 A partial list of systems, subsystems, and types used within the
 284 .Ic notify
 285 mechanism.
 286 .Pp
 287 .Bl -tag -width ".Li coretemp" -compact
 288 .It Sy System
 289 .It Li ACPI
 290 Events related to the ACPI subsystem.
 291 .Bl -tag -width ".Sy Subsystem" -compact
 292 .It Sy Subsystem
 293 .It Li ACAD
 294 AC line state ($notify=0x00 is offline, 0x01 is online).
 295 .It Li Button
 296 Button state ($notify=0x00 is power, 0x01 is sleep).
 297 .It Li CMBAT
 298 Battery events.
 299 .It Li Lid
 300 Lid state ($notify=0x00 is closed, 0x01 is open).
 301 .It Li Thermal
 302 Thermal zone events.
 303 .El
 304 .Pp
 305 .It Li IFNET
 306 Events related to the network subsystem.
 307 .Bl -tag -width ".Sy Subsystem" -compact
 308 .It Sy Subsystem
 309 .It Ar interface
 310 The
 311 .Dq subsystem
 312 is the actual name of the network interface on which the event
 313 took place.
 314 .Bl -tag -width ".Li LINK_DOWN" -compact
 315 .It Sy Type
 316 .It Li LINK_UP
 317 Carrier status changed to UP.
 318 .It Li LINK_DOWN
 319 Carrier status changed to DOWN.
 320 .It Li ATTACH
 321 The network interface is attached to the system.
 322 .It Li DETACH
 323 The network interface is detached from the system.
 324 .El
 325 .El
 326 .It Li DEVFS
 327 Events related to the
 328 .Xr devfs 5
 329 filesystem.
 330 .Bl -tag -width ".Sy Subsystem" -compact
 331 .It Sy Subsystem
 332 .It Li CDEV
 333 .Bl -tag -width ".Li DESTROY" -compact
 334 .It Sy Type
 335 .It Li CREATE
 336 The
 337 .Xr devfs 5
 338 node is created.
 339 .It Li DESTROY
 340 The
 341 .Xr devfs 5
 342 node is destroyed.
 343 .El
 344 .El
 345 .It Li coretemp
 346 Events related to the
 347 .Xr coretemp 4
 348 device.
 349 .Bl -tag -width ".Sy Subsystem" -compact
 350 .It Sy Subsystem
 351 .It Li Thermal
 352 Notification that the CPU core has reached critical temperature.
 353 .Bl -tag -width ".Ar temperature" -compact
 354 .It Sy Type
 355 .It Ar temperature
 356 String containing the temperature of the core that has become too hot.
 357 .El
 358 .El
 359 .It Li kern
 360 Events related to the kernel.
 361 .Bl -tag -width ".Sy Subsystem" -compact
 362 .It Sy Subsystem
 363 .It Li power
 364 Information about the state of the system.
 365 .Bl -tag -width ".li resume" -compact
 366 .It Sy Type
 367 .It Li resume
 368 Notification that the system has woken from the suspended state.
 369 .El
 370 .El
 371 .El
 372 .Pp
 373 A link state change to UP on the interface
 374 .Dq Li fxp0
 375 would result in the following notify event:
 376 .Bd -literal -offset indent
 377 system=IFNET, subsystem=fxp0, type=LINK_UP
 378 .Ed
 379 .Pp
 380 An AC line state change to
 381 .Dq offline
 382 would result in the following event:
 383 .Bd -literal -offset indent
 384 system=ACPI, subsystem=ACAD, notify=0x00
 385 .Ed
 386 .Ss Comments
 387 Comments may appear anywhere that whitespace may appear in a
 388 configuration file.
 389 To appeal to programmers of all kinds, they can
 390 be written in C, C++, or shell/Perl constructs.
 391 .Pp
 392 C-style comments start with the two characters
 393 .Ql /*
 394 (slash, star) and end with
 395 .Ql */
 396 (star, slash).
 397 Because they are completely delimited with these characters,
 398 they can be used to comment only a portion of a line or to span
 399 multiple lines.
 400 .Pp
 401 C-style comments cannot be nested.
 402 For example, the following is
 403 not valid because the entire comment ends with the first
 404 .Ql */ :
 405 .Bd -literal -offset indent
 406 /* This is the start of a comment.
 407    This is still part of the comment.
 408 /* This is an incorrect attempt at nesting a comment. */
 409    This is no longer in any comment. */
 410 .Ed
 411 .Pp
 412 C++-style comments start with the two characters
 413 .Ql //
 414 (slash, slash) and continue to the end of the physical line.
 415 They cannot be continued across multiple physical lines; to have
 416 one logical comment span multiple lines, each line must use the
 417 .Ql //
 418 pair.
 419 For example:
 420 .Bd -literal -offset indent
 421 // This is the start of a comment.  The next line
 422 // is a new comment, even though it is logically
 423 // part of the previous comment.
 424 .Ed
 425 .Sh FILES
 426 .Bl -tag -width ".Pa /etc/devd.conf" -compact
 427 .It Pa /etc/devd.conf
 428 The
 429 .Xr devd 8
 430 configuration file.
 431 .El
 432 .Sh EXAMPLES
 433 .Bd -literal
 434 #
 435 # This will catch link down events on the interfaces fxp0 and ath0
 436 #
 437 notify 0 {
 438         match "system"                  "IFNET";
 439         match "subsystem"               "(fxp0|ath0)";
 440         match "type"                    "LINK_DOWN";
 441         action "logger $subsystem is DOWN";
 442 };
 443
 444 #
 445 # Match lid open/close events
 446 # These can be combined to a single event, by passing the
 447 # value of $notify to the external script.
 448 #
 449 notify 0 {
 450         match "system"                  "ACPI";
 451         match "subsystem"               "Lid";
 452         match "notify"                  "0x00";
 453         action "logger Lid closed, we can sleep now!";
 454 };
 455
 456 notify 0 {
 457         match "system"                  "ACPI";
 458         match "subsystem"               "Lid";
 459         match "notify"                  "0x01";
 460         action "logger Lid opened, the sleeper must awaken!";
 461 };
 462
 463 #
 464 # Try to configure ath and wi devices with pccard_ether
 465 # as they are attached.
 466 #
 467 attach 0 {
 468         device-name "(ath|wi)[0-9]+";
 469         action "/etc/pccard_ether $device-name start";
 470 };
 471
 472 #
 473 # Stop ath and wi devices as they are detached from
 474 # the system.
 475 #
 476 detach 0 {
 477         device-name "(ath|wi)[0-9]+";
 478         action "/etc/pccard_ether $device-name stop";
 479 };
 480 .Ed
 481 .Pp
 482 The installed
 483 .Pa /etc/devd.conf
 484 has many additional examples.
 485 .Sh SEE ALSO
 486 .Xr coretemp 4 ,
 487 .Xr devfs 5 ,
 488 .Xr devd 8