[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / input / keyboard / locomokbd.c

/*
 *  Copyright (c) 2005 John Lenz
 *
 * Based on from xtkbd.c
 */

/*
 * LoCoMo keyboard driver for Linux/ARM
 */

/*
 * 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
 *
 */

#include <linux/slab.h>
#include <linux/module.h>
#include <linux/init.h>
#include <linux/input.h>
#include <linux/delay.h>
#include <linux/device.h>
#include <linux/interrupt.h>
#include <linux/ioport.h>

#include <asm/hardware/locomo.h>
#include <asm/irq.h>

MODULE_AUTHOR("John Lenz <lenz@cs.wisc.edu>");
MODULE_DESCRIPTION("LoCoMo keyboard driver");
MODULE_LICENSE("GPL");

#define LOCOMOKBD_NUMKEYS	128

#define KEY_ACTIVITY		KEY_F16
#define KEY_CONTACT		KEY_F18
#define KEY_CENTER		KEY_F15

static unsigned char locomokbd_keycode[LOCOMOKBD_NUMKEYS] = {
	0, KEY_ESC, KEY_ACTIVITY, 0, 0, 0, 0, 0, 0, 0,				/* 0 - 9 */
	0, 0, 0, 0, 0, 0, 0, KEY_MENU, KEY_HOME, KEY_CONTACT,			/* 10 - 19 */
	0, 0, 0, 0, 0, 0, 0, 0, 0, 0,						/* 20 - 29 */
	0, 0, 0, KEY_CENTER, 0, KEY_MAIL, 0, 0, 0, 0,				/* 30 - 39 */
	0, 0, 0, 0, 0, 0, 0, 0, 0, KEY_RIGHT,					/* 40 - 49 */
	KEY_UP, KEY_LEFT, 0, 0, KEY_P, 0, KEY_O, KEY_I, KEY_Y, KEY_T,		/* 50 - 59 */
	KEY_E, KEY_W, 0, 0, 0, 0, KEY_DOWN, KEY_ENTER, 0, 0,			/* 60 - 69 */
	KEY_BACKSPACE, 0, KEY_L, KEY_U, KEY_H, KEY_R, KEY_D, KEY_Q, 0, 0,	/* 70 - 79 */
	0, 0, 0, 0, 0, 0, KEY_ENTER, KEY_RIGHTSHIFT, KEY_K, KEY_J,		/* 80 - 89 */
	KEY_G, KEY_F, KEY_X, KEY_S, 0, 0, 0, 0, 0, 0,				/* 90 - 99 */
	0, 0, KEY_DOT, 0, KEY_COMMA, KEY_N, KEY_B, KEY_C, KEY_Z, KEY_A,		/* 100 - 109 */
	KEY_LEFTSHIFT, KEY_TAB, KEY_LEFTCTRL, 0, 0, 0, 0, 0, 0, 0,		/* 110 - 119 */
	KEY_M, KEY_SPACE, KEY_V, KEY_APOSTROPHE, KEY_SLASH, 0, 0, 0		/* 120 - 128 */
};

#define KB_ROWS			16
#define KB_COLS			8
#define KB_ROWMASK(r)		(1 << (r))
#define SCANCODE(c,r)		( ((c)<<4) + (r) + 1 )
#define	NR_SCANCODES		128

#define KB_DELAY		8
#define SCAN_INTERVAL		(HZ/10)
#define LOCOMOKBD_PRESSED	1

struct locomokbd {
	unsigned char keycode[LOCOMOKBD_NUMKEYS];
	struct input_dev *input;
	char phys[32];

	struct locomo_dev *ldev;
	unsigned long base;
	spinlock_t lock;

	struct timer_list timer;
};

/* helper functions for reading the keyboard matrix */
static inline void locomokbd_charge_all(unsigned long membase)
{
	locomo_writel(0x00FF, membase + LOCOMO_KSC);
}

static inline void locomokbd_activate_all(unsigned long membase)
{
	unsigned long r;

	locomo_writel(0, membase + LOCOMO_KSC);
	r = locomo_readl(membase + LOCOMO_KIC);
	r &= 0xFEFF;
	locomo_writel(r, membase + LOCOMO_KIC);
}

static inline void locomokbd_activate_col(unsigned long membase, int col)
{
	unsigned short nset;
	unsigned short nbset;

	nset = 0xFF & ~(1 << col);
	nbset = (nset << 8) + nset;
	locomo_writel(nbset, membase + LOCOMO_KSC);
}

static inline void locomokbd_reset_col(unsigned long membase, int col)
{
	unsigned short nbset;

	nbset = ((0xFF & ~(1 << col)) << 8) + 0xFF;
	locomo_writel(nbset, membase + LOCOMO_KSC);
}

/*
 * The LoCoMo keyboard only generates interrupts when a key is pressed.
 * So when a key is pressed, we enable a timer.  This timer scans the
 * keyboard, and this is how we detect when the key is released.
 */

/* Scan the hardware keyboard and push any changes up through the input layer */
static void locomokbd_scankeyboard(struct locomokbd *locomokbd)
{
	unsigned int row, col, rowd, scancode;
	unsigned long flags;
	unsigned int num_pressed;
	unsigned long membase = locomokbd->base;

	spin_lock_irqsave(&locomokbd->lock, flags);

	locomokbd_charge_all(membase);

	num_pressed = 0;
	for (col = 0; col < KB_COLS; col++) {

		locomokbd_activate_col(membase, col);
		udelay(KB_DELAY);

		rowd = ~locomo_readl(membase + LOCOMO_KIB);
		for (row = 0; row < KB_ROWS; row++) {
			scancode = SCANCODE(col, row);
			if (rowd & KB_ROWMASK(row)) {
				num_pressed += 1;
				input_report_key(locomokbd->input, locomokbd->keycode[scancode], 1);
			} else {
				input_report_key(locomokbd->input, locomokbd->keycode[scancode], 0);
			}
		}
		locomokbd_reset_col(membase, col);
	}
	locomokbd_activate_all(membase);

	input_sync(locomokbd->input);

	/* if any keys are pressed, enable the timer */
	if (num_pressed)
		mod_timer(&locomokbd->timer, jiffies + SCAN_INTERVAL);

	spin_unlock_irqrestore(&locomokbd->lock, flags);
}

/*
 * LoCoMo keyboard interrupt handler.
 */
static irqreturn_t locomokbd_interrupt(int irq, void *dev_id)
{
	struct locomokbd *locomokbd = dev_id;
	/** wait chattering delay **/
	udelay(100);

	locomokbd_scankeyboard(locomokbd);

	return IRQ_HANDLED;
}

/*
 * LoCoMo timer checking for released keys
 */
static void locomokbd_timer_callback(unsigned long data)
{
	struct locomokbd *locomokbd = (struct locomokbd *) data;
	locomokbd_scankeyboard(locomokbd, NULL);
}

static int locomokbd_probe(struct locomo_dev *dev)
{
	struct locomokbd *locomokbd;
	struct input_dev *input_dev;
	int i, ret;

	locomokbd = kzalloc(sizeof(struct locomokbd), GFP_KERNEL);
	input_dev = input_allocate_device();
	if (!locomokbd || !input_dev) {
		ret = -ENOMEM;
		goto free;
	}

	/* try and claim memory region */
	if (!request_mem_region((unsigned long) dev->mapbase,
				dev->length,
				LOCOMO_DRIVER_NAME(dev))) {
		ret = -EBUSY;
		printk(KERN_ERR "locomokbd: Can't acquire access to io memory for keyboard\n");
		goto free;
	}

	locomokbd->ldev = dev;
	locomo_set_drvdata(dev, locomokbd);

	locomokbd->base = (unsigned long) dev->mapbase;

	spin_lock_init(&locomokbd->lock);

	init_timer(&locomokbd->timer);
	locomokbd->timer.function = locomokbd_timer_callback;
	locomokbd->timer.data = (unsigned long) locomokbd;

	locomokbd->input = input_dev;
	strcpy(locomokbd->phys, "locomokbd/input0");

	input_dev->name = "LoCoMo keyboard";
	input_dev->phys = locomokbd->phys;
	input_dev->id.bustype = BUS_HOST;
	input_dev->id.vendor = 0x0001;
	input_dev->id.product = 0x0001;
	input_dev->id.version = 0x0100;
	input_dev->private = locomokbd;

	input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_REP);
	input_dev->keycode = locomokbd->keycode;
	input_dev->keycodesize = sizeof(unsigned char);
	input_dev->keycodemax = ARRAY_SIZE(locomokbd_keycode);

	memcpy(locomokbd->keycode, locomokbd_keycode, sizeof(locomokbd->keycode));
	for (i = 0; i < LOCOMOKBD_NUMKEYS; i++)
		set_bit(locomokbd->keycode[i], input_dev->keybit);
	clear_bit(0, input_dev->keybit);

	/* attempt to get the interrupt */
	ret = request_irq(dev->irq[0], locomokbd_interrupt, 0, "locomokbd", locomokbd);
	if (ret) {
		printk(KERN_ERR "locomokbd: Can't get irq for keyboard\n");
		goto out;
	}

	input_register_device(locomokbd->input);

	return 0;

out:
	release_mem_region((unsigned long) dev->mapbase, dev->length);
	locomo_set_drvdata(dev, NULL);
free:
	input_free_device(input_dev);
	kfree(locomokbd);

	return ret;
}

