1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2007-2011 Freescale Semiconductor, Inc.
8 * The hwirq alloc and free code reuse from sysdev/mpic_msi.c
10 #include <linux/irq.h>
11 #include <linux/msi.h>
12 #include <linux/pci.h>
13 #include <linux/slab.h>
14 #include <linux/of_address.h>
15 #include <linux/of_irq.h>
16 #include <linux/of_platform.h>
17 #include <linux/interrupt.h>
18 #include <linux/irqdomain.h>
19 #include <linux/seq_file.h>
20 #include <sysdev/fsl_soc.h>
21 #include <asm/hw_irq.h>
22 #include <asm/ppc-pci.h>
24 #include <asm/fsl_hcalls.h>
29 #define MSIIR_OFFSET_MASK 0xfffff
30 #define MSIIR_IBS_SHIFT 0
31 #define MSIIR_SRS_SHIFT 5
32 #define MSIIR1_IBS_SHIFT 4
33 #define MSIIR1_SRS_SHIFT 0
34 #define MSI_SRS_MASK 0xf
35 #define MSI_IBS_MASK 0x1f
37 #define msi_hwirq(msi, msir_index, intr_index) \
38 ((msir_index) << (msi)->srs_shift | \
39 ((intr_index) << (msi)->ibs_shift))
41 static LIST_HEAD(msi_head);
43 struct fsl_msi_feature {
45 u32 msiir_offset; /* Offset of MSIIR, relative to start of MSIR bank */
48 struct fsl_msi_cascade_data {
49 struct fsl_msi *msi_data;
54 static inline u32 fsl_msi_read(u32 __iomem *base, unsigned int reg)
56 return in_be32(base + (reg >> 2));
60 * We do not need this actually. The MSIR register has been read once
61 * in the cascade interrupt. So, this MSI interrupt has been acked
63 static void fsl_msi_end_irq(struct irq_data *d)
67 static void fsl_msi_print_chip(struct irq_data *irqd, struct seq_file *p)
69 struct fsl_msi *msi_data = irqd->domain->host_data;
70 irq_hw_number_t hwirq = irqd_to_hwirq(irqd);
71 int cascade_virq, srs;
73 srs = (hwirq >> msi_data->srs_shift) & MSI_SRS_MASK;
74 cascade_virq = msi_data->cascade_array[srs]->virq;
76 seq_printf(p, " fsl-msi-%d", cascade_virq);
80 static struct irq_chip fsl_msi_chip = {
81 .irq_mask = pci_msi_mask_irq,
82 .irq_unmask = pci_msi_unmask_irq,
83 .irq_ack = fsl_msi_end_irq,
84 .irq_print_chip = fsl_msi_print_chip,
87 static int fsl_msi_host_map(struct irq_domain *h, unsigned int virq,
90 struct fsl_msi *msi_data = h->host_data;
91 struct irq_chip *chip = &fsl_msi_chip;
93 irq_set_status_flags(virq, IRQ_TYPE_EDGE_FALLING);
95 irq_set_chip_data(virq, msi_data);
96 irq_set_chip_and_handler(virq, chip, handle_edge_irq);
101 static const struct irq_domain_ops fsl_msi_host_ops = {
102 .map = fsl_msi_host_map,
105 static int fsl_msi_init_allocator(struct fsl_msi *msi_data)
109 rc = msi_bitmap_alloc(&msi_data->bitmap, NR_MSI_IRQS_MAX,
110 irq_domain_get_of_node(msi_data->irqhost));
115 * Reserve all the hwirqs
116 * The available hwirqs will be released in fsl_msi_setup_hwirq()
118 for (hwirq = 0; hwirq < NR_MSI_IRQS_MAX; hwirq++)
119 msi_bitmap_reserve_hwirq(&msi_data->bitmap, hwirq);
124 static void fsl_teardown_msi_irqs(struct pci_dev *pdev)
126 struct msi_desc *entry;
127 struct fsl_msi *msi_data;
128 irq_hw_number_t hwirq;
130 msi_for_each_desc(entry, &pdev->dev, MSI_DESC_ASSOCIATED) {
131 hwirq = virq_to_hw(entry->irq);
132 msi_data = irq_get_chip_data(entry->irq);
133 irq_set_msi_desc(entry->irq, NULL);
134 irq_dispose_mapping(entry->irq);
135 msi_bitmap_free_hwirqs(&msi_data->bitmap, hwirq, 1);
139 static void fsl_compose_msi_msg(struct pci_dev *pdev, int hwirq,
141 struct fsl_msi *fsl_msi_data)
143 struct fsl_msi *msi_data = fsl_msi_data;
144 struct pci_controller *hose = pci_bus_to_host(pdev->bus);
145 u64 address; /* Physical address of the MSIIR */
149 /* If the msi-address-64 property exists, then use it */
150 reg = of_get_property(hose->dn, "msi-address-64", &len);
151 if (reg && (len == sizeof(u64)))
152 address = be64_to_cpup(reg);
154 address = fsl_pci_immrbar_base(hose) + msi_data->msiir_offset;
156 msg->address_lo = lower_32_bits(address);
157 msg->address_hi = upper_32_bits(address);
160 * MPIC version 2.0 has erratum PIC1. It causes
161 * that neither MSI nor MSI-X can work fine.
162 * This is a workaround to allow MSI-X to function
163 * properly. It only works for MSI-X, we prevent
164 * MSI on buggy chips in fsl_setup_msi_irqs().
166 if (msi_data->feature & MSI_HW_ERRATA_ENDIAN)
167 msg->data = __swab32(hwirq);
171 pr_debug("%s: allocated srs: %d, ibs: %d\n", __func__,
172 (hwirq >> msi_data->srs_shift) & MSI_SRS_MASK,
173 (hwirq >> msi_data->ibs_shift) & MSI_IBS_MASK);
176 static int fsl_setup_msi_irqs(struct pci_dev *pdev, int nvec, int type)
178 struct pci_controller *hose = pci_bus_to_host(pdev->bus);
179 struct device_node *np;
181 int rc, hwirq = -ENOMEM;
183 struct msi_desc *entry;
185 struct fsl_msi *msi_data;
187 if (type == PCI_CAP_ID_MSI) {
189 * MPIC version 2.0 has erratum PIC1. For now MSI
190 * could not work. So check to prevent MSI from
191 * being used on the board with this erratum.
193 list_for_each_entry(msi_data, &msi_head, list)
194 if (msi_data->feature & MSI_HW_ERRATA_ENDIAN)
199 * If the PCI node has an fsl,msi property, then we need to use it
200 * to find the specific MSI.
202 np = of_parse_phandle(hose->dn, "fsl,msi", 0);
204 if (of_device_is_compatible(np, "fsl,mpic-msi") ||
205 of_device_is_compatible(np, "fsl,vmpic-msi") ||
206 of_device_is_compatible(np, "fsl,vmpic-msi-v4.3"))
207 phandle = np->phandle;
210 "node %pOF has an invalid fsl,msi phandle %u\n",
211 hose->dn, np->phandle);
218 msi_for_each_desc(entry, &pdev->dev, MSI_DESC_NOTASSOCIATED) {
220 * Loop over all the MSI devices until we find one that has an
221 * available interrupt.
223 list_for_each_entry(msi_data, &msi_head, list) {
225 * If the PCI node has an fsl,msi property, then we
226 * restrict our search to the corresponding MSI node.
227 * The simplest way is to skip over MSI nodes with the
228 * wrong phandle. Under the Freescale hypervisor, this
229 * has the additional benefit of skipping over MSI
230 * nodes that are not mapped in the PAMU.
232 if (phandle && (phandle != msi_data->phandle))
235 hwirq = msi_bitmap_alloc_hwirqs(&msi_data->bitmap, 1);
242 dev_err(&pdev->dev, "could not allocate MSI interrupt\n");
246 virq = irq_create_mapping(msi_data->irqhost, hwirq);
249 dev_err(&pdev->dev, "fail mapping hwirq %i\n", hwirq);
250 msi_bitmap_free_hwirqs(&msi_data->bitmap, hwirq, 1);
254 /* chip_data is msi_data via host->hostdata in host->map() */
255 irq_set_msi_desc(virq, entry);
257 fsl_compose_msi_msg(pdev, hwirq, &msg, msi_data);
258 pci_write_msi_msg(virq, &msg);
263 /* free by the caller of this function */
267 static irqreturn_t fsl_msi_cascade(int irq, void *data)
269 struct fsl_msi *msi_data;
274 struct fsl_msi_cascade_data *cascade_data = data;
275 irqreturn_t ret = IRQ_NONE;
277 msi_data = cascade_data->msi_data;
279 msir_index = cascade_data->index;
281 switch (msi_data->feature & FSL_PIC_IP_MASK) {
282 case FSL_PIC_IP_MPIC:
283 msir_value = fsl_msi_read(msi_data->msi_regs,
286 case FSL_PIC_IP_IPIC:
287 msir_value = fsl_msi_read(msi_data->msi_regs, msir_index * 0x4);
289 #ifdef CONFIG_EPAPR_PARAVIRT
290 case FSL_PIC_IP_VMPIC: {
292 ret = fh_vmpic_get_msir(virq_to_hw(irq), &msir_value);
294 pr_err("fsl-msi: fh_vmpic_get_msir() failed for "
295 "irq %u (ret=%u)\n", irq, ret);
305 intr_index = ffs(msir_value) - 1;
307 err = generic_handle_domain_irq(msi_data->irqhost,
308 msi_hwirq(msi_data, msir_index,
309 intr_index + have_shift));
313 have_shift += intr_index + 1;
314 msir_value = msir_value >> (intr_index + 1);
320 static int fsl_of_msi_remove(struct platform_device *ofdev)
322 struct fsl_msi *msi = platform_get_drvdata(ofdev);
325 if (msi->list.prev != NULL)
326 list_del(&msi->list);
327 for (i = 0; i < NR_MSI_REG_MAX; i++) {
328 if (msi->cascade_array[i]) {
329 virq = msi->cascade_array[i]->virq;
333 free_irq(virq, msi->cascade_array[i]);
334 kfree(msi->cascade_array[i]);
335 irq_dispose_mapping(virq);
338 if (msi->bitmap.bitmap)
339 msi_bitmap_free(&msi->bitmap);
340 if ((msi->feature & FSL_PIC_IP_MASK) != FSL_PIC_IP_VMPIC)
341 iounmap(msi->msi_regs);
347 static struct lock_class_key fsl_msi_irq_class;
348 static struct lock_class_key fsl_msi_irq_request_class;
350 static int fsl_msi_setup_hwirq(struct fsl_msi *msi, struct platform_device *dev,
351 int offset, int irq_index)
353 struct fsl_msi_cascade_data *cascade_data = NULL;
354 int virt_msir, i, ret;
356 virt_msir = irq_of_parse_and_map(dev->dev.of_node, irq_index);
358 dev_err(&dev->dev, "%s: Cannot translate IRQ index %d\n",
359 __func__, irq_index);
363 cascade_data = kzalloc(sizeof(struct fsl_msi_cascade_data), GFP_KERNEL);
365 dev_err(&dev->dev, "No memory for MSI cascade data\n");
368 irq_set_lockdep_class(virt_msir, &fsl_msi_irq_class,
369 &fsl_msi_irq_request_class);
370 cascade_data->index = offset;
371 cascade_data->msi_data = msi;
372 cascade_data->virq = virt_msir;
373 msi->cascade_array[irq_index] = cascade_data;
375 ret = request_irq(virt_msir, fsl_msi_cascade, IRQF_NO_THREAD,
376 "fsl-msi-cascade", cascade_data);
378 dev_err(&dev->dev, "failed to request_irq(%d), ret = %d\n",
383 /* Release the hwirqs corresponding to this MSI register */
384 for (i = 0; i < IRQS_PER_MSI_REG; i++)
385 msi_bitmap_free_hwirqs(&msi->bitmap,
386 msi_hwirq(msi, offset, i), 1);
391 static const struct of_device_id fsl_of_msi_ids[];
392 static int fsl_of_msi_probe(struct platform_device *dev)
394 const struct of_device_id *match;
396 struct resource res, msiir;
397 int err, i, j, irq_index, count;
399 const struct fsl_msi_feature *features;
402 struct pci_controller *phb;
404 match = of_match_device(fsl_of_msi_ids, &dev->dev);
407 features = match->data;
409 printk(KERN_DEBUG "Setting up Freescale MSI support\n");
411 msi = kzalloc(sizeof(struct fsl_msi), GFP_KERNEL);
413 dev_err(&dev->dev, "No memory for MSI structure\n");
416 platform_set_drvdata(dev, msi);
418 msi->irqhost = irq_domain_add_linear(dev->dev.of_node,
419 NR_MSI_IRQS_MAX, &fsl_msi_host_ops, msi);
421 if (msi->irqhost == NULL) {
422 dev_err(&dev->dev, "No memory for MSI irqhost\n");
428 * Under the Freescale hypervisor, the msi nodes don't have a 'reg'
429 * property. Instead, we use hypercalls to access the MSI.
431 if ((features->fsl_pic_ip & FSL_PIC_IP_MASK) != FSL_PIC_IP_VMPIC) {
432 err = of_address_to_resource(dev->dev.of_node, 0, &res);
434 dev_err(&dev->dev, "invalid resource for node %pOF\n",
439 msi->msi_regs = ioremap(res.start, resource_size(&res));
440 if (!msi->msi_regs) {
442 dev_err(&dev->dev, "could not map node %pOF\n",
447 features->msiir_offset + (res.start & 0xfffff);
450 * First read the MSIIR/MSIIR1 offset from dts
451 * On failure use the hardcode MSIIR offset
453 if (of_address_to_resource(dev->dev.of_node, 1, &msiir))
454 msi->msiir_offset = features->msiir_offset +
455 (res.start & MSIIR_OFFSET_MASK);
457 msi->msiir_offset = msiir.start & MSIIR_OFFSET_MASK;
460 msi->feature = features->fsl_pic_ip;
462 /* For erratum PIC1 on MPIC version 2.0*/
463 if ((features->fsl_pic_ip & FSL_PIC_IP_MASK) == FSL_PIC_IP_MPIC
464 && (fsl_mpic_primary_get_version() == 0x0200))
465 msi->feature |= MSI_HW_ERRATA_ENDIAN;
468 * Remember the phandle, so that we can match with any PCI nodes
469 * that have an "fsl,msi" property.
471 msi->phandle = dev->dev.of_node->phandle;
473 err = fsl_msi_init_allocator(msi);
475 dev_err(&dev->dev, "Error allocating MSI bitmap\n");
479 p = of_get_property(dev->dev.of_node, "msi-available-ranges", &len);
481 if (of_device_is_compatible(dev->dev.of_node, "fsl,mpic-msi-v4.3") ||
482 of_device_is_compatible(dev->dev.of_node, "fsl,vmpic-msi-v4.3")) {
483 msi->srs_shift = MSIIR1_SRS_SHIFT;
484 msi->ibs_shift = MSIIR1_IBS_SHIFT;
486 dev_warn(&dev->dev, "%s: dose not support msi-available-ranges property\n",
489 for (irq_index = 0; irq_index < NR_MSI_REG_MSIIR1;
491 err = fsl_msi_setup_hwirq(msi, dev,
492 irq_index, irq_index);
497 static const u32 all_avail[] =
498 { 0, NR_MSI_REG_MSIIR * IRQS_PER_MSI_REG };
500 msi->srs_shift = MSIIR_SRS_SHIFT;
501 msi->ibs_shift = MSIIR_IBS_SHIFT;
503 if (p && len % (2 * sizeof(u32)) != 0) {
504 dev_err(&dev->dev, "%s: Malformed msi-available-ranges property\n",
512 len = sizeof(all_avail);
515 for (irq_index = 0, i = 0; i < len / (2 * sizeof(u32)); i++) {
516 if (p[i * 2] % IRQS_PER_MSI_REG ||
517 p[i * 2 + 1] % IRQS_PER_MSI_REG) {
518 pr_warn("%s: %pOF: msi available range of %u at %u is not IRQ-aligned\n",
519 __func__, dev->dev.of_node,
520 p[i * 2 + 1], p[i * 2]);
525 offset = p[i * 2] / IRQS_PER_MSI_REG;
526 count = p[i * 2 + 1] / IRQS_PER_MSI_REG;
528 for (j = 0; j < count; j++, irq_index++) {
529 err = fsl_msi_setup_hwirq(msi, dev, offset + j,
537 list_add_tail(&msi->list, &msi_head);
540 * Apply the MSI ops to all the controllers.
541 * It doesn't hurt to reassign the same ops,
542 * but bail out if we find another MSI driver.
544 list_for_each_entry(phb, &hose_list, list_node) {
545 if (!phb->controller_ops.setup_msi_irqs) {
546 phb->controller_ops.setup_msi_irqs = fsl_setup_msi_irqs;
547 phb->controller_ops.teardown_msi_irqs = fsl_teardown_msi_irqs;
548 } else if (phb->controller_ops.setup_msi_irqs != fsl_setup_msi_irqs) {
549 dev_err(&dev->dev, "Different MSI driver already installed!\n");
556 fsl_of_msi_remove(dev);
560 static const struct fsl_msi_feature mpic_msi_feature = {
561 .fsl_pic_ip = FSL_PIC_IP_MPIC,
562 .msiir_offset = 0x140,
565 static const struct fsl_msi_feature ipic_msi_feature = {
566 .fsl_pic_ip = FSL_PIC_IP_IPIC,
567 .msiir_offset = 0x38,
570 static const struct fsl_msi_feature vmpic_msi_feature = {
571 .fsl_pic_ip = FSL_PIC_IP_VMPIC,
575 static const struct of_device_id fsl_of_msi_ids[] = {
577 .compatible = "fsl,mpic-msi",
578 .data = &mpic_msi_feature,
581 .compatible = "fsl,mpic-msi-v4.3",
582 .data = &mpic_msi_feature,
585 .compatible = "fsl,ipic-msi",
586 .data = &ipic_msi_feature,
588 #ifdef CONFIG_EPAPR_PARAVIRT
590 .compatible = "fsl,vmpic-msi",
591 .data = &vmpic_msi_feature,
594 .compatible = "fsl,vmpic-msi-v4.3",
595 .data = &vmpic_msi_feature,
601 static struct platform_driver fsl_of_msi_driver = {
604 .of_match_table = fsl_of_msi_ids,
606 .probe = fsl_of_msi_probe,
607 .remove = fsl_of_msi_remove,
610 static __init int fsl_of_msi_init(void)
612 return platform_driver_register(&fsl_of_msi_driver);
615 subsys_initcall(fsl_of_msi_init);