blob: 37252d0012a77ae6ef616c3db23065e0beee6b84 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * ether.c -- Ethernet gadget driver, with CDC and non-CDC options
3 *
David Brownell0391c822008-06-19 18:20:11 -07004 * Copyright (C) 2003-2005,2008 David Brownell
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 * Copyright (C) 2003-2004 Robert Schwebel, Benedikt Spranger
David Brownell0391c822008-06-19 18:20:11 -07006 * Copyright (C) 2008 Nokia Corporation
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 */
22
David Brownell0cf4f2d2007-08-02 00:00:38 -070023/* #define VERBOSE_DEBUG */
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/kernel.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#include <linux/utsname.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027
David Brownell0391c822008-06-19 18:20:11 -070028#include "u_ether.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
31/*
32 * Ethernet gadget driver -- with CDC and non-CDC options
33 * Builds on hardware support for a full duplex link.
34 *
35 * CDC Ethernet is the standard USB solution for sending Ethernet frames
36 * using USB. Real hardware tends to use the same framing protocol but look
37 * different for control features. This driver strongly prefers to use
38 * this USB-IF standard as its open-systems interoperability solution;
39 * most host side USB stacks (except from Microsoft) support it.
40 *
David Brownell0391c822008-06-19 18:20:11 -070041 * This is sometimes called "CDC ECM" (Ethernet Control Model) to support
42 * TLA-soup. "CDC ACM" (Abstract Control Model) is for modems, and a new
43 * "CDC EEM" (Ethernet Emulation Model) is starting to spread.
44 *
45 * There's some hardware that can't talk CDC ECM. We make that hardware
Linus Torvalds1da177e2005-04-16 15:20:36 -070046 * implement a "minimalist" vendor-agnostic CDC core: same framing, but
David Brownell11d54892006-12-11 15:59:04 -080047 * link-level setup only requires activating the configuration. Only the
48 * endpoint descriptors, and product/vendor IDs, are relevant; no control
49 * operations are available. Linux supports it, but other host operating
50 * systems may not. (This is a subset of CDC Ethernet.)
51 *
52 * It turns out that if you add a few descriptors to that "CDC Subset",
53 * (Windows) host side drivers from MCCI can treat it as one submode of
54 * a proprietary scheme called "SAFE" ... without needing to know about
55 * specific product/vendor IDs. So we do that, making it easier to use
56 * those MS-Windows drivers. Those added descriptors make it resemble a
57 * CDC MDLM device, but they don't change device behavior at all. (See
58 * MCCI Engineering report 950198 "SAFE Networking Functions".)
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 *
60 * A third option is also in use. Rather than CDC Ethernet, or something
61 * simpler, Microsoft pushes their own approach: RNDIS. The published
62 * RNDIS specs are ambiguous and appear to be incomplete, and are also
David Brownell0391c822008-06-19 18:20:11 -070063 * needlessly complex. They borrow more from CDC ACM than CDC ECM.
Linus Torvalds1da177e2005-04-16 15:20:36 -070064 */
65
66#define DRIVER_DESC "Ethernet Gadget"
David Brownell0391c822008-06-19 18:20:11 -070067#define DRIVER_VERSION "Memorial Day 2008"
Linus Torvalds1da177e2005-04-16 15:20:36 -070068
David Brownell0391c822008-06-19 18:20:11 -070069#ifdef CONFIG_USB_ETH_RNDIS
70#define PREFIX "RNDIS/"
71#else
72#define PREFIX ""
Linus Torvalds1da177e2005-04-16 15:20:36 -070073#endif
74
David Brownell0391c822008-06-19 18:20:11 -070075/*
76 * This driver aims for interoperability by using CDC ECM unless
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 *
David Brownell0391c822008-06-19 18:20:11 -070078 * can_support_ecm()
79 *
80 * returns false, in which case it supports the CDC Subset. By default,
81 * that returns true; most hardware has no problems with CDC ECM, that's
82 * a good default. Previous versions of this driver had no default; this
83 * version changes that, removing overhead for new controller support.
84 *
85 * IF YOUR HARDWARE CAN'T SUPPORT CDC ECM, UPDATE THAT ROUTINE!
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070087
David Brownell0391c822008-06-19 18:20:11 -070088static inline bool has_rndis(void)
89{
90#ifdef CONFIG_USB_ETH_RNDIS
91 return true;
92#else
93 return false;
94#endif
95}
96
Linus Torvalds1da177e2005-04-16 15:20:36 -070097/*-------------------------------------------------------------------------*/
98
David Brownell33376c12008-08-18 17:45:07 -070099/*
100 * Kbuild is not very cooperative with respect to linking separately
101 * compiled library objects into one module. So for now we won't use
102 * separate compilation ... ensuring init/exit sections work to shrink
103 * the runtime footprint, and giving us at least some parts of what
104 * a "gcc --combine ... part1.c part2.c part3.c ... " build would.
105 */
106#include "composite.c"
107#include "usbstring.c"
108#include "config.c"
109#include "epautoconf.c"
110
111#include "f_ecm.c"
112#include "f_subset.c"
113#ifdef CONFIG_USB_ETH_RNDIS
114#include "f_rndis.c"
115#include "rndis.c"
116#endif
117#include "u_ether.c"
118
119/*-------------------------------------------------------------------------*/
120
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121/* DO NOT REUSE THESE IDs with a protocol-incompatible driver!! Ever!!
122 * Instead: allocate your own, using normal USB-IF procedures.
123 */
124
125/* Thanks to NetChip Technologies for donating this product ID.
126 * It's for devices with only CDC Ethernet configurations.
127 */
David Brownell0391c822008-06-19 18:20:11 -0700128#define CDC_VENDOR_NUM 0x0525 /* NetChip */
129#define CDC_PRODUCT_NUM 0xa4a1 /* Linux-USB Ethernet Gadget */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130
131/* For hardware that can't talk CDC, we use the same vendor ID that
132 * ARM Linux has used for ethernet-over-usb, both with sa1100 and
133 * with pxa250. We're protocol-compatible, if the host-side drivers
134 * use the endpoint descriptors. bcdDevice (version) is nonzero, so
135 * drivers that need to hard-wire endpoint numbers have a hook.
136 *
137 * The protocol is a minimal subset of CDC Ether, which works on any bulk
138 * hardware that's not deeply broken ... even on hardware that can't talk
139 * RNDIS (like SA-1100, with no interrupt endpoint, or anything that
140 * doesn't handle control-OUT).
141 */
142#define SIMPLE_VENDOR_NUM 0x049f
143#define SIMPLE_PRODUCT_NUM 0x505a
144
145/* For hardware that can talk RNDIS and either of the above protocols,
146 * use this ID ... the windows INF files will know it. Unless it's
147 * used with CDC Ethernet, Linux 2.4 hosts will need updates to choose
148 * the non-RNDIS configuration.
149 */
150#define RNDIS_VENDOR_NUM 0x0525 /* NetChip */
151#define RNDIS_PRODUCT_NUM 0xa4a2 /* Ethernet/RNDIS Gadget */
152
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153/*-------------------------------------------------------------------------*/
154
David Brownell0391c822008-06-19 18:20:11 -0700155static struct usb_device_descriptor device_desc = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 .bLength = sizeof device_desc,
157 .bDescriptorType = USB_DT_DEVICE,
158
159 .bcdUSB = __constant_cpu_to_le16 (0x0200),
160
161 .bDeviceClass = USB_CLASS_COMM,
162 .bDeviceSubClass = 0,
163 .bDeviceProtocol = 0,
David Brownell0391c822008-06-19 18:20:11 -0700164 /* .bMaxPacketSize0 = f(hardware) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165
David Brownell0391c822008-06-19 18:20:11 -0700166 /* Vendor and product id defaults change according to what configs
167 * we support. (As does bNumConfigurations.) These values can
168 * also be overridden by module parameters.
169 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 .idVendor = __constant_cpu_to_le16 (CDC_VENDOR_NUM),
171 .idProduct = __constant_cpu_to_le16 (CDC_PRODUCT_NUM),
David Brownell0391c822008-06-19 18:20:11 -0700172 /* .bcdDevice = f(hardware) */
173 /* .iManufacturer = DYNAMIC */
174 /* .iProduct = DYNAMIC */
175 /* NO SERIAL NUMBER */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 .bNumConfigurations = 1,
177};
178
David Brownell0391c822008-06-19 18:20:11 -0700179static struct usb_otg_descriptor otg_descriptor = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 .bLength = sizeof otg_descriptor,
181 .bDescriptorType = USB_DT_OTG,
182
David Brownell0391c822008-06-19 18:20:11 -0700183 /* REVISIT SRP-only hardware is possible, although
184 * it would not be called "OTG" ...
185 */
186 .bmAttributes = USB_OTG_SRP | USB_OTG_HNP,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187};
188
David Brownell0391c822008-06-19 18:20:11 -0700189static const struct usb_descriptor_header *otg_desc[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 (struct usb_descriptor_header *) &otg_descriptor,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 NULL,
192};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194
David Brownell0391c822008-06-19 18:20:11 -0700195/* string IDs are assigned dynamically */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196
David Brownell0391c822008-06-19 18:20:11 -0700197#define STRING_MANUFACTURER_IDX 0
198#define STRING_PRODUCT_IDX 1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
David Brownell0391c822008-06-19 18:20:11 -0700200static char manufacturer[50];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201
David Brownell0391c822008-06-19 18:20:11 -0700202static struct usb_string strings_dev[] = {
203 [STRING_MANUFACTURER_IDX].s = manufacturer,
204 [STRING_PRODUCT_IDX].s = PREFIX DRIVER_DESC,
205 { } /* end of list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206};
207
David Brownell0391c822008-06-19 18:20:11 -0700208static struct usb_gadget_strings stringtab_dev = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 .language = 0x0409, /* en-us */
David Brownell0391c822008-06-19 18:20:11 -0700210 .strings = strings_dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211};
212
David Brownell0391c822008-06-19 18:20:11 -0700213static struct usb_gadget_strings *dev_strings[] = {
214 &stringtab_dev,
215 NULL,
216};
217
218static u8 hostaddr[ETH_ALEN];
219
220/*-------------------------------------------------------------------------*/
221
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222/*
David Brownell0391c822008-06-19 18:20:11 -0700223 * We may not have an RNDIS configuration, but if we do it needs to be
224 * the first one present. That's to make Microsoft's drivers happy,
225 * and to follow DOCSIS 1.0 (cable modem standard).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226 */
David Brownell0391c822008-06-19 18:20:11 -0700227static int __init rndis_do_config(struct usb_configuration *c)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228{
David Brownell0391c822008-06-19 18:20:11 -0700229 /* FIXME alloc iConfiguration string, set it in c->strings */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
David Brownell0391c822008-06-19 18:20:11 -0700231 if (gadget_is_otg(c->cdev->gadget)) {
232 c->descriptors = otg_desc;
233 c->bmAttributes |= USB_CONFIG_ATT_WAKEUP;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 }
235
David Brownell0391c822008-06-19 18:20:11 -0700236 return rndis_bind_config(c, hostaddr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237}
238
David Brownell0391c822008-06-19 18:20:11 -0700239static struct usb_configuration rndis_config_driver = {
240 .label = "RNDIS",
241 .bind = rndis_do_config,
242 .bConfigurationValue = 2,
243 /* .iConfiguration = DYNAMIC */
244 .bmAttributes = USB_CONFIG_ATT_SELFPOWER,
David Brownell0391c822008-06-19 18:20:11 -0700245};
246
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247/*-------------------------------------------------------------------------*/
248
David Brownell0391c822008-06-19 18:20:11 -0700249/*
250 * We _always_ have an ECM or CDC Subset configuration.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251 */
David Brownell0391c822008-06-19 18:20:11 -0700252static int __init eth_do_config(struct usb_configuration *c)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253{
David Brownell0391c822008-06-19 18:20:11 -0700254 /* FIXME alloc iConfiguration string, set it in c->strings */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255
David Brownell0391c822008-06-19 18:20:11 -0700256 if (gadget_is_otg(c->cdev->gadget)) {
257 c->descriptors = otg_desc;
258 c->bmAttributes |= USB_CONFIG_ATT_WAKEUP;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 }
260
David Brownell0391c822008-06-19 18:20:11 -0700261 if (can_support_ecm(c->cdev->gadget))
262 return ecm_bind_config(c, hostaddr);
263 else
264 return geth_bind_config(c, hostaddr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265}
266
David Brownell0391c822008-06-19 18:20:11 -0700267static struct usb_configuration eth_config_driver = {
268 /* .label = f(hardware) */
269 .bind = eth_do_config,
270 .bConfigurationValue = 1,
271 /* .iConfiguration = DYNAMIC */
272 .bmAttributes = USB_CONFIG_ATT_SELFPOWER,
David Brownell0391c822008-06-19 18:20:11 -0700273};
274
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275/*-------------------------------------------------------------------------*/
276
David Brownell0391c822008-06-19 18:20:11 -0700277static int __init eth_bind(struct usb_composite_dev *cdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278{
David Brownell0391c822008-06-19 18:20:11 -0700279 int gcnum;
280 struct usb_gadget *gadget = cdev->gadget;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 int status;
David Brownell7e27f182006-06-13 09:54:40 -0700282
David Brownell0391c822008-06-19 18:20:11 -0700283 /* set up network link layer */
284 status = gether_setup(cdev->gadget, hostaddr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285 if (status < 0)
David Brownell0391c822008-06-19 18:20:11 -0700286 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287
David Brownell0391c822008-06-19 18:20:11 -0700288 /* set up main config label and device descriptor */
289 if (can_support_ecm(cdev->gadget)) {
290 /* ECM */
291 eth_config_driver.label = "CDC Ethernet (ECM)";
292 } else {
293 /* CDC Subset */
294 eth_config_driver.label = "CDC Subset/SAFE";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295
David Brownell0391c822008-06-19 18:20:11 -0700296 device_desc.idVendor = cpu_to_le16(SIMPLE_VENDOR_NUM),
297 device_desc.idProduct = cpu_to_le16(SIMPLE_PRODUCT_NUM),
298 device_desc.bDeviceClass = USB_CLASS_VENDOR_SPEC;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299 }
300
David Brownell0391c822008-06-19 18:20:11 -0700301 if (has_rndis()) {
302 /* RNDIS plus ECM-or-Subset */
303 device_desc.idVendor = cpu_to_le16(RNDIS_VENDOR_NUM),
304 device_desc.idProduct = cpu_to_le16(RNDIS_PRODUCT_NUM),
305 device_desc.bNumConfigurations = 2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 }
307
David Brownell0391c822008-06-19 18:20:11 -0700308 gcnum = usb_gadget_controller_number(gadget);
David Brownell91e79c92005-07-13 15:18:30 -0700309 if (gcnum >= 0)
David Brownell0391c822008-06-19 18:20:11 -0700310 device_desc.bcdDevice = cpu_to_le16(0x0300 | gcnum);
David Brownell91e79c92005-07-13 15:18:30 -0700311 else {
David Brownell0391c822008-06-19 18:20:11 -0700312 /* We assume that can_support_ecm() tells the truth;
313 * but if the controller isn't recognized at all then
314 * that assumption is a bit more likely to be wrong.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 */
David Brownell33376c12008-08-18 17:45:07 -0700316 dev_warn(&gadget->dev,
317 "controller '%s' not recognized; trying %s\n",
David Brownell0391c822008-06-19 18:20:11 -0700318 gadget->name,
319 eth_config_driver.label);
320 device_desc.bcdDevice =
321 __constant_cpu_to_le16(0x0300 | 0x0099);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 }
David Brownell0391c822008-06-19 18:20:11 -0700323
324
325 /* Allocate string descriptor numbers ... note that string
326 * contents can be overridden by the composite_dev glue.
327 */
328
329 /* device descriptor strings: manufacturer, product */
330 snprintf(manufacturer, sizeof manufacturer, "%s %s with %s",
Serge E. Hallyn96b644b2006-10-02 02:18:13 -0700331 init_utsname()->sysname, init_utsname()->release,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332 gadget->name);
David Brownell0391c822008-06-19 18:20:11 -0700333 status = usb_string_id(cdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 if (status < 0)
David Brownell0391c822008-06-19 18:20:11 -0700335 goto fail;
336 strings_dev[STRING_MANUFACTURER_IDX].id = status;
337 device_desc.iManufacturer = status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338
David Brownell0391c822008-06-19 18:20:11 -0700339 status = usb_string_id(cdev);
340 if (status < 0)
341 goto fail;
342 strings_dev[STRING_PRODUCT_IDX].id = status;
343 device_desc.iProduct = status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344
David Brownell0391c822008-06-19 18:20:11 -0700345 /* register our configuration(s); RNDIS first, if it's used */
346 if (has_rndis()) {
347 status = usb_add_config(cdev, &rndis_config_driver);
348 if (status < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 goto fail;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351
David Brownell0391c822008-06-19 18:20:11 -0700352 status = usb_add_config(cdev, &eth_config_driver);
353 if (status < 0)
354 goto fail;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355
David Brownell33376c12008-08-18 17:45:07 -0700356 dev_info(&gadget->dev, "%s, version: " DRIVER_VERSION "\n",
357 DRIVER_DESC);
David Brownell0391c822008-06-19 18:20:11 -0700358
359 return 0;
360
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361fail:
David Brownell0391c822008-06-19 18:20:11 -0700362 gether_cleanup();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 return status;
364}
365
David Brownell0391c822008-06-19 18:20:11 -0700366static int __exit eth_unbind(struct usb_composite_dev *cdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367{
David Brownell0391c822008-06-19 18:20:11 -0700368 gether_cleanup();
369 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370}
371
David Brownell0391c822008-06-19 18:20:11 -0700372static struct usb_composite_driver eth_driver = {
373 .name = "g_ether",
374 .dev = &device_desc,
375 .strings = dev_strings,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 .bind = eth_bind,
David Brownell0391c822008-06-19 18:20:11 -0700377 .unbind = __exit_p(eth_unbind),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378};
379
David Brownell0391c822008-06-19 18:20:11 -0700380MODULE_DESCRIPTION(PREFIX DRIVER_DESC);
381MODULE_AUTHOR("David Brownell, Benedikt Spanger");
382MODULE_LICENSE("GPL");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383
David Brownell0391c822008-06-19 18:20:11 -0700384static int __init init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385{
David Brownell0391c822008-06-19 18:20:11 -0700386 return usb_composite_register(&eth_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387}
David Brownell0391c822008-06-19 18:20:11 -0700388module_init(init);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389
David Brownell0391c822008-06-19 18:20:11 -0700390static void __exit cleanup(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391{
David Brownell0391c822008-06-19 18:20:11 -0700392 usb_composite_unregister(&eth_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393}
David Brownell0391c822008-06-19 18:20:11 -0700394module_exit(cleanup);