static int locomokbd_remove(struct locomo_dev *dev)
{
	struct locomokbd *locomokbd = locomo_get_drvdata(dev);

	free_irq(dev->irq[0], locomokbd);

	del_timer_sync(&locomokbd->timer);

	input_unregister_device(locomokbd->input);
	locomo_set_drvdata(dev, NULL);

	release_mem_region((unsigned long) dev->mapbase, dev->length);

	kfree(locomokbd);

	return 0;
}

static struct locomo_driver keyboard_driver = {
	.drv = {
		.name = "locomokbd"
	},
	.devid	= LOCOMO_DEVID_KEYBOARD,
	.probe	= locomokbd_probe,
	.remove	= locomokbd_remove,
};

static int __init locomokbd_init(void)
{
	return locomo_driver_register(&keyboard_driver);
}

static void __exit locomokbd_exit(void)
{
	locomo_driver_unregister(&keyboard_driver);
}

module_init(locomokbd_init);
module_exit(locomokbd_exit);
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Copyright (c) 2005 John Lenz
	3	*
	4	* Based on from xtkbd.c
	5	*/
	6
	7	/*
	8	* LoCoMo keyboard driver for Linux/ARM
	9	*/
	10
	11	/*
	12	* This program is free software; you can redistribute it and/or modify
	13	* it under the terms of the GNU General Public License as published by
	14	* the Free Software Foundation; either version 2 of the License, or
	15	* (at your option) any later version.
	16	*
	17	* This program is distributed in the hope that it will be useful,
	18	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	19	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	20	* GNU General Public License for more details.
	21	*
	22	* You should have received a copy of the GNU General Public License
	23	* along with this program; if not, write to the Free Software
	24	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	25	*
	26	*/
	27
