blob: ba442d5ed529bb04a88a41e630477b4a46b32d46 [file] [log] [blame]
Remy Bohmer23cd1382009-07-29 18:18:43 +02001/*
2 * ether.c -- Ethernet gadget driver, with CDC and non-CDC options
3 *
4 * Copyright (C) 2003-2005,2008 David Brownell
5 * Copyright (C) 2003-2004 Robert Schwebel, Benedikt Spranger
6 * Copyright (C) 2008 Nokia Corporation
7 *
Wolfgang Denk1a459662013-07-08 09:37:19 +02008 * SPDX-License-Identifier: GPL-2.0+
Remy Bohmer23cd1382009-07-29 18:18:43 +02009 */
10
11#include <common.h>
12#include <asm/errno.h>
Vitaly Kuzmichevc85d70e2011-02-11 18:18:32 +030013#include <linux/netdevice.h>
Remy Bohmer23cd1382009-07-29 18:18:43 +020014#include <linux/usb/ch9.h>
15#include <linux/usb/cdc.h>
16#include <linux/usb/gadget.h>
17#include <net.h>
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +030018#include <malloc.h>
Remy Bohmer23cd1382009-07-29 18:18:43 +020019#include <linux/ctype.h>
20
21#include "gadget_chips.h"
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +030022#include "rndis.h"
Remy Bohmer23cd1382009-07-29 18:18:43 +020023
Vitaly Kuzmichev8f7aa832010-12-28 16:59:31 +030024#define USB_NET_NAME "usb_ether"
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +040025
Remy Bohmer23cd1382009-07-29 18:18:43 +020026#define atomic_read
27extern struct platform_data brd;
Remy Bohmer23cd1382009-07-29 18:18:43 +020028
29
30unsigned packet_received, packet_sent;
31
Remy Bohmer23cd1382009-07-29 18:18:43 +020032/*
33 * Ethernet gadget driver -- with CDC and non-CDC options
34 * Builds on hardware support for a full duplex link.
35 *
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.
41 *
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.
45 *
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.)
52 *
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".)
60 *
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.
65 */
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 */
72
73#define DRIVER_DESC "Ethernet Gadget"
74/* Based on linux 2.6.27 version */
75#define DRIVER_VERSION "May Day 2005"
76
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +040077static const char shortname[] = "ether";
78static const char driver_desc[] = DRIVER_DESC;
Remy Bohmer23cd1382009-07-29 18:18:43 +020079
80#define RX_EXTRA 20 /* guard against rx overflows */
81
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +030082#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)
86#endif
87
88/* CDC and RNDIS support the same host-chosen outgoing packet filters. */
Remy Bohmer23cd1382009-07-29 18:18:43 +020089#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)
93
94#define USB_CONNECT_TIMEOUT (3 * CONFIG_SYS_HZ)
95
96/*-------------------------------------------------------------------------*/
Vitaly Kuzmichev8b6b66b2011-02-11 18:18:33 +030097
98struct eth_dev {
99 struct usb_gadget *gadget;
100 struct usb_request *req; /* for control responses */
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300101 struct usb_request *stat_req; /* for cdc & rndis status */
Vitaly Kuzmichev8b6b66b2011-02-11 18:18:33 +0300102
103 u8 config;
104 struct usb_ep *in_ep, *out_ep, *status_ep;
105 const struct usb_endpoint_descriptor
106 *in, *out, *status;
107
108 struct usb_request *tx_req, *rx_req;
109
110 struct eth_device *net;
111 struct net_device_stats stats;
112 unsigned int tx_qlen;
113
114 unsigned zlp:1;
115 unsigned cdc:1;
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300116 unsigned rndis:1;
Vitaly Kuzmichev8b6b66b2011-02-11 18:18:33 +0300117 unsigned suspended:1;
118 unsigned network_started:1;
119 u16 cdc_filter;
120 unsigned long todo;
121 int mtu;
122#define WORK_RX_MEMORY 0
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300123 int rndis_config;
Vitaly Kuzmichev8b6b66b2011-02-11 18:18:33 +0300124 u8 host_mac[ETH_ALEN];
125};
126
127/*
128 * This version autoconfigures as much as possible at run-time.
129 *
130 * It also ASSUMES a self-powered device, without remote wakeup,
131 * although remote wakeup support would make sense.
132 */
133
134/*-------------------------------------------------------------------------*/
Remy Bohmer23cd1382009-07-29 18:18:43 +0200135static struct eth_dev l_ethdev;
136static struct eth_device l_netdev;
137static struct usb_gadget_driver eth_driver;
138
139/*-------------------------------------------------------------------------*/
140
141/* "main" config is either CDC, or its simple subset */
142static inline int is_cdc(struct eth_dev *dev)
143{
Lukasz Dalek2bb37882012-10-02 17:04:31 +0200144#if !defined(CONFIG_USB_ETH_SUBSET)
Remy Bohmer23cd1382009-07-29 18:18:43 +0200145 return 1; /* only cdc possible */
Lukasz Dalek2bb37882012-10-02 17:04:31 +0200146#elif !defined(CONFIG_USB_ETH_CDC)
Remy Bohmer23cd1382009-07-29 18:18:43 +0200147 return 0; /* only subset possible */
148#else
149 return dev->cdc; /* depends on what hardware we found */
150#endif
151}
152
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300153/* "secondary" RNDIS config may sometimes be activated */
154static inline int rndis_active(struct eth_dev *dev)
155{
156#ifdef CONFIG_USB_ETH_RNDIS
157 return dev->rndis;
158#else
159 return 0;
160#endif
161}
162
163#define subset_active(dev) (!is_cdc(dev) && !rndis_active(dev))
164#define cdc_active(dev) (is_cdc(dev) && !rndis_active(dev))
Remy Bohmer23cd1382009-07-29 18:18:43 +0200165
166#define DEFAULT_QLEN 2 /* double buffering by default */
167
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)
171
172#ifdef CONFIG_USB_GADGET_DUALSPEED
173#define DEVSPEED USB_SPEED_HIGH
174
Vitaly Kuzmichev2721dbf2010-08-12 16:44:40 +0400175#ifdef CONFIG_USB_ETH_QMULT
176#define qmult CONFIG_USB_ETH_QMULT
177#else
178#define qmult 5
179#endif
180
Remy Bohmer23cd1382009-07-29 18:18:43 +0200181/* for dual-speed hardware, use deeper queues at highspeed */
182#define qlen(gadget) \
183 (DEFAULT_QLEN*((gadget->speed == USB_SPEED_HIGH) ? qmult : 1))
184
185static inline int BITRATE(struct usb_gadget *g)
186{
187 return (g->speed == USB_SPEED_HIGH) ? HS_BPS : FS_BPS;
188}
189
190#else /* full speed (low speed doesn't do bulk) */
191
192#define qmult 1
193
194#define DEVSPEED USB_SPEED_FULL
195
196#define qlen(gadget) DEFAULT_QLEN
197
198static inline int BITRATE(struct usb_gadget *g)
199{
200 return FS_BPS;
201}
202#endif
203
Remy Bohmer23cd1382009-07-29 18:18:43 +0200204/*-------------------------------------------------------------------------*/
205
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400206/*
207 * DO NOT REUSE THESE IDs with a protocol-incompatible driver!! Ever!!
Remy Bohmer23cd1382009-07-29 18:18:43 +0200208 * Instead: allocate your own, using normal USB-IF procedures.
209 */
210
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400211/*
212 * Thanks to NetChip Technologies for donating this product ID.
Remy Bohmer23cd1382009-07-29 18:18:43 +0200213 * It's for devices with only CDC Ethernet configurations.
214 */
215#define CDC_VENDOR_NUM 0x0525 /* NetChip */
216#define CDC_PRODUCT_NUM 0xa4a1 /* Linux-USB Ethernet Gadget */
217
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400218/*
219 * For hardware that can't talk CDC, we use the same vendor ID that
Remy Bohmer23cd1382009-07-29 18:18:43 +0200220 * 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.
224 *
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).
229 */
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300230#define SIMPLE_VENDOR_NUM 0x049f /* Compaq Computer Corp. */
231#define SIMPLE_PRODUCT_NUM 0x505a /* Linux-USB "CDC Subset" Device */
232
233/*
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.
238 */
239#define RNDIS_VENDOR_NUM 0x0525 /* NetChip */
240#define RNDIS_PRODUCT_NUM 0xa4a2 /* Ethernet/RNDIS Gadget */
Remy Bohmer23cd1382009-07-29 18:18:43 +0200241
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400242/*
243 * Some systems will want different product identifers published in the
Remy Bohmer23cd1382009-07-29 18:18:43 +0200244 * device descriptor, either numbers or strings or both. These string
245 * parameters are in UTF-8 (superset of ASCII's 7 bit characters).
246 */
247
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300248/*
249 * Emulating them in eth_bind:
250 * static ushort idVendor;
251 * static ushort idProduct;
252 */
253
Remy Bohmer23cd1382009-07-29 18:18:43 +0200254#if defined(CONFIG_USBNET_MANUFACTURER)
255static char *iManufacturer = CONFIG_USBNET_MANUFACTURER;
256#else
257static char *iManufacturer = "U-boot";
258#endif
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300259
260/* These probably need to be configurable. */
261static ushort bcdDevice;
Remy Bohmer23cd1382009-07-29 18:18:43 +0200262static char *iProduct;
263static char *iSerialNumber;
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300264
Remy Bohmer23cd1382009-07-29 18:18:43 +0200265static char dev_addr[18];
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300266
Remy Bohmer23cd1382009-07-29 18:18:43 +0200267static char host_addr[18];
268
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300269
Remy Bohmer23cd1382009-07-29 18:18:43 +0200270/*-------------------------------------------------------------------------*/
271
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400272/*
273 * USB DRIVER HOOKUP (to the hardware driver, below us), mostly
Remy Bohmer23cd1382009-07-29 18:18:43 +0200274 * ep0 implementation: descriptors, config management, setup().
275 * also optional class-specific notification interrupt transfer.
276 */
277
278/*
279 * DESCRIPTORS ... most are static, but strings and (full) configuration
280 * descriptors are built on demand. For now we do either full CDC, or
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300281 * our simple subset, with RNDIS as an optional second configuration.
282 *
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.
Remy Bohmer23cd1382009-07-29 18:18:43 +0200287 */
288
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
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300294#define STRING_RNDIS_CONTROL 6
Remy Bohmer23cd1382009-07-29 18:18:43 +0200295#define STRING_CDC 7
296#define STRING_SUBSET 8
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300297#define STRING_RNDIS 9
Remy Bohmer23cd1382009-07-29 18:18:43 +0200298#define STRING_SERIALNUMBER 10
299
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300300/* holds our biggest descriptor (or RNDIS response) */
Remy Bohmer23cd1382009-07-29 18:18:43 +0200301#define USB_BUFSIZ 256
302
303/*
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300304 * This device advertises one configuration, eth_config, unless RNDIS
305 * is enabled (rndis_config) on hardware supporting at least two configs.
306 *
307 * NOTE: Controllers like superh_udc should probably be able to use
308 * an RNDIS-only configuration.
Remy Bohmer23cd1382009-07-29 18:18:43 +0200309 *
310 * FIXME define some higher-powered configurations to make it easier
311 * to recharge batteries ...
312 */
313
314#define DEV_CONFIG_VALUE 1 /* cdc or subset */
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300315#define DEV_RNDIS_CONFIG_VALUE 2 /* rndis; optional */
Remy Bohmer23cd1382009-07-29 18:18:43 +0200316
317static struct usb_device_descriptor
318device_desc = {
319 .bLength = sizeof device_desc,
320 .bDescriptorType = USB_DT_DEVICE,
321
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400322 .bcdUSB = __constant_cpu_to_le16(0x0200),
Remy Bohmer23cd1382009-07-29 18:18:43 +0200323
324 .bDeviceClass = USB_CLASS_COMM,
325 .bDeviceSubClass = 0,
326 .bDeviceProtocol = 0,
327
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400328 .idVendor = __constant_cpu_to_le16(CDC_VENDOR_NUM),
329 .idProduct = __constant_cpu_to_le16(CDC_PRODUCT_NUM),
Remy Bohmer23cd1382009-07-29 18:18:43 +0200330 .iManufacturer = STRING_MANUFACTURER,
331 .iProduct = STRING_PRODUCT,
332 .bNumConfigurations = 1,
333};
334
335static struct usb_otg_descriptor
336otg_descriptor = {
337 .bLength = sizeof otg_descriptor,
338 .bDescriptorType = USB_DT_OTG,
339
340 .bmAttributes = USB_OTG_SRP,
341};
342
343static struct usb_config_descriptor
344eth_config = {
345 .bLength = sizeof eth_config,
346 .bDescriptorType = USB_DT_CONFIG,
347
348 /* compute wTotalLength on the fly */
349 .bNumInterfaces = 2,
350 .bConfigurationValue = DEV_CONFIG_VALUE,
351 .iConfiguration = STRING_CDC,
352 .bmAttributes = USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER,
353 .bMaxPower = 1,
354};
355
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300356#ifdef CONFIG_USB_ETH_RNDIS
357static struct usb_config_descriptor
358rndis_config = {
359 .bLength = sizeof rndis_config,
360 .bDescriptorType = USB_DT_CONFIG,
361
362 /* compute wTotalLength on the fly */
363 .bNumInterfaces = 2,
364 .bConfigurationValue = DEV_RNDIS_CONFIG_VALUE,
365 .iConfiguration = STRING_RNDIS,
366 .bmAttributes = USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER,
367 .bMaxPower = 1,
368};
369#endif
370
Remy Bohmer23cd1382009-07-29 18:18:43 +0200371/*
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.
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300376 *
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.
382 *
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.
Remy Bohmer23cd1382009-07-29 18:18:43 +0200388 */
389
Lukasz Dalek2bb37882012-10-02 17:04:31 +0200390#ifdef CONFIG_USB_ETH_CDC
Remy Bohmer23cd1382009-07-29 18:18:43 +0200391static struct usb_interface_descriptor
392control_intf = {
393 .bLength = sizeof control_intf,
394 .bDescriptorType = USB_DT_INTERFACE,
395
396 .bInterfaceNumber = 0,
397 /* status endpoint is optional; this may be patched later */
398 .bNumEndpoints = 1,
399 .bInterfaceClass = USB_CLASS_COMM,
400 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET,
401 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
402 .iInterface = STRING_CONTROL,
403};
404#endif
405
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300406#ifdef CONFIG_USB_ETH_RNDIS
407static const struct usb_interface_descriptor
408rndis_control_intf = {
409 .bLength = sizeof rndis_control_intf,
410 .bDescriptorType = USB_DT_INTERFACE,
411
412 .bInterfaceNumber = 0,
413 .bNumEndpoints = 1,
414 .bInterfaceClass = USB_CLASS_COMM,
415 .bInterfaceSubClass = USB_CDC_SUBCLASS_ACM,
416 .bInterfaceProtocol = USB_CDC_ACM_PROTO_VENDOR,
417 .iInterface = STRING_RNDIS_CONTROL,
418};
419#endif
420
Remy Bohmer23cd1382009-07-29 18:18:43 +0200421static 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,
425
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400426 .bcdCDC = __constant_cpu_to_le16(0x0110),
Remy Bohmer23cd1382009-07-29 18:18:43 +0200427};
428
Lukasz Dalek2bb37882012-10-02 17:04:31 +0200429#if defined(CONFIG_USB_ETH_CDC) || defined(CONFIG_USB_ETH_RNDIS)
Remy Bohmer23cd1382009-07-29 18:18:43 +0200430
431static 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,
435
436 .bMasterInterface0 = 0, /* index of control interface */
437 .bSlaveInterface0 = 1, /* index of DATA interface */
438};
439
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300440#endif /* CDC || RNDIS */
441
442#ifdef CONFIG_USB_ETH_RNDIS
443
444static 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,
448
449 .bmCapabilities = 0x00,
450 .bDataInterface = 0x01,
451};
452
453static 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,
457
458 .bmCapabilities = 0x00,
459};
460
461#endif
Remy Bohmer23cd1382009-07-29 18:18:43 +0200462
Lukasz Dalek2bb37882012-10-02 17:04:31 +0200463#ifndef CONFIG_USB_ETH_CDC
Remy Bohmer23cd1382009-07-29 18:18:43 +0200464
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400465/*
466 * "SAFE" loosely follows CDC WMC MDLM, violating the spec in various
Remy Bohmer23cd1382009-07-29 18:18:43 +0200467 * 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.
469 */
470
471static 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,
475
476 .bcdVersion = __constant_cpu_to_le16(0x0100),
477 .bGUID = {
478 0x5d, 0x34, 0xcf, 0x66, 0x11, 0x18, 0x11, 0xd6,
479 0xa2, 0x1a, 0x00, 0x01, 0x02, 0xca, 0x9a, 0x7f,
480 },
481};
482
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400483/*
484 * since "usb_cdc_mdlm_detail_desc" is a variable length structure, we
Remy Bohmer23cd1382009-07-29 18:18:43 +0200485 * 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.
487 */
488static const u8 mdlm_detail_desc[] = {
489 6,
490 USB_DT_CS_INTERFACE,
491 USB_CDC_MDLM_DETAIL_TYPE,
492
493 0, /* "SAFE" */
494 0, /* network control capabilities (none) */
495 0, /* network data capabilities ("raw" encapsulation) */
496};
497
498#endif
499
Remy Bohmer23cd1382009-07-29 18:18:43 +0200500static const struct usb_cdc_ether_desc ether_desc = {
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400501 .bLength = sizeof(ether_desc),
Remy Bohmer23cd1382009-07-29 18:18:43 +0200502 .bDescriptorType = USB_DT_CS_INTERFACE,
503 .bDescriptorSubType = USB_CDC_ETHERNET_TYPE,
504
505 /* this descriptor actually adds value, surprise! */
506 .iMACAddress = STRING_ETHADDR,
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400507 .bmEthernetStatistics = __constant_cpu_to_le32(0), /* no statistics */
508 .wMaxSegmentSize = __constant_cpu_to_le16(ETH_FRAME_LEN),
509 .wNumberMCFilters = __constant_cpu_to_le16(0),
Remy Bohmer23cd1382009-07-29 18:18:43 +0200510 .bNumberPowerFilters = 0,
511};
512
Lukasz Dalek2bb37882012-10-02 17:04:31 +0200513#if defined(CONFIG_USB_ETH_CDC) || defined(CONFIG_USB_ETH_RNDIS)
Remy Bohmer23cd1382009-07-29 18:18:43 +0200514
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400515/*
516 * include the status endpoint if we can, even where it's optional.
Remy Bohmer23cd1382009-07-29 18:18:43 +0200517 * 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.
520 *
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).
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300525 *
526 * RNDIS requires the status endpoint, since it uses that encapsulation
527 * mechanism for its funky RPC scheme.
Remy Bohmer23cd1382009-07-29 18:18:43 +0200528 */
529
530#define LOG2_STATUS_INTERVAL_MSEC 5 /* 1 << 5 == 32 msec */
531#define STATUS_BYTECOUNT 16 /* 8 byte header + data */
532
533static struct usb_endpoint_descriptor
534fs_status_desc = {
535 .bLength = USB_DT_ENDPOINT_SIZE,
536 .bDescriptorType = USB_DT_ENDPOINT,
537
538 .bEndpointAddress = USB_DIR_IN,
539 .bmAttributes = USB_ENDPOINT_XFER_INT,
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400540 .wMaxPacketSize = __constant_cpu_to_le16(STATUS_BYTECOUNT),
Remy Bohmer23cd1382009-07-29 18:18:43 +0200541 .bInterval = 1 << LOG2_STATUS_INTERVAL_MSEC,
542};
543#endif
544
Lukasz Dalek2bb37882012-10-02 17:04:31 +0200545#ifdef CONFIG_USB_ETH_CDC
Remy Bohmer23cd1382009-07-29 18:18:43 +0200546
547/* the default data interface has no endpoints ... */
548
549static const struct usb_interface_descriptor
550data_nop_intf = {
551 .bLength = sizeof data_nop_intf,
552 .bDescriptorType = USB_DT_INTERFACE,
553
554 .bInterfaceNumber = 1,
555 .bAlternateSetting = 0,
556 .bNumEndpoints = 0,
557 .bInterfaceClass = USB_CLASS_CDC_DATA,
558 .bInterfaceSubClass = 0,
559 .bInterfaceProtocol = 0,
560};
561
562/* ... but the "real" data interface has two bulk endpoints */
563
564static const struct usb_interface_descriptor
565data_intf = {
566 .bLength = sizeof data_intf,
567 .bDescriptorType = USB_DT_INTERFACE,
568
569 .bInterfaceNumber = 1,
570 .bAlternateSetting = 1,
571 .bNumEndpoints = 2,
572 .bInterfaceClass = USB_CLASS_CDC_DATA,
573 .bInterfaceSubClass = 0,
574 .bInterfaceProtocol = 0,
575 .iInterface = STRING_DATA,
576};
577
578#endif
579
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300580#ifdef CONFIG_USB_ETH_RNDIS
581
582/* RNDIS doesn't activate by changing to the "real" altsetting */
583
584static const struct usb_interface_descriptor
585rndis_data_intf = {
586 .bLength = sizeof rndis_data_intf,
587 .bDescriptorType = USB_DT_INTERFACE,
588
589 .bInterfaceNumber = 1,
590 .bAlternateSetting = 0,
591 .bNumEndpoints = 2,
592 .bInterfaceClass = USB_CLASS_CDC_DATA,
593 .bInterfaceSubClass = 0,
594 .bInterfaceProtocol = 0,
595 .iInterface = STRING_DATA,
596};
597
598#endif
599
Lukasz Dalek2bb37882012-10-02 17:04:31 +0200600#ifdef CONFIG_USB_ETH_SUBSET
Remy Bohmer23cd1382009-07-29 18:18:43 +0200601
602/*
603 * "Simple" CDC-subset option is a simple vendor-neutral model that most
604 * full speed controllers can handle: one interface, two bulk endpoints.
605 *
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.
608 */
609
610static const struct usb_interface_descriptor
611subset_data_intf = {
612 .bLength = sizeof subset_data_intf,
613 .bDescriptorType = USB_DT_INTERFACE,
614
615 .bInterfaceNumber = 0,
616 .bAlternateSetting = 0,
617 .bNumEndpoints = 2,
618 .bInterfaceClass = USB_CLASS_COMM,
619 .bInterfaceSubClass = USB_CDC_SUBCLASS_MDLM,
620 .bInterfaceProtocol = 0,
621 .iInterface = STRING_DATA,
622};
623
624#endif /* SUBSET */
625
Remy Bohmer23cd1382009-07-29 18:18:43 +0200626static struct usb_endpoint_descriptor
627fs_source_desc = {
628 .bLength = USB_DT_ENDPOINT_SIZE,
629 .bDescriptorType = USB_DT_ENDPOINT,
630
631 .bEndpointAddress = USB_DIR_IN,
632 .bmAttributes = USB_ENDPOINT_XFER_BULK,
Troy Kisky43880ce2013-09-25 18:41:04 -0700633 .wMaxPacketSize = __constant_cpu_to_le16(64),
Remy Bohmer23cd1382009-07-29 18:18:43 +0200634};
635
636static struct usb_endpoint_descriptor
637fs_sink_desc = {
638 .bLength = USB_DT_ENDPOINT_SIZE,
639 .bDescriptorType = USB_DT_ENDPOINT,
640
641 .bEndpointAddress = USB_DIR_OUT,
642 .bmAttributes = USB_ENDPOINT_XFER_BULK,
Troy Kisky43880ce2013-09-25 18:41:04 -0700643 .wMaxPacketSize = __constant_cpu_to_le16(64),
Remy Bohmer23cd1382009-07-29 18:18:43 +0200644};
645
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400646static const struct usb_descriptor_header *fs_eth_function[11] = {
Remy Bohmer23cd1382009-07-29 18:18:43 +0200647 (struct usb_descriptor_header *) &otg_descriptor,
Lukasz Dalek2bb37882012-10-02 17:04:31 +0200648#ifdef CONFIG_USB_ETH_CDC
Remy Bohmer23cd1382009-07-29 18:18:43 +0200649 /* "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 *) &ether_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,
661 NULL,
Lukasz Dalek2bb37882012-10-02 17:04:31 +0200662#endif /* CONFIG_USB_ETH_CDC */
Remy Bohmer23cd1382009-07-29 18:18:43 +0200663};
664
665static inline void fs_subset_descriptors(void)
666{
Lukasz Dalek2bb37882012-10-02 17:04:31 +0200667#ifdef CONFIG_USB_ETH_SUBSET
Remy Bohmer23cd1382009-07-29 18:18:43 +0200668 /* 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 *) &ether_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;
677#else
678 fs_eth_function[1] = NULL;
679#endif
680}
681
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300682#ifdef CONFIG_USB_ETH_RNDIS
683static 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,
696 NULL,
697};
698#endif
699
Remy Bohmer23cd1382009-07-29 18:18:43 +0200700/*
701 * usb 2.0 devices need to expose both high speed and full speed
702 * descriptors, unless they only run at full speed.
703 */
704
Lukasz Dalek2bb37882012-10-02 17:04:31 +0200705#if defined(CONFIG_USB_ETH_CDC) || defined(CONFIG_USB_ETH_RNDIS)
Remy Bohmer23cd1382009-07-29 18:18:43 +0200706static struct usb_endpoint_descriptor
707hs_status_desc = {
708 .bLength = USB_DT_ENDPOINT_SIZE,
709 .bDescriptorType = USB_DT_ENDPOINT,
710
711 .bmAttributes = USB_ENDPOINT_XFER_INT,
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400712 .wMaxPacketSize = __constant_cpu_to_le16(STATUS_BYTECOUNT),
Remy Bohmer23cd1382009-07-29 18:18:43 +0200713 .bInterval = LOG2_STATUS_INTERVAL_MSEC + 4,
714};
Lukasz Dalek2bb37882012-10-02 17:04:31 +0200715#endif /* CONFIG_USB_ETH_CDC */
Remy Bohmer23cd1382009-07-29 18:18:43 +0200716
717static struct usb_endpoint_descriptor
718hs_source_desc = {
719 .bLength = USB_DT_ENDPOINT_SIZE,
720 .bDescriptorType = USB_DT_ENDPOINT,
721
722 .bmAttributes = USB_ENDPOINT_XFER_BULK,
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400723 .wMaxPacketSize = __constant_cpu_to_le16(512),
Remy Bohmer23cd1382009-07-29 18:18:43 +0200724};
725
726static struct usb_endpoint_descriptor
727hs_sink_desc = {
728 .bLength = USB_DT_ENDPOINT_SIZE,
729 .bDescriptorType = USB_DT_ENDPOINT,
730
731 .bmAttributes = USB_ENDPOINT_XFER_BULK,
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400732 .wMaxPacketSize = __constant_cpu_to_le16(512),
Remy Bohmer23cd1382009-07-29 18:18:43 +0200733};
734
735static struct usb_qualifier_descriptor
736dev_qualifier = {
737 .bLength = sizeof dev_qualifier,
738 .bDescriptorType = USB_DT_DEVICE_QUALIFIER,
739
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400740 .bcdUSB = __constant_cpu_to_le16(0x0200),
Remy Bohmer23cd1382009-07-29 18:18:43 +0200741 .bDeviceClass = USB_CLASS_COMM,
742
743 .bNumConfigurations = 1,
744};
745
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400746static const struct usb_descriptor_header *hs_eth_function[11] = {
Remy Bohmer23cd1382009-07-29 18:18:43 +0200747 (struct usb_descriptor_header *) &otg_descriptor,
Lukasz Dalek2bb37882012-10-02 17:04:31 +0200748#ifdef CONFIG_USB_ETH_CDC
Remy Bohmer23cd1382009-07-29 18:18:43 +0200749 /* "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 *) &ether_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,
761 NULL,
Lukasz Dalek2bb37882012-10-02 17:04:31 +0200762#endif /* CONFIG_USB_ETH_CDC */
Remy Bohmer23cd1382009-07-29 18:18:43 +0200763};
764
765static inline void hs_subset_descriptors(void)
766{
Lukasz Dalek2bb37882012-10-02 17:04:31 +0200767#ifdef CONFIG_USB_ETH_SUBSET
Remy Bohmer23cd1382009-07-29 18:18:43 +0200768 /* 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 *) &ether_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;
777#else
778 hs_eth_function[1] = NULL;
779#endif
780}
781
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300782#ifdef CONFIG_USB_ETH_RNDIS
783static 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,
796 NULL,
797};
798#endif
799
800
Remy Bohmer23cd1382009-07-29 18:18:43 +0200801/* maxpacket and other transfer characteristics vary by speed. */
802static inline struct usb_endpoint_descriptor *
803ep_desc(struct usb_gadget *g, struct usb_endpoint_descriptor *hs,
804 struct usb_endpoint_descriptor *fs)
805{
806 if (gadget_is_dualspeed(g) && g->speed == USB_SPEED_HIGH)
807 return hs;
808 return fs;
809}
810
Remy Bohmer23cd1382009-07-29 18:18:43 +0200811/*-------------------------------------------------------------------------*/
812
813/* descriptors that are built on-demand */
814
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400815static char manufacturer[50];
816static char product_desc[40] = DRIVER_DESC;
817static char serial_number[20];
Remy Bohmer23cd1382009-07-29 18:18:43 +0200818
819/* address that the host will use ... usually assigned at random */
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400820static char ethaddr[2 * ETH_ALEN + 1];
Remy Bohmer23cd1382009-07-29 18:18:43 +0200821
822/* static strings, in UTF-8 */
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400823static struct usb_string strings[] = {
Remy Bohmer23cd1382009-07-29 18:18:43 +0200824 { STRING_MANUFACTURER, manufacturer, },
825 { STRING_PRODUCT, product_desc, },
826 { STRING_SERIALNUMBER, serial_number, },
827 { STRING_DATA, "Ethernet Data", },
828 { STRING_ETHADDR, ethaddr, },
Lukasz Dalek2bb37882012-10-02 17:04:31 +0200829#ifdef CONFIG_USB_ETH_CDC
Remy Bohmer23cd1382009-07-29 18:18:43 +0200830 { STRING_CDC, "CDC Ethernet", },
831 { STRING_CONTROL, "CDC Communications Control", },
832#endif
Lukasz Dalek2bb37882012-10-02 17:04:31 +0200833#ifdef CONFIG_USB_ETH_SUBSET
Remy Bohmer23cd1382009-07-29 18:18:43 +0200834 { STRING_SUBSET, "CDC Ethernet Subset", },
835#endif
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300836#ifdef CONFIG_USB_ETH_RNDIS
837 { STRING_RNDIS, "RNDIS", },
838 { STRING_RNDIS_CONTROL, "RNDIS Communications Control", },
839#endif
Remy Bohmer23cd1382009-07-29 18:18:43 +0200840 { } /* end of list */
841};
842
843static struct usb_gadget_strings stringtab = {
844 .language = 0x0409, /* en-us */
845 .strings = strings,
846};
847
Remy Bohmer23cd1382009-07-29 18:18:43 +0200848/*============================================================================*/
Joel Fernandes52907592013-09-04 18:55:14 -0500849DEFINE_CACHE_ALIGN_BUFFER(u8, control_req, USB_BUFSIZ);
850
Lukasz Dalek2bb37882012-10-02 17:04:31 +0200851#if defined(CONFIG_USB_ETH_CDC) || defined(CONFIG_USB_ETH_RNDIS)
Joel Fernandes52907592013-09-04 18:55:14 -0500852DEFINE_CACHE_ALIGN_BUFFER(u8, status_req, STATUS_BYTECOUNT);
Lukasz Dalek563aed22012-10-02 17:04:29 +0200853#endif
Remy Bohmer23cd1382009-07-29 18:18:43 +0200854
Remy Bohmer23cd1382009-07-29 18:18:43 +0200855/*============================================================================*/
856
857/*
858 * one config, two interfaces: control, data.
859 * complications: class descriptors, and an altsetting.
860 */
861static int
862config_buf(struct usb_gadget *g, u8 *buf, u8 type, unsigned index, int is_otg)
863{
864 int len;
865 const struct usb_config_descriptor *config;
866 const struct usb_descriptor_header **function;
867 int hs = 0;
868
869 if (gadget_is_dualspeed(g)) {
870 hs = (g->speed == USB_SPEED_HIGH);
871 if (type == USB_DT_OTHER_SPEED_CONFIG)
872 hs = !hs;
873 }
874#define which_fn(t) (hs ? hs_ ## t ## _function : fs_ ## t ## _function)
875
876 if (index >= device_desc.bNumConfigurations)
877 return -EINVAL;
878
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300879#ifdef CONFIG_USB_ETH_RNDIS
880 /*
881 * list the RNDIS config first, to make Microsoft's drivers
882 * happy. DOCSIS 1.0 needs this too.
883 */
884 if (device_desc.bNumConfigurations == 2 && index == 0) {
885 config = &rndis_config;
886 function = which_fn(rndis);
887 } else
888#endif
889 {
890 config = &eth_config;
891 function = which_fn(eth);
892 }
Remy Bohmer23cd1382009-07-29 18:18:43 +0200893
894 /* for now, don't advertise srp-only devices */
895 if (!is_otg)
896 function++;
897
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400898 len = usb_gadget_config_buf(config, buf, USB_BUFSIZ, function);
Remy Bohmer23cd1382009-07-29 18:18:43 +0200899 if (len < 0)
900 return len;
901 ((struct usb_config_descriptor *) buf)->bDescriptorType = type;
902 return len;
903}
904
905/*-------------------------------------------------------------------------*/
906
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300907static void eth_start(struct eth_dev *dev, gfp_t gfp_flags);
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400908static int alloc_requests(struct eth_dev *dev, unsigned n, gfp_t gfp_flags);
Remy Bohmer23cd1382009-07-29 18:18:43 +0200909
910static int
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400911set_ether_config(struct eth_dev *dev, gfp_t gfp_flags)
Remy Bohmer23cd1382009-07-29 18:18:43 +0200912{
913 int result = 0;
914 struct usb_gadget *gadget = dev->gadget;
915
Lukasz Dalek2bb37882012-10-02 17:04:31 +0200916#if defined(CONFIG_USB_ETH_CDC) || defined(CONFIG_USB_ETH_RNDIS)
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300917 /* status endpoint used for RNDIS and (optionally) CDC */
Remy Bohmer23cd1382009-07-29 18:18:43 +0200918 if (!subset_active(dev) && dev->status_ep) {
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400919 dev->status = ep_desc(gadget, &hs_status_desc,
Remy Bohmer23cd1382009-07-29 18:18:43 +0200920 &fs_status_desc);
921 dev->status_ep->driver_data = dev;
922
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400923 result = usb_ep_enable(dev->status_ep, dev->status);
Remy Bohmer23cd1382009-07-29 18:18:43 +0200924 if (result != 0) {
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +0400925 debug("enable %s --> %d\n",
Remy Bohmer23cd1382009-07-29 18:18:43 +0200926 dev->status_ep->name, result);
927 goto done;
928 }
929 }
930#endif
931
932 dev->in = ep_desc(gadget, &hs_source_desc, &fs_source_desc);
933 dev->in_ep->driver_data = dev;
934
935 dev->out = ep_desc(gadget, &hs_sink_desc, &fs_sink_desc);
936 dev->out_ep->driver_data = dev;
937
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400938 /*
939 * With CDC, the host isn't allowed to use these two data
Remy Bohmer23cd1382009-07-29 18:18:43 +0200940 * endpoints in the default altsetting for the interface.
941 * so we don't activate them yet. Reset from SET_INTERFACE.
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300942 *
943 * Strictly speaking RNDIS should work the same: activation is
944 * a side effect of setting a packet filter. Deactivation is
945 * from REMOTE_NDIS_HALT_MSG, reset from REMOTE_NDIS_RESET_MSG.
Remy Bohmer23cd1382009-07-29 18:18:43 +0200946 */
947 if (!cdc_active(dev)) {
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400948 result = usb_ep_enable(dev->in_ep, dev->in);
Remy Bohmer23cd1382009-07-29 18:18:43 +0200949 if (result != 0) {
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +0400950 debug("enable %s --> %d\n",
Remy Bohmer23cd1382009-07-29 18:18:43 +0200951 dev->in_ep->name, result);
952 goto done;
953 }
954
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400955 result = usb_ep_enable(dev->out_ep, dev->out);
Remy Bohmer23cd1382009-07-29 18:18:43 +0200956 if (result != 0) {
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +0400957 debug("enable %s --> %d\n",
Remy Bohmer23cd1382009-07-29 18:18:43 +0200958 dev->out_ep->name, result);
959 goto done;
960 }
961 }
962
963done:
964 if (result == 0)
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400965 result = alloc_requests(dev, qlen(gadget), gfp_flags);
Remy Bohmer23cd1382009-07-29 18:18:43 +0200966
967 /* on error, disable any endpoints */
968 if (result < 0) {
Vitaly Kuzmichevd5292c12010-08-13 17:02:29 +0400969 if (!subset_active(dev) && dev->status_ep)
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400970 (void) usb_ep_disable(dev->status_ep);
Remy Bohmer23cd1382009-07-29 18:18:43 +0200971 dev->status = NULL;
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400972 (void) usb_ep_disable(dev->in_ep);
973 (void) usb_ep_disable(dev->out_ep);
Remy Bohmer23cd1382009-07-29 18:18:43 +0200974 dev->in = NULL;
975 dev->out = NULL;
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300976 } else if (!cdc_active(dev)) {
977 /*
978 * activate non-CDC configs right away
979 * this isn't strictly according to the RNDIS spec
980 */
981 eth_start(dev, GFP_ATOMIC);
Remy Bohmer23cd1382009-07-29 18:18:43 +0200982 }
983
984 /* caller is responsible for cleanup on error */
985 return result;
986}
987
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400988static void eth_reset_config(struct eth_dev *dev)
Remy Bohmer23cd1382009-07-29 18:18:43 +0200989{
990 if (dev->config == 0)
991 return;
992
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +0400993 debug("%s\n", __func__);
994
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +0300995 rndis_uninit(dev->rndis_config);
996
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +0400997 /*
998 * disable endpoints, forcing (synchronous) completion of
Remy Bohmer23cd1382009-07-29 18:18:43 +0200999 * pending i/o. then free the requests.
1000 */
1001
1002 if (dev->in) {
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001003 usb_ep_disable(dev->in_ep);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001004 if (dev->tx_req) {
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001005 usb_ep_free_request(dev->in_ep, dev->tx_req);
1006 dev->tx_req = NULL;
Remy Bohmer23cd1382009-07-29 18:18:43 +02001007 }
1008 }
1009 if (dev->out) {
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001010 usb_ep_disable(dev->out_ep);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001011 if (dev->rx_req) {
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001012 usb_ep_free_request(dev->out_ep, dev->rx_req);
1013 dev->rx_req = NULL;
Remy Bohmer23cd1382009-07-29 18:18:43 +02001014 }
1015 }
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001016 if (dev->status)
1017 usb_ep_disable(dev->status_ep);
1018
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03001019 dev->rndis = 0;
Remy Bohmer23cd1382009-07-29 18:18:43 +02001020 dev->cdc_filter = 0;
1021 dev->config = 0;
1022}
1023
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001024/*
1025 * change our operational config. must agree with the code
Remy Bohmer23cd1382009-07-29 18:18:43 +02001026 * that returns config descriptors, and altsetting code.
1027 */
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001028static int eth_set_config(struct eth_dev *dev, unsigned number,
1029 gfp_t gfp_flags)
Remy Bohmer23cd1382009-07-29 18:18:43 +02001030{
1031 int result = 0;
1032 struct usb_gadget *gadget = dev->gadget;
1033
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001034 if (gadget_is_sa1100(gadget)
Remy Bohmer23cd1382009-07-29 18:18:43 +02001035 && dev->config
1036 && dev->tx_qlen != 0) {
1037 /* tx fifo is full, but we can't clear it...*/
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +04001038 error("can't change configurations");
Remy Bohmer23cd1382009-07-29 18:18:43 +02001039 return -ESPIPE;
1040 }
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001041 eth_reset_config(dev);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001042
1043 switch (number) {
1044 case DEV_CONFIG_VALUE:
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001045 result = set_ether_config(dev, gfp_flags);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001046 break;
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03001047#ifdef CONFIG_USB_ETH_RNDIS
1048 case DEV_RNDIS_CONFIG_VALUE:
1049 dev->rndis = 1;
1050 result = set_ether_config(dev, gfp_flags);
1051 break;
1052#endif
Remy Bohmer23cd1382009-07-29 18:18:43 +02001053 default:
1054 result = -EINVAL;
1055 /* FALL THROUGH */
1056 case 0:
1057 break;
1058 }
1059
1060 if (result) {
1061 if (number)
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001062 eth_reset_config(dev);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001063 usb_gadget_vbus_draw(dev->gadget,
1064 gadget_is_otg(dev->gadget) ? 8 : 100);
1065 } else {
1066 char *speed;
1067 unsigned power;
1068
1069 power = 2 * eth_config.bMaxPower;
1070 usb_gadget_vbus_draw(dev->gadget, power);
1071
1072 switch (gadget->speed) {
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001073 case USB_SPEED_FULL:
1074 speed = "full"; break;
Remy Bohmer23cd1382009-07-29 18:18:43 +02001075#ifdef CONFIG_USB_GADGET_DUALSPEED
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001076 case USB_SPEED_HIGH:
1077 speed = "high"; break;
Remy Bohmer23cd1382009-07-29 18:18:43 +02001078#endif
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001079 default:
1080 speed = "?"; break;
Remy Bohmer23cd1382009-07-29 18:18:43 +02001081 }
1082
1083 dev->config = number;
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +04001084 printf("%s speed config #%d: %d mA, %s, using %s\n",
Remy Bohmer23cd1382009-07-29 18:18:43 +02001085 speed, number, power, driver_desc,
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03001086 rndis_active(dev)
1087 ? "RNDIS"
1088 : (cdc_active(dev)
1089 ? "CDC Ethernet"
Remy Bohmer23cd1382009-07-29 18:18:43 +02001090 : "CDC Ethernet Subset"));
1091 }
1092 return result;
1093}
1094
1095/*-------------------------------------------------------------------------*/
1096
Lukasz Dalek2bb37882012-10-02 17:04:31 +02001097#ifdef CONFIG_USB_ETH_CDC
Remy Bohmer23cd1382009-07-29 18:18:43 +02001098
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001099/*
1100 * The interrupt endpoint is used in CDC networking models (Ethernet, ATM)
Remy Bohmer23cd1382009-07-29 18:18:43 +02001101 * only to notify the host about link status changes (which we support) or
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03001102 * report completion of some encapsulated command (as used in RNDIS). Since
Remy Bohmer23cd1382009-07-29 18:18:43 +02001103 * we want this CDC Ethernet code to be vendor-neutral, we don't use that
1104 * command mechanism; and only one status request is ever queued.
1105 */
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001106static void eth_status_complete(struct usb_ep *ep, struct usb_request *req)
Remy Bohmer23cd1382009-07-29 18:18:43 +02001107{
1108 struct usb_cdc_notification *event = req->buf;
1109 int value = req->status;
1110 struct eth_dev *dev = ep->driver_data;
1111
1112 /* issue the second notification if host reads the first */
1113 if (event->bNotificationType == USB_CDC_NOTIFY_NETWORK_CONNECTION
1114 && value == 0) {
1115 __le32 *data = req->buf + sizeof *event;
1116
1117 event->bmRequestType = 0xA1;
1118 event->bNotificationType = USB_CDC_NOTIFY_SPEED_CHANGE;
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001119 event->wValue = __constant_cpu_to_le16(0);
1120 event->wIndex = __constant_cpu_to_le16(1);
1121 event->wLength = __constant_cpu_to_le16(8);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001122
1123 /* SPEED_CHANGE data is up/down speeds in bits/sec */
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001124 data[0] = data[1] = cpu_to_le32(BITRATE(dev->gadget));
Remy Bohmer23cd1382009-07-29 18:18:43 +02001125
1126 req->length = STATUS_BYTECOUNT;
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001127 value = usb_ep_queue(ep, req, GFP_ATOMIC);
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +04001128 debug("send SPEED_CHANGE --> %d\n", value);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001129 if (value == 0)
1130 return;
1131 } else if (value != -ECONNRESET) {
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +04001132 debug("event %02x --> %d\n",
Remy Bohmer23cd1382009-07-29 18:18:43 +02001133 event->bNotificationType, value);
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001134 if (event->bNotificationType ==
1135 USB_CDC_NOTIFY_SPEED_CHANGE) {
1136 l_ethdev.network_started = 1;
Remy Bohmer23cd1382009-07-29 18:18:43 +02001137 printf("USB network up!\n");
1138 }
1139 }
1140 req->context = NULL;
1141}
1142
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001143static void issue_start_status(struct eth_dev *dev)
Remy Bohmer23cd1382009-07-29 18:18:43 +02001144{
1145 struct usb_request *req = dev->stat_req;
1146 struct usb_cdc_notification *event;
1147 int value;
1148
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001149 /*
1150 * flush old status
Remy Bohmer23cd1382009-07-29 18:18:43 +02001151 *
1152 * FIXME ugly idiom, maybe we'd be better with just
1153 * a "cancel the whole queue" primitive since any
1154 * unlink-one primitive has way too many error modes.
1155 * here, we "know" toggle is already clear...
1156 *
1157 * FIXME iff req->context != null just dequeue it
1158 */
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001159 usb_ep_disable(dev->status_ep);
1160 usb_ep_enable(dev->status_ep, dev->status);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001161
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001162 /*
1163 * 3.8.1 says to issue first NETWORK_CONNECTION, then
Remy Bohmer23cd1382009-07-29 18:18:43 +02001164 * a SPEED_CHANGE. could be useful in some configs.
1165 */
1166 event = req->buf;
1167 event->bmRequestType = 0xA1;
1168 event->bNotificationType = USB_CDC_NOTIFY_NETWORK_CONNECTION;
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001169 event->wValue = __constant_cpu_to_le16(1); /* connected */
1170 event->wIndex = __constant_cpu_to_le16(1);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001171 event->wLength = 0;
1172
1173 req->length = sizeof *event;
1174 req->complete = eth_status_complete;
1175 req->context = dev;
1176
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001177 value = usb_ep_queue(dev->status_ep, req, GFP_ATOMIC);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001178 if (value < 0)
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +04001179 debug("status buf queue --> %d\n", value);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001180}
1181
1182#endif
1183
1184/*-------------------------------------------------------------------------*/
1185
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001186static void eth_setup_complete(struct usb_ep *ep, struct usb_request *req)
Remy Bohmer23cd1382009-07-29 18:18:43 +02001187{
1188 if (req->status || req->actual != req->length)
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +04001189 debug("setup complete --> %d, %d/%d\n",
Remy Bohmer23cd1382009-07-29 18:18:43 +02001190 req->status, req->actual, req->length);
1191}
1192
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03001193#ifdef CONFIG_USB_ETH_RNDIS
1194
1195static void rndis_response_complete(struct usb_ep *ep, struct usb_request *req)
1196{
1197 if (req->status || req->actual != req->length)
1198 debug("rndis response complete --> %d, %d/%d\n",
1199 req->status, req->actual, req->length);
1200
1201 /* done sending after USB_CDC_GET_ENCAPSULATED_RESPONSE */
1202}
1203
1204static void rndis_command_complete(struct usb_ep *ep, struct usb_request *req)
1205{
1206 struct eth_dev *dev = ep->driver_data;
1207 int status;
1208
1209 /* received RNDIS command from USB_CDC_SEND_ENCAPSULATED_COMMAND */
1210 status = rndis_msg_parser(dev->rndis_config, (u8 *) req->buf);
1211 if (status < 0)
1212 error("%s: rndis parse error %d", __func__, status);
1213}
1214
1215#endif /* RNDIS */
1216
Remy Bohmer23cd1382009-07-29 18:18:43 +02001217/*
1218 * The setup() callback implements all the ep0 functionality that's not
1219 * handled lower down. CDC has a number of less-common features:
1220 *
1221 * - two interfaces: control, and ethernet data
1222 * - Ethernet data interface has two altsettings: default, and active
1223 * - class-specific descriptors for the control interface
1224 * - class-specific control requests
1225 */
1226static int
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001227eth_setup(struct usb_gadget *gadget, const struct usb_ctrlrequest *ctrl)
Remy Bohmer23cd1382009-07-29 18:18:43 +02001228{
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001229 struct eth_dev *dev = get_gadget_data(gadget);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001230 struct usb_request *req = dev->req;
1231 int value = -EOPNOTSUPP;
1232 u16 wIndex = le16_to_cpu(ctrl->wIndex);
1233 u16 wValue = le16_to_cpu(ctrl->wValue);
1234 u16 wLength = le16_to_cpu(ctrl->wLength);
1235
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001236 /*
1237 * descriptors just go into the pre-allocated ep0 buffer,
Remy Bohmer23cd1382009-07-29 18:18:43 +02001238 * while config change events may enable network traffic.
1239 */
1240
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +04001241 debug("%s\n", __func__);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001242
1243 req->complete = eth_setup_complete;
1244 switch (ctrl->bRequest) {
1245
1246 case USB_REQ_GET_DESCRIPTOR:
1247 if (ctrl->bRequestType != USB_DIR_IN)
1248 break;
1249 switch (wValue >> 8) {
1250
1251 case USB_DT_DEVICE:
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001252 value = min(wLength, (u16) sizeof device_desc);
1253 memcpy(req->buf, &device_desc, value);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001254 break;
1255 case USB_DT_DEVICE_QUALIFIER:
1256 if (!gadget_is_dualspeed(gadget))
1257 break;
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001258 value = min(wLength, (u16) sizeof dev_qualifier);
1259 memcpy(req->buf, &dev_qualifier, value);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001260 break;
1261
1262 case USB_DT_OTHER_SPEED_CONFIG:
1263 if (!gadget_is_dualspeed(gadget))
1264 break;
1265 /* FALLTHROUGH */
1266 case USB_DT_CONFIG:
1267 value = config_buf(gadget, req->buf,
1268 wValue >> 8,
1269 wValue & 0xff,
1270 gadget_is_otg(gadget));
1271 if (value >= 0)
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001272 value = min(wLength, (u16) value);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001273 break;
1274
1275 case USB_DT_STRING:
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001276 value = usb_gadget_get_string(&stringtab,
Remy Bohmer23cd1382009-07-29 18:18:43 +02001277 wValue & 0xff, req->buf);
1278
1279 if (value >= 0)
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001280 value = min(wLength, (u16) value);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001281
1282 break;
1283 }
1284 break;
1285
1286 case USB_REQ_SET_CONFIGURATION:
1287 if (ctrl->bRequestType != 0)
1288 break;
1289 if (gadget->a_hnp_support)
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +04001290 debug("HNP available\n");
Remy Bohmer23cd1382009-07-29 18:18:43 +02001291 else if (gadget->a_alt_hnp_support)
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +04001292 debug("HNP needs a different root port\n");
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001293 value = eth_set_config(dev, wValue, GFP_ATOMIC);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001294 break;
1295 case USB_REQ_GET_CONFIGURATION:
1296 if (ctrl->bRequestType != USB_DIR_IN)
1297 break;
1298 *(u8 *)req->buf = dev->config;
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001299 value = min(wLength, (u16) 1);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001300 break;
1301
1302 case USB_REQ_SET_INTERFACE:
1303 if (ctrl->bRequestType != USB_RECIP_INTERFACE
1304 || !dev->config
1305 || wIndex > 1)
1306 break;
1307 if (!cdc_active(dev) && wIndex != 0)
1308 break;
1309
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001310 /*
1311 * PXA hardware partially handles SET_INTERFACE;
Remy Bohmer23cd1382009-07-29 18:18:43 +02001312 * we need to kluge around that interference.
1313 */
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001314 if (gadget_is_pxa(gadget)) {
1315 value = eth_set_config(dev, DEV_CONFIG_VALUE,
Remy Bohmer23cd1382009-07-29 18:18:43 +02001316 GFP_ATOMIC);
Lukasz Dalek563aed22012-10-02 17:04:29 +02001317 /*
1318 * PXA25x driver use non-CDC ethernet gadget.
1319 * But only _CDC and _RNDIS code can signalize
1320 * that network is working. So we signalize it
1321 * here.
1322 */
1323 l_ethdev.network_started = 1;
1324 debug("USB network up!\n");
Remy Bohmer23cd1382009-07-29 18:18:43 +02001325 goto done_set_intf;
1326 }
1327
Lukasz Dalek2bb37882012-10-02 17:04:31 +02001328#ifdef CONFIG_USB_ETH_CDC
Remy Bohmer23cd1382009-07-29 18:18:43 +02001329 switch (wIndex) {
1330 case 0: /* control/master intf */
1331 if (wValue != 0)
1332 break;
1333 if (dev->status) {
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001334 usb_ep_disable(dev->status_ep);
1335 usb_ep_enable(dev->status_ep, dev->status);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001336 }
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03001337
Remy Bohmer23cd1382009-07-29 18:18:43 +02001338 value = 0;
1339 break;
1340 case 1: /* data intf */
1341 if (wValue > 1)
1342 break;
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001343 usb_ep_disable(dev->in_ep);
1344 usb_ep_disable(dev->out_ep);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001345
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001346 /*
1347 * CDC requires the data transfers not be done from
Remy Bohmer23cd1382009-07-29 18:18:43 +02001348 * the default interface setting ... also, setting
1349 * the non-default interface resets filters etc.
1350 */
1351 if (wValue == 1) {
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001352 if (!cdc_active(dev))
Remy Bohmer23cd1382009-07-29 18:18:43 +02001353 break;
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001354 usb_ep_enable(dev->in_ep, dev->in);
1355 usb_ep_enable(dev->out_ep, dev->out);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001356 dev->cdc_filter = DEFAULT_FILTER;
1357 if (dev->status)
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001358 issue_start_status(dev);
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03001359 eth_start(dev, GFP_ATOMIC);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001360 }
Remy Bohmer23cd1382009-07-29 18:18:43 +02001361 value = 0;
1362 break;
1363 }
1364#else
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001365 /*
1366 * FIXME this is wrong, as is the assumption that
Remy Bohmer23cd1382009-07-29 18:18:43 +02001367 * all non-PXA hardware talks real CDC ...
1368 */
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +04001369 debug("set_interface ignored!\n");
Lukasz Dalek2bb37882012-10-02 17:04:31 +02001370#endif /* CONFIG_USB_ETH_CDC */
Remy Bohmer23cd1382009-07-29 18:18:43 +02001371
1372done_set_intf:
1373 break;
1374 case USB_REQ_GET_INTERFACE:
1375 if (ctrl->bRequestType != (USB_DIR_IN|USB_RECIP_INTERFACE)
1376 || !dev->config
1377 || wIndex > 1)
1378 break;
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03001379 if (!(cdc_active(dev) || rndis_active(dev)) && wIndex != 0)
Remy Bohmer23cd1382009-07-29 18:18:43 +02001380 break;
1381
1382 /* for CDC, iff carrier is on, data interface is active. */
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03001383 if (rndis_active(dev) || wIndex != 1)
Remy Bohmer23cd1382009-07-29 18:18:43 +02001384 *(u8 *)req->buf = 0;
1385 else {
1386 /* *(u8 *)req->buf = netif_carrier_ok (dev->net) ? 1 : 0; */
1387 /* carrier always ok ...*/
1388 *(u8 *)req->buf = 1 ;
1389 }
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001390 value = min(wLength, (u16) 1);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001391 break;
1392
Lukasz Dalek2bb37882012-10-02 17:04:31 +02001393#ifdef CONFIG_USB_ETH_CDC
Remy Bohmer23cd1382009-07-29 18:18:43 +02001394 case USB_CDC_SET_ETHERNET_PACKET_FILTER:
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001395 /*
1396 * see 6.2.30: no data, wIndex = interface,
Remy Bohmer23cd1382009-07-29 18:18:43 +02001397 * wValue = packet filter bitmap
1398 */
1399 if (ctrl->bRequestType != (USB_TYPE_CLASS|USB_RECIP_INTERFACE)
1400 || !cdc_active(dev)
1401 || wLength != 0
1402 || wIndex > 1)
1403 break;
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +04001404 debug("packet filter %02x\n", wValue);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001405 dev->cdc_filter = wValue;
1406 value = 0;
1407 break;
1408
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001409 /*
1410 * and potentially:
Remy Bohmer23cd1382009-07-29 18:18:43 +02001411 * case USB_CDC_SET_ETHERNET_MULTICAST_FILTERS:
1412 * case USB_CDC_SET_ETHERNET_PM_PATTERN_FILTER:
1413 * case USB_CDC_GET_ETHERNET_PM_PATTERN_FILTER:
1414 * case USB_CDC_GET_ETHERNET_STATISTIC:
1415 */
1416
Lukasz Dalek2bb37882012-10-02 17:04:31 +02001417#endif /* CONFIG_USB_ETH_CDC */
Remy Bohmer23cd1382009-07-29 18:18:43 +02001418
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03001419#ifdef CONFIG_USB_ETH_RNDIS
1420 /*
1421 * RNDIS uses the CDC command encapsulation mechanism to implement
1422 * an RPC scheme, with much getting/setting of attributes by OID.
1423 */
1424 case USB_CDC_SEND_ENCAPSULATED_COMMAND:
1425 if (ctrl->bRequestType != (USB_TYPE_CLASS|USB_RECIP_INTERFACE)
1426 || !rndis_active(dev)
1427 || wLength > USB_BUFSIZ
1428 || wValue
1429 || rndis_control_intf.bInterfaceNumber
1430 != wIndex)
1431 break;
1432 /* read the request, then process it */
1433 value = wLength;
1434 req->complete = rndis_command_complete;
1435 /* later, rndis_control_ack () sends a notification */
1436 break;
1437
1438 case USB_CDC_GET_ENCAPSULATED_RESPONSE:
1439 if ((USB_DIR_IN|USB_TYPE_CLASS|USB_RECIP_INTERFACE)
1440 == ctrl->bRequestType
1441 && rndis_active(dev)
1442 /* && wLength >= 0x0400 */
1443 && !wValue
1444 && rndis_control_intf.bInterfaceNumber
1445 == wIndex) {
1446 u8 *buf;
1447 u32 n;
1448
1449 /* return the result */
1450 buf = rndis_get_next_response(dev->rndis_config, &n);
1451 if (buf) {
1452 memcpy(req->buf, buf, n);
1453 req->complete = rndis_response_complete;
1454 rndis_free_response(dev->rndis_config, buf);
1455 value = n;
1456 }
1457 /* else stalls ... spec says to avoid that */
1458 }
1459 break;
1460#endif /* RNDIS */
1461
Remy Bohmer23cd1382009-07-29 18:18:43 +02001462 default:
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +04001463 debug("unknown control req%02x.%02x v%04x i%04x l%d\n",
Remy Bohmer23cd1382009-07-29 18:18:43 +02001464 ctrl->bRequestType, ctrl->bRequest,
1465 wValue, wIndex, wLength);
1466 }
1467
1468 /* respond with data transfer before status phase? */
1469 if (value >= 0) {
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +04001470 debug("respond with data transfer before status phase\n");
Remy Bohmer23cd1382009-07-29 18:18:43 +02001471 req->length = value;
1472 req->zero = value < wLength
1473 && (value % gadget->ep0->maxpacket) == 0;
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001474 value = usb_ep_queue(gadget->ep0, req, GFP_ATOMIC);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001475 if (value < 0) {
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +04001476 debug("ep_queue --> %d\n", value);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001477 req->status = 0;
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001478 eth_setup_complete(gadget->ep0, req);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001479 }
1480 }
1481
1482 /* host either stalls (value < 0) or reports success */
1483 return value;
1484}
1485
Remy Bohmer23cd1382009-07-29 18:18:43 +02001486/*-------------------------------------------------------------------------*/
1487
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001488static void rx_complete(struct usb_ep *ep, struct usb_request *req);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001489
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001490static int rx_submit(struct eth_dev *dev, struct usb_request *req,
Remy Bohmer23cd1382009-07-29 18:18:43 +02001491 gfp_t gfp_flags)
1492{
1493 int retval = -ENOMEM;
1494 size_t size;
1495
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001496 /*
1497 * Padding up to RX_EXTRA handles minor disagreements with host.
Remy Bohmer23cd1382009-07-29 18:18:43 +02001498 * Normally we use the USB "terminate on short read" convention;
1499 * so allow up to (N*maxpacket), since that memory is normally
1500 * already allocated. Some hardware doesn't deal well with short
1501 * reads (e.g. DMA must be N*maxpacket), so for now don't trim a
1502 * byte off the end (to force hardware errors on overflow).
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03001503 *
1504 * RNDIS uses internal framing, and explicitly allows senders to
1505 * pad to end-of-packet. That's potentially nice for speed,
1506 * but means receivers can't recover synch on their own.
Remy Bohmer23cd1382009-07-29 18:18:43 +02001507 */
1508
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +04001509 debug("%s\n", __func__);
Troy Kisky71fc5f92013-09-25 18:41:05 -07001510 if (!req)
1511 return -EINVAL;
Remy Bohmer23cd1382009-07-29 18:18:43 +02001512
1513 size = (ETHER_HDR_SIZE + dev->mtu + RX_EXTRA);
1514 size += dev->out_ep->maxpacket - 1;
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03001515 if (rndis_active(dev))
1516 size += sizeof(struct rndis_packet_msg_type);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001517 size -= size % dev->out_ep->maxpacket;
1518
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001519 /*
1520 * Some platforms perform better when IP packets are aligned,
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03001521 * but on at least one, checksumming fails otherwise. Note:
1522 * RNDIS headers involve variable numbers of LE32 values.
Remy Bohmer23cd1382009-07-29 18:18:43 +02001523 */
1524
1525 req->buf = (u8 *) NetRxPackets[0];
1526 req->length = size;
1527 req->complete = rx_complete;
1528
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001529 retval = usb_ep_queue(dev->out_ep, req, gfp_flags);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001530
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001531 if (retval)
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +04001532 error("rx submit --> %d", retval);
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001533
Remy Bohmer23cd1382009-07-29 18:18:43 +02001534 return retval;
1535}
1536
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001537static void rx_complete(struct usb_ep *ep, struct usb_request *req)
Remy Bohmer23cd1382009-07-29 18:18:43 +02001538{
1539 struct eth_dev *dev = ep->driver_data;
1540
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +04001541 debug("%s: status %d\n", __func__, req->status);
Vitaly Kuzmichevc85d70e2011-02-11 18:18:32 +03001542 switch (req->status) {
1543 /* normal completion */
1544 case 0:
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03001545 if (rndis_active(dev)) {
1546 /* we know MaxPacketsPerTransfer == 1 here */
1547 int length = rndis_rm_hdr(req->buf, req->actual);
1548 if (length < 0)
1549 goto length_err;
1550 req->length -= length;
1551 req->actual -= length;
1552 }
1553 if (req->actual < ETH_HLEN || ETH_FRAME_LEN < req->actual) {
1554length_err:
1555 dev->stats.rx_errors++;
1556 dev->stats.rx_length_errors++;
1557 debug("rx length %d\n", req->length);
1558 break;
1559 }
1560
Vitaly Kuzmichevc85d70e2011-02-11 18:18:32 +03001561 dev->stats.rx_packets++;
1562 dev->stats.rx_bytes += req->length;
1563 break;
1564
1565 /* software-driven interface shutdown */
1566 case -ECONNRESET: /* unlink */
1567 case -ESHUTDOWN: /* disconnect etc */
1568 /* for hardware automagic (such as pxa) */
1569 case -ECONNABORTED: /* endpoint reset */
1570 break;
1571
1572 /* data overrun */
1573 case -EOVERFLOW:
1574 dev->stats.rx_over_errors++;
1575 /* FALLTHROUGH */
1576 default:
1577 dev->stats.rx_errors++;
1578 break;
1579 }
Remy Bohmer23cd1382009-07-29 18:18:43 +02001580
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001581 packet_received = 1;
Remy Bohmer23cd1382009-07-29 18:18:43 +02001582}
1583
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001584static int alloc_requests(struct eth_dev *dev, unsigned n, gfp_t gfp_flags)
Remy Bohmer23cd1382009-07-29 18:18:43 +02001585{
1586
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001587 dev->tx_req = usb_ep_alloc_request(dev->in_ep, 0);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001588
1589 if (!dev->tx_req)
Vitaly Kuzmichevac5d32d2010-09-22 13:13:55 +04001590 goto fail1;
Remy Bohmer23cd1382009-07-29 18:18:43 +02001591
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001592 dev->rx_req = usb_ep_alloc_request(dev->out_ep, 0);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001593
1594 if (!dev->rx_req)
Vitaly Kuzmichevac5d32d2010-09-22 13:13:55 +04001595 goto fail2;
Remy Bohmer23cd1382009-07-29 18:18:43 +02001596
1597 return 0;
1598
Vitaly Kuzmichevac5d32d2010-09-22 13:13:55 +04001599fail2:
1600 usb_ep_free_request(dev->in_ep, dev->tx_req);
1601fail1:
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +04001602 error("can't alloc requests");
Remy Bohmer23cd1382009-07-29 18:18:43 +02001603 return -1;
1604}
1605
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001606static void tx_complete(struct usb_ep *ep, struct usb_request *req)
Remy Bohmer23cd1382009-07-29 18:18:43 +02001607{
Vitaly Kuzmichevc85d70e2011-02-11 18:18:32 +03001608 struct eth_dev *dev = ep->driver_data;
1609
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001610 debug("%s: status %s\n", __func__, (req->status) ? "failed" : "ok");
Vitaly Kuzmichevc85d70e2011-02-11 18:18:32 +03001611 switch (req->status) {
1612 default:
1613 dev->stats.tx_errors++;
1614 debug("tx err %d\n", req->status);
1615 /* FALLTHROUGH */
1616 case -ECONNRESET: /* unlink */
1617 case -ESHUTDOWN: /* disconnect etc */
1618 break;
1619 case 0:
1620 dev->stats.tx_bytes += req->length;
1621 }
1622 dev->stats.tx_packets++;
1623
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001624 packet_sent = 1;
Remy Bohmer23cd1382009-07-29 18:18:43 +02001625}
1626
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001627static inline int eth_is_promisc(struct eth_dev *dev)
Remy Bohmer23cd1382009-07-29 18:18:43 +02001628{
1629 /* no filters for the CDC subset; always promisc */
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001630 if (subset_active(dev))
Remy Bohmer23cd1382009-07-29 18:18:43 +02001631 return 1;
1632 return dev->cdc_filter & USB_CDC_PACKET_TYPE_PROMISCUOUS;
1633}
1634
1635#if 0
1636static int eth_start_xmit (struct sk_buff *skb, struct net_device *net)
1637{
1638 struct eth_dev *dev = netdev_priv(net);
1639 int length = skb->len;
1640 int retval;
1641 struct usb_request *req = NULL;
1642 unsigned long flags;
1643
1644 /* apply outgoing CDC or RNDIS filters */
1645 if (!eth_is_promisc (dev)) {
1646 u8 *dest = skb->data;
1647
1648 if (is_multicast_ether_addr(dest)) {
1649 u16 type;
1650
1651 /* ignores USB_CDC_PACKET_TYPE_MULTICAST and host
1652 * SET_ETHERNET_MULTICAST_FILTERS requests
1653 */
1654 if (is_broadcast_ether_addr(dest))
1655 type = USB_CDC_PACKET_TYPE_BROADCAST;
1656 else
1657 type = USB_CDC_PACKET_TYPE_ALL_MULTICAST;
1658 if (!(dev->cdc_filter & type)) {
1659 dev_kfree_skb_any (skb);
1660 return 0;
1661 }
1662 }
1663 /* ignores USB_CDC_PACKET_TYPE_DIRECTED */
1664 }
1665
1666 spin_lock_irqsave(&dev->req_lock, flags);
1667 /*
1668 * this freelist can be empty if an interrupt triggered disconnect()
1669 * and reconfigured the gadget (shutting down this queue) after the
1670 * network stack decided to xmit but before we got the spinlock.
1671 */
1672 if (list_empty(&dev->tx_reqs)) {
1673 spin_unlock_irqrestore(&dev->req_lock, flags);
1674 return 1;
1675 }
1676
1677 req = container_of (dev->tx_reqs.next, struct usb_request, list);
1678 list_del (&req->list);
1679
1680 /* temporarily stop TX queue when the freelist empties */
1681 if (list_empty (&dev->tx_reqs))
1682 netif_stop_queue (net);
1683 spin_unlock_irqrestore(&dev->req_lock, flags);
1684
1685 /* no buffer copies needed, unless the network stack did it
1686 * or the hardware can't use skb buffers.
1687 * or there's not enough space for any RNDIS headers we need
1688 */
1689 if (rndis_active(dev)) {
1690 struct sk_buff *skb_rndis;
1691
1692 skb_rndis = skb_realloc_headroom (skb,
1693 sizeof (struct rndis_packet_msg_type));
1694 if (!skb_rndis)
1695 goto drop;
1696
1697 dev_kfree_skb_any (skb);
1698 skb = skb_rndis;
1699 rndis_add_hdr (skb);
1700 length = skb->len;
1701 }
1702 req->buf = skb->data;
1703 req->context = skb;
1704 req->complete = tx_complete;
1705
1706 /* use zlp framing on tx for strict CDC-Ether conformance,
1707 * though any robust network rx path ignores extra padding.
1708 * and some hardware doesn't like to write zlps.
1709 */
1710 req->zero = 1;
1711 if (!dev->zlp && (length % dev->in_ep->maxpacket) == 0)
1712 length++;
1713
1714 req->length = length;
1715
1716 /* throttle highspeed IRQ rate back slightly */
1717 if (gadget_is_dualspeed(dev->gadget))
1718 req->no_interrupt = (dev->gadget->speed == USB_SPEED_HIGH)
1719 ? ((atomic_read(&dev->tx_qlen) % qmult) != 0)
1720 : 0;
1721
1722 retval = usb_ep_queue (dev->in_ep, req, GFP_ATOMIC);
1723 switch (retval) {
1724 default:
1725 DEBUG (dev, "tx queue err %d\n", retval);
1726 break;
1727 case 0:
1728 net->trans_start = jiffies;
1729 atomic_inc (&dev->tx_qlen);
1730 }
1731
1732 if (retval) {
1733drop:
1734 dev->stats.tx_dropped++;
1735 dev_kfree_skb_any (skb);
1736 spin_lock_irqsave(&dev->req_lock, flags);
1737 if (list_empty (&dev->tx_reqs))
1738 netif_start_queue (net);
1739 list_add (&req->list, &dev->tx_reqs);
1740 spin_unlock_irqrestore(&dev->req_lock, flags);
1741 }
1742 return 0;
1743}
1744
1745/*-------------------------------------------------------------------------*/
1746#endif
1747
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001748static void eth_unbind(struct usb_gadget *gadget)
Remy Bohmer23cd1382009-07-29 18:18:43 +02001749{
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03001750 struct eth_dev *dev = get_gadget_data(gadget);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001751
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +04001752 debug("%s...\n", __func__);
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03001753 rndis_deregister(dev->rndis_config);
1754 rndis_exit();
Remy Bohmer23cd1382009-07-29 18:18:43 +02001755
Vitaly Kuzmichev0129e322010-08-13 17:00:16 +04001756 /* we've already been disconnected ... no i/o is active */
1757 if (dev->req) {
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001758 usb_ep_free_request(gadget->ep0, dev->req);
Vitaly Kuzmichev0129e322010-08-13 17:00:16 +04001759 dev->req = NULL;
1760 }
Remy Bohmer23cd1382009-07-29 18:18:43 +02001761 if (dev->stat_req) {
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001762 usb_ep_free_request(dev->status_ep, dev->stat_req);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001763 dev->stat_req = NULL;
1764 }
1765
1766 if (dev->tx_req) {
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001767 usb_ep_free_request(dev->in_ep, dev->tx_req);
1768 dev->tx_req = NULL;
Remy Bohmer23cd1382009-07-29 18:18:43 +02001769 }
1770
1771 if (dev->rx_req) {
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001772 usb_ep_free_request(dev->out_ep, dev->rx_req);
1773 dev->rx_req = NULL;
Remy Bohmer23cd1382009-07-29 18:18:43 +02001774 }
1775
1776/* unregister_netdev (dev->net);*/
1777/* free_netdev(dev->net);*/
1778
Lei Wen988ee3e2010-12-01 23:43:43 +08001779 dev->gadget = NULL;
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001780 set_gadget_data(gadget, NULL);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001781}
1782
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001783static void eth_disconnect(struct usb_gadget *gadget)
Remy Bohmer23cd1382009-07-29 18:18:43 +02001784{
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001785 eth_reset_config(get_gadget_data(gadget));
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03001786 /* FIXME RNDIS should enter RNDIS_UNINITIALIZED */
Remy Bohmer23cd1382009-07-29 18:18:43 +02001787}
1788
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001789static void eth_suspend(struct usb_gadget *gadget)
Remy Bohmer23cd1382009-07-29 18:18:43 +02001790{
1791 /* Not used */
1792}
1793
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001794static void eth_resume(struct usb_gadget *gadget)
Remy Bohmer23cd1382009-07-29 18:18:43 +02001795{
1796 /* Not used */
1797}
1798
1799/*-------------------------------------------------------------------------*/
1800
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03001801#ifdef CONFIG_USB_ETH_RNDIS
1802
1803/*
1804 * The interrupt endpoint is used in RNDIS to notify the host when messages
1805 * other than data packets are available ... notably the REMOTE_NDIS_*_CMPLT
1806 * messages, but also REMOTE_NDIS_INDICATE_STATUS_MSG and potentially even
1807 * REMOTE_NDIS_KEEPALIVE_MSG.
1808 *
1809 * The RNDIS control queue is processed by GET_ENCAPSULATED_RESPONSE, and
1810 * normally just one notification will be queued.
1811 */
1812
1813static void rndis_control_ack_complete(struct usb_ep *ep,
1814 struct usb_request *req)
1815{
1816 struct eth_dev *dev = ep->driver_data;
1817
1818 debug("%s...\n", __func__);
1819 if (req->status || req->actual != req->length)
1820 debug("rndis control ack complete --> %d, %d/%d\n",
1821 req->status, req->actual, req->length);
1822
1823 if (!l_ethdev.network_started) {
1824 if (rndis_get_state(dev->rndis_config)
1825 == RNDIS_DATA_INITIALIZED) {
1826 l_ethdev.network_started = 1;
1827 printf("USB RNDIS network up!\n");
1828 }
1829 }
1830
1831 req->context = NULL;
1832
1833 if (req != dev->stat_req)
1834 usb_ep_free_request(ep, req);
1835}
1836
1837static char rndis_resp_buf[8] __attribute__((aligned(sizeof(__le32))));
1838
1839static int rndis_control_ack(struct eth_device *net)
1840{
1841 struct eth_dev *dev = &l_ethdev;
1842 int length;
1843 struct usb_request *resp = dev->stat_req;
1844
1845 /* in case RNDIS calls this after disconnect */
1846 if (!dev->status) {
1847 debug("status ENODEV\n");
1848 return -ENODEV;
1849 }
1850
1851 /* in case queue length > 1 */
1852 if (resp->context) {
1853 resp = usb_ep_alloc_request(dev->status_ep, GFP_ATOMIC);
1854 if (!resp)
1855 return -ENOMEM;
1856 resp->buf = rndis_resp_buf;
1857 }
1858
1859 /*
1860 * Send RNDIS RESPONSE_AVAILABLE notification;
1861 * USB_CDC_NOTIFY_RESPONSE_AVAILABLE should work too
1862 */
1863 resp->length = 8;
1864 resp->complete = rndis_control_ack_complete;
1865 resp->context = dev;
1866
1867 *((__le32 *) resp->buf) = __constant_cpu_to_le32(1);
1868 *((__le32 *) (resp->buf + 4)) = __constant_cpu_to_le32(0);
1869
1870 length = usb_ep_queue(dev->status_ep, resp, GFP_ATOMIC);
1871 if (length < 0) {
1872 resp->status = 0;
1873 rndis_control_ack_complete(dev->status_ep, resp);
1874 }
1875
1876 return 0;
1877}
1878
1879#else
1880
1881#define rndis_control_ack NULL
1882
1883#endif /* RNDIS */
1884
1885static void eth_start(struct eth_dev *dev, gfp_t gfp_flags)
1886{
1887 if (rndis_active(dev)) {
1888 rndis_set_param_medium(dev->rndis_config,
1889 NDIS_MEDIUM_802_3,
1890 BITRATE(dev->gadget)/100);
1891 rndis_signal_connect(dev->rndis_config);
1892 }
1893}
1894
1895static int eth_stop(struct eth_dev *dev)
1896{
Vitaly Kuzmicheve4ae6662011-02-11 18:18:35 +03001897#ifdef RNDIS_COMPLETE_SIGNAL_DISCONNECT
1898 unsigned long ts;
1899 unsigned long timeout = CONFIG_SYS_HZ; /* 1 sec to stop RNDIS */
1900#endif
1901
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03001902 if (rndis_active(dev)) {
1903 rndis_set_param_medium(dev->rndis_config, NDIS_MEDIUM_802_3, 0);
1904 rndis_signal_disconnect(dev->rndis_config);
1905
Vitaly Kuzmicheve4ae6662011-02-11 18:18:35 +03001906#ifdef RNDIS_COMPLETE_SIGNAL_DISCONNECT
1907 /* Wait until host receives OID_GEN_MEDIA_CONNECT_STATUS */
1908 ts = get_timer(0);
1909 while (get_timer(ts) < timeout)
1910 usb_gadget_handle_interrupts();
1911#endif
1912
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03001913 rndis_uninit(dev->rndis_config);
1914 dev->rndis = 0;
1915 }
1916
1917 return 0;
1918}
1919
1920/*-------------------------------------------------------------------------*/
1921
Remy Bohmer23cd1382009-07-29 18:18:43 +02001922static int is_eth_addr_valid(char *str)
1923{
1924 if (strlen(str) == 17) {
1925 int i;
1926 char *p, *q;
1927 uchar ea[6];
1928
1929 /* see if it looks like an ethernet address */
1930
1931 p = str;
1932
1933 for (i = 0; i < 6; i++) {
1934 char term = (i == 5 ? '\0' : ':');
1935
1936 ea[i] = simple_strtol(p, &q, 16);
1937
1938 if ((q - p) != 2 || *q++ != term)
1939 break;
1940
1941 p = q;
1942 }
1943
Tom Rini57a87a22012-10-31 13:30:41 +00001944 /* Now check the contents. */
1945 return is_valid_ether_addr(ea);
Remy Bohmer23cd1382009-07-29 18:18:43 +02001946 }
1947 return 0;
1948}
1949
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001950static u8 nibble(unsigned char c)
Remy Bohmer23cd1382009-07-29 18:18:43 +02001951{
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001952 if (likely(isdigit(c)))
Remy Bohmer23cd1382009-07-29 18:18:43 +02001953 return c - '0';
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001954 c = toupper(c);
1955 if (likely(isxdigit(c)))
Remy Bohmer23cd1382009-07-29 18:18:43 +02001956 return 10 + c - 'A';
1957 return 0;
1958}
1959
1960static int get_ether_addr(const char *str, u8 *dev_addr)
1961{
1962 if (str) {
1963 unsigned i;
1964
1965 for (i = 0; i < 6; i++) {
1966 unsigned char num;
1967
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001968 if ((*str == '.') || (*str == ':'))
Remy Bohmer23cd1382009-07-29 18:18:43 +02001969 str++;
1970 num = nibble(*str++) << 4;
1971 num |= (nibble(*str++));
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001972 dev_addr[i] = num;
Remy Bohmer23cd1382009-07-29 18:18:43 +02001973 }
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001974 if (is_valid_ether_addr(dev_addr))
Remy Bohmer23cd1382009-07-29 18:18:43 +02001975 return 0;
1976 }
1977 return 1;
1978}
1979
1980static int eth_bind(struct usb_gadget *gadget)
1981{
1982 struct eth_dev *dev = &l_ethdev;
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03001983 u8 cdc = 1, zlp = 1, rndis = 1;
Remy Bohmer23cd1382009-07-29 18:18:43 +02001984 struct usb_ep *in_ep, *out_ep, *status_ep = NULL;
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03001985 int status = -ENOMEM;
Remy Bohmer23cd1382009-07-29 18:18:43 +02001986 int gcnum;
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001987 u8 tmp[7];
Remy Bohmer23cd1382009-07-29 18:18:43 +02001988
1989 /* these flags are only ever cleared; compiler take note */
Lukasz Dalek2bb37882012-10-02 17:04:31 +02001990#ifndef CONFIG_USB_ETH_CDC
Remy Bohmer23cd1382009-07-29 18:18:43 +02001991 cdc = 0;
1992#endif
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03001993#ifndef CONFIG_USB_ETH_RNDIS
1994 rndis = 0;
1995#endif
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04001996 /*
1997 * Because most host side USB stacks handle CDC Ethernet, that
Remy Bohmer23cd1382009-07-29 18:18:43 +02001998 * standard protocol is _strongly_ preferred for interop purposes.
1999 * (By everyone except Microsoft.)
2000 */
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002001 if (gadget_is_pxa(gadget)) {
Remy Bohmer23cd1382009-07-29 18:18:43 +02002002 /* pxa doesn't support altsettings */
2003 cdc = 0;
2004 } else if (gadget_is_musbhdrc(gadget)) {
2005 /* reduce tx dma overhead by avoiding special cases */
2006 zlp = 0;
2007 } else if (gadget_is_sh(gadget)) {
2008 /* sh doesn't support multiple interfaces or configs */
2009 cdc = 0;
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03002010 rndis = 0;
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002011 } else if (gadget_is_sa1100(gadget)) {
Remy Bohmer23cd1382009-07-29 18:18:43 +02002012 /* hardware can't write zlps */
2013 zlp = 0;
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002014 /*
2015 * sa1100 CAN do CDC, without status endpoint ... we use
Remy Bohmer23cd1382009-07-29 18:18:43 +02002016 * non-CDC to be compatible with ARM Linux-2.4 "usb-eth".
2017 */
2018 cdc = 0;
2019 }
2020
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002021 gcnum = usb_gadget_controller_number(gadget);
Remy Bohmer23cd1382009-07-29 18:18:43 +02002022 if (gcnum >= 0)
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002023 device_desc.bcdDevice = cpu_to_le16(0x0300 + gcnum);
Remy Bohmer23cd1382009-07-29 18:18:43 +02002024 else {
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002025 /*
2026 * can't assume CDC works. don't want to default to
Remy Bohmer23cd1382009-07-29 18:18:43 +02002027 * anything less functional on CDC-capable hardware,
2028 * so we fail in this case.
2029 */
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +04002030 error("controller '%s' not recognized",
Remy Bohmer23cd1382009-07-29 18:18:43 +02002031 gadget->name);
2032 return -ENODEV;
2033 }
2034
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002035 /*
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03002036 * If there's an RNDIS configuration, that's what Windows wants to
2037 * be using ... so use these product IDs here and in the "linux.inf"
2038 * needed to install MSFT drivers. Current Linux kernels will use
2039 * the second configuration if it's CDC Ethernet, and need some help
2040 * to choose the right configuration otherwise.
2041 */
2042 if (rndis) {
2043#if defined(CONFIG_USB_RNDIS_VENDOR_ID) && defined(CONFIG_USB_RNDIS_PRODUCT_ID)
2044 device_desc.idVendor =
2045 __constant_cpu_to_le16(CONFIG_USB_RNDIS_VENDOR_ID);
2046 device_desc.idProduct =
2047 __constant_cpu_to_le16(CONFIG_USB_RNDIS_PRODUCT_ID);
2048#else
2049 device_desc.idVendor =
2050 __constant_cpu_to_le16(RNDIS_VENDOR_NUM);
2051 device_desc.idProduct =
2052 __constant_cpu_to_le16(RNDIS_PRODUCT_NUM);
2053#endif
2054 sprintf(product_desc, "RNDIS/%s", driver_desc);
2055
2056 /*
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002057 * CDC subset ... recognized by Linux since 2.4.10, but Windows
Remy Bohmer23cd1382009-07-29 18:18:43 +02002058 * drivers aren't widely available. (That may be improved by
2059 * supporting one submode of the "SAFE" variant of MDLM.)
2060 */
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03002061 } else {
Remy Bohmer23cd1382009-07-29 18:18:43 +02002062#if defined(CONFIG_USB_CDC_VENDOR_ID) && defined(CONFIG_USB_CDC_PRODUCT_ID)
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03002063 device_desc.idVendor = cpu_to_le16(CONFIG_USB_CDC_VENDOR_ID);
2064 device_desc.idProduct = cpu_to_le16(CONFIG_USB_CDC_PRODUCT_ID);
2065#else
2066 if (!cdc) {
2067 device_desc.idVendor =
2068 __constant_cpu_to_le16(SIMPLE_VENDOR_NUM);
2069 device_desc.idProduct =
2070 __constant_cpu_to_le16(SIMPLE_PRODUCT_NUM);
2071 }
Remy Bohmer23cd1382009-07-29 18:18:43 +02002072#endif
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03002073 }
2074 /* support optional vendor/distro customization */
Remy Bohmer23cd1382009-07-29 18:18:43 +02002075 if (bcdDevice)
2076 device_desc.bcdDevice = cpu_to_le16(bcdDevice);
2077 if (iManufacturer)
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002078 strlcpy(manufacturer, iManufacturer, sizeof manufacturer);
Remy Bohmer23cd1382009-07-29 18:18:43 +02002079 if (iProduct)
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002080 strlcpy(product_desc, iProduct, sizeof product_desc);
Remy Bohmer23cd1382009-07-29 18:18:43 +02002081 if (iSerialNumber) {
2082 device_desc.iSerialNumber = STRING_SERIALNUMBER,
Vitaly Kuzmichev2e12abe2010-08-13 17:00:45 +04002083 strlcpy(serial_number, iSerialNumber, sizeof serial_number);
Remy Bohmer23cd1382009-07-29 18:18:43 +02002084 }
2085
2086 /* all we really need is bulk IN/OUT */
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002087 usb_ep_autoconfig_reset(gadget);
2088 in_ep = usb_ep_autoconfig(gadget, &fs_source_desc);
Remy Bohmer23cd1382009-07-29 18:18:43 +02002089 if (!in_ep) {
2090autoconf_fail:
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +04002091 error("can't autoconfigure on %s\n",
Remy Bohmer23cd1382009-07-29 18:18:43 +02002092 gadget->name);
2093 return -ENODEV;
2094 }
2095 in_ep->driver_data = in_ep; /* claim */
2096
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002097 out_ep = usb_ep_autoconfig(gadget, &fs_sink_desc);
Remy Bohmer23cd1382009-07-29 18:18:43 +02002098 if (!out_ep)
2099 goto autoconf_fail;
2100 out_ep->driver_data = out_ep; /* claim */
2101
Lukasz Dalek2bb37882012-10-02 17:04:31 +02002102#if defined(CONFIG_USB_ETH_CDC) || defined(CONFIG_USB_ETH_RNDIS)
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002103 /*
2104 * CDC Ethernet control interface doesn't require a status endpoint.
Remy Bohmer23cd1382009-07-29 18:18:43 +02002105 * Since some hosts expect one, try to allocate one anyway.
2106 */
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03002107 if (cdc || rndis) {
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002108 status_ep = usb_ep_autoconfig(gadget, &fs_status_desc);
Remy Bohmer23cd1382009-07-29 18:18:43 +02002109 if (status_ep) {
2110 status_ep->driver_data = status_ep; /* claim */
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03002111 } else if (rndis) {
2112 error("can't run RNDIS on %s", gadget->name);
2113 return -ENODEV;
Lukasz Dalek2bb37882012-10-02 17:04:31 +02002114#ifdef CONFIG_USB_ETH_CDC
Remy Bohmer23cd1382009-07-29 18:18:43 +02002115 } else if (cdc) {
2116 control_intf.bNumEndpoints = 0;
2117 /* FIXME remove endpoint from descriptor list */
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03002118#endif
Remy Bohmer23cd1382009-07-29 18:18:43 +02002119 }
2120 }
2121#endif
2122
2123 /* one config: cdc, else minimal subset */
2124 if (!cdc) {
2125 eth_config.bNumInterfaces = 1;
2126 eth_config.iConfiguration = STRING_SUBSET;
2127
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002128 /*
2129 * use functions to set these up, in case we're built to work
Remy Bohmer23cd1382009-07-29 18:18:43 +02002130 * with multiple controllers and must override CDC Ethernet.
2131 */
2132 fs_subset_descriptors();
2133 hs_subset_descriptors();
2134 }
2135
2136 device_desc.bMaxPacketSize0 = gadget->ep0->maxpacket;
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002137 usb_gadget_set_selfpowered(gadget);
Remy Bohmer23cd1382009-07-29 18:18:43 +02002138
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03002139 /* For now RNDIS is always a second config */
2140 if (rndis)
2141 device_desc.bNumConfigurations = 2;
2142
Remy Bohmer23cd1382009-07-29 18:18:43 +02002143 if (gadget_is_dualspeed(gadget)) {
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03002144 if (rndis)
2145 dev_qualifier.bNumConfigurations = 2;
2146 else if (!cdc)
Remy Bohmer23cd1382009-07-29 18:18:43 +02002147 dev_qualifier.bDeviceClass = USB_CLASS_VENDOR_SPEC;
2148
2149 /* assumes ep0 uses the same value for both speeds ... */
2150 dev_qualifier.bMaxPacketSize0 = device_desc.bMaxPacketSize0;
2151
2152 /* and that all endpoints are dual-speed */
2153 hs_source_desc.bEndpointAddress =
2154 fs_source_desc.bEndpointAddress;
2155 hs_sink_desc.bEndpointAddress =
2156 fs_sink_desc.bEndpointAddress;
Lukasz Dalek2bb37882012-10-02 17:04:31 +02002157#if defined(CONFIG_USB_ETH_CDC) || defined(CONFIG_USB_ETH_RNDIS)
Remy Bohmer23cd1382009-07-29 18:18:43 +02002158 if (status_ep)
2159 hs_status_desc.bEndpointAddress =
2160 fs_status_desc.bEndpointAddress;
2161#endif
2162 }
2163
2164 if (gadget_is_otg(gadget)) {
2165 otg_descriptor.bmAttributes |= USB_OTG_HNP,
2166 eth_config.bmAttributes |= USB_CONFIG_ATT_WAKEUP;
2167 eth_config.bMaxPower = 4;
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03002168#ifdef CONFIG_USB_ETH_RNDIS
2169 rndis_config.bmAttributes |= USB_CONFIG_ATT_WAKEUP;
2170 rndis_config.bMaxPower = 4;
2171#endif
Remy Bohmer23cd1382009-07-29 18:18:43 +02002172 }
2173
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03002174
2175 /* network device setup */
Remy Bohmer23cd1382009-07-29 18:18:43 +02002176 dev->net = &l_netdev;
Remy Bohmer23cd1382009-07-29 18:18:43 +02002177
2178 dev->cdc = cdc;
2179 dev->zlp = zlp;
2180
2181 dev->in_ep = in_ep;
2182 dev->out_ep = out_ep;
2183 dev->status_ep = status_ep;
2184
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002185 /*
2186 * Module params for these addresses should come from ID proms.
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03002187 * The host side address is used with CDC and RNDIS, and commonly
Remy Bohmer23cd1382009-07-29 18:18:43 +02002188 * ends up in a persistent config database. It's not clear if
2189 * host side code for the SAFE thing cares -- its original BLAN
2190 * thing didn't, Sharp never assigned those addresses on Zaurii.
2191 */
2192 get_ether_addr(dev_addr, dev->net->enetaddr);
2193
2194 memset(tmp, 0, sizeof(tmp));
2195 memcpy(tmp, dev->net->enetaddr, sizeof(dev->net->enetaddr));
2196
2197 get_ether_addr(host_addr, dev->host_mac);
2198
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002199 sprintf(ethaddr, "%02X%02X%02X%02X%02X%02X",
2200 dev->host_mac[0], dev->host_mac[1],
2201 dev->host_mac[2], dev->host_mac[3],
2202 dev->host_mac[4], dev->host_mac[5]);
Remy Bohmer23cd1382009-07-29 18:18:43 +02002203
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03002204 if (rndis) {
2205 status = rndis_init();
2206 if (status < 0) {
2207 error("can't init RNDIS, %d", status);
2208 goto fail;
2209 }
Remy Bohmer23cd1382009-07-29 18:18:43 +02002210 }
2211
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002212 /*
2213 * use PKTSIZE (or aligned... from u-boot) and set
2214 * wMaxSegmentSize accordingly
2215 */
Remy Bohmer23cd1382009-07-29 18:18:43 +02002216 dev->mtu = PKTSIZE_ALIGN; /* RNDIS does not like this, only 1514, TODO*/
2217
2218 /* preallocate control message data and buffer */
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002219 dev->req = usb_ep_alloc_request(gadget->ep0, GFP_KERNEL);
Remy Bohmer23cd1382009-07-29 18:18:43 +02002220 if (!dev->req)
2221 goto fail;
2222 dev->req->buf = control_req;
2223 dev->req->complete = eth_setup_complete;
2224
2225 /* ... and maybe likewise for status transfer */
Lukasz Dalek2bb37882012-10-02 17:04:31 +02002226#if defined(CONFIG_USB_ETH_CDC) || defined(CONFIG_USB_ETH_RNDIS)
Remy Bohmer23cd1382009-07-29 18:18:43 +02002227 if (dev->status_ep) {
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002228 dev->stat_req = usb_ep_alloc_request(dev->status_ep,
2229 GFP_KERNEL);
Remy Bohmer23cd1382009-07-29 18:18:43 +02002230 if (!dev->stat_req) {
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002231 usb_ep_free_request(dev->status_ep, dev->req);
Remy Bohmer23cd1382009-07-29 18:18:43 +02002232
2233 goto fail;
2234 }
Vitaly Kuzmichevdf559c12010-08-13 17:01:06 +04002235 dev->stat_req->buf = status_req;
Remy Bohmer23cd1382009-07-29 18:18:43 +02002236 dev->stat_req->context = NULL;
2237 }
2238#endif
2239
2240 /* finish hookup to lower layer ... */
2241 dev->gadget = gadget;
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002242 set_gadget_data(gadget, dev);
Remy Bohmer23cd1382009-07-29 18:18:43 +02002243 gadget->ep0->driver_data = dev;
2244
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002245 /*
2246 * two kinds of host-initiated state changes:
Remy Bohmer23cd1382009-07-29 18:18:43 +02002247 * - iff DATA transfer is active, carrier is "on"
2248 * - tx queueing enabled if open *and* carrier is "on"
2249 */
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03002250
2251 printf("using %s, OUT %s IN %s%s%s\n", gadget->name,
2252 out_ep->name, in_ep->name,
2253 status_ep ? " STATUS " : "",
2254 status_ep ? status_ep->name : ""
2255 );
2256 printf("MAC %02x:%02x:%02x:%02x:%02x:%02x\n",
2257 dev->net->enetaddr[0], dev->net->enetaddr[1],
2258 dev->net->enetaddr[2], dev->net->enetaddr[3],
2259 dev->net->enetaddr[4], dev->net->enetaddr[5]);
2260
2261 if (cdc || rndis)
2262 printf("HOST MAC %02x:%02x:%02x:%02x:%02x:%02x\n",
2263 dev->host_mac[0], dev->host_mac[1],
2264 dev->host_mac[2], dev->host_mac[3],
2265 dev->host_mac[4], dev->host_mac[5]);
2266
2267 if (rndis) {
2268 u32 vendorID = 0;
2269
2270 /* FIXME RNDIS vendor id == "vendor NIC code" == ? */
2271
2272 dev->rndis_config = rndis_register(rndis_control_ack);
2273 if (dev->rndis_config < 0) {
2274fail0:
2275 eth_unbind(gadget);
2276 debug("RNDIS setup failed\n");
2277 status = -ENODEV;
2278 goto fail;
2279 }
2280
2281 /* these set up a lot of the OIDs that RNDIS needs */
2282 rndis_set_host_mac(dev->rndis_config, dev->host_mac);
2283 if (rndis_set_param_dev(dev->rndis_config, dev->net, dev->mtu,
2284 &dev->stats, &dev->cdc_filter))
2285 goto fail0;
2286 if (rndis_set_param_vendor(dev->rndis_config, vendorID,
2287 manufacturer))
2288 goto fail0;
2289 if (rndis_set_param_medium(dev->rndis_config,
2290 NDIS_MEDIUM_802_3, 0))
2291 goto fail0;
2292 printf("RNDIS ready\n");
2293 }
Remy Bohmer23cd1382009-07-29 18:18:43 +02002294 return 0;
2295
2296fail:
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03002297 error("%s failed, status = %d", __func__, status);
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002298 eth_unbind(gadget);
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03002299 return status;
Remy Bohmer23cd1382009-07-29 18:18:43 +02002300}
2301
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03002302/*-------------------------------------------------------------------------*/
2303
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002304static int usb_eth_init(struct eth_device *netdev, bd_t *bd)
Remy Bohmer23cd1382009-07-29 18:18:43 +02002305{
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002306 struct eth_dev *dev = &l_ethdev;
Remy Bohmer23cd1382009-07-29 18:18:43 +02002307 struct usb_gadget *gadget;
2308 unsigned long ts;
2309 unsigned long timeout = USB_CONNECT_TIMEOUT;
2310
2311 if (!netdev) {
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +04002312 error("received NULL ptr");
Remy Bohmer23cd1382009-07-29 18:18:43 +02002313 goto fail;
2314 }
Vitaly Kuzmichev58939fc2010-12-28 16:59:32 +03002315
2316 /* Configure default mac-addresses for the USB ethernet device */
2317#ifdef CONFIG_USBNET_DEV_ADDR
2318 strlcpy(dev_addr, CONFIG_USBNET_DEV_ADDR, sizeof(dev_addr));
2319#endif
2320#ifdef CONFIG_USBNET_HOST_ADDR
2321 strlcpy(host_addr, CONFIG_USBNET_HOST_ADDR, sizeof(host_addr));
2322#endif
2323 /* Check if the user overruled the MAC addresses */
2324 if (getenv("usbnet_devaddr"))
2325 strlcpy(dev_addr, getenv("usbnet_devaddr"),
2326 sizeof(dev_addr));
2327
2328 if (getenv("usbnet_hostaddr"))
2329 strlcpy(host_addr, getenv("usbnet_hostaddr"),
2330 sizeof(host_addr));
2331
2332 if (!is_eth_addr_valid(dev_addr)) {
2333 error("Need valid 'usbnet_devaddr' to be set");
2334 goto fail;
2335 }
2336 if (!is_eth_addr_valid(host_addr)) {
2337 error("Need valid 'usbnet_hostaddr' to be set");
2338 goto fail;
2339 }
2340
Lei Wen988ee3e2010-12-01 23:43:43 +08002341 if (usb_gadget_register_driver(&eth_driver) < 0)
2342 goto fail;
Remy Bohmer23cd1382009-07-29 18:18:43 +02002343
2344 dev->network_started = 0;
Remy Bohmer23cd1382009-07-29 18:18:43 +02002345
2346 packet_received = 0;
2347 packet_sent = 0;
2348
2349 gadget = dev->gadget;
2350 usb_gadget_connect(gadget);
2351
2352 if (getenv("cdc_connect_timeout"))
2353 timeout = simple_strtoul(getenv("cdc_connect_timeout"),
2354 NULL, 10) * CONFIG_SYS_HZ;
2355 ts = get_timer(0);
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002356 while (!l_ethdev.network_started) {
Remy Bohmer23cd1382009-07-29 18:18:43 +02002357 /* Handle control-c and timeouts */
2358 if (ctrlc() || (get_timer(ts) > timeout)) {
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +04002359 error("The remote end did not respond in time.");
Remy Bohmer23cd1382009-07-29 18:18:43 +02002360 goto fail;
2361 }
2362 usb_gadget_handle_interrupts();
2363 }
2364
Vitaly Kuzmichev98fae972010-09-22 13:13:56 +04002365 packet_received = 0;
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002366 rx_submit(dev, dev->rx_req, 0);
Remy Bohmer23cd1382009-07-29 18:18:43 +02002367 return 0;
2368fail:
2369 return -1;
2370}
2371
Joe Hershberger10cbe3b2012-05-22 18:36:19 +00002372static int usb_eth_send(struct eth_device *netdev, void *packet, int length)
Remy Bohmer23cd1382009-07-29 18:18:43 +02002373{
2374 int retval;
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03002375 void *rndis_pkt = NULL;
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +04002376 struct eth_dev *dev = &l_ethdev;
Vitaly Kuzmichevac5d32d2010-09-22 13:13:55 +04002377 struct usb_request *req = dev->tx_req;
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002378 unsigned long ts;
2379 unsigned long timeout = USB_CONNECT_TIMEOUT;
Remy Bohmer23cd1382009-07-29 18:18:43 +02002380
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +04002381 debug("%s:...\n", __func__);
Remy Bohmer23cd1382009-07-29 18:18:43 +02002382
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03002383 /* new buffer is needed to include RNDIS header */
2384 if (rndis_active(dev)) {
2385 rndis_pkt = malloc(length +
2386 sizeof(struct rndis_packet_msg_type));
2387 if (!rndis_pkt) {
2388 error("No memory to alloc RNDIS packet");
2389 goto drop;
2390 }
2391 rndis_add_hdr(rndis_pkt, length);
2392 memcpy(rndis_pkt + sizeof(struct rndis_packet_msg_type),
Joe Hershberger10cbe3b2012-05-22 18:36:19 +00002393 packet, length);
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03002394 packet = rndis_pkt;
2395 length += sizeof(struct rndis_packet_msg_type);
2396 }
Joe Hershberger10cbe3b2012-05-22 18:36:19 +00002397 req->buf = packet;
Remy Bohmer23cd1382009-07-29 18:18:43 +02002398 req->context = NULL;
2399 req->complete = tx_complete;
2400
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002401 /*
2402 * use zlp framing on tx for strict CDC-Ether conformance,
Remy Bohmer23cd1382009-07-29 18:18:43 +02002403 * though any robust network rx path ignores extra padding.
2404 * and some hardware doesn't like to write zlps.
2405 */
2406 req->zero = 1;
2407 if (!dev->zlp && (length % dev->in_ep->maxpacket) == 0)
2408 length++;
2409
2410 req->length = length;
2411#if 0
2412 /* throttle highspeed IRQ rate back slightly */
2413 if (gadget_is_dualspeed(dev->gadget))
2414 req->no_interrupt = (dev->gadget->speed == USB_SPEED_HIGH)
2415 ? ((dev->tx_qlen % qmult) != 0) : 0;
2416#endif
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002417 dev->tx_qlen = 1;
2418 ts = get_timer(0);
2419 packet_sent = 0;
Remy Bohmer23cd1382009-07-29 18:18:43 +02002420
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002421 retval = usb_ep_queue(dev->in_ep, req, GFP_ATOMIC);
Remy Bohmer23cd1382009-07-29 18:18:43 +02002422
2423 if (!retval)
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +04002424 debug("%s: packet queued\n", __func__);
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002425 while (!packet_sent) {
2426 if (get_timer(ts) > timeout) {
2427 printf("timeout sending packets to usb ethernet\n");
2428 return -1;
2429 }
2430 usb_gadget_handle_interrupts();
Remy Bohmer23cd1382009-07-29 18:18:43 +02002431 }
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03002432 if (rndis_pkt)
2433 free(rndis_pkt);
Remy Bohmer23cd1382009-07-29 18:18:43 +02002434
2435 return 0;
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03002436drop:
2437 dev->stats.tx_dropped++;
2438 return -ENOMEM;
Remy Bohmer23cd1382009-07-29 18:18:43 +02002439}
2440
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002441static int usb_eth_recv(struct eth_device *netdev)
Remy Bohmer23cd1382009-07-29 18:18:43 +02002442{
2443 struct eth_dev *dev = &l_ethdev;
2444
2445 usb_gadget_handle_interrupts();
2446
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002447 if (packet_received) {
2448 debug("%s: packet received\n", __func__);
2449 if (dev->rx_req) {
2450 NetReceive(NetRxPackets[0], dev->rx_req->length);
2451 packet_received = 0;
Remy Bohmer23cd1382009-07-29 18:18:43 +02002452
Vitaly Kuzmichevac5d32d2010-09-22 13:13:55 +04002453 rx_submit(dev, dev->rx_req, 0);
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002454 } else
2455 error("dev->rx_req invalid");
Remy Bohmer23cd1382009-07-29 18:18:43 +02002456 }
2457 return 0;
2458}
2459
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002460void usb_eth_halt(struct eth_device *netdev)
Remy Bohmer23cd1382009-07-29 18:18:43 +02002461{
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002462 struct eth_dev *dev = &l_ethdev;
Remy Bohmer23cd1382009-07-29 18:18:43 +02002463
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002464 if (!netdev) {
Vitaly Kuzmichev7de73182010-08-13 16:57:51 +04002465 error("received NULL ptr");
Remy Bohmer23cd1382009-07-29 18:18:43 +02002466 return;
2467 }
2468
Lei Wen988ee3e2010-12-01 23:43:43 +08002469 /* If the gadget not registered, simple return */
2470 if (!dev->gadget)
2471 return;
2472
Vitaly Kuzmicheve4ae6662011-02-11 18:18:35 +03002473 /*
2474 * Some USB controllers may need additional deinitialization here
2475 * before dropping pull-up (also due to hardware issues).
2476 * For example: unhandled interrupt with status stage started may
2477 * bring the controller to fully broken state (until board reset).
2478 * There are some variants to debug and fix such cases:
2479 * 1) In the case of RNDIS connection eth_stop can perform additional
2480 * interrupt handling. See RNDIS_COMPLETE_SIGNAL_DISCONNECT definition.
2481 * 2) 'pullup' callback in your UDC driver can be improved to perform
2482 * this deinitialization.
2483 */
Vitaly Kuzmichev7612a432011-02-11 18:18:34 +03002484 eth_stop(dev);
2485
Remy Bohmer23cd1382009-07-29 18:18:43 +02002486 usb_gadget_disconnect(dev->gadget);
Vitaly Kuzmichevb3649f32011-02-11 18:18:31 +03002487
2488 /* Clear pending interrupt */
2489 if (dev->network_started) {
2490 usb_gadget_handle_interrupts();
2491 dev->network_started = 0;
2492 }
2493
Lei Wen988ee3e2010-12-01 23:43:43 +08002494 usb_gadget_unregister_driver(&eth_driver);
Remy Bohmer23cd1382009-07-29 18:18:43 +02002495}
2496
2497static struct usb_gadget_driver eth_driver = {
2498 .speed = DEVSPEED,
2499
2500 .bind = eth_bind,
2501 .unbind = eth_unbind,
2502
2503 .setup = eth_setup,
2504 .disconnect = eth_disconnect,
2505
2506 .suspend = eth_suspend,
2507 .resume = eth_resume,
2508};
2509
2510int usb_eth_initialize(bd_t *bi)
2511{
Vitaly Kuzmichev6142e0a2010-09-13 18:37:11 +04002512 struct eth_device *netdev = &l_netdev;
Remy Bohmer23cd1382009-07-29 18:18:43 +02002513
Vitaly Kuzmichev8f7aa832010-12-28 16:59:31 +03002514 strlcpy(netdev->name, USB_NET_NAME, sizeof(netdev->name));
Remy Bohmer23cd1382009-07-29 18:18:43 +02002515
2516 netdev->init = usb_eth_init;
2517 netdev->send = usb_eth_send;
2518 netdev->recv = usb_eth_recv;
2519 netdev->halt = usb_eth_halt;
2520
2521#ifdef CONFIG_MCAST_TFTP
2522 #error not supported
2523#endif
Remy Bohmer23cd1382009-07-29 18:18:43 +02002524 eth_register(netdev);
2525 return 0;
Remy Bohmer23cd1382009-07-29 18:18:43 +02002526}