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         struct mii_if_info      mii;
  48
  49         /* various kinds of pending driver work */
  50         struct sk_buff_head     rxq;
  51         struct sk_buff_head     txq;
  52         struct sk_buff_head     done;
  53         struct urb              *interrupt;
  54         struct tasklet_struct   bh;
  55
  56         struct work_struct      kevent;
  57         unsigned long           flags;
  58 #               define EVENT_TX_HALT    0
  59 #               define EVENT_RX_HALT    1
  60 #               define EVENT_RX_MEMORY  2
  61 #               define EVENT_STS_SPLIT  3
  62 #               define EVENT_LINK_RESET 4
  63 };
  64
  65 static inline struct usb_driver *driver_of(struct usb_interface *intf)
  66 {
  67         return to_usb_driver(intf->dev.driver);
  68 }
  69
  70 /* interface from the device/framing level "minidriver" to core */
  71 struct driver_info {
  72         char            *description;
  73
  74         int             flags;
  75 /* framing is CDC Ethernet, not writing ZLPs (hw issues), or optionally: */
  76 #define FLAG_FRAMING_NC 0x0001          /* guard against device dropouts */
  77 #define FLAG_FRAMING_GL 0x0002          /* genelink batches packets */
  78 #define FLAG_FRAMING_Z  0x0004          /* zaurus adds a trailer */
  79 #define FLAG_FRAMING_RN 0x0008          /* RNDIS batches, plus huge header */
  80
  81 #define FLAG_NO_SETINT  0x0010          /* device can't set_interface() */
  82 #define FLAG_ETHER      0x0020          /* maybe use "eth%d" names */
  83
  84 #define FLAG_FRAMING_AX 0x0040          /* AX88772/178 packets */
  85
  86         /* init device ... can sleep, or cause probe() failure */
  87         int     (*bind)(struct usbnet *, struct usb_interface *);
  88
  89         /* cleanup device ... can sleep, but can't fail */
  90         void    (*unbind)(struct usbnet *, struct usb_interface *);
  91
  92         /* reset device ... can sleep */
  93         int     (*reset)(struct usbnet *);
  94
  95         /* see if peer is connected ... can sleep */
  96         int     (*check_connect)(struct usbnet *);
  97
  98         /* for status polling */
  99         void    (*status)(struct usbnet *, struct urb *);
 100
 101         /* link reset handling, called from defer_kevent */
 102         int     (*link_reset)(struct usbnet *);
 103
 104         /* fixup rx packet (strip framing) */
 105         int     (*rx_fixup)(struct usbnet *dev, struct sk_buff *skb);
 106
 107         /* fixup tx packet (add framing) */
 108         struct sk_buff  *(*tx_fixup)(struct usbnet *dev,
 109                                 struct sk_buff *skb, unsigned flags);
 110
 111         /* for new devices, use the descriptor-reading code instead */
 112         int             in;             /* rx endpoint */
 113         int             out;            /* tx endpoint */
 114
 115         unsigned long   data;           /* Misc driver specific data */
 116 };
 117
 118 /* Minidrivers are just drivers using the "usbnet" core as a powerful
 119  * network-specific subroutine library ... that happens to do pretty
 120  * much everything except custom framing and chip-specific stuff.
 121  */
 122 extern int usbnet_probe(struct usb_interface *, const struct usb_device_id *);
 123 extern int usbnet_suspend (struct usb_interface *, pm_message_t );
 124 extern int usbnet_resume (struct usb_interface *);
 125 extern void usbnet_disconnect(struct usb_interface *);
 126
 127
 128 /* we record the state for each of our queued skbs */
 129 enum skb_state {
 130         illegal = 0,
 131         tx_start, tx_done,
 132         rx_start, rx_done, rx_cleanup
 133 };
 134
 135 struct skb_data {       /* skb->cb is one of these */
 136         struct urb              *urb;
 137         struct usbnet           *dev;
 138         enum skb_state          state;
 139         size_t                  length;
 140 };
 141
 142
 143
 144 /* messaging support includes the interface name, so it must not be
 145  * used before it has one ... notably, in minidriver bind() calls.
 146  */
 147 #ifdef DEBUG
 148 #define devdbg(usbnet, fmt, arg...) \
 149         printk(KERN_DEBUG "%s: " fmt "\n" , (usbnet)->net->name , ## arg)
 150 #else
 151 #define devdbg(usbnet, fmt, arg...) do {} while(0)
 152 #endif
 153
 154 #define deverr(usbnet, fmt, arg...) \
 155         printk(KERN_ERR "%s: " fmt "\n" , (usbnet)->net->name , ## arg)
 156 #define devwarn(usbnet, fmt, arg...) \
 157         printk(KERN_WARNING "%s: " fmt "\n" , (usbnet)->net->name , ## arg)
 158
 159 #define devinfo(usbnet, fmt, arg...) \
 160         printk(KERN_INFO "%s: " fmt "\n" , (usbnet)->net->name , ## arg); \
 161
 162
 163 #endif  /* __USBNET_H */