]>
Commit | Line | Data |
---|---|---|
45fe3b8e DB |
1 | /* |
2 | * f_rndis.c -- RNDIS link function driver | |
3 | * | |
4 | * Copyright (C) 2003-2005,2008 David Brownell | |
5 | * Copyright (C) 2003-2004 Robert Schwebel, Benedikt Spranger | |
6 | * Copyright (C) 2008 Nokia Corporation | |
b97503ff MN |
7 | * Copyright (C) 2009 Samsung Electronics |
8 | * Author: Michal Nazarewicz (m.nazarewicz@samsung.com) | |
45fe3b8e DB |
9 | * |
10 | * This program is free software; you can redistribute it and/or modify | |
11 | * it under the terms of the GNU General Public License as published by | |
12 | * the Free Software Foundation; either version 2 of the License, or | |
13 | * (at your option) any later version. | |
14 | * | |
15 | * This program is distributed in the hope that it will be useful, | |
16 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 | * GNU General Public License for more details. | |
19 | * | |
20 | * You should have received a copy of the GNU General Public License | |
21 | * along with this program; if not, write to the Free Software | |
22 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
23 | */ | |
24 | ||
25 | /* #define VERBOSE_DEBUG */ | |
26 | ||
5a0e3ad6 | 27 | #include <linux/slab.h> |
45fe3b8e DB |
28 | #include <linux/kernel.h> |
29 | #include <linux/device.h> | |
30 | #include <linux/etherdevice.h> | |
31 | ||
32 | #include <asm/atomic.h> | |
33 | ||
34 | #include "u_ether.h" | |
35 | #include "rndis.h" | |
36 | ||
37 | ||
38 | /* | |
39 | * This function is an RNDIS Ethernet port -- a Microsoft protocol that's | |
40 | * been promoted instead of the standard CDC Ethernet. The published RNDIS | |
41 | * spec is ambiguous, incomplete, and needlessly complex. Variants such as | |
42 | * ActiveSync have even worse status in terms of specification. | |
43 | * | |
44 | * In short: it's a protocol controlled by (and for) Microsoft, not for an | |
45 | * Open ecosystem or markets. Linux supports it *only* because Microsoft | |
46 | * doesn't support the CDC Ethernet standard. | |
47 | * | |
48 | * The RNDIS data transfer model is complex, with multiple Ethernet packets | |
49 | * per USB message, and out of band data. The control model is built around | |
50 | * what's essentially an "RNDIS RPC" protocol. It's all wrapped in a CDC ACM | |
51 | * (modem, not Ethernet) veneer, with those ACM descriptors being entirely | |
52 | * useless (they're ignored). RNDIS expects to be the only function in its | |
53 | * configuration, so it's no real help if you need composite devices; and | |
54 | * it expects to be the first configuration too. | |
55 | * | |
56 | * There is a single technical advantage of RNDIS over CDC Ethernet, if you | |
57 | * discount the fluff that its RPC can be made to deliver: it doesn't need | |
58 | * a NOP altsetting for the data interface. That lets it work on some of the | |
59 | * "so smart it's stupid" hardware which takes over configuration changes | |
60 | * from the software, and adds restrictions like "no altsettings". | |
61 | * | |
62 | * Unfortunately MSFT's RNDIS drivers are buggy. They hang or oops, and | |
63 | * have all sorts of contrary-to-specification oddities that can prevent | |
64 | * them from working sanely. Since bugfixes (or accurate specs, letting | |
65 | * Linux work around those bugs) are unlikely to ever come from MSFT, you | |
66 | * may want to avoid using RNDIS on purely operational grounds. | |
67 | * | |
68 | * Omissions from the RNDIS 1.0 specification include: | |
69 | * | |
70 | * - Power management ... references data that's scattered around lots | |
71 | * of other documentation, which is incorrect/incomplete there too. | |
72 | * | |
73 | * - There are various undocumented protocol requirements, like the need | |
74 | * to send garbage in some control-OUT messages. | |
75 | * | |
76 | * - MS-Windows drivers sometimes emit undocumented requests. | |
77 | */ | |
78 | ||
79 | struct rndis_ep_descs { | |
80 | struct usb_endpoint_descriptor *in; | |
81 | struct usb_endpoint_descriptor *out; | |
82 | struct usb_endpoint_descriptor *notify; | |
83 | }; | |
84 | ||
85 | struct f_rndis { | |
86 | struct gether port; | |
87 | u8 ctrl_id, data_id; | |
88 | u8 ethaddr[ETH_ALEN]; | |
89 | int config; | |
90 | ||
45fe3b8e | 91 | struct rndis_ep_descs fs; |
45fe3b8e DB |
92 | struct rndis_ep_descs hs; |
93 | ||
94 | struct usb_ep *notify; | |
95 | struct usb_endpoint_descriptor *notify_desc; | |
96 | struct usb_request *notify_req; | |
97 | atomic_t notify_count; | |
98 | }; | |
99 | ||
100 | static inline struct f_rndis *func_to_rndis(struct usb_function *f) | |
101 | { | |
102 | return container_of(f, struct f_rndis, port.func); | |
103 | } | |
104 | ||
105 | /* peak (theoretical) bulk transfer rate in bits-per-second */ | |
106 | static unsigned int bitrate(struct usb_gadget *g) | |
107 | { | |
108 | if (gadget_is_dualspeed(g) && g->speed == USB_SPEED_HIGH) | |
109 | return 13 * 512 * 8 * 1000 * 8; | |
110 | else | |
111 | return 19 * 64 * 1 * 1000 * 8; | |
112 | } | |
113 | ||
114 | /*-------------------------------------------------------------------------*/ | |
115 | ||
116 | /* | |
117 | */ | |
118 | ||
119 | #define LOG2_STATUS_INTERVAL_MSEC 5 /* 1 << 5 == 32 msec */ | |
120 | #define STATUS_BYTECOUNT 8 /* 8 bytes data */ | |
121 | ||
122 | ||
123 | /* interface descriptor: */ | |
124 | ||
125 | static struct usb_interface_descriptor rndis_control_intf __initdata = { | |
126 | .bLength = sizeof rndis_control_intf, | |
127 | .bDescriptorType = USB_DT_INTERFACE, | |
128 | ||
129 | /* .bInterfaceNumber = DYNAMIC */ | |
130 | /* status endpoint is optional; this could be patched later */ | |
131 | .bNumEndpoints = 1, | |
132 | .bInterfaceClass = USB_CLASS_COMM, | |
133 | .bInterfaceSubClass = USB_CDC_SUBCLASS_ACM, | |
134 | .bInterfaceProtocol = USB_CDC_ACM_PROTO_VENDOR, | |
135 | /* .iInterface = DYNAMIC */ | |
136 | }; | |
137 | ||
138 | static struct usb_cdc_header_desc header_desc __initdata = { | |
139 | .bLength = sizeof header_desc, | |
140 | .bDescriptorType = USB_DT_CS_INTERFACE, | |
141 | .bDescriptorSubType = USB_CDC_HEADER_TYPE, | |
142 | ||
551509d2 | 143 | .bcdCDC = cpu_to_le16(0x0110), |
45fe3b8e DB |
144 | }; |
145 | ||
146 | static struct usb_cdc_call_mgmt_descriptor call_mgmt_descriptor __initdata = { | |
147 | .bLength = sizeof call_mgmt_descriptor, | |
148 | .bDescriptorType = USB_DT_CS_INTERFACE, | |
149 | .bDescriptorSubType = USB_CDC_CALL_MANAGEMENT_TYPE, | |
150 | ||
151 | .bmCapabilities = 0x00, | |
152 | .bDataInterface = 0x01, | |
153 | }; | |
154 | ||
b97503ff MN |
155 | static struct usb_cdc_acm_descriptor rndis_acm_descriptor __initdata = { |
156 | .bLength = sizeof rndis_acm_descriptor, | |
45fe3b8e DB |
157 | .bDescriptorType = USB_DT_CS_INTERFACE, |
158 | .bDescriptorSubType = USB_CDC_ACM_TYPE, | |
159 | ||
160 | .bmCapabilities = 0x00, | |
161 | }; | |
162 | ||
163 | static struct usb_cdc_union_desc rndis_union_desc __initdata = { | |
164 | .bLength = sizeof(rndis_union_desc), | |
165 | .bDescriptorType = USB_DT_CS_INTERFACE, | |
166 | .bDescriptorSubType = USB_CDC_UNION_TYPE, | |
167 | /* .bMasterInterface0 = DYNAMIC */ | |
168 | /* .bSlaveInterface0 = DYNAMIC */ | |
169 | }; | |
170 | ||
171 | /* the data interface has two bulk endpoints */ | |
172 | ||
173 | static struct usb_interface_descriptor rndis_data_intf __initdata = { | |
174 | .bLength = sizeof rndis_data_intf, | |
175 | .bDescriptorType = USB_DT_INTERFACE, | |
176 | ||
177 | /* .bInterfaceNumber = DYNAMIC */ | |
45fe3b8e DB |
178 | .bNumEndpoints = 2, |
179 | .bInterfaceClass = USB_CLASS_CDC_DATA, | |
180 | .bInterfaceSubClass = 0, | |
181 | .bInterfaceProtocol = 0, | |
182 | /* .iInterface = DYNAMIC */ | |
183 | }; | |
184 | ||
b97503ff MN |
185 | |
186 | static struct usb_interface_assoc_descriptor | |
187 | rndis_iad_descriptor = { | |
188 | .bLength = sizeof rndis_iad_descriptor, | |
189 | .bDescriptorType = USB_DT_INTERFACE_ASSOCIATION, | |
190 | ||
191 | .bFirstInterface = 0, /* XXX, hardcoded */ | |
192 | .bInterfaceCount = 2, // control + data | |
193 | .bFunctionClass = USB_CLASS_COMM, | |
194 | .bFunctionSubClass = USB_CDC_SUBCLASS_ETHERNET, | |
195 | .bFunctionProtocol = USB_CDC_PROTO_NONE, | |
196 | /* .iFunction = DYNAMIC */ | |
197 | }; | |
198 | ||
45fe3b8e DB |
199 | /* full speed support: */ |
200 | ||
201 | static struct usb_endpoint_descriptor fs_notify_desc __initdata = { | |
202 | .bLength = USB_DT_ENDPOINT_SIZE, | |
203 | .bDescriptorType = USB_DT_ENDPOINT, | |
204 | ||
205 | .bEndpointAddress = USB_DIR_IN, | |
206 | .bmAttributes = USB_ENDPOINT_XFER_INT, | |
551509d2 | 207 | .wMaxPacketSize = cpu_to_le16(STATUS_BYTECOUNT), |
45fe3b8e DB |
208 | .bInterval = 1 << LOG2_STATUS_INTERVAL_MSEC, |
209 | }; | |
210 | ||
211 | static struct usb_endpoint_descriptor fs_in_desc __initdata = { | |
212 | .bLength = USB_DT_ENDPOINT_SIZE, | |
213 | .bDescriptorType = USB_DT_ENDPOINT, | |
214 | ||
215 | .bEndpointAddress = USB_DIR_IN, | |
216 | .bmAttributes = USB_ENDPOINT_XFER_BULK, | |
217 | }; | |
218 | ||
219 | static struct usb_endpoint_descriptor fs_out_desc __initdata = { | |
220 | .bLength = USB_DT_ENDPOINT_SIZE, | |
221 | .bDescriptorType = USB_DT_ENDPOINT, | |
222 | ||
223 | .bEndpointAddress = USB_DIR_OUT, | |
224 | .bmAttributes = USB_ENDPOINT_XFER_BULK, | |
225 | }; | |
226 | ||
227 | static struct usb_descriptor_header *eth_fs_function[] __initdata = { | |
b97503ff | 228 | (struct usb_descriptor_header *) &rndis_iad_descriptor, |
45fe3b8e DB |
229 | /* control interface matches ACM, not Ethernet */ |
230 | (struct usb_descriptor_header *) &rndis_control_intf, | |
231 | (struct usb_descriptor_header *) &header_desc, | |
232 | (struct usb_descriptor_header *) &call_mgmt_descriptor, | |
b97503ff | 233 | (struct usb_descriptor_header *) &rndis_acm_descriptor, |
45fe3b8e DB |
234 | (struct usb_descriptor_header *) &rndis_union_desc, |
235 | (struct usb_descriptor_header *) &fs_notify_desc, | |
236 | /* data interface has no altsetting */ | |
237 | (struct usb_descriptor_header *) &rndis_data_intf, | |
238 | (struct usb_descriptor_header *) &fs_in_desc, | |
239 | (struct usb_descriptor_header *) &fs_out_desc, | |
240 | NULL, | |
241 | }; | |
242 | ||
243 | /* high speed support: */ | |
244 | ||
245 | static struct usb_endpoint_descriptor hs_notify_desc __initdata = { | |
246 | .bLength = USB_DT_ENDPOINT_SIZE, | |
247 | .bDescriptorType = USB_DT_ENDPOINT, | |
248 | ||
249 | .bEndpointAddress = USB_DIR_IN, | |
250 | .bmAttributes = USB_ENDPOINT_XFER_INT, | |
551509d2 | 251 | .wMaxPacketSize = cpu_to_le16(STATUS_BYTECOUNT), |
45fe3b8e DB |
252 | .bInterval = LOG2_STATUS_INTERVAL_MSEC + 4, |
253 | }; | |
254 | static struct usb_endpoint_descriptor hs_in_desc __initdata = { | |
255 | .bLength = USB_DT_ENDPOINT_SIZE, | |
256 | .bDescriptorType = USB_DT_ENDPOINT, | |
257 | ||
258 | .bEndpointAddress = USB_DIR_IN, | |
259 | .bmAttributes = USB_ENDPOINT_XFER_BULK, | |
551509d2 | 260 | .wMaxPacketSize = cpu_to_le16(512), |
45fe3b8e DB |
261 | }; |
262 | ||
263 | static struct usb_endpoint_descriptor hs_out_desc __initdata = { | |
264 | .bLength = USB_DT_ENDPOINT_SIZE, | |
265 | .bDescriptorType = USB_DT_ENDPOINT, | |
266 | ||
267 | .bEndpointAddress = USB_DIR_OUT, | |
268 | .bmAttributes = USB_ENDPOINT_XFER_BULK, | |
551509d2 | 269 | .wMaxPacketSize = cpu_to_le16(512), |
45fe3b8e DB |
270 | }; |
271 | ||
272 | static struct usb_descriptor_header *eth_hs_function[] __initdata = { | |
b97503ff | 273 | (struct usb_descriptor_header *) &rndis_iad_descriptor, |
45fe3b8e DB |
274 | /* control interface matches ACM, not Ethernet */ |
275 | (struct usb_descriptor_header *) &rndis_control_intf, | |
276 | (struct usb_descriptor_header *) &header_desc, | |
277 | (struct usb_descriptor_header *) &call_mgmt_descriptor, | |
b97503ff | 278 | (struct usb_descriptor_header *) &rndis_acm_descriptor, |
45fe3b8e DB |
279 | (struct usb_descriptor_header *) &rndis_union_desc, |
280 | (struct usb_descriptor_header *) &hs_notify_desc, | |
281 | /* data interface has no altsetting */ | |
282 | (struct usb_descriptor_header *) &rndis_data_intf, | |
283 | (struct usb_descriptor_header *) &hs_in_desc, | |
284 | (struct usb_descriptor_header *) &hs_out_desc, | |
285 | NULL, | |
286 | }; | |
287 | ||
288 | /* string descriptors: */ | |
289 | ||
290 | static struct usb_string rndis_string_defs[] = { | |
291 | [0].s = "RNDIS Communications Control", | |
292 | [1].s = "RNDIS Ethernet Data", | |
b97503ff | 293 | [2].s = "RNDIS", |
45fe3b8e DB |
294 | { } /* end of list */ |
295 | }; | |
296 | ||
297 | static struct usb_gadget_strings rndis_string_table = { | |
298 | .language = 0x0409, /* en-us */ | |
299 | .strings = rndis_string_defs, | |
300 | }; | |
301 | ||
302 | static struct usb_gadget_strings *rndis_strings[] = { | |
303 | &rndis_string_table, | |
304 | NULL, | |
305 | }; | |
306 | ||
307 | /*-------------------------------------------------------------------------*/ | |
308 | ||
9b39e9dd BN |
309 | static struct sk_buff *rndis_add_header(struct gether *port, |
310 | struct sk_buff *skb) | |
45fe3b8e | 311 | { |
9b39e9dd BN |
312 | struct sk_buff *skb2; |
313 | ||
314 | skb2 = skb_realloc_headroom(skb, sizeof(struct rndis_packet_msg_type)); | |
315 | if (skb2) | |
316 | rndis_add_hdr(skb2); | |
317 | ||
318 | dev_kfree_skb_any(skb); | |
319 | return skb2; | |
45fe3b8e DB |
320 | } |
321 | ||
322 | static void rndis_response_available(void *_rndis) | |
323 | { | |
324 | struct f_rndis *rndis = _rndis; | |
325 | struct usb_request *req = rndis->notify_req; | |
326 | struct usb_composite_dev *cdev = rndis->port.func.config->cdev; | |
327 | __le32 *data = req->buf; | |
328 | int status; | |
329 | ||
ff349505 | 330 | if (atomic_inc_return(&rndis->notify_count) != 1) |
45fe3b8e DB |
331 | return; |
332 | ||
333 | /* Send RNDIS RESPONSE_AVAILABLE notification; a | |
334 | * USB_CDC_NOTIFY_RESPONSE_AVAILABLE "should" work too | |
335 | * | |
336 | * This is the only notification defined by RNDIS. | |
337 | */ | |
338 | data[0] = cpu_to_le32(1); | |
339 | data[1] = cpu_to_le32(0); | |
340 | ||
341 | status = usb_ep_queue(rndis->notify, req, GFP_ATOMIC); | |
342 | if (status) { | |
343 | atomic_dec(&rndis->notify_count); | |
344 | DBG(cdev, "notify/0 --> %d\n", status); | |
345 | } | |
346 | } | |
347 | ||
348 | static void rndis_response_complete(struct usb_ep *ep, struct usb_request *req) | |
349 | { | |
350 | struct f_rndis *rndis = req->context; | |
351 | struct usb_composite_dev *cdev = rndis->port.func.config->cdev; | |
352 | int status = req->status; | |
353 | ||
354 | /* after TX: | |
355 | * - USB_CDC_GET_ENCAPSULATED_RESPONSE (ep0/control) | |
356 | * - RNDIS_RESPONSE_AVAILABLE (status/irq) | |
357 | */ | |
358 | switch (status) { | |
359 | case -ECONNRESET: | |
360 | case -ESHUTDOWN: | |
361 | /* connection gone */ | |
362 | atomic_set(&rndis->notify_count, 0); | |
363 | break; | |
364 | default: | |
365 | DBG(cdev, "RNDIS %s response error %d, %d/%d\n", | |
366 | ep->name, status, | |
367 | req->actual, req->length); | |
368 | /* FALLTHROUGH */ | |
369 | case 0: | |
370 | if (ep != rndis->notify) | |
371 | break; | |
372 | ||
373 | /* handle multiple pending RNDIS_RESPONSE_AVAILABLE | |
374 | * notifications by resending until we're done | |
375 | */ | |
376 | if (atomic_dec_and_test(&rndis->notify_count)) | |
377 | break; | |
378 | status = usb_ep_queue(rndis->notify, req, GFP_ATOMIC); | |
379 | if (status) { | |
380 | atomic_dec(&rndis->notify_count); | |
381 | DBG(cdev, "notify/1 --> %d\n", status); | |
382 | } | |
383 | break; | |
384 | } | |
385 | } | |
386 | ||
387 | static void rndis_command_complete(struct usb_ep *ep, struct usb_request *req) | |
388 | { | |
389 | struct f_rndis *rndis = req->context; | |
390 | struct usb_composite_dev *cdev = rndis->port.func.config->cdev; | |
391 | int status; | |
392 | ||
393 | /* received RNDIS command from USB_CDC_SEND_ENCAPSULATED_COMMAND */ | |
394 | // spin_lock(&dev->lock); | |
395 | status = rndis_msg_parser(rndis->config, (u8 *) req->buf); | |
396 | if (status < 0) | |
397 | ERROR(cdev, "RNDIS command error %d, %d/%d\n", | |
398 | status, req->actual, req->length); | |
399 | // spin_unlock(&dev->lock); | |
400 | } | |
401 | ||
402 | static int | |
403 | rndis_setup(struct usb_function *f, const struct usb_ctrlrequest *ctrl) | |
404 | { | |
405 | struct f_rndis *rndis = func_to_rndis(f); | |
406 | struct usb_composite_dev *cdev = f->config->cdev; | |
407 | struct usb_request *req = cdev->req; | |
408 | int value = -EOPNOTSUPP; | |
409 | u16 w_index = le16_to_cpu(ctrl->wIndex); | |
410 | u16 w_value = le16_to_cpu(ctrl->wValue); | |
411 | u16 w_length = le16_to_cpu(ctrl->wLength); | |
412 | ||
413 | /* composite driver infrastructure handles everything except | |
414 | * CDC class messages; interface activation uses set_alt(). | |
415 | */ | |
416 | switch ((ctrl->bRequestType << 8) | ctrl->bRequest) { | |
417 | ||
418 | /* RNDIS uses the CDC command encapsulation mechanism to implement | |
419 | * an RPC scheme, with much getting/setting of attributes by OID. | |
420 | */ | |
421 | case ((USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE) << 8) | |
422 | | USB_CDC_SEND_ENCAPSULATED_COMMAND: | |
423 | if (w_length > req->length || w_value | |
424 | || w_index != rndis->ctrl_id) | |
425 | goto invalid; | |
426 | /* read the request; process it later */ | |
427 | value = w_length; | |
428 | req->complete = rndis_command_complete; | |
429 | req->context = rndis; | |
430 | /* later, rndis_response_available() sends a notification */ | |
431 | break; | |
432 | ||
433 | case ((USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE) << 8) | |
434 | | USB_CDC_GET_ENCAPSULATED_RESPONSE: | |
435 | if (w_value || w_index != rndis->ctrl_id) | |
436 | goto invalid; | |
437 | else { | |
438 | u8 *buf; | |
439 | u32 n; | |
440 | ||
441 | /* return the result */ | |
442 | buf = rndis_get_next_response(rndis->config, &n); | |
443 | if (buf) { | |
444 | memcpy(req->buf, buf, n); | |
445 | req->complete = rndis_response_complete; | |
446 | rndis_free_response(rndis->config, buf); | |
447 | value = n; | |
448 | } | |
449 | /* else stalls ... spec says to avoid that */ | |
450 | } | |
451 | break; | |
452 | ||
453 | default: | |
454 | invalid: | |
455 | VDBG(cdev, "invalid control req%02x.%02x v%04x i%04x l%d\n", | |
456 | ctrl->bRequestType, ctrl->bRequest, | |
457 | w_value, w_index, w_length); | |
458 | } | |
459 | ||
460 | /* respond with data transfer or status phase? */ | |
461 | if (value >= 0) { | |
462 | DBG(cdev, "rndis req%02x.%02x v%04x i%04x l%d\n", | |
463 | ctrl->bRequestType, ctrl->bRequest, | |
464 | w_value, w_index, w_length); | |
090b9011 | 465 | req->zero = (value < w_length); |
45fe3b8e DB |
466 | req->length = value; |
467 | value = usb_ep_queue(cdev->gadget->ep0, req, GFP_ATOMIC); | |
468 | if (value < 0) | |
469 | ERROR(cdev, "rndis response on err %d\n", value); | |
470 | } | |
471 | ||
472 | /* device either stalls (value < 0) or reports success */ | |
473 | return value; | |
474 | } | |
475 | ||
476 | ||
477 | static int rndis_set_alt(struct usb_function *f, unsigned intf, unsigned alt) | |
478 | { | |
479 | struct f_rndis *rndis = func_to_rndis(f); | |
480 | struct usb_composite_dev *cdev = f->config->cdev; | |
481 | ||
482 | /* we know alt == 0 */ | |
483 | ||
484 | if (intf == rndis->ctrl_id) { | |
485 | if (rndis->notify->driver_data) { | |
486 | VDBG(cdev, "reset rndis control %d\n", intf); | |
487 | usb_ep_disable(rndis->notify); | |
488 | } else { | |
489 | VDBG(cdev, "init rndis ctrl %d\n", intf); | |
490 | rndis->notify_desc = ep_choose(cdev->gadget, | |
491 | rndis->hs.notify, | |
492 | rndis->fs.notify); | |
493 | } | |
494 | usb_ep_enable(rndis->notify, rndis->notify_desc); | |
495 | rndis->notify->driver_data = rndis; | |
496 | ||
497 | } else if (intf == rndis->data_id) { | |
498 | struct net_device *net; | |
499 | ||
500 | if (rndis->port.in_ep->driver_data) { | |
501 | DBG(cdev, "reset rndis\n"); | |
502 | gether_disconnect(&rndis->port); | |
830d1b18 MM |
503 | } |
504 | ||
505 | if (!rndis->port.in) { | |
45fe3b8e DB |
506 | DBG(cdev, "init rndis\n"); |
507 | rndis->port.in = ep_choose(cdev->gadget, | |
508 | rndis->hs.in, rndis->fs.in); | |
509 | rndis->port.out = ep_choose(cdev->gadget, | |
510 | rndis->hs.out, rndis->fs.out); | |
511 | } | |
512 | ||
513 | /* Avoid ZLPs; they can be troublesome. */ | |
514 | rndis->port.is_zlp_ok = false; | |
515 | ||
516 | /* RNDIS should be in the "RNDIS uninitialized" state, | |
517 | * either never activated or after rndis_uninit(). | |
518 | * | |
519 | * We don't want data to flow here until a nonzero packet | |
520 | * filter is set, at which point it enters "RNDIS data | |
521 | * initialized" state ... but we do want the endpoints | |
522 | * to be activated. It's a strange little state. | |
523 | * | |
524 | * REVISIT the RNDIS gadget code has done this wrong for a | |
525 | * very long time. We need another call to the link layer | |
526 | * code -- gether_updown(...bool) maybe -- to do it right. | |
527 | */ | |
528 | rndis->port.cdc_filter = 0; | |
529 | ||
530 | DBG(cdev, "RNDIS RX/TX early activation ... \n"); | |
531 | net = gether_connect(&rndis->port); | |
532 | if (IS_ERR(net)) | |
533 | return PTR_ERR(net); | |
534 | ||
535 | rndis_set_param_dev(rndis->config, net, | |
536 | &rndis->port.cdc_filter); | |
537 | } else | |
538 | goto fail; | |
539 | ||
540 | return 0; | |
541 | fail: | |
542 | return -EINVAL; | |
543 | } | |
544 | ||
545 | static void rndis_disable(struct usb_function *f) | |
546 | { | |
547 | struct f_rndis *rndis = func_to_rndis(f); | |
548 | struct usb_composite_dev *cdev = f->config->cdev; | |
549 | ||
550 | if (!rndis->notify->driver_data) | |
551 | return; | |
552 | ||
553 | DBG(cdev, "rndis deactivated\n"); | |
554 | ||
555 | rndis_uninit(rndis->config); | |
556 | gether_disconnect(&rndis->port); | |
557 | ||
558 | usb_ep_disable(rndis->notify); | |
559 | rndis->notify->driver_data = NULL; | |
560 | } | |
561 | ||
562 | /*-------------------------------------------------------------------------*/ | |
563 | ||
564 | /* | |
565 | * This isn't quite the same mechanism as CDC Ethernet, since the | |
566 | * notification scheme passes less data, but the same set of link | |
567 | * states must be tested. A key difference is that altsettings are | |
568 | * not used to tell whether the link should send packets or not. | |
569 | */ | |
570 | ||
571 | static void rndis_open(struct gether *geth) | |
572 | { | |
573 | struct f_rndis *rndis = func_to_rndis(&geth->func); | |
574 | struct usb_composite_dev *cdev = geth->func.config->cdev; | |
575 | ||
576 | DBG(cdev, "%s\n", __func__); | |
577 | ||
578 | rndis_set_param_medium(rndis->config, NDIS_MEDIUM_802_3, | |
579 | bitrate(cdev->gadget) / 100); | |
580 | rndis_signal_connect(rndis->config); | |
581 | } | |
582 | ||
583 | static void rndis_close(struct gether *geth) | |
584 | { | |
585 | struct f_rndis *rndis = func_to_rndis(&geth->func); | |
586 | ||
587 | DBG(geth->func.config->cdev, "%s\n", __func__); | |
588 | ||
589 | rndis_set_param_medium(rndis->config, NDIS_MEDIUM_802_3, 0); | |
590 | rndis_signal_disconnect(rndis->config); | |
591 | } | |
592 | ||
593 | /*-------------------------------------------------------------------------*/ | |
594 | ||
595 | /* ethernet function driver setup/binding */ | |
596 | ||
597 | static int __init | |
598 | rndis_bind(struct usb_configuration *c, struct usb_function *f) | |
599 | { | |
600 | struct usb_composite_dev *cdev = c->cdev; | |
601 | struct f_rndis *rndis = func_to_rndis(f); | |
602 | int status; | |
603 | struct usb_ep *ep; | |
604 | ||
605 | /* allocate instance-specific interface IDs */ | |
606 | status = usb_interface_id(c, f); | |
607 | if (status < 0) | |
608 | goto fail; | |
609 | rndis->ctrl_id = status; | |
b97503ff | 610 | rndis_iad_descriptor.bFirstInterface = status; |
45fe3b8e DB |
611 | |
612 | rndis_control_intf.bInterfaceNumber = status; | |
613 | rndis_union_desc.bMasterInterface0 = status; | |
614 | ||
615 | status = usb_interface_id(c, f); | |
616 | if (status < 0) | |
617 | goto fail; | |
618 | rndis->data_id = status; | |
619 | ||
620 | rndis_data_intf.bInterfaceNumber = status; | |
621 | rndis_union_desc.bSlaveInterface0 = status; | |
622 | ||
623 | status = -ENODEV; | |
624 | ||
625 | /* allocate instance-specific endpoints */ | |
626 | ep = usb_ep_autoconfig(cdev->gadget, &fs_in_desc); | |
627 | if (!ep) | |
628 | goto fail; | |
629 | rndis->port.in_ep = ep; | |
630 | ep->driver_data = cdev; /* claim */ | |
631 | ||
632 | ep = usb_ep_autoconfig(cdev->gadget, &fs_out_desc); | |
633 | if (!ep) | |
634 | goto fail; | |
635 | rndis->port.out_ep = ep; | |
636 | ep->driver_data = cdev; /* claim */ | |
637 | ||
638 | /* NOTE: a status/notification endpoint is, strictly speaking, | |
639 | * optional. We don't treat it that way though! It's simpler, | |
640 | * and some newer profiles don't treat it as optional. | |
641 | */ | |
642 | ep = usb_ep_autoconfig(cdev->gadget, &fs_notify_desc); | |
643 | if (!ep) | |
644 | goto fail; | |
645 | rndis->notify = ep; | |
646 | ep->driver_data = cdev; /* claim */ | |
647 | ||
648 | status = -ENOMEM; | |
649 | ||
650 | /* allocate notification request and buffer */ | |
651 | rndis->notify_req = usb_ep_alloc_request(ep, GFP_KERNEL); | |
652 | if (!rndis->notify_req) | |
653 | goto fail; | |
654 | rndis->notify_req->buf = kmalloc(STATUS_BYTECOUNT, GFP_KERNEL); | |
655 | if (!rndis->notify_req->buf) | |
656 | goto fail; | |
657 | rndis->notify_req->length = STATUS_BYTECOUNT; | |
658 | rndis->notify_req->context = rndis; | |
659 | rndis->notify_req->complete = rndis_response_complete; | |
660 | ||
661 | /* copy descriptors, and track endpoint copies */ | |
662 | f->descriptors = usb_copy_descriptors(eth_fs_function); | |
663 | if (!f->descriptors) | |
664 | goto fail; | |
665 | ||
666 | rndis->fs.in = usb_find_endpoint(eth_fs_function, | |
667 | f->descriptors, &fs_in_desc); | |
668 | rndis->fs.out = usb_find_endpoint(eth_fs_function, | |
669 | f->descriptors, &fs_out_desc); | |
670 | rndis->fs.notify = usb_find_endpoint(eth_fs_function, | |
671 | f->descriptors, &fs_notify_desc); | |
672 | ||
673 | /* support all relevant hardware speeds... we expect that when | |
674 | * hardware is dual speed, all bulk-capable endpoints work at | |
675 | * both speeds | |
676 | */ | |
677 | if (gadget_is_dualspeed(c->cdev->gadget)) { | |
678 | hs_in_desc.bEndpointAddress = | |
679 | fs_in_desc.bEndpointAddress; | |
680 | hs_out_desc.bEndpointAddress = | |
681 | fs_out_desc.bEndpointAddress; | |
7c124149 DB |
682 | hs_notify_desc.bEndpointAddress = |
683 | fs_notify_desc.bEndpointAddress; | |
45fe3b8e DB |
684 | |
685 | /* copy descriptors, and track endpoint copies */ | |
686 | f->hs_descriptors = usb_copy_descriptors(eth_hs_function); | |
687 | ||
688 | if (!f->hs_descriptors) | |
689 | goto fail; | |
690 | ||
691 | rndis->hs.in = usb_find_endpoint(eth_hs_function, | |
692 | f->hs_descriptors, &hs_in_desc); | |
693 | rndis->hs.out = usb_find_endpoint(eth_hs_function, | |
694 | f->hs_descriptors, &hs_out_desc); | |
7c124149 DB |
695 | rndis->hs.notify = usb_find_endpoint(eth_hs_function, |
696 | f->hs_descriptors, &hs_notify_desc); | |
45fe3b8e DB |
697 | } |
698 | ||
699 | rndis->port.open = rndis_open; | |
700 | rndis->port.close = rndis_close; | |
701 | ||
702 | status = rndis_register(rndis_response_available, rndis); | |
703 | if (status < 0) | |
704 | goto fail; | |
705 | rndis->config = status; | |
706 | ||
707 | rndis_set_param_medium(rndis->config, NDIS_MEDIUM_802_3, 0); | |
708 | rndis_set_host_mac(rndis->config, rndis->ethaddr); | |
709 | ||
710 | #if 0 | |
711 | // FIXME | |
712 | if (rndis_set_param_vendor(rndis->config, vendorID, | |
713 | manufacturer)) | |
714 | goto fail0; | |
715 | #endif | |
716 | ||
717 | /* NOTE: all that is done without knowing or caring about | |
718 | * the network link ... which is unavailable to this code | |
719 | * until we're activated via set_alt(). | |
720 | */ | |
721 | ||
722 | DBG(cdev, "RNDIS: %s speed IN/%s OUT/%s NOTIFY/%s\n", | |
723 | gadget_is_dualspeed(c->cdev->gadget) ? "dual" : "full", | |
724 | rndis->port.in_ep->name, rndis->port.out_ep->name, | |
725 | rndis->notify->name); | |
726 | return 0; | |
727 | ||
728 | fail: | |
729 | if (gadget_is_dualspeed(c->cdev->gadget) && f->hs_descriptors) | |
730 | usb_free_descriptors(f->hs_descriptors); | |
731 | if (f->descriptors) | |
732 | usb_free_descriptors(f->descriptors); | |
733 | ||
734 | if (rndis->notify_req) { | |
735 | kfree(rndis->notify_req->buf); | |
736 | usb_ep_free_request(rndis->notify, rndis->notify_req); | |
737 | } | |
738 | ||
739 | /* we might as well release our claims on endpoints */ | |
740 | if (rndis->notify) | |
741 | rndis->notify->driver_data = NULL; | |
742 | if (rndis->port.out) | |
743 | rndis->port.out_ep->driver_data = NULL; | |
744 | if (rndis->port.in) | |
745 | rndis->port.in_ep->driver_data = NULL; | |
746 | ||
747 | ERROR(cdev, "%s: can't bind, err %d\n", f->name, status); | |
748 | ||
749 | return status; | |
750 | } | |
751 | ||
752 | static void | |
753 | rndis_unbind(struct usb_configuration *c, struct usb_function *f) | |
754 | { | |
755 | struct f_rndis *rndis = func_to_rndis(f); | |
756 | ||
757 | rndis_deregister(rndis->config); | |
758 | rndis_exit(); | |
759 | ||
760 | if (gadget_is_dualspeed(c->cdev->gadget)) | |
761 | usb_free_descriptors(f->hs_descriptors); | |
762 | usb_free_descriptors(f->descriptors); | |
763 | ||
764 | kfree(rndis->notify_req->buf); | |
765 | usb_ep_free_request(rndis->notify, rndis->notify_req); | |
766 | ||
767 | kfree(rndis); | |
768 | } | |
769 | ||
770 | /* Some controllers can't support RNDIS ... */ | |
771 | static inline bool can_support_rndis(struct usb_configuration *c) | |
772 | { | |
45fe3b8e DB |
773 | /* everything else is *presumably* fine */ |
774 | return true; | |
775 | } | |
776 | ||
777 | /** | |
778 | * rndis_bind_config - add RNDIS network link to a configuration | |
779 | * @c: the configuration to support the network link | |
780 | * @ethaddr: a buffer in which the ethernet address of the host side | |
781 | * side of the link was recorded | |
782 | * Context: single threaded during gadget setup | |
783 | * | |
784 | * Returns zero on success, else negative errno. | |
785 | * | |
786 | * Caller must have called @gether_setup(). Caller is also responsible | |
787 | * for calling @gether_cleanup() before module unload. | |
788 | */ | |
789 | int __init rndis_bind_config(struct usb_configuration *c, u8 ethaddr[ETH_ALEN]) | |
790 | { | |
791 | struct f_rndis *rndis; | |
792 | int status; | |
793 | ||
794 | if (!can_support_rndis(c) || !ethaddr) | |
795 | return -EINVAL; | |
796 | ||
797 | /* maybe allocate device-global string IDs */ | |
798 | if (rndis_string_defs[0].id == 0) { | |
799 | ||
800 | /* ... and setup RNDIS itself */ | |
801 | status = rndis_init(); | |
802 | if (status < 0) | |
803 | return status; | |
804 | ||
805 | /* control interface label */ | |
806 | status = usb_string_id(c->cdev); | |
807 | if (status < 0) | |
808 | return status; | |
809 | rndis_string_defs[0].id = status; | |
810 | rndis_control_intf.iInterface = status; | |
811 | ||
812 | /* data interface label */ | |
813 | status = usb_string_id(c->cdev); | |
814 | if (status < 0) | |
815 | return status; | |
816 | rndis_string_defs[1].id = status; | |
817 | rndis_data_intf.iInterface = status; | |
b97503ff MN |
818 | |
819 | /* IAD iFunction label */ | |
820 | status = usb_string_id(c->cdev); | |
821 | if (status < 0) | |
822 | return status; | |
823 | rndis_string_defs[2].id = status; | |
824 | rndis_iad_descriptor.iFunction = status; | |
45fe3b8e DB |
825 | } |
826 | ||
827 | /* allocate and initialize one new instance */ | |
828 | status = -ENOMEM; | |
829 | rndis = kzalloc(sizeof *rndis, GFP_KERNEL); | |
830 | if (!rndis) | |
831 | goto fail; | |
832 | ||
833 | memcpy(rndis->ethaddr, ethaddr, ETH_ALEN); | |
834 | ||
835 | /* RNDIS activates when the host changes this filter */ | |
836 | rndis->port.cdc_filter = 0; | |
837 | ||
838 | /* RNDIS has special (and complex) framing */ | |
839 | rndis->port.header_len = sizeof(struct rndis_packet_msg_type); | |
840 | rndis->port.wrap = rndis_add_header; | |
841 | rndis->port.unwrap = rndis_rm_hdr; | |
842 | ||
843 | rndis->port.func.name = "rndis"; | |
844 | rndis->port.func.strings = rndis_strings; | |
845 | /* descriptors are per-instance copies */ | |
846 | rndis->port.func.bind = rndis_bind; | |
847 | rndis->port.func.unbind = rndis_unbind; | |
848 | rndis->port.func.set_alt = rndis_set_alt; | |
849 | rndis->port.func.setup = rndis_setup; | |
850 | rndis->port.func.disable = rndis_disable; | |
851 | ||
852 | status = usb_add_function(c, &rndis->port.func); | |
853 | if (status) { | |
854 | kfree(rndis); | |
855 | fail: | |
856 | rndis_exit(); | |
857 | } | |
858 | return status; | |
859 | } |