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 * SPDX-License-Identifier: GPL-2.0+
12 #include <asm/errno.h>
13 #include <linux/netdevice.h>
14 #include <linux/usb/ch9.h>
15 #include <linux/usb/cdc.h>
16 #include <linux/usb/gadget.h>
19 #include <linux/ctype.h>
21 #include "gadget_chips.h"
24 #define USB_NET_NAME "usb_ether"
27 extern struct platform_data brd;
29 #define spin_unlock(x)
32 unsigned packet_received, packet_sent;
34 #define GFP_ATOMIC ((gfp_t) 0)
35 #define GFP_KERNEL ((gfp_t) 0)
38 * Ethernet gadget driver -- with CDC and non-CDC options
39 * Builds on hardware support for a full duplex link.
41 * CDC Ethernet is the standard USB solution for sending Ethernet frames
42 * using USB. Real hardware tends to use the same framing protocol but look
43 * different for control features. This driver strongly prefers to use
44 * this USB-IF standard as its open-systems interoperability solution;
45 * most host side USB stacks (except from Microsoft) support it.
47 * This is sometimes called "CDC ECM" (Ethernet Control Model) to support
48 * TLA-soup. "CDC ACM" (Abstract Control Model) is for modems, and a new
49 * "CDC EEM" (Ethernet Emulation Model) is starting to spread.
51 * There's some hardware that can't talk CDC ECM. We make that hardware
52 * implement a "minimalist" vendor-agnostic CDC core: same framing, but
53 * link-level setup only requires activating the configuration. Only the
54 * endpoint descriptors, and product/vendor IDs, are relevant; no control
55 * operations are available. Linux supports it, but other host operating
56 * systems may not. (This is a subset of CDC Ethernet.)
58 * It turns out that if you add a few descriptors to that "CDC Subset",
59 * (Windows) host side drivers from MCCI can treat it as one submode of
60 * a proprietary scheme called "SAFE" ... without needing to know about
61 * specific product/vendor IDs. So we do that, making it easier to use
62 * those MS-Windows drivers. Those added descriptors make it resemble a
63 * CDC MDLM device, but they don't change device behavior at all. (See
64 * MCCI Engineering report 950198 "SAFE Networking Functions".)
66 * A third option is also in use. Rather than CDC Ethernet, or something
67 * simpler, Microsoft pushes their own approach: RNDIS. The published
68 * RNDIS specs are ambiguous and appear to be incomplete, and are also
69 * needlessly complex. They borrow more from CDC ACM than CDC ECM.
71 #define ETH_ALEN 6 /* Octets in one ethernet addr */
72 #define ETH_HLEN 14 /* Total octets in header. */
73 #define ETH_ZLEN 60 /* Min. octets in frame sans FCS */
74 #define ETH_DATA_LEN 1500 /* Max. octets in payload */
75 #define ETH_FRAME_LEN PKTSIZE_ALIGN /* Max. octets in frame sans FCS */
76 #define ETH_FCS_LEN 4 /* Octets in the FCS */
78 #define DRIVER_DESC "Ethernet Gadget"
79 /* Based on linux 2.6.27 version */
80 #define DRIVER_VERSION "May Day 2005"
82 static const char shortname[] = "ether";
83 static const char driver_desc[] = DRIVER_DESC;
85 #define RX_EXTRA 20 /* guard against rx overflows */
87 #ifndef CONFIG_USB_ETH_RNDIS
88 #define rndis_uninit(x) do {} while (0)
89 #define rndis_deregister(c) do {} while (0)
90 #define rndis_exit() do {} while (0)
93 /* CDC and RNDIS support the same host-chosen outgoing packet filters. */
94 #define DEFAULT_FILTER (USB_CDC_PACKET_TYPE_BROADCAST \
95 |USB_CDC_PACKET_TYPE_ALL_MULTICAST \
96 |USB_CDC_PACKET_TYPE_PROMISCUOUS \
97 |USB_CDC_PACKET_TYPE_DIRECTED)
99 #define USB_CONNECT_TIMEOUT (3 * CONFIG_SYS_HZ)
101 /*-------------------------------------------------------------------------*/
104 struct usb_gadget *gadget;
105 struct usb_request *req; /* for control responses */
106 struct usb_request *stat_req; /* for cdc & rndis status */
109 struct usb_ep *in_ep, *out_ep, *status_ep;
110 const struct usb_endpoint_descriptor
113 struct usb_request *tx_req, *rx_req;
115 struct eth_device *net;
116 struct net_device_stats stats;
117 unsigned int tx_qlen;
122 unsigned suspended:1;
123 unsigned network_started:1;
127 #define WORK_RX_MEMORY 0
129 u8 host_mac[ETH_ALEN];
133 * This version autoconfigures as much as possible at run-time.
135 * It also ASSUMES a self-powered device, without remote wakeup,
136 * although remote wakeup support would make sense.
139 /*-------------------------------------------------------------------------*/
140 static struct eth_dev l_ethdev;
141 static struct eth_device l_netdev;
142 static struct usb_gadget_driver eth_driver;
144 /*-------------------------------------------------------------------------*/
146 /* "main" config is either CDC, or its simple subset */
147 static inline int is_cdc(struct eth_dev *dev)
149 #if !defined(CONFIG_USB_ETH_SUBSET)
150 return 1; /* only cdc possible */
151 #elif !defined(CONFIG_USB_ETH_CDC)
152 return 0; /* only subset possible */
154 return dev->cdc; /* depends on what hardware we found */
158 /* "secondary" RNDIS config may sometimes be activated */
159 static inline int rndis_active(struct eth_dev *dev)
161 #ifdef CONFIG_USB_ETH_RNDIS
168 #define subset_active(dev) (!is_cdc(dev) && !rndis_active(dev))
169 #define cdc_active(dev) (is_cdc(dev) && !rndis_active(dev))
171 #define DEFAULT_QLEN 2 /* double buffering by default */
173 /* peak bulk transfer bits-per-second */
174 #define HS_BPS (13 * 512 * 8 * 1000 * 8)
175 #define FS_BPS (19 * 64 * 1 * 1000 * 8)
177 #ifdef CONFIG_USB_GADGET_DUALSPEED
178 #define DEVSPEED USB_SPEED_HIGH
180 #ifdef CONFIG_USB_ETH_QMULT
181 #define qmult CONFIG_USB_ETH_QMULT
186 /* for dual-speed hardware, use deeper queues at highspeed */
187 #define qlen(gadget) \
188 (DEFAULT_QLEN*((gadget->speed == USB_SPEED_HIGH) ? qmult : 1))
190 static inline int BITRATE(struct usb_gadget *g)
192 return (g->speed == USB_SPEED_HIGH) ? HS_BPS : FS_BPS;
195 #else /* full speed (low speed doesn't do bulk) */
199 #define DEVSPEED USB_SPEED_FULL
201 #define qlen(gadget) DEFAULT_QLEN
203 static inline int BITRATE(struct usb_gadget *g)
209 /*-------------------------------------------------------------------------*/
212 * DO NOT REUSE THESE IDs with a protocol-incompatible driver!! Ever!!
213 * Instead: allocate your own, using normal USB-IF procedures.
217 * Thanks to NetChip Technologies for donating this product ID.
218 * It's for devices with only CDC Ethernet configurations.
220 #define CDC_VENDOR_NUM 0x0525 /* NetChip */
221 #define CDC_PRODUCT_NUM 0xa4a1 /* Linux-USB Ethernet Gadget */
224 * For hardware that can't talk CDC, we use the same vendor ID that
225 * ARM Linux has used for ethernet-over-usb, both with sa1100 and
226 * with pxa250. We're protocol-compatible, if the host-side drivers
227 * use the endpoint descriptors. bcdDevice (version) is nonzero, so
228 * drivers that need to hard-wire endpoint numbers have a hook.
230 * The protocol is a minimal subset of CDC Ether, which works on any bulk
231 * hardware that's not deeply broken ... even on hardware that can't talk
232 * RNDIS (like SA-1100, with no interrupt endpoint, or anything that
233 * doesn't handle control-OUT).
235 #define SIMPLE_VENDOR_NUM 0x049f /* Compaq Computer Corp. */
236 #define SIMPLE_PRODUCT_NUM 0x505a /* Linux-USB "CDC Subset" Device */
239 * For hardware that can talk RNDIS and either of the above protocols,
240 * use this ID ... the windows INF files will know it. Unless it's
241 * used with CDC Ethernet, Linux 2.4 hosts will need updates to choose
242 * the non-RNDIS configuration.
244 #define RNDIS_VENDOR_NUM 0x0525 /* NetChip */
245 #define RNDIS_PRODUCT_NUM 0xa4a2 /* Ethernet/RNDIS Gadget */
248 * Some systems will want different product identifers published in the
249 * device descriptor, either numbers or strings or both. These string
250 * parameters are in UTF-8 (superset of ASCII's 7 bit characters).
254 * Emulating them in eth_bind:
255 * static ushort idVendor;
256 * static ushort idProduct;
259 #if defined(CONFIG_USBNET_MANUFACTURER)
260 static char *iManufacturer = CONFIG_USBNET_MANUFACTURER;
262 static char *iManufacturer = "U-boot";
265 /* These probably need to be configurable. */
266 static ushort bcdDevice;
267 static char *iProduct;
268 static char *iSerialNumber;
270 static char dev_addr[18];
272 static char host_addr[18];
275 /*-------------------------------------------------------------------------*/
278 * USB DRIVER HOOKUP (to the hardware driver, below us), mostly
279 * ep0 implementation: descriptors, config management, setup().
280 * also optional class-specific notification interrupt transfer.
284 * DESCRIPTORS ... most are static, but strings and (full) configuration
285 * descriptors are built on demand. For now we do either full CDC, or
286 * our simple subset, with RNDIS as an optional second configuration.
288 * RNDIS includes some CDC ACM descriptors ... like CDC Ethernet. But
289 * the class descriptors match a modem (they're ignored; it's really just
290 * Ethernet functionality), they don't need the NOP altsetting, and the
291 * status transfer endpoint isn't optional.
294 #define STRING_MANUFACTURER 1
295 #define STRING_PRODUCT 2
296 #define STRING_ETHADDR 3
297 #define STRING_DATA 4
298 #define STRING_CONTROL 5
299 #define STRING_RNDIS_CONTROL 6
301 #define STRING_SUBSET 8
302 #define STRING_RNDIS 9
303 #define STRING_SERIALNUMBER 10
305 /* holds our biggest descriptor (or RNDIS response) */
306 #define USB_BUFSIZ 256
309 * This device advertises one configuration, eth_config, unless RNDIS
310 * is enabled (rndis_config) on hardware supporting at least two configs.
312 * NOTE: Controllers like superh_udc should probably be able to use
313 * an RNDIS-only configuration.
315 * FIXME define some higher-powered configurations to make it easier
316 * to recharge batteries ...
319 #define DEV_CONFIG_VALUE 1 /* cdc or subset */
320 #define DEV_RNDIS_CONFIG_VALUE 2 /* rndis; optional */
322 static struct usb_device_descriptor
324 .bLength = sizeof device_desc,
325 .bDescriptorType = USB_DT_DEVICE,
327 .bcdUSB = __constant_cpu_to_le16(0x0200),
329 .bDeviceClass = USB_CLASS_COMM,
330 .bDeviceSubClass = 0,
331 .bDeviceProtocol = 0,
333 .idVendor = __constant_cpu_to_le16(CDC_VENDOR_NUM),
334 .idProduct = __constant_cpu_to_le16(CDC_PRODUCT_NUM),
335 .iManufacturer = STRING_MANUFACTURER,
336 .iProduct = STRING_PRODUCT,
337 .bNumConfigurations = 1,
340 static struct usb_otg_descriptor
342 .bLength = sizeof otg_descriptor,
343 .bDescriptorType = USB_DT_OTG,
345 .bmAttributes = USB_OTG_SRP,
348 static struct usb_config_descriptor
350 .bLength = sizeof eth_config,
351 .bDescriptorType = USB_DT_CONFIG,
353 /* compute wTotalLength on the fly */
355 .bConfigurationValue = DEV_CONFIG_VALUE,
356 .iConfiguration = STRING_CDC,
357 .bmAttributes = USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER,
361 #ifdef CONFIG_USB_ETH_RNDIS
362 static struct usb_config_descriptor
364 .bLength = sizeof rndis_config,
365 .bDescriptorType = USB_DT_CONFIG,
367 /* compute wTotalLength on the fly */
369 .bConfigurationValue = DEV_RNDIS_CONFIG_VALUE,
370 .iConfiguration = STRING_RNDIS,
371 .bmAttributes = USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER,
377 * Compared to the simple CDC subset, the full CDC Ethernet model adds
378 * three class descriptors, two interface descriptors, optional status
379 * endpoint. Both have a "data" interface and two bulk endpoints.
380 * There are also differences in how control requests are handled.
382 * RNDIS shares a lot with CDC-Ethernet, since it's a variant of the
383 * CDC-ACM (modem) spec. Unfortunately MSFT's RNDIS driver is buggy; it
384 * may hang or oops. Since bugfixes (or accurate specs, letting Linux
385 * work around those bugs) are unlikely to ever come from MSFT, you may
386 * wish to avoid using RNDIS.
388 * MCCI offers an alternative to RNDIS if you need to connect to Windows
389 * but have hardware that can't support CDC Ethernet. We add descriptors
390 * to present the CDC Subset as a (nonconformant) CDC MDLM variant called
391 * "SAFE". That borrows from both CDC Ethernet and CDC MDLM. You can
392 * get those drivers from MCCI, or bundled with various products.
395 #ifdef CONFIG_USB_ETH_CDC
396 static struct usb_interface_descriptor
398 .bLength = sizeof control_intf,
399 .bDescriptorType = USB_DT_INTERFACE,
401 .bInterfaceNumber = 0,
402 /* status endpoint is optional; this may be patched later */
404 .bInterfaceClass = USB_CLASS_COMM,
405 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET,
406 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
407 .iInterface = STRING_CONTROL,
411 #ifdef CONFIG_USB_ETH_RNDIS
412 static const struct usb_interface_descriptor
413 rndis_control_intf = {
414 .bLength = sizeof rndis_control_intf,
415 .bDescriptorType = USB_DT_INTERFACE,
417 .bInterfaceNumber = 0,
419 .bInterfaceClass = USB_CLASS_COMM,
420 .bInterfaceSubClass = USB_CDC_SUBCLASS_ACM,
421 .bInterfaceProtocol = USB_CDC_ACM_PROTO_VENDOR,
422 .iInterface = STRING_RNDIS_CONTROL,
426 static const struct usb_cdc_header_desc header_desc = {
427 .bLength = sizeof header_desc,
428 .bDescriptorType = USB_DT_CS_INTERFACE,
429 .bDescriptorSubType = USB_CDC_HEADER_TYPE,
431 .bcdCDC = __constant_cpu_to_le16(0x0110),
434 #if defined(CONFIG_USB_ETH_CDC) || defined(CONFIG_USB_ETH_RNDIS)
436 static const struct usb_cdc_union_desc union_desc = {
437 .bLength = sizeof union_desc,
438 .bDescriptorType = USB_DT_CS_INTERFACE,
439 .bDescriptorSubType = USB_CDC_UNION_TYPE,
441 .bMasterInterface0 = 0, /* index of control interface */
442 .bSlaveInterface0 = 1, /* index of DATA interface */
445 #endif /* CDC || RNDIS */
447 #ifdef CONFIG_USB_ETH_RNDIS
449 static const struct usb_cdc_call_mgmt_descriptor call_mgmt_descriptor = {
450 .bLength = sizeof call_mgmt_descriptor,
451 .bDescriptorType = USB_DT_CS_INTERFACE,
452 .bDescriptorSubType = USB_CDC_CALL_MANAGEMENT_TYPE,
454 .bmCapabilities = 0x00,
455 .bDataInterface = 0x01,
458 static const struct usb_cdc_acm_descriptor acm_descriptor = {
459 .bLength = sizeof acm_descriptor,
460 .bDescriptorType = USB_DT_CS_INTERFACE,
461 .bDescriptorSubType = USB_CDC_ACM_TYPE,
463 .bmCapabilities = 0x00,
468 #ifndef CONFIG_USB_ETH_CDC
471 * "SAFE" loosely follows CDC WMC MDLM, violating the spec in various
472 * ways: data endpoints live in the control interface, there's no data
473 * interface, and it's not used to talk to a cell phone radio.
476 static const struct usb_cdc_mdlm_desc mdlm_desc = {
477 .bLength = sizeof mdlm_desc,
478 .bDescriptorType = USB_DT_CS_INTERFACE,
479 .bDescriptorSubType = USB_CDC_MDLM_TYPE,
481 .bcdVersion = __constant_cpu_to_le16(0x0100),
483 0x5d, 0x34, 0xcf, 0x66, 0x11, 0x18, 0x11, 0xd6,
484 0xa2, 0x1a, 0x00, 0x01, 0x02, 0xca, 0x9a, 0x7f,
489 * since "usb_cdc_mdlm_detail_desc" is a variable length structure, we
490 * can't really use its struct. All we do here is say that we're using
491 * the submode of "SAFE" which directly matches the CDC Subset.
493 static const u8 mdlm_detail_desc[] = {
496 USB_CDC_MDLM_DETAIL_TYPE,
499 0, /* network control capabilities (none) */
500 0, /* network data capabilities ("raw" encapsulation) */
505 static const struct usb_cdc_ether_desc ether_desc = {
506 .bLength = sizeof(ether_desc),
507 .bDescriptorType = USB_DT_CS_INTERFACE,
508 .bDescriptorSubType = USB_CDC_ETHERNET_TYPE,
510 /* this descriptor actually adds value, surprise! */
511 .iMACAddress = STRING_ETHADDR,
512 .bmEthernetStatistics = __constant_cpu_to_le32(0), /* no statistics */
513 .wMaxSegmentSize = __constant_cpu_to_le16(ETH_FRAME_LEN),
514 .wNumberMCFilters = __constant_cpu_to_le16(0),
515 .bNumberPowerFilters = 0,
518 #if defined(CONFIG_USB_ETH_CDC) || defined(CONFIG_USB_ETH_RNDIS)
521 * include the status endpoint if we can, even where it's optional.
522 * use wMaxPacketSize big enough to fit CDC_NOTIFY_SPEED_CHANGE in one
523 * packet, to simplify cancellation; and a big transfer interval, to
524 * waste less bandwidth.
526 * some drivers (like Linux 2.4 cdc-ether!) "need" it to exist even
527 * if they ignore the connect/disconnect notifications that real aether
528 * can provide. more advanced cdc configurations might want to support
529 * encapsulated commands (vendor-specific, using control-OUT).
531 * RNDIS requires the status endpoint, since it uses that encapsulation
532 * mechanism for its funky RPC scheme.
535 #define LOG2_STATUS_INTERVAL_MSEC 5 /* 1 << 5 == 32 msec */
536 #define STATUS_BYTECOUNT 16 /* 8 byte header + data */
538 static struct usb_endpoint_descriptor
540 .bLength = USB_DT_ENDPOINT_SIZE,
541 .bDescriptorType = USB_DT_ENDPOINT,
543 .bEndpointAddress = USB_DIR_IN,
544 .bmAttributes = USB_ENDPOINT_XFER_INT,
545 .wMaxPacketSize = __constant_cpu_to_le16(STATUS_BYTECOUNT),
546 .bInterval = 1 << LOG2_STATUS_INTERVAL_MSEC,
550 #ifdef CONFIG_USB_ETH_CDC
552 /* the default data interface has no endpoints ... */
554 static const struct usb_interface_descriptor
556 .bLength = sizeof data_nop_intf,
557 .bDescriptorType = USB_DT_INTERFACE,
559 .bInterfaceNumber = 1,
560 .bAlternateSetting = 0,
562 .bInterfaceClass = USB_CLASS_CDC_DATA,
563 .bInterfaceSubClass = 0,
564 .bInterfaceProtocol = 0,
567 /* ... but the "real" data interface has two bulk endpoints */
569 static const struct usb_interface_descriptor
571 .bLength = sizeof data_intf,
572 .bDescriptorType = USB_DT_INTERFACE,
574 .bInterfaceNumber = 1,
575 .bAlternateSetting = 1,
577 .bInterfaceClass = USB_CLASS_CDC_DATA,
578 .bInterfaceSubClass = 0,
579 .bInterfaceProtocol = 0,
580 .iInterface = STRING_DATA,
585 #ifdef CONFIG_USB_ETH_RNDIS
587 /* RNDIS doesn't activate by changing to the "real" altsetting */
589 static const struct usb_interface_descriptor
591 .bLength = sizeof rndis_data_intf,
592 .bDescriptorType = USB_DT_INTERFACE,
594 .bInterfaceNumber = 1,
595 .bAlternateSetting = 0,
597 .bInterfaceClass = USB_CLASS_CDC_DATA,
598 .bInterfaceSubClass = 0,
599 .bInterfaceProtocol = 0,
600 .iInterface = STRING_DATA,
605 #ifdef CONFIG_USB_ETH_SUBSET
608 * "Simple" CDC-subset option is a simple vendor-neutral model that most
609 * full speed controllers can handle: one interface, two bulk endpoints.
611 * To assist host side drivers, we fancy it up a bit, and add descriptors
612 * so some host side drivers will understand it as a "SAFE" variant.
615 static const struct usb_interface_descriptor
617 .bLength = sizeof subset_data_intf,
618 .bDescriptorType = USB_DT_INTERFACE,
620 .bInterfaceNumber = 0,
621 .bAlternateSetting = 0,
623 .bInterfaceClass = USB_CLASS_COMM,
624 .bInterfaceSubClass = USB_CDC_SUBCLASS_MDLM,
625 .bInterfaceProtocol = 0,
626 .iInterface = STRING_DATA,
631 static struct usb_endpoint_descriptor
633 .bLength = USB_DT_ENDPOINT_SIZE,
634 .bDescriptorType = USB_DT_ENDPOINT,
636 .bEndpointAddress = USB_DIR_IN,
637 .bmAttributes = USB_ENDPOINT_XFER_BULK,
640 static struct usb_endpoint_descriptor
642 .bLength = USB_DT_ENDPOINT_SIZE,
643 .bDescriptorType = USB_DT_ENDPOINT,
645 .bEndpointAddress = USB_DIR_OUT,
646 .bmAttributes = USB_ENDPOINT_XFER_BULK,
649 static const struct usb_descriptor_header *fs_eth_function[11] = {
650 (struct usb_descriptor_header *) &otg_descriptor,
651 #ifdef CONFIG_USB_ETH_CDC
652 /* "cdc" mode descriptors */
653 (struct usb_descriptor_header *) &control_intf,
654 (struct usb_descriptor_header *) &header_desc,
655 (struct usb_descriptor_header *) &union_desc,
656 (struct usb_descriptor_header *) ðer_desc,
657 /* NOTE: status endpoint may need to be removed */
658 (struct usb_descriptor_header *) &fs_status_desc,
659 /* data interface, with altsetting */
660 (struct usb_descriptor_header *) &data_nop_intf,
661 (struct usb_descriptor_header *) &data_intf,
662 (struct usb_descriptor_header *) &fs_source_desc,
663 (struct usb_descriptor_header *) &fs_sink_desc,
665 #endif /* CONFIG_USB_ETH_CDC */
668 static inline void fs_subset_descriptors(void)
670 #ifdef CONFIG_USB_ETH_SUBSET
671 /* behavior is "CDC Subset"; extra descriptors say "SAFE" */
672 fs_eth_function[1] = (struct usb_descriptor_header *) &subset_data_intf;
673 fs_eth_function[2] = (struct usb_descriptor_header *) &header_desc;
674 fs_eth_function[3] = (struct usb_descriptor_header *) &mdlm_desc;
675 fs_eth_function[4] = (struct usb_descriptor_header *) &mdlm_detail_desc;
676 fs_eth_function[5] = (struct usb_descriptor_header *) ðer_desc;
677 fs_eth_function[6] = (struct usb_descriptor_header *) &fs_source_desc;
678 fs_eth_function[7] = (struct usb_descriptor_header *) &fs_sink_desc;
679 fs_eth_function[8] = NULL;
681 fs_eth_function[1] = NULL;
685 #ifdef CONFIG_USB_ETH_RNDIS
686 static const struct usb_descriptor_header *fs_rndis_function[] = {
687 (struct usb_descriptor_header *) &otg_descriptor,
688 /* control interface matches ACM, not Ethernet */
689 (struct usb_descriptor_header *) &rndis_control_intf,
690 (struct usb_descriptor_header *) &header_desc,
691 (struct usb_descriptor_header *) &call_mgmt_descriptor,
692 (struct usb_descriptor_header *) &acm_descriptor,
693 (struct usb_descriptor_header *) &union_desc,
694 (struct usb_descriptor_header *) &fs_status_desc,
695 /* data interface has no altsetting */
696 (struct usb_descriptor_header *) &rndis_data_intf,
697 (struct usb_descriptor_header *) &fs_source_desc,
698 (struct usb_descriptor_header *) &fs_sink_desc,
704 * usb 2.0 devices need to expose both high speed and full speed
705 * descriptors, unless they only run at full speed.
708 #if defined(CONFIG_USB_ETH_CDC) || defined(CONFIG_USB_ETH_RNDIS)
709 static struct usb_endpoint_descriptor
711 .bLength = USB_DT_ENDPOINT_SIZE,
712 .bDescriptorType = USB_DT_ENDPOINT,
714 .bmAttributes = USB_ENDPOINT_XFER_INT,
715 .wMaxPacketSize = __constant_cpu_to_le16(STATUS_BYTECOUNT),
716 .bInterval = LOG2_STATUS_INTERVAL_MSEC + 4,
718 #endif /* CONFIG_USB_ETH_CDC */
720 static struct usb_endpoint_descriptor
722 .bLength = USB_DT_ENDPOINT_SIZE,
723 .bDescriptorType = USB_DT_ENDPOINT,
725 .bmAttributes = USB_ENDPOINT_XFER_BULK,
726 .wMaxPacketSize = __constant_cpu_to_le16(512),
729 static struct usb_endpoint_descriptor
731 .bLength = USB_DT_ENDPOINT_SIZE,
732 .bDescriptorType = USB_DT_ENDPOINT,
734 .bmAttributes = USB_ENDPOINT_XFER_BULK,
735 .wMaxPacketSize = __constant_cpu_to_le16(512),
738 static struct usb_qualifier_descriptor
740 .bLength = sizeof dev_qualifier,
741 .bDescriptorType = USB_DT_DEVICE_QUALIFIER,
743 .bcdUSB = __constant_cpu_to_le16(0x0200),
744 .bDeviceClass = USB_CLASS_COMM,
746 .bNumConfigurations = 1,
749 static const struct usb_descriptor_header *hs_eth_function[11] = {
750 (struct usb_descriptor_header *) &otg_descriptor,
751 #ifdef CONFIG_USB_ETH_CDC
752 /* "cdc" mode descriptors */
753 (struct usb_descriptor_header *) &control_intf,
754 (struct usb_descriptor_header *) &header_desc,
755 (struct usb_descriptor_header *) &union_desc,
756 (struct usb_descriptor_header *) ðer_desc,
757 /* NOTE: status endpoint may need to be removed */
758 (struct usb_descriptor_header *) &hs_status_desc,
759 /* data interface, with altsetting */
760 (struct usb_descriptor_header *) &data_nop_intf,
761 (struct usb_descriptor_header *) &data_intf,
762 (struct usb_descriptor_header *) &hs_source_desc,
763 (struct usb_descriptor_header *) &hs_sink_desc,
765 #endif /* CONFIG_USB_ETH_CDC */
768 static inline void hs_subset_descriptors(void)
770 #ifdef CONFIG_USB_ETH_SUBSET
771 /* behavior is "CDC Subset"; extra descriptors say "SAFE" */
772 hs_eth_function[1] = (struct usb_descriptor_header *) &subset_data_intf;
773 hs_eth_function[2] = (struct usb_descriptor_header *) &header_desc;
774 hs_eth_function[3] = (struct usb_descriptor_header *) &mdlm_desc;
775 hs_eth_function[4] = (struct usb_descriptor_header *) &mdlm_detail_desc;
776 hs_eth_function[5] = (struct usb_descriptor_header *) ðer_desc;
777 hs_eth_function[6] = (struct usb_descriptor_header *) &hs_source_desc;
778 hs_eth_function[7] = (struct usb_descriptor_header *) &hs_sink_desc;
779 hs_eth_function[8] = NULL;
781 hs_eth_function[1] = NULL;
785 #ifdef CONFIG_USB_ETH_RNDIS
786 static const struct usb_descriptor_header *hs_rndis_function[] = {
787 (struct usb_descriptor_header *) &otg_descriptor,
788 /* control interface matches ACM, not Ethernet */
789 (struct usb_descriptor_header *) &rndis_control_intf,
790 (struct usb_descriptor_header *) &header_desc,
791 (struct usb_descriptor_header *) &call_mgmt_descriptor,
792 (struct usb_descriptor_header *) &acm_descriptor,
793 (struct usb_descriptor_header *) &union_desc,
794 (struct usb_descriptor_header *) &hs_status_desc,
795 /* data interface has no altsetting */
796 (struct usb_descriptor_header *) &rndis_data_intf,
797 (struct usb_descriptor_header *) &hs_source_desc,
798 (struct usb_descriptor_header *) &hs_sink_desc,
804 /* maxpacket and other transfer characteristics vary by speed. */
805 static inline struct usb_endpoint_descriptor *
806 ep_desc(struct usb_gadget *g, struct usb_endpoint_descriptor *hs,
807 struct usb_endpoint_descriptor *fs)
809 if (gadget_is_dualspeed(g) && g->speed == USB_SPEED_HIGH)
814 /*-------------------------------------------------------------------------*/
816 /* descriptors that are built on-demand */
818 static char manufacturer[50];
819 static char product_desc[40] = DRIVER_DESC;
820 static char serial_number[20];
822 /* address that the host will use ... usually assigned at random */
823 static char ethaddr[2 * ETH_ALEN + 1];
825 /* static strings, in UTF-8 */
826 static struct usb_string strings[] = {
827 { STRING_MANUFACTURER, manufacturer, },
828 { STRING_PRODUCT, product_desc, },
829 { STRING_SERIALNUMBER, serial_number, },
830 { STRING_DATA, "Ethernet Data", },
831 { STRING_ETHADDR, ethaddr, },
832 #ifdef CONFIG_USB_ETH_CDC
833 { STRING_CDC, "CDC Ethernet", },
834 { STRING_CONTROL, "CDC Communications Control", },
836 #ifdef CONFIG_USB_ETH_SUBSET
837 { STRING_SUBSET, "CDC Ethernet Subset", },
839 #ifdef CONFIG_USB_ETH_RNDIS
840 { STRING_RNDIS, "RNDIS", },
841 { STRING_RNDIS_CONTROL, "RNDIS Communications Control", },
843 { } /* end of list */
846 static struct usb_gadget_strings stringtab = {
847 .language = 0x0409, /* en-us */
851 /*============================================================================*/
852 static u8 control_req[USB_BUFSIZ];
853 #if defined(CONFIG_USB_ETH_CDC) || defined(CONFIG_USB_ETH_RNDIS)
854 static u8 status_req[STATUS_BYTECOUNT] __attribute__ ((aligned(4)));
859 * strlcpy - Copy a %NUL terminated string into a sized buffer
860 * @dest: Where to copy the string to
861 * @src: Where to copy the string from
862 * @size: size of destination buffer
864 * Compatible with *BSD: the result is always a valid
865 * NUL-terminated string that fits in the buffer (unless,
866 * of course, the buffer size is zero). It does not pad
867 * out the result like strncpy() does.
869 size_t strlcpy(char *dest, const char *src, size_t size)
871 size_t ret = strlen(src);
874 size_t len = (ret >= size) ? size - 1 : ret;
875 memcpy(dest, src, len);
881 /*============================================================================*/
884 * one config, two interfaces: control, data.
885 * complications: class descriptors, and an altsetting.
888 config_buf(struct usb_gadget *g, u8 *buf, u8 type, unsigned index, int is_otg)
891 const struct usb_config_descriptor *config;
892 const struct usb_descriptor_header **function;
895 if (gadget_is_dualspeed(g)) {
896 hs = (g->speed == USB_SPEED_HIGH);
897 if (type == USB_DT_OTHER_SPEED_CONFIG)
900 #define which_fn(t) (hs ? hs_ ## t ## _function : fs_ ## t ## _function)
902 if (index >= device_desc.bNumConfigurations)
905 #ifdef CONFIG_USB_ETH_RNDIS
907 * list the RNDIS config first, to make Microsoft's drivers
908 * happy. DOCSIS 1.0 needs this too.
910 if (device_desc.bNumConfigurations == 2 && index == 0) {
911 config = &rndis_config;
912 function = which_fn(rndis);
916 config = ð_config;
917 function = which_fn(eth);
920 /* for now, don't advertise srp-only devices */
924 len = usb_gadget_config_buf(config, buf, USB_BUFSIZ, function);
927 ((struct usb_config_descriptor *) buf)->bDescriptorType = type;
931 /*-------------------------------------------------------------------------*/
933 static void eth_start(struct eth_dev *dev, gfp_t gfp_flags);
934 static int alloc_requests(struct eth_dev *dev, unsigned n, gfp_t gfp_flags);
937 set_ether_config(struct eth_dev *dev, gfp_t gfp_flags)
940 struct usb_gadget *gadget = dev->gadget;
942 #if defined(CONFIG_USB_ETH_CDC) || defined(CONFIG_USB_ETH_RNDIS)
943 /* status endpoint used for RNDIS and (optionally) CDC */
944 if (!subset_active(dev) && dev->status_ep) {
945 dev->status = ep_desc(gadget, &hs_status_desc,
947 dev->status_ep->driver_data = dev;
949 result = usb_ep_enable(dev->status_ep, dev->status);
951 debug("enable %s --> %d\n",
952 dev->status_ep->name, result);
958 dev->in = ep_desc(gadget, &hs_source_desc, &fs_source_desc);
959 dev->in_ep->driver_data = dev;
961 dev->out = ep_desc(gadget, &hs_sink_desc, &fs_sink_desc);
962 dev->out_ep->driver_data = dev;
965 * With CDC, the host isn't allowed to use these two data
966 * endpoints in the default altsetting for the interface.
967 * so we don't activate them yet. Reset from SET_INTERFACE.
969 * Strictly speaking RNDIS should work the same: activation is
970 * a side effect of setting a packet filter. Deactivation is
971 * from REMOTE_NDIS_HALT_MSG, reset from REMOTE_NDIS_RESET_MSG.
973 if (!cdc_active(dev)) {
974 result = usb_ep_enable(dev->in_ep, dev->in);
976 debug("enable %s --> %d\n",
977 dev->in_ep->name, result);
981 result = usb_ep_enable(dev->out_ep, dev->out);
983 debug("enable %s --> %d\n",
984 dev->out_ep->name, result);
991 result = alloc_requests(dev, qlen(gadget), gfp_flags);
993 /* on error, disable any endpoints */
995 if (!subset_active(dev) && dev->status_ep)
996 (void) usb_ep_disable(dev->status_ep);
998 (void) usb_ep_disable(dev->in_ep);
999 (void) usb_ep_disable(dev->out_ep);
1002 } else if (!cdc_active(dev)) {
1004 * activate non-CDC configs right away
1005 * this isn't strictly according to the RNDIS spec
1007 eth_start(dev, GFP_ATOMIC);
1010 /* caller is responsible for cleanup on error */
1014 static void eth_reset_config(struct eth_dev *dev)
1016 if (dev->config == 0)
1019 debug("%s\n", __func__);
1021 rndis_uninit(dev->rndis_config);
1024 * disable endpoints, forcing (synchronous) completion of
1025 * pending i/o. then free the requests.
1029 usb_ep_disable(dev->in_ep);
1031 usb_ep_free_request(dev->in_ep, dev->tx_req);
1036 usb_ep_disable(dev->out_ep);
1038 usb_ep_free_request(dev->out_ep, dev->rx_req);
1043 usb_ep_disable(dev->status_ep);
1046 dev->cdc_filter = 0;
1051 * change our operational config. must agree with the code
1052 * that returns config descriptors, and altsetting code.
1054 static int eth_set_config(struct eth_dev *dev, unsigned number,
1058 struct usb_gadget *gadget = dev->gadget;
1060 if (gadget_is_sa1100(gadget)
1062 && dev->tx_qlen != 0) {
1063 /* tx fifo is full, but we can't clear it...*/
1064 error("can't change configurations");
1067 eth_reset_config(dev);
1070 case DEV_CONFIG_VALUE:
1071 result = set_ether_config(dev, gfp_flags);
1073 #ifdef CONFIG_USB_ETH_RNDIS
1074 case DEV_RNDIS_CONFIG_VALUE:
1076 result = set_ether_config(dev, gfp_flags);
1088 eth_reset_config(dev);
1089 usb_gadget_vbus_draw(dev->gadget,
1090 gadget_is_otg(dev->gadget) ? 8 : 100);
1095 power = 2 * eth_config.bMaxPower;
1096 usb_gadget_vbus_draw(dev->gadget, power);
1098 switch (gadget->speed) {
1099 case USB_SPEED_FULL:
1100 speed = "full"; break;
1101 #ifdef CONFIG_USB_GADGET_DUALSPEED
1102 case USB_SPEED_HIGH:
1103 speed = "high"; break;
1109 dev->config = number;
1110 printf("%s speed config #%d: %d mA, %s, using %s\n",
1111 speed, number, power, driver_desc,
1116 : "CDC Ethernet Subset"));
1121 /*-------------------------------------------------------------------------*/
1123 #ifdef CONFIG_USB_ETH_CDC
1126 * The interrupt endpoint is used in CDC networking models (Ethernet, ATM)
1127 * only to notify the host about link status changes (which we support) or
1128 * report completion of some encapsulated command (as used in RNDIS). Since
1129 * we want this CDC Ethernet code to be vendor-neutral, we don't use that
1130 * command mechanism; and only one status request is ever queued.
1132 static void eth_status_complete(struct usb_ep *ep, struct usb_request *req)
1134 struct usb_cdc_notification *event = req->buf;
1135 int value = req->status;
1136 struct eth_dev *dev = ep->driver_data;
1138 /* issue the second notification if host reads the first */
1139 if (event->bNotificationType == USB_CDC_NOTIFY_NETWORK_CONNECTION
1141 __le32 *data = req->buf + sizeof *event;
1143 event->bmRequestType = 0xA1;
1144 event->bNotificationType = USB_CDC_NOTIFY_SPEED_CHANGE;
1145 event->wValue = __constant_cpu_to_le16(0);
1146 event->wIndex = __constant_cpu_to_le16(1);
1147 event->wLength = __constant_cpu_to_le16(8);
1149 /* SPEED_CHANGE data is up/down speeds in bits/sec */
1150 data[0] = data[1] = cpu_to_le32(BITRATE(dev->gadget));
1152 req->length = STATUS_BYTECOUNT;
1153 value = usb_ep_queue(ep, req, GFP_ATOMIC);
1154 debug("send SPEED_CHANGE --> %d\n", value);
1157 } else if (value != -ECONNRESET) {
1158 debug("event %02x --> %d\n",
1159 event->bNotificationType, value);
1160 if (event->bNotificationType ==
1161 USB_CDC_NOTIFY_SPEED_CHANGE) {
1162 l_ethdev.network_started = 1;
1163 printf("USB network up!\n");
1166 req->context = NULL;
1169 static void issue_start_status(struct eth_dev *dev)
1171 struct usb_request *req = dev->stat_req;
1172 struct usb_cdc_notification *event;
1178 * FIXME ugly idiom, maybe we'd be better with just
1179 * a "cancel the whole queue" primitive since any
1180 * unlink-one primitive has way too many error modes.
1181 * here, we "know" toggle is already clear...
1183 * FIXME iff req->context != null just dequeue it
1185 usb_ep_disable(dev->status_ep);
1186 usb_ep_enable(dev->status_ep, dev->status);
1189 * 3.8.1 says to issue first NETWORK_CONNECTION, then
1190 * a SPEED_CHANGE. could be useful in some configs.
1193 event->bmRequestType = 0xA1;
1194 event->bNotificationType = USB_CDC_NOTIFY_NETWORK_CONNECTION;
1195 event->wValue = __constant_cpu_to_le16(1); /* connected */
1196 event->wIndex = __constant_cpu_to_le16(1);
1199 req->length = sizeof *event;
1200 req->complete = eth_status_complete;
1203 value = usb_ep_queue(dev->status_ep, req, GFP_ATOMIC);
1205 debug("status buf queue --> %d\n", value);
1210 /*-------------------------------------------------------------------------*/
1212 static void eth_setup_complete(struct usb_ep *ep, struct usb_request *req)
1214 if (req->status || req->actual != req->length)
1215 debug("setup complete --> %d, %d/%d\n",
1216 req->status, req->actual, req->length);
1219 #ifdef CONFIG_USB_ETH_RNDIS
1221 static void rndis_response_complete(struct usb_ep *ep, struct usb_request *req)
1223 if (req->status || req->actual != req->length)
1224 debug("rndis response complete --> %d, %d/%d\n",
1225 req->status, req->actual, req->length);
1227 /* done sending after USB_CDC_GET_ENCAPSULATED_RESPONSE */
1230 static void rndis_command_complete(struct usb_ep *ep, struct usb_request *req)
1232 struct eth_dev *dev = ep->driver_data;
1235 /* received RNDIS command from USB_CDC_SEND_ENCAPSULATED_COMMAND */
1236 status = rndis_msg_parser(dev->rndis_config, (u8 *) req->buf);
1238 error("%s: rndis parse error %d", __func__, status);
1244 * The setup() callback implements all the ep0 functionality that's not
1245 * handled lower down. CDC has a number of less-common features:
1247 * - two interfaces: control, and ethernet data
1248 * - Ethernet data interface has two altsettings: default, and active
1249 * - class-specific descriptors for the control interface
1250 * - class-specific control requests
1253 eth_setup(struct usb_gadget *gadget, const struct usb_ctrlrequest *ctrl)
1255 struct eth_dev *dev = get_gadget_data(gadget);
1256 struct usb_request *req = dev->req;
1257 int value = -EOPNOTSUPP;
1258 u16 wIndex = le16_to_cpu(ctrl->wIndex);
1259 u16 wValue = le16_to_cpu(ctrl->wValue);
1260 u16 wLength = le16_to_cpu(ctrl->wLength);
1263 * descriptors just go into the pre-allocated ep0 buffer,
1264 * while config change events may enable network traffic.
1267 debug("%s\n", __func__);
1269 req->complete = eth_setup_complete;
1270 switch (ctrl->bRequest) {
1272 case USB_REQ_GET_DESCRIPTOR:
1273 if (ctrl->bRequestType != USB_DIR_IN)
1275 switch (wValue >> 8) {
1278 value = min(wLength, (u16) sizeof device_desc);
1279 memcpy(req->buf, &device_desc, value);
1281 case USB_DT_DEVICE_QUALIFIER:
1282 if (!gadget_is_dualspeed(gadget))
1284 value = min(wLength, (u16) sizeof dev_qualifier);
1285 memcpy(req->buf, &dev_qualifier, value);
1288 case USB_DT_OTHER_SPEED_CONFIG:
1289 if (!gadget_is_dualspeed(gadget))
1293 value = config_buf(gadget, req->buf,
1296 gadget_is_otg(gadget));
1298 value = min(wLength, (u16) value);
1302 value = usb_gadget_get_string(&stringtab,
1303 wValue & 0xff, req->buf);
1306 value = min(wLength, (u16) value);
1312 case USB_REQ_SET_CONFIGURATION:
1313 if (ctrl->bRequestType != 0)
1315 if (gadget->a_hnp_support)
1316 debug("HNP available\n");
1317 else if (gadget->a_alt_hnp_support)
1318 debug("HNP needs a different root port\n");
1319 value = eth_set_config(dev, wValue, GFP_ATOMIC);
1321 case USB_REQ_GET_CONFIGURATION:
1322 if (ctrl->bRequestType != USB_DIR_IN)
1324 *(u8 *)req->buf = dev->config;
1325 value = min(wLength, (u16) 1);
1328 case USB_REQ_SET_INTERFACE:
1329 if (ctrl->bRequestType != USB_RECIP_INTERFACE
1333 if (!cdc_active(dev) && wIndex != 0)
1337 * PXA hardware partially handles SET_INTERFACE;
1338 * we need to kluge around that interference.
1340 if (gadget_is_pxa(gadget)) {
1341 value = eth_set_config(dev, DEV_CONFIG_VALUE,
1344 * PXA25x driver use non-CDC ethernet gadget.
1345 * But only _CDC and _RNDIS code can signalize
1346 * that network is working. So we signalize it
1349 l_ethdev.network_started = 1;
1350 debug("USB network up!\n");
1354 #ifdef CONFIG_USB_ETH_CDC
1356 case 0: /* control/master intf */
1360 usb_ep_disable(dev->status_ep);
1361 usb_ep_enable(dev->status_ep, dev->status);
1366 case 1: /* data intf */
1369 usb_ep_disable(dev->in_ep);
1370 usb_ep_disable(dev->out_ep);
1373 * CDC requires the data transfers not be done from
1374 * the default interface setting ... also, setting
1375 * the non-default interface resets filters etc.
1378 if (!cdc_active(dev))
1380 usb_ep_enable(dev->in_ep, dev->in);
1381 usb_ep_enable(dev->out_ep, dev->out);
1382 dev->cdc_filter = DEFAULT_FILTER;
1384 issue_start_status(dev);
1385 eth_start(dev, GFP_ATOMIC);
1392 * FIXME this is wrong, as is the assumption that
1393 * all non-PXA hardware talks real CDC ...
1395 debug("set_interface ignored!\n");
1396 #endif /* CONFIG_USB_ETH_CDC */
1400 case USB_REQ_GET_INTERFACE:
1401 if (ctrl->bRequestType != (USB_DIR_IN|USB_RECIP_INTERFACE)
1405 if (!(cdc_active(dev) || rndis_active(dev)) && wIndex != 0)
1408 /* for CDC, iff carrier is on, data interface is active. */
1409 if (rndis_active(dev) || wIndex != 1)
1410 *(u8 *)req->buf = 0;
1412 /* *(u8 *)req->buf = netif_carrier_ok (dev->net) ? 1 : 0; */
1413 /* carrier always ok ...*/
1414 *(u8 *)req->buf = 1 ;
1416 value = min(wLength, (u16) 1);
1419 #ifdef CONFIG_USB_ETH_CDC
1420 case USB_CDC_SET_ETHERNET_PACKET_FILTER:
1422 * see 6.2.30: no data, wIndex = interface,
1423 * wValue = packet filter bitmap
1425 if (ctrl->bRequestType != (USB_TYPE_CLASS|USB_RECIP_INTERFACE)
1430 debug("packet filter %02x\n", wValue);
1431 dev->cdc_filter = wValue;
1437 * case USB_CDC_SET_ETHERNET_MULTICAST_FILTERS:
1438 * case USB_CDC_SET_ETHERNET_PM_PATTERN_FILTER:
1439 * case USB_CDC_GET_ETHERNET_PM_PATTERN_FILTER:
1440 * case USB_CDC_GET_ETHERNET_STATISTIC:
1443 #endif /* CONFIG_USB_ETH_CDC */
1445 #ifdef CONFIG_USB_ETH_RNDIS
1447 * RNDIS uses the CDC command encapsulation mechanism to implement
1448 * an RPC scheme, with much getting/setting of attributes by OID.
1450 case USB_CDC_SEND_ENCAPSULATED_COMMAND:
1451 if (ctrl->bRequestType != (USB_TYPE_CLASS|USB_RECIP_INTERFACE)
1452 || !rndis_active(dev)
1453 || wLength > USB_BUFSIZ
1455 || rndis_control_intf.bInterfaceNumber
1458 /* read the request, then process it */
1460 req->complete = rndis_command_complete;
1461 /* later, rndis_control_ack () sends a notification */
1464 case USB_CDC_GET_ENCAPSULATED_RESPONSE:
1465 if ((USB_DIR_IN|USB_TYPE_CLASS|USB_RECIP_INTERFACE)
1466 == ctrl->bRequestType
1467 && rndis_active(dev)
1468 /* && wLength >= 0x0400 */
1470 && rndis_control_intf.bInterfaceNumber
1475 /* return the result */
1476 buf = rndis_get_next_response(dev->rndis_config, &n);
1478 memcpy(req->buf, buf, n);
1479 req->complete = rndis_response_complete;
1480 rndis_free_response(dev->rndis_config, buf);
1483 /* else stalls ... spec says to avoid that */
1489 debug("unknown control req%02x.%02x v%04x i%04x l%d\n",
1490 ctrl->bRequestType, ctrl->bRequest,
1491 wValue, wIndex, wLength);
1494 /* respond with data transfer before status phase? */
1496 debug("respond with data transfer before status phase\n");
1497 req->length = value;
1498 req->zero = value < wLength
1499 && (value % gadget->ep0->maxpacket) == 0;
1500 value = usb_ep_queue(gadget->ep0, req, GFP_ATOMIC);
1502 debug("ep_queue --> %d\n", value);
1504 eth_setup_complete(gadget->ep0, req);
1508 /* host either stalls (value < 0) or reports success */
1512 /*-------------------------------------------------------------------------*/
1514 static void rx_complete(struct usb_ep *ep, struct usb_request *req);
1516 static int rx_submit(struct eth_dev *dev, struct usb_request *req,
1519 int retval = -ENOMEM;
1523 * Padding up to RX_EXTRA handles minor disagreements with host.
1524 * Normally we use the USB "terminate on short read" convention;
1525 * so allow up to (N*maxpacket), since that memory is normally
1526 * already allocated. Some hardware doesn't deal well with short
1527 * reads (e.g. DMA must be N*maxpacket), so for now don't trim a
1528 * byte off the end (to force hardware errors on overflow).
1530 * RNDIS uses internal framing, and explicitly allows senders to
1531 * pad to end-of-packet. That's potentially nice for speed,
1532 * but means receivers can't recover synch on their own.
1535 debug("%s\n", __func__);
1537 size = (ETHER_HDR_SIZE + dev->mtu + RX_EXTRA);
1538 size += dev->out_ep->maxpacket - 1;
1539 if (rndis_active(dev))
1540 size += sizeof(struct rndis_packet_msg_type);
1541 size -= size % dev->out_ep->maxpacket;
1544 * Some platforms perform better when IP packets are aligned,
1545 * but on at least one, checksumming fails otherwise. Note:
1546 * RNDIS headers involve variable numbers of LE32 values.
1549 req->buf = (u8 *) NetRxPackets[0];
1551 req->complete = rx_complete;
1553 retval = usb_ep_queue(dev->out_ep, req, gfp_flags);
1556 error("rx submit --> %d", retval);
1561 static void rx_complete(struct usb_ep *ep, struct usb_request *req)
1563 struct eth_dev *dev = ep->driver_data;
1565 debug("%s: status %d\n", __func__, req->status);
1566 switch (req->status) {
1567 /* normal completion */
1569 if (rndis_active(dev)) {
1570 /* we know MaxPacketsPerTransfer == 1 here */
1571 int length = rndis_rm_hdr(req->buf, req->actual);
1574 req->length -= length;
1575 req->actual -= length;
1577 if (req->actual < ETH_HLEN || ETH_FRAME_LEN < req->actual) {
1579 dev->stats.rx_errors++;
1580 dev->stats.rx_length_errors++;
1581 debug("rx length %d\n", req->length);
1585 dev->stats.rx_packets++;
1586 dev->stats.rx_bytes += req->length;
1589 /* software-driven interface shutdown */
1590 case -ECONNRESET: /* unlink */
1591 case -ESHUTDOWN: /* disconnect etc */
1592 /* for hardware automagic (such as pxa) */
1593 case -ECONNABORTED: /* endpoint reset */
1598 dev->stats.rx_over_errors++;
1601 dev->stats.rx_errors++;
1605 packet_received = 1;
1608 static int alloc_requests(struct eth_dev *dev, unsigned n, gfp_t gfp_flags)
1611 dev->tx_req = usb_ep_alloc_request(dev->in_ep, 0);
1616 dev->rx_req = usb_ep_alloc_request(dev->out_ep, 0);
1624 usb_ep_free_request(dev->in_ep, dev->tx_req);
1626 error("can't alloc requests");
1630 static void tx_complete(struct usb_ep *ep, struct usb_request *req)
1632 struct eth_dev *dev = ep->driver_data;
1634 debug("%s: status %s\n", __func__, (req->status) ? "failed" : "ok");
1635 switch (req->status) {
1637 dev->stats.tx_errors++;
1638 debug("tx err %d\n", req->status);
1640 case -ECONNRESET: /* unlink */
1641 case -ESHUTDOWN: /* disconnect etc */
1644 dev->stats.tx_bytes += req->length;
1646 dev->stats.tx_packets++;
1651 static inline int eth_is_promisc(struct eth_dev *dev)
1653 /* no filters for the CDC subset; always promisc */
1654 if (subset_active(dev))
1656 return dev->cdc_filter & USB_CDC_PACKET_TYPE_PROMISCUOUS;
1660 static int eth_start_xmit (struct sk_buff *skb, struct net_device *net)
1662 struct eth_dev *dev = netdev_priv(net);
1663 int length = skb->len;
1665 struct usb_request *req = NULL;
1666 unsigned long flags;
1668 /* apply outgoing CDC or RNDIS filters */
1669 if (!eth_is_promisc (dev)) {
1670 u8 *dest = skb->data;
1672 if (is_multicast_ether_addr(dest)) {
1675 /* ignores USB_CDC_PACKET_TYPE_MULTICAST and host
1676 * SET_ETHERNET_MULTICAST_FILTERS requests
1678 if (is_broadcast_ether_addr(dest))
1679 type = USB_CDC_PACKET_TYPE_BROADCAST;
1681 type = USB_CDC_PACKET_TYPE_ALL_MULTICAST;
1682 if (!(dev->cdc_filter & type)) {
1683 dev_kfree_skb_any (skb);
1687 /* ignores USB_CDC_PACKET_TYPE_DIRECTED */
1690 spin_lock_irqsave(&dev->req_lock, flags);
1692 * this freelist can be empty if an interrupt triggered disconnect()
1693 * and reconfigured the gadget (shutting down this queue) after the
1694 * network stack decided to xmit but before we got the spinlock.
1696 if (list_empty(&dev->tx_reqs)) {
1697 spin_unlock_irqrestore(&dev->req_lock, flags);
1701 req = container_of (dev->tx_reqs.next, struct usb_request, list);
1702 list_del (&req->list);
1704 /* temporarily stop TX queue when the freelist empties */
1705 if (list_empty (&dev->tx_reqs))
1706 netif_stop_queue (net);
1707 spin_unlock_irqrestore(&dev->req_lock, flags);
1709 /* no buffer copies needed, unless the network stack did it
1710 * or the hardware can't use skb buffers.
1711 * or there's not enough space for any RNDIS headers we need
1713 if (rndis_active(dev)) {
1714 struct sk_buff *skb_rndis;
1716 skb_rndis = skb_realloc_headroom (skb,
1717 sizeof (struct rndis_packet_msg_type));
1721 dev_kfree_skb_any (skb);
1723 rndis_add_hdr (skb);
1726 req->buf = skb->data;
1728 req->complete = tx_complete;
1730 /* use zlp framing on tx for strict CDC-Ether conformance,
1731 * though any robust network rx path ignores extra padding.
1732 * and some hardware doesn't like to write zlps.
1735 if (!dev->zlp && (length % dev->in_ep->maxpacket) == 0)
1738 req->length = length;
1740 /* throttle highspeed IRQ rate back slightly */
1741 if (gadget_is_dualspeed(dev->gadget))
1742 req->no_interrupt = (dev->gadget->speed == USB_SPEED_HIGH)
1743 ? ((atomic_read(&dev->tx_qlen) % qmult) != 0)
1746 retval = usb_ep_queue (dev->in_ep, req, GFP_ATOMIC);
1749 DEBUG (dev, "tx queue err %d\n", retval);
1752 net->trans_start = jiffies;
1753 atomic_inc (&dev->tx_qlen);
1758 dev->stats.tx_dropped++;
1759 dev_kfree_skb_any (skb);
1760 spin_lock_irqsave(&dev->req_lock, flags);
1761 if (list_empty (&dev->tx_reqs))
1762 netif_start_queue (net);
1763 list_add (&req->list, &dev->tx_reqs);
1764 spin_unlock_irqrestore(&dev->req_lock, flags);
1769 /*-------------------------------------------------------------------------*/
1772 static void eth_unbind(struct usb_gadget *gadget)
1774 struct eth_dev *dev = get_gadget_data(gadget);
1776 debug("%s...\n", __func__);
1777 rndis_deregister(dev->rndis_config);
1780 /* we've already been disconnected ... no i/o is active */
1782 usb_ep_free_request(gadget->ep0, dev->req);
1785 if (dev->stat_req) {
1786 usb_ep_free_request(dev->status_ep, dev->stat_req);
1787 dev->stat_req = NULL;
1791 usb_ep_free_request(dev->in_ep, dev->tx_req);
1796 usb_ep_free_request(dev->out_ep, dev->rx_req);
1800 /* unregister_netdev (dev->net);*/
1801 /* free_netdev(dev->net);*/
1804 set_gadget_data(gadget, NULL);
1807 static void eth_disconnect(struct usb_gadget *gadget)
1809 eth_reset_config(get_gadget_data(gadget));
1810 /* FIXME RNDIS should enter RNDIS_UNINITIALIZED */
1813 static void eth_suspend(struct usb_gadget *gadget)
1818 static void eth_resume(struct usb_gadget *gadget)
1823 /*-------------------------------------------------------------------------*/
1825 #ifdef CONFIG_USB_ETH_RNDIS
1828 * The interrupt endpoint is used in RNDIS to notify the host when messages
1829 * other than data packets are available ... notably the REMOTE_NDIS_*_CMPLT
1830 * messages, but also REMOTE_NDIS_INDICATE_STATUS_MSG and potentially even
1831 * REMOTE_NDIS_KEEPALIVE_MSG.
1833 * The RNDIS control queue is processed by GET_ENCAPSULATED_RESPONSE, and
1834 * normally just one notification will be queued.
1837 static void rndis_control_ack_complete(struct usb_ep *ep,
1838 struct usb_request *req)
1840 struct eth_dev *dev = ep->driver_data;
1842 debug("%s...\n", __func__);
1843 if (req->status || req->actual != req->length)
1844 debug("rndis control ack complete --> %d, %d/%d\n",
1845 req->status, req->actual, req->length);
1847 if (!l_ethdev.network_started) {
1848 if (rndis_get_state(dev->rndis_config)
1849 == RNDIS_DATA_INITIALIZED) {
1850 l_ethdev.network_started = 1;
1851 printf("USB RNDIS network up!\n");
1855 req->context = NULL;
1857 if (req != dev->stat_req)
1858 usb_ep_free_request(ep, req);
1861 static char rndis_resp_buf[8] __attribute__((aligned(sizeof(__le32))));
1863 static int rndis_control_ack(struct eth_device *net)
1865 struct eth_dev *dev = &l_ethdev;
1867 struct usb_request *resp = dev->stat_req;
1869 /* in case RNDIS calls this after disconnect */
1871 debug("status ENODEV\n");
1875 /* in case queue length > 1 */
1876 if (resp->context) {
1877 resp = usb_ep_alloc_request(dev->status_ep, GFP_ATOMIC);
1880 resp->buf = rndis_resp_buf;
1884 * Send RNDIS RESPONSE_AVAILABLE notification;
1885 * USB_CDC_NOTIFY_RESPONSE_AVAILABLE should work too
1888 resp->complete = rndis_control_ack_complete;
1889 resp->context = dev;
1891 *((__le32 *) resp->buf) = __constant_cpu_to_le32(1);
1892 *((__le32 *) (resp->buf + 4)) = __constant_cpu_to_le32(0);
1894 length = usb_ep_queue(dev->status_ep, resp, GFP_ATOMIC);
1897 rndis_control_ack_complete(dev->status_ep, resp);
1905 #define rndis_control_ack NULL
1909 static void eth_start(struct eth_dev *dev, gfp_t gfp_flags)
1911 if (rndis_active(dev)) {
1912 rndis_set_param_medium(dev->rndis_config,
1914 BITRATE(dev->gadget)/100);
1915 rndis_signal_connect(dev->rndis_config);
1919 static int eth_stop(struct eth_dev *dev)
1921 #ifdef RNDIS_COMPLETE_SIGNAL_DISCONNECT
1923 unsigned long timeout = CONFIG_SYS_HZ; /* 1 sec to stop RNDIS */
1926 if (rndis_active(dev)) {
1927 rndis_set_param_medium(dev->rndis_config, NDIS_MEDIUM_802_3, 0);
1928 rndis_signal_disconnect(dev->rndis_config);
1930 #ifdef RNDIS_COMPLETE_SIGNAL_DISCONNECT
1931 /* Wait until host receives OID_GEN_MEDIA_CONNECT_STATUS */
1933 while (get_timer(ts) < timeout)
1934 usb_gadget_handle_interrupts();
1937 rndis_uninit(dev->rndis_config);
1944 /*-------------------------------------------------------------------------*/
1946 static int is_eth_addr_valid(char *str)
1948 if (strlen(str) == 17) {
1953 /* see if it looks like an ethernet address */
1957 for (i = 0; i < 6; i++) {
1958 char term = (i == 5 ? '\0' : ':');
1960 ea[i] = simple_strtol(p, &q, 16);
1962 if ((q - p) != 2 || *q++ != term)
1968 /* Now check the contents. */
1969 return is_valid_ether_addr(ea);
1974 static u8 nibble(unsigned char c)
1976 if (likely(isdigit(c)))
1979 if (likely(isxdigit(c)))
1980 return 10 + c - 'A';
1984 static int get_ether_addr(const char *str, u8 *dev_addr)
1989 for (i = 0; i < 6; i++) {
1992 if ((*str == '.') || (*str == ':'))
1994 num = nibble(*str++) << 4;
1995 num |= (nibble(*str++));
1998 if (is_valid_ether_addr(dev_addr))
2004 static int eth_bind(struct usb_gadget *gadget)
2006 struct eth_dev *dev = &l_ethdev;
2007 u8 cdc = 1, zlp = 1, rndis = 1;
2008 struct usb_ep *in_ep, *out_ep, *status_ep = NULL;
2009 int status = -ENOMEM;
2013 /* these flags are only ever cleared; compiler take note */
2014 #ifndef CONFIG_USB_ETH_CDC
2017 #ifndef CONFIG_USB_ETH_RNDIS
2021 * Because most host side USB stacks handle CDC Ethernet, that
2022 * standard protocol is _strongly_ preferred for interop purposes.
2023 * (By everyone except Microsoft.)
2025 if (gadget_is_pxa(gadget)) {
2026 /* pxa doesn't support altsettings */
2028 } else if (gadget_is_musbhdrc(gadget)) {
2029 /* reduce tx dma overhead by avoiding special cases */
2031 } else if (gadget_is_sh(gadget)) {
2032 /* sh doesn't support multiple interfaces or configs */
2035 } else if (gadget_is_sa1100(gadget)) {
2036 /* hardware can't write zlps */
2039 * sa1100 CAN do CDC, without status endpoint ... we use
2040 * non-CDC to be compatible with ARM Linux-2.4 "usb-eth".
2045 gcnum = usb_gadget_controller_number(gadget);
2047 device_desc.bcdDevice = cpu_to_le16(0x0300 + gcnum);
2050 * can't assume CDC works. don't want to default to
2051 * anything less functional on CDC-capable hardware,
2052 * so we fail in this case.
2054 error("controller '%s' not recognized",
2060 * If there's an RNDIS configuration, that's what Windows wants to
2061 * be using ... so use these product IDs here and in the "linux.inf"
2062 * needed to install MSFT drivers. Current Linux kernels will use
2063 * the second configuration if it's CDC Ethernet, and need some help
2064 * to choose the right configuration otherwise.
2067 #if defined(CONFIG_USB_RNDIS_VENDOR_ID) && defined(CONFIG_USB_RNDIS_PRODUCT_ID)
2068 device_desc.idVendor =
2069 __constant_cpu_to_le16(CONFIG_USB_RNDIS_VENDOR_ID);
2070 device_desc.idProduct =
2071 __constant_cpu_to_le16(CONFIG_USB_RNDIS_PRODUCT_ID);
2073 device_desc.idVendor =
2074 __constant_cpu_to_le16(RNDIS_VENDOR_NUM);
2075 device_desc.idProduct =
2076 __constant_cpu_to_le16(RNDIS_PRODUCT_NUM);
2078 sprintf(product_desc, "RNDIS/%s", driver_desc);
2081 * CDC subset ... recognized by Linux since 2.4.10, but Windows
2082 * drivers aren't widely available. (That may be improved by
2083 * supporting one submode of the "SAFE" variant of MDLM.)
2086 #if defined(CONFIG_USB_CDC_VENDOR_ID) && defined(CONFIG_USB_CDC_PRODUCT_ID)
2087 device_desc.idVendor = cpu_to_le16(CONFIG_USB_CDC_VENDOR_ID);
2088 device_desc.idProduct = cpu_to_le16(CONFIG_USB_CDC_PRODUCT_ID);
2091 device_desc.idVendor =
2092 __constant_cpu_to_le16(SIMPLE_VENDOR_NUM);
2093 device_desc.idProduct =
2094 __constant_cpu_to_le16(SIMPLE_PRODUCT_NUM);
2098 /* support optional vendor/distro customization */
2100 device_desc.bcdDevice = cpu_to_le16(bcdDevice);
2102 strlcpy(manufacturer, iManufacturer, sizeof manufacturer);
2104 strlcpy(product_desc, iProduct, sizeof product_desc);
2105 if (iSerialNumber) {
2106 device_desc.iSerialNumber = STRING_SERIALNUMBER,
2107 strlcpy(serial_number, iSerialNumber, sizeof serial_number);
2110 /* all we really need is bulk IN/OUT */
2111 usb_ep_autoconfig_reset(gadget);
2112 in_ep = usb_ep_autoconfig(gadget, &fs_source_desc);
2115 error("can't autoconfigure on %s\n",
2119 in_ep->driver_data = in_ep; /* claim */
2121 out_ep = usb_ep_autoconfig(gadget, &fs_sink_desc);
2124 out_ep->driver_data = out_ep; /* claim */
2126 #if defined(CONFIG_USB_ETH_CDC) || defined(CONFIG_USB_ETH_RNDIS)
2128 * CDC Ethernet control interface doesn't require a status endpoint.
2129 * Since some hosts expect one, try to allocate one anyway.
2132 status_ep = usb_ep_autoconfig(gadget, &fs_status_desc);
2134 status_ep->driver_data = status_ep; /* claim */
2136 error("can't run RNDIS on %s", gadget->name);
2138 #ifdef CONFIG_USB_ETH_CDC
2140 control_intf.bNumEndpoints = 0;
2141 /* FIXME remove endpoint from descriptor list */
2147 /* one config: cdc, else minimal subset */
2149 eth_config.bNumInterfaces = 1;
2150 eth_config.iConfiguration = STRING_SUBSET;
2153 * use functions to set these up, in case we're built to work
2154 * with multiple controllers and must override CDC Ethernet.
2156 fs_subset_descriptors();
2157 hs_subset_descriptors();
2160 device_desc.bMaxPacketSize0 = gadget->ep0->maxpacket;
2161 usb_gadget_set_selfpowered(gadget);
2163 /* For now RNDIS is always a second config */
2165 device_desc.bNumConfigurations = 2;
2167 if (gadget_is_dualspeed(gadget)) {
2169 dev_qualifier.bNumConfigurations = 2;
2171 dev_qualifier.bDeviceClass = USB_CLASS_VENDOR_SPEC;
2173 /* assumes ep0 uses the same value for both speeds ... */
2174 dev_qualifier.bMaxPacketSize0 = device_desc.bMaxPacketSize0;
2176 /* and that all endpoints are dual-speed */
2177 hs_source_desc.bEndpointAddress =
2178 fs_source_desc.bEndpointAddress;
2179 hs_sink_desc.bEndpointAddress =
2180 fs_sink_desc.bEndpointAddress;
2181 #if defined(CONFIG_USB_ETH_CDC) || defined(CONFIG_USB_ETH_RNDIS)
2183 hs_status_desc.bEndpointAddress =
2184 fs_status_desc.bEndpointAddress;
2188 if (gadget_is_otg(gadget)) {
2189 otg_descriptor.bmAttributes |= USB_OTG_HNP,
2190 eth_config.bmAttributes |= USB_CONFIG_ATT_WAKEUP;
2191 eth_config.bMaxPower = 4;
2192 #ifdef CONFIG_USB_ETH_RNDIS
2193 rndis_config.bmAttributes |= USB_CONFIG_ATT_WAKEUP;
2194 rndis_config.bMaxPower = 4;
2199 /* network device setup */
2200 dev->net = &l_netdev;
2206 dev->out_ep = out_ep;
2207 dev->status_ep = status_ep;
2210 * Module params for these addresses should come from ID proms.
2211 * The host side address is used with CDC and RNDIS, and commonly
2212 * ends up in a persistent config database. It's not clear if
2213 * host side code for the SAFE thing cares -- its original BLAN
2214 * thing didn't, Sharp never assigned those addresses on Zaurii.
2216 get_ether_addr(dev_addr, dev->net->enetaddr);
2218 memset(tmp, 0, sizeof(tmp));
2219 memcpy(tmp, dev->net->enetaddr, sizeof(dev->net->enetaddr));
2221 get_ether_addr(host_addr, dev->host_mac);
2223 sprintf(ethaddr, "%02X%02X%02X%02X%02X%02X",
2224 dev->host_mac[0], dev->host_mac[1],
2225 dev->host_mac[2], dev->host_mac[3],
2226 dev->host_mac[4], dev->host_mac[5]);
2229 status = rndis_init();
2231 error("can't init RNDIS, %d", status);
2237 * use PKTSIZE (or aligned... from u-boot) and set
2238 * wMaxSegmentSize accordingly
2240 dev->mtu = PKTSIZE_ALIGN; /* RNDIS does not like this, only 1514, TODO*/
2242 /* preallocate control message data and buffer */
2243 dev->req = usb_ep_alloc_request(gadget->ep0, GFP_KERNEL);
2246 dev->req->buf = control_req;
2247 dev->req->complete = eth_setup_complete;
2249 /* ... and maybe likewise for status transfer */
2250 #if defined(CONFIG_USB_ETH_CDC) || defined(CONFIG_USB_ETH_RNDIS)
2251 if (dev->status_ep) {
2252 dev->stat_req = usb_ep_alloc_request(dev->status_ep,
2254 if (!dev->stat_req) {
2255 usb_ep_free_request(dev->status_ep, dev->req);
2259 dev->stat_req->buf = status_req;
2260 dev->stat_req->context = NULL;
2264 /* finish hookup to lower layer ... */
2265 dev->gadget = gadget;
2266 set_gadget_data(gadget, dev);
2267 gadget->ep0->driver_data = dev;
2270 * two kinds of host-initiated state changes:
2271 * - iff DATA transfer is active, carrier is "on"
2272 * - tx queueing enabled if open *and* carrier is "on"
2275 printf("using %s, OUT %s IN %s%s%s\n", gadget->name,
2276 out_ep->name, in_ep->name,
2277 status_ep ? " STATUS " : "",
2278 status_ep ? status_ep->name : ""
2280 printf("MAC %02x:%02x:%02x:%02x:%02x:%02x\n",
2281 dev->net->enetaddr[0], dev->net->enetaddr[1],
2282 dev->net->enetaddr[2], dev->net->enetaddr[3],
2283 dev->net->enetaddr[4], dev->net->enetaddr[5]);
2286 printf("HOST MAC %02x:%02x:%02x:%02x:%02x:%02x\n",
2287 dev->host_mac[0], dev->host_mac[1],
2288 dev->host_mac[2], dev->host_mac[3],
2289 dev->host_mac[4], dev->host_mac[5]);
2294 /* FIXME RNDIS vendor id == "vendor NIC code" == ? */
2296 dev->rndis_config = rndis_register(rndis_control_ack);
2297 if (dev->rndis_config < 0) {
2300 debug("RNDIS setup failed\n");
2305 /* these set up a lot of the OIDs that RNDIS needs */
2306 rndis_set_host_mac(dev->rndis_config, dev->host_mac);
2307 if (rndis_set_param_dev(dev->rndis_config, dev->net, dev->mtu,
2308 &dev->stats, &dev->cdc_filter))
2310 if (rndis_set_param_vendor(dev->rndis_config, vendorID,
2313 if (rndis_set_param_medium(dev->rndis_config,
2314 NDIS_MEDIUM_802_3, 0))
2316 printf("RNDIS ready\n");
2321 error("%s failed, status = %d", __func__, status);
2326 /*-------------------------------------------------------------------------*/
2328 static int usb_eth_init(struct eth_device *netdev, bd_t *bd)
2330 struct eth_dev *dev = &l_ethdev;
2331 struct usb_gadget *gadget;
2333 unsigned long timeout = USB_CONNECT_TIMEOUT;
2336 error("received NULL ptr");
2340 /* Configure default mac-addresses for the USB ethernet device */
2341 #ifdef CONFIG_USBNET_DEV_ADDR
2342 strlcpy(dev_addr, CONFIG_USBNET_DEV_ADDR, sizeof(dev_addr));
2344 #ifdef CONFIG_USBNET_HOST_ADDR
2345 strlcpy(host_addr, CONFIG_USBNET_HOST_ADDR, sizeof(host_addr));
2347 /* Check if the user overruled the MAC addresses */
2348 if (getenv("usbnet_devaddr"))
2349 strlcpy(dev_addr, getenv("usbnet_devaddr"),
2352 if (getenv("usbnet_hostaddr"))
2353 strlcpy(host_addr, getenv("usbnet_hostaddr"),
2356 if (!is_eth_addr_valid(dev_addr)) {
2357 error("Need valid 'usbnet_devaddr' to be set");
2360 if (!is_eth_addr_valid(host_addr)) {
2361 error("Need valid 'usbnet_hostaddr' to be set");
2365 if (usb_gadget_register_driver(ð_driver) < 0)
2368 dev->network_started = 0;
2370 packet_received = 0;
2373 gadget = dev->gadget;
2374 usb_gadget_connect(gadget);
2376 if (getenv("cdc_connect_timeout"))
2377 timeout = simple_strtoul(getenv("cdc_connect_timeout"),
2378 NULL, 10) * CONFIG_SYS_HZ;
2380 while (!l_ethdev.network_started) {
2381 /* Handle control-c and timeouts */
2382 if (ctrlc() || (get_timer(ts) > timeout)) {
2383 error("The remote end did not respond in time.");
2386 usb_gadget_handle_interrupts();
2389 packet_received = 0;
2390 rx_submit(dev, dev->rx_req, 0);
2396 static int usb_eth_send(struct eth_device *netdev, void *packet, int length)
2399 void *rndis_pkt = NULL;
2400 struct eth_dev *dev = &l_ethdev;
2401 struct usb_request *req = dev->tx_req;
2403 unsigned long timeout = USB_CONNECT_TIMEOUT;
2405 debug("%s:...\n", __func__);
2407 /* new buffer is needed to include RNDIS header */
2408 if (rndis_active(dev)) {
2409 rndis_pkt = malloc(length +
2410 sizeof(struct rndis_packet_msg_type));
2412 error("No memory to alloc RNDIS packet");
2415 rndis_add_hdr(rndis_pkt, length);
2416 memcpy(rndis_pkt + sizeof(struct rndis_packet_msg_type),
2419 length += sizeof(struct rndis_packet_msg_type);
2422 req->context = NULL;
2423 req->complete = tx_complete;
2426 * use zlp framing on tx for strict CDC-Ether conformance,
2427 * though any robust network rx path ignores extra padding.
2428 * and some hardware doesn't like to write zlps.
2431 if (!dev->zlp && (length % dev->in_ep->maxpacket) == 0)
2434 req->length = length;
2436 /* throttle highspeed IRQ rate back slightly */
2437 if (gadget_is_dualspeed(dev->gadget))
2438 req->no_interrupt = (dev->gadget->speed == USB_SPEED_HIGH)
2439 ? ((dev->tx_qlen % qmult) != 0) : 0;
2445 retval = usb_ep_queue(dev->in_ep, req, GFP_ATOMIC);
2448 debug("%s: packet queued\n", __func__);
2449 while (!packet_sent) {
2450 if (get_timer(ts) > timeout) {
2451 printf("timeout sending packets to usb ethernet\n");
2454 usb_gadget_handle_interrupts();
2461 dev->stats.tx_dropped++;
2465 static int usb_eth_recv(struct eth_device *netdev)
2467 struct eth_dev *dev = &l_ethdev;
2469 usb_gadget_handle_interrupts();
2471 if (packet_received) {
2472 debug("%s: packet received\n", __func__);
2474 NetReceive(NetRxPackets[0], dev->rx_req->length);
2475 packet_received = 0;
2477 rx_submit(dev, dev->rx_req, 0);
2479 error("dev->rx_req invalid");
2484 void usb_eth_halt(struct eth_device *netdev)
2486 struct eth_dev *dev = &l_ethdev;
2489 error("received NULL ptr");
2493 /* If the gadget not registered, simple return */
2498 * Some USB controllers may need additional deinitialization here
2499 * before dropping pull-up (also due to hardware issues).
2500 * For example: unhandled interrupt with status stage started may
2501 * bring the controller to fully broken state (until board reset).
2502 * There are some variants to debug and fix such cases:
2503 * 1) In the case of RNDIS connection eth_stop can perform additional
2504 * interrupt handling. See RNDIS_COMPLETE_SIGNAL_DISCONNECT definition.
2505 * 2) 'pullup' callback in your UDC driver can be improved to perform
2506 * this deinitialization.
2510 usb_gadget_disconnect(dev->gadget);
2512 /* Clear pending interrupt */
2513 if (dev->network_started) {
2514 usb_gadget_handle_interrupts();
2515 dev->network_started = 0;
2518 usb_gadget_unregister_driver(ð_driver);
2521 static struct usb_gadget_driver eth_driver = {
2525 .unbind = eth_unbind,
2528 .disconnect = eth_disconnect,
2530 .suspend = eth_suspend,
2531 .resume = eth_resume,
2534 int usb_eth_initialize(bd_t *bi)
2536 struct eth_device *netdev = &l_netdev;
2538 strlcpy(netdev->name, USB_NET_NAME, sizeof(netdev->name));
2540 netdev->init = usb_eth_init;
2541 netdev->send = usb_eth_send;
2542 netdev->recv = usb_eth_recv;
2543 netdev->halt = usb_eth_halt;
2545 #ifdef CONFIG_MCAST_TFTP
2546 #error not supported
2548 eth_register(netdev);