1da177e4 LT	28	#include <linux/slab.h>
	29	#include <linux/module.h>
	30	#include <linux/init.h>
	31	#include <linux/input.h>
	32	#include <linux/delay.h>
	33	#include <linux/device.h>
	34	#include <linux/interrupt.h>
	35	#include <linux/ioport.h>
	36
	37	#include <asm/hardware/locomo.h>
	38	#include <asm/irq.h>
	39
	40	MODULE_AUTHOR("John Lenz <lenz@cs.wisc.edu>");
	41	MODULE_DESCRIPTION("LoCoMo keyboard driver");
	42	MODULE_LICENSE("GPL");
	43
d083e906	44	#define LOCOMOKBD_NUMKEYS 128
1da177e4 LT	45
	46	#define KEY_ACTIVITY KEY_F16
	47	#define KEY_CONTACT KEY_F18
	48	#define KEY_CENTER KEY_F15
	49
	50	static unsigned char locomokbd_keycode[LOCOMOKBD_NUMKEYS] = {
	51	0, KEY_ESC, KEY_ACTIVITY, 0, 0, 0, 0, 0, 0, 0, /* 0 - 9 */
	52	0, 0, 0, 0, 0, 0, 0, KEY_MENU, KEY_HOME, KEY_CONTACT, /* 10 - 19 */
	53	0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 20 - 29 */
	54	0, 0, 0, KEY_CENTER, 0, KEY_MAIL, 0, 0, 0, 0, /* 30 - 39 */
	55	0, 0, 0, 0, 0, 0, 0, 0, 0, KEY_RIGHT, /* 40 - 49 */
	56	KEY_UP, KEY_LEFT, 0, 0, KEY_P, 0, KEY_O, KEY_I, KEY_Y, KEY_T, /* 50 - 59 */
	57	KEY_E, KEY_W, 0, 0, 0, 0, KEY_DOWN, KEY_ENTER, 0, 0, /* 60 - 69 */
	58	KEY_BACKSPACE, 0, KEY_L, KEY_U, KEY_H, KEY_R, KEY_D, KEY_Q, 0, 0, /* 70 - 79 */
	59	0, 0, 0, 0, 0, 0, KEY_ENTER, KEY_RIGHTSHIFT, KEY_K, KEY_J, /* 80 - 89 */
	60	KEY_G, KEY_F, KEY_X, KEY_S, 0, 0, 0, 0, 0, 0, /* 90 - 99 */
	61	0, 0, KEY_DOT, 0, KEY_COMMA, KEY_N, KEY_B, KEY_C, KEY_Z, KEY_A, /* 100 - 109 */
	62	KEY_LEFTSHIFT, KEY_TAB, KEY_LEFTCTRL, 0, 0, 0, 0, 0, 0, 0, /* 110 - 119 */
d083e906	63	KEY_M, KEY_SPACE, KEY_V, KEY_APOSTROPHE, KEY_SLASH, 0, 0, 0 /* 120 - 128 */
1da177e4 LT	64	};
	65
	66	#define KB_ROWS 16
	67	#define KB_COLS 8
	68	#define KB_ROWMASK(r) (1 << (r))
	69	#define SCANCODE(c,r) ( ((c)<<4) + (r) + 1 )
	70	#define NR_SCANCODES 128
	71
	72	#define KB_DELAY 8
	73	#define SCAN_INTERVAL (HZ/10)
	74	#define LOCOMOKBD_PRESSED 1
	75
	76	struct locomokbd {
	77	unsigned char keycode[LOCOMOKBD_NUMKEYS];
438c9da5	78	struct input_dev *input;
1da177e4 LT	79	char phys[32];
	80
	81	struct locomo_dev *ldev;
	82	unsigned long base;
	83	spinlock_t lock;
d083e906	84
1da177e4 LT	85	struct timer_list timer;
	86	};
	87
	88	/* helper functions for reading the keyboard matrix */
	89	static inline void locomokbd_charge_all(unsigned long membase)
	90	{
	91	locomo_writel(0x00FF, membase + LOCOMO_KSC);
	92	}
	93
	94	static inline void locomokbd_activate_all(unsigned long membase)
	95	{
	96	unsigned long r;
d083e906	97
1da177e4 LT	98	locomo_writel(0, membase + LOCOMO_KSC);
	99	r = locomo_readl(membase + LOCOMO_KIC);
	100	r &= 0xFEFF;
	101	locomo_writel(r, membase + LOCOMO_KIC);
	102	}
	103
	104	static inline void locomokbd_activate_col(unsigned long membase, int col)
	105	{
	106	unsigned short nset;
	107	unsigned short nbset;
	108
	109	nset = 0xFF & ~(1 << col);
	110	nbset = (nset << 8) + nset;
	111	locomo_writel(nbset, membase + LOCOMO_KSC);
	112	}
	113
	114	static inline void locomokbd_reset_col(unsigned long membase, int col)
	115	{
	116	unsigned short nbset;
	117
	118	nbset = ((0xFF & ~(1 << col)) << 8) + 0xFF;
	119	locomo_writel(nbset, membase + LOCOMO_KSC);
	120	}
	121
	122	/*
	123	* The LoCoMo keyboard only generates interrupts when a key is pressed.
	124	* So when a key is pressed, we enable a timer. This timer scans the
	125	* keyboard, and this is how we detect when the key is released.
	126	*/
	127
	128	/* Scan the hardware keyboard and push any changes up through the input layer */
