xref: /freebsd/share/man/man9/bus_generic_shutdown.9 (revision 8c2f6c3be0125142d3c1782e4b0ee0634c584b9e)
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 January 15, 2017
30.Dt BUS_GENERIC_SHUTDOWN 9
31.Os
32.Sh NAME
33.Nm bus_generic_shutdown
34.Nd generic implementation of
35.Dv DEVICE_SHUTDOWN
36for buses
37.Sh SYNOPSIS
38.In sys/param.h
39.In sys/bus.h
40.Ft int
41.Fn bus_generic_shutdown "device_t dev"
42.Sh DESCRIPTION
43This function provides an implementation of the
44.Xr DEVICE_SHUTDOWN 9
45method
46which can be used by most bus code.
47It simply calls the
48.Xr DEVICE_SHUTDOWN 9
49method of each child device attached to the bus.
50.Sh RETURN VALUES
51Zero is returned on success, otherwise an appropriate error is returned.
52.Sh SEE ALSO
53.Xr device 9 ,
54.Xr driver 9
55.Sh AUTHORS
56This manual page was written by
57.An Doug Rabson .
58