2 * f_obex.c -- USB CDC OBEX function driver
4 * Copyright (C) 2008 Nokia Corporation
5 * Contact: Felipe Balbi <felipe.balbi@nokia.com>
7 * Based on f_acm.c by Al Borchers and David Brownell.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
15 /* #define VERBOSE_DEBUG */
17 #include <linux/slab.h>
18 #include <linux/kernel.h>
19 #include <linux/device.h>
20 #include <linux/module.h>
23 #include "gadget_chips.h"
27 * This CDC OBEX function support just packages a TTY-ish byte stream.
28 * A user mode server will put it into "raw" mode and handle all the
29 * relevant protocol details ... this is just a kernel passthrough.
30 * When possible, we prevent gadget enumeration until that server is
31 * ready to handle the commands.
42 static inline struct f_obex
*func_to_obex(struct usb_function
*f
)
44 return container_of(f
, struct f_obex
, port
.func
);
47 static inline struct f_obex
*port_to_obex(struct gserial
*p
)
49 return container_of(p
, struct f_obex
, port
);
52 /*-------------------------------------------------------------------------*/
54 #define OBEX_CTRL_IDX 0
55 #define OBEX_DATA_IDX 1
57 static struct usb_string obex_string_defs
[] = {
58 [OBEX_CTRL_IDX
].s
= "CDC Object Exchange (OBEX)",
59 [OBEX_DATA_IDX
].s
= "CDC OBEX Data",
60 { }, /* end of list */
63 static struct usb_gadget_strings obex_string_table
= {
64 .language
= 0x0409, /* en-US */
65 .strings
= obex_string_defs
,
68 static struct usb_gadget_strings
*obex_strings
[] = {
73 /*-------------------------------------------------------------------------*/
75 static struct usb_interface_descriptor obex_control_intf __initdata
= {
76 .bLength
= sizeof(obex_control_intf
),
77 .bDescriptorType
= USB_DT_INTERFACE
,
78 .bInterfaceNumber
= 0,
80 .bAlternateSetting
= 0,
82 .bInterfaceClass
= USB_CLASS_COMM
,
83 .bInterfaceSubClass
= USB_CDC_SUBCLASS_OBEX
,
86 static struct usb_interface_descriptor obex_data_nop_intf __initdata
= {
87 .bLength
= sizeof(obex_data_nop_intf
),
88 .bDescriptorType
= USB_DT_INTERFACE
,
89 .bInterfaceNumber
= 1,
91 .bAlternateSetting
= 0,
93 .bInterfaceClass
= USB_CLASS_CDC_DATA
,
96 static struct usb_interface_descriptor obex_data_intf __initdata
= {
97 .bLength
= sizeof(obex_data_intf
),
98 .bDescriptorType
= USB_DT_INTERFACE
,
99 .bInterfaceNumber
= 2,
101 .bAlternateSetting
= 1,
103 .bInterfaceClass
= USB_CLASS_CDC_DATA
,
106 static struct usb_cdc_header_desc obex_cdc_header_desc __initdata
= {
107 .bLength
= sizeof(obex_cdc_header_desc
),
108 .bDescriptorType
= USB_DT_CS_INTERFACE
,
109 .bDescriptorSubType
= USB_CDC_HEADER_TYPE
,
110 .bcdCDC
= cpu_to_le16(0x0120),
113 static struct usb_cdc_union_desc obex_cdc_union_desc __initdata
= {
114 .bLength
= sizeof(obex_cdc_union_desc
),
115 .bDescriptorType
= USB_DT_CS_INTERFACE
,
116 .bDescriptorSubType
= USB_CDC_UNION_TYPE
,
117 .bMasterInterface0
= 1,
118 .bSlaveInterface0
= 2,
121 static struct usb_cdc_obex_desc obex_desc __initdata
= {
122 .bLength
= sizeof(obex_desc
),
123 .bDescriptorType
= USB_DT_CS_INTERFACE
,
124 .bDescriptorSubType
= USB_CDC_OBEX_TYPE
,
125 .bcdVersion
= cpu_to_le16(0x0100),
128 /* High-Speed Support */
130 static struct usb_endpoint_descriptor obex_hs_ep_out_desc __initdata
= {
131 .bLength
= USB_DT_ENDPOINT_SIZE
,
132 .bDescriptorType
= USB_DT_ENDPOINT
,
134 .bEndpointAddress
= USB_DIR_OUT
,
135 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
136 .wMaxPacketSize
= cpu_to_le16(512),
139 static struct usb_endpoint_descriptor obex_hs_ep_in_desc __initdata
= {
140 .bLength
= USB_DT_ENDPOINT_SIZE
,
141 .bDescriptorType
= USB_DT_ENDPOINT
,
143 .bEndpointAddress
= USB_DIR_IN
,
144 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
145 .wMaxPacketSize
= cpu_to_le16(512),
148 static struct usb_descriptor_header
*hs_function
[] __initdata
= {
149 (struct usb_descriptor_header
*) &obex_control_intf
,
150 (struct usb_descriptor_header
*) &obex_cdc_header_desc
,
151 (struct usb_descriptor_header
*) &obex_desc
,
152 (struct usb_descriptor_header
*) &obex_cdc_union_desc
,
154 (struct usb_descriptor_header
*) &obex_data_nop_intf
,
155 (struct usb_descriptor_header
*) &obex_data_intf
,
156 (struct usb_descriptor_header
*) &obex_hs_ep_in_desc
,
157 (struct usb_descriptor_header
*) &obex_hs_ep_out_desc
,
161 /* Full-Speed Support */
163 static struct usb_endpoint_descriptor obex_fs_ep_in_desc __initdata
= {
164 .bLength
= USB_DT_ENDPOINT_SIZE
,
165 .bDescriptorType
= USB_DT_ENDPOINT
,
167 .bEndpointAddress
= USB_DIR_IN
,
168 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
171 static struct usb_endpoint_descriptor obex_fs_ep_out_desc __initdata
= {
172 .bLength
= USB_DT_ENDPOINT_SIZE
,
173 .bDescriptorType
= USB_DT_ENDPOINT
,
175 .bEndpointAddress
= USB_DIR_OUT
,
176 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
179 static struct usb_descriptor_header
*fs_function
[] __initdata
= {
180 (struct usb_descriptor_header
*) &obex_control_intf
,
181 (struct usb_descriptor_header
*) &obex_cdc_header_desc
,
182 (struct usb_descriptor_header
*) &obex_desc
,
183 (struct usb_descriptor_header
*) &obex_cdc_union_desc
,
185 (struct usb_descriptor_header
*) &obex_data_nop_intf
,
186 (struct usb_descriptor_header
*) &obex_data_intf
,
187 (struct usb_descriptor_header
*) &obex_fs_ep_in_desc
,
188 (struct usb_descriptor_header
*) &obex_fs_ep_out_desc
,
192 /*-------------------------------------------------------------------------*/
194 static int obex_set_alt(struct usb_function
*f
, unsigned intf
, unsigned alt
)
196 struct f_obex
*obex
= func_to_obex(f
);
197 struct usb_composite_dev
*cdev
= f
->config
->cdev
;
199 if (intf
== obex
->ctrl_id
) {
203 DBG(cdev
, "reset obex ttyGS%d control\n", obex
->port_num
);
205 } else if (intf
== obex
->data_id
) {
209 if (obex
->port
.in
->driver_data
) {
210 DBG(cdev
, "reset obex ttyGS%d\n", obex
->port_num
);
211 gserial_disconnect(&obex
->port
);
214 if (!obex
->port
.in
->desc
|| !obex
->port
.out
->desc
) {
215 DBG(cdev
, "init obex ttyGS%d\n", obex
->port_num
);
216 if (config_ep_by_speed(cdev
->gadget
, f
,
218 config_ep_by_speed(cdev
->gadget
, f
,
220 obex
->port
.out
->desc
= NULL
;
221 obex
->port
.in
->desc
= NULL
;
227 DBG(cdev
, "activate obex ttyGS%d\n", obex
->port_num
);
228 gserial_connect(&obex
->port
, obex
->port_num
);
240 static int obex_get_alt(struct usb_function
*f
, unsigned intf
)
242 struct f_obex
*obex
= func_to_obex(f
);
244 if (intf
== obex
->ctrl_id
)
247 return obex
->port
.in
->driver_data
? 1 : 0;
250 static void obex_disable(struct usb_function
*f
)
252 struct f_obex
*obex
= func_to_obex(f
);
253 struct usb_composite_dev
*cdev
= f
->config
->cdev
;
255 DBG(cdev
, "obex ttyGS%d disable\n", obex
->port_num
);
256 gserial_disconnect(&obex
->port
);
259 /*-------------------------------------------------------------------------*/
261 static void obex_connect(struct gserial
*g
)
263 struct f_obex
*obex
= port_to_obex(g
);
264 struct usb_composite_dev
*cdev
= g
->func
.config
->cdev
;
267 if (!obex
->can_activate
)
270 status
= usb_function_activate(&g
->func
);
272 DBG(cdev
, "obex ttyGS%d function activate --> %d\n",
273 obex
->port_num
, status
);
276 static void obex_disconnect(struct gserial
*g
)
278 struct f_obex
*obex
= port_to_obex(g
);
279 struct usb_composite_dev
*cdev
= g
->func
.config
->cdev
;
282 if (!obex
->can_activate
)
285 status
= usb_function_deactivate(&g
->func
);
287 DBG(cdev
, "obex ttyGS%d function deactivate --> %d\n",
288 obex
->port_num
, status
);
291 /*-------------------------------------------------------------------------*/
294 obex_bind(struct usb_configuration
*c
, struct usb_function
*f
)
296 struct usb_composite_dev
*cdev
= c
->cdev
;
297 struct f_obex
*obex
= func_to_obex(f
);
301 /* allocate instance-specific interface IDs, and patch descriptors */
303 status
= usb_interface_id(c
, f
);
306 obex
->ctrl_id
= status
;
308 obex_control_intf
.bInterfaceNumber
= status
;
309 obex_cdc_union_desc
.bMasterInterface0
= status
;
311 status
= usb_interface_id(c
, f
);
314 obex
->data_id
= status
;
316 obex_data_nop_intf
.bInterfaceNumber
= status
;
317 obex_data_intf
.bInterfaceNumber
= status
;
318 obex_cdc_union_desc
.bSlaveInterface0
= status
;
320 /* allocate instance-specific endpoints */
322 ep
= usb_ep_autoconfig(cdev
->gadget
, &obex_fs_ep_in_desc
);
326 ep
->driver_data
= cdev
; /* claim */
328 ep
= usb_ep_autoconfig(cdev
->gadget
, &obex_fs_ep_out_desc
);
332 ep
->driver_data
= cdev
; /* claim */
334 /* support all relevant hardware speeds... we expect that when
335 * hardware is dual speed, all bulk-capable endpoints work at
339 obex_hs_ep_in_desc
.bEndpointAddress
=
340 obex_fs_ep_in_desc
.bEndpointAddress
;
341 obex_hs_ep_out_desc
.bEndpointAddress
=
342 obex_fs_ep_out_desc
.bEndpointAddress
;
344 status
= usb_assign_descriptors(f
, fs_function
, hs_function
, NULL
);
348 /* Avoid letting this gadget enumerate until the userspace
349 * OBEX server is active.
351 status
= usb_function_deactivate(f
);
353 WARNING(cdev
, "obex ttyGS%d: can't prevent enumeration, %d\n",
354 obex
->port_num
, status
);
356 obex
->can_activate
= true;
359 DBG(cdev
, "obex ttyGS%d: %s speed IN/%s OUT/%s\n",
361 gadget_is_dualspeed(c
->cdev
->gadget
) ? "dual" : "full",
362 obex
->port
.in
->name
, obex
->port
.out
->name
);
367 usb_free_all_descriptors(f
);
368 /* we might as well release our claims on endpoints */
370 obex
->port
.out
->driver_data
= NULL
;
372 obex
->port
.in
->driver_data
= NULL
;
374 ERROR(cdev
, "%s/%p: can't bind, err %d\n", f
->name
, f
, status
);
380 obex_unbind(struct usb_configuration
*c
, struct usb_function
*f
)
382 obex_string_defs
[OBEX_CTRL_IDX
].id
= 0;
383 usb_free_all_descriptors(f
);
384 kfree(func_to_obex(f
));
387 /* Some controllers can't support CDC OBEX ... */
388 static inline bool can_support_obex(struct usb_configuration
*c
)
390 /* Since the first interface is a NOP, we can ignore the
391 * issue of multi-interface support on most controllers.
393 * Altsettings are mandatory, however...
395 if (!gadget_supports_altsettings(c
->cdev
->gadget
))
398 /* everything else is *probably* fine ... */
403 * obex_bind_config - add a CDC OBEX function to a configuration
404 * @c: the configuration to support the CDC OBEX instance
405 * @port_num: /dev/ttyGS* port this interface will use
406 * Context: single threaded during gadget setup
408 * Returns zero on success, else negative errno.
410 int __init
obex_bind_config(struct usb_configuration
*c
, u8 port_num
)
415 if (!can_support_obex(c
))
418 if (obex_string_defs
[OBEX_CTRL_IDX
].id
== 0) {
419 status
= usb_string_ids_tab(c
->cdev
, obex_string_defs
);
422 obex_control_intf
.iInterface
=
423 obex_string_defs
[OBEX_CTRL_IDX
].id
;
425 status
= obex_string_defs
[OBEX_DATA_IDX
].id
;
426 obex_data_nop_intf
.iInterface
= status
;
427 obex_data_intf
.iInterface
= status
;
430 /* allocate and initialize one new instance */
431 obex
= kzalloc(sizeof *obex
, GFP_KERNEL
);
435 obex
->port_num
= port_num
;
437 obex
->port
.connect
= obex_connect
;
438 obex
->port
.disconnect
= obex_disconnect
;
440 obex
->port
.func
.name
= "obex";
441 obex
->port
.func
.strings
= obex_strings
;
442 /* descriptors are per-instance copies */
443 obex
->port
.func
.bind
= obex_bind
;
444 obex
->port
.func
.unbind
= obex_unbind
;
445 obex
->port
.func
.set_alt
= obex_set_alt
;
446 obex
->port
.func
.get_alt
= obex_get_alt
;
447 obex
->port
.func
.disable
= obex_disable
;
449 status
= usb_add_function(c
, &obex
->port
.func
);
456 MODULE_AUTHOR("Felipe Balbi");
457 MODULE_LICENSE("GPL");