1.\" 2.\" Copyright (c) 2015 John Baldwin <jhb@FreeBSD.org> 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 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.Dd April 4, 2019 28.Dt DEVCTL 8 29.Os 30.Sh NAME 31.Nm devctl 32.Nd device control utility 33.Sh SYNOPSIS 34.Nm 35.Cm attach 36.Ar device 37.Nm 38.Cm clear driver 39.Op Fl f 40.Ar device 41.Nm 42.Cm detach 43.Op Fl f 44.Ar device 45.Nm 46.Cm disable 47.Op Fl f 48.Ar device 49.Nm 50.Cm enable 51.Ar device 52.Nm 53.Cm suspend 54.Ar device 55.Nm 56.Cm resume 57.Ar device 58.Nm 59.Cm set driver 60.Op Fl f 61.Ar device driver 62.Nm 63.Cm rescan 64.Ar device 65.Nm 66.Cm delete 67.Op Fl f 68.Ar device 69.Nm 70.Cm reset 71.Op Fl d 72.Ar device 73.Sh DESCRIPTION 74The 75.Nm 76utility adjusts the state of individual devices in the kernel's 77internal device hierarchy. 78Each invocation of 79.Nm 80consists of a single command followed by command-specific arguments. 81Each command operates on a single device specified via the 82.Ar device 83argument. 84The 85.Ar device 86may be specified either as the name of an existing device or as a 87bus-specific address. 88More details on supported address formats can be found in 89.Xr devctl 3 . 90.Pp 91The following commands are supported: 92.Bl -tag -width indent 93.It Cm attach Ar device 94Force the kernel to re-probe the device. 95If a suitable driver is found, 96it is attached to the device. 97.It Xo Cm detach 98.Op Fl f 99.Ar device 100.Xc 101Detach the device from its current device driver. 102If the 103.Fl f 104flag is specified, 105the device driver will be detached even if the device is busy. 106.It Xo Cm disable 107.Op Fl f 108.Ar device 109.Xc 110Disable a device. 111If the device is currently attached to a device driver, 112the device driver will be detached from the device, 113but the device will retain its current name. 114If the 115.Fl f 116flag is specified, 117the device driver will be detached even if the device is busy. 118.It Cm enable Ar device 119Enable a device. 120The device will probe and attach if a suitable device driver is found. 121Note that this can re-enable a device disabled at boot time via a 122loader tunable. 123.It Cm suspend Ar device 124Suspend a device. 125This may include placing the device in a reduced power state. 126.It Cm resume Ar device 127Resume a suspended device to a fully working state. 128.It Xo Cm set driver 129.Op Fl f 130.Ar device driver 131.Xc 132Force the device to use a device driver named 133.Ar driver . 134If the device is already attached to a device driver and the 135.Fl f 136flag is specified, 137the device will be detached from its current device driver before it is 138attached to the new device driver. 139If the device is already attached to a device driver and the 140.Fl f 141flag is not specified, 142the device will not be changed. 143.It Xo Cm clear driver 144.Op Fl f 145.Ar device 146.Xc 147Clear a previously-forced driver name so that the device is able to use any 148valid device driver. 149After the previous name has been cleared, 150the device is reprobed so that other device drivers may attach to it. 151This can be used to undo an earlier 152.Cm set driver 153command. 154If the device is currently attached to a device driver and the 155.Fl f 156flag is not specified, 157the device will not be changed. 158.It Cm rescan Ar device 159Rescan a bus device checking for devices that have been added or 160removed. 161.It Xo Cm delete 162.Op Fl f 163.Ar device 164.Xc 165Delete the device from the device tree. 166If the 167.Fl f 168flag is specified, 169the device will be deleted even if it is physically present. 170This command should be used with care as a device that is deleted but present 171can no longer be used unless the parent bus device rediscovers the device via 172a rescan request. 173.It Xo Cm reset 174.Op Fl d 175.Ar device 176.Xc 177Reset the device, using bus-specific reset method. 178Drivers for the devices being reset are suspended around the reset. 179If the 180.Fl d 181option is specified, drivers are detached instead. 182.Pp 183Currently, resets are implemented for PCIe buses and PCI devices. 184For PCIe bus, the link is disabled and then re-trained, causing all 185children of the bus to reset. 186Use 187.Fl p 188option of 189.Xr devinfo 8 190tool to report parent bus for the device. 191For PCI device, if Function-Level Reset is implemented by it, FLR is 192tried first; if failed or not implemented, power reset is tried. 193.Pp 194If you have detached or suspended a child device explicitly and then 195do a reset, the child device will end up attached. 196.El 197.Sh BUGS 198Currently there is no administrative flag to prevent re-attach or resume 199of the manually detached or suspended devices after reset. 200Similarly, there is no flag to prevent un-suspending of the the manually 201suspended devices after system resume. 202.Sh SEE ALSO 203.Xr devctl 3 , 204.Xr devinfo 8 205.Sh HISTORY 206The 207.Nm 208utility first appeared in 209.Fx 10.3 . 210