xref: /openbmc/linux/drivers/input/joystick/warrior.c (revision 1da177e4)
1 /*
2  * $Id: warrior.c,v 1.14 2002/01/22 20:32:10 vojtech 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 
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 WARRIOR_MAX_LENGTH	16
49 static char warrior_lengths[] = { 0, 4, 12, 3, 4, 4, 0, 0 };
50 static char *warrior_name = "Logitech WingMan Warrior";
51 
52 /*
53  * Per-Warrior data.
54  */
55 
56 struct warrior {
57 	struct input_dev dev;
58 	int idx, len;
59 	unsigned char data[WARRIOR_MAX_LENGTH];
60 	char phys[32];
61 };
62 
63 /*
64  * warrior_process_packet() decodes packets the driver receives from the
65  * Warrior. It updates the data accordingly.
66  */
67 
68 static void warrior_process_packet(struct warrior *warrior, struct pt_regs *regs)
69 {
70 	struct input_dev *dev = &warrior->dev;
71 	unsigned char *data = warrior->data;
72 
73 	if (!warrior->idx) return;
74 
75 	input_regs(dev, regs);
76 
77 	switch ((data[0] >> 4) & 7) {
78 		case 1:					/* Button data */
79 			input_report_key(dev, BTN_TRIGGER,  data[3]       & 1);
80 			input_report_key(dev, BTN_THUMB,   (data[3] >> 1) & 1);
81 			input_report_key(dev, BTN_TOP,     (data[3] >> 2) & 1);
82 			input_report_key(dev, BTN_TOP2,    (data[3] >> 3) & 1);
83 			break;
84 		case 3:					/* XY-axis info->data */
85 			input_report_abs(dev, ABS_X, ((data[0] & 8) << 5) - (data[2] | ((data[0] & 4) << 5)));
86 			input_report_abs(dev, ABS_Y, (data[1] | ((data[0] & 1) << 7)) - ((data[0] & 2) << 7));
87 			break;
88 		case 5:					/* Throttle, spinner, hat info->data */
89 			input_report_abs(dev, ABS_THROTTLE, (data[1] | ((data[0] & 1) << 7)) - ((data[0] & 2) << 7));
90 			input_report_abs(dev, ABS_HAT0X, (data[3] & 2 ? 1 : 0) - (data[3] & 1 ? 1 : 0));
91 			input_report_abs(dev, ABS_HAT0Y, (data[3] & 8 ? 1 : 0) - (data[3] & 4 ? 1 : 0));
92 			input_report_rel(dev, REL_DIAL,  (data[2] | ((data[0] & 4) << 5)) - ((data[0] & 8) << 5));
93 			break;
94 	}
95 	input_sync(dev);
96 }
97 
98 /*
99  * warrior_interrupt() is called by the low level driver when characters
100  * are ready for us. We then buffer them for further processing, or call the
101  * packet processing routine.
102  */
103 
104 static irqreturn_t warrior_interrupt(struct serio *serio,
105 		unsigned char data, unsigned int flags, struct pt_regs *regs)
106 {
107 	struct warrior *warrior = serio_get_drvdata(serio);
108 
109 	if (data & 0x80) {
110 		if (warrior->idx) warrior_process_packet(warrior, regs);
111 		warrior->idx = 0;
112 		warrior->len = warrior_lengths[(data >> 4) & 7];
113 	}
114 
115 	if (warrior->idx < warrior->len)
116 		warrior->data[warrior->idx++] = data;
117 
118 	if (warrior->idx == warrior->len) {
119 		if (warrior->idx) warrior_process_packet(warrior, regs);
120 		warrior->idx = 0;
121 		warrior->len = 0;
122 	}
123 	return IRQ_HANDLED;
124 }
125 
126 /*
127  * warrior_disconnect() is the opposite of warrior_connect()
128  */
129 
130 static void warrior_disconnect(struct serio *serio)
131 {
132 	struct warrior *warrior = serio_get_drvdata(serio);
133 
134 	input_unregister_device(&warrior->dev);
135 	serio_close(serio);
136 	serio_set_drvdata(serio, NULL);
137 	kfree(warrior);
138 }
139 
140 /*
141  * warrior_connect() is the routine that is called when someone adds a
142  * new serio device. It looks for the Warrior, and if found, registers
143  * it as an input device.
144  */
145 
146 static int warrior_connect(struct serio *serio, struct serio_driver *drv)
147 {
148 	struct warrior *warrior;
149 	int i;
150 	int err;
151 
152 	if (!(warrior = kmalloc(sizeof(struct warrior), GFP_KERNEL)))
153 		return -ENOMEM;
154 
155 	memset(warrior, 0, sizeof(struct warrior));
156 
157 	warrior->dev.evbit[0] = BIT(EV_KEY) | BIT(EV_REL) | BIT(EV_ABS);
158 	warrior->dev.keybit[LONG(BTN_TRIGGER)] = BIT(BTN_TRIGGER) | BIT(BTN_THUMB) | BIT(BTN_TOP) | BIT(BTN_TOP2);
159 	warrior->dev.relbit[0] = BIT(REL_DIAL);
160 	warrior->dev.absbit[0] = BIT(ABS_X) | BIT(ABS_Y) | BIT(ABS_THROTTLE) | BIT(ABS_HAT0X) | BIT(ABS_HAT0Y);
161 
162 	sprintf(warrior->phys, "%s/input0", serio->phys);
163 
164 	init_input_dev(&warrior->dev);
165 	warrior->dev.name = warrior_name;
166 	warrior->dev.phys = warrior->phys;
167 	warrior->dev.id.bustype = BUS_RS232;
168 	warrior->dev.id.vendor = SERIO_WARRIOR;
169 	warrior->dev.id.product = 0x0001;
170 	warrior->dev.id.version = 0x0100;
171 	warrior->dev.dev = &serio->dev;
172 
173 	for (i = 0; i < 2; i++) {
174 		warrior->dev.absmax[ABS_X+i] = -64;
175 		warrior->dev.absmin[ABS_X+i] =  64;
176 		warrior->dev.absflat[ABS_X+i] = 8;
177 	}
178 
179 	warrior->dev.absmax[ABS_THROTTLE] = -112;
180 	warrior->dev.absmin[ABS_THROTTLE] =  112;
181 
182 	for (i = 0; i < 2; i++) {
183 		warrior->dev.absmax[ABS_HAT0X+i] = -1;
184 		warrior->dev.absmin[ABS_HAT0X+i] =  1;
185 	}
186 
187 	warrior->dev.private = warrior;
188 
189 	serio_set_drvdata(serio, warrior);
190 
191 	err = serio_open(serio, drv);
192 	if (err) {
193 		serio_set_drvdata(serio, NULL);
194 		kfree(warrior);
195 		return err;
196 	}
197 
198 	input_register_device(&warrior->dev);
199 
200 	printk(KERN_INFO "input: Logitech WingMan Warrior on %s\n", serio->phys);
201 
202 	return 0;
203 }
204 
205 /*
206  * The serio driver structure.
207  */
208 
209 static struct serio_device_id warrior_serio_ids[] = {
210 	{
211 		.type	= SERIO_RS232,
212 		.proto	= SERIO_WARRIOR,
213 		.id	= SERIO_ANY,
214 		.extra	= SERIO_ANY,
215 	},
216 	{ 0 }
217 };
218 
219 MODULE_DEVICE_TABLE(serio, warrior_serio_ids);
220 
221 static struct serio_driver warrior_drv = {
222 	.driver		= {
223 		.name	= "warrior",
224 	},
225 	.description	= DRIVER_DESC,
226 	.id_table	= warrior_serio_ids,
227 	.interrupt	= warrior_interrupt,
228 	.connect	= warrior_connect,
229 	.disconnect	= warrior_disconnect,
230 };
231 
232 /*
233  * The functions for inserting/removing us as a module.
234  */
235 
236 static int __init warrior_init(void)
237 {
238 	serio_register_driver(&warrior_drv);
239 	return 0;
240 }
241 
242 static void __exit warrior_exit(void)
243 {
244 	serio_unregister_driver(&warrior_drv);
245 }
246 
247 module_init(warrior_init);
248 module_exit(warrior_exit);
249