1 /*
2 * f_serial.c - generic USB serial function driver
3 *
4 * Copyright (C) 2003 Al Borchers (alborchers@steinerpoint.com)
5 * Copyright (C) 2008 by David Brownell
6 * Copyright (C) 2008 by Nokia Corporation
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.
11 */
12
13 #include <linux/slab.h>
14 #include <linux/kernel.h>
15 #include <linux/device.h>
16
17 #include "u_serial.h"
18 #include "gadget_chips.h"
19
20
21 /*
22 * This function packages a simple "generic serial" port with no real
23 * control mechanisms, just raw data transfer over two bulk endpoints.
24 *
25 * Because it's not standardized, this isn't as interoperable as the
26 * CDC ACM driver. However, for many purposes it's just as functional
27 * if you can arrange appropriate host side drivers.
28 */
29
30 struct f_gser {
31 struct gserial port;
32 u8 data_id;
33 u8 port_num;
34 };
35
func_to_gser(struct usb_function * f)36 static inline struct f_gser *func_to_gser(struct usb_function *f)
37 {
38 return container_of(f, struct f_gser, port.func);
39 }
40
41 /*-------------------------------------------------------------------------*/
42
43 /* interface descriptor: */
44
45 static struct usb_interface_descriptor gser_interface_desc __initdata = {
46 .bLength = USB_DT_INTERFACE_SIZE,
47 .bDescriptorType = USB_DT_INTERFACE,
48 /* .bInterfaceNumber = DYNAMIC */
49 .bNumEndpoints = 2,
50 .bInterfaceClass = USB_CLASS_VENDOR_SPEC,
51 .bInterfaceSubClass = 0,
52 .bInterfaceProtocol = 0,
53 /* .iInterface = DYNAMIC */
54 };
55
56 /* full speed support: */
57
58 static struct usb_endpoint_descriptor gser_fs_in_desc __initdata = {
59 .bLength = USB_DT_ENDPOINT_SIZE,
60 .bDescriptorType = USB_DT_ENDPOINT,
61 .bEndpointAddress = USB_DIR_IN,
62 .bmAttributes = USB_ENDPOINT_XFER_BULK,
63 };
64
65 static struct usb_endpoint_descriptor gser_fs_out_desc __initdata = {
66 .bLength = USB_DT_ENDPOINT_SIZE,
67 .bDescriptorType = USB_DT_ENDPOINT,
68 .bEndpointAddress = USB_DIR_OUT,
69 .bmAttributes = USB_ENDPOINT_XFER_BULK,
70 };
71
72 static struct usb_descriptor_header *gser_fs_function[] __initdata = {
73 (struct usb_descriptor_header *) &gser_interface_desc,
74 (struct usb_descriptor_header *) &gser_fs_in_desc,
75 (struct usb_descriptor_header *) &gser_fs_out_desc,
76 NULL,
77 };
78
79 /* high speed support: */
80
81 static struct usb_endpoint_descriptor gser_hs_in_desc __initdata = {
82 .bLength = USB_DT_ENDPOINT_SIZE,
83 .bDescriptorType = USB_DT_ENDPOINT,
84 .bmAttributes = USB_ENDPOINT_XFER_BULK,
85 .wMaxPacketSize = cpu_to_le16(512),
86 };
87
88 static struct usb_endpoint_descriptor gser_hs_out_desc __initdata = {
89 .bLength = USB_DT_ENDPOINT_SIZE,
90 .bDescriptorType = USB_DT_ENDPOINT,
91 .bmAttributes = USB_ENDPOINT_XFER_BULK,
92 .wMaxPacketSize = cpu_to_le16(512),
93 };
94
95 static struct usb_descriptor_header *gser_hs_function[] __initdata = {
96 (struct usb_descriptor_header *) &gser_interface_desc,
97 (struct usb_descriptor_header *) &gser_hs_in_desc,
98 (struct usb_descriptor_header *) &gser_hs_out_desc,
99 NULL,
100 };
101
102 static struct usb_endpoint_descriptor gser_ss_in_desc __initdata = {
103 .bLength = USB_DT_ENDPOINT_SIZE,
104 .bDescriptorType = USB_DT_ENDPOINT,
105 .bmAttributes = USB_ENDPOINT_XFER_BULK,
106 .wMaxPacketSize = cpu_to_le16(1024),
107 };
108
109 static struct usb_endpoint_descriptor gser_ss_out_desc __initdata = {
110 .bLength = USB_DT_ENDPOINT_SIZE,
111 .bDescriptorType = USB_DT_ENDPOINT,
112 .bmAttributes = USB_ENDPOINT_XFER_BULK,
113 .wMaxPacketSize = cpu_to_le16(1024),
114 };
115
116 static struct usb_ss_ep_comp_descriptor gser_ss_bulk_comp_desc __initdata = {
117 .bLength = sizeof gser_ss_bulk_comp_desc,
118 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
119 };
120
121 static struct usb_descriptor_header *gser_ss_function[] __initdata = {
122 (struct usb_descriptor_header *) &gser_interface_desc,
123 (struct usb_descriptor_header *) &gser_ss_in_desc,
124 (struct usb_descriptor_header *) &gser_ss_bulk_comp_desc,
125 (struct usb_descriptor_header *) &gser_ss_out_desc,
126 (struct usb_descriptor_header *) &gser_ss_bulk_comp_desc,
127 NULL,
128 };
129
130 /* string descriptors: */
131
132 static struct usb_string gser_string_defs[] = {
133 [0].s = "Generic Serial",
134 { } /* end of list */
135 };
136
137 static struct usb_gadget_strings gser_string_table = {
138 .language = 0x0409, /* en-us */
139 .strings = gser_string_defs,
140 };
141
142 static struct usb_gadget_strings *gser_strings[] = {
143 &gser_string_table,
144 NULL,
145 };
146
147 /*-------------------------------------------------------------------------*/
148
gser_set_alt(struct usb_function * f,unsigned intf,unsigned alt)149 static int gser_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
150 {
151 struct f_gser *gser = func_to_gser(f);
152 struct usb_composite_dev *cdev = f->config->cdev;
153
154 /* we know alt == 0, so this is an activation or a reset */
155
156 if (gser->port.in->driver_data) {
157 DBG(cdev, "reset generic ttyGS%d\n", gser->port_num);
158 gserial_disconnect(&gser->port);
159 }
160 if (!gser->port.in->desc || !gser->port.out->desc) {
161 DBG(cdev, "activate generic ttyGS%d\n", gser->port_num);
162 if (config_ep_by_speed(cdev->gadget, f, gser->port.in) ||
163 config_ep_by_speed(cdev->gadget, f, gser->port.out)) {
164 gser->port.in->desc = NULL;
165 gser->port.out->desc = NULL;
166 return -EINVAL;
167 }
168 }
169 gserial_connect(&gser->port, gser->port_num);
170 return 0;
171 }
172
gser_disable(struct usb_function * f)173 static void gser_disable(struct usb_function *f)
174 {
175 struct f_gser *gser = func_to_gser(f);
176 struct usb_composite_dev *cdev = f->config->cdev;
177
178 DBG(cdev, "generic ttyGS%d deactivated\n", gser->port_num);
179 gserial_disconnect(&gser->port);
180 }
181
182 /*-------------------------------------------------------------------------*/
183
184 /* serial function driver setup/binding */
185
186 static int __init
gser_bind(struct usb_configuration * c,struct usb_function * f)187 gser_bind(struct usb_configuration *c, struct usb_function *f)
188 {
189 struct usb_composite_dev *cdev = c->cdev;
190 struct f_gser *gser = func_to_gser(f);
191 int status;
192 struct usb_ep *ep;
193
194 /* allocate instance-specific interface IDs */
195 status = usb_interface_id(c, f);
196 if (status < 0)
197 goto fail;
198 gser->data_id = status;
199 gser_interface_desc.bInterfaceNumber = status;
200
201 status = -ENODEV;
202
203 /* allocate instance-specific endpoints */
204 ep = usb_ep_autoconfig(cdev->gadget, &gser_fs_in_desc);
205 if (!ep)
206 goto fail;
207 gser->port.in = ep;
208 ep->driver_data = cdev; /* claim */
209
210 ep = usb_ep_autoconfig(cdev->gadget, &gser_fs_out_desc);
211 if (!ep)
212 goto fail;
213 gser->port.out = ep;
214 ep->driver_data = cdev; /* claim */
215
216 /* copy descriptors, and track endpoint copies */
217 f->descriptors = usb_copy_descriptors(gser_fs_function);
218
219 /* support all relevant hardware speeds... we expect that when
220 * hardware is dual speed, all bulk-capable endpoints work at
221 * both speeds
222 */
223 if (gadget_is_dualspeed(c->cdev->gadget)) {
224 gser_hs_in_desc.bEndpointAddress =
225 gser_fs_in_desc.bEndpointAddress;
226 gser_hs_out_desc.bEndpointAddress =
227 gser_fs_out_desc.bEndpointAddress;
228
229 /* copy descriptors, and track endpoint copies */
230 f->hs_descriptors = usb_copy_descriptors(gser_hs_function);
231 }
232 if (gadget_is_superspeed(c->cdev->gadget)) {
233 gser_ss_in_desc.bEndpointAddress =
234 gser_fs_in_desc.bEndpointAddress;
235 gser_ss_out_desc.bEndpointAddress =
236 gser_fs_out_desc.bEndpointAddress;
237
238 /* copy descriptors, and track endpoint copies */
239 f->ss_descriptors = usb_copy_descriptors(gser_ss_function);
240 if (!f->ss_descriptors)
241 goto fail;
242 }
243
244 DBG(cdev, "generic ttyGS%d: %s speed IN/%s OUT/%s\n",
245 gser->port_num,
246 gadget_is_superspeed(c->cdev->gadget) ? "super" :
247 gadget_is_dualspeed(c->cdev->gadget) ? "dual" : "full",
248 gser->port.in->name, gser->port.out->name);
249 return 0;
250
251 fail:
252 /* we might as well release our claims on endpoints */
253 if (gser->port.out)
254 gser->port.out->driver_data = NULL;
255 if (gser->port.in)
256 gser->port.in->driver_data = NULL;
257
258 ERROR(cdev, "%s: can't bind, err %d\n", f->name, status);
259
260 return status;
261 }
262
263 static void
gser_unbind(struct usb_configuration * c,struct usb_function * f)264 gser_unbind(struct usb_configuration *c, struct usb_function *f)
265 {
266 if (gadget_is_dualspeed(c->cdev->gadget))
267 usb_free_descriptors(f->hs_descriptors);
268 if (gadget_is_superspeed(c->cdev->gadget))
269 usb_free_descriptors(f->ss_descriptors);
270 usb_free_descriptors(f->descriptors);
271 kfree(func_to_gser(f));
272 }
273
274 /**
275 * gser_bind_config - add a generic serial function to a configuration
276 * @c: the configuration to support the serial instance
277 * @port_num: /dev/ttyGS* port this interface will use
278 * Context: single threaded during gadget setup
279 *
280 * Returns zero on success, else negative errno.
281 *
282 * Caller must have called @gserial_setup() with enough ports to
283 * handle all the ones it binds. Caller is also responsible
284 * for calling @gserial_cleanup() before module unload.
285 */
gser_bind_config(struct usb_configuration * c,u8 port_num)286 int __init gser_bind_config(struct usb_configuration *c, u8 port_num)
287 {
288 struct f_gser *gser;
289 int status;
290
291 /* REVISIT might want instance-specific strings to help
292 * distinguish instances ...
293 */
294
295 /* maybe allocate device-global string ID */
296 if (gser_string_defs[0].id == 0) {
297 status = usb_string_id(c->cdev);
298 if (status < 0)
299 return status;
300 gser_string_defs[0].id = status;
301 }
302
303 /* allocate and initialize one new instance */
304 gser = kzalloc(sizeof *gser, GFP_KERNEL);
305 if (!gser)
306 return -ENOMEM;
307
308 gser->port_num = port_num;
309
310 gser->port.func.name = "gser";
311 gser->port.func.strings = gser_strings;
312 gser->port.func.bind = gser_bind;
313 gser->port.func.unbind = gser_unbind;
314 gser->port.func.set_alt = gser_set_alt;
315 gser->port.func.disable = gser_disable;
316
317 status = usb_add_function(c, &gser->port.func);
318 if (status)
319 kfree(gser);
320 return status;
321 }
322