input/joystick/spaceorb.c

0001 // SPDX-License-Identifier: GPL-2.0-or-later
0002 /*
0003  *  Copyright (c) 1999-2001 Vojtech Pavlik
0004  *
0005  *  Based on the work of:
0006  *  David Thompson
0007  */
0008
0009 /*
0010  * SpaceTec SpaceOrb 360 and Avenger 6dof controller driver for Linux
0011  */
0012
0013 /*
0014  */
0015
0016 #include <linux/kernel.h>
0017 #include <linux/slab.h>
0018 #include <linux/module.h>
0019 #include <linux/input.h>
0020 #include <linux/serio.h>
0021
0022 #define DRIVER_DESC "SpaceTec SpaceOrb 360 and Avenger 6dof controller driver"
0023
0024 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
0025 MODULE_DESCRIPTION(DRIVER_DESC);
0026 MODULE_LICENSE("GPL");
0027
0028 /*
0029  * Constants.
0030  */
0031
0032 #define SPACEORB_MAX_LENGTH 64
0033
0034 static int spaceorb_buttons[] = { BTN_TL, BTN_TR, BTN_Y, BTN_X, BTN_B, BTN_A };
0035 static int spaceorb_axes[] = { ABS_X, ABS_Y, ABS_Z, ABS_RX, ABS_RY, ABS_RZ };
0036
0037 /*
0038  * Per-Orb data.
0039  */
0040
0041 struct spaceorb {
0042     struct input_dev *dev;
0043     int idx;
0044     unsigned char data[SPACEORB_MAX_LENGTH];
0045     char phys[32];
0046 };
0047
0048 static unsigned char spaceorb_xor[] = "SpaceWare";
0049
0050 static unsigned char *spaceorb_errors[] = { "EEPROM storing 0 failed", "Receive queue overflow", "Transmit queue timeout",
0051         "Bad packet", "Power brown-out", "EEPROM checksum error", "Hardware fault" };
0052
0053 /*
0054  * spaceorb_process_packet() decodes packets the driver receives from the
0055  * SpaceOrb.
0056  */
0057
0058 static void spaceorb_process_packet(struct spaceorb *spaceorb)
0059 {
0060     struct input_dev *dev = spaceorb->dev;
0061     unsigned char *data = spaceorb->data;
0062     unsigned char c = 0;
0063     int axes[6];
0064     int i;
0065
0066     if (spaceorb->idx < 2) return;
0067     for (i = 0; i < spaceorb->idx; i++) c ^= data[i];
0068     if (c) return;
0069
0070     switch (data[0]) {
0071
0072         case 'R':               /* Reset packet */
0073             spaceorb->data[spaceorb->idx - 1] = 0;
0074             for (i = 1; i < spaceorb->idx && spaceorb->data[i] == ' '; i++);
0075             printk(KERN_INFO "input: %s [%s] is %s\n",
0076                  dev->name, spaceorb->data + i, spaceorb->phys);
0077             break;
0078
0079         case 'D':               /* Ball + button data */
0080             if (spaceorb->idx != 12) return;
0081             for (i = 0; i < 9; i++) spaceorb->data[i+2] ^= spaceorb_xor[i];
0082             axes[0] = ( data[2]  << 3) | (data[ 3] >> 4);
0083             axes[1] = ((data[3] & 0x0f) << 6) | (data[ 4] >> 1);
0084             axes[2] = ((data[4] & 0x01) << 9) | (data[ 5] << 2) | (data[4] >> 5);
0085             axes[3] = ((data[6] & 0x1f) << 5) | (data[ 7] >> 2);
0086             axes[4] = ((data[7] & 0x03) << 8) | (data[ 8] << 1) | (data[7] >> 6);
0087             axes[5] = ((data[9] & 0x3f) << 4) | (data[10] >> 3);
0088             for (i = 0; i < 6; i++)
0089                 input_report_abs(dev, spaceorb_axes[i], axes[i] - ((axes[i] & 0x200) ? 1024 : 0));
0090             for (i = 0; i < 6; i++)
0091                 input_report_key(dev, spaceorb_buttons[i], (data[1] >> i) & 1);
0092             break;
0093
0094         case 'K':               /* Button data */
0095             if (spaceorb->idx != 5) return;
0096             for (i = 0; i < 6; i++)
0097                 input_report_key(dev, spaceorb_buttons[i], (data[2] >> i) & 1);
0098
0099             break;
0100
0101         case 'E':               /* Error packet */
0102             if (spaceorb->idx != 4) return;
0103             printk(KERN_ERR "spaceorb: Device error. [ ");
0104             for (i = 0; i < 7; i++) if (data[1] & (1 << i)) printk("%s ", spaceorb_errors[i]);
0105             printk("]\n");
0106             break;
0107     }
0108
0109     input_sync(dev);
0110 }
0111
0112 static irqreturn_t spaceorb_interrupt(struct serio *serio,
0113         unsigned char data, unsigned int flags)
0114 {
0115     struct spaceorb* spaceorb = serio_get_drvdata(serio);
0116
0117     if (~data & 0x80) {
0118         if (spaceorb->idx) spaceorb_process_packet(spaceorb);
0119         spaceorb->idx = 0;
0120     }
0121     if (spaceorb->idx < SPACEORB_MAX_LENGTH)
0122         spaceorb->data[spaceorb->idx++] = data & 0x7f;
0123     return IRQ_HANDLED;
0124 }
0125
0126 /*
0127  * spaceorb_disconnect() is the opposite of spaceorb_connect()
0128  */
0129
0130 static void spaceorb_disconnect(struct serio *serio)
0131 {
0132     struct spaceorb* spaceorb = serio_get_drvdata(serio);
0133
0134     serio_close(serio);
0135     serio_set_drvdata(serio, NULL);
0136     input_unregister_device(spaceorb->dev);
0137     kfree(spaceorb);
0138 }
0139
0140 /*
0141  * spaceorb_connect() is the routine that is called when someone adds a
0142  * new serio device that supports SpaceOrb/Avenger protocol and registers
0143  * it as an input device.
0144  */
0145
0146 static int spaceorb_connect(struct serio *serio, struct serio_driver *drv)
0147 {
0148     struct spaceorb *spaceorb;
0149     struct input_dev *input_dev;
0150     int err = -ENOMEM;
0151     int i;
0152
0153     spaceorb = kzalloc(sizeof(struct spaceorb), GFP_KERNEL);
0154     input_dev = input_allocate_device();
0155     if (!spaceorb || !input_dev)
0156         goto fail1;
0157
0158     spaceorb->dev = input_dev;
0159     snprintf(spaceorb->phys, sizeof(spaceorb->phys), "%s/input0", serio->phys);
0160
0161     input_dev->name = "SpaceTec SpaceOrb 360 / Avenger";
0162     input_dev->phys = spaceorb->phys;
0163     input_dev->id.bustype = BUS_RS232;
0164     input_dev->id.vendor = SERIO_SPACEORB;
0165     input_dev->id.product = 0x0001;
0166     input_dev->id.version = 0x0100;
0167     input_dev->dev.parent = &serio->dev;
0168
0169     input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
0170
0171     for (i = 0; i < 6; i++)
0172         set_bit(spaceorb_buttons[i], input_dev->keybit);
0173
0174     for (i = 0; i < 6; i++)
0175         input_set_abs_params(input_dev, spaceorb_axes[i], -508, 508, 0, 0);
0176
0177     serio_set_drvdata(serio, spaceorb);
0178
0179     err = serio_open(serio, drv);
0180     if (err)
0181         goto fail2;
0182
0183     err = input_register_device(spaceorb->dev);
0184     if (err)
0185         goto fail3;
0186
0187     return 0;
0188
0189  fail3: serio_close(serio);
0190  fail2: serio_set_drvdata(serio, NULL);
0191  fail1: input_free_device(input_dev);
0192     kfree(spaceorb);
0193     return err;
0194 }
0195
0196 /*
0197  * The serio driver structure.
0198  */
0199
0200 static const struct serio_device_id spaceorb_serio_ids[] = {
0201     {
0202         .type   = SERIO_RS232,
0203         .proto  = SERIO_SPACEORB,
0204         .id = SERIO_ANY,
0205         .extra  = SERIO_ANY,
0206     },
0207     { 0 }
0208 };
0209
0210 MODULE_DEVICE_TABLE(serio, spaceorb_serio_ids);
0211
0212 static struct serio_driver spaceorb_drv = {
0213     .driver     = {
0214         .name   = "spaceorb",
0215     },
0216     .description    = DRIVER_DESC,
0217     .id_table   = spaceorb_serio_ids,
0218     .interrupt  = spaceorb_interrupt,
0219     .connect    = spaceorb_connect,
0220     .disconnect = spaceorb_disconnect,
0221 };
0222
0223 module_serio_driver(spaceorb_drv);