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