include/linux/usb/usbnet.h

   1 /*
   2  * USB Networking Link Interface
   3  *
   4  * Copyright (C) 2000-2005 by David Brownell <dbrownell@users.sourceforge.net>
   5  * Copyright (C) 2003-2005 David Hollis <dhollis@davehollis.com>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20  */
  21
  22 #ifndef __LINUX_USB_USBNET_H
  23 #define __LINUX_USB_USBNET_H
  24
  25 /* interface from usbnet core to each USB networking link we handle */
  26 struct usbnet {
  27         /* housekeeping */
  28         struct usb_device       *udev;
  29         struct usb_interface    *intf;
  30         struct driver_info      *driver_info;
  31         const char              *driver_name;
  32         void                    *driver_priv;
  33         wait_queue_head_t       wait;
  34         struct mutex            phy_mutex;
  35         unsigned char           suspend_count;
  36         unsigned char           pkt_cnt, pkt_err;
  37         unsigned short          rx_qlen, tx_qlen;
  38         unsigned                can_dma_sg:1;
  39
  40         /* i/o info: pipes etc */
  41         unsigned                in, out;
  42         struct usb_host_endpoint *status;
  43         unsigned                maxpacket;
  44         struct timer_list       delay;
  45         const char              *padding_pkt;
  46
  47         /* protocol/interface state */
  48         struct net_device       *net;
  49         int                     msg_enable;
  50         unsigned long           data[5];
  51         u32                     xid;
  52         u32                     hard_mtu;       /* count any extra framing */
  53         size_t                  rx_urb_size;    /* size for rx urbs */
  54         struct mii_if_info      mii;
  55
  56         /* various kinds of pending driver work */
  57         struct sk_buff_head     rxq;
  58         struct sk_buff_head     txq;
  59         struct sk_buff_head     done;
  60         struct sk_buff_head     rxq_pause;
  61         struct urb              *interrupt;
  62         unsigned                interrupt_count;
  63         struct mutex            interrupt_mutex;
  64         struct usb_anchor       deferred;
  65         struct tasklet_struct   bh;
  66
  67         struct work_struct      kevent;
  68         unsigned long           flags;
  69 #               define EVENT_TX_HALT    0
  70 #               define EVENT_RX_HALT    1
  71 #               define EVENT_RX_MEMORY  2
  72 #               define EVENT_STS_SPLIT  3
  73 #               define EVENT_LINK_RESET 4
  74 #               define EVENT_RX_PAUSED  5
  75 #               define EVENT_DEV_ASLEEP 6
  76 #               define EVENT_DEV_OPEN   7
  77 #               define EVENT_DEVICE_REPORT_IDLE 8
  78 #               define EVENT_NO_RUNTIME_PM      9
  79 #               define EVENT_RX_KILL    10
  80 #               define EVENT_LINK_CHANGE        11
  81 #               define EVENT_SET_RX_MODE        12
  82 };
  83
  84 static inline struct usb_driver *driver_of(struct usb_interface *intf)
  85 {
  86         return to_usb_driver(intf->dev.driver);
  87 }
  88
  89 /* interface from the device/framing level "minidriver" to core */
  90 struct driver_info {
  91         char            *description;
  92
  93         int             flags;
  94 /* framing is CDC Ethernet, not writing ZLPs (hw issues), or optionally: */
  95 #define FLAG_FRAMING_NC 0x0001          /* guard against device dropouts */
  96 #define FLAG_FRAMING_GL 0x0002          /* genelink batches packets */
  97 #define FLAG_FRAMING_Z  0x0004          /* zaurus adds a trailer */
  98 #define FLAG_FRAMING_RN 0x0008          /* RNDIS batches, plus huge header */
  99
 100 #define FLAG_NO_SETINT  0x0010          /* device can't set_interface() */
 101 #define FLAG_ETHER      0x0020          /* maybe use "eth%d" names */
 102
 103 #define FLAG_FRAMING_AX 0x0040          /* AX88772/178 packets */
 104 #define FLAG_WLAN       0x0080          /* use "wlan%d" names */
 105 #define FLAG_AVOID_UNLINK_URBS 0x0100   /* don't unlink urbs at usbnet_stop() */
 106 #define FLAG_SEND_ZLP   0x0200          /* hw requires ZLPs are sent */
 107 #define FLAG_WWAN       0x0400          /* use "wwan%d" names */
 108
 109 #define FLAG_LINK_INTR  0x0800          /* updates link (carrier) status */
 110
 111 #define FLAG_POINTTOPOINT 0x1000        /* possibly use "usb%d" names */
 112
 113 /*
 114  * Indicates to usbnet, that USB driver accumulates multiple IP packets.
 115  * Affects statistic (counters) and short packet handling.
 116  */
 117 #define FLAG_MULTI_PACKET       0x2000
 118 #define FLAG_RX_ASSEMBLE        0x4000  /* rx packets may span >1 frames */
 119 #define FLAG_NOARP              0x8000  /* device can't do ARP */
 120
 121         /* init device ... can sleep, or cause probe() failure */
 122         int     (*bind)(struct usbnet *, struct usb_interface *);
 123
 124         /* cleanup device ... can sleep, but can't fail */
 125         void    (*unbind)(struct usbnet *, struct usb_interface *);
 126
 127         /* reset device ... can sleep */
 128         int     (*reset)(struct usbnet *);
 129
 130         /* stop device ... can sleep */
 131         int     (*stop)(struct usbnet *);
 132
 133         /* see if peer is connected ... can sleep */
 134         int     (*check_connect)(struct usbnet *);
 135
 136         /* (dis)activate runtime power management */
 137         int     (*manage_power)(struct usbnet *, int);
 138
 139         /* for status polling */
 140         void    (*status)(struct usbnet *, struct urb *);
 141
 142         /* link reset handling, called from defer_kevent */
 143         int     (*link_reset)(struct usbnet *);
 144
 145         /* fixup rx packet (strip framing) */
 146         int     (*rx_fixup)(struct usbnet *dev, struct sk_buff *skb);
 147
 148         /* fixup tx packet (add framing) */
 149         struct sk_buff  *(*tx_fixup)(struct usbnet *dev,
 150                                 struct sk_buff *skb, gfp_t flags);
 151
 152         /* recover from timeout */
 153         void    (*recover)(struct usbnet *dev);
 154
 155         /* early initialization code, can sleep. This is for minidrivers
 156          * having 'subminidrivers' that need to do extra initialization
 157          * right after minidriver have initialized hardware. */
 158         int     (*early_init)(struct usbnet *dev);
 159
 160         /* called by minidriver when receiving indication */
 161         void    (*indication)(struct usbnet *dev, void *ind, int indlen);
 162
 163         /* rx mode change (device changes address list filtering) */
 164         void    (*set_rx_mode)(struct usbnet *dev);
 165
 166         /* for new devices, use the descriptor-reading code instead */
 167         int             in;             /* rx endpoint */
 168         int             out;            /* tx endpoint */
 169
 170         unsigned long   data;           /* Misc driver specific data */
 171 };
 172
 173 /* Minidrivers are just drivers using the "usbnet" core as a powerful
 174  * network-specific subroutine library ... that happens to do pretty
 175  * much everything except custom framing and chip-specific stuff.
 176  */
 177 extern int usbnet_probe(struct usb_interface *, const struct usb_device_id *);
 178 extern int usbnet_suspend(struct usb_interface *, pm_message_t);
 179 extern int usbnet_resume(struct usb_interface *);
 180 extern void usbnet_disconnect(struct usb_interface *);
 181 extern void usbnet_device_suggests_idle(struct usbnet *dev);
 182
 183 extern int usbnet_read_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
 184                     u16 value, u16 index, void *data, u16 size);
 185 extern int usbnet_write_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
 186                     u16 value, u16 index, const void *data, u16 size);
 187 extern int usbnet_read_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype,
 188                     u16 value, u16 index, void *data, u16 size);
 189 extern int usbnet_write_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype,
 190                     u16 value, u16 index, const void *data, u16 size);
 191 extern int usbnet_write_cmd_async(struct usbnet *dev, u8 cmd, u8 reqtype,
 192                     u16 value, u16 index, const void *data, u16 size);
 193
 194 /* Drivers that reuse some of the standard USB CDC infrastructure
 195  * (notably, using multiple interfaces according to the CDC
 196  * union descriptor) get some helper code.
 197  */
 198 struct cdc_state {
 199         struct usb_cdc_header_desc      *header;
 200         struct usb_cdc_union_desc       *u;
 201         struct usb_cdc_ether_desc       *ether;
 202         struct usb_interface            *control;
 203         struct usb_interface            *data;
 204 };
 205
 206 extern int usbnet_generic_cdc_bind(struct usbnet *, struct usb_interface *);
 207 extern int usbnet_cdc_bind(struct usbnet *, struct usb_interface *);
 208 extern void usbnet_cdc_unbind(struct usbnet *, struct usb_interface *);
 209 extern void usbnet_cdc_status(struct usbnet *, struct urb *);
 210
 211 /* CDC and RNDIS support the same host-chosen packet filters for IN transfers */
 212 #define DEFAULT_FILTER  (USB_CDC_PACKET_TYPE_BROADCAST \
 213                         |USB_CDC_PACKET_TYPE_ALL_MULTICAST \
 214                         |USB_CDC_PACKET_TYPE_PROMISCUOUS \
 215                         |USB_CDC_PACKET_TYPE_DIRECTED)
 216
 217
 218 /* we record the state for each of our queued skbs */
 219 enum skb_state {
 220         illegal = 0,
 221         tx_start, tx_done,
 222         rx_start, rx_done, rx_cleanup,
 223         unlink_start
 224 };
 225
 226 struct skb_data {       /* skb->cb is one of these */
 227         struct urb              *urb;
 228         struct usbnet           *dev;
 229         enum skb_state          state;
 230         long                    length;
 231         unsigned long           packets;
 232 };
 233
 234 /* Drivers that set FLAG_MULTI_PACKET must call this in their
 235  * tx_fixup method before returning an skb.
 236  */
 237 static inline void
 238 usbnet_set_skb_tx_stats(struct sk_buff *skb,
 239                         unsigned long packets, long bytes_delta)
 240 {
 241         struct skb_data *entry = (struct skb_data *) skb->cb;
 242
 243         entry->packets = packets;
 244         entry->length = bytes_delta;
 245 }
 246
 247 extern int usbnet_open(struct net_device *net);
 248 extern int usbnet_stop(struct net_device *net);
 249 extern netdev_tx_t usbnet_start_xmit(struct sk_buff *skb,
 250                                      struct net_device *net);
 251 extern void usbnet_tx_timeout(struct net_device *net);
 252 extern int usbnet_change_mtu(struct net_device *net, int new_mtu);
 253
 254 extern int usbnet_get_endpoints(struct usbnet *, struct usb_interface *);
 255 extern int usbnet_get_ethernet_addr(struct usbnet *, int);
 256 extern void usbnet_defer_kevent(struct usbnet *, int);
 257 extern void usbnet_skb_return(struct usbnet *, struct sk_buff *);
 258 extern void usbnet_unlink_rx_urbs(struct usbnet *);
 259
 260 extern void usbnet_pause_rx(struct usbnet *);
 261 extern void usbnet_resume_rx(struct usbnet *);
 262 extern void usbnet_purge_paused_rxq(struct usbnet *);
 263
 264 extern int usbnet_get_settings(struct net_device *net,
 265                                struct ethtool_cmd *cmd);
 266 extern int usbnet_set_settings(struct net_device *net,
 267                                struct ethtool_cmd *cmd);
 268 extern u32 usbnet_get_link(struct net_device *net);
 269 extern u32 usbnet_get_msglevel(struct net_device *);
 270 extern void usbnet_set_msglevel(struct net_device *, u32);
 271 extern void usbnet_get_drvinfo(struct net_device *, struct ethtool_drvinfo *);
 272 extern int usbnet_nway_reset(struct net_device *net);
 273
 274 extern int usbnet_manage_power(struct usbnet *, int);
 275 extern void usbnet_link_change(struct usbnet *, bool, bool);
 276
 277 extern int usbnet_status_start(struct usbnet *dev, gfp_t mem_flags);
 278 extern void usbnet_status_stop(struct usbnet *dev);
 279
 280 extern void usbnet_update_max_qlen(struct usbnet *dev);
 281
 282 #endif /* __LINUX_USB_USBNET_H */