ARM: gic: add irq_domain support

[deliverable/linux.git] / arch / arm / common / gic.c

/*
 *  linux/arch/arm/common/gic.c
 *
 *  Copyright (C) 2002 ARM Limited, All Rights Reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * Interrupt architecture for the GIC:
 *
 * o There is one Interrupt Distributor, which receives interrupts
 *   from system devices and sends them to the Interrupt Controllers.
 *
 * o There is one CPU Interface per CPU, which sends interrupts sent
 *   by the Distributor, and interrupts generated locally, to the
 *   associated CPU. The base address of the CPU interface is usually
 *   aliased so that the same address points to different chips depending
 *   on the CPU it is accessed from.
 *
 * Note that IRQs 0-31 are special - they are local to each CPU.
 * As such, the enable set/clear, pending set/clear and active bit
 * registers are banked per-cpu for these sources.
 */
#include <linux/init.h>
#include <linux/kernel.h>
#include <linux/export.h>
#include <linux/list.h>
#include <linux/smp.h>
#include <linux/cpu_pm.h>
#include <linux/cpumask.h>
#include <linux/io.h>
#include <linux/irqdomain.h>
#include <linux/interrupt.h>
#include <linux/percpu.h>
#include <linux/slab.h>

#include <asm/irq.h>
#include <asm/mach/irq.h>
#include <asm/hardware/gic.h>

static DEFINE_SPINLOCK(irq_controller_lock);

/* Address of GIC 0 CPU interface */
void __iomem *gic_cpu_base_addr __read_mostly;

/*
 * Supported arch specific GIC irq extension.
 * Default make them NULL.
 */
struct irq_chip gic_arch_extn = {
        .irq_eoi        = NULL,
        .irq_mask       = NULL,
        .irq_unmask     = NULL,
        .irq_retrigger  = NULL,
        .irq_set_type   = NULL,
        .irq_set_wake   = NULL,
};

#ifndef MAX_GIC_NR
#define MAX_GIC_NR      1
#endif

static struct gic_chip_data gic_data[MAX_GIC_NR] __read_mostly;

static inline void __iomem *gic_dist_base(struct irq_data *d)
{
        struct gic_chip_data *gic_data = irq_data_get_irq_chip_data(d);
        return gic_data->dist_base;
}

static inline void __iomem *gic_cpu_base(struct irq_data *d)
{
        struct gic_chip_data *gic_data = irq_data_get_irq_chip_data(d);
        return gic_data->cpu_base;
}

static inline unsigned int gic_irq(struct irq_data *d)
{
        return d->hwirq;
}

/*
 * Routines to acknowledge, disable and enable interrupts
 */
static void gic_mask_irq(struct irq_data *d)
{
        u32 mask = 1 << (gic_irq(d) % 32);

        spin_lock(&irq_controller_lock);
        writel_relaxed(mask, gic_dist_base(d) + GIC_DIST_ENABLE_CLEAR + (gic_irq(d) / 32) * 4);
        if (gic_arch_extn.irq_mask)
                gic_arch_extn.irq_mask(d);
        spin_unlock(&irq_controller_lock);
}

static void gic_unmask_irq(struct irq_data *d)
{
        u32 mask = 1 << (gic_irq(d) % 32);

        spin_lock(&irq_controller_lock);
        if (gic_arch_extn.irq_unmask)
                gic_arch_extn.irq_unmask(d);
        writel_relaxed(mask, gic_dist_base(d) + GIC_DIST_ENABLE_SET + (gic_irq(d) / 32) * 4);
        spin_unlock(&irq_controller_lock);
}

static void gic_eoi_irq(struct irq_data *d)
{
        if (gic_arch_extn.irq_eoi) {
                spin_lock(&irq_controller_lock);
                gic_arch_extn.irq_eoi(d);
                spin_unlock(&irq_controller_lock);
        }

        writel_relaxed(gic_irq(d), gic_cpu_base(d) + GIC_CPU_EOI);
}

