2 * $Id: spaceorb.c,v 1.15 2002/01/22 20:29:19 vojtech Exp $
4 * Copyright (c) 1999-2001 Vojtech Pavlik
6 * Based on the work of:
11 * SpaceTec SpaceOrb 360 and Avenger 6dof controller driver for Linux
15 * This program is free software; you can redistribute it and/or modify
16 * it under the terms of the GNU General Public License as published by
17 * the Free Software Foundation; either version 2 of the License, or
18 * (at your option) any later version.
20 * This program is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
25 * You should have received a copy of the GNU General Public License
26 * along with this program; if not, write to the Free Software
27 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
29 * Should you need to contact me, the author, you can do so either by
30 * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
31 * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
34 #include <linux/kernel.h>
35 #include <linux/slab.h>
36 #include <linux/module.h>
37 #include <linux/init.h>
38 #include <linux/input.h>
39 #include <linux/serio.h>
41 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
42 MODULE_DESCRIPTION("SpaceTec SpaceOrb 360 and Avenger 6dof controller driver");
43 MODULE_LICENSE("GPL");
49 #define SPACEORB_MAX_LENGTH 64
51 static int spaceorb_buttons[] = { BTN_TL, BTN_TR, BTN_Y, BTN_X, BTN_B, BTN_A };
52 static int spaceorb_axes[] = { ABS_X, ABS_Y, ABS_Z, ABS_RX, ABS_RY, ABS_RZ };
53 static char *spaceorb_name = "SpaceTec SpaceOrb 360 / Avenger";
63 unsigned char data[SPACEORB_MAX_LENGTH];
67 static unsigned char spaceorb_xor[] = "SpaceWare";
69 static unsigned char *spaceorb_errors[] = { "EEPROM storing 0 failed", "Receive queue overflow", "Transmit queue timeout",
70 "Bad packet", "Power brown-out", "EEPROM checksum error", "Hardware fault" };
73 * spaceorb_process_packet() decodes packets the driver receives from the
77 static void spaceorb_process_packet(struct spaceorb *spaceorb, struct pt_regs *regs)
79 struct input_dev *dev = &spaceorb->dev;
80 unsigned char *data = spaceorb->data;
85 if (spaceorb->idx < 2) return;
86 for (i = 0; i < spaceorb->idx; i++) c ^= data[i];
89 input_regs(dev, regs);
93 case 'R': /* Reset packet */
94 spaceorb->data[spaceorb->idx - 1] = 0;
95 for (i = 1; i < spaceorb->idx && spaceorb->data[i] == ' '; i++);
96 printk(KERN_INFO "input: %s [%s] on %s\n",
97 spaceorb_name, spaceorb->data + i, spaceorb->serio->phys);
100 case 'D': /* Ball + button data */
101 if (spaceorb->idx != 12) return;
102 for (i = 0; i < 9; i++) spaceorb->data[i+2] ^= spaceorb_xor[i];
103 axes[0] = ( data[2] << 3) | (data[ 3] >> 4);
104 axes[1] = ((data[3] & 0x0f) << 6) | (data[ 4] >> 1);
105 axes[2] = ((data[4] & 0x01) << 9) | (data[ 5] << 2) | (data[4] >> 5);
106 axes[3] = ((data[6] & 0x1f) << 5) | (data[ 7] >> 2);
107 axes[4] = ((data[7] & 0x03) << 8) | (data[ 8] << 1) | (data[7] >> 6);
108 axes[5] = ((data[9] & 0x3f) << 4) | (data[10] >> 3);
109 for (i = 0; i < 6; i++)
110 input_report_abs(dev, spaceorb_axes[i], axes[i] - ((axes[i] & 0x200) ? 1024 : 0));
111 for (i = 0; i < 6; i++)
112 input_report_key(dev, spaceorb_buttons[i], (data[1] >> i) & 1);
115 case 'K': /* Button data */
116 if (spaceorb->idx != 5) return;
117 for (i = 0; i < 7; i++)
118 input_report_key(dev, spaceorb_buttons[i], (data[2] >> i) & 1);
122 case 'E': /* Error packet */
123 if (spaceorb->idx != 4) return;
124 printk(KERN_ERR "joy-spaceorb: Device error. [ ");
125 for (i = 0; i < 7; i++) if (data[1] & (1 << i)) printk("%s ", spaceorb_errors[i]);
133 static irqreturn_t spaceorb_interrupt(struct serio *serio,
134 unsigned char data, unsigned int flags, struct pt_regs *regs)
136 struct spaceorb* spaceorb = serio->private;
139 if (spaceorb->idx) spaceorb_process_packet(spaceorb, regs);
142 if (spaceorb->idx < SPACEORB_MAX_LENGTH)
143 spaceorb->data[spaceorb->idx++] = data & 0x7f;
148 * spaceorb_disconnect() is the opposite of spaceorb_connect()
151 static void spaceorb_disconnect(struct serio *serio)
153 struct spaceorb* spaceorb = serio->private;
154 input_unregister_device(&spaceorb->dev);
160 * spaceorb_connect() is the routine that is called when someone adds a
161 * new serio device. It looks for the SpaceOrb/Avenger, and if found, registers
162 * it as an input device.
165 static void spaceorb_connect(struct serio *serio, struct serio_dev *dev)
167 struct spaceorb *spaceorb;
170 if (serio->type != (SERIO_RS232 | SERIO_SPACEORB))
173 if (!(spaceorb = kmalloc(sizeof(struct spaceorb), GFP_KERNEL)))
175 memset(spaceorb, 0, sizeof(struct spaceorb));
177 spaceorb->dev.evbit[0] = BIT(EV_KEY) | BIT(EV_ABS);
179 for (i = 0; i < 6; i++)
180 set_bit(spaceorb_buttons[i], spaceorb->dev.keybit);
182 for (i = 0; i < 6; i++) {
183 t = spaceorb_axes[i];
184 set_bit(t, spaceorb->dev.absbit);
185 spaceorb->dev.absmin[t] = -508;
186 spaceorb->dev.absmax[t] = 508;
189 spaceorb->serio = serio;
190 spaceorb->dev.private = spaceorb;
192 sprintf(spaceorb->phys, "%s/input0", serio->phys);
194 init_input_dev(&spaceorb->dev);
195 spaceorb->dev.name = spaceorb_name;
196 spaceorb->dev.phys = spaceorb->phys;
197 spaceorb->dev.id.bustype = BUS_RS232;
198 spaceorb->dev.id.vendor = SERIO_SPACEORB;
199 spaceorb->dev.id.product = 0x0001;
200 spaceorb->dev.id.version = 0x0100;
202 serio->private = spaceorb;
204 if (serio_open(serio, dev)) {
209 input_register_device(&spaceorb->dev);
213 * The serio device structure.
216 static struct serio_dev spaceorb_dev = {
217 .interrupt = spaceorb_interrupt,
218 .connect = spaceorb_connect,
219 .disconnect = spaceorb_disconnect,
223 * The functions for inserting/removing us as a module.
226 int __init spaceorb_init(void)
228 serio_register_device(&spaceorb_dev);
232 void __exit spaceorb_exit(void)
234 serio_unregister_device(&spaceorb_dev);
237 module_init(spaceorb_init);
238 module_exit(spaceorb_exit);