1 // SPDX-License-Identifier: GPL-2.0+
3 * adutux - driver for ADU devices from Ontrak Control Systems
4 * This is an experimental driver. Use at your own risk.
5 * This driver is not supported by Ontrak Control Systems.
7 * Copyright (c) 2003 John Homppi (SCO, leave this notice here)
9 * derived from the Lego USB Tower driver 0.56:
10 * Copyright (c) 2003 David Glance <davidgsf@sourceforge.net>
11 * 2001 Juergen Stuber <stuber@loria.fr>
12 * that was derived from USB Skeleton driver - 0.5
13 * Copyright (c) 2001 Greg Kroah-Hartman (greg@kroah.com)
17 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
19 #include <linux/kernel.h>
20 #include <linux/sched/signal.h>
21 #include <linux/errno.h>
22 #include <linux/slab.h>
23 #include <linux/module.h>
24 #include <linux/usb.h>
25 #include <linux/mutex.h>
26 #include <linux/uaccess.h>
28 #define DRIVER_AUTHOR "John Homppi"
29 #define DRIVER_DESC "adutux (see www.ontrak.net)"
31 /* Define these values to match your device */
32 #define ADU_VENDOR_ID 0x0a07
33 #define ADU_PRODUCT_ID 0x0064
35 /* table of devices that work with this driver */
36 static const struct usb_device_id device_table[] = {
37 { USB_DEVICE(ADU_VENDOR_ID, ADU_PRODUCT_ID) }, /* ADU100 */
38 { USB_DEVICE(ADU_VENDOR_ID, ADU_PRODUCT_ID+20) }, /* ADU120 */
39 { USB_DEVICE(ADU_VENDOR_ID, ADU_PRODUCT_ID+30) }, /* ADU130 */
40 { USB_DEVICE(ADU_VENDOR_ID, ADU_PRODUCT_ID+100) }, /* ADU200 */
41 { USB_DEVICE(ADU_VENDOR_ID, ADU_PRODUCT_ID+108) }, /* ADU208 */
42 { USB_DEVICE(ADU_VENDOR_ID, ADU_PRODUCT_ID+118) }, /* ADU218 */
43 { } /* Terminating entry */
46 MODULE_DEVICE_TABLE(usb, device_table);
48 #ifdef CONFIG_USB_DYNAMIC_MINORS
49 #define ADU_MINOR_BASE 0
51 #define ADU_MINOR_BASE 67
54 /* we can have up to this number of device plugged in at once */
55 #define MAX_DEVICES 16
57 #define COMMAND_TIMEOUT (2*HZ)
60 * The locking scheme is a vanilla 3-lock:
61 * adu_device.buflock: A spinlock, covers what IRQs touch.
62 * adutux_mutex: A Static lock to cover open_count. It would also cover
63 * any globals, but we don't have them in 2.6.
64 * adu_device.mtx: A mutex to hold across sleepers like copy_from_user.
65 * It covers all of adu_device, except the open_count
66 * and what .buflock covers.
69 /* Structure to hold all of our device specific stuff */
72 struct usb_device *udev; /* save off the usb device pointer */
73 struct usb_interface *interface;
74 unsigned int minor; /* the starting minor number for this device */
75 char serial_number[8];
77 int open_count; /* number of times this port has been opened */
78 unsigned long disconnected:1;
80 char *read_buffer_primary;
81 int read_buffer_length;
82 char *read_buffer_secondary;
87 wait_queue_head_t read_wait;
88 wait_queue_head_t write_wait;
90 char *interrupt_in_buffer;
91 struct usb_endpoint_descriptor *interrupt_in_endpoint;
92 struct urb *interrupt_in_urb;
93 int read_urb_finished;
95 char *interrupt_out_buffer;
96 struct usb_endpoint_descriptor *interrupt_out_endpoint;
97 struct urb *interrupt_out_urb;
101 static DEFINE_MUTEX(adutux_mutex);
103 static struct usb_driver adu_driver;
105 static inline void adu_debug_data(struct device *dev, const char *function,
106 int size, const unsigned char *data)
108 dev_dbg(dev, "%s - length = %d, data = %*ph\n",
109 function, size, size, data);
113 * adu_abort_transfers
114 * aborts transfers and frees associated data structures
116 static void adu_abort_transfers(struct adu_device *dev)
120 if (dev->disconnected)
123 /* shutdown transfer */
125 /* XXX Anchor these instead */
126 spin_lock_irqsave(&dev->buflock, flags);
127 if (!dev->read_urb_finished) {
128 spin_unlock_irqrestore(&dev->buflock, flags);
129 usb_kill_urb(dev->interrupt_in_urb);
131 spin_unlock_irqrestore(&dev->buflock, flags);
133 spin_lock_irqsave(&dev->buflock, flags);
134 if (!dev->out_urb_finished) {
135 spin_unlock_irqrestore(&dev->buflock, flags);
136 wait_event_timeout(dev->write_wait, dev->out_urb_finished,
138 usb_kill_urb(dev->interrupt_out_urb);
140 spin_unlock_irqrestore(&dev->buflock, flags);
143 static void adu_delete(struct adu_device *dev)
145 /* free data structures */
146 usb_free_urb(dev->interrupt_in_urb);
147 usb_free_urb(dev->interrupt_out_urb);
148 kfree(dev->read_buffer_primary);
149 kfree(dev->read_buffer_secondary);
150 kfree(dev->interrupt_in_buffer);
151 kfree(dev->interrupt_out_buffer);
152 usb_put_dev(dev->udev);
156 static void adu_interrupt_in_callback(struct urb *urb)
158 struct adu_device *dev = urb->context;
159 int status = urb->status;
162 adu_debug_data(&dev->udev->dev, __func__,
163 urb->actual_length, urb->transfer_buffer);
165 spin_lock_irqsave(&dev->buflock, flags);
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_irqrestore(&dev->buflock, flags);
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;
207 adu_debug_data(&dev->udev->dev, __func__,
208 urb->actual_length, urb->transfer_buffer);
211 if ((status != -ENOENT) &&
212 (status != -ECONNRESET)) {
213 dev_dbg(&dev->udev->dev,
214 "%s :nonzero status received: %d\n", __func__,
220 spin_lock_irqsave(&dev->buflock, flags);
221 dev->out_urb_finished = 1;
222 wake_up(&dev->write_wait);
223 spin_unlock_irqrestore(&dev->buflock, flags);
226 static int adu_open(struct inode *inode, struct file *file)
228 struct adu_device *dev = NULL;
229 struct usb_interface *interface;
233 subminor = iminor(inode);
235 retval = mutex_lock_interruptible(&adutux_mutex);
239 interface = usb_find_interface(&adu_driver, subminor);
241 pr_err("%s - error, can't find device for minor %d\n",
247 dev = usb_get_intfdata(interface);
253 /* check that nobody else is using the device */
254 if (dev->open_count) {
260 dev_dbg(&dev->udev->dev, "%s: open count %d\n", __func__,
263 /* save device in the file's private structure */
264 file->private_data = dev;
266 /* initialize in direction */
267 dev->read_buffer_length = 0;
269 /* fixup first read by having urb waiting for it */
270 usb_fill_int_urb(dev->interrupt_in_urb, dev->udev,
271 usb_rcvintpipe(dev->udev,
272 dev->interrupt_in_endpoint->bEndpointAddress),
273 dev->interrupt_in_buffer,
274 usb_endpoint_maxp(dev->interrupt_in_endpoint),
275 adu_interrupt_in_callback, dev,
276 dev->interrupt_in_endpoint->bInterval);
277 dev->read_urb_finished = 0;
278 if (usb_submit_urb(dev->interrupt_in_urb, GFP_KERNEL))
279 dev->read_urb_finished = 1;
280 /* we ignore failure */
281 /* end of fixup for first read */
283 /* initialize out direction */
284 dev->out_urb_finished = 1;
289 mutex_unlock(&adutux_mutex);
294 static void adu_release_internal(struct adu_device *dev)
296 /* decrement our usage count for the device */
298 dev_dbg(&dev->udev->dev, "%s : open count %d\n", __func__,
300 if (dev->open_count <= 0) {
301 adu_abort_transfers(dev);
306 static int adu_release(struct inode *inode, struct file *file)
308 struct adu_device *dev;
316 dev = file->private_data;
322 mutex_lock(&adutux_mutex); /* not interruptible */
324 if (dev->open_count <= 0) {
325 dev_dbg(&dev->udev->dev, "%s : device not opened\n", __func__);
330 adu_release_internal(dev);
331 if (dev->disconnected) {
332 /* the device was unplugged before the file was released */
333 if (!dev->open_count) /* ... and we're the last user */
337 mutex_unlock(&adutux_mutex);
342 static ssize_t adu_read(struct file *file, __user char *buffer, size_t count,
345 struct adu_device *dev;
346 size_t bytes_read = 0;
347 size_t bytes_to_read = count;
351 int should_submit = 0;
353 DECLARE_WAITQUEUE(wait, current);
355 dev = file->private_data;
356 if (mutex_lock_interruptible(&dev->mtx))
359 /* verify that the device wasn't unplugged */
360 if (dev->disconnected) {
362 pr_err("No device or device unplugged %d\n", retval);
366 /* verify that some data was requested */
368 dev_dbg(&dev->udev->dev, "%s : read request of 0 bytes\n",
373 timeout = COMMAND_TIMEOUT;
374 dev_dbg(&dev->udev->dev, "%s : about to start looping\n", __func__);
375 while (bytes_to_read) {
376 int data_in_secondary = dev->secondary_tail - dev->secondary_head;
377 dev_dbg(&dev->udev->dev,
378 "%s : while, data_in_secondary=%d, status=%d\n",
379 __func__, data_in_secondary,
380 dev->interrupt_in_urb->status);
382 if (data_in_secondary) {
383 /* drain secondary buffer */
384 int amount = bytes_to_read < data_in_secondary ? bytes_to_read : data_in_secondary;
385 i = copy_to_user(buffer, dev->read_buffer_secondary+dev->secondary_head, amount);
390 dev->secondary_head += (amount - i);
391 bytes_read += (amount - i);
392 bytes_to_read -= (amount - i);
394 /* we check the primary buffer */
395 spin_lock_irqsave (&dev->buflock, flags);
396 if (dev->read_buffer_length) {
397 /* we secure access to the primary */
399 dev_dbg(&dev->udev->dev,
400 "%s : swap, read_buffer_length = %d\n",
401 __func__, dev->read_buffer_length);
402 tmp = dev->read_buffer_secondary;
403 dev->read_buffer_secondary = dev->read_buffer_primary;
404 dev->read_buffer_primary = tmp;
405 dev->secondary_head = 0;
406 dev->secondary_tail = dev->read_buffer_length;
407 dev->read_buffer_length = 0;
408 spin_unlock_irqrestore(&dev->buflock, flags);
409 /* we have a free buffer so use it */
412 /* even the primary was empty - we may need to do IO */
413 if (!dev->read_urb_finished) {
414 /* somebody is doing IO */
415 spin_unlock_irqrestore(&dev->buflock, flags);
416 dev_dbg(&dev->udev->dev,
417 "%s : submitted already\n",
420 /* we must initiate input */
421 dev_dbg(&dev->udev->dev,
422 "%s : initiate input\n",
424 dev->read_urb_finished = 0;
425 spin_unlock_irqrestore(&dev->buflock, flags);
427 usb_fill_int_urb(dev->interrupt_in_urb, dev->udev,
428 usb_rcvintpipe(dev->udev,
429 dev->interrupt_in_endpoint->bEndpointAddress),
430 dev->interrupt_in_buffer,
431 usb_endpoint_maxp(dev->interrupt_in_endpoint),
432 adu_interrupt_in_callback,
434 dev->interrupt_in_endpoint->bInterval);
435 retval = usb_submit_urb(dev->interrupt_in_urb, GFP_KERNEL);
437 dev->read_urb_finished = 1;
438 if (retval == -ENOMEM) {
439 retval = bytes_read ? bytes_read : -ENOMEM;
441 dev_dbg(&dev->udev->dev,
442 "%s : submit failed\n",
448 /* we wait for I/O to complete */
449 set_current_state(TASK_INTERRUPTIBLE);
450 add_wait_queue(&dev->read_wait, &wait);
451 spin_lock_irqsave(&dev->buflock, flags);
452 if (!dev->read_urb_finished) {
453 spin_unlock_irqrestore(&dev->buflock, flags);
454 timeout = schedule_timeout(COMMAND_TIMEOUT);
456 spin_unlock_irqrestore(&dev->buflock, flags);
457 set_current_state(TASK_RUNNING);
459 remove_wait_queue(&dev->read_wait, &wait);
462 dev_dbg(&dev->udev->dev,
463 "%s : timeout\n", __func__);
464 retval = bytes_read ? bytes_read : -ETIMEDOUT;
468 if (signal_pending(current)) {
469 dev_dbg(&dev->udev->dev,
470 "%s : signal pending\n",
472 retval = bytes_read ? bytes_read : -EINTR;
480 /* if the primary buffer is empty then use it */
481 spin_lock_irqsave(&dev->buflock, flags);
482 if (should_submit && dev->read_urb_finished) {
483 dev->read_urb_finished = 0;
484 spin_unlock_irqrestore(&dev->buflock, flags);
485 usb_fill_int_urb(dev->interrupt_in_urb, dev->udev,
486 usb_rcvintpipe(dev->udev,
487 dev->interrupt_in_endpoint->bEndpointAddress),
488 dev->interrupt_in_buffer,
489 usb_endpoint_maxp(dev->interrupt_in_endpoint),
490 adu_interrupt_in_callback,
492 dev->interrupt_in_endpoint->bInterval);
493 if (usb_submit_urb(dev->interrupt_in_urb, GFP_KERNEL) != 0)
494 dev->read_urb_finished = 1;
495 /* we ignore failure */
497 spin_unlock_irqrestore(&dev->buflock, flags);
501 /* unlock the device */
502 mutex_unlock(&dev->mtx);
507 static ssize_t adu_write(struct file *file, const __user char *buffer,
508 size_t count, loff_t *ppos)
510 DECLARE_WAITQUEUE(waita, current);
511 struct adu_device *dev;
512 size_t bytes_written = 0;
513 size_t bytes_to_write;
518 dev = file->private_data;
520 retval = mutex_lock_interruptible(&dev->mtx);
524 /* verify that the device wasn't unplugged */
525 if (dev->disconnected) {
527 pr_err("No device or device unplugged %d\n", retval);
531 /* verify that we actually have some data to write */
533 dev_dbg(&dev->udev->dev, "%s : write request of 0 bytes\n",
539 add_wait_queue(&dev->write_wait, &waita);
540 set_current_state(TASK_INTERRUPTIBLE);
541 spin_lock_irqsave(&dev->buflock, flags);
542 if (!dev->out_urb_finished) {
543 spin_unlock_irqrestore(&dev->buflock, flags);
545 mutex_unlock(&dev->mtx);
546 if (signal_pending(current)) {
547 dev_dbg(&dev->udev->dev, "%s : interrupted\n",
549 set_current_state(TASK_RUNNING);
553 if (schedule_timeout(COMMAND_TIMEOUT) == 0) {
554 dev_dbg(&dev->udev->dev,
555 "%s - command timed out.\n", __func__);
559 remove_wait_queue(&dev->write_wait, &waita);
560 retval = mutex_lock_interruptible(&dev->mtx);
562 retval = bytes_written ? bytes_written : retval;
566 dev_dbg(&dev->udev->dev,
567 "%s : in progress, count = %zd\n",
570 spin_unlock_irqrestore(&dev->buflock, flags);
571 set_current_state(TASK_RUNNING);
572 remove_wait_queue(&dev->write_wait, &waita);
573 dev_dbg(&dev->udev->dev, "%s : sending, count = %zd\n",
576 /* write the data into interrupt_out_buffer from userspace */
577 buffer_size = usb_endpoint_maxp(dev->interrupt_out_endpoint);
578 bytes_to_write = count > buffer_size ? buffer_size : count;
579 dev_dbg(&dev->udev->dev,
580 "%s : buffer_size = %zd, count = %zd, bytes_to_write = %zd\n",
581 __func__, buffer_size, count, bytes_to_write);
583 if (copy_from_user(dev->interrupt_out_buffer, buffer, bytes_to_write) != 0) {
588 /* send off the urb */
590 dev->interrupt_out_urb,
592 usb_sndintpipe(dev->udev, dev->interrupt_out_endpoint->bEndpointAddress),
593 dev->interrupt_out_buffer,
595 adu_interrupt_out_callback,
597 dev->interrupt_out_endpoint->bInterval);
598 dev->interrupt_out_urb->actual_length = bytes_to_write;
599 dev->out_urb_finished = 0;
600 retval = usb_submit_urb(dev->interrupt_out_urb, GFP_KERNEL);
602 dev->out_urb_finished = 1;
603 dev_err(&dev->udev->dev, "Couldn't submit "
604 "interrupt_out_urb %d\n", retval);
608 buffer += bytes_to_write;
609 count -= bytes_to_write;
611 bytes_written += bytes_to_write;
614 mutex_unlock(&dev->mtx);
615 return bytes_written;
618 mutex_unlock(&dev->mtx);
623 remove_wait_queue(&dev->write_wait, &waita);
627 /* file operations needed when we register this driver */
628 static const struct file_operations adu_fops = {
629 .owner = THIS_MODULE,
633 .release = adu_release,
634 .llseek = noop_llseek,
638 * usb class driver info in order to get a minor number from the usb core,
639 * and to have the device registered with devfs and the driver core
641 static struct usb_class_driver adu_class = {
642 .name = "usb/adutux%d",
644 .minor_base = ADU_MINOR_BASE,
650 * Called by the usb core when a new device is connected that it thinks
651 * this driver might be interested in.
653 static int adu_probe(struct usb_interface *interface,
654 const struct usb_device_id *id)
656 struct usb_device *udev = interface_to_usbdev(interface);
657 struct adu_device *dev = NULL;
658 int retval = -ENOMEM;
663 /* allocate memory for our device state and initialize it */
664 dev = kzalloc(sizeof(struct adu_device), GFP_KERNEL);
668 mutex_init(&dev->mtx);
669 spin_lock_init(&dev->buflock);
670 dev->udev = usb_get_dev(udev);
671 init_waitqueue_head(&dev->read_wait);
672 init_waitqueue_head(&dev->write_wait);
674 res = usb_find_common_endpoints_reverse(&interface->altsetting[0],
676 &dev->interrupt_in_endpoint,
677 &dev->interrupt_out_endpoint);
679 dev_err(&interface->dev, "interrupt endpoints not found\n");
684 in_end_size = usb_endpoint_maxp(dev->interrupt_in_endpoint);
685 out_end_size = usb_endpoint_maxp(dev->interrupt_out_endpoint);
687 dev->read_buffer_primary = kmalloc((4 * in_end_size), GFP_KERNEL);
688 if (!dev->read_buffer_primary)
691 /* debug code prime the buffer */
692 memset(dev->read_buffer_primary, 'a', in_end_size);
693 memset(dev->read_buffer_primary + in_end_size, 'b', in_end_size);
694 memset(dev->read_buffer_primary + (2 * in_end_size), 'c', in_end_size);
695 memset(dev->read_buffer_primary + (3 * in_end_size), 'd', in_end_size);
697 dev->read_buffer_secondary = kmalloc((4 * in_end_size), GFP_KERNEL);
698 if (!dev->read_buffer_secondary)
701 /* debug code prime the buffer */
702 memset(dev->read_buffer_secondary, 'e', in_end_size);
703 memset(dev->read_buffer_secondary + in_end_size, 'f', in_end_size);
704 memset(dev->read_buffer_secondary + (2 * in_end_size), 'g', in_end_size);
705 memset(dev->read_buffer_secondary + (3 * in_end_size), 'h', in_end_size);
707 dev->interrupt_in_buffer = kmalloc(in_end_size, GFP_KERNEL);
708 if (!dev->interrupt_in_buffer)
711 /* debug code prime the buffer */
712 memset(dev->interrupt_in_buffer, 'i', in_end_size);
714 dev->interrupt_in_urb = usb_alloc_urb(0, GFP_KERNEL);
715 if (!dev->interrupt_in_urb)
717 dev->interrupt_out_buffer = kmalloc(out_end_size, GFP_KERNEL);
718 if (!dev->interrupt_out_buffer)
720 dev->interrupt_out_urb = usb_alloc_urb(0, GFP_KERNEL);
721 if (!dev->interrupt_out_urb)
724 if (!usb_string(udev, udev->descriptor.iSerialNumber, dev->serial_number,
725 sizeof(dev->serial_number))) {
726 dev_err(&interface->dev, "Could not retrieve serial number\n");
730 dev_dbg(&interface->dev,"serial_number=%s", dev->serial_number);
732 /* we can register the device now, as it is ready */
733 usb_set_intfdata(interface, dev);
735 retval = usb_register_dev(interface, &adu_class);
738 /* something prevented us from registering this driver */
739 dev_err(&interface->dev, "Not able to get a minor for this device.\n");
740 usb_set_intfdata(interface, NULL);
744 dev->minor = interface->minor;
746 /* let the user know what node this device is now attached to */
747 dev_info(&interface->dev, "ADU%d %s now attached to /dev/usb/adutux%d\n",
748 le16_to_cpu(udev->descriptor.idProduct), dev->serial_number,
749 (dev->minor - ADU_MINOR_BASE));
761 * Called by the usb core when the device is removed from the system.
763 static void adu_disconnect(struct usb_interface *interface)
765 struct adu_device *dev;
767 dev = usb_get_intfdata(interface);
769 usb_deregister_dev(interface, &adu_class);
771 usb_poison_urb(dev->interrupt_in_urb);
772 usb_poison_urb(dev->interrupt_out_urb);
774 mutex_lock(&adutux_mutex);
775 usb_set_intfdata(interface, NULL);
777 mutex_lock(&dev->mtx); /* not interruptible */
778 dev->disconnected = 1;
779 mutex_unlock(&dev->mtx);
781 /* if the device is not opened, then we clean up right now */
782 if (!dev->open_count)
785 mutex_unlock(&adutux_mutex);
788 /* usb specific object needed to register this driver with the usb subsystem */
789 static struct usb_driver adu_driver = {
792 .disconnect = adu_disconnect,
793 .id_table = device_table,
796 module_usb_driver(adu_driver);
798 MODULE_AUTHOR(DRIVER_AUTHOR);
799 MODULE_DESCRIPTION(DRIVER_DESC);
800 MODULE_LICENSE("GPL");