projects/linux·blob master · refs

406 lines · 10.5 KiB

1// SPDX-License-Identifier: GPL-2.0+
2/* Siemens ID Mouse driver v0.6
3
4 Copyright (C) 2004-5 by Florian 'Floe' Echtler <[email protected]>
5 and Andreas 'ad' Deresch <[email protected]>
6
7 Derived from the USB Skeleton driver 1.1,
8 Copyright (C) 2003 Greg Kroah-Hartman ([email protected])
9
10 Additional information provided by Martin Reising
11 <[email protected]>
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 <[email protected]>"
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);
63
64/* structure to hold all of our device specific stuff */
65struct usb_idmouse {
66 struct kref kref;
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 /* check for valid image */
182 /* right border should be black (0x00) */
183 for (bytes_read = sizeof(HEADER)-1 + WIDTH-1; bytes_read < IMGSIZE; bytes_read += WIDTH)
184 if (dev->bulk_in_buffer[bytes_read] != 0x00)
185 return -EAGAIN;
186
187 /* lower border should be white (0xFF) */
188 for (bytes_read = IMGSIZE-WIDTH; bytes_read < IMGSIZE-1; bytes_read++)
189 if (dev->bulk_in_buffer[bytes_read] != 0xFF)
190 return -EAGAIN;
191
192 /* reset the device */
193reset:
194 ftip_command(dev, FTIP_RELEASE, 0, 0);
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 kref *kref)
214{
215 struct usb_idmouse *dev = container_of(kref, struct usb_idmouse, kref);
216
217 kfree(dev->bulk_in_buffer);
218 kfree(dev);
219}
220
221static int idmouse_open(struct inode *inode, struct file *file)
222{
223 struct usb_idmouse *dev;
224 struct usb_interface *interface;
225 int result;
226
227 /* get the interface from minor number and driver information */
228 interface = usb_find_interface(&idmouse_driver, iminor(inode));
229 if (!interface)
230 return -ENODEV;
231
232 /* get the device information block from the interface */
233 dev = usb_get_intfdata(interface);
234 if (!dev)
235 return -ENODEV;
236
237 /* lock this device */
238 mutex_lock(&dev->lock);
239
240 /* check if already open */
241 if (dev->open) {
242
243 /* already open, so fail */
244 result = -EBUSY;
245
246 } else {
247
248 /* create a new image and check for success */
249 result = usb_autopm_get_interface(interface);
250 if (result)
251 goto error;
252 result = idmouse_create_image(dev);
253 usb_autopm_put_interface(interface);
254 if (result)
255 goto error;
256
257 /* increment our usage count for the driver */
258 ++dev->open;
259
260 kref_get(&dev->kref);
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 /* lock our device */
284 mutex_lock(&dev->lock);
285 --dev->open;
286 mutex_unlock(&dev->lock);
287
288 kref_put(&dev->kref, idmouse_delete);
289
290 return 0;
291}
292
293static ssize_t idmouse_read(struct file *file, char __user *buffer, size_t count,
294 loff_t * ppos)
295{
296 struct usb_idmouse *dev = file->private_data;
297 int result;
298
299 /* lock this object */
300 mutex_lock(&dev->lock);
301
302 /* verify that the device wasn't unplugged */
303 if (!dev->present) {
304 mutex_unlock(&dev->lock);
305 return -ENODEV;
306 }
307
308 result = simple_read_from_buffer(buffer, count, ppos,
309 dev->bulk_in_buffer, IMGSIZE);
310 /* unlock the device */
311 mutex_unlock(&dev->lock);
312 return result;
313}
314
315static int idmouse_probe(struct usb_interface *interface,
316 const struct usb_device_id *id)
317{
318 struct usb_device *udev = interface_to_usbdev(interface);
319 struct usb_idmouse *dev;
320 struct usb_host_interface *iface_desc;
321 struct usb_endpoint_descriptor *endpoint;
322 int result;
323
324 /* check if we have gotten the data or the hid interface */
325 iface_desc = interface->cur_altsetting;
326 if (iface_desc->desc.bInterfaceClass != 0x0A)
327 return -ENODEV;
328
329 if (iface_desc->desc.bNumEndpoints < 1)
330 return -ENODEV;
331
332 /* allocate memory for our device state and initialize it */
333 dev = kzalloc_obj(*dev);
334 if (dev == NULL)
335 return -ENOMEM;
336
337 kref_init(&dev->kref);
338 mutex_init(&dev->lock);
339 dev->udev = udev;
340 dev->interface = interface;
341
342 /* set up the endpoint information - use only the first bulk-in endpoint */
343 result = usb_find_bulk_in_endpoint(iface_desc, &endpoint);
344 if (result) {
345 dev_err(&interface->dev, "Unable to find bulk-in endpoint.\n");
346 goto err_put_kref;
347 }
348
349 dev->orig_bi_size = usb_endpoint_maxp(endpoint);
350 dev->bulk_in_size = 0x200; /* works _much_ faster */
351 dev->bulk_in_endpointAddr = endpoint->bEndpointAddress;
352 dev->bulk_in_buffer = kmalloc(IMGSIZE + dev->bulk_in_size, GFP_KERNEL);
353 if (!dev->bulk_in_buffer) {
354 result = -ENOMEM;
355 goto err_put_kref;
356 }
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 dev_err(&interface->dev, "Unable to allocate minor number.\n");
367 goto err_put_kref;
368 }
369
370 /* be noisy */
371 dev_info(&interface->dev,"%s now attached\n",DRIVER_DESC);
372
373 return 0;
374
375err_put_kref:
376 kref_put(&dev->kref, idmouse_delete);
377
378 return result;
379}
380
381static void idmouse_disconnect(struct usb_interface *interface)
382{
383 struct usb_idmouse *dev = usb_get_intfdata(interface);
384
385 /* give back our minor */
386 usb_deregister_dev(interface, &idmouse_class);
387
388 /* lock the device */
389 mutex_lock(&dev->lock);
390
391 /* prevent device read, write and ioctl */
392 dev->present = 0;
393
394 mutex_unlock(&dev->lock);
395
396 kref_put(&dev->kref, idmouse_delete);
397
398 dev_info(&interface->dev, "disconnected\n");
399}
400
401module_usb_driver(idmouse_driver);
402
403MODULE_AUTHOR(DRIVER_AUTHOR);
404MODULE_DESCRIPTION(DRIVER_DESC);
405MODULE_LICENSE("GPL");
406