1 /*****************************************************************************/
3 * auerswald.c -- Auerswald PBX/System Telephone usb driver.
5 * Copyright (C) 2001 Wolfgang Mües (wolfgang@iksw-muees.de)
7 * Very much code of this driver is borrowed from dabusb.c (Deti Fliegl)
8 * and from the USB Skeleton driver (Greg Kroah-Hartman). Thank you.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 /*****************************************************************************/
26 /* Standard Linux module include files */
27 #include <asm/uaccess.h>
28 #include <asm/byteorder.h>
29 #include <linux/slab.h>
30 #include <linux/module.h>
31 #include <linux/init.h>
32 #include <linux/wait.h>
33 #include <linux/usb.h>
35 /*-------------------------------------------------------------------*/
38 #define dump( adr, len) \
41 printk (KERN_DEBUG); \
42 for (u = 0; u < len; u++) \
43 printk (" %02X", adr[u] & 0xFF); \
47 #define dump( adr, len)
50 /*-------------------------------------------------------------------*/
51 /* Version Information */
52 #define DRIVER_VERSION "0.9.11"
53 #define DRIVER_AUTHOR "Wolfgang Mües <wolfgang@iksw-muees.de>"
54 #define DRIVER_DESC "Auerswald PBX/System Telephone usb driver"
56 /*-------------------------------------------------------------------*/
57 /* Private declarations for Auerswald USB driver */
59 /* Auerswald Vendor ID */
60 #define ID_AUERSWALD 0x09BF
62 #define AUER_MINOR_BASE 112 /* auerswald driver minor number */
64 /* we can have up to this number of device plugged in at once */
65 #define AUER_MAX_DEVICES 16
68 /* Number of read buffers for each device */
69 #define AU_RBUFFERS 10
71 /* Number of chain elements for each control chain */
72 #define AUCH_ELEMENTS 20
74 /* Number of retries in communication */
77 /*-------------------------------------------------------------------*/
78 /* vendor specific protocol */
80 #define AUH_INDIRMASK 0x80 /* mask for direct/indirect bit */
81 #define AUH_DIRECT 0x00 /* data is for USB device */
82 #define AUH_INDIRECT 0x80 /* USB device is relay */
84 #define AUH_SPLITMASK 0x40 /* mask for split bit */
85 #define AUH_UNSPLIT 0x00 /* data block is full-size */
86 #define AUH_SPLIT 0x40 /* data block is part of a larger one,
89 #define AUH_TYPEMASK 0x3F /* mask for type of data transfer */
90 #define AUH_TYPESIZE 0x40 /* different types */
91 #define AUH_DCHANNEL 0x00 /* D channel data */
92 #define AUH_B1CHANNEL 0x01 /* B1 channel transparent */
93 #define AUH_B2CHANNEL 0x02 /* B2 channel transparent */
94 /* 0x03..0x0F reserved for driver internal use */
95 #define AUH_COMMAND 0x10 /* Command channel */
96 #define AUH_BPROT 0x11 /* Configuration block protocol */
97 #define AUH_DPROTANA 0x12 /* D channel protocol analyzer */
98 #define AUH_TAPI 0x13 /* telephone api data (ATD) */
99 /* 0x14..0x3F reserved for other protocols */
100 #define AUH_UNASSIGNED 0xFF /* if char device has no assigned service */
101 #define AUH_FIRSTUSERCH 0x11 /* first channel which is available for driver users */
103 #define AUH_SIZE 1 /* Size of Header Byte */
105 /* Split Byte. Only present if split bit in header byte set.*/
106 #define AUS_STARTMASK 0x80 /* mask for first block of splitted frame */
107 #define AUS_FIRST 0x80 /* first block */
108 #define AUS_FOLLOW 0x00 /* following block */
110 #define AUS_ENDMASK 0x40 /* mask for last block of splitted frame */
111 #define AUS_END 0x40 /* last block */
112 #define AUS_NOEND 0x00 /* not the last block */
114 #define AUS_LENMASK 0x3F /* mask for block length information */
117 #define AUT_RREQ (USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER) /* Read Request */
118 #define AUT_WREQ (USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER) /* Write Request */
120 /* Vendor Requests */
121 #define AUV_GETINFO 0x00 /* GetDeviceInfo */
122 #define AUV_WBLOCK 0x01 /* Write Block */
123 #define AUV_RBLOCK 0x02 /* Read Block */
124 #define AUV_CHANNELCTL 0x03 /* Channel Control */
125 #define AUV_DUMMY 0x04 /* Dummy Out for retry */
127 /* Device Info Types */
128 #define AUDI_NUMBCH 0x0000 /* Number of supported B channels */
129 #define AUDI_OUTFSIZE 0x0001 /* Size of OUT B channel fifos */
130 #define AUDI_MBCTRANS 0x0002 /* max. Blocklength of control transfer */
132 /* Interrupt endpoint definitions */
133 #define AU_IRQENDP 1 /* Endpoint number */
134 #define AU_IRQCMDID 16 /* Command-block ID */
135 #define AU_BLOCKRDY 0 /* Command: Block data ready on ctl endpoint */
136 #define AU_IRQMINSIZE 5 /* Nr. of bytes decoded in this driver */
138 /* Device String Descriptors */
139 #define AUSI_VENDOR 1 /* "Auerswald GmbH & Co. KG" */
140 #define AUSI_DEVICE 2 /* Name of the Device */
141 #define AUSI_SERIALNR 3 /* Serial Number */
142 #define AUSI_MSN 4 /* "MSN ..." (first) Multiple Subscriber Number */
144 #define AUSI_DLEN 100 /* Max. Length of Device Description */
146 #define AUV_RETRY 0x101 /* First Firmware version which can do control retries */
148 /*-------------------------------------------------------------------*/
149 /* External data structures / Interface */
152 char __user *buf; /* return buffer for string contents */
153 unsigned int bsize; /* size of return buffer */
154 } audevinfo_t,*paudevinfo_t;
157 #define IOCTL_AU_SLEN _IOR( 'U', 0xF0, int) /* return the max. string descriptor length */
158 #define IOCTL_AU_DEVINFO _IOWR('U', 0xF1, audevinfo_t) /* get name of a specific device */
159 #define IOCTL_AU_SERVREQ _IOW( 'U', 0xF2, int) /* request a service channel */
160 #define IOCTL_AU_BUFLEN _IOR( 'U', 0xF3, int) /* return the max. buffer length for the device */
161 #define IOCTL_AU_RXAVAIL _IOR( 'U', 0xF4, int) /* return != 0 if Receive Data available */
162 #define IOCTL_AU_CONNECT _IOR( 'U', 0xF5, int) /* return != 0 if connected to a service channel */
163 #define IOCTL_AU_TXREADY _IOR( 'U', 0xF6, int) /* return != 0 if Transmitt channel ready to send */
164 /* 'U' 0xF7..0xFF reseved */
166 /*-------------------------------------------------------------------*/
167 /* Internal data structures */
169 /* ..................................................................*/
170 /* urb chain element */
171 struct auerchain; /* forward for circular reference */
174 struct auerchain *chain; /* pointer to the chain to which this element belongs */
175 struct urb * urbp; /* pointer to attached urb */
176 void *context; /* saved URB context */
177 usb_complete_t complete; /* saved URB completion function */
178 struct list_head list; /* to include element into a list */
179 } auerchainelement_t,*pauerchainelement_t;
182 typedef struct auerchain
184 pauerchainelement_t active; /* element which is submitted to urb */
185 spinlock_t lock; /* protection agains interrupts */
186 struct list_head waiting_list; /* list of waiting elements */
187 struct list_head free_list; /* list of available elements */
188 } auerchain_t,*pauerchain_t;
190 /* urb blocking completion helper struct */
193 wait_queue_head_t wqh; /* wait for completion */
194 unsigned int done; /* completion flag */
195 } auerchain_chs_t,*pauerchain_chs_t;
197 /* ...................................................................*/
199 struct auerbufctl; /* forward */
202 char *bufp; /* reference to allocated data buffer */
203 unsigned int len; /* number of characters in data buffer */
204 unsigned int retries; /* for urb retries */
205 struct usb_ctrlrequest *dr; /* for setup data in control messages */
206 struct urb * urbp; /* USB urb */
207 struct auerbufctl *list; /* pointer to list */
208 struct list_head buff_list; /* reference to next buffer in list */
209 } auerbuf_t,*pauerbuf_t;
211 /* buffer list control block */
212 typedef struct auerbufctl
214 spinlock_t lock; /* protection in interrupt */
215 struct list_head free_buff_list;/* free buffers */
216 struct list_head rec_buff_list; /* buffers with receive data */
217 } auerbufctl_t,*pauerbufctl_t;
219 /* ...................................................................*/
220 /* service context */
221 struct auerscon; /* forward */
222 typedef void (*auer_dispatch_t)(struct auerscon*, pauerbuf_t);
223 typedef void (*auer_disconn_t) (struct auerscon*);
224 typedef struct auerscon
226 unsigned int id; /* protocol service id AUH_xxxx */
227 auer_dispatch_t dispatch; /* dispatch read buffer */
228 auer_disconn_t disconnect; /* disconnect from device, wake up all char readers */
229 } auerscon_t,*pauerscon_t;
231 /* ...................................................................*/
232 /* USB device context */
235 struct semaphore mutex; /* protection in user context */
236 char name[20]; /* name of the /dev/usb entry */
237 unsigned int dtindex; /* index in the device table */
238 struct usb_device * usbdev; /* USB device handle */
239 int open_count; /* count the number of open character channels */
240 char dev_desc[AUSI_DLEN];/* for storing a textual description */
241 unsigned int maxControlLength; /* max. Length of control paket (without header) */
242 struct urb * inturbp; /* interrupt urb */
243 char * intbufp; /* data buffer for interrupt urb */
244 unsigned int irqsize; /* size of interrupt endpoint 1 */
245 struct auerchain controlchain; /* for chaining of control messages */
246 auerbufctl_t bufctl; /* Buffer control for control transfers */
247 pauerscon_t services[AUH_TYPESIZE];/* context pointers for each service */
248 unsigned int version; /* Version of the device */
249 wait_queue_head_t bufferwait; /* wait for a control buffer */
250 } auerswald_t,*pauerswald_t;
252 /* ................................................................... */
253 /* character device context */
256 struct semaphore mutex; /* protection in user context */
257 pauerswald_t auerdev; /* context pointer of assigned device */
258 auerbufctl_t bufctl; /* controls the buffer chain */
259 auerscon_t scontext; /* service context */
260 wait_queue_head_t readwait; /* for synchronous reading */
261 struct semaphore readmutex; /* protection against multiple reads */
262 pauerbuf_t readbuf; /* buffer held for partial reading */
263 unsigned int readoffset; /* current offset in readbuf */
264 unsigned int removed; /* is != 0 if device is removed */
265 } auerchar_t,*pauerchar_t;
268 /*-------------------------------------------------------------------*/
270 static void auerswald_ctrlread_complete (struct urb * urb);
271 static void auerswald_removeservice (pauerswald_t cp, pauerscon_t scp);
272 static struct usb_driver auerswald_driver;
275 /*-------------------------------------------------------------------*/
276 /* USB chain helper functions */
277 /* -------------------------- */
279 /* completion function for chained urbs */
280 static void auerchain_complete (struct urb * urb)
285 /* get pointer to element and to chain */
286 pauerchainelement_t acep = (pauerchainelement_t) urb->context;
287 pauerchain_t acp = acep->chain;
289 /* restore original entries in urb */
290 urb->context = acep->context;
291 urb->complete = acep->complete;
293 dbg ("auerchain_complete called");
295 /* call original completion function
296 NOTE: this function may lead to more urbs submitted into the chain.
297 (no chain lock at calling complete()!)
298 acp->active != NULL is protecting us against recursion.*/
301 /* detach element from chain data structure */
302 spin_lock_irqsave (&acp->lock, flags);
303 if (acp->active != acep) /* paranoia debug check */
304 dbg ("auerchain_complete: completion on non-active element called!");
308 /* add the used chain element to the list of free elements */
309 list_add_tail (&acep->list, &acp->free_list);
312 /* is there a new element waiting in the chain? */
313 if (!acp->active && !list_empty (&acp->waiting_list)) {
314 /* yes: get the entry */
315 struct list_head *tmp = acp->waiting_list.next;
317 acep = list_entry (tmp, auerchainelement_t, list);
320 spin_unlock_irqrestore (&acp->lock, flags);
322 /* submit the new urb */
325 dbg ("auerchain_complete: submitting next urb from chain");
326 urb->status = 0; /* needed! */
327 result = usb_submit_urb(urb, GFP_ATOMIC);
329 /* check for submit errors */
331 urb->status = result;
332 dbg("auerchain_complete: usb_submit_urb with error code %d", result);
333 /* and do error handling via *this* completion function (recursive) */
334 auerchain_complete( urb);
337 /* simple return without submitting a new urb.
338 The empty chain is detected with acp->active == NULL. */
343 /* submit function for chained urbs
344 this function may be called from completion context or from user space!
345 early = 1 -> submit in front of chain
347 static int auerchain_submit_urb_list (pauerchain_t acp, struct urb * urb, int early)
351 pauerchainelement_t acep = NULL;
353 dbg ("auerchain_submit_urb called");
355 /* try to get a chain element */
356 spin_lock_irqsave (&acp->lock, flags);
357 if (!list_empty (&acp->free_list)) {
358 /* yes: get the entry */
359 struct list_head *tmp = acp->free_list.next;
361 acep = list_entry (tmp, auerchainelement_t, list);
363 spin_unlock_irqrestore (&acp->lock, flags);
365 /* if no chain element available: return with error */
370 /* fill in the new chain element values */
372 acep->context = urb->context;
373 acep->complete = urb->complete;
375 INIT_LIST_HEAD (&acep->list);
379 urb->complete = auerchain_complete;
380 urb->status = -EINPROGRESS; /* usb_submit_urb does this, too */
382 /* add element to chain - or start it immediately */
383 spin_lock_irqsave (&acp->lock, flags);
385 /* there is traffic in the chain, simple add element to chain */
387 dbg ("adding new urb to head of chain");
388 list_add (&acep->list, &acp->waiting_list);
390 dbg ("adding new urb to end of chain");
391 list_add_tail (&acep->list, &acp->waiting_list);
395 /* the chain is empty. Prepare restart */
398 /* Spin has to be removed before usb_submit_urb! */
399 spin_unlock_irqrestore (&acp->lock, flags);
401 /* Submit urb if immediate restart */
403 dbg("submitting urb immediate");
404 urb->status = 0; /* needed! */
405 result = usb_submit_urb(urb, GFP_ATOMIC);
406 /* check for submit errors */
408 urb->status = result;
409 dbg("auerchain_submit_urb: usb_submit_urb with error code %d", result);
410 /* and do error handling via completion function */
411 auerchain_complete( urb);
418 /* submit function for chained urbs
419 this function may be called from completion context or from user space!
421 static int auerchain_submit_urb (pauerchain_t acp, struct urb * urb)
423 return auerchain_submit_urb_list (acp, urb, 0);
426 /* cancel an urb which is submitted to the chain
427 the result is 0 if the urb is cancelled, or -EINPROGRESS if
428 the function is successfully started.
430 static int auerchain_unlink_urb (pauerchain_t acp, struct urb * urb)
434 pauerchainelement_t acep;
435 struct list_head *tmp;
437 dbg ("auerchain_unlink_urb called");
439 /* search the chain of waiting elements */
440 spin_lock_irqsave (&acp->lock, flags);
441 list_for_each (tmp, &acp->waiting_list) {
442 acep = list_entry (tmp, auerchainelement_t, list);
443 if (acep->urbp == urb) {
445 urb->context = acep->context;
446 urb->complete = acep->complete;
447 list_add_tail (&acep->list, &acp->free_list);
448 spin_unlock_irqrestore (&acp->lock, flags);
449 dbg ("unlink waiting urb");
450 urb->status = -ENOENT;
456 spin_unlock_irqrestore (&acp->lock, flags);
458 /* get the active urb */
463 /* check if we have to cancel the active urb */
465 /* note that there is a race condition between the check above
466 and the unlink() call because of no lock. This race is harmless,
467 because the usb module will detect the unlink() after completion.
468 We can't use the acp->lock here because the completion function
471 dbg ("unlink active urb");
472 return usb_unlink_urb (urbp);
477 ... is some kind of success
479 dbg ("urb to unlink not found in chain");
483 /* cancel all urbs which are in the chain.
484 this function must not be called from interrupt or completion handler.
486 static void auerchain_unlink_all (pauerchain_t acp)
490 pauerchainelement_t acep;
492 dbg ("auerchain_unlink_all called");
494 /* clear the chain of waiting elements */
495 spin_lock_irqsave (&acp->lock, flags);
496 while (!list_empty (&acp->waiting_list)) {
497 /* get the next entry */
498 struct list_head *tmp = acp->waiting_list.next;
500 acep = list_entry (tmp, auerchainelement_t, list);
502 urbp->context = acep->context;
503 urbp->complete = acep->complete;
504 list_add_tail (&acep->list, &acp->free_list);
505 spin_unlock_irqrestore (&acp->lock, flags);
506 dbg ("unlink waiting urb");
507 urbp->status = -ENOENT;
508 urbp->complete (urbp);
509 spin_lock_irqsave (&acp->lock, flags);
511 spin_unlock_irqrestore (&acp->lock, flags);
513 /* clear the active urb */
517 dbg ("unlink active urb");
524 this function must not be called from interrupt or completion handler.
526 static void auerchain_free (pauerchain_t acp)
529 pauerchainelement_t acep;
531 dbg ("auerchain_free called");
533 /* first, cancel all pending urbs */
534 auerchain_unlink_all (acp);
536 /* free the elements */
537 spin_lock_irqsave (&acp->lock, flags);
538 while (!list_empty (&acp->free_list)) {
539 /* get the next entry */
540 struct list_head *tmp = acp->free_list.next;
542 spin_unlock_irqrestore (&acp->lock, flags);
543 acep = list_entry (tmp, auerchainelement_t, list);
545 spin_lock_irqsave (&acp->lock, flags);
547 spin_unlock_irqrestore (&acp->lock, flags);
551 /* Init the chain control structure */
552 static void auerchain_init (pauerchain_t acp)
554 /* init the chain data structure */
556 spin_lock_init (&acp->lock);
557 INIT_LIST_HEAD (&acp->waiting_list);
558 INIT_LIST_HEAD (&acp->free_list);
562 It is assumed that there is no concurrency while setting up the chain
563 requirement: auerchain_init()
565 static int auerchain_setup (pauerchain_t acp, unsigned int numElements)
567 pauerchainelement_t acep;
569 dbg ("auerchain_setup called with %d elements", numElements);
571 /* fill the list of free elements */
572 for (;numElements; numElements--) {
573 acep = kzalloc(sizeof(auerchainelement_t), GFP_KERNEL);
576 INIT_LIST_HEAD (&acep->list);
577 list_add_tail (&acep->list, &acp->free_list);
581 ac_fail:/* free the elements */
582 while (!list_empty (&acp->free_list)) {
583 /* get the next entry */
584 struct list_head *tmp = acp->free_list.next;
586 acep = list_entry (tmp, auerchainelement_t, list);
593 /* completion handler for synchronous chained URBs */
594 static void auerchain_blocking_completion (struct urb *urb)
596 pauerchain_chs_t pchs = (pauerchain_chs_t)urb->context;
599 wake_up (&pchs->wqh);
603 /* Starts chained urb and waits for completion or timeout */
604 static int auerchain_start_wait_urb (pauerchain_t acp, struct urb *urb, int timeout, int* actual_length)
609 dbg ("auerchain_start_wait_urb called");
610 init_waitqueue_head (&chs.wqh);
614 status = auerchain_submit_urb (acp, urb);
616 /* something went wrong */
619 timeout = wait_event_timeout(chs.wqh, chs.done, timeout);
621 if (!timeout && !chs.done) {
622 if (urb->status != -EINPROGRESS) { /* No callback?!! */
623 dbg ("auerchain_start_wait_urb: raced timeout");
624 status = urb->status;
626 dbg ("auerchain_start_wait_urb: timeout");
627 auerchain_unlink_urb (acp, urb); /* remove urb safely */
631 status = urb->status;
634 *actual_length = urb->actual_length;
640 /* auerchain_control_msg - Builds a control urb, sends it off and waits for completion
641 acp: pointer to the auerchain
642 dev: pointer to the usb device to send the message to
643 pipe: endpoint "pipe" to send the message to
644 request: USB message request value
645 requesttype: USB message request type value
646 value: USB message value
647 index: USB message index value
648 data: pointer to the data to send
649 size: length in bytes of the data to send
650 timeout: time to wait for the message to complete before timing out (if 0 the wait is forever)
652 This function sends a simple control message to a specified endpoint
653 and waits for the message to complete, or timeout.
655 If successful, it returns the transferred length, otherwise a negative error number.
657 Don't use this function from within an interrupt context, like a
658 bottom half handler. If you need an asynchronous message, or need to send
659 a message from within interrupt context, use auerchain_submit_urb()
661 static int auerchain_control_msg (pauerchain_t acp, struct usb_device *dev, unsigned int pipe, __u8 request, __u8 requesttype,
662 __u16 value, __u16 index, void *data, __u16 size, int timeout)
665 struct usb_ctrlrequest *dr;
669 dbg ("auerchain_control_msg");
670 dr = kmalloc (sizeof (struct usb_ctrlrequest), GFP_KERNEL);
673 urb = usb_alloc_urb (0, GFP_KERNEL);
679 dr->bRequestType = requesttype;
680 dr->bRequest = request;
681 dr->wValue = cpu_to_le16 (value);
682 dr->wIndex = cpu_to_le16 (index);
683 dr->wLength = cpu_to_le16 (size);
685 usb_fill_control_urb (urb, dev, pipe, (unsigned char*)dr, data, size, /* build urb */
686 auerchain_blocking_completion, NULL);
687 ret = auerchain_start_wait_urb (acp, urb, timeout, &length);
699 /*-------------------------------------------------------------------*/
700 /* Buffer List helper functions */
702 /* free a single auerbuf */
703 static void auerbuf_free (pauerbuf_t bp)
707 usb_free_urb(bp->urbp);
711 /* free the buffers from an auerbuf list */
712 static void auerbuf_free_list (struct list_head *q)
714 struct list_head *tmp;
718 dbg ("auerbuf_free_list");
719 for (p = q->next; p != q;) {
720 bp = list_entry (p, auerbuf_t, buff_list);
728 /* init the members of a list control block */
729 static void auerbuf_init (pauerbufctl_t bcp)
731 dbg ("auerbuf_init");
732 spin_lock_init (&bcp->lock);
733 INIT_LIST_HEAD (&bcp->free_buff_list);
734 INIT_LIST_HEAD (&bcp->rec_buff_list);
737 /* free all buffers from an auerbuf chain */
738 static void auerbuf_free_buffers (pauerbufctl_t bcp)
741 dbg ("auerbuf_free_buffers");
743 spin_lock_irqsave (&bcp->lock, flags);
745 auerbuf_free_list (&bcp->free_buff_list);
746 auerbuf_free_list (&bcp->rec_buff_list);
748 spin_unlock_irqrestore (&bcp->lock, flags);
751 /* setup a list of buffers */
752 /* requirement: auerbuf_init() */
753 static int auerbuf_setup (pauerbufctl_t bcp, unsigned int numElements, unsigned int bufsize)
755 pauerbuf_t bep = NULL;
757 dbg ("auerbuf_setup called with %d elements of %d bytes", numElements, bufsize);
759 /* fill the list of free elements */
760 for (;numElements; numElements--) {
761 bep = kzalloc(sizeof(auerbuf_t), GFP_KERNEL);
765 INIT_LIST_HEAD (&bep->buff_list);
766 bep->bufp = kmalloc (bufsize, GFP_KERNEL);
769 bep->dr = (struct usb_ctrlrequest *) kmalloc (sizeof (struct usb_ctrlrequest), GFP_KERNEL);
772 bep->urbp = usb_alloc_urb (0, GFP_KERNEL);
775 list_add_tail (&bep->buff_list, &bcp->free_buff_list);
779 bl_fail:/* not enough memory. Free allocated elements */
780 dbg ("auerbuf_setup: no more memory");
782 auerbuf_free_buffers (bcp);
786 /* insert a used buffer into the free list */
787 static void auerbuf_releasebuf( pauerbuf_t bp)
790 pauerbufctl_t bcp = bp->list;
793 dbg ("auerbuf_releasebuf called");
794 spin_lock_irqsave (&bcp->lock, flags);
795 list_add_tail (&bp->buff_list, &bcp->free_buff_list);
796 spin_unlock_irqrestore (&bcp->lock, flags);
800 /*-------------------------------------------------------------------*/
801 /* Completion handlers */
803 /* Values of urb->status or results of usb_submit_urb():
805 -EINPROGRESS during submission until end
806 -ENOENT if urb is unlinked
807 -ETIME Device did not respond
808 -ENOMEM Memory Overflow
809 -ENODEV Specified USB-device or bus doesn't exist
810 -ENXIO URB already queued
811 -EINVAL a) Invalid transfer type specified (or not supported)
812 b) Invalid interrupt interval (0n256)
813 -EAGAIN a) Specified ISO start frame too early
814 b) (using ISO-ASAP) Too much scheduled for the future wait some time and try again.
815 -EFBIG Too much ISO frames requested (currently uhci900)
816 -EPIPE Specified pipe-handle/Endpoint is already stalled
817 -EMSGSIZE Endpoint message size is zero, do interface/alternate setting
818 -EPROTO a) Bitstuff error
822 -EREMOTEIO Short packet detected
823 -EXDEV ISO transfer only partially completed look at individual frame status for details
824 -EINVAL ISO madness, if this happens: Log off and go home
828 /* check if a status code allows a retry */
829 static int auerswald_status_retry (int status)
841 return 1; /* do a retry */
843 return 0; /* no retry possible */
846 /* Completion of asynchronous write block */
847 static void auerchar_ctrlwrite_complete (struct urb * urb)
849 pauerbuf_t bp = (pauerbuf_t) urb->context;
850 pauerswald_t cp = ((pauerswald_t)((char *)(bp->list)-(unsigned long)(&((pauerswald_t)0)->bufctl)));
851 dbg ("auerchar_ctrlwrite_complete called");
853 /* reuse the buffer */
854 auerbuf_releasebuf (bp);
855 /* Wake up all processes waiting for a buffer */
856 wake_up (&cp->bufferwait);
859 /* Completion handler for dummy retry packet */
860 static void auerswald_ctrlread_wretcomplete (struct urb * urb)
862 pauerbuf_t bp = (pauerbuf_t) urb->context;
865 dbg ("auerswald_ctrlread_wretcomplete called");
866 dbg ("complete with status: %d", urb->status);
867 cp = ((pauerswald_t)((char *)(bp->list)-(unsigned long)(&((pauerswald_t)0)->bufctl)));
869 /* check if it is possible to advance */
870 if (!auerswald_status_retry (urb->status) || !cp->usbdev) {
871 /* reuse the buffer */
872 err ("control dummy: transmission error %d, can not retry", urb->status);
873 auerbuf_releasebuf (bp);
874 /* Wake up all processes waiting for a buffer */
875 wake_up (&cp->bufferwait);
879 /* fill the control message */
880 bp->dr->bRequestType = AUT_RREQ;
881 bp->dr->bRequest = AUV_RBLOCK;
882 bp->dr->wLength = bp->dr->wValue; /* temporary stored */
883 bp->dr->wValue = cpu_to_le16 (1); /* Retry Flag */
884 /* bp->dr->index = channel id; remains */
885 usb_fill_control_urb (bp->urbp, cp->usbdev, usb_rcvctrlpipe (cp->usbdev, 0),
886 (unsigned char*)bp->dr, bp->bufp, le16_to_cpu (bp->dr->wLength),
887 auerswald_ctrlread_complete,bp);
889 /* submit the control msg as next paket */
890 ret = auerchain_submit_urb_list (&cp->controlchain, bp->urbp, 1);
892 dbg ("auerswald_ctrlread_complete: nonzero result of auerchain_submit_urb_list %d", ret);
893 bp->urbp->status = ret;
894 auerswald_ctrlread_complete (bp->urbp);
898 /* completion handler for receiving of control messages */
899 static void auerswald_ctrlread_complete (struct urb * urb)
901 unsigned int serviceid;
904 pauerbuf_t bp = (pauerbuf_t) urb->context;
906 dbg ("auerswald_ctrlread_complete called");
908 cp = ((pauerswald_t)((char *)(bp->list)-(unsigned long)(&((pauerswald_t)0)->bufctl)));
910 /* check if there is valid data in this urb */
912 dbg ("complete with non-zero status: %d", urb->status);
913 /* should we do a retry? */
914 if (!auerswald_status_retry (urb->status)
916 || (cp->version < AUV_RETRY)
917 || (bp->retries >= AU_RETRIES)) {
918 /* reuse the buffer */
919 err ("control read: transmission error %d, can not retry", urb->status);
920 auerbuf_releasebuf (bp);
921 /* Wake up all processes waiting for a buffer */
922 wake_up (&cp->bufferwait);
926 dbg ("Retry count = %d", bp->retries);
927 /* send a long dummy control-write-message to allow device firmware to react */
928 bp->dr->bRequestType = AUT_WREQ;
929 bp->dr->bRequest = AUV_DUMMY;
930 bp->dr->wValue = bp->dr->wLength; /* temporary storage */
931 // bp->dr->wIndex channel ID remains
932 bp->dr->wLength = cpu_to_le16 (32); /* >= 8 bytes */
933 usb_fill_control_urb (bp->urbp, cp->usbdev, usb_sndctrlpipe (cp->usbdev, 0),
934 (unsigned char*)bp->dr, bp->bufp, 32,
935 auerswald_ctrlread_wretcomplete,bp);
937 /* submit the control msg as next paket */
938 ret = auerchain_submit_urb_list (&cp->controlchain, bp->urbp, 1);
940 dbg ("auerswald_ctrlread_complete: nonzero result of auerchain_submit_urb_list %d", ret);
941 bp->urbp->status = ret;
942 auerswald_ctrlread_wretcomplete (bp->urbp);
947 /* get the actual bytecount (incl. headerbyte) */
948 bp->len = urb->actual_length;
949 serviceid = bp->bufp[0] & AUH_TYPEMASK;
950 dbg ("Paket with serviceid %d and %d bytes received", serviceid, bp->len);
952 /* dispatch the paket */
953 scp = cp->services[serviceid];
955 /* look, Ma, a listener! */
956 scp->dispatch (scp, bp);
959 /* release the paket */
960 auerbuf_releasebuf (bp);
961 /* Wake up all processes waiting for a buffer */
962 wake_up (&cp->bufferwait);
965 /*-------------------------------------------------------------------*/
966 /* Handling of Interrupt Endpoint */
967 /* This interrupt Endpoint is used to inform the host about waiting
968 messages from the USB device.
970 /* int completion handler. */
971 static void auerswald_int_complete (struct urb * urb)
974 unsigned int channelid;
975 unsigned int bytecount;
977 pauerbuf_t bp = NULL;
978 pauerswald_t cp = (pauerswald_t) urb->context;
980 dbg ("%s called", __FUNCTION__);
982 switch (urb->status) {
989 /* this urb is terminated, clean up */
990 dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);
993 dbg("%s - nonzero urb status received: %d", __FUNCTION__, urb->status);
997 /* check if all needed data was received */
998 if (urb->actual_length < AU_IRQMINSIZE) {
999 dbg ("invalid data length received: %d bytes", urb->actual_length);
1003 /* check the command code */
1004 if (cp->intbufp[0] != AU_IRQCMDID) {
1005 dbg ("invalid command received: %d", cp->intbufp[0]);
1009 /* check the command type */
1010 if (cp->intbufp[1] != AU_BLOCKRDY) {
1011 dbg ("invalid command type received: %d", cp->intbufp[1]);
1015 /* now extract the information */
1016 channelid = cp->intbufp[2];
1017 bytecount = (unsigned char)cp->intbufp[3];
1018 bytecount |= (unsigned char)cp->intbufp[4] << 8;
1020 /* check the channel id */
1021 if (channelid >= AUH_TYPESIZE) {
1022 dbg ("invalid channel id received: %d", channelid);
1026 /* check the byte count */
1027 if (bytecount > (cp->maxControlLength+AUH_SIZE)) {
1028 dbg ("invalid byte count received: %d", bytecount);
1031 dbg ("Service Channel = %d", channelid);
1032 dbg ("Byte Count = %d", bytecount);
1034 /* get a buffer for the next data paket */
1035 spin_lock_irqsave (&cp->bufctl.lock, flags);
1036 if (!list_empty (&cp->bufctl.free_buff_list)) {
1037 /* yes: get the entry */
1038 struct list_head *tmp = cp->bufctl.free_buff_list.next;
1040 bp = list_entry (tmp, auerbuf_t, buff_list);
1042 spin_unlock_irqrestore (&cp->bufctl.lock, flags);
1044 /* if no buffer available: skip it */
1046 dbg ("auerswald_int_complete: no data buffer available");
1047 /* can we do something more?
1048 This is a big problem: if this int packet is ignored, the
1049 device will wait forever and not signal any more data.
1050 The only real solution is: having enough buffers!
1051 Or perhaps temporary disabling the int endpoint?
1056 /* fill the control message */
1057 bp->dr->bRequestType = AUT_RREQ;
1058 bp->dr->bRequest = AUV_RBLOCK;
1059 bp->dr->wValue = cpu_to_le16 (0);
1060 bp->dr->wIndex = cpu_to_le16 (channelid | AUH_DIRECT | AUH_UNSPLIT);
1061 bp->dr->wLength = cpu_to_le16 (bytecount);
1062 usb_fill_control_urb (bp->urbp, cp->usbdev, usb_rcvctrlpipe (cp->usbdev, 0),
1063 (unsigned char*)bp->dr, bp->bufp, bytecount,
1064 auerswald_ctrlread_complete,bp);
1066 /* submit the control msg */
1067 ret = auerchain_submit_urb (&cp->controlchain, bp->urbp);
1069 dbg ("auerswald_int_complete: nonzero result of auerchain_submit_urb %d", ret);
1070 bp->urbp->status = ret;
1071 auerswald_ctrlread_complete( bp->urbp);
1072 /* here applies the same problem as above: device locking! */
1075 ret = usb_submit_urb (urb, GFP_ATOMIC);
1077 err ("%s - usb_submit_urb failed with result %d",
1081 /* int memory deallocation
1082 NOTE: no mutex please!
1084 static void auerswald_int_free (pauerswald_t cp)
1087 usb_free_urb(cp->inturbp);
1094 /* This function is called to activate the interrupt
1095 endpoint. This function returns 0 if successful or an error code.
1096 NOTE: no mutex please!
1098 static int auerswald_int_open (pauerswald_t cp)
1101 struct usb_host_endpoint *ep;
1103 dbg ("auerswald_int_open");
1105 ep = cp->usbdev->ep_in[AU_IRQENDP];
1110 irqsize = le16_to_cpu(ep->desc.wMaxPacketSize);
1111 cp->irqsize = irqsize;
1113 /* allocate the urb and data buffer */
1115 cp->inturbp = usb_alloc_urb (0, GFP_KERNEL);
1122 cp->intbufp = kmalloc (irqsize, GFP_KERNEL);
1129 usb_fill_int_urb (cp->inturbp, cp->usbdev,
1130 usb_rcvintpipe (cp->usbdev,AU_IRQENDP), cp->intbufp,
1131 irqsize, auerswald_int_complete, cp, ep->desc.bInterval);
1133 cp->inturbp->status = 0; /* needed! */
1134 ret = usb_submit_urb (cp->inturbp, GFP_KERNEL);
1138 /* activation of interrupt endpoint has failed. Now clean up. */
1139 dbg ("auerswald_int_open: activation of int endpoint failed");
1141 /* deallocate memory */
1142 auerswald_int_free (cp);
1147 /* This function is called to deactivate the interrupt
1148 endpoint. This function returns 0 if successful or an error code.
1149 NOTE: no mutex please!
1151 static void auerswald_int_release (pauerswald_t cp)
1153 dbg ("auerswald_int_release");
1155 /* stop the int endpoint */
1156 usb_kill_urb (cp->inturbp);
1158 /* deallocate memory */
1159 auerswald_int_free (cp);
1162 /* --------------------------------------------------------------------- */
1163 /* Helper functions */
1165 /* wake up waiting readers */
1166 static void auerchar_disconnect (pauerscon_t scp)
1168 pauerchar_t ccp = ((pauerchar_t)((char *)(scp)-(unsigned long)(&((pauerchar_t)0)->scontext)));
1169 dbg ("auerchar_disconnect called");
1171 wake_up (&ccp->readwait);
1175 /* dispatch a read paket to a waiting character device */
1176 static void auerchar_ctrlread_dispatch (pauerscon_t scp, pauerbuf_t bp)
1178 unsigned long flags;
1180 pauerbuf_t newbp = NULL;
1182 dbg ("auerchar_ctrlread_dispatch called");
1183 ccp = ((pauerchar_t)((char *)(scp)-(unsigned long)(&((pauerchar_t)0)->scontext)));
1185 /* get a read buffer from character device context */
1186 spin_lock_irqsave (&ccp->bufctl.lock, flags);
1187 if (!list_empty (&ccp->bufctl.free_buff_list)) {
1188 /* yes: get the entry */
1189 struct list_head *tmp = ccp->bufctl.free_buff_list.next;
1191 newbp = list_entry (tmp, auerbuf_t, buff_list);
1193 spin_unlock_irqrestore (&ccp->bufctl.lock, flags);
1196 dbg ("No read buffer available, discard paket!");
1197 return; /* no buffer, no dispatch */
1200 /* copy information to new buffer element
1201 (all buffers have the same length) */
1202 charp = newbp->bufp;
1203 newbp->bufp = bp->bufp;
1205 newbp->len = bp->len;
1207 /* insert new buffer in read list */
1208 spin_lock_irqsave (&ccp->bufctl.lock, flags);
1209 list_add_tail (&newbp->buff_list, &ccp->bufctl.rec_buff_list);
1210 spin_unlock_irqrestore (&ccp->bufctl.lock, flags);
1211 dbg ("read buffer appended to rec_list");
1213 /* wake up pending synchronous reads */
1214 wake_up (&ccp->readwait);
1218 /* Delete an auerswald driver context */
1219 static void auerswald_delete( pauerswald_t cp)
1221 dbg( "auerswald_delete");
1225 /* Wake up all processes waiting for a buffer */
1226 wake_up (&cp->bufferwait);
1229 auerswald_int_release (cp);
1230 auerchain_free (&cp->controlchain);
1231 auerbuf_free_buffers (&cp->bufctl);
1233 /* release the memory */
1238 /* Delete an auerswald character context */
1239 static void auerchar_delete( pauerchar_t ccp)
1241 dbg ("auerchar_delete");
1245 /* wake up pending synchronous reads */
1247 wake_up (&ccp->readwait);
1249 /* remove the read buffer */
1251 auerbuf_releasebuf (ccp->readbuf);
1252 ccp->readbuf = NULL;
1255 /* remove the character buffers */
1256 auerbuf_free_buffers (&ccp->bufctl);
1258 /* release the memory */
1263 /* add a new service to the device
1264 scp->id must be set!
1265 return: 0 if OK, else error code
1267 static int auerswald_addservice (pauerswald_t cp, pauerscon_t scp)
1271 /* is the device available? */
1273 dbg ("usbdev == NULL");
1274 return -EIO; /*no: can not add a service, sorry*/
1277 /* is the service available? */
1278 if (cp->services[scp->id]) {
1279 dbg ("service is busy");
1283 /* device is available, service is free */
1284 cp->services[scp->id] = scp;
1286 /* register service in device */
1287 ret = auerchain_control_msg(
1288 &cp->controlchain, /* pointer to control chain */
1289 cp->usbdev, /* pointer to device */
1290 usb_sndctrlpipe (cp->usbdev, 0), /* pipe to control endpoint */
1291 AUV_CHANNELCTL, /* USB message request value */
1292 AUT_WREQ, /* USB message request type value */
1293 0x01, /* open USB message value */
1294 scp->id, /* USB message index value */
1295 NULL, /* pointer to the data to send */
1296 0, /* length in bytes of the data to send */
1297 HZ * 2); /* time to wait for the message to complete before timing out */
1299 dbg ("auerswald_addservice: auerchain_control_msg returned error code %d", ret);
1300 /* undo above actions */
1301 cp->services[scp->id] = NULL;
1305 dbg ("auerswald_addservice: channel open OK");
1310 /* remove a service from the the device
1311 scp->id must be set! */
1312 static void auerswald_removeservice (pauerswald_t cp, pauerscon_t scp)
1314 dbg ("auerswald_removeservice called");
1316 /* check if we have a service allocated */
1317 if (scp->id == AUH_UNASSIGNED)
1320 /* If there is a device: close the channel */
1322 /* Close the service channel inside the device */
1323 int ret = auerchain_control_msg(
1324 &cp->controlchain, /* pointer to control chain */
1325 cp->usbdev, /* pointer to device */
1326 usb_sndctrlpipe (cp->usbdev, 0), /* pipe to control endpoint */
1327 AUV_CHANNELCTL, /* USB message request value */
1328 AUT_WREQ, /* USB message request type value */
1329 0x00, // close /* USB message value */
1330 scp->id, /* USB message index value */
1331 NULL, /* pointer to the data to send */
1332 0, /* length in bytes of the data to send */
1333 HZ * 2); /* time to wait for the message to complete before timing out */
1335 dbg ("auerswald_removeservice: auerchain_control_msg returned error code %d", ret);
1338 dbg ("auerswald_removeservice: channel close OK");
1342 /* remove the service from the device */
1343 cp->services[scp->id] = NULL;
1344 scp->id = AUH_UNASSIGNED;
1348 /* --------------------------------------------------------------------- */
1349 /* Char device functions */
1351 /* Open a new character device */
1352 static int auerchar_open (struct inode *inode, struct file *file)
1354 int dtindex = iminor(inode);
1355 pauerswald_t cp = NULL;
1356 pauerchar_t ccp = NULL;
1357 struct usb_interface *intf;
1360 /* minor number in range? */
1364 intf = usb_find_interface(&auerswald_driver, dtindex);
1369 /* usb device available? */
1370 cp = usb_get_intfdata (intf);
1374 if (down_interruptible (&cp->mutex)) {
1375 return -ERESTARTSYS;
1378 /* we have access to the device. Now lets allocate memory */
1379 ccp = (pauerchar_t) kmalloc(sizeof(auerchar_t), GFP_KERNEL);
1381 err ("out of memory");
1386 /* Initialize device descriptor */
1387 memset( ccp, 0, sizeof(auerchar_t));
1388 init_MUTEX( &ccp->mutex);
1389 init_MUTEX( &ccp->readmutex);
1390 auerbuf_init (&ccp->bufctl);
1391 ccp->scontext.id = AUH_UNASSIGNED;
1392 ccp->scontext.dispatch = auerchar_ctrlread_dispatch;
1393 ccp->scontext.disconnect = auerchar_disconnect;
1394 init_waitqueue_head (&ccp->readwait);
1396 ret = auerbuf_setup (&ccp->bufctl, AU_RBUFFERS, cp->maxControlLength+AUH_SIZE);
1403 dbg("open %s as /dev/%s", cp->dev_desc, cp->name);
1408 file->private_data = ccp;
1409 return nonseekable_open(inode, file);
1412 ofail: up (&cp->mutex);
1413 auerchar_delete (ccp);
1418 /* IOCTL functions */
1419 static int auerchar_ioctl (struct inode *inode, struct file *file, unsigned int cmd, unsigned long arg)
1421 pauerchar_t ccp = (pauerchar_t) file->private_data;
1423 audevinfo_t devinfo;
1424 pauerswald_t cp = NULL;
1426 unsigned int __user *user_arg = (unsigned int __user *)arg;
1430 /* get the mutexes */
1431 if (down_interruptible (&ccp->mutex)) {
1432 return -ERESTARTSYS;
1439 if (down_interruptible (&cp->mutex)) {
1441 return -ERESTARTSYS;
1444 /* Check for removal */
1453 /* return != 0 if Transmitt channel ready to send */
1454 case IOCTL_AU_TXREADY:
1455 dbg ("IOCTL_AU_TXREADY");
1457 && (ccp->scontext.id != AUH_UNASSIGNED)
1458 && !list_empty (&cp->bufctl.free_buff_list);
1459 ret = put_user (u, user_arg);
1462 /* return != 0 if connected to a service channel */
1463 case IOCTL_AU_CONNECT:
1464 dbg ("IOCTL_AU_CONNECT");
1465 u = (ccp->scontext.id != AUH_UNASSIGNED);
1466 ret = put_user (u, user_arg);
1469 /* return != 0 if Receive Data available */
1470 case IOCTL_AU_RXAVAIL:
1471 dbg ("IOCTL_AU_RXAVAIL");
1472 if (ccp->scontext.id == AUH_UNASSIGNED) {
1476 u = 0; /* no data */
1478 int restlen = ccp->readbuf->len - ccp->readoffset;
1483 if (!list_empty (&ccp->bufctl.rec_buff_list)) {
1487 ret = put_user (u, user_arg);
1490 /* return the max. buffer length for the device */
1491 case IOCTL_AU_BUFLEN:
1492 dbg ("IOCTL_AU_BUFLEN");
1493 u = cp->maxControlLength;
1494 ret = put_user (u, user_arg);
1497 /* requesting a service channel */
1498 case IOCTL_AU_SERVREQ:
1499 dbg ("IOCTL_AU_SERVREQ");
1500 /* requesting a service means: release the previous one first */
1501 auerswald_removeservice (cp, &ccp->scontext);
1502 /* get the channel number */
1503 ret = get_user (u, user_arg);
1507 if ((u < AUH_FIRSTUSERCH) || (u >= AUH_TYPESIZE)) {
1511 dbg ("auerchar service request parameters are ok");
1512 ccp->scontext.id = u;
1514 /* request the service now */
1515 ret = auerswald_addservice (cp, &ccp->scontext);
1517 /* no: revert service entry */
1518 ccp->scontext.id = AUH_UNASSIGNED;
1522 /* get a string descriptor for the device */
1523 case IOCTL_AU_DEVINFO:
1524 dbg ("IOCTL_AU_DEVINFO");
1525 if (copy_from_user (&devinfo, (void __user *) arg, sizeof (audevinfo_t))) {
1529 u = strlen(cp->dev_desc)+1;
1530 if (u > devinfo.bsize) {
1533 ret = copy_to_user(devinfo.buf, cp->dev_desc, u) ? -EFAULT : 0;
1536 /* get the max. string descriptor length */
1538 dbg ("IOCTL_AU_SLEN");
1540 ret = put_user (u, user_arg);
1544 dbg ("IOCTL_AU_UNKNOWN");
1548 /* release the mutexes */
1554 /* Read data from the device */
1555 static ssize_t auerchar_read (struct file *file, char __user *buf, size_t count, loff_t * ppos)
1557 unsigned long flags;
1558 pauerchar_t ccp = (pauerchar_t) file->private_data;
1559 pauerbuf_t bp = NULL;
1562 dbg ("auerchar_read");
1564 /* Error checking */
1573 if (down_interruptible (&ccp->mutex))
1574 return -ERESTARTSYS;
1576 /* Can we expect to read something? */
1577 if (ccp->scontext.id == AUH_UNASSIGNED) {
1582 /* only one reader per device allowed */
1583 if (down_interruptible (&ccp->readmutex)) {
1585 return -ERESTARTSYS;
1588 /* read data from readbuf, if available */
1592 /* read the maximum bytes */
1593 int restlen = bp->len - ccp->readoffset;
1596 if (count > restlen)
1599 if (copy_to_user (buf, bp->bufp+ccp->readoffset, count)) {
1600 dbg ("auerswald_read: copy_to_user failed");
1601 up (&ccp->readmutex);
1606 /* advance the read offset */
1607 ccp->readoffset += count;
1609 // reuse the read buffer
1611 auerbuf_releasebuf (bp);
1612 ccp->readbuf = NULL;
1614 /* return with number of bytes read */
1616 up (&ccp->readmutex);
1622 /* a read buffer is not available. Try to get the next data block. */
1624 /* Preparing for sleep */
1625 init_waitqueue_entry (&wait, current);
1626 set_current_state (TASK_INTERRUPTIBLE);
1627 add_wait_queue (&ccp->readwait, &wait);
1630 spin_lock_irqsave (&ccp->bufctl.lock, flags);
1631 if (!list_empty (&ccp->bufctl.rec_buff_list)) {
1632 /* yes: get the entry */
1633 struct list_head *tmp = ccp->bufctl.rec_buff_list.next;
1635 bp = list_entry (tmp, auerbuf_t, buff_list);
1637 spin_unlock_irqrestore (&ccp->bufctl.lock, flags);
1639 /* have we got data? */
1642 ccp->readoffset = AUH_SIZE; /* for headerbyte */
1643 set_current_state (TASK_RUNNING);
1644 remove_wait_queue (&ccp->readwait, &wait);
1645 goto doreadbuf; /* now we can read! */
1648 /* no data available. Should we wait? */
1649 if (file->f_flags & O_NONBLOCK) {
1650 dbg ("No read buffer available, returning -EAGAIN");
1651 set_current_state (TASK_RUNNING);
1652 remove_wait_queue (&ccp->readwait, &wait);
1653 up (&ccp->readmutex);
1655 return -EAGAIN; /* nonblocking, no data available */
1658 /* yes, we should wait! */
1659 up (&ccp->mutex); /* allow other operations while we wait */
1661 remove_wait_queue (&ccp->readwait, &wait);
1662 if (signal_pending (current)) {
1663 /* waked up by a signal */
1664 up (&ccp->readmutex);
1665 return -ERESTARTSYS;
1668 /* Anything left to read? */
1669 if ((ccp->scontext.id == AUH_UNASSIGNED) || ccp->removed) {
1670 up (&ccp->readmutex);
1674 if (down_interruptible (&ccp->mutex)) {
1675 up (&ccp->readmutex);
1676 return -ERESTARTSYS;
1679 /* try to read the incoming data again */
1684 /* Write a data block into the right service channel of the device */
1685 static ssize_t auerchar_write (struct file *file, const char __user *buf, size_t len, loff_t *ppos)
1687 pauerchar_t ccp = (pauerchar_t) file->private_data;
1688 pauerswald_t cp = NULL;
1690 unsigned long flags;
1694 dbg ("auerchar_write %zd bytes", len);
1696 /* Error checking */
1706 if (down_interruptible (&ccp->mutex))
1707 return -ERESTARTSYS;
1709 /* Can we expect to write something? */
1710 if (ccp->scontext.id == AUH_UNASSIGNED) {
1718 return -ERESTARTSYS;
1720 if (down_interruptible (&cp->mutex)) {
1722 return -ERESTARTSYS;
1729 /* Prepare for sleep */
1730 init_waitqueue_entry (&wait, current);
1731 set_current_state (TASK_INTERRUPTIBLE);
1732 add_wait_queue (&cp->bufferwait, &wait);
1734 /* Try to get a buffer from the device pool.
1735 We can't use a buffer from ccp->bufctl because the write
1736 command will last beond a release() */
1738 spin_lock_irqsave (&cp->bufctl.lock, flags);
1739 if (!list_empty (&cp->bufctl.free_buff_list)) {
1740 /* yes: get the entry */
1741 struct list_head *tmp = cp->bufctl.free_buff_list.next;
1743 bp = list_entry (tmp, auerbuf_t, buff_list);
1745 spin_unlock_irqrestore (&cp->bufctl.lock, flags);
1747 /* are there any buffers left? */
1752 /* NONBLOCK: don't wait */
1753 if (file->f_flags & O_NONBLOCK) {
1754 set_current_state (TASK_RUNNING);
1755 remove_wait_queue (&cp->bufferwait, &wait);
1759 /* BLOCKING: wait */
1761 remove_wait_queue (&cp->bufferwait, &wait);
1762 if (signal_pending (current)) {
1763 /* waked up by a signal */
1764 return -ERESTARTSYS;
1768 set_current_state (TASK_RUNNING);
1769 remove_wait_queue (&cp->bufferwait, &wait);
1772 /* protect against too big write requests */
1773 if (len > cp->maxControlLength)
1774 len = cp->maxControlLength;
1776 /* Fill the buffer */
1777 if (copy_from_user ( bp->bufp+AUH_SIZE, buf, len)) {
1778 dbg ("copy_from_user failed");
1779 auerbuf_releasebuf (bp);
1780 /* Wake up all processes waiting for a buffer */
1781 wake_up (&cp->bufferwait);
1787 /* set the header byte */
1788 *(bp->bufp) = ccp->scontext.id | AUH_DIRECT | AUH_UNSPLIT;
1790 /* Set the transfer Parameters */
1791 bp->len = len+AUH_SIZE;
1792 bp->dr->bRequestType = AUT_WREQ;
1793 bp->dr->bRequest = AUV_WBLOCK;
1794 bp->dr->wValue = cpu_to_le16 (0);
1795 bp->dr->wIndex = cpu_to_le16 (ccp->scontext.id | AUH_DIRECT | AUH_UNSPLIT);
1796 bp->dr->wLength = cpu_to_le16 (len+AUH_SIZE);
1797 usb_fill_control_urb (bp->urbp, cp->usbdev, usb_sndctrlpipe (cp->usbdev, 0),
1798 (unsigned char*)bp->dr, bp->bufp, len+AUH_SIZE,
1799 auerchar_ctrlwrite_complete, bp);
1801 ret = auerchain_submit_urb (&cp->controlchain, bp->urbp);
1804 dbg ("auerchar_write: nonzero result of auerchain_submit_urb %d", ret);
1805 auerbuf_releasebuf (bp);
1806 /* Wake up all processes waiting for a buffer */
1807 wake_up (&cp->bufferwait);
1812 dbg ("auerchar_write: Write OK");
1819 /* Close a character device */
1820 static int auerchar_release (struct inode *inode, struct file *file)
1822 pauerchar_t ccp = (pauerchar_t) file->private_data;
1826 /* get the mutexes */
1827 if (down_interruptible (&ccp->mutex)) {
1828 return -ERESTARTSYS;
1832 if (down_interruptible (&cp->mutex)) {
1834 return -ERESTARTSYS;
1836 /* remove an open service */
1837 auerswald_removeservice (cp, &ccp->scontext);
1838 /* detach from device */
1839 if ((--cp->open_count <= 0) && (cp->usbdev == NULL)) {
1840 /* usb device waits for removal */
1842 auerswald_delete (cp);
1847 ccp->auerdev = NULL;
1850 auerchar_delete (ccp);
1856 /*----------------------------------------------------------------------*/
1857 /* File operation structure */
1858 static const struct file_operations auerswald_fops =
1860 .owner = THIS_MODULE,
1861 .llseek = no_llseek,
1862 .read = auerchar_read,
1863 .write = auerchar_write,
1864 .ioctl = auerchar_ioctl,
1865 .open = auerchar_open,
1866 .release = auerchar_release,
1869 static struct usb_class_driver auerswald_class = {
1871 .fops = &auerswald_fops,
1872 .minor_base = AUER_MINOR_BASE,
1876 /* --------------------------------------------------------------------- */
1877 /* Special USB driver functions */
1879 /* Probe if this driver wants to serve an USB device
1881 This entry point is called whenever a new device is attached to the bus.
1882 Then the device driver has to create a new instance of its internal data
1883 structures for the new device.
1885 The dev argument specifies the device context, which contains pointers
1886 to all USB descriptors. The interface argument specifies the interface
1887 number. If a USB driver wants to bind itself to a particular device and
1888 interface it has to return a pointer. This pointer normally references
1889 the device driver's context structure.
1891 Probing normally is done by checking the vendor and product identifications
1892 or the class and subclass definitions. If they match the interface number
1893 is compared with the ones supported by the driver. When probing is done
1894 class based it might be necessary to parse some more USB descriptors because
1895 the device properties can differ in a wide range.
1897 static int auerswald_probe (struct usb_interface *intf,
1898 const struct usb_device_id *id)
1900 struct usb_device *usbdev = interface_to_usbdev(intf);
1901 pauerswald_t cp = NULL;
1906 dbg ("probe: vendor id 0x%x, device id 0x%x",
1907 le16_to_cpu(usbdev->descriptor.idVendor),
1908 le16_to_cpu(usbdev->descriptor.idProduct));
1910 /* we use only the first -and only- interface */
1911 if (intf->altsetting->desc.bInterfaceNumber != 0)
1914 /* allocate memory for our device and initialize it */
1915 cp = kmalloc (sizeof(auerswald_t), GFP_KERNEL);
1917 err ("out of memory");
1921 /* Initialize device descriptor */
1922 memset (cp, 0, sizeof(auerswald_t));
1923 init_MUTEX (&cp->mutex);
1924 cp->usbdev = usbdev;
1925 auerchain_init (&cp->controlchain);
1926 auerbuf_init (&cp->bufctl);
1927 init_waitqueue_head (&cp->bufferwait);
1929 ret = usb_register_dev(intf, &auerswald_class);
1931 err ("Not able to get a minor for this device.");
1935 /* Give the device a name */
1936 sprintf (cp->name, "usb/auer%d", intf->minor);
1938 /* Store the index */
1939 cp->dtindex = intf->minor;
1941 /* Get the usb version of the device */
1942 cp->version = le16_to_cpu(cp->usbdev->descriptor.bcdDevice);
1943 dbg ("Version is %X", cp->version);
1945 /* allow some time to settle the device */
1948 /* Try to get a suitable textual description of the device */
1950 ret = usb_string( cp->usbdev, AUSI_DEVICE, cp->dev_desc, AUSI_DLEN-1);
1953 /* Append Serial Number */
1954 memcpy(&cp->dev_desc[u], ",Ser# ", 6);
1956 ret = usb_string( cp->usbdev, AUSI_SERIALNR, &cp->dev_desc[u], AUSI_DLEN-u-1);
1959 /* Append subscriber number */
1960 memcpy(&cp->dev_desc[u], ", ", 2);
1962 ret = usb_string( cp->usbdev, AUSI_MSN, &cp->dev_desc[u], AUSI_DLEN-u-1);
1968 cp->dev_desc[u] = '\0';
1969 info("device is a %s", cp->dev_desc);
1971 /* get the maximum allowed control transfer length */
1972 pbuf = (__le16 *) kmalloc (2, GFP_KERNEL); /* use an allocated buffer because of urb target */
1974 err( "out of memory");
1977 ret = usb_control_msg(cp->usbdev, /* pointer to device */
1978 usb_rcvctrlpipe( cp->usbdev, 0 ), /* pipe to control endpoint */
1979 AUV_GETINFO, /* USB message request value */
1980 AUT_RREQ, /* USB message request type value */
1981 0, /* USB message value */
1982 AUDI_MBCTRANS, /* USB message index value */
1983 pbuf, /* pointer to the receive buffer */
1984 2, /* length of the buffer */
1985 2000); /* time to wait for the message to complete before timing out */
1987 cp->maxControlLength = le16_to_cpup(pbuf);
1989 dbg("setup: max. allowed control transfersize is %d bytes", cp->maxControlLength);
1992 err("setup: getting max. allowed control transfer length failed with error %d", ret);
1996 /* allocate a chain for the control messages */
1997 if (auerchain_setup (&cp->controlchain, AUCH_ELEMENTS)) {
1998 err ("out of memory");
2002 /* allocate buffers for control messages */
2003 if (auerbuf_setup (&cp->bufctl, AU_RBUFFERS, cp->maxControlLength+AUH_SIZE)) {
2004 err ("out of memory");
2008 /* start the interrupt endpoint */
2009 if (auerswald_int_open (cp)) {
2010 err ("int endpoint failed");
2015 usb_set_intfdata (intf, cp);
2018 /* Error exit: clean up the memory */
2019 pfail: auerswald_delete (cp);
2024 /* Disconnect driver from a served device
2026 This function is called whenever a device which was served by this driver
2029 The argument dev specifies the device context and the driver_context
2030 returns a pointer to the previously registered driver_context of the
2031 probe function. After returning from the disconnect function the USB
2032 framework completely deallocates all data structures associated with
2033 this device. So especially the usb_device structure must not be used
2034 any longer by the usb driver.
2036 static void auerswald_disconnect (struct usb_interface *intf)
2038 pauerswald_t cp = usb_get_intfdata (intf);
2041 usb_set_intfdata (intf, NULL);
2046 info ("device /dev/%s now disconnecting", cp->name);
2048 /* give back our USB minor number */
2049 usb_deregister_dev(intf, &auerswald_class);
2051 /* Stop the interrupt endpoint */
2052 auerswald_int_release (cp);
2054 /* remove the control chain allocated in auerswald_probe
2055 This has the benefit of
2056 a) all pending (a)synchronous urbs are unlinked
2057 b) all buffers dealing with urbs are reclaimed
2059 auerchain_free (&cp->controlchain);
2061 if (cp->open_count == 0) {
2062 /* nobody is using this device. So we can clean up now */
2063 up (&cp->mutex);/* up() is possible here because no other task
2064 can open the device (see above). I don't want
2065 to kfree() a locked mutex. */
2066 auerswald_delete (cp);
2068 /* device is used. Remove the pointer to the
2069 usb device (it's not valid any more). The last
2070 release() will do the clean up */
2073 /* Terminate waiting writers */
2074 wake_up (&cp->bufferwait);
2075 /* Inform all waiting readers */
2076 for ( u = 0; u < AUH_TYPESIZE; u++) {
2077 pauerscon_t scp = cp->services[u];
2079 scp->disconnect( scp);
2084 /* Descriptor for the devices which are served by this driver.
2085 NOTE: this struct is parsed by the usbmanager install scripts.
2086 Don't change without caution!
2088 static struct usb_device_id auerswald_ids [] = {
2089 { USB_DEVICE (ID_AUERSWALD, 0x00C0) }, /* COMpact 2104 USB */
2090 { USB_DEVICE (ID_AUERSWALD, 0x00DB) }, /* COMpact 4410/2206 USB */
2091 { USB_DEVICE (ID_AUERSWALD, 0x00DC) }, /* COMpact 4406 DSL */
2092 { USB_DEVICE (ID_AUERSWALD, 0x00DD) }, /* COMpact 2204 USB */
2093 { USB_DEVICE (ID_AUERSWALD, 0x00F1) }, /* Comfort 2000 System Telephone */
2094 { USB_DEVICE (ID_AUERSWALD, 0x00F2) }, /* Comfort 1200 System Telephone */
2095 { } /* Terminating entry */
2098 /* Standard module device table */
2099 MODULE_DEVICE_TABLE (usb, auerswald_ids);
2101 /* Standard usb driver struct */
2102 static struct usb_driver auerswald_driver = {
2103 .name = "auerswald",
2104 .probe = auerswald_probe,
2105 .disconnect = auerswald_disconnect,
2106 .id_table = auerswald_ids,
2110 /* --------------------------------------------------------------------- */
2111 /* Module loading/unloading */
2113 /* Driver initialisation. Called after module loading.
2114 NOTE: there is no concurrency at _init
2116 static int __init auerswald_init (void)
2121 /* register driver at the USB subsystem */
2122 result = usb_register (&auerswald_driver);
2124 err ("driver could not be registered");
2130 /* Driver deinit. Called before module removal.
2131 NOTE: there is no concurrency at _cleanup
2133 static void __exit auerswald_cleanup (void)
2136 usb_deregister (&auerswald_driver);
2139 /* --------------------------------------------------------------------- */
2140 /* Linux device driver module description */
2142 MODULE_AUTHOR (DRIVER_AUTHOR);
2143 MODULE_DESCRIPTION (DRIVER_DESC);
2144 MODULE_LICENSE ("GPL");
2146 module_init (auerswald_init);
2147 module_exit (auerswald_cleanup);
2149 /* --------------------------------------------------------------------- */