1/*
2 * $Id: warrior.c,v 1.1.1.1 2007/08/03 18:52:33 Exp $
3 *
4 *  Copyright (c) 1999-2001 Vojtech Pavlik
5 */
6
7/*
8 * Logitech WingMan Warrior joystick driver for Linux
9 */
10
11/*
12 * This program is free warftware; 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 *  Should you need to contact me, the author, you can do so either by
27 * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
28 * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
29 */
30
31#include <linux/kernel.h>
32#include <linux/module.h>
33#include <linux/slab.h>
34#include <linux/input.h>
35#include <linux/serio.h>
36#include <linux/init.h>
37
38#define DRIVER_DESC	"Logitech WingMan Warrior joystick driver"
39
40MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
41MODULE_DESCRIPTION(DRIVER_DESC);
42MODULE_LICENSE("GPL");
43
44/*
45 * Constants.
46 */
47
48#define WARRIOR_MAX_LENGTH	16
49static char warrior_lengths[] = { 0, 4, 12, 3, 4, 4, 0, 0 };
50
51/*
52 * Per-Warrior data.
53 */
54
55struct warrior {
56	struct input_dev *dev;
57	int idx, len;
58	unsigned char data[WARRIOR_MAX_LENGTH];
59	char phys[32];
60};
61
62/*
63 * warrior_process_packet() decodes packets the driver receives from the
64 * Warrior. It updates the data accordingly.
65 */
66
67static void warrior_process_packet(struct warrior *warrior)
68{
69	struct input_dev *dev = warrior->dev;
70	unsigned char *data = warrior->data;
71
72	if (!warrior->idx) return;
73
74	switch ((data[0] >> 4) & 7) {
75		case 1:					/* Button data */
76			input_report_key(dev, BTN_TRIGGER,  data[3]       & 1);
77			input_report_key(dev, BTN_THUMB,   (data[3] >> 1) & 1);
78			input_report_key(dev, BTN_TOP,     (data[3] >> 2) & 1);
79			input_report_key(dev, BTN_TOP2,    (data[3] >> 3) & 1);
80			break;
81		case 3:					/* XY-axis info->data */
82			input_report_abs(dev, ABS_X, ((data[0] & 8) << 5) - (data[2] | ((data[0] & 4) << 5)));
83			input_report_abs(dev, ABS_Y, (data[1] | ((data[0] & 1) << 7)) - ((data[0] & 2) << 7));
84			break;
85		case 5:					/* Throttle, spinner, hat info->data */
86			input_report_abs(dev, ABS_THROTTLE, (data[1] | ((data[0] & 1) << 7)) - ((data[0] & 2) << 7));
87			input_report_abs(dev, ABS_HAT0X, (data[3] & 2 ? 1 : 0) - (data[3] & 1 ? 1 : 0));
88			input_report_abs(dev, ABS_HAT0Y, (data[3] & 8 ? 1 : 0) - (data[3] & 4 ? 1 : 0));
89			input_report_rel(dev, REL_DIAL,  (data[2] | ((data[0] & 4) << 5)) - ((data[0] & 8) << 5));
90			break;
91	}
92	input_sync(dev);
93}
94
95/*
96 * warrior_interrupt() is called by the low level driver when characters
97 * are ready for us. We then buffer them for further processing, or call the
98 * packet processing routine.
99 */
100
101static irqreturn_t warrior_interrupt(struct serio *serio,
102		unsigned char data, unsigned int flags)
103{
104	struct warrior *warrior = serio_get_drvdata(serio);
105
106	if (data & 0x80) {
107		if (warrior->idx) warrior_process_packet(warrior);
108		warrior->idx = 0;
109		warrior->len = warrior_lengths[(data >> 4) & 7];
110	}
111
112	if (warrior->idx < warrior->len)
113		warrior->data[warrior->idx++] = data;
114
115	if (warrior->idx == warrior->len) {
116		if (warrior->idx) warrior_process_packet(warrior);
117		warrior->idx = 0;
118		warrior->len = 0;
119	}
120	return IRQ_HANDLED;
121}
122
123/*
124 * warrior_disconnect() is the opposite of warrior_connect()
125 */
126
127static void warrior_disconnect(struct serio *serio)
128{
129	struct warrior *warrior = serio_get_drvdata(serio);
130
131	serio_close(serio);
132	serio_set_drvdata(serio, NULL);
133	input_unregister_device(warrior->dev);
134	kfree(warrior);
135}
136
137/*
138 * warrior_connect() is the routine that is called when someone adds a
139 * new serio device. It looks for the Warrior, and if found, registers
140 * it as an input device.
141 */
142
143static int warrior_connect(struct serio *serio, struct serio_driver *drv)
144{
145	struct warrior *warrior;
146	struct input_dev *input_dev;
147	int err = -ENOMEM;
148
149	warrior = kzalloc(sizeof(struct warrior), GFP_KERNEL);
150	input_dev = input_allocate_device();
151	if (!warrior || !input_dev)
152		goto fail1;
153
154	warrior->dev = input_dev;
155	snprintf(warrior->phys, sizeof(warrior->phys), "%s/input0", serio->phys);
156
157	input_dev->name = "Logitech WingMan Warrior";
158	input_dev->phys = warrior->phys;
159	input_dev->id.bustype = BUS_RS232;
160	input_dev->id.vendor = SERIO_WARRIOR;
161	input_dev->id.product = 0x0001;
162	input_dev->id.version = 0x0100;
163	input_dev->dev.parent = &serio->dev;
164
165	input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_REL) | BIT(EV_ABS);
166	input_dev->keybit[LONG(BTN_TRIGGER)] = BIT(BTN_TRIGGER) | BIT(BTN_THUMB) | BIT(BTN_TOP) | BIT(BTN_TOP2);
167	input_dev->relbit[0] = BIT(REL_DIAL);
168	input_set_abs_params(input_dev, ABS_X, -64, 64, 0, 8);
169	input_set_abs_params(input_dev, ABS_Y, -64, 64, 0, 8);
170	input_set_abs_params(input_dev, ABS_THROTTLE, -112, 112, 0, 0);
171	input_set_abs_params(input_dev, ABS_HAT0X, -1, 1, 0, 0);
172	input_set_abs_params(input_dev, ABS_HAT0Y, -1, 1, 0, 0);
173
174	serio_set_drvdata(serio, warrior);
175
176	err = serio_open(serio, drv);
177	if (err)
178		goto fail2;
179
180	err = input_register_device(warrior->dev);
181	if (err)
182		goto fail3;
183
184	return 0;
185
186 fail3:	serio_close(serio);
187 fail2:	serio_set_drvdata(serio, NULL);
188 fail1:	input_free_device(input_dev);
189	kfree(warrior);
190	return err;
191}
192
193/*
194 * The serio driver structure.
195 */
196
197static struct serio_device_id warrior_serio_ids[] = {
198	{
199		.type	= SERIO_RS232,
200		.proto	= SERIO_WARRIOR,
201		.id	= SERIO_ANY,
202		.extra	= SERIO_ANY,
203	},
204	{ 0 }
205};
206
207MODULE_DEVICE_TABLE(serio, warrior_serio_ids);
208
209static struct serio_driver warrior_drv = {
210	.driver		= {
211		.name	= "warrior",
212	},
213	.description	= DRIVER_DESC,
214	.id_table	= warrior_serio_ids,
215	.interrupt	= warrior_interrupt,
216	.connect	= warrior_connect,
217	.disconnect	= warrior_disconnect,
218};
219
220/*
221 * The functions for inserting/removing us as a module.
222 */
223
224static int __init warrior_init(void)
225{
226	return serio_register_driver(&warrior_drv);
227}
228
229static void __exit warrior_exit(void)
230{
231	serio_unregister_driver(&warrior_drv);
232}
233
234module_init(warrior_init);
235module_exit(warrior_exit);
236