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 November 3, 2010
  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 that will not execute any potentially
  89 blocking operation, use the
  90 .Fa filter
  91 argument.
  92 See the
  93 .Sx "Filter Routines"
  94 section below for information on writing a filter.
  95 Otherwise, use the
  96 .Fa ithread
  97 argument.
  98 The defined handler
  99 will be called with the value
 100 .Fa arg
 101 as its only argument.
 102 See the
 103 .Sx "ithread Routines"
 104 section below for more information on writing an interrupt handler.
 105 .Pp
 106 The
 107 .Fa cookiep
 108 argument is a pointer to a
 109 .Vt "void *"
 110 that
 111 .Fn BUS_SETUP_INTR
 112 will write a cookie for the parent bus' use to if it is successful in
 113 establishing an interrupt.
 114 Driver writers may assume that this cookie will be non-zero.
 115 The nexus driver will write 0 on failure to
 116 .Fa cookiep .
 117 .Pp
 118 The interrupt handler will be detached by
 119 .Fn BUS_TEARDOWN_INTR .
 120 The cookie needs to be passed to
 121 .Fn BUS_TEARDOWN_INTR
 122 in order to tear down the correct interrupt handler.
 123 Once
 124 .Fn BUS_TEARDOWN_INTR
 125 returns, it is guaranteed that the interrupt function is not active and
 126 will no longer be called.
 127 .Pp
 128 Mutexes are not allowed to be held across calls to these functions.
 129 .Ss "Filter Routines"
 130 A filter runs in primary interrupt context.
 131 In this context, normal mutexes cannot be used.
 132 Only the spin lock version of these can be used (specified by passing
 133 .Dv MTX_SPIN
 134 to
 135 .Fn mtx_init
 136 when initializing the mutex).
 137 .Xr wakeup 9
 138 and similar routines can be called.
 139 Atomic operations from
 140 .Pa machine/atomic
 141 may be used.
 142 Reads and writes to hardware through
 143 .Xr bus_space 9
 144 may be used.
 145 PCI configuration registers may be read and written.
 146 All other kernel interfaces cannot be used.
 147 .Pp
 148 In this restricted environment, care must be taken to account for all
 149 races.
 150 A careful analysis of races should be done as well.
 151 It is generally cheaper to take an extra interrupt, for example, than
 152 to protect variables with spinlocks.
 153 Read, modify, write cycles of hardware registers need to be carefully
 154 analyzed if other threads are accessing the same registers.
 155 .Pp
 156 Generally, a filter routine will use one of two strategies.
 157 The first strategy is to simply mask the interrupt in hardware and
 158 allow the
 159 .Dv ithread
 160 routine to read the state from the hardware and then reenable
 161 interrupts.
 162 The
 163 .Dv ithread
 164 also acknowledges the interrupt before re-enabling the interrupt
 165 source in hardware.
 166 Most PCI hardware can mask its interrupt source.
 167 .Pp
 168 The second common approach is to use a filter with multiple
 169 .Xr taskqueue 9
 170 tasks.
 171 In this case, the filter acknowledges the interrupts and queues the
 172 work to the appropriate taskqueue.
 173 Where one has to multiplex different kinds of interrupt sources, like
 174 a network card's transmit and receive paths, this can reduce lock
 175 contention and increase performance.
 176 .Pp
 177 You should not
 178 .Xr malloc 9
 179 from inside a filter.
 180 You may not call anything that uses a normal mutex.
 181 Witness may complain about these.
 182 .Ss "ithread Routines"
 183 You can do whatever you want in an ithread routine, except sleep.
 184 Care must be taken not to sleep in an ithread.
 185 In addition, one should minimize lock contention in an ithread routine
 186 because contested locks ripple over to all other ithread routines on
 187 that interrupt.
 188 .Ss "Sleeping"
 189 Sleeping is voluntarily giving up control of your thread.
 190 All the sleep routine found in
 191 .Xr msleep 9
 192 sleep.
 193 Waiting for a condition variable described in
 194 .Xr condvar 9
 195 is sleeping.
 196 Calling any function that does any of these things is sleeping.
 197 .Sh RETURN VALUES
 198 Zero is returned on success,
 199 otherwise an appropriate error is returned.
 200 .Sh SEE ALSO
 201 .Xr random 4 ,
 202 .Xr device 9 ,
 203 .Xr driver 9 ,
 204 .Xr locking 9
 205 .Sh AUTHORS
 206 .An -nosplit
 207 This manual page was written by
 208 .An Jeroen Ruigrok van der Werven
 209 .Aq asmodai@FreeBSD.org
 210 based on the manual pages for
 211 .Fn BUS_CREATE_INTR
 212 and
 213 .Fn BUS_CONNECT_INTR
 214 written by
 215 .An Doug Rabson
 216 .Aq dfr@FreeBSD.org .