1 /*****************************************************************************
2 * File: drivers/usb/misc/vstusb.c
4 * Purpose: Support for the bulk USB Vernier Spectrophotometers
6 * Author: Johnnie Peters
8 * Beaverton, OR, USA 97005
10 * Modified by: EQware Engineering, Inc.
11 * Oregon City, OR, USA 97045
13 * Copyright: 2007, 2008
14 * Vernier Software & Technology
15 * Beaverton, OR, USA 97005
17 * Web: www.vernier.com
19 * This program is free software; you can redistribute it and/or modify
20 * it under the terms of the GNU General Public License version 2 as
21 * published by the Free Software Foundation.
23 *****************************************************************************/
24 #include <linux/kernel.h>
25 #include <linux/errno.h>
26 #include <linux/init.h>
27 #include <linux/slab.h>
28 #include <linux/module.h>
29 #include <linux/mutex.h>
30 #include <linux/uaccess.h>
31 #include <linux/usb.h>
33 #include <linux/usb/vstusb.h>
35 #define DRIVER_VERSION "VST USB Driver Version 1.5"
36 #define DRIVER_DESC "Vernier Software Technology Bulk USB Driver"
38 #ifdef CONFIG_USB_DYNAMIC_MINORS
39 #define VSTUSB_MINOR_BASE 0
41 #define VSTUSB_MINOR_BASE 199
44 #define USB_VENDOR_OCEANOPTICS 0x2457
45 #define USB_VENDOR_VERNIER 0x08F7 /* Vernier Software & Technology */
47 #define USB_PRODUCT_USB2000 0x1002
48 #define USB_PRODUCT_ADC1000_FW 0x1003 /* firmware download (renumerates) */
49 #define USB_PRODUCT_ADC1000 0x1004
50 #define USB_PRODUCT_HR2000_FW 0x1009 /* firmware download (renumerates) */
51 #define USB_PRODUCT_HR2000 0x100A
52 #define USB_PRODUCT_HR4000_FW 0x1011 /* firmware download (renumerates) */
53 #define USB_PRODUCT_HR4000 0x1012
54 #define USB_PRODUCT_USB650 0x1014 /* "Red Tide" */
55 #define USB_PRODUCT_QE65000 0x1018
56 #define USB_PRODUCT_USB4000 0x1022
57 #define USB_PRODUCT_USB325 0x1024 /* "Vernier Spectrometer" */
59 #define USB_PRODUCT_LABPRO 0x0001
60 #define USB_PRODUCT_LABQUEST 0x0005
62 static struct usb_device_id id_table[] = {
63 { USB_DEVICE(USB_VENDOR_OCEANOPTICS, USB_PRODUCT_USB2000)},
64 { USB_DEVICE(USB_VENDOR_OCEANOPTICS, USB_PRODUCT_HR4000)},
65 { USB_DEVICE(USB_VENDOR_OCEANOPTICS, USB_PRODUCT_USB650)},
66 { USB_DEVICE(USB_VENDOR_OCEANOPTICS, USB_PRODUCT_USB4000)},
67 { USB_DEVICE(USB_VENDOR_OCEANOPTICS, USB_PRODUCT_USB325)},
68 { USB_DEVICE(USB_VENDOR_VERNIER, USB_PRODUCT_LABQUEST)},
69 { USB_DEVICE(USB_VENDOR_VERNIER, USB_PRODUCT_LABPRO)},
73 MODULE_DEVICE_TABLE(usb, id_table);
75 struct vstusb_device {
77 struct usb_device *usb_dev;
80 struct usb_anchor submitted;
87 static struct usb_driver vstusb_driver;
89 static int vstusb_open(struct inode *inode, struct file *file)
91 struct vstusb_device *vstdev;
92 struct usb_interface *interface;
94 interface = usb_find_interface(&vstusb_driver, iminor(inode));
97 printk(KERN_ERR KBUILD_MODNAME
98 ": %s - error, can't find device for minor %d\n",
99 __func__, iminor(inode));
103 vstdev = usb_get_intfdata(interface);
108 /* lock this device */
109 mutex_lock(&vstdev->lock);
111 /* can only open one time */
112 if ((!vstdev->present) || (vstdev->isopen)) {
113 mutex_unlock(&vstdev->lock);
119 /* save device in the file's private structure */
120 file->private_data = vstdev;
122 dev_dbg(&vstdev->usb_dev->dev, "%s: opened\n", __func__);
124 mutex_unlock(&vstdev->lock);
129 static int vstusb_close(struct inode *inode, struct file *file)
131 struct vstusb_device *vstdev;
133 vstdev = file->private_data;
138 mutex_lock(&vstdev->lock);
141 file->private_data = NULL;
143 /* if device is no longer present */
144 if (!vstdev->present) {
145 mutex_unlock(&vstdev->lock);
148 mutex_unlock(&vstdev->lock);
153 static void usb_api_blocking_completion(struct urb *urb)
155 struct completion *completeit = urb->context;
157 complete(completeit);
160 static int vstusb_fill_and_send_urb(struct urb *urb,
161 struct usb_device *usb_dev,
162 unsigned int pipe, void *data,
163 unsigned int len, struct completion *done)
165 struct usb_host_endpoint *ep;
166 struct usb_host_endpoint **hostep;
171 hostep = usb_pipein(pipe) ? usb_dev->ep_in : usb_dev->ep_out;
172 pipend = usb_pipeendpoint(pipe);
175 if (!ep || (len == 0))
178 if ((ep->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
179 == USB_ENDPOINT_XFER_INT) {
180 pipe = (pipe & ~(3 << 30)) | (PIPE_INTERRUPT << 30);
181 usb_fill_int_urb(urb, usb_dev, pipe, data, len,
182 (usb_complete_t)usb_api_blocking_completion,
183 NULL, ep->desc.bInterval);
185 usb_fill_bulk_urb(urb, usb_dev, pipe, data, len,
186 (usb_complete_t)usb_api_blocking_completion,
189 init_completion(done);
191 urb->actual_length = 0;
192 status = usb_submit_urb(urb, GFP_KERNEL);
197 static int vstusb_complete_urb(struct urb *urb, struct completion *done,
198 int timeout, int *actual_length)
200 unsigned long expire;
203 expire = timeout ? msecs_to_jiffies(timeout) : MAX_SCHEDULE_TIMEOUT;
204 if (!wait_for_completion_interruptible_timeout(done, expire)) {
206 status = urb->status == -ENOENT ? -ETIMEDOUT : urb->status;
208 dev_dbg(&urb->dev->dev,
209 "%s timed out on ep%d%s len=%d/%d, urb status = %d\n",
211 usb_pipeendpoint(urb->pipe),
212 usb_pipein(urb->pipe) ? "in" : "out",
214 urb->transfer_buffer_length,
218 if (signal_pending(current)) {
219 /* if really an error */
220 if (urb->status && !((urb->status == -ENOENT) ||
221 (urb->status == -ECONNRESET) ||
222 (urb->status == -ESHUTDOWN))) {
229 dev_dbg(&urb->dev->dev,
230 "%s: signal pending on ep%d%s len=%d/%d,"
233 usb_pipeendpoint(urb->pipe),
234 usb_pipein(urb->pipe) ? "in" : "out",
236 urb->transfer_buffer_length,
240 status = urb->status;
245 *actual_length = urb->actual_length;
250 static ssize_t vstusb_read(struct file *file, char __user *buffer,
251 size_t count, loff_t *ppos)
253 struct vstusb_device *vstdev;
259 struct usb_device *dev;
263 DECLARE_COMPLETION_ONSTACK(done);
265 vstdev = file->private_data;
270 /* verify that we actually want to read some data */
274 /* lock this object */
275 if (mutex_lock_interruptible(&vstdev->lock))
279 if (!vstdev->present) {
280 mutex_unlock(&vstdev->lock);
281 printk(KERN_ERR KBUILD_MODNAME
282 ": %s: device not present\n", __func__);
286 /* pull out the necessary data */
287 dev = vstdev->usb_dev;
288 pipe = usb_rcvbulkpipe(dev, vstdev->rd_pipe);
289 timeout = vstdev->rd_timeout_ms;
291 buf = kmalloc(count, GFP_KERNEL);
293 mutex_unlock(&vstdev->lock);
297 urb = usb_alloc_urb(0, GFP_KERNEL);
300 mutex_unlock(&vstdev->lock);
304 usb_anchor_urb(urb, &vstdev->submitted);
305 retval = vstusb_fill_and_send_urb(urb, dev, pipe, buf, count, &done);
306 mutex_unlock(&vstdev->lock);
308 usb_unanchor_urb(urb);
309 dev_err(&dev->dev, "%s: error %d filling and sending urb %d\n",
310 __func__, retval, pipe);
314 retval = vstusb_complete_urb(urb, &done, timeout, &cnt);
316 dev_err(&dev->dev, "%s: error %d completing urb %d\n",
317 __func__, retval, pipe);
321 if (copy_to_user(buffer, buf, cnt)) {
322 dev_err(&dev->dev, "%s: can't copy_to_user\n", __func__);
326 dev_dbg(&dev->dev, "%s: read %d bytes from pipe %d\n",
327 __func__, cnt, pipe);
336 static ssize_t vstusb_write(struct file *file, const char __user *buffer,
337 size_t count, loff_t *ppos)
339 struct vstusb_device *vstdev;
345 struct usb_device *dev;
349 DECLARE_COMPLETION_ONSTACK(done);
351 vstdev = file->private_data;
356 /* verify that we actually have some data to write */
360 /* lock this object */
361 if (mutex_lock_interruptible(&vstdev->lock))
365 if (!vstdev->present) {
366 mutex_unlock(&vstdev->lock);
367 printk(KERN_ERR KBUILD_MODNAME
368 ": %s: device not present\n", __func__);
372 /* pull out the necessary data */
373 dev = vstdev->usb_dev;
374 pipe = usb_sndbulkpipe(dev, vstdev->wr_pipe);
375 timeout = vstdev->wr_timeout_ms;
377 buf = kmalloc(count, GFP_KERNEL);
379 mutex_unlock(&vstdev->lock);
383 urb = usb_alloc_urb(0, GFP_KERNEL);
386 mutex_unlock(&vstdev->lock);
390 if (copy_from_user(buf, buffer, count)) {
391 dev_err(&dev->dev, "%s: can't copy_from_user\n", __func__);
396 usb_anchor_urb(urb, &vstdev->submitted);
397 retval = vstusb_fill_and_send_urb(urb, dev, pipe, buf, count, &done);
398 mutex_unlock(&vstdev->lock);
400 usb_unanchor_urb(urb);
401 dev_err(&dev->dev, "%s: error %d filling and sending urb %d\n",
402 __func__, retval, pipe);
406 retval = vstusb_complete_urb(urb, &done, timeout, &cnt);
408 dev_err(&dev->dev, "%s: error %d completing urb %d\n",
409 __func__, retval, pipe);
413 dev_dbg(&dev->dev, "%s: sent %d bytes to pipe %d\n",
414 __func__, cnt, pipe);
423 static long vstusb_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
427 void __user *data = (void __user *)arg;
428 struct vstusb_args usb_data;
430 struct vstusb_device *vstdev;
431 void *buffer = NULL; /* must be initialized. buffer is
432 * referenced on exit but not all
433 * ioctls allocate it */
435 struct urb *urb = NULL; /* must be initialized. urb is
436 * referenced on exit but not all
437 * ioctls allocate it */
438 struct usb_device *dev;
442 DECLARE_COMPLETION_ONSTACK(done);
444 vstdev = file->private_data;
446 if (_IOC_TYPE(cmd) != VST_IOC_MAGIC) {
447 dev_warn(&vstdev->usb_dev->dev,
448 "%s: ioctl command %x, bad ioctl magic %x, "
449 "expected %x\n", __func__, cmd,
450 _IOC_TYPE(cmd), VST_IOC_MAGIC);
457 if (copy_from_user(&usb_data, data, sizeof(struct vstusb_args))) {
458 dev_err(&vstdev->usb_dev->dev, "%s: can't copy_from_user\n",
463 /* lock this object */
464 if (mutex_lock_interruptible(&vstdev->lock)) {
465 retval = -ERESTARTSYS;
470 if (!vstdev->present) {
471 mutex_unlock(&vstdev->lock);
472 dev_err(&vstdev->usb_dev->dev, "%s: device not present\n",
478 /* pull out the necessary data */
479 dev = vstdev->usb_dev;
483 case IOCTL_VSTUSB_CONFIG_RW:
485 vstdev->rd_pipe = usb_data.rd_pipe;
486 vstdev->rd_timeout_ms = usb_data.rd_timeout_ms;
487 vstdev->wr_pipe = usb_data.wr_pipe;
488 vstdev->wr_timeout_ms = usb_data.wr_timeout_ms;
490 mutex_unlock(&vstdev->lock);
492 dev_dbg(&dev->dev, "%s: setting pipes/timeouts, "
493 "rdpipe = %d, rdtimeout = %d, "
494 "wrpipe = %d, wrtimeout = %d\n", __func__,
495 vstdev->rd_pipe, vstdev->rd_timeout_ms,
496 vstdev->wr_pipe, vstdev->wr_timeout_ms);
499 case IOCTL_VSTUSB_SEND_PIPE:
501 if (usb_data.count == 0) {
502 mutex_unlock(&vstdev->lock);
507 buffer = kmalloc(usb_data.count, GFP_KERNEL);
508 if (buffer == NULL) {
509 mutex_unlock(&vstdev->lock);
514 urb = usb_alloc_urb(0, GFP_KERNEL);
516 mutex_unlock(&vstdev->lock);
521 timeout = usb_data.timeout_ms;
523 pipe = usb_sndbulkpipe(dev, usb_data.pipe);
525 if (copy_from_user(buffer, usb_data.buffer, usb_data.count)) {
526 dev_err(&dev->dev, "%s: can't copy_from_user\n",
528 mutex_unlock(&vstdev->lock);
533 usb_anchor_urb(urb, &vstdev->submitted);
534 retval = vstusb_fill_and_send_urb(urb, dev, pipe, buffer,
535 usb_data.count, &done);
536 mutex_unlock(&vstdev->lock);
538 usb_unanchor_urb(urb);
540 "%s: error %d filling and sending urb %d\n",
541 __func__, retval, pipe);
545 retval = vstusb_complete_urb(urb, &done, timeout, &cnt);
547 dev_err(&dev->dev, "%s: error %d completing urb %d\n",
548 __func__, retval, pipe);
552 case IOCTL_VSTUSB_RECV_PIPE:
554 if (usb_data.count == 0) {
555 mutex_unlock(&vstdev->lock);
560 buffer = kmalloc(usb_data.count, GFP_KERNEL);
561 if (buffer == NULL) {
562 mutex_unlock(&vstdev->lock);
567 urb = usb_alloc_urb(0, GFP_KERNEL);
569 mutex_unlock(&vstdev->lock);
574 timeout = usb_data.timeout_ms;
576 pipe = usb_rcvbulkpipe(dev, usb_data.pipe);
578 usb_anchor_urb(urb, &vstdev->submitted);
579 retval = vstusb_fill_and_send_urb(urb, dev, pipe, buffer,
580 usb_data.count, &done);
581 mutex_unlock(&vstdev->lock);
583 usb_unanchor_urb(urb);
585 "%s: error %d filling and sending urb %d\n",
586 __func__, retval, pipe);
590 retval = vstusb_complete_urb(urb, &done, timeout, &cnt);
592 dev_err(&dev->dev, "%s: error %d completing urb %d\n",
593 __func__, retval, pipe);
597 if (copy_to_user(usb_data.buffer, buffer, cnt)) {
598 dev_err(&dev->dev, "%s: can't copy_to_user\n",
604 usb_data.count = cnt;
605 if (copy_to_user(data, &usb_data, sizeof(struct vstusb_args))) {
606 dev_err(&dev->dev, "%s: can't copy_to_user\n",
610 dev_dbg(&dev->dev, "%s: recv %d bytes from pipe %d\n",
611 __func__, usb_data.count, usb_data.pipe);
617 mutex_unlock(&vstdev->lock);
618 dev_warn(&dev->dev, "ioctl_vstusb: invalid ioctl cmd %x\n",
629 static const struct file_operations vstusb_fops = {
630 .owner = THIS_MODULE,
632 .write = vstusb_write,
633 .unlocked_ioctl = vstusb_ioctl,
634 .compat_ioctl = vstusb_ioctl,
636 .release = vstusb_close,
639 static struct usb_class_driver usb_vstusb_class = {
640 .name = "usb/vstusb%d",
641 .fops = &vstusb_fops,
642 .minor_base = VSTUSB_MINOR_BASE,
645 static int vstusb_probe(struct usb_interface *intf,
646 const struct usb_device_id *id)
648 struct usb_device *dev = interface_to_usbdev(intf);
649 struct vstusb_device *vstdev;
653 /* allocate memory for our device state and intialize it */
655 vstdev = kzalloc(sizeof(*vstdev), GFP_KERNEL);
659 mutex_init(&vstdev->lock);
661 i = dev->descriptor.bcdDevice;
663 dev_dbg(&intf->dev, "Version %1d%1d.%1d%1d found at address %d\n",
664 (i & 0xF000) >> 12, (i & 0xF00) >> 8,
665 (i & 0xF0) >> 4, (i & 0xF), dev->devnum);
669 vstdev->usb_dev = dev;
670 init_usb_anchor(&vstdev->submitted);
672 usb_set_intfdata(intf, vstdev);
673 retval = usb_register_dev(intf, &usb_vstusb_class);
676 "%s: Not able to get a minor for this device.\n",
678 usb_set_intfdata(intf, NULL);
683 /* let the user know what node this device is now attached to */
685 "VST USB Device #%d now attached to major %d minor %d\n",
686 (intf->minor - VSTUSB_MINOR_BASE), USB_MAJOR, intf->minor);
688 dev_info(&intf->dev, "%s, %s\n", DRIVER_DESC, DRIVER_VERSION);
693 static void vstusb_disconnect(struct usb_interface *intf)
695 struct vstusb_device *vstdev = usb_get_intfdata(intf);
697 usb_deregister_dev(intf, &usb_vstusb_class);
698 usb_set_intfdata(intf, NULL);
702 mutex_lock(&vstdev->lock);
705 usb_kill_anchored_urbs(&vstdev->submitted);
707 /* if the device is not opened, then we clean up right now */
708 if (!vstdev->isopen) {
709 mutex_unlock(&vstdev->lock);
712 mutex_unlock(&vstdev->lock);
717 static int vstusb_suspend(struct usb_interface *intf, pm_message_t message)
719 struct vstusb_device *vstdev = usb_get_intfdata(intf);
724 mutex_lock(&vstdev->lock);
725 time = usb_wait_anchor_empty_timeout(&vstdev->submitted, 1000);
727 usb_kill_anchored_urbs(&vstdev->submitted);
728 mutex_unlock(&vstdev->lock);
733 static int vstusb_resume(struct usb_interface *intf)
738 static struct usb_driver vstusb_driver = {
740 .probe = vstusb_probe,
741 .disconnect = vstusb_disconnect,
742 .suspend = vstusb_suspend,
743 .resume = vstusb_resume,
744 .id_table = id_table,
747 static int __init vstusb_init(void)
751 rc = usb_register(&vstusb_driver);
753 printk(KERN_ERR "%s: failed to register (%d)", __func__, rc);
758 static void __exit vstusb_exit(void)
760 usb_deregister(&vstusb_driver);
763 module_init(vstusb_init);
764 module_exit(vstusb_exit);
766 MODULE_AUTHOR("Dennis O'Brien/Stephen Ware");
767 MODULE_DESCRIPTION(DRIVER_VERSION);
768 MODULE_LICENSE("GPL");