2 * Simple "CDC Subset" USB Networking Links
3 * Copyright (C) 2000-2005 by David Brownell
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, see <http://www.gnu.org/licenses/>.
19 #include <linux/module.h>
20 #include <linux/kmod.h>
21 #include <linux/netdevice.h>
22 #include <linux/etherdevice.h>
23 #include <linux/ethtool.h>
24 #include <linux/workqueue.h>
25 #include <linux/mii.h>
26 #include <linux/usb.h>
27 #include <linux/usb/usbnet.h>
31 * This supports simple USB network links that don't require any special
32 * framing or hardware control operations. The protocol used here is a
33 * strict subset of CDC Ethernet, with three basic differences reflecting
34 * the goal that almost any hardware should run it:
36 * - Minimal runtime control: one interface, no altsettings, and
37 * no vendor or class specific control requests. If a device is
38 * configured, it is allowed to exchange packets with the host.
39 * Fancier models would mean not working on some hardware.
41 * - Minimal manufacturing control: no IEEE "Organizationally
42 * Unique ID" required, or an EEPROMs to store one. Each host uses
43 * one random "locally assigned" Ethernet address instead, which can
44 * of course be overridden using standard tools like "ifconfig".
45 * (With 2^46 such addresses, same-net collisions are quite rare.)
47 * - There is no additional framing data for USB. Packets are written
48 * exactly as in CDC Ethernet, starting with an Ethernet header and
49 * terminated by a short packet. However, the host will never send a
50 * zero length packet; some systems can't handle those robustly.
52 * Anything that can transmit and receive USB bulk packets can implement
53 * this protocol. That includes both smart peripherals and quite a lot
54 * of "host-to-host" USB cables (which embed two devices back-to-back).
56 * Note that although Linux may use many of those host-to-host links
57 * with this "cdc_subset" framing, that doesn't mean there may not be a
58 * better approach. Handling the "other end unplugs/replugs" scenario
59 * well tends to require chip-specific vendor requests. Also, Windows
60 * peers at the other end of host-to-host cables may expect their own
61 * framing to be used rather than this "cdc_subset" model.
64 #if defined(CONFIG_USB_EPSON2888) || defined(CONFIG_USB_ARMLINUX)
65 /* PDA style devices are always connected if present */
66 static int always_connected (struct usbnet *dev)
72 #ifdef CONFIG_USB_ALI_M5632
75 /*-------------------------------------------------------------------------
77 * ALi M5632 driver ... does high speed
79 * NOTE that the MS-Windows drivers for this chip use some funky and
80 * (naturally) undocumented 7-byte prefix to each packet, so this is a
81 * case where we don't currently interoperate. Also, once you unplug
82 * one end of the cable, you need to replug the other end too ... since
83 * chip docs are unavailable, there's no way to reset the relevant state
84 * short of a power cycle.
86 *-------------------------------------------------------------------------*/
88 static void m5632_recover(struct usbnet *dev)
90 struct usb_device *udev = dev->udev;
91 struct usb_interface *intf = dev->intf;
94 r = usb_lock_device_for_reset(udev, intf);
98 usb_reset_device(udev);
99 usb_unlock_device(udev);
102 static int dummy_prereset(struct usb_interface *intf)
107 static int dummy_postreset(struct usb_interface *intf)
112 static const struct driver_info ali_m5632_info = {
113 .description = "ALi M5632",
114 .flags = FLAG_POINTTOPOINT,
115 .recover = m5632_recover,
121 #ifdef CONFIG_USB_AN2720
122 #define HAVE_HARDWARE
124 /*-------------------------------------------------------------------------
126 * AnchorChips 2720 driver ... http://www.cypress.com
128 * This doesn't seem to have a way to detect whether the peer is
129 * connected, or need any reset handshaking. It's got pretty big
130 * internal buffers (handles most of a frame's worth of data).
131 * Chip data sheets don't describe any vendor control messages.
133 *-------------------------------------------------------------------------*/
135 static const struct driver_info an2720_info = {
136 .description = "AnchorChips/Cypress 2720",
137 .flags = FLAG_POINTTOPOINT,
138 // no reset available!
139 // no check_connect available!
141 .in = 2, .out = 2, // direction distinguishes these
144 #endif /* CONFIG_USB_AN2720 */
147 #ifdef CONFIG_USB_BELKIN
148 #define HAVE_HARDWARE
150 /*-------------------------------------------------------------------------
152 * Belkin F5U104 ... two NetChip 2280 devices + Atmel AVR microcontroller
154 * ... also two eTEK designs, including one sold as "Advance USBNET"
156 *-------------------------------------------------------------------------*/
158 static const struct driver_info belkin_info = {
159 .description = "Belkin, eTEK, or compatible",
160 .flags = FLAG_POINTTOPOINT,
163 #endif /* CONFIG_USB_BELKIN */
167 #ifdef CONFIG_USB_EPSON2888
168 #define HAVE_HARDWARE
170 /*-------------------------------------------------------------------------
174 * This is the same idea as Linux PDAs (below) except the firmware in the
175 * device might not be Tux-powered. Epson provides reference firmware that
176 * implements this interface. Product developers can reuse or modify that
177 * code, such as by using their own product and vendor codes.
179 * Support was from Juro Bystricky <bystricky.juro@erd.epson.com>
181 *-------------------------------------------------------------------------*/
183 static const struct driver_info epson2888_info = {
184 .description = "Epson USB Device",
185 .check_connect = always_connected,
186 .flags = FLAG_POINTTOPOINT,
191 #endif /* CONFIG_USB_EPSON2888 */
194 /*-------------------------------------------------------------------------
196 * info from Jonathan McDowell <noodles@earth.li>
198 *-------------------------------------------------------------------------*/
199 #ifdef CONFIG_USB_KC2190
200 #define HAVE_HARDWARE
201 static const struct driver_info kc2190_info = {
202 .description = "KC Technology KC-190",
203 .flags = FLAG_POINTTOPOINT,
205 #endif /* CONFIG_USB_KC2190 */
208 #ifdef CONFIG_USB_ARMLINUX
209 #define HAVE_HARDWARE
211 /*-------------------------------------------------------------------------
213 * Intel's SA-1100 chip integrates basic USB support, and is used
214 * in PDAs like some iPaqs, the Yopy, some Zaurus models, and more.
215 * When they run Linux, arch/arm/mach-sa1100/usb-eth.c may be used to
216 * network using minimal USB framing data.
218 * This describes the driver currently in standard ARM Linux kernels.
219 * The Zaurus uses a different driver (see later).
221 * PXA25x and PXA210 use XScale cores (ARM v5TE) with better USB support
222 * and different USB endpoint numbering than the SA1100 devices. The
223 * mach-pxa/usb-eth.c driver re-uses the device ids from mach-sa1100
224 * so we rely on the endpoint descriptors.
226 *-------------------------------------------------------------------------*/
228 static const struct driver_info linuxdev_info = {
229 .description = "Linux Device",
230 .check_connect = always_connected,
231 .flags = FLAG_POINTTOPOINT,
234 static const struct driver_info yopy_info = {
235 .description = "Yopy",
236 .check_connect = always_connected,
237 .flags = FLAG_POINTTOPOINT,
240 static const struct driver_info blob_info = {
241 .description = "Boot Loader OBject",
242 .check_connect = always_connected,
243 .flags = FLAG_POINTTOPOINT,
246 #endif /* CONFIG_USB_ARMLINUX */
249 /*-------------------------------------------------------------------------*/
251 #ifndef HAVE_HARDWARE
252 #warning You need to configure some hardware for this driver
256 * chip vendor names won't normally be on the cables, and
257 * may not be on the device.
260 static const struct usb_device_id products [] = {
262 #ifdef CONFIG_USB_ALI_M5632
264 USB_DEVICE (0x0402, 0x5632), // ALi defaults
265 .driver_info = (unsigned long) &ali_m5632_info,
268 USB_DEVICE (0x182d,0x207c), // SiteCom CN-124
269 .driver_info = (unsigned long) &ali_m5632_info,
273 #ifdef CONFIG_USB_AN2720
275 USB_DEVICE (0x0547, 0x2720), // AnchorChips defaults
276 .driver_info = (unsigned long) &an2720_info,
278 USB_DEVICE (0x0547, 0x2727), // Xircom PGUNET
279 .driver_info = (unsigned long) &an2720_info,
283 #ifdef CONFIG_USB_BELKIN
285 USB_DEVICE (0x050d, 0x0004), // Belkin
286 .driver_info = (unsigned long) &belkin_info,
288 USB_DEVICE (0x056c, 0x8100), // eTEK
289 .driver_info = (unsigned long) &belkin_info,
291 USB_DEVICE (0x0525, 0x9901), // Advance USBNET (eTEK)
292 .driver_info = (unsigned long) &belkin_info,
296 #ifdef CONFIG_USB_EPSON2888
298 USB_DEVICE (0x0525, 0x2888), // EPSON USB client
299 .driver_info = (unsigned long) &epson2888_info,
303 #ifdef CONFIG_USB_KC2190
305 USB_DEVICE (0x050f, 0x0190), // KC-190
306 .driver_info = (unsigned long) &kc2190_info,
310 #ifdef CONFIG_USB_ARMLINUX
312 * SA-1100 using standard ARM Linux kernels, or compatible.
313 * Often used when talking to Linux PDAs (iPaq, Yopy, etc).
314 * The sa-1100 "usb-eth" driver handles the basic framing.
316 * PXA25x or PXA210 ... these use a "usb-eth" driver much like
317 * the sa1100 one, but hardware uses different endpoint numbers.
319 * Or the Linux "Ethernet" gadget on hardware that can't talk
320 * CDC Ethernet (e.g., no altsettings), in either of two modes:
321 * - acting just like the old "usb-eth" firmware, though
322 * the implementation is different
323 * - supporting RNDIS as the first/default configuration for
324 * MS-Windows interop; Linux needs to use the other config
327 // 1183 = 0x049F, both used as hex values?
328 // Compaq "Itsy" vendor/product id
329 USB_DEVICE (0x049F, 0x505A), // usb-eth, or compatible
330 .driver_info = (unsigned long) &linuxdev_info,
332 USB_DEVICE (0x0E7E, 0x1001), // G.Mate "Yopy"
333 .driver_info = (unsigned long) &yopy_info,
335 USB_DEVICE (0x8086, 0x07d3), // "blob" bootloader
336 .driver_info = (unsigned long) &blob_info,
338 USB_DEVICE (0x1286, 0x8001), // "blob" bootloader
339 .driver_info = (unsigned long) &blob_info,
341 // Linux Ethernet/RNDIS gadget, mostly on PXA, second config
342 // e.g. Gumstix, current OpenZaurus, ... or anything else
343 // that just enables this gadget option.
344 USB_DEVICE (0x0525, 0xa4a2),
345 .driver_info = (unsigned long) &linuxdev_info,
351 MODULE_DEVICE_TABLE(usb, products);
353 /*-------------------------------------------------------------------------*/
355 static struct usb_driver cdc_subset_driver = {
356 .name = "cdc_subset",
357 .probe = usbnet_probe,
358 .suspend = usbnet_suspend,
359 .resume = usbnet_resume,
360 .pre_reset = dummy_prereset,
361 .post_reset = dummy_postreset,
362 .disconnect = usbnet_disconnect,
363 .id_table = products,
364 .disable_hub_initiated_lpm = 1,
367 module_usb_driver(cdc_subset_driver);
369 MODULE_AUTHOR("David Brownell");
370 MODULE_DESCRIPTION("Simple 'CDC Subset' USB networking links");
371 MODULE_LICENSE("GPL");