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 February 2, 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 detach
  40 .Op Fl f
  41 .Ar device
  42 .Nm
  43 .Cm disable
  44 .Op Fl f
  45 .Ar device
  46 .Nm
  47 .Cm enable
  48 .Ar device
  49 .Nm
  50 .Cm set driver
  51 .Op Fl f
  52 .Ar device driver
  53 .Sh DESCRIPTION
  54 The
  55 .Nm
  56 utility adjusts the state of individual devices in the kernel's
  57 internal device hierarchy.
  58 Each invocation of
  59 .Nm
  60 consists of a single command followed by command-specific arguments.
  61 Each command operates on a single device specified via the
  62 .Ar device
  63 argument.
  64 The
  65 .Ar device
  66 may be specified either as the name of an existing device or as a
  67 bus-specific address.
  68 More details on supported address formats can be found in
  69 .Xr devctl 3 .
  70 .Pp
  71 The following commands are supported:
  72 .Bl -tag -width indent
  73 .It Cm attach Ar device
  74 Force the kernel to re-probe the device.
  75 If a suitable driver is found,
  76 it is attached to the device.
  77 .It Xo Cm detach
  78 .Op Fl f
  79 .Ar device
  80 .Xc
  81 Detach the device from its current device driver.
  82 If the
  83 .Fl f
  84 flag is specified,
  85 the device driver will be detached even if the device is busy.
  86 .It Xo Cm disable
  87 .Op Fl f
  88 .Ar device
  89 .Xc
  90 Disable a device.
  91 If the device is currently attached to a device driver,
  92 the device driver will be detached from the device,
  93 but the device will retain its current name.
  94 If the
  95 .Fl f
  96 flag is specified,
  97 the device driver will be detached even if the device is busy.
  98 .It Cm enable Ar device
  99 Enable a device.
 100 The device will probe and attach if a suitable device driver is found.
 101 Note that this can re-enable a device disabled at boot time via a
 102 loader tunable.
 103 .It Xo Cm set driver
 104 .Op Fl f
 105 .Ar device driver
 106 .Xc
 107 Force the device to use a device driver named
 108 .Ar driver .
 109 If the device is already attached to a device driver and the
 110 .Fl f
 111 flag is specified,
 112 the device will be detached from its current device driver before it is
 113 attached to the new device driver.
 114 If the device is already attached to a device driver and the
 115 .Fl f
 116 flag is not specified,
 117 the device will not be changed.
 118 .El
 119 .Sh SEE ALSO
 120 .Xr devctl 3 ,
 121 .Xr devinfo 8
 122 .Sh HISTORY
 123 The
 124 .Nm
 125 utility first appeared in
 126 .Fx 10.3 .