[deliverable/linux.git] / drivers / input / serio / ct82c710.c

/*
 *  Copyright (c) 1999-2001 Vojtech Pavlik
 */

/*
 *  82C710 C&T mouse port chip driver for Linux
 */

/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 * Should you need to contact me, the author, you can do so either by
 * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
 * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
 */

#include <linux/delay.h>
#include <linux/module.h>
#include <linux/ioport.h>
#include <linux/init.h>
#include <linux/interrupt.h>
#include <linux/serio.h>
#include <linux/errno.h>
#include <linux/err.h>
#include <linux/platform_device.h>
#include <linux/slab.h>

#include <asm/io.h>

MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
MODULE_DESCRIPTION("82C710 C&T mouse port chip driver");
MODULE_LICENSE("GPL");

/*
 * ct82c710 interface
 */

#define CT82C710_DEV_IDLE     0x01		/* Device Idle */
#define CT82C710_RX_FULL      0x02		/* Device Char received */
#define CT82C710_TX_IDLE      0x04		/* Device XMIT Idle */
#define CT82C710_RESET        0x08		/* Device Reset */
#define CT82C710_INTS_ON      0x10		/* Device Interrupt On */
#define CT82C710_ERROR_FLAG   0x20		/* Device Error */
#define CT82C710_CLEAR        0x40		/* Device Clear */
#define CT82C710_ENABLE       0x80		/* Device Enable */

#define CT82C710_IRQ          12

#define CT82C710_DATA         ct82c710_iores.start
#define CT82C710_STATUS       (ct82c710_iores.start + 1)

static struct serio *ct82c710_port;
static struct platform_device *ct82c710_device;
static struct resource ct82c710_iores;

/*
 * Interrupt handler for the 82C710 mouse port. A character
 * is waiting in the 82C710.
 */

static irqreturn_t ct82c710_interrupt(int cpl, void *dev_id)
{
	return serio_interrupt(ct82c710_port, inb(CT82C710_DATA), 0);
}

/*
 * Wait for device to send output char and flush any input char.
 */

static int ct82c170_wait(void)
{
	int timeout = 60000;

	while ((inb(CT82C710_STATUS) & (CT82C710_RX_FULL | CT82C710_TX_IDLE | CT82C710_DEV_IDLE))
		       != (CT82C710_DEV_IDLE | CT82C710_TX_IDLE) && timeout) {

		if (inb_p(CT82C710_STATUS) & CT82C710_RX_FULL) inb_p(CT82C710_DATA);

		udelay(1);
		timeout--;
	}

	return !timeout;
}

static void ct82c710_close(struct serio *serio)
{
	if (ct82c170_wait())
		printk(KERN_WARNING "ct82c710.c: Device busy in close()\n");

	outb_p(inb_p(CT82C710_STATUS) & ~(CT82C710_ENABLE | CT82C710_INTS_ON), CT82C710_STATUS);

	if (ct82c170_wait())
		printk(KERN_WARNING "ct82c710.c: Device busy in close()\n");

	free_irq(CT82C710_IRQ, NULL);
}

static int ct82c710_open(struct serio *serio)
{
	unsigned char status;
	int err;

	err = request_irq(CT82C710_IRQ, ct82c710_interrupt, 0, "ct82c710", NULL);
	if (err)
		return err;

	status = inb_p(CT82C710_STATUS);

	status |= (CT82C710_ENABLE | CT82C710_RESET);
	outb_p(status, CT82C710_STATUS);

	status &= ~(CT82C710_RESET);
	outb_p(status, CT82C710_STATUS);

	status |= CT82C710_INTS_ON;
	outb_p(status, CT82C710_STATUS);	/* Enable interrupts */

	while (ct82c170_wait()) {
		printk(KERN_ERR "ct82c710: Device busy in open()\n");
		status &= ~(CT82C710_ENABLE | CT82C710_INTS_ON);
		outb_p(status, CT82C710_STATUS);
		free_irq(CT82C710_IRQ, NULL);
		return -EBUSY;
	}

	return 0;
}

/*
 * Write to the 82C710 mouse device.
 */

static int ct82c710_write(struct serio *port, unsigned char c)
{
	if (ct82c170_wait()) return -1;
	outb_p(c, CT82C710_DATA);
	return 0;
}

/*
 * See if we can find a 82C710 device. Read mouse address.
 */

