usbnet.h (10469B)
1// SPDX-License-Identifier: GPL-2.0+ 2/* 3 * USB Networking Link Interface 4 * 5 * Copyright (C) 2000-2005 by David Brownell <dbrownell@users.sourceforge.net> 6 * Copyright (C) 2003-2005 David Hollis <dhollis@davehollis.com> 7 * 8 * This program is free software; you can redistribute it and/or modify 9 * it under the terms of the GNU General Public License as published by 10 * the Free Software Foundation; either version 2 of the License, or 11 * (at your option) any later version. 12 * 13 * This program is distributed in the hope that it will be useful, 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 * GNU General Public License for more details. 17 * 18 * You should have received a copy of the GNU General Public License 19 * along with this program; if not, write to the Free Software 20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 21 */ 22 23#ifndef __LINUX_USB_USBNET_H 24#define __LINUX_USB_USBNET_H 25 26/* interface from usbnet core to each USB networking link we handle */ 27struct usbnet { 28 /* housekeeping */ 29 struct usb_device *udev; 30 struct usb_interface *intf; 31 const struct driver_info *driver_info; 32 const char *driver_name; 33 void *driver_priv; 34 wait_queue_head_t wait; 35 struct mutex phy_mutex; 36 unsigned char suspend_count; 37 unsigned char pkt_cnt, pkt_err; 38 unsigned short rx_qlen, tx_qlen; 39 unsigned can_dma_sg:1; 40 41 /* i/o info: pipes etc */ 42 unsigned in, out; 43 struct usb_host_endpoint *status; 44 unsigned maxpacket; 45 struct timer_list delay; 46 const char *padding_pkt; 47 48 /* protocol/interface state */ 49 struct net_device *net; 50 int msg_enable; 51 unsigned long data[5]; 52 u32 xid; 53 u32 hard_mtu; /* count any extra framing */ 54 size_t rx_urb_size; /* size for rx urbs */ 55 struct mii_if_info mii; 56 long rx_speed; /* If MII not used */ 57 long tx_speed; /* If MII not used */ 58# define SPEED_UNSET -1 59 60 /* various kinds of pending driver work */ 61 struct sk_buff_head rxq; 62 struct sk_buff_head txq; 63 struct sk_buff_head done; 64 struct sk_buff_head rxq_pause; 65 struct urb *interrupt; 66 unsigned interrupt_count; 67 struct mutex interrupt_mutex; 68 struct usb_anchor deferred; 69 struct tasklet_struct bh; 70 71 struct work_struct kevent; 72 unsigned long flags; 73# define EVENT_TX_HALT 0 74# define EVENT_RX_HALT 1 75# define EVENT_RX_MEMORY 2 76# define EVENT_STS_SPLIT 3 77# define EVENT_LINK_RESET 4 78# define EVENT_RX_PAUSED 5 79# define EVENT_DEV_ASLEEP 6 80# define EVENT_DEV_OPEN 7 81# define EVENT_DEVICE_REPORT_IDLE 8 82# define EVENT_NO_RUNTIME_PM 9 83# define EVENT_RX_KILL 10 84# define EVENT_LINK_CHANGE 11 85# define EVENT_SET_RX_MODE 12 86# define EVENT_NO_IP_ALIGN 13 87}; 88 89static inline struct usb_driver *driver_of(struct usb_interface *intf) 90{ 91 return to_usb_driver(intf->dev.driver); 92} 93 94/* interface from the device/framing level "minidriver" to core */ 95struct driver_info { 96 char *description; 97 98 int flags; 99/* framing is CDC Ethernet, not writing ZLPs (hw issues), or optionally: */ 100#define FLAG_FRAMING_NC 0x0001 /* guard against device dropouts */ 101#define FLAG_FRAMING_GL 0x0002 /* genelink batches packets */ 102#define FLAG_FRAMING_Z 0x0004 /* zaurus adds a trailer */ 103#define FLAG_FRAMING_RN 0x0008 /* RNDIS batches, plus huge header */ 104 105#define FLAG_NO_SETINT 0x0010 /* device can't set_interface() */ 106#define FLAG_ETHER 0x0020 /* maybe use "eth%d" names */ 107 108#define FLAG_FRAMING_AX 0x0040 /* AX88772/178 packets */ 109#define FLAG_WLAN 0x0080 /* use "wlan%d" names */ 110#define FLAG_AVOID_UNLINK_URBS 0x0100 /* don't unlink urbs at usbnet_stop() */ 111#define FLAG_SEND_ZLP 0x0200 /* hw requires ZLPs are sent */ 112#define FLAG_WWAN 0x0400 /* use "wwan%d" names */ 113 114#define FLAG_LINK_INTR 0x0800 /* updates link (carrier) status */ 115 116#define FLAG_POINTTOPOINT 0x1000 /* possibly use "usb%d" names */ 117 118/* 119 * Indicates to usbnet, that USB driver accumulates multiple IP packets. 120 * Affects statistic (counters) and short packet handling. 121 */ 122#define FLAG_MULTI_PACKET 0x2000 123#define FLAG_RX_ASSEMBLE 0x4000 /* rx packets may span >1 frames */ 124#define FLAG_NOARP 0x8000 /* device can't do ARP */ 125 126 /* init device ... can sleep, or cause probe() failure */ 127 int (*bind)(struct usbnet *, struct usb_interface *); 128 129 /* cleanup device ... can sleep, but can't fail */ 130 void (*unbind)(struct usbnet *, struct usb_interface *); 131 132 /* reset device ... can sleep */ 133 int (*reset)(struct usbnet *); 134 135 /* stop device ... can sleep */ 136 int (*stop)(struct usbnet *); 137 138 /* see if peer is connected ... can sleep */ 139 int (*check_connect)(struct usbnet *); 140 141 /* (dis)activate runtime power management */ 142 int (*manage_power)(struct usbnet *, int); 143 144 /* for status polling */ 145 void (*status)(struct usbnet *, struct urb *); 146 147 /* link reset handling, called from defer_kevent */ 148 int (*link_reset)(struct usbnet *); 149 150 /* fixup rx packet (strip framing) */ 151 int (*rx_fixup)(struct usbnet *dev, struct sk_buff *skb); 152 153 /* fixup tx packet (add framing) */ 154 struct sk_buff *(*tx_fixup)(struct usbnet *dev, 155 struct sk_buff *skb, gfp_t flags); 156 157 /* recover from timeout */ 158 void (*recover)(struct usbnet *dev); 159 160 /* early initialization code, can sleep. This is for minidrivers 161 * having 'subminidrivers' that need to do extra initialization 162 * right after minidriver have initialized hardware. */ 163 int (*early_init)(struct usbnet *dev); 164 165 /* called by minidriver when receiving indication */ 166 void (*indication)(struct usbnet *dev, void *ind, int indlen); 167 168 /* rx mode change (device changes address list filtering) */ 169 void (*set_rx_mode)(struct usbnet *dev); 170 171 /* for new devices, use the descriptor-reading code instead */ 172 int in; /* rx endpoint */ 173 int out; /* tx endpoint */ 174 175 unsigned long data; /* Misc driver specific data */ 176}; 177 178/* Minidrivers are just drivers using the "usbnet" core as a powerful 179 * network-specific subroutine library ... that happens to do pretty 180 * much everything except custom framing and chip-specific stuff. 181 */ 182extern int usbnet_probe(struct usb_interface *, const struct usb_device_id *); 183extern int usbnet_suspend(struct usb_interface *, pm_message_t); 184extern int usbnet_resume(struct usb_interface *); 185extern void usbnet_disconnect(struct usb_interface *); 186extern void usbnet_device_suggests_idle(struct usbnet *dev); 187 188extern int usbnet_read_cmd(struct usbnet *dev, u8 cmd, u8 reqtype, 189 u16 value, u16 index, void *data, u16 size); 190extern int usbnet_write_cmd(struct usbnet *dev, u8 cmd, u8 reqtype, 191 u16 value, u16 index, const void *data, u16 size); 192extern int usbnet_read_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype, 193 u16 value, u16 index, void *data, u16 size); 194extern int usbnet_write_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype, 195 u16 value, u16 index, const void *data, u16 size); 196extern int usbnet_write_cmd_async(struct usbnet *dev, u8 cmd, u8 reqtype, 197 u16 value, u16 index, const void *data, u16 size); 198 199/* Drivers that reuse some of the standard USB CDC infrastructure 200 * (notably, using multiple interfaces according to the CDC 201 * union descriptor) get some helper code. 202 */ 203struct cdc_state { 204 struct usb_cdc_header_desc *header; 205 struct usb_cdc_union_desc *u; 206 struct usb_cdc_ether_desc *ether; 207 struct usb_interface *control; 208 struct usb_interface *data; 209}; 210 211extern void usbnet_cdc_update_filter(struct usbnet *dev); 212extern int usbnet_generic_cdc_bind(struct usbnet *, struct usb_interface *); 213extern int usbnet_ether_cdc_bind(struct usbnet *dev, struct usb_interface *intf); 214extern int usbnet_cdc_bind(struct usbnet *, struct usb_interface *); 215extern void usbnet_cdc_unbind(struct usbnet *, struct usb_interface *); 216extern void usbnet_cdc_status(struct usbnet *, struct urb *); 217extern int usbnet_cdc_zte_rx_fixup(struct usbnet *dev, struct sk_buff *skb); 218 219/* CDC and RNDIS support the same host-chosen packet filters for IN transfers */ 220#define DEFAULT_FILTER (USB_CDC_PACKET_TYPE_BROADCAST \ 221 |USB_CDC_PACKET_TYPE_ALL_MULTICAST \ 222 |USB_CDC_PACKET_TYPE_PROMISCUOUS \ 223 |USB_CDC_PACKET_TYPE_DIRECTED) 224 225 226/* we record the state for each of our queued skbs */ 227enum skb_state { 228 illegal = 0, 229 tx_start, tx_done, 230 rx_start, rx_done, rx_cleanup, 231 unlink_start 232}; 233 234struct skb_data { /* skb->cb is one of these */ 235 struct urb *urb; 236 struct usbnet *dev; 237 enum skb_state state; 238 long length; 239 unsigned long packets; 240}; 241 242/* Drivers that set FLAG_MULTI_PACKET must call this in their 243 * tx_fixup method before returning an skb. 244 */ 245static inline void 246usbnet_set_skb_tx_stats(struct sk_buff *skb, 247 unsigned long packets, long bytes_delta) 248{ 249 struct skb_data *entry = (struct skb_data *) skb->cb; 250 251 entry->packets = packets; 252 entry->length = bytes_delta; 253} 254 255extern int usbnet_open(struct net_device *net); 256extern int usbnet_stop(struct net_device *net); 257extern netdev_tx_t usbnet_start_xmit(struct sk_buff *skb, 258 struct net_device *net); 259extern void usbnet_tx_timeout(struct net_device *net, unsigned int txqueue); 260extern int usbnet_change_mtu(struct net_device *net, int new_mtu); 261 262extern int usbnet_get_endpoints(struct usbnet *, struct usb_interface *); 263extern int usbnet_get_ethernet_addr(struct usbnet *, int); 264extern void usbnet_defer_kevent(struct usbnet *, int); 265extern void usbnet_skb_return(struct usbnet *, struct sk_buff *); 266extern void usbnet_unlink_rx_urbs(struct usbnet *); 267 268extern void usbnet_pause_rx(struct usbnet *); 269extern void usbnet_resume_rx(struct usbnet *); 270extern void usbnet_purge_paused_rxq(struct usbnet *); 271 272extern int usbnet_get_link_ksettings_mii(struct net_device *net, 273 struct ethtool_link_ksettings *cmd); 274extern int usbnet_set_link_ksettings_mii(struct net_device *net, 275 const struct ethtool_link_ksettings *cmd); 276extern int usbnet_get_link_ksettings_internal(struct net_device *net, 277 struct ethtool_link_ksettings *cmd); 278extern u32 usbnet_get_link(struct net_device *net); 279extern u32 usbnet_get_msglevel(struct net_device *); 280extern void usbnet_set_msglevel(struct net_device *, u32); 281extern void usbnet_set_rx_mode(struct net_device *net); 282extern void usbnet_get_drvinfo(struct net_device *, struct ethtool_drvinfo *); 283extern int usbnet_nway_reset(struct net_device *net); 284 285extern int usbnet_manage_power(struct usbnet *, int); 286extern void usbnet_link_change(struct usbnet *, bool, bool); 287 288extern int usbnet_status_start(struct usbnet *dev, gfp_t mem_flags); 289extern void usbnet_status_stop(struct usbnet *dev); 290 291extern void usbnet_update_max_qlen(struct usbnet *dev); 292 293#endif /* __LINUX_USB_USBNET_H */