11a59d1b8SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-or-later 21da177e4SLinus Torvalds /* 31da177e4SLinus Torvalds * Copyright (c) 1999-2001 Vojtech Pavlik 41da177e4SLinus Torvalds */ 51da177e4SLinus Torvalds 61da177e4SLinus Torvalds /* 71da177e4SLinus Torvalds * Magellan and Space Mouse 6dof controller driver for Linux 81da177e4SLinus Torvalds */ 91da177e4SLinus Torvalds 101da177e4SLinus Torvalds /* 111da177e4SLinus Torvalds */ 121da177e4SLinus Torvalds 131da177e4SLinus Torvalds #include <linux/kernel.h> 141da177e4SLinus Torvalds #include <linux/module.h> 151da177e4SLinus Torvalds #include <linux/slab.h> 161da177e4SLinus Torvalds #include <linux/input.h> 171da177e4SLinus Torvalds #include <linux/serio.h> 181da177e4SLinus Torvalds 191da177e4SLinus Torvalds #define DRIVER_DESC "Magellan and SpaceMouse 6dof controller driver" 201da177e4SLinus Torvalds 211da177e4SLinus Torvalds MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>"); 221da177e4SLinus Torvalds MODULE_DESCRIPTION(DRIVER_DESC); 231da177e4SLinus Torvalds MODULE_LICENSE("GPL"); 241da177e4SLinus Torvalds 251da177e4SLinus Torvalds /* 261da177e4SLinus Torvalds * Definitions & global arrays. 271da177e4SLinus Torvalds */ 281da177e4SLinus Torvalds 291da177e4SLinus Torvalds #define MAGELLAN_MAX_LENGTH 32 301da177e4SLinus Torvalds 311da177e4SLinus Torvalds static int magellan_buttons[] = { BTN_0, BTN_1, BTN_2, BTN_3, BTN_4, BTN_5, BTN_6, BTN_7, BTN_8 }; 321da177e4SLinus Torvalds static int magellan_axes[] = { ABS_X, ABS_Y, ABS_Z, ABS_RX, ABS_RY, ABS_RZ }; 331da177e4SLinus Torvalds 341da177e4SLinus Torvalds /* 351da177e4SLinus Torvalds * Per-Magellan data. 361da177e4SLinus Torvalds */ 371da177e4SLinus Torvalds 381da177e4SLinus Torvalds struct magellan { 3917dd3f0fSDmitry Torokhov struct input_dev *dev; 401da177e4SLinus Torvalds int idx; 411da177e4SLinus Torvalds unsigned char data[MAGELLAN_MAX_LENGTH]; 421da177e4SLinus Torvalds char phys[32]; 431da177e4SLinus Torvalds }; 441da177e4SLinus Torvalds 451da177e4SLinus Torvalds /* 461da177e4SLinus Torvalds * magellan_crunch_nibbles() verifies that the bytes sent from the Magellan 471da177e4SLinus Torvalds * have correct upper nibbles for the lower ones, if not, the packet will 481da177e4SLinus Torvalds * be thrown away. It also strips these upper halves to simplify further 491da177e4SLinus Torvalds * processing. 501da177e4SLinus Torvalds */ 511da177e4SLinus Torvalds 521da177e4SLinus Torvalds static int magellan_crunch_nibbles(unsigned char *data, int count) 531da177e4SLinus Torvalds { 541da177e4SLinus Torvalds static unsigned char nibbles[16] = "0AB3D56GH9:K<MN?"; 551da177e4SLinus Torvalds 561da177e4SLinus Torvalds do { 571da177e4SLinus Torvalds if (data[count] == nibbles[data[count] & 0xf]) 581da177e4SLinus Torvalds data[count] = data[count] & 0xf; 591da177e4SLinus Torvalds else 601da177e4SLinus Torvalds return -1; 611da177e4SLinus Torvalds } while (--count); 621da177e4SLinus Torvalds 631da177e4SLinus Torvalds return 0; 641da177e4SLinus Torvalds } 651da177e4SLinus Torvalds 667d12e780SDavid Howells static void magellan_process_packet(struct magellan* magellan) 671da177e4SLinus Torvalds { 6817dd3f0fSDmitry Torokhov struct input_dev *dev = magellan->dev; 691da177e4SLinus Torvalds unsigned char *data = magellan->data; 701da177e4SLinus Torvalds int i, t; 711da177e4SLinus Torvalds 721da177e4SLinus Torvalds if (!magellan->idx) return; 731da177e4SLinus Torvalds 741da177e4SLinus Torvalds switch (magellan->data[0]) { 751da177e4SLinus Torvalds 761da177e4SLinus Torvalds case 'd': /* Axis data */ 771da177e4SLinus Torvalds if (magellan->idx != 25) return; 781da177e4SLinus Torvalds if (magellan_crunch_nibbles(data, 24)) return; 791da177e4SLinus Torvalds for (i = 0; i < 6; i++) 801da177e4SLinus Torvalds input_report_abs(dev, magellan_axes[i], 811da177e4SLinus Torvalds (data[(i << 2) + 1] << 12 | data[(i << 2) + 2] << 8 | 821da177e4SLinus Torvalds data[(i << 2) + 3] << 4 | data[(i << 2) + 4]) - 32768); 831da177e4SLinus Torvalds break; 841da177e4SLinus Torvalds 851da177e4SLinus Torvalds case 'k': /* Button data */ 861da177e4SLinus Torvalds if (magellan->idx != 4) return; 871da177e4SLinus Torvalds if (magellan_crunch_nibbles(data, 3)) return; 881da177e4SLinus Torvalds t = (data[1] << 1) | (data[2] << 5) | data[3]; 891da177e4SLinus Torvalds for (i = 0; i < 9; i++) input_report_key(dev, magellan_buttons[i], (t >> i) & 1); 901da177e4SLinus Torvalds break; 911da177e4SLinus Torvalds } 921da177e4SLinus Torvalds 931da177e4SLinus Torvalds input_sync(dev); 941da177e4SLinus Torvalds } 951da177e4SLinus Torvalds 961da177e4SLinus Torvalds static irqreturn_t magellan_interrupt(struct serio *serio, 977d12e780SDavid Howells unsigned char data, unsigned int flags) 981da177e4SLinus Torvalds { 991da177e4SLinus Torvalds struct magellan* magellan = serio_get_drvdata(serio); 1001da177e4SLinus Torvalds 1011da177e4SLinus Torvalds if (data == '\r') { 1027d12e780SDavid Howells magellan_process_packet(magellan); 1031da177e4SLinus Torvalds magellan->idx = 0; 1041da177e4SLinus Torvalds } else { 1051da177e4SLinus Torvalds if (magellan->idx < MAGELLAN_MAX_LENGTH) 1061da177e4SLinus Torvalds magellan->data[magellan->idx++] = data; 1071da177e4SLinus Torvalds } 1081da177e4SLinus Torvalds return IRQ_HANDLED; 1091da177e4SLinus Torvalds } 1101da177e4SLinus Torvalds 1111da177e4SLinus Torvalds /* 1121da177e4SLinus Torvalds * magellan_disconnect() is the opposite of magellan_connect() 1131da177e4SLinus Torvalds */ 1141da177e4SLinus Torvalds 1151da177e4SLinus Torvalds static void magellan_disconnect(struct serio *serio) 1161da177e4SLinus Torvalds { 1171da177e4SLinus Torvalds struct magellan* magellan = serio_get_drvdata(serio); 1181da177e4SLinus Torvalds 1191da177e4SLinus Torvalds serio_close(serio); 1201da177e4SLinus Torvalds serio_set_drvdata(serio, NULL); 12117dd3f0fSDmitry Torokhov input_unregister_device(magellan->dev); 1221da177e4SLinus Torvalds kfree(magellan); 1231da177e4SLinus Torvalds } 1241da177e4SLinus Torvalds 1251da177e4SLinus Torvalds /* 1261da177e4SLinus Torvalds * magellan_connect() is the routine that is called when someone adds a 1271da177e4SLinus Torvalds * new serio device that supports Magellan protocol and registers it as 1281da177e4SLinus Torvalds * an input device. 1291da177e4SLinus Torvalds */ 1301da177e4SLinus Torvalds 1311da177e4SLinus Torvalds static int magellan_connect(struct serio *serio, struct serio_driver *drv) 1321da177e4SLinus Torvalds { 1331da177e4SLinus Torvalds struct magellan *magellan; 13417dd3f0fSDmitry Torokhov struct input_dev *input_dev; 13517dd3f0fSDmitry Torokhov int err = -ENOMEM; 13617dd3f0fSDmitry Torokhov int i; 1371da177e4SLinus Torvalds 13817dd3f0fSDmitry Torokhov magellan = kzalloc(sizeof(struct magellan), GFP_KERNEL); 13917dd3f0fSDmitry Torokhov input_dev = input_allocate_device(); 14017dd3f0fSDmitry Torokhov if (!magellan || !input_dev) 141127278ceSDmitry Torokhov goto fail1; 1421da177e4SLinus Torvalds 14317dd3f0fSDmitry Torokhov magellan->dev = input_dev; 14410ca4c0aSDmitry Torokhov snprintf(magellan->phys, sizeof(magellan->phys), "%s/input0", serio->phys); 1451da177e4SLinus Torvalds 14617dd3f0fSDmitry Torokhov input_dev->name = "LogiCad3D Magellan / SpaceMouse"; 14717dd3f0fSDmitry Torokhov input_dev->phys = magellan->phys; 14817dd3f0fSDmitry Torokhov input_dev->id.bustype = BUS_RS232; 14917dd3f0fSDmitry Torokhov input_dev->id.vendor = SERIO_MAGELLAN; 15017dd3f0fSDmitry Torokhov input_dev->id.product = 0x0001; 15117dd3f0fSDmitry Torokhov input_dev->id.version = 0x0100; 152935e658eSDmitry Torokhov input_dev->dev.parent = &serio->dev; 15317dd3f0fSDmitry Torokhov 1547b19ada2SJiri Slaby input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS); 15517dd3f0fSDmitry Torokhov 15617dd3f0fSDmitry Torokhov for (i = 0; i < 9; i++) 15717dd3f0fSDmitry Torokhov set_bit(magellan_buttons[i], input_dev->keybit); 15817dd3f0fSDmitry Torokhov 15917dd3f0fSDmitry Torokhov for (i = 0; i < 6; i++) 16017dd3f0fSDmitry Torokhov input_set_abs_params(input_dev, magellan_axes[i], -360, 360, 0, 0); 1611da177e4SLinus Torvalds 1621da177e4SLinus Torvalds serio_set_drvdata(serio, magellan); 1631da177e4SLinus Torvalds 1641da177e4SLinus Torvalds err = serio_open(serio, drv); 16517dd3f0fSDmitry Torokhov if (err) 166127278ceSDmitry Torokhov goto fail2; 16717dd3f0fSDmitry Torokhov 168127278ceSDmitry Torokhov err = input_register_device(magellan->dev); 169127278ceSDmitry Torokhov if (err) 170127278ceSDmitry Torokhov goto fail3; 171127278ceSDmitry Torokhov 17217dd3f0fSDmitry Torokhov return 0; 17317dd3f0fSDmitry Torokhov 174127278ceSDmitry Torokhov fail3: serio_close(serio); 175127278ceSDmitry Torokhov fail2: serio_set_drvdata(serio, NULL); 176127278ceSDmitry Torokhov fail1: input_free_device(input_dev); 1771da177e4SLinus Torvalds kfree(magellan); 1781da177e4SLinus Torvalds return err; 1791da177e4SLinus Torvalds } 1801da177e4SLinus Torvalds 1811da177e4SLinus Torvalds /* 1821da177e4SLinus Torvalds * The serio driver structure. 1831da177e4SLinus Torvalds */ 1841da177e4SLinus Torvalds 185f31103f8SArvind Yadav static const struct serio_device_id magellan_serio_ids[] = { 1861da177e4SLinus Torvalds { 1871da177e4SLinus Torvalds .type = SERIO_RS232, 1881da177e4SLinus Torvalds .proto = SERIO_MAGELLAN, 1891da177e4SLinus Torvalds .id = SERIO_ANY, 1901da177e4SLinus Torvalds .extra = SERIO_ANY, 1911da177e4SLinus Torvalds }, 1921da177e4SLinus Torvalds { 0 } 1931da177e4SLinus Torvalds }; 1941da177e4SLinus Torvalds 1951da177e4SLinus Torvalds MODULE_DEVICE_TABLE(serio, magellan_serio_ids); 1961da177e4SLinus Torvalds 1971da177e4SLinus Torvalds static struct serio_driver magellan_drv = { 1981da177e4SLinus Torvalds .driver = { 1991da177e4SLinus Torvalds .name = "magellan", 2001da177e4SLinus Torvalds }, 2011da177e4SLinus Torvalds .description = DRIVER_DESC, 2021da177e4SLinus Torvalds .id_table = magellan_serio_ids, 2031da177e4SLinus Torvalds .interrupt = magellan_interrupt, 2041da177e4SLinus Torvalds .connect = magellan_connect, 2051da177e4SLinus Torvalds .disconnect = magellan_disconnect, 2061da177e4SLinus Torvalds }; 2071da177e4SLinus Torvalds 20865ac9f7aSAxel Lin module_serio_driver(magellan_drv); 209