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, write to the Free Software
17
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
#include <linux/module.h>
21
#include <linux/kmod.h>
22
#include <linux/init.h>
23
#include <linux/netdevice.h>
24
#include <linux/etherdevice.h>
25
#include <linux/ethtool.h>
26
#include <linux/workqueue.h>
27
#include <linux/mii.h>
28
#include <linux/usb.h>
29
#include <linux/usb/usbnet.h>
33
* This supports simple USB network links that don't require any special
34
* framing or hardware control operations. The protocol used here is a
35
* strict subset of CDC Ethernet, with three basic differences reflecting
36
* the goal that almost any hardware should run it:
38
* - Minimal runtime control: one interface, no altsettings, and
39
* no vendor or class specific control requests. If a device is
40
* configured, it is allowed to exchange packets with the host.
41
* Fancier models would mean not working on some hardware.
43
* - Minimal manufacturing control: no IEEE "Organizationally
44
* Unique ID" required, or an EEPROMs to store one. Each host uses
45
* one random "locally assigned" Ethernet address instead, which can
46
* of course be overridden using standard tools like "ifconfig".
47
* (With 2^46 such addresses, same-net collisions are quite rare.)
49
* - There is no additional framing data for USB. Packets are written
50
* exactly as in CDC Ethernet, starting with an Ethernet header and
51
* terminated by a short packet. However, the host will never send a
52
* zero length packet; some systems can't handle those robustly.
54
* Anything that can transmit and receive USB bulk packets can implement
55
* this protocol. That includes both smart peripherals and quite a lot
56
* of "host-to-host" USB cables (which embed two devices back-to-back).
58
* Note that although Linux may use many of those host-to-host links
59
* with this "cdc_subset" framing, that doesn't mean there may not be a
60
* better approach. Handling the "other end unplugs/replugs" scenario
61
* well tends to require chip-specific vendor requests. Also, Windows
62
* peers at the other end of host-to-host cables may expect their own
63
* framing to be used rather than this "cdc_subset" model.
66
#if defined(CONFIG_USB_EPSON2888) || defined(CONFIG_USB_ARMLINUX)
67
/* PDA style devices are always connected if present */
68
static int always_connected (struct usbnet *dev)
74
#ifdef CONFIG_USB_ALI_M5632
77
/*-------------------------------------------------------------------------
79
* ALi M5632 driver ... does high speed
81
* NOTE that the MS-Windows drivers for this chip use some funky and
82
* (naturally) undocumented 7-byte prefix to each packet, so this is a
83
* case where we don't currently interoperate. Also, once you unplug
84
* one end of the cable, you need to replug the other end too ... since
85
* chip docs are unavailable, there's no way to reset the relevant state
86
* short of a power cycle.
88
*-------------------------------------------------------------------------*/
90
static const struct driver_info ali_m5632_info = {
91
.description = "ALi M5632",
92
.flags = FLAG_POINTTOPOINT,
98
#ifdef CONFIG_USB_AN2720
101
/*-------------------------------------------------------------------------
103
* AnchorChips 2720 driver ... http://www.cypress.com
105
* This doesn't seem to have a way to detect whether the peer is
106
* connected, or need any reset handshaking. It's got pretty big
107
* internal buffers (handles most of a frame's worth of data).
108
* Chip data sheets don't describe any vendor control messages.
110
*-------------------------------------------------------------------------*/
112
static const struct driver_info an2720_info = {
113
.description = "AnchorChips/Cypress 2720",
114
.flags = FLAG_POINTTOPOINT,
115
// no reset available!
116
// no check_connect available!
118
.in = 2, .out = 2, // direction distinguishes these
121
#endif /* CONFIG_USB_AN2720 */
124
#ifdef CONFIG_USB_BELKIN
125
#define HAVE_HARDWARE
127
/*-------------------------------------------------------------------------
129
* Belkin F5U104 ... two NetChip 2280 devices + Atmel AVR microcontroller
131
* ... also two eTEK designs, including one sold as "Advance USBNET"
133
*-------------------------------------------------------------------------*/
135
static const struct driver_info belkin_info = {
136
.description = "Belkin, eTEK, or compatible",
137
.flags = FLAG_POINTTOPOINT,
140
#endif /* CONFIG_USB_BELKIN */
144
#ifdef CONFIG_USB_EPSON2888
145
#define HAVE_HARDWARE
147
/*-------------------------------------------------------------------------
151
* This is the same idea as Linux PDAs (below) except the firmware in the
152
* device might not be Tux-powered. Epson provides reference firmware that
153
* implements this interface. Product developers can reuse or modify that
154
* code, such as by using their own product and vendor codes.
156
* Support was from Juro Bystricky <bystricky.juro@erd.epson.com>
158
*-------------------------------------------------------------------------*/
160
static const struct driver_info epson2888_info = {
161
.description = "Epson USB Device",
162
.check_connect = always_connected,
163
.flags = FLAG_POINTTOPOINT,
168
#endif /* CONFIG_USB_EPSON2888 */
171
/*-------------------------------------------------------------------------
173
* info from Jonathan McDowell <noodles@earth.li>
175
*-------------------------------------------------------------------------*/
176
#ifdef CONFIG_USB_KC2190
177
#define HAVE_HARDWARE
178
static const struct driver_info kc2190_info = {
179
.description = "KC Technology KC-190",
180
.flags = FLAG_POINTTOPOINT,
182
#endif /* CONFIG_USB_KC2190 */
185
#ifdef CONFIG_USB_ARMLINUX
186
#define HAVE_HARDWARE
188
/*-------------------------------------------------------------------------
190
* Intel's SA-1100 chip integrates basic USB support, and is used
191
* in PDAs like some iPaqs, the Yopy, some Zaurus models, and more.
192
* When they run Linux, arch/arm/mach-sa1100/usb-eth.c may be used to
193
* network using minimal USB framing data.
195
* This describes the driver currently in standard ARM Linux kernels.
196
* The Zaurus uses a different driver (see later).
198
* PXA25x and PXA210 use XScale cores (ARM v5TE) with better USB support
199
* and different USB endpoint numbering than the SA1100 devices. The
200
* mach-pxa/usb-eth.c driver re-uses the device ids from mach-sa1100
201
* so we rely on the endpoint descriptors.
203
*-------------------------------------------------------------------------*/
205
static const struct driver_info linuxdev_info = {
206
.description = "Linux Device",
207
.check_connect = always_connected,
208
.flags = FLAG_POINTTOPOINT,
211
static const struct driver_info yopy_info = {
212
.description = "Yopy",
213
.check_connect = always_connected,
214
.flags = FLAG_POINTTOPOINT,
217
static const struct driver_info blob_info = {
218
.description = "Boot Loader OBject",
219
.check_connect = always_connected,
220
.flags = FLAG_POINTTOPOINT,
223
#endif /* CONFIG_USB_ARMLINUX */
226
/*-------------------------------------------------------------------------*/
228
#ifndef HAVE_HARDWARE
229
#warning You need to configure some hardware for this driver
233
* chip vendor names won't normally be on the cables, and
234
* may not be on the device.
237
static const struct usb_device_id products [] = {
239
#ifdef CONFIG_USB_ALI_M5632
241
USB_DEVICE (0x0402, 0x5632), // ALi defaults
242
.driver_info = (unsigned long) &ali_m5632_info,
245
USB_DEVICE (0x182d,0x207c), // SiteCom CN-124
246
.driver_info = (unsigned long) &ali_m5632_info,
250
#ifdef CONFIG_USB_AN2720
252
USB_DEVICE (0x0547, 0x2720), // AnchorChips defaults
253
.driver_info = (unsigned long) &an2720_info,
255
USB_DEVICE (0x0547, 0x2727), // Xircom PGUNET
256
.driver_info = (unsigned long) &an2720_info,
260
#ifdef CONFIG_USB_BELKIN
262
USB_DEVICE (0x050d, 0x0004), // Belkin
263
.driver_info = (unsigned long) &belkin_info,
265
USB_DEVICE (0x056c, 0x8100), // eTEK
266
.driver_info = (unsigned long) &belkin_info,
268
USB_DEVICE (0x0525, 0x9901), // Advance USBNET (eTEK)
269
.driver_info = (unsigned long) &belkin_info,
273
#ifdef CONFIG_USB_EPSON2888
275
USB_DEVICE (0x0525, 0x2888), // EPSON USB client
276
.driver_info = (unsigned long) &epson2888_info,
280
#ifdef CONFIG_USB_KC2190
282
USB_DEVICE (0x050f, 0x0190), // KC-190
283
.driver_info = (unsigned long) &kc2190_info,
287
#ifdef CONFIG_USB_ARMLINUX
289
* SA-1100 using standard ARM Linux kernels, or compatible.
290
* Often used when talking to Linux PDAs (iPaq, Yopy, etc).
291
* The sa-1100 "usb-eth" driver handles the basic framing.
293
* PXA25x or PXA210 ... these use a "usb-eth" driver much like
294
* the sa1100 one, but hardware uses different endpoint numbers.
296
* Or the Linux "Ethernet" gadget on hardware that can't talk
297
* CDC Ethernet (e.g., no altsettings), in either of two modes:
298
* - acting just like the old "usb-eth" firmware, though
299
* the implementation is different
300
* - supporting RNDIS as the first/default configuration for
301
* MS-Windows interop; Linux needs to use the other config
304
// 1183 = 0x049F, both used as hex values?
305
// Compaq "Itsy" vendor/product id
306
USB_DEVICE (0x049F, 0x505A), // usb-eth, or compatible
307
.driver_info = (unsigned long) &linuxdev_info,
309
USB_DEVICE (0x0E7E, 0x1001), // G.Mate "Yopy"
310
.driver_info = (unsigned long) &yopy_info,
312
USB_DEVICE (0x8086, 0x07d3), // "blob" bootloader
313
.driver_info = (unsigned long) &blob_info,
315
USB_DEVICE (0x1286, 0x8001), // "blob" bootloader
316
.driver_info = (unsigned long) &blob_info,
318
// Linux Ethernet/RNDIS gadget, mostly on PXA, second config
319
// e.g. Gumstix, current OpenZaurus, ... or anything else
320
// that just enables this gadget option.
321
USB_DEVICE (0x0525, 0xa4a2),
322
.driver_info = (unsigned long) &linuxdev_info,
328
MODULE_DEVICE_TABLE(usb, products);
330
/*-------------------------------------------------------------------------*/
332
static struct usb_driver cdc_subset_driver = {
333
.name = "cdc_subset",
334
.probe = usbnet_probe,
335
.suspend = usbnet_suspend,
336
.resume = usbnet_resume,
337
.disconnect = usbnet_disconnect,
338
.id_table = products,
341
static int __init cdc_subset_init(void)
343
return usb_register(&cdc_subset_driver);
345
module_init(cdc_subset_init);
347
static void __exit cdc_subset_exit(void)
349
usb_deregister(&cdc_subset_driver);
351
module_exit(cdc_subset_exit);
353
MODULE_AUTHOR("David Brownell");
354
MODULE_DESCRIPTION("Simple 'CDC Subset' USB networking links");
355
MODULE_LICENSE("GPL");