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", __FUNCTION__
);
185 IRDA_DEBUG(2, "%s(), changing speed to %d\n", __FUNCTION__
, 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", __FUNCTION__
, 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", __FUNCTION__
,
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", __FUNCTION__
);
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", __FUNCTION__
);
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", __FUNCTION__
);
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", __FUNCTION__
, 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
;
388 struct urb
*urb
= self
->tx_urb
;
393 int err
= 1; /* Failed */
395 IRDA_DEBUG(4, "%s() on %s\n", __FUNCTION__
, 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", __FUNCTION__
);
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", __FUNCTION__
);
444 memcpy(self
->tx_buff
+ self
->header_length
, skb
->data
, 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", __FUNCTION__
);
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", __FUNCTION__
);
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", __FUNCTION__
, 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", __FUNCTION__
);
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", __FUNCTION__
);
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
;
633 int done
= 0; /* If we have made any progress */
635 IRDA_DEBUG(0, "%s(), Network layer thinks we timed out!\n", __FUNCTION__
);
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", __FUNCTION__
);
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", __FUNCTION__
);
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", __FUNCTION__
, 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", __FUNCTION__
);
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", __FUNCTION__
, 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", __FUNCTION__
);
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 memcpy(newskb
->data
, skb
->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 dataskb
->mac
.raw
= dataskb
->data
;
925 dataskb
->protocol
= htons(ETH_P_IRDA
);
929 /* Keep stats up to date */
930 self
->stats
.rx_bytes
+= len
;
931 self
->stats
.rx_packets
++;
932 self
->netdev
->last_rx
= jiffies
;
935 /* Note : at this point, the URB we've just received (urb)
936 * is still referenced by the USB layer. For example, if we
937 * have received a -ECONNRESET, uhci_cleanup_unlink() will
938 * continue to process it (in fact, cleaning it up).
939 * If we were to submit this URB, disaster would ensue.
940 * Therefore, we submit our idle URB, and put this URB in our
943 /* Note : with this scheme, we could submit the idle URB before
944 * processing the Rx URB. I don't think it would buy us anything as
945 * we are running in the USB thread context. Jean II */
946 next_urb
= self
->idle_rx_urb
;
948 /* Recycle Rx URB : Now, the idle URB is the present one */
950 self
->idle_rx_urb
= urb
;
952 /* Submit the idle URB to replace the URB we've just received.
953 * Do it last to avoid race conditions... Jean II */
954 irda_usb_submit(self
, skb
, next_urb
);
957 /*------------------------------------------------------------------*/
959 * In case of errors, we want the USB layer to have time to recover.
960 * Now, it is time to resubmit ouur Rx URB...
962 static void irda_usb_rx_defer_expired(unsigned long data
)
964 struct urb
*urb
= (struct urb
*) data
;
965 struct sk_buff
*skb
= (struct sk_buff
*) urb
->context
;
966 struct irda_usb_cb
*self
;
967 struct irda_skb_cb
*cb
;
968 struct urb
*next_urb
;
970 IRDA_DEBUG(2, "%s()\n", __FUNCTION__
);
973 cb
= (struct irda_skb_cb
*) skb
->cb
;
974 IRDA_ASSERT(cb
!= NULL
, return;);
975 self
= (struct irda_usb_cb
*) cb
->context
;
976 IRDA_ASSERT(self
!= NULL
, return;);
978 /* Same stuff as when Rx is done, see above... */
979 next_urb
= self
->idle_rx_urb
;
981 self
->idle_rx_urb
= urb
;
982 irda_usb_submit(self
, skb
, next_urb
);
985 /*------------------------------------------------------------------*/
987 * Callbak from IrDA layer. IrDA wants to know if we have
988 * started receiving anything.
990 static int irda_usb_is_receiving(struct irda_usb_cb
*self
)
992 /* Note : because of the way UHCI works, it's almost impossible
993 * to get this info. The Controller DMA directly to memory and
994 * signal only when the whole frame is finished. To know if the
995 * first TD of the URB has been filled or not seems hard work...
997 * The other solution would be to use the "receiving" command
998 * on the default decriptor with a usb_control_msg(), but that
999 * would add USB traffic and would return result only in the
1000 * next USB frame (~1ms).
1002 * I've been told that current dongles send status info on their
1003 * interrupt endpoint, and that's what the Windows driver uses
1004 * to know this info. Unfortunately, this is not yet in the spec...
1009 return 0; /* For now */
1012 #define STIR421X_PATCH_PRODUCT_VER "Product Version: "
1013 #define STIR421X_PATCH_STMP_TAG "STMP"
1014 #define STIR421X_PATCH_CODE_OFFSET 512 /* patch image starts before here */
1015 /* marks end of patch file header (PC DOS text file EOF character) */
1016 #define STIR421X_PATCH_END_OF_HDR_TAG 0x1A
1017 #define STIR421X_PATCH_BLOCK_SIZE 1023
1020 * Function stir421x_fwupload (struct irda_usb_cb *self,
1021 * unsigned char *patch,
1022 * const unsigned int patch_len)
1024 * Upload firmware code to SigmaTel 421X IRDA-USB dongle
1026 static int stir421x_fw_upload(struct irda_usb_cb
*self
,
1027 unsigned char *patch
,
1028 const unsigned int patch_len
)
1033 unsigned int block_size
= 0;
1034 unsigned char *patch_block
;
1036 patch_block
= kzalloc(STIR421X_PATCH_BLOCK_SIZE
, GFP_KERNEL
);
1037 if (patch_block
== NULL
)
1040 /* break up patch into 1023-byte sections */
1041 for (i
= 0; i
< patch_len
; i
+= block_size
) {
1042 block_size
= patch_len
- i
;
1044 if (block_size
> STIR421X_PATCH_BLOCK_SIZE
)
1045 block_size
= STIR421X_PATCH_BLOCK_SIZE
;
1047 /* upload the patch section */
1048 memcpy(patch_block
, patch
+ i
, block_size
);
1050 ret
= usb_bulk_msg(self
->usbdev
,
1051 usb_sndbulkpipe(self
->usbdev
,
1053 patch_block
, block_size
,
1054 &actual_len
, msecs_to_jiffies(500));
1055 IRDA_DEBUG(3,"%s(): Bulk send %u bytes, ret=%d\n",
1056 __FUNCTION__
, actual_len
, ret
);
1068 * Function stir421x_patch_device(struct irda_usb_cb *self)
1070 * Get a firmware code from userspase using hotplug request_firmware() call
1072 static int stir421x_patch_device(struct irda_usb_cb
*self
)
1076 char stir421x_fw_name
[11];
1077 const struct firmware
*fw
;
1078 unsigned char *fw_version_ptr
; /* pointer to version string */
1079 unsigned long fw_version
= 0;
1082 * Known firmware patch file names for STIR421x dongles
1083 * are "42101001.sb" or "42101002.sb"
1085 sprintf(stir421x_fw_name
, "4210%4X.sb",
1086 self
->usbdev
->descriptor
.bcdDevice
);
1087 ret
= request_firmware(&fw
, stir421x_fw_name
, &self
->usbdev
->dev
);
1091 /* We get a patch from userspace */
1092 IRDA_MESSAGE("%s(): Received firmware %s (%zu bytes)\n",
1093 __FUNCTION__
, stir421x_fw_name
, fw
->size
);
1097 /* Get the bcd product version */
1098 if (!memcmp(fw
->data
, STIR421X_PATCH_PRODUCT_VER
,
1099 sizeof(STIR421X_PATCH_PRODUCT_VER
) - 1)) {
1100 fw_version_ptr
= fw
->data
+
1101 sizeof(STIR421X_PATCH_PRODUCT_VER
) - 1;
1103 /* Let's check if the product version is dotted */
1104 if (fw_version_ptr
[3] == '.' &&
1105 fw_version_ptr
[7] == '.') {
1106 unsigned long major
, minor
, build
;
1107 major
= simple_strtoul(fw_version_ptr
, NULL
, 10);
1108 minor
= simple_strtoul(fw_version_ptr
+ 4, NULL
, 10);
1109 build
= simple_strtoul(fw_version_ptr
+ 8, NULL
, 10);
1111 fw_version
= (major
<< 12)
1113 + ((build
/ 10) << 4)
1116 IRDA_DEBUG(3, "%s(): Firmware Product version %ld\n",
1117 __FUNCTION__
, fw_version
);
1121 if (self
->usbdev
->descriptor
.bcdDevice
== fw_version
) {
1123 * If we're here, we've found a correct patch
1124 * The actual image starts after the "STMP" keyword
1125 * so forward to the firmware header tag
1127 for (i
= 0; (fw
->data
[i
] != STIR421X_PATCH_END_OF_HDR_TAG
)
1128 && (i
< fw
->size
); i
++) ;
1129 /* here we check for the out of buffer case */
1130 if ((STIR421X_PATCH_END_OF_HDR_TAG
== fw
->data
[i
])
1131 && (i
< STIR421X_PATCH_CODE_OFFSET
)) {
1132 if (!memcmp(fw
->data
+ i
+ 1, STIR421X_PATCH_STMP_TAG
,
1133 sizeof(STIR421X_PATCH_STMP_TAG
) - 1)) {
1135 /* We can upload the patch to the target */
1136 i
+= sizeof(STIR421X_PATCH_STMP_TAG
);
1137 ret
= stir421x_fw_upload(self
, &fw
->data
[i
],
1143 release_firmware(fw
);
1149 /********************** IRDA DEVICE CALLBACKS **********************/
1151 * Main calls from the IrDA/Network subsystem.
1152 * Mostly registering a new irda-usb device and removing it....
1153 * We only deal with the IrDA side of the business, the USB side will
1154 * be dealt with below...
1158 /*------------------------------------------------------------------*/
1160 * Function irda_usb_net_open (dev)
1162 * Network device is taken up. Usually this is done by "ifconfig irda0 up"
1164 * Note : don't mess with self->netopen - Jean II
1166 static int irda_usb_net_open(struct net_device
*netdev
)
1168 struct irda_usb_cb
*self
;
1172 IRDA_DEBUG(1, "%s()\n", __FUNCTION__
);
1174 IRDA_ASSERT(netdev
!= NULL
, return -1;);
1175 self
= (struct irda_usb_cb
*) netdev
->priv
;
1176 IRDA_ASSERT(self
!= NULL
, return -1;);
1178 /* Can only open the device if it's there */
1179 if(!self
->present
) {
1180 IRDA_WARNING("%s(), device not present!\n", __FUNCTION__
);
1184 if(self
->needspatch
) {
1185 IRDA_WARNING("%s(), device needs patch\n", __FUNCTION__
) ;
1189 /* Initialise default speed and xbofs value
1190 * (IrLAP will change that soon) */
1193 self
->new_speed
= -1;
1194 self
->new_xbofs
= -1;
1196 /* To do *before* submitting Rx urbs and starting net Tx queue
1201 * Now that everything should be initialized properly,
1202 * Open new IrLAP layer instance to take care of us...
1203 * Note : will send immediately a speed change...
1205 sprintf(hwname
, "usb#%d", self
->usbdev
->devnum
);
1206 self
->irlap
= irlap_open(netdev
, &self
->qos
, hwname
);
1207 IRDA_ASSERT(self
->irlap
!= NULL
, return -1;);
1209 /* Allow IrLAP to send data to us */
1210 netif_start_queue(netdev
);
1212 /* We submit all the Rx URB except for one that we keep idle.
1213 * Need to be initialised before submitting other USBs, because
1214 * in some cases as soon as we submit the URBs the USB layer
1215 * will trigger a dummy receive - Jean II */
1216 self
->idle_rx_urb
= self
->rx_urb
[IU_MAX_ACTIVE_RX_URBS
];
1217 self
->idle_rx_urb
->context
= NULL
;
1219 /* Now that we can pass data to IrLAP, allow the USB layer
1220 * to send us some data... */
1221 for (i
= 0; i
< IU_MAX_ACTIVE_RX_URBS
; i
++) {
1222 struct sk_buff
*skb
= dev_alloc_skb(IRDA_SKB_MAX_MTU
);
1224 /* If this ever happen, we are in deep s***.
1225 * Basically, we can't start the Rx path... */
1226 IRDA_WARNING("%s(), Failed to allocate Rx skb\n",
1230 //skb_reserve(newskb, USB_IRDA_HEADER - 1);
1231 irda_usb_submit(self
, skb
, self
->rx_urb
[i
]);
1234 /* Ready to play !!! */
1238 /*------------------------------------------------------------------*/
1240 * Function irda_usb_net_close (self)
1242 * Network device is taken down. Usually this is done by
1243 * "ifconfig irda0 down"
1245 static int irda_usb_net_close(struct net_device
*netdev
)
1247 struct irda_usb_cb
*self
;
1250 IRDA_DEBUG(1, "%s()\n", __FUNCTION__
);
1252 IRDA_ASSERT(netdev
!= NULL
, return -1;);
1253 self
= (struct irda_usb_cb
*) netdev
->priv
;
1254 IRDA_ASSERT(self
!= NULL
, return -1;);
1256 /* Clear this flag *before* unlinking the urbs and *before*
1257 * stopping the network Tx queue - Jean II */
1260 /* Stop network Tx queue */
1261 netif_stop_queue(netdev
);
1263 /* Kill defered Rx URB */
1264 del_timer(&self
->rx_defer_timer
);
1266 /* Deallocate all the Rx path buffers (URBs and skb) */
1267 for (i
= 0; i
< self
->max_rx_urb
; i
++) {
1268 struct urb
*urb
= self
->rx_urb
[i
];
1269 struct sk_buff
*skb
= (struct sk_buff
*) urb
->context
;
1270 /* Cancel the receive command */
1272 /* The skb is ours, free it */
1275 urb
->context
= NULL
;
1278 /* Cancel Tx and speed URB - need to be synchronous to avoid races */
1279 usb_kill_urb(self
->tx_urb
);
1280 usb_kill_urb(self
->speed_urb
);
1282 /* Stop and remove instance of IrLAP */
1284 irlap_close(self
->irlap
);
1290 /*------------------------------------------------------------------*/
1292 * IOCTLs : Extra out-of-band network commands...
1294 static int irda_usb_net_ioctl(struct net_device
*dev
, struct ifreq
*rq
, int cmd
)
1296 unsigned long flags
;
1297 struct if_irda_req
*irq
= (struct if_irda_req
*) rq
;
1298 struct irda_usb_cb
*self
;
1301 IRDA_ASSERT(dev
!= NULL
, return -1;);
1303 IRDA_ASSERT(self
!= NULL
, return -1;);
1305 IRDA_DEBUG(2, "%s(), %s, (cmd=0x%X)\n", __FUNCTION__
, dev
->name
, cmd
);
1308 case SIOCSBANDWIDTH
: /* Set bandwidth */
1309 if (!capable(CAP_NET_ADMIN
))
1311 /* Protect us from USB callbacks, net watchdog and else. */
1312 spin_lock_irqsave(&self
->lock
, flags
);
1313 /* Check if the device is still there */
1315 /* Set the desired speed */
1316 self
->new_speed
= irq
->ifr_baudrate
;
1317 irda_usb_change_speed_xbofs(self
);
1319 spin_unlock_irqrestore(&self
->lock
, flags
);
1321 case SIOCSMEDIABUSY
: /* Set media busy */
1322 if (!capable(CAP_NET_ADMIN
))
1324 /* Check if the IrDA stack is still there */
1326 irda_device_set_media_busy(self
->netdev
, TRUE
);
1328 case SIOCGRECEIVING
: /* Check if we are receiving right now */
1329 irq
->ifr_receiving
= irda_usb_is_receiving(self
);
1338 /*------------------------------------------------------------------*/
1340 * Get device stats (for /proc/net/dev and ifconfig)
1342 static struct net_device_stats
*irda_usb_net_get_stats(struct net_device
*dev
)
1344 struct irda_usb_cb
*self
= dev
->priv
;
1345 return &self
->stats
;
1348 /********************* IRDA CONFIG SUBROUTINES *********************/
1350 * Various subroutines dealing with IrDA and network stuff we use to
1351 * configure and initialise each irda-usb instance.
1352 * These functions are used below in the main calls of the driver...
1355 /*------------------------------------------------------------------*/
1357 * Set proper values in the IrDA QOS structure
1359 static inline void irda_usb_init_qos(struct irda_usb_cb
*self
)
1361 struct irda_class_desc
*desc
;
1363 IRDA_DEBUG(3, "%s()\n", __FUNCTION__
);
1365 desc
= self
->irda_desc
;
1367 /* Initialize QoS for this device */
1368 irda_init_max_qos_capabilies(&self
->qos
);
1370 /* See spec section 7.2 for meaning.
1371 * Values are little endian (as most USB stuff), the IrDA stack
1372 * use it in native order (see parameters.c). - Jean II */
1373 self
->qos
.baud_rate
.bits
= le16_to_cpu(desc
->wBaudRate
);
1374 self
->qos
.min_turn_time
.bits
= desc
->bmMinTurnaroundTime
;
1375 self
->qos
.additional_bofs
.bits
= desc
->bmAdditionalBOFs
;
1376 self
->qos
.window_size
.bits
= desc
->bmWindowSize
;
1377 self
->qos
.data_size
.bits
= desc
->bmDataSize
;
1379 IRDA_DEBUG(0, "%s(), dongle says speed=0x%X, size=0x%X, window=0x%X, bofs=0x%X, turn=0x%X\n",
1380 __FUNCTION__
, 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
);
1382 /* Don't always trust what the dongle tell us */
1383 if(self
->capability
& IUC_SIR_ONLY
)
1384 self
->qos
.baud_rate
.bits
&= 0x00ff;
1385 if(self
->capability
& IUC_SMALL_PKT
)
1386 self
->qos
.data_size
.bits
= 0x07;
1387 if(self
->capability
& IUC_NO_WINDOW
)
1388 self
->qos
.window_size
.bits
= 0x01;
1389 if(self
->capability
& IUC_MAX_WINDOW
)
1390 self
->qos
.window_size
.bits
= 0x7f;
1391 if(self
->capability
& IUC_MAX_XBOFS
)
1392 self
->qos
.additional_bofs
.bits
= 0x01;
1395 /* Module parameter can override the rx window size */
1397 self
->qos
.min_turn_time
.bits
= qos_mtt_bits
;
1400 * Note : most of those values apply only for the receive path,
1401 * the transmit path will be set differently - Jean II
1403 irda_qos_bits_to_value(&self
->qos
);
1406 /*------------------------------------------------------------------*/
1408 * Initialise the network side of the irda-usb instance
1409 * Called when a new USB instance is registered in irda_usb_probe()
1411 static inline int irda_usb_open(struct irda_usb_cb
*self
)
1413 struct net_device
*netdev
= self
->netdev
;
1415 IRDA_DEBUG(1, "%s()\n", __FUNCTION__
);
1417 irda_usb_init_qos(self
);
1419 /* Override the network functions we need to use */
1420 netdev
->hard_start_xmit
= irda_usb_hard_xmit
;
1421 netdev
->tx_timeout
= irda_usb_net_timeout
;
1422 netdev
->watchdog_timeo
= 250*HZ
/1000; /* 250 ms > USB timeout */
1423 netdev
->open
= irda_usb_net_open
;
1424 netdev
->stop
= irda_usb_net_close
;
1425 netdev
->get_stats
= irda_usb_net_get_stats
;
1426 netdev
->do_ioctl
= irda_usb_net_ioctl
;
1428 return register_netdev(netdev
);
1431 /*------------------------------------------------------------------*/
1433 * Cleanup the network side of the irda-usb instance
1434 * Called when a USB instance is removed in irda_usb_disconnect()
1436 static inline void irda_usb_close(struct irda_usb_cb
*self
)
1438 IRDA_DEBUG(1, "%s()\n", __FUNCTION__
);
1440 /* Remove netdevice */
1441 unregister_netdev(self
->netdev
);
1443 /* Remove the speed buffer */
1444 kfree(self
->speed_buff
);
1445 self
->speed_buff
= NULL
;
1447 kfree(self
->tx_buff
);
1448 self
->tx_buff
= NULL
;
1451 /********************** USB CONFIG SUBROUTINES **********************/
1453 * Various subroutines dealing with USB stuff we use to configure and
1454 * initialise each irda-usb instance.
1455 * These functions are used below in the main calls of the driver...
1458 /*------------------------------------------------------------------*/
1460 * Function irda_usb_parse_endpoints(dev, ifnum)
1462 * Parse the various endpoints and find the one we need.
1464 * The endpoint are the pipes used to communicate with the USB device.
1465 * The spec defines 2 endpoints of type bulk transfer, one in, and one out.
1466 * These are used to pass frames back and forth with the dongle.
1467 * Most dongle have also an interrupt endpoint, that will be probably
1468 * documented in the next spec...
1470 static inline int irda_usb_parse_endpoints(struct irda_usb_cb
*self
, struct usb_host_endpoint
*endpoint
, int ennum
)
1472 int i
; /* Endpoint index in table */
1474 /* Init : no endpoints */
1475 self
->bulk_in_ep
= 0;
1476 self
->bulk_out_ep
= 0;
1477 self
->bulk_int_ep
= 0;
1479 /* Let's look at all those endpoints */
1480 for(i
= 0; i
< ennum
; i
++) {
1481 /* All those variables will get optimised by the compiler,
1482 * so let's aim for clarity... - Jean II */
1483 __u8 ep
; /* Endpoint address */
1484 __u8 dir
; /* Endpoint direction */
1485 __u8 attr
; /* Endpoint attribute */
1486 __u16 psize
; /* Endpoint max packet size in bytes */
1488 /* Get endpoint address, direction and attribute */
1489 ep
= endpoint
[i
].desc
.bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
1490 dir
= endpoint
[i
].desc
.bEndpointAddress
& USB_ENDPOINT_DIR_MASK
;
1491 attr
= endpoint
[i
].desc
.bmAttributes
;
1492 psize
= le16_to_cpu(endpoint
[i
].desc
.wMaxPacketSize
);
1494 /* Is it a bulk endpoint ??? */
1495 if(attr
== USB_ENDPOINT_XFER_BULK
) {
1496 /* We need to find an IN and an OUT */
1497 if(dir
== USB_DIR_IN
) {
1498 /* This is our Rx endpoint */
1499 self
->bulk_in_ep
= ep
;
1501 /* This is our Tx endpoint */
1502 self
->bulk_out_ep
= ep
;
1503 self
->bulk_out_mtu
= psize
;
1506 if((attr
== USB_ENDPOINT_XFER_INT
) &&
1507 (dir
== USB_DIR_IN
)) {
1508 /* This is our interrupt endpoint */
1509 self
->bulk_int_ep
= ep
;
1511 IRDA_ERROR("%s(), Unrecognised endpoint %02X.\n", __FUNCTION__
, ep
);
1516 IRDA_DEBUG(0, "%s(), And our endpoints are : in=%02X, out=%02X (%d), int=%02X\n",
1517 __FUNCTION__
, self
->bulk_in_ep
, self
->bulk_out_ep
, self
->bulk_out_mtu
, self
->bulk_int_ep
);
1519 return((self
->bulk_in_ep
!= 0) && (self
->bulk_out_ep
!= 0));
1522 #ifdef IU_DUMP_CLASS_DESC
1523 /*------------------------------------------------------------------*/
1525 * Function usb_irda_dump_class_desc(desc)
1527 * Prints out the contents of the IrDA class descriptor
1530 static inline void irda_usb_dump_class_desc(struct irda_class_desc
*desc
)
1532 /* Values are little endian */
1533 printk("bLength=%x\n", desc
->bLength
);
1534 printk("bDescriptorType=%x\n", desc
->bDescriptorType
);
1535 printk("bcdSpecRevision=%x\n", le16_to_cpu(desc
->bcdSpecRevision
));
1536 printk("bmDataSize=%x\n", desc
->bmDataSize
);
1537 printk("bmWindowSize=%x\n", desc
->bmWindowSize
);
1538 printk("bmMinTurnaroundTime=%d\n", desc
->bmMinTurnaroundTime
);
1539 printk("wBaudRate=%x\n", le16_to_cpu(desc
->wBaudRate
));
1540 printk("bmAdditionalBOFs=%x\n", desc
->bmAdditionalBOFs
);
1541 printk("bIrdaRateSniff=%x\n", desc
->bIrdaRateSniff
);
1542 printk("bMaxUnicastList=%x\n", desc
->bMaxUnicastList
);
1544 #endif /* IU_DUMP_CLASS_DESC */
1546 /*------------------------------------------------------------------*/
1548 * Function irda_usb_find_class_desc(intf)
1550 * Returns instance of IrDA class descriptor, or NULL if not found
1552 * The class descriptor is some extra info that IrDA USB devices will
1553 * offer to us, describing their IrDA characteristics. We will use that in
1554 * irda_usb_init_qos()
1556 static inline struct irda_class_desc
*irda_usb_find_class_desc(struct usb_interface
*intf
)
1558 struct usb_device
*dev
= interface_to_usbdev (intf
);
1559 struct irda_class_desc
*desc
;
1562 desc
= kmalloc(sizeof (*desc
), GFP_KERNEL
);
1565 memset(desc
, 0, sizeof(*desc
));
1567 /* USB-IrDA class spec 1.0:
1568 * 6.1.3: Standard "Get Descriptor" Device Request is not
1569 * appropriate to retrieve class-specific descriptor
1570 * 6.2.5: Class Specific "Get Class Descriptor" Interface Request
1571 * is mandatory and returns the USB-IrDA class descriptor
1574 ret
= usb_control_msg(dev
, usb_rcvctrlpipe(dev
,0),
1575 IU_REQ_GET_CLASS_DESC
,
1576 USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
1577 0, intf
->altsetting
->desc
.bInterfaceNumber
, desc
,
1578 sizeof(*desc
), 500);
1580 IRDA_DEBUG(1, "%s(), ret=%d\n", __FUNCTION__
, ret
);
1581 if (ret
< sizeof(*desc
)) {
1582 IRDA_WARNING("usb-irda: class_descriptor read %s (%d)\n",
1583 (ret
<0) ? "failed" : "too short", ret
);
1585 else if (desc
->bDescriptorType
!= USB_DT_IRDA
) {
1586 IRDA_WARNING("usb-irda: bad class_descriptor type\n");
1589 #ifdef IU_DUMP_CLASS_DESC
1590 irda_usb_dump_class_desc(desc
);
1591 #endif /* IU_DUMP_CLASS_DESC */
1599 /*********************** USB DEVICE CALLBACKS ***********************/
1601 * Main calls from the USB subsystem.
1602 * Mostly registering a new irda-usb device and removing it....
1605 /*------------------------------------------------------------------*/
1607 * This routine is called by the USB subsystem for each new device
1608 * in the system. We need to check if the device is ours, and in
1609 * this case start handling it.
1610 * The USB layer protect us from reentrancy (via BKL), so we don't need
1611 * to spinlock in there... Jean II
1613 static int irda_usb_probe(struct usb_interface
*intf
,
1614 const struct usb_device_id
*id
)
1616 struct net_device
*net
;
1617 struct usb_device
*dev
= interface_to_usbdev(intf
);
1618 struct irda_usb_cb
*self
= NULL
;
1619 struct usb_host_interface
*interface
;
1620 struct irda_class_desc
*irda_desc
;
1622 int i
; /* Driver instance index / Rx URB index */
1624 /* Note : the probe make sure to call us only for devices that
1625 * matches the list of dongle (top of the file). So, we
1626 * don't need to check if the dongle is really ours.
1629 IRDA_MESSAGE("IRDA-USB found at address %d, Vendor: %x, Product: %x\n",
1630 dev
->devnum
, le16_to_cpu(dev
->descriptor
.idVendor
),
1631 le16_to_cpu(dev
->descriptor
.idProduct
));
1633 net
= alloc_irdadev(sizeof(*self
));
1637 SET_MODULE_OWNER(net
);
1638 SET_NETDEV_DEV(net
, &intf
->dev
);
1641 spin_lock_init(&self
->lock
);
1642 init_timer(&self
->rx_defer_timer
);
1644 self
->capability
= id
->driver_info
;
1645 self
->needspatch
= ((self
->capability
& IUC_STIR421X
) != 0);
1647 /* Create all of the needed urbs */
1648 if (self
->capability
& IUC_STIR421X
) {
1649 self
->max_rx_urb
= IU_SIGMATEL_MAX_RX_URBS
;
1650 self
->header_length
= USB_IRDA_STIR421X_HEADER
;
1652 self
->max_rx_urb
= IU_MAX_RX_URBS
;
1653 self
->header_length
= USB_IRDA_HEADER
;
1656 self
->rx_urb
= kzalloc(self
->max_rx_urb
* sizeof(struct urb
*),
1659 for (i
= 0; i
< self
->max_rx_urb
; i
++) {
1660 self
->rx_urb
[i
] = usb_alloc_urb(0, GFP_KERNEL
);
1661 if (!self
->rx_urb
[i
]) {
1665 self
->tx_urb
= usb_alloc_urb(0, GFP_KERNEL
);
1666 if (!self
->tx_urb
) {
1669 self
->speed_urb
= usb_alloc_urb(0, GFP_KERNEL
);
1670 if (!self
->speed_urb
) {
1674 /* Is this really necessary? (no, except maybe for broken devices) */
1675 if (usb_reset_configuration (dev
) < 0) {
1676 err("reset_configuration failed");
1681 /* Is this really necessary? */
1682 /* Note : some driver do hardcode the interface number, some others
1683 * specify an alternate, but very few driver do like this.
1685 ret
= usb_set_interface(dev
, intf
->altsetting
->desc
.bInterfaceNumber
, 0);
1686 IRDA_DEBUG(1, "usb-irda: set interface %d result %d\n", intf
->altsetting
->desc
.bInterfaceNumber
, ret
);
1690 case -EPIPE
: /* -EPIPE = -32 */
1691 /* Martin Diehl says if we get a -EPIPE we should
1692 * be fine and we don't need to do a usb_clear_halt().
1694 IRDA_DEBUG(0, "%s(), Received -EPIPE, ignoring...\n", __FUNCTION__
);
1697 IRDA_DEBUG(0, "%s(), Unknown error %d\n", __FUNCTION__
, ret
);
1702 /* Find our endpoints */
1703 interface
= intf
->cur_altsetting
;
1704 if(!irda_usb_parse_endpoints(self
, interface
->endpoint
,
1705 interface
->desc
.bNumEndpoints
)) {
1706 IRDA_ERROR("%s(), Bogus endpoints...\n", __FUNCTION__
);
1713 /* Find IrDA class descriptor */
1714 irda_desc
= irda_usb_find_class_desc(intf
);
1716 if (irda_desc
== NULL
)
1719 if (self
->needspatch
) {
1720 ret
= usb_control_msg (self
->usbdev
, usb_sndctrlpipe (self
->usbdev
, 0),
1721 0x02, 0x40, 0, 0, NULL
, 0, 500);
1723 IRDA_DEBUG (0, "usb_control_msg failed %d\n", ret
);
1730 self
->irda_desc
= irda_desc
;
1733 self
->usbintf
= intf
;
1735 /* Allocate the buffer for speed changes */
1736 /* Don't change this buffer size and allocation without doing
1737 * some heavy and complete testing. Don't ask why :-(
1739 self
->speed_buff
= kmalloc(IRDA_USB_SPEED_MTU
, GFP_KERNEL
);
1740 if (self
->speed_buff
== NULL
)
1743 memset(self
->speed_buff
, 0, IRDA_USB_SPEED_MTU
);
1745 self
->tx_buff
= kzalloc(IRDA_SKB_MAX_MTU
+ self
->header_length
,
1747 if (self
->tx_buff
== NULL
)
1750 ret
= irda_usb_open(self
);
1754 IRDA_MESSAGE("IrDA: Registered device %s\n", net
->name
);
1755 usb_set_intfdata(intf
, self
);
1757 if (self
->needspatch
) {
1758 /* Now we fetch and upload the firmware patch */
1759 ret
= stir421x_patch_device(self
);
1760 self
->needspatch
= (ret
< 0);
1761 if (self
->needspatch
) {
1762 IRDA_ERROR("STIR421X: Couldn't upload patch\n");
1766 /* replace IrDA class descriptor with what patched device is now reporting */
1767 irda_desc
= irda_usb_find_class_desc (self
->usbintf
);
1768 if (irda_desc
== NULL
) {
1772 if (self
->irda_desc
)
1773 kfree (self
->irda_desc
);
1774 self
->irda_desc
= irda_desc
;
1775 irda_usb_init_qos(self
);
1780 unregister_netdev(self
->netdev
);
1782 kfree(self
->tx_buff
);
1784 kfree(self
->speed_buff
);
1786 /* Free all urbs that we may have created */
1787 usb_free_urb(self
->speed_urb
);
1789 usb_free_urb(self
->tx_urb
);
1791 for (i
= 0; i
< self
->max_rx_urb
; i
++)
1792 usb_free_urb(self
->rx_urb
[i
]);
1798 /*------------------------------------------------------------------*/
1800 * The current irda-usb device is removed, the USB layer tell us
1801 * to shut it down...
1802 * One of the constraints is that when we exit this function,
1803 * we cannot use the usb_device no more. Gone. Destroyed. kfree().
1804 * Most other subsystem allow you to destroy the instance at a time
1805 * when it's convenient to you, to postpone it to a later date, but
1806 * not the USB subsystem.
1807 * So, we must make bloody sure that everything gets deactivated.
1810 static void irda_usb_disconnect(struct usb_interface
*intf
)
1812 unsigned long flags
;
1813 struct irda_usb_cb
*self
= usb_get_intfdata(intf
);
1816 IRDA_DEBUG(1, "%s()\n", __FUNCTION__
);
1818 usb_set_intfdata(intf
, NULL
);
1822 /* Make sure that the Tx path is not executing. - Jean II */
1823 spin_lock_irqsave(&self
->lock
, flags
);
1825 /* Oups ! We are not there any more.
1826 * This will stop/desactivate the Tx path. - Jean II */
1829 /* Kill defered Rx URB */
1830 del_timer(&self
->rx_defer_timer
);
1832 /* We need to have irq enabled to unlink the URBs. That's OK,
1833 * at this point the Tx path is gone - Jean II */
1834 spin_unlock_irqrestore(&self
->lock
, flags
);
1836 /* Hum... Check if networking is still active (avoid races) */
1837 if((self
->netopen
) || (self
->irlap
)) {
1838 /* Accept no more transmissions */
1839 /*netif_device_detach(self->netdev);*/
1840 netif_stop_queue(self
->netdev
);
1841 /* Stop all the receive URBs. Must be synchronous. */
1842 for (i
= 0; i
< self
->max_rx_urb
; i
++)
1843 usb_kill_urb(self
->rx_urb
[i
]);
1844 /* Cancel Tx and speed URB.
1845 * Make sure it's synchronous to avoid races. */
1846 usb_kill_urb(self
->tx_urb
);
1847 usb_kill_urb(self
->speed_urb
);
1850 /* Cleanup the device stuff */
1851 irda_usb_close(self
);
1852 /* No longer attached to USB bus */
1853 self
->usbdev
= NULL
;
1854 self
->usbintf
= NULL
;
1856 /* Clean up our urbs */
1857 for (i
= 0; i
< self
->max_rx_urb
; i
++)
1858 usb_free_urb(self
->rx_urb
[i
]);
1859 kfree(self
->rx_urb
);
1860 /* Clean up Tx and speed URB */
1861 usb_free_urb(self
->tx_urb
);
1862 usb_free_urb(self
->speed_urb
);
1864 /* Free self and network device */
1865 free_netdev(self
->netdev
);
1866 IRDA_DEBUG(0, "%s(), USB IrDA Disconnected\n", __FUNCTION__
);
1869 /*------------------------------------------------------------------*/
1871 * USB device callbacks
1873 static struct usb_driver irda_driver
= {
1875 .probe
= irda_usb_probe
,
1876 .disconnect
= irda_usb_disconnect
,
1877 .id_table
= dongles
,
1880 /************************* MODULE CALLBACKS *************************/
1882 * Deal with module insertion/removal
1883 * Mostly tell USB about our existence
1886 /*------------------------------------------------------------------*/
1890 static int __init
usb_irda_init(void)
1894 ret
= usb_register(&irda_driver
);
1898 IRDA_MESSAGE("USB IrDA support registered\n");
1901 module_init(usb_irda_init
);
1903 /*------------------------------------------------------------------*/
1907 static void __exit
usb_irda_cleanup(void)
1909 /* Deregister the driver and remove all pending instances */
1910 usb_deregister(&irda_driver
);
1912 module_exit(usb_irda_cleanup
);
1914 /*------------------------------------------------------------------*/
1918 module_param(qos_mtt_bits
, int, 0);
1919 MODULE_PARM_DESC(qos_mtt_bits
, "Minimum Turn Time");
1920 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>");
1921 MODULE_DESCRIPTION("IrDA-USB Dongle Driver");
1922 MODULE_LICENSE("GPL");