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