xref: /freebsd/share/man/man9/DEVICE_ATTACH.9 (revision 1a720cbec513210fa2e85c3882741ef2f6dc5f35)
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 DEVICE_ATTACH 9
31.Os
32.Sh NAME
33.Nm DEVICE_ATTACH
34.Nd attach a device
35.Sh SYNOPSIS
36.In sys/param.h
37.In sys/bus.h
38.Ft int
39.Fn DEVICE_ATTACH "device_t dev"
40.Sh DESCRIPTION
41Attach a device to the system after the
42.Fn DEVICE_PROBE
43method has been called and has indicated that
44the device exists.
45The
46.Fn DEVICE_ATTACH
47method should initialize the hardware and allocate other
48system resources (such as
49.Xr devfs 4
50entries).
51.Pp
52Devices which implement buses should use this method to probe for
53the existence of devices attached to the bus and add them as
54children.
55If this is combined with the use of
56.Xr bus_generic_attach 9
57the child devices will be automatically probed and attached.
58.Sh RETURN VALUES
59Zero is returned on success, otherwise an appropriate error is returned.
60.Sh SEE ALSO
61.Xr devfs 4 ,
62.Xr device 9 ,
63.Xr DEVICE_DETACH 9 ,
64.Xr DEVICE_IDENTIFY 9 ,
65.Xr DEVICE_PROBE 9 ,
66.Xr DEVICE_SHUTDOWN 9
67.Sh AUTHORS
68This manual page was written by
69.An Doug Rabson Aq Mt dfr@FreeBSD.org .
70