aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/net/usb/usbnet.h
diff options
context:
space:
mode:
Diffstat (limited to 'drivers/net/usb/usbnet.h')
-rw-r--r--drivers/net/usb/usbnet.h200
1 files changed, 200 insertions, 0 deletions
diff --git a/drivers/net/usb/usbnet.h b/drivers/net/usb/usbnet.h
new file mode 100644
index 000000000000..82db5a8e528e
--- /dev/null
+++ b/drivers/net/usb/usbnet.h
@@ -0,0 +1,200 @@
1/*
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 */
28struct usbnet {
29 /* housekeeping */
30 struct usb_device *udev;
31 struct driver_info *driver_info;
32 const char *driver_name;
33 wait_queue_head_t *wait;
34 struct mutex phy_mutex;
35
36 /* i/o info: pipes etc */
37 unsigned in, out;
38 struct usb_host_endpoint *status;
39 unsigned maxpacket;
40 struct timer_list delay;
41
42 /* protocol/interface state */
43 struct net_device *net;
44 struct net_device_stats stats;
45 int msg_enable;
46 unsigned long data [5];
47 u32 xid;
48 u32 hard_mtu; /* count any extra framing */
49 size_t rx_urb_size; /* size for rx urbs */
50 struct mii_if_info mii;
51
52 /* various kinds of pending driver work */
53 struct sk_buff_head rxq;
54 struct sk_buff_head txq;
55 struct sk_buff_head done;
56 struct urb *interrupt;
57 struct tasklet_struct bh;
58
59 struct work_struct kevent;
60 unsigned long flags;
61# define EVENT_TX_HALT 0
62# define EVENT_RX_HALT 1
63# define EVENT_RX_MEMORY 2
64# define EVENT_STS_SPLIT 3
65# define EVENT_LINK_RESET 4
66};
67
68static inline struct usb_driver *driver_of(struct usb_interface *intf)
69{
70 return to_usb_driver(intf->dev.driver);
71}
72
73/* interface from the device/framing level "minidriver" to core */
74struct driver_info {
75 char *description;
76
77 int flags;
78/* framing is CDC Ethernet, not writing ZLPs (hw issues), or optionally: */
79#define FLAG_FRAMING_NC 0x0001 /* guard against device dropouts */
80#define FLAG_FRAMING_GL 0x0002 /* genelink batches packets */
81#define FLAG_FRAMING_Z 0x0004 /* zaurus adds a trailer */
82#define FLAG_FRAMING_RN 0x0008 /* RNDIS batches, plus huge header */
83
84#define FLAG_NO_SETINT 0x0010 /* device can't set_interface() */
85#define FLAG_ETHER 0x0020 /* maybe use "eth%d" names */
86
87#define FLAG_FRAMING_AX 0x0040 /* AX88772/178 packets */
88
89 /* init device ... can sleep, or cause probe() failure */
90 int (*bind)(struct usbnet *, struct usb_interface *);
91
92 /* cleanup device ... can sleep, but can't fail */
93 void (*unbind)(struct usbnet *, struct usb_interface *);
94
95 /* reset device ... can sleep */
96 int (*reset)(struct usbnet *);
97
98 /* see if peer is connected ... can sleep */
99 int (*check_connect)(struct usbnet *);
100
101 /* for status polling */
102 void (*status)(struct usbnet *, struct urb *);
103
104 /* link reset handling, called from defer_kevent */
105 int (*link_reset)(struct usbnet *);
106
107 /* fixup rx packet (strip framing) */
108 int (*rx_fixup)(struct usbnet *dev, struct sk_buff *skb);
109
110 /* fixup tx packet (add framing) */
111 struct sk_buff *(*tx_fixup)(struct usbnet *dev,
112 struct sk_buff *skb, gfp_t flags);
113
114 /* for new devices, use the descriptor-reading code instead */
115 int in; /* rx endpoint */
116 int out; /* tx endpoint */
117
118 unsigned long data; /* Misc driver specific data */
119};
120
121/* Minidrivers are just drivers using the "usbnet" core as a powerful
122 * network-specific subroutine library ... that happens to do pretty
123 * much everything except custom framing and chip-specific stuff.
124 */
125extern int usbnet_probe(struct usb_interface *, const struct usb_device_id *);
126extern int usbnet_suspend (struct usb_interface *, pm_message_t );
127extern int usbnet_resume (struct usb_interface *);
128extern void usbnet_disconnect(struct usb_interface *);
129
130
131/* Drivers that reuse some of the standard USB CDC infrastructure
132 * (notably, using multiple interfaces according to the CDC
133 * union descriptor) get some helper code.
134 */
135struct cdc_state {
136 struct usb_cdc_header_desc *header;
137 struct usb_cdc_union_desc *u;
138 struct usb_cdc_ether_desc *ether;
139 struct usb_interface *control;
140 struct usb_interface *data;
141};
142
143extern int usbnet_generic_cdc_bind (struct usbnet *, struct usb_interface *);
144extern void usbnet_cdc_unbind (struct usbnet *, struct usb_interface *);
145
146/* CDC and RNDIS support the same host-chosen packet filters for IN transfers */
147#define DEFAULT_FILTER (USB_CDC_PACKET_TYPE_BROADCAST \
148 |USB_CDC_PACKET_TYPE_ALL_MULTICAST \
149 |USB_CDC_PACKET_TYPE_PROMISCUOUS \
150 |USB_CDC_PACKET_TYPE_DIRECTED)
151
152
153/* we record the state for each of our queued skbs */
154enum skb_state {
155 illegal = 0,
156 tx_start, tx_done,
157 rx_start, rx_done, rx_cleanup
158};
159
160struct skb_data { /* skb->cb is one of these */
161 struct urb *urb;
162 struct usbnet *dev;
163 enum skb_state state;
164 size_t length;
165};
166
167
168extern int usbnet_get_endpoints(struct usbnet *, struct usb_interface *);
169extern void usbnet_defer_kevent (struct usbnet *, int);
170extern void usbnet_skb_return (struct usbnet *, struct sk_buff *);
171extern void usbnet_unlink_rx_urbs(struct usbnet *);
172
173extern int usbnet_get_settings (struct net_device *net, struct ethtool_cmd *cmd);
174extern int usbnet_set_settings (struct net_device *net, struct ethtool_cmd *cmd);
175extern u32 usbnet_get_link (struct net_device *net);
176extern u32 usbnet_get_msglevel (struct net_device *);
177extern void usbnet_set_msglevel (struct net_device *, u32);
178extern void usbnet_get_drvinfo (struct net_device *, struct ethtool_drvinfo *);
179extern int usbnet_nway_reset(struct net_device *net);
180
181/* messaging support includes the interface name, so it must not be
182 * used before it has one ... notably, in minidriver bind() calls.
183 */
184#ifdef DEBUG
185#define devdbg(usbnet, fmt, arg...) \
186 printk(KERN_DEBUG "%s: " fmt "\n" , (usbnet)->net->name , ## arg)
187#else
188#define devdbg(usbnet, fmt, arg...) do {} while(0)
189#endif
190
191#define deverr(usbnet, fmt, arg...) \
192 printk(KERN_ERR "%s: " fmt "\n" , (usbnet)->net->name , ## arg)
193#define devwarn(usbnet, fmt, arg...) \
194 printk(KERN_WARNING "%s: " fmt "\n" , (usbnet)->net->name , ## arg)
195
196#define devinfo(usbnet, fmt, arg...) \
197 printk(KERN_INFO "%s: " fmt "\n" , (usbnet)->net->name , ## arg); \
198
199
200#endif /* __USBNET_H */
generated by cgit v1.2.2 (git 2.25.0) at 2024-12-22 12:41:46 -0500