16e0832faSShawn Lin // SPDX-License-Identifier: GPL-2.0
26e0832faSShawn Lin /*
36e0832faSShawn Lin * Altera PCIe MSI support
46e0832faSShawn Lin *
56e0832faSShawn Lin * Author: Ley Foon Tan <lftan@altera.com>
66e0832faSShawn Lin *
76e0832faSShawn Lin * Copyright Altera Corporation (C) 2013-2015. All rights reserved
86e0832faSShawn Lin */
96e0832faSShawn Lin
106e0832faSShawn Lin #include <linux/interrupt.h>
116e0832faSShawn Lin #include <linux/irqchip/chained_irq.h>
128c50cd05SBjorn Helgaas #include <linux/irqdomain.h>
136e0832faSShawn Lin #include <linux/init.h>
14c7ddfd35SLey Foon Tan #include <linux/module.h>
156e0832faSShawn Lin #include <linux/msi.h>
166e0832faSShawn Lin #include <linux/of_address.h>
176e0832faSShawn Lin #include <linux/of_pci.h>
186e0832faSShawn Lin #include <linux/pci.h>
196e0832faSShawn Lin #include <linux/platform_device.h>
206e0832faSShawn Lin #include <linux/slab.h>
216e0832faSShawn Lin
226e0832faSShawn Lin #define MSI_STATUS 0x0
236e0832faSShawn Lin #define MSI_ERROR 0x4
246e0832faSShawn Lin #define MSI_INTMASK 0x8
256e0832faSShawn Lin
266e0832faSShawn Lin #define MAX_MSI_VECTORS 32
276e0832faSShawn Lin
286e0832faSShawn Lin struct altera_msi {
296e0832faSShawn Lin DECLARE_BITMAP(used, MAX_MSI_VECTORS);
306e0832faSShawn Lin struct mutex lock; /* protect "used" bitmap */
316e0832faSShawn Lin struct platform_device *pdev;
326e0832faSShawn Lin struct irq_domain *msi_domain;
336e0832faSShawn Lin struct irq_domain *inner_domain;
346e0832faSShawn Lin void __iomem *csr_base;
356e0832faSShawn Lin void __iomem *vector_base;
366e0832faSShawn Lin phys_addr_t vector_phy;
376e0832faSShawn Lin u32 num_of_vectors;
386e0832faSShawn Lin int irq;
396e0832faSShawn Lin };
406e0832faSShawn Lin
msi_writel(struct altera_msi * msi,const u32 value,const u32 reg)416e0832faSShawn Lin static inline void msi_writel(struct altera_msi *msi, const u32 value,
426e0832faSShawn Lin const u32 reg)
436e0832faSShawn Lin {
446e0832faSShawn Lin writel_relaxed(value, msi->csr_base + reg);
456e0832faSShawn Lin }
466e0832faSShawn Lin
msi_readl(struct altera_msi * msi,const u32 reg)476e0832faSShawn Lin static inline u32 msi_readl(struct altera_msi *msi, const u32 reg)
486e0832faSShawn Lin {
496e0832faSShawn Lin return readl_relaxed(msi->csr_base + reg);
506e0832faSShawn Lin }
516e0832faSShawn Lin
altera_msi_isr(struct irq_desc * desc)526e0832faSShawn Lin static void altera_msi_isr(struct irq_desc *desc)
536e0832faSShawn Lin {
546e0832faSShawn Lin struct irq_chip *chip = irq_desc_get_chip(desc);
556e0832faSShawn Lin struct altera_msi *msi;
566e0832faSShawn Lin unsigned long status;
576e0832faSShawn Lin u32 bit;
58d21faba1SMarc Zyngier int ret;
596e0832faSShawn Lin
606e0832faSShawn Lin chained_irq_enter(chip, desc);
616e0832faSShawn Lin msi = irq_desc_get_handler_data(desc);
626e0832faSShawn Lin
636e0832faSShawn Lin while ((status = msi_readl(msi, MSI_STATUS)) != 0) {
646e0832faSShawn Lin for_each_set_bit(bit, &status, msi->num_of_vectors) {
656e0832faSShawn Lin /* Dummy read from vector to clear the interrupt */
666e0832faSShawn Lin readl_relaxed(msi->vector_base + (bit * sizeof(u32)));
676e0832faSShawn Lin
68d21faba1SMarc Zyngier ret = generic_handle_domain_irq(msi->inner_domain, bit);
69d21faba1SMarc Zyngier if (ret)
70d21faba1SMarc Zyngier dev_err_ratelimited(&msi->pdev->dev, "unexpected MSI\n");
716e0832faSShawn Lin }
726e0832faSShawn Lin }
736e0832faSShawn Lin
746e0832faSShawn Lin chained_irq_exit(chip, desc);
756e0832faSShawn Lin }
766e0832faSShawn Lin
776e0832faSShawn Lin static struct irq_chip altera_msi_irq_chip = {
786e0832faSShawn Lin .name = "Altera PCIe MSI",
796e0832faSShawn Lin .irq_mask = pci_msi_mask_irq,
806e0832faSShawn Lin .irq_unmask = pci_msi_unmask_irq,
816e0832faSShawn Lin };
826e0832faSShawn Lin
836e0832faSShawn Lin static struct msi_domain_info altera_msi_domain_info = {
846e0832faSShawn Lin .flags = (MSI_FLAG_USE_DEF_DOM_OPS | MSI_FLAG_USE_DEF_CHIP_OPS |
856e0832faSShawn Lin MSI_FLAG_PCI_MSIX),
866e0832faSShawn Lin .chip = &altera_msi_irq_chip,
876e0832faSShawn Lin };
886e0832faSShawn Lin
altera_compose_msi_msg(struct irq_data * data,struct msi_msg * msg)896e0832faSShawn Lin static void altera_compose_msi_msg(struct irq_data *data, struct msi_msg *msg)
906e0832faSShawn Lin {
916e0832faSShawn Lin struct altera_msi *msi = irq_data_get_irq_chip_data(data);
926e0832faSShawn Lin phys_addr_t addr = msi->vector_phy + (data->hwirq * sizeof(u32));
936e0832faSShawn Lin
946e0832faSShawn Lin msg->address_lo = lower_32_bits(addr);
956e0832faSShawn Lin msg->address_hi = upper_32_bits(addr);
966e0832faSShawn Lin msg->data = data->hwirq;
976e0832faSShawn Lin
986e0832faSShawn Lin dev_dbg(&msi->pdev->dev, "msi#%d address_hi %#x address_lo %#x\n",
996e0832faSShawn Lin (int)data->hwirq, msg->address_hi, msg->address_lo);
1006e0832faSShawn Lin }
1016e0832faSShawn Lin
altera_msi_set_affinity(struct irq_data * irq_data,const struct cpumask * mask,bool force)1026e0832faSShawn Lin static int altera_msi_set_affinity(struct irq_data *irq_data,
1036e0832faSShawn Lin const struct cpumask *mask, bool force)
1046e0832faSShawn Lin {
1056e0832faSShawn Lin return -EINVAL;
1066e0832faSShawn Lin }
1076e0832faSShawn Lin
1086e0832faSShawn Lin static struct irq_chip altera_msi_bottom_irq_chip = {
1096e0832faSShawn Lin .name = "Altera MSI",
1106e0832faSShawn Lin .irq_compose_msi_msg = altera_compose_msi_msg,
1116e0832faSShawn Lin .irq_set_affinity = altera_msi_set_affinity,
1126e0832faSShawn Lin };
1136e0832faSShawn Lin
altera_irq_domain_alloc(struct irq_domain * domain,unsigned int virq,unsigned int nr_irqs,void * args)1146e0832faSShawn Lin static int altera_irq_domain_alloc(struct irq_domain *domain, unsigned int virq,
1156e0832faSShawn Lin unsigned int nr_irqs, void *args)
1166e0832faSShawn Lin {
1176e0832faSShawn Lin struct altera_msi *msi = domain->host_data;
1186e0832faSShawn Lin unsigned long bit;
1196e0832faSShawn Lin u32 mask;
1206e0832faSShawn Lin
1216e0832faSShawn Lin WARN_ON(nr_irqs != 1);
1226e0832faSShawn Lin mutex_lock(&msi->lock);
1236e0832faSShawn Lin
1246e0832faSShawn Lin bit = find_first_zero_bit(msi->used, msi->num_of_vectors);
1256e0832faSShawn Lin if (bit >= msi->num_of_vectors) {
1266e0832faSShawn Lin mutex_unlock(&msi->lock);
1276e0832faSShawn Lin return -ENOSPC;
1286e0832faSShawn Lin }
1296e0832faSShawn Lin
1306e0832faSShawn Lin set_bit(bit, msi->used);
1316e0832faSShawn Lin
1326e0832faSShawn Lin mutex_unlock(&msi->lock);
1336e0832faSShawn Lin
1346e0832faSShawn Lin irq_domain_set_info(domain, virq, bit, &altera_msi_bottom_irq_chip,
1356e0832faSShawn Lin domain->host_data, handle_simple_irq,
1366e0832faSShawn Lin NULL, NULL);
1376e0832faSShawn Lin
1386e0832faSShawn Lin mask = msi_readl(msi, MSI_INTMASK);
1396e0832faSShawn Lin mask |= 1 << bit;
1406e0832faSShawn Lin msi_writel(msi, mask, MSI_INTMASK);
1416e0832faSShawn Lin
1426e0832faSShawn Lin return 0;
1436e0832faSShawn Lin }
1446e0832faSShawn Lin
altera_irq_domain_free(struct irq_domain * domain,unsigned int virq,unsigned int nr_irqs)1456e0832faSShawn Lin static void altera_irq_domain_free(struct irq_domain *domain,
1466e0832faSShawn Lin unsigned int virq, unsigned int nr_irqs)
1476e0832faSShawn Lin {
1486e0832faSShawn Lin struct irq_data *d = irq_domain_get_irq_data(domain, virq);
1496e0832faSShawn Lin struct altera_msi *msi = irq_data_get_irq_chip_data(d);
1506e0832faSShawn Lin u32 mask;
1516e0832faSShawn Lin
1526e0832faSShawn Lin mutex_lock(&msi->lock);
1536e0832faSShawn Lin
1546e0832faSShawn Lin if (!test_bit(d->hwirq, msi->used)) {
1556e0832faSShawn Lin dev_err(&msi->pdev->dev, "trying to free unused MSI#%lu\n",
1566e0832faSShawn Lin d->hwirq);
1576e0832faSShawn Lin } else {
1586e0832faSShawn Lin __clear_bit(d->hwirq, msi->used);
1596e0832faSShawn Lin mask = msi_readl(msi, MSI_INTMASK);
1606e0832faSShawn Lin mask &= ~(1 << d->hwirq);
1616e0832faSShawn Lin msi_writel(msi, mask, MSI_INTMASK);
1626e0832faSShawn Lin }
1636e0832faSShawn Lin
1646e0832faSShawn Lin mutex_unlock(&msi->lock);
1656e0832faSShawn Lin }
1666e0832faSShawn Lin
1676e0832faSShawn Lin static const struct irq_domain_ops msi_domain_ops = {
1686e0832faSShawn Lin .alloc = altera_irq_domain_alloc,
1696e0832faSShawn Lin .free = altera_irq_domain_free,
1706e0832faSShawn Lin };
1716e0832faSShawn Lin
altera_allocate_domains(struct altera_msi * msi)1726e0832faSShawn Lin static int altera_allocate_domains(struct altera_msi *msi)
1736e0832faSShawn Lin {
1746e0832faSShawn Lin struct fwnode_handle *fwnode = of_node_to_fwnode(msi->pdev->dev.of_node);
1756e0832faSShawn Lin
1766e0832faSShawn Lin msi->inner_domain = irq_domain_add_linear(NULL, msi->num_of_vectors,
1776e0832faSShawn Lin &msi_domain_ops, msi);
1786e0832faSShawn Lin if (!msi->inner_domain) {
1796e0832faSShawn Lin dev_err(&msi->pdev->dev, "failed to create IRQ domain\n");
1806e0832faSShawn Lin return -ENOMEM;
1816e0832faSShawn Lin }
1826e0832faSShawn Lin
1836e0832faSShawn Lin msi->msi_domain = pci_msi_create_irq_domain(fwnode,
1846e0832faSShawn Lin &altera_msi_domain_info, msi->inner_domain);
1856e0832faSShawn Lin if (!msi->msi_domain) {
1866e0832faSShawn Lin dev_err(&msi->pdev->dev, "failed to create MSI domain\n");
1876e0832faSShawn Lin irq_domain_remove(msi->inner_domain);
1886e0832faSShawn Lin return -ENOMEM;
1896e0832faSShawn Lin }
1906e0832faSShawn Lin
1916e0832faSShawn Lin return 0;
1926e0832faSShawn Lin }
1936e0832faSShawn Lin
altera_free_domains(struct altera_msi * msi)1946e0832faSShawn Lin static void altera_free_domains(struct altera_msi *msi)
1956e0832faSShawn Lin {
1966e0832faSShawn Lin irq_domain_remove(msi->msi_domain);
1976e0832faSShawn Lin irq_domain_remove(msi->inner_domain);
1986e0832faSShawn Lin }
1996e0832faSShawn Lin
altera_msi_remove(struct platform_device * pdev)200*60d03f70SUwe Kleine-König static void altera_msi_remove(struct platform_device *pdev)
2016e0832faSShawn Lin {
2026e0832faSShawn Lin struct altera_msi *msi = platform_get_drvdata(pdev);
2036e0832faSShawn Lin
2046e0832faSShawn Lin msi_writel(msi, 0, MSI_INTMASK);
2053f0ea236SMartin Kaiser irq_set_chained_handler_and_data(msi->irq, NULL, NULL);
2066e0832faSShawn Lin
2076e0832faSShawn Lin altera_free_domains(msi);
2086e0832faSShawn Lin
2096e0832faSShawn Lin platform_set_drvdata(pdev, NULL);
2106e0832faSShawn Lin }
2116e0832faSShawn Lin
altera_msi_probe(struct platform_device * pdev)2126e0832faSShawn Lin static int altera_msi_probe(struct platform_device *pdev)
2136e0832faSShawn Lin {
2146e0832faSShawn Lin struct altera_msi *msi;
2156e0832faSShawn Lin struct device_node *np = pdev->dev.of_node;
2166e0832faSShawn Lin struct resource *res;
2176e0832faSShawn Lin int ret;
2186e0832faSShawn Lin
2196e0832faSShawn Lin msi = devm_kzalloc(&pdev->dev, sizeof(struct altera_msi),
2206e0832faSShawn Lin GFP_KERNEL);
2216e0832faSShawn Lin if (!msi)
2226e0832faSShawn Lin return -ENOMEM;
2236e0832faSShawn Lin
2246e0832faSShawn Lin mutex_init(&msi->lock);
2256e0832faSShawn Lin msi->pdev = pdev;
2266e0832faSShawn Lin
227e2dcd20bSDejin Zheng msi->csr_base = devm_platform_ioremap_resource_byname(pdev, "csr");
2286e0832faSShawn Lin if (IS_ERR(msi->csr_base)) {
2296e0832faSShawn Lin dev_err(&pdev->dev, "failed to map csr memory\n");
2306e0832faSShawn Lin return PTR_ERR(msi->csr_base);
2316e0832faSShawn Lin }
2326e0832faSShawn Lin
2336e0832faSShawn Lin res = platform_get_resource_byname(pdev, IORESOURCE_MEM,
2346e0832faSShawn Lin "vector_slave");
2356e0832faSShawn Lin msi->vector_base = devm_ioremap_resource(&pdev->dev, res);
236b1160a06SChen Hui if (IS_ERR(msi->vector_base))
2376e0832faSShawn Lin return PTR_ERR(msi->vector_base);
2386e0832faSShawn Lin
2396e0832faSShawn Lin msi->vector_phy = res->start;
2406e0832faSShawn Lin
2416e0832faSShawn Lin if (of_property_read_u32(np, "num-vectors", &msi->num_of_vectors)) {
2426e0832faSShawn Lin dev_err(&pdev->dev, "failed to parse the number of vectors\n");
2436e0832faSShawn Lin return -EINVAL;
2446e0832faSShawn Lin }
2456e0832faSShawn Lin
2466e0832faSShawn Lin ret = altera_allocate_domains(msi);
2476e0832faSShawn Lin if (ret)
2486e0832faSShawn Lin return ret;
2496e0832faSShawn Lin
2506e0832faSShawn Lin msi->irq = platform_get_irq(pdev, 0);
2516e0832faSShawn Lin if (msi->irq < 0) {
2526e0832faSShawn Lin ret = msi->irq;
2536e0832faSShawn Lin goto err;
2546e0832faSShawn Lin }
2556e0832faSShawn Lin
2566e0832faSShawn Lin irq_set_chained_handler_and_data(msi->irq, altera_msi_isr, msi);
2576e0832faSShawn Lin platform_set_drvdata(pdev, msi);
2586e0832faSShawn Lin
2596e0832faSShawn Lin return 0;
2606e0832faSShawn Lin
2616e0832faSShawn Lin err:
2626e0832faSShawn Lin altera_msi_remove(pdev);
2636e0832faSShawn Lin return ret;
2646e0832faSShawn Lin }
2656e0832faSShawn Lin
2666e0832faSShawn Lin static const struct of_device_id altera_msi_of_match[] = {
2676e0832faSShawn Lin { .compatible = "altr,msi-1.0", NULL },
2686e0832faSShawn Lin { },
2696e0832faSShawn Lin };
2706e0832faSShawn Lin
2716e0832faSShawn Lin static struct platform_driver altera_msi_driver = {
2726e0832faSShawn Lin .driver = {
2736e0832faSShawn Lin .name = "altera-msi",
2746e0832faSShawn Lin .of_match_table = altera_msi_of_match,
2756e0832faSShawn Lin },
2766e0832faSShawn Lin .probe = altera_msi_probe,
277*60d03f70SUwe Kleine-König .remove_new = altera_msi_remove,
2786e0832faSShawn Lin };
2796e0832faSShawn Lin
altera_msi_init(void)2806e0832faSShawn Lin static int __init altera_msi_init(void)
2816e0832faSShawn Lin {
2826e0832faSShawn Lin return platform_driver_register(&altera_msi_driver);
2836e0832faSShawn Lin }
284c7ddfd35SLey Foon Tan
altera_msi_exit(void)285c7ddfd35SLey Foon Tan static void __exit altera_msi_exit(void)
286c7ddfd35SLey Foon Tan {
287c7ddfd35SLey Foon Tan platform_driver_unregister(&altera_msi_driver);
288c7ddfd35SLey Foon Tan }
289c7ddfd35SLey Foon Tan
2906e0832faSShawn Lin subsys_initcall(altera_msi_init);
291c7ddfd35SLey Foon Tan MODULE_DEVICE_TABLE(of, altera_msi_of_match);
292c7ddfd35SLey Foon Tan module_exit(altera_msi_exit);
293c7ddfd35SLey Foon Tan MODULE_LICENSE("GPL v2");
294