1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0-only
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * Altera University Program PS2 controller driver
4*4882a593Smuzhiyun *
5*4882a593Smuzhiyun * Copyright (C) 2008 Thomas Chou <thomas@wytron.com.tw>
6*4882a593Smuzhiyun *
7*4882a593Smuzhiyun * Based on sa1111ps2.c, which is:
8*4882a593Smuzhiyun * Copyright (C) 2002 Russell King
9*4882a593Smuzhiyun */
10*4882a593Smuzhiyun
11*4882a593Smuzhiyun #include <linux/module.h>
12*4882a593Smuzhiyun #include <linux/input.h>
13*4882a593Smuzhiyun #include <linux/serio.h>
14*4882a593Smuzhiyun #include <linux/interrupt.h>
15*4882a593Smuzhiyun #include <linux/platform_device.h>
16*4882a593Smuzhiyun #include <linux/io.h>
17*4882a593Smuzhiyun #include <linux/slab.h>
18*4882a593Smuzhiyun #include <linux/of.h>
19*4882a593Smuzhiyun
20*4882a593Smuzhiyun #define DRV_NAME "altera_ps2"
21*4882a593Smuzhiyun
22*4882a593Smuzhiyun struct ps2if {
23*4882a593Smuzhiyun struct serio *io;
24*4882a593Smuzhiyun void __iomem *base;
25*4882a593Smuzhiyun };
26*4882a593Smuzhiyun
27*4882a593Smuzhiyun /*
28*4882a593Smuzhiyun * Read all bytes waiting in the PS2 port. There should be
29*4882a593Smuzhiyun * at the most one, but we loop for safety.
30*4882a593Smuzhiyun */
altera_ps2_rxint(int irq,void * dev_id)31*4882a593Smuzhiyun static irqreturn_t altera_ps2_rxint(int irq, void *dev_id)
32*4882a593Smuzhiyun {
33*4882a593Smuzhiyun struct ps2if *ps2if = dev_id;
34*4882a593Smuzhiyun unsigned int status;
35*4882a593Smuzhiyun irqreturn_t handled = IRQ_NONE;
36*4882a593Smuzhiyun
37*4882a593Smuzhiyun while ((status = readl(ps2if->base)) & 0xffff0000) {
38*4882a593Smuzhiyun serio_interrupt(ps2if->io, status & 0xff, 0);
39*4882a593Smuzhiyun handled = IRQ_HANDLED;
40*4882a593Smuzhiyun }
41*4882a593Smuzhiyun
42*4882a593Smuzhiyun return handled;
43*4882a593Smuzhiyun }
44*4882a593Smuzhiyun
45*4882a593Smuzhiyun /*
46*4882a593Smuzhiyun * Write a byte to the PS2 port.
47*4882a593Smuzhiyun */
altera_ps2_write(struct serio * io,unsigned char val)48*4882a593Smuzhiyun static int altera_ps2_write(struct serio *io, unsigned char val)
49*4882a593Smuzhiyun {
50*4882a593Smuzhiyun struct ps2if *ps2if = io->port_data;
51*4882a593Smuzhiyun
52*4882a593Smuzhiyun writel(val, ps2if->base);
53*4882a593Smuzhiyun return 0;
54*4882a593Smuzhiyun }
55*4882a593Smuzhiyun
altera_ps2_open(struct serio * io)56*4882a593Smuzhiyun static int altera_ps2_open(struct serio *io)
57*4882a593Smuzhiyun {
58*4882a593Smuzhiyun struct ps2if *ps2if = io->port_data;
59*4882a593Smuzhiyun
60*4882a593Smuzhiyun /* clear fifo */
61*4882a593Smuzhiyun while (readl(ps2if->base) & 0xffff0000)
62*4882a593Smuzhiyun /* empty */;
63*4882a593Smuzhiyun
64*4882a593Smuzhiyun writel(1, ps2if->base + 4); /* enable rx irq */
65*4882a593Smuzhiyun return 0;
66*4882a593Smuzhiyun }
67*4882a593Smuzhiyun
altera_ps2_close(struct serio * io)68*4882a593Smuzhiyun static void altera_ps2_close(struct serio *io)
69*4882a593Smuzhiyun {
70*4882a593Smuzhiyun struct ps2if *ps2if = io->port_data;
71*4882a593Smuzhiyun
72*4882a593Smuzhiyun writel(0, ps2if->base + 4); /* disable rx irq */
73*4882a593Smuzhiyun }
74*4882a593Smuzhiyun
75*4882a593Smuzhiyun /*
76*4882a593Smuzhiyun * Add one device to this driver.
77*4882a593Smuzhiyun */
altera_ps2_probe(struct platform_device * pdev)78*4882a593Smuzhiyun static int altera_ps2_probe(struct platform_device *pdev)
79*4882a593Smuzhiyun {
80*4882a593Smuzhiyun struct ps2if *ps2if;
81*4882a593Smuzhiyun struct resource *res;
82*4882a593Smuzhiyun struct serio *serio;
83*4882a593Smuzhiyun int error, irq;
84*4882a593Smuzhiyun
85*4882a593Smuzhiyun ps2if = devm_kzalloc(&pdev->dev, sizeof(struct ps2if), GFP_KERNEL);
86*4882a593Smuzhiyun if (!ps2if)
87*4882a593Smuzhiyun return -ENOMEM;
88*4882a593Smuzhiyun
89*4882a593Smuzhiyun res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
90*4882a593Smuzhiyun ps2if->base = devm_ioremap_resource(&pdev->dev, res);
91*4882a593Smuzhiyun if (IS_ERR(ps2if->base))
92*4882a593Smuzhiyun return PTR_ERR(ps2if->base);
93*4882a593Smuzhiyun
94*4882a593Smuzhiyun irq = platform_get_irq(pdev, 0);
95*4882a593Smuzhiyun if (irq < 0)
96*4882a593Smuzhiyun return -ENXIO;
97*4882a593Smuzhiyun
98*4882a593Smuzhiyun error = devm_request_irq(&pdev->dev, irq, altera_ps2_rxint, 0,
99*4882a593Smuzhiyun pdev->name, ps2if);
100*4882a593Smuzhiyun if (error) {
101*4882a593Smuzhiyun dev_err(&pdev->dev, "could not request IRQ %d\n", irq);
102*4882a593Smuzhiyun return error;
103*4882a593Smuzhiyun }
104*4882a593Smuzhiyun
105*4882a593Smuzhiyun serio = kzalloc(sizeof(struct serio), GFP_KERNEL);
106*4882a593Smuzhiyun if (!serio)
107*4882a593Smuzhiyun return -ENOMEM;
108*4882a593Smuzhiyun
109*4882a593Smuzhiyun serio->id.type = SERIO_8042;
110*4882a593Smuzhiyun serio->write = altera_ps2_write;
111*4882a593Smuzhiyun serio->open = altera_ps2_open;
112*4882a593Smuzhiyun serio->close = altera_ps2_close;
113*4882a593Smuzhiyun strlcpy(serio->name, dev_name(&pdev->dev), sizeof(serio->name));
114*4882a593Smuzhiyun strlcpy(serio->phys, dev_name(&pdev->dev), sizeof(serio->phys));
115*4882a593Smuzhiyun serio->port_data = ps2if;
116*4882a593Smuzhiyun serio->dev.parent = &pdev->dev;
117*4882a593Smuzhiyun ps2if->io = serio;
118*4882a593Smuzhiyun
119*4882a593Smuzhiyun dev_info(&pdev->dev, "base %p, irq %d\n", ps2if->base, irq);
120*4882a593Smuzhiyun
121*4882a593Smuzhiyun serio_register_port(ps2if->io);
122*4882a593Smuzhiyun platform_set_drvdata(pdev, ps2if);
123*4882a593Smuzhiyun
124*4882a593Smuzhiyun return 0;
125*4882a593Smuzhiyun }
126*4882a593Smuzhiyun
127*4882a593Smuzhiyun /*
128*4882a593Smuzhiyun * Remove one device from this driver.
129*4882a593Smuzhiyun */
altera_ps2_remove(struct platform_device * pdev)130*4882a593Smuzhiyun static int altera_ps2_remove(struct platform_device *pdev)
131*4882a593Smuzhiyun {
132*4882a593Smuzhiyun struct ps2if *ps2if = platform_get_drvdata(pdev);
133*4882a593Smuzhiyun
134*4882a593Smuzhiyun serio_unregister_port(ps2if->io);
135*4882a593Smuzhiyun
136*4882a593Smuzhiyun return 0;
137*4882a593Smuzhiyun }
138*4882a593Smuzhiyun
139*4882a593Smuzhiyun #ifdef CONFIG_OF
140*4882a593Smuzhiyun static const struct of_device_id altera_ps2_match[] = {
141*4882a593Smuzhiyun { .compatible = "ALTR,ps2-1.0", },
142*4882a593Smuzhiyun { .compatible = "altr,ps2-1.0", },
143*4882a593Smuzhiyun {},
144*4882a593Smuzhiyun };
145*4882a593Smuzhiyun MODULE_DEVICE_TABLE(of, altera_ps2_match);
146*4882a593Smuzhiyun #endif /* CONFIG_OF */
147*4882a593Smuzhiyun
148*4882a593Smuzhiyun /*
149*4882a593Smuzhiyun * Our device driver structure
150*4882a593Smuzhiyun */
151*4882a593Smuzhiyun static struct platform_driver altera_ps2_driver = {
152*4882a593Smuzhiyun .probe = altera_ps2_probe,
153*4882a593Smuzhiyun .remove = altera_ps2_remove,
154*4882a593Smuzhiyun .driver = {
155*4882a593Smuzhiyun .name = DRV_NAME,
156*4882a593Smuzhiyun .of_match_table = of_match_ptr(altera_ps2_match),
157*4882a593Smuzhiyun },
158*4882a593Smuzhiyun };
159*4882a593Smuzhiyun module_platform_driver(altera_ps2_driver);
160*4882a593Smuzhiyun
161*4882a593Smuzhiyun MODULE_DESCRIPTION("Altera University Program PS2 controller driver");
162*4882a593Smuzhiyun MODULE_AUTHOR("Thomas Chou <thomas@wytron.com.tw>");
163*4882a593Smuzhiyun MODULE_LICENSE("GPL");
164*4882a593Smuzhiyun MODULE_ALIAS("platform:" DRV_NAME);
165