xref: /openbmc/linux/drivers/input/serio/ioc3kbd.c (revision d053cf0d771f6547cb0537759a9af63cf402908d)
1*273db8f0SThomas Bogendoerfer // SPDX-License-Identifier: GPL-2.0
2*273db8f0SThomas Bogendoerfer /*
3*273db8f0SThomas Bogendoerfer  * SGI IOC3 PS/2 controller driver for linux
4*273db8f0SThomas Bogendoerfer  *
5*273db8f0SThomas Bogendoerfer  * Copyright (C) 2019 Thomas Bogendoerfer <tbogendoerfer@suse.de>
6*273db8f0SThomas Bogendoerfer  *
7*273db8f0SThomas Bogendoerfer  * Based on code Copyright (C) 2005 Stanislaw Skowronek <skylark@unaligned.org>
8*273db8f0SThomas Bogendoerfer  *               Copyright (C) 2009 Johannes Dickgreber <tanzy@gmx.de>
9*273db8f0SThomas Bogendoerfer  */
10*273db8f0SThomas Bogendoerfer 
11*273db8f0SThomas Bogendoerfer #include <linux/delay.h>
12*273db8f0SThomas Bogendoerfer #include <linux/init.h>
13*273db8f0SThomas Bogendoerfer #include <linux/io.h>
14*273db8f0SThomas Bogendoerfer #include <linux/serio.h>
15*273db8f0SThomas Bogendoerfer #include <linux/module.h>
16*273db8f0SThomas Bogendoerfer #include <linux/platform_device.h>
17*273db8f0SThomas Bogendoerfer 
18*273db8f0SThomas Bogendoerfer #include <asm/sn/ioc3.h>
19*273db8f0SThomas Bogendoerfer 
20*273db8f0SThomas Bogendoerfer struct ioc3kbd_data {
21*273db8f0SThomas Bogendoerfer 	struct ioc3_serioregs __iomem *regs;
22*273db8f0SThomas Bogendoerfer 	struct serio *kbd, *aux;
23*273db8f0SThomas Bogendoerfer 	bool kbd_exists, aux_exists;
24*273db8f0SThomas Bogendoerfer 	int irq;
25*273db8f0SThomas Bogendoerfer };
26*273db8f0SThomas Bogendoerfer 
ioc3kbd_wait(struct ioc3_serioregs __iomem * regs,u32 mask)27*273db8f0SThomas Bogendoerfer static int ioc3kbd_wait(struct ioc3_serioregs __iomem *regs, u32 mask)
28*273db8f0SThomas Bogendoerfer {
29*273db8f0SThomas Bogendoerfer 	unsigned long timeout = 0;
30*273db8f0SThomas Bogendoerfer 
31*273db8f0SThomas Bogendoerfer 	while ((readl(&regs->km_csr) & mask) && (timeout < 250)) {
32*273db8f0SThomas Bogendoerfer 		udelay(50);
33*273db8f0SThomas Bogendoerfer 		timeout++;
34*273db8f0SThomas Bogendoerfer 	}
35*273db8f0SThomas Bogendoerfer 	return (timeout >= 250) ? -ETIMEDOUT : 0;
36*273db8f0SThomas Bogendoerfer }
37*273db8f0SThomas Bogendoerfer 
ioc3kbd_write(struct serio * dev,u8 val)38*273db8f0SThomas Bogendoerfer static int ioc3kbd_write(struct serio *dev, u8 val)
39*273db8f0SThomas Bogendoerfer {
40*273db8f0SThomas Bogendoerfer 	struct ioc3kbd_data *d = dev->port_data;
41*273db8f0SThomas Bogendoerfer 	int ret;
42*273db8f0SThomas Bogendoerfer 
43*273db8f0SThomas Bogendoerfer 	ret = ioc3kbd_wait(d->regs, KM_CSR_K_WRT_PEND);
44*273db8f0SThomas Bogendoerfer 	if (ret)
45*273db8f0SThomas Bogendoerfer 		return ret;
46*273db8f0SThomas Bogendoerfer 
47*273db8f0SThomas Bogendoerfer 	writel(val, &d->regs->k_wd);
48*273db8f0SThomas Bogendoerfer 
49*273db8f0SThomas Bogendoerfer 	return 0;
50*273db8f0SThomas Bogendoerfer }
51*273db8f0SThomas Bogendoerfer 
ioc3kbd_start(struct serio * dev)52*273db8f0SThomas Bogendoerfer static int ioc3kbd_start(struct serio *dev)
53*273db8f0SThomas Bogendoerfer {
54*273db8f0SThomas Bogendoerfer 	struct ioc3kbd_data *d = dev->port_data;
55*273db8f0SThomas Bogendoerfer 
56*273db8f0SThomas Bogendoerfer 	d->kbd_exists = true;
57*273db8f0SThomas Bogendoerfer 	return 0;
58*273db8f0SThomas Bogendoerfer }
59*273db8f0SThomas Bogendoerfer 
ioc3kbd_stop(struct serio * dev)60*273db8f0SThomas Bogendoerfer static void ioc3kbd_stop(struct serio *dev)
61*273db8f0SThomas Bogendoerfer {
62*273db8f0SThomas Bogendoerfer 	struct ioc3kbd_data *d = dev->port_data;
63*273db8f0SThomas Bogendoerfer 
64*273db8f0SThomas Bogendoerfer 	d->kbd_exists = false;
65*273db8f0SThomas Bogendoerfer }
66*273db8f0SThomas Bogendoerfer 
ioc3aux_write(struct serio * dev,u8 val)67*273db8f0SThomas Bogendoerfer static int ioc3aux_write(struct serio *dev, u8 val)
68*273db8f0SThomas Bogendoerfer {
69*273db8f0SThomas Bogendoerfer 	struct ioc3kbd_data *d = dev->port_data;
70*273db8f0SThomas Bogendoerfer 	int ret;
71*273db8f0SThomas Bogendoerfer 
72*273db8f0SThomas Bogendoerfer 	ret = ioc3kbd_wait(d->regs, KM_CSR_M_WRT_PEND);
73*273db8f0SThomas Bogendoerfer 	if (ret)
74*273db8f0SThomas Bogendoerfer 		return ret;
75*273db8f0SThomas Bogendoerfer 
76*273db8f0SThomas Bogendoerfer 	writel(val, &d->regs->m_wd);
77*273db8f0SThomas Bogendoerfer 
78*273db8f0SThomas Bogendoerfer 	return 0;
79*273db8f0SThomas Bogendoerfer }
80*273db8f0SThomas Bogendoerfer 
ioc3aux_start(struct serio * dev)81*273db8f0SThomas Bogendoerfer static int ioc3aux_start(struct serio *dev)
82*273db8f0SThomas Bogendoerfer {
83*273db8f0SThomas Bogendoerfer 	struct ioc3kbd_data *d = dev->port_data;
84*273db8f0SThomas Bogendoerfer 
85*273db8f0SThomas Bogendoerfer 	d->aux_exists = true;
86*273db8f0SThomas Bogendoerfer 	return 0;
87*273db8f0SThomas Bogendoerfer }
88*273db8f0SThomas Bogendoerfer 
ioc3aux_stop(struct serio * dev)89*273db8f0SThomas Bogendoerfer static void ioc3aux_stop(struct serio *dev)
90*273db8f0SThomas Bogendoerfer {
91*273db8f0SThomas Bogendoerfer 	struct ioc3kbd_data *d = dev->port_data;
92*273db8f0SThomas Bogendoerfer 
93*273db8f0SThomas Bogendoerfer 	d->aux_exists = false;
94*273db8f0SThomas Bogendoerfer }
95*273db8f0SThomas Bogendoerfer 
ioc3kbd_process_data(struct serio * dev,u32 data)96*273db8f0SThomas Bogendoerfer static void ioc3kbd_process_data(struct serio *dev, u32 data)
97*273db8f0SThomas Bogendoerfer {
98*273db8f0SThomas Bogendoerfer 	if (data & KM_RD_VALID_0)
99*273db8f0SThomas Bogendoerfer 		serio_interrupt(dev, (data >> KM_RD_DATA_0_SHIFT) & 0xff, 0);
100*273db8f0SThomas Bogendoerfer 	if (data & KM_RD_VALID_1)
101*273db8f0SThomas Bogendoerfer 		serio_interrupt(dev, (data >> KM_RD_DATA_1_SHIFT) & 0xff, 0);
102*273db8f0SThomas Bogendoerfer 	if (data & KM_RD_VALID_2)
103*273db8f0SThomas Bogendoerfer 		serio_interrupt(dev, (data >> KM_RD_DATA_2_SHIFT) & 0xff, 0);
104*273db8f0SThomas Bogendoerfer }
105*273db8f0SThomas Bogendoerfer 
ioc3kbd_intr(int itq,void * dev_id)106*273db8f0SThomas Bogendoerfer static irqreturn_t ioc3kbd_intr(int itq, void *dev_id)
107*273db8f0SThomas Bogendoerfer {
108*273db8f0SThomas Bogendoerfer 	struct ioc3kbd_data *d = dev_id;
109*273db8f0SThomas Bogendoerfer 	u32 data_k, data_m;
110*273db8f0SThomas Bogendoerfer 
111*273db8f0SThomas Bogendoerfer 	data_k = readl(&d->regs->k_rd);
112*273db8f0SThomas Bogendoerfer 	if (d->kbd_exists)
113*273db8f0SThomas Bogendoerfer 		ioc3kbd_process_data(d->kbd, data_k);
114*273db8f0SThomas Bogendoerfer 
115*273db8f0SThomas Bogendoerfer 	data_m = readl(&d->regs->m_rd);
116*273db8f0SThomas Bogendoerfer 	if (d->aux_exists)
117*273db8f0SThomas Bogendoerfer 		ioc3kbd_process_data(d->aux, data_m);
118*273db8f0SThomas Bogendoerfer 
119*273db8f0SThomas Bogendoerfer 	return IRQ_HANDLED;
120*273db8f0SThomas Bogendoerfer }
121*273db8f0SThomas Bogendoerfer 
ioc3kbd_probe(struct platform_device * pdev)122*273db8f0SThomas Bogendoerfer static int ioc3kbd_probe(struct platform_device *pdev)
123*273db8f0SThomas Bogendoerfer {
124*273db8f0SThomas Bogendoerfer 	struct ioc3_serioregs __iomem *regs;
125*273db8f0SThomas Bogendoerfer 	struct device *dev = &pdev->dev;
126*273db8f0SThomas Bogendoerfer 	struct ioc3kbd_data *d;
127*273db8f0SThomas Bogendoerfer 	struct serio *sk, *sa;
128*273db8f0SThomas Bogendoerfer 	int irq, ret;
129*273db8f0SThomas Bogendoerfer 
130*273db8f0SThomas Bogendoerfer 	regs = devm_platform_ioremap_resource(pdev, 0);
131*273db8f0SThomas Bogendoerfer 	if (IS_ERR(regs))
132*273db8f0SThomas Bogendoerfer 		return PTR_ERR(regs);
133*273db8f0SThomas Bogendoerfer 
134*273db8f0SThomas Bogendoerfer 	irq = platform_get_irq(pdev, 0);
135*273db8f0SThomas Bogendoerfer 	if (irq < 0)
136*273db8f0SThomas Bogendoerfer 		return -ENXIO;
137*273db8f0SThomas Bogendoerfer 
138*273db8f0SThomas Bogendoerfer 	d = devm_kzalloc(dev, sizeof(*d), GFP_KERNEL);
139*273db8f0SThomas Bogendoerfer 	if (!d)
140*273db8f0SThomas Bogendoerfer 		return -ENOMEM;
141*273db8f0SThomas Bogendoerfer 
142*273db8f0SThomas Bogendoerfer 	sk = kzalloc(sizeof(*sk), GFP_KERNEL);
143*273db8f0SThomas Bogendoerfer 	if (!sk)
144*273db8f0SThomas Bogendoerfer 		return -ENOMEM;
145*273db8f0SThomas Bogendoerfer 
146*273db8f0SThomas Bogendoerfer 	sa = kzalloc(sizeof(*sa), GFP_KERNEL);
147*273db8f0SThomas Bogendoerfer 	if (!sa) {
148*273db8f0SThomas Bogendoerfer 		kfree(sk);
149*273db8f0SThomas Bogendoerfer 		return -ENOMEM;
150*273db8f0SThomas Bogendoerfer 	}
151*273db8f0SThomas Bogendoerfer 
152*273db8f0SThomas Bogendoerfer 	sk->id.type = SERIO_8042;
153*273db8f0SThomas Bogendoerfer 	sk->write = ioc3kbd_write;
154*273db8f0SThomas Bogendoerfer 	sk->start = ioc3kbd_start;
155*273db8f0SThomas Bogendoerfer 	sk->stop = ioc3kbd_stop;
156*273db8f0SThomas Bogendoerfer 	snprintf(sk->name, sizeof(sk->name), "IOC3 keyboard %d", pdev->id);
157*273db8f0SThomas Bogendoerfer 	snprintf(sk->phys, sizeof(sk->phys), "ioc3/serio%dkbd", pdev->id);
158*273db8f0SThomas Bogendoerfer 	sk->port_data = d;
159*273db8f0SThomas Bogendoerfer 	sk->dev.parent = dev;
160*273db8f0SThomas Bogendoerfer 
161*273db8f0SThomas Bogendoerfer 	sa->id.type = SERIO_8042;
162*273db8f0SThomas Bogendoerfer 	sa->write = ioc3aux_write;
163*273db8f0SThomas Bogendoerfer 	sa->start = ioc3aux_start;
164*273db8f0SThomas Bogendoerfer 	sa->stop = ioc3aux_stop;
165*273db8f0SThomas Bogendoerfer 	snprintf(sa->name, sizeof(sa->name), "IOC3 auxiliary %d", pdev->id);
166*273db8f0SThomas Bogendoerfer 	snprintf(sa->phys, sizeof(sa->phys), "ioc3/serio%daux", pdev->id);
167*273db8f0SThomas Bogendoerfer 	sa->port_data = d;
168*273db8f0SThomas Bogendoerfer 	sa->dev.parent = dev;
169*273db8f0SThomas Bogendoerfer 
170*273db8f0SThomas Bogendoerfer 	d->regs = regs;
171*273db8f0SThomas Bogendoerfer 	d->kbd = sk;
172*273db8f0SThomas Bogendoerfer 	d->aux = sa;
173*273db8f0SThomas Bogendoerfer 	d->irq = irq;
174*273db8f0SThomas Bogendoerfer 
175*273db8f0SThomas Bogendoerfer 	platform_set_drvdata(pdev, d);
176*273db8f0SThomas Bogendoerfer 	serio_register_port(d->kbd);
177*273db8f0SThomas Bogendoerfer 	serio_register_port(d->aux);
178*273db8f0SThomas Bogendoerfer 
179*273db8f0SThomas Bogendoerfer 	ret = request_irq(irq, ioc3kbd_intr, IRQF_SHARED, "ioc3-kbd", d);
180*273db8f0SThomas Bogendoerfer 	if (ret) {
181*273db8f0SThomas Bogendoerfer 		dev_err(dev, "could not request IRQ %d\n", irq);
182*273db8f0SThomas Bogendoerfer 		serio_unregister_port(d->kbd);
183*273db8f0SThomas Bogendoerfer 		serio_unregister_port(d->aux);
184*273db8f0SThomas Bogendoerfer 		return ret;
185*273db8f0SThomas Bogendoerfer 	}
186*273db8f0SThomas Bogendoerfer 
187*273db8f0SThomas Bogendoerfer 	/* enable ports */
188*273db8f0SThomas Bogendoerfer 	writel(KM_CSR_K_CLAMP_3 | KM_CSR_M_CLAMP_3, &regs->km_csr);
189*273db8f0SThomas Bogendoerfer 
190*273db8f0SThomas Bogendoerfer 	return 0;
191*273db8f0SThomas Bogendoerfer }
192*273db8f0SThomas Bogendoerfer 
ioc3kbd_remove(struct platform_device * pdev)193*273db8f0SThomas Bogendoerfer static int ioc3kbd_remove(struct platform_device *pdev)
194*273db8f0SThomas Bogendoerfer {
195*273db8f0SThomas Bogendoerfer 	struct ioc3kbd_data *d = platform_get_drvdata(pdev);
196*273db8f0SThomas Bogendoerfer 
197*273db8f0SThomas Bogendoerfer 	free_irq(d->irq, d);
198*273db8f0SThomas Bogendoerfer 
199*273db8f0SThomas Bogendoerfer 	serio_unregister_port(d->kbd);
200*273db8f0SThomas Bogendoerfer 	serio_unregister_port(d->aux);
201*273db8f0SThomas Bogendoerfer 
202*273db8f0SThomas Bogendoerfer 	return 0;
203*273db8f0SThomas Bogendoerfer }
204*273db8f0SThomas Bogendoerfer 
205*273db8f0SThomas Bogendoerfer static struct platform_driver ioc3kbd_driver = {
206*273db8f0SThomas Bogendoerfer 	.probe          = ioc3kbd_probe,
207*273db8f0SThomas Bogendoerfer 	.remove         = ioc3kbd_remove,
208*273db8f0SThomas Bogendoerfer 	.driver = {
209*273db8f0SThomas Bogendoerfer 		.name = "ioc3-kbd",
210*273db8f0SThomas Bogendoerfer 	},
211*273db8f0SThomas Bogendoerfer };
212*273db8f0SThomas Bogendoerfer module_platform_driver(ioc3kbd_driver);
213*273db8f0SThomas Bogendoerfer 
214*273db8f0SThomas Bogendoerfer MODULE_AUTHOR("Thomas Bogendoerfer <tbogendoerfer@suse.de>");
215*273db8f0SThomas Bogendoerfer MODULE_DESCRIPTION("SGI IOC3 serio driver");
216*273db8f0SThomas Bogendoerfer MODULE_LICENSE("GPL");
217