[deliverable/linux.git] / drivers / input / joystick / twidjoy.c

/*
 *  Copyright (c) 2001 Arndt Schoenewald
 *  Copyright (c) 2000-2001 Vojtech Pavlik
 *  Copyright (c) 2000 Mark Fletcher
 *
 *  Sponsored by Quelltext AG (http://www.quelltext-ag.de), Dortmund, Germany
 */

/*
 * Driver to use Handykey's Twiddler (the first edition, i.e. the one with
 * the RS232 interface) as a joystick under Linux
 *
 * The Twiddler is a one-handed chording keyboard featuring twelve buttons on
 * the front, six buttons on the top, and a built-in tilt sensor. The buttons
 * on the front, which are grouped as four rows of three buttons, are pressed
 * by the four fingers (this implies only one button per row can be held down
 * at the same time) and the buttons on the top are for the thumb. The tilt
 * sensor delivers X and Y axis data depending on how the Twiddler is held.
 * Additional information can be found at http://www.handykey.com.
 *
 * This driver does not use the Twiddler for its intended purpose, i.e. as
 * a chording keyboard, but as a joystick: pressing and releasing a button
 * immediately sends a corresponding button event, and tilting it generates
 * corresponding ABS_X and ABS_Y events. This turns the Twiddler into a game
 * controller with amazing 18 buttons :-)
 *
 * Note: The Twiddler2 (the successor of the Twiddler that connects directly
 * to the PS/2 keyboard and mouse ports) is NOT supported by this driver!
 *
 * For questions or feedback regarding this driver module please contact:
 * Arndt Schoenewald <arndt@quelltext.com>
 */

/*
 * 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/kernel.h>
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/input.h>
#include <linux/serio.h>
#include <linux/init.h>

#define DRIVER_DESC	"Handykey Twiddler keyboard as a joystick driver"

MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_LICENSE("GPL");

/*
 * Constants.
 */

#define TWIDJOY_MAX_LENGTH 5

static struct twidjoy_button_spec {
	int bitshift;
	int bitmask;
	int buttons[3];
}
twidjoy_buttons[] = {
	{  0, 3, { BTN_A,      BTN_B,     BTN_C    } },
	{  2, 3, { BTN_X,      BTN_Y,     BTN_Z    } },
	{  4, 3, { BTN_TL,     BTN_TR,    BTN_TR2  } },
	{  6, 3, { BTN_SELECT, BTN_START, BTN_MODE } },
	{  8, 1, { BTN_BASE5                       } },
	{  9, 1, { BTN_BASE                        } },
	{ 10, 1, { BTN_BASE3                       } },
	{ 11, 1, { BTN_BASE4                       } },
	{ 12, 1, { BTN_BASE2                       } },
	{ 13, 1, { BTN_BASE6                       } },
	{ 0,  0, { 0                               } }
};

/*
 * Per-Twiddler data.
 */

struct twidjoy {
	struct input_dev *dev;
	int idx;
	unsigned char data[TWIDJOY_MAX_LENGTH];
	char phys[32];
};

/*
 * twidjoy_process_packet() decodes packets the driver receives from the
 * Twiddler. It updates the data accordingly.
 */

static void twidjoy_process_packet(struct twidjoy *twidjoy)
{
	struct input_dev *dev = twidjoy->dev;
	unsigned char *data = twidjoy->data;
	struct twidjoy_button_spec *bp;
	int button_bits, abs_x, abs_y;

	button_bits = ((data[1] & 0x7f) << 7) | (data[0] & 0x7f);

	for (bp = twidjoy_buttons; bp->bitmask; bp++) {
		int value = (button_bits & (bp->bitmask << bp->bitshift)) >> bp->bitshift;
		int i;

		for (i = 0; i < bp->bitmask; i++)
			input_report_key(dev, bp->buttons[i], i+1 == value);
	}

	abs_x = ((data[4] & 0x07) << 5) | ((data[3] & 0x7C) >> 2);
	if (data[4] & 0x08) abs_x -= 256;

	abs_y = ((data[3] & 0x01) << 7) | ((data[2] & 0x7F) >> 0);
	if (data[3] & 0x02) abs_y -= 256;

	input_report_abs(dev, ABS_X, -abs_x);
	input_report_abs(dev, ABS_Y, +abs_y);

	input_sync(dev);
}

