2 * Copyright 2007, Michael Ellerman, IBM Corporation.
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; either version
7 * 2 of the License, or (at your option) any later version.
11 #include <linux/interrupt.h>
12 #include <linux/irq.h>
13 #include <linux/kernel.h>
14 #include <linux/pci.h>
15 #include <linux/msi.h>
16 #include <linux/of_platform.h>
17 #include <linux/debugfs.h>
20 #include <asm/machdep.h>
25 * MSIC registers, specified as offsets from dcr_base
27 #define MSIC_CTRL_REG 0x0
29 /* Base Address registers specify FIFO location in BE memory */
30 #define MSIC_BASE_ADDR_HI_REG 0x3
31 #define MSIC_BASE_ADDR_LO_REG 0x4
33 /* Hold the read/write offsets into the FIFO */
34 #define MSIC_READ_OFFSET_REG 0x5
35 #define MSIC_WRITE_OFFSET_REG 0x6
38 /* MSIC control register flags */
39 #define MSIC_CTRL_ENABLE 0x0001
40 #define MSIC_CTRL_FIFO_FULL_ENABLE 0x0002
41 #define MSIC_CTRL_IRQ_ENABLE 0x0008
42 #define MSIC_CTRL_FULL_STOP_ENABLE 0x0010
45 * The MSIC can be configured to use a FIFO of 32KB, 64KB, 128KB or 256KB.
46 * Currently we're using a 64KB FIFO size.
48 #define MSIC_FIFO_SIZE_SHIFT 16
49 #define MSIC_FIFO_SIZE_BYTES (1 << MSIC_FIFO_SIZE_SHIFT)
52 * To configure the FIFO size as (1 << n) bytes, we write (n - 15) into bits
53 * 8-9 of the MSIC control reg.
55 #define MSIC_CTRL_FIFO_SIZE (((MSIC_FIFO_SIZE_SHIFT - 15) << 8) & 0x300)
58 * We need to mask the read/write offsets to make sure they stay within
59 * the bounds of the FIFO. Also they should always be 16-byte aligned.
61 #define MSIC_FIFO_SIZE_MASK ((MSIC_FIFO_SIZE_BYTES - 1) & ~0xFu)
63 /* Each entry in the FIFO is 16 bytes, the first 4 bytes hold the irq # */
64 #define MSIC_FIFO_ENTRY_SIZE 0x10
68 struct irq_host *irq_host;
79 void axon_msi_debug_setup(struct device_node *dn, struct axon_msic *msic);
81 static inline void axon_msi_debug_setup(struct device_node *dn,
82 struct axon_msic *msic) { }
86 static void msic_dcr_write(struct axon_msic *msic, unsigned int dcr_n, u32 val)
88 pr_debug("axon_msi: dcr_write(0x%x, 0x%x)\n", val, dcr_n);
90 dcr_write(msic->dcr_host, dcr_n, val);
93 static void axon_msi_cascade(unsigned int irq, struct irq_desc *desc)
95 struct axon_msic *msic = get_irq_data(irq);
96 u32 write_offset, msi;
100 write_offset = dcr_read(msic->dcr_host, MSIC_WRITE_OFFSET_REG);
101 pr_debug("axon_msi: original write_offset 0x%x\n", write_offset);
103 /* write_offset doesn't wrap properly, so we have to mask it */
104 write_offset &= MSIC_FIFO_SIZE_MASK;
106 while (msic->read_offset != write_offset && retry < 100) {
107 idx = msic->read_offset / sizeof(__le32);
108 msi = le32_to_cpu(msic->fifo_virt[idx]);
111 pr_debug("axon_msi: woff %x roff %x msi %x\n",
112 write_offset, msic->read_offset, msi);
114 if (msi < NR_IRQS && irq_map[msi].host == msic->irq_host) {
115 generic_handle_irq(msi);
116 msic->fifo_virt[idx] = cpu_to_le32(0xffffffff);
119 * Reading the MSIC_WRITE_OFFSET_REG does not
120 * reliably flush the outstanding DMA to the
121 * FIFO buffer. Here we were reading stale
122 * data, so we need to retry.
126 pr_debug("axon_msi: invalid irq 0x%x!\n", msi);
131 pr_debug("axon_msi: late irq 0x%x, retry %d\n",
136 msic->read_offset += MSIC_FIFO_ENTRY_SIZE;
137 msic->read_offset &= MSIC_FIFO_SIZE_MASK;
141 printk(KERN_WARNING "axon_msi: irq timed out\n");
143 msic->read_offset += MSIC_FIFO_ENTRY_SIZE;
144 msic->read_offset &= MSIC_FIFO_SIZE_MASK;
147 desc->chip->eoi(irq);
150 static struct axon_msic *find_msi_translator(struct pci_dev *dev)
152 struct irq_host *irq_host;
153 struct device_node *dn, *tmp;
155 struct axon_msic *msic = NULL;
157 dn = of_node_get(pci_device_to_OF_node(dev));
159 dev_dbg(&dev->dev, "axon_msi: no pci_dn found\n");
163 for (; dn; dn = of_get_next_parent(dn)) {
164 ph = of_get_property(dn, "msi-translator", NULL);
171 "axon_msi: no msi-translator property found\n");
176 dn = of_find_node_by_phandle(*ph);
180 "axon_msi: msi-translator doesn't point to a node\n");
184 irq_host = irq_find_host(dn);
186 dev_dbg(&dev->dev, "axon_msi: no irq_host found for node %s\n",
191 msic = irq_host->host_data;
199 static int axon_msi_check_device(struct pci_dev *dev, int nvec, int type)
201 if (!find_msi_translator(dev))
207 static int setup_msi_msg_address(struct pci_dev *dev, struct msi_msg *msg)
209 struct device_node *dn;
210 struct msi_desc *entry;
214 dn = of_node_get(pci_device_to_OF_node(dev));
216 dev_dbg(&dev->dev, "axon_msi: no pci_dn found\n");
220 entry = list_first_entry(&dev->msi_list, struct msi_desc, list);
222 for (; dn; dn = of_get_next_parent(dn)) {
223 if (entry->msi_attrib.is_64) {
224 prop = of_get_property(dn, "msi-address-64", &len);
229 prop = of_get_property(dn, "msi-address-32", &len);
236 "axon_msi: no msi-address-(32|64) properties found\n");
242 msg->address_hi = prop[0];
243 msg->address_lo = prop[1];
247 msg->address_lo = prop[0];
251 "axon_msi: malformed msi-address-(32|64) property\n");
261 static int axon_msi_setup_msi_irqs(struct pci_dev *dev, int nvec, int type)
263 unsigned int virq, rc;
264 struct msi_desc *entry;
266 struct axon_msic *msic;
268 msic = find_msi_translator(dev);
272 rc = setup_msi_msg_address(dev, &msg);
276 /* We rely on being able to stash a virq in a u16 */
277 BUILD_BUG_ON(NR_IRQS > 65536);
279 list_for_each_entry(entry, &dev->msi_list, list) {
280 virq = irq_create_direct_mapping(msic->irq_host);
281 if (virq == NO_IRQ) {
283 "axon_msi: virq allocation failed!\n");
286 dev_dbg(&dev->dev, "axon_msi: allocated virq 0x%x\n", virq);
288 set_irq_msi(virq, entry);
290 write_msi_msg(virq, &msg);
296 static void axon_msi_teardown_msi_irqs(struct pci_dev *dev)
298 struct msi_desc *entry;
300 dev_dbg(&dev->dev, "axon_msi: tearing down msi irqs\n");
302 list_for_each_entry(entry, &dev->msi_list, list) {
303 if (entry->irq == NO_IRQ)
306 set_irq_msi(entry->irq, NULL);
307 irq_dispose_mapping(entry->irq);
311 static struct irq_chip msic_irq_chip = {
312 .mask = mask_msi_irq,
313 .unmask = unmask_msi_irq,
314 .shutdown = unmask_msi_irq,
315 .typename = "AXON-MSI",
318 static int msic_host_map(struct irq_host *h, unsigned int virq,
321 set_irq_chip_and_handler(virq, &msic_irq_chip, handle_simple_irq);
326 static struct irq_host_ops msic_host_ops = {
327 .map = msic_host_map,
330 static int axon_msi_shutdown(struct of_device *device)
332 struct axon_msic *msic = device->dev.platform_data;
335 pr_debug("axon_msi: disabling %s\n",
336 msic->irq_host->of_node->full_name);
337 tmp = dcr_read(msic->dcr_host, MSIC_CTRL_REG);
338 tmp &= ~MSIC_CTRL_ENABLE & ~MSIC_CTRL_IRQ_ENABLE;
339 msic_dcr_write(msic, MSIC_CTRL_REG, tmp);
344 static int axon_msi_probe(struct of_device *device,
345 const struct of_device_id *device_id)
347 struct device_node *dn = device->node;
348 struct axon_msic *msic;
350 int dcr_base, dcr_len;
352 pr_debug("axon_msi: setting up dn %s\n", dn->full_name);
354 msic = kzalloc(sizeof(struct axon_msic), GFP_KERNEL);
356 printk(KERN_ERR "axon_msi: couldn't allocate msic for %s\n",
361 dcr_base = dcr_resource_start(dn, 0);
362 dcr_len = dcr_resource_len(dn, 0);
364 if (dcr_base == 0 || dcr_len == 0) {
366 "axon_msi: couldn't parse dcr properties on %s\n",
371 msic->dcr_host = dcr_map(dn, dcr_base, dcr_len);
372 if (!DCR_MAP_OK(msic->dcr_host)) {
373 printk(KERN_ERR "axon_msi: dcr_map failed for %s\n",
378 msic->fifo_virt = dma_alloc_coherent(&device->dev, MSIC_FIFO_SIZE_BYTES,
379 &msic->fifo_phys, GFP_KERNEL);
380 if (!msic->fifo_virt) {
381 printk(KERN_ERR "axon_msi: couldn't allocate fifo for %s\n",
386 virq = irq_of_parse_and_map(dn, 0);
387 if (virq == NO_IRQ) {
388 printk(KERN_ERR "axon_msi: irq parse and map failed for %s\n",
392 memset(msic->fifo_virt, 0xff, MSIC_FIFO_SIZE_BYTES);
394 msic->irq_host = irq_alloc_host(dn, IRQ_HOST_MAP_NOMAP,
395 NR_IRQS, &msic_host_ops, 0);
396 if (!msic->irq_host) {
397 printk(KERN_ERR "axon_msi: couldn't allocate irq_host for %s\n",
402 msic->irq_host->host_data = msic;
404 set_irq_data(virq, msic);
405 set_irq_chained_handler(virq, axon_msi_cascade);
406 pr_debug("axon_msi: irq 0x%x setup for axon_msi\n", virq);
408 /* Enable the MSIC hardware */
409 msic_dcr_write(msic, MSIC_BASE_ADDR_HI_REG, msic->fifo_phys >> 32);
410 msic_dcr_write(msic, MSIC_BASE_ADDR_LO_REG,
411 msic->fifo_phys & 0xFFFFFFFF);
412 msic_dcr_write(msic, MSIC_CTRL_REG,
413 MSIC_CTRL_IRQ_ENABLE | MSIC_CTRL_ENABLE |
414 MSIC_CTRL_FIFO_SIZE);
416 msic->read_offset = dcr_read(msic->dcr_host, MSIC_WRITE_OFFSET_REG)
417 & MSIC_FIFO_SIZE_MASK;
419 device->dev.platform_data = msic;
421 ppc_md.setup_msi_irqs = axon_msi_setup_msi_irqs;
422 ppc_md.teardown_msi_irqs = axon_msi_teardown_msi_irqs;
423 ppc_md.msi_check_device = axon_msi_check_device;
425 axon_msi_debug_setup(dn, msic);
427 printk(KERN_DEBUG "axon_msi: setup MSIC on %s\n", dn->full_name);
432 dma_free_coherent(&device->dev, MSIC_FIFO_SIZE_BYTES, msic->fifo_virt,
441 static const struct of_device_id axon_msi_device_id[] = {
443 .compatible = "ibm,axon-msic"
448 static struct of_platform_driver axon_msi_driver = {
449 .match_table = axon_msi_device_id,
450 .probe = axon_msi_probe,
451 .shutdown = axon_msi_shutdown,
457 static int __init axon_msi_init(void)
459 return of_register_platform_driver(&axon_msi_driver);
461 subsys_initcall(axon_msi_init);
465 static int msic_set(void *data, u64 val)
467 struct axon_msic *msic = data;
468 out_le32(msic->trigger, val);
472 static int msic_get(void *data, u64 *val)
478 DEFINE_SIMPLE_ATTRIBUTE(fops_msic, msic_get, msic_set, "%llu\n");
480 void axon_msi_debug_setup(struct device_node *dn, struct axon_msic *msic)
485 addr = of_translate_address(dn, of_get_property(dn, "reg", NULL));
486 if (addr == OF_BAD_ADDR) {
487 pr_debug("axon_msi: couldn't translate reg property\n");
491 msic->trigger = ioremap(addr, 0x4);
492 if (!msic->trigger) {
493 pr_debug("axon_msi: ioremap failed\n");
497 snprintf(name, sizeof(name), "msic_%d", of_node_to_nid(dn));
499 if (!debugfs_create_file(name, 0600, powerpc_debugfs_root,
501 pr_debug("axon_msi: debugfs_create_file failed!\n");