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.Dt BUS_SETUP_INTR 9 29.Os 30.Sh NAME 31.Nm BUS_SETUP_INTR , 32.Nm bus_setup_intr , 33.Nm BUS_TEARDOWN_INTR , 34.Nm bus_teardown_intr 35.Nd create, attach and teardown an interrupt handler 36.Sh SYNOPSIS 37.In sys/param.h 38.In sys/bus.h 39.Ft int 40.Fn BUS_SETUP_INTR "device_t dev" "device_t child" "struct resource *irq" "int flags" "driver_intr_t *intr" "void *arg" "void **cookiep" 41.Ft int 42.Fn bus_setup_intr "device_t dev" "struct resource *r" "int flags" "driver_intr_t handler" "void *arg" "void **cookiep" 43.Ft int 44.Fn BUS_TEARDOWN_INTR "device_t dev" "device_t child" "struct resource *irq" "void *cookiep" 45.Ft int 46.Fn bus_teardown_intr "device_t dev" "struct resource *r" "void *cookiep" 47.Sh DESCRIPTION 48The method 49.Nm 50will create and attach an interrupt handler to an interrupt 51previously allocated by the resource manager's 52.Xr BUS_ALLOC_RESOURCE 9 53method. 54The 55.Fa flags 56are found in 57.Aq Pa sys/bus.h , 58and give the broad category of interrupt. 59The 60.Fa flags 61also tell the interrupt handlers the about certain 62device driver characteristics. 63.Dv INTR_FAST 64means the handler is for a timing-critical function. 65Extra care is take to speed up these handlers. 66Use of this implies 67.Dv INTR_EXCL . 68.Dv INTR_EXCL 69marks the handler as being 70an exclusive handler for this interrupt. 71.Dv INTR_MPSAFE 72tells the scheduler that the interrupt handler 73is well behaved in a preemptive environment 74(``SMP safe''), 75and does not need 76to be protected by the ``Giant Lock'' mutex. 77.Dv INTR_ENTROPY 78marks the interrupt as being a good source of entropy - 79this may be used by the entropy device 80.Pa /dev/random . 81The handler 82.Fa intr 83will be called with the value 84.Fa arg 85as its only argument. 86.Pp 87The interrupt handler will be detached by 88.Fn BUS_TEARDOWN_INTR . 89The cookie needs to be passed to 90.Fn BUS_TEARDOWN_INTR 91in order to tear down the correct interrupt handler. 92.Sh RETURN VALUES 93Zero is returned on success, 94otherwise an appropriate error is returned. 95.Sh SEE ALSO 96.Xr random 4 , 97.Xr device 9 , 98.Xr driver 9 99.Sh AUTHORS 100.An -nosplit 101This man page was written by 102.An Jeroen Ruigrok van der Werven 103.Aq asmodai@FreeBSD.org 104based on the man pages for BUS_CREATE_INTR and BUS_CONNECT_INTR written by 105.An Doug Rabson 106.Aq dfr@FreeBSD.org . 107