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/slab.h> 23 #include <linux/module.h> 24 #include <linux/completion.h> 25 #include <linux/mutex.h> 26 #include <asm/uaccess.h> 27 #include <linux/usb.h> 28 29 /* image constants */ 30 #define WIDTH 225 31 #define HEIGHT 289 32 #define HEADER "P5 225 289 255 " 33 #define IMGSIZE ((WIDTH * HEIGHT) + sizeof(HEADER)-1) 34 35 /* version information */ 36 #define DRIVER_VERSION "0.6" 37 #define DRIVER_SHORT "idmouse" 38 #define DRIVER_AUTHOR "Florian 'Floe' Echtler <echtler@fs.tum.de>" 39 #define DRIVER_DESC "Siemens ID Mouse FingerTIP Sensor Driver" 40 41 /* minor number for misc USB devices */ 42 #define USB_IDMOUSE_MINOR_BASE 132 43 44 /* vendor and device IDs */ 45 #define ID_SIEMENS 0x0681 46 #define ID_IDMOUSE 0x0005 47 #define ID_CHERRY 0x0010 48 49 /* device ID table */ 50 static const struct usb_device_id idmouse_table[] = { 51 {USB_DEVICE(ID_SIEMENS, ID_IDMOUSE)}, /* Siemens ID Mouse (Professional) */ 52 {USB_DEVICE(ID_SIEMENS, ID_CHERRY )}, /* Cherry FingerTIP ID Board */ 53 {} /* terminating null entry */ 54 }; 55 56 /* sensor commands */ 57 #define FTIP_RESET 0x20 58 #define FTIP_ACQUIRE 0x21 59 #define FTIP_RELEASE 0x22 60 #define FTIP_BLINK 0x23 /* LSB of value = blink pulse width */ 61 #define FTIP_SCROLL 0x24 62 63 #define ftip_command(dev, command, value, index) \ 64 usb_control_msg (dev->udev, usb_sndctrlpipe (dev->udev, 0), command, \ 65 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT, value, index, NULL, 0, 1000) 66 67 MODULE_DEVICE_TABLE(usb, idmouse_table); 68 static DEFINE_MUTEX(open_disc_mutex); 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 mutex lock; /* 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 static int idmouse_suspend(struct usb_interface *intf, pm_message_t message); 99 static int idmouse_resume(struct usb_interface *intf); 100 101 /* file operation pointers */ 102 static const struct file_operations idmouse_fops = { 103 .owner = THIS_MODULE, 104 .read = idmouse_read, 105 .open = idmouse_open, 106 .release = idmouse_release, 107 .llseek = default_llseek, 108 }; 109 110 /* class driver information */ 111 static struct usb_class_driver idmouse_class = { 112 .name = "idmouse%d", 113 .fops = &idmouse_fops, 114 .minor_base = USB_IDMOUSE_MINOR_BASE, 115 }; 116 117 /* usb specific object needed to register this driver with the usb subsystem */ 118 static struct usb_driver idmouse_driver = { 119 .name = DRIVER_SHORT, 120 .probe = idmouse_probe, 121 .disconnect = idmouse_disconnect, 122 .suspend = idmouse_suspend, 123 .resume = idmouse_resume, 124 .reset_resume = idmouse_resume, 125 .id_table = idmouse_table, 126 .supports_autosuspend = 1, 127 }; 128 129 static int idmouse_create_image(struct usb_idmouse *dev) 130 { 131 int bytes_read; 132 int bulk_read; 133 int result; 134 135 memcpy(dev->bulk_in_buffer, HEADER, sizeof(HEADER)-1); 136 bytes_read = sizeof(HEADER)-1; 137 138 /* reset the device and set a fast blink rate */ 139 result = ftip_command(dev, FTIP_RELEASE, 0, 0); 140 if (result < 0) 141 goto reset; 142 result = ftip_command(dev, FTIP_BLINK, 1, 0); 143 if (result < 0) 144 goto reset; 145 146 /* initialize the sensor - sending this command twice */ 147 /* significantly reduces the rate of failed reads */ 148 result = ftip_command(dev, FTIP_ACQUIRE, 0, 0); 149 if (result < 0) 150 goto reset; 151 result = ftip_command(dev, FTIP_ACQUIRE, 0, 0); 152 if (result < 0) 153 goto reset; 154 155 /* start the readout - sending this command twice */ 156 /* presumably enables the high dynamic range mode */ 157 result = ftip_command(dev, FTIP_RESET, 0, 0); 158 if (result < 0) 159 goto reset; 160 result = ftip_command(dev, FTIP_RESET, 0, 0); 161 if (result < 0) 162 goto reset; 163 164 /* loop over a blocking bulk read to get data from the device */ 165 while (bytes_read < IMGSIZE) { 166 result = usb_bulk_msg (dev->udev, 167 usb_rcvbulkpipe (dev->udev, dev->bulk_in_endpointAddr), 168 dev->bulk_in_buffer + bytes_read, 169 dev->bulk_in_size, &bulk_read, 5000); 170 if (result < 0) { 171 /* Maybe this error was caused by the increased packet size? */ 172 /* Reset to the original value and tell userspace to retry. */ 173 if (dev->bulk_in_size != dev->orig_bi_size) { 174 dev->bulk_in_size = dev->orig_bi_size; 175 result = -EAGAIN; 176 } 177 break; 178 } 179 if (signal_pending(current)) { 180 result = -EINTR; 181 break; 182 } 183 bytes_read += bulk_read; 184 } 185 186 /* reset the device */ 187 reset: 188 ftip_command(dev, FTIP_RELEASE, 0, 0); 189 190 /* check for valid image */ 191 /* right border should be black (0x00) */ 192 for (bytes_read = sizeof(HEADER)-1 + WIDTH-1; bytes_read < IMGSIZE; bytes_read += WIDTH) 193 if (dev->bulk_in_buffer[bytes_read] != 0x00) 194 return -EAGAIN; 195 196 /* lower border should be white (0xFF) */ 197 for (bytes_read = IMGSIZE-WIDTH; bytes_read < IMGSIZE-1; bytes_read++) 198 if (dev->bulk_in_buffer[bytes_read] != 0xFF) 199 return -EAGAIN; 200 201 /* should be IMGSIZE == 65040 */ 202 dev_dbg(&dev->interface->dev, "read %d bytes fingerprint data\n", 203 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 /* allocate memory for our device state and initialize it */ 350 dev = kzalloc(sizeof(*dev), GFP_KERNEL); 351 if (dev == NULL) 352 return -ENOMEM; 353 354 mutex_init(&dev->lock); 355 dev->udev = udev; 356 dev->interface = interface; 357 358 /* set up the endpoint information - use only the first bulk-in endpoint */ 359 endpoint = &iface_desc->endpoint[0].desc; 360 if (!dev->bulk_in_endpointAddr && usb_endpoint_is_bulk_in(endpoint)) { 361 /* we found a bulk in endpoint */ 362 dev->orig_bi_size = usb_endpoint_maxp(endpoint); 363 dev->bulk_in_size = 0x200; /* works _much_ faster */ 364 dev->bulk_in_endpointAddr = endpoint->bEndpointAddress; 365 dev->bulk_in_buffer = 366 kmalloc(IMGSIZE + dev->bulk_in_size, GFP_KERNEL); 367 368 if (!dev->bulk_in_buffer) { 369 dev_err(&interface->dev, "Unable to allocate input buffer.\n"); 370 idmouse_delete(dev); 371 return -ENOMEM; 372 } 373 } 374 375 if (!(dev->bulk_in_endpointAddr)) { 376 dev_err(&interface->dev, "Unable to find bulk-in endpoint.\n"); 377 idmouse_delete(dev); 378 return -ENODEV; 379 } 380 /* allow device read, write and ioctl */ 381 dev->present = 1; 382 383 /* we can register the device now, as it is ready */ 384 usb_set_intfdata(interface, dev); 385 result = usb_register_dev(interface, &idmouse_class); 386 if (result) { 387 /* something prevented us from registering this device */ 388 dev_err(&interface->dev, "Unable to allocate minor number.\n"); 389 usb_set_intfdata(interface, NULL); 390 idmouse_delete(dev); 391 return result; 392 } 393 394 /* be noisy */ 395 dev_info(&interface->dev,"%s now attached\n",DRIVER_DESC); 396 397 return 0; 398 } 399 400 static void idmouse_disconnect(struct usb_interface *interface) 401 { 402 struct usb_idmouse *dev; 403 404 /* get device structure */ 405 dev = usb_get_intfdata(interface); 406 407 /* give back our minor */ 408 usb_deregister_dev(interface, &idmouse_class); 409 410 mutex_lock(&open_disc_mutex); 411 usb_set_intfdata(interface, NULL); 412 /* lock the device */ 413 mutex_lock(&dev->lock); 414 mutex_unlock(&open_disc_mutex); 415 416 /* prevent device read, write and ioctl */ 417 dev->present = 0; 418 419 /* if the device is opened, idmouse_release will clean this up */ 420 if (!dev->open) { 421 mutex_unlock(&dev->lock); 422 idmouse_delete(dev); 423 } else { 424 /* unlock */ 425 mutex_unlock(&dev->lock); 426 } 427 428 dev_info(&interface->dev, "disconnected\n"); 429 } 430 431 module_usb_driver(idmouse_driver); 432 433 MODULE_AUTHOR(DRIVER_AUTHOR); 434 MODULE_DESCRIPTION(DRIVER_DESC); 435 MODULE_LICENSE("GPL"); 436 437