2 * f_ecm.c -- USB CDC Ethernet (ECM) link function driver
4 * Copyright (C) 2003-2005,2008 David Brownell
5 * Copyright (C) 2008 Nokia Corporation
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.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 /* #define VERBOSE_DEBUG */
24 #include <linux/slab.h>
25 #include <linux/kernel.h>
26 #include <linux/device.h>
27 #include <linux/etherdevice.h>
33 * This function is a "CDC Ethernet Networking Control Model" (CDC ECM)
34 * Ethernet link. The data transfer model is simple (packets sent and
35 * received over bulk endpoints using normal short packet termination),
36 * and the control model exposes various data and optional notifications.
38 * ECM is well standardized and (except for Microsoft) supported by most
39 * operating systems with USB host support. It's the preferred interop
40 * solution for Ethernet over USB, at least for firmware based solutions.
41 * (Hardware solutions tend to be more minimalist.) A newer and simpler
42 * "Ethernet Emulation Model" (CDC EEM) hasn't yet caught on.
44 * Note that ECM requires the use of "alternate settings" for its data
45 * interface. This means that the set_alt() method has real work to do,
46 * and also means that a get_alt() method is required.
50 struct usb_endpoint_descriptor
*in
;
51 struct usb_endpoint_descriptor
*out
;
52 struct usb_endpoint_descriptor
*notify
;
55 enum ecm_notify_state
{
56 ECM_NOTIFY_NONE
, /* don't notify */
57 ECM_NOTIFY_CONNECT
, /* issue CONNECT next */
58 ECM_NOTIFY_SPEED
, /* issue SPEED_CHANGE next */
67 struct ecm_ep_descs fs
;
68 struct ecm_ep_descs hs
;
70 struct usb_ep
*notify
;
71 struct usb_endpoint_descriptor
*notify_desc
;
72 struct usb_request
*notify_req
;
76 /* FIXME is_open needs some irq-ish locking
77 * ... possibly the same as port.ioport
81 static inline struct f_ecm
*func_to_ecm(struct usb_function
*f
)
83 return container_of(f
, struct f_ecm
, port
.func
);
86 /* peak (theoretical) bulk transfer rate in bits-per-second */
87 static inline unsigned ecm_bitrate(struct usb_gadget
*g
)
89 if (gadget_is_dualspeed(g
) && g
->speed
== USB_SPEED_HIGH
)
90 return 13 * 512 * 8 * 1000 * 8;
92 return 19 * 64 * 1 * 1000 * 8;
95 /*-------------------------------------------------------------------------*/
98 * Include the status endpoint if we can, even though it's optional.
100 * Use wMaxPacketSize big enough to fit CDC_NOTIFY_SPEED_CHANGE in one
101 * packet, to simplify cancellation; and a big transfer interval, to
102 * waste less bandwidth.
104 * Some drivers (like Linux 2.4 cdc-ether!) "need" it to exist even
105 * if they ignore the connect/disconnect notifications that real aether
106 * can provide. More advanced cdc configurations might want to support
107 * encapsulated commands (vendor-specific, using control-OUT).
110 #define LOG2_STATUS_INTERVAL_MSEC 5 /* 1 << 5 == 32 msec */
111 #define ECM_STATUS_BYTECOUNT 16 /* 8 byte header + data */
114 /* interface descriptor: */
116 static struct usb_interface_descriptor ecm_control_intf __initdata
= {
117 .bLength
= sizeof ecm_control_intf
,
118 .bDescriptorType
= USB_DT_INTERFACE
,
120 /* .bInterfaceNumber = DYNAMIC */
121 /* status endpoint is optional; this could be patched later */
123 .bInterfaceClass
= USB_CLASS_COMM
,
124 .bInterfaceSubClass
= USB_CDC_SUBCLASS_ETHERNET
,
125 .bInterfaceProtocol
= USB_CDC_PROTO_NONE
,
126 /* .iInterface = DYNAMIC */
129 static struct usb_cdc_header_desc ecm_header_desc __initdata
= {
130 .bLength
= sizeof ecm_header_desc
,
131 .bDescriptorType
= USB_DT_CS_INTERFACE
,
132 .bDescriptorSubType
= USB_CDC_HEADER_TYPE
,
134 .bcdCDC
= cpu_to_le16(0x0110),
137 static struct usb_cdc_union_desc ecm_union_desc __initdata
= {
138 .bLength
= sizeof(ecm_union_desc
),
139 .bDescriptorType
= USB_DT_CS_INTERFACE
,
140 .bDescriptorSubType
= USB_CDC_UNION_TYPE
,
141 /* .bMasterInterface0 = DYNAMIC */
142 /* .bSlaveInterface0 = DYNAMIC */
145 static struct usb_cdc_ether_desc ecm_desc __initdata
= {
146 .bLength
= sizeof ecm_desc
,
147 .bDescriptorType
= USB_DT_CS_INTERFACE
,
148 .bDescriptorSubType
= USB_CDC_ETHERNET_TYPE
,
150 /* this descriptor actually adds value, surprise! */
151 /* .iMACAddress = DYNAMIC */
152 .bmEthernetStatistics
= cpu_to_le32(0), /* no statistics */
153 .wMaxSegmentSize
= cpu_to_le16(ETH_FRAME_LEN
),
154 .wNumberMCFilters
= cpu_to_le16(0),
155 .bNumberPowerFilters
= 0,
158 /* the default data interface has no endpoints ... */
160 static struct usb_interface_descriptor ecm_data_nop_intf __initdata
= {
161 .bLength
= sizeof ecm_data_nop_intf
,
162 .bDescriptorType
= USB_DT_INTERFACE
,
164 .bInterfaceNumber
= 1,
165 .bAlternateSetting
= 0,
167 .bInterfaceClass
= USB_CLASS_CDC_DATA
,
168 .bInterfaceSubClass
= 0,
169 .bInterfaceProtocol
= 0,
170 /* .iInterface = DYNAMIC */
173 /* ... but the "real" data interface has two bulk endpoints */
175 static struct usb_interface_descriptor ecm_data_intf __initdata
= {
176 .bLength
= sizeof ecm_data_intf
,
177 .bDescriptorType
= USB_DT_INTERFACE
,
179 .bInterfaceNumber
= 1,
180 .bAlternateSetting
= 1,
182 .bInterfaceClass
= USB_CLASS_CDC_DATA
,
183 .bInterfaceSubClass
= 0,
184 .bInterfaceProtocol
= 0,
185 /* .iInterface = DYNAMIC */
188 /* full speed support: */
190 static struct usb_endpoint_descriptor fs_ecm_notify_desc __initdata
= {
191 .bLength
= USB_DT_ENDPOINT_SIZE
,
192 .bDescriptorType
= USB_DT_ENDPOINT
,
194 .bEndpointAddress
= USB_DIR_IN
,
195 .bmAttributes
= USB_ENDPOINT_XFER_INT
,
196 .wMaxPacketSize
= cpu_to_le16(ECM_STATUS_BYTECOUNT
),
197 .bInterval
= 1 << LOG2_STATUS_INTERVAL_MSEC
,
200 static struct usb_endpoint_descriptor fs_ecm_in_desc __initdata
= {
201 .bLength
= USB_DT_ENDPOINT_SIZE
,
202 .bDescriptorType
= USB_DT_ENDPOINT
,
204 .bEndpointAddress
= USB_DIR_IN
,
205 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
208 static struct usb_endpoint_descriptor fs_ecm_out_desc __initdata
= {
209 .bLength
= USB_DT_ENDPOINT_SIZE
,
210 .bDescriptorType
= USB_DT_ENDPOINT
,
212 .bEndpointAddress
= USB_DIR_OUT
,
213 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
216 static struct usb_descriptor_header
*ecm_fs_function
[] __initdata
= {
217 /* CDC ECM control descriptors */
218 (struct usb_descriptor_header
*) &ecm_control_intf
,
219 (struct usb_descriptor_header
*) &ecm_header_desc
,
220 (struct usb_descriptor_header
*) &ecm_union_desc
,
221 (struct usb_descriptor_header
*) &ecm_desc
,
222 /* NOTE: status endpoint might need to be removed */
223 (struct usb_descriptor_header
*) &fs_ecm_notify_desc
,
224 /* data interface, altsettings 0 and 1 */
225 (struct usb_descriptor_header
*) &ecm_data_nop_intf
,
226 (struct usb_descriptor_header
*) &ecm_data_intf
,
227 (struct usb_descriptor_header
*) &fs_ecm_in_desc
,
228 (struct usb_descriptor_header
*) &fs_ecm_out_desc
,
232 /* high speed support: */
234 static struct usb_endpoint_descriptor hs_ecm_notify_desc __initdata
= {
235 .bLength
= USB_DT_ENDPOINT_SIZE
,
236 .bDescriptorType
= USB_DT_ENDPOINT
,
238 .bEndpointAddress
= USB_DIR_IN
,
239 .bmAttributes
= USB_ENDPOINT_XFER_INT
,
240 .wMaxPacketSize
= cpu_to_le16(ECM_STATUS_BYTECOUNT
),
241 .bInterval
= LOG2_STATUS_INTERVAL_MSEC
+ 4,
243 static struct usb_endpoint_descriptor hs_ecm_in_desc __initdata
= {
244 .bLength
= USB_DT_ENDPOINT_SIZE
,
245 .bDescriptorType
= USB_DT_ENDPOINT
,
247 .bEndpointAddress
= USB_DIR_IN
,
248 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
249 .wMaxPacketSize
= cpu_to_le16(512),
252 static struct usb_endpoint_descriptor hs_ecm_out_desc __initdata
= {
253 .bLength
= USB_DT_ENDPOINT_SIZE
,
254 .bDescriptorType
= USB_DT_ENDPOINT
,
256 .bEndpointAddress
= USB_DIR_OUT
,
257 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
258 .wMaxPacketSize
= cpu_to_le16(512),
261 static struct usb_descriptor_header
*ecm_hs_function
[] __initdata
= {
262 /* CDC ECM control descriptors */
263 (struct usb_descriptor_header
*) &ecm_control_intf
,
264 (struct usb_descriptor_header
*) &ecm_header_desc
,
265 (struct usb_descriptor_header
*) &ecm_union_desc
,
266 (struct usb_descriptor_header
*) &ecm_desc
,
267 /* NOTE: status endpoint might need to be removed */
268 (struct usb_descriptor_header
*) &hs_ecm_notify_desc
,
269 /* data interface, altsettings 0 and 1 */
270 (struct usb_descriptor_header
*) &ecm_data_nop_intf
,
271 (struct usb_descriptor_header
*) &ecm_data_intf
,
272 (struct usb_descriptor_header
*) &hs_ecm_in_desc
,
273 (struct usb_descriptor_header
*) &hs_ecm_out_desc
,
277 /* string descriptors: */
279 static struct usb_string ecm_string_defs
[] = {
280 [0].s
= "CDC Ethernet Control Model (ECM)",
281 [1].s
= NULL
/* DYNAMIC */,
282 [2].s
= "CDC Ethernet Data",
283 { } /* end of list */
286 static struct usb_gadget_strings ecm_string_table
= {
287 .language
= 0x0409, /* en-us */
288 .strings
= ecm_string_defs
,
291 static struct usb_gadget_strings
*ecm_strings
[] = {
296 /*-------------------------------------------------------------------------*/
298 static void ecm_do_notify(struct f_ecm
*ecm
)
300 struct usb_request
*req
= ecm
->notify_req
;
301 struct usb_cdc_notification
*event
;
302 struct usb_composite_dev
*cdev
= ecm
->port
.func
.config
->cdev
;
306 /* notification already in flight? */
311 switch (ecm
->notify_state
) {
312 case ECM_NOTIFY_NONE
:
315 case ECM_NOTIFY_CONNECT
:
316 event
->bNotificationType
= USB_CDC_NOTIFY_NETWORK_CONNECTION
;
318 event
->wValue
= cpu_to_le16(1);
320 event
->wValue
= cpu_to_le16(0);
322 req
->length
= sizeof *event
;
324 DBG(cdev
, "notify connect %s\n",
325 ecm
->is_open
? "true" : "false");
326 ecm
->notify_state
= ECM_NOTIFY_SPEED
;
329 case ECM_NOTIFY_SPEED
:
330 event
->bNotificationType
= USB_CDC_NOTIFY_SPEED_CHANGE
;
331 event
->wValue
= cpu_to_le16(0);
332 event
->wLength
= cpu_to_le16(8);
333 req
->length
= ECM_STATUS_BYTECOUNT
;
335 /* SPEED_CHANGE data is up/down speeds in bits/sec */
336 data
= req
->buf
+ sizeof *event
;
337 data
[0] = cpu_to_le32(ecm_bitrate(cdev
->gadget
));
340 DBG(cdev
, "notify speed %d\n", ecm_bitrate(cdev
->gadget
));
341 ecm
->notify_state
= ECM_NOTIFY_NONE
;
344 event
->bmRequestType
= 0xA1;
345 event
->wIndex
= cpu_to_le16(ecm
->ctrl_id
);
347 ecm
->notify_req
= NULL
;
348 status
= usb_ep_queue(ecm
->notify
, req
, GFP_ATOMIC
);
350 ecm
->notify_req
= req
;
351 DBG(cdev
, "notify --> %d\n", status
);
355 static void ecm_notify(struct f_ecm
*ecm
)
357 /* NOTE on most versions of Linux, host side cdc-ethernet
358 * won't listen for notifications until its netdevice opens.
359 * The first notification then sits in the FIFO for a long
360 * time, and the second one is queued.
362 ecm
->notify_state
= ECM_NOTIFY_CONNECT
;
366 static void ecm_notify_complete(struct usb_ep
*ep
, struct usb_request
*req
)
368 struct f_ecm
*ecm
= req
->context
;
369 struct usb_composite_dev
*cdev
= ecm
->port
.func
.config
->cdev
;
370 struct usb_cdc_notification
*event
= req
->buf
;
372 switch (req
->status
) {
378 ecm
->notify_state
= ECM_NOTIFY_NONE
;
381 DBG(cdev
, "event %02x --> %d\n",
382 event
->bNotificationType
, req
->status
);
385 ecm
->notify_req
= req
;
389 static int ecm_setup(struct usb_function
*f
, const struct usb_ctrlrequest
*ctrl
)
391 struct f_ecm
*ecm
= func_to_ecm(f
);
392 struct usb_composite_dev
*cdev
= f
->config
->cdev
;
393 struct usb_request
*req
= cdev
->req
;
394 int value
= -EOPNOTSUPP
;
395 u16 w_index
= le16_to_cpu(ctrl
->wIndex
);
396 u16 w_value
= le16_to_cpu(ctrl
->wValue
);
397 u16 w_length
= le16_to_cpu(ctrl
->wLength
);
399 /* composite driver infrastructure handles everything except
400 * CDC class messages; interface activation uses set_alt().
402 switch ((ctrl
->bRequestType
<< 8) | ctrl
->bRequest
) {
403 case ((USB_DIR_OUT
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
) << 8)
404 | USB_CDC_SET_ETHERNET_PACKET_FILTER
:
405 /* see 6.2.30: no data, wIndex = interface,
406 * wValue = packet filter bitmap
408 if (w_length
!= 0 || w_index
!= ecm
->ctrl_id
)
410 DBG(cdev
, "packet filter %02x\n", w_value
);
411 /* REVISIT locking of cdc_filter. This assumes the UDC
412 * driver won't have a concurrent packet TX irq running on
413 * another CPU; or that if it does, this write is atomic...
415 ecm
->port
.cdc_filter
= w_value
;
420 * case USB_CDC_SEND_ENCAPSULATED_COMMAND:
421 * case USB_CDC_GET_ENCAPSULATED_RESPONSE:
422 * case USB_CDC_SET_ETHERNET_MULTICAST_FILTERS:
423 * case USB_CDC_SET_ETHERNET_PM_PATTERN_FILTER:
424 * case USB_CDC_GET_ETHERNET_PM_PATTERN_FILTER:
425 * case USB_CDC_GET_ETHERNET_STATISTIC:
430 DBG(cdev
, "invalid control req%02x.%02x v%04x i%04x l%d\n",
431 ctrl
->bRequestType
, ctrl
->bRequest
,
432 w_value
, w_index
, w_length
);
435 /* respond with data transfer or status phase? */
437 DBG(cdev
, "ecm req%02x.%02x v%04x i%04x l%d\n",
438 ctrl
->bRequestType
, ctrl
->bRequest
,
439 w_value
, w_index
, w_length
);
442 value
= usb_ep_queue(cdev
->gadget
->ep0
, req
, GFP_ATOMIC
);
444 ERROR(cdev
, "ecm req %02x.%02x response err %d\n",
445 ctrl
->bRequestType
, ctrl
->bRequest
,
449 /* device either stalls (value < 0) or reports success */
454 static int ecm_set_alt(struct usb_function
*f
, unsigned intf
, unsigned alt
)
456 struct f_ecm
*ecm
= func_to_ecm(f
);
457 struct usb_composite_dev
*cdev
= f
->config
->cdev
;
459 /* Control interface has only altsetting 0 */
460 if (intf
== ecm
->ctrl_id
) {
464 if (ecm
->notify
->driver_data
) {
465 VDBG(cdev
, "reset ecm control %d\n", intf
);
466 usb_ep_disable(ecm
->notify
);
468 VDBG(cdev
, "init ecm ctrl %d\n", intf
);
469 ecm
->notify_desc
= ep_choose(cdev
->gadget
,
473 usb_ep_enable(ecm
->notify
, ecm
->notify_desc
);
474 ecm
->notify
->driver_data
= ecm
;
476 /* Data interface has two altsettings, 0 and 1 */
477 } else if (intf
== ecm
->data_id
) {
481 if (ecm
->port
.in_ep
->driver_data
) {
482 DBG(cdev
, "reset ecm\n");
483 gether_disconnect(&ecm
->port
);
487 DBG(cdev
, "init ecm\n");
488 ecm
->port
.in
= ep_choose(cdev
->gadget
,
489 ecm
->hs
.in
, ecm
->fs
.in
);
490 ecm
->port
.out
= ep_choose(cdev
->gadget
,
491 ecm
->hs
.out
, ecm
->fs
.out
);
494 /* CDC Ethernet only sends data in non-default altsettings.
495 * Changing altsettings resets filters, statistics, etc.
498 struct net_device
*net
;
500 /* Enable zlps by default for ECM conformance;
501 * override for musb_hdrc (avoids txdma ovhead).
503 ecm
->port
.is_zlp_ok
= !(gadget_is_musbhdrc(cdev
->gadget
)
505 ecm
->port
.cdc_filter
= DEFAULT_FILTER
;
506 DBG(cdev
, "activate ecm\n");
507 net
= gether_connect(&ecm
->port
);
512 /* NOTE this can be a minor disagreement with the ECM spec,
513 * which says speed notifications will "always" follow
514 * connection notifications. But we allow one connect to
515 * follow another (if the first is in flight), and instead
516 * just guarantee that a speed notification is always sent.
527 /* Because the data interface supports multiple altsettings,
528 * this ECM function *MUST* implement a get_alt() method.
530 static int ecm_get_alt(struct usb_function
*f
, unsigned intf
)
532 struct f_ecm
*ecm
= func_to_ecm(f
);
534 if (intf
== ecm
->ctrl_id
)
536 return ecm
->port
.in_ep
->driver_data
? 1 : 0;
539 static void ecm_disable(struct usb_function
*f
)
541 struct f_ecm
*ecm
= func_to_ecm(f
);
542 struct usb_composite_dev
*cdev
= f
->config
->cdev
;
544 DBG(cdev
, "ecm deactivated\n");
546 if (ecm
->port
.in_ep
->driver_data
)
547 gether_disconnect(&ecm
->port
);
549 if (ecm
->notify
->driver_data
) {
550 usb_ep_disable(ecm
->notify
);
551 ecm
->notify
->driver_data
= NULL
;
552 ecm
->notify_desc
= NULL
;
556 /*-------------------------------------------------------------------------*/
559 * Callbacks let us notify the host about connect/disconnect when the
560 * net device is opened or closed.
562 * For testing, note that link states on this side include both opened
563 * and closed variants of:
565 * - disconnected/unconfigured
566 * - configured but inactive (data alt 0)
567 * - configured and active (data alt 1)
569 * Each needs to be tested with unplug, rmmod, SET_CONFIGURATION, and
570 * SET_INTERFACE (altsetting). Remember also that "configured" doesn't
571 * imply the host is actually polling the notification endpoint, and
572 * likewise that "active" doesn't imply it's actually using the data
573 * endpoints for traffic.
576 static void ecm_open(struct gether
*geth
)
578 struct f_ecm
*ecm
= func_to_ecm(&geth
->func
);
580 DBG(ecm
->port
.func
.config
->cdev
, "%s\n", __func__
);
586 static void ecm_close(struct gether
*geth
)
588 struct f_ecm
*ecm
= func_to_ecm(&geth
->func
);
590 DBG(ecm
->port
.func
.config
->cdev
, "%s\n", __func__
);
592 ecm
->is_open
= false;
596 /*-------------------------------------------------------------------------*/
598 /* ethernet function driver setup/binding */
601 ecm_bind(struct usb_configuration
*c
, struct usb_function
*f
)
603 struct usb_composite_dev
*cdev
= c
->cdev
;
604 struct f_ecm
*ecm
= func_to_ecm(f
);
608 /* allocate instance-specific interface IDs */
609 status
= usb_interface_id(c
, f
);
612 ecm
->ctrl_id
= status
;
614 ecm_control_intf
.bInterfaceNumber
= status
;
615 ecm_union_desc
.bMasterInterface0
= status
;
617 status
= usb_interface_id(c
, f
);
620 ecm
->data_id
= status
;
622 ecm_data_nop_intf
.bInterfaceNumber
= status
;
623 ecm_data_intf
.bInterfaceNumber
= status
;
624 ecm_union_desc
.bSlaveInterface0
= status
;
628 /* allocate instance-specific endpoints */
629 ep
= usb_ep_autoconfig(cdev
->gadget
, &fs_ecm_in_desc
);
632 ecm
->port
.in_ep
= ep
;
633 ep
->driver_data
= cdev
; /* claim */
635 ep
= usb_ep_autoconfig(cdev
->gadget
, &fs_ecm_out_desc
);
638 ecm
->port
.out_ep
= ep
;
639 ep
->driver_data
= cdev
; /* claim */
641 /* NOTE: a status/notification endpoint is *OPTIONAL* but we
642 * don't treat it that way. It's simpler, and some newer CDC
643 * profiles (wireless handsets) no longer treat it as optional.
645 ep
= usb_ep_autoconfig(cdev
->gadget
, &fs_ecm_notify_desc
);
649 ep
->driver_data
= cdev
; /* claim */
653 /* allocate notification request and buffer */
654 ecm
->notify_req
= usb_ep_alloc_request(ep
, GFP_KERNEL
);
655 if (!ecm
->notify_req
)
657 ecm
->notify_req
->buf
= kmalloc(ECM_STATUS_BYTECOUNT
, GFP_KERNEL
);
658 if (!ecm
->notify_req
->buf
)
660 ecm
->notify_req
->context
= ecm
;
661 ecm
->notify_req
->complete
= ecm_notify_complete
;
663 /* copy descriptors, and track endpoint copies */
664 f
->descriptors
= usb_copy_descriptors(ecm_fs_function
);
668 ecm
->fs
.in
= usb_find_endpoint(ecm_fs_function
,
669 f
->descriptors
, &fs_ecm_in_desc
);
670 ecm
->fs
.out
= usb_find_endpoint(ecm_fs_function
,
671 f
->descriptors
, &fs_ecm_out_desc
);
672 ecm
->fs
.notify
= usb_find_endpoint(ecm_fs_function
,
673 f
->descriptors
, &fs_ecm_notify_desc
);
675 /* support all relevant hardware speeds... we expect that when
676 * hardware is dual speed, all bulk-capable endpoints work at
679 if (gadget_is_dualspeed(c
->cdev
->gadget
)) {
680 hs_ecm_in_desc
.bEndpointAddress
=
681 fs_ecm_in_desc
.bEndpointAddress
;
682 hs_ecm_out_desc
.bEndpointAddress
=
683 fs_ecm_out_desc
.bEndpointAddress
;
684 hs_ecm_notify_desc
.bEndpointAddress
=
685 fs_ecm_notify_desc
.bEndpointAddress
;
687 /* copy descriptors, and track endpoint copies */
688 f
->hs_descriptors
= usb_copy_descriptors(ecm_hs_function
);
689 if (!f
->hs_descriptors
)
692 ecm
->hs
.in
= usb_find_endpoint(ecm_hs_function
,
693 f
->hs_descriptors
, &hs_ecm_in_desc
);
694 ecm
->hs
.out
= usb_find_endpoint(ecm_hs_function
,
695 f
->hs_descriptors
, &hs_ecm_out_desc
);
696 ecm
->hs
.notify
= usb_find_endpoint(ecm_hs_function
,
697 f
->hs_descriptors
, &hs_ecm_notify_desc
);
700 /* NOTE: all that is done without knowing or caring about
701 * the network link ... which is unavailable to this code
702 * until we're activated via set_alt().
705 ecm
->port
.open
= ecm_open
;
706 ecm
->port
.close
= ecm_close
;
708 DBG(cdev
, "CDC Ethernet: %s speed IN/%s OUT/%s NOTIFY/%s\n",
709 gadget_is_dualspeed(c
->cdev
->gadget
) ? "dual" : "full",
710 ecm
->port
.in_ep
->name
, ecm
->port
.out_ep
->name
,
716 usb_free_descriptors(f
->descriptors
);
718 if (ecm
->notify_req
) {
719 kfree(ecm
->notify_req
->buf
);
720 usb_ep_free_request(ecm
->notify
, ecm
->notify_req
);
723 /* we might as well release our claims on endpoints */
725 ecm
->notify
->driver_data
= NULL
;
727 ecm
->port
.out_ep
->driver_data
= NULL
;
729 ecm
->port
.in_ep
->driver_data
= NULL
;
731 ERROR(cdev
, "%s: can't bind, err %d\n", f
->name
, status
);
737 ecm_unbind(struct usb_configuration
*c
, struct usb_function
*f
)
739 struct f_ecm
*ecm
= func_to_ecm(f
);
741 DBG(c
->cdev
, "ecm unbind\n");
743 if (gadget_is_dualspeed(c
->cdev
->gadget
))
744 usb_free_descriptors(f
->hs_descriptors
);
745 usb_free_descriptors(f
->descriptors
);
747 kfree(ecm
->notify_req
->buf
);
748 usb_ep_free_request(ecm
->notify
, ecm
->notify_req
);
750 ecm_string_defs
[1].s
= NULL
;
755 * ecm_bind_config - add CDC Ethernet network link to a configuration
756 * @c: the configuration to support the network link
757 * @ethaddr: a buffer in which the ethernet address of the host side
758 * side of the link was recorded
759 * Context: single threaded during gadget setup
761 * Returns zero on success, else negative errno.
763 * Caller must have called @gether_setup(). Caller is also responsible
764 * for calling @gether_cleanup() before module unload.
766 int __init
ecm_bind_config(struct usb_configuration
*c
, u8 ethaddr
[ETH_ALEN
])
771 if (!can_support_ecm(c
->cdev
->gadget
) || !ethaddr
)
774 /* maybe allocate device-global string IDs */
775 if (ecm_string_defs
[0].id
== 0) {
777 /* control interface label */
778 status
= usb_string_id(c
->cdev
);
781 ecm_string_defs
[0].id
= status
;
782 ecm_control_intf
.iInterface
= status
;
784 /* data interface label */
785 status
= usb_string_id(c
->cdev
);
788 ecm_string_defs
[2].id
= status
;
789 ecm_data_intf
.iInterface
= status
;
792 status
= usb_string_id(c
->cdev
);
795 ecm_string_defs
[1].id
= status
;
796 ecm_desc
.iMACAddress
= status
;
799 /* allocate and initialize one new instance */
800 ecm
= kzalloc(sizeof *ecm
, GFP_KERNEL
);
804 /* export host's Ethernet address in CDC format */
805 snprintf(ecm
->ethaddr
, sizeof ecm
->ethaddr
,
806 "%02X%02X%02X%02X%02X%02X",
807 ethaddr
[0], ethaddr
[1], ethaddr
[2],
808 ethaddr
[3], ethaddr
[4], ethaddr
[5]);
809 ecm_string_defs
[1].s
= ecm
->ethaddr
;
811 ecm
->port
.cdc_filter
= DEFAULT_FILTER
;
813 ecm
->port
.func
.name
= "cdc_ethernet";
814 ecm
->port
.func
.strings
= ecm_strings
;
815 /* descriptors are per-instance copies */
816 ecm
->port
.func
.bind
= ecm_bind
;
817 ecm
->port
.func
.unbind
= ecm_unbind
;
818 ecm
->port
.func
.set_alt
= ecm_set_alt
;
819 ecm
->port
.func
.get_alt
= ecm_get_alt
;
820 ecm
->port
.func
.setup
= ecm_setup
;
821 ecm
->port
.func
.disable
= ecm_disable
;
823 status
= usb_add_function(c
, &ecm
->port
.func
);
825 ecm_string_defs
[1].s
= NULL
;