Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 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 */ |
| 27 | struct usbnet { |
| 28 | /* housekeeping */ |
| 29 | struct usb_device *udev; |
| 30 | struct usb_interface *intf; |
David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame] | 31 | const struct driver_info *driver_info; |
Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 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 | |
| 57 | /* various kinds of pending driver work */ |
| 58 | struct sk_buff_head rxq; |
| 59 | struct sk_buff_head txq; |
| 60 | struct sk_buff_head done; |
| 61 | struct sk_buff_head rxq_pause; |
| 62 | struct urb *interrupt; |
| 63 | unsigned interrupt_count; |
| 64 | struct mutex interrupt_mutex; |
| 65 | struct usb_anchor deferred; |
| 66 | struct tasklet_struct bh; |
| 67 | |
| 68 | struct pcpu_sw_netstats __percpu *stats64; |
| 69 | |
| 70 | struct work_struct kevent; |
| 71 | unsigned long flags; |
| 72 | # define EVENT_TX_HALT 0 |
| 73 | # define EVENT_RX_HALT 1 |
| 74 | # define EVENT_RX_MEMORY 2 |
| 75 | # define EVENT_STS_SPLIT 3 |
| 76 | # define EVENT_LINK_RESET 4 |
| 77 | # define EVENT_RX_PAUSED 5 |
| 78 | # define EVENT_DEV_ASLEEP 6 |
| 79 | # define EVENT_DEV_OPEN 7 |
| 80 | # define EVENT_DEVICE_REPORT_IDLE 8 |
| 81 | # define EVENT_NO_RUNTIME_PM 9 |
| 82 | # define EVENT_RX_KILL 10 |
| 83 | # define EVENT_LINK_CHANGE 11 |
| 84 | # define EVENT_SET_RX_MODE 12 |
| 85 | # define EVENT_NO_IP_ALIGN 13 |
Olivier Deprez | 0e64123 | 2021-09-23 10:07:05 +0200 | [diff] [blame] | 86 | u32 rx_speed; /* in bps - NOT Mbps */ |
| 87 | u32 tx_speed; /* in bps - NOT Mbps */ |
Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 88 | }; |
| 89 | |
| 90 | static inline struct usb_driver *driver_of(struct usb_interface *intf) |
| 91 | { |
| 92 | return to_usb_driver(intf->dev.driver); |
| 93 | } |
| 94 | |
| 95 | /* interface from the device/framing level "minidriver" to core */ |
| 96 | struct driver_info { |
| 97 | char *description; |
| 98 | |
| 99 | int flags; |
| 100 | /* framing is CDC Ethernet, not writing ZLPs (hw issues), or optionally: */ |
| 101 | #define FLAG_FRAMING_NC 0x0001 /* guard against device dropouts */ |
| 102 | #define FLAG_FRAMING_GL 0x0002 /* genelink batches packets */ |
| 103 | #define FLAG_FRAMING_Z 0x0004 /* zaurus adds a trailer */ |
| 104 | #define FLAG_FRAMING_RN 0x0008 /* RNDIS batches, plus huge header */ |
| 105 | |
| 106 | #define FLAG_NO_SETINT 0x0010 /* device can't set_interface() */ |
| 107 | #define FLAG_ETHER 0x0020 /* maybe use "eth%d" names */ |
| 108 | |
| 109 | #define FLAG_FRAMING_AX 0x0040 /* AX88772/178 packets */ |
| 110 | #define FLAG_WLAN 0x0080 /* use "wlan%d" names */ |
| 111 | #define FLAG_AVOID_UNLINK_URBS 0x0100 /* don't unlink urbs at usbnet_stop() */ |
| 112 | #define FLAG_SEND_ZLP 0x0200 /* hw requires ZLPs are sent */ |
| 113 | #define FLAG_WWAN 0x0400 /* use "wwan%d" names */ |
| 114 | |
| 115 | #define FLAG_LINK_INTR 0x0800 /* updates link (carrier) status */ |
| 116 | |
| 117 | #define FLAG_POINTTOPOINT 0x1000 /* possibly use "usb%d" names */ |
| 118 | |
| 119 | /* |
| 120 | * Indicates to usbnet, that USB driver accumulates multiple IP packets. |
| 121 | * Affects statistic (counters) and short packet handling. |
| 122 | */ |
| 123 | #define FLAG_MULTI_PACKET 0x2000 |
| 124 | #define FLAG_RX_ASSEMBLE 0x4000 /* rx packets may span >1 frames */ |
| 125 | #define FLAG_NOARP 0x8000 /* device can't do ARP */ |
| 126 | |
| 127 | /* init device ... can sleep, or cause probe() failure */ |
| 128 | int (*bind)(struct usbnet *, struct usb_interface *); |
| 129 | |
| 130 | /* cleanup device ... can sleep, but can't fail */ |
| 131 | void (*unbind)(struct usbnet *, struct usb_interface *); |
| 132 | |
| 133 | /* reset device ... can sleep */ |
| 134 | int (*reset)(struct usbnet *); |
| 135 | |
| 136 | /* stop device ... can sleep */ |
| 137 | int (*stop)(struct usbnet *); |
| 138 | |
| 139 | /* see if peer is connected ... can sleep */ |
| 140 | int (*check_connect)(struct usbnet *); |
| 141 | |
| 142 | /* (dis)activate runtime power management */ |
| 143 | int (*manage_power)(struct usbnet *, int); |
| 144 | |
| 145 | /* for status polling */ |
| 146 | void (*status)(struct usbnet *, struct urb *); |
| 147 | |
| 148 | /* link reset handling, called from defer_kevent */ |
| 149 | int (*link_reset)(struct usbnet *); |
| 150 | |
| 151 | /* fixup rx packet (strip framing) */ |
| 152 | int (*rx_fixup)(struct usbnet *dev, struct sk_buff *skb); |
| 153 | |
| 154 | /* fixup tx packet (add framing) */ |
| 155 | struct sk_buff *(*tx_fixup)(struct usbnet *dev, |
| 156 | struct sk_buff *skb, gfp_t flags); |
| 157 | |
| 158 | /* recover from timeout */ |
| 159 | void (*recover)(struct usbnet *dev); |
| 160 | |
| 161 | /* early initialization code, can sleep. This is for minidrivers |
| 162 | * having 'subminidrivers' that need to do extra initialization |
| 163 | * right after minidriver have initialized hardware. */ |
| 164 | int (*early_init)(struct usbnet *dev); |
| 165 | |
| 166 | /* called by minidriver when receiving indication */ |
| 167 | void (*indication)(struct usbnet *dev, void *ind, int indlen); |
| 168 | |
| 169 | /* rx mode change (device changes address list filtering) */ |
| 170 | void (*set_rx_mode)(struct usbnet *dev); |
| 171 | |
| 172 | /* for new devices, use the descriptor-reading code instead */ |
| 173 | int in; /* rx endpoint */ |
| 174 | int out; /* tx endpoint */ |
| 175 | |
| 176 | unsigned long data; /* Misc driver specific data */ |
| 177 | }; |
| 178 | |
| 179 | /* Minidrivers are just drivers using the "usbnet" core as a powerful |
| 180 | * network-specific subroutine library ... that happens to do pretty |
| 181 | * much everything except custom framing and chip-specific stuff. |
| 182 | */ |
| 183 | extern int usbnet_probe(struct usb_interface *, const struct usb_device_id *); |
| 184 | extern int usbnet_suspend(struct usb_interface *, pm_message_t); |
| 185 | extern int usbnet_resume(struct usb_interface *); |
| 186 | extern void usbnet_disconnect(struct usb_interface *); |
| 187 | extern void usbnet_device_suggests_idle(struct usbnet *dev); |
| 188 | |
| 189 | extern int usbnet_read_cmd(struct usbnet *dev, u8 cmd, u8 reqtype, |
| 190 | u16 value, u16 index, void *data, u16 size); |
| 191 | extern int usbnet_write_cmd(struct usbnet *dev, u8 cmd, u8 reqtype, |
| 192 | u16 value, u16 index, const void *data, u16 size); |
| 193 | extern int usbnet_read_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype, |
| 194 | u16 value, u16 index, void *data, u16 size); |
| 195 | extern int usbnet_write_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype, |
| 196 | u16 value, u16 index, const void *data, u16 size); |
| 197 | extern int usbnet_write_cmd_async(struct usbnet *dev, u8 cmd, u8 reqtype, |
| 198 | u16 value, u16 index, const void *data, u16 size); |
| 199 | |
| 200 | /* Drivers that reuse some of the standard USB CDC infrastructure |
| 201 | * (notably, using multiple interfaces according to the CDC |
| 202 | * union descriptor) get some helper code. |
| 203 | */ |
| 204 | struct cdc_state { |
| 205 | struct usb_cdc_header_desc *header; |
| 206 | struct usb_cdc_union_desc *u; |
| 207 | struct usb_cdc_ether_desc *ether; |
| 208 | struct usb_interface *control; |
| 209 | struct usb_interface *data; |
| 210 | }; |
| 211 | |
Olivier Deprez | 157378f | 2022-04-04 15:47:50 +0200 | [diff] [blame^] | 212 | extern void usbnet_cdc_update_filter(struct usbnet *dev); |
Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 213 | extern int usbnet_generic_cdc_bind(struct usbnet *, struct usb_interface *); |
| 214 | extern int usbnet_ether_cdc_bind(struct usbnet *dev, struct usb_interface *intf); |
| 215 | extern int usbnet_cdc_bind(struct usbnet *, struct usb_interface *); |
| 216 | extern void usbnet_cdc_unbind(struct usbnet *, struct usb_interface *); |
| 217 | extern void usbnet_cdc_status(struct usbnet *, struct urb *); |
| 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 */ |
| 227 | enum skb_state { |
| 228 | illegal = 0, |
| 229 | tx_start, tx_done, |
| 230 | rx_start, rx_done, rx_cleanup, |
| 231 | unlink_start |
| 232 | }; |
| 233 | |
| 234 | struct 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 | */ |
| 245 | static inline void |
| 246 | usbnet_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 | |
| 255 | extern int usbnet_open(struct net_device *net); |
| 256 | extern int usbnet_stop(struct net_device *net); |
| 257 | extern netdev_tx_t usbnet_start_xmit(struct sk_buff *skb, |
| 258 | struct net_device *net); |
Olivier Deprez | 157378f | 2022-04-04 15:47:50 +0200 | [diff] [blame^] | 259 | extern void usbnet_tx_timeout(struct net_device *net, unsigned int txqueue); |
Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 260 | extern int usbnet_change_mtu(struct net_device *net, int new_mtu); |
| 261 | |
| 262 | extern int usbnet_get_endpoints(struct usbnet *, struct usb_interface *); |
| 263 | extern int usbnet_get_ethernet_addr(struct usbnet *, int); |
| 264 | extern void usbnet_defer_kevent(struct usbnet *, int); |
| 265 | extern void usbnet_skb_return(struct usbnet *, struct sk_buff *); |
| 266 | extern void usbnet_unlink_rx_urbs(struct usbnet *); |
| 267 | |
| 268 | extern void usbnet_pause_rx(struct usbnet *); |
| 269 | extern void usbnet_resume_rx(struct usbnet *); |
| 270 | extern void usbnet_purge_paused_rxq(struct usbnet *); |
| 271 | |
| 272 | extern int usbnet_get_link_ksettings(struct net_device *net, |
| 273 | struct ethtool_link_ksettings *cmd); |
| 274 | extern int usbnet_set_link_ksettings(struct net_device *net, |
| 275 | const struct ethtool_link_ksettings *cmd); |
| 276 | extern u32 usbnet_get_link(struct net_device *net); |
| 277 | extern u32 usbnet_get_msglevel(struct net_device *); |
| 278 | extern void usbnet_set_msglevel(struct net_device *, u32); |
Olivier Deprez | 157378f | 2022-04-04 15:47:50 +0200 | [diff] [blame^] | 279 | extern void usbnet_set_rx_mode(struct net_device *net); |
Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 280 | extern void usbnet_get_drvinfo(struct net_device *, struct ethtool_drvinfo *); |
| 281 | extern int usbnet_nway_reset(struct net_device *net); |
| 282 | |
| 283 | extern int usbnet_manage_power(struct usbnet *, int); |
| 284 | extern void usbnet_link_change(struct usbnet *, bool, bool); |
| 285 | |
| 286 | extern int usbnet_status_start(struct usbnet *dev, gfp_t mem_flags); |
| 287 | extern void usbnet_status_stop(struct usbnet *dev); |
| 288 | |
| 289 | extern void usbnet_update_max_qlen(struct usbnet *dev); |
| 290 | extern void usbnet_get_stats64(struct net_device *dev, |
| 291 | struct rtnl_link_stats64 *stats); |
| 292 | |
| 293 | #endif /* __LINUX_USB_USBNET_H */ |