blob: 965f6eaea6a0ace3ddb1014fa687ab6850cb3dd0 [file] [log] [blame]
Steven Haigh03270632006-08-09 07:42:06 +10001/*
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.
5 *
6 * Copyright (c) 2003 John Homppi (SCO, leave this notice here)
7 *
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.
12 *
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)
18 *
19 */
20
21#include <linux/kernel.h>
22#include <linux/errno.h>
23#include <linux/init.h>
24#include <linux/slab.h>
25#include <linux/module.h>
26#include <linux/usb.h>
Matthias Kaehlcke8293c562007-07-13 21:28:31 +020027#include <linux/mutex.h>
Steven Haigh03270632006-08-09 07:42:06 +100028#include <asm/uaccess.h>
29
30#ifdef CONFIG_USB_DEBUG
31static int debug = 5;
32#else
33static int debug = 1;
34#endif
35
36/* Use our own dbg macro */
37#undef dbg
38#define dbg(lvl, format, arg...) \
39do { \
40 if (debug >= lvl) \
41 printk(KERN_DEBUG __FILE__ " : " format " \n", ## arg); \
42} while (0)
43
44
45/* Version Information */
46#define DRIVER_VERSION "v0.0.13"
47#define DRIVER_AUTHOR "John Homppi"
48#define DRIVER_DESC "adutux (see www.ontrak.net)"
49
50/* Module parameters */
51module_param(debug, int, S_IRUGO | S_IWUSR);
52MODULE_PARM_DESC(debug, "Debug enabled or not");
53
54/* Define these values to match your device */
55#define ADU_VENDOR_ID 0x0a07
56#define ADU_PRODUCT_ID 0x0064
57
58/* table of devices that work with this driver */
59static struct usb_device_id device_table [] = {
60 { USB_DEVICE(ADU_VENDOR_ID, ADU_PRODUCT_ID) }, /* ADU100 */
61 { USB_DEVICE(ADU_VENDOR_ID, ADU_PRODUCT_ID+20) }, /* ADU120 */
62 { USB_DEVICE(ADU_VENDOR_ID, ADU_PRODUCT_ID+30) }, /* ADU130 */
63 { USB_DEVICE(ADU_VENDOR_ID, ADU_PRODUCT_ID+100) }, /* ADU200 */
64 { USB_DEVICE(ADU_VENDOR_ID, ADU_PRODUCT_ID+108) }, /* ADU208 */
65 { USB_DEVICE(ADU_VENDOR_ID, ADU_PRODUCT_ID+118) }, /* ADU218 */
66 { }/* Terminating entry */
67};
68
69MODULE_DEVICE_TABLE(usb, device_table);
70
71#ifdef CONFIG_USB_DYNAMIC_MINORS
72#define ADU_MINOR_BASE 0
73#else
74#define ADU_MINOR_BASE 67
75#endif
76
77/* we can have up to this number of device plugged in at once */
78#define MAX_DEVICES 16
79
80#define COMMAND_TIMEOUT (2*HZ) /* 60 second timeout for a command */
81
Pete Zaitcevf08812d2007-10-31 15:59:30 -070082/*
83 * The locking scheme is a vanilla 3-lock:
84 * adu_device.buflock: A spinlock, covers what IRQs touch.
85 * adutux_mutex: A Static lock to cover open_count. It would also cover
86 * any globals, but we don't have them in 2.6.
87 * adu_device.mtx: A mutex to hold across sleepers like copy_from_user.
88 * It covers all of adu_device, except the open_count
89 * and what .buflock covers.
90 */
91
Steven Haigh03270632006-08-09 07:42:06 +100092/* Structure to hold all of our device specific stuff */
93struct adu_device {
Pete Zaitcevf08812d2007-10-31 15:59:30 -070094 struct mutex mtx;
Steven Haigh03270632006-08-09 07:42:06 +100095 struct usb_device* udev; /* save off the usb device pointer */
96 struct usb_interface* interface;
Pete Zaitcevf08812d2007-10-31 15:59:30 -070097 unsigned int minor; /* the starting minor number for this device */
Steven Haigh03270632006-08-09 07:42:06 +100098 char serial_number[8];
99
100 int open_count; /* number of times this port has been opened */
101
102 char* read_buffer_primary;
103 int read_buffer_length;
104 char* read_buffer_secondary;
105 int secondary_head;
106 int secondary_tail;
107 spinlock_t buflock;
108
109 wait_queue_head_t read_wait;
110 wait_queue_head_t write_wait;
111
112 char* interrupt_in_buffer;
113 struct usb_endpoint_descriptor* interrupt_in_endpoint;
114 struct urb* interrupt_in_urb;
115 int read_urb_finished;
116
117 char* interrupt_out_buffer;
118 struct usb_endpoint_descriptor* interrupt_out_endpoint;
119 struct urb* interrupt_out_urb;
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700120 int out_urb_finished;
Steven Haigh03270632006-08-09 07:42:06 +1000121};
122
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700123static DEFINE_MUTEX(adutux_mutex);
124
Steven Haigh03270632006-08-09 07:42:06 +1000125static struct usb_driver adu_driver;
126
127static void adu_debug_data(int level, const char *function, int size,
128 const unsigned char *data)
129{
130 int i;
131
132 if (debug < level)
133 return;
134
135 printk(KERN_DEBUG __FILE__": %s - length = %d, data = ",
136 function, size);
137 for (i = 0; i < size; ++i)
138 printk("%.2x ", data[i]);
139 printk("\n");
140}
141
142/**
143 * adu_abort_transfers
144 * aborts transfers and frees associated data structures
145 */
146static void adu_abort_transfers(struct adu_device *dev)
147{
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700148 unsigned long flags;
Steven Haigh03270632006-08-09 07:42:06 +1000149
Harvey Harrison441b62c2008-03-03 16:08:34 -0800150 dbg(2," %s : enter", __func__);
Steven Haigh03270632006-08-09 07:42:06 +1000151
152 if (dev->udev == NULL) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800153 dbg(1," %s : udev is null", __func__);
Steven Haigh03270632006-08-09 07:42:06 +1000154 goto exit;
155 }
156
Steven Haigh03270632006-08-09 07:42:06 +1000157 /* shutdown transfer */
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700158
159 /* XXX Anchor these instead */
160 spin_lock_irqsave(&dev->buflock, flags);
161 if (!dev->read_urb_finished) {
162 spin_unlock_irqrestore(&dev->buflock, flags);
163 usb_kill_urb(dev->interrupt_in_urb);
164 } else
165 spin_unlock_irqrestore(&dev->buflock, flags);
166
167 spin_lock_irqsave(&dev->buflock, flags);
168 if (!dev->out_urb_finished) {
169 spin_unlock_irqrestore(&dev->buflock, flags);
170 usb_kill_urb(dev->interrupt_out_urb);
171 } else
172 spin_unlock_irqrestore(&dev->buflock, flags);
Steven Haigh03270632006-08-09 07:42:06 +1000173
174exit:
Harvey Harrison441b62c2008-03-03 16:08:34 -0800175 dbg(2," %s : leave", __func__);
Steven Haigh03270632006-08-09 07:42:06 +1000176}
177
178static void adu_delete(struct adu_device *dev)
179{
Harvey Harrison441b62c2008-03-03 16:08:34 -0800180 dbg(2, "%s enter", __func__);
Steven Haigh03270632006-08-09 07:42:06 +1000181
Steven Haigh03270632006-08-09 07:42:06 +1000182 /* free data structures */
183 usb_free_urb(dev->interrupt_in_urb);
184 usb_free_urb(dev->interrupt_out_urb);
185 kfree(dev->read_buffer_primary);
186 kfree(dev->read_buffer_secondary);
187 kfree(dev->interrupt_in_buffer);
188 kfree(dev->interrupt_out_buffer);
189 kfree(dev);
190
Harvey Harrison441b62c2008-03-03 16:08:34 -0800191 dbg(2, "%s : leave", __func__);
Steven Haigh03270632006-08-09 07:42:06 +1000192}
193
David Howells7d12e782006-10-05 14:55:46 +0100194static void adu_interrupt_in_callback(struct urb *urb)
Steven Haigh03270632006-08-09 07:42:06 +1000195{
196 struct adu_device *dev = urb->context;
Greg Kroah-Hartman24497a02007-07-18 10:58:02 -0700197 int status = urb->status;
Steven Haigh03270632006-08-09 07:42:06 +1000198
Harvey Harrison441b62c2008-03-03 16:08:34 -0800199 dbg(4," %s : enter, status %d", __func__, status);
200 adu_debug_data(5, __func__, urb->actual_length,
Steven Haigh03270632006-08-09 07:42:06 +1000201 urb->transfer_buffer);
202
203 spin_lock(&dev->buflock);
204
Greg Kroah-Hartman24497a02007-07-18 10:58:02 -0700205 if (status != 0) {
Oliver Neukumf6c1cea2007-08-16 16:02:08 +0200206 if ((status != -ENOENT) && (status != -ECONNRESET) &&
207 (status != -ESHUTDOWN)) {
Steven Haigh03270632006-08-09 07:42:06 +1000208 dbg(1," %s : nonzero status received: %d",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800209 __func__, status);
Steven Haigh03270632006-08-09 07:42:06 +1000210 }
211 goto exit;
212 }
213
214 if (urb->actual_length > 0 && dev->interrupt_in_buffer[0] != 0x00) {
215 if (dev->read_buffer_length <
216 (4 * le16_to_cpu(dev->interrupt_in_endpoint->wMaxPacketSize)) -
217 (urb->actual_length)) {
218 memcpy (dev->read_buffer_primary +
219 dev->read_buffer_length,
220 dev->interrupt_in_buffer, urb->actual_length);
221
222 dev->read_buffer_length += urb->actual_length;
Harvey Harrison441b62c2008-03-03 16:08:34 -0800223 dbg(2," %s reading %d ", __func__,
Steven Haigh03270632006-08-09 07:42:06 +1000224 urb->actual_length);
225 } else {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800226 dbg(1," %s : read_buffer overflow", __func__);
Steven Haigh03270632006-08-09 07:42:06 +1000227 }
228 }
229
230exit:
231 dev->read_urb_finished = 1;
232 spin_unlock(&dev->buflock);
233 /* always wake up so we recover from errors */
234 wake_up_interruptible(&dev->read_wait);
Harvey Harrison441b62c2008-03-03 16:08:34 -0800235 adu_debug_data(5, __func__, urb->actual_length,
Steven Haigh03270632006-08-09 07:42:06 +1000236 urb->transfer_buffer);
Harvey Harrison441b62c2008-03-03 16:08:34 -0800237 dbg(4," %s : leave, status %d", __func__, status);
Steven Haigh03270632006-08-09 07:42:06 +1000238}
239
David Howells7d12e782006-10-05 14:55:46 +0100240static void adu_interrupt_out_callback(struct urb *urb)
Steven Haigh03270632006-08-09 07:42:06 +1000241{
242 struct adu_device *dev = urb->context;
Greg Kroah-Hartman24497a02007-07-18 10:58:02 -0700243 int status = urb->status;
Steven Haigh03270632006-08-09 07:42:06 +1000244
Harvey Harrison441b62c2008-03-03 16:08:34 -0800245 dbg(4," %s : enter, status %d", __func__, status);
246 adu_debug_data(5,__func__, urb->actual_length, urb->transfer_buffer);
Steven Haigh03270632006-08-09 07:42:06 +1000247
Greg Kroah-Hartman24497a02007-07-18 10:58:02 -0700248 if (status != 0) {
249 if ((status != -ENOENT) &&
250 (status != -ECONNRESET)) {
Steven Haigh03270632006-08-09 07:42:06 +1000251 dbg(1, " %s :nonzero status received: %d",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800252 __func__, status);
Steven Haigh03270632006-08-09 07:42:06 +1000253 }
254 goto exit;
255 }
256
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700257 spin_lock(&dev->buflock);
258 dev->out_urb_finished = 1;
259 wake_up(&dev->write_wait);
260 spin_unlock(&dev->buflock);
Steven Haigh03270632006-08-09 07:42:06 +1000261exit:
262
Harvey Harrison441b62c2008-03-03 16:08:34 -0800263 adu_debug_data(5, __func__, urb->actual_length,
Steven Haigh03270632006-08-09 07:42:06 +1000264 urb->transfer_buffer);
Harvey Harrison441b62c2008-03-03 16:08:34 -0800265 dbg(4," %s : leave, status %d", __func__, status);
Steven Haigh03270632006-08-09 07:42:06 +1000266}
267
268static int adu_open(struct inode *inode, struct file *file)
269{
270 struct adu_device *dev = NULL;
271 struct usb_interface *interface;
272 int subminor;
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700273 int retval;
Steven Haigh03270632006-08-09 07:42:06 +1000274
Harvey Harrison441b62c2008-03-03 16:08:34 -0800275 dbg(2,"%s : enter", __func__);
Steven Haigh03270632006-08-09 07:42:06 +1000276
277 subminor = iminor(inode);
278
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700279 if ((retval = mutex_lock_interruptible(&adutux_mutex))) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800280 dbg(2, "%s : mutex lock failed", __func__);
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700281 goto exit_no_lock;
282 }
283
Steven Haigh03270632006-08-09 07:42:06 +1000284 interface = usb_find_interface(&adu_driver, subminor);
285 if (!interface) {
286 err("%s - error, can't find device for minor %d",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800287 __func__, subminor);
Steven Haigh03270632006-08-09 07:42:06 +1000288 retval = -ENODEV;
289 goto exit_no_device;
290 }
291
292 dev = usb_get_intfdata(interface);
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700293 if (!dev || !dev->udev) {
Steven Haigh03270632006-08-09 07:42:06 +1000294 retval = -ENODEV;
295 goto exit_no_device;
296 }
297
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700298 /* check that nobody else is using the device */
299 if (dev->open_count) {
300 retval = -EBUSY;
Steven Haigh03270632006-08-09 07:42:06 +1000301 goto exit_no_device;
302 }
303
Steven Haigh03270632006-08-09 07:42:06 +1000304 ++dev->open_count;
Harvey Harrison441b62c2008-03-03 16:08:34 -0800305 dbg(2,"%s : open count %d", __func__, dev->open_count);
Steven Haigh03270632006-08-09 07:42:06 +1000306
307 /* save device in the file's private structure */
308 file->private_data = dev;
309
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700310 /* initialize in direction */
311 dev->read_buffer_length = 0;
Steven Haigh03270632006-08-09 07:42:06 +1000312
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700313 /* fixup first read by having urb waiting for it */
314 usb_fill_int_urb(dev->interrupt_in_urb,dev->udev,
315 usb_rcvintpipe(dev->udev,
316 dev->interrupt_in_endpoint->bEndpointAddress),
317 dev->interrupt_in_buffer,
318 le16_to_cpu(dev->interrupt_in_endpoint->wMaxPacketSize),
319 adu_interrupt_in_callback, dev,
320 dev->interrupt_in_endpoint->bInterval);
321 dev->read_urb_finished = 0;
322 if (usb_submit_urb(dev->interrupt_in_urb, GFP_KERNEL))
323 dev->read_urb_finished = 1;
324 /* we ignore failure */
325 /* end of fixup for first read */
326
327 /* initialize out direction */
328 dev->out_urb_finished = 1;
329
330 retval = 0;
Steven Haigh03270632006-08-09 07:42:06 +1000331
332exit_no_device:
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700333 mutex_unlock(&adutux_mutex);
334exit_no_lock:
Harvey Harrison441b62c2008-03-03 16:08:34 -0800335 dbg(2,"%s : leave, return value %d ", __func__, retval);
Steven Haigh03270632006-08-09 07:42:06 +1000336 return retval;
337}
338
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700339static void adu_release_internal(struct adu_device *dev)
Steven Haigh03270632006-08-09 07:42:06 +1000340{
Harvey Harrison441b62c2008-03-03 16:08:34 -0800341 dbg(2," %s : enter", __func__);
Steven Haigh03270632006-08-09 07:42:06 +1000342
Steven Haigh03270632006-08-09 07:42:06 +1000343 /* decrement our usage count for the device */
344 --dev->open_count;
Harvey Harrison441b62c2008-03-03 16:08:34 -0800345 dbg(2," %s : open count %d", __func__, dev->open_count);
Steven Haigh03270632006-08-09 07:42:06 +1000346 if (dev->open_count <= 0) {
347 adu_abort_transfers(dev);
348 dev->open_count = 0;
349 }
350
Harvey Harrison441b62c2008-03-03 16:08:34 -0800351 dbg(2," %s : leave", __func__);
Steven Haigh03270632006-08-09 07:42:06 +1000352}
353
354static int adu_release(struct inode *inode, struct file *file)
355{
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700356 struct adu_device *dev;
Steven Haigh03270632006-08-09 07:42:06 +1000357 int retval = 0;
358
Harvey Harrison441b62c2008-03-03 16:08:34 -0800359 dbg(2," %s : enter", __func__);
Steven Haigh03270632006-08-09 07:42:06 +1000360
361 if (file == NULL) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800362 dbg(1," %s : file is NULL", __func__);
Steven Haigh03270632006-08-09 07:42:06 +1000363 retval = -ENODEV;
364 goto exit;
365 }
366
367 dev = file->private_data;
Steven Haigh03270632006-08-09 07:42:06 +1000368 if (dev == NULL) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800369 dbg(1," %s : object is NULL", __func__);
Steven Haigh03270632006-08-09 07:42:06 +1000370 retval = -ENODEV;
371 goto exit;
372 }
373
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700374 mutex_lock(&adutux_mutex); /* not interruptible */
Steven Haigh03270632006-08-09 07:42:06 +1000375
376 if (dev->open_count <= 0) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800377 dbg(1," %s : device not opened", __func__);
Steven Haigh03270632006-08-09 07:42:06 +1000378 retval = -ENODEV;
379 goto exit;
380 }
381
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700382 adu_release_internal(dev);
Alan Sternd4ead162007-05-22 11:46:41 -0400383 if (dev->udev == NULL) {
384 /* the device was unplugged before the file was released */
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700385 if (!dev->open_count) /* ... and we're the last user */
386 adu_delete(dev);
Alan Sternd4ead162007-05-22 11:46:41 -0400387 }
Steven Haigh03270632006-08-09 07:42:06 +1000388
389exit:
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700390 mutex_unlock(&adutux_mutex);
Harvey Harrison441b62c2008-03-03 16:08:34 -0800391 dbg(2," %s : leave, return value %d", __func__, retval);
Steven Haigh03270632006-08-09 07:42:06 +1000392 return retval;
393}
394
395static ssize_t adu_read(struct file *file, __user char *buffer, size_t count,
396 loff_t *ppos)
397{
398 struct adu_device *dev;
399 size_t bytes_read = 0;
400 size_t bytes_to_read = count;
401 int i;
402 int retval = 0;
403 int timeout = 0;
404 int should_submit = 0;
405 unsigned long flags;
406 DECLARE_WAITQUEUE(wait, current);
407
Harvey Harrison441b62c2008-03-03 16:08:34 -0800408 dbg(2," %s : enter, count = %Zd, file=%p", __func__, count, file);
Steven Haigh03270632006-08-09 07:42:06 +1000409
410 dev = file->private_data;
Harvey Harrison441b62c2008-03-03 16:08:34 -0800411 dbg(2," %s : dev=%p", __func__, dev);
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700412
Matthias Kaehlcke8293c562007-07-13 21:28:31 +0200413 if (mutex_lock_interruptible(&dev->mtx))
Steven Haigh03270632006-08-09 07:42:06 +1000414 return -ERESTARTSYS;
415
416 /* verify that the device wasn't unplugged */
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700417 if (dev->udev == NULL) {
Steven Haigh03270632006-08-09 07:42:06 +1000418 retval = -ENODEV;
419 err("No device or device unplugged %d", retval);
420 goto exit;
421 }
422
423 /* verify that some data was requested */
424 if (count == 0) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800425 dbg(1," %s : read request of 0 bytes", __func__);
Steven Haigh03270632006-08-09 07:42:06 +1000426 goto exit;
427 }
428
429 timeout = COMMAND_TIMEOUT;
Harvey Harrison441b62c2008-03-03 16:08:34 -0800430 dbg(2," %s : about to start looping", __func__);
Steven Haigh03270632006-08-09 07:42:06 +1000431 while (bytes_to_read) {
432 int data_in_secondary = dev->secondary_tail - dev->secondary_head;
433 dbg(2," %s : while, data_in_secondary=%d, status=%d",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800434 __func__, data_in_secondary,
Steven Haigh03270632006-08-09 07:42:06 +1000435 dev->interrupt_in_urb->status);
436
437 if (data_in_secondary) {
438 /* drain secondary buffer */
439 int amount = bytes_to_read < data_in_secondary ? bytes_to_read : data_in_secondary;
440 i = copy_to_user(buffer, dev->read_buffer_secondary+dev->secondary_head, amount);
441 if (i < 0) {
442 retval = -EFAULT;
443 goto exit;
444 }
445 dev->secondary_head += (amount - i);
446 bytes_read += (amount - i);
447 bytes_to_read -= (amount - i);
448 if (i) {
449 retval = bytes_read ? bytes_read : -EFAULT;
450 goto exit;
451 }
452 } else {
453 /* we check the primary buffer */
454 spin_lock_irqsave (&dev->buflock, flags);
455 if (dev->read_buffer_length) {
456 /* we secure access to the primary */
457 char *tmp;
458 dbg(2," %s : swap, read_buffer_length = %d",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800459 __func__, dev->read_buffer_length);
Steven Haigh03270632006-08-09 07:42:06 +1000460 tmp = dev->read_buffer_secondary;
461 dev->read_buffer_secondary = dev->read_buffer_primary;
462 dev->read_buffer_primary = tmp;
463 dev->secondary_head = 0;
464 dev->secondary_tail = dev->read_buffer_length;
465 dev->read_buffer_length = 0;
466 spin_unlock_irqrestore(&dev->buflock, flags);
467 /* we have a free buffer so use it */
468 should_submit = 1;
469 } else {
470 /* even the primary was empty - we may need to do IO */
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700471 if (!dev->read_urb_finished) {
Steven Haigh03270632006-08-09 07:42:06 +1000472 /* somebody is doing IO */
473 spin_unlock_irqrestore(&dev->buflock, flags);
Harvey Harrison441b62c2008-03-03 16:08:34 -0800474 dbg(2," %s : submitted already", __func__);
Steven Haigh03270632006-08-09 07:42:06 +1000475 } else {
476 /* we must initiate input */
Harvey Harrison441b62c2008-03-03 16:08:34 -0800477 dbg(2," %s : initiate input", __func__);
Steven Haigh03270632006-08-09 07:42:06 +1000478 dev->read_urb_finished = 0;
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700479 spin_unlock_irqrestore(&dev->buflock, flags);
Steven Haigh03270632006-08-09 07:42:06 +1000480
481 usb_fill_int_urb(dev->interrupt_in_urb,dev->udev,
482 usb_rcvintpipe(dev->udev,
483 dev->interrupt_in_endpoint->bEndpointAddress),
484 dev->interrupt_in_buffer,
485 le16_to_cpu(dev->interrupt_in_endpoint->wMaxPacketSize),
486 adu_interrupt_in_callback,
487 dev,
488 dev->interrupt_in_endpoint->bInterval);
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700489 retval = usb_submit_urb(dev->interrupt_in_urb, GFP_KERNEL);
490 if (retval) {
491 dev->read_urb_finished = 1;
Steven Haigh03270632006-08-09 07:42:06 +1000492 if (retval == -ENOMEM) {
493 retval = bytes_read ? bytes_read : -ENOMEM;
494 }
Harvey Harrison441b62c2008-03-03 16:08:34 -0800495 dbg(2," %s : submit failed", __func__);
Steven Haigh03270632006-08-09 07:42:06 +1000496 goto exit;
497 }
498 }
499
500 /* we wait for I/O to complete */
501 set_current_state(TASK_INTERRUPTIBLE);
502 add_wait_queue(&dev->read_wait, &wait);
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700503 spin_lock_irqsave(&dev->buflock, flags);
504 if (!dev->read_urb_finished) {
505 spin_unlock_irqrestore(&dev->buflock, flags);
Steven Haigh03270632006-08-09 07:42:06 +1000506 timeout = schedule_timeout(COMMAND_TIMEOUT);
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700507 } else {
508 spin_unlock_irqrestore(&dev->buflock, flags);
Steven Haigh03270632006-08-09 07:42:06 +1000509 set_current_state(TASK_RUNNING);
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700510 }
Steven Haigh03270632006-08-09 07:42:06 +1000511 remove_wait_queue(&dev->read_wait, &wait);
512
513 if (timeout <= 0) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800514 dbg(2," %s : timeout", __func__);
Steven Haigh03270632006-08-09 07:42:06 +1000515 retval = bytes_read ? bytes_read : -ETIMEDOUT;
516 goto exit;
517 }
518
519 if (signal_pending(current)) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800520 dbg(2," %s : signal pending", __func__);
Steven Haigh03270632006-08-09 07:42:06 +1000521 retval = bytes_read ? bytes_read : -EINTR;
522 goto exit;
523 }
524 }
525 }
526 }
527
528 retval = bytes_read;
529 /* if the primary buffer is empty then use it */
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700530 spin_lock_irqsave(&dev->buflock, flags);
531 if (should_submit && dev->read_urb_finished) {
532 dev->read_urb_finished = 0;
533 spin_unlock_irqrestore(&dev->buflock, flags);
Steven Haigh03270632006-08-09 07:42:06 +1000534 usb_fill_int_urb(dev->interrupt_in_urb,dev->udev,
535 usb_rcvintpipe(dev->udev,
536 dev->interrupt_in_endpoint->bEndpointAddress),
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700537 dev->interrupt_in_buffer,
538 le16_to_cpu(dev->interrupt_in_endpoint->wMaxPacketSize),
539 adu_interrupt_in_callback,
540 dev,
541 dev->interrupt_in_endpoint->bInterval);
542 if (usb_submit_urb(dev->interrupt_in_urb, GFP_KERNEL) != 0)
543 dev->read_urb_finished = 1;
Steven Haigh03270632006-08-09 07:42:06 +1000544 /* we ignore failure */
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700545 } else {
546 spin_unlock_irqrestore(&dev->buflock, flags);
Steven Haigh03270632006-08-09 07:42:06 +1000547 }
548
549exit:
550 /* unlock the device */
Matthias Kaehlcke8293c562007-07-13 21:28:31 +0200551 mutex_unlock(&dev->mtx);
Steven Haigh03270632006-08-09 07:42:06 +1000552
Harvey Harrison441b62c2008-03-03 16:08:34 -0800553 dbg(2," %s : leave, return value %d", __func__, retval);
Steven Haigh03270632006-08-09 07:42:06 +1000554 return retval;
555}
556
557static ssize_t adu_write(struct file *file, const __user char *buffer,
558 size_t count, loff_t *ppos)
559{
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700560 DECLARE_WAITQUEUE(waita, current);
Steven Haigh03270632006-08-09 07:42:06 +1000561 struct adu_device *dev;
562 size_t bytes_written = 0;
563 size_t bytes_to_write;
564 size_t buffer_size;
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700565 unsigned long flags;
Oliver Neukumebc3ac12007-04-02 15:16:36 +0200566 int retval;
Steven Haigh03270632006-08-09 07:42:06 +1000567
Harvey Harrison441b62c2008-03-03 16:08:34 -0800568 dbg(2," %s : enter, count = %Zd", __func__, count);
Steven Haigh03270632006-08-09 07:42:06 +1000569
570 dev = file->private_data;
571
Matthias Kaehlcke8293c562007-07-13 21:28:31 +0200572 retval = mutex_lock_interruptible(&dev->mtx);
Oliver Neukumebc3ac12007-04-02 15:16:36 +0200573 if (retval)
574 goto exit_nolock;
Steven Haigh03270632006-08-09 07:42:06 +1000575
576 /* verify that the device wasn't unplugged */
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700577 if (dev->udev == NULL) {
Steven Haigh03270632006-08-09 07:42:06 +1000578 retval = -ENODEV;
579 err("No device or device unplugged %d", retval);
580 goto exit;
581 }
582
583 /* verify that we actually have some data to write */
584 if (count == 0) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800585 dbg(1," %s : write request of 0 bytes", __func__);
Steven Haigh03270632006-08-09 07:42:06 +1000586 goto exit;
587 }
588
Steven Haigh03270632006-08-09 07:42:06 +1000589 while (count > 0) {
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700590 add_wait_queue(&dev->write_wait, &waita);
591 set_current_state(TASK_INTERRUPTIBLE);
592 spin_lock_irqsave(&dev->buflock, flags);
593 if (!dev->out_urb_finished) {
594 spin_unlock_irqrestore(&dev->buflock, flags);
Steven Haigh03270632006-08-09 07:42:06 +1000595
Matthias Kaehlcke8293c562007-07-13 21:28:31 +0200596 mutex_unlock(&dev->mtx);
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700597 if (signal_pending(current)) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800598 dbg(1," %s : interrupted", __func__);
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700599 set_current_state(TASK_RUNNING);
600 retval = -EINTR;
601 goto exit_onqueue;
602 }
603 if (schedule_timeout(COMMAND_TIMEOUT) == 0) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800604 dbg(1, "%s - command timed out.", __func__);
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700605 retval = -ETIMEDOUT;
606 goto exit_onqueue;
607 }
608 remove_wait_queue(&dev->write_wait, &waita);
Matthias Kaehlcke8293c562007-07-13 21:28:31 +0200609 retval = mutex_lock_interruptible(&dev->mtx);
Oliver Neukumebc3ac12007-04-02 15:16:36 +0200610 if (retval) {
611 retval = bytes_written ? bytes_written : retval;
612 goto exit_nolock;
613 }
Steven Haigh03270632006-08-09 07:42:06 +1000614
Harvey Harrison441b62c2008-03-03 16:08:34 -0800615 dbg(4," %s : in progress, count = %Zd", __func__, count);
Steven Haigh03270632006-08-09 07:42:06 +1000616 } else {
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700617 spin_unlock_irqrestore(&dev->buflock, flags);
618 set_current_state(TASK_RUNNING);
619 remove_wait_queue(&dev->write_wait, &waita);
Harvey Harrison441b62c2008-03-03 16:08:34 -0800620 dbg(4," %s : sending, count = %Zd", __func__, count);
Steven Haigh03270632006-08-09 07:42:06 +1000621
622 /* write the data into interrupt_out_buffer from userspace */
623 buffer_size = le16_to_cpu(dev->interrupt_out_endpoint->wMaxPacketSize);
624 bytes_to_write = count > buffer_size ? buffer_size : count;
625 dbg(4," %s : buffer_size = %Zd, count = %Zd, bytes_to_write = %Zd",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800626 __func__, buffer_size, count, bytes_to_write);
Steven Haigh03270632006-08-09 07:42:06 +1000627
628 if (copy_from_user(dev->interrupt_out_buffer, buffer, bytes_to_write) != 0) {
629 retval = -EFAULT;
630 goto exit;
631 }
632
633 /* send off the urb */
634 usb_fill_int_urb(
635 dev->interrupt_out_urb,
636 dev->udev,
637 usb_sndintpipe(dev->udev, dev->interrupt_out_endpoint->bEndpointAddress),
638 dev->interrupt_out_buffer,
639 bytes_to_write,
640 adu_interrupt_out_callback,
641 dev,
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700642 dev->interrupt_out_endpoint->bInterval);
Steven Haigh03270632006-08-09 07:42:06 +1000643 dev->interrupt_out_urb->actual_length = bytes_to_write;
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700644 dev->out_urb_finished = 0;
Steven Haigh03270632006-08-09 07:42:06 +1000645 retval = usb_submit_urb(dev->interrupt_out_urb, GFP_KERNEL);
646 if (retval < 0) {
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700647 dev->out_urb_finished = 1;
Steven Haigh03270632006-08-09 07:42:06 +1000648 err("Couldn't submit interrupt_out_urb %d", retval);
649 goto exit;
650 }
651
652 buffer += bytes_to_write;
653 count -= bytes_to_write;
654
655 bytes_written += bytes_to_write;
656 }
657 }
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700658 mutex_unlock(&dev->mtx);
659 return bytes_written;
Steven Haigh03270632006-08-09 07:42:06 +1000660
661exit:
Matthias Kaehlcke8293c562007-07-13 21:28:31 +0200662 mutex_unlock(&dev->mtx);
Oliver Neukumebc3ac12007-04-02 15:16:36 +0200663exit_nolock:
Harvey Harrison441b62c2008-03-03 16:08:34 -0800664 dbg(2," %s : leave, return value %d", __func__, retval);
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700665 return retval;
Steven Haigh03270632006-08-09 07:42:06 +1000666
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700667exit_onqueue:
668 remove_wait_queue(&dev->write_wait, &waita);
Steven Haigh03270632006-08-09 07:42:06 +1000669 return retval;
670}
671
672/* file operations needed when we register this driver */
Arjan van de Ven00977a52007-02-12 00:55:34 -0800673static const struct file_operations adu_fops = {
Steven Haigh03270632006-08-09 07:42:06 +1000674 .owner = THIS_MODULE,
675 .read = adu_read,
676 .write = adu_write,
677 .open = adu_open,
678 .release = adu_release,
679};
680
681/*
682 * usb class driver info in order to get a minor number from the usb core,
683 * and to have the device registered with devfs and the driver core
684 */
685static struct usb_class_driver adu_class = {
686 .name = "usb/adutux%d",
687 .fops = &adu_fops,
688 .minor_base = ADU_MINOR_BASE,
689};
690
691/**
692 * adu_probe
693 *
694 * Called by the usb core when a new device is connected that it thinks
695 * this driver might be interested in.
696 */
697static int adu_probe(struct usb_interface *interface,
698 const struct usb_device_id *id)
699{
700 struct usb_device *udev = interface_to_usbdev(interface);
701 struct adu_device *dev = NULL;
702 struct usb_host_interface *iface_desc;
703 struct usb_endpoint_descriptor *endpoint;
704 int retval = -ENODEV;
705 int in_end_size;
706 int out_end_size;
707 int i;
708
Harvey Harrison441b62c2008-03-03 16:08:34 -0800709 dbg(2," %s : enter", __func__);
Steven Haigh03270632006-08-09 07:42:06 +1000710
711 if (udev == NULL) {
712 dev_err(&interface->dev, "udev is NULL.\n");
713 goto exit;
714 }
715
716 /* allocate memory for our device state and intialize it */
717 dev = kzalloc(sizeof(struct adu_device), GFP_KERNEL);
718 if (dev == NULL) {
719 dev_err(&interface->dev, "Out of memory\n");
720 retval = -ENOMEM;
721 goto exit;
722 }
723
Matthias Kaehlcke8293c562007-07-13 21:28:31 +0200724 mutex_init(&dev->mtx);
Steven Haigh03270632006-08-09 07:42:06 +1000725 spin_lock_init(&dev->buflock);
726 dev->udev = udev;
727 init_waitqueue_head(&dev->read_wait);
728 init_waitqueue_head(&dev->write_wait);
729
730 iface_desc = &interface->altsetting[0];
731
732 /* set up the endpoint information */
733 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
734 endpoint = &iface_desc->endpoint[i].desc;
735
736 if (usb_endpoint_is_int_in(endpoint))
737 dev->interrupt_in_endpoint = endpoint;
738
739 if (usb_endpoint_is_int_out(endpoint))
740 dev->interrupt_out_endpoint = endpoint;
741 }
742 if (dev->interrupt_in_endpoint == NULL) {
743 dev_err(&interface->dev, "interrupt in endpoint not found\n");
744 goto error;
745 }
746 if (dev->interrupt_out_endpoint == NULL) {
747 dev_err(&interface->dev, "interrupt out endpoint not found\n");
748 goto error;
749 }
750
751 in_end_size = le16_to_cpu(dev->interrupt_in_endpoint->wMaxPacketSize);
752 out_end_size = le16_to_cpu(dev->interrupt_out_endpoint->wMaxPacketSize);
753
754 dev->read_buffer_primary = kmalloc((4 * in_end_size), GFP_KERNEL);
755 if (!dev->read_buffer_primary) {
756 dev_err(&interface->dev, "Couldn't allocate read_buffer_primary\n");
757 retval = -ENOMEM;
758 goto error;
759 }
760
761 /* debug code prime the buffer */
762 memset(dev->read_buffer_primary, 'a', in_end_size);
763 memset(dev->read_buffer_primary + in_end_size, 'b', in_end_size);
764 memset(dev->read_buffer_primary + (2 * in_end_size), 'c', in_end_size);
765 memset(dev->read_buffer_primary + (3 * in_end_size), 'd', in_end_size);
766
767 dev->read_buffer_secondary = kmalloc((4 * in_end_size), GFP_KERNEL);
768 if (!dev->read_buffer_secondary) {
769 dev_err(&interface->dev, "Couldn't allocate read_buffer_secondary\n");
770 retval = -ENOMEM;
771 goto error;
772 }
773
774 /* debug code prime the buffer */
775 memset(dev->read_buffer_secondary, 'e', in_end_size);
776 memset(dev->read_buffer_secondary + in_end_size, 'f', in_end_size);
777 memset(dev->read_buffer_secondary + (2 * in_end_size), 'g', in_end_size);
778 memset(dev->read_buffer_secondary + (3 * in_end_size), 'h', in_end_size);
779
780 dev->interrupt_in_buffer = kmalloc(in_end_size, GFP_KERNEL);
781 if (!dev->interrupt_in_buffer) {
782 dev_err(&interface->dev, "Couldn't allocate interrupt_in_buffer\n");
783 goto error;
784 }
785
786 /* debug code prime the buffer */
787 memset(dev->interrupt_in_buffer, 'i', in_end_size);
788
789 dev->interrupt_in_urb = usb_alloc_urb(0, GFP_KERNEL);
790 if (!dev->interrupt_in_urb) {
791 dev_err(&interface->dev, "Couldn't allocate interrupt_in_urb\n");
792 goto error;
793 }
794 dev->interrupt_out_buffer = kmalloc(out_end_size, GFP_KERNEL);
795 if (!dev->interrupt_out_buffer) {
796 dev_err(&interface->dev, "Couldn't allocate interrupt_out_buffer\n");
797 goto error;
798 }
799 dev->interrupt_out_urb = usb_alloc_urb(0, GFP_KERNEL);
800 if (!dev->interrupt_out_urb) {
801 dev_err(&interface->dev, "Couldn't allocate interrupt_out_urb\n");
802 goto error;
803 }
804
805 if (!usb_string(udev, udev->descriptor.iSerialNumber, dev->serial_number,
806 sizeof(dev->serial_number))) {
807 dev_err(&interface->dev, "Could not retrieve serial number\n");
808 goto error;
809 }
Harvey Harrison441b62c2008-03-03 16:08:34 -0800810 dbg(2," %s : serial_number=%s", __func__, dev->serial_number);
Steven Haigh03270632006-08-09 07:42:06 +1000811
812 /* we can register the device now, as it is ready */
813 usb_set_intfdata(interface, dev);
814
815 retval = usb_register_dev(interface, &adu_class);
816
817 if (retval) {
818 /* something prevented us from registering this driver */
819 dev_err(&interface->dev, "Not able to get a minor for this device.\n");
820 usb_set_intfdata(interface, NULL);
821 goto error;
822 }
823
824 dev->minor = interface->minor;
825
826 /* let the user know what node this device is now attached to */
Joe Perches898eb712007-10-18 03:06:30 -0700827 dev_info(&interface->dev, "ADU%d %s now attached to /dev/usb/adutux%d\n",
Steven Haigh03270632006-08-09 07:42:06 +1000828 udev->descriptor.idProduct, dev->serial_number,
829 (dev->minor - ADU_MINOR_BASE));
830exit:
Harvey Harrison441b62c2008-03-03 16:08:34 -0800831 dbg(2," %s : leave, return value %p (dev)", __func__, dev);
Steven Haigh03270632006-08-09 07:42:06 +1000832
833 return retval;
834
835error:
836 adu_delete(dev);
837 return retval;
838}
839
840/**
841 * adu_disconnect
842 *
843 * Called by the usb core when the device is removed from the system.
844 */
845static void adu_disconnect(struct usb_interface *interface)
846{
847 struct adu_device *dev;
848 int minor;
849
Harvey Harrison441b62c2008-03-03 16:08:34 -0800850 dbg(2," %s : enter", __func__);
Steven Haigh03270632006-08-09 07:42:06 +1000851
Steven Haigh03270632006-08-09 07:42:06 +1000852 dev = usb_get_intfdata(interface);
Steven Haigh03270632006-08-09 07:42:06 +1000853
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700854 mutex_lock(&dev->mtx); /* not interruptible */
855 dev->udev = NULL; /* poison */
Steven Haigh03270632006-08-09 07:42:06 +1000856 minor = dev->minor;
Steven Haigh03270632006-08-09 07:42:06 +1000857 usb_deregister_dev(interface, &adu_class);
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700858 mutex_unlock(&dev->mtx);
Steven Haigh03270632006-08-09 07:42:06 +1000859
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700860 mutex_lock(&adutux_mutex);
861 usb_set_intfdata(interface, NULL);
Alan Sternd4ead162007-05-22 11:46:41 -0400862
Steven Haigh03270632006-08-09 07:42:06 +1000863 /* if the device is not opened, then we clean up right now */
Harvey Harrison441b62c2008-03-03 16:08:34 -0800864 dbg(2," %s : open count %d", __func__, dev->open_count);
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700865 if (!dev->open_count)
Steven Haigh03270632006-08-09 07:42:06 +1000866 adu_delete(dev);
Pete Zaitcevf08812d2007-10-31 15:59:30 -0700867
868 mutex_unlock(&adutux_mutex);
Steven Haigh03270632006-08-09 07:42:06 +1000869
Joe Perches898eb712007-10-18 03:06:30 -0700870 dev_info(&interface->dev, "ADU device adutux%d now disconnected\n",
Steven Haigh03270632006-08-09 07:42:06 +1000871 (minor - ADU_MINOR_BASE));
872
Harvey Harrison441b62c2008-03-03 16:08:34 -0800873 dbg(2," %s : leave", __func__);
Steven Haigh03270632006-08-09 07:42:06 +1000874}
875
876/* usb specific object needed to register this driver with the usb subsystem */
877static struct usb_driver adu_driver = {
878 .name = "adutux",
879 .probe = adu_probe,
880 .disconnect = adu_disconnect,
881 .id_table = device_table,
882};
883
884static int __init adu_init(void)
885{
886 int result;
887
Harvey Harrison441b62c2008-03-03 16:08:34 -0800888 dbg(2," %s : enter", __func__);
Steven Haigh03270632006-08-09 07:42:06 +1000889
890 /* register this driver with the USB subsystem */
891 result = usb_register(&adu_driver);
892 if (result < 0) {
893 err("usb_register failed for the "__FILE__" driver. "
894 "Error number %d", result);
895 goto exit;
896 }
897
898 info("adutux " DRIVER_DESC " " DRIVER_VERSION);
899 info("adutux is an experimental driver. Use at your own risk");
900
901exit:
Harvey Harrison441b62c2008-03-03 16:08:34 -0800902 dbg(2," %s : leave, return value %d", __func__, result);
Steven Haigh03270632006-08-09 07:42:06 +1000903
904 return result;
905}
906
907static void __exit adu_exit(void)
908{
Harvey Harrison441b62c2008-03-03 16:08:34 -0800909 dbg(2," %s : enter", __func__);
Steven Haigh03270632006-08-09 07:42:06 +1000910 /* deregister this driver with the USB subsystem */
911 usb_deregister(&adu_driver);
Harvey Harrison441b62c2008-03-03 16:08:34 -0800912 dbg(2," %s : leave", __func__);
Steven Haigh03270632006-08-09 07:42:06 +1000913}
914
915module_init(adu_init);
916module_exit(adu_exit);
917
918MODULE_AUTHOR(DRIVER_AUTHOR);
919MODULE_DESCRIPTION(DRIVER_DESC);
920MODULE_LICENSE("GPL");