input/joystick/gf2k.c

0001 // SPDX-License-Identifier: GPL-2.0-or-later
0002 /*
0003  *  Copyright (c) 1998-2001 Vojtech Pavlik
0004  */
0005
0006 /*
0007  * Genius Flight 2000 joystick driver for Linux
0008  */
0009
0010 /*
0011  */
0012
0013 #include <linux/delay.h>
0014 #include <linux/kernel.h>
0015 #include <linux/slab.h>
0016 #include <linux/module.h>
0017 #include <linux/input.h>
0018 #include <linux/gameport.h>
0019 #include <linux/jiffies.h>
0020
0021 #define DRIVER_DESC "Genius Flight 2000 joystick driver"
0022
0023 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
0024 MODULE_DESCRIPTION(DRIVER_DESC);
0025 MODULE_LICENSE("GPL");
0026
0027 #define GF2K_START      400 /* The time we wait for the first bit [400 us] */
0028 #define GF2K_STROBE     40  /* The time we wait for the first bit [40 us] */
0029 #define GF2K_TIMEOUT        4   /* Wait for everything to settle [4 ms] */
0030 #define GF2K_LENGTH     80  /* Max number of triplets in a packet */
0031
0032 /*
0033  * Genius joystick ids ...
0034  */
0035
0036 #define GF2K_ID_G09     1
0037 #define GF2K_ID_F30D        2
0038 #define GF2K_ID_F30     3
0039 #define GF2K_ID_F31D        4
0040 #define GF2K_ID_F305        5
0041 #define GF2K_ID_F23P        6
0042 #define GF2K_ID_F31     7
0043 #define GF2K_ID_MAX     7
0044
0045 static char gf2k_length[] = { 40, 40, 40, 40, 40, 40, 40, 40 };
0046 static char gf2k_hat_to_axis[][2] = {{ 0, 0}, { 0,-1}, { 1,-1}, { 1, 0}, { 1, 1}, { 0, 1}, {-1, 1}, {-1, 0}, {-1,-1}};
0047
0048 static char *gf2k_names[] = {"", "Genius G-09D", "Genius F-30D", "Genius F-30", "Genius MaxFighter F-31D",
0049                 "Genius F-30-5", "Genius Flight2000 F-23", "Genius F-31"};
0050 static unsigned char gf2k_hats[] = { 0, 2, 0, 0, 2, 0, 2, 0 };
0051 static unsigned char gf2k_axes[] = { 0, 2, 0, 0, 4, 0, 4, 0 };
0052 static unsigned char gf2k_joys[] = { 0, 0, 0, 0,10, 0, 8, 0 };
0053 static unsigned char gf2k_pads[] = { 0, 6, 0, 0, 0, 0, 0, 0 };
0054 static unsigned char gf2k_lens[] = { 0,18, 0, 0,18, 0,18, 0 };
0055
0056 static unsigned char gf2k_abs[] = { ABS_X, ABS_Y, ABS_THROTTLE, ABS_RUDDER, ABS_GAS, ABS_BRAKE };
0057 static short gf2k_btn_joy[] = { BTN_TRIGGER, BTN_THUMB, BTN_TOP, BTN_TOP2, BTN_BASE, BTN_BASE2, BTN_BASE3, BTN_BASE4 };
0058 static short gf2k_btn_pad[] = { BTN_A, BTN_B, BTN_C, BTN_X, BTN_Y, BTN_Z, BTN_TL, BTN_TR, BTN_TL2, BTN_TR2, BTN_START, BTN_SELECT };
0059
0060
0061 static short gf2k_seq_reset[] = { 240, 340, 0 };
0062 static short gf2k_seq_digital[] = { 590, 320, 860, 0 };
0063
0064 struct gf2k {
0065     struct gameport *gameport;
0066     struct input_dev *dev;
0067     int reads;
0068     int bads;
0069     unsigned char id;
0070     unsigned char length;
0071     char phys[32];
0072 };
0073
0074 /*
0075  * gf2k_read_packet() reads a Genius Flight2000 packet.
0076  */
0077
0078 static int gf2k_read_packet(struct gameport *gameport, int length, char *data)
0079 {
0080     unsigned char u, v;
0081     int i;
0082     unsigned int t, p;
0083     unsigned long flags;
0084
0085     t = gameport_time(gameport, GF2K_START);
0086     p = gameport_time(gameport, GF2K_STROBE);
0087
0088     i = 0;
0089
0090     local_irq_save(flags);
0091
0092     gameport_trigger(gameport);
0093     v = gameport_read(gameport);
0094
0095     while (t > 0 && i < length) {
0096         t--; u = v;
0097         v = gameport_read(gameport);
0098         if (v & ~u & 0x10) {
0099             data[i++] = v >> 5;
0100             t = p;
0101         }
0102     }
0103
0104     local_irq_restore(flags);
0105
0106     return i;
0107 }
0108
0109 /*
0110  * gf2k_trigger_seq() initializes a Genius Flight2000 joystick
0111  * into digital mode.
0112  */
0113
0114 static void gf2k_trigger_seq(struct gameport *gameport, short *seq)
0115 {
0116
0117     unsigned long flags;
0118     int i, t;
0119
0120         local_irq_save(flags);
0121
0122     i = 0;
0123         do {
0124         gameport_trigger(gameport);
0125         t = gameport_time(gameport, GF2K_TIMEOUT * 1000);
0126         while ((gameport_read(gameport) & 1) && t) t--;
0127                 udelay(seq[i]);
0128         } while (seq[++i]);
0129
0130     gameport_trigger(gameport);
0131
0132     local_irq_restore(flags);
0133 }
0134
0135 /*
0136  * js_sw_get_bits() composes bits from the triplet buffer into a __u64.
0137  * Parameter 'pos' is bit number inside packet where to start at, 'num' is number
0138  * of bits to be read, 'shift' is offset in the resulting __u64 to start at, bits
0139  * is number of bits per triplet.
0140  */
0141
0142 #define GB(p,n,s)   gf2k_get_bits(data, p, n, s)
0143
0144 static int gf2k_get_bits(unsigned char *buf, int pos, int num, int shift)
0145 {
0146     __u64 data = 0;
0147     int i;
0148
0149     for (i = 0; i < num / 3 + 2; i++)
0150         data |= buf[pos / 3 + i] << (i * 3);
0151     data >>= pos % 3;
0152     data &= (1 << num) - 1;
0153     data <<= shift;
0154
0155     return data;
0156 }
0157
0158 static void gf2k_read(struct gf2k *gf2k, unsigned char *data)
0159 {
0160     struct input_dev *dev = gf2k->dev;
0161     int i, t;
0162
0163     for (i = 0; i < 4 && i < gf2k_axes[gf2k->id]; i++)
0164         input_report_abs(dev, gf2k_abs[i], GB(i<<3,8,0) | GB(i+46,1,8) | GB(i+50,1,9));
0165
0166     for (i = 0; i < 2 && i < gf2k_axes[gf2k->id] - 4; i++)
0167         input_report_abs(dev, gf2k_abs[i], GB(i*9+60,8,0) | GB(i+54,1,9));
0168
0169     t = GB(40,4,0);
0170
0171     for (i = 0; i < gf2k_hats[gf2k->id]; i++)
0172         input_report_abs(dev, ABS_HAT0X + i, gf2k_hat_to_axis[t][i]);
0173
0174     t = GB(44,2,0) | GB(32,8,2) | GB(78,2,10);
0175
0176     for (i = 0; i < gf2k_joys[gf2k->id]; i++)
0177         input_report_key(dev, gf2k_btn_joy[i], (t >> i) & 1);
0178
0179     for (i = 0; i < gf2k_pads[gf2k->id]; i++)
0180         input_report_key(dev, gf2k_btn_pad[i], (t >> i) & 1);
0181
0182     input_sync(dev);
0183 }
0184
0185 /*
0186  * gf2k_poll() reads and analyzes Genius joystick data.
0187  */
0188
0189 static void gf2k_poll(struct gameport *gameport)
0190 {
0191     struct gf2k *gf2k = gameport_get_drvdata(gameport);
0192     unsigned char data[GF2K_LENGTH];
0193
0194     gf2k->reads++;
0195
0196     if (gf2k_read_packet(gf2k->gameport, gf2k_length[gf2k->id], data) < gf2k_length[gf2k->id])
0197         gf2k->bads++;
0198     else
0199         gf2k_read(gf2k, data);
0200 }
0201
0202 static int gf2k_open(struct input_dev *dev)
0203 {
0204     struct gf2k *gf2k = input_get_drvdata(dev);
0205
0206     gameport_start_polling(gf2k->gameport);
0207     return 0;
0208 }
0209
0210 static void gf2k_close(struct input_dev *dev)
0211 {
0212     struct gf2k *gf2k = input_get_drvdata(dev);
0213
0214     gameport_stop_polling(gf2k->gameport);
0215 }
0216
0217 /*
0218  * gf2k_connect() probes for Genius id joysticks.
0219  */
0220
0221 static int gf2k_connect(struct gameport *gameport, struct gameport_driver *drv)
0222 {
0223     struct gf2k *gf2k;
0224     struct input_dev *input_dev;
0225     unsigned char data[GF2K_LENGTH];
0226     int i, err;
0227
0228     gf2k = kzalloc(sizeof(struct gf2k), GFP_KERNEL);
0229     input_dev = input_allocate_device();
0230     if (!gf2k || !input_dev) {
0231         err = -ENOMEM;
0232         goto fail1;
0233     }
0234
0235     gf2k->gameport = gameport;
0236     gf2k->dev = input_dev;
0237
0238     gameport_set_drvdata(gameport, gf2k);
0239
0240     err = gameport_open(gameport, drv, GAMEPORT_MODE_RAW);
0241     if (err)
0242         goto fail1;
0243
0244     gf2k_trigger_seq(gameport, gf2k_seq_reset);
0245
0246     msleep(GF2K_TIMEOUT);
0247
0248     gf2k_trigger_seq(gameport, gf2k_seq_digital);
0249
0250     msleep(GF2K_TIMEOUT);
0251
0252     if (gf2k_read_packet(gameport, GF2K_LENGTH, data) < 12) {
0253         err = -ENODEV;
0254         goto fail2;
0255     }
0256
0257     if (!(gf2k->id = GB(7,2,0) | GB(3,3,2) | GB(0,3,5))) {
0258         err = -ENODEV;
0259         goto fail2;
0260     }
0261
0262 #ifdef RESET_WORKS
0263     if ((gf2k->id != (GB(19,2,0) | GB(15,3,2) | GB(12,3,5))) &&
0264         (gf2k->id != (GB(31,2,0) | GB(27,3,2) | GB(24,3,5)))) {
0265         err = -ENODEV;
0266         goto fail2;
0267     }
0268 #else
0269     gf2k->id = 6;
0270 #endif
0271
0272     if (gf2k->id > GF2K_ID_MAX || !gf2k_axes[gf2k->id]) {
0273         printk(KERN_WARNING "gf2k.c: Not yet supported joystick on %s. [id: %d type:%s]\n",
0274             gameport->phys, gf2k->id, gf2k->id > GF2K_ID_MAX ? "Unknown" : gf2k_names[gf2k->id]);
0275         err = -ENODEV;
0276         goto fail2;
0277     }
0278
0279     gameport_set_poll_handler(gameport, gf2k_poll);
0280     gameport_set_poll_interval(gameport, 20);
0281
0282     snprintf(gf2k->phys, sizeof(gf2k->phys), "%s/input0", gameport->phys);
0283
0284     gf2k->length = gf2k_lens[gf2k->id];
0285
0286     input_dev->name = gf2k_names[gf2k->id];
0287     input_dev->phys = gf2k->phys;
0288     input_dev->id.bustype = BUS_GAMEPORT;
0289     input_dev->id.vendor = GAMEPORT_ID_VENDOR_GENIUS;
0290     input_dev->id.product = gf2k->id;
0291     input_dev->id.version = 0x0100;
0292     input_dev->dev.parent = &gameport->dev;
0293
0294     input_set_drvdata(input_dev, gf2k);
0295
0296     input_dev->open = gf2k_open;
0297     input_dev->close = gf2k_close;
0298
0299     input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
0300
0301     for (i = 0; i < gf2k_axes[gf2k->id]; i++)
0302         set_bit(gf2k_abs[i], input_dev->absbit);
0303
0304     for (i = 0; i < gf2k_hats[gf2k->id]; i++)
0305         input_set_abs_params(input_dev, ABS_HAT0X + i, -1, 1, 0, 0);
0306
0307     for (i = 0; i < gf2k_joys[gf2k->id]; i++)
0308         set_bit(gf2k_btn_joy[i], input_dev->keybit);
0309
0310     for (i = 0; i < gf2k_pads[gf2k->id]; i++)
0311         set_bit(gf2k_btn_pad[i], input_dev->keybit);
0312
0313     gf2k_read_packet(gameport, gf2k->length, data);
0314     gf2k_read(gf2k, data);
0315
0316     for (i = 0; i < gf2k_axes[gf2k->id]; i++) {
0317         int max = i < 2 ?
0318             input_abs_get_val(input_dev, gf2k_abs[i]) * 2 :
0319             input_abs_get_val(input_dev, gf2k_abs[0]) +
0320                 input_abs_get_val(input_dev, gf2k_abs[1]);
0321         int flat = i < 2 ? 24 : 0;
0322
0323         input_set_abs_params(input_dev, gf2k_abs[i],
0324                      32, max - 32, 8, flat);
0325     }
0326
0327     err = input_register_device(gf2k->dev);
0328     if (err)
0329         goto fail2;
0330
0331     return 0;
0332
0333  fail2: gameport_close(gameport);
0334  fail1: gameport_set_drvdata(gameport, NULL);
0335     input_free_device(input_dev);
0336     kfree(gf2k);
0337     return err;
0338 }
0339
0340 static void gf2k_disconnect(struct gameport *gameport)
0341 {
0342     struct gf2k *gf2k = gameport_get_drvdata(gameport);
0343
0344     input_unregister_device(gf2k->dev);
0345     gameport_close(gameport);
0346     gameport_set_drvdata(gameport, NULL);
0347     kfree(gf2k);
0348 }
0349
0350 static struct gameport_driver gf2k_drv = {
0351     .driver     = {
0352         .name   = "gf2k",
0353     },
0354     .description    = DRIVER_DESC,
0355     .connect    = gf2k_connect,
0356     .disconnect = gf2k_disconnect,
0357 };
0358
0359 module_gameport_driver(gf2k_drv);