static int __init ct82c710_detect(void)
{
	outb_p(0x55, 0x2fa);				/* Any value except 9, ff or 36 */
	outb_p(0xaa, 0x3fa);				/* Inverse of 55 */
	outb_p(0x36, 0x3fa);				/* Address the chip */
	outb_p(0xe4, 0x3fa);				/* 390/4; 390 = config address */
	outb_p(0x1b, 0x2fa);				/* Inverse of e4 */
	outb_p(0x0f, 0x390);				/* Write index */
	if (inb_p(0x391) != 0xe4)			/* Config address found? */
		return -ENODEV;				/* No: no 82C710 here */

	outb_p(0x0d, 0x390);				/* Write index */
	ct82c710_iores.start = inb_p(0x391) << 2;	/* Get mouse I/O address */
	ct82c710_iores.end = ct82c710_iores.start + 1;
	ct82c710_iores.flags = IORESOURCE_IO;
	outb_p(0x0f, 0x390);
	outb_p(0x0f, 0x391);				/* Close config mode */

	return 0;
}

static int ct82c710_probe(struct platform_device *dev)
{
	ct82c710_port = kzalloc(sizeof(struct serio), GFP_KERNEL);
	if (!ct82c710_port)
		return -ENOMEM;

	ct82c710_port->id.type = SERIO_8042;
	ct82c710_port->dev.parent = &dev->dev;
	ct82c710_port->open = ct82c710_open;
	ct82c710_port->close = ct82c710_close;
	ct82c710_port->write = ct82c710_write;
	strlcpy(ct82c710_port->name, "C&T 82c710 mouse port",
		sizeof(ct82c710_port->name));
	snprintf(ct82c710_port->phys, sizeof(ct82c710_port->phys),
		 "isa%16llx/serio0", (unsigned long long)CT82C710_DATA);

	serio_register_port(ct82c710_port);

	printk(KERN_INFO "serio: C&T 82c710 mouse port at %#llx irq %d\n",
		(unsigned long long)CT82C710_DATA, CT82C710_IRQ);

	return 0;
}

static int ct82c710_remove(struct platform_device *dev)
{
	serio_unregister_port(ct82c710_port);

	return 0;
}

static struct platform_driver ct82c710_driver = {
	.driver		= {
		.name	= "ct82c710",
	},
	.probe		= ct82c710_probe,
	.remove		= ct82c710_remove,
};


static int __init ct82c710_init(void)
{
	int error;

	error = ct82c710_detect();
	if (error)
		return error;

	error = platform_driver_register(&ct82c710_driver);
	if (error)
		return error;

	ct82c710_device = platform_device_alloc("ct82c710", -1);
	if (!ct82c710_device) {
		error = -ENOMEM;
		goto err_unregister_driver;
	}

	error = platform_device_add_resources(ct82c710_device, &ct82c710_iores, 1);
	if (error)
		goto err_free_device;

	error = platform_device_add(ct82c710_device);
	if (error)
		goto err_free_device;

	return 0;

 err_free_device:
	platform_device_put(ct82c710_device);
 err_unregister_driver:
	platform_driver_unregister(&ct82c710_driver);
	return error;
}

static void __exit ct82c710_exit(void)
{
	platform_device_unregister(ct82c710_device);
	platform_driver_unregister(&ct82c710_driver);
}

module_init(ct82c710_init);
module_exit(ct82c710_exit);
Commit	Line	Data
1da177e4	1	/*
1da177e4 LT	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>
1da177e4 LT	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>
d052d1be	37	#include <linux/platform_device.h>
5a0e3ad6	38	#include <linux/slab.h>
1da177e4 LT	39
	40	#include <asm/io.h>
	41
	42	MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
	43	MODULE_DESCRIPTION("82C710 C&T mouse port chip driver");
	44	MODULE_LICENSE("GPL");
	45
	46	/*
	47	* ct82c710 interface
	48	*/
	49
	50	#define CT82C710_DEV_IDLE 0x01 /* Device Idle */
	51	#define CT82C710_RX_FULL 0x02 /* Device Char received */
	52	#define CT82C710_TX_IDLE 0x04 /* Device XMIT Idle */
	53	#define CT82C710_RESET 0x08 /* Device Reset */
	54	#define CT82C710_INTS_ON 0x10 /* Device Interrupt On */
	55	#define CT82C710_ERROR_FLAG 0x20 /* Device Error */
	56	#define CT82C710_CLEAR 0x40 /* Device Clear */
	57	#define CT82C710_ENABLE 0x80 /* Device Enable */
	58
	59	#define CT82C710_IRQ 12
	60
	61	#define CT82C710_DATA ct82c710_iores.start
	62	#define CT82C710_STATUS (ct82c710_iores.start + 1)
	63
	64	static struct serio *ct82c710_port;
	65	static struct platform_device *ct82c710_device;
	66	static struct resource ct82c710_iores;
	67
	68	/*
	69	* Interrupt handler for the 82C710 mouse port. A character
	70	* is waiting in the 82C710.
	71	*/
	72
