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