drivers/input/joystick/turbografx.c

   1 /*
   2  *  Copyright (c) 1998-2001 Vojtech Pavlik
   3  *
   4  *  Based on the work of:
   5  *      Steffen Schwenke
   6  */
   7
   8 /*
   9  * TurboGraFX parallel port interface driver for Linux.
  10  */
  11
  12 /*
  13  * This program is free software; you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation; either version 2 of the License, or
  16  * (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License
  24  * along with this program; if not, write to the Free Software
  25  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  26  *
  27  * Should you need to contact me, the author, you can do so either by
  28  * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
  29  * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
  30  */
  31
  32 #include <linux/kernel.h>
  33 #include <linux/parport.h>
  34 #include <linux/input.h>
  35 #include <linux/module.h>
  36 #include <linux/init.h>
  37 #include <linux/mutex.h>
  38
  39 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
  40 MODULE_DESCRIPTION("TurboGraFX parallel port interface driver");
  41 MODULE_LICENSE("GPL");
  42
  43 #define TGFX_MAX_PORTS          3
  44 #define TGFX_MAX_DEVICES        7
  45
  46 struct tgfx_config {
  47         int args[TGFX_MAX_DEVICES + 1];
  48         unsigned int nargs;
  49 };
  50
  51 static struct tgfx_config tgfx_cfg[TGFX_MAX_PORTS] __initdata;
  52
  53 module_param_array_named(map, tgfx_cfg[0].args, int, &tgfx_cfg[0].nargs, 0);
  54 MODULE_PARM_DESC(map, "Describes first set of devices (<parport#>,<js1>,<js2>,..<js7>");
  55 module_param_array_named(map2, tgfx_cfg[1].args, int, &tgfx_cfg[1].nargs, 0);
  56 MODULE_PARM_DESC(map2, "Describes second set of devices");
  57 module_param_array_named(map3, tgfx_cfg[2].args, int, &tgfx_cfg[2].nargs, 0);
  58 MODULE_PARM_DESC(map3, "Describes third set of devices");
  59
  60 #define TGFX_REFRESH_TIME       HZ/100  /* 10 ms */
  61
  62 #define TGFX_TRIGGER            0x08
  63 #define TGFX_UP                 0x10
  64 #define TGFX_DOWN               0x20
  65 #define TGFX_LEFT               0x40
  66 #define TGFX_RIGHT              0x80
  67
  68 #define TGFX_THUMB              0x02
  69 #define TGFX_THUMB2             0x04
  70 #define TGFX_TOP                0x01
  71 #define TGFX_TOP2               0x08
  72
  73 static int tgfx_buttons[] = { BTN_TRIGGER, BTN_THUMB, BTN_THUMB2, BTN_TOP, BTN_TOP2 };
  74
  75 static struct tgfx {
  76         struct pardevice *pd;
  77         struct timer_list timer;
  78         struct input_dev *dev[TGFX_MAX_DEVICES];
  79         char name[TGFX_MAX_DEVICES][64];
  80         char phys[TGFX_MAX_DEVICES][32];
  81         int sticks;
  82         int used;
  83         struct mutex sem;
  84 } *tgfx_base[TGFX_MAX_PORTS];
  85
  86 /*
  87  * tgfx_timer() reads and analyzes TurboGraFX joystick data.
  88  */
  89
  90 static void tgfx_timer(unsigned long private)
  91 {
  92         struct tgfx *tgfx = (void *) private;
  93         struct input_dev *dev;
  94         int data1, data2, i;
  95
  96         for (i = 0; i < 7; i++)
  97                 if (tgfx->sticks & (1 << i)) {
  98
  99                         dev = tgfx->dev[i];
 100
 101                         parport_write_data(tgfx->pd->port, ~(1 << i));
 102                         data1 = parport_read_status(tgfx->pd->port) ^ 0x7f;
 103                         data2 = parport_read_control(tgfx->pd->port) ^ 0x04;    /* CAVEAT parport */
 104
 105                         input_report_abs(dev, ABS_X, !!(data1 & TGFX_RIGHT) - !!(data1 & TGFX_LEFT));
 106                         input_report_abs(dev, ABS_Y, !!(data1 & TGFX_DOWN ) - !!(data1 & TGFX_UP  ));
 107
 108                         input_report_key(dev, BTN_TRIGGER, (data1 & TGFX_TRIGGER));
 109                         input_report_key(dev, BTN_THUMB,   (data2 & TGFX_THUMB  ));
 110                         input_report_key(dev, BTN_THUMB2,  (data2 & TGFX_THUMB2 ));
 111                         input_report_key(dev, BTN_TOP,     (data2 & TGFX_TOP    ));
 112                         input_report_key(dev, BTN_TOP2,    (data2 & TGFX_TOP2   ));
 113
 114                         input_sync(dev);
 115                 }
 116
 117         mod_timer(&tgfx->timer, jiffies + TGFX_REFRESH_TIME);
 118 }
 119
 120 static int tgfx_open(struct input_dev *dev)
 121 {
 122         struct tgfx *tgfx = input_get_drvdata(dev);
 123         int err;
 124
 125         err = mutex_lock_interruptible(&tgfx->sem);
 126         if (err)
 127                 return err;
 128
 129         if (!tgfx->used++) {
 130                 parport_claim(tgfx->pd);
 131                 parport_write_control(tgfx->pd->port, 0x04);
 132                 mod_timer(&tgfx->timer, jiffies + TGFX_REFRESH_TIME);
 133         }
 134
 135         mutex_unlock(&tgfx->sem);
 136         return 0;
 137 }
 138
 139 static void tgfx_close(struct input_dev *dev)
 140 {
 141         struct tgfx *tgfx = input_get_drvdata(dev);
 142
 143         mutex_lock(&tgfx->sem);
 144         if (!--tgfx->used) {
 145                 del_timer_sync(&tgfx->timer);
 146                 parport_write_control(tgfx->pd->port, 0x00);
 147                 parport_release(tgfx->pd);
 148         }
 149         mutex_unlock(&tgfx->sem);
 150 }
 151
 152
 153
 154 /*
 155  * tgfx_probe() probes for tg gamepads.
 156  */
 157
 158 static struct tgfx __init *tgfx_probe(int parport, int *n_buttons, int n_devs)
 159 {
 160         struct tgfx *tgfx;
 161         struct input_dev *input_dev;
 162         struct parport *pp;
 163         struct pardevice *pd;
 164         int i, j;
 165         int err;
 166
 167         pp = parport_find_number(parport);
 168         if (!pp) {
 169                 printk(KERN_ERR "turbografx.c: no such parport\n");
 170                 err = -EINVAL;
 171                 goto err_out;
 172         }
 173
 174         pd = parport_register_device(pp, "turbografx", NULL, NULL, NULL, PARPORT_DEV_EXCL, NULL);
 175         if (!pd) {
 176                 printk(KERN_ERR "turbografx.c: parport busy already - lp.o loaded?\n");
 177                 err = -EBUSY;
 178                 goto err_put_pp;
 179         }
 180
 181         tgfx = kzalloc(sizeof(struct tgfx), GFP_KERNEL);
 182         if (!tgfx) {
 183                 printk(KERN_ERR "turbografx.c: Not enough memory\n");
 184                 err = -ENOMEM;
 185                 goto err_unreg_pardev;
 186         }
 187
 188         mutex_init(&tgfx->sem);
 189         tgfx->pd = pd;
 190         init_timer(&tgfx->timer);
 191         tgfx->timer.data = (long) tgfx;
 192         tgfx->timer.function = tgfx_timer;
 193
 194         for (i = 0; i < n_devs; i++) {
 195                 if (n_buttons[i] < 1)
 196                         continue;
 197
 198                 if (n_buttons[i] > 6) {
 199                         printk(KERN_ERR "turbografx.c: Invalid number of buttons %d\n", n_buttons[i]);
 200                         err = -EINVAL;
 201                         goto err_unreg_devs;
 202                 }
 203
 204                 tgfx->dev[i] = input_dev = input_allocate_device();
 205                 if (!input_dev) {
 206                         printk(KERN_ERR "turbografx.c: Not enough memory for input device\n");
 207                         err = -ENOMEM;
 208                         goto err_unreg_devs;
 209                 }
 210
 211                 tgfx->sticks |= (1 << i);
 212                 snprintf(tgfx->name[i], sizeof(tgfx->name[i]),
 213                          "TurboGraFX %d-button Multisystem joystick", n_buttons[i]);
 214                 snprintf(tgfx->phys[i], sizeof(tgfx->phys[i]),
 215                          "%s/input%d", tgfx->pd->port->name, i);
 216
 217                 input_dev->name = tgfx->name[i];
 218                 input_dev->phys = tgfx->phys[i];
 219                 input_dev->id.bustype = BUS_PARPORT;
 220                 input_dev->id.vendor = 0x0003;
 221                 input_dev->id.product = n_buttons[i];
 222                 input_dev->id.version = 0x0100;
 223
 224                 input_set_drvdata(input_dev, tgfx);
 225
 226                 input_dev->open = tgfx_open;
 227                 input_dev->close = tgfx_close;
 228
 229                 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
 230                 input_set_abs_params(input_dev, ABS_X, -1, 1, 0, 0);
 231                 input_set_abs_params(input_dev, ABS_Y, -1, 1, 0, 0);
 232
 233                 for (j = 0; j < n_buttons[i]; j++)
 234                         set_bit(tgfx_buttons[j], input_dev->keybit);
 235
 236                 err = input_register_device(tgfx->dev[i]);
 237                 if (err)
 238                         goto err_free_dev;
 239         }
 240
 241         if (!tgfx->sticks) {
 242                 printk(KERN_ERR "turbografx.c: No valid devices specified\n");
 243                 err = -EINVAL;
 244                 goto err_free_tgfx;
 245         }
 246
 247         return tgfx;
 248
 249  err_free_dev:
 250         input_free_device(tgfx->dev[i]);
 251  err_unreg_devs:
 252         while (--i >= 0)
 253                 if (tgfx->dev[i])
 254                         input_unregister_device(tgfx->dev[i]);
 255  err_free_tgfx:
 256         kfree(tgfx);
 257  err_unreg_pardev:
 258         parport_unregister_device(pd);
 259  err_put_pp:
 260         parport_put_port(pp);
 261  err_out:
 262         return ERR_PTR(err);
 263 }
 264
 265 static void tgfx_remove(struct tgfx *tgfx)
 266 {
 267         int i;
 268
 269         for (i = 0; i < TGFX_MAX_DEVICES; i++)
 270                 if (tgfx->dev[i])
 271                         input_unregister_device(tgfx->dev[i]);
 272         parport_unregister_device(tgfx->pd);
 273         kfree(tgfx);
 274 }
 275
 276 static int __init tgfx_init(void)
 277 {
 278         int i;
 279         int have_dev = 0;
 280         int err = 0;
 281
 282         for (i = 0; i < TGFX_MAX_PORTS; i++) {
 283                 if (tgfx_cfg[i].nargs == 0 || tgfx_cfg[i].args[0] < 0)
 284                         continue;
 285
 286                 if (tgfx_cfg[i].nargs < 2) {
 287                         printk(KERN_ERR "turbografx.c: at least one joystick must be specified\n");
 288                         err = -EINVAL;
 289                         break;
 290                 }
 291
 292                 tgfx_base[i] = tgfx_probe(tgfx_cfg[i].args[0],
 293                                           tgfx_cfg[i].args + 1,
 294                                           tgfx_cfg[i].nargs - 1);
 295                 if (IS_ERR(tgfx_base[i])) {
 296                         err = PTR_ERR(tgfx_base[i]);
 297                         break;
 298                 }
 299
 300                 have_dev = 1;
 301         }
 302
 303         if (err) {
 304                 while (--i >= 0)
 305                         if (tgfx_base[i])
 306                                 tgfx_remove(tgfx_base[i]);
 307                 return err;
 308         }
 309
 310         return have_dev ? 0 : -ENODEV;
 311 }
 312
 313 static void __exit tgfx_exit(void)
 314 {
 315         int i;
 316
 317         for (i = 0; i < TGFX_MAX_PORTS; i++)
 318                 if (tgfx_base[i])
 319                         tgfx_remove(tgfx_base[i]);
 320 }
 321
 322 module_init(tgfx_init);
 323 module_exit(tgfx_exit);