usr.sbin/devctl/devctl.8

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