2 * serial.c -- USB gadget serial driver
4 * Copyright (C) 2003 Al Borchers (alborchers@steinerpoint.com)
5 * Copyright (C) 2008 by David Brownell
6 * Copyright (C) 2008 by Nokia Corporation
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.
13 #include <linux/kernel.h>
14 #include <linux/utsname.h>
15 #include <linux/device.h>
16 #include <linux/tty.h>
17 #include <linux/tty_flip.h>
20 #include "gadget_chips.h"
25 #define GS_VERSION_STR "v2.4"
26 #define GS_VERSION_NUM 0x2400
28 #define GS_LONG_NAME "Gadget Serial"
29 #define GS_VERSION_NAME GS_LONG_NAME " " GS_VERSION_STR
31 /*-------------------------------------------------------------------------*/
34 * Kbuild is not very cooperative with respect to linking separately
35 * compiled library objects into one module. So for now we won't use
36 * separate compilation ... ensuring init/exit sections work to shrink
37 * the runtime footprint, and giving us at least some parts of what
38 * a "gcc --combine ... part1.c part2.c part3.c ... " build would.
40 #include "composite.c"
41 #include "usbstring.c"
43 #include "epautoconf.c"
50 /*-------------------------------------------------------------------------*/
52 /* Thanks to NetChip Technologies for donating this product ID.
54 * DO NOT REUSE THESE IDs with a protocol-incompatible driver!! Ever!!
55 * Instead: allocate your own, using normal USB-IF procedures.
57 #define GS_VENDOR_ID 0x0525 /* NetChip */
58 #define GS_PRODUCT_ID 0xa4a6 /* Linux-USB Serial Gadget */
59 #define GS_CDC_PRODUCT_ID 0xa4a7 /* ... as CDC-ACM */
60 #define GS_CDC_OBEX_PRODUCT_ID 0xa4a9 /* ... as CDC-OBEX */
62 /* string IDs are assigned dynamically */
64 #define STRING_MANUFACTURER_IDX 0
65 #define STRING_PRODUCT_IDX 1
66 #define STRING_DESCRIPTION_IDX 2
68 static char manufacturer
[50];
70 static struct usb_string strings_dev
[] = {
71 [STRING_MANUFACTURER_IDX
].s
= manufacturer
,
72 [STRING_PRODUCT_IDX
].s
= GS_VERSION_NAME
,
73 [STRING_DESCRIPTION_IDX
].s
= NULL
/* updated; f(use_acm) */,
77 static struct usb_gadget_strings stringtab_dev
= {
78 .language
= 0x0409, /* en-us */
79 .strings
= strings_dev
,
82 static struct usb_gadget_strings
*dev_strings
[] = {
87 static struct usb_device_descriptor device_desc
= {
88 .bLength
= USB_DT_DEVICE_SIZE
,
89 .bDescriptorType
= USB_DT_DEVICE
,
90 .bcdUSB
= cpu_to_le16(0x0200),
91 /* .bDeviceClass = f(use_acm) */
94 /* .bMaxPacketSize0 = f(hardware) */
95 .idVendor
= cpu_to_le16(GS_VENDOR_ID
),
96 /* .idProduct = f(use_acm) */
97 /* .bcdDevice = f(hardware) */
98 /* .iManufacturer = DYNAMIC */
99 /* .iProduct = DYNAMIC */
100 .bNumConfigurations
= 1,
103 static struct usb_otg_descriptor otg_descriptor
= {
104 .bLength
= sizeof otg_descriptor
,
105 .bDescriptorType
= USB_DT_OTG
,
107 /* REVISIT SRP-only hardware is possible, although
108 * it would not be called "OTG" ...
110 .bmAttributes
= USB_OTG_SRP
| USB_OTG_HNP
,
113 static const struct usb_descriptor_header
*otg_desc
[] = {
114 (struct usb_descriptor_header
*) &otg_descriptor
,
118 /*-------------------------------------------------------------------------*/
121 MODULE_DESCRIPTION(GS_VERSION_NAME
);
122 MODULE_AUTHOR("Al Borchers");
123 MODULE_AUTHOR("David Brownell");
124 MODULE_LICENSE("GPL");
126 static bool use_acm
= true;
127 module_param(use_acm
, bool, 0);
128 MODULE_PARM_DESC(use_acm
, "Use CDC ACM, default=yes");
130 static bool use_obex
= false;
131 module_param(use_obex
, bool, 0);
132 MODULE_PARM_DESC(use_obex
, "Use CDC OBEX, default=no");
134 static unsigned n_ports
= 1;
135 module_param(n_ports
, uint
, 0);
136 MODULE_PARM_DESC(n_ports
, "number of ports to create, default=1");
138 /*-------------------------------------------------------------------------*/
140 static int __init
serial_bind_config(struct usb_configuration
*c
)
145 for (i
= 0; i
< n_ports
&& status
== 0; i
++) {
147 status
= acm_bind_config(c
, i
);
149 status
= obex_bind_config(c
, i
);
151 status
= gser_bind_config(c
, i
);
156 static struct usb_configuration serial_config_driver
= {
157 /* .label = f(use_acm) */
158 /* .bConfigurationValue = f(use_acm) */
159 /* .iConfiguration = DYNAMIC */
160 .bmAttributes
= USB_CONFIG_ATT_SELFPOWER
,
163 static int __init
gs_bind(struct usb_composite_dev
*cdev
)
166 struct usb_gadget
*gadget
= cdev
->gadget
;
169 status
= gserial_setup(cdev
->gadget
, n_ports
);
173 /* Allocate string descriptor numbers ... note that string
174 * contents can be overridden by the composite_dev glue.
177 /* device description: manufacturer, product */
178 snprintf(manufacturer
, sizeof manufacturer
, "%s %s with %s",
179 init_utsname()->sysname
, init_utsname()->release
,
181 status
= usb_string_id(cdev
);
184 strings_dev
[STRING_MANUFACTURER_IDX
].id
= status
;
186 device_desc
.iManufacturer
= status
;
188 status
= usb_string_id(cdev
);
191 strings_dev
[STRING_PRODUCT_IDX
].id
= status
;
193 device_desc
.iProduct
= status
;
195 /* config description */
196 status
= usb_string_id(cdev
);
199 strings_dev
[STRING_DESCRIPTION_IDX
].id
= status
;
201 serial_config_driver
.iConfiguration
= status
;
203 /* set up other descriptors */
204 gcnum
= usb_gadget_controller_number(gadget
);
206 device_desc
.bcdDevice
= cpu_to_le16(GS_VERSION_NUM
| gcnum
);
208 /* this is so simple (for now, no altsettings) that it
209 * SHOULD NOT have problems with bulk-capable hardware.
210 * so warn about unrcognized controllers -- don't panic.
212 * things like configuration and altsetting numbering
213 * can need hardware-specific attention though.
215 pr_warning("gs_bind: controller '%s' not recognized\n",
217 device_desc
.bcdDevice
=
218 cpu_to_le16(GS_VERSION_NUM
| 0x0099);
221 if (gadget_is_otg(cdev
->gadget
)) {
222 serial_config_driver
.descriptors
= otg_desc
;
223 serial_config_driver
.bmAttributes
|= USB_CONFIG_ATT_WAKEUP
;
226 /* register our configuration */
227 status
= usb_add_config(cdev
, &serial_config_driver
,
232 INFO(cdev
, "%s\n", GS_VERSION_NAME
);
241 static struct usb_composite_driver gserial_driver
= {
244 .strings
= dev_strings
,
245 .max_speed
= USB_SPEED_HIGH
,
248 static int __init
init(void)
250 /* We *could* export two configs; that'd be much cleaner...
251 * but neither of these product IDs was defined that way.
254 serial_config_driver
.label
= "CDC ACM config";
255 serial_config_driver
.bConfigurationValue
= 2;
256 device_desc
.bDeviceClass
= USB_CLASS_COMM
;
257 device_desc
.idProduct
=
258 cpu_to_le16(GS_CDC_PRODUCT_ID
);
259 } else if (use_obex
) {
260 serial_config_driver
.label
= "CDC OBEX config";
261 serial_config_driver
.bConfigurationValue
= 3;
262 device_desc
.bDeviceClass
= USB_CLASS_COMM
;
263 device_desc
.idProduct
=
264 cpu_to_le16(GS_CDC_OBEX_PRODUCT_ID
);
266 serial_config_driver
.label
= "Generic Serial config";
267 serial_config_driver
.bConfigurationValue
= 1;
268 device_desc
.bDeviceClass
= USB_CLASS_VENDOR_SPEC
;
269 device_desc
.idProduct
=
270 cpu_to_le16(GS_PRODUCT_ID
);
272 strings_dev
[STRING_DESCRIPTION_IDX
].s
= serial_config_driver
.label
;
274 return usb_composite_probe(&gserial_driver
, gs_bind
);
278 static void __exit
cleanup(void)
280 usb_composite_unregister(&gserial_driver
);
283 module_exit(cleanup
);