blob: bd9c07888ebb43e6b0fff37a8578ec8cf1cde0dc [file] [log] [blame]
Thomas Gleixner1ccea772019-05-19 15:51:43 +02001// SPDX-License-Identifier: GPL-2.0-or-later
David Brownell64e04912005-08-31 09:54:36 -07002/*
3 * Host Side support for RNDIS Networking Links
4 * Copyright (C) 2005 by David Brownell
David Brownell64e04912005-08-31 09:54:36 -07005 */
David Brownell64e04912005-08-31 09:54:36 -07006#include <linux/module.h>
David Brownell64e04912005-08-31 09:54:36 -07007#include <linux/netdevice.h>
8#include <linux/etherdevice.h>
9#include <linux/ethtool.h>
10#include <linux/workqueue.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090011#include <linux/slab.h>
David Brownell64e04912005-08-31 09:54:36 -070012#include <linux/mii.h>
13#include <linux/usb.h>
David Brownella8c28f22006-06-13 09:57:47 -070014#include <linux/usb/cdc.h>
Jussi Kivilinna3692e942008-01-26 00:51:45 +020015#include <linux/usb/usbnet.h>
16#include <linux/usb/rndis_host.h>
David Brownell64e04912005-08-31 09:54:36 -070017
18
19/*
20 * RNDIS is NDIS remoted over USB. It's a MSFT variant of CDC ACM ... of
21 * course ACM was intended for modems, not Ethernet links! USB's standard
22 * for Ethernet links is "CDC Ethernet", which is significantly simpler.
David Brownell51400f12006-04-02 10:19:08 -080023 *
24 * NOTE that Microsoft's "RNDIS 1.0" specification is incomplete. Issues
25 * include:
26 * - Power management in particular relies on information that's scattered
27 * through other documentation, and which is incomplete or incorrect even
28 * there.
29 * - There are various undocumented protocol requirements, such as the
30 * need to send unused garbage in control-OUT messages.
31 * - In some cases, MS-Windows will emit undocumented requests; this
32 * matters more to peripheral implementations than host ones.
33 *
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -080034 * Moreover there's a no-open-specs variant of RNDIS called "ActiveSync".
35 *
David Brownell51400f12006-04-02 10:19:08 -080036 * For these reasons and others, ** USE OF RNDIS IS STRONGLY DISCOURAGED ** in
37 * favor of such non-proprietary alternatives as CDC Ethernet or the newer (and
38 * currently rare) "Ethernet Emulation Model" (EEM).
David Brownell64e04912005-08-31 09:54:36 -070039 */
40
41/*
David Brownell64e04912005-08-31 09:54:36 -070042 * RNDIS notifications from device: command completion; "reverse"
43 * keepalives; etc
44 */
Jussi Kivilinna56659982008-01-26 00:51:17 +020045void rndis_status(struct usbnet *dev, struct urb *urb)
David Brownell64e04912005-08-31 09:54:36 -070046{
Joe Perches60b86752010-02-17 10:30:23 +000047 netdev_dbg(dev->net, "rndis status urb, len %d stat %d\n",
48 urb->actual_length, urb->status);
David Brownell64e04912005-08-31 09:54:36 -070049 // FIXME for keepalives, respond immediately (asynchronously)
50 // if not an RNDIS status, do like cdc_status(dev,urb) does
51}
Jussi Kivilinna56659982008-01-26 00:51:17 +020052EXPORT_SYMBOL_GPL(rndis_status);
David Brownell64e04912005-08-31 09:54:36 -070053
54/*
Jussi Kivilinna2a4901b2009-07-30 19:41:52 +030055 * RNDIS indicate messages.
56 */
57static void rndis_msg_indicate(struct usbnet *dev, struct rndis_indicate *msg,
58 int buflen)
59{
60 struct cdc_state *info = (void *)&dev->data;
61 struct device *udev = &info->control->dev;
62
63 if (dev->driver_info->indication) {
64 dev->driver_info->indication(dev, msg, buflen);
65 } else {
Jussi Kivilinna3eef3662012-05-11 22:17:34 +000066 u32 status = le32_to_cpu(msg->status);
67
68 switch (status) {
69 case RNDIS_STATUS_MEDIA_CONNECT:
Jussi Kivilinna2a4901b2009-07-30 19:41:52 +030070 dev_info(udev, "rndis media connect\n");
71 break;
Jussi Kivilinna3eef3662012-05-11 22:17:34 +000072 case RNDIS_STATUS_MEDIA_DISCONNECT:
Jussi Kivilinna2a4901b2009-07-30 19:41:52 +030073 dev_info(udev, "rndis media disconnect\n");
74 break;
75 default:
Jussi Kivilinna3eef3662012-05-11 22:17:34 +000076 dev_info(udev, "rndis indication: 0x%08x\n", status);
Jussi Kivilinna2a4901b2009-07-30 19:41:52 +030077 }
78 }
79}
80
81/*
David Brownell64e04912005-08-31 09:54:36 -070082 * RPC done RNDIS-style. Caller guarantees:
83 * - message is properly byteswapped
84 * - there's no other request pending
85 * - buf can hold up to 1KB response (required by RNDIS spec)
86 * On return, the first few entries are already byteswapped.
87 *
88 * Call context is likely probe(), before interface name is known,
89 * which is why we won't try to use it in the diagnostics.
90 */
Jussi Kivilinna818727b2008-06-18 15:40:12 +030091int rndis_command(struct usbnet *dev, struct rndis_msg_hdr *buf, int buflen)
David Brownell64e04912005-08-31 09:54:36 -070092{
93 struct cdc_state *info = (void *) &dev->data;
Ben Hutchings4d42d412011-04-13 14:48:55 -070094 struct usb_cdc_notification notification;
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -080095 int master_ifnum;
David Brownell64e04912005-08-31 09:54:36 -070096 int retval;
Ben Hutchings4d42d412011-04-13 14:48:55 -070097 int partial;
David Brownell64e04912005-08-31 09:54:36 -070098 unsigned count;
Jussi Kivilinna3eef3662012-05-11 22:17:34 +000099 u32 xid = 0, msg_len, request_id, msg_type, rsp,
100 status;
David Brownell64e04912005-08-31 09:54:36 -0700101
102 /* REVISIT when this gets called from contexts other than probe() or
103 * disconnect(): either serialize, or dispatch responses on xid
104 */
105
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000106 msg_type = le32_to_cpu(buf->msg_type);
107
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800108 /* Issue the request; xid is unique, don't bother byteswapping it */
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000109 if (likely(msg_type != RNDIS_MSG_HALT && msg_type != RNDIS_MSG_RESET)) {
David Brownell64e04912005-08-31 09:54:36 -0700110 xid = dev->xid++;
111 if (!xid)
112 xid = dev->xid++;
113 buf->request_id = (__force __le32) xid;
114 }
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800115 master_ifnum = info->control->cur_altsetting->desc.bInterfaceNumber;
David Brownell64e04912005-08-31 09:54:36 -0700116 retval = usb_control_msg(dev->udev,
117 usb_sndctrlpipe(dev->udev, 0),
118 USB_CDC_SEND_ENCAPSULATED_COMMAND,
119 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800120 0, master_ifnum,
David Brownell64e04912005-08-31 09:54:36 -0700121 buf, le32_to_cpu(buf->msg_len),
122 RNDIS_CONTROL_TIMEOUT_MS);
123 if (unlikely(retval < 0 || xid == 0))
124 return retval;
125
Ben Hutchings4d42d412011-04-13 14:48:55 -0700126 /* Some devices don't respond on the control channel until
127 * polled on the status channel, so do that first. */
128 if (dev->driver_info->data & RNDIS_DRIVER_DATA_POLL_STATUS) {
129 retval = usb_interrupt_msg(
130 dev->udev,
131 usb_rcvintpipe(dev->udev,
132 dev->status->desc.bEndpointAddress),
133 &notification, sizeof(notification), &partial,
134 RNDIS_CONTROL_TIMEOUT_MS);
135 if (unlikely(retval < 0))
136 return retval;
137 }
David Brownell64e04912005-08-31 09:54:36 -0700138
Ben Hutchings4d42d412011-04-13 14:48:55 -0700139 /* Poll the control channel; the request probably completed immediately */
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000140 rsp = le32_to_cpu(buf->msg_type) | RNDIS_MSG_COMPLETION;
David Brownell64e04912005-08-31 09:54:36 -0700141 for (count = 0; count < 10; count++) {
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800142 memset(buf, 0, CONTROL_BUFFER_SIZE);
David Brownell64e04912005-08-31 09:54:36 -0700143 retval = usb_control_msg(dev->udev,
144 usb_rcvctrlpipe(dev->udev, 0),
145 USB_CDC_GET_ENCAPSULATED_RESPONSE,
146 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800147 0, master_ifnum,
Jussi Kivilinna818727b2008-06-18 15:40:12 +0300148 buf, buflen,
David Brownell64e04912005-08-31 09:54:36 -0700149 RNDIS_CONTROL_TIMEOUT_MS);
150 if (likely(retval >= 8)) {
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000151 msg_type = le32_to_cpu(buf->msg_type);
David Brownell64e04912005-08-31 09:54:36 -0700152 msg_len = le32_to_cpu(buf->msg_len);
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000153 status = le32_to_cpu(buf->status);
David Brownell64e04912005-08-31 09:54:36 -0700154 request_id = (__force u32) buf->request_id;
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000155 if (likely(msg_type == rsp)) {
David Brownell64e04912005-08-31 09:54:36 -0700156 if (likely(request_id == xid)) {
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000157 if (unlikely(rsp == RNDIS_MSG_RESET_C))
David Brownell64e04912005-08-31 09:54:36 -0700158 return 0;
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000159 if (likely(RNDIS_STATUS_SUCCESS ==
160 status))
David Brownell64e04912005-08-31 09:54:36 -0700161 return 0;
162 dev_dbg(&info->control->dev,
163 "rndis reply status %08x\n",
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000164 status);
David Brownell64e04912005-08-31 09:54:36 -0700165 return -EL3RST;
166 }
167 dev_dbg(&info->control->dev,
168 "rndis reply id %d expected %d\n",
169 request_id, xid);
170 /* then likely retry */
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000171 } else switch (msg_type) {
172 case RNDIS_MSG_INDICATE: /* fault/event */
Jussi Kivilinna2a4901b2009-07-30 19:41:52 +0300173 rndis_msg_indicate(dev, (void *)buf, buflen);
David Brownell64e04912005-08-31 09:54:36 -0700174 break;
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000175 case RNDIS_MSG_KEEPALIVE: { /* ping */
David Brownell64e04912005-08-31 09:54:36 -0700176 struct rndis_keepalive_c *msg = (void *)buf;
177
Linus Walleij7390e8b02012-05-11 22:15:39 +0000178 msg->msg_type = cpu_to_le32(RNDIS_MSG_KEEPALIVE_C);
Harvey Harrison35c26c22009-02-14 22:56:56 -0800179 msg->msg_len = cpu_to_le32(sizeof *msg);
Linus Walleij7390e8b02012-05-11 22:15:39 +0000180 msg->status = cpu_to_le32(RNDIS_STATUS_SUCCESS);
David Brownell64e04912005-08-31 09:54:36 -0700181 retval = usb_control_msg(dev->udev,
182 usb_sndctrlpipe(dev->udev, 0),
183 USB_CDC_SEND_ENCAPSULATED_COMMAND,
184 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800185 0, master_ifnum,
David Brownell64e04912005-08-31 09:54:36 -0700186 msg, sizeof *msg,
187 RNDIS_CONTROL_TIMEOUT_MS);
188 if (unlikely(retval < 0))
189 dev_dbg(&info->control->dev,
190 "rndis keepalive err %d\n",
191 retval);
192 }
193 break;
194 default:
195 dev_dbg(&info->control->dev,
196 "unexpected rndis msg %08x len %d\n",
197 le32_to_cpu(buf->msg_type), msg_len);
198 }
199 } else {
200 /* device probably issued a protocol stall; ignore */
201 dev_dbg(&info->control->dev,
202 "rndis response error, code %d\n", retval);
203 }
Pierre Ynard74ef5c52008-05-14 16:20:16 -0700204 msleep(20);
David Brownell64e04912005-08-31 09:54:36 -0700205 }
206 dev_dbg(&info->control->dev, "rndis response timeout\n");
207 return -ETIMEDOUT;
208}
Jussi Kivilinna56659982008-01-26 00:51:17 +0200209EXPORT_SYMBOL_GPL(rndis_command);
David Brownell64e04912005-08-31 09:54:36 -0700210
David Brownellddda0862007-04-17 17:53:20 -0700211/*
212 * rndis_query:
213 *
214 * Performs a query for @oid along with 0 or more bytes of payload as
215 * specified by @in_len. If @reply_len is not set to -1 then the reply
216 * length is checked against this value, resulting in an error if it
217 * doesn't match.
218 *
219 * NOTE: Adding a payload exactly or greater than the size of the expected
220 * response payload is an evident requirement MSFT added for ActiveSync.
221 *
222 * The only exception is for OIDs that return a variably sized response,
223 * in which case no payload should be added. This undocumented (and
224 * nonsensical!) issue was found by sniffing protocol requests from the
225 * ActiveSync 4.1 Windows driver.
226 */
227static int rndis_query(struct usbnet *dev, struct usb_interface *intf,
Jussi Kivilinna5432bdc2012-05-11 22:17:50 +0000228 void *buf, u32 oid, u32 in_len,
David Brownellddda0862007-04-17 17:53:20 -0700229 void **reply, int *reply_len)
230{
231 int retval;
232 union {
233 void *buf;
234 struct rndis_msg_hdr *header;
235 struct rndis_query *get;
236 struct rndis_query_c *get_c;
237 } u;
238 u32 off, len;
239
240 u.buf = buf;
241
242 memset(u.get, 0, sizeof *u.get + in_len);
Linus Walleij7390e8b02012-05-11 22:15:39 +0000243 u.get->msg_type = cpu_to_le32(RNDIS_MSG_QUERY);
David Brownellddda0862007-04-17 17:53:20 -0700244 u.get->msg_len = cpu_to_le32(sizeof *u.get + in_len);
Jussi Kivilinna5432bdc2012-05-11 22:17:50 +0000245 u.get->oid = cpu_to_le32(oid);
David Brownellddda0862007-04-17 17:53:20 -0700246 u.get->len = cpu_to_le32(in_len);
Harvey Harrison35c26c22009-02-14 22:56:56 -0800247 u.get->offset = cpu_to_le32(20);
David Brownellddda0862007-04-17 17:53:20 -0700248
Jussi Kivilinna818727b2008-06-18 15:40:12 +0300249 retval = rndis_command(dev, u.header, CONTROL_BUFFER_SIZE);
David Brownellddda0862007-04-17 17:53:20 -0700250 if (unlikely(retval < 0)) {
251 dev_err(&intf->dev, "RNDIS_MSG_QUERY(0x%08x) failed, %d\n",
252 oid, retval);
253 return retval;
254 }
255
256 off = le32_to_cpu(u.get_c->offset);
257 len = le32_to_cpu(u.get_c->len);
258 if (unlikely((8 + off + len) > CONTROL_BUFFER_SIZE))
259 goto response_error;
260
261 if (*reply_len != -1 && len != *reply_len)
262 goto response_error;
263
264 *reply = (unsigned char *) &u.get_c->request_id + off;
265 *reply_len = len;
266
267 return retval;
268
269response_error:
270 dev_err(&intf->dev, "RNDIS_MSG_QUERY(0x%08x) "
271 "invalid response - off %d len %d\n",
272 oid, off, len);
273 return -EDOM;
274}
275
Stephen Hemminger0f2166d2009-03-20 19:36:00 +0000276/* same as usbnet_netdev_ops but MTU change not allowed */
277static const struct net_device_ops rndis_netdev_ops = {
278 .ndo_open = usbnet_open,
279 .ndo_stop = usbnet_stop,
280 .ndo_start_xmit = usbnet_start_xmit,
281 .ndo_tx_timeout = usbnet_tx_timeout,
Greg Ungererc8b5d122017-04-03 15:50:03 +1000282 .ndo_get_stats64 = usbnet_get_stats64,
Stephen Hemminger0f2166d2009-03-20 19:36:00 +0000283 .ndo_set_mac_address = eth_mac_addr,
284 .ndo_validate_addr = eth_validate_addr,
285};
286
Jussi Kivilinna039ee172008-01-27 23:34:33 +0200287int
288generic_rndis_bind(struct usbnet *dev, struct usb_interface *intf, int flags)
David Brownell64e04912005-08-31 09:54:36 -0700289{
290 int retval;
291 struct net_device *net = dev->net;
Daniel Gollubdeb31f12007-01-16 11:03:01 +0100292 struct cdc_state *info = (void *) &dev->data;
David Brownell64e04912005-08-31 09:54:36 -0700293 union {
294 void *buf;
295 struct rndis_msg_hdr *header;
296 struct rndis_init *init;
297 struct rndis_init_c *init_c;
298 struct rndis_query *get;
299 struct rndis_query_c *get_c;
300 struct rndis_set *set;
301 struct rndis_set_c *set_c;
Jussi Kivilinna9ff55872008-01-26 00:50:55 +0200302 struct rndis_halt *halt;
David Brownell64e04912005-08-31 09:54:36 -0700303 } u;
Al Virod63ddce2008-05-21 01:34:30 +0100304 u32 tmp;
305 __le32 phym_unspec, *phym;
David Brownellddda0862007-04-17 17:53:20 -0700306 int reply_len;
307 unsigned char *bp;
David Brownell64e04912005-08-31 09:54:36 -0700308
309 /* we can't rely on i/o from stack working, or stack allocation */
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800310 u.buf = kmalloc(CONTROL_BUFFER_SIZE, GFP_KERNEL);
David Brownell64e04912005-08-31 09:54:36 -0700311 if (!u.buf)
312 return -ENOMEM;
313 retval = usbnet_generic_cdc_bind(dev, intf);
314 if (retval < 0)
Daniel Gollubdeb31f12007-01-16 11:03:01 +0100315 goto fail;
David Brownell64e04912005-08-31 09:54:36 -0700316
Linus Walleij7390e8b02012-05-11 22:15:39 +0000317 u.init->msg_type = cpu_to_le32(RNDIS_MSG_INIT);
Harvey Harrison35c26c22009-02-14 22:56:56 -0800318 u.init->msg_len = cpu_to_le32(sizeof *u.init);
319 u.init->major_version = cpu_to_le32(1);
320 u.init->minor_version = cpu_to_le32(0);
David Brownell64e04912005-08-31 09:54:36 -0700321
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800322 /* max transfer (in spec) is 0x4000 at full speed, but for
323 * TX we'll stick to one Ethernet packet plus RNDIS framing.
324 * For RX we handle drivers that zero-pad to end-of-packet.
325 * Don't let userspace change these settings.
David Brownellddda0862007-04-17 17:53:20 -0700326 *
327 * NOTE: there still seems to be wierdness here, as if we need
328 * to do some more things to make sure WinCE targets accept this.
329 * They default to jumbograms of 8KB or 16KB, which is absurd
330 * for such low data rates and which is also more than Linux
331 * can usually expect to allocate for SKB data...
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800332 */
333 net->hard_header_len += sizeof (struct rndis_data_hdr);
334 dev->hard_mtu = net->mtu + net->hard_header_len;
335
Jean-Christophe Dubois10d0f272008-03-13 14:56:36 -0800336 dev->maxpacket = usb_maxpacket(dev->udev, dev->out, 1);
337 if (dev->maxpacket == 0) {
Joe Perchesa475f602010-02-17 10:30:24 +0000338 netif_dbg(dev, probe, dev->net,
339 "dev->maxpacket can't be 0\n");
Jean-Christophe Dubois10d0f272008-03-13 14:56:36 -0800340 retval = -EINVAL;
341 goto fail_and_release;
342 }
343
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800344 dev->rx_urb_size = dev->hard_mtu + (dev->maxpacket + 1);
345 dev->rx_urb_size &= ~(dev->maxpacket - 1);
346 u.init->max_transfer_size = cpu_to_le32(dev->rx_urb_size);
347
Stephen Hemminger0f2166d2009-03-20 19:36:00 +0000348 net->netdev_ops = &rndis_netdev_ops;
349
Jussi Kivilinna818727b2008-06-18 15:40:12 +0300350 retval = rndis_command(dev, u.header, CONTROL_BUFFER_SIZE);
David Brownell64e04912005-08-31 09:54:36 -0700351 if (unlikely(retval < 0)) {
352 /* it might not even be an RNDIS device!! */
353 dev_err(&intf->dev, "RNDIS init failed, %d\n", retval);
David Brownellddda0862007-04-17 17:53:20 -0700354 goto fail_and_release;
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800355 }
356 tmp = le32_to_cpu(u.init_c->max_transfer_size);
357 if (tmp < dev->hard_mtu) {
Thomas Sailer500d2c22007-10-24 00:47:19 +0200358 if (tmp <= net->hard_header_len) {
359 dev_err(&intf->dev,
360 "dev can't take %u byte packets (max %u)\n",
361 dev->hard_mtu, tmp);
362 retval = -EINVAL;
Jussi Kivilinna9ff55872008-01-26 00:50:55 +0200363 goto halt_fail_and_release;
Thomas Sailer500d2c22007-10-24 00:47:19 +0200364 }
Thomas Sailer500d2c22007-10-24 00:47:19 +0200365 dev_warn(&intf->dev,
366 "dev can't take %u byte packets (max %u), "
367 "adjusting MTU to %u\n",
George Nassar40ac7b62009-10-14 18:27:41 -0500368 dev->hard_mtu, tmp, tmp - net->hard_header_len);
369 dev->hard_mtu = tmp;
370 net->mtu = dev->hard_mtu - net->hard_header_len;
David Brownell64e04912005-08-31 09:54:36 -0700371 }
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800372
David Brownell64e04912005-08-31 09:54:36 -0700373 /* REVISIT: peripheral "alignment" request is ignored ... */
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800374 dev_dbg(&intf->dev,
Alexey Dobriyan5b5e0922017-02-27 14:30:02 -0800375 "hard mtu %u (%u from dev), rx buflen %zu, align %d\n",
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800376 dev->hard_mtu, tmp, dev->rx_urb_size,
David Brownell64e04912005-08-31 09:54:36 -0700377 1 << le32_to_cpu(u.init_c->packet_alignment));
378
Jussi Kivilinna7c39e032008-01-26 00:51:28 +0200379 /* module has some device initialization code needs to be done right
380 * after RNDIS_INIT */
381 if (dev->driver_info->early_init &&
382 dev->driver_info->early_init(dev) != 0)
383 goto halt_fail_and_release;
384
Jussi Kivilinna039ee172008-01-27 23:34:33 +0200385 /* Check physical medium */
Jussi Kivilinna9f5e60d2008-03-23 12:45:44 +0200386 phym = NULL;
Jussi Kivilinna039ee172008-01-27 23:34:33 +0200387 reply_len = sizeof *phym;
Linus Walleij7390e8b02012-05-11 22:15:39 +0000388 retval = rndis_query(dev, intf, u.buf,
Jussi Kivilinna5432bdc2012-05-11 22:17:50 +0000389 RNDIS_OID_GEN_PHYSICAL_MEDIUM,
390 0, (void **) &phym, &reply_len);
Jussi Kivilinna9f5e60d2008-03-23 12:45:44 +0200391 if (retval != 0 || !phym) {
Jussi Kivilinna039ee172008-01-27 23:34:33 +0200392 /* OID is optional so don't fail here. */
Linus Walleij7390e8b02012-05-11 22:15:39 +0000393 phym_unspec = cpu_to_le32(RNDIS_PHYSICAL_MEDIUM_UNSPECIFIED);
Jussi Kivilinna9f5e60d2008-03-23 12:45:44 +0200394 phym = &phym_unspec;
395 }
Jussi Kivilinna039ee172008-01-27 23:34:33 +0200396 if ((flags & FLAG_RNDIS_PHYM_WIRELESS) &&
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000397 le32_to_cpup(phym) != RNDIS_PHYSICAL_MEDIUM_WIRELESS_LAN) {
Joe Perchesa475f602010-02-17 10:30:24 +0000398 netif_dbg(dev, probe, dev->net,
399 "driver requires wireless physical medium, but device is not\n");
Jussi Kivilinna039ee172008-01-27 23:34:33 +0200400 retval = -ENODEV;
401 goto halt_fail_and_release;
402 }
403 if ((flags & FLAG_RNDIS_PHYM_NOT_WIRELESS) &&
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000404 le32_to_cpup(phym) == RNDIS_PHYSICAL_MEDIUM_WIRELESS_LAN) {
Joe Perchesa475f602010-02-17 10:30:24 +0000405 netif_dbg(dev, probe, dev->net,
406 "driver requires non-wireless physical medium, but device is wireless.\n");
Jussi Kivilinna039ee172008-01-27 23:34:33 +0200407 retval = -ENODEV;
408 goto halt_fail_and_release;
409 }
410
David Brownellddda0862007-04-17 17:53:20 -0700411 /* Get designated host ethernet address */
412 reply_len = ETH_ALEN;
Linus Walleij7390e8b02012-05-11 22:15:39 +0000413 retval = rndis_query(dev, intf, u.buf,
Jussi Kivilinna5432bdc2012-05-11 22:17:50 +0000414 RNDIS_OID_802_3_PERMANENT_ADDRESS,
415 48, (void **) &bp, &reply_len);
David Brownellddda0862007-04-17 17:53:20 -0700416 if (unlikely(retval< 0)) {
David Brownell64e04912005-08-31 09:54:36 -0700417 dev_err(&intf->dev, "rndis get ethaddr, %d\n", retval);
Jussi Kivilinna9ff55872008-01-26 00:50:55 +0200418 goto halt_fail_and_release;
David Brownell64e04912005-08-31 09:54:36 -0700419 }
Kristian Evensena5a18bd2016-07-14 10:23:03 +0200420
421 if (bp[0] & 0x02)
422 eth_hw_addr_random(net);
423 else
424 ether_addr_copy(net->dev_addr, bp);
David Brownell64e04912005-08-31 09:54:36 -0700425
426 /* set a nonzero filter to enable data transfers */
427 memset(u.set, 0, sizeof *u.set);
Linus Walleij7390e8b02012-05-11 22:15:39 +0000428 u.set->msg_type = cpu_to_le32(RNDIS_MSG_SET);
Harvey Harrison35c26c22009-02-14 22:56:56 -0800429 u.set->msg_len = cpu_to_le32(4 + sizeof *u.set);
Linus Walleij8cdddc32012-05-11 22:16:08 +0000430 u.set->oid = cpu_to_le32(RNDIS_OID_GEN_CURRENT_PACKET_FILTER);
Harvey Harrison35c26c22009-02-14 22:56:56 -0800431 u.set->len = cpu_to_le32(4);
432 u.set->offset = cpu_to_le32((sizeof *u.set) - 8);
Linus Walleij7390e8b02012-05-11 22:15:39 +0000433 *(__le32 *)(u.buf + sizeof *u.set) = cpu_to_le32(RNDIS_DEFAULT_FILTER);
David Brownell64e04912005-08-31 09:54:36 -0700434
Jussi Kivilinna818727b2008-06-18 15:40:12 +0300435 retval = rndis_command(dev, u.header, CONTROL_BUFFER_SIZE);
David Brownell64e04912005-08-31 09:54:36 -0700436 if (unlikely(retval < 0)) {
437 dev_err(&intf->dev, "rndis set packet filter, %d\n", retval);
Jussi Kivilinna9ff55872008-01-26 00:50:55 +0200438 goto halt_fail_and_release;
David Brownell64e04912005-08-31 09:54:36 -0700439 }
440
441 retval = 0;
Daniel Gollubdeb31f12007-01-16 11:03:01 +0100442
443 kfree(u.buf);
444 return retval;
445
Jussi Kivilinna9ff55872008-01-26 00:50:55 +0200446halt_fail_and_release:
447 memset(u.halt, 0, sizeof *u.halt);
Linus Walleij7390e8b02012-05-11 22:15:39 +0000448 u.halt->msg_type = cpu_to_le32(RNDIS_MSG_HALT);
Harvey Harrison35c26c22009-02-14 22:56:56 -0800449 u.halt->msg_len = cpu_to_le32(sizeof *u.halt);
Jussi Kivilinna818727b2008-06-18 15:40:12 +0300450 (void) rndis_command(dev, (void *)u.halt, CONTROL_BUFFER_SIZE);
Daniel Gollubdeb31f12007-01-16 11:03:01 +0100451fail_and_release:
452 usb_set_intfdata(info->data, NULL);
453 usb_driver_release_interface(driver_of(intf), info->data);
David Brownellddda0862007-04-17 17:53:20 -0700454 info->data = NULL;
Daniel Gollubdeb31f12007-01-16 11:03:01 +0100455fail:
David Brownell64e04912005-08-31 09:54:36 -0700456 kfree(u.buf);
457 return retval;
458}
Jussi Kivilinna56659982008-01-26 00:51:17 +0200459EXPORT_SYMBOL_GPL(generic_rndis_bind);
David Brownell64e04912005-08-31 09:54:36 -0700460
Jussi Kivilinna039ee172008-01-27 23:34:33 +0200461static int rndis_bind(struct usbnet *dev, struct usb_interface *intf)
462{
463 return generic_rndis_bind(dev, intf, FLAG_RNDIS_PHYM_NOT_WIRELESS);
464}
465
Jussi Kivilinna56659982008-01-26 00:51:17 +0200466void rndis_unbind(struct usbnet *dev, struct usb_interface *intf)
David Brownell64e04912005-08-31 09:54:36 -0700467{
468 struct rndis_halt *halt;
469
470 /* try to clear any rndis state/activity (no i/o from stack!) */
Jussi Kivilinna04c3c012008-01-26 00:50:49 +0200471 halt = kzalloc(CONTROL_BUFFER_SIZE, GFP_KERNEL);
David Brownell64e04912005-08-31 09:54:36 -0700472 if (halt) {
Linus Walleij7390e8b02012-05-11 22:15:39 +0000473 halt->msg_type = cpu_to_le32(RNDIS_MSG_HALT);
Harvey Harrison35c26c22009-02-14 22:56:56 -0800474 halt->msg_len = cpu_to_le32(sizeof *halt);
Jussi Kivilinna818727b2008-06-18 15:40:12 +0300475 (void) rndis_command(dev, (void *)halt, CONTROL_BUFFER_SIZE);
David Brownell64e04912005-08-31 09:54:36 -0700476 kfree(halt);
477 }
478
Bjorge Dijkstra2bfa2e12008-01-26 00:50:38 +0200479 usbnet_cdc_unbind(dev, intf);
David Brownell64e04912005-08-31 09:54:36 -0700480}
Jussi Kivilinna56659982008-01-26 00:51:17 +0200481EXPORT_SYMBOL_GPL(rndis_unbind);
David Brownell64e04912005-08-31 09:54:36 -0700482
483/*
484 * DATA -- host must not write zlps
485 */
Jussi Kivilinna56659982008-01-26 00:51:17 +0200486int rndis_rx_fixup(struct usbnet *dev, struct sk_buff *skb)
David Brownell64e04912005-08-31 09:54:36 -0700487{
Emil Goodeeb855692014-02-13 17:50:19 +0100488 /* This check is no longer done by usbnet */
489 if (skb->len < dev->net->hard_header_len)
490 return 0;
491
David Brownell64e04912005-08-31 09:54:36 -0700492 /* peripheral may have batched packets to us... */
493 while (likely(skb->len)) {
494 struct rndis_data_hdr *hdr = (void *)skb->data;
495 struct sk_buff *skb2;
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000496 u32 msg_type, msg_len, data_offset, data_len;
David Brownell64e04912005-08-31 09:54:36 -0700497
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000498 msg_type = le32_to_cpu(hdr->msg_type);
David Brownell64e04912005-08-31 09:54:36 -0700499 msg_len = le32_to_cpu(hdr->msg_len);
500 data_offset = le32_to_cpu(hdr->data_offset);
501 data_len = le32_to_cpu(hdr->data_len);
502
503 /* don't choke if we see oob, per-packet data, etc */
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000504 if (unlikely(msg_type != RNDIS_MSG_PACKET || skb->len < msg_len
505 || (data_offset + data_len + 8) > msg_len)) {
Herbert Xu58e2e7d2009-06-29 16:52:26 +0000506 dev->net->stats.rx_frame_errors++;
Joe Perches60b86752010-02-17 10:30:23 +0000507 netdev_dbg(dev->net, "bad rndis message %d/%d/%d/%d, len %d\n",
508 le32_to_cpu(hdr->msg_type),
509 msg_len, data_offset, data_len, skb->len);
David Brownell64e04912005-08-31 09:54:36 -0700510 return 0;
511 }
512 skb_pull(skb, 8 + data_offset);
513
514 /* at most one packet left? */
515 if (likely((data_len - skb->len) <= sizeof *hdr)) {
516 skb_trim(skb, data_len);
517 break;
518 }
519
520 /* try to return all the packets in the batch */
521 skb2 = skb_clone(skb, GFP_ATOMIC);
522 if (unlikely(!skb2))
523 break;
524 skb_pull(skb, msg_len - sizeof *hdr);
525 skb_trim(skb2, data_len);
526 usbnet_skb_return(dev, skb2);
527 }
528
529 /* caller will usbnet_skb_return the remaining packet */
530 return 1;
531}
Jussi Kivilinna56659982008-01-26 00:51:17 +0200532EXPORT_SYMBOL_GPL(rndis_rx_fixup);
David Brownell64e04912005-08-31 09:54:36 -0700533
Jussi Kivilinna56659982008-01-26 00:51:17 +0200534struct sk_buff *
Al Viro55016f12005-10-21 03:21:58 -0400535rndis_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
David Brownell64e04912005-08-31 09:54:36 -0700536{
537 struct rndis_data_hdr *hdr;
538 struct sk_buff *skb2;
539 unsigned len = skb->len;
540
541 if (likely(!skb_cloned(skb))) {
542 int room = skb_headroom(skb);
543
544 /* enough head room as-is? */
545 if (unlikely((sizeof *hdr) <= room))
546 goto fill;
547
548 /* enough room, but needs to be readjusted? */
549 room += skb_tailroom(skb);
550 if (likely((sizeof *hdr) <= room)) {
551 skb->data = memmove(skb->head + sizeof *hdr,
552 skb->data, len);
Arnaldo Carvalho de Melo27a884d2007-04-19 20:29:13 -0700553 skb_set_tail_pointer(skb, len);
David Brownell64e04912005-08-31 09:54:36 -0700554 goto fill;
555 }
556 }
557
558 /* create a new skb, with the correct size (and tailpad) */
559 skb2 = skb_copy_expand(skb, sizeof *hdr, 1, flags);
560 dev_kfree_skb_any(skb);
561 if (unlikely(!skb2))
562 return skb2;
563 skb = skb2;
564
565 /* fill out the RNDIS header. we won't bother trying to batch
566 * packets; Linux minimizes wasted bandwidth through tx queues.
567 */
568fill:
Johannes Bergd58ff352017-06-16 14:29:23 +0200569 hdr = __skb_push(skb, sizeof *hdr);
David Brownell64e04912005-08-31 09:54:36 -0700570 memset(hdr, 0, sizeof *hdr);
Linus Walleij7390e8b02012-05-11 22:15:39 +0000571 hdr->msg_type = cpu_to_le32(RNDIS_MSG_PACKET);
David Brownell64e04912005-08-31 09:54:36 -0700572 hdr->msg_len = cpu_to_le32(skb->len);
Harvey Harrison35c26c22009-02-14 22:56:56 -0800573 hdr->data_offset = cpu_to_le32(sizeof(*hdr) - 8);
David Brownell64e04912005-08-31 09:54:36 -0700574 hdr->data_len = cpu_to_le32(len);
575
576 /* FIXME make the last packet always be short ... */
577 return skb;
578}
Jussi Kivilinna56659982008-01-26 00:51:17 +0200579EXPORT_SYMBOL_GPL(rndis_tx_fixup);
David Brownell64e04912005-08-31 09:54:36 -0700580
581
582static const struct driver_info rndis_info = {
583 .description = "RNDIS device",
Arnd Bergmannc2613442011-04-01 20:12:02 -0700584 .flags = FLAG_ETHER | FLAG_POINTTOPOINT | FLAG_FRAMING_RN | FLAG_NO_SETINT,
Jussi Kivilinna039ee172008-01-27 23:34:33 +0200585 .bind = rndis_bind,
David Brownell64e04912005-08-31 09:54:36 -0700586 .unbind = rndis_unbind,
587 .status = rndis_status,
588 .rx_fixup = rndis_rx_fixup,
589 .tx_fixup = rndis_tx_fixup,
590};
591
Ben Hutchings4d42d412011-04-13 14:48:55 -0700592static const struct driver_info rndis_poll_status_info = {
593 .description = "RNDIS device (poll status before control)",
Ben Hutchingseb8aa722011-04-14 23:23:45 -0700594 .flags = FLAG_ETHER | FLAG_POINTTOPOINT | FLAG_FRAMING_RN | FLAG_NO_SETINT,
Ben Hutchings4d42d412011-04-13 14:48:55 -0700595 .data = RNDIS_DRIVER_DATA_POLL_STATUS,
596 .bind = rndis_bind,
597 .unbind = rndis_unbind,
598 .status = rndis_status,
599 .rx_fixup = rndis_rx_fixup,
600 .tx_fixup = rndis_tx_fixup,
601};
602
David Brownell64e04912005-08-31 09:54:36 -0700603/*-------------------------------------------------------------------------*/
604
605static const struct usb_device_id products [] = {
606{
Ben Hutchings4d42d412011-04-13 14:48:55 -0700607 /* 2Wire HomePortal 1000SW */
608 USB_DEVICE_AND_INTERFACE_INFO(0x1630, 0x0042,
609 USB_CLASS_COMM, 2 /* ACM */, 0x0ff),
610 .driver_info = (unsigned long) &rndis_poll_status_info,
611}, {
David Brownell64e04912005-08-31 09:54:36 -0700612 /* RNDIS is MSFT's un-official variant of CDC ACM */
613 USB_INTERFACE_INFO(USB_CLASS_COMM, 2 /* ACM */, 0x0ff),
614 .driver_info = (unsigned long) &rndis_info,
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800615}, {
616 /* "ActiveSync" is an undocumented variant of RNDIS, used in WM5 */
617 USB_INTERFACE_INFO(USB_CLASS_MISC, 1, 1),
Ben Hutchings4d42d412011-04-13 14:48:55 -0700618 .driver_info = (unsigned long) &rndis_poll_status_info,
Thomas Backlund7e99eed2008-07-22 13:55:58 -0700619}, {
620 /* RNDIS for tethering */
621 USB_INTERFACE_INFO(USB_CLASS_WIRELESS_CONTROLLER, 1, 3),
622 .driver_info = (unsigned long) &rndis_info,
Aleksander Morgado63ba3952017-09-27 23:31:03 +0200623}, {
624 /* Novatel Verizon USB730L */
625 USB_INTERFACE_INFO(USB_CLASS_MISC, 4, 1),
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");