drivers/net/irda/irda-usb.c

   1 /*****************************************************************************
   2  *
   3  * Filename:      irda-usb.c
   4  * Version:       0.10
   5  * Description:   IrDA-USB Driver
   6  * Status:        Experimental
   7  * Author:        Dag Brattli <dag@brattli.net>
   8  *
   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>
  15  *
  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.
  20  *
  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.
  25  *
  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.
  29  *
  30  *****************************************************************************/
  31
  32 /*
  33  *                          IMPORTANT NOTE
  34  *                          --------------
  35  *
  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...
  38  *
  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)
  43  *
  44  * This driver has NOT been tested with the following drivers :
  45  *      o ehci-hcd      (USB 2.0 controllers)
  46  *
  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...
  51  *
  52  * Jean II
  53  */
  54
  55 /*------------------------------------------------------------------*/
  56
  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>
  68
  69 #include "irda-usb.h"
  70
  71 /*------------------------------------------------------------------*/
  72
  73 static int qos_mtt_bits = 0;
  74
  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, },
  94         { }, /* The end */
  95 };
  96
  97 /*
  98  * Important note :
  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.
 103  * Jean II
 104  */
 105
 106 MODULE_DEVICE_TABLE(usb, dongles);
 107
 108 /*------------------------------------------------------------------*/
 109
 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, struct pt_regs *regs);
 118 static void write_bulk_callback(struct urb *urb, struct pt_regs *regs);
 119 static void irda_usb_receive(struct urb *urb, struct pt_regs *regs);
 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);
 126
 127 /************************ TRANSMIT ROUTINES ************************/
 128 /*
 129  * Receive packets from the IrDA stack and send them on the USB pipe.
 130  * Handle speed change, timeout and lot's of ugliness...
 131  */
 132
 133 /*------------------------------------------------------------------*/
 134 /*
 135  * Function irda_usb_build_header(self, skb, header)
 136  *
 137  *   Builds USB-IrDA outbound header
 138  *
 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.
 141  *
 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...
 147  * Jean II
 148  */
 149 static void irda_usb_build_header(struct irda_usb_cb *self,
 150                                   __u8 *header,
 151                                   int   force)
 152 {
 153         /* Here we check if we have an STIR421x chip,
 154          * and if either speed or xbofs (or both) needs
 155          * to be changed.
 156          */
 157         if (self->capability & IUC_STIR421X &&
 158             ((self->new_speed != -1) || (self->new_xbofs != -1))) {
 159
 160                 /* With STIR421x, speed and xBOFs must be set at the same
 161                  * time, even if only one of them changes.
 162                  */
 163                 if (self->new_speed == -1)
 164                         self->new_speed = self->speed ;
 165
 166                 if (self->new_xbofs == -1)
 167                         self->new_xbofs = self->xbofs ;
 168         }
 169
 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
 175                  */
 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__);
 181                         *header = 0;
 182                         return;
 183                 }
 184
 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 */
 189
 190                 switch (self->speed) {
 191                 case 2400:
 192                         *header = SPEED_2400;
 193                         break;
 194                 default:
 195                 case 9600:
 196                         *header = SPEED_9600;
 197                         break;
 198                 case 19200:
 199                         *header = SPEED_19200;
 200                         break;
 201                 case 38400:
 202                         *header = SPEED_38400;
 203                         break;
 204                 case 57600:
 205                         *header = SPEED_57600;
 206                         break;
 207                 case 115200:
 208                         *header = SPEED_115200;
 209                         break;
 210                 case 576000:
 211                         *header = SPEED_576000;
 212                         break;
 213                 case 1152000:
 214                         *header = SPEED_1152000;
 215                         break;
 216                 case 4000000:
 217                         *header = SPEED_4000000;
 218                         self->new_xbofs = 0;
 219                         break;
 220                 case 16000000:
 221                         *header = SPEED_16000000;
 222                         self->new_xbofs = 0;
 223                         break;
 224                 }
 225         } else
 226                 /* No change */
 227                 *header = 0;
 228
 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 */
 235
 236                 switch (self->xbofs) {
 237                 case 48:
 238                         *header |= 0x10;
 239                         break;
 240                 case 28:
 241                 case 24:        /* USB spec 1.0 says 24 */
 242                         *header |= 0x20;
 243                         break;
 244                 default:
 245                 case 12:
 246                         *header |= 0x30;
 247                         break;
 248                 case 5: /* Bug in IrLAP spec? (should be 6) */
 249                 case 6:
 250                         *header |= 0x40;
 251                         break;
 252                 case 3:
 253                         *header |= 0x50;
 254                         break;
 255                 case 2:
 256                         *header |= 0x60;
 257                         break;
 258                 case 1:
 259                         *header |= 0x70;
 260                         break;
 261                 case 0:
 262                         *header |= 0x80;
 263                         break;
 264                 }
 265         }
 266 }
 267
 268 /*
 269 *   calculate turnaround time for SigmaTel header
 270 */
 271 static __u8 get_turnaround_time(struct sk_buff *skb)
 272 {
 273         int turnaround_time = irda_get_mtt(skb);
 274
 275         if ( turnaround_time == 0 )
 276                 return 0;
 277         else if ( turnaround_time <= 10 )
 278                 return 1;
 279         else if ( turnaround_time <= 50 )
 280                 return 2;
 281         else if ( turnaround_time <= 100 )
 282                 return 3;
 283         else if ( turnaround_time <= 500 )
 284                 return 4;
 285         else if ( turnaround_time <= 1000 )
 286                 return 5;
 287         else if ( turnaround_time <= 5000 )
 288                 return 6;
 289         else
 290                 return 7;
 291 }
 292
 293
 294 /*------------------------------------------------------------------*/
 295 /*
 296  * Send a command to change the speed of the dongle
 297  * Need to be called with spinlock on.
 298  */
 299 static void irda_usb_change_speed_xbofs(struct irda_usb_cb *self)
 300 {
 301         __u8 *frame;
 302         struct urb *urb;
 303         int ret;
 304
 305         IRDA_DEBUG(2, "%s(), speed=%d, xbofs=%d\n", __FUNCTION__,
 306                    self->new_speed, self->new_xbofs);
 307
 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__);
 312                 return;
 313         }
 314
 315         /* Allocate the fake frame */
 316         frame = self->speed_buff;
 317
 318         /* Set the new speed and xbofs in this fake frame */
 319         irda_usb_build_header(self, frame, 1);
 320
 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
 324                 frame[2] = 0;
 325         }
 326
 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;
 334
 335         /* Irq disabled -> GFP_ATOMIC */
 336         if ((ret = usb_submit_urb(urb, GFP_ATOMIC))) {
 337                 IRDA_WARNING("%s(), failed Speed URB\n", __FUNCTION__);
 338         }
 339 }
 340
 341 /*------------------------------------------------------------------*/
 342 /*
 343  * Speed URB callback
 344  * Now, we can only get called for the speed URB.
 345  */
 346 static void speed_bulk_callback(struct urb *urb, struct pt_regs *regs)
 347 {
 348         struct irda_usb_cb *self = urb->context;
 349
 350         IRDA_DEBUG(2, "%s()\n", __FUNCTION__);
 351
 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;);
 356
 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);
 361
 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.
 365                  * Jean II */
 366                 /* A reset of the dongle might be welcomed here - Jean II */
 367                 return;
 368         }
 369
 370         /* urb is now available */
 371         //urb->status = 0; -> tested above
 372
 373         /* New speed and xbof is now commited in hardware */
 374         self->new_speed = -1;
 375         self->new_xbofs = -1;
 376
 377         /* Allow the stack to send more packets */
 378         netif_wake_queue(self->netdev);
 379 }
 380
 381 /*------------------------------------------------------------------*/
 382 /*
 383  * Send an IrDA frame to the USB dongle (for transmission)
 384  */
 385 static int irda_usb_hard_xmit(struct sk_buff *skb, struct net_device *netdev)
 386 {
 387         struct irda_usb_cb *self = netdev->priv;
 388         struct urb *urb = self->tx_urb;
 389         unsigned long flags;
 390         s32 speed;
 391         s16 xbofs;
 392         int res, mtt;
 393         int     err = 1;        /* Failed */
 394
 395         IRDA_DEBUG(4, "%s() on %s\n", __FUNCTION__, netdev->name);
 396
 397         netif_stop_queue(netdev);
 398
 399         /* Protect us from USB callbacks, net watchdog and else. */
 400         spin_lock_irqsave(&self->lock, flags);
 401
 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__);
 407                 goto drop;
 408         }
 409
 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;
 414         }
 415
 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;
 421
 422                 /* Check for empty frame */
 423                 if (!skb->len) {
 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...
 430                          * Jean II */
 431                         irda_usb_change_speed_xbofs(self);
 432                         netdev->trans_start = jiffies;
 433                         /* Will netif_wake_queue() in callback */
 434                         err = 0;        /* No error */
 435                         goto drop;
 436                 }
 437         }
 438
 439         if (urb->status != 0) {
 440                 IRDA_WARNING("%s(), URB still in use!\n", __FUNCTION__);
 441                 goto drop;
 442         }
 443
 444         /* Make sure there is room for IrDA-USB header. The actual
 445          * allocation will be done lower in skb_push().
 446          * Also, we don't use directly skb_cow(), because it require
 447          * headroom >= 16, which force unnecessary copies - Jean II */
 448         if (skb_headroom(skb) < self->header_length) {
 449                 IRDA_DEBUG(0, "%s(), Insuficient skb headroom.\n", __FUNCTION__);
 450                 if (skb_cow(skb, self->header_length)) {
 451                         IRDA_WARNING("%s(), failed skb_cow() !!!\n", __FUNCTION__);
 452                         goto drop;
 453                 }
 454         }
 455
 456         /* Change setting for next frame */
 457
 458         if (self->capability & IUC_STIR421X) {
 459                 __u8 turnaround_time;
 460                 __u8* frame;
 461                 turnaround_time = get_turnaround_time( skb );
 462                 frame= skb_push(skb, self->header_length);
 463                 irda_usb_build_header(self, frame, 0);
 464                 frame[2] = turnaround_time;
 465                 if ((skb->len != 0) &&
 466                     ((skb->len % 128) == 0) &&
 467                     ((skb->len % 512) != 0)) {
 468                         /* add extra byte for special SigmaTel feature */
 469                         frame[1] = 1;
 470                         skb_put(skb, 1);
 471                 } else {
 472                         frame[1] = 0;
 473                 }
 474         } else {
 475                 irda_usb_build_header(self, skb_push(skb, self->header_length), 0);
 476         }
 477
 478         /* FIXME: Make macro out of this one */
 479         ((struct irda_skb_cb *)skb->cb)->context = self;
 480
 481         usb_fill_bulk_urb(urb, self->usbdev,
 482                       usb_sndbulkpipe(self->usbdev, self->bulk_out_ep),
 483                       skb->data, IRDA_SKB_MAX_MTU,
 484                       write_bulk_callback, skb);
 485         urb->transfer_buffer_length = skb->len;
 486         /* This flag (URB_ZERO_PACKET) indicates that what we send is not
 487          * a continuous stream of data but separate packets.
 488          * In this case, the USB layer will insert an empty USB frame (TD)
 489          * after each of our packets that is exact multiple of the frame size.
 490          * This is how the dongle will detect the end of packet - Jean II */
 491         urb->transfer_flags = URB_ZERO_PACKET;
 492
 493         /* Generate min turn time. FIXME: can we do better than this? */
 494         /* Trying to a turnaround time at this level is trying to measure
 495          * processor clock cycle with a wrist-watch, approximate at best...
 496          *
 497          * What we know is the last time we received a frame over USB.
 498          * Due to latency over USB that depend on the USB load, we don't
 499          * know when this frame was received over IrDA (a few ms before ?)
 500          * Then, same story for our outgoing frame...
 501          *
 502          * In theory, the USB dongle is supposed to handle the turnaround
 503          * by itself (spec 1.0, chater 4, page 6). Who knows ??? That's
 504          * why this code is enabled only for dongles that doesn't meet
 505          * the spec.
 506          * Jean II */
 507         if (self->capability & IUC_NO_TURN) {
 508                 mtt = irda_get_mtt(skb);
 509                 if (mtt) {
 510                         int diff;
 511                         do_gettimeofday(&self->now);
 512                         diff = self->now.tv_usec - self->stamp.tv_usec;
 513 #ifdef IU_USB_MIN_RTT
 514                         /* Factor in USB delays -> Get rid of udelay() that
 515                          * would be lost in the noise - Jean II */
 516                         diff += IU_USB_MIN_RTT;
 517 #endif /* IU_USB_MIN_RTT */
 518                         /* If the usec counter did wraparound, the diff will
 519                          * go negative (tv_usec is a long), so we need to
 520                          * correct it by one second. Jean II */
 521                         if (diff < 0)
 522                                 diff += 1000000;
 523
 524                         /* Check if the mtt is larger than the time we have
 525                          * already used by all the protocol processing
 526                          */
 527                         if (mtt > diff) {
 528                                 mtt -= diff;
 529                                 if (mtt > 1000)
 530                                         mdelay(mtt/1000);
 531                                 else
 532                                         udelay(mtt);
 533                         }
 534                 }
 535         }
 536
 537         /* Ask USB to send the packet - Irq disabled -> GFP_ATOMIC */
 538         if ((res = usb_submit_urb(urb, GFP_ATOMIC))) {
 539                 IRDA_WARNING("%s(), failed Tx URB\n", __FUNCTION__);
 540                 self->stats.tx_errors++;
 541                 /* Let USB recover : We will catch that in the watchdog */
 542                 /*netif_start_queue(netdev);*/
 543         } else {
 544                 /* Increment packet stats */
 545                 self->stats.tx_packets++;
 546                 self->stats.tx_bytes += skb->len;
 547
 548                 netdev->trans_start = jiffies;
 549         }
 550         spin_unlock_irqrestore(&self->lock, flags);
 551
 552         return 0;
 553
 554 drop:
 555         /* Drop silently the skb and exit */
 556         dev_kfree_skb(skb);
 557         spin_unlock_irqrestore(&self->lock, flags);
 558         return err;             /* Usually 1 */
 559 }
 560
 561 /*------------------------------------------------------------------*/
 562 /*
 563  * Note : this function will be called only for tx_urb...
 564  */
 565 static void write_bulk_callback(struct urb *urb, struct pt_regs *regs)
 566 {
 567         unsigned long flags;
 568         struct sk_buff *skb = urb->context;
 569         struct irda_usb_cb *self = ((struct irda_skb_cb *) skb->cb)->context;
 570
 571         IRDA_DEBUG(2, "%s()\n", __FUNCTION__);
 572
 573         /* We should always have a context */
 574         IRDA_ASSERT(self != NULL, return;);
 575         /* We should always be called for the speed URB */
 576         IRDA_ASSERT(urb == self->tx_urb, return;);
 577
 578         /* Free up the skb */
 579         dev_kfree_skb_any(skb);
 580         urb->context = NULL;
 581
 582         /* Check for timeout and other USB nasties */
 583         if (urb->status != 0) {
 584                 /* I get a lot of -ECONNABORTED = -103 here - Jean II */
 585                 IRDA_DEBUG(0, "%s(), URB complete status %d, transfer_flags 0x%04X\n", __FUNCTION__, urb->status, urb->transfer_flags);
 586
 587                 /* Don't do anything here, that might confuse the USB layer,
 588                  * and we could go in recursion and blow the kernel stack...
 589                  * Instead, we will wait for irda_usb_net_timeout(), the
 590                  * network layer watchdog, to fix the situation.
 591                  * Jean II */
 592                 /* A reset of the dongle might be welcomed here - Jean II */
 593                 return;
 594         }
 595
 596         /* urb is now available */
 597         //urb->status = 0; -> tested above
 598
 599         /* Make sure we read self->present properly */
 600         spin_lock_irqsave(&self->lock, flags);
 601
 602         /* If the network is closed, stop everything */
 603         if ((!self->netopen) || (!self->present)) {
 604                 IRDA_DEBUG(0, "%s(), Network is gone...\n", __FUNCTION__);
 605                 spin_unlock_irqrestore(&self->lock, flags);
 606                 return;
 607         }
 608
 609         /* If changes to speed or xbofs is pending... */
 610         if ((self->new_speed != -1) || (self->new_xbofs != -1)) {
 611                 if ((self->new_speed != self->speed) ||
 612                     (self->new_xbofs != self->xbofs)) {
 613                         /* We haven't changed speed yet (because of
 614                          * IUC_SPEED_BUG), so do it now - Jean II */
 615                         IRDA_DEBUG(1, "%s(), Changing speed now...\n", __FUNCTION__);
 616                         irda_usb_change_speed_xbofs(self);
 617                 } else {
 618                         /* New speed and xbof is now commited in hardware */
 619                         self->new_speed = -1;
 620                         self->new_xbofs = -1;
 621                         /* Done, waiting for next packet */
 622                         netif_wake_queue(self->netdev);
 623                 }
 624         } else {
 625                 /* Otherwise, allow the stack to send more packets */
 626                 netif_wake_queue(self->netdev);
 627         }
 628         spin_unlock_irqrestore(&self->lock, flags);
 629 }
 630
 631 /*------------------------------------------------------------------*/
 632 /*
 633  * Watchdog timer from the network layer.
 634  * After a predetermined timeout, if we don't give confirmation that
 635  * the packet has been sent (i.e. no call to netif_wake_queue()),
 636  * the network layer will call this function.
 637  * Note that URB that we submit have also a timeout. When the URB timeout
 638  * expire, the normal URB callback is called (write_bulk_callback()).
 639  */
 640 static void irda_usb_net_timeout(struct net_device *netdev)
 641 {
 642         unsigned long flags;
 643         struct irda_usb_cb *self = netdev->priv;
 644         struct urb *urb;
 645         int     done = 0;       /* If we have made any progress */
 646
 647         IRDA_DEBUG(0, "%s(), Network layer thinks we timed out!\n", __FUNCTION__);
 648         IRDA_ASSERT(self != NULL, return;);
 649
 650         /* Protect us from USB callbacks, net Tx and else. */
 651         spin_lock_irqsave(&self->lock, flags);
 652
 653         /* self->present *MUST* be read under spinlock */
 654         if (!self->present) {
 655                 IRDA_WARNING("%s(), device not present!\n", __FUNCTION__);
 656                 netif_stop_queue(netdev);
 657                 spin_unlock_irqrestore(&self->lock, flags);
 658                 return;
 659         }
 660
 661         /* Check speed URB */
 662         urb = self->speed_urb;
 663         if (urb->status != 0) {
 664                 IRDA_DEBUG(0, "%s: Speed change timed out, urb->status=%d, urb->transfer_flags=0x%04X\n", netdev->name, urb->status, urb->transfer_flags);
 665
 666                 switch (urb->status) {
 667                 case -EINPROGRESS:
 668                         usb_unlink_urb(urb);
 669                         /* Note : above will  *NOT* call netif_wake_queue()
 670                          * in completion handler, we will come back here.
 671                          * Jean II */
 672                         done = 1;
 673                         break;
 674                 case -ECONNABORTED:             /* -103 */
 675                 case -ECONNRESET:               /* -104 */
 676                 case -ETIMEDOUT:                /* -110 */
 677                 case -ENOENT:                   /* -2 (urb unlinked by us)  */
 678                 default:                        /* ??? - Play safe */
 679                         urb->status = 0;
 680                         netif_wake_queue(self->netdev);
 681                         done = 1;
 682                         break;
 683                 }
 684         }
 685
 686         /* Check Tx URB */
 687         urb = self->tx_urb;
 688         if (urb->status != 0) {
 689                 struct sk_buff *skb = urb->context;
 690
 691                 IRDA_DEBUG(0, "%s: Tx timed out, urb->status=%d, urb->transfer_flags=0x%04X\n", netdev->name, urb->status, urb->transfer_flags);
 692
 693                 /* Increase error count */
 694                 self->stats.tx_errors++;
 695
 696 #ifdef IU_BUG_KICK_TIMEOUT
 697                 /* Can't be a bad idea to reset the speed ;-) - Jean II */
 698                 if(self->new_speed == -1)
 699                         self->new_speed = self->speed;
 700                 if(self->new_xbofs == -1)
 701                         self->new_xbofs = self->xbofs;
 702                 irda_usb_change_speed_xbofs(self);
 703 #endif /* IU_BUG_KICK_TIMEOUT */
 704
 705                 switch (urb->status) {
 706                 case -EINPROGRESS:
 707                         usb_unlink_urb(urb);
 708                         /* Note : above will  *NOT* call netif_wake_queue()
 709                          * in completion handler, because urb->status will
 710                          * be -ENOENT. We will fix that at the next watchdog,
 711                          * leaving more time to USB to recover...
 712                          * Jean II */
 713                         done = 1;
 714                         break;
 715                 case -ECONNABORTED:             /* -103 */
 716                 case -ECONNRESET:               /* -104 */
 717                 case -ETIMEDOUT:                /* -110 */
 718                 case -ENOENT:                   /* -2 (urb unlinked by us)  */
 719                 default:                        /* ??? - Play safe */
 720                         if(skb != NULL) {
 721                                 dev_kfree_skb_any(skb);
 722                                 urb->context = NULL;
 723                         }
 724                         urb->status = 0;
 725                         netif_wake_queue(self->netdev);
 726                         done = 1;
 727                         break;
 728                 }
 729         }
 730         spin_unlock_irqrestore(&self->lock, flags);
 731
 732         /* Maybe we need a reset */
 733         /* Note : Some drivers seem to use a usb_set_interface() when they
 734          * need to reset the hardware. Hum...
 735          */
 736
 737         /* if(done == 0) */
 738 }
 739
 740 /************************* RECEIVE ROUTINES *************************/
 741 /*
 742  * Receive packets from the USB layer stack and pass them to the IrDA stack.
 743  * Try to work around USB failures...
 744  */
 745
 746 /*
 747  * Note :
 748  * Some of you may have noticed that most dongle have an interrupt in pipe
 749  * that we don't use. Here is the little secret...
 750  * When we hang a Rx URB on the bulk in pipe, it generates some USB traffic
 751  * in every USB frame. This is unnecessary overhead.
 752  * The interrupt in pipe will generate an event every time a packet is
 753  * received. Reading an interrupt pipe adds minimal overhead, but has some
 754  * latency (~1ms).
 755  * If we are connected (speed != 9600), we want to minimise latency, so
 756  * we just always hang the Rx URB and ignore the interrupt.
 757  * If we are not connected (speed == 9600), there is usually no Rx traffic,
 758  * and we want to minimise the USB overhead. In this case we should wait
 759  * on the interrupt pipe and hang the Rx URB only when an interrupt is
 760  * received.
 761  * Jean II
 762  *
 763  * Note : don't read the above as what we are currently doing, but as
 764  * something we could do with KC dongle. Also don't forget that the
 765  * interrupt pipe is not part of the original standard, so this would
 766  * need to be optional...
 767  * Jean II
 768  */
 769
 770 /*------------------------------------------------------------------*/
 771 /*
 772  * Submit a Rx URB to the USB layer to handle reception of a frame
 773  * Mostly called by the completion callback of the previous URB.
 774  *
 775  * Jean II
 776  */
 777 static void irda_usb_submit(struct irda_usb_cb *self, struct sk_buff *skb, struct urb *urb)
 778 {
 779         struct irda_skb_cb *cb;
 780         int ret;
 781
 782         IRDA_DEBUG(2, "%s()\n", __FUNCTION__);
 783
 784         /* This should never happen */
 785         IRDA_ASSERT(skb != NULL, return;);
 786         IRDA_ASSERT(urb != NULL, return;);
 787
 788         /* Save ourselves in the skb */
 789         cb = (struct irda_skb_cb *) skb->cb;
 790         cb->context = self;
 791
 792         /* Reinitialize URB */
 793         usb_fill_bulk_urb(urb, self->usbdev,
 794                       usb_rcvbulkpipe(self->usbdev, self->bulk_in_ep),
 795                       skb->data, IRDA_SKB_MAX_MTU,
 796                       irda_usb_receive, skb);
 797         urb->status = 0;
 798
 799         /* Can be called from irda_usb_receive (irq handler) -> GFP_ATOMIC */
 800         ret = usb_submit_urb(urb, GFP_ATOMIC);
 801         if (ret) {
 802                 /* If this ever happen, we are in deep s***.
 803                  * Basically, the Rx path will stop... */
 804                 IRDA_WARNING("%s(), Failed to submit Rx URB %d\n",
 805                              __FUNCTION__, ret);
 806         }
 807 }
 808
 809 /*------------------------------------------------------------------*/
 810 /*
 811  * Function irda_usb_receive(urb)
 812  *
 813  *     Called by the USB subsystem when a frame has been received
 814  *
 815  */
 816 static void irda_usb_receive(struct urb *urb, struct pt_regs *regs)
 817 {
 818         struct sk_buff *skb = (struct sk_buff *) urb->context;
 819         struct irda_usb_cb *self;
 820         struct irda_skb_cb *cb;
 821         struct sk_buff *newskb;
 822         struct sk_buff *dataskb;
 823         struct urb *next_urb;
 824         unsigned int len, docopy;
 825
 826         IRDA_DEBUG(2, "%s(), len=%d\n", __FUNCTION__, urb->actual_length);
 827
 828         /* Find ourselves */
 829         cb = (struct irda_skb_cb *) skb->cb;
 830         IRDA_ASSERT(cb != NULL, return;);
 831         self = (struct irda_usb_cb *) cb->context;
 832         IRDA_ASSERT(self != NULL, return;);
 833
 834         /* If the network is closed or the device gone, stop everything */
 835         if ((!self->netopen) || (!self->present)) {
 836                 IRDA_DEBUG(0, "%s(), Network is gone!\n", __FUNCTION__);
 837                 /* Don't re-submit the URB : will stall the Rx path */
 838                 return;
 839         }
 840
 841         /* Check the status */
 842         if (urb->status != 0) {
 843                 switch (urb->status) {
 844                 case -EILSEQ:
 845                         self->stats.rx_crc_errors++;
 846                         /* Also precursor to a hot-unplug on UHCI. */
 847                         /* Fallthrough... */
 848                 case -ECONNRESET:               /* -104 */
 849                         /* Random error, if I remember correctly */
 850                         /* uhci_cleanup_unlink() is going to kill the Rx
 851                          * URB just after we return. No problem, at this
 852                          * point the URB will be idle ;-) - Jean II */
 853                 case -ESHUTDOWN:                /* -108 */
 854                         /* That's usually a hot-unplug. Submit will fail... */
 855                 case -ETIMEDOUT:                /* -110 */
 856                         /* Usually precursor to a hot-unplug on OHCI. */
 857                 default:
 858                         self->stats.rx_errors++;
 859                         IRDA_DEBUG(0, "%s(), RX status %d, transfer_flags 0x%04X \n", __FUNCTION__, urb->status, urb->transfer_flags);
 860                         break;
 861                 }
 862                 /* If we received an error, we don't want to resubmit the
 863                  * Rx URB straight away but to give the USB layer a little
 864                  * bit of breathing room.
 865                  * We are in the USB thread context, therefore there is a
 866                  * danger of recursion (new URB we submit fails, we come
 867                  * back here).
 868                  * With recent USB stack (2.6.15+), I'm seeing that on
 869                  * hot unplug of the dongle...
 870                  * Lowest effective timer is 10ms...
 871                  * Jean II */
 872                 self->rx_defer_timer.function = &irda_usb_rx_defer_expired;
 873                 self->rx_defer_timer.data = (unsigned long) urb;
 874                 mod_timer(&self->rx_defer_timer, jiffies + (10 * HZ / 1000));
 875                 return;
 876         }
 877
 878         /* Check for empty frames */
 879         if (urb->actual_length <= self->header_length) {
 880                 IRDA_WARNING("%s(), empty frame!\n", __FUNCTION__);
 881                 goto done;
 882         }
 883
 884         /*
 885          * Remember the time we received this frame, so we can
 886          * reduce the min turn time a bit since we will know
 887          * how much time we have used for protocol processing
 888          */
 889         do_gettimeofday(&self->stamp);
 890
 891         /* Check if we need to copy the data to a new skb or not.
 892          * For most frames, we use ZeroCopy and pass the already
 893          * allocated skb up the stack.
 894          * If the frame is small, it is more efficient to copy it
 895          * to save memory (copy will be fast anyway - that's
 896          * called Rx-copy-break). Jean II */
 897         docopy = (urb->actual_length < IRDA_RX_COPY_THRESHOLD);
 898
 899         /* Allocate a new skb */
 900         if (self->capability & IUC_STIR421X)
 901                 newskb = dev_alloc_skb(docopy ? urb->actual_length :
 902                                        IRDA_SKB_MAX_MTU +
 903                                        USB_IRDA_STIR421X_HEADER);
 904         else
 905                 newskb = dev_alloc_skb(docopy ? urb->actual_length :
 906                                        IRDA_SKB_MAX_MTU);
 907
 908         if (!newskb)  {
 909                 self->stats.rx_dropped++;
 910                 /* We could deliver the current skb, but this would stall
 911                  * the Rx path. Better drop the packet... Jean II */
 912                 goto done;
 913         }
 914
 915         /* Make sure IP header get aligned (IrDA header is 5 bytes) */
 916         /* But IrDA-USB header is 1 byte. Jean II */
 917         //skb_reserve(newskb, USB_IRDA_HEADER - 1);
 918
 919         if(docopy) {
 920                 /* Copy packet, so we can recycle the original */
 921                 memcpy(newskb->data, skb->data, urb->actual_length);
 922                 /* Deliver this new skb */
 923                 dataskb = newskb;
 924                 /* And hook the old skb to the URB
 925                  * Note : we don't need to "clean up" the old skb,
 926                  * as we never touched it. Jean II */
 927         } else {
 928                 /* We are using ZeroCopy. Deliver old skb */
 929                 dataskb = skb;
 930                 /* And hook the new skb to the URB */
 931                 skb = newskb;
 932         }
 933
 934         /* Set proper length on skb & remove USB-IrDA header */
 935         skb_put(dataskb, urb->actual_length);
 936         skb_pull(dataskb, self->header_length);
 937
 938         /* Ask the networking layer to queue the packet for the IrDA stack */
 939         dataskb->dev = self->netdev;
 940         dataskb->mac.raw  = dataskb->data;
 941         dataskb->protocol = htons(ETH_P_IRDA);
 942         len = dataskb->len;
 943         netif_rx(dataskb);
 944
 945         /* Keep stats up to date */
 946         self->stats.rx_bytes += len;
 947         self->stats.rx_packets++;
 948         self->netdev->last_rx = jiffies;
 949
 950 done:
 951         /* Note : at this point, the URB we've just received (urb)
 952          * is still referenced by the USB layer. For example, if we
 953          * have received a -ECONNRESET, uhci_cleanup_unlink() will
 954          * continue to process it (in fact, cleaning it up).
 955          * If we were to submit this URB, disaster would ensue.
 956          * Therefore, we submit our idle URB, and put this URB in our
 957          * idle slot....
 958          * Jean II */
 959         /* Note : with this scheme, we could submit the idle URB before
 960          * processing the Rx URB. I don't think it would buy us anything as
 961          * we are running in the USB thread context. Jean II */
 962         next_urb = self->idle_rx_urb;
 963
 964         /* Recycle Rx URB : Now, the idle URB is the present one */
 965         urb->context = NULL;
 966         self->idle_rx_urb = urb;
 967
 968         /* Submit the idle URB to replace the URB we've just received.
 969          * Do it last to avoid race conditions... Jean II */
 970         irda_usb_submit(self, skb, next_urb);
 971 }
 972
 973 /*------------------------------------------------------------------*/
 974 /*
 975  * In case of errors, we want the USB layer to have time to recover.
 976  * Now, it is time to resubmit ouur Rx URB...
 977  */
 978 static void irda_usb_rx_defer_expired(unsigned long data)
 979 {
 980         struct urb *urb = (struct urb *) data;
 981         struct sk_buff *skb = (struct sk_buff *) urb->context;
 982         struct irda_usb_cb *self;
 983         struct irda_skb_cb *cb;
 984         struct urb *next_urb;
 985
 986         IRDA_DEBUG(2, "%s()\n", __FUNCTION__);
 987
 988         /* Find ourselves */
 989         cb = (struct irda_skb_cb *) skb->cb;
 990         IRDA_ASSERT(cb != NULL, return;);
 991         self = (struct irda_usb_cb *) cb->context;
 992         IRDA_ASSERT(self != NULL, return;);
 993
 994         /* Same stuff as when Rx is done, see above... */
 995         next_urb = self->idle_rx_urb;
 996         urb->context = NULL;
 997         self->idle_rx_urb = urb;
 998         irda_usb_submit(self, skb, next_urb);
 999 }
