2 * ether.c -- Ethernet gadget driver, with CDC and non-CDC options
4 * Copyright (C) 2003-2005,2008 David Brownell
5 * Copyright (C) 2003-2004 Robert Schwebel, Benedikt Spranger
6 * Copyright (C) 2008 Nokia Corporation
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.
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.
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
24 #include <asm/errno.h>
25 #include <linux/usb/ch9.h>
26 #include <linux/usb/cdc.h>
27 #include <linux/usb/gadget.h>
29 #include <linux/ctype.h>
31 #include "gadget_chips.h"
33 #define USB_NET_NAME "usb0"
34 #define dprintf(x, ...)
36 #define INFO(x, s...) printf(s)
37 #define dev_err(x, stuff...) printf(stuff)
38 #define dev_dbg dev_err
39 #define dev_warn dev_err
43 extern struct platform_data brd;
45 #define spin_unlock(x)
48 unsigned packet_received, packet_sent;
50 #define DEV_CONFIG_CDC 1
51 #define GFP_ATOMIC ((gfp_t) 0)
52 #define GFP_KERNEL ((gfp_t) 0)
55 * Ethernet gadget driver -- with CDC and non-CDC options
56 * Builds on hardware support for a full duplex link.
58 * CDC Ethernet is the standard USB solution for sending Ethernet frames
59 * using USB. Real hardware tends to use the same framing protocol but look
60 * different for control features. This driver strongly prefers to use
61 * this USB-IF standard as its open-systems interoperability solution;
62 * most host side USB stacks (except from Microsoft) support it.
64 * This is sometimes called "CDC ECM" (Ethernet Control Model) to support
65 * TLA-soup. "CDC ACM" (Abstract Control Model) is for modems, and a new
66 * "CDC EEM" (Ethernet Emulation Model) is starting to spread.
68 * There's some hardware that can't talk CDC ECM. We make that hardware
69 * implement a "minimalist" vendor-agnostic CDC core: same framing, but
70 * link-level setup only requires activating the configuration. Only the
71 * endpoint descriptors, and product/vendor IDs, are relevant; no control
72 * operations are available. Linux supports it, but other host operating
73 * systems may not. (This is a subset of CDC Ethernet.)
75 * It turns out that if you add a few descriptors to that "CDC Subset",
76 * (Windows) host side drivers from MCCI can treat it as one submode of
77 * a proprietary scheme called "SAFE" ... without needing to know about
78 * specific product/vendor IDs. So we do that, making it easier to use
79 * those MS-Windows drivers. Those added descriptors make it resemble a
80 * CDC MDLM device, but they don't change device behavior at all. (See
81 * MCCI Engineering report 950198 "SAFE Networking Functions".)
83 * A third option is also in use. Rather than CDC Ethernet, or something
84 * simpler, Microsoft pushes their own approach: RNDIS. The published
85 * RNDIS specs are ambiguous and appear to be incomplete, and are also
86 * needlessly complex. They borrow more from CDC ACM than CDC ECM.
88 #define ETH_ALEN 6 /* Octets in one ethernet addr */
89 #define ETH_HLEN 14 /* Total octets in header. */
90 #define ETH_ZLEN 60 /* Min. octets in frame sans FCS */
91 #define ETH_DATA_LEN 1500 /* Max. octets in payload */
92 #define ETH_FRAME_LEN PKTSIZE_ALIGN /* Max. octets in frame sans FCS */
93 #define ETH_FCS_LEN 4 /* Octets in the FCS */
95 #define DRIVER_DESC "Ethernet Gadget"
96 /* Based on linux 2.6.27 version */
97 #define DRIVER_VERSION "May Day 2005"
99 static const char shortname [] = "ether";
100 static const char driver_desc [] = DRIVER_DESC;
102 #define RX_EXTRA 20 /* guard against rx overflows */
104 /* CDC support the same host-chosen outgoing packet filters. */
105 #define DEFAULT_FILTER (USB_CDC_PACKET_TYPE_BROADCAST \
106 |USB_CDC_PACKET_TYPE_ALL_MULTICAST \
107 |USB_CDC_PACKET_TYPE_PROMISCUOUS \
108 |USB_CDC_PACKET_TYPE_DIRECTED)
110 #define USB_CONNECT_TIMEOUT (3 * CONFIG_SYS_HZ)
112 /*-------------------------------------------------------------------------*/
113 static struct eth_dev l_ethdev;
114 static struct eth_device l_netdev;
115 static struct usb_gadget_driver eth_driver;
117 /*-------------------------------------------------------------------------*/
119 /* "main" config is either CDC, or its simple subset */
120 static inline int is_cdc(struct eth_dev *dev)
122 #if !defined(DEV_CONFIG_SUBSET)
123 return 1; /* only cdc possible */
124 #elif !defined (DEV_CONFIG_CDC)
125 return 0; /* only subset possible */
127 return dev->cdc; /* depends on what hardware we found */
131 #define subset_active(dev) (!is_cdc(dev))
132 #define cdc_active(dev) ( is_cdc(dev))
134 #define DEFAULT_QLEN 2 /* double buffering by default */
136 /* peak bulk transfer bits-per-second */
137 #define HS_BPS (13 * 512 * 8 * 1000 * 8)
138 #define FS_BPS (19 * 64 * 1 * 1000 * 8)
140 #ifdef CONFIG_USB_GADGET_DUALSPEED
141 #define DEVSPEED USB_SPEED_HIGH
143 /* for dual-speed hardware, use deeper queues at highspeed */
144 #define qlen(gadget) \
145 (DEFAULT_QLEN*((gadget->speed == USB_SPEED_HIGH) ? qmult : 1))
147 static inline int BITRATE(struct usb_gadget *g)
149 return (g->speed == USB_SPEED_HIGH) ? HS_BPS : FS_BPS;
152 #else /* full speed (low speed doesn't do bulk) */
156 #define DEVSPEED USB_SPEED_FULL
158 #define qlen(gadget) DEFAULT_QLEN
160 static inline int BITRATE(struct usb_gadget *g)
167 struct usb_gadget *gadget;
168 struct usb_request *req; /* for control responses */
169 struct usb_request *stat_req; /* for cdc status */
172 struct usb_ep *in_ep, *out_ep, *status_ep;
173 const struct usb_endpoint_descriptor
176 struct usb_request *tx_req, *rx_req;
178 struct eth_device *net;
179 unsigned int tx_qlen;
183 unsigned suspended:1;
184 unsigned network_started:1;
188 #define WORK_RX_MEMORY 0
189 u8 host_mac [ETH_ALEN];
192 /* This version autoconfigures as much as possible at run-time.
194 * It also ASSUMES a self-powered device, without remote wakeup,
195 * although remote wakeup support would make sense.
198 /*-------------------------------------------------------------------------*/
200 /* DO NOT REUSE THESE IDs with a protocol-incompatible driver!! Ever!!
201 * Instead: allocate your own, using normal USB-IF procedures.
204 /* Thanks to NetChip Technologies for donating this product ID.
205 * It's for devices with only CDC Ethernet configurations.
207 #define CDC_VENDOR_NUM 0x0525 /* NetChip */
208 #define CDC_PRODUCT_NUM 0xa4a1 /* Linux-USB Ethernet Gadget */
210 /* For hardware that can't talk CDC, we use the same vendor ID that
211 * ARM Linux has used for ethernet-over-usb, both with sa1100 and
212 * with pxa250. We're protocol-compatible, if the host-side drivers
213 * use the endpoint descriptors. bcdDevice (version) is nonzero, so
214 * drivers that need to hard-wire endpoint numbers have a hook.
216 * The protocol is a minimal subset of CDC Ether, which works on any bulk
217 * hardware that's not deeply broken ... even on hardware that can't talk
218 * RNDIS (like SA-1100, with no interrupt endpoint, or anything that
219 * doesn't handle control-OUT).
221 #define SIMPLE_VENDOR_NUM 0x049f
222 #define SIMPLE_PRODUCT_NUM 0x505a
224 /* Some systems will want different product identifers published in the
225 * device descriptor, either numbers or strings or both. These string
226 * parameters are in UTF-8 (superset of ASCII's 7 bit characters).
229 static ushort bcdDevice;
230 #if defined(CONFIG_USBNET_MANUFACTURER)
231 static char *iManufacturer = CONFIG_USBNET_MANUFACTURER;
233 static char *iManufacturer = "U-boot";
235 static char *iProduct;
236 static char *iSerialNumber;
237 static char dev_addr[18];
238 static char host_addr[18];
240 /*-------------------------------------------------------------------------*/
242 /* USB DRIVER HOOKUP (to the hardware driver, below us), mostly
243 * ep0 implementation: descriptors, config management, setup().
244 * also optional class-specific notification interrupt transfer.
248 * DESCRIPTORS ... most are static, but strings and (full) configuration
249 * descriptors are built on demand. For now we do either full CDC, or
253 #define STRING_MANUFACTURER 1
254 #define STRING_PRODUCT 2
255 #define STRING_ETHADDR 3
256 #define STRING_DATA 4
257 #define STRING_CONTROL 5
259 #define STRING_SUBSET 8
260 #define STRING_SERIALNUMBER 10
262 /* holds our biggest descriptor */
263 #define USB_BUFSIZ 256
266 * This device advertises one configuration, eth_config,
267 * on hardware supporting at least two configs.
269 * FIXME define some higher-powered configurations to make it easier
270 * to recharge batteries ...
273 #define DEV_CONFIG_VALUE 1 /* cdc or subset */
275 static struct usb_device_descriptor
277 .bLength = sizeof device_desc,
278 .bDescriptorType = USB_DT_DEVICE,
280 .bcdUSB = __constant_cpu_to_le16 (0x0200),
282 .bDeviceClass = USB_CLASS_COMM,
283 .bDeviceSubClass = 0,
284 .bDeviceProtocol = 0,
286 .idVendor = __constant_cpu_to_le16 (CDC_VENDOR_NUM),
287 .idProduct = __constant_cpu_to_le16 (CDC_PRODUCT_NUM),
288 .iManufacturer = STRING_MANUFACTURER,
289 .iProduct = STRING_PRODUCT,
290 .bNumConfigurations = 1,
293 static struct usb_otg_descriptor
295 .bLength = sizeof otg_descriptor,
296 .bDescriptorType = USB_DT_OTG,
298 .bmAttributes = USB_OTG_SRP,
301 static struct usb_config_descriptor
303 .bLength = sizeof eth_config,
304 .bDescriptorType = USB_DT_CONFIG,
306 /* compute wTotalLength on the fly */
308 .bConfigurationValue = DEV_CONFIG_VALUE,
309 .iConfiguration = STRING_CDC,
310 .bmAttributes = USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER,
315 * Compared to the simple CDC subset, the full CDC Ethernet model adds
316 * three class descriptors, two interface descriptors, optional status
317 * endpoint. Both have a "data" interface and two bulk endpoints.
318 * There are also differences in how control requests are handled.
321 #ifdef DEV_CONFIG_CDC
322 static struct usb_interface_descriptor
324 .bLength = sizeof control_intf,
325 .bDescriptorType = USB_DT_INTERFACE,
327 .bInterfaceNumber = 0,
328 /* status endpoint is optional; this may be patched later */
330 .bInterfaceClass = USB_CLASS_COMM,
331 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET,
332 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
333 .iInterface = STRING_CONTROL,
337 static const struct usb_cdc_header_desc header_desc = {
338 .bLength = sizeof header_desc,
339 .bDescriptorType = USB_DT_CS_INTERFACE,
340 .bDescriptorSubType = USB_CDC_HEADER_TYPE,
342 .bcdCDC = __constant_cpu_to_le16 (0x0110),
345 #if defined(DEV_CONFIG_CDC)
347 static const struct usb_cdc_union_desc union_desc = {
348 .bLength = sizeof union_desc,
349 .bDescriptorType = USB_DT_CS_INTERFACE,
350 .bDescriptorSubType = USB_CDC_UNION_TYPE,
352 .bMasterInterface0 = 0, /* index of control interface */
353 .bSlaveInterface0 = 1, /* index of DATA interface */
358 #ifndef DEV_CONFIG_CDC
360 /* "SAFE" loosely follows CDC WMC MDLM, violating the spec in various
361 * ways: data endpoints live in the control interface, there's no data
362 * interface, and it's not used to talk to a cell phone radio.
365 static const struct usb_cdc_mdlm_desc mdlm_desc = {
366 .bLength = sizeof mdlm_desc,
367 .bDescriptorType = USB_DT_CS_INTERFACE,
368 .bDescriptorSubType = USB_CDC_MDLM_TYPE,
370 .bcdVersion = __constant_cpu_to_le16(0x0100),
372 0x5d, 0x34, 0xcf, 0x66, 0x11, 0x18, 0x11, 0xd6,
373 0xa2, 0x1a, 0x00, 0x01, 0x02, 0xca, 0x9a, 0x7f,
377 /* since "usb_cdc_mdlm_detail_desc" is a variable length structure, we
378 * can't really use its struct. All we do here is say that we're using
379 * the submode of "SAFE" which directly matches the CDC Subset.
381 static const u8 mdlm_detail_desc[] = {
384 USB_CDC_MDLM_DETAIL_TYPE,
387 0, /* network control capabilities (none) */
388 0, /* network data capabilities ("raw" encapsulation) */
394 static const struct usb_cdc_ether_desc ether_desc = {
395 .bLength = sizeof (ether_desc),
396 .bDescriptorType = USB_DT_CS_INTERFACE,
397 .bDescriptorSubType = USB_CDC_ETHERNET_TYPE,
399 /* this descriptor actually adds value, surprise! */
400 .iMACAddress = STRING_ETHADDR,
401 .bmEthernetStatistics = __constant_cpu_to_le32 (0), /* no statistics */
402 .wMaxSegmentSize = __constant_cpu_to_le16 (ETH_FRAME_LEN),
403 .wNumberMCFilters = __constant_cpu_to_le16 (0),
404 .bNumberPowerFilters = 0,
408 #if defined(DEV_CONFIG_CDC)
410 /* include the status endpoint if we can, even where it's optional.
411 * use wMaxPacketSize big enough to fit CDC_NOTIFY_SPEED_CHANGE in one
412 * packet, to simplify cancellation; and a big transfer interval, to
413 * waste less bandwidth.
415 * some drivers (like Linux 2.4 cdc-ether!) "need" it to exist even
416 * if they ignore the connect/disconnect notifications that real aether
417 * can provide. more advanced cdc configurations might want to support
418 * encapsulated commands (vendor-specific, using control-OUT).
421 #define LOG2_STATUS_INTERVAL_MSEC 5 /* 1 << 5 == 32 msec */
422 #define STATUS_BYTECOUNT 16 /* 8 byte header + data */
424 static struct usb_endpoint_descriptor
426 .bLength = USB_DT_ENDPOINT_SIZE,
427 .bDescriptorType = USB_DT_ENDPOINT,
429 .bEndpointAddress = USB_DIR_IN,
430 .bmAttributes = USB_ENDPOINT_XFER_INT,
431 .wMaxPacketSize = __constant_cpu_to_le16 (STATUS_BYTECOUNT),
432 .bInterval = 1 << LOG2_STATUS_INTERVAL_MSEC,
436 #ifdef DEV_CONFIG_CDC
438 /* the default data interface has no endpoints ... */
440 static const struct usb_interface_descriptor
442 .bLength = sizeof data_nop_intf,
443 .bDescriptorType = USB_DT_INTERFACE,
445 .bInterfaceNumber = 1,
446 .bAlternateSetting = 0,
448 .bInterfaceClass = USB_CLASS_CDC_DATA,
449 .bInterfaceSubClass = 0,
450 .bInterfaceProtocol = 0,
453 /* ... but the "real" data interface has two bulk endpoints */
455 static const struct usb_interface_descriptor
457 .bLength = sizeof data_intf,
458 .bDescriptorType = USB_DT_INTERFACE,
460 .bInterfaceNumber = 1,
461 .bAlternateSetting = 1,
463 .bInterfaceClass = USB_CLASS_CDC_DATA,
464 .bInterfaceSubClass = 0,
465 .bInterfaceProtocol = 0,
466 .iInterface = STRING_DATA,
471 #ifdef DEV_CONFIG_SUBSET
474 * "Simple" CDC-subset option is a simple vendor-neutral model that most
475 * full speed controllers can handle: one interface, two bulk endpoints.
477 * To assist host side drivers, we fancy it up a bit, and add descriptors
478 * so some host side drivers will understand it as a "SAFE" variant.
481 static const struct usb_interface_descriptor
483 .bLength = sizeof subset_data_intf,
484 .bDescriptorType = USB_DT_INTERFACE,
486 .bInterfaceNumber = 0,
487 .bAlternateSetting = 0,
489 .bInterfaceClass = USB_CLASS_COMM,
490 .bInterfaceSubClass = USB_CDC_SUBCLASS_MDLM,
491 .bInterfaceProtocol = 0,
492 .iInterface = STRING_DATA,
498 static struct usb_endpoint_descriptor
500 .bLength = USB_DT_ENDPOINT_SIZE,
501 .bDescriptorType = USB_DT_ENDPOINT,
503 .bEndpointAddress = USB_DIR_IN,
504 .bmAttributes = USB_ENDPOINT_XFER_BULK,
507 static struct usb_endpoint_descriptor
509 .bLength = USB_DT_ENDPOINT_SIZE,
510 .bDescriptorType = USB_DT_ENDPOINT,
512 .bEndpointAddress = USB_DIR_OUT,
513 .bmAttributes = USB_ENDPOINT_XFER_BULK,
516 static const struct usb_descriptor_header *fs_eth_function [11] = {
517 (struct usb_descriptor_header *) &otg_descriptor,
518 #ifdef DEV_CONFIG_CDC
519 /* "cdc" mode descriptors */
520 (struct usb_descriptor_header *) &control_intf,
521 (struct usb_descriptor_header *) &header_desc,
522 (struct usb_descriptor_header *) &union_desc,
523 (struct usb_descriptor_header *) ðer_desc,
524 /* NOTE: status endpoint may need to be removed */
525 (struct usb_descriptor_header *) &fs_status_desc,
526 /* data interface, with altsetting */
527 (struct usb_descriptor_header *) &data_nop_intf,
528 (struct usb_descriptor_header *) &data_intf,
529 (struct usb_descriptor_header *) &fs_source_desc,
530 (struct usb_descriptor_header *) &fs_sink_desc,
532 #endif /* DEV_CONFIG_CDC */
535 static inline void fs_subset_descriptors(void)
537 #ifdef DEV_CONFIG_SUBSET
538 /* behavior is "CDC Subset"; extra descriptors say "SAFE" */
539 fs_eth_function[1] = (struct usb_descriptor_header *) &subset_data_intf;
540 fs_eth_function[2] = (struct usb_descriptor_header *) &header_desc;
541 fs_eth_function[3] = (struct usb_descriptor_header *) &mdlm_desc;
542 fs_eth_function[4] = (struct usb_descriptor_header *) &mdlm_detail_desc;
543 fs_eth_function[5] = (struct usb_descriptor_header *) ðer_desc;
544 fs_eth_function[6] = (struct usb_descriptor_header *) &fs_source_desc;
545 fs_eth_function[7] = (struct usb_descriptor_header *) &fs_sink_desc;
546 fs_eth_function[8] = NULL;
548 fs_eth_function[1] = NULL;
553 * usb 2.0 devices need to expose both high speed and full speed
554 * descriptors, unless they only run at full speed.
557 #if defined(DEV_CONFIG_CDC)
558 static struct usb_endpoint_descriptor
560 .bLength = USB_DT_ENDPOINT_SIZE,
561 .bDescriptorType = USB_DT_ENDPOINT,
563 .bmAttributes = USB_ENDPOINT_XFER_INT,
564 .wMaxPacketSize = __constant_cpu_to_le16 (STATUS_BYTECOUNT),
565 .bInterval = LOG2_STATUS_INTERVAL_MSEC + 4,
567 #endif /* DEV_CONFIG_CDC */
569 static struct usb_endpoint_descriptor
571 .bLength = USB_DT_ENDPOINT_SIZE,
572 .bDescriptorType = USB_DT_ENDPOINT,
574 .bmAttributes = USB_ENDPOINT_XFER_BULK,
575 .wMaxPacketSize = __constant_cpu_to_le16 (512),
578 static struct usb_endpoint_descriptor
580 .bLength = USB_DT_ENDPOINT_SIZE,
581 .bDescriptorType = USB_DT_ENDPOINT,
583 .bmAttributes = USB_ENDPOINT_XFER_BULK,
584 .wMaxPacketSize = __constant_cpu_to_le16 (512),
587 static struct usb_qualifier_descriptor
589 .bLength = sizeof dev_qualifier,
590 .bDescriptorType = USB_DT_DEVICE_QUALIFIER,
592 .bcdUSB = __constant_cpu_to_le16 (0x0200),
593 .bDeviceClass = USB_CLASS_COMM,
595 .bNumConfigurations = 1,
598 static const struct usb_descriptor_header *hs_eth_function [11] = {
599 (struct usb_descriptor_header *) &otg_descriptor,
600 #ifdef DEV_CONFIG_CDC
601 /* "cdc" mode descriptors */
602 (struct usb_descriptor_header *) &control_intf,
603 (struct usb_descriptor_header *) &header_desc,
604 (struct usb_descriptor_header *) &union_desc,
605 (struct usb_descriptor_header *) ðer_desc,
606 /* NOTE: status endpoint may need to be removed */
607 (struct usb_descriptor_header *) &hs_status_desc,
608 /* data interface, with altsetting */
609 (struct usb_descriptor_header *) &data_nop_intf,
610 (struct usb_descriptor_header *) &data_intf,
611 (struct usb_descriptor_header *) &hs_source_desc,
612 (struct usb_descriptor_header *) &hs_sink_desc,
614 #endif /* DEV_CONFIG_CDC */
617 static inline void hs_subset_descriptors(void)
619 #ifdef DEV_CONFIG_SUBSET
620 /* behavior is "CDC Subset"; extra descriptors say "SAFE" */
621 hs_eth_function[1] = (struct usb_descriptor_header *) &subset_data_intf;
622 hs_eth_function[2] = (struct usb_descriptor_header *) &header_desc;
623 hs_eth_function[3] = (struct usb_descriptor_header *) &mdlm_desc;
624 hs_eth_function[4] = (struct usb_descriptor_header *) &mdlm_detail_desc;
625 hs_eth_function[5] = (struct usb_descriptor_header *) ðer_desc;
626 hs_eth_function[6] = (struct usb_descriptor_header *) &hs_source_desc;
627 hs_eth_function[7] = (struct usb_descriptor_header *) &hs_sink_desc;
628 hs_eth_function[8] = NULL;
630 hs_eth_function[1] = NULL;
634 /* maxpacket and other transfer characteristics vary by speed. */
635 static inline struct usb_endpoint_descriptor *
636 ep_desc(struct usb_gadget *g, struct usb_endpoint_descriptor *hs,
637 struct usb_endpoint_descriptor *fs)
639 if (gadget_is_dualspeed(g) && g->speed == USB_SPEED_HIGH)
645 /*-------------------------------------------------------------------------*/
647 /* descriptors that are built on-demand */
649 static char manufacturer [50];
650 static char product_desc [40] = DRIVER_DESC;
651 static char serial_number [20];
653 /* address that the host will use ... usually assigned at random */
654 static char ethaddr [2 * ETH_ALEN + 1];
656 /* static strings, in UTF-8 */
657 static struct usb_string strings [] = {
658 { STRING_MANUFACTURER, manufacturer, },
659 { STRING_PRODUCT, product_desc, },
660 { STRING_SERIALNUMBER, serial_number, },
661 { STRING_DATA, "Ethernet Data", },
662 { STRING_ETHADDR, ethaddr, },
663 #ifdef DEV_CONFIG_CDC
664 { STRING_CDC, "CDC Ethernet", },
665 { STRING_CONTROL, "CDC Communications Control", },
667 #ifdef DEV_CONFIG_SUBSET
668 { STRING_SUBSET, "CDC Ethernet Subset", },
670 { } /* end of list */
673 static struct usb_gadget_strings stringtab = {
674 .language = 0x0409, /* en-us */
679 /*============================================================================*/
680 static u8 control_req[USB_BUFSIZ];
681 static u8 status_req[STATUS_BYTECOUNT];
686 * strlcpy - Copy a %NUL terminated string into a sized buffer
687 * @dest: Where to copy the string to
688 * @src: Where to copy the string from
689 * @size: size of destination buffer
691 * Compatible with *BSD: the result is always a valid
692 * NUL-terminated string that fits in the buffer (unless,
693 * of course, the buffer size is zero). It does not pad
694 * out the result like strncpy() does.
696 size_t strlcpy(char *dest, const char *src, size_t size)
698 size_t ret = strlen(src);
701 size_t len = (ret >= size) ? size - 1 : ret;
702 memcpy(dest, src, len);
709 /*============================================================================*/
712 * one config, two interfaces: control, data.
713 * complications: class descriptors, and an altsetting.
716 config_buf(struct usb_gadget *g, u8 *buf, u8 type, unsigned index, int is_otg)
719 const struct usb_config_descriptor *config;
720 const struct usb_descriptor_header **function;
723 if (gadget_is_dualspeed(g)) {
724 hs = (g->speed == USB_SPEED_HIGH);
725 if (type == USB_DT_OTHER_SPEED_CONFIG)
728 #define which_fn(t) (hs ? hs_ ## t ## _function : fs_ ## t ## _function)
730 if (index >= device_desc.bNumConfigurations)
733 config = ð_config;
734 function = which_fn (eth);
736 /* for now, don't advertise srp-only devices */
740 len = usb_gadget_config_buf (config, buf, USB_BUFSIZ, function);
743 ((struct usb_config_descriptor *) buf)->bDescriptorType = type;
747 /*-------------------------------------------------------------------------*/
749 static int alloc_requests (struct eth_dev *dev, unsigned n, gfp_t gfp_flags);
752 set_ether_config (struct eth_dev *dev, gfp_t gfp_flags)
755 struct usb_gadget *gadget = dev->gadget;
757 #if defined(DEV_CONFIG_CDC)
758 /* status endpoint used for (optionally) CDC */
759 if (!subset_active(dev) && dev->status_ep) {
760 dev->status = ep_desc (gadget, &hs_status_desc,
762 dev->status_ep->driver_data = dev;
764 result = usb_ep_enable (dev->status_ep, dev->status);
766 printf ("enable %s --> %d\n",
767 dev->status_ep->name, result);
773 dev->in = ep_desc(gadget, &hs_source_desc, &fs_source_desc);
774 dev->in_ep->driver_data = dev;
776 dev->out = ep_desc(gadget, &hs_sink_desc, &fs_sink_desc);
777 dev->out_ep->driver_data = dev;
779 /* With CDC, the host isn't allowed to use these two data
780 * endpoints in the default altsetting for the interface.
781 * so we don't activate them yet. Reset from SET_INTERFACE.
783 if (!cdc_active(dev)) {
784 result = usb_ep_enable (dev->in_ep, dev->in);
786 printf ("enable %s --> %d\n",
787 dev->in_ep->name, result);
791 result = usb_ep_enable (dev->out_ep, dev->out);
793 printf ("enable %s --> %d\n",
794 dev->out_ep->name, result);
801 result = alloc_requests (dev, qlen (gadget), gfp_flags);
803 /* on error, disable any endpoints */
805 if (!subset_active(dev))
806 (void) usb_ep_disable (dev->status_ep);
808 (void) usb_ep_disable (dev->in_ep);
809 (void) usb_ep_disable (dev->out_ep);
814 /* caller is responsible for cleanup on error */
819 static void eth_reset_config (struct eth_dev *dev)
821 if (dev->config == 0)
824 /* disable endpoints, forcing (synchronous) completion of
825 * pending i/o. then free the requests.
829 usb_ep_disable (dev->in_ep);
831 usb_ep_free_request (dev->in_ep, dev->tx_req);
836 usb_ep_disable (dev->out_ep);
838 usb_ep_free_request (dev->in_ep, dev->rx_req);
843 usb_ep_disable (dev->status_ep);
849 /* change our operational config. must agree with the code
850 * that returns config descriptors, and altsetting code.
852 static int eth_set_config (struct eth_dev *dev, unsigned number, gfp_t gfp_flags)
855 struct usb_gadget *gadget = dev->gadget;
857 if (gadget_is_sa1100 (gadget)
859 && dev->tx_qlen != 0) {
860 /* tx fifo is full, but we can't clear it...*/
861 INFO (dev, "can't change configurations\n");
864 eth_reset_config (dev);
867 case DEV_CONFIG_VALUE:
868 result = set_ether_config (dev, gfp_flags);
879 eth_reset_config (dev);
880 usb_gadget_vbus_draw(dev->gadget,
881 gadget_is_otg(dev->gadget) ? 8 : 100);
886 power = 2 * eth_config.bMaxPower;
887 usb_gadget_vbus_draw(dev->gadget, power);
889 switch (gadget->speed) {
890 case USB_SPEED_FULL: speed = "full"; break;
891 #ifdef CONFIG_USB_GADGET_DUALSPEED
892 case USB_SPEED_HIGH: speed = "high"; break;
894 default: speed = "?"; break;
897 dev->config = number;
898 INFO (dev, "%s speed config #%d: %d mA, %s, using %s\n",
899 speed, number, power, driver_desc,
900 (cdc_active(dev)? "CDC Ethernet"
901 : "CDC Ethernet Subset"));
906 /*-------------------------------------------------------------------------*/
908 #ifdef DEV_CONFIG_CDC
910 /* The interrupt endpoint is used in CDC networking models (Ethernet, ATM)
911 * only to notify the host about link status changes (which we support) or
912 * report completion of some encapsulated command. Since
913 * we want this CDC Ethernet code to be vendor-neutral, we don't use that
914 * command mechanism; and only one status request is ever queued.
916 static void eth_status_complete (struct usb_ep *ep, struct usb_request *req)
918 struct usb_cdc_notification *event = req->buf;
919 int value = req->status;
920 struct eth_dev *dev = ep->driver_data;
922 /* issue the second notification if host reads the first */
923 if (event->bNotificationType == USB_CDC_NOTIFY_NETWORK_CONNECTION
925 __le32 *data = req->buf + sizeof *event;
927 event->bmRequestType = 0xA1;
928 event->bNotificationType = USB_CDC_NOTIFY_SPEED_CHANGE;
929 event->wValue = __constant_cpu_to_le16 (0);
930 event->wIndex = __constant_cpu_to_le16 (1);
931 event->wLength = __constant_cpu_to_le16 (8);
933 /* SPEED_CHANGE data is up/down speeds in bits/sec */
934 data [0] = data [1] = cpu_to_le32 (BITRATE (dev->gadget));
936 req->length = STATUS_BYTECOUNT;
937 value = usb_ep_queue (ep, req, GFP_ATOMIC);
938 dprintf ("send SPEED_CHANGE --> %d\n", value);
941 } else if (value != -ECONNRESET) {
942 dprintf("event %02x --> %d\n",
943 event->bNotificationType, value);
944 if (event->bNotificationType==
945 USB_CDC_NOTIFY_SPEED_CHANGE)
947 l_ethdev.network_started=1;
948 printf("USB network up!\n");
954 static void issue_start_status (struct eth_dev *dev)
956 struct usb_request *req = dev->stat_req;
957 struct usb_cdc_notification *event;
962 * FIXME ugly idiom, maybe we'd be better with just
963 * a "cancel the whole queue" primitive since any
964 * unlink-one primitive has way too many error modes.
965 * here, we "know" toggle is already clear...
967 * FIXME iff req->context != null just dequeue it
969 usb_ep_disable (dev->status_ep);
970 usb_ep_enable (dev->status_ep, dev->status);
972 /* 3.8.1 says to issue first NETWORK_CONNECTION, then
973 * a SPEED_CHANGE. could be useful in some configs.
976 event->bmRequestType = 0xA1;
977 event->bNotificationType = USB_CDC_NOTIFY_NETWORK_CONNECTION;
978 event->wValue = __constant_cpu_to_le16 (1); /* connected */
979 event->wIndex = __constant_cpu_to_le16 (1);
982 req->length = sizeof *event;
983 req->complete = eth_status_complete;
986 value = usb_ep_queue (dev->status_ep, req, GFP_ATOMIC);
988 printf ("status buf queue --> %d\n", value);
993 /*-------------------------------------------------------------------------*/
995 static void eth_setup_complete (struct usb_ep *ep, struct usb_request *req)
997 if (req->status || req->actual != req->length)
998 dprintf (/*(struct eth_dev *) ep->driver_data*/
999 "setup complete --> %d, %d/%d\n",
1000 req->status, req->actual, req->length);
1004 * The setup() callback implements all the ep0 functionality that's not
1005 * handled lower down. CDC has a number of less-common features:
1007 * - two interfaces: control, and ethernet data
1008 * - Ethernet data interface has two altsettings: default, and active
1009 * - class-specific descriptors for the control interface
1010 * - class-specific control requests
1013 eth_setup (struct usb_gadget *gadget, const struct usb_ctrlrequest *ctrl)
1015 struct eth_dev *dev = get_gadget_data (gadget);
1016 struct usb_request *req = dev->req;
1017 int value = -EOPNOTSUPP;
1018 u16 wIndex = le16_to_cpu(ctrl->wIndex);
1019 u16 wValue = le16_to_cpu(ctrl->wValue);
1020 u16 wLength = le16_to_cpu(ctrl->wLength);
1022 /* descriptors just go into the pre-allocated ep0 buffer,
1023 * while config change events may enable network traffic.
1026 dprintf("eth_setup:...\n");
1028 req->complete = eth_setup_complete;
1029 switch (ctrl->bRequest) {
1031 case USB_REQ_GET_DESCRIPTOR:
1032 if (ctrl->bRequestType != USB_DIR_IN)
1034 switch (wValue >> 8) {
1037 value = min (wLength, (u16) sizeof device_desc);
1038 memcpy (req->buf, &device_desc, value);
1040 case USB_DT_DEVICE_QUALIFIER:
1041 if (!gadget_is_dualspeed(gadget))
1043 value = min (wLength, (u16) sizeof dev_qualifier);
1044 memcpy (req->buf, &dev_qualifier, value);
1047 case USB_DT_OTHER_SPEED_CONFIG:
1048 if (!gadget_is_dualspeed(gadget))
1052 value = config_buf(gadget, req->buf,
1055 gadget_is_otg(gadget));
1057 value = min (wLength, (u16) value);
1061 value = usb_gadget_get_string (&stringtab,
1062 wValue & 0xff, req->buf);
1065 value = min (wLength, (u16) value);
1071 case USB_REQ_SET_CONFIGURATION:
1072 if (ctrl->bRequestType != 0)
1074 if (gadget->a_hnp_support)
1075 DEBUG (dev, "HNP available\n");
1076 else if (gadget->a_alt_hnp_support)
1077 DEBUG (dev, "HNP needs a different root port\n");
1078 value = eth_set_config (dev, wValue, GFP_ATOMIC);
1080 case USB_REQ_GET_CONFIGURATION:
1081 if (ctrl->bRequestType != USB_DIR_IN)
1083 *(u8 *)req->buf = dev->config;
1084 value = min (wLength, (u16) 1);
1087 case USB_REQ_SET_INTERFACE:
1088 if (ctrl->bRequestType != USB_RECIP_INTERFACE
1092 if (!cdc_active(dev) && wIndex != 0)
1095 /* PXA hardware partially handles SET_INTERFACE;
1096 * we need to kluge around that interference.
1098 if (gadget_is_pxa (gadget)) {
1099 value = eth_set_config (dev, DEV_CONFIG_VALUE,
1104 #ifdef DEV_CONFIG_CDC
1106 case 0: /* control/master intf */
1110 usb_ep_disable (dev->status_ep);
1111 usb_ep_enable (dev->status_ep, dev->status);
1115 case 1: /* data intf */
1118 usb_ep_disable (dev->in_ep);
1119 usb_ep_disable (dev->out_ep);
1121 /* CDC requires the data transfers not be done from
1122 * the default interface setting ... also, setting
1123 * the non-default interface resets filters etc.
1126 if (!cdc_active (dev))
1128 usb_ep_enable (dev->in_ep, dev->in);
1129 usb_ep_enable (dev->out_ep, dev->out);
1130 dev->cdc_filter = DEFAULT_FILTER;
1132 issue_start_status (dev);
1139 /* FIXME this is wrong, as is the assumption that
1140 * all non-PXA hardware talks real CDC ...
1142 dev_warn (&gadget->dev, "set_interface ignored!\n");
1143 #endif /* DEV_CONFIG_CDC */
1147 case USB_REQ_GET_INTERFACE:
1148 if (ctrl->bRequestType != (USB_DIR_IN|USB_RECIP_INTERFACE)
1152 if (!(cdc_active(dev)) && wIndex != 0)
1155 /* for CDC, iff carrier is on, data interface is active. */
1157 *(u8 *)req->buf = 0;
1159 /* *(u8 *)req->buf = netif_carrier_ok (dev->net) ? 1 : 0; */
1160 /* carrier always ok ...*/
1161 *(u8 *)req->buf = 1 ;
1163 value = min (wLength, (u16) 1);
1166 #ifdef DEV_CONFIG_CDC
1167 case USB_CDC_SET_ETHERNET_PACKET_FILTER:
1168 /* see 6.2.30: no data, wIndex = interface,
1169 * wValue = packet filter bitmap
1171 if (ctrl->bRequestType != (USB_TYPE_CLASS|USB_RECIP_INTERFACE)
1176 printf ("packet filter %02x\n", wValue);
1177 dev->cdc_filter = wValue;
1182 * case USB_CDC_SET_ETHERNET_MULTICAST_FILTERS:
1183 * case USB_CDC_SET_ETHERNET_PM_PATTERN_FILTER:
1184 * case USB_CDC_GET_ETHERNET_PM_PATTERN_FILTER:
1185 * case USB_CDC_GET_ETHERNET_STATISTIC:
1188 #endif /* DEV_CONFIG_CDC */
1192 "unknown control req%02x.%02x v%04x i%04x l%d\n",
1193 ctrl->bRequestType, ctrl->bRequest,
1194 wValue, wIndex, wLength);
1197 /* respond with data transfer before status phase? */
1199 dprintf("respond with data transfer before status phase\n");
1200 req->length = value;
1201 req->zero = value < wLength
1202 && (value % gadget->ep0->maxpacket) == 0;
1203 value = usb_ep_queue (gadget->ep0, req, GFP_ATOMIC);
1205 DEBUG (dev, "ep_queue --> %d\n", value);
1207 eth_setup_complete (gadget->ep0, req);
1211 /* host either stalls (value < 0) or reports success */
1216 /*-------------------------------------------------------------------------*/
1218 static void rx_complete (struct usb_ep *ep, struct usb_request *req);
1220 static int rx_submit ( struct eth_dev *dev, struct usb_request *req, \
1223 int retval = -ENOMEM;
1226 /* Padding up to RX_EXTRA handles minor disagreements with host.
1227 * Normally we use the USB "terminate on short read" convention;
1228 * so allow up to (N*maxpacket), since that memory is normally
1229 * already allocated. Some hardware doesn't deal well with short
1230 * reads (e.g. DMA must be N*maxpacket), so for now don't trim a
1231 * byte off the end (to force hardware errors on overflow).
1234 dprintf("%s\n", __func__);
1236 size = (ETHER_HDR_SIZE + dev->mtu + RX_EXTRA);
1237 size += dev->out_ep->maxpacket - 1;
1238 size -= size % dev->out_ep->maxpacket;
1241 /* Some platforms perform better when IP packets are aligned,
1242 * but on at least one, checksumming fails otherwise.
1245 req->buf = (u8 *) NetRxPackets[0];
1247 req->complete = rx_complete;
1249 retval = usb_ep_queue (dev->out_ep, req, gfp_flags);
1252 dprintf ("rx submit --> %d\n", retval);
1258 static void rx_complete (struct usb_ep *ep, struct usb_request *req)
1260 struct eth_dev *dev = ep->driver_data;
1262 dprintf("%s\n", __func__);
1263 dprintf("rx status %d\n", req->status);
1272 static int alloc_requests (struct eth_dev *dev, unsigned n, gfp_t gfp_flags)
1275 dev->tx_req = usb_ep_alloc_request (dev->in_ep, 0);
1280 dev->rx_req = usb_ep_alloc_request (dev->out_ep, 0);
1288 DEBUG (dev, "can't alloc requests\n");
1293 static void tx_complete (struct usb_ep *ep, struct usb_request *req)
1295 dprintf("%s, status: %s\n", __func__,(req->status) ? "failed":"ok");
1299 static inline int eth_is_promisc (struct eth_dev *dev)
1301 /* no filters for the CDC subset; always promisc */
1302 if (subset_active (dev))
1304 return dev->cdc_filter & USB_CDC_PACKET_TYPE_PROMISCUOUS;
1308 static int eth_start_xmit (struct sk_buff *skb, struct net_device *net)
1310 struct eth_dev *dev = netdev_priv(net);
1311 int length = skb->len;
1313 struct usb_request *req = NULL;
1314 unsigned long flags;
1316 /* apply outgoing CDC or RNDIS filters */
1317 if (!eth_is_promisc (dev)) {
1318 u8 *dest = skb->data;
1320 if (is_multicast_ether_addr(dest)) {
1323 /* ignores USB_CDC_PACKET_TYPE_MULTICAST and host
1324 * SET_ETHERNET_MULTICAST_FILTERS requests
1326 if (is_broadcast_ether_addr(dest))
1327 type = USB_CDC_PACKET_TYPE_BROADCAST;
1329 type = USB_CDC_PACKET_TYPE_ALL_MULTICAST;
1330 if (!(dev->cdc_filter & type)) {
1331 dev_kfree_skb_any (skb);
1335 /* ignores USB_CDC_PACKET_TYPE_DIRECTED */
1338 spin_lock_irqsave(&dev->req_lock, flags);
1340 * this freelist can be empty if an interrupt triggered disconnect()
1341 * and reconfigured the gadget (shutting down this queue) after the
1342 * network stack decided to xmit but before we got the spinlock.
1344 if (list_empty(&dev->tx_reqs)) {
1345 spin_unlock_irqrestore(&dev->req_lock, flags);
1349 req = container_of (dev->tx_reqs.next, struct usb_request, list);
1350 list_del (&req->list);
1352 /* temporarily stop TX queue when the freelist empties */
1353 if (list_empty (&dev->tx_reqs))
1354 netif_stop_queue (net);
1355 spin_unlock_irqrestore(&dev->req_lock, flags);
1357 /* no buffer copies needed, unless the network stack did it
1358 * or the hardware can't use skb buffers.
1359 * or there's not enough space for any RNDIS headers we need
1361 if (rndis_active(dev)) {
1362 struct sk_buff *skb_rndis;
1364 skb_rndis = skb_realloc_headroom (skb,
1365 sizeof (struct rndis_packet_msg_type));
1369 dev_kfree_skb_any (skb);
1371 rndis_add_hdr (skb);
1374 req->buf = skb->data;
1376 req->complete = tx_complete;
1378 /* use zlp framing on tx for strict CDC-Ether conformance,
1379 * though any robust network rx path ignores extra padding.
1380 * and some hardware doesn't like to write zlps.
1383 if (!dev->zlp && (length % dev->in_ep->maxpacket) == 0)
1386 req->length = length;
1388 /* throttle highspeed IRQ rate back slightly */
1389 if (gadget_is_dualspeed(dev->gadget))
1390 req->no_interrupt = (dev->gadget->speed == USB_SPEED_HIGH)
1391 ? ((atomic_read(&dev->tx_qlen) % qmult) != 0)
1394 retval = usb_ep_queue (dev->in_ep, req, GFP_ATOMIC);
1397 DEBUG (dev, "tx queue err %d\n", retval);
1400 net->trans_start = jiffies;
1401 atomic_inc (&dev->tx_qlen);
1406 dev->stats.tx_dropped++;
1407 dev_kfree_skb_any (skb);
1408 spin_lock_irqsave(&dev->req_lock, flags);
1409 if (list_empty (&dev->tx_reqs))
1410 netif_start_queue (net);
1411 list_add (&req->list, &dev->tx_reqs);
1412 spin_unlock_irqrestore(&dev->req_lock, flags);
1417 /*-------------------------------------------------------------------------*/
1420 static void eth_unbind (struct usb_gadget *gadget)
1422 struct eth_dev *dev = get_gadget_data (gadget);
1424 printf("eth_unbind:...\n");
1426 if (dev->stat_req) {
1427 usb_ep_free_request (dev->status_ep, dev->stat_req);
1428 dev->stat_req = NULL;
1432 usb_ep_free_request (dev->in_ep, dev->tx_req);
1437 usb_ep_free_request (dev->in_ep, dev->rx_req);
1441 /* unregister_netdev (dev->net);*/
1442 /* free_netdev(dev->net);*/
1444 set_gadget_data (gadget, NULL);
1447 static void eth_disconnect (struct usb_gadget *gadget)
1449 eth_reset_config (get_gadget_data (gadget));
1452 static void eth_suspend (struct usb_gadget *gadget)
1457 static void eth_resume (struct usb_gadget *gadget)
1462 /*-------------------------------------------------------------------------*/
1464 static int is_eth_addr_valid(char *str)
1466 if (strlen(str) == 17) {
1471 /* see if it looks like an ethernet address */
1475 for (i = 0; i < 6; i++) {
1476 char term = (i == 5 ? '\0' : ':');
1478 ea[i] = simple_strtol(p, &q, 16);
1480 if ((q - p) != 2 || *q++ != term)
1486 if (i == 6) /* it looks ok */
1492 static u8 nibble (unsigned char c)
1494 if (likely (isdigit (c)))
1497 if (likely (isxdigit (c)))
1498 return 10 + c - 'A';
1502 static int get_ether_addr(const char *str, u8 *dev_addr)
1507 for (i = 0; i < 6; i++) {
1510 if((*str == '.') || (*str == ':'))
1512 num = nibble(*str++) << 4;
1513 num |= (nibble(*str++));
1516 if (is_valid_ether_addr (dev_addr))
1522 static int eth_bind(struct usb_gadget *gadget)
1524 struct eth_dev *dev = &l_ethdev;
1525 u8 cdc = 1, zlp = 1;
1526 struct usb_ep *in_ep, *out_ep, *status_ep = NULL;
1530 /* these flags are only ever cleared; compiler take note */
1531 #ifndef DEV_CONFIG_CDC
1534 /* Because most host side USB stacks handle CDC Ethernet, that
1535 * standard protocol is _strongly_ preferred for interop purposes.
1536 * (By everyone except Microsoft.)
1538 if (gadget_is_pxa (gadget)) {
1539 /* pxa doesn't support altsettings */
1541 } else if (gadget_is_musbhdrc(gadget)) {
1542 /* reduce tx dma overhead by avoiding special cases */
1544 } else if (gadget_is_sh(gadget)) {
1545 /* sh doesn't support multiple interfaces or configs */
1547 } else if (gadget_is_sa1100 (gadget)) {
1548 /* hardware can't write zlps */
1550 /* sa1100 CAN do CDC, without status endpoint ... we use
1551 * non-CDC to be compatible with ARM Linux-2.4 "usb-eth".
1556 gcnum = usb_gadget_controller_number (gadget);
1558 device_desc.bcdDevice = cpu_to_le16 (0x0300 + gcnum);
1560 /* can't assume CDC works. don't want to default to
1561 * anything less functional on CDC-capable hardware,
1562 * so we fail in this case.
1564 dev_err (&gadget->dev,
1565 "controller '%s' not recognized\n",
1570 /* CDC subset ... recognized by Linux since 2.4.10, but Windows
1571 * drivers aren't widely available. (That may be improved by
1572 * supporting one submode of the "SAFE" variant of MDLM.)
1575 device_desc.idVendor =
1576 __constant_cpu_to_le16(SIMPLE_VENDOR_NUM);
1577 device_desc.idProduct =
1578 __constant_cpu_to_le16(SIMPLE_PRODUCT_NUM);
1581 /* support optional vendor/distro customization */
1582 #if defined(CONFIG_USB_CDC_VENDOR_ID) && defined(CONFIG_USB_CDC_PRODUCT_ID)
1583 device_desc.idVendor = cpu_to_le16(CONFIG_USB_CDC_VENDOR_ID);
1584 device_desc.idProduct = cpu_to_le16(CONFIG_USB_CDC_PRODUCT_ID);
1587 device_desc.bcdDevice = cpu_to_le16(bcdDevice);
1589 strcpy (manufacturer, iManufacturer);
1591 strcpy (product_desc, iProduct);
1592 if (iSerialNumber) {
1593 device_desc.iSerialNumber = STRING_SERIALNUMBER,
1594 strcpy(serial_number, iSerialNumber);
1597 /* all we really need is bulk IN/OUT */
1598 usb_ep_autoconfig_reset (gadget);
1599 in_ep = usb_ep_autoconfig (gadget, &fs_source_desc);
1602 dev_err (&gadget->dev,
1603 "can't autoconfigure on %s\n",
1607 in_ep->driver_data = in_ep; /* claim */
1609 out_ep = usb_ep_autoconfig (gadget, &fs_sink_desc);
1612 out_ep->driver_data = out_ep; /* claim */
1614 #if defined(DEV_CONFIG_CDC)
1615 /* CDC Ethernet control interface doesn't require a status endpoint.
1616 * Since some hosts expect one, try to allocate one anyway.
1619 status_ep = usb_ep_autoconfig (gadget, &fs_status_desc);
1621 status_ep->driver_data = status_ep; /* claim */
1623 control_intf.bNumEndpoints = 0;
1624 /* FIXME remove endpoint from descriptor list */
1629 /* one config: cdc, else minimal subset */
1631 eth_config.bNumInterfaces = 1;
1632 eth_config.iConfiguration = STRING_SUBSET;
1634 /* use functions to set these up, in case we're built to work
1635 * with multiple controllers and must override CDC Ethernet.
1637 fs_subset_descriptors();
1638 hs_subset_descriptors();
1641 device_desc.bMaxPacketSize0 = gadget->ep0->maxpacket;
1642 usb_gadget_set_selfpowered (gadget);
1644 if (gadget_is_dualspeed(gadget)) {
1646 dev_qualifier.bDeviceClass = USB_CLASS_VENDOR_SPEC;
1648 /* assumes ep0 uses the same value for both speeds ... */
1649 dev_qualifier.bMaxPacketSize0 = device_desc.bMaxPacketSize0;
1651 /* and that all endpoints are dual-speed */
1652 hs_source_desc.bEndpointAddress =
1653 fs_source_desc.bEndpointAddress;
1654 hs_sink_desc.bEndpointAddress =
1655 fs_sink_desc.bEndpointAddress;
1656 #if defined(DEV_CONFIG_CDC)
1658 hs_status_desc.bEndpointAddress =
1659 fs_status_desc.bEndpointAddress;
1663 if (gadget_is_otg(gadget)) {
1664 otg_descriptor.bmAttributes |= USB_OTG_HNP,
1665 eth_config.bmAttributes |= USB_CONFIG_ATT_WAKEUP;
1666 eth_config.bMaxPower = 4;
1669 dev->net = &l_netdev;
1670 strcpy (dev->net->name, USB_NET_NAME);
1676 dev->out_ep = out_ep;
1677 dev->status_ep = status_ep;
1679 /* Module params for these addresses should come from ID proms.
1680 * The host side address is used with CDC, and commonly
1681 * ends up in a persistent config database. It's not clear if
1682 * host side code for the SAFE thing cares -- its original BLAN
1683 * thing didn't, Sharp never assigned those addresses on Zaurii.
1685 get_ether_addr(dev_addr, dev->net->enetaddr);
1687 memset(tmp, 0, sizeof(tmp));
1688 memcpy(tmp, dev->net->enetaddr, sizeof(dev->net->enetaddr));
1690 get_ether_addr(host_addr, dev->host_mac);
1692 sprintf (ethaddr, "%02X%02X%02X%02X%02X%02X",
1693 dev->host_mac [0], dev->host_mac [1],
1694 dev->host_mac [2], dev->host_mac [3],
1695 dev->host_mac [4], dev->host_mac [5]);
1697 INFO (dev, "using %s, OUT %s IN %s%s%s\n", gadget->name,
1698 out_ep->name, in_ep->name,
1699 status_ep ? " STATUS " : "",
1700 status_ep ? status_ep->name : ""
1702 INFO (dev, "MAC %02x:%02x:%02x:%02x:%02x:%02x\n",
1703 dev->net->enetaddr [0], dev->net->enetaddr [1],
1704 dev->net->enetaddr [2], dev->net->enetaddr [3],
1705 dev->net->enetaddr [4], dev->net->enetaddr [5]);
1708 INFO (dev, "HOST MAC %02x:%02x:%02x:%02x:%02x:%02x\n",
1709 dev->host_mac [0], dev->host_mac [1],
1710 dev->host_mac [2], dev->host_mac [3],
1711 dev->host_mac [4], dev->host_mac [5]);
1714 /* use PKTSIZE (or aligned... from u-boot) and set
1715 * wMaxSegmentSize accordingly*/
1716 dev->mtu = PKTSIZE_ALIGN; /* RNDIS does not like this, only 1514, TODO*/
1718 /* preallocate control message data and buffer */
1719 dev->req = usb_ep_alloc_request (gadget->ep0, GFP_KERNEL);
1722 dev->req->buf = control_req;
1723 dev->req->complete = eth_setup_complete;
1725 /* ... and maybe likewise for status transfer */
1726 #if defined(DEV_CONFIG_CDC)
1727 if (dev->status_ep) {
1728 dev->stat_req = usb_ep_alloc_request(gadget->ep0, GFP_KERNEL);
1729 dev->stat_req->buf = status_req;
1730 if (!dev->stat_req) {
1731 dev->stat_req->buf=NULL;
1732 usb_ep_free_request (gadget->ep0, dev->req);
1736 dev->stat_req->context = NULL;
1740 /* finish hookup to lower layer ... */
1741 dev->gadget = gadget;
1742 set_gadget_data (gadget, dev);
1743 gadget->ep0->driver_data = dev;
1745 /* two kinds of host-initiated state changes:
1746 * - iff DATA transfer is active, carrier is "on"
1747 * - tx queueing enabled if open *and* carrier is "on"
1752 dev_dbg(&gadget->dev, "register_netdev failed\n");
1753 eth_unbind (gadget);
1757 static int usb_eth_init(struct eth_device* netdev, bd_t* bd)
1759 struct eth_dev *dev=&l_ethdev;
1760 struct usb_gadget *gadget;
1762 unsigned long timeout = USB_CONNECT_TIMEOUT;
1765 printf("ERROR: received NULL ptr\n");
1769 dev->network_started = 0;
1773 packet_received = 0;
1776 gadget = dev->gadget;
1777 usb_gadget_connect(gadget);
1779 if (getenv("cdc_connect_timeout"))
1780 timeout = simple_strtoul(getenv("cdc_connect_timeout"),
1781 NULL, 10) * CONFIG_SYS_HZ;
1783 while (!l_ethdev.network_started)
1785 /* Handle control-c and timeouts */
1786 if (ctrlc() || (get_timer(ts) > timeout)) {
1787 printf("The remote end did not respond in time.\n");
1790 usb_gadget_handle_interrupts();
1793 rx_submit (dev, dev->rx_req, 0);
1799 static int usb_eth_send(struct eth_device* netdev, volatile void* packet, int length)
1802 struct usb_request *req = NULL;
1804 struct eth_dev *dev = &l_ethdev;
1805 dprintf("%s:...\n",__func__);
1809 req->buf = (void *)packet;
1810 req->context = NULL;
1811 req->complete = tx_complete;
1813 /* use zlp framing on tx for strict CDC-Ether conformance,
1814 * though any robust network rx path ignores extra padding.
1815 * and some hardware doesn't like to write zlps.
1818 if (!dev->zlp && (length % dev->in_ep->maxpacket) == 0)
1821 req->length = length;
1823 /* throttle highspeed IRQ rate back slightly */
1824 if (gadget_is_dualspeed(dev->gadget))
1825 req->no_interrupt = (dev->gadget->speed == USB_SPEED_HIGH)
1826 ? ((dev->tx_qlen % qmult) != 0) : 0;
1830 retval = usb_ep_queue (dev->in_ep, req, GFP_ATOMIC);
1833 dprintf("%s: packet queued\n",__func__);
1842 static int usb_eth_recv(struct eth_device* netdev)
1844 struct eth_dev *dev = &l_ethdev;
1846 usb_gadget_handle_interrupts();
1848 if (packet_received)
1850 dprintf("%s: packet received \n",__func__);
1853 NetReceive(NetRxPackets[0],dev->rx_req->length);
1857 rx_submit (dev, dev->rx_req, 0);
1859 else printf("dev->rx_req invalid\n");
1864 void usb_eth_halt(struct eth_device* netdev)
1866 struct eth_dev *dev =&l_ethdev;
1870 printf("ERROR: received NULL ptr\n");
1874 usb_gadget_disconnect(dev->gadget);
1877 static struct usb_gadget_driver eth_driver = {
1881 .unbind = eth_unbind,
1884 .disconnect = eth_disconnect,
1886 .suspend = eth_suspend,
1887 .resume = eth_resume,
1890 int usb_eth_initialize(bd_t *bi)
1893 struct eth_device *netdev=&l_netdev;
1895 sprintf(netdev->name,"usb_ether");
1897 netdev->init = usb_eth_init;
1898 netdev->send = usb_eth_send;
1899 netdev->recv = usb_eth_recv;
1900 netdev->halt = usb_eth_halt;
1902 #ifdef CONFIG_MCAST_TFTP
1903 #error not supported
1905 /* Configure default mac-addresses for the USB ethernet device */
1906 #ifdef CONFIG_USBNET_DEV_ADDR
1907 strncpy(dev_addr, CONFIG_USBNET_DEV_ADDR, sizeof(dev_addr));
1909 #ifdef CONFIG_USBNET_HOST_ADDR
1910 strncpy(host_addr, CONFIG_USBNET_HOST_ADDR, sizeof(host_addr));
1912 /* Check if the user overruled the MAC addresses */
1913 if (getenv("usbnet_devaddr"))
1914 strncpy(dev_addr, getenv("usbnet_devaddr"),
1917 if (getenv("usbnet_hostaddr"))
1918 strncpy(host_addr, getenv("usbnet_hostaddr"),
1921 /* Make sure both strings are terminated */
1922 dev_addr[sizeof(dev_addr)-1] = '\0';
1923 host_addr[sizeof(host_addr)-1] = '\0';
1925 if (!is_eth_addr_valid(dev_addr)) {
1926 printf("ERROR: Need valid 'usbnet_devaddr' to be set\n");
1929 if (!is_eth_addr_valid(host_addr)) {
1930 printf("ERROR: Need valid 'usbnet_hostaddr' to be set\n");
1936 status = usb_gadget_register_driver(ð_driver);
1940 eth_register(netdev);
1944 printf("%s failed\n", __func__ );