man.bsd.lv manual page server

Manual Page Search Parameters
DEVD.CONF(5) File Formats Manual DEVD.CONF(5)

devd.conf — configuration file for devd(8)

A devd(8) configuration consists of two general features, statements and comments. All statements end with a semicolon. Many statements can contain substatements, which are also terminated with a semicolon.

The following statements are supported:

Specifies various matching criteria and actions to perform when a newly attached device matches said criteria.
Specifies various matching criteria and actions to perform when a newly detached device matches said criteria.
Specifies various matching criteria and actions to perform when no device driver currently loaded in the kernel claims a (new) device.
Specifies various matching criteria and actions to perform when the kernel sends an event notification to userland.
Specifies various options and parameters for the operation of devd(8).

Statements may occur in any order in the configuration file, and may be repeated as often as required. Further details on the syntax and meaning of each statement and their substatements are explained below.

Each statement, except options has a priority (an arbitrary number) associated with it, where ‘0’ is defined as the lowest priority. If two statements match the same event, only the action of the statement with highest priority will be executed. In this way generic statements can be overridden for devices or notifications that require special attention.

The general syntax of a statement is:

statement priority {
	substatement "value";
	...
	substatement "value";
};

The following sub-statements are supported within the options statement.

"/some/path";
Adds the given directory to the list of directories from which devd(8) will read all files named "*.conf" as further configuration files. Any number of directory statements can be used.
"/var/run/devd.pid";
Specifies PID file.
regexp-name "(some|regexp)";
Creates a regular expression and assigns it to the variable regexp-name. The variable is available throughout the rest of the configuration file. If the string begins with ‘!’, it matches if the regular expression formed by the rest of the string does not match. All regular expressions have an implicit ‘^$’ around them.

The following sub-statements are supported within the attach and detach statements.

"command";
Command to execute upon a successful match. Example “/etc/pccard_ether $device-name start”.
"string";
This is shorthand for “match "class" "string"”.
"string";
This is shorthand for “match "device-name" "string"”. This matches a device named string, which is allowed to be a regular expression or a variable previously created containing a regular expression. The “device-name” variable is available for later use with the action statement.
"variable" "value";
Matches the content of value against variable; the content of value may be a regular expression. Not required during attach nor detach events since the device-name statement takes care of all device matching. For a partial list of variables, see below.
"string";
For network devices, media-type will match devices that have the given media type. Valid media types are: “Ethernet”, “Tokenring”, “FDDI”, “802.11”, and “ATM”.
"string";
This is shorthand for “match "subdevice" "string"”.

The following sub-statements are supported within the nomatch statement.

"command";
Same as above.
"variable" "value";
Matches the content of value against variable; the content of value may be a regular expression. For a partial list of variables, see below.

The following sub-statements are supported within the notify statement. The “notify” variable is available inside this statement and contains, a value, depending on which system and subsystem that delivered the event.

"command";
Command to execute upon a successful match. Example “/etc/rc.d/power_profile $notify”.
"system | subsystem | type | notify" "value";
Any number of match statements can exist within a notify statement; value can be either a fixed string or a regular expression. Below is a list of available systems, subsystems, and types.
"string";
See above.

A partial list of variables and their possible values that can be used together with the match statement. The variables are published by the bus based on characteristics of the device that generated the event (for device events). Variables for other classes of events are dependent on those events.

The entire message from the current event.
The entire message from the current event, after the initial type character.
The time this event was processed, in seconds since 1970 dot fraction.
Device name of parent bus.
Device node path if one is created by the devfs(5) filesystem.
CIS-product.
CIS-vendor.
Device class.
Executable name (kernel).
Path to core file (kernel).
Device ID.
Device Class (USB).
Device Sub-class (USB).
Name of attached/detached device.
Endpoint count (USB).
Card functions.
Interface ID (USB).
Interface Class (USB).
Interface Protocol (USB).
Interface Sub-class (USB).
Jail name for the process triggering the rule (RCTL).
Manufacturer ID (pccard).
Peripheral mode (USB).
Match the value of the “notify” variable.
Parent device.
PID of the process triggering the rule (RCTL).
Hub port number (USB).
Product ID (pccard/USB).
Hardware revision (USB).
Real UID of the process triggering the rule (RCTL).
Rule (RCTL).
Serial Number (USB).
Card slot.
Sub-vendor ID.
Sub-device ID.
Matches a subsystem of a system, see below.
Matches a system type, see below.
Type of notification, see below.
Vendor ID.

A partial list of systems, subsystems, and types used within the notify mechanism.

 
Events related to the ACPI subsystem.
 
