blob: 3944a55ed74cecabdd1b9d24415f22bdc8e5069e [file] [log] [blame]
Florian Echtler4244f722005-05-06 19:05:39 +02001/* Siemens ID Mouse driver v0.6
Linus Torvalds1da177e2005-04-16 15:20:36 -07002
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
Florian Echtler4244f722005-05-06 19:05:39 +020014 Additional information provided by Martin Reising
15 <Martin.Reising@natural-computing.de>
16
Linus Torvalds1da177e2005-04-16 15:20:36 -070017*/
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
Florian Echtler4244f722005-05-06 19:05:39 +020031/* image constants */
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#define WIDTH 225
Florian Echtler4244f722005-05-06 19:05:39 +020033#define HEIGHT 289
34#define HEADER "P5 225 289 255 "
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#define IMGSIZE ((WIDTH * HEIGHT) + sizeof(HEADER)-1)
36
Florian Echtler4244f722005-05-06 19:05:39 +020037/* version information */
38#define DRIVER_VERSION "0.6"
Linus Torvalds1da177e2005-04-16 15:20:36 -070039#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
Florian Echtler4244f722005-05-06 19:05:39 +020043/* minor number for misc USB devices */
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#define USB_IDMOUSE_MINOR_BASE 132
45
Florian Echtler4244f722005-05-06 19:05:39 +020046/* vendor and device IDs */
47#define ID_SIEMENS 0x0681
48#define ID_IDMOUSE 0x0005
49#define ID_CHERRY 0x0010
50
51/* device ID table */
Linus Torvalds1da177e2005-04-16 15:20:36 -070052static struct usb_device_id idmouse_table[] = {
Florian Echtler4244f722005-05-06 19:05:39 +020053 {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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070056};
57
Florian Echtler4244f722005-05-06 19:05:39 +020058/* 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070069MODULE_DEVICE_TABLE(usb, idmouse_table);
70
71/* structure to hold all of our device specific stuff */
72struct 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 */
Florian Echtler4244f722005-05-06 19:05:39 +020078 size_t bulk_in_size; /* the maximum bulk packet size */
79 size_t orig_bi_size; /* same as above, but reported by the device */
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 __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 */
89static ssize_t idmouse_read(struct file *file, char __user *buffer,
90 size_t count, loff_t * ppos);
91
92static int idmouse_open(struct inode *inode, struct file *file);
93static int idmouse_release(struct inode *inode, struct file *file);
94
95static int idmouse_probe(struct usb_interface *interface,
96 const struct usb_device_id *id);
97
98static void idmouse_disconnect(struct usb_interface *interface);
99
100/* file operation pointers */
101static struct file_operations idmouse_fops = {
102 .owner = THIS_MODULE,
103 .read = idmouse_read,
104 .open = idmouse_open,
105 .release = idmouse_release,
106};
107
Greg Kroah-Hartmand6e5bcf2005-06-20 21:15:16 -0700108/* class driver information */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109static struct usb_class_driver idmouse_class = {
Greg Kroah-Hartmand6e5bcf2005-06-20 21:15:16 -0700110 .name = "idmouse%d",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 .fops = &idmouse_fops,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 .minor_base = USB_IDMOUSE_MINOR_BASE,
113};
114
115/* usb specific object needed to register this driver with the usb subsystem */
116static struct usb_driver idmouse_driver = {
117 .owner = THIS_MODULE,
118 .name = DRIVER_SHORT,
119 .probe = idmouse_probe,
120 .disconnect = idmouse_disconnect,
121 .id_table = idmouse_table,
122};
123
Florian Echtler4244f722005-05-06 19:05:39 +0200124/* prevent races between open() and disconnect() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125static DECLARE_MUTEX(disconnect_sem);
126
127static int idmouse_create_image(struct usb_idmouse *dev)
128{
129 int bytes_read = 0;
130 int bulk_read = 0;
131 int result = 0;
132
Florian Echtler4244f722005-05-06 19:05:39 +0200133 memcpy(dev->bulk_in_buffer, HEADER, sizeof(HEADER)-1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 bytes_read += sizeof(HEADER)-1;
135
Florian Echtler4244f722005-05-06 19:05:39 +0200136 /* reset the device and set a fast blink rate */
137 result = ftip_command(dev, FTIP_RELEASE, 0, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 if (result < 0)
Florian Echtler4244f722005-05-06 19:05:39 +0200139 goto reset;
140 result = ftip_command(dev, FTIP_BLINK, 1, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 if (result < 0)
Florian Echtler4244f722005-05-06 19:05:39 +0200142 goto reset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143
Florian Echtler4244f722005-05-06 19:05:39 +0200144 /* initialize the sensor - sending this command twice */
145 /* significantly reduces the rate of failed reads */
146 result = ftip_command(dev, FTIP_ACQUIRE, 0, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 if (result < 0)
Florian Echtler4244f722005-05-06 19:05:39 +0200148 goto reset;
149 result = ftip_command(dev, FTIP_ACQUIRE, 0, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 if (result < 0)
Florian Echtler4244f722005-05-06 19:05:39 +0200151 goto reset;
152
153 /* start the readout - sending this command twice */
154 /* presumably enables the high dynamic range mode */
155 result = ftip_command(dev, FTIP_RESET, 0, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 if (result < 0)
Florian Echtler4244f722005-05-06 19:05:39 +0200157 goto reset;
158 result = ftip_command(dev, FTIP_RESET, 0, 0);
159 if (result < 0)
160 goto reset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
162 /* loop over a blocking bulk read to get data from the device */
163 while (bytes_read < IMGSIZE) {
164 result = usb_bulk_msg (dev->udev,
165 usb_rcvbulkpipe (dev->udev, dev->bulk_in_endpointAddr),
166 dev->bulk_in_buffer + bytes_read,
167 dev->bulk_in_size, &bulk_read, 5000);
Florian Echtler4244f722005-05-06 19:05:39 +0200168 if (result < 0) {
169 /* Maybe this error was caused by the increased packet size? */
170 /* Reset to the original value and tell userspace to retry. */
171 if (dev->bulk_in_size != dev->orig_bi_size) {
172 dev->bulk_in_size = dev->orig_bi_size;
173 result = -EAGAIN;
174 }
175 break;
176 }
177 if (signal_pending(current)) {
178 result = -EINTR;
179 break;
180 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 bytes_read += bulk_read;
182 }
183
184 /* reset the device */
Florian Echtler4244f722005-05-06 19:05:39 +0200185reset:
186 ftip_command(dev, FTIP_RELEASE, 0, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187
Florian Echtler4244f722005-05-06 19:05:39 +0200188 /* check for valid image */
189 /* right border should be black (0x00) */
190 for (bytes_read = sizeof(HEADER)-1 + WIDTH-1; bytes_read < IMGSIZE; bytes_read += WIDTH)
191 if (dev->bulk_in_buffer[bytes_read] != 0x00)
192 return -EAGAIN;
193
194 /* lower border should be white (0xFF) */
195 for (bytes_read = IMGSIZE-WIDTH; bytes_read < IMGSIZE-1; bytes_read++)
196 if (dev->bulk_in_buffer[bytes_read] != 0xFF)
197 return -EAGAIN;
198
199 /* should be IMGSIZE == 65040 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 dbg("read %d bytes fingerprint data", bytes_read);
Florian Echtler4244f722005-05-06 19:05:39 +0200201 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202}
203
204static inline void idmouse_delete(struct usb_idmouse *dev)
205{
206 kfree(dev->bulk_in_buffer);
207 kfree(dev);
208}
209
210static int idmouse_open(struct inode *inode, struct file *file)
211{
212 struct usb_idmouse *dev = NULL;
213 struct usb_interface *interface;
214 int result = 0;
215
216 /* prevent disconnects */
217 down(&disconnect_sem);
218
219 /* get the interface from minor number and driver information */
220 interface = usb_find_interface (&idmouse_driver, iminor (inode));
221 if (!interface) {
222 up(&disconnect_sem);
223 return -ENODEV;
224 }
225 /* get the device information block from the interface */
226 dev = usb_get_intfdata(interface);
227 if (!dev) {
228 up(&disconnect_sem);
229 return -ENODEV;
230 }
231
232 /* lock this device */
233 down(&dev->sem);
234
235 /* check if already open */
236 if (dev->open) {
237
238 /* already open, so fail */
239 result = -EBUSY;
240
241 } else {
242
243 /* create a new image and check for success */
244 result = idmouse_create_image (dev);
245 if (result)
246 goto error;
247
248 /* increment our usage count for the driver */
249 ++dev->open;
250
251 /* save our object in the file's private structure */
252 file->private_data = dev;
253
254 }
255
256error:
257
258 /* unlock this device */
259 up(&dev->sem);
260
261 /* unlock the disconnect semaphore */
262 up(&disconnect_sem);
263 return result;
264}
265
266static int idmouse_release(struct inode *inode, struct file *file)
267{
268 struct usb_idmouse *dev;
269
270 /* prevent a race condition with open() */
271 down(&disconnect_sem);
272
273 dev = (struct usb_idmouse *) file->private_data;
274
275 if (dev == NULL) {
276 up(&disconnect_sem);
277 return -ENODEV;
278 }
279
280 /* lock our device */
281 down(&dev->sem);
282
283 /* are we really open? */
284 if (dev->open <= 0) {
285 up(&dev->sem);
286 up(&disconnect_sem);
287 return -ENODEV;
288 }
289
290 --dev->open;
291
292 if (!dev->present) {
293 /* the device was unplugged before the file was released */
294 up(&dev->sem);
295 idmouse_delete(dev);
296 up(&disconnect_sem);
297 return 0;
298 }
299
300 up(&dev->sem);
301 up(&disconnect_sem);
302 return 0;
303}
304
305static ssize_t idmouse_read(struct file *file, char __user *buffer, size_t count,
306 loff_t * ppos)
307{
308 struct usb_idmouse *dev;
309 int result = 0;
310
311 dev = (struct usb_idmouse *) file->private_data;
312
Florian Echtler4244f722005-05-06 19:05:39 +0200313 /* lock this object */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 down (&dev->sem);
315
Florian Echtler4244f722005-05-06 19:05:39 +0200316 /* verify that the device wasn't unplugged */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 if (!dev->present) {
318 up (&dev->sem);
319 return -ENODEV;
320 }
321
322 if (*ppos >= IMGSIZE) {
323 up (&dev->sem);
324 return 0;
325 }
326
Florian Echtler4244f722005-05-06 19:05:39 +0200327 count = min ((loff_t)count, IMGSIZE - (*ppos));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328
329 if (copy_to_user (buffer, dev->bulk_in_buffer + *ppos, count)) {
330 result = -EFAULT;
331 } else {
332 result = count;
333 *ppos += count;
334 }
335
Florian Echtler4244f722005-05-06 19:05:39 +0200336 /* unlock the device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 up(&dev->sem);
338 return result;
339}
340
341static int idmouse_probe(struct usb_interface *interface,
342 const struct usb_device_id *id)
343{
344 struct usb_device *udev = interface_to_usbdev(interface);
345 struct usb_idmouse *dev = NULL;
346 struct usb_host_interface *iface_desc;
347 struct usb_endpoint_descriptor *endpoint;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 int result;
349
350 /* check if we have gotten the data or the hid interface */
351 iface_desc = &interface->altsetting[0];
352 if (iface_desc->desc.bInterfaceClass != 0x0A)
353 return -ENODEV;
354
355 /* allocate memory for our device state and initialize it */
356 dev = kmalloc(sizeof(*dev), GFP_KERNEL);
357 if (dev == NULL)
358 return -ENOMEM;
359 memset(dev, 0x00, sizeof(*dev));
360
361 init_MUTEX(&dev->sem);
362 dev->udev = udev;
363 dev->interface = interface;
364
365 /* set up the endpoint information - use only the first bulk-in endpoint */
366 endpoint = &iface_desc->endpoint[0].desc;
367 if (!dev->bulk_in_endpointAddr
368 && (endpoint->bEndpointAddress & USB_DIR_IN)
369 && ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
370 USB_ENDPOINT_XFER_BULK)) {
371
372 /* we found a bulk in endpoint */
Florian Echtler4244f722005-05-06 19:05:39 +0200373 dev->orig_bi_size = le16_to_cpu(endpoint->wMaxPacketSize);
374 dev->bulk_in_size = 0x200; /* works _much_ faster */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375 dev->bulk_in_endpointAddr = endpoint->bEndpointAddress;
376 dev->bulk_in_buffer =
Florian Echtler4244f722005-05-06 19:05:39 +0200377 kmalloc(IMGSIZE + dev->bulk_in_size, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378
379 if (!dev->bulk_in_buffer) {
380 err("Unable to allocate input buffer.");
381 idmouse_delete(dev);
382 return -ENOMEM;
383 }
384 }
385
386 if (!(dev->bulk_in_endpointAddr)) {
387 err("Unable to find bulk-in endpoint.");
388 idmouse_delete(dev);
389 return -ENODEV;
390 }
391 /* allow device read, write and ioctl */
392 dev->present = 1;
393
394 /* we can register the device now, as it is ready */
395 usb_set_intfdata(interface, dev);
396 result = usb_register_dev(interface, &idmouse_class);
397 if (result) {
398 /* something prevented us from registering this device */
399 err("Unble to allocate minor number.");
400 usb_set_intfdata(interface, NULL);
401 idmouse_delete(dev);
402 return result;
403 }
404
405 /* be noisy */
406 dev_info(&interface->dev,"%s now attached\n",DRIVER_DESC);
407
408 return 0;
409}
410
411static void idmouse_disconnect(struct usb_interface *interface)
412{
413 struct usb_idmouse *dev;
414
415 /* prevent races with open() */
416 down(&disconnect_sem);
417
418 /* get device structure */
419 dev = usb_get_intfdata(interface);
420 usb_set_intfdata(interface, NULL);
421
422 /* lock it */
423 down(&dev->sem);
424
425 /* give back our minor */
426 usb_deregister_dev(interface, &idmouse_class);
427
428 /* prevent device read, write and ioctl */
429 dev->present = 0;
430
431 /* unlock */
432 up(&dev->sem);
433
434 /* if the device is opened, idmouse_release will clean this up */
435 if (!dev->open)
436 idmouse_delete(dev);
437
438 up(&disconnect_sem);
439
440 info("%s disconnected", DRIVER_DESC);
441}
442
443static int __init usb_idmouse_init(void)
444{
445 int result;
446
447 info(DRIVER_DESC " " DRIVER_VERSION);
448
449 /* register this driver with the USB subsystem */
450 result = usb_register(&idmouse_driver);
451 if (result)
452 err("Unable to register device (error %d).", result);
453
454 return result;
455}
456
457static void __exit usb_idmouse_exit(void)
458{
459 /* deregister this driver with the USB subsystem */
460 usb_deregister(&idmouse_driver);
461}
462
463module_init(usb_idmouse_init);
464module_exit(usb_idmouse_exit);
465
466MODULE_AUTHOR(DRIVER_AUTHOR);
467MODULE_DESCRIPTION(DRIVER_DESC);
468MODULE_LICENSE("GPL");
469