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
27 /* interface from usbnet core to each USB networking link we handle */
30 struct usb_device
*udev
;
31 struct usb_interface
*intf
;
32 struct driver_info
*driver_info
;
33 const char *driver_name
;
34 wait_queue_head_t
*wait
;
35 struct mutex phy_mutex
;
36 unsigned char suspend_count
;
38 /* i/o info: pipes etc */
40 struct usb_host_endpoint
*status
;
42 struct timer_list delay
;
44 /* protocol/interface state */
45 struct net_device
*net
;
46 struct net_device_stats stats
;
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 urb
*interrupt
;
59 struct tasklet_struct bh
;
61 struct work_struct kevent
;
63 # define EVENT_TX_HALT 0
64 # define EVENT_RX_HALT 1
65 # define EVENT_RX_MEMORY 2
66 # define EVENT_STS_SPLIT 3
67 # define EVENT_LINK_RESET 4
70 static inline struct usb_driver
*driver_of(struct usb_interface
*intf
)
72 return to_usb_driver(intf
->dev
.driver
);
75 /* interface from the device/framing level "minidriver" to core */
80 /* framing is CDC Ethernet, not writing ZLPs (hw issues), or optionally: */
81 #define FLAG_FRAMING_NC 0x0001 /* guard against device dropouts */
82 #define FLAG_FRAMING_GL 0x0002 /* genelink batches packets */
83 #define FLAG_FRAMING_Z 0x0004 /* zaurus adds a trailer */
84 #define FLAG_FRAMING_RN 0x0008 /* RNDIS batches, plus huge header */
86 #define FLAG_NO_SETINT 0x0010 /* device can't set_interface() */
87 #define FLAG_ETHER 0x0020 /* maybe use "eth%d" names */
89 #define FLAG_FRAMING_AX 0x0040 /* AX88772/178 packets */
90 #define FLAG_SEND_ZLP 0x0200 /* hw requires ZLPs are sent */
93 * Indicates to usbnet, that USB driver accumulates multiple IP packets.
94 * Affects statistic (counters) and short packet handling.
96 #define FLAG_MULTI_PACKET 0x2000
97 //#define FLAG_RX_ASSEMBLE 0x4000 /* rx packets may span >1 frames */
98 #define FLAG_NOARP 0x8000 /* device can't do ARP */
100 /* init device ... can sleep, or cause probe() failure */
101 int (*bind
)(struct usbnet
*, struct usb_interface
*);
103 /* cleanup device ... can sleep, but can't fail */
104 void (*unbind
)(struct usbnet
*, struct usb_interface
*);
106 /* reset device ... can sleep */
107 int (*reset
)(struct usbnet
*);
109 /* see if peer is connected ... can sleep */
110 int (*check_connect
)(struct usbnet
*);
112 /* for status polling */
113 void (*status
)(struct usbnet
*, struct urb
*);
115 /* link reset handling, called from defer_kevent */
116 int (*link_reset
)(struct usbnet
*);
118 /* fixup rx packet (strip framing) */
119 int (*rx_fixup
)(struct usbnet
*dev
, struct sk_buff
*skb
);
121 /* fixup tx packet (add framing) */
122 struct sk_buff
*(*tx_fixup
)(struct usbnet
*dev
,
123 struct sk_buff
*skb
, gfp_t flags
);
125 /* for new devices, use the descriptor-reading code instead */
126 int in
; /* rx endpoint */
127 int out
; /* tx endpoint */
129 unsigned long data
; /* Misc driver specific data */
132 /* Minidrivers are just drivers using the "usbnet" core as a powerful
133 * network-specific subroutine library ... that happens to do pretty
134 * much everything except custom framing and chip-specific stuff.
136 extern int usbnet_probe(struct usb_interface
*, const struct usb_device_id
*);
137 extern int usbnet_suspend (struct usb_interface
*, pm_message_t
);
138 extern int usbnet_resume (struct usb_interface
*);
139 extern void usbnet_disconnect(struct usb_interface
*);
142 /* Drivers that reuse some of the standard USB CDC infrastructure
143 * (notably, using multiple interfaces according to the CDC
144 * union descriptor) get some helper code.
147 struct usb_cdc_header_desc
*header
;
148 struct usb_cdc_union_desc
*u
;
149 struct usb_cdc_ether_desc
*ether
;
150 struct usb_interface
*control
;
151 struct usb_interface
*data
;
154 extern int usbnet_generic_cdc_bind (struct usbnet
*, struct usb_interface
*);
155 extern void usbnet_cdc_unbind (struct usbnet
*, struct usb_interface
*);
157 /* CDC and RNDIS support the same host-chosen packet filters for IN transfers */
158 #define DEFAULT_FILTER (USB_CDC_PACKET_TYPE_BROADCAST \
159 |USB_CDC_PACKET_TYPE_ALL_MULTICAST \
160 |USB_CDC_PACKET_TYPE_PROMISCUOUS \
161 |USB_CDC_PACKET_TYPE_DIRECTED)
164 /* we record the state for each of our queued skbs */
168 rx_start
, rx_done
, rx_cleanup
,
172 struct skb_data
{ /* skb->cb is one of these */
175 enum skb_state state
;
179 extern int usbnet_open (struct net_device
*net
);
180 extern int usbnet_stop (struct net_device
*net
);
181 extern int usbnet_start_xmit (struct sk_buff
*skb
, struct net_device
*net
);
182 extern void usbnet_tx_timeout (struct net_device
*net
);
183 extern int usbnet_change_mtu (struct net_device
*net
, int new_mtu
);
185 extern int usbnet_get_endpoints(struct usbnet
*, struct usb_interface
*);
186 extern int usbnet_get_ethernet_addr(struct usbnet
*, int);
187 extern void usbnet_defer_kevent (struct usbnet
*, int);
188 extern void usbnet_skb_return (struct usbnet
*, struct sk_buff
*);
189 extern void usbnet_unlink_rx_urbs(struct usbnet
*);
191 extern int usbnet_get_settings (struct net_device
*net
, struct ethtool_cmd
*cmd
);
192 extern int usbnet_set_settings (struct net_device
*net
, struct ethtool_cmd
*cmd
);
193 extern u32
usbnet_get_link (struct net_device
*net
);
194 extern u32
usbnet_get_msglevel (struct net_device
*);
195 extern void usbnet_set_msglevel (struct net_device
*, u32
);
196 extern void usbnet_get_drvinfo (struct net_device
*, struct ethtool_drvinfo
*);
197 extern int usbnet_nway_reset(struct net_device
*net
);
199 /* messaging support includes the interface name, so it must not be
200 * used before it has one ... notably, in minidriver bind() calls.
203 #define devdbg(usbnet, fmt, arg...) \
204 printk(KERN_DEBUG "%s: " fmt "\n" , (usbnet)->net->name , ## arg)
206 #define devdbg(usbnet, fmt, arg...) do {} while(0)
209 #define deverr(usbnet, fmt, arg...) \
210 printk(KERN_ERR "%s: " fmt "\n" , (usbnet)->net->name , ## arg)
211 #define devwarn(usbnet, fmt, arg...) \
212 printk(KERN_WARNING "%s: " fmt "\n" , (usbnet)->net->name , ## arg)
214 #define devinfo(usbnet, fmt, arg...) \
215 printk(KERN_INFO "%s: " fmt "\n" , (usbnet)->net->name , ## arg); \
218 #endif /* __USBNET_H */