drivers/usb/net/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
  23 #ifndef __USBNET_H
  24 #define __USBNET_H
  25
  26
  27 /* interface from usbnet core to each USB networking link we handle */
  28 struct usbnet {
  29         /* housekeeping */
  30         struct usb_device       *udev;
  31         struct driver_info      *driver_info;
  32         wait_queue_head_t       *wait;
  33
  34         /* i/o info: pipes etc */
  35         unsigned                in, out;
  36         struct usb_host_endpoint *status;
  37         unsigned                maxpacket;
  38         struct timer_list       delay;
  39
  40         /* protocol/interface state */
  41         struct net_device       *net;
  42         struct net_device_stats stats;
  43         int                     msg_enable;
  44         unsigned long           data [5];
  45         u32                     xid;
  46         u32                     hard_mtu;       /* count any extra framing */
  47         size_t                  rx_urb_size;    /* size for rx urbs  */
  48         struct mii_if_info      mii;
  49
  50         /* various kinds of pending driver work */
  51         struct sk_buff_head     rxq;
  52         struct sk_buff_head     txq;
  53         struct sk_buff_head     done;
  54         struct urb              *interrupt;
  55         struct tasklet_struct   bh;
  56
  57         struct work_struct      kevent;
  58         unsigned long           flags;
  59 #               define EVENT_TX_HALT    0
  60 #               define EVENT_RX_HALT    1
  61 #               define EVENT_RX_MEMORY  2
  62 #               define EVENT_STS_SPLIT  3
  63 #               define EVENT_LINK_RESET 4
  64 };
  65
  66 static inline struct usb_driver *driver_of(struct usb_interface *intf)
  67 {
  68         return to_usb_driver(intf->dev.driver);
  69 }
  70
  71 /* interface from the device/framing level "minidriver" to core */
  72 struct driver_info {
  73         char            *description;
  74
  75         int             flags;
  76 /* framing is CDC Ethernet, not writing ZLPs (hw issues), or optionally: */
  77 #define FLAG_FRAMING_NC 0x0001          /* guard against device dropouts */
  78 #define FLAG_FRAMING_GL 0x0002          /* genelink batches packets */
  79 #define FLAG_FRAMING_Z  0x0004          /* zaurus adds a trailer */
  80 #define FLAG_FRAMING_RN 0x0008          /* RNDIS batches, plus huge header */
  81
  82 #define FLAG_NO_SETINT  0x0010          /* device can't set_interface() */
  83 #define FLAG_ETHER      0x0020          /* maybe use "eth%d" names */
  84
  85 #define FLAG_FRAMING_AX 0x0040          /* AX88772/178 packets */
  86
  87         /* init device ... can sleep, or cause probe() failure */
  88         int     (*bind)(struct usbnet *, struct usb_interface *);
  89
  90         /* cleanup device ... can sleep, but can't fail */
  91         void    (*unbind)(struct usbnet *, struct usb_interface *);
  92
  93         /* reset device ... can sleep */
  94         int     (*reset)(struct usbnet *);
  95
  96         /* see if peer is connected ... can sleep */
  97         int     (*check_connect)(struct usbnet *);
  98
  99         /* for status polling */
 100         void    (*status)(struct usbnet *, struct urb *);
 101
 102         /* link reset handling, called from defer_kevent */
 103         int     (*link_reset)(struct usbnet *);
 104
 105         /* fixup rx packet (strip framing) */
 106         int     (*rx_fixup)(struct usbnet *dev, struct sk_buff *skb);
 107
 108         /* fixup tx packet (add framing) */
 109         struct sk_buff  *(*tx_fixup)(struct usbnet *dev,
 110                                 struct sk_buff *skb, gfp_t flags);
 111
 112         /* for new devices, use the descriptor-reading code instead */
 113         int             in;             /* rx endpoint */
 114         int             out;            /* tx endpoint */
 115
 116         unsigned long   data;           /* Misc driver specific data */
 117 };
 118
 119 /* Minidrivers are just drivers using the "usbnet" core as a powerful
 120  * network-specific subroutine library ... that happens to do pretty
 121  * much everything except custom framing and chip-specific stuff.
 122  */
 123 extern int usbnet_probe(struct usb_interface *, const struct usb_device_id *);
 124 extern int usbnet_suspend (struct usb_interface *, pm_message_t );
 125 extern int usbnet_resume (struct usb_interface *);
 126 extern void usbnet_disconnect(struct usb_interface *);
 127
 128
 129 /* Drivers that reuse some of the standard USB CDC infrastructure
 130  * (notably, using multiple interfaces according to the the CDC
 131  * union descriptor) get some helper code.
 132  */
 133 struct cdc_state {
 134         struct usb_cdc_header_desc      *header;
 135         struct usb_cdc_union_desc       *u;
 136         struct usb_cdc_ether_desc       *ether;
 137         struct usb_interface            *control;
 138         struct usb_interface            *data;
 139 };
 140
 141 extern int usbnet_generic_cdc_bind (struct usbnet *, struct usb_interface *);
 142 extern void usbnet_cdc_unbind (struct usbnet *, struct usb_interface *);
 143
 144 /* CDC and RNDIS support the same host-chosen packet filters for IN transfers */
 145 #define DEFAULT_FILTER  (USB_CDC_PACKET_TYPE_BROADCAST \
 146                         |USB_CDC_PACKET_TYPE_ALL_MULTICAST \
 147                         |USB_CDC_PACKET_TYPE_PROMISCUOUS \
 148                         |USB_CDC_PACKET_TYPE_DIRECTED)
 149
 150
 151 /* we record the state for each of our queued skbs */
 152 enum skb_state {
 153         illegal = 0,
 154         tx_start, tx_done,
 155         rx_start, rx_done, rx_cleanup
 156 };
 157
 158 struct skb_data {       /* skb->cb is one of these */
 159         struct urb              *urb;
 160         struct usbnet           *dev;
 161         enum skb_state          state;
 162         size_t                  length;
 163 };
 164
 165
 166 extern int usbnet_get_endpoints(struct usbnet *, struct usb_interface *);
 167 extern void usbnet_defer_kevent (struct usbnet *, int);
 168 extern void usbnet_skb_return (struct usbnet *, struct sk_buff *);
 169
 170 extern u32 usbnet_get_msglevel (struct net_device *);
 171 extern void usbnet_set_msglevel (struct net_device *, u32);
 172 extern void usbnet_get_drvinfo (struct net_device *, struct ethtool_drvinfo *);
 173
 174 /* messaging support includes the interface name, so it must not be
 175  * used before it has one ... notably, in minidriver bind() calls.
 176  */
 177 #ifdef DEBUG
 178 #define devdbg(usbnet, fmt, arg...) \
 179         printk(KERN_DEBUG "%s: " fmt "\n" , (usbnet)->net->name , ## arg)
 180 #else
 181 #define devdbg(usbnet, fmt, arg...) do {} while(0)
 182 #endif
 183
 184 #define deverr(usbnet, fmt, arg...) \
 185         printk(KERN_ERR "%s: " fmt "\n" , (usbnet)->net->name , ## arg)
 186 #define devwarn(usbnet, fmt, arg...) \
 187         printk(KERN_WARNING "%s: " fmt "\n" , (usbnet)->net->name , ## arg)
 188
 189 #define devinfo(usbnet, fmt, arg...) \
 190         printk(KERN_INFO "%s: " fmt "\n" , (usbnet)->net->name , ## arg); \
 191
 192
 193 #endif  /* __USBNET_H */