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/skbuff.h>
62 #include <linux/netdevice.h>
63 #include <linux/slab.h>
64 #include <linux/rtnetlink.h>
65 #include <linux/usb.h>
66 #include <linux/firmware.h>
70 /*------------------------------------------------------------------*/
72 static int qos_mtt_bits
= 0;
74 /* These are the currently known IrDA USB dongles. Add new dongles here */
75 static struct usb_device_id dongles
[] = {
76 /* ACTiSYS Corp., ACT-IR2000U FIR-USB Adapter */
77 { USB_DEVICE(0x9c4, 0x011), .driver_info
= IUC_SPEED_BUG
| IUC_NO_WINDOW
},
78 /* Look like ACTiSYS, Report : IBM Corp., IBM UltraPort IrDA */
79 { USB_DEVICE(0x4428, 0x012), .driver_info
= IUC_SPEED_BUG
| IUC_NO_WINDOW
},
80 /* KC Technology Inc., KC-180 USB IrDA Device */
81 { USB_DEVICE(0x50f, 0x180), .driver_info
= IUC_SPEED_BUG
| IUC_NO_WINDOW
},
82 /* Extended Systems, Inc., XTNDAccess IrDA USB (ESI-9685) */
83 { USB_DEVICE(0x8e9, 0x100), .driver_info
= IUC_SPEED_BUG
| IUC_NO_WINDOW
},
84 /* SigmaTel STIR4210/4220/4116 USB IrDA (VFIR) Bridge */
85 { USB_DEVICE(0x66f, 0x4210), .driver_info
= IUC_STIR421X
| IUC_SPEED_BUG
},
86 { USB_DEVICE(0x66f, 0x4220), .driver_info
= IUC_STIR421X
| IUC_SPEED_BUG
},
87 { USB_DEVICE(0x66f, 0x4116), .driver_info
= IUC_STIR421X
| IUC_SPEED_BUG
},
88 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
|
89 USB_DEVICE_ID_MATCH_INT_SUBCLASS
,
90 .bInterfaceClass
= USB_CLASS_APP_SPEC
,
91 .bInterfaceSubClass
= USB_CLASS_IRDA
,
92 .driver_info
= IUC_DEFAULT
, },
98 * Devices based on the SigmaTel chipset (0x66f, 0x4200) are not designed
99 * using the "USB-IrDA specification" (yes, there exist such a thing), and
100 * therefore not supported by this driver (don't add them above).
101 * There is a Linux driver, stir4200, that support those USB devices.
105 MODULE_DEVICE_TABLE(usb
, dongles
);
107 /*------------------------------------------------------------------*/
109 static void irda_usb_init_qos(struct irda_usb_cb
*self
) ;
110 static struct irda_class_desc
*irda_usb_find_class_desc(struct usb_interface
*intf
);
111 static void irda_usb_disconnect(struct usb_interface
*intf
);
112 static void irda_usb_change_speed_xbofs(struct irda_usb_cb
*self
);
113 static netdev_tx_t
irda_usb_hard_xmit(struct sk_buff
*skb
,
114 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
);
126 /************************ TRANSMIT ROUTINES ************************/
128 * Receive packets from the IrDA stack and send them on the USB pipe.
129 * Handle speed change, timeout and lot's of ugliness...
132 /*------------------------------------------------------------------*/
134 * Function irda_usb_build_header(self, skb, header)
136 * Builds USB-IrDA outbound header
138 * When we send an IrDA frame over an USB pipe, we add to it a 1 byte
139 * header. This function create this header with the proper values.
141 * Important note : the USB-IrDA spec 1.0 say very clearly in chapter 5.4.2.2
142 * that the setting of the link speed and xbof number in this outbound header
143 * should be applied *AFTER* the frame has been sent.
144 * Unfortunately, some devices are not compliant with that... It seems that
145 * reading the spec is far too difficult...
148 static void irda_usb_build_header(struct irda_usb_cb
*self
,
152 /* Here we check if we have an STIR421x chip,
153 * and if either speed or xbofs (or both) needs
156 if (self
->capability
& IUC_STIR421X
&&
157 ((self
->new_speed
!= -1) || (self
->new_xbofs
!= -1))) {
159 /* With STIR421x, speed and xBOFs must be set at the same
160 * time, even if only one of them changes.
162 if (self
->new_speed
== -1)
163 self
->new_speed
= self
->speed
;
165 if (self
->new_xbofs
== -1)
166 self
->new_xbofs
= self
->xbofs
;
169 /* Set the link speed */
170 if (self
->new_speed
!= -1) {
171 /* Hum... Ugly hack :-(
172 * Some device are not compliant with the spec and change
173 * parameters *before* sending the frame. - Jean II
175 if ((self
->capability
& IUC_SPEED_BUG
) &&
176 (!force
) && (self
->speed
!= -1)) {
177 /* No speed and xbofs change here
178 * (we'll do it later in the write callback) */
179 pr_debug("%s(), not changing speed yet\n", __func__
);
184 pr_debug("%s(), changing speed to %d\n",
185 __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 pr_debug("%s(), changing xbofs to %d\n",
232 __func__
, self
->new_xbofs
);
233 self
->xbofs
= self
->new_xbofs
;
234 /* We will do ` self->new_xbofs = -1; ' in the completion
235 * handler just in case the current URB fail - Jean II */
237 switch (self
->xbofs
) {
242 case 24: /* USB spec 1.0 says 24 */
249 case 5: /* Bug in IrLAP spec? (should be 6) */
270 * calculate turnaround time for SigmaTel header
272 static __u8
get_turnaround_time(struct sk_buff
*skb
)
274 int turnaround_time
= irda_get_mtt(skb
);
276 if ( turnaround_time
== 0 )
278 else if ( turnaround_time
<= 10 )
280 else if ( turnaround_time
<= 50 )
282 else if ( turnaround_time
<= 100 )
284 else if ( turnaround_time
<= 500 )
286 else if ( turnaround_time
<= 1000 )
288 else if ( turnaround_time
<= 5000 )
295 /*------------------------------------------------------------------*/
297 * Send a command to change the speed of the dongle
298 * Need to be called with spinlock on.
300 static void irda_usb_change_speed_xbofs(struct irda_usb_cb
*self
)
306 pr_debug("%s(), speed=%d, xbofs=%d\n", __func__
,
307 self
->new_speed
, self
->new_xbofs
);
309 /* Grab the speed URB */
310 urb
= self
->speed_urb
;
311 if (urb
->status
!= 0) {
312 net_warn_ratelimited("%s(), URB still in use!\n", __func__
);
316 /* Allocate the fake frame */
317 frame
= self
->speed_buff
;
319 /* Set the new speed and xbofs in this fake frame */
320 irda_usb_build_header(self
, frame
, 1);
322 if (self
->capability
& IUC_STIR421X
) {
323 if (frame
[0] == 0) return ; // do nothing if no change
324 frame
[1] = 0; // other parameters don't change here
328 /* Submit the 0 length IrDA frame to trigger new speed settings */
329 usb_fill_bulk_urb(urb
, self
->usbdev
,
330 usb_sndbulkpipe(self
->usbdev
, self
->bulk_out_ep
),
331 frame
, IRDA_USB_SPEED_MTU
,
332 speed_bulk_callback
, self
);
333 urb
->transfer_buffer_length
= self
->header_length
;
334 urb
->transfer_flags
= 0;
336 /* Irq disabled -> GFP_ATOMIC */
337 if ((ret
= usb_submit_urb(urb
, GFP_ATOMIC
))) {
338 net_warn_ratelimited("%s(), failed Speed URB\n", __func__
);
342 /*------------------------------------------------------------------*/
345 * Now, we can only get called for the speed URB.
347 static void speed_bulk_callback(struct urb
*urb
)
349 struct irda_usb_cb
*self
= urb
->context
;
351 /* We should always have a context */
352 IRDA_ASSERT(self
!= NULL
, return;);
353 /* We should always be called for the speed URB */
354 IRDA_ASSERT(urb
== self
->speed_urb
, return;);
356 /* Check for timeout and other USB nasties */
357 if (urb
->status
!= 0) {
358 /* I get a lot of -ECONNABORTED = -103 here - Jean II */
359 pr_debug("%s(), URB complete status %d, transfer_flags 0x%04X\n",
360 __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 committed 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 netdev_tx_t
irda_usb_hard_xmit(struct sk_buff
*skb
,
386 struct net_device
*netdev
)
388 struct irda_usb_cb
*self
= netdev_priv(netdev
);
389 struct urb
*urb
= self
->tx_urb
;
395 pr_debug("%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 pr_debug("%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 */
438 if (urb
->status
!= 0) {
439 net_warn_ratelimited("%s(), URB still in use!\n", __func__
);
443 skb_copy_from_linear_data(skb
, self
->tx_buff
+ self
->header_length
, skb
->len
);
445 /* Change setting for next frame */
446 if (self
->capability
& IUC_STIR421X
) {
447 __u8 turnaround_time
;
448 __u8
* frame
= self
->tx_buff
;
449 turnaround_time
= get_turnaround_time( skb
);
450 irda_usb_build_header(self
, frame
, 0);
451 frame
[2] = turnaround_time
;
452 if ((skb
->len
!= 0) &&
453 ((skb
->len
% 128) == 0) &&
454 ((skb
->len
% 512) != 0)) {
455 /* add extra byte for special SigmaTel feature */
462 irda_usb_build_header(self
, self
->tx_buff
, 0);
465 /* FIXME: Make macro out of this one */
466 ((struct irda_skb_cb
*)skb
->cb
)->context
= self
;
468 usb_fill_bulk_urb(urb
, self
->usbdev
,
469 usb_sndbulkpipe(self
->usbdev
, self
->bulk_out_ep
),
470 self
->tx_buff
, skb
->len
+ self
->header_length
,
471 write_bulk_callback
, skb
);
473 /* This flag (URB_ZERO_PACKET) indicates that what we send is not
474 * a continuous stream of data but separate packets.
475 * In this case, the USB layer will insert an empty USB frame (TD)
476 * after each of our packets that is exact multiple of the frame size.
477 * This is how the dongle will detect the end of packet - Jean II */
478 urb
->transfer_flags
= URB_ZERO_PACKET
;
480 /* Generate min turn time. FIXME: can we do better than this? */
481 /* Trying to a turnaround time at this level is trying to measure
482 * processor clock cycle with a wrist-watch, approximate at best...
484 * What we know is the last time we received a frame over USB.
485 * Due to latency over USB that depend on the USB load, we don't
486 * know when this frame was received over IrDA (a few ms before ?)
487 * Then, same story for our outgoing frame...
489 * In theory, the USB dongle is supposed to handle the turnaround
490 * by itself (spec 1.0, chater 4, page 6). Who knows ??? That's
491 * why this code is enabled only for dongles that doesn't meet
494 if (self
->capability
& IUC_NO_TURN
) {
495 mtt
= irda_get_mtt(skb
);
498 diff
= ktime_us_delta(ktime_get(), self
->stamp
);
499 #ifdef IU_USB_MIN_RTT
500 /* Factor in USB delays -> Get rid of udelay() that
501 * would be lost in the noise - Jean II */
502 diff
+= IU_USB_MIN_RTT
;
503 #endif /* IU_USB_MIN_RTT */
505 /* Check if the mtt is larger than the time we have
506 * already used by all the protocol processing
518 /* Ask USB to send the packet - Irq disabled -> GFP_ATOMIC */
519 if ((res
= usb_submit_urb(urb
, GFP_ATOMIC
))) {
520 net_warn_ratelimited("%s(), failed Tx URB\n", __func__
);
521 netdev
->stats
.tx_errors
++;
522 /* Let USB recover : We will catch that in the watchdog */
523 /*netif_start_queue(netdev);*/
525 /* Increment packet stats */
526 netdev
->stats
.tx_packets
++;
527 netdev
->stats
.tx_bytes
+= skb
->len
;
529 netdev
->trans_start
= jiffies
;
531 spin_unlock_irqrestore(&self
->lock
, flags
);
536 /* Drop silently the skb and exit */
538 spin_unlock_irqrestore(&self
->lock
, flags
);
542 /*------------------------------------------------------------------*/
544 * Note : this function will be called only for tx_urb...
546 static void write_bulk_callback(struct urb
*urb
)
549 struct sk_buff
*skb
= urb
->context
;
550 struct irda_usb_cb
*self
= ((struct irda_skb_cb
*) skb
->cb
)->context
;
552 /* We should always have a context */
553 IRDA_ASSERT(self
!= NULL
, return;);
554 /* We should always be called for the speed URB */
555 IRDA_ASSERT(urb
== self
->tx_urb
, return;);
557 /* Free up the skb */
558 dev_kfree_skb_any(skb
);
561 /* Check for timeout and other USB nasties */
562 if (urb
->status
!= 0) {
563 /* I get a lot of -ECONNABORTED = -103 here - Jean II */
564 pr_debug("%s(), URB complete status %d, transfer_flags 0x%04X\n",
565 __func__
, urb
->status
, urb
->transfer_flags
);
567 /* Don't do anything here, that might confuse the USB layer,
568 * and we could go in recursion and blow the kernel stack...
569 * Instead, we will wait for irda_usb_net_timeout(), the
570 * network layer watchdog, to fix the situation.
572 /* A reset of the dongle might be welcomed here - Jean II */
576 /* urb is now available */
577 //urb->status = 0; -> tested above
579 /* Make sure we read self->present properly */
580 spin_lock_irqsave(&self
->lock
, flags
);
582 /* If the network is closed, stop everything */
583 if ((!self
->netopen
) || (!self
->present
)) {
584 pr_debug("%s(), Network is gone...\n", __func__
);
585 spin_unlock_irqrestore(&self
->lock
, flags
);
589 /* If changes to speed or xbofs is pending... */
590 if ((self
->new_speed
!= -1) || (self
->new_xbofs
!= -1)) {
591 if ((self
->new_speed
!= self
->speed
) ||
592 (self
->new_xbofs
!= self
->xbofs
)) {
593 /* We haven't changed speed yet (because of
594 * IUC_SPEED_BUG), so do it now - Jean II */
595 pr_debug("%s(), Changing speed now...\n", __func__
);
596 irda_usb_change_speed_xbofs(self
);
598 /* New speed and xbof is now committed in hardware */
599 self
->new_speed
= -1;
600 self
->new_xbofs
= -1;
601 /* Done, waiting for next packet */
602 netif_wake_queue(self
->netdev
);
605 /* Otherwise, allow the stack to send more packets */
606 netif_wake_queue(self
->netdev
);
608 spin_unlock_irqrestore(&self
->lock
, flags
);
611 /*------------------------------------------------------------------*/
613 * Watchdog timer from the network layer.
614 * After a predetermined timeout, if we don't give confirmation that
615 * the packet has been sent (i.e. no call to netif_wake_queue()),
616 * the network layer will call this function.
617 * Note that URB that we submit have also a timeout. When the URB timeout
618 * expire, the normal URB callback is called (write_bulk_callback()).
620 static void irda_usb_net_timeout(struct net_device
*netdev
)
623 struct irda_usb_cb
*self
= netdev_priv(netdev
);
625 int done
= 0; /* If we have made any progress */
627 pr_debug("%s(), Network layer thinks we timed out!\n", __func__
);
628 IRDA_ASSERT(self
!= NULL
, return;);
630 /* Protect us from USB callbacks, net Tx and else. */
631 spin_lock_irqsave(&self
->lock
, flags
);
633 /* self->present *MUST* be read under spinlock */
634 if (!self
->present
) {
635 net_warn_ratelimited("%s(), device not present!\n", __func__
);
636 netif_stop_queue(netdev
);
637 spin_unlock_irqrestore(&self
->lock
, flags
);
641 /* Check speed URB */
642 urb
= self
->speed_urb
;
643 if (urb
->status
!= 0) {
644 pr_debug("%s: Speed change timed out, urb->status=%d, urb->transfer_flags=0x%04X\n",
645 netdev
->name
, urb
->status
, urb
->transfer_flags
);
647 switch (urb
->status
) {
650 /* Note : above will *NOT* call netif_wake_queue()
651 * in completion handler, we will come back here.
656 case -ENOENT
: /* urb unlinked by us */
657 default: /* ??? - Play safe */
659 netif_wake_queue(self
->netdev
);
667 if (urb
->status
!= 0) {
668 struct sk_buff
*skb
= urb
->context
;
670 pr_debug("%s: Tx timed out, urb->status=%d, urb->transfer_flags=0x%04X\n",
671 netdev
->name
, urb
->status
, urb
->transfer_flags
);
673 /* Increase error count */
674 netdev
->stats
.tx_errors
++;
676 #ifdef IU_BUG_KICK_TIMEOUT
677 /* Can't be a bad idea to reset the speed ;-) - Jean II */
678 if(self
->new_speed
== -1)
679 self
->new_speed
= self
->speed
;
680 if(self
->new_xbofs
== -1)
681 self
->new_xbofs
= self
->xbofs
;
682 irda_usb_change_speed_xbofs(self
);
683 #endif /* IU_BUG_KICK_TIMEOUT */
685 switch (urb
->status
) {
688 /* Note : above will *NOT* call netif_wake_queue()
689 * in completion handler, because urb->status will
690 * be -ENOENT. We will fix that at the next watchdog,
691 * leaving more time to USB to recover...
696 case -ENOENT
: /* urb unlinked by us */
697 default: /* ??? - Play safe */
699 dev_kfree_skb_any(skb
);
703 netif_wake_queue(self
->netdev
);
708 spin_unlock_irqrestore(&self
->lock
, flags
);
710 /* Maybe we need a reset */
711 /* Note : Some drivers seem to use a usb_set_interface() when they
712 * need to reset the hardware. Hum...
718 /************************* RECEIVE ROUTINES *************************/
720 * Receive packets from the USB layer stack and pass them to the IrDA stack.
721 * Try to work around USB failures...
726 * Some of you may have noticed that most dongle have an interrupt in pipe
727 * that we don't use. Here is the little secret...
728 * When we hang a Rx URB on the bulk in pipe, it generates some USB traffic
729 * in every USB frame. This is unnecessary overhead.
730 * The interrupt in pipe will generate an event every time a packet is
731 * received. Reading an interrupt pipe adds minimal overhead, but has some
733 * If we are connected (speed != 9600), we want to minimise latency, so
734 * we just always hang the Rx URB and ignore the interrupt.
735 * If we are not connected (speed == 9600), there is usually no Rx traffic,
736 * and we want to minimise the USB overhead. In this case we should wait
737 * on the interrupt pipe and hang the Rx URB only when an interrupt is
741 * Note : don't read the above as what we are currently doing, but as
742 * something we could do with KC dongle. Also don't forget that the
743 * interrupt pipe is not part of the original standard, so this would
744 * need to be optional...
748 /*------------------------------------------------------------------*/
750 * Submit a Rx URB to the USB layer to handle reception of a frame
751 * Mostly called by the completion callback of the previous URB.
755 static void irda_usb_submit(struct irda_usb_cb
*self
, struct sk_buff
*skb
, struct urb
*urb
)
757 struct irda_skb_cb
*cb
;
760 /* This should never happen */
761 IRDA_ASSERT(skb
!= NULL
, return;);
762 IRDA_ASSERT(urb
!= NULL
, return;);
764 /* Save ourselves in the skb */
765 cb
= (struct irda_skb_cb
*) skb
->cb
;
768 /* Reinitialize URB */
769 usb_fill_bulk_urb(urb
, self
->usbdev
,
770 usb_rcvbulkpipe(self
->usbdev
, self
->bulk_in_ep
),
771 skb
->data
, IRDA_SKB_MAX_MTU
,
772 irda_usb_receive
, skb
);
775 /* Can be called from irda_usb_receive (irq handler) -> GFP_ATOMIC */
776 ret
= usb_submit_urb(urb
, GFP_ATOMIC
);
778 /* If this ever happen, we are in deep s***.
779 * Basically, the Rx path will stop... */
780 net_warn_ratelimited("%s(), Failed to submit Rx URB %d\n",
785 /*------------------------------------------------------------------*/
787 * Function irda_usb_receive(urb)
789 * Called by the USB subsystem when a frame has been received
792 static void irda_usb_receive(struct urb
*urb
)
794 struct sk_buff
*skb
= (struct sk_buff
*) urb
->context
;
795 struct irda_usb_cb
*self
;
796 struct irda_skb_cb
*cb
;
797 struct sk_buff
*newskb
;
798 struct sk_buff
*dataskb
;
799 struct urb
*next_urb
;
800 unsigned int len
, docopy
;
802 pr_debug("%s(), len=%d\n", __func__
, urb
->actual_length
);
805 cb
= (struct irda_skb_cb
*) skb
->cb
;
806 IRDA_ASSERT(cb
!= NULL
, return;);
807 self
= (struct irda_usb_cb
*) cb
->context
;
808 IRDA_ASSERT(self
!= NULL
, return;);
810 /* If the network is closed or the device gone, stop everything */
811 if ((!self
->netopen
) || (!self
->present
)) {
812 pr_debug("%s(), Network is gone!\n", __func__
);
813 /* Don't re-submit the URB : will stall the Rx path */
817 /* Check the status */
818 if (urb
->status
!= 0) {
819 switch (urb
->status
) {
821 self
->netdev
->stats
.rx_crc_errors
++;
822 /* Also precursor to a hot-unplug on UHCI. */
825 /* Random error, if I remember correctly */
826 /* uhci_cleanup_unlink() is going to kill the Rx
827 * URB just after we return. No problem, at this
828 * point the URB will be idle ;-) - Jean II */
830 /* That's usually a hot-unplug. Submit will fail... */
832 /* Usually precursor to a hot-unplug on OHCI. */
834 self
->netdev
->stats
.rx_errors
++;
835 pr_debug("%s(), RX status %d, transfer_flags 0x%04X\n",
836 __func__
, urb
->status
, urb
->transfer_flags
);
839 /* If we received an error, we don't want to resubmit the
840 * Rx URB straight away but to give the USB layer a little
841 * bit of breathing room.
842 * We are in the USB thread context, therefore there is a
843 * danger of recursion (new URB we submit fails, we come
845 * With recent USB stack (2.6.15+), I'm seeing that on
846 * hot unplug of the dongle...
847 * Lowest effective timer is 10ms...
849 self
->rx_defer_timer
.function
= irda_usb_rx_defer_expired
;
850 self
->rx_defer_timer
.data
= (unsigned long) urb
;
851 mod_timer(&self
->rx_defer_timer
,
852 jiffies
+ msecs_to_jiffies(10));
857 /* Check for empty frames */
858 if (urb
->actual_length
<= self
->header_length
) {
859 net_warn_ratelimited("%s(), empty frame!\n", __func__
);
864 * Remember the time we received this frame, so we can
865 * reduce the min turn time a bit since we will know
866 * how much time we have used for protocol processing
868 self
->stamp
= ktime_get();
870 /* Check if we need to copy the data to a new skb or not.
871 * For most frames, we use ZeroCopy and pass the already
872 * allocated skb up the stack.
873 * If the frame is small, it is more efficient to copy it
874 * to save memory (copy will be fast anyway - that's
875 * called Rx-copy-break). Jean II */
876 docopy
= (urb
->actual_length
< IRDA_RX_COPY_THRESHOLD
);
878 /* Allocate a new skb */
879 if (self
->capability
& IUC_STIR421X
)
880 newskb
= dev_alloc_skb(docopy
? urb
->actual_length
:
882 USB_IRDA_STIR421X_HEADER
);
884 newskb
= dev_alloc_skb(docopy
? urb
->actual_length
:
888 self
->netdev
->stats
.rx_dropped
++;
889 /* We could deliver the current skb, but this would stall
890 * the Rx path. Better drop the packet... Jean II */
894 /* Make sure IP header get aligned (IrDA header is 5 bytes) */
895 /* But IrDA-USB header is 1 byte. Jean II */
896 //skb_reserve(newskb, USB_IRDA_HEADER - 1);
899 /* Copy packet, so we can recycle the original */
900 skb_copy_from_linear_data(skb
, newskb
->data
, urb
->actual_length
);
901 /* Deliver this new skb */
903 /* And hook the old skb to the URB
904 * Note : we don't need to "clean up" the old skb,
905 * as we never touched it. Jean II */
907 /* We are using ZeroCopy. Deliver old skb */
909 /* And hook the new skb to the URB */
913 /* Set proper length on skb & remove USB-IrDA header */
914 skb_put(dataskb
, urb
->actual_length
);
915 skb_pull(dataskb
, self
->header_length
);
917 /* Ask the networking layer to queue the packet for the IrDA stack */
918 dataskb
->dev
= self
->netdev
;
919 skb_reset_mac_header(dataskb
);
920 dataskb
->protocol
= htons(ETH_P_IRDA
);
924 /* Keep stats up to date */
925 self
->netdev
->stats
.rx_bytes
+= len
;
926 self
->netdev
->stats
.rx_packets
++;
929 /* Note : at this point, the URB we've just received (urb)
930 * is still referenced by the USB layer. For example, if we
931 * have received a -ECONNRESET, uhci_cleanup_unlink() will
932 * continue to process it (in fact, cleaning it up).
933 * If we were to submit this URB, disaster would ensue.
934 * Therefore, we submit our idle URB, and put this URB in our
937 /* Note : with this scheme, we could submit the idle URB before
938 * processing the Rx URB. I don't think it would buy us anything as
939 * we are running in the USB thread context. Jean II */
940 next_urb
= self
->idle_rx_urb
;
942 /* Recycle Rx URB : Now, the idle URB is the present one */
944 self
->idle_rx_urb
= urb
;
946 /* Submit the idle URB to replace the URB we've just received.
947 * Do it last to avoid race conditions... Jean II */
948 irda_usb_submit(self
, skb
, next_urb
);
951 /*------------------------------------------------------------------*/
953 * In case of errors, we want the USB layer to have time to recover.
954 * Now, it is time to resubmit ouur Rx URB...
956 static void irda_usb_rx_defer_expired(unsigned long data
)
958 struct urb
*urb
= (struct urb
*) data
;
959 struct sk_buff
*skb
= (struct sk_buff
*) urb
->context
;
960 struct irda_usb_cb
*self
;
961 struct irda_skb_cb
*cb
;
962 struct urb
*next_urb
;
965 cb
= (struct irda_skb_cb
*) skb
->cb
;
966 IRDA_ASSERT(cb
!= NULL
, return;);
967 self
= (struct irda_usb_cb
*) cb
->context
;
968 IRDA_ASSERT(self
!= NULL
, return;);
970 /* Same stuff as when Rx is done, see above... */
971 next_urb
= self
->idle_rx_urb
;
973 self
->idle_rx_urb
= urb
;
974 irda_usb_submit(self
, skb
, next_urb
);
977 /*------------------------------------------------------------------*/
979 * Callbak from IrDA layer. IrDA wants to know if we have
980 * started receiving anything.
982 static int irda_usb_is_receiving(struct irda_usb_cb
*self
)
984 /* Note : because of the way UHCI works, it's almost impossible
985 * to get this info. The Controller DMA directly to memory and
986 * signal only when the whole frame is finished. To know if the
987 * first TD of the URB has been filled or not seems hard work...
989 * The other solution would be to use the "receiving" command
990 * on the default decriptor with a usb_control_msg(), but that
991 * would add USB traffic and would return result only in the
992 * next USB frame (~1ms).
994 * I've been told that current dongles send status info on their
995 * interrupt endpoint, and that's what the Windows driver uses
996 * to know this info. Unfortunately, this is not yet in the spec...
1001 return 0; /* For now */
1004 #define STIR421X_PATCH_PRODUCT_VER "Product Version: "
1005 #define STIR421X_PATCH_STMP_TAG "STMP"
1006 #define STIR421X_PATCH_CODE_OFFSET 512 /* patch image starts before here */
1007 /* marks end of patch file header (PC DOS text file EOF character) */
1008 #define STIR421X_PATCH_END_OF_HDR_TAG 0x1A
1009 #define STIR421X_PATCH_BLOCK_SIZE 1023
1012 * Function stir421x_fwupload (struct irda_usb_cb *self,
1013 * unsigned char *patch,
1014 * const unsigned int patch_len)
1016 * Upload firmware code to SigmaTel 421X IRDA-USB dongle
1018 static int stir421x_fw_upload(struct irda_usb_cb
*self
,
1019 const unsigned char *patch
,
1020 const unsigned int patch_len
)
1025 unsigned int block_size
= 0;
1026 unsigned char *patch_block
;
1028 patch_block
= kzalloc(STIR421X_PATCH_BLOCK_SIZE
, GFP_KERNEL
);
1029 if (patch_block
== NULL
)
1032 /* break up patch into 1023-byte sections */
1033 for (i
= 0; i
< patch_len
; i
+= block_size
) {
1034 block_size
= patch_len
- i
;
1036 if (block_size
> STIR421X_PATCH_BLOCK_SIZE
)
1037 block_size
= STIR421X_PATCH_BLOCK_SIZE
;
1039 /* upload the patch section */
1040 memcpy(patch_block
, patch
+ i
, block_size
);
1042 ret
= usb_bulk_msg(self
->usbdev
,
1043 usb_sndbulkpipe(self
->usbdev
,
1045 patch_block
, block_size
,
1046 &actual_len
, msecs_to_jiffies(500));
1047 pr_debug("%s(): Bulk send %u bytes, ret=%d\n",
1048 __func__
, actual_len
, ret
);
1062 * Function stir421x_patch_device(struct irda_usb_cb *self)
1064 * Get a firmware code from userspase using hotplug request_firmware() call
1066 static int stir421x_patch_device(struct irda_usb_cb
*self
)
1070 char stir421x_fw_name
[12];
1071 const struct firmware
*fw
;
1072 const unsigned char *fw_version_ptr
; /* pointer to version string */
1073 unsigned long fw_version
= 0;
1076 * Known firmware patch file names for STIR421x dongles
1077 * are "42101001.sb" or "42101002.sb"
1079 sprintf(stir421x_fw_name
, "4210%4X.sb",
1080 self
->usbdev
->descriptor
.bcdDevice
);
1081 ret
= request_firmware(&fw
, stir421x_fw_name
, &self
->usbdev
->dev
);
1085 /* We get a patch from userspace */
1086 net_info_ratelimited("%s(): Received firmware %s (%zu bytes)\n",
1087 __func__
, stir421x_fw_name
, fw
->size
);
1091 /* Get the bcd product version */
1092 if (!memcmp(fw
->data
, STIR421X_PATCH_PRODUCT_VER
,
1093 sizeof(STIR421X_PATCH_PRODUCT_VER
) - 1)) {
1094 fw_version_ptr
= fw
->data
+
1095 sizeof(STIR421X_PATCH_PRODUCT_VER
) - 1;
1097 /* Let's check if the product version is dotted */
1098 if (fw_version_ptr
[3] == '.' &&
1099 fw_version_ptr
[7] == '.') {
1100 unsigned long major
, minor
, build
;
1101 major
= simple_strtoul(fw_version_ptr
, NULL
, 10);
1102 minor
= simple_strtoul(fw_version_ptr
+ 4, NULL
, 10);
1103 build
= simple_strtoul(fw_version_ptr
+ 8, NULL
, 10);
1105 fw_version
= (major
<< 12)
1107 + ((build
/ 10) << 4)
1110 pr_debug("%s(): Firmware Product version %ld\n",
1111 __func__
, fw_version
);
1115 if (self
->usbdev
->descriptor
.bcdDevice
== cpu_to_le16(fw_version
)) {
1117 * If we're here, we've found a correct patch
1118 * The actual image starts after the "STMP" keyword
1119 * so forward to the firmware header tag
1121 for (i
= 0; i
< fw
->size
&& fw
->data
[i
] !=
1122 STIR421X_PATCH_END_OF_HDR_TAG
; i
++) ;
1123 /* here we check for the out of buffer case */
1124 if (i
< STIR421X_PATCH_CODE_OFFSET
&& i
< fw
->size
&&
1125 STIR421X_PATCH_END_OF_HDR_TAG
== fw
->data
[i
]) {
1126 if (!memcmp(fw
->data
+ i
+ 1, STIR421X_PATCH_STMP_TAG
,
1127 sizeof(STIR421X_PATCH_STMP_TAG
) - 1)) {
1129 /* We can upload the patch to the target */
1130 i
+= sizeof(STIR421X_PATCH_STMP_TAG
);
1131 ret
= stir421x_fw_upload(self
, &fw
->data
[i
],
1137 release_firmware(fw
);
1143 /********************** IRDA DEVICE CALLBACKS **********************/
1145 * Main calls from the IrDA/Network subsystem.
1146 * Mostly registering a new irda-usb device and removing it....
1147 * We only deal with the IrDA side of the business, the USB side will
1148 * be dealt with below...
1152 /*------------------------------------------------------------------*/
1154 * Function irda_usb_net_open (dev)
1156 * Network device is taken up. Usually this is done by "ifconfig irda0 up"
1158 * Note : don't mess with self->netopen - Jean II
1160 static int irda_usb_net_open(struct net_device
*netdev
)
1162 struct irda_usb_cb
*self
;
1163 unsigned long flags
;
1167 IRDA_ASSERT(netdev
!= NULL
, return -1;);
1168 self
= netdev_priv(netdev
);
1169 IRDA_ASSERT(self
!= NULL
, return -1;);
1171 spin_lock_irqsave(&self
->lock
, flags
);
1172 /* Can only open the device if it's there */
1173 if(!self
->present
) {
1174 spin_unlock_irqrestore(&self
->lock
, flags
);
1175 net_warn_ratelimited("%s(), device not present!\n", __func__
);
1179 if(self
->needspatch
) {
1180 spin_unlock_irqrestore(&self
->lock
, flags
);
1181 net_warn_ratelimited("%s(), device needs patch\n", __func__
);
1185 /* Initialise default speed and xbofs value
1186 * (IrLAP will change that soon) */
1189 self
->new_speed
= -1;
1190 self
->new_xbofs
= -1;
1192 /* To do *before* submitting Rx urbs and starting net Tx queue
1195 spin_unlock_irqrestore(&self
->lock
, flags
);
1198 * Now that everything should be initialized properly,
1199 * Open new IrLAP layer instance to take care of us...
1200 * Note : will send immediately a speed change...
1202 sprintf(hwname
, "usb#%d", self
->usbdev
->devnum
);
1203 self
->irlap
= irlap_open(netdev
, &self
->qos
, hwname
);
1204 IRDA_ASSERT(self
->irlap
!= NULL
, return -1;);
1206 /* Allow IrLAP to send data to us */
1207 netif_start_queue(netdev
);
1209 /* We submit all the Rx URB except for one that we keep idle.
1210 * Need to be initialised before submitting other USBs, because
1211 * in some cases as soon as we submit the URBs the USB layer
1212 * will trigger a dummy receive - Jean II */
1213 self
->idle_rx_urb
= self
->rx_urb
[IU_MAX_ACTIVE_RX_URBS
];
1214 self
->idle_rx_urb
->context
= NULL
;
1216 /* Now that we can pass data to IrLAP, allow the USB layer
1217 * to send us some data... */
1218 for (i
= 0; i
< IU_MAX_ACTIVE_RX_URBS
; i
++) {
1219 struct sk_buff
*skb
= dev_alloc_skb(IRDA_SKB_MAX_MTU
);
1221 /* If this ever happen, we are in deep s***.
1222 * Basically, we can't start the Rx path... */
1225 //skb_reserve(newskb, USB_IRDA_HEADER - 1);
1226 irda_usb_submit(self
, skb
, self
->rx_urb
[i
]);
1229 /* Ready to play !!! */
1233 /*------------------------------------------------------------------*/
1235 * Function irda_usb_net_close (self)
1237 * Network device is taken down. Usually this is done by
1238 * "ifconfig irda0 down"
1240 static int irda_usb_net_close(struct net_device
*netdev
)
1242 struct irda_usb_cb
*self
;
1245 IRDA_ASSERT(netdev
!= NULL
, return -1;);
1246 self
= netdev_priv(netdev
);
1247 IRDA_ASSERT(self
!= NULL
, return -1;);
1249 /* Clear this flag *before* unlinking the urbs and *before*
1250 * stopping the network Tx queue - Jean II */
1253 /* Stop network Tx queue */
1254 netif_stop_queue(netdev
);
1256 /* Kill defered Rx URB */
1257 del_timer(&self
->rx_defer_timer
);
1259 /* Deallocate all the Rx path buffers (URBs and skb) */
1260 for (i
= 0; i
< self
->max_rx_urb
; i
++) {
1261 struct urb
*urb
= self
->rx_urb
[i
];
1262 struct sk_buff
*skb
= (struct sk_buff
*) urb
->context
;
1263 /* Cancel the receive command */
1265 /* The skb is ours, free it */
1268 urb
->context
= NULL
;
1271 /* Cancel Tx and speed URB - need to be synchronous to avoid races */
1272 usb_kill_urb(self
->tx_urb
);
1273 usb_kill_urb(self
->speed_urb
);
1275 /* Stop and remove instance of IrLAP */
1277 irlap_close(self
->irlap
);
1283 /*------------------------------------------------------------------*/
1285 * IOCTLs : Extra out-of-band network commands...
1287 static int irda_usb_net_ioctl(struct net_device
*dev
, struct ifreq
*rq
, int cmd
)
1289 unsigned long flags
;
1290 struct if_irda_req
*irq
= (struct if_irda_req
*) rq
;
1291 struct irda_usb_cb
*self
;
1294 IRDA_ASSERT(dev
!= NULL
, return -1;);
1295 self
= netdev_priv(dev
);
1296 IRDA_ASSERT(self
!= NULL
, return -1;);
1298 pr_debug("%s(), %s, (cmd=0x%X)\n", __func__
, dev
->name
, cmd
);
1301 case SIOCSBANDWIDTH
: /* Set bandwidth */
1302 if (!capable(CAP_NET_ADMIN
))
1304 /* Protect us from USB callbacks, net watchdog and else. */
1305 spin_lock_irqsave(&self
->lock
, flags
);
1306 /* Check if the device is still there */
1308 /* Set the desired speed */
1309 self
->new_speed
= irq
->ifr_baudrate
;
1310 irda_usb_change_speed_xbofs(self
);
1312 spin_unlock_irqrestore(&self
->lock
, flags
);
1314 case SIOCSMEDIABUSY
: /* Set media busy */
1315 if (!capable(CAP_NET_ADMIN
))
1317 /* Check if the IrDA stack is still there */
1319 irda_device_set_media_busy(self
->netdev
, TRUE
);
1321 case SIOCGRECEIVING
: /* Check if we are receiving right now */
1322 irq
->ifr_receiving
= irda_usb_is_receiving(self
);
1331 /*------------------------------------------------------------------*/
1333 /********************* IRDA CONFIG SUBROUTINES *********************/
1335 * Various subroutines dealing with IrDA and network stuff we use to
1336 * configure and initialise each irda-usb instance.
1337 * These functions are used below in the main calls of the driver...
1340 /*------------------------------------------------------------------*/
1342 * Set proper values in the IrDA QOS structure
1344 static inline void irda_usb_init_qos(struct irda_usb_cb
*self
)
1346 struct irda_class_desc
*desc
;
1349 desc
= self
->irda_desc
;
1351 /* Initialize QoS for this device */
1352 irda_init_max_qos_capabilies(&self
->qos
);
1354 /* See spec section 7.2 for meaning.
1355 * Values are little endian (as most USB stuff), the IrDA stack
1356 * use it in native order (see parameters.c). - Jean II */
1357 self
->qos
.baud_rate
.bits
= le16_to_cpu(desc
->wBaudRate
);
1358 self
->qos
.min_turn_time
.bits
= desc
->bmMinTurnaroundTime
;
1359 self
->qos
.additional_bofs
.bits
= desc
->bmAdditionalBOFs
;
1360 self
->qos
.window_size
.bits
= desc
->bmWindowSize
;
1361 self
->qos
.data_size
.bits
= desc
->bmDataSize
;
1363 pr_debug("%s(), dongle says speed=0x%X, size=0x%X, window=0x%X, bofs=0x%X, turn=0x%X\n",
1364 __func__
, self
->qos
.baud_rate
.bits
, self
->qos
.data_size
.bits
,
1365 self
->qos
.window_size
.bits
, self
->qos
.additional_bofs
.bits
,
1366 self
->qos
.min_turn_time
.bits
);
1368 /* Don't always trust what the dongle tell us */
1369 if(self
->capability
& IUC_SIR_ONLY
)
1370 self
->qos
.baud_rate
.bits
&= 0x00ff;
1371 if(self
->capability
& IUC_SMALL_PKT
)
1372 self
->qos
.data_size
.bits
= 0x07;
1373 if(self
->capability
& IUC_NO_WINDOW
)
1374 self
->qos
.window_size
.bits
= 0x01;
1375 if(self
->capability
& IUC_MAX_WINDOW
)
1376 self
->qos
.window_size
.bits
= 0x7f;
1377 if(self
->capability
& IUC_MAX_XBOFS
)
1378 self
->qos
.additional_bofs
.bits
= 0x01;
1381 /* Module parameter can override the rx window size */
1383 self
->qos
.min_turn_time
.bits
= qos_mtt_bits
;
1386 * Note : most of those values apply only for the receive path,
1387 * the transmit path will be set differently - Jean II
1389 irda_qos_bits_to_value(&self
->qos
);
1392 /*------------------------------------------------------------------*/
1393 static const struct net_device_ops irda_usb_netdev_ops
= {
1394 .ndo_open
= irda_usb_net_open
,
1395 .ndo_stop
= irda_usb_net_close
,
1396 .ndo_do_ioctl
= irda_usb_net_ioctl
,
1397 .ndo_start_xmit
= irda_usb_hard_xmit
,
1398 .ndo_tx_timeout
= irda_usb_net_timeout
,
1402 * Initialise the network side of the irda-usb instance
1403 * Called when a new USB instance is registered in irda_usb_probe()
1405 static inline int irda_usb_open(struct irda_usb_cb
*self
)
1407 struct net_device
*netdev
= self
->netdev
;
1409 netdev
->netdev_ops
= &irda_usb_netdev_ops
;
1411 irda_usb_init_qos(self
);
1413 return register_netdev(netdev
);
1416 /*------------------------------------------------------------------*/
1418 * Cleanup the network side of the irda-usb instance
1419 * Called when a USB instance is removed in irda_usb_disconnect()
1421 static inline void irda_usb_close(struct irda_usb_cb
*self
)
1423 /* Remove netdevice */
1424 unregister_netdev(self
->netdev
);
1426 /* Remove the speed buffer */
1427 kfree(self
->speed_buff
);
1428 self
->speed_buff
= NULL
;
1430 kfree(self
->tx_buff
);
1431 self
->tx_buff
= NULL
;
1434 /********************** USB CONFIG SUBROUTINES **********************/
1436 * Various subroutines dealing with USB stuff we use to configure and
1437 * initialise each irda-usb instance.
1438 * These functions are used below in the main calls of the driver...
1441 /*------------------------------------------------------------------*/
1443 * Function irda_usb_parse_endpoints(dev, ifnum)
1445 * Parse the various endpoints and find the one we need.
1447 * The endpoint are the pipes used to communicate with the USB device.
1448 * The spec defines 2 endpoints of type bulk transfer, one in, and one out.
1449 * These are used to pass frames back and forth with the dongle.
1450 * Most dongle have also an interrupt endpoint, that will be probably
1451 * documented in the next spec...
1453 static inline int irda_usb_parse_endpoints(struct irda_usb_cb
*self
, struct usb_host_endpoint
*endpoint
, int ennum
)
1455 int i
; /* Endpoint index in table */
1457 /* Init : no endpoints */
1458 self
->bulk_in_ep
= 0;
1459 self
->bulk_out_ep
= 0;
1460 self
->bulk_int_ep
= 0;
1462 /* Let's look at all those endpoints */
1463 for(i
= 0; i
< ennum
; i
++) {
1464 /* All those variables will get optimised by the compiler,
1465 * so let's aim for clarity... - Jean II */
1466 __u8 ep
; /* Endpoint address */
1467 __u8 dir
; /* Endpoint direction */
1468 __u8 attr
; /* Endpoint attribute */
1469 __u16 psize
; /* Endpoint max packet size in bytes */
1471 /* Get endpoint address, direction and attribute */
1472 ep
= endpoint
[i
].desc
.bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
1473 dir
= endpoint
[i
].desc
.bEndpointAddress
& USB_ENDPOINT_DIR_MASK
;
1474 attr
= endpoint
[i
].desc
.bmAttributes
;
1475 psize
= le16_to_cpu(endpoint
[i
].desc
.wMaxPacketSize
);
1477 /* Is it a bulk endpoint ??? */
1478 if(attr
== USB_ENDPOINT_XFER_BULK
) {
1479 /* We need to find an IN and an OUT */
1480 if(dir
== USB_DIR_IN
) {
1481 /* This is our Rx endpoint */
1482 self
->bulk_in_ep
= ep
;
1484 /* This is our Tx endpoint */
1485 self
->bulk_out_ep
= ep
;
1486 self
->bulk_out_mtu
= psize
;
1489 if((attr
== USB_ENDPOINT_XFER_INT
) &&
1490 (dir
== USB_DIR_IN
)) {
1491 /* This is our interrupt endpoint */
1492 self
->bulk_int_ep
= ep
;
1494 net_err_ratelimited("%s(), Unrecognised endpoint %02X\n",
1500 pr_debug("%s(), And our endpoints are : in=%02X, out=%02X (%d), int=%02X\n",
1501 __func__
, self
->bulk_in_ep
, self
->bulk_out_ep
,
1502 self
->bulk_out_mtu
, self
->bulk_int_ep
);
1504 return (self
->bulk_in_ep
!= 0) && (self
->bulk_out_ep
!= 0);
1507 #ifdef IU_DUMP_CLASS_DESC
1508 /*------------------------------------------------------------------*/
1510 * Function usb_irda_dump_class_desc(desc)
1512 * Prints out the contents of the IrDA class descriptor
1515 static inline void irda_usb_dump_class_desc(struct irda_class_desc
*desc
)
1517 /* Values are little endian */
1518 printk("bLength=%x\n", desc
->bLength
);
1519 printk("bDescriptorType=%x\n", desc
->bDescriptorType
);
1520 printk("bcdSpecRevision=%x\n", le16_to_cpu(desc
->bcdSpecRevision
));
1521 printk("bmDataSize=%x\n", desc
->bmDataSize
);
1522 printk("bmWindowSize=%x\n", desc
->bmWindowSize
);
1523 printk("bmMinTurnaroundTime=%d\n", desc
->bmMinTurnaroundTime
);
1524 printk("wBaudRate=%x\n", le16_to_cpu(desc
->wBaudRate
));
1525 printk("bmAdditionalBOFs=%x\n", desc
->bmAdditionalBOFs
);
1526 printk("bIrdaRateSniff=%x\n", desc
->bIrdaRateSniff
);
1527 printk("bMaxUnicastList=%x\n", desc
->bMaxUnicastList
);
1529 #endif /* IU_DUMP_CLASS_DESC */
1531 /*------------------------------------------------------------------*/
1533 * Function irda_usb_find_class_desc(intf)
1535 * Returns instance of IrDA class descriptor, or NULL if not found
1537 * The class descriptor is some extra info that IrDA USB devices will
1538 * offer to us, describing their IrDA characteristics. We will use that in
1539 * irda_usb_init_qos()
1541 static inline struct irda_class_desc
*irda_usb_find_class_desc(struct usb_interface
*intf
)
1543 struct usb_device
*dev
= interface_to_usbdev (intf
);
1544 struct irda_class_desc
*desc
;
1547 desc
= kzalloc(sizeof(*desc
), GFP_KERNEL
);
1551 /* USB-IrDA class spec 1.0:
1552 * 6.1.3: Standard "Get Descriptor" Device Request is not
1553 * appropriate to retrieve class-specific descriptor
1554 * 6.2.5: Class Specific "Get Class Descriptor" Interface Request
1555 * is mandatory and returns the USB-IrDA class descriptor
1558 ret
= usb_control_msg(dev
, usb_rcvctrlpipe(dev
,0),
1559 IU_REQ_GET_CLASS_DESC
,
1560 USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
1561 0, intf
->altsetting
->desc
.bInterfaceNumber
, desc
,
1562 sizeof(*desc
), 500);
1564 pr_debug("%s(), ret=%d\n", __func__
, ret
);
1565 if (ret
< sizeof(*desc
)) {
1566 net_warn_ratelimited("usb-irda: class_descriptor read %s (%d)\n",
1567 ret
< 0 ? "failed" : "too short", ret
);
1569 else if (desc
->bDescriptorType
!= USB_DT_IRDA
) {
1570 net_warn_ratelimited("usb-irda: bad class_descriptor type\n");
1573 #ifdef IU_DUMP_CLASS_DESC
1574 irda_usb_dump_class_desc(desc
);
1575 #endif /* IU_DUMP_CLASS_DESC */
1583 /*********************** USB DEVICE CALLBACKS ***********************/
1585 * Main calls from the USB subsystem.
1586 * Mostly registering a new irda-usb device and removing it....
1589 /*------------------------------------------------------------------*/
1591 * This routine is called by the USB subsystem for each new device
1592 * in the system. We need to check if the device is ours, and in
1593 * this case start handling it.
1594 * The USB layer protect us from reentrancy (via BKL), so we don't need
1595 * to spinlock in there... Jean II
1597 static int irda_usb_probe(struct usb_interface
*intf
,
1598 const struct usb_device_id
*id
)
1600 struct net_device
*net
;
1601 struct usb_device
*dev
= interface_to_usbdev(intf
);
1602 struct irda_usb_cb
*self
;
1603 struct usb_host_interface
*interface
;
1604 struct irda_class_desc
*irda_desc
;
1606 int i
; /* Driver instance index / Rx URB index */
1608 /* Note : the probe make sure to call us only for devices that
1609 * matches the list of dongle (top of the file). So, we
1610 * don't need to check if the dongle is really ours.
1613 net_info_ratelimited("IRDA-USB found at address %d, Vendor: %x, Product: %x\n",
1614 dev
->devnum
, le16_to_cpu(dev
->descriptor
.idVendor
),
1615 le16_to_cpu(dev
->descriptor
.idProduct
));
1617 net
= alloc_irdadev(sizeof(*self
));
1621 SET_NETDEV_DEV(net
, &intf
->dev
);
1622 self
= netdev_priv(net
);
1624 spin_lock_init(&self
->lock
);
1625 init_timer(&self
->rx_defer_timer
);
1627 self
->capability
= id
->driver_info
;
1628 self
->needspatch
= ((self
->capability
& IUC_STIR421X
) != 0);
1630 /* Create all of the needed urbs */
1631 if (self
->capability
& IUC_STIR421X
) {
1632 self
->max_rx_urb
= IU_SIGMATEL_MAX_RX_URBS
;
1633 self
->header_length
= USB_IRDA_STIR421X_HEADER
;
1635 self
->max_rx_urb
= IU_MAX_RX_URBS
;
1636 self
->header_length
= USB_IRDA_HEADER
;
1639 self
->rx_urb
= kcalloc(self
->max_rx_urb
, sizeof(struct urb
*),
1644 for (i
= 0; i
< self
->max_rx_urb
; i
++) {
1645 self
->rx_urb
[i
] = usb_alloc_urb(0, GFP_KERNEL
);
1646 if (!self
->rx_urb
[i
]) {
1650 self
->tx_urb
= usb_alloc_urb(0, GFP_KERNEL
);
1651 if (!self
->tx_urb
) {
1654 self
->speed_urb
= usb_alloc_urb(0, GFP_KERNEL
);
1655 if (!self
->speed_urb
) {
1659 /* Is this really necessary? (no, except maybe for broken devices) */
1660 if (usb_reset_configuration (dev
) < 0) {
1661 dev_err(&intf
->dev
, "reset_configuration failed\n");
1666 /* Is this really necessary? */
1667 /* Note : some driver do hardcode the interface number, some others
1668 * specify an alternate, but very few driver do like this.
1670 ret
= usb_set_interface(dev
, intf
->altsetting
->desc
.bInterfaceNumber
, 0);
1671 pr_debug("usb-irda: set interface %d result %d\n",
1672 intf
->altsetting
->desc
.bInterfaceNumber
, ret
);
1676 case -EPIPE
: /* -EPIPE = -32 */
1677 /* Martin Diehl says if we get a -EPIPE we should
1678 * be fine and we don't need to do a usb_clear_halt().
1680 pr_debug("%s(), Received -EPIPE, ignoring...\n",
1684 pr_debug("%s(), Unknown error %d\n", __func__
, ret
);
1689 /* Find our endpoints */
1690 interface
= intf
->cur_altsetting
;
1691 if(!irda_usb_parse_endpoints(self
, interface
->endpoint
,
1692 interface
->desc
.bNumEndpoints
)) {
1693 net_err_ratelimited("%s(), Bogus endpoints...\n", __func__
);
1700 /* Find IrDA class descriptor */
1701 irda_desc
= irda_usb_find_class_desc(intf
);
1706 if (self
->needspatch
) {
1707 ret
= usb_control_msg (self
->usbdev
, usb_sndctrlpipe (self
->usbdev
, 0),
1708 0x02, 0x40, 0, 0, NULL
, 0, 500);
1710 pr_debug("usb_control_msg failed %d\n", ret
);
1717 self
->irda_desc
= irda_desc
;
1720 self
->usbintf
= intf
;
1722 /* Allocate the buffer for speed changes */
1723 /* Don't change this buffer size and allocation without doing
1724 * some heavy and complete testing. Don't ask why :-(
1726 self
->speed_buff
= kzalloc(IRDA_USB_SPEED_MTU
, GFP_KERNEL
);
1727 if (!self
->speed_buff
)
1730 self
->tx_buff
= kzalloc(IRDA_SKB_MAX_MTU
+ self
->header_length
,
1735 ret
= irda_usb_open(self
);
1739 net_info_ratelimited("IrDA: Registered device %s\n", net
->name
);
1740 usb_set_intfdata(intf
, self
);
1742 if (self
->needspatch
) {
1743 /* Now we fetch and upload the firmware patch */
1744 ret
= stir421x_patch_device(self
);
1745 self
->needspatch
= (ret
< 0);
1746 if (self
->needspatch
) {
1747 net_err_ratelimited("STIR421X: Couldn't upload patch\n");
1751 /* replace IrDA class descriptor with what patched device is now reporting */
1752 irda_desc
= irda_usb_find_class_desc (self
->usbintf
);
1757 kfree(self
->irda_desc
);
1758 self
->irda_desc
= irda_desc
;
1759 irda_usb_init_qos(self
);
1764 unregister_netdev(self
->netdev
);
1766 kfree(self
->tx_buff
);
1768 kfree(self
->speed_buff
);
1770 /* Free all urbs that we may have created */
1771 usb_free_urb(self
->speed_urb
);
1773 usb_free_urb(self
->tx_urb
);
1775 for (i
= 0; i
< self
->max_rx_urb
; i
++)
1776 usb_free_urb(self
->rx_urb
[i
]);
1777 kfree(self
->rx_urb
);
1784 /*------------------------------------------------------------------*/
1786 * The current irda-usb device is removed, the USB layer tell us
1787 * to shut it down...
1788 * One of the constraints is that when we exit this function,
1789 * we cannot use the usb_device no more. Gone. Destroyed. kfree().
1790 * Most other subsystem allow you to destroy the instance at a time
1791 * when it's convenient to you, to postpone it to a later date, but
1792 * not the USB subsystem.
1793 * So, we must make bloody sure that everything gets deactivated.
1796 static void irda_usb_disconnect(struct usb_interface
*intf
)
1798 unsigned long flags
;
1799 struct irda_usb_cb
*self
= usb_get_intfdata(intf
);
1802 usb_set_intfdata(intf
, NULL
);
1806 /* Make sure that the Tx path is not executing. - Jean II */
1807 spin_lock_irqsave(&self
->lock
, flags
);
1809 /* Oups ! We are not there any more.
1810 * This will stop/desactivate the Tx path. - Jean II */
1813 /* Kill defered Rx URB */
1814 del_timer(&self
->rx_defer_timer
);
1816 /* We need to have irq enabled to unlink the URBs. That's OK,
1817 * at this point the Tx path is gone - Jean II */
1818 spin_unlock_irqrestore(&self
->lock
, flags
);
1820 /* Hum... Check if networking is still active (avoid races) */
1821 if((self
->netopen
) || (self
->irlap
)) {
1822 /* Accept no more transmissions */
1823 /*netif_device_detach(self->netdev);*/
1824 netif_stop_queue(self
->netdev
);
1825 /* Stop all the receive URBs. Must be synchronous. */
1826 for (i
= 0; i
< self
->max_rx_urb
; i
++)
1827 usb_kill_urb(self
->rx_urb
[i
]);
1828 /* Cancel Tx and speed URB.
1829 * Make sure it's synchronous to avoid races. */
1830 usb_kill_urb(self
->tx_urb
);
1831 usb_kill_urb(self
->speed_urb
);
1834 /* Cleanup the device stuff */
1835 irda_usb_close(self
);
1836 /* No longer attached to USB bus */
1837 self
->usbdev
= NULL
;
1838 self
->usbintf
= NULL
;
1840 /* Clean up our urbs */
1841 for (i
= 0; i
< self
->max_rx_urb
; i
++)
1842 usb_free_urb(self
->rx_urb
[i
]);
1843 kfree(self
->rx_urb
);
1844 /* Clean up Tx and speed URB */
1845 usb_free_urb(self
->tx_urb
);
1846 usb_free_urb(self
->speed_urb
);
1848 /* Free self and network device */
1849 free_netdev(self
->netdev
);
1850 pr_debug("%s(), USB IrDA Disconnected\n", __func__
);
1854 /* USB suspend, so power off the transmitter/receiver */
1855 static int irda_usb_suspend(struct usb_interface
*intf
, pm_message_t message
)
1857 struct irda_usb_cb
*self
= usb_get_intfdata(intf
);
1860 netif_device_detach(self
->netdev
);
1862 if (self
->tx_urb
!= NULL
)
1863 usb_kill_urb(self
->tx_urb
);
1864 if (self
->speed_urb
!= NULL
)
1865 usb_kill_urb(self
->speed_urb
);
1866 for (i
= 0; i
< self
->max_rx_urb
; i
++) {
1867 if (self
->rx_urb
[i
] != NULL
)
1868 usb_kill_urb(self
->rx_urb
[i
]);
1873 /* Coming out of suspend, so reset hardware */
1874 static int irda_usb_resume(struct usb_interface
*intf
)
1876 struct irda_usb_cb
*self
= usb_get_intfdata(intf
);
1879 for (i
= 0; i
< self
->max_rx_urb
; i
++) {
1880 if (self
->rx_urb
[i
] != NULL
)
1881 usb_submit_urb(self
->rx_urb
[i
], GFP_KERNEL
);
1884 netif_device_attach(self
->netdev
);
1889 /*------------------------------------------------------------------*/
1891 * USB device callbacks
1893 static struct usb_driver irda_driver
= {
1895 .probe
= irda_usb_probe
,
1896 .disconnect
= irda_usb_disconnect
,
1897 .id_table
= dongles
,
1899 .suspend
= irda_usb_suspend
,
1900 .resume
= irda_usb_resume
,
1904 module_usb_driver(irda_driver
);
1909 module_param(qos_mtt_bits
, int, 0);
1910 MODULE_PARM_DESC(qos_mtt_bits
, "Minimum Turn Time");
1911 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>");
1912 MODULE_DESCRIPTION("IrDA-USB Dongle Driver");
1913 MODULE_LICENSE("GPL");