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
;
39 /* i/o info: pipes etc */
41 struct usb_host_endpoint
*status
;
43 struct timer_list delay
;
45 /* protocol/interface state */
46 struct net_device
*net
;
48 unsigned long data
[5];
50 u32 hard_mtu
; /* count any extra framing */
51 size_t rx_urb_size
; /* size for rx urbs */
52 struct mii_if_info mii
;
54 /* various kinds of pending driver work */
55 struct sk_buff_head rxq
;
56 struct sk_buff_head txq
;
57 struct sk_buff_head done
;
58 struct sk_buff_head rxq_pause
;
59 struct urb
*interrupt
;
60 unsigned interrupt_count
;
61 struct mutex interrupt_mutex
;
62 struct usb_anchor deferred
;
63 struct tasklet_struct bh
;
65 struct work_struct kevent
;
67 # define EVENT_TX_HALT 0
68 # define EVENT_RX_HALT 1
69 # define EVENT_RX_MEMORY 2
70 # define EVENT_STS_SPLIT 3
71 # define EVENT_LINK_RESET 4
72 # define EVENT_RX_PAUSED 5
73 # define EVENT_DEV_ASLEEP 6
74 # define EVENT_DEV_OPEN 7
75 # define EVENT_DEVICE_REPORT_IDLE 8
76 # define EVENT_NO_RUNTIME_PM 9
77 # define EVENT_RX_KILL 10
78 # define EVENT_LINK_CHANGE 11
81 static inline struct usb_driver
*driver_of(struct usb_interface
*intf
)
83 return to_usb_driver(intf
->dev
.driver
);
86 /* interface from the device/framing level "minidriver" to core */
91 /* framing is CDC Ethernet, not writing ZLPs (hw issues), or optionally: */
92 #define FLAG_FRAMING_NC 0x0001 /* guard against device dropouts */
93 #define FLAG_FRAMING_GL 0x0002 /* genelink batches packets */
94 #define FLAG_FRAMING_Z 0x0004 /* zaurus adds a trailer */
95 #define FLAG_FRAMING_RN 0x0008 /* RNDIS batches, plus huge header */
97 #define FLAG_NO_SETINT 0x0010 /* device can't set_interface() */
98 #define FLAG_ETHER 0x0020 /* maybe use "eth%d" names */
100 #define FLAG_FRAMING_AX 0x0040 /* AX88772/178 packets */
101 #define FLAG_WLAN 0x0080 /* use "wlan%d" names */
102 #define FLAG_AVOID_UNLINK_URBS 0x0100 /* don't unlink urbs at usbnet_stop() */
103 #define FLAG_SEND_ZLP 0x0200 /* hw requires ZLPs are sent */
104 #define FLAG_WWAN 0x0400 /* use "wwan%d" names */
106 #define FLAG_LINK_INTR 0x0800 /* updates link (carrier) status */
108 #define FLAG_POINTTOPOINT 0x1000 /* possibly use "usb%d" names */
111 * Indicates to usbnet, that USB driver accumulates multiple IP packets.
112 * Affects statistic (counters) and short packet handling.
114 #define FLAG_MULTI_PACKET 0x2000
115 #define FLAG_RX_ASSEMBLE 0x4000 /* rx packets may span >1 frames */
116 #define FLAG_NOARP 0x8000 /* device can't do ARP */
118 /* init device ... can sleep, or cause probe() failure */
119 int (*bind
)(struct usbnet
*, struct usb_interface
*);
121 /* cleanup device ... can sleep, but can't fail */
122 void (*unbind
)(struct usbnet
*, struct usb_interface
*);
124 /* reset device ... can sleep */
125 int (*reset
)(struct usbnet
*);
127 /* stop device ... can sleep */
128 int (*stop
)(struct usbnet
*);
130 /* see if peer is connected ... can sleep */
131 int (*check_connect
)(struct usbnet
*);
133 /* (dis)activate runtime power management */
134 int (*manage_power
)(struct usbnet
*, int);
136 /* for status polling */
137 void (*status
)(struct usbnet
*, struct urb
*);
139 /* link reset handling, called from defer_kevent */
140 int (*link_reset
)(struct usbnet
*);
142 /* fixup rx packet (strip framing) */
143 int (*rx_fixup
)(struct usbnet
*dev
, struct sk_buff
*skb
);
145 /* fixup tx packet (add framing) */
146 struct sk_buff
*(*tx_fixup
)(struct usbnet
*dev
,
147 struct sk_buff
*skb
, gfp_t flags
);
149 /* early initialization code, can sleep. This is for minidrivers
150 * having 'subminidrivers' that need to do extra initialization
151 * right after minidriver have initialized hardware. */
152 int (*early_init
)(struct usbnet
*dev
);
154 /* called by minidriver when receiving indication */
155 void (*indication
)(struct usbnet
*dev
, void *ind
, int indlen
);
157 /* for new devices, use the descriptor-reading code instead */
158 int in
; /* rx endpoint */
159 int out
; /* tx endpoint */
161 unsigned long data
; /* Misc driver specific data */
164 /* Minidrivers are just drivers using the "usbnet" core as a powerful
165 * network-specific subroutine library ... that happens to do pretty
166 * much everything except custom framing and chip-specific stuff.
168 extern int usbnet_probe(struct usb_interface
*, const struct usb_device_id
*);
169 extern int usbnet_suspend(struct usb_interface
*, pm_message_t
);
170 extern int usbnet_resume(struct usb_interface
*);
171 extern void usbnet_disconnect(struct usb_interface
*);
172 extern void usbnet_device_suggests_idle(struct usbnet
*dev
);
174 extern int usbnet_read_cmd(struct usbnet
*dev
, u8 cmd
, u8 reqtype
,
175 u16 value
, u16 index
, void *data
, u16 size
);
176 extern int usbnet_write_cmd(struct usbnet
*dev
, u8 cmd
, u8 reqtype
,
177 u16 value
, u16 index
, const void *data
, u16 size
);
178 extern int usbnet_read_cmd_nopm(struct usbnet
*dev
, u8 cmd
, u8 reqtype
,
179 u16 value
, u16 index
, void *data
, u16 size
);
180 extern int usbnet_write_cmd_nopm(struct usbnet
*dev
, u8 cmd
, u8 reqtype
,
181 u16 value
, u16 index
, const void *data
, u16 size
);
182 extern int usbnet_write_cmd_async(struct usbnet
*dev
, u8 cmd
, u8 reqtype
,
183 u16 value
, u16 index
, const void *data
, u16 size
);
185 /* Drivers that reuse some of the standard USB CDC infrastructure
186 * (notably, using multiple interfaces according to the CDC
187 * union descriptor) get some helper code.
190 struct usb_cdc_header_desc
*header
;
191 struct usb_cdc_union_desc
*u
;
192 struct usb_cdc_ether_desc
*ether
;
193 struct usb_interface
*control
;
194 struct usb_interface
*data
;
197 extern int usbnet_generic_cdc_bind(struct usbnet
*, struct usb_interface
*);
198 extern int usbnet_cdc_bind(struct usbnet
*, struct usb_interface
*);
199 extern void usbnet_cdc_unbind(struct usbnet
*, struct usb_interface
*);
200 extern void usbnet_cdc_status(struct usbnet
*, struct urb
*);
202 /* CDC and RNDIS support the same host-chosen packet filters for IN transfers */
203 #define DEFAULT_FILTER (USB_CDC_PACKET_TYPE_BROADCAST \
204 |USB_CDC_PACKET_TYPE_ALL_MULTICAST \
205 |USB_CDC_PACKET_TYPE_PROMISCUOUS \
206 |USB_CDC_PACKET_TYPE_DIRECTED)
209 /* we record the state for each of our queued skbs */
213 rx_start
, rx_done
, rx_cleanup
,
217 struct skb_data
{ /* skb->cb is one of these */
220 enum skb_state state
;
224 extern int usbnet_open(struct net_device
*net
);
225 extern int usbnet_stop(struct net_device
*net
);
226 extern netdev_tx_t
usbnet_start_xmit(struct sk_buff
*skb
,
227 struct net_device
*net
);
228 extern void usbnet_tx_timeout(struct net_device
*net
);
229 extern int usbnet_change_mtu(struct net_device
*net
, int new_mtu
);
231 extern int usbnet_get_endpoints(struct usbnet
*, struct usb_interface
*);
232 extern int usbnet_get_ethernet_addr(struct usbnet
*, int);
233 extern void usbnet_defer_kevent(struct usbnet
*, int);
234 extern void usbnet_skb_return(struct usbnet
*, struct sk_buff
*);
235 extern void usbnet_unlink_rx_urbs(struct usbnet
*);
237 extern void usbnet_pause_rx(struct usbnet
*);
238 extern void usbnet_resume_rx(struct usbnet
*);
239 extern void usbnet_purge_paused_rxq(struct usbnet
*);
241 extern int usbnet_get_settings(struct net_device
*net
,
242 struct ethtool_cmd
*cmd
);
243 extern int usbnet_set_settings(struct net_device
*net
,
244 struct ethtool_cmd
*cmd
);
245 extern u32
usbnet_get_link(struct net_device
*net
);
246 extern u32
usbnet_get_msglevel(struct net_device
*);
247 extern void usbnet_set_msglevel(struct net_device
*, u32
);
248 extern void usbnet_get_drvinfo(struct net_device
*, struct ethtool_drvinfo
*);
249 extern int usbnet_nway_reset(struct net_device
*net
);
251 extern int usbnet_manage_power(struct usbnet
*, int);
252 extern void usbnet_link_change(struct usbnet
*, bool, bool);
254 extern int usbnet_status_start(struct usbnet
*dev
, gfp_t mem_flags
);
255 extern void usbnet_status_stop(struct usbnet
*dev
);
257 extern void usbnet_update_max_qlen(struct usbnet
*dev
);
259 #endif /* __LINUX_USB_USBNET_H */
This page took 0.039852 seconds and 5 git commands to generate.