LXR linux/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 */
  26struct 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
  37        /* i/o info: pipes etc */
  38        unsigned                in, out;
  39        struct usb_host_endpoint *status;
  40        unsigned                maxpacket;
  41        struct timer_list       delay;
  42
  43        /* protocol/interface state */
  44        struct net_device       *net;
  45        int                     msg_enable;
  46        unsigned long           data[5];
  47        u32                     xid;
  48        u32                     hard_mtu;       /* count any extra framing */
  49        size_t                  rx_urb_size;    /* size for rx urbs */
  50        struct mii_if_info      mii;
  51
  52        /* various kinds of pending driver work */
  53        struct sk_buff_head     rxq;
  54        struct sk_buff_head     txq;
  55        struct sk_buff_head     done;
  56        struct sk_buff_head     rxq_pause;
  57        struct urb              *interrupt;
  58        struct usb_anchor       deferred;
  59        struct tasklet_struct   bh;
  60
  61        struct work_struct      kevent;
  62        unsigned long           flags;
  63#               define EVENT_TX_HALT    0
  64#               define EVENT_RX_HALT    1
  65#               define EVENT_RX_MEMORY  2
  66#               define EVENT_STS_SPLIT  3
  67#               define EVENT_LINK_RESET 4
  68#               define EVENT_RX_PAUSED  5
  69#               define EVENT_DEV_WAKING 6
  70#               define EVENT_DEV_ASLEEP 7
  71};
  72
  73static inline struct usb_driver *driver_of(struct usb_interface *intf)
  74{
  75        return to_usb_driver(intf->dev.driver);
  76}
  77
  78/* interface from the device/framing level "minidriver" to core */
  79struct driver_info {
  80        char            *description;
  81
  82        int             flags;
  83/* framing is CDC Ethernet, not writing ZLPs (hw issues), or optionally: */
  84#define FLAG_FRAMING_NC 0x0001          /* guard against device dropouts */
  85#define FLAG_FRAMING_GL 0x0002          /* genelink batches packets */
  86#define FLAG_FRAMING_Z  0x0004          /* zaurus adds a trailer */
  87#define FLAG_FRAMING_RN 0x0008          /* RNDIS batches, plus huge header */
  88
  89#define FLAG_NO_SETINT  0x0010          /* device can't set_interface() */
  90#define FLAG_ETHER      0x0020          /* maybe use "eth%d" names */
  91
  92#define FLAG_FRAMING_AX 0x0040          /* AX88772/178 packets */
  93#define FLAG_WLAN       0x0080          /* use "wlan%d" names */
  94#define FLAG_AVOID_UNLINK_URBS 0x0100   /* don't unlink urbs at usbnet_stop() */
  95#define FLAG_SEND_ZLP   0x0200          /* hw requires ZLPs are sent */
  96#define FLAG_WWAN       0x0400          /* use "wwan%d" names */
  97
  98#define FLAG_LINK_INTR  0x0800          /* updates link (carrier) status */
  99
 100/*
 101 * Indicates to usbnet, that USB driver accumulates multiple IP packets.
 102 * Affects statistic (counters) and short packet handling.
 103 */
 104#define FLAG_MULTI_PACKET       0x1000
 105
 106        /* init device ... can sleep, or cause probe() failure */
 107        int     (*bind)(struct usbnet *, struct usb_interface *);
 108
 109        /* cleanup device ... can sleep, but can't fail */
 110        void    (*unbind)(struct usbnet *, struct usb_interface *);
 111
 112        /* reset device ... can sleep */
 113        int     (*reset)(struct usbnet *);
 114
 115        /* stop device ... can sleep */
 116        int     (*stop)(struct usbnet *);
 117
 118        /* see if peer is connected ... can sleep */
 119        int     (*check_connect)(struct usbnet *);
 120
 121        /* (dis)activate runtime power management */
 122        int     (*manage_power)(struct usbnet *, int);
 123
 124        /* for status polling */
 125        void    (*status)(struct usbnet *, struct urb *);
 126
 127        /* link reset handling, called from defer_kevent */
 128        int     (*link_reset)(struct usbnet *);
 129
 130        /* fixup rx packet (strip framing) */
 131        int     (*rx_fixup)(struct usbnet *dev, struct sk_buff *skb);
 132
 133        /* fixup tx packet (add framing) */
 134        struct sk_buff  *(*tx_fixup)(struct usbnet *dev,
 135                                struct sk_buff *skb, gfp_t flags);
 136
 137        /* early initialization code, can sleep. This is for minidrivers
 138         * having 'subminidrivers' that need to do extra initialization
 139         * right after minidriver have initialized hardware. */
 140        int     (*early_init)(struct usbnet *dev);
 141
 142        /* called by minidriver when receiving indication */
 143        void    (*indication)(struct usbnet *dev, void *ind, int indlen);
 144
 145        /* for new devices, use the descriptor-reading code instead */
 146        int             in;             /* rx endpoint */
 147        int             out;            /* tx endpoint */
 148
 149        unsigned long   data;           /* Misc driver specific data */
 150};
 151
 152/* Minidrivers are just drivers using the "usbnet" core as a powerful
 153 * network-specific subroutine library ... that happens to do pretty
 154 * much everything except custom framing and chip-specific stuff.
 155 */
 156extern int usbnet_probe(struct usb_interface *, const struct usb_device_id *);
 157extern int usbnet_suspend(struct usb_interface *, pm_message_t);
 158extern int usbnet_resume(struct usb_interface *);
 159extern void usbnet_disconnect(struct usb_interface *);
 160
 161
 162/* Drivers that reuse some of the standard USB CDC infrastructure
 163 * (notably, using multiple interfaces according to the CDC
 164 * union descriptor) get some helper code.
 165 */
 166struct cdc_state {
 167        struct usb_cdc_header_desc      *header;
 168        struct usb_cdc_union_desc       *u;
 169        struct usb_cdc_ether_desc       *ether;
 170        struct usb_interface            *control;
 171        struct usb_interface            *data;
 172};
 173
 174extern int usbnet_generic_cdc_bind(struct usbnet *, struct usb_interface *);
 175extern void usbnet_cdc_unbind(struct usbnet *, struct usb_interface *);
 176
 177/* CDC and RNDIS support the same host-chosen packet filters for IN transfers */
 178#define DEFAULT_FILTER  (USB_CDC_PACKET_TYPE_BROADCAST \
 179                        |USB_CDC_PACKET_TYPE_ALL_MULTICAST \
 180                        |USB_CDC_PACKET_TYPE_PROMISCUOUS \
 181                        |USB_CDC_PACKET_TYPE_DIRECTED)
 182
 183
 184/* we record the state for each of our queued skbs */
 185enum skb_state {
 186        illegal = 0,
 187        tx_start, tx_done,
 188        rx_start, rx_done, rx_cleanup
 189};
 190
 191struct skb_data {       /* skb->cb is one of these */
 192        struct urb              *urb;
 193        struct usbnet           *dev;
 194        enum skb_state          state;
 195        size_t                  length;
 196};
 197
 198extern int usbnet_open(struct net_device *net);
 199extern int usbnet_stop(struct net_device *net);
 200extern netdev_tx_t usbnet_start_xmit(struct sk_buff *skb,
 201                                     struct net_device *net);
 202extern void usbnet_tx_timeout(struct net_device *net);
 203extern int usbnet_change_mtu(struct net_device *net, int new_mtu);
 204
 205extern int usbnet_get_endpoints(struct usbnet *, struct usb_interface *);
 206extern int usbnet_get_ethernet_addr(struct usbnet *, int);
 207extern void usbnet_defer_kevent(struct usbnet *, int);
 208extern void usbnet_skb_return(struct usbnet *, struct sk_buff *);
 209extern void usbnet_unlink_rx_urbs(struct usbnet *);
 210
 211extern void usbnet_pause_rx(struct usbnet *);
 212extern void usbnet_resume_rx(struct usbnet *);
 213extern void usbnet_purge_paused_rxq(struct usbnet *);
 214
 215extern int usbnet_get_settings(struct net_device *net,
 216                               struct ethtool_cmd *cmd);
 217extern int usbnet_set_settings(struct net_device *net,
 218                               struct ethtool_cmd *cmd);
 219extern u32 usbnet_get_link(struct net_device *net);
 220extern u32 usbnet_get_msglevel(struct net_device *);
 221extern void usbnet_set_msglevel(struct net_device *, u32);
 222extern void usbnet_get_drvinfo(struct net_device *, struct ethtool_drvinfo *);
 223extern int usbnet_nway_reset(struct net_device *net);
 224
 225#endif /* __LINUX_USB_USBNET_H */
 226