static int gic_set_type(struct irq_data *d, unsigned int type)
{
        void __iomem *base = gic_dist_base(d);
        unsigned int gicirq = gic_irq(d);
        u32 enablemask = 1 << (gicirq % 32);
        u32 enableoff = (gicirq / 32) * 4;
        u32 confmask = 0x2 << ((gicirq % 16) * 2);
        u32 confoff = (gicirq / 16) * 4;
        bool enabled = false;
        u32 val;

        /* Interrupt configuration for SGIs can't be changed */
        if (gicirq < 16)
                return -EINVAL;

        if (type != IRQ_TYPE_LEVEL_HIGH && type != IRQ_TYPE_EDGE_RISING)
                return -EINVAL;

        spin_lock(&irq_controller_lock);

        if (gic_arch_extn.irq_set_type)
                gic_arch_extn.irq_set_type(d, type);

        val = readl_relaxed(base + GIC_DIST_CONFIG + confoff);
        if (type == IRQ_TYPE_LEVEL_HIGH)
                val &= ~confmask;
        else if (type == IRQ_TYPE_EDGE_RISING)
                val |= confmask;

        /*
         * As recommended by the spec, disable the interrupt before changing
         * the configuration
         */
        if (readl_relaxed(base + GIC_DIST_ENABLE_SET + enableoff) & enablemask) {
                writel_relaxed(enablemask, base + GIC_DIST_ENABLE_CLEAR + enableoff);
                enabled = true;
        }

        writel_relaxed(val, base + GIC_DIST_CONFIG + confoff);

        if (enabled)
                writel_relaxed(enablemask, base + GIC_DIST_ENABLE_SET + enableoff);

        spin_unlock(&irq_controller_lock);

        return 0;
}

static int gic_retrigger(struct irq_data *d)
{
        if (gic_arch_extn.irq_retrigger)
                return gic_arch_extn.irq_retrigger(d);

        return -ENXIO;
}

#ifdef CONFIG_SMP
static int gic_set_affinity(struct irq_data *d, const struct cpumask *mask_val,
                            bool force)
{
        void __iomem *reg = gic_dist_base(d) + GIC_DIST_TARGET + (gic_irq(d) & ~3);
        unsigned int shift = (gic_irq(d) % 4) * 8;
        unsigned int cpu = cpumask_any_and(mask_val, cpu_online_mask);
        u32 val, mask, bit;

        if (cpu >= 8 || cpu >= nr_cpu_ids)
                return -EINVAL;

        mask = 0xff << shift;
        bit = 1 << (cpu_logical_map(cpu) + shift);

        spin_lock(&irq_controller_lock);
        val = readl_relaxed(reg) & ~mask;
        writel_relaxed(val | bit, reg);
        spin_unlock(&irq_controller_lock);

        return IRQ_SET_MASK_OK;
}
#endif

#ifdef CONFIG_PM
static int gic_set_wake(struct irq_data *d, unsigned int on)
{
        int ret = -ENXIO;

        if (gic_arch_extn.irq_set_wake)
                ret = gic_arch_extn.irq_set_wake(d, on);

        return ret;
}

#else
#define gic_set_wake    NULL
#endif

static void gic_handle_cascade_irq(unsigned int irq, struct irq_desc *desc)
{
        struct gic_chip_data *chip_data = irq_get_handler_data(irq);
        struct irq_chip *chip = irq_get_chip(irq);
        unsigned int cascade_irq, gic_irq;
        unsigned long status;

        chained_irq_enter(chip, desc);

        spin_lock(&irq_controller_lock);
        status = readl_relaxed(chip_data->cpu_base + GIC_CPU_INTACK);
        spin_unlock(&irq_controller_lock);

        gic_irq = (status & 0x3ff);
        if (gic_irq == 1023)
                goto out;

        cascade_irq = irq_domain_to_irq(&chip_data->domain, gic_irq);
        if (unlikely(gic_irq < 32 || gic_irq > 1020 || cascade_irq >= NR_IRQS))
                do_bad_IRQ(cascade_irq, desc);
        else
                generic_handle_irq(cascade_irq);

 out:
        chained_irq_exit(chip, desc);
}

static struct irq_chip gic_chip = {
        .name                   = "GIC",
        .irq_mask               = gic_mask_irq,
        .irq_unmask             = gic_unmask_irq,
        .irq_eoi                = gic_eoi_irq,
        .irq_set_type           = gic_set_type,
        .irq_retrigger          = gic_retrigger,
#ifdef CONFIG_SMP
        .irq_set_affinity       = gic_set_affinity,
#endif
        .irq_set_wake           = gic_set_wake,
};

