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