xref: /freebsd/share/man/man9/BUS_RESCAN.9 (revision 61ba55bcf70f2340f9c943c9571113b3fd8eda69)
1.\" -*- nroff -*-
2.\"
3.\" Copyright (c) 2016 John H. Baldwin <jhb@FreeBSD.org>
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
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.
13.\"
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
24.\" SUCH DAMAGE.
25.\"
26.Dd April 27, 2016
27.Dt BUS_RESCAN 9
28.Os
29.Sh NAME
30.Nm BUS_RESCAN
31.Nd "rescan a bus checking for devices that have been added or removed"
32.Sh SYNOPSIS
33.In sys/param.h
34.In sys/bus.h
35.Ft void
36.Fn BUS_RESCAN "device_t dev"
37.Sh DESCRIPTION
38The
39.Fn BUS_RESCAN
40method is called to request a rescan of the child devices on a bus device.
41The method should add any devices that have been added since the previous
42scan and remove devices that have been removed.
43This method is not required to re-examine existing devices to determine if
44their properties have changed.
45This method is also not required to propagate the rescan request to child
46devices.
47.Sh SEE ALSO
48.Xr device 9
49