xref: /freebsd/usr.sbin/devctl/devctl.8 (revision 64de80195bba295c961a4cdf96dbe0e4979bdf2a)
1*64de8019SJohn Baldwin.\"
2*64de8019SJohn Baldwin.\" Copyright (c) 2015 John Baldwin <jhb@FreeBSD.org>
3*64de8019SJohn Baldwin.\" All rights reserved.
4*64de8019SJohn Baldwin.\"
5*64de8019SJohn Baldwin.\" Redistribution and use in source and binary forms, with or without
6*64de8019SJohn Baldwin.\" modification, are permitted provided that the following conditions
7*64de8019SJohn Baldwin.\" are met:
8*64de8019SJohn Baldwin.\" 1. Redistributions of source code must retain the above copyright
9*64de8019SJohn Baldwin.\"    notice, this list of conditions and the following disclaimer.
10*64de8019SJohn Baldwin.\" 2. Redistributions in binary form must reproduce the above copyright
11*64de8019SJohn Baldwin.\"    notice, this list of conditions and the following disclaimer in the
12*64de8019SJohn Baldwin.\"    documentation and/or other materials provided with the distribution.
13*64de8019SJohn Baldwin.\"
14*64de8019SJohn Baldwin.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15*64de8019SJohn Baldwin.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16*64de8019SJohn Baldwin.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17*64de8019SJohn Baldwin.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18*64de8019SJohn Baldwin.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19*64de8019SJohn Baldwin.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20*64de8019SJohn Baldwin.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21*64de8019SJohn Baldwin.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22*64de8019SJohn Baldwin.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23*64de8019SJohn Baldwin.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24*64de8019SJohn Baldwin.\" SUCH DAMAGE.
25*64de8019SJohn Baldwin.\"
26*64de8019SJohn Baldwin.\" $FreeBSD$
27*64de8019SJohn Baldwin.\"
28*64de8019SJohn Baldwin.Dd February 5, 2015
29*64de8019SJohn Baldwin.Dt DEVCTL 8
30*64de8019SJohn Baldwin.Os
31*64de8019SJohn Baldwin.Sh NAME
32*64de8019SJohn Baldwin.Nm devctl
33*64de8019SJohn Baldwin.Nd device control utility
34*64de8019SJohn Baldwin.Sh SYNOPSIS
35*64de8019SJohn Baldwin.Nm
36*64de8019SJohn Baldwin.Cm attach
37*64de8019SJohn Baldwin.Ar device
38*64de8019SJohn Baldwin.Nm
39*64de8019SJohn Baldwin.Cm detach
40*64de8019SJohn Baldwin.Op Fl f
41*64de8019SJohn Baldwin.Ar device
42*64de8019SJohn Baldwin.Nm
43*64de8019SJohn Baldwin.Cm disable
44*64de8019SJohn Baldwin.Op Fl f
45*64de8019SJohn Baldwin.Ar device
46*64de8019SJohn Baldwin.Nm
47*64de8019SJohn Baldwin.Cm enable
48*64de8019SJohn Baldwin.Ar device
49*64de8019SJohn Baldwin.Nm
50*64de8019SJohn Baldwin.Cm suspend
51*64de8019SJohn Baldwin.Ar device
52*64de8019SJohn Baldwin.Nm
53*64de8019SJohn Baldwin.Cm resume
54*64de8019SJohn Baldwin.Ar device
55*64de8019SJohn Baldwin.Nm
56*64de8019SJohn Baldwin.Cm set driver
57*64de8019SJohn Baldwin.Op Fl f
58*64de8019SJohn Baldwin.Ar device driver
59*64de8019SJohn Baldwin.Sh DESCRIPTION
60*64de8019SJohn BaldwinThe
61*64de8019SJohn Baldwin.Nm
62*64de8019SJohn Baldwinutility adjusts the state of individual devices in the kernel's
63*64de8019SJohn Baldwininternal device hierarchy.
64*64de8019SJohn BaldwinEach invocation of
65*64de8019SJohn Baldwin.Nm
66*64de8019SJohn Baldwinconsists of a single command followed by command-specific arguments.
67*64de8019SJohn BaldwinEach command operates on a single device specified via the
68*64de8019SJohn Baldwin.Ar device
69*64de8019SJohn Baldwinargument.
70*64de8019SJohn BaldwinThe
71*64de8019SJohn Baldwin.Ar device
72*64de8019SJohn Baldwinmay be specified either as the name of an existing device or as a
73*64de8019SJohn Baldwinbus-specific address.
74*64de8019SJohn BaldwinMore details on supported address formats can be found in
75*64de8019SJohn Baldwin.Xr devctl 3 .
76*64de8019SJohn Baldwin.Pp
77*64de8019SJohn BaldwinThe following commands are supported:
78*64de8019SJohn Baldwin.Bl -tag -width indent
79*64de8019SJohn Baldwin.It Cm attach Ar device
80*64de8019SJohn BaldwinForce the kernel to re-probe the device.
81*64de8019SJohn BaldwinIf a suitable driver is found,
82*64de8019SJohn Baldwinit is attached to the device.
83*64de8019SJohn Baldwin.It Xo Cm detach
84*64de8019SJohn Baldwin.Op Fl f
85*64de8019SJohn Baldwin.Ar device
86*64de8019SJohn Baldwin.Xc
87*64de8019SJohn BaldwinDetach the device from its current device driver.
88*64de8019SJohn BaldwinIf the
89*64de8019SJohn Baldwin.Fl f
90*64de8019SJohn Baldwinflag is specified,
91*64de8019SJohn Baldwinthe device driver will be detached even if the device is busy.
92*64de8019SJohn Baldwin.It Xo Cm disable
93*64de8019SJohn Baldwin.Op Fl f
94*64de8019SJohn Baldwin.Ar device
95*64de8019SJohn Baldwin.Xc
96*64de8019SJohn BaldwinDisable a device.
97*64de8019SJohn BaldwinIf the device is currently attached to a device driver,
98*64de8019SJohn Baldwinthe device driver will be detached from the device,
99*64de8019SJohn Baldwinbut the device will retain its current name.
100*64de8019SJohn BaldwinIf the
101*64de8019SJohn Baldwin.Fl f
102*64de8019SJohn Baldwinflag is specified,
103*64de8019SJohn Baldwinthe device driver will be detached even if the device is busy.
104*64de8019SJohn Baldwin.It Cm enable Ar device
105*64de8019SJohn BaldwinEnable a device.
106*64de8019SJohn BaldwinThe device will probe and attach if a suitable device driver is found.
107*64de8019SJohn BaldwinNote that this can re-enable a device disabled at boot time via a
108*64de8019SJohn Baldwinloader tunable.
109*64de8019SJohn Baldwin.It Cm suspend Ar device
110*64de8019SJohn BaldwinSuspend a device.
111*64de8019SJohn BaldwinThis may include placing the device in a reduced power state.
112*64de8019SJohn Baldwin.It Cm resume device
113*64de8019SJohn BaldwinResume a suspended device to a fully working state.
114*64de8019SJohn Baldwin.It Xo Cm set driver
115*64de8019SJohn Baldwin.Op Fl f
116*64de8019SJohn Baldwin.Ar device driver
117*64de8019SJohn Baldwin.Xc
118*64de8019SJohn BaldwinForce the device to use a device driver named
119*64de8019SJohn Baldwin.Ar driver .
120*64de8019SJohn BaldwinIf the device is already attached to a device driver and the
121*64de8019SJohn Baldwin.Fl f
122*64de8019SJohn Baldwinflag is specified,
123*64de8019SJohn Baldwinthe device will be detached from its current device driver before it is
124*64de8019SJohn Baldwinattached to the new device driver.
125*64de8019SJohn BaldwinIf the device is already attached to a device driver and the
126*64de8019SJohn Baldwin.Fl f
127*64de8019SJohn Baldwinflag is not specified,
128*64de8019SJohn Baldwinthe device will not be changed.
129*64de8019SJohn Baldwin.El
130*64de8019SJohn Baldwin.Sh SEE ALSO
131*64de8019SJohn Baldwin.Xr devctl 3 ,
132*64de8019SJohn Baldwin.Xr devinfo 8
133*64de8019SJohn Baldwin.Sh HISTORY
134*64de8019SJohn BaldwinThe
135*64de8019SJohn Baldwin.Nm
136*64de8019SJohn Baldwinutility first appeared in
137*64de8019SJohn Baldwin.Fx 11.0 .
138