2 * adutux - driver for ADU devices from Ontrak Control Systems
3 * This is an experimental driver. Use at your own risk.
4 * This driver is not supported by Ontrak Control Systems.
6 * Copyright (c) 2003 John Homppi (SCO, leave this notice here)
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License as
10 * published by the Free Software Foundation; either version 2 of
11 * the License, or (at your option) any later version.
13 * derived from the Lego USB Tower driver 0.56:
14 * Copyright (c) 2003 David Glance <davidgsf@sourceforge.net>
15 * 2001 Juergen Stuber <stuber@loria.fr>
16 * that was derived from USB Skeleton driver - 0.5
17 * Copyright (c) 2001 Greg Kroah-Hartman (greg@kroah.com)
21 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
23 #include <linux/kernel.h>
24 #include <linux/errno.h>
25 #include <linux/slab.h>
26 #include <linux/module.h>
27 #include <linux/usb.h>
28 #include <linux/mutex.h>
29 #include <linux/uaccess.h>
31 /* Version Information */
32 #define DRIVER_VERSION "v0.0.13"
33 #define DRIVER_AUTHOR "John Homppi"
34 #define DRIVER_DESC "adutux (see www.ontrak.net)"
36 /* Define these values to match your device */
37 #define ADU_VENDOR_ID 0x0a07
38 #define ADU_PRODUCT_ID 0x0064
40 /* table of devices that work with this driver */
41 static const struct usb_device_id device_table[] = {
42 { USB_DEVICE(ADU_VENDOR_ID, ADU_PRODUCT_ID) }, /* ADU100 */
43 { USB_DEVICE(ADU_VENDOR_ID, ADU_PRODUCT_ID+20) }, /* ADU120 */
44 { USB_DEVICE(ADU_VENDOR_ID, ADU_PRODUCT_ID+30) }, /* ADU130 */
45 { USB_DEVICE(ADU_VENDOR_ID, ADU_PRODUCT_ID+100) }, /* ADU200 */
46 { USB_DEVICE(ADU_VENDOR_ID, ADU_PRODUCT_ID+108) }, /* ADU208 */
47 { USB_DEVICE(ADU_VENDOR_ID, ADU_PRODUCT_ID+118) }, /* ADU218 */
48 { } /* Terminating entry */
51 MODULE_DEVICE_TABLE(usb, device_table);
53 #ifdef CONFIG_USB_DYNAMIC_MINORS
54 #define ADU_MINOR_BASE 0
56 #define ADU_MINOR_BASE 67
59 /* we can have up to this number of device plugged in at once */
60 #define MAX_DEVICES 16
62 #define COMMAND_TIMEOUT (2*HZ) /* 60 second timeout for a command */
65 * The locking scheme is a vanilla 3-lock:
66 * adu_device.buflock: A spinlock, covers what IRQs touch.
67 * adutux_mutex: A Static lock to cover open_count. It would also cover
68 * any globals, but we don't have them in 2.6.
69 * adu_device.mtx: A mutex to hold across sleepers like copy_from_user.
70 * It covers all of adu_device, except the open_count
71 * and what .buflock covers.
74 /* Structure to hold all of our device specific stuff */
77 struct usb_device *udev; /* save off the usb device pointer */
78 struct usb_interface *interface;
79 unsigned int minor; /* the starting minor number for this device */
80 char serial_number[8];
82 int open_count; /* number of times this port has been opened */
84 char *read_buffer_primary;
85 int read_buffer_length;
86 char *read_buffer_secondary;
91 wait_queue_head_t read_wait;
92 wait_queue_head_t write_wait;
94 char *interrupt_in_buffer;
95 struct usb_endpoint_descriptor *interrupt_in_endpoint;
96 struct urb *interrupt_in_urb;
97 int read_urb_finished;
99 char *interrupt_out_buffer;
100 struct usb_endpoint_descriptor *interrupt_out_endpoint;
101 struct urb *interrupt_out_urb;
102 int out_urb_finished;
105 static DEFINE_MUTEX(adutux_mutex);
107 static struct usb_driver adu_driver;
109 static inline void adu_debug_data(struct device *dev, const char *function,
110 int size, const unsigned char *data)
112 dev_dbg(dev, "%s - length = %d, data = %*ph\n",
113 function, size, size, data);
117 * adu_abort_transfers
118 * aborts transfers and frees associated data structures
120 static void adu_abort_transfers(struct adu_device *dev)
124 if (dev->udev == NULL)
127 /* shutdown transfer */
129 /* XXX Anchor these instead */
130 spin_lock_irqsave(&dev->buflock, flags);
131 if (!dev->read_urb_finished) {
132 spin_unlock_irqrestore(&dev->buflock, flags);
133 usb_kill_urb(dev->interrupt_in_urb);
135 spin_unlock_irqrestore(&dev->buflock, flags);
137 spin_lock_irqsave(&dev->buflock, flags);
138 if (!dev->out_urb_finished) {
139 spin_unlock_irqrestore(&dev->buflock, flags);
140 usb_kill_urb(dev->interrupt_out_urb);
142 spin_unlock_irqrestore(&dev->buflock, flags);
145 static void adu_delete(struct adu_device *dev)
147 /* free data structures */
148 usb_free_urb(dev->interrupt_in_urb);
149 usb_free_urb(dev->interrupt_out_urb);
150 kfree(dev->read_buffer_primary);
151 kfree(dev->read_buffer_secondary);
152 kfree(dev->interrupt_in_buffer);
153 kfree(dev->interrupt_out_buffer);
157 static void adu_interrupt_in_callback(struct urb *urb)
159 struct adu_device *dev = urb->context;
160 int status = urb->status;
162 adu_debug_data(&dev->udev->dev, __func__,
163 urb->actual_length, urb->transfer_buffer);
165 spin_lock(&dev->buflock);
168 if ((status != -ENOENT) && (status != -ECONNRESET) &&
169 (status != -ESHUTDOWN)) {
170 dev_dbg(&dev->udev->dev,
171 "%s : nonzero status received: %d\n",
177 if (urb->actual_length > 0 && dev->interrupt_in_buffer[0] != 0x00) {
178 if (dev->read_buffer_length <
179 (4 * usb_endpoint_maxp(dev->interrupt_in_endpoint)) -
180 (urb->actual_length)) {
181 memcpy (dev->read_buffer_primary +
182 dev->read_buffer_length,
183 dev->interrupt_in_buffer, urb->actual_length);
185 dev->read_buffer_length += urb->actual_length;
186 dev_dbg(&dev->udev->dev,"%s reading %d\n", __func__,
189 dev_dbg(&dev->udev->dev,"%s : read_buffer overflow\n",
195 dev->read_urb_finished = 1;
196 spin_unlock(&dev->buflock);
197 /* always wake up so we recover from errors */
198 wake_up_interruptible(&dev->read_wait);
201 static void adu_interrupt_out_callback(struct urb *urb)
203 struct adu_device *dev = urb->context;
204 int status = urb->status;
206 adu_debug_data(&dev->udev->dev, __func__,
207 urb->actual_length, urb->transfer_buffer);
210 if ((status != -ENOENT) &&
211 (status != -ECONNRESET)) {
212 dev_dbg(&dev->udev->dev,
213 "%s :nonzero status received: %d\n", __func__,
219 spin_lock(&dev->buflock);
220 dev->out_urb_finished = 1;
221 wake_up(&dev->write_wait);
222 spin_unlock(&dev->buflock);
225 static int adu_open(struct inode *inode, struct file *file)
227 struct adu_device *dev = NULL;
228 struct usb_interface *interface;
232 subminor = iminor(inode);
234 retval = mutex_lock_interruptible(&adutux_mutex);
238 interface = usb_find_interface(&adu_driver, subminor);
240 pr_err("%s - error, can't find device for minor %d\n",
246 dev = usb_get_intfdata(interface);
247 if (!dev || !dev->udev) {
252 /* check that nobody else is using the device */
253 if (dev->open_count) {
259 dev_dbg(&dev->udev->dev, "%s: open count %d\n", __func__,
262 /* save device in the file's private structure */
263 file->private_data = dev;
265 /* initialize in direction */
266 dev->read_buffer_length = 0;
268 /* fixup first read by having urb waiting for it */
269 usb_fill_int_urb(dev->interrupt_in_urb, dev->udev,
270 usb_rcvintpipe(dev->udev,
271 dev->interrupt_in_endpoint->bEndpointAddress),
272 dev->interrupt_in_buffer,
273 usb_endpoint_maxp(dev->interrupt_in_endpoint),
274 adu_interrupt_in_callback, dev,
275 dev->interrupt_in_endpoint->bInterval);
276 dev->read_urb_finished = 0;
277 if (usb_submit_urb(dev->interrupt_in_urb, GFP_KERNEL))
278 dev->read_urb_finished = 1;
279 /* we ignore failure */
280 /* end of fixup for first read */
282 /* initialize out direction */
283 dev->out_urb_finished = 1;
288 mutex_unlock(&adutux_mutex);
293 static void adu_release_internal(struct adu_device *dev)
295 /* decrement our usage count for the device */
297 dev_dbg(&dev->udev->dev, "%s : open count %d\n", __func__,
299 if (dev->open_count <= 0) {
300 adu_abort_transfers(dev);
305 static int adu_release(struct inode *inode, struct file *file)
307 struct adu_device *dev;
315 dev = file->private_data;
321 mutex_lock(&adutux_mutex); /* not interruptible */
323 if (dev->open_count <= 0) {
324 dev_dbg(&dev->udev->dev, "%s : device not opened\n", __func__);
329 adu_release_internal(dev);
330 if (dev->udev == NULL) {
331 /* the device was unplugged before the file was released */
332 if (!dev->open_count) /* ... and we're the last user */
336 mutex_unlock(&adutux_mutex);
341 static ssize_t adu_read(struct file *file, __user char *buffer, size_t count,
344 struct adu_device *dev;
345 size_t bytes_read = 0;
346 size_t bytes_to_read = count;
350 int should_submit = 0;
352 DECLARE_WAITQUEUE(wait, current);
354 dev = file->private_data;
355 if (mutex_lock_interruptible(&dev->mtx))
358 /* verify that the device wasn't unplugged */
359 if (dev->udev == NULL) {
361 pr_err("No device or device unplugged %d\n", retval);
365 /* verify that some data was requested */
367 dev_dbg(&dev->udev->dev, "%s : read request of 0 bytes\n",
372 timeout = COMMAND_TIMEOUT;
373 dev_dbg(&dev->udev->dev, "%s : about to start looping\n", __func__);
374 while (bytes_to_read) {
375 int data_in_secondary = dev->secondary_tail - dev->secondary_head;
376 dev_dbg(&dev->udev->dev,
377 "%s : while, data_in_secondary=%d, status=%d\n",
378 __func__, data_in_secondary,
379 dev->interrupt_in_urb->status);
381 if (data_in_secondary) {
382 /* drain secondary buffer */
383 int amount = bytes_to_read < data_in_secondary ? bytes_to_read : data_in_secondary;
384 i = copy_to_user(buffer, dev->read_buffer_secondary+dev->secondary_head, amount);
389 dev->secondary_head += (amount - i);
390 bytes_read += (amount - i);
391 bytes_to_read -= (amount - i);
393 retval = bytes_read ? bytes_read : -EFAULT;
397 /* we check the primary buffer */
398 spin_lock_irqsave (&dev->buflock, flags);
399 if (dev->read_buffer_length) {
400 /* we secure access to the primary */
402 dev_dbg(&dev->udev->dev,
403 "%s : swap, read_buffer_length = %d\n",
404 __func__, dev->read_buffer_length);
405 tmp = dev->read_buffer_secondary;
406 dev->read_buffer_secondary = dev->read_buffer_primary;
407 dev->read_buffer_primary = tmp;
408 dev->secondary_head = 0;
409 dev->secondary_tail = dev->read_buffer_length;
410 dev->read_buffer_length = 0;
411 spin_unlock_irqrestore(&dev->buflock, flags);
412 /* we have a free buffer so use it */
415 /* even the primary was empty - we may need to do IO */
416 if (!dev->read_urb_finished) {
417 /* somebody is doing IO */
418 spin_unlock_irqrestore(&dev->buflock, flags);
419 dev_dbg(&dev->udev->dev,
420 "%s : submitted already\n",
423 /* we must initiate input */
424 dev_dbg(&dev->udev->dev,
425 "%s : initiate input\n",
427 dev->read_urb_finished = 0;
428 spin_unlock_irqrestore(&dev->buflock, flags);
430 usb_fill_int_urb(dev->interrupt_in_urb, dev->udev,
431 usb_rcvintpipe(dev->udev,
432 dev->interrupt_in_endpoint->bEndpointAddress),
433 dev->interrupt_in_buffer,
434 usb_endpoint_maxp(dev->interrupt_in_endpoint),
435 adu_interrupt_in_callback,
437 dev->interrupt_in_endpoint->bInterval);
438 retval = usb_submit_urb(dev->interrupt_in_urb, GFP_KERNEL);
440 dev->read_urb_finished = 1;
441 if (retval == -ENOMEM) {
442 retval = bytes_read ? bytes_read : -ENOMEM;
444 dev_dbg(&dev->udev->dev,
445 "%s : submit failed\n",
451 /* we wait for I/O to complete */
452 set_current_state(TASK_INTERRUPTIBLE);
453 add_wait_queue(&dev->read_wait, &wait);
454 spin_lock_irqsave(&dev->buflock, flags);
455 if (!dev->read_urb_finished) {
456 spin_unlock_irqrestore(&dev->buflock, flags);
457 timeout = schedule_timeout(COMMAND_TIMEOUT);
459 spin_unlock_irqrestore(&dev->buflock, flags);
460 set_current_state(TASK_RUNNING);
462 remove_wait_queue(&dev->read_wait, &wait);
465 dev_dbg(&dev->udev->dev,
466 "%s : timeout\n", __func__);
467 retval = bytes_read ? bytes_read : -ETIMEDOUT;
471 if (signal_pending(current)) {
472 dev_dbg(&dev->udev->dev,
473 "%s : signal pending\n",
475 retval = bytes_read ? bytes_read : -EINTR;
483 /* if the primary buffer is empty then use it */
484 spin_lock_irqsave(&dev->buflock, flags);
485 if (should_submit && dev->read_urb_finished) {
486 dev->read_urb_finished = 0;
487 spin_unlock_irqrestore(&dev->buflock, flags);
488 usb_fill_int_urb(dev->interrupt_in_urb, dev->udev,
489 usb_rcvintpipe(dev->udev,
490 dev->interrupt_in_endpoint->bEndpointAddress),
491 dev->interrupt_in_buffer,
492 usb_endpoint_maxp(dev->interrupt_in_endpoint),
493 adu_interrupt_in_callback,
495 dev->interrupt_in_endpoint->bInterval);
496 if (usb_submit_urb(dev->interrupt_in_urb, GFP_KERNEL) != 0)
497 dev->read_urb_finished = 1;
498 /* we ignore failure */
500 spin_unlock_irqrestore(&dev->buflock, flags);
504 /* unlock the device */
505 mutex_unlock(&dev->mtx);
510 static ssize_t adu_write(struct file *file, const __user char *buffer,
511 size_t count, loff_t *ppos)
513 DECLARE_WAITQUEUE(waita, current);
514 struct adu_device *dev;
515 size_t bytes_written = 0;
516 size_t bytes_to_write;
521 dev = file->private_data;
523 retval = mutex_lock_interruptible(&dev->mtx);
527 /* verify that the device wasn't unplugged */
528 if (dev->udev == NULL) {
530 pr_err("No device or device unplugged %d\n", retval);
534 /* verify that we actually have some data to write */
536 dev_dbg(&dev->udev->dev, "%s : write request of 0 bytes\n",
542 add_wait_queue(&dev->write_wait, &waita);
543 set_current_state(TASK_INTERRUPTIBLE);
544 spin_lock_irqsave(&dev->buflock, flags);
545 if (!dev->out_urb_finished) {
546 spin_unlock_irqrestore(&dev->buflock, flags);
548 mutex_unlock(&dev->mtx);
549 if (signal_pending(current)) {
550 dev_dbg(&dev->udev->dev, "%s : interrupted\n",
552 set_current_state(TASK_RUNNING);
556 if (schedule_timeout(COMMAND_TIMEOUT) == 0) {
557 dev_dbg(&dev->udev->dev,
558 "%s - command timed out.\n", __func__);
562 remove_wait_queue(&dev->write_wait, &waita);
563 retval = mutex_lock_interruptible(&dev->mtx);
565 retval = bytes_written ? bytes_written : retval;
569 dev_dbg(&dev->udev->dev,
570 "%s : in progress, count = %Zd\n",
573 spin_unlock_irqrestore(&dev->buflock, flags);
574 set_current_state(TASK_RUNNING);
575 remove_wait_queue(&dev->write_wait, &waita);
576 dev_dbg(&dev->udev->dev, "%s : sending, count = %Zd\n",
579 /* write the data into interrupt_out_buffer from userspace */
580 buffer_size = usb_endpoint_maxp(dev->interrupt_out_endpoint);
581 bytes_to_write = count > buffer_size ? buffer_size : count;
582 dev_dbg(&dev->udev->dev,
583 "%s : buffer_size = %Zd, count = %Zd, bytes_to_write = %Zd\n",
584 __func__, buffer_size, count, bytes_to_write);
586 if (copy_from_user(dev->interrupt_out_buffer, buffer, bytes_to_write) != 0) {
591 /* send off the urb */
593 dev->interrupt_out_urb,
595 usb_sndintpipe(dev->udev, dev->interrupt_out_endpoint->bEndpointAddress),
596 dev->interrupt_out_buffer,
598 adu_interrupt_out_callback,
600 dev->interrupt_out_endpoint->bInterval);
601 dev->interrupt_out_urb->actual_length = bytes_to_write;
602 dev->out_urb_finished = 0;
603 retval = usb_submit_urb(dev->interrupt_out_urb, GFP_KERNEL);
605 dev->out_urb_finished = 1;
606 dev_err(&dev->udev->dev, "Couldn't submit "
607 "interrupt_out_urb %d\n", retval);
611 buffer += bytes_to_write;
612 count -= bytes_to_write;
614 bytes_written += bytes_to_write;
617 mutex_unlock(&dev->mtx);
618 return bytes_written;
621 mutex_unlock(&dev->mtx);
626 remove_wait_queue(&dev->write_wait, &waita);
630 /* file operations needed when we register this driver */
631 static const struct file_operations adu_fops = {
632 .owner = THIS_MODULE,
636 .release = adu_release,
637 .llseek = noop_llseek,
641 * usb class driver info in order to get a minor number from the usb core,
642 * and to have the device registered with devfs and the driver core
644 static struct usb_class_driver adu_class = {
645 .name = "usb/adutux%d",
647 .minor_base = ADU_MINOR_BASE,
653 * Called by the usb core when a new device is connected that it thinks
654 * this driver might be interested in.
656 static int adu_probe(struct usb_interface *interface,
657 const struct usb_device_id *id)
659 struct usb_device *udev = interface_to_usbdev(interface);
660 struct adu_device *dev = NULL;
661 struct usb_host_interface *iface_desc;
662 struct usb_endpoint_descriptor *endpoint;
663 int retval = -ENODEV;
669 dev_err(&interface->dev, "udev is NULL.\n");
673 /* allocate memory for our device state and initialize it */
674 dev = kzalloc(sizeof(struct adu_device), GFP_KERNEL);
676 dev_err(&interface->dev, "Out of memory\n");
681 mutex_init(&dev->mtx);
682 spin_lock_init(&dev->buflock);
684 init_waitqueue_head(&dev->read_wait);
685 init_waitqueue_head(&dev->write_wait);
687 iface_desc = &interface->altsetting[0];
689 /* set up the endpoint information */
690 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
691 endpoint = &iface_desc->endpoint[i].desc;
693 if (usb_endpoint_is_int_in(endpoint))
694 dev->interrupt_in_endpoint = endpoint;
696 if (usb_endpoint_is_int_out(endpoint))
697 dev->interrupt_out_endpoint = endpoint;
699 if (dev->interrupt_in_endpoint == NULL) {
700 dev_err(&interface->dev, "interrupt in endpoint not found\n");
703 if (dev->interrupt_out_endpoint == NULL) {
704 dev_err(&interface->dev, "interrupt out endpoint not found\n");
708 in_end_size = usb_endpoint_maxp(dev->interrupt_in_endpoint);
709 out_end_size = usb_endpoint_maxp(dev->interrupt_out_endpoint);
711 dev->read_buffer_primary = kmalloc((4 * in_end_size), GFP_KERNEL);
712 if (!dev->read_buffer_primary) {
713 dev_err(&interface->dev, "Couldn't allocate read_buffer_primary\n");
718 /* debug code prime the buffer */
719 memset(dev->read_buffer_primary, 'a', in_end_size);
720 memset(dev->read_buffer_primary + in_end_size, 'b', in_end_size);
721 memset(dev->read_buffer_primary + (2 * in_end_size), 'c', in_end_size);
722 memset(dev->read_buffer_primary + (3 * in_end_size), 'd', in_end_size);
724 dev->read_buffer_secondary = kmalloc((4 * in_end_size), GFP_KERNEL);
725 if (!dev->read_buffer_secondary) {
726 dev_err(&interface->dev, "Couldn't allocate read_buffer_secondary\n");
731 /* debug code prime the buffer */
732 memset(dev->read_buffer_secondary, 'e', in_end_size);
733 memset(dev->read_buffer_secondary + in_end_size, 'f', in_end_size);
734 memset(dev->read_buffer_secondary + (2 * in_end_size), 'g', in_end_size);
735 memset(dev->read_buffer_secondary + (3 * in_end_size), 'h', in_end_size);
737 dev->interrupt_in_buffer = kmalloc(in_end_size, GFP_KERNEL);
738 if (!dev->interrupt_in_buffer) {
739 dev_err(&interface->dev, "Couldn't allocate interrupt_in_buffer\n");
743 /* debug code prime the buffer */
744 memset(dev->interrupt_in_buffer, 'i', in_end_size);
746 dev->interrupt_in_urb = usb_alloc_urb(0, GFP_KERNEL);
747 if (!dev->interrupt_in_urb) {
748 dev_err(&interface->dev, "Couldn't allocate interrupt_in_urb\n");
751 dev->interrupt_out_buffer = kmalloc(out_end_size, GFP_KERNEL);
752 if (!dev->interrupt_out_buffer) {
753 dev_err(&interface->dev, "Couldn't allocate interrupt_out_buffer\n");
756 dev->interrupt_out_urb = usb_alloc_urb(0, GFP_KERNEL);
757 if (!dev->interrupt_out_urb) {
758 dev_err(&interface->dev, "Couldn't allocate interrupt_out_urb\n");
762 if (!usb_string(udev, udev->descriptor.iSerialNumber, dev->serial_number,
763 sizeof(dev->serial_number))) {
764 dev_err(&interface->dev, "Could not retrieve serial number\n");
767 dev_dbg(&interface->dev,"serial_number=%s", dev->serial_number);
769 /* we can register the device now, as it is ready */
770 usb_set_intfdata(interface, dev);
772 retval = usb_register_dev(interface, &adu_class);
775 /* something prevented us from registering this driver */
776 dev_err(&interface->dev, "Not able to get a minor for this device.\n");
777 usb_set_intfdata(interface, NULL);
781 dev->minor = interface->minor;
783 /* let the user know what node this device is now attached to */
784 dev_info(&interface->dev, "ADU%d %s now attached to /dev/usb/adutux%d\n",
785 le16_to_cpu(udev->descriptor.idProduct), dev->serial_number,
786 (dev->minor - ADU_MINOR_BASE));
798 * Called by the usb core when the device is removed from the system.
800 static void adu_disconnect(struct usb_interface *interface)
802 struct adu_device *dev;
805 dev = usb_get_intfdata(interface);
807 mutex_lock(&dev->mtx); /* not interruptible */
808 dev->udev = NULL; /* poison */
810 usb_deregister_dev(interface, &adu_class);
811 mutex_unlock(&dev->mtx);
813 mutex_lock(&adutux_mutex);
814 usb_set_intfdata(interface, NULL);
816 /* if the device is not opened, then we clean up right now */
817 if (!dev->open_count)
820 mutex_unlock(&adutux_mutex);
823 /* usb specific object needed to register this driver with the usb subsystem */
824 static struct usb_driver adu_driver = {
827 .disconnect = adu_disconnect,
828 .id_table = device_table,
831 module_usb_driver(adu_driver);
833 MODULE_AUTHOR(DRIVER_AUTHOR);
834 MODULE_DESCRIPTION(DRIVER_DESC);
835 MODULE_LICENSE("GPL");