void __init gic_cascade_irq(unsigned int gic_nr, unsigned int irq)
{
        if (gic_nr >= MAX_GIC_NR)
                BUG();
        if (irq_set_handler_data(irq, &gic_data[gic_nr]) != 0)
                BUG();
        irq_set_chained_handler(irq, gic_handle_cascade_irq);
}

static void __init gic_dist_init(struct gic_chip_data *gic)
{
        unsigned int i, irq;
        u32 cpumask;
        unsigned int gic_irqs = gic->gic_irqs;
        struct irq_domain *domain = &gic->domain;
        void __iomem *base = gic->dist_base;
        u32 cpu = 0;

#ifdef CONFIG_SMP
        cpu = cpu_logical_map(smp_processor_id());
#endif

        cpumask = 1 << cpu;
        cpumask |= cpumask << 8;
        cpumask |= cpumask << 16;

        writel_relaxed(0, base + GIC_DIST_CTRL);

        /*
         * Set all global interrupts to be level triggered, active low.
         */
        for (i = 32; i < gic_irqs; i += 16)
                writel_relaxed(0, base + GIC_DIST_CONFIG + i * 4 / 16);

        /*
         * Set all global interrupts to this CPU only.
         */
        for (i = 32; i < gic_irqs; i += 4)
                writel_relaxed(cpumask, base + GIC_DIST_TARGET + i * 4 / 4);

        /*
         * Set priority on all global interrupts.
         */
        for (i = 32; i < gic_irqs; i += 4)
                writel_relaxed(0xa0a0a0a0, base + GIC_DIST_PRI + i * 4 / 4);

        /*
         * Disable all interrupts.  Leave the PPI and SGIs alone
         * as these enables are banked registers.
         */
        for (i = 32; i < gic_irqs; i += 32)
                writel_relaxed(0xffffffff, base + GIC_DIST_ENABLE_CLEAR + i * 4 / 32);

        /*
         * Setup the Linux IRQ subsystem.
         */
        irq_domain_for_each_irq(domain, i, irq) {
                if (i < 32) {
                        irq_set_percpu_devid(irq);
                        irq_set_chip_and_handler(irq, &gic_chip,
                                                 handle_percpu_devid_irq);
                        set_irq_flags(irq, IRQF_VALID | IRQF_NOAUTOEN);
                } else {
                        irq_set_chip_and_handler(irq, &gic_chip,
                                                 handle_fasteoi_irq);
                        set_irq_flags(irq, IRQF_VALID | IRQF_PROBE);
                }
                irq_set_chip_data(irq, gic);
        }

        writel_relaxed(1, base + GIC_DIST_CTRL);
}

static void __cpuinit gic_cpu_init(struct gic_chip_data *gic)
{
        void __iomem *dist_base = gic->dist_base;
        void __iomem *base = gic->cpu_base;
        int i;

        /*
         * Deal with the banked PPI and SGI interrupts - disable all
         * PPI interrupts, ensure all SGI interrupts are enabled.
         */
        writel_relaxed(0xffff0000, dist_base + GIC_DIST_ENABLE_CLEAR);
        writel_relaxed(0x0000ffff, dist_base + GIC_DIST_ENABLE_SET);

        /*
         * Set priority on PPI and SGI interrupts
         */
        for (i = 0; i < 32; i += 4)
                writel_relaxed(0xa0a0a0a0, dist_base + GIC_DIST_PRI + i * 4 / 4);

        writel_relaxed(0xf0, base + GIC_CPU_PRIMASK);
        writel_relaxed(1, base + GIC_CPU_CTRL);
}

#ifdef CONFIG_CPU_PM
/*
 * Saves the GIC distributor registers during suspend or idle.  Must be called
 * with interrupts disabled but before powering down the GIC.  After calling
 * this function, no interrupts will be delivered by the GIC, and another
 * platform-specific wakeup source must be enabled.
 */
static void gic_dist_save(unsigned int gic_nr)
{
        unsigned int gic_irqs;
        void __iomem *dist_base;
        int i;

        if (gic_nr >= MAX_GIC_NR)
                BUG();

        gic_irqs = gic_data[gic_nr].gic_irqs;
        dist_base = gic_data[gic_nr].dist_base;

        if (!dist_base)
                return;

        for (i = 0; i < DIV_ROUND_UP(gic_irqs, 16); i++)
                gic_data[gic_nr].saved_spi_conf[i] =
                        readl_relaxed(dist_base + GIC_DIST_CONFIG + i * 4);

        for (i = 0; i < DIV_ROUND_UP(gic_irqs, 4); i++)
                gic_data[gic_nr].saved_spi_target[i] =
                        readl_relaxed(dist_base + GIC_DIST_TARGET + i * 4);

        for (i = 0; i < DIV_ROUND_UP(gic_irqs, 32); i++)
                gic_data[gic_nr].saved_spi_enable[i] =
                        readl_relaxed(dist_base + GIC_DIST_ENABLE_SET + i * 4);
}

