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/sched/signal.h>
  21 #include <linux/errno.h>
  22 #include <linux/delay.h>
  23 #include <linux/slab.h>
  24 #include <linux/module.h>
  25 #include <linux/completion.h>
  26 #include <linux/mutex.h>
  27 #include <linux/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         dev_dbg(&dev->interface->dev, "read %d bytes fingerprint data\n",
 204                 bytes_read);
 205         return result;
 206 }
 207
 208 /* PM operations are nops as this driver does IO only during open() */
 209 static int idmouse_suspend(struct usb_interface *intf, pm_message_t message)
 210 {
 211         return 0;
 212 }
 213
 214 static int idmouse_resume(struct usb_interface *intf)
 215 {
 216         return 0;
 217 }
 218
 219 static inline void idmouse_delete(struct usb_idmouse *dev)
 220 {
 221         kfree(dev->bulk_in_buffer);
 222         kfree(dev);
 223 }
 224
 225 static int idmouse_open(struct inode *inode, struct file *file)
 226 {
 227         struct usb_idmouse *dev;
 228         struct usb_interface *interface;
 229         int result;
 230
 231         /* get the interface from minor number and driver information */
 232         interface = usb_find_interface (&idmouse_driver, iminor (inode));
 233         if (!interface)
 234                 return -ENODEV;
 235
 236         mutex_lock(&open_disc_mutex);
 237         /* get the device information block from the interface */
 238         dev = usb_get_intfdata(interface);
 239         if (!dev) {
 240                 mutex_unlock(&open_disc_mutex);
 241                 return -ENODEV;
 242         }
 243
 244         /* lock this device */
 245         mutex_lock(&dev->lock);
 246         mutex_unlock(&open_disc_mutex);
 247
 248         /* check if already open */
 249         if (dev->open) {
 250
 251                 /* already open, so fail */
 252                 result = -EBUSY;
 253
 254         } else {
 255
 256                 /* create a new image and check for success */
 257                 result = usb_autopm_get_interface(interface);
 258                 if (result)
 259                         goto error;
 260                 result = idmouse_create_image (dev);
 261                 usb_autopm_put_interface(interface);
 262                 if (result)
 263                         goto error;
 264
 265                 /* increment our usage count for the driver */
 266                 ++dev->open;
 267
 268                 /* save our object in the file's private structure */
 269                 file->private_data = dev;
 270
 271         }
 272
 273 error:
 274
 275         /* unlock this device */
 276         mutex_unlock(&dev->lock);
 277         return result;
 278 }
 279
 280 static int idmouse_release(struct inode *inode, struct file *file)
 281 {
 282         struct usb_idmouse *dev;
 283
 284         dev = file->private_data;
 285
 286         if (dev == NULL)
 287                 return -ENODEV;
 288
 289         mutex_lock(&open_disc_mutex);
 290         /* lock our device */
 291         mutex_lock(&dev->lock);
 292
 293         /* are we really open? */
 294         if (dev->open <= 0) {
 295                 mutex_unlock(&dev->lock);
 296                 mutex_unlock(&open_disc_mutex);
 297                 return -ENODEV;
 298         }
 299
 300         --dev->open;
 301
 302         if (!dev->present) {
 303                 /* the device was unplugged before the file was released */
 304                 mutex_unlock(&dev->lock);
 305                 mutex_unlock(&open_disc_mutex);
 306                 idmouse_delete(dev);
 307         } else {
 308                 mutex_unlock(&dev->lock);
 309                 mutex_unlock(&open_disc_mutex);
 310         }
 311         return 0;
 312 }
 313
 314 static ssize_t idmouse_read(struct file *file, char __user *buffer, size_t count,
 315                                 loff_t * ppos)
 316 {
 317         struct usb_idmouse *dev = file->private_data;
 318         int result;
 319
 320         /* lock this object */
 321         mutex_lock(&dev->lock);
 322
 323         /* verify that the device wasn't unplugged */
 324         if (!dev->present) {
 325                 mutex_unlock(&dev->lock);
 326                 return -ENODEV;
 327         }
 328
 329         result = simple_read_from_buffer(buffer, count, ppos,
 330                                         dev->bulk_in_buffer, IMGSIZE);
 331         /* unlock the device */
 332         mutex_unlock(&dev->lock);
 333         return result;
 334 }
 335
 336 static int idmouse_probe(struct usb_interface *interface,
 337                                 const struct usb_device_id *id)
 338 {
 339         struct usb_device *udev = interface_to_usbdev(interface);
 340         struct usb_idmouse *dev;
 341         struct usb_host_interface *iface_desc;
 342         struct usb_endpoint_descriptor *endpoint;
 343         int result;
 344
 345         /* check if we have gotten the data or the hid interface */
 346         iface_desc = &interface->altsetting[0];
 347         if (iface_desc->desc.bInterfaceClass != 0x0A)
 348                 return -ENODEV;
 349
 350         if (iface_desc->desc.bNumEndpoints < 1)
 351                 return -ENODEV;
 352
 353         /* allocate memory for our device state and initialize it */
 354         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
 355         if (dev == NULL)
 356                 return -ENOMEM;
 357
 358         mutex_init(&dev->lock);
 359         dev->udev = udev;
 360         dev->interface = interface;
 361
 362         /* set up the endpoint information - use only the first bulk-in endpoint */
 363         result = usb_find_bulk_in_endpoint(iface_desc, &endpoint);
 364         if (result) {
 365                 dev_err(&interface->dev, "Unable to find bulk-in endpoint.\n");
 366                 idmouse_delete(dev);
 367                 return result;
 368         }
 369
 370         dev->orig_bi_size = usb_endpoint_maxp(endpoint);
 371         dev->bulk_in_size = 0x200; /* works _much_ faster */
 372         dev->bulk_in_endpointAddr = endpoint->bEndpointAddress;
 373         dev->bulk_in_buffer = kmalloc(IMGSIZE + dev->bulk_in_size, GFP_KERNEL);
 374         if (!dev->bulk_in_buffer) {
 375                 idmouse_delete(dev);
 376                 return -ENOMEM;
 377         }
 378
 379         /* allow device read, write and ioctl */
 380         dev->present = 1;
 381
 382         /* we can register the device now, as it is ready */
 383         usb_set_intfdata(interface, dev);
 384         result = usb_register_dev(interface, &idmouse_class);
 385         if (result) {
 386                 /* something prevented us from registering this device */
 387                 dev_err(&interface->dev, "Unable to allocate minor number.\n");
 388                 usb_set_intfdata(interface, NULL);
 389                 idmouse_delete(dev);
 390                 return result;
 391         }
 392
 393         /* be noisy */
 394         dev_info(&interface->dev,"%s now attached\n",DRIVER_DESC);
 395
 396         return 0;
 397 }
 398
 399 static void idmouse_disconnect(struct usb_interface *interface)
 400 {
 401         struct usb_idmouse *dev;
 402
 403         /* get device structure */
 404         dev = usb_get_intfdata(interface);
 405
 406         /* give back our minor */
 407         usb_deregister_dev(interface, &idmouse_class);
 408
 409         mutex_lock(&open_disc_mutex);
 410         usb_set_intfdata(interface, NULL);
 411         /* lock the device */
 412         mutex_lock(&dev->lock);
 413         mutex_unlock(&open_disc_mutex);
 414
 415         /* prevent device read, write and ioctl */
 416         dev->present = 0;
 417
 418         /* if the device is opened, idmouse_release will clean this up */
 419         if (!dev->open) {
 420                 mutex_unlock(&dev->lock);
 421                 idmouse_delete(dev);
 422         } else {
 423                 /* unlock */
 424                 mutex_unlock(&dev->lock);
 425         }
 426
 427         dev_info(&interface->dev, "disconnected\n");
 428 }
 429
 430 module_usb_driver(idmouse_driver);
 431
 432 MODULE_AUTHOR(DRIVER_AUTHOR);
 433 MODULE_DESCRIPTION(DRIVER_DESC);
 434 MODULE_LICENSE("GPL");
 435