FreeBSD/Linux Kernel Cross Reference
sys/i386/include/intr_machdep.h

     /*-
      * Copyright (c) 2003 John Baldwin <jhb@FreeBSD.org>
      * All rights reserved.
      *
      * Redistribution and use in source and binary forms, with or without
      * modification, are permitted provided that the following conditions
      * are met:
      * 1. Redistributions of source code must retain the above copyright
      *    notice, this list of conditions and the following disclaimer.
     * 2. Redistributions in binary form must reproduce the above copyright
     *    notice, this list of conditions and the following disclaimer in the
     *    documentation and/or other materials provided with the distribution.
     *
     * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
     * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
     * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     * SUCH DAMAGE.
     *
     * $FreeBSD: releng/11.0/sys/i386/include/intr_machdep.h 302895 2016-07-15 09:44:48Z royger $
     */
    
    #ifndef __MACHINE_INTR_MACHDEP_H__
    #define __MACHINE_INTR_MACHDEP_H__
    
    #ifdef _KERNEL
    
    /*
     * The maximum number of I/O interrupts we allow.  This number is rather
     * arbitrary as it is just the maximum IRQ resource value.  The interrupt
     * source for a given IRQ maps that I/O interrupt to device interrupt
     * source whether it be a pin on an interrupt controller or an MSI interrupt.
     * The 16 ISA IRQs are assigned fixed IDT vectors, but all other device
     * interrupts allocate IDT vectors on demand.  Currently we have 191 IDT
     * vectors available for device interrupts.  On many systems with I/O APICs,
     * a lot of the IRQs are not used, so this number can be much larger than
     * 191 and still be safe since only interrupt sources in actual use will
     * allocate IDT vectors.
     *
     * The first 255 IRQs (0 - 254) are reserved for ISA IRQs and PCI intline IRQs.
     * IRQ values from 256 to 767 are used by MSI.  When running under the Xen
     * Hypervisor, IRQ values from 768 to 4863 are available for binding to
     * event channel events.  We leave 255 unused to avoid confusion since 255 is
     * used in PCI to indicate an invalid IRQ.
     */
    #define NUM_MSI_INTS    512
    #define FIRST_MSI_INT   256
    #ifdef XENHVM
    #include <xen/xen-os.h>
    #include <xen/interface/event_channel.h>
    #define NUM_EVTCHN_INTS NR_EVENT_CHANNELS
    #define FIRST_EVTCHN_INT \
        (FIRST_MSI_INT + NUM_MSI_INTS)
    #define LAST_EVTCHN_INT \
        (FIRST_EVTCHN_INT + NUM_EVTCHN_INTS - 1)
    #else /* !XENHVM */
    #define NUM_EVTCHN_INTS 0
    #endif
    #define NUM_IO_INTS     (FIRST_MSI_INT + NUM_MSI_INTS + NUM_EVTCHN_INTS)
    
    /*
     * Default base address for MSI messages on x86 platforms.
     */
    #define MSI_INTEL_ADDR_BASE             0xfee00000
    
    /*
     * - 1 ??? dummy counter.
     * - 2 counters for each I/O interrupt.
     * - 1 counter for each CPU for lapic timer.
     * - 9 counters for each CPU for IPI counters for SMP.
     */
    #ifdef SMP
    #define INTRCNT_COUNT   (1 + NUM_IO_INTS * 2 + (1 + 9) * MAXCPU)
    #else
    #define INTRCNT_COUNT   (1 + NUM_IO_INTS * 2 + 1)
    #endif
    
    #ifndef LOCORE
    
    typedef void inthand_t(void);
    
    #define IDTVEC(name)    __CONCAT(X,name)
    
    struct intsrc;
    
    /*
     * Methods that a PIC provides to mask/unmask a given interrupt source,
     * "turn on" the interrupt on the CPU side by setting up an IDT entry, and
     * return the vector associated with this source.
     */
    struct pic {
            void (*pic_enable_source)(struct intsrc *);
            void (*pic_disable_source)(struct intsrc *, int);
           void (*pic_eoi_source)(struct intsrc *);
           void (*pic_enable_intr)(struct intsrc *);
           void (*pic_disable_intr)(struct intsrc *);
           int (*pic_vector)(struct intsrc *);
           int (*pic_source_pending)(struct intsrc *);
           void (*pic_suspend)(struct pic *);
           void (*pic_resume)(struct pic *, bool suspend_cancelled);
           int (*pic_config_intr)(struct intsrc *, enum intr_trigger,
               enum intr_polarity);
           int (*pic_assign_cpu)(struct intsrc *, u_int apic_id);
           void (*pic_reprogram_pin)(struct intsrc *);
           TAILQ_ENTRY(pic) pics;
   };
   
   /* Flags for pic_disable_source() */
   enum {
           PIC_EOI,
           PIC_NO_EOI,
   };
   
   /*
    * An interrupt source.  The upper-layer code uses the PIC methods to
    * control a given source.  The lower-layer PIC drivers can store additional
    * private data in a given interrupt source such as an interrupt pin number
    * or an I/O APIC pointer.
    */
   struct intsrc {
           struct pic *is_pic;
           struct intr_event *is_event;
           u_long *is_count;
           u_long *is_straycount;
           u_int is_index;
           u_int is_handlers;
   };
   
   struct trapframe;
   
   #ifdef SMP
   extern cpuset_t intr_cpus;
   #endif
   extern struct mtx icu_lock;
   extern int elcr_found;
   
   extern int msix_disable_migration;
   
   #ifndef DEV_ATPIC
   void    atpic_reset(void);
   #endif
   /* XXX: The elcr_* prototypes probably belong somewhere else. */
   int     elcr_probe(void);
   enum intr_trigger elcr_read_trigger(u_int irq);
   void    elcr_resume(void);
   void    elcr_write_trigger(u_int irq, enum intr_trigger trigger);
   #ifdef SMP
   void    intr_add_cpu(u_int cpu);
   #endif
   int     intr_add_handler(const char *name, int vector, driver_filter_t filter,
       driver_intr_t handler, void *arg, enum intr_type flags, void **cookiep);
   #ifdef SMP
   int     intr_bind(u_int vector, u_char cpu);
   #endif
   int     intr_config_intr(int vector, enum intr_trigger trig,
       enum intr_polarity pol);
   int     intr_describe(u_int vector, void *ih, const char *descr);
   void    intr_execute_handlers(struct intsrc *isrc, struct trapframe *frame);
   u_int   intr_next_cpu(void);
   struct intsrc *intr_lookup_source(int vector);
   int     intr_register_pic(struct pic *pic);
   int     intr_register_source(struct intsrc *isrc);
   int     intr_remove_handler(void *cookie);
   void    intr_resume(bool suspend_cancelled);
   void    intr_suspend(void);
   void    intr_reprogram(void);
   void    intrcnt_add(const char *name, u_long **countp);
   void    nexus_add_irq(u_long irq);
   int     msi_alloc(device_t dev, int count, int maxcount, int *irqs);
   void    msi_init(void);
   int     msi_map(int irq, uint64_t *addr, uint32_t *data);
   int     msi_release(int* irqs, int count);
   int     msix_alloc(device_t dev, int *irq);
   int     msix_release(int irq);
   
   #endif  /* !LOCORE */
   #endif  /* _KERNEL */
   #endif  /* !__MACHINE_INTR_MACHDEP_H__ */

Cache object: 465705acf59db582184121ee684b6c8d