sys/sys/interrupt.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 1997, Stefan Esser <se@freebsd.org>
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice unmodified, this list of conditions, and the following
  12  *    disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 #ifndef _SYS_INTERRUPT_H_
  32 #define _SYS_INTERRUPT_H_
  33
  34 #include <sys/_lock.h>
  35 #include <sys/_mutex.h>
  36
  37 struct intr_event;
  38 struct intr_thread;
  39 struct trapframe;
  40
  41 /*
  42  * Describe a hardware interrupt handler.
  43  *
  44  * Multiple interrupt handlers for a specific event can be chained
  45  * together.
  46  */
  47 struct intr_handler {
  48         driver_filter_t *ih_filter;     /* Filter handler function. */
  49         driver_intr_t   *ih_handler;    /* Threaded handler function. */
  50         void            *ih_argument;   /* Argument to pass to handlers. */
  51         int              ih_flags;
  52         char             ih_name[MAXCOMLEN + 1]; /* Name of handler. */
  53         struct intr_event *ih_event;    /* Event we are connected to. */
  54         int              ih_need;       /* Needs service. */
  55         TAILQ_ENTRY(intr_handler) ih_next; /* Next handler for this event. */
  56         u_char           ih_pri;        /* Priority of this handler. */
  57         struct intr_thread *ih_thread;  /* Ithread for filtered handler. */
  58 };
  59
  60 /* Interrupt handle flags kept in ih_flags */
  61 #define IH_EXCLUSIVE    0x00000002      /* Exclusive interrupt. */
  62 #define IH_ENTROPY      0x00000004      /* Device is a good entropy source. */
  63 #define IH_DEAD         0x00000008      /* Handler should be removed. */
  64 #define IH_MPSAFE       0x80000000      /* Handler does not need Giant. */
  65
  66 /*
  67  * Describe an interrupt event.  An event holds a list of handlers.
  68  * The 'pre_ithread', 'post_ithread', 'post_filter', and 'assign_cpu'
  69  * hooks are used to invoke MD code for certain operations.
  70  *
  71  * The 'pre_ithread' hook is called when an interrupt thread for
  72  * handlers without filters is scheduled.  It is responsible for
  73  * ensuring that 1) the system won't be swamped with an interrupt
  74  * storm from the associated source while the ithread runs and 2) the
  75  * current CPU is able to receive interrupts from other interrupt
  76  * sources.  The first is usually accomplished by disabling
  77  * level-triggered interrupts until the ithread completes.  The second
  78  * is accomplished on some platforms by acknowledging the interrupt
  79  * via an EOI.
  80  *
  81  * The 'post_ithread' hook is invoked when an ithread finishes.  It is
  82  * responsible for ensuring that the associated interrupt source will
  83  * trigger an interrupt when it is asserted in the future.  Usually
  84  * this is implemented by enabling a level-triggered interrupt that
  85  * was previously disabled via the 'pre_ithread' hook.
  86  *
  87  * The 'post_filter' hook is invoked when a filter handles an
  88  * interrupt.  It is responsible for ensuring that the current CPU is
  89  * able to receive interrupts again.  On some platforms this is done
  90  * by acknowledging the interrupts via an EOI.
  91  *
  92  * The 'assign_cpu' hook is used to bind an interrupt source to a
  93  * specific CPU.  If the interrupt cannot be bound, this function may
  94  * return an error.
  95  *
  96  * Note that device drivers may also use interrupt events to manage
  97  * multiplexing interrupt interrupt handler into handlers for child
  98  * devices.  In that case, the above hooks are not used.  The device
  99  * can create an event for its interrupt resource and register child
 100  * event handlers with that event.  It can then use
 101  * intr_event_execute_handlers() to execute non-filter handlers.
 102  * Currently filter handlers are not supported by this, but that can
 103  * be added by splitting out the filter loop from intr_event_handle()
 104  * if desired.
 105  */
 106 struct intr_event {
 107         TAILQ_ENTRY(intr_event) ie_list;
 108         TAILQ_HEAD(, intr_handler) ie_handlers; /* Interrupt handlers. */
 109         char            ie_name[MAXCOMLEN + 1]; /* Individual event name. */
 110         char            ie_fullname[MAXCOMLEN + 1];
 111         struct mtx      ie_lock;
 112         void            *ie_source;     /* Cookie used by MD code. */
 113         struct intr_thread *ie_thread;  /* Thread we are connected to. */
 114         void            (*ie_pre_ithread)(void *);
 115         void            (*ie_post_ithread)(void *);
 116         void            (*ie_post_filter)(void *);
 117         int             (*ie_assign_cpu)(void *, int);
 118         int             ie_flags;
 119         int             ie_count;       /* Loop counter. */
 120         int             ie_warncnt;     /* Rate-check interrupt storm warns. */
 121         struct timeval  ie_warntm;
 122         int             ie_irq;         /* Physical irq number if !SOFT. */
 123         int             ie_cpu;         /* CPU this event is bound to. */
 124 };
 125
 126 /* Interrupt event flags kept in ie_flags. */
 127 #define IE_SOFT         0x000001        /* Software interrupt. */
 128 #define IE_ENTROPY      0x000002        /* Interrupt is an entropy source. */
 129 #define IE_ADDING_THREAD 0x000004       /* Currently building an ithread. */
 130
 131 /* Flags to pass to sched_swi. */
 132 #define SWI_DELAY       0x2
 133
 134 /*
 135  * Software interrupt numbers in priority order.  The priority determines
 136  * the priority of the corresponding interrupt thread.
 137  */
 138 #define SWI_TTY         0
 139 #define SWI_NET         1
 140 #define SWI_CAMBIO      2
 141 #define SWI_VM          3
 142 #define SWI_CLOCK       4
 143 #define SWI_TQ_FAST     5
 144 #define SWI_TQ          6
 145 #define SWI_TQ_GIANT    6
 146
 147 struct proc;
 148
 149 extern struct   intr_event *tty_intr_event;
 150 extern struct   intr_event *clk_intr_event;
 151 extern void     *vm_ih;
 152
 153 /* Counts and names for statistics (defined in MD code). */
 154 extern u_long   intrcnt[];      /* counts for for each device and stray */
 155 extern char     intrnames[];    /* string table containing device names */
 156 extern size_t   sintrcnt;       /* size of intrcnt table */
 157 extern size_t   sintrnames;     /* size of intrnames table */
 158
 159 #ifdef DDB
 160 void    db_dump_intr_event(struct intr_event *ie, int handlers);
 161 #endif
 162 u_char  intr_priority(enum intr_type flags);
 163 int     intr_event_add_handler(struct intr_event *ie, const char *name,
 164             driver_filter_t filter, driver_intr_t handler, void *arg,
 165             u_char pri, enum intr_type flags, void **cookiep);
 166 int     intr_event_bind(struct intr_event *ie, int cpu);
 167 int     intr_event_bind_irqonly(struct intr_event *ie, int cpu);
 168 int     intr_event_bind_ithread(struct intr_event *ie, int cpu);
 169 int     intr_event_create(struct intr_event **event, void *source,
 170             int flags, int irq, void (*pre_ithread)(void *),
 171             void (*post_ithread)(void *), void (*post_filter)(void *),
 172             int (*assign_cpu)(void *, int), const char *fmt, ...)
 173             __printflike(9, 10);
 174 int     intr_event_describe_handler(struct intr_event *ie, void *cookie,
 175             const char *descr);
 176 int     intr_event_destroy(struct intr_event *ie);
 177 void    intr_event_execute_handlers(struct proc *p, struct intr_event *ie);
 178 int     intr_event_handle(struct intr_event *ie, struct trapframe *frame);
 179 int     intr_event_remove_handler(void *cookie);
 180 int     intr_getaffinity(int irq, int mode, void *mask);
 181 void    *intr_handler_source(void *cookie);
 182 int     intr_setaffinity(int irq, int mode, void *mask);
 183 void    _intr_drain(int irq);  /* Linux compat only. */
 184 int     swi_add(struct intr_event **eventp, const char *name,
 185             driver_intr_t handler, void *arg, int pri, enum intr_type flags,
 186             void **cookiep);
 187 void    swi_sched(void *cookie, int flags);
 188 int     swi_remove(void *cookie);
 189
 190 #endif