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/config.h> 20 #include <linux/kernel.h> 21 #include <linux/errno.h> 22 #include <linux/delay.h> 23 #include <linux/init.h> 24 #include <linux/slab.h> 25 #include <linux/module.h> 26 #include <linux/smp_lock.h> 27 #include <linux/completion.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 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 for devfs */ 109 static struct usb_class_driver idmouse_class = { 110 .name = "usb/idmouse%d", 111 .fops = &idmouse_fops, 112 .mode = S_IFCHR | S_IRUSR | S_IRGRP | S_IROTH, /* filemode (char, 444) */ 113 .minor_base = USB_IDMOUSE_MINOR_BASE, 114 }; 115 116 /* usb specific object needed to register this driver with the usb subsystem */ 117 static struct usb_driver idmouse_driver = { 118 .owner = THIS_MODULE, 119 .name = DRIVER_SHORT, 120 .probe = idmouse_probe, 121 .disconnect = idmouse_disconnect, 122 .id_table = idmouse_table, 123 }; 124 125 /* prevent races between open() and disconnect() */ 126 static DECLARE_MUTEX(disconnect_sem); 127 128 static int idmouse_create_image(struct usb_idmouse *dev) 129 { 130 int bytes_read = 0; 131 int bulk_read = 0; 132 int result = 0; 133 134 memcpy(dev->bulk_in_buffer, HEADER, sizeof(HEADER)-1); 135 bytes_read += sizeof(HEADER)-1; 136 137 /* reset the device and set a fast blink rate */ 138 result = ftip_command(dev, FTIP_RELEASE, 0, 0); 139 if (result < 0) 140 goto reset; 141 result = ftip_command(dev, FTIP_BLINK, 1, 0); 142 if (result < 0) 143 goto reset; 144 145 /* initialize the sensor - sending this command twice */ 146 /* significantly reduces the rate of failed reads */ 147 result = ftip_command(dev, FTIP_ACQUIRE, 0, 0); 148 if (result < 0) 149 goto reset; 150 result = ftip_command(dev, FTIP_ACQUIRE, 0, 0); 151 if (result < 0) 152 goto reset; 153 154 /* start the readout - sending this command twice */ 155 /* presumably enables the high dynamic range mode */ 156 result = ftip_command(dev, FTIP_RESET, 0, 0); 157 if (result < 0) 158 goto reset; 159 result = ftip_command(dev, FTIP_RESET, 0, 0); 160 if (result < 0) 161 goto reset; 162 163 /* loop over a blocking bulk read to get data from the device */ 164 while (bytes_read < IMGSIZE) { 165 result = usb_bulk_msg (dev->udev, 166 usb_rcvbulkpipe (dev->udev, dev->bulk_in_endpointAddr), 167 dev->bulk_in_buffer + bytes_read, 168 dev->bulk_in_size, &bulk_read, 5000); 169 if (result < 0) { 170 /* Maybe this error was caused by the increased packet size? */ 171 /* Reset to the original value and tell userspace to retry. */ 172 if (dev->bulk_in_size != dev->orig_bi_size) { 173 dev->bulk_in_size = dev->orig_bi_size; 174 result = -EAGAIN; 175 } 176 break; 177 } 178 if (signal_pending(current)) { 179 result = -EINTR; 180 break; 181 } 182 bytes_read += bulk_read; 183 } 184 185 /* reset the device */ 186 reset: 187 ftip_command(dev, FTIP_RELEASE, 0, 0); 188 189 /* check for valid image */ 190 /* right border should be black (0x00) */ 191 for (bytes_read = sizeof(HEADER)-1 + WIDTH-1; bytes_read < IMGSIZE; bytes_read += WIDTH) 192 if (dev->bulk_in_buffer[bytes_read] != 0x00) 193 return -EAGAIN; 194 195 /* lower border should be white (0xFF) */ 196 for (bytes_read = IMGSIZE-WIDTH; bytes_read < IMGSIZE-1; bytes_read++) 197 if (dev->bulk_in_buffer[bytes_read] != 0xFF) 198 return -EAGAIN; 199 200 /* should be IMGSIZE == 65040 */ 201 dbg("read %d bytes fingerprint data", bytes_read); 202 return result; 203 } 204 205 static inline void idmouse_delete(struct usb_idmouse *dev) 206 { 207 kfree(dev->bulk_in_buffer); 208 kfree(dev); 209 } 210 211 static int idmouse_open(struct inode *inode, struct file *file) 212 { 213 struct usb_idmouse *dev = NULL; 214 struct usb_interface *interface; 215 int result = 0; 216 217 /* prevent disconnects */ 218 down(&disconnect_sem); 219 220 /* get the interface from minor number and driver information */ 221 interface = usb_find_interface (&idmouse_driver, iminor (inode)); 222 if (!interface) { 223 up(&disconnect_sem); 224 return -ENODEV; 225 } 226 /* get the device information block from the interface */ 227 dev = usb_get_intfdata(interface); 228 if (!dev) { 229 up(&disconnect_sem); 230 return -ENODEV; 231 } 232 233 /* lock this device */ 234 down(&dev->sem); 235 236 /* check if already open */ 237 if (dev->open) { 238 239 /* already open, so fail */ 240 result = -EBUSY; 241 242 } else { 243 244 /* create a new image and check for success */ 245 result = idmouse_create_image (dev); 246 if (result) 247 goto error; 248 249 /* increment our usage count for the driver */ 250 ++dev->open; 251 252 /* save our object in the file's private structure */ 253 file->private_data = dev; 254 255 } 256 257 error: 258 259 /* unlock this device */ 260 up(&dev->sem); 261 262 /* unlock the disconnect semaphore */ 263 up(&disconnect_sem); 264 return result; 265 } 266 267 static int idmouse_release(struct inode *inode, struct file *file) 268 { 269 struct usb_idmouse *dev; 270 271 /* prevent a race condition with open() */ 272 down(&disconnect_sem); 273 274 dev = (struct usb_idmouse *) file->private_data; 275 276 if (dev == NULL) { 277 up(&disconnect_sem); 278 return -ENODEV; 279 } 280 281 /* lock our device */ 282 down(&dev->sem); 283 284 /* are we really open? */ 285 if (dev->open <= 0) { 286 up(&dev->sem); 287 up(&disconnect_sem); 288 return -ENODEV; 289 } 290 291 --dev->open; 292 293 if (!dev->present) { 294 /* the device was unplugged before the file was released */ 295 up(&dev->sem); 296 idmouse_delete(dev); 297 up(&disconnect_sem); 298 return 0; 299 } 300 301 up(&dev->sem); 302 up(&disconnect_sem); 303 return 0; 304 } 305 306 static ssize_t idmouse_read(struct file *file, char __user *buffer, size_t count, 307 loff_t * ppos) 308 { 309 struct usb_idmouse *dev; 310 int result = 0; 311 312 dev = (struct usb_idmouse *) file->private_data; 313 314 /* lock this object */ 315 down (&dev->sem); 316 317 /* verify that the device wasn't unplugged */ 318 if (!dev->present) { 319 up (&dev->sem); 320 return -ENODEV; 321 } 322 323 if (*ppos >= IMGSIZE) { 324 up (&dev->sem); 325 return 0; 326 } 327 328 count = min ((loff_t)count, IMGSIZE - (*ppos)); 329 330 if (copy_to_user (buffer, dev->bulk_in_buffer + *ppos, count)) { 331 result = -EFAULT; 332 } else { 333 result = count; 334 *ppos += count; 335 } 336 337 /* unlock the device */ 338 up(&dev->sem); 339 return result; 340 } 341 342 static int idmouse_probe(struct usb_interface *interface, 343 const struct usb_device_id *id) 344 { 345 struct usb_device *udev = interface_to_usbdev(interface); 346 struct usb_idmouse *dev = NULL; 347 struct usb_host_interface *iface_desc; 348 struct usb_endpoint_descriptor *endpoint; 349 int result; 350 351 /* check if we have gotten the data or the hid interface */ 352 iface_desc = &interface->altsetting[0]; 353 if (iface_desc->desc.bInterfaceClass != 0x0A) 354 return -ENODEV; 355 356 /* allocate memory for our device state and initialize it */ 357 dev = kmalloc(sizeof(*dev), GFP_KERNEL); 358 if (dev == NULL) 359 return -ENOMEM; 360 memset(dev, 0x00, sizeof(*dev)); 361 362 init_MUTEX(&dev->sem); 363 dev->udev = udev; 364 dev->interface = interface; 365 366 /* set up the endpoint information - use only the first bulk-in endpoint */ 367 endpoint = &iface_desc->endpoint[0].desc; 368 if (!dev->bulk_in_endpointAddr 369 && (endpoint->bEndpointAddress & USB_DIR_IN) 370 && ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == 371 USB_ENDPOINT_XFER_BULK)) { 372 373 /* we found a bulk in endpoint */ 374 dev->orig_bi_size = le16_to_cpu(endpoint->wMaxPacketSize); 375 dev->bulk_in_size = 0x200; /* works _much_ faster */ 376 dev->bulk_in_endpointAddr = endpoint->bEndpointAddress; 377 dev->bulk_in_buffer = 378 kmalloc(IMGSIZE + dev->bulk_in_size, GFP_KERNEL); 379 380 if (!dev->bulk_in_buffer) { 381 err("Unable to allocate input buffer."); 382 idmouse_delete(dev); 383 return -ENOMEM; 384 } 385 } 386 387 if (!(dev->bulk_in_endpointAddr)) { 388 err("Unable to find bulk-in endpoint."); 389 idmouse_delete(dev); 390 return -ENODEV; 391 } 392 /* allow device read, write and ioctl */ 393 dev->present = 1; 394 395 /* we can register the device now, as it is ready */ 396 usb_set_intfdata(interface, dev); 397 result = usb_register_dev(interface, &idmouse_class); 398 if (result) { 399 /* something prevented us from registering this device */ 400 err("Unble to allocate minor number."); 401 usb_set_intfdata(interface, NULL); 402 idmouse_delete(dev); 403 return result; 404 } 405 406 /* be noisy */ 407 dev_info(&interface->dev,"%s now attached\n",DRIVER_DESC); 408 409 return 0; 410 } 411 412 static void idmouse_disconnect(struct usb_interface *interface) 413 { 414 struct usb_idmouse *dev; 415 416 /* prevent races with open() */ 417 down(&disconnect_sem); 418 419 /* get device structure */ 420 dev = usb_get_intfdata(interface); 421 usb_set_intfdata(interface, NULL); 422 423 /* lock it */ 424 down(&dev->sem); 425 426 /* give back our minor */ 427 usb_deregister_dev(interface, &idmouse_class); 428 429 /* prevent device read, write and ioctl */ 430 dev->present = 0; 431 432 /* unlock */ 433 up(&dev->sem); 434 435 /* if the device is opened, idmouse_release will clean this up */ 436 if (!dev->open) 437 idmouse_delete(dev); 438 439 up(&disconnect_sem); 440 441 info("%s disconnected", DRIVER_DESC); 442 } 443 444 static int __init usb_idmouse_init(void) 445 { 446 int result; 447 448 info(DRIVER_DESC " " DRIVER_VERSION); 449 450 /* register this driver with the USB subsystem */ 451 result = usb_register(&idmouse_driver); 452 if (result) 453 err("Unable to register device (error %d).", result); 454 455 return result; 456 } 457 458 static void __exit usb_idmouse_exit(void) 459 { 460 /* deregister this driver with the USB subsystem */ 461 usb_deregister(&idmouse_driver); 462 } 463 464 module_init(usb_idmouse_init); 465 module_exit(usb_idmouse_exit); 466 467 MODULE_AUTHOR(DRIVER_AUTHOR); 468 MODULE_DESCRIPTION(DRIVER_DESC); 469 MODULE_LICENSE("GPL"); 470 471