xref: /freebsd/usr.sbin/devctl/devctl.8 (revision 193d9e768ba63fcfb187cfd17f461f7d41345048)
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 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.Sh DESCRIPTION
71The
72.Nm
73utility adjusts the state of individual devices in the kernel's
74internal device hierarchy.
75Each invocation of
76.Nm
77consists of a single command followed by command-specific arguments.
78Each command operates on a single device specified via the
79.Ar device
80argument.
81The
82.Ar device
83may be specified either as the name of an existing device or as a
84bus-specific address.
85More details on supported address formats can be found in
86.Xr devctl 3 .
87.Pp
88The following commands are supported:
89.Bl -tag -width indent
90.It Cm attach Ar device
91Force the kernel to re-probe the device.
92If a suitable driver is found,
93it is attached to the device.
94.It Xo Cm detach
95.Op Fl f
96.Ar device
97.Xc
98Detach the device from its current device driver.
99If the
100.Fl f
101flag is specified,
102the device driver will be detached even if the device is busy.
103.It Xo Cm disable
104.Op Fl f
105.Ar device
106.Xc
107Disable a device.
108If the device is currently attached to a device driver,
109the device driver will be detached from the device,
110but the device will retain its current name.
111If the
112.Fl f
113flag is specified,
114the device driver will be detached even if the device is busy.
115.It Cm enable Ar device
116Enable a device.
117The device will probe and attach if a suitable device driver is found.
118Note that this can re-enable a device disabled at boot time via a
119loader tunable.
120.It Cm suspend Ar device
121Suspend a device.
122This may include placing the device in a reduced power state.
123.It Cm resume Ar device
124Resume a suspended device to a fully working state.
125.It Xo Cm set driver
126.Op Fl f
127.Ar device driver
128.Xc
129Force the device to use a device driver named
130.Ar driver .
131If the device is already attached to a device driver and the
132.Fl f
133flag is specified,
134the device will be detached from its current device driver before it is
135attached to the new device driver.
136If the device is already attached to a device driver and the
137.Fl f
138flag is not specified,
139the device will not be changed.
140.It Xo Cm clear driver
141.Op Fl f
142.Ar device
143.Xc
144Clear a previously-forced driver name so that the device is able to use any
145valid device driver.
146After the previous name has been cleared,
147the device is reprobed so that other device drivers may attach to it.
148This can be used to undo an earlier
149.Cm set driver
150command.
151If the device is currently attached to a device driver and the
152.Fl f
153flag is not specified,
154the device will not be changed.
155.It Cm rescan Ar device
156Rescan a bus device checking for devices that have been added or
157removed.
158.It Xo Cm delete
159.Op Fl
160.Ar device
161.Xc
162Delete the device from the device tree.
163If the
164.Fl f
165flag is specified,
166the device will be deleted even if it is physically present.
167This command should be used with care as a device that is deleted but present
168can no longer be used unless the parent bus device rediscovers the device via
169a rescan request.
170.El
171.Sh SEE ALSO
172.Xr devctl 3 ,
173.Xr devinfo 8
174.Sh HISTORY
175The
176.Nm
177utility first appeared in
178.Fx 10.3 .
179