1 |
62 |
marcus.erl |
/*
|
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 |
|
|
|
23 |
|
|
#ifndef __USBNET_H
|
24 |
|
|
#define __USBNET_H
|
25 |
|
|
|
26 |
|
|
|
27 |
|
|
/* interface from usbnet core to each USB networking link we handle */
|
28 |
|
|
struct usbnet {
|
29 |
|
|
/* housekeeping */
|
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;
|
37 |
|
|
|
38 |
|
|
/* i/o info: pipes etc */
|
39 |
|
|
unsigned in, out;
|
40 |
|
|
struct usb_host_endpoint *status;
|
41 |
|
|
unsigned maxpacket;
|
42 |
|
|
struct timer_list delay;
|
43 |
|
|
|
44 |
|
|
/* protocol/interface state */
|
45 |
|
|
struct net_device *net;
|
46 |
|
|
struct net_device_stats stats;
|
47 |
|
|
int msg_enable;
|
48 |
|
|
unsigned long data [5];
|
49 |
|
|
u32 xid;
|
50 |
|
|
u32 hard_mtu; /* count any extra framing */
|
51 |
|
|
size_t rx_urb_size; /* size for rx urbs */
|
52 |
|
|
struct mii_if_info mii;
|
53 |
|
|
|
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;
|
60 |
|
|
|
61 |
|
|
struct work_struct kevent;
|
62 |
|
|
unsigned long flags;
|
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
|
68 |
|
|
};
|
69 |
|
|
|
70 |
|
|
static inline struct usb_driver *driver_of(struct usb_interface *intf)
|
71 |
|
|
{
|
72 |
|
|
return to_usb_driver(intf->dev.driver);
|
73 |
|
|
}
|
74 |
|
|
|
75 |
|
|
/* interface from the device/framing level "minidriver" to core */
|
76 |
|
|
struct driver_info {
|
77 |
|
|
char *description;
|
78 |
|
|
|
79 |
|
|
int flags;
|
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 */
|
85 |
|
|
|
86 |
|
|
#define FLAG_NO_SETINT 0x0010 /* device can't set_interface() */
|
87 |
|
|
#define FLAG_ETHER 0x0020 /* maybe use "eth%d" names */
|
88 |
|
|
|
89 |
|
|
#define FLAG_FRAMING_AX 0x0040 /* AX88772/178 packets */
|
90 |
|
|
|
91 |
|
|
/* init device ... can sleep, or cause probe() failure */
|
92 |
|
|
int (*bind)(struct usbnet *, struct usb_interface *);
|
93 |
|
|
|
94 |
|
|
/* cleanup device ... can sleep, but can't fail */
|
95 |
|
|
void (*unbind)(struct usbnet *, struct usb_interface *);
|
96 |
|
|
|
97 |
|
|
/* reset device ... can sleep */
|
98 |
|
|
int (*reset)(struct usbnet *);
|
99 |
|
|
|
100 |
|
|
/* see if peer is connected ... can sleep */
|
101 |
|
|
int (*check_connect)(struct usbnet *);
|
102 |
|
|
|
103 |
|
|
/* for status polling */
|
104 |
|
|
void (*status)(struct usbnet *, struct urb *);
|
105 |
|
|
|
106 |
|
|
/* link reset handling, called from defer_kevent */
|
107 |
|
|
int (*link_reset)(struct usbnet *);
|
108 |
|
|
|
109 |
|
|
/* fixup rx packet (strip framing) */
|
110 |
|
|
int (*rx_fixup)(struct usbnet *dev, struct sk_buff *skb);
|
111 |
|
|
|
112 |
|
|
/* fixup tx packet (add framing) */
|
113 |
|
|
struct sk_buff *(*tx_fixup)(struct usbnet *dev,
|
114 |
|
|
struct sk_buff *skb, gfp_t flags);
|
115 |
|
|
|
116 |
|
|
/* for new devices, use the descriptor-reading code instead */
|
117 |
|
|
int in; /* rx endpoint */
|
118 |
|
|
int out; /* tx endpoint */
|
119 |
|
|
|
120 |
|
|
unsigned long data; /* Misc driver specific data */
|
121 |
|
|
};
|
122 |
|
|
|
123 |
|
|
/* Minidrivers are just drivers using the "usbnet" core as a powerful
|
124 |
|
|
* network-specific subroutine library ... that happens to do pretty
|
125 |
|
|
* much everything except custom framing and chip-specific stuff.
|
126 |
|
|
*/
|
127 |
|
|
extern int usbnet_probe(struct usb_interface *, const struct usb_device_id *);
|
128 |
|
|
extern int usbnet_suspend (struct usb_interface *, pm_message_t );
|
129 |
|
|
extern int usbnet_resume (struct usb_interface *);
|
130 |
|
|
extern void usbnet_disconnect(struct usb_interface *);
|
131 |
|
|
|
132 |
|
|
|
133 |
|
|
/* Drivers that reuse some of the standard USB CDC infrastructure
|
134 |
|
|
* (notably, using multiple interfaces according to the CDC
|
135 |
|
|
* union descriptor) get some helper code.
|
136 |
|
|
*/
|
137 |
|
|
struct cdc_state {
|
138 |
|
|
struct usb_cdc_header_desc *header;
|
139 |
|
|
struct usb_cdc_union_desc *u;
|
140 |
|
|
struct usb_cdc_ether_desc *ether;
|
141 |
|
|
struct usb_interface *control;
|
142 |
|
|
struct usb_interface *data;
|
143 |
|
|
};
|
144 |
|
|
|
145 |
|
|
extern int usbnet_generic_cdc_bind (struct usbnet *, struct usb_interface *);
|
146 |
|
|
extern void usbnet_cdc_unbind (struct usbnet *, struct usb_interface *);
|
147 |
|
|
|
148 |
|
|
/* CDC and RNDIS support the same host-chosen packet filters for IN transfers */
|
149 |
|
|
#define DEFAULT_FILTER (USB_CDC_PACKET_TYPE_BROADCAST \
|
150 |
|
|
|USB_CDC_PACKET_TYPE_ALL_MULTICAST \
|
151 |
|
|
|USB_CDC_PACKET_TYPE_PROMISCUOUS \
|
152 |
|
|
|USB_CDC_PACKET_TYPE_DIRECTED)
|
153 |
|
|
|
154 |
|
|
|
155 |
|
|
/* we record the state for each of our queued skbs */
|
156 |
|
|
enum skb_state {
|
157 |
|
|
illegal = 0,
|
158 |
|
|
tx_start, tx_done,
|
159 |
|
|
rx_start, rx_done, rx_cleanup
|
160 |
|
|
};
|
161 |
|
|
|
162 |
|
|
struct skb_data { /* skb->cb is one of these */
|
163 |
|
|
struct urb *urb;
|
164 |
|
|
struct usbnet *dev;
|
165 |
|
|
enum skb_state state;
|
166 |
|
|
size_t length;
|
167 |
|
|
};
|
168 |
|
|
|
169 |
|
|
|
170 |
|
|
extern int usbnet_get_endpoints(struct usbnet *, struct usb_interface *);
|
171 |
|
|
extern void usbnet_defer_kevent (struct usbnet *, int);
|
172 |
|
|
extern void usbnet_skb_return (struct usbnet *, struct sk_buff *);
|
173 |
|
|
extern void usbnet_unlink_rx_urbs(struct usbnet *);
|
174 |
|
|
|
175 |
|
|
extern int usbnet_get_settings (struct net_device *net, struct ethtool_cmd *cmd);
|
176 |
|
|
extern int usbnet_set_settings (struct net_device *net, struct ethtool_cmd *cmd);
|
177 |
|
|
extern u32 usbnet_get_link (struct net_device *net);
|
178 |
|
|
extern u32 usbnet_get_msglevel (struct net_device *);
|
179 |
|
|
extern void usbnet_set_msglevel (struct net_device *, u32);
|
180 |
|
|
extern void usbnet_get_drvinfo (struct net_device *, struct ethtool_drvinfo *);
|
181 |
|
|
extern int usbnet_nway_reset(struct net_device *net);
|
182 |
|
|
|
183 |
|
|
/* messaging support includes the interface name, so it must not be
|
184 |
|
|
* used before it has one ... notably, in minidriver bind() calls.
|
185 |
|
|
*/
|
186 |
|
|
#ifdef DEBUG
|
187 |
|
|
#define devdbg(usbnet, fmt, arg...) \
|
188 |
|
|
printk(KERN_DEBUG "%s: " fmt "\n" , (usbnet)->net->name , ## arg)
|
189 |
|
|
#else
|
190 |
|
|
#define devdbg(usbnet, fmt, arg...) do {} while(0)
|
191 |
|
|
#endif
|
192 |
|
|
|
193 |
|
|
#define deverr(usbnet, fmt, arg...) \
|
194 |
|
|
printk(KERN_ERR "%s: " fmt "\n" , (usbnet)->net->name , ## arg)
|
195 |
|
|
#define devwarn(usbnet, fmt, arg...) \
|
196 |
|
|
printk(KERN_WARNING "%s: " fmt "\n" , (usbnet)->net->name , ## arg)
|
197 |
|
|
|
198 |
|
|
#define devinfo(usbnet, fmt, arg...) \
|
199 |
|
|
printk(KERN_INFO "%s: " fmt "\n" , (usbnet)->net->name , ## arg); \
|
200 |
|
|
|
201 |
|
|
|
202 |
|
|
#endif /* __USBNET_H */
|