Commit | Line | Data |
---|---|---|
4d5a73dc DB |
1 | /* |
2 | * f_acm.c -- USB CDC serial (ACM) 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 | |
b97503ff | 7 | * Copyright (C) 2009 by Samsung Electronics |
54b8360f | 8 | * Author: Michal Nazarewicz (mina86@mina86.com) |
4d5a73dc DB |
9 | * |
10 | * This software is distributed under the terms of the GNU General | |
11 | * Public License ("GPL") as published by the Free Software Foundation, | |
12 | * either version 2 of that License or (at your option) any later version. | |
13 | */ | |
14 | ||
15 | /* #define VERBOSE_DEBUG */ | |
16 | ||
5a0e3ad6 | 17 | #include <linux/slab.h> |
4d5a73dc | 18 | #include <linux/kernel.h> |
ff47f594 | 19 | #include <linux/module.h> |
4d5a73dc | 20 | #include <linux/device.h> |
ff47f594 | 21 | #include <linux/err.h> |
4d5a73dc DB |
22 | |
23 | #include "u_serial.h" | |
24 | #include "gadget_chips.h" | |
25 | ||
26 | ||
27 | /* | |
28 | * This CDC ACM function support just wraps control functions and | |
29 | * notifications around the generic serial-over-usb code. | |
30 | * | |
31 | * Because CDC ACM is standardized by the USB-IF, many host operating | |
32 | * systems have drivers for it. Accordingly, ACM is the preferred | |
33 | * interop solution for serial-port type connections. The control | |
34 | * models are often not necessary, and in any case don't do much in | |
35 | * this bare-bones implementation. | |
36 | * | |
37 | * Note that even MS-Windows has some support for ACM. However, that | |
38 | * support is somewhat broken because when you use ACM in a composite | |
39 | * device, having multiple interfaces confuses the poor OS. It doesn't | |
40 | * seem to understand CDC Union descriptors. The new "association" | |
41 | * descriptors (roughly equivalent to CDC Unions) may sometimes help. | |
42 | */ | |
43 | ||
4d5a73dc DB |
44 | struct f_acm { |
45 | struct gserial port; | |
46 | u8 ctrl_id, data_id; | |
47 | u8 port_num; | |
48 | ||
1f1ba11b DB |
49 | u8 pending; |
50 | ||
51 | /* lock is mostly for pending and notify_req ... they get accessed | |
52 | * by callbacks both from tty (open/close/break) under its spinlock, | |
53 | * and notify_req.complete() which can't use that lock. | |
54 | */ | |
55 | spinlock_t lock; | |
56 | ||
4d5a73dc | 57 | struct usb_ep *notify; |
1f1ba11b | 58 | struct usb_request *notify_req; |
4d5a73dc DB |
59 | |
60 | struct usb_cdc_line_coding port_line_coding; /* 8-N-1 etc */ | |
1f1ba11b DB |
61 | |
62 | /* SetControlLineState request -- CDC 1.1 section 6.2.14 (INPUT) */ | |
4d5a73dc | 63 | u16 port_handshake_bits; |
1f1ba11b DB |
64 | #define ACM_CTRL_RTS (1 << 1) /* unused with full duplex */ |
65 | #define ACM_CTRL_DTR (1 << 0) /* host is ready for data r/w */ | |
66 | ||
67 | /* SerialState notification -- CDC 1.1 section 6.3.5 (OUTPUT) */ | |
68 | u16 serial_state; | |
69 | #define ACM_CTRL_OVERRUN (1 << 6) | |
70 | #define ACM_CTRL_PARITY (1 << 5) | |
71 | #define ACM_CTRL_FRAMING (1 << 4) | |
72 | #define ACM_CTRL_RI (1 << 3) | |
73 | #define ACM_CTRL_BRK (1 << 2) | |
74 | #define ACM_CTRL_DSR (1 << 1) | |
75 | #define ACM_CTRL_DCD (1 << 0) | |
4d5a73dc DB |
76 | }; |
77 | ||
78 | static inline struct f_acm *func_to_acm(struct usb_function *f) | |
79 | { | |
80 | return container_of(f, struct f_acm, port.func); | |
81 | } | |
82 | ||
1f1ba11b DB |
83 | static inline struct f_acm *port_to_acm(struct gserial *p) |
84 | { | |
85 | return container_of(p, struct f_acm, port); | |
86 | } | |
87 | ||
4d5a73dc DB |
88 | /*-------------------------------------------------------------------------*/ |
89 | ||
90 | /* notification endpoint uses smallish and infrequent fixed-size messages */ | |
91 | ||
bcb2f99c | 92 | #define GS_NOTIFY_INTERVAL_MS 32 |
1f1ba11b | 93 | #define GS_NOTIFY_MAXPACKET 10 /* notification + 2 bytes */ |
4d5a73dc DB |
94 | |
95 | /* interface and class descriptors: */ | |
96 | ||
b97503ff MN |
97 | static struct usb_interface_assoc_descriptor |
98 | acm_iad_descriptor = { | |
99 | .bLength = sizeof acm_iad_descriptor, | |
100 | .bDescriptorType = USB_DT_INTERFACE_ASSOCIATION, | |
101 | ||
102 | /* .bFirstInterface = DYNAMIC, */ | |
103 | .bInterfaceCount = 2, // control + data | |
104 | .bFunctionClass = USB_CLASS_COMM, | |
105 | .bFunctionSubClass = USB_CDC_SUBCLASS_ACM, | |
5c8db070 | 106 | .bFunctionProtocol = USB_CDC_ACM_PROTO_AT_V25TER, |
b97503ff MN |
107 | /* .iFunction = DYNAMIC */ |
108 | }; | |
109 | ||
110 | ||
28824b18 | 111 | static struct usb_interface_descriptor acm_control_interface_desc = { |
4d5a73dc DB |
112 | .bLength = USB_DT_INTERFACE_SIZE, |
113 | .bDescriptorType = USB_DT_INTERFACE, | |
114 | /* .bInterfaceNumber = DYNAMIC */ | |
115 | .bNumEndpoints = 1, | |
116 | .bInterfaceClass = USB_CLASS_COMM, | |
117 | .bInterfaceSubClass = USB_CDC_SUBCLASS_ACM, | |
118 | .bInterfaceProtocol = USB_CDC_ACM_PROTO_AT_V25TER, | |
119 | /* .iInterface = DYNAMIC */ | |
120 | }; | |
121 | ||
28824b18 | 122 | static struct usb_interface_descriptor acm_data_interface_desc = { |
4d5a73dc DB |
123 | .bLength = USB_DT_INTERFACE_SIZE, |
124 | .bDescriptorType = USB_DT_INTERFACE, | |
125 | /* .bInterfaceNumber = DYNAMIC */ | |
126 | .bNumEndpoints = 2, | |
127 | .bInterfaceClass = USB_CLASS_CDC_DATA, | |
128 | .bInterfaceSubClass = 0, | |
129 | .bInterfaceProtocol = 0, | |
130 | /* .iInterface = DYNAMIC */ | |
131 | }; | |
132 | ||
28824b18 | 133 | static struct usb_cdc_header_desc acm_header_desc = { |
4d5a73dc DB |
134 | .bLength = sizeof(acm_header_desc), |
135 | .bDescriptorType = USB_DT_CS_INTERFACE, | |
136 | .bDescriptorSubType = USB_CDC_HEADER_TYPE, | |
551509d2 | 137 | .bcdCDC = cpu_to_le16(0x0110), |
4d5a73dc DB |
138 | }; |
139 | ||
140 | static struct usb_cdc_call_mgmt_descriptor | |
28824b18 | 141 | acm_call_mgmt_descriptor = { |
4d5a73dc DB |
142 | .bLength = sizeof(acm_call_mgmt_descriptor), |
143 | .bDescriptorType = USB_DT_CS_INTERFACE, | |
144 | .bDescriptorSubType = USB_CDC_CALL_MANAGEMENT_TYPE, | |
145 | .bmCapabilities = 0, | |
146 | /* .bDataInterface = DYNAMIC */ | |
147 | }; | |
148 | ||
28824b18 | 149 | static struct usb_cdc_acm_descriptor acm_descriptor = { |
4d5a73dc DB |
150 | .bLength = sizeof(acm_descriptor), |
151 | .bDescriptorType = USB_DT_CS_INTERFACE, | |
152 | .bDescriptorSubType = USB_CDC_ACM_TYPE, | |
1f1ba11b | 153 | .bmCapabilities = USB_CDC_CAP_LINE, |
4d5a73dc DB |
154 | }; |
155 | ||
28824b18 | 156 | static struct usb_cdc_union_desc acm_union_desc = { |
4d5a73dc DB |
157 | .bLength = sizeof(acm_union_desc), |
158 | .bDescriptorType = USB_DT_CS_INTERFACE, | |
159 | .bDescriptorSubType = USB_CDC_UNION_TYPE, | |
160 | /* .bMasterInterface0 = DYNAMIC */ | |
161 | /* .bSlaveInterface0 = DYNAMIC */ | |
162 | }; | |
163 | ||
164 | /* full speed support: */ | |
165 | ||
28824b18 | 166 | static struct usb_endpoint_descriptor acm_fs_notify_desc = { |
4d5a73dc DB |
167 | .bLength = USB_DT_ENDPOINT_SIZE, |
168 | .bDescriptorType = USB_DT_ENDPOINT, | |
169 | .bEndpointAddress = USB_DIR_IN, | |
170 | .bmAttributes = USB_ENDPOINT_XFER_INT, | |
551509d2 | 171 | .wMaxPacketSize = cpu_to_le16(GS_NOTIFY_MAXPACKET), |
bcb2f99c | 172 | .bInterval = GS_NOTIFY_INTERVAL_MS, |
4d5a73dc DB |
173 | }; |
174 | ||
28824b18 | 175 | static struct usb_endpoint_descriptor acm_fs_in_desc = { |
4d5a73dc DB |
176 | .bLength = USB_DT_ENDPOINT_SIZE, |
177 | .bDescriptorType = USB_DT_ENDPOINT, | |
178 | .bEndpointAddress = USB_DIR_IN, | |
179 | .bmAttributes = USB_ENDPOINT_XFER_BULK, | |
180 | }; | |
181 | ||
28824b18 | 182 | static struct usb_endpoint_descriptor acm_fs_out_desc = { |
4d5a73dc DB |
183 | .bLength = USB_DT_ENDPOINT_SIZE, |
184 | .bDescriptorType = USB_DT_ENDPOINT, | |
185 | .bEndpointAddress = USB_DIR_OUT, | |
186 | .bmAttributes = USB_ENDPOINT_XFER_BULK, | |
187 | }; | |
188 | ||
28824b18 | 189 | static struct usb_descriptor_header *acm_fs_function[] = { |
b97503ff | 190 | (struct usb_descriptor_header *) &acm_iad_descriptor, |
4d5a73dc DB |
191 | (struct usb_descriptor_header *) &acm_control_interface_desc, |
192 | (struct usb_descriptor_header *) &acm_header_desc, | |
193 | (struct usb_descriptor_header *) &acm_call_mgmt_descriptor, | |
194 | (struct usb_descriptor_header *) &acm_descriptor, | |
195 | (struct usb_descriptor_header *) &acm_union_desc, | |
196 | (struct usb_descriptor_header *) &acm_fs_notify_desc, | |
197 | (struct usb_descriptor_header *) &acm_data_interface_desc, | |
198 | (struct usb_descriptor_header *) &acm_fs_in_desc, | |
199 | (struct usb_descriptor_header *) &acm_fs_out_desc, | |
200 | NULL, | |
201 | }; | |
202 | ||
203 | /* high speed support: */ | |
28824b18 | 204 | static struct usb_endpoint_descriptor acm_hs_notify_desc = { |
4d5a73dc DB |
205 | .bLength = USB_DT_ENDPOINT_SIZE, |
206 | .bDescriptorType = USB_DT_ENDPOINT, | |
207 | .bEndpointAddress = USB_DIR_IN, | |
208 | .bmAttributes = USB_ENDPOINT_XFER_INT, | |
551509d2 | 209 | .wMaxPacketSize = cpu_to_le16(GS_NOTIFY_MAXPACKET), |
bcb2f99c | 210 | .bInterval = USB_MS_TO_HS_INTERVAL(GS_NOTIFY_INTERVAL_MS), |
4d5a73dc DB |
211 | }; |
212 | ||
28824b18 | 213 | static struct usb_endpoint_descriptor acm_hs_in_desc = { |
4d5a73dc DB |
214 | .bLength = USB_DT_ENDPOINT_SIZE, |
215 | .bDescriptorType = USB_DT_ENDPOINT, | |
216 | .bmAttributes = USB_ENDPOINT_XFER_BULK, | |
551509d2 | 217 | .wMaxPacketSize = cpu_to_le16(512), |
4d5a73dc DB |
218 | }; |
219 | ||
28824b18 | 220 | static struct usb_endpoint_descriptor acm_hs_out_desc = { |
4d5a73dc DB |
221 | .bLength = USB_DT_ENDPOINT_SIZE, |
222 | .bDescriptorType = USB_DT_ENDPOINT, | |
223 | .bmAttributes = USB_ENDPOINT_XFER_BULK, | |
551509d2 | 224 | .wMaxPacketSize = cpu_to_le16(512), |
4d5a73dc DB |
225 | }; |
226 | ||
28824b18 | 227 | static struct usb_descriptor_header *acm_hs_function[] = { |
b97503ff | 228 | (struct usb_descriptor_header *) &acm_iad_descriptor, |
4d5a73dc DB |
229 | (struct usb_descriptor_header *) &acm_control_interface_desc, |
230 | (struct usb_descriptor_header *) &acm_header_desc, | |
231 | (struct usb_descriptor_header *) &acm_call_mgmt_descriptor, | |
232 | (struct usb_descriptor_header *) &acm_descriptor, | |
233 | (struct usb_descriptor_header *) &acm_union_desc, | |
234 | (struct usb_descriptor_header *) &acm_hs_notify_desc, | |
235 | (struct usb_descriptor_header *) &acm_data_interface_desc, | |
236 | (struct usb_descriptor_header *) &acm_hs_in_desc, | |
237 | (struct usb_descriptor_header *) &acm_hs_out_desc, | |
238 | NULL, | |
239 | }; | |
240 | ||
6fecfb05 SAS |
241 | static struct usb_endpoint_descriptor acm_ss_in_desc = { |
242 | .bLength = USB_DT_ENDPOINT_SIZE, | |
243 | .bDescriptorType = USB_DT_ENDPOINT, | |
244 | .bmAttributes = USB_ENDPOINT_XFER_BULK, | |
245 | .wMaxPacketSize = cpu_to_le16(1024), | |
246 | }; | |
247 | ||
248 | static struct usb_endpoint_descriptor acm_ss_out_desc = { | |
249 | .bLength = USB_DT_ENDPOINT_SIZE, | |
250 | .bDescriptorType = USB_DT_ENDPOINT, | |
251 | .bmAttributes = USB_ENDPOINT_XFER_BULK, | |
252 | .wMaxPacketSize = cpu_to_le16(1024), | |
253 | }; | |
254 | ||
255 | static struct usb_ss_ep_comp_descriptor acm_ss_bulk_comp_desc = { | |
256 | .bLength = sizeof acm_ss_bulk_comp_desc, | |
257 | .bDescriptorType = USB_DT_SS_ENDPOINT_COMP, | |
258 | }; | |
259 | ||
260 | static struct usb_descriptor_header *acm_ss_function[] = { | |
261 | (struct usb_descriptor_header *) &acm_iad_descriptor, | |
262 | (struct usb_descriptor_header *) &acm_control_interface_desc, | |
263 | (struct usb_descriptor_header *) &acm_header_desc, | |
264 | (struct usb_descriptor_header *) &acm_call_mgmt_descriptor, | |
265 | (struct usb_descriptor_header *) &acm_descriptor, | |
266 | (struct usb_descriptor_header *) &acm_union_desc, | |
267 | (struct usb_descriptor_header *) &acm_hs_notify_desc, | |
268 | (struct usb_descriptor_header *) &acm_ss_bulk_comp_desc, | |
269 | (struct usb_descriptor_header *) &acm_data_interface_desc, | |
270 | (struct usb_descriptor_header *) &acm_ss_in_desc, | |
271 | (struct usb_descriptor_header *) &acm_ss_bulk_comp_desc, | |
272 | (struct usb_descriptor_header *) &acm_ss_out_desc, | |
273 | (struct usb_descriptor_header *) &acm_ss_bulk_comp_desc, | |
274 | NULL, | |
275 | }; | |
276 | ||
4d5a73dc DB |
277 | /* string descriptors: */ |
278 | ||
279 | #define ACM_CTRL_IDX 0 | |
280 | #define ACM_DATA_IDX 1 | |
b97503ff | 281 | #define ACM_IAD_IDX 2 |
4d5a73dc DB |
282 | |
283 | /* static strings, in UTF-8 */ | |
284 | static struct usb_string acm_string_defs[] = { | |
285 | [ACM_CTRL_IDX].s = "CDC Abstract Control Model (ACM)", | |
286 | [ACM_DATA_IDX].s = "CDC ACM Data", | |
b97503ff | 287 | [ACM_IAD_IDX ].s = "CDC Serial", |
d2572218 | 288 | { } /* end of list */ |
4d5a73dc DB |
289 | }; |
290 | ||
291 | static struct usb_gadget_strings acm_string_table = { | |
292 | .language = 0x0409, /* en-us */ | |
293 | .strings = acm_string_defs, | |
294 | }; | |
295 | ||
296 | static struct usb_gadget_strings *acm_strings[] = { | |
297 | &acm_string_table, | |
298 | NULL, | |
299 | }; | |
300 | ||
301 | /*-------------------------------------------------------------------------*/ | |
302 | ||
303 | /* ACM control ... data handling is delegated to tty library code. | |
304 | * The main task of this function is to activate and deactivate | |
305 | * that code based on device state; track parameters like line | |
306 | * speed, handshake state, and so on; and issue notifications. | |
307 | */ | |
308 | ||
309 | static void acm_complete_set_line_coding(struct usb_ep *ep, | |
310 | struct usb_request *req) | |
311 | { | |
312 | struct f_acm *acm = ep->driver_data; | |
313 | struct usb_composite_dev *cdev = acm->port.func.config->cdev; | |
314 | ||
315 | if (req->status != 0) { | |
316 | DBG(cdev, "acm ttyGS%d completion, err %d\n", | |
317 | acm->port_num, req->status); | |
318 | return; | |
319 | } | |
320 | ||
321 | /* normal completion */ | |
322 | if (req->actual != sizeof(acm->port_line_coding)) { | |
323 | DBG(cdev, "acm ttyGS%d short resp, len %d\n", | |
324 | acm->port_num, req->actual); | |
325 | usb_ep_set_halt(ep); | |
326 | } else { | |
327 | struct usb_cdc_line_coding *value = req->buf; | |
328 | ||
329 | /* REVISIT: we currently just remember this data. | |
330 | * If we change that, (a) validate it first, then | |
331 | * (b) update whatever hardware needs updating, | |
332 | * (c) worry about locking. This is information on | |
333 | * the order of 9600-8-N-1 ... most of which means | |
334 | * nothing unless we control a real RS232 line. | |
335 | */ | |
336 | acm->port_line_coding = *value; | |
337 | } | |
338 | } | |
339 | ||
340 | static int acm_setup(struct usb_function *f, const struct usb_ctrlrequest *ctrl) | |
341 | { | |
342 | struct f_acm *acm = func_to_acm(f); | |
343 | struct usb_composite_dev *cdev = f->config->cdev; | |
344 | struct usb_request *req = cdev->req; | |
345 | int value = -EOPNOTSUPP; | |
346 | u16 w_index = le16_to_cpu(ctrl->wIndex); | |
347 | u16 w_value = le16_to_cpu(ctrl->wValue); | |
348 | u16 w_length = le16_to_cpu(ctrl->wLength); | |
349 | ||
350 | /* composite driver infrastructure handles everything except | |
351 | * CDC class messages; interface activation uses set_alt(). | |
1f1ba11b DB |
352 | * |
353 | * Note CDC spec table 4 lists the ACM request profile. It requires | |
354 | * encapsulated command support ... we don't handle any, and respond | |
355 | * to them by stalling. Options include get/set/clear comm features | |
356 | * (not that useful) and SEND_BREAK. | |
4d5a73dc DB |
357 | */ |
358 | switch ((ctrl->bRequestType << 8) | ctrl->bRequest) { | |
359 | ||
360 | /* SET_LINE_CODING ... just read and save what the host sends */ | |
361 | case ((USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE) << 8) | |
362 | | USB_CDC_REQ_SET_LINE_CODING: | |
363 | if (w_length != sizeof(struct usb_cdc_line_coding) | |
364 | || w_index != acm->ctrl_id) | |
365 | goto invalid; | |
366 | ||
367 | value = w_length; | |
368 | cdev->gadget->ep0->driver_data = acm; | |
369 | req->complete = acm_complete_set_line_coding; | |
370 | break; | |
371 | ||
372 | /* GET_LINE_CODING ... return what host sent, or initial value */ | |
373 | case ((USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE) << 8) | |
374 | | USB_CDC_REQ_GET_LINE_CODING: | |
375 | if (w_index != acm->ctrl_id) | |
376 | goto invalid; | |
377 | ||
378 | value = min_t(unsigned, w_length, | |
379 | sizeof(struct usb_cdc_line_coding)); | |
380 | memcpy(req->buf, &acm->port_line_coding, value); | |
381 | break; | |
382 | ||
383 | /* SET_CONTROL_LINE_STATE ... save what the host sent */ | |
384 | case ((USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE) << 8) | |
385 | | USB_CDC_REQ_SET_CONTROL_LINE_STATE: | |
386 | if (w_index != acm->ctrl_id) | |
387 | goto invalid; | |
388 | ||
389 | value = 0; | |
390 | ||
391 | /* FIXME we should not allow data to flow until the | |
1f1ba11b | 392 | * host sets the ACM_CTRL_DTR bit; and when it clears |
4d5a73dc DB |
393 | * that bit, we should return to that no-flow state. |
394 | */ | |
395 | acm->port_handshake_bits = w_value; | |
396 | break; | |
397 | ||
398 | default: | |
399 | invalid: | |
400 | VDBG(cdev, "invalid control req%02x.%02x v%04x i%04x l%d\n", | |
401 | ctrl->bRequestType, ctrl->bRequest, | |
402 | w_value, w_index, w_length); | |
403 | } | |
404 | ||
405 | /* respond with data transfer or status phase? */ | |
406 | if (value >= 0) { | |
407 | DBG(cdev, "acm ttyGS%d req%02x.%02x v%04x i%04x l%d\n", | |
408 | acm->port_num, ctrl->bRequestType, ctrl->bRequest, | |
409 | w_value, w_index, w_length); | |
410 | req->zero = 0; | |
411 | req->length = value; | |
412 | value = usb_ep_queue(cdev->gadget->ep0, req, GFP_ATOMIC); | |
413 | if (value < 0) | |
414 | ERROR(cdev, "acm response on ttyGS%d, err %d\n", | |
415 | acm->port_num, value); | |
416 | } | |
417 | ||
418 | /* device either stalls (value < 0) or reports success */ | |
419 | return value; | |
420 | } | |
421 | ||
422 | static int acm_set_alt(struct usb_function *f, unsigned intf, unsigned alt) | |
423 | { | |
424 | struct f_acm *acm = func_to_acm(f); | |
425 | struct usb_composite_dev *cdev = f->config->cdev; | |
426 | ||
427 | /* we know alt == 0, so this is an activation or a reset */ | |
428 | ||
429 | if (intf == acm->ctrl_id) { | |
4d5a73dc DB |
430 | if (acm->notify->driver_data) { |
431 | VDBG(cdev, "reset acm control interface %d\n", intf); | |
432 | usb_ep_disable(acm->notify); | |
433 | } else { | |
434 | VDBG(cdev, "init acm ctrl interface %d\n", intf); | |
ea2a1df7 TB |
435 | if (config_ep_by_speed(cdev->gadget, f, acm->notify)) |
436 | return -EINVAL; | |
4d5a73dc | 437 | } |
72c973dd | 438 | usb_ep_enable(acm->notify); |
4d5a73dc DB |
439 | acm->notify->driver_data = acm; |
440 | ||
441 | } else if (intf == acm->data_id) { | |
442 | if (acm->port.in->driver_data) { | |
443 | DBG(cdev, "reset acm ttyGS%d\n", acm->port_num); | |
444 | gserial_disconnect(&acm->port); | |
ea2a1df7 TB |
445 | } |
446 | if (!acm->port.in->desc || !acm->port.out->desc) { | |
4d5a73dc | 447 | DBG(cdev, "activate acm ttyGS%d\n", acm->port_num); |
ea2a1df7 TB |
448 | if (config_ep_by_speed(cdev->gadget, f, |
449 | acm->port.in) || | |
450 | config_ep_by_speed(cdev->gadget, f, | |
451 | acm->port.out)) { | |
452 | acm->port.in->desc = NULL; | |
453 | acm->port.out->desc = NULL; | |
454 | return -EINVAL; | |
455 | } | |
4d5a73dc DB |
456 | } |
457 | gserial_connect(&acm->port, acm->port_num); | |
458 | ||
459 | } else | |
460 | return -EINVAL; | |
461 | ||
462 | return 0; | |
463 | } | |
464 | ||
465 | static void acm_disable(struct usb_function *f) | |
466 | { | |
467 | struct f_acm *acm = func_to_acm(f); | |
468 | struct usb_composite_dev *cdev = f->config->cdev; | |
469 | ||
470 | DBG(cdev, "acm ttyGS%d deactivated\n", acm->port_num); | |
471 | gserial_disconnect(&acm->port); | |
472 | usb_ep_disable(acm->notify); | |
473 | acm->notify->driver_data = NULL; | |
474 | } | |
475 | ||
476 | /*-------------------------------------------------------------------------*/ | |
477 | ||
1f1ba11b DB |
478 | /** |
479 | * acm_cdc_notify - issue CDC notification to host | |
480 | * @acm: wraps host to be notified | |
481 | * @type: notification type | |
482 | * @value: Refer to cdc specs, wValue field. | |
483 | * @data: data to be sent | |
484 | * @length: size of data | |
485 | * Context: irqs blocked, acm->lock held, acm_notify_req non-null | |
486 | * | |
af901ca1 | 487 | * Returns zero on success or a negative errno. |
1f1ba11b DB |
488 | * |
489 | * See section 6.3.5 of the CDC 1.1 specification for information | |
490 | * about the only notification we issue: SerialState change. | |
491 | */ | |
492 | static int acm_cdc_notify(struct f_acm *acm, u8 type, u16 value, | |
493 | void *data, unsigned length) | |
494 | { | |
495 | struct usb_ep *ep = acm->notify; | |
496 | struct usb_request *req; | |
497 | struct usb_cdc_notification *notify; | |
498 | const unsigned len = sizeof(*notify) + length; | |
499 | void *buf; | |
500 | int status; | |
501 | ||
502 | req = acm->notify_req; | |
503 | acm->notify_req = NULL; | |
504 | acm->pending = false; | |
505 | ||
506 | req->length = len; | |
507 | notify = req->buf; | |
508 | buf = notify + 1; | |
509 | ||
510 | notify->bmRequestType = USB_DIR_IN | USB_TYPE_CLASS | |
511 | | USB_RECIP_INTERFACE; | |
512 | notify->bNotificationType = type; | |
513 | notify->wValue = cpu_to_le16(value); | |
514 | notify->wIndex = cpu_to_le16(acm->ctrl_id); | |
515 | notify->wLength = cpu_to_le16(length); | |
516 | memcpy(buf, data, length); | |
517 | ||
e50ae572 DB |
518 | /* ep_queue() can complete immediately if it fills the fifo... */ |
519 | spin_unlock(&acm->lock); | |
1f1ba11b | 520 | status = usb_ep_queue(ep, req, GFP_ATOMIC); |
e50ae572 DB |
521 | spin_lock(&acm->lock); |
522 | ||
1f1ba11b DB |
523 | if (status < 0) { |
524 | ERROR(acm->port.func.config->cdev, | |
525 | "acm ttyGS%d can't notify serial state, %d\n", | |
526 | acm->port_num, status); | |
527 | acm->notify_req = req; | |
528 | } | |
529 | ||
530 | return status; | |
531 | } | |
532 | ||
533 | static int acm_notify_serial_state(struct f_acm *acm) | |
534 | { | |
535 | struct usb_composite_dev *cdev = acm->port.func.config->cdev; | |
536 | int status; | |
537 | ||
538 | spin_lock(&acm->lock); | |
539 | if (acm->notify_req) { | |
540 | DBG(cdev, "acm ttyGS%d serial state %04x\n", | |
541 | acm->port_num, acm->serial_state); | |
542 | status = acm_cdc_notify(acm, USB_CDC_NOTIFY_SERIAL_STATE, | |
543 | 0, &acm->serial_state, sizeof(acm->serial_state)); | |
544 | } else { | |
545 | acm->pending = true; | |
546 | status = 0; | |
547 | } | |
548 | spin_unlock(&acm->lock); | |
549 | return status; | |
550 | } | |
551 | ||
552 | static void acm_cdc_notify_complete(struct usb_ep *ep, struct usb_request *req) | |
553 | { | |
554 | struct f_acm *acm = req->context; | |
555 | u8 doit = false; | |
556 | ||
557 | /* on this call path we do NOT hold the port spinlock, | |
558 | * which is why ACM needs its own spinlock | |
559 | */ | |
560 | spin_lock(&acm->lock); | |
561 | if (req->status != -ESHUTDOWN) | |
562 | doit = acm->pending; | |
563 | acm->notify_req = req; | |
564 | spin_unlock(&acm->lock); | |
565 | ||
566 | if (doit) | |
567 | acm_notify_serial_state(acm); | |
568 | } | |
569 | ||
570 | /* connect == the TTY link is open */ | |
571 | ||
572 | static void acm_connect(struct gserial *port) | |
573 | { | |
574 | struct f_acm *acm = port_to_acm(port); | |
575 | ||
576 | acm->serial_state |= ACM_CTRL_DSR | ACM_CTRL_DCD; | |
577 | acm_notify_serial_state(acm); | |
578 | } | |
579 | ||
580 | static void acm_disconnect(struct gserial *port) | |
581 | { | |
582 | struct f_acm *acm = port_to_acm(port); | |
583 | ||
584 | acm->serial_state &= ~(ACM_CTRL_DSR | ACM_CTRL_DCD); | |
585 | acm_notify_serial_state(acm); | |
586 | } | |
587 | ||
588 | static int acm_send_break(struct gserial *port, int duration) | |
589 | { | |
590 | struct f_acm *acm = port_to_acm(port); | |
591 | u16 state; | |
592 | ||
593 | state = acm->serial_state; | |
594 | state &= ~ACM_CTRL_BRK; | |
595 | if (duration) | |
596 | state |= ACM_CTRL_BRK; | |
597 | ||
598 | acm->serial_state = state; | |
599 | return acm_notify_serial_state(acm); | |
600 | } | |
601 | ||
602 | /*-------------------------------------------------------------------------*/ | |
603 | ||
4d5a73dc | 604 | /* ACM function driver setup/binding */ |
28824b18 | 605 | static int |
4d5a73dc DB |
606 | acm_bind(struct usb_configuration *c, struct usb_function *f) |
607 | { | |
608 | struct usb_composite_dev *cdev = c->cdev; | |
609 | struct f_acm *acm = func_to_acm(f); | |
27a46633 | 610 | struct usb_string *us; |
4d5a73dc DB |
611 | int status; |
612 | struct usb_ep *ep; | |
613 | ||
ff47f594 SAS |
614 | /* REVISIT might want instance-specific strings to help |
615 | * distinguish instances ... | |
616 | */ | |
617 | ||
618 | /* maybe allocate device-global string IDs, and patch descriptors */ | |
27a46633 SAS |
619 | us = usb_gstrings_attach(cdev, acm_strings, |
620 | ARRAY_SIZE(acm_string_defs)); | |
621 | if (IS_ERR(us)) | |
622 | return PTR_ERR(us); | |
623 | acm_control_interface_desc.iInterface = us[ACM_CTRL_IDX].id; | |
624 | acm_data_interface_desc.iInterface = us[ACM_DATA_IDX].id; | |
625 | acm_iad_descriptor.iFunction = us[ACM_IAD_IDX].id; | |
ff47f594 | 626 | |
4d5a73dc DB |
627 | /* allocate instance-specific interface IDs, and patch descriptors */ |
628 | status = usb_interface_id(c, f); | |
629 | if (status < 0) | |
630 | goto fail; | |
631 | acm->ctrl_id = status; | |
b97503ff | 632 | acm_iad_descriptor.bFirstInterface = status; |
4d5a73dc DB |
633 | |
634 | acm_control_interface_desc.bInterfaceNumber = status; | |
635 | acm_union_desc .bMasterInterface0 = status; | |
636 | ||
637 | status = usb_interface_id(c, f); | |
638 | if (status < 0) | |
639 | goto fail; | |
640 | acm->data_id = status; | |
641 | ||
642 | acm_data_interface_desc.bInterfaceNumber = status; | |
643 | acm_union_desc.bSlaveInterface0 = status; | |
644 | acm_call_mgmt_descriptor.bDataInterface = status; | |
645 | ||
646 | status = -ENODEV; | |
647 | ||
648 | /* allocate instance-specific endpoints */ | |
649 | ep = usb_ep_autoconfig(cdev->gadget, &acm_fs_in_desc); | |
650 | if (!ep) | |
651 | goto fail; | |
652 | acm->port.in = ep; | |
653 | ep->driver_data = cdev; /* claim */ | |
654 | ||
655 | ep = usb_ep_autoconfig(cdev->gadget, &acm_fs_out_desc); | |
656 | if (!ep) | |
657 | goto fail; | |
658 | acm->port.out = ep; | |
659 | ep->driver_data = cdev; /* claim */ | |
660 | ||
661 | ep = usb_ep_autoconfig(cdev->gadget, &acm_fs_notify_desc); | |
662 | if (!ep) | |
663 | goto fail; | |
664 | acm->notify = ep; | |
665 | ep->driver_data = cdev; /* claim */ | |
666 | ||
1f1ba11b DB |
667 | /* allocate notification */ |
668 | acm->notify_req = gs_alloc_req(ep, | |
669 | sizeof(struct usb_cdc_notification) + 2, | |
670 | GFP_KERNEL); | |
671 | if (!acm->notify_req) | |
672 | goto fail; | |
673 | ||
674 | acm->notify_req->complete = acm_cdc_notify_complete; | |
675 | acm->notify_req->context = acm; | |
676 | ||
4d5a73dc DB |
677 | /* support all relevant hardware speeds... we expect that when |
678 | * hardware is dual speed, all bulk-capable endpoints work at | |
679 | * both speeds | |
680 | */ | |
10287bae SAS |
681 | acm_hs_in_desc.bEndpointAddress = acm_fs_in_desc.bEndpointAddress; |
682 | acm_hs_out_desc.bEndpointAddress = acm_fs_out_desc.bEndpointAddress; | |
683 | acm_hs_notify_desc.bEndpointAddress = | |
684 | acm_fs_notify_desc.bEndpointAddress; | |
685 | ||
686 | acm_ss_in_desc.bEndpointAddress = acm_fs_in_desc.bEndpointAddress; | |
687 | acm_ss_out_desc.bEndpointAddress = acm_fs_out_desc.bEndpointAddress; | |
688 | ||
689 | status = usb_assign_descriptors(f, acm_fs_function, acm_hs_function, | |
690 | acm_ss_function); | |
691 | if (status) | |
692 | goto fail; | |
4d5a73dc | 693 | |
4d5a73dc DB |
694 | DBG(cdev, "acm ttyGS%d: %s speed IN/%s OUT/%s NOTIFY/%s\n", |
695 | acm->port_num, | |
6fecfb05 | 696 | gadget_is_superspeed(c->cdev->gadget) ? "super" : |
4d5a73dc DB |
697 | gadget_is_dualspeed(c->cdev->gadget) ? "dual" : "full", |
698 | acm->port.in->name, acm->port.out->name, | |
699 | acm->notify->name); | |
700 | return 0; | |
701 | ||
702 | fail: | |
1f1ba11b DB |
703 | if (acm->notify_req) |
704 | gs_free_req(acm->notify, acm->notify_req); | |
705 | ||
4d5a73dc DB |
706 | /* we might as well release our claims on endpoints */ |
707 | if (acm->notify) | |
708 | acm->notify->driver_data = NULL; | |
709 | if (acm->port.out) | |
710 | acm->port.out->driver_data = NULL; | |
711 | if (acm->port.in) | |
712 | acm->port.in->driver_data = NULL; | |
713 | ||
714 | ERROR(cdev, "%s/%p: can't bind, err %d\n", f->name, f, status); | |
715 | ||
716 | return status; | |
717 | } | |
718 | ||
ff47f594 SAS |
719 | static void acm_unbind(struct usb_configuration *c, struct usb_function *f) |
720 | { | |
721 | struct f_acm *acm = func_to_acm(f); | |
722 | ||
723 | acm_string_defs[0].id = 0; | |
724 | usb_free_all_descriptors(f); | |
725 | if (acm->notify_req) | |
726 | gs_free_req(acm->notify, acm->notify_req); | |
727 | } | |
728 | ||
729 | static void acm_free_func(struct usb_function *f) | |
730 | { | |
731 | struct f_acm *acm = func_to_acm(f); | |
732 | ||
733 | kfree(acm); | |
734 | } | |
735 | ||
736 | static struct usb_function *acm_alloc_func(struct usb_function_instance *fi) | |
737 | { | |
738 | struct f_serial_opts *opts; | |
739 | struct f_acm *acm; | |
740 | ||
15761826 | 741 | acm = kzalloc(sizeof(*acm), GFP_KERNEL); |
ff47f594 SAS |
742 | if (!acm) |
743 | return ERR_PTR(-ENOMEM); | |
744 | ||
15761826 SAS |
745 | spin_lock_init(&acm->lock); |
746 | ||
747 | acm->port.connect = acm_connect; | |
748 | acm->port.disconnect = acm_disconnect; | |
749 | acm->port.send_break = acm_send_break; | |
750 | ||
751 | acm->port.func.name = "acm"; | |
752 | acm->port.func.strings = acm_strings; | |
753 | /* descriptors are per-instance copies */ | |
754 | acm->port.func.bind = acm_bind; | |
755 | acm->port.func.set_alt = acm_set_alt; | |
756 | acm->port.func.setup = acm_setup; | |
757 | acm->port.func.disable = acm_disable; | |
758 | ||
ff47f594 SAS |
759 | opts = container_of(fi, struct f_serial_opts, func_inst); |
760 | acm->port_num = opts->port_num; | |
761 | acm->port.func.unbind = acm_unbind; | |
762 | acm->port.func.free_func = acm_free_func; | |
763 | ||
764 | return &acm->port.func; | |
765 | } | |
766 | ||
88af8bbe SAS |
767 | static inline struct f_serial_opts *to_f_serial_opts(struct config_item *item) |
768 | { | |
769 | return container_of(to_config_group(item), struct f_serial_opts, | |
770 | func_inst.group); | |
771 | } | |
772 | ||
773 | CONFIGFS_ATTR_STRUCT(f_serial_opts); | |
774 | static ssize_t f_acm_attr_show(struct config_item *item, | |
775 | struct configfs_attribute *attr, | |
776 | char *page) | |
777 | { | |
778 | struct f_serial_opts *opts = to_f_serial_opts(item); | |
779 | struct f_serial_opts_attribute *f_serial_opts_attr = | |
780 | container_of(attr, struct f_serial_opts_attribute, attr); | |
781 | ssize_t ret = 0; | |
782 | ||
783 | if (f_serial_opts_attr->show) | |
784 | ret = f_serial_opts_attr->show(opts, page); | |
785 | return ret; | |
786 | } | |
787 | ||
788 | static void acm_attr_release(struct config_item *item) | |
789 | { | |
790 | struct f_serial_opts *opts = to_f_serial_opts(item); | |
791 | ||
792 | usb_put_function_instance(&opts->func_inst); | |
793 | } | |
794 | ||
795 | static struct configfs_item_operations acm_item_ops = { | |
796 | .release = acm_attr_release, | |
797 | .show_attribute = f_acm_attr_show, | |
798 | }; | |
799 | ||
800 | static ssize_t f_acm_port_num_show(struct f_serial_opts *opts, char *page) | |
801 | { | |
802 | return sprintf(page, "%u\n", opts->port_num); | |
803 | } | |
804 | ||
805 | static struct f_serial_opts_attribute f_acm_port_num = | |
806 | __CONFIGFS_ATTR_RO(port_num, f_acm_port_num_show); | |
807 | ||
808 | ||
809 | static struct configfs_attribute *acm_attrs[] = { | |
810 | &f_acm_port_num.attr, | |
811 | NULL, | |
812 | }; | |
813 | ||
814 | static struct config_item_type acm_func_type = { | |
815 | .ct_item_ops = &acm_item_ops, | |
816 | .ct_attrs = acm_attrs, | |
817 | .ct_owner = THIS_MODULE, | |
818 | }; | |
819 | ||
ff47f594 SAS |
820 | static void acm_free_instance(struct usb_function_instance *fi) |
821 | { | |
822 | struct f_serial_opts *opts; | |
823 | ||
824 | opts = container_of(fi, struct f_serial_opts, func_inst); | |
c4ed4ac1 | 825 | gserial_free_line(opts->port_num); |
ff47f594 SAS |
826 | kfree(opts); |
827 | } | |
828 | ||
829 | static struct usb_function_instance *acm_alloc_instance(void) | |
830 | { | |
831 | struct f_serial_opts *opts; | |
c4ed4ac1 | 832 | int ret; |
ff47f594 SAS |
833 | |
834 | opts = kzalloc(sizeof(*opts), GFP_KERNEL); | |
835 | if (!opts) | |
836 | return ERR_PTR(-ENOMEM); | |
837 | opts->func_inst.free_func_inst = acm_free_instance; | |
c4ed4ac1 SAS |
838 | ret = gserial_alloc_line(&opts->port_num); |
839 | if (ret) { | |
840 | kfree(opts); | |
841 | return ERR_PTR(ret); | |
842 | } | |
88af8bbe SAS |
843 | config_group_init_type_name(&opts->func_inst.group, "", |
844 | &acm_func_type); | |
ff47f594 SAS |
845 | return &opts->func_inst; |
846 | } | |
847 | DECLARE_USB_FUNCTION_INIT(acm, acm_alloc_instance, acm_alloc_func); | |
848 | MODULE_LICENSE("GPL"); |