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