1d2912cb1SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only 2e4b29009SMischa Jonker /* 3e4b29009SMischa Jonker * Copyright (C) 2004, 2007-2010, 2011-2012 Synopsys, Inc. (www.synopsys.com) 4e4b29009SMischa Jonker * 5e4b29009SMischa Jonker * Driver is originally developed by Pavel Sokolov <psokolov@synopsys.com> 6e4b29009SMischa Jonker */ 7e4b29009SMischa Jonker 88d1cbc98SThierry Reding #include <linux/err.h> 9e4b29009SMischa Jonker #include <linux/module.h> 10e4b29009SMischa Jonker #include <linux/interrupt.h> 11e4b29009SMischa Jonker #include <linux/input.h> 12e4b29009SMischa Jonker #include <linux/serio.h> 13e4b29009SMischa Jonker #include <linux/platform_device.h> 142c0a4f8bSMischa Jonker #include <linux/of.h> 15e4b29009SMischa Jonker #include <linux/io.h> 16e4b29009SMischa Jonker #include <linux/kernel.h> 17e4b29009SMischa Jonker #include <linux/slab.h> 18e4b29009SMischa Jonker 19e4b29009SMischa Jonker #define ARC_PS2_PORTS 2 20e4b29009SMischa Jonker 21e4b29009SMischa Jonker #define ARC_ARC_PS2_ID 0x0001f609 22e4b29009SMischa Jonker 23e4b29009SMischa Jonker #define STAT_TIMEOUT 128 24e4b29009SMischa Jonker 25e4b29009SMischa Jonker #define PS2_STAT_RX_FRM_ERR (1) 26e4b29009SMischa Jonker #define PS2_STAT_RX_BUF_OVER (1 << 1) 27e4b29009SMischa Jonker #define PS2_STAT_RX_INT_EN (1 << 2) 28e4b29009SMischa Jonker #define PS2_STAT_RX_VAL (1 << 3) 29e4b29009SMischa Jonker #define PS2_STAT_TX_ISNOT_FUL (1 << 4) 30e4b29009SMischa Jonker #define PS2_STAT_TX_INT_EN (1 << 5) 31e4b29009SMischa Jonker 32e4b29009SMischa Jonker struct arc_ps2_port { 33e4b29009SMischa Jonker void __iomem *data_addr; 34e4b29009SMischa Jonker void __iomem *status_addr; 35e4b29009SMischa Jonker struct serio *io; 36e4b29009SMischa Jonker }; 37e4b29009SMischa Jonker 38e4b29009SMischa Jonker struct arc_ps2_data { 39e4b29009SMischa Jonker struct arc_ps2_port port[ARC_PS2_PORTS]; 40e4b29009SMischa Jonker void __iomem *addr; 41e4b29009SMischa Jonker unsigned int frame_error; 42e4b29009SMischa Jonker unsigned int buf_overflow; 43e4b29009SMischa Jonker unsigned int total_int; 44e4b29009SMischa Jonker }; 45e4b29009SMischa Jonker 46e4b29009SMischa Jonker static void arc_ps2_check_rx(struct arc_ps2_data *arc_ps2, 47e4b29009SMischa Jonker struct arc_ps2_port *port) 48e4b29009SMischa Jonker { 49e4b29009SMischa Jonker unsigned int timeout = 1000; 50e4b29009SMischa Jonker unsigned int flag, status; 51e4b29009SMischa Jonker unsigned char data; 52e4b29009SMischa Jonker 53e4b29009SMischa Jonker do { 54e4b29009SMischa Jonker status = ioread32(port->status_addr); 55e4b29009SMischa Jonker if (!(status & PS2_STAT_RX_VAL)) 56e4b29009SMischa Jonker return; 57e4b29009SMischa Jonker 58e4b29009SMischa Jonker data = ioread32(port->data_addr) & 0xff; 59e4b29009SMischa Jonker 60e4b29009SMischa Jonker flag = 0; 61e4b29009SMischa Jonker arc_ps2->total_int++; 62e4b29009SMischa Jonker if (status & PS2_STAT_RX_FRM_ERR) { 63e4b29009SMischa Jonker arc_ps2->frame_error++; 64e4b29009SMischa Jonker flag |= SERIO_PARITY; 65e4b29009SMischa Jonker } else if (status & PS2_STAT_RX_BUF_OVER) { 66e4b29009SMischa Jonker arc_ps2->buf_overflow++; 67e4b29009SMischa Jonker flag |= SERIO_FRAME; 68e4b29009SMischa Jonker } 69e4b29009SMischa Jonker 70e4b29009SMischa Jonker serio_interrupt(port->io, data, flag); 71e4b29009SMischa Jonker } while (--timeout); 72e4b29009SMischa Jonker 73e4b29009SMischa Jonker dev_err(&port->io->dev, "PS/2 hardware stuck\n"); 74e4b29009SMischa Jonker } 75e4b29009SMischa Jonker 76e4b29009SMischa Jonker static irqreturn_t arc_ps2_interrupt(int irq, void *dev) 77e4b29009SMischa Jonker { 78e4b29009SMischa Jonker struct arc_ps2_data *arc_ps2 = dev; 79e4b29009SMischa Jonker int i; 80e4b29009SMischa Jonker 81e4b29009SMischa Jonker for (i = 0; i < ARC_PS2_PORTS; i++) 82e4b29009SMischa Jonker arc_ps2_check_rx(arc_ps2, &arc_ps2->port[i]); 83e4b29009SMischa Jonker 84e4b29009SMischa Jonker return IRQ_HANDLED; 85e4b29009SMischa Jonker } 86e4b29009SMischa Jonker 87e4b29009SMischa Jonker static int arc_ps2_write(struct serio *io, unsigned char val) 88e4b29009SMischa Jonker { 89e4b29009SMischa Jonker unsigned status; 90e4b29009SMischa Jonker struct arc_ps2_port *port = io->port_data; 91e4b29009SMischa Jonker int timeout = STAT_TIMEOUT; 92e4b29009SMischa Jonker 93e4b29009SMischa Jonker do { 94e4b29009SMischa Jonker status = ioread32(port->status_addr); 95e4b29009SMischa Jonker cpu_relax(); 96e4b29009SMischa Jonker 97e4b29009SMischa Jonker if (status & PS2_STAT_TX_ISNOT_FUL) { 98e4b29009SMischa Jonker iowrite32(val & 0xff, port->data_addr); 99e4b29009SMischa Jonker return 0; 100e4b29009SMischa Jonker } 101e4b29009SMischa Jonker 102e4b29009SMischa Jonker } while (--timeout); 103e4b29009SMischa Jonker 104e4b29009SMischa Jonker dev_err(&io->dev, "write timeout\n"); 105e4b29009SMischa Jonker return -ETIMEDOUT; 106e4b29009SMischa Jonker } 107e4b29009SMischa Jonker 108e4b29009SMischa Jonker static int arc_ps2_open(struct serio *io) 109e4b29009SMischa Jonker { 110e4b29009SMischa Jonker struct arc_ps2_port *port = io->port_data; 111e4b29009SMischa Jonker 112e4b29009SMischa Jonker iowrite32(PS2_STAT_RX_INT_EN, port->status_addr); 113e4b29009SMischa Jonker 114e4b29009SMischa Jonker return 0; 115e4b29009SMischa Jonker } 116e4b29009SMischa Jonker 117e4b29009SMischa Jonker static void arc_ps2_close(struct serio *io) 118e4b29009SMischa Jonker { 119e4b29009SMischa Jonker struct arc_ps2_port *port = io->port_data; 120e4b29009SMischa Jonker 121e4b29009SMischa Jonker iowrite32(ioread32(port->status_addr) & ~PS2_STAT_RX_INT_EN, 122e4b29009SMischa Jonker port->status_addr); 123e4b29009SMischa Jonker } 124e4b29009SMischa Jonker 1255298cc4cSBill Pemberton static void __iomem *arc_ps2_calc_addr(struct arc_ps2_data *arc_ps2, 126a4d6983cSDmitry Torokhov int index, bool status) 127a4d6983cSDmitry Torokhov { 128a4d6983cSDmitry Torokhov void __iomem *addr; 129a4d6983cSDmitry Torokhov 130a4d6983cSDmitry Torokhov addr = arc_ps2->addr + 4 + 4 * index; 131a4d6983cSDmitry Torokhov if (status) 132a4d6983cSDmitry Torokhov addr += ARC_PS2_PORTS * 4; 133a4d6983cSDmitry Torokhov 134a4d6983cSDmitry Torokhov return addr; 135a4d6983cSDmitry Torokhov } 136a4d6983cSDmitry Torokhov 1375298cc4cSBill Pemberton static void arc_ps2_inhibit_ports(struct arc_ps2_data *arc_ps2) 138a4d6983cSDmitry Torokhov { 139a4d6983cSDmitry Torokhov void __iomem *addr; 140a4d6983cSDmitry Torokhov u32 val; 141a4d6983cSDmitry Torokhov int i; 142a4d6983cSDmitry Torokhov 143a4d6983cSDmitry Torokhov for (i = 0; i < ARC_PS2_PORTS; i++) { 144a4d6983cSDmitry Torokhov addr = arc_ps2_calc_addr(arc_ps2, i, true); 145a4d6983cSDmitry Torokhov val = ioread32(addr); 146a4d6983cSDmitry Torokhov val &= ~(PS2_STAT_RX_INT_EN | PS2_STAT_TX_INT_EN); 147a4d6983cSDmitry Torokhov iowrite32(val, addr); 148a4d6983cSDmitry Torokhov } 149a4d6983cSDmitry Torokhov } 150a4d6983cSDmitry Torokhov 1515298cc4cSBill Pemberton static int arc_ps2_create_port(struct platform_device *pdev, 152e4b29009SMischa Jonker struct arc_ps2_data *arc_ps2, 153e4b29009SMischa Jonker int index) 154e4b29009SMischa Jonker { 155e4b29009SMischa Jonker struct arc_ps2_port *port = &arc_ps2->port[index]; 156e4b29009SMischa Jonker struct serio *io; 157e4b29009SMischa Jonker 158e4b29009SMischa Jonker io = kzalloc(sizeof(struct serio), GFP_KERNEL); 159e4b29009SMischa Jonker if (!io) 160e4b29009SMischa Jonker return -ENOMEM; 161e4b29009SMischa Jonker 162e4b29009SMischa Jonker io->id.type = SERIO_8042; 163e4b29009SMischa Jonker io->write = arc_ps2_write; 164e4b29009SMischa Jonker io->open = arc_ps2_open; 165e4b29009SMischa Jonker io->close = arc_ps2_close; 166e4b29009SMischa Jonker snprintf(io->name, sizeof(io->name), "ARC PS/2 port%d", index); 167e4b29009SMischa Jonker snprintf(io->phys, sizeof(io->phys), "arc/serio%d", index); 168e4b29009SMischa Jonker io->port_data = port; 169e4b29009SMischa Jonker 170e4b29009SMischa Jonker port->io = io; 171e4b29009SMischa Jonker 172a4d6983cSDmitry Torokhov port->data_addr = arc_ps2_calc_addr(arc_ps2, index, false); 173a4d6983cSDmitry Torokhov port->status_addr = arc_ps2_calc_addr(arc_ps2, index, true); 174e4b29009SMischa Jonker 175e4b29009SMischa Jonker dev_dbg(&pdev->dev, "port%d is allocated (data = 0x%p, status = 0x%p)\n", 176e4b29009SMischa Jonker index, port->data_addr, port->status_addr); 177e4b29009SMischa Jonker 178e4b29009SMischa Jonker serio_register_port(port->io); 179e4b29009SMischa Jonker return 0; 180e4b29009SMischa Jonker } 181e4b29009SMischa Jonker 1825298cc4cSBill Pemberton static int arc_ps2_probe(struct platform_device *pdev) 183e4b29009SMischa Jonker { 184e4b29009SMischa Jonker struct arc_ps2_data *arc_ps2; 185a4d6983cSDmitry Torokhov struct resource *res; 186a4d6983cSDmitry Torokhov int irq; 187e4b29009SMischa Jonker int error, id, i; 188e4b29009SMischa Jonker 189a4d6983cSDmitry Torokhov irq = platform_get_irq_byname(pdev, "arc_ps2_irq"); 190a4d6983cSDmitry Torokhov if (irq < 0) { 191a4d6983cSDmitry Torokhov dev_err(&pdev->dev, "no IRQ defined\n"); 192a4d6983cSDmitry Torokhov return -EINVAL; 193a4d6983cSDmitry Torokhov } 194a4d6983cSDmitry Torokhov 195a4d6983cSDmitry Torokhov arc_ps2 = devm_kzalloc(&pdev->dev, sizeof(struct arc_ps2_data), 196a4d6983cSDmitry Torokhov GFP_KERNEL); 197e4b29009SMischa Jonker if (!arc_ps2) { 198e4b29009SMischa Jonker dev_err(&pdev->dev, "out of memory\n"); 199e4b29009SMischa Jonker return -ENOMEM; 200e4b29009SMischa Jonker } 201e4b29009SMischa Jonker 202ef0aca7fSJulia Lawall res = platform_get_resource(pdev, IORESOURCE_MEM, 0); 2038d1cbc98SThierry Reding arc_ps2->addr = devm_ioremap_resource(&pdev->dev, res); 2048d1cbc98SThierry Reding if (IS_ERR(arc_ps2->addr)) 2058d1cbc98SThierry Reding return PTR_ERR(arc_ps2->addr); 206e4b29009SMischa Jonker 207e4b29009SMischa Jonker dev_info(&pdev->dev, "irq = %d, address = 0x%p, ports = %i\n", 208a4d6983cSDmitry Torokhov irq, arc_ps2->addr, ARC_PS2_PORTS); 209e4b29009SMischa Jonker 210e4b29009SMischa Jonker id = ioread32(arc_ps2->addr); 211e4b29009SMischa Jonker if (id != ARC_ARC_PS2_ID) { 212e4b29009SMischa Jonker dev_err(&pdev->dev, "device id does not match\n"); 213a4d6983cSDmitry Torokhov return -ENXIO; 214a4d6983cSDmitry Torokhov } 215a4d6983cSDmitry Torokhov 216a4d6983cSDmitry Torokhov arc_ps2_inhibit_ports(arc_ps2); 217a4d6983cSDmitry Torokhov 218a4d6983cSDmitry Torokhov error = devm_request_irq(&pdev->dev, irq, arc_ps2_interrupt, 219a4d6983cSDmitry Torokhov 0, "arc_ps2", arc_ps2); 220a4d6983cSDmitry Torokhov if (error) { 221a4d6983cSDmitry Torokhov dev_err(&pdev->dev, "Could not allocate IRQ\n"); 222a4d6983cSDmitry Torokhov return error; 223e4b29009SMischa Jonker } 224e4b29009SMischa Jonker 225e4b29009SMischa Jonker for (i = 0; i < ARC_PS2_PORTS; i++) { 226e4b29009SMischa Jonker error = arc_ps2_create_port(pdev, arc_ps2, i); 227e4b29009SMischa Jonker if (error) { 228a4d6983cSDmitry Torokhov while (--i >= 0) 229a4d6983cSDmitry Torokhov serio_unregister_port(arc_ps2->port[i].io); 230a4d6983cSDmitry Torokhov return error; 231a4d6983cSDmitry Torokhov } 232e4b29009SMischa Jonker } 233e4b29009SMischa Jonker 234e4b29009SMischa Jonker platform_set_drvdata(pdev, arc_ps2); 235e4b29009SMischa Jonker 236e4b29009SMischa Jonker return 0; 237e4b29009SMischa Jonker } 238e4b29009SMischa Jonker 239e2619cf7SBill Pemberton static int arc_ps2_remove(struct platform_device *pdev) 240e4b29009SMischa Jonker { 241e4b29009SMischa Jonker struct arc_ps2_data *arc_ps2 = platform_get_drvdata(pdev); 242e4b29009SMischa Jonker int i; 243e4b29009SMischa Jonker 244e4b29009SMischa Jonker for (i = 0; i < ARC_PS2_PORTS; i++) 245e4b29009SMischa Jonker serio_unregister_port(arc_ps2->port[i].io); 246e4b29009SMischa Jonker 247e4b29009SMischa Jonker dev_dbg(&pdev->dev, "interrupt count = %i\n", arc_ps2->total_int); 248e4b29009SMischa Jonker dev_dbg(&pdev->dev, "frame error count = %i\n", arc_ps2->frame_error); 249e4b29009SMischa Jonker dev_dbg(&pdev->dev, "buffer overflow count = %i\n", 250e4b29009SMischa Jonker arc_ps2->buf_overflow); 251e4b29009SMischa Jonker 252e4b29009SMischa Jonker return 0; 253e4b29009SMischa Jonker } 254e4b29009SMischa Jonker 2552c0a4f8bSMischa Jonker #ifdef CONFIG_OF 2562c0a4f8bSMischa Jonker static const struct of_device_id arc_ps2_match[] = { 2572c0a4f8bSMischa Jonker { .compatible = "snps,arc_ps2" }, 2582c0a4f8bSMischa Jonker { }, 2592c0a4f8bSMischa Jonker }; 2602c0a4f8bSMischa Jonker MODULE_DEVICE_TABLE(of, arc_ps2_match); 2612c0a4f8bSMischa Jonker #endif 2622c0a4f8bSMischa Jonker 263e4b29009SMischa Jonker static struct platform_driver arc_ps2_driver = { 264e4b29009SMischa Jonker .driver = { 265e4b29009SMischa Jonker .name = "arc_ps2", 2662c0a4f8bSMischa Jonker .of_match_table = of_match_ptr(arc_ps2_match), 267e4b29009SMischa Jonker }, 268e4b29009SMischa Jonker .probe = arc_ps2_probe, 2691cb0aa88SBill Pemberton .remove = arc_ps2_remove, 270e4b29009SMischa Jonker }; 271e4b29009SMischa Jonker 272e4b29009SMischa Jonker module_platform_driver(arc_ps2_driver); 273e4b29009SMischa Jonker 274e4b29009SMischa Jonker MODULE_LICENSE("GPL"); 275e4b29009SMischa Jonker MODULE_AUTHOR("Pavel Sokolov <psokolov@synopsys.com>"); 276e4b29009SMischa Jonker MODULE_DESCRIPTION("ARC PS/2 Driver"); 277