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 ,
42 .Nm devctl_set_driver ,
45 .Nd device control library
51 .Fn devctl_attach "const char *device"
53 .Fn devctl_clear_driver "const char *device" "bool force"
55 .Fn devctl_delete "const char *device" "bool force"
57 .Fn devctl_detach "const char *device" "bool force"
59 .Fn devctl_disable "const char *device" "bool force_detach"
61 .Fn devctl_enable "const char *device"
63 .Fn devctl_freeze "void"
65 .Fn devctl_rescan "const char *device"
67 .Fn devctl_resume "const char *device"
69 .Fn devctl_set_driver "const char *device" "const char *driver" "bool force"
71 .Fn devctl_suspend "const char *device"
73 .Fn devctl_thaw "void"
77 library adjusts the state of devices in the kernel's internal device
79 Each control operation accepts a
81 argument that identifies the device to adjust.
84 may be specified as either the name of an existing device or as a
86 The following bus-specific address formats are currently supported:
87 .Bl -tag -offset indent
88 .It Sy pci Ns Fa domain Ns : Ns Fa bus Ns : Ns Fa slot Ns : Ns Fa function
89 A PCI device with the specified
95 .It Sy pci Ns Fa bus Ns : Ns Fa slot Ns : Ns Fa function
96 A PCI device in domain zero with the specified
102 A device with an ACPI handle of
104 The handle must be specified as an absolute path and must begin with a
110 function probes a device and attaches a suitable device driver if one is
115 function detaches a device from its current device driver.
116 The device is left detached until either a new driver for its parent
117 bus is loaded or the device is explicitly probed via
122 the current device driver will be detached even if the device is busy.
126 function deletes a device from the device tree.
131 the device is deleted even if the device is physically present.
135 function disables a device.
136 If the device is currently attached to a device driver,
137 the device driver will be detached from the device,
138 but the device will retain its current name.
142 the current device driver will be detached even if the device is busy.
143 The device will remain disabled and detached until it is explicitly enabled
149 function re-enables a disabled device.
150 The device will probe and attach if a suitable device driver is found.
154 function suspends a device.
155 This may include placing the device in a reduced power state,
156 but any device driver currently attached to the device will remain attached.
160 function resumes a suspended device to a fully working state.
163 .Fn devctl_set_driver
164 function attaches a device driver named
167 If the device is already attached and
170 the request will fail.
171 If the device is already attached and
174 the device will be detached from its current device driver before it is
175 attached to the new device driver.
178 .Fn devctl_clear_driver
179 function resets a device so that it can be attached to any valid device
180 driver rather than only drivers with a previously specified name.
181 This function is used to undo a previous call to
182 .Fn devctl_set_driver .
183 If the device is already attached and
186 the request will fail.
187 If the device is already attached and
190 the device will be detached from its current device driver.
191 After the device's name is reset,
192 it is reprobed and attached to a suitable device driver if one is found.
196 function rescans a bus device checking for devices that have been added or
201 function freezes probe and attach processing initiated in response to
202 drivers being loaded.
206 function resumes (thaws the freeze) probe and attach processing
207 initiated in response to drivers being loaded.
209 .Rv -std devctl_attach devctl_clear_driver devctl_delete devctl_detach \
210 devctl_disable devctl_enable devctl_suspend devctl_rescan devctl_resume \
213 In addition to specific errors noted below,
216 functions may fail for any of the errors described in
221 The device name is too long.
223 No existing device matches the specified name or location.
225 The current process is not permitted to adjust the state of
231 function may fail if:
234 The device is already attached.
236 An internal memory allocation request failed.
238 The device is disabled.
240 No suitable driver for the device could be found,
241 or the driver failed to attach.
246 function may fail if:
249 The current device driver for
251 is busy and cannot detach at this time.
252 Note that some drivers may return this even if
256 The device is not attached to a driver.
258 The current device driver for
260 does not support detaching.
265 function may fail if:
268 The device is already enabled.
270 An internal memory allocation request failed.
272 No suitable driver for the device could be found,
273 or the driver failed to attach.
278 function may fail if:
281 The current device driver for
283 is busy and cannot detach at this time.
284 Note that some drivers may return this even if
288 The device is already disabled.
290 The current device driver for
292 does not support detaching.
297 function may fail if:
300 The device is already suspended.
302 The device to be suspended is the root bus device.
307 function may fail if:
310 The device is not suspended.
312 The device to be resumed is the root bus device.
316 .Fn devctl_set_driver
317 function may fail if:
320 The device is currently attached to a device driver and
324 The current device driver for
326 is busy and cannot detach at this time.
330 argument points outside the process' allocated address space.
332 No device driver with the requested name exists.
334 An internal memory allocation request failed.
336 The device is disabled.
338 The new device driver failed to attach.
342 .Fn devctl_clear_driver
343 function may fail if:
346 The device is currently attached to a device driver and
350 The current device driver for
352 is busy and cannot detach at this time.
354 The device is not configured for a specific device driver name.
356 The device driver chosen after reprobing failed to attach.
361 function may fail if:
364 The device is not attached to a driver.
366 The bus driver does not support rescanning.
371 function may fail if:
374 The device is physically present and
379 is the root device of the device tree.
388 library first appeared in
391 If a device is suspended individually via
393 and the entire machine is subsequently suspended,
394 the device will be resumed when the machine resumes.