sys/sys/interrupt.h

   1 /*-
   2  * Copyright (c) 1997, Stefan Esser <se@freebsd.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice unmodified, this list of conditions, and the following
  10  *    disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 #ifndef _SYS_INTERRUPT_H_
  30 #define _SYS_INTERRUPT_H_
  31
  32 #include <sys/_lock.h>
  33 #include <sys/_mutex.h>
  34
  35 struct intr_event;
  36 struct intr_thread;
  37 struct trapframe;
  38
  39 /*
  40  * Describe a hardware interrupt handler.
  41  *
  42  * Multiple interrupt handlers for a specific event can be chained
  43  * together.
  44  */
  45 struct intr_handler {
  46         driver_filter_t *ih_filter;     /* Filter function. */
  47         driver_intr_t   *ih_handler;    /* Handler function. */
  48         void            *ih_argument;   /* Argument to pass to handler. */
  49         int              ih_flags;
  50         const char      *ih_name;       /* Name of handler. */
  51         struct intr_event *ih_event;    /* Event we are connected to. */
  52         int              ih_need;       /* Needs service. */
  53         TAILQ_ENTRY(intr_handler) ih_next; /* Next handler for this event. */
  54         u_char           ih_pri;        /* Priority of this handler. */
  55         struct intr_thread *ih_thread;  /* Ithread for filtered handler. */
  56 };
  57
  58 /* Interrupt handle flags kept in ih_flags */
  59 #define IH_EXCLUSIVE    0x00000002      /* Exclusive interrupt. */
  60 #define IH_ENTROPY      0x00000004      /* Device is a good entropy source. */
  61 #define IH_DEAD         0x00000008      /* Handler should be removed. */
  62 #define IH_MPSAFE       0x80000000      /* Handler does not need Giant. */
  63
  64 /*
  65  * Describe an interrupt event.  An event holds a list of handlers.
  66  */
  67 struct intr_event {
  68         TAILQ_ENTRY(intr_event) ie_list;
  69         TAILQ_HEAD(, intr_handler) ie_handlers; /* Interrupt handlers. */
  70         char            ie_name[MAXCOMLEN]; /* Individual event name. */
  71         char            ie_fullname[MAXCOMLEN];
  72         struct mtx      ie_lock;
  73         void            *ie_source;     /* Cookie used by MD code. */
  74         struct intr_thread *ie_thread;  /* Thread we are connected to. */
  75         void            (*ie_enable)(void *);
  76 #ifdef INTR_FILTER
  77         void            (*ie_eoi)(void *);
  78         void            (*ie_disab)(void *);
  79 #endif
  80         int             ie_flags;
  81         int             ie_count;       /* Loop counter. */
  82         int             ie_warncnt;     /* Rate-check interrupt storm warns. */
  83         struct timeval  ie_warntm;
  84 };
  85
  86 /* Interrupt event flags kept in ie_flags. */
  87 #define IE_SOFT         0x000001        /* Software interrupt. */
  88 #define IE_ENTROPY      0x000002        /* Interrupt is an entropy source. */
  89 #define IE_ADDING_THREAD 0x000004       /* Currently building an ithread. */
  90
  91 /* Flags to pass to sched_swi. */
  92 #define SWI_DELAY       0x2
  93
  94 /*
  95  * Software interrupt numbers in priority order.  The priority determines
  96  * the priority of the corresponding interrupt thread.
  97  */
  98 #define SWI_TTY         0
  99 #define SWI_NET         1
 100 #define SWI_CAMBIO      2
 101 #define SWI_VM          3
 102 #define SWI_CLOCK       4
 103 #define SWI_TQ_FAST     5
 104 #define SWI_TQ          6
 105 #define SWI_TQ_GIANT    6
 106
 107 extern struct   intr_event *tty_intr_event;
 108 extern struct   intr_event *clk_intr_event;
 109 extern void     *softclock_ih;
 110 extern void     *vm_ih;
 111
 112 /* Counts and names for statistics (defined in MD code). */
 113 extern u_long   eintrcnt[];     /* end of intrcnt[] */
 114 extern char     eintrnames[];   /* end of intrnames[] */
 115 extern u_long   intrcnt[];      /* counts for for each device and stray */
 116 extern char     intrnames[];    /* string table containing device names */
 117
 118 #ifdef DDB
 119 void    db_dump_intr_event(struct intr_event *ie, int handlers);
 120 #endif
 121 #ifdef INTR_FILTER
 122 int     intr_filter_loop(struct intr_event *ie, struct trapframe *frame,
 123                          struct intr_thread **ithd);
 124 int     intr_event_handle(struct intr_event *ie, struct trapframe *frame);
 125 #endif
 126 u_char  intr_priority(enum intr_type flags);
 127 int     intr_event_add_handler(struct intr_event *ie, const char *name,
 128             driver_filter_t filter, driver_intr_t handler, void *arg,
 129             u_char pri, enum intr_type flags, void **cookiep);
 130 #ifndef INTR_FILTER
 131 int     intr_event_create(struct intr_event **event, void *source,
 132             int flags, void (*enable)(void *), const char *fmt, ...)
 133             __printflike(5, 6);
 134 #else
 135 int     intr_event_create(struct intr_event **event, void *source,
 136             int flags, void (*enable)(void *), void (*eoi)(void *),
 137             void (*disab)(void *), const char *fmt, ...)
 138             __printflike(7, 8);
 139 #endif
 140 int     intr_event_destroy(struct intr_event *ie);
 141 int     intr_event_remove_handler(void *cookie);
 142 #ifndef INTR_FILTER
 143 int     intr_event_schedule_thread(struct intr_event *ie);
 144 #else
 145 int     intr_event_schedule_thread(struct intr_event *ie,
 146             struct intr_thread *ithd);
 147 #endif
 148 void    *intr_handler_source(void *cookie);
 149 int     swi_add(struct intr_event **eventp, const char *name,
 150             driver_intr_t handler, void *arg, int pri, enum intr_type flags,
 151             void **cookiep);
 152 void    swi_sched(void *cookie, int flags);
 153 int     swi_remove(void *cookie);
 154
 155 #endif