2 .\" Copyright (c) 2014 John Baldwin <jhb@FreeBSD.org>
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
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.
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
34 .Nm devctl_clear_driver ,
39 .Nd device control library
45 .Fn devctl_attach "const char *device"
47 .Fn devctl_clear_driver "const char *device" "bool force"
49 .Fn devctl_detach "const char *device" "bool force"
51 .Fn devctl_disable "const char *device" "bool force_detach"
53 .Fn devctl_enable "const char *device"
55 .Fn devctl_set_driver "const char *device" "const char *driver" "bool force"
59 library adjusts the state of devices in the kernel's internal device
61 Each control operation accepts a
63 argument that identifies the device to adjust.
66 may be specified as either the name of an existing device or as a
68 The following bus-specific address formats are currently supported:
69 .Bl -tag -offset indent
70 .It Sy pci Ns Fa domain Ns : Ns Fa bus Ns : Ns Fa slot Ns : Ns Fa function
71 A PCI device with the specified
77 .It Sy pci Ns Fa bus Ns : Ns Fa slot Ns : Ns Fa function
78 A PCI device in domain zero with the specified
84 A device with an ACPI handle of
86 The handle must be specified as an absolute path and must begin with a
92 function probes a device and attaches a suitable device driver if one is
97 function detaches a device from its current device driver.
98 The device is left detached until either a new driver for its parent
99 bus is loaded or the device is explicitly probed via
104 the current device driver will be detached even if the device is busy.
108 function disables a device.
109 If the device is currently attached to a device driver,
110 the device driver will be detached from the device,
111 but the device will retain its current name.
115 the current device driver will be detached even if the device is busy.
116 The device will remain disabled and detached until it is explicitly enabled
122 function re-enables a disabled device.
123 The device will probe and attach if a suitable device driver is found.
126 .Fn devctl_set_driver
127 function attaches a device driver named
130 If the device is already attached and
133 the request will fail.
134 If the device is already attached and
137 the device will be detached from its current device driver before it is
138 attached to the new device driver.
141 .Fn devctl_clear_driver
142 function resets a device so that it can be attached to any valid device
143 driver rather than only drivers with a previously specified name.
144 This function is used to undo a previous call to
145 .Fn devctl_set_driver .
146 If the device is already attached and
149 the request will fail.
150 If the device is already attached and
153 the device will be detached from its current device driver.
154 After the device's name is reset,
155 it is reprobed and attached to a suitable device driver if one is found.
157 .Rv -std devctl_attach devctl_clear_driver devctl_detach \
158 devctl_disable devctl_enable devctl_set_driver
160 In addition to specific errors noted below,
163 functions may fail for any of the errors described in
168 The device name is too long.
170 No existing device matches the specified name or location.
172 The current process is not permitted to adjust the state of
178 function may fail if:
181 The device is already attached.
183 An internal memory allocation request failed.
185 The device is disabled.
187 No suitable driver for the device could be found,
188 or the driver failed to attach.
193 function may fail if:
196 The current device driver for
198 is busy and cannot detach at this time.
199 Note that some drivers may return this even if
203 The device is not attached to a driver.
205 The current device driver for
207 does not support detaching.
212 function may fail if:
215 The device is already enabled.
217 An internal memory allocation request failed.
219 No suitable driver for the device could be found,
220 or the driver failed to attach.
225 function may fail if:
228 The current device driver for
230 is busy and cannot detach at this time.
231 Note that some drivers may return this even if
235 The device is already disabled.
237 The current device driver for
239 does not support detaching.
243 .Fn devctl_set_driver
244 function may fail if:
247 The device is currently attached to a device driver and
251 The current device driver for
253 is busy and cannot detach at this time.
257 argument points outside the process' allocated address space.
259 No device driver with the requested name exists.
261 An internal memory allocation request failed.
263 The device is disabled.
265 The new device driver failed to attach.
269 .Fn devctl_clear_driver
270 function may fail if:
273 The device is currently attached to a device driver and
277 The current device driver for
279 is busy and cannot detach at this time.
281 The device is not configured for a specific device driver name.
283 The device driver chosen after reprobing failed to attach.
292 library first appeared in