David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 1 | /* |
| 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 |
| 16 | * along with this program; if not, write to the Free Software |
| 17 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| 18 | */ |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 19 | #include <linux/module.h> |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 20 | #include <linux/init.h> |
| 21 | #include <linux/netdevice.h> |
| 22 | #include <linux/etherdevice.h> |
| 23 | #include <linux/ethtool.h> |
| 24 | #include <linux/workqueue.h> |
| 25 | #include <linux/mii.h> |
| 26 | #include <linux/usb.h> |
David Brownell | a8c28f2 | 2006-06-13 09:57:47 -0700 | [diff] [blame] | 27 | #include <linux/usb/cdc.h> |
Jussi Kivilinna | 3692e94 | 2008-01-26 00:51:45 +0200 | [diff] [blame] | 28 | #include <linux/usb/usbnet.h> |
| 29 | #include <linux/usb/rndis_host.h> |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 30 | |
| 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 Brownell | 51400f1 | 2006-04-02 10:19:08 -0800 | [diff] [blame] | 36 | * |
| 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 Ravnas | ad55d71 | 2006-12-14 16:01:28 -0800 | [diff] [blame] | 47 | * Moreover there's a no-open-specs variant of RNDIS called "ActiveSync". |
| 48 | * |
David Brownell | 51400f1 | 2006-04-02 10:19:08 -0800 | [diff] [blame] | 49 | * 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 Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 52 | */ |
| 53 | |
| 54 | /* |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 55 | * RNDIS notifications from device: command completion; "reverse" |
| 56 | * keepalives; etc |
| 57 | */ |
Jussi Kivilinna | 5665998 | 2008-01-26 00:51:17 +0200 | [diff] [blame] | 58 | void rndis_status(struct usbnet *dev, struct urb *urb) |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 59 | { |
| 60 | devdbg(dev, "rndis status urb, len %d stat %d", |
| 61 | urb->actual_length, urb->status); |
| 62 | // FIXME for keepalives, respond immediately (asynchronously) |
| 63 | // if not an RNDIS status, do like cdc_status(dev,urb) does |
| 64 | } |
Jussi Kivilinna | 5665998 | 2008-01-26 00:51:17 +0200 | [diff] [blame] | 65 | EXPORT_SYMBOL_GPL(rndis_status); |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 66 | |
| 67 | /* |
| 68 | * RPC done RNDIS-style. Caller guarantees: |
| 69 | * - message is properly byteswapped |
| 70 | * - there's no other request pending |
| 71 | * - buf can hold up to 1KB response (required by RNDIS spec) |
| 72 | * On return, the first few entries are already byteswapped. |
| 73 | * |
| 74 | * Call context is likely probe(), before interface name is known, |
| 75 | * which is why we won't try to use it in the diagnostics. |
| 76 | */ |
Jussi Kivilinna | 5665998 | 2008-01-26 00:51:17 +0200 | [diff] [blame] | 77 | int rndis_command(struct usbnet *dev, struct rndis_msg_hdr *buf) |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 78 | { |
| 79 | struct cdc_state *info = (void *) &dev->data; |
Ole Andre Vadla Ravnas | ad55d71 | 2006-12-14 16:01:28 -0800 | [diff] [blame] | 80 | int master_ifnum; |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 81 | int retval; |
| 82 | unsigned count; |
| 83 | __le32 rsp; |
| 84 | u32 xid = 0, msg_len, request_id; |
| 85 | |
| 86 | /* REVISIT when this gets called from contexts other than probe() or |
| 87 | * disconnect(): either serialize, or dispatch responses on xid |
| 88 | */ |
| 89 | |
Ole Andre Vadla Ravnas | ad55d71 | 2006-12-14 16:01:28 -0800 | [diff] [blame] | 90 | /* Issue the request; xid is unique, don't bother byteswapping it */ |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 91 | if (likely(buf->msg_type != RNDIS_MSG_HALT |
| 92 | && buf->msg_type != RNDIS_MSG_RESET)) { |
| 93 | xid = dev->xid++; |
| 94 | if (!xid) |
| 95 | xid = dev->xid++; |
| 96 | buf->request_id = (__force __le32) xid; |
| 97 | } |
Ole Andre Vadla Ravnas | ad55d71 | 2006-12-14 16:01:28 -0800 | [diff] [blame] | 98 | master_ifnum = info->control->cur_altsetting->desc.bInterfaceNumber; |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 99 | retval = usb_control_msg(dev->udev, |
| 100 | usb_sndctrlpipe(dev->udev, 0), |
| 101 | USB_CDC_SEND_ENCAPSULATED_COMMAND, |
| 102 | USB_TYPE_CLASS | USB_RECIP_INTERFACE, |
Ole Andre Vadla Ravnas | ad55d71 | 2006-12-14 16:01:28 -0800 | [diff] [blame] | 103 | 0, master_ifnum, |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 104 | buf, le32_to_cpu(buf->msg_len), |
| 105 | RNDIS_CONTROL_TIMEOUT_MS); |
| 106 | if (unlikely(retval < 0 || xid == 0)) |
| 107 | return retval; |
| 108 | |
| 109 | // FIXME Seems like some devices discard responses when |
| 110 | // we time out and cancel our "get response" requests... |
| 111 | // so, this is fragile. Probably need to poll for status. |
| 112 | |
| 113 | /* ignore status endpoint, just poll the control channel; |
| 114 | * the request probably completed immediately |
| 115 | */ |
| 116 | rsp = buf->msg_type | RNDIS_MSG_COMPLETION; |
| 117 | for (count = 0; count < 10; count++) { |
Ole Andre Vadla Ravnas | ad55d71 | 2006-12-14 16:01:28 -0800 | [diff] [blame] | 118 | memset(buf, 0, CONTROL_BUFFER_SIZE); |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 119 | retval = usb_control_msg(dev->udev, |
| 120 | usb_rcvctrlpipe(dev->udev, 0), |
| 121 | USB_CDC_GET_ENCAPSULATED_RESPONSE, |
| 122 | USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE, |
Ole Andre Vadla Ravnas | ad55d71 | 2006-12-14 16:01:28 -0800 | [diff] [blame] | 123 | 0, master_ifnum, |
| 124 | buf, CONTROL_BUFFER_SIZE, |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 125 | RNDIS_CONTROL_TIMEOUT_MS); |
| 126 | if (likely(retval >= 8)) { |
| 127 | msg_len = le32_to_cpu(buf->msg_len); |
| 128 | request_id = (__force u32) buf->request_id; |
| 129 | if (likely(buf->msg_type == rsp)) { |
| 130 | if (likely(request_id == xid)) { |
| 131 | if (unlikely(rsp == RNDIS_MSG_RESET_C)) |
| 132 | return 0; |
| 133 | if (likely(RNDIS_STATUS_SUCCESS |
| 134 | == buf->status)) |
| 135 | return 0; |
| 136 | dev_dbg(&info->control->dev, |
| 137 | "rndis reply status %08x\n", |
| 138 | le32_to_cpu(buf->status)); |
| 139 | return -EL3RST; |
| 140 | } |
| 141 | dev_dbg(&info->control->dev, |
| 142 | "rndis reply id %d expected %d\n", |
| 143 | request_id, xid); |
| 144 | /* then likely retry */ |
| 145 | } else switch (buf->msg_type) { |
Jussi Kivilinna | 5d6ecf6 | 2008-01-26 00:51:34 +0200 | [diff] [blame] | 146 | case RNDIS_MSG_INDICATE: { /* fault/event */ |
| 147 | struct rndis_indicate *msg = (void *)buf; |
| 148 | int state = 0; |
| 149 | |
| 150 | switch (msg->status) { |
| 151 | case RNDIS_STATUS_MEDIA_CONNECT: |
| 152 | state = 1; |
| 153 | case RNDIS_STATUS_MEDIA_DISCONNECT: |
| 154 | dev_info(&info->control->dev, |
| 155 | "rndis media %sconnect\n", |
| 156 | !state?"dis":""); |
| 157 | if (dev->driver_info->link_change) |
| 158 | dev->driver_info->link_change( |
| 159 | dev, state); |
| 160 | break; |
| 161 | default: |
| 162 | dev_info(&info->control->dev, |
| 163 | "rndis indication: 0x%08x\n", |
| 164 | le32_to_cpu(msg->status)); |
| 165 | } |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 166 | } |
| 167 | break; |
| 168 | case RNDIS_MSG_KEEPALIVE: { /* ping */ |
| 169 | struct rndis_keepalive_c *msg = (void *)buf; |
| 170 | |
| 171 | msg->msg_type = RNDIS_MSG_KEEPALIVE_C; |
| 172 | msg->msg_len = ccpu2(sizeof *msg); |
| 173 | msg->status = RNDIS_STATUS_SUCCESS; |
| 174 | retval = usb_control_msg(dev->udev, |
| 175 | usb_sndctrlpipe(dev->udev, 0), |
| 176 | USB_CDC_SEND_ENCAPSULATED_COMMAND, |
| 177 | USB_TYPE_CLASS | USB_RECIP_INTERFACE, |
Ole Andre Vadla Ravnas | ad55d71 | 2006-12-14 16:01:28 -0800 | [diff] [blame] | 178 | 0, master_ifnum, |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 179 | msg, sizeof *msg, |
| 180 | RNDIS_CONTROL_TIMEOUT_MS); |
| 181 | if (unlikely(retval < 0)) |
| 182 | dev_dbg(&info->control->dev, |
| 183 | "rndis keepalive err %d\n", |
| 184 | retval); |
| 185 | } |
| 186 | break; |
| 187 | default: |
| 188 | dev_dbg(&info->control->dev, |
| 189 | "unexpected rndis msg %08x len %d\n", |
| 190 | le32_to_cpu(buf->msg_type), msg_len); |
| 191 | } |
| 192 | } else { |
| 193 | /* device probably issued a protocol stall; ignore */ |
| 194 | dev_dbg(&info->control->dev, |
| 195 | "rndis response error, code %d\n", retval); |
| 196 | } |
| 197 | msleep(2); |
| 198 | } |
| 199 | dev_dbg(&info->control->dev, "rndis response timeout\n"); |
| 200 | return -ETIMEDOUT; |
| 201 | } |
Jussi Kivilinna | 5665998 | 2008-01-26 00:51:17 +0200 | [diff] [blame] | 202 | EXPORT_SYMBOL_GPL(rndis_command); |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 203 | |
David Brownell | ddda086 | 2007-04-17 17:53:20 -0700 | [diff] [blame] | 204 | /* |
| 205 | * rndis_query: |
| 206 | * |
| 207 | * Performs a query for @oid along with 0 or more bytes of payload as |
| 208 | * specified by @in_len. If @reply_len is not set to -1 then the reply |
| 209 | * length is checked against this value, resulting in an error if it |
| 210 | * doesn't match. |
| 211 | * |
| 212 | * NOTE: Adding a payload exactly or greater than the size of the expected |
| 213 | * response payload is an evident requirement MSFT added for ActiveSync. |
| 214 | * |
| 215 | * The only exception is for OIDs that return a variably sized response, |
| 216 | * in which case no payload should be added. This undocumented (and |
| 217 | * nonsensical!) issue was found by sniffing protocol requests from the |
| 218 | * ActiveSync 4.1 Windows driver. |
| 219 | */ |
| 220 | static int rndis_query(struct usbnet *dev, struct usb_interface *intf, |
| 221 | void *buf, u32 oid, u32 in_len, |
| 222 | void **reply, int *reply_len) |
| 223 | { |
| 224 | int retval; |
| 225 | union { |
| 226 | void *buf; |
| 227 | struct rndis_msg_hdr *header; |
| 228 | struct rndis_query *get; |
| 229 | struct rndis_query_c *get_c; |
| 230 | } u; |
| 231 | u32 off, len; |
| 232 | |
| 233 | u.buf = buf; |
| 234 | |
| 235 | memset(u.get, 0, sizeof *u.get + in_len); |
| 236 | u.get->msg_type = RNDIS_MSG_QUERY; |
| 237 | u.get->msg_len = cpu_to_le32(sizeof *u.get + in_len); |
| 238 | u.get->oid = oid; |
| 239 | u.get->len = cpu_to_le32(in_len); |
| 240 | u.get->offset = ccpu2(20); |
| 241 | |
| 242 | retval = rndis_command(dev, u.header); |
| 243 | if (unlikely(retval < 0)) { |
| 244 | dev_err(&intf->dev, "RNDIS_MSG_QUERY(0x%08x) failed, %d\n", |
| 245 | oid, retval); |
| 246 | return retval; |
| 247 | } |
| 248 | |
| 249 | off = le32_to_cpu(u.get_c->offset); |
| 250 | len = le32_to_cpu(u.get_c->len); |
| 251 | if (unlikely((8 + off + len) > CONTROL_BUFFER_SIZE)) |
| 252 | goto response_error; |
| 253 | |
| 254 | if (*reply_len != -1 && len != *reply_len) |
| 255 | goto response_error; |
| 256 | |
| 257 | *reply = (unsigned char *) &u.get_c->request_id + off; |
| 258 | *reply_len = len; |
| 259 | |
| 260 | return retval; |
| 261 | |
| 262 | response_error: |
| 263 | dev_err(&intf->dev, "RNDIS_MSG_QUERY(0x%08x) " |
| 264 | "invalid response - off %d len %d\n", |
| 265 | oid, off, len); |
| 266 | return -EDOM; |
| 267 | } |
| 268 | |
Jussi Kivilinna | 039ee17 | 2008-01-27 23:34:33 +0200 | [diff] [blame] | 269 | int |
| 270 | generic_rndis_bind(struct usbnet *dev, struct usb_interface *intf, int flags) |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 271 | { |
| 272 | int retval; |
| 273 | struct net_device *net = dev->net; |
Daniel Gollub | deb31f1 | 2007-01-16 11:03:01 +0100 | [diff] [blame] | 274 | struct cdc_state *info = (void *) &dev->data; |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 275 | union { |
| 276 | void *buf; |
| 277 | struct rndis_msg_hdr *header; |
| 278 | struct rndis_init *init; |
| 279 | struct rndis_init_c *init_c; |
| 280 | struct rndis_query *get; |
| 281 | struct rndis_query_c *get_c; |
| 282 | struct rndis_set *set; |
| 283 | struct rndis_set_c *set_c; |
Jussi Kivilinna | 9ff5587 | 2008-01-26 00:50:55 +0200 | [diff] [blame] | 284 | struct rndis_halt *halt; |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 285 | } u; |
Jussi Kivilinna | 039ee17 | 2008-01-27 23:34:33 +0200 | [diff] [blame] | 286 | u32 tmp, *phym; |
David Brownell | ddda086 | 2007-04-17 17:53:20 -0700 | [diff] [blame] | 287 | int reply_len; |
| 288 | unsigned char *bp; |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 289 | |
| 290 | /* we can't rely on i/o from stack working, or stack allocation */ |
Ole Andre Vadla Ravnas | ad55d71 | 2006-12-14 16:01:28 -0800 | [diff] [blame] | 291 | u.buf = kmalloc(CONTROL_BUFFER_SIZE, GFP_KERNEL); |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 292 | if (!u.buf) |
| 293 | return -ENOMEM; |
| 294 | retval = usbnet_generic_cdc_bind(dev, intf); |
| 295 | if (retval < 0) |
Daniel Gollub | deb31f1 | 2007-01-16 11:03:01 +0100 | [diff] [blame] | 296 | goto fail; |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 297 | |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 298 | u.init->msg_type = RNDIS_MSG_INIT; |
| 299 | u.init->msg_len = ccpu2(sizeof *u.init); |
| 300 | u.init->major_version = ccpu2(1); |
| 301 | u.init->minor_version = ccpu2(0); |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 302 | |
Ole Andre Vadla Ravnas | ad55d71 | 2006-12-14 16:01:28 -0800 | [diff] [blame] | 303 | /* max transfer (in spec) is 0x4000 at full speed, but for |
| 304 | * TX we'll stick to one Ethernet packet plus RNDIS framing. |
| 305 | * For RX we handle drivers that zero-pad to end-of-packet. |
| 306 | * Don't let userspace change these settings. |
David Brownell | ddda086 | 2007-04-17 17:53:20 -0700 | [diff] [blame] | 307 | * |
| 308 | * NOTE: there still seems to be wierdness here, as if we need |
| 309 | * to do some more things to make sure WinCE targets accept this. |
| 310 | * They default to jumbograms of 8KB or 16KB, which is absurd |
| 311 | * for such low data rates and which is also more than Linux |
| 312 | * can usually expect to allocate for SKB data... |
Ole Andre Vadla Ravnas | ad55d71 | 2006-12-14 16:01:28 -0800 | [diff] [blame] | 313 | */ |
| 314 | net->hard_header_len += sizeof (struct rndis_data_hdr); |
| 315 | dev->hard_mtu = net->mtu + net->hard_header_len; |
| 316 | |
Jean-Christophe Dubois | 10d0f27 | 2008-03-13 14:56:36 -0800 | [diff] [blame] | 317 | dev->maxpacket = usb_maxpacket(dev->udev, dev->out, 1); |
| 318 | if (dev->maxpacket == 0) { |
| 319 | if (netif_msg_probe(dev)) |
| 320 | dev_dbg(&intf->dev, "dev->maxpacket can't be 0\n"); |
| 321 | retval = -EINVAL; |
| 322 | goto fail_and_release; |
| 323 | } |
| 324 | |
Ole Andre Vadla Ravnas | ad55d71 | 2006-12-14 16:01:28 -0800 | [diff] [blame] | 325 | dev->rx_urb_size = dev->hard_mtu + (dev->maxpacket + 1); |
| 326 | dev->rx_urb_size &= ~(dev->maxpacket - 1); |
| 327 | u.init->max_transfer_size = cpu_to_le32(dev->rx_urb_size); |
| 328 | |
| 329 | net->change_mtu = NULL; |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 330 | retval = rndis_command(dev, u.header); |
| 331 | if (unlikely(retval < 0)) { |
| 332 | /* it might not even be an RNDIS device!! */ |
| 333 | dev_err(&intf->dev, "RNDIS init failed, %d\n", retval); |
David Brownell | ddda086 | 2007-04-17 17:53:20 -0700 | [diff] [blame] | 334 | goto fail_and_release; |
Ole Andre Vadla Ravnas | ad55d71 | 2006-12-14 16:01:28 -0800 | [diff] [blame] | 335 | } |
| 336 | tmp = le32_to_cpu(u.init_c->max_transfer_size); |
| 337 | if (tmp < dev->hard_mtu) { |
Thomas Sailer | 500d2c2 | 2007-10-24 00:47:19 +0200 | [diff] [blame] | 338 | if (tmp <= net->hard_header_len) { |
| 339 | dev_err(&intf->dev, |
| 340 | "dev can't take %u byte packets (max %u)\n", |
| 341 | dev->hard_mtu, tmp); |
| 342 | retval = -EINVAL; |
Jussi Kivilinna | 9ff5587 | 2008-01-26 00:50:55 +0200 | [diff] [blame] | 343 | goto halt_fail_and_release; |
Thomas Sailer | 500d2c2 | 2007-10-24 00:47:19 +0200 | [diff] [blame] | 344 | } |
| 345 | dev->hard_mtu = tmp; |
| 346 | net->mtu = dev->hard_mtu - net->hard_header_len; |
| 347 | dev_warn(&intf->dev, |
| 348 | "dev can't take %u byte packets (max %u), " |
| 349 | "adjusting MTU to %u\n", |
| 350 | dev->hard_mtu, tmp, net->mtu); |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 351 | } |
Ole Andre Vadla Ravnas | ad55d71 | 2006-12-14 16:01:28 -0800 | [diff] [blame] | 352 | |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 353 | /* REVISIT: peripheral "alignment" request is ignored ... */ |
Ole Andre Vadla Ravnas | ad55d71 | 2006-12-14 16:01:28 -0800 | [diff] [blame] | 354 | dev_dbg(&intf->dev, |
| 355 | "hard mtu %u (%u from dev), rx buflen %Zu, align %d\n", |
| 356 | dev->hard_mtu, tmp, dev->rx_urb_size, |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 357 | 1 << le32_to_cpu(u.init_c->packet_alignment)); |
| 358 | |
Jussi Kivilinna | 7c39e03 | 2008-01-26 00:51:28 +0200 | [diff] [blame] | 359 | /* module has some device initialization code needs to be done right |
| 360 | * after RNDIS_INIT */ |
| 361 | if (dev->driver_info->early_init && |
| 362 | dev->driver_info->early_init(dev) != 0) |
| 363 | goto halt_fail_and_release; |
| 364 | |
Jussi Kivilinna | 039ee17 | 2008-01-27 23:34:33 +0200 | [diff] [blame] | 365 | /* Check physical medium */ |
| 366 | reply_len = sizeof *phym; |
| 367 | retval = rndis_query(dev, intf, u.buf, OID_GEN_PHYSICAL_MEDIUM, |
| 368 | 0, (void **) &phym, &reply_len); |
| 369 | if (retval != 0) |
| 370 | /* OID is optional so don't fail here. */ |
| 371 | *phym = RNDIS_PHYSICAL_MEDIUM_UNSPECIFIED; |
| 372 | if ((flags & FLAG_RNDIS_PHYM_WIRELESS) && |
| 373 | *phym != RNDIS_PHYSICAL_MEDIUM_WIRELESS_LAN) { |
| 374 | if (netif_msg_probe(dev)) |
| 375 | dev_dbg(&intf->dev, "driver requires wireless " |
| 376 | "physical medium, but device is not.\n"); |
| 377 | retval = -ENODEV; |
| 378 | goto halt_fail_and_release; |
| 379 | } |
| 380 | if ((flags & FLAG_RNDIS_PHYM_NOT_WIRELESS) && |
| 381 | *phym == RNDIS_PHYSICAL_MEDIUM_WIRELESS_LAN) { |
| 382 | if (netif_msg_probe(dev)) |
| 383 | dev_dbg(&intf->dev, "driver requires non-wireless " |
| 384 | "physical medium, but device is wireless.\n"); |
| 385 | retval = -ENODEV; |
| 386 | goto halt_fail_and_release; |
| 387 | } |
| 388 | |
David Brownell | ddda086 | 2007-04-17 17:53:20 -0700 | [diff] [blame] | 389 | /* Get designated host ethernet address */ |
| 390 | reply_len = ETH_ALEN; |
| 391 | retval = rndis_query(dev, intf, u.buf, OID_802_3_PERMANENT_ADDRESS, |
| 392 | 48, (void **) &bp, &reply_len); |
| 393 | if (unlikely(retval< 0)) { |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 394 | dev_err(&intf->dev, "rndis get ethaddr, %d\n", retval); |
Jussi Kivilinna | 9ff5587 | 2008-01-26 00:50:55 +0200 | [diff] [blame] | 395 | goto halt_fail_and_release; |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 396 | } |
David Brownell | ddda086 | 2007-04-17 17:53:20 -0700 | [diff] [blame] | 397 | memcpy(net->dev_addr, bp, ETH_ALEN); |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 398 | |
| 399 | /* set a nonzero filter to enable data transfers */ |
| 400 | memset(u.set, 0, sizeof *u.set); |
| 401 | u.set->msg_type = RNDIS_MSG_SET; |
| 402 | u.set->msg_len = ccpu2(4 + sizeof *u.set); |
| 403 | u.set->oid = OID_GEN_CURRENT_PACKET_FILTER; |
| 404 | u.set->len = ccpu2(4); |
| 405 | u.set->offset = ccpu2((sizeof *u.set) - 8); |
Jussi Kivilinna | a842eda | 2008-01-26 00:51:01 +0200 | [diff] [blame] | 406 | *(__le32 *)(u.buf + sizeof *u.set) = RNDIS_DEFAULT_FILTER; |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 407 | |
| 408 | retval = rndis_command(dev, u.header); |
| 409 | if (unlikely(retval < 0)) { |
| 410 | dev_err(&intf->dev, "rndis set packet filter, %d\n", retval); |
Jussi Kivilinna | 9ff5587 | 2008-01-26 00:50:55 +0200 | [diff] [blame] | 411 | goto halt_fail_and_release; |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 412 | } |
| 413 | |
| 414 | retval = 0; |
Daniel Gollub | deb31f1 | 2007-01-16 11:03:01 +0100 | [diff] [blame] | 415 | |
| 416 | kfree(u.buf); |
| 417 | return retval; |
| 418 | |
Jussi Kivilinna | 9ff5587 | 2008-01-26 00:50:55 +0200 | [diff] [blame] | 419 | halt_fail_and_release: |
| 420 | memset(u.halt, 0, sizeof *u.halt); |
| 421 | u.halt->msg_type = RNDIS_MSG_HALT; |
| 422 | u.halt->msg_len = ccpu2(sizeof *u.halt); |
| 423 | (void) rndis_command(dev, (void *)u.halt); |
Daniel Gollub | deb31f1 | 2007-01-16 11:03:01 +0100 | [diff] [blame] | 424 | fail_and_release: |
| 425 | usb_set_intfdata(info->data, NULL); |
| 426 | usb_driver_release_interface(driver_of(intf), info->data); |
David Brownell | ddda086 | 2007-04-17 17:53:20 -0700 | [diff] [blame] | 427 | info->data = NULL; |
Daniel Gollub | deb31f1 | 2007-01-16 11:03:01 +0100 | [diff] [blame] | 428 | fail: |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 429 | kfree(u.buf); |
| 430 | return retval; |
| 431 | } |
Jussi Kivilinna | 5665998 | 2008-01-26 00:51:17 +0200 | [diff] [blame] | 432 | EXPORT_SYMBOL_GPL(generic_rndis_bind); |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 433 | |
Jussi Kivilinna | 039ee17 | 2008-01-27 23:34:33 +0200 | [diff] [blame] | 434 | static int rndis_bind(struct usbnet *dev, struct usb_interface *intf) |
| 435 | { |
| 436 | return generic_rndis_bind(dev, intf, FLAG_RNDIS_PHYM_NOT_WIRELESS); |
| 437 | } |
| 438 | |
Jussi Kivilinna | 5665998 | 2008-01-26 00:51:17 +0200 | [diff] [blame] | 439 | void rndis_unbind(struct usbnet *dev, struct usb_interface *intf) |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 440 | { |
| 441 | struct rndis_halt *halt; |
| 442 | |
| 443 | /* try to clear any rndis state/activity (no i/o from stack!) */ |
Jussi Kivilinna | 04c3c01 | 2008-01-26 00:50:49 +0200 | [diff] [blame] | 444 | halt = kzalloc(CONTROL_BUFFER_SIZE, GFP_KERNEL); |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 445 | if (halt) { |
| 446 | halt->msg_type = RNDIS_MSG_HALT; |
| 447 | halt->msg_len = ccpu2(sizeof *halt); |
| 448 | (void) rndis_command(dev, (void *)halt); |
| 449 | kfree(halt); |
| 450 | } |
| 451 | |
Bjorge Dijkstra | 2bfa2e1 | 2008-01-26 00:50:38 +0200 | [diff] [blame] | 452 | usbnet_cdc_unbind(dev, intf); |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 453 | } |
Jussi Kivilinna | 5665998 | 2008-01-26 00:51:17 +0200 | [diff] [blame] | 454 | EXPORT_SYMBOL_GPL(rndis_unbind); |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 455 | |
| 456 | /* |
| 457 | * DATA -- host must not write zlps |
| 458 | */ |
Jussi Kivilinna | 5665998 | 2008-01-26 00:51:17 +0200 | [diff] [blame] | 459 | int rndis_rx_fixup(struct usbnet *dev, struct sk_buff *skb) |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 460 | { |
| 461 | /* peripheral may have batched packets to us... */ |
| 462 | while (likely(skb->len)) { |
| 463 | struct rndis_data_hdr *hdr = (void *)skb->data; |
| 464 | struct sk_buff *skb2; |
| 465 | u32 msg_len, data_offset, data_len; |
| 466 | |
| 467 | msg_len = le32_to_cpu(hdr->msg_len); |
| 468 | data_offset = le32_to_cpu(hdr->data_offset); |
| 469 | data_len = le32_to_cpu(hdr->data_len); |
| 470 | |
| 471 | /* don't choke if we see oob, per-packet data, etc */ |
| 472 | if (unlikely(hdr->msg_type != RNDIS_MSG_PACKET |
| 473 | || skb->len < msg_len |
| 474 | || (data_offset + data_len + 8) > msg_len)) { |
| 475 | dev->stats.rx_frame_errors++; |
| 476 | devdbg(dev, "bad rndis message %d/%d/%d/%d, len %d", |
| 477 | le32_to_cpu(hdr->msg_type), |
| 478 | msg_len, data_offset, data_len, skb->len); |
| 479 | return 0; |
| 480 | } |
| 481 | skb_pull(skb, 8 + data_offset); |
| 482 | |
| 483 | /* at most one packet left? */ |
| 484 | if (likely((data_len - skb->len) <= sizeof *hdr)) { |
| 485 | skb_trim(skb, data_len); |
| 486 | break; |
| 487 | } |
| 488 | |
| 489 | /* try to return all the packets in the batch */ |
| 490 | skb2 = skb_clone(skb, GFP_ATOMIC); |
| 491 | if (unlikely(!skb2)) |
| 492 | break; |
| 493 | skb_pull(skb, msg_len - sizeof *hdr); |
| 494 | skb_trim(skb2, data_len); |
| 495 | usbnet_skb_return(dev, skb2); |
| 496 | } |
| 497 | |
| 498 | /* caller will usbnet_skb_return the remaining packet */ |
| 499 | return 1; |
| 500 | } |
Jussi Kivilinna | 5665998 | 2008-01-26 00:51:17 +0200 | [diff] [blame] | 501 | EXPORT_SYMBOL_GPL(rndis_rx_fixup); |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 502 | |
Jussi Kivilinna | 5665998 | 2008-01-26 00:51:17 +0200 | [diff] [blame] | 503 | struct sk_buff * |
Al Viro | 55016f1 | 2005-10-21 03:21:58 -0400 | [diff] [blame] | 504 | rndis_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags) |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 505 | { |
| 506 | struct rndis_data_hdr *hdr; |
| 507 | struct sk_buff *skb2; |
| 508 | unsigned len = skb->len; |
| 509 | |
| 510 | if (likely(!skb_cloned(skb))) { |
| 511 | int room = skb_headroom(skb); |
| 512 | |
| 513 | /* enough head room as-is? */ |
| 514 | if (unlikely((sizeof *hdr) <= room)) |
| 515 | goto fill; |
| 516 | |
| 517 | /* enough room, but needs to be readjusted? */ |
| 518 | room += skb_tailroom(skb); |
| 519 | if (likely((sizeof *hdr) <= room)) { |
| 520 | skb->data = memmove(skb->head + sizeof *hdr, |
| 521 | skb->data, len); |
Arnaldo Carvalho de Melo | 27a884d | 2007-04-19 20:29:13 -0700 | [diff] [blame] | 522 | skb_set_tail_pointer(skb, len); |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 523 | goto fill; |
| 524 | } |
| 525 | } |
| 526 | |
| 527 | /* create a new skb, with the correct size (and tailpad) */ |
| 528 | skb2 = skb_copy_expand(skb, sizeof *hdr, 1, flags); |
| 529 | dev_kfree_skb_any(skb); |
| 530 | if (unlikely(!skb2)) |
| 531 | return skb2; |
| 532 | skb = skb2; |
| 533 | |
| 534 | /* fill out the RNDIS header. we won't bother trying to batch |
| 535 | * packets; Linux minimizes wasted bandwidth through tx queues. |
| 536 | */ |
| 537 | fill: |
| 538 | hdr = (void *) __skb_push(skb, sizeof *hdr); |
| 539 | memset(hdr, 0, sizeof *hdr); |
| 540 | hdr->msg_type = RNDIS_MSG_PACKET; |
| 541 | hdr->msg_len = cpu_to_le32(skb->len); |
| 542 | hdr->data_offset = ccpu2(sizeof(*hdr) - 8); |
| 543 | hdr->data_len = cpu_to_le32(len); |
| 544 | |
| 545 | /* FIXME make the last packet always be short ... */ |
| 546 | return skb; |
| 547 | } |
Jussi Kivilinna | 5665998 | 2008-01-26 00:51:17 +0200 | [diff] [blame] | 548 | EXPORT_SYMBOL_GPL(rndis_tx_fixup); |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 549 | |
| 550 | |
| 551 | static const struct driver_info rndis_info = { |
| 552 | .description = "RNDIS device", |
David Brownell | ddda086 | 2007-04-17 17:53:20 -0700 | [diff] [blame] | 553 | .flags = FLAG_ETHER | FLAG_FRAMING_RN | FLAG_NO_SETINT, |
Jussi Kivilinna | 039ee17 | 2008-01-27 23:34:33 +0200 | [diff] [blame] | 554 | .bind = rndis_bind, |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 555 | .unbind = rndis_unbind, |
| 556 | .status = rndis_status, |
| 557 | .rx_fixup = rndis_rx_fixup, |
| 558 | .tx_fixup = rndis_tx_fixup, |
| 559 | }; |
| 560 | |
| 561 | #undef ccpu2 |
| 562 | |
| 563 | |
| 564 | /*-------------------------------------------------------------------------*/ |
| 565 | |
| 566 | static const struct usb_device_id products [] = { |
| 567 | { |
| 568 | /* RNDIS is MSFT's un-official variant of CDC ACM */ |
| 569 | USB_INTERFACE_INFO(USB_CLASS_COMM, 2 /* ACM */, 0x0ff), |
| 570 | .driver_info = (unsigned long) &rndis_info, |
Ole Andre Vadla Ravnas | ad55d71 | 2006-12-14 16:01:28 -0800 | [diff] [blame] | 571 | }, { |
| 572 | /* "ActiveSync" is an undocumented variant of RNDIS, used in WM5 */ |
| 573 | USB_INTERFACE_INFO(USB_CLASS_MISC, 1, 1), |
| 574 | .driver_info = (unsigned long) &rndis_info, |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 575 | }, |
| 576 | { }, // END |
| 577 | }; |
| 578 | MODULE_DEVICE_TABLE(usb, products); |
| 579 | |
| 580 | static struct usb_driver rndis_driver = { |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 581 | .name = "rndis_host", |
| 582 | .id_table = products, |
| 583 | .probe = usbnet_probe, |
| 584 | .disconnect = usbnet_disconnect, |
| 585 | .suspend = usbnet_suspend, |
| 586 | .resume = usbnet_resume, |
| 587 | }; |
| 588 | |
| 589 | static int __init rndis_init(void) |
| 590 | { |
David Brownell | 51400f1 | 2006-04-02 10:19:08 -0800 | [diff] [blame] | 591 | return usb_register(&rndis_driver); |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 592 | } |
| 593 | module_init(rndis_init); |
| 594 | |
| 595 | static void __exit rndis_exit(void) |
| 596 | { |
David Brownell | 51400f1 | 2006-04-02 10:19:08 -0800 | [diff] [blame] | 597 | usb_deregister(&rndis_driver); |
David Brownell | 64e0491 | 2005-08-31 09:54:36 -0700 | [diff] [blame] | 598 | } |
| 599 | module_exit(rndis_exit); |
| 600 | |
| 601 | MODULE_AUTHOR("David Brownell"); |
| 602 | MODULE_DESCRIPTION("USB Host side RNDIS driver"); |
| 603 | MODULE_LICENSE("GPL"); |