Commit | Line | Data |
---|---|---|
1da177e4 | 1 | /* |
1da177e4 LT |
2 | * Copyright (c) 1999-2001 Vojtech Pavlik |
3 | * | |
4 | * Based on the work of: | |
ab0c3443 DT |
5 | * David Thompson |
6 | * Joseph Krahn | |
1da177e4 LT |
7 | */ |
8 | ||
9 | /* | |
10 | * SpaceTec SpaceBall 2003/3003/4000 FLX driver for Linux | |
11 | */ | |
12 | ||
13 | /* | |
14 | * This program is free software; you can redistribute it and/or modify | |
15 | * it under the terms of the GNU General Public License as published by | |
16 | * the Free Software Foundation; either version 2 of the License, or | |
17 | * (at your option) any later version. | |
18 | * | |
19 | * This program is distributed in the hope that it will be useful, | |
20 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
21 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
22 | * GNU General Public License for more details. | |
23 | * | |
24 | * You should have received a copy of the GNU General Public License | |
25 | * along with this program; if not, write to the Free Software | |
26 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
27 | * | |
28 | * Should you need to contact me, the author, you can do so either by | |
29 | * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail: | |
30 | * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic | |
31 | */ | |
32 | ||
33 | #include <linux/kernel.h> | |
34 | #include <linux/slab.h> | |
35 | #include <linux/module.h> | |
1da177e4 LT |
36 | #include <linux/input.h> |
37 | #include <linux/serio.h> | |
38 | ||
39 | #define DRIVER_DESC "SpaceTec SpaceBall 2003/3003/4000 FLX driver" | |
40 | ||
41 | MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>"); | |
42 | MODULE_DESCRIPTION(DRIVER_DESC); | |
43 | MODULE_LICENSE("GPL"); | |
44 | ||
45 | /* | |
46 | * Constants. | |
47 | */ | |
48 | ||
49 | #define SPACEBALL_MAX_LENGTH 128 | |
2c1dd69d | 50 | #define SPACEBALL_MAX_ID 9 |
1da177e4 LT |
51 | |
52 | #define SPACEBALL_1003 1 | |
53 | #define SPACEBALL_2003B 3 | |
54 | #define SPACEBALL_2003C 4 | |
55 | #define SPACEBALL_3003C 7 | |
56 | #define SPACEBALL_4000FLX 8 | |
57 | #define SPACEBALL_4000FLX_L 9 | |
58 | ||
59 | static int spaceball_axes[] = { ABS_X, ABS_Z, ABS_Y, ABS_RX, ABS_RZ, ABS_RY }; | |
60 | static char *spaceball_names[] = { | |
61 | "?", "SpaceTec SpaceBall 1003", "SpaceTec SpaceBall 2003", "SpaceTec SpaceBall 2003B", | |
62 | "SpaceTec SpaceBall 2003C", "SpaceTec SpaceBall 3003", "SpaceTec SpaceBall SpaceController", | |
63 | "SpaceTec SpaceBall 3003C", "SpaceTec SpaceBall 4000FLX", "SpaceTec SpaceBall 4000FLX Lefty" }; | |
64 | ||
65 | /* | |
66 | * Per-Ball data. | |
67 | */ | |
68 | ||
69 | struct spaceball { | |
17dd3f0f | 70 | struct input_dev *dev; |
1da177e4 LT |
71 | int idx; |
72 | int escape; | |
73 | unsigned char data[SPACEBALL_MAX_LENGTH]; | |
74 | char phys[32]; | |
75 | }; | |
76 | ||
77 | /* | |
78 | * spaceball_process_packet() decodes packets the driver receives from the | |
79 | * SpaceBall. | |
80 | */ | |
81 | ||
7d12e780 | 82 | static void spaceball_process_packet(struct spaceball* spaceball) |
1da177e4 | 83 | { |
17dd3f0f | 84 | struct input_dev *dev = spaceball->dev; |
1da177e4 LT |
85 | unsigned char *data = spaceball->data; |
86 | int i; | |
87 | ||
88 | if (spaceball->idx < 2) return; | |
89 | ||
1da177e4 LT |
90 | switch (spaceball->data[0]) { |
91 | ||
92 | case 'D': /* Ball data */ | |
93 | if (spaceball->idx != 15) return; | |
94 | for (i = 0; i < 6; i++) | |
95 | input_report_abs(dev, spaceball_axes[i], | |
96 | (__s16)((data[2 * i + 3] << 8) | data[2 * i + 2])); | |
97 | break; | |
98 | ||
99 | case 'K': /* Button data */ | |
100 | if (spaceball->idx != 3) return; | |
101 | input_report_key(dev, BTN_1, (data[2] & 0x01) || (data[2] & 0x20)); | |
102 | input_report_key(dev, BTN_2, data[2] & 0x02); | |
103 | input_report_key(dev, BTN_3, data[2] & 0x04); | |
104 | input_report_key(dev, BTN_4, data[2] & 0x08); | |
105 | input_report_key(dev, BTN_5, data[1] & 0x01); | |
106 | input_report_key(dev, BTN_6, data[1] & 0x02); | |
107 | input_report_key(dev, BTN_7, data[1] & 0x04); | |
108 | input_report_key(dev, BTN_8, data[1] & 0x10); | |
109 | break; | |
110 | ||
111 | case '.': /* Advanced button data */ | |
112 | if (spaceball->idx != 3) return; | |
113 | input_report_key(dev, BTN_1, data[2] & 0x01); | |
114 | input_report_key(dev, BTN_2, data[2] & 0x02); | |
115 | input_report_key(dev, BTN_3, data[2] & 0x04); | |
116 | input_report_key(dev, BTN_4, data[2] & 0x08); | |
117 | input_report_key(dev, BTN_5, data[2] & 0x10); | |
118 | input_report_key(dev, BTN_6, data[2] & 0x20); | |
119 | input_report_key(dev, BTN_7, data[2] & 0x80); | |
120 | input_report_key(dev, BTN_8, data[1] & 0x01); | |
121 | input_report_key(dev, BTN_9, data[1] & 0x02); | |
122 | input_report_key(dev, BTN_A, data[1] & 0x04); | |
123 | input_report_key(dev, BTN_B, data[1] & 0x08); | |
124 | input_report_key(dev, BTN_C, data[1] & 0x10); | |
125 | input_report_key(dev, BTN_MODE, data[1] & 0x20); | |
126 | break; | |
127 | ||
128 | case 'E': /* Device error */ | |
129 | spaceball->data[spaceball->idx - 1] = 0; | |
130 | printk(KERN_ERR "spaceball: Device error. [%s]\n", spaceball->data + 1); | |
131 | break; | |
132 | ||
133 | case '?': /* Bad command packet */ | |
134 | spaceball->data[spaceball->idx - 1] = 0; | |
135 | printk(KERN_ERR "spaceball: Bad command. [%s]\n", spaceball->data + 1); | |
136 | break; | |
137 | } | |
138 | ||
139 | input_sync(dev); | |
140 | } | |
141 | ||
142 | /* | |
143 | * Spaceball 4000 FLX packets all start with a one letter packet-type decriptor, | |
144 | * and end in 0x0d. It uses '^' as an escape for CR, XOFF and XON characters which | |
145 | * can occur in the axis values. | |
146 | */ | |
147 | ||
148 | static irqreturn_t spaceball_interrupt(struct serio *serio, | |
7d12e780 | 149 | unsigned char data, unsigned int flags) |
1da177e4 LT |
150 | { |
151 | struct spaceball *spaceball = serio_get_drvdata(serio); | |
152 | ||
153 | switch (data) { | |
154 | case 0xd: | |
7d12e780 | 155 | spaceball_process_packet(spaceball); |
1da177e4 LT |
156 | spaceball->idx = 0; |
157 | spaceball->escape = 0; | |
158 | break; | |
159 | case '^': | |
160 | if (!spaceball->escape) { | |
161 | spaceball->escape = 1; | |
162 | break; | |
163 | } | |
164 | spaceball->escape = 0; | |
165 | case 'M': | |
166 | case 'Q': | |
167 | case 'S': | |
168 | if (spaceball->escape) { | |
169 | spaceball->escape = 0; | |
170 | data &= 0x1f; | |
171 | } | |
172 | default: | |
173 | if (spaceball->escape) | |
174 | spaceball->escape = 0; | |
175 | if (spaceball->idx < SPACEBALL_MAX_LENGTH) | |
176 | spaceball->data[spaceball->idx++] = data; | |
177 | break; | |
178 | } | |
179 | return IRQ_HANDLED; | |
180 | } | |
181 | ||
182 | /* | |
183 | * spaceball_disconnect() is the opposite of spaceball_connect() | |
184 | */ | |
185 | ||
186 | static void spaceball_disconnect(struct serio *serio) | |
187 | { | |
188 | struct spaceball* spaceball = serio_get_drvdata(serio); | |
189 | ||
1da177e4 LT |
190 | serio_close(serio); |
191 | serio_set_drvdata(serio, NULL); | |
17dd3f0f | 192 | input_unregister_device(spaceball->dev); |
1da177e4 LT |
193 | kfree(spaceball); |
194 | } | |
195 | ||
196 | /* | |
197 | * spaceball_connect() is the routine that is called when someone adds a | |
198 | * new serio device that supports Spaceball protocol and registers it as | |
199 | * an input device. | |
200 | */ | |
201 | ||
202 | static int spaceball_connect(struct serio *serio, struct serio_driver *drv) | |
203 | { | |
204 | struct spaceball *spaceball; | |
17dd3f0f DT |
205 | struct input_dev *input_dev; |
206 | int err = -ENOMEM; | |
207 | int i, id; | |
1da177e4 LT |
208 | |
209 | if ((id = serio->id.id) > SPACEBALL_MAX_ID) | |
210 | return -ENODEV; | |
211 | ||
17dd3f0f DT |
212 | spaceball = kmalloc(sizeof(struct spaceball), GFP_KERNEL); |
213 | input_dev = input_allocate_device(); | |
214 | if (!spaceball || !input_dev) | |
127278ce | 215 | goto fail1; |
1da177e4 | 216 | |
17dd3f0f | 217 | spaceball->dev = input_dev; |
10ca4c0a | 218 | snprintf(spaceball->phys, sizeof(spaceball->phys), "%s/input0", serio->phys); |
17dd3f0f DT |
219 | |
220 | input_dev->name = spaceball_names[id]; | |
221 | input_dev->phys = spaceball->phys; | |
222 | input_dev->id.bustype = BUS_RS232; | |
223 | input_dev->id.vendor = SERIO_SPACEBALL; | |
224 | input_dev->id.product = id; | |
225 | input_dev->id.version = 0x0100; | |
935e658e | 226 | input_dev->dev.parent = &serio->dev; |
1da177e4 | 227 | |
7b19ada2 | 228 | input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS); |
1da177e4 LT |
229 | |
230 | switch (id) { | |
231 | case SPACEBALL_4000FLX: | |
232 | case SPACEBALL_4000FLX_L: | |
7b19ada2 JS |
233 | input_dev->keybit[BIT_WORD(BTN_0)] |= BIT_MASK(BTN_9); |
234 | input_dev->keybit[BIT_WORD(BTN_A)] |= BIT_MASK(BTN_A) | | |
235 | BIT_MASK(BTN_B) | BIT_MASK(BTN_C) | | |
236 | BIT_MASK(BTN_MODE); | |
1da177e4 | 237 | default: |
7b19ada2 JS |
238 | input_dev->keybit[BIT_WORD(BTN_0)] |= BIT_MASK(BTN_2) | |
239 | BIT_MASK(BTN_3) | BIT_MASK(BTN_4) | | |
240 | BIT_MASK(BTN_5) | BIT_MASK(BTN_6) | | |
241 | BIT_MASK(BTN_7) | BIT_MASK(BTN_8); | |
1da177e4 | 242 | case SPACEBALL_3003C: |
7b19ada2 JS |
243 | input_dev->keybit[BIT_WORD(BTN_0)] |= BIT_MASK(BTN_1) | |
244 | BIT_MASK(BTN_8); | |
1da177e4 LT |
245 | } |
246 | ||
17dd3f0f DT |
247 | for (i = 0; i < 3; i++) { |
248 | input_set_abs_params(input_dev, ABS_X + i, -8000, 8000, 8, 40); | |
249 | input_set_abs_params(input_dev, ABS_RX + i, -1600, 1600, 2, 8); | |
1da177e4 LT |
250 | } |
251 | ||
1da177e4 LT |
252 | serio_set_drvdata(serio, spaceball); |
253 | ||
254 | err = serio_open(serio, drv); | |
17dd3f0f | 255 | if (err) |
127278ce DT |
256 | goto fail2; |
257 | ||
258 | err = input_register_device(spaceball->dev); | |
259 | if (err) | |
260 | goto fail3; | |
1da177e4 LT |
261 | |
262 | return 0; | |
17dd3f0f | 263 | |
127278ce DT |
264 | fail3: serio_close(serio); |
265 | fail2: serio_set_drvdata(serio, NULL); | |
266 | fail1: input_free_device(input_dev); | |
17dd3f0f DT |
267 | kfree(spaceball); |
268 | return err; | |
1da177e4 LT |
269 | } |
270 | ||
271 | /* | |
272 | * The serio driver structure. | |
273 | */ | |
274 | ||
275 | static struct serio_device_id spaceball_serio_ids[] = { | |
276 | { | |
277 | .type = SERIO_RS232, | |
278 | .proto = SERIO_SPACEBALL, | |
279 | .id = SERIO_ANY, | |
280 | .extra = SERIO_ANY, | |
281 | }, | |
282 | { 0 } | |
283 | }; | |
284 | ||
285 | MODULE_DEVICE_TABLE(serio, spaceball_serio_ids); | |
286 | ||
287 | static struct serio_driver spaceball_drv = { | |
288 | .driver = { | |
289 | .name = "spaceball", | |
290 | }, | |
291 | .description = DRIVER_DESC, | |
292 | .id_table = spaceball_serio_ids, | |
293 | .interrupt = spaceball_interrupt, | |
294 | .connect = spaceball_connect, | |
295 | .disconnect = spaceball_disconnect, | |
296 | }; | |
297 | ||
65ac9f7a | 298 | module_serio_driver(spaceball_drv); |