1 /*
2 * cdc2.c -- CDC Composite driver, with ECM and ACM support
3 *
4 * Copyright (C) 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.
11 */
12
13 #include <linux/kernel.h>
14 #include <linux/module.h>
15
16 #include "u_ether.h"
17 #include "u_serial.h"
18
19
20 #define DRIVER_DESC "CDC Composite Gadget"
21 #define DRIVER_VERSION "King Kamehameha Day 2008"
22
23 /*-------------------------------------------------------------------------*/
24
25 /* DO NOT REUSE THESE IDs with a protocol-incompatible driver!! Ever!!
26 * Instead: allocate your own, using normal USB-IF procedures.
27 */
28
29 /* Thanks to NetChip Technologies for donating this product ID.
30 * It's for devices with only this composite CDC configuration.
31 */
32 #define CDC_VENDOR_NUM 0x0525 /* NetChip */
33 #define CDC_PRODUCT_NUM 0xa4aa /* CDC Composite: ECM + ACM */
34
35 /*-------------------------------------------------------------------------*/
36 USB_GADGET_COMPOSITE_OPTIONS();
37
38 /*
39 * Kbuild is not very cooperative with respect to linking separately
40 * compiled library objects into one module. So for now we won't use
41 * separate compilation ... ensuring init/exit sections work to shrink
42 * the runtime footprint, and giving us at least some parts of what
43 * a "gcc --combine ... part1.c part2.c part3.c ... " build would.
44 */
45 #include "f_ecm.c"
46 #include "u_ether.c"
47
48 /*-------------------------------------------------------------------------*/
49
50 static struct usb_device_descriptor device_desc = {
51 .bLength = sizeof device_desc,
52 .bDescriptorType = USB_DT_DEVICE,
53
54 .bcdUSB = cpu_to_le16(0x0200),
55
56 .bDeviceClass = USB_CLASS_COMM,
57 .bDeviceSubClass = 0,
58 .bDeviceProtocol = 0,
59 /* .bMaxPacketSize0 = f(hardware) */
60
61 /* Vendor and product id can be overridden by module parameters. */
62 .idVendor = cpu_to_le16(CDC_VENDOR_NUM),
63 .idProduct = cpu_to_le16(CDC_PRODUCT_NUM),
64 /* .bcdDevice = f(hardware) */
65 /* .iManufacturer = DYNAMIC */
66 /* .iProduct = DYNAMIC */
67 /* NO SERIAL NUMBER */
68 .bNumConfigurations = 1,
69 };
70
71 static struct usb_otg_descriptor otg_descriptor = {
72 .bLength = sizeof otg_descriptor,
73 .bDescriptorType = USB_DT_OTG,
74
75 /* REVISIT SRP-only hardware is possible, although
76 * it would not be called "OTG" ...
77 */
78 .bmAttributes = USB_OTG_SRP | USB_OTG_HNP,
79 };
80
81 static const struct usb_descriptor_header *otg_desc[] = {
82 (struct usb_descriptor_header *) &otg_descriptor,
83 NULL,
84 };
85
86
87 /* string IDs are assigned dynamically */
88 static struct usb_string strings_dev[] = {
89 [USB_GADGET_MANUFACTURER_IDX].s = "",
90 [USB_GADGET_PRODUCT_IDX].s = DRIVER_DESC,
91 [USB_GADGET_SERIAL_IDX].s = "",
92 { } /* end of list */
93 };
94
95 static struct usb_gadget_strings stringtab_dev = {
96 .language = 0x0409, /* en-us */
97 .strings = strings_dev,
98 };
99
100 static struct usb_gadget_strings *dev_strings[] = {
101 &stringtab_dev,
102 NULL,
103 };
104
105 static u8 hostaddr[ETH_ALEN];
106 static struct eth_dev *the_dev;
107 /*-------------------------------------------------------------------------*/
108 static struct usb_function *f_acm;
109 static struct usb_function_instance *fi_serial;
110
111 /*
112 * We _always_ have both CDC ECM and CDC ACM functions.
113 */
cdc_do_config(struct usb_configuration * c)114 static int __init cdc_do_config(struct usb_configuration *c)
115 {
116 int status;
117
118 if (gadget_is_otg(c->cdev->gadget)) {
119 c->descriptors = otg_desc;
120 c->bmAttributes |= USB_CONFIG_ATT_WAKEUP;
121 }
122
123 status = ecm_bind_config(c, hostaddr, the_dev);
124 if (status < 0)
125 return status;
126
127 fi_serial = usb_get_function_instance("acm");
128 if (IS_ERR(fi_serial))
129 return PTR_ERR(fi_serial);
130
131 f_acm = usb_get_function(fi_serial);
132 if (IS_ERR(f_acm)) {
133 status = PTR_ERR(f_acm);
134 goto err_func_acm;
135 }
136
137 status = usb_add_function(c, f_acm);
138 if (status)
139 goto err_conf;
140 return 0;
141 err_conf:
142 usb_put_function(f_acm);
143 err_func_acm:
144 usb_put_function_instance(fi_serial);
145 return status;
146 }
147
148 static struct usb_configuration cdc_config_driver = {
149 .label = "CDC Composite (ECM + ACM)",
150 .bConfigurationValue = 1,
151 /* .iConfiguration = DYNAMIC */
152 .bmAttributes = USB_CONFIG_ATT_SELFPOWER,
153 };
154
155 /*-------------------------------------------------------------------------*/
156
cdc_bind(struct usb_composite_dev * cdev)157 static int __init cdc_bind(struct usb_composite_dev *cdev)
158 {
159 struct usb_gadget *gadget = cdev->gadget;
160 int status;
161
162 if (!can_support_ecm(cdev->gadget)) {
163 dev_err(&gadget->dev, "controller '%s' not usable\n",
164 gadget->name);
165 return -EINVAL;
166 }
167
168 /* set up network link layer */
169 the_dev = gether_setup(cdev->gadget, hostaddr);
170 if (IS_ERR(the_dev))
171 return PTR_ERR(the_dev);
172
173 /* Allocate string descriptor numbers ... note that string
174 * contents can be overridden by the composite_dev glue.
175 */
176
177 status = usb_string_ids_tab(cdev, strings_dev);
178 if (status < 0)
179 goto fail1;
180 device_desc.iManufacturer = strings_dev[USB_GADGET_MANUFACTURER_IDX].id;
181 device_desc.iProduct = strings_dev[USB_GADGET_PRODUCT_IDX].id;
182
183 /* register our configuration */
184 status = usb_add_config(cdev, &cdc_config_driver, cdc_do_config);
185 if (status < 0)
186 goto fail1;
187
188 usb_composite_overwrite_options(cdev, &coverwrite);
189 dev_info(&gadget->dev, "%s, version: " DRIVER_VERSION "\n",
190 DRIVER_DESC);
191
192 return 0;
193
194 fail1:
195 gether_cleanup(the_dev);
196 return status;
197 }
198
cdc_unbind(struct usb_composite_dev * cdev)199 static int __exit cdc_unbind(struct usb_composite_dev *cdev)
200 {
201 usb_put_function(f_acm);
202 usb_put_function_instance(fi_serial);
203 gether_cleanup(the_dev);
204 return 0;
205 }
206
207 static __refdata struct usb_composite_driver cdc_driver = {
208 .name = "g_cdc",
209 .dev = &device_desc,
210 .strings = dev_strings,
211 .max_speed = USB_SPEED_HIGH,
212 .bind = cdc_bind,
213 .unbind = __exit_p(cdc_unbind),
214 };
215
216 MODULE_DESCRIPTION(DRIVER_DESC);
217 MODULE_AUTHOR("David Brownell");
218 MODULE_LICENSE("GPL");
219
init(void)220 static int __init init(void)
221 {
222 return usb_composite_probe(&cdc_driver);
223 }
224 module_init(init);
225
cleanup(void)226 static void __exit cleanup(void)
227 {
228 usb_composite_unregister(&cdc_driver);
229 }
230 module_exit(cleanup);
231