arch/arm/common/vic.c

   1 /*
   2  *  linux/arch/arm/common/vic.c
   3  *
   4  *  Copyright (C) 1999 - 2003 ARM Limited
   5  *  Copyright (C) 2000 Deep Blue Solutions Ltd
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20  */
  21
  22 #include <linux/export.h>
  23 #include <linux/init.h>
  24 #include <linux/list.h>
  25 #include <linux/io.h>
  26 #include <linux/irqdomain.h>
  27 #include <linux/of.h>
  28 #include <linux/of_address.h>
  29 #include <linux/of_irq.h>
  30 #include <linux/syscore_ops.h>
  31 #include <linux/device.h>
  32 #include <linux/amba/bus.h>
  33
  34 #include <asm/mach/irq.h>
  35 #include <asm/hardware/vic.h>
  36
  37 /**
  38  * struct vic_device - VIC PM device
  39  * @irq: The IRQ number for the base of the VIC.
  40  * @base: The register base for the VIC.
  41  * @resume_sources: A bitmask of interrupts for resume.
  42  * @resume_irqs: The IRQs enabled for resume.
  43  * @int_select: Save for VIC_INT_SELECT.
  44  * @int_enable: Save for VIC_INT_ENABLE.
  45  * @soft_int: Save for VIC_INT_SOFT.
  46  * @protect: Save for VIC_PROTECT.
  47  * @domain: The IRQ domain for the VIC.
  48  */
  49 struct vic_device {
  50         void __iomem    *base;
  51         int             irq;
  52         u32             resume_sources;
  53         u32             resume_irqs;
  54         u32             int_select;
  55         u32             int_enable;
  56         u32             soft_int;
  57         u32             protect;
  58         struct irq_domain domain;
  59 };
  60
  61 /* we cannot allocate memory when VICs are initially registered */
  62 static struct vic_device vic_devices[CONFIG_ARM_VIC_NR];
  63
  64 static int vic_id;
  65
  66 /**
  67  * vic_init2 - common initialisation code
  68  * @base: Base of the VIC.
  69  *
  70  * Common initialisation code for registration
  71  * and resume.
  72 */
  73 static void vic_init2(void __iomem *base)
  74 {
  75         int i;
  76
  77         for (i = 0; i < 16; i++) {
  78                 void __iomem *reg = base + VIC_VECT_CNTL0 + (i * 4);
  79                 writel(VIC_VECT_CNTL_ENABLE | i, reg);
  80         }
  81
  82         writel(32, base + VIC_PL190_DEF_VECT_ADDR);
  83 }
  84
  85 #ifdef CONFIG_PM
  86 static void resume_one_vic(struct vic_device *vic)
  87 {
  88         void __iomem *base = vic->base;
  89
  90         printk(KERN_DEBUG "%s: resuming vic at %p\n", __func__, base);
  91
  92         /* re-initialise static settings */
  93         vic_init2(base);
  94
  95         writel(vic->int_select, base + VIC_INT_SELECT);
  96         writel(vic->protect, base + VIC_PROTECT);
  97
  98         /* set the enabled ints and then clear the non-enabled */
  99         writel(vic->int_enable, base + VIC_INT_ENABLE);
 100         writel(~vic->int_enable, base + VIC_INT_ENABLE_CLEAR);
 101
 102         /* and the same for the soft-int register */
 103
 104         writel(vic->soft_int, base + VIC_INT_SOFT);
 105         writel(~vic->soft_int, base + VIC_INT_SOFT_CLEAR);
 106 }
 107
 108 static void vic_resume(void)
 109 {
 110         int id;
 111
 112         for (id = vic_id - 1; id >= 0; id--)
 113                 resume_one_vic(vic_devices + id);
 114 }
 115
 116 static void suspend_one_vic(struct vic_device *vic)
 117 {
 118         void __iomem *base = vic->base;
 119
 120         printk(KERN_DEBUG "%s: suspending vic at %p\n", __func__, base);
 121
 122         vic->int_select = readl(base + VIC_INT_SELECT);
 123         vic->int_enable = readl(base + VIC_INT_ENABLE);
 124         vic->soft_int = readl(base + VIC_INT_SOFT);
 125         vic->protect = readl(base + VIC_PROTECT);
 126
 127         /* set the interrupts (if any) that are used for
 128          * resuming the system */
 129
 130         writel(vic->resume_irqs, base + VIC_INT_ENABLE);
 131         writel(~vic->resume_irqs, base + VIC_INT_ENABLE_CLEAR);
 132 }
 133
 134 static int vic_suspend(void)
 135 {
 136         int id;
 137
 138         for (id = 0; id < vic_id; id++)
 139                 suspend_one_vic(vic_devices + id);
 140
 141         return 0;
 142 }
 143
 144 struct syscore_ops vic_syscore_ops = {
 145         .suspend        = vic_suspend,
 146         .resume         = vic_resume,
 147 };
 148
 149 /**
 150  * vic_pm_init - initicall to register VIC pm
 151  *
 152  * This is called via late_initcall() to register
 153  * the resources for the VICs due to the early
 154  * nature of the VIC's registration.
 155 */
 156 static int __init vic_pm_init(void)
 157 {
 158         if (vic_id > 0)
 159                 register_syscore_ops(&vic_syscore_ops);
 160
 161         return 0;
 162 }
 163 late_initcall(vic_pm_init);
 164 #endif /* CONFIG_PM */
 165
 166 /**
 167  * vic_register() - Register a VIC.
 168  * @base: The base address of the VIC.
 169  * @irq: The base IRQ for the VIC.
 170  * @resume_sources: bitmask of interrupts allowed for resume sources.
 171  * @node: The device tree node associated with the VIC.
 172  *
 173  * Register the VIC with the system device tree so that it can be notified
 174  * of suspend and resume requests and ensure that the correct actions are
 175  * taken to re-instate the settings on resume.
 176  *
 177  * This also configures the IRQ domain for the VIC.
 178  */
 179 static void __init vic_register(void __iomem *base, unsigned int irq,
 180                                 u32 resume_sources, struct device_node *node)
 181 {
 182         struct vic_device *v;
 183
 184         if (vic_id >= ARRAY_SIZE(vic_devices)) {
 185                 printk(KERN_ERR "%s: too few VICs, increase CONFIG_ARM_VIC_NR\n", __func__);
 186                 return;
 187         }
 188
 189         v = &vic_devices[vic_id];
 190         v->base = base;
 191         v->resume_sources = resume_sources;
 192         v->irq = irq;
 193         vic_id++;
 194
 195         v->domain.irq_base = irq;
 196         v->domain.nr_irq = 32;
 197 #ifdef CONFIG_OF_IRQ
 198         v->domain.of_node = of_node_get(node);
 199         v->domain.ops = &irq_domain_simple_ops;
 200 #endif /* CONFIG_OF */
 201         irq_domain_add(&v->domain);
 202 }
 203
 204 static void vic_ack_irq(struct irq_data *d)
 205 {
 206         void __iomem *base = irq_data_get_irq_chip_data(d);
 207         unsigned int irq = d->hwirq;
 208         writel(1 << irq, base + VIC_INT_ENABLE_CLEAR);
 209         /* moreover, clear the soft-triggered, in case it was the reason */
 210         writel(1 << irq, base + VIC_INT_SOFT_CLEAR);
 211 }
 212
 213 static void vic_mask_irq(struct irq_data *d)
 214 {
 215         void __iomem *base = irq_data_get_irq_chip_data(d);
 216         unsigned int irq = d->hwirq;
 217         writel(1 << irq, base + VIC_INT_ENABLE_CLEAR);
 218 }
 219
 220 static void vic_unmask_irq(struct irq_data *d)
 221 {
 222         void __iomem *base = irq_data_get_irq_chip_data(d);
 223         unsigned int irq = d->hwirq;
 224         writel(1 << irq, base + VIC_INT_ENABLE);
 225 }
 226
 227 #if defined(CONFIG_PM)
 228 static struct vic_device *vic_from_irq(unsigned int irq)
 229 {
 230         struct vic_device *v = vic_devices;
 231         unsigned int base_irq = irq & ~31;
 232         int id;
 233
 234         for (id = 0; id < vic_id; id++, v++) {
 235                 if (v->irq == base_irq)
 236                         return v;
 237         }
 238
 239         return NULL;
 240 }
 241
 242 static int vic_set_wake(struct irq_data *d, unsigned int on)
 243 {
 244         struct vic_device *v = vic_from_irq(d->irq);
 245         unsigned int off = d->hwirq;
 246         u32 bit = 1 << off;
 247
 248         if (!v)
 249                 return -EINVAL;
 250
 251         if (!(bit & v->resume_sources))
 252                 return -EINVAL;
 253
 254         if (on)
 255                 v->resume_irqs |= bit;
 256         else
 257                 v->resume_irqs &= ~bit;
 258
 259         return 0;
 260 }
 261 #else
 262 #define vic_set_wake NULL
 263 #endif /* CONFIG_PM */
 264
 265 static struct irq_chip vic_chip = {
 266         .name           = "VIC",
 267         .irq_ack        = vic_ack_irq,
 268         .irq_mask       = vic_mask_irq,
 269         .irq_unmask     = vic_unmask_irq,
 270         .irq_set_wake   = vic_set_wake,
 271 };
 272
 273 static void __init vic_disable(void __iomem *base)
 274 {
 275         writel(0, base + VIC_INT_SELECT);
 276         writel(0, base + VIC_INT_ENABLE);
 277         writel(~0, base + VIC_INT_ENABLE_CLEAR);
 278         writel(0, base + VIC_ITCR);
 279         writel(~0, base + VIC_INT_SOFT_CLEAR);
 280 }
 281
 282 static void __init vic_clear_interrupts(void __iomem *base)
 283 {
 284         unsigned int i;
 285
 286         writel(0, base + VIC_PL190_VECT_ADDR);
 287         for (i = 0; i < 19; i++) {
 288                 unsigned int value;
 289
 290                 value = readl(base + VIC_PL190_VECT_ADDR);
 291                 writel(value, base + VIC_PL190_VECT_ADDR);
 292         }
 293 }
 294
 295 static void __init vic_set_irq_sources(void __iomem *base,
 296                                 unsigned int irq_start, u32 vic_sources)
 297 {
 298         unsigned int i;
 299
 300         for (i = 0; i < 32; i++) {
 301                 if (vic_sources & (1 << i)) {
 302                         unsigned int irq = irq_start + i;
 303
 304                         irq_set_chip_and_handler(irq, &vic_chip,
 305                                                  handle_level_irq);
 306                         irq_set_chip_data(irq, base);
 307                         set_irq_flags(irq, IRQF_VALID | IRQF_PROBE);
 308                 }
 309         }
 310 }
 311
 312 /*
 313  * The PL190 cell from ARM has been modified by ST to handle 64 interrupts.
 314  * The original cell has 32 interrupts, while the modified one has 64,
 315  * replocating two blocks 0x00..0x1f in 0x20..0x3f. In that case
 316  * the probe function is called twice, with base set to offset 000
 317  *  and 020 within the page. We call this "second block".
 318  */
 319 static void __init vic_init_st(void __iomem *base, unsigned int irq_start,
 320                                 u32 vic_sources)
 321 {
 322         unsigned int i;
 323         int vic_2nd_block = ((unsigned long)base & ~PAGE_MASK) != 0;
 324
 325         /* Disable all interrupts initially. */
 326         vic_disable(base);
 327
 328         /*
 329          * Make sure we clear all existing interrupts. The vector registers
 330          * in this cell are after the second block of general registers,
 331          * so we can address them using standard offsets, but only from
 332          * the second base address, which is 0x20 in the page
 333          */
 334         if (vic_2nd_block) {
 335                 vic_clear_interrupts(base);
 336
 337                 /* ST has 16 vectors as well, but we don't enable them by now */
 338                 for (i = 0; i < 16; i++) {
 339                         void __iomem *reg = base + VIC_VECT_CNTL0 + (i * 4);
 340                         writel(0, reg);
 341                 }
 342
 343                 writel(32, base + VIC_PL190_DEF_VECT_ADDR);
 344         }
 345
 346         vic_set_irq_sources(base, irq_start, vic_sources);
 347 }
 348
 349 static void __init __vic_init(void __iomem *base, unsigned int irq_start,
 350                               u32 vic_sources, u32 resume_sources,
 351                               struct device_node *node)
 352 {
 353         unsigned int i;
 354         u32 cellid = 0;
 355         enum amba_vendor vendor;
 356
 357         /* Identify which VIC cell this one is, by reading the ID */
 358         for (i = 0; i < 4; i++) {
 359                 void __iomem *addr;
 360                 addr = (void __iomem *)((u32)base & PAGE_MASK) + 0xfe0 + (i * 4);
 361                 cellid |= (readl(addr) & 0xff) << (8 * i);
 362         }
 363         vendor = (cellid >> 12) & 0xff;
 364         printk(KERN_INFO "VIC @%p: id 0x%08x, vendor 0x%02x\n",
 365                base, cellid, vendor);
 366
 367         switch(vendor) {
 368         case AMBA_VENDOR_ST:
 369                 vic_init_st(base, irq_start, vic_sources);
 370                 return;
 371         default:
 372                 printk(KERN_WARNING "VIC: unknown vendor, continuing anyways\n");
 373                 /* fall through */
 374         case AMBA_VENDOR_ARM:
 375                 break;
 376         }
 377
 378         /* Disable all interrupts initially. */
 379         vic_disable(base);
 380
 381         /* Make sure we clear all existing interrupts */
 382         vic_clear_interrupts(base);
 383
 384         vic_init2(base);
 385
 386         vic_set_irq_sources(base, irq_start, vic_sources);
 387
 388         vic_register(base, irq_start, resume_sources, node);
 389 }
 390
 391 /**
 392  * vic_init() - initialise a vectored interrupt controller
 393  * @base: iomem base address
 394  * @irq_start: starting interrupt number, must be muliple of 32
 395  * @vic_sources: bitmask of interrupt sources to allow
 396  * @resume_sources: bitmask of interrupt sources to allow for resume
 397  */
 398 void __init vic_init(void __iomem *base, unsigned int irq_start,
 399                      u32 vic_sources, u32 resume_sources)
 400 {
 401         __vic_init(base, irq_start, vic_sources, resume_sources, NULL);
 402 }
 403
 404 #ifdef CONFIG_OF
 405 int __init vic_of_init(struct device_node *node, struct device_node *parent)
 406 {
 407         void __iomem *regs;
 408         int irq_base;
 409
 410         if (WARN(parent, "non-root VICs are not supported"))
 411                 return -EINVAL;
 412
 413         regs = of_iomap(node, 0);
 414         if (WARN_ON(!regs))
 415                 return -EIO;
 416
 417         irq_base = irq_alloc_descs(-1, 0, 32, numa_node_id());
 418         if (WARN_ON(irq_base < 0))
 419                 goto out_unmap;
 420
 421         __vic_init(regs, irq_base, ~0, ~0, node);
 422
 423         return 0;
 424
 425  out_unmap:
 426         iounmap(regs);
 427
 428         return -EIO;
 429 }
 430 #endif /* CONFIG OF */