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"
56 #define DRIVER_DESC "Printer Gadget"
57 #define DRIVER_VERSION "2007 OCT 06"
59 static const char shortname [] = "printer";
60 static const char driver_desc [] = DRIVER_DESC;
62 static dev_t g_printer_devno;
64 static struct class *usb_gadget_class;
66 /*-------------------------------------------------------------------------*/
69 spinlock_t lock; /* lock this structure */
70 /* lock buffer lists during read/write calls */
71 spinlock_t lock_printer_io;
72 struct usb_gadget *gadget;
73 struct usb_request *req; /* for control responses */
76 struct usb_ep *in_ep, *out_ep;
77 const struct usb_endpoint_descriptor
79 struct list_head rx_reqs; /* List of free RX structs */
80 struct list_head rx_reqs_active; /* List of Active RX xfers */
81 struct list_head rx_buffers; /* List of completed xfers */
82 /* wait until there is data to be read. */
83 wait_queue_head_t rx_wait;
84 struct list_head tx_reqs; /* List of free TX structs */
85 struct list_head tx_reqs_active; /* List of Active TX xfers */
86 /* Wait until there are write buffers available to use. */
87 wait_queue_head_t tx_wait;
88 /* Wait until all write buffers have been sent. */
89 wait_queue_head_t tx_flush_wait;
90 struct usb_request *current_rx_req;
91 size_t current_rx_bytes;
95 struct cdev printer_cdev;
98 wait_queue_head_t wait;
101 static struct printer_dev usb_printer_gadget;
103 /*-------------------------------------------------------------------------*/
105 /* DO NOT REUSE THESE IDs with a protocol-incompatible driver!! Ever!!
106 * Instead: allocate your own, using normal USB-IF procedures.
109 /* Thanks to NetChip Technologies for donating this product ID.
111 #define PRINTER_VENDOR_NUM 0x0525 /* NetChip */
112 #define PRINTER_PRODUCT_NUM 0xa4a8 /* Linux-USB Printer Gadget */
114 /* Some systems will want different product identifers published in the
115 * device descriptor, either numbers or strings or both. These string
116 * parameters are in UTF-8 (superset of ASCII's 7 bit characters).
119 static ushort __initdata idVendor;
120 module_param(idVendor, ushort, S_IRUGO);
121 MODULE_PARM_DESC(idVendor, "USB Vendor ID");
123 static ushort __initdata idProduct;
124 module_param(idProduct, ushort, S_IRUGO);
125 MODULE_PARM_DESC(idProduct, "USB Product ID");
127 static ushort __initdata bcdDevice;
128 module_param(bcdDevice, ushort, S_IRUGO);
129 MODULE_PARM_DESC(bcdDevice, "USB Device version (BCD)");
131 static char *__initdata iManufacturer;
132 module_param(iManufacturer, charp, S_IRUGO);
133 MODULE_PARM_DESC(iManufacturer, "USB Manufacturer string");
135 static char *__initdata iProduct;
136 module_param(iProduct, charp, S_IRUGO);
137 MODULE_PARM_DESC(iProduct, "USB Product string");
139 static char *__initdata iSerialNum;
140 module_param(iSerialNum, charp, S_IRUGO);
141 MODULE_PARM_DESC(iSerialNum, "1");
143 static char *__initdata iPNPstring;
144 module_param(iPNPstring, charp, S_IRUGO);
145 MODULE_PARM_DESC(iPNPstring, "MFG:linux;MDL:g_printer;CLS:PRINTER;SN:1;");
147 /* Number of requests to allocate per endpoint, not used for ep0. */
148 static unsigned qlen = 10;
149 module_param(qlen, uint, S_IRUGO|S_IWUSR);
153 #ifdef CONFIG_USB_GADGET_DUALSPEED
154 #define DEVSPEED USB_SPEED_HIGH
155 #else /* full speed (low speed doesn't do bulk) */
156 #define DEVSPEED USB_SPEED_FULL
159 /*-------------------------------------------------------------------------*/
161 #define xprintk(d, level, fmt, args...) \
162 printk(level "%s: " fmt, DRIVER_DESC, ## args)
165 #define DBG(dev, fmt, args...) \
166 xprintk(dev, KERN_DEBUG, fmt, ## args)
168 #define DBG(dev, fmt, args...) \
173 #define VDBG(dev, fmt, args...) \
174 xprintk(dev, KERN_DEBUG, fmt, ## args)
176 #define VDBG(dev, fmt, args...) \
180 #define ERROR(dev, fmt, args...) \
181 xprintk(dev, KERN_ERR, fmt, ## args)
182 #define WARN(dev, fmt, args...) \
183 xprintk(dev, KERN_WARNING, fmt, ## args)
184 #define INFO(dev, fmt, args...) \
185 xprintk(dev, KERN_INFO, fmt, ## args)
187 /*-------------------------------------------------------------------------*/
189 /* USB DRIVER HOOKUP (to the hardware driver, below us), mostly
190 * ep0 implementation: descriptors, config management, setup().
191 * also optional class-specific notification interrupt transfer.
195 * DESCRIPTORS ... most are static, but strings and (full) configuration
196 * descriptors are built on demand.
199 #define STRING_MANUFACTURER 1
200 #define STRING_PRODUCT 2
201 #define STRING_SERIALNUM 3
203 /* holds our biggest descriptor */
204 #define USB_DESC_BUFSIZE 256
205 #define USB_BUFSIZE 8192
207 /* This device advertises one configuration. */
208 #define DEV_CONFIG_VALUE 1
209 #define PRINTER_INTERFACE 0
211 static struct usb_device_descriptor device_desc = {
212 .bLength = sizeof device_desc,
213 .bDescriptorType = USB_DT_DEVICE,
214 .bcdUSB = __constant_cpu_to_le16(0x0200),
215 .bDeviceClass = USB_CLASS_PER_INTERFACE,
216 .bDeviceSubClass = 0,
217 .bDeviceProtocol = 0,
218 .idVendor = __constant_cpu_to_le16(PRINTER_VENDOR_NUM),
219 .idProduct = __constant_cpu_to_le16(PRINTER_PRODUCT_NUM),
220 .iManufacturer = STRING_MANUFACTURER,
221 .iProduct = STRING_PRODUCT,
222 .iSerialNumber = STRING_SERIALNUM,
223 .bNumConfigurations = 1
226 static struct usb_otg_descriptor otg_desc = {
227 .bLength = sizeof otg_desc,
228 .bDescriptorType = USB_DT_OTG,
229 .bmAttributes = USB_OTG_SRP
232 static struct usb_config_descriptor config_desc = {
233 .bLength = sizeof config_desc,
234 .bDescriptorType = USB_DT_CONFIG,
236 /* compute wTotalLength on the fly */
238 .bConfigurationValue = DEV_CONFIG_VALUE,
240 .bmAttributes = USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER,
241 .bMaxPower = 1 /* Self-Powered */
244 static struct usb_interface_descriptor intf_desc = {
245 .bLength = sizeof intf_desc,
246 .bDescriptorType = USB_DT_INTERFACE,
247 .bInterfaceNumber = PRINTER_INTERFACE,
249 .bInterfaceClass = USB_CLASS_PRINTER,
250 .bInterfaceSubClass = 1, /* Printer Sub-Class */
251 .bInterfaceProtocol = 2, /* Bi-Directional */
255 static struct usb_endpoint_descriptor fs_ep_in_desc = {
256 .bLength = USB_DT_ENDPOINT_SIZE,
257 .bDescriptorType = USB_DT_ENDPOINT,
258 .bEndpointAddress = USB_DIR_IN,
259 .bmAttributes = USB_ENDPOINT_XFER_BULK
262 static struct usb_endpoint_descriptor fs_ep_out_desc = {
263 .bLength = USB_DT_ENDPOINT_SIZE,
264 .bDescriptorType = USB_DT_ENDPOINT,
265 .bEndpointAddress = USB_DIR_OUT,
266 .bmAttributes = USB_ENDPOINT_XFER_BULK
269 static const struct usb_descriptor_header *fs_printer_function [11] = {
270 (struct usb_descriptor_header *) &otg_desc,
271 (struct usb_descriptor_header *) &intf_desc,
272 (struct usb_descriptor_header *) &fs_ep_in_desc,
273 (struct usb_descriptor_header *) &fs_ep_out_desc,
277 #ifdef CONFIG_USB_GADGET_DUALSPEED
280 * usb 2.0 devices need to expose both high speed and full speed
281 * descriptors, unless they only run at full speed.
284 static struct usb_endpoint_descriptor hs_ep_in_desc = {
285 .bLength = USB_DT_ENDPOINT_SIZE,
286 .bDescriptorType = USB_DT_ENDPOINT,
287 .bmAttributes = USB_ENDPOINT_XFER_BULK,
288 .wMaxPacketSize = __constant_cpu_to_le16(512)
291 static struct usb_endpoint_descriptor hs_ep_out_desc = {
292 .bLength = USB_DT_ENDPOINT_SIZE,
293 .bDescriptorType = USB_DT_ENDPOINT,
294 .bmAttributes = USB_ENDPOINT_XFER_BULK,
295 .wMaxPacketSize = __constant_cpu_to_le16(512)
298 static struct usb_qualifier_descriptor dev_qualifier = {
299 .bLength = sizeof dev_qualifier,
300 .bDescriptorType = USB_DT_DEVICE_QUALIFIER,
301 .bcdUSB = __constant_cpu_to_le16(0x0200),
302 .bDeviceClass = USB_CLASS_PRINTER,
303 .bNumConfigurations = 1
306 static const struct usb_descriptor_header *hs_printer_function [11] = {
307 (struct usb_descriptor_header *) &otg_desc,
308 (struct usb_descriptor_header *) &intf_desc,
309 (struct usb_descriptor_header *) &hs_ep_in_desc,
310 (struct usb_descriptor_header *) &hs_ep_out_desc,
314 /* maxpacket and other transfer characteristics vary by speed. */
315 #define ep_desc(g, hs, fs) (((g)->speed == USB_SPEED_HIGH)?(hs):(fs))
319 /* if there's no high speed support, maxpacket doesn't change. */
320 #define ep_desc(g, hs, fs) (((void)(g)), (fs))
322 #endif /* !CONFIG_USB_GADGET_DUALSPEED */
324 /*-------------------------------------------------------------------------*/
326 /* descriptors that are built on-demand */
328 static char manufacturer [50];
329 static char product_desc [40] = DRIVER_DESC;
330 static char serial_num [40] = "1";
331 static char pnp_string [1024] =
332 "XXMFG:linux;MDL:g_printer;CLS:PRINTER;SN:1;";
334 /* static strings, in UTF-8 */
335 static struct usb_string strings [] = {
336 { STRING_MANUFACTURER, manufacturer, },
337 { STRING_PRODUCT, product_desc, },
338 { STRING_SERIALNUM, serial_num, },
339 { } /* end of list */
342 static struct usb_gadget_strings stringtab = {
343 .language = 0x0409, /* en-us */
347 /*-------------------------------------------------------------------------*/
349 static struct usb_request *
350 printer_req_alloc(struct usb_ep *ep, unsigned len, gfp_t gfp_flags)
352 struct usb_request *req;
354 req = usb_ep_alloc_request(ep, gfp_flags);
358 req->buf = kmalloc(len, gfp_flags);
359 if (req->buf == NULL) {
360 usb_ep_free_request(ep, req);
369 printer_req_free(struct usb_ep *ep, struct usb_request *req)
371 if (ep != NULL && req != NULL) {
373 usb_ep_free_request(ep, req);
377 /*-------------------------------------------------------------------------*/
379 static void rx_complete(struct usb_ep *ep, struct usb_request *req)
381 struct printer_dev *dev = ep->driver_data;
382 int status = req->status;
385 spin_lock_irqsave(&dev->lock, flags);
387 list_del_init(&req->list); /* Remode from Active List */
391 /* normal completion */
393 if (req->actual > 0) {
394 list_add_tail(&req->list, &dev->rx_buffers);
395 DBG(dev, "G_Printer : rx length %d\n", req->actual);
397 list_add(&req->list, &dev->rx_reqs);
401 /* software-driven interface shutdown */
402 case -ECONNRESET: /* unlink */
403 case -ESHUTDOWN: /* disconnect etc */
404 VDBG(dev, "rx shutdown, code %d\n", status);
405 list_add(&req->list, &dev->rx_reqs);
408 /* for hardware automagic (such as pxa) */
409 case -ECONNABORTED: /* endpoint reset */
410 DBG(dev, "rx %s reset\n", ep->name);
411 list_add(&req->list, &dev->rx_reqs);
419 DBG(dev, "rx status %d\n", status);
420 list_add(&req->list, &dev->rx_reqs);
424 wake_up_interruptible(&dev->rx_wait);
425 spin_unlock_irqrestore(&dev->lock, flags);
428 static void tx_complete(struct usb_ep *ep, struct usb_request *req)
430 struct printer_dev *dev = ep->driver_data;
432 switch (req->status) {
434 VDBG(dev, "tx err %d\n", req->status);
436 case -ECONNRESET: /* unlink */
437 case -ESHUTDOWN: /* disconnect etc */
443 spin_lock(&dev->lock);
444 /* Take the request struct off the active list and put it on the
447 list_del_init(&req->list);
448 list_add(&req->list, &dev->tx_reqs);
449 wake_up_interruptible(&dev->tx_wait);
450 if (likely(list_empty(&dev->tx_reqs_active)))
451 wake_up_interruptible(&dev->tx_flush_wait);
453 spin_unlock(&dev->lock);
456 /*-------------------------------------------------------------------------*/
459 printer_open(struct inode *inode, struct file *fd)
461 struct printer_dev *dev;
466 dev = container_of(inode->i_cdev, struct printer_dev, printer_cdev);
468 spin_lock_irqsave(&dev->lock, flags);
470 if (!dev->printer_cdev_open) {
471 dev->printer_cdev_open = 1;
472 fd->private_data = dev;
474 /* Change the printer status to show that it's on-line. */
475 dev->printer_status |= PRINTER_SELECTED;
478 spin_unlock_irqrestore(&dev->lock, flags);
480 DBG(dev, "printer_open returned %x\n", ret);
486 printer_close(struct inode *inode, struct file *fd)
488 struct printer_dev *dev = fd->private_data;
491 spin_lock_irqsave(&dev->lock, flags);
492 dev->printer_cdev_open = 0;
493 fd->private_data = NULL;
494 /* Change printer status to show that the printer is off-line. */
495 dev->printer_status &= ~PRINTER_SELECTED;
496 spin_unlock_irqrestore(&dev->lock, flags);
498 DBG(dev, "printer_close\n");
503 /* This function must be called with interrupts turned off. */
505 setup_rx_reqs(struct printer_dev *dev)
507 struct usb_request *req;
509 while (likely(!list_empty(&dev->rx_reqs))) {
512 req = container_of(dev->rx_reqs.next,
513 struct usb_request, list);
514 list_del_init(&req->list);
516 /* The USB Host sends us whatever amount of data it wants to
517 * so we always set the length field to the full USB_BUFSIZE.
518 * If the amount of data is more than the read() caller asked
519 * for it will be stored in the request buffer until it is
520 * asked for by read().
522 req->length = USB_BUFSIZE;
523 req->complete = rx_complete;
525 error = usb_ep_queue(dev->out_ep, req, GFP_ATOMIC);
527 DBG(dev, "rx submit --> %d\n", error);
528 list_add(&req->list, &dev->rx_reqs);
531 list_add(&req->list, &dev->rx_reqs_active);
537 printer_read(struct file *fd, char __user *buf, size_t len, loff_t *ptr)
539 struct printer_dev *dev = fd->private_data;
543 struct usb_request *req;
544 /* This is a pointer to the current USB rx request. */
545 struct usb_request *current_rx_req;
546 /* This is the number of bytes in the current rx buffer. */
547 size_t current_rx_bytes;
548 /* This is a pointer to the current rx buffer. */
554 DBG(dev, "printer_read trying to read %d bytes\n", (int)len);
556 spin_lock(&dev->lock_printer_io);
557 spin_lock_irqsave(&dev->lock, flags);
559 /* We will use this flag later to check if a printer reset happened
560 * after we turn interrupts back on.
562 dev->reset_printer = 0;
567 current_rx_req = dev->current_rx_req;
568 current_rx_bytes = dev->current_rx_bytes;
569 current_rx_buf = dev->current_rx_buf;
570 dev->current_rx_req = NULL;
571 dev->current_rx_bytes = 0;
572 dev->current_rx_buf = NULL;
574 /* Check if there is any data in the read buffers. Please note that
575 * current_rx_bytes is the number of bytes in the current rx buffer.
576 * If it is zero then check if there are any other rx_buffers that
577 * are on the completed list. We are only out of data if all rx
580 if ((current_rx_bytes == 0) &&
581 (likely(list_empty(&dev->rx_buffers)))) {
582 /* Turn interrupts back on before sleeping. */
583 spin_unlock_irqrestore(&dev->lock, flags);
586 * If no data is available check if this is a NON-Blocking
589 if (fd->f_flags & (O_NONBLOCK|O_NDELAY)) {
590 spin_unlock(&dev->lock_printer_io);
594 /* Sleep until data is available */
595 wait_event_interruptible(dev->rx_wait,
596 (likely(!list_empty(&dev->rx_buffers))));
597 spin_lock_irqsave(&dev->lock, flags);
600 /* We have data to return then copy it to the caller's buffer.*/
601 while ((current_rx_bytes || likely(!list_empty(&dev->rx_buffers)))
603 if (current_rx_bytes == 0) {
604 req = container_of(dev->rx_buffers.next,
605 struct usb_request, list);
606 list_del_init(&req->list);
608 if (req->actual && req->buf) {
609 current_rx_req = req;
610 current_rx_bytes = req->actual;
611 current_rx_buf = req->buf;
613 list_add(&req->list, &dev->rx_reqs);
618 /* Don't leave irqs off while doing memory copies */
619 spin_unlock_irqrestore(&dev->lock, flags);
621 if (len > current_rx_bytes)
622 size = current_rx_bytes;
626 size -= copy_to_user(buf, current_rx_buf, size);
627 bytes_copied += size;
631 spin_lock_irqsave(&dev->lock, flags);
633 /* We've disconnected or reset so return. */
634 if (dev->reset_printer) {
635 list_add(¤t_rx_req->list, &dev->rx_reqs);
636 spin_unlock_irqrestore(&dev->lock, flags);
637 spin_unlock(&dev->lock_printer_io);
641 /* If we not returning all the data left in this RX request
642 * buffer then adjust the amount of data left in the buffer.
643 * Othewise if we are done with this RX request buffer then
644 * requeue it to get any incoming data from the USB host.
646 if (size < current_rx_bytes) {
647 current_rx_bytes -= size;
648 current_rx_buf += size;
650 list_add(¤t_rx_req->list, &dev->rx_reqs);
651 current_rx_bytes = 0;
652 current_rx_buf = NULL;
653 current_rx_req = NULL;
657 dev->current_rx_req = current_rx_req;
658 dev->current_rx_bytes = current_rx_bytes;
659 dev->current_rx_buf = current_rx_buf;
661 spin_unlock_irqrestore(&dev->lock, flags);
662 spin_unlock(&dev->lock_printer_io);
664 DBG(dev, "printer_read returned %d bytes\n", (int)bytes_copied);
673 printer_write(struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
675 struct printer_dev *dev = fd->private_data;
677 size_t size; /* Amount of data in a TX request. */
678 size_t bytes_copied = 0;
679 struct usb_request *req;
681 DBG(dev, "printer_write trying to send %d bytes\n", (int)len);
686 spin_lock(&dev->lock_printer_io);
687 spin_lock_irqsave(&dev->lock, flags);
689 /* Check if a printer reset happens while we have interrupts on */
690 dev->reset_printer = 0;
692 /* Check if there is any available write buffers */
693 if (likely(list_empty(&dev->tx_reqs))) {
694 /* Turn interrupts back on before sleeping. */
695 spin_unlock_irqrestore(&dev->lock, flags);
698 * If write buffers are available check if this is
699 * a NON-Blocking call or not.
701 if (fd->f_flags & (O_NONBLOCK|O_NDELAY)) {
702 spin_unlock(&dev->lock_printer_io);
706 /* Sleep until a write buffer is available */
707 wait_event_interruptible(dev->tx_wait,
708 (likely(!list_empty(&dev->tx_reqs))));
709 spin_lock_irqsave(&dev->lock, flags);
712 while (likely(!list_empty(&dev->tx_reqs)) && len) {
714 if (len > USB_BUFSIZE)
719 req = container_of(dev->tx_reqs.next, struct usb_request,
721 list_del_init(&req->list);
723 req->complete = tx_complete;
726 /* Check if we need to send a zero length packet. */
728 /* They will be more TX requests so no yet. */
731 /* If the data amount is not a multple of the
732 * maxpacket size then send a zero length packet.
734 req->zero = ((len % dev->in_ep->maxpacket) == 0);
736 /* Don't leave irqs off while doing memory copies */
737 spin_unlock_irqrestore(&dev->lock, flags);
739 if (copy_from_user(req->buf, buf, size)) {
740 list_add(&req->list, &dev->tx_reqs);
741 spin_unlock(&dev->lock_printer_io);
745 bytes_copied += size;
749 spin_lock_irqsave(&dev->lock, flags);
751 /* We've disconnected or reset so free the req and buffer */
752 if (dev->reset_printer) {
753 list_add(&req->list, &dev->tx_reqs);
754 spin_unlock_irqrestore(&dev->lock, flags);
755 spin_unlock(&dev->lock_printer_io);
759 if (usb_ep_queue(dev->in_ep, req, GFP_ATOMIC)) {
760 list_add(&req->list, &dev->tx_reqs);
761 spin_unlock_irqrestore(&dev->lock, flags);
762 spin_unlock(&dev->lock_printer_io);
766 list_add(&req->list, &dev->tx_reqs_active);
770 spin_unlock_irqrestore(&dev->lock, flags);
771 spin_unlock(&dev->lock_printer_io);
773 DBG(dev, "printer_write sent %d bytes\n", (int)bytes_copied);
783 printer_fsync(struct file *fd, struct dentry *dentry, int datasync)
785 struct printer_dev *dev = fd->private_data;
789 spin_lock_irqsave(&dev->lock, flags);
790 tx_list_empty = (likely(list_empty(&dev->tx_reqs)));
791 spin_unlock_irqrestore(&dev->lock, flags);
793 if (!tx_list_empty) {
794 /* Sleep until all data has been sent */
795 wait_event_interruptible(dev->tx_flush_wait,
796 (likely(list_empty(&dev->tx_reqs_active))));
803 printer_poll(struct file *fd, poll_table *wait)
805 struct printer_dev *dev = fd->private_data;
809 spin_lock(&dev->lock_printer_io);
810 spin_lock_irqsave(&dev->lock, flags);
812 spin_unlock_irqrestore(&dev->lock, flags);
813 spin_unlock(&dev->lock_printer_io);
815 poll_wait(fd, &dev->rx_wait, wait);
816 poll_wait(fd, &dev->tx_wait, wait);
818 spin_lock_irqsave(&dev->lock, flags);
819 if (likely(!list_empty(&dev->tx_reqs)))
820 status |= POLLOUT | POLLWRNORM;
822 if (likely(dev->current_rx_bytes) ||
823 likely(!list_empty(&dev->rx_buffers)))
824 status |= POLLIN | POLLRDNORM;
826 spin_unlock_irqrestore(&dev->lock, flags);
832 printer_ioctl(struct file *fd, unsigned int code, unsigned long arg)
834 struct printer_dev *dev = fd->private_data;
838 DBG(dev, "printer_ioctl: cmd=0x%4.4x, arg=%lu\n", code, arg);
842 spin_lock_irqsave(&dev->lock, flags);
845 case GADGET_GET_PRINTER_STATUS:
846 status = (int)dev->printer_status;
848 case GADGET_SET_PRINTER_STATUS:
849 dev->printer_status = (u8)arg;
852 /* could not handle ioctl */
853 DBG(dev, "printer_ioctl: ERROR cmd=0x%4.4xis not supported\n",
858 spin_unlock_irqrestore(&dev->lock, flags);
863 /* used after endpoint configuration */
864 static struct file_operations printer_io_operations = {
865 .owner = THIS_MODULE,
866 .open = printer_open,
867 .read = printer_read,
868 .write = printer_write,
869 .fsync = printer_fsync,
870 .poll = printer_poll,
871 .unlocked_ioctl = printer_ioctl,
872 .release = printer_close
875 /*-------------------------------------------------------------------------*/
878 set_printer_interface(struct printer_dev *dev)
882 dev->in = ep_desc(dev->gadget, &hs_ep_in_desc, &fs_ep_in_desc);
883 dev->in_ep->driver_data = dev;
885 dev->out = ep_desc(dev->gadget, &hs_ep_out_desc, &fs_ep_out_desc);
886 dev->out_ep->driver_data = dev;
888 result = usb_ep_enable(dev->in_ep, dev->in);
890 DBG(dev, "enable %s --> %d\n", dev->in_ep->name, result);
894 result = usb_ep_enable(dev->out_ep, dev->out);
896 DBG(dev, "enable %s --> %d\n", dev->in_ep->name, result);
901 /* on error, disable any endpoints */
903 (void) usb_ep_disable(dev->in_ep);
904 (void) usb_ep_disable(dev->out_ep);
909 /* caller is responsible for cleanup on error */
913 static void printer_reset_interface(struct printer_dev *dev)
915 if (dev->interface < 0)
918 DBG(dev, "%s\n", __func__);
921 usb_ep_disable(dev->in_ep);
924 usb_ep_disable(dev->out_ep);
929 /* change our operational config. must agree with the code
930 * that returns config descriptors, and altsetting code.
933 printer_set_config(struct printer_dev *dev, unsigned number)
936 struct usb_gadget *gadget = dev->gadget;
938 if (gadget_is_sa1100(gadget) && dev->config) {
939 /* tx fifo is full, but we can't clear it...*/
940 INFO(dev, "can't change configurations\n");
945 case DEV_CONFIG_VALUE:
956 usb_gadget_vbus_draw(dev->gadget,
957 dev->gadget->is_otg ? 8 : 100);
962 power = 2 * config_desc.bMaxPower;
963 usb_gadget_vbus_draw(dev->gadget, power);
965 switch (gadget->speed) {
966 case USB_SPEED_FULL: speed = "full"; break;
967 #ifdef CONFIG_USB_GADGET_DUALSPEED
968 case USB_SPEED_HIGH: speed = "high"; break;
970 default: speed = "?"; break;
973 dev->config = number;
974 INFO(dev, "%s speed config #%d: %d mA, %s\n",
975 speed, number, power, driver_desc);
981 config_buf(enum usb_device_speed speed, u8 *buf, u8 type, unsigned index,
985 const struct usb_descriptor_header **function;
986 #ifdef CONFIG_USB_GADGET_DUALSPEED
987 int hs = (speed == USB_SPEED_HIGH);
989 if (type == USB_DT_OTHER_SPEED_CONFIG)
993 function = hs_printer_function;
995 function = fs_printer_function;
998 function = fs_printer_function;
1001 if (index >= device_desc.bNumConfigurations)
1004 /* for now, don't advertise srp-only devices */
1008 len = usb_gadget_config_buf(&config_desc, buf, USB_DESC_BUFSIZE,
1012 ((struct usb_config_descriptor *) buf)->bDescriptorType = type;
1016 /* Change our operational Interface. */
1018 set_interface(struct printer_dev *dev, unsigned number)
1022 if (gadget_is_sa1100(dev->gadget) && dev->interface < 0) {
1023 /* tx fifo is full, but we can't clear it...*/
1024 INFO(dev, "can't change interfaces\n");
1028 /* Free the current interface */
1029 switch (dev->interface) {
1030 case PRINTER_INTERFACE:
1031 printer_reset_interface(dev);
1036 case PRINTER_INTERFACE:
1037 result = set_printer_interface(dev);
1039 printer_reset_interface(dev);
1041 dev->interface = PRINTER_INTERFACE;
1050 INFO(dev, "Using interface %x\n", number);
1055 static void printer_setup_complete(struct usb_ep *ep, struct usb_request *req)
1057 if (req->status || req->actual != req->length)
1058 DBG((struct printer_dev *) ep->driver_data,
1059 "setup complete --> %d, %d/%d\n",
1060 req->status, req->actual, req->length);
1063 static void printer_soft_reset(struct printer_dev *dev)
1065 struct usb_request *req;
1067 INFO(dev, "Received Printer Reset Request\n");
1069 if (usb_ep_disable(dev->in_ep))
1070 DBG(dev, "Failed to disable USB in_ep\n");
1071 if (usb_ep_disable(dev->out_ep))
1072 DBG(dev, "Failed to disable USB out_ep\n");
1074 if (dev->current_rx_req != NULL) {
1075 list_add(&dev->current_rx_req->list, &dev->rx_reqs);
1076 dev->current_rx_req = NULL;
1078 dev->current_rx_bytes = 0;
1079 dev->current_rx_buf = NULL;
1080 dev->reset_printer = 1;
1082 while (likely(!(list_empty(&dev->rx_buffers)))) {
1083 req = container_of(dev->rx_buffers.next, struct usb_request,
1085 list_del_init(&req->list);
1086 list_add(&req->list, &dev->rx_reqs);
1089 while (likely(!(list_empty(&dev->rx_reqs_active)))) {
1090 req = container_of(dev->rx_buffers.next, struct usb_request,
1092 list_del_init(&req->list);
1093 list_add(&req->list, &dev->rx_reqs);
1096 while (likely(!(list_empty(&dev->tx_reqs_active)))) {
1097 req = container_of(dev->tx_reqs_active.next,
1098 struct usb_request, list);
1099 list_del_init(&req->list);
1100 list_add(&req->list, &dev->tx_reqs);
1103 if (usb_ep_enable(dev->in_ep, dev->in))
1104 DBG(dev, "Failed to enable USB in_ep\n");
1105 if (usb_ep_enable(dev->out_ep, dev->out))
1106 DBG(dev, "Failed to enable USB out_ep\n");
1108 wake_up_interruptible(&dev->rx_wait);
1109 wake_up_interruptible(&dev->tx_wait);
1110 wake_up_interruptible(&dev->tx_flush_wait);
1113 /*-------------------------------------------------------------------------*/
1116 * The setup() callback implements all the ep0 functionality that's not
1117 * handled lower down.
1120 printer_setup(struct usb_gadget *gadget, const struct usb_ctrlrequest *ctrl)
1122 struct printer_dev *dev = get_gadget_data(gadget);
1123 struct usb_request *req = dev->req;
1124 int value = -EOPNOTSUPP;
1125 u16 wIndex = le16_to_cpu(ctrl->wIndex);
1126 u16 wValue = le16_to_cpu(ctrl->wValue);
1127 u16 wLength = le16_to_cpu(ctrl->wLength);
1129 DBG(dev, "ctrl req%02x.%02x v%04x i%04x l%d\n",
1130 ctrl->bRequestType, ctrl->bRequest, wValue, wIndex, wLength);
1132 req->complete = printer_setup_complete;
1134 switch (ctrl->bRequestType&USB_TYPE_MASK) {
1136 case USB_TYPE_STANDARD:
1137 switch (ctrl->bRequest) {
1139 case USB_REQ_GET_DESCRIPTOR:
1140 if (ctrl->bRequestType != USB_DIR_IN)
1142 switch (wValue >> 8) {
1145 value = min(wLength, (u16) sizeof device_desc);
1146 memcpy(req->buf, &device_desc, value);
1148 #ifdef CONFIG_USB_GADGET_DUALSPEED
1149 case USB_DT_DEVICE_QUALIFIER:
1150 if (!gadget->is_dualspeed)
1152 value = min(wLength,
1153 (u16) sizeof dev_qualifier);
1154 memcpy(req->buf, &dev_qualifier, value);
1157 case USB_DT_OTHER_SPEED_CONFIG:
1158 if (!gadget->is_dualspeed)
1161 #endif /* CONFIG_USB_GADGET_DUALSPEED */
1163 value = config_buf(gadget->speed, req->buf,
1168 value = min(wLength, (u16) value);
1172 value = usb_gadget_get_string(&stringtab,
1173 wValue & 0xff, req->buf);
1175 value = min(wLength, (u16) value);
1180 case USB_REQ_SET_CONFIGURATION:
1181 if (ctrl->bRequestType != 0)
1183 if (gadget->a_hnp_support)
1184 DBG(dev, "HNP available\n");
1185 else if (gadget->a_alt_hnp_support)
1186 DBG(dev, "HNP needs a different root port\n");
1187 value = printer_set_config(dev, wValue);
1189 case USB_REQ_GET_CONFIGURATION:
1190 if (ctrl->bRequestType != USB_DIR_IN)
1192 *(u8 *)req->buf = dev->config;
1193 value = min(wLength, (u16) 1);
1196 case USB_REQ_SET_INTERFACE:
1197 if (ctrl->bRequestType != USB_RECIP_INTERFACE ||
1201 value = set_interface(dev, PRINTER_INTERFACE);
1203 case USB_REQ_GET_INTERFACE:
1204 if (ctrl->bRequestType !=
1205 (USB_DIR_IN|USB_RECIP_INTERFACE)
1209 *(u8 *)req->buf = dev->interface;
1210 value = min(wLength, (u16) 1);
1218 case USB_TYPE_CLASS:
1219 switch (ctrl->bRequest) {
1220 case 0: /* Get the IEEE-1284 PNP String */
1221 /* Only one printer interface is supported. */
1222 if ((wIndex>>8) != PRINTER_INTERFACE)
1225 value = (pnp_string[0]<<8)|pnp_string[1];
1226 memcpy(req->buf, pnp_string, value);
1227 DBG(dev, "1284 PNP String: %x %s\n", value,
1231 case 1: /* Get Port Status */
1232 /* Only one printer interface is supported. */
1233 if (wIndex != PRINTER_INTERFACE)
1236 *(u8 *)req->buf = dev->printer_status;
1237 value = min(wLength, (u16) 1);
1240 case 2: /* Soft Reset */
1241 /* Only one printer interface is supported. */
1242 if (wIndex != PRINTER_INTERFACE)
1245 printer_soft_reset(dev);
1258 "unknown ctrl req%02x.%02x v%04x i%04x l%d\n",
1259 ctrl->bRequestType, ctrl->bRequest,
1260 wValue, wIndex, wLength);
1264 /* respond with data transfer before status phase? */
1266 req->length = value;
1267 req->zero = value < wLength
1268 && (value % gadget->ep0->maxpacket) == 0;
1269 value = usb_ep_queue(gadget->ep0, req, GFP_ATOMIC);
1271 DBG(dev, "ep_queue --> %d\n", value);
1273 printer_setup_complete(gadget->ep0, req);
1277 /* host either stalls (value < 0) or reports success */
1282 printer_disconnect(struct usb_gadget *gadget)
1284 struct printer_dev *dev = get_gadget_data(gadget);
1285 unsigned long flags;
1287 DBG(dev, "%s\n", __func__);
1289 spin_lock_irqsave(&dev->lock, flags);
1291 printer_reset_interface(dev);
1293 spin_unlock_irqrestore(&dev->lock, flags);
1297 printer_unbind(struct usb_gadget *gadget)
1299 struct printer_dev *dev = get_gadget_data(gadget);
1300 struct usb_request *req;
1303 DBG(dev, "%s\n", __func__);
1305 /* Remove sysfs files */
1306 device_destroy(usb_gadget_class, g_printer_devno);
1308 /* Remove Character Device */
1309 cdev_del(&dev->printer_cdev);
1311 /* we must already have been disconnected ... no i/o may be active */
1312 WARN_ON(!list_empty(&dev->tx_reqs_active));
1313 WARN_ON(!list_empty(&dev->rx_reqs_active));
1315 /* Free all memory for this driver. */
1316 while (!list_empty(&dev->tx_reqs)) {
1317 req = container_of(dev->tx_reqs.next, struct usb_request,
1319 list_del(&req->list);
1320 printer_req_free(dev->in_ep, req);
1323 if (dev->current_rx_req != NULL)
1324 printer_req_free(dev->out_ep, dev->current_rx_req);
1326 while (!list_empty(&dev->rx_reqs)) {
1327 req = container_of(dev->rx_reqs.next,
1328 struct usb_request, list);
1329 list_del(&req->list);
1330 printer_req_free(dev->out_ep, req);
1333 while (!list_empty(&dev->rx_buffers)) {
1334 req = container_of(dev->rx_buffers.next,
1335 struct usb_request, list);
1336 list_del(&req->list);
1337 printer_req_free(dev->out_ep, req);
1341 printer_req_free(gadget->ep0, dev->req);
1345 set_gadget_data(gadget, NULL);
1349 printer_bind(struct usb_gadget *gadget)
1351 struct printer_dev *dev;
1352 struct usb_ep *in_ep, *out_ep;
1353 int status = -ENOMEM;
1357 struct usb_request *req;
1359 dev = &usb_printer_gadget;
1362 /* Setup the sysfs files for the printer gadget. */
1363 dev->pdev = device_create(usb_gadget_class, NULL, g_printer_devno,
1365 if (IS_ERR(dev->pdev)) {
1366 ERROR(dev, "Failed to create device: g_printer\n");
1371 * Register a character device as an interface to a user mode
1372 * program that handles the printer specific functionality.
1374 cdev_init(&dev->printer_cdev, &printer_io_operations);
1375 dev->printer_cdev.owner = THIS_MODULE;
1376 status = cdev_add(&dev->printer_cdev, g_printer_devno, 1);
1378 ERROR(dev, "Failed to open char device\n");
1382 if (gadget_is_sa1100(gadget)) {
1383 /* hardware can't write zero length packets. */
1384 ERROR(dev, "SA1100 controller is unsupport by this driver\n");
1388 gcnum = usb_gadget_controller_number(gadget);
1390 device_desc.bcdDevice = cpu_to_le16(0x0200 + gcnum);
1392 dev_warn(&gadget->dev, "controller '%s' not recognized\n",
1394 /* unrecognized, but safe unless bulk is REALLY quirky */
1395 device_desc.bcdDevice =
1396 __constant_cpu_to_le16(0xFFFF);
1398 snprintf(manufacturer, sizeof(manufacturer), "%s %s with %s",
1399 init_utsname()->sysname, init_utsname()->release,
1402 device_desc.idVendor =
1403 __constant_cpu_to_le16(PRINTER_VENDOR_NUM);
1404 device_desc.idProduct =
1405 __constant_cpu_to_le16(PRINTER_PRODUCT_NUM);
1407 /* support optional vendor/distro customization */
1410 dev_err(&gadget->dev, "idVendor needs idProduct!\n");
1413 device_desc.idVendor = cpu_to_le16(idVendor);
1414 device_desc.idProduct = cpu_to_le16(idProduct);
1416 device_desc.bcdDevice = cpu_to_le16(bcdDevice);
1420 strlcpy(manufacturer, iManufacturer, sizeof manufacturer);
1423 strlcpy(product_desc, iProduct, sizeof product_desc);
1426 strlcpy(serial_num, iSerialNum, sizeof serial_num);
1429 strlcpy(&pnp_string[2], iPNPstring, (sizeof pnp_string)-2);
1431 len = strlen(pnp_string);
1432 pnp_string[0] = (len >> 8) & 0xFF;
1433 pnp_string[1] = len & 0xFF;
1435 /* all we really need is bulk IN/OUT */
1436 usb_ep_autoconfig_reset(gadget);
1437 in_ep = usb_ep_autoconfig(gadget, &fs_ep_in_desc);
1440 dev_err(&gadget->dev, "can't autoconfigure on %s\n",
1444 in_ep->driver_data = in_ep; /* claim */
1446 out_ep = usb_ep_autoconfig(gadget, &fs_ep_out_desc);
1449 out_ep->driver_data = out_ep; /* claim */
1451 #ifdef CONFIG_USB_GADGET_DUALSPEED
1452 /* assumes ep0 uses the same value for both speeds ... */
1453 dev_qualifier.bMaxPacketSize0 = device_desc.bMaxPacketSize0;
1455 /* and that all endpoints are dual-speed */
1456 hs_ep_in_desc.bEndpointAddress = fs_ep_in_desc.bEndpointAddress;
1457 hs_ep_out_desc.bEndpointAddress = fs_ep_out_desc.bEndpointAddress;
1458 #endif /* DUALSPEED */
1460 device_desc.bMaxPacketSize0 = gadget->ep0->maxpacket;
1461 usb_gadget_set_selfpowered(gadget);
1463 if (gadget->is_otg) {
1464 otg_desc.bmAttributes |= USB_OTG_HNP,
1465 config_desc.bmAttributes |= USB_CONFIG_ATT_WAKEUP;
1466 config_desc.bMaxPower = 4;
1469 spin_lock_init(&dev->lock);
1470 spin_lock_init(&dev->lock_printer_io);
1471 INIT_LIST_HEAD(&dev->tx_reqs);
1472 INIT_LIST_HEAD(&dev->tx_reqs_active);
1473 INIT_LIST_HEAD(&dev->rx_reqs);
1474 INIT_LIST_HEAD(&dev->rx_reqs_active);
1475 INIT_LIST_HEAD(&dev->rx_buffers);
1476 init_waitqueue_head(&dev->rx_wait);
1477 init_waitqueue_head(&dev->tx_wait);
1478 init_waitqueue_head(&dev->tx_flush_wait);
1481 dev->interface = -1;
1482 dev->printer_cdev_open = 0;
1483 dev->printer_status = PRINTER_NOT_ERROR;
1484 dev->current_rx_req = NULL;
1485 dev->current_rx_bytes = 0;
1486 dev->current_rx_buf = NULL;
1489 dev->out_ep = out_ep;
1491 /* preallocate control message data and buffer */
1492 dev->req = printer_req_alloc(gadget->ep0, USB_DESC_BUFSIZE,
1499 for (i = 0; i < QLEN; i++) {
1500 req = printer_req_alloc(dev->in_ep, USB_BUFSIZE, GFP_KERNEL);
1502 while (!list_empty(&dev->tx_reqs)) {
1503 req = container_of(dev->tx_reqs.next,
1504 struct usb_request, list);
1505 list_del(&req->list);
1506 printer_req_free(dev->in_ep, req);
1510 list_add(&req->list, &dev->tx_reqs);
1513 for (i = 0; i < QLEN; i++) {
1514 req = printer_req_alloc(dev->out_ep, USB_BUFSIZE, GFP_KERNEL);
1516 while (!list_empty(&dev->rx_reqs)) {
1517 req = container_of(dev->rx_reqs.next,
1518 struct usb_request, list);
1519 list_del(&req->list);
1520 printer_req_free(dev->out_ep, req);
1524 list_add(&req->list, &dev->rx_reqs);
1527 dev->req->complete = printer_setup_complete;
1529 /* finish hookup to lower layer ... */
1530 dev->gadget = gadget;
1531 set_gadget_data(gadget, dev);
1532 gadget->ep0->driver_data = dev;
1534 INFO(dev, "%s, version: " DRIVER_VERSION "\n", driver_desc);
1535 INFO(dev, "using %s, OUT %s IN %s\n", gadget->name, out_ep->name,
1541 printer_unbind(gadget);
1545 /*-------------------------------------------------------------------------*/
1547 static struct usb_gadget_driver printer_driver = {
1550 .function = (char *) driver_desc,
1551 .bind = printer_bind,
1552 .unbind = printer_unbind,
1554 .setup = printer_setup,
1555 .disconnect = printer_disconnect,
1558 .name = (char *) shortname,
1559 .owner = THIS_MODULE,
1563 MODULE_DESCRIPTION(DRIVER_DESC);
1564 MODULE_AUTHOR("Craig Nadler");
1565 MODULE_LICENSE("GPL");
1572 usb_gadget_class = class_create(THIS_MODULE, "usb_printer_gadget");
1573 if (IS_ERR(usb_gadget_class)) {
1574 status = PTR_ERR(usb_gadget_class);
1575 ERROR(dev, "unable to create usb_gadget class %d\n", status);
1579 status = alloc_chrdev_region(&g_printer_devno, 0, 1,
1580 "USB printer gadget");
1582 ERROR(dev, "alloc_chrdev_region %d\n", status);
1583 class_destroy(usb_gadget_class);
1587 status = usb_gadget_register_driver(&printer_driver);
1589 class_destroy(usb_gadget_class);
1590 unregister_chrdev_region(g_printer_devno, 1);
1591 DBG(dev, "usb_gadget_register_driver %x\n", status);
1603 spin_lock(&usb_printer_gadget.lock_printer_io);
1604 class_destroy(usb_gadget_class);
1605 unregister_chrdev_region(g_printer_devno, 2);
1607 status = usb_gadget_unregister_driver(&printer_driver);
1609 ERROR(dev, "usb_gadget_unregister_driver %x\n", status);
1611 spin_unlock(&usb_printer_gadget.lock_printer_io);
1613 module_exit(cleanup);