drivers/net/usb/cdc_subset.c

   1 /*
   2  * Simple "CDC Subset" USB Networking Links
   3  * Copyright (C) 2000-2005 by David Brownell
   4  *
   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.
   9  *
  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.
  14  *
  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/>.
  17  */
  18
  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>
  28
  29
  30 /*
  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:
  35  *
  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.
  40  *
  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.)
  46  *
  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.
  51  *
  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).
  55  *
  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.
  62  */
  63
  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)
  67 {
  68         return 0;
  69 }
  70 #endif
  71
  72 #ifdef  CONFIG_USB_ALI_M5632
  73 #define HAVE_HARDWARE
  74
  75 /*-------------------------------------------------------------------------
  76  *
  77  * ALi M5632 driver ... does high speed
  78  *
  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.
  85  *
  86  *-------------------------------------------------------------------------*/
  87
  88 static const struct driver_info ali_m5632_info = {
  89         .description =  "ALi M5632",
  90         .flags       = FLAG_POINTTOPOINT,
  91 };
  92
  93 #endif
  94
  95 \f
  96 #ifdef  CONFIG_USB_AN2720
  97 #define HAVE_HARDWARE
  98
  99 /*-------------------------------------------------------------------------
 100  *
 101  * AnchorChips 2720 driver ... http://www.cypress.com
 102  *
 103  * This doesn't seem to have a way to detect whether the peer is
 104  * connected, or need any reset handshaking.  It's got pretty big
 105  * internal buffers (handles most of a frame's worth of data).
 106  * Chip data sheets don't describe any vendor control messages.
 107  *
 108  *-------------------------------------------------------------------------*/
 109
 110 static const struct driver_info an2720_info = {
 111         .description =  "AnchorChips/Cypress 2720",
 112         .flags       = FLAG_POINTTOPOINT,
 113         // no reset available!
 114         // no check_connect available!
 115
 116         .in = 2, .out = 2,              // direction distinguishes these
 117 };
 118
 119 #endif  /* CONFIG_USB_AN2720 */
 120
 121 \f
 122 #ifdef  CONFIG_USB_BELKIN
 123 #define HAVE_HARDWARE
 124
 125 /*-------------------------------------------------------------------------
 126  *
 127  * Belkin F5U104 ... two NetChip 2280 devices + Atmel AVR microcontroller
 128  *
 129  * ... also two eTEK designs, including one sold as "Advance USBNET"
 130  *
 131  *-------------------------------------------------------------------------*/
 132
 133 static const struct driver_info belkin_info = {
 134         .description =  "Belkin, eTEK, or compatible",
 135         .flags       = FLAG_POINTTOPOINT,
 136 };
 137
 138 #endif  /* CONFIG_USB_BELKIN */
 139
 140
 141 \f
 142 #ifdef  CONFIG_USB_EPSON2888
 143 #define HAVE_HARDWARE
 144
 145 /*-------------------------------------------------------------------------
 146  *
 147  * EPSON USB clients
 148  *
 149  * This is the same idea as Linux PDAs (below) except the firmware in the
 150  * device might not be Tux-powered.  Epson provides reference firmware that
 151  * implements this interface.  Product developers can reuse or modify that
 152  * code, such as by using their own product and vendor codes.
 153  *
 154  * Support was from Juro Bystricky <bystricky.juro@erd.epson.com>
 155  *
 156  *-------------------------------------------------------------------------*/
 157
 158 static const struct driver_info epson2888_info = {
 159         .description =  "Epson USB Device",
 160         .check_connect = always_connected,
 161         .flags = FLAG_POINTTOPOINT,
 162
 163         .in = 4, .out = 3,
 164 };
 165
 166 #endif  /* CONFIG_USB_EPSON2888 */
 167
 168 \f
 169 /*-------------------------------------------------------------------------
 170  *
 171  * info from Jonathan McDowell <noodles@earth.li>
 172  *
 173  *-------------------------------------------------------------------------*/
 174 #ifdef CONFIG_USB_KC2190
 175 #define HAVE_HARDWARE
 176 static const struct driver_info kc2190_info = {
 177         .description =  "KC Technology KC-190",
 178         .flags = FLAG_POINTTOPOINT,
 179 };
 180 #endif /* CONFIG_USB_KC2190 */
 181
 182 \f
 183 #ifdef  CONFIG_USB_ARMLINUX
 184 #define HAVE_HARDWARE
 185
 186 /*-------------------------------------------------------------------------
 187  *
 188  * Intel's SA-1100 chip integrates basic USB support, and is used
 189  * in PDAs like some iPaqs, the Yopy, some Zaurus models, and more.
 190  * When they run Linux, arch/arm/mach-sa1100/usb-eth.c may be used to
 191  * network using minimal USB framing data.
 192  *
 193  * This describes the driver currently in standard ARM Linux kernels.
 194  * The Zaurus uses a different driver (see later).
 195  *
 196  * PXA25x and PXA210 use XScale cores (ARM v5TE) with better USB support
 197  * and different USB endpoint numbering than the SA1100 devices.  The
 198  * mach-pxa/usb-eth.c driver re-uses the device ids from mach-sa1100
 199  * so we rely on the endpoint descriptors.
 200  *
 201  *-------------------------------------------------------------------------*/
 202
 203 static const struct driver_info linuxdev_info = {
 204         .description =  "Linux Device",
 205         .check_connect = always_connected,
 206         .flags = FLAG_POINTTOPOINT,
 207 };
 208
 209 static const struct driver_info yopy_info = {
 210         .description =  "Yopy",
 211         .check_connect = always_connected,
 212         .flags = FLAG_POINTTOPOINT,
 213 };
 214
 215 static const struct driver_info blob_info = {
 216         .description =  "Boot Loader OBject",
 217         .check_connect = always_connected,
 218         .flags = FLAG_POINTTOPOINT,
 219 };
 220
 221 #endif  /* CONFIG_USB_ARMLINUX */
 222
 223 \f
 224 /*-------------------------------------------------------------------------*/
 225
 226 #ifndef HAVE_HARDWARE
 227 #warning You need to configure some hardware for this driver
 228 #endif
 229
 230 /*
 231  * chip vendor names won't normally be on the cables, and
 232  * may not be on the device.
 233  */
 234
 235 static const struct usb_device_id       products [] = {
 236
 237 #ifdef  CONFIG_USB_ALI_M5632
 238 {
 239         USB_DEVICE (0x0402, 0x5632),    // ALi defaults
 240         .driver_info =  (unsigned long) &ali_m5632_info,
 241 },
 242 {
 243         USB_DEVICE (0x182d,0x207c),     // SiteCom CN-124
 244         .driver_info =  (unsigned long) &ali_m5632_info,
 245 },
 246 #endif
 247
 248 #ifdef  CONFIG_USB_AN2720
 249 {
 250         USB_DEVICE (0x0547, 0x2720),    // AnchorChips defaults
 251         .driver_info =  (unsigned long) &an2720_info,
 252 }, {
 253         USB_DEVICE (0x0547, 0x2727),    // Xircom PGUNET
 254         .driver_info =  (unsigned long) &an2720_info,
 255 },
 256 #endif
 257
 258 #ifdef  CONFIG_USB_BELKIN
 259 {
 260         USB_DEVICE (0x050d, 0x0004),    // Belkin
 261         .driver_info =  (unsigned long) &belkin_info,
 262 }, {
 263         USB_DEVICE (0x056c, 0x8100),    // eTEK
 264         .driver_info =  (unsigned long) &belkin_info,
 265 }, {
 266         USB_DEVICE (0x0525, 0x9901),    // Advance USBNET (eTEK)
 267         .driver_info =  (unsigned long) &belkin_info,
 268 },
 269 #endif
 270
 271 #ifdef  CONFIG_USB_EPSON2888
 272 {
 273         USB_DEVICE (0x0525, 0x2888),    // EPSON USB client
 274         .driver_info    = (unsigned long) &epson2888_info,
 275 },
 276 #endif
 277
 278 #ifdef CONFIG_USB_KC2190
 279 {
 280         USB_DEVICE (0x050f, 0x0190),    // KC-190
 281         .driver_info =  (unsigned long) &kc2190_info,
 282 },
 283 #endif
 284
 285 #ifdef  CONFIG_USB_ARMLINUX
 286 /*
 287  * SA-1100 using standard ARM Linux kernels, or compatible.
 288  * Often used when talking to Linux PDAs (iPaq, Yopy, etc).
 289  * The sa-1100 "usb-eth" driver handles the basic framing.
 290  *
 291  * PXA25x or PXA210 ...  these use a "usb-eth" driver much like
 292  * the sa1100 one, but hardware uses different endpoint numbers.
 293  *
 294  * Or the Linux "Ethernet" gadget on hardware that can't talk
 295  * CDC Ethernet (e.g., no altsettings), in either of two modes:
 296  *  - acting just like the old "usb-eth" firmware, though
 297  *    the implementation is different
 298  *  - supporting RNDIS as the first/default configuration for
 299  *    MS-Windows interop; Linux needs to use the other config
 300  */
 301 {
 302         // 1183 = 0x049F, both used as hex values?
 303         // Compaq "Itsy" vendor/product id
 304         USB_DEVICE (0x049F, 0x505A),    // usb-eth, or compatible
 305         .driver_info =  (unsigned long) &linuxdev_info,
 306 }, {
 307         USB_DEVICE (0x0E7E, 0x1001),    // G.Mate "Yopy"
 308         .driver_info =  (unsigned long) &yopy_info,
 309 }, {
 310         USB_DEVICE (0x8086, 0x07d3),    // "blob" bootloader
 311         .driver_info =  (unsigned long) &blob_info,
 312 }, {
 313         USB_DEVICE (0x1286, 0x8001),    // "blob" bootloader
 314         .driver_info =  (unsigned long) &blob_info,
 315 }, {
 316         // Linux Ethernet/RNDIS gadget, mostly on PXA, second config
 317         // e.g. Gumstix, current OpenZaurus, ... or anything else
 318         // that just enables this gadget option.
 319         USB_DEVICE (0x0525, 0xa4a2),
 320         .driver_info =  (unsigned long) &linuxdev_info,
 321 },
 322 #endif
 323
 324         { },            // END
 325 };
 326 MODULE_DEVICE_TABLE(usb, products);
 327
 328 /*-------------------------------------------------------------------------*/
 329
 330 static struct usb_driver cdc_subset_driver = {
 331         .name =         "cdc_subset",
 332         .probe =        usbnet_probe,
 333         .suspend =      usbnet_suspend,
 334         .resume =       usbnet_resume,
 335         .disconnect =   usbnet_disconnect,
 336         .id_table =     products,
 337         .disable_hub_initiated_lpm = 1,
 338 };
 339
 340 module_usb_driver(cdc_subset_driver);
 341
 342 MODULE_AUTHOR("David Brownell");
 343 MODULE_DESCRIPTION("Simple 'CDC Subset' USB networking links");
 344 MODULE_LICENSE("GPL");