xref: /dragonfly/share/man/man9/BUS_SETUP_INTR.9 (revision 9dbf638f)
1.\" Copyright (c) 2000 Jeroen Ruigrok van der Werven
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD: src/share/man/man9/BUS_SETUP_INTR.9,v 1.1.2.6 2001/12/17 11:30:18 ru Exp $
26.\" $DragonFly: src/share/man/man9/BUS_SETUP_INTR.9,v 1.2 2003/06/17 04:37:01 dillon Exp $
27.\"
28.Dd April 2, 2000
29.Dt BUS_SETUP_INTR 9
30.Os
31.Sh NAME
32.Nm BUS_SETUP_INTR
33.Nd create and attach to an interrupt handler
34.Sh SYNOPSIS
35.In sys/param.h
36.In sys/bus.h
37.Ft int
38.Fn BUS_SETUP_INTR "device_t dev" "device_t child" "struct resource *irq" "int flags" "driver_intr_t *intr" "void *arg" "void **cookiep"
39.Sh DESCRIPTION
40The method
41.Nm
42will create and attach an interrupt handler to an interrupt
43previously allocated by the resource manager's
44.Xr BUS_ALLOC_RESOURCE 9
45method.
46The handler
47.Fa intr
48will be called with the value
49.Fa arg
50as its only argument.
51.Pp
52The interrupt handler will be detached by
53.Fn BUS_TEARDOWN_INTR .
54The cookie needs to be passed to
55.Fn BUS_TEARDOWN_INTR
56in order to tear down the correct interrupt handler.
57.Sh RETURN VALUES
58Zero is returned on success,
59otherwise an appropriate error is returned.
60.Sh SEE ALSO
61.Xr BUS_TEARDOWN_INTR 9 ,
62.Xr device 9 ,
63.Xr driver 9
64.Sh AUTHORS
65.An -nosplit
66This man page was written by
67.An Jeroen Ruigrok van der Werven
68.Aq asmodai@FreeBSD.org
69based on the manpages for BUS_CREATE_INTR and BUS_CONNECT_INTR written by
70.An Doug Rabson
71.Aq dfr@FreeBSD.org .
72