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