1000
1001 /*------------------------------------------------------------------*/
1002 /*
1003  * Callbak from IrDA layer. IrDA wants to know if we have
1004  * started receiving anything.
1005  */
1006 static int irda_usb_is_receiving(struct irda_usb_cb *self)
1007 {
1008         /* Note : because of the way UHCI works, it's almost impossible
1009          * to get this info. The Controller DMA directly to memory and
1010          * signal only when the whole frame is finished. To know if the
1011          * first TD of the URB has been filled or not seems hard work...
1012          *
1013          * The other solution would be to use the "receiving" command
1014          * on the default decriptor with a usb_control_msg(), but that
1015          * would add USB traffic and would return result only in the
1016          * next USB frame (~1ms).
1017          *
1018          * I've been told that current dongles send status info on their
1019          * interrupt endpoint, and that's what the Windows driver uses
1020          * to know this info. Unfortunately, this is not yet in the spec...
1021          *
1022          * Jean II
1023          */
1024
1025         return 0; /* For now */
1026 }
1027
1028 #define STIR421X_PATCH_PRODUCT_VER     "Product Version: "
1029 #define STIR421X_PATCH_STMP_TAG        "STMP"
1030 #define STIR421X_PATCH_CODE_OFFSET     512 /* patch image starts before here */
1031 /* marks end of patch file header (PC DOS text file EOF character) */
1032 #define STIR421X_PATCH_END_OF_HDR_TAG  0x1A
1033 #define STIR421X_PATCH_BLOCK_SIZE      1023
1034
1035 /*
1036  * Function stir421x_fwupload (struct irda_usb_cb *self,
1037  *                             unsigned char *patch,
1038  *                             const unsigned int patch_len)
1039  *
1040  *   Upload firmware code to SigmaTel 421X IRDA-USB dongle
1041  */
1042 static int stir421x_fw_upload(struct irda_usb_cb *self,
1043                              unsigned char *patch,
1044                              const unsigned int patch_len)
1045 {
1046         int ret = -ENOMEM;
1047         int actual_len = 0;
1048         unsigned int i;
1049         unsigned int block_size = 0;
1050         unsigned char *patch_block;
1051
1052         patch_block = kzalloc(STIR421X_PATCH_BLOCK_SIZE, GFP_KERNEL);
1053         if (patch_block == NULL)
1054                 return -ENOMEM;
1055
1056         /* break up patch into 1023-byte sections */
1057         for (i = 0; i < patch_len; i += block_size) {
1058                 block_size = patch_len - i;
1059
1060                 if (block_size > STIR421X_PATCH_BLOCK_SIZE)
1061                         block_size = STIR421X_PATCH_BLOCK_SIZE;
1062
1063                 /* upload the patch section */
1064                 memcpy(patch_block, patch + i, block_size);
1065
1066                 ret = usb_bulk_msg(self->usbdev,
1067                                    usb_sndbulkpipe(self->usbdev,
1068                                                    self->bulk_out_ep),
1069                                    patch_block, block_size,
1070                                    &actual_len, msecs_to_jiffies(500));
1071                 IRDA_DEBUG(3,"%s(): Bulk send %u bytes, ret=%d\n",
1072                            __FUNCTION__, actual_len, ret);
1073
1074                 if (ret < 0)
1075                         break;
1076         }
1077
1078         kfree(patch_block);
1079
1080         return ret;
1081  }
1082
1083 /*
1084  * Function stir421x_patch_device(struct irda_usb_cb *self)
1085  *
1086  * Get a firmware code from userspase using hotplug request_firmware() call
1087   */
1088 static int stir421x_patch_device(struct irda_usb_cb *self)
1089 {
1090         unsigned int i;
1091         int ret;
1092         char stir421x_fw_name[11];
1093         const struct firmware *fw;
1094         unsigned char *fw_version_ptr; /* pointer to version string */
1095         unsigned long fw_version = 0;
1096
1097         /*
1098          * Known firmware patch file names for STIR421x dongles
1099          * are "42101001.sb" or "42101002.sb"
1100          */
1101         sprintf(stir421x_fw_name, "4210%4X.sb",
1102                 self->usbdev->descriptor.bcdDevice);
1103         ret = request_firmware(&fw, stir421x_fw_name, &self->usbdev->dev);
1104         if (ret < 0)
1105                 return ret;
1106
1107         /* We get a patch from userspace */
1108         IRDA_MESSAGE("%s(): Received firmware %s (%zu bytes)\n",
1109                      __FUNCTION__, stir421x_fw_name, fw->size);
1110
1111         ret = -EINVAL;
1112
1113         /* Get the bcd product version */
1114         if (!memcmp(fw->data, STIR421X_PATCH_PRODUCT_VER,
1115                     sizeof(STIR421X_PATCH_PRODUCT_VER) - 1)) {
1116                 fw_version_ptr = fw->data +
1117                         sizeof(STIR421X_PATCH_PRODUCT_VER) - 1;
1118
1119                 /* Let's check if the product version is dotted */
1120                 if (fw_version_ptr[3] == '.' &&
1121                     fw_version_ptr[7] == '.') {
1122                         unsigned long major, minor, build;
1123                         major = simple_strtoul(fw_version_ptr, NULL, 10);
1124                         minor = simple_strtoul(fw_version_ptr + 4, NULL, 10);
1125                         build = simple_strtoul(fw_version_ptr + 8, NULL, 10);
1126
1127                         fw_version = (major << 12)
1128                                 + (minor << 8)
1129                                 + ((build / 10) << 4)
1130                                 + (build % 10);
1131
1132                         IRDA_DEBUG(3, "%s(): Firmware Product version %ld\n",
1133                                    __FUNCTION__, fw_version);
1134                 }
1135         }
1136
1137         if (self->usbdev->descriptor.bcdDevice == fw_version) {
1138                 /*
1139                  * If we're here, we've found a correct patch
1140                  * The actual image starts after the "STMP" keyword
1141                  * so forward to the firmware header tag
1142                  */
1143                 for (i = 0; (fw->data[i] != STIR421X_PATCH_END_OF_HDR_TAG)
1144                              && (i < fw->size); i++) ;
1145                 /* here we check for the out of buffer case */
1146                 if ((STIR421X_PATCH_END_OF_HDR_TAG == fw->data[i])
1147                     && (i < STIR421X_PATCH_CODE_OFFSET)) {
1148                         if (!memcmp(fw->data + i + 1, STIR421X_PATCH_STMP_TAG,
1149                                     sizeof(STIR421X_PATCH_STMP_TAG) - 1)) {
1150
1151                                 /* We can upload the patch to the target */
1152                                 i += sizeof(STIR421X_PATCH_STMP_TAG);
1153                                 ret = stir421x_fw_upload(self, &fw->data[i],
1154                                                          fw->size - i);
1155                         }
1156                 }
1157         }
1158
1159         release_firmware(fw);
1160
1161         return ret;
1162 }
1163
1164
1165 /********************** IRDA DEVICE CALLBACKS **********************/
1166 /*
1167  * Main calls from the IrDA/Network subsystem.
1168  * Mostly registering a new irda-usb device and removing it....
1169  * We only deal with the IrDA side of the business, the USB side will
1170  * be dealt with below...
1171  */
1172
1173
1174 /*------------------------------------------------------------------*/
1175 /*
1176  * Function irda_usb_net_open (dev)
1177  *
1178  *    Network device is taken up. Usually this is done by "ifconfig irda0 up"
1179  *
1180  * Note : don't mess with self->netopen - Jean II
1181  */
1182 static int irda_usb_net_open(struct net_device *netdev)
1183 {
1184         struct irda_usb_cb *self;
1185         char    hwname[16];
1186         int i;
1187
1188         IRDA_DEBUG(1, "%s()\n", __FUNCTION__);
1189
1190         IRDA_ASSERT(netdev != NULL, return -1;);
1191         self = (struct irda_usb_cb *) netdev->priv;
1192         IRDA_ASSERT(self != NULL, return -1;);
1193
1194         /* Can only open the device if it's there */
1195         if(!self->present) {
1196                 IRDA_WARNING("%s(), device not present!\n", __FUNCTION__);
1197                 return -1;
1198         }
1199
1200         if(self->needspatch) {
1201                 IRDA_WARNING("%s(), device needs patch\n", __FUNCTION__) ;
1202                 return -EIO ;
1203         }
1204
1205         /* Initialise default speed and xbofs value
1206          * (IrLAP will change that soon) */
1207         self->speed = -1;
1208         self->xbofs = -1;
1209         self->new_speed = -1;
1210         self->new_xbofs = -1;
1211
1212         /* To do *before* submitting Rx urbs and starting net Tx queue
1213          * Jean II */
1214         self->netopen = 1;
1215
1216         /*
1217          * Now that everything should be initialized properly,
1218          * Open new IrLAP layer instance to take care of us...
1219          * Note : will send immediately a speed change...
1220          */
1221         sprintf(hwname, "usb#%d", self->usbdev->devnum);
1222         self->irlap = irlap_open(netdev, &self->qos, hwname);
1223         IRDA_ASSERT(self->irlap != NULL, return -1;);
1224
1225         /* Allow IrLAP to send data to us */
1226         netif_start_queue(netdev);
1227
1228         /* We submit all the Rx URB except for one that we keep idle.
1229          * Need to be initialised before submitting other USBs, because
1230          * in some cases as soon as we submit the URBs the USB layer
1231          * will trigger a dummy receive - Jean II */
1232         self->idle_rx_urb = self->rx_urb[IU_MAX_ACTIVE_RX_URBS];
1233         self->idle_rx_urb->context = NULL;
1234
1235         /* Now that we can pass data to IrLAP, allow the USB layer
1236          * to send us some data... */
1237         for (i = 0; i < IU_MAX_ACTIVE_RX_URBS; i++) {
1238                 struct sk_buff *skb = dev_alloc_skb(IRDA_SKB_MAX_MTU);
1239                 if (!skb) {
1240                         /* If this ever happen, we are in deep s***.
1241                          * Basically, we can't start the Rx path... */
1242                         IRDA_WARNING("%s(), Failed to allocate Rx skb\n",
1243                                      __FUNCTION__);
1244                         return -1;
1245                 }
1246                 //skb_reserve(newskb, USB_IRDA_HEADER - 1);
1247                 irda_usb_submit(self, skb, self->rx_urb[i]);
1248         }
1249
1250         /* Ready to play !!! */
1251         return 0;
1252 }
1253
1254 /*------------------------------------------------------------------*/
1255 /*
1256  * Function irda_usb_net_close (self)
1257  *
1258  *    Network device is taken down. Usually this is done by
1259  *    "ifconfig irda0 down"
1260  */
1261 static int irda_usb_net_close(struct net_device *netdev)
1262 {
1263         struct irda_usb_cb *self;
1264         int     i;
1265
1266         IRDA_DEBUG(1, "%s()\n", __FUNCTION__);
1267
1268         IRDA_ASSERT(netdev != NULL, return -1;);
1269         self = (struct irda_usb_cb *) netdev->priv;
1270         IRDA_ASSERT(self != NULL, return -1;);
1271
1272         /* Clear this flag *before* unlinking the urbs and *before*
1273          * stopping the network Tx queue - Jean II */
1274         self->netopen = 0;
1275
1276         /* Stop network Tx queue */
1277         netif_stop_queue(netdev);
1278
1279         /* Kill defered Rx URB */
1280         del_timer(&self->rx_defer_timer);
1281
1282         /* Deallocate all the Rx path buffers (URBs and skb) */
1283         for (i = 0; i < self->max_rx_urb; i++) {
1284                 struct urb *urb = self->rx_urb[i];
1285                 struct sk_buff *skb = (struct sk_buff *) urb->context;
1286                 /* Cancel the receive command */
1287                 usb_kill_urb(urb);
1288                 /* The skb is ours, free it */
1289                 if(skb) {
1290                         dev_kfree_skb(skb);
1291                         urb->context = NULL;
1292                 }
1293         }
1294         /* Cancel Tx and speed URB - need to be synchronous to avoid races */
1295         usb_kill_urb(self->tx_urb);
1296         usb_kill_urb(self->speed_urb);
1297
1298         /* Stop and remove instance of IrLAP */
1299         if (self->irlap)
1300                 irlap_close(self->irlap);
1301         self->irlap = NULL;
1302
1303         return 0;
1304 }
1305
1306 /*------------------------------------------------------------------*/
1307 /*
1308  * IOCTLs : Extra out-of-band network commands...
1309  */
1310 static int irda_usb_net_ioctl(struct net_device *dev, struct ifreq *rq, int cmd)
1311 {
1312         unsigned long flags;
1313         struct if_irda_req *irq = (struct if_irda_req *) rq;
1314         struct irda_usb_cb *self;
1315         int ret = 0;
1316
1317         IRDA_ASSERT(dev != NULL, return -1;);
1318         self = dev->priv;
1319         IRDA_ASSERT(self != NULL, return -1;);
1320
1321         IRDA_DEBUG(2, "%s(), %s, (cmd=0x%X)\n", __FUNCTION__, dev->name, cmd);
1322
1323         switch (cmd) {
1324         case SIOCSBANDWIDTH: /* Set bandwidth */
1325                 if (!capable(CAP_NET_ADMIN))
1326                         return -EPERM;
1327                 /* Protect us from USB callbacks, net watchdog and else. */
1328                 spin_lock_irqsave(&self->lock, flags);
1329                 /* Check if the device is still there */
1330                 if(self->present) {
1331                         /* Set the desired speed */
1332                         self->new_speed = irq->ifr_baudrate;
1333                         irda_usb_change_speed_xbofs(self);
1334                 }
1335                 spin_unlock_irqrestore(&self->lock, flags);
1336                 break;
1337         case SIOCSMEDIABUSY: /* Set media busy */
1338                 if (!capable(CAP_NET_ADMIN))
1339                         return -EPERM;
1340                 /* Check if the IrDA stack is still there */
1341                 if(self->netopen)
1342                         irda_device_set_media_busy(self->netdev, TRUE);
1343                 break;
1344         case SIOCGRECEIVING: /* Check if we are receiving right now */
1345                 irq->ifr_receiving = irda_usb_is_receiving(self);
1346                 break;
1347         default:
1348                 ret = -EOPNOTSUPP;
1349         }
1350
1351         return ret;
1352 }
1353
1354 /*------------------------------------------------------------------*/
1355 /*
1356  * Get device stats (for /proc/net/dev and ifconfig)
1357  */
1358 static struct net_device_stats *irda_usb_net_get_stats(struct net_device *dev)
1359 {
1360         struct irda_usb_cb *self = dev->priv;
1361         return &self->stats;
1362 }
1363
1364 /********************* IRDA CONFIG SUBROUTINES *********************/
1365 /*
1366  * Various subroutines dealing with IrDA and network stuff we use to
1367  * configure and initialise each irda-usb instance.
1368  * These functions are used below in the main calls of the driver...
1369  */
1370
1371 /*------------------------------------------------------------------*/
1372 /*
1373  * Set proper values in the IrDA QOS structure
1374  */
1375 static inline void irda_usb_init_qos(struct irda_usb_cb *self)
1376 {
1377         struct irda_class_desc *desc;
1378
1379         IRDA_DEBUG(3, "%s()\n", __FUNCTION__);
1380
1381         desc = self->irda_desc;
1382
1383         /* Initialize QoS for this device */
1384         irda_init_max_qos_capabilies(&self->qos);
1385
1386         /* See spec section 7.2 for meaning.
1387          * Values are little endian (as most USB stuff), the IrDA stack
1388          * use it in native order (see parameters.c). - Jean II */
1389         self->qos.baud_rate.bits       = le16_to_cpu(desc->wBaudRate);
1390         self->qos.min_turn_time.bits   = desc->bmMinTurnaroundTime;
1391         self->qos.additional_bofs.bits = desc->bmAdditionalBOFs;
1392         self->qos.window_size.bits     = desc->bmWindowSize;
1393         self->qos.data_size.bits       = desc->bmDataSize;
1394
1395         IRDA_DEBUG(0, "%s(), dongle says speed=0x%X, size=0x%X, window=0x%X, bofs=0x%X, turn=0x%X\n",
1396                 __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);
1397
1398         /* Don't always trust what the dongle tell us */
1399         if(self->capability & IUC_SIR_ONLY)
1400                 self->qos.baud_rate.bits        &= 0x00ff;
1401         if(self->capability & IUC_SMALL_PKT)
1402                 self->qos.data_size.bits         = 0x07;
1403         if(self->capability & IUC_NO_WINDOW)
1404                 self->qos.window_size.bits       = 0x01;
1405         if(self->capability & IUC_MAX_WINDOW)
1406                 self->qos.window_size.bits       = 0x7f;
1407         if(self->capability & IUC_MAX_XBOFS)
1408                 self->qos.additional_bofs.bits   = 0x01;
1409
1410 #if 1
1411         /* Module parameter can override the rx window size */
1412         if (qos_mtt_bits)
1413                 self->qos.min_turn_time.bits = qos_mtt_bits;
1414 #endif
1415         /*
1416          * Note : most of those values apply only for the receive path,
1417          * the transmit path will be set differently - Jean II
1418          */
1419         irda_qos_bits_to_value(&self->qos);
1420 }
1421
1422 /*------------------------------------------------------------------*/
1423 /*
1424  * Initialise the network side of the irda-usb instance
1425  * Called when a new USB instance is registered in irda_usb_probe()
1426  */
1427 static inline int irda_usb_open(struct irda_usb_cb *self)
1428 {
1429         struct net_device *netdev = self->netdev;
1430
1431         IRDA_DEBUG(1, "%s()\n", __FUNCTION__);
1432
1433         irda_usb_init_qos(self);
1434
1435         /* Override the network functions we need to use */
1436         netdev->hard_start_xmit = irda_usb_hard_xmit;
1437         netdev->tx_timeout      = irda_usb_net_timeout;
1438         netdev->watchdog_timeo  = 250*HZ/1000;  /* 250 ms > USB timeout */
1439         netdev->open            = irda_usb_net_open;
1440         netdev->stop            = irda_usb_net_close;
1441         netdev->get_stats       = irda_usb_net_get_stats;
1442         netdev->do_ioctl        = irda_usb_net_ioctl;
1443
1444         return register_netdev(netdev);
1445 }
1446
1447 /*------------------------------------------------------------------*/
1448 /*
1449  * Cleanup the network side of the irda-usb instance
1450  * Called when a USB instance is removed in irda_usb_disconnect()
1451  */
1452 static inline void irda_usb_close(struct irda_usb_cb *self)
1453 {
1454         IRDA_DEBUG(1, "%s()\n", __FUNCTION__);
1455
1456         /* Remove netdevice */
1457         unregister_netdev(self->netdev);
1458
1459         /* Remove the speed buffer */
1460         kfree(self->speed_buff);
1461         self->speed_buff = NULL;
1462 }
1463
1464 /********************** USB CONFIG SUBROUTINES **********************/
1465 /*
1466  * Various subroutines dealing with USB stuff we use to configure and
1467  * initialise each irda-usb instance.
1468  * These functions are used below in the main calls of the driver...
1469  */
1470
1471 /*------------------------------------------------------------------*/
1472 /*
1473  * Function irda_usb_parse_endpoints(dev, ifnum)
1474  *
1475  *    Parse the various endpoints and find the one we need.
1476  *
1477  * The endpoint are the pipes used to communicate with the USB device.
1478  * The spec defines 2 endpoints of type bulk transfer, one in, and one out.
1479  * These are used to pass frames back and forth with the dongle.
1480  * Most dongle have also an interrupt endpoint, that will be probably
1481  * documented in the next spec...
1482  */
1483 static inline int irda_usb_parse_endpoints(struct irda_usb_cb *self, struct usb_host_endpoint *endpoint, int ennum)
1484 {
1485         int i;          /* Endpoint index in table */
1486
1487         /* Init : no endpoints */
1488         self->bulk_in_ep = 0;
1489         self->bulk_out_ep = 0;
1490         self->bulk_int_ep = 0;
1491
1492         /* Let's look at all those endpoints */
1493         for(i = 0; i < ennum; i++) {
1494                 /* All those variables will get optimised by the compiler,
1495                  * so let's aim for clarity... - Jean II */
1496                 __u8 ep;        /* Endpoint address */
1497                 __u8 dir;       /* Endpoint direction */
1498                 __u8 attr;      /* Endpoint attribute */
1499                 __u16 psize;    /* Endpoint max packet size in bytes */
1500
1501                 /* Get endpoint address, direction and attribute */
1502                 ep = endpoint[i].desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1503                 dir = endpoint[i].desc.bEndpointAddress & USB_ENDPOINT_DIR_MASK;
1504                 attr = endpoint[i].desc.bmAttributes;
1505                 psize = le16_to_cpu(endpoint[i].desc.wMaxPacketSize);
1506
1507                 /* Is it a bulk endpoint ??? */
1508                 if(attr == USB_ENDPOINT_XFER_BULK) {
1509                         /* We need to find an IN and an OUT */
1510                         if(dir == USB_DIR_IN) {
1511                                 /* This is our Rx endpoint */
1512                                 self->bulk_in_ep = ep;
1513                         } else {
1514                                 /* This is our Tx endpoint */
1515                                 self->bulk_out_ep = ep;
1516                                 self->bulk_out_mtu = psize;
1517                         }
1518                 } else {
1519                         if((attr == USB_ENDPOINT_XFER_INT) &&
1520                            (dir == USB_DIR_IN)) {
1521                                 /* This is our interrupt endpoint */
1522                                 self->bulk_int_ep = ep;
1523                         } else {
1524                                 IRDA_ERROR("%s(), Unrecognised endpoint %02X.\n", __FUNCTION__, ep);
1525                         }
1526                 }
1527         }
1528
1529         IRDA_DEBUG(0, "%s(), And our endpoints are : in=%02X, out=%02X (%d), int=%02X\n",
1530                 __FUNCTION__, self->bulk_in_ep, self->bulk_out_ep, self->bulk_out_mtu, self->bulk_int_ep);
1531         /* Should be 8, 16, 32 or 64 bytes */
1532         IRDA_ASSERT(self->bulk_out_mtu == 64, ;);
1533
1534         return((self->bulk_in_ep != 0) && (self->bulk_out_ep != 0));
1535 }
1536
1537 #ifdef IU_DUMP_CLASS_DESC
1538 /*------------------------------------------------------------------*/
1539 /*
1540  * Function usb_irda_dump_class_desc(desc)
1541  *
1542  *    Prints out the contents of the IrDA class descriptor
1543  *
1544  */
1545 static inline void irda_usb_dump_class_desc(struct irda_class_desc *desc)
1546 {
1547         /* Values are little endian */
1548         printk("bLength=%x\n", desc->bLength);
1549         printk("bDescriptorType=%x\n", desc->bDescriptorType);
1550         printk("bcdSpecRevision=%x\n", le16_to_cpu(desc->bcdSpecRevision));
1551         printk("bmDataSize=%x\n", desc->bmDataSize);
1552         printk("bmWindowSize=%x\n", desc->bmWindowSize);
1553         printk("bmMinTurnaroundTime=%d\n", desc->bmMinTurnaroundTime);
1554         printk("wBaudRate=%x\n", le16_to_cpu(desc->wBaudRate));
1555         printk("bmAdditionalBOFs=%x\n", desc->bmAdditionalBOFs);
1556         printk("bIrdaRateSniff=%x\n", desc->bIrdaRateSniff);
1557         printk("bMaxUnicastList=%x\n", desc->bMaxUnicastList);
1558 }
1559 #endif /* IU_DUMP_CLASS_DESC */
1560
1561 /*------------------------------------------------------------------*/
1562 /*
1563  * Function irda_usb_find_class_desc(intf)
1564  *
1565  *    Returns instance of IrDA class descriptor, or NULL if not found
1566  *
1567  * The class descriptor is some extra info that IrDA USB devices will
1568  * offer to us, describing their IrDA characteristics. We will use that in
1569  * irda_usb_init_qos()
1570  */
1571 static inline struct irda_class_desc *irda_usb_find_class_desc(struct usb_interface *intf)
1572 {
1573         struct usb_device *dev = interface_to_usbdev (intf);
1574         struct irda_class_desc *desc;
1575         int ret;
1576
1577         desc = kmalloc(sizeof (*desc), GFP_KERNEL);
1578         if (desc == NULL)
1579                 return NULL;
1580         memset(desc, 0, sizeof(*desc));
1581
1582         /* USB-IrDA class spec 1.0:
1583          *      6.1.3: Standard "Get Descriptor" Device Request is not
1584          *             appropriate to retrieve class-specific descriptor
1585          *      6.2.5: Class Specific "Get Class Descriptor" Interface Request
1586          *             is mandatory and returns the USB-IrDA class descriptor
1587          */
1588
1589         ret = usb_control_msg(dev, usb_rcvctrlpipe(dev,0),
1590                 IU_REQ_GET_CLASS_DESC,
1591                 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
1592                 0, intf->altsetting->desc.bInterfaceNumber, desc,
1593                 sizeof(*desc), 500);
1594
1595         IRDA_DEBUG(1, "%s(), ret=%d\n", __FUNCTION__, ret);
1596         if (ret < sizeof(*desc)) {
1597                 IRDA_WARNING("usb-irda: class_descriptor read %s (%d)\n",
1598                              (ret<0) ? "failed" : "too short", ret);
1599         }
1600         else if (desc->bDescriptorType != USB_DT_IRDA) {
1601                 IRDA_WARNING("usb-irda: bad class_descriptor type\n");
1602         }
1603         else {
1604 #ifdef IU_DUMP_CLASS_DESC
1605                 irda_usb_dump_class_desc(desc);
1606 #endif  /* IU_DUMP_CLASS_DESC */
1607
1608                 return desc;
1609         }
1610         kfree(desc);
1611         return NULL;
1612 }
1613
1614 /*********************** USB DEVICE CALLBACKS ***********************/
1615 /*
1616  * Main calls from the USB subsystem.
1617  * Mostly registering a new irda-usb device and removing it....
1618  */
1619
1620 /*------------------------------------------------------------------*/
1621 /*
1622  * This routine is called by the USB subsystem for each new device
1623  * in the system. We need to check if the device is ours, and in
1624  * this case start handling it.
1625  * The USB layer protect us from reentrancy (via BKL), so we don't need
1626  * to spinlock in there... Jean II
1627  */
1628 static int irda_usb_probe(struct usb_interface *intf,
1629                           const struct usb_device_id *id)
1630 {
1631         struct net_device *net;
1632         struct usb_device *dev = interface_to_usbdev(intf);
1633         struct irda_usb_cb *self = NULL;
1634         struct usb_host_interface *interface;
1635         struct irda_class_desc *irda_desc;
1636         int ret = -ENOMEM;
1637         int i;          /* Driver instance index / Rx URB index */
1638
1639         /* Note : the probe make sure to call us only for devices that
1640          * matches the list of dongle (top of the file). So, we
1641          * don't need to check if the dongle is really ours.
1642          * Jean II */
1643
1644         IRDA_MESSAGE("IRDA-USB found at address %d, Vendor: %x, Product: %x\n",
1645                      dev->devnum, le16_to_cpu(dev->descriptor.idVendor),
1646                      le16_to_cpu(dev->descriptor.idProduct));
1647
1648         net = alloc_irdadev(sizeof(*self));
1649         if (!net)
1650                 goto err_out;
1651
1652         SET_MODULE_OWNER(net);
1653         SET_NETDEV_DEV(net, &intf->dev);
1654         self = net->priv;
1655         self->netdev = net;
1656         spin_lock_init(&self->lock);
1657         init_timer(&self->rx_defer_timer);
1658
1659         self->capability = id->driver_info;
1660         self->needspatch = ((self->capability & IUC_STIR421X) != 0);
1661
1662         /* Create all of the needed urbs */
1663         if (self->capability & IUC_STIR421X) {
1664                 self->max_rx_urb = IU_SIGMATEL_MAX_RX_URBS;
1665                 self->header_length = USB_IRDA_STIR421X_HEADER;
1666         } else {
1667                 self->max_rx_urb = IU_MAX_RX_URBS;
1668                 self->header_length = USB_IRDA_HEADER;
1669         }
1670
1671         self->rx_urb = kzalloc(self->max_rx_urb * sizeof(struct urb *),
1672                                 GFP_KERNEL);
1673
1674         for (i = 0; i < self->max_rx_urb; i++) {
1675                 self->rx_urb[i] = usb_alloc_urb(0, GFP_KERNEL);
1676                 if (!self->rx_urb[i]) {
1677                         goto err_out_1;
1678                 }
1679         }
1680         self->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
1681         if (!self->tx_urb) {
1682                 goto err_out_1;
1683         }
1684         self->speed_urb = usb_alloc_urb(0, GFP_KERNEL);
1685         if (!self->speed_urb) {
1686                 goto err_out_2;
1687         }
1688
1689         /* Is this really necessary? (no, except maybe for broken devices) */
1690         if (usb_reset_configuration (dev) < 0) {
1691                 err("reset_configuration failed");
1692                 ret = -EIO;
1693                 goto err_out_3;
1694         }
1695
1696         /* Is this really necessary? */
1697         /* Note : some driver do hardcode the interface number, some others
1698          * specify an alternate, but very few driver do like this.
1699          * Jean II */
1700         ret = usb_set_interface(dev, intf->altsetting->desc.bInterfaceNumber, 0);
1701         IRDA_DEBUG(1, "usb-irda: set interface %d result %d\n", intf->altsetting->desc.bInterfaceNumber, ret);
1702         switch (ret) {
1703                 case 0:
1704                         break;
1705                 case -EPIPE:            /* -EPIPE = -32 */
1706                         /* Martin Diehl says if we get a -EPIPE we should
1707                          * be fine and we don't need to do a usb_clear_halt().
1708                          * - Jean II */
1709                         IRDA_DEBUG(0, "%s(), Received -EPIPE, ignoring...\n", __FUNCTION__);
1710                         break;
1711                 default:
1712                         IRDA_DEBUG(0, "%s(), Unknown error %d\n", __FUNCTION__, ret);
1713                         ret = -EIO;
1714                         goto err_out_3;
1715         }
1716
1717         /* Find our endpoints */
1718         interface = intf->cur_altsetting;
1719         if(!irda_usb_parse_endpoints(self, interface->endpoint,
1720                                      interface->desc.bNumEndpoints)) {
1721                 IRDA_ERROR("%s(), Bogus endpoints...\n", __FUNCTION__);
1722                 ret = -EIO;
1723                 goto err_out_3;
1724         }
1725
1726         self->usbdev = dev;
1727
1728         /* Find IrDA class descriptor */
1729         irda_desc = irda_usb_find_class_desc(intf);
1730         ret = -ENODEV;
1731         if (irda_desc == NULL)
1732                 goto err_out_3;
1733
1734         if (self->needspatch) {
1735                 ret = usb_control_msg (self->usbdev, usb_sndctrlpipe (self->usbdev, 0),
1736                                        0x02, 0x40, 0, 0, NULL, 0, 500);
1737                 if (ret < 0) {
1738                         IRDA_DEBUG (0, "usb_control_msg failed %d\n", ret);
1739                         goto err_out_3;
1740                 } else {
1741                         mdelay(10);
1742                 }
1743         }
1744
1745         self->irda_desc =  irda_desc;
1746         self->present = 1;
1747         self->netopen = 0;
1748         self->usbintf = intf;
1749
1750         /* Allocate the buffer for speed changes */
1751         /* Don't change this buffer size and allocation without doing
1752          * some heavy and complete testing. Don't ask why :-(
1753          * Jean II */
1754         self->speed_buff = (char *) kmalloc(IRDA_USB_SPEED_MTU, GFP_KERNEL);
1755         if (self->speed_buff == NULL)
1756                 goto err_out_3;
1757
1758         memset(self->speed_buff, 0, IRDA_USB_SPEED_MTU);
1759
1760         ret = irda_usb_open(self);
1761         if (ret)
1762                 goto err_out_4;
1763
1764         IRDA_MESSAGE("IrDA: Registered device %s\n", net->name);
1765         usb_set_intfdata(intf, self);
1766
1767         if (self->needspatch) {
1768                 /* Now we fetch and upload the firmware patch */
1769                 ret = stir421x_patch_device(self);
1770                 self->needspatch = (ret < 0);
1771                 if (self->needspatch) {
1772                         IRDA_ERROR("STIR421X: Couldn't upload patch\n");
1773                         goto err_out_5;
1774                 }
1775
1776                 /* replace IrDA class descriptor with what patched device is now reporting */
1777                 irda_desc = irda_usb_find_class_desc (self->usbintf);
1778                 if (irda_desc == NULL) {
1779                         ret = -ENODEV;
1780                         goto err_out_5;
1781                 }
1782                 if (self->irda_desc)
1783                         kfree (self->irda_desc);
1784                 self->irda_desc = irda_desc;
1785                 irda_usb_init_qos(self);
1786         }
1787
1788         return 0;
1789
1790 err_out_5:
1791         unregister_netdev(self->netdev);
1792 err_out_4:
1793         kfree(self->speed_buff);
1794 err_out_3:
1795         /* Free all urbs that we may have created */
1796         usb_free_urb(self->speed_urb);
1797 err_out_2:
1798         usb_free_urb(self->tx_urb);
1799 err_out_1:
1800         for (i = 0; i < self->max_rx_urb; i++) {
1801                 if (self->rx_urb[i])
1802                         usb_free_urb(self->rx_urb[i]);
1803         }
1804         free_netdev(net);
1805 err_out:
1806         return ret;
1807 }
1808
1809 /*------------------------------------------------------------------*/
1810 /*
1811  * The current irda-usb device is removed, the USB layer tell us
1812  * to shut it down...
1813  * One of the constraints is that when we exit this function,
1814  * we cannot use the usb_device no more. Gone. Destroyed. kfree().
1815  * Most other subsystem allow you to destroy the instance at a time
1816  * when it's convenient to you, to postpone it to a later date, but
1817  * not the USB subsystem.
1818  * So, we must make bloody sure that everything gets deactivated.
1819  * Jean II
1820  */
1821 static void irda_usb_disconnect(struct usb_interface *intf)
1822 {
1823         unsigned long flags;
1824         struct irda_usb_cb *self = usb_get_intfdata(intf);
1825         int i;
1826
1827         IRDA_DEBUG(1, "%s()\n", __FUNCTION__);
1828
1829         usb_set_intfdata(intf, NULL);
1830         if (!self)
1831                 return;
1832
1833         /* Make sure that the Tx path is not executing. - Jean II */
1834         spin_lock_irqsave(&self->lock, flags);
1835
1836         /* Oups ! We are not there any more.
1837          * This will stop/desactivate the Tx path. - Jean II */
1838         self->present = 0;
1839
1840         /* Kill defered Rx URB */
1841         del_timer(&self->rx_defer_timer);
1842
1843         /* We need to have irq enabled to unlink the URBs. That's OK,
1844          * at this point the Tx path is gone - Jean II */
1845         spin_unlock_irqrestore(&self->lock, flags);
1846
1847         /* Hum... Check if networking is still active (avoid races) */
1848         if((self->netopen) || (self->irlap)) {
1849                 /* Accept no more transmissions */
1850                 /*netif_device_detach(self->netdev);*/
1851                 netif_stop_queue(self->netdev);
1852                 /* Stop all the receive URBs. Must be synchronous. */
1853                 for (i = 0; i < self->max_rx_urb; i++)
1854                         usb_kill_urb(self->rx_urb[i]);
1855                 /* Cancel Tx and speed URB.
1856                  * Make sure it's synchronous to avoid races. */
1857                 usb_kill_urb(self->tx_urb);
1858                 usb_kill_urb(self->speed_urb);
1859         }
1860
1861         /* Cleanup the device stuff */
1862         irda_usb_close(self);
1863         /* No longer attached to USB bus */
1864         self->usbdev = NULL;
1865         self->usbintf = NULL;
1866
1867         /* Clean up our urbs */
1868         for (i = 0; i < self->max_rx_urb; i++)
1869                 usb_free_urb(self->rx_urb[i]);
1870         kfree(self->rx_urb);
1871         /* Clean up Tx and speed URB */
1872         usb_free_urb(self->tx_urb);
1873         usb_free_urb(self->speed_urb);
1874
1875         /* Free self and network device */
1876         free_netdev(self->netdev);
1877         IRDA_DEBUG(0, "%s(), USB IrDA Disconnected\n", __FUNCTION__);
1878 }
1879
1880 /*------------------------------------------------------------------*/
1881 /*
1882  * USB device callbacks
1883  */
1884 static struct usb_driver irda_driver = {
1885         .name           = "irda-usb",
1886         .probe          = irda_usb_probe,
1887         .disconnect     = irda_usb_disconnect,
1888         .id_table       = dongles,
1889 };
1890
1891 /************************* MODULE CALLBACKS *************************/
1892 /*
1893  * Deal with module insertion/removal
1894  * Mostly tell USB about our existence
1895  */
1896
1897 /*------------------------------------------------------------------*/
1898 /*
1899  * Module insertion
1900  */
1901 static int __init usb_irda_init(void)
1902 {
1903         int     ret;
1904
1905         ret = usb_register(&irda_driver);
1906         if (ret < 0)
1907                 return ret;
1908
1909         IRDA_MESSAGE("USB IrDA support registered\n");
1910         return 0;
1911 }
1912 module_init(usb_irda_init);
1913
1914 /*------------------------------------------------------------------*/
1915 /*
1916  * Module removal
1917  */
1918 static void __exit usb_irda_cleanup(void)
1919 {
1920         /* Deregister the driver and remove all pending instances */
1921         usb_deregister(&irda_driver);
1922 }
1923 module_exit(usb_irda_cleanup);
1924
1925 /*------------------------------------------------------------------*/
1926 /*
1927  * Module parameters
1928  */
1929 module_param(qos_mtt_bits, int, 0);
1930 MODULE_PARM_DESC(qos_mtt_bits, "Minimum Turn Time");
1931 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>");
1932 MODULE_DESCRIPTION("IrDA-USB Dongle Driver");
1933 MODULE_LICENSE("GPL");