1 // SPDX-License-Identifier: GPL-2.0
3 * SGI IOC3 multifunction device driver
5 * Copyright (C) 2018, 2019 Thomas Bogendoerfer <tbogendoerfer@suse.de>
8 * Stanislaw Skowronek <skylark@unaligned.org>
9 * Joshua Kinard <kumba@gentoo.org>
10 * Brent Casavant <bcasavan@sgi.com> - IOC4 master driver
11 * Pat Gefre <pfg@sgi.com> - IOC3 serial port IRQ demuxer
14 #include <linux/delay.h>
15 #include <linux/errno.h>
16 #include <linux/interrupt.h>
17 #include <linux/irqdomain.h>
18 #include <linux/mfd/core.h>
19 #include <linux/module.h>
20 #include <linux/pci.h>
21 #include <linux/platform_device.h>
22 #include <linux/platform_data/sgi-w1.h>
23 #include <linux/rtc/ds1685.h>
25 #include <asm/pci/bridge.h>
26 #include <asm/sn/ioc3.h>
28 #define IOC3_IRQ_SERIAL_A 6
29 #define IOC3_IRQ_SERIAL_B 15
30 #define IOC3_IRQ_KBD 22
32 /* Bitmask for selecting which IRQs are level triggered */
33 #define IOC3_LVL_MASK (BIT(IOC3_IRQ_SERIAL_A) | BIT(IOC3_IRQ_SERIAL_B))
35 #define M48T35_REG_SIZE 32768 /* size of m48t35 registers */
37 /* 1.2 us latency timer (40 cycles at 33 MHz) */
38 #define IOC3_LATENCY 40
40 struct ioc3_priv_data {
41 struct irq_domain *domain;
42 struct ioc3 __iomem *regs;
47 static void ioc3_irq_ack(struct irq_data *d)
49 struct ioc3_priv_data *ipd = irq_data_get_irq_chip_data(d);
50 unsigned int hwirq = irqd_to_hwirq(d);
52 writel(BIT(hwirq), &ipd->regs->sio_ir);
55 static void ioc3_irq_mask(struct irq_data *d)
57 struct ioc3_priv_data *ipd = irq_data_get_irq_chip_data(d);
58 unsigned int hwirq = irqd_to_hwirq(d);
60 writel(BIT(hwirq), &ipd->regs->sio_iec);
63 static void ioc3_irq_unmask(struct irq_data *d)
65 struct ioc3_priv_data *ipd = irq_data_get_irq_chip_data(d);
66 unsigned int hwirq = irqd_to_hwirq(d);
68 writel(BIT(hwirq), &ipd->regs->sio_ies);
71 static struct irq_chip ioc3_irq_chip = {
73 .irq_ack = ioc3_irq_ack,
74 .irq_mask = ioc3_irq_mask,
75 .irq_unmask = ioc3_irq_unmask,
78 static int ioc3_irq_domain_map(struct irq_domain *d, unsigned int irq,
79 irq_hw_number_t hwirq)
81 /* Set level IRQs for every interrupt contained in IOC3_LVL_MASK */
82 if (BIT(hwirq) & IOC3_LVL_MASK)
83 irq_set_chip_and_handler(irq, &ioc3_irq_chip, handle_level_irq);
85 irq_set_chip_and_handler(irq, &ioc3_irq_chip, handle_edge_irq);
87 irq_set_chip_data(irq, d->host_data);
91 static void ioc3_irq_domain_unmap(struct irq_domain *d, unsigned int irq)
93 irq_set_chip_and_handler(irq, NULL, NULL);
94 irq_set_chip_data(irq, NULL);
97 static const struct irq_domain_ops ioc3_irq_domain_ops = {
98 .map = ioc3_irq_domain_map,
99 .unmap = ioc3_irq_domain_unmap,
102 static void ioc3_irq_handler(struct irq_desc *desc)
104 struct irq_domain *domain = irq_desc_get_handler_data(desc);
105 struct ioc3_priv_data *ipd = domain->host_data;
106 struct ioc3 __iomem *regs = ipd->regs;
109 pending = readl(®s->sio_ir);
110 mask = readl(®s->sio_ies);
111 pending &= mask; /* Mask off not enabled interrupts */
114 generic_handle_domain_irq(domain, __ffs(pending));
116 spurious_interrupt();
120 * System boards/BaseIOs use more interrupt pins of the bridge ASIC
121 * to which the IOC3 is connected. Since the IOC3 MFD driver
122 * knows wiring of these extra pins, we use the map_irq function
123 * to get interrupts activated
125 static int ioc3_map_irq(struct pci_dev *pdev, int slot, int pin)
127 struct pci_host_bridge *hbrg = pci_find_host_bridge(pdev->bus);
129 return hbrg->map_irq(pdev, slot, pin);
132 static int ioc3_irq_domain_setup(struct ioc3_priv_data *ipd, int irq)
134 struct irq_domain *domain;
135 struct fwnode_handle *fn;
137 fn = irq_domain_alloc_named_fwnode("IOC3");
141 domain = irq_domain_create_linear(fn, 24, &ioc3_irq_domain_ops, ipd);
143 irq_domain_free_fwnode(fn);
147 ipd->domain = domain;
149 irq_set_chained_handler_and_data(irq, ioc3_irq_handler, domain);
150 ipd->domain_irq = irq;
154 dev_err(&ipd->pdev->dev, "irq domain setup failed\n");
158 static const struct resource ioc3_uarta_resources[] = {
159 DEFINE_RES_MEM(offsetof(struct ioc3, sregs.uarta),
160 sizeof_field(struct ioc3, sregs.uarta)),
161 DEFINE_RES_IRQ(IOC3_IRQ_SERIAL_A)
164 static const struct resource ioc3_uartb_resources[] = {
165 DEFINE_RES_MEM(offsetof(struct ioc3, sregs.uartb),
166 sizeof_field(struct ioc3, sregs.uartb)),
167 DEFINE_RES_IRQ(IOC3_IRQ_SERIAL_B)
170 static struct mfd_cell ioc3_serial_cells[] = {
172 .name = "ioc3-serial8250",
173 .resources = ioc3_uarta_resources,
174 .num_resources = ARRAY_SIZE(ioc3_uarta_resources),
177 .name = "ioc3-serial8250",
178 .resources = ioc3_uartb_resources,
179 .num_resources = ARRAY_SIZE(ioc3_uartb_resources),
183 static int ioc3_serial_setup(struct ioc3_priv_data *ipd)
187 /* Set gpio pins for RS232/RS422 mode selection */
188 writel(GPCR_UARTA_MODESEL | GPCR_UARTB_MODESEL,
190 /* Select RS232 mode for uart a */
191 writel(0, &ipd->regs->gppr[6]);
192 /* Select RS232 mode for uart b */
193 writel(0, &ipd->regs->gppr[7]);
195 /* Switch both ports to 16650 mode */
196 writel(readl(&ipd->regs->port_a.sscr) & ~SSCR_DMA_EN,
197 &ipd->regs->port_a.sscr);
198 writel(readl(&ipd->regs->port_b.sscr) & ~SSCR_DMA_EN,
199 &ipd->regs->port_b.sscr);
200 udelay(1000); /* Wait until mode switch is done */
202 ret = mfd_add_devices(&ipd->pdev->dev, PLATFORM_DEVID_AUTO,
203 ioc3_serial_cells, ARRAY_SIZE(ioc3_serial_cells),
204 &ipd->pdev->resource[0], 0, ipd->domain);
206 dev_err(&ipd->pdev->dev, "Failed to add 16550 subdevs\n");
213 static const struct resource ioc3_kbd_resources[] = {
214 DEFINE_RES_MEM(offsetof(struct ioc3, serio),
215 sizeof_field(struct ioc3, serio)),
216 DEFINE_RES_IRQ(IOC3_IRQ_KBD)
219 static struct mfd_cell ioc3_kbd_cells[] = {
222 .resources = ioc3_kbd_resources,
223 .num_resources = ARRAY_SIZE(ioc3_kbd_resources),
227 static int ioc3_kbd_setup(struct ioc3_priv_data *ipd)
231 ret = mfd_add_devices(&ipd->pdev->dev, PLATFORM_DEVID_AUTO,
232 ioc3_kbd_cells, ARRAY_SIZE(ioc3_kbd_cells),
233 &ipd->pdev->resource[0], 0, ipd->domain);
235 dev_err(&ipd->pdev->dev, "Failed to add 16550 subdevs\n");
242 static const struct resource ioc3_eth_resources[] = {
243 DEFINE_RES_MEM(offsetof(struct ioc3, eth),
244 sizeof_field(struct ioc3, eth)),
245 DEFINE_RES_MEM(offsetof(struct ioc3, ssram),
246 sizeof_field(struct ioc3, ssram)),
250 static const struct resource ioc3_w1_resources[] = {
251 DEFINE_RES_MEM(offsetof(struct ioc3, mcr),
252 sizeof_field(struct ioc3, mcr)),
254 static struct sgi_w1_platform_data ioc3_w1_platform_data;
256 static struct mfd_cell ioc3_eth_cells[] = {
259 .resources = ioc3_eth_resources,
260 .num_resources = ARRAY_SIZE(ioc3_eth_resources),
264 .resources = ioc3_w1_resources,
265 .num_resources = ARRAY_SIZE(ioc3_w1_resources),
266 .platform_data = &ioc3_w1_platform_data,
267 .pdata_size = sizeof(ioc3_w1_platform_data),
271 static int ioc3_eth_setup(struct ioc3_priv_data *ipd)
275 /* Enable One-Wire bus */
276 writel(GPCR_MLAN_EN, &ipd->regs->gpcr_s);
278 /* Generate unique identifier */
279 snprintf(ioc3_w1_platform_data.dev_id,
280 sizeof(ioc3_w1_platform_data.dev_id), "ioc3-%012llx",
281 ipd->pdev->resource->start);
283 ret = mfd_add_devices(&ipd->pdev->dev, PLATFORM_DEVID_AUTO,
284 ioc3_eth_cells, ARRAY_SIZE(ioc3_eth_cells),
285 &ipd->pdev->resource[0], ipd->pdev->irq, NULL);
287 dev_err(&ipd->pdev->dev, "Failed to add ETH/W1 subdev\n");
294 static const struct resource ioc3_m48t35_resources[] = {
295 DEFINE_RES_MEM(IOC3_BYTEBUS_DEV0, M48T35_REG_SIZE)
298 static struct mfd_cell ioc3_m48t35_cells[] = {
300 .name = "rtc-m48t35",
301 .resources = ioc3_m48t35_resources,
302 .num_resources = ARRAY_SIZE(ioc3_m48t35_resources),
306 static int ioc3_m48t35_setup(struct ioc3_priv_data *ipd)
310 ret = mfd_add_devices(&ipd->pdev->dev, PLATFORM_DEVID_AUTO,
311 ioc3_m48t35_cells, ARRAY_SIZE(ioc3_m48t35_cells),
312 &ipd->pdev->resource[0], 0, ipd->domain);
314 dev_err(&ipd->pdev->dev, "Failed to add M48T35 subdev\n");
319 static struct ds1685_rtc_platform_data ip30_rtc_platform_data = {
322 .uie_unsupported = true,
323 .access_type = ds1685_reg_indirect,
326 static const struct resource ioc3_rtc_ds1685_resources[] = {
327 DEFINE_RES_MEM(IOC3_BYTEBUS_DEV1, 1),
328 DEFINE_RES_MEM(IOC3_BYTEBUS_DEV2, 1),
332 static struct mfd_cell ioc3_ds1685_cells[] = {
334 .name = "rtc-ds1685",
335 .resources = ioc3_rtc_ds1685_resources,
336 .num_resources = ARRAY_SIZE(ioc3_rtc_ds1685_resources),
337 .platform_data = &ip30_rtc_platform_data,
338 .pdata_size = sizeof(ip30_rtc_platform_data),
339 .id = PLATFORM_DEVID_NONE,
343 static int ioc3_ds1685_setup(struct ioc3_priv_data *ipd)
347 irq = ioc3_map_irq(ipd->pdev, 6, 0);
349 ret = mfd_add_devices(&ipd->pdev->dev, 0, ioc3_ds1685_cells,
350 ARRAY_SIZE(ioc3_ds1685_cells),
351 &ipd->pdev->resource[0], irq, NULL);
353 dev_err(&ipd->pdev->dev, "Failed to add DS1685 subdev\n");
359 static const struct resource ioc3_leds_resources[] = {
360 DEFINE_RES_MEM(offsetof(struct ioc3, gppr[0]),
361 sizeof_field(struct ioc3, gppr[0])),
362 DEFINE_RES_MEM(offsetof(struct ioc3, gppr[1]),
363 sizeof_field(struct ioc3, gppr[1])),
366 static struct mfd_cell ioc3_led_cells[] = {
369 .resources = ioc3_leds_resources,
370 .num_resources = ARRAY_SIZE(ioc3_leds_resources),
371 .id = PLATFORM_DEVID_NONE,
375 static int ioc3_led_setup(struct ioc3_priv_data *ipd)
379 ret = mfd_add_devices(&ipd->pdev->dev, 0, ioc3_led_cells,
380 ARRAY_SIZE(ioc3_led_cells),
381 &ipd->pdev->resource[0], 0, ipd->domain);
383 dev_err(&ipd->pdev->dev, "Failed to add LED subdev\n");
388 static int ip27_baseio_setup(struct ioc3_priv_data *ipd)
392 io_irq = ioc3_map_irq(ipd->pdev, PCI_SLOT(ipd->pdev->devfn),
394 ret = ioc3_irq_domain_setup(ipd, io_irq);
398 ret = ioc3_eth_setup(ipd);
402 ret = ioc3_serial_setup(ipd);
406 return ioc3_m48t35_setup(ipd);
409 static int ip27_baseio6g_setup(struct ioc3_priv_data *ipd)
413 io_irq = ioc3_map_irq(ipd->pdev, PCI_SLOT(ipd->pdev->devfn),
415 ret = ioc3_irq_domain_setup(ipd, io_irq);
419 ret = ioc3_eth_setup(ipd);
423 ret = ioc3_serial_setup(ipd);
427 ret = ioc3_m48t35_setup(ipd);
431 return ioc3_kbd_setup(ipd);
434 static int ip27_mio_setup(struct ioc3_priv_data *ipd)
438 ret = ioc3_irq_domain_setup(ipd, ipd->pdev->irq);
442 ret = ioc3_serial_setup(ipd);
446 return ioc3_kbd_setup(ipd);
449 static int ip30_sysboard_setup(struct ioc3_priv_data *ipd)
453 io_irq = ioc3_map_irq(ipd->pdev, PCI_SLOT(ipd->pdev->devfn),
455 ret = ioc3_irq_domain_setup(ipd, io_irq);
459 ret = ioc3_eth_setup(ipd);
463 ret = ioc3_serial_setup(ipd);
467 ret = ioc3_kbd_setup(ipd);
471 ret = ioc3_ds1685_setup(ipd);
475 return ioc3_led_setup(ipd);
478 static int ioc3_menet_setup(struct ioc3_priv_data *ipd)
482 io_irq = ioc3_map_irq(ipd->pdev, PCI_SLOT(ipd->pdev->devfn),
484 ret = ioc3_irq_domain_setup(ipd, io_irq);
488 ret = ioc3_eth_setup(ipd);
492 return ioc3_serial_setup(ipd);
495 static int ioc3_menet4_setup(struct ioc3_priv_data *ipd)
497 return ioc3_eth_setup(ipd);
500 static int ioc3_cad_duo_setup(struct ioc3_priv_data *ipd)
504 io_irq = ioc3_map_irq(ipd->pdev, PCI_SLOT(ipd->pdev->devfn),
506 ret = ioc3_irq_domain_setup(ipd, io_irq);
510 ret = ioc3_eth_setup(ipd);
514 return ioc3_kbd_setup(ipd);
517 /* Helper macro for filling ioc3_info array */
518 #define IOC3_SID(_name, _sid, _setup) \
521 .sid = PCI_VENDOR_ID_SGI | (IOC3_SUBSYS_ ## _sid << 16), \
528 int (*setup)(struct ioc3_priv_data *ipd);
530 IOC3_SID("IP27 BaseIO6G", IP27_BASEIO6G, &ip27_baseio6g_setup),
531 IOC3_SID("IP27 MIO", IP27_MIO, &ip27_mio_setup),
532 IOC3_SID("IP27 BaseIO", IP27_BASEIO, &ip27_baseio_setup),
533 IOC3_SID("IP29 System Board", IP29_SYSBOARD, &ip27_baseio6g_setup),
534 IOC3_SID("IP30 System Board", IP30_SYSBOARD, &ip30_sysboard_setup),
535 IOC3_SID("MENET", MENET, &ioc3_menet_setup),
536 IOC3_SID("MENET4", MENET4, &ioc3_menet4_setup)
540 static int ioc3_setup(struct ioc3_priv_data *ipd)
546 writel(~0, &ipd->regs->sio_iec);
547 writel(~0, &ipd->regs->sio_ir);
548 writel(0, &ipd->regs->eth.eier);
549 writel(~0, &ipd->regs->eth.eisr);
551 /* Read subsystem vendor id and subsystem id */
552 pci_read_config_dword(ipd->pdev, PCI_SUBSYSTEM_VENDOR_ID, &sid);
554 for (i = 0; i < ARRAY_SIZE(ioc3_infos); i++)
555 if (sid == ioc3_infos[i].sid) {
556 pr_info("ioc3: %s\n", ioc3_infos[i].name);
557 return ioc3_infos[i].setup(ipd);
560 /* Treat everything not identified by PCI subid as CAD DUO */
561 pr_info("ioc3: CAD DUO\n");
562 return ioc3_cad_duo_setup(ipd);
565 static int ioc3_mfd_probe(struct pci_dev *pdev,
566 const struct pci_device_id *pci_id)
568 struct ioc3_priv_data *ipd;
569 struct ioc3 __iomem *regs;
572 ret = pci_enable_device(pdev);
576 pci_write_config_byte(pdev, PCI_LATENCY_TIMER, IOC3_LATENCY);
577 pci_set_master(pdev);
579 ret = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(64));
581 pr_err("%s: No usable DMA configuration, aborting.\n",
583 goto out_disable_device;
586 /* Set up per-IOC3 data */
587 ipd = devm_kzalloc(&pdev->dev, sizeof(struct ioc3_priv_data),
591 goto out_disable_device;
596 * Map all IOC3 registers. These are shared between subdevices
597 * so the main IOC3 module manages them.
599 regs = pci_ioremap_bar(pdev, 0);
601 dev_warn(&pdev->dev, "ioc3: Unable to remap PCI BAR for %s.\n",
604 goto out_disable_device;
608 /* Track PCI-device specific data */
609 pci_set_drvdata(pdev, ipd);
611 ret = ioc3_setup(ipd);
613 /* Remove all already added MFD devices */
614 mfd_remove_devices(&ipd->pdev->dev);
616 struct fwnode_handle *fn = ipd->domain->fwnode;
618 irq_domain_remove(ipd->domain);
619 irq_domain_free_fwnode(fn);
620 free_irq(ipd->domain_irq, (void *)ipd);
622 pci_iounmap(pdev, regs);
623 goto out_disable_device;
629 pci_disable_device(pdev);
633 static void ioc3_mfd_remove(struct pci_dev *pdev)
635 struct ioc3_priv_data *ipd;
637 ipd = pci_get_drvdata(pdev);
639 /* Clear and disable all IRQs */
640 writel(~0, &ipd->regs->sio_iec);
641 writel(~0, &ipd->regs->sio_ir);
643 /* Release resources */
644 mfd_remove_devices(&ipd->pdev->dev);
646 struct fwnode_handle *fn = ipd->domain->fwnode;
648 irq_domain_remove(ipd->domain);
649 irq_domain_free_fwnode(fn);
650 free_irq(ipd->domain_irq, (void *)ipd);
652 pci_iounmap(pdev, ipd->regs);
653 pci_disable_device(pdev);
656 static struct pci_device_id ioc3_mfd_id_table[] = {
657 { PCI_VENDOR_ID_SGI, PCI_DEVICE_ID_SGI_IOC3, PCI_ANY_ID, PCI_ANY_ID },
660 MODULE_DEVICE_TABLE(pci, ioc3_mfd_id_table);
662 static struct pci_driver ioc3_mfd_driver = {
664 .id_table = ioc3_mfd_id_table,
665 .probe = ioc3_mfd_probe,
666 .remove = ioc3_mfd_remove,
669 module_pci_driver(ioc3_mfd_driver);
671 MODULE_AUTHOR("Thomas Bogendoerfer <tbogendoerfer@suse.de>");
672 MODULE_DESCRIPTION("SGI IOC3 MFD driver");
673 MODULE_LICENSE("GPL v2");