/*
 * twidjoy_interrupt() is called by the low level driver when characters
 * are ready for us. We then buffer them for further processing, or call the
 * packet processing routine.
 */

static irqreturn_t twidjoy_interrupt(struct serio *serio, unsigned char data, unsigned int flags)
{
	struct twidjoy *twidjoy = serio_get_drvdata(serio);

	/* All Twiddler packets are 5 bytes. The fact that the first byte
	 * has a MSB of 0 and all other bytes have a MSB of 1 can be used
	 * to check and regain sync. */

	if ((data & 0x80) == 0)
		twidjoy->idx = 0;	/* this byte starts a new packet */
	else if (twidjoy->idx == 0)
		return IRQ_HANDLED;	/* wrong MSB -- ignore this byte */

	if (twidjoy->idx < TWIDJOY_MAX_LENGTH)
		twidjoy->data[twidjoy->idx++] = data;

	if (twidjoy->idx == TWIDJOY_MAX_LENGTH) {
		twidjoy_process_packet(twidjoy);
		twidjoy->idx = 0;
	}

	return IRQ_HANDLED;
}

/*
 * twidjoy_disconnect() is the opposite of twidjoy_connect()
 */

static void twidjoy_disconnect(struct serio *serio)
{
	struct twidjoy *twidjoy = serio_get_drvdata(serio);

	serio_close(serio);
	serio_set_drvdata(serio, NULL);
	input_unregister_device(twidjoy->dev);
	kfree(twidjoy);
}

/*
 * twidjoy_connect() is the routine that is called when someone adds a
 * new serio device. It looks for the Twiddler, and if found, registers
 * it as an input device.
 */

static int twidjoy_connect(struct serio *serio, struct serio_driver *drv)
{
	struct twidjoy_button_spec *bp;
	struct twidjoy *twidjoy;
	struct input_dev *input_dev;
	int err = -ENOMEM;
	int i;

	twidjoy = kzalloc(sizeof(struct twidjoy), GFP_KERNEL);
	input_dev = input_allocate_device();
	if (!twidjoy || !input_dev)
		goto fail1;

	twidjoy->dev = input_dev;
	snprintf(twidjoy->phys, sizeof(twidjoy->phys), "%s/input0", serio->phys);

	input_dev->name = "Handykey Twiddler";
	input_dev->phys = twidjoy->phys;
	input_dev->id.bustype = BUS_RS232;
	input_dev->id.vendor = SERIO_TWIDJOY;
	input_dev->id.product = 0x0001;
	input_dev->id.version = 0x0100;
	input_dev->dev.parent = &serio->dev;

	input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
	input_set_abs_params(input_dev, ABS_X, -50, 50, 4, 4);
	input_set_abs_params(input_dev, ABS_Y, -50, 50, 4, 4);

	for (bp = twidjoy_buttons; bp->bitmask; bp++)
		for (i = 0; i < bp->bitmask; i++)
			set_bit(bp->buttons[i], input_dev->keybit);

	serio_set_drvdata(serio, twidjoy);

	err = serio_open(serio, drv);
	if (err)
		goto fail2;

	err = input_register_device(twidjoy->dev);
	if (err)
		goto fail3;

	return 0;

 fail3:	serio_close(serio);
 fail2:	serio_set_drvdata(serio, NULL);
 fail1:	input_free_device(input_dev);
	kfree(twidjoy);
	return err;
}

/*
 * The serio driver structure.
 */

static struct serio_device_id twidjoy_serio_ids[] = {
	{
		.type	= SERIO_RS232,
		.proto	= SERIO_TWIDJOY,
		.id	= SERIO_ANY,
		.extra	= SERIO_ANY,
	},
	{ 0 }
};

MODULE_DEVICE_TABLE(serio, twidjoy_serio_ids);

static struct serio_driver twidjoy_drv = {
	.driver		= {
		.name	= "twidjoy",
	},
	.description	= DRIVER_DESC,
	.id_table	= twidjoy_serio_ids,
	.interrupt	= twidjoy_interrupt,
	.connect	= twidjoy_connect,
	.disconnect	= twidjoy_disconnect,
};

