Commit | Line | Data |
---|---|---|
1da177e4 | 1 | /* |
a7707adf | 2 | * serial.c -- USB gadget serial driver |
1da177e4 | 3 | * |
a7707adf DB |
4 | * Copyright (C) 2003 Al Borchers (alborchers@steinerpoint.com) |
5 | * Copyright (C) 2008 by David Brownell | |
7bb5ea54 | 6 | * Copyright (C) 2008 by Nokia Corporation |
1da177e4 LT |
7 | * |
8 | * This software is distributed under the terms of the GNU General | |
9 | * Public License ("GPL") as published by the Free Software Foundation, | |
10 | * either version 2 of that License or (at your option) any later version. | |
1da177e4 LT |
11 | */ |
12 | ||
1da177e4 | 13 | #include <linux/kernel.h> |
1da177e4 LT |
14 | #include <linux/device.h> |
15 | #include <linux/tty.h> | |
16 | #include <linux/tty_flip.h> | |
1da177e4 | 17 | |
a7707adf | 18 | #include "u_serial.h" |
1da177e4 LT |
19 | #include "gadget_chips.h" |
20 | ||
21 | ||
1da177e4 LT |
22 | /* Defines */ |
23 | ||
7bb5ea54 DB |
24 | #define GS_VERSION_STR "v2.4" |
25 | #define GS_VERSION_NUM 0x2400 | |
1da177e4 LT |
26 | |
27 | #define GS_LONG_NAME "Gadget Serial" | |
a7707adf DB |
28 | #define GS_VERSION_NAME GS_LONG_NAME " " GS_VERSION_STR |
29 | ||
7bb5ea54 | 30 | /*-------------------------------------------------------------------------*/ |
1da177e4 | 31 | |
4e9ba518 DB |
32 | /* |
33 | * Kbuild is not very cooperative with respect to linking separately | |
34 | * compiled library objects into one module. So for now we won't use | |
35 | * separate compilation ... ensuring init/exit sections work to shrink | |
36 | * the runtime footprint, and giving us at least some parts of what | |
37 | * a "gcc --combine ... part1.c part2.c part3.c ... " build would. | |
38 | */ | |
1d8fc251 | 39 | #define USBF_OBEX_INCLUDED |
3086775a | 40 | #include "f_obex.c" |
4e9ba518 DB |
41 | |
42 | /*-------------------------------------------------------------------------*/ | |
7d16e8d3 | 43 | USB_GADGET_COMPOSITE_OPTIONS(); |
4e9ba518 | 44 | |
1da177e4 | 45 | /* Thanks to NetChip Technologies for donating this product ID. |
7bb5ea54 DB |
46 | * |
47 | * DO NOT REUSE THESE IDs with a protocol-incompatible driver!! Ever!! | |
48 | * Instead: allocate your own, using normal USB-IF procedures. | |
49 | */ | |
1da177e4 LT |
50 | #define GS_VENDOR_ID 0x0525 /* NetChip */ |
51 | #define GS_PRODUCT_ID 0xa4a6 /* Linux-USB Serial Gadget */ | |
52 | #define GS_CDC_PRODUCT_ID 0xa4a7 /* ... as CDC-ACM */ | |
3086775a | 53 | #define GS_CDC_OBEX_PRODUCT_ID 0xa4a9 /* ... as CDC-OBEX */ |
1da177e4 | 54 | |
7bb5ea54 | 55 | /* string IDs are assigned dynamically */ |
1da177e4 | 56 | |
276e2e4f | 57 | #define STRING_DESCRIPTION_IDX USB_GADGET_FIRST_AVAIL_IDX |
a7707adf | 58 | |
7bb5ea54 | 59 | static struct usb_string strings_dev[] = { |
cc2683c3 | 60 | [USB_GADGET_MANUFACTURER_IDX].s = "", |
276e2e4f SAS |
61 | [USB_GADGET_PRODUCT_IDX].s = GS_VERSION_NAME, |
62 | [USB_GADGET_SERIAL_IDX].s = "", | |
7bb5ea54 | 63 | [STRING_DESCRIPTION_IDX].s = NULL /* updated; f(use_acm) */, |
1da177e4 LT |
64 | { } /* end of list */ |
65 | }; | |
66 | ||
7bb5ea54 DB |
67 | static struct usb_gadget_strings stringtab_dev = { |
68 | .language = 0x0409, /* en-us */ | |
69 | .strings = strings_dev, | |
1da177e4 LT |
70 | }; |
71 | ||
7bb5ea54 DB |
72 | static struct usb_gadget_strings *dev_strings[] = { |
73 | &stringtab_dev, | |
74 | NULL, | |
75 | }; | |
76 | ||
77 | static struct usb_device_descriptor device_desc = { | |
1da177e4 LT |
78 | .bLength = USB_DT_DEVICE_SIZE, |
79 | .bDescriptorType = USB_DT_DEVICE, | |
551509d2 | 80 | .bcdUSB = cpu_to_le16(0x0200), |
7bb5ea54 | 81 | /* .bDeviceClass = f(use_acm) */ |
1da177e4 LT |
82 | .bDeviceSubClass = 0, |
83 | .bDeviceProtocol = 0, | |
7bb5ea54 | 84 | /* .bMaxPacketSize0 = f(hardware) */ |
551509d2 | 85 | .idVendor = cpu_to_le16(GS_VENDOR_ID), |
7bb5ea54 | 86 | /* .idProduct = f(use_acm) */ |
5c4d46eb | 87 | .bcdDevice = cpu_to_le16(GS_VERSION_NUM), |
7bb5ea54 DB |
88 | /* .iManufacturer = DYNAMIC */ |
89 | /* .iProduct = DYNAMIC */ | |
90 | .bNumConfigurations = 1, | |
1da177e4 LT |
91 | }; |
92 | ||
7bb5ea54 DB |
93 | static struct usb_otg_descriptor otg_descriptor = { |
94 | .bLength = sizeof otg_descriptor, | |
1da177e4 | 95 | .bDescriptorType = USB_DT_OTG, |
1da177e4 | 96 | |
7bb5ea54 DB |
97 | /* REVISIT SRP-only hardware is possible, although |
98 | * it would not be called "OTG" ... | |
99 | */ | |
100 | .bmAttributes = USB_OTG_SRP | USB_OTG_HNP, | |
a7707adf DB |
101 | }; |
102 | ||
7bb5ea54 DB |
103 | static const struct usb_descriptor_header *otg_desc[] = { |
104 | (struct usb_descriptor_header *) &otg_descriptor, | |
a7707adf DB |
105 | NULL, |
106 | }; | |
1da177e4 | 107 | |
a7707adf | 108 | /*-------------------------------------------------------------------------*/ |
1da177e4 | 109 | |
a7707adf DB |
110 | /* Module */ |
111 | MODULE_DESCRIPTION(GS_VERSION_NAME); | |
112 | MODULE_AUTHOR("Al Borchers"); | |
113 | MODULE_AUTHOR("David Brownell"); | |
114 | MODULE_LICENSE("GPL"); | |
1da177e4 | 115 | |
90ab5ee9 | 116 | static bool use_acm = true; |
7bb5ea54 DB |
117 | module_param(use_acm, bool, 0); |
118 | MODULE_PARM_DESC(use_acm, "Use CDC ACM, default=yes"); | |
1da177e4 | 119 | |
90ab5ee9 | 120 | static bool use_obex = false; |
3086775a FB |
121 | module_param(use_obex, bool, 0); |
122 | MODULE_PARM_DESC(use_obex, "Use CDC OBEX, default=no"); | |
123 | ||
7bb5ea54 DB |
124 | static unsigned n_ports = 1; |
125 | module_param(n_ports, uint, 0); | |
126 | MODULE_PARM_DESC(n_ports, "number of ports to create, default=1"); | |
9079e91b | 127 | |
7bb5ea54 | 128 | /*-------------------------------------------------------------------------*/ |
19b10a88 | 129 | static unsigned char tty_lines[MAX_U_SERIAL_PORTS]; |
1da177e4 | 130 | |
48177cd8 SAS |
131 | static int __init serial_bind_obex_config(struct usb_configuration *c) |
132 | { | |
133 | unsigned i; | |
134 | int status = 0; | |
135 | ||
136 | for (i = 0; i < n_ports && status == 0; i++) | |
19b10a88 | 137 | status = obex_bind_config(c, tty_lines[i]); |
48177cd8 SAS |
138 | return status; |
139 | } | |
140 | ||
7bb5ea54 DB |
141 | static struct usb_configuration serial_config_driver = { |
142 | /* .label = f(use_acm) */ | |
7bb5ea54 DB |
143 | /* .bConfigurationValue = f(use_acm) */ |
144 | /* .iConfiguration = DYNAMIC */ | |
145 | .bmAttributes = USB_CONFIG_ATT_SELFPOWER, | |
7bb5ea54 DB |
146 | }; |
147 | ||
ff47f594 SAS |
148 | static struct usb_function_instance *fi_serial[MAX_U_SERIAL_PORTS]; |
149 | static struct usb_function *f_serial[MAX_U_SERIAL_PORTS]; | |
150 | ||
151 | static int serial_register_ports(struct usb_composite_dev *cdev, | |
152 | struct usb_configuration *c, const char *f_name) | |
19b10a88 SAS |
153 | { |
154 | int i; | |
ff47f594 SAS |
155 | int ret; |
156 | ||
157 | ret = usb_add_config_only(cdev, c); | |
158 | if (ret) | |
159 | goto out; | |
160 | ||
161 | for (i = 0; i < n_ports; i++) { | |
ff47f594 SAS |
162 | |
163 | fi_serial[i] = usb_get_function_instance(f_name); | |
164 | if (IS_ERR(fi_serial[i])) { | |
165 | ret = PTR_ERR(fi_serial[i]); | |
166 | goto fail; | |
167 | } | |
ff47f594 SAS |
168 | |
169 | f_serial[i] = usb_get_function(fi_serial[i]); | |
170 | if (IS_ERR(f_serial[i])) { | |
171 | ret = PTR_ERR(f_serial[i]); | |
172 | goto err_get_func; | |
173 | } | |
174 | ||
175 | ret = usb_add_function(c, f_serial[i]); | |
176 | if (ret) | |
177 | goto err_add_func; | |
178 | } | |
19b10a88 | 179 | |
19b10a88 | 180 | return 0; |
ff47f594 SAS |
181 | |
182 | err_add_func: | |
183 | usb_put_function(f_serial[i]); | |
184 | err_get_func: | |
185 | usb_put_function_instance(fi_serial[i]); | |
186 | ||
187 | fail: | |
188 | i--; | |
189 | while (i >= 0) { | |
190 | usb_remove_function(c, f_serial[i]); | |
191 | usb_put_function(f_serial[i]); | |
192 | usb_put_function_instance(fi_serial[i]); | |
193 | i--; | |
194 | } | |
195 | out: | |
196 | return ret; | |
19b10a88 SAS |
197 | } |
198 | ||
e12995ec | 199 | static int __init gs_bind(struct usb_composite_dev *cdev) |
1da177e4 | 200 | { |
7bb5ea54 | 201 | int status; |
c4ed4ac1 | 202 | int cur_line = 0; |
1da177e4 | 203 | |
70cc3c02 | 204 | if (use_obex) { |
c4ed4ac1 SAS |
205 | for (cur_line = 0; cur_line < n_ports; cur_line++) { |
206 | status = gserial_alloc_line(&tty_lines[cur_line]); | |
207 | if (status) | |
208 | goto fail; | |
209 | } | |
19b10a88 | 210 | } |
a7707adf | 211 | |
7bb5ea54 DB |
212 | /* Allocate string descriptor numbers ... note that string |
213 | * contents can be overridden by the composite_dev glue. | |
91e79c91 | 214 | */ |
1da177e4 | 215 | |
e1f15ccb | 216 | status = usb_string_ids_tab(cdev, strings_dev); |
7bb5ea54 DB |
217 | if (status < 0) |
218 | goto fail; | |
276e2e4f SAS |
219 | device_desc.iManufacturer = strings_dev[USB_GADGET_MANUFACTURER_IDX].id; |
220 | device_desc.iProduct = strings_dev[USB_GADGET_PRODUCT_IDX].id; | |
e1f15ccb | 221 | status = strings_dev[STRING_DESCRIPTION_IDX].id; |
7bb5ea54 | 222 | serial_config_driver.iConfiguration = status; |
1da177e4 | 223 | |
7bb5ea54 DB |
224 | if (gadget_is_otg(cdev->gadget)) { |
225 | serial_config_driver.descriptors = otg_desc; | |
226 | serial_config_driver.bmAttributes |= USB_CONFIG_ATT_WAKEUP; | |
1da177e4 | 227 | } |
9079e91b | 228 | |
7bb5ea54 | 229 | /* register our configuration */ |
ff47f594 SAS |
230 | if (use_acm) { |
231 | status = serial_register_ports(cdev, &serial_config_driver, | |
232 | "acm"); | |
233 | usb_ep_autoconfig_reset(cdev->gadget); | |
234 | } else if (use_obex) | |
48177cd8 SAS |
235 | status = usb_add_config(cdev, &serial_config_driver, |
236 | serial_bind_obex_config); | |
70cc3c02 AP |
237 | else { |
238 | status = serial_register_ports(cdev, &serial_config_driver, | |
239 | "gser"); | |
240 | } | |
7bb5ea54 DB |
241 | if (status < 0) |
242 | goto fail; | |
1da177e4 | 243 | |
7d16e8d3 | 244 | usb_composite_overwrite_options(cdev, &coverwrite); |
7bb5ea54 | 245 | INFO(cdev, "%s\n", GS_VERSION_NAME); |
1da177e4 | 246 | |
7bb5ea54 | 247 | return 0; |
1da177e4 | 248 | |
7bb5ea54 | 249 | fail: |
19b10a88 | 250 | cur_line--; |
70cc3c02 | 251 | while (cur_line >= 0 && use_obex) |
19b10a88 | 252 | gserial_free_line(tty_lines[cur_line--]); |
7bb5ea54 | 253 | return status; |
1da177e4 LT |
254 | } |
255 | ||
ff47f594 SAS |
256 | static int gs_unbind(struct usb_composite_dev *cdev) |
257 | { | |
258 | int i; | |
259 | ||
260 | for (i = 0; i < n_ports; i++) { | |
261 | usb_put_function(f_serial[i]); | |
262 | usb_put_function_instance(fi_serial[i]); | |
70cc3c02 | 263 | if (use_obex) |
c4ed4ac1 | 264 | gserial_free_line(tty_lines[i]); |
ff47f594 SAS |
265 | } |
266 | return 0; | |
267 | } | |
268 | ||
c2ec75c2 | 269 | static __refdata struct usb_composite_driver gserial_driver = { |
7bb5ea54 DB |
270 | .name = "g_serial", |
271 | .dev = &device_desc, | |
272 | .strings = dev_strings, | |
6fecfb05 | 273 | .max_speed = USB_SPEED_SUPER, |
03e42bd5 | 274 | .bind = gs_bind, |
19b10a88 | 275 | .unbind = gs_unbind, |
9079e91b DB |
276 | }; |
277 | ||
7bb5ea54 | 278 | static int __init init(void) |
1da177e4 | 279 | { |
7bb5ea54 DB |
280 | /* We *could* export two configs; that'd be much cleaner... |
281 | * but neither of these product IDs was defined that way. | |
f371e750 | 282 | */ |
1da177e4 | 283 | if (use_acm) { |
7bb5ea54 DB |
284 | serial_config_driver.label = "CDC ACM config"; |
285 | serial_config_driver.bConfigurationValue = 2; | |
286 | device_desc.bDeviceClass = USB_CLASS_COMM; | |
287 | device_desc.idProduct = | |
551509d2 | 288 | cpu_to_le16(GS_CDC_PRODUCT_ID); |
3086775a FB |
289 | } else if (use_obex) { |
290 | serial_config_driver.label = "CDC OBEX config"; | |
291 | serial_config_driver.bConfigurationValue = 3; | |
292 | device_desc.bDeviceClass = USB_CLASS_COMM; | |
293 | device_desc.idProduct = | |
551509d2 | 294 | cpu_to_le16(GS_CDC_OBEX_PRODUCT_ID); |
1da177e4 | 295 | } else { |
7bb5ea54 DB |
296 | serial_config_driver.label = "Generic Serial config"; |
297 | serial_config_driver.bConfigurationValue = 1; | |
298 | device_desc.bDeviceClass = USB_CLASS_VENDOR_SPEC; | |
299 | device_desc.idProduct = | |
551509d2 | 300 | cpu_to_le16(GS_PRODUCT_ID); |
1da177e4 | 301 | } |
7bb5ea54 | 302 | strings_dev[STRING_DESCRIPTION_IDX].s = serial_config_driver.label; |
9079e91b | 303 | |
03e42bd5 | 304 | return usb_composite_probe(&gserial_driver); |
9079e91b | 305 | } |
7bb5ea54 | 306 | module_init(init); |
9079e91b | 307 | |
7bb5ea54 | 308 | static void __exit cleanup(void) |
9079e91b | 309 | { |
7bb5ea54 | 310 | usb_composite_unregister(&gserial_driver); |
9079e91b | 311 | } |
7bb5ea54 | 312 | module_exit(cleanup); |