Merge branch 'urgent' of git://git.kernel.org/pub/scm/linux/kernel/git/brodo/pcmcia-2.6
[linux-2.6-block.git] / drivers / usb / misc / idmouse.c
CommitLineData
4244f724 1/* Siemens ID Mouse driver v0.6
1da177e4
LT
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
4244f724
FE
14 Additional information provided by Martin Reising
15 <Martin.Reising@natural-computing.de>
16
1da177e4
LT
17*/
18
1da177e4
LT
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>
1da177e4 25#include <linux/completion.h>
4186ecf8 26#include <linux/mutex.h>
1da177e4
LT
27#include <asm/uaccess.h>
28#include <linux/usb.h>
29
4244f724 30/* image constants */
1da177e4 31#define WIDTH 225
4244f724
FE
32#define HEIGHT 289
33#define HEADER "P5 225 289 255 "
1da177e4
LT
34#define IMGSIZE ((WIDTH * HEIGHT) + sizeof(HEADER)-1)
35
4244f724
FE
36/* version information */
37#define DRIVER_VERSION "0.6"
1da177e4
LT
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
4244f724 42/* minor number for misc USB devices */
1da177e4
LT
43#define USB_IDMOUSE_MINOR_BASE 132
44
4244f724
FE
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 */
33b9e162 51static const struct usb_device_id idmouse_table[] = {
4244f724
FE
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 */
1da177e4
LT
55};
56
4244f724
FE
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
1da177e4 68MODULE_DEVICE_TABLE(usb, idmouse_table);
54d2bc06 69static DEFINE_MUTEX(open_disc_mutex);
1da177e4
LT
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 */
4244f724
FE
78 size_t bulk_in_size; /* the maximum bulk packet size */
79 size_t orig_bi_size; /* same as above, but reported by the device */
1da177e4
LT
80 __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 */
54d2bc06 84 struct mutex lock; /* locks this structure */
1da177e4
LT
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);
d9bfbd16
ON
99static int idmouse_suspend(struct usb_interface *intf, pm_message_t message);
100static int idmouse_resume(struct usb_interface *intf);
1da177e4
LT
101
102/* file operation pointers */
066202dd 103static const struct file_operations idmouse_fops = {
1da177e4
LT
104 .owner = THIS_MODULE,
105 .read = idmouse_read,
106 .open = idmouse_open,
107 .release = idmouse_release,
108};
109
d6e5bcf4 110/* class driver information */
1da177e4 111static struct usb_class_driver idmouse_class = {
d6e5bcf4 112 .name = "idmouse%d",
1da177e4 113 .fops = &idmouse_fops,
1da177e4
LT
114 .minor_base = USB_IDMOUSE_MINOR_BASE,
115};
116
117/* usb specific object needed to register this driver with the usb subsystem */
118static struct usb_driver idmouse_driver = {
1da177e4
LT
119 .name = DRIVER_SHORT,
120 .probe = idmouse_probe,
121 .disconnect = idmouse_disconnect,
d9bfbd16
ON
122 .suspend = idmouse_suspend,
123 .resume = idmouse_resume,
124 .reset_resume = idmouse_resume,
1da177e4 125 .id_table = idmouse_table,
d9bfbd16 126 .supports_autosuspend = 1,
1da177e4
LT
127};
128
1da177e4
LT
129static int idmouse_create_image(struct usb_idmouse *dev)
130{
54ecf1fb
MK
131 int bytes_read;
132 int bulk_read;
133 int result;
1da177e4 134
4244f724 135 memcpy(dev->bulk_in_buffer, HEADER, sizeof(HEADER)-1);
54ecf1fb 136 bytes_read = sizeof(HEADER)-1;
1da177e4 137
4244f724
FE
138 /* reset the device and set a fast blink rate */
139 result = ftip_command(dev, FTIP_RELEASE, 0, 0);
1da177e4 140 if (result < 0)
4244f724
FE
141 goto reset;
142 result = ftip_command(dev, FTIP_BLINK, 1, 0);
1da177e4 143 if (result < 0)
4244f724 144 goto reset;
1da177e4 145
4244f724
FE
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);
1da177e4 149 if (result < 0)
4244f724
FE
150 goto reset;
151 result = ftip_command(dev, FTIP_ACQUIRE, 0, 0);
1da177e4 152 if (result < 0)
4244f724
FE
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);
1da177e4 158 if (result < 0)
4244f724
FE
159 goto reset;
160 result = ftip_command(dev, FTIP_RESET, 0, 0);
161 if (result < 0)
162 goto reset;
1da177e4
LT
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);
4244f724
FE
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 }
1da177e4
LT
183 bytes_read += bulk_read;
184 }
185
186 /* reset the device */
4244f724
FE
187reset:
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;
1da177e4 195
4244f724
FE
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 */
1da177e4 202 dbg("read %d bytes fingerprint data", bytes_read);
4244f724 203 return result;
1da177e4
LT
204}
205
d9bfbd16
ON
206/* PM operations are nops as this driver does IO only during open() */
207static int idmouse_suspend(struct usb_interface *intf, pm_message_t message)
208{
209 return 0;
210}
211
212static int idmouse_resume(struct usb_interface *intf)
213{
214 return 0;
215}
216
1da177e4
LT
217static inline void idmouse_delete(struct usb_idmouse *dev)
218{
219 kfree(dev->bulk_in_buffer);
220 kfree(dev);
221}
222
223static int idmouse_open(struct inode *inode, struct file *file)
224{
54ecf1fb 225 struct usb_idmouse *dev;
1da177e4 226 struct usb_interface *interface;
54ecf1fb 227 int result;
1da177e4 228
1da177e4
LT
229 /* get the interface from minor number and driver information */
230 interface = usb_find_interface (&idmouse_driver, iminor (inode));
dbdae3bd 231 if (!interface)
1da177e4 232 return -ENODEV;
d4ead16f 233
54d2bc06 234 mutex_lock(&open_disc_mutex);
1da177e4
LT
235 /* get the device information block from the interface */
236 dev = usb_get_intfdata(interface);
54d2bc06
ON
237 if (!dev) {
238 mutex_unlock(&open_disc_mutex);
1da177e4 239 return -ENODEV;
54d2bc06 240 }
1da177e4
LT
241
242 /* lock this device */
54d2bc06
ON
243 mutex_lock(&dev->lock);
244 mutex_unlock(&open_disc_mutex);
1da177e4
LT
245
246 /* check if already open */
247 if (dev->open) {
248
249 /* already open, so fail */
250 result = -EBUSY;
251
252 } else {
253
254 /* create a new image and check for success */
d9bfbd16
ON
255 result = usb_autopm_get_interface(interface);
256 if (result)
257 goto error;
1da177e4
LT
258 result = idmouse_create_image (dev);
259 if (result)
260 goto error;
d9bfbd16 261 usb_autopm_put_interface(interface);
1da177e4
LT
262
263 /* increment our usage count for the driver */
264 ++dev->open;
265
266 /* save our object in the file's private structure */
267 file->private_data = dev;
268
269 }
270
271error:
272
273 /* unlock this device */
54d2bc06 274 mutex_unlock(&dev->lock);
1da177e4
LT
275 return result;
276}
277
278static int idmouse_release(struct inode *inode, struct file *file)
279{
280 struct usb_idmouse *dev;
281
47278107 282 dev = file->private_data;
1da177e4 283
d4ead16f 284 if (dev == NULL)
1da177e4 285 return -ENODEV;
1da177e4 286
54d2bc06 287 mutex_lock(&open_disc_mutex);
1da177e4 288 /* lock our device */
54d2bc06 289 mutex_lock(&dev->lock);
1da177e4
LT
290
291 /* are we really open? */
292 if (dev->open <= 0) {
54d2bc06
ON
293 mutex_unlock(&dev->lock);
294 mutex_unlock(&open_disc_mutex);
1da177e4
LT
295 return -ENODEV;
296 }
297
298 --dev->open;
299
300 if (!dev->present) {
301 /* the device was unplugged before the file was released */
54d2bc06
ON
302 mutex_unlock(&dev->lock);
303 mutex_unlock(&open_disc_mutex);
1da177e4 304 idmouse_delete(dev);
d4ead16f 305 } else {
54d2bc06
ON
306 mutex_unlock(&dev->lock);
307 mutex_unlock(&open_disc_mutex);
1da177e4 308 }
1da177e4
LT
309 return 0;
310}
311
312static ssize_t idmouse_read(struct file *file, char __user *buffer, size_t count,
313 loff_t * ppos)
314{
47278107 315 struct usb_idmouse *dev = file->private_data;
54ecf1fb 316 int result;
1da177e4 317
4244f724 318 /* lock this object */
54d2bc06 319 mutex_lock(&dev->lock);
1da177e4 320
4244f724 321 /* verify that the device wasn't unplugged */
1da177e4 322 if (!dev->present) {
54d2bc06 323 mutex_unlock(&dev->lock);
1da177e4
LT
324 return -ENODEV;
325 }
326
018a2cdf
AV
327 result = simple_read_from_buffer(buffer, count, ppos,
328 dev->bulk_in_buffer, IMGSIZE);
4244f724 329 /* unlock the device */
54d2bc06 330 mutex_unlock(&dev->lock);
1da177e4
LT
331 return result;
332}
333
334static int idmouse_probe(struct usb_interface *interface,
335 const struct usb_device_id *id)
336{
337 struct usb_device *udev = interface_to_usbdev(interface);
54ecf1fb 338 struct usb_idmouse *dev;
1da177e4
LT
339 struct usb_host_interface *iface_desc;
340 struct usb_endpoint_descriptor *endpoint;
1da177e4
LT
341 int result;
342
343 /* check if we have gotten the data or the hid interface */
344 iface_desc = &interface->altsetting[0];
345 if (iface_desc->desc.bInterfaceClass != 0x0A)
346 return -ENODEV;
347
348 /* allocate memory for our device state and initialize it */
092e462a 349 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1da177e4
LT
350 if (dev == NULL)
351 return -ENOMEM;
1da177e4 352
54d2bc06 353 mutex_init(&dev->lock);
1da177e4
LT
354 dev->udev = udev;
355 dev->interface = interface;
356
357 /* set up the endpoint information - use only the first bulk-in endpoint */
358 endpoint = &iface_desc->endpoint[0].desc;
a7dc218b 359 if (!dev->bulk_in_endpointAddr && usb_endpoint_is_bulk_in(endpoint)) {
1da177e4 360 /* we found a bulk in endpoint */
4244f724
FE
361 dev->orig_bi_size = le16_to_cpu(endpoint->wMaxPacketSize);
362 dev->bulk_in_size = 0x200; /* works _much_ faster */
1da177e4
LT
363 dev->bulk_in_endpointAddr = endpoint->bEndpointAddress;
364 dev->bulk_in_buffer =
4244f724 365 kmalloc(IMGSIZE + dev->bulk_in_size, GFP_KERNEL);
1da177e4
LT
366
367 if (!dev->bulk_in_buffer) {
368 err("Unable to allocate input buffer.");
369 idmouse_delete(dev);
370 return -ENOMEM;
371 }
372 }
373
374 if (!(dev->bulk_in_endpointAddr)) {
375 err("Unable to find bulk-in endpoint.");
376 idmouse_delete(dev);
377 return -ENODEV;
378 }
379 /* allow device read, write and ioctl */
380 dev->present = 1;
381
382 /* we can register the device now, as it is ready */
383 usb_set_intfdata(interface, dev);
384 result = usb_register_dev(interface, &idmouse_class);
385 if (result) {
386 /* something prevented us from registering this device */
387 err("Unble to allocate minor number.");
388 usb_set_intfdata(interface, NULL);
389 idmouse_delete(dev);
390 return result;
391 }
392
393 /* be noisy */
394 dev_info(&interface->dev,"%s now attached\n",DRIVER_DESC);
395
396 return 0;
397}
398
399static void idmouse_disconnect(struct usb_interface *interface)
400{
401 struct usb_idmouse *dev;
402
1da177e4
LT
403 /* get device structure */
404 dev = usb_get_intfdata(interface);
1da177e4 405
1da177e4
LT
406 /* give back our minor */
407 usb_deregister_dev(interface, &idmouse_class);
408
54d2bc06
ON
409 mutex_lock(&open_disc_mutex);
410 usb_set_intfdata(interface, NULL);
411 /* lock the device */
412 mutex_lock(&dev->lock);
413 mutex_unlock(&open_disc_mutex);
d4ead16f 414
1da177e4
LT
415 /* prevent device read, write and ioctl */
416 dev->present = 0;
417
1da177e4 418 /* if the device is opened, idmouse_release will clean this up */
d4ead16f 419 if (!dev->open) {
54d2bc06 420 mutex_unlock(&dev->lock);
1da177e4 421 idmouse_delete(dev);
d4ead16f
AS
422 } else {
423 /* unlock */
54d2bc06 424 mutex_unlock(&dev->lock);
d4ead16f 425 }
1da177e4 426
1b29a375 427 dev_info(&interface->dev, "disconnected\n");
1da177e4
LT
428}
429
430static int __init usb_idmouse_init(void)
431{
432 int result;
433
1b29a375
GKH
434 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
435 DRIVER_DESC "\n");
1da177e4
LT
436
437 /* register this driver with the USB subsystem */
438 result = usb_register(&idmouse_driver);
439 if (result)
440 err("Unable to register device (error %d).", result);
441
442 return result;
443}
444
445static void __exit usb_idmouse_exit(void)
446{
447 /* deregister this driver with the USB subsystem */
448 usb_deregister(&idmouse_driver);
449}
450
451module_init(usb_idmouse_init);
452module_exit(usb_idmouse_exit);
453
454MODULE_AUTHOR(DRIVER_AUTHOR);
455MODULE_DESCRIPTION(DRIVER_DESC);
456MODULE_LICENSE("GPL");
457