blob: a48bc0f20c1a860a66299d00391381cf58972b95 [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/netdevice.h>
20#include <linux/etherdevice.h>
21#include <linux/ethtool.h>
22#include <linux/workqueue.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090023#include <linux/slab.h>
David Brownell64e04912005-08-31 09:54:36 -070024#include <linux/mii.h>
25#include <linux/usb.h>
David Brownella8c28f22006-06-13 09:57:47 -070026#include <linux/usb/cdc.h>
Jussi Kivilinna3692e942008-01-26 00:51:45 +020027#include <linux/usb/usbnet.h>
28#include <linux/usb/rndis_host.h>
David Brownell64e04912005-08-31 09:54:36 -070029
30
31/*
32 * RNDIS is NDIS remoted over USB. It's a MSFT variant of CDC ACM ... of
33 * course ACM was intended for modems, not Ethernet links! USB's standard
34 * for Ethernet links is "CDC Ethernet", which is significantly simpler.
David Brownell51400f12006-04-02 10:19:08 -080035 *
36 * NOTE that Microsoft's "RNDIS 1.0" specification is incomplete. Issues
37 * include:
38 * - Power management in particular relies on information that's scattered
39 * through other documentation, and which is incomplete or incorrect even
40 * there.
41 * - There are various undocumented protocol requirements, such as the
42 * need to send unused garbage in control-OUT messages.
43 * - In some cases, MS-Windows will emit undocumented requests; this
44 * matters more to peripheral implementations than host ones.
45 *
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -080046 * Moreover there's a no-open-specs variant of RNDIS called "ActiveSync".
47 *
David Brownell51400f12006-04-02 10:19:08 -080048 * For these reasons and others, ** USE OF RNDIS IS STRONGLY DISCOURAGED ** in
49 * favor of such non-proprietary alternatives as CDC Ethernet or the newer (and
50 * currently rare) "Ethernet Emulation Model" (EEM).
David Brownell64e04912005-08-31 09:54:36 -070051 */
52
53/*
David Brownell64e04912005-08-31 09:54:36 -070054 * RNDIS notifications from device: command completion; "reverse"
55 * keepalives; etc
56 */
Jussi Kivilinna56659982008-01-26 00:51:17 +020057void rndis_status(struct usbnet *dev, struct urb *urb)
David Brownell64e04912005-08-31 09:54:36 -070058{
Joe Perches60b86752010-02-17 10:30:23 +000059 netdev_dbg(dev->net, "rndis status urb, len %d stat %d\n",
60 urb->actual_length, urb->status);
David Brownell64e04912005-08-31 09:54:36 -070061 // FIXME for keepalives, respond immediately (asynchronously)
62 // if not an RNDIS status, do like cdc_status(dev,urb) does
63}
Jussi Kivilinna56659982008-01-26 00:51:17 +020064EXPORT_SYMBOL_GPL(rndis_status);
David Brownell64e04912005-08-31 09:54:36 -070065
66/*
Jussi Kivilinna2a4901b2009-07-30 19:41:52 +030067 * RNDIS indicate messages.
68 */
69static void rndis_msg_indicate(struct usbnet *dev, struct rndis_indicate *msg,
70 int buflen)
71{
72 struct cdc_state *info = (void *)&dev->data;
73 struct device *udev = &info->control->dev;
74
75 if (dev->driver_info->indication) {
76 dev->driver_info->indication(dev, msg, buflen);
77 } else {
Jussi Kivilinna3eef3662012-05-11 22:17:34 +000078 u32 status = le32_to_cpu(msg->status);
79
80 switch (status) {
81 case RNDIS_STATUS_MEDIA_CONNECT:
Jussi Kivilinna2a4901b2009-07-30 19:41:52 +030082 dev_info(udev, "rndis media connect\n");
83 break;
Jussi Kivilinna3eef3662012-05-11 22:17:34 +000084 case RNDIS_STATUS_MEDIA_DISCONNECT:
Jussi Kivilinna2a4901b2009-07-30 19:41:52 +030085 dev_info(udev, "rndis media disconnect\n");
86 break;
87 default:
Jussi Kivilinna3eef3662012-05-11 22:17:34 +000088 dev_info(udev, "rndis indication: 0x%08x\n", status);
Jussi Kivilinna2a4901b2009-07-30 19:41:52 +030089 }
90 }
91}
92
93/*
David Brownell64e04912005-08-31 09:54:36 -070094 * RPC done RNDIS-style. Caller guarantees:
95 * - message is properly byteswapped
96 * - there's no other request pending
97 * - buf can hold up to 1KB response (required by RNDIS spec)
98 * On return, the first few entries are already byteswapped.
99 *
100 * Call context is likely probe(), before interface name is known,
101 * which is why we won't try to use it in the diagnostics.
102 */
Jussi Kivilinna818727b2008-06-18 15:40:12 +0300103int rndis_command(struct usbnet *dev, struct rndis_msg_hdr *buf, int buflen)
David Brownell64e04912005-08-31 09:54:36 -0700104{
105 struct cdc_state *info = (void *) &dev->data;
Ben Hutchings4d42d412011-04-13 14:48:55 -0700106 struct usb_cdc_notification notification;
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800107 int master_ifnum;
David Brownell64e04912005-08-31 09:54:36 -0700108 int retval;
Ben Hutchings4d42d412011-04-13 14:48:55 -0700109 int partial;
David Brownell64e04912005-08-31 09:54:36 -0700110 unsigned count;
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000111 u32 xid = 0, msg_len, request_id, msg_type, rsp,
112 status;
David Brownell64e04912005-08-31 09:54:36 -0700113
114 /* REVISIT when this gets called from contexts other than probe() or
115 * disconnect(): either serialize, or dispatch responses on xid
116 */
117
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000118 msg_type = le32_to_cpu(buf->msg_type);
119
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800120 /* Issue the request; xid is unique, don't bother byteswapping it */
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000121 if (likely(msg_type != RNDIS_MSG_HALT && msg_type != RNDIS_MSG_RESET)) {
David Brownell64e04912005-08-31 09:54:36 -0700122 xid = dev->xid++;
123 if (!xid)
124 xid = dev->xid++;
125 buf->request_id = (__force __le32) xid;
126 }
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800127 master_ifnum = info->control->cur_altsetting->desc.bInterfaceNumber;
David Brownell64e04912005-08-31 09:54:36 -0700128 retval = usb_control_msg(dev->udev,
129 usb_sndctrlpipe(dev->udev, 0),
130 USB_CDC_SEND_ENCAPSULATED_COMMAND,
131 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800132 0, master_ifnum,
David Brownell64e04912005-08-31 09:54:36 -0700133 buf, le32_to_cpu(buf->msg_len),
134 RNDIS_CONTROL_TIMEOUT_MS);
135 if (unlikely(retval < 0 || xid == 0))
136 return retval;
137
Ben Hutchings4d42d412011-04-13 14:48:55 -0700138 /* Some devices don't respond on the control channel until
139 * polled on the status channel, so do that first. */
140 if (dev->driver_info->data & RNDIS_DRIVER_DATA_POLL_STATUS) {
141 retval = usb_interrupt_msg(
142 dev->udev,
143 usb_rcvintpipe(dev->udev,
144 dev->status->desc.bEndpointAddress),
145 &notification, sizeof(notification), &partial,
146 RNDIS_CONTROL_TIMEOUT_MS);
147 if (unlikely(retval < 0))
148 return retval;
149 }
David Brownell64e04912005-08-31 09:54:36 -0700150
Ben Hutchings4d42d412011-04-13 14:48:55 -0700151 /* Poll the control channel; the request probably completed immediately */
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000152 rsp = le32_to_cpu(buf->msg_type) | RNDIS_MSG_COMPLETION;
David Brownell64e04912005-08-31 09:54:36 -0700153 for (count = 0; count < 10; count++) {
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800154 memset(buf, 0, CONTROL_BUFFER_SIZE);
David Brownell64e04912005-08-31 09:54:36 -0700155 retval = usb_control_msg(dev->udev,
156 usb_rcvctrlpipe(dev->udev, 0),
157 USB_CDC_GET_ENCAPSULATED_RESPONSE,
158 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800159 0, master_ifnum,
Jussi Kivilinna818727b2008-06-18 15:40:12 +0300160 buf, buflen,
David Brownell64e04912005-08-31 09:54:36 -0700161 RNDIS_CONTROL_TIMEOUT_MS);
162 if (likely(retval >= 8)) {
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000163 msg_type = le32_to_cpu(buf->msg_type);
David Brownell64e04912005-08-31 09:54:36 -0700164 msg_len = le32_to_cpu(buf->msg_len);
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000165 status = le32_to_cpu(buf->status);
David Brownell64e04912005-08-31 09:54:36 -0700166 request_id = (__force u32) buf->request_id;
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000167 if (likely(msg_type == rsp)) {
David Brownell64e04912005-08-31 09:54:36 -0700168 if (likely(request_id == xid)) {
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000169 if (unlikely(rsp == RNDIS_MSG_RESET_C))
David Brownell64e04912005-08-31 09:54:36 -0700170 return 0;
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000171 if (likely(RNDIS_STATUS_SUCCESS ==
172 status))
David Brownell64e04912005-08-31 09:54:36 -0700173 return 0;
174 dev_dbg(&info->control->dev,
175 "rndis reply status %08x\n",
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000176 status);
David Brownell64e04912005-08-31 09:54:36 -0700177 return -EL3RST;
178 }
179 dev_dbg(&info->control->dev,
180 "rndis reply id %d expected %d\n",
181 request_id, xid);
182 /* then likely retry */
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000183 } else switch (msg_type) {
184 case RNDIS_MSG_INDICATE: /* fault/event */
Jussi Kivilinna2a4901b2009-07-30 19:41:52 +0300185 rndis_msg_indicate(dev, (void *)buf, buflen);
David Brownell64e04912005-08-31 09:54:36 -0700186 break;
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000187 case RNDIS_MSG_KEEPALIVE: { /* ping */
David Brownell64e04912005-08-31 09:54:36 -0700188 struct rndis_keepalive_c *msg = (void *)buf;
189
Linus Walleij7390e8b2012-05-11 22:15:39 +0000190 msg->msg_type = cpu_to_le32(RNDIS_MSG_KEEPALIVE_C);
Harvey Harrison35c26c22009-02-14 22:56:56 -0800191 msg->msg_len = cpu_to_le32(sizeof *msg);
Linus Walleij7390e8b2012-05-11 22:15:39 +0000192 msg->status = cpu_to_le32(RNDIS_STATUS_SUCCESS);
David Brownell64e04912005-08-31 09:54:36 -0700193 retval = usb_control_msg(dev->udev,
194 usb_sndctrlpipe(dev->udev, 0),
195 USB_CDC_SEND_ENCAPSULATED_COMMAND,
196 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800197 0, master_ifnum,
David Brownell64e04912005-08-31 09:54:36 -0700198 msg, sizeof *msg,
199 RNDIS_CONTROL_TIMEOUT_MS);
200 if (unlikely(retval < 0))
201 dev_dbg(&info->control->dev,
202 "rndis keepalive err %d\n",
203 retval);
204 }
205 break;
206 default:
207 dev_dbg(&info->control->dev,
208 "unexpected rndis msg %08x len %d\n",
209 le32_to_cpu(buf->msg_type), msg_len);
210 }
211 } else {
212 /* device probably issued a protocol stall; ignore */
213 dev_dbg(&info->control->dev,
214 "rndis response error, code %d\n", retval);
215 }
Pierre Ynard74ef5c52008-05-14 16:20:16 -0700216 msleep(20);
David Brownell64e04912005-08-31 09:54:36 -0700217 }
218 dev_dbg(&info->control->dev, "rndis response timeout\n");
219 return -ETIMEDOUT;
220}
Jussi Kivilinna56659982008-01-26 00:51:17 +0200221EXPORT_SYMBOL_GPL(rndis_command);
David Brownell64e04912005-08-31 09:54:36 -0700222
David Brownellddda0862007-04-17 17:53:20 -0700223/*
224 * rndis_query:
225 *
226 * Performs a query for @oid along with 0 or more bytes of payload as
227 * specified by @in_len. If @reply_len is not set to -1 then the reply
228 * length is checked against this value, resulting in an error if it
229 * doesn't match.
230 *
231 * NOTE: Adding a payload exactly or greater than the size of the expected
232 * response payload is an evident requirement MSFT added for ActiveSync.
233 *
234 * The only exception is for OIDs that return a variably sized response,
235 * in which case no payload should be added. This undocumented (and
236 * nonsensical!) issue was found by sniffing protocol requests from the
237 * ActiveSync 4.1 Windows driver.
238 */
239static int rndis_query(struct usbnet *dev, struct usb_interface *intf,
Jussi Kivilinna5432bdc2012-05-11 22:17:50 +0000240 void *buf, u32 oid, u32 in_len,
David Brownellddda0862007-04-17 17:53:20 -0700241 void **reply, int *reply_len)
242{
243 int retval;
244 union {
245 void *buf;
246 struct rndis_msg_hdr *header;
247 struct rndis_query *get;
248 struct rndis_query_c *get_c;
249 } u;
250 u32 off, len;
251
252 u.buf = buf;
253
254 memset(u.get, 0, sizeof *u.get + in_len);
Linus Walleij7390e8b2012-05-11 22:15:39 +0000255 u.get->msg_type = cpu_to_le32(RNDIS_MSG_QUERY);
David Brownellddda0862007-04-17 17:53:20 -0700256 u.get->msg_len = cpu_to_le32(sizeof *u.get + in_len);
Jussi Kivilinna5432bdc2012-05-11 22:17:50 +0000257 u.get->oid = cpu_to_le32(oid);
David Brownellddda0862007-04-17 17:53:20 -0700258 u.get->len = cpu_to_le32(in_len);
Harvey Harrison35c26c22009-02-14 22:56:56 -0800259 u.get->offset = cpu_to_le32(20);
David Brownellddda0862007-04-17 17:53:20 -0700260
Jussi Kivilinna818727b2008-06-18 15:40:12 +0300261 retval = rndis_command(dev, u.header, CONTROL_BUFFER_SIZE);
David Brownellddda0862007-04-17 17:53:20 -0700262 if (unlikely(retval < 0)) {
263 dev_err(&intf->dev, "RNDIS_MSG_QUERY(0x%08x) failed, %d\n",
264 oid, retval);
265 return retval;
266 }
267
268 off = le32_to_cpu(u.get_c->offset);
269 len = le32_to_cpu(u.get_c->len);
270 if (unlikely((8 + off + len) > CONTROL_BUFFER_SIZE))
271 goto response_error;
272
273 if (*reply_len != -1 && len != *reply_len)
274 goto response_error;
275
276 *reply = (unsigned char *) &u.get_c->request_id + off;
277 *reply_len = len;
278
279 return retval;
280
281response_error:
282 dev_err(&intf->dev, "RNDIS_MSG_QUERY(0x%08x) "
283 "invalid response - off %d len %d\n",
284 oid, off, len);
285 return -EDOM;
286}
287
Stephen Hemminger0f2166d2009-03-20 19:36:00 +0000288/* same as usbnet_netdev_ops but MTU change not allowed */
289static const struct net_device_ops rndis_netdev_ops = {
290 .ndo_open = usbnet_open,
291 .ndo_stop = usbnet_stop,
292 .ndo_start_xmit = usbnet_start_xmit,
293 .ndo_tx_timeout = usbnet_tx_timeout,
294 .ndo_set_mac_address = eth_mac_addr,
295 .ndo_validate_addr = eth_validate_addr,
296};
297
Jussi Kivilinna039ee172008-01-27 23:34:33 +0200298int
299generic_rndis_bind(struct usbnet *dev, struct usb_interface *intf, int flags)
David Brownell64e04912005-08-31 09:54:36 -0700300{
301 int retval;
302 struct net_device *net = dev->net;
Daniel Gollubdeb31f12007-01-16 11:03:01 +0100303 struct cdc_state *info = (void *) &dev->data;
David Brownell64e04912005-08-31 09:54:36 -0700304 union {
305 void *buf;
306 struct rndis_msg_hdr *header;
307 struct rndis_init *init;
308 struct rndis_init_c *init_c;
309 struct rndis_query *get;
310 struct rndis_query_c *get_c;
311 struct rndis_set *set;
312 struct rndis_set_c *set_c;
Jussi Kivilinna9ff55872008-01-26 00:50:55 +0200313 struct rndis_halt *halt;
David Brownell64e04912005-08-31 09:54:36 -0700314 } u;
Al Virod63ddce2008-05-21 01:34:30 +0100315 u32 tmp;
316 __le32 phym_unspec, *phym;
David Brownellddda0862007-04-17 17:53:20 -0700317 int reply_len;
318 unsigned char *bp;
David Brownell64e04912005-08-31 09:54:36 -0700319
320 /* we can't rely on i/o from stack working, or stack allocation */
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800321 u.buf = kmalloc(CONTROL_BUFFER_SIZE, GFP_KERNEL);
David Brownell64e04912005-08-31 09:54:36 -0700322 if (!u.buf)
323 return -ENOMEM;
324 retval = usbnet_generic_cdc_bind(dev, intf);
325 if (retval < 0)
Daniel Gollubdeb31f12007-01-16 11:03:01 +0100326 goto fail;
David Brownell64e04912005-08-31 09:54:36 -0700327
Linus Walleij7390e8b2012-05-11 22:15:39 +0000328 u.init->msg_type = cpu_to_le32(RNDIS_MSG_INIT);
Harvey Harrison35c26c22009-02-14 22:56:56 -0800329 u.init->msg_len = cpu_to_le32(sizeof *u.init);
330 u.init->major_version = cpu_to_le32(1);
331 u.init->minor_version = cpu_to_le32(0);
David Brownell64e04912005-08-31 09:54:36 -0700332
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800333 /* max transfer (in spec) is 0x4000 at full speed, but for
334 * TX we'll stick to one Ethernet packet plus RNDIS framing.
335 * For RX we handle drivers that zero-pad to end-of-packet.
336 * Don't let userspace change these settings.
David Brownellddda0862007-04-17 17:53:20 -0700337 *
338 * NOTE: there still seems to be wierdness here, as if we need
339 * to do some more things to make sure WinCE targets accept this.
340 * They default to jumbograms of 8KB or 16KB, which is absurd
341 * for such low data rates and which is also more than Linux
342 * can usually expect to allocate for SKB data...
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800343 */
344 net->hard_header_len += sizeof (struct rndis_data_hdr);
345 dev->hard_mtu = net->mtu + net->hard_header_len;
346
Jean-Christophe Dubois10d0f272008-03-13 14:56:36 -0800347 dev->maxpacket = usb_maxpacket(dev->udev, dev->out, 1);
348 if (dev->maxpacket == 0) {
Joe Perchesa475f602010-02-17 10:30:24 +0000349 netif_dbg(dev, probe, dev->net,
350 "dev->maxpacket can't be 0\n");
Jean-Christophe Dubois10d0f272008-03-13 14:56:36 -0800351 retval = -EINVAL;
352 goto fail_and_release;
353 }
354
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800355 dev->rx_urb_size = dev->hard_mtu + (dev->maxpacket + 1);
356 dev->rx_urb_size &= ~(dev->maxpacket - 1);
357 u.init->max_transfer_size = cpu_to_le32(dev->rx_urb_size);
358
Stephen Hemminger0f2166d2009-03-20 19:36:00 +0000359 net->netdev_ops = &rndis_netdev_ops;
360
Jussi Kivilinna818727b2008-06-18 15:40:12 +0300361 retval = rndis_command(dev, u.header, CONTROL_BUFFER_SIZE);
David Brownell64e04912005-08-31 09:54:36 -0700362 if (unlikely(retval < 0)) {
363 /* it might not even be an RNDIS device!! */
364 dev_err(&intf->dev, "RNDIS init failed, %d\n", retval);
David Brownellddda0862007-04-17 17:53:20 -0700365 goto fail_and_release;
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800366 }
367 tmp = le32_to_cpu(u.init_c->max_transfer_size);
368 if (tmp < dev->hard_mtu) {
Thomas Sailer500d2c22007-10-24 00:47:19 +0200369 if (tmp <= net->hard_header_len) {
370 dev_err(&intf->dev,
371 "dev can't take %u byte packets (max %u)\n",
372 dev->hard_mtu, tmp);
373 retval = -EINVAL;
Jussi Kivilinna9ff55872008-01-26 00:50:55 +0200374 goto halt_fail_and_release;
Thomas Sailer500d2c22007-10-24 00:47:19 +0200375 }
Thomas Sailer500d2c22007-10-24 00:47:19 +0200376 dev_warn(&intf->dev,
377 "dev can't take %u byte packets (max %u), "
378 "adjusting MTU to %u\n",
George Nassar40ac7b62009-10-14 18:27:41 -0500379 dev->hard_mtu, tmp, tmp - net->hard_header_len);
380 dev->hard_mtu = tmp;
381 net->mtu = dev->hard_mtu - net->hard_header_len;
David Brownell64e04912005-08-31 09:54:36 -0700382 }
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800383
David Brownell64e04912005-08-31 09:54:36 -0700384 /* REVISIT: peripheral "alignment" request is ignored ... */
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800385 dev_dbg(&intf->dev,
386 "hard mtu %u (%u from dev), rx buflen %Zu, align %d\n",
387 dev->hard_mtu, tmp, dev->rx_urb_size,
David Brownell64e04912005-08-31 09:54:36 -0700388 1 << le32_to_cpu(u.init_c->packet_alignment));
389
Jussi Kivilinna7c39e032008-01-26 00:51:28 +0200390 /* module has some device initialization code needs to be done right
391 * after RNDIS_INIT */
392 if (dev->driver_info->early_init &&
393 dev->driver_info->early_init(dev) != 0)
394 goto halt_fail_and_release;
395
Jussi Kivilinna039ee172008-01-27 23:34:33 +0200396 /* Check physical medium */
Jussi Kivilinna9f5e60d2008-03-23 12:45:44 +0200397 phym = NULL;
Jussi Kivilinna039ee172008-01-27 23:34:33 +0200398 reply_len = sizeof *phym;
Linus Walleij7390e8b2012-05-11 22:15:39 +0000399 retval = rndis_query(dev, intf, u.buf,
Jussi Kivilinna5432bdc2012-05-11 22:17:50 +0000400 RNDIS_OID_GEN_PHYSICAL_MEDIUM,
401 0, (void **) &phym, &reply_len);
Jussi Kivilinna9f5e60d2008-03-23 12:45:44 +0200402 if (retval != 0 || !phym) {
Jussi Kivilinna039ee172008-01-27 23:34:33 +0200403 /* OID is optional so don't fail here. */
Linus Walleij7390e8b2012-05-11 22:15:39 +0000404 phym_unspec = cpu_to_le32(RNDIS_PHYSICAL_MEDIUM_UNSPECIFIED);
Jussi Kivilinna9f5e60d2008-03-23 12:45:44 +0200405 phym = &phym_unspec;
406 }
Jussi Kivilinna039ee172008-01-27 23:34:33 +0200407 if ((flags & FLAG_RNDIS_PHYM_WIRELESS) &&
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000408 le32_to_cpup(phym) != RNDIS_PHYSICAL_MEDIUM_WIRELESS_LAN) {
Joe Perchesa475f602010-02-17 10:30:24 +0000409 netif_dbg(dev, probe, dev->net,
410 "driver requires wireless physical medium, but device is not\n");
Jussi Kivilinna039ee172008-01-27 23:34:33 +0200411 retval = -ENODEV;
412 goto halt_fail_and_release;
413 }
414 if ((flags & FLAG_RNDIS_PHYM_NOT_WIRELESS) &&
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000415 le32_to_cpup(phym) == RNDIS_PHYSICAL_MEDIUM_WIRELESS_LAN) {
Joe Perchesa475f602010-02-17 10:30:24 +0000416 netif_dbg(dev, probe, dev->net,
417 "driver requires non-wireless physical medium, but device is wireless.\n");
Jussi Kivilinna039ee172008-01-27 23:34:33 +0200418 retval = -ENODEV;
419 goto halt_fail_and_release;
420 }
421
David Brownellddda0862007-04-17 17:53:20 -0700422 /* Get designated host ethernet address */
423 reply_len = ETH_ALEN;
Linus Walleij7390e8b2012-05-11 22:15:39 +0000424 retval = rndis_query(dev, intf, u.buf,
Jussi Kivilinna5432bdc2012-05-11 22:17:50 +0000425 RNDIS_OID_802_3_PERMANENT_ADDRESS,
426 48, (void **) &bp, &reply_len);
David Brownellddda0862007-04-17 17:53:20 -0700427 if (unlikely(retval< 0)) {
David Brownell64e04912005-08-31 09:54:36 -0700428 dev_err(&intf->dev, "rndis get ethaddr, %d\n", retval);
Jussi Kivilinna9ff55872008-01-26 00:50:55 +0200429 goto halt_fail_and_release;
David Brownell64e04912005-08-31 09:54:36 -0700430 }
David Brownellddda0862007-04-17 17:53:20 -0700431 memcpy(net->dev_addr, bp, ETH_ALEN);
David Brownell64e04912005-08-31 09:54:36 -0700432
433 /* set a nonzero filter to enable data transfers */
434 memset(u.set, 0, sizeof *u.set);
Linus Walleij7390e8b2012-05-11 22:15:39 +0000435 u.set->msg_type = cpu_to_le32(RNDIS_MSG_SET);
Harvey Harrison35c26c22009-02-14 22:56:56 -0800436 u.set->msg_len = cpu_to_le32(4 + sizeof *u.set);
Linus Walleij8cdddc32012-05-11 22:16:08 +0000437 u.set->oid = cpu_to_le32(RNDIS_OID_GEN_CURRENT_PACKET_FILTER);
Harvey Harrison35c26c22009-02-14 22:56:56 -0800438 u.set->len = cpu_to_le32(4);
439 u.set->offset = cpu_to_le32((sizeof *u.set) - 8);
Linus Walleij7390e8b2012-05-11 22:15:39 +0000440 *(__le32 *)(u.buf + sizeof *u.set) = cpu_to_le32(RNDIS_DEFAULT_FILTER);
David Brownell64e04912005-08-31 09:54:36 -0700441
Jussi Kivilinna818727b2008-06-18 15:40:12 +0300442 retval = rndis_command(dev, u.header, CONTROL_BUFFER_SIZE);
David Brownell64e04912005-08-31 09:54:36 -0700443 if (unlikely(retval < 0)) {
444 dev_err(&intf->dev, "rndis set packet filter, %d\n", retval);
Jussi Kivilinna9ff55872008-01-26 00:50:55 +0200445 goto halt_fail_and_release;
David Brownell64e04912005-08-31 09:54:36 -0700446 }
447
448 retval = 0;
Daniel Gollubdeb31f12007-01-16 11:03:01 +0100449
450 kfree(u.buf);
451 return retval;
452
Jussi Kivilinna9ff55872008-01-26 00:50:55 +0200453halt_fail_and_release:
454 memset(u.halt, 0, sizeof *u.halt);
Linus Walleij7390e8b2012-05-11 22:15:39 +0000455 u.halt->msg_type = cpu_to_le32(RNDIS_MSG_HALT);
Harvey Harrison35c26c22009-02-14 22:56:56 -0800456 u.halt->msg_len = cpu_to_le32(sizeof *u.halt);
Jussi Kivilinna818727b2008-06-18 15:40:12 +0300457 (void) rndis_command(dev, (void *)u.halt, CONTROL_BUFFER_SIZE);
Daniel Gollubdeb31f12007-01-16 11:03:01 +0100458fail_and_release:
459 usb_set_intfdata(info->data, NULL);
460 usb_driver_release_interface(driver_of(intf), info->data);
David Brownellddda0862007-04-17 17:53:20 -0700461 info->data = NULL;
Daniel Gollubdeb31f12007-01-16 11:03:01 +0100462fail:
David Brownell64e04912005-08-31 09:54:36 -0700463 kfree(u.buf);
464 return retval;
465}
Jussi Kivilinna56659982008-01-26 00:51:17 +0200466EXPORT_SYMBOL_GPL(generic_rndis_bind);
David Brownell64e04912005-08-31 09:54:36 -0700467
Jussi Kivilinna039ee172008-01-27 23:34:33 +0200468static int rndis_bind(struct usbnet *dev, struct usb_interface *intf)
469{
470 return generic_rndis_bind(dev, intf, FLAG_RNDIS_PHYM_NOT_WIRELESS);
471}
472
Jussi Kivilinna56659982008-01-26 00:51:17 +0200473void rndis_unbind(struct usbnet *dev, struct usb_interface *intf)
David Brownell64e04912005-08-31 09:54:36 -0700474{
475 struct rndis_halt *halt;
476
477 /* try to clear any rndis state/activity (no i/o from stack!) */
Jussi Kivilinna04c3c012008-01-26 00:50:49 +0200478 halt = kzalloc(CONTROL_BUFFER_SIZE, GFP_KERNEL);
David Brownell64e04912005-08-31 09:54:36 -0700479 if (halt) {
Linus Walleij7390e8b2012-05-11 22:15:39 +0000480 halt->msg_type = cpu_to_le32(RNDIS_MSG_HALT);
Harvey Harrison35c26c22009-02-14 22:56:56 -0800481 halt->msg_len = cpu_to_le32(sizeof *halt);
Jussi Kivilinna818727b2008-06-18 15:40:12 +0300482 (void) rndis_command(dev, (void *)halt, CONTROL_BUFFER_SIZE);
David Brownell64e04912005-08-31 09:54:36 -0700483 kfree(halt);
484 }
485
Bjorge Dijkstra2bfa2e12008-01-26 00:50:38 +0200486 usbnet_cdc_unbind(dev, intf);
David Brownell64e04912005-08-31 09:54:36 -0700487}
Jussi Kivilinna56659982008-01-26 00:51:17 +0200488EXPORT_SYMBOL_GPL(rndis_unbind);
David Brownell64e04912005-08-31 09:54:36 -0700489
490/*
491 * DATA -- host must not write zlps
492 */
Jussi Kivilinna56659982008-01-26 00:51:17 +0200493int rndis_rx_fixup(struct usbnet *dev, struct sk_buff *skb)
David Brownell64e04912005-08-31 09:54:36 -0700494{
495 /* peripheral may have batched packets to us... */
496 while (likely(skb->len)) {
497 struct rndis_data_hdr *hdr = (void *)skb->data;
498 struct sk_buff *skb2;
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000499 u32 msg_type, msg_len, data_offset, data_len;
David Brownell64e04912005-08-31 09:54:36 -0700500
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000501 msg_type = le32_to_cpu(hdr->msg_type);
David Brownell64e04912005-08-31 09:54:36 -0700502 msg_len = le32_to_cpu(hdr->msg_len);
503 data_offset = le32_to_cpu(hdr->data_offset);
504 data_len = le32_to_cpu(hdr->data_len);
505
506 /* don't choke if we see oob, per-packet data, etc */
Jussi Kivilinna3eef3662012-05-11 22:17:34 +0000507 if (unlikely(msg_type != RNDIS_MSG_PACKET || skb->len < msg_len
508 || (data_offset + data_len + 8) > msg_len)) {
Herbert Xu58e2e7d2009-06-29 16:52:26 +0000509 dev->net->stats.rx_frame_errors++;
Joe Perches60b86752010-02-17 10:30:23 +0000510 netdev_dbg(dev->net, "bad rndis message %d/%d/%d/%d, len %d\n",
511 le32_to_cpu(hdr->msg_type),
512 msg_len, data_offset, data_len, skb->len);
David Brownell64e04912005-08-31 09:54:36 -0700513 return 0;
514 }
515 skb_pull(skb, 8 + data_offset);
516
517 /* at most one packet left? */
518 if (likely((data_len - skb->len) <= sizeof *hdr)) {
519 skb_trim(skb, data_len);
520 break;
521 }
522
523 /* try to return all the packets in the batch */
524 skb2 = skb_clone(skb, GFP_ATOMIC);
525 if (unlikely(!skb2))
526 break;
527 skb_pull(skb, msg_len - sizeof *hdr);
528 skb_trim(skb2, data_len);
529 usbnet_skb_return(dev, skb2);
530 }
531
532 /* caller will usbnet_skb_return the remaining packet */
533 return 1;
534}
Jussi Kivilinna56659982008-01-26 00:51:17 +0200535EXPORT_SYMBOL_GPL(rndis_rx_fixup);
David Brownell64e04912005-08-31 09:54:36 -0700536
Jussi Kivilinna56659982008-01-26 00:51:17 +0200537struct sk_buff *
Al Viro55016f12005-10-21 03:21:58 -0400538rndis_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
David Brownell64e04912005-08-31 09:54:36 -0700539{
540 struct rndis_data_hdr *hdr;
541 struct sk_buff *skb2;
542 unsigned len = skb->len;
543
544 if (likely(!skb_cloned(skb))) {
545 int room = skb_headroom(skb);
546
547 /* enough head room as-is? */
548 if (unlikely((sizeof *hdr) <= room))
549 goto fill;
550
551 /* enough room, but needs to be readjusted? */
552 room += skb_tailroom(skb);
553 if (likely((sizeof *hdr) <= room)) {
554 skb->data = memmove(skb->head + sizeof *hdr,
555 skb->data, len);
Arnaldo Carvalho de Melo27a884d2007-04-19 20:29:13 -0700556 skb_set_tail_pointer(skb, len);
David Brownell64e04912005-08-31 09:54:36 -0700557 goto fill;
558 }
559 }
560
561 /* create a new skb, with the correct size (and tailpad) */
562 skb2 = skb_copy_expand(skb, sizeof *hdr, 1, flags);
563 dev_kfree_skb_any(skb);
564 if (unlikely(!skb2))
565 return skb2;
566 skb = skb2;
567
568 /* fill out the RNDIS header. we won't bother trying to batch
569 * packets; Linux minimizes wasted bandwidth through tx queues.
570 */
571fill:
572 hdr = (void *) __skb_push(skb, sizeof *hdr);
573 memset(hdr, 0, sizeof *hdr);
Linus Walleij7390e8b2012-05-11 22:15:39 +0000574 hdr->msg_type = cpu_to_le32(RNDIS_MSG_PACKET);
David Brownell64e04912005-08-31 09:54:36 -0700575 hdr->msg_len = cpu_to_le32(skb->len);
Harvey Harrison35c26c22009-02-14 22:56:56 -0800576 hdr->data_offset = cpu_to_le32(sizeof(*hdr) - 8);
David Brownell64e04912005-08-31 09:54:36 -0700577 hdr->data_len = cpu_to_le32(len);
578
579 /* FIXME make the last packet always be short ... */
580 return skb;
581}
Jussi Kivilinna56659982008-01-26 00:51:17 +0200582EXPORT_SYMBOL_GPL(rndis_tx_fixup);
David Brownell64e04912005-08-31 09:54:36 -0700583
584
585static const struct driver_info rndis_info = {
586 .description = "RNDIS device",
Arnd Bergmannc2613442011-04-01 20:12:02 -0700587 .flags = FLAG_ETHER | FLAG_POINTTOPOINT | FLAG_FRAMING_RN | FLAG_NO_SETINT,
Jussi Kivilinna039ee172008-01-27 23:34:33 +0200588 .bind = rndis_bind,
David Brownell64e04912005-08-31 09:54:36 -0700589 .unbind = rndis_unbind,
590 .status = rndis_status,
591 .rx_fixup = rndis_rx_fixup,
592 .tx_fixup = rndis_tx_fixup,
593};
594
Ben Hutchings4d42d412011-04-13 14:48:55 -0700595static const struct driver_info rndis_poll_status_info = {
596 .description = "RNDIS device (poll status before control)",
Ben Hutchingseb8aa722011-04-14 23:23:45 -0700597 .flags = FLAG_ETHER | FLAG_POINTTOPOINT | FLAG_FRAMING_RN | FLAG_NO_SETINT,
Ben Hutchings4d42d412011-04-13 14:48:55 -0700598 .data = RNDIS_DRIVER_DATA_POLL_STATUS,
599 .bind = rndis_bind,
600 .unbind = rndis_unbind,
601 .status = rndis_status,
602 .rx_fixup = rndis_rx_fixup,
603 .tx_fixup = rndis_tx_fixup,
604};
605
David Brownell64e04912005-08-31 09:54:36 -0700606/*-------------------------------------------------------------------------*/
607
608static const struct usb_device_id products [] = {
609{
Ben Hutchings4d42d412011-04-13 14:48:55 -0700610 /* 2Wire HomePortal 1000SW */
611 USB_DEVICE_AND_INTERFACE_INFO(0x1630, 0x0042,
612 USB_CLASS_COMM, 2 /* ACM */, 0x0ff),
613 .driver_info = (unsigned long) &rndis_poll_status_info,
614}, {
David Brownell64e04912005-08-31 09:54:36 -0700615 /* RNDIS is MSFT's un-official variant of CDC ACM */
616 USB_INTERFACE_INFO(USB_CLASS_COMM, 2 /* ACM */, 0x0ff),
617 .driver_info = (unsigned long) &rndis_info,
Ole Andre Vadla Ravnasad55d712006-12-14 16:01:28 -0800618}, {
619 /* "ActiveSync" is an undocumented variant of RNDIS, used in WM5 */
620 USB_INTERFACE_INFO(USB_CLASS_MISC, 1, 1),
Ben Hutchings4d42d412011-04-13 14:48:55 -0700621 .driver_info = (unsigned long) &rndis_poll_status_info,
Thomas Backlund7e99eed2008-07-22 13:55:58 -0700622}, {
623 /* RNDIS for tethering */
624 USB_INTERFACE_INFO(USB_CLASS_WIRELESS_CONTROLLER, 1, 3),
625 .driver_info = (unsigned long) &rndis_info,
David Brownell64e04912005-08-31 09:54:36 -0700626},
627 { }, // END
628};
629MODULE_DEVICE_TABLE(usb, products);
630
631static struct usb_driver rndis_driver = {
David Brownell64e04912005-08-31 09:54:36 -0700632 .name = "rndis_host",
633 .id_table = products,
634 .probe = usbnet_probe,
635 .disconnect = usbnet_disconnect,
636 .suspend = usbnet_suspend,
637 .resume = usbnet_resume,
Sarah Sharpe1f12eb2012-04-23 10:08:51 -0700638 .disable_hub_initiated_lpm = 1,
David Brownell64e04912005-08-31 09:54:36 -0700639};
640
Greg Kroah-Hartmand632eb12011-11-18 09:44:20 -0800641module_usb_driver(rndis_driver);
David Brownell64e04912005-08-31 09:54:36 -0700642
643MODULE_AUTHOR("David Brownell");
644MODULE_DESCRIPTION("USB Host side RNDIS driver");
645MODULE_LICENSE("GPL");