source: src/linux/universal/linux-3.18/drivers/usb/gadget/function/f_acm.c @ 31885

Last change on this file since 31885 was 31885, checked in by brainslayer, 3 months ago

update

File size: 24.5 KB
Line 
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
7 * Copyright (C) 2009 by Samsung Electronics
8 * Author: Michal Nazarewicz (mina86@mina86.com)
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
17#include <linux/slab.h>
18#include <linux/kernel.h>
19#include <linux/module.h>
20#include <linux/device.h>
21#include <linux/err.h>
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
44struct f_acm {
45        struct gserial                  port;
46        u8                              ctrl_id, data_id;
47        u8                              port_num;
48
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
57        struct usb_ep                   *notify;
58        struct usb_request              *notify_req;
59
60        struct usb_cdc_line_coding      port_line_coding;       /* 8-N-1 etc */
61
62        /* SetControlLineState request -- CDC 1.1 section 6.2.14 (INPUT) */
63        u16                             port_handshake_bits;
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)
76};
77
78static inline struct f_acm *func_to_acm(struct usb_function *f)
79{
80        return container_of(f, struct f_acm, port.func);
81}
82
83static inline struct f_acm *port_to_acm(struct gserial *p)
84{
85        return container_of(p, struct f_acm, port);
86}
87
88/*-------------------------------------------------------------------------*/
89
90/* notification endpoint uses smallish and infrequent fixed-size messages */
91
92#define GS_NOTIFY_INTERVAL_MS           32
93#define GS_NOTIFY_MAXPACKET             10      /* notification + 2 bytes */
94
95/* interface and class descriptors: */
96
97static struct usb_interface_assoc_descriptor
98acm_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,
106        .bFunctionProtocol =    USB_CDC_ACM_PROTO_AT_V25TER,
107        /* .iFunction =         DYNAMIC */
108};
109
110
111static struct usb_interface_descriptor acm_control_interface_desc = {
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
122static struct usb_interface_descriptor acm_data_interface_desc = {
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
133static struct usb_cdc_header_desc acm_header_desc = {
134        .bLength =              sizeof(acm_header_desc),
135        .bDescriptorType =      USB_DT_CS_INTERFACE,
136        .bDescriptorSubType =   USB_CDC_HEADER_TYPE,
137        .bcdCDC =               cpu_to_le16(0x0110),
138};
139
140static struct usb_cdc_call_mgmt_descriptor
141acm_call_mgmt_descriptor = {
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
149static struct usb_cdc_acm_descriptor acm_descriptor = {
150        .bLength =              sizeof(acm_descriptor),
151        .bDescriptorType =      USB_DT_CS_INTERFACE,
152        .bDescriptorSubType =   USB_CDC_ACM_TYPE,
153        .bmCapabilities =       USB_CDC_CAP_LINE,
154};
155
156static struct usb_cdc_union_desc acm_union_desc = {
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
166static struct usb_endpoint_descriptor acm_fs_notify_desc = {
167        .bLength =              USB_DT_ENDPOINT_SIZE,
168        .bDescriptorType =      USB_DT_ENDPOINT,
169        .bEndpointAddress =     USB_DIR_IN,
170        .bmAttributes =         USB_ENDPOINT_XFER_INT,
171        .wMaxPacketSize =       cpu_to_le16(GS_NOTIFY_MAXPACKET),
172        .bInterval =            GS_NOTIFY_INTERVAL_MS,
173};
174
175static struct usb_endpoint_descriptor acm_fs_in_desc = {
176        .bLength =              USB_DT_ENDPOINT_SIZE,
177        .bDescriptorType =      USB_DT_ENDPOINT,
178        .bEndpointAddress =     USB_DIR_IN,
179        .bmAttributes =         USB_ENDPOINT_XFER_BULK,
180};
181
182static struct usb_endpoint_descriptor acm_fs_out_desc = {
183        .bLength =              USB_DT_ENDPOINT_SIZE,
184        .bDescriptorType =      USB_DT_ENDPOINT,
185        .bEndpointAddress =     USB_DIR_OUT,
186        .bmAttributes =         USB_ENDPOINT_XFER_BULK,
187};
188
189static struct usb_descriptor_header *acm_fs_function[] = {
190        (struct usb_descriptor_header *) &acm_iad_descriptor,
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: */
204static struct usb_endpoint_descriptor acm_hs_notify_desc = {
205        .bLength =              USB_DT_ENDPOINT_SIZE,
206        .bDescriptorType =      USB_DT_ENDPOINT,
207        .bEndpointAddress =     USB_DIR_IN,
208        .bmAttributes =         USB_ENDPOINT_XFER_INT,
209        .wMaxPacketSize =       cpu_to_le16(GS_NOTIFY_MAXPACKET),
210        .bInterval =            USB_MS_TO_HS_INTERVAL(GS_NOTIFY_INTERVAL_MS),
211};
212
213static struct usb_endpoint_descriptor acm_hs_in_desc = {
214        .bLength =              USB_DT_ENDPOINT_SIZE,
215        .bDescriptorType =      USB_DT_ENDPOINT,
216        .bmAttributes =         USB_ENDPOINT_XFER_BULK,
217        .wMaxPacketSize =       cpu_to_le16(512),
218};
219
220static struct usb_endpoint_descriptor acm_hs_out_desc = {
221        .bLength =              USB_DT_ENDPOINT_SIZE,
222        .bDescriptorType =      USB_DT_ENDPOINT,
223        .bmAttributes =         USB_ENDPOINT_XFER_BULK,
224        .wMaxPacketSize =       cpu_to_le16(512),
225};
226
227static struct usb_descriptor_header *acm_hs_function[] = {
228        (struct usb_descriptor_header *) &acm_iad_descriptor,
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
241static 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
248static 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
255static 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
260static 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
277/* string descriptors: */
278
279#define ACM_CTRL_IDX    0
280#define ACM_DATA_IDX    1
281#define ACM_IAD_IDX     2
282
283/* static strings, in UTF-8 */
284static struct usb_string acm_string_defs[] = {
285        [ACM_CTRL_IDX].s = "CDC Abstract Control Model (ACM)",
286        [ACM_DATA_IDX].s = "CDC ACM Data",
287        [ACM_IAD_IDX ].s = "CDC Serial",
288        {  } /* end of list */
289};
290
291static struct usb_gadget_strings acm_string_table = {
292        .language =             0x0409, /* en-us */
293        .strings =              acm_string_defs,
294};
295
296static 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
309static 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                dev_dbg(&cdev->gadget->dev, "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                dev_dbg(&cdev->gadget->dev, "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
340static 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().
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.
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
392                 * host sets the ACM_CTRL_DTR bit; and when it clears
393                 * that bit, we should return to that no-flow state.
394                 */
395                acm->port_handshake_bits = w_value;
396                break;
397
398        default:
399invalid:
400                dev_vdbg(&cdev->gadget->dev,
401                         "invalid control req%02x.%02x v%04x i%04x l%d\n",
402                         ctrl->bRequestType, ctrl->bRequest,
403                         w_value, w_index, w_length);
404        }
405
406        /* respond with data transfer or status phase? */
407        if (value >= 0) {
408                dev_dbg(&cdev->gadget->dev,
409                        "acm ttyGS%d req%02x.%02x v%04x i%04x l%d\n",
410                        acm->port_num, ctrl->bRequestType, ctrl->bRequest,
411                        w_value, w_index, w_length);
412                req->zero = 0;
413                req->length = value;
414                value = usb_ep_queue(cdev->gadget->ep0, req, GFP_ATOMIC);
415                if (value < 0)
416                        ERROR(cdev, "acm response on ttyGS%d, err %d\n",
417                                        acm->port_num, value);
418        }
419
420        /* device either stalls (value < 0) or reports success */
421        return value;
422}
423
424static int acm_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
425{
426        struct f_acm            *acm = func_to_acm(f);
427        struct usb_composite_dev *cdev = f->config->cdev;
428
429        /* we know alt == 0, so this is an activation or a reset */
430
431        if (intf == acm->ctrl_id) {
432                if (acm->notify->driver_data) {
433                        dev_vdbg(&cdev->gadget->dev,
434                                 "reset acm control interface %d\n", intf);
435                        usb_ep_disable(acm->notify);
436                }
437
438                if (!acm->notify->desc)
439                        if (config_ep_by_speed(cdev->gadget, f, acm->notify))
440                                return -EINVAL;
441
442                usb_ep_enable(acm->notify);
443                acm->notify->driver_data = acm;
444
445        } else if (intf == acm->data_id) {
446                if (acm->port.in->driver_data) {
447                        dev_dbg(&cdev->gadget->dev,
448                                "reset acm ttyGS%d\n", acm->port_num);
449                        gserial_disconnect(&acm->port);
450                }
451                if (!acm->port.in->desc || !acm->port.out->desc) {
452                        dev_dbg(&cdev->gadget->dev,
453                                "activate acm ttyGS%d\n", acm->port_num);
454                        if (config_ep_by_speed(cdev->gadget, f,
455                                               acm->port.in) ||
456                            config_ep_by_speed(cdev->gadget, f,
457                                               acm->port.out)) {
458                                acm->port.in->desc = NULL;
459                                acm->port.out->desc = NULL;
460                                return -EINVAL;
461                        }
462                }
463                gserial_connect(&acm->port, acm->port_num);
464
465        } else
466                return -EINVAL;
467
468        return 0;
469}
470
471static void acm_disable(struct usb_function *f)
472{
473        struct f_acm    *acm = func_to_acm(f);
474        struct usb_composite_dev *cdev = f->config->cdev;
475
476        dev_dbg(&cdev->gadget->dev, "acm ttyGS%d deactivated\n", acm->port_num);
477        gserial_disconnect(&acm->port);
478        usb_ep_disable(acm->notify);
479        acm->notify->driver_data = NULL;
480}
481
482/*-------------------------------------------------------------------------*/
483
484/**
485 * acm_cdc_notify - issue CDC notification to host
486 * @acm: wraps host to be notified
487 * @type: notification type
488 * @value: Refer to cdc specs, wValue field.
489 * @data: data to be sent
490 * @length: size of data
491 * Context: irqs blocked, acm->lock held, acm_notify_req non-null
492 *
493 * Returns zero on success or a negative errno.
494 *
495 * See section 6.3.5 of the CDC 1.1 specification for information
496 * about the only notification we issue:  SerialState change.
497 */
498static int acm_cdc_notify(struct f_acm *acm, u8 type, u16 value,
499                void *data, unsigned length)
500{
501        struct usb_ep                   *ep = acm->notify;
502        struct usb_request              *req;
503        struct usb_cdc_notification     *notify;
504        const unsigned                  len = sizeof(*notify) + length;
505        void                            *buf;
506        int                             status;
507
508        req = acm->notify_req;
509        acm->notify_req = NULL;
510        acm->pending = false;
511
512        req->length = len;
513        notify = req->buf;
514        buf = notify + 1;
515
516        notify->bmRequestType = USB_DIR_IN | USB_TYPE_CLASS
517                        | USB_RECIP_INTERFACE;
518        notify->bNotificationType = type;
519        notify->wValue = cpu_to_le16(value);
520        notify->wIndex = cpu_to_le16(acm->ctrl_id);
521        notify->wLength = cpu_to_le16(length);
522        memcpy(buf, data, length);
523
524        /* ep_queue() can complete immediately if it fills the fifo... */
525        spin_unlock(&acm->lock);
526        status = usb_ep_queue(ep, req, GFP_ATOMIC);
527        spin_lock(&acm->lock);
528
529        if (status < 0) {
530                ERROR(acm->port.func.config->cdev,
531                                "acm ttyGS%d can't notify serial state, %d\n",
532                                acm->port_num, status);
533                acm->notify_req = req;
534        }
535
536        return status;
537}
538
539static int acm_notify_serial_state(struct f_acm *acm)
540{
541        struct usb_composite_dev *cdev = acm->port.func.config->cdev;
542        int                     status;
543        __le16                  serial_state;
544
545        spin_lock(&acm->lock);
546        if (acm->notify_req) {
547                dev_dbg(&cdev->gadget->dev, "acm ttyGS%d serial state %04x\n",
548                        acm->port_num, acm->serial_state);
549                serial_state = cpu_to_le16(acm->serial_state);
550                status = acm_cdc_notify(acm, USB_CDC_NOTIFY_SERIAL_STATE,
551                                0, &serial_state, sizeof(acm->serial_state));
552        } else {
553                acm->pending = true;
554                status = 0;
555        }
556        spin_unlock(&acm->lock);
557        return status;
558}
559
560static void acm_cdc_notify_complete(struct usb_ep *ep, struct usb_request *req)
561{
562        struct f_acm            *acm = req->context;
563        u8                      doit = false;
564
565        /* on this call path we do NOT hold the port spinlock,
566         * which is why ACM needs its own spinlock
567         */
568        spin_lock(&acm->lock);
569        if (req->status != -ESHUTDOWN)
570                doit = acm->pending;
571        acm->notify_req = req;
572        spin_unlock(&acm->lock);
573
574        if (doit)
575                acm_notify_serial_state(acm);
576}
577
578/* connect == the TTY link is open */
579
580static void acm_connect(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
588static void acm_disconnect(struct gserial *port)
589{
590        struct f_acm            *acm = port_to_acm(port);
591
592        acm->serial_state &= ~(ACM_CTRL_DSR | ACM_CTRL_DCD);
593        acm_notify_serial_state(acm);
594}
595
596static int acm_send_break(struct gserial *port, int duration)
597{
598        struct f_acm            *acm = port_to_acm(port);
599        u16                     state;
600
601        state = acm->serial_state;
602        state &= ~ACM_CTRL_BRK;
603        if (duration)
604                state |= ACM_CTRL_BRK;
605
606        acm->serial_state = state;
607        return acm_notify_serial_state(acm);
608}
609
610/*-------------------------------------------------------------------------*/
611
612/* ACM function driver setup/binding */
613static int
614acm_bind(struct usb_configuration *c, struct usb_function *f)
615{
616        struct usb_composite_dev *cdev = c->cdev;
617        struct f_acm            *acm = func_to_acm(f);
618        struct usb_string       *us;
619        int                     status;
620        struct usb_ep           *ep;
621
622        /* REVISIT might want instance-specific strings to help
623         * distinguish instances ...
624         */
625
626        /* maybe allocate device-global string IDs, and patch descriptors */
627        us = usb_gstrings_attach(cdev, acm_strings,
628                        ARRAY_SIZE(acm_string_defs));
629        if (IS_ERR(us))
630                return PTR_ERR(us);
631        acm_control_interface_desc.iInterface = us[ACM_CTRL_IDX].id;
632        acm_data_interface_desc.iInterface = us[ACM_DATA_IDX].id;
633        acm_iad_descriptor.iFunction = us[ACM_IAD_IDX].id;
634
635        /* allocate instance-specific interface IDs, and patch descriptors */
636        status = usb_interface_id(c, f);
637        if (status < 0)
638                goto fail;
639        acm->ctrl_id = status;
640        acm_iad_descriptor.bFirstInterface = status;
641
642        acm_control_interface_desc.bInterfaceNumber = status;
643        acm_union_desc .bMasterInterface0 = status;
644
645        status = usb_interface_id(c, f);
646        if (status < 0)
647                goto fail;
648        acm->data_id = status;
649
650        acm_data_interface_desc.bInterfaceNumber = status;
651        acm_union_desc.bSlaveInterface0 = status;
652        acm_call_mgmt_descriptor.bDataInterface = status;
653
654        status = -ENODEV;
655
656        /* allocate instance-specific endpoints */
657        ep = usb_ep_autoconfig(cdev->gadget, &acm_fs_in_desc);
658        if (!ep)
659                goto fail;
660        acm->port.in = ep;
661        ep->driver_data = cdev; /* claim */
662
663        ep = usb_ep_autoconfig(cdev->gadget, &acm_fs_out_desc);
664        if (!ep)
665                goto fail;
666        acm->port.out = ep;
667        ep->driver_data = cdev; /* claim */
668
669        ep = usb_ep_autoconfig(cdev->gadget, &acm_fs_notify_desc);
670        if (!ep)
671                goto fail;
672        acm->notify = ep;
673        ep->driver_data = cdev; /* claim */
674
675        /* allocate notification */
676        acm->notify_req = gs_alloc_req(ep,
677                        sizeof(struct usb_cdc_notification) + 2,
678                        GFP_KERNEL);
679        if (!acm->notify_req)
680                goto fail;
681
682        acm->notify_req->complete = acm_cdc_notify_complete;
683        acm->notify_req->context = acm;
684
685        /* support all relevant hardware speeds... we expect that when
686         * hardware is dual speed, all bulk-capable endpoints work at
687         * both speeds
688         */
689        acm_hs_in_desc.bEndpointAddress = acm_fs_in_desc.bEndpointAddress;
690        acm_hs_out_desc.bEndpointAddress = acm_fs_out_desc.bEndpointAddress;
691        acm_hs_notify_desc.bEndpointAddress =
692                acm_fs_notify_desc.bEndpointAddress;
693
694        acm_ss_in_desc.bEndpointAddress = acm_fs_in_desc.bEndpointAddress;
695        acm_ss_out_desc.bEndpointAddress = acm_fs_out_desc.bEndpointAddress;
696
697        status = usb_assign_descriptors(f, acm_fs_function, acm_hs_function,
698                        acm_ss_function);
699        if (status)
700                goto fail;
701
702        dev_dbg(&cdev->gadget->dev,
703                "acm ttyGS%d: %s speed IN/%s OUT/%s NOTIFY/%s\n",
704                acm->port_num,
705                gadget_is_superspeed(c->cdev->gadget) ? "super" :
706                gadget_is_dualspeed(c->cdev->gadget) ? "dual" : "full",
707                acm->port.in->name, acm->port.out->name,
708                acm->notify->name);
709        return 0;
710
711fail:
712        if (acm->notify_req)
713                gs_free_req(acm->notify, acm->notify_req);
714
715        /* we might as well release our claims on endpoints */
716        if (acm->notify)
717                acm->notify->driver_data = NULL;
718        if (acm->port.out)
719                acm->port.out->driver_data = NULL;
720        if (acm->port.in)
721                acm->port.in->driver_data = NULL;
722
723        ERROR(cdev, "%s/%p: can't bind, err %d\n", f->name, f, status);
724
725        return status;
726}
727
728static void acm_unbind(struct usb_configuration *c, struct usb_function *f)
729{
730        struct f_acm            *acm = func_to_acm(f);
731
732        acm_string_defs[0].id = 0;
733        usb_free_all_descriptors(f);
734        if (acm->notify_req)
735                gs_free_req(acm->notify, acm->notify_req);
736}
737
738static void acm_free_func(struct usb_function *f)
739{
740        struct f_acm            *acm = func_to_acm(f);
741
742        kfree(acm);
743}
744
745static struct usb_function *acm_alloc_func(struct usb_function_instance *fi)
746{
747        struct f_serial_opts *opts;
748        struct f_acm *acm;
749
750        acm = kzalloc(sizeof(*acm), GFP_KERNEL);
751        if (!acm)
752                return ERR_PTR(-ENOMEM);
753
754        spin_lock_init(&acm->lock);
755
756        acm->port.connect = acm_connect;
757        acm->port.disconnect = acm_disconnect;
758        acm->port.send_break = acm_send_break;
759
760        acm->port.func.name = "acm";
761        acm->port.func.strings = acm_strings;
762        /* descriptors are per-instance copies */
763        acm->port.func.bind = acm_bind;
764        acm->port.func.set_alt = acm_set_alt;
765        acm->port.func.setup = acm_setup;
766        acm->port.func.disable = acm_disable;
767
768        opts = container_of(fi, struct f_serial_opts, func_inst);
769        acm->port_num = opts->port_num;
770        acm->port.func.unbind = acm_unbind;
771        acm->port.func.free_func = acm_free_func;
772
773        return &acm->port.func;
774}
775
776static inline struct f_serial_opts *to_f_serial_opts(struct config_item *item)
777{
778        return container_of(to_config_group(item), struct f_serial_opts,
779                        func_inst.group);
780}
781
782CONFIGFS_ATTR_STRUCT(f_serial_opts);
783static ssize_t f_acm_attr_show(struct config_item *item,
784                                 struct configfs_attribute *attr,
785                                 char *page)
786{
787        struct f_serial_opts *opts = to_f_serial_opts(item);
788        struct f_serial_opts_attribute *f_serial_opts_attr =
789                container_of(attr, struct f_serial_opts_attribute, attr);
790        ssize_t ret = 0;
791
792        if (f_serial_opts_attr->show)
793                ret = f_serial_opts_attr->show(opts, page);
794        return ret;
795}
796
797static void acm_attr_release(struct config_item *item)
798{
799        struct f_serial_opts *opts = to_f_serial_opts(item);
800
801        usb_put_function_instance(&opts->func_inst);
802}
803
804static struct configfs_item_operations acm_item_ops = {
805        .release                = acm_attr_release,
806        .show_attribute         = f_acm_attr_show,
807};
808
809static ssize_t f_acm_port_num_show(struct f_serial_opts *opts, char *page)
810{
811        return sprintf(page, "%u\n", opts->port_num);
812}
813
814static struct f_serial_opts_attribute f_acm_port_num =
815        __CONFIGFS_ATTR_RO(port_num, f_acm_port_num_show);
816
817
818static struct configfs_attribute *acm_attrs[] = {
819        &f_acm_port_num.attr,
820        NULL,
821};
822
823static struct config_item_type acm_func_type = {
824        .ct_item_ops    = &acm_item_ops,
825        .ct_attrs       = acm_attrs,
826        .ct_owner       = THIS_MODULE,
827};
828
829static void acm_free_instance(struct usb_function_instance *fi)
830{
831        struct f_serial_opts *opts;
832
833        opts = container_of(fi, struct f_serial_opts, func_inst);
834        gserial_free_line(opts->port_num);
835        kfree(opts);
836}
837
838static struct usb_function_instance *acm_alloc_instance(void)
839{
840        struct f_serial_opts *opts;
841        int ret;
842
843        opts = kzalloc(sizeof(*opts), GFP_KERNEL);
844        if (!opts)
845                return ERR_PTR(-ENOMEM);
846        opts->func_inst.free_func_inst = acm_free_instance;
847        ret = gserial_alloc_line(&opts->port_num);
848        if (ret) {
849                kfree(opts);
850                return ERR_PTR(ret);
851        }
852        config_group_init_type_name(&opts->func_inst.group, "",
853                        &acm_func_type);
854        return &opts->func_inst;
855}
856DECLARE_USB_FUNCTION_INIT(acm, acm_alloc_instance, acm_alloc_func);
857MODULE_LICENSE("GPL");
Note: See TracBrowser for help on using the repository browser.