2 * Annapurna Labs MSIX support services
4 * Copyright (C) 2016, Amazon.com, Inc. or its affiliates. All Rights Reserved.
6 * Antoine Tenart <antoine.tenart@free-electrons.com>
8 * This file is licensed under the terms of the GNU General Public
9 * License version 2. This program is licensed "as is" without any
10 * warranty of any kind, whether express or implied.
13 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
15 #include <linux/irqchip.h>
16 #include <linux/irqchip/arm-gic.h>
17 #include <linux/msi.h>
19 #include <linux/of_address.h>
20 #include <linux/of_irq.h>
21 #include <linux/of_pci.h>
22 #include <linux/pci.h>
23 #include <linux/slab.h>
28 /* MSIX message address format: local GIC target */
29 #define ALPINE_MSIX_SPI_TARGET_CLUSTER0 BIT(16)
31 struct alpine_msix_data {
32 spinlock_t msi_map_lock;
34 u32 spi_first; /* The SGI number that MSIs start */
35 u32 num_spis; /* The number of SGIs for MSIs */
36 unsigned long *msi_map;
39 static void alpine_msix_mask_msi_irq(struct irq_data *d)
42 irq_chip_mask_parent(d);
45 static void alpine_msix_unmask_msi_irq(struct irq_data *d)
47 pci_msi_unmask_irq(d);
48 irq_chip_unmask_parent(d);
51 static struct irq_chip alpine_msix_irq_chip = {
53 .irq_mask = alpine_msix_mask_msi_irq,
54 .irq_unmask = alpine_msix_unmask_msi_irq,
55 .irq_eoi = irq_chip_eoi_parent,
56 .irq_set_affinity = irq_chip_set_affinity_parent,
59 static int alpine_msix_allocate_sgi(struct alpine_msix_data *priv, int num_req)
63 spin_lock(&priv->msi_map_lock);
65 first = bitmap_find_next_zero_area(priv->msi_map, priv->num_spis, 0,
67 if (first >= priv->num_spis) {
68 spin_unlock(&priv->msi_map_lock);
72 bitmap_set(priv->msi_map, first, num_req);
74 spin_unlock(&priv->msi_map_lock);
76 return priv->spi_first + first;
79 static void alpine_msix_free_sgi(struct alpine_msix_data *priv, unsigned sgi,
82 int first = sgi - priv->spi_first;
84 spin_lock(&priv->msi_map_lock);
86 bitmap_clear(priv->msi_map, first, num_req);
88 spin_unlock(&priv->msi_map_lock);
91 static void alpine_msix_compose_msi_msg(struct irq_data *data,
94 struct alpine_msix_data *priv = irq_data_get_irq_chip_data(data);
95 phys_addr_t msg_addr = priv->addr;
97 msg_addr |= (data->hwirq << 3);
99 msg->address_hi = upper_32_bits(msg_addr);
100 msg->address_lo = lower_32_bits(msg_addr);
104 static struct msi_domain_info alpine_msix_domain_info = {
105 .flags = MSI_FLAG_USE_DEF_DOM_OPS | MSI_FLAG_USE_DEF_CHIP_OPS |
107 .chip = &alpine_msix_irq_chip,
110 static struct irq_chip middle_irq_chip = {
111 .name = "alpine_msix_middle",
112 .irq_mask = irq_chip_mask_parent,
113 .irq_unmask = irq_chip_unmask_parent,
114 .irq_eoi = irq_chip_eoi_parent,
115 .irq_set_affinity = irq_chip_set_affinity_parent,
116 .irq_compose_msi_msg = alpine_msix_compose_msi_msg,
119 static int alpine_msix_gic_domain_alloc(struct irq_domain *domain,
120 unsigned int virq, int sgi)
122 struct irq_fwspec fwspec;
126 if (!is_of_node(domain->parent->fwnode))
129 fwspec.fwnode = domain->parent->fwnode;
130 fwspec.param_count = 3;
132 fwspec.param[1] = sgi;
133 fwspec.param[2] = IRQ_TYPE_EDGE_RISING;
135 ret = irq_domain_alloc_irqs_parent(domain, virq, 1, &fwspec);
139 d = irq_domain_get_irq_data(domain->parent, virq);
140 d->chip->irq_set_type(d, IRQ_TYPE_EDGE_RISING);
145 static int alpine_msix_middle_domain_alloc(struct irq_domain *domain,
147 unsigned int nr_irqs, void *args)
149 struct alpine_msix_data *priv = domain->host_data;
152 sgi = alpine_msix_allocate_sgi(priv, nr_irqs);
156 for (i = 0; i < nr_irqs; i++) {
157 err = alpine_msix_gic_domain_alloc(domain, virq + i, sgi + i);
161 irq_domain_set_hwirq_and_chip(domain, virq + i, sgi + i,
162 &middle_irq_chip, priv);
168 irq_domain_free_irqs_parent(domain, virq, i - 1);
169 alpine_msix_free_sgi(priv, sgi, nr_irqs);
173 static void alpine_msix_middle_domain_free(struct irq_domain *domain,
175 unsigned int nr_irqs)
177 struct irq_data *d = irq_domain_get_irq_data(domain, virq);
178 struct alpine_msix_data *priv = irq_data_get_irq_chip_data(d);
180 irq_domain_free_irqs_parent(domain, virq, nr_irqs);
181 alpine_msix_free_sgi(priv, d->hwirq, nr_irqs);
184 static const struct irq_domain_ops alpine_msix_middle_domain_ops = {
185 .alloc = alpine_msix_middle_domain_alloc,
186 .free = alpine_msix_middle_domain_free,
189 static int alpine_msix_init_domains(struct alpine_msix_data *priv,
190 struct device_node *node)
192 struct irq_domain *middle_domain, *msi_domain, *gic_domain;
193 struct device_node *gic_node;
195 gic_node = of_irq_find_parent(node);
197 pr_err("Failed to find the GIC node\n");
201 gic_domain = irq_find_host(gic_node);
202 of_node_put(gic_node);
204 pr_err("Failed to find the GIC domain\n");
208 middle_domain = irq_domain_add_hierarchy(gic_domain, 0, 0, NULL,
209 &alpine_msix_middle_domain_ops,
211 if (!middle_domain) {
212 pr_err("Failed to create the MSIX middle domain\n");
216 msi_domain = pci_msi_create_irq_domain(of_node_to_fwnode(node),
217 &alpine_msix_domain_info,
220 pr_err("Failed to create MSI domain\n");
221 irq_domain_remove(middle_domain);
228 static int alpine_msix_init(struct device_node *node,
229 struct device_node *parent)
231 struct alpine_msix_data *priv;
235 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
239 spin_lock_init(&priv->msi_map_lock);
241 ret = of_address_to_resource(node, 0, &res);
243 pr_err("Failed to allocate resource\n");
248 * The 20 least significant bits of addr provide direct information
249 * regarding the interrupt destination.
251 * To select the primary GIC as the target GIC, bits [18:17] must be set
252 * to 0x0. In this case, bit 16 (SPI_TARGET_CLUSTER0) must be set.
254 priv->addr = res.start & GENMASK_ULL(63,20);
255 priv->addr |= ALPINE_MSIX_SPI_TARGET_CLUSTER0;
257 if (of_property_read_u32(node, "al,msi-base-spi", &priv->spi_first)) {
258 pr_err("Unable to parse MSI base\n");
263 if (of_property_read_u32(node, "al,msi-num-spis", &priv->num_spis)) {
264 pr_err("Unable to parse MSI numbers\n");
269 priv->msi_map = bitmap_zalloc(priv->num_spis, GFP_KERNEL);
270 if (!priv->msi_map) {
275 pr_debug("Registering %d msixs, starting at %d\n",
276 priv->num_spis, priv->spi_first);
278 ret = alpine_msix_init_domains(priv, node);
285 bitmap_free(priv->msi_map);
290 IRQCHIP_DECLARE(alpine_msix, "al,alpine-msix", alpine_msix_init);