share/man/man9/BUS_SETUP_INTR.9

   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 December 18, 2007
  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 .Fo BUS_SETUP_INTR
  41 .Fa "device_t dev" "device_t child" "struct resource *irq" "int flags"
  42 .Fa "driver_filter_t *filter" "driver_intr_t *ithread" "void *arg"
  43 .Fa "void **cookiep"
  44 .Fc
  45 .Ft int
  46 .Fo bus_setup_intr
  47 .Fa "device_t dev" "struct resource *r" "int flags"
  48 .Fa "driver_filter_t filter" "driver_intr_t ithread" "void *arg"
  49 .Fa "void **cookiep"
  50 .Fc
  51 .Ft int
  52 .Fo BUS_TEARDOWN_INTR
  53 .Fa "device_t dev" "device_t child" "struct resource *irq" "void *cookiep"
  54 .Fc
  55 .Ft int
  56 .Fn bus_teardown_intr "device_t dev" "struct resource *r" "void *cookiep"
  57 .Sh DESCRIPTION
  58 The
  59 .Fn BUS_SETUP_INTR
  60 method
  61 will create and attach an interrupt handler to an interrupt
  62 previously allocated by the resource manager's
  63 .Xr BUS_ALLOC_RESOURCE 9
  64 method.
  65 The
  66 .Fa flags
  67 are found in
  68 .In sys/bus.h ,
  69 and give the broad category of interrupt.
  70 The
  71 .Fa flags
  72 also tell the interrupt handlers about certain
  73 device driver characteristics.
  74 .Dv INTR_EXCL
  75 marks the handler as being
  76 an exclusive handler for this interrupt.
  77 .Dv INTR_MPSAFE
  78 tells the scheduler that the interrupt handler
  79 is well behaved in a preemptive environment
  80 (``SMP safe''),
  81 and does not need
  82 to be protected by the ``Giant Lock'' mutex.
  83 .Dv INTR_ENTROPY
  84 marks the interrupt as being a good source of entropy -
  85 this may be used by the entropy device
  86 .Pa /dev/random .
  87 .Pp
  88 To define a time-critical handler (previously known as
  89 .Dv INTR_FAST )
  90 that will not execute any potentially blocking operation, use the
  91 .Fa filter
  92 argument.
  93 See the
  94 .Sx "Filter Routines"
  95 section below for information on writing a filter.
  96 Otherwise, use the
  97 .Fa ithread
  98 argument.
  99 The defined handler
 100 will be called with the value
 101 .Fa arg
 102 as its only argument.
 103 See the
 104 .Sx "ithread Routines"
 105 section below for more information on writing an interrupt handler.
 106 .Pp
 107 The
 108 .Fa cookiep
 109 argument is a pointer to a
 110 .Vt "void *"
 111 that
 112 .Fn BUS_SETUP_INTR
 113 will write a cookie for the parent bus' use to if it is successful in
 114 establishing an interrupt.
 115 Driver writers may assume that this cookie will be non-zero.
 116 The nexus driver will write 0 on failure to
 117 .Fa cookiep .
 118 .Pp
 119 The interrupt handler will be detached by
 120 .Fn BUS_TEARDOWN_INTR .
 121 The cookie needs to be passed to
 122 .Fn BUS_TEARDOWN_INTR
 123 in order to tear down the correct interrupt handler.
 124 Once
 125 .Fn BUS_TEARDOWN_INTR
 126 returns, it is guaranteed that the interrupt function is not active and
 127 will no longer be called.
 128 .Pp
 129 Mutexes are not allowed to be held across calls to these functions.
 130 .Ss "Filter Routines"
 131 A filter runs in a context very similar to what was known as an
 132 .Dv INTR_FAST
 133 routine in previous versions of
 134 .Fx .
 135 In this context, normal mutexes cannot be used.
 136 Only the spin lock version of these can be used (specified by passing
 137 .Dv MTX_SPIN
 138 to
 139 .Fn mtx_init
 140 when initializing the mutex).
 141 .Xr wakeup 9
 142 and similar routines can be called.
 143 Atomic operations from
 144 .Pa machine/atomic
 145 may be used.
 146 Reads and writes to hardware through
 147 .Xr bus_space 9
 148 may be used.
 149 PCI configuration registers may be read and written.
 150 All other kernel interfaces cannot be used.
 151 .Pp
 152 In this restricted environment, care must be taken to account for all
 153 races.
 154 A careful analysis of races should be done as well.
 155 It is generally cheaper to take an extra interrupt, for example, than
 156 to protect variables with spinlocks.
 157 Read, modify, write cycles of hardware registers need to be carefully
 158 analyzed if other threads are accessing the same registers.
 159 .Pp
 160 Generally, a filter routine will use one of two strategies.
 161 The first strategy is to simply mask the interrupt in hardware and
 162 allow the
 163 .Dv ithread
 164 routine to read the state from the hardware and then reenable
 165 interrupts.
 166 The
 167 .Dv ithread
 168 also acknowledges the interrupt before re-enabling the interrupt
 169 source in hardware.
 170 Most PCI hardware can mask its interrupt source.
 171 .Pp
 172 The second common approach is to use a filter with multiple
 173 .Xr taskqueue 9
 174 tasks.
 175 In this case, the filter acknowledges the interrupts and queues the
 176 work to the appropriate taskqueue.
 177 Where one has to multiplex different kinds of interrupt sources, like
 178 a network card's transmit and receive paths, this can reduce lock
 179 contention and increase performance.
 180 .Pp
 181 You should not
 182 .Xr malloc 9
 183 from inside a filter.
 184 You may not call anything that uses a normal mutex.
 185 Witness may complain about these.
 186 .Ss "ithread Routines"
 187 You can do whatever you want in an ithread routine, except sleep.
 188 Care must be taken not to sleep in an ithread.
 189 In addition, one should minimize lock contention in an ithread routine
 190 because contested locks ripple over to all other ithread routines on
 191 that interrupt.
 192 .Ss "Sleeping"
 193 Sleeping is voluntarily giving up control of your thread.
 194 All the sleep routine found in
 195 .Xr msleep 9
 196 sleep.
 197 Waiting for a condition variable described in
 198 .Xr condvar 9
 199 is sleeping.
 200 Calling any function that does any of these things is sleeping.
 201 .Sh RETURN VALUES
 202 Zero is returned on success,
 203 otherwise an appropriate error is returned.
 204 .Sh SEE ALSO
 205 .Xr random 4 ,
 206 .Xr device 9 ,
 207 .Xr driver 9 ,
 208 .Xr mtx_init 9 ,
 209 .Xr wakeup 9
 210 .Sh AUTHORS
 211 .An -nosplit
 212 This manual page was written by
 213 .An Jeroen Ruigrok van der Werven
 214 .Aq asmodai@FreeBSD.org
 215 based on the manual pages for
 216 .Fn BUS_CREATE_INTR
 217 and
 218 .Fn BUS_CONNECT_INTR
 219 written by
 220 .An Doug Rabson
 221 .Aq dfr@FreeBSD.org .