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