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];
  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        int parportno;
  85        struct mutex sem;
  86} *tgfx_base[TGFX_MAX_PORTS];
  87
  88/*
  89 * tgfx_timer() reads and analyzes TurboGraFX joystick data.
  90 */
  91
  92static void tgfx_timer(unsigned long private)
  93{
  94        struct tgfx *tgfx = (void *) private;
  95        struct input_dev *dev;
  96        int data1, data2, i;
  97
  98        for (i = 0; i < 7; i++)
  99                if (tgfx->sticks & (1 << i)) {
 100
 101                        dev = tgfx->dev[i];
 102
 103                        parport_write_data(tgfx->pd->port, ~(1 << i));
 104                        data1 = parport_read_status(tgfx->pd->port) ^ 0x7f;
 105                        data2 = parport_read_control(tgfx->pd->port) ^ 0x04;    /* CAVEAT parport */
 106
 107                        input_report_abs(dev, ABS_X, !!(data1 & TGFX_RIGHT) - !!(data1 & TGFX_LEFT));
 108                        input_report_abs(dev, ABS_Y, !!(data1 & TGFX_DOWN ) - !!(data1 & TGFX_UP  ));
 109
 110                        input_report_key(dev, BTN_TRIGGER, (data1 & TGFX_TRIGGER));
 111                        input_report_key(dev, BTN_THUMB,   (data2 & TGFX_THUMB  ));
 112                        input_report_key(dev, BTN_THUMB2,  (data2 & TGFX_THUMB2 ));
 113                        input_report_key(dev, BTN_TOP,     (data2 & TGFX_TOP    ));
 114                        input_report_key(dev, BTN_TOP2,    (data2 & TGFX_TOP2   ));
 115
 116                        input_sync(dev);
 117                }
 118
 119        mod_timer(&tgfx->timer, jiffies + TGFX_REFRESH_TIME);
 120}
 121
 122static int tgfx_open(struct input_dev *dev)
 123{
 124        struct tgfx *tgfx = input_get_drvdata(dev);
 125        int err;
 126
 127        err = mutex_lock_interruptible(&tgfx->sem);
 128        if (err)
 129                return err;
 130
 131        if (!tgfx->used++) {
 132                parport_claim(tgfx->pd);
 133                parport_write_control(tgfx->pd->port, 0x04);
 134                mod_timer(&tgfx->timer, jiffies + TGFX_REFRESH_TIME);
 135        }
 136
 137        mutex_unlock(&tgfx->sem);
 138        return 0;
 139}
 140
 141static void tgfx_close(struct input_dev *dev)
 142{
 143        struct tgfx *tgfx = input_get_drvdata(dev);
 144
 145        mutex_lock(&tgfx->sem);
 146        if (!--tgfx->used) {
 147                del_timer_sync(&tgfx->timer);
 148                parport_write_control(tgfx->pd->port, 0x00);
 149                parport_release(tgfx->pd);
 150        }
 151        mutex_unlock(&tgfx->sem);
 152}
 153
 154
 155
 156/*
 157 * tgfx_probe() probes for tg gamepads.
 158 */
 159
 160static void tgfx_attach(struct parport *pp)
 161{
 162        struct tgfx *tgfx;
 163        struct input_dev *input_dev;
 164        struct pardevice *pd;
 165        int i, j, port_idx;
 166        int *n_buttons, n_devs;
 167        struct pardev_cb tgfx_parport_cb;
 168
 169        for (port_idx = 0; port_idx < TGFX_MAX_PORTS; port_idx++) {
 170                if (tgfx_cfg[port_idx].nargs == 0 ||
 171                    tgfx_cfg[port_idx].args[0] < 0)
 172                        continue;
 173                if (tgfx_cfg[port_idx].args[0] == pp->number)
 174                        break;
 175        }
 176
 177        if (port_idx == TGFX_MAX_PORTS) {
 178                pr_debug("Not using parport%d.\n", pp->number);
 179                return;
 180        }
 181        n_buttons = tgfx_cfg[port_idx].args + 1;
 182        n_devs = tgfx_cfg[port_idx].nargs - 1;
 183
 184        memset(&tgfx_parport_cb, 0, sizeof(tgfx_parport_cb));
 185        tgfx_parport_cb.flags = PARPORT_FLAG_EXCL;
 186
 187        pd = parport_register_dev_model(pp, "turbografx", &tgfx_parport_cb,
 188                                        port_idx);
 189        if (!pd) {
 190                pr_err("parport busy already - lp.o loaded?\n");
 191                return;
 192        }
 193
 194        tgfx = kzalloc(sizeof(struct tgfx), GFP_KERNEL);
 195        if (!tgfx) {
 196                printk(KERN_ERR "turbografx.c: Not enough memory\n");
 197                goto err_unreg_pardev;
 198        }
 199
 200        mutex_init(&tgfx->sem);
 201        tgfx->pd = pd;
 202        tgfx->parportno = pp->number;
 203        setup_timer(&tgfx->timer, tgfx_timer, (long)tgfx);
 204
 205        for (i = 0; i < n_devs; i++) {
 206                if (n_buttons[i] < 1)
 207                        continue;
 208
 209                if (n_buttons[i] > ARRAY_SIZE(tgfx_buttons)) {
 210                        printk(KERN_ERR "turbografx.c: Invalid number of buttons %d\n", n_buttons[i]);
 211                        goto err_unreg_devs;
 212                }
 213
 214                tgfx->dev[i] = input_dev = input_allocate_device();
 215                if (!input_dev) {
 216                        printk(KERN_ERR "turbografx.c: Not enough memory for input device\n");
 217                        goto err_unreg_devs;
 218                }
 219
 220                tgfx->sticks |= (1 << i);
 221                snprintf(tgfx->name[i], sizeof(tgfx->name[i]),
 222                         "TurboGraFX %d-button Multisystem joystick", n_buttons[i]);
 223                snprintf(tgfx->phys[i], sizeof(tgfx->phys[i]),
 224                         "%s/input%d", tgfx->pd->port->name, i);
 225
 226                input_dev->name = tgfx->name[i];
 227                input_dev->phys = tgfx->phys[i];
 228                input_dev->id.bustype = BUS_PARPORT;
 229                input_dev->id.vendor = 0x0003;
 230                input_dev->id.product = n_buttons[i];
 231                input_dev->id.version = 0x0100;
 232
 233                input_set_drvdata(input_dev, tgfx);
 234
 235                input_dev->open = tgfx_open;
 236                input_dev->close = tgfx_close;
 237
 238                input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
 239                input_set_abs_params(input_dev, ABS_X, -1, 1, 0, 0);
 240                input_set_abs_params(input_dev, ABS_Y, -1, 1, 0, 0);
 241
 242                for (j = 0; j < n_buttons[i]; j++)
 243                        set_bit(tgfx_buttons[j], input_dev->keybit);
 244
 245                if (input_register_device(tgfx->dev[i]))
 246                        goto err_free_dev;
 247        }
 248
 249        if (!tgfx->sticks) {
 250                printk(KERN_ERR "turbografx.c: No valid devices specified\n");
 251                goto err_free_tgfx;
 252        }
 253
 254        tgfx_base[port_idx] = tgfx;
 255        return;
 256
 257 err_free_dev:
 258        input_free_device(tgfx->dev[i]);
 259 err_unreg_devs:
 260        while (--i >= 0)
 261                if (tgfx->dev[i])
 262                        input_unregister_device(tgfx->dev[i]);
 263 err_free_tgfx:
 264        kfree(tgfx);
 265 err_unreg_pardev:
 266        parport_unregister_device(pd);
 267}
 268
 269static void tgfx_detach(struct parport *port)
 270{
 271        int i;
 272        struct tgfx *tgfx;
 273
 274        for (i = 0; i < TGFX_MAX_PORTS; i++) {
 275                if (tgfx_base[i] && tgfx_base[i]->parportno == port->number)
 276                        break;
 277        }
 278
 279        if (i == TGFX_MAX_PORTS)
 280                return;
 281
 282        tgfx = tgfx_base[i];
 283        tgfx_base[i] = NULL;
 284
 285        for (i = 0; i < TGFX_MAX_DEVICES; i++)
 286                if (tgfx->dev[i])
 287                        input_unregister_device(tgfx->dev[i]);
 288        parport_unregister_device(tgfx->pd);
 289        kfree(tgfx);
 290}
 291
 292static struct parport_driver tgfx_parport_driver = {
 293        .name = "turbografx",
 294        .match_port = tgfx_attach,
 295        .detach = tgfx_detach,
 296        .devmodel = true,
 297};
 298
 299static int __init tgfx_init(void)
 300{
 301        int i;
 302        int have_dev = 0;
 303
 304        for (i = 0; i < TGFX_MAX_PORTS; i++) {
 305                if (tgfx_cfg[i].nargs == 0 || tgfx_cfg[i].args[0] < 0)
 306                        continue;
 307
 308                if (tgfx_cfg[i].nargs < 2) {
 309                        printk(KERN_ERR "turbografx.c: at least one joystick must be specified\n");
 310                        return -EINVAL;
 311                }
 312
 313                have_dev = 1;
 314        }
 315
 316        if (!have_dev)
 317                return -ENODEV;
 318
 319        return parport_register_driver(&tgfx_parport_driver);
 320}
 321
 322static void __exit tgfx_exit(void)
 323{
 324        parport_unregister_driver(&tgfx_parport_driver);
 325}
 326
 327module_init(tgfx_init);
 328module_exit(tgfx_exit);
 329