Initial import from FreeBSD RELENG_4:
[games.git] / share / man / man9 / DEVICE_DETACH.9
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: src/share/man/man9/DEVICE_DETACH.9,v 1.3.2.5 2001/12/17 11:30:18 ru Exp $
30 .\"
31 .Dd June 16, 1998
32 .Dt DEVICE_DETACH 9
33 .Os
34 .Sh NAME
35 .Nm DEVICE_DETACH
36 .Nd detach a device
37 .Sh SYNOPSIS
38 .In sys/param.h
39 .In sys/bus.h
40 .Ft int
41 .Fn DEVICE_DETACH "device_t dev"
42 .Sh DESCRIPTION
43 Detach a device.  This can be called if the user is replacing the
44 driver software or if a device is about to be physically removed from
45 the system (e.g. for pccard devices).
46 .Pp
47 The method should deallocate any system resources allocated during the
48 .Xr DEVICE_ATTACH 9
49 method and reset the hardware to a sane state (i.e. disable interrupts
50 etc.)
51 .Sh RETURN VALUES
52 Zero is returned on success, otherwise an appropriate error is returned.
53 .Sh SEE ALSO
54 .Xr device 9 ,
55 .Xr DEVICE_ATTACH 9
56 .Sh AUTHORS
57 This man page was written by
58 .An Doug Rabson .