linux/drivers/input/joystick/turbografx.c
<<
>>
Prefs
   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#include <linux/slab.h>
  39
  40MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
  41MODULE_DESCRIPTION("TurboGraFX parallel port interface driver");
  42MODULE_LICENSE("GPL");
  43
  44#define TGFX_MAX_PORTS          3
  45#define TGFX_MAX_DEVICES        7
  46
  47struct tgfx_config {
  48        int args[TGFX_MAX_DEVICES + 1];
  49        unsigned int nargs;
  50};
  51
  52static struct tgfx_config tgfx_cfg[TGFX_MAX_PORTS] __initdata;
  53
  54module_param_array_named(map, tgfx_cfg[0].args, int, &tgfx_cfg[0].nargs, 0);
  55MODULE_PARM_DESC(map, "Describes first set of devices (<parport#>,<js1>,<js2>,..<js7>");
  56module_param_array_named(map2, tgfx_cfg[1].args, int, &tgfx_cfg[1].nargs, 0);
  57MODULE_PARM_DESC(map2, "Describes second set of devices");
  58module_param_array_named(map3, tgfx_cfg[2].args, int, &tgfx_cfg[2].nargs, 0);
  59MODULE_PARM_DESC(map3, "Describes third set of devices");
  60
  61#define TGFX_REFRESH_TIME       HZ/100  /* 10 ms */
  62
  63#define TGFX_TRIGGER            0x08
  64#define TGFX_UP                 0x10
  65#define TGFX_DOWN               0x20
  66#define TGFX_LEFT               0x40
  67#define TGFX_RIGHT              0x80
  68
  69#define TGFX_THUMB              0x02
  70#define TGFX_THUMB2             0x04
  71#define TGFX_TOP                0x01
  72#define TGFX_TOP2               0x08
  73
  74static int tgfx_buttons[] = { BTN_TRIGGER, BTN_THUMB, BTN_THUMB2, BTN_TOP, BTN_TOP2 };
  75
  76static struct tgfx {
  77        struct pardevice *pd;
  78        struct timer_list timer;
  79        struct input_dev *dev[TGFX_MAX_DEVICES];
  80        char name[TGFX_MAX_DEVICES][64];
  81        char phys[TGFX_MAX_DEVICES][32];
  82        int sticks;
  83        int used;
  84        struct mutex sem;
  85} *tgfx_base[TGFX_MAX_PORTS];
  86
  87/*
  88 * tgfx_timer() reads and analyzes TurboGraFX joystick data.
  89 */
  90
  91static void tgfx_timer(unsigned long private)
  92{
  93        struct tgfx *tgfx = (void *) private;
  94        struct input_dev *dev;
  95        int data1, data2, i;
  96
  97        for (i = 0; i < 7; i++)
  98                if (tgfx->sticks & (1 << i)) {
  99
 100                        dev = tgfx->dev[i];
 101
 102                        parport_write_data(tgfx->pd->port, ~(1 << i));
 103                        data1 = parport_read_status(tgfx->pd->port) ^ 0x7f;
 104                        data2 = parport_read_control(tgfx->pd->port) ^ 0x04;    /* CAVEAT parport */
 105
 106                        input_report_abs(dev, ABS_X, !!(data1 & TGFX_RIGHT) - !!(data1 & TGFX_LEFT));
 107                        input_report_abs(dev, ABS_Y, !!(data1 & TGFX_DOWN ) - !!(data1 & TGFX_UP  ));
 108
 109                        input_report_key(dev, BTN_TRIGGER, (data1 & TGFX_TRIGGER));
 110                        input_report_key(dev, BTN_THUMB,   (data2 & TGFX_THUMB  ));
 111                        input_report_key(dev, BTN_THUMB2,  (data2 & TGFX_THUMB2 ));
 112                        input_report_key(dev, BTN_TOP,     (data2 & TGFX_TOP    ));
 113                        input_report_key(dev, BTN_TOP2,    (data2 & TGFX_TOP2   ));
 114
 115                        input_sync(dev);
 116                }
 117
 118        mod_timer(&tgfx->timer, jiffies + TGFX_REFRESH_TIME);
 119}
 120
 121static int tgfx_open(struct input_dev *dev)
 122{
 123        struct tgfx *tgfx = input_get_drvdata(dev);
 124        int err;
 125
 126        err = mutex_lock_interruptible(&tgfx->sem);
 127        if (err)
 128                return err;
 129
 130        if (!tgfx->used++) {
 131                parport_claim(tgfx->pd);
 132                parport_write_control(tgfx->pd->port, 0x04);
 133                mod_timer(&tgfx->timer, jiffies + TGFX_REFRESH_TIME);
 134        }
 135
 136        mutex_unlock(&tgfx->sem);
 137        return 0;
 138}
 139
 140static void tgfx_close(struct input_dev *dev)
 141{
 142        struct tgfx *tgfx = input_get_drvdata(dev);
 143
 144        mutex_lock(&tgfx->sem);
 145        if (!--tgfx->used) {
 146                del_timer_sync(&tgfx->timer);
 147                parport_write_control(tgfx->pd->port, 0x00);
 148                parport_release(tgfx->pd);
 149        }
 150        mutex_unlock(&tgfx->sem);
 151}
 152
 153
 154
 155/*
 156 * tgfx_probe() probes for tg gamepads.
 157 */
 158
 159static struct tgfx __init *tgfx_probe(int parport, int *n_buttons, int n_devs)
 160{
 161        struct tgfx *tgfx;
 162        struct input_dev *input_dev;
 163        struct parport *pp;
 164        struct pardevice *pd;
 165        int i, j;
 166        int err;
 167
 168        pp = parport_find_number(parport);
 169        if (!pp) {
 170                printk(KERN_ERR "turbografx.c: no such parport\n");
 171                err = -EINVAL;
 172                goto err_out;
 173        }
 174
 175        pd = parport_register_device(pp, "turbografx", NULL, NULL, NULL, PARPORT_DEV_EXCL, NULL);
 176        if (!pd) {
 177                printk(KERN_ERR "turbografx.c: parport busy already - lp.o loaded?\n");
 178                err = -EBUSY;
 179                goto err_put_pp;
 180        }
 181
 182        tgfx = kzalloc(sizeof(struct tgfx), GFP_KERNEL);
 183        if (!tgfx) {
 184                printk(KERN_ERR "turbografx.c: Not enough memory\n");
 185                err = -ENOMEM;
 186                goto err_unreg_pardev;
 187        }
 188
 189        mutex_init(&tgfx->sem);
 190        tgfx->pd = pd;
 191        init_timer(&tgfx->timer);
 192        tgfx->timer.data = (long) tgfx;
 193        tgfx->timer.function = tgfx_timer;
 194
 195        for (i = 0; i < n_devs; i++) {
 196                if (n_buttons[i] < 1)
 197                        continue;
 198
 199                if (n_buttons[i] > 6) {
 200                        printk(KERN_ERR "turbografx.c: Invalid number of buttons %d\n", n_buttons[i]);
 201                        err = -EINVAL;
 202                        goto err_unreg_devs;
 203                }
 204
 205                tgfx->dev[i] = input_dev = input_allocate_device();
 206                if (!input_dev) {
 207                        printk(KERN_ERR "turbografx.c: Not enough memory for input device\n");
 208                        err = -ENOMEM;
 209                        goto err_unreg_devs;
 210                }
 211
 212                tgfx->sticks |= (1 << i);
 213                snprintf(tgfx->name[i], sizeof(tgfx->name[i]),
 214                         "TurboGraFX %d-button Multisystem joystick", n_buttons[i]);
 215                snprintf(tgfx->phys[i], sizeof(tgfx->phys[i]),
 216                         "%s/input%d", tgfx->pd->port->name, i);
 217
 218                input_dev->name = tgfx->name[i];
 219                input_dev->phys = tgfx->phys[i];
 220                input_dev->id.bustype = BUS_PARPORT;
 221                input_dev->id.vendor = 0x0003;
 222                input_dev->id.product = n_buttons[i];
 223                input_dev->id.version = 0x0100;
 224
 225                input_set_drvdata(input_dev, tgfx);
 226
 227                input_dev->open = tgfx_open;
 228                input_dev->close = tgfx_close;
 229
 230                input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
 231                input_set_abs_params(input_dev, ABS_X, -1, 1, 0, 0);
 232                input_set_abs_params(input_dev, ABS_Y, -1, 1, 0, 0);
 233
 234                for (j = 0; j < n_buttons[i]; j++)
 235                        set_bit(tgfx_buttons[j], input_dev->keybit);
 236
 237                err = input_register_device(tgfx->dev[i]);
 238                if (err)
 239                        goto err_free_dev;
 240        }
 241
 242        if (!tgfx->sticks) {
 243                printk(KERN_ERR "turbografx.c: No valid devices specified\n");
 244                err = -EINVAL;
 245                goto err_free_tgfx;
 246        }
 247
 248        parport_put_port(pp);
 249        return tgfx;
 250
 251 err_free_dev:
 252        input_free_device(tgfx->dev[i]);
 253 err_unreg_devs:
 254        while (--i >= 0)
 255                if (tgfx->dev[i])
 256                        input_unregister_device(tgfx->dev[i]);
 257 err_free_tgfx:
 258        kfree(tgfx);
 259 err_unreg_pardev:
 260        parport_unregister_device(pd);
 261 err_put_pp:
 262        parport_put_port(pp);
 263 err_out:
 264        return ERR_PTR(err);
 265}
 266
 267static void tgfx_remove(struct tgfx *tgfx)
 268{
 269        int i;
 270
 271        for (i = 0; i < TGFX_MAX_DEVICES; i++)
 272                if (tgfx->dev[i])
 273                        input_unregister_device(tgfx->dev[i]);
 274        parport_unregister_device(tgfx->pd);
 275        kfree(tgfx);
 276}
 277
 278static int __init tgfx_init(void)
 279{
 280        int i;
 281        int have_dev = 0;
 282        int err = 0;
 283
 284        for (i = 0; i < TGFX_MAX_PORTS; i++) {
 285                if (tgfx_cfg[i].nargs == 0 || tgfx_cfg[i].args[0] < 0)
 286                        continue;
 287
 288                if (tgfx_cfg[i].nargs < 2) {
 289                        printk(KERN_ERR "turbografx.c: at least one joystick must be specified\n");
 290                        err = -EINVAL;
 291                        break;
 292                }
 293
 294                tgfx_base[i] = tgfx_probe(tgfx_cfg[i].args[0],
 295                                          tgfx_cfg[i].args + 1,
 296                                          tgfx_cfg[i].nargs - 1);
 297                if (IS_ERR(tgfx_base[i])) {
 298                        err = PTR_ERR(tgfx_base[i]);
 299                        break;
 300                }
 301
 302                have_dev = 1;
 303        }
 304
 305        if (err) {
 306                while (--i >= 0)
 307                        if (tgfx_base[i])
 308                                tgfx_remove(tgfx_base[i]);
 309                return err;
 310        }
 311
 312        return have_dev ? 0 : -ENODEV;
 313}
 314
 315static void __exit tgfx_exit(void)
 316{
 317        int i;
 318
 319        for (i = 0; i < TGFX_MAX_PORTS; i++)
 320                if (tgfx_base[i])
 321                        tgfx_remove(tgfx_base[i]);
 322}
 323
 324module_init(tgfx_init);
 325module_exit(tgfx_exit);
 326