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