1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2007-2011 Freescale Semiconductor, Inc.
5 * Author: Tony Li <tony.li@freescale.com>
6 * Jason Jin <Jason.jin@freescale.com>
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>
15 #include <linux/of_address.h>
16 #include <linux/of_irq.h>
17 #include <linux/platform_device.h>
18 #include <linux/property.h>
19 #include <linux/interrupt.h>
20 #include <linux/irqdomain.h>
21 #include <linux/seq_file.h>
22 #include <sysdev/fsl_soc.h>
23 #include <asm/hw_irq.h>
24 #include <asm/ppc-pci.h>
26 #include <asm/fsl_hcalls.h>
31 #define MSIIR_OFFSET_MASK 0xfffff
32 #define MSIIR_IBS_SHIFT 0
33 #define MSIIR_SRS_SHIFT 5
34 #define MSIIR1_IBS_SHIFT 4
35 #define MSIIR1_SRS_SHIFT 0
36 #define MSI_SRS_MASK 0xf
37 #define MSI_IBS_MASK 0x1f
39 #define msi_hwirq(msi, msir_index, intr_index) \
40 ((msir_index) << (msi)->srs_shift | \
41 ((intr_index) << (msi)->ibs_shift))
43 static LIST_HEAD(msi_head
);
45 struct fsl_msi_feature
{
47 u32 msiir_offset
; /* Offset of MSIIR, relative to start of MSIR bank */
50 struct fsl_msi_cascade_data
{
51 struct fsl_msi
*msi_data
;
56 static inline u32
fsl_msi_read(u32 __iomem
*base
, unsigned int reg
)
58 return in_be32(base
+ (reg
>> 2));
62 * We do not need this actually. The MSIR register has been read once
63 * in the cascade interrupt. So, this MSI interrupt has been acked
65 static void fsl_msi_end_irq(struct irq_data
*d
)
69 static void fsl_msi_print_chip(struct irq_data
*irqd
, struct seq_file
*p
)
71 struct fsl_msi
*msi_data
= irqd
->domain
->host_data
;
72 irq_hw_number_t hwirq
= irqd_to_hwirq(irqd
);
73 int cascade_virq
, srs
;
75 srs
= (hwirq
>> msi_data
->srs_shift
) & MSI_SRS_MASK
;
76 cascade_virq
= msi_data
->cascade_array
[srs
]->virq
;
78 seq_printf(p
, " fsl-msi-%d", cascade_virq
);
82 static struct irq_chip fsl_msi_chip
= {
83 .irq_mask
= pci_msi_mask_irq
,
84 .irq_unmask
= pci_msi_unmask_irq
,
85 .irq_ack
= fsl_msi_end_irq
,
86 .irq_print_chip
= fsl_msi_print_chip
,
89 static int fsl_msi_host_map(struct irq_domain
*h
, unsigned int virq
,
92 struct fsl_msi
*msi_data
= h
->host_data
;
93 struct irq_chip
*chip
= &fsl_msi_chip
;
95 irq_set_status_flags(virq
, IRQ_TYPE_EDGE_FALLING
);
97 irq_set_chip_data(virq
, msi_data
);
98 irq_set_chip_and_handler(virq
, chip
, handle_edge_irq
);
103 static const struct irq_domain_ops fsl_msi_host_ops
= {
104 .map
= fsl_msi_host_map
,
107 static int fsl_msi_init_allocator(struct fsl_msi
*msi_data
)
111 rc
= msi_bitmap_alloc(&msi_data
->bitmap
, NR_MSI_IRQS_MAX
,
112 irq_domain_get_of_node(msi_data
->irqhost
));
117 * Reserve all the hwirqs
118 * The available hwirqs will be released in fsl_msi_setup_hwirq()
120 for (hwirq
= 0; hwirq
< NR_MSI_IRQS_MAX
; hwirq
++)
121 msi_bitmap_reserve_hwirq(&msi_data
->bitmap
, hwirq
);
126 static void fsl_teardown_msi_irqs(struct pci_dev
*pdev
)
128 struct msi_desc
*entry
;
129 struct fsl_msi
*msi_data
;
130 irq_hw_number_t hwirq
;
132 msi_for_each_desc(entry
, &pdev
->dev
, MSI_DESC_ASSOCIATED
) {
133 hwirq
= virq_to_hw(entry
->irq
);
134 msi_data
= irq_get_chip_data(entry
->irq
);
135 irq_set_msi_desc(entry
->irq
, NULL
);
136 irq_dispose_mapping(entry
->irq
);
138 msi_bitmap_free_hwirqs(&msi_data
->bitmap
, hwirq
, 1);
142 static void fsl_compose_msi_msg(struct pci_dev
*pdev
, int hwirq
,
144 struct fsl_msi
*fsl_msi_data
)
146 struct fsl_msi
*msi_data
= fsl_msi_data
;
147 struct pci_controller
*hose
= pci_bus_to_host(pdev
->bus
);
148 u64 address
; /* Physical address of the MSIIR */
152 /* If the msi-address-64 property exists, then use it */
153 reg
= of_get_property(hose
->dn
, "msi-address-64", &len
);
154 if (reg
&& (len
== sizeof(u64
)))
155 address
= be64_to_cpup(reg
);
157 address
= fsl_pci_immrbar_base(hose
) + msi_data
->msiir_offset
;
159 msg
->address_lo
= lower_32_bits(address
);
160 msg
->address_hi
= upper_32_bits(address
);
163 * MPIC version 2.0 has erratum PIC1. It causes
164 * that neither MSI nor MSI-X can work fine.
165 * This is a workaround to allow MSI-X to function
166 * properly. It only works for MSI-X, we prevent
167 * MSI on buggy chips in fsl_setup_msi_irqs().
169 if (msi_data
->feature
& MSI_HW_ERRATA_ENDIAN
)
170 msg
->data
= __swab32(hwirq
);
174 pr_debug("%s: allocated srs: %d, ibs: %d\n", __func__
,
175 (hwirq
>> msi_data
->srs_shift
) & MSI_SRS_MASK
,
176 (hwirq
>> msi_data
->ibs_shift
) & MSI_IBS_MASK
);
179 static int fsl_setup_msi_irqs(struct pci_dev
*pdev
, int nvec
, int type
)
181 struct pci_controller
*hose
= pci_bus_to_host(pdev
->bus
);
182 struct device_node
*np
;
184 int rc
, hwirq
= -ENOMEM
;
186 struct msi_desc
*entry
;
188 struct fsl_msi
*msi_data
;
190 if (type
== PCI_CAP_ID_MSI
) {
192 * MPIC version 2.0 has erratum PIC1. For now MSI
193 * could not work. So check to prevent MSI from
194 * being used on the board with this erratum.
196 list_for_each_entry(msi_data
, &msi_head
, list
)
197 if (msi_data
->feature
& MSI_HW_ERRATA_ENDIAN
)
202 * If the PCI node has an fsl,msi property, then we need to use it
203 * to find the specific MSI.
205 np
= of_parse_phandle(hose
->dn
, "fsl,msi", 0);
207 if (of_device_is_compatible(np
, "fsl,mpic-msi") ||
208 of_device_is_compatible(np
, "fsl,vmpic-msi") ||
209 of_device_is_compatible(np
, "fsl,vmpic-msi-v4.3"))
210 phandle
= np
->phandle
;
213 "node %pOF has an invalid fsl,msi phandle %u\n",
214 hose
->dn
, np
->phandle
);
221 msi_for_each_desc(entry
, &pdev
->dev
, MSI_DESC_NOTASSOCIATED
) {
223 * Loop over all the MSI devices until we find one that has an
224 * available interrupt.
226 list_for_each_entry(msi_data
, &msi_head
, list
) {
228 * If the PCI node has an fsl,msi property, then we
229 * restrict our search to the corresponding MSI node.
230 * The simplest way is to skip over MSI nodes with the
231 * wrong phandle. Under the Freescale hypervisor, this
232 * has the additional benefit of skipping over MSI
233 * nodes that are not mapped in the PAMU.
235 if (phandle
&& (phandle
!= msi_data
->phandle
))
238 hwirq
= msi_bitmap_alloc_hwirqs(&msi_data
->bitmap
, 1);
245 dev_err(&pdev
->dev
, "could not allocate MSI interrupt\n");
249 virq
= irq_create_mapping(msi_data
->irqhost
, hwirq
);
252 dev_err(&pdev
->dev
, "fail mapping hwirq %i\n", hwirq
);
253 msi_bitmap_free_hwirqs(&msi_data
->bitmap
, hwirq
, 1);
257 /* chip_data is msi_data via host->hostdata in host->map() */
258 irq_set_msi_desc(virq
, entry
);
260 fsl_compose_msi_msg(pdev
, hwirq
, &msg
, msi_data
);
261 pci_write_msi_msg(virq
, &msg
);
266 /* free by the caller of this function */
270 static irqreturn_t
fsl_msi_cascade(int irq
, void *data
)
272 struct fsl_msi
*msi_data
;
277 struct fsl_msi_cascade_data
*cascade_data
= data
;
278 irqreturn_t ret
= IRQ_NONE
;
280 msi_data
= cascade_data
->msi_data
;
282 msir_index
= cascade_data
->index
;
284 switch (msi_data
->feature
& FSL_PIC_IP_MASK
) {
285 case FSL_PIC_IP_MPIC
:
286 msir_value
= fsl_msi_read(msi_data
->msi_regs
,
289 case FSL_PIC_IP_IPIC
:
290 msir_value
= fsl_msi_read(msi_data
->msi_regs
, msir_index
* 0x4);
292 #ifdef CONFIG_EPAPR_PARAVIRT
293 case FSL_PIC_IP_VMPIC
: {
295 ret
= fh_vmpic_get_msir(virq_to_hw(irq
), &msir_value
);
297 pr_err("fsl-msi: fh_vmpic_get_msir() failed for "
298 "irq %u (ret=%u)\n", irq
, ret
);
308 intr_index
= ffs(msir_value
) - 1;
310 err
= generic_handle_domain_irq(msi_data
->irqhost
,
311 msi_hwirq(msi_data
, msir_index
,
312 intr_index
+ have_shift
));
316 have_shift
+= intr_index
+ 1;
317 msir_value
= msir_value
>> (intr_index
+ 1);
323 static void fsl_of_msi_remove(struct platform_device
*ofdev
)
325 struct fsl_msi
*msi
= platform_get_drvdata(ofdev
);
328 if (msi
->list
.prev
!= NULL
)
329 list_del(&msi
->list
);
330 for (i
= 0; i
< NR_MSI_REG_MAX
; i
++) {
331 if (msi
->cascade_array
[i
]) {
332 virq
= msi
->cascade_array
[i
]->virq
;
336 free_irq(virq
, msi
->cascade_array
[i
]);
337 kfree(msi
->cascade_array
[i
]);
338 irq_dispose_mapping(virq
);
341 if (msi
->bitmap
.bitmap
)
342 msi_bitmap_free(&msi
->bitmap
);
343 if ((msi
->feature
& FSL_PIC_IP_MASK
) != FSL_PIC_IP_VMPIC
)
344 iounmap(msi
->msi_regs
);
348 static struct lock_class_key fsl_msi_irq_class
;
349 static struct lock_class_key fsl_msi_irq_request_class
;
351 static int fsl_msi_setup_hwirq(struct fsl_msi
*msi
, struct platform_device
*dev
,
352 int offset
, int irq_index
)
354 struct fsl_msi_cascade_data
*cascade_data
= NULL
;
355 int virt_msir
, i
, ret
;
357 virt_msir
= irq_of_parse_and_map(dev
->dev
.of_node
, irq_index
);
359 dev_err(&dev
->dev
, "%s: Cannot translate IRQ index %d\n",
360 __func__
, irq_index
);
364 cascade_data
= kzalloc(sizeof(struct fsl_msi_cascade_data
), GFP_KERNEL
);
366 dev_err(&dev
->dev
, "No memory for MSI cascade data\n");
369 irq_set_lockdep_class(virt_msir
, &fsl_msi_irq_class
,
370 &fsl_msi_irq_request_class
);
371 cascade_data
->index
= offset
;
372 cascade_data
->msi_data
= msi
;
373 cascade_data
->virq
= virt_msir
;
374 msi
->cascade_array
[irq_index
] = cascade_data
;
376 ret
= request_irq(virt_msir
, fsl_msi_cascade
, IRQF_NO_THREAD
,
377 "fsl-msi-cascade", cascade_data
);
379 dev_err(&dev
->dev
, "failed to request_irq(%d), ret = %d\n",
384 /* Release the hwirqs corresponding to this MSI register */
385 for (i
= 0; i
< IRQS_PER_MSI_REG
; i
++)
386 msi_bitmap_free_hwirqs(&msi
->bitmap
,
387 msi_hwirq(msi
, offset
, i
), 1);
392 static const struct of_device_id fsl_of_msi_ids
[];
393 static int fsl_of_msi_probe(struct platform_device
*dev
)
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 features
= device_get_match_data(&dev
->dev
);
406 printk(KERN_DEBUG
"Setting up Freescale MSI support\n");
408 msi
= kzalloc(sizeof(struct fsl_msi
), GFP_KERNEL
);
410 dev_err(&dev
->dev
, "No memory for MSI structure\n");
413 platform_set_drvdata(dev
, msi
);
415 msi
->irqhost
= irq_domain_add_linear(dev
->dev
.of_node
,
416 NR_MSI_IRQS_MAX
, &fsl_msi_host_ops
, msi
);
418 if (msi
->irqhost
== NULL
) {
419 dev_err(&dev
->dev
, "No memory for MSI irqhost\n");
425 * Under the Freescale hypervisor, the msi nodes don't have a 'reg'
426 * property. Instead, we use hypercalls to access the MSI.
428 if ((features
->fsl_pic_ip
& FSL_PIC_IP_MASK
) != FSL_PIC_IP_VMPIC
) {
429 err
= of_address_to_resource(dev
->dev
.of_node
, 0, &res
);
431 dev_err(&dev
->dev
, "invalid resource for node %pOF\n",
436 msi
->msi_regs
= ioremap(res
.start
, resource_size(&res
));
437 if (!msi
->msi_regs
) {
439 dev_err(&dev
->dev
, "could not map node %pOF\n",
444 features
->msiir_offset
+ (res
.start
& 0xfffff);
447 * First read the MSIIR/MSIIR1 offset from dts
448 * On failure use the hardcode MSIIR offset
450 if (of_address_to_resource(dev
->dev
.of_node
, 1, &msiir
))
451 msi
->msiir_offset
= features
->msiir_offset
+
452 (res
.start
& MSIIR_OFFSET_MASK
);
454 msi
->msiir_offset
= msiir
.start
& MSIIR_OFFSET_MASK
;
457 msi
->feature
= features
->fsl_pic_ip
;
459 /* For erratum PIC1 on MPIC version 2.0*/
460 if ((features
->fsl_pic_ip
& FSL_PIC_IP_MASK
) == FSL_PIC_IP_MPIC
461 && (fsl_mpic_primary_get_version() == 0x0200))
462 msi
->feature
|= MSI_HW_ERRATA_ENDIAN
;
465 * Remember the phandle, so that we can match with any PCI nodes
466 * that have an "fsl,msi" property.
468 msi
->phandle
= dev
->dev
.of_node
->phandle
;
470 err
= fsl_msi_init_allocator(msi
);
472 dev_err(&dev
->dev
, "Error allocating MSI bitmap\n");
476 p
= of_get_property(dev
->dev
.of_node
, "msi-available-ranges", &len
);
478 if (of_device_is_compatible(dev
->dev
.of_node
, "fsl,mpic-msi-v4.3") ||
479 of_device_is_compatible(dev
->dev
.of_node
, "fsl,vmpic-msi-v4.3")) {
480 msi
->srs_shift
= MSIIR1_SRS_SHIFT
;
481 msi
->ibs_shift
= MSIIR1_IBS_SHIFT
;
483 dev_warn(&dev
->dev
, "%s: dose not support msi-available-ranges property\n",
486 for (irq_index
= 0; irq_index
< NR_MSI_REG_MSIIR1
;
488 err
= fsl_msi_setup_hwirq(msi
, dev
,
489 irq_index
, irq_index
);
494 static const u32 all_avail
[] =
495 { 0, NR_MSI_REG_MSIIR
* IRQS_PER_MSI_REG
};
497 msi
->srs_shift
= MSIIR_SRS_SHIFT
;
498 msi
->ibs_shift
= MSIIR_IBS_SHIFT
;
500 if (p
&& len
% (2 * sizeof(u32
)) != 0) {
501 dev_err(&dev
->dev
, "%s: Malformed msi-available-ranges property\n",
509 len
= sizeof(all_avail
);
512 for (irq_index
= 0, i
= 0; i
< len
/ (2 * sizeof(u32
)); i
++) {
513 if (p
[i
* 2] % IRQS_PER_MSI_REG
||
514 p
[i
* 2 + 1] % IRQS_PER_MSI_REG
) {
515 pr_warn("%s: %pOF: msi available range of %u at %u is not IRQ-aligned\n",
516 __func__
, dev
->dev
.of_node
,
517 p
[i
* 2 + 1], p
[i
* 2]);
522 offset
= p
[i
* 2] / IRQS_PER_MSI_REG
;
523 count
= p
[i
* 2 + 1] / IRQS_PER_MSI_REG
;
525 for (j
= 0; j
< count
; j
++, irq_index
++) {
526 err
= fsl_msi_setup_hwirq(msi
, dev
, offset
+ j
,
534 list_add_tail(&msi
->list
, &msi_head
);
537 * Apply the MSI ops to all the controllers.
538 * It doesn't hurt to reassign the same ops,
539 * but bail out if we find another MSI driver.
541 list_for_each_entry(phb
, &hose_list
, list_node
) {
542 if (!phb
->controller_ops
.setup_msi_irqs
) {
543 phb
->controller_ops
.setup_msi_irqs
= fsl_setup_msi_irqs
;
544 phb
->controller_ops
.teardown_msi_irqs
= fsl_teardown_msi_irqs
;
545 } else if (phb
->controller_ops
.setup_msi_irqs
!= fsl_setup_msi_irqs
) {
546 dev_err(&dev
->dev
, "Different MSI driver already installed!\n");
553 fsl_of_msi_remove(dev
);
557 static const struct fsl_msi_feature mpic_msi_feature
= {
558 .fsl_pic_ip
= FSL_PIC_IP_MPIC
,
559 .msiir_offset
= 0x140,
562 static const struct fsl_msi_feature ipic_msi_feature
= {
563 .fsl_pic_ip
= FSL_PIC_IP_IPIC
,
564 .msiir_offset
= 0x38,
567 #ifdef CONFIG_EPAPR_PARAVIRT
568 static const struct fsl_msi_feature vmpic_msi_feature
= {
569 .fsl_pic_ip
= FSL_PIC_IP_VMPIC
,
574 static const struct of_device_id fsl_of_msi_ids
[] = {
576 .compatible
= "fsl,mpic-msi",
577 .data
= &mpic_msi_feature
,
580 .compatible
= "fsl,mpic-msi-v4.3",
581 .data
= &mpic_msi_feature
,
584 .compatible
= "fsl,ipic-msi",
585 .data
= &ipic_msi_feature
,
587 #ifdef CONFIG_EPAPR_PARAVIRT
589 .compatible
= "fsl,vmpic-msi",
590 .data
= &vmpic_msi_feature
,
593 .compatible
= "fsl,vmpic-msi-v4.3",
594 .data
= &vmpic_msi_feature
,
600 static struct platform_driver fsl_of_msi_driver
= {
603 .of_match_table
= fsl_of_msi_ids
,
605 .probe
= fsl_of_msi_probe
,
606 .remove
= fsl_of_msi_remove
,
609 static __init
int fsl_of_msi_init(void)
611 return platform_driver_register(&fsl_of_msi_driver
);
614 subsys_initcall(fsl_of_msi_init
);