patch-2.4.27 linux-2.4.27/drivers/usb/gadget/ether.c
Next file: linux-2.4.27/drivers/usb/gadget/file_storage.c
Previous file: linux-2.4.27/drivers/usb/gadget/epautoconf.c
Back to the patch index
Back to the overall index
- Lines: 2296
- Date:
2004-08-07 16:26:05.691389388 -0700
- Orig file:
linux-2.4.26/drivers/usb/gadget/ether.c
- Orig date:
2004-04-14 06:05:32.000000000 -0700
diff -urN linux-2.4.26/drivers/usb/gadget/ether.c linux-2.4.27/drivers/usb/gadget/ether.c
@@ -1,7 +1,8 @@
/*
* ether.c -- Ethernet gadget driver, with CDC and non-CDC options
*
- * Copyright (C) 2003 David Brownell
+ * Copyright (C) 2003-2004 David Brownell
+ * Copyright (C) 2003-2004 Robert Schwebel, Benedikt Spranger
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -23,8 +24,8 @@
// #define VERBOSE
#include <linux/config.h>
-#include <linux/kernel.h>
#include <linux/module.h>
+#include <linux/kernel.h>
#include <linux/delay.h>
#include <linux/ioport.h>
#include <linux/sched.h>
@@ -37,6 +38,8 @@
#include <linux/interrupt.h>
#include <linux/uts.h>
#include <linux/version.h>
+#include <linux/moduleparam.h>
+#include <linux/ctype.h>
#include <asm/byteorder.h>
#include <asm/io.h>
@@ -53,6 +56,8 @@
#include <linux/etherdevice.h>
#include <linux/ethtool.h>
+#include "gadget_chips.h"
+
/*-------------------------------------------------------------------------*/
/*
@@ -60,39 +65,54 @@
*
* CDC Ethernet is the standard USB solution for sending Ethernet frames
* using USB. Real hardware tends to use the same framing protocol but look
- * different for control features. And Microsoft pushes their own approach
- * (RNDIS) instead of the standard.
+ * different for control features. This driver strongly prefers to use
+ * this USB-IF standard as its open-systems interoperability solution;
+ * most host side USB stacks (except from Microsoft) support it.
*
* There's some hardware that can't talk CDC. We make that hardware
* implement a "minimalist" vendor-agnostic CDC core: same framing, but
* link-level setup only requires activating the configuration.
+ * Linux supports it, but other host operating systems may not.
+ * (This is a subset of CDC Ethernet.)
+ *
+ * A third option is also in use. Rather than CDC Ethernet, or something
+ * simpler, Microsoft pushes their own approach: RNDIS. The published
+ * RNDIS specs are ambiguous and appear to be incomplete, and are also
+ * needlessly complex.
*/
#define DRIVER_DESC "Ethernet Gadget"
-#define DRIVER_VERSION "Bastille Day 2003"
+#define DRIVER_VERSION "St Patrick's Day 2004"
static const char shortname [] = "ether";
static const char driver_desc [] = DRIVER_DESC;
-#define MIN_PACKET sizeof(struct ethhdr)
-#define MAX_PACKET ETH_DATA_LEN /* biggest packet we'll rx/tx */
#define RX_EXTRA 20 /* guard against rx overflows */
-/* FIXME allow high speed jumbograms */
-
-/*-------------------------------------------------------------------------*/
+#ifdef CONFIG_USB_ETH_RNDIS
+#include "rndis.h"
+#else
+#define rndis_init() 0
+#define rndis_exit() do{}while(0)
+#endif
+/* 2.6-compat */
#ifndef container_of
-#define container_of list_entry
+#define container_of list_entry
#endif
-/* 2.5 modified and renamed these */
-#ifndef INIT_WORK
-#define work_struct tq_struct
-#define INIT_WORK INIT_TQUEUE
+#include <linux/tqueue.h>
+#define work_struct tq_struct
+#define INIT_WORK INIT_TQUEUE
#define schedule_work schedule_task
#define flush_scheduled_work flush_scheduled_tasks
-#endif
+
+static void random_ether_addr (u8 *addr)
+{
+ get_random_bytes (addr, ETH_ALEN);
+ addr [0] &= 0xfe; // clear multicast bit
+ addr [0] |= 0x02; // set local assignment bit (IEEE802)
+}
/*-------------------------------------------------------------------------*/
@@ -112,219 +132,147 @@
atomic_t tx_qlen;
struct work_struct work;
+ unsigned zlp:1;
+ unsigned cdc:1;
+ unsigned rndis:1;
+ unsigned suspended:1;
+ u16 cdc_filter;
unsigned long todo;
#define WORK_RX_MEMORY 0
+ int rndis_config;
+ u8 host_mac [ETH_ALEN];
};
+/* This version autoconfigures as much as possible at run-time.
+ *
+ * It also ASSUMES a self-powered device, without remote wakeup,
+ * although remote wakeup support would make sense.
+ */
+static const char *EP_IN_NAME;
+static const char *EP_OUT_NAME;
+static const char *EP_STATUS_NAME;
+
/*-------------------------------------------------------------------------*/
-/* Thanks to NetChip Technologies for donating this product ID.
- *
- * DO NOT REUSE THESE IDs with a protocol-incompatible driver!! Ever!!
+/* DO NOT REUSE THESE IDs with a protocol-incompatible driver!! Ever!!
* Instead: allocate your own, using normal USB-IF procedures.
*/
-#define DRIVER_VENDOR_NUM 0x0525 /* NetChip */
-#define DRIVER_PRODUCT_NUM 0xa4a1 /* Linux-USB Ethernet Gadget */
-/*-------------------------------------------------------------------------*/
+/* Thanks to NetChip Technologies for donating this product ID.
+ * It's for devices with only CDC Ethernet configurations.
+ */
+#define CDC_VENDOR_NUM 0x0525 /* NetChip */
+#define CDC_PRODUCT_NUM 0xa4a1 /* Linux-USB Ethernet Gadget */
-/*
- * hardware-specific configuration, controlled by which device
- * controller driver was configured.
- *
- * CHIP ... hardware identifier
- * DRIVER_VERSION_NUM ... alerts the host side driver to differences
- * EP_*_NAME ... which endpoints do we use for which purpose?
- * EP_*_NUM ... numbers for them (often limited by hardware)
- * WAKEUP ... if hardware supports remote wakeup AND we will issue the
- * usb_gadget_wakeup() call to initiate it, USB_CONFIG_ATT_WAKEUP
- *
- * hw_optimize(gadget) ... for any hardware tweaks we want to kick in
- * before we enable our endpoints
+/* For hardware that can't talk CDC, we use the same vendor ID that
+ * ARM Linux has used for ethernet-over-usb, both with sa1100 and
+ * with pxa250. We're protocol-compatible, if the host-side drivers
+ * use the endpoint descriptors. bcdDevice (version) is nonzero, so
+ * drivers that need to hard-wire endpoint numbers have a hook.
*
- * add other defines for other portability issues, like hardware that
- * for some reason doesn't handle full speed bulk maxpacket of 64.
+ * The protocol is a minimal subset of CDC Ether, which works on any bulk
+ * hardware that's not deeply broken ... even on hardware that can't talk
+ * RNDIS (like SA-1100, with no interrupt endpoint, or anything that
+ * doesn't handle control-OUT).
*/
+#define SIMPLE_VENDOR_NUM 0x049f
+#define SIMPLE_PRODUCT_NUM 0x505a
-#define DEV_CONFIG_VALUE 3 /* some hardware cares */
-
-/* #undef on hardware that can't implement CDC */
-#define DEV_CONFIG_CDC
+/* For hardware that can talk RNDIS and either of the above protocols,
+ * use this ID ... the windows INF files will know it. Unless it's
+ * used with CDC Ethernet, Linux 2.4 hosts will need updates to choose
+ * the non-RNDIS configuration.
+ */
+#define RNDIS_VENDOR_NUM 0x0525 /* NetChip */
+#define RNDIS_PRODUCT_NUM 0xa4a2 /* Ethernet/RNDIS Gadget */
-/* undef on bus-powered hardware, and #define MAX_USB_POWER */
-#define SELFPOWER
-/*
- * NetChip 2280, PCI based.
- *
- * use DMA with fat fifos for all data traffic, PIO for the status channel
- * where its 64 byte maxpacket ceiling is no issue.
- *
- * performance note: only PIO needs per-usb-packet IRQs (ep0, ep-e, ep-f)
- * otherwise IRQs are per-Ethernet-packet unless TX_DELAY and chaining help.
+/* Some systems will want different product identifers published in the
+ * device descriptor, either numbers or strings or both. These string
+ * parameters are in UTF-8 (superset of ASCII's 7 bit characters).
*/
-#ifdef CONFIG_USB_GADGET_NET2280
-#define CHIP "net2280"
-#define DEFAULT_QLEN 4 /* has dma chaining */
-#define DRIVER_VERSION_NUM 0x0111
-static const char EP_OUT_NAME [] = "ep-a";
-#define EP_OUT_NUM 1
-static const char EP_IN_NAME [] = "ep-b";
-#define EP_IN_NUM 2
-static const char EP_STATUS_NAME [] = "ep-f";
-#define EP_STATUS_NUM 3
-/* supports remote wakeup, but this driver doesn't */
-extern int net2280_set_fifo_mode (struct usb_gadget *gadget, int mode);
+static ushort __initdata idVendor;
+module_param(idVendor, ushort, 0);
+MODULE_PARM_DESC(idVendor, "USB Vendor ID");
-static inline void hw_optimize (struct usb_gadget *gadget)
-{
- /* we can have bigger ep-a/ep-b fifos (2KB each, 4 USB packets
- * for highspeed bulk) because we're not using ep-c/ep-d.
- */
- net2280_set_fifo_mode (gadget, 1);
-}
-#endif
+static ushort __initdata idProduct;
+module_param(idProduct, ushort, 0);
+MODULE_PARM_DESC(idProduct, "USB Product ID");
-/*
- * PXA-2xx UDC: widely used in second gen Linux-capable ARM PDAs
- * and other products. The IXP-42x UDC is register-compatible.
- *
- * multiple interfaces (or altsettings) aren't usable. so this hardware
- * can't implement CDC, which needs both capabilities.
- */
-#ifdef CONFIG_USB_GADGET_PXA2XX
-#undef DEV_CONFIG_CDC
-#define CHIP "pxa2xx"
-#define DRIVER_VERSION_NUM 0x0113
-static const char EP_OUT_NAME [] = "ep2out-bulk";
-#define EP_OUT_NUM 2
-static const char EP_IN_NAME [] = "ep1in-bulk";
-#define EP_IN_NUM 1
-/* supports remote wakeup, but this driver doesn't */
+static ushort __initdata bcdDevice;
+module_param(bcdDevice, ushort, 0);
+MODULE_PARM_DESC(bcdDevice, "USB Device version (BCD)");
-/* no hw optimizations to apply */
-#define hw_optimize(g) do {} while (0)
-#endif
+static char *__initdata iManufacturer;
+MODULE_PARM(iManufacturer, "s");
+MODULE_PARM_DESC(iManufacturer, "USB Manufacturer string");
-/*
- * SA-1100 UDC: widely used in first gen Linux-capable PDAs.
- *
- * can't have a notification endpoint, since there are only the two
- * bulk-capable ones. the CDC spec allows that.
- */
-#ifdef CONFIG_USB_GADGET_SA1100
-#define CHIP "sa1100"
-#define DRIVER_VERSION_NUM 0x0115
-static const char EP_OUT_NAME [] = "ep1out-bulk";
-#define EP_OUT_NUM 1
-static const char EP_IN_NAME [] = "ep2in-bulk";
-#define EP_IN_NUM 2
-// EP_STATUS_NUM is undefined
-/* doesn't support remote wakeup? */
+static char *__initdata iProduct;
+MODULE_PARM(iProduct, "s");
+MODULE_PARM_DESC(iProduct, "USB Product string");
-/* no hw optimizations to apply */
-#define hw_optimize(g) do {} while (0)
-#endif
+/* initial value, changed by "ifconfig usb0 hw ether xx:xx:xx:xx:xx:xx" */
+static char *__initdata dev_addr;
+MODULE_PARM(dev_addr, "s");
+MODULE_PARM_DESC(dev_addr, "Device Ethernet Address");
-/*
- * Toshiba TC86C001 ("Goku-S") UDC
- *
- * This has three semi-configurable full speed bulk/interrupt endpoints.
- */
-#ifdef CONFIG_USB_GADGET_GOKU
-#define CHIP "goku"
-#define DRIVER_VERSION_NUM 0x0116
-static const char EP_OUT_NAME [] = "ep1-bulk";
-#define EP_OUT_NUM 1
-static const char EP_IN_NAME [] = "ep2-bulk";
-#define EP_IN_NUM 2
-static const char EP_STATUS_NAME [] = "ep3-bulk";
-#define EP_STATUS_NUM 3
-/* doesn't support remote wakeup */
+/* this address is invisible to ifconfig */
+static char *__initdata host_addr;
+MODULE_PARM(host_addr, "s");
+MODULE_PARM_DESC(host_addr, "Host Ethernet Address");
+
+
+/*-------------------------------------------------------------------------*/
-#define hw_optimize(g) do {} while (0)
+/* Include CDC support if we could run on CDC-capable hardware. */
+
+#ifdef CONFIG_USB_GADGET_NET2280
+#define DEV_CONFIG_CDC
#endif
-/*
- * SuperH UDC: UDC built-in to some Renesas SH processors.
- *
- * This has three semi-configurable full speed bulk/interrupt endpoints.
- *
- * Only one configuration and interface is supported. So this hardware
- * can't implement CDC.
- */
-#ifdef CONFIG_USB_GADGET_SUPERH
-#undef DEV_CONFIG_CDC
-#define CHIP "superh"
-#define DRIVER_VERSION_NUM 0x0117
-static const char EP_OUT_NAME[] = "ep1out-bulk";
-#define EP_OUT_NUM 1
-static const char EP_IN_NAME[] = "ep2in-bulk";
-#define EP_IN_NUM 2
+#ifdef CONFIG_USB_GADGET_DUMMY_HCD
+#define DEV_CONFIG_CDC
+#endif
-#define hw_optimize(g) do {} while (0)
+#ifdef CONFIG_USB_GADGET_GOKU
+#define DEV_CONFIG_CDC
#endif
-/*-------------------------------------------------------------------------*/
+#ifdef CONFIG_USB_GADGET_MQ11XX
+#define DEV_CONFIG_CDC
+#endif
-#ifndef CHIP
-# error Configure some USB peripheral controller driver!
+#ifdef CONFIG_USB_GADGET_OMAP
+#define DEV_CONFIG_CDC
#endif
-/* We normally expect hardware that can talk CDC. That involves
- * using multiple interfaces and altsettings, and maybe a status
- * interrupt. Driver binding to be done according to USB-IF class,
- * though you can use different VENDOR and PRODUCT numbers if you
- * want (and they're officially assigned).
- *
- * For hardware that can't talk CDC, we use the same vendor ID that
- * ARM Linux has used for ethernet-over-usb, both with sa1100 and
- * with pxa250. We're protocol-compatible, if the host-side drivers
- * use the endpoint descriptors. DRIVER_VERSION_NUM is nonzero, so
- * drivers that need to hard-wire endpoint numbers have a hook.
+
+/* For CDC-incapable hardware, choose the simple cdc subset.
+ * Anything that talks bulk (without notable bugs) can do this.
*/
-#ifdef DEV_CONFIG_CDC
-#define DEV_CONFIG_CLASS USB_CLASS_COMM
-#else
-#define DEV_CONFIG_CLASS USB_CLASS_VENDOR_SPEC
-#undef EP_STATUS_NUM
-#undef DRIVER_VENDOR_NUM
-#undef DRIVER_PRODUCT_NUM
-#define DRIVER_VENDOR_NUM 0x049f
-#define DRIVER_PRODUCT_NUM 0x505a
-#endif /* CONFIG_CDC_ETHER */
-
-/* power usage is config specific.
- * hardware that supports remote wakeup defaults to disabling it.
- */
-
-#ifndef MAX_USB_POWER
-#ifdef SELFPOWER
-/* some hosts are confused by 0mA */
-#define MAX_USB_POWER 2 /* mA */
-#else
-/* bus powered */
-#error Define your bus power consumption!
+#ifdef CONFIG_USB_GADGET_PXA2XX
+#define DEV_CONFIG_SUBSET
+#endif
+
+#ifdef CONFIG_USB_GADGET_SH
+#define DEV_CONFIG_SUBSET
#endif
-#endif /* MAX_USB_POWER */
-#ifndef WAKEUP
-/* default: this driver won't do remote wakeup */
-#define WAKEUP 0
-/* else value must be USB_CONFIG_ATT_WAKEUP */
+#ifdef CONFIG_USB_GADGET_SA1100
+/* use non-CDC for backwards compatibility */
+#define DEV_CONFIG_SUBSET
#endif
+
/*-------------------------------------------------------------------------*/
-#ifndef DEFAULT_QLEN
#define DEFAULT_QLEN 2 /* double buffering by default */
-#endif
#ifdef CONFIG_USB_GADGET_DUALSPEED
static unsigned qmult = 5;
-MODULE_PARM (qmult, "i");
+module_param (qmult, uint, 0);
/* for dual-speed hardware, use deeper queues at highspeed */
@@ -332,10 +280,14 @@
(DEFAULT_QLEN*((gadget->speed == USB_SPEED_HIGH) ? qmult : 1))
/* also defer IRQs on highspeed TX */
-#define TX_DELAY DEFAULT_QLEN
+#define TX_DELAY qmult
+
+#define BITRATE(g) ((g->speed == USB_SPEED_HIGH) ? 4800000 : 120000)
#else /* full speed (low speed doesn't do bulk) */
#define qlen(gadget) DEFAULT_QLEN
+
+#define BITRATE(g) (12000)
#endif
@@ -376,8 +328,13 @@
/*
* DESCRIPTORS ... most are static, but strings and (full) configuration
- * descriptors are built on demand. Notice how most of the cdc descriptors
- * aren't needed in the "minimalist" mode.
+ * descriptors are built on demand. For now we do either full CDC, or
+ * our simple subset, with RNDIS as an optional second configuration.
+ *
+ * RNDIS includes some CDC ACM descriptors ... like CDC Ethernet. But
+ * the class descriptors match a modem (they're ignored; it's really just
+ * Ethernet functionality), they don't need the NOP altsetting, and the
+ * status transfer endpoint isn't optional.
*/
#define STRING_MANUFACTURER 1
@@ -385,12 +342,24 @@
#define STRING_ETHADDR 3
#define STRING_DATA 4
#define STRING_CONTROL 5
+#define STRING_RNDIS_CONTROL 6
+#define STRING_CDC 7
+#define STRING_SUBSET 8
+#define STRING_RNDIS 9
#define USB_BUFSIZ 256 /* holds our biggest descriptor */
/*
- * This device advertises one configuration.
+ * This device advertises one configuration, eth_config, unless RNDIS
+ * is enabled (rndis_config) on hardware supporting at least two configs.
+ *
+ * NOTE: Controllers like superh_udc should probably be able to use
+ * an RNDIS-only configuration.
*/
+
+#define DEV_CONFIG_VALUE 1 /* cdc or subset */
+#define DEV_RNDIS_CONFIG_VALUE 2 /* rndis; optional */
+
static struct usb_device_descriptor
device_desc = {
.bLength = sizeof device_desc,
@@ -398,13 +367,12 @@
.bcdUSB = __constant_cpu_to_le16 (0x0200),
- .bDeviceClass = DEV_CONFIG_CLASS,
+ .bDeviceClass = USB_CLASS_COMM,
.bDeviceSubClass = 0,
.bDeviceProtocol = 0,
- .idVendor = __constant_cpu_to_le16 (DRIVER_VENDOR_NUM),
- .idProduct = __constant_cpu_to_le16 (DRIVER_PRODUCT_NUM),
- .bcdDevice = __constant_cpu_to_le16 (DRIVER_VERSION_NUM),
+ .idVendor = __constant_cpu_to_le16 (CDC_VENDOR_NUM),
+ .idProduct = __constant_cpu_to_le16 (CDC_PRODUCT_NUM),
.iManufacturer = STRING_MANUFACTURER,
.iProduct = STRING_PRODUCT,
.bNumConfigurations = 1,
@@ -416,44 +384,70 @@
.bDescriptorType = USB_DT_CONFIG,
/* compute wTotalLength on the fly */
-#ifdef DEV_CONFIG_CDC
.bNumInterfaces = 2,
-#else
- .bNumInterfaces = 1,
-#endif
.bConfigurationValue = DEV_CONFIG_VALUE,
- .iConfiguration = STRING_PRODUCT,
- .bmAttributes = USB_CONFIG_ATT_ONE | WAKEUP,
- .bMaxPower = (MAX_USB_POWER + 1) / 2,
+ .iConfiguration = STRING_CDC,
+ .bmAttributes = USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER,
+ .bMaxPower = 1,
};
-#ifdef DEV_CONFIG_CDC
+#ifdef CONFIG_USB_ETH_RNDIS
+static const struct usb_config_descriptor
+rndis_config = {
+ .bLength = sizeof rndis_config,
+ .bDescriptorType = USB_DT_CONFIG,
+
+ /* compute wTotalLength on the fly */
+ .bNumInterfaces = 2,
+ .bConfigurationValue = DEV_RNDIS_CONFIG_VALUE,
+ .iConfiguration = STRING_RNDIS,
+ .bmAttributes = USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER,
+ .bMaxPower = 1,
+};
+#endif
/*
- * Compared to the "minimalist" non-CDC model, the CDC model adds
- * three class descriptors, two interface descrioptors, and a status
+ * Compared to the simple CDC subset, the full CDC Ethernet model adds
+ * three class descriptors, two interface descriptors, optional status
* endpoint. Both have a "data" interface and two bulk endpoints.
* There are also differences in how control requests are handled.
+ *
+ * RNDIS shares a lot with CDC-Ethernet, since it's a variant of
+ * the CDC-ACM (modem) spec.
*/
-/* master comm interface optionally has a status notification endpoint */
-
-static const struct usb_interface_descriptor
+#ifdef DEV_CONFIG_CDC
+static struct usb_interface_descriptor
control_intf = {
.bLength = sizeof control_intf,
.bDescriptorType = USB_DT_INTERFACE,
.bInterfaceNumber = 0,
-#ifdef EP_STATUS_NUM
+ /* status endpoint is optional; this may be patched later */
.bNumEndpoints = 1,
-#else
- .bNumEndpoints = 0,
-#endif
.bInterfaceClass = USB_CLASS_COMM,
.bInterfaceSubClass = 6, /* ethernet control model */
.bInterfaceProtocol = 0,
.iInterface = STRING_CONTROL,
};
+#endif
+
+#ifdef CONFIG_USB_ETH_RNDIS
+static const struct usb_interface_descriptor
+rndis_control_intf = {
+ .bLength = sizeof rndis_control_intf,
+ .bDescriptorType = USB_DT_INTERFACE,
+
+ .bInterfaceNumber = 0,
+ .bNumEndpoints = 1,
+ .bInterfaceClass = USB_CLASS_COMM,
+ .bInterfaceSubClass = 2, /* abstract control model */
+ .bInterfaceProtocol = 0xff, /* vendor specific */
+ .iInterface = STRING_RNDIS_CONTROL,
+};
+#endif
+
+#if defined(DEV_CONFIG_CDC) || defined(CONFIG_USB_ETH_RNDIS)
/* "Header Functional Descriptor" from CDC spec 5.2.3.1 */
struct header_desc {
@@ -466,13 +460,13 @@
static const struct header_desc header_desc = {
.bLength = sizeof header_desc,
- .bDescriptorType = 0x24,
+ .bDescriptorType = USB_DT_CS_INTERFACE,
.bDescriptorSubType = 0,
.bcdCDC = __constant_cpu_to_le16 (0x0110),
};
-/* "Union Functional Descriptor" from CDC spec 5.2.3.X */
+/* "Union Functional Descriptor" from CDC spec 5.2.3.8 */
struct union_desc {
u8 bLength;
u8 bDescriptorType;
@@ -485,13 +479,58 @@
static const struct union_desc union_desc = {
.bLength = sizeof union_desc,
- .bDescriptorType = 0x24,
+ .bDescriptorType = USB_DT_CS_INTERFACE,
.bDescriptorSubType = 6,
.bMasterInterface0 = 0, /* index of control interface */
.bSlaveInterface0 = 1, /* index of DATA interface */
};
+#endif /* CDC || RNDIS */
+
+#ifdef CONFIG_USB_ETH_RNDIS
+
+/* "Call Management Descriptor" from CDC spec 5.2.3.3 */
+struct call_mgmt_descriptor {
+ u8 bLength;
+ u8 bDescriptorType;
+ u8 bDescriptorSubType;
+
+ u8 bmCapabilities;
+ u8 bDataInterface;
+} __attribute__ ((packed));
+
+static const struct call_mgmt_descriptor call_mgmt_descriptor = {
+ .bLength = sizeof call_mgmt_descriptor,
+ .bDescriptorType = USB_DT_CS_INTERFACE,
+ .bDescriptorSubType = 0x01,
+
+ .bmCapabilities = 0x00,
+ .bDataInterface = 0x01,
+};
+
+
+/* "Abstract Control Management Descriptor" from CDC spec 5.2.3.4 */
+struct acm_descriptor {
+ u8 bLength;
+ u8 bDescriptorType;
+ u8 bDescriptorSubType;
+
+ u8 bmCapabilities;
+} __attribute__ ((packed));
+
+static struct acm_descriptor acm_descriptor = {
+ .bLength = sizeof acm_descriptor,
+ .bDescriptorType = USB_DT_CS_INTERFACE,
+ .bDescriptorSubType = 0x02,
+
+ .bmCapabilities = 0X00,
+};
+
+#endif
+
+#ifdef DEV_CONFIG_CDC
+
/* "Ethernet Networking Functional Descriptor" from CDC spec 5.2.3.16 */
struct ether_desc {
u8 bLength;
@@ -507,41 +546,53 @@
static const struct ether_desc ether_desc = {
.bLength = sizeof ether_desc,
- .bDescriptorType = 0x24,
+ .bDescriptorType = USB_DT_CS_INTERFACE,
.bDescriptorSubType = 0x0f,
/* this descriptor actually adds value, surprise! */
.iMACAddress = STRING_ETHADDR,
.bmEthernetStatistics = __constant_cpu_to_le32 (0), /* no statistics */
- .wMaxSegmentSize = __constant_cpu_to_le16 (MAX_PACKET + ETH_HLEN),
+ .wMaxSegmentSize = __constant_cpu_to_le16 (ETH_FRAME_LEN),
.wNumberMCFilters = __constant_cpu_to_le16 (0),
.bNumberPowerFilters = 0,
};
-#ifdef EP_STATUS_NUM
+#endif
-/* include the status endpoint if we can, even though it's optional.
+#if defined(DEV_CONFIG_CDC) || defined(CONFIG_USB_ETH_RNDIS)
+
+/* include the status endpoint if we can, even where it's optional.
+ * use small wMaxPacketSize, since many "interrupt" endpoints have
+ * very small fifos and it's no big deal if CDC_NOTIFY_SPEED_CHANGE
+ * takes two packets. also default to a big transfer interval, to
+ * waste less bandwidth.
*
- * some drivers (like current Linux cdc-ether!) "need" it to exist even
+ * some drivers (like Linux 2.4 cdc-ether!) "need" it to exist even
* if they ignore the connect/disconnect notifications that real aether
* can provide. more advanced cdc configurations might want to support
* encapsulated commands (vendor-specific, using control-OUT).
+ *
+ * RNDIS requires the status endpoint, since it uses that encapsulation
+ * mechanism for its funky RPC scheme.
*/
-#define LOG2_STATUS_INTERVAL_MSEC 6
-#define STATUS_BYTECOUNT 16 /* 8 byte header + data */
-static const struct usb_endpoint_descriptor
+#define LOG2_STATUS_INTERVAL_MSEC 5 /* 1 << 5 == 32 msec */
+#define STATUS_BYTECOUNT 8 /* 8 byte header + data */
+
+static struct usb_endpoint_descriptor
fs_status_desc = {
.bLength = USB_DT_ENDPOINT_SIZE,
.bDescriptorType = USB_DT_ENDPOINT,
- .bEndpointAddress = EP_STATUS_NUM | USB_DIR_IN,
+ .bEndpointAddress = USB_DIR_IN,
.bmAttributes = USB_ENDPOINT_XFER_INT,
.wMaxPacketSize = __constant_cpu_to_le16 (STATUS_BYTECOUNT),
.bInterval = 1 << LOG2_STATUS_INTERVAL_MSEC,
};
#endif
+#ifdef DEV_CONFIG_CDC
+
/* the default data interface has no endpoints ... */
static const struct usb_interface_descriptor
@@ -555,10 +606,9 @@
.bInterfaceClass = USB_CLASS_CDC_DATA,
.bInterfaceSubClass = 0,
.bInterfaceProtocol = 0,
- .iInterface = STRING_DATA,
};
-/* ... but the "real" data interface has two full speed bulk endpoints */
+/* ... but the "real" data interface has two bulk endpoints */
static const struct usb_interface_descriptor
data_intf = {
@@ -573,16 +623,39 @@
.bInterfaceProtocol = 0,
.iInterface = STRING_DATA,
};
-#else
+
+#endif
+
+#ifdef CONFIG_USB_ETH_RNDIS
+
+/* RNDIS doesn't activate by changing to the "real" altsetting */
+
+static const struct usb_interface_descriptor
+rndis_data_intf = {
+ .bLength = sizeof rndis_data_intf,
+ .bDescriptorType = USB_DT_INTERFACE,
+
+ .bInterfaceNumber = 1,
+ .bAlternateSetting = 0,
+ .bNumEndpoints = 2,
+ .bInterfaceClass = USB_CLASS_CDC_DATA,
+ .bInterfaceSubClass = 0,
+ .bInterfaceProtocol = 0,
+ .iInterface = STRING_DATA,
+};
+
+#endif
+
+#ifdef DEV_CONFIG_SUBSET
/*
- * "Minimalist" non-CDC option is a simple vendor-neutral model that most
+ * "Simple" CDC-subset option is a simple vendor-neutral model that most
* full speed controllers can handle: one interface, two bulk endpoints.
*/
static const struct usb_interface_descriptor
-data_intf = {
- .bLength = sizeof data_intf,
+subset_data_intf = {
+ .bLength = sizeof subset_data_intf,
.bDescriptorType = USB_DT_INTERFACE,
.bInterfaceNumber = 0,
@@ -594,47 +667,73 @@
.iInterface = STRING_DATA,
};
-#endif /* DEV_CONFIG_CDC */
+#endif /* SUBSET */
-static const struct usb_endpoint_descriptor
+static struct usb_endpoint_descriptor
fs_source_desc = {
.bLength = USB_DT_ENDPOINT_SIZE,
.bDescriptorType = USB_DT_ENDPOINT,
- .bEndpointAddress = EP_IN_NUM | USB_DIR_IN,
+ .bEndpointAddress = USB_DIR_IN,
.bmAttributes = USB_ENDPOINT_XFER_BULK,
- .wMaxPacketSize = __constant_cpu_to_le16 (64),
};
-static const struct usb_endpoint_descriptor
+static struct usb_endpoint_descriptor
fs_sink_desc = {
.bLength = USB_DT_ENDPOINT_SIZE,
.bDescriptorType = USB_DT_ENDPOINT,
- .bEndpointAddress = EP_OUT_NUM,
+ .bEndpointAddress = USB_DIR_OUT,
.bmAttributes = USB_ENDPOINT_XFER_BULK,
- .wMaxPacketSize = __constant_cpu_to_le16 (64),
};
-static const struct usb_descriptor_header *fs_function [] = {
+static const struct usb_descriptor_header *fs_eth_function [10] = {
#ifdef DEV_CONFIG_CDC
/* "cdc" mode descriptors */
(struct usb_descriptor_header *) &control_intf,
(struct usb_descriptor_header *) &header_desc,
(struct usb_descriptor_header *) &union_desc,
(struct usb_descriptor_header *) ðer_desc,
-#ifdef EP_STATUS_NUM
+ /* NOTE: status endpoint may need to be removed */
(struct usb_descriptor_header *) &fs_status_desc,
-#endif
+ /* data interface, with altsetting */
(struct usb_descriptor_header *) &data_nop_intf,
-#endif /* DEV_CONFIG_CDC */
- /* minimalist core */
(struct usb_descriptor_header *) &data_intf,
(struct usb_descriptor_header *) &fs_source_desc,
(struct usb_descriptor_header *) &fs_sink_desc,
0,
+#endif /* DEV_CONFIG_CDC */
+};
+
+static inline void __init fs_subset_descriptors(void)
+{
+#ifdef DEV_CONFIG_SUBSET
+ fs_eth_function[0] = (struct usb_descriptor_header *) &subset_data_intf;
+ fs_eth_function[1] = (struct usb_descriptor_header *) &fs_source_desc;
+ fs_eth_function[2] = (struct usb_descriptor_header *) &fs_sink_desc;
+ fs_eth_function[3] = 0;
+#else
+ fs_eth_function[0] = 0;
+#endif
+}
+
+#ifdef CONFIG_USB_ETH_RNDIS
+static const struct usb_descriptor_header *fs_rndis_function [] = {
+ /* control interface matches ACM, not Ethernet */
+ (struct usb_descriptor_header *) &rndis_control_intf,
+ (struct usb_descriptor_header *) &header_desc,
+ (struct usb_descriptor_header *) &call_mgmt_descriptor,
+ (struct usb_descriptor_header *) &acm_descriptor,
+ (struct usb_descriptor_header *) &union_desc,
+ (struct usb_descriptor_header *) &fs_status_desc,
+ /* data interface has no altsetting */
+ (struct usb_descriptor_header *) &rndis_data_intf,
+ (struct usb_descriptor_header *) &fs_source_desc,
+ (struct usb_descriptor_header *) &fs_sink_desc,
+ 0,
};
+#endif
#ifdef CONFIG_USB_GADGET_DUALSPEED
@@ -643,39 +742,34 @@
* descriptors, unless they only run at full speed.
*/
-#ifdef EP_STATUS_NUM
-static const struct usb_endpoint_descriptor
+#if defined(DEV_CONFIG_CDC) || defined(CONFIG_USB_ETH_RNDIS)
+static struct usb_endpoint_descriptor
hs_status_desc = {
.bLength = USB_DT_ENDPOINT_SIZE,
.bDescriptorType = USB_DT_ENDPOINT,
- .bEndpointAddress = EP_STATUS_NUM | USB_DIR_IN,
.bmAttributes = USB_ENDPOINT_XFER_INT,
.wMaxPacketSize = __constant_cpu_to_le16 (STATUS_BYTECOUNT),
- .bInterval = LOG2_STATUS_INTERVAL_MSEC + 3,
+ .bInterval = LOG2_STATUS_INTERVAL_MSEC + 4,
};
-#endif
+#endif /* DEV_CONFIG_CDC */
-static const struct usb_endpoint_descriptor
+static struct usb_endpoint_descriptor
hs_source_desc = {
.bLength = USB_DT_ENDPOINT_SIZE,
.bDescriptorType = USB_DT_ENDPOINT,
- .bEndpointAddress = EP_IN_NUM | USB_DIR_IN,
.bmAttributes = USB_ENDPOINT_XFER_BULK,
.wMaxPacketSize = __constant_cpu_to_le16 (512),
- .bInterval = 1,
};
-static const struct usb_endpoint_descriptor
+static struct usb_endpoint_descriptor
hs_sink_desc = {
.bLength = USB_DT_ENDPOINT_SIZE,
.bDescriptorType = USB_DT_ENDPOINT,
- .bEndpointAddress = EP_OUT_NUM,
.bmAttributes = USB_ENDPOINT_XFER_BULK,
.wMaxPacketSize = __constant_cpu_to_le16 (512),
- .bInterval = 1,
};
static struct usb_qualifier_descriptor
@@ -684,29 +778,57 @@
.bDescriptorType = USB_DT_DEVICE_QUALIFIER,
.bcdUSB = __constant_cpu_to_le16 (0x0200),
- .bDeviceClass = DEV_CONFIG_CLASS,
+ .bDeviceClass = USB_CLASS_COMM,
.bNumConfigurations = 1,
};
-static const struct usb_descriptor_header *hs_function [] = {
+static const struct usb_descriptor_header *hs_eth_function [10] = {
#ifdef DEV_CONFIG_CDC
/* "cdc" mode descriptors */
(struct usb_descriptor_header *) &control_intf,
(struct usb_descriptor_header *) &header_desc,
(struct usb_descriptor_header *) &union_desc,
(struct usb_descriptor_header *) ðer_desc,
-#ifdef EP_STATUS_NUM
+ /* NOTE: status endpoint may need to be removed */
(struct usb_descriptor_header *) &hs_status_desc,
-#endif
+ /* data interface, with altsetting */
(struct usb_descriptor_header *) &data_nop_intf,
-#endif /* DEV_CONFIG_CDC */
- /* minimalist core */
(struct usb_descriptor_header *) &data_intf,
(struct usb_descriptor_header *) &hs_source_desc,
(struct usb_descriptor_header *) &hs_sink_desc,
0,
+#endif /* DEV_CONFIG_CDC */
+};
+
+static inline void __init hs_subset_descriptors(void)
+{
+#ifdef DEV_CONFIG_SUBSET
+ hs_eth_function[0] = (struct usb_descriptor_header *) &subset_data_intf;
+ hs_eth_function[1] = (struct usb_descriptor_header *) &fs_source_desc;
+ hs_eth_function[2] = (struct usb_descriptor_header *) &fs_sink_desc;
+ hs_eth_function[3] = 0;
+#else
+ hs_eth_function[0] = 0;
+#endif
+}
+
+#ifdef CONFIG_USB_ETH_RNDIS
+static const struct usb_descriptor_header *hs_rndis_function [] = {
+ /* control interface matches ACM, not Ethernet */
+ (struct usb_descriptor_header *) &rndis_control_intf,
+ (struct usb_descriptor_header *) &header_desc,
+ (struct usb_descriptor_header *) &call_mgmt_descriptor,
+ (struct usb_descriptor_header *) &acm_descriptor,
+ (struct usb_descriptor_header *) &union_desc,
+ (struct usb_descriptor_header *) &hs_status_desc,
+ /* data interface has no altsetting */
+ (struct usb_descriptor_header *) &rndis_data_intf,
+ (struct usb_descriptor_header *) &hs_source_desc,
+ (struct usb_descriptor_header *) &hs_sink_desc,
+ 0,
};
+#endif
/* maxpacket and other transfer characteristics vary by speed. */
@@ -717,12 +839,19 @@
/* if there's no high speed support, maxpacket doesn't change. */
#define ep_desc(g,hs,fs) fs
+static inline void __init hs_subset_descriptors(void)
+{
+}
+
#endif /* !CONFIG_USB_GADGET_DUALSPEED */
/*-------------------------------------------------------------------------*/
/* descriptors that are built on-demand */
+static char manufacturer [40];
+static char product_desc [40] = DRIVER_DESC;
+
#ifdef DEV_CONFIG_CDC
/* address that the host will use ... usually assigned at random */
static char ethaddr [2 * ETH_ALEN + 1];
@@ -730,13 +859,21 @@
/* static strings, in iso 8859/1 */
static struct usb_string strings [] = {
- { STRING_MANUFACTURER, UTS_SYSNAME " " UTS_RELEASE "/" CHIP, },
- { STRING_PRODUCT, driver_desc, },
+ { STRING_MANUFACTURER, manufacturer, },
+ { STRING_PRODUCT, product_desc, },
+ { STRING_DATA, "Ethernet Data", },
#ifdef DEV_CONFIG_CDC
+ { STRING_CDC, "CDC Ethernet", },
{ STRING_ETHADDR, ethaddr, },
{ STRING_CONTROL, "CDC Communications Control", },
#endif
- { STRING_DATA, "Ethernet Data", },
+#ifdef DEV_CONFIG_SUBSET
+ { STRING_SUBSET, "CDC Ethernet Subset", },
+#endif
+#ifdef CONFIG_USB_ETH_RNDIS
+ { STRING_RNDIS, "RNDIS", },
+ { STRING_RNDIS_CONTROL, "RNDIS Communications Control", },
+#endif
{ } /* end of list */
};
@@ -753,20 +890,34 @@
config_buf (enum usb_device_speed speed, u8 *buf, u8 type, unsigned index)
{
int len;
- const struct usb_descriptor_header **function = fs_function;
#ifdef CONFIG_USB_GADGET_DUALSPEED
int hs = (speed == USB_SPEED_HIGH);
if (type == USB_DT_OTHER_SPEED_CONFIG)
hs = !hs;
- if (hs)
- function = hs_function;
+#define which_config(t) (hs ? & t ## _config : & t ## _config)
+#define which_fn(t) (hs ? & hs_ ## t ## _function : & fs_ ## t ## _function)
+#else
+#define which_config(t) (& t ## _config)
+#define which_fn(t) (& fs_ ## t ## _function)
#endif
- /* a single configuration must always be index 0 */
- if (index > 0)
+ if (index >= device_desc.bNumConfigurations)
return -EINVAL;
- len = usb_gadget_config_buf (ð_config, buf, USB_BUFSIZ, function);
+
+#ifdef CONFIG_USB_ETH_RNDIS
+ /* list the RNDIS config first, to make Microsoft's drivers
+ * happy. DOCSIS 1.0 needs this too.
+ */
+ if (device_desc.bNumConfigurations == 2 && index == 0)
+ len = usb_gadget_config_buf (which_config (rndis), buf,
+ USB_BUFSIZ, (const struct usb_descriptor_header **)
+ which_fn (rndis));
+ else
+#endif
+ len = usb_gadget_config_buf (which_config (eth), buf,
+ USB_BUFSIZ, (const struct usb_descriptor_header **)
+ which_fn (eth));
if (len < 0)
return len;
((struct usb_config_descriptor *) buf)->bDescriptorType = type;
@@ -778,6 +929,91 @@
static void eth_start (struct eth_dev *dev, int gfp_flags);
static int alloc_requests (struct eth_dev *dev, unsigned n, int gfp_flags);
+#ifdef DEV_CONFIG_CDC
+static inline int ether_alt_ep_setup (struct eth_dev *dev, struct usb_ep *ep)
+{
+ const struct usb_endpoint_descriptor *d;
+
+ /* With CDC, the host isn't allowed to use these two data
+ * endpoints in the default altsetting for the interface.
+ * so we don't activate them yet. Reset from SET_INTERFACE.
+ *
+ * Strictly speaking RNDIS should work the same: activation is
+ * a side effect of setting a packet filter. Deactivation is
+ * from REMOTE_NDIS_HALT_MSG, reset from REMOTE_NDIS_RESET_MSG.
+ */
+
+ /* one endpoint writes data back IN to the host */
+ if (strcmp (ep->name, EP_IN_NAME) == 0) {
+ d = ep_desc (dev->gadget, &hs_source_desc, &fs_source_desc);
+ ep->driver_data = dev;
+ dev->in_ep = ep;
+ dev->in = d;
+
+ /* one endpoint just reads OUT packets */
+ } else if (strcmp (ep->name, EP_OUT_NAME) == 0) {
+ d = ep_desc (dev->gadget, &hs_sink_desc, &fs_sink_desc);
+ ep->driver_data = dev;
+ dev->out_ep = ep;
+ dev->out = d;
+
+ /* optional status/notification endpoint */
+ } else if (EP_STATUS_NAME &&
+ strcmp (ep->name, EP_STATUS_NAME) == 0) {
+ int result;
+
+ d = ep_desc (dev->gadget, &hs_status_desc, &fs_status_desc);
+ result = usb_ep_enable (ep, d);
+ if (result < 0)
+ return result;
+
+ ep->driver_data = dev;
+ dev->status_ep = ep;
+ dev->status = d;
+ }
+ return 0;
+}
+#endif
+
+#if defined(DEV_CONFIG_SUBSET) || defined(CONFIG_USB_ETH_RNDIS)
+static inline int ether_ep_setup (struct eth_dev *dev, struct usb_ep *ep)
+{
+ int result;
+ const struct usb_endpoint_descriptor *d;
+
+ /* CDC subset is simpler: if the device is there,
+ * it's live with rx and tx endpoints.
+ *
+ * Do this as a shortcut for RNDIS too.
+ */
+
+ /* one endpoint writes data back IN to the host */
+ if (strcmp (ep->name, EP_IN_NAME) == 0) {
+ d = ep_desc (dev->gadget, &hs_source_desc, &fs_source_desc);
+ result = usb_ep_enable (ep, d);
+ if (result < 0)
+ return result;
+
+ ep->driver_data = dev;
+ dev->in_ep = ep;
+ dev->in = d;
+
+ /* one endpoint just reads OUT packets */
+ } else if (strcmp (ep->name, EP_OUT_NAME) == 0) {
+ d = ep_desc (dev->gadget, &hs_sink_desc, &fs_sink_desc);
+ result = usb_ep_enable (ep, d);
+ if (result < 0)
+ return result;
+
+ ep->driver_data = dev;
+ dev->out_ep = ep;
+ dev->out = d;
+ }
+
+ return 0;
+}
+#endif
+
static int
set_ether_config (struct eth_dev *dev, int gfp_flags)
{
@@ -786,34 +1022,17 @@
struct usb_gadget *gadget = dev->gadget;
gadget_for_each_ep (ep, gadget) {
- const struct usb_endpoint_descriptor *d;
-
#ifdef DEV_CONFIG_CDC
- /* With CDC, the host isn't allowed to use these two data
- * endpoints in the default altsetting for the interface.
- * so we don't activate them yet.
- */
+ if (!dev->rndis && dev->cdc) {
+ result = ether_alt_ep_setup (dev, ep);
+ if (result == 0)
+ continue;
+ }
+#endif
- /* one endpoint writes data back IN to the host */
- if (strcmp (ep->name, EP_IN_NAME) == 0) {
- d = ep_desc (gadget, &hs_source_desc, &fs_source_desc);
- ep->driver_data = dev;
- dev->in_ep = ep;
- dev->in = d;
- continue;
-
- /* one endpoint just reads OUT packets */
- } else if (strcmp (ep->name, EP_OUT_NAME) == 0) {
- d = ep_desc (gadget, &hs_sink_desc, &fs_sink_desc);
- ep->driver_data = dev;
- dev->out_ep = ep;
- dev->out = d;
- continue;
- }
-
-#ifdef EP_STATUS_NUM
- /* optional status/notification endpoint */
- else if (strcmp (ep->name, EP_STATUS_NAME) == 0) {
+#ifdef CONFIG_USB_ETH_RNDIS
+ if (dev->rndis && strcmp (ep->name, EP_STATUS_NAME) == 0) {
+ const struct usb_endpoint_descriptor *d;
d = ep_desc (gadget, &hs_status_desc, &fs_status_desc);
result = usb_ep_enable (ep, d);
if (result == 0) {
@@ -822,43 +1041,17 @@
dev->status = d;
continue;
}
- }
+ } else
#endif
-#else /* !CONFIG_CDC_ETHER */
-
- /* non-CDC is simpler: if the device is there,
- * it's live with rx and tx endpoints.
- */
- /* one endpoint writes data back IN to the host */
- if (strcmp (ep->name, EP_IN_NAME) == 0) {
- d = ep_desc (gadget, &hs_source_desc, &fs_source_desc);
- result = usb_ep_enable (ep, d);
- if (result == 0) {
- ep->driver_data = dev;
- dev->in_ep = ep;
- dev->in = d;
+ {
+#if defined(DEV_CONFIG_SUBSET) || defined(CONFIG_USB_ETH_RNDIS)
+ result = ether_ep_setup (dev, ep);
+ if (result == 0)
continue;
- }
-
- /* one endpoint just reads OUT packets */
- } else if (strcmp (ep->name, EP_OUT_NAME) == 0) {
- d = ep_desc (gadget, &hs_sink_desc, &fs_sink_desc);
- result = usb_ep_enable (ep, d);
- if (result == 0) {
- ep->driver_data = dev;
- dev->out_ep = ep;
- dev->out = d;
- continue;
- }
+#endif
}
-#endif /* !CONFIG_CDC_ETHER */
-
- /* ignore any other endpoints */
- else
- continue;
-
/* stop on error */
ERROR (dev, "can't enable %s, result %d\n", ep->name, result);
break;
@@ -869,23 +1062,41 @@
if (result == 0)
result = alloc_requests (dev, qlen (gadget), gfp_flags);
-#ifndef DEV_CONFIG_CDC
- if (result == 0) {
+ /* on error, disable any endpoints */
+ if (result < 0) {
+#if defined(DEV_CONFIG_CDC) || defined(CONFIG_USB_ETH_RNDIS)
+ if (dev->status_ep)
+ (void) usb_ep_disable (dev->status_ep);
+#endif
+ dev->status_ep = 0;
+ dev->status = 0;
+#if defined(DEV_CONFIG_SUBSET) || defined(CONFIG_USB_ETH_RNDIS)
+ if (dev->rndis || !dev->cdc) {
+ if (dev->in_ep)
+ (void) usb_ep_disable (dev->in_ep);
+ if (dev->out_ep)
+ (void) usb_ep_disable (dev->out_ep);
+ }
+#endif
+ dev->in_ep = 0;
+ dev->in = 0;
+ dev->out_ep = 0;
+ dev->out = 0;
+ } else
+
+ /* activate non-CDC configs right away
+ * this isn't strictly according to the RNDIS spec
+ */
+#if defined(DEV_CONFIG_SUBSET) || defined(CONFIG_USB_ETH_RNDIS)
+ if (dev->rndis || !dev->cdc) {
netif_carrier_on (dev->net);
if (netif_running (dev->net)) {
spin_unlock (&dev->lock);
eth_start (dev, GFP_ATOMIC);
spin_lock (&dev->lock);
}
- } else {
- (void) usb_ep_disable (dev->in_ep);
- dev->in_ep = 0;
- dev->in = 0;
- (void) usb_ep_disable (dev->out_ep);
- dev->out_ep = 0;
- dev->out = 0;
}
-#endif /* !CONFIG_CDC_ETHER */
+#endif
if (result == 0)
DEBUG (dev, "qlen %d\n", qlen (gadget));
@@ -930,12 +1141,10 @@
dev->out_ep = 0;
}
-#ifdef EP_STATUS_NUM
if (dev->status_ep) {
usb_ep_disable (dev->status_ep);
dev->status_ep = 0;
}
-#endif
dev->config = 0;
}
@@ -951,20 +1160,29 @@
if (number == dev->config)
return 0;
-#ifdef CONFIG_USB_GADGET_SA1100
- if (dev->config && atomic_read (&dev->tx_qlen) != 0) {
+ if (gadget_is_sa1100 (gadget)
+ && dev->config
+ && atomic_read (&dev->tx_qlen) != 0) {
/* tx fifo is full, but we can't clear it...*/
INFO (dev, "can't change configurations\n");
return -ESPIPE;
}
-#endif
eth_reset_config (dev);
- hw_optimize (gadget);
+
+ /* default: pass all packets, no multicast filtering */
+ dev->cdc_filter = 0x000f;
switch (number) {
case DEV_CONFIG_VALUE:
+ dev->rndis = 0;
+ result = set_ether_config (dev, gfp_flags);
+ break;
+#ifdef CONFIG_USB_ETH_RNDIS
+ case DEV_RNDIS_CONFIG_VALUE:
+ dev->rndis = 1;
result = set_ether_config (dev, gfp_flags);
break;
+#endif
default:
result = -EINVAL;
/* FALL THROUGH */
@@ -986,21 +1204,29 @@
}
dev->config = number;
- INFO (dev, "%s speed config #%d: %s\n", speed, number,
- driver_desc);
+ INFO (dev, "%s speed config #%d: %s, using %s\n",
+ speed, number, driver_desc,
+ dev->rndis
+ ? "RNDIS"
+ : (dev->cdc
+ ? "CDC Ethernet"
+ : "CDC Ethernet Subset"));
}
return result;
}
/*-------------------------------------------------------------------------*/
-#ifdef EP_STATUS_NUM
-
-/* section 3.8.2 table 11 of the CDC spec lists Ethernet notifications */
+/* section 3.8.2 table 11 of the CDC spec lists Ethernet notifications
+ * section 3.6.2.1 table 5 specifies ACM notifications, accepted by RNDIS
+ * and RNDIS also defines its own bit-incompatible notifications
+ */
#define CDC_NOTIFY_NETWORK_CONNECTION 0x00 /* required; 6.3.1 */
#define CDC_NOTIFY_RESPONSE_AVAILABLE 0x01 /* optional; 6.3.2 */
#define CDC_NOTIFY_SPEED_CHANGE 0x2a /* required; 6.3.8 */
+#ifdef DEV_CONFIG_CDC
+
struct cdc_notification {
u8 bmRequestType;
u8 bNotificationType;
@@ -1115,19 +1341,58 @@
/* see section 3.8.2 table 10 of the CDC spec for more ethernet
* requests, mostly for filters (multicast, pm) and statistics
+ * section 3.6.2.1 table 4 has ACM requests; RNDIS requires the
+ * encapsulated command mechanism.
*/
-#define CDC_SEND_ENCAPSULATED_REQUEST 0x00 /* optional */
-#define CDC_GET_ENCAPSULATED_RESPONSE 0x01 /* optional */
-#define CDC_SET_ETHERNET_PACKET_FILTER 0x43 /* required */
+#define CDC_SEND_ENCAPSULATED_COMMAND 0x00 /* optional */
+#define CDC_GET_ENCAPSULATED_RESPONSE 0x01 /* optional */
+#define CDC_SET_ETHERNET_MULTICAST_FILTERS 0x40 /* optional */
+#define CDC_SET_ETHERNET_PM_PATTERN_FILTER 0x41 /* optional */
+#define CDC_GET_ETHERNET_PM_PATTERN_FILTER 0x42 /* optional */
+#define CDC_SET_ETHERNET_PACKET_FILTER 0x43 /* required */
+#define CDC_GET_ETHERNET_STATISTIC 0x44 /* optional */
+
+/* table 62; bits in cdc_filter */
+#define CDC_PACKET_TYPE_PROMISCUOUS (1 << 0)
+#define CDC_PACKET_TYPE_ALL_MULTICAST (1 << 1) /* no filter */
+#define CDC_PACKET_TYPE_DIRECTED (1 << 2)
+#define CDC_PACKET_TYPE_BROADCAST (1 << 3)
+#define CDC_PACKET_TYPE_MULTICAST (1 << 4) /* filtered */
+
+#ifdef CONFIG_USB_ETH_RNDIS
+
+static void rndis_response_complete (struct usb_ep *ep, struct usb_request *req)
+{
+ if (req->status || req->actual != req->length)
+ DEBUG (dev, "rndis response complete --> %d, %d/%d\n",
+ req->status, req->actual, req->length);
+
+ /* done sending after CDC_GET_ENCAPSULATED_RESPONSE */
+}
+
+static void rndis_command_complete (struct usb_ep *ep, struct usb_request *req)
+{
+ struct eth_dev *dev = ep->driver_data;
+ int status;
+
+ /* received RNDIS command from CDC_SEND_ENCAPSULATED_COMMAND */
+ spin_lock(&dev->lock);
+ status = rndis_msg_parser (dev->rndis_config, (u8 *) req->buf);
+ if (status < 0)
+ ERROR(dev, "%s: rndis parse error %d\n", __FUNCTION__, status);
+ spin_unlock(&dev->lock);
+}
+
+#endif /* RNDIS */
/*
* The setup() callback implements all the ep0 functionality that's not
* handled lower down. CDC has a number of less-common features:
*
* - two interfaces: control, and ethernet data
- * - data interface has two altsettings: default, and active
+ * - Ethernet data interface has two altsettings: default, and active
* - class-specific descriptors for the control interface
- * - a mandatory class-specific control request
+ * - class-specific control requests
*/
static int
eth_setup (struct usb_gadget *gadget, const struct usb_ctrlrequest *ctrl)
@@ -1187,17 +1452,6 @@
value = eth_set_config (dev, ctrl->wValue, GFP_ATOMIC);
spin_unlock (&dev->lock);
break;
-#ifdef CONFIG_USB_GADGET_PXA2XX
- /* PXA UDC prevents us from using SET_INTERFACE in normal ways.
- * And it hides GET_CONFIGURATION and GET_INTERFACE too.
- */
- case USB_REQ_SET_INTERFACE:
- spin_lock (&dev->lock);
- value = eth_set_config (dev, DEV_CONFIG_VALUE, GFP_ATOMIC);
- spin_unlock (&dev->lock);
- break;
-
-#else /* hardware that that stays out of our way */
case USB_REQ_GET_CONFIGURATION:
if (ctrl->bRequestType != USB_DIR_IN)
break;
@@ -1210,17 +1464,28 @@
|| !dev->config
|| ctrl->wIndex > 1)
break;
+ if (!dev->cdc && ctrl->wIndex != 0)
+ break;
spin_lock (&dev->lock);
+
+ /* PXA hardware partially handles SET_INTERFACE;
+ * we need to kluge around that interference.
+ */
+ if (gadget_is_pxa (gadget)) {
+ value = eth_set_config (dev, DEV_CONFIG_VALUE,
+ GFP_ATOMIC);
+ goto done_set_intf;
+ }
+
+#ifdef DEV_CONFIG_CDC
switch (ctrl->wIndex) {
case 0: /* control/master intf */
if (ctrl->wValue != 0)
break;
-#ifdef EP_STATUS_NUM
if (dev->status_ep) {
usb_ep_disable (dev->status_ep);
usb_ep_enable (dev->status_ep, dev->status);
}
-#endif
value = 0;
break;
case 1: /* data intf */
@@ -1237,9 +1502,8 @@
usb_ep_enable (dev->in_ep, dev->in);
usb_ep_enable (dev->out_ep, dev->out);
netif_carrier_on (dev->net);
-#ifdef EP_STATUS_NUM
- issue_start_status (dev);
-#endif
+ if (dev->status_ep)
+ issue_start_status (dev);
if (netif_running (dev->net)) {
spin_unlock (&dev->lock);
eth_start (dev, GFP_ATOMIC);
@@ -1252,6 +1516,14 @@
value = 0;
break;
}
+#else
+ /* FIXME this is wrong, as is the assumption that
+ * all non-PXA hardware talks real CDC ...
+ */
+ dev_warn (&gadget->dev, "set_interface ignored!\n");
+#endif /* DEV_CONFIG_CDC */
+
+done_set_intf:
spin_unlock (&dev->lock);
break;
case USB_REQ_GET_INTERFACE:
@@ -1259,15 +1531,16 @@
|| !dev->config
|| ctrl->wIndex > 1)
break;
+ if (!(dev->cdc || dev->rndis) && ctrl->wIndex != 0)
+ break;
- /* if carrier is on, data interface is active. */
- *(u8 *)req->buf =
- ((ctrl->wIndex == 1) && netif_carrier_ok (dev->net))
- ? 1
- : 0,
+ /* for CDC, iff carrier is on, data interface is active. */
+ if (dev->rndis || ctrl->wIndex != 1)
+ *(u8 *)req->buf = 0;
+ else
+ *(u8 *)req->buf = netif_carrier_ok (dev->net) ? 1 : 0;
value = min (ctrl->wLength, (u16) 1);
break;
-#endif
#ifdef DEV_CONFIG_CDC
case CDC_SET_ETHERNET_PACKET_FILTER:
@@ -1275,17 +1548,62 @@
* wValue = packet filter bitmap
*/
if (ctrl->bRequestType != (USB_TYPE_CLASS|USB_RECIP_INTERFACE)
+ || !dev->cdc
+ || dev->rndis
|| ctrl->wLength != 0
|| ctrl->wIndex > 1)
+ break;
DEBUG (dev, "NOP packet filter %04x\n", ctrl->wValue);
/* NOTE: table 62 has 5 filter bits to reduce traffic,
* and we "must" support multicast and promiscuous.
- * this NOP implements a bad filter...
+ * this NOP implements a bad filter (always promisc)
*/
+ dev->cdc_filter = ctrl->wValue;
value = 0;
break;
#endif /* DEV_CONFIG_CDC */
+#ifdef CONFIG_USB_ETH_RNDIS
+ /* RNDIS uses the CDC command encapsulation mechanism to implement
+ * an RPC scheme, with much getting/setting of attributes by OID.
+ */
+ case CDC_SEND_ENCAPSULATED_COMMAND:
+ if (ctrl->bRequestType != (USB_TYPE_CLASS|USB_RECIP_INTERFACE)
+ || !dev->rndis
+ || ctrl->wLength > USB_BUFSIZ
+ || ctrl->wValue
+ || rndis_control_intf.bInterfaceNumber
+ != ctrl->wIndex)
+ break;
+ /* read the request, then process it */
+ value = ctrl->wLength;
+ req->complete = rndis_command_complete;
+ /* later, rndis_control_ack () sends a notification */
+ break;
+
+ case CDC_GET_ENCAPSULATED_RESPONSE:
+ if ((USB_DIR_IN|USB_TYPE_CLASS|USB_RECIP_INTERFACE)
+ == ctrl->bRequestType
+ && dev->rndis
+ // && ctrl->wLength >= 0x0400
+ && !ctrl->wValue
+ && rndis_control_intf.bInterfaceNumber
+ == ctrl->wIndex) {
+ u8 *buf;
+
+ /* return the result */
+ buf = rndis_get_next_response (dev->rndis_config,
+ &value);
+ if (buf) {
+ memcpy (req->buf, buf, value);
+ req->complete = rndis_response_complete;
+ rndis_free_response(dev->rndis_config, buf);
+ }
+ /* else stalls ... spec says to avoid that */
+ }
+ break;
+#endif /* RNDIS */
+
default:
VDEBUG (dev,
"unknown control req%02x.%02x v%04x i%04x l%d\n",
@@ -1320,6 +1638,8 @@
eth_reset_config (dev);
spin_unlock_irqrestore (&dev->lock, flags);
+ /* FIXME RNDIS should enter RNDIS_UNINITIALIZED */
+
/* next we may get setup() calls to enumerate new connections;
* or an unbind() during shutdown (including removing module).
*/
@@ -1333,7 +1653,9 @@
{
struct eth_dev *dev = (struct eth_dev *) net->priv;
- if (new_mtu <= MIN_PACKET || new_mtu > MAX_PACKET)
+ // FIXME if rndis, don't change while link's live
+
+ if (new_mtu <= ETH_HLEN || new_mtu > ETH_FRAME_LEN)
return -ERANGE;
/* no zero-length packet read wanted after mtu-sized packets */
if (((new_mtu + sizeof (struct ethhdr)) % dev->in_ep->maxpacket) == 0)
@@ -1347,12 +1669,12 @@
return &((struct eth_dev *) net->priv)->stats;
}
-static int eth_ethtool_ioctl (struct net_device *net, void *useraddr)
+static int eth_ethtool_ioctl (struct net_device *net, void __user *useraddr)
{
struct eth_dev *dev = (struct eth_dev *) net->priv;
u32 cmd;
- if (get_user (cmd, (u32 *)useraddr))
+ if (get_user (cmd, (u32 __user *)useraddr))
return -EFAULT;
switch (cmd) {
@@ -1363,7 +1685,8 @@
info.cmd = ETHTOOL_GDRVINFO;
strncpy (info.driver, shortname, sizeof info.driver);
strncpy (info.version, DRIVER_VERSION, sizeof info.version);
- strncpy (info.fw_version, CHIP, sizeof info.fw_version);
+ strncpy (info.fw_version, dev->gadget->name,
+ sizeof info.fw_version);
strncpy (info.bus_info, dev->gadget->dev.bus_id,
sizeof info.bus_info);
if (copy_to_user (useraddr, &info, sizeof (info)))
@@ -1389,7 +1712,7 @@
{
switch (cmd) {
case SIOCETHTOOL:
- return eth_ethtool_ioctl (net, (void *)rq->ifr_data);
+ return eth_ethtool_ioctl(net, rq->ifr_data);
default:
return -EOPNOTSUPP;
}
@@ -1414,7 +1737,27 @@
int retval = -ENOMEM;
size_t size;
+ /* Padding up to RX_EXTRA handles minor disagreements with host.
+ * Normally we use the USB "terminate on short read" convention;
+ * so allow up to (N*maxpacket)-1, since that memory is normally
+ * already allocated. Major loss of synch means -EOVERFLOW; any
+ * obviously corrupted packets will automatically be discarded.
+ *
+ * RNDIS uses internal framing, and explicitly allows senders to
+ * pad to end-of-packet. That's potentially nice for speed,
+ * but means receivers can't recover synch on their own.
+ */
size = (sizeof (struct ethhdr) + dev->net->mtu + RX_EXTRA);
+ size += dev->out_ep->maxpacket - 1;
+#ifdef CONFIG_USB_ETH_RNDIS
+ if (dev->rndis)
+ size += sizeof (struct rndis_packet_msg_type);
+#endif
+ size -= size % dev->out_ep->maxpacket;
+#ifdef CONFIG_USB_ETH_RNDIS
+ if (!dev->rndis)
+#endif
+ size--;
if ((skb = alloc_skb (size, gfp_flags)) == 0) {
DEBUG (dev, "no rx skb\n");
@@ -1451,8 +1794,12 @@
/* normal completion */
case 0:
skb_put (skb, req->actual);
- if (MIN_PACKET > skb->len
- || skb->len > (MAX_PACKET + ETH_HLEN)) {
+#ifdef CONFIG_USB_ETH_RNDIS
+ /* we know MaxPacketsPerTransfer == 1 here */
+ if (dev->rndis)
+ rndis_rm_hdr (req->buf, &(skb->len));
+#endif
+ if (ETH_HLEN > skb->len || skb->len > ETH_FRAME_LEN) {
dev->stats.rx_errors++;
dev->stats.rx_length_errors++;
DEBUG (dev, "rx length %d\n", skb->len);
@@ -1640,6 +1987,11 @@
struct usb_request *req = 0;
unsigned long flags;
+ /* FIXME check dev->cdc_filter to decide whether to send this,
+ * instead of acting as if CDC_PACKET_TYPE_PROMISCUOUS were
+ * always set. RNDIS has the same kind of outgoing filter.
+ */
+
spin_lock_irqsave (&dev->lock, flags);
req = container_of (dev->tx_reqs.next, struct usb_request, list);
list_del (&req->list);
@@ -1649,21 +2001,35 @@
/* no buffer copies needed, unless the network stack did it
* or the hardware can't use skb buffers.
+ * or there's not enough space for any RNDIS headers we need
*/
+#ifdef CONFIG_USB_ETH_RNDIS
+ if (dev->rndis) {
+ struct sk_buff *skb_rndis;
+
+ skb_rndis = skb_realloc_headroom (skb,
+ sizeof (struct rndis_packet_msg_type));
+ if (!skb_rndis)
+ goto drop;
+
+ dev_kfree_skb_any (skb);
+ skb = skb_rndis;
+ rndis_add_hdr (skb);
+ length = skb->len;
+ }
+#endif
req->buf = skb->data;
req->context = skb;
req->complete = tx_complete;
-#ifdef CONFIG_USB_GADGET_SA1100
- /* don't demand zlp (req->zero) support from all hardware */
- if ((length % dev->in_ep->maxpacket) == 0)
- length++;
-#else
/* use zlp framing on tx for strict CDC-Ether conformance,
* though any robust network rx path ignores extra padding.
+ * and some hardware doesn't like to write zlps.
*/
req->zero = 1;
-#endif
+ if (!dev->zlp && (length % dev->in_ep->maxpacket) == 0)
+ length++;
+
req->length = length;
#ifdef CONFIG_USB_GADGET_DUALSPEED
@@ -1684,6 +2050,9 @@
}
if (retval) {
+#ifdef CONFIG_USB_ETH_RNDIS
+drop:
+#endif
dev->stats.tx_dropped++;
dev_kfree_skb_any (skb);
spin_lock_irqsave (&dev->lock, flags);
@@ -1695,6 +2064,81 @@
return 0;
}
+/*-------------------------------------------------------------------------*/
+
+#ifdef CONFIG_USB_ETH_RNDIS
+
+static void rndis_send_media_state (struct eth_dev *dev, int connect)
+{
+ if (!dev)
+ return;
+
+ if (connect) {
+ if (rndis_signal_connect (dev->rndis_config))
+ return;
+ } else {
+ if (rndis_signal_disconnect (dev->rndis_config))
+ return;
+ }
+}
+
+static void rndis_control_ack_complete (struct usb_ep *ep, struct usb_request *req)
+{
+ if (req->status || req->actual != req->length)
+ DEBUG (dev, "rndis control ack complete --> %d, %d/%d\n",
+ req->status, req->actual, req->length);
+
+ usb_ep_free_buffer(ep, req->buf, req->dma, 8);
+ usb_ep_free_request(ep, req);
+}
+
+static int rndis_control_ack (struct net_device *net)
+{
+ struct eth_dev *dev = (struct eth_dev *) net->priv;
+ u32 length;
+ struct usb_request *resp;
+
+ /* in case RNDIS calls this after disconnect */
+ if (!dev->status_ep) {
+ DEBUG (dev, "status ENODEV\n");
+ return -ENODEV;
+ }
+
+ /* Allocate memory for notification ie. ACK */
+ resp = usb_ep_alloc_request (dev->status_ep, GFP_ATOMIC);
+ if (!resp) {
+ DEBUG (dev, "status ENOMEM\n");
+ return -ENOMEM;
+ }
+
+ resp->buf = usb_ep_alloc_buffer (dev->status_ep, 8,
+ &resp->dma, GFP_ATOMIC);
+ if (!resp->buf) {
+ DEBUG (dev, "status buf ENOMEM\n");
+ usb_ep_free_request (dev->status_ep, resp);
+ return -ENOMEM;
+ }
+
+ /* Send RNDIS RESPONSE_AVAILABLE notification;
+ * CDC_NOTIFY_RESPONSE_AVAILABLE should work too
+ */
+ resp->length = 8;
+ resp->complete = rndis_control_ack_complete;
+
+ *((u32 *) resp->buf) = __constant_cpu_to_le32 (1);
+ *((u32 *) resp->buf + 1) = __constant_cpu_to_le32 (0);
+
+ length = usb_ep_queue (dev->status_ep, resp, GFP_ATOMIC);
+ if (length < 0) {
+ resp->status = 0;
+ rndis_control_ack_complete (dev->status_ep, resp);
+ }
+
+ return 0;
+}
+
+#endif /* RNDIS */
+
static void eth_start (struct eth_dev *dev, int gfp_flags)
{
DEBUG (dev, "%s\n", __FUNCTION__);
@@ -1705,6 +2149,14 @@
/* and open the tx floodgates */
atomic_set (&dev->tx_qlen, 0);
netif_wake_queue (dev->net);
+#ifdef CONFIG_USB_ETH_RNDIS
+ if (dev->rndis) {
+ rndis_set_param_medium (dev->rndis_config,
+ NDIS_MEDIUM_802_3,
+ BITRATE(dev->gadget));
+ rndis_send_media_state (dev, 1);
+ }
+#endif
}
static int eth_open (struct net_device *net)
@@ -1739,11 +2191,19 @@
usb_ep_enable (dev->in_ep, dev->in);
usb_ep_enable (dev->out_ep, dev->out);
}
-#ifdef EP_STATUS_NUM
- usb_ep_disable (dev->status_ep);
- usb_ep_enable (dev->status_ep, dev->status);
-#endif
+ if (dev->status_ep) {
+ usb_ep_disable (dev->status_ep);
+ usb_ep_enable (dev->status_ep, dev->status);
+ }
+ }
+
+#ifdef CONFIG_USB_ETH_RNDIS
+ if (dev->rndis) {
+ rndis_set_param_medium (dev->rndis_config,
+ NDIS_MEDIUM_802_3, 0);
+ rndis_send_media_state (dev, 0);
}
+#endif
return 0;
}
@@ -1756,6 +2216,10 @@
struct eth_dev *dev = get_gadget_data (gadget);
DEBUG (dev, "unbind\n");
+#ifdef CONFIG_USB_ETH_RNDIS
+ rndis_deregister (dev->rndis_config);
+ rndis_exit ();
+#endif
/* we've already been disconnected ... no i/o is active */
if (dev->req) {
@@ -1767,37 +2231,218 @@
}
unregister_netdev (dev->net);
- dev_put (dev->net);
+ free_netdev(dev->net);
/* assuming we used keventd, it must quiesce too */
flush_scheduled_work ();
set_gadget_data (gadget, 0);
}
-static int
+static u8 __init nibble (unsigned char c)
+{
+ if (likely (isdigit (c)))
+ return c - '0';
+ c = toupper (c);
+ if (likely (isxdigit (c)))
+ return 10 + c - 'A';
+ return 0;
+}
+
+static void __init get_ether_addr (const char *str, u8 *dev_addr)
+{
+ if (str) {
+ unsigned i;
+
+ for (i = 0; i < 6; i++) {
+ unsigned char num;
+
+ if((*str == '.') || (*str == ':'))
+ str++;
+ num = nibble(*str++) << 4;
+ num |= (nibble(*str++));
+ dev_addr [i] = num;
+ }
+ if (is_valid_ether_addr (dev_addr))
+ return;
+ }
+ random_ether_addr(dev_addr);
+}
+
+static int __init
eth_bind (struct usb_gadget *gadget)
{
struct eth_dev *dev;
struct net_device *net;
+ u8 cdc = 1, zlp = 1, rndis = 1;
+ struct usb_ep *ep;
int status = -ENOMEM;
-#ifdef DEV_CONFIG_CDC
- u8 node_id [ETH_ALEN];
- /* just one upstream link at a time */
- if (ethaddr [0] != 0)
+ /* these flags are only ever cleared; compiler take note */
+#ifndef DEV_CONFIG_CDC
+ cdc = 0;
+#endif
+#ifndef CONFIG_USB_ETH_RNDIS
+ rndis = 0;
+#endif
+
+ /* Because most host side USB stacks handle CDC Ethernet, that
+ * standard protocol is _strongly_ preferred for interop purposes.
+ * (By everyone except Microsoft.)
+ */
+ if (gadget_is_net2280 (gadget)) {
+ device_desc.bcdDevice = __constant_cpu_to_le16 (0x0201);
+ } else if (gadget_is_dummy (gadget)) {
+ device_desc.bcdDevice = __constant_cpu_to_le16 (0x0202);
+ } else if (gadget_is_pxa (gadget)) {
+ device_desc.bcdDevice = __constant_cpu_to_le16 (0x0203);
+ /* pxa doesn't support altsettings */
+ cdc = 0;
+ } else if (gadget_is_sh(gadget)) {
+ device_desc.bcdDevice = __constant_cpu_to_le16 (0x0204);
+ /* sh doesn't support multiple interfaces or configs */
+ cdc = 0;
+ rndis = 0;
+ } else if (gadget_is_sa1100 (gadget)) {
+ device_desc.bcdDevice = __constant_cpu_to_le16 (0x0205);
+ /* hardware can't write zlps */
+ zlp = 0;
+ /* sa1100 CAN do CDC, without status endpoint ... we use
+ * non-CDC to be compatible with ARM Linux-2.4 "usb-eth".
+ */
+ cdc = 0;
+ } else if (gadget_is_goku (gadget)) {
+ device_desc.bcdDevice = __constant_cpu_to_le16 (0x0206);
+ } else if (gadget_is_mq11xx (gadget)) {
+ device_desc.bcdDevice = __constant_cpu_to_le16 (0x0207);
+ } else if (gadget_is_omap (gadget)) {
+ device_desc.bcdDevice = __constant_cpu_to_le16 (0x0208);
+ } else {
+ /* can't assume CDC works. don't want to default to
+ * anything less functional on CDC-capable hardware,
+ * so we fail in this case.
+ */
+ printk (KERN_ERR "%s: controller '%s' not recognized\n",
+ shortname, gadget->name);
+ return -ENODEV;
+ }
+ snprintf (manufacturer, sizeof manufacturer,
+ UTS_SYSNAME " " UTS_RELEASE "/%s",
+ gadget->name);
+
+ /* If there's an RNDIS configuration, that's what Windows wants to
+ * be using ... so use these product IDs here and in the "linux.inf"
+ * needed to install MSFT drivers. Current Linux kernels will use
+ * the second configuration if it's CDC Ethernet, and need some help
+ * to choose the right configuration otherwise.
+ */
+ if (rndis) {
+ device_desc.idVendor =
+ __constant_cpu_to_le16(RNDIS_VENDOR_NUM);
+ device_desc.idProduct =
+ __constant_cpu_to_le16(RNDIS_PRODUCT_NUM);
+ snprintf (product_desc, sizeof product_desc,
+ "RNDIS/%s", driver_desc);
+
+ /* CDC subset ... recognized by Linux since 2.4.10, but Windows
+ * drivers aren't widely available.
+ */
+ } else if (!cdc) {
+ device_desc.bDeviceClass = USB_CLASS_VENDOR_SPEC;
+ device_desc.idVendor =
+ __constant_cpu_to_le16(SIMPLE_VENDOR_NUM);
+ device_desc.idProduct =
+ __constant_cpu_to_le16(SIMPLE_PRODUCT_NUM);
+ }
+
+
+ /* support optional vendor/distro customization */
+ if (idVendor) {
+ if (!idProduct) {
+ printk (KERN_ERR "%s: idVendor needs idProduct!\n",
+ shortname);
+ return -ENODEV;
+ }
+ device_desc.idVendor = cpu_to_le16(idVendor);
+ device_desc.idProduct = cpu_to_le16(idProduct);
+ if (bcdDevice)
+ device_desc.bcdDevice = cpu_to_le16(bcdDevice);
+ }
+ if (iManufacturer)
+ strncpy (manufacturer, iManufacturer, sizeof manufacturer);
+ if (iProduct)
+ strncpy (product_desc, iProduct, sizeof product_desc);
+
+ /* all we really need is bulk IN/OUT */
+ usb_ep_autoconfig_reset (gadget);
+ ep = usb_ep_autoconfig (gadget, &fs_source_desc);
+ if (!ep) {
+autoconf_fail:
+ printk (KERN_ERR "%s: can't autoconfigure on %s\n",
+ shortname, gadget->name);
return -ENODEV;
+ }
+ EP_IN_NAME = ep->name;
+ ep->driver_data = ep; /* claim */
+
+ ep = usb_ep_autoconfig (gadget, &fs_sink_desc);
+ if (!ep)
+ goto autoconf_fail;
+ EP_OUT_NAME = ep->name;
+ ep->driver_data = ep; /* claim */
+
+#if defined(DEV_CONFIG_CDC) || defined(CONFIG_USB_ETH_RNDIS)
+ /* CDC Ethernet control interface doesn't require a status endpoint.
+ * Since some hosts expect one, try to allocate one anyway.
+ */
+ if (cdc || rndis) {
+ ep = usb_ep_autoconfig (gadget, &fs_status_desc);
+ if (ep) {
+ EP_STATUS_NAME = ep->name;
+ ep->driver_data = ep; /* claim */
+ } else if (rndis) {
+ printk (KERN_ERR "%s: can't run RNDIS on %s\n",
+ shortname, gadget->name);
+ return -ENODEV;
+ } else if (cdc) {
+ control_intf.bNumEndpoints = 0;
+ /* FIXME remove endpoint from descriptor list */
+ }
+ }
#endif
- device_desc.bMaxPacketSize0 = gadget->ep0->maxpacket;
+ /* one config: cdc, else minimal subset */
+ if (!cdc) {
+ eth_config.bNumInterfaces = 1;
+ eth_config.iConfiguration = STRING_SUBSET;
+ fs_subset_descriptors();
+ hs_subset_descriptors();
+ }
+
+ /* For now RNDIS is always a second config */
+ if (rndis)
+ device_desc.bNumConfigurations = 2;
+
#ifdef CONFIG_USB_GADGET_DUALSPEED
+ if (rndis)
+ dev_qualifier.bNumConfigurations = 2;
+ else if (!cdc)
+ dev_qualifier.bDeviceClass = USB_CLASS_VENDOR_SPEC;
+
/* assumes ep0 uses the same value for both speeds ... */
dev_qualifier.bMaxPacketSize0 = device_desc.bMaxPacketSize0;
+
+ /* and that all endpoints are dual-speed */
+ hs_source_desc.bEndpointAddress = fs_source_desc.bEndpointAddress;
+ hs_sink_desc.bEndpointAddress = fs_sink_desc.bEndpointAddress;
+#if defined(DEV_CONFIG_CDC) || defined(CONFIG_USB_ETH_RNDIS)
+ if (EP_STATUS_NAME)
+ hs_status_desc.bEndpointAddress =
+ fs_status_desc.bEndpointAddress;
#endif
+#endif /* DUALSPEED */
-#ifdef SELFPOWERED
- eth_config.bmAttributes |= USB_CONFIG_ATT_SELFPOWERED;
+ device_desc.bMaxPacketSize0 = gadget->ep0->maxpacket;
usb_gadget_set_selfpowered (gadget);
-#endif
net = alloc_etherdev (sizeof *dev);
if (!net)
@@ -1812,25 +2457,32 @@
dev->net = net;
SET_MODULE_OWNER (net);
strcpy (net->name, "usb%d");
+ dev->cdc = cdc;
+ dev->zlp = zlp;
- /* one random address for the gadget device ... both of these could
- * reasonably come from an id prom or a module parameter.
+ /* Module params for these addresses should come from ID proms.
+ * The host side address is used with CDC and RNDIS, and commonly
+ * ends up in a persistent config database.
*/
- get_random_bytes (net->dev_addr, ETH_ALEN);
- net->dev_addr [0] &= 0xfe; // clear multicast bit
- net->dev_addr [0] |= 0x02; // set local assignment bit (IEEE802)
-
+ get_ether_addr(dev_addr, net->dev_addr);
+ if (cdc || rndis) {
+ get_ether_addr(host_addr, dev->host_mac);
#ifdef DEV_CONFIG_CDC
- /* ... another address for the host, on the other end of the
- * link, gets exported through CDC (see CDC spec table 41)
- */
- get_random_bytes (node_id, sizeof node_id);
- node_id [0] &= 0xfe; // clear multicast bit
- node_id [0] |= 0x02; // set local assignment bit (IEEE802)
- snprintf (ethaddr, sizeof ethaddr, "%02X%02X%02X%02X%02X%02X",
- node_id [0], node_id [1], node_id [2],
- node_id [3], node_id [4], node_id [5]);
+ snprintf (ethaddr, sizeof ethaddr, "%02X%02X%02X%02X%02X%02X",
+ dev->host_mac [0], dev->host_mac [1],
+ dev->host_mac [2], dev->host_mac [3],
+ dev->host_mac [4], dev->host_mac [5]);
#endif
+ }
+
+ if (rndis) {
+ status = rndis_init();
+ if (status < 0) {
+ printk (KERN_ERR "%s: can't init RNDIS, %d\n",
+ shortname, status);
+ goto fail;
+ }
+ }
net->change_mtu = eth_change_mtu;
net->get_stats = eth_get_stats;
@@ -1867,16 +2519,60 @@
// SET_NETDEV_DEV (dev->net, &gadget->dev);
status = register_netdev (dev->net);
- if (status == 0) {
+ if (status < 0)
+ goto fail1;
- INFO (dev, "%s, " CHIP ", version: " DRIVER_VERSION "\n",
- driver_desc);
-#ifdef DEV_CONFIG_CDC
- INFO (dev, "CDC host enet %s\n", ethaddr);
-#endif
- return status;
+ INFO (dev, "%s, version: " DRIVER_VERSION "\n", driver_desc);
+ INFO (dev, "using %s, OUT %s IN %s%s%s\n", gadget->name,
+ EP_OUT_NAME, EP_IN_NAME,
+ EP_STATUS_NAME ? " STATUS " : "",
+ EP_STATUS_NAME ? EP_STATUS_NAME : ""
+ );
+ INFO (dev, "MAC %02x:%02x:%02x:%02x:%02x:%02x\n",
+ net->dev_addr [0], net->dev_addr [1],
+ net->dev_addr [2], net->dev_addr [3],
+ net->dev_addr [4], net->dev_addr [5]);
+
+ if (cdc || rndis)
+ INFO (dev, "HOST MAC %02x:%02x:%02x:%02x:%02x:%02x\n",
+ dev->host_mac [0], dev->host_mac [1],
+ dev->host_mac [2], dev->host_mac [3],
+ dev->host_mac [4], dev->host_mac [5]);
+
+#ifdef CONFIG_USB_ETH_RNDIS
+ if (rndis) {
+ u32 vendorID = 0;
+
+ /* FIXME RNDIS vendor id == "vendor NIC code" == ? */
+
+ dev->rndis_config = rndis_register (rndis_control_ack);
+ if (dev->rndis_config < 0) {
+fail0:
+ unregister_netdev (dev->net);
+ status = -ENODEV;
+ goto fail;
+ }
+
+ /* these set up a lot of the OIDs that RNDIS needs */
+ rndis_set_host_mac (dev->rndis_config, dev->host_mac);
+ if (rndis_set_param_dev (dev->rndis_config, dev->net,
+ &dev->stats))
+ goto fail0;
+ if (rndis_set_param_vendor (dev->rndis_config, vendorID,
+ manufacturer))
+ goto fail0;
+ if (rndis_set_param_medium (dev->rndis_config,
+ NDIS_MEDIUM_802_3,
+ 0))
+ goto fail0;
+ INFO (dev, "RNDIS ready\n");
}
- pr_debug("%s: register_netdev failed, %d\n", shortname, status);
+#endif
+
+ return status;
+
+fail1:
+ pr_debug ("%s: register_netdev failed, %d\n", shortname, status);
fail:
eth_unbind (gadget);
return status;
@@ -1884,6 +2580,26 @@
/*-------------------------------------------------------------------------*/
+static void
+eth_suspend (struct usb_gadget *gadget)
+{
+ struct eth_dev *dev = get_gadget_data (gadget);
+
+ DEBUG (dev, "suspend\n");
+ dev->suspended = 1;
+}
+
+static void
+eth_resume (struct usb_gadget *gadget)
+{
+ struct eth_dev *dev = get_gadget_data (gadget);
+
+ DEBUG (dev, "resume\n");
+ dev->suspended = 0;
+}
+
+/*-------------------------------------------------------------------------*/
+
static struct usb_gadget_driver eth_driver = {
#ifdef CONFIG_USB_GADGET_DUALSPEED
.speed = USB_SPEED_HIGH,
@@ -1897,6 +2613,9 @@
.setup = eth_setup,
.disconnect = eth_disconnect,
+ .suspend = eth_suspend,
+ .resume = eth_resume,
+
.driver = {
.name = (char *) shortname,
// .shutdown = ...
@@ -1906,7 +2625,7 @@
};
MODULE_DESCRIPTION (DRIVER_DESC);
-MODULE_AUTHOR ("David Brownell");
+MODULE_AUTHOR ("David Brownell, Benedikt Spanger");
MODULE_LICENSE ("GPL");
FUNET's LINUX-ADM group, linux-adm@nic.funet.fi
TCL-scripts by Sam Shen (who was at: slshen@lbl.gov)