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