1 // SPDX-License-Identifier: GPL-2.0
3 * USB Raw Gadget driver.
4 * See Documentation/usb/raw-gadget.rst for more details.
6 * Copyright (c) 2020 Google, Inc.
7 * Author: Andrey Konovalov <andreyknvl@gmail.com>
10 #include <linux/compiler.h>
11 #include <linux/ctype.h>
12 #include <linux/debugfs.h>
13 #include <linux/delay.h>
14 #include <linux/idr.h>
15 #include <linux/kref.h>
16 #include <linux/miscdevice.h>
17 #include <linux/module.h>
18 #include <linux/semaphore.h>
19 #include <linux/sched.h>
20 #include <linux/slab.h>
21 #include <linux/uaccess.h>
22 #include <linux/wait.h>
24 #include <linux/usb.h>
25 #include <linux/usb/ch9.h>
26 #include <linux/usb/ch11.h>
27 #include <linux/usb/gadget.h>
28 #include <linux/usb/composite.h>
30 #include <uapi/linux/usb/raw_gadget.h>
32 #define DRIVER_DESC "USB Raw Gadget"
33 #define DRIVER_NAME "raw-gadget"
35 MODULE_DESCRIPTION(DRIVER_DESC);
36 MODULE_AUTHOR("Andrey Konovalov");
37 MODULE_LICENSE("GPL");
39 /*----------------------------------------------------------------------*/
41 static DEFINE_IDA(driver_id_numbers);
42 #define DRIVER_DRIVER_NAME_LENGTH_MAX 32
44 #define RAW_EVENT_QUEUE_SIZE 16
46 struct raw_event_queue {
47 /* See the comment in raw_event_queue_fetch() for locking details. */
49 struct semaphore sema;
50 struct usb_raw_event *events[RAW_EVENT_QUEUE_SIZE];
54 static void raw_event_queue_init(struct raw_event_queue *queue)
56 spin_lock_init(&queue->lock);
57 sema_init(&queue->sema, 0);
61 static int raw_event_queue_add(struct raw_event_queue *queue,
62 enum usb_raw_event_type type, size_t length, const void *data)
65 struct usb_raw_event *event;
67 spin_lock_irqsave(&queue->lock, flags);
68 if (queue->size >= RAW_EVENT_QUEUE_SIZE) {
69 spin_unlock_irqrestore(&queue->lock, flags);
72 event = kmalloc(sizeof(*event) + length, GFP_ATOMIC);
74 spin_unlock_irqrestore(&queue->lock, flags);
78 event->length = length;
80 memcpy(&event->data[0], data, length);
81 queue->events[queue->size] = event;
84 spin_unlock_irqrestore(&queue->lock, flags);
88 static struct usb_raw_event *raw_event_queue_fetch(
89 struct raw_event_queue *queue)
93 struct usb_raw_event *event;
96 * This function can be called concurrently. We first check that
97 * there's at least one event queued by decrementing the semaphore,
98 * and then take the lock to protect queue struct fields.
100 ret = down_interruptible(&queue->sema);
103 spin_lock_irqsave(&queue->lock, flags);
105 * queue->size must have the same value as queue->sema counter (before
106 * the down_interruptible() call above), so this check is a fail-safe.
108 if (WARN_ON(!queue->size)) {
109 spin_unlock_irqrestore(&queue->lock, flags);
110 return ERR_PTR(-ENODEV);
112 event = queue->events[0];
114 memmove(&queue->events[0], &queue->events[1],
115 queue->size * sizeof(queue->events[0]));
116 spin_unlock_irqrestore(&queue->lock, flags);
120 static void raw_event_queue_destroy(struct raw_event_queue *queue)
124 for (i = 0; i < queue->size; i++)
125 kfree(queue->events[i]);
129 /*----------------------------------------------------------------------*/
143 struct usb_request *req;
150 STATE_DEV_INVALID = 0,
152 STATE_DEV_INITIALIZED,
153 STATE_DEV_REGISTERING,
163 const char *udc_name;
164 struct usb_gadget_driver driver;
166 /* Reference to misc device: */
169 /* Make driver names unique */
170 int driver_id_number;
172 /* Protected by lock: */
173 enum dev_state state;
174 bool gadget_registered;
175 struct usb_gadget *gadget;
176 struct usb_request *req;
178 bool ep0_out_pending;
181 struct raw_ep eps[USB_RAW_EPS_NUM_MAX];
184 struct completion ep0_done;
185 struct raw_event_queue queue;
188 static struct raw_dev *dev_new(void)
192 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
195 /* Matches kref_put() in raw_release(). */
196 kref_init(&dev->count);
197 spin_lock_init(&dev->lock);
198 init_completion(&dev->ep0_done);
199 raw_event_queue_init(&dev->queue);
200 dev->driver_id_number = -1;
204 static void dev_free(struct kref *kref)
206 struct raw_dev *dev = container_of(kref, struct raw_dev, count);
209 kfree(dev->udc_name);
210 kfree(dev->driver.udc_name);
211 kfree(dev->driver.driver.name);
212 if (dev->driver_id_number >= 0)
213 ida_free(&driver_id_numbers, dev->driver_id_number);
215 if (dev->ep0_urb_queued)
216 usb_ep_dequeue(dev->gadget->ep0, dev->req);
217 usb_ep_free_request(dev->gadget->ep0, dev->req);
219 raw_event_queue_destroy(&dev->queue);
220 for (i = 0; i < dev->eps_num; i++) {
221 if (dev->eps[i].state == STATE_EP_DISABLED)
223 usb_ep_disable(dev->eps[i].ep);
224 usb_ep_free_request(dev->eps[i].ep, dev->eps[i].req);
225 kfree(dev->eps[i].ep->desc);
226 dev->eps[i].state = STATE_EP_DISABLED;
231 /*----------------------------------------------------------------------*/
233 static int raw_queue_event(struct raw_dev *dev,
234 enum usb_raw_event_type type, size_t length, const void *data)
239 ret = raw_event_queue_add(&dev->queue, type, length, data);
241 spin_lock_irqsave(&dev->lock, flags);
242 dev->state = STATE_DEV_FAILED;
243 spin_unlock_irqrestore(&dev->lock, flags);
248 static void gadget_ep0_complete(struct usb_ep *ep, struct usb_request *req)
250 struct raw_dev *dev = req->context;
253 spin_lock_irqsave(&dev->lock, flags);
255 dev->ep0_status = req->status;
257 dev->ep0_status = req->actual;
258 if (dev->ep0_in_pending)
259 dev->ep0_in_pending = false;
261 dev->ep0_out_pending = false;
262 spin_unlock_irqrestore(&dev->lock, flags);
264 complete(&dev->ep0_done);
267 static u8 get_ep_addr(const char *name)
269 /* If the endpoint has fixed function (named as e.g. "ep12out-bulk"),
270 * parse the endpoint address from its name. We deliberately use
271 * deprecated simple_strtoul() function here, as the number isn't
272 * followed by '\0' nor '\n'.
274 if (isdigit(name[2]))
275 return simple_strtoul(&name[2], NULL, 10);
276 /* Otherwise the endpoint is configurable (named as e.g. "ep-a"). */
277 return USB_RAW_EP_ADDR_ANY;
280 static int gadget_bind(struct usb_gadget *gadget,
281 struct usb_gadget_driver *driver)
284 struct raw_dev *dev = container_of(driver, struct raw_dev, driver);
285 struct usb_request *req;
289 if (strcmp(gadget->name, dev->udc_name) != 0)
292 set_gadget_data(gadget, dev);
293 req = usb_ep_alloc_request(gadget->ep0, GFP_KERNEL);
295 dev_err(&gadget->dev, "usb_ep_alloc_request failed\n");
296 set_gadget_data(gadget, NULL);
300 spin_lock_irqsave(&dev->lock, flags);
302 dev->req->context = dev;
303 dev->req->complete = gadget_ep0_complete;
304 dev->gadget = gadget;
305 gadget_for_each_ep(ep, dev->gadget) {
307 dev->eps[i].addr = get_ep_addr(ep->name);
308 dev->eps[i].state = STATE_EP_DISABLED;
312 spin_unlock_irqrestore(&dev->lock, flags);
314 dev_dbg(&gadget->dev, "gadget connected\n");
315 ret = raw_queue_event(dev, USB_RAW_EVENT_CONNECT, 0, NULL);
317 dev_err(&gadget->dev, "failed to queue connect event\n");
318 set_gadget_data(gadget, NULL);
322 /* Matches kref_put() in gadget_unbind(). */
323 kref_get(&dev->count);
327 static void gadget_unbind(struct usb_gadget *gadget)
329 struct raw_dev *dev = get_gadget_data(gadget);
331 set_gadget_data(gadget, NULL);
332 /* Matches kref_get() in gadget_bind(). */
333 kref_put(&dev->count, dev_free);
336 static int gadget_setup(struct usb_gadget *gadget,
337 const struct usb_ctrlrequest *ctrl)
340 struct raw_dev *dev = get_gadget_data(gadget);
343 spin_lock_irqsave(&dev->lock, flags);
344 if (dev->state != STATE_DEV_RUNNING) {
345 dev_err(&gadget->dev, "ignoring, device is not running\n");
349 if (dev->ep0_in_pending || dev->ep0_out_pending) {
350 dev_dbg(&gadget->dev, "stalling, request already pending\n");
354 if ((ctrl->bRequestType & USB_DIR_IN) && ctrl->wLength)
355 dev->ep0_in_pending = true;
357 dev->ep0_out_pending = true;
358 spin_unlock_irqrestore(&dev->lock, flags);
360 ret = raw_queue_event(dev, USB_RAW_EVENT_CONTROL, sizeof(*ctrl), ctrl);
362 dev_err(&gadget->dev, "failed to queue control event\n");
366 spin_unlock_irqrestore(&dev->lock, flags);
368 if (ret == 0 && ctrl->wLength == 0) {
370 * Return USB_GADGET_DELAYED_STATUS as a workaround to stop
371 * some UDC drivers (e.g. dwc3) from automatically proceeding
372 * with the status stage for 0-length transfers.
373 * Should be removed once all UDC drivers are fixed to always
374 * delay the status stage until a response is queued to EP0.
376 return USB_GADGET_DELAYED_STATUS;
381 static void gadget_disconnect(struct usb_gadget *gadget)
383 struct raw_dev *dev = get_gadget_data(gadget);
386 dev_dbg(&gadget->dev, "gadget disconnected\n");
387 ret = raw_queue_event(dev, USB_RAW_EVENT_DISCONNECT, 0, NULL);
389 dev_err(&gadget->dev, "failed to queue disconnect event\n");
391 static void gadget_suspend(struct usb_gadget *gadget)
393 struct raw_dev *dev = get_gadget_data(gadget);
396 dev_dbg(&gadget->dev, "gadget suspended\n");
397 ret = raw_queue_event(dev, USB_RAW_EVENT_SUSPEND, 0, NULL);
399 dev_err(&gadget->dev, "failed to queue suspend event\n");
401 static void gadget_resume(struct usb_gadget *gadget)
403 struct raw_dev *dev = get_gadget_data(gadget);
406 dev_dbg(&gadget->dev, "gadget resumed\n");
407 ret = raw_queue_event(dev, USB_RAW_EVENT_RESUME, 0, NULL);
409 dev_err(&gadget->dev, "failed to queue resume event\n");
411 static void gadget_reset(struct usb_gadget *gadget)
413 struct raw_dev *dev = get_gadget_data(gadget);
416 dev_dbg(&gadget->dev, "gadget reset\n");
417 ret = raw_queue_event(dev, USB_RAW_EVENT_RESET, 0, NULL);
419 dev_err(&gadget->dev, "failed to queue reset event\n");
422 /*----------------------------------------------------------------------*/
424 static struct miscdevice raw_misc_device;
426 static int raw_open(struct inode *inode, struct file *fd)
430 /* Nonblocking I/O is not supported yet. */
431 if (fd->f_flags & O_NONBLOCK)
437 fd->private_data = dev;
438 dev->state = STATE_DEV_OPENED;
439 dev->dev = raw_misc_device.this_device;
443 static int raw_release(struct inode *inode, struct file *fd)
446 struct raw_dev *dev = fd->private_data;
448 bool unregister = false;
450 spin_lock_irqsave(&dev->lock, flags);
451 dev->state = STATE_DEV_CLOSED;
453 spin_unlock_irqrestore(&dev->lock, flags);
456 if (dev->gadget_registered)
458 dev->gadget_registered = false;
459 spin_unlock_irqrestore(&dev->lock, flags);
462 ret = usb_gadget_unregister_driver(&dev->driver);
465 "usb_gadget_unregister_driver() failed with %d\n",
467 /* Matches kref_get() in raw_ioctl_run(). */
468 kref_put(&dev->count, dev_free);
472 /* Matches dev_new() in raw_open(). */
473 kref_put(&dev->count, dev_free);
477 /*----------------------------------------------------------------------*/
479 static int raw_ioctl_init(struct raw_dev *dev, unsigned long value)
482 int driver_id_number;
483 struct usb_raw_init arg;
484 char *udc_driver_name;
485 char *udc_device_name;
486 char *driver_driver_name;
489 if (copy_from_user(&arg, (void __user *)value, sizeof(arg)))
493 case USB_SPEED_UNKNOWN:
494 arg.speed = USB_SPEED_HIGH;
499 case USB_SPEED_SUPER:
505 driver_id_number = ida_alloc(&driver_id_numbers, GFP_KERNEL);
506 if (driver_id_number < 0)
507 return driver_id_number;
509 driver_driver_name = kmalloc(DRIVER_DRIVER_NAME_LENGTH_MAX, GFP_KERNEL);
510 if (!driver_driver_name) {
512 goto out_free_driver_id_number;
514 snprintf(driver_driver_name, DRIVER_DRIVER_NAME_LENGTH_MAX,
515 DRIVER_NAME ".%d", driver_id_number);
517 udc_driver_name = kmalloc(UDC_NAME_LENGTH_MAX, GFP_KERNEL);
518 if (!udc_driver_name) {
520 goto out_free_driver_driver_name;
522 ret = strscpy(udc_driver_name, &arg.driver_name[0],
523 UDC_NAME_LENGTH_MAX);
525 goto out_free_udc_driver_name;
528 udc_device_name = kmalloc(UDC_NAME_LENGTH_MAX, GFP_KERNEL);
529 if (!udc_device_name) {
531 goto out_free_udc_driver_name;
533 ret = strscpy(udc_device_name, &arg.device_name[0],
534 UDC_NAME_LENGTH_MAX);
536 goto out_free_udc_device_name;
539 spin_lock_irqsave(&dev->lock, flags);
540 if (dev->state != STATE_DEV_OPENED) {
541 dev_dbg(dev->dev, "fail, device is not opened\n");
545 dev->udc_name = udc_driver_name;
547 dev->driver.function = DRIVER_DESC;
548 dev->driver.max_speed = arg.speed;
549 dev->driver.setup = gadget_setup;
550 dev->driver.disconnect = gadget_disconnect;
551 dev->driver.bind = gadget_bind;
552 dev->driver.unbind = gadget_unbind;
553 dev->driver.suspend = gadget_suspend;
554 dev->driver.resume = gadget_resume;
555 dev->driver.reset = gadget_reset;
556 dev->driver.driver.name = driver_driver_name;
557 dev->driver.udc_name = udc_device_name;
558 dev->driver.match_existing_only = 1;
559 dev->driver_id_number = driver_id_number;
561 dev->state = STATE_DEV_INITIALIZED;
562 spin_unlock_irqrestore(&dev->lock, flags);
566 spin_unlock_irqrestore(&dev->lock, flags);
567 out_free_udc_device_name:
568 kfree(udc_device_name);
569 out_free_udc_driver_name:
570 kfree(udc_driver_name);
571 out_free_driver_driver_name:
572 kfree(driver_driver_name);
573 out_free_driver_id_number:
574 ida_free(&driver_id_numbers, driver_id_number);
578 static int raw_ioctl_run(struct raw_dev *dev, unsigned long value)
586 spin_lock_irqsave(&dev->lock, flags);
587 if (dev->state != STATE_DEV_INITIALIZED) {
588 dev_dbg(dev->dev, "fail, device is not initialized\n");
592 dev->state = STATE_DEV_REGISTERING;
593 spin_unlock_irqrestore(&dev->lock, flags);
595 ret = usb_gadget_register_driver(&dev->driver);
597 spin_lock_irqsave(&dev->lock, flags);
600 "fail, usb_gadget_register_driver returned %d\n", ret);
601 dev->state = STATE_DEV_FAILED;
604 dev->gadget_registered = true;
605 dev->state = STATE_DEV_RUNNING;
606 /* Matches kref_put() in raw_release(). */
607 kref_get(&dev->count);
610 spin_unlock_irqrestore(&dev->lock, flags);
614 static int raw_ioctl_event_fetch(struct raw_dev *dev, unsigned long value)
616 struct usb_raw_event arg;
618 struct usb_raw_event *event;
621 if (copy_from_user(&arg, (void __user *)value, sizeof(arg)))
624 spin_lock_irqsave(&dev->lock, flags);
625 if (dev->state != STATE_DEV_RUNNING) {
626 dev_dbg(dev->dev, "fail, device is not running\n");
627 spin_unlock_irqrestore(&dev->lock, flags);
631 dev_dbg(dev->dev, "fail, gadget is not bound\n");
632 spin_unlock_irqrestore(&dev->lock, flags);
635 spin_unlock_irqrestore(&dev->lock, flags);
637 event = raw_event_queue_fetch(&dev->queue);
638 if (PTR_ERR(event) == -EINTR) {
639 dev_dbg(&dev->gadget->dev, "event fetching interrupted\n");
643 dev_err(&dev->gadget->dev, "failed to fetch event\n");
644 spin_lock_irqsave(&dev->lock, flags);
645 dev->state = STATE_DEV_FAILED;
646 spin_unlock_irqrestore(&dev->lock, flags);
649 length = min(arg.length, event->length);
650 if (copy_to_user((void __user *)value, event, sizeof(*event) + length)) {
659 static void *raw_alloc_io_data(struct usb_raw_ep_io *io, void __user *ptr,
664 if (copy_from_user(io, ptr, sizeof(*io)))
665 return ERR_PTR(-EFAULT);
666 if (io->ep >= USB_RAW_EPS_NUM_MAX)
667 return ERR_PTR(-EINVAL);
668 if (!usb_raw_io_flags_valid(io->flags))
669 return ERR_PTR(-EINVAL);
670 if (io->length > PAGE_SIZE)
671 return ERR_PTR(-EINVAL);
673 data = memdup_user(ptr + sizeof(*io), io->length);
675 data = kmalloc(io->length, GFP_KERNEL);
677 data = ERR_PTR(-ENOMEM);
682 static int raw_process_ep0_io(struct raw_dev *dev, struct usb_raw_ep_io *io,
688 spin_lock_irqsave(&dev->lock, flags);
689 if (dev->state != STATE_DEV_RUNNING) {
690 dev_dbg(dev->dev, "fail, device is not running\n");
695 dev_dbg(dev->dev, "fail, gadget is not bound\n");
699 if (dev->ep0_urb_queued) {
700 dev_dbg(&dev->gadget->dev, "fail, urb already queued\n");
704 if ((in && !dev->ep0_in_pending) ||
705 (!in && !dev->ep0_out_pending)) {
706 dev_dbg(&dev->gadget->dev, "fail, wrong direction\n");
710 if (WARN_ON(in && dev->ep0_out_pending)) {
712 dev->state = STATE_DEV_FAILED;
715 if (WARN_ON(!in && dev->ep0_in_pending)) {
717 dev->state = STATE_DEV_FAILED;
721 dev->req->buf = data;
722 dev->req->length = io->length;
723 dev->req->zero = usb_raw_io_flags_zero(io->flags);
724 dev->ep0_urb_queued = true;
725 spin_unlock_irqrestore(&dev->lock, flags);
727 ret = usb_ep_queue(dev->gadget->ep0, dev->req, GFP_KERNEL);
729 dev_err(&dev->gadget->dev,
730 "fail, usb_ep_queue returned %d\n", ret);
731 spin_lock_irqsave(&dev->lock, flags);
732 goto out_queue_failed;
735 ret = wait_for_completion_interruptible(&dev->ep0_done);
737 dev_dbg(&dev->gadget->dev, "wait interrupted\n");
738 usb_ep_dequeue(dev->gadget->ep0, dev->req);
739 wait_for_completion(&dev->ep0_done);
740 spin_lock_irqsave(&dev->lock, flags);
741 if (dev->ep0_status == -ECONNRESET)
742 dev->ep0_status = -EINTR;
743 goto out_interrupted;
746 spin_lock_irqsave(&dev->lock, flags);
749 ret = dev->ep0_status;
751 dev->ep0_urb_queued = false;
753 spin_unlock_irqrestore(&dev->lock, flags);
757 static int raw_ioctl_ep0_write(struct raw_dev *dev, unsigned long value)
761 struct usb_raw_ep_io io;
763 data = raw_alloc_io_data(&io, (void __user *)value, true);
765 return PTR_ERR(data);
766 ret = raw_process_ep0_io(dev, &io, data, true);
771 static int raw_ioctl_ep0_read(struct raw_dev *dev, unsigned long value)
775 struct usb_raw_ep_io io;
778 data = raw_alloc_io_data(&io, (void __user *)value, false);
780 return PTR_ERR(data);
781 ret = raw_process_ep0_io(dev, &io, data, false);
785 length = min(io.length, (unsigned int)ret);
786 if (copy_to_user((void __user *)(value + sizeof(io)), data, length))
795 static int raw_ioctl_ep0_stall(struct raw_dev *dev, unsigned long value)
802 spin_lock_irqsave(&dev->lock, flags);
803 if (dev->state != STATE_DEV_RUNNING) {
804 dev_dbg(dev->dev, "fail, device is not running\n");
809 dev_dbg(dev->dev, "fail, gadget is not bound\n");
813 if (dev->ep0_urb_queued) {
814 dev_dbg(&dev->gadget->dev, "fail, urb already queued\n");
818 if (!dev->ep0_in_pending && !dev->ep0_out_pending) {
819 dev_dbg(&dev->gadget->dev, "fail, no request pending\n");
824 ret = usb_ep_set_halt(dev->gadget->ep0);
826 dev_err(&dev->gadget->dev,
827 "fail, usb_ep_set_halt returned %d\n", ret);
829 if (dev->ep0_in_pending)
830 dev->ep0_in_pending = false;
832 dev->ep0_out_pending = false;
835 spin_unlock_irqrestore(&dev->lock, flags);
839 static int raw_ioctl_ep_enable(struct raw_dev *dev, unsigned long value)
843 struct usb_endpoint_descriptor *desc;
845 bool ep_props_matched = false;
847 desc = memdup_user((void __user *)value, sizeof(*desc));
849 return PTR_ERR(desc);
852 * Endpoints with a maxpacket length of 0 can cause crashes in UDC
855 if (usb_endpoint_maxp(desc) == 0) {
856 dev_dbg(dev->dev, "fail, bad endpoint maxpacket\n");
861 spin_lock_irqsave(&dev->lock, flags);
862 if (dev->state != STATE_DEV_RUNNING) {
863 dev_dbg(dev->dev, "fail, device is not running\n");
868 dev_dbg(dev->dev, "fail, gadget is not bound\n");
873 for (i = 0; i < dev->eps_num; i++) {
875 if (ep->addr != usb_endpoint_num(desc) &&
876 ep->addr != USB_RAW_EP_ADDR_ANY)
878 if (!usb_gadget_ep_match_desc(dev->gadget, ep->ep, desc, NULL))
880 ep_props_matched = true;
881 if (ep->state != STATE_EP_DISABLED)
884 ret = usb_ep_enable(ep->ep);
886 dev_err(&dev->gadget->dev,
887 "fail, usb_ep_enable returned %d\n", ret);
890 ep->req = usb_ep_alloc_request(ep->ep, GFP_ATOMIC);
892 dev_err(&dev->gadget->dev,
893 "fail, usb_ep_alloc_request failed\n");
894 usb_ep_disable(ep->ep);
898 ep->state = STATE_EP_ENABLED;
899 ep->ep->driver_data = ep;
904 if (!ep_props_matched) {
905 dev_dbg(&dev->gadget->dev, "fail, bad endpoint descriptor\n");
908 dev_dbg(&dev->gadget->dev, "fail, no endpoints available\n");
915 spin_unlock_irqrestore(&dev->lock, flags);
919 static int raw_ioctl_ep_disable(struct raw_dev *dev, unsigned long value)
921 int ret = 0, i = value;
924 spin_lock_irqsave(&dev->lock, flags);
925 if (dev->state != STATE_DEV_RUNNING) {
926 dev_dbg(dev->dev, "fail, device is not running\n");
931 dev_dbg(dev->dev, "fail, gadget is not bound\n");
935 if (i < 0 || i >= dev->eps_num) {
936 dev_dbg(dev->dev, "fail, invalid endpoint\n");
940 if (dev->eps[i].state == STATE_EP_DISABLED) {
941 dev_dbg(&dev->gadget->dev, "fail, endpoint is not enabled\n");
945 if (dev->eps[i].disabling) {
946 dev_dbg(&dev->gadget->dev,
947 "fail, disable already in progress\n");
951 if (dev->eps[i].urb_queued) {
952 dev_dbg(&dev->gadget->dev,
953 "fail, waiting for urb completion\n");
957 dev->eps[i].disabling = true;
958 spin_unlock_irqrestore(&dev->lock, flags);
960 usb_ep_disable(dev->eps[i].ep);
962 spin_lock_irqsave(&dev->lock, flags);
963 usb_ep_free_request(dev->eps[i].ep, dev->eps[i].req);
964 kfree(dev->eps[i].ep->desc);
965 dev->eps[i].state = STATE_EP_DISABLED;
966 dev->eps[i].disabling = false;
969 spin_unlock_irqrestore(&dev->lock, flags);
973 static int raw_ioctl_ep_set_clear_halt_wedge(struct raw_dev *dev,
974 unsigned long value, bool set, bool halt)
976 int ret = 0, i = value;
979 spin_lock_irqsave(&dev->lock, flags);
980 if (dev->state != STATE_DEV_RUNNING) {
981 dev_dbg(dev->dev, "fail, device is not running\n");
986 dev_dbg(dev->dev, "fail, gadget is not bound\n");
990 if (i < 0 || i >= dev->eps_num) {
991 dev_dbg(dev->dev, "fail, invalid endpoint\n");
995 if (dev->eps[i].state == STATE_EP_DISABLED) {
996 dev_dbg(&dev->gadget->dev, "fail, endpoint is not enabled\n");
1000 if (dev->eps[i].disabling) {
1001 dev_dbg(&dev->gadget->dev,
1002 "fail, disable is in progress\n");
1006 if (dev->eps[i].urb_queued) {
1007 dev_dbg(&dev->gadget->dev,
1008 "fail, waiting for urb completion\n");
1012 if (usb_endpoint_xfer_isoc(dev->eps[i].ep->desc)) {
1013 dev_dbg(&dev->gadget->dev,
1014 "fail, can't halt/wedge ISO endpoint\n");
1020 ret = usb_ep_set_halt(dev->eps[i].ep);
1022 dev_err(&dev->gadget->dev,
1023 "fail, usb_ep_set_halt returned %d\n", ret);
1024 } else if (!set && halt) {
1025 ret = usb_ep_clear_halt(dev->eps[i].ep);
1027 dev_err(&dev->gadget->dev,
1028 "fail, usb_ep_clear_halt returned %d\n", ret);
1029 } else if (set && !halt) {
1030 ret = usb_ep_set_wedge(dev->eps[i].ep);
1032 dev_err(&dev->gadget->dev,
1033 "fail, usb_ep_set_wedge returned %d\n", ret);
1037 spin_unlock_irqrestore(&dev->lock, flags);
1041 static void gadget_ep_complete(struct usb_ep *ep, struct usb_request *req)
1043 struct raw_ep *r_ep = (struct raw_ep *)ep->driver_data;
1044 struct raw_dev *dev = r_ep->dev;
1045 unsigned long flags;
1047 spin_lock_irqsave(&dev->lock, flags);
1049 r_ep->status = req->status;
1051 r_ep->status = req->actual;
1052 spin_unlock_irqrestore(&dev->lock, flags);
1054 complete((struct completion *)req->context);
1057 static int raw_process_ep_io(struct raw_dev *dev, struct usb_raw_ep_io *io,
1058 void *data, bool in)
1061 unsigned long flags;
1063 DECLARE_COMPLETION_ONSTACK(done);
1065 spin_lock_irqsave(&dev->lock, flags);
1066 if (dev->state != STATE_DEV_RUNNING) {
1067 dev_dbg(dev->dev, "fail, device is not running\n");
1072 dev_dbg(dev->dev, "fail, gadget is not bound\n");
1076 if (io->ep >= dev->eps_num) {
1077 dev_dbg(&dev->gadget->dev, "fail, invalid endpoint\n");
1081 ep = &dev->eps[io->ep];
1082 if (ep->state != STATE_EP_ENABLED) {
1083 dev_dbg(&dev->gadget->dev, "fail, endpoint is not enabled\n");
1087 if (ep->disabling) {
1088 dev_dbg(&dev->gadget->dev,
1089 "fail, endpoint is already being disabled\n");
1093 if (ep->urb_queued) {
1094 dev_dbg(&dev->gadget->dev, "fail, urb already queued\n");
1098 if (in != usb_endpoint_dir_in(ep->ep->desc)) {
1099 dev_dbg(&dev->gadget->dev, "fail, wrong direction\n");
1105 ep->req->context = &done;
1106 ep->req->complete = gadget_ep_complete;
1107 ep->req->buf = data;
1108 ep->req->length = io->length;
1109 ep->req->zero = usb_raw_io_flags_zero(io->flags);
1110 ep->urb_queued = true;
1111 spin_unlock_irqrestore(&dev->lock, flags);
1113 ret = usb_ep_queue(ep->ep, ep->req, GFP_KERNEL);
1115 dev_err(&dev->gadget->dev,
1116 "fail, usb_ep_queue returned %d\n", ret);
1117 spin_lock_irqsave(&dev->lock, flags);
1118 goto out_queue_failed;
1121 ret = wait_for_completion_interruptible(&done);
1123 dev_dbg(&dev->gadget->dev, "wait interrupted\n");
1124 usb_ep_dequeue(ep->ep, ep->req);
1125 wait_for_completion(&done);
1126 spin_lock_irqsave(&dev->lock, flags);
1127 if (ep->status == -ECONNRESET)
1128 ep->status = -EINTR;
1129 goto out_interrupted;
1132 spin_lock_irqsave(&dev->lock, flags);
1137 ep->urb_queued = false;
1139 spin_unlock_irqrestore(&dev->lock, flags);
1143 static int raw_ioctl_ep_write(struct raw_dev *dev, unsigned long value)
1147 struct usb_raw_ep_io io;
1149 data = raw_alloc_io_data(&io, (void __user *)value, true);
1151 return PTR_ERR(data);
1152 ret = raw_process_ep_io(dev, &io, data, true);
1157 static int raw_ioctl_ep_read(struct raw_dev *dev, unsigned long value)
1161 struct usb_raw_ep_io io;
1162 unsigned int length;
1164 data = raw_alloc_io_data(&io, (void __user *)value, false);
1166 return PTR_ERR(data);
1167 ret = raw_process_ep_io(dev, &io, data, false);
1171 length = min(io.length, (unsigned int)ret);
1172 if (copy_to_user((void __user *)(value + sizeof(io)), data, length))
1181 static int raw_ioctl_configure(struct raw_dev *dev, unsigned long value)
1184 unsigned long flags;
1188 spin_lock_irqsave(&dev->lock, flags);
1189 if (dev->state != STATE_DEV_RUNNING) {
1190 dev_dbg(dev->dev, "fail, device is not running\n");
1195 dev_dbg(dev->dev, "fail, gadget is not bound\n");
1199 usb_gadget_set_state(dev->gadget, USB_STATE_CONFIGURED);
1202 spin_unlock_irqrestore(&dev->lock, flags);
1206 static int raw_ioctl_vbus_draw(struct raw_dev *dev, unsigned long value)
1209 unsigned long flags;
1211 spin_lock_irqsave(&dev->lock, flags);
1212 if (dev->state != STATE_DEV_RUNNING) {
1213 dev_dbg(dev->dev, "fail, device is not running\n");
1218 dev_dbg(dev->dev, "fail, gadget is not bound\n");
1222 usb_gadget_vbus_draw(dev->gadget, 2 * value);
1225 spin_unlock_irqrestore(&dev->lock, flags);
1229 static void fill_ep_caps(struct usb_ep_caps *caps,
1230 struct usb_raw_ep_caps *raw_caps)
1232 raw_caps->type_control = caps->type_control;
1233 raw_caps->type_iso = caps->type_iso;
1234 raw_caps->type_bulk = caps->type_bulk;
1235 raw_caps->type_int = caps->type_int;
1236 raw_caps->dir_in = caps->dir_in;
1237 raw_caps->dir_out = caps->dir_out;
1240 static void fill_ep_limits(struct usb_ep *ep, struct usb_raw_ep_limits *limits)
1242 limits->maxpacket_limit = ep->maxpacket_limit;
1243 limits->max_streams = ep->max_streams;
1246 static int raw_ioctl_eps_info(struct raw_dev *dev, unsigned long value)
1249 unsigned long flags;
1250 struct usb_raw_eps_info *info;
1253 info = kzalloc(sizeof(*info), GFP_KERNEL);
1259 spin_lock_irqsave(&dev->lock, flags);
1260 if (dev->state != STATE_DEV_RUNNING) {
1261 dev_dbg(dev->dev, "fail, device is not running\n");
1263 spin_unlock_irqrestore(&dev->lock, flags);
1267 dev_dbg(dev->dev, "fail, gadget is not bound\n");
1269 spin_unlock_irqrestore(&dev->lock, flags);
1273 for (i = 0; i < dev->eps_num; i++) {
1275 strscpy(&info->eps[i].name[0], ep->ep->name,
1276 USB_RAW_EP_NAME_MAX);
1277 info->eps[i].addr = ep->addr;
1278 fill_ep_caps(&ep->ep->caps, &info->eps[i].caps);
1279 fill_ep_limits(ep->ep, &info->eps[i].limits);
1282 spin_unlock_irqrestore(&dev->lock, flags);
1284 if (copy_to_user((void __user *)value, info, sizeof(*info)))
1293 static long raw_ioctl(struct file *fd, unsigned int cmd, unsigned long value)
1295 struct raw_dev *dev = fd->private_data;
1302 case USB_RAW_IOCTL_INIT:
1303 ret = raw_ioctl_init(dev, value);
1305 case USB_RAW_IOCTL_RUN:
1306 ret = raw_ioctl_run(dev, value);
1308 case USB_RAW_IOCTL_EVENT_FETCH:
1309 ret = raw_ioctl_event_fetch(dev, value);
1311 case USB_RAW_IOCTL_EP0_WRITE:
1312 ret = raw_ioctl_ep0_write(dev, value);
1314 case USB_RAW_IOCTL_EP0_READ:
1315 ret = raw_ioctl_ep0_read(dev, value);
1317 case USB_RAW_IOCTL_EP_ENABLE:
1318 ret = raw_ioctl_ep_enable(dev, value);
1320 case USB_RAW_IOCTL_EP_DISABLE:
1321 ret = raw_ioctl_ep_disable(dev, value);
1323 case USB_RAW_IOCTL_EP_WRITE:
1324 ret = raw_ioctl_ep_write(dev, value);
1326 case USB_RAW_IOCTL_EP_READ:
1327 ret = raw_ioctl_ep_read(dev, value);
1329 case USB_RAW_IOCTL_CONFIGURE:
1330 ret = raw_ioctl_configure(dev, value);
1332 case USB_RAW_IOCTL_VBUS_DRAW:
1333 ret = raw_ioctl_vbus_draw(dev, value);
1335 case USB_RAW_IOCTL_EPS_INFO:
1336 ret = raw_ioctl_eps_info(dev, value);
1338 case USB_RAW_IOCTL_EP0_STALL:
1339 ret = raw_ioctl_ep0_stall(dev, value);
1341 case USB_RAW_IOCTL_EP_SET_HALT:
1342 ret = raw_ioctl_ep_set_clear_halt_wedge(
1343 dev, value, true, true);
1345 case USB_RAW_IOCTL_EP_CLEAR_HALT:
1346 ret = raw_ioctl_ep_set_clear_halt_wedge(
1347 dev, value, false, true);
1349 case USB_RAW_IOCTL_EP_SET_WEDGE:
1350 ret = raw_ioctl_ep_set_clear_halt_wedge(
1351 dev, value, true, false);
1360 /*----------------------------------------------------------------------*/
1362 static const struct file_operations raw_fops = {
1364 .unlocked_ioctl = raw_ioctl,
1365 .compat_ioctl = raw_ioctl,
1366 .release = raw_release,
1367 .llseek = no_llseek,
1370 static struct miscdevice raw_misc_device = {
1371 .minor = MISC_DYNAMIC_MINOR,
1372 .name = DRIVER_NAME,
1376 module_misc_device(raw_misc_device);