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"
36 extern struct platform_data brd;
38 #define spin_unlock(x)
41 unsigned packet_received, packet_sent;
43 #define DEV_CONFIG_CDC 1
44 #define GFP_ATOMIC ((gfp_t) 0)
45 #define GFP_KERNEL ((gfp_t) 0)
48 * Ethernet gadget driver -- with CDC and non-CDC options
49 * Builds on hardware support for a full duplex link.
51 * CDC Ethernet is the standard USB solution for sending Ethernet frames
52 * using USB. Real hardware tends to use the same framing protocol but look
53 * different for control features. This driver strongly prefers to use
54 * this USB-IF standard as its open-systems interoperability solution;
55 * most host side USB stacks (except from Microsoft) support it.
57 * This is sometimes called "CDC ECM" (Ethernet Control Model) to support
58 * TLA-soup. "CDC ACM" (Abstract Control Model) is for modems, and a new
59 * "CDC EEM" (Ethernet Emulation Model) is starting to spread.
61 * There's some hardware that can't talk CDC ECM. We make that hardware
62 * implement a "minimalist" vendor-agnostic CDC core: same framing, but
63 * link-level setup only requires activating the configuration. Only the
64 * endpoint descriptors, and product/vendor IDs, are relevant; no control
65 * operations are available. Linux supports it, but other host operating
66 * systems may not. (This is a subset of CDC Ethernet.)
68 * It turns out that if you add a few descriptors to that "CDC Subset",
69 * (Windows) host side drivers from MCCI can treat it as one submode of
70 * a proprietary scheme called "SAFE" ... without needing to know about
71 * specific product/vendor IDs. So we do that, making it easier to use
72 * those MS-Windows drivers. Those added descriptors make it resemble a
73 * CDC MDLM device, but they don't change device behavior at all. (See
74 * MCCI Engineering report 950198 "SAFE Networking Functions".)
76 * A third option is also in use. Rather than CDC Ethernet, or something
77 * simpler, Microsoft pushes their own approach: RNDIS. The published
78 * RNDIS specs are ambiguous and appear to be incomplete, and are also
79 * needlessly complex. They borrow more from CDC ACM than CDC ECM.
81 #define ETH_ALEN 6 /* Octets in one ethernet addr */
82 #define ETH_HLEN 14 /* Total octets in header. */
83 #define ETH_ZLEN 60 /* Min. octets in frame sans FCS */
84 #define ETH_DATA_LEN 1500 /* Max. octets in payload */
85 #define ETH_FRAME_LEN PKTSIZE_ALIGN /* Max. octets in frame sans FCS */
86 #define ETH_FCS_LEN 4 /* Octets in the FCS */
88 #define DRIVER_DESC "Ethernet Gadget"
89 /* Based on linux 2.6.27 version */
90 #define DRIVER_VERSION "May Day 2005"
92 static const char shortname [] = "ether";
93 static const char driver_desc [] = DRIVER_DESC;
95 #define RX_EXTRA 20 /* guard against rx overflows */
97 /* CDC support the same host-chosen outgoing packet filters. */
98 #define DEFAULT_FILTER (USB_CDC_PACKET_TYPE_BROADCAST \
99 |USB_CDC_PACKET_TYPE_ALL_MULTICAST \
100 |USB_CDC_PACKET_TYPE_PROMISCUOUS \
101 |USB_CDC_PACKET_TYPE_DIRECTED)
103 #define USB_CONNECT_TIMEOUT (3 * CONFIG_SYS_HZ)
105 /*-------------------------------------------------------------------------*/
106 static struct eth_dev l_ethdev;
107 static struct eth_device l_netdev;
108 static struct usb_gadget_driver eth_driver;
110 /*-------------------------------------------------------------------------*/
112 /* "main" config is either CDC, or its simple subset */
113 static inline int is_cdc(struct eth_dev *dev)
115 #if !defined(DEV_CONFIG_SUBSET)
116 return 1; /* only cdc possible */
117 #elif !defined (DEV_CONFIG_CDC)
118 return 0; /* only subset possible */
120 return dev->cdc; /* depends on what hardware we found */
124 #define subset_active(dev) (!is_cdc(dev))
125 #define cdc_active(dev) ( is_cdc(dev))
127 #define DEFAULT_QLEN 2 /* double buffering by default */
129 /* peak bulk transfer bits-per-second */
130 #define HS_BPS (13 * 512 * 8 * 1000 * 8)
131 #define FS_BPS (19 * 64 * 1 * 1000 * 8)
133 #ifdef CONFIG_USB_GADGET_DUALSPEED
134 #define DEVSPEED USB_SPEED_HIGH
136 #ifdef CONFIG_USB_ETH_QMULT
137 #define qmult CONFIG_USB_ETH_QMULT
142 /* for dual-speed hardware, use deeper queues at highspeed */
143 #define qlen(gadget) \
144 (DEFAULT_QLEN*((gadget->speed == USB_SPEED_HIGH) ? qmult : 1))
146 static inline int BITRATE(struct usb_gadget *g)
148 return (g->speed == USB_SPEED_HIGH) ? HS_BPS : FS_BPS;
151 #else /* full speed (low speed doesn't do bulk) */
155 #define DEVSPEED USB_SPEED_FULL
157 #define qlen(gadget) DEFAULT_QLEN
159 static inline int BITRATE(struct usb_gadget *g)
166 struct usb_gadget *gadget;
167 struct usb_request *req; /* for control responses */
168 struct usb_request *stat_req; /* for cdc status */
171 struct usb_ep *in_ep, *out_ep, *status_ep;
172 const struct usb_endpoint_descriptor
175 struct usb_request *tx_req, *rx_req;
177 struct eth_device *net;
178 unsigned int tx_qlen;
182 unsigned suspended:1;
183 unsigned network_started:1;
187 #define WORK_RX_MEMORY 0
188 u8 host_mac [ETH_ALEN];
191 /* This version autoconfigures as much as possible at run-time.
193 * It also ASSUMES a self-powered device, without remote wakeup,
194 * although remote wakeup support would make sense.
197 /*-------------------------------------------------------------------------*/
199 /* DO NOT REUSE THESE IDs with a protocol-incompatible driver!! Ever!!
200 * Instead: allocate your own, using normal USB-IF procedures.
203 /* Thanks to NetChip Technologies for donating this product ID.
204 * It's for devices with only CDC Ethernet configurations.
206 #define CDC_VENDOR_NUM 0x0525 /* NetChip */
207 #define CDC_PRODUCT_NUM 0xa4a1 /* Linux-USB Ethernet Gadget */
209 /* For hardware that can't talk CDC, we use the same vendor ID that
210 * ARM Linux has used for ethernet-over-usb, both with sa1100 and
211 * with pxa250. We're protocol-compatible, if the host-side drivers
212 * use the endpoint descriptors. bcdDevice (version) is nonzero, so
213 * drivers that need to hard-wire endpoint numbers have a hook.
215 * The protocol is a minimal subset of CDC Ether, which works on any bulk
216 * hardware that's not deeply broken ... even on hardware that can't talk
217 * RNDIS (like SA-1100, with no interrupt endpoint, or anything that
218 * doesn't handle control-OUT).
220 #define SIMPLE_VENDOR_NUM 0x049f
221 #define SIMPLE_PRODUCT_NUM 0x505a
223 /* Some systems will want different product identifers published in the
224 * device descriptor, either numbers or strings or both. These string
225 * parameters are in UTF-8 (superset of ASCII's 7 bit characters).
228 static ushort bcdDevice;
229 #if defined(CONFIG_USBNET_MANUFACTURER)
230 static char *iManufacturer = CONFIG_USBNET_MANUFACTURER;
232 static char *iManufacturer = "U-boot";
234 static char *iProduct;
235 static char *iSerialNumber;
236 static char dev_addr[18];
237 static char host_addr[18];
239 /*-------------------------------------------------------------------------*/
241 /* USB DRIVER HOOKUP (to the hardware driver, below us), mostly
242 * ep0 implementation: descriptors, config management, setup().
243 * also optional class-specific notification interrupt transfer.
247 * DESCRIPTORS ... most are static, but strings and (full) configuration
248 * descriptors are built on demand. For now we do either full CDC, or
252 #define STRING_MANUFACTURER 1
253 #define STRING_PRODUCT 2
254 #define STRING_ETHADDR 3
255 #define STRING_DATA 4
256 #define STRING_CONTROL 5
258 #define STRING_SUBSET 8
259 #define STRING_SERIALNUMBER 10
261 /* holds our biggest descriptor */
262 #define USB_BUFSIZ 256
265 * This device advertises one configuration, eth_config,
266 * on hardware supporting at least two configs.
268 * FIXME define some higher-powered configurations to make it easier
269 * to recharge batteries ...
272 #define DEV_CONFIG_VALUE 1 /* cdc or subset */
274 static struct usb_device_descriptor
276 .bLength = sizeof device_desc,
277 .bDescriptorType = USB_DT_DEVICE,
279 .bcdUSB = __constant_cpu_to_le16 (0x0200),
281 .bDeviceClass = USB_CLASS_COMM,
282 .bDeviceSubClass = 0,
283 .bDeviceProtocol = 0,
285 .idVendor = __constant_cpu_to_le16 (CDC_VENDOR_NUM),
286 .idProduct = __constant_cpu_to_le16 (CDC_PRODUCT_NUM),
287 .iManufacturer = STRING_MANUFACTURER,
288 .iProduct = STRING_PRODUCT,
289 .bNumConfigurations = 1,
292 static struct usb_otg_descriptor
294 .bLength = sizeof otg_descriptor,
295 .bDescriptorType = USB_DT_OTG,
297 .bmAttributes = USB_OTG_SRP,
300 static struct usb_config_descriptor
302 .bLength = sizeof eth_config,
303 .bDescriptorType = USB_DT_CONFIG,
305 /* compute wTotalLength on the fly */
307 .bConfigurationValue = DEV_CONFIG_VALUE,
308 .iConfiguration = STRING_CDC,
309 .bmAttributes = USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER,
314 * Compared to the simple CDC subset, the full CDC Ethernet model adds
315 * three class descriptors, two interface descriptors, optional status
316 * endpoint. Both have a "data" interface and two bulk endpoints.
317 * There are also differences in how control requests are handled.
320 #ifdef DEV_CONFIG_CDC
321 static struct usb_interface_descriptor
323 .bLength = sizeof control_intf,
324 .bDescriptorType = USB_DT_INTERFACE,
326 .bInterfaceNumber = 0,
327 /* status endpoint is optional; this may be patched later */
329 .bInterfaceClass = USB_CLASS_COMM,
330 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET,
331 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
332 .iInterface = STRING_CONTROL,
336 static const struct usb_cdc_header_desc header_desc = {
337 .bLength = sizeof header_desc,
338 .bDescriptorType = USB_DT_CS_INTERFACE,
339 .bDescriptorSubType = USB_CDC_HEADER_TYPE,
341 .bcdCDC = __constant_cpu_to_le16 (0x0110),
344 #if defined(DEV_CONFIG_CDC)
346 static const struct usb_cdc_union_desc union_desc = {
347 .bLength = sizeof union_desc,
348 .bDescriptorType = USB_DT_CS_INTERFACE,
349 .bDescriptorSubType = USB_CDC_UNION_TYPE,
351 .bMasterInterface0 = 0, /* index of control interface */
352 .bSlaveInterface0 = 1, /* index of DATA interface */
357 #ifndef DEV_CONFIG_CDC
359 /* "SAFE" loosely follows CDC WMC MDLM, violating the spec in various
360 * ways: data endpoints live in the control interface, there's no data
361 * interface, and it's not used to talk to a cell phone radio.
364 static const struct usb_cdc_mdlm_desc mdlm_desc = {
365 .bLength = sizeof mdlm_desc,
366 .bDescriptorType = USB_DT_CS_INTERFACE,
367 .bDescriptorSubType = USB_CDC_MDLM_TYPE,
369 .bcdVersion = __constant_cpu_to_le16(0x0100),
371 0x5d, 0x34, 0xcf, 0x66, 0x11, 0x18, 0x11, 0xd6,
372 0xa2, 0x1a, 0x00, 0x01, 0x02, 0xca, 0x9a, 0x7f,
376 /* since "usb_cdc_mdlm_detail_desc" is a variable length structure, we
377 * can't really use its struct. All we do here is say that we're using
378 * the submode of "SAFE" which directly matches the CDC Subset.
380 static const u8 mdlm_detail_desc[] = {
383 USB_CDC_MDLM_DETAIL_TYPE,
386 0, /* network control capabilities (none) */
387 0, /* network data capabilities ("raw" encapsulation) */
393 static const struct usb_cdc_ether_desc ether_desc = {
394 .bLength = sizeof (ether_desc),
395 .bDescriptorType = USB_DT_CS_INTERFACE,
396 .bDescriptorSubType = USB_CDC_ETHERNET_TYPE,
398 /* this descriptor actually adds value, surprise! */
399 .iMACAddress = STRING_ETHADDR,
400 .bmEthernetStatistics = __constant_cpu_to_le32 (0), /* no statistics */
401 .wMaxSegmentSize = __constant_cpu_to_le16 (ETH_FRAME_LEN),
402 .wNumberMCFilters = __constant_cpu_to_le16 (0),
403 .bNumberPowerFilters = 0,
407 #if defined(DEV_CONFIG_CDC)
409 /* include the status endpoint if we can, even where it's optional.
410 * use wMaxPacketSize big enough to fit CDC_NOTIFY_SPEED_CHANGE in one
411 * packet, to simplify cancellation; and a big transfer interval, to
412 * waste less bandwidth.
414 * some drivers (like Linux 2.4 cdc-ether!) "need" it to exist even
415 * if they ignore the connect/disconnect notifications that real aether
416 * can provide. more advanced cdc configurations might want to support
417 * encapsulated commands (vendor-specific, using control-OUT).
420 #define LOG2_STATUS_INTERVAL_MSEC 5 /* 1 << 5 == 32 msec */
421 #define STATUS_BYTECOUNT 16 /* 8 byte header + data */
423 static struct usb_endpoint_descriptor
425 .bLength = USB_DT_ENDPOINT_SIZE,
426 .bDescriptorType = USB_DT_ENDPOINT,
428 .bEndpointAddress = USB_DIR_IN,
429 .bmAttributes = USB_ENDPOINT_XFER_INT,
430 .wMaxPacketSize = __constant_cpu_to_le16 (STATUS_BYTECOUNT),
431 .bInterval = 1 << LOG2_STATUS_INTERVAL_MSEC,
435 #ifdef DEV_CONFIG_CDC
437 /* the default data interface has no endpoints ... */
439 static const struct usb_interface_descriptor
441 .bLength = sizeof data_nop_intf,
442 .bDescriptorType = USB_DT_INTERFACE,
444 .bInterfaceNumber = 1,
445 .bAlternateSetting = 0,
447 .bInterfaceClass = USB_CLASS_CDC_DATA,
448 .bInterfaceSubClass = 0,
449 .bInterfaceProtocol = 0,
452 /* ... but the "real" data interface has two bulk endpoints */
454 static const struct usb_interface_descriptor
456 .bLength = sizeof data_intf,
457 .bDescriptorType = USB_DT_INTERFACE,
459 .bInterfaceNumber = 1,
460 .bAlternateSetting = 1,
462 .bInterfaceClass = USB_CLASS_CDC_DATA,
463 .bInterfaceSubClass = 0,
464 .bInterfaceProtocol = 0,
465 .iInterface = STRING_DATA,
470 #ifdef DEV_CONFIG_SUBSET
473 * "Simple" CDC-subset option is a simple vendor-neutral model that most
474 * full speed controllers can handle: one interface, two bulk endpoints.
476 * To assist host side drivers, we fancy it up a bit, and add descriptors
477 * so some host side drivers will understand it as a "SAFE" variant.
480 static const struct usb_interface_descriptor
482 .bLength = sizeof subset_data_intf,
483 .bDescriptorType = USB_DT_INTERFACE,
485 .bInterfaceNumber = 0,
486 .bAlternateSetting = 0,
488 .bInterfaceClass = USB_CLASS_COMM,
489 .bInterfaceSubClass = USB_CDC_SUBCLASS_MDLM,
490 .bInterfaceProtocol = 0,
491 .iInterface = STRING_DATA,
497 static struct usb_endpoint_descriptor
499 .bLength = USB_DT_ENDPOINT_SIZE,
500 .bDescriptorType = USB_DT_ENDPOINT,
502 .bEndpointAddress = USB_DIR_IN,
503 .bmAttributes = USB_ENDPOINT_XFER_BULK,
506 static struct usb_endpoint_descriptor
508 .bLength = USB_DT_ENDPOINT_SIZE,
509 .bDescriptorType = USB_DT_ENDPOINT,
511 .bEndpointAddress = USB_DIR_OUT,
512 .bmAttributes = USB_ENDPOINT_XFER_BULK,
515 static const struct usb_descriptor_header *fs_eth_function [11] = {
516 (struct usb_descriptor_header *) &otg_descriptor,
517 #ifdef DEV_CONFIG_CDC
518 /* "cdc" mode descriptors */
519 (struct usb_descriptor_header *) &control_intf,
520 (struct usb_descriptor_header *) &header_desc,
521 (struct usb_descriptor_header *) &union_desc,
522 (struct usb_descriptor_header *) ðer_desc,
523 /* NOTE: status endpoint may need to be removed */
524 (struct usb_descriptor_header *) &fs_status_desc,
525 /* data interface, with altsetting */
526 (struct usb_descriptor_header *) &data_nop_intf,
527 (struct usb_descriptor_header *) &data_intf,
528 (struct usb_descriptor_header *) &fs_source_desc,
529 (struct usb_descriptor_header *) &fs_sink_desc,
531 #endif /* DEV_CONFIG_CDC */
534 static inline void fs_subset_descriptors(void)
536 #ifdef DEV_CONFIG_SUBSET
537 /* behavior is "CDC Subset"; extra descriptors say "SAFE" */
538 fs_eth_function[1] = (struct usb_descriptor_header *) &subset_data_intf;
539 fs_eth_function[2] = (struct usb_descriptor_header *) &header_desc;
540 fs_eth_function[3] = (struct usb_descriptor_header *) &mdlm_desc;
541 fs_eth_function[4] = (struct usb_descriptor_header *) &mdlm_detail_desc;
542 fs_eth_function[5] = (struct usb_descriptor_header *) ðer_desc;
543 fs_eth_function[6] = (struct usb_descriptor_header *) &fs_source_desc;
544 fs_eth_function[7] = (struct usb_descriptor_header *) &fs_sink_desc;
545 fs_eth_function[8] = NULL;
547 fs_eth_function[1] = NULL;
552 * usb 2.0 devices need to expose both high speed and full speed
553 * descriptors, unless they only run at full speed.
556 #if defined(DEV_CONFIG_CDC)
557 static struct usb_endpoint_descriptor
559 .bLength = USB_DT_ENDPOINT_SIZE,
560 .bDescriptorType = USB_DT_ENDPOINT,
562 .bmAttributes = USB_ENDPOINT_XFER_INT,
563 .wMaxPacketSize = __constant_cpu_to_le16 (STATUS_BYTECOUNT),
564 .bInterval = LOG2_STATUS_INTERVAL_MSEC + 4,
566 #endif /* DEV_CONFIG_CDC */
568 static struct usb_endpoint_descriptor
570 .bLength = USB_DT_ENDPOINT_SIZE,
571 .bDescriptorType = USB_DT_ENDPOINT,
573 .bmAttributes = USB_ENDPOINT_XFER_BULK,
574 .wMaxPacketSize = __constant_cpu_to_le16 (512),
577 static struct usb_endpoint_descriptor
579 .bLength = USB_DT_ENDPOINT_SIZE,
580 .bDescriptorType = USB_DT_ENDPOINT,
582 .bmAttributes = USB_ENDPOINT_XFER_BULK,
583 .wMaxPacketSize = __constant_cpu_to_le16 (512),
586 static struct usb_qualifier_descriptor
588 .bLength = sizeof dev_qualifier,
589 .bDescriptorType = USB_DT_DEVICE_QUALIFIER,
591 .bcdUSB = __constant_cpu_to_le16 (0x0200),
592 .bDeviceClass = USB_CLASS_COMM,
594 .bNumConfigurations = 1,
597 static const struct usb_descriptor_header *hs_eth_function [11] = {
598 (struct usb_descriptor_header *) &otg_descriptor,
599 #ifdef DEV_CONFIG_CDC
600 /* "cdc" mode descriptors */
601 (struct usb_descriptor_header *) &control_intf,
602 (struct usb_descriptor_header *) &header_desc,
603 (struct usb_descriptor_header *) &union_desc,
604 (struct usb_descriptor_header *) ðer_desc,
605 /* NOTE: status endpoint may need to be removed */
606 (struct usb_descriptor_header *) &hs_status_desc,
607 /* data interface, with altsetting */
608 (struct usb_descriptor_header *) &data_nop_intf,
609 (struct usb_descriptor_header *) &data_intf,
610 (struct usb_descriptor_header *) &hs_source_desc,
611 (struct usb_descriptor_header *) &hs_sink_desc,
613 #endif /* DEV_CONFIG_CDC */
616 static inline void hs_subset_descriptors(void)
618 #ifdef DEV_CONFIG_SUBSET
619 /* behavior is "CDC Subset"; extra descriptors say "SAFE" */
620 hs_eth_function[1] = (struct usb_descriptor_header *) &subset_data_intf;
621 hs_eth_function[2] = (struct usb_descriptor_header *) &header_desc;
622 hs_eth_function[3] = (struct usb_descriptor_header *) &mdlm_desc;
623 hs_eth_function[4] = (struct usb_descriptor_header *) &mdlm_detail_desc;
624 hs_eth_function[5] = (struct usb_descriptor_header *) ðer_desc;
625 hs_eth_function[6] = (struct usb_descriptor_header *) &hs_source_desc;
626 hs_eth_function[7] = (struct usb_descriptor_header *) &hs_sink_desc;
627 hs_eth_function[8] = NULL;
629 hs_eth_function[1] = NULL;
633 /* maxpacket and other transfer characteristics vary by speed. */
634 static inline struct usb_endpoint_descriptor *
635 ep_desc(struct usb_gadget *g, struct usb_endpoint_descriptor *hs,
636 struct usb_endpoint_descriptor *fs)
638 if (gadget_is_dualspeed(g) && g->speed == USB_SPEED_HIGH)
644 /*-------------------------------------------------------------------------*/
646 /* descriptors that are built on-demand */
648 static char manufacturer [50];
649 static char product_desc [40] = DRIVER_DESC;
650 static char serial_number [20];
652 /* address that the host will use ... usually assigned at random */
653 static char ethaddr [2 * ETH_ALEN + 1];
655 /* static strings, in UTF-8 */
656 static struct usb_string strings [] = {
657 { STRING_MANUFACTURER, manufacturer, },
658 { STRING_PRODUCT, product_desc, },
659 { STRING_SERIALNUMBER, serial_number, },
660 { STRING_DATA, "Ethernet Data", },
661 { STRING_ETHADDR, ethaddr, },
662 #ifdef DEV_CONFIG_CDC
663 { STRING_CDC, "CDC Ethernet", },
664 { STRING_CONTROL, "CDC Communications Control", },
666 #ifdef DEV_CONFIG_SUBSET
667 { STRING_SUBSET, "CDC Ethernet Subset", },
669 { } /* end of list */
672 static struct usb_gadget_strings stringtab = {
673 .language = 0x0409, /* en-us */
678 /*============================================================================*/
679 static u8 control_req[USB_BUFSIZ];
680 static u8 status_req[STATUS_BYTECOUNT];
685 * strlcpy - Copy a %NUL terminated string into a sized buffer
686 * @dest: Where to copy the string to
687 * @src: Where to copy the string from
688 * @size: size of destination buffer
690 * Compatible with *BSD: the result is always a valid
691 * NUL-terminated string that fits in the buffer (unless,
692 * of course, the buffer size is zero). It does not pad
693 * out the result like strncpy() does.
695 size_t strlcpy(char *dest, const char *src, size_t size)
697 size_t ret = strlen(src);
700 size_t len = (ret >= size) ? size - 1 : ret;
701 memcpy(dest, src, len);
708 /*============================================================================*/
711 * one config, two interfaces: control, data.
712 * complications: class descriptors, and an altsetting.
715 config_buf(struct usb_gadget *g, u8 *buf, u8 type, unsigned index, int is_otg)
718 const struct usb_config_descriptor *config;
719 const struct usb_descriptor_header **function;
722 if (gadget_is_dualspeed(g)) {
723 hs = (g->speed == USB_SPEED_HIGH);
724 if (type == USB_DT_OTHER_SPEED_CONFIG)
727 #define which_fn(t) (hs ? hs_ ## t ## _function : fs_ ## t ## _function)
729 if (index >= device_desc.bNumConfigurations)
732 config = ð_config;
733 function = which_fn (eth);
735 /* for now, don't advertise srp-only devices */
739 len = usb_gadget_config_buf (config, buf, USB_BUFSIZ, function);
742 ((struct usb_config_descriptor *) buf)->bDescriptorType = type;
746 /*-------------------------------------------------------------------------*/
748 static int alloc_requests (struct eth_dev *dev, unsigned n, gfp_t gfp_flags);
751 set_ether_config (struct eth_dev *dev, gfp_t gfp_flags)
754 struct usb_gadget *gadget = dev->gadget;
756 #if defined(DEV_CONFIG_CDC)
757 /* status endpoint used for (optionally) CDC */
758 if (!subset_active(dev) && dev->status_ep) {
759 dev->status = ep_desc (gadget, &hs_status_desc,
761 dev->status_ep->driver_data = dev;
763 result = usb_ep_enable (dev->status_ep, dev->status);
765 debug("enable %s --> %d\n",
766 dev->status_ep->name, result);
772 dev->in = ep_desc(gadget, &hs_source_desc, &fs_source_desc);
773 dev->in_ep->driver_data = dev;
775 dev->out = ep_desc(gadget, &hs_sink_desc, &fs_sink_desc);
776 dev->out_ep->driver_data = dev;
778 /* With CDC, the host isn't allowed to use these two data
779 * endpoints in the default altsetting for the interface.
780 * so we don't activate them yet. Reset from SET_INTERFACE.
782 if (!cdc_active(dev)) {
783 result = usb_ep_enable (dev->in_ep, dev->in);
785 debug("enable %s --> %d\n",
786 dev->in_ep->name, result);
790 result = usb_ep_enable (dev->out_ep, dev->out);
792 debug("enable %s --> %d\n",
793 dev->out_ep->name, result);
800 result = alloc_requests (dev, qlen (gadget), gfp_flags);
802 /* on error, disable any endpoints */
804 if (!subset_active(dev) && dev->status_ep)
805 (void) usb_ep_disable (dev->status_ep);
807 (void) usb_ep_disable (dev->in_ep);
808 (void) usb_ep_disable (dev->out_ep);
813 /* caller is responsible for cleanup on error */
818 static void eth_reset_config (struct eth_dev *dev)
820 if (dev->config == 0)
823 debug("%s\n", __func__);
825 /* disable endpoints, forcing (synchronous) completion of
826 * pending i/o. then free the requests.
830 usb_ep_disable (dev->in_ep);
832 usb_ep_free_request (dev->in_ep, dev->tx_req);
837 usb_ep_disable (dev->out_ep);
839 usb_ep_free_request (dev->out_ep, dev->rx_req);
844 usb_ep_disable (dev->status_ep);
850 /* change our operational config. must agree with the code
851 * that returns config descriptors, and altsetting code.
853 static int eth_set_config (struct eth_dev *dev, unsigned number, gfp_t gfp_flags)
856 struct usb_gadget *gadget = dev->gadget;
858 if (gadget_is_sa1100 (gadget)
860 && dev->tx_qlen != 0) {
861 /* tx fifo is full, but we can't clear it...*/
862 error("can't change configurations");
865 eth_reset_config (dev);
868 case DEV_CONFIG_VALUE:
869 result = set_ether_config (dev, gfp_flags);
880 eth_reset_config (dev);
881 usb_gadget_vbus_draw(dev->gadget,
882 gadget_is_otg(dev->gadget) ? 8 : 100);
887 power = 2 * eth_config.bMaxPower;
888 usb_gadget_vbus_draw(dev->gadget, power);
890 switch (gadget->speed) {
891 case USB_SPEED_FULL: speed = "full"; break;
892 #ifdef CONFIG_USB_GADGET_DUALSPEED
893 case USB_SPEED_HIGH: speed = "high"; break;
895 default: speed = "?"; break;
898 dev->config = number;
899 printf("%s speed config #%d: %d mA, %s, using %s\n",
900 speed, number, power, driver_desc,
901 (cdc_active(dev)? "CDC Ethernet"
902 : "CDC Ethernet Subset"));
907 /*-------------------------------------------------------------------------*/
909 #ifdef DEV_CONFIG_CDC
911 /* The interrupt endpoint is used in CDC networking models (Ethernet, ATM)
912 * only to notify the host about link status changes (which we support) or
913 * report completion of some encapsulated command. Since
914 * we want this CDC Ethernet code to be vendor-neutral, we don't use that
915 * command mechanism; and only one status request is ever queued.
917 static void eth_status_complete (struct usb_ep *ep, struct usb_request *req)
919 struct usb_cdc_notification *event = req->buf;
920 int value = req->status;
921 struct eth_dev *dev = ep->driver_data;
923 /* issue the second notification if host reads the first */
924 if (event->bNotificationType == USB_CDC_NOTIFY_NETWORK_CONNECTION
926 __le32 *data = req->buf + sizeof *event;
928 event->bmRequestType = 0xA1;
929 event->bNotificationType = USB_CDC_NOTIFY_SPEED_CHANGE;
930 event->wValue = __constant_cpu_to_le16 (0);
931 event->wIndex = __constant_cpu_to_le16 (1);
932 event->wLength = __constant_cpu_to_le16 (8);
934 /* SPEED_CHANGE data is up/down speeds in bits/sec */
935 data [0] = data [1] = cpu_to_le32 (BITRATE (dev->gadget));
937 req->length = STATUS_BYTECOUNT;
938 value = usb_ep_queue (ep, req, GFP_ATOMIC);
939 debug("send SPEED_CHANGE --> %d\n", value);
942 } else if (value != -ECONNRESET) {
943 debug("event %02x --> %d\n",
944 event->bNotificationType, value);
945 if (event->bNotificationType==
946 USB_CDC_NOTIFY_SPEED_CHANGE)
948 l_ethdev.network_started=1;
949 printf("USB network up!\n");
955 static void issue_start_status (struct eth_dev *dev)
957 struct usb_request *req = dev->stat_req;
958 struct usb_cdc_notification *event;
963 * FIXME ugly idiom, maybe we'd be better with just
964 * a "cancel the whole queue" primitive since any
965 * unlink-one primitive has way too many error modes.
966 * here, we "know" toggle is already clear...
968 * FIXME iff req->context != null just dequeue it
970 usb_ep_disable (dev->status_ep);
971 usb_ep_enable (dev->status_ep, dev->status);
973 /* 3.8.1 says to issue first NETWORK_CONNECTION, then
974 * a SPEED_CHANGE. could be useful in some configs.
977 event->bmRequestType = 0xA1;
978 event->bNotificationType = USB_CDC_NOTIFY_NETWORK_CONNECTION;
979 event->wValue = __constant_cpu_to_le16 (1); /* connected */
980 event->wIndex = __constant_cpu_to_le16 (1);
983 req->length = sizeof *event;
984 req->complete = eth_status_complete;
987 value = usb_ep_queue (dev->status_ep, req, GFP_ATOMIC);
989 debug("status buf queue --> %d\n", value);
994 /*-------------------------------------------------------------------------*/
996 static void eth_setup_complete (struct usb_ep *ep, struct usb_request *req)
998 if (req->status || req->actual != req->length)
999 debug("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 debug("%s\n", __func__);
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("HNP available\n");
1076 else if (gadget->a_alt_hnp_support)
1077 debug("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 debug("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 debug("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 */
1191 debug("unknown control req%02x.%02x v%04x i%04x l%d\n",
1192 ctrl->bRequestType, ctrl->bRequest,
1193 wValue, wIndex, wLength);
1196 /* respond with data transfer before status phase? */
1198 debug("respond with data transfer before status phase\n");
1199 req->length = value;
1200 req->zero = value < wLength
1201 && (value % gadget->ep0->maxpacket) == 0;
1202 value = usb_ep_queue (gadget->ep0, req, GFP_ATOMIC);
1204 debug("ep_queue --> %d\n", value);
1206 eth_setup_complete (gadget->ep0, req);
1210 /* host either stalls (value < 0) or reports success */
1215 /*-------------------------------------------------------------------------*/
1217 static void rx_complete (struct usb_ep *ep, struct usb_request *req);
1219 static int rx_submit ( struct eth_dev *dev, struct usb_request *req, \
1222 int retval = -ENOMEM;
1225 /* Padding up to RX_EXTRA handles minor disagreements with host.
1226 * Normally we use the USB "terminate on short read" convention;
1227 * so allow up to (N*maxpacket), since that memory is normally
1228 * already allocated. Some hardware doesn't deal well with short
1229 * reads (e.g. DMA must be N*maxpacket), so for now don't trim a
1230 * byte off the end (to force hardware errors on overflow).
1233 debug("%s\n", __func__);
1235 size = (ETHER_HDR_SIZE + dev->mtu + RX_EXTRA);
1236 size += dev->out_ep->maxpacket - 1;
1237 size -= size % dev->out_ep->maxpacket;
1240 /* Some platforms perform better when IP packets are aligned,
1241 * but on at least one, checksumming fails otherwise.
1244 req->buf = (u8 *) NetRxPackets[0];
1246 req->complete = rx_complete;
1248 retval = usb_ep_queue (dev->out_ep, req, gfp_flags);
1251 error("rx submit --> %d", retval);
1257 static void rx_complete (struct usb_ep *ep, struct usb_request *req)
1259 struct eth_dev *dev = ep->driver_data;
1261 debug("%s: status %d\n", __func__, req->status);
1270 static int alloc_requests (struct eth_dev *dev, unsigned n, gfp_t gfp_flags)
1273 dev->tx_req = usb_ep_alloc_request (dev->in_ep, 0);
1278 dev->rx_req = usb_ep_alloc_request (dev->out_ep, 0);
1286 error("can't alloc requests");
1291 static void tx_complete (struct usb_ep *ep, struct usb_request *req)
1293 debug("%s: status %s\n", __func__, (req->status)?"failed":"ok");
1297 static inline int eth_is_promisc (struct eth_dev *dev)
1299 /* no filters for the CDC subset; always promisc */
1300 if (subset_active (dev))
1302 return dev->cdc_filter & USB_CDC_PACKET_TYPE_PROMISCUOUS;
1306 static int eth_start_xmit (struct sk_buff *skb, struct net_device *net)
1308 struct eth_dev *dev = netdev_priv(net);
1309 int length = skb->len;
1311 struct usb_request *req = NULL;
1312 unsigned long flags;
1314 /* apply outgoing CDC or RNDIS filters */
1315 if (!eth_is_promisc (dev)) {
1316 u8 *dest = skb->data;
1318 if (is_multicast_ether_addr(dest)) {
1321 /* ignores USB_CDC_PACKET_TYPE_MULTICAST and host
1322 * SET_ETHERNET_MULTICAST_FILTERS requests
1324 if (is_broadcast_ether_addr(dest))
1325 type = USB_CDC_PACKET_TYPE_BROADCAST;
1327 type = USB_CDC_PACKET_TYPE_ALL_MULTICAST;
1328 if (!(dev->cdc_filter & type)) {
1329 dev_kfree_skb_any (skb);
1333 /* ignores USB_CDC_PACKET_TYPE_DIRECTED */
1336 spin_lock_irqsave(&dev->req_lock, flags);
1338 * this freelist can be empty if an interrupt triggered disconnect()
1339 * and reconfigured the gadget (shutting down this queue) after the
1340 * network stack decided to xmit but before we got the spinlock.
1342 if (list_empty(&dev->tx_reqs)) {
1343 spin_unlock_irqrestore(&dev->req_lock, flags);
1347 req = container_of (dev->tx_reqs.next, struct usb_request, list);
1348 list_del (&req->list);
1350 /* temporarily stop TX queue when the freelist empties */
1351 if (list_empty (&dev->tx_reqs))
1352 netif_stop_queue (net);
1353 spin_unlock_irqrestore(&dev->req_lock, flags);
1355 /* no buffer copies needed, unless the network stack did it
1356 * or the hardware can't use skb buffers.
1357 * or there's not enough space for any RNDIS headers we need
1359 if (rndis_active(dev)) {
1360 struct sk_buff *skb_rndis;
1362 skb_rndis = skb_realloc_headroom (skb,
1363 sizeof (struct rndis_packet_msg_type));
1367 dev_kfree_skb_any (skb);
1369 rndis_add_hdr (skb);
1372 req->buf = skb->data;
1374 req->complete = tx_complete;
1376 /* use zlp framing on tx for strict CDC-Ether conformance,
1377 * though any robust network rx path ignores extra padding.
1378 * and some hardware doesn't like to write zlps.
1381 if (!dev->zlp && (length % dev->in_ep->maxpacket) == 0)
1384 req->length = length;
1386 /* throttle highspeed IRQ rate back slightly */
1387 if (gadget_is_dualspeed(dev->gadget))
1388 req->no_interrupt = (dev->gadget->speed == USB_SPEED_HIGH)
1389 ? ((atomic_read(&dev->tx_qlen) % qmult) != 0)
1392 retval = usb_ep_queue (dev->in_ep, req, GFP_ATOMIC);
1395 DEBUG (dev, "tx queue err %d\n", retval);
1398 net->trans_start = jiffies;
1399 atomic_inc (&dev->tx_qlen);
1404 dev->stats.tx_dropped++;
1405 dev_kfree_skb_any (skb);
1406 spin_lock_irqsave(&dev->req_lock, flags);
1407 if (list_empty (&dev->tx_reqs))
1408 netif_start_queue (net);
1409 list_add (&req->list, &dev->tx_reqs);
1410 spin_unlock_irqrestore(&dev->req_lock, flags);
1415 /*-------------------------------------------------------------------------*/
1418 static void eth_unbind (struct usb_gadget *gadget)
1420 struct eth_dev *dev = get_gadget_data (gadget);
1422 debug("%s...\n", __func__);
1424 /* we've already been disconnected ... no i/o is active */
1426 usb_ep_free_request (gadget->ep0, dev->req);
1429 if (dev->stat_req) {
1430 usb_ep_free_request (dev->status_ep, dev->stat_req);
1431 dev->stat_req = NULL;
1435 usb_ep_free_request (dev->in_ep, dev->tx_req);
1440 usb_ep_free_request (dev->out_ep, dev->rx_req);
1444 /* unregister_netdev (dev->net);*/
1445 /* free_netdev(dev->net);*/
1447 set_gadget_data (gadget, NULL);
1450 static void eth_disconnect (struct usb_gadget *gadget)
1452 eth_reset_config (get_gadget_data (gadget));
1455 static void eth_suspend (struct usb_gadget *gadget)
1460 static void eth_resume (struct usb_gadget *gadget)
1465 /*-------------------------------------------------------------------------*/
1467 static int is_eth_addr_valid(char *str)
1469 if (strlen(str) == 17) {
1474 /* see if it looks like an ethernet address */
1478 for (i = 0; i < 6; i++) {
1479 char term = (i == 5 ? '\0' : ':');
1481 ea[i] = simple_strtol(p, &q, 16);
1483 if ((q - p) != 2 || *q++ != term)
1489 if (i == 6) /* it looks ok */
1495 static u8 nibble (unsigned char c)
1497 if (likely (isdigit (c)))
1500 if (likely (isxdigit (c)))
1501 return 10 + c - 'A';
1505 static int get_ether_addr(const char *str, u8 *dev_addr)
1510 for (i = 0; i < 6; i++) {
1513 if((*str == '.') || (*str == ':'))
1515 num = nibble(*str++) << 4;
1516 num |= (nibble(*str++));
1519 if (is_valid_ether_addr (dev_addr))
1525 static int eth_bind(struct usb_gadget *gadget)
1527 struct eth_dev *dev = &l_ethdev;
1528 u8 cdc = 1, zlp = 1;
1529 struct usb_ep *in_ep, *out_ep, *status_ep = NULL;
1533 /* these flags are only ever cleared; compiler take note */
1534 #ifndef DEV_CONFIG_CDC
1537 /* Because most host side USB stacks handle CDC Ethernet, that
1538 * standard protocol is _strongly_ preferred for interop purposes.
1539 * (By everyone except Microsoft.)
1541 if (gadget_is_pxa (gadget)) {
1542 /* pxa doesn't support altsettings */
1544 } else if (gadget_is_musbhdrc(gadget)) {
1545 /* reduce tx dma overhead by avoiding special cases */
1547 } else if (gadget_is_sh(gadget)) {
1548 /* sh doesn't support multiple interfaces or configs */
1550 } else if (gadget_is_sa1100 (gadget)) {
1551 /* hardware can't write zlps */
1553 /* sa1100 CAN do CDC, without status endpoint ... we use
1554 * non-CDC to be compatible with ARM Linux-2.4 "usb-eth".
1559 gcnum = usb_gadget_controller_number (gadget);
1561 device_desc.bcdDevice = cpu_to_le16 (0x0300 + gcnum);
1563 /* can't assume CDC works. don't want to default to
1564 * anything less functional on CDC-capable hardware,
1565 * so we fail in this case.
1567 error("controller '%s' not recognized",
1572 /* CDC subset ... recognized by Linux since 2.4.10, but Windows
1573 * drivers aren't widely available. (That may be improved by
1574 * supporting one submode of the "SAFE" variant of MDLM.)
1577 device_desc.idVendor =
1578 __constant_cpu_to_le16(SIMPLE_VENDOR_NUM);
1579 device_desc.idProduct =
1580 __constant_cpu_to_le16(SIMPLE_PRODUCT_NUM);
1583 /* support optional vendor/distro customization */
1584 #if defined(CONFIG_USB_CDC_VENDOR_ID) && defined(CONFIG_USB_CDC_PRODUCT_ID)
1585 device_desc.idVendor = cpu_to_le16(CONFIG_USB_CDC_VENDOR_ID);
1586 device_desc.idProduct = cpu_to_le16(CONFIG_USB_CDC_PRODUCT_ID);
1589 device_desc.bcdDevice = cpu_to_le16(bcdDevice);
1591 strlcpy (manufacturer, iManufacturer, sizeof manufacturer);
1593 strlcpy (product_desc, iProduct, sizeof product_desc);
1594 if (iSerialNumber) {
1595 device_desc.iSerialNumber = STRING_SERIALNUMBER,
1596 strlcpy(serial_number, iSerialNumber, sizeof serial_number);
1599 /* all we really need is bulk IN/OUT */
1600 usb_ep_autoconfig_reset (gadget);
1601 in_ep = usb_ep_autoconfig (gadget, &fs_source_desc);
1604 error("can't autoconfigure on %s\n",
1608 in_ep->driver_data = in_ep; /* claim */
1610 out_ep = usb_ep_autoconfig (gadget, &fs_sink_desc);
1613 out_ep->driver_data = out_ep; /* claim */
1615 #if defined(DEV_CONFIG_CDC)
1616 /* CDC Ethernet control interface doesn't require a status endpoint.
1617 * Since some hosts expect one, try to allocate one anyway.
1620 status_ep = usb_ep_autoconfig (gadget, &fs_status_desc);
1622 status_ep->driver_data = status_ep; /* claim */
1624 control_intf.bNumEndpoints = 0;
1625 /* FIXME remove endpoint from descriptor list */
1630 /* one config: cdc, else minimal subset */
1632 eth_config.bNumInterfaces = 1;
1633 eth_config.iConfiguration = STRING_SUBSET;
1635 /* use functions to set these up, in case we're built to work
1636 * with multiple controllers and must override CDC Ethernet.
1638 fs_subset_descriptors();
1639 hs_subset_descriptors();
1642 device_desc.bMaxPacketSize0 = gadget->ep0->maxpacket;
1643 usb_gadget_set_selfpowered (gadget);
1645 if (gadget_is_dualspeed(gadget)) {
1647 dev_qualifier.bDeviceClass = USB_CLASS_VENDOR_SPEC;
1649 /* assumes ep0 uses the same value for both speeds ... */
1650 dev_qualifier.bMaxPacketSize0 = device_desc.bMaxPacketSize0;
1652 /* and that all endpoints are dual-speed */
1653 hs_source_desc.bEndpointAddress =
1654 fs_source_desc.bEndpointAddress;
1655 hs_sink_desc.bEndpointAddress =
1656 fs_sink_desc.bEndpointAddress;
1657 #if defined(DEV_CONFIG_CDC)
1659 hs_status_desc.bEndpointAddress =
1660 fs_status_desc.bEndpointAddress;
1664 if (gadget_is_otg(gadget)) {
1665 otg_descriptor.bmAttributes |= USB_OTG_HNP,
1666 eth_config.bmAttributes |= USB_CONFIG_ATT_WAKEUP;
1667 eth_config.bMaxPower = 4;
1670 dev->net = &l_netdev;
1671 strcpy (dev->net->name, USB_NET_NAME);
1677 dev->out_ep = out_ep;
1678 dev->status_ep = status_ep;
1680 /* Module params for these addresses should come from ID proms.
1681 * The host side address is used with CDC, and commonly
1682 * ends up in a persistent config database. It's not clear if
1683 * host side code for the SAFE thing cares -- its original BLAN
1684 * thing didn't, Sharp never assigned those addresses on Zaurii.
1686 get_ether_addr(dev_addr, dev->net->enetaddr);
1688 memset(tmp, 0, sizeof(tmp));
1689 memcpy(tmp, dev->net->enetaddr, sizeof(dev->net->enetaddr));
1691 get_ether_addr(host_addr, dev->host_mac);
1693 sprintf (ethaddr, "%02X%02X%02X%02X%02X%02X",
1694 dev->host_mac [0], dev->host_mac [1],
1695 dev->host_mac [2], dev->host_mac [3],
1696 dev->host_mac [4], dev->host_mac [5]);
1698 printf("using %s, OUT %s IN %s%s%s\n", gadget->name,
1699 out_ep->name, in_ep->name,
1700 status_ep ? " STATUS " : "",
1701 status_ep ? status_ep->name : ""
1703 printf("MAC %02x:%02x:%02x:%02x:%02x:%02x\n",
1704 dev->net->enetaddr [0], dev->net->enetaddr [1],
1705 dev->net->enetaddr [2], dev->net->enetaddr [3],
1706 dev->net->enetaddr [4], dev->net->enetaddr [5]);
1709 printf("HOST MAC %02x:%02x:%02x:%02x:%02x:%02x\n",
1710 dev->host_mac [0], dev->host_mac [1],
1711 dev->host_mac [2], dev->host_mac [3],
1712 dev->host_mac [4], dev->host_mac [5]);
1715 /* use PKTSIZE (or aligned... from u-boot) and set
1716 * wMaxSegmentSize accordingly*/
1717 dev->mtu = PKTSIZE_ALIGN; /* RNDIS does not like this, only 1514, TODO*/
1719 /* preallocate control message data and buffer */
1720 dev->req = usb_ep_alloc_request (gadget->ep0, GFP_KERNEL);
1723 dev->req->buf = control_req;
1724 dev->req->complete = eth_setup_complete;
1726 /* ... and maybe likewise for status transfer */
1727 #if defined(DEV_CONFIG_CDC)
1728 if (dev->status_ep) {
1729 dev->stat_req = usb_ep_alloc_request(dev->status_ep, GFP_KERNEL);
1730 if (!dev->stat_req) {
1731 usb_ep_free_request (dev->status_ep, dev->req);
1735 dev->stat_req->buf = status_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 error("%s failed", __func__);
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 error("received NULL ptr");
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 error("The remote end did not respond in time.");
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;
1803 struct eth_dev *dev = &l_ethdev;
1805 debug("%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 debug("%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 debug("%s: packet received \n", __func__);
1853 NetReceive(NetRxPackets[0],dev->rx_req->length);
1857 rx_submit (dev, dev->rx_req, 0);
1859 else error("dev->rx_req invalid");
1864 void usb_eth_halt(struct eth_device* netdev)
1866 struct eth_dev *dev =&l_ethdev;
1870 error("received NULL ptr");
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 error("Need valid 'usbnet_devaddr' to be set");
1929 if (!is_eth_addr_valid(host_addr)) {
1930 error("Need valid 'usbnet_hostaddr' to be set");
1936 status = usb_gadget_register_driver(ð_driver);
1940 eth_register(netdev);
1944 error("%s failed. error = %d", __func__, status);