The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/sys/interrupt.h

Version: -  FREEBSD  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-2  -  FREEBSD-11-1  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-4  -  FREEBSD-10-3  -  FREEBSD-10-2  -  FREEBSD-10-1  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-3  -  FREEBSD-9-2  -  FREEBSD-9-1  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-4  -  FREEBSD-8-3  -  FREEBSD-8-2  -  FREEBSD-8-1  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-4  -  FREEBSD-7-3  -  FREEBSD-7-2  -  FREEBSD-7-1  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-4  -  FREEBSD-6-3  -  FREEBSD-6-2  -  FREEBSD-6-1  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-5  -  FREEBSD-5-4  -  FREEBSD-5-3  -  FREEBSD-5-2  -  FREEBSD-5-1  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

    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: head/sys/sys/interrupt.h 344716 2019-03-02 01:51:41Z jhibbits $
   29  */
   30 
   31 #ifndef _SYS_INTERRUPT_H_
   32 #define _SYS_INTERRUPT_H_
   33 
   34 #include <sys/_lock.h>
   35 #include <sys/_mutex.h>
   36 #include <sys/ck.h>
   37 
   38 struct intr_event;
   39 struct intr_thread;
   40 struct trapframe;
   41 
   42 /*
   43  * Describe a hardware interrupt handler.
   44  *
   45  * Multiple interrupt handlers for a specific event can be chained
   46  * together.
   47  */
   48 struct intr_handler {
   49         driver_filter_t *ih_filter;     /* Filter handler function. */
   50         driver_intr_t   *ih_handler;    /* Threaded handler function. */
   51         void            *ih_argument;   /* Argument to pass to handlers. */
   52         int              ih_flags;
   53         char             ih_name[MAXCOMLEN + 1]; /* Name of handler. */
   54         struct intr_event *ih_event;    /* Event we are connected to. */
   55         int              ih_need;       /* Needs service. */
   56         CK_SLIST_ENTRY(intr_handler) ih_next; /* Next handler for this event. */
   57         u_char           ih_pri;        /* Priority of this handler. */
   58         struct intr_thread *ih_thread;  /* Ithread for filtered handler. */
   59 };
   60 
   61 /* Interrupt handle flags kept in ih_flags */
   62 #define IH_EXCLUSIVE    0x00000002      /* Exclusive interrupt. */
   63 #define IH_ENTROPY      0x00000004      /* Device is a good entropy source. */
   64 #define IH_DEAD         0x00000008      /* Handler should be removed. */
   65 #define IH_SUSP         0x00000010      /* Device is powered down. */
   66 #define IH_CHANGED      0x40000000      /* Handler state is changed. */
   67 #define IH_MPSAFE       0x80000000      /* Handler does not need Giant. */
   68 
   69 /*
   70  * Describe an interrupt event.  An event holds a list of handlers.
   71  * The 'pre_ithread', 'post_ithread', 'post_filter', and 'assign_cpu'
   72  * hooks are used to invoke MD code for certain operations.
   73  *
   74  * The 'pre_ithread' hook is called when an interrupt thread for
   75  * handlers without filters is scheduled.  It is responsible for
   76  * ensuring that 1) the system won't be swamped with an interrupt
   77  * storm from the associated source while the ithread runs and 2) the
   78  * current CPU is able to receive interrupts from other interrupt
   79  * sources.  The first is usually accomplished by disabling
   80  * level-triggered interrupts until the ithread completes.  The second
   81  * is accomplished on some platforms by acknowledging the interrupt
   82  * via an EOI.
   83  *
   84  * The 'post_ithread' hook is invoked when an ithread finishes.  It is
   85  * responsible for ensuring that the associated interrupt source will
   86  * trigger an interrupt when it is asserted in the future.  Usually
   87  * this is implemented by enabling a level-triggered interrupt that
   88  * was previously disabled via the 'pre_ithread' hook.
   89  *
   90  * The 'post_filter' hook is invoked when a filter handles an
   91  * interrupt.  It is responsible for ensuring that the current CPU is
   92  * able to receive interrupts again.  On some platforms this is done
   93  * by acknowledging the interrupts via an EOI.
   94  *
   95  * The 'assign_cpu' hook is used to bind an interrupt source to a
   96  * specific CPU.  If the interrupt cannot be bound, this function may
   97  * return an error.
   98  *
   99  * Note that device drivers may also use interrupt events to manage
  100  * multiplexing interrupt interrupt handler into handlers for child
  101  * devices.  In that case, the above hooks are not used.  The device
  102  * can create an event for its interrupt resource and register child
  103  * event handlers with that event.  It can then use
  104  * intr_event_execute_handlers() to execute non-filter handlers.
  105  * Currently filter handlers are not supported by this, but that can
  106  * be added by splitting out the filter loop from intr_event_handle()
  107  * if desired.
  108  */
  109 struct intr_event {
  110         TAILQ_ENTRY(intr_event) ie_list;
  111         CK_SLIST_HEAD(, intr_handler) ie_handlers; /* Interrupt handlers. */
  112         char            ie_name[MAXCOMLEN + 1]; /* Individual event name. */
  113         char            ie_fullname[MAXCOMLEN + 1];
  114         struct mtx      ie_lock;
  115         void            *ie_source;     /* Cookie used by MD code. */
  116         struct intr_thread *ie_thread;  /* Thread we are connected to. */
  117         void            (*ie_pre_ithread)(void *);
  118         void            (*ie_post_ithread)(void *);
  119         void            (*ie_post_filter)(void *);
  120         int             (*ie_assign_cpu)(void *, int);
  121         int             ie_flags;
  122         int             ie_count;       /* Loop counter. */
  123         int             ie_warncnt;     /* Rate-check interrupt storm warns. */
  124         struct timeval  ie_warntm;
  125         int             ie_irq;         /* Physical irq number if !SOFT. */
  126         int             ie_cpu;         /* CPU this event is bound to. */
  127         volatile int    ie_phase;       /* Switched to establish a barrier. */
  128         volatile int    ie_active[2];   /* Filters in ISR context. */
  129 };
  130 
  131 /* Interrupt event flags kept in ie_flags. */
  132 #define IE_SOFT         0x000001        /* Software interrupt. */
  133 #define IE_ENTROPY      0x000002        /* Interrupt is an entropy source. */
  134 #define IE_ADDING_THREAD 0x000004       /* Currently building an ithread. */
  135 
  136 /* Flags to pass to sched_swi. */
  137 #define SWI_DELAY       0x2
  138 
  139 /*
  140  * Software interrupt numbers in priority order.  The priority determines
  141  * the priority of the corresponding interrupt thread.
  142  */
  143 #define SWI_TTY         0
  144 #define SWI_NET         1
  145 #define SWI_CAMBIO      2
  146 #define SWI_VM          3
  147 #define SWI_CLOCK       4
  148 #define SWI_TQ_FAST     5
  149 #define SWI_TQ          6
  150 #define SWI_TQ_GIANT    6
  151 
  152 struct proc;
  153 
  154 extern struct   intr_event *tty_intr_event;
  155 extern struct   intr_event *clk_intr_event;
  156 extern void     *vm_ih;
  157 
  158 /* Counts and names for statistics (defined in MD code). */
  159 #if defined(__amd64__) || defined(__i386__) || defined(__powerpc__)
  160 extern u_long   *intrcnt;       /* counts for for each device and stray */
  161 extern char     *intrnames;     /* string table containing device names */
  162 #else
  163 extern u_long   intrcnt[];      /* counts for for each device and stray */
  164 extern char     intrnames[];    /* string table containing device names */
  165 #endif
  166 extern size_t   sintrcnt;       /* size of intrcnt table */
  167 extern size_t   sintrnames;     /* size of intrnames table */
  168 
  169 #ifdef DDB
  170 void    db_dump_intr_event(struct intr_event *ie, int handlers);
  171 #endif
  172 u_char  intr_priority(enum intr_type flags);
  173 int     intr_event_add_handler(struct intr_event *ie, const char *name,
  174             driver_filter_t filter, driver_intr_t handler, void *arg, 
  175             u_char pri, enum intr_type flags, void **cookiep);      
  176 int     intr_event_bind(struct intr_event *ie, int cpu);
  177 int     intr_event_bind_irqonly(struct intr_event *ie, int cpu);
  178 int     intr_event_bind_ithread(struct intr_event *ie, int cpu);
  179 int     intr_event_create(struct intr_event **event, void *source,
  180             int flags, int irq, void (*pre_ithread)(void *),
  181             void (*post_ithread)(void *), void (*post_filter)(void *),
  182             int (*assign_cpu)(void *, int), const char *fmt, ...)
  183             __printflike(9, 10);
  184 int     intr_event_describe_handler(struct intr_event *ie, void *cookie,
  185             const char *descr);
  186 int     intr_event_destroy(struct intr_event *ie);
  187 int     intr_event_handle(struct intr_event *ie, struct trapframe *frame);
  188 int     intr_event_remove_handler(void *cookie);
  189 int     intr_event_suspend_handler(void *cookie);
  190 int     intr_event_resume_handler(void *cookie);
  191 int     intr_getaffinity(int irq, int mode, void *mask);
  192 void    *intr_handler_source(void *cookie);
  193 int     intr_setaffinity(int irq, int mode, void *mask);
  194 void    _intr_drain(int irq);  /* Linux compat only. */
  195 int     swi_add(struct intr_event **eventp, const char *name,
  196             driver_intr_t handler, void *arg, int pri, enum intr_type flags,
  197             void **cookiep);
  198 void    swi_sched(void *cookie, int flags);
  199 int     swi_remove(void *cookie);
  200 
  201 #endif

Cache object: 1834f50330eabdc8a2330a3dc108c255


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.