drivers/input/joystick/guillemot.c

   1 /*
   2  *  Copyright (c) 2001 Vojtech Pavlik
   3  */
   4
   5 /*
   6  * Guillemot Digital Interface Protocol driver for Linux
   7  */
   8
   9 /*
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  23  *
  24  * Should you need to contact me, the author, you can do so either by
  25  * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
  26  * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
  27  */
  28
  29 #include <linux/kernel.h>
  30 #include <linux/slab.h>
  31 #include <linux/module.h>
  32 #include <linux/delay.h>
  33 #include <linux/gameport.h>
  34 #include <linux/input.h>
  35 #include <linux/jiffies.h>
  36
  37 #define DRIVER_DESC     "Guillemot Digital joystick driver"
  38
  39 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
  40 MODULE_DESCRIPTION(DRIVER_DESC);
  41 MODULE_LICENSE("GPL");
  42
  43 #define GUILLEMOT_MAX_START     600     /* 600 us */
  44 #define GUILLEMOT_MAX_STROBE    60      /* 60 us */
  45 #define GUILLEMOT_MAX_LENGTH    17      /* 17 bytes */
  46
  47 static short guillemot_abs_pad[] =
  48         { ABS_X, ABS_Y, ABS_THROTTLE, ABS_RUDDER, -1 };
  49
  50 static short guillemot_btn_pad[] =
  51         { BTN_A, BTN_B, BTN_C, BTN_X, BTN_Y, BTN_Z, BTN_TL, BTN_TR, BTN_MODE, BTN_SELECT, -1 };
  52
  53 static struct {
  54         int x;
  55         int y;
  56 } guillemot_hat_to_axis[16] = {{ 0,-1}, { 1,-1}, { 1, 0}, { 1, 1}, { 0, 1}, {-1, 1}, {-1, 0}, {-1,-1}};
  57
  58 struct guillemot_type {
  59         unsigned char id;
  60         short *abs;
  61         short *btn;
  62         int hat;
  63         char *name;
  64 };
  65
  66 struct guillemot {
  67         struct gameport *gameport;
  68         struct input_dev *dev;
  69         int bads;
  70         int reads;
  71         struct guillemot_type *type;
  72         unsigned char length;
  73         char phys[32];
  74 };
  75
  76 static struct guillemot_type guillemot_type[] = {
  77         { 0x00, guillemot_abs_pad, guillemot_btn_pad, 1, "Guillemot Pad" },
  78         { 0 }};
  79
  80 /*
  81  * guillemot_read_packet() reads Guillemot joystick data.
  82  */
  83
  84 static int guillemot_read_packet(struct gameport *gameport, u8 *data)
  85 {
  86         unsigned long flags;
  87         unsigned char u, v;
  88         unsigned int t, s;
  89         int i;
  90
  91         for (i = 0; i < GUILLEMOT_MAX_LENGTH; i++)
  92                 data[i] = 0;
  93
  94         i = 0;
  95         t = gameport_time(gameport, GUILLEMOT_MAX_START);
  96         s = gameport_time(gameport, GUILLEMOT_MAX_STROBE);
  97
  98         local_irq_save(flags);
  99         gameport_trigger(gameport);
 100         v = gameport_read(gameport);
 101
 102         while (t > 0 && i < GUILLEMOT_MAX_LENGTH * 8) {
 103                 t--;
 104                 u = v; v = gameport_read(gameport);
 105                 if (v & ~u & 0x10) {
 106                         data[i >> 3] |= ((v >> 5) & 1) << (i & 7);
 107                         i++;
 108                         t = s;
 109                 }
 110         }
 111
 112         local_irq_restore(flags);
 113
 114         return i;
 115 }
 116
 117 /*
 118  * guillemot_poll() reads and analyzes Guillemot joystick data.
 119  */
 120
 121 static void guillemot_poll(struct gameport *gameport)
 122 {
 123         struct guillemot *guillemot = gameport_get_drvdata(gameport);
 124         struct input_dev *dev = guillemot->dev;
 125         u8 data[GUILLEMOT_MAX_LENGTH];
 126         int i;
 127
 128         guillemot->reads++;
 129
 130         if (guillemot_read_packet(guillemot->gameport, data) != GUILLEMOT_MAX_LENGTH * 8 ||
 131                 data[0] != 0x55 || data[16] != 0xaa) {
 132                 guillemot->bads++;
 133         } else {
 134
 135                 for (i = 0; i < 6 && guillemot->type->abs[i] >= 0; i++)
 136                         input_report_abs(dev, guillemot->type->abs[i], data[i + 5]);
 137
 138                 if (guillemot->type->hat) {
 139                         input_report_abs(dev, ABS_HAT0X, guillemot_hat_to_axis[data[4] >> 4].x);
 140                         input_report_abs(dev, ABS_HAT0Y, guillemot_hat_to_axis[data[4] >> 4].y);
 141                 }
 142
 143                 for (i = 0; i < 16 && guillemot->type->btn[i] >= 0; i++)
 144                         input_report_key(dev, guillemot->type->btn[i], (data[2 + (i >> 3)] >> (i & 7)) & 1);
 145         }
 146
 147         input_sync(dev);
 148 }
 149
 150 /*
 151  * guillemot_open() is a callback from the input open routine.
 152  */
 153
 154 static int guillemot_open(struct input_dev *dev)
 155 {
 156         struct guillemot *guillemot = input_get_drvdata(dev);
 157
 158         gameport_start_polling(guillemot->gameport);
 159         return 0;
 160 }
 161
 162 /*
 163  * guillemot_close() is a callback from the input close routine.
 164  */
 165
 166 static void guillemot_close(struct input_dev *dev)
 167 {
 168         struct guillemot *guillemot = input_get_drvdata(dev);
 169
 170         gameport_stop_polling(guillemot->gameport);
 171 }
 172
 173 /*
 174  * guillemot_connect() probes for Guillemot joysticks.
 175  */
 176
 177 static int guillemot_connect(struct gameport *gameport, struct gameport_driver *drv)
 178 {
 179         struct guillemot *guillemot;
 180         struct input_dev *input_dev;
 181         u8 data[GUILLEMOT_MAX_LENGTH];
 182         int i, t;
 183         int err;
 184
 185         guillemot = kzalloc(sizeof(struct guillemot), GFP_KERNEL);
 186         input_dev = input_allocate_device();
 187         if (!guillemot || !input_dev) {
 188                 err = -ENOMEM;
 189                 goto fail1;
 190         }
 191
 192         guillemot->gameport = gameport;
 193         guillemot->dev = input_dev;
 194
 195         gameport_set_drvdata(gameport, guillemot);
 196
 197         err = gameport_open(gameport, drv, GAMEPORT_MODE_RAW);
 198         if (err)
 199                 goto fail1;
 200
 201         i = guillemot_read_packet(gameport, data);
 202
 203         if (i != GUILLEMOT_MAX_LENGTH * 8 || data[0] != 0x55 || data[16] != 0xaa) {
 204                 err = -ENODEV;
 205                 goto fail2;
 206         }
 207
 208         for (i = 0; guillemot_type[i].name; i++)
 209                 if (guillemot_type[i].id == data[11])
 210                         break;
 211
 212         if (!guillemot_type[i].name) {
 213                 printk(KERN_WARNING "guillemot.c: Unknown joystick on %s. [ %02x%02x:%04x, ver %d.%02d ]\n",
 214                         gameport->phys, data[12], data[13], data[11], data[14], data[15]);
 215                 err = -ENODEV;
 216                 goto fail2;
 217         }
 218
 219         gameport_set_poll_handler(gameport, guillemot_poll);
 220         gameport_set_poll_interval(gameport, 20);
 221
 222         snprintf(guillemot->phys, sizeof(guillemot->phys), "%s/input0", gameport->phys);
 223         guillemot->type = guillemot_type + i;
 224
 225         input_dev->name = guillemot_type[i].name;
 226         input_dev->phys = guillemot->phys;
 227         input_dev->id.bustype = BUS_GAMEPORT;
 228         input_dev->id.vendor = GAMEPORT_ID_VENDOR_GUILLEMOT;
 229         input_dev->id.product = guillemot_type[i].id;
 230         input_dev->id.version = (int)data[14] << 8 | data[15];
 231         input_dev->dev.parent = &gameport->dev;
 232
 233         input_set_drvdata(input_dev, guillemot);
 234
 235         input_dev->open = guillemot_open;
 236         input_dev->close = guillemot_close;
 237
 238         input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
 239
 240         for (i = 0; (t = guillemot->type->abs[i]) >= 0; i++)
 241                 input_set_abs_params(input_dev, t, 0, 255, 0, 0);
 242
 243         if (guillemot->type->hat) {
 244                 input_set_abs_params(input_dev, ABS_HAT0X, -1, 1, 0, 0);
 245                 input_set_abs_params(input_dev, ABS_HAT0Y, -1, 1, 0, 0);
 246         }
 247
 248         for (i = 0; (t = guillemot->type->btn[i]) >= 0; i++)
 249                 set_bit(t, input_dev->keybit);
 250
 251         err = input_register_device(guillemot->dev);
 252         if (err)
 253                 goto fail2;
 254
 255         return 0;
 256
 257 fail2:  gameport_close(gameport);
 258 fail1:  gameport_set_drvdata(gameport, NULL);
 259         input_free_device(input_dev);
 260         kfree(guillemot);
 261         return err;
 262 }
 263
 264 static void guillemot_disconnect(struct gameport *gameport)
 265 {
 266         struct guillemot *guillemot = gameport_get_drvdata(gameport);
 267
 268         printk(KERN_INFO "guillemot.c: Failed %d reads out of %d on %s\n", guillemot->reads, guillemot->bads, guillemot->phys);
 269         input_unregister_device(guillemot->dev);
 270         gameport_close(gameport);
 271         kfree(guillemot);
 272 }
 273
 274 static struct gameport_driver guillemot_drv = {
 275         .driver         = {
 276                 .name   = "guillemot",
 277         },
 278         .description    = DRIVER_DESC,
 279         .connect        = guillemot_connect,
 280         .disconnect     = guillemot_disconnect,
 281 };
 282
 283 module_gameport_driver(guillemot_drv);