AC line state ($notify=0x00 is offline, 0x01 is online).
Button state ($notify=0x00 is power, 0x01 is sleep).
Battery events.
Lid state ($notify=0x00 is closed, 0x01 is open).
Processor state/configuration ($notify=0x81 is a change in available Cx states).
Resume notification.
Suspend notification.
Thermal zone events.

Events related to the carp(4) protocol.
 
vhid@interface
The “subsystem” contains the actual CARP vhid and the name of the network interface on which the event took place.
 
Node become the master for a virtual host.
Node become the backup for a virtual host.

Events related to the network subsystem.
 
interface
The “subsystem” is the actual name of the network interface on which the event took place.
 
Carrier status changed to UP.
Carrier status changed to DOWN.
The network interface is attached to the system.
The network interface is detached from the system.

Events related to the devfs(5) filesystem.
 
 
The devfs(5) node is created.
The devfs(5) node is destroyed.

Events related to the geom(4) framework. The difference compared to DEVFS is that GEOM only includes disk-like devices.
 
 
A geom(4) device node is created.
A geom(4) device node is destroyed.
The physical path of a device has changed.
Physical media has changed.

Events related to the rctl(8) framework.
 
 
A rule with action specified as "devctl" was triggered.

Events related to the USB subsystem.
 
 
USB device is attached to the system.
USB device is detached from the system.
 
USB interface is attached to a device.
USB interface is detached from a device.

Events related to the coretemp(4) device.
 
Notification that the CPU core has reached critical temperature.
 
temperature
String containing the temperature of the core that has become too hot.

Events related to the kernel.
 
 
Notification that the system has woken from the suspended state.

More events related to the kernel.
 
 
Notification that a process has crashed and dumped core.

Events related to the cam(4) system.
 
Events related to peripheral devices.
 
Generic errors.
Command timeouts.

A link state change to UP on the interface “fxp0” would result in the following notify event:

system=IFNET, subsystem=fxp0, type=LINK_UP

An AC line state change to “offline” would result in the following event:

system=ACPI, subsystem=ACAD, notify=0x00

Comments may appear anywhere that whitespace may appear in a configuration file. To appeal to programmers of all kinds, they can be written in C, C++, or shell/Perl constructs.

C-style comments start with the two characters ‘/*’ (slash, star) and end with ‘*/’ (star, slash). Because they are completely delimited with these characters, they can be used to comment only a portion of a line or to span multiple lines.

C-style comments cannot be nested. For example, the following is not valid because the entire comment ends with the first ‘*/’:

/* This is the start of a comment.
   This is still part of the comment.
/* This is an incorrect attempt at nesting a comment. */
   This is no longer in any comment. */

C++-style comments start with the two characters ‘//’ (slash, slash) and continue to the end of the physical line. They cannot be continued across multiple physical lines; to have one logical comment span multiple lines, each line must use the ‘//’ pair. For example:

// This is the start of a comment.  The next line
// is a new comment, even though it is logically
// part of the previous comment.

/etc/devd.conf
The devd(8) configuration file.

#
# This will catch link down events on the interfaces fxp0 and ath0
#
notify 0 {
	match "system"			"IFNET";
	match "subsystem"		"(fxp0|ath0)";
	match "type"			"LINK_DOWN";
	action "logger $subsystem is DOWN";
};

#
# Match lid open/close events
# These can be combined to a single event, by passing the
# value of $notify to the external script.
#
notify 0 {
	match "system"			"ACPI";
	match "subsystem"		"Lid";
	match "notify"			"0x00";
	action "logger Lid closed, we can sleep now!";
};

notify 0 {
	match "system"			"ACPI";
	match "subsystem"		"Lid";
	match "notify"			"0x01";
	action "logger Lid opened, the sleeper must awaken!";
};

#
# Match a USB device type
#
notify 0 {
	match "system"			"USB";
	match "subsystem"		"INTERFACE";
	match "type"			"ATTACH";
	match "intclass"		"0x0e";
	action "logger USB video device attached";
};

#
# Try to configure ath and wi devices with pccard_ether
# as they are attached.
#
attach 0 {
        device-name "(ath|wi)[0-9]+";
        action "/etc/pccard_ether $device-name start";
};

#
# Stop ath and wi devices as they are detached from
# the system.
#
detach 0 {
        device-name "(ath|wi)[0-9]+";
        action "/etc/pccard_ether $device-name stop";
};

The installed /etc/devd.conf has many additional examples.

cam(4), coretemp(4), devfs(5), re_format(7), devd(8)

July 20, 2018 FreeBSD-12.0