[linux-2.6-block.git] / drivers / input / joystick / spaceorb.c

/*
 *  Copyright (c) 1999-2001 Vojtech Pavlik
 *
 *  Based on the work of:
 *	David Thompson
 */

/*
 * SpaceTec SpaceOrb 360 and Avenger 6dof controller 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/kernel.h>
#include <linux/slab.h>
#include <linux/module.h>
#include <linux/input.h>
#include <linux/serio.h>

#define DRIVER_DESC	"SpaceTec SpaceOrb 360 and Avenger 6dof controller driver"

MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_LICENSE("GPL");

/*
 * Constants.
 */

#define SPACEORB_MAX_LENGTH	64

static int spaceorb_buttons[] = { BTN_TL, BTN_TR, BTN_Y, BTN_X, BTN_B, BTN_A };
static int spaceorb_axes[] = { ABS_X, ABS_Y, ABS_Z, ABS_RX, ABS_RY, ABS_RZ };

/*
 * Per-Orb data.
 */

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

static unsigned char spaceorb_xor[] = "SpaceWare";

static unsigned char *spaceorb_errors[] = { "EEPROM storing 0 failed", "Receive queue overflow", "Transmit queue timeout",
		"Bad packet", "Power brown-out", "EEPROM checksum error", "Hardware fault" };

/*
 * spaceorb_process_packet() decodes packets the driver receives from the
 * SpaceOrb.
 */

static void spaceorb_process_packet(struct spaceorb *spaceorb)
{
	struct input_dev *dev = spaceorb->dev;
	unsigned char *data = spaceorb->data;
	unsigned char c = 0;
	int axes[6];
	int i;

	if (spaceorb->idx < 2) return;
	for (i = 0; i < spaceorb->idx; i++) c ^= data[i];
	if (c) return;

	switch (data[0]) {

		case 'R':				/* Reset packet */
			spaceorb->data[spaceorb->idx - 1] = 0;
			for (i = 1; i < spaceorb->idx && spaceorb->data[i] == ' '; i++);
			printk(KERN_INFO "input: %s [%s] is %s\n",
				 dev->name, spaceorb->data + i, spaceorb->phys);
			break;

		case 'D':				/* Ball + button data */
			if (spaceorb->idx != 12) return;
			for (i = 0; i < 9; i++) spaceorb->data[i+2] ^= spaceorb_xor[i];
			axes[0] = ( data[2]	 << 3) | (data[ 3] >> 4);
			axes[1] = ((data[3] & 0x0f) << 6) | (data[ 4] >> 1);
			axes[2] = ((data[4] & 0x01) << 9) | (data[ 5] << 2) | (data[4] >> 5);
			axes[3] = ((data[6] & 0x1f) << 5) | (data[ 7] >> 2);
			axes[4] = ((data[7] & 0x03) << 8) | (data[ 8] << 1) | (data[7] >> 6);
			axes[5] = ((data[9] & 0x3f) << 4) | (data[10] >> 3);
			for (i = 0; i < 6; i++)
				input_report_abs(dev, spaceorb_axes[i], axes[i] - ((axes[i] & 0x200) ? 1024 : 0));
			for (i = 0; i < 6; i++)
				input_report_key(dev, spaceorb_buttons[i], (data[1] >> i) & 1);
			break;

		case 'K':				/* Button data */
			if (spaceorb->idx != 5) return;
			for (i = 0; i < 6; i++)
				input_report_key(dev, spaceorb_buttons[i], (data[2] >> i) & 1);

			break;

		case 'E':				/* Error packet */
			if (spaceorb->idx != 4) return;
			printk(KERN_ERR "spaceorb: Device error. [ ");
			for (i = 0; i < 7; i++) if (data[1] & (1 << i)) printk("%s ", spaceorb_errors[i]);
			printk("]\n");
			break;
	}

	input_sync(dev);
}

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

	if (~data & 0x80) {
		if (spaceorb->idx) spaceorb_process_packet(spaceorb);
		spaceorb->idx = 0;
	}
	if (spaceorb->idx < SPACEORB_MAX_LENGTH)
		spaceorb->data[spaceorb->idx++] = data & 0x7f;
	return IRQ_HANDLED;
}

