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