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