1 // SPDX-License-Identifier: GPL-2.0+
3 * f_printer.c - USB printer function driver
5 * Copied from drivers/usb/gadget/legacy/printer.c,
8 * printer.c -- Printer gadget driver
10 * Copyright (C) 2003-2005 David Brownell
11 * Copyright (C) 2006 Craig W. Nadler
14 #include <linux/module.h>
15 #include <linux/kernel.h>
16 #include <linux/delay.h>
17 #include <linux/ioport.h>
18 #include <linux/sched.h>
19 #include <linux/slab.h>
20 #include <linux/mutex.h>
21 #include <linux/errno.h>
22 #include <linux/init.h>
23 #include <linux/idr.h>
24 #include <linux/timer.h>
25 #include <linux/list.h>
26 #include <linux/interrupt.h>
27 #include <linux/device.h>
28 #include <linux/moduleparam.h>
30 #include <linux/poll.h>
31 #include <linux/types.h>
32 #include <linux/ctype.h>
33 #include <linux/cdev.h>
34 #include <linux/kref.h>
36 #include <asm/byteorder.h>
38 #include <linux/irq.h>
39 #include <linux/uaccess.h>
40 #include <asm/unaligned.h>
42 #include <linux/usb/ch9.h>
43 #include <linux/usb/composite.h>
44 #include <linux/usb/gadget.h>
45 #include <linux/usb/g_printer.h>
47 #include "u_printer.h"
49 #define PRINTER_MINORS 4
50 #define GET_DEVICE_ID 0
51 #define GET_PORT_STATUS 1
54 static int major, minors;
55 static struct class *usb_gadget_class;
56 static DEFINE_IDA(printer_ida);
57 static DEFINE_MUTEX(printer_ida_lock); /* protects access do printer_ida */
59 /*-------------------------------------------------------------------------*/
62 spinlock_t lock; /* lock this structure */
63 /* lock buffer lists during read/write calls */
64 struct mutex lock_printer_io;
65 struct usb_gadget *gadget;
67 struct usb_ep *in_ep, *out_ep;
69 struct list_head rx_reqs; /* List of free RX structs */
70 struct list_head rx_reqs_active; /* List of Active RX xfers */
71 struct list_head rx_buffers; /* List of completed xfers */
72 /* wait until there is data to be read. */
73 wait_queue_head_t rx_wait;
74 struct list_head tx_reqs; /* List of free TX structs */
75 struct list_head tx_reqs_active; /* List of Active TX xfers */
76 /* Wait until there are write buffers available to use. */
77 wait_queue_head_t tx_wait;
78 /* Wait until all write buffers have been sent. */
79 wait_queue_head_t tx_flush_wait;
80 struct usb_request *current_rx_req;
81 size_t current_rx_bytes;
86 struct cdev printer_cdev;
88 wait_queue_head_t wait;
90 char *pnp_string; /* We don't own memory! */
91 struct usb_function function;
94 static inline struct printer_dev *func_to_printer(struct usb_function *f)
96 return container_of(f, struct printer_dev, function);
99 /*-------------------------------------------------------------------------*/
102 * DESCRIPTORS ... most are static, but strings and (full) configuration
103 * descriptors are built on demand.
106 /* holds our biggest descriptor */
107 #define USB_DESC_BUFSIZE 256
108 #define USB_BUFSIZE 8192
110 static struct usb_interface_descriptor intf_desc = {
111 .bLength = sizeof(intf_desc),
112 .bDescriptorType = USB_DT_INTERFACE,
114 .bInterfaceClass = USB_CLASS_PRINTER,
115 .bInterfaceSubClass = 1, /* Printer Sub-Class */
116 .bInterfaceProtocol = 2, /* Bi-Directional */
120 static struct usb_endpoint_descriptor fs_ep_in_desc = {
121 .bLength = USB_DT_ENDPOINT_SIZE,
122 .bDescriptorType = USB_DT_ENDPOINT,
123 .bEndpointAddress = USB_DIR_IN,
124 .bmAttributes = USB_ENDPOINT_XFER_BULK
127 static struct usb_endpoint_descriptor fs_ep_out_desc = {
128 .bLength = USB_DT_ENDPOINT_SIZE,
129 .bDescriptorType = USB_DT_ENDPOINT,
130 .bEndpointAddress = USB_DIR_OUT,
131 .bmAttributes = USB_ENDPOINT_XFER_BULK
134 static struct usb_descriptor_header *fs_printer_function[] = {
135 (struct usb_descriptor_header *) &intf_desc,
136 (struct usb_descriptor_header *) &fs_ep_in_desc,
137 (struct usb_descriptor_header *) &fs_ep_out_desc,
142 * usb 2.0 devices need to expose both high speed and full speed
143 * descriptors, unless they only run at full speed.
146 static struct usb_endpoint_descriptor hs_ep_in_desc = {
147 .bLength = USB_DT_ENDPOINT_SIZE,
148 .bDescriptorType = USB_DT_ENDPOINT,
149 .bmAttributes = USB_ENDPOINT_XFER_BULK,
150 .wMaxPacketSize = cpu_to_le16(512)
153 static struct usb_endpoint_descriptor hs_ep_out_desc = {
154 .bLength = USB_DT_ENDPOINT_SIZE,
155 .bDescriptorType = USB_DT_ENDPOINT,
156 .bmAttributes = USB_ENDPOINT_XFER_BULK,
157 .wMaxPacketSize = cpu_to_le16(512)
160 static struct usb_descriptor_header *hs_printer_function[] = {
161 (struct usb_descriptor_header *) &intf_desc,
162 (struct usb_descriptor_header *) &hs_ep_in_desc,
163 (struct usb_descriptor_header *) &hs_ep_out_desc,
168 * Added endpoint descriptors for 3.0 devices
171 static struct usb_endpoint_descriptor ss_ep_in_desc = {
172 .bLength = USB_DT_ENDPOINT_SIZE,
173 .bDescriptorType = USB_DT_ENDPOINT,
174 .bmAttributes = USB_ENDPOINT_XFER_BULK,
175 .wMaxPacketSize = cpu_to_le16(1024),
178 static struct usb_ss_ep_comp_descriptor ss_ep_in_comp_desc = {
179 .bLength = sizeof(ss_ep_in_comp_desc),
180 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
183 static struct usb_endpoint_descriptor ss_ep_out_desc = {
184 .bLength = USB_DT_ENDPOINT_SIZE,
185 .bDescriptorType = USB_DT_ENDPOINT,
186 .bmAttributes = USB_ENDPOINT_XFER_BULK,
187 .wMaxPacketSize = cpu_to_le16(1024),
190 static struct usb_ss_ep_comp_descriptor ss_ep_out_comp_desc = {
191 .bLength = sizeof(ss_ep_out_comp_desc),
192 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
195 static struct usb_descriptor_header *ss_printer_function[] = {
196 (struct usb_descriptor_header *) &intf_desc,
197 (struct usb_descriptor_header *) &ss_ep_in_desc,
198 (struct usb_descriptor_header *) &ss_ep_in_comp_desc,
199 (struct usb_descriptor_header *) &ss_ep_out_desc,
200 (struct usb_descriptor_header *) &ss_ep_out_comp_desc,
204 /* maxpacket and other transfer characteristics vary by speed. */
205 static inline struct usb_endpoint_descriptor *ep_desc(struct usb_gadget *gadget,
206 struct usb_endpoint_descriptor *fs,
207 struct usb_endpoint_descriptor *hs,
208 struct usb_endpoint_descriptor *ss)
210 switch (gadget->speed) {
211 case USB_SPEED_SUPER:
220 /*-------------------------------------------------------------------------*/
222 static void printer_dev_free(struct kref *kref)
224 struct printer_dev *dev = container_of(kref, struct printer_dev, kref);
229 static struct usb_request *
230 printer_req_alloc(struct usb_ep *ep, unsigned len, gfp_t gfp_flags)
232 struct usb_request *req;
234 req = usb_ep_alloc_request(ep, gfp_flags);
238 req->buf = kmalloc(len, gfp_flags);
239 if (req->buf == NULL) {
240 usb_ep_free_request(ep, req);
249 printer_req_free(struct usb_ep *ep, struct usb_request *req)
251 if (ep != NULL && req != NULL) {
253 usb_ep_free_request(ep, req);
257 /*-------------------------------------------------------------------------*/
259 static void rx_complete(struct usb_ep *ep, struct usb_request *req)
261 struct printer_dev *dev = ep->driver_data;
262 int status = req->status;
265 spin_lock_irqsave(&dev->lock, flags);
267 list_del_init(&req->list); /* Remode from Active List */
271 /* normal completion */
273 if (req->actual > 0) {
274 list_add_tail(&req->list, &dev->rx_buffers);
275 DBG(dev, "G_Printer : rx length %d\n", req->actual);
277 list_add(&req->list, &dev->rx_reqs);
281 /* software-driven interface shutdown */
282 case -ECONNRESET: /* unlink */
283 case -ESHUTDOWN: /* disconnect etc */
284 VDBG(dev, "rx shutdown, code %d\n", status);
285 list_add(&req->list, &dev->rx_reqs);
288 /* for hardware automagic (such as pxa) */
289 case -ECONNABORTED: /* endpoint reset */
290 DBG(dev, "rx %s reset\n", ep->name);
291 list_add(&req->list, &dev->rx_reqs);
299 DBG(dev, "rx status %d\n", status);
300 list_add(&req->list, &dev->rx_reqs);
304 wake_up_interruptible(&dev->rx_wait);
305 spin_unlock_irqrestore(&dev->lock, flags);
308 static void tx_complete(struct usb_ep *ep, struct usb_request *req)
310 struct printer_dev *dev = ep->driver_data;
312 switch (req->status) {
314 VDBG(dev, "tx err %d\n", req->status);
316 case -ECONNRESET: /* unlink */
317 case -ESHUTDOWN: /* disconnect etc */
323 spin_lock(&dev->lock);
324 /* Take the request struct off the active list and put it on the
327 list_del_init(&req->list);
328 list_add(&req->list, &dev->tx_reqs);
329 wake_up_interruptible(&dev->tx_wait);
330 if (likely(list_empty(&dev->tx_reqs_active)))
331 wake_up_interruptible(&dev->tx_flush_wait);
333 spin_unlock(&dev->lock);
336 /*-------------------------------------------------------------------------*/
339 printer_open(struct inode *inode, struct file *fd)
341 struct printer_dev *dev;
345 dev = container_of(inode->i_cdev, struct printer_dev, printer_cdev);
347 spin_lock_irqsave(&dev->lock, flags);
349 if (!dev->printer_cdev_open) {
350 dev->printer_cdev_open = 1;
351 fd->private_data = dev;
353 /* Change the printer status to show that it's on-line. */
354 dev->printer_status |= PRINTER_SELECTED;
357 spin_unlock_irqrestore(&dev->lock, flags);
359 kref_get(&dev->kref);
360 DBG(dev, "printer_open returned %x\n", ret);
365 printer_close(struct inode *inode, struct file *fd)
367 struct printer_dev *dev = fd->private_data;
370 spin_lock_irqsave(&dev->lock, flags);
371 dev->printer_cdev_open = 0;
372 fd->private_data = NULL;
373 /* Change printer status to show that the printer is off-line. */
374 dev->printer_status &= ~PRINTER_SELECTED;
375 spin_unlock_irqrestore(&dev->lock, flags);
377 kref_put(&dev->kref, printer_dev_free);
378 DBG(dev, "printer_close\n");
383 /* This function must be called with interrupts turned off. */
385 setup_rx_reqs(struct printer_dev *dev)
387 struct usb_request *req;
389 while (likely(!list_empty(&dev->rx_reqs))) {
392 req = container_of(dev->rx_reqs.next,
393 struct usb_request, list);
394 list_del_init(&req->list);
396 /* The USB Host sends us whatever amount of data it wants to
397 * so we always set the length field to the full USB_BUFSIZE.
398 * If the amount of data is more than the read() caller asked
399 * for it will be stored in the request buffer until it is
400 * asked for by read().
402 req->length = USB_BUFSIZE;
403 req->complete = rx_complete;
405 /* here, we unlock, and only unlock, to avoid deadlock. */
406 spin_unlock(&dev->lock);
407 error = usb_ep_queue(dev->out_ep, req, GFP_ATOMIC);
408 spin_lock(&dev->lock);
410 DBG(dev, "rx submit --> %d\n", error);
411 list_add(&req->list, &dev->rx_reqs);
414 /* if the req is empty, then add it into dev->rx_reqs_active. */
415 else if (list_empty(&req->list))
416 list_add(&req->list, &dev->rx_reqs_active);
421 printer_read(struct file *fd, char __user *buf, size_t len, loff_t *ptr)
423 struct printer_dev *dev = fd->private_data;
427 struct usb_request *req;
428 /* This is a pointer to the current USB rx request. */
429 struct usb_request *current_rx_req;
430 /* This is the number of bytes in the current rx buffer. */
431 size_t current_rx_bytes;
432 /* This is a pointer to the current rx buffer. */
438 DBG(dev, "printer_read trying to read %d bytes\n", (int)len);
440 mutex_lock(&dev->lock_printer_io);
441 spin_lock_irqsave(&dev->lock, flags);
443 /* We will use this flag later to check if a printer reset happened
444 * after we turn interrupts back on.
446 dev->reset_printer = 0;
451 current_rx_req = dev->current_rx_req;
452 current_rx_bytes = dev->current_rx_bytes;
453 current_rx_buf = dev->current_rx_buf;
454 dev->current_rx_req = NULL;
455 dev->current_rx_bytes = 0;
456 dev->current_rx_buf = NULL;
458 /* Check if there is any data in the read buffers. Please note that
459 * current_rx_bytes is the number of bytes in the current rx buffer.
460 * If it is zero then check if there are any other rx_buffers that
461 * are on the completed list. We are only out of data if all rx
464 if ((current_rx_bytes == 0) &&
465 (likely(list_empty(&dev->rx_buffers)))) {
466 /* Turn interrupts back on before sleeping. */
467 spin_unlock_irqrestore(&dev->lock, flags);
470 * If no data is available check if this is a NON-Blocking
473 if (fd->f_flags & (O_NONBLOCK|O_NDELAY)) {
474 mutex_unlock(&dev->lock_printer_io);
478 /* Sleep until data is available */
479 wait_event_interruptible(dev->rx_wait,
480 (likely(!list_empty(&dev->rx_buffers))));
481 spin_lock_irqsave(&dev->lock, flags);
484 /* We have data to return then copy it to the caller's buffer.*/
485 while ((current_rx_bytes || likely(!list_empty(&dev->rx_buffers)))
487 if (current_rx_bytes == 0) {
488 req = container_of(dev->rx_buffers.next,
489 struct usb_request, list);
490 list_del_init(&req->list);
492 if (req->actual && req->buf) {
493 current_rx_req = req;
494 current_rx_bytes = req->actual;
495 current_rx_buf = req->buf;
497 list_add(&req->list, &dev->rx_reqs);
502 /* Don't leave irqs off while doing memory copies */
503 spin_unlock_irqrestore(&dev->lock, flags);
505 if (len > current_rx_bytes)
506 size = current_rx_bytes;
510 size -= copy_to_user(buf, current_rx_buf, size);
511 bytes_copied += size;
515 spin_lock_irqsave(&dev->lock, flags);
517 /* We've disconnected or reset so return. */
518 if (dev->reset_printer) {
519 list_add(¤t_rx_req->list, &dev->rx_reqs);
520 spin_unlock_irqrestore(&dev->lock, flags);
521 mutex_unlock(&dev->lock_printer_io);
525 /* If we not returning all the data left in this RX request
526 * buffer then adjust the amount of data left in the buffer.
527 * Othewise if we are done with this RX request buffer then
528 * requeue it to get any incoming data from the USB host.
530 if (size < current_rx_bytes) {
531 current_rx_bytes -= size;
532 current_rx_buf += size;
534 list_add(¤t_rx_req->list, &dev->rx_reqs);
535 current_rx_bytes = 0;
536 current_rx_buf = NULL;
537 current_rx_req = NULL;
541 dev->current_rx_req = current_rx_req;
542 dev->current_rx_bytes = current_rx_bytes;
543 dev->current_rx_buf = current_rx_buf;
545 spin_unlock_irqrestore(&dev->lock, flags);
546 mutex_unlock(&dev->lock_printer_io);
548 DBG(dev, "printer_read returned %d bytes\n", (int)bytes_copied);
557 printer_write(struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
559 struct printer_dev *dev = fd->private_data;
561 size_t size; /* Amount of data in a TX request. */
562 size_t bytes_copied = 0;
563 struct usb_request *req;
566 DBG(dev, "printer_write trying to send %d bytes\n", (int)len);
571 mutex_lock(&dev->lock_printer_io);
572 spin_lock_irqsave(&dev->lock, flags);
574 /* Check if a printer reset happens while we have interrupts on */
575 dev->reset_printer = 0;
577 /* Check if there is any available write buffers */
578 if (likely(list_empty(&dev->tx_reqs))) {
579 /* Turn interrupts back on before sleeping. */
580 spin_unlock_irqrestore(&dev->lock, flags);
583 * If write buffers are available check if this is
584 * a NON-Blocking call or not.
586 if (fd->f_flags & (O_NONBLOCK|O_NDELAY)) {
587 mutex_unlock(&dev->lock_printer_io);
591 /* Sleep until a write buffer is available */
592 wait_event_interruptible(dev->tx_wait,
593 (likely(!list_empty(&dev->tx_reqs))));
594 spin_lock_irqsave(&dev->lock, flags);
597 while (likely(!list_empty(&dev->tx_reqs)) && len) {
599 if (len > USB_BUFSIZE)
604 req = container_of(dev->tx_reqs.next, struct usb_request,
606 list_del_init(&req->list);
608 req->complete = tx_complete;
611 /* Check if we need to send a zero length packet. */
613 /* They will be more TX requests so no yet. */
616 /* If the data amount is not a multiple of the
617 * maxpacket size then send a zero length packet.
619 req->zero = ((len % dev->in_ep->maxpacket) == 0);
621 /* Don't leave irqs off while doing memory copies */
622 spin_unlock_irqrestore(&dev->lock, flags);
624 if (copy_from_user(req->buf, buf, size)) {
625 list_add(&req->list, &dev->tx_reqs);
626 mutex_unlock(&dev->lock_printer_io);
630 bytes_copied += size;
634 spin_lock_irqsave(&dev->lock, flags);
636 /* We've disconnected or reset so free the req and buffer */
637 if (dev->reset_printer) {
638 list_add(&req->list, &dev->tx_reqs);
639 spin_unlock_irqrestore(&dev->lock, flags);
640 mutex_unlock(&dev->lock_printer_io);
644 list_add(&req->list, &dev->tx_reqs_active);
646 /* here, we unlock, and only unlock, to avoid deadlock. */
647 spin_unlock(&dev->lock);
648 value = usb_ep_queue(dev->in_ep, req, GFP_ATOMIC);
649 spin_lock(&dev->lock);
651 list_del(&req->list);
652 list_add(&req->list, &dev->tx_reqs);
653 spin_unlock_irqrestore(&dev->lock, flags);
654 mutex_unlock(&dev->lock_printer_io);
659 spin_unlock_irqrestore(&dev->lock, flags);
660 mutex_unlock(&dev->lock_printer_io);
662 DBG(dev, "printer_write sent %d bytes\n", (int)bytes_copied);
671 printer_fsync(struct file *fd, loff_t start, loff_t end, int datasync)
673 struct printer_dev *dev = fd->private_data;
674 struct inode *inode = file_inode(fd);
679 spin_lock_irqsave(&dev->lock, flags);
680 tx_list_empty = (likely(list_empty(&dev->tx_reqs)));
681 spin_unlock_irqrestore(&dev->lock, flags);
683 if (!tx_list_empty) {
684 /* Sleep until all data has been sent */
685 wait_event_interruptible(dev->tx_flush_wait,
686 (likely(list_empty(&dev->tx_reqs_active))));
694 printer_poll(struct file *fd, poll_table *wait)
696 struct printer_dev *dev = fd->private_data;
700 mutex_lock(&dev->lock_printer_io);
701 spin_lock_irqsave(&dev->lock, flags);
703 spin_unlock_irqrestore(&dev->lock, flags);
704 mutex_unlock(&dev->lock_printer_io);
706 poll_wait(fd, &dev->rx_wait, wait);
707 poll_wait(fd, &dev->tx_wait, wait);
709 spin_lock_irqsave(&dev->lock, flags);
710 if (likely(!list_empty(&dev->tx_reqs)))
711 status |= EPOLLOUT | EPOLLWRNORM;
713 if (likely(dev->current_rx_bytes) ||
714 likely(!list_empty(&dev->rx_buffers)))
715 status |= EPOLLIN | EPOLLRDNORM;
717 spin_unlock_irqrestore(&dev->lock, flags);
723 printer_ioctl(struct file *fd, unsigned int code, unsigned long arg)
725 struct printer_dev *dev = fd->private_data;
729 DBG(dev, "printer_ioctl: cmd=0x%4.4x, arg=%lu\n", code, arg);
733 spin_lock_irqsave(&dev->lock, flags);
736 case GADGET_GET_PRINTER_STATUS:
737 status = (int)dev->printer_status;
739 case GADGET_SET_PRINTER_STATUS:
740 dev->printer_status = (u8)arg;
743 /* could not handle ioctl */
744 DBG(dev, "printer_ioctl: ERROR cmd=0x%4.4xis not supported\n",
749 spin_unlock_irqrestore(&dev->lock, flags);
754 /* used after endpoint configuration */
755 static const struct file_operations printer_io_operations = {
756 .owner = THIS_MODULE,
757 .open = printer_open,
758 .read = printer_read,
759 .write = printer_write,
760 .fsync = printer_fsync,
761 .poll = printer_poll,
762 .unlocked_ioctl = printer_ioctl,
763 .release = printer_close,
764 .llseek = noop_llseek,
767 /*-------------------------------------------------------------------------*/
770 set_printer_interface(struct printer_dev *dev)
774 dev->in_ep->desc = ep_desc(dev->gadget, &fs_ep_in_desc, &hs_ep_in_desc,
776 dev->in_ep->driver_data = dev;
778 dev->out_ep->desc = ep_desc(dev->gadget, &fs_ep_out_desc,
779 &hs_ep_out_desc, &ss_ep_out_desc);
780 dev->out_ep->driver_data = dev;
782 result = usb_ep_enable(dev->in_ep);
784 DBG(dev, "enable %s --> %d\n", dev->in_ep->name, result);
788 result = usb_ep_enable(dev->out_ep);
790 DBG(dev, "enable %s --> %d\n", dev->in_ep->name, result);
795 /* on error, disable any endpoints */
797 (void) usb_ep_disable(dev->in_ep);
798 (void) usb_ep_disable(dev->out_ep);
799 dev->in_ep->desc = NULL;
800 dev->out_ep->desc = NULL;
803 /* caller is responsible for cleanup on error */
807 static void printer_reset_interface(struct printer_dev *dev)
811 if (dev->interface < 0)
814 DBG(dev, "%s\n", __func__);
816 if (dev->in_ep->desc)
817 usb_ep_disable(dev->in_ep);
819 if (dev->out_ep->desc)
820 usb_ep_disable(dev->out_ep);
822 spin_lock_irqsave(&dev->lock, flags);
823 dev->in_ep->desc = NULL;
824 dev->out_ep->desc = NULL;
826 spin_unlock_irqrestore(&dev->lock, flags);
829 /* Change our operational Interface. */
830 static int set_interface(struct printer_dev *dev, unsigned number)
834 /* Free the current interface */
835 printer_reset_interface(dev);
837 result = set_printer_interface(dev);
839 printer_reset_interface(dev);
841 dev->interface = number;
844 INFO(dev, "Using interface %x\n", number);
849 static void printer_soft_reset(struct printer_dev *dev)
851 struct usb_request *req;
853 INFO(dev, "Received Printer Reset Request\n");
855 if (usb_ep_disable(dev->in_ep))
856 DBG(dev, "Failed to disable USB in_ep\n");
857 if (usb_ep_disable(dev->out_ep))
858 DBG(dev, "Failed to disable USB out_ep\n");
860 if (dev->current_rx_req != NULL) {
861 list_add(&dev->current_rx_req->list, &dev->rx_reqs);
862 dev->current_rx_req = NULL;
864 dev->current_rx_bytes = 0;
865 dev->current_rx_buf = NULL;
866 dev->reset_printer = 1;
868 while (likely(!(list_empty(&dev->rx_buffers)))) {
869 req = container_of(dev->rx_buffers.next, struct usb_request,
871 list_del_init(&req->list);
872 list_add(&req->list, &dev->rx_reqs);
875 while (likely(!(list_empty(&dev->rx_reqs_active)))) {
876 req = container_of(dev->rx_buffers.next, struct usb_request,
878 list_del_init(&req->list);
879 list_add(&req->list, &dev->rx_reqs);
882 while (likely(!(list_empty(&dev->tx_reqs_active)))) {
883 req = container_of(dev->tx_reqs_active.next,
884 struct usb_request, list);
885 list_del_init(&req->list);
886 list_add(&req->list, &dev->tx_reqs);
889 if (usb_ep_enable(dev->in_ep))
890 DBG(dev, "Failed to enable USB in_ep\n");
891 if (usb_ep_enable(dev->out_ep))
892 DBG(dev, "Failed to enable USB out_ep\n");
894 wake_up_interruptible(&dev->rx_wait);
895 wake_up_interruptible(&dev->tx_wait);
896 wake_up_interruptible(&dev->tx_flush_wait);
899 /*-------------------------------------------------------------------------*/
901 static bool gprinter_req_match(struct usb_function *f,
902 const struct usb_ctrlrequest *ctrl,
905 struct printer_dev *dev = func_to_printer(f);
906 u16 w_index = le16_to_cpu(ctrl->wIndex);
907 u16 w_value = le16_to_cpu(ctrl->wValue);
908 u16 w_length = le16_to_cpu(ctrl->wLength);
913 if ((ctrl->bRequestType & USB_RECIP_MASK) != USB_RECIP_INTERFACE ||
914 (ctrl->bRequestType & USB_TYPE_MASK) != USB_TYPE_CLASS)
917 switch (ctrl->bRequest) {
920 if (USB_DIR_IN & ctrl->bRequestType)
923 case GET_PORT_STATUS:
924 if (!w_value && w_length == 1 &&
925 (USB_DIR_IN & ctrl->bRequestType))
929 if (!w_value && !w_length &&
930 !(USB_DIR_IN & ctrl->bRequestType))
936 return w_index == dev->interface;
940 * The setup() callback implements all the ep0 functionality that's not
941 * handled lower down.
943 static int printer_func_setup(struct usb_function *f,
944 const struct usb_ctrlrequest *ctrl)
946 struct printer_dev *dev = func_to_printer(f);
947 struct usb_composite_dev *cdev = f->config->cdev;
948 struct usb_request *req = cdev->req;
950 int value = -EOPNOTSUPP;
951 u16 wIndex = le16_to_cpu(ctrl->wIndex);
952 u16 wValue = le16_to_cpu(ctrl->wValue);
953 u16 wLength = le16_to_cpu(ctrl->wLength);
955 DBG(dev, "ctrl req%02x.%02x v%04x i%04x l%d\n",
956 ctrl->bRequestType, ctrl->bRequest, wValue, wIndex, wLength);
958 switch (ctrl->bRequestType&USB_TYPE_MASK) {
960 switch (ctrl->bRequest) {
961 case GET_DEVICE_ID: /* Get the IEEE-1284 PNP String */
962 /* Only one printer interface is supported. */
963 if ((wIndex>>8) != dev->interface)
966 if (!dev->pnp_string) {
970 value = strlen(dev->pnp_string);
971 buf[0] = (value >> 8) & 0xFF;
972 buf[1] = value & 0xFF;
973 memcpy(buf + 2, dev->pnp_string, value);
974 DBG(dev, "1284 PNP String: %x %s\n", value,
978 case GET_PORT_STATUS: /* Get Port Status */
979 /* Only one printer interface is supported. */
980 if (wIndex != dev->interface)
983 buf[0] = dev->printer_status;
984 value = min_t(u16, wLength, 1);
987 case SOFT_RESET: /* Soft Reset */
988 /* Only one printer interface is supported. */
989 if (wIndex != dev->interface)
992 printer_soft_reset(dev);
1005 "unknown ctrl req%02x.%02x v%04x i%04x l%d\n",
1006 ctrl->bRequestType, ctrl->bRequest,
1007 wValue, wIndex, wLength);
1010 /* host either stalls (value < 0) or reports success */
1012 req->length = value;
1013 req->zero = value < wLength;
1014 value = usb_ep_queue(cdev->gadget->ep0, req, GFP_ATOMIC);
1016 ERROR(dev, "%s:%d Error!\n", __func__, __LINE__);
1023 static int printer_func_bind(struct usb_configuration *c,
1024 struct usb_function *f)
1026 struct usb_gadget *gadget = c->cdev->gadget;
1027 struct printer_dev *dev = func_to_printer(f);
1028 struct device *pdev;
1029 struct usb_composite_dev *cdev = c->cdev;
1030 struct usb_ep *in_ep;
1031 struct usb_ep *out_ep = NULL;
1032 struct usb_request *req;
1038 id = usb_interface_id(c, f);
1041 intf_desc.bInterfaceNumber = id;
1043 /* finish hookup to lower layer ... */
1044 dev->gadget = gadget;
1046 /* all we really need is bulk IN/OUT */
1047 in_ep = usb_ep_autoconfig(cdev->gadget, &fs_ep_in_desc);
1050 dev_err(&cdev->gadget->dev, "can't autoconfigure on %s\n",
1051 cdev->gadget->name);
1055 out_ep = usb_ep_autoconfig(cdev->gadget, &fs_ep_out_desc);
1059 /* assumes that all endpoints are dual-speed */
1060 hs_ep_in_desc.bEndpointAddress = fs_ep_in_desc.bEndpointAddress;
1061 hs_ep_out_desc.bEndpointAddress = fs_ep_out_desc.bEndpointAddress;
1062 ss_ep_in_desc.bEndpointAddress = fs_ep_in_desc.bEndpointAddress;
1063 ss_ep_out_desc.bEndpointAddress = fs_ep_out_desc.bEndpointAddress;
1065 ret = usb_assign_descriptors(f, fs_printer_function,
1066 hs_printer_function, ss_printer_function,
1067 ss_printer_function);
1072 dev->out_ep = out_ep;
1075 for (i = 0; i < dev->q_len; i++) {
1076 req = printer_req_alloc(dev->in_ep, USB_BUFSIZE, GFP_KERNEL);
1079 list_add(&req->list, &dev->tx_reqs);
1082 for (i = 0; i < dev->q_len; i++) {
1083 req = printer_req_alloc(dev->out_ep, USB_BUFSIZE, GFP_KERNEL);
1086 list_add(&req->list, &dev->rx_reqs);
1089 /* Setup the sysfs files for the printer gadget. */
1090 devt = MKDEV(major, dev->minor);
1091 pdev = device_create(usb_gadget_class, NULL, devt,
1092 NULL, "g_printer%d", dev->minor);
1094 ERROR(dev, "Failed to create device: g_printer\n");
1095 ret = PTR_ERR(pdev);
1100 * Register a character device as an interface to a user mode
1101 * program that handles the printer specific functionality.
1103 cdev_init(&dev->printer_cdev, &printer_io_operations);
1104 dev->printer_cdev.owner = THIS_MODULE;
1105 ret = cdev_add(&dev->printer_cdev, devt, 1);
1107 ERROR(dev, "Failed to open char device\n");
1114 device_destroy(usb_gadget_class, devt);
1117 while (!list_empty(&dev->rx_reqs)) {
1118 req = container_of(dev->rx_reqs.next, struct usb_request, list);
1119 list_del(&req->list);
1120 printer_req_free(dev->out_ep, req);
1124 while (!list_empty(&dev->tx_reqs)) {
1125 req = container_of(dev->tx_reqs.next, struct usb_request, list);
1126 list_del(&req->list);
1127 printer_req_free(dev->in_ep, req);
1130 usb_free_all_descriptors(f);
1135 static int printer_func_set_alt(struct usb_function *f,
1136 unsigned intf, unsigned alt)
1138 struct printer_dev *dev = func_to_printer(f);
1139 int ret = -ENOTSUPP;
1142 ret = set_interface(dev, intf);
1147 static void printer_func_disable(struct usb_function *f)
1149 struct printer_dev *dev = func_to_printer(f);
1151 DBG(dev, "%s\n", __func__);
1153 printer_reset_interface(dev);
1156 static inline struct f_printer_opts
1157 *to_f_printer_opts(struct config_item *item)
1159 return container_of(to_config_group(item), struct f_printer_opts,
1163 static void printer_attr_release(struct config_item *item)
1165 struct f_printer_opts *opts = to_f_printer_opts(item);
1167 usb_put_function_instance(&opts->func_inst);
1170 static struct configfs_item_operations printer_item_ops = {
1171 .release = printer_attr_release,
1174 static ssize_t f_printer_opts_pnp_string_show(struct config_item *item,
1177 struct f_printer_opts *opts = to_f_printer_opts(item);
1180 mutex_lock(&opts->lock);
1181 if (!opts->pnp_string)
1184 result = strlcpy(page, opts->pnp_string, PAGE_SIZE);
1185 if (result >= PAGE_SIZE) {
1187 } else if (page[result - 1] != '\n' && result + 1 < PAGE_SIZE) {
1188 page[result++] = '\n';
1189 page[result] = '\0';
1193 mutex_unlock(&opts->lock);
1198 static ssize_t f_printer_opts_pnp_string_store(struct config_item *item,
1199 const char *page, size_t len)
1201 struct f_printer_opts *opts = to_f_printer_opts(item);
1205 mutex_lock(&opts->lock);
1207 new_pnp = kstrndup(page, len, GFP_KERNEL);
1213 if (opts->pnp_string_allocated)
1214 kfree(opts->pnp_string);
1216 opts->pnp_string_allocated = true;
1217 opts->pnp_string = new_pnp;
1220 mutex_unlock(&opts->lock);
1225 CONFIGFS_ATTR(f_printer_opts_, pnp_string);
1227 static ssize_t f_printer_opts_q_len_show(struct config_item *item,
1230 struct f_printer_opts *opts = to_f_printer_opts(item);
1233 mutex_lock(&opts->lock);
1234 result = sprintf(page, "%d\n", opts->q_len);
1235 mutex_unlock(&opts->lock);
1240 static ssize_t f_printer_opts_q_len_store(struct config_item *item,
1241 const char *page, size_t len)
1243 struct f_printer_opts *opts = to_f_printer_opts(item);
1247 mutex_lock(&opts->lock);
1253 ret = kstrtou16(page, 0, &num);
1257 opts->q_len = (unsigned)num;
1260 mutex_unlock(&opts->lock);
1264 CONFIGFS_ATTR(f_printer_opts_, q_len);
1266 static struct configfs_attribute *printer_attrs[] = {
1267 &f_printer_opts_attr_pnp_string,
1268 &f_printer_opts_attr_q_len,
1272 static const struct config_item_type printer_func_type = {
1273 .ct_item_ops = &printer_item_ops,
1274 .ct_attrs = printer_attrs,
1275 .ct_owner = THIS_MODULE,
1278 static inline int gprinter_get_minor(void)
1282 ret = ida_simple_get(&printer_ida, 0, 0, GFP_KERNEL);
1283 if (ret >= PRINTER_MINORS) {
1284 ida_simple_remove(&printer_ida, ret);
1291 static inline void gprinter_put_minor(int minor)
1293 ida_simple_remove(&printer_ida, minor);
1296 static int gprinter_setup(int);
1297 static void gprinter_cleanup(void);
1299 static void gprinter_free_inst(struct usb_function_instance *f)
1301 struct f_printer_opts *opts;
1303 opts = container_of(f, struct f_printer_opts, func_inst);
1305 mutex_lock(&printer_ida_lock);
1307 gprinter_put_minor(opts->minor);
1308 if (ida_is_empty(&printer_ida))
1311 mutex_unlock(&printer_ida_lock);
1313 if (opts->pnp_string_allocated)
1314 kfree(opts->pnp_string);
1318 static struct usb_function_instance *gprinter_alloc_inst(void)
1320 struct f_printer_opts *opts;
1321 struct usb_function_instance *ret;
1324 opts = kzalloc(sizeof(*opts), GFP_KERNEL);
1326 return ERR_PTR(-ENOMEM);
1328 mutex_init(&opts->lock);
1329 opts->func_inst.free_func_inst = gprinter_free_inst;
1330 ret = &opts->func_inst;
1332 mutex_lock(&printer_ida_lock);
1334 if (ida_is_empty(&printer_ida)) {
1335 status = gprinter_setup(PRINTER_MINORS);
1337 ret = ERR_PTR(status);
1343 opts->minor = gprinter_get_minor();
1344 if (opts->minor < 0) {
1345 ret = ERR_PTR(opts->minor);
1347 if (ida_is_empty(&printer_ida))
1351 config_group_init_type_name(&opts->func_inst.group, "",
1352 &printer_func_type);
1355 mutex_unlock(&printer_ida_lock);
1359 static void gprinter_free(struct usb_function *f)
1361 struct printer_dev *dev = func_to_printer(f);
1362 struct f_printer_opts *opts;
1364 opts = container_of(f->fi, struct f_printer_opts, func_inst);
1366 kref_put(&dev->kref, printer_dev_free);
1367 mutex_lock(&opts->lock);
1369 mutex_unlock(&opts->lock);
1372 static void printer_func_unbind(struct usb_configuration *c,
1373 struct usb_function *f)
1375 struct printer_dev *dev;
1376 struct usb_request *req;
1378 dev = func_to_printer(f);
1380 device_destroy(usb_gadget_class, MKDEV(major, dev->minor));
1382 /* Remove Character Device */
1383 cdev_del(&dev->printer_cdev);
1385 /* we must already have been disconnected ... no i/o may be active */
1386 WARN_ON(!list_empty(&dev->tx_reqs_active));
1387 WARN_ON(!list_empty(&dev->rx_reqs_active));
1389 /* Free all memory for this driver. */
1390 while (!list_empty(&dev->tx_reqs)) {
1391 req = container_of(dev->tx_reqs.next, struct usb_request,
1393 list_del(&req->list);
1394 printer_req_free(dev->in_ep, req);
1397 if (dev->current_rx_req != NULL)
1398 printer_req_free(dev->out_ep, dev->current_rx_req);
1400 while (!list_empty(&dev->rx_reqs)) {
1401 req = container_of(dev->rx_reqs.next,
1402 struct usb_request, list);
1403 list_del(&req->list);
1404 printer_req_free(dev->out_ep, req);
1407 while (!list_empty(&dev->rx_buffers)) {
1408 req = container_of(dev->rx_buffers.next,
1409 struct usb_request, list);
1410 list_del(&req->list);
1411 printer_req_free(dev->out_ep, req);
1413 usb_free_all_descriptors(f);
1416 static struct usb_function *gprinter_alloc(struct usb_function_instance *fi)
1418 struct printer_dev *dev;
1419 struct f_printer_opts *opts;
1421 opts = container_of(fi, struct f_printer_opts, func_inst);
1423 mutex_lock(&opts->lock);
1424 if (opts->minor >= minors) {
1425 mutex_unlock(&opts->lock);
1426 return ERR_PTR(-ENOENT);
1429 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1431 mutex_unlock(&opts->lock);
1432 return ERR_PTR(-ENOMEM);
1435 kref_init(&dev->kref);
1437 dev->minor = opts->minor;
1438 dev->pnp_string = opts->pnp_string;
1439 dev->q_len = opts->q_len;
1440 mutex_unlock(&opts->lock);
1442 dev->function.name = "printer";
1443 dev->function.bind = printer_func_bind;
1444 dev->function.setup = printer_func_setup;
1445 dev->function.unbind = printer_func_unbind;
1446 dev->function.set_alt = printer_func_set_alt;
1447 dev->function.disable = printer_func_disable;
1448 dev->function.req_match = gprinter_req_match;
1449 dev->function.free_func = gprinter_free;
1451 INIT_LIST_HEAD(&dev->tx_reqs);
1452 INIT_LIST_HEAD(&dev->rx_reqs);
1453 INIT_LIST_HEAD(&dev->rx_buffers);
1454 INIT_LIST_HEAD(&dev->tx_reqs_active);
1455 INIT_LIST_HEAD(&dev->rx_reqs_active);
1457 spin_lock_init(&dev->lock);
1458 mutex_init(&dev->lock_printer_io);
1459 init_waitqueue_head(&dev->rx_wait);
1460 init_waitqueue_head(&dev->tx_wait);
1461 init_waitqueue_head(&dev->tx_flush_wait);
1463 dev->interface = -1;
1464 dev->printer_cdev_open = 0;
1465 dev->printer_status = PRINTER_NOT_ERROR;
1466 dev->current_rx_req = NULL;
1467 dev->current_rx_bytes = 0;
1468 dev->current_rx_buf = NULL;
1470 return &dev->function;
1473 DECLARE_USB_FUNCTION_INIT(printer, gprinter_alloc_inst, gprinter_alloc);
1474 MODULE_LICENSE("GPL");
1475 MODULE_AUTHOR("Craig Nadler");
1477 static int gprinter_setup(int count)
1482 usb_gadget_class = class_create(THIS_MODULE, "usb_printer_gadget");
1483 if (IS_ERR(usb_gadget_class)) {
1484 status = PTR_ERR(usb_gadget_class);
1485 usb_gadget_class = NULL;
1486 pr_err("unable to create usb_gadget class %d\n", status);
1490 status = alloc_chrdev_region(&devt, 0, count, "USB printer gadget");
1492 pr_err("alloc_chrdev_region %d\n", status);
1493 class_destroy(usb_gadget_class);
1494 usb_gadget_class = NULL;
1498 major = MAJOR(devt);
1504 static void gprinter_cleanup(void)
1507 unregister_chrdev_region(MKDEV(major, 0), minors);
1510 class_destroy(usb_gadget_class);
1511 usb_gadget_class = NULL;