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