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