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