blob: ca3cc2319d6ae393e11dc1db5fd2645f16906e2e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * $Id: magellan.c,v 1.16 2002/01/22 20:28:39 vojtech Exp $
3 *
4 * Copyright (c) 1999-2001 Vojtech Pavlik
5 */
6
7/*
8 * Magellan and Space Mouse 6dof controller driver for Linux
9 */
10
11/*
12 * This program is free software; 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 "Magellan and SpaceMouse 6dof controller driver"
39
40MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
41MODULE_DESCRIPTION(DRIVER_DESC);
42MODULE_LICENSE("GPL");
43
44/*
45 * Definitions & global arrays.
46 */
47
48#define MAGELLAN_MAX_LENGTH 32
49
50static int magellan_buttons[] = { BTN_0, BTN_1, BTN_2, BTN_3, BTN_4, BTN_5, BTN_6, BTN_7, BTN_8 };
51static int magellan_axes[] = { ABS_X, ABS_Y, ABS_Z, ABS_RX, ABS_RY, ABS_RZ };
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
53/*
54 * Per-Magellan data.
55 */
56
57struct magellan {
Dmitry Torokhov17dd3f02005-09-15 02:01:52 -050058 struct input_dev *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 int idx;
60 unsigned char data[MAGELLAN_MAX_LENGTH];
61 char phys[32];
62};
63
64/*
65 * magellan_crunch_nibbles() verifies that the bytes sent from the Magellan
66 * have correct upper nibbles for the lower ones, if not, the packet will
67 * be thrown away. It also strips these upper halves to simplify further
68 * processing.
69 */
70
71static int magellan_crunch_nibbles(unsigned char *data, int count)
72{
73 static unsigned char nibbles[16] = "0AB3D56GH9:K<MN?";
74
75 do {
76 if (data[count] == nibbles[data[count] & 0xf])
77 data[count] = data[count] & 0xf;
78 else
79 return -1;
80 } while (--count);
81
82 return 0;
83}
84
85static void magellan_process_packet(struct magellan* magellan, struct pt_regs *regs)
86{
Dmitry Torokhov17dd3f02005-09-15 02:01:52 -050087 struct input_dev *dev = magellan->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070088 unsigned char *data = magellan->data;
89 int i, t;
90
91 if (!magellan->idx) return;
92
93 input_regs(dev, regs);
94
95 switch (magellan->data[0]) {
96
97 case 'd': /* Axis data */
98 if (magellan->idx != 25) return;
99 if (magellan_crunch_nibbles(data, 24)) return;
100 for (i = 0; i < 6; i++)
101 input_report_abs(dev, magellan_axes[i],
102 (data[(i << 2) + 1] << 12 | data[(i << 2) + 2] << 8 |
103 data[(i << 2) + 3] << 4 | data[(i << 2) + 4]) - 32768);
104 break;
105
106 case 'k': /* Button data */
107 if (magellan->idx != 4) return;
108 if (magellan_crunch_nibbles(data, 3)) return;
109 t = (data[1] << 1) | (data[2] << 5) | data[3];
110 for (i = 0; i < 9; i++) input_report_key(dev, magellan_buttons[i], (t >> i) & 1);
111 break;
112 }
113
114 input_sync(dev);
115}
116
117static irqreturn_t magellan_interrupt(struct serio *serio,
118 unsigned char data, unsigned int flags, struct pt_regs *regs)
119{
120 struct magellan* magellan = serio_get_drvdata(serio);
121
122 if (data == '\r') {
123 magellan_process_packet(magellan, regs);
124 magellan->idx = 0;
125 } else {
126 if (magellan->idx < MAGELLAN_MAX_LENGTH)
127 magellan->data[magellan->idx++] = data;
128 }
129 return IRQ_HANDLED;
130}
131
132/*
133 * magellan_disconnect() is the opposite of magellan_connect()
134 */
135
136static void magellan_disconnect(struct serio *serio)
137{
138 struct magellan* magellan = serio_get_drvdata(serio);
139
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 serio_close(serio);
141 serio_set_drvdata(serio, NULL);
Dmitry Torokhov17dd3f02005-09-15 02:01:52 -0500142 input_unregister_device(magellan->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 kfree(magellan);
144}
145
146/*
147 * magellan_connect() is the routine that is called when someone adds a
148 * new serio device that supports Magellan protocol and registers it as
149 * an input device.
150 */
151
152static int magellan_connect(struct serio *serio, struct serio_driver *drv)
153{
154 struct magellan *magellan;
Dmitry Torokhov17dd3f02005-09-15 02:01:52 -0500155 struct input_dev *input_dev;
156 int err = -ENOMEM;
157 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158
Dmitry Torokhov17dd3f02005-09-15 02:01:52 -0500159 magellan = kzalloc(sizeof(struct magellan), GFP_KERNEL);
160 input_dev = input_allocate_device();
161 if (!magellan || !input_dev)
162 goto fail;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
Dmitry Torokhov17dd3f02005-09-15 02:01:52 -0500164 magellan->dev = input_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 sprintf(magellan->phys, "%s/input0", serio->phys);
166
Dmitry Torokhov17dd3f02005-09-15 02:01:52 -0500167 input_dev->name = "LogiCad3D Magellan / SpaceMouse";
168 input_dev->phys = magellan->phys;
169 input_dev->id.bustype = BUS_RS232;
170 input_dev->id.vendor = SERIO_MAGELLAN;
171 input_dev->id.product = 0x0001;
172 input_dev->id.version = 0x0100;
173 input_dev->cdev.dev = &serio->dev;
174 input_dev->private = magellan;
175
176 input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_ABS);
177
178 for (i = 0; i < 9; i++)
179 set_bit(magellan_buttons[i], input_dev->keybit);
180
181 for (i = 0; i < 6; i++)
182 input_set_abs_params(input_dev, magellan_axes[i], -360, 360, 0, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183
184 serio_set_drvdata(serio, magellan);
185
186 err = serio_open(serio, drv);
Dmitry Torokhov17dd3f02005-09-15 02:01:52 -0500187 if (err)
188 goto fail;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189
Dmitry Torokhov17dd3f02005-09-15 02:01:52 -0500190 input_register_device(magellan->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 return 0;
Dmitry Torokhov17dd3f02005-09-15 02:01:52 -0500192
193 fail: serio_set_drvdata(serio, NULL);
194 input_free_device(input_dev);
195 kfree(magellan);
196 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197}
198
199/*
200 * The serio driver structure.
201 */
202
203static struct serio_device_id magellan_serio_ids[] = {
204 {
205 .type = SERIO_RS232,
206 .proto = SERIO_MAGELLAN,
207 .id = SERIO_ANY,
208 .extra = SERIO_ANY,
209 },
210 { 0 }
211};
212
213MODULE_DEVICE_TABLE(serio, magellan_serio_ids);
214
215static struct serio_driver magellan_drv = {
216 .driver = {
217 .name = "magellan",
218 },
219 .description = DRIVER_DESC,
220 .id_table = magellan_serio_ids,
221 .interrupt = magellan_interrupt,
222 .connect = magellan_connect,
223 .disconnect = magellan_disconnect,
224};
225
226/*
227 * The functions for inserting/removing us as a module.
228 */
229
230static int __init magellan_init(void)
231{
232 serio_register_driver(&magellan_drv);
233 return 0;
234}
235
236static void __exit magellan_exit(void)
237{
238 serio_unregister_driver(&magellan_drv);
239}
240
241module_init(magellan_init);
242module_exit(magellan_exit);