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 August 29, 2016
  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 set driver
  55 .Op Fl f
  56 .Ar device driver
  57 .Sh DESCRIPTION
  58 The
  59 .Nm
  60 utility adjusts the state of individual devices in the kernel's
  61 internal device hierarchy.
  62 Each invocation of
  63 .Nm
  64 consists of a single command followed by command-specific arguments.
  65 Each command operates on a single device specified via the
  66 .Ar device
  67 argument.
  68 The
  69 .Ar device
  70 may be specified either as the name of an existing device or as a
  71 bus-specific address.
  72 More details on supported address formats can be found in
  73 .Xr devctl 3 .
  74 .Pp
  75 The following commands are supported:
  76 .Bl -tag -width indent
  77 .It Cm attach Ar device
  78 Force the kernel to re-probe the device.
  79 If a suitable driver is found,
  80 it is attached to the device.
  81 .It Xo Cm detach
  82 .Op Fl f
  83 .Ar device
  84 .Xc
  85 Detach the device from its current device driver.
  86 If the
  87 .Fl f
  88 flag is specified,
  89 the device driver will be detached even if the device is busy.
  90 .It Xo Cm disable
  91 .Op Fl f
  92 .Ar device
  93 .Xc
  94 Disable a device.
  95 If the device is currently attached to a device driver,
  96 the device driver will be detached from the device,
  97 but the device will retain its current name.
  98 If the
  99 .Fl f
 100 flag is specified,
 101 the device driver will be detached even if the device is busy.
 102 .It Cm enable Ar device
 103 Enable a device.
 104 The device will probe and attach if a suitable device driver is found.
 105 Note that this can re-enable a device disabled at boot time via a
 106 loader tunable.
 107 .It Xo Cm set driver
 108 .Op Fl f
 109 .Ar device driver
 110 .Xc
 111 Force the device to use a device driver named
 112 .Ar driver .
 113 If the device is already attached to a device driver and the
 114 .Fl f
 115 flag is specified,
 116 the device will be detached from its current device driver before it is
 117 attached to the new device driver.
 118 If the device is already attached to a device driver and the
 119 .Fl f
 120 flag is not specified,
 121 the device will not be changed.
 122 .It Xo Cm clear driver
 123 .Op Fl f
 124 .Ar device
 125 .Xc
 126 Clear a previously-forced driver name so that the device is able to use any
 127 valid device driver.
 128 After the previous name has been cleared,
 129 the device is reprobed so that other device drivers may attach to it.
 130 This can be used to undo an earlier
 131 .Cm set driver
 132 command.
 133 If the device is currently attached to a device driver and the
 134 .Fl f
 135 flag is not specified,
 136 the device will not be changed.
 137 .El
 138 .Sh SEE ALSO
 139 .Xr devctl 3 ,
 140 .Xr devinfo 8
 141 .Sh HISTORY
 142 The
 143 .Nm
 144 utility first appeared in
 145 .Fx 10.3 .