/*
 * The functions for inserting/removing us as a module.
 */

static int __init twidjoy_init(void)
{
	return serio_register_driver(&twidjoy_drv);
}

static void __exit twidjoy_exit(void)
{
	serio_unregister_driver(&twidjoy_drv);
}

module_init(twidjoy_init);
module_exit(twidjoy_exit);
Commit	Line	Data
1da177e4	1	/*
1da177e4 LT	2	* Copyright (c) 2001 Arndt Schoenewald
	3	* Copyright (c) 2000-2001 Vojtech Pavlik
	4	* Copyright (c) 2000 Mark Fletcher
	5	*
	6	* Sponsored by Quelltext AG (http://www.quelltext-ag.de), Dortmund, Germany
	7	*/
	8
	9	/*
	10	* Driver to use Handykey's Twiddler (the first edition, i.e. the one with
	11	* the RS232 interface) as a joystick under Linux
	12	*
	13	* The Twiddler is a one-handed chording keyboard featuring twelve buttons on
	14	* the front, six buttons on the top, and a built-in tilt sensor. The buttons
	15	* on the front, which are grouped as four rows of three buttons, are pressed
	16	* by the four fingers (this implies only one button per row can be held down
	17	* at the same time) and the buttons on the top are for the thumb. The tilt
	18	* sensor delivers X and Y axis data depending on how the Twiddler is held.
	19	* Additional information can be found at http://www.handykey.com.
	20	*
	21	* This driver does not use the Twiddler for its intended purpose, i.e. as
	22	* a chording keyboard, but as a joystick: pressing and releasing a button
	23	* immediately sends a corresponding button event, and tilting it generates
	24	* corresponding ABS_X and ABS_Y events. This turns the Twiddler into a game
	25	* controller with amazing 18 buttons :-)
	26	*
	27	* Note: The Twiddler2 (the successor of the Twiddler that connects directly
	28	* to the PS/2 keyboard and mouse ports) is NOT supported by this driver!
	29	*
	30	* For questions or feedback regarding this driver module please contact:
	31	* Arndt Schoenewald <arndt@quelltext.com>
	32	*/
	33
	34	/*
	35	* This program is free software; you can redistribute it and/or modify
	36	* it under the terms of the GNU General Public License as published by
	37	* the Free Software Foundation; either version 2 of the License, or
	38	* (at your option) any later version.
	39	*
	40	* This program is distributed in the hope that it will be useful,
	41	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	42	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	43	* GNU General Public License for more details.
	44	*
	45	* You should have received a copy of the GNU General Public License
	46	* along with this program; if not, write to the Free Software
	47	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	48	*/
	49
	50	#include <linux/kernel.h>
	51	#include <linux/module.h>
	52	#include <linux/slab.h>
	53	#include <linux/input.h>
	54	#include <linux/serio.h>
	55	#include <linux/init.h>
	56
	57	#define DRIVER_DESC "Handykey Twiddler keyboard as a joystick driver"
	58
	59	MODULE_DESCRIPTION(DRIVER_DESC);
	60	MODULE_LICENSE("GPL");
	61
	62	/*
	63	* Constants.
	64	*/
	65
66	#define TWIDJOY_MAX_LENGTH 5
67
1da177e4 LT	68	static struct twidjoy_button_spec {
	69	int bitshift;
	70	int bitmask;
	71	int buttons[3];
	72	}
	73	twidjoy_buttons[] = {
	74	{ 0, 3, { BTN_A, BTN_B, BTN_C } },
	75	{ 2, 3, { BTN_X, BTN_Y, BTN_Z } },
	76	{ 4, 3, { BTN_TL, BTN_TR, BTN_TR2 } },
	77	{ 6, 3, { BTN_SELECT, BTN_START, BTN_MODE } },
	78	{ 8, 1, { BTN_BASE5 } },
	79	{ 9, 1, { BTN_BASE } },
	80	{ 10, 1, { BTN_BASE3 } },
	81	{ 11, 1, { BTN_BASE4 } },
	82	{ 12, 1, { BTN_BASE2 } },
	83	{ 13, 1, { BTN_BASE6 } },
	84	{ 0, 0, { 0 } }
	85	};
	86
	87	/*
	88	* Per-Twiddler data.
	89	*/
	90
	91	struct twidjoy {
17dd3f0f	92	struct input_dev *dev;
1da177e4 LT	93	int idx;
	94	unsigned char data[TWIDJOY_MAX_LENGTH];
	95	char phys[32];
	96	};
	97
	98	/*
	99	* twidjoy_process_packet() decodes packets the driver receives from the
	100	* Twiddler. It updates the data accordingly.
	101	*/
	102
