blob: 72aee8516ca8511c7b02d307ac51dcf2425fa3f2 [file] [log] [blame]
David Brownell64e04912005-08-31 09:54:36 -07001/*
2 * Host Side support for RNDIS Networking Links
3 * Copyright (C) 2005 by David Brownell
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
Jeff Kirsher9cb00072013-12-06 06:28:46 -080016 * along with this program; if not, see <http://www.gnu.org/licenses/>.
David Brownell64e04912005-08-31 09:54:36 -070017 */
David Brownell64e04912005-08-31 09:54:36 -070018#include <linux/module.h>
David Brownell64e04912005-08-31 09:54:36 -070019#include <linux/init.h>
20#include <linux/netdevice.h>
21#include <linux/etherdevice.h>
22#include <linux/ethtool.h>
23#include <linux/workqueue.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090024#include <linux/slab.h>
David Brownell64e04912005-08-31 09:54:36 -070025#include <linux/mii.h>
26#include <linux/usb.h>
David Brownella8c28f22006-06-13 09:57:47 -070027#include <linux/usb/cdc.h>
Jussi Kivilinna3692e942008-01-26 00:51:45 +020028#include <linux/usb/usbnet.h>
29#include <linux/usb/rndis_host.h>
David Brownell64e04912005-08-31 09:54:36 -070030
31
32/*
33 * RNDIS is NDIS remoted over USB. It's a MSFT variant of CDC ACM ... of
34 * course ACM was intended for modems, not Ethernet links! USB's standard
35 * for Ethernet links is "CDC Ethernet", which is significantly simpler.
David Brownell51400f12006-04-02 10:19:08 -080036 *
37 * NOTE that Microsoft's "RNDIS 1.0" specification is incomplete. Issues
38 * include:
39 * - Power management in particular relies on information that's scattered
40 * through other documentation, and which is incomplete or incorrect even
41 * there.
42 * - There are various undocumented protocol requirements, such as the
43 * need to send unused garbage in control-OUT messages.
44 * - In some cases, MS-Windows will emit undocumented requests; this
45 * matters more to peripheral implementations than host ones.
46 *
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -080047 * Moreover there's a no-open-specs variant of RNDIS called "ActiveSync".
48 *
David Brownell51400f12006-04-02 10:19:08 -080049 * For these reasons and others, ** USE OF RNDIS IS STRONGLY DISCOURAGED ** in
50 * favor of such non-proprietary alternatives as CDC Ethernet or the newer (and
51 * currently rare) "Ethernet Emulation Model" (EEM).
David Brownell64e04912005-08-31 09:54:36 -070052 */
53
54/*
David Brownell64e04912005-08-31 09:54:36 -070055 * RNDIS notifications from device: command completion; "reverse"
56 * keepalives; etc
57 */
Jussi Kivilinna56659982008-01-26 00:51:17 +020058void rndis_status(struct usbnet *dev, struct urb *urb)
David Brownell64e04912005-08-31 09:54:36 -070059{
Joe Perches60b86752010-02-17 10:30:23 +000060 netdev_dbg(dev->net, "rndis status urb, len %d stat %d\n",
61 urb->actual_length, urb->status);
David Brownell64e04912005-08-31 09:54:36 -070062 // FIXME for keepalives, respond immediately (asynchronously)
63 // if not an RNDIS status, do like cdc_status(dev,urb) does
64}
Jussi Kivilinna56659982008-01-26 00:51:17 +020065EXPORT_SYMBOL_GPL(rndis_status);
David Brownell64e04912005-08-31 09:54:36 -070066
67/*
Jussi Kivilinna2a4901b2009-07-30 19:41:52 +030068 * RNDIS indicate messages.
69 */
70static void rndis_msg_indicate(struct usbnet *dev, struct rndis_indicate *msg,
71 int buflen)
72{
73 struct cdc_state *info = (void *)&dev->data;
74 struct device *udev = &info->control->dev;
75
76 if (dev->driver_info->indication) {
77 dev->driver_info->indication(dev, msg, buflen);
78 } else {
Jussi Kivilinna3eef3662012-05-11 22:17:34 +000079 u32 status = le32_to_cpu(msg->status);
80
81 switch (status) {
82 case RNDIS_STATUS_MEDIA_CONNECT:
Jussi Kivilinna2a4901b2009-07-30 19:41:52 +030083 dev_info(udev, "rndis media connect\n");
84 break;
Jussi Kivilinna3eef3662012-05-11 22:17:34 +000085 case RNDIS_STATUS_MEDIA_DISCONNECT:
Jussi Kivilinna2a4901b2009-07-30 19:41:52 +030086 dev_info(udev, "rndis media disconnect\n");
87 break;
88 default:
Jussi Kivilinna3eef3662012-05-11 22:17:34 +000089 dev_info(udev, "rndis indication: 0x%08x\n", status);
Jussi Kivilinna2a4901b2009-07-30 19:41:52 +030090 }
91 }
92}
93
94/*
David Brownell64e04912005-08-31 09:54:36 -070095 * RPC done RNDIS-style. Caller guarantees:
96 * - message is properly byteswapped
97 * - there's no other request pending
98 * - buf can hold up to 1KB response (required by RNDIS spec)
99 * On return, the first few entries are already byteswapped.
100 *
101 * Call context is likely probe(), before interface name is known,
102 * which is why we won't try to use it in the diagnostics.
103 */
Jussi Kivilinna818727b2008-06-18 15:40:12 +0300104int rndis_command(struct usbnet *dev, struct rndis_msg_hdr *buf, int buflen)
David Brownell64e04912005-08-31 09:54:36 -0700105{
106 struct cdc_state *info = (void *) &dev->data;
Ben Hutchings4d42d412011-04-13 14:48:55 -0700107 struct usb_cdc_notification notification;
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800108 int master_ifnum;
David Brownell64e04912005-08-31 09:54:36 -0700109 int retval;
Ben Hutchings4d42d412011-04-13 14:48:55 -0700110 int partial;
David Brownell64e04912005-08-31 09:54:36 -0700111 unsigned count;
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000112 u32 xid = 0, msg_len, request_id, msg_type, rsp,
113 status;
David Brownell64e04912005-08-31 09:54:36 -0700114
115 /* REVISIT when this gets called from contexts other than probe() or
116 * disconnect(): either serialize, or dispatch responses on xid
117 */
118
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000119 msg_type = le32_to_cpu(buf->msg_type);
120
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800121 /* Issue the request; xid is unique, don't bother byteswapping it */
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000122 if (likely(msg_type != RNDIS_MSG_HALT && msg_type != RNDIS_MSG_RESET)) {
David Brownell64e04912005-08-31 09:54:36 -0700123 xid = dev->xid++;
124 if (!xid)
125 xid = dev->xid++;
126 buf->request_id = (__force __le32) xid;
127 }
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800128 master_ifnum = info->control->cur_altsetting->desc.bInterfaceNumber;
David Brownell64e04912005-08-31 09:54:36 -0700129 retval = usb_control_msg(dev->udev,
130 usb_sndctrlpipe(dev->udev, 0),
131 USB_CDC_SEND_ENCAPSULATED_COMMAND,
132 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800133 0, master_ifnum,
David Brownell64e04912005-08-31 09:54:36 -0700134 buf, le32_to_cpu(buf->msg_len),
135 RNDIS_CONTROL_TIMEOUT_MS);
136 if (unlikely(retval < 0 || xid == 0))
137 return retval;
138
Ben Hutchings4d42d412011-04-13 14:48:55 -0700139 /* Some devices don't respond on the control channel until
140 * polled on the status channel, so do that first. */
141 if (dev->driver_info->data & RNDIS_DRIVER_DATA_POLL_STATUS) {
142 retval = usb_interrupt_msg(
143 dev->udev,
144 usb_rcvintpipe(dev->udev,
145 dev->status->desc.bEndpointAddress),
146 &notification, sizeof(notification), &partial,
147 RNDIS_CONTROL_TIMEOUT_MS);
148 if (unlikely(retval < 0))
149 return retval;
150 }
David Brownell64e04912005-08-31 09:54:36 -0700151
Ben Hutchings4d42d412011-04-13 14:48:55 -0700152 /* Poll the control channel; the request probably completed immediately */
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000153 rsp = le32_to_cpu(buf->msg_type) | RNDIS_MSG_COMPLETION;
David Brownell64e04912005-08-31 09:54:36 -0700154 for (count = 0; count < 10; count++) {
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800155 memset(buf, 0, CONTROL_BUFFER_SIZE);
David Brownell64e04912005-08-31 09:54:36 -0700156 retval = usb_control_msg(dev->udev,
157 usb_rcvctrlpipe(dev->udev, 0),
158 USB_CDC_GET_ENCAPSULATED_RESPONSE,
159 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800160 0, master_ifnum,
Jussi Kivilinna818727b2008-06-18 15:40:12 +0300161 buf, buflen,
David Brownell64e04912005-08-31 09:54:36 -0700162 RNDIS_CONTROL_TIMEOUT_MS);
163 if (likely(retval >= 8)) {
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000164 msg_type = le32_to_cpu(buf->msg_type);
David Brownell64e04912005-08-31 09:54:36 -0700165 msg_len = le32_to_cpu(buf->msg_len);
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000166 status = le32_to_cpu(buf->status);
David Brownell64e04912005-08-31 09:54:36 -0700167 request_id = (__force u32) buf->request_id;
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000168 if (likely(msg_type == rsp)) {
David Brownell64e04912005-08-31 09:54:36 -0700169 if (likely(request_id == xid)) {
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000170 if (unlikely(rsp == RNDIS_MSG_RESET_C))
David Brownell64e04912005-08-31 09:54:36 -0700171 return 0;
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000172 if (likely(RNDIS_STATUS_SUCCESS ==
173 status))
David Brownell64e04912005-08-31 09:54:36 -0700174 return 0;
175 dev_dbg(&info->control->dev,
176 "rndis reply status %08x\n",
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000177 status);
David Brownell64e04912005-08-31 09:54:36 -0700178 return -EL3RST;
179 }
180 dev_dbg(&info->control->dev,
181 "rndis reply id %d expected %d\n",
182 request_id, xid);
183 /* then likely retry */
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000184 } else switch (msg_type) {
185 case RNDIS_MSG_INDICATE: /* fault/event */
Jussi Kivilinna2a4901b2009-07-30 19:41:52 +0300186 rndis_msg_indicate(dev, (void *)buf, buflen);
David Brownell64e04912005-08-31 09:54:36 -0700187 break;
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000188 case RNDIS_MSG_KEEPALIVE: { /* ping */
David Brownell64e04912005-08-31 09:54:36 -0700189 struct rndis_keepalive_c *msg = (void *)buf;
190
Linus Walleij7390e8b2012-05-11 22:15:39 +0000191 msg->msg_type = cpu_to_le32(RNDIS_MSG_KEEPALIVE_C);
Harvey Harrison35c26c22009-02-14 22:56:56 -0800192 msg->msg_len = cpu_to_le32(sizeof *msg);
Linus Walleij7390e8b2012-05-11 22:15:39 +0000193 msg->status = cpu_to_le32(RNDIS_STATUS_SUCCESS);
David Brownell64e04912005-08-31 09:54:36 -0700194 retval = usb_control_msg(dev->udev,
195 usb_sndctrlpipe(dev->udev, 0),
196 USB_CDC_SEND_ENCAPSULATED_COMMAND,
197 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800198 0, master_ifnum,
David Brownell64e04912005-08-31 09:54:36 -0700199 msg, sizeof *msg,
200 RNDIS_CONTROL_TIMEOUT_MS);
201 if (unlikely(retval < 0))
202 dev_dbg(&info->control->dev,
203 "rndis keepalive err %d\n",
204 retval);
205 }
206 break;
207 default:
208 dev_dbg(&info->control->dev,
209 "unexpected rndis msg %08x len %d\n",
210 le32_to_cpu(buf->msg_type), msg_len);
211 }
212 } else {
213 /* device probably issued a protocol stall; ignore */
214 dev_dbg(&info->control->dev,
215 "rndis response error, code %d\n", retval);
216 }
Pierre Ynard74ef5c52008-05-14 16:20:16 -0700217 msleep(20);
David Brownell64e04912005-08-31 09:54:36 -0700218 }
219 dev_dbg(&info->control->dev, "rndis response timeout\n");
220 return -ETIMEDOUT;
221}
Jussi Kivilinna56659982008-01-26 00:51:17 +0200222EXPORT_SYMBOL_GPL(rndis_command);
David Brownell64e04912005-08-31 09:54:36 -0700223
David Brownellddda0862007-04-17 17:53:20 -0700224/*
225 * rndis_query:
226 *
227 * Performs a query for @oid along with 0 or more bytes of payload as
228 * specified by @in_len. If @reply_len is not set to -1 then the reply
229 * length is checked against this value, resulting in an error if it
230 * doesn't match.
231 *
232 * NOTE: Adding a payload exactly or greater than the size of the expected
233 * response payload is an evident requirement MSFT added for ActiveSync.
234 *
235 * The only exception is for OIDs that return a variably sized response,
236 * in which case no payload should be added. This undocumented (and
237 * nonsensical!) issue was found by sniffing protocol requests from the
238 * ActiveSync 4.1 Windows driver.
239 */
240static int rndis_query(struct usbnet *dev, struct usb_interface *intf,
Jussi Kivilinna5432bdc2012-05-11 22:17:50 +0000241 void *buf, u32 oid, u32 in_len,
David Brownellddda0862007-04-17 17:53:20 -0700242 void **reply, int *reply_len)
243{
244 int retval;
245 union {
246 void *buf;
247 struct rndis_msg_hdr *header;
248 struct rndis_query *get;
249 struct rndis_query_c *get_c;
250 } u;
251 u32 off, len;
252
253 u.buf = buf;
254
255 memset(u.get, 0, sizeof *u.get + in_len);
Linus Walleij7390e8b2012-05-11 22:15:39 +0000256 u.get->msg_type = cpu_to_le32(RNDIS_MSG_QUERY);
David Brownellddda0862007-04-17 17:53:20 -0700257 u.get->msg_len = cpu_to_le32(sizeof *u.get + in_len);
Jussi Kivilinna5432bdc2012-05-11 22:17:50 +0000258 u.get->oid = cpu_to_le32(oid);
David Brownellddda0862007-04-17 17:53:20 -0700259 u.get->len = cpu_to_le32(in_len);
Harvey Harrison35c26c22009-02-14 22:56:56 -0800260 u.get->offset = cpu_to_le32(20);
David Brownellddda0862007-04-17 17:53:20 -0700261
Jussi Kivilinna818727b2008-06-18 15:40:12 +0300262 retval = rndis_command(dev, u.header, CONTROL_BUFFER_SIZE);
David Brownellddda0862007-04-17 17:53:20 -0700263 if (unlikely(retval < 0)) {
264 dev_err(&intf->dev, "RNDIS_MSG_QUERY(0x%08x) failed, %d\n",
265 oid, retval);
266 return retval;
267 }
268
269 off = le32_to_cpu(u.get_c->offset);
270 len = le32_to_cpu(u.get_c->len);
271 if (unlikely((8 + off + len) > CONTROL_BUFFER_SIZE))
272 goto response_error;
273
274 if (*reply_len != -1 && len != *reply_len)
275 goto response_error;
276
277 *reply = (unsigned char *) &u.get_c->request_id + off;
278 *reply_len = len;
279
280 return retval;
281
282response_error:
283 dev_err(&intf->dev, "RNDIS_MSG_QUERY(0x%08x) "
284 "invalid response - off %d len %d\n",
285 oid, off, len);
286 return -EDOM;
287}
288
Stephen Hemminger0f2166d2009-03-20 19:36:00 +0000289/* same as usbnet_netdev_ops but MTU change not allowed */
290static const struct net_device_ops rndis_netdev_ops = {
291 .ndo_open = usbnet_open,
292 .ndo_stop = usbnet_stop,
293 .ndo_start_xmit = usbnet_start_xmit,
294 .ndo_tx_timeout = usbnet_tx_timeout,
295 .ndo_set_mac_address = eth_mac_addr,
296 .ndo_validate_addr = eth_validate_addr,
297};
298
Jussi Kivilinna039ee172008-01-27 23:34:33 +0200299int
300generic_rndis_bind(struct usbnet *dev, struct usb_interface *intf, int flags)
David Brownell64e04912005-08-31 09:54:36 -0700301{
302 int retval;
303 struct net_device *net = dev->net;
Daniel Gollubdeb31f12007-01-16 11:03:01 +0100304 struct cdc_state *info = (void *) &dev->data;
David Brownell64e04912005-08-31 09:54:36 -0700305 union {
306 void *buf;
307 struct rndis_msg_hdr *header;
308 struct rndis_init *init;
309 struct rndis_init_c *init_c;
310 struct rndis_query *get;
311 struct rndis_query_c *get_c;
312 struct rndis_set *set;
313 struct rndis_set_c *set_c;
Jussi Kivilinna9ff55872008-01-26 00:50:55 +0200314 struct rndis_halt *halt;
David Brownell64e04912005-08-31 09:54:36 -0700315 } u;
Al Virod63ddce2008-05-21 01:34:30 +0100316 u32 tmp;
317 __le32 phym_unspec, *phym;
David Brownellddda0862007-04-17 17:53:20 -0700318 int reply_len;
319 unsigned char *bp;
David Brownell64e04912005-08-31 09:54:36 -0700320
321 /* we can't rely on i/o from stack working, or stack allocation */
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800322 u.buf = kmalloc(CONTROL_BUFFER_SIZE, GFP_KERNEL);
David Brownell64e04912005-08-31 09:54:36 -0700323 if (!u.buf)
324 return -ENOMEM;
325 retval = usbnet_generic_cdc_bind(dev, intf);
326 if (retval < 0)
Daniel Gollubdeb31f12007-01-16 11:03:01 +0100327 goto fail;
David Brownell64e04912005-08-31 09:54:36 -0700328
Linus Walleij7390e8b2012-05-11 22:15:39 +0000329 u.init->msg_type = cpu_to_le32(RNDIS_MSG_INIT);
Harvey Harrison35c26c22009-02-14 22:56:56 -0800330 u.init->msg_len = cpu_to_le32(sizeof *u.init);
331 u.init->major_version = cpu_to_le32(1);
332 u.init->minor_version = cpu_to_le32(0);
David Brownell64e04912005-08-31 09:54:36 -0700333
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800334 /* max transfer (in spec) is 0x4000 at full speed, but for
335 * TX we'll stick to one Ethernet packet plus RNDIS framing.
336 * For RX we handle drivers that zero-pad to end-of-packet.
337 * Don't let userspace change these settings.
David Brownellddda0862007-04-17 17:53:20 -0700338 *
339 * NOTE: there still seems to be wierdness here, as if we need
340 * to do some more things to make sure WinCE targets accept this.
341 * They default to jumbograms of 8KB or 16KB, which is absurd
342 * for such low data rates and which is also more than Linux
343 * can usually expect to allocate for SKB data...
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800344 */
345 net->hard_header_len += sizeof (struct rndis_data_hdr);
346 dev->hard_mtu = net->mtu + net->hard_header_len;
347
Jean-Christophe Dubois10d0f272008-03-13 14:56:36 -0800348 dev->maxpacket = usb_maxpacket(dev->udev, dev->out, 1);
349 if (dev->maxpacket == 0) {
Joe Perchesa475f602010-02-17 10:30:24 +0000350 netif_dbg(dev, probe, dev->net,
351 "dev->maxpacket can't be 0\n");
Jean-Christophe Dubois10d0f272008-03-13 14:56:36 -0800352 retval = -EINVAL;
353 goto fail_and_release;
354 }
355
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800356 dev->rx_urb_size = dev->hard_mtu + (dev->maxpacket + 1);
357 dev->rx_urb_size &= ~(dev->maxpacket - 1);
358 u.init->max_transfer_size = cpu_to_le32(dev->rx_urb_size);
359
Stephen Hemminger0f2166d2009-03-20 19:36:00 +0000360 net->netdev_ops = &rndis_netdev_ops;
361
Jussi Kivilinna818727b2008-06-18 15:40:12 +0300362 retval = rndis_command(dev, u.header, CONTROL_BUFFER_SIZE);
David Brownell64e04912005-08-31 09:54:36 -0700363 if (unlikely(retval < 0)) {
364 /* it might not even be an RNDIS device!! */
365 dev_err(&intf->dev, "RNDIS init failed, %d\n", retval);
David Brownellddda0862007-04-17 17:53:20 -0700366 goto fail_and_release;
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800367 }
368 tmp = le32_to_cpu(u.init_c->max_transfer_size);
369 if (tmp < dev->hard_mtu) {
Thomas Sailer500d2c22007-10-24 00:47:19 +0200370 if (tmp <= net->hard_header_len) {
371 dev_err(&intf->dev,
372 "dev can't take %u byte packets (max %u)\n",
373 dev->hard_mtu, tmp);
374 retval = -EINVAL;
Jussi Kivilinna9ff55872008-01-26 00:50:55 +0200375 goto halt_fail_and_release;
Thomas Sailer500d2c22007-10-24 00:47:19 +0200376 }
Thomas Sailer500d2c22007-10-24 00:47:19 +0200377 dev_warn(&intf->dev,
378 "dev can't take %u byte packets (max %u), "
379 "adjusting MTU to %u\n",
George Nassar40ac7b62009-10-14 18:27:41 -0500380 dev->hard_mtu, tmp, tmp - net->hard_header_len);
381 dev->hard_mtu = tmp;
382 net->mtu = dev->hard_mtu - net->hard_header_len;
David Brownell64e04912005-08-31 09:54:36 -0700383 }
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800384
David Brownell64e04912005-08-31 09:54:36 -0700385 /* REVISIT: peripheral "alignment" request is ignored ... */
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800386 dev_dbg(&intf->dev,
387 "hard mtu %u (%u from dev), rx buflen %Zu, align %d\n",
388 dev->hard_mtu, tmp, dev->rx_urb_size,
David Brownell64e04912005-08-31 09:54:36 -0700389 1 << le32_to_cpu(u.init_c->packet_alignment));
390
Jussi Kivilinna7c39e032008-01-26 00:51:28 +0200391 /* module has some device initialization code needs to be done right
392 * after RNDIS_INIT */
393 if (dev->driver_info->early_init &&
394 dev->driver_info->early_init(dev) != 0)
395 goto halt_fail_and_release;
396
Jussi Kivilinna039ee172008-01-27 23:34:33 +0200397 /* Check physical medium */
Jussi Kivilinna9f5e60d2008-03-23 12:45:44 +0200398 phym = NULL;
Jussi Kivilinna039ee172008-01-27 23:34:33 +0200399 reply_len = sizeof *phym;
Linus Walleij7390e8b2012-05-11 22:15:39 +0000400 retval = rndis_query(dev, intf, u.buf,
Jussi Kivilinna5432bdc2012-05-11 22:17:50 +0000401 RNDIS_OID_GEN_PHYSICAL_MEDIUM,
402 0, (void **) &phym, &reply_len);
Jussi Kivilinna9f5e60d2008-03-23 12:45:44 +0200403 if (retval != 0 || !phym) {
Jussi Kivilinna039ee172008-01-27 23:34:33 +0200404 /* OID is optional so don't fail here. */
Linus Walleij7390e8b2012-05-11 22:15:39 +0000405 phym_unspec = cpu_to_le32(RNDIS_PHYSICAL_MEDIUM_UNSPECIFIED);
Jussi Kivilinna9f5e60d2008-03-23 12:45:44 +0200406 phym = &phym_unspec;
407 }
Jussi Kivilinna039ee172008-01-27 23:34:33 +0200408 if ((flags & FLAG_RNDIS_PHYM_WIRELESS) &&
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000409 le32_to_cpup(phym) != RNDIS_PHYSICAL_MEDIUM_WIRELESS_LAN) {
Joe Perchesa475f602010-02-17 10:30:24 +0000410 netif_dbg(dev, probe, dev->net,
411 "driver requires wireless physical medium, but device is not\n");
Jussi Kivilinna039ee172008-01-27 23:34:33 +0200412 retval = -ENODEV;
413 goto halt_fail_and_release;
414 }
415 if ((flags & FLAG_RNDIS_PHYM_NOT_WIRELESS) &&
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000416 le32_to_cpup(phym) == RNDIS_PHYSICAL_MEDIUM_WIRELESS_LAN) {
Joe Perchesa475f602010-02-17 10:30:24 +0000417 netif_dbg(dev, probe, dev->net,
418 "driver requires non-wireless physical medium, but device is wireless.\n");
Jussi Kivilinna039ee172008-01-27 23:34:33 +0200419 retval = -ENODEV;
420 goto halt_fail_and_release;
421 }
422
David Brownellddda0862007-04-17 17:53:20 -0700423 /* Get designated host ethernet address */
424 reply_len = ETH_ALEN;
Linus Walleij7390e8b2012-05-11 22:15:39 +0000425 retval = rndis_query(dev, intf, u.buf,
Jussi Kivilinna5432bdc2012-05-11 22:17:50 +0000426 RNDIS_OID_802_3_PERMANENT_ADDRESS,
427 48, (void **) &bp, &reply_len);
David Brownellddda0862007-04-17 17:53:20 -0700428 if (unlikely(retval< 0)) {
David Brownell64e04912005-08-31 09:54:36 -0700429 dev_err(&intf->dev, "rndis get ethaddr, %d\n", retval);
Jussi Kivilinna9ff55872008-01-26 00:50:55 +0200430 goto halt_fail_and_release;
David Brownell64e04912005-08-31 09:54:36 -0700431 }
David Brownellddda0862007-04-17 17:53:20 -0700432 memcpy(net->dev_addr, bp, ETH_ALEN);
David Brownell64e04912005-08-31 09:54:36 -0700433
434 /* set a nonzero filter to enable data transfers */
435 memset(u.set, 0, sizeof *u.set);
Linus Walleij7390e8b2012-05-11 22:15:39 +0000436 u.set->msg_type = cpu_to_le32(RNDIS_MSG_SET);
Harvey Harrison35c26c22009-02-14 22:56:56 -0800437 u.set->msg_len = cpu_to_le32(4 + sizeof *u.set);
Linus Walleij8cdddc32012-05-11 22:16:08 +0000438 u.set->oid = cpu_to_le32(RNDIS_OID_GEN_CURRENT_PACKET_FILTER);
Harvey Harrison35c26c22009-02-14 22:56:56 -0800439 u.set->len = cpu_to_le32(4);
440 u.set->offset = cpu_to_le32((sizeof *u.set) - 8);
Linus Walleij7390e8b2012-05-11 22:15:39 +0000441 *(__le32 *)(u.buf + sizeof *u.set) = cpu_to_le32(RNDIS_DEFAULT_FILTER);
David Brownell64e04912005-08-31 09:54:36 -0700442
Jussi Kivilinna818727b2008-06-18 15:40:12 +0300443 retval = rndis_command(dev, u.header, CONTROL_BUFFER_SIZE);
David Brownell64e04912005-08-31 09:54:36 -0700444 if (unlikely(retval < 0)) {
445 dev_err(&intf->dev, "rndis set packet filter, %d\n", retval);
Jussi Kivilinna9ff55872008-01-26 00:50:55 +0200446 goto halt_fail_and_release;
David Brownell64e04912005-08-31 09:54:36 -0700447 }
448
449 retval = 0;
Daniel Gollubdeb31f12007-01-16 11:03:01 +0100450
451 kfree(u.buf);
452 return retval;
453
Jussi Kivilinna9ff55872008-01-26 00:50:55 +0200454halt_fail_and_release:
455 memset(u.halt, 0, sizeof *u.halt);
Linus Walleij7390e8b2012-05-11 22:15:39 +0000456 u.halt->msg_type = cpu_to_le32(RNDIS_MSG_HALT);
Harvey Harrison35c26c22009-02-14 22:56:56 -0800457 u.halt->msg_len = cpu_to_le32(sizeof *u.halt);
Jussi Kivilinna818727b2008-06-18 15:40:12 +0300458 (void) rndis_command(dev, (void *)u.halt, CONTROL_BUFFER_SIZE);
Daniel Gollubdeb31f12007-01-16 11:03:01 +0100459fail_and_release:
460 usb_set_intfdata(info->data, NULL);
461 usb_driver_release_interface(driver_of(intf), info->data);
David Brownellddda0862007-04-17 17:53:20 -0700462 info->data = NULL;
Daniel Gollubdeb31f12007-01-16 11:03:01 +0100463fail:
David Brownell64e04912005-08-31 09:54:36 -0700464 kfree(u.buf);
465 return retval;
466}
Jussi Kivilinna56659982008-01-26 00:51:17 +0200467EXPORT_SYMBOL_GPL(generic_rndis_bind);
David Brownell64e04912005-08-31 09:54:36 -0700468
Jussi Kivilinna039ee172008-01-27 23:34:33 +0200469static int rndis_bind(struct usbnet *dev, struct usb_interface *intf)
470{
471 return generic_rndis_bind(dev, intf, FLAG_RNDIS_PHYM_NOT_WIRELESS);
472}
473
Jussi Kivilinna56659982008-01-26 00:51:17 +0200474void rndis_unbind(struct usbnet *dev, struct usb_interface *intf)
David Brownell64e04912005-08-31 09:54:36 -0700475{
476 struct rndis_halt *halt;
477
478 /* try to clear any rndis state/activity (no i/o from stack!) */
Jussi Kivilinna04c3c012008-01-26 00:50:49 +0200479 halt = kzalloc(CONTROL_BUFFER_SIZE, GFP_KERNEL);
David Brownell64e04912005-08-31 09:54:36 -0700480 if (halt) {
Linus Walleij7390e8b2012-05-11 22:15:39 +0000481 halt->msg_type = cpu_to_le32(RNDIS_MSG_HALT);
Harvey Harrison35c26c22009-02-14 22:56:56 -0800482 halt->msg_len = cpu_to_le32(sizeof *halt);
Jussi Kivilinna818727b2008-06-18 15:40:12 +0300483 (void) rndis_command(dev, (void *)halt, CONTROL_BUFFER_SIZE);
David Brownell64e04912005-08-31 09:54:36 -0700484 kfree(halt);
485 }
486
Bjorge Dijkstra2bfa2e12008-01-26 00:50:38 +0200487 usbnet_cdc_unbind(dev, intf);
David Brownell64e04912005-08-31 09:54:36 -0700488}
Jussi Kivilinna56659982008-01-26 00:51:17 +0200489EXPORT_SYMBOL_GPL(rndis_unbind);
David Brownell64e04912005-08-31 09:54:36 -0700490
491/*
492 * DATA -- host must not write zlps
493 */
Jussi Kivilinna56659982008-01-26 00:51:17 +0200494int rndis_rx_fixup(struct usbnet *dev, struct sk_buff *skb)
David Brownell64e04912005-08-31 09:54:36 -0700495{
496 /* peripheral may have batched packets to us... */
497 while (likely(skb->len)) {
498 struct rndis_data_hdr *hdr = (void *)skb->data;
499 struct sk_buff *skb2;
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000500 u32 msg_type, msg_len, data_offset, data_len;
David Brownell64e04912005-08-31 09:54:36 -0700501
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000502 msg_type = le32_to_cpu(hdr->msg_type);
David Brownell64e04912005-08-31 09:54:36 -0700503 msg_len = le32_to_cpu(hdr->msg_len);
504 data_offset = le32_to_cpu(hdr->data_offset);
505 data_len = le32_to_cpu(hdr->data_len);
506
507 /* don't choke if we see oob, per-packet data, etc */
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000508 if (unlikely(msg_type != RNDIS_MSG_PACKET || skb->len < msg_len
509 || (data_offset + data_len + 8) > msg_len)) {
Herbert Xu58e2e7d2009-06-29 16:52:26 +0000510 dev->net->stats.rx_frame_errors++;
Joe Perches60b86752010-02-17 10:30:23 +0000511 netdev_dbg(dev->net, "bad rndis message %d/%d/%d/%d, len %d\n",
512 le32_to_cpu(hdr->msg_type),
513 msg_len, data_offset, data_len, skb->len);
David Brownell64e04912005-08-31 09:54:36 -0700514 return 0;
515 }
516 skb_pull(skb, 8 + data_offset);
517
518 /* at most one packet left? */
519 if (likely((data_len - skb->len) <= sizeof *hdr)) {
520 skb_trim(skb, data_len);
521 break;
522 }
523
524 /* try to return all the packets in the batch */
525 skb2 = skb_clone(skb, GFP_ATOMIC);
526 if (unlikely(!skb2))
527 break;
528 skb_pull(skb, msg_len - sizeof *hdr);
529 skb_trim(skb2, data_len);
530 usbnet_skb_return(dev, skb2);
531 }
532
533 /* caller will usbnet_skb_return the remaining packet */
534 return 1;
535}
Jussi Kivilinna56659982008-01-26 00:51:17 +0200536EXPORT_SYMBOL_GPL(rndis_rx_fixup);
David Brownell64e04912005-08-31 09:54:36 -0700537
Jussi Kivilinna56659982008-01-26 00:51:17 +0200538struct sk_buff *
Al Viro55016f12005-10-21 03:21:58 -0400539rndis_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
David Brownell64e04912005-08-31 09:54:36 -0700540{
541 struct rndis_data_hdr *hdr;
542 struct sk_buff *skb2;
543 unsigned len = skb->len;
544
545 if (likely(!skb_cloned(skb))) {
546 int room = skb_headroom(skb);
547
548 /* enough head room as-is? */
549 if (unlikely((sizeof *hdr) <= room))
550 goto fill;
551
552 /* enough room, but needs to be readjusted? */
553 room += skb_tailroom(skb);
554 if (likely((sizeof *hdr) <= room)) {
555 skb->data = memmove(skb->head + sizeof *hdr,
556 skb->data, len);
Arnaldo Carvalho de Melo27a884d2007-04-19 20:29:13 -0700557 skb_set_tail_pointer(skb, len);
David Brownell64e04912005-08-31 09:54:36 -0700558 goto fill;
559 }
560 }
561
562 /* create a new skb, with the correct size (and tailpad) */
563 skb2 = skb_copy_expand(skb, sizeof *hdr, 1, flags);
564 dev_kfree_skb_any(skb);
565 if (unlikely(!skb2))
566 return skb2;
567 skb = skb2;
568
569 /* fill out the RNDIS header. we won't bother trying to batch
570 * packets; Linux minimizes wasted bandwidth through tx queues.
571 */
572fill:
573 hdr = (void *) __skb_push(skb, sizeof *hdr);
574 memset(hdr, 0, sizeof *hdr);
Linus Walleij7390e8b2012-05-11 22:15:39 +0000575 hdr->msg_type = cpu_to_le32(RNDIS_MSG_PACKET);
David Brownell64e04912005-08-31 09:54:36 -0700576 hdr->msg_len = cpu_to_le32(skb->len);
Harvey Harrison35c26c22009-02-14 22:56:56 -0800577 hdr->data_offset = cpu_to_le32(sizeof(*hdr) - 8);
David Brownell64e04912005-08-31 09:54:36 -0700578 hdr->data_len = cpu_to_le32(len);
579
580 /* FIXME make the last packet always be short ... */
581 return skb;
582}
Jussi Kivilinna56659982008-01-26 00:51:17 +0200583EXPORT_SYMBOL_GPL(rndis_tx_fixup);
David Brownell64e04912005-08-31 09:54:36 -0700584
585
586static const struct driver_info rndis_info = {
587 .description = "RNDIS device",
Arnd Bergmannc2613442011-04-01 20:12:02 -0700588 .flags = FLAG_ETHER | FLAG_POINTTOPOINT | FLAG_FRAMING_RN | FLAG_NO_SETINT,
Jussi Kivilinna039ee172008-01-27 23:34:33 +0200589 .bind = rndis_bind,
David Brownell64e04912005-08-31 09:54:36 -0700590 .unbind = rndis_unbind,
591 .status = rndis_status,
592 .rx_fixup = rndis_rx_fixup,
593 .tx_fixup = rndis_tx_fixup,
594};
595
Ben Hutchings4d42d412011-04-13 14:48:55 -0700596static const struct driver_info rndis_poll_status_info = {
597 .description = "RNDIS device (poll status before control)",
Ben Hutchingseb8aa722011-04-14 23:23:45 -0700598 .flags = FLAG_ETHER | FLAG_POINTTOPOINT | FLAG_FRAMING_RN | FLAG_NO_SETINT,
Ben Hutchings4d42d412011-04-13 14:48:55 -0700599 .data = RNDIS_DRIVER_DATA_POLL_STATUS,
600 .bind = rndis_bind,
601 .unbind = rndis_unbind,
602 .status = rndis_status,
603 .rx_fixup = rndis_rx_fixup,
604 .tx_fixup = rndis_tx_fixup,
605};
606
David Brownell64e04912005-08-31 09:54:36 -0700607/*-------------------------------------------------------------------------*/
608
609static const struct usb_device_id products [] = {
610{
Ben Hutchings4d42d412011-04-13 14:48:55 -0700611 /* 2Wire HomePortal 1000SW */
612 USB_DEVICE_AND_INTERFACE_INFO(0x1630, 0x0042,
613 USB_CLASS_COMM, 2 /* ACM */, 0x0ff),
614 .driver_info = (unsigned long) &rndis_poll_status_info,
615}, {
David Brownell64e04912005-08-31 09:54:36 -0700616 /* RNDIS is MSFT's un-official variant of CDC ACM */
617 USB_INTERFACE_INFO(USB_CLASS_COMM, 2 /* ACM */, 0x0ff),
618 .driver_info = (unsigned long) &rndis_info,
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800619}, {
620 /* "ActiveSync" is an undocumented variant of RNDIS, used in WM5 */
621 USB_INTERFACE_INFO(USB_CLASS_MISC, 1, 1),
Ben Hutchings4d42d412011-04-13 14:48:55 -0700622 .driver_info = (unsigned long) &rndis_poll_status_info,
Thomas Backlund7e99eed2008-07-22 13:55:58 -0700623}, {
624 /* RNDIS for tethering */
625 USB_INTERFACE_INFO(USB_CLASS_WIRELESS_CONTROLLER, 1, 3),
626 .driver_info = (unsigned long) &rndis_info,
David Brownell64e04912005-08-31 09:54:36 -0700627},
628 { }, // END
629};
630MODULE_DEVICE_TABLE(usb, products);
631
632static struct usb_driver rndis_driver = {
David Brownell64e04912005-08-31 09:54:36 -0700633 .name = "rndis_host",
634 .id_table = products,
635 .probe = usbnet_probe,
636 .disconnect = usbnet_disconnect,
637 .suspend = usbnet_suspend,
638 .resume = usbnet_resume,
Sarah Sharpe1f12eb2012-04-23 10:08:51 -0700639 .disable_hub_initiated_lpm = 1,
David Brownell64e04912005-08-31 09:54:36 -0700640};
641
Greg Kroah-Hartmand632eb12011-11-18 09:44:20 -0800642module_usb_driver(rndis_driver);
David Brownell64e04912005-08-31 09:54:36 -0700643
644MODULE_AUTHOR("David Brownell");
645MODULE_DESCRIPTION("USB Host side RNDIS driver");
646MODULE_LICENSE("GPL");