Diff markup
1 /* 1 /*
2 * USB Networking Link Interface 2 * USB Networking Link Interface
3 * 3 *
4 * Copyright (C) 2000-2005 by David Brownell < 4 * Copyright (C) 2000-2005 by David Brownell <dbrownell@users.sourceforge.net>
5 * Copyright (C) 2003-2005 David Hollis <dholl 5 * Copyright (C) 2003-2005 David Hollis <dhollis@davehollis.com>
6 * 6 *
7 * This program is free software; you can redi 7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Publi 8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either versio 9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version. 10 * (at your option) any later version.
11 * 11 *
12 * This program is distributed in the hope tha 12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the 13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details 15 * GNU General Public License for more details.
16 * 16 *
17 * You should have received a copy of the GNU 17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to t 18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 33 19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 */ 20 */
21 21
22 !! 22 #ifndef __LINUX_USB_USBNET_H
23 #ifndef __USBNET_H !! 23 #define __LINUX_USB_USBNET_H
24 #define __USBNET_H <<
25 <<
26 24
27 /* interface from usbnet core to each USB netw 25 /* interface from usbnet core to each USB networking link we handle */
28 struct usbnet { 26 struct usbnet {
29 /* housekeeping */ 27 /* housekeeping */
30 struct usb_device *udev; 28 struct usb_device *udev;
31 struct usb_interface *intf; 29 struct usb_interface *intf;
32 struct driver_info *driver_info; 30 struct driver_info *driver_info;
33 const char *driver_name; 31 const char *driver_name;
34 void *driver_priv; 32 void *driver_priv;
35 wait_queue_head_t *wait; 33 wait_queue_head_t *wait;
36 struct mutex phy_mutex; 34 struct mutex phy_mutex;
37 unsigned char suspend_count; 35 unsigned char suspend_count;
38 36
39 /* i/o info: pipes etc */ 37 /* i/o info: pipes etc */
40 unsigned in, out; 38 unsigned in, out;
41 struct usb_host_endpoint *status; 39 struct usb_host_endpoint *status;
42 unsigned maxpacket; 40 unsigned maxpacket;
43 struct timer_list delay; 41 struct timer_list delay;
44 42
45 /* protocol/interface state */ 43 /* protocol/interface state */
46 struct net_device *net; 44 struct net_device *net;
47 struct net_device_stats stats; <<
48 int msg_enable; 45 int msg_enable;
49 unsigned long data [5]; 46 unsigned long data [5];
50 u32 xid; 47 u32 xid;
51 u32 hard_mtu; 48 u32 hard_mtu; /* count any extra framing */
52 size_t rx_urb_size; 49 size_t rx_urb_size; /* size for rx urbs */
53 struct mii_if_info mii; 50 struct mii_if_info mii;
54 51
55 /* various kinds of pending driver wor 52 /* various kinds of pending driver work */
56 struct sk_buff_head rxq; 53 struct sk_buff_head rxq;
57 struct sk_buff_head txq; 54 struct sk_buff_head txq;
58 struct sk_buff_head done; 55 struct sk_buff_head done;
59 struct urb *interrupt; 56 struct urb *interrupt;
60 struct tasklet_struct bh; 57 struct tasklet_struct bh;
61 58
62 struct work_struct kevent; 59 struct work_struct kevent;
63 unsigned long flags; 60 unsigned long flags;
64 # define EVENT_TX_HALT 0 61 # define EVENT_TX_HALT 0
65 # define EVENT_RX_HALT 1 62 # define EVENT_RX_HALT 1
66 # define EVENT_RX_MEMORY 2 63 # define EVENT_RX_MEMORY 2
67 # define EVENT_STS_SPLIT 3 64 # define EVENT_STS_SPLIT 3
68 # define EVENT_LINK_RESET 4 65 # define EVENT_LINK_RESET 4
69 }; 66 };
70 67
71 static inline struct usb_driver *driver_of(str 68 static inline struct usb_driver *driver_of(struct usb_interface *intf)
72 { 69 {
73 return to_usb_driver(intf->dev.driver) 70 return to_usb_driver(intf->dev.driver);
74 } 71 }
75 72
76 /* interface from the device/framing level "mi 73 /* interface from the device/framing level "minidriver" to core */
77 struct driver_info { 74 struct driver_info {
78 char *description; 75 char *description;
79 76
80 int flags; 77 int flags;
81 /* framing is CDC Ethernet, not writing ZLPs ( 78 /* framing is CDC Ethernet, not writing ZLPs (hw issues), or optionally: */
82 #define FLAG_FRAMING_NC 0x0001 /* gua 79 #define FLAG_FRAMING_NC 0x0001 /* guard against device dropouts */
83 #define FLAG_FRAMING_GL 0x0002 /* gen 80 #define FLAG_FRAMING_GL 0x0002 /* genelink batches packets */
84 #define FLAG_FRAMING_Z 0x0004 /* zau 81 #define FLAG_FRAMING_Z 0x0004 /* zaurus adds a trailer */
85 #define FLAG_FRAMING_RN 0x0008 /* RND 82 #define FLAG_FRAMING_RN 0x0008 /* RNDIS batches, plus huge header */
86 83
87 #define FLAG_NO_SETINT 0x0010 /* dev 84 #define FLAG_NO_SETINT 0x0010 /* device can't set_interface() */
88 #define FLAG_ETHER 0x0020 /* may 85 #define FLAG_ETHER 0x0020 /* maybe use "eth%d" names */
89 86
90 #define FLAG_FRAMING_AX 0x0040 /* AX8 87 #define FLAG_FRAMING_AX 0x0040 /* AX88772/178 packets */
91 #define FLAG_WLAN 0x0080 /* use 88 #define FLAG_WLAN 0x0080 /* use "wlan%d" names */
>> 89 #define FLAG_SEND_ZLP 0x0200 /* hw requires ZLPs are sent */
92 90
93 91
94 /* init device ... can sleep, or cause 92 /* init device ... can sleep, or cause probe() failure */
95 int (*bind)(struct usbnet *, struc 93 int (*bind)(struct usbnet *, struct usb_interface *);
96 94
97 /* cleanup device ... can sleep, but c 95 /* cleanup device ... can sleep, but can't fail */
98 void (*unbind)(struct usbnet *, str 96 void (*unbind)(struct usbnet *, struct usb_interface *);
99 97
100 /* reset device ... can sleep */ 98 /* reset device ... can sleep */
101 int (*reset)(struct usbnet *); 99 int (*reset)(struct usbnet *);
102 100
103 /* see if peer is connected ... can sl 101 /* see if peer is connected ... can sleep */
104 int (*check_connect)(struct usbnet 102 int (*check_connect)(struct usbnet *);
105 103
106 /* for status polling */ 104 /* for status polling */
107 void (*status)(struct usbnet *, str 105 void (*status)(struct usbnet *, struct urb *);
108 106
109 /* link reset handling, called from de 107 /* link reset handling, called from defer_kevent */
110 int (*link_reset)(struct usbnet *) 108 int (*link_reset)(struct usbnet *);
111 109
112 /* fixup rx packet (strip framing) */ 110 /* fixup rx packet (strip framing) */
113 int (*rx_fixup)(struct usbnet *dev 111 int (*rx_fixup)(struct usbnet *dev, struct sk_buff *skb);
114 112
115 /* fixup tx packet (add framing) */ 113 /* fixup tx packet (add framing) */
116 struct sk_buff *(*tx_fixup)(struct us 114 struct sk_buff *(*tx_fixup)(struct usbnet *dev,
117 struct sk_buff 115 struct sk_buff *skb, gfp_t flags);
118 116
119 /* early initialization code, can slee 117 /* early initialization code, can sleep. This is for minidrivers
120 * having 'subminidrivers' that need t 118 * having 'subminidrivers' that need to do extra initialization
121 * right after minidriver have initial 119 * right after minidriver have initialized hardware. */
122 int (*early_init)(struct usbnet *d 120 int (*early_init)(struct usbnet *dev);
123 121
124 /* called by minidriver when link stat 122 /* called by minidriver when link state changes, state: 0=disconnect,
125 * 1=connect */ 123 * 1=connect */
126 void (*link_change)(struct usbnet * 124 void (*link_change)(struct usbnet *dev, int state);
127 125
128 /* for new devices, use the descriptor 126 /* for new devices, use the descriptor-reading code instead */
129 int in; /* rx 127 int in; /* rx endpoint */
130 int out; /* tx 128 int out; /* tx endpoint */
131 129
132 unsigned long data; /* Mis 130 unsigned long data; /* Misc driver specific data */
133 }; 131 };
134 132
135 /* Minidrivers are just drivers using the "usb 133 /* Minidrivers are just drivers using the "usbnet" core as a powerful
136 * network-specific subroutine library ... tha 134 * network-specific subroutine library ... that happens to do pretty
137 * much everything except custom framing and c 135 * much everything except custom framing and chip-specific stuff.
138 */ 136 */
139 extern int usbnet_probe(struct usb_interface * 137 extern int usbnet_probe(struct usb_interface *, const struct usb_device_id *);
140 extern int usbnet_suspend (struct usb_interfac 138 extern int usbnet_suspend (struct usb_interface *, pm_message_t );
141 extern int usbnet_resume (struct usb_interface 139 extern int usbnet_resume (struct usb_interface *);
142 extern void usbnet_disconnect(struct usb_inter 140 extern void usbnet_disconnect(struct usb_interface *);
143 141
144 142
145 /* Drivers that reuse some of the standard USB 143 /* Drivers that reuse some of the standard USB CDC infrastructure
146 * (notably, using multiple interfaces accordi 144 * (notably, using multiple interfaces according to the CDC
147 * union descriptor) get some helper code. 145 * union descriptor) get some helper code.
148 */ 146 */
149 struct cdc_state { 147 struct cdc_state {
150 struct usb_cdc_header_desc *heade 148 struct usb_cdc_header_desc *header;
151 struct usb_cdc_union_desc *u; 149 struct usb_cdc_union_desc *u;
152 struct usb_cdc_ether_desc *ether 150 struct usb_cdc_ether_desc *ether;
153 struct usb_interface *contr 151 struct usb_interface *control;
154 struct usb_interface *data; 152 struct usb_interface *data;
155 }; 153 };
156 154
157 extern int usbnet_generic_cdc_bind (struct usb 155 extern int usbnet_generic_cdc_bind (struct usbnet *, struct usb_interface *);
158 extern void usbnet_cdc_unbind (struct usbnet * 156 extern void usbnet_cdc_unbind (struct usbnet *, struct usb_interface *);
159 157
160 /* CDC and RNDIS support the same host-chosen 158 /* CDC and RNDIS support the same host-chosen packet filters for IN transfers */
161 #define DEFAULT_FILTER (USB_CDC_PACKET_TYPE_B 159 #define DEFAULT_FILTER (USB_CDC_PACKET_TYPE_BROADCAST \
162 |USB_CDC_PACKET_TYPE_A 160 |USB_CDC_PACKET_TYPE_ALL_MULTICAST \
163 |USB_CDC_PACKET_TYPE_P 161 |USB_CDC_PACKET_TYPE_PROMISCUOUS \
164 |USB_CDC_PACKET_TYPE_D 162 |USB_CDC_PACKET_TYPE_DIRECTED)
165 163
166 164
167 /* we record the state for each of our queued 165 /* we record the state for each of our queued skbs */
168 enum skb_state { 166 enum skb_state {
169 illegal = 0, 167 illegal = 0,
170 tx_start, tx_done, 168 tx_start, tx_done,
171 rx_start, rx_done, rx_cleanup 169 rx_start, rx_done, rx_cleanup
172 }; 170 };
173 171
174 struct skb_data { /* skb->cb is one of t 172 struct skb_data { /* skb->cb is one of these */
175 struct urb *urb; 173 struct urb *urb;
176 struct usbnet *dev; 174 struct usbnet *dev;
177 enum skb_state state; 175 enum skb_state state;
178 size_t length; 176 size_t length;
179 }; 177 };
180 178
>> 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);
181 184
182 extern int usbnet_get_endpoints(struct usbnet 185 extern int usbnet_get_endpoints(struct usbnet *, struct usb_interface *);
>> 186 extern int usbnet_get_ethernet_addr(struct usbnet *, int);
183 extern void usbnet_defer_kevent (struct usbnet 187 extern void usbnet_defer_kevent (struct usbnet *, int);
184 extern void usbnet_skb_return (struct usbnet * 188 extern void usbnet_skb_return (struct usbnet *, struct sk_buff *);
185 extern void usbnet_unlink_rx_urbs(struct usbne 189 extern void usbnet_unlink_rx_urbs(struct usbnet *);
186 190
187 extern int usbnet_get_settings (struct net_dev 191 extern int usbnet_get_settings (struct net_device *net, struct ethtool_cmd *cmd);
188 extern int usbnet_set_settings (struct net_dev 192 extern int usbnet_set_settings (struct net_device *net, struct ethtool_cmd *cmd);
189 extern u32 usbnet_get_link (struct net_device 193 extern u32 usbnet_get_link (struct net_device *net);
190 extern u32 usbnet_get_msglevel (struct net_dev 194 extern u32 usbnet_get_msglevel (struct net_device *);
191 extern void usbnet_set_msglevel (struct net_de 195 extern void usbnet_set_msglevel (struct net_device *, u32);
192 extern void usbnet_get_drvinfo (struct net_dev 196 extern void usbnet_get_drvinfo (struct net_device *, struct ethtool_drvinfo *);
193 extern int usbnet_nway_reset(struct net_device 197 extern int usbnet_nway_reset(struct net_device *net);
194 198
195 /* messaging support includes the interface na 199 /* messaging support includes the interface name, so it must not be
196 * used before it has one ... notably, in mini 200 * used before it has one ... notably, in minidriver bind() calls.
197 */ 201 */
198 #ifdef DEBUG 202 #ifdef DEBUG
199 #define devdbg(usbnet, fmt, arg...) \ 203 #define devdbg(usbnet, fmt, arg...) \
200 printk(KERN_DEBUG "%s: " fmt "\n" , (u 204 printk(KERN_DEBUG "%s: " fmt "\n" , (usbnet)->net->name , ## arg)
201 #else 205 #else
202 #define devdbg(usbnet, fmt, arg...) do {} whil !! 206 #define devdbg(usbnet, fmt, arg...) \
>> 207 ({ if (0) printk(KERN_DEBUG "%s: " fmt "\n" , (usbnet)->net->name , \
>> 208 ## arg); 0; })
203 #endif 209 #endif
204 210
205 #define deverr(usbnet, fmt, arg...) \ 211 #define deverr(usbnet, fmt, arg...) \
206 printk(KERN_ERR "%s: " fmt "\n" , (usb 212 printk(KERN_ERR "%s: " fmt "\n" , (usbnet)->net->name , ## arg)
207 #define devwarn(usbnet, fmt, arg...) \ 213 #define devwarn(usbnet, fmt, arg...) \
208 printk(KERN_WARNING "%s: " fmt "\n" , 214 printk(KERN_WARNING "%s: " fmt "\n" , (usbnet)->net->name , ## arg)
209 215
210 #define devinfo(usbnet, fmt, arg...) \ 216 #define devinfo(usbnet, fmt, arg...) \
211 printk(KERN_INFO "%s: " fmt "\n" , (us 217 printk(KERN_INFO "%s: " fmt "\n" , (usbnet)->net->name , ## arg); \
212 218
213 219
214 #endif /* __USBNET_H */ !! 220 #endif /* __LINUX_USB_USBNET_H */
215 221
|
This page was automatically generated by the
LXR engine.
|