15b2fc499SJeff Garzik /* 25b2fc499SJeff Garzik * Host Side support for RNDIS Networking Links 35b2fc499SJeff Garzik * Copyright (C) 2005 by David Brownell 45b2fc499SJeff Garzik * 55b2fc499SJeff Garzik * This program is free software; you can redistribute it and/or modify 65b2fc499SJeff Garzik * it under the terms of the GNU General Public License as published by 75b2fc499SJeff Garzik * the Free Software Foundation; either version 2 of the License, or 85b2fc499SJeff Garzik * (at your option) any later version. 95b2fc499SJeff Garzik * 105b2fc499SJeff Garzik * This program is distributed in the hope that it will be useful, 115b2fc499SJeff Garzik * but WITHOUT ANY WARRANTY; without even the implied warranty of 125b2fc499SJeff Garzik * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 135b2fc499SJeff Garzik * GNU General Public License for more details. 145b2fc499SJeff Garzik * 155b2fc499SJeff Garzik * You should have received a copy of the GNU General Public License 169cb00073SJeff Kirsher * along with this program; if not, see <http://www.gnu.org/licenses/>. 175b2fc499SJeff Garzik */ 185b2fc499SJeff Garzik #include <linux/module.h> 195b2fc499SJeff Garzik #include <linux/netdevice.h> 205b2fc499SJeff Garzik #include <linux/etherdevice.h> 215b2fc499SJeff Garzik #include <linux/ethtool.h> 225b2fc499SJeff Garzik #include <linux/workqueue.h> 235a0e3ad6STejun Heo #include <linux/slab.h> 245b2fc499SJeff Garzik #include <linux/mii.h> 255b2fc499SJeff Garzik #include <linux/usb.h> 265b2fc499SJeff Garzik #include <linux/usb/cdc.h> 273692e94fSJussi Kivilinna #include <linux/usb/usbnet.h> 283692e94fSJussi Kivilinna #include <linux/usb/rndis_host.h> 295b2fc499SJeff Garzik 305b2fc499SJeff Garzik 315b2fc499SJeff Garzik /* 325b2fc499SJeff Garzik * RNDIS is NDIS remoted over USB. It's a MSFT variant of CDC ACM ... of 335b2fc499SJeff Garzik * course ACM was intended for modems, not Ethernet links! USB's standard 345b2fc499SJeff Garzik * for Ethernet links is "CDC Ethernet", which is significantly simpler. 355b2fc499SJeff Garzik * 365b2fc499SJeff Garzik * NOTE that Microsoft's "RNDIS 1.0" specification is incomplete. Issues 375b2fc499SJeff Garzik * include: 385b2fc499SJeff Garzik * - Power management in particular relies on information that's scattered 395b2fc499SJeff Garzik * through other documentation, and which is incomplete or incorrect even 405b2fc499SJeff Garzik * there. 415b2fc499SJeff Garzik * - There are various undocumented protocol requirements, such as the 425b2fc499SJeff Garzik * need to send unused garbage in control-OUT messages. 435b2fc499SJeff Garzik * - In some cases, MS-Windows will emit undocumented requests; this 445b2fc499SJeff Garzik * matters more to peripheral implementations than host ones. 455b2fc499SJeff Garzik * 465b2fc499SJeff Garzik * Moreover there's a no-open-specs variant of RNDIS called "ActiveSync". 475b2fc499SJeff Garzik * 485b2fc499SJeff Garzik * For these reasons and others, ** USE OF RNDIS IS STRONGLY DISCOURAGED ** in 495b2fc499SJeff Garzik * favor of such non-proprietary alternatives as CDC Ethernet or the newer (and 505b2fc499SJeff Garzik * currently rare) "Ethernet Emulation Model" (EEM). 515b2fc499SJeff Garzik */ 525b2fc499SJeff Garzik 535b2fc499SJeff Garzik /* 545b2fc499SJeff Garzik * RNDIS notifications from device: command completion; "reverse" 555b2fc499SJeff Garzik * keepalives; etc 565b2fc499SJeff Garzik */ 575665998cSJussi Kivilinna void rndis_status(struct usbnet *dev, struct urb *urb) 585b2fc499SJeff Garzik { 5960b86755SJoe Perches netdev_dbg(dev->net, "rndis status urb, len %d stat %d\n", 605b2fc499SJeff Garzik urb->actual_length, urb->status); 615b2fc499SJeff Garzik // FIXME for keepalives, respond immediately (asynchronously) 625b2fc499SJeff Garzik // if not an RNDIS status, do like cdc_status(dev,urb) does 635b2fc499SJeff Garzik } 645665998cSJussi Kivilinna EXPORT_SYMBOL_GPL(rndis_status); 655b2fc499SJeff Garzik 665b2fc499SJeff Garzik /* 672a4901bcSJussi Kivilinna * RNDIS indicate messages. 682a4901bcSJussi Kivilinna */ 692a4901bcSJussi Kivilinna static void rndis_msg_indicate(struct usbnet *dev, struct rndis_indicate *msg, 702a4901bcSJussi Kivilinna int buflen) 712a4901bcSJussi Kivilinna { 722a4901bcSJussi Kivilinna struct cdc_state *info = (void *)&dev->data; 732a4901bcSJussi Kivilinna struct device *udev = &info->control->dev; 742a4901bcSJussi Kivilinna 752a4901bcSJussi Kivilinna if (dev->driver_info->indication) { 762a4901bcSJussi Kivilinna dev->driver_info->indication(dev, msg, buflen); 772a4901bcSJussi Kivilinna } else { 783eef3668SJussi Kivilinna u32 status = le32_to_cpu(msg->status); 793eef3668SJussi Kivilinna 803eef3668SJussi Kivilinna switch (status) { 813eef3668SJussi Kivilinna case RNDIS_STATUS_MEDIA_CONNECT: 822a4901bcSJussi Kivilinna dev_info(udev, "rndis media connect\n"); 832a4901bcSJussi Kivilinna break; 843eef3668SJussi Kivilinna case RNDIS_STATUS_MEDIA_DISCONNECT: 852a4901bcSJussi Kivilinna dev_info(udev, "rndis media disconnect\n"); 862a4901bcSJussi Kivilinna break; 872a4901bcSJussi Kivilinna default: 883eef3668SJussi Kivilinna dev_info(udev, "rndis indication: 0x%08x\n", status); 892a4901bcSJussi Kivilinna } 902a4901bcSJussi Kivilinna } 912a4901bcSJussi Kivilinna } 922a4901bcSJussi Kivilinna 932a4901bcSJussi Kivilinna /* 945b2fc499SJeff Garzik * RPC done RNDIS-style. Caller guarantees: 955b2fc499SJeff Garzik * - message is properly byteswapped 965b2fc499SJeff Garzik * - there's no other request pending 975b2fc499SJeff Garzik * - buf can hold up to 1KB response (required by RNDIS spec) 985b2fc499SJeff Garzik * On return, the first few entries are already byteswapped. 995b2fc499SJeff Garzik * 1005b2fc499SJeff Garzik * Call context is likely probe(), before interface name is known, 1015b2fc499SJeff Garzik * which is why we won't try to use it in the diagnostics. 1025b2fc499SJeff Garzik */ 103818727baSJussi Kivilinna int rndis_command(struct usbnet *dev, struct rndis_msg_hdr *buf, int buflen) 1045b2fc499SJeff Garzik { 1055b2fc499SJeff Garzik struct cdc_state *info = (void *) &dev->data; 1064d42d417SBen Hutchings struct usb_cdc_notification notification; 1075b2fc499SJeff Garzik int master_ifnum; 1085b2fc499SJeff Garzik int retval; 1094d42d417SBen Hutchings int partial; 1105b2fc499SJeff Garzik unsigned count; 1113eef3668SJussi Kivilinna u32 xid = 0, msg_len, request_id, msg_type, rsp, 1123eef3668SJussi Kivilinna status; 1135b2fc499SJeff Garzik 1145b2fc499SJeff Garzik /* REVISIT when this gets called from contexts other than probe() or 1155b2fc499SJeff Garzik * disconnect(): either serialize, or dispatch responses on xid 1165b2fc499SJeff Garzik */ 1175b2fc499SJeff Garzik 1183eef3668SJussi Kivilinna msg_type = le32_to_cpu(buf->msg_type); 1193eef3668SJussi Kivilinna 1205b2fc499SJeff Garzik /* Issue the request; xid is unique, don't bother byteswapping it */ 1213eef3668SJussi Kivilinna if (likely(msg_type != RNDIS_MSG_HALT && msg_type != RNDIS_MSG_RESET)) { 1225b2fc499SJeff Garzik xid = dev->xid++; 1235b2fc499SJeff Garzik if (!xid) 1245b2fc499SJeff Garzik xid = dev->xid++; 1255b2fc499SJeff Garzik buf->request_id = (__force __le32) xid; 1265b2fc499SJeff Garzik } 1275b2fc499SJeff Garzik master_ifnum = info->control->cur_altsetting->desc.bInterfaceNumber; 1285b2fc499SJeff Garzik retval = usb_control_msg(dev->udev, 1295b2fc499SJeff Garzik usb_sndctrlpipe(dev->udev, 0), 1305b2fc499SJeff Garzik USB_CDC_SEND_ENCAPSULATED_COMMAND, 1315b2fc499SJeff Garzik USB_TYPE_CLASS | USB_RECIP_INTERFACE, 1325b2fc499SJeff Garzik 0, master_ifnum, 1335b2fc499SJeff Garzik buf, le32_to_cpu(buf->msg_len), 1345b2fc499SJeff Garzik RNDIS_CONTROL_TIMEOUT_MS); 1355b2fc499SJeff Garzik if (unlikely(retval < 0 || xid == 0)) 1365b2fc499SJeff Garzik return retval; 1375b2fc499SJeff Garzik 1384d42d417SBen Hutchings /* Some devices don't respond on the control channel until 1394d42d417SBen Hutchings * polled on the status channel, so do that first. */ 1404d42d417SBen Hutchings if (dev->driver_info->data & RNDIS_DRIVER_DATA_POLL_STATUS) { 1414d42d417SBen Hutchings retval = usb_interrupt_msg( 1424d42d417SBen Hutchings dev->udev, 1434d42d417SBen Hutchings usb_rcvintpipe(dev->udev, 1444d42d417SBen Hutchings dev->status->desc.bEndpointAddress), 1454d42d417SBen Hutchings ¬ification, sizeof(notification), &partial, 1464d42d417SBen Hutchings RNDIS_CONTROL_TIMEOUT_MS); 1474d42d417SBen Hutchings if (unlikely(retval < 0)) 1484d42d417SBen Hutchings return retval; 1494d42d417SBen Hutchings } 1505b2fc499SJeff Garzik 1514d42d417SBen Hutchings /* Poll the control channel; the request probably completed immediately */ 1523eef3668SJussi Kivilinna rsp = le32_to_cpu(buf->msg_type) | RNDIS_MSG_COMPLETION; 1535b2fc499SJeff Garzik for (count = 0; count < 10; count++) { 1545b2fc499SJeff Garzik memset(buf, 0, CONTROL_BUFFER_SIZE); 1555b2fc499SJeff Garzik retval = usb_control_msg(dev->udev, 1565b2fc499SJeff Garzik usb_rcvctrlpipe(dev->udev, 0), 1575b2fc499SJeff Garzik USB_CDC_GET_ENCAPSULATED_RESPONSE, 1585b2fc499SJeff Garzik USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE, 1595b2fc499SJeff Garzik 0, master_ifnum, 160818727baSJussi Kivilinna buf, buflen, 1615b2fc499SJeff Garzik RNDIS_CONTROL_TIMEOUT_MS); 1625b2fc499SJeff Garzik if (likely(retval >= 8)) { 1633eef3668SJussi Kivilinna msg_type = le32_to_cpu(buf->msg_type); 1645b2fc499SJeff Garzik msg_len = le32_to_cpu(buf->msg_len); 1653eef3668SJussi Kivilinna status = le32_to_cpu(buf->status); 1665b2fc499SJeff Garzik request_id = (__force u32) buf->request_id; 1673eef3668SJussi Kivilinna if (likely(msg_type == rsp)) { 1685b2fc499SJeff Garzik if (likely(request_id == xid)) { 1693eef3668SJussi Kivilinna if (unlikely(rsp == RNDIS_MSG_RESET_C)) 1705b2fc499SJeff Garzik return 0; 1713eef3668SJussi Kivilinna if (likely(RNDIS_STATUS_SUCCESS == 1723eef3668SJussi Kivilinna status)) 1735b2fc499SJeff Garzik return 0; 1745b2fc499SJeff Garzik dev_dbg(&info->control->dev, 1755b2fc499SJeff Garzik "rndis reply status %08x\n", 1763eef3668SJussi Kivilinna status); 1775b2fc499SJeff Garzik return -EL3RST; 1785b2fc499SJeff Garzik } 1795b2fc499SJeff Garzik dev_dbg(&info->control->dev, 1805b2fc499SJeff Garzik "rndis reply id %d expected %d\n", 1815b2fc499SJeff Garzik request_id, xid); 1825b2fc499SJeff Garzik /* then likely retry */ 1833eef3668SJussi Kivilinna } else switch (msg_type) { 1843eef3668SJussi Kivilinna case RNDIS_MSG_INDICATE: /* fault/event */ 1852a4901bcSJussi Kivilinna rndis_msg_indicate(dev, (void *)buf, buflen); 1865b2fc499SJeff Garzik break; 1873eef3668SJussi Kivilinna case RNDIS_MSG_KEEPALIVE: { /* ping */ 1885b2fc499SJeff Garzik struct rndis_keepalive_c *msg = (void *)buf; 1895b2fc499SJeff Garzik 1907390e8b0SLinus Walleij msg->msg_type = cpu_to_le32(RNDIS_MSG_KEEPALIVE_C); 19135c26c2cSHarvey Harrison msg->msg_len = cpu_to_le32(sizeof *msg); 1927390e8b0SLinus Walleij msg->status = cpu_to_le32(RNDIS_STATUS_SUCCESS); 1935b2fc499SJeff Garzik retval = usb_control_msg(dev->udev, 1945b2fc499SJeff Garzik usb_sndctrlpipe(dev->udev, 0), 1955b2fc499SJeff Garzik USB_CDC_SEND_ENCAPSULATED_COMMAND, 1965b2fc499SJeff Garzik USB_TYPE_CLASS | USB_RECIP_INTERFACE, 1975b2fc499SJeff Garzik 0, master_ifnum, 1985b2fc499SJeff Garzik msg, sizeof *msg, 1995b2fc499SJeff Garzik RNDIS_CONTROL_TIMEOUT_MS); 2005b2fc499SJeff Garzik if (unlikely(retval < 0)) 2015b2fc499SJeff Garzik dev_dbg(&info->control->dev, 2025b2fc499SJeff Garzik "rndis keepalive err %d\n", 2035b2fc499SJeff Garzik retval); 2045b2fc499SJeff Garzik } 2055b2fc499SJeff Garzik break; 2065b2fc499SJeff Garzik default: 2075b2fc499SJeff Garzik dev_dbg(&info->control->dev, 2085b2fc499SJeff Garzik "unexpected rndis msg %08x len %d\n", 2095b2fc499SJeff Garzik le32_to_cpu(buf->msg_type), msg_len); 2105b2fc499SJeff Garzik } 2115b2fc499SJeff Garzik } else { 2125b2fc499SJeff Garzik /* device probably issued a protocol stall; ignore */ 2135b2fc499SJeff Garzik dev_dbg(&info->control->dev, 2145b2fc499SJeff Garzik "rndis response error, code %d\n", retval); 2155b2fc499SJeff Garzik } 21674ef5c50SPierre Ynard msleep(20); 2175b2fc499SJeff Garzik } 2185b2fc499SJeff Garzik dev_dbg(&info->control->dev, "rndis response timeout\n"); 2195b2fc499SJeff Garzik return -ETIMEDOUT; 2205b2fc499SJeff Garzik } 2215665998cSJussi Kivilinna EXPORT_SYMBOL_GPL(rndis_command); 2225b2fc499SJeff Garzik 2235b2fc499SJeff Garzik /* 2245b2fc499SJeff Garzik * rndis_query: 2255b2fc499SJeff Garzik * 2265b2fc499SJeff Garzik * Performs a query for @oid along with 0 or more bytes of payload as 2275b2fc499SJeff Garzik * specified by @in_len. If @reply_len is not set to -1 then the reply 2285b2fc499SJeff Garzik * length is checked against this value, resulting in an error if it 2295b2fc499SJeff Garzik * doesn't match. 2305b2fc499SJeff Garzik * 2315b2fc499SJeff Garzik * NOTE: Adding a payload exactly or greater than the size of the expected 2325b2fc499SJeff Garzik * response payload is an evident requirement MSFT added for ActiveSync. 2335b2fc499SJeff Garzik * 2345b2fc499SJeff Garzik * The only exception is for OIDs that return a variably sized response, 2355b2fc499SJeff Garzik * in which case no payload should be added. This undocumented (and 2365b2fc499SJeff Garzik * nonsensical!) issue was found by sniffing protocol requests from the 2375b2fc499SJeff Garzik * ActiveSync 4.1 Windows driver. 2385b2fc499SJeff Garzik */ 2395b2fc499SJeff Garzik static int rndis_query(struct usbnet *dev, struct usb_interface *intf, 2405432bdc0SJussi Kivilinna void *buf, u32 oid, u32 in_len, 2415b2fc499SJeff Garzik void **reply, int *reply_len) 2425b2fc499SJeff Garzik { 2435b2fc499SJeff Garzik int retval; 2445b2fc499SJeff Garzik union { 2455b2fc499SJeff Garzik void *buf; 2465b2fc499SJeff Garzik struct rndis_msg_hdr *header; 2475b2fc499SJeff Garzik struct rndis_query *get; 2485b2fc499SJeff Garzik struct rndis_query_c *get_c; 2495b2fc499SJeff Garzik } u; 2505b2fc499SJeff Garzik u32 off, len; 2515b2fc499SJeff Garzik 2525b2fc499SJeff Garzik u.buf = buf; 2535b2fc499SJeff Garzik 2545b2fc499SJeff Garzik memset(u.get, 0, sizeof *u.get + in_len); 2557390e8b0SLinus Walleij u.get->msg_type = cpu_to_le32(RNDIS_MSG_QUERY); 2565b2fc499SJeff Garzik u.get->msg_len = cpu_to_le32(sizeof *u.get + in_len); 2575432bdc0SJussi Kivilinna u.get->oid = cpu_to_le32(oid); 2585b2fc499SJeff Garzik u.get->len = cpu_to_le32(in_len); 25935c26c2cSHarvey Harrison u.get->offset = cpu_to_le32(20); 2605b2fc499SJeff Garzik 261818727baSJussi Kivilinna retval = rndis_command(dev, u.header, CONTROL_BUFFER_SIZE); 2625b2fc499SJeff Garzik if (unlikely(retval < 0)) { 2635b2fc499SJeff Garzik dev_err(&intf->dev, "RNDIS_MSG_QUERY(0x%08x) failed, %d\n", 2645b2fc499SJeff Garzik oid, retval); 2655b2fc499SJeff Garzik return retval; 2665b2fc499SJeff Garzik } 2675b2fc499SJeff Garzik 2685b2fc499SJeff Garzik off = le32_to_cpu(u.get_c->offset); 2695b2fc499SJeff Garzik len = le32_to_cpu(u.get_c->len); 2705b2fc499SJeff Garzik if (unlikely((8 + off + len) > CONTROL_BUFFER_SIZE)) 2715b2fc499SJeff Garzik goto response_error; 2725b2fc499SJeff Garzik 2735b2fc499SJeff Garzik if (*reply_len != -1 && len != *reply_len) 2745b2fc499SJeff Garzik goto response_error; 2755b2fc499SJeff Garzik 2765b2fc499SJeff Garzik *reply = (unsigned char *) &u.get_c->request_id + off; 2775b2fc499SJeff Garzik *reply_len = len; 2785b2fc499SJeff Garzik 2795b2fc499SJeff Garzik return retval; 2805b2fc499SJeff Garzik 2815b2fc499SJeff Garzik response_error: 2825b2fc499SJeff Garzik dev_err(&intf->dev, "RNDIS_MSG_QUERY(0x%08x) " 2835b2fc499SJeff Garzik "invalid response - off %d len %d\n", 2845b2fc499SJeff Garzik oid, off, len); 2855b2fc499SJeff Garzik return -EDOM; 2865b2fc499SJeff Garzik } 2875b2fc499SJeff Garzik 2880f2166dfSStephen Hemminger /* same as usbnet_netdev_ops but MTU change not allowed */ 2890f2166dfSStephen Hemminger static const struct net_device_ops rndis_netdev_ops = { 2900f2166dfSStephen Hemminger .ndo_open = usbnet_open, 2910f2166dfSStephen Hemminger .ndo_stop = usbnet_stop, 2920f2166dfSStephen Hemminger .ndo_start_xmit = usbnet_start_xmit, 2930f2166dfSStephen Hemminger .ndo_tx_timeout = usbnet_tx_timeout, 2940f2166dfSStephen Hemminger .ndo_set_mac_address = eth_mac_addr, 2950f2166dfSStephen Hemminger .ndo_validate_addr = eth_validate_addr, 2960f2166dfSStephen Hemminger }; 2970f2166dfSStephen Hemminger 298039ee17dSJussi Kivilinna int 299039ee17dSJussi Kivilinna generic_rndis_bind(struct usbnet *dev, struct usb_interface *intf, int flags) 3005b2fc499SJeff Garzik { 3015b2fc499SJeff Garzik int retval; 3025b2fc499SJeff Garzik struct net_device *net = dev->net; 3035b2fc499SJeff Garzik struct cdc_state *info = (void *) &dev->data; 3045b2fc499SJeff Garzik union { 3055b2fc499SJeff Garzik void *buf; 3065b2fc499SJeff Garzik struct rndis_msg_hdr *header; 3075b2fc499SJeff Garzik struct rndis_init *init; 3085b2fc499SJeff Garzik struct rndis_init_c *init_c; 3095b2fc499SJeff Garzik struct rndis_query *get; 3105b2fc499SJeff Garzik struct rndis_query_c *get_c; 3115b2fc499SJeff Garzik struct rndis_set *set; 3125b2fc499SJeff Garzik struct rndis_set_c *set_c; 3139ff55874SJussi Kivilinna struct rndis_halt *halt; 3145b2fc499SJeff Garzik } u; 315d63ddcecSAl Viro u32 tmp; 316d63ddcecSAl Viro __le32 phym_unspec, *phym; 3175b2fc499SJeff Garzik int reply_len; 3185b2fc499SJeff Garzik unsigned char *bp; 3195b2fc499SJeff Garzik 3205b2fc499SJeff Garzik /* we can't rely on i/o from stack working, or stack allocation */ 3215b2fc499SJeff Garzik u.buf = kmalloc(CONTROL_BUFFER_SIZE, GFP_KERNEL); 3225b2fc499SJeff Garzik if (!u.buf) 3235b2fc499SJeff Garzik return -ENOMEM; 3245b2fc499SJeff Garzik retval = usbnet_generic_cdc_bind(dev, intf); 3255b2fc499SJeff Garzik if (retval < 0) 3265b2fc499SJeff Garzik goto fail; 3275b2fc499SJeff Garzik 3287390e8b0SLinus Walleij u.init->msg_type = cpu_to_le32(RNDIS_MSG_INIT); 32935c26c2cSHarvey Harrison u.init->msg_len = cpu_to_le32(sizeof *u.init); 33035c26c2cSHarvey Harrison u.init->major_version = cpu_to_le32(1); 33135c26c2cSHarvey Harrison u.init->minor_version = cpu_to_le32(0); 3325b2fc499SJeff Garzik 3335b2fc499SJeff Garzik /* max transfer (in spec) is 0x4000 at full speed, but for 3345b2fc499SJeff Garzik * TX we'll stick to one Ethernet packet plus RNDIS framing. 3355b2fc499SJeff Garzik * For RX we handle drivers that zero-pad to end-of-packet. 3365b2fc499SJeff Garzik * Don't let userspace change these settings. 3375b2fc499SJeff Garzik * 3385b2fc499SJeff Garzik * NOTE: there still seems to be wierdness here, as if we need 3395b2fc499SJeff Garzik * to do some more things to make sure WinCE targets accept this. 3405b2fc499SJeff Garzik * They default to jumbograms of 8KB or 16KB, which is absurd 3415b2fc499SJeff Garzik * for such low data rates and which is also more than Linux 3425b2fc499SJeff Garzik * can usually expect to allocate for SKB data... 3435b2fc499SJeff Garzik */ 3445b2fc499SJeff Garzik net->hard_header_len += sizeof (struct rndis_data_hdr); 3455b2fc499SJeff Garzik dev->hard_mtu = net->mtu + net->hard_header_len; 3465b2fc499SJeff Garzik 34710d0f27cSJean-Christophe Dubois dev->maxpacket = usb_maxpacket(dev->udev, dev->out, 1); 34810d0f27cSJean-Christophe Dubois if (dev->maxpacket == 0) { 349a475f603SJoe Perches netif_dbg(dev, probe, dev->net, 350a475f603SJoe Perches "dev->maxpacket can't be 0\n"); 35110d0f27cSJean-Christophe Dubois retval = -EINVAL; 35210d0f27cSJean-Christophe Dubois goto fail_and_release; 35310d0f27cSJean-Christophe Dubois } 35410d0f27cSJean-Christophe Dubois 3555b2fc499SJeff Garzik dev->rx_urb_size = dev->hard_mtu + (dev->maxpacket + 1); 3565b2fc499SJeff Garzik dev->rx_urb_size &= ~(dev->maxpacket - 1); 3575b2fc499SJeff Garzik u.init->max_transfer_size = cpu_to_le32(dev->rx_urb_size); 3585b2fc499SJeff Garzik 3590f2166dfSStephen Hemminger net->netdev_ops = &rndis_netdev_ops; 3600f2166dfSStephen Hemminger 361818727baSJussi Kivilinna retval = rndis_command(dev, u.header, CONTROL_BUFFER_SIZE); 3625b2fc499SJeff Garzik if (unlikely(retval < 0)) { 3635b2fc499SJeff Garzik /* it might not even be an RNDIS device!! */ 3645b2fc499SJeff Garzik dev_err(&intf->dev, "RNDIS init failed, %d\n", retval); 3655b2fc499SJeff Garzik goto fail_and_release; 3665b2fc499SJeff Garzik } 3675b2fc499SJeff Garzik tmp = le32_to_cpu(u.init_c->max_transfer_size); 3685b2fc499SJeff Garzik if (tmp < dev->hard_mtu) { 369500d2c2fSThomas Sailer if (tmp <= net->hard_header_len) { 3705b2fc499SJeff Garzik dev_err(&intf->dev, 3715b2fc499SJeff Garzik "dev can't take %u byte packets (max %u)\n", 3725b2fc499SJeff Garzik dev->hard_mtu, tmp); 3734149b72eSDavid Brownell retval = -EINVAL; 3749ff55874SJussi Kivilinna goto halt_fail_and_release; 3755b2fc499SJeff Garzik } 376500d2c2fSThomas Sailer dev_warn(&intf->dev, 377500d2c2fSThomas Sailer "dev can't take %u byte packets (max %u), " 378500d2c2fSThomas Sailer "adjusting MTU to %u\n", 37940ac7b62SGeorge Nassar dev->hard_mtu, tmp, tmp - net->hard_header_len); 38040ac7b62SGeorge Nassar dev->hard_mtu = tmp; 38140ac7b62SGeorge Nassar net->mtu = dev->hard_mtu - net->hard_header_len; 382500d2c2fSThomas Sailer } 3835b2fc499SJeff Garzik 3845b2fc499SJeff Garzik /* REVISIT: peripheral "alignment" request is ignored ... */ 3855b2fc499SJeff Garzik dev_dbg(&intf->dev, 3865b2fc499SJeff Garzik "hard mtu %u (%u from dev), rx buflen %Zu, align %d\n", 3875b2fc499SJeff Garzik dev->hard_mtu, tmp, dev->rx_urb_size, 3885b2fc499SJeff Garzik 1 << le32_to_cpu(u.init_c->packet_alignment)); 3895b2fc499SJeff Garzik 3907c39e038SJussi Kivilinna /* module has some device initialization code needs to be done right 3917c39e038SJussi Kivilinna * after RNDIS_INIT */ 3927c39e038SJussi Kivilinna if (dev->driver_info->early_init && 3937c39e038SJussi Kivilinna dev->driver_info->early_init(dev) != 0) 3947c39e038SJussi Kivilinna goto halt_fail_and_release; 3957c39e038SJussi Kivilinna 396039ee17dSJussi Kivilinna /* Check physical medium */ 3979f5e60ddSJussi Kivilinna phym = NULL; 398039ee17dSJussi Kivilinna reply_len = sizeof *phym; 3997390e8b0SLinus Walleij retval = rndis_query(dev, intf, u.buf, 4005432bdc0SJussi Kivilinna RNDIS_OID_GEN_PHYSICAL_MEDIUM, 401039ee17dSJussi Kivilinna 0, (void **) &phym, &reply_len); 4029f5e60ddSJussi Kivilinna if (retval != 0 || !phym) { 403039ee17dSJussi Kivilinna /* OID is optional so don't fail here. */ 4047390e8b0SLinus Walleij phym_unspec = cpu_to_le32(RNDIS_PHYSICAL_MEDIUM_UNSPECIFIED); 4059f5e60ddSJussi Kivilinna phym = &phym_unspec; 4069f5e60ddSJussi Kivilinna } 407039ee17dSJussi Kivilinna if ((flags & FLAG_RNDIS_PHYM_WIRELESS) && 4083eef3668SJussi Kivilinna le32_to_cpup(phym) != RNDIS_PHYSICAL_MEDIUM_WIRELESS_LAN) { 409a475f603SJoe Perches netif_dbg(dev, probe, dev->net, 410a475f603SJoe Perches "driver requires wireless physical medium, but device is not\n"); 411039ee17dSJussi Kivilinna retval = -ENODEV; 412039ee17dSJussi Kivilinna goto halt_fail_and_release; 413039ee17dSJussi Kivilinna } 414039ee17dSJussi Kivilinna if ((flags & FLAG_RNDIS_PHYM_NOT_WIRELESS) && 4153eef3668SJussi Kivilinna le32_to_cpup(phym) == RNDIS_PHYSICAL_MEDIUM_WIRELESS_LAN) { 416a475f603SJoe Perches netif_dbg(dev, probe, dev->net, 417a475f603SJoe Perches "driver requires non-wireless physical medium, but device is wireless.\n"); 418039ee17dSJussi Kivilinna retval = -ENODEV; 419039ee17dSJussi Kivilinna goto halt_fail_and_release; 420039ee17dSJussi Kivilinna } 421039ee17dSJussi Kivilinna 4225b2fc499SJeff Garzik /* Get designated host ethernet address */ 4235b2fc499SJeff Garzik reply_len = ETH_ALEN; 4247390e8b0SLinus Walleij retval = rndis_query(dev, intf, u.buf, 4255432bdc0SJussi Kivilinna RNDIS_OID_802_3_PERMANENT_ADDRESS, 4265b2fc499SJeff Garzik 48, (void **) &bp, &reply_len); 4275b2fc499SJeff Garzik if (unlikely(retval< 0)) { 4285b2fc499SJeff Garzik dev_err(&intf->dev, "rndis get ethaddr, %d\n", retval); 4299ff55874SJussi Kivilinna goto halt_fail_and_release; 4305b2fc499SJeff Garzik } 4315b2fc499SJeff Garzik memcpy(net->dev_addr, bp, ETH_ALEN); 4325b2fc499SJeff Garzik 4335b2fc499SJeff Garzik /* set a nonzero filter to enable data transfers */ 4345b2fc499SJeff Garzik memset(u.set, 0, sizeof *u.set); 4357390e8b0SLinus Walleij u.set->msg_type = cpu_to_le32(RNDIS_MSG_SET); 43635c26c2cSHarvey Harrison u.set->msg_len = cpu_to_le32(4 + sizeof *u.set); 4378cdddc3fSLinus Walleij u.set->oid = cpu_to_le32(RNDIS_OID_GEN_CURRENT_PACKET_FILTER); 43835c26c2cSHarvey Harrison u.set->len = cpu_to_le32(4); 43935c26c2cSHarvey Harrison u.set->offset = cpu_to_le32((sizeof *u.set) - 8); 4407390e8b0SLinus Walleij *(__le32 *)(u.buf + sizeof *u.set) = cpu_to_le32(RNDIS_DEFAULT_FILTER); 4415b2fc499SJeff Garzik 442818727baSJussi Kivilinna retval = rndis_command(dev, u.header, CONTROL_BUFFER_SIZE); 4435b2fc499SJeff Garzik if (unlikely(retval < 0)) { 4445b2fc499SJeff Garzik dev_err(&intf->dev, "rndis set packet filter, %d\n", retval); 4459ff55874SJussi Kivilinna goto halt_fail_and_release; 4465b2fc499SJeff Garzik } 4475b2fc499SJeff Garzik 4485b2fc499SJeff Garzik retval = 0; 4495b2fc499SJeff Garzik 4505b2fc499SJeff Garzik kfree(u.buf); 4515b2fc499SJeff Garzik return retval; 4525b2fc499SJeff Garzik 4539ff55874SJussi Kivilinna halt_fail_and_release: 4549ff55874SJussi Kivilinna memset(u.halt, 0, sizeof *u.halt); 4557390e8b0SLinus Walleij u.halt->msg_type = cpu_to_le32(RNDIS_MSG_HALT); 45635c26c2cSHarvey Harrison u.halt->msg_len = cpu_to_le32(sizeof *u.halt); 457818727baSJussi Kivilinna (void) rndis_command(dev, (void *)u.halt, CONTROL_BUFFER_SIZE); 4585b2fc499SJeff Garzik fail_and_release: 4595b2fc499SJeff Garzik usb_set_intfdata(info->data, NULL); 4605b2fc499SJeff Garzik usb_driver_release_interface(driver_of(intf), info->data); 4615b2fc499SJeff Garzik info->data = NULL; 4625b2fc499SJeff Garzik fail: 4635b2fc499SJeff Garzik kfree(u.buf); 4645b2fc499SJeff Garzik return retval; 4655b2fc499SJeff Garzik } 4665665998cSJussi Kivilinna EXPORT_SYMBOL_GPL(generic_rndis_bind); 4675b2fc499SJeff Garzik 468039ee17dSJussi Kivilinna static int rndis_bind(struct usbnet *dev, struct usb_interface *intf) 469039ee17dSJussi Kivilinna { 470039ee17dSJussi Kivilinna return generic_rndis_bind(dev, intf, FLAG_RNDIS_PHYM_NOT_WIRELESS); 471039ee17dSJussi Kivilinna } 472039ee17dSJussi Kivilinna 4735665998cSJussi Kivilinna void rndis_unbind(struct usbnet *dev, struct usb_interface *intf) 4745b2fc499SJeff Garzik { 4755b2fc499SJeff Garzik struct rndis_halt *halt; 4765b2fc499SJeff Garzik 4775b2fc499SJeff Garzik /* try to clear any rndis state/activity (no i/o from stack!) */ 47804c3c01aSJussi Kivilinna halt = kzalloc(CONTROL_BUFFER_SIZE, GFP_KERNEL); 4795b2fc499SJeff Garzik if (halt) { 4807390e8b0SLinus Walleij halt->msg_type = cpu_to_le32(RNDIS_MSG_HALT); 48135c26c2cSHarvey Harrison halt->msg_len = cpu_to_le32(sizeof *halt); 482818727baSJussi Kivilinna (void) rndis_command(dev, (void *)halt, CONTROL_BUFFER_SIZE); 4835b2fc499SJeff Garzik kfree(halt); 4845b2fc499SJeff Garzik } 4855b2fc499SJeff Garzik 4862bfa2e1fSBjorge Dijkstra usbnet_cdc_unbind(dev, intf); 4875b2fc499SJeff Garzik } 4885665998cSJussi Kivilinna EXPORT_SYMBOL_GPL(rndis_unbind); 4895b2fc499SJeff Garzik 4905b2fc499SJeff Garzik /* 4915b2fc499SJeff Garzik * DATA -- host must not write zlps 4925b2fc499SJeff Garzik */ 4935665998cSJussi Kivilinna int rndis_rx_fixup(struct usbnet *dev, struct sk_buff *skb) 4945b2fc499SJeff Garzik { 495*eb85569fSEmil Goode /* This check is no longer done by usbnet */ 496*eb85569fSEmil Goode if (skb->len < dev->net->hard_header_len) 497*eb85569fSEmil Goode return 0; 498*eb85569fSEmil Goode 4995b2fc499SJeff Garzik /* peripheral may have batched packets to us... */ 5005b2fc499SJeff Garzik while (likely(skb->len)) { 5015b2fc499SJeff Garzik struct rndis_data_hdr *hdr = (void *)skb->data; 5025b2fc499SJeff Garzik struct sk_buff *skb2; 5033eef3668SJussi Kivilinna u32 msg_type, msg_len, data_offset, data_len; 5045b2fc499SJeff Garzik 5053eef3668SJussi Kivilinna msg_type = le32_to_cpu(hdr->msg_type); 5065b2fc499SJeff Garzik msg_len = le32_to_cpu(hdr->msg_len); 5075b2fc499SJeff Garzik data_offset = le32_to_cpu(hdr->data_offset); 5085b2fc499SJeff Garzik data_len = le32_to_cpu(hdr->data_len); 5095b2fc499SJeff Garzik 5105b2fc499SJeff Garzik /* don't choke if we see oob, per-packet data, etc */ 5113eef3668SJussi Kivilinna if (unlikely(msg_type != RNDIS_MSG_PACKET || skb->len < msg_len 5123eef3668SJussi Kivilinna || (data_offset + data_len + 8) > msg_len)) { 51358e2e7d5SHerbert Xu dev->net->stats.rx_frame_errors++; 51460b86755SJoe Perches netdev_dbg(dev->net, "bad rndis message %d/%d/%d/%d, len %d\n", 5155b2fc499SJeff Garzik le32_to_cpu(hdr->msg_type), 5165b2fc499SJeff Garzik msg_len, data_offset, data_len, skb->len); 5175b2fc499SJeff Garzik return 0; 5185b2fc499SJeff Garzik } 5195b2fc499SJeff Garzik skb_pull(skb, 8 + data_offset); 5205b2fc499SJeff Garzik 5215b2fc499SJeff Garzik /* at most one packet left? */ 5225b2fc499SJeff Garzik if (likely((data_len - skb->len) <= sizeof *hdr)) { 5235b2fc499SJeff Garzik skb_trim(skb, data_len); 5245b2fc499SJeff Garzik break; 5255b2fc499SJeff Garzik } 5265b2fc499SJeff Garzik 5275b2fc499SJeff Garzik /* try to return all the packets in the batch */ 5285b2fc499SJeff Garzik skb2 = skb_clone(skb, GFP_ATOMIC); 5295b2fc499SJeff Garzik if (unlikely(!skb2)) 5305b2fc499SJeff Garzik break; 5315b2fc499SJeff Garzik skb_pull(skb, msg_len - sizeof *hdr); 5325b2fc499SJeff Garzik skb_trim(skb2, data_len); 5335b2fc499SJeff Garzik usbnet_skb_return(dev, skb2); 5345b2fc499SJeff Garzik } 5355b2fc499SJeff Garzik 5365b2fc499SJeff Garzik /* caller will usbnet_skb_return the remaining packet */ 5375b2fc499SJeff Garzik return 1; 5385b2fc499SJeff Garzik } 5395665998cSJussi Kivilinna EXPORT_SYMBOL_GPL(rndis_rx_fixup); 5405b2fc499SJeff Garzik 5415665998cSJussi Kivilinna struct sk_buff * 5425b2fc499SJeff Garzik rndis_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags) 5435b2fc499SJeff Garzik { 5445b2fc499SJeff Garzik struct rndis_data_hdr *hdr; 5455b2fc499SJeff Garzik struct sk_buff *skb2; 5465b2fc499SJeff Garzik unsigned len = skb->len; 5475b2fc499SJeff Garzik 5485b2fc499SJeff Garzik if (likely(!skb_cloned(skb))) { 5495b2fc499SJeff Garzik int room = skb_headroom(skb); 5505b2fc499SJeff Garzik 5515b2fc499SJeff Garzik /* enough head room as-is? */ 5525b2fc499SJeff Garzik if (unlikely((sizeof *hdr) <= room)) 5535b2fc499SJeff Garzik goto fill; 5545b2fc499SJeff Garzik 5555b2fc499SJeff Garzik /* enough room, but needs to be readjusted? */ 5565b2fc499SJeff Garzik room += skb_tailroom(skb); 5575b2fc499SJeff Garzik if (likely((sizeof *hdr) <= room)) { 5585b2fc499SJeff Garzik skb->data = memmove(skb->head + sizeof *hdr, 5595b2fc499SJeff Garzik skb->data, len); 5605b2fc499SJeff Garzik skb_set_tail_pointer(skb, len); 5615b2fc499SJeff Garzik goto fill; 5625b2fc499SJeff Garzik } 5635b2fc499SJeff Garzik } 5645b2fc499SJeff Garzik 5655b2fc499SJeff Garzik /* create a new skb, with the correct size (and tailpad) */ 5665b2fc499SJeff Garzik skb2 = skb_copy_expand(skb, sizeof *hdr, 1, flags); 5675b2fc499SJeff Garzik dev_kfree_skb_any(skb); 5685b2fc499SJeff Garzik if (unlikely(!skb2)) 5695b2fc499SJeff Garzik return skb2; 5705b2fc499SJeff Garzik skb = skb2; 5715b2fc499SJeff Garzik 5725b2fc499SJeff Garzik /* fill out the RNDIS header. we won't bother trying to batch 5735b2fc499SJeff Garzik * packets; Linux minimizes wasted bandwidth through tx queues. 5745b2fc499SJeff Garzik */ 5755b2fc499SJeff Garzik fill: 5765b2fc499SJeff Garzik hdr = (void *) __skb_push(skb, sizeof *hdr); 5775b2fc499SJeff Garzik memset(hdr, 0, sizeof *hdr); 5787390e8b0SLinus Walleij hdr->msg_type = cpu_to_le32(RNDIS_MSG_PACKET); 5795b2fc499SJeff Garzik hdr->msg_len = cpu_to_le32(skb->len); 58035c26c2cSHarvey Harrison hdr->data_offset = cpu_to_le32(sizeof(*hdr) - 8); 5815b2fc499SJeff Garzik hdr->data_len = cpu_to_le32(len); 5825b2fc499SJeff Garzik 5835b2fc499SJeff Garzik /* FIXME make the last packet always be short ... */ 5845b2fc499SJeff Garzik return skb; 5855b2fc499SJeff Garzik } 5865665998cSJussi Kivilinna EXPORT_SYMBOL_GPL(rndis_tx_fixup); 5875b2fc499SJeff Garzik 5885b2fc499SJeff Garzik 5895b2fc499SJeff Garzik static const struct driver_info rndis_info = { 5905b2fc499SJeff Garzik .description = "RNDIS device", 591c261344dSArnd Bergmann .flags = FLAG_ETHER | FLAG_POINTTOPOINT | FLAG_FRAMING_RN | FLAG_NO_SETINT, 592039ee17dSJussi Kivilinna .bind = rndis_bind, 5935b2fc499SJeff Garzik .unbind = rndis_unbind, 5945b2fc499SJeff Garzik .status = rndis_status, 5955b2fc499SJeff Garzik .rx_fixup = rndis_rx_fixup, 5965b2fc499SJeff Garzik .tx_fixup = rndis_tx_fixup, 5975b2fc499SJeff Garzik }; 5985b2fc499SJeff Garzik 5994d42d417SBen Hutchings static const struct driver_info rndis_poll_status_info = { 6004d42d417SBen Hutchings .description = "RNDIS device (poll status before control)", 601eb8aa72dSBen Hutchings .flags = FLAG_ETHER | FLAG_POINTTOPOINT | FLAG_FRAMING_RN | FLAG_NO_SETINT, 6024d42d417SBen Hutchings .data = RNDIS_DRIVER_DATA_POLL_STATUS, 6034d42d417SBen Hutchings .bind = rndis_bind, 6044d42d417SBen Hutchings .unbind = rndis_unbind, 6054d42d417SBen Hutchings .status = rndis_status, 6064d42d417SBen Hutchings .rx_fixup = rndis_rx_fixup, 6074d42d417SBen Hutchings .tx_fixup = rndis_tx_fixup, 6084d42d417SBen Hutchings }; 6094d42d417SBen Hutchings 6105b2fc499SJeff Garzik /*-------------------------------------------------------------------------*/ 6115b2fc499SJeff Garzik 6125b2fc499SJeff Garzik static const struct usb_device_id products [] = { 6135b2fc499SJeff Garzik { 6144d42d417SBen Hutchings /* 2Wire HomePortal 1000SW */ 6154d42d417SBen Hutchings USB_DEVICE_AND_INTERFACE_INFO(0x1630, 0x0042, 6164d42d417SBen Hutchings USB_CLASS_COMM, 2 /* ACM */, 0x0ff), 6174d42d417SBen Hutchings .driver_info = (unsigned long) &rndis_poll_status_info, 6184d42d417SBen Hutchings }, { 6195b2fc499SJeff Garzik /* RNDIS is MSFT's un-official variant of CDC ACM */ 6205b2fc499SJeff Garzik USB_INTERFACE_INFO(USB_CLASS_COMM, 2 /* ACM */, 0x0ff), 6215b2fc499SJeff Garzik .driver_info = (unsigned long) &rndis_info, 6225b2fc499SJeff Garzik }, { 6235b2fc499SJeff Garzik /* "ActiveSync" is an undocumented variant of RNDIS, used in WM5 */ 6245b2fc499SJeff Garzik USB_INTERFACE_INFO(USB_CLASS_MISC, 1, 1), 6254d42d417SBen Hutchings .driver_info = (unsigned long) &rndis_poll_status_info, 6267e99eeddSThomas Backlund }, { 6277e99eeddSThomas Backlund /* RNDIS for tethering */ 6287e99eeddSThomas Backlund USB_INTERFACE_INFO(USB_CLASS_WIRELESS_CONTROLLER, 1, 3), 6297e99eeddSThomas Backlund .driver_info = (unsigned long) &rndis_info, 6305b2fc499SJeff Garzik }, 6315b2fc499SJeff Garzik { }, // END 6325b2fc499SJeff Garzik }; 6335b2fc499SJeff Garzik MODULE_DEVICE_TABLE(usb, products); 6345b2fc499SJeff Garzik 6355b2fc499SJeff Garzik static struct usb_driver rndis_driver = { 6365b2fc499SJeff Garzik .name = "rndis_host", 6375b2fc499SJeff Garzik .id_table = products, 6385b2fc499SJeff Garzik .probe = usbnet_probe, 6395b2fc499SJeff Garzik .disconnect = usbnet_disconnect, 6405b2fc499SJeff Garzik .suspend = usbnet_suspend, 6415b2fc499SJeff Garzik .resume = usbnet_resume, 642e1f12eb6SSarah Sharp .disable_hub_initiated_lpm = 1, 6435b2fc499SJeff Garzik }; 6445b2fc499SJeff Garzik 645d632eb1bSGreg Kroah-Hartman module_usb_driver(rndis_driver); 6465b2fc499SJeff Garzik 6475b2fc499SJeff Garzik MODULE_AUTHOR("David Brownell"); 6485b2fc499SJeff Garzik MODULE_DESCRIPTION("USB Host side RNDIS driver"); 6495b2fc499SJeff Garzik MODULE_LICENSE("GPL"); 650