]>
Commit | Line | Data |
---|---|---|
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 */ | |
1da177e4 | 51 | static 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 | 68 | MODULE_DEVICE_TABLE(usb, idmouse_table); |
54d2bc06 | 69 | static DEFINE_MUTEX(open_disc_mutex); |
1da177e4 LT |
70 | |
71 | /* structure to hold all of our device specific stuff */ | |
72 | struct 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 */ | |
89 | static ssize_t idmouse_read(struct file *file, char __user *buffer, | |
90 | size_t count, loff_t * ppos); | |
91 | ||
92 | static int idmouse_open(struct inode *inode, struct file *file); | |
93 | static int idmouse_release(struct inode *inode, struct file *file); | |
94 | ||
95 | static int idmouse_probe(struct usb_interface *interface, | |
96 | const struct usb_device_id *id); | |
97 | ||
98 | static void idmouse_disconnect(struct usb_interface *interface); | |
99 | ||
100 | /* file operation pointers */ | |
066202dd | 101 | static const struct file_operations idmouse_fops = { |
1da177e4 LT |
102 | .owner = THIS_MODULE, |
103 | .read = idmouse_read, | |
104 | .open = idmouse_open, | |
105 | .release = idmouse_release, | |
106 | }; | |
107 | ||
d6e5bcf4 | 108 | /* class driver information */ |
1da177e4 | 109 | static struct usb_class_driver idmouse_class = { |
d6e5bcf4 | 110 | .name = "idmouse%d", |
1da177e4 | 111 | .fops = &idmouse_fops, |
1da177e4 LT |
112 | .minor_base = USB_IDMOUSE_MINOR_BASE, |
113 | }; | |
114 | ||
115 | /* usb specific object needed to register this driver with the usb subsystem */ | |
116 | static struct usb_driver idmouse_driver = { | |
1da177e4 LT |
117 | .name = DRIVER_SHORT, |
118 | .probe = idmouse_probe, | |
119 | .disconnect = idmouse_disconnect, | |
120 | .id_table = idmouse_table, | |
121 | }; | |
122 | ||
1da177e4 LT |
123 | static int idmouse_create_image(struct usb_idmouse *dev) |
124 | { | |
54ecf1fb MK |
125 | int bytes_read; |
126 | int bulk_read; | |
127 | int result; | |
1da177e4 | 128 | |
4244f724 | 129 | memcpy(dev->bulk_in_buffer, HEADER, sizeof(HEADER)-1); |
54ecf1fb | 130 | bytes_read = sizeof(HEADER)-1; |
1da177e4 | 131 | |
4244f724 FE |
132 | /* reset the device and set a fast blink rate */ |
133 | result = ftip_command(dev, FTIP_RELEASE, 0, 0); | |
1da177e4 | 134 | if (result < 0) |
4244f724 FE |
135 | goto reset; |
136 | result = ftip_command(dev, FTIP_BLINK, 1, 0); | |
1da177e4 | 137 | if (result < 0) |
4244f724 | 138 | goto reset; |
1da177e4 | 139 | |
4244f724 FE |
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); | |
1da177e4 | 143 | if (result < 0) |
4244f724 FE |
144 | goto reset; |
145 | result = ftip_command(dev, FTIP_ACQUIRE, 0, 0); | |
1da177e4 | 146 | if (result < 0) |
4244f724 FE |
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); | |
1da177e4 | 152 | if (result < 0) |
4244f724 FE |
153 | goto reset; |
154 | result = ftip_command(dev, FTIP_RESET, 0, 0); | |
155 | if (result < 0) | |
156 | goto reset; | |
1da177e4 LT |
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); | |
4244f724 FE |
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 | } | |
1da177e4 LT |
177 | bytes_read += bulk_read; |
178 | } | |
179 | ||
180 | /* reset the device */ | |
4244f724 FE |
181 | reset: |
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; | |
1da177e4 | 189 | |
4244f724 FE |
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 */ | |
1da177e4 | 196 | dbg("read %d bytes fingerprint data", bytes_read); |
4244f724 | 197 | return result; |
1da177e4 LT |
198 | } |
199 | ||
200 | static inline void idmouse_delete(struct usb_idmouse *dev) | |
201 | { | |
202 | kfree(dev->bulk_in_buffer); | |
203 | kfree(dev); | |
204 | } | |
205 | ||
206 | static int idmouse_open(struct inode *inode, struct file *file) | |
207 | { | |
54ecf1fb | 208 | struct usb_idmouse *dev; |
1da177e4 | 209 | struct usb_interface *interface; |
54ecf1fb | 210 | int result; |
1da177e4 | 211 | |
1da177e4 LT |
212 | /* get the interface from minor number and driver information */ |
213 | interface = usb_find_interface (&idmouse_driver, iminor (inode)); | |
d4ead16f | 214 | if (!interface) |
1da177e4 | 215 | return -ENODEV; |
d4ead16f | 216 | |
54d2bc06 | 217 | mutex_lock(&open_disc_mutex); |
1da177e4 LT |
218 | /* get the device information block from the interface */ |
219 | dev = usb_get_intfdata(interface); | |
54d2bc06 ON |
220 | if (!dev) { |
221 | mutex_unlock(&open_disc_mutex); | |
1da177e4 | 222 | return -ENODEV; |
54d2bc06 | 223 | } |
1da177e4 LT |
224 | |
225 | /* lock this device */ | |
54d2bc06 ON |
226 | mutex_lock(&dev->lock); |
227 | mutex_unlock(&open_disc_mutex); | |
1da177e4 LT |
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 | ||
250 | error: | |
251 | ||
252 | /* unlock this device */ | |
54d2bc06 | 253 | mutex_unlock(&dev->lock); |
1da177e4 LT |
254 | return result; |
255 | } | |
256 | ||
257 | static int idmouse_release(struct inode *inode, struct file *file) | |
258 | { | |
259 | struct usb_idmouse *dev; | |
260 | ||
47278107 | 261 | dev = file->private_data; |
1da177e4 | 262 | |
d4ead16f | 263 | if (dev == NULL) |
1da177e4 | 264 | return -ENODEV; |
1da177e4 | 265 | |
54d2bc06 | 266 | mutex_lock(&open_disc_mutex); |
1da177e4 | 267 | /* lock our device */ |
54d2bc06 | 268 | mutex_lock(&dev->lock); |
1da177e4 LT |
269 | |
270 | /* are we really open? */ | |
271 | if (dev->open <= 0) { | |
54d2bc06 ON |
272 | mutex_unlock(&dev->lock); |
273 | mutex_unlock(&open_disc_mutex); | |
1da177e4 LT |
274 | return -ENODEV; |
275 | } | |
276 | ||
277 | --dev->open; | |
278 | ||
279 | if (!dev->present) { | |
280 | /* the device was unplugged before the file was released */ | |
54d2bc06 ON |
281 | mutex_unlock(&dev->lock); |
282 | mutex_unlock(&open_disc_mutex); | |
1da177e4 | 283 | idmouse_delete(dev); |
d4ead16f | 284 | } else { |
54d2bc06 ON |
285 | mutex_unlock(&dev->lock); |
286 | mutex_unlock(&open_disc_mutex); | |
1da177e4 | 287 | } |
1da177e4 LT |
288 | return 0; |
289 | } | |
290 | ||
291 | static ssize_t idmouse_read(struct file *file, char __user *buffer, size_t count, | |
292 | loff_t * ppos) | |
293 | { | |
47278107 | 294 | struct usb_idmouse *dev = file->private_data; |
54ecf1fb | 295 | int result; |
1da177e4 | 296 | |
4244f724 | 297 | /* lock this object */ |
54d2bc06 | 298 | mutex_lock(&dev->lock); |
1da177e4 | 299 | |
4244f724 | 300 | /* verify that the device wasn't unplugged */ |
1da177e4 | 301 | if (!dev->present) { |
54d2bc06 | 302 | mutex_unlock(&dev->lock); |
1da177e4 LT |
303 | return -ENODEV; |
304 | } | |
305 | ||
018a2cdf AV |
306 | result = simple_read_from_buffer(buffer, count, ppos, |
307 | dev->bulk_in_buffer, IMGSIZE); | |
4244f724 | 308 | /* unlock the device */ |
54d2bc06 | 309 | mutex_unlock(&dev->lock); |
1da177e4 LT |
310 | return result; |
311 | } | |
312 | ||
313 | static int idmouse_probe(struct usb_interface *interface, | |
314 | const struct usb_device_id *id) | |
315 | { | |
316 | struct usb_device *udev = interface_to_usbdev(interface); | |
54ecf1fb | 317 | struct usb_idmouse *dev; |
1da177e4 LT |
318 | struct usb_host_interface *iface_desc; |
319 | struct usb_endpoint_descriptor *endpoint; | |
1da177e4 LT |
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 */ | |
092e462a | 328 | dev = kzalloc(sizeof(*dev), GFP_KERNEL); |
1da177e4 LT |
329 | if (dev == NULL) |
330 | return -ENOMEM; | |
1da177e4 | 331 | |
54d2bc06 | 332 | mutex_init(&dev->lock); |
1da177e4 LT |
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; | |
a7dc218b | 338 | if (!dev->bulk_in_endpointAddr && usb_endpoint_is_bulk_in(endpoint)) { |
1da177e4 | 339 | /* we found a bulk in endpoint */ |
4244f724 FE |
340 | dev->orig_bi_size = le16_to_cpu(endpoint->wMaxPacketSize); |
341 | dev->bulk_in_size = 0x200; /* works _much_ faster */ | |
1da177e4 LT |
342 | dev->bulk_in_endpointAddr = endpoint->bEndpointAddress; |
343 | dev->bulk_in_buffer = | |
4244f724 | 344 | kmalloc(IMGSIZE + dev->bulk_in_size, GFP_KERNEL); |
1da177e4 LT |
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 | ||
378 | static void idmouse_disconnect(struct usb_interface *interface) | |
379 | { | |
380 | struct usb_idmouse *dev; | |
381 | ||
1da177e4 LT |
382 | /* get device structure */ |
383 | dev = usb_get_intfdata(interface); | |
1da177e4 | 384 | |
1da177e4 LT |
385 | /* give back our minor */ |
386 | usb_deregister_dev(interface, &idmouse_class); | |
387 | ||
54d2bc06 ON |
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); | |
d4ead16f | 393 | |
1da177e4 LT |
394 | /* prevent device read, write and ioctl */ |
395 | dev->present = 0; | |
396 | ||
1da177e4 | 397 | /* if the device is opened, idmouse_release will clean this up */ |
d4ead16f | 398 | if (!dev->open) { |
54d2bc06 | 399 | mutex_unlock(&dev->lock); |
1da177e4 | 400 | idmouse_delete(dev); |
d4ead16f AS |
401 | } else { |
402 | /* unlock */ | |
54d2bc06 | 403 | mutex_unlock(&dev->lock); |
d4ead16f | 404 | } |
1da177e4 LT |
405 | |
406 | info("%s disconnected", DRIVER_DESC); | |
407 | } | |
408 | ||
409 | static 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 | ||
423 | static void __exit usb_idmouse_exit(void) | |
424 | { | |
425 | /* deregister this driver with the USB subsystem */ | |
426 | usb_deregister(&idmouse_driver); | |
427 | } | |
428 | ||
429 | module_init(usb_idmouse_init); | |
430 | module_exit(usb_idmouse_exit); | |
431 | ||
432 | MODULE_AUTHOR(DRIVER_AUTHOR); | |
433 | MODULE_DESCRIPTION(DRIVER_DESC); | |
434 | MODULE_LICENSE("GPL"); | |
435 |