arch/powerpc/sysdev/fsl_msi.c

   1 /*
   2  * Copyright (C) 2007-2011 Freescale Semiconductor, Inc.
   3  *
   4  * Author: Tony Li <tony.li@freescale.com>
   5  *         Jason Jin <Jason.jin@freescale.com>
   6  *
   7  * The hwirq alloc and free code reuse from sysdev/mpic_msi.c
   8  *
   9  * This program is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License
  11  * as published by the Free Software Foundation; version 2 of the
  12  * License.
  13  *
  14  */
  15 #include <linux/irq.h>
  16 #include <linux/bootmem.h>
  17 #include <linux/msi.h>
  18 #include <linux/pci.h>
  19 #include <linux/slab.h>
  20 #include <linux/of_platform.h>
  21 #include <sysdev/fsl_soc.h>
  22 #include <asm/prom.h>
  23 #include <asm/hw_irq.h>
  24 #include <asm/ppc-pci.h>
  25 #include <asm/mpic.h>
  26 #include "fsl_msi.h"
  27 #include "fsl_pci.h"
  28
  29 LIST_HEAD(msi_head);
  30
  31 struct fsl_msi_feature {
  32         u32 fsl_pic_ip;
  33         u32 msiir_offset; /* Offset of MSIIR, relative to start of MSIR bank */
  34 };
  35
  36 struct fsl_msi_cascade_data {
  37         struct fsl_msi *msi_data;
  38         int index;
  39 };
  40
  41 static inline u32 fsl_msi_read(u32 __iomem *base, unsigned int reg)
  42 {
  43         return in_be32(base + (reg >> 2));
  44 }
  45
  46 /*
  47  * We do not need this actually. The MSIR register has been read once
  48  * in the cascade interrupt. So, this MSI interrupt has been acked
  49 */
  50 static void fsl_msi_end_irq(struct irq_data *d)
  51 {
  52 }
  53
  54 static struct irq_chip fsl_msi_chip = {
  55         .irq_mask       = mask_msi_irq,
  56         .irq_unmask     = unmask_msi_irq,
  57         .irq_ack        = fsl_msi_end_irq,
  58         .name           = "FSL-MSI",
  59 };
  60
  61 static int fsl_msi_host_map(struct irq_host *h, unsigned int virq,
  62                                 irq_hw_number_t hw)
  63 {
  64         struct fsl_msi *msi_data = h->host_data;
  65         struct irq_chip *chip = &fsl_msi_chip;
  66
  67         irq_set_status_flags(virq, IRQ_TYPE_EDGE_FALLING);
  68
  69         irq_set_chip_data(virq, msi_data);
  70         irq_set_chip_and_handler(virq, chip, handle_edge_irq);
  71
  72         return 0;
  73 }
  74
  75 static struct irq_host_ops fsl_msi_host_ops = {
  76         .map = fsl_msi_host_map,
  77 };
  78
  79 static int fsl_msi_init_allocator(struct fsl_msi *msi_data)
  80 {
  81         int rc;
  82
  83         rc = msi_bitmap_alloc(&msi_data->bitmap, NR_MSI_IRQS,
  84                               msi_data->irqhost->of_node);
  85         if (rc)
  86                 return rc;
  87
  88         rc = msi_bitmap_reserve_dt_hwirqs(&msi_data->bitmap);
  89         if (rc < 0) {
  90                 msi_bitmap_free(&msi_data->bitmap);
  91                 return rc;
  92         }
  93
  94         return 0;
  95 }
  96
  97 static int fsl_msi_check_device(struct pci_dev *pdev, int nvec, int type)
  98 {
  99         if (type == PCI_CAP_ID_MSIX)
 100                 pr_debug("fslmsi: MSI-X untested, trying anyway.\n");
 101
 102         return 0;
 103 }
 104
 105 static void fsl_teardown_msi_irqs(struct pci_dev *pdev)
 106 {
 107         struct msi_desc *entry;
 108         struct fsl_msi *msi_data;
 109         irq_hw_number_t hwirq;
 110
 111         list_for_each_entry(entry, &pdev->msi_list, list) {
 112                 if (entry->irq == NO_IRQ)
 113                         continue;
 114                 hwirq = virq_to_hw(entry->irq);
 115                 msi_data = irq_get_chip_data(entry->irq);
 116                 irq_set_msi_desc(entry->irq, NULL);
 117                 irq_dispose_mapping(entry->irq);
 118                 msi_bitmap_free_hwirqs(&msi_data->bitmap, hwirq, 1);
 119         }
 120
 121         return;
 122 }
 123
 124 static void fsl_compose_msi_msg(struct pci_dev *pdev, int hwirq,
 125                                 struct msi_msg *msg,
 126                                 struct fsl_msi *fsl_msi_data)
 127 {
 128         struct fsl_msi *msi_data = fsl_msi_data;
 129         struct pci_controller *hose = pci_bus_to_host(pdev->bus);
 130         u64 address; /* Physical address of the MSIIR */
 131         int len;
 132         const u64 *reg;
 133
 134         /* If the msi-address-64 property exists, then use it */
 135         reg = of_get_property(hose->dn, "msi-address-64", &len);
 136         if (reg && (len == sizeof(u64)))
 137                 address = be64_to_cpup(reg);
 138         else
 139                 address = fsl_pci_immrbar_base(hose) + msi_data->msiir_offset;
 140
 141         msg->address_lo = lower_32_bits(address);
 142         msg->address_hi = upper_32_bits(address);
 143
 144         msg->data = hwirq;
 145
 146         pr_debug("%s: allocated srs: %d, ibs: %d\n",
 147                 __func__, hwirq / IRQS_PER_MSI_REG, hwirq % IRQS_PER_MSI_REG);
 148 }
 149
 150 static int fsl_setup_msi_irqs(struct pci_dev *pdev, int nvec, int type)
 151 {
 152         int rc, hwirq = -ENOMEM;
 153         unsigned int virq;
 154         struct msi_desc *entry;
 155         struct msi_msg msg;
 156         struct fsl_msi *msi_data;
 157
 158         list_for_each_entry(entry, &pdev->msi_list, list) {
 159                 list_for_each_entry(msi_data, &msi_head, list) {
 160                         hwirq = msi_bitmap_alloc_hwirqs(&msi_data->bitmap, 1);
 161                         if (hwirq >= 0)
 162                                 break;
 163                 }
 164
 165                 if (hwirq < 0) {
 166                         rc = hwirq;
 167                         pr_debug("%s: fail allocating msi interrupt\n",
 168                                         __func__);
 169                         goto out_free;
 170                 }
 171
 172                 virq = irq_create_mapping(msi_data->irqhost, hwirq);
 173
 174                 if (virq == NO_IRQ) {
 175                         pr_debug("%s: fail mapping hwirq 0x%x\n",
 176                                         __func__, hwirq);
 177                         msi_bitmap_free_hwirqs(&msi_data->bitmap, hwirq, 1);
 178                         rc = -ENOSPC;
 179                         goto out_free;
 180                 }
 181                 /* chip_data is msi_data via host->hostdata in host->map() */
 182                 irq_set_msi_desc(virq, entry);
 183
 184                 fsl_compose_msi_msg(pdev, hwirq, &msg, msi_data);
 185                 write_msi_msg(virq, &msg);
 186         }
 187         return 0;
 188
 189 out_free:
 190         /* free by the caller of this function */
 191         return rc;
 192 }
 193
 194 static void fsl_msi_cascade(unsigned int irq, struct irq_desc *desc)
 195 {
 196         struct irq_chip *chip = irq_desc_get_chip(desc);
 197         struct irq_data *idata = irq_desc_get_irq_data(desc);
 198         unsigned int cascade_irq;
 199         struct fsl_msi *msi_data;
 200         int msir_index = -1;
 201         u32 msir_value = 0;
 202         u32 intr_index;
 203         u32 have_shift = 0;
 204         struct fsl_msi_cascade_data *cascade_data;
 205
 206         cascade_data = irq_get_handler_data(irq);
 207         msi_data = cascade_data->msi_data;
 208
 209         raw_spin_lock(&desc->lock);
 210         if ((msi_data->feature &  FSL_PIC_IP_MASK) == FSL_PIC_IP_IPIC) {
 211                 if (chip->irq_mask_ack)
 212                         chip->irq_mask_ack(idata);
 213                 else {
 214                         chip->irq_mask(idata);
 215                         chip->irq_ack(idata);
 216                 }
 217         }
 218
 219         if (unlikely(irqd_irq_inprogress(idata)))
 220                 goto unlock;
 221
 222         msir_index = cascade_data->index;
 223
 224         if (msir_index >= NR_MSI_REG)
 225                 cascade_irq = NO_IRQ;
 226
 227         irqd_set_chained_irq_inprogress(idata);
 228         switch (msi_data->feature & FSL_PIC_IP_MASK) {
 229         case FSL_PIC_IP_MPIC:
 230                 msir_value = fsl_msi_read(msi_data->msi_regs,
 231                         msir_index * 0x10);
 232                 break;
 233         case FSL_PIC_IP_IPIC:
 234                 msir_value = fsl_msi_read(msi_data->msi_regs, msir_index * 0x4);
 235                 break;
 236         }
 237
 238         while (msir_value) {
 239                 intr_index = ffs(msir_value) - 1;
 240
 241                 cascade_irq = irq_linear_revmap(msi_data->irqhost,
 242                                 msir_index * IRQS_PER_MSI_REG +
 243                                         intr_index + have_shift);
 244                 if (cascade_irq != NO_IRQ)
 245                         generic_handle_irq(cascade_irq);
 246                 have_shift += intr_index + 1;
 247                 msir_value = msir_value >> (intr_index + 1);
 248         }
 249         irqd_clr_chained_irq_inprogress(idata);
 250
 251         switch (msi_data->feature & FSL_PIC_IP_MASK) {
 252         case FSL_PIC_IP_MPIC:
 253                 chip->irq_eoi(idata);
 254                 break;
 255         case FSL_PIC_IP_IPIC:
 256                 if (!irqd_irq_disabled(idata) && chip->irq_unmask)
 257                         chip->irq_unmask(idata);
 258                 break;
 259         }
 260 unlock:
 261         raw_spin_unlock(&desc->lock);
 262 }
 263
 264 static int fsl_of_msi_remove(struct platform_device *ofdev)
 265 {
 266         struct fsl_msi *msi = platform_get_drvdata(ofdev);
 267         int virq, i;
 268         struct fsl_msi_cascade_data *cascade_data;
 269
 270         if (msi->list.prev != NULL)
 271                 list_del(&msi->list);
 272         for (i = 0; i < NR_MSI_REG; i++) {
 273                 virq = msi->msi_virqs[i];
 274                 if (virq != NO_IRQ) {
 275                         cascade_data = irq_get_handler_data(virq);
 276                         kfree(cascade_data);
 277                         irq_dispose_mapping(virq);
 278                 }
 279         }
 280         if (msi->bitmap.bitmap)
 281                 msi_bitmap_free(&msi->bitmap);
 282         iounmap(msi->msi_regs);
 283         kfree(msi);
 284
 285         return 0;
 286 }
 287
 288 static int __devinit fsl_msi_setup_hwirq(struct fsl_msi *msi,
 289                                          struct platform_device *dev,
 290                                          int offset, int irq_index)
 291 {
 292         struct fsl_msi_cascade_data *cascade_data = NULL;
 293         int virt_msir;
 294
 295         virt_msir = irq_of_parse_and_map(dev->dev.of_node, irq_index);
 296         if (virt_msir == NO_IRQ) {
 297                 dev_err(&dev->dev, "%s: Cannot translate IRQ index %d\n",
 298                         __func__, irq_index);
 299                 return 0;
 300         }
 301
 302         cascade_data = kzalloc(sizeof(struct fsl_msi_cascade_data), GFP_KERNEL);
 303         if (!cascade_data) {
 304                 dev_err(&dev->dev, "No memory for MSI cascade data\n");
 305                 return -ENOMEM;
 306         }
 307
 308         msi->msi_virqs[irq_index] = virt_msir;
 309         cascade_data->index = offset;
 310         cascade_data->msi_data = msi;
 311         irq_set_handler_data(virt_msir, cascade_data);
 312         irq_set_chained_handler(virt_msir, fsl_msi_cascade);
 313
 314         return 0;
 315 }
 316
 317 static const struct of_device_id fsl_of_msi_ids[];
 318 static int __devinit fsl_of_msi_probe(struct platform_device *dev)
 319 {
 320         const struct of_device_id *match;
 321         struct fsl_msi *msi;
 322         struct resource res;
 323         int err, i, j, irq_index, count;
 324         int rc;
 325         const u32 *p;
 326         struct fsl_msi_feature *features;
 327         int len;
 328         u32 offset;
 329         static const u32 all_avail[] = { 0, NR_MSI_IRQS };
 330
 331         match = of_match_device(fsl_of_msi_ids, &dev->dev);
 332         if (!match)
 333                 return -EINVAL;
 334         features = match->data;
 335
 336         printk(KERN_DEBUG "Setting up Freescale MSI support\n");
 337
 338         msi = kzalloc(sizeof(struct fsl_msi), GFP_KERNEL);
 339         if (!msi) {
 340                 dev_err(&dev->dev, "No memory for MSI structure\n");
 341                 return -ENOMEM;
 342         }
 343         platform_set_drvdata(dev, msi);
 344
 345         msi->irqhost = irq_alloc_host(dev->dev.of_node, IRQ_HOST_MAP_LINEAR,
 346                                       NR_MSI_IRQS, &fsl_msi_host_ops, 0);
 347
 348         if (msi->irqhost == NULL) {
 349                 dev_err(&dev->dev, "No memory for MSI irqhost\n");
 350                 err = -ENOMEM;
 351                 goto error_out;
 352         }
 353
 354         /* Get the MSI reg base */
 355         err = of_address_to_resource(dev->dev.of_node, 0, &res);
 356         if (err) {
 357                 dev_err(&dev->dev, "%s resource error!\n",
 358                                 dev->dev.of_node->full_name);
 359                 goto error_out;
 360         }
 361
 362         msi->msi_regs = ioremap(res.start, resource_size(&res));
 363         if (!msi->msi_regs) {
 364                 dev_err(&dev->dev, "ioremap problem failed\n");
 365                 goto error_out;
 366         }
 367
 368         msi->feature = features->fsl_pic_ip;
 369
 370         msi->irqhost->host_data = msi;
 371
 372         msi->msiir_offset = features->msiir_offset + (res.start & 0xfffff);
 373
 374         rc = fsl_msi_init_allocator(msi);
 375         if (rc) {
 376                 dev_err(&dev->dev, "Error allocating MSI bitmap\n");
 377                 goto error_out;
 378         }
 379
 380         p = of_get_property(dev->dev.of_node, "msi-available-ranges", &len);
 381         if (p && len % (2 * sizeof(u32)) != 0) {
 382                 dev_err(&dev->dev, "%s: Malformed msi-available-ranges property\n",
 383                         __func__);
 384                 err = -EINVAL;
 385                 goto error_out;
 386         }
 387
 388         if (!p) {
 389                 p = all_avail;
 390                 len = sizeof(all_avail);
 391         }
 392
 393         for (irq_index = 0, i = 0; i < len / (2 * sizeof(u32)); i++) {
 394                 if (p[i * 2] % IRQS_PER_MSI_REG ||
 395                     p[i * 2 + 1] % IRQS_PER_MSI_REG) {
 396                         printk(KERN_WARNING "%s: %s: msi available range of %u at %u is not IRQ-aligned\n",
 397                                __func__, dev->dev.of_node->full_name,
 398                                p[i * 2 + 1], p[i * 2]);
 399                         err = -EINVAL;
 400                         goto error_out;
 401                 }
 402
 403                 offset = p[i * 2] / IRQS_PER_MSI_REG;
 404                 count = p[i * 2 + 1] / IRQS_PER_MSI_REG;
 405
 406                 for (j = 0; j < count; j++, irq_index++) {
 407                         err = fsl_msi_setup_hwirq(msi, dev, offset + j, irq_index);
 408                         if (err)
 409                                 goto error_out;
 410                 }
 411         }
 412
 413         list_add_tail(&msi->list, &msi_head);
 414
 415         /* The multiple setting ppc_md.setup_msi_irqs will not harm things */
 416         if (!ppc_md.setup_msi_irqs) {
 417                 ppc_md.setup_msi_irqs = fsl_setup_msi_irqs;
 418                 ppc_md.teardown_msi_irqs = fsl_teardown_msi_irqs;
 419                 ppc_md.msi_check_device = fsl_msi_check_device;
 420         } else if (ppc_md.setup_msi_irqs != fsl_setup_msi_irqs) {
 421                 dev_err(&dev->dev, "Different MSI driver already installed!\n");
 422                 err = -ENODEV;
 423                 goto error_out;
 424         }
 425         return 0;
 426 error_out:
 427         fsl_of_msi_remove(dev);
 428         return err;
 429 }
 430
 431 static const struct fsl_msi_feature mpic_msi_feature = {
 432         .fsl_pic_ip = FSL_PIC_IP_MPIC,
 433         .msiir_offset = 0x140,
 434 };
 435
 436 static const struct fsl_msi_feature ipic_msi_feature = {
 437         .fsl_pic_ip = FSL_PIC_IP_IPIC,
 438         .msiir_offset = 0x38,
 439 };
 440
 441 static const struct of_device_id fsl_of_msi_ids[] = {
 442         {
 443                 .compatible = "fsl,mpic-msi",
 444                 .data = (void *)&mpic_msi_feature,
 445         },
 446         {
 447                 .compatible = "fsl,ipic-msi",
 448                 .data = (void *)&ipic_msi_feature,
 449         },
 450         {}
 451 };
 452
 453 static struct platform_driver fsl_of_msi_driver = {
 454         .driver = {
 455                 .name = "fsl-msi",
 456                 .owner = THIS_MODULE,
 457                 .of_match_table = fsl_of_msi_ids,
 458         },
 459         .probe = fsl_of_msi_probe,
 460         .remove = fsl_of_msi_remove,
 461 };
 462
 463 static __init int fsl_of_msi_init(void)
 464 {
 465         return platform_driver_register(&fsl_of_msi_driver);
 466 }
 467
 468 subsys_initcall(fsl_of_msi_init);