/*
 * Restores the GIC distributor registers during resume or when coming out of
 * idle.  Must be called before enabling interrupts.  If a level interrupt
 * that occured while the GIC was suspended is still present, it will be
 * handled normally, but any edge interrupts that occured will not be seen by
 * the GIC and need to be handled by the platform-specific wakeup source.
 */
static void gic_dist_restore(unsigned int gic_nr)
{
        unsigned int gic_irqs;
        unsigned int i;
        void __iomem *dist_base;

        if (gic_nr >= MAX_GIC_NR)
                BUG();

        gic_irqs = gic_data[gic_nr].gic_irqs;
        dist_base = gic_data[gic_nr].dist_base;

        if (!dist_base)
                return;

        writel_relaxed(0, dist_base + GIC_DIST_CTRL);

        for (i = 0; i < DIV_ROUND_UP(gic_irqs, 16); i++)
                writel_relaxed(gic_data[gic_nr].saved_spi_conf[i],
                        dist_base + GIC_DIST_CONFIG + i * 4);

        for (i = 0; i < DIV_ROUND_UP(gic_irqs, 4); i++)
                writel_relaxed(0xa0a0a0a0,
                        dist_base + GIC_DIST_PRI + i * 4);

        for (i = 0; i < DIV_ROUND_UP(gic_irqs, 4); i++)
                writel_relaxed(gic_data[gic_nr].saved_spi_target[i],
                        dist_base + GIC_DIST_TARGET + i * 4);

        for (i = 0; i < DIV_ROUND_UP(gic_irqs, 32); i++)
                writel_relaxed(gic_data[gic_nr].saved_spi_enable[i],
                        dist_base + GIC_DIST_ENABLE_SET + i * 4);

        writel_relaxed(1, dist_base + GIC_DIST_CTRL);
}

static void gic_cpu_save(unsigned int gic_nr)
{
        int i;
        u32 *ptr;
        void __iomem *dist_base;
        void __iomem *cpu_base;

        if (gic_nr >= MAX_GIC_NR)
                BUG();

        dist_base = gic_data[gic_nr].dist_base;
        cpu_base = gic_data[gic_nr].cpu_base;

        if (!dist_base || !cpu_base)
                return;

        ptr = __this_cpu_ptr(gic_data[gic_nr].saved_ppi_enable);
        for (i = 0; i < DIV_ROUND_UP(32, 32); i++)
                ptr[i] = readl_relaxed(dist_base + GIC_DIST_ENABLE_SET + i * 4);

        ptr = __this_cpu_ptr(gic_data[gic_nr].saved_ppi_conf);
        for (i = 0; i < DIV_ROUND_UP(32, 16); i++)
                ptr[i] = readl_relaxed(dist_base + GIC_DIST_CONFIG + i * 4);

}

static void gic_cpu_restore(unsigned int gic_nr)
{
        int i;
        u32 *ptr;
        void __iomem *dist_base;
        void __iomem *cpu_base;

        if (gic_nr >= MAX_GIC_NR)
                BUG();

        dist_base = gic_data[gic_nr].dist_base;
        cpu_base = gic_data[gic_nr].cpu_base;

        if (!dist_base || !cpu_base)
                return;

        ptr = __this_cpu_ptr(gic_data[gic_nr].saved_ppi_enable);
        for (i = 0; i < DIV_ROUND_UP(32, 32); i++)
                writel_relaxed(ptr[i], dist_base + GIC_DIST_ENABLE_SET + i * 4);

        ptr = __this_cpu_ptr(gic_data[gic_nr].saved_ppi_conf);
        for (i = 0; i < DIV_ROUND_UP(32, 16); i++)
                writel_relaxed(ptr[i], dist_base + GIC_DIST_CONFIG + i * 4);

        for (i = 0; i < DIV_ROUND_UP(32, 4); i++)
                writel_relaxed(0xa0a0a0a0, dist_base + GIC_DIST_PRI + i * 4);

        writel_relaxed(0xf0, cpu_base + GIC_CPU_PRIMASK);
        writel_relaxed(1, cpu_base + GIC_CPU_CTRL);
}