/*
 * spaceorb_disconnect() is the opposite of spaceorb_connect()
 */

static void spaceorb_disconnect(struct serio *serio)
{
	struct spaceorb* spaceorb = serio_get_drvdata(serio);

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

/*
 * spaceorb_connect() is the routine that is called when someone adds a
 * new serio device that supports SpaceOrb/Avenger protocol and registers
 * it as an input device.
 */

static int spaceorb_connect(struct serio *serio, struct serio_driver *drv)
{
	struct spaceorb *spaceorb;
	struct input_dev *input_dev;
	int err = -ENOMEM;
	int i;

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

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

	input_dev->name = "SpaceTec SpaceOrb 360 / Avenger";
	input_dev->phys = spaceorb->phys;
	input_dev->id.bustype = BUS_RS232;
	input_dev->id.vendor = SERIO_SPACEORB;
	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);

	for (i = 0; i < 6; i++)
		set_bit(spaceorb_buttons[i], input_dev->keybit);

	for (i = 0; i < 6; i++)
		input_set_abs_params(input_dev, spaceorb_axes[i], -508, 508, 0, 0);

	serio_set_drvdata(serio, spaceorb);

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

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

	return 0;

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

/*
 * The serio driver structure.
 */

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

MODULE_DEVICE_TABLE(serio, spaceorb_serio_ids);

static struct serio_driver spaceorb_drv = {
	.driver		= {
		.name	= "spaceorb",
	},
	.description	= DRIVER_DESC,
	.id_table	= spaceorb_serio_ids,
	.interrupt	= spaceorb_interrupt,
	.connect	= spaceorb_connect,
	.disconnect	= spaceorb_disconnect,
};

module_serio_driver(spaceorb_drv);
Commit	Line	Data
1da177e4	1	/*
1da177e4 LT	2	* Copyright (c) 1999-2001 Vojtech Pavlik
	3	*
	4	* Based on the work of:
ab0c3443	5	* David Thompson
1da177e4 LT	6	*/
	7
	8	/*
	9	* SpaceTec SpaceOrb 360 and Avenger 6dof controller driver for Linux
	10	*/
	11
	12	/*
	13	* This program is free software; you can redistribute it and/or modify
	14	* it under the terms of the GNU General Public License as published by
	15	* the Free Software Foundation; either version 2 of the License, or
	16	* (at your option) any later version.
	17	*
	18	* This program is distributed in the hope that it will be useful,
	19	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	20	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	21	* GNU General Public License for more details.
	22	*
	23	* You should have received a copy of the GNU General Public License
	24	* along with this program; if not, write to the Free Software
	25	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	26	*
	27	* Should you need to contact me, the author, you can do so either by
	28	* e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
	29	* Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
	30	*/
	31
	32	#include <linux/kernel.h>
	33	#include <linux/slab.h>
	34	#include <linux/module.h>
1da177e4 LT	35	#include <linux/input.h>
	36	#include <linux/serio.h>
	37
	38	#define DRIVER_DESC "SpaceTec SpaceOrb 360 and Avenger 6dof controller driver"
	39
	40	MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
	41	MODULE_DESCRIPTION(DRIVER_DESC);
	42	MODULE_LICENSE("GPL");
	43
	44	/*
	45	* Constants.
	46	*/
	47
	48	#define SPACEORB_MAX_LENGTH 64
	49
	50	static int spaceorb_buttons[] = { BTN_TL, BTN_TR, BTN_Y, BTN_X, BTN_B, BTN_A };
	51	static int spaceorb_axes[] = { ABS_X, ABS_Y, ABS_Z, ABS_RX, ABS_RY, ABS_RZ };
1da177e4 LT	52
	53	/*
	54	* Per-Orb data.
	55	*/
	56
	57	struct spaceorb {
17dd3f0f	58	struct input_dev *dev;
1da177e4 LT	59	int idx;
	60	unsigned char data[SPACEORB_MAX_LENGTH];
	61	char phys[32];
	62	};
	63
	64	static unsigned char spaceorb_xor[] = "SpaceWare";
	65
	66	static unsigned char *spaceorb_errors[] = { "EEPROM storing 0 failed", "Receive queue overflow", "Transmit queue timeout",
	67	"Bad packet", "Power brown-out", "EEPROM checksum error", "Hardware fault" };
	68
	69	/*
	70	* spaceorb_process_packet() decodes packets the driver receives from the
	71	* SpaceOrb.
	72	*/
	73
7d12e780	74	static void spaceorb_process_packet(struct spaceorb *spaceorb)
1da177e4	75	{
17dd3f0f	76	struct input_dev *dev = spaceorb->dev;
1da177e4 LT	77	unsigned char *data = spaceorb->data;
	78	unsigned char c = 0;
	79	int axes[6];
	80	int i;
	81
	82	if (spaceorb->idx < 2) return;
	83	for (i = 0; i < spaceorb->idx; i++) c ^= data[i];
	84	if (c) return;
	85
1da177e4 LT	86	switch (data[0]) {
	87
	88	case 'R': /* Reset packet */
	89	spaceorb->data[spaceorb->idx - 1] = 0;
	90	for (i = 1; i < spaceorb->idx && spaceorb->data[i] == ' '; i++);
17dd3f0f DT	91	printk(KERN_INFO "input: %s [%s] is %s\n",
17dd3f0f DT	92	dev->name, spaceorb->data + i, spaceorb->phys);
1da177e4 LT	93	break;
	94
	95	case 'D': /* Ball + button data */
	96	if (spaceorb->idx != 12) return;
	97	for (i = 0; i < 9; i++) spaceorb->data[i+2] ^= spaceorb_xor[i];
	98	axes[0] = ( data[2] << 3) \| (data[ 3] >> 4);
	99	axes[1] = ((data[3] & 0x0f) << 6) \| (data[ 4] >> 1);
	100	axes[2] = ((data[4] & 0x01) << 9) \| (data[ 5] << 2) \| (data[4] >> 5);
	101	axes[3] = ((data[6] & 0x1f) << 5) \| (data[ 7] >> 2);
	102	axes[4] = ((data[7] & 0x03) << 8) \| (data[ 8] << 1) \| (data[7] >> 6);
	103	axes[5] = ((data[9] & 0x3f) << 4) \| (data[10] >> 3);
	104	for (i = 0; i < 6; i++)
	105	input_report_abs(dev, spaceorb_axes[i], axes[i] - ((axes[i] & 0x200) ? 1024 : 0));
	106	for (i = 0; i < 6; i++)
	107	input_report_key(dev, spaceorb_buttons[i], (data[1] >> i) & 1);
	108	break;
	109
	110	case 'K': /* Button data */
	111	if (spaceorb->idx != 5) return;
6c207e76	112	for (i = 0; i < 6; i++)
1da177e4 LT	113	input_report_key(dev, spaceorb_buttons[i], (data[2] >> i) & 1);
	114
	115	break;
	116
	117	case 'E': /* Error packet */
	118	if (spaceorb->idx != 4) return;
17dd3f0f	119	printk(KERN_ERR "spaceorb: Device error. [ ");
1da177e4 LT	120	for (i = 0; i < 7; i++) if (data[1] & (1 << i)) printk("%s ", spaceorb_errors[i]);
	121	printk("]\n");
	122	break;
	123	}
	124
	125	input_sync(dev);
	126	}
	127
	128	static irqreturn_t spaceorb_interrupt(struct serio *serio,
7d12e780	129	unsigned char data, unsigned int flags)
1da177e4 LT	130	{
	131	struct spaceorb* spaceorb = serio_get_drvdata(serio);
	132
	133	if (~data & 0x80) {
7d12e780	134	if (spaceorb->idx) spaceorb_process_packet(spaceorb);
1da177e4 LT	135	spaceorb->idx = 0;
	136	}
	137	if (spaceorb->idx < SPACEORB_MAX_LENGTH)
	138	spaceorb->data[spaceorb->idx++] = data & 0x7f;
	139	return IRQ_HANDLED;
	140	}
	141
	142	/*
	143	* spaceorb_disconnect() is the opposite of spaceorb_connect()
	144	*/
	145
	146	static void spaceorb_disconnect(struct serio *serio)
	147	{
	148	struct spaceorb* spaceorb = serio_get_drvdata(serio);
	149
1da177e4 LT	150	serio_close(serio);
1da177e4 LT	151	serio_set_drvdata(serio, NULL);
17dd3f0f	152	input_unregister_device(spaceorb->dev);
1da177e4 LT	153	kfree(spaceorb);
	154	}
	155
	156	/*
	157	* spaceorb_connect() is the routine that is called when someone adds a
	158	* new serio device that supports SpaceOrb/Avenger protocol and registers
	159	* it as an input device.
	160	*/
	161
	162	static int spaceorb_connect(struct serio serio, struct serio_driver drv)
	163	{
	164	struct spaceorb *spaceorb;
17dd3f0f DT	165	struct input_dev *input_dev;
	166	int err = -ENOMEM;
	167	int i;
1da177e4	168
17dd3f0f DT	169	spaceorb = kzalloc(sizeof(struct spaceorb), GFP_KERNEL);
	170	input_dev = input_allocate_device();
	171	if (!spaceorb \|\| !input_dev)
127278ce	172	goto fail1;
1da177e4	173
17dd3f0f	174	spaceorb->dev = input_dev;
10ca4c0a	175	snprintf(spaceorb->phys, sizeof(spaceorb->phys), "%s/input0", serio->phys);
1da177e4	176
17dd3f0f DT	177	input_dev->name = "SpaceTec SpaceOrb 360 / Avenger";
	178	input_dev->phys = spaceorb->phys;
	179	input_dev->id.bustype = BUS_RS232;
	180	input_dev->id.vendor = SERIO_SPACEORB;
	181	input_dev->id.product = 0x0001;
	182	input_dev->id.version = 0x0100;
935e658e	183	input_dev->dev.parent = &serio->dev;
1da177e4	184
7b19ada2	185	input_dev->evbit[0] = BIT_MASK(EV_KEY) \| BIT_MASK(EV_ABS);
1da177e4	186
17dd3f0f DT	187	for (i = 0; i < 6; i++)
17dd3f0f DT	188	set_bit(spaceorb_buttons[i], input_dev->keybit);
1da177e4	189
17dd3f0f DT	190	for (i = 0; i < 6; i++)
17dd3f0f DT	191	input_set_abs_params(input_dev, spaceorb_axes[i], -508, 508, 0, 0);
1da177e4 LT	192
	193	serio_set_drvdata(serio, spaceorb);
	194
	195	err = serio_open(serio, drv);
17dd3f0f	196	if (err)
127278ce DT	197	goto fail2;
	198
	199	err = input_register_device(spaceorb->dev);
	200	if (err)
	201	goto fail3;
1da177e4 LT	202
1da177e4 LT	203	return 0;
17dd3f0f	204
127278ce DT	205	fail3: serio_close(serio);
	206	fail2: serio_set_drvdata(serio, NULL);
	207	fail1: input_free_device(input_dev);
17dd3f0f DT	208	kfree(spaceorb);
17dd3f0f DT	209	return err;
1da177e4 LT	210	}
	211
	212	/*
	213	* The serio driver structure.
	214	*/
	215
	216	static struct serio_device_id spaceorb_serio_ids[] = {
	217	{
	218	.type = SERIO_RS232,
	219	.proto = SERIO_SPACEORB,
	220	.id = SERIO_ANY,
	221	.extra = SERIO_ANY,
	222	},
	223	{ 0 }
	224	};
	225
	226	MODULE_DEVICE_TABLE(serio, spaceorb_serio_ids);
	227
	228	static struct serio_driver spaceorb_drv = {
	229	.driver = {
	230	.name = "spaceorb",
	231	},
	232	.description = DRIVER_DESC,
	233	.id_table = spaceorb_serio_ids,
	234	.interrupt = spaceorb_interrupt,
	235	.connect = spaceorb_connect,
	236	.disconnect = spaceorb_disconnect,
	237	};
	238
65ac9f7a	239	module_serio_driver(spaceorb_drv);