7d12e780	129	static void locomokbd_scankeyboard(struct locomokbd *locomokbd)
1da177e4 LT	130	{
	131	unsigned int row, col, rowd, scancode;
	132	unsigned long flags;
	133	unsigned int num_pressed;
	134	unsigned long membase = locomokbd->base;
	135
	136	spin_lock_irqsave(&locomokbd->lock, flags);
	137
1da177e4 LT	138	locomokbd_charge_all(membase);
	139
	140	num_pressed = 0;
	141	for (col = 0; col < KB_COLS; col++) {
	142
	143	locomokbd_activate_col(membase, col);
	144	udelay(KB_DELAY);
d083e906	145
1da177e4	146	rowd = ~locomo_readl(membase + LOCOMO_KIB);
d083e906	147	for (row = 0; row < KB_ROWS; row++) {
1da177e4 LT	148	scancode = SCANCODE(col, row);
	149	if (rowd & KB_ROWMASK(row)) {
	150	num_pressed += 1;
438c9da5	151	input_report_key(locomokbd->input, locomokbd->keycode[scancode], 1);
1da177e4	152	} else {
438c9da5	153	input_report_key(locomokbd->input, locomokbd->keycode[scancode], 0);
1da177e4 LT	154	}
	155	}
	156	locomokbd_reset_col(membase, col);
	157	}
	158	locomokbd_activate_all(membase);
	159
438c9da5	160	input_sync(locomokbd->input);
1da177e4 LT	161
	162	/* if any keys are pressed, enable the timer */
	163	if (num_pressed)
	164	mod_timer(&locomokbd->timer, jiffies + SCAN_INTERVAL);
	165
	166	spin_unlock_irqrestore(&locomokbd->lock, flags);
	167	}
	168
