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.Dd October 31, 2021 26.Dt DEVCTL 8 27.Os 28.Sh NAME 29.Nm devctl 30.Nd device control utility 31.Sh SYNOPSIS 32.Nm 33.Cm attach 34.Ar device 35.Nm 36.Cm clear driver 37.Op Fl f 38.Ar device 39.Nm 40.Cm detach 41.Op Fl f 42.Ar device 43.Nm 44.Cm disable 45.Op Fl f 46.Ar device 47.Nm 48.Cm enable 49.Ar device 50.Nm 51.Cm suspend 52.Ar device 53.Nm 54.Cm resume 55.Ar device 56.Nm 57.Cm set driver 58.Op Fl f 59.Ar device driver 60.Nm 61.Cm rescan 62.Ar device 63.Nm 64.Cm delete 65.Op Fl f 66.Ar device 67.Nm 68.Cm freeze 69.Nm 70.Cm thaw 71.Nm 72.Cm reset 73.Op Fl d 74.Ar device 75.Nm 76.Cm getpath 77.Ar locator 78.Ar device 79.Sh DESCRIPTION 80The 81.Nm 82utility adjusts the state of individual devices in the kernel's 83internal device hierarchy. 84Each invocation of 85.Nm 86consists of a single command followed by command-specific arguments. 87Each command operates on a single device specified via the 88.Ar device 89argument. 90The 91.Ar device 92may be specified either as the name of an existing device or as a 93bus-specific address. 94More details on supported address formats can be found in 95.Xr devctl 3 . 96.Pp 97The following commands are supported: 98.Bl -tag -width indent 99.It Cm attach Ar device 100Force the kernel to re-probe the device. 101If a suitable driver is found, 102it is attached to the device. 103.It Xo Cm detach 104.Op Fl f 105.Ar device 106.Xc 107Detach the device from its current device driver. 108If the 109.Fl f 110flag is specified, 111the device driver will be detached even if the device is busy. 112.It Xo Cm disable 113.Op Fl f 114.Ar device 115.Xc 116Disable a device. 117If the device is currently attached to a device driver, 118the device driver will be detached from the device, 119but the device will retain its current name. 120If the 121.Fl f 122flag is specified, 123the device driver will be detached even if the device is busy. 124.It Cm enable Ar device 125Enable a device. 126The device will probe and attach if a suitable device driver is found. 127Note that this can re-enable a device disabled at boot time via a 128loader tunable. 129.It Cm suspend Ar device 130Suspend a device. 131This may include placing the device in a reduced power state. 132.It Cm resume Ar device 133Resume a suspended device to a fully working state. 134.It Xo Cm set driver 135.Op Fl f 136.Ar device driver 137.Xc 138Force the device to use a device driver named 139.Ar driver . 140If the device is already attached to a device driver and the 141.Fl f 142flag is specified, 143the device will be detached from its current device driver before it is 144attached to the new device driver. 145If the device is already attached to a device driver and the 146.Fl f 147flag is not specified, 148the device will not be changed. 149.It Xo Cm clear driver 150.Op Fl f 151.Ar device 152.Xc 153Clear a previously-forced driver name so that the device is able to use any 154valid device driver. 155After the previous name has been cleared, 156the device is reprobed so that other device drivers may attach to it. 157This can be used to undo an earlier 158.Cm set driver 159command. 160If the device is currently attached to a device driver and the 161.Fl f 162flag is not specified, 163the device will not be changed. 164.It Cm rescan Ar device 165Rescan a bus device checking for devices that have been added or 166removed. 167.It Xo Cm delete 168.Op Fl f 169.Ar device 170.Xc 171Delete the device from the device tree. 172If the 173.Fl f 174flag is specified, 175the device will be deleted even if it is physically present. 176This command should be used with care as a device that is deleted but present 177can no longer be used unless the parent bus device rediscovers the device via 178a rescan request. 179.It Cm freeze 180Freeze probe and attach processing initiated in response to drivers being 181loaded. 182Drivers are placed on a 183.Do 184frozen list 185.Dc 186and processed when a later 187.Do 188thaw 189.Dc 190occurs. 191.It Cm thaw 192Resume (thaw the freeze) probe and attach initiated in response to drivers 193being loaded. 194In addition to resuming, all pending actions that were frozen during the freeze 195are performed. 196.It Xo Cm reset 197.Op Fl d 198.Ar device 199.Xc 200Reset the device, using bus-specific reset method. 201Drivers for the devices being reset are suspended around the reset. 202If the 203.Fl d 204option is specified, drivers are detached instead. 205.Pp 206Currently, resets are implemented for PCIe buses and PCI devices. 207For PCIe bus, the link is disabled and then re-trained, causing all 208children of the bus to reset. 209Use 210.Fl p 211option of 212.Xr devinfo 8 213tool to report parent bus for the device. 214For PCI device, if Function-Level Reset is implemented by it, FLR is 215tried first; if failed or not implemented, power reset is tried. 216.Pp 217If you have detached or suspended a child device explicitly and then 218do a reset, the child device will end up attached. 219.It Xo Cm getpath 220.Ar locator 221.Ar device 222.Xc 223Prints the full path to the 224.Ar device 225using the 226.Ar locator 227method to get the path name. 228Currently, only the 229.Dq UEFI 230and 231.Dq FreeBSD 232locators are implemented. 233The UEFI locator constructs a path to the device using the rules 234outlines for DEVICE_PATH in the UEFI standard. 235The FreeBSD locator constructs a path back to the root of the tree 236with the nodes separated by slashes. 237.El 238.Sh SEE ALSO 239.Xr devctl 3 , 240.Xr devinfo 8 241.Sh HISTORY 242The 243.Nm 244utility first appeared in 245.Fx 10.3 . 246.Sh BUGS 247Currently there is no administrative flag to prevent re-attach or resume 248of the manually detached or suspended devices after reset. 249Similarly, there is no flag to prevent un-suspending of the manually 250suspended devices after system resume. 251