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.3 2005/12/20 13:16:14 swildner Exp $ 27.\" 28.Dd December 20, 2005 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" "lwkt_serialize_t serializer" 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 52Interrupt flags are typically either 53.Li 0 54or 55.Dv INTR_MPSAFE . 56If 57.Dv INTR_MPSAFE 58is specified the kernel is free to call the interrupt handler without 59holding the MP lock. 60.Dv INTR_FAST 61is also sometimes specified and allows the 62interrupt handler to be directly called from the context of the thread 63being interrupted, but is not recommended for most drivers. 64Other interrupt flags exist for special purposes. 65.Pp 66If 67.Fa serializer 68is non-NULL the interrupt handler will be called with the serializer held. 69The serializer replaces the obsolete SPL calls that are no longer relevant on 70SMP systems. 71Driver code can obtain the same serializer to interlock against 72the driver interrupt. 73The serializer also has enablement and disablement 74features which mainline driver code can use to avoid races between interrupt 75disablement and delayed interrupts executing from the device's interrupt 76thread. 77.Pp 78The interrupt handler will be detached by 79.Fn BUS_TEARDOWN_INTR . 80The cookie will be stored in the pointer 81.Fa *cookiep 82and needs to be passed to 83.Fn BUS_TEARDOWN_INTR 84in order to tear down the correct interrupt handler. 85.Sh RETURN VALUES 86Zero is returned on success, 87otherwise an appropriate error is returned. 88.Sh SEE ALSO 89.Xr BUS_TEARDOWN_INTR 9 , 90.Xr device 9 , 91.Xr driver 9 92.Sh AUTHORS 93.An -nosplit 94This man page was written by 95.An Jeroen Ruigrok van der Werven 96.Aq asmodai@FreeBSD.org 97based on the manpages for BUS_CREATE_INTR and BUS_CONNECT_INTR written by 98.An Doug Rabson 99.Aq dfr@FreeBSD.org . 100