358 lines · c
1// SPDX-License-Identifier: GPL-2.0-or-later2/*3 * Simple "CDC Subset" USB Networking Links4 * Copyright (C) 2000-2005 by David Brownell5 */6 7#include <linux/module.h>8#include <linux/kmod.h>9#include <linux/netdevice.h>10#include <linux/etherdevice.h>11#include <linux/ethtool.h>12#include <linux/workqueue.h>13#include <linux/mii.h>14#include <linux/usb.h>15#include <linux/usb/usbnet.h>16 17 18/*19 * This supports simple USB network links that don't require any special20 * framing or hardware control operations. The protocol used here is a21 * strict subset of CDC Ethernet, with three basic differences reflecting22 * the goal that almost any hardware should run it:23 *24 * - Minimal runtime control: one interface, no altsettings, and25 * no vendor or class specific control requests. If a device is26 * configured, it is allowed to exchange packets with the host.27 * Fancier models would mean not working on some hardware.28 *29 * - Minimal manufacturing control: no IEEE "Organizationally30 * Unique ID" required, or an EEPROMs to store one. Each host uses31 * one random "locally assigned" Ethernet address instead, which can32 * of course be overridden using standard tools like "ifconfig".33 * (With 2^46 such addresses, same-net collisions are quite rare.)34 *35 * - There is no additional framing data for USB. Packets are written36 * exactly as in CDC Ethernet, starting with an Ethernet header and37 * terminated by a short packet. However, the host will never send a38 * zero length packet; some systems can't handle those robustly.39 *40 * Anything that can transmit and receive USB bulk packets can implement41 * this protocol. That includes both smart peripherals and quite a lot42 * of "host-to-host" USB cables (which embed two devices back-to-back).43 *44 * Note that although Linux may use many of those host-to-host links45 * with this "cdc_subset" framing, that doesn't mean there may not be a46 * better approach. Handling the "other end unplugs/replugs" scenario47 * well tends to require chip-specific vendor requests. Also, Windows48 * peers at the other end of host-to-host cables may expect their own49 * framing to be used rather than this "cdc_subset" model.50 */51 52#if defined(CONFIG_USB_EPSON2888) || defined(CONFIG_USB_ARMLINUX)53/* PDA style devices are always connected if present */54static int always_connected (struct usbnet *dev)55{56 return 0;57}58#endif59 60#ifdef CONFIG_USB_ALI_M563261#define HAVE_HARDWARE62 63/*-------------------------------------------------------------------------64 *65 * ALi M5632 driver ... does high speed66 *67 * NOTE that the MS-Windows drivers for this chip use some funky and68 * (naturally) undocumented 7-byte prefix to each packet, so this is a69 * case where we don't currently interoperate. Also, once you unplug70 * one end of the cable, you need to replug the other end too ... since71 * chip docs are unavailable, there's no way to reset the relevant state72 * short of a power cycle.73 *74 *-------------------------------------------------------------------------*/75 76static void m5632_recover(struct usbnet *dev)77{78 struct usb_device *udev = dev->udev;79 struct usb_interface *intf = dev->intf;80 int r;81 82 r = usb_lock_device_for_reset(udev, intf);83 if (r < 0)84 return;85 86 usb_reset_device(udev);87 usb_unlock_device(udev);88}89 90static const struct driver_info ali_m5632_info = {91 .description = "ALi M5632",92 .flags = FLAG_POINTTOPOINT,93 .recover = m5632_recover,94};95 96#endif97 98#ifdef CONFIG_USB_AN272099#define HAVE_HARDWARE100 101/*-------------------------------------------------------------------------102 *103 * AnchorChips 2720 driver ... http://www.cypress.com104 *105 * This doesn't seem to have a way to detect whether the peer is106 * connected, or need any reset handshaking. It's got pretty big107 * internal buffers (handles most of a frame's worth of data).108 * Chip data sheets don't describe any vendor control messages.109 *110 *-------------------------------------------------------------------------*/111 112static const struct driver_info an2720_info = {113 .description = "AnchorChips/Cypress 2720",114 .flags = FLAG_POINTTOPOINT,115 // no reset available!116 // no check_connect available!117 118 .in = 2, .out = 2, // direction distinguishes these119};120 121#endif /* CONFIG_USB_AN2720 */122 123 124#ifdef CONFIG_USB_BELKIN125#define HAVE_HARDWARE126 127/*-------------------------------------------------------------------------128 *129 * Belkin F5U104 ... two NetChip 2280 devices + Atmel AVR microcontroller130 *131 * ... also two eTEK designs, including one sold as "Advance USBNET"132 *133 *-------------------------------------------------------------------------*/134 135static const struct driver_info belkin_info = {136 .description = "Belkin, eTEK, or compatible",137 .flags = FLAG_POINTTOPOINT,138};139 140#endif /* CONFIG_USB_BELKIN */141 142 143 144#ifdef CONFIG_USB_EPSON2888145#define HAVE_HARDWARE146 147/*-------------------------------------------------------------------------148 *149 * EPSON USB clients150 *151 * This is the same idea as Linux PDAs (below) except the firmware in the152 * device might not be Tux-powered. Epson provides reference firmware that153 * implements this interface. Product developers can reuse or modify that154 * code, such as by using their own product and vendor codes.155 *156 * Support was from Juro Bystricky <bystricky.juro@erd.epson.com>157 *158 *-------------------------------------------------------------------------*/159 160static const struct driver_info epson2888_info = {161 .description = "Epson USB Device",162 .check_connect = always_connected,163 .flags = FLAG_POINTTOPOINT,164 165 .in = 4, .out = 3,166};167 168#endif /* CONFIG_USB_EPSON2888 */169 170 171/*-------------------------------------------------------------------------172 *173 * info from Jonathan McDowell <noodles@earth.li>174 *175 *-------------------------------------------------------------------------*/176#ifdef CONFIG_USB_KC2190177#define HAVE_HARDWARE178static const struct driver_info kc2190_info = {179 .description = "KC Technology KC-190",180 .flags = FLAG_POINTTOPOINT,181};182#endif /* CONFIG_USB_KC2190 */183 184 185#ifdef CONFIG_USB_ARMLINUX186#define HAVE_HARDWARE187 188/*-------------------------------------------------------------------------189 *190 * Intel's SA-1100 chip integrates basic USB support, and is used191 * 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 to193 * network using minimal USB framing data.194 *195 * This describes the driver currently in standard ARM Linux kernels.196 * The Zaurus uses a different driver (see later).197 *198 * PXA25x and PXA210 use XScale cores (ARM v5TE) with better USB support199 * and different USB endpoint numbering than the SA1100 devices. The200 * mach-pxa/usb-eth.c driver re-uses the device ids from mach-sa1100201 * so we rely on the endpoint descriptors.202 *203 *-------------------------------------------------------------------------*/204 205static const struct driver_info linuxdev_info = {206 .description = "Linux Device",207 .check_connect = always_connected,208 .flags = FLAG_POINTTOPOINT,209};210 211static const struct driver_info yopy_info = {212 .description = "Yopy",213 .check_connect = always_connected,214 .flags = FLAG_POINTTOPOINT,215};216 217static const struct driver_info blob_info = {218 .description = "Boot Loader OBject",219 .check_connect = always_connected,220 .flags = FLAG_POINTTOPOINT,221};222 223#endif /* CONFIG_USB_ARMLINUX */224 225 226/*-------------------------------------------------------------------------*/227 228#ifndef HAVE_HARDWARE229#warning You need to configure some hardware for this driver230#endif231 232/*233 * chip vendor names won't normally be on the cables, and234 * may not be on the device.235 */236 237static const struct usb_device_id products [] = {238 239#ifdef CONFIG_USB_ALI_M5632240{241 USB_DEVICE (0x0402, 0x5632), // ALi defaults242 .driver_info = (unsigned long) &ali_m5632_info,243},244{245 USB_DEVICE (0x182d,0x207c), // SiteCom CN-124246 .driver_info = (unsigned long) &ali_m5632_info,247},248#endif249 250#ifdef CONFIG_USB_AN2720251{252 USB_DEVICE (0x0547, 0x2720), // AnchorChips defaults253 .driver_info = (unsigned long) &an2720_info,254}, {255 USB_DEVICE (0x0547, 0x2727), // Xircom PGUNET256 .driver_info = (unsigned long) &an2720_info,257},258#endif259 260#ifdef CONFIG_USB_BELKIN261{262 USB_DEVICE (0x050d, 0x0004), // Belkin263 .driver_info = (unsigned long) &belkin_info,264}, {265 USB_DEVICE (0x056c, 0x8100), // eTEK266 .driver_info = (unsigned long) &belkin_info,267}, {268 USB_DEVICE (0x0525, 0x9901), // Advance USBNET (eTEK)269 .driver_info = (unsigned long) &belkin_info,270},271#endif272 273#ifdef CONFIG_USB_EPSON2888274{275 USB_DEVICE (0x0525, 0x2888), // EPSON USB client276 .driver_info = (unsigned long) &epson2888_info,277},278#endif279 280#ifdef CONFIG_USB_KC2190281{282 USB_DEVICE (0x050f, 0x0190), // KC-190283 .driver_info = (unsigned long) &kc2190_info,284},285#endif286 287#ifdef CONFIG_USB_ARMLINUX288/*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.292 *293 * PXA25x or PXA210 ... these use a "usb-eth" driver much like294 * the sa1100 one, but hardware uses different endpoint numbers.295 *296 * Or the Linux "Ethernet" gadget on hardware that can't talk297 * CDC Ethernet (e.g., no altsettings), in either of two modes:298 * - acting just like the old "usb-eth" firmware, though299 * the implementation is different300 * - supporting RNDIS as the first/default configuration for301 * MS-Windows interop; Linux needs to use the other config302 */303{304 // 1183 = 0x049F, both used as hex values?305 // Compaq "Itsy" vendor/product id306 USB_DEVICE (0x049F, 0x505A), // usb-eth, or compatible307 .driver_info = (unsigned long) &linuxdev_info,308}, {309 USB_DEVICE (0x0E7E, 0x1001), // G.Mate "Yopy"310 .driver_info = (unsigned long) &yopy_info,311}, {312 USB_DEVICE (0x8086, 0x07d3), // "blob" bootloader313 .driver_info = (unsigned long) &blob_info,314}, {315 USB_DEVICE (0x1286, 0x8001), // "blob" bootloader316 .driver_info = (unsigned long) &blob_info,317}, {318 // Linux Ethernet/RNDIS gadget, mostly on PXA, second config319 // e.g. Gumstix, current OpenZaurus, ... or anything else320 // that just enables this gadget option.321 USB_DEVICE (0x0525, 0xa4a2),322 .driver_info = (unsigned long) &linuxdev_info,323},324#endif325 326 { }, // END327};328MODULE_DEVICE_TABLE(usb, products);329 330/*-------------------------------------------------------------------------*/331static int dummy_prereset(struct usb_interface *intf)332{333 return 0;334}335 336static int dummy_postreset(struct usb_interface *intf)337{338 return 0;339}340 341static struct usb_driver cdc_subset_driver = {342 .name = "cdc_subset",343 .probe = usbnet_probe,344 .suspend = usbnet_suspend,345 .resume = usbnet_resume,346 .pre_reset = dummy_prereset,347 .post_reset = dummy_postreset,348 .disconnect = usbnet_disconnect,349 .id_table = products,350 .disable_hub_initiated_lpm = 1,351};352 353module_usb_driver(cdc_subset_driver);354 355MODULE_AUTHOR("David Brownell");356MODULE_DESCRIPTION("Simple 'CDC Subset' USB networking links");357MODULE_LICENSE("GPL");358