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;
30 unsigned packet_received, packet_sent;
33 * Ethernet gadget driver -- with CDC and non-CDC options
34 * Builds on hardware support for a full duplex link.
36 * CDC Ethernet is the standard USB solution for sending Ethernet frames
37 * using USB. Real hardware tends to use the same framing protocol but look
38 * different for control features. This driver strongly prefers to use
39 * this USB-IF standard as its open-systems interoperability solution;
40 * most host side USB stacks (except from Microsoft) support it.
42 * This is sometimes called "CDC ECM" (Ethernet Control Model) to support
43 * TLA-soup. "CDC ACM" (Abstract Control Model) is for modems, and a new
44 * "CDC EEM" (Ethernet Emulation Model) is starting to spread.
46 * There's some hardware that can't talk CDC ECM. We make that hardware
47 * implement a "minimalist" vendor-agnostic CDC core: same framing, but
48 * link-level setup only requires activating the configuration. Only the
49 * endpoint descriptors, and product/vendor IDs, are relevant; no control
50 * operations are available. Linux supports it, but other host operating
51 * systems may not. (This is a subset of CDC Ethernet.)
53 * It turns out that if you add a few descriptors to that "CDC Subset",
54 * (Windows) host side drivers from MCCI can treat it as one submode of
55 * a proprietary scheme called "SAFE" ... without needing to know about
56 * specific product/vendor IDs. So we do that, making it easier to use
57 * those MS-Windows drivers. Those added descriptors make it resemble a
58 * CDC MDLM device, but they don't change device behavior at all. (See
59 * MCCI Engineering report 950198 "SAFE Networking Functions".)
61 * A third option is also in use. Rather than CDC Ethernet, or something
62 * simpler, Microsoft pushes their own approach: RNDIS. The published
63 * RNDIS specs are ambiguous and appear to be incomplete, and are also
64 * needlessly complex. They borrow more from CDC ACM than CDC ECM.
66 #define ETH_ALEN 6 /* Octets in one ethernet addr */
67 #define ETH_HLEN 14 /* Total octets in header. */
68 #define ETH_ZLEN 60 /* Min. octets in frame sans FCS */
69 #define ETH_DATA_LEN 1500 /* Max. octets in payload */
70 #define ETH_FRAME_LEN PKTSIZE_ALIGN /* Max. octets in frame sans FCS */
71 #define ETH_FCS_LEN 4 /* Octets in the FCS */
73 #define DRIVER_DESC "Ethernet Gadget"
74 /* Based on linux 2.6.27 version */
75 #define DRIVER_VERSION "May Day 2005"
77 static const char shortname[] = "ether";
78 static const char driver_desc[] = DRIVER_DESC;
80 #define RX_EXTRA 20 /* guard against rx overflows */
82 #ifndef CONFIG_USB_ETH_RNDIS
83 #define rndis_uninit(x) do {} while (0)
84 #define rndis_deregister(c) do {} while (0)
85 #define rndis_exit() do {} while (0)
88 /* CDC and RNDIS support the same host-chosen outgoing packet filters. */
89 #define DEFAULT_FILTER (USB_CDC_PACKET_TYPE_BROADCAST \
90 |USB_CDC_PACKET_TYPE_ALL_MULTICAST \
91 |USB_CDC_PACKET_TYPE_PROMISCUOUS \
92 |USB_CDC_PACKET_TYPE_DIRECTED)
94 #define USB_CONNECT_TIMEOUT (3 * CONFIG_SYS_HZ)
96 /*-------------------------------------------------------------------------*/
99 struct usb_gadget *gadget;
100 struct usb_request *req; /* for control responses */
101 struct usb_request *stat_req; /* for cdc & rndis status */
104 struct usb_ep *in_ep, *out_ep, *status_ep;
105 const struct usb_endpoint_descriptor
108 struct usb_request *tx_req, *rx_req;
110 struct eth_device *net;
111 struct net_device_stats stats;
112 unsigned int tx_qlen;
117 unsigned suspended:1;
118 unsigned network_started:1;
122 #define WORK_RX_MEMORY 0
124 u8 host_mac[ETH_ALEN];
128 * This version autoconfigures as much as possible at run-time.
130 * It also ASSUMES a self-powered device, without remote wakeup,
131 * although remote wakeup support would make sense.
134 /*-------------------------------------------------------------------------*/
135 static struct eth_dev l_ethdev;
136 static struct eth_device l_netdev;
137 static struct usb_gadget_driver eth_driver;
139 /*-------------------------------------------------------------------------*/
141 /* "main" config is either CDC, or its simple subset */
142 static inline int is_cdc(struct eth_dev *dev)
144 #if !defined(CONFIG_USB_ETH_SUBSET)
145 return 1; /* only cdc possible */
146 #elif !defined(CONFIG_USB_ETH_CDC)
147 return 0; /* only subset possible */
149 return dev->cdc; /* depends on what hardware we found */
153 /* "secondary" RNDIS config may sometimes be activated */
154 static inline int rndis_active(struct eth_dev *dev)
156 #ifdef CONFIG_USB_ETH_RNDIS
163 #define subset_active(dev) (!is_cdc(dev) && !rndis_active(dev))
164 #define cdc_active(dev) (is_cdc(dev) && !rndis_active(dev))
166 #define DEFAULT_QLEN 2 /* double buffering by default */
168 /* peak bulk transfer bits-per-second */
169 #define HS_BPS (13 * 512 * 8 * 1000 * 8)
170 #define FS_BPS (19 * 64 * 1 * 1000 * 8)
172 #ifdef CONFIG_USB_GADGET_DUALSPEED
173 #define DEVSPEED USB_SPEED_HIGH
175 #ifdef CONFIG_USB_ETH_QMULT
176 #define qmult CONFIG_USB_ETH_QMULT
181 /* for dual-speed hardware, use deeper queues at highspeed */
182 #define qlen(gadget) \
183 (DEFAULT_QLEN*((gadget->speed == USB_SPEED_HIGH) ? qmult : 1))
185 static inline int BITRATE(struct usb_gadget *g)
187 return (g->speed == USB_SPEED_HIGH) ? HS_BPS : FS_BPS;
190 #else /* full speed (low speed doesn't do bulk) */
194 #define DEVSPEED USB_SPEED_FULL
196 #define qlen(gadget) DEFAULT_QLEN
198 static inline int BITRATE(struct usb_gadget *g)
204 /*-------------------------------------------------------------------------*/
207 * DO NOT REUSE THESE IDs with a protocol-incompatible driver!! Ever!!
208 * Instead: allocate your own, using normal USB-IF procedures.
212 * Thanks to NetChip Technologies for donating this product ID.
213 * It's for devices with only CDC Ethernet configurations.
215 #define CDC_VENDOR_NUM 0x0525 /* NetChip */
216 #define CDC_PRODUCT_NUM 0xa4a1 /* Linux-USB Ethernet Gadget */
219 * For hardware that can't talk CDC, we use the same vendor ID that
220 * ARM Linux has used for ethernet-over-usb, both with sa1100 and
221 * with pxa250. We're protocol-compatible, if the host-side drivers
222 * use the endpoint descriptors. bcdDevice (version) is nonzero, so
223 * drivers that need to hard-wire endpoint numbers have a hook.
225 * The protocol is a minimal subset of CDC Ether, which works on any bulk
226 * hardware that's not deeply broken ... even on hardware that can't talk
227 * RNDIS (like SA-1100, with no interrupt endpoint, or anything that
228 * doesn't handle control-OUT).
230 #define SIMPLE_VENDOR_NUM 0x049f /* Compaq Computer Corp. */
231 #define SIMPLE_PRODUCT_NUM 0x505a /* Linux-USB "CDC Subset" Device */
234 * For hardware that can talk RNDIS and either of the above protocols,
235 * use this ID ... the windows INF files will know it. Unless it's
236 * used with CDC Ethernet, Linux 2.4 hosts will need updates to choose
237 * the non-RNDIS configuration.
239 #define RNDIS_VENDOR_NUM 0x0525 /* NetChip */
240 #define RNDIS_PRODUCT_NUM 0xa4a2 /* Ethernet/RNDIS Gadget */
243 * Some systems will want different product identifers published in the
244 * device descriptor, either numbers or strings or both. These string
245 * parameters are in UTF-8 (superset of ASCII's 7 bit characters).
249 * Emulating them in eth_bind:
250 * static ushort idVendor;
251 * static ushort idProduct;
254 #if defined(CONFIG_USBNET_MANUFACTURER)
255 static char *iManufacturer = CONFIG_USBNET_MANUFACTURER;
257 static char *iManufacturer = "U-boot";
260 /* These probably need to be configurable. */
261 static ushort bcdDevice;
262 static char *iProduct;
263 static char *iSerialNumber;
265 static char dev_addr[18];
267 static char host_addr[18];
270 /*-------------------------------------------------------------------------*/
273 * USB DRIVER HOOKUP (to the hardware driver, below us), mostly
274 * ep0 implementation: descriptors, config management, setup().
275 * also optional class-specific notification interrupt transfer.
279 * DESCRIPTORS ... most are static, but strings and (full) configuration
280 * descriptors are built on demand. For now we do either full CDC, or
281 * our simple subset, with RNDIS as an optional second configuration.
283 * RNDIS includes some CDC ACM descriptors ... like CDC Ethernet. But
284 * the class descriptors match a modem (they're ignored; it's really just
285 * Ethernet functionality), they don't need the NOP altsetting, and the
286 * status transfer endpoint isn't optional.
289 #define STRING_MANUFACTURER 1
290 #define STRING_PRODUCT 2
291 #define STRING_ETHADDR 3
292 #define STRING_DATA 4
293 #define STRING_CONTROL 5
294 #define STRING_RNDIS_CONTROL 6
296 #define STRING_SUBSET 8
297 #define STRING_RNDIS 9
298 #define STRING_SERIALNUMBER 10
300 /* holds our biggest descriptor (or RNDIS response) */
301 #define USB_BUFSIZ 256
304 * This device advertises one configuration, eth_config, unless RNDIS
305 * is enabled (rndis_config) on hardware supporting at least two configs.
307 * NOTE: Controllers like superh_udc should probably be able to use
308 * an RNDIS-only configuration.
310 * FIXME define some higher-powered configurations to make it easier
311 * to recharge batteries ...
314 #define DEV_CONFIG_VALUE 1 /* cdc or subset */
315 #define DEV_RNDIS_CONFIG_VALUE 2 /* rndis; optional */
317 static struct usb_device_descriptor
319 .bLength = sizeof device_desc,
320 .bDescriptorType = USB_DT_DEVICE,
322 .bcdUSB = __constant_cpu_to_le16(0x0200),
324 .bDeviceClass = USB_CLASS_COMM,
325 .bDeviceSubClass = 0,
326 .bDeviceProtocol = 0,
328 .idVendor = __constant_cpu_to_le16(CDC_VENDOR_NUM),
329 .idProduct = __constant_cpu_to_le16(CDC_PRODUCT_NUM),
330 .iManufacturer = STRING_MANUFACTURER,
331 .iProduct = STRING_PRODUCT,
332 .bNumConfigurations = 1,
335 static struct usb_otg_descriptor
337 .bLength = sizeof otg_descriptor,
338 .bDescriptorType = USB_DT_OTG,
340 .bmAttributes = USB_OTG_SRP,
343 static struct usb_config_descriptor
345 .bLength = sizeof eth_config,
346 .bDescriptorType = USB_DT_CONFIG,
348 /* compute wTotalLength on the fly */
350 .bConfigurationValue = DEV_CONFIG_VALUE,
351 .iConfiguration = STRING_CDC,
352 .bmAttributes = USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER,
356 #ifdef CONFIG_USB_ETH_RNDIS
357 static struct usb_config_descriptor
359 .bLength = sizeof rndis_config,
360 .bDescriptorType = USB_DT_CONFIG,
362 /* compute wTotalLength on the fly */
364 .bConfigurationValue = DEV_RNDIS_CONFIG_VALUE,
365 .iConfiguration = STRING_RNDIS,
366 .bmAttributes = USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER,
372 * Compared to the simple CDC subset, the full CDC Ethernet model adds
373 * three class descriptors, two interface descriptors, optional status
374 * endpoint. Both have a "data" interface and two bulk endpoints.
375 * There are also differences in how control requests are handled.
377 * RNDIS shares a lot with CDC-Ethernet, since it's a variant of the
378 * CDC-ACM (modem) spec. Unfortunately MSFT's RNDIS driver is buggy; it
379 * may hang or oops. Since bugfixes (or accurate specs, letting Linux
380 * work around those bugs) are unlikely to ever come from MSFT, you may
381 * wish to avoid using RNDIS.
383 * MCCI offers an alternative to RNDIS if you need to connect to Windows
384 * but have hardware that can't support CDC Ethernet. We add descriptors
385 * to present the CDC Subset as a (nonconformant) CDC MDLM variant called
386 * "SAFE". That borrows from both CDC Ethernet and CDC MDLM. You can
387 * get those drivers from MCCI, or bundled with various products.
390 #ifdef CONFIG_USB_ETH_CDC
391 static struct usb_interface_descriptor
393 .bLength = sizeof control_intf,
394 .bDescriptorType = USB_DT_INTERFACE,
396 .bInterfaceNumber = 0,
397 /* status endpoint is optional; this may be patched later */
399 .bInterfaceClass = USB_CLASS_COMM,
400 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET,
401 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
402 .iInterface = STRING_CONTROL,
406 #ifdef CONFIG_USB_ETH_RNDIS
407 static const struct usb_interface_descriptor
408 rndis_control_intf = {
409 .bLength = sizeof rndis_control_intf,
410 .bDescriptorType = USB_DT_INTERFACE,
412 .bInterfaceNumber = 0,
414 .bInterfaceClass = USB_CLASS_COMM,
415 .bInterfaceSubClass = USB_CDC_SUBCLASS_ACM,
416 .bInterfaceProtocol = USB_CDC_ACM_PROTO_VENDOR,
417 .iInterface = STRING_RNDIS_CONTROL,
421 static const struct usb_cdc_header_desc header_desc = {
422 .bLength = sizeof header_desc,
423 .bDescriptorType = USB_DT_CS_INTERFACE,
424 .bDescriptorSubType = USB_CDC_HEADER_TYPE,
426 .bcdCDC = __constant_cpu_to_le16(0x0110),
429 #if defined(CONFIG_USB_ETH_CDC) || defined(CONFIG_USB_ETH_RNDIS)
431 static const struct usb_cdc_union_desc union_desc = {
432 .bLength = sizeof union_desc,
433 .bDescriptorType = USB_DT_CS_INTERFACE,
434 .bDescriptorSubType = USB_CDC_UNION_TYPE,
436 .bMasterInterface0 = 0, /* index of control interface */
437 .bSlaveInterface0 = 1, /* index of DATA interface */
440 #endif /* CDC || RNDIS */
442 #ifdef CONFIG_USB_ETH_RNDIS
444 static const struct usb_cdc_call_mgmt_descriptor call_mgmt_descriptor = {
445 .bLength = sizeof call_mgmt_descriptor,
446 .bDescriptorType = USB_DT_CS_INTERFACE,
447 .bDescriptorSubType = USB_CDC_CALL_MANAGEMENT_TYPE,
449 .bmCapabilities = 0x00,
450 .bDataInterface = 0x01,
453 static const struct usb_cdc_acm_descriptor acm_descriptor = {
454 .bLength = sizeof acm_descriptor,
455 .bDescriptorType = USB_DT_CS_INTERFACE,
456 .bDescriptorSubType = USB_CDC_ACM_TYPE,
458 .bmCapabilities = 0x00,
463 #ifndef CONFIG_USB_ETH_CDC
466 * "SAFE" loosely follows CDC WMC MDLM, violating the spec in various
467 * ways: data endpoints live in the control interface, there's no data
468 * interface, and it's not used to talk to a cell phone radio.
471 static const struct usb_cdc_mdlm_desc mdlm_desc = {
472 .bLength = sizeof mdlm_desc,
473 .bDescriptorType = USB_DT_CS_INTERFACE,
474 .bDescriptorSubType = USB_CDC_MDLM_TYPE,
476 .bcdVersion = __constant_cpu_to_le16(0x0100),
478 0x5d, 0x34, 0xcf, 0x66, 0x11, 0x18, 0x11, 0xd6,
479 0xa2, 0x1a, 0x00, 0x01, 0x02, 0xca, 0x9a, 0x7f,
484 * since "usb_cdc_mdlm_detail_desc" is a variable length structure, we
485 * can't really use its struct. All we do here is say that we're using
486 * the submode of "SAFE" which directly matches the CDC Subset.
488 static const u8 mdlm_detail_desc[] = {
491 USB_CDC_MDLM_DETAIL_TYPE,
494 0, /* network control capabilities (none) */
495 0, /* network data capabilities ("raw" encapsulation) */
500 static const struct usb_cdc_ether_desc ether_desc = {
501 .bLength = sizeof(ether_desc),
502 .bDescriptorType = USB_DT_CS_INTERFACE,
503 .bDescriptorSubType = USB_CDC_ETHERNET_TYPE,
505 /* this descriptor actually adds value, surprise! */
506 .iMACAddress = STRING_ETHADDR,
507 .bmEthernetStatistics = __constant_cpu_to_le32(0), /* no statistics */
508 .wMaxSegmentSize = __constant_cpu_to_le16(ETH_FRAME_LEN),
509 .wNumberMCFilters = __constant_cpu_to_le16(0),
510 .bNumberPowerFilters = 0,
513 #if defined(CONFIG_USB_ETH_CDC) || defined(CONFIG_USB_ETH_RNDIS)
516 * include the status endpoint if we can, even where it's optional.
517 * use wMaxPacketSize big enough to fit CDC_NOTIFY_SPEED_CHANGE in one
518 * packet, to simplify cancellation; and a big transfer interval, to
519 * waste less bandwidth.
521 * some drivers (like Linux 2.4 cdc-ether!) "need" it to exist even
522 * if they ignore the connect/disconnect notifications that real aether
523 * can provide. more advanced cdc configurations might want to support
524 * encapsulated commands (vendor-specific, using control-OUT).
526 * RNDIS requires the status endpoint, since it uses that encapsulation
527 * mechanism for its funky RPC scheme.
530 #define LOG2_STATUS_INTERVAL_MSEC 5 /* 1 << 5 == 32 msec */
531 #define STATUS_BYTECOUNT 16 /* 8 byte header + data */
533 static struct usb_endpoint_descriptor
535 .bLength = USB_DT_ENDPOINT_SIZE,
536 .bDescriptorType = USB_DT_ENDPOINT,
538 .bEndpointAddress = USB_DIR_IN,
539 .bmAttributes = USB_ENDPOINT_XFER_INT,
540 .wMaxPacketSize = __constant_cpu_to_le16(STATUS_BYTECOUNT),
541 .bInterval = 1 << LOG2_STATUS_INTERVAL_MSEC,
545 #ifdef CONFIG_USB_ETH_CDC
547 /* the default data interface has no endpoints ... */
549 static const struct usb_interface_descriptor
551 .bLength = sizeof data_nop_intf,
552 .bDescriptorType = USB_DT_INTERFACE,
554 .bInterfaceNumber = 1,
555 .bAlternateSetting = 0,
557 .bInterfaceClass = USB_CLASS_CDC_DATA,
558 .bInterfaceSubClass = 0,
559 .bInterfaceProtocol = 0,
562 /* ... but the "real" data interface has two bulk endpoints */
564 static const struct usb_interface_descriptor
566 .bLength = sizeof data_intf,
567 .bDescriptorType = USB_DT_INTERFACE,
569 .bInterfaceNumber = 1,
570 .bAlternateSetting = 1,
572 .bInterfaceClass = USB_CLASS_CDC_DATA,
573 .bInterfaceSubClass = 0,
574 .bInterfaceProtocol = 0,
575 .iInterface = STRING_DATA,
580 #ifdef CONFIG_USB_ETH_RNDIS
582 /* RNDIS doesn't activate by changing to the "real" altsetting */
584 static const struct usb_interface_descriptor
586 .bLength = sizeof rndis_data_intf,
587 .bDescriptorType = USB_DT_INTERFACE,
589 .bInterfaceNumber = 1,
590 .bAlternateSetting = 0,
592 .bInterfaceClass = USB_CLASS_CDC_DATA,
593 .bInterfaceSubClass = 0,
594 .bInterfaceProtocol = 0,
595 .iInterface = STRING_DATA,
600 #ifdef CONFIG_USB_ETH_SUBSET
603 * "Simple" CDC-subset option is a simple vendor-neutral model that most
604 * full speed controllers can handle: one interface, two bulk endpoints.
606 * To assist host side drivers, we fancy it up a bit, and add descriptors
607 * so some host side drivers will understand it as a "SAFE" variant.
610 static const struct usb_interface_descriptor
612 .bLength = sizeof subset_data_intf,
613 .bDescriptorType = USB_DT_INTERFACE,
615 .bInterfaceNumber = 0,
616 .bAlternateSetting = 0,
618 .bInterfaceClass = USB_CLASS_COMM,
619 .bInterfaceSubClass = USB_CDC_SUBCLASS_MDLM,
620 .bInterfaceProtocol = 0,
621 .iInterface = STRING_DATA,
626 static struct usb_endpoint_descriptor
628 .bLength = USB_DT_ENDPOINT_SIZE,
629 .bDescriptorType = USB_DT_ENDPOINT,
631 .bEndpointAddress = USB_DIR_IN,
632 .bmAttributes = USB_ENDPOINT_XFER_BULK,
633 .wMaxPacketSize = __constant_cpu_to_le16(64),
636 static struct usb_endpoint_descriptor
638 .bLength = USB_DT_ENDPOINT_SIZE,
639 .bDescriptorType = USB_DT_ENDPOINT,
641 .bEndpointAddress = USB_DIR_OUT,
642 .bmAttributes = USB_ENDPOINT_XFER_BULK,
643 .wMaxPacketSize = __constant_cpu_to_le16(64),
646 static const struct usb_descriptor_header *fs_eth_function[11] = {
647 (struct usb_descriptor_header *) &otg_descriptor,
648 #ifdef CONFIG_USB_ETH_CDC
649 /* "cdc" mode descriptors */
650 (struct usb_descriptor_header *) &control_intf,
651 (struct usb_descriptor_header *) &header_desc,
652 (struct usb_descriptor_header *) &union_desc,
653 (struct usb_descriptor_header *) ðer_desc,
654 /* NOTE: status endpoint may need to be removed */
655 (struct usb_descriptor_header *) &fs_status_desc,
656 /* data interface, with altsetting */
657 (struct usb_descriptor_header *) &data_nop_intf,
658 (struct usb_descriptor_header *) &data_intf,
659 (struct usb_descriptor_header *) &fs_source_desc,
660 (struct usb_descriptor_header *) &fs_sink_desc,
662 #endif /* CONFIG_USB_ETH_CDC */
665 static inline void fs_subset_descriptors(void)
667 #ifdef CONFIG_USB_ETH_SUBSET
668 /* behavior is "CDC Subset"; extra descriptors say "SAFE" */
669 fs_eth_function[1] = (struct usb_descriptor_header *) &subset_data_intf;
670 fs_eth_function[2] = (struct usb_descriptor_header *) &header_desc;
671 fs_eth_function[3] = (struct usb_descriptor_header *) &mdlm_desc;
672 fs_eth_function[4] = (struct usb_descriptor_header *) &mdlm_detail_desc;
673 fs_eth_function[5] = (struct usb_descriptor_header *) ðer_desc;
674 fs_eth_function[6] = (struct usb_descriptor_header *) &fs_source_desc;
675 fs_eth_function[7] = (struct usb_descriptor_header *) &fs_sink_desc;
676 fs_eth_function[8] = NULL;
678 fs_eth_function[1] = NULL;
682 #ifdef CONFIG_USB_ETH_RNDIS
683 static const struct usb_descriptor_header *fs_rndis_function[] = {
684 (struct usb_descriptor_header *) &otg_descriptor,
685 /* control interface matches ACM, not Ethernet */
686 (struct usb_descriptor_header *) &rndis_control_intf,
687 (struct usb_descriptor_header *) &header_desc,
688 (struct usb_descriptor_header *) &call_mgmt_descriptor,
689 (struct usb_descriptor_header *) &acm_descriptor,
690 (struct usb_descriptor_header *) &union_desc,
691 (struct usb_descriptor_header *) &fs_status_desc,
692 /* data interface has no altsetting */
693 (struct usb_descriptor_header *) &rndis_data_intf,
694 (struct usb_descriptor_header *) &fs_source_desc,
695 (struct usb_descriptor_header *) &fs_sink_desc,
701 * usb 2.0 devices need to expose both high speed and full speed
702 * descriptors, unless they only run at full speed.
705 #if defined(CONFIG_USB_ETH_CDC) || defined(CONFIG_USB_ETH_RNDIS)
706 static struct usb_endpoint_descriptor
708 .bLength = USB_DT_ENDPOINT_SIZE,
709 .bDescriptorType = USB_DT_ENDPOINT,
711 .bmAttributes = USB_ENDPOINT_XFER_INT,
712 .wMaxPacketSize = __constant_cpu_to_le16(STATUS_BYTECOUNT),
713 .bInterval = LOG2_STATUS_INTERVAL_MSEC + 4,
715 #endif /* CONFIG_USB_ETH_CDC */
717 static struct usb_endpoint_descriptor
719 .bLength = USB_DT_ENDPOINT_SIZE,
720 .bDescriptorType = USB_DT_ENDPOINT,
722 .bmAttributes = USB_ENDPOINT_XFER_BULK,
723 .wMaxPacketSize = __constant_cpu_to_le16(512),
726 static struct usb_endpoint_descriptor
728 .bLength = USB_DT_ENDPOINT_SIZE,
729 .bDescriptorType = USB_DT_ENDPOINT,
731 .bmAttributes = USB_ENDPOINT_XFER_BULK,
732 .wMaxPacketSize = __constant_cpu_to_le16(512),
735 static struct usb_qualifier_descriptor
737 .bLength = sizeof dev_qualifier,
738 .bDescriptorType = USB_DT_DEVICE_QUALIFIER,
740 .bcdUSB = __constant_cpu_to_le16(0x0200),
741 .bDeviceClass = USB_CLASS_COMM,
743 .bNumConfigurations = 1,
746 static const struct usb_descriptor_header *hs_eth_function[11] = {
747 (struct usb_descriptor_header *) &otg_descriptor,
748 #ifdef CONFIG_USB_ETH_CDC
749 /* "cdc" mode descriptors */
750 (struct usb_descriptor_header *) &control_intf,
751 (struct usb_descriptor_header *) &header_desc,
752 (struct usb_descriptor_header *) &union_desc,
753 (struct usb_descriptor_header *) ðer_desc,
754 /* NOTE: status endpoint may need to be removed */
755 (struct usb_descriptor_header *) &hs_status_desc,
756 /* data interface, with altsetting */
757 (struct usb_descriptor_header *) &data_nop_intf,
758 (struct usb_descriptor_header *) &data_intf,
759 (struct usb_descriptor_header *) &hs_source_desc,
760 (struct usb_descriptor_header *) &hs_sink_desc,
762 #endif /* CONFIG_USB_ETH_CDC */
765 static inline void hs_subset_descriptors(void)
767 #ifdef CONFIG_USB_ETH_SUBSET
768 /* behavior is "CDC Subset"; extra descriptors say "SAFE" */
769 hs_eth_function[1] = (struct usb_descriptor_header *) &subset_data_intf;
770 hs_eth_function[2] = (struct usb_descriptor_header *) &header_desc;
771 hs_eth_function[3] = (struct usb_descriptor_header *) &mdlm_desc;
772 hs_eth_function[4] = (struct usb_descriptor_header *) &mdlm_detail_desc;
773 hs_eth_function[5] = (struct usb_descriptor_header *) ðer_desc;
774 hs_eth_function[6] = (struct usb_descriptor_header *) &hs_source_desc;
775 hs_eth_function[7] = (struct usb_descriptor_header *) &hs_sink_desc;
776 hs_eth_function[8] = NULL;
778 hs_eth_function[1] = NULL;
782 #ifdef CONFIG_USB_ETH_RNDIS
783 static const struct usb_descriptor_header *hs_rndis_function[] = {
784 (struct usb_descriptor_header *) &otg_descriptor,
785 /* control interface matches ACM, not Ethernet */
786 (struct usb_descriptor_header *) &rndis_control_intf,
787 (struct usb_descriptor_header *) &header_desc,
788 (struct usb_descriptor_header *) &call_mgmt_descriptor,
789 (struct usb_descriptor_header *) &acm_descriptor,
790 (struct usb_descriptor_header *) &union_desc,
791 (struct usb_descriptor_header *) &hs_status_desc,
792 /* data interface has no altsetting */
793 (struct usb_descriptor_header *) &rndis_data_intf,
794 (struct usb_descriptor_header *) &hs_source_desc,
795 (struct usb_descriptor_header *) &hs_sink_desc,
801 /* maxpacket and other transfer characteristics vary by speed. */
802 static inline struct usb_endpoint_descriptor *
803 ep_desc(struct usb_gadget *g, struct usb_endpoint_descriptor *hs,
804 struct usb_endpoint_descriptor *fs)
806 if (gadget_is_dualspeed(g) && g->speed == USB_SPEED_HIGH)
811 /*-------------------------------------------------------------------------*/
813 /* descriptors that are built on-demand */
815 static char manufacturer[50];
816 static char product_desc[40] = DRIVER_DESC;
817 static char serial_number[20];
819 /* address that the host will use ... usually assigned at random */
820 static char ethaddr[2 * ETH_ALEN + 1];
822 /* static strings, in UTF-8 */
823 static struct usb_string strings[] = {
824 { STRING_MANUFACTURER, manufacturer, },
825 { STRING_PRODUCT, product_desc, },
826 { STRING_SERIALNUMBER, serial_number, },
827 { STRING_DATA, "Ethernet Data", },
828 { STRING_ETHADDR, ethaddr, },
829 #ifdef CONFIG_USB_ETH_CDC
830 { STRING_CDC, "CDC Ethernet", },
831 { STRING_CONTROL, "CDC Communications Control", },
833 #ifdef CONFIG_USB_ETH_SUBSET
834 { STRING_SUBSET, "CDC Ethernet Subset", },
836 #ifdef CONFIG_USB_ETH_RNDIS
837 { STRING_RNDIS, "RNDIS", },
838 { STRING_RNDIS_CONTROL, "RNDIS Communications Control", },
840 { } /* end of list */
843 static struct usb_gadget_strings stringtab = {
844 .language = 0x0409, /* en-us */
848 /*============================================================================*/
849 DEFINE_CACHE_ALIGN_BUFFER(u8, control_req, USB_BUFSIZ);
851 #if defined(CONFIG_USB_ETH_CDC) || defined(CONFIG_USB_ETH_RNDIS)
852 DEFINE_CACHE_ALIGN_BUFFER(u8, status_req, STATUS_BYTECOUNT);
857 * strlcpy - Copy a %NUL terminated string into a sized buffer
858 * @dest: Where to copy the string to
859 * @src: Where to copy the string from
860 * @size: size of destination buffer
862 * Compatible with *BSD: the result is always a valid
863 * NUL-terminated string that fits in the buffer (unless,
864 * of course, the buffer size is zero). It does not pad
865 * out the result like strncpy() does.
867 size_t strlcpy(char *dest, const char *src, size_t size)
869 size_t ret = strlen(src);
872 size_t len = (ret >= size) ? size - 1 : ret;
873 memcpy(dest, src, len);
879 /*============================================================================*/
882 * one config, two interfaces: control, data.
883 * complications: class descriptors, and an altsetting.
886 config_buf(struct usb_gadget *g, u8 *buf, u8 type, unsigned index, int is_otg)
889 const struct usb_config_descriptor *config;
890 const struct usb_descriptor_header **function;
893 if (gadget_is_dualspeed(g)) {
894 hs = (g->speed == USB_SPEED_HIGH);
895 if (type == USB_DT_OTHER_SPEED_CONFIG)
898 #define which_fn(t) (hs ? hs_ ## t ## _function : fs_ ## t ## _function)
900 if (index >= device_desc.bNumConfigurations)
903 #ifdef CONFIG_USB_ETH_RNDIS
905 * list the RNDIS config first, to make Microsoft's drivers
906 * happy. DOCSIS 1.0 needs this too.
908 if (device_desc.bNumConfigurations == 2 && index == 0) {
909 config = &rndis_config;
910 function = which_fn(rndis);
914 config = ð_config;
915 function = which_fn(eth);
918 /* for now, don't advertise srp-only devices */
922 len = usb_gadget_config_buf(config, buf, USB_BUFSIZ, function);
925 ((struct usb_config_descriptor *) buf)->bDescriptorType = type;
929 /*-------------------------------------------------------------------------*/
931 static void eth_start(struct eth_dev *dev, gfp_t gfp_flags);
932 static int alloc_requests(struct eth_dev *dev, unsigned n, gfp_t gfp_flags);
935 set_ether_config(struct eth_dev *dev, gfp_t gfp_flags)
938 struct usb_gadget *gadget = dev->gadget;
940 #if defined(CONFIG_USB_ETH_CDC) || defined(CONFIG_USB_ETH_RNDIS)
941 /* status endpoint used for RNDIS and (optionally) CDC */
942 if (!subset_active(dev) && dev->status_ep) {
943 dev->status = ep_desc(gadget, &hs_status_desc,
945 dev->status_ep->driver_data = dev;
947 result = usb_ep_enable(dev->status_ep, dev->status);
949 debug("enable %s --> %d\n",
950 dev->status_ep->name, result);
956 dev->in = ep_desc(gadget, &hs_source_desc, &fs_source_desc);
957 dev->in_ep->driver_data = dev;
959 dev->out = ep_desc(gadget, &hs_sink_desc, &fs_sink_desc);
960 dev->out_ep->driver_data = dev;
963 * With CDC, the host isn't allowed to use these two data
964 * endpoints in the default altsetting for the interface.
965 * so we don't activate them yet. Reset from SET_INTERFACE.
967 * Strictly speaking RNDIS should work the same: activation is
968 * a side effect of setting a packet filter. Deactivation is
969 * from REMOTE_NDIS_HALT_MSG, reset from REMOTE_NDIS_RESET_MSG.
971 if (!cdc_active(dev)) {
972 result = usb_ep_enable(dev->in_ep, dev->in);
974 debug("enable %s --> %d\n",
975 dev->in_ep->name, result);
979 result = usb_ep_enable(dev->out_ep, dev->out);
981 debug("enable %s --> %d\n",
982 dev->out_ep->name, result);
989 result = alloc_requests(dev, qlen(gadget), gfp_flags);
991 /* on error, disable any endpoints */
993 if (!subset_active(dev) && dev->status_ep)
994 (void) usb_ep_disable(dev->status_ep);
996 (void) usb_ep_disable(dev->in_ep);
997 (void) usb_ep_disable(dev->out_ep);
1000 } else if (!cdc_active(dev)) {
1002 * activate non-CDC configs right away
1003 * this isn't strictly according to the RNDIS spec
1005 eth_start(dev, GFP_ATOMIC);
1008 /* caller is responsible for cleanup on error */
1012 static void eth_reset_config(struct eth_dev *dev)
1014 if (dev->config == 0)
1017 debug("%s\n", __func__);
1019 rndis_uninit(dev->rndis_config);
1022 * disable endpoints, forcing (synchronous) completion of
1023 * pending i/o. then free the requests.
1027 usb_ep_disable(dev->in_ep);
1029 usb_ep_free_request(dev->in_ep, dev->tx_req);
1034 usb_ep_disable(dev->out_ep);
1036 usb_ep_free_request(dev->out_ep, dev->rx_req);
1041 usb_ep_disable(dev->status_ep);
1044 dev->cdc_filter = 0;
1049 * change our operational config. must agree with the code
1050 * that returns config descriptors, and altsetting code.
1052 static int eth_set_config(struct eth_dev *dev, unsigned number,
1056 struct usb_gadget *gadget = dev->gadget;
1058 if (gadget_is_sa1100(gadget)
1060 && dev->tx_qlen != 0) {
1061 /* tx fifo is full, but we can't clear it...*/
1062 error("can't change configurations");
1065 eth_reset_config(dev);
1068 case DEV_CONFIG_VALUE:
1069 result = set_ether_config(dev, gfp_flags);
1071 #ifdef CONFIG_USB_ETH_RNDIS
1072 case DEV_RNDIS_CONFIG_VALUE:
1074 result = set_ether_config(dev, gfp_flags);
1086 eth_reset_config(dev);
1087 usb_gadget_vbus_draw(dev->gadget,
1088 gadget_is_otg(dev->gadget) ? 8 : 100);
1093 power = 2 * eth_config.bMaxPower;
1094 usb_gadget_vbus_draw(dev->gadget, power);
1096 switch (gadget->speed) {
1097 case USB_SPEED_FULL:
1098 speed = "full"; break;
1099 #ifdef CONFIG_USB_GADGET_DUALSPEED
1100 case USB_SPEED_HIGH:
1101 speed = "high"; break;
1107 dev->config = number;
1108 printf("%s speed config #%d: %d mA, %s, using %s\n",
1109 speed, number, power, driver_desc,
1114 : "CDC Ethernet Subset"));
1119 /*-------------------------------------------------------------------------*/
1121 #ifdef CONFIG_USB_ETH_CDC
1124 * The interrupt endpoint is used in CDC networking models (Ethernet, ATM)
1125 * only to notify the host about link status changes (which we support) or
1126 * report completion of some encapsulated command (as used in RNDIS). Since
1127 * we want this CDC Ethernet code to be vendor-neutral, we don't use that
1128 * command mechanism; and only one status request is ever queued.
1130 static void eth_status_complete(struct usb_ep *ep, struct usb_request *req)
1132 struct usb_cdc_notification *event = req->buf;
1133 int value = req->status;
1134 struct eth_dev *dev = ep->driver_data;
1136 /* issue the second notification if host reads the first */
1137 if (event->bNotificationType == USB_CDC_NOTIFY_NETWORK_CONNECTION
1139 __le32 *data = req->buf + sizeof *event;
1141 event->bmRequestType = 0xA1;
1142 event->bNotificationType = USB_CDC_NOTIFY_SPEED_CHANGE;
1143 event->wValue = __constant_cpu_to_le16(0);
1144 event->wIndex = __constant_cpu_to_le16(1);
1145 event->wLength = __constant_cpu_to_le16(8);
1147 /* SPEED_CHANGE data is up/down speeds in bits/sec */
1148 data[0] = data[1] = cpu_to_le32(BITRATE(dev->gadget));
1150 req->length = STATUS_BYTECOUNT;
1151 value = usb_ep_queue(ep, req, GFP_ATOMIC);
1152 debug("send SPEED_CHANGE --> %d\n", value);
1155 } else if (value != -ECONNRESET) {
1156 debug("event %02x --> %d\n",
1157 event->bNotificationType, value);
1158 if (event->bNotificationType ==
1159 USB_CDC_NOTIFY_SPEED_CHANGE) {
1160 l_ethdev.network_started = 1;
1161 printf("USB network up!\n");
1164 req->context = NULL;
1167 static void issue_start_status(struct eth_dev *dev)
1169 struct usb_request *req = dev->stat_req;
1170 struct usb_cdc_notification *event;
1176 * FIXME ugly idiom, maybe we'd be better with just
1177 * a "cancel the whole queue" primitive since any
1178 * unlink-one primitive has way too many error modes.
1179 * here, we "know" toggle is already clear...
1181 * FIXME iff req->context != null just dequeue it
1183 usb_ep_disable(dev->status_ep);
1184 usb_ep_enable(dev->status_ep, dev->status);
1187 * 3.8.1 says to issue first NETWORK_CONNECTION, then
1188 * a SPEED_CHANGE. could be useful in some configs.
1191 event->bmRequestType = 0xA1;
1192 event->bNotificationType = USB_CDC_NOTIFY_NETWORK_CONNECTION;
1193 event->wValue = __constant_cpu_to_le16(1); /* connected */
1194 event->wIndex = __constant_cpu_to_le16(1);
1197 req->length = sizeof *event;
1198 req->complete = eth_status_complete;
1201 value = usb_ep_queue(dev->status_ep, req, GFP_ATOMIC);
1203 debug("status buf queue --> %d\n", value);
1208 /*-------------------------------------------------------------------------*/
1210 static void eth_setup_complete(struct usb_ep *ep, struct usb_request *req)
1212 if (req->status || req->actual != req->length)
1213 debug("setup complete --> %d, %d/%d\n",
1214 req->status, req->actual, req->length);
1217 #ifdef CONFIG_USB_ETH_RNDIS
1219 static void rndis_response_complete(struct usb_ep *ep, struct usb_request *req)
1221 if (req->status || req->actual != req->length)
1222 debug("rndis response complete --> %d, %d/%d\n",
1223 req->status, req->actual, req->length);
1225 /* done sending after USB_CDC_GET_ENCAPSULATED_RESPONSE */
1228 static void rndis_command_complete(struct usb_ep *ep, struct usb_request *req)
1230 struct eth_dev *dev = ep->driver_data;
1233 /* received RNDIS command from USB_CDC_SEND_ENCAPSULATED_COMMAND */
1234 status = rndis_msg_parser(dev->rndis_config, (u8 *) req->buf);
1236 error("%s: rndis parse error %d", __func__, status);
1242 * The setup() callback implements all the ep0 functionality that's not
1243 * handled lower down. CDC has a number of less-common features:
1245 * - two interfaces: control, and ethernet data
1246 * - Ethernet data interface has two altsettings: default, and active
1247 * - class-specific descriptors for the control interface
1248 * - class-specific control requests
1251 eth_setup(struct usb_gadget *gadget, const struct usb_ctrlrequest *ctrl)
1253 struct eth_dev *dev = get_gadget_data(gadget);
1254 struct usb_request *req = dev->req;
1255 int value = -EOPNOTSUPP;
1256 u16 wIndex = le16_to_cpu(ctrl->wIndex);
1257 u16 wValue = le16_to_cpu(ctrl->wValue);
1258 u16 wLength = le16_to_cpu(ctrl->wLength);
1261 * descriptors just go into the pre-allocated ep0 buffer,
1262 * while config change events may enable network traffic.
1265 debug("%s\n", __func__);
1267 req->complete = eth_setup_complete;
1268 switch (ctrl->bRequest) {
1270 case USB_REQ_GET_DESCRIPTOR:
1271 if (ctrl->bRequestType != USB_DIR_IN)
1273 switch (wValue >> 8) {
1276 value = min(wLength, (u16) sizeof device_desc);
1277 memcpy(req->buf, &device_desc, value);
1279 case USB_DT_DEVICE_QUALIFIER:
1280 if (!gadget_is_dualspeed(gadget))
1282 value = min(wLength, (u16) sizeof dev_qualifier);
1283 memcpy(req->buf, &dev_qualifier, value);
1286 case USB_DT_OTHER_SPEED_CONFIG:
1287 if (!gadget_is_dualspeed(gadget))
1291 value = config_buf(gadget, req->buf,
1294 gadget_is_otg(gadget));
1296 value = min(wLength, (u16) value);
1300 value = usb_gadget_get_string(&stringtab,
1301 wValue & 0xff, req->buf);
1304 value = min(wLength, (u16) value);
1310 case USB_REQ_SET_CONFIGURATION:
1311 if (ctrl->bRequestType != 0)
1313 if (gadget->a_hnp_support)
1314 debug("HNP available\n");
1315 else if (gadget->a_alt_hnp_support)
1316 debug("HNP needs a different root port\n");
1317 value = eth_set_config(dev, wValue, GFP_ATOMIC);
1319 case USB_REQ_GET_CONFIGURATION:
1320 if (ctrl->bRequestType != USB_DIR_IN)
1322 *(u8 *)req->buf = dev->config;
1323 value = min(wLength, (u16) 1);
1326 case USB_REQ_SET_INTERFACE:
1327 if (ctrl->bRequestType != USB_RECIP_INTERFACE
1331 if (!cdc_active(dev) && wIndex != 0)
1335 * PXA hardware partially handles SET_INTERFACE;
1336 * we need to kluge around that interference.
1338 if (gadget_is_pxa(gadget)) {
1339 value = eth_set_config(dev, DEV_CONFIG_VALUE,
1342 * PXA25x driver use non-CDC ethernet gadget.
1343 * But only _CDC and _RNDIS code can signalize
1344 * that network is working. So we signalize it
1347 l_ethdev.network_started = 1;
1348 debug("USB network up!\n");
1352 #ifdef CONFIG_USB_ETH_CDC
1354 case 0: /* control/master intf */
1358 usb_ep_disable(dev->status_ep);
1359 usb_ep_enable(dev->status_ep, dev->status);
1364 case 1: /* data intf */
1367 usb_ep_disable(dev->in_ep);
1368 usb_ep_disable(dev->out_ep);
1371 * CDC requires the data transfers not be done from
1372 * the default interface setting ... also, setting
1373 * the non-default interface resets filters etc.
1376 if (!cdc_active(dev))
1378 usb_ep_enable(dev->in_ep, dev->in);
1379 usb_ep_enable(dev->out_ep, dev->out);
1380 dev->cdc_filter = DEFAULT_FILTER;
1382 issue_start_status(dev);
1383 eth_start(dev, GFP_ATOMIC);
1390 * FIXME this is wrong, as is the assumption that
1391 * all non-PXA hardware talks real CDC ...
1393 debug("set_interface ignored!\n");
1394 #endif /* CONFIG_USB_ETH_CDC */
1398 case USB_REQ_GET_INTERFACE:
1399 if (ctrl->bRequestType != (USB_DIR_IN|USB_RECIP_INTERFACE)
1403 if (!(cdc_active(dev) || rndis_active(dev)) && wIndex != 0)
1406 /* for CDC, iff carrier is on, data interface is active. */
1407 if (rndis_active(dev) || wIndex != 1)
1408 *(u8 *)req->buf = 0;
1410 /* *(u8 *)req->buf = netif_carrier_ok (dev->net) ? 1 : 0; */
1411 /* carrier always ok ...*/
1412 *(u8 *)req->buf = 1 ;
1414 value = min(wLength, (u16) 1);
1417 #ifdef CONFIG_USB_ETH_CDC
1418 case USB_CDC_SET_ETHERNET_PACKET_FILTER:
1420 * see 6.2.30: no data, wIndex = interface,
1421 * wValue = packet filter bitmap
1423 if (ctrl->bRequestType != (USB_TYPE_CLASS|USB_RECIP_INTERFACE)
1428 debug("packet filter %02x\n", wValue);
1429 dev->cdc_filter = wValue;
1435 * case USB_CDC_SET_ETHERNET_MULTICAST_FILTERS:
1436 * case USB_CDC_SET_ETHERNET_PM_PATTERN_FILTER:
1437 * case USB_CDC_GET_ETHERNET_PM_PATTERN_FILTER:
1438 * case USB_CDC_GET_ETHERNET_STATISTIC:
1441 #endif /* CONFIG_USB_ETH_CDC */
1443 #ifdef CONFIG_USB_ETH_RNDIS
1445 * RNDIS uses the CDC command encapsulation mechanism to implement
1446 * an RPC scheme, with much getting/setting of attributes by OID.
1448 case USB_CDC_SEND_ENCAPSULATED_COMMAND:
1449 if (ctrl->bRequestType != (USB_TYPE_CLASS|USB_RECIP_INTERFACE)
1450 || !rndis_active(dev)
1451 || wLength > USB_BUFSIZ
1453 || rndis_control_intf.bInterfaceNumber
1456 /* read the request, then process it */
1458 req->complete = rndis_command_complete;
1459 /* later, rndis_control_ack () sends a notification */
1462 case USB_CDC_GET_ENCAPSULATED_RESPONSE:
1463 if ((USB_DIR_IN|USB_TYPE_CLASS|USB_RECIP_INTERFACE)
1464 == ctrl->bRequestType
1465 && rndis_active(dev)
1466 /* && wLength >= 0x0400 */
1468 && rndis_control_intf.bInterfaceNumber
1473 /* return the result */
1474 buf = rndis_get_next_response(dev->rndis_config, &n);
1476 memcpy(req->buf, buf, n);
1477 req->complete = rndis_response_complete;
1478 rndis_free_response(dev->rndis_config, buf);
1481 /* else stalls ... spec says to avoid that */
1487 debug("unknown control req%02x.%02x v%04x i%04x l%d\n",
1488 ctrl->bRequestType, ctrl->bRequest,
1489 wValue, wIndex, wLength);
1492 /* respond with data transfer before status phase? */
1494 debug("respond with data transfer before status phase\n");
1495 req->length = value;
1496 req->zero = value < wLength
1497 && (value % gadget->ep0->maxpacket) == 0;
1498 value = usb_ep_queue(gadget->ep0, req, GFP_ATOMIC);
1500 debug("ep_queue --> %d\n", value);
1502 eth_setup_complete(gadget->ep0, req);
1506 /* host either stalls (value < 0) or reports success */
1510 /*-------------------------------------------------------------------------*/
1512 static void rx_complete(struct usb_ep *ep, struct usb_request *req);
1514 static int rx_submit(struct eth_dev *dev, struct usb_request *req,
1517 int retval = -ENOMEM;
1521 * Padding up to RX_EXTRA handles minor disagreements with host.
1522 * Normally we use the USB "terminate on short read" convention;
1523 * so allow up to (N*maxpacket), since that memory is normally
1524 * already allocated. Some hardware doesn't deal well with short
1525 * reads (e.g. DMA must be N*maxpacket), so for now don't trim a
1526 * byte off the end (to force hardware errors on overflow).
1528 * RNDIS uses internal framing, and explicitly allows senders to
1529 * pad to end-of-packet. That's potentially nice for speed,
1530 * but means receivers can't recover synch on their own.
1533 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);