d083e906	169	/*
1da177e4 LT	170	* LoCoMo keyboard interrupt handler.
1da177e4 LT	171	*/
7d12e780	172	static irqreturn_t locomokbd_interrupt(int irq, void *dev_id)
1da177e4 LT	173	{
	174	struct locomokbd *locomokbd = dev_id;
	175	/ wait chattering delay /
	176	udelay(100);
	177
7d12e780	178	locomokbd_scankeyboard(locomokbd);
1da177e4 LT	179
	180	return IRQ_HANDLED;
	181	}
	182
	183	/*
	184	* LoCoMo timer checking for released keys
	185	*/
	186	static void locomokbd_timer_callback(unsigned long data)
	187	{
	188	struct locomokbd locomokbd = (struct locomokbd ) data;
	189	locomokbd_scankeyboard(locomokbd, NULL);
	190	}
	191
	192	static int locomokbd_probe(struct locomo_dev *dev)
	193	{
	194	struct locomokbd *locomokbd;
438c9da5	195	struct input_dev *input_dev;
1da177e4 LT	196	int i, ret;
1da177e4 LT	197
438c9da5 DT	198	locomokbd = kzalloc(sizeof(struct locomokbd), GFP_KERNEL);
	199	input_dev = input_allocate_device();
	200	if (!locomokbd \|\| !input_dev) {
	201	ret = -ENOMEM;
	202	goto free;
	203	}
1da177e4 LT	204
1da177e4 LT	205	/* try and claim memory region */
d083e906 DT	206	if (!request_mem_region((unsigned long) dev->mapbase,
d083e906 DT	207	dev->length,
1da177e4 LT	208	LOCOMO_DRIVER_NAME(dev))) {
	209	ret = -EBUSY;
	210	printk(KERN_ERR "locomokbd: Can't acquire access to io memory for keyboard\n");
	211	goto free;
	212	}
	213
	214	locomokbd->ldev = dev;
	215	locomo_set_drvdata(dev, locomokbd);
	216
	217	locomokbd->base = (unsigned long) dev->mapbase;
	218
	219	spin_lock_init(&locomokbd->lock);
	220
	221	init_timer(&locomokbd->timer);
	222	locomokbd->timer.function = locomokbd_timer_callback;
	223	locomokbd->timer.data = (unsigned long) locomokbd;
	224
438c9da5 DT	225	locomokbd->input = input_dev;
	226	strcpy(locomokbd->phys, "locomokbd/input0");
	227
	228	input_dev->name = "LoCoMo keyboard";
	229	input_dev->phys = locomokbd->phys;
d7a767dd	230	input_dev->id.bustype = BUS_HOST;
438c9da5 DT	231	input_dev->id.vendor = 0x0001;
	232	input_dev->id.product = 0x0001;
	233	input_dev->id.version = 0x0100;
	234	input_dev->private = locomokbd;
d083e906	235
438c9da5 DT	236	input_dev->evbit[0] = BIT(EV_KEY) \| BIT(EV_REP);
	237	input_dev->keycode = locomokbd->keycode;
	238	input_dev->keycodesize = sizeof(unsigned char);
	239	input_dev->keycodemax = ARRAY_SIZE(locomokbd_keycode);
1da177e4 LT	240
	241	memcpy(locomokbd->keycode, locomokbd_keycode, sizeof(locomokbd->keycode));
	242	for (i = 0; i < LOCOMOKBD_NUMKEYS; i++)
438c9da5 DT	243	set_bit(locomokbd->keycode[i], input_dev->keybit);
438c9da5 DT	244	clear_bit(0, input_dev->keybit);
1da177e4 LT	245
	246	/* attempt to get the interrupt */
	247	ret = request_irq(dev->irq[0], locomokbd_interrupt, 0, "locomokbd", locomokbd);
	248	if (ret) {
	249	printk(KERN_ERR "locomokbd: Can't get irq for keyboard\n");
	250	goto out;
	251	}
	252
438c9da5	253	input_register_device(locomokbd->input);
1da177e4 LT	254
	255	return 0;
	256
	257	out:
	258	release_mem_region((unsigned long) dev->mapbase, dev->length);
	259	locomo_set_drvdata(dev, NULL);
	260	free:
438c9da5	261	input_free_device(input_dev);
1da177e4 LT	262	kfree(locomokbd);
	263
	264	return ret;
	265	}
	266
	267	static int locomokbd_remove(struct locomo_dev *dev)
	268	{
	269	struct locomokbd *locomokbd = locomo_get_drvdata(dev);
d083e906	270
1da177e4 LT	271	free_irq(dev->irq[0], locomokbd);
	272
	273	del_timer_sync(&locomokbd->timer);
d083e906	274
438c9da5	275	input_unregister_device(locomokbd->input);
1da177e4 LT	276	locomo_set_drvdata(dev, NULL);
	277
	278	release_mem_region((unsigned long) dev->mapbase, dev->length);
	279
	280	kfree(locomokbd);
	281
	282	return 0;
	283	}
	284
	285	static struct locomo_driver keyboard_driver = {
	286	.drv = {
	287	.name = "locomokbd"
	288	},
	289	.devid = LOCOMO_DEVID_KEYBOARD,
	290	.probe = locomokbd_probe,
	291	.remove = locomokbd_remove,
	292	};
	293
	294	static int __init locomokbd_init(void)
	295	{
	296	return locomo_driver_register(&keyboard_driver);
	297	}
	298
	299	static void __exit locomokbd_exit(void)
	300	{
	301	locomo_driver_unregister(&keyboard_driver);
	302	}
	303
	304	module_init(locomokbd_init);
	305	module_exit(locomokbd_exit);