[PATCH] USB: convert a bunch of USB semaphores to mutexes
[linux-3.10.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/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 <linux/mutex.h>
29 #include <asm/uaccess.h>
30 #include <linux/usb.h>
31
32 /* image constants */
33 #define WIDTH 225
34 #define HEIGHT 289
35 #define HEADER "P5 225 289 255 "
36 #define IMGSIZE ((WIDTH * HEIGHT) + sizeof(HEADER)-1)
37
38 /* version information */
39 #define DRIVER_VERSION "0.6"
40 #define DRIVER_SHORT   "idmouse"
41 #define DRIVER_AUTHOR  "Florian 'Floe' Echtler <echtler@fs.tum.de>"
42 #define DRIVER_DESC    "Siemens ID Mouse FingerTIP Sensor Driver"
43
44 /* minor number for misc USB devices */
45 #define USB_IDMOUSE_MINOR_BASE 132
46
47 /* vendor and device IDs */
48 #define ID_SIEMENS 0x0681
49 #define ID_IDMOUSE 0x0005
50 #define ID_CHERRY  0x0010
51
52 /* device ID table */
53 static struct usb_device_id idmouse_table[] = {
54         {USB_DEVICE(ID_SIEMENS, ID_IDMOUSE)}, /* Siemens ID Mouse (Professional) */
55         {USB_DEVICE(ID_SIEMENS, ID_CHERRY )}, /* Cherry FingerTIP ID Board       */
56         {}                                    /* terminating null entry          */
57 };
58
59 /* sensor commands */
60 #define FTIP_RESET   0x20
61 #define FTIP_ACQUIRE 0x21
62 #define FTIP_RELEASE 0x22
63 #define FTIP_BLINK   0x23  /* LSB of value = blink pulse width */
64 #define FTIP_SCROLL  0x24
65
66 #define ftip_command(dev, command, value, index) \
67         usb_control_msg (dev->udev, usb_sndctrlpipe (dev->udev, 0), command, \
68         USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT, value, index, NULL, 0, 1000)
69
70 MODULE_DEVICE_TABLE(usb, idmouse_table);
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 semaphore sem; /* 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
101 /* file operation pointers */
102 static struct file_operations idmouse_fops = {
103         .owner = THIS_MODULE,
104         .read = idmouse_read,
105         .open = idmouse_open,
106         .release = idmouse_release,
107 };
108
109 /* class driver information */
110 static struct usb_class_driver idmouse_class = {
111         .name = "idmouse%d",
112         .fops = &idmouse_fops,
113         .minor_base = USB_IDMOUSE_MINOR_BASE,
114 };
115
116 /* usb specific object needed to register this driver with the usb subsystem */
117 static struct usb_driver idmouse_driver = {
118         .name = DRIVER_SHORT,
119         .probe = idmouse_probe,
120         .disconnect = idmouse_disconnect,
121         .id_table = idmouse_table,
122 };
123
124 /* prevent races between open() and disconnect() */
125 static DEFINE_MUTEX(disconnect_mutex);
126
127 static int idmouse_create_image(struct usb_idmouse *dev)
128 {
129         int bytes_read = 0;
130         int bulk_read = 0;
131         int result = 0;
132
133         memcpy(dev->bulk_in_buffer, HEADER, sizeof(HEADER)-1);
134         bytes_read += sizeof(HEADER)-1;
135
136         /* reset the device and set a fast blink rate */
137         result = ftip_command(dev, FTIP_RELEASE, 0, 0);
138         if (result < 0)
139                 goto reset;
140         result = ftip_command(dev, FTIP_BLINK,   1, 0);
141         if (result < 0)
142                 goto reset;
143
144         /* initialize the sensor - sending this command twice */
145         /* significantly reduces the rate of failed reads     */
146         result = ftip_command(dev, FTIP_ACQUIRE, 0, 0);
147         if (result < 0)
148                 goto reset;
149         result = ftip_command(dev, FTIP_ACQUIRE, 0, 0);
150         if (result < 0)
151                 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);
156         if (result < 0)
157                 goto reset;
158         result = ftip_command(dev, FTIP_RESET,   0, 0);
159         if (result < 0)
160                 goto reset;
161
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);
168                 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                 }
181                 bytes_read += bulk_read;
182         }
183
184         /* reset the device */
185 reset:
186         ftip_command(dev, FTIP_RELEASE, 0, 0);
187
188         /* 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 */
200         dbg("read %d bytes fingerprint data", bytes_read);
201         return result;
202 }
203
204 static inline void idmouse_delete(struct usb_idmouse *dev)
205 {
206         kfree(dev->bulk_in_buffer);
207         kfree(dev);
208 }
209
210 static 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         mutex_lock(&disconnect_mutex);
218
219         /* get the interface from minor number and driver information */
220         interface = usb_find_interface (&idmouse_driver, iminor (inode));
221         if (!interface) {
222                 mutex_unlock(&disconnect_mutex);
223                 return -ENODEV;
224         }
225         /* get the device information block from the interface */
226         dev = usb_get_intfdata(interface);
227         if (!dev) {
228                 mutex_unlock(&disconnect_mutex);
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
256 error:
257
258         /* unlock this device */
259         up(&dev->sem);
260
261         /* unlock the disconnect semaphore */
262         mutex_unlock(&disconnect_mutex);
263         return result;
264 }
265
266 static int idmouse_release(struct inode *inode, struct file *file)
267 {
268         struct usb_idmouse *dev;
269
270         /* prevent a race condition with open() */
271         mutex_lock(&disconnect_mutex);
272
273         dev = (struct usb_idmouse *) file->private_data;
274
275         if (dev == NULL) {
276                 mutex_unlock(&disconnect_mutex);
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                 mutex_unlock(&disconnect_mutex);
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                 mutex_unlock(&disconnect_mutex);
297                 return 0;
298         }
299
300         up(&dev->sem);
301         mutex_unlock(&disconnect_mutex);
302         return 0;
303 }
304
305 static 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
313         /* lock this object */
314         down (&dev->sem);
315
316         /* verify that the device wasn't unplugged */
317         if (!dev->present) {
318                 up (&dev->sem);
319                 return -ENODEV;
320         }
321
322         result = simple_read_from_buffer(buffer, count, ppos,
323                                         dev->bulk_in_buffer, IMGSIZE);
324         /* unlock the device */
325         up(&dev->sem);
326         return result;
327 }
328
329 static int idmouse_probe(struct usb_interface *interface,
330                                 const struct usb_device_id *id)
331 {
332         struct usb_device *udev = interface_to_usbdev(interface);
333         struct usb_idmouse *dev = NULL;
334         struct usb_host_interface *iface_desc;
335         struct usb_endpoint_descriptor *endpoint;
336         int result;
337
338         /* check if we have gotten the data or the hid interface */
339         iface_desc = &interface->altsetting[0];
340         if (iface_desc->desc.bInterfaceClass != 0x0A)
341                 return -ENODEV;
342
343         /* allocate memory for our device state and initialize it */
344         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
345         if (dev == NULL)
346                 return -ENOMEM;
347
348         init_MUTEX(&dev->sem);
349         dev->udev = udev;
350         dev->interface = interface;
351
352         /* set up the endpoint information - use only the first bulk-in endpoint */
353         endpoint = &iface_desc->endpoint[0].desc;
354         if (!dev->bulk_in_endpointAddr
355                 && (endpoint->bEndpointAddress & USB_DIR_IN)
356                 && ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
357                 USB_ENDPOINT_XFER_BULK)) {
358
359                 /* we found a bulk in endpoint */
360                 dev->orig_bi_size = le16_to_cpu(endpoint->wMaxPacketSize);
361                 dev->bulk_in_size = 0x200; /* works _much_ faster */
362                 dev->bulk_in_endpointAddr = endpoint->bEndpointAddress;
363                 dev->bulk_in_buffer =
364                         kmalloc(IMGSIZE + dev->bulk_in_size, GFP_KERNEL);
365
366                 if (!dev->bulk_in_buffer) {
367                         err("Unable to allocate input buffer.");
368                         idmouse_delete(dev);
369                         return -ENOMEM;
370                 }
371         }
372
373         if (!(dev->bulk_in_endpointAddr)) {
374                 err("Unable to find bulk-in endpoint.");
375                 idmouse_delete(dev);
376                 return -ENODEV;
377         }
378         /* allow device read, write and ioctl */
379         dev->present = 1;
380
381         /* we can register the device now, as it is ready */
382         usb_set_intfdata(interface, dev);
383         result = usb_register_dev(interface, &idmouse_class);
384         if (result) {
385                 /* something prevented us from registering this device */
386                 err("Unble to allocate minor number.");
387                 usb_set_intfdata(interface, NULL);
388                 idmouse_delete(dev);
389                 return result;
390         }
391
392         /* be noisy */
393         dev_info(&interface->dev,"%s now attached\n",DRIVER_DESC);
394
395         return 0;
396 }
397
398 static void idmouse_disconnect(struct usb_interface *interface)
399 {
400         struct usb_idmouse *dev;
401
402         /* prevent races with open() */
403         mutex_lock(&disconnect_mutex);
404
405         /* get device structure */
406         dev = usb_get_intfdata(interface);
407         usb_set_intfdata(interface, NULL);
408
409         /* lock it */
410         down(&dev->sem);
411
412         /* give back our minor */
413         usb_deregister_dev(interface, &idmouse_class);
414
415         /* prevent device read, write and ioctl */
416         dev->present = 0;
417
418         /* unlock */
419         up(&dev->sem);
420
421         /* if the device is opened, idmouse_release will clean this up */
422         if (!dev->open)
423                 idmouse_delete(dev);
424
425         mutex_unlock(&disconnect_mutex);
426
427         info("%s disconnected", DRIVER_DESC);
428 }
429
430 static int __init usb_idmouse_init(void)
431 {
432         int result;
433
434         info(DRIVER_DESC " " DRIVER_VERSION);
435
436         /* register this driver with the USB subsystem */
437         result = usb_register(&idmouse_driver);
438         if (result)
439                 err("Unable to register device (error %d).", result);
440
441         return result;
442 }
443
444 static void __exit usb_idmouse_exit(void)
445 {
446         /* deregister this driver with the USB subsystem */
447         usb_deregister(&idmouse_driver);
448 }
449
450 module_init(usb_idmouse_init);
451 module_exit(usb_idmouse_exit);
452
453 MODULE_AUTHOR(DRIVER_AUTHOR);
454 MODULE_DESCRIPTION(DRIVER_DESC);
455 MODULE_LICENSE("GPL");
456