Manual Pages  — DEVCTL

devctl, devctl_attach, devctl_clear_driver, devctl_delete, devctl_detach, devctl_disable, devctl_enable, devctl_freeze, devctl_rescan, devctl_reset, devctl_resume, devctl_set_driver, devctl_suspend, devctl_thaw – device control library

LIBRARY SYNOPSIS DESCRIPTION RETURN VALUES ERRORS SEE ALSO HISTORY BUGS

libdevctl

#include <devctl.h>

int
devctl_attach(const char *device);

int
devctl_clear_driver(const char *device, bool force);

int
devctl_delete(const char *device, bool force);

int
devctl_detach(const char *device, bool force);

int
devctl_disable(const char *device, bool force_detach);

int
devctl_enable(const char *device);

int
devctl_freeze(void);

int
devctl_rescan(const char *device);

int
devctl_reset(const char *device, bool detach);

int
devctl_resume(const char *device);

int
devctl_set_driver(const char *device, const char *driver, bool force);

int
devctl_suspend(const char *device);

int
devctl_thaw(void);

The devctl library adjusts the state of devices in the kernel's internal device hierarchy. Each control operation accepts a device argument that identifies the device to adjust. The device may be specified as either the name of an existing device or as a bus-specific address. The following bus-specific address formats are currently supported:

pcidomain, Ns, :, Ns, Fa, bus, Ns, :, Ns, Fa, slot, Ns, :, Ns, Fa, function	A PCI device with the specified domain, bus, slot, and function.
pcibus, Ns, :, Ns, Fa, slot, Ns, :, Ns, Fa, function	A PCI device in domain zero with the specified bus, slot, and function.
handle	A device with an ACPI handle of handle. The handle must be specified as an absolute path and must begin with a "\".

The devctl_attach() function probes a device and attaches a suitable device driver if one is found.

The devctl_detach() function detaches a device from its current device driver. The device is left detached until either a new driver for its parent bus is loaded or the device is explicitly probed via devctl_attach(). If force is true, the current device driver will be detached even if the device is busy.

The devctl_delete() function deletes a device from the device tree. No If force is true, the device is deleted even if the device is physically present.

The devctl_disable() function disables a device. If the device is currently attached to a device driver, the device driver will be detached from the device, but the device will retain its current name. If force_detach is true, the current device driver will be detached even if the device is busy. The device will remain disabled and detached until it is explicitly enabled via devctl_enable().

The devctl_enable() function re-enables a disabled device. The device will probe and attach if a suitable device driver is found.

The devctl_suspend() function suspends a device. This may include placing the device in a reduced power state, but any device driver currently attached to the device will remain attached.

The devctl_resume() function resumes a suspended device to a fully working state.

The devctl_set_driver() function attaches a device driver named driver to a device. If the device is already attached and force is false, the request will fail. If the device is already attached and force is true, the device will be detached from its current device driver before it is attached to the new device driver.

The devctl_clear_driver() function resets a device so that it can be attached to any valid device driver rather than only drivers with a previously specified name. This function is used to undo a previous call to devctl_set_driver(). If the device is already attached and force is false, the request will fail. If the device is already attached and force is true, the device will be detached from its current device driver. After the device's name is reset, it is reprobed and attached to a suitable device driver if one is found.

The devctl_rescan() function rescans a bus device checking for devices that have been added or removed.

The devctl_freeze() function freezes probe and attach processing initiated in response to drivers being loaded.

The devctl_thaw() function resumes (thaws the freeze) probe and attach processing initiated in response to drivers being loaded.

The devctl_reset() function resets the specified device using bus-specific reset method. The detach argument, if true, specifies that the device driver is detached before the reset, and re-attached afterwards. If false, the device is suspended before the reset, and resumed after.

The devctl_attach, devctl_clear_driver, devctl_deleteand devctl_detach functions return the value 0 if successful; otherwise the value -1 is returned and the global variable errno is set to indicate the error. devctl_disable devctl_enable devctl_suspend devctl_rescan devctl_resume devctl_set_driver

The devctl library first appeared in FreeBSD 10.3 .

If a device is suspended individually via devctl_suspend() and the entire machine is subsequently suspended, the device will be resumed when the machine resumes.

Similarly, if the device is suspended, and devctl_reset() is called on the device with detach set to false, the device is resumed by the devctl_reset() call. Or, if the driver for the device is detached manually, and devctl_reset() is called on the device with detach set to true, device reset re-attaches the driver.