7d12e780	73	static irqreturn_t ct82c710_interrupt(int cpl, void *dev_id)
1da177e4	74	{
7d12e780	75	return serio_interrupt(ct82c710_port, inb(CT82C710_DATA), 0);
1da177e4 LT	76	}
	77
	78	/*
	79	* Wait for device to send output char and flush any input char.
	80	*/
	81
	82	static int ct82c170_wait(void)
	83	{
	84	int timeout = 60000;
	85
	86	while ((inb(CT82C710_STATUS) & (CT82C710_RX_FULL \| CT82C710_TX_IDLE \| CT82C710_DEV_IDLE))
	87	!= (CT82C710_DEV_IDLE \| CT82C710_TX_IDLE) && timeout) {
	88
	89	if (inb_p(CT82C710_STATUS) & CT82C710_RX_FULL) inb_p(CT82C710_DATA);
	90
	91	udelay(1);
	92	timeout--;
	93	}
	94
	95	return !timeout;
	96	}
	97
	98	static void ct82c710_close(struct serio *serio)
	99	{
	100	if (ct82c170_wait())
	101	printk(KERN_WARNING "ct82c710.c: Device busy in close()\n");
	102
	103	outb_p(inb_p(CT82C710_STATUS) & ~(CT82C710_ENABLE \| CT82C710_INTS_ON), CT82C710_STATUS);
	104
	105	if (ct82c170_wait())
	106	printk(KERN_WARNING "ct82c710.c: Device busy in close()\n");
	107
	108	free_irq(CT82C710_IRQ, NULL);
	109	}
	110
	111	static int ct82c710_open(struct serio *serio)
	112	{
	113	unsigned char status;
b0f05aad	114	int err;
1da177e4	115
b0f05aad DB	116	err = request_irq(CT82C710_IRQ, ct82c710_interrupt, 0, "ct82c710", NULL);
	117	if (err)
	118	return err;
1da177e4 LT	119
	120	status = inb_p(CT82C710_STATUS);
	121
	122	status \|= (CT82C710_ENABLE \| CT82C710_RESET);
	123	outb_p(status, CT82C710_STATUS);
	124
	125	status &= ~(CT82C710_RESET);
	126	outb_p(status, CT82C710_STATUS);
	127
	128	status \|= CT82C710_INTS_ON;
	129	outb_p(status, CT82C710_STATUS); /* Enable interrupts */
	130
	131	while (ct82c170_wait()) {
	132	printk(KERN_ERR "ct82c710: Device busy in open()\n");
	133	status &= ~(CT82C710_ENABLE \| CT82C710_INTS_ON);
	134	outb_p(status, CT82C710_STATUS);
	135	free_irq(CT82C710_IRQ, NULL);
b0f05aad	136	return -EBUSY;
1da177e4 LT	137	}
	138
	139	return 0;
	140	}
	141
	142	/*
	143	* Write to the 82C710 mouse device.
	144	*/
	145
	146	static int ct82c710_write(struct serio *port, unsigned char c)
	147	{
	148	if (ct82c170_wait()) return -1;
	149	outb_p(c, CT82C710_DATA);
	150	return 0;
	151	}
	152
	153	/*
	154	* See if we can find a 82C710 device. Read mouse address.
	155	*/
	156
