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;
99 write_offset = dcr_read(msic->dcr_host, MSIC_WRITE_OFFSET_REG);
100 pr_debug("axon_msi: original write_offset 0x%x\n", write_offset);
102 /* write_offset doesn't wrap properly, so we have to mask it */
103 write_offset &= MSIC_FIFO_SIZE_MASK;
105 while (msic->read_offset != write_offset) {
106 idx = msic->read_offset / sizeof(__le32);
107 msi = le32_to_cpu(msic->fifo_virt[idx]);
110 pr_debug("axon_msi: woff %x roff %x msi %x\n",
111 write_offset, msic->read_offset, msi);
113 msic->read_offset += MSIC_FIFO_ENTRY_SIZE;
114 msic->read_offset &= MSIC_FIFO_SIZE_MASK;
116 if (msi < NR_IRQS && irq_map[msi].host == msic->irq_host)
117 generic_handle_irq(msi);
119 pr_debug("axon_msi: invalid irq 0x%x!\n", msi);
122 desc->chip->eoi(irq);
125 static struct axon_msic *find_msi_translator(struct pci_dev *dev)
127 struct irq_host *irq_host;
128 struct device_node *dn, *tmp;
130 struct axon_msic *msic = NULL;
132 dn = of_node_get(pci_device_to_OF_node(dev));
134 dev_dbg(&dev->dev, "axon_msi: no pci_dn found\n");
138 for (; dn; dn = of_get_next_parent(dn)) {
139 ph = of_get_property(dn, "msi-translator", NULL);
146 "axon_msi: no msi-translator property found\n");
151 dn = of_find_node_by_phandle(*ph);
155 "axon_msi: msi-translator doesn't point to a node\n");
159 irq_host = irq_find_host(dn);
161 dev_dbg(&dev->dev, "axon_msi: no irq_host found for node %s\n",
166 msic = irq_host->host_data;
174 static int axon_msi_check_device(struct pci_dev *dev, int nvec, int type)
176 if (!find_msi_translator(dev))
182 static int setup_msi_msg_address(struct pci_dev *dev, struct msi_msg *msg)
184 struct device_node *dn;
185 struct msi_desc *entry;
189 dn = of_node_get(pci_device_to_OF_node(dev));
191 dev_dbg(&dev->dev, "axon_msi: no pci_dn found\n");
195 entry = list_first_entry(&dev->msi_list, struct msi_desc, list);
197 for (; dn; dn = of_get_next_parent(dn)) {
198 if (entry->msi_attrib.is_64) {
199 prop = of_get_property(dn, "msi-address-64", &len);
204 prop = of_get_property(dn, "msi-address-32", &len);
211 "axon_msi: no msi-address-(32|64) properties found\n");
217 msg->address_hi = prop[0];
218 msg->address_lo = prop[1];
222 msg->address_lo = prop[0];
226 "axon_msi: malformed msi-address-(32|64) property\n");
236 static int axon_msi_setup_msi_irqs(struct pci_dev *dev, int nvec, int type)
238 unsigned int virq, rc;
239 struct msi_desc *entry;
241 struct axon_msic *msic;
243 msic = find_msi_translator(dev);
247 rc = setup_msi_msg_address(dev, &msg);
251 /* We rely on being able to stash a virq in a u16 */
252 BUILD_BUG_ON(NR_IRQS > 65536);
254 list_for_each_entry(entry, &dev->msi_list, list) {
255 virq = irq_create_direct_mapping(msic->irq_host);
256 if (virq == NO_IRQ) {
258 "axon_msi: virq allocation failed!\n");
261 dev_dbg(&dev->dev, "axon_msi: allocated virq 0x%x\n", virq);
263 set_irq_msi(virq, entry);
265 write_msi_msg(virq, &msg);
271 static void axon_msi_teardown_msi_irqs(struct pci_dev *dev)
273 struct msi_desc *entry;
275 dev_dbg(&dev->dev, "axon_msi: tearing down msi irqs\n");
277 list_for_each_entry(entry, &dev->msi_list, list) {
278 if (entry->irq == NO_IRQ)
281 set_irq_msi(entry->irq, NULL);
282 irq_dispose_mapping(entry->irq);
286 static struct irq_chip msic_irq_chip = {
287 .mask = mask_msi_irq,
288 .unmask = unmask_msi_irq,
289 .shutdown = unmask_msi_irq,
290 .typename = "AXON-MSI",
293 static int msic_host_map(struct irq_host *h, unsigned int virq,
296 set_irq_chip_and_handler(virq, &msic_irq_chip, handle_simple_irq);
301 static struct irq_host_ops msic_host_ops = {
302 .map = msic_host_map,
305 static int axon_msi_shutdown(struct of_device *device)
307 struct axon_msic *msic = device->dev.platform_data;
310 pr_debug("axon_msi: disabling %s\n",
311 msic->irq_host->of_node->full_name);
312 tmp = dcr_read(msic->dcr_host, MSIC_CTRL_REG);
313 tmp &= ~MSIC_CTRL_ENABLE & ~MSIC_CTRL_IRQ_ENABLE;
314 msic_dcr_write(msic, MSIC_CTRL_REG, tmp);
319 static int axon_msi_probe(struct of_device *device,
320 const struct of_device_id *device_id)
322 struct device_node *dn = device->node;
323 struct axon_msic *msic;
325 int dcr_base, dcr_len;
327 pr_debug("axon_msi: setting up dn %s\n", dn->full_name);
329 msic = kzalloc(sizeof(struct axon_msic), GFP_KERNEL);
331 printk(KERN_ERR "axon_msi: couldn't allocate msic for %s\n",
336 dcr_base = dcr_resource_start(dn, 0);
337 dcr_len = dcr_resource_len(dn, 0);
339 if (dcr_base == 0 || dcr_len == 0) {
341 "axon_msi: couldn't parse dcr properties on %s\n",
346 msic->dcr_host = dcr_map(dn, dcr_base, dcr_len);
347 if (!DCR_MAP_OK(msic->dcr_host)) {
348 printk(KERN_ERR "axon_msi: dcr_map failed for %s\n",
353 msic->fifo_virt = dma_alloc_coherent(&device->dev, MSIC_FIFO_SIZE_BYTES,
354 &msic->fifo_phys, GFP_KERNEL);
355 if (!msic->fifo_virt) {
356 printk(KERN_ERR "axon_msi: couldn't allocate fifo for %s\n",
361 virq = irq_of_parse_and_map(dn, 0);
362 if (virq == NO_IRQ) {
363 printk(KERN_ERR "axon_msi: irq parse and map failed for %s\n",
368 msic->irq_host = irq_alloc_host(dn, IRQ_HOST_MAP_NOMAP,
369 NR_IRQS, &msic_host_ops, 0);
370 if (!msic->irq_host) {
371 printk(KERN_ERR "axon_msi: couldn't allocate irq_host for %s\n",
376 msic->irq_host->host_data = msic;
378 set_irq_data(virq, msic);
379 set_irq_chained_handler(virq, axon_msi_cascade);
380 pr_debug("axon_msi: irq 0x%x setup for axon_msi\n", virq);
382 /* Enable the MSIC hardware */
383 msic_dcr_write(msic, MSIC_BASE_ADDR_HI_REG, msic->fifo_phys >> 32);
384 msic_dcr_write(msic, MSIC_BASE_ADDR_LO_REG,
385 msic->fifo_phys & 0xFFFFFFFF);
386 msic_dcr_write(msic, MSIC_CTRL_REG,
387 MSIC_CTRL_IRQ_ENABLE | MSIC_CTRL_ENABLE |
388 MSIC_CTRL_FIFO_SIZE);
390 device->dev.platform_data = msic;
392 ppc_md.setup_msi_irqs = axon_msi_setup_msi_irqs;
393 ppc_md.teardown_msi_irqs = axon_msi_teardown_msi_irqs;
394 ppc_md.msi_check_device = axon_msi_check_device;
396 axon_msi_debug_setup(dn, msic);
398 printk(KERN_DEBUG "axon_msi: setup MSIC on %s\n", dn->full_name);
403 dma_free_coherent(&device->dev, MSIC_FIFO_SIZE_BYTES, msic->fifo_virt,
412 static const struct of_device_id axon_msi_device_id[] = {
414 .compatible = "ibm,axon-msic"
419 static struct of_platform_driver axon_msi_driver = {
420 .match_table = axon_msi_device_id,
421 .probe = axon_msi_probe,
422 .shutdown = axon_msi_shutdown,
428 static int __init axon_msi_init(void)
430 return of_register_platform_driver(&axon_msi_driver);
432 subsys_initcall(axon_msi_init);
436 static int msic_set(void *data, u64 val)
438 struct axon_msic *msic = data;
439 out_le32(msic->trigger, val);
443 static int msic_get(void *data, u64 *val)
449 DEFINE_SIMPLE_ATTRIBUTE(fops_msic, msic_get, msic_set, "%llu\n");
451 void axon_msi_debug_setup(struct device_node *dn, struct axon_msic *msic)
456 addr = of_translate_address(dn, of_get_property(dn, "reg", NULL));
457 if (addr == OF_BAD_ADDR) {
458 pr_debug("axon_msi: couldn't translate reg property\n");
462 msic->trigger = ioremap(addr, 0x4);
463 if (!msic->trigger) {
464 pr_debug("axon_msi: ioremap failed\n");
468 snprintf(name, sizeof(name), "msic_%d", of_node_to_nid(dn));
470 if (!debugfs_create_file(name, 0600, powerpc_debugfs_root,
472 pr_debug("axon_msi: debugfs_create_file failed!\n");