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.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 #include <linux/module.h>
23 #include <linux/kernel.h>
24 #include <linux/delay.h>
25 #include <linux/ioport.h>
26 #include <linux/sched.h>
27 #include <linux/slab.h>
28 #include <linux/smp_lock.h>
29 #include <linux/errno.h>
30 #include <linux/init.h>
31 #include <linux/timer.h>
32 #include <linux/list.h>
33 #include <linux/interrupt.h>
34 #include <linux/utsname.h>
35 #include <linux/device.h>
36 #include <linux/moduleparam.h>
38 #include <linux/poll.h>
39 #include <linux/types.h>
40 #include <linux/ctype.h>
41 #include <linux/cdev.h>
43 #include <asm/byteorder.h>
45 #include <linux/irq.h>
46 #include <asm/system.h>
47 #include <linux/uaccess.h>
48 #include <asm/unaligned.h>
50 #include <linux/usb/ch9.h>
51 #include <linux/usb/gadget.h>
52 #include <linux/usb/g_printer.h>
54 #include "gadget_chips.h"
58 * Kbuild is not very cooperative with respect to linking separately
59 * compiled library objects into one module. So for now we won't use
60 * separate compilation ... ensuring init/exit sections work to shrink
61 * the runtime footprint, and giving us at least some parts of what
62 * a "gcc --combine ... part1.c part2.c part3.c ... " build would.
64 #include "usbstring.c"
66 #include "epautoconf.c"
68 /*-------------------------------------------------------------------------*/
70 #define DRIVER_DESC "Printer Gadget"
71 #define DRIVER_VERSION "2007 OCT 06"
73 static const char shortname [] = "printer";
74 static const char driver_desc [] = DRIVER_DESC;
76 static dev_t g_printer_devno;
78 static struct class *usb_gadget_class;
80 /*-------------------------------------------------------------------------*/
83 spinlock_t lock; /* lock this structure */
84 /* lock buffer lists during read/write calls */
85 spinlock_t lock_printer_io;
86 struct usb_gadget *gadget;
87 struct usb_request *req; /* for control responses */
90 struct usb_ep *in_ep, *out_ep;
91 const struct usb_endpoint_descriptor
93 struct list_head rx_reqs; /* List of free RX structs */
94 struct list_head rx_reqs_active; /* List of Active RX xfers */
95 struct list_head rx_buffers; /* List of completed xfers */
96 /* wait until there is data to be read. */
97 wait_queue_head_t rx_wait;
98 struct list_head tx_reqs; /* List of free TX structs */
99 struct list_head tx_reqs_active; /* List of Active TX xfers */
100 /* Wait until there are write buffers available to use. */
101 wait_queue_head_t tx_wait;
102 /* Wait until all write buffers have been sent. */
103 wait_queue_head_t tx_flush_wait;
104 struct usb_request *current_rx_req;
105 size_t current_rx_bytes;
109 struct cdev printer_cdev;
111 u8 printer_cdev_open;
112 wait_queue_head_t wait;
115 static struct printer_dev usb_printer_gadget;
117 /*-------------------------------------------------------------------------*/
119 /* DO NOT REUSE THESE IDs with a protocol-incompatible driver!! Ever!!
120 * Instead: allocate your own, using normal USB-IF procedures.
123 /* Thanks to NetChip Technologies for donating this product ID.
125 #define PRINTER_VENDOR_NUM 0x0525 /* NetChip */
126 #define PRINTER_PRODUCT_NUM 0xa4a8 /* Linux-USB Printer Gadget */
128 /* Some systems will want different product identifers published in the
129 * device descriptor, either numbers or strings or both. These string
130 * parameters are in UTF-8 (superset of ASCII's 7 bit characters).
133 static ushort __initdata idVendor;
134 module_param(idVendor, ushort, S_IRUGO);
135 MODULE_PARM_DESC(idVendor, "USB Vendor ID");
137 static ushort __initdata idProduct;
138 module_param(idProduct, ushort, S_IRUGO);
139 MODULE_PARM_DESC(idProduct, "USB Product ID");
141 static ushort __initdata bcdDevice;
142 module_param(bcdDevice, ushort, S_IRUGO);
143 MODULE_PARM_DESC(bcdDevice, "USB Device version (BCD)");
145 static char *__initdata iManufacturer;
146 module_param(iManufacturer, charp, S_IRUGO);
147 MODULE_PARM_DESC(iManufacturer, "USB Manufacturer string");
149 static char *__initdata iProduct;
150 module_param(iProduct, charp, S_IRUGO);
151 MODULE_PARM_DESC(iProduct, "USB Product string");
153 static char *__initdata iSerialNum;
154 module_param(iSerialNum, charp, S_IRUGO);
155 MODULE_PARM_DESC(iSerialNum, "1");
157 static char *__initdata iPNPstring;
158 module_param(iPNPstring, charp, S_IRUGO);
159 MODULE_PARM_DESC(iPNPstring, "MFG:linux;MDL:g_printer;CLS:PRINTER;SN:1;");
161 /* Number of requests to allocate per endpoint, not used for ep0. */
162 static unsigned qlen = 10;
163 module_param(qlen, uint, S_IRUGO|S_IWUSR);
167 #ifdef CONFIG_USB_GADGET_DUALSPEED
168 #define DEVSPEED USB_SPEED_HIGH
169 #else /* full speed (low speed doesn't do bulk) */
170 #define DEVSPEED USB_SPEED_FULL
173 /*-------------------------------------------------------------------------*/
175 #define xprintk(d, level, fmt, args...) \
176 printk(level "%s: " fmt, DRIVER_DESC, ## args)
179 #define DBG(dev, fmt, args...) \
180 xprintk(dev, KERN_DEBUG, fmt, ## args)
182 #define DBG(dev, fmt, args...) \
187 #define VDBG(dev, fmt, args...) \
188 xprintk(dev, KERN_DEBUG, fmt, ## args)
190 #define VDBG(dev, fmt, args...) \
194 #define ERROR(dev, fmt, args...) \
195 xprintk(dev, KERN_ERR, fmt, ## args)
196 #define WARNING(dev, fmt, args...) \
197 xprintk(dev, KERN_WARNING, fmt, ## args)
198 #define INFO(dev, fmt, args...) \
199 xprintk(dev, KERN_INFO, fmt, ## args)
201 /*-------------------------------------------------------------------------*/
203 /* USB DRIVER HOOKUP (to the hardware driver, below us), mostly
204 * ep0 implementation: descriptors, config management, setup().
205 * also optional class-specific notification interrupt transfer.
209 * DESCRIPTORS ... most are static, but strings and (full) configuration
210 * descriptors are built on demand.
213 #define STRING_MANUFACTURER 1
214 #define STRING_PRODUCT 2
215 #define STRING_SERIALNUM 3
217 /* holds our biggest descriptor */
218 #define USB_DESC_BUFSIZE 256
219 #define USB_BUFSIZE 8192
221 /* This device advertises one configuration. */
222 #define DEV_CONFIG_VALUE 1
223 #define PRINTER_INTERFACE 0
225 static struct usb_device_descriptor device_desc = {
226 .bLength = sizeof device_desc,
227 .bDescriptorType = USB_DT_DEVICE,
228 .bcdUSB = cpu_to_le16(0x0200),
229 .bDeviceClass = USB_CLASS_PER_INTERFACE,
230 .bDeviceSubClass = 0,
231 .bDeviceProtocol = 0,
232 .idVendor = cpu_to_le16(PRINTER_VENDOR_NUM),
233 .idProduct = cpu_to_le16(PRINTER_PRODUCT_NUM),
234 .iManufacturer = STRING_MANUFACTURER,
235 .iProduct = STRING_PRODUCT,
236 .iSerialNumber = STRING_SERIALNUM,
237 .bNumConfigurations = 1
240 static struct usb_otg_descriptor otg_desc = {
241 .bLength = sizeof otg_desc,
242 .bDescriptorType = USB_DT_OTG,
243 .bmAttributes = USB_OTG_SRP
246 static struct usb_config_descriptor config_desc = {
247 .bLength = sizeof config_desc,
248 .bDescriptorType = USB_DT_CONFIG,
250 /* compute wTotalLength on the fly */
252 .bConfigurationValue = DEV_CONFIG_VALUE,
254 .bmAttributes = USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER,
255 .bMaxPower = CONFIG_USB_GADGET_VBUS_DRAW / 2,
258 static struct usb_interface_descriptor intf_desc = {
259 .bLength = sizeof intf_desc,
260 .bDescriptorType = USB_DT_INTERFACE,
261 .bInterfaceNumber = PRINTER_INTERFACE,
263 .bInterfaceClass = USB_CLASS_PRINTER,
264 .bInterfaceSubClass = 1, /* Printer Sub-Class */
265 .bInterfaceProtocol = 2, /* Bi-Directional */
269 static struct usb_endpoint_descriptor fs_ep_in_desc = {
270 .bLength = USB_DT_ENDPOINT_SIZE,
271 .bDescriptorType = USB_DT_ENDPOINT,
272 .bEndpointAddress = USB_DIR_IN,
273 .bmAttributes = USB_ENDPOINT_XFER_BULK
276 static struct usb_endpoint_descriptor fs_ep_out_desc = {
277 .bLength = USB_DT_ENDPOINT_SIZE,
278 .bDescriptorType = USB_DT_ENDPOINT,
279 .bEndpointAddress = USB_DIR_OUT,
280 .bmAttributes = USB_ENDPOINT_XFER_BULK
283 static const struct usb_descriptor_header *fs_printer_function [11] = {
284 (struct usb_descriptor_header *) &otg_desc,
285 (struct usb_descriptor_header *) &intf_desc,
286 (struct usb_descriptor_header *) &fs_ep_in_desc,
287 (struct usb_descriptor_header *) &fs_ep_out_desc,
291 #ifdef CONFIG_USB_GADGET_DUALSPEED
294 * usb 2.0 devices need to expose both high speed and full speed
295 * descriptors, unless they only run at full speed.
298 static struct usb_endpoint_descriptor hs_ep_in_desc = {
299 .bLength = USB_DT_ENDPOINT_SIZE,
300 .bDescriptorType = USB_DT_ENDPOINT,
301 .bmAttributes = USB_ENDPOINT_XFER_BULK,
302 .wMaxPacketSize = cpu_to_le16(512)
305 static struct usb_endpoint_descriptor hs_ep_out_desc = {
306 .bLength = USB_DT_ENDPOINT_SIZE,
307 .bDescriptorType = USB_DT_ENDPOINT,
308 .bmAttributes = USB_ENDPOINT_XFER_BULK,
309 .wMaxPacketSize = cpu_to_le16(512)
312 static struct usb_qualifier_descriptor dev_qualifier = {
313 .bLength = sizeof dev_qualifier,
314 .bDescriptorType = USB_DT_DEVICE_QUALIFIER,
315 .bcdUSB = cpu_to_le16(0x0200),
316 .bDeviceClass = USB_CLASS_PRINTER,
317 .bNumConfigurations = 1
320 static const struct usb_descriptor_header *hs_printer_function [11] = {
321 (struct usb_descriptor_header *) &otg_desc,
322 (struct usb_descriptor_header *) &intf_desc,
323 (struct usb_descriptor_header *) &hs_ep_in_desc,
324 (struct usb_descriptor_header *) &hs_ep_out_desc,
328 /* maxpacket and other transfer characteristics vary by speed. */
329 #define ep_desc(g, hs, fs) (((g)->speed == USB_SPEED_HIGH)?(hs):(fs))
333 /* if there's no high speed support, maxpacket doesn't change. */
334 #define ep_desc(g, hs, fs) (((void)(g)), (fs))
336 #endif /* !CONFIG_USB_GADGET_DUALSPEED */
338 /*-------------------------------------------------------------------------*/
340 /* descriptors that are built on-demand */
342 static char manufacturer [50];
343 static char product_desc [40] = DRIVER_DESC;
344 static char serial_num [40] = "1";
345 static char pnp_string [1024] =
346 "XXMFG:linux;MDL:g_printer;CLS:PRINTER;SN:1;";
348 /* static strings, in UTF-8 */
349 static struct usb_string strings [] = {
350 { STRING_MANUFACTURER, manufacturer, },
351 { STRING_PRODUCT, product_desc, },
352 { STRING_SERIALNUM, serial_num, },
353 { } /* end of list */
356 static struct usb_gadget_strings stringtab = {
357 .language = 0x0409, /* en-us */
361 /*-------------------------------------------------------------------------*/
363 static struct usb_request *
364 printer_req_alloc(struct usb_ep *ep, unsigned len, gfp_t gfp_flags)
366 struct usb_request *req;
368 req = usb_ep_alloc_request(ep, gfp_flags);
372 req->buf = kmalloc(len, gfp_flags);
373 if (req->buf == NULL) {
374 usb_ep_free_request(ep, req);
383 printer_req_free(struct usb_ep *ep, struct usb_request *req)
385 if (ep != NULL && req != NULL) {
387 usb_ep_free_request(ep, req);
391 /*-------------------------------------------------------------------------*/
393 static void rx_complete(struct usb_ep *ep, struct usb_request *req)
395 struct printer_dev *dev = ep->driver_data;
396 int status = req->status;
399 spin_lock_irqsave(&dev->lock, flags);
401 list_del_init(&req->list); /* Remode from Active List */
405 /* normal completion */
407 if (req->actual > 0) {
408 list_add_tail(&req->list, &dev->rx_buffers);
409 DBG(dev, "G_Printer : rx length %d\n", req->actual);
411 list_add(&req->list, &dev->rx_reqs);
415 /* software-driven interface shutdown */
416 case -ECONNRESET: /* unlink */
417 case -ESHUTDOWN: /* disconnect etc */
418 VDBG(dev, "rx shutdown, code %d\n", status);
419 list_add(&req->list, &dev->rx_reqs);
422 /* for hardware automagic (such as pxa) */
423 case -ECONNABORTED: /* endpoint reset */
424 DBG(dev, "rx %s reset\n", ep->name);
425 list_add(&req->list, &dev->rx_reqs);
433 DBG(dev, "rx status %d\n", status);
434 list_add(&req->list, &dev->rx_reqs);
438 wake_up_interruptible(&dev->rx_wait);
439 spin_unlock_irqrestore(&dev->lock, flags);
442 static void tx_complete(struct usb_ep *ep, struct usb_request *req)
444 struct printer_dev *dev = ep->driver_data;
446 switch (req->status) {
448 VDBG(dev, "tx err %d\n", req->status);
450 case -ECONNRESET: /* unlink */
451 case -ESHUTDOWN: /* disconnect etc */
457 spin_lock(&dev->lock);
458 /* Take the request struct off the active list and put it on the
461 list_del_init(&req->list);
462 list_add(&req->list, &dev->tx_reqs);
463 wake_up_interruptible(&dev->tx_wait);
464 if (likely(list_empty(&dev->tx_reqs_active)))
465 wake_up_interruptible(&dev->tx_flush_wait);
467 spin_unlock(&dev->lock);
470 /*-------------------------------------------------------------------------*/
473 printer_open(struct inode *inode, struct file *fd)
475 struct printer_dev *dev;
480 dev = container_of(inode->i_cdev, struct printer_dev, printer_cdev);
482 spin_lock_irqsave(&dev->lock, flags);
484 if (!dev->printer_cdev_open) {
485 dev->printer_cdev_open = 1;
486 fd->private_data = dev;
488 /* Change the printer status to show that it's on-line. */
489 dev->printer_status |= PRINTER_SELECTED;
492 spin_unlock_irqrestore(&dev->lock, flags);
494 DBG(dev, "printer_open returned %x\n", ret);
500 printer_close(struct inode *inode, struct file *fd)
502 struct printer_dev *dev = fd->private_data;
505 spin_lock_irqsave(&dev->lock, flags);
506 dev->printer_cdev_open = 0;
507 fd->private_data = NULL;
508 /* Change printer status to show that the printer is off-line. */
509 dev->printer_status &= ~PRINTER_SELECTED;
510 spin_unlock_irqrestore(&dev->lock, flags);
512 DBG(dev, "printer_close\n");
517 /* This function must be called with interrupts turned off. */
519 setup_rx_reqs(struct printer_dev *dev)
521 struct usb_request *req;
523 while (likely(!list_empty(&dev->rx_reqs))) {
526 req = container_of(dev->rx_reqs.next,
527 struct usb_request, list);
528 list_del_init(&req->list);
530 /* The USB Host sends us whatever amount of data it wants to
531 * so we always set the length field to the full USB_BUFSIZE.
532 * If the amount of data is more than the read() caller asked
533 * for it will be stored in the request buffer until it is
534 * asked for by read().
536 req->length = USB_BUFSIZE;
537 req->complete = rx_complete;
539 error = usb_ep_queue(dev->out_ep, req, GFP_ATOMIC);
541 DBG(dev, "rx submit --> %d\n", error);
542 list_add(&req->list, &dev->rx_reqs);
545 list_add(&req->list, &dev->rx_reqs_active);
551 printer_read(struct file *fd, char __user *buf, size_t len, loff_t *ptr)
553 struct printer_dev *dev = fd->private_data;
557 struct usb_request *req;
558 /* This is a pointer to the current USB rx request. */
559 struct usb_request *current_rx_req;
560 /* This is the number of bytes in the current rx buffer. */
561 size_t current_rx_bytes;
562 /* This is a pointer to the current rx buffer. */
568 DBG(dev, "printer_read trying to read %d bytes\n", (int)len);
570 spin_lock(&dev->lock_printer_io);
571 spin_lock_irqsave(&dev->lock, flags);
573 /* We will use this flag later to check if a printer reset happened
574 * after we turn interrupts back on.
576 dev->reset_printer = 0;
581 current_rx_req = dev->current_rx_req;
582 current_rx_bytes = dev->current_rx_bytes;
583 current_rx_buf = dev->current_rx_buf;
584 dev->current_rx_req = NULL;
585 dev->current_rx_bytes = 0;
586 dev->current_rx_buf = NULL;
588 /* Check if there is any data in the read buffers. Please note that
589 * current_rx_bytes is the number of bytes in the current rx buffer.
590 * If it is zero then check if there are any other rx_buffers that
591 * are on the completed list. We are only out of data if all rx
594 if ((current_rx_bytes == 0) &&
595 (likely(list_empty(&dev->rx_buffers)))) {
596 /* Turn interrupts back on before sleeping. */
597 spin_unlock_irqrestore(&dev->lock, flags);
600 * If no data is available check if this is a NON-Blocking
603 if (fd->f_flags & (O_NONBLOCK|O_NDELAY)) {
604 spin_unlock(&dev->lock_printer_io);
608 /* Sleep until data is available */
609 wait_event_interruptible(dev->rx_wait,
610 (likely(!list_empty(&dev->rx_buffers))));
611 spin_lock_irqsave(&dev->lock, flags);
614 /* We have data to return then copy it to the caller's buffer.*/
615 while ((current_rx_bytes || likely(!list_empty(&dev->rx_buffers)))
617 if (current_rx_bytes == 0) {
618 req = container_of(dev->rx_buffers.next,
619 struct usb_request, list);
620 list_del_init(&req->list);
622 if (req->actual && req->buf) {
623 current_rx_req = req;
624 current_rx_bytes = req->actual;
625 current_rx_buf = req->buf;
627 list_add(&req->list, &dev->rx_reqs);
632 /* Don't leave irqs off while doing memory copies */
633 spin_unlock_irqrestore(&dev->lock, flags);
635 if (len > current_rx_bytes)
636 size = current_rx_bytes;
640 size -= copy_to_user(buf, current_rx_buf, size);
641 bytes_copied += size;
645 spin_lock_irqsave(&dev->lock, flags);
647 /* We've disconnected or reset so return. */
648 if (dev->reset_printer) {
649 list_add(¤t_rx_req->list, &dev->rx_reqs);
650 spin_unlock_irqrestore(&dev->lock, flags);
651 spin_unlock(&dev->lock_printer_io);
655 /* If we not returning all the data left in this RX request
656 * buffer then adjust the amount of data left in the buffer.
657 * Othewise if we are done with this RX request buffer then
658 * requeue it to get any incoming data from the USB host.
660 if (size < current_rx_bytes) {
661 current_rx_bytes -= size;
662 current_rx_buf += size;
664 list_add(¤t_rx_req->list, &dev->rx_reqs);
665 current_rx_bytes = 0;
666 current_rx_buf = NULL;
667 current_rx_req = NULL;
671 dev->current_rx_req = current_rx_req;
672 dev->current_rx_bytes = current_rx_bytes;
673 dev->current_rx_buf = current_rx_buf;
675 spin_unlock_irqrestore(&dev->lock, flags);
676 spin_unlock(&dev->lock_printer_io);
678 DBG(dev, "printer_read returned %d bytes\n", (int)bytes_copied);
687 printer_write(struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
689 struct printer_dev *dev = fd->private_data;
691 size_t size; /* Amount of data in a TX request. */
692 size_t bytes_copied = 0;
693 struct usb_request *req;
695 DBG(dev, "printer_write trying to send %d bytes\n", (int)len);
700 spin_lock(&dev->lock_printer_io);
701 spin_lock_irqsave(&dev->lock, flags);
703 /* Check if a printer reset happens while we have interrupts on */
704 dev->reset_printer = 0;
706 /* Check if there is any available write buffers */
707 if (likely(list_empty(&dev->tx_reqs))) {
708 /* Turn interrupts back on before sleeping. */
709 spin_unlock_irqrestore(&dev->lock, flags);
712 * If write buffers are available check if this is
713 * a NON-Blocking call or not.
715 if (fd->f_flags & (O_NONBLOCK|O_NDELAY)) {
716 spin_unlock(&dev->lock_printer_io);
720 /* Sleep until a write buffer is available */
721 wait_event_interruptible(dev->tx_wait,
722 (likely(!list_empty(&dev->tx_reqs))));
723 spin_lock_irqsave(&dev->lock, flags);
726 while (likely(!list_empty(&dev->tx_reqs)) && len) {
728 if (len > USB_BUFSIZE)
733 req = container_of(dev->tx_reqs.next, struct usb_request,
735 list_del_init(&req->list);
737 req->complete = tx_complete;
740 /* Check if we need to send a zero length packet. */
742 /* They will be more TX requests so no yet. */
745 /* If the data amount is not a multple of the
746 * maxpacket size then send a zero length packet.
748 req->zero = ((len % dev->in_ep->maxpacket) == 0);
750 /* Don't leave irqs off while doing memory copies */
751 spin_unlock_irqrestore(&dev->lock, flags);
753 if (copy_from_user(req->buf, buf, size)) {
754 list_add(&req->list, &dev->tx_reqs);
755 spin_unlock(&dev->lock_printer_io);
759 bytes_copied += size;
763 spin_lock_irqsave(&dev->lock, flags);
765 /* We've disconnected or reset so free the req and buffer */
766 if (dev->reset_printer) {
767 list_add(&req->list, &dev->tx_reqs);
768 spin_unlock_irqrestore(&dev->lock, flags);
769 spin_unlock(&dev->lock_printer_io);
773 if (usb_ep_queue(dev->in_ep, req, GFP_ATOMIC)) {
774 list_add(&req->list, &dev->tx_reqs);
775 spin_unlock_irqrestore(&dev->lock, flags);
776 spin_unlock(&dev->lock_printer_io);
780 list_add(&req->list, &dev->tx_reqs_active);
784 spin_unlock_irqrestore(&dev->lock, flags);
785 spin_unlock(&dev->lock_printer_io);
787 DBG(dev, "printer_write sent %d bytes\n", (int)bytes_copied);
797 printer_fsync(struct file *fd, int datasync)
799 struct printer_dev *dev = fd->private_data;
803 spin_lock_irqsave(&dev->lock, flags);
804 tx_list_empty = (likely(list_empty(&dev->tx_reqs)));
805 spin_unlock_irqrestore(&dev->lock, flags);
807 if (!tx_list_empty) {
808 /* Sleep until all data has been sent */
809 wait_event_interruptible(dev->tx_flush_wait,
810 (likely(list_empty(&dev->tx_reqs_active))));
817 printer_poll(struct file *fd, poll_table *wait)
819 struct printer_dev *dev = fd->private_data;
823 spin_lock(&dev->lock_printer_io);
824 spin_lock_irqsave(&dev->lock, flags);
826 spin_unlock_irqrestore(&dev->lock, flags);
827 spin_unlock(&dev->lock_printer_io);
829 poll_wait(fd, &dev->rx_wait, wait);
830 poll_wait(fd, &dev->tx_wait, wait);
832 spin_lock_irqsave(&dev->lock, flags);
833 if (likely(!list_empty(&dev->tx_reqs)))
834 status |= POLLOUT | POLLWRNORM;
836 if (likely(dev->current_rx_bytes) ||
837 likely(!list_empty(&dev->rx_buffers)))
838 status |= POLLIN | POLLRDNORM;
840 spin_unlock_irqrestore(&dev->lock, flags);
846 printer_ioctl(struct file *fd, unsigned int code, unsigned long arg)
848 struct printer_dev *dev = fd->private_data;
852 DBG(dev, "printer_ioctl: cmd=0x%4.4x, arg=%lu\n", code, arg);
856 spin_lock_irqsave(&dev->lock, flags);
859 case GADGET_GET_PRINTER_STATUS:
860 status = (int)dev->printer_status;
862 case GADGET_SET_PRINTER_STATUS:
863 dev->printer_status = (u8)arg;
866 /* could not handle ioctl */
867 DBG(dev, "printer_ioctl: ERROR cmd=0x%4.4xis not supported\n",
872 spin_unlock_irqrestore(&dev->lock, flags);
877 /* used after endpoint configuration */
878 static const struct file_operations printer_io_operations = {
879 .owner = THIS_MODULE,
880 .open = printer_open,
881 .read = printer_read,
882 .write = printer_write,
883 .fsync = printer_fsync,
884 .poll = printer_poll,
885 .unlocked_ioctl = printer_ioctl,
886 .release = printer_close
889 /*-------------------------------------------------------------------------*/
892 set_printer_interface(struct printer_dev *dev)
896 dev->in = ep_desc(dev->gadget, &hs_ep_in_desc, &fs_ep_in_desc);
897 dev->in_ep->driver_data = dev;
899 dev->out = ep_desc(dev->gadget, &hs_ep_out_desc, &fs_ep_out_desc);
900 dev->out_ep->driver_data = dev;
902 result = usb_ep_enable(dev->in_ep, dev->in);
904 DBG(dev, "enable %s --> %d\n", dev->in_ep->name, result);
908 result = usb_ep_enable(dev->out_ep, dev->out);
910 DBG(dev, "enable %s --> %d\n", dev->in_ep->name, result);
915 /* on error, disable any endpoints */
917 (void) usb_ep_disable(dev->in_ep);
918 (void) usb_ep_disable(dev->out_ep);
923 /* caller is responsible for cleanup on error */
927 static void printer_reset_interface(struct printer_dev *dev)
929 if (dev->interface < 0)
932 DBG(dev, "%s\n", __func__);
935 usb_ep_disable(dev->in_ep);
938 usb_ep_disable(dev->out_ep);
943 /* change our operational config. must agree with the code
944 * that returns config descriptors, and altsetting code.
947 printer_set_config(struct printer_dev *dev, unsigned number)
950 struct usb_gadget *gadget = dev->gadget;
953 case DEV_CONFIG_VALUE:
964 usb_gadget_vbus_draw(dev->gadget,
965 dev->gadget->is_otg ? 8 : 100);
970 power = 2 * config_desc.bMaxPower;
971 usb_gadget_vbus_draw(dev->gadget, power);
973 switch (gadget->speed) {
974 case USB_SPEED_FULL: speed = "full"; break;
975 #ifdef CONFIG_USB_GADGET_DUALSPEED
976 case USB_SPEED_HIGH: speed = "high"; break;
978 default: speed = "?"; break;
981 dev->config = number;
982 INFO(dev, "%s speed config #%d: %d mA, %s\n",
983 speed, number, power, driver_desc);
989 config_buf(enum usb_device_speed speed, u8 *buf, u8 type, unsigned index,
993 const struct usb_descriptor_header **function;
994 #ifdef CONFIG_USB_GADGET_DUALSPEED
995 int hs = (speed == USB_SPEED_HIGH);
997 if (type == USB_DT_OTHER_SPEED_CONFIG)
1001 function = hs_printer_function;
1003 function = fs_printer_function;
1006 function = fs_printer_function;
1009 if (index >= device_desc.bNumConfigurations)
1012 /* for now, don't advertise srp-only devices */
1016 len = usb_gadget_config_buf(&config_desc, buf, USB_DESC_BUFSIZE,
1020 ((struct usb_config_descriptor *) buf)->bDescriptorType = type;
1024 /* Change our operational Interface. */
1026 set_interface(struct printer_dev *dev, unsigned number)
1030 /* Free the current interface */
1031 switch (dev->interface) {
1032 case PRINTER_INTERFACE:
1033 printer_reset_interface(dev);
1038 case PRINTER_INTERFACE:
1039 result = set_printer_interface(dev);
1041 printer_reset_interface(dev);
1043 dev->interface = PRINTER_INTERFACE;
1052 INFO(dev, "Using interface %x\n", number);
1057 static void printer_setup_complete(struct usb_ep *ep, struct usb_request *req)
1059 if (req->status || req->actual != req->length)
1060 DBG((struct printer_dev *) ep->driver_data,
1061 "setup complete --> %d, %d/%d\n",
1062 req->status, req->actual, req->length);
1065 static void printer_soft_reset(struct printer_dev *dev)
1067 struct usb_request *req;
1069 INFO(dev, "Received Printer Reset Request\n");
1071 if (usb_ep_disable(dev->in_ep))
1072 DBG(dev, "Failed to disable USB in_ep\n");
1073 if (usb_ep_disable(dev->out_ep))
1074 DBG(dev, "Failed to disable USB out_ep\n");
1076 if (dev->current_rx_req != NULL) {
1077 list_add(&dev->current_rx_req->list, &dev->rx_reqs);
1078 dev->current_rx_req = NULL;
1080 dev->current_rx_bytes = 0;
1081 dev->current_rx_buf = NULL;
1082 dev->reset_printer = 1;
1084 while (likely(!(list_empty(&dev->rx_buffers)))) {
1085 req = container_of(dev->rx_buffers.next, struct usb_request,
1087 list_del_init(&req->list);
1088 list_add(&req->list, &dev->rx_reqs);
1091 while (likely(!(list_empty(&dev->rx_reqs_active)))) {
1092 req = container_of(dev->rx_buffers.next, struct usb_request,
1094 list_del_init(&req->list);
1095 list_add(&req->list, &dev->rx_reqs);
1098 while (likely(!(list_empty(&dev->tx_reqs_active)))) {
1099 req = container_of(dev->tx_reqs_active.next,
1100 struct usb_request, list);
1101 list_del_init(&req->list);
1102 list_add(&req->list, &dev->tx_reqs);
1105 if (usb_ep_enable(dev->in_ep, dev->in))
1106 DBG(dev, "Failed to enable USB in_ep\n");
1107 if (usb_ep_enable(dev->out_ep, dev->out))
1108 DBG(dev, "Failed to enable USB out_ep\n");
1110 wake_up_interruptible(&dev->rx_wait);
1111 wake_up_interruptible(&dev->tx_wait);
1112 wake_up_interruptible(&dev->tx_flush_wait);
1115 /*-------------------------------------------------------------------------*/
1118 * The setup() callback implements all the ep0 functionality that's not
1119 * handled lower down.
1122 printer_setup(struct usb_gadget *gadget, const struct usb_ctrlrequest *ctrl)
1124 struct printer_dev *dev = get_gadget_data(gadget);
1125 struct usb_request *req = dev->req;
1126 int value = -EOPNOTSUPP;
1127 u16 wIndex = le16_to_cpu(ctrl->wIndex);
1128 u16 wValue = le16_to_cpu(ctrl->wValue);
1129 u16 wLength = le16_to_cpu(ctrl->wLength);
1131 DBG(dev, "ctrl req%02x.%02x v%04x i%04x l%d\n",
1132 ctrl->bRequestType, ctrl->bRequest, wValue, wIndex, wLength);
1134 req->complete = printer_setup_complete;
1136 switch (ctrl->bRequestType&USB_TYPE_MASK) {
1138 case USB_TYPE_STANDARD:
1139 switch (ctrl->bRequest) {
1141 case USB_REQ_GET_DESCRIPTOR:
1142 if (ctrl->bRequestType != USB_DIR_IN)
1144 switch (wValue >> 8) {
1147 value = min(wLength, (u16) sizeof device_desc);
1148 memcpy(req->buf, &device_desc, value);
1150 #ifdef CONFIG_USB_GADGET_DUALSPEED
1151 case USB_DT_DEVICE_QUALIFIER:
1152 if (!gadget->is_dualspeed)
1154 value = min(wLength,
1155 (u16) sizeof dev_qualifier);
1156 memcpy(req->buf, &dev_qualifier, value);
1159 case USB_DT_OTHER_SPEED_CONFIG:
1160 if (!gadget->is_dualspeed)
1163 #endif /* CONFIG_USB_GADGET_DUALSPEED */
1165 value = config_buf(gadget->speed, req->buf,
1170 value = min(wLength, (u16) value);
1174 value = usb_gadget_get_string(&stringtab,
1175 wValue & 0xff, req->buf);
1177 value = min(wLength, (u16) value);
1182 case USB_REQ_SET_CONFIGURATION:
1183 if (ctrl->bRequestType != 0)
1185 if (gadget->a_hnp_support)
1186 DBG(dev, "HNP available\n");
1187 else if (gadget->a_alt_hnp_support)
1188 DBG(dev, "HNP needs a different root port\n");
1189 value = printer_set_config(dev, wValue);
1191 case USB_REQ_GET_CONFIGURATION:
1192 if (ctrl->bRequestType != USB_DIR_IN)
1194 *(u8 *)req->buf = dev->config;
1195 value = min(wLength, (u16) 1);
1198 case USB_REQ_SET_INTERFACE:
1199 if (ctrl->bRequestType != USB_RECIP_INTERFACE ||
1203 value = set_interface(dev, PRINTER_INTERFACE);
1205 case USB_REQ_GET_INTERFACE:
1206 if (ctrl->bRequestType !=
1207 (USB_DIR_IN|USB_RECIP_INTERFACE)
1211 *(u8 *)req->buf = dev->interface;
1212 value = min(wLength, (u16) 1);
1220 case USB_TYPE_CLASS:
1221 switch (ctrl->bRequest) {
1222 case 0: /* Get the IEEE-1284 PNP String */
1223 /* Only one printer interface is supported. */
1224 if ((wIndex>>8) != PRINTER_INTERFACE)
1227 value = (pnp_string[0]<<8)|pnp_string[1];
1228 memcpy(req->buf, pnp_string, value);
1229 DBG(dev, "1284 PNP String: %x %s\n", value,
1233 case 1: /* Get Port Status */
1234 /* Only one printer interface is supported. */
1235 if (wIndex != PRINTER_INTERFACE)
1238 *(u8 *)req->buf = dev->printer_status;
1239 value = min(wLength, (u16) 1);
1242 case 2: /* Soft Reset */
1243 /* Only one printer interface is supported. */
1244 if (wIndex != PRINTER_INTERFACE)
1247 printer_soft_reset(dev);
1260 "unknown ctrl req%02x.%02x v%04x i%04x l%d\n",
1261 ctrl->bRequestType, ctrl->bRequest,
1262 wValue, wIndex, wLength);
1266 /* respond with data transfer before status phase? */
1268 req->length = value;
1269 req->zero = value < wLength;
1270 value = usb_ep_queue(gadget->ep0, req, GFP_ATOMIC);
1272 DBG(dev, "ep_queue --> %d\n", value);
1274 printer_setup_complete(gadget->ep0, req);
1278 /* host either stalls (value < 0) or reports success */
1283 printer_disconnect(struct usb_gadget *gadget)
1285 struct printer_dev *dev = get_gadget_data(gadget);
1286 unsigned long flags;
1288 DBG(dev, "%s\n", __func__);
1290 spin_lock_irqsave(&dev->lock, flags);
1292 printer_reset_interface(dev);
1294 spin_unlock_irqrestore(&dev->lock, flags);
1298 printer_unbind(struct usb_gadget *gadget)
1300 struct printer_dev *dev = get_gadget_data(gadget);
1301 struct usb_request *req;
1304 DBG(dev, "%s\n", __func__);
1306 /* Remove sysfs files */
1307 device_destroy(usb_gadget_class, g_printer_devno);
1309 /* Remove Character Device */
1310 cdev_del(&dev->printer_cdev);
1312 /* we must already have been disconnected ... no i/o may be active */
1313 WARN_ON(!list_empty(&dev->tx_reqs_active));
1314 WARN_ON(!list_empty(&dev->rx_reqs_active));
1316 /* Free all memory for this driver. */
1317 while (!list_empty(&dev->tx_reqs)) {
1318 req = container_of(dev->tx_reqs.next, struct usb_request,
1320 list_del(&req->list);
1321 printer_req_free(dev->in_ep, req);
1324 if (dev->current_rx_req != NULL)
1325 printer_req_free(dev->out_ep, dev->current_rx_req);
1327 while (!list_empty(&dev->rx_reqs)) {
1328 req = container_of(dev->rx_reqs.next,
1329 struct usb_request, list);
1330 list_del(&req->list);
1331 printer_req_free(dev->out_ep, req);
1334 while (!list_empty(&dev->rx_buffers)) {
1335 req = container_of(dev->rx_buffers.next,
1336 struct usb_request, list);
1337 list_del(&req->list);
1338 printer_req_free(dev->out_ep, req);
1342 printer_req_free(gadget->ep0, dev->req);
1346 set_gadget_data(gadget, NULL);
1350 printer_bind(struct usb_gadget *gadget)
1352 struct printer_dev *dev;
1353 struct usb_ep *in_ep, *out_ep;
1354 int status = -ENOMEM;
1358 struct usb_request *req;
1360 dev = &usb_printer_gadget;
1363 /* Setup the sysfs files for the printer gadget. */
1364 dev->pdev = device_create(usb_gadget_class, NULL, g_printer_devno,
1366 if (IS_ERR(dev->pdev)) {
1367 ERROR(dev, "Failed to create device: g_printer\n");
1372 * Register a character device as an interface to a user mode
1373 * program that handles the printer specific functionality.
1375 cdev_init(&dev->printer_cdev, &printer_io_operations);
1376 dev->printer_cdev.owner = THIS_MODULE;
1377 status = cdev_add(&dev->printer_cdev, g_printer_devno, 1);
1379 ERROR(dev, "Failed to open char device\n");
1383 gcnum = usb_gadget_controller_number(gadget);
1385 device_desc.bcdDevice = cpu_to_le16(0x0200 + gcnum);
1387 dev_warn(&gadget->dev, "controller '%s' not recognized\n",
1389 /* unrecognized, but safe unless bulk is REALLY quirky */
1390 device_desc.bcdDevice =
1391 cpu_to_le16(0xFFFF);
1393 snprintf(manufacturer, sizeof(manufacturer), "%s %s with %s",
1394 init_utsname()->sysname, init_utsname()->release,
1397 device_desc.idVendor =
1398 cpu_to_le16(PRINTER_VENDOR_NUM);
1399 device_desc.idProduct =
1400 cpu_to_le16(PRINTER_PRODUCT_NUM);
1402 /* support optional vendor/distro customization */
1405 dev_err(&gadget->dev, "idVendor needs idProduct!\n");
1408 device_desc.idVendor = cpu_to_le16(idVendor);
1409 device_desc.idProduct = cpu_to_le16(idProduct);
1411 device_desc.bcdDevice = cpu_to_le16(bcdDevice);
1415 strlcpy(manufacturer, iManufacturer, sizeof manufacturer);
1418 strlcpy(product_desc, iProduct, sizeof product_desc);
1421 strlcpy(serial_num, iSerialNum, sizeof serial_num);
1424 strlcpy(&pnp_string[2], iPNPstring, (sizeof pnp_string)-2);
1426 len = strlen(pnp_string);
1427 pnp_string[0] = (len >> 8) & 0xFF;
1428 pnp_string[1] = len & 0xFF;
1430 /* all we really need is bulk IN/OUT */
1431 usb_ep_autoconfig_reset(gadget);
1432 in_ep = usb_ep_autoconfig(gadget, &fs_ep_in_desc);
1435 dev_err(&gadget->dev, "can't autoconfigure on %s\n",
1439 in_ep->driver_data = in_ep; /* claim */
1441 out_ep = usb_ep_autoconfig(gadget, &fs_ep_out_desc);
1444 out_ep->driver_data = out_ep; /* claim */
1446 #ifdef CONFIG_USB_GADGET_DUALSPEED
1447 /* assumes ep0 uses the same value for both speeds ... */
1448 dev_qualifier.bMaxPacketSize0 = device_desc.bMaxPacketSize0;
1450 /* and that all endpoints are dual-speed */
1451 hs_ep_in_desc.bEndpointAddress = fs_ep_in_desc.bEndpointAddress;
1452 hs_ep_out_desc.bEndpointAddress = fs_ep_out_desc.bEndpointAddress;
1453 #endif /* DUALSPEED */
1455 device_desc.bMaxPacketSize0 = gadget->ep0->maxpacket;
1456 usb_gadget_set_selfpowered(gadget);
1458 if (gadget->is_otg) {
1459 otg_desc.bmAttributes |= USB_OTG_HNP,
1460 config_desc.bmAttributes |= USB_CONFIG_ATT_WAKEUP;
1463 spin_lock_init(&dev->lock);
1464 spin_lock_init(&dev->lock_printer_io);
1465 INIT_LIST_HEAD(&dev->tx_reqs);
1466 INIT_LIST_HEAD(&dev->tx_reqs_active);
1467 INIT_LIST_HEAD(&dev->rx_reqs);
1468 INIT_LIST_HEAD(&dev->rx_reqs_active);
1469 INIT_LIST_HEAD(&dev->rx_buffers);
1470 init_waitqueue_head(&dev->rx_wait);
1471 init_waitqueue_head(&dev->tx_wait);
1472 init_waitqueue_head(&dev->tx_flush_wait);
1475 dev->interface = -1;
1476 dev->printer_cdev_open = 0;
1477 dev->printer_status = PRINTER_NOT_ERROR;
1478 dev->current_rx_req = NULL;
1479 dev->current_rx_bytes = 0;
1480 dev->current_rx_buf = NULL;
1483 dev->out_ep = out_ep;
1485 /* preallocate control message data and buffer */
1486 dev->req = printer_req_alloc(gadget->ep0, USB_DESC_BUFSIZE,
1493 for (i = 0; i < QLEN; i++) {
1494 req = printer_req_alloc(dev->in_ep, USB_BUFSIZE, GFP_KERNEL);
1496 while (!list_empty(&dev->tx_reqs)) {
1497 req = container_of(dev->tx_reqs.next,
1498 struct usb_request, list);
1499 list_del(&req->list);
1500 printer_req_free(dev->in_ep, req);
1504 list_add(&req->list, &dev->tx_reqs);
1507 for (i = 0; i < QLEN; i++) {
1508 req = printer_req_alloc(dev->out_ep, USB_BUFSIZE, GFP_KERNEL);
1510 while (!list_empty(&dev->rx_reqs)) {
1511 req = container_of(dev->rx_reqs.next,
1512 struct usb_request, list);
1513 list_del(&req->list);
1514 printer_req_free(dev->out_ep, req);
1518 list_add(&req->list, &dev->rx_reqs);
1521 dev->req->complete = printer_setup_complete;
1523 /* finish hookup to lower layer ... */
1524 dev->gadget = gadget;
1525 set_gadget_data(gadget, dev);
1526 gadget->ep0->driver_data = dev;
1528 INFO(dev, "%s, version: " DRIVER_VERSION "\n", driver_desc);
1529 INFO(dev, "using %s, OUT %s IN %s\n", gadget->name, out_ep->name,
1535 printer_unbind(gadget);
1539 /*-------------------------------------------------------------------------*/
1541 static struct usb_gadget_driver printer_driver = {
1544 .function = (char *) driver_desc,
1545 .bind = printer_bind,
1546 .unbind = printer_unbind,
1548 .setup = printer_setup,
1549 .disconnect = printer_disconnect,
1552 .name = (char *) shortname,
1553 .owner = THIS_MODULE,
1557 MODULE_DESCRIPTION(DRIVER_DESC);
1558 MODULE_AUTHOR("Craig Nadler");
1559 MODULE_LICENSE("GPL");
1566 usb_gadget_class = class_create(THIS_MODULE, "usb_printer_gadget");
1567 if (IS_ERR(usb_gadget_class)) {
1568 status = PTR_ERR(usb_gadget_class);
1569 ERROR(dev, "unable to create usb_gadget class %d\n", status);
1573 status = alloc_chrdev_region(&g_printer_devno, 0, 1,
1574 "USB printer gadget");
1576 ERROR(dev, "alloc_chrdev_region %d\n", status);
1577 class_destroy(usb_gadget_class);
1581 status = usb_gadget_register_driver(&printer_driver);
1583 class_destroy(usb_gadget_class);
1584 unregister_chrdev_region(g_printer_devno, 1);
1585 DBG(dev, "usb_gadget_register_driver %x\n", status);
1597 spin_lock(&usb_printer_gadget.lock_printer_io);
1598 class_destroy(usb_gadget_class);
1599 unregister_chrdev_region(g_printer_devno, 2);
1601 status = usb_gadget_unregister_driver(&printer_driver);
1603 ERROR(dev, "usb_gadget_unregister_driver %x\n", status);
1605 spin_unlock(&usb_printer_gadget.lock_printer_io);
1607 module_exit(cleanup);