drivers/net/irda/irda-usb.h

   1 /*****************************************************************************
   2  *
   3  * Filename:      irda-usb.h
   4  * Version:       0.10
   5  * Description:   IrDA-USB Driver
   6  * Status:        Experimental
   7  * Author:        Dag Brattli <dag@brattli.net>
   8  *
   9  *      Copyright (C) 2001, Roman Weissgaerber <weissg@vienna.at>
  10  *      Copyright (C) 2000, 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 #include <linux/time.h>
  33
  34 #include <net/irda/irda.h>
  35 #include <net/irda/irda_device.h>      /* struct irlap_cb */
  36
  37 #define PATCH_FILE_SIZE_MAX     65536
  38 #define PATCH_FILE_SIZE_MIN     80
  39
  40 #define RX_COPY_THRESHOLD 200
  41 #define IRDA_USB_MAX_MTU 2051
  42 #define IRDA_USB_SPEED_MTU 64           /* Weird, but work like this */
  43
  44 /* Maximum number of active URB on the Rx path
  45  * This is the amount of buffers the we keep between the USB harware and the
  46  * IrDA stack.
  47  *
  48  * Note : the network layer does also queue the packets between us and the
  49  * IrDA stack, and is actually pretty fast and efficient in doing that.
  50  * Therefore, we don't need to have a large number of URBs, and we can
  51  * perfectly live happy with only one. We certainly don't need to keep the
  52  * full IrTTP window around here...
  53  * I repeat for those who have trouble to understand : 1 URB is plenty
  54  * good enough to handle back-to-back (brickwalled) frames. I tried it,
  55  * it works (it's the hardware that has trouble doing it).
  56  *
  57  * Having 2 URBs would allow the USB stack to process one URB while we take
  58  * care of the other and then swap the URBs...
  59  * On the other hand, increasing the number of URB will have penalities
  60  * in term of latency and will interact with the link management in IrLAP...
  61  * Jean II */
  62 #define IU_MAX_ACTIVE_RX_URBS   1       /* Don't touch !!! */
  63
  64 /* When a Rx URB is passed back to us, we can't reuse it immediately,
  65  * because it may still be referenced by the USB layer. Therefore we
  66  * need to keep one extra URB in the Rx path.
  67  * Jean II */
  68 #define IU_MAX_RX_URBS  (IU_MAX_ACTIVE_RX_URBS + 1)
  69
  70 /* Various ugly stuff to try to workaround generic problems */
  71 /* Send speed command in case of timeout, just for trying to get things sane */
  72 #define IU_BUG_KICK_TIMEOUT
  73 /* Show the USB class descriptor */
  74 #undef IU_DUMP_CLASS_DESC
  75 /* Assume a minimum round trip latency for USB transfer (in us)...
  76  * USB transfer are done in the next USB slot if there is no traffic
  77  * (1/19 msec) and is done at 12 Mb/s :
  78  * Waiting for slot + tx = (53us + 16us) * 2 = 137us minimum.
  79  * Rx notification will only be done at the end of the USB frame period :
  80  * OHCI : frame period = 1ms
  81  * UHCI : frame period = 1ms, but notification can take 2 or 3 ms :-(
  82  * EHCI : frame period = 125us */
  83 #define IU_USB_MIN_RTT          500     /* This should be safe in most cases */
  84
  85 /* Inbound header */
  86 #define MEDIA_BUSY    0x80
  87
  88 #define SPEED_2400     0x01
  89 #define SPEED_9600     0x02
  90 #define SPEED_19200    0x03
  91 #define SPEED_38400    0x04
  92 #define SPEED_57600    0x05
  93 #define SPEED_115200   0x06
  94 #define SPEED_576000   0x07
  95 #define SPEED_1152000  0x08
  96 #define SPEED_4000000  0x09
  97 #define SPEED_16000000 0x0a
  98
  99 /* Basic capabilities */
 100 #define IUC_DEFAULT     0x00    /* Basic device compliant with 1.0 spec */
 101 /* Main bugs */
 102 #define IUC_SPEED_BUG   0x01    /* Device doesn't set speed after the frame */
 103 #define IUC_NO_WINDOW   0x02    /* Device doesn't behave with big Rx window */
 104 #define IUC_NO_TURN     0x04    /* Device doesn't do turnaround by itself */
 105 /* Not currently used */
 106 #define IUC_SIR_ONLY    0x08    /* Device doesn't behave at FIR speeds */
 107 #define IUC_SMALL_PKT   0x10    /* Device doesn't behave with big Rx packets */
 108 #define IUC_MAX_WINDOW  0x20    /* Device underestimate the Rx window */
 109 #define IUC_MAX_XBOFS   0x40    /* Device need more xbofs than advertised */
 110 #define IUC_STIR_4210   0x80    /* SigmaTel 4210/4220/4116 VFIR */
 111
 112 /* USB class definitions */
 113 #define USB_IRDA_HEADER            0x01
 114 #define USB_CLASS_IRDA             0x02 /* USB_CLASS_APP_SPEC subclass */
 115 #define USB_DT_IRDA                0x21
 116 #define USB_IRDA_SIGMATEL_HEADER   0x03
 117 #define IU_SIGMATEL_MAX_RX_URBS    (IU_MAX_ACTIVE_RX_URBS + USB_IRDA_SIGMATEL_HEADER)
 118
 119 struct irda_class_desc {
 120         __u8  bLength;
 121         __u8  bDescriptorType;
 122         __u16 bcdSpecRevision;
 123         __u8  bmDataSize;
 124         __u8  bmWindowSize;
 125         __u8  bmMinTurnaroundTime;
 126         __u16 wBaudRate;
 127         __u8  bmAdditionalBOFs;
 128         __u8  bIrdaRateSniff;
 129         __u8  bMaxUnicastList;
 130 } __attribute__ ((packed));
 131
 132 /* class specific interface request to get the IrDA-USB class descriptor
 133  * (6.2.5, USB-IrDA class spec 1.0) */
 134
 135 #define IU_REQ_GET_CLASS_DESC   0x06
 136 #define STIR421X_MAX_PATCH_DOWNLOAD_SIZE 1023
 137
 138 struct irda_usb_cb {
 139         struct irda_class_desc *irda_desc;
 140         struct usb_device *usbdev;      /* init: probe_irda */
 141         struct usb_interface *usbintf;  /* init: probe_irda */
 142         int netopen;                    /* Device is active for network */
 143         int present;                    /* Device is present on the bus */
 144         __u32 capability;               /* Capability of the hardware */
 145         __u8  bulk_in_ep;               /* Rx Endpoint assignments */
 146         __u8  bulk_out_ep;              /* Tx Endpoint assignments */
 147         __u16 bulk_out_mtu;             /* Max Tx packet size in bytes */
 148         __u8  bulk_int_ep;              /* Interrupt Endpoint assignments */
 149
 150         __u8  max_rx_urb;
 151         struct urb **rx_urb;            /* URBs used to receive data frames */
 152         struct urb *idle_rx_urb;        /* Pointer to idle URB in Rx path */
 153         struct urb *tx_urb;             /* URB used to send data frames */
 154         struct urb *speed_urb;          /* URB used to send speed commands */
 155
 156         struct net_device *netdev;      /* Yes! we are some kind of netdev. */
 157         struct net_device_stats stats;
 158         struct irlap_cb   *irlap;       /* The link layer we are binded to */
 159         struct qos_info qos;
 160         char *speed_buff;               /* Buffer for speed changes */
 161
 162         struct timeval stamp;
 163         struct timeval now;
 164
 165         spinlock_t lock;                /* For serializing Tx operations */
 166
 167         __u16 xbofs;                    /* Current xbofs setting */
 168         __s16 new_xbofs;                /* xbofs we need to set */
 169         __u32 speed;                    /* Current speed */
 170         __s32 new_speed;                /* speed we need to set */
 171
 172         __u8 header_length;             /* USB-IrDA frame header size */
 173         int needspatch;                 /* device needs firmware patch */
 174
 175         struct timer_list rx_defer_timer;       /* Wait for Rx error to clear */
 176 };
 177