serial.c 6.6 KB
Newer Older
L
Linus Torvalds 已提交
1
/*
D
David Brownell 已提交
2
 * serial.c -- USB gadget serial driver
L
Linus Torvalds 已提交
3
 *
D
David Brownell 已提交
4 5
 * Copyright (C) 2003 Al Borchers (alborchers@steinerpoint.com)
 * Copyright (C) 2008 by David Brownell
6
 * Copyright (C) 2008 by Nokia Corporation
L
Linus Torvalds 已提交
7 8 9 10 11 12 13 14 15 16 17 18
 *
 * This software is distributed under the terms of the GNU General
 * Public License ("GPL") as published by the Free Software Foundation,
 * either version 2 of that License or (at your option) any later version.
 */

#include <linux/kernel.h>
#include <linux/utsname.h>
#include <linux/device.h>
#include <linux/tty.h>
#include <linux/tty_flip.h>

D
David Brownell 已提交
19
#include "u_serial.h"
L
Linus Torvalds 已提交
20 21 22 23 24
#include "gadget_chips.h"


/* Defines */

25 26
#define GS_VERSION_STR			"v2.4"
#define GS_VERSION_NUM			0x2400
L
Linus Torvalds 已提交
27 28

#define GS_LONG_NAME			"Gadget Serial"
D
David Brownell 已提交
29 30
#define GS_VERSION_NAME			GS_LONG_NAME " " GS_VERSION_STR

31
/*-------------------------------------------------------------------------*/
L
Linus Torvalds 已提交
32 33

/* Thanks to NetChip Technologies for donating this product ID.
34 35 36 37
*
* DO NOT REUSE THESE IDs with a protocol-incompatible driver!!  Ever!!
* Instead:  allocate your own, using normal USB-IF procedures.
*/
L
Linus Torvalds 已提交
38 39 40 41
#define GS_VENDOR_ID			0x0525	/* NetChip */
#define GS_PRODUCT_ID			0xa4a6	/* Linux-USB Serial Gadget */
#define GS_CDC_PRODUCT_ID		0xa4a7	/* ... as CDC-ACM */

42
/* string IDs are assigned dynamically */
L
Linus Torvalds 已提交
43

44 45 46
#define STRING_MANUFACTURER_IDX		0
#define STRING_PRODUCT_IDX		1
#define STRING_DESCRIPTION_IDX		2
D
David Brownell 已提交
47

L
Linus Torvalds 已提交
48
static char manufacturer[50];
49 50 51 52 53

static struct usb_string strings_dev[] = {
	[STRING_MANUFACTURER_IDX].s = manufacturer,
	[STRING_PRODUCT_IDX].s = GS_VERSION_NAME,
	[STRING_DESCRIPTION_IDX].s = NULL /* updated; f(use_acm) */,
L
Linus Torvalds 已提交
54 55 56
	{  } /* end of list */
};

57 58 59
static struct usb_gadget_strings stringtab_dev = {
	.language	= 0x0409,	/* en-us */
	.strings	= strings_dev,
L
Linus Torvalds 已提交
60 61
};

62 63 64 65 66 67
static struct usb_gadget_strings *dev_strings[] = {
	&stringtab_dev,
	NULL,
};

static struct usb_device_descriptor device_desc = {
L
Linus Torvalds 已提交
68 69 70
	.bLength =		USB_DT_DEVICE_SIZE,
	.bDescriptorType =	USB_DT_DEVICE,
	.bcdUSB =		__constant_cpu_to_le16(0x0200),
71
	/* .bDeviceClass = f(use_acm) */
L
Linus Torvalds 已提交
72 73
	.bDeviceSubClass =	0,
	.bDeviceProtocol =	0,
74
	/* .bMaxPacketSize0 = f(hardware) */
L
Linus Torvalds 已提交
75
	.idVendor =		__constant_cpu_to_le16(GS_VENDOR_ID),
76 77 78 79 80
	/* .idProduct =	f(use_acm) */
	/* .bcdDevice = f(hardware) */
	/* .iManufacturer = DYNAMIC */
	/* .iProduct = DYNAMIC */
	.bNumConfigurations =	1,
L
Linus Torvalds 已提交
81 82
};

83 84
static struct usb_otg_descriptor otg_descriptor = {
	.bLength =		sizeof otg_descriptor,
L
Linus Torvalds 已提交
85 86
	.bDescriptorType =	USB_DT_OTG,

87 88 89 90
	/* REVISIT SRP-only hardware is possible, although
	 * it would not be called "OTG" ...
	 */
	.bmAttributes =		USB_OTG_SRP | USB_OTG_HNP,
D
David Brownell 已提交
91 92
};

93 94
static const struct usb_descriptor_header *otg_desc[] = {
	(struct usb_descriptor_header *) &otg_descriptor,
D
David Brownell 已提交
95 96
	NULL,
};
L
Linus Torvalds 已提交
97

D
David Brownell 已提交
98
/*-------------------------------------------------------------------------*/
L
Linus Torvalds 已提交
99

D
David Brownell 已提交
100 101 102 103 104
/* Module */
MODULE_DESCRIPTION(GS_VERSION_NAME);
MODULE_AUTHOR("Al Borchers");
MODULE_AUTHOR("David Brownell");
MODULE_LICENSE("GPL");
L
Linus Torvalds 已提交
105

106 107 108
static int use_acm = true;
module_param(use_acm, bool, 0);
MODULE_PARM_DESC(use_acm, "Use CDC ACM, default=yes");
L
Linus Torvalds 已提交
109

110 111 112
static unsigned n_ports = 1;
module_param(n_ports, uint, 0);
MODULE_PARM_DESC(n_ports, "number of ports to create, default=1");
113

114
/*-------------------------------------------------------------------------*/
L
Linus Torvalds 已提交
115