7d12e780	103	static void twidjoy_process_packet(struct twidjoy *twidjoy)
1da177e4	104	{
17dd3f0f DT	105	struct input_dev *dev = twidjoy->dev;
	106	unsigned char *data = twidjoy->data;
	107	struct twidjoy_button_spec *bp;
	108	int button_bits, abs_x, abs_y;
1da177e4	109
17dd3f0f	110	button_bits = ((data[1] & 0x7f) << 7) \| (data[0] & 0x7f);
1da177e4	111
17dd3f0f DT	112	for (bp = twidjoy_buttons; bp->bitmask; bp++) {
	113	int value = (button_bits & (bp->bitmask << bp->bitshift)) >> bp->bitshift;
	114	int i;
1da177e4	115
17dd3f0f DT	116	for (i = 0; i < bp->bitmask; i++)
	117	input_report_key(dev, bp->buttons[i], i+1 == value);
	118	}
1da177e4	119
17dd3f0f DT	120	abs_x = ((data[4] & 0x07) << 5) \| ((data[3] & 0x7C) >> 2);
17dd3f0f DT	121	if (data[4] & 0x08) abs_x -= 256;
1da177e4	122
17dd3f0f DT	123	abs_y = ((data[3] & 0x01) << 7) \| ((data[2] & 0x7F) >> 0);
17dd3f0f DT	124	if (data[3] & 0x02) abs_y -= 256;
1da177e4	125
17dd3f0f DT	126	input_report_abs(dev, ABS_X, -abs_x);
17dd3f0f DT	127	input_report_abs(dev, ABS_Y, +abs_y);
1da177e4	128
17dd3f0f	129	input_sync(dev);
1da177e4 LT	130	}
	131
	132	/*
	133	* twidjoy_interrupt() is called by the low level driver when characters
	134	* are ready for us. We then buffer them for further processing, or call the
	135	* packet processing routine.
	136	*/
	137
