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