xref: /freebsd/share/man/man9/bus_generic_detach.9 (revision b670c9bafc0e31c7609969bf374b2e80bdc00211)
1.\" -*- nroff -*-
2.\"
3.\" Copyright (c) 1998 Doug Rabson
4.\"
5.\" All rights reserved.
6.\"
7.\" This program is free software.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
19.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
22.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28.\"
29.Dd February 5, 2025
30.Dt BUS_GENERIC_DETACH 9
31.Os
32.Sh NAME
33.Nm bus_generic_detach
34.Nd generic implementation of
35.Dv DEVICE_DETACH
36for buses
37.Sh SYNOPSIS
38.In sys/param.h
39.In sys/bus.h
40.Ft int
41.Fn bus_generic_detach "device_t dev"
42.Sh DESCRIPTION
43This function provides an implementation of the
44.Xr DEVICE_DETACH 9
45method
46which can be used by most bus code.
47It uses
48.Xr bus_detach_children 9
49to detach drivers from all child devices giving them a chance to veto the
50detach request.
51If
52.Fn bus_detach_children
53succeeds,
54.Fn bus_generic_detach
55calls
56.Xr device_delete_children 9
57to delete all child devices.
58.Sh RETURN VALUES
59Zero is returned on success, otherwise an appropriate error is returned.
60.Sh SEE ALSO
61.Xr bus_detach_children 9 ,
62.Xr device 9 ,
63.Xr device_delete_children 9 ,
64.Xr driver 9
65.Sh AUTHORS
66This manual page was written by
67.An Doug Rabson .
68