xref: /openbmc/linux/drivers/input/serio/ct82c710.c (revision d1659fcc)
1 /*
2  *  Copyright (c) 1999-2001 Vojtech Pavlik
3  */
4 
5 /*
6  *  82C710 C&T mouse port chip driver for Linux
7  */
8 
9 /*
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23  *
24  * Should you need to contact me, the author, you can do so either by
25  * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
26  * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
27  */
28 
29 #include <linux/delay.h>
30 #include <linux/module.h>
31 #include <linux/ioport.h>
32 #include <linux/init.h>
33 #include <linux/interrupt.h>
34 #include <linux/serio.h>
35 #include <linux/errno.h>
36 #include <linux/err.h>
37 #include <linux/platform_device.h>
38 
39 #include <asm/io.h>
40 
41 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
42 MODULE_DESCRIPTION("82C710 C&T mouse port chip driver");
43 MODULE_LICENSE("GPL");
44 
45 /*
46  * ct82c710 interface
47  */
48 
49 #define CT82C710_DEV_IDLE     0x01		/* Device Idle */
50 #define CT82C710_RX_FULL      0x02		/* Device Char received */
51 #define CT82C710_TX_IDLE      0x04		/* Device XMIT Idle */
52 #define CT82C710_RESET        0x08		/* Device Reset */
53 #define CT82C710_INTS_ON      0x10		/* Device Interrupt On */
54 #define CT82C710_ERROR_FLAG   0x20		/* Device Error */
55 #define CT82C710_CLEAR        0x40		/* Device Clear */
56 #define CT82C710_ENABLE       0x80		/* Device Enable */
57 
58 #define CT82C710_IRQ          12
59 
60 #define CT82C710_DATA         ct82c710_iores.start
61 #define CT82C710_STATUS       (ct82c710_iores.start + 1)
62 
63 static struct serio *ct82c710_port;
64 static struct platform_device *ct82c710_device;
65 static struct resource ct82c710_iores;
66 
67 /*
68  * Interrupt handler for the 82C710 mouse port. A character
69  * is waiting in the 82C710.
70  */
71 
72 static irqreturn_t ct82c710_interrupt(int cpl, void *dev_id)
73 {
74 	return serio_interrupt(ct82c710_port, inb(CT82C710_DATA), 0);
75 }
76 
77 /*
78  * Wait for device to send output char and flush any input char.
79  */
80 
81 static int ct82c170_wait(void)
82 {
83 	int timeout = 60000;
84 
85 	while ((inb(CT82C710_STATUS) & (CT82C710_RX_FULL | CT82C710_TX_IDLE | CT82C710_DEV_IDLE))
86 		       != (CT82C710_DEV_IDLE | CT82C710_TX_IDLE) && timeout) {
87 
88 		if (inb_p(CT82C710_STATUS) & CT82C710_RX_FULL) inb_p(CT82C710_DATA);
89 
90 		udelay(1);
91 		timeout--;
92 	}
93 
94 	return !timeout;
95 }
96 
97 static void ct82c710_close(struct serio *serio)
98 {
99 	if (ct82c170_wait())
100 		printk(KERN_WARNING "ct82c710.c: Device busy in close()\n");
101 
102 	outb_p(inb_p(CT82C710_STATUS) & ~(CT82C710_ENABLE | CT82C710_INTS_ON), CT82C710_STATUS);
103 
104 	if (ct82c170_wait())
105 		printk(KERN_WARNING "ct82c710.c: Device busy in close()\n");
106 
107 	free_irq(CT82C710_IRQ, NULL);
108 }
109 
110 static int ct82c710_open(struct serio *serio)
111 {
112 	unsigned char status;
113 
114 	if (request_irq(CT82C710_IRQ, ct82c710_interrupt, 0, "ct82c710", NULL))
115 		return -1;
116 
117 	status = inb_p(CT82C710_STATUS);
118 
119 	status |= (CT82C710_ENABLE | CT82C710_RESET);
120 	outb_p(status, CT82C710_STATUS);
121 
122 	status &= ~(CT82C710_RESET);
123 	outb_p(status, CT82C710_STATUS);
124 
125 	status |= CT82C710_INTS_ON;
126 	outb_p(status, CT82C710_STATUS);	/* Enable interrupts */
127 
128 	while (ct82c170_wait()) {
129 		printk(KERN_ERR "ct82c710: Device busy in open()\n");
130 		status &= ~(CT82C710_ENABLE | CT82C710_INTS_ON);
131 		outb_p(status, CT82C710_STATUS);
132 		free_irq(CT82C710_IRQ, NULL);
133 		return -1;
134 	}
135 
136 	return 0;
137 }
138 
139 /*
140  * Write to the 82C710 mouse device.
141  */
142 
143 static int ct82c710_write(struct serio *port, unsigned char c)
144 {
145 	if (ct82c170_wait()) return -1;
146 	outb_p(c, CT82C710_DATA);
147 	return 0;
148 }
149 
150 /*
151  * See if we can find a 82C710 device. Read mouse address.
152  */
153 
154 static int __init ct82c710_detect(void)
155 {
156 	outb_p(0x55, 0x2fa);				/* Any value except 9, ff or 36 */
157 	outb_p(0xaa, 0x3fa);				/* Inverse of 55 */
158 	outb_p(0x36, 0x3fa);				/* Address the chip */
159 	outb_p(0xe4, 0x3fa);				/* 390/4; 390 = config address */
160 	outb_p(0x1b, 0x2fa);				/* Inverse of e4 */
161 	outb_p(0x0f, 0x390);				/* Write index */
162 	if (inb_p(0x391) != 0xe4)			/* Config address found? */
163 		return -ENODEV;				/* No: no 82C710 here */
164 
165 	outb_p(0x0d, 0x390);				/* Write index */
166 	ct82c710_iores.start = inb_p(0x391) << 2;	/* Get mouse I/O address */
167 	ct82c710_iores.end = ct82c710_iores.start + 1;
168 	ct82c710_iores.flags = IORESOURCE_IO;
169 	outb_p(0x0f, 0x390);
170 	outb_p(0x0f, 0x391);				/* Close config mode */
171 
172 	return 0;
173 }
174 
175 static int __devinit ct82c710_probe(struct platform_device *dev)
176 {
177 	ct82c710_port = kzalloc(sizeof(struct serio), GFP_KERNEL);
178 	if (!ct82c710_port)
179 		return -ENOMEM;
180 
181 	ct82c710_port->id.type = SERIO_8042;
182 	ct82c710_port->dev.parent = &dev->dev;
183 	ct82c710_port->open = ct82c710_open;
184 	ct82c710_port->close = ct82c710_close;
185 	ct82c710_port->write = ct82c710_write;
186 	strlcpy(ct82c710_port->name, "C&T 82c710 mouse port",
187 		sizeof(ct82c710_port->name));
188 	snprintf(ct82c710_port->phys, sizeof(ct82c710_port->phys),
189 		 "isa%16llx/serio0", (unsigned long long)CT82C710_DATA);
190 
191 	serio_register_port(ct82c710_port);
192 
193 	return 0;
194 }
195 
196 static int __devexit ct82c710_remove(struct platform_device *dev)
197 {
198 	serio_unregister_port(ct82c710_port);
199 
200 	return 0;
201 }
202 
203 static struct platform_driver ct82c710_driver = {
204 	.driver		= {
205 		.name	= "ct82c710",
206 		.owner	= THIS_MODULE,
207 	},
208 	.probe		= ct82c710_probe,
209 	.remove		= __devexit_p(ct82c710_remove),
210 };
211 
212 
213 static int __init ct82c710_init(void)
214 {
215 	int error;
216 
217 	error = ct82c710_detect();
218 	if (error)
219 		return error;
220 
221 	error = platform_driver_register(&ct82c710_driver);
222 	if (error)
223 		return error;
224 
225 	ct82c710_device = platform_device_alloc("ct82c710", -1);
226 	if (!ct82c710_device) {
227 		error = -ENOMEM;
228 		goto err_unregister_driver;
229 	}
230 
231 	error = platform_device_add_resources(ct82c710_device, &ct82c710_iores, 1);
232 	if (error)
233 		goto err_free_device;
234 
235 	error = platform_device_add(ct82c710_device);
236 	if (error)
237 		goto err_free_device;
238 
239 	serio_register_port(ct82c710_port);
240 
241 	printk(KERN_INFO "serio: C&T 82c710 mouse port at %#llx irq %d\n",
242 		(unsigned long long)CT82C710_DATA, CT82C710_IRQ);
243 
244 	return 0;
245 
246  err_free_device:
247 	platform_device_put(ct82c710_device);
248  err_unregister_driver:
249 	platform_driver_unregister(&ct82c710_driver);
250 	return error;
251 }
252 
253 static void __exit ct82c710_exit(void)
254 {
255 	platform_device_unregister(ct82c710_device);
256 	platform_driver_unregister(&ct82c710_driver);
257 }
258 
259 module_init(ct82c710_init);
260 module_exit(ct82c710_exit);
261