1 /*
2 * Native support for the I/O-Warrior USB devices
3 *
4 * Copyright (c) 2003-2005 Code Mercenaries GmbH
5 * written by Christian Lucht <lucht@codemercs.com>
6 *
7 * based on
8
9 * usb-skeleton.c by Greg Kroah-Hartman <greg@kroah.com>
10 * brlvger.c by Stephane Dalton <sdalton@videotron.ca>
11 * and St�hane Doyon <s.doyon@videotron.ca>
12 *
13 * Released under the GPLv2.
14 */
15
16 #include <linux/module.h>
17 #include <linux/usb.h>
18 #include <linux/slab.h>
19 #include <linux/sched.h>
20 #include <linux/mutex.h>
21 #include <linux/poll.h>
22 #include <linux/usb/iowarrior.h>
23
24 /* Version Information */
25 #define DRIVER_VERSION "v0.4.0"
26 #define DRIVER_AUTHOR "Christian Lucht <lucht@codemercs.com>"
27 #define DRIVER_DESC "USB IO-Warrior driver (Linux 2.6.x)"
28
29 #define USB_VENDOR_ID_CODEMERCS 1984
30 /* low speed iowarrior */
31 #define USB_DEVICE_ID_CODEMERCS_IOW40 0x1500
32 #define USB_DEVICE_ID_CODEMERCS_IOW24 0x1501
33 #define USB_DEVICE_ID_CODEMERCS_IOWPV1 0x1511
34 #define USB_DEVICE_ID_CODEMERCS_IOWPV2 0x1512
35 /* full speed iowarrior */
36 #define USB_DEVICE_ID_CODEMERCS_IOW56 0x1503
37
38 /* Get a minor range for your devices from the usb maintainer */
39 #ifdef CONFIG_USB_DYNAMIC_MINORS
40 #define IOWARRIOR_MINOR_BASE 0
41 #else
42 #define IOWARRIOR_MINOR_BASE 208 // SKELETON_MINOR_BASE 192 + 16, not official yet
43 #endif
44
45 /* interrupt input queue size */
46 #define MAX_INTERRUPT_BUFFER 16
47 /*
48 maximum number of urbs that are submitted for writes at the same time,
49 this applies to the IOWarrior56 only!
50 IOWarrior24 and IOWarrior40 use synchronous usb_control_msg calls.
51 */
52 #define MAX_WRITES_IN_FLIGHT 4
53
54 MODULE_AUTHOR(DRIVER_AUTHOR);
55 MODULE_DESCRIPTION(DRIVER_DESC);
56 MODULE_LICENSE("GPL");
57
58 /* Module parameters */
59 static DEFINE_MUTEX(iowarrior_mutex);
60
61 static struct usb_driver iowarrior_driver;
62 static DEFINE_MUTEX(iowarrior_open_disc_lock);
63
64 /*--------------*/
65 /* data */
66 /*--------------*/
67
68 /* Structure to hold all of our device specific stuff */
69 struct iowarrior {
70 struct mutex mutex; /* locks this structure */
71 struct usb_device *udev; /* save off the usb device pointer */
72 struct usb_interface *interface; /* the interface for this device */
73 unsigned char minor; /* the starting minor number for this device */
74 struct usb_endpoint_descriptor *int_out_endpoint; /* endpoint for reading (needed for IOW56 only) */
75 struct usb_endpoint_descriptor *int_in_endpoint; /* endpoint for reading */
76 struct urb *int_in_urb; /* the urb for reading data */
77 unsigned char *int_in_buffer; /* buffer for data to be read */
78 unsigned char serial_number; /* to detect lost packages */
79 unsigned char *read_queue; /* size is MAX_INTERRUPT_BUFFER * packet size */
80 wait_queue_head_t read_wait;
81 wait_queue_head_t write_wait; /* wait-queue for writing to the device */
82 atomic_t write_busy; /* number of write-urbs submitted */
83 atomic_t read_idx;
84 atomic_t intr_idx;
85 spinlock_t intr_idx_lock; /* protects intr_idx */
86 atomic_t overflow_flag; /* signals an index 'rollover' */
87 int present; /* this is 1 as long as the device is connected */
88 int opened; /* this is 1 if the device is currently open */
89 char chip_serial[9]; /* the serial number string of the chip connected */
90 int report_size; /* number of bytes in a report */
91 u16 product_id;
92 struct usb_anchor submitted;
93 };
94
95 /*--------------*/
96 /* globals */
97 /*--------------*/
98
99 #define USB_REQ_GET_REPORT 0x01
100 //#if 0
usb_get_report(struct usb_device * dev,struct usb_host_interface * inter,unsigned char type,unsigned char id,void * buf,int size)101 static int usb_get_report(struct usb_device *dev,
102 struct usb_host_interface *inter, unsigned char type,
103 unsigned char id, void *buf, int size)
104 {
105 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
106 USB_REQ_GET_REPORT,
107 USB_DIR_IN | USB_TYPE_CLASS |
108 USB_RECIP_INTERFACE, (type << 8) + id,
109 inter->desc.bInterfaceNumber, buf, size,
110 USB_CTRL_GET_TIMEOUT);
111 }
112 //#endif
113
114 #define USB_REQ_SET_REPORT 0x09
115
usb_set_report(struct usb_interface * intf,unsigned char type,unsigned char id,void * buf,int size)116 static int usb_set_report(struct usb_interface *intf, unsigned char type,
117 unsigned char id, void *buf, int size)
118 {
119 return usb_control_msg(interface_to_usbdev(intf),
120 usb_sndctrlpipe(interface_to_usbdev(intf), 0),
121 USB_REQ_SET_REPORT,
122 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
123 (type << 8) + id,
124 intf->cur_altsetting->desc.bInterfaceNumber, buf,
125 size, 1000);
126 }
127
128 /*---------------------*/
129 /* driver registration */
130 /*---------------------*/
131 /* table of devices that work with this driver */
132 static const struct usb_device_id iowarrior_ids[] = {
133 {USB_DEVICE(USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW40)},
134 {USB_DEVICE(USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW24)},
135 {USB_DEVICE(USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOWPV1)},
136 {USB_DEVICE(USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOWPV2)},
137 {USB_DEVICE(USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW56)},
138 {} /* Terminating entry */
139 };
140 MODULE_DEVICE_TABLE(usb, iowarrior_ids);
141
142 /*
143 * USB callback handler for reading data
144 */
iowarrior_callback(struct urb * urb)145 static void iowarrior_callback(struct urb *urb)
146 {
147 struct iowarrior *dev = urb->context;
148 int intr_idx;
149 int read_idx;
150 int aux_idx;
151 int offset;
152 int status = urb->status;
153 int retval;
154
155 switch (status) {
156 case 0:
157 /* success */
158 break;
159 case -ECONNRESET:
160 case -ENOENT:
161 case -ESHUTDOWN:
162 return;
163 default:
164 goto exit;
165 }
166
167 spin_lock(&dev->intr_idx_lock);
168 intr_idx = atomic_read(&dev->intr_idx);
169 /* aux_idx become previous intr_idx */
170 aux_idx = (intr_idx == 0) ? (MAX_INTERRUPT_BUFFER - 1) : (intr_idx - 1);
171 read_idx = atomic_read(&dev->read_idx);
172
173 /* queue is not empty and it's interface 0 */
174 if ((intr_idx != read_idx)
175 && (dev->interface->cur_altsetting->desc.bInterfaceNumber == 0)) {
176 /* + 1 for serial number */
177 offset = aux_idx * (dev->report_size + 1);
178 if (!memcmp
179 (dev->read_queue + offset, urb->transfer_buffer,
180 dev->report_size)) {
181 /* equal values on interface 0 will be ignored */
182 spin_unlock(&dev->intr_idx_lock);
183 goto exit;
184 }
185 }
186
187 /* aux_idx become next intr_idx */
188 aux_idx = (intr_idx == (MAX_INTERRUPT_BUFFER - 1)) ? 0 : (intr_idx + 1);
189 if (read_idx == aux_idx) {
190 /* queue full, dropping oldest input */
191 read_idx = (++read_idx == MAX_INTERRUPT_BUFFER) ? 0 : read_idx;
192 atomic_set(&dev->read_idx, read_idx);
193 atomic_set(&dev->overflow_flag, 1);
194 }
195
196 /* +1 for serial number */
197 offset = intr_idx * (dev->report_size + 1);
198 memcpy(dev->read_queue + offset, urb->transfer_buffer,
199 dev->report_size);
200 *(dev->read_queue + offset + (dev->report_size)) = dev->serial_number++;
201
202 atomic_set(&dev->intr_idx, aux_idx);
203 spin_unlock(&dev->intr_idx_lock);
204 /* tell the blocking read about the new data */
205 wake_up_interruptible(&dev->read_wait);
206
207 exit:
208 retval = usb_submit_urb(urb, GFP_ATOMIC);
209 if (retval)
210 dev_err(&dev->interface->dev, "%s - usb_submit_urb failed with result %d\n",
211 __func__, retval);
212
213 }
214
215 /*
216 * USB Callback handler for write-ops
217 */
iowarrior_write_callback(struct urb * urb)218 static void iowarrior_write_callback(struct urb *urb)
219 {
220 struct iowarrior *dev;
221 int status = urb->status;
222
223 dev = urb->context;
224 /* sync/async unlink faults aren't errors */
225 if (status &&
226 !(status == -ENOENT ||
227 status == -ECONNRESET || status == -ESHUTDOWN)) {
228 dev_dbg(&dev->interface->dev,
229 "nonzero write bulk status received: %d\n", status);
230 }
231 /* free up our allocated buffer */
232 usb_free_coherent(urb->dev, urb->transfer_buffer_length,
233 urb->transfer_buffer, urb->transfer_dma);
234 /* tell a waiting writer the interrupt-out-pipe is available again */
235 atomic_dec(&dev->write_busy);
236 wake_up_interruptible(&dev->write_wait);
237 }
238
239 /**
240 * iowarrior_delete
241 */
iowarrior_delete(struct iowarrior * dev)242 static inline void iowarrior_delete(struct iowarrior *dev)
243 {
244 dev_dbg(&dev->interface->dev, "minor %d\n", dev->minor);
245 kfree(dev->int_in_buffer);
246 usb_free_urb(dev->int_in_urb);
247 kfree(dev->read_queue);
248 usb_put_intf(dev->interface);
249 kfree(dev);
250 }
251
252 /*---------------------*/
253 /* fops implementation */
254 /*---------------------*/
255
read_index(struct iowarrior * dev)256 static int read_index(struct iowarrior *dev)
257 {
258 int intr_idx, read_idx;
259
260 read_idx = atomic_read(&dev->read_idx);
261 intr_idx = atomic_read(&dev->intr_idx);
262
263 return (read_idx == intr_idx ? -1 : read_idx);
264 }
265
266 /**
267 * iowarrior_read
268 */
iowarrior_read(struct file * file,char __user * buffer,size_t count,loff_t * ppos)269 static ssize_t iowarrior_read(struct file *file, char __user *buffer,
270 size_t count, loff_t *ppos)
271 {
272 struct iowarrior *dev;
273 int read_idx;
274 int offset;
275
276 dev = file->private_data;
277
278 /* verify that the device wasn't unplugged */
279 if (dev == NULL || !dev->present)
280 return -ENODEV;
281
282 dev_dbg(&dev->interface->dev, "minor %d, count = %zd\n",
283 dev->minor, count);
284
285 /* read count must be packet size (+ time stamp) */
286 if ((count != dev->report_size)
287 && (count != (dev->report_size + 1)))
288 return -EINVAL;
289
290 /* repeat until no buffer overrun in callback handler occur */
291 do {
292 atomic_set(&dev->overflow_flag, 0);
293 if ((read_idx = read_index(dev)) == -1) {
294 /* queue empty */
295 if (file->f_flags & O_NONBLOCK)
296 return -EAGAIN;
297 else {
298 //next line will return when there is either new data, or the device is unplugged
299 int r = wait_event_interruptible(dev->read_wait,
300 (!dev->present
301 || (read_idx =
302 read_index
303 (dev)) !=
304 -1));
305 if (r) {
306 //we were interrupted by a signal
307 return -ERESTART;
308 }
309 if (!dev->present) {
310 //The device was unplugged
311 return -ENODEV;
312 }
313 if (read_idx == -1) {
314 // Can this happen ???
315 return 0;
316 }
317 }
318 }
319
320 offset = read_idx * (dev->report_size + 1);
321 if (copy_to_user(buffer, dev->read_queue + offset, count)) {
322 return -EFAULT;
323 }
324 } while (atomic_read(&dev->overflow_flag));
325
326 read_idx = ++read_idx == MAX_INTERRUPT_BUFFER ? 0 : read_idx;
327 atomic_set(&dev->read_idx, read_idx);
328 return count;
329 }
330
331 /*
332 * iowarrior_write
333 */
iowarrior_write(struct file * file,const char __user * user_buffer,size_t count,loff_t * ppos)334 static ssize_t iowarrior_write(struct file *file,
335 const char __user *user_buffer,
336 size_t count, loff_t *ppos)
337 {
338 struct iowarrior *dev;
339 int retval = 0;
340 char *buf = NULL; /* for IOW24 and IOW56 we need a buffer */
341 struct urb *int_out_urb = NULL;
342
343 dev = file->private_data;
344
345 mutex_lock(&dev->mutex);
346 /* verify that the device wasn't unplugged */
347 if (!dev->present) {
348 retval = -ENODEV;
349 goto exit;
350 }
351 dev_dbg(&dev->interface->dev, "minor %d, count = %zd\n",
352 dev->minor, count);
353 /* if count is 0 we're already done */
354 if (count == 0) {
355 retval = 0;
356 goto exit;
357 }
358 /* We only accept full reports */
359 if (count != dev->report_size) {
360 retval = -EINVAL;
361 goto exit;
362 }
363 switch (dev->product_id) {
364 case USB_DEVICE_ID_CODEMERCS_IOW24:
365 case USB_DEVICE_ID_CODEMERCS_IOWPV1:
366 case USB_DEVICE_ID_CODEMERCS_IOWPV2:
367 case USB_DEVICE_ID_CODEMERCS_IOW40:
368 /* IOW24 and IOW40 use a synchronous call */
369 buf = kmalloc(count, GFP_KERNEL);
370 if (!buf) {
371 retval = -ENOMEM;
372 goto exit;
373 }
374 if (copy_from_user(buf, user_buffer, count)) {
375 retval = -EFAULT;
376 kfree(buf);
377 goto exit;
378 }
379 retval = usb_set_report(dev->interface, 2, 0, buf, count);
380 kfree(buf);
381 goto exit;
382 break;
383 case USB_DEVICE_ID_CODEMERCS_IOW56:
384 /* The IOW56 uses asynchronous IO and more urbs */
385 if (atomic_read(&dev->write_busy) == MAX_WRITES_IN_FLIGHT) {
386 /* Wait until we are below the limit for submitted urbs */
387 if (file->f_flags & O_NONBLOCK) {
388 retval = -EAGAIN;
389 goto exit;
390 } else {
391 retval = wait_event_interruptible(dev->write_wait,
392 (!dev->present || (atomic_read (&dev-> write_busy) < MAX_WRITES_IN_FLIGHT)));
393 if (retval) {
394 /* we were interrupted by a signal */
395 retval = -ERESTART;
396 goto exit;
397 }
398 if (!dev->present) {
399 /* The device was unplugged */
400 retval = -ENODEV;
401 goto exit;
402 }
403 if (!dev->opened) {
404 /* We were closed while waiting for an URB */
405 retval = -ENODEV;
406 goto exit;
407 }
408 }
409 }
410 atomic_inc(&dev->write_busy);
411 int_out_urb = usb_alloc_urb(0, GFP_KERNEL);
412 if (!int_out_urb) {
413 retval = -ENOMEM;
414 dev_dbg(&dev->interface->dev,
415 "Unable to allocate urb\n");
416 goto error_no_urb;
417 }
418 buf = usb_alloc_coherent(dev->udev, dev->report_size,
419 GFP_KERNEL, &int_out_urb->transfer_dma);
420 if (!buf) {
421 retval = -ENOMEM;
422 dev_dbg(&dev->interface->dev,
423 "Unable to allocate buffer\n");
424 goto error_no_buffer;
425 }
426 usb_fill_int_urb(int_out_urb, dev->udev,
427 usb_sndintpipe(dev->udev,
428 dev->int_out_endpoint->bEndpointAddress),
429 buf, dev->report_size,
430 iowarrior_write_callback, dev,
431 dev->int_out_endpoint->bInterval);
432 int_out_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
433 if (copy_from_user(buf, user_buffer, count)) {
434 retval = -EFAULT;
435 goto error;
436 }
437 usb_anchor_urb(int_out_urb, &dev->submitted);
438 retval = usb_submit_urb(int_out_urb, GFP_KERNEL);
439 if (retval) {
440 dev_dbg(&dev->interface->dev,
441 "submit error %d for urb nr.%d\n",
442 retval, atomic_read(&dev->write_busy));
443 usb_unanchor_urb(int_out_urb);
444 goto error;
445 }
446 /* submit was ok */
447 retval = count;
448 usb_free_urb(int_out_urb);
449 goto exit;
450 break;
451 default:
452 /* what do we have here ? An unsupported Product-ID ? */
453 dev_err(&dev->interface->dev, "%s - not supported for product=0x%x\n",
454 __func__, dev->product_id);
455 retval = -EFAULT;
456 goto exit;
457 break;
458 }
459 error:
460 usb_free_coherent(dev->udev, dev->report_size, buf,
461 int_out_urb->transfer_dma);
462 error_no_buffer:
463 usb_free_urb(int_out_urb);
464 error_no_urb:
465 atomic_dec(&dev->write_busy);
466 wake_up_interruptible(&dev->write_wait);
467 exit:
468 mutex_unlock(&dev->mutex);
469 return retval;
470 }
471
472 /**
473 * iowarrior_ioctl
474 */
iowarrior_ioctl(struct file * file,unsigned int cmd,unsigned long arg)475 static long iowarrior_ioctl(struct file *file, unsigned int cmd,
476 unsigned long arg)
477 {
478 struct iowarrior *dev = NULL;
479 __u8 *buffer;
480 __u8 __user *user_buffer;
481 int retval;
482 int io_res; /* checks for bytes read/written and copy_to/from_user results */
483
484 dev = file->private_data;
485 if (dev == NULL) {
486 return -ENODEV;
487 }
488
489 buffer = kzalloc(dev->report_size, GFP_KERNEL);
490 if (!buffer)
491 return -ENOMEM;
492
493 /* lock this object */
494 mutex_lock(&iowarrior_mutex);
495 mutex_lock(&dev->mutex);
496
497 /* verify that the device wasn't unplugged */
498 if (!dev->present) {
499 retval = -ENODEV;
500 goto error_out;
501 }
502
503 dev_dbg(&dev->interface->dev, "minor %d, cmd 0x%.4x, arg %ld\n",
504 dev->minor, cmd, arg);
505
506 retval = 0;
507 io_res = 0;
508 switch (cmd) {
509 case IOW_WRITE:
510 if (dev->product_id == USB_DEVICE_ID_CODEMERCS_IOW24 ||
511 dev->product_id == USB_DEVICE_ID_CODEMERCS_IOWPV1 ||
512 dev->product_id == USB_DEVICE_ID_CODEMERCS_IOWPV2 ||
513 dev->product_id == USB_DEVICE_ID_CODEMERCS_IOW40) {
514 user_buffer = (__u8 __user *)arg;
515 io_res = copy_from_user(buffer, user_buffer,
516 dev->report_size);
517 if (io_res) {
518 retval = -EFAULT;
519 } else {
520 io_res = usb_set_report(dev->interface, 2, 0,
521 buffer,
522 dev->report_size);
523 if (io_res < 0)
524 retval = io_res;
525 }
526 } else {
527 retval = -EINVAL;
528 dev_err(&dev->interface->dev,
529 "ioctl 'IOW_WRITE' is not supported for product=0x%x.\n",
530 dev->product_id);
531 }
532 break;
533 case IOW_READ:
534 user_buffer = (__u8 __user *)arg;
535 io_res = usb_get_report(dev->udev,
536 dev->interface->cur_altsetting, 1, 0,
537 buffer, dev->report_size);
538 if (io_res < 0)
539 retval = io_res;
540 else {
541 io_res = copy_to_user(user_buffer, buffer, dev->report_size);
542 if (io_res)
543 retval = -EFAULT;
544 }
545 break;
546 case IOW_GETINFO:
547 {
548 /* Report available information for the device */
549 struct iowarrior_info info;
550 /* needed for power consumption */
551 struct usb_config_descriptor *cfg_descriptor = &dev->udev->actconfig->desc;
552
553 memset(&info, 0, sizeof(info));
554 /* directly from the descriptor */
555 info.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
556 info.product = dev->product_id;
557 info.revision = le16_to_cpu(dev->udev->descriptor.bcdDevice);
558
559 /* 0==UNKNOWN, 1==LOW(usb1.1) ,2=FULL(usb1.1), 3=HIGH(usb2.0) */
560 info.speed = dev->udev->speed;
561 info.if_num = dev->interface->cur_altsetting->desc.bInterfaceNumber;
562 info.report_size = dev->report_size;
563
564 /* serial number string has been read earlier 8 chars or empty string */
565 memcpy(info.serial, dev->chip_serial,
566 sizeof(dev->chip_serial));
567 if (cfg_descriptor == NULL) {
568 info.power = -1; /* no information available */
569 } else {
570 /* the MaxPower is stored in units of 2mA to make it fit into a byte-value */
571 info.power = cfg_descriptor->bMaxPower * 2;
572 }
573 io_res = copy_to_user((struct iowarrior_info __user *)arg, &info,
574 sizeof(struct iowarrior_info));
575 if (io_res)
576 retval = -EFAULT;
577 break;
578 }
579 default:
580 /* return that we did not understand this ioctl call */
581 retval = -ENOTTY;
582 break;
583 }
584 error_out:
585 /* unlock the device */
586 mutex_unlock(&dev->mutex);
587 mutex_unlock(&iowarrior_mutex);
588 kfree(buffer);
589 return retval;
590 }
591
592 /**
593 * iowarrior_open
594 */
iowarrior_open(struct inode * inode,struct file * file)595 static int iowarrior_open(struct inode *inode, struct file *file)
596 {
597 struct iowarrior *dev = NULL;
598 struct usb_interface *interface;
599 int subminor;
600 int retval = 0;
601
602 mutex_lock(&iowarrior_mutex);
603 subminor = iminor(inode);
604
605 interface = usb_find_interface(&iowarrior_driver, subminor);
606 if (!interface) {
607 mutex_unlock(&iowarrior_mutex);
608 printk(KERN_ERR "%s - error, can't find device for minor %d\n",
609 __func__, subminor);
610 return -ENODEV;
611 }
612
613 mutex_lock(&iowarrior_open_disc_lock);
614 dev = usb_get_intfdata(interface);
615 if (!dev) {
616 mutex_unlock(&iowarrior_open_disc_lock);
617 mutex_unlock(&iowarrior_mutex);
618 return -ENODEV;
619 }
620
621 mutex_lock(&dev->mutex);
622 mutex_unlock(&iowarrior_open_disc_lock);
623
624 /* Only one process can open each device, no sharing. */
625 if (dev->opened) {
626 retval = -EBUSY;
627 goto out;
628 }
629
630 /* setup interrupt handler for receiving values */
631 if ((retval = usb_submit_urb(dev->int_in_urb, GFP_KERNEL)) < 0) {
632 dev_err(&interface->dev, "Error %d while submitting URB\n", retval);
633 retval = -EFAULT;
634 goto out;
635 }
636 /* increment our usage count for the driver */
637 ++dev->opened;
638 /* save our object in the file's private structure */
639 file->private_data = dev;
640 retval = 0;
641
642 out:
643 mutex_unlock(&dev->mutex);
644 mutex_unlock(&iowarrior_mutex);
645 return retval;
646 }
647
648 /**
649 * iowarrior_release
650 */
iowarrior_release(struct inode * inode,struct file * file)651 static int iowarrior_release(struct inode *inode, struct file *file)
652 {
653 struct iowarrior *dev;
654 int retval = 0;
655
656 dev = file->private_data;
657 if (dev == NULL) {
658 return -ENODEV;
659 }
660
661 dev_dbg(&dev->interface->dev, "minor %d\n", dev->minor);
662
663 /* lock our device */
664 mutex_lock(&dev->mutex);
665
666 if (dev->opened <= 0) {
667 retval = -ENODEV; /* close called more than once */
668 mutex_unlock(&dev->mutex);
669 } else {
670 dev->opened = 0; /* we're closing now */
671 retval = 0;
672 if (dev->present) {
673 /*
674 The device is still connected so we only shutdown
675 pending read-/write-ops.
676 */
677 usb_kill_urb(dev->int_in_urb);
678 wake_up_interruptible(&dev->read_wait);
679 wake_up_interruptible(&dev->write_wait);
680 mutex_unlock(&dev->mutex);
681 } else {
682 /* The device was unplugged, cleanup resources */
683 mutex_unlock(&dev->mutex);
684 iowarrior_delete(dev);
685 }
686 }
687 return retval;
688 }
689
iowarrior_poll(struct file * file,poll_table * wait)690 static unsigned iowarrior_poll(struct file *file, poll_table * wait)
691 {
692 struct iowarrior *dev = file->private_data;
693 unsigned int mask = 0;
694
695 if (!dev->present)
696 return POLLERR | POLLHUP;
697
698 poll_wait(file, &dev->read_wait, wait);
699 poll_wait(file, &dev->write_wait, wait);
700
701 if (!dev->present)
702 return POLLERR | POLLHUP;
703
704 if (read_index(dev) != -1)
705 mask |= POLLIN | POLLRDNORM;
706
707 if (atomic_read(&dev->write_busy) < MAX_WRITES_IN_FLIGHT)
708 mask |= POLLOUT | POLLWRNORM;
709 return mask;
710 }
711
712 /*
713 * File operations needed when we register this driver.
714 * This assumes that this driver NEEDS file operations,
715 * of course, which means that the driver is expected
716 * to have a node in the /dev directory. If the USB
717 * device were for a network interface then the driver
718 * would use "struct net_driver" instead, and a serial
719 * device would use "struct tty_driver".
720 */
721 static const struct file_operations iowarrior_fops = {
722 .owner = THIS_MODULE,
723 .write = iowarrior_write,
724 .read = iowarrior_read,
725 .unlocked_ioctl = iowarrior_ioctl,
726 .open = iowarrior_open,
727 .release = iowarrior_release,
728 .poll = iowarrior_poll,
729 .llseek = noop_llseek,
730 };
731
iowarrior_devnode(struct device * dev,umode_t * mode)732 static char *iowarrior_devnode(struct device *dev, umode_t *mode)
733 {
734 return kasprintf(GFP_KERNEL, "usb/%s", dev_name(dev));
735 }
736
737 /*
738 * usb class driver info in order to get a minor number from the usb core,
739 * and to have the device registered with devfs and the driver core
740 */
741 static struct usb_class_driver iowarrior_class = {
742 .name = "iowarrior%d",
743 .devnode = iowarrior_devnode,
744 .fops = &iowarrior_fops,
745 .minor_base = IOWARRIOR_MINOR_BASE,
746 };
747
748 /*---------------------------------*/
749 /* probe and disconnect functions */
750 /*---------------------------------*/
751 /**
752 * iowarrior_probe
753 *
754 * Called by the usb core when a new device is connected that it thinks
755 * this driver might be interested in.
756 */
iowarrior_probe(struct usb_interface * interface,const struct usb_device_id * id)757 static int iowarrior_probe(struct usb_interface *interface,
758 const struct usb_device_id *id)
759 {
760 struct usb_device *udev = interface_to_usbdev(interface);
761 struct iowarrior *dev = NULL;
762 struct usb_host_interface *iface_desc;
763 struct usb_endpoint_descriptor *endpoint;
764 int i;
765 int retval = -ENOMEM;
766
767 /* allocate memory for our device state and initialize it */
768 dev = kzalloc(sizeof(struct iowarrior), GFP_KERNEL);
769 if (dev == NULL) {
770 dev_err(&interface->dev, "Out of memory\n");
771 return retval;
772 }
773
774 mutex_init(&dev->mutex);
775
776 atomic_set(&dev->intr_idx, 0);
777 atomic_set(&dev->read_idx, 0);
778 spin_lock_init(&dev->intr_idx_lock);
779 atomic_set(&dev->overflow_flag, 0);
780 init_waitqueue_head(&dev->read_wait);
781 atomic_set(&dev->write_busy, 0);
782 init_waitqueue_head(&dev->write_wait);
783
784 dev->udev = udev;
785 dev->interface = usb_get_intf(interface);
786
787 iface_desc = interface->cur_altsetting;
788 dev->product_id = le16_to_cpu(udev->descriptor.idProduct);
789
790 init_usb_anchor(&dev->submitted);
791
792 /* set up the endpoint information */
793 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
794 endpoint = &iface_desc->endpoint[i].desc;
795
796 if (usb_endpoint_is_int_in(endpoint))
797 dev->int_in_endpoint = endpoint;
798 if (usb_endpoint_is_int_out(endpoint))
799 /* this one will match for the IOWarrior56 only */
800 dev->int_out_endpoint = endpoint;
801 }
802
803 if (!dev->int_in_endpoint) {
804 dev_err(&interface->dev, "no interrupt-in endpoint found\n");
805 retval = -ENODEV;
806 goto error;
807 }
808
809 if (dev->product_id == USB_DEVICE_ID_CODEMERCS_IOW56) {
810 if (!dev->int_out_endpoint) {
811 dev_err(&interface->dev, "no interrupt-out endpoint found\n");
812 retval = -ENODEV;
813 goto error;
814 }
815 }
816
817 /* we have to check the report_size often, so remember it in the endianness suitable for our machine */
818 dev->report_size = usb_endpoint_maxp(dev->int_in_endpoint);
819 if ((dev->interface->cur_altsetting->desc.bInterfaceNumber == 0) &&
820 (dev->product_id == USB_DEVICE_ID_CODEMERCS_IOW56))
821 /* IOWarrior56 has wMaxPacketSize different from report size */
822 dev->report_size = 7;
823
824 /* create the urb and buffer for reading */
825 dev->int_in_urb = usb_alloc_urb(0, GFP_KERNEL);
826 if (!dev->int_in_urb) {
827 dev_err(&interface->dev, "Couldn't allocate interrupt_in_urb\n");
828 goto error;
829 }
830 dev->int_in_buffer = kmalloc(dev->report_size, GFP_KERNEL);
831 if (!dev->int_in_buffer) {
832 dev_err(&interface->dev, "Couldn't allocate int_in_buffer\n");
833 goto error;
834 }
835 usb_fill_int_urb(dev->int_in_urb, dev->udev,
836 usb_rcvintpipe(dev->udev,
837 dev->int_in_endpoint->bEndpointAddress),
838 dev->int_in_buffer, dev->report_size,
839 iowarrior_callback, dev,
840 dev->int_in_endpoint->bInterval);
841 /* create an internal buffer for interrupt data from the device */
842 dev->read_queue =
843 kmalloc(((dev->report_size + 1) * MAX_INTERRUPT_BUFFER),
844 GFP_KERNEL);
845 if (!dev->read_queue) {
846 dev_err(&interface->dev, "Couldn't allocate read_queue\n");
847 goto error;
848 }
849 /* Get the serial-number of the chip */
850 memset(dev->chip_serial, 0x00, sizeof(dev->chip_serial));
851 usb_string(udev, udev->descriptor.iSerialNumber, dev->chip_serial,
852 sizeof(dev->chip_serial));
853 if (strlen(dev->chip_serial) != 8)
854 memset(dev->chip_serial, 0x00, sizeof(dev->chip_serial));
855
856 /* Set the idle timeout to 0, if this is interface 0 */
857 if (dev->interface->cur_altsetting->desc.bInterfaceNumber == 0) {
858 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
859 0x0A,
860 USB_TYPE_CLASS | USB_RECIP_INTERFACE, 0,
861 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
862 }
863 /* allow device read and ioctl */
864 dev->present = 1;
865
866 /* we can register the device now, as it is ready */
867 usb_set_intfdata(interface, dev);
868
869 retval = usb_register_dev(interface, &iowarrior_class);
870 if (retval) {
871 /* something prevented us from registering this driver */
872 dev_err(&interface->dev, "Not able to get a minor for this device.\n");
873 usb_set_intfdata(interface, NULL);
874 goto error;
875 }
876
877 dev->minor = interface->minor;
878
879 /* let the user know what node this device is now attached to */
880 dev_info(&interface->dev, "IOWarrior product=0x%x, serial=%s interface=%d "
881 "now attached to iowarrior%d\n", dev->product_id, dev->chip_serial,
882 iface_desc->desc.bInterfaceNumber, dev->minor - IOWARRIOR_MINOR_BASE);
883 return retval;
884
885 error:
886 iowarrior_delete(dev);
887 return retval;
888 }
889
890 /**
891 * iowarrior_disconnect
892 *
893 * Called by the usb core when the device is removed from the system.
894 */
iowarrior_disconnect(struct usb_interface * interface)895 static void iowarrior_disconnect(struct usb_interface *interface)
896 {
897 struct iowarrior *dev;
898 int minor;
899
900 dev = usb_get_intfdata(interface);
901 mutex_lock(&iowarrior_open_disc_lock);
902 usb_set_intfdata(interface, NULL);
903
904 minor = dev->minor;
905 mutex_unlock(&iowarrior_open_disc_lock);
906 /* give back our minor - this will call close() locks need to be dropped at this point*/
907
908 usb_deregister_dev(interface, &iowarrior_class);
909
910 mutex_lock(&dev->mutex);
911
912 /* prevent device read, write and ioctl */
913 dev->present = 0;
914
915 if (dev->opened) {
916 /* There is a process that holds a filedescriptor to the device ,
917 so we only shutdown read-/write-ops going on.
918 Deleting the device is postponed until close() was called.
919 */
920 usb_kill_urb(dev->int_in_urb);
921 usb_kill_anchored_urbs(&dev->submitted);
922 wake_up_interruptible(&dev->read_wait);
923 wake_up_interruptible(&dev->write_wait);
924 mutex_unlock(&dev->mutex);
925 } else {
926 /* no process is using the device, cleanup now */
927 mutex_unlock(&dev->mutex);
928 iowarrior_delete(dev);
929 }
930
931 dev_info(&interface->dev, "I/O-Warror #%d now disconnected\n",
932 minor - IOWARRIOR_MINOR_BASE);
933 }
934
935 /* usb specific object needed to register this driver with the usb subsystem */
936 static struct usb_driver iowarrior_driver = {
937 .name = "iowarrior",
938 .probe = iowarrior_probe,
939 .disconnect = iowarrior_disconnect,
940 .id_table = iowarrior_ids,
941 };
942
943 module_usb_driver(iowarrior_driver);
944