xref: /freebsd/share/man/man9/BUS_SETUP_INTR.9 (revision 23f282aa31e9b6fceacd449020e936e98d6f2298)
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$
26.\"
27.Dd April 2, 2000
28.Os
29.Dt BUS_SETUP_INTR 9
30.Os FreeBSD
31.Sh NAME
32.Nm BUS_SETUP_INTR
33.Nd create and attach to an interrupt handler
34.Sh SYNOPSIS
35.Fd #include <sys/param.h>
36.Fd #include <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
40.Pp
41The method
42.Nm
43will create and attach an interrupt handler to an interrupt
44previously allocated by the resource manager's
45.Xr BUS_ALLOC_RESOURCE 9
46method.
47The handler
48.Fa intr
49will be called with the value
50.Fa arg
51as its only argument.
52.Pp
53The interrupt handler will be detached by
54.Fn BUS_TEARDOWN_INTR .
55The cookie needs to be passed to
56.Fn BUS_TEARDOWN_INTR
57in order to tear down the correct interrupt handler.
58.Sh RETURN VALUES
59Zero is returned on success,
60otherwise an appropriate error is returned.
61.Sh SEE ALSO
62.Xr BUS_TEARDOWN_INTR 9 ,
63.Xr device 9 ,
64.Xr driver 9
65.Sh AUTHORS
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