7d12e780	138	static irqreturn_t twidjoy_interrupt(struct serio *serio, unsigned char data, unsigned int flags)
1da177e4 LT	139	{
	140	struct twidjoy *twidjoy = serio_get_drvdata(serio);
	141
	142	/* All Twiddler packets are 5 bytes. The fact that the first byte
	143	* has a MSB of 0 and all other bytes have a MSB of 1 can be used
	144	* to check and regain sync. */
	145
	146	if ((data & 0x80) == 0)
	147	twidjoy->idx = 0; /* this byte starts a new packet */
	148	else if (twidjoy->idx == 0)
	149	return IRQ_HANDLED; /* wrong MSB -- ignore this byte */
	150
	151	if (twidjoy->idx < TWIDJOY_MAX_LENGTH)
	152	twidjoy->data[twidjoy->idx++] = data;
	153
	154	if (twidjoy->idx == TWIDJOY_MAX_LENGTH) {
7d12e780	155	twidjoy_process_packet(twidjoy);
1da177e4 LT	156	twidjoy->idx = 0;
	157	}
	158
	159	return IRQ_HANDLED;
	160	}
	161
	162	/*
	163	* twidjoy_disconnect() is the opposite of twidjoy_connect()
	164	*/
	165
	166	static void twidjoy_disconnect(struct serio *serio)
	167	{
	168	struct twidjoy *twidjoy = serio_get_drvdata(serio);
	169
1da177e4 LT	170	serio_close(serio);
1da177e4 LT	171	serio_set_drvdata(serio, NULL);
17dd3f0f	172	input_unregister_device(twidjoy->dev);
1da177e4 LT	173	kfree(twidjoy);
	174	}
	175
	176	/*
	177	* twidjoy_connect() is the routine that is called when someone adds a
	178	* new serio device. It looks for the Twiddler, and if found, registers
	179	* it as an input device.
	180	*/
	181
	182	static int twidjoy_connect(struct serio serio, struct serio_driver drv)
	183	{
	184	struct twidjoy_button_spec *bp;
	185	struct twidjoy *twidjoy;
17dd3f0f DT	186	struct input_dev *input_dev;
17dd3f0f DT	187	int err = -ENOMEM;
1da177e4	188	int i;
1da177e4	189
17dd3f0f DT	190	twidjoy = kzalloc(sizeof(struct twidjoy), GFP_KERNEL);
	191	input_dev = input_allocate_device();
	192	if (!twidjoy \|\| !input_dev)
127278ce	193	goto fail1;
1da177e4	194
17dd3f0f	195	twidjoy->dev = input_dev;
10ca4c0a	196	snprintf(twidjoy->phys, sizeof(twidjoy->phys), "%s/input0", serio->phys);
1da177e4	197
17dd3f0f DT	198	input_dev->name = "Handykey Twiddler";
	199	input_dev->phys = twidjoy->phys;
	200	input_dev->id.bustype = BUS_RS232;
	201	input_dev->id.vendor = SERIO_TWIDJOY;
	202	input_dev->id.product = 0x0001;
	203	input_dev->id.version = 0x0100;
935e658e	204	input_dev->dev.parent = &serio->dev;
17dd3f0f	205
7b19ada2	206	input_dev->evbit[0] = BIT_MASK(EV_KEY) \| BIT_MASK(EV_ABS);
17dd3f0f DT	207	input_set_abs_params(input_dev, ABS_X, -50, 50, 4, 4);
	208	input_set_abs_params(input_dev, ABS_Y, -50, 50, 4, 4);
	209
	210	for (bp = twidjoy_buttons; bp->bitmask; bp++)
1da177e4	211	for (i = 0; i < bp->bitmask; i++)
17dd3f0f	212	set_bit(bp->buttons[i], input_dev->keybit);
1da177e4 LT	213
	214	serio_set_drvdata(serio, twidjoy);
	215
	216	err = serio_open(serio, drv);
17dd3f0f	217	if (err)
127278ce DT	218	goto fail2;
	219
	220	err = input_register_device(twidjoy->dev);
	221	if (err)
	222	goto fail3;
1da177e4 LT	223
1da177e4 LT	224	return 0;
17dd3f0f	225
127278ce DT	226	fail3: serio_close(serio);
	227	fail2: serio_set_drvdata(serio, NULL);
	228	fail1: input_free_device(input_dev);
17dd3f0f DT	229	kfree(twidjoy);
17dd3f0f DT	230	return err;
1da177e4 LT	231	}
	232
	233	/*
	234	* The serio driver structure.
	235	*/
	236
	237	static struct serio_device_id twidjoy_serio_ids[] = {
	238	{
	239	.type = SERIO_RS232,
	240	.proto = SERIO_TWIDJOY,
	241	.id = SERIO_ANY,
	242	.extra = SERIO_ANY,
	243	},
	244	{ 0 }
	245	};
	246
	247	MODULE_DEVICE_TABLE(serio, twidjoy_serio_ids);
	248
	249	static struct serio_driver twidjoy_drv = {
	250	.driver = {
	251	.name = "twidjoy",
	252	},
	253	.description = DRIVER_DESC,
	254	.id_table = twidjoy_serio_ids,
	255	.interrupt = twidjoy_interrupt,
	256	.connect = twidjoy_connect,
	257	.disconnect = twidjoy_disconnect,
	258	};
	259
	260	/*
	261	* The functions for inserting/removing us as a module.
	262	*/
	263
ffc6b529	264	static int __init twidjoy_init(void)
1da177e4	265	{
153a9df0	266	return serio_register_driver(&twidjoy_drv);
1da177e4 LT	267	}
1da177e4 LT	268
ffc6b529	269	static void __exit twidjoy_exit(void)
1da177e4 LT	270	{
	271	serio_unregister_driver(&twidjoy_drv);
	272	}
	273
	274	module_init(twidjoy_init);
	275	module_exit(twidjoy_exit);