Merge 4.11-rc4 into tty-next
[linux/fpc-iii.git] / drivers / usb / gadget / legacy / printer.c
blob4c9cfff34a03fde35060c559b4a67ce6c34ecaf9
1 /*
2 * printer.c -- Printer gadget driver
4 * Copyright (C) 2003-2005 David Brownell
5 * Copyright (C) 2006 Craig W. Nadler
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
13 #include <linux/module.h>
14 #include <linux/kernel.h>
15 #include <asm/byteorder.h>
17 #include <linux/usb/ch9.h>
18 #include <linux/usb/composite.h>
19 #include <linux/usb/gadget.h>
20 #include <linux/usb/g_printer.h>
22 USB_GADGET_COMPOSITE_OPTIONS();
24 #define DRIVER_DESC "Printer Gadget"
25 #define DRIVER_VERSION "2015 FEB 17"
27 static const char shortname [] = "printer";
28 static const char driver_desc [] = DRIVER_DESC;
30 #include "u_printer.h"
32 /*-------------------------------------------------------------------------*/
34 /* DO NOT REUSE THESE IDs with a protocol-incompatible driver!! Ever!!
35 * Instead: allocate your own, using normal USB-IF procedures.
38 /* Thanks to NetChip Technologies for donating this product ID.
40 #define PRINTER_VENDOR_NUM 0x0525 /* NetChip */
41 #define PRINTER_PRODUCT_NUM 0xa4a8 /* Linux-USB Printer Gadget */
43 /* Some systems will want different product identifiers published in the
44 * device descriptor, either numbers or strings or both. These string
45 * parameters are in UTF-8 (superset of ASCII's 7 bit characters).
48 module_param_named(iSerialNum, coverwrite.serial_number, charp, S_IRUGO);
49 MODULE_PARM_DESC(iSerialNum, "1");
51 static char *iPNPstring;
52 module_param(iPNPstring, charp, S_IRUGO);
53 MODULE_PARM_DESC(iPNPstring, "MFG:linux;MDL:g_printer;CLS:PRINTER;SN:1;");
55 /* Number of requests to allocate per endpoint, not used for ep0. */
56 static unsigned qlen = 10;
57 module_param(qlen, uint, S_IRUGO|S_IWUSR);
59 #define QLEN qlen
61 static struct usb_function_instance *fi_printer;
62 static struct usb_function *f_printer;
64 /*-------------------------------------------------------------------------*/
67 * DESCRIPTORS ... most are static, but strings and (full) configuration
68 * descriptors are built on demand.
71 static struct usb_device_descriptor device_desc = {
72 .bLength = sizeof device_desc,
73 .bDescriptorType = USB_DT_DEVICE,
74 /* .bcdUSB = DYNAMIC */
75 .bDeviceClass = USB_CLASS_PER_INTERFACE,
76 .bDeviceSubClass = 0,
77 .bDeviceProtocol = 0,
78 .idVendor = cpu_to_le16(PRINTER_VENDOR_NUM),
79 .idProduct = cpu_to_le16(PRINTER_PRODUCT_NUM),
80 .bNumConfigurations = 1
83 static const struct usb_descriptor_header *otg_desc[2];
85 /*-------------------------------------------------------------------------*/
87 /* descriptors that are built on-demand */
89 static char product_desc [40] = DRIVER_DESC;
90 static char serial_num [40] = "1";
91 static char *pnp_string =
92 "MFG:linux;MDL:g_printer;CLS:PRINTER;SN:1;";
94 /* static strings, in UTF-8 */
95 static struct usb_string strings [] = {
96 [USB_GADGET_MANUFACTURER_IDX].s = "",
97 [USB_GADGET_PRODUCT_IDX].s = product_desc,
98 [USB_GADGET_SERIAL_IDX].s = serial_num,
99 { } /* end of list */
102 static struct usb_gadget_strings stringtab_dev = {
103 .language = 0x0409, /* en-us */
104 .strings = strings,
107 static struct usb_gadget_strings *dev_strings[] = {
108 &stringtab_dev,
109 NULL,
112 static struct usb_configuration printer_cfg_driver = {
113 .label = "printer",
114 .bConfigurationValue = 1,
115 .bmAttributes = USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER,
118 static int printer_do_config(struct usb_configuration *c)
120 struct usb_gadget *gadget = c->cdev->gadget;
121 int status = 0;
123 usb_ep_autoconfig_reset(gadget);
125 usb_gadget_set_selfpowered(gadget);
127 if (gadget_is_otg(gadget)) {
128 printer_cfg_driver.descriptors = otg_desc;
129 printer_cfg_driver.bmAttributes |= USB_CONFIG_ATT_WAKEUP;
132 f_printer = usb_get_function(fi_printer);
133 if (IS_ERR(f_printer))
134 return PTR_ERR(f_printer);
136 status = usb_add_function(c, f_printer);
137 if (status < 0)
138 usb_put_function(f_printer);
140 return status;
143 static int printer_bind(struct usb_composite_dev *cdev)
145 struct f_printer_opts *opts;
146 int ret;
148 fi_printer = usb_get_function_instance("printer");
149 if (IS_ERR(fi_printer))
150 return PTR_ERR(fi_printer);
152 opts = container_of(fi_printer, struct f_printer_opts, func_inst);
153 opts->minor = 0;
154 opts->q_len = QLEN;
155 if (iPNPstring) {
156 opts->pnp_string = kstrdup(iPNPstring, GFP_KERNEL);
157 if (!opts->pnp_string) {
158 ret = -ENOMEM;
159 goto fail_put_func_inst;
161 opts->pnp_string_allocated = true;
163 * we don't free this memory in case of error
164 * as printer cleanup func will do this for us
166 } else {
167 opts->pnp_string = pnp_string;
170 ret = usb_string_ids_tab(cdev, strings);
171 if (ret < 0)
172 goto fail_put_func_inst;
174 device_desc.iManufacturer = strings[USB_GADGET_MANUFACTURER_IDX].id;
175 device_desc.iProduct = strings[USB_GADGET_PRODUCT_IDX].id;
176 device_desc.iSerialNumber = strings[USB_GADGET_SERIAL_IDX].id;
178 if (gadget_is_otg(cdev->gadget) && !otg_desc[0]) {
179 struct usb_descriptor_header *usb_desc;
181 usb_desc = usb_otg_descriptor_alloc(cdev->gadget);
182 if (!usb_desc) {
183 ret = -ENOMEM;
184 goto fail_put_func_inst;
186 usb_otg_descriptor_init(cdev->gadget, usb_desc);
187 otg_desc[0] = usb_desc;
188 otg_desc[1] = NULL;
191 ret = usb_add_config(cdev, &printer_cfg_driver, printer_do_config);
192 if (ret)
193 goto fail_free_otg_desc;
195 usb_composite_overwrite_options(cdev, &coverwrite);
196 return ret;
198 fail_free_otg_desc:
199 kfree(otg_desc[0]);
200 otg_desc[0] = NULL;
201 fail_put_func_inst:
202 usb_put_function_instance(fi_printer);
203 return ret;
206 static int printer_unbind(struct usb_composite_dev *cdev)
208 usb_put_function(f_printer);
209 usb_put_function_instance(fi_printer);
211 kfree(otg_desc[0]);
212 otg_desc[0] = NULL;
214 return 0;
217 static struct usb_composite_driver printer_driver = {
218 .name = shortname,
219 .dev = &device_desc,
220 .strings = dev_strings,
221 .max_speed = USB_SPEED_SUPER,
222 .bind = printer_bind,
223 .unbind = printer_unbind,
226 module_usb_composite_driver(printer_driver);
228 MODULE_DESCRIPTION(DRIVER_DESC);
229 MODULE_AUTHOR("Craig Nadler");
230 MODULE_LICENSE("GPL");