drivers/usb/misc/idmouse.c

   1 /* Siemens ID Mouse driver v0.6
   2
   3   This program is free software; you can redistribute it and/or
   4   modify it under the terms of the GNU General Public License as
   5   published by the Free Software Foundation; either version 2 of
   6   the License, or (at your option) any later version.
   7
   8   Copyright (C) 2004-5 by Florian 'Floe' Echtler  <echtler@fs.tum.de>
   9                       and Andreas  'ad'  Deresch <aderesch@fs.tum.de>
  10
  11   Derived from the USB Skeleton driver 1.1,
  12   Copyright (C) 2003 Greg Kroah-Hartman (greg@kroah.com)
  13
  14   Additional information provided by Martin Reising
  15   <Martin.Reising@natural-computing.de>
  16
  17 */
  18
  19 #include <linux/kernel.h>
  20 #include <linux/errno.h>
  21 #include <linux/delay.h>
  22 #include <linux/init.h>
  23 #include <linux/slab.h>
  24 #include <linux/module.h>
  25 #include <linux/smp_lock.h>
  26 #include <linux/completion.h>
  27 #include <linux/mutex.h>
  28 #include <asm/uaccess.h>
  29 #include <linux/usb.h>
  30
  31 /* image constants */
  32 #define WIDTH 225
  33 #define HEIGHT 289
  34 #define HEADER "P5 225 289 255 "
  35 #define IMGSIZE ((WIDTH * HEIGHT) + sizeof(HEADER)-1)
  36
  37 /* version information */
  38 #define DRIVER_VERSION "0.6"
  39 #define DRIVER_SHORT   "idmouse"
  40 #define DRIVER_AUTHOR  "Florian 'Floe' Echtler <echtler@fs.tum.de>"
  41 #define DRIVER_DESC    "Siemens ID Mouse FingerTIP Sensor Driver"
  42
  43 /* minor number for misc USB devices */
  44 #define USB_IDMOUSE_MINOR_BASE 132
  45
  46 /* vendor and device IDs */
  47 #define ID_SIEMENS 0x0681
  48 #define ID_IDMOUSE 0x0005
  49 #define ID_CHERRY  0x0010
  50
  51 /* device ID table */
  52 static struct usb_device_id idmouse_table[] = {
  53         {USB_DEVICE(ID_SIEMENS, ID_IDMOUSE)}, /* Siemens ID Mouse (Professional) */
  54         {USB_DEVICE(ID_SIEMENS, ID_CHERRY )}, /* Cherry FingerTIP ID Board       */
  55         {}                                    /* terminating null entry          */
  56 };
  57
  58 /* sensor commands */
  59 #define FTIP_RESET   0x20
  60 #define FTIP_ACQUIRE 0x21
  61 #define FTIP_RELEASE 0x22
  62 #define FTIP_BLINK   0x23  /* LSB of value = blink pulse width */
  63 #define FTIP_SCROLL  0x24
  64
  65 #define ftip_command(dev, command, value, index) \
  66         usb_control_msg (dev->udev, usb_sndctrlpipe (dev->udev, 0), command, \
  67         USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT, value, index, NULL, 0, 1000)
  68
  69 MODULE_DEVICE_TABLE(usb, idmouse_table);
  70
  71 /* structure to hold all of our device specific stuff */
  72 struct usb_idmouse {
  73
  74         struct usb_device *udev; /* save off the usb device pointer */
  75         struct usb_interface *interface; /* the interface for this device */
  76
  77         unsigned char *bulk_in_buffer; /* the buffer to receive data */
  78         size_t bulk_in_size; /* the maximum bulk packet size */
  79         size_t orig_bi_size; /* same as above, but reported by the device */
  80         __u8 bulk_in_endpointAddr; /* the address of the bulk in endpoint */
  81
  82         int open; /* if the port is open or not */
  83         int present; /* if the device is not disconnected */
  84         struct semaphore sem; /* locks this structure */
  85
  86 };
  87
  88 /* local function prototypes */
  89 static ssize_t idmouse_read(struct file *file, char __user *buffer,
  90                                 size_t count, loff_t * ppos);
  91
  92 static int idmouse_open(struct inode *inode, struct file *file);
  93 static int idmouse_release(struct inode *inode, struct file *file);
  94
  95 static int idmouse_probe(struct usb_interface *interface,
  96                                 const struct usb_device_id *id);
  97
  98 static void idmouse_disconnect(struct usb_interface *interface);
  99
 100 /* file operation pointers */
 101 static const struct file_operations idmouse_fops = {
 102         .owner = THIS_MODULE,
 103         .read = idmouse_read,
 104         .open = idmouse_open,
 105         .release = idmouse_release,
 106 };
 107
 108 /* class driver information */
 109 static struct usb_class_driver idmouse_class = {
 110         .name = "idmouse%d",
 111         .fops = &idmouse_fops,
 112         .minor_base = USB_IDMOUSE_MINOR_BASE,
 113 };
 114
 115 /* usb specific object needed to register this driver with the usb subsystem */
 116 static struct usb_driver idmouse_driver = {
 117         .name = DRIVER_SHORT,
 118         .probe = idmouse_probe,
 119         .disconnect = idmouse_disconnect,
 120         .id_table = idmouse_table,
 121 };
 122
 123 /* prevent races between open() and disconnect() */
 124 static DEFINE_MUTEX(disconnect_mutex);
 125
 126 static int idmouse_create_image(struct usb_idmouse *dev)
 127 {
 128         int bytes_read;
 129         int bulk_read;
 130         int result;
 131
 132         memcpy(dev->bulk_in_buffer, HEADER, sizeof(HEADER)-1);
 133         bytes_read = sizeof(HEADER)-1;
 134
 135         /* reset the device and set a fast blink rate */
 136         result = ftip_command(dev, FTIP_RELEASE, 0, 0);
 137         if (result < 0)
 138                 goto reset;
 139         result = ftip_command(dev, FTIP_BLINK,   1, 0);
 140         if (result < 0)
 141                 goto reset;
 142
 143         /* initialize the sensor - sending this command twice */
 144         /* significantly reduces the rate of failed reads     */
 145         result = ftip_command(dev, FTIP_ACQUIRE, 0, 0);
 146         if (result < 0)
 147                 goto reset;
 148         result = ftip_command(dev, FTIP_ACQUIRE, 0, 0);
 149         if (result < 0)
 150                 goto reset;
 151
 152         /* start the readout - sending this command twice */
 153         /* presumably enables the high dynamic range mode */
 154         result = ftip_command(dev, FTIP_RESET,   0, 0);
 155         if (result < 0)
 156                 goto reset;
 157         result = ftip_command(dev, FTIP_RESET,   0, 0);
 158         if (result < 0)
 159                 goto reset;
 160
 161         /* loop over a blocking bulk read to get data from the device */
 162         while (bytes_read < IMGSIZE) {
 163                 result = usb_bulk_msg (dev->udev,
 164                                 usb_rcvbulkpipe (dev->udev, dev->bulk_in_endpointAddr),
 165                                 dev->bulk_in_buffer + bytes_read,
 166                                 dev->bulk_in_size, &bulk_read, 5000);
 167                 if (result < 0) {
 168                         /* Maybe this error was caused by the increased packet size? */
 169                         /* Reset to the original value and tell userspace to retry.  */
 170                         if (dev->bulk_in_size != dev->orig_bi_size) {
 171                                 dev->bulk_in_size = dev->orig_bi_size;
 172                                 result = -EAGAIN;
 173                         }
 174                         break;
 175                 }
 176                 if (signal_pending(current)) {
 177                         result = -EINTR;
 178                         break;
 179                 }
 180                 bytes_read += bulk_read;
 181         }
 182
 183         /* reset the device */
 184 reset:
 185         ftip_command(dev, FTIP_RELEASE, 0, 0);
 186
 187         /* check for valid image */
 188         /* right border should be black (0x00) */
 189         for (bytes_read = sizeof(HEADER)-1 + WIDTH-1; bytes_read < IMGSIZE; bytes_read += WIDTH)
 190                 if (dev->bulk_in_buffer[bytes_read] != 0x00)
 191                         return -EAGAIN;
 192
 193         /* lower border should be white (0xFF) */
 194         for (bytes_read = IMGSIZE-WIDTH; bytes_read < IMGSIZE-1; bytes_read++)
 195                 if (dev->bulk_in_buffer[bytes_read] != 0xFF)
 196                         return -EAGAIN;
 197
 198         /* should be IMGSIZE == 65040 */
 199         dbg("read %d bytes fingerprint data", bytes_read);
 200         return result;
 201 }
 202
 203 static inline void idmouse_delete(struct usb_idmouse *dev)
 204 {
 205         kfree(dev->bulk_in_buffer);
 206         kfree(dev);
 207 }
 208
 209 static int idmouse_open(struct inode *inode, struct file *file)
 210 {
 211         struct usb_idmouse *dev;
 212         struct usb_interface *interface;
 213         int result;
 214
 215         /* prevent disconnects */
 216         mutex_lock(&disconnect_mutex);
 217
 218         /* get the interface from minor number and driver information */
 219         interface = usb_find_interface (&idmouse_driver, iminor (inode));
 220         if (!interface) {
 221                 mutex_unlock(&disconnect_mutex);
 222                 return -ENODEV;
 223         }
 224         /* get the device information block from the interface */
 225         dev = usb_get_intfdata(interface);
 226         if (!dev) {
 227                 mutex_unlock(&disconnect_mutex);
 228                 return -ENODEV;
 229         }
 230
 231         /* lock this device */
 232         down(&dev->sem);
 233
 234         /* check if already open */
 235         if (dev->open) {
 236
 237                 /* already open, so fail */
 238                 result = -EBUSY;
 239
 240         } else {
 241
 242                 /* create a new image and check for success */
 243                 result = idmouse_create_image (dev);
 244                 if (result)
 245                         goto error;
 246
 247                 /* increment our usage count for the driver */
 248                 ++dev->open;
 249
 250                 /* save our object in the file's private structure */
 251                 file->private_data = dev;
 252
 253         }
 254
 255 error:
 256
 257         /* unlock this device */
 258         up(&dev->sem);
 259
 260         /* unlock the disconnect semaphore */
 261         mutex_unlock(&disconnect_mutex);
 262         return result;
 263 }
 264
 265 static int idmouse_release(struct inode *inode, struct file *file)
 266 {
 267         struct usb_idmouse *dev;
 268
 269         /* prevent a race condition with open() */
 270         mutex_lock(&disconnect_mutex);
 271
 272         dev = (struct usb_idmouse *) file->private_data;
 273
 274         if (dev == NULL) {
 275                 mutex_unlock(&disconnect_mutex);
 276                 return -ENODEV;
 277         }
 278
 279         /* lock our device */
 280         down(&dev->sem);
 281
 282         /* are we really open? */
 283         if (dev->open <= 0) {
 284                 up(&dev->sem);
 285                 mutex_unlock(&disconnect_mutex);
 286                 return -ENODEV;
 287         }
 288
 289         --dev->open;
 290
 291         if (!dev->present) {
 292                 /* the device was unplugged before the file was released */
 293                 up(&dev->sem);
 294                 idmouse_delete(dev);
 295                 mutex_unlock(&disconnect_mutex);
 296                 return 0;
 297         }
 298
 299         up(&dev->sem);
 300         mutex_unlock(&disconnect_mutex);
 301         return 0;
 302 }
 303
 304 static ssize_t idmouse_read(struct file *file, char __user *buffer, size_t count,
 305                                 loff_t * ppos)
 306 {
 307         struct usb_idmouse *dev;
 308         int result;
 309
 310         dev = (struct usb_idmouse *) file->private_data;
 311
 312         /* lock this object */
 313         down (&dev->sem);
 314
 315         /* verify that the device wasn't unplugged */
 316         if (!dev->present) {
 317                 up (&dev->sem);
 318                 return -ENODEV;
 319         }
 320
 321         result = simple_read_from_buffer(buffer, count, ppos,
 322                                         dev->bulk_in_buffer, IMGSIZE);
 323         /* unlock the device */
 324         up(&dev->sem);
 325         return result;
 326 }
 327
 328 static int idmouse_probe(struct usb_interface *interface,
 329                                 const struct usb_device_id *id)
 330 {
 331         struct usb_device *udev = interface_to_usbdev(interface);
 332         struct usb_idmouse *dev;
 333         struct usb_host_interface *iface_desc;
 334         struct usb_endpoint_descriptor *endpoint;
 335         int result;
 336
 337         /* check if we have gotten the data or the hid interface */
 338         iface_desc = &interface->altsetting[0];
 339         if (iface_desc->desc.bInterfaceClass != 0x0A)
 340                 return -ENODEV;
 341
 342         /* allocate memory for our device state and initialize it */
 343         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
 344         if (dev == NULL)
 345                 return -ENOMEM;
 346
 347         init_MUTEX(&dev->sem);
 348         dev->udev = udev;
 349         dev->interface = interface;
 350
 351         /* set up the endpoint information - use only the first bulk-in endpoint */
 352         endpoint = &iface_desc->endpoint[0].desc;
 353         if (!dev->bulk_in_endpointAddr && usb_endpoint_is_bulk_in(endpoint)) {
 354                 /* we found a bulk in endpoint */
 355                 dev->orig_bi_size = le16_to_cpu(endpoint->wMaxPacketSize);
 356                 dev->bulk_in_size = 0x200; /* works _much_ faster */
 357                 dev->bulk_in_endpointAddr = endpoint->bEndpointAddress;
 358                 dev->bulk_in_buffer =
 359                         kmalloc(IMGSIZE + dev->bulk_in_size, GFP_KERNEL);
 360
 361                 if (!dev->bulk_in_buffer) {
 362                         err("Unable to allocate input buffer.");
 363                         idmouse_delete(dev);
 364                         return -ENOMEM;
 365                 }
 366         }
 367
 368         if (!(dev->bulk_in_endpointAddr)) {
 369                 err("Unable to find bulk-in endpoint.");
 370                 idmouse_delete(dev);
 371                 return -ENODEV;
 372         }
 373         /* allow device read, write and ioctl */
 374         dev->present = 1;
 375
 376         /* we can register the device now, as it is ready */
 377         usb_set_intfdata(interface, dev);
 378         result = usb_register_dev(interface, &idmouse_class);
 379         if (result) {
 380                 /* something prevented us from registering this device */
 381                 err("Unble to allocate minor number.");
 382                 usb_set_intfdata(interface, NULL);
 383                 idmouse_delete(dev);
 384                 return result;
 385         }
 386
 387         /* be noisy */
 388         dev_info(&interface->dev,"%s now attached\n",DRIVER_DESC);
 389
 390         return 0;
 391 }
 392
 393 static void idmouse_disconnect(struct usb_interface *interface)
 394 {
 395         struct usb_idmouse *dev;
 396
 397         /* prevent races with open() */
 398         mutex_lock(&disconnect_mutex);
 399
 400         /* get device structure */
 401         dev = usb_get_intfdata(interface);
 402         usb_set_intfdata(interface, NULL);
 403
 404         /* lock it */
 405         down(&dev->sem);
 406
 407         /* give back our minor */
 408         usb_deregister_dev(interface, &idmouse_class);
 409
 410         /* prevent device read, write and ioctl */
 411         dev->present = 0;
 412
 413         /* unlock */
 414         up(&dev->sem);
 415
 416         /* if the device is opened, idmouse_release will clean this up */
 417         if (!dev->open)
 418                 idmouse_delete(dev);
 419
 420         mutex_unlock(&disconnect_mutex);
 421
 422         info("%s disconnected", DRIVER_DESC);
 423 }
 424
 425 static int __init usb_idmouse_init(void)
 426 {
 427         int result;
 428
 429         info(DRIVER_DESC " " DRIVER_VERSION);
 430
 431         /* register this driver with the USB subsystem */
 432         result = usb_register(&idmouse_driver);
 433         if (result)
 434                 err("Unable to register device (error %d).", result);
 435
 436         return result;
 437 }
 438
 439 static void __exit usb_idmouse_exit(void)
 440 {
 441         /* deregister this driver with the USB subsystem */
 442         usb_deregister(&idmouse_driver);
 443 }
 444
 445 module_init(usb_idmouse_init);
 446 module_exit(usb_idmouse_exit);
 447
 448 MODULE_AUTHOR(DRIVER_AUTHOR);
 449 MODULE_DESCRIPTION(DRIVER_DESC);
 450 MODULE_LICENSE("GPL");
 451