2009-05-04 13:01:43 -06:00
|
|
|
/*
|
|
|
|
* USB CDC EEM network interface driver
|
|
|
|
* Copyright (C) 2009 Oberthur Technologies
|
|
|
|
* by Omar Laazimani, Olivier Condemine
|
|
|
|
*
|
|
|
|
* 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
|
|
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
2013-12-06 07:28:46 -07:00
|
|
|
* along with this program; if not, see <http://www.gnu.org/licenses/>.
|
2009-05-04 13:01:43 -06:00
|
|
|
*/
|
|
|
|
|
|
|
|
#include <linux/module.h>
|
|
|
|
#include <linux/netdevice.h>
|
|
|
|
#include <linux/etherdevice.h>
|
|
|
|
#include <linux/ctype.h>
|
|
|
|
#include <linux/ethtool.h>
|
|
|
|
#include <linux/workqueue.h>
|
|
|
|
#include <linux/mii.h>
|
|
|
|
#include <linux/usb.h>
|
|
|
|
#include <linux/crc32.h>
|
|
|
|
#include <linux/usb/cdc.h>
|
|
|
|
#include <linux/usb/usbnet.h>
|
include cleanup: Update gfp.h and slab.h includes to prepare for breaking implicit slab.h inclusion from percpu.h
percpu.h is included by sched.h and module.h and thus ends up being
included when building most .c files. percpu.h includes slab.h which
in turn includes gfp.h making everything defined by the two files
universally available and complicating inclusion dependencies.
percpu.h -> slab.h dependency is about to be removed. Prepare for
this change by updating users of gfp and slab facilities include those
headers directly instead of assuming availability. As this conversion
needs to touch large number of source files, the following script is
used as the basis of conversion.
http://userweb.kernel.org/~tj/misc/slabh-sweep.py
The script does the followings.
* Scan files for gfp and slab usages and update includes such that
only the necessary includes are there. ie. if only gfp is used,
gfp.h, if slab is used, slab.h.
* When the script inserts a new include, it looks at the include
blocks and try to put the new include such that its order conforms
to its surrounding. It's put in the include block which contains
core kernel includes, in the same order that the rest are ordered -
alphabetical, Christmas tree, rev-Xmas-tree or at the end if there
doesn't seem to be any matching order.
* If the script can't find a place to put a new include (mostly
because the file doesn't have fitting include block), it prints out
an error message indicating which .h file needs to be added to the
file.
The conversion was done in the following steps.
1. The initial automatic conversion of all .c files updated slightly
over 4000 files, deleting around 700 includes and adding ~480 gfp.h
and ~3000 slab.h inclusions. The script emitted errors for ~400
files.
2. Each error was manually checked. Some didn't need the inclusion,
some needed manual addition while adding it to implementation .h or
embedding .c file was more appropriate for others. This step added
inclusions to around 150 files.
3. The script was run again and the output was compared to the edits
from #2 to make sure no file was left behind.
4. Several build tests were done and a couple of problems were fixed.
e.g. lib/decompress_*.c used malloc/free() wrappers around slab
APIs requiring slab.h to be added manually.
5. The script was run on all .h files but without automatically
editing them as sprinkling gfp.h and slab.h inclusions around .h
files could easily lead to inclusion dependency hell. Most gfp.h
inclusion directives were ignored as stuff from gfp.h was usually
wildly available and often used in preprocessor macros. Each
slab.h inclusion directive was examined and added manually as
necessary.
6. percpu.h was updated not to include slab.h.
7. Build test were done on the following configurations and failures
were fixed. CONFIG_GCOV_KERNEL was turned off for all tests (as my
distributed build env didn't work with gcov compiles) and a few
more options had to be turned off depending on archs to make things
build (like ipr on powerpc/64 which failed due to missing writeq).
* x86 and x86_64 UP and SMP allmodconfig and a custom test config.
* powerpc and powerpc64 SMP allmodconfig
* sparc and sparc64 SMP allmodconfig
* ia64 SMP allmodconfig
* s390 SMP allmodconfig
* alpha SMP allmodconfig
* um on x86_64 SMP allmodconfig
8. percpu.h modifications were reverted so that it could be applied as
a separate patch and serve as bisection point.
Given the fact that I had only a couple of failures from tests on step
6, I'm fairly confident about the coverage of this conversion patch.
If there is a breakage, it's likely to be something in one of the arch
headers which should be easily discoverable easily on most builds of
the specific arch.
Signed-off-by: Tejun Heo <tj@kernel.org>
Guess-its-ok-by: Christoph Lameter <cl@linux-foundation.org>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Lee Schermerhorn <Lee.Schermerhorn@hp.com>
2010-03-24 02:04:11 -06:00
|
|
|
#include <linux/gfp.h>
|
2012-11-07 07:39:19 -07:00
|
|
|
#include <linux/if_vlan.h>
|
2009-05-04 13:01:43 -06:00
|
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
* This driver is an implementation of the CDC "Ethernet Emulation
|
|
|
|
* Model" (EEM) specification, which encapsulates Ethernet frames
|
|
|
|
* for transport over USB using a simpler USB device model than the
|
|
|
|
* previous CDC "Ethernet Control Model" (ECM, or "CDC Ethernet").
|
|
|
|
*
|
|
|
|
* For details, see www.usb.org/developers/devclass_docs/CDC_EEM10.pdf
|
|
|
|
*
|
|
|
|
* This version has been tested with GIGAntIC WuaoW SIM Smart Card on 2.6.24,
|
|
|
|
* 2.6.27 and 2.6.30rc2 kernel.
|
|
|
|
* It has also been validated on Openmoko Om 2008.12 (based on 2.6.24 kernel).
|
|
|
|
* build on 23-April-2009
|
|
|
|
*/
|
|
|
|
|
|
|
|
#define EEM_HEAD 2 /* 2 byte header */
|
|
|
|
|
|
|
|
/*-------------------------------------------------------------------------*/
|
|
|
|
|
|
|
|
static void eem_linkcmd_complete(struct urb *urb)
|
|
|
|
{
|
|
|
|
dev_kfree_skb(urb->context);
|
|
|
|
usb_free_urb(urb);
|
|
|
|
}
|
|
|
|
|
|
|
|
static void eem_linkcmd(struct usbnet *dev, struct sk_buff *skb)
|
|
|
|
{
|
|
|
|
struct urb *urb;
|
|
|
|
int status;
|
|
|
|
|
|
|
|
urb = usb_alloc_urb(0, GFP_ATOMIC);
|
|
|
|
if (!urb)
|
|
|
|
goto fail;
|
|
|
|
|
|
|
|
usb_fill_bulk_urb(urb, dev->udev, dev->out,
|
|
|
|
skb->data, skb->len, eem_linkcmd_complete, skb);
|
|
|
|
|
|
|
|
status = usb_submit_urb(urb, GFP_ATOMIC);
|
|
|
|
if (status) {
|
|
|
|
usb_free_urb(urb);
|
|
|
|
fail:
|
|
|
|
dev_kfree_skb(skb);
|
2010-02-17 03:30:23 -07:00
|
|
|
netdev_warn(dev->net, "link cmd failure\n");
|
2009-05-04 13:01:43 -06:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
static int eem_bind(struct usbnet *dev, struct usb_interface *intf)
|
|
|
|
{
|
|
|
|
int status = 0;
|
|
|
|
|
|
|
|
status = usbnet_get_endpoints(dev, intf);
|
2018-03-07 02:46:58 -07:00
|
|
|
if (status < 0)
|
2009-05-04 13:01:43 -06:00
|
|
|
return status;
|
|
|
|
|
|
|
|
/* no jumbogram (16K) support for now */
|
|
|
|
|
2012-11-07 07:39:19 -07:00
|
|
|
dev->net->hard_header_len += EEM_HEAD + ETH_FCS_LEN + VLAN_HLEN;
|
2012-03-29 01:15:15 -06:00
|
|
|
dev->hard_mtu = dev->net->mtu + dev->net->hard_header_len;
|
2009-05-04 13:01:43 -06:00
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* EEM permits packing multiple Ethernet frames into USB transfers
|
|
|
|
* (a "bundle"), but for TX we don't try to do that.
|
|
|
|
*/
|
|
|
|
static struct sk_buff *eem_tx_fixup(struct usbnet *dev, struct sk_buff *skb,
|
|
|
|
gfp_t flags)
|
|
|
|
{
|
|
|
|
struct sk_buff *skb2 = NULL;
|
|
|
|
u16 len = skb->len;
|
|
|
|
u32 crc = 0;
|
|
|
|
int padlen = 0;
|
|
|
|
|
|
|
|
/* When ((len + EEM_HEAD + ETH_FCS_LEN) % dev->maxpacket) is
|
|
|
|
* zero, stick two bytes of zero length EEM packet on the end.
|
|
|
|
* Else the framework would add invalid single byte padding,
|
|
|
|
* since it can't know whether ZLPs will be handled right by
|
|
|
|
* all the relevant hardware and software.
|
|
|
|
*/
|
|
|
|
if (!((len + EEM_HEAD + ETH_FCS_LEN) % dev->maxpacket))
|
|
|
|
padlen += 2;
|
|
|
|
|
|
|
|
if (!skb_cloned(skb)) {
|
|
|
|
int headroom = skb_headroom(skb);
|
|
|
|
int tailroom = skb_tailroom(skb);
|
|
|
|
|
2009-12-03 00:58:21 -07:00
|
|
|
if ((tailroom >= ETH_FCS_LEN + padlen) &&
|
|
|
|
(headroom >= EEM_HEAD))
|
2009-05-04 13:01:43 -06:00
|
|
|
goto done;
|
|
|
|
|
|
|
|
if ((headroom + tailroom)
|
|
|
|
> (EEM_HEAD + ETH_FCS_LEN + padlen)) {
|
|
|
|
skb->data = memmove(skb->head +
|
|
|
|
EEM_HEAD,
|
|
|
|
skb->data,
|
|
|
|
skb->len);
|
|
|
|
skb_set_tail_pointer(skb, len);
|
|
|
|
goto done;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
skb2 = skb_copy_expand(skb, EEM_HEAD, ETH_FCS_LEN + padlen, flags);
|
|
|
|
if (!skb2)
|
|
|
|
return NULL;
|
|
|
|
|
|
|
|
dev_kfree_skb_any(skb);
|
|
|
|
skb = skb2;
|
|
|
|
|
|
|
|
done:
|
|
|
|
/* we don't use the "no Ethernet CRC" option */
|
|
|
|
crc = crc32_le(~0, skb->data, skb->len);
|
|
|
|
crc = ~crc;
|
|
|
|
|
|
|
|
put_unaligned_le32(crc, skb_put(skb, 4));
|
|
|
|
|
|
|
|
/* EEM packet header format:
|
|
|
|
* b0..13: length of ethernet frame
|
|
|
|
* b14: bmCRC (1 == valid Ethernet CRC)
|
|
|
|
* b15: bmType (0 == data)
|
|
|
|
*/
|
|
|
|
len = skb->len;
|
|
|
|
put_unaligned_le16(BIT(14) | len, skb_push(skb, 2));
|
|
|
|
|
|
|
|
/* Bundle a zero length EEM packet if needed */
|
|
|
|
if (padlen)
|
|
|
|
put_unaligned_le16(0, skb_put(skb, 2));
|
|
|
|
|
|
|
|
return skb;
|
|
|
|
}
|
|
|
|
|
|
|
|
static int eem_rx_fixup(struct usbnet *dev, struct sk_buff *skb)
|
|
|
|
{
|
|
|
|
/*
|
|
|
|
* Our task here is to strip off framing, leaving skb with one
|
|
|
|
* data frame for the usbnet framework code to process. But we
|
|
|
|
* may have received multiple EEM payloads, or command payloads.
|
|
|
|
* So we must process _everything_ as if it's a header, except
|
|
|
|
* maybe the last data payload
|
|
|
|
*
|
|
|
|
* REVISIT the framework needs updating so that when we consume
|
|
|
|
* all payloads (the last or only message was a command, or a
|
|
|
|
* zero length EEM packet) that is not accounted as an rx_error.
|
|
|
|
*/
|
|
|
|
do {
|
|
|
|
struct sk_buff *skb2 = NULL;
|
|
|
|
u16 header;
|
|
|
|
u16 len = 0;
|
|
|
|
|
|
|
|
/* incomplete EEM header? */
|
|
|
|
if (skb->len < EEM_HEAD)
|
|
|
|
return 0;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* EEM packet header format:
|
2011-03-30 19:57:33 -06:00
|
|
|
* b0..14: EEM type dependent (Data or Command)
|
2009-05-04 13:01:43 -06:00
|
|
|
* b15: bmType
|
|
|
|
*/
|
|
|
|
header = get_unaligned_le16(skb->data);
|
|
|
|
skb_pull(skb, EEM_HEAD);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* The bmType bit helps to denote when EEM
|
|
|
|
* packet is data or command :
|
|
|
|
* bmType = 0 : EEM data payload
|
|
|
|
* bmType = 1 : EEM (link) command
|
|
|
|
*/
|
|
|
|
if (header & BIT(15)) {
|
|
|
|
u16 bmEEMCmd;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* EEM (link) command packet:
|
|
|
|
* b0..10: bmEEMCmdParam
|
|
|
|
* b11..13: bmEEMCmd
|
|
|
|
* b14: bmReserved (must be 0)
|
|
|
|
* b15: 1 (EEM command)
|
|
|
|
*/
|
|
|
|
if (header & BIT(14)) {
|
2010-02-17 03:30:23 -07:00
|
|
|
netdev_dbg(dev->net, "reserved command %04x\n",
|
|
|
|
header);
|
2009-05-04 13:01:43 -06:00
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
|
|
|
bmEEMCmd = (header >> 11) & 0x7;
|
|
|
|
switch (bmEEMCmd) {
|
|
|
|
|
|
|
|
/* Responding to echo requests is mandatory. */
|
|
|
|
case 0: /* Echo command */
|
|
|
|
len = header & 0x7FF;
|
|
|
|
|
|
|
|
/* bogus command? */
|
|
|
|
if (skb->len < len)
|
|
|
|
return 0;
|
|
|
|
|
|
|
|
skb2 = skb_clone(skb, GFP_ATOMIC);
|
|
|
|
if (unlikely(!skb2))
|
|
|
|
goto next;
|
|
|
|
skb_trim(skb2, len);
|
|
|
|
put_unaligned_le16(BIT(15) | (1 << 11) | len,
|
|
|
|
skb_push(skb2, 2));
|
|
|
|
eem_linkcmd(dev, skb2);
|
|
|
|
break;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Host may choose to ignore hints.
|
|
|
|
* - suspend: peripheral ready to suspend
|
|
|
|
* - response: suggest N millisec polling
|
|
|
|
* - response complete: suggest N sec polling
|
2012-10-10 20:50:10 -06:00
|
|
|
*
|
|
|
|
* Suspend is reported and maybe heeded.
|
2009-05-04 13:01:43 -06:00
|
|
|
*/
|
|
|
|
case 2: /* Suspend hint */
|
2012-10-10 20:50:10 -06:00
|
|
|
usbnet_device_suggests_idle(dev);
|
|
|
|
continue;
|
2009-05-04 13:01:43 -06:00
|
|
|
case 3: /* Response hint */
|
|
|
|
case 4: /* Response complete hint */
|
|
|
|
continue;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Hosts should never receive host-to-peripheral
|
|
|
|
* or reserved command codes; or responses to an
|
|
|
|
* echo command we didn't send.
|
|
|
|
*/
|
|
|
|
case 1: /* Echo response */
|
|
|
|
case 5: /* Tickle */
|
|
|
|
default: /* reserved */
|
2010-02-17 03:30:23 -07:00
|
|
|
netdev_warn(dev->net,
|
|
|
|
"unexpected link command %d\n",
|
|
|
|
bmEEMCmd);
|
2009-05-04 13:01:43 -06:00
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
|
|
|
} else {
|
|
|
|
u32 crc, crc2;
|
|
|
|
int is_last;
|
|
|
|
|
|
|
|
/* zero length EEM packet? */
|
|
|
|
if (header == 0)
|
|
|
|
continue;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* EEM data packet header :
|
|
|
|
* b0..13: length of ethernet frame
|
|
|
|
* b14: bmCRC
|
|
|
|
* b15: 0 (EEM data)
|
|
|
|
*/
|
|
|
|
len = header & 0x3FFF;
|
|
|
|
|
|
|
|
/* bogus EEM payload? */
|
|
|
|
if (skb->len < len)
|
|
|
|
return 0;
|
|
|
|
|
|
|
|
/* bogus ethernet frame? */
|
|
|
|
if (len < (ETH_HLEN + ETH_FCS_LEN))
|
|
|
|
goto next;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Treat the last payload differently: framework
|
|
|
|
* code expects our "fixup" to have stripped off
|
|
|
|
* headers, so "skb" is a data packet (or error).
|
|
|
|
* Else if it's not the last payload, keep "skb"
|
|
|
|
* for further processing.
|
|
|
|
*/
|
|
|
|
is_last = (len == skb->len);
|
|
|
|
if (is_last)
|
|
|
|
skb2 = skb;
|
|
|
|
else {
|
|
|
|
skb2 = skb_clone(skb, GFP_ATOMIC);
|
|
|
|
if (unlikely(!skb2))
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* The bmCRC helps to denote when the CRC field in
|
|
|
|
* the Ethernet frame contains a calculated CRC:
|
|
|
|
* bmCRC = 1 : CRC is calculated
|
|
|
|
* bmCRC = 0 : CRC = 0xDEADBEEF
|
|
|
|
*/
|
2009-08-10 15:46:59 -06:00
|
|
|
if (header & BIT(14)) {
|
|
|
|
crc = get_unaligned_le32(skb2->data
|
|
|
|
+ len - ETH_FCS_LEN);
|
|
|
|
crc2 = ~crc32_le(~0, skb2->data, skb2->len
|
|
|
|
- ETH_FCS_LEN);
|
|
|
|
} else {
|
|
|
|
crc = get_unaligned_be32(skb2->data
|
|
|
|
+ len - ETH_FCS_LEN);
|
2009-05-04 13:01:43 -06:00
|
|
|
crc2 = 0xdeadbeef;
|
2009-08-10 15:46:59 -06:00
|
|
|
}
|
|
|
|
skb_trim(skb2, len - ETH_FCS_LEN);
|
2009-05-04 13:01:43 -06:00
|
|
|
|
|
|
|
if (is_last)
|
|
|
|
return crc == crc2;
|
|
|
|
|
|
|
|
if (unlikely(crc != crc2)) {
|
2009-06-29 10:49:40 -06:00
|
|
|
dev->net->stats.rx_errors++;
|
2009-05-04 13:01:43 -06:00
|
|
|
dev_kfree_skb_any(skb2);
|
|
|
|
} else
|
|
|
|
usbnet_skb_return(dev, skb2);
|
|
|
|
}
|
|
|
|
|
|
|
|
next:
|
|
|
|
skb_pull(skb, len);
|
|
|
|
} while (skb->len);
|
|
|
|
|
|
|
|
return 1;
|
|
|
|
}
|
|
|
|
|
|
|
|
static const struct driver_info eem_info = {
|
|
|
|
.description = "CDC EEM Device",
|
usbnet: use eth%d name for known ethernet devices
The documentation for the USB ethernet devices suggests that
only some devices are supposed to use usb0 as the network interface
name instead of eth0. The logic used there, and documented in
Kconfig for CDC is that eth0 will be used when the mac address
is a globally assigned one, but usb0 is used for the locally
managed range that is typically used on point-to-point links.
Unfortunately, this has caused a lot of pain on the smsc95xx
device that is used on the popular pandaboard without an
EEPROM to store the MAC address, which causes the driver to
call random_ether_address().
Obviously, there should be a proper MAC addressed assigned to
the device, and discussions are ongoing about how to solve
this, but this patch at least makes sure that the default
interface naming gets a little saner and matches what the
user can expect based on the documentation, including for
new devices.
The approach taken here is to flag whether a device might be a
point-to-point link with the new FLAG_POINTTOPOINT setting in
the usbnet driver_info. A driver can set both FLAG_POINTTOPOINT
and FLAG_ETHER if it is not sure (e.g. cdc_ether), or just one
of the two. The usbnet framework only looks at the MAC address
for device naming if both flags are set, otherwise it trusts the
flag.
Signed-off-by: Arnd Bergmann <arnd.bergmann@linaro.org>
Tested-by: Andy Green <andy.green@linaro.org>
Signed-off-by: David S. Miller <davem@davemloft.net>
2011-04-01 21:12:02 -06:00
|
|
|
.flags = FLAG_ETHER | FLAG_POINTTOPOINT,
|
2009-05-04 13:01:43 -06:00
|
|
|
.bind = eem_bind,
|
|
|
|
.rx_fixup = eem_rx_fixup,
|
|
|
|
.tx_fixup = eem_tx_fixup,
|
|
|
|
};
|
|
|
|
|
|
|
|
/*-------------------------------------------------------------------------*/
|
|
|
|
|
|
|
|
static const struct usb_device_id products[] = {
|
|
|
|
{
|
|
|
|
USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_EEM,
|
|
|
|
USB_CDC_PROTO_EEM),
|
|
|
|
.driver_info = (unsigned long) &eem_info,
|
|
|
|
},
|
|
|
|
{
|
|
|
|
/* EMPTY == end of list */
|
|
|
|
},
|
|
|
|
};
|
|
|
|
MODULE_DEVICE_TABLE(usb, products);
|
|
|
|
|
|
|
|
static struct usb_driver eem_driver = {
|
|
|
|
.name = "cdc_eem",
|
|
|
|
.id_table = products,
|
|
|
|
.probe = usbnet_probe,
|
|
|
|
.disconnect = usbnet_disconnect,
|
|
|
|
.suspend = usbnet_suspend,
|
|
|
|
.resume = usbnet_resume,
|
2012-04-23 11:08:51 -06:00
|
|
|
.disable_hub_initiated_lpm = 1,
|
2009-05-04 13:01:43 -06:00
|
|
|
};
|
|
|
|
|
2011-11-18 10:44:20 -07:00
|
|
|
module_usb_driver(eem_driver);
|
2009-05-04 13:01:43 -06:00
|
|
|
|
|
|
|
MODULE_AUTHOR("Omar Laazimani <omar.oberthur@gmail.com>");
|
|
|
|
MODULE_DESCRIPTION("USB CDC EEM");
|
|
|
|
MODULE_LICENSE("GPL");
|