Loading...
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 const 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);
99static int idmouse_suspend(struct usb_interface *intf, pm_message_t message);
100static int idmouse_resume(struct usb_interface *intf);
101
102/* file operation pointers */
103static const struct file_operations idmouse_fops = {
104 .owner = THIS_MODULE,
105 .read = idmouse_read,
106 .open = idmouse_open,
107 .release = idmouse_release,
108 .llseek = default_llseek,
109};
110
111/* class driver information */
112static struct usb_class_driver idmouse_class = {
113 .name = "idmouse%d",
114 .fops = &idmouse_fops,
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 = {
120 .name = DRIVER_SHORT,
121 .probe = idmouse_probe,
122 .disconnect = idmouse_disconnect,
123 .suspend = idmouse_suspend,
124 .resume = idmouse_resume,
125 .reset_resume = idmouse_resume,
126 .id_table = idmouse_table,
127 .supports_autosuspend = 1,
128};
129
130static int idmouse_create_image(struct usb_idmouse *dev)
131{
132 int bytes_read;
133 int bulk_read;
134 int result;
135
136 memcpy(dev->bulk_in_buffer, HEADER, sizeof(HEADER)-1);
137 bytes_read = sizeof(HEADER)-1;
138
139 /* reset the device and set a fast blink rate */
140 result = ftip_command(dev, FTIP_RELEASE, 0, 0);
141 if (result < 0)
142 goto reset;
143 result = ftip_command(dev, FTIP_BLINK, 1, 0);
144 if (result < 0)
145 goto reset;
146
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);
150 if (result < 0)
151 goto reset;
152 result = ftip_command(dev, FTIP_ACQUIRE, 0, 0);
153 if (result < 0)
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);
159 if (result < 0)
160 goto reset;
161 result = ftip_command(dev, FTIP_RESET, 0, 0);
162 if (result < 0)
163 goto reset;
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);
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 }
184 bytes_read += bulk_read;
185 }
186
187 /* reset the device */
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;
196
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 */
203 dbg("read %d bytes fingerprint data", bytes_read);
204 return result;
205}
206
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
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{
226 struct usb_idmouse *dev;
227 struct usb_interface *interface;
228 int result;
229
230 /* get the interface from minor number and driver information */
231 interface = usb_find_interface (&idmouse_driver, iminor (inode));
232 if (!interface)
233 return -ENODEV;
234
235 mutex_lock(&open_disc_mutex);
236 /* get the device information block from the interface */
237 dev = usb_get_intfdata(interface);
238 if (!dev) {
239 mutex_unlock(&open_disc_mutex);
240 return -ENODEV;
241 }
242
243 /* lock this device */
244 mutex_lock(&dev->lock);
245 mutex_unlock(&open_disc_mutex);
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 */
256 result = usb_autopm_get_interface(interface);
257 if (result)
258 goto error;
259 result = idmouse_create_image (dev);
260 if (result)
261 goto error;
262 usb_autopm_put_interface(interface);
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 */
275 mutex_unlock(&dev->lock);
276 return result;
277}
278
279static int idmouse_release(struct inode *inode, struct file *file)
280{
281 struct usb_idmouse *dev;
282
283 dev = file->private_data;
284
285 if (dev == NULL)
286 return -ENODEV;
287
288 mutex_lock(&open_disc_mutex);
289 /* lock our device */
290 mutex_lock(&dev->lock);
291
292 /* are we really open? */
293 if (dev->open <= 0) {
294 mutex_unlock(&dev->lock);
295 mutex_unlock(&open_disc_mutex);
296 return -ENODEV;
297 }
298
299 --dev->open;
300
301 if (!dev->present) {
302 /* the device was unplugged before the file was released */
303 mutex_unlock(&dev->lock);
304 mutex_unlock(&open_disc_mutex);
305 idmouse_delete(dev);
306 } else {
307 mutex_unlock(&dev->lock);
308 mutex_unlock(&open_disc_mutex);
309 }
310 return 0;
311}
312
313static ssize_t idmouse_read(struct file *file, char __user *buffer, size_t count,
314 loff_t * ppos)
315{
316 struct usb_idmouse *dev = file->private_data;
317 int result;
318
319 /* lock this object */
320 mutex_lock(&dev->lock);
321
322 /* verify that the device wasn't unplugged */
323 if (!dev->present) {
324 mutex_unlock(&dev->lock);
325 return -ENODEV;
326 }
327
328 result = simple_read_from_buffer(buffer, count, ppos,
329 dev->bulk_in_buffer, IMGSIZE);
330 /* unlock the device */
331 mutex_unlock(&dev->lock);
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);
339 struct usb_idmouse *dev;
340 struct usb_host_interface *iface_desc;
341 struct usb_endpoint_descriptor *endpoint;
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 */
350 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
351 if (dev == NULL)
352 return -ENOMEM;
353
354 mutex_init(&dev->lock);
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;
360 if (!dev->bulk_in_endpointAddr && usb_endpoint_is_bulk_in(endpoint)) {
361 /* we found a bulk in endpoint */
362 dev->orig_bi_size = le16_to_cpu(endpoint->wMaxPacketSize);
363 dev->bulk_in_size = 0x200; /* works _much_ faster */
364 dev->bulk_in_endpointAddr = endpoint->bEndpointAddress;
365 dev->bulk_in_buffer =
366 kmalloc(IMGSIZE + dev->bulk_in_size, GFP_KERNEL);
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
404 /* get device structure */
405 dev = usb_get_intfdata(interface);
406
407 /* give back our minor */
408 usb_deregister_dev(interface, &idmouse_class);
409
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);
415
416 /* prevent device read, write and ioctl */
417 dev->present = 0;
418
419 /* if the device is opened, idmouse_release will clean this up */
420 if (!dev->open) {
421 mutex_unlock(&dev->lock);
422 idmouse_delete(dev);
423 } else {
424 /* unlock */
425 mutex_unlock(&dev->lock);
426 }
427
428 dev_info(&interface->dev, "disconnected\n");
429}
430
431static int __init usb_idmouse_init(void)
432{
433 int result;
434
435 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
436 DRIVER_DESC "\n");
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
1// SPDX-License-Identifier: GPL-2.0+
2/* Siemens ID Mouse driver v0.6
3
4 Copyright (C) 2004-5 by Florian 'Floe' Echtler <echtler@fs.tum.de>
5 and Andreas 'ad' Deresch <aderesch@fs.tum.de>
6
7 Derived from the USB Skeleton driver 1.1,
8 Copyright (C) 2003 Greg Kroah-Hartman (greg@kroah.com)
9
10 Additional information provided by Martin Reising
11 <Martin.Reising@natural-computing.de>
12
13*/
14
15#include <linux/kernel.h>
16#include <linux/sched/signal.h>
17#include <linux/errno.h>
18#include <linux/delay.h>
19#include <linux/slab.h>
20#include <linux/module.h>
21#include <linux/completion.h>
22#include <linux/mutex.h>
23#include <linux/uaccess.h>
24#include <linux/usb.h>
25
26/* image constants */
27#define WIDTH 225
28#define HEIGHT 289
29#define HEADER "P5 225 289 255 "
30#define IMGSIZE ((WIDTH * HEIGHT) + sizeof(HEADER)-1)
31
32#define DRIVER_SHORT "idmouse"
33#define DRIVER_AUTHOR "Florian 'Floe' Echtler <echtler@fs.tum.de>"
34#define DRIVER_DESC "Siemens ID Mouse FingerTIP Sensor Driver"
35
36/* minor number for misc USB devices */
37#define USB_IDMOUSE_MINOR_BASE 132
38
39/* vendor and device IDs */
40#define ID_SIEMENS 0x0681
41#define ID_IDMOUSE 0x0005
42#define ID_CHERRY 0x0010
43
44/* device ID table */
45static const struct usb_device_id idmouse_table[] = {
46 {USB_DEVICE(ID_SIEMENS, ID_IDMOUSE)}, /* Siemens ID Mouse (Professional) */
47 {USB_DEVICE(ID_SIEMENS, ID_CHERRY )}, /* Cherry FingerTIP ID Board */
48 {} /* terminating null entry */
49};
50
51/* sensor commands */
52#define FTIP_RESET 0x20
53#define FTIP_ACQUIRE 0x21
54#define FTIP_RELEASE 0x22
55#define FTIP_BLINK 0x23 /* LSB of value = blink pulse width */
56#define FTIP_SCROLL 0x24
57
58#define ftip_command(dev, command, value, index) \
59 usb_control_msg (dev->udev, usb_sndctrlpipe (dev->udev, 0), command, \
60 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT, value, index, NULL, 0, 1000)
61
62MODULE_DEVICE_TABLE(usb, idmouse_table);
63static DEFINE_MUTEX(open_disc_mutex);
64
65/* structure to hold all of our device specific stuff */
66struct usb_idmouse {
67
68 struct usb_device *udev; /* save off the usb device pointer */
69 struct usb_interface *interface; /* the interface for this device */
70
71 unsigned char *bulk_in_buffer; /* the buffer to receive data */
72 size_t bulk_in_size; /* the maximum bulk packet size */
73 size_t orig_bi_size; /* same as above, but reported by the device */
74 __u8 bulk_in_endpointAddr; /* the address of the bulk in endpoint */
75
76 int open; /* if the port is open or not */
77 int present; /* if the device is not disconnected */
78 struct mutex lock; /* locks this structure */
79
80};
81
82/* local function prototypes */
83static ssize_t idmouse_read(struct file *file, char __user *buffer,
84 size_t count, loff_t * ppos);
85
86static int idmouse_open(struct inode *inode, struct file *file);
87static int idmouse_release(struct inode *inode, struct file *file);
88
89static int idmouse_probe(struct usb_interface *interface,
90 const struct usb_device_id *id);
91
92static void idmouse_disconnect(struct usb_interface *interface);
93static int idmouse_suspend(struct usb_interface *intf, pm_message_t message);
94static int idmouse_resume(struct usb_interface *intf);
95
96/* file operation pointers */
97static const struct file_operations idmouse_fops = {
98 .owner = THIS_MODULE,
99 .read = idmouse_read,
100 .open = idmouse_open,
101 .release = idmouse_release,
102 .llseek = default_llseek,
103};
104
105/* class driver information */
106static struct usb_class_driver idmouse_class = {
107 .name = "idmouse%d",
108 .fops = &idmouse_fops,
109 .minor_base = USB_IDMOUSE_MINOR_BASE,
110};
111
112/* usb specific object needed to register this driver with the usb subsystem */
113static struct usb_driver idmouse_driver = {
114 .name = DRIVER_SHORT,
115 .probe = idmouse_probe,
116 .disconnect = idmouse_disconnect,
117 .suspend = idmouse_suspend,
118 .resume = idmouse_resume,
119 .reset_resume = idmouse_resume,
120 .id_table = idmouse_table,
121 .supports_autosuspend = 1,
122};
123
124static int idmouse_create_image(struct usb_idmouse *dev)
125{
126 int bytes_read;
127 int bulk_read;
128 int result;
129
130 memcpy(dev->bulk_in_buffer, HEADER, sizeof(HEADER)-1);
131 bytes_read = sizeof(HEADER)-1;
132
133 /* reset the device and set a fast blink rate */
134 result = ftip_command(dev, FTIP_RELEASE, 0, 0);
135 if (result < 0)
136 goto reset;
137 result = ftip_command(dev, FTIP_BLINK, 1, 0);
138 if (result < 0)
139 goto reset;
140
141 /* initialize the sensor - sending this command twice */
142 /* significantly reduces the rate of failed reads */
143 result = ftip_command(dev, FTIP_ACQUIRE, 0, 0);
144 if (result < 0)
145 goto reset;
146 result = ftip_command(dev, FTIP_ACQUIRE, 0, 0);
147 if (result < 0)
148 goto reset;
149
150 /* start the readout - sending this command twice */
151 /* presumably enables the high dynamic range mode */
152 result = ftip_command(dev, FTIP_RESET, 0, 0);
153 if (result < 0)
154 goto reset;
155 result = ftip_command(dev, FTIP_RESET, 0, 0);
156 if (result < 0)
157 goto reset;
158
159 /* loop over a blocking bulk read to get data from the device */
160 while (bytes_read < IMGSIZE) {
161 result = usb_bulk_msg (dev->udev,
162 usb_rcvbulkpipe (dev->udev, dev->bulk_in_endpointAddr),
163 dev->bulk_in_buffer + bytes_read,
164 dev->bulk_in_size, &bulk_read, 5000);
165 if (result < 0) {
166 /* Maybe this error was caused by the increased packet size? */
167 /* Reset to the original value and tell userspace to retry. */
168 if (dev->bulk_in_size != dev->orig_bi_size) {
169 dev->bulk_in_size = dev->orig_bi_size;
170 result = -EAGAIN;
171 }
172 break;
173 }
174 if (signal_pending(current)) {
175 result = -EINTR;
176 break;
177 }
178 bytes_read += bulk_read;
179 }
180
181 /* reset the device */
182reset:
183 ftip_command(dev, FTIP_RELEASE, 0, 0);
184
185 /* check for valid image */
186 /* right border should be black (0x00) */
187 for (bytes_read = sizeof(HEADER)-1 + WIDTH-1; bytes_read < IMGSIZE; bytes_read += WIDTH)
188 if (dev->bulk_in_buffer[bytes_read] != 0x00)
189 return -EAGAIN;
190
191 /* lower border should be white (0xFF) */
192 for (bytes_read = IMGSIZE-WIDTH; bytes_read < IMGSIZE-1; bytes_read++)
193 if (dev->bulk_in_buffer[bytes_read] != 0xFF)
194 return -EAGAIN;
195
196 /* should be IMGSIZE == 65040 */
197 dev_dbg(&dev->interface->dev, "read %d bytes fingerprint data\n",
198 bytes_read);
199 return result;
200}
201
202/* PM operations are nops as this driver does IO only during open() */
203static int idmouse_suspend(struct usb_interface *intf, pm_message_t message)
204{
205 return 0;
206}
207
208static int idmouse_resume(struct usb_interface *intf)
209{
210 return 0;
211}
212
213static inline void idmouse_delete(struct usb_idmouse *dev)
214{
215 kfree(dev->bulk_in_buffer);
216 kfree(dev);
217}
218
219static int idmouse_open(struct inode *inode, struct file *file)
220{
221 struct usb_idmouse *dev;
222 struct usb_interface *interface;
223 int result;
224
225 /* get the interface from minor number and driver information */
226 interface = usb_find_interface (&idmouse_driver, iminor (inode));
227 if (!interface)
228 return -ENODEV;
229
230 mutex_lock(&open_disc_mutex);
231 /* get the device information block from the interface */
232 dev = usb_get_intfdata(interface);
233 if (!dev) {
234 mutex_unlock(&open_disc_mutex);
235 return -ENODEV;
236 }
237
238 /* lock this device */
239 mutex_lock(&dev->lock);
240 mutex_unlock(&open_disc_mutex);
241
242 /* check if already open */
243 if (dev->open) {
244
245 /* already open, so fail */
246 result = -EBUSY;
247
248 } else {
249
250 /* create a new image and check for success */
251 result = usb_autopm_get_interface(interface);
252 if (result)
253 goto error;
254 result = idmouse_create_image (dev);
255 usb_autopm_put_interface(interface);
256 if (result)
257 goto error;
258
259 /* increment our usage count for the driver */
260 ++dev->open;
261
262 /* save our object in the file's private structure */
263 file->private_data = dev;
264
265 }
266
267error:
268
269 /* unlock this device */
270 mutex_unlock(&dev->lock);
271 return result;
272}
273
274static int idmouse_release(struct inode *inode, struct file *file)
275{
276 struct usb_idmouse *dev;
277
278 dev = file->private_data;
279
280 if (dev == NULL)
281 return -ENODEV;
282
283 mutex_lock(&open_disc_mutex);
284 /* lock our device */
285 mutex_lock(&dev->lock);
286
287 /* are we really open? */
288 if (dev->open <= 0) {
289 mutex_unlock(&dev->lock);
290 mutex_unlock(&open_disc_mutex);
291 return -ENODEV;
292 }
293
294 --dev->open;
295
296 if (!dev->present) {
297 /* the device was unplugged before the file was released */
298 mutex_unlock(&dev->lock);
299 mutex_unlock(&open_disc_mutex);
300 idmouse_delete(dev);
301 } else {
302 mutex_unlock(&dev->lock);
303 mutex_unlock(&open_disc_mutex);
304 }
305 return 0;
306}
307
308static ssize_t idmouse_read(struct file *file, char __user *buffer, size_t count,
309 loff_t * ppos)
310{
311 struct usb_idmouse *dev = file->private_data;
312 int result;
313
314 /* lock this object */
315 mutex_lock(&dev->lock);
316
317 /* verify that the device wasn't unplugged */
318 if (!dev->present) {
319 mutex_unlock(&dev->lock);
320 return -ENODEV;
321 }
322
323 result = simple_read_from_buffer(buffer, count, ppos,
324 dev->bulk_in_buffer, IMGSIZE);
325 /* unlock the device */
326 mutex_unlock(&dev->lock);
327 return result;
328}
329
330static int idmouse_probe(struct usb_interface *interface,
331 const struct usb_device_id *id)
332{
333 struct usb_device *udev = interface_to_usbdev(interface);
334 struct usb_idmouse *dev;
335 struct usb_host_interface *iface_desc;
336 struct usb_endpoint_descriptor *endpoint;
337 int result;
338
339 /* check if we have gotten the data or the hid interface */
340 iface_desc = &interface->altsetting[0];
341 if (iface_desc->desc.bInterfaceClass != 0x0A)
342 return -ENODEV;
343
344 if (iface_desc->desc.bNumEndpoints < 1)
345 return -ENODEV;
346
347 /* allocate memory for our device state and initialize it */
348 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
349 if (dev == NULL)
350 return -ENOMEM;
351
352 mutex_init(&dev->lock);
353 dev->udev = udev;
354 dev->interface = interface;
355
356 /* set up the endpoint information - use only the first bulk-in endpoint */
357 result = usb_find_bulk_in_endpoint(iface_desc, &endpoint);
358 if (result) {
359 dev_err(&interface->dev, "Unable to find bulk-in endpoint.\n");
360 idmouse_delete(dev);
361 return result;
362 }
363
364 dev->orig_bi_size = usb_endpoint_maxp(endpoint);
365 dev->bulk_in_size = 0x200; /* works _much_ faster */
366 dev->bulk_in_endpointAddr = endpoint->bEndpointAddress;
367 dev->bulk_in_buffer = kmalloc(IMGSIZE + dev->bulk_in_size, GFP_KERNEL);
368 if (!dev->bulk_in_buffer) {
369 idmouse_delete(dev);
370 return -ENOMEM;
371 }
372
373 /* allow device read, write and ioctl */
374 dev->present = 1;
375
376 /* we can register the device now, as it is ready */
377 usb_set_intfdata(interface, dev);
378 result = usb_register_dev(interface, &idmouse_class);
379 if (result) {
380 /* something prevented us from registering this device */
381 dev_err(&interface->dev, "Unable to allocate minor number.\n");
382 usb_set_intfdata(interface, NULL);
383 idmouse_delete(dev);
384 return result;
385 }
386
387 /* be noisy */
388 dev_info(&interface->dev,"%s now attached\n",DRIVER_DESC);
389
390 return 0;
391}
392
393static void idmouse_disconnect(struct usb_interface *interface)
394{
395 struct usb_idmouse *dev;
396
397 /* get device structure */
398 dev = usb_get_intfdata(interface);
399
400 /* give back our minor */
401 usb_deregister_dev(interface, &idmouse_class);
402
403 mutex_lock(&open_disc_mutex);
404 usb_set_intfdata(interface, NULL);
405 /* lock the device */
406 mutex_lock(&dev->lock);
407 mutex_unlock(&open_disc_mutex);
408
409 /* prevent device read, write and ioctl */
410 dev->present = 0;
411
412 /* if the device is opened, idmouse_release will clean this up */
413 if (!dev->open) {
414 mutex_unlock(&dev->lock);
415 idmouse_delete(dev);
416 } else {
417 /* unlock */
418 mutex_unlock(&dev->lock);
419 }
420
421 dev_info(&interface->dev, "disconnected\n");
422}
423
424module_usb_driver(idmouse_driver);
425
426MODULE_AUTHOR(DRIVER_AUTHOR);
427MODULE_DESCRIPTION(DRIVER_DESC);
428MODULE_LICENSE("GPL");
429