2 * ether.c -- Ethernet gadget driver, with CDC and non-CDC options
4 * Copyright (C) 2003-2005 David Brownell
5 * Copyright (C) 2003-2004 Robert Schwebel, Benedikt Spranger
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
26 #include <linux/config.h>
27 #include <linux/module.h>
28 #include <linux/kernel.h>
29 #include <linux/delay.h>
30 #include <linux/ioport.h>
31 #include <linux/sched.h>
32 #include <linux/slab.h>
33 #include <linux/smp_lock.h>
34 #include <linux/errno.h>
35 #include <linux/init.h>
36 #include <linux/timer.h>
37 #include <linux/list.h>
38 #include <linux/interrupt.h>
39 #include <linux/utsname.h>
40 #include <linux/device.h>
41 #include <linux/moduleparam.h>
42 #include <linux/ctype.h>
44 #include <asm/byteorder.h>
47 #include <asm/system.h>
48 #include <asm/uaccess.h>
49 #include <asm/unaligned.h>
51 #include <linux/usb_ch9.h>
52 #include <linux/usb_cdc.h>
53 #include <linux/usb_gadget.h>
55 #include <linux/random.h>
56 #include <linux/netdevice.h>
57 #include <linux/etherdevice.h>
58 #include <linux/ethtool.h>
60 #include "gadget_chips.h"
62 /*-------------------------------------------------------------------------*/
65 * Ethernet gadget driver -- with CDC and non-CDC options
66 * Builds on hardware support for a full duplex link.
68 * CDC Ethernet is the standard USB solution for sending Ethernet frames
69 * using USB. Real hardware tends to use the same framing protocol but look
70 * different for control features. This driver strongly prefers to use
71 * this USB-IF standard as its open-systems interoperability solution;
72 * most host side USB stacks (except from Microsoft) support it.
74 * There's some hardware that can't talk CDC. We make that hardware
75 * implement a "minimalist" vendor-agnostic CDC core: same framing, but
76 * link-level setup only requires activating the configuration.
77 * Linux supports it, but other host operating systems may not.
78 * (This is a subset of CDC Ethernet.)
80 * A third option is also in use. Rather than CDC Ethernet, or something
81 * simpler, Microsoft pushes their own approach: RNDIS. The published
82 * RNDIS specs are ambiguous and appear to be incomplete, and are also
86 #define DRIVER_DESC "Ethernet Gadget"
87 #define DRIVER_VERSION "Equinox 2004"
89 static const char shortname
[] = "ether";
90 static const char driver_desc
[] = DRIVER_DESC
;
92 #define RX_EXTRA 20 /* guard against rx overflows */
94 #ifdef CONFIG_USB_ETH_RNDIS
97 #define rndis_init() 0
98 #define rndis_exit() do{}while(0)
101 /* CDC and RNDIS support the same host-chosen outgoing packet filters. */
102 #define DEFAULT_FILTER (USB_CDC_PACKET_TYPE_BROADCAST \
103 |USB_CDC_PACKET_TYPE_ALL_MULTICAST \
104 |USB_CDC_PACKET_TYPE_PROMISCUOUS \
105 |USB_CDC_PACKET_TYPE_DIRECTED)
108 /*-------------------------------------------------------------------------*/
112 struct usb_gadget
*gadget
;
113 struct usb_request
*req
; /* for control responses */
114 struct usb_request
*stat_req
; /* for cdc & rndis status */
117 struct usb_ep
*in_ep
, *out_ep
, *status_ep
;
118 const struct usb_endpoint_descriptor
120 struct list_head tx_reqs
, rx_reqs
;
122 struct net_device
*net
;
123 struct net_device_stats stats
;
126 struct work_struct work
;
130 unsigned suspended
:1;
133 #define WORK_RX_MEMORY 0
135 u8 host_mac
[ETH_ALEN
];
138 /* This version autoconfigures as much as possible at run-time.
140 * It also ASSUMES a self-powered device, without remote wakeup,
141 * although remote wakeup support would make sense.
143 static const char *EP_IN_NAME
;
144 static const char *EP_OUT_NAME
;
145 static const char *EP_STATUS_NAME
;
147 /*-------------------------------------------------------------------------*/
149 /* DO NOT REUSE THESE IDs with a protocol-incompatible driver!! Ever!!
150 * Instead: allocate your own, using normal USB-IF procedures.
153 /* Thanks to NetChip Technologies for donating this product ID.
154 * It's for devices with only CDC Ethernet configurations.
156 #define CDC_VENDOR_NUM 0x0525 /* NetChip */
157 #define CDC_PRODUCT_NUM 0xa4a1 /* Linux-USB Ethernet Gadget */
159 /* For hardware that can't talk CDC, we use the same vendor ID that
160 * ARM Linux has used for ethernet-over-usb, both with sa1100 and
161 * with pxa250. We're protocol-compatible, if the host-side drivers
162 * use the endpoint descriptors. bcdDevice (version) is nonzero, so
163 * drivers that need to hard-wire endpoint numbers have a hook.
165 * The protocol is a minimal subset of CDC Ether, which works on any bulk
166 * hardware that's not deeply broken ... even on hardware that can't talk
167 * RNDIS (like SA-1100, with no interrupt endpoint, or anything that
168 * doesn't handle control-OUT).
170 #define SIMPLE_VENDOR_NUM 0x049f
171 #define SIMPLE_PRODUCT_NUM 0x505a
173 /* For hardware that can talk RNDIS and either of the above protocols,
174 * use this ID ... the windows INF files will know it. Unless it's
175 * used with CDC Ethernet, Linux 2.4 hosts will need updates to choose
176 * the non-RNDIS configuration.
178 #define RNDIS_VENDOR_NUM 0x0525 /* NetChip */
179 #define RNDIS_PRODUCT_NUM 0xa4a2 /* Ethernet/RNDIS Gadget */
182 /* Some systems will want different product identifers published in the
183 * device descriptor, either numbers or strings or both. These string
184 * parameters are in UTF-8 (superset of ASCII's 7 bit characters).
187 static ushort __initdata idVendor
;
188 module_param(idVendor
, ushort
, S_IRUGO
);
189 MODULE_PARM_DESC(idVendor
, "USB Vendor ID");
191 static ushort __initdata idProduct
;
192 module_param(idProduct
, ushort
, S_IRUGO
);
193 MODULE_PARM_DESC(idProduct
, "USB Product ID");
195 static ushort __initdata bcdDevice
;
196 module_param(bcdDevice
, ushort
, S_IRUGO
);
197 MODULE_PARM_DESC(bcdDevice
, "USB Device version (BCD)");
199 static char *__initdata iManufacturer
;
200 module_param(iManufacturer
, charp
, S_IRUGO
);
201 MODULE_PARM_DESC(iManufacturer
, "USB Manufacturer string");
203 static char *__initdata iProduct
;
204 module_param(iProduct
, charp
, S_IRUGO
);
205 MODULE_PARM_DESC(iProduct
, "USB Product string");
207 /* initial value, changed by "ifconfig usb0 hw ether xx:xx:xx:xx:xx:xx" */
208 static char *__initdata dev_addr
;
209 module_param(dev_addr
, charp
, S_IRUGO
);
210 MODULE_PARM_DESC(dev_addr
, "Device Ethernet Address");
212 /* this address is invisible to ifconfig */
213 static char *__initdata host_addr
;
214 module_param(host_addr
, charp
, S_IRUGO
);
215 MODULE_PARM_DESC(host_addr
, "Host Ethernet Address");
218 /*-------------------------------------------------------------------------*/
220 /* Include CDC support if we could run on CDC-capable hardware. */
222 #ifdef CONFIG_USB_GADGET_NET2280
223 #define DEV_CONFIG_CDC
226 #ifdef CONFIG_USB_GADGET_DUMMY_HCD
227 #define DEV_CONFIG_CDC
230 #ifdef CONFIG_USB_GADGET_GOKU
231 #define DEV_CONFIG_CDC
234 #ifdef CONFIG_USB_GADGET_LH7A40X
235 #define DEV_CONFIG_CDC
238 #ifdef CONFIG_USB_GADGET_MQ11XX
239 #define DEV_CONFIG_CDC
242 #ifdef CONFIG_USB_GADGET_OMAP
243 #define DEV_CONFIG_CDC
246 #ifdef CONFIG_USB_GADGET_N9604
247 #define DEV_CONFIG_CDC
250 #ifdef CONFIG_USB_GADGET_PXA27X
251 #define DEV_CONFIG_CDC
254 #ifdef CONFIG_USB_GADGET_AT91
255 #define DEV_CONFIG_CDC
259 /* For CDC-incapable hardware, choose the simple cdc subset.
260 * Anything that talks bulk (without notable bugs) can do this.
262 #ifdef CONFIG_USB_GADGET_PXA2XX
263 #define DEV_CONFIG_SUBSET
266 #ifdef CONFIG_USB_GADGET_SH
267 #define DEV_CONFIG_SUBSET
270 #ifdef CONFIG_USB_GADGET_SA1100
271 /* use non-CDC for backwards compatibility */
272 #define DEV_CONFIG_SUBSET
275 #ifdef CONFIG_USB_GADGET_S3C2410
276 #define DEV_CONFIG_CDC
279 /*-------------------------------------------------------------------------*/
281 /* "main" config is either CDC, or its simple subset */
282 static inline int is_cdc(struct eth_dev
*dev
)
284 #if !defined(DEV_CONFIG_SUBSET)
285 return 1; /* only cdc possible */
286 #elif !defined (DEV_CONFIG_CDC)
287 return 0; /* only subset possible */
289 return dev
->cdc
; /* depends on what hardware we found */
293 /* "secondary" RNDIS config may sometimes be activated */
294 static inline int rndis_active(struct eth_dev
*dev
)
296 #ifdef CONFIG_USB_ETH_RNDIS
303 #define subset_active(dev) (!is_cdc(dev) && !rndis_active(dev))
304 #define cdc_active(dev) ( is_cdc(dev) && !rndis_active(dev))
308 #define DEFAULT_QLEN 2 /* double buffering by default */
310 /* peak bulk transfer bits-per-second */
311 #define HS_BPS (13 * 512 * 8 * 1000 * 8)
312 #define FS_BPS (19 * 64 * 1 * 1000 * 8)
314 #ifdef CONFIG_USB_GADGET_DUALSPEED
316 static unsigned qmult
= 5;
317 module_param (qmult
, uint
, S_IRUGO
|S_IWUSR
);
320 /* for dual-speed hardware, use deeper queues at highspeed */
321 #define qlen(gadget) \
322 (DEFAULT_QLEN*((gadget->speed == USB_SPEED_HIGH) ? qmult : 1))
324 /* also defer IRQs on highspeed TX */
325 #define TX_DELAY qmult
327 static inline int BITRATE(struct usb_gadget
*g
)
329 return (g
->speed
== USB_SPEED_HIGH
) ? HS_BPS
: FS_BPS
;
332 #else /* full speed (low speed doesn't do bulk) */
333 #define qlen(gadget) DEFAULT_QLEN
335 static inline int BITRATE(struct usb_gadget
*g
)
342 /*-------------------------------------------------------------------------*/
344 #define xprintk(d,level,fmt,args...) \
345 printk(level "%s: " fmt , (d)->net->name , ## args)
349 #define DEBUG(dev,fmt,args...) \
350 xprintk(dev , KERN_DEBUG , fmt , ## args)
352 #define DEBUG(dev,fmt,args...) \
359 #define VDEBUG(dev,fmt,args...) \
363 #define ERROR(dev,fmt,args...) \
364 xprintk(dev , KERN_ERR , fmt , ## args)
365 #define WARN(dev,fmt,args...) \
366 xprintk(dev , KERN_WARNING , fmt , ## args)
367 #define INFO(dev,fmt,args...) \
368 xprintk(dev , KERN_INFO , fmt , ## args)
370 /*-------------------------------------------------------------------------*/
372 /* USB DRIVER HOOKUP (to the hardware driver, below us), mostly
373 * ep0 implementation: descriptors, config management, setup().
374 * also optional class-specific notification interrupt transfer.
378 * DESCRIPTORS ... most are static, but strings and (full) configuration
379 * descriptors are built on demand. For now we do either full CDC, or
380 * our simple subset, with RNDIS as an optional second configuration.
382 * RNDIS includes some CDC ACM descriptors ... like CDC Ethernet. But
383 * the class descriptors match a modem (they're ignored; it's really just
384 * Ethernet functionality), they don't need the NOP altsetting, and the
385 * status transfer endpoint isn't optional.
388 #define STRING_MANUFACTURER 1
389 #define STRING_PRODUCT 2
390 #define STRING_ETHADDR 3
391 #define STRING_DATA 4
392 #define STRING_CONTROL 5
393 #define STRING_RNDIS_CONTROL 6
395 #define STRING_SUBSET 8
396 #define STRING_RNDIS 9
398 #define USB_BUFSIZ 256 /* holds our biggest descriptor */
401 * This device advertises one configuration, eth_config, unless RNDIS
402 * is enabled (rndis_config) on hardware supporting at least two configs.
404 * NOTE: Controllers like superh_udc should probably be able to use
405 * an RNDIS-only configuration.
407 * FIXME define some higher-powered configurations to make it easier
408 * to recharge batteries ...
411 #define DEV_CONFIG_VALUE 1 /* cdc or subset */
412 #define DEV_RNDIS_CONFIG_VALUE 2 /* rndis; optional */
414 static struct usb_device_descriptor
416 .bLength
= sizeof device_desc
,
417 .bDescriptorType
= USB_DT_DEVICE
,
419 .bcdUSB
= __constant_cpu_to_le16 (0x0200),
421 .bDeviceClass
= USB_CLASS_COMM
,
422 .bDeviceSubClass
= 0,
423 .bDeviceProtocol
= 0,
425 .idVendor
= __constant_cpu_to_le16 (CDC_VENDOR_NUM
),
426 .idProduct
= __constant_cpu_to_le16 (CDC_PRODUCT_NUM
),
427 .iManufacturer
= STRING_MANUFACTURER
,
428 .iProduct
= STRING_PRODUCT
,
429 .bNumConfigurations
= 1,
432 static struct usb_otg_descriptor
434 .bLength
= sizeof otg_descriptor
,
435 .bDescriptorType
= USB_DT_OTG
,
437 .bmAttributes
= USB_OTG_SRP
,
440 static struct usb_config_descriptor
442 .bLength
= sizeof eth_config
,
443 .bDescriptorType
= USB_DT_CONFIG
,
445 /* compute wTotalLength on the fly */
447 .bConfigurationValue
= DEV_CONFIG_VALUE
,
448 .iConfiguration
= STRING_CDC
,
449 .bmAttributes
= USB_CONFIG_ATT_ONE
| USB_CONFIG_ATT_SELFPOWER
,
453 #ifdef CONFIG_USB_ETH_RNDIS
454 static struct usb_config_descriptor
456 .bLength
= sizeof rndis_config
,
457 .bDescriptorType
= USB_DT_CONFIG
,
459 /* compute wTotalLength on the fly */
461 .bConfigurationValue
= DEV_RNDIS_CONFIG_VALUE
,
462 .iConfiguration
= STRING_RNDIS
,
463 .bmAttributes
= USB_CONFIG_ATT_ONE
| USB_CONFIG_ATT_SELFPOWER
,
469 * Compared to the simple CDC subset, the full CDC Ethernet model adds
470 * three class descriptors, two interface descriptors, optional status
471 * endpoint. Both have a "data" interface and two bulk endpoints.
472 * There are also differences in how control requests are handled.
474 * RNDIS shares a lot with CDC-Ethernet, since it's a variant of
475 * the CDC-ACM (modem) spec.
478 #ifdef DEV_CONFIG_CDC
479 static struct usb_interface_descriptor
481 .bLength
= sizeof control_intf
,
482 .bDescriptorType
= USB_DT_INTERFACE
,
484 .bInterfaceNumber
= 0,
485 /* status endpoint is optional; this may be patched later */
487 .bInterfaceClass
= USB_CLASS_COMM
,
488 .bInterfaceSubClass
= USB_CDC_SUBCLASS_ETHERNET
,
489 .bInterfaceProtocol
= USB_CDC_PROTO_NONE
,
490 .iInterface
= STRING_CONTROL
,
494 #ifdef CONFIG_USB_ETH_RNDIS
495 static const struct usb_interface_descriptor
496 rndis_control_intf
= {
497 .bLength
= sizeof rndis_control_intf
,
498 .bDescriptorType
= USB_DT_INTERFACE
,
500 .bInterfaceNumber
= 0,
502 .bInterfaceClass
= USB_CLASS_COMM
,
503 .bInterfaceSubClass
= USB_CDC_SUBCLASS_ACM
,
504 .bInterfaceProtocol
= USB_CDC_ACM_PROTO_VENDOR
,
505 .iInterface
= STRING_RNDIS_CONTROL
,
509 #if defined(DEV_CONFIG_CDC) || defined(CONFIG_USB_ETH_RNDIS)
511 static const struct usb_cdc_header_desc header_desc
= {
512 .bLength
= sizeof header_desc
,
513 .bDescriptorType
= USB_DT_CS_INTERFACE
,
514 .bDescriptorSubType
= USB_CDC_HEADER_TYPE
,
516 .bcdCDC
= __constant_cpu_to_le16 (0x0110),
519 static const struct usb_cdc_union_desc union_desc
= {
520 .bLength
= sizeof union_desc
,
521 .bDescriptorType
= USB_DT_CS_INTERFACE
,
522 .bDescriptorSubType
= USB_CDC_UNION_TYPE
,
524 .bMasterInterface0
= 0, /* index of control interface */
525 .bSlaveInterface0
= 1, /* index of DATA interface */
528 #endif /* CDC || RNDIS */
530 #ifdef CONFIG_USB_ETH_RNDIS
532 static const struct usb_cdc_call_mgmt_descriptor call_mgmt_descriptor
= {
533 .bLength
= sizeof call_mgmt_descriptor
,
534 .bDescriptorType
= USB_DT_CS_INTERFACE
,
535 .bDescriptorSubType
= USB_CDC_CALL_MANAGEMENT_TYPE
,
537 .bmCapabilities
= 0x00,
538 .bDataInterface
= 0x01,
541 static struct usb_cdc_acm_descriptor acm_descriptor
= {
542 .bLength
= sizeof acm_descriptor
,
543 .bDescriptorType
= USB_DT_CS_INTERFACE
,
544 .bDescriptorSubType
= USB_CDC_ACM_TYPE
,
546 .bmCapabilities
= 0x00,
551 #ifdef DEV_CONFIG_CDC
553 static const struct usb_cdc_ether_desc ether_desc
= {
554 .bLength
= sizeof ether_desc
,
555 .bDescriptorType
= USB_DT_CS_INTERFACE
,
556 .bDescriptorSubType
= USB_CDC_ETHERNET_TYPE
,
558 /* this descriptor actually adds value, surprise! */
559 .iMACAddress
= STRING_ETHADDR
,
560 .bmEthernetStatistics
= __constant_cpu_to_le32 (0), /* no statistics */
561 .wMaxSegmentSize
= __constant_cpu_to_le16 (ETH_FRAME_LEN
),
562 .wNumberMCFilters
= __constant_cpu_to_le16 (0),
563 .bNumberPowerFilters
= 0,
568 #if defined(DEV_CONFIG_CDC) || defined(CONFIG_USB_ETH_RNDIS)
570 /* include the status endpoint if we can, even where it's optional.
571 * use wMaxPacketSize big enough to fit CDC_NOTIFY_SPEED_CHANGE in one
572 * packet, to simplify cancellation; and a big transfer interval, to
573 * waste less bandwidth.
575 * some drivers (like Linux 2.4 cdc-ether!) "need" it to exist even
576 * if they ignore the connect/disconnect notifications that real aether
577 * can provide. more advanced cdc configurations might want to support
578 * encapsulated commands (vendor-specific, using control-OUT).
580 * RNDIS requires the status endpoint, since it uses that encapsulation
581 * mechanism for its funky RPC scheme.
584 #define LOG2_STATUS_INTERVAL_MSEC 5 /* 1 << 5 == 32 msec */
585 #define STATUS_BYTECOUNT 16 /* 8 byte header + data */
587 static struct usb_endpoint_descriptor
589 .bLength
= USB_DT_ENDPOINT_SIZE
,
590 .bDescriptorType
= USB_DT_ENDPOINT
,
592 .bEndpointAddress
= USB_DIR_IN
,
593 .bmAttributes
= USB_ENDPOINT_XFER_INT
,
594 .wMaxPacketSize
= __constant_cpu_to_le16 (STATUS_BYTECOUNT
),
595 .bInterval
= 1 << LOG2_STATUS_INTERVAL_MSEC
,
599 #ifdef DEV_CONFIG_CDC
601 /* the default data interface has no endpoints ... */
603 static const struct usb_interface_descriptor
605 .bLength
= sizeof data_nop_intf
,
606 .bDescriptorType
= USB_DT_INTERFACE
,
608 .bInterfaceNumber
= 1,
609 .bAlternateSetting
= 0,
611 .bInterfaceClass
= USB_CLASS_CDC_DATA
,
612 .bInterfaceSubClass
= 0,
613 .bInterfaceProtocol
= 0,
616 /* ... but the "real" data interface has two bulk endpoints */
618 static const struct usb_interface_descriptor
620 .bLength
= sizeof data_intf
,
621 .bDescriptorType
= USB_DT_INTERFACE
,
623 .bInterfaceNumber
= 1,
624 .bAlternateSetting
= 1,
626 .bInterfaceClass
= USB_CLASS_CDC_DATA
,
627 .bInterfaceSubClass
= 0,
628 .bInterfaceProtocol
= 0,
629 .iInterface
= STRING_DATA
,
634 #ifdef CONFIG_USB_ETH_RNDIS
636 /* RNDIS doesn't activate by changing to the "real" altsetting */
638 static const struct usb_interface_descriptor
640 .bLength
= sizeof rndis_data_intf
,
641 .bDescriptorType
= USB_DT_INTERFACE
,
643 .bInterfaceNumber
= 1,
644 .bAlternateSetting
= 0,
646 .bInterfaceClass
= USB_CLASS_CDC_DATA
,
647 .bInterfaceSubClass
= 0,
648 .bInterfaceProtocol
= 0,
649 .iInterface
= STRING_DATA
,
654 #ifdef DEV_CONFIG_SUBSET
657 * "Simple" CDC-subset option is a simple vendor-neutral model that most
658 * full speed controllers can handle: one interface, two bulk endpoints.
661 static const struct usb_interface_descriptor
663 .bLength
= sizeof subset_data_intf
,
664 .bDescriptorType
= USB_DT_INTERFACE
,
666 .bInterfaceNumber
= 0,
667 .bAlternateSetting
= 0,
669 .bInterfaceClass
= USB_CLASS_VENDOR_SPEC
,
670 .bInterfaceSubClass
= 0,
671 .bInterfaceProtocol
= 0,
672 .iInterface
= STRING_DATA
,
678 static struct usb_endpoint_descriptor
680 .bLength
= USB_DT_ENDPOINT_SIZE
,
681 .bDescriptorType
= USB_DT_ENDPOINT
,
683 .bEndpointAddress
= USB_DIR_IN
,
684 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
687 static struct usb_endpoint_descriptor
689 .bLength
= USB_DT_ENDPOINT_SIZE
,
690 .bDescriptorType
= USB_DT_ENDPOINT
,
692 .bEndpointAddress
= USB_DIR_OUT
,
693 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
696 static const struct usb_descriptor_header
*fs_eth_function
[11] = {
697 (struct usb_descriptor_header
*) &otg_descriptor
,
698 #ifdef DEV_CONFIG_CDC
699 /* "cdc" mode descriptors */
700 (struct usb_descriptor_header
*) &control_intf
,
701 (struct usb_descriptor_header
*) &header_desc
,
702 (struct usb_descriptor_header
*) &union_desc
,
703 (struct usb_descriptor_header
*) ðer_desc
,
704 /* NOTE: status endpoint may need to be removed */
705 (struct usb_descriptor_header
*) &fs_status_desc
,
706 /* data interface, with altsetting */
707 (struct usb_descriptor_header
*) &data_nop_intf
,
708 (struct usb_descriptor_header
*) &data_intf
,
709 (struct usb_descriptor_header
*) &fs_source_desc
,
710 (struct usb_descriptor_header
*) &fs_sink_desc
,
712 #endif /* DEV_CONFIG_CDC */
715 static inline void __init
fs_subset_descriptors(void)
717 #ifdef DEV_CONFIG_SUBSET
718 fs_eth_function
[1] = (struct usb_descriptor_header
*) &subset_data_intf
;
719 fs_eth_function
[2] = (struct usb_descriptor_header
*) &fs_source_desc
;
720 fs_eth_function
[3] = (struct usb_descriptor_header
*) &fs_sink_desc
;
721 fs_eth_function
[4] = NULL
;
723 fs_eth_function
[1] = NULL
;
727 #ifdef CONFIG_USB_ETH_RNDIS
728 static const struct usb_descriptor_header
*fs_rndis_function
[] = {
729 (struct usb_descriptor_header
*) &otg_descriptor
,
730 /* control interface matches ACM, not Ethernet */
731 (struct usb_descriptor_header
*) &rndis_control_intf
,
732 (struct usb_descriptor_header
*) &header_desc
,
733 (struct usb_descriptor_header
*) &call_mgmt_descriptor
,
734 (struct usb_descriptor_header
*) &acm_descriptor
,
735 (struct usb_descriptor_header
*) &union_desc
,
736 (struct usb_descriptor_header
*) &fs_status_desc
,
737 /* data interface has no altsetting */
738 (struct usb_descriptor_header
*) &rndis_data_intf
,
739 (struct usb_descriptor_header
*) &fs_source_desc
,
740 (struct usb_descriptor_header
*) &fs_sink_desc
,
745 #ifdef CONFIG_USB_GADGET_DUALSPEED
748 * usb 2.0 devices need to expose both high speed and full speed
749 * descriptors, unless they only run at full speed.
752 #if defined(DEV_CONFIG_CDC) || defined(CONFIG_USB_ETH_RNDIS)
753 static struct usb_endpoint_descriptor
755 .bLength
= USB_DT_ENDPOINT_SIZE
,
756 .bDescriptorType
= USB_DT_ENDPOINT
,
758 .bmAttributes
= USB_ENDPOINT_XFER_INT
,
759 .wMaxPacketSize
= __constant_cpu_to_le16 (STATUS_BYTECOUNT
),
760 .bInterval
= LOG2_STATUS_INTERVAL_MSEC
+ 4,
762 #endif /* DEV_CONFIG_CDC */
764 static struct usb_endpoint_descriptor
766 .bLength
= USB_DT_ENDPOINT_SIZE
,
767 .bDescriptorType
= USB_DT_ENDPOINT
,
769 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
770 .wMaxPacketSize
= __constant_cpu_to_le16 (512),
773 static struct usb_endpoint_descriptor
775 .bLength
= USB_DT_ENDPOINT_SIZE
,
776 .bDescriptorType
= USB_DT_ENDPOINT
,
778 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
779 .wMaxPacketSize
= __constant_cpu_to_le16 (512),
782 static struct usb_qualifier_descriptor
784 .bLength
= sizeof dev_qualifier
,
785 .bDescriptorType
= USB_DT_DEVICE_QUALIFIER
,
787 .bcdUSB
= __constant_cpu_to_le16 (0x0200),
788 .bDeviceClass
= USB_CLASS_COMM
,
790 .bNumConfigurations
= 1,
793 static const struct usb_descriptor_header
*hs_eth_function
[11] = {
794 (struct usb_descriptor_header
*) &otg_descriptor
,
795 #ifdef DEV_CONFIG_CDC
796 /* "cdc" mode descriptors */
797 (struct usb_descriptor_header
*) &control_intf
,
798 (struct usb_descriptor_header
*) &header_desc
,
799 (struct usb_descriptor_header
*) &union_desc
,
800 (struct usb_descriptor_header
*) ðer_desc
,
801 /* NOTE: status endpoint may need to be removed */
802 (struct usb_descriptor_header
*) &hs_status_desc
,
803 /* data interface, with altsetting */
804 (struct usb_descriptor_header
*) &data_nop_intf
,
805 (struct usb_descriptor_header
*) &data_intf
,
806 (struct usb_descriptor_header
*) &hs_source_desc
,
807 (struct usb_descriptor_header
*) &hs_sink_desc
,
809 #endif /* DEV_CONFIG_CDC */
812 static inline void __init
hs_subset_descriptors(void)
814 #ifdef DEV_CONFIG_SUBSET
815 hs_eth_function
[1] = (struct usb_descriptor_header
*) &subset_data_intf
;
816 hs_eth_function
[2] = (struct usb_descriptor_header
*) &fs_source_desc
;
817 hs_eth_function
[3] = (struct usb_descriptor_header
*) &fs_sink_desc
;
818 hs_eth_function
[4] = NULL
;
820 hs_eth_function
[1] = NULL
;
824 #ifdef CONFIG_USB_ETH_RNDIS
825 static const struct usb_descriptor_header
*hs_rndis_function
[] = {
826 (struct usb_descriptor_header
*) &otg_descriptor
,
827 /* control interface matches ACM, not Ethernet */
828 (struct usb_descriptor_header
*) &rndis_control_intf
,
829 (struct usb_descriptor_header
*) &header_desc
,
830 (struct usb_descriptor_header
*) &call_mgmt_descriptor
,
831 (struct usb_descriptor_header
*) &acm_descriptor
,
832 (struct usb_descriptor_header
*) &union_desc
,
833 (struct usb_descriptor_header
*) &hs_status_desc
,
834 /* data interface has no altsetting */
835 (struct usb_descriptor_header
*) &rndis_data_intf
,
836 (struct usb_descriptor_header
*) &hs_source_desc
,
837 (struct usb_descriptor_header
*) &hs_sink_desc
,
843 /* maxpacket and other transfer characteristics vary by speed. */
844 #define ep_desc(g,hs,fs) (((g)->speed==USB_SPEED_HIGH)?(hs):(fs))
848 /* if there's no high speed support, maxpacket doesn't change. */
849 #define ep_desc(g,hs,fs) fs
851 static inline void __init
hs_subset_descriptors(void)
855 #endif /* !CONFIG_USB_GADGET_DUALSPEED */
857 /*-------------------------------------------------------------------------*/
859 /* descriptors that are built on-demand */
861 static char manufacturer
[50];
862 static char product_desc
[40] = DRIVER_DESC
;
864 #ifdef DEV_CONFIG_CDC
865 /* address that the host will use ... usually assigned at random */
866 static char ethaddr
[2 * ETH_ALEN
+ 1];
869 /* static strings, in UTF-8 */
870 static struct usb_string strings
[] = {
871 { STRING_MANUFACTURER
, manufacturer
, },
872 { STRING_PRODUCT
, product_desc
, },
873 { STRING_DATA
, "Ethernet Data", },
874 #ifdef DEV_CONFIG_CDC
875 { STRING_CDC
, "CDC Ethernet", },
876 { STRING_ETHADDR
, ethaddr
, },
877 { STRING_CONTROL
, "CDC Communications Control", },
879 #ifdef DEV_CONFIG_SUBSET
880 { STRING_SUBSET
, "CDC Ethernet Subset", },
882 #ifdef CONFIG_USB_ETH_RNDIS
883 { STRING_RNDIS
, "RNDIS", },
884 { STRING_RNDIS_CONTROL
, "RNDIS Communications Control", },
886 { } /* end of list */
889 static struct usb_gadget_strings stringtab
= {
890 .language
= 0x0409, /* en-us */
895 * one config, two interfaces: control, data.
896 * complications: class descriptors, and an altsetting.
899 config_buf (enum usb_device_speed speed
,
901 unsigned index
, int is_otg
)
904 const struct usb_config_descriptor
*config
;
905 const struct usb_descriptor_header
**function
;
906 #ifdef CONFIG_USB_GADGET_DUALSPEED
907 int hs
= (speed
== USB_SPEED_HIGH
);
909 if (type
== USB_DT_OTHER_SPEED_CONFIG
)
911 #define which_fn(t) (hs ? hs_ ## t ## _function : fs_ ## t ## _function)
913 #define which_fn(t) (fs_ ## t ## _function)
916 if (index
>= device_desc
.bNumConfigurations
)
919 #ifdef CONFIG_USB_ETH_RNDIS
920 /* list the RNDIS config first, to make Microsoft's drivers
921 * happy. DOCSIS 1.0 needs this too.
923 if (device_desc
.bNumConfigurations
== 2 && index
== 0) {
924 config
= &rndis_config
;
925 function
= which_fn (rndis
);
929 config
= ð_config
;
930 function
= which_fn (eth
);
933 /* for now, don't advertise srp-only devices */
937 len
= usb_gadget_config_buf (config
, buf
, USB_BUFSIZ
, function
);
940 ((struct usb_config_descriptor
*) buf
)->bDescriptorType
= type
;
944 /*-------------------------------------------------------------------------*/
946 static void eth_start (struct eth_dev
*dev
, int gfp_flags
);
947 static int alloc_requests (struct eth_dev
*dev
, unsigned n
, int gfp_flags
);
949 #ifdef DEV_CONFIG_CDC
950 static inline int ether_alt_ep_setup (struct eth_dev
*dev
, struct usb_ep
*ep
)
952 const struct usb_endpoint_descriptor
*d
;
954 /* With CDC, the host isn't allowed to use these two data
955 * endpoints in the default altsetting for the interface.
956 * so we don't activate them yet. Reset from SET_INTERFACE.
958 * Strictly speaking RNDIS should work the same: activation is
959 * a side effect of setting a packet filter. Deactivation is
960 * from REMOTE_NDIS_HALT_MSG, reset from REMOTE_NDIS_RESET_MSG.
963 /* one endpoint writes data back IN to the host */
964 if (strcmp (ep
->name
, EP_IN_NAME
) == 0) {
965 d
= ep_desc (dev
->gadget
, &hs_source_desc
, &fs_source_desc
);
966 ep
->driver_data
= dev
;
969 /* one endpoint just reads OUT packets */
970 } else if (strcmp (ep
->name
, EP_OUT_NAME
) == 0) {
971 d
= ep_desc (dev
->gadget
, &hs_sink_desc
, &fs_sink_desc
);
972 ep
->driver_data
= dev
;
975 /* optional status/notification endpoint */
976 } else if (EP_STATUS_NAME
&&
977 strcmp (ep
->name
, EP_STATUS_NAME
) == 0) {
980 d
= ep_desc (dev
->gadget
, &hs_status_desc
, &fs_status_desc
);
981 result
= usb_ep_enable (ep
, d
);
985 ep
->driver_data
= dev
;
992 #if defined(DEV_CONFIG_SUBSET) || defined(CONFIG_USB_ETH_RNDIS)
993 static inline int ether_ep_setup (struct eth_dev
*dev
, struct usb_ep
*ep
)
996 const struct usb_endpoint_descriptor
*d
;
998 /* CDC subset is simpler: if the device is there,
999 * it's live with rx and tx endpoints.
1001 * Do this as a shortcut for RNDIS too.
1004 /* one endpoint writes data back IN to the host */
1005 if (strcmp (ep
->name
, EP_IN_NAME
) == 0) {
1006 d
= ep_desc (dev
->gadget
, &hs_source_desc
, &fs_source_desc
);
1007 result
= usb_ep_enable (ep
, d
);
1011 ep
->driver_data
= dev
;
1014 /* one endpoint just reads OUT packets */
1015 } else if (strcmp (ep
->name
, EP_OUT_NAME
) == 0) {
1016 d
= ep_desc (dev
->gadget
, &hs_sink_desc
, &fs_sink_desc
);
1017 result
= usb_ep_enable (ep
, d
);
1021 ep
->driver_data
= dev
;
1030 set_ether_config (struct eth_dev
*dev
, int gfp_flags
)
1034 struct usb_gadget
*gadget
= dev
->gadget
;
1036 gadget_for_each_ep (ep
, gadget
) {
1037 #ifdef DEV_CONFIG_CDC
1038 if (!dev
->rndis
&& dev
->cdc
) {
1039 result
= ether_alt_ep_setup (dev
, ep
);
1045 #ifdef CONFIG_USB_ETH_RNDIS
1046 if (dev
->rndis
&& strcmp (ep
->name
, EP_STATUS_NAME
) == 0) {
1047 const struct usb_endpoint_descriptor
*d
;
1048 d
= ep_desc (gadget
, &hs_status_desc
, &fs_status_desc
);
1049 result
= usb_ep_enable (ep
, d
);
1051 ep
->driver_data
= dev
;
1059 #if defined(DEV_CONFIG_SUBSET) || defined(CONFIG_USB_ETH_RNDIS)
1060 result
= ether_ep_setup (dev
, ep
);
1067 ERROR (dev
, "can't enable %s, result %d\n", ep
->name
, result
);
1070 if (!result
&& (!dev
->in_ep
|| !dev
->out_ep
))
1074 result
= alloc_requests (dev
, qlen (gadget
), gfp_flags
);
1076 /* on error, disable any endpoints */
1078 #if defined(DEV_CONFIG_CDC) || defined(CONFIG_USB_ETH_RNDIS)
1080 (void) usb_ep_disable (dev
->status_ep
);
1083 #if defined(DEV_CONFIG_SUBSET) || defined(CONFIG_USB_ETH_RNDIS)
1084 if (dev
->rndis
|| !dev
->cdc
) {
1086 (void) usb_ep_disable (dev
->in_ep
);
1088 (void) usb_ep_disable (dev
->out_ep
);
1095 /* activate non-CDC configs right away
1096 * this isn't strictly according to the RNDIS spec
1098 #if defined(DEV_CONFIG_SUBSET) || defined(CONFIG_USB_ETH_RNDIS)
1099 if (dev
->rndis
|| !dev
->cdc
) {
1100 netif_carrier_on (dev
->net
);
1101 if (netif_running (dev
->net
)) {
1102 spin_unlock (&dev
->lock
);
1103 eth_start (dev
, GFP_ATOMIC
);
1104 spin_lock (&dev
->lock
);
1110 DEBUG (dev
, "qlen %d\n", qlen (gadget
));
1112 /* caller is responsible for cleanup on error */
1116 static void eth_reset_config (struct eth_dev
*dev
)
1118 struct usb_request
*req
;
1120 if (dev
->config
== 0)
1123 DEBUG (dev
, "%s\n", __FUNCTION__
);
1125 netif_stop_queue (dev
->net
);
1126 netif_carrier_off (dev
->net
);
1128 /* disable endpoints, forcing (synchronous) completion of
1129 * pending i/o. then free the requests.
1132 usb_ep_disable (dev
->in_ep
);
1133 while (likely (!list_empty (&dev
->tx_reqs
))) {
1134 req
= container_of (dev
->tx_reqs
.next
,
1135 struct usb_request
, list
);
1136 list_del (&req
->list
);
1137 usb_ep_free_request (dev
->in_ep
, req
);
1141 usb_ep_disable (dev
->out_ep
);
1142 while (likely (!list_empty (&dev
->rx_reqs
))) {
1143 req
= container_of (dev
->rx_reqs
.next
,
1144 struct usb_request
, list
);
1145 list_del (&req
->list
);
1146 usb_ep_free_request (dev
->out_ep
, req
);
1151 usb_ep_disable (dev
->status_ep
);
1156 /* change our operational config. must agree with the code
1157 * that returns config descriptors, and altsetting code.
1160 eth_set_config (struct eth_dev
*dev
, unsigned number
, int gfp_flags
)
1163 struct usb_gadget
*gadget
= dev
->gadget
;
1165 if (number
== dev
->config
)
1168 if (gadget_is_sa1100 (gadget
)
1170 && atomic_read (&dev
->tx_qlen
) != 0) {
1171 /* tx fifo is full, but we can't clear it...*/
1172 INFO (dev
, "can't change configurations\n");
1175 eth_reset_config (dev
);
1177 /* default: pass all packets, no multicast filtering */
1178 dev
->cdc_filter
= DEFAULT_FILTER
;
1181 case DEV_CONFIG_VALUE
:
1183 result
= set_ether_config (dev
, gfp_flags
);
1185 #ifdef CONFIG_USB_ETH_RNDIS
1186 case DEV_RNDIS_CONFIG_VALUE
:
1188 result
= set_ether_config (dev
, gfp_flags
);
1200 eth_reset_config (dev
);
1201 usb_gadget_vbus_draw(dev
->gadget
,
1202 dev
->gadget
->is_otg
? 8 : 100);
1207 power
= 2 * eth_config
.bMaxPower
;
1208 usb_gadget_vbus_draw(dev
->gadget
, power
);
1210 switch (gadget
->speed
) {
1211 case USB_SPEED_FULL
: speed
= "full"; break;
1212 #ifdef CONFIG_USB_GADGET_DUALSPEED
1213 case USB_SPEED_HIGH
: speed
= "high"; break;
1215 default: speed
= "?"; break;
1218 dev
->config
= number
;
1219 INFO (dev
, "%s speed config #%d: %d mA, %s, using %s\n",
1220 speed
, number
, power
, driver_desc
,
1225 : "CDC Ethernet Subset"));
1230 /*-------------------------------------------------------------------------*/
1232 #ifdef DEV_CONFIG_CDC
1234 static void eth_status_complete (struct usb_ep
*ep
, struct usb_request
*req
)
1236 struct usb_cdc_notification
*event
= req
->buf
;
1237 int value
= req
->status
;
1238 struct eth_dev
*dev
= ep
->driver_data
;
1240 /* issue the second notification if host reads the first */
1241 if (event
->bNotificationType
== USB_CDC_NOTIFY_NETWORK_CONNECTION
1243 __le32
*data
= req
->buf
+ sizeof *event
;
1245 event
->bmRequestType
= 0xA1;
1246 event
->bNotificationType
= USB_CDC_NOTIFY_SPEED_CHANGE
;
1247 event
->wValue
= __constant_cpu_to_le16 (0);
1248 event
->wIndex
= __constant_cpu_to_le16 (1);
1249 event
->wLength
= __constant_cpu_to_le16 (8);
1251 /* SPEED_CHANGE data is up/down speeds in bits/sec */
1252 data
[0] = data
[1] = cpu_to_le32 (BITRATE (dev
->gadget
));
1254 req
->length
= STATUS_BYTECOUNT
;
1255 value
= usb_ep_queue (ep
, req
, GFP_ATOMIC
);
1256 DEBUG (dev
, "send SPEED_CHANGE --> %d\n", value
);
1259 } else if (value
!= -ECONNRESET
)
1260 DEBUG (dev
, "event %02x --> %d\n",
1261 event
->bNotificationType
, value
);
1262 event
->bmRequestType
= 0xff;
1265 static void issue_start_status (struct eth_dev
*dev
)
1267 struct usb_request
*req
= dev
->stat_req
;
1268 struct usb_cdc_notification
*event
;
1271 DEBUG (dev
, "%s, flush old status first\n", __FUNCTION__
);
1275 * FIXME ugly idiom, maybe we'd be better with just
1276 * a "cancel the whole queue" primitive since any
1277 * unlink-one primitive has way too many error modes.
1278 * here, we "know" toggle is already clear...
1280 usb_ep_disable (dev
->status_ep
);
1281 usb_ep_enable (dev
->status_ep
, dev
->status
);
1283 /* 3.8.1 says to issue first NETWORK_CONNECTION, then
1284 * a SPEED_CHANGE. could be useful in some configs.
1287 event
->bmRequestType
= 0xA1;
1288 event
->bNotificationType
= USB_CDC_NOTIFY_NETWORK_CONNECTION
;
1289 event
->wValue
= __constant_cpu_to_le16 (1); /* connected */
1290 event
->wIndex
= __constant_cpu_to_le16 (1);
1293 req
->length
= sizeof *event
;
1294 req
->complete
= eth_status_complete
;
1295 value
= usb_ep_queue (dev
->status_ep
, req
, GFP_ATOMIC
);
1297 DEBUG (dev
, "status buf queue --> %d\n", value
);
1302 /*-------------------------------------------------------------------------*/
1304 static void eth_setup_complete (struct usb_ep
*ep
, struct usb_request
*req
)
1306 if (req
->status
|| req
->actual
!= req
->length
)
1307 DEBUG ((struct eth_dev
*) ep
->driver_data
,
1308 "setup complete --> %d, %d/%d\n",
1309 req
->status
, req
->actual
, req
->length
);
1312 #ifdef CONFIG_USB_ETH_RNDIS
1314 static void rndis_response_complete (struct usb_ep
*ep
, struct usb_request
*req
)
1316 if (req
->status
|| req
->actual
!= req
->length
)
1317 DEBUG ((struct eth_dev
*) ep
->driver_data
,
1318 "rndis response complete --> %d, %d/%d\n",
1319 req
->status
, req
->actual
, req
->length
);
1321 /* done sending after USB_CDC_GET_ENCAPSULATED_RESPONSE */
1324 static void rndis_command_complete (struct usb_ep
*ep
, struct usb_request
*req
)
1326 struct eth_dev
*dev
= ep
->driver_data
;
1329 /* received RNDIS command from USB_CDC_SEND_ENCAPSULATED_COMMAND */
1330 spin_lock(&dev
->lock
);
1331 status
= rndis_msg_parser (dev
->rndis_config
, (u8
*) req
->buf
);
1333 ERROR(dev
, "%s: rndis parse error %d\n", __FUNCTION__
, status
);
1334 spin_unlock(&dev
->lock
);
1340 * The setup() callback implements all the ep0 functionality that's not
1341 * handled lower down. CDC has a number of less-common features:
1343 * - two interfaces: control, and ethernet data
1344 * - Ethernet data interface has two altsettings: default, and active
1345 * - class-specific descriptors for the control interface
1346 * - class-specific control requests
1349 eth_setup (struct usb_gadget
*gadget
, const struct usb_ctrlrequest
*ctrl
)
1351 struct eth_dev
*dev
= get_gadget_data (gadget
);
1352 struct usb_request
*req
= dev
->req
;
1353 int value
= -EOPNOTSUPP
;
1354 u16 wIndex
= (__force u16
) ctrl
->wIndex
;
1355 u16 wValue
= (__force u16
) ctrl
->wValue
;
1356 u16 wLength
= (__force u16
) ctrl
->wLength
;
1358 /* descriptors just go into the pre-allocated ep0 buffer,
1359 * while config change events may enable network traffic.
1361 req
->complete
= eth_setup_complete
;
1362 switch (ctrl
->bRequest
) {
1364 case USB_REQ_GET_DESCRIPTOR
:
1365 if (ctrl
->bRequestType
!= USB_DIR_IN
)
1367 switch (wValue
>> 8) {
1370 value
= min (wLength
, (u16
) sizeof device_desc
);
1371 memcpy (req
->buf
, &device_desc
, value
);
1373 #ifdef CONFIG_USB_GADGET_DUALSPEED
1374 case USB_DT_DEVICE_QUALIFIER
:
1375 if (!gadget
->is_dualspeed
)
1377 value
= min (wLength
, (u16
) sizeof dev_qualifier
);
1378 memcpy (req
->buf
, &dev_qualifier
, value
);
1381 case USB_DT_OTHER_SPEED_CONFIG
:
1382 if (!gadget
->is_dualspeed
)
1385 #endif /* CONFIG_USB_GADGET_DUALSPEED */
1387 value
= config_buf (gadget
->speed
, req
->buf
,
1392 value
= min (wLength
, (u16
) value
);
1396 value
= usb_gadget_get_string (&stringtab
,
1397 wValue
& 0xff, req
->buf
);
1399 value
= min (wLength
, (u16
) value
);
1404 case USB_REQ_SET_CONFIGURATION
:
1405 if (ctrl
->bRequestType
!= 0)
1407 if (gadget
->a_hnp_support
)
1408 DEBUG (dev
, "HNP available\n");
1409 else if (gadget
->a_alt_hnp_support
)
1410 DEBUG (dev
, "HNP needs a different root port\n");
1411 spin_lock (&dev
->lock
);
1412 value
= eth_set_config (dev
, wValue
, GFP_ATOMIC
);
1413 spin_unlock (&dev
->lock
);
1415 case USB_REQ_GET_CONFIGURATION
:
1416 if (ctrl
->bRequestType
!= USB_DIR_IN
)
1418 *(u8
*)req
->buf
= dev
->config
;
1419 value
= min (wLength
, (u16
) 1);
1422 case USB_REQ_SET_INTERFACE
:
1423 if (ctrl
->bRequestType
!= USB_RECIP_INTERFACE
1427 if (!dev
->cdc
&& wIndex
!= 0)
1429 spin_lock (&dev
->lock
);
1431 /* PXA hardware partially handles SET_INTERFACE;
1432 * we need to kluge around that interference.
1434 if (gadget_is_pxa (gadget
)) {
1435 value
= eth_set_config (dev
, DEV_CONFIG_VALUE
,
1440 #ifdef DEV_CONFIG_CDC
1442 case 0: /* control/master intf */
1446 usb_ep_disable (dev
->status_ep
);
1447 usb_ep_enable (dev
->status_ep
, dev
->status
);
1451 case 1: /* data intf */
1454 usb_ep_disable (dev
->in_ep
);
1455 usb_ep_disable (dev
->out_ep
);
1457 /* CDC requires the data transfers not be done from
1458 * the default interface setting ... also, setting
1459 * the non-default interface clears filters etc.
1462 usb_ep_enable (dev
->in_ep
, dev
->in
);
1463 usb_ep_enable (dev
->out_ep
, dev
->out
);
1464 dev
->cdc_filter
= DEFAULT_FILTER
;
1465 netif_carrier_on (dev
->net
);
1467 issue_start_status (dev
);
1468 if (netif_running (dev
->net
)) {
1469 spin_unlock (&dev
->lock
);
1470 eth_start (dev
, GFP_ATOMIC
);
1471 spin_lock (&dev
->lock
);
1474 netif_stop_queue (dev
->net
);
1475 netif_carrier_off (dev
->net
);
1481 /* FIXME this is wrong, as is the assumption that
1482 * all non-PXA hardware talks real CDC ...
1484 dev_warn (&gadget
->dev
, "set_interface ignored!\n");
1485 #endif /* DEV_CONFIG_CDC */
1488 spin_unlock (&dev
->lock
);
1490 case USB_REQ_GET_INTERFACE
:
1491 if (ctrl
->bRequestType
!= (USB_DIR_IN
|USB_RECIP_INTERFACE
)
1495 if (!(dev
->cdc
|| dev
->rndis
) && wIndex
!= 0)
1498 /* for CDC, iff carrier is on, data interface is active. */
1499 if (dev
->rndis
|| wIndex
!= 1)
1500 *(u8
*)req
->buf
= 0;
1502 *(u8
*)req
->buf
= netif_carrier_ok (dev
->net
) ? 1 : 0;
1503 value
= min (wLength
, (u16
) 1);
1506 #ifdef DEV_CONFIG_CDC
1507 case USB_CDC_SET_ETHERNET_PACKET_FILTER
:
1508 /* see 6.2.30: no data, wIndex = interface,
1509 * wValue = packet filter bitmap
1511 if (ctrl
->bRequestType
!= (USB_TYPE_CLASS
|USB_RECIP_INTERFACE
)
1517 DEBUG (dev
, "packet filter %02x\n", wValue
);
1518 dev
->cdc_filter
= wValue
;
1523 * case USB_CDC_SET_ETHERNET_MULTICAST_FILTERS:
1524 * case USB_CDC_SET_ETHERNET_PM_PATTERN_FILTER:
1525 * case USB_CDC_GET_ETHERNET_PM_PATTERN_FILTER:
1526 * case USB_CDC_GET_ETHERNET_STATISTIC:
1529 #endif /* DEV_CONFIG_CDC */
1531 #ifdef CONFIG_USB_ETH_RNDIS
1532 /* RNDIS uses the CDC command encapsulation mechanism to implement
1533 * an RPC scheme, with much getting/setting of attributes by OID.
1535 case USB_CDC_SEND_ENCAPSULATED_COMMAND
:
1536 if (ctrl
->bRequestType
!= (USB_TYPE_CLASS
|USB_RECIP_INTERFACE
)
1538 || wLength
> USB_BUFSIZ
1540 || rndis_control_intf
.bInterfaceNumber
1543 /* read the request, then process it */
1545 req
->complete
= rndis_command_complete
;
1546 /* later, rndis_control_ack () sends a notification */
1549 case USB_CDC_GET_ENCAPSULATED_RESPONSE
:
1550 if ((USB_DIR_IN
|USB_TYPE_CLASS
|USB_RECIP_INTERFACE
)
1551 == ctrl
->bRequestType
1553 // && wLength >= 0x0400
1555 && rndis_control_intf
.bInterfaceNumber
1559 /* return the result */
1560 buf
= rndis_get_next_response (dev
->rndis_config
,
1563 memcpy (req
->buf
, buf
, value
);
1564 req
->complete
= rndis_response_complete
;
1565 rndis_free_response(dev
->rndis_config
, buf
);
1567 /* else stalls ... spec says to avoid that */
1574 "unknown control req%02x.%02x v%04x i%04x l%d\n",
1575 ctrl
->bRequestType
, ctrl
->bRequest
,
1576 wValue
, wIndex
, wLength
);
1579 /* respond with data transfer before status phase? */
1581 req
->length
= value
;
1582 req
->zero
= value
< wLength
1583 && (value
% gadget
->ep0
->maxpacket
) == 0;
1584 value
= usb_ep_queue (gadget
->ep0
, req
, GFP_ATOMIC
);
1586 DEBUG (dev
, "ep_queue --> %d\n", value
);
1588 eth_setup_complete (gadget
->ep0
, req
);
1592 /* host either stalls (value < 0) or reports success */
1597 eth_disconnect (struct usb_gadget
*gadget
)
1599 struct eth_dev
*dev
= get_gadget_data (gadget
);
1600 unsigned long flags
;
1602 spin_lock_irqsave (&dev
->lock
, flags
);
1603 netif_stop_queue (dev
->net
);
1604 netif_carrier_off (dev
->net
);
1605 eth_reset_config (dev
);
1606 spin_unlock_irqrestore (&dev
->lock
, flags
);
1608 /* FIXME RNDIS should enter RNDIS_UNINITIALIZED */
1610 /* next we may get setup() calls to enumerate new connections;
1611 * or an unbind() during shutdown (including removing module).
1615 /*-------------------------------------------------------------------------*/
1617 /* NETWORK DRIVER HOOKUP (to the layer above this driver) */
1619 static int eth_change_mtu (struct net_device
*net
, int new_mtu
)
1621 struct eth_dev
*dev
= netdev_priv(net
);
1623 // FIXME if rndis, don't change while link's live
1625 if (new_mtu
<= ETH_HLEN
|| new_mtu
> ETH_FRAME_LEN
)
1627 /* no zero-length packet read wanted after mtu-sized packets */
1628 if (((new_mtu
+ sizeof (struct ethhdr
)) % dev
->in_ep
->maxpacket
) == 0)
1634 static struct net_device_stats
*eth_get_stats (struct net_device
*net
)
1636 return &((struct eth_dev
*)netdev_priv(net
))->stats
;
1639 static void eth_get_drvinfo(struct net_device
*net
, struct ethtool_drvinfo
*p
)
1641 struct eth_dev
*dev
= netdev_priv(net
);
1642 strlcpy(p
->driver
, shortname
, sizeof p
->driver
);
1643 strlcpy(p
->version
, DRIVER_VERSION
, sizeof p
->version
);
1644 strlcpy(p
->fw_version
, dev
->gadget
->name
, sizeof p
->fw_version
);
1645 strlcpy (p
->bus_info
, dev
->gadget
->dev
.bus_id
, sizeof p
->bus_info
);
1648 static u32
eth_get_link(struct net_device
*net
)
1650 struct eth_dev
*dev
= netdev_priv(net
);
1651 return dev
->gadget
->speed
!= USB_SPEED_UNKNOWN
;
1654 static struct ethtool_ops ops
= {
1655 .get_drvinfo
= eth_get_drvinfo
,
1656 .get_link
= eth_get_link
1659 static void defer_kevent (struct eth_dev
*dev
, int flag
)
1661 if (test_and_set_bit (flag
, &dev
->todo
))
1663 if (!schedule_work (&dev
->work
))
1664 ERROR (dev
, "kevent %d may have been dropped\n", flag
);
1666 DEBUG (dev
, "kevent %d scheduled\n", flag
);
1669 static void rx_complete (struct usb_ep
*ep
, struct usb_request
*req
);
1672 rx_submit (struct eth_dev
*dev
, struct usb_request
*req
, int gfp_flags
)
1674 struct sk_buff
*skb
;
1675 int retval
= -ENOMEM
;
1678 /* Padding up to RX_EXTRA handles minor disagreements with host.
1679 * Normally we use the USB "terminate on short read" convention;
1680 * so allow up to (N*maxpacket), since that memory is normally
1681 * already allocated. Some hardware doesn't deal well with short
1682 * reads (e.g. DMA must be N*maxpacket), so for now don't trim a
1683 * byte off the end (to force hardware errors on overflow).
1685 * RNDIS uses internal framing, and explicitly allows senders to
1686 * pad to end-of-packet. That's potentially nice for speed,
1687 * but means receivers can't recover synch on their own.
1689 size
= (sizeof (struct ethhdr
) + dev
->net
->mtu
+ RX_EXTRA
);
1690 size
+= dev
->out_ep
->maxpacket
- 1;
1691 #ifdef CONFIG_USB_ETH_RNDIS
1693 size
+= sizeof (struct rndis_packet_msg_type
);
1695 size
-= size
% dev
->out_ep
->maxpacket
;
1697 if ((skb
= alloc_skb (size
+ NET_IP_ALIGN
, gfp_flags
)) == 0) {
1698 DEBUG (dev
, "no rx skb\n");
1702 /* Some platforms perform better when IP packets are aligned,
1703 * but on at least one, checksumming fails otherwise. Note:
1704 * RNDIS headers involve variable numbers of LE32 values.
1706 skb_reserve(skb
, NET_IP_ALIGN
);
1708 req
->buf
= skb
->data
;
1710 req
->complete
= rx_complete
;
1713 retval
= usb_ep_queue (dev
->out_ep
, req
, gfp_flags
);
1714 if (retval
== -ENOMEM
)
1716 defer_kevent (dev
, WORK_RX_MEMORY
);
1718 DEBUG (dev
, "rx submit --> %d\n", retval
);
1719 dev_kfree_skb_any (skb
);
1720 spin_lock (&dev
->lock
);
1721 list_add (&req
->list
, &dev
->rx_reqs
);
1722 spin_unlock (&dev
->lock
);
1727 static void rx_complete (struct usb_ep
*ep
, struct usb_request
*req
)
1729 struct sk_buff
*skb
= req
->context
;
1730 struct eth_dev
*dev
= ep
->driver_data
;
1731 int status
= req
->status
;
1735 /* normal completion */
1737 skb_put (skb
, req
->actual
);
1738 #ifdef CONFIG_USB_ETH_RNDIS
1739 /* we know MaxPacketsPerTransfer == 1 here */
1741 status
= rndis_rm_hdr (skb
);
1744 || ETH_HLEN
> skb
->len
1745 || skb
->len
> ETH_FRAME_LEN
) {
1746 dev
->stats
.rx_errors
++;
1747 dev
->stats
.rx_length_errors
++;
1748 DEBUG (dev
, "rx length %d\n", skb
->len
);
1752 skb
->dev
= dev
->net
;
1753 skb
->protocol
= eth_type_trans (skb
, dev
->net
);
1754 dev
->stats
.rx_packets
++;
1755 dev
->stats
.rx_bytes
+= skb
->len
;
1757 /* no buffer copies needed, unless hardware can't
1760 status
= netif_rx (skb
);
1764 /* software-driven interface shutdown */
1765 case -ECONNRESET
: // unlink
1766 case -ESHUTDOWN
: // disconnect etc
1767 VDEBUG (dev
, "rx shutdown, code %d\n", status
);
1770 /* for hardware automagic (such as pxa) */
1771 case -ECONNABORTED
: // endpoint reset
1772 DEBUG (dev
, "rx %s reset\n", ep
->name
);
1773 defer_kevent (dev
, WORK_RX_MEMORY
);
1775 dev_kfree_skb_any (skb
);
1780 dev
->stats
.rx_over_errors
++;
1784 dev
->stats
.rx_errors
++;
1785 DEBUG (dev
, "rx status %d\n", status
);
1790 dev_kfree_skb_any (skb
);
1791 if (!netif_running (dev
->net
)) {
1793 /* nobody reading rx_reqs, so no dev->lock */
1794 list_add (&req
->list
, &dev
->rx_reqs
);
1798 rx_submit (dev
, req
, GFP_ATOMIC
);
1801 static int prealloc (struct list_head
*list
, struct usb_ep
*ep
,
1802 unsigned n
, int gfp_flags
)
1805 struct usb_request
*req
;
1810 /* queue/recycle up to N requests */
1812 list_for_each_entry (req
, list
, list
) {
1817 req
= usb_ep_alloc_request (ep
, gfp_flags
);
1819 return list_empty (list
) ? -ENOMEM
: 0;
1820 list_add (&req
->list
, list
);
1827 struct list_head
*next
;
1829 next
= req
->list
.next
;
1830 list_del (&req
->list
);
1831 usb_ep_free_request (ep
, req
);
1836 req
= container_of (next
, struct usb_request
, list
);
1841 static int alloc_requests (struct eth_dev
*dev
, unsigned n
, int gfp_flags
)
1845 status
= prealloc (&dev
->tx_reqs
, dev
->in_ep
, n
, gfp_flags
);
1848 status
= prealloc (&dev
->rx_reqs
, dev
->out_ep
, n
, gfp_flags
);
1853 DEBUG (dev
, "can't alloc requests\n");
1857 static void rx_fill (struct eth_dev
*dev
, int gfp_flags
)
1859 struct usb_request
*req
;
1860 unsigned long flags
;
1862 clear_bit (WORK_RX_MEMORY
, &dev
->todo
);
1864 /* fill unused rxq slots with some skb */
1865 spin_lock_irqsave (&dev
->lock
, flags
);
1866 while (!list_empty (&dev
->rx_reqs
)) {
1867 req
= container_of (dev
->rx_reqs
.next
,
1868 struct usb_request
, list
);
1869 list_del_init (&req
->list
);
1870 spin_unlock_irqrestore (&dev
->lock
, flags
);
1872 if (rx_submit (dev
, req
, gfp_flags
) < 0) {
1873 defer_kevent (dev
, WORK_RX_MEMORY
);
1877 spin_lock_irqsave (&dev
->lock
, flags
);
1879 spin_unlock_irqrestore (&dev
->lock
, flags
);
1882 static void eth_work (void *_dev
)
1884 struct eth_dev
*dev
= _dev
;
1886 if (test_bit (WORK_RX_MEMORY
, &dev
->todo
)) {
1887 if (netif_running (dev
->net
))
1888 rx_fill (dev
, GFP_KERNEL
);
1890 clear_bit (WORK_RX_MEMORY
, &dev
->todo
);
1894 DEBUG (dev
, "work done, flags = 0x%lx\n", dev
->todo
);
1897 static void tx_complete (struct usb_ep
*ep
, struct usb_request
*req
)
1899 struct sk_buff
*skb
= req
->context
;
1900 struct eth_dev
*dev
= ep
->driver_data
;
1902 switch (req
->status
) {
1904 dev
->stats
.tx_errors
++;
1905 VDEBUG (dev
, "tx err %d\n", req
->status
);
1907 case -ECONNRESET
: // unlink
1908 case -ESHUTDOWN
: // disconnect etc
1911 dev
->stats
.tx_bytes
+= skb
->len
;
1913 dev
->stats
.tx_packets
++;
1915 spin_lock (&dev
->lock
);
1916 list_add (&req
->list
, &dev
->tx_reqs
);
1917 spin_unlock (&dev
->lock
);
1918 dev_kfree_skb_any (skb
);
1920 atomic_dec (&dev
->tx_qlen
);
1921 if (netif_carrier_ok (dev
->net
))
1922 netif_wake_queue (dev
->net
);
1925 static inline int eth_is_promisc (struct eth_dev
*dev
)
1927 /* no filters for the CDC subset; always promisc */
1928 if (subset_active (dev
))
1930 return dev
->cdc_filter
& USB_CDC_PACKET_TYPE_PROMISCUOUS
;
1933 static int eth_start_xmit (struct sk_buff
*skb
, struct net_device
*net
)
1935 struct eth_dev
*dev
= netdev_priv(net
);
1936 int length
= skb
->len
;
1938 struct usb_request
*req
= NULL
;
1939 unsigned long flags
;
1941 /* apply outgoing CDC or RNDIS filters */
1942 if (!eth_is_promisc (dev
)) {
1943 u8
*dest
= skb
->data
;
1945 if (dest
[0] & 0x01) {
1948 /* ignores USB_CDC_PACKET_TYPE_MULTICAST and host
1949 * SET_ETHERNET_MULTICAST_FILTERS requests
1951 if (memcmp (dest
, net
->broadcast
, ETH_ALEN
) == 0)
1952 type
= USB_CDC_PACKET_TYPE_BROADCAST
;
1954 type
= USB_CDC_PACKET_TYPE_ALL_MULTICAST
;
1955 if (!(dev
->cdc_filter
& type
)) {
1956 dev_kfree_skb_any (skb
);
1960 /* ignores USB_CDC_PACKET_TYPE_DIRECTED */
1963 spin_lock_irqsave (&dev
->lock
, flags
);
1964 req
= container_of (dev
->tx_reqs
.next
, struct usb_request
, list
);
1965 list_del (&req
->list
);
1966 if (list_empty (&dev
->tx_reqs
))
1967 netif_stop_queue (net
);
1968 spin_unlock_irqrestore (&dev
->lock
, flags
);
1970 /* no buffer copies needed, unless the network stack did it
1971 * or the hardware can't use skb buffers.
1972 * or there's not enough space for any RNDIS headers we need
1974 #ifdef CONFIG_USB_ETH_RNDIS
1976 struct sk_buff
*skb_rndis
;
1978 skb_rndis
= skb_realloc_headroom (skb
,
1979 sizeof (struct rndis_packet_msg_type
));
1983 dev_kfree_skb_any (skb
);
1985 rndis_add_hdr (skb
);
1989 req
->buf
= skb
->data
;
1991 req
->complete
= tx_complete
;
1993 /* use zlp framing on tx for strict CDC-Ether conformance,
1994 * though any robust network rx path ignores extra padding.
1995 * and some hardware doesn't like to write zlps.
1998 if (!dev
->zlp
&& (length
% dev
->in_ep
->maxpacket
) == 0)
2001 req
->length
= length
;
2003 #ifdef CONFIG_USB_GADGET_DUALSPEED
2004 /* throttle highspeed IRQ rate back slightly */
2005 req
->no_interrupt
= (dev
->gadget
->speed
== USB_SPEED_HIGH
)
2006 ? ((atomic_read (&dev
->tx_qlen
) % TX_DELAY
) != 0)
2010 retval
= usb_ep_queue (dev
->in_ep
, req
, GFP_ATOMIC
);
2013 DEBUG (dev
, "tx queue err %d\n", retval
);
2016 net
->trans_start
= jiffies
;
2017 atomic_inc (&dev
->tx_qlen
);
2021 #ifdef CONFIG_USB_ETH_RNDIS
2024 dev
->stats
.tx_dropped
++;
2025 dev_kfree_skb_any (skb
);
2026 spin_lock_irqsave (&dev
->lock
, flags
);
2027 if (list_empty (&dev
->tx_reqs
))
2028 netif_start_queue (net
);
2029 list_add (&req
->list
, &dev
->tx_reqs
);
2030 spin_unlock_irqrestore (&dev
->lock
, flags
);
2035 /*-------------------------------------------------------------------------*/
2037 #ifdef CONFIG_USB_ETH_RNDIS
2039 static void rndis_send_media_state (struct eth_dev
*dev
, int connect
)
2045 if (rndis_signal_connect (dev
->rndis_config
))
2048 if (rndis_signal_disconnect (dev
->rndis_config
))
2054 rndis_control_ack_complete (struct usb_ep
*ep
, struct usb_request
*req
)
2056 if (req
->status
|| req
->actual
!= req
->length
)
2057 DEBUG ((struct eth_dev
*) ep
->driver_data
,
2058 "rndis control ack complete --> %d, %d/%d\n",
2059 req
->status
, req
->actual
, req
->length
);
2062 static int rndis_control_ack (struct net_device
*net
)
2064 struct eth_dev
*dev
= netdev_priv(net
);
2066 struct usb_request
*resp
= dev
->stat_req
;
2068 /* in case RNDIS calls this after disconnect */
2070 DEBUG (dev
, "status ENODEV\n");
2074 /* Send RNDIS RESPONSE_AVAILABLE notification;
2075 * USB_CDC_NOTIFY_RESPONSE_AVAILABLE should work too
2078 resp
->complete
= rndis_control_ack_complete
;
2080 *((__le32
*) resp
->buf
) = __constant_cpu_to_le32 (1);
2081 *((__le32
*) resp
->buf
+ 1) = __constant_cpu_to_le32 (0);
2083 length
= usb_ep_queue (dev
->status_ep
, resp
, GFP_ATOMIC
);
2086 rndis_control_ack_complete (dev
->status_ep
, resp
);
2094 static void eth_start (struct eth_dev
*dev
, int gfp_flags
)
2096 DEBUG (dev
, "%s\n", __FUNCTION__
);
2098 /* fill the rx queue */
2099 rx_fill (dev
, gfp_flags
);
2101 /* and open the tx floodgates */
2102 atomic_set (&dev
->tx_qlen
, 0);
2103 netif_wake_queue (dev
->net
);
2104 #ifdef CONFIG_USB_ETH_RNDIS
2106 rndis_set_param_medium (dev
->rndis_config
,
2108 BITRATE(dev
->gadget
)/100);
2109 rndis_send_media_state (dev
, 1);
2114 static int eth_open (struct net_device
*net
)
2116 struct eth_dev
*dev
= netdev_priv(net
);
2118 DEBUG (dev
, "%s\n", __FUNCTION__
);
2119 if (netif_carrier_ok (dev
->net
))
2120 eth_start (dev
, GFP_KERNEL
);
2124 static int eth_stop (struct net_device
*net
)
2126 struct eth_dev
*dev
= netdev_priv(net
);
2128 VDEBUG (dev
, "%s\n", __FUNCTION__
);
2129 netif_stop_queue (net
);
2131 DEBUG (dev
, "stop stats: rx/tx %ld/%ld, errs %ld/%ld\n",
2132 dev
->stats
.rx_packets
, dev
->stats
.tx_packets
,
2133 dev
->stats
.rx_errors
, dev
->stats
.tx_errors
2136 /* ensure there are no more active requests */
2138 usb_ep_disable (dev
->in_ep
);
2139 usb_ep_disable (dev
->out_ep
);
2140 if (netif_carrier_ok (dev
->net
)) {
2141 DEBUG (dev
, "host still using in/out endpoints\n");
2142 // FIXME idiom may leave toggle wrong here
2143 usb_ep_enable (dev
->in_ep
, dev
->in
);
2144 usb_ep_enable (dev
->out_ep
, dev
->out
);
2146 if (dev
->status_ep
) {
2147 usb_ep_disable (dev
->status_ep
);
2148 usb_ep_enable (dev
->status_ep
, dev
->status
);
2152 #ifdef CONFIG_USB_ETH_RNDIS
2154 rndis_set_param_medium (dev
->rndis_config
,
2155 NDIS_MEDIUM_802_3
, 0);
2156 rndis_send_media_state (dev
, 0);
2163 /*-------------------------------------------------------------------------*/
2165 static struct usb_request
*eth_req_alloc (struct usb_ep
*ep
, unsigned size
)
2167 struct usb_request
*req
;
2169 req
= usb_ep_alloc_request (ep
, GFP_KERNEL
);
2173 req
->buf
= kmalloc (size
, GFP_KERNEL
);
2175 usb_ep_free_request (ep
, req
);
2182 eth_req_free (struct usb_ep
*ep
, struct usb_request
*req
)
2185 usb_ep_free_request (ep
, req
);
2190 eth_unbind (struct usb_gadget
*gadget
)
2192 struct eth_dev
*dev
= get_gadget_data (gadget
);
2194 DEBUG (dev
, "unbind\n");
2195 #ifdef CONFIG_USB_ETH_RNDIS
2196 rndis_deregister (dev
->rndis_config
);
2200 /* we've already been disconnected ... no i/o is active */
2202 eth_req_free (gadget
->ep0
, dev
->req
);
2205 if (dev
->stat_req
) {
2206 eth_req_free (dev
->status_ep
, dev
->stat_req
);
2207 dev
->stat_req
= NULL
;
2210 unregister_netdev (dev
->net
);
2211 free_netdev(dev
->net
);
2213 /* assuming we used keventd, it must quiesce too */
2214 flush_scheduled_work ();
2215 set_gadget_data (gadget
, NULL
);
2218 static u8 __init
nibble (unsigned char c
)
2220 if (likely (isdigit (c
)))
2223 if (likely (isxdigit (c
)))
2224 return 10 + c
- 'A';
2228 static void __init
get_ether_addr (const char *str
, u8
*dev_addr
)
2233 for (i
= 0; i
< 6; i
++) {
2236 if((*str
== '.') || (*str
== ':'))
2238 num
= nibble(*str
++) << 4;
2239 num
|= (nibble(*str
++));
2242 if (is_valid_ether_addr (dev_addr
))
2245 random_ether_addr(dev_addr
);
2249 eth_bind (struct usb_gadget
*gadget
)
2251 struct eth_dev
*dev
;
2252 struct net_device
*net
;
2253 u8 cdc
= 1, zlp
= 1, rndis
= 1;
2254 struct usb_ep
*in_ep
, *out_ep
, *status_ep
= NULL
;
2255 int status
= -ENOMEM
;
2257 /* these flags are only ever cleared; compiler take note */
2258 #ifndef DEV_CONFIG_CDC
2261 #ifndef CONFIG_USB_ETH_RNDIS
2265 /* Because most host side USB stacks handle CDC Ethernet, that
2266 * standard protocol is _strongly_ preferred for interop purposes.
2267 * (By everyone except Microsoft.)
2269 if (gadget_is_net2280 (gadget
)) {
2270 device_desc
.bcdDevice
= __constant_cpu_to_le16 (0x0201);
2271 } else if (gadget_is_dummy (gadget
)) {
2272 device_desc
.bcdDevice
= __constant_cpu_to_le16 (0x0202);
2273 } else if (gadget_is_pxa (gadget
)) {
2274 device_desc
.bcdDevice
= __constant_cpu_to_le16 (0x0203);
2275 /* pxa doesn't support altsettings */
2277 } else if (gadget_is_sh(gadget
)) {
2278 device_desc
.bcdDevice
= __constant_cpu_to_le16 (0x0204);
2279 /* sh doesn't support multiple interfaces or configs */
2282 } else if (gadget_is_sa1100 (gadget
)) {
2283 device_desc
.bcdDevice
= __constant_cpu_to_le16 (0x0205);
2284 /* hardware can't write zlps */
2286 /* sa1100 CAN do CDC, without status endpoint ... we use
2287 * non-CDC to be compatible with ARM Linux-2.4 "usb-eth".
2290 } else if (gadget_is_goku (gadget
)) {
2291 device_desc
.bcdDevice
= __constant_cpu_to_le16 (0x0206);
2292 } else if (gadget_is_mq11xx (gadget
)) {
2293 device_desc
.bcdDevice
= __constant_cpu_to_le16 (0x0207);
2294 } else if (gadget_is_omap (gadget
)) {
2295 device_desc
.bcdDevice
= __constant_cpu_to_le16 (0x0208);
2296 } else if (gadget_is_lh7a40x(gadget
)) {
2297 device_desc
.bcdDevice
= __constant_cpu_to_le16 (0x0209);
2298 } else if (gadget_is_n9604(gadget
)) {
2299 device_desc
.bcdDevice
= __constant_cpu_to_le16 (0x0210);
2300 } else if (gadget_is_pxa27x(gadget
)) {
2301 device_desc
.bcdDevice
= __constant_cpu_to_le16 (0x0211);
2302 } else if (gadget_is_s3c2410(gadget
)) {
2303 device_desc
.bcdDevice
= __constant_cpu_to_le16 (0x0212);
2304 } else if (gadget_is_at91(gadget
)) {
2305 device_desc
.bcdDevice
= __constant_cpu_to_le16 (0x0213);
2307 /* can't assume CDC works. don't want to default to
2308 * anything less functional on CDC-capable hardware,
2309 * so we fail in this case.
2311 dev_err (&gadget
->dev
,
2312 "controller '%s' not recognized\n",
2316 snprintf (manufacturer
, sizeof manufacturer
, "%s %s/%s",
2317 system_utsname
.sysname
, system_utsname
.release
,
2320 /* If there's an RNDIS configuration, that's what Windows wants to
2321 * be using ... so use these product IDs here and in the "linux.inf"
2322 * needed to install MSFT drivers. Current Linux kernels will use
2323 * the second configuration if it's CDC Ethernet, and need some help
2324 * to choose the right configuration otherwise.
2327 device_desc
.idVendor
=
2328 __constant_cpu_to_le16(RNDIS_VENDOR_NUM
);
2329 device_desc
.idProduct
=
2330 __constant_cpu_to_le16(RNDIS_PRODUCT_NUM
);
2331 snprintf (product_desc
, sizeof product_desc
,
2332 "RNDIS/%s", driver_desc
);
2334 /* CDC subset ... recognized by Linux since 2.4.10, but Windows
2335 * drivers aren't widely available.
2338 device_desc
.bDeviceClass
= USB_CLASS_VENDOR_SPEC
;
2339 device_desc
.idVendor
=
2340 __constant_cpu_to_le16(SIMPLE_VENDOR_NUM
);
2341 device_desc
.idProduct
=
2342 __constant_cpu_to_le16(SIMPLE_PRODUCT_NUM
);
2345 /* support optional vendor/distro customization */
2348 dev_err (&gadget
->dev
, "idVendor needs idProduct!\n");
2351 device_desc
.idVendor
= cpu_to_le16(idVendor
);
2352 device_desc
.idProduct
= cpu_to_le16(idProduct
);
2354 device_desc
.bcdDevice
= cpu_to_le16(bcdDevice
);
2357 strlcpy (manufacturer
, iManufacturer
, sizeof manufacturer
);
2359 strlcpy (product_desc
, iProduct
, sizeof product_desc
);
2361 /* all we really need is bulk IN/OUT */
2362 usb_ep_autoconfig_reset (gadget
);
2363 in_ep
= usb_ep_autoconfig (gadget
, &fs_source_desc
);
2366 dev_err (&gadget
->dev
,
2367 "can't autoconfigure on %s\n",
2371 EP_IN_NAME
= in_ep
->name
;
2372 in_ep
->driver_data
= in_ep
; /* claim */
2374 out_ep
= usb_ep_autoconfig (gadget
, &fs_sink_desc
);
2377 EP_OUT_NAME
= out_ep
->name
;
2378 out_ep
->driver_data
= out_ep
; /* claim */
2380 #if defined(DEV_CONFIG_CDC) || defined(CONFIG_USB_ETH_RNDIS)
2381 /* CDC Ethernet control interface doesn't require a status endpoint.
2382 * Since some hosts expect one, try to allocate one anyway.
2385 status_ep
= usb_ep_autoconfig (gadget
, &fs_status_desc
);
2387 EP_STATUS_NAME
= status_ep
->name
;
2388 status_ep
->driver_data
= status_ep
; /* claim */
2390 dev_err (&gadget
->dev
,
2391 "can't run RNDIS on %s\n",
2394 #ifdef DEV_CONFIG_CDC
2395 /* pxa25x only does CDC subset; often used with RNDIS */
2397 control_intf
.bNumEndpoints
= 0;
2398 /* FIXME remove endpoint from descriptor list */
2404 /* one config: cdc, else minimal subset */
2406 eth_config
.bNumInterfaces
= 1;
2407 eth_config
.iConfiguration
= STRING_SUBSET
;
2408 fs_subset_descriptors();
2409 hs_subset_descriptors();
2412 /* For now RNDIS is always a second config */
2414 device_desc
.bNumConfigurations
= 2;
2416 #ifdef CONFIG_USB_GADGET_DUALSPEED
2418 dev_qualifier
.bNumConfigurations
= 2;
2420 dev_qualifier
.bDeviceClass
= USB_CLASS_VENDOR_SPEC
;
2422 /* assumes ep0 uses the same value for both speeds ... */
2423 dev_qualifier
.bMaxPacketSize0
= device_desc
.bMaxPacketSize0
;
2425 /* and that all endpoints are dual-speed */
2426 hs_source_desc
.bEndpointAddress
= fs_source_desc
.bEndpointAddress
;
2427 hs_sink_desc
.bEndpointAddress
= fs_sink_desc
.bEndpointAddress
;
2428 #if defined(DEV_CONFIG_CDC) || defined(CONFIG_USB_ETH_RNDIS)
2430 hs_status_desc
.bEndpointAddress
=
2431 fs_status_desc
.bEndpointAddress
;
2433 #endif /* DUALSPEED */
2435 device_desc
.bMaxPacketSize0
= gadget
->ep0
->maxpacket
;
2436 usb_gadget_set_selfpowered (gadget
);
2438 if (gadget
->is_otg
) {
2439 otg_descriptor
.bmAttributes
|= USB_OTG_HNP
,
2440 eth_config
.bmAttributes
|= USB_CONFIG_ATT_WAKEUP
;
2441 eth_config
.bMaxPower
= 4;
2442 #ifdef CONFIG_USB_ETH_RNDIS
2443 rndis_config
.bmAttributes
|= USB_CONFIG_ATT_WAKEUP
;
2444 rndis_config
.bMaxPower
= 4;
2448 net
= alloc_etherdev (sizeof *dev
);
2451 dev
= netdev_priv(net
);
2452 spin_lock_init (&dev
->lock
);
2453 INIT_WORK (&dev
->work
, eth_work
, dev
);
2454 INIT_LIST_HEAD (&dev
->tx_reqs
);
2455 INIT_LIST_HEAD (&dev
->rx_reqs
);
2457 /* network device setup */
2459 SET_MODULE_OWNER (net
);
2460 strcpy (net
->name
, "usb%d");
2465 dev
->out_ep
= out_ep
;
2466 dev
->status_ep
= status_ep
;
2468 /* Module params for these addresses should come from ID proms.
2469 * The host side address is used with CDC and RNDIS, and commonly
2470 * ends up in a persistent config database.
2472 get_ether_addr(dev_addr
, net
->dev_addr
);
2474 get_ether_addr(host_addr
, dev
->host_mac
);
2475 #ifdef DEV_CONFIG_CDC
2476 snprintf (ethaddr
, sizeof ethaddr
, "%02X%02X%02X%02X%02X%02X",
2477 dev
->host_mac
[0], dev
->host_mac
[1],
2478 dev
->host_mac
[2], dev
->host_mac
[3],
2479 dev
->host_mac
[4], dev
->host_mac
[5]);
2484 status
= rndis_init();
2486 dev_err (&gadget
->dev
, "can't init RNDIS, %d\n",
2492 net
->change_mtu
= eth_change_mtu
;
2493 net
->get_stats
= eth_get_stats
;
2494 net
->hard_start_xmit
= eth_start_xmit
;
2495 net
->open
= eth_open
;
2496 net
->stop
= eth_stop
;
2497 // watchdog_timeo, tx_timeout ...
2498 // set_multicast_list
2499 SET_ETHTOOL_OPS(net
, &ops
);
2501 /* preallocate control message data and buffer */
2502 dev
->req
= eth_req_alloc (gadget
->ep0
, USB_BUFSIZ
);
2505 dev
->req
->complete
= eth_setup_complete
;
2507 /* ... and maybe likewise for status transfer */
2508 if (dev
->status_ep
) {
2509 dev
->stat_req
= eth_req_alloc (dev
->status_ep
,
2511 if (!dev
->stat_req
) {
2512 eth_req_free (gadget
->ep0
, dev
->req
);
2517 /* finish hookup to lower layer ... */
2518 dev
->gadget
= gadget
;
2519 set_gadget_data (gadget
, dev
);
2520 gadget
->ep0
->driver_data
= dev
;
2522 /* two kinds of host-initiated state changes:
2523 * - iff DATA transfer is active, carrier is "on"
2524 * - tx queueing enabled if open *and* carrier is "on"
2526 netif_stop_queue (dev
->net
);
2527 netif_carrier_off (dev
->net
);
2529 // SET_NETDEV_DEV (dev->net, &gadget->dev);
2530 status
= register_netdev (dev
->net
);
2534 INFO (dev
, "%s, version: " DRIVER_VERSION
"\n", driver_desc
);
2535 INFO (dev
, "using %s, OUT %s IN %s%s%s\n", gadget
->name
,
2536 EP_OUT_NAME
, EP_IN_NAME
,
2537 EP_STATUS_NAME
? " STATUS " : "",
2538 EP_STATUS_NAME
? EP_STATUS_NAME
: ""
2540 INFO (dev
, "MAC %02x:%02x:%02x:%02x:%02x:%02x\n",
2541 net
->dev_addr
[0], net
->dev_addr
[1],
2542 net
->dev_addr
[2], net
->dev_addr
[3],
2543 net
->dev_addr
[4], net
->dev_addr
[5]);
2546 INFO (dev
, "HOST MAC %02x:%02x:%02x:%02x:%02x:%02x\n",
2547 dev
->host_mac
[0], dev
->host_mac
[1],
2548 dev
->host_mac
[2], dev
->host_mac
[3],
2549 dev
->host_mac
[4], dev
->host_mac
[5]);
2551 #ifdef CONFIG_USB_ETH_RNDIS
2555 /* FIXME RNDIS vendor id == "vendor NIC code" == ? */
2557 dev
->rndis_config
= rndis_register (rndis_control_ack
);
2558 if (dev
->rndis_config
< 0) {
2560 unregister_netdev (dev
->net
);
2565 /* these set up a lot of the OIDs that RNDIS needs */
2566 rndis_set_host_mac (dev
->rndis_config
, dev
->host_mac
);
2567 if (rndis_set_param_dev (dev
->rndis_config
, dev
->net
,
2570 if (rndis_set_param_vendor (dev
->rndis_config
, vendorID
,
2573 if (rndis_set_param_medium (dev
->rndis_config
,
2577 INFO (dev
, "RNDIS ready\n");
2584 dev_dbg(&gadget
->dev
, "register_netdev failed, %d\n", status
);
2586 eth_unbind (gadget
);
2590 /*-------------------------------------------------------------------------*/
2593 eth_suspend (struct usb_gadget
*gadget
)
2595 struct eth_dev
*dev
= get_gadget_data (gadget
);
2597 DEBUG (dev
, "suspend\n");
2602 eth_resume (struct usb_gadget
*gadget
)
2604 struct eth_dev
*dev
= get_gadget_data (gadget
);
2606 DEBUG (dev
, "resume\n");
2610 /*-------------------------------------------------------------------------*/
2612 static struct usb_gadget_driver eth_driver
= {
2613 #ifdef CONFIG_USB_GADGET_DUALSPEED
2614 .speed
= USB_SPEED_HIGH
,
2616 .speed
= USB_SPEED_FULL
,
2618 .function
= (char *) driver_desc
,
2620 .unbind
= eth_unbind
,
2623 .disconnect
= eth_disconnect
,
2625 .suspend
= eth_suspend
,
2626 .resume
= eth_resume
,
2629 .name
= (char *) shortname
,
2636 MODULE_DESCRIPTION (DRIVER_DESC
);
2637 MODULE_AUTHOR ("David Brownell, Benedikt Spanger");
2638 MODULE_LICENSE ("GPL");
2641 static int __init
init (void)
2643 return usb_gadget_register_driver (ð_driver
);
2647 static void __exit
cleanup (void)
2649 usb_gadget_unregister_driver (ð_driver
);
2651 module_exit (cleanup
);