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