1 /* Siemens ID Mouse driver v0.6
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.
8 Copyright (C) 2004-5 by Florian 'Floe' Echtler <echtler@fs.tum.de>
9 and Andreas 'ad' Deresch <aderesch@fs.tum.de>
11 Derived from the USB Skeleton driver 1.1,
12 Copyright (C) 2003 Greg Kroah-Hartman (greg@kroah.com)
14 Additional information provided by Martin Reising
15 <Martin.Reising@natural-computing.de>
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>
33 #define HEADER "P5 225 289 255 "
34 #define IMGSIZE ((WIDTH * HEIGHT) + sizeof(HEADER)-1)
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"
42 /* minor number for misc USB devices */
43 #define USB_IDMOUSE_MINOR_BASE 132
45 /* vendor and device IDs */
46 #define ID_SIEMENS 0x0681
47 #define ID_IDMOUSE 0x0005
48 #define ID_CHERRY 0x0010
51 static 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 */
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
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)
68 MODULE_DEVICE_TABLE(usb
, idmouse_table
);
70 /* structure to hold all of our device specific stuff */
73 struct usb_device
*udev
; /* save off the usb device pointer */
74 struct usb_interface
*interface
; /* the interface for this device */
76 unsigned char *bulk_in_buffer
; /* the buffer to receive data */
77 size_t bulk_in_size
; /* the maximum bulk packet size */
78 size_t orig_bi_size
; /* same as above, but reported by the device */
79 __u8 bulk_in_endpointAddr
; /* the address of the bulk in endpoint */
81 int open
; /* if the port is open or not */
82 int present
; /* if the device is not disconnected */
83 struct semaphore sem
; /* locks this structure */
87 /* local function prototypes */
88 static ssize_t
idmouse_read(struct file
*file
, char __user
*buffer
,
89 size_t count
, loff_t
* ppos
);
91 static int idmouse_open(struct inode
*inode
, struct file
*file
);
92 static int idmouse_release(struct inode
*inode
, struct file
*file
);
94 static int idmouse_probe(struct usb_interface
*interface
,
95 const struct usb_device_id
*id
);
97 static void idmouse_disconnect(struct usb_interface
*interface
);
99 /* file operation pointers */
100 static const struct file_operations idmouse_fops
= {
101 .owner
= THIS_MODULE
,
102 .read
= idmouse_read
,
103 .open
= idmouse_open
,
104 .release
= idmouse_release
,
107 /* class driver information */
108 static struct usb_class_driver idmouse_class
= {
110 .fops
= &idmouse_fops
,
111 .minor_base
= USB_IDMOUSE_MINOR_BASE
,
114 /* usb specific object needed to register this driver with the usb subsystem */
115 static struct usb_driver idmouse_driver
= {
116 .name
= DRIVER_SHORT
,
117 .probe
= idmouse_probe
,
118 .disconnect
= idmouse_disconnect
,
119 .id_table
= idmouse_table
,
122 /* prevent races between open() and disconnect() */
123 static DEFINE_MUTEX(disconnect_mutex
);
125 static int idmouse_create_image(struct usb_idmouse
*dev
)
131 memcpy(dev
->bulk_in_buffer
, HEADER
, sizeof(HEADER
)-1);
132 bytes_read
= sizeof(HEADER
)-1;
134 /* reset the device and set a fast blink rate */
135 result
= ftip_command(dev
, FTIP_RELEASE
, 0, 0);
138 result
= ftip_command(dev
, FTIP_BLINK
, 1, 0);
142 /* initialize the sensor - sending this command twice */
143 /* significantly reduces the rate of failed reads */
144 result
= ftip_command(dev
, FTIP_ACQUIRE
, 0, 0);
147 result
= ftip_command(dev
, FTIP_ACQUIRE
, 0, 0);
151 /* start the readout - sending this command twice */
152 /* presumably enables the high dynamic range mode */
153 result
= ftip_command(dev
, FTIP_RESET
, 0, 0);
156 result
= ftip_command(dev
, FTIP_RESET
, 0, 0);
160 /* loop over a blocking bulk read to get data from the device */
161 while (bytes_read
< IMGSIZE
) {
162 result
= usb_bulk_msg (dev
->udev
,
163 usb_rcvbulkpipe (dev
->udev
, dev
->bulk_in_endpointAddr
),
164 dev
->bulk_in_buffer
+ bytes_read
,
165 dev
->bulk_in_size
, &bulk_read
, 5000);
167 /* Maybe this error was caused by the increased packet size? */
168 /* Reset to the original value and tell userspace to retry. */
169 if (dev
->bulk_in_size
!= dev
->orig_bi_size
) {
170 dev
->bulk_in_size
= dev
->orig_bi_size
;
175 if (signal_pending(current
)) {
179 bytes_read
+= bulk_read
;
182 /* reset the device */
184 ftip_command(dev
, FTIP_RELEASE
, 0, 0);
186 /* check for valid image */
187 /* right border should be black (0x00) */
188 for (bytes_read
= sizeof(HEADER
)-1 + WIDTH
-1; bytes_read
< IMGSIZE
; bytes_read
+= WIDTH
)
189 if (dev
->bulk_in_buffer
[bytes_read
] != 0x00)
192 /* lower border should be white (0xFF) */
193 for (bytes_read
= IMGSIZE
-WIDTH
; bytes_read
< IMGSIZE
-1; bytes_read
++)
194 if (dev
->bulk_in_buffer
[bytes_read
] != 0xFF)
197 /* should be IMGSIZE == 65040 */
198 dbg("read %d bytes fingerprint data", bytes_read
);
202 static inline void idmouse_delete(struct usb_idmouse
*dev
)
204 kfree(dev
->bulk_in_buffer
);
208 static int idmouse_open(struct inode
*inode
, struct file
*file
)
210 struct usb_idmouse
*dev
;
211 struct usb_interface
*interface
;
214 /* prevent disconnects */
215 mutex_lock(&disconnect_mutex
);
217 /* get the interface from minor number and driver information */
218 interface
= usb_find_interface (&idmouse_driver
, iminor (inode
));
220 mutex_unlock(&disconnect_mutex
);
223 /* get the device information block from the interface */
224 dev
= usb_get_intfdata(interface
);
226 mutex_unlock(&disconnect_mutex
);
230 /* lock this device */
233 /* check if already open */
236 /* already open, so fail */
241 /* create a new image and check for success */
242 result
= idmouse_create_image (dev
);
246 /* increment our usage count for the driver */
249 /* save our object in the file's private structure */
250 file
->private_data
= dev
;
256 /* unlock this device */
259 /* unlock the disconnect semaphore */
260 mutex_unlock(&disconnect_mutex
);
264 static int idmouse_release(struct inode
*inode
, struct file
*file
)
266 struct usb_idmouse
*dev
;
268 /* prevent a race condition with open() */
269 mutex_lock(&disconnect_mutex
);
271 dev
= file
->private_data
;
274 mutex_unlock(&disconnect_mutex
);
278 /* lock our device */
281 /* are we really open? */
282 if (dev
->open
<= 0) {
284 mutex_unlock(&disconnect_mutex
);
291 /* the device was unplugged before the file was released */
294 mutex_unlock(&disconnect_mutex
);
299 mutex_unlock(&disconnect_mutex
);
303 static ssize_t
idmouse_read(struct file
*file
, char __user
*buffer
, size_t count
,
306 struct usb_idmouse
*dev
= file
->private_data
;
309 /* lock this object */
312 /* verify that the device wasn't unplugged */
318 result
= simple_read_from_buffer(buffer
, count
, ppos
,
319 dev
->bulk_in_buffer
, IMGSIZE
);
320 /* unlock the device */
325 static int idmouse_probe(struct usb_interface
*interface
,
326 const struct usb_device_id
*id
)
328 struct usb_device
*udev
= interface_to_usbdev(interface
);
329 struct usb_idmouse
*dev
;
330 struct usb_host_interface
*iface_desc
;
331 struct usb_endpoint_descriptor
*endpoint
;
334 /* check if we have gotten the data or the hid interface */
335 iface_desc
= &interface
->altsetting
[0];
336 if (iface_desc
->desc
.bInterfaceClass
!= 0x0A)
339 /* allocate memory for our device state and initialize it */
340 dev
= kzalloc(sizeof(*dev
), GFP_KERNEL
);
344 init_MUTEX(&dev
->sem
);
346 dev
->interface
= interface
;
348 /* set up the endpoint information - use only the first bulk-in endpoint */
349 endpoint
= &iface_desc
->endpoint
[0].desc
;
350 if (!dev
->bulk_in_endpointAddr
&& usb_endpoint_is_bulk_in(endpoint
)) {
351 /* we found a bulk in endpoint */
352 dev
->orig_bi_size
= le16_to_cpu(endpoint
->wMaxPacketSize
);
353 dev
->bulk_in_size
= 0x200; /* works _much_ faster */
354 dev
->bulk_in_endpointAddr
= endpoint
->bEndpointAddress
;
355 dev
->bulk_in_buffer
=
356 kmalloc(IMGSIZE
+ dev
->bulk_in_size
, GFP_KERNEL
);
358 if (!dev
->bulk_in_buffer
) {
359 err("Unable to allocate input buffer.");
365 if (!(dev
->bulk_in_endpointAddr
)) {
366 err("Unable to find bulk-in endpoint.");
370 /* allow device read, write and ioctl */
373 /* we can register the device now, as it is ready */
374 usb_set_intfdata(interface
, dev
);
375 result
= usb_register_dev(interface
, &idmouse_class
);
377 /* something prevented us from registering this device */
378 err("Unble to allocate minor number.");
379 usb_set_intfdata(interface
, NULL
);
385 dev_info(&interface
->dev
,"%s now attached\n",DRIVER_DESC
);
390 static void idmouse_disconnect(struct usb_interface
*interface
)
392 struct usb_idmouse
*dev
;
394 /* prevent races with open() */
395 mutex_lock(&disconnect_mutex
);
397 /* get device structure */
398 dev
= usb_get_intfdata(interface
);
399 usb_set_intfdata(interface
, NULL
);
404 /* give back our minor */
405 usb_deregister_dev(interface
, &idmouse_class
);
407 /* prevent device read, write and ioctl */
413 /* if the device is opened, idmouse_release will clean this up */
417 mutex_unlock(&disconnect_mutex
);
419 info("%s disconnected", DRIVER_DESC
);
422 static int __init
usb_idmouse_init(void)
426 info(DRIVER_DESC
" " DRIVER_VERSION
);
428 /* register this driver with the USB subsystem */
429 result
= usb_register(&idmouse_driver
);
431 err("Unable to register device (error %d).", result
);
436 static void __exit
usb_idmouse_exit(void)
438 /* deregister this driver with the USB subsystem */
439 usb_deregister(&idmouse_driver
);
442 module_init(usb_idmouse_init
);
443 module_exit(usb_idmouse_exit
);
445 MODULE_AUTHOR(DRIVER_AUTHOR
);
446 MODULE_DESCRIPTION(DRIVER_DESC
);
447 MODULE_LICENSE("GPL");