1 /*****************************************************************************
5 * Description: IrDA-USB Driver
7 * Author: Dag Brattli <dag@brattli.net>
9 * Copyright (C) 2000, Roman Weissgaerber <weissg@vienna.at>
10 * Copyright (C) 2001, Dag Brattli <dag@brattli.net>
11 * Copyright (C) 2001, Jean Tourrilhes <jt@hpl.hp.com>
12 * Copyright (C) 2004, SigmaTel, Inc. <irquality@sigmatel.com>
13 * Copyright (C) 2005, Milan Beno <beno@pobox.sk>
14 * Copyright (C) 2006, Nick Fedchik <nick@fedchik.org.ua>
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation; either version 2 of the License, or
19 * (at your option) any later version.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
26 * You should have received a copy of the GNU General Public License
27 * along with this program; if not, write to the Free Software
28 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
30 *****************************************************************************/
36 * As of kernel 2.5.20, this is the state of compliance and testing of
37 * this driver (irda-usb) with regards to the USB low level drivers...
39 * This driver has been tested SUCCESSFULLY with the following drivers :
40 * o usb-uhci-hcd (For Intel/Via USB controllers)
41 * o uhci-hcd (Alternate/JE driver for Intel/Via USB controllers)
42 * o ohci-hcd (For other USB controllers)
44 * This driver has NOT been tested with the following drivers :
45 * o ehci-hcd (USB 2.0 controllers)
47 * Note that all HCD drivers do URB_ZERO_PACKET and timeout properly,
48 * so we don't have to worry about that anymore.
49 * One common problem is the failure to set the address on the dongle,
50 * but this happens before the driver gets loaded...
55 /*------------------------------------------------------------------*/
57 #include <linux/module.h>
58 #include <linux/moduleparam.h>
59 #include <linux/kernel.h>
60 #include <linux/types.h>
61 #include <linux/init.h>
62 #include <linux/skbuff.h>
63 #include <linux/netdevice.h>
64 #include <linux/slab.h>
65 #include <linux/rtnetlink.h>
66 #include <linux/usb.h>
67 #include <linux/firmware.h>
71 /*------------------------------------------------------------------*/
73 static int qos_mtt_bits = 0;
75 /* These are the currently known IrDA USB dongles. Add new dongles here */
76 static struct usb_device_id dongles[] = {
77 /* ACTiSYS Corp., ACT-IR2000U FIR-USB Adapter */
78 { USB_DEVICE(0x9c4, 0x011), .driver_info = IUC_SPEED_BUG | IUC_NO_WINDOW },
79 /* Look like ACTiSYS, Report : IBM Corp., IBM UltraPort IrDA */
80 { USB_DEVICE(0x4428, 0x012), .driver_info = IUC_SPEED_BUG | IUC_NO_WINDOW },
81 /* KC Technology Inc., KC-180 USB IrDA Device */
82 { USB_DEVICE(0x50f, 0x180), .driver_info = IUC_SPEED_BUG | IUC_NO_WINDOW },
83 /* Extended Systems, Inc., XTNDAccess IrDA USB (ESI-9685) */
84 { USB_DEVICE(0x8e9, 0x100), .driver_info = IUC_SPEED_BUG | IUC_NO_WINDOW },
85 /* SigmaTel STIR4210/4220/4116 USB IrDA (VFIR) Bridge */
86 { USB_DEVICE(0x66f, 0x4210), .driver_info = IUC_STIR421X | IUC_SPEED_BUG },
87 { USB_DEVICE(0x66f, 0x4220), .driver_info = IUC_STIR421X | IUC_SPEED_BUG },
88 { USB_DEVICE(0x66f, 0x4116), .driver_info = IUC_STIR421X | IUC_SPEED_BUG },
89 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS |
90 USB_DEVICE_ID_MATCH_INT_SUBCLASS,
91 .bInterfaceClass = USB_CLASS_APP_SPEC,
92 .bInterfaceSubClass = USB_CLASS_IRDA,
93 .driver_info = IUC_DEFAULT, },
99 * Devices based on the SigmaTel chipset (0x66f, 0x4200) are not designed
100 * using the "USB-IrDA specification" (yes, there exist such a thing), and
101 * therefore not supported by this driver (don't add them above).
102 * There is a Linux driver, stir4200, that support those USB devices.
106 MODULE_DEVICE_TABLE(usb, dongles);
108 /*------------------------------------------------------------------*/
110 static void irda_usb_init_qos(struct irda_usb_cb *self) ;
111 static struct irda_class_desc *irda_usb_find_class_desc(struct usb_interface *intf);
112 static void irda_usb_disconnect(struct usb_interface *intf);
113 static void irda_usb_change_speed_xbofs(struct irda_usb_cb *self);
114 static int irda_usb_hard_xmit(struct sk_buff *skb, struct net_device *dev);
115 static int irda_usb_open(struct irda_usb_cb *self);
116 static void irda_usb_close(struct irda_usb_cb *self);
117 static void speed_bulk_callback(struct urb *urb);
118 static void write_bulk_callback(struct urb *urb);
119 static void irda_usb_receive(struct urb *urb);
120 static void irda_usb_rx_defer_expired(unsigned long data);
121 static int irda_usb_net_open(struct net_device *dev);
122 static int irda_usb_net_close(struct net_device *dev);
123 static int irda_usb_net_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
124 static void irda_usb_net_timeout(struct net_device *dev);
125 static struct net_device_stats *irda_usb_net_get_stats(struct net_device *dev);
127 /************************ TRANSMIT ROUTINES ************************/
129 * Receive packets from the IrDA stack and send them on the USB pipe.
130 * Handle speed change, timeout and lot's of ugliness...
133 /*------------------------------------------------------------------*/
135 * Function irda_usb_build_header(self, skb, header)
137 * Builds USB-IrDA outbound header
139 * When we send an IrDA frame over an USB pipe, we add to it a 1 byte
140 * header. This function create this header with the proper values.
142 * Important note : the USB-IrDA spec 1.0 say very clearly in chapter 5.4.2.2
143 * that the setting of the link speed and xbof number in this outbound header
144 * should be applied *AFTER* the frame has been sent.
145 * Unfortunately, some devices are not compliant with that... It seems that
146 * reading the spec is far too difficult...
149 static void irda_usb_build_header(struct irda_usb_cb *self,
153 /* Here we check if we have an STIR421x chip,
154 * and if either speed or xbofs (or both) needs
157 if (self->capability & IUC_STIR421X &&
158 ((self->new_speed != -1) || (self->new_xbofs != -1))) {
160 /* With STIR421x, speed and xBOFs must be set at the same
161 * time, even if only one of them changes.
163 if (self->new_speed == -1)
164 self->new_speed = self->speed ;
166 if (self->new_xbofs == -1)
167 self->new_xbofs = self->xbofs ;
170 /* Set the link speed */
171 if (self->new_speed != -1) {
172 /* Hum... Ugly hack :-(
173 * Some device are not compliant with the spec and change
174 * parameters *before* sending the frame. - Jean II
176 if ((self->capability & IUC_SPEED_BUG) &&
177 (!force) && (self->speed != -1)) {
178 /* No speed and xbofs change here
179 * (we'll do it later in the write callback) */
180 IRDA_DEBUG(2, "%s(), not changing speed yet\n", __func__);
185 IRDA_DEBUG(2, "%s(), changing speed to %d\n", __func__, self->new_speed);
186 self->speed = self->new_speed;
187 /* We will do ` self->new_speed = -1; ' in the completion
188 * handler just in case the current URB fail - Jean II */
190 switch (self->speed) {
192 *header = SPEED_2400;
196 *header = SPEED_9600;
199 *header = SPEED_19200;
202 *header = SPEED_38400;
205 *header = SPEED_57600;
208 *header = SPEED_115200;
211 *header = SPEED_576000;
214 *header = SPEED_1152000;
217 *header = SPEED_4000000;
221 *header = SPEED_16000000;
229 /* Set the negotiated additional XBOFS */
230 if (self->new_xbofs != -1) {
231 IRDA_DEBUG(2, "%s(), changing xbofs to %d\n", __func__, self->new_xbofs);
232 self->xbofs = self->new_xbofs;
233 /* We will do ` self->new_xbofs = -1; ' in the completion
234 * handler just in case the current URB fail - Jean II */
236 switch (self->xbofs) {
241 case 24: /* USB spec 1.0 says 24 */
248 case 5: /* Bug in IrLAP spec? (should be 6) */
269 * calculate turnaround time for SigmaTel header
271 static __u8 get_turnaround_time(struct sk_buff *skb)
273 int turnaround_time = irda_get_mtt(skb);
275 if ( turnaround_time == 0 )
277 else if ( turnaround_time <= 10 )
279 else if ( turnaround_time <= 50 )
281 else if ( turnaround_time <= 100 )
283 else if ( turnaround_time <= 500 )
285 else if ( turnaround_time <= 1000 )
287 else if ( turnaround_time <= 5000 )
294 /*------------------------------------------------------------------*/
296 * Send a command to change the speed of the dongle
297 * Need to be called with spinlock on.
299 static void irda_usb_change_speed_xbofs(struct irda_usb_cb *self)
305 IRDA_DEBUG(2, "%s(), speed=%d, xbofs=%d\n", __func__,
306 self->new_speed, self->new_xbofs);
308 /* Grab the speed URB */
309 urb = self->speed_urb;
310 if (urb->status != 0) {
311 IRDA_WARNING("%s(), URB still in use!\n", __func__);
315 /* Allocate the fake frame */
316 frame = self->speed_buff;
318 /* Set the new speed and xbofs in this fake frame */
319 irda_usb_build_header(self, frame, 1);
321 if (self->capability & IUC_STIR421X) {
322 if (frame[0] == 0) return ; // do nothing if no change
323 frame[1] = 0; // other parameters don't change here
327 /* Submit the 0 length IrDA frame to trigger new speed settings */
328 usb_fill_bulk_urb(urb, self->usbdev,
329 usb_sndbulkpipe(self->usbdev, self->bulk_out_ep),
330 frame, IRDA_USB_SPEED_MTU,
331 speed_bulk_callback, self);
332 urb->transfer_buffer_length = self->header_length;
333 urb->transfer_flags = 0;
335 /* Irq disabled -> GFP_ATOMIC */
336 if ((ret = usb_submit_urb(urb, GFP_ATOMIC))) {
337 IRDA_WARNING("%s(), failed Speed URB\n", __func__);
341 /*------------------------------------------------------------------*/
344 * Now, we can only get called for the speed URB.
346 static void speed_bulk_callback(struct urb *urb)
348 struct irda_usb_cb *self = urb->context;
350 IRDA_DEBUG(2, "%s()\n", __func__);
352 /* We should always have a context */
353 IRDA_ASSERT(self != NULL, return;);
354 /* We should always be called for the speed URB */
355 IRDA_ASSERT(urb == self->speed_urb, return;);
357 /* Check for timeout and other USB nasties */
358 if (urb->status != 0) {
359 /* I get a lot of -ECONNABORTED = -103 here - Jean II */
360 IRDA_DEBUG(0, "%s(), URB complete status %d, transfer_flags 0x%04X\n", __func__, urb->status, urb->transfer_flags);
362 /* Don't do anything here, that might confuse the USB layer.
363 * Instead, we will wait for irda_usb_net_timeout(), the
364 * network layer watchdog, to fix the situation.
366 /* A reset of the dongle might be welcomed here - Jean II */
370 /* urb is now available */
371 //urb->status = 0; -> tested above
373 /* New speed and xbof is now commited in hardware */
374 self->new_speed = -1;
375 self->new_xbofs = -1;
377 /* Allow the stack to send more packets */
378 netif_wake_queue(self->netdev);
381 /*------------------------------------------------------------------*/
383 * Send an IrDA frame to the USB dongle (for transmission)
385 static int irda_usb_hard_xmit(struct sk_buff *skb, struct net_device *netdev)
387 struct irda_usb_cb *self = netdev_priv(netdev);
388 struct urb *urb = self->tx_urb;
393 int err = 1; /* Failed */
395 IRDA_DEBUG(4, "%s() on %s\n", __func__, netdev->name);
397 netif_stop_queue(netdev);
399 /* Protect us from USB callbacks, net watchdog and else. */
400 spin_lock_irqsave(&self->lock, flags);
402 /* Check if the device is still there.
403 * We need to check self->present under the spinlock because
404 * of irda_usb_disconnect() is synchronous - Jean II */
405 if (!self->present) {
406 IRDA_DEBUG(0, "%s(), Device is gone...\n", __func__);
410 /* Check if we need to change the number of xbofs */
411 xbofs = irda_get_next_xbofs(skb);
412 if ((xbofs != self->xbofs) && (xbofs != -1)) {
413 self->new_xbofs = xbofs;
416 /* Check if we need to change the speed */
417 speed = irda_get_next_speed(skb);
418 if ((speed != self->speed) && (speed != -1)) {
419 /* Set the desired speed */
420 self->new_speed = speed;
422 /* Check for empty frame */
424 /* IrLAP send us an empty frame to make us change the
425 * speed. Changing speed with the USB adapter is in
426 * fact sending an empty frame to the adapter, so we
427 * could just let the present function do its job.
428 * However, we would wait for min turn time,
429 * do an extra memcpy and increment packet counters...
431 irda_usb_change_speed_xbofs(self);
432 netdev->trans_start = jiffies;
433 /* Will netif_wake_queue() in callback */
434 err = 0; /* No error */
439 if (urb->status != 0) {
440 IRDA_WARNING("%s(), URB still in use!\n", __func__);
444 skb_copy_from_linear_data(skb, self->tx_buff + self->header_length, skb->len);
446 /* Change setting for next frame */
447 if (self->capability & IUC_STIR421X) {
448 __u8 turnaround_time;
449 __u8* frame = self->tx_buff;
450 turnaround_time = get_turnaround_time( skb );
451 irda_usb_build_header(self, frame, 0);
452 frame[2] = turnaround_time;
453 if ((skb->len != 0) &&
454 ((skb->len % 128) == 0) &&
455 ((skb->len % 512) != 0)) {
456 /* add extra byte for special SigmaTel feature */
463 irda_usb_build_header(self, self->tx_buff, 0);
466 /* FIXME: Make macro out of this one */
467 ((struct irda_skb_cb *)skb->cb)->context = self;
469 usb_fill_bulk_urb(urb, self->usbdev,
470 usb_sndbulkpipe(self->usbdev, self->bulk_out_ep),
471 self->tx_buff, skb->len + self->header_length,
472 write_bulk_callback, skb);
474 /* This flag (URB_ZERO_PACKET) indicates that what we send is not
475 * a continuous stream of data but separate packets.
476 * In this case, the USB layer will insert an empty USB frame (TD)
477 * after each of our packets that is exact multiple of the frame size.
478 * This is how the dongle will detect the end of packet - Jean II */
479 urb->transfer_flags = URB_ZERO_PACKET;
481 /* Generate min turn time. FIXME: can we do better than this? */
482 /* Trying to a turnaround time at this level is trying to measure
483 * processor clock cycle with a wrist-watch, approximate at best...
485 * What we know is the last time we received a frame over USB.
486 * Due to latency over USB that depend on the USB load, we don't
487 * know when this frame was received over IrDA (a few ms before ?)
488 * Then, same story for our outgoing frame...
490 * In theory, the USB dongle is supposed to handle the turnaround
491 * by itself (spec 1.0, chater 4, page 6). Who knows ??? That's
492 * why this code is enabled only for dongles that doesn't meet
495 if (self->capability & IUC_NO_TURN) {
496 mtt = irda_get_mtt(skb);
499 do_gettimeofday(&self->now);
500 diff = self->now.tv_usec - self->stamp.tv_usec;
501 #ifdef IU_USB_MIN_RTT
502 /* Factor in USB delays -> Get rid of udelay() that
503 * would be lost in the noise - Jean II */
504 diff += IU_USB_MIN_RTT;
505 #endif /* IU_USB_MIN_RTT */
506 /* If the usec counter did wraparound, the diff will
507 * go negative (tv_usec is a long), so we need to
508 * correct it by one second. Jean II */
512 /* Check if the mtt is larger than the time we have
513 * already used by all the protocol processing
525 /* Ask USB to send the packet - Irq disabled -> GFP_ATOMIC */
526 if ((res = usb_submit_urb(urb, GFP_ATOMIC))) {
527 IRDA_WARNING("%s(), failed Tx URB\n", __func__);
528 self->stats.tx_errors++;
529 /* Let USB recover : We will catch that in the watchdog */
530 /*netif_start_queue(netdev);*/
532 /* Increment packet stats */
533 self->stats.tx_packets++;
534 self->stats.tx_bytes += skb->len;
536 netdev->trans_start = jiffies;
538 spin_unlock_irqrestore(&self->lock, flags);
543 /* Drop silently the skb and exit */
545 spin_unlock_irqrestore(&self->lock, flags);
546 return err; /* Usually 1 */
549 /*------------------------------------------------------------------*/
551 * Note : this function will be called only for tx_urb...
553 static void write_bulk_callback(struct urb *urb)
556 struct sk_buff *skb = urb->context;
557 struct irda_usb_cb *self = ((struct irda_skb_cb *) skb->cb)->context;
559 IRDA_DEBUG(2, "%s()\n", __func__);
561 /* We should always have a context */
562 IRDA_ASSERT(self != NULL, return;);
563 /* We should always be called for the speed URB */
564 IRDA_ASSERT(urb == self->tx_urb, return;);
566 /* Free up the skb */
567 dev_kfree_skb_any(skb);
570 /* Check for timeout and other USB nasties */
571 if (urb->status != 0) {
572 /* I get a lot of -ECONNABORTED = -103 here - Jean II */
573 IRDA_DEBUG(0, "%s(), URB complete status %d, transfer_flags 0x%04X\n", __func__, urb->status, urb->transfer_flags);
575 /* Don't do anything here, that might confuse the USB layer,
576 * and we could go in recursion and blow the kernel stack...
577 * Instead, we will wait for irda_usb_net_timeout(), the
578 * network layer watchdog, to fix the situation.
580 /* A reset of the dongle might be welcomed here - Jean II */
584 /* urb is now available */
585 //urb->status = 0; -> tested above
587 /* Make sure we read self->present properly */
588 spin_lock_irqsave(&self->lock, flags);
590 /* If the network is closed, stop everything */
591 if ((!self->netopen) || (!self->present)) {
592 IRDA_DEBUG(0, "%s(), Network is gone...\n", __func__);
593 spin_unlock_irqrestore(&self->lock, flags);
597 /* If changes to speed or xbofs is pending... */
598 if ((self->new_speed != -1) || (self->new_xbofs != -1)) {
599 if ((self->new_speed != self->speed) ||
600 (self->new_xbofs != self->xbofs)) {
601 /* We haven't changed speed yet (because of
602 * IUC_SPEED_BUG), so do it now - Jean II */
603 IRDA_DEBUG(1, "%s(), Changing speed now...\n", __func__);
604 irda_usb_change_speed_xbofs(self);
606 /* New speed and xbof is now commited in hardware */
607 self->new_speed = -1;
608 self->new_xbofs = -1;
609 /* Done, waiting for next packet */
610 netif_wake_queue(self->netdev);
613 /* Otherwise, allow the stack to send more packets */
614 netif_wake_queue(self->netdev);
616 spin_unlock_irqrestore(&self->lock, flags);
619 /*------------------------------------------------------------------*/
621 * Watchdog timer from the network layer.
622 * After a predetermined timeout, if we don't give confirmation that
623 * the packet has been sent (i.e. no call to netif_wake_queue()),
624 * the network layer will call this function.
625 * Note that URB that we submit have also a timeout. When the URB timeout
626 * expire, the normal URB callback is called (write_bulk_callback()).
628 static void irda_usb_net_timeout(struct net_device *netdev)
631 struct irda_usb_cb *self = netdev_priv(netdev);
633 int done = 0; /* If we have made any progress */
635 IRDA_DEBUG(0, "%s(), Network layer thinks we timed out!\n", __func__);
636 IRDA_ASSERT(self != NULL, return;);
638 /* Protect us from USB callbacks, net Tx and else. */
639 spin_lock_irqsave(&self->lock, flags);
641 /* self->present *MUST* be read under spinlock */
642 if (!self->present) {
643 IRDA_WARNING("%s(), device not present!\n", __func__);
644 netif_stop_queue(netdev);
645 spin_unlock_irqrestore(&self->lock, flags);
649 /* Check speed URB */
650 urb = self->speed_urb;
651 if (urb->status != 0) {
652 IRDA_DEBUG(0, "%s: Speed change timed out, urb->status=%d, urb->transfer_flags=0x%04X\n", netdev->name, urb->status, urb->transfer_flags);
654 switch (urb->status) {
657 /* Note : above will *NOT* call netif_wake_queue()
658 * in completion handler, we will come back here.
663 case -ENOENT: /* urb unlinked by us */
664 default: /* ??? - Play safe */
666 netif_wake_queue(self->netdev);
674 if (urb->status != 0) {
675 struct sk_buff *skb = urb->context;
677 IRDA_DEBUG(0, "%s: Tx timed out, urb->status=%d, urb->transfer_flags=0x%04X\n", netdev->name, urb->status, urb->transfer_flags);
679 /* Increase error count */
680 self->stats.tx_errors++;
682 #ifdef IU_BUG_KICK_TIMEOUT
683 /* Can't be a bad idea to reset the speed ;-) - Jean II */
684 if(self->new_speed == -1)
685 self->new_speed = self->speed;
686 if(self->new_xbofs == -1)
687 self->new_xbofs = self->xbofs;
688 irda_usb_change_speed_xbofs(self);
689 #endif /* IU_BUG_KICK_TIMEOUT */
691 switch (urb->status) {
694 /* Note : above will *NOT* call netif_wake_queue()
695 * in completion handler, because urb->status will
696 * be -ENOENT. We will fix that at the next watchdog,
697 * leaving more time to USB to recover...
702 case -ENOENT: /* urb unlinked by us */
703 default: /* ??? - Play safe */
705 dev_kfree_skb_any(skb);
709 netif_wake_queue(self->netdev);
714 spin_unlock_irqrestore(&self->lock, flags);
716 /* Maybe we need a reset */
717 /* Note : Some drivers seem to use a usb_set_interface() when they
718 * need to reset the hardware. Hum...
724 /************************* RECEIVE ROUTINES *************************/
726 * Receive packets from the USB layer stack and pass them to the IrDA stack.
727 * Try to work around USB failures...
732 * Some of you may have noticed that most dongle have an interrupt in pipe
733 * that we don't use. Here is the little secret...
734 * When we hang a Rx URB on the bulk in pipe, it generates some USB traffic
735 * in every USB frame. This is unnecessary overhead.
736 * The interrupt in pipe will generate an event every time a packet is
737 * received. Reading an interrupt pipe adds minimal overhead, but has some
739 * If we are connected (speed != 9600), we want to minimise latency, so
740 * we just always hang the Rx URB and ignore the interrupt.
741 * If we are not connected (speed == 9600), there is usually no Rx traffic,
742 * and we want to minimise the USB overhead. In this case we should wait
743 * on the interrupt pipe and hang the Rx URB only when an interrupt is
747 * Note : don't read the above as what we are currently doing, but as
748 * something we could do with KC dongle. Also don't forget that the
749 * interrupt pipe is not part of the original standard, so this would
750 * need to be optional...
754 /*------------------------------------------------------------------*/
756 * Submit a Rx URB to the USB layer to handle reception of a frame
757 * Mostly called by the completion callback of the previous URB.
761 static void irda_usb_submit(struct irda_usb_cb *self, struct sk_buff *skb, struct urb *urb)
763 struct irda_skb_cb *cb;
766 IRDA_DEBUG(2, "%s()\n", __func__);
768 /* This should never happen */
769 IRDA_ASSERT(skb != NULL, return;);
770 IRDA_ASSERT(urb != NULL, return;);
772 /* Save ourselves in the skb */
773 cb = (struct irda_skb_cb *) skb->cb;
776 /* Reinitialize URB */
777 usb_fill_bulk_urb(urb, self->usbdev,
778 usb_rcvbulkpipe(self->usbdev, self->bulk_in_ep),
779 skb->data, IRDA_SKB_MAX_MTU,
780 irda_usb_receive, skb);
783 /* Can be called from irda_usb_receive (irq handler) -> GFP_ATOMIC */
784 ret = usb_submit_urb(urb, GFP_ATOMIC);
786 /* If this ever happen, we are in deep s***.
787 * Basically, the Rx path will stop... */
788 IRDA_WARNING("%s(), Failed to submit Rx URB %d\n",
793 /*------------------------------------------------------------------*/
795 * Function irda_usb_receive(urb)
797 * Called by the USB subsystem when a frame has been received
800 static void irda_usb_receive(struct urb *urb)
802 struct sk_buff *skb = (struct sk_buff *) urb->context;
803 struct irda_usb_cb *self;
804 struct irda_skb_cb *cb;
805 struct sk_buff *newskb;
806 struct sk_buff *dataskb;
807 struct urb *next_urb;
808 unsigned int len, docopy;
810 IRDA_DEBUG(2, "%s(), len=%d\n", __func__, urb->actual_length);
813 cb = (struct irda_skb_cb *) skb->cb;
814 IRDA_ASSERT(cb != NULL, return;);
815 self = (struct irda_usb_cb *) cb->context;
816 IRDA_ASSERT(self != NULL, return;);
818 /* If the network is closed or the device gone, stop everything */
819 if ((!self->netopen) || (!self->present)) {
820 IRDA_DEBUG(0, "%s(), Network is gone!\n", __func__);
821 /* Don't re-submit the URB : will stall the Rx path */
825 /* Check the status */
826 if (urb->status != 0) {
827 switch (urb->status) {
829 self->stats.rx_crc_errors++;
830 /* Also precursor to a hot-unplug on UHCI. */
833 /* Random error, if I remember correctly */
834 /* uhci_cleanup_unlink() is going to kill the Rx
835 * URB just after we return. No problem, at this
836 * point the URB will be idle ;-) - Jean II */
838 /* That's usually a hot-unplug. Submit will fail... */
840 /* Usually precursor to a hot-unplug on OHCI. */
842 self->stats.rx_errors++;
843 IRDA_DEBUG(0, "%s(), RX status %d, transfer_flags 0x%04X \n", __func__, urb->status, urb->transfer_flags);
846 /* If we received an error, we don't want to resubmit the
847 * Rx URB straight away but to give the USB layer a little
848 * bit of breathing room.
849 * We are in the USB thread context, therefore there is a
850 * danger of recursion (new URB we submit fails, we come
852 * With recent USB stack (2.6.15+), I'm seeing that on
853 * hot unplug of the dongle...
854 * Lowest effective timer is 10ms...
856 self->rx_defer_timer.function = &irda_usb_rx_defer_expired;
857 self->rx_defer_timer.data = (unsigned long) urb;
858 mod_timer(&self->rx_defer_timer, jiffies + (10 * HZ / 1000));
862 /* Check for empty frames */
863 if (urb->actual_length <= self->header_length) {
864 IRDA_WARNING("%s(), empty frame!\n", __func__);
869 * Remember the time we received this frame, so we can
870 * reduce the min turn time a bit since we will know
871 * how much time we have used for protocol processing
873 do_gettimeofday(&self->stamp);
875 /* Check if we need to copy the data to a new skb or not.
876 * For most frames, we use ZeroCopy and pass the already
877 * allocated skb up the stack.
878 * If the frame is small, it is more efficient to copy it
879 * to save memory (copy will be fast anyway - that's
880 * called Rx-copy-break). Jean II */
881 docopy = (urb->actual_length < IRDA_RX_COPY_THRESHOLD);
883 /* Allocate a new skb */
884 if (self->capability & IUC_STIR421X)
885 newskb = dev_alloc_skb(docopy ? urb->actual_length :
887 USB_IRDA_STIR421X_HEADER);
889 newskb = dev_alloc_skb(docopy ? urb->actual_length :
893 self->stats.rx_dropped++;
894 /* We could deliver the current skb, but this would stall
895 * the Rx path. Better drop the packet... Jean II */
899 /* Make sure IP header get aligned (IrDA header is 5 bytes) */
900 /* But IrDA-USB header is 1 byte. Jean II */
901 //skb_reserve(newskb, USB_IRDA_HEADER - 1);
904 /* Copy packet, so we can recycle the original */
905 skb_copy_from_linear_data(skb, newskb->data, urb->actual_length);
906 /* Deliver this new skb */
908 /* And hook the old skb to the URB
909 * Note : we don't need to "clean up" the old skb,
910 * as we never touched it. Jean II */
912 /* We are using ZeroCopy. Deliver old skb */
914 /* And hook the new skb to the URB */
918 /* Set proper length on skb & remove USB-IrDA header */
919 skb_put(dataskb, urb->actual_length);
920 skb_pull(dataskb, self->header_length);
922 /* Ask the networking layer to queue the packet for the IrDA stack */
923 dataskb->dev = self->netdev;
924 skb_reset_mac_header(dataskb);
925 dataskb->protocol = htons(ETH_P_IRDA);
929 /* Keep stats up to date */
930 self->stats.rx_bytes += len;
931 self->stats.rx_packets++;
934 /* Note : at this point, the URB we've just received (urb)
935 * is still referenced by the USB layer. For example, if we
936 * have received a -ECONNRESET, uhci_cleanup_unlink() will
937 * continue to process it (in fact, cleaning it up).
938 * If we were to submit this URB, disaster would ensue.
939 * Therefore, we submit our idle URB, and put this URB in our
942 /* Note : with this scheme, we could submit the idle URB before
943 * processing the Rx URB. I don't think it would buy us anything as
944 * we are running in the USB thread context. Jean II */
945 next_urb = self->idle_rx_urb;
947 /* Recycle Rx URB : Now, the idle URB is the present one */
949 self->idle_rx_urb = urb;
951 /* Submit the idle URB to replace the URB we've just received.
952 * Do it last to avoid race conditions... Jean II */
953 irda_usb_submit(self, skb, next_urb);
956 /*------------------------------------------------------------------*/
958 * In case of errors, we want the USB layer to have time to recover.
959 * Now, it is time to resubmit ouur Rx URB...
961 static void irda_usb_rx_defer_expired(unsigned long data)
963 struct urb *urb = (struct urb *) data;
964 struct sk_buff *skb = (struct sk_buff *) urb->context;
965 struct irda_usb_cb *self;
966 struct irda_skb_cb *cb;
967 struct urb *next_urb;
969 IRDA_DEBUG(2, "%s()\n", __func__);
972 cb = (struct irda_skb_cb *) skb->cb;
973 IRDA_ASSERT(cb != NULL, return;);
974 self = (struct irda_usb_cb *) cb->context;
975 IRDA_ASSERT(self != NULL, return;);
977 /* Same stuff as when Rx is done, see above... */
978 next_urb = self->idle_rx_urb;
980 self->idle_rx_urb = urb;
981 irda_usb_submit(self, skb, next_urb);
984 /*------------------------------------------------------------------*/
986 * Callbak from IrDA layer. IrDA wants to know if we have
987 * started receiving anything.
989 static int irda_usb_is_receiving(struct irda_usb_cb *self)
991 /* Note : because of the way UHCI works, it's almost impossible
992 * to get this info. The Controller DMA directly to memory and
993 * signal only when the whole frame is finished. To know if the
994 * first TD of the URB has been filled or not seems hard work...
996 * The other solution would be to use the "receiving" command
997 * on the default decriptor with a usb_control_msg(), but that
998 * would add USB traffic and would return result only in the
999 * next USB frame (~1ms).
1001 * I've been told that current dongles send status info on their
1002 * interrupt endpoint, and that's what the Windows driver uses
1003 * to know this info. Unfortunately, this is not yet in the spec...
1008 return 0; /* For now */
1011 #define STIR421X_PATCH_PRODUCT_VER "Product Version: "
1012 #define STIR421X_PATCH_STMP_TAG "STMP"
1013 #define STIR421X_PATCH_CODE_OFFSET 512 /* patch image starts before here */
1014 /* marks end of patch file header (PC DOS text file EOF character) */
1015 #define STIR421X_PATCH_END_OF_HDR_TAG 0x1A
1016 #define STIR421X_PATCH_BLOCK_SIZE 1023
1019 * Function stir421x_fwupload (struct irda_usb_cb *self,
1020 * unsigned char *patch,
1021 * const unsigned int patch_len)
1023 * Upload firmware code to SigmaTel 421X IRDA-USB dongle
1025 static int stir421x_fw_upload(struct irda_usb_cb *self,
1026 const unsigned char *patch,
1027 const unsigned int patch_len)
1032 unsigned int block_size = 0;
1033 unsigned char *patch_block;
1035 patch_block = kzalloc(STIR421X_PATCH_BLOCK_SIZE, GFP_KERNEL);
1036 if (patch_block == NULL)
1039 /* break up patch into 1023-byte sections */
1040 for (i = 0; i < patch_len; i += block_size) {
1041 block_size = patch_len - i;
1043 if (block_size > STIR421X_PATCH_BLOCK_SIZE)
1044 block_size = STIR421X_PATCH_BLOCK_SIZE;
1046 /* upload the patch section */
1047 memcpy(patch_block, patch + i, block_size);
1049 ret = usb_bulk_msg(self->usbdev,
1050 usb_sndbulkpipe(self->usbdev,
1052 patch_block, block_size,
1053 &actual_len, msecs_to_jiffies(500));
1054 IRDA_DEBUG(3,"%s(): Bulk send %u bytes, ret=%d\n",
1055 __func__, actual_len, ret);
1069 * Function stir421x_patch_device(struct irda_usb_cb *self)
1071 * Get a firmware code from userspase using hotplug request_firmware() call
1073 static int stir421x_patch_device(struct irda_usb_cb *self)
1077 char stir421x_fw_name[11];
1078 const struct firmware *fw;
1079 const unsigned char *fw_version_ptr; /* pointer to version string */
1080 unsigned long fw_version = 0;
1083 * Known firmware patch file names for STIR421x dongles
1084 * are "42101001.sb" or "42101002.sb"
1086 sprintf(stir421x_fw_name, "4210%4X.sb",
1087 self->usbdev->descriptor.bcdDevice);
1088 ret = request_firmware(&fw, stir421x_fw_name, &self->usbdev->dev);
1092 /* We get a patch from userspace */
1093 IRDA_MESSAGE("%s(): Received firmware %s (%zu bytes)\n",
1094 __func__, stir421x_fw_name, fw->size);
1098 /* Get the bcd product version */
1099 if (!memcmp(fw->data, STIR421X_PATCH_PRODUCT_VER,
1100 sizeof(STIR421X_PATCH_PRODUCT_VER) - 1)) {
1101 fw_version_ptr = fw->data +
1102 sizeof(STIR421X_PATCH_PRODUCT_VER) - 1;
1104 /* Let's check if the product version is dotted */
1105 if (fw_version_ptr[3] == '.' &&
1106 fw_version_ptr[7] == '.') {
1107 unsigned long major, minor, build;
1108 major = simple_strtoul(fw_version_ptr, NULL, 10);
1109 minor = simple_strtoul(fw_version_ptr + 4, NULL, 10);
1110 build = simple_strtoul(fw_version_ptr + 8, NULL, 10);
1112 fw_version = (major << 12)
1114 + ((build / 10) << 4)
1117 IRDA_DEBUG(3, "%s(): Firmware Product version %ld\n",
1118 __func__, fw_version);
1122 if (self->usbdev->descriptor.bcdDevice == cpu_to_le16(fw_version)) {
1124 * If we're here, we've found a correct patch
1125 * The actual image starts after the "STMP" keyword
1126 * so forward to the firmware header tag
1128 for (i = 0; (fw->data[i] != STIR421X_PATCH_END_OF_HDR_TAG)
1129 && (i < fw->size); i++) ;
1130 /* here we check for the out of buffer case */
1131 if ((STIR421X_PATCH_END_OF_HDR_TAG == fw->data[i])
1132 && (i < STIR421X_PATCH_CODE_OFFSET)) {
1133 if (!memcmp(fw->data + i + 1, STIR421X_PATCH_STMP_TAG,
1134 sizeof(STIR421X_PATCH_STMP_TAG) - 1)) {
1136 /* We can upload the patch to the target */
1137 i += sizeof(STIR421X_PATCH_STMP_TAG);
1138 ret = stir421x_fw_upload(self, &fw->data[i],
1144 release_firmware(fw);
1150 /********************** IRDA DEVICE CALLBACKS **********************/
1152 * Main calls from the IrDA/Network subsystem.
1153 * Mostly registering a new irda-usb device and removing it....
1154 * We only deal with the IrDA side of the business, the USB side will
1155 * be dealt with below...
1159 /*------------------------------------------------------------------*/
1161 * Function irda_usb_net_open (dev)
1163 * Network device is taken up. Usually this is done by "ifconfig irda0 up"
1165 * Note : don't mess with self->netopen - Jean II
1167 static int irda_usb_net_open(struct net_device *netdev)
1169 struct irda_usb_cb *self;
1170 unsigned long flags;
1174 IRDA_DEBUG(1, "%s()\n", __func__);
1176 IRDA_ASSERT(netdev != NULL, return -1;);
1177 self = netdev_priv(netdev);
1178 IRDA_ASSERT(self != NULL, return -1;);
1180 spin_lock_irqsave(&self->lock, flags);
1181 /* Can only open the device if it's there */
1182 if(!self->present) {
1183 spin_unlock_irqrestore(&self->lock, flags);
1184 IRDA_WARNING("%s(), device not present!\n", __func__);
1188 if(self->needspatch) {
1189 spin_unlock_irqrestore(&self->lock, flags);
1190 IRDA_WARNING("%s(), device needs patch\n", __func__) ;
1194 /* Initialise default speed and xbofs value
1195 * (IrLAP will change that soon) */
1198 self->new_speed = -1;
1199 self->new_xbofs = -1;
1201 /* To do *before* submitting Rx urbs and starting net Tx queue
1204 spin_unlock_irqrestore(&self->lock, flags);
1207 * Now that everything should be initialized properly,
1208 * Open new IrLAP layer instance to take care of us...
1209 * Note : will send immediately a speed change...
1211 sprintf(hwname, "usb#%d", self->usbdev->devnum);
1212 self->irlap = irlap_open(netdev, &self->qos, hwname);
1213 IRDA_ASSERT(self->irlap != NULL, return -1;);
1215 /* Allow IrLAP to send data to us */
1216 netif_start_queue(netdev);
1218 /* We submit all the Rx URB except for one that we keep idle.
1219 * Need to be initialised before submitting other USBs, because
1220 * in some cases as soon as we submit the URBs the USB layer
1221 * will trigger a dummy receive - Jean II */
1222 self->idle_rx_urb = self->rx_urb[IU_MAX_ACTIVE_RX_URBS];
1223 self->idle_rx_urb->context = NULL;
1225 /* Now that we can pass data to IrLAP, allow the USB layer
1226 * to send us some data... */
1227 for (i = 0; i < IU_MAX_ACTIVE_RX_URBS; i++) {
1228 struct sk_buff *skb = dev_alloc_skb(IRDA_SKB_MAX_MTU);
1230 /* If this ever happen, we are in deep s***.
1231 * Basically, we can't start the Rx path... */
1232 IRDA_WARNING("%s(), Failed to allocate Rx skb\n",
1236 //skb_reserve(newskb, USB_IRDA_HEADER - 1);
1237 irda_usb_submit(self, skb, self->rx_urb[i]);
1240 /* Ready to play !!! */
1244 /*------------------------------------------------------------------*/
1246 * Function irda_usb_net_close (self)
1248 * Network device is taken down. Usually this is done by
1249 * "ifconfig irda0 down"
1251 static int irda_usb_net_close(struct net_device *netdev)
1253 struct irda_usb_cb *self;
1256 IRDA_DEBUG(1, "%s()\n", __func__);
1258 IRDA_ASSERT(netdev != NULL, return -1;);
1259 self = netdev_priv(netdev);
1260 IRDA_ASSERT(self != NULL, return -1;);
1262 /* Clear this flag *before* unlinking the urbs and *before*
1263 * stopping the network Tx queue - Jean II */
1266 /* Stop network Tx queue */
1267 netif_stop_queue(netdev);
1269 /* Kill defered Rx URB */
1270 del_timer(&self->rx_defer_timer);
1272 /* Deallocate all the Rx path buffers (URBs and skb) */
1273 for (i = 0; i < self->max_rx_urb; i++) {
1274 struct urb *urb = self->rx_urb[i];
1275 struct sk_buff *skb = (struct sk_buff *) urb->context;
1276 /* Cancel the receive command */
1278 /* The skb is ours, free it */
1281 urb->context = NULL;
1284 /* Cancel Tx and speed URB - need to be synchronous to avoid races */
1285 usb_kill_urb(self->tx_urb);
1286 usb_kill_urb(self->speed_urb);
1288 /* Stop and remove instance of IrLAP */
1290 irlap_close(self->irlap);
1296 /*------------------------------------------------------------------*/
1298 * IOCTLs : Extra out-of-band network commands...
1300 static int irda_usb_net_ioctl(struct net_device *dev, struct ifreq *rq, int cmd)
1302 unsigned long flags;
1303 struct if_irda_req *irq = (struct if_irda_req *) rq;
1304 struct irda_usb_cb *self;
1307 IRDA_ASSERT(dev != NULL, return -1;);
1308 self = netdev_priv(dev);
1309 IRDA_ASSERT(self != NULL, return -1;);
1311 IRDA_DEBUG(2, "%s(), %s, (cmd=0x%X)\n", __func__, dev->name, cmd);
1314 case SIOCSBANDWIDTH: /* Set bandwidth */
1315 if (!capable(CAP_NET_ADMIN))
1317 /* Protect us from USB callbacks, net watchdog and else. */
1318 spin_lock_irqsave(&self->lock, flags);
1319 /* Check if the device is still there */
1321 /* Set the desired speed */
1322 self->new_speed = irq->ifr_baudrate;
1323 irda_usb_change_speed_xbofs(self);
1325 spin_unlock_irqrestore(&self->lock, flags);
1327 case SIOCSMEDIABUSY: /* Set media busy */
1328 if (!capable(CAP_NET_ADMIN))
1330 /* Check if the IrDA stack is still there */
1332 irda_device_set_media_busy(self->netdev, TRUE);
1334 case SIOCGRECEIVING: /* Check if we are receiving right now */
1335 irq->ifr_receiving = irda_usb_is_receiving(self);
1344 /*------------------------------------------------------------------*/
1346 * Get device stats (for /proc/net/dev and ifconfig)
1348 static struct net_device_stats *irda_usb_net_get_stats(struct net_device *dev)
1350 struct irda_usb_cb *self = netdev_priv(dev);
1351 return &self->stats;
1354 /********************* IRDA CONFIG SUBROUTINES *********************/
1356 * Various subroutines dealing with IrDA and network stuff we use to
1357 * configure and initialise each irda-usb instance.
1358 * These functions are used below in the main calls of the driver...
1361 /*------------------------------------------------------------------*/
1363 * Set proper values in the IrDA QOS structure
1365 static inline void irda_usb_init_qos(struct irda_usb_cb *self)
1367 struct irda_class_desc *desc;
1369 IRDA_DEBUG(3, "%s()\n", __func__);
1371 desc = self->irda_desc;
1373 /* Initialize QoS for this device */
1374 irda_init_max_qos_capabilies(&self->qos);
1376 /* See spec section 7.2 for meaning.
1377 * Values are little endian (as most USB stuff), the IrDA stack
1378 * use it in native order (see parameters.c). - Jean II */
1379 self->qos.baud_rate.bits = le16_to_cpu(desc->wBaudRate);
1380 self->qos.min_turn_time.bits = desc->bmMinTurnaroundTime;
1381 self->qos.additional_bofs.bits = desc->bmAdditionalBOFs;
1382 self->qos.window_size.bits = desc->bmWindowSize;
1383 self->qos.data_size.bits = desc->bmDataSize;
1385 IRDA_DEBUG(0, "%s(), dongle says speed=0x%X, size=0x%X, window=0x%X, bofs=0x%X, turn=0x%X\n",
1386 __func__, self->qos.baud_rate.bits, self->qos.data_size.bits, self->qos.window_size.bits, self->qos.additional_bofs.bits, self->qos.min_turn_time.bits);
1388 /* Don't always trust what the dongle tell us */
1389 if(self->capability & IUC_SIR_ONLY)
1390 self->qos.baud_rate.bits &= 0x00ff;
1391 if(self->capability & IUC_SMALL_PKT)
1392 self->qos.data_size.bits = 0x07;
1393 if(self->capability & IUC_NO_WINDOW)
1394 self->qos.window_size.bits = 0x01;
1395 if(self->capability & IUC_MAX_WINDOW)
1396 self->qos.window_size.bits = 0x7f;
1397 if(self->capability & IUC_MAX_XBOFS)
1398 self->qos.additional_bofs.bits = 0x01;
1401 /* Module parameter can override the rx window size */
1403 self->qos.min_turn_time.bits = qos_mtt_bits;
1406 * Note : most of those values apply only for the receive path,
1407 * the transmit path will be set differently - Jean II
1409 irda_qos_bits_to_value(&self->qos);
1412 /*------------------------------------------------------------------*/
1414 * Initialise the network side of the irda-usb instance
1415 * Called when a new USB instance is registered in irda_usb_probe()
1417 static inline int irda_usb_open(struct irda_usb_cb *self)
1419 struct net_device *netdev = self->netdev;
1421 IRDA_DEBUG(1, "%s()\n", __func__);
1423 irda_usb_init_qos(self);
1425 /* Override the network functions we need to use */
1426 netdev->hard_start_xmit = irda_usb_hard_xmit;
1427 netdev->tx_timeout = irda_usb_net_timeout;
1428 netdev->watchdog_timeo = 250*HZ/1000; /* 250 ms > USB timeout */
1429 netdev->open = irda_usb_net_open;
1430 netdev->stop = irda_usb_net_close;
1431 netdev->get_stats = irda_usb_net_get_stats;
1432 netdev->do_ioctl = irda_usb_net_ioctl;
1434 return register_netdev(netdev);
1437 /*------------------------------------------------------------------*/
1439 * Cleanup the network side of the irda-usb instance
1440 * Called when a USB instance is removed in irda_usb_disconnect()
1442 static inline void irda_usb_close(struct irda_usb_cb *self)
1444 IRDA_DEBUG(1, "%s()\n", __func__);
1446 /* Remove netdevice */
1447 unregister_netdev(self->netdev);
1449 /* Remove the speed buffer */
1450 kfree(self->speed_buff);
1451 self->speed_buff = NULL;
1453 kfree(self->tx_buff);
1454 self->tx_buff = NULL;
1457 /********************** USB CONFIG SUBROUTINES **********************/
1459 * Various subroutines dealing with USB stuff we use to configure and
1460 * initialise each irda-usb instance.
1461 * These functions are used below in the main calls of the driver...
1464 /*------------------------------------------------------------------*/
1466 * Function irda_usb_parse_endpoints(dev, ifnum)
1468 * Parse the various endpoints and find the one we need.
1470 * The endpoint are the pipes used to communicate with the USB device.
1471 * The spec defines 2 endpoints of type bulk transfer, one in, and one out.
1472 * These are used to pass frames back and forth with the dongle.
1473 * Most dongle have also an interrupt endpoint, that will be probably
1474 * documented in the next spec...
1476 static inline int irda_usb_parse_endpoints(struct irda_usb_cb *self, struct usb_host_endpoint *endpoint, int ennum)
1478 int i; /* Endpoint index in table */
1480 /* Init : no endpoints */
1481 self->bulk_in_ep = 0;
1482 self->bulk_out_ep = 0;
1483 self->bulk_int_ep = 0;
1485 /* Let's look at all those endpoints */
1486 for(i = 0; i < ennum; i++) {
1487 /* All those variables will get optimised by the compiler,
1488 * so let's aim for clarity... - Jean II */
1489 __u8 ep; /* Endpoint address */
1490 __u8 dir; /* Endpoint direction */
1491 __u8 attr; /* Endpoint attribute */
1492 __u16 psize; /* Endpoint max packet size in bytes */
1494 /* Get endpoint address, direction and attribute */
1495 ep = endpoint[i].desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1496 dir = endpoint[i].desc.bEndpointAddress & USB_ENDPOINT_DIR_MASK;
1497 attr = endpoint[i].desc.bmAttributes;
1498 psize = le16_to_cpu(endpoint[i].desc.wMaxPacketSize);
1500 /* Is it a bulk endpoint ??? */
1501 if(attr == USB_ENDPOINT_XFER_BULK) {
1502 /* We need to find an IN and an OUT */
1503 if(dir == USB_DIR_IN) {
1504 /* This is our Rx endpoint */
1505 self->bulk_in_ep = ep;
1507 /* This is our Tx endpoint */
1508 self->bulk_out_ep = ep;
1509 self->bulk_out_mtu = psize;
1512 if((attr == USB_ENDPOINT_XFER_INT) &&
1513 (dir == USB_DIR_IN)) {
1514 /* This is our interrupt endpoint */
1515 self->bulk_int_ep = ep;
1517 IRDA_ERROR("%s(), Unrecognised endpoint %02X.\n", __func__, ep);
1522 IRDA_DEBUG(0, "%s(), And our endpoints are : in=%02X, out=%02X (%d), int=%02X\n",
1523 __func__, self->bulk_in_ep, self->bulk_out_ep, self->bulk_out_mtu, self->bulk_int_ep);
1525 return((self->bulk_in_ep != 0) && (self->bulk_out_ep != 0));
1528 #ifdef IU_DUMP_CLASS_DESC
1529 /*------------------------------------------------------------------*/
1531 * Function usb_irda_dump_class_desc(desc)
1533 * Prints out the contents of the IrDA class descriptor
1536 static inline void irda_usb_dump_class_desc(struct irda_class_desc *desc)
1538 /* Values are little endian */
1539 printk("bLength=%x\n", desc->bLength);
1540 printk("bDescriptorType=%x\n", desc->bDescriptorType);
1541 printk("bcdSpecRevision=%x\n", le16_to_cpu(desc->bcdSpecRevision));
1542 printk("bmDataSize=%x\n", desc->bmDataSize);
1543 printk("bmWindowSize=%x\n", desc->bmWindowSize);
1544 printk("bmMinTurnaroundTime=%d\n", desc->bmMinTurnaroundTime);
1545 printk("wBaudRate=%x\n", le16_to_cpu(desc->wBaudRate));
1546 printk("bmAdditionalBOFs=%x\n", desc->bmAdditionalBOFs);
1547 printk("bIrdaRateSniff=%x\n", desc->bIrdaRateSniff);
1548 printk("bMaxUnicastList=%x\n", desc->bMaxUnicastList);
1550 #endif /* IU_DUMP_CLASS_DESC */
1552 /*------------------------------------------------------------------*/
1554 * Function irda_usb_find_class_desc(intf)
1556 * Returns instance of IrDA class descriptor, or NULL if not found
1558 * The class descriptor is some extra info that IrDA USB devices will
1559 * offer to us, describing their IrDA characteristics. We will use that in
1560 * irda_usb_init_qos()
1562 static inline struct irda_class_desc *irda_usb_find_class_desc(struct usb_interface *intf)
1564 struct usb_device *dev = interface_to_usbdev (intf);
1565 struct irda_class_desc *desc;
1568 desc = kzalloc(sizeof(*desc), GFP_KERNEL);
1572 /* USB-IrDA class spec 1.0:
1573 * 6.1.3: Standard "Get Descriptor" Device Request is not
1574 * appropriate to retrieve class-specific descriptor
1575 * 6.2.5: Class Specific "Get Class Descriptor" Interface Request
1576 * is mandatory and returns the USB-IrDA class descriptor
1579 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev,0),
1580 IU_REQ_GET_CLASS_DESC,
1581 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
1582 0, intf->altsetting->desc.bInterfaceNumber, desc,
1583 sizeof(*desc), 500);
1585 IRDA_DEBUG(1, "%s(), ret=%d\n", __func__, ret);
1586 if (ret < sizeof(*desc)) {
1587 IRDA_WARNING("usb-irda: class_descriptor read %s (%d)\n",
1588 (ret<0) ? "failed" : "too short", ret);
1590 else if (desc->bDescriptorType != USB_DT_IRDA) {
1591 IRDA_WARNING("usb-irda: bad class_descriptor type\n");
1594 #ifdef IU_DUMP_CLASS_DESC
1595 irda_usb_dump_class_desc(desc);
1596 #endif /* IU_DUMP_CLASS_DESC */
1604 /*********************** USB DEVICE CALLBACKS ***********************/
1606 * Main calls from the USB subsystem.
1607 * Mostly registering a new irda-usb device and removing it....
1610 /*------------------------------------------------------------------*/
1612 * This routine is called by the USB subsystem for each new device
1613 * in the system. We need to check if the device is ours, and in
1614 * this case start handling it.
1615 * The USB layer protect us from reentrancy (via BKL), so we don't need
1616 * to spinlock in there... Jean II
1618 static int irda_usb_probe(struct usb_interface *intf,
1619 const struct usb_device_id *id)
1621 struct net_device *net;
1622 struct usb_device *dev = interface_to_usbdev(intf);
1623 struct irda_usb_cb *self;
1624 struct usb_host_interface *interface;
1625 struct irda_class_desc *irda_desc;
1627 int i; /* Driver instance index / Rx URB index */
1629 /* Note : the probe make sure to call us only for devices that
1630 * matches the list of dongle (top of the file). So, we
1631 * don't need to check if the dongle is really ours.
1634 IRDA_MESSAGE("IRDA-USB found at address %d, Vendor: %x, Product: %x\n",
1635 dev->devnum, le16_to_cpu(dev->descriptor.idVendor),
1636 le16_to_cpu(dev->descriptor.idProduct));
1638 net = alloc_irdadev(sizeof(*self));
1642 SET_NETDEV_DEV(net, &intf->dev);
1643 self = netdev_priv(net);
1645 spin_lock_init(&self->lock);
1646 init_timer(&self->rx_defer_timer);
1648 self->capability = id->driver_info;
1649 self->needspatch = ((self->capability & IUC_STIR421X) != 0);
1651 /* Create all of the needed urbs */
1652 if (self->capability & IUC_STIR421X) {
1653 self->max_rx_urb = IU_SIGMATEL_MAX_RX_URBS;
1654 self->header_length = USB_IRDA_STIR421X_HEADER;
1656 self->max_rx_urb = IU_MAX_RX_URBS;
1657 self->header_length = USB_IRDA_HEADER;
1660 self->rx_urb = kcalloc(self->max_rx_urb, sizeof(struct urb *),
1663 for (i = 0; i < self->max_rx_urb; i++) {
1664 self->rx_urb[i] = usb_alloc_urb(0, GFP_KERNEL);
1665 if (!self->rx_urb[i]) {
1669 self->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
1670 if (!self->tx_urb) {
1673 self->speed_urb = usb_alloc_urb(0, GFP_KERNEL);
1674 if (!self->speed_urb) {
1678 /* Is this really necessary? (no, except maybe for broken devices) */
1679 if (usb_reset_configuration (dev) < 0) {
1680 err("reset_configuration failed");
1685 /* Is this really necessary? */
1686 /* Note : some driver do hardcode the interface number, some others
1687 * specify an alternate, but very few driver do like this.
1689 ret = usb_set_interface(dev, intf->altsetting->desc.bInterfaceNumber, 0);
1690 IRDA_DEBUG(1, "usb-irda: set interface %d result %d\n", intf->altsetting->desc.bInterfaceNumber, ret);
1694 case -EPIPE: /* -EPIPE = -32 */
1695 /* Martin Diehl says if we get a -EPIPE we should
1696 * be fine and we don't need to do a usb_clear_halt().
1698 IRDA_DEBUG(0, "%s(), Received -EPIPE, ignoring...\n", __func__);
1701 IRDA_DEBUG(0, "%s(), Unknown error %d\n", __func__, ret);
1706 /* Find our endpoints */
1707 interface = intf->cur_altsetting;
1708 if(!irda_usb_parse_endpoints(self, interface->endpoint,
1709 interface->desc.bNumEndpoints)) {
1710 IRDA_ERROR("%s(), Bogus endpoints...\n", __func__);
1717 /* Find IrDA class descriptor */
1718 irda_desc = irda_usb_find_class_desc(intf);
1723 if (self->needspatch) {
1724 ret = usb_control_msg (self->usbdev, usb_sndctrlpipe (self->usbdev, 0),
1725 0x02, 0x40, 0, 0, NULL, 0, 500);
1727 IRDA_DEBUG (0, "usb_control_msg failed %d\n", ret);
1734 self->irda_desc = irda_desc;
1737 self->usbintf = intf;
1739 /* Allocate the buffer for speed changes */
1740 /* Don't change this buffer size and allocation without doing
1741 * some heavy and complete testing. Don't ask why :-(
1743 self->speed_buff = kzalloc(IRDA_USB_SPEED_MTU, GFP_KERNEL);
1744 if (!self->speed_buff)
1747 self->tx_buff = kzalloc(IRDA_SKB_MAX_MTU + self->header_length,
1752 ret = irda_usb_open(self);
1756 IRDA_MESSAGE("IrDA: Registered device %s\n", net->name);
1757 usb_set_intfdata(intf, self);
1759 if (self->needspatch) {
1760 /* Now we fetch and upload the firmware patch */
1761 ret = stir421x_patch_device(self);
1762 self->needspatch = (ret < 0);
1763 if (self->needspatch) {
1764 IRDA_ERROR("STIR421X: Couldn't upload patch\n");
1768 /* replace IrDA class descriptor with what patched device is now reporting */
1769 irda_desc = irda_usb_find_class_desc (self->usbintf);
1774 kfree(self->irda_desc);
1775 self->irda_desc = irda_desc;
1776 irda_usb_init_qos(self);
1781 unregister_netdev(self->netdev);
1783 kfree(self->tx_buff);
1785 kfree(self->speed_buff);
1787 /* Free all urbs that we may have created */
1788 usb_free_urb(self->speed_urb);
1790 usb_free_urb(self->tx_urb);
1792 for (i = 0; i < self->max_rx_urb; i++)
1793 usb_free_urb(self->rx_urb[i]);
1799 /*------------------------------------------------------------------*/
1801 * The current irda-usb device is removed, the USB layer tell us
1802 * to shut it down...
1803 * One of the constraints is that when we exit this function,
1804 * we cannot use the usb_device no more. Gone. Destroyed. kfree().
1805 * Most other subsystem allow you to destroy the instance at a time
1806 * when it's convenient to you, to postpone it to a later date, but
1807 * not the USB subsystem.
1808 * So, we must make bloody sure that everything gets deactivated.
1811 static void irda_usb_disconnect(struct usb_interface *intf)
1813 unsigned long flags;
1814 struct irda_usb_cb *self = usb_get_intfdata(intf);
1817 IRDA_DEBUG(1, "%s()\n", __func__);
1819 usb_set_intfdata(intf, NULL);
1823 /* Make sure that the Tx path is not executing. - Jean II */
1824 spin_lock_irqsave(&self->lock, flags);
1826 /* Oups ! We are not there any more.
1827 * This will stop/desactivate the Tx path. - Jean II */
1830 /* Kill defered Rx URB */
1831 del_timer(&self->rx_defer_timer);
1833 /* We need to have irq enabled to unlink the URBs. That's OK,
1834 * at this point the Tx path is gone - Jean II */
1835 spin_unlock_irqrestore(&self->lock, flags);
1837 /* Hum... Check if networking is still active (avoid races) */
1838 if((self->netopen) || (self->irlap)) {
1839 /* Accept no more transmissions */
1840 /*netif_device_detach(self->netdev);*/
1841 netif_stop_queue(self->netdev);
1842 /* Stop all the receive URBs. Must be synchronous. */
1843 for (i = 0; i < self->max_rx_urb; i++)
1844 usb_kill_urb(self->rx_urb[i]);
1845 /* Cancel Tx and speed URB.
1846 * Make sure it's synchronous to avoid races. */
1847 usb_kill_urb(self->tx_urb);
1848 usb_kill_urb(self->speed_urb);
1851 /* Cleanup the device stuff */
1852 irda_usb_close(self);
1853 /* No longer attached to USB bus */
1854 self->usbdev = NULL;
1855 self->usbintf = NULL;
1857 /* Clean up our urbs */
1858 for (i = 0; i < self->max_rx_urb; i++)
1859 usb_free_urb(self->rx_urb[i]);
1860 kfree(self->rx_urb);
1861 /* Clean up Tx and speed URB */
1862 usb_free_urb(self->tx_urb);
1863 usb_free_urb(self->speed_urb);
1865 /* Free self and network device */
1866 free_netdev(self->netdev);
1867 IRDA_DEBUG(0, "%s(), USB IrDA Disconnected\n", __func__);
1870 /*------------------------------------------------------------------*/
1872 * USB device callbacks
1874 static struct usb_driver irda_driver = {
1876 .probe = irda_usb_probe,
1877 .disconnect = irda_usb_disconnect,
1878 .id_table = dongles,
1881 /************************* MODULE CALLBACKS *************************/
1883 * Deal with module insertion/removal
1884 * Mostly tell USB about our existence
1887 /*------------------------------------------------------------------*/
1891 static int __init usb_irda_init(void)
1895 ret = usb_register(&irda_driver);
1899 IRDA_MESSAGE("USB IrDA support registered\n");
1902 module_init(usb_irda_init);
1904 /*------------------------------------------------------------------*/
1908 static void __exit usb_irda_cleanup(void)
1910 /* Deregister the driver and remove all pending instances */
1911 usb_deregister(&irda_driver);
1913 module_exit(usb_irda_cleanup);
1915 /*------------------------------------------------------------------*/
1919 module_param(qos_mtt_bits, int, 0);
1920 MODULE_PARM_DESC(qos_mtt_bits, "Minimum Turn Time");
1921 MODULE_AUTHOR("Roman Weissgaerber <weissg@vienna.at>, Dag Brattli <dag@brattli.net>, Jean Tourrilhes <jt@hpl.hp.com> and Nick Fedchik <nick@fedchik.org.ua>");
1922 MODULE_DESCRIPTION("IrDA-USB Dongle Driver");
1923 MODULE_LICENSE("GPL");