• Home
  • History
  • Annotate
  • Line#
  • Navigate
  • Raw
  • Download
  • only in /asuswrt-rt-n18u-9.0.0.4.380.2695/release/src-rt-6.x.4708/linux/linux-2.6.36/drivers/usb/misc/
1/*
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>
27#include <linux/mutex.h>
28#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 "%s: " format "\n", __FILE__, ##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 const 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
82/*
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
92/* Structure to hold all of our device specific stuff */
93struct adu_device {
94	struct mutex		mtx;
95	struct usb_device*	udev; /* save off the usb device pointer */
96	struct usb_interface*	interface;
97	unsigned int		minor; /* the starting minor number for this device */
98	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;
120	int			out_urb_finished;
121};
122
123static DEFINE_MUTEX(adutux_mutex);
124
125static 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 "%s: %s - length = %d, data = ",
136	       __FILE__, 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{
148	unsigned long flags;
149
150	dbg(2," %s : enter", __func__);
151
152	if (dev->udev == NULL) {
153		dbg(1," %s : udev is null", __func__);
154		goto exit;
155	}
156
157	/* shutdown transfer */
158
159	spin_lock_irqsave(&dev->buflock, flags);
160	if (!dev->read_urb_finished) {
161		spin_unlock_irqrestore(&dev->buflock, flags);
162		usb_kill_urb(dev->interrupt_in_urb);
163	} else
164		spin_unlock_irqrestore(&dev->buflock, flags);
165
166	spin_lock_irqsave(&dev->buflock, flags);
167	if (!dev->out_urb_finished) {
168		spin_unlock_irqrestore(&dev->buflock, flags);
169		usb_kill_urb(dev->interrupt_out_urb);
170	} else
171		spin_unlock_irqrestore(&dev->buflock, flags);
172
173exit:
174	dbg(2," %s : leave", __func__);
175}
176
177static void adu_delete(struct adu_device *dev)
178{
179	dbg(2, "%s enter", __func__);
180
181	/* free data structures */
182	usb_free_urb(dev->interrupt_in_urb);
183	usb_free_urb(dev->interrupt_out_urb);
184	kfree(dev->read_buffer_primary);
185	kfree(dev->read_buffer_secondary);
186	kfree(dev->interrupt_in_buffer);
187	kfree(dev->interrupt_out_buffer);
188	kfree(dev);
189
190	dbg(2, "%s : leave", __func__);
191}
192
193static void adu_interrupt_in_callback(struct urb *urb)
194{
195	struct adu_device *dev = urb->context;
196	int status = urb->status;
197
198	dbg(4," %s : enter, status %d", __func__, status);
199	adu_debug_data(5, __func__, urb->actual_length,
200		       urb->transfer_buffer);
201
202	spin_lock(&dev->buflock);
203
204	if (status != 0) {
205		if ((status != -ENOENT) && (status != -ECONNRESET) &&
206			(status != -ESHUTDOWN)) {
207			dbg(1," %s : nonzero status received: %d",
208			    __func__, status);
209		}
210		goto exit;
211	}
212
213	if (urb->actual_length > 0 && dev->interrupt_in_buffer[0] != 0x00) {
214		if (dev->read_buffer_length <
215		    (4 * le16_to_cpu(dev->interrupt_in_endpoint->wMaxPacketSize)) -
216		     (urb->actual_length)) {
217			memcpy (dev->read_buffer_primary +
218				dev->read_buffer_length,
219				dev->interrupt_in_buffer, urb->actual_length);
220
221			dev->read_buffer_length += urb->actual_length;
222			dbg(2," %s reading  %d ", __func__,
223			    urb->actual_length);
224		} else {
225			dbg(1," %s : read_buffer overflow", __func__);
226		}
227	}
228
229exit:
230	dev->read_urb_finished = 1;
231	spin_unlock(&dev->buflock);
232	/* always wake up so we recover from errors */
233	wake_up_interruptible(&dev->read_wait);
234	adu_debug_data(5, __func__, urb->actual_length,
235		       urb->transfer_buffer);
236	dbg(4," %s : leave, status %d", __func__, status);
237}
238
239static void adu_interrupt_out_callback(struct urb *urb)
240{
241	struct adu_device *dev = urb->context;
242	int status = urb->status;
243
244	dbg(4," %s : enter, status %d", __func__, status);
245	adu_debug_data(5,__func__, urb->actual_length, urb->transfer_buffer);
246
247	if (status != 0) {
248		if ((status != -ENOENT) &&
249		    (status != -ECONNRESET)) {
250			dbg(1, " %s :nonzero status received: %d",
251			    __func__, status);
252		}
253		goto exit;
254	}
255
256	spin_lock(&dev->buflock);
257	dev->out_urb_finished = 1;
258	wake_up(&dev->write_wait);
259	spin_unlock(&dev->buflock);
260exit:
261
262	adu_debug_data(5, __func__, urb->actual_length,
263		       urb->transfer_buffer);
264	dbg(4," %s : leave, status %d", __func__, status);
265}
266
267static int adu_open(struct inode *inode, struct file *file)
268{
269	struct adu_device *dev = NULL;
270	struct usb_interface *interface;
271	int subminor;
272	int retval;
273
274	dbg(2,"%s : enter", __func__);
275
276	subminor = iminor(inode);
277
278	if ((retval = mutex_lock_interruptible(&adutux_mutex))) {
279		dbg(2, "%s : mutex lock failed", __func__);
280		goto exit_no_lock;
281	}
282
283	interface = usb_find_interface(&adu_driver, subminor);
284	if (!interface) {
285		printk(KERN_ERR "adutux: %s - error, can't find device for "
286		       "minor %d\n", __func__, subminor);
287		retval = -ENODEV;
288		goto exit_no_device;
289	}
290
291	dev = usb_get_intfdata(interface);
292	if (!dev || !dev->udev) {
293		retval = -ENODEV;
294		goto exit_no_device;
295	}
296
297	/* check that nobody else is using the device */
298	if (dev->open_count) {
299		retval = -EBUSY;
300		goto exit_no_device;
301	}
302
303	++dev->open_count;
304	dbg(2,"%s : open count %d", __func__, dev->open_count);
305
306	/* save device in the file's private structure */
307	file->private_data = dev;
308
309	/* initialize in direction */
310	dev->read_buffer_length = 0;
311
312	/* fixup first read by having urb waiting for it */
313	usb_fill_int_urb(dev->interrupt_in_urb,dev->udev,
314			 usb_rcvintpipe(dev->udev,
315					dev->interrupt_in_endpoint->bEndpointAddress),
316			 dev->interrupt_in_buffer,
317			 le16_to_cpu(dev->interrupt_in_endpoint->wMaxPacketSize),
318			 adu_interrupt_in_callback, dev,
319			 dev->interrupt_in_endpoint->bInterval);
320	dev->read_urb_finished = 0;
321	if (usb_submit_urb(dev->interrupt_in_urb, GFP_KERNEL))
322		dev->read_urb_finished = 1;
323	/* we ignore failure */
324	/* end of fixup for first read */
325
326	/* initialize out direction */
327	dev->out_urb_finished = 1;
328
329	retval = 0;
330
331exit_no_device:
332	mutex_unlock(&adutux_mutex);
333exit_no_lock:
334	dbg(2,"%s : leave, return value %d ", __func__, retval);
335	return retval;
336}
337
338static void adu_release_internal(struct adu_device *dev)
339{
340	dbg(2," %s : enter", __func__);
341
342	/* decrement our usage count for the device */
343	--dev->open_count;
344	dbg(2," %s : open count %d", __func__, dev->open_count);
345	if (dev->open_count <= 0) {
346		adu_abort_transfers(dev);
347		dev->open_count = 0;
348	}
349
350	dbg(2," %s : leave", __func__);
351}
352
353static int adu_release(struct inode *inode, struct file *file)
354{
355	struct adu_device *dev;
356	int retval = 0;
357
358	dbg(2," %s : enter", __func__);
359
360	if (file == NULL) {
361 		dbg(1," %s : file is NULL", __func__);
362		retval = -ENODEV;
363		goto exit;
364	}
365
366	dev = file->private_data;
367	if (dev == NULL) {
368 		dbg(1," %s : object is NULL", __func__);
369		retval = -ENODEV;
370		goto exit;
371	}
372
373	mutex_lock(&adutux_mutex); /* not interruptible */
374
375	if (dev->open_count <= 0) {
376		dbg(1," %s : device not opened", __func__);
377		retval = -ENODEV;
378		goto unlock;
379	}
380
381	adu_release_internal(dev);
382	if (dev->udev == NULL) {
383		/* the device was unplugged before the file was released */
384		if (!dev->open_count)	/* ... and we're the last user */
385			adu_delete(dev);
386	}
387unlock:
388	mutex_unlock(&adutux_mutex);
389exit:
390	dbg(2," %s : leave, return value %d", __func__, retval);
391	return retval;
392}
393
394static ssize_t adu_read(struct file *file, __user char *buffer, size_t count,
395			loff_t *ppos)
396{
397	struct adu_device *dev;
398	size_t bytes_read = 0;
399	size_t bytes_to_read = count;
400	int i;
401	int retval = 0;
402	int timeout = 0;
403	int should_submit = 0;
404	unsigned long flags;
405	DECLARE_WAITQUEUE(wait, current);
406
407	dbg(2," %s : enter, count = %Zd, file=%p", __func__, count, file);
408
409	dev = file->private_data;
410	dbg(2," %s : dev=%p", __func__, dev);
411
412	if (mutex_lock_interruptible(&dev->mtx))
413		return -ERESTARTSYS;
414
415	/* verify that the device wasn't unplugged */
416	if (dev->udev == NULL) {
417		retval = -ENODEV;
418		printk(KERN_ERR "adutux: No device or device unplugged %d\n",
419		       retval);
420		goto exit;
421	}
422
423	/* verify that some data was requested */
424	if (count == 0) {
425		dbg(1," %s : read request of 0 bytes", __func__);
426		goto exit;
427	}
428
429	timeout = COMMAND_TIMEOUT;
430	dbg(2," %s : about to start looping", __func__);
431	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",
434		    __func__, data_in_secondary,
435		    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) {
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",
459				    __func__, dev->read_buffer_length);
460				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 */
471				if (!dev->read_urb_finished) {
472					/* somebody is doing IO */
473					spin_unlock_irqrestore(&dev->buflock, flags);
474					dbg(2," %s : submitted already", __func__);
475				} else {
476					/* we must initiate input */
477					dbg(2," %s : initiate input", __func__);
478					dev->read_urb_finished = 0;
479					spin_unlock_irqrestore(&dev->buflock, flags);
480
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);
489					retval = usb_submit_urb(dev->interrupt_in_urb, GFP_KERNEL);
490					if (retval) {
491						dev->read_urb_finished = 1;
492						if (retval == -ENOMEM) {
493							retval = bytes_read ? bytes_read : -ENOMEM;
494						}
495						dbg(2," %s : submit failed", __func__);
496						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);
503				spin_lock_irqsave(&dev->buflock, flags);
504				if (!dev->read_urb_finished) {
505					spin_unlock_irqrestore(&dev->buflock, flags);
506					timeout = schedule_timeout(COMMAND_TIMEOUT);
507				} else {
508					spin_unlock_irqrestore(&dev->buflock, flags);
509					set_current_state(TASK_RUNNING);
510				}
511				remove_wait_queue(&dev->read_wait, &wait);
512
513				if (timeout <= 0) {
514					dbg(2," %s : timeout", __func__);
515					retval = bytes_read ? bytes_read : -ETIMEDOUT;
516					goto exit;
517				}
518
519				if (signal_pending(current)) {
520					dbg(2," %s : signal pending", __func__);
521					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 */
530	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);
534		usb_fill_int_urb(dev->interrupt_in_urb,dev->udev,
535				 usb_rcvintpipe(dev->udev,
536				 		dev->interrupt_in_endpoint->bEndpointAddress),
537				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;
544		/* we ignore failure */
545	} else {
546		spin_unlock_irqrestore(&dev->buflock, flags);
547	}
548
549exit:
550	/* unlock the device */
551	mutex_unlock(&dev->mtx);
552
553	dbg(2," %s : leave, return value %d", __func__, retval);
554	return retval;
555}
556
557static ssize_t adu_write(struct file *file, const __user char *buffer,
558			 size_t count, loff_t *ppos)
559{
560	DECLARE_WAITQUEUE(waita, current);
561	struct adu_device *dev;
562	size_t bytes_written = 0;
563	size_t bytes_to_write;
564	size_t buffer_size;
565	unsigned long flags;
566	int retval;
567
568	dbg(2," %s : enter, count = %Zd", __func__, count);
569
570	dev = file->private_data;
571
572	retval = mutex_lock_interruptible(&dev->mtx);
573	if (retval)
574		goto exit_nolock;
575
576	/* verify that the device wasn't unplugged */
577	if (dev->udev == NULL) {
578		retval = -ENODEV;
579		printk(KERN_ERR "adutux: No device or device unplugged %d\n",
580		       retval);
581		goto exit;
582	}
583
584	/* verify that we actually have some data to write */
585	if (count == 0) {
586		dbg(1," %s : write request of 0 bytes", __func__);
587		goto exit;
588	}
589
590	while (count > 0) {
591		add_wait_queue(&dev->write_wait, &waita);
592		set_current_state(TASK_INTERRUPTIBLE);
593		spin_lock_irqsave(&dev->buflock, flags);
594		if (!dev->out_urb_finished) {
595			spin_unlock_irqrestore(&dev->buflock, flags);
596
597			mutex_unlock(&dev->mtx);
598			if (signal_pending(current)) {
599				dbg(1," %s : interrupted", __func__);
600				set_current_state(TASK_RUNNING);
601				retval = -EINTR;
602				goto exit_onqueue;
603			}
604			if (schedule_timeout(COMMAND_TIMEOUT) == 0) {
605				dbg(1, "%s - command timed out.", __func__);
606				retval = -ETIMEDOUT;
607				goto exit_onqueue;
608			}
609			remove_wait_queue(&dev->write_wait, &waita);
610			retval = mutex_lock_interruptible(&dev->mtx);
611			if (retval) {
612				retval = bytes_written ? bytes_written : retval;
613				goto exit_nolock;
614			}
615
616			dbg(4," %s : in progress, count = %Zd", __func__, count);
617		} else {
618			spin_unlock_irqrestore(&dev->buflock, flags);
619			set_current_state(TASK_RUNNING);
620			remove_wait_queue(&dev->write_wait, &waita);
621			dbg(4," %s : sending, count = %Zd", __func__, count);
622
623			/* write the data into interrupt_out_buffer from userspace */
624			buffer_size = le16_to_cpu(dev->interrupt_out_endpoint->wMaxPacketSize);
625			bytes_to_write = count > buffer_size ? buffer_size : count;
626			dbg(4," %s : buffer_size = %Zd, count = %Zd, bytes_to_write = %Zd",
627			    __func__, buffer_size, count, bytes_to_write);
628
629			if (copy_from_user(dev->interrupt_out_buffer, buffer, bytes_to_write) != 0) {
630				retval = -EFAULT;
631				goto exit;
632			}
633
634			/* send off the urb */
635			usb_fill_int_urb(
636				dev->interrupt_out_urb,
637				dev->udev,
638				usb_sndintpipe(dev->udev, dev->interrupt_out_endpoint->bEndpointAddress),
639				dev->interrupt_out_buffer,
640				bytes_to_write,
641				adu_interrupt_out_callback,
642				dev,
643				dev->interrupt_out_endpoint->bInterval);
644			dev->interrupt_out_urb->actual_length = bytes_to_write;
645			dev->out_urb_finished = 0;
646			retval = usb_submit_urb(dev->interrupt_out_urb, GFP_KERNEL);
647			if (retval < 0) {
648				dev->out_urb_finished = 1;
649				dev_err(&dev->udev->dev, "Couldn't submit "
650					"interrupt_out_urb %d\n", retval);
651				goto exit;
652			}
653
654			buffer += bytes_to_write;
655			count -= bytes_to_write;
656
657			bytes_written += bytes_to_write;
658		}
659	}
660	mutex_unlock(&dev->mtx);
661	return bytes_written;
662
663exit:
664	mutex_unlock(&dev->mtx);
665exit_nolock:
666	dbg(2," %s : leave, return value %d", __func__, retval);
667	return retval;
668
669exit_onqueue:
670	remove_wait_queue(&dev->write_wait, &waita);
671	return retval;
672}
673
674/* file operations needed when we register this driver */
675static const struct file_operations adu_fops = {
676	.owner = THIS_MODULE,
677	.read  = adu_read,
678	.write = adu_write,
679	.open = adu_open,
680	.release = adu_release,
681};
682
683/*
684 * usb class driver info in order to get a minor number from the usb core,
685 * and to have the device registered with devfs and the driver core
686 */
687static struct usb_class_driver adu_class = {
688	.name = "usb/adutux%d",
689	.fops = &adu_fops,
690	.minor_base = ADU_MINOR_BASE,
691};
692
693/**
694 * adu_probe
695 *
696 * Called by the usb core when a new device is connected that it thinks
697 * this driver might be interested in.
698 */
699static int adu_probe(struct usb_interface *interface,
700		     const struct usb_device_id *id)
701{
702	struct usb_device *udev = interface_to_usbdev(interface);
703	struct adu_device *dev = NULL;
704	struct usb_host_interface *iface_desc;
705	struct usb_endpoint_descriptor *endpoint;
706	int retval = -ENODEV;
707	int in_end_size;
708	int out_end_size;
709	int i;
710
711	dbg(2," %s : enter", __func__);
712
713	if (udev == NULL) {
714		dev_err(&interface->dev, "udev is NULL.\n");
715		goto exit;
716	}
717
718	/* allocate memory for our device state and intialize it */
719	dev = kzalloc(sizeof(struct adu_device), GFP_KERNEL);
720	if (dev == NULL) {
721		dev_err(&interface->dev, "Out of memory\n");
722		retval = -ENOMEM;
723		goto exit;
724	}
725
726	mutex_init(&dev->mtx);
727	spin_lock_init(&dev->buflock);
728	dev->udev = udev;
729	init_waitqueue_head(&dev->read_wait);
730	init_waitqueue_head(&dev->write_wait);
731
732	iface_desc = &interface->altsetting[0];
733
734	/* set up the endpoint information */
735	for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
736		endpoint = &iface_desc->endpoint[i].desc;
737
738		if (usb_endpoint_is_int_in(endpoint))
739			dev->interrupt_in_endpoint = endpoint;
740
741		if (usb_endpoint_is_int_out(endpoint))
742			dev->interrupt_out_endpoint = endpoint;
743	}
744	if (dev->interrupt_in_endpoint == NULL) {
745		dev_err(&interface->dev, "interrupt in endpoint not found\n");
746		goto error;
747	}
748	if (dev->interrupt_out_endpoint == NULL) {
749		dev_err(&interface->dev, "interrupt out endpoint not found\n");
750		goto error;
751	}
752
753	in_end_size = le16_to_cpu(dev->interrupt_in_endpoint->wMaxPacketSize);
754	out_end_size = le16_to_cpu(dev->interrupt_out_endpoint->wMaxPacketSize);
755
756	dev->read_buffer_primary = kmalloc((4 * in_end_size), GFP_KERNEL);
757	if (!dev->read_buffer_primary) {
758		dev_err(&interface->dev, "Couldn't allocate read_buffer_primary\n");
759		retval = -ENOMEM;
760		goto error;
761	}
762
763	/* debug code prime the buffer */
764	memset(dev->read_buffer_primary, 'a', in_end_size);
765	memset(dev->read_buffer_primary + in_end_size, 'b', in_end_size);
766	memset(dev->read_buffer_primary + (2 * in_end_size), 'c', in_end_size);
767	memset(dev->read_buffer_primary + (3 * in_end_size), 'd', in_end_size);
768
769	dev->read_buffer_secondary = kmalloc((4 * in_end_size), GFP_KERNEL);
770	if (!dev->read_buffer_secondary) {
771		dev_err(&interface->dev, "Couldn't allocate read_buffer_secondary\n");
772		retval = -ENOMEM;
773		goto error;
774	}
775
776	/* debug code prime the buffer */
777	memset(dev->read_buffer_secondary, 'e', in_end_size);
778	memset(dev->read_buffer_secondary + in_end_size, 'f', in_end_size);
779	memset(dev->read_buffer_secondary + (2 * in_end_size), 'g', in_end_size);
780	memset(dev->read_buffer_secondary + (3 * in_end_size), 'h', in_end_size);
781
782	dev->interrupt_in_buffer = kmalloc(in_end_size, GFP_KERNEL);
783	if (!dev->interrupt_in_buffer) {
784		dev_err(&interface->dev, "Couldn't allocate interrupt_in_buffer\n");
785		goto error;
786	}
787
788	/* debug code prime the buffer */
789	memset(dev->interrupt_in_buffer, 'i', in_end_size);
790
791	dev->interrupt_in_urb = usb_alloc_urb(0, GFP_KERNEL);
792	if (!dev->interrupt_in_urb) {
793		dev_err(&interface->dev, "Couldn't allocate interrupt_in_urb\n");
794		goto error;
795	}
796	dev->interrupt_out_buffer = kmalloc(out_end_size, GFP_KERNEL);
797	if (!dev->interrupt_out_buffer) {
798		dev_err(&interface->dev, "Couldn't allocate interrupt_out_buffer\n");
799		goto error;
800	}
801	dev->interrupt_out_urb = usb_alloc_urb(0, GFP_KERNEL);
802	if (!dev->interrupt_out_urb) {
803		dev_err(&interface->dev, "Couldn't allocate interrupt_out_urb\n");
804		goto error;
805	}
806
807	if (!usb_string(udev, udev->descriptor.iSerialNumber, dev->serial_number,
808			sizeof(dev->serial_number))) {
809		dev_err(&interface->dev, "Could not retrieve serial number\n");
810		goto error;
811	}
812	dbg(2," %s : serial_number=%s", __func__, dev->serial_number);
813
814	/* we can register the device now, as it is ready */
815	usb_set_intfdata(interface, dev);
816
817	retval = usb_register_dev(interface, &adu_class);
818
819	if (retval) {
820		/* something prevented us from registering this driver */
821		dev_err(&interface->dev, "Not able to get a minor for this device.\n");
822		usb_set_intfdata(interface, NULL);
823		goto error;
824	}
825
826	dev->minor = interface->minor;
827
828	/* let the user know what node this device is now attached to */
829	dev_info(&interface->dev, "ADU%d %s now attached to /dev/usb/adutux%d\n",
830		 udev->descriptor.idProduct, dev->serial_number,
831		 (dev->minor - ADU_MINOR_BASE));
832exit:
833	dbg(2," %s : leave, return value %p (dev)", __func__, dev);
834
835	return retval;
836
837error:
838	adu_delete(dev);
839	return retval;
840}
841
842/**
843 * adu_disconnect
844 *
845 * Called by the usb core when the device is removed from the system.
846 */
847static void adu_disconnect(struct usb_interface *interface)
848{
849	struct adu_device *dev;
850	int minor;
851
852	dbg(2," %s : enter", __func__);
853
854	dev = usb_get_intfdata(interface);
855
856	mutex_lock(&dev->mtx);	/* not interruptible */
857	dev->udev = NULL;	/* poison */
858	minor = dev->minor;
859	usb_deregister_dev(interface, &adu_class);
860	mutex_unlock(&dev->mtx);
861
862	mutex_lock(&adutux_mutex);
863	usb_set_intfdata(interface, NULL);
864
865	/* if the device is not opened, then we clean up right now */
866	dbg(2," %s : open count %d", __func__, dev->open_count);
867	if (!dev->open_count)
868		adu_delete(dev);
869
870	mutex_unlock(&adutux_mutex);
871
872	dev_info(&interface->dev, "ADU device adutux%d now disconnected\n",
873		 (minor - ADU_MINOR_BASE));
874
875	dbg(2," %s : leave", __func__);
876}
877
878/* usb specific object needed to register this driver with the usb subsystem */
879static struct usb_driver adu_driver = {
880	.name = "adutux",
881	.probe = adu_probe,
882	.disconnect = adu_disconnect,
883	.id_table = device_table,
884};
885
886static int __init adu_init(void)
887{
888	int result;
889
890	dbg(2," %s : enter", __func__);
891
892	/* register this driver with the USB subsystem */
893	result = usb_register(&adu_driver);
894	if (result < 0) {
895		printk(KERN_ERR "usb_register failed for the "__FILE__
896		       " driver. Error number %d\n", result);
897		goto exit;
898	}
899
900	printk(KERN_INFO "adutux " DRIVER_DESC " " DRIVER_VERSION "\n");
901	printk(KERN_INFO "adutux is an experimental driver. "
902	       "Use at your own risk\n");
903
904exit:
905	dbg(2," %s : leave, return value %d", __func__, result);
906
907	return result;
908}
909
910static void __exit adu_exit(void)
911{
912	dbg(2," %s : enter", __func__);
913	/* deregister this driver with the USB subsystem */
914	usb_deregister(&adu_driver);
915	dbg(2," %s : leave", __func__);
916}
917
918module_init(adu_init);
919module_exit(adu_exit);
920
921MODULE_AUTHOR(DRIVER_AUTHOR);
922MODULE_DESCRIPTION(DRIVER_DESC);
923MODULE_LICENSE("GPL");
924