Commit | Line | Data |
---|---|---|
da741b8c DB |
1 | /* |
2 | * f_ecm.c -- USB CDC Ethernet (ECM) link function driver | |
3 | * | |
4 | * Copyright (C) 2003-2005,2008 David Brownell | |
5 | * Copyright (C) 2008 Nokia Corporation | |
6 | * | |
7 | * This program is free software; you can redistribute it and/or modify | |
8 | * it under the terms of the GNU General Public License as published by | |
9 | * the Free Software Foundation; either version 2 of the License, or | |
10 | * (at your option) any later version. | |
da741b8c DB |
11 | */ |
12 | ||
13 | /* #define VERBOSE_DEBUG */ | |
14 | ||
5a0e3ad6 | 15 | #include <linux/slab.h> |
da741b8c | 16 | #include <linux/kernel.h> |
fee562a6 | 17 | #include <linux/module.h> |
da741b8c DB |
18 | #include <linux/device.h> |
19 | #include <linux/etherdevice.h> | |
20 | ||
21 | #include "u_ether.h" | |
da92801c | 22 | #include "u_ether_configfs.h" |
fee562a6 | 23 | #include "u_ecm.h" |
da741b8c DB |
24 | |
25 | ||
26 | /* | |
27 | * This function is a "CDC Ethernet Networking Control Model" (CDC ECM) | |
28 | * Ethernet link. The data transfer model is simple (packets sent and | |
29 | * received over bulk endpoints using normal short packet termination), | |
30 | * and the control model exposes various data and optional notifications. | |
31 | * | |
32 | * ECM is well standardized and (except for Microsoft) supported by most | |
33 | * operating systems with USB host support. It's the preferred interop | |
34 | * solution for Ethernet over USB, at least for firmware based solutions. | |
35 | * (Hardware solutions tend to be more minimalist.) A newer and simpler | |
36 | * "Ethernet Emulation Model" (CDC EEM) hasn't yet caught on. | |
37 | * | |
38 | * Note that ECM requires the use of "alternate settings" for its data | |
39 | * interface. This means that the set_alt() method has real work to do, | |
40 | * and also means that a get_alt() method is required. | |
41 | */ | |
42 | ||
da741b8c DB |
43 | |
44 | enum ecm_notify_state { | |
45 | ECM_NOTIFY_NONE, /* don't notify */ | |
46 | ECM_NOTIFY_CONNECT, /* issue CONNECT next */ | |
47 | ECM_NOTIFY_SPEED, /* issue SPEED_CHANGE next */ | |
48 | }; | |
49 | ||
50 | struct f_ecm { | |
51 | struct gether port; | |
52 | u8 ctrl_id, data_id; | |
53 | ||
54 | char ethaddr[14]; | |
55 | ||
da741b8c | 56 | struct usb_ep *notify; |
da741b8c DB |
57 | struct usb_request *notify_req; |
58 | u8 notify_state; | |
59 | bool is_open; | |
60 | ||
61 | /* FIXME is_open needs some irq-ish locking | |
62 | * ... possibly the same as port.ioport | |
63 | */ | |
64 | }; | |
65 | ||
66 | static inline struct f_ecm *func_to_ecm(struct usb_function *f) | |
67 | { | |
68 | return container_of(f, struct f_ecm, port.func); | |
69 | } | |
70 | ||
71 | /* peak (theoretical) bulk transfer rate in bits-per-second */ | |
33376c1c | 72 | static inline unsigned ecm_bitrate(struct usb_gadget *g) |
da741b8c | 73 | { |
04617db7 PZ |
74 | if (gadget_is_superspeed(g) && g->speed == USB_SPEED_SUPER) |
75 | return 13 * 1024 * 8 * 1000 * 8; | |
76 | else if (gadget_is_dualspeed(g) && g->speed == USB_SPEED_HIGH) | |
da741b8c DB |
77 | return 13 * 512 * 8 * 1000 * 8; |
78 | else | |
04617db7 | 79 | return 19 * 64 * 1 * 1000 * 8; |
da741b8c DB |
80 | } |
81 | ||
82 | /*-------------------------------------------------------------------------*/ | |
83 | ||
84 | /* | |
85 | * Include the status endpoint if we can, even though it's optional. | |
86 | * | |
87 | * Use wMaxPacketSize big enough to fit CDC_NOTIFY_SPEED_CHANGE in one | |
88 | * packet, to simplify cancellation; and a big transfer interval, to | |
89 | * waste less bandwidth. | |
90 | * | |
91 | * Some drivers (like Linux 2.4 cdc-ether!) "need" it to exist even | |
92 | * if they ignore the connect/disconnect notifications that real aether | |
93 | * can provide. More advanced cdc configurations might want to support | |
94 | * encapsulated commands (vendor-specific, using control-OUT). | |
95 | */ | |
96 | ||
bcb2f99c | 97 | #define ECM_STATUS_INTERVAL_MS 32 |
33376c1c | 98 | #define ECM_STATUS_BYTECOUNT 16 /* 8 byte header + data */ |
da741b8c DB |
99 | |
100 | ||
101 | /* interface descriptor: */ | |
102 | ||
d11519ad PN |
103 | static struct usb_interface_assoc_descriptor |
104 | ecm_iad_descriptor = { | |
105 | .bLength = sizeof ecm_iad_descriptor, | |
106 | .bDescriptorType = USB_DT_INTERFACE_ASSOCIATION, | |
107 | ||
108 | /* .bFirstInterface = DYNAMIC, */ | |
109 | .bInterfaceCount = 2, /* control + data */ | |
110 | .bFunctionClass = USB_CLASS_COMM, | |
111 | .bFunctionSubClass = USB_CDC_SUBCLASS_ETHERNET, | |
112 | .bFunctionProtocol = USB_CDC_PROTO_NONE, | |
113 | /* .iFunction = DYNAMIC */ | |
114 | }; | |
115 | ||
116 | ||
28824b18 | 117 | static struct usb_interface_descriptor ecm_control_intf = { |
da741b8c DB |
118 | .bLength = sizeof ecm_control_intf, |
119 | .bDescriptorType = USB_DT_INTERFACE, | |
120 | ||
121 | /* .bInterfaceNumber = DYNAMIC */ | |
122 | /* status endpoint is optional; this could be patched later */ | |
123 | .bNumEndpoints = 1, | |
124 | .bInterfaceClass = USB_CLASS_COMM, | |
125 | .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET, | |
126 | .bInterfaceProtocol = USB_CDC_PROTO_NONE, | |
127 | /* .iInterface = DYNAMIC */ | |
128 | }; | |
129 | ||
28824b18 | 130 | static struct usb_cdc_header_desc ecm_header_desc = { |
33376c1c | 131 | .bLength = sizeof ecm_header_desc, |
da741b8c DB |
132 | .bDescriptorType = USB_DT_CS_INTERFACE, |
133 | .bDescriptorSubType = USB_CDC_HEADER_TYPE, | |
134 | ||
551509d2 | 135 | .bcdCDC = cpu_to_le16(0x0110), |
da741b8c DB |
136 | }; |
137 | ||
28824b18 | 138 | static struct usb_cdc_union_desc ecm_union_desc = { |
da741b8c DB |
139 | .bLength = sizeof(ecm_union_desc), |
140 | .bDescriptorType = USB_DT_CS_INTERFACE, | |
141 | .bDescriptorSubType = USB_CDC_UNION_TYPE, | |
142 | /* .bMasterInterface0 = DYNAMIC */ | |
143 | /* .bSlaveInterface0 = DYNAMIC */ | |
144 | }; | |
145 | ||
28824b18 | 146 | static struct usb_cdc_ether_desc ecm_desc = { |
33376c1c | 147 | .bLength = sizeof ecm_desc, |
da741b8c DB |
148 | .bDescriptorType = USB_DT_CS_INTERFACE, |
149 | .bDescriptorSubType = USB_CDC_ETHERNET_TYPE, | |
150 | ||
151 | /* this descriptor actually adds value, surprise! */ | |
152 | /* .iMACAddress = DYNAMIC */ | |
551509d2 HH |
153 | .bmEthernetStatistics = cpu_to_le32(0), /* no statistics */ |
154 | .wMaxSegmentSize = cpu_to_le16(ETH_FRAME_LEN), | |
155 | .wNumberMCFilters = cpu_to_le16(0), | |
da741b8c DB |
156 | .bNumberPowerFilters = 0, |
157 | }; | |
158 | ||
159 | /* the default data interface has no endpoints ... */ | |
160 | ||
28824b18 | 161 | static struct usb_interface_descriptor ecm_data_nop_intf = { |
da741b8c DB |
162 | .bLength = sizeof ecm_data_nop_intf, |
163 | .bDescriptorType = USB_DT_INTERFACE, | |
164 | ||
165 | .bInterfaceNumber = 1, | |
166 | .bAlternateSetting = 0, | |
167 | .bNumEndpoints = 0, | |
168 | .bInterfaceClass = USB_CLASS_CDC_DATA, | |
169 | .bInterfaceSubClass = 0, | |
170 | .bInterfaceProtocol = 0, | |
171 | /* .iInterface = DYNAMIC */ | |
172 | }; | |
173 | ||
174 | /* ... but the "real" data interface has two bulk endpoints */ | |
175 | ||
28824b18 | 176 | static struct usb_interface_descriptor ecm_data_intf = { |
da741b8c DB |
177 | .bLength = sizeof ecm_data_intf, |
178 | .bDescriptorType = USB_DT_INTERFACE, | |
179 | ||
180 | .bInterfaceNumber = 1, | |
181 | .bAlternateSetting = 1, | |
182 | .bNumEndpoints = 2, | |
183 | .bInterfaceClass = USB_CLASS_CDC_DATA, | |
184 | .bInterfaceSubClass = 0, | |
185 | .bInterfaceProtocol = 0, | |
186 | /* .iInterface = DYNAMIC */ | |
187 | }; | |
188 | ||
189 | /* full speed support: */ | |
190 | ||
28824b18 | 191 | static struct usb_endpoint_descriptor fs_ecm_notify_desc = { |
da741b8c DB |
192 | .bLength = USB_DT_ENDPOINT_SIZE, |
193 | .bDescriptorType = USB_DT_ENDPOINT, | |
194 | ||
195 | .bEndpointAddress = USB_DIR_IN, | |
196 | .bmAttributes = USB_ENDPOINT_XFER_INT, | |
551509d2 | 197 | .wMaxPacketSize = cpu_to_le16(ECM_STATUS_BYTECOUNT), |
bcb2f99c | 198 | .bInterval = ECM_STATUS_INTERVAL_MS, |
da741b8c DB |
199 | }; |
200 | ||
28824b18 | 201 | static struct usb_endpoint_descriptor fs_ecm_in_desc = { |
da741b8c DB |
202 | .bLength = USB_DT_ENDPOINT_SIZE, |
203 | .bDescriptorType = USB_DT_ENDPOINT, | |
204 | ||
205 | .bEndpointAddress = USB_DIR_IN, | |
206 | .bmAttributes = USB_ENDPOINT_XFER_BULK, | |
207 | }; | |
208 | ||
28824b18 | 209 | static struct usb_endpoint_descriptor fs_ecm_out_desc = { |
da741b8c DB |
210 | .bLength = USB_DT_ENDPOINT_SIZE, |
211 | .bDescriptorType = USB_DT_ENDPOINT, | |
212 | ||
213 | .bEndpointAddress = USB_DIR_OUT, | |
214 | .bmAttributes = USB_ENDPOINT_XFER_BULK, | |
215 | }; | |
216 | ||
28824b18 | 217 | static struct usb_descriptor_header *ecm_fs_function[] = { |
da741b8c | 218 | /* CDC ECM control descriptors */ |
d11519ad | 219 | (struct usb_descriptor_header *) &ecm_iad_descriptor, |
da741b8c | 220 | (struct usb_descriptor_header *) &ecm_control_intf, |
33376c1c | 221 | (struct usb_descriptor_header *) &ecm_header_desc, |
da741b8c | 222 | (struct usb_descriptor_header *) &ecm_union_desc, |
33376c1c | 223 | (struct usb_descriptor_header *) &ecm_desc, |
04617db7 | 224 | |
da741b8c | 225 | /* NOTE: status endpoint might need to be removed */ |
33376c1c | 226 | (struct usb_descriptor_header *) &fs_ecm_notify_desc, |
04617db7 | 227 | |
da741b8c DB |
228 | /* data interface, altsettings 0 and 1 */ |
229 | (struct usb_descriptor_header *) &ecm_data_nop_intf, | |
230 | (struct usb_descriptor_header *) &ecm_data_intf, | |
33376c1c DB |
231 | (struct usb_descriptor_header *) &fs_ecm_in_desc, |
232 | (struct usb_descriptor_header *) &fs_ecm_out_desc, | |
da741b8c DB |
233 | NULL, |
234 | }; | |
235 | ||
236 | /* high speed support: */ | |
237 | ||
28824b18 | 238 | static struct usb_endpoint_descriptor hs_ecm_notify_desc = { |
da741b8c DB |
239 | .bLength = USB_DT_ENDPOINT_SIZE, |
240 | .bDescriptorType = USB_DT_ENDPOINT, | |
241 | ||
242 | .bEndpointAddress = USB_DIR_IN, | |
243 | .bmAttributes = USB_ENDPOINT_XFER_INT, | |
551509d2 | 244 | .wMaxPacketSize = cpu_to_le16(ECM_STATUS_BYTECOUNT), |
bcb2f99c | 245 | .bInterval = USB_MS_TO_HS_INTERVAL(ECM_STATUS_INTERVAL_MS), |
da741b8c | 246 | }; |
04617db7 | 247 | |
28824b18 | 248 | static struct usb_endpoint_descriptor hs_ecm_in_desc = { |
da741b8c DB |
249 | .bLength = USB_DT_ENDPOINT_SIZE, |
250 | .bDescriptorType = USB_DT_ENDPOINT, | |
251 | ||
252 | .bEndpointAddress = USB_DIR_IN, | |
253 | .bmAttributes = USB_ENDPOINT_XFER_BULK, | |
551509d2 | 254 | .wMaxPacketSize = cpu_to_le16(512), |
da741b8c DB |
255 | }; |
256 | ||
28824b18 | 257 | static struct usb_endpoint_descriptor hs_ecm_out_desc = { |
da741b8c DB |
258 | .bLength = USB_DT_ENDPOINT_SIZE, |
259 | .bDescriptorType = USB_DT_ENDPOINT, | |
260 | ||
261 | .bEndpointAddress = USB_DIR_OUT, | |
262 | .bmAttributes = USB_ENDPOINT_XFER_BULK, | |
551509d2 | 263 | .wMaxPacketSize = cpu_to_le16(512), |
da741b8c DB |
264 | }; |
265 | ||
28824b18 | 266 | static struct usb_descriptor_header *ecm_hs_function[] = { |
da741b8c | 267 | /* CDC ECM control descriptors */ |
d11519ad | 268 | (struct usb_descriptor_header *) &ecm_iad_descriptor, |
da741b8c | 269 | (struct usb_descriptor_header *) &ecm_control_intf, |
33376c1c | 270 | (struct usb_descriptor_header *) &ecm_header_desc, |
da741b8c | 271 | (struct usb_descriptor_header *) &ecm_union_desc, |
33376c1c | 272 | (struct usb_descriptor_header *) &ecm_desc, |
04617db7 | 273 | |
da741b8c | 274 | /* NOTE: status endpoint might need to be removed */ |
33376c1c | 275 | (struct usb_descriptor_header *) &hs_ecm_notify_desc, |
04617db7 | 276 | |
da741b8c DB |
277 | /* data interface, altsettings 0 and 1 */ |
278 | (struct usb_descriptor_header *) &ecm_data_nop_intf, | |
279 | (struct usb_descriptor_header *) &ecm_data_intf, | |
33376c1c DB |
280 | (struct usb_descriptor_header *) &hs_ecm_in_desc, |
281 | (struct usb_descriptor_header *) &hs_ecm_out_desc, | |
da741b8c DB |
282 | NULL, |
283 | }; | |
284 | ||
04617db7 PZ |
285 | /* super speed support: */ |
286 | ||
287 | static struct usb_endpoint_descriptor ss_ecm_notify_desc = { | |
288 | .bLength = USB_DT_ENDPOINT_SIZE, | |
289 | .bDescriptorType = USB_DT_ENDPOINT, | |
290 | ||
291 | .bEndpointAddress = USB_DIR_IN, | |
292 | .bmAttributes = USB_ENDPOINT_XFER_INT, | |
293 | .wMaxPacketSize = cpu_to_le16(ECM_STATUS_BYTECOUNT), | |
bcb2f99c | 294 | .bInterval = USB_MS_TO_HS_INTERVAL(ECM_STATUS_INTERVAL_MS), |
04617db7 PZ |
295 | }; |
296 | ||
297 | static struct usb_ss_ep_comp_descriptor ss_ecm_intr_comp_desc = { | |
298 | .bLength = sizeof ss_ecm_intr_comp_desc, | |
299 | .bDescriptorType = USB_DT_SS_ENDPOINT_COMP, | |
300 | ||
301 | /* the following 3 values can be tweaked if necessary */ | |
302 | /* .bMaxBurst = 0, */ | |
303 | /* .bmAttributes = 0, */ | |
304 | .wBytesPerInterval = cpu_to_le16(ECM_STATUS_BYTECOUNT), | |
305 | }; | |
306 | ||
307 | static struct usb_endpoint_descriptor ss_ecm_in_desc = { | |
308 | .bLength = USB_DT_ENDPOINT_SIZE, | |
309 | .bDescriptorType = USB_DT_ENDPOINT, | |
310 | ||
311 | .bEndpointAddress = USB_DIR_IN, | |
312 | .bmAttributes = USB_ENDPOINT_XFER_BULK, | |
313 | .wMaxPacketSize = cpu_to_le16(1024), | |
314 | }; | |
315 | ||
316 | static struct usb_endpoint_descriptor ss_ecm_out_desc = { | |
317 | .bLength = USB_DT_ENDPOINT_SIZE, | |
318 | .bDescriptorType = USB_DT_ENDPOINT, | |
319 | ||
320 | .bEndpointAddress = USB_DIR_OUT, | |
321 | .bmAttributes = USB_ENDPOINT_XFER_BULK, | |
322 | .wMaxPacketSize = cpu_to_le16(1024), | |
323 | }; | |
324 | ||
325 | static struct usb_ss_ep_comp_descriptor ss_ecm_bulk_comp_desc = { | |
326 | .bLength = sizeof ss_ecm_bulk_comp_desc, | |
327 | .bDescriptorType = USB_DT_SS_ENDPOINT_COMP, | |
328 | ||
329 | /* the following 2 values can be tweaked if necessary */ | |
330 | /* .bMaxBurst = 0, */ | |
331 | /* .bmAttributes = 0, */ | |
332 | }; | |
333 | ||
334 | static struct usb_descriptor_header *ecm_ss_function[] = { | |
335 | /* CDC ECM control descriptors */ | |
585e3931 | 336 | (struct usb_descriptor_header *) &ecm_iad_descriptor, |
04617db7 PZ |
337 | (struct usb_descriptor_header *) &ecm_control_intf, |
338 | (struct usb_descriptor_header *) &ecm_header_desc, | |
339 | (struct usb_descriptor_header *) &ecm_union_desc, | |
340 | (struct usb_descriptor_header *) &ecm_desc, | |
341 | ||
342 | /* NOTE: status endpoint might need to be removed */ | |
343 | (struct usb_descriptor_header *) &ss_ecm_notify_desc, | |
344 | (struct usb_descriptor_header *) &ss_ecm_intr_comp_desc, | |
345 | ||
346 | /* data interface, altsettings 0 and 1 */ | |
347 | (struct usb_descriptor_header *) &ecm_data_nop_intf, | |
348 | (struct usb_descriptor_header *) &ecm_data_intf, | |
349 | (struct usb_descriptor_header *) &ss_ecm_in_desc, | |
350 | (struct usb_descriptor_header *) &ss_ecm_bulk_comp_desc, | |
351 | (struct usb_descriptor_header *) &ss_ecm_out_desc, | |
352 | (struct usb_descriptor_header *) &ss_ecm_bulk_comp_desc, | |
353 | NULL, | |
354 | }; | |
355 | ||
da741b8c DB |
356 | /* string descriptors: */ |
357 | ||
358 | static struct usb_string ecm_string_defs[] = { | |
359 | [0].s = "CDC Ethernet Control Model (ECM)", | |
1616e99d | 360 | [1].s = "", |
da741b8c | 361 | [2].s = "CDC Ethernet Data", |
d11519ad | 362 | [3].s = "CDC ECM", |
da741b8c DB |
363 | { } /* end of list */ |
364 | }; | |
365 | ||
366 | static struct usb_gadget_strings ecm_string_table = { | |
367 | .language = 0x0409, /* en-us */ | |
368 | .strings = ecm_string_defs, | |
369 | }; | |
370 | ||
371 | static struct usb_gadget_strings *ecm_strings[] = { | |
372 | &ecm_string_table, | |
373 | NULL, | |
374 | }; | |
375 | ||
376 | /*-------------------------------------------------------------------------*/ | |
377 | ||
378 | static void ecm_do_notify(struct f_ecm *ecm) | |
379 | { | |
380 | struct usb_request *req = ecm->notify_req; | |
381 | struct usb_cdc_notification *event; | |
382 | struct usb_composite_dev *cdev = ecm->port.func.config->cdev; | |
383 | __le32 *data; | |
384 | int status; | |
385 | ||
386 | /* notification already in flight? */ | |
387 | if (!req) | |
388 | return; | |
389 | ||
390 | event = req->buf; | |
391 | switch (ecm->notify_state) { | |
392 | case ECM_NOTIFY_NONE: | |
393 | return; | |
394 | ||
395 | case ECM_NOTIFY_CONNECT: | |
396 | event->bNotificationType = USB_CDC_NOTIFY_NETWORK_CONNECTION; | |
397 | if (ecm->is_open) | |
398 | event->wValue = cpu_to_le16(1); | |
399 | else | |
400 | event->wValue = cpu_to_le16(0); | |
401 | event->wLength = 0; | |
402 | req->length = sizeof *event; | |
403 | ||
404 | DBG(cdev, "notify connect %s\n", | |
405 | ecm->is_open ? "true" : "false"); | |
406 | ecm->notify_state = ECM_NOTIFY_SPEED; | |
407 | break; | |
408 | ||
409 | case ECM_NOTIFY_SPEED: | |
410 | event->bNotificationType = USB_CDC_NOTIFY_SPEED_CHANGE; | |
411 | event->wValue = cpu_to_le16(0); | |
412 | event->wLength = cpu_to_le16(8); | |
33376c1c | 413 | req->length = ECM_STATUS_BYTECOUNT; |
da741b8c DB |
414 | |
415 | /* SPEED_CHANGE data is up/down speeds in bits/sec */ | |
416 | data = req->buf + sizeof *event; | |
33376c1c | 417 | data[0] = cpu_to_le32(ecm_bitrate(cdev->gadget)); |
da741b8c DB |
418 | data[1] = data[0]; |
419 | ||
33376c1c | 420 | DBG(cdev, "notify speed %d\n", ecm_bitrate(cdev->gadget)); |
da741b8c DB |
421 | ecm->notify_state = ECM_NOTIFY_NONE; |
422 | break; | |
423 | } | |
424 | event->bmRequestType = 0xA1; | |
425 | event->wIndex = cpu_to_le16(ecm->ctrl_id); | |
426 | ||
427 | ecm->notify_req = NULL; | |
428 | status = usb_ep_queue(ecm->notify, req, GFP_ATOMIC); | |
429 | if (status < 0) { | |
430 | ecm->notify_req = req; | |
431 | DBG(cdev, "notify --> %d\n", status); | |
432 | } | |
433 | } | |
434 | ||
435 | static void ecm_notify(struct f_ecm *ecm) | |
436 | { | |
437 | /* NOTE on most versions of Linux, host side cdc-ethernet | |
438 | * won't listen for notifications until its netdevice opens. | |
439 | * The first notification then sits in the FIFO for a long | |
440 | * time, and the second one is queued. | |
441 | */ | |
442 | ecm->notify_state = ECM_NOTIFY_CONNECT; | |
443 | ecm_do_notify(ecm); | |
444 | } | |
445 | ||
446 | static void ecm_notify_complete(struct usb_ep *ep, struct usb_request *req) | |
447 | { | |
448 | struct f_ecm *ecm = req->context; | |
449 | struct usb_composite_dev *cdev = ecm->port.func.config->cdev; | |
450 | struct usb_cdc_notification *event = req->buf; | |
451 | ||
452 | switch (req->status) { | |
453 | case 0: | |
454 | /* no fault */ | |
455 | break; | |
456 | case -ECONNRESET: | |
457 | case -ESHUTDOWN: | |
458 | ecm->notify_state = ECM_NOTIFY_NONE; | |
459 | break; | |
460 | default: | |
461 | DBG(cdev, "event %02x --> %d\n", | |
462 | event->bNotificationType, req->status); | |
463 | break; | |
464 | } | |
465 | ecm->notify_req = req; | |
466 | ecm_do_notify(ecm); | |
467 | } | |
468 | ||
469 | static int ecm_setup(struct usb_function *f, const struct usb_ctrlrequest *ctrl) | |
470 | { | |
471 | struct f_ecm *ecm = func_to_ecm(f); | |
472 | struct usb_composite_dev *cdev = f->config->cdev; | |
473 | struct usb_request *req = cdev->req; | |
474 | int value = -EOPNOTSUPP; | |
475 | u16 w_index = le16_to_cpu(ctrl->wIndex); | |
476 | u16 w_value = le16_to_cpu(ctrl->wValue); | |
477 | u16 w_length = le16_to_cpu(ctrl->wLength); | |
478 | ||
479 | /* composite driver infrastructure handles everything except | |
480 | * CDC class messages; interface activation uses set_alt(). | |
481 | */ | |
482 | switch ((ctrl->bRequestType << 8) | ctrl->bRequest) { | |
483 | case ((USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE) << 8) | |
484 | | USB_CDC_SET_ETHERNET_PACKET_FILTER: | |
485 | /* see 6.2.30: no data, wIndex = interface, | |
486 | * wValue = packet filter bitmap | |
487 | */ | |
488 | if (w_length != 0 || w_index != ecm->ctrl_id) | |
489 | goto invalid; | |
490 | DBG(cdev, "packet filter %02x\n", w_value); | |
491 | /* REVISIT locking of cdc_filter. This assumes the UDC | |
492 | * driver won't have a concurrent packet TX irq running on | |
493 | * another CPU; or that if it does, this write is atomic... | |
494 | */ | |
495 | ecm->port.cdc_filter = w_value; | |
496 | value = 0; | |
497 | break; | |
498 | ||
499 | /* and optionally: | |
500 | * case USB_CDC_SEND_ENCAPSULATED_COMMAND: | |
501 | * case USB_CDC_GET_ENCAPSULATED_RESPONSE: | |
502 | * case USB_CDC_SET_ETHERNET_MULTICAST_FILTERS: | |
503 | * case USB_CDC_SET_ETHERNET_PM_PATTERN_FILTER: | |
504 | * case USB_CDC_GET_ETHERNET_PM_PATTERN_FILTER: | |
505 | * case USB_CDC_GET_ETHERNET_STATISTIC: | |
506 | */ | |
507 | ||
508 | default: | |
509 | invalid: | |
510 | DBG(cdev, "invalid control req%02x.%02x v%04x i%04x l%d\n", | |
511 | ctrl->bRequestType, ctrl->bRequest, | |
512 | w_value, w_index, w_length); | |
513 | } | |
514 | ||
515 | /* respond with data transfer or status phase? */ | |
516 | if (value >= 0) { | |
517 | DBG(cdev, "ecm req%02x.%02x v%04x i%04x l%d\n", | |
518 | ctrl->bRequestType, ctrl->bRequest, | |
519 | w_value, w_index, w_length); | |
520 | req->zero = 0; | |
521 | req->length = value; | |
522 | value = usb_ep_queue(cdev->gadget->ep0, req, GFP_ATOMIC); | |
523 | if (value < 0) | |
524 | ERROR(cdev, "ecm req %02x.%02x response err %d\n", | |
525 | ctrl->bRequestType, ctrl->bRequest, | |
526 | value); | |
527 | } | |
528 | ||
529 | /* device either stalls (value < 0) or reports success */ | |
530 | return value; | |
531 | } | |
532 | ||
533 | ||
534 | static int ecm_set_alt(struct usb_function *f, unsigned intf, unsigned alt) | |
535 | { | |
536 | struct f_ecm *ecm = func_to_ecm(f); | |
537 | struct usb_composite_dev *cdev = f->config->cdev; | |
538 | ||
539 | /* Control interface has only altsetting 0 */ | |
540 | if (intf == ecm->ctrl_id) { | |
541 | if (alt != 0) | |
542 | goto fail; | |
543 | ||
544 | if (ecm->notify->driver_data) { | |
545 | VDBG(cdev, "reset ecm control %d\n", intf); | |
546 | usb_ep_disable(ecm->notify); | |
ea2a1df7 TB |
547 | } |
548 | if (!(ecm->notify->desc)) { | |
da741b8c | 549 | VDBG(cdev, "init ecm ctrl %d\n", intf); |
ea2a1df7 TB |
550 | if (config_ep_by_speed(cdev->gadget, f, ecm->notify)) |
551 | goto fail; | |
da741b8c | 552 | } |
72c973dd | 553 | usb_ep_enable(ecm->notify); |
da741b8c DB |
554 | ecm->notify->driver_data = ecm; |
555 | ||
556 | /* Data interface has two altsettings, 0 and 1 */ | |
557 | } else if (intf == ecm->data_id) { | |
558 | if (alt > 1) | |
559 | goto fail; | |
560 | ||
561 | if (ecm->port.in_ep->driver_data) { | |
562 | DBG(cdev, "reset ecm\n"); | |
563 | gether_disconnect(&ecm->port); | |
564 | } | |
565 | ||
ea2a1df7 TB |
566 | if (!ecm->port.in_ep->desc || |
567 | !ecm->port.out_ep->desc) { | |
da741b8c | 568 | DBG(cdev, "init ecm\n"); |
ea2a1df7 TB |
569 | if (config_ep_by_speed(cdev->gadget, f, |
570 | ecm->port.in_ep) || | |
571 | config_ep_by_speed(cdev->gadget, f, | |
572 | ecm->port.out_ep)) { | |
573 | ecm->port.in_ep->desc = NULL; | |
574 | ecm->port.out_ep->desc = NULL; | |
575 | goto fail; | |
576 | } | |
da741b8c DB |
577 | } |
578 | ||
579 | /* CDC Ethernet only sends data in non-default altsettings. | |
580 | * Changing altsettings resets filters, statistics, etc. | |
581 | */ | |
582 | if (alt == 1) { | |
583 | struct net_device *net; | |
584 | ||
585 | /* Enable zlps by default for ECM conformance; | |
90f79768 | 586 | * override for musb_hdrc (avoids txdma ovhead). |
da741b8c | 587 | */ |
90f79768 | 588 | ecm->port.is_zlp_ok = !(gadget_is_musbhdrc(cdev->gadget) |
da741b8c DB |
589 | ); |
590 | ecm->port.cdc_filter = DEFAULT_FILTER; | |
591 | DBG(cdev, "activate ecm\n"); | |
592 | net = gether_connect(&ecm->port); | |
593 | if (IS_ERR(net)) | |
594 | return PTR_ERR(net); | |
595 | } | |
596 | ||
597 | /* NOTE this can be a minor disagreement with the ECM spec, | |
598 | * which says speed notifications will "always" follow | |
599 | * connection notifications. But we allow one connect to | |
600 | * follow another (if the first is in flight), and instead | |
601 | * just guarantee that a speed notification is always sent. | |
602 | */ | |
603 | ecm_notify(ecm); | |
604 | } else | |
605 | goto fail; | |
606 | ||
607 | return 0; | |
608 | fail: | |
609 | return -EINVAL; | |
610 | } | |
611 | ||
612 | /* Because the data interface supports multiple altsettings, | |
613 | * this ECM function *MUST* implement a get_alt() method. | |
614 | */ | |
615 | static int ecm_get_alt(struct usb_function *f, unsigned intf) | |
616 | { | |
617 | struct f_ecm *ecm = func_to_ecm(f); | |
618 | ||
619 | if (intf == ecm->ctrl_id) | |
620 | return 0; | |
621 | return ecm->port.in_ep->driver_data ? 1 : 0; | |
622 | } | |
623 | ||
624 | static void ecm_disable(struct usb_function *f) | |
625 | { | |
626 | struct f_ecm *ecm = func_to_ecm(f); | |
627 | struct usb_composite_dev *cdev = f->config->cdev; | |
628 | ||
629 | DBG(cdev, "ecm deactivated\n"); | |
630 | ||
631 | if (ecm->port.in_ep->driver_data) | |
632 | gether_disconnect(&ecm->port); | |
633 | ||
634 | if (ecm->notify->driver_data) { | |
635 | usb_ep_disable(ecm->notify); | |
636 | ecm->notify->driver_data = NULL; | |
72c973dd | 637 | ecm->notify->desc = NULL; |
da741b8c DB |
638 | } |
639 | } | |
640 | ||
641 | /*-------------------------------------------------------------------------*/ | |
642 | ||
643 | /* | |
644 | * Callbacks let us notify the host about connect/disconnect when the | |
645 | * net device is opened or closed. | |
646 | * | |
647 | * For testing, note that link states on this side include both opened | |
648 | * and closed variants of: | |
649 | * | |
650 | * - disconnected/unconfigured | |
651 | * - configured but inactive (data alt 0) | |
652 | * - configured and active (data alt 1) | |
653 | * | |
654 | * Each needs to be tested with unplug, rmmod, SET_CONFIGURATION, and | |
655 | * SET_INTERFACE (altsetting). Remember also that "configured" doesn't | |
656 | * imply the host is actually polling the notification endpoint, and | |
657 | * likewise that "active" doesn't imply it's actually using the data | |
658 | * endpoints for traffic. | |
659 | */ | |
660 | ||
661 | static void ecm_open(struct gether *geth) | |
662 | { | |
663 | struct f_ecm *ecm = func_to_ecm(&geth->func); | |
664 | ||
665 | DBG(ecm->port.func.config->cdev, "%s\n", __func__); | |
666 | ||
667 | ecm->is_open = true; | |
668 | ecm_notify(ecm); | |
669 | } | |
670 | ||
671 | static void ecm_close(struct gether *geth) | |
672 | { | |
673 | struct f_ecm *ecm = func_to_ecm(&geth->func); | |
674 | ||
675 | DBG(ecm->port.func.config->cdev, "%s\n", __func__); | |
676 | ||
677 | ecm->is_open = false; | |
678 | ecm_notify(ecm); | |
679 | } | |
680 | ||
681 | /*-------------------------------------------------------------------------*/ | |
682 | ||
683 | /* ethernet function driver setup/binding */ | |
684 | ||
28824b18 | 685 | static int |
da741b8c DB |
686 | ecm_bind(struct usb_configuration *c, struct usb_function *f) |
687 | { | |
688 | struct usb_composite_dev *cdev = c->cdev; | |
689 | struct f_ecm *ecm = func_to_ecm(f); | |
06b72598 | 690 | struct usb_string *us; |
da741b8c DB |
691 | int status; |
692 | struct usb_ep *ep; | |
693 | ||
fee562a6 AP |
694 | struct f_ecm_opts *ecm_opts; |
695 | ||
696 | if (!can_support_ecm(cdev->gadget)) | |
697 | return -EINVAL; | |
698 | ||
699 | ecm_opts = container_of(f->fi, struct f_ecm_opts, func_inst); | |
700 | ||
701 | /* | |
702 | * in drivers/usb/gadget/configfs.c:configfs_composite_bind() | |
703 | * configurations are bound in sequence with list_for_each_entry, | |
704 | * in each configuration its functions are bound in sequence | |
705 | * with list_for_each_entry, so we assume no race condition | |
706 | * with regard to ecm_opts->bound access | |
707 | */ | |
708 | if (!ecm_opts->bound) { | |
da92801c | 709 | mutex_lock(&ecm_opts->lock); |
fee562a6 AP |
710 | gether_set_gadget(ecm_opts->net, cdev->gadget); |
711 | status = gether_register_netdev(ecm_opts->net); | |
da92801c | 712 | mutex_unlock(&ecm_opts->lock); |
fee562a6 AP |
713 | if (status) |
714 | return status; | |
715 | ecm_opts->bound = true; | |
716 | } | |
f1a2ca2e | 717 | |
06b72598 AP |
718 | us = usb_gstrings_attach(cdev, ecm_strings, |
719 | ARRAY_SIZE(ecm_string_defs)); | |
720 | if (IS_ERR(us)) | |
721 | return PTR_ERR(us); | |
722 | ecm_control_intf.iInterface = us[0].id; | |
723 | ecm_data_intf.iInterface = us[2].id; | |
724 | ecm_desc.iMACAddress = us[1].id; | |
725 | ecm_iad_descriptor.iFunction = us[3].id; | |
fee562a6 | 726 | |
da741b8c DB |
727 | /* allocate instance-specific interface IDs */ |
728 | status = usb_interface_id(c, f); | |
729 | if (status < 0) | |
730 | goto fail; | |
731 | ecm->ctrl_id = status; | |
d11519ad | 732 | ecm_iad_descriptor.bFirstInterface = status; |
da741b8c DB |
733 | |
734 | ecm_control_intf.bInterfaceNumber = status; | |
735 | ecm_union_desc.bMasterInterface0 = status; | |
736 | ||
737 | status = usb_interface_id(c, f); | |
738 | if (status < 0) | |
739 | goto fail; | |
740 | ecm->data_id = status; | |
741 | ||
742 | ecm_data_nop_intf.bInterfaceNumber = status; | |
743 | ecm_data_intf.bInterfaceNumber = status; | |
744 | ecm_union_desc.bSlaveInterface0 = status; | |
745 | ||
746 | status = -ENODEV; | |
747 | ||
748 | /* allocate instance-specific endpoints */ | |
33376c1c | 749 | ep = usb_ep_autoconfig(cdev->gadget, &fs_ecm_in_desc); |
da741b8c DB |
750 | if (!ep) |
751 | goto fail; | |
752 | ecm->port.in_ep = ep; | |
753 | ep->driver_data = cdev; /* claim */ | |
754 | ||
33376c1c | 755 | ep = usb_ep_autoconfig(cdev->gadget, &fs_ecm_out_desc); |
da741b8c DB |
756 | if (!ep) |
757 | goto fail; | |
758 | ecm->port.out_ep = ep; | |
759 | ep->driver_data = cdev; /* claim */ | |
760 | ||
761 | /* NOTE: a status/notification endpoint is *OPTIONAL* but we | |
762 | * don't treat it that way. It's simpler, and some newer CDC | |
763 | * profiles (wireless handsets) no longer treat it as optional. | |
764 | */ | |
33376c1c | 765 | ep = usb_ep_autoconfig(cdev->gadget, &fs_ecm_notify_desc); |
da741b8c DB |
766 | if (!ep) |
767 | goto fail; | |
768 | ecm->notify = ep; | |
769 | ep->driver_data = cdev; /* claim */ | |
770 | ||
771 | status = -ENOMEM; | |
772 | ||
773 | /* allocate notification request and buffer */ | |
774 | ecm->notify_req = usb_ep_alloc_request(ep, GFP_KERNEL); | |
775 | if (!ecm->notify_req) | |
776 | goto fail; | |
33376c1c | 777 | ecm->notify_req->buf = kmalloc(ECM_STATUS_BYTECOUNT, GFP_KERNEL); |
da741b8c DB |
778 | if (!ecm->notify_req->buf) |
779 | goto fail; | |
780 | ecm->notify_req->context = ecm; | |
781 | ecm->notify_req->complete = ecm_notify_complete; | |
782 | ||
da741b8c DB |
783 | /* support all relevant hardware speeds... we expect that when |
784 | * hardware is dual speed, all bulk-capable endpoints work at | |
785 | * both speeds | |
786 | */ | |
10287bae SAS |
787 | hs_ecm_in_desc.bEndpointAddress = fs_ecm_in_desc.bEndpointAddress; |
788 | hs_ecm_out_desc.bEndpointAddress = fs_ecm_out_desc.bEndpointAddress; | |
789 | hs_ecm_notify_desc.bEndpointAddress = | |
790 | fs_ecm_notify_desc.bEndpointAddress; | |
791 | ||
792 | ss_ecm_in_desc.bEndpointAddress = fs_ecm_in_desc.bEndpointAddress; | |
793 | ss_ecm_out_desc.bEndpointAddress = fs_ecm_out_desc.bEndpointAddress; | |
794 | ss_ecm_notify_desc.bEndpointAddress = | |
795 | fs_ecm_notify_desc.bEndpointAddress; | |
796 | ||
797 | status = usb_assign_descriptors(f, ecm_fs_function, ecm_hs_function, | |
798 | ecm_ss_function); | |
799 | if (status) | |
800 | goto fail; | |
04617db7 | 801 | |
da741b8c DB |
802 | /* NOTE: all that is done without knowing or caring about |
803 | * the network link ... which is unavailable to this code | |
804 | * until we're activated via set_alt(). | |
805 | */ | |
806 | ||
807 | ecm->port.open = ecm_open; | |
808 | ecm->port.close = ecm_close; | |
809 | ||
810 | DBG(cdev, "CDC Ethernet: %s speed IN/%s OUT/%s NOTIFY/%s\n", | |
04617db7 | 811 | gadget_is_superspeed(c->cdev->gadget) ? "super" : |
da741b8c DB |
812 | gadget_is_dualspeed(c->cdev->gadget) ? "dual" : "full", |
813 | ecm->port.in_ep->name, ecm->port.out_ep->name, | |
814 | ecm->notify->name); | |
815 | return 0; | |
816 | ||
817 | fail: | |
da741b8c DB |
818 | if (ecm->notify_req) { |
819 | kfree(ecm->notify_req->buf); | |
820 | usb_ep_free_request(ecm->notify, ecm->notify_req); | |
821 | } | |
822 | ||
823 | /* we might as well release our claims on endpoints */ | |
824 | if (ecm->notify) | |
825 | ecm->notify->driver_data = NULL; | |
e79cc615 | 826 | if (ecm->port.out_ep) |
da741b8c | 827 | ecm->port.out_ep->driver_data = NULL; |
e79cc615 | 828 | if (ecm->port.in_ep) |
da741b8c DB |
829 | ecm->port.in_ep->driver_data = NULL; |
830 | ||
831 | ERROR(cdev, "%s: can't bind, err %d\n", f->name, status); | |
832 | ||
833 | return status; | |
834 | } | |
835 | ||
da92801c AP |
836 | static inline struct f_ecm_opts *to_f_ecm_opts(struct config_item *item) |
837 | { | |
838 | return container_of(to_config_group(item), struct f_ecm_opts, | |
839 | func_inst.group); | |
840 | } | |
841 | ||
842 | /* f_ecm_item_ops */ | |
843 | USB_ETHERNET_CONFIGFS_ITEM(ecm); | |
844 | ||
845 | /* f_ecm_opts_dev_addr */ | |
846 | USB_ETHERNET_CONFIGFS_ITEM_ATTR_DEV_ADDR(ecm); | |
847 | ||
848 | /* f_ecm_opts_host_addr */ | |
849 | USB_ETHERNET_CONFIGFS_ITEM_ATTR_HOST_ADDR(ecm); | |
850 | ||
851 | /* f_ecm_opts_qmult */ | |
852 | USB_ETHERNET_CONFIGFS_ITEM_ATTR_QMULT(ecm); | |
853 | ||
854 | /* f_ecm_opts_ifname */ | |
855 | USB_ETHERNET_CONFIGFS_ITEM_ATTR_IFNAME(ecm); | |
856 | ||
857 | static struct configfs_attribute *ecm_attrs[] = { | |
858 | &f_ecm_opts_dev_addr.attr, | |
859 | &f_ecm_opts_host_addr.attr, | |
860 | &f_ecm_opts_qmult.attr, | |
861 | &f_ecm_opts_ifname.attr, | |
862 | NULL, | |
863 | }; | |
864 | ||
865 | static struct config_item_type ecm_func_type = { | |
866 | .ct_item_ops = &ecm_item_ops, | |
867 | .ct_attrs = ecm_attrs, | |
868 | .ct_owner = THIS_MODULE, | |
869 | }; | |
870 | ||
fee562a6 AP |
871 | static void ecm_free_inst(struct usb_function_instance *f) |
872 | { | |
873 | struct f_ecm_opts *opts; | |
874 | ||
875 | opts = container_of(f, struct f_ecm_opts, func_inst); | |
876 | if (opts->bound) | |
877 | gether_cleanup(netdev_priv(opts->net)); | |
878 | else | |
879 | free_netdev(opts->net); | |
880 | kfree(opts); | |
881 | } | |
882 | ||
883 | static struct usb_function_instance *ecm_alloc_inst(void) | |
884 | { | |
885 | struct f_ecm_opts *opts; | |
886 | ||
887 | opts = kzalloc(sizeof(*opts), GFP_KERNEL); | |
888 | if (!opts) | |
889 | return ERR_PTR(-ENOMEM); | |
da92801c | 890 | mutex_init(&opts->lock); |
fee562a6 AP |
891 | opts->func_inst.free_func_inst = ecm_free_inst; |
892 | opts->net = gether_setup_default(); | |
172d934c AP |
893 | if (IS_ERR(opts->net)) { |
894 | struct net_device *net = opts->net; | |
895 | kfree(opts); | |
896 | return ERR_CAST(net); | |
897 | } | |
fee562a6 | 898 | |
da92801c AP |
899 | config_group_init_type_name(&opts->func_inst.group, "", &ecm_func_type); |
900 | ||
fee562a6 AP |
901 | return &opts->func_inst; |
902 | } | |
903 | ||
904 | static void ecm_free(struct usb_function *f) | |
905 | { | |
906 | struct f_ecm *ecm; | |
da92801c | 907 | struct f_ecm_opts *opts; |
fee562a6 AP |
908 | |
909 | ecm = func_to_ecm(f); | |
da92801c | 910 | opts = container_of(f->fi, struct f_ecm_opts, func_inst); |
fee562a6 | 911 | kfree(ecm); |
da92801c AP |
912 | mutex_lock(&opts->lock); |
913 | opts->refcnt--; | |
914 | mutex_unlock(&opts->lock); | |
fee562a6 AP |
915 | } |
916 | ||
917 | static void ecm_unbind(struct usb_configuration *c, struct usb_function *f) | |
918 | { | |
919 | struct f_ecm *ecm = func_to_ecm(f); | |
920 | ||
921 | DBG(c->cdev, "ecm unbind\n"); | |
922 | ||
fee562a6 AP |
923 | usb_free_all_descriptors(f); |
924 | ||
925 | kfree(ecm->notify_req->buf); | |
926 | usb_ep_free_request(ecm->notify, ecm->notify_req); | |
927 | } | |
928 | ||
0f0392f2 | 929 | static struct usb_function *ecm_alloc(struct usb_function_instance *fi) |
fee562a6 AP |
930 | { |
931 | struct f_ecm *ecm; | |
932 | struct f_ecm_opts *opts; | |
933 | int status; | |
934 | ||
935 | /* allocate and initialize one new instance */ | |
936 | ecm = kzalloc(sizeof(*ecm), GFP_KERNEL); | |
937 | if (!ecm) | |
938 | return ERR_PTR(-ENOMEM); | |
939 | ||
940 | opts = container_of(fi, struct f_ecm_opts, func_inst); | |
da92801c AP |
941 | mutex_lock(&opts->lock); |
942 | opts->refcnt++; | |
fee562a6 AP |
943 | |
944 | /* export host's Ethernet address in CDC format */ | |
945 | status = gether_get_host_addr_cdc(opts->net, ecm->ethaddr, | |
946 | sizeof(ecm->ethaddr)); | |
947 | if (status < 12) { | |
948 | kfree(ecm); | |
2a98dbbc | 949 | mutex_unlock(&opts->lock); |
fee562a6 AP |
950 | return ERR_PTR(-EINVAL); |
951 | } | |
952 | ecm_string_defs[1].s = ecm->ethaddr; | |
953 | ||
954 | ecm->port.ioport = netdev_priv(opts->net); | |
da92801c | 955 | mutex_unlock(&opts->lock); |
fee562a6 AP |
956 | ecm->port.cdc_filter = DEFAULT_FILTER; |
957 | ||
958 | ecm->port.func.name = "cdc_ethernet"; | |
fee562a6 AP |
959 | /* descriptors are per-instance copies */ |
960 | ecm->port.func.bind = ecm_bind; | |
961 | ecm->port.func.unbind = ecm_unbind; | |
962 | ecm->port.func.set_alt = ecm_set_alt; | |
963 | ecm->port.func.get_alt = ecm_get_alt; | |
964 | ecm->port.func.setup = ecm_setup; | |
965 | ecm->port.func.disable = ecm_disable; | |
966 | ecm->port.func.free_func = ecm_free; | |
967 | ||
968 | return &ecm->port.func; | |
969 | } | |
970 | ||
971 | DECLARE_USB_FUNCTION_INIT(ecm, ecm_alloc_inst, ecm_alloc); | |
972 | MODULE_LICENSE("GPL"); | |
973 | MODULE_AUTHOR("David Brownell"); |