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