static int gic_notifier(struct notifier_block *self, unsigned long cmd, void *v)
{
        int i;

        for (i = 0; i < MAX_GIC_NR; i++) {
                switch (cmd) {
                case CPU_PM_ENTER:
                        gic_cpu_save(i);
                        break;
                case CPU_PM_ENTER_FAILED:
                case CPU_PM_EXIT:
                        gic_cpu_restore(i);
                        break;
                case CPU_CLUSTER_PM_ENTER:
                        gic_dist_save(i);
                        break;
                case CPU_CLUSTER_PM_ENTER_FAILED:
                case CPU_CLUSTER_PM_EXIT:
                        gic_dist_restore(i);
                        break;
                }
        }

        return NOTIFY_OK;
}

static struct notifier_block gic_notifier_block = {
        .notifier_call = gic_notifier,
};

static void __init gic_pm_init(struct gic_chip_data *gic)
{
        gic->saved_ppi_enable = __alloc_percpu(DIV_ROUND_UP(32, 32) * 4,
                sizeof(u32));
        BUG_ON(!gic->saved_ppi_enable);

        gic->saved_ppi_conf = __alloc_percpu(DIV_ROUND_UP(32, 16) * 4,
                sizeof(u32));
        BUG_ON(!gic->saved_ppi_conf);

        cpu_pm_register_notifier(&gic_notifier_block);
}
#else
static void __init gic_pm_init(struct gic_chip_data *gic)
{
}
#endif

const struct irq_domain_ops gic_irq_domain_ops = {
};

void __init gic_init(unsigned int gic_nr, unsigned int irq_start,
        void __iomem *dist_base, void __iomem *cpu_base)
{
        struct gic_chip_data *gic;
        struct irq_domain *domain;
        int gic_irqs;

        BUG_ON(gic_nr >= MAX_GIC_NR);

        gic = &gic_data[gic_nr];
        domain = &gic->domain;
        gic->dist_base = dist_base;
        gic->cpu_base = cpu_base;

        /*
         * For primary GICs, skip over SGIs.
         * For secondary GICs, skip over PPIs, too.
         */
        if (gic_nr == 0) {
                gic_cpu_base_addr = cpu_base;
                domain->hwirq_base = 16;
                irq_start = (irq_start & ~31) + 16;
        } else
                domain->hwirq_base = 32;

        /*
         * Find out how many interrupts are supported.
         * The GIC only supports up to 1020 interrupt sources.
         */
        gic_irqs = readl_relaxed(dist_base + GIC_DIST_CTR) & 0x1f;
        gic_irqs = (gic_irqs + 1) * 32;
        if (gic_irqs > 1020)
                gic_irqs = 1020;
        gic->gic_irqs = gic_irqs;

        domain->nr_irq = gic_irqs - domain->hwirq_base;
        domain->irq_base = irq_alloc_descs(-1, irq_start, domain->nr_irq,
                                           numa_node_id());
        domain->priv = gic;
        domain->ops = &gic_irq_domain_ops;
        irq_domain_add(domain);

        gic_chip.flags |= gic_arch_extn.flags;
        gic_dist_init(gic);
        gic_cpu_init(gic);
        gic_pm_init(gic);
}

void __cpuinit gic_secondary_init(unsigned int gic_nr)
{
        BUG_ON(gic_nr >= MAX_GIC_NR);

        gic_cpu_init(&gic_data[gic_nr]);
}

#ifdef CONFIG_SMP
void gic_raise_softirq(const struct cpumask *mask, unsigned int irq)
{
        int cpu;
        unsigned long map = 0;

        /* Convert our logical CPU mask into a physical one. */
        for_each_cpu(cpu, mask)
                map |= 1 << cpu_logical_map(cpu);

        /*
         * Ensure that stores to Normal memory are visible to the
         * other CPUs before issuing the IPI.
         */
        dsb();

        /* this always happens on GIC0 */
        writel_relaxed(map << 16 | irq, gic_data[0].dist_base + GIC_DIST_SOFTINT);
}
#endif