input/joystick/magellan.c

0001 // SPDX-License-Identifier: GPL-2.0-or-later
0002 /*
0003  *  Copyright (c) 1999-2001 Vojtech Pavlik
0004  */
0005
0006 /*
0007  * Magellan and Space Mouse 6dof controller driver for Linux
0008  */
0009
0010 /*
0011  */
0012
0013 #include <linux/kernel.h>
0014 #include <linux/module.h>
0015 #include <linux/slab.h>
0016 #include <linux/input.h>
0017 #include <linux/serio.h>
0018
0019 #define DRIVER_DESC "Magellan and SpaceMouse 6dof controller driver"
0020
0021 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
0022 MODULE_DESCRIPTION(DRIVER_DESC);
0023 MODULE_LICENSE("GPL");
0024
0025 /*
0026  * Definitions & global arrays.
0027  */
0028
0029 #define MAGELLAN_MAX_LENGTH 32
0030
0031 static int magellan_buttons[] = { BTN_0, BTN_1, BTN_2, BTN_3, BTN_4, BTN_5, BTN_6, BTN_7, BTN_8 };
0032 static int magellan_axes[] = { ABS_X, ABS_Y, ABS_Z, ABS_RX, ABS_RY, ABS_RZ };
0033
0034 /*
0035  * Per-Magellan data.
0036  */
0037
0038 struct magellan {
0039     struct input_dev *dev;
0040     int idx;
0041     unsigned char data[MAGELLAN_MAX_LENGTH];
0042     char phys[32];
0043 };
0044
0045 /*
0046  * magellan_crunch_nibbles() verifies that the bytes sent from the Magellan
0047  * have correct upper nibbles for the lower ones, if not, the packet will
0048  * be thrown away. It also strips these upper halves to simplify further
0049  * processing.
0050  */
0051
0052 static int magellan_crunch_nibbles(unsigned char *data, int count)
0053 {
0054     static unsigned char nibbles[16] = "0AB3D56GH9:K<MN?";
0055
0056     do {
0057         if (data[count] == nibbles[data[count] & 0xf])
0058             data[count] = data[count] & 0xf;
0059         else
0060             return -1;
0061     } while (--count);
0062
0063     return 0;
0064 }
0065
0066 static void magellan_process_packet(struct magellan* magellan)
0067 {
0068     struct input_dev *dev = magellan->dev;
0069     unsigned char *data = magellan->data;
0070     int i, t;
0071
0072     if (!magellan->idx) return;
0073
0074     switch (magellan->data[0]) {
0075
0076         case 'd':               /* Axis data */
0077             if (magellan->idx != 25) return;
0078             if (magellan_crunch_nibbles(data, 24)) return;
0079             for (i = 0; i < 6; i++)
0080                 input_report_abs(dev, magellan_axes[i],
0081                     (data[(i << 2) + 1] << 12 | data[(i << 2) + 2] << 8 |
0082                      data[(i << 2) + 3] <<  4 | data[(i << 2) + 4]) - 32768);
0083             break;
0084
0085         case 'k':               /* Button data */
0086             if (magellan->idx != 4) return;
0087             if (magellan_crunch_nibbles(data, 3)) return;
0088             t = (data[1] << 1) | (data[2] << 5) | data[3];
0089             for (i = 0; i < 9; i++) input_report_key(dev, magellan_buttons[i], (t >> i) & 1);
0090             break;
0091     }
0092
0093     input_sync(dev);
0094 }
0095
0096 static irqreturn_t magellan_interrupt(struct serio *serio,
0097         unsigned char data, unsigned int flags)
0098 {
0099     struct magellan* magellan = serio_get_drvdata(serio);
0100
0101     if (data == '\r') {
0102         magellan_process_packet(magellan);
0103         magellan->idx = 0;
0104     } else {
0105         if (magellan->idx < MAGELLAN_MAX_LENGTH)
0106             magellan->data[magellan->idx++] = data;
0107     }
0108     return IRQ_HANDLED;
0109 }
0110
0111 /*
0112  * magellan_disconnect() is the opposite of magellan_connect()
0113  */
0114
0115 static void magellan_disconnect(struct serio *serio)
0116 {
0117     struct magellan* magellan = serio_get_drvdata(serio);
0118
0119     serio_close(serio);
0120     serio_set_drvdata(serio, NULL);
0121     input_unregister_device(magellan->dev);
0122     kfree(magellan);
0123 }
0124
0125 /*
0126  * magellan_connect() is the routine that is called when someone adds a
0127  * new serio device that supports Magellan protocol and registers it as
0128  * an input device.
0129  */
0130
0131 static int magellan_connect(struct serio *serio, struct serio_driver *drv)
0132 {
0133     struct magellan *magellan;
0134     struct input_dev *input_dev;
0135     int err = -ENOMEM;
0136     int i;
0137
0138     magellan = kzalloc(sizeof(struct magellan), GFP_KERNEL);
0139     input_dev = input_allocate_device();
0140     if (!magellan || !input_dev)
0141         goto fail1;
0142
0143     magellan->dev = input_dev;
0144     snprintf(magellan->phys, sizeof(magellan->phys), "%s/input0", serio->phys);
0145
0146     input_dev->name = "LogiCad3D Magellan / SpaceMouse";
0147     input_dev->phys = magellan->phys;
0148     input_dev->id.bustype = BUS_RS232;
0149     input_dev->id.vendor = SERIO_MAGELLAN;
0150     input_dev->id.product = 0x0001;
0151     input_dev->id.version = 0x0100;
0152     input_dev->dev.parent = &serio->dev;
0153
0154     input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
0155
0156     for (i = 0; i < 9; i++)
0157         set_bit(magellan_buttons[i], input_dev->keybit);
0158
0159     for (i = 0; i < 6; i++)
0160         input_set_abs_params(input_dev, magellan_axes[i], -360, 360, 0, 0);
0161
0162     serio_set_drvdata(serio, magellan);
0163
0164     err = serio_open(serio, drv);
0165     if (err)
0166         goto fail2;
0167
0168     err = input_register_device(magellan->dev);
0169     if (err)
0170         goto fail3;
0171
0172     return 0;
0173
0174  fail3: serio_close(serio);
0175  fail2: serio_set_drvdata(serio, NULL);
0176  fail1: input_free_device(input_dev);
0177     kfree(magellan);
0178     return err;
0179 }
0180
0181 /*
0182  * The serio driver structure.
0183  */
0184
0185 static const struct serio_device_id magellan_serio_ids[] = {
0186     {
0187         .type   = SERIO_RS232,
0188         .proto  = SERIO_MAGELLAN,
0189         .id = SERIO_ANY,
0190         .extra  = SERIO_ANY,
0191     },
0192     { 0 }
0193 };
0194
0195 MODULE_DEVICE_TABLE(serio, magellan_serio_ids);
0196
0197 static struct serio_driver magellan_drv = {
0198     .driver     = {
0199         .name   = "magellan",
0200     },
0201     .description    = DRIVER_DESC,
0202     .id_table   = magellan_serio_ids,
0203     .interrupt  = magellan_interrupt,
0204     .connect    = magellan_connect,
0205     .disconnect = magellan_disconnect,
0206 };
0207
0208 module_serio_driver(magellan_drv);