11da177e4SLinus Torvalds /* 21da177e4SLinus Torvalds * $Id: magellan.c,v 1.16 2002/01/22 20:28:39 vojtech Exp $ 31da177e4SLinus Torvalds * 41da177e4SLinus Torvalds * Copyright (c) 1999-2001 Vojtech Pavlik 51da177e4SLinus Torvalds */ 61da177e4SLinus Torvalds 71da177e4SLinus Torvalds /* 81da177e4SLinus Torvalds * Magellan and Space Mouse 6dof controller driver for Linux 91da177e4SLinus Torvalds */ 101da177e4SLinus Torvalds 111da177e4SLinus Torvalds /* 121da177e4SLinus Torvalds * This program is free software; you can redistribute it and/or modify 131da177e4SLinus Torvalds * it under the terms of the GNU General Public License as published by 141da177e4SLinus Torvalds * the Free Software Foundation; either version 2 of the License, or 151da177e4SLinus Torvalds * (at your option) any later version. 161da177e4SLinus Torvalds * 171da177e4SLinus Torvalds * This program is distributed in the hope that it will be useful, 181da177e4SLinus Torvalds * but WITHOUT ANY WARRANTY; without even the implied warranty of 191da177e4SLinus Torvalds * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 201da177e4SLinus Torvalds * GNU General Public License for more details. 211da177e4SLinus Torvalds * 221da177e4SLinus Torvalds * You should have received a copy of the GNU General Public License 231da177e4SLinus Torvalds * along with this program; if not, write to the Free Software 241da177e4SLinus Torvalds * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 251da177e4SLinus Torvalds * 261da177e4SLinus Torvalds * Should you need to contact me, the author, you can do so either by 271da177e4SLinus Torvalds * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail: 281da177e4SLinus Torvalds * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic 291da177e4SLinus Torvalds */ 301da177e4SLinus Torvalds 311da177e4SLinus Torvalds #include <linux/kernel.h> 321da177e4SLinus Torvalds #include <linux/module.h> 331da177e4SLinus Torvalds #include <linux/slab.h> 341da177e4SLinus Torvalds #include <linux/input.h> 351da177e4SLinus Torvalds #include <linux/serio.h> 361da177e4SLinus Torvalds #include <linux/init.h> 371da177e4SLinus Torvalds 381da177e4SLinus Torvalds #define DRIVER_DESC "Magellan and SpaceMouse 6dof controller driver" 391da177e4SLinus Torvalds 401da177e4SLinus Torvalds MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>"); 411da177e4SLinus Torvalds MODULE_DESCRIPTION(DRIVER_DESC); 421da177e4SLinus Torvalds MODULE_LICENSE("GPL"); 431da177e4SLinus Torvalds 441da177e4SLinus Torvalds /* 451da177e4SLinus Torvalds * Definitions & global arrays. 461da177e4SLinus Torvalds */ 471da177e4SLinus Torvalds 481da177e4SLinus Torvalds #define MAGELLAN_MAX_LENGTH 32 491da177e4SLinus Torvalds 501da177e4SLinus Torvalds static int magellan_buttons[] = { BTN_0, BTN_1, BTN_2, BTN_3, BTN_4, BTN_5, BTN_6, BTN_7, BTN_8 }; 511da177e4SLinus Torvalds static int magellan_axes[] = { ABS_X, ABS_Y, ABS_Z, ABS_RX, ABS_RY, ABS_RZ }; 521da177e4SLinus Torvalds 531da177e4SLinus Torvalds /* 541da177e4SLinus Torvalds * Per-Magellan data. 551da177e4SLinus Torvalds */ 561da177e4SLinus Torvalds 571da177e4SLinus Torvalds struct magellan { 5817dd3f0fSDmitry Torokhov struct input_dev *dev; 591da177e4SLinus Torvalds int idx; 601da177e4SLinus Torvalds unsigned char data[MAGELLAN_MAX_LENGTH]; 611da177e4SLinus Torvalds char phys[32]; 621da177e4SLinus Torvalds }; 631da177e4SLinus Torvalds 641da177e4SLinus Torvalds /* 651da177e4SLinus Torvalds * magellan_crunch_nibbles() verifies that the bytes sent from the Magellan 661da177e4SLinus Torvalds * have correct upper nibbles for the lower ones, if not, the packet will 671da177e4SLinus Torvalds * be thrown away. It also strips these upper halves to simplify further 681da177e4SLinus Torvalds * processing. 691da177e4SLinus Torvalds */ 701da177e4SLinus Torvalds 711da177e4SLinus Torvalds static int magellan_crunch_nibbles(unsigned char *data, int count) 721da177e4SLinus Torvalds { 731da177e4SLinus Torvalds static unsigned char nibbles[16] = "0AB3D56GH9:K<MN?"; 741da177e4SLinus Torvalds 751da177e4SLinus Torvalds do { 761da177e4SLinus Torvalds if (data[count] == nibbles[data[count] & 0xf]) 771da177e4SLinus Torvalds data[count] = data[count] & 0xf; 781da177e4SLinus Torvalds else 791da177e4SLinus Torvalds return -1; 801da177e4SLinus Torvalds } while (--count); 811da177e4SLinus Torvalds 821da177e4SLinus Torvalds return 0; 831da177e4SLinus Torvalds } 841da177e4SLinus Torvalds 851da177e4SLinus Torvalds static void magellan_process_packet(struct magellan* magellan, struct pt_regs *regs) 861da177e4SLinus Torvalds { 8717dd3f0fSDmitry Torokhov struct input_dev *dev = magellan->dev; 881da177e4SLinus Torvalds unsigned char *data = magellan->data; 891da177e4SLinus Torvalds int i, t; 901da177e4SLinus Torvalds 911da177e4SLinus Torvalds if (!magellan->idx) return; 921da177e4SLinus Torvalds 931da177e4SLinus Torvalds input_regs(dev, regs); 941da177e4SLinus Torvalds 951da177e4SLinus Torvalds switch (magellan->data[0]) { 961da177e4SLinus Torvalds 971da177e4SLinus Torvalds case 'd': /* Axis data */ 981da177e4SLinus Torvalds if (magellan->idx != 25) return; 991da177e4SLinus Torvalds if (magellan_crunch_nibbles(data, 24)) return; 1001da177e4SLinus Torvalds for (i = 0; i < 6; i++) 1011da177e4SLinus Torvalds input_report_abs(dev, magellan_axes[i], 1021da177e4SLinus Torvalds (data[(i << 2) + 1] << 12 | data[(i << 2) + 2] << 8 | 1031da177e4SLinus Torvalds data[(i << 2) + 3] << 4 | data[(i << 2) + 4]) - 32768); 1041da177e4SLinus Torvalds break; 1051da177e4SLinus Torvalds 1061da177e4SLinus Torvalds case 'k': /* Button data */ 1071da177e4SLinus Torvalds if (magellan->idx != 4) return; 1081da177e4SLinus Torvalds if (magellan_crunch_nibbles(data, 3)) return; 1091da177e4SLinus Torvalds t = (data[1] << 1) | (data[2] << 5) | data[3]; 1101da177e4SLinus Torvalds for (i = 0; i < 9; i++) input_report_key(dev, magellan_buttons[i], (t >> i) & 1); 1111da177e4SLinus Torvalds break; 1121da177e4SLinus Torvalds } 1131da177e4SLinus Torvalds 1141da177e4SLinus Torvalds input_sync(dev); 1151da177e4SLinus Torvalds } 1161da177e4SLinus Torvalds 1171da177e4SLinus Torvalds static irqreturn_t magellan_interrupt(struct serio *serio, 1181da177e4SLinus Torvalds unsigned char data, unsigned int flags, struct pt_regs *regs) 1191da177e4SLinus Torvalds { 1201da177e4SLinus Torvalds struct magellan* magellan = serio_get_drvdata(serio); 1211da177e4SLinus Torvalds 1221da177e4SLinus Torvalds if (data == '\r') { 1231da177e4SLinus Torvalds magellan_process_packet(magellan, regs); 1241da177e4SLinus Torvalds magellan->idx = 0; 1251da177e4SLinus Torvalds } else { 1261da177e4SLinus Torvalds if (magellan->idx < MAGELLAN_MAX_LENGTH) 1271da177e4SLinus Torvalds magellan->data[magellan->idx++] = data; 1281da177e4SLinus Torvalds } 1291da177e4SLinus Torvalds return IRQ_HANDLED; 1301da177e4SLinus Torvalds } 1311da177e4SLinus Torvalds 1321da177e4SLinus Torvalds /* 1331da177e4SLinus Torvalds * magellan_disconnect() is the opposite of magellan_connect() 1341da177e4SLinus Torvalds */ 1351da177e4SLinus Torvalds 1361da177e4SLinus Torvalds static void magellan_disconnect(struct serio *serio) 1371da177e4SLinus Torvalds { 1381da177e4SLinus Torvalds struct magellan* magellan = serio_get_drvdata(serio); 1391da177e4SLinus Torvalds 1401da177e4SLinus Torvalds serio_close(serio); 1411da177e4SLinus Torvalds serio_set_drvdata(serio, NULL); 14217dd3f0fSDmitry Torokhov input_unregister_device(magellan->dev); 1431da177e4SLinus Torvalds kfree(magellan); 1441da177e4SLinus Torvalds } 1451da177e4SLinus Torvalds 1461da177e4SLinus Torvalds /* 1471da177e4SLinus Torvalds * magellan_connect() is the routine that is called when someone adds a 1481da177e4SLinus Torvalds * new serio device that supports Magellan protocol and registers it as 1491da177e4SLinus Torvalds * an input device. 1501da177e4SLinus Torvalds */ 1511da177e4SLinus Torvalds 1521da177e4SLinus Torvalds static int magellan_connect(struct serio *serio, struct serio_driver *drv) 1531da177e4SLinus Torvalds { 1541da177e4SLinus Torvalds struct magellan *magellan; 15517dd3f0fSDmitry Torokhov struct input_dev *input_dev; 15617dd3f0fSDmitry Torokhov int err = -ENOMEM; 15717dd3f0fSDmitry Torokhov int i; 1581da177e4SLinus Torvalds 15917dd3f0fSDmitry Torokhov magellan = kzalloc(sizeof(struct magellan), GFP_KERNEL); 16017dd3f0fSDmitry Torokhov input_dev = input_allocate_device(); 16117dd3f0fSDmitry Torokhov if (!magellan || !input_dev) 16217dd3f0fSDmitry Torokhov goto fail; 1631da177e4SLinus Torvalds 16417dd3f0fSDmitry Torokhov magellan->dev = input_dev; 1651da177e4SLinus Torvalds sprintf(magellan->phys, "%s/input0", serio->phys); 1661da177e4SLinus Torvalds 16717dd3f0fSDmitry Torokhov input_dev->name = "LogiCad3D Magellan / SpaceMouse"; 16817dd3f0fSDmitry Torokhov input_dev->phys = magellan->phys; 16917dd3f0fSDmitry Torokhov input_dev->id.bustype = BUS_RS232; 17017dd3f0fSDmitry Torokhov input_dev->id.vendor = SERIO_MAGELLAN; 17117dd3f0fSDmitry Torokhov input_dev->id.product = 0x0001; 17217dd3f0fSDmitry Torokhov input_dev->id.version = 0x0100; 17317dd3f0fSDmitry Torokhov input_dev->cdev.dev = &serio->dev; 17417dd3f0fSDmitry Torokhov input_dev->private = magellan; 17517dd3f0fSDmitry Torokhov 17617dd3f0fSDmitry Torokhov input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_ABS); 17717dd3f0fSDmitry Torokhov 17817dd3f0fSDmitry Torokhov for (i = 0; i < 9; i++) 17917dd3f0fSDmitry Torokhov set_bit(magellan_buttons[i], input_dev->keybit); 18017dd3f0fSDmitry Torokhov 18117dd3f0fSDmitry Torokhov for (i = 0; i < 6; i++) 18217dd3f0fSDmitry Torokhov input_set_abs_params(input_dev, magellan_axes[i], -360, 360, 0, 0); 1831da177e4SLinus Torvalds 1841da177e4SLinus Torvalds serio_set_drvdata(serio, magellan); 1851da177e4SLinus Torvalds 1861da177e4SLinus Torvalds err = serio_open(serio, drv); 18717dd3f0fSDmitry Torokhov if (err) 18817dd3f0fSDmitry Torokhov goto fail; 18917dd3f0fSDmitry Torokhov 19017dd3f0fSDmitry Torokhov input_register_device(magellan->dev); 19117dd3f0fSDmitry Torokhov return 0; 19217dd3f0fSDmitry Torokhov 19317dd3f0fSDmitry Torokhov fail: serio_set_drvdata(serio, NULL); 19417dd3f0fSDmitry Torokhov input_free_device(input_dev); 1951da177e4SLinus Torvalds kfree(magellan); 1961da177e4SLinus Torvalds return err; 1971da177e4SLinus Torvalds } 1981da177e4SLinus Torvalds 1991da177e4SLinus Torvalds /* 2001da177e4SLinus Torvalds * The serio driver structure. 2011da177e4SLinus Torvalds */ 2021da177e4SLinus Torvalds 2031da177e4SLinus Torvalds static struct serio_device_id magellan_serio_ids[] = { 2041da177e4SLinus Torvalds { 2051da177e4SLinus Torvalds .type = SERIO_RS232, 2061da177e4SLinus Torvalds .proto = SERIO_MAGELLAN, 2071da177e4SLinus Torvalds .id = SERIO_ANY, 2081da177e4SLinus Torvalds .extra = SERIO_ANY, 2091da177e4SLinus Torvalds }, 2101da177e4SLinus Torvalds { 0 } 2111da177e4SLinus Torvalds }; 2121da177e4SLinus Torvalds 2131da177e4SLinus Torvalds MODULE_DEVICE_TABLE(serio, magellan_serio_ids); 2141da177e4SLinus Torvalds 2151da177e4SLinus Torvalds static struct serio_driver magellan_drv = { 2161da177e4SLinus Torvalds .driver = { 2171da177e4SLinus Torvalds .name = "magellan", 2181da177e4SLinus Torvalds }, 2191da177e4SLinus Torvalds .description = DRIVER_DESC, 2201da177e4SLinus Torvalds .id_table = magellan_serio_ids, 2211da177e4SLinus Torvalds .interrupt = magellan_interrupt, 2221da177e4SLinus Torvalds .connect = magellan_connect, 2231da177e4SLinus Torvalds .disconnect = magellan_disconnect, 2241da177e4SLinus Torvalds }; 2251da177e4SLinus Torvalds 2261da177e4SLinus Torvalds /* 2271da177e4SLinus Torvalds * The functions for inserting/removing us as a module. 2281da177e4SLinus Torvalds */ 2291da177e4SLinus Torvalds 2301da177e4SLinus Torvalds static int __init magellan_init(void) 2311da177e4SLinus Torvalds { 2321da177e4SLinus Torvalds serio_register_driver(&magellan_drv); 2331da177e4SLinus Torvalds return 0; 2341da177e4SLinus Torvalds } 2351da177e4SLinus Torvalds 2361da177e4SLinus Torvalds static void __exit magellan_exit(void) 2371da177e4SLinus Torvalds { 2381da177e4SLinus Torvalds serio_unregister_driver(&magellan_drv); 2391da177e4SLinus Torvalds } 2401da177e4SLinus Torvalds 2411da177e4SLinus Torvalds module_init(magellan_init); 2421da177e4SLinus Torvalds module_exit(magellan_exit); 243