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