116
static int __init serial_bind_config(struct usb_configuration *c)
117
{
118 119
	unsigned i;
	int status = 0;
120

121 122 123 124 125
	for (i = 0; i < n_ports && status == 0; i++) {
		if (use_acm)
			status = acm_bind_config(c, i);
		else
			status = gser_bind_config(c, i);
126
	}
127
	return status;
128 129
}

130 131 132 133 134 135 136 137 138 139
static struct usb_configuration serial_config_driver = {
	/* .label = f(use_acm) */
	.bind		= serial_bind_config,
	/* .bConfigurationValue = f(use_acm) */
	/* .iConfiguration = DYNAMIC */
	.bmAttributes	= USB_CONFIG_ATT_SELFPOWER,
	.bMaxPower	= 1,	/* 2 mA, minimal */
};

static int __init gs_bind(struct usb_composite_dev *cdev)
L
Linus Torvalds 已提交
140
{
141 142 143
	int			gcnum;
	struct usb_gadget	*gadget = cdev->gadget;
	int			status;
L
Linus Torvalds 已提交
144

145 146 147
	status = gserial_setup(cdev->gadget, n_ports);
	if (status < 0)
		return status;
D
David Brownell 已提交
148

149 150
	/* Allocate string descriptor numbers ... note that string
	 * contents can be overridden by the composite_dev glue.
151
	 */
L
Linus Torvalds 已提交
152

153 154
	/* device description: manufacturer, product */
	snprintf(manufacturer, sizeof manufacturer, "%s %s with %s",
155
		init_utsname()->sysname, init_utsname()->release,
L
Linus Torvalds 已提交
156
		gadget->name);
157 158 159 160
	status = usb_string_id(cdev);
	if (status < 0)
		goto fail;
	strings_dev[STRING_MANUFACTURER_IDX].id = status;
L
Linus Torvalds 已提交
161

162
	device_desc.iManufacturer = status;
L
Linus Torvalds 已提交
163

164 165 166 167
	status = usb_string_id(cdev);
	if (status < 0)
		goto fail;
	strings_dev[STRING_PRODUCT_IDX].id = status;
L
Linus Torvalds 已提交
168

169
	device_desc.iProduct = status;
L
Linus Torvalds 已提交
170

171 172 173 174 175
	/* config description */
	status = usb_string_id(cdev);
	if (status < 0)
		goto fail;
	strings_dev[STRING_DESCRIPTION_IDX].id = status;
L
Linus Torvalds 已提交
176

177
	serial_config_driver.iConfiguration = status;
L
Linus Torvalds 已提交
178

179 180 181 182 183 184 185 186 187 188 189
	/* set up other descriptors */
	gcnum = usb_gadget_controller_number(gadget);
	if (gcnum >= 0)
		device_desc.bcdDevice = cpu_to_le16(GS_VERSION_NUM | gcnum);
	else {
		/* this is so simple (for now, no altsettings) that it
		 * SHOULD NOT have problems with bulk-capable hardware.
		 * so warn about unrcognized controllers -- don't panic.
		 *
		 * things like configuration and altsetting numbering
		 * can need hardware-specific attention though.
190
		 */
191 192 193 194
		pr_warning("gs_bind: controller '%s' not recognized\n",
			gadget->name);
		device_desc.bcdDevice =
			__constant_cpu_to_le16(GS_VERSION_NUM | 0x0099);
195 196
	}

197 198 199
	if (gadget_is_otg(cdev->gadget)) {
		serial_config_driver.descriptors = otg_desc;
		serial_config_driver.bmAttributes |= USB_CONFIG_ATT_WAKEUP;
L
Linus Torvalds 已提交
200
	}
201

202 203 204 205
	/* register our configuration */
	status = usb_add_config(cdev, &serial_config_driver);
	if (status < 0)
		goto fail;
L
Linus Torvalds 已提交
206

207
	INFO(cdev, "%s\n", GS_VERSION_NAME);
L
Linus Torvalds 已提交
208

209
	return 0;
L
Linus Torvalds 已提交
210

211 212 213
fail:
	gserial_cleanup();
	return status;
L
Linus Torvalds 已提交
214 215
}

216 217 218 219 220
static struct usb_composite_driver gserial_driver = {
	.name		= "g_serial",
	.dev		= &device_desc,
	.strings	= dev_strings,
	.bind		= gs_bind,
221 222
};

223
static int __init init(void)
L
Linus Torvalds 已提交
224
{
225 226
	/* We *could* export two configs; that'd be much cleaner...
	 * but neither of these product IDs was defined that way.
227
	 */
L
Linus Torvalds 已提交
228
	if (use_acm) {
229 230 231 232 233
		serial_config_driver.label = "CDC ACM config";
		serial_config_driver.bConfigurationValue = 2;
		device_desc.bDeviceClass = USB_CLASS_COMM;
		device_desc.idProduct =
				__constant_cpu_to_le16(GS_CDC_PRODUCT_ID);
L
Linus Torvalds 已提交
234
	} else {
235 236 237 238 239
		serial_config_driver.label = "Generic Serial config";
		serial_config_driver.bConfigurationValue = 1;
		device_desc.bDeviceClass = USB_CLASS_VENDOR_SPEC;
		device_desc.idProduct =
				__constant_cpu_to_le16(GS_PRODUCT_ID);
L
Linus Torvalds 已提交
240
	}
241
	strings_dev[STRING_DESCRIPTION_IDX].s = serial_config_driver.label;
242

243
	return usb_composite_register(&gserial_driver);
244
}
245
module_init(init);
246

247
static void __exit cleanup(void)
248
{
249 250
	usb_composite_unregister(&gserial_driver);
	gserial_cleanup();
251
}
252
module_exit(cleanup);