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
39 .Nd device control library
45 .Fn devctl_attach "const char *device"
47 .Fn devctl_detach "const char *device" "bool force"
49 .Fn devctl_disable "const char *device" "bool force_detach"
51 .Fn devctl_enable "const char *device"
53 .Fn devctl_resume "const char *device"
55 .Fn devctl_suspend "const char *device"
57 .Fn devctl_set_driver "const char *device" "const char *driver" "bool force"
61 library adjusts the state of devices in the kernel's internal device
63 Each control operation accepts a
65 argument that identifies the device to adjust.
68 may be specified as either the name of an existing device or as a
70 The following bus-specific address formats are currently supported:
71 .Bl -tag -offset indent
72 .It Sy pci Ns Fa domain Ns : Ns Fa bus Ns : Ns Fa slot Ns : Ns Fa function
73 A PCI device with the specified
79 .It Sy pci Ns Fa bus Ns : Ns Fa slot Ns : Ns Fa function
80 A PCI device in domain zero with the specified
86 A device with an ACPI handle of
88 The handle must be specified as an absolute path and must begin with a
94 function probes a device and attaches a suitable device driver if one is
99 function detaches a device from its current device driver.
100 The device is left detached until either a new driver for its parent
101 bus is loaded or the device is explicitly probed via
106 the current device driver will be detached even if the device is busy.
110 function disables a device.
111 If the device is currently attached to a device driver,
112 the device driver will be detached from the device,
113 but the device will retain its current name.
117 the current device driver will be detached even if the device is busy.
118 The device will remain disabled and detached until it is explicitly enabled
124 function re-enables a disabled device.
125 The device will probe and attach if a suitable device driver is found.
129 function suspends a device.
130 This may include placing the device in a reduced power state,
131 but any device driver currently attached to the device will remain attached.
135 function resumes a suspended device to a fully working state.
138 .Fn devctl_set_driver
139 function attaches a device driver named
142 If the device is already attached and
145 the request will fail.
146 If the device is already attached and
149 the device will be detached from its current device driver before it is
150 attached to the new device driver.
152 .Rv -std devctl_attach devctl_detach devctl_disable devctl_enable \
153 devctl_suspend devctl_resume devctl_set_driver
155 In addition to specific errors noted below,
158 functions may fail for any of the errors described in
163 The device name is too long.
165 No existing device matches the specified name or location.
167 The current process is not permitted to adjust the state of
173 function may fail if:
176 The device is already attached.
178 An internal memory allocation request failed.
180 The device is disabled.
182 No suitable driver for the device could be found,
183 or the driver failed to attach.
188 function may fail if:
191 The current device driver for
193 is busy and cannot detach at this time.
194 Note that some drivers may return this even if
198 The device is not attached to a driver.
200 The current device driver for
202 does not support detaching.
207 function may fail if:
210 The device is already enabled.
212 An internal memory allocation request failed.
214 No suitable driver for the device could be found,
215 or the driver failed to attach.
220 function may fail if:
223 The current device driver for
225 is busy and cannot detach at this time.
226 Note that some drivers may return this even if
230 The device is already disabled.
232 The current device driver for
234 does not support detaching.
239 function may fail if:
242 The device is already suspended.
244 The device to be suspended is the root bus device.
249 function may fail if:
252 The device is not suspended.
254 The device to be resumed is the root bus device.
258 .Fn devctl_set_driver
259 function may fail if:
262 The device is currently attached to a device driver and
266 The current device driver for
268 is busy and cannot detach at this time.
272 argument points outside the process' allocated address space.
274 No device driver with the requested name exists.
276 An internal memory allocation request failed.
278 The device is disabled.
280 The new device driver failed to attach.
289 library first appeared in
292 If a device is suspended individually via
294 and the entire machine is subsequently suspended,
295 the device will be resumed when the machine resumes.