916d83cf	157	static int __init ct82c710_detect(void)
1da177e4 LT	158	{
	159	outb_p(0x55, 0x2fa); /* Any value except 9, ff or 36 */
	160	outb_p(0xaa, 0x3fa); /* Inverse of 55 */
	161	outb_p(0x36, 0x3fa); /* Address the chip */
	162	outb_p(0xe4, 0x3fa); /* 390/4; 390 = config address */
	163	outb_p(0x1b, 0x2fa); /* Inverse of e4 */
	164	outb_p(0x0f, 0x390); /* Write index */
	165	if (inb_p(0x391) != 0xe4) /* Config address found? */
916d83cf	166	return -ENODEV; /* No: no 82C710 here */
1da177e4 LT	167
	168	outb_p(0x0d, 0x390); /* Write index */
	169	ct82c710_iores.start = inb_p(0x391) << 2; /* Get mouse I/O address */
	170	ct82c710_iores.end = ct82c710_iores.start + 1;
	171	ct82c710_iores.flags = IORESOURCE_IO;
	172	outb_p(0x0f, 0x390);
	173	outb_p(0x0f, 0x391); /* Close config mode */
	174
	175	return 0;
	176	}
	177
5298cc4c	178	static int ct82c710_probe(struct platform_device *dev)
1da177e4	179	{
916d83cf DT	180	ct82c710_port = kzalloc(sizeof(struct serio), GFP_KERNEL);
	181	if (!ct82c710_port)
	182	return -ENOMEM;
	183
	184	ct82c710_port->id.type = SERIO_8042;
	185	ct82c710_port->dev.parent = &dev->dev;
	186	ct82c710_port->open = ct82c710_open;
	187	ct82c710_port->close = ct82c710_close;
	188	ct82c710_port->write = ct82c710_write;
	189	strlcpy(ct82c710_port->name, "C&T 82c710 mouse port",
	190	sizeof(ct82c710_port->name));
	191	snprintf(ct82c710_port->phys, sizeof(ct82c710_port->phys),
e29419ff	192	"isa%16llx/serio0", (unsigned long long)CT82C710_DATA);
916d83cf DT	193
	194	serio_register_port(ct82c710_port);
	195
f09830ab AL	196	printk(KERN_INFO "serio: C&T 82c710 mouse port at %#llx irq %d\n",
	197	(unsigned long long)CT82C710_DATA, CT82C710_IRQ);
	198
916d83cf DT	199	return 0;
	200	}
	201
e2619cf7	202	static int ct82c710_remove(struct platform_device *dev)
916d83cf DT	203	{
916d83cf DT	204	serio_unregister_port(ct82c710_port);
1da177e4	205
916d83cf	206	return 0;
1da177e4 LT	207	}
1da177e4 LT	208
916d83cf DT	209	static struct platform_driver ct82c710_driver = {
	210	.driver = {
	211	.name = "ct82c710",
916d83cf DT	212	},
916d83cf DT	213	.probe = ct82c710_probe,
1cb0aa88	214	.remove = ct82c710_remove,
916d83cf DT	215	};
	216
	217
1da177e4 LT	218	static int __init ct82c710_init(void)
1da177e4 LT	219	{
916d83cf	220	int error;
1da177e4	221
916d83cf DT	222	error = ct82c710_detect();
	223	if (error)
	224	return error;
1da177e4	225
916d83cf DT	226	error = platform_driver_register(&ct82c710_driver);
	227	if (error)
	228	return error;
	229
	230	ct82c710_device = platform_device_alloc("ct82c710", -1);
	231	if (!ct82c710_device) {
	232	error = -ENOMEM;
	233	goto err_unregister_driver;
1da177e4 LT	234	}
1da177e4 LT	235
916d83cf DT	236	error = platform_device_add_resources(ct82c710_device, &ct82c710_iores, 1);
	237	if (error)
	238	goto err_free_device;
	239
	240	error = platform_device_add(ct82c710_device);
	241	if (error)
	242	goto err_free_device;
	243
1da177e4	244	return 0;
916d83cf DT	245
	246	err_free_device:
	247	platform_device_put(ct82c710_device);
	248	err_unregister_driver:
	249	platform_driver_unregister(&ct82c710_driver);
	250	return error;
1da177e4 LT	251	}
	252
	253	static void __exit ct82c710_exit(void)
	254	{
1da177e4	255	platform_device_unregister(ct82c710_device);
916d83cf	256	platform_driver_unregister(&ct82c710_driver);
1da177e4 LT	257	}
	258
	259	module_init(ct82c710_init);
	260	module_exit(ct82c710_exit);