sys/arm/arm/gic.h

   1 /*-
   2  * Copyright (c) 2011,2016 The FreeBSD Foundation
   3  * All rights reserved.
   4  *
   5  * This software was developed by Andrew Turner under
   6  * sponsorship from the FreeBSD Foundation.
   7  *
   8  * Developed by Damjan Marion <damjan.marion@gmail.com>
   9  *
  10  * Based on OMAP4 GIC code by Ben Gray
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  * 3. The name of the company nor the name of the author may be used to
  21  *    endorse or promote products derived from this software without specific
  22  *    prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  * $FreeBSD$
  37  */
  38
  39 #ifndef _ARM_GIC_H_
  40 #define _ARM_GIC_H_
  41
  42 #define GIC_FIRST_SGI            0      /* Irqs 0-15 are SGIs/IPIs. */
  43 #define GIC_LAST_SGI            15
  44 #define GIC_FIRST_PPI           16      /* Irqs 16-31 are private (per */
  45 #define GIC_LAST_PPI            31      /* core) peripheral interrupts. */
  46 #define GIC_FIRST_SPI           32      /* Irqs 32+ are shared peripherals. */
  47
  48 #ifdef INTRNG
  49 struct arm_gic_range {
  50         uint64_t bus;
  51         uint64_t host;
  52         uint64_t size;
  53 };
  54 #endif
  55
  56 struct arm_gic_softc {
  57         device_t                gic_dev;
  58 #ifdef INTRNG
  59         void *                  gic_intrhand;
  60         struct gic_irqsrc *     gic_irqs;
  61 #endif
  62         struct resource *       gic_res[3];
  63         bus_space_tag_t         gic_c_bst;
  64         bus_space_tag_t         gic_d_bst;
  65         bus_space_handle_t      gic_c_bsh;
  66         bus_space_handle_t      gic_d_bsh;
  67         uint8_t                 ver;
  68         struct mtx              mutex;
  69         uint32_t                nirqs;
  70         uint32_t                typer;
  71         uint32_t                last_irq[MAXCPU];
  72
  73 #ifdef INTRNG
  74         uint32_t                gic_iidr;
  75         u_int                   gic_bus;
  76
  77         int                     nranges;
  78         struct arm_gic_range *  ranges;
  79 #endif
  80 };
  81
  82 DECLARE_CLASS(arm_gic_driver);
  83
  84 #ifdef INTRNG
  85 struct arm_gicv2m_softc {
  86         struct resource *sc_mem;
  87         struct mtx      sc_mutex;
  88         uintptr_t       sc_xref;
  89         u_int           sc_spi_start;
  90         u_int           sc_spi_end;
  91         u_int           sc_spi_count;
  92 };
  93
  94 DECLARE_CLASS(arm_gicv2m_driver);
  95 #endif
  96
  97 int arm_gic_attach(device_t);
  98 int arm_gic_detach(device_t);
  99 int arm_gicv2m_attach(device_t);
 100 int arm_gic_intr(void *);
 101
 102 #endif /* _ARM_GIC_H_ */