2 * USB Networking Link Interface
4 * Copyright (C) 2000-2005 by David Brownell <dbrownell@users.sourceforge.net>
5 * Copyright (C) 2003-2005 David Hollis <dhollis@davehollis.com>
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.
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.
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
22 #ifndef __LINUX_USB_USBNET_H
23 #define __LINUX_USB_USBNET_H
25 /* interface from usbnet core to each USB networking link we handle */
28 struct usb_device *udev;
29 struct usb_interface *intf;
30 struct driver_info *driver_info;
31 const char *driver_name;
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;
40 /* i/o info: pipes etc */
42 struct usb_host_endpoint *status;
44 struct timer_list delay;
46 /* protocol/interface state */
47 struct net_device *net;
49 unsigned long data[5];
51 u32 hard_mtu; /* count any extra framing */
52 size_t rx_urb_size; /* size for rx urbs */
53 struct mii_if_info mii;
55 /* various kinds of pending driver work */
56 struct sk_buff_head rxq;
57 struct sk_buff_head txq;
58 struct sk_buff_head done;
59 struct sk_buff_head rxq_pause;
60 struct urb *interrupt;
61 unsigned interrupt_count;
62 struct mutex interrupt_mutex;
63 struct usb_anchor deferred;
64 struct tasklet_struct bh;
66 struct work_struct kevent;
68 # define EVENT_TX_HALT 0
69 # define EVENT_RX_HALT 1
70 # define EVENT_RX_MEMORY 2
71 # define EVENT_STS_SPLIT 3
72 # define EVENT_LINK_RESET 4
73 # define EVENT_RX_PAUSED 5
74 # define EVENT_DEV_ASLEEP 6
75 # define EVENT_DEV_OPEN 7
76 # define EVENT_DEVICE_REPORT_IDLE 8
77 # define EVENT_NO_RUNTIME_PM 9
78 # define EVENT_RX_KILL 10
79 # define EVENT_LINK_CHANGE 11
82 static inline struct usb_driver *driver_of(struct usb_interface *intf)
84 return to_usb_driver(intf->dev.driver);
87 /* interface from the device/framing level "minidriver" to core */
92 /* framing is CDC Ethernet, not writing ZLPs (hw issues), or optionally: */
93 #define FLAG_FRAMING_NC 0x0001 /* guard against device dropouts */
94 #define FLAG_FRAMING_GL 0x0002 /* genelink batches packets */
95 #define FLAG_FRAMING_Z 0x0004 /* zaurus adds a trailer */
96 #define FLAG_FRAMING_RN 0x0008 /* RNDIS batches, plus huge header */
98 #define FLAG_NO_SETINT 0x0010 /* device can't set_interface() */
99 #define FLAG_ETHER 0x0020 /* maybe use "eth%d" names */
101 #define FLAG_FRAMING_AX 0x0040 /* AX88772/178 packets */
102 #define FLAG_WLAN 0x0080 /* use "wlan%d" names */
103 #define FLAG_AVOID_UNLINK_URBS 0x0100 /* don't unlink urbs at usbnet_stop() */
104 #define FLAG_SEND_ZLP 0x0200 /* hw requires ZLPs are sent */
105 #define FLAG_WWAN 0x0400 /* use "wwan%d" names */
107 #define FLAG_LINK_INTR 0x0800 /* updates link (carrier) status */
109 #define FLAG_POINTTOPOINT 0x1000 /* possibly use "usb%d" names */
112 * Indicates to usbnet, that USB driver accumulates multiple IP packets.
113 * Affects statistic (counters) and short packet handling.
115 #define FLAG_MULTI_PACKET 0x2000
116 #define FLAG_RX_ASSEMBLE 0x4000 /* rx packets may span >1 frames */
117 #define FLAG_NOARP 0x8000 /* device can't do ARP */
119 /* init device ... can sleep, or cause probe() failure */
120 int (*bind)(struct usbnet *, struct usb_interface *);
122 /* cleanup device ... can sleep, but can't fail */
123 void (*unbind)(struct usbnet *, struct usb_interface *);
125 /* reset device ... can sleep */
126 int (*reset)(struct usbnet *);
128 /* stop device ... can sleep */
129 int (*stop)(struct usbnet *);
131 /* see if peer is connected ... can sleep */
132 int (*check_connect)(struct usbnet *);
134 /* (dis)activate runtime power management */
135 int (*manage_power)(struct usbnet *, int);
137 /* for status polling */
138 void (*status)(struct usbnet *, struct urb *);
140 /* link reset handling, called from defer_kevent */
141 int (*link_reset)(struct usbnet *);
143 /* fixup rx packet (strip framing) */
144 int (*rx_fixup)(struct usbnet *dev, struct sk_buff *skb);
146 /* fixup tx packet (add framing) */
147 struct sk_buff *(*tx_fixup)(struct usbnet *dev,
148 struct sk_buff *skb, gfp_t flags);
150 /* early initialization code, can sleep. This is for minidrivers
151 * having 'subminidrivers' that need to do extra initialization
152 * right after minidriver have initialized hardware. */
153 int (*early_init)(struct usbnet *dev);
155 /* called by minidriver when receiving indication */
156 void (*indication)(struct usbnet *dev, void *ind, int indlen);
158 /* for new devices, use the descriptor-reading code instead */
159 int in; /* rx endpoint */
160 int out; /* tx endpoint */
162 unsigned long data; /* Misc driver specific data */
165 /* Minidrivers are just drivers using the "usbnet" core as a powerful
166 * network-specific subroutine library ... that happens to do pretty
167 * much everything except custom framing and chip-specific stuff.
169 extern int usbnet_probe(struct usb_interface *, const struct usb_device_id *);
170 extern int usbnet_suspend(struct usb_interface *, pm_message_t);
171 extern int usbnet_resume(struct usb_interface *);
172 extern void usbnet_disconnect(struct usb_interface *);
173 extern void usbnet_device_suggests_idle(struct usbnet *dev);
175 extern int usbnet_read_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
176 u16 value, u16 index, void *data, u16 size);
177 extern int usbnet_write_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
178 u16 value, u16 index, const void *data, u16 size);
179 extern int usbnet_read_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype,
180 u16 value, u16 index, void *data, u16 size);
181 extern int usbnet_write_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype,
182 u16 value, u16 index, const void *data, u16 size);
183 extern int usbnet_write_cmd_async(struct usbnet *dev, u8 cmd, u8 reqtype,
184 u16 value, u16 index, const void *data, u16 size);
186 /* Drivers that reuse some of the standard USB CDC infrastructure
187 * (notably, using multiple interfaces according to the CDC
188 * union descriptor) get some helper code.
191 struct usb_cdc_header_desc *header;
192 struct usb_cdc_union_desc *u;
193 struct usb_cdc_ether_desc *ether;
194 struct usb_interface *control;
195 struct usb_interface *data;
198 extern int usbnet_generic_cdc_bind(struct usbnet *, struct usb_interface *);
199 extern int usbnet_cdc_bind(struct usbnet *, struct usb_interface *);
200 extern void usbnet_cdc_unbind(struct usbnet *, struct usb_interface *);
201 extern void usbnet_cdc_status(struct usbnet *, struct urb *);
203 /* CDC and RNDIS support the same host-chosen packet filters for IN transfers */
204 #define DEFAULT_FILTER (USB_CDC_PACKET_TYPE_BROADCAST \
205 |USB_CDC_PACKET_TYPE_ALL_MULTICAST \
206 |USB_CDC_PACKET_TYPE_PROMISCUOUS \
207 |USB_CDC_PACKET_TYPE_DIRECTED)
210 /* we record the state for each of our queued skbs */
214 rx_start, rx_done, rx_cleanup,
218 struct skb_data { /* skb->cb is one of these */
221 enum skb_state state;
225 extern int usbnet_open(struct net_device *net);
226 extern int usbnet_stop(struct net_device *net);
227 extern netdev_tx_t usbnet_start_xmit(struct sk_buff *skb,
228 struct net_device *net);
229 extern void usbnet_tx_timeout(struct net_device *net);
230 extern int usbnet_change_mtu(struct net_device *net, int new_mtu);
232 extern int usbnet_get_endpoints(struct usbnet *, struct usb_interface *);
233 extern int usbnet_get_ethernet_addr(struct usbnet *, int);
234 extern void usbnet_defer_kevent(struct usbnet *, int);
235 extern void usbnet_skb_return(struct usbnet *, struct sk_buff *);
236 extern void usbnet_unlink_rx_urbs(struct usbnet *);
238 extern void usbnet_pause_rx(struct usbnet *);
239 extern void usbnet_resume_rx(struct usbnet *);
240 extern void usbnet_purge_paused_rxq(struct usbnet *);
242 extern int usbnet_get_settings(struct net_device *net,
243 struct ethtool_cmd *cmd);
244 extern int usbnet_set_settings(struct net_device *net,
245 struct ethtool_cmd *cmd);
246 extern u32 usbnet_get_link(struct net_device *net);
247 extern u32 usbnet_get_msglevel(struct net_device *);
248 extern void usbnet_set_msglevel(struct net_device *, u32);
249 extern void usbnet_get_drvinfo(struct net_device *, struct ethtool_drvinfo *);
250 extern int usbnet_nway_reset(struct net_device *net);
252 extern int usbnet_manage_power(struct usbnet *, int);
253 extern void usbnet_link_change(struct usbnet *, bool, bool);
255 extern int usbnet_status_start(struct usbnet *dev, gfp_t mem_flags);
256 extern void usbnet_status_stop(struct usbnet *dev);
258 extern void usbnet_update_max_qlen(struct usbnet *dev);
260 #endif /* __LINUX_USB_USBNET_H */