Loading...
1// SPDX-License-Identifier: GPL-2.0+
2/*
3 * inode.c -- user mode filesystem api for usb gadget controllers
4 *
5 * Copyright (C) 2003-2004 David Brownell
6 * Copyright (C) 2003 Agilent Technologies
7 */
8
9
10/* #define VERBOSE_DEBUG */
11
12#include <linux/init.h>
13#include <linux/module.h>
14#include <linux/fs.h>
15#include <linux/fs_context.h>
16#include <linux/pagemap.h>
17#include <linux/uts.h>
18#include <linux/wait.h>
19#include <linux/compiler.h>
20#include <linux/uaccess.h>
21#include <linux/sched.h>
22#include <linux/slab.h>
23#include <linux/poll.h>
24#include <linux/kthread.h>
25#include <linux/aio.h>
26#include <linux/uio.h>
27#include <linux/refcount.h>
28#include <linux/delay.h>
29#include <linux/device.h>
30#include <linux/moduleparam.h>
31
32#include <linux/usb/gadgetfs.h>
33#include <linux/usb/gadget.h>
34#include <linux/usb/composite.h> /* for USB_GADGET_DELAYED_STATUS */
35
36/* Undef helpers from linux/usb/composite.h as gadgetfs redefines them */
37#undef DBG
38#undef ERROR
39#undef INFO
40
41
42/*
43 * The gadgetfs API maps each endpoint to a file descriptor so that you
44 * can use standard synchronous read/write calls for I/O. There's some
45 * O_NONBLOCK and O_ASYNC/FASYNC style i/o support. Example usermode
46 * drivers show how this works in practice. You can also use AIO to
47 * eliminate I/O gaps between requests, to help when streaming data.
48 *
49 * Key parts that must be USB-specific are protocols defining how the
50 * read/write operations relate to the hardware state machines. There
51 * are two types of files. One type is for the device, implementing ep0.
52 * The other type is for each IN or OUT endpoint. In both cases, the
53 * user mode driver must configure the hardware before using it.
54 *
55 * - First, dev_config() is called when /dev/gadget/$CHIP is configured
56 * (by writing configuration and device descriptors). Afterwards it
57 * may serve as a source of device events, used to handle all control
58 * requests other than basic enumeration.
59 *
60 * - Then, after a SET_CONFIGURATION control request, ep_config() is
61 * called when each /dev/gadget/ep* file is configured (by writing
62 * endpoint descriptors). Afterwards these files are used to write()
63 * IN data or to read() OUT data. To halt the endpoint, a "wrong
64 * direction" request is issued (like reading an IN endpoint).
65 *
66 * Unlike "usbfs" the only ioctl()s are for things that are rare, and maybe
67 * not possible on all hardware. For example, precise fault handling with
68 * respect to data left in endpoint fifos after aborted operations; or
69 * selective clearing of endpoint halts, to implement SET_INTERFACE.
70 */
71
72#define DRIVER_DESC "USB Gadget filesystem"
73#define DRIVER_VERSION "24 Aug 2004"
74
75static const char driver_desc [] = DRIVER_DESC;
76static const char shortname [] = "gadgetfs";
77
78MODULE_DESCRIPTION (DRIVER_DESC);
79MODULE_AUTHOR ("David Brownell");
80MODULE_LICENSE ("GPL");
81
82static int ep_open(struct inode *, struct file *);
83
84
85/*----------------------------------------------------------------------*/
86
87#define GADGETFS_MAGIC 0xaee71ee7
88
89/* /dev/gadget/$CHIP represents ep0 and the whole device */
90enum ep0_state {
91 /* DISABLED is the initial state. */
92 STATE_DEV_DISABLED = 0,
93
94 /* Only one open() of /dev/gadget/$CHIP; only one file tracks
95 * ep0/device i/o modes and binding to the controller. Driver
96 * must always write descriptors to initialize the device, then
97 * the device becomes UNCONNECTED until enumeration.
98 */
99 STATE_DEV_OPENED,
100
101 /* From then on, ep0 fd is in either of two basic modes:
102 * - (UN)CONNECTED: read usb_gadgetfs_event(s) from it
103 * - SETUP: read/write will transfer control data and succeed;
104 * or if "wrong direction", performs protocol stall
105 */
106 STATE_DEV_UNCONNECTED,
107 STATE_DEV_CONNECTED,
108 STATE_DEV_SETUP,
109
110 /* UNBOUND means the driver closed ep0, so the device won't be
111 * accessible again (DEV_DISABLED) until all fds are closed.
112 */
113 STATE_DEV_UNBOUND,
114};
115
116/* enough for the whole queue: most events invalidate others */
117#define N_EVENT 5
118
119#define RBUF_SIZE 256
120
121struct dev_data {
122 spinlock_t lock;
123 refcount_t count;
124 int udc_usage;
125 enum ep0_state state; /* P: lock */
126 struct usb_gadgetfs_event event [N_EVENT];
127 unsigned ev_next;
128 struct fasync_struct *fasync;
129 u8 current_config;
130
131 /* drivers reading ep0 MUST handle control requests (SETUP)
132 * reported that way; else the host will time out.
133 */
134 unsigned usermode_setup : 1,
135 setup_in : 1,
136 setup_can_stall : 1,
137 setup_out_ready : 1,
138 setup_out_error : 1,
139 setup_abort : 1,
140 gadget_registered : 1;
141 unsigned setup_wLength;
142
143 /* the rest is basically write-once */
144 struct usb_config_descriptor *config, *hs_config;
145 struct usb_device_descriptor *dev;
146 struct usb_request *req;
147 struct usb_gadget *gadget;
148 struct list_head epfiles;
149 void *buf;
150 wait_queue_head_t wait;
151 struct super_block *sb;
152 struct dentry *dentry;
153
154 /* except this scratch i/o buffer for ep0 */
155 u8 rbuf[RBUF_SIZE];
156};
157
158static inline void get_dev (struct dev_data *data)
159{
160 refcount_inc (&data->count);
161}
162
163static void put_dev (struct dev_data *data)
164{
165 if (likely (!refcount_dec_and_test (&data->count)))
166 return;
167 /* needs no more cleanup */
168 BUG_ON (waitqueue_active (&data->wait));
169 kfree (data);
170}
171
172static struct dev_data *dev_new (void)
173{
174 struct dev_data *dev;
175
176 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
177 if (!dev)
178 return NULL;
179 dev->state = STATE_DEV_DISABLED;
180 refcount_set (&dev->count, 1);
181 spin_lock_init (&dev->lock);
182 INIT_LIST_HEAD (&dev->epfiles);
183 init_waitqueue_head (&dev->wait);
184 return dev;
185}
186
187/*----------------------------------------------------------------------*/
188
189/* other /dev/gadget/$ENDPOINT files represent endpoints */
190enum ep_state {
191 STATE_EP_DISABLED = 0,
192 STATE_EP_READY,
193 STATE_EP_ENABLED,
194 STATE_EP_UNBOUND,
195};
196
197struct ep_data {
198 struct mutex lock;
199 enum ep_state state;
200 refcount_t count;
201 struct dev_data *dev;
202 /* must hold dev->lock before accessing ep or req */
203 struct usb_ep *ep;
204 struct usb_request *req;
205 ssize_t status;
206 char name [16];
207 struct usb_endpoint_descriptor desc, hs_desc;
208 struct list_head epfiles;
209 wait_queue_head_t wait;
210 struct dentry *dentry;
211};
212
213static inline void get_ep (struct ep_data *data)
214{
215 refcount_inc (&data->count);
216}
217
218static void put_ep (struct ep_data *data)
219{
220 if (likely (!refcount_dec_and_test (&data->count)))
221 return;
222 put_dev (data->dev);
223 /* needs no more cleanup */
224 BUG_ON (!list_empty (&data->epfiles));
225 BUG_ON (waitqueue_active (&data->wait));
226 kfree (data);
227}
228
229/*----------------------------------------------------------------------*/
230
231/* most "how to use the hardware" policy choices are in userspace:
232 * mapping endpoint roles (which the driver needs) to the capabilities
233 * which the usb controller has. most of those capabilities are exposed
234 * implicitly, starting with the driver name and then endpoint names.
235 */
236
237static const char *CHIP;
238static DEFINE_MUTEX(sb_mutex); /* Serialize superblock operations */
239
240/*----------------------------------------------------------------------*/
241
242/* NOTE: don't use dev_printk calls before binding to the gadget
243 * at the end of ep0 configuration, or after unbind.
244 */
245
246/* too wordy: dev_printk(level , &(d)->gadget->dev , fmt , ## args) */
247#define xprintk(d,level,fmt,args...) \
248 printk(level "%s: " fmt , shortname , ## args)
249
250#ifdef DEBUG
251#define DBG(dev,fmt,args...) \
252 xprintk(dev , KERN_DEBUG , fmt , ## args)
253#else
254#define DBG(dev,fmt,args...) \
255 do { } while (0)
256#endif /* DEBUG */
257
258#ifdef VERBOSE_DEBUG
259#define VDEBUG DBG
260#else
261#define VDEBUG(dev,fmt,args...) \
262 do { } while (0)
263#endif /* DEBUG */
264
265#define ERROR(dev,fmt,args...) \
266 xprintk(dev , KERN_ERR , fmt , ## args)
267#define INFO(dev,fmt,args...) \
268 xprintk(dev , KERN_INFO , fmt , ## args)
269
270
271/*----------------------------------------------------------------------*/
272
273/* SYNCHRONOUS ENDPOINT OPERATIONS (bulk/intr/iso)
274 *
275 * After opening, configure non-control endpoints. Then use normal
276 * stream read() and write() requests; and maybe ioctl() to get more
277 * precise FIFO status when recovering from cancellation.
278 */
279
280static void epio_complete (struct usb_ep *ep, struct usb_request *req)
281{
282 struct ep_data *epdata = ep->driver_data;
283
284 if (!req->context)
285 return;
286 if (req->status)
287 epdata->status = req->status;
288 else
289 epdata->status = req->actual;
290 complete ((struct completion *)req->context);
291}
292
293/* tasklock endpoint, returning when it's connected.
294 * still need dev->lock to use epdata->ep.
295 */
296static int
297get_ready_ep (unsigned f_flags, struct ep_data *epdata, bool is_write)
298{
299 int val;
300
301 if (f_flags & O_NONBLOCK) {
302 if (!mutex_trylock(&epdata->lock))
303 goto nonblock;
304 if (epdata->state != STATE_EP_ENABLED &&
305 (!is_write || epdata->state != STATE_EP_READY)) {
306 mutex_unlock(&epdata->lock);
307nonblock:
308 val = -EAGAIN;
309 } else
310 val = 0;
311 return val;
312 }
313
314 val = mutex_lock_interruptible(&epdata->lock);
315 if (val < 0)
316 return val;
317
318 switch (epdata->state) {
319 case STATE_EP_ENABLED:
320 return 0;
321 case STATE_EP_READY: /* not configured yet */
322 if (is_write)
323 return 0;
324 fallthrough;
325 case STATE_EP_UNBOUND: /* clean disconnect */
326 break;
327 // case STATE_EP_DISABLED: /* "can't happen" */
328 default: /* error! */
329 pr_debug ("%s: ep %p not available, state %d\n",
330 shortname, epdata, epdata->state);
331 }
332 mutex_unlock(&epdata->lock);
333 return -ENODEV;
334}
335
336static ssize_t
337ep_io (struct ep_data *epdata, void *buf, unsigned len)
338{
339 DECLARE_COMPLETION_ONSTACK (done);
340 int value;
341
342 spin_lock_irq (&epdata->dev->lock);
343 if (likely (epdata->ep != NULL)) {
344 struct usb_request *req = epdata->req;
345
346 req->context = &done;
347 req->complete = epio_complete;
348 req->buf = buf;
349 req->length = len;
350 value = usb_ep_queue (epdata->ep, req, GFP_ATOMIC);
351 } else
352 value = -ENODEV;
353 spin_unlock_irq (&epdata->dev->lock);
354
355 if (likely (value == 0)) {
356 value = wait_for_completion_interruptible(&done);
357 if (value != 0) {
358 spin_lock_irq (&epdata->dev->lock);
359 if (likely (epdata->ep != NULL)) {
360 DBG (epdata->dev, "%s i/o interrupted\n",
361 epdata->name);
362 usb_ep_dequeue (epdata->ep, epdata->req);
363 spin_unlock_irq (&epdata->dev->lock);
364
365 wait_for_completion(&done);
366 if (epdata->status == -ECONNRESET)
367 epdata->status = -EINTR;
368 } else {
369 spin_unlock_irq (&epdata->dev->lock);
370
371 DBG (epdata->dev, "endpoint gone\n");
372 wait_for_completion(&done);
373 epdata->status = -ENODEV;
374 }
375 }
376 return epdata->status;
377 }
378 return value;
379}
380
381static int
382ep_release (struct inode *inode, struct file *fd)
383{
384 struct ep_data *data = fd->private_data;
385 int value;
386
387 value = mutex_lock_interruptible(&data->lock);
388 if (value < 0)
389 return value;
390
391 /* clean up if this can be reopened */
392 if (data->state != STATE_EP_UNBOUND) {
393 data->state = STATE_EP_DISABLED;
394 data->desc.bDescriptorType = 0;
395 data->hs_desc.bDescriptorType = 0;
396 usb_ep_disable(data->ep);
397 }
398 mutex_unlock(&data->lock);
399 put_ep (data);
400 return 0;
401}
402
403static long ep_ioctl(struct file *fd, unsigned code, unsigned long value)
404{
405 struct ep_data *data = fd->private_data;
406 int status;
407
408 if ((status = get_ready_ep (fd->f_flags, data, false)) < 0)
409 return status;
410
411 spin_lock_irq (&data->dev->lock);
412 if (likely (data->ep != NULL)) {
413 switch (code) {
414 case GADGETFS_FIFO_STATUS:
415 status = usb_ep_fifo_status (data->ep);
416 break;
417 case GADGETFS_FIFO_FLUSH:
418 usb_ep_fifo_flush (data->ep);
419 break;
420 case GADGETFS_CLEAR_HALT:
421 status = usb_ep_clear_halt (data->ep);
422 break;
423 default:
424 status = -ENOTTY;
425 }
426 } else
427 status = -ENODEV;
428 spin_unlock_irq (&data->dev->lock);
429 mutex_unlock(&data->lock);
430 return status;
431}
432
433/*----------------------------------------------------------------------*/
434
435/* ASYNCHRONOUS ENDPOINT I/O OPERATIONS (bulk/intr/iso) */
436
437struct kiocb_priv {
438 struct usb_request *req;
439 struct ep_data *epdata;
440 struct kiocb *iocb;
441 struct mm_struct *mm;
442 struct work_struct work;
443 void *buf;
444 struct iov_iter to;
445 const void *to_free;
446 unsigned actual;
447};
448
449static int ep_aio_cancel(struct kiocb *iocb)
450{
451 struct kiocb_priv *priv = iocb->private;
452 struct ep_data *epdata;
453 int value;
454
455 local_irq_disable();
456 epdata = priv->epdata;
457 // spin_lock(&epdata->dev->lock);
458 if (likely(epdata && epdata->ep && priv->req))
459 value = usb_ep_dequeue (epdata->ep, priv->req);
460 else
461 value = -EINVAL;
462 // spin_unlock(&epdata->dev->lock);
463 local_irq_enable();
464
465 return value;
466}
467
468static void ep_user_copy_worker(struct work_struct *work)
469{
470 struct kiocb_priv *priv = container_of(work, struct kiocb_priv, work);
471 struct mm_struct *mm = priv->mm;
472 struct kiocb *iocb = priv->iocb;
473 size_t ret;
474
475 kthread_use_mm(mm);
476 ret = copy_to_iter(priv->buf, priv->actual, &priv->to);
477 kthread_unuse_mm(mm);
478 if (!ret)
479 ret = -EFAULT;
480
481 /* completing the iocb can drop the ctx and mm, don't touch mm after */
482 iocb->ki_complete(iocb, ret);
483
484 kfree(priv->buf);
485 kfree(priv->to_free);
486 kfree(priv);
487}
488
489static void ep_aio_complete(struct usb_ep *ep, struct usb_request *req)
490{
491 struct kiocb *iocb = req->context;
492 struct kiocb_priv *priv = iocb->private;
493 struct ep_data *epdata = priv->epdata;
494
495 /* lock against disconnect (and ideally, cancel) */
496 spin_lock(&epdata->dev->lock);
497 priv->req = NULL;
498 priv->epdata = NULL;
499
500 /* if this was a write or a read returning no data then we
501 * don't need to copy anything to userspace, so we can
502 * complete the aio request immediately.
503 */
504 if (priv->to_free == NULL || unlikely(req->actual == 0)) {
505 kfree(req->buf);
506 kfree(priv->to_free);
507 kfree(priv);
508 iocb->private = NULL;
509 iocb->ki_complete(iocb,
510 req->actual ? req->actual : (long)req->status);
511 } else {
512 /* ep_copy_to_user() won't report both; we hide some faults */
513 if (unlikely(0 != req->status))
514 DBG(epdata->dev, "%s fault %d len %d\n",
515 ep->name, req->status, req->actual);
516
517 priv->buf = req->buf;
518 priv->actual = req->actual;
519 INIT_WORK(&priv->work, ep_user_copy_worker);
520 schedule_work(&priv->work);
521 }
522
523 usb_ep_free_request(ep, req);
524 spin_unlock(&epdata->dev->lock);
525 put_ep(epdata);
526}
527
528static ssize_t ep_aio(struct kiocb *iocb,
529 struct kiocb_priv *priv,
530 struct ep_data *epdata,
531 char *buf,
532 size_t len)
533{
534 struct usb_request *req;
535 ssize_t value;
536
537 iocb->private = priv;
538 priv->iocb = iocb;
539
540 kiocb_set_cancel_fn(iocb, ep_aio_cancel);
541 get_ep(epdata);
542 priv->epdata = epdata;
543 priv->actual = 0;
544 priv->mm = current->mm; /* mm teardown waits for iocbs in exit_aio() */
545
546 /* each kiocb is coupled to one usb_request, but we can't
547 * allocate or submit those if the host disconnected.
548 */
549 spin_lock_irq(&epdata->dev->lock);
550 value = -ENODEV;
551 if (unlikely(epdata->ep == NULL))
552 goto fail;
553
554 req = usb_ep_alloc_request(epdata->ep, GFP_ATOMIC);
555 value = -ENOMEM;
556 if (unlikely(!req))
557 goto fail;
558
559 priv->req = req;
560 req->buf = buf;
561 req->length = len;
562 req->complete = ep_aio_complete;
563 req->context = iocb;
564 value = usb_ep_queue(epdata->ep, req, GFP_ATOMIC);
565 if (unlikely(0 != value)) {
566 usb_ep_free_request(epdata->ep, req);
567 goto fail;
568 }
569 spin_unlock_irq(&epdata->dev->lock);
570 return -EIOCBQUEUED;
571
572fail:
573 spin_unlock_irq(&epdata->dev->lock);
574 kfree(priv->to_free);
575 kfree(priv);
576 put_ep(epdata);
577 return value;
578}
579
580static ssize_t
581ep_read_iter(struct kiocb *iocb, struct iov_iter *to)
582{
583 struct file *file = iocb->ki_filp;
584 struct ep_data *epdata = file->private_data;
585 size_t len = iov_iter_count(to);
586 ssize_t value;
587 char *buf;
588
589 if ((value = get_ready_ep(file->f_flags, epdata, false)) < 0)
590 return value;
591
592 /* halt any endpoint by doing a "wrong direction" i/o call */
593 if (usb_endpoint_dir_in(&epdata->desc)) {
594 if (usb_endpoint_xfer_isoc(&epdata->desc) ||
595 !is_sync_kiocb(iocb)) {
596 mutex_unlock(&epdata->lock);
597 return -EINVAL;
598 }
599 DBG (epdata->dev, "%s halt\n", epdata->name);
600 spin_lock_irq(&epdata->dev->lock);
601 if (likely(epdata->ep != NULL))
602 usb_ep_set_halt(epdata->ep);
603 spin_unlock_irq(&epdata->dev->lock);
604 mutex_unlock(&epdata->lock);
605 return -EBADMSG;
606 }
607
608 buf = kmalloc(len, GFP_KERNEL);
609 if (unlikely(!buf)) {
610 mutex_unlock(&epdata->lock);
611 return -ENOMEM;
612 }
613 if (is_sync_kiocb(iocb)) {
614 value = ep_io(epdata, buf, len);
615 if (value >= 0 && (copy_to_iter(buf, value, to) != value))
616 value = -EFAULT;
617 } else {
618 struct kiocb_priv *priv = kzalloc(sizeof *priv, GFP_KERNEL);
619 value = -ENOMEM;
620 if (!priv)
621 goto fail;
622 priv->to_free = dup_iter(&priv->to, to, GFP_KERNEL);
623 if (!iter_is_ubuf(&priv->to) && !priv->to_free) {
624 kfree(priv);
625 goto fail;
626 }
627 value = ep_aio(iocb, priv, epdata, buf, len);
628 if (value == -EIOCBQUEUED)
629 buf = NULL;
630 }
631fail:
632 kfree(buf);
633 mutex_unlock(&epdata->lock);
634 return value;
635}
636
637static ssize_t ep_config(struct ep_data *, const char *, size_t);
638
639static ssize_t
640ep_write_iter(struct kiocb *iocb, struct iov_iter *from)
641{
642 struct file *file = iocb->ki_filp;
643 struct ep_data *epdata = file->private_data;
644 size_t len = iov_iter_count(from);
645 bool configured;
646 ssize_t value;
647 char *buf;
648
649 if ((value = get_ready_ep(file->f_flags, epdata, true)) < 0)
650 return value;
651
652 configured = epdata->state == STATE_EP_ENABLED;
653
654 /* halt any endpoint by doing a "wrong direction" i/o call */
655 if (configured && !usb_endpoint_dir_in(&epdata->desc)) {
656 if (usb_endpoint_xfer_isoc(&epdata->desc) ||
657 !is_sync_kiocb(iocb)) {
658 mutex_unlock(&epdata->lock);
659 return -EINVAL;
660 }
661 DBG (epdata->dev, "%s halt\n", epdata->name);
662 spin_lock_irq(&epdata->dev->lock);
663 if (likely(epdata->ep != NULL))
664 usb_ep_set_halt(epdata->ep);
665 spin_unlock_irq(&epdata->dev->lock);
666 mutex_unlock(&epdata->lock);
667 return -EBADMSG;
668 }
669
670 buf = kmalloc(len, GFP_KERNEL);
671 if (unlikely(!buf)) {
672 mutex_unlock(&epdata->lock);
673 return -ENOMEM;
674 }
675
676 if (unlikely(!copy_from_iter_full(buf, len, from))) {
677 value = -EFAULT;
678 goto out;
679 }
680
681 if (unlikely(!configured)) {
682 value = ep_config(epdata, buf, len);
683 } else if (is_sync_kiocb(iocb)) {
684 value = ep_io(epdata, buf, len);
685 } else {
686 struct kiocb_priv *priv = kzalloc(sizeof *priv, GFP_KERNEL);
687 value = -ENOMEM;
688 if (priv) {
689 value = ep_aio(iocb, priv, epdata, buf, len);
690 if (value == -EIOCBQUEUED)
691 buf = NULL;
692 }
693 }
694out:
695 kfree(buf);
696 mutex_unlock(&epdata->lock);
697 return value;
698}
699
700/*----------------------------------------------------------------------*/
701
702/* used after endpoint configuration */
703static const struct file_operations ep_io_operations = {
704 .owner = THIS_MODULE,
705
706 .open = ep_open,
707 .release = ep_release,
708 .llseek = no_llseek,
709 .unlocked_ioctl = ep_ioctl,
710 .read_iter = ep_read_iter,
711 .write_iter = ep_write_iter,
712};
713
714/* ENDPOINT INITIALIZATION
715 *
716 * fd = open ("/dev/gadget/$ENDPOINT", O_RDWR)
717 * status = write (fd, descriptors, sizeof descriptors)
718 *
719 * That write establishes the endpoint configuration, configuring
720 * the controller to process bulk, interrupt, or isochronous transfers
721 * at the right maxpacket size, and so on.
722 *
723 * The descriptors are message type 1, identified by a host order u32
724 * at the beginning of what's written. Descriptor order is: full/low
725 * speed descriptor, then optional high speed descriptor.
726 */
727static ssize_t
728ep_config (struct ep_data *data, const char *buf, size_t len)
729{
730 struct usb_ep *ep;
731 u32 tag;
732 int value, length = len;
733
734 if (data->state != STATE_EP_READY) {
735 value = -EL2HLT;
736 goto fail;
737 }
738
739 value = len;
740 if (len < USB_DT_ENDPOINT_SIZE + 4)
741 goto fail0;
742
743 /* we might need to change message format someday */
744 memcpy(&tag, buf, 4);
745 if (tag != 1) {
746 DBG(data->dev, "config %s, bad tag %d\n", data->name, tag);
747 goto fail0;
748 }
749 buf += 4;
750 len -= 4;
751
752 /* NOTE: audio endpoint extensions not accepted here;
753 * just don't include the extra bytes.
754 */
755
756 /* full/low speed descriptor, then high speed */
757 memcpy(&data->desc, buf, USB_DT_ENDPOINT_SIZE);
758 if (data->desc.bLength != USB_DT_ENDPOINT_SIZE
759 || data->desc.bDescriptorType != USB_DT_ENDPOINT)
760 goto fail0;
761 if (len != USB_DT_ENDPOINT_SIZE) {
762 if (len != 2 * USB_DT_ENDPOINT_SIZE)
763 goto fail0;
764 memcpy(&data->hs_desc, buf + USB_DT_ENDPOINT_SIZE,
765 USB_DT_ENDPOINT_SIZE);
766 if (data->hs_desc.bLength != USB_DT_ENDPOINT_SIZE
767 || data->hs_desc.bDescriptorType
768 != USB_DT_ENDPOINT) {
769 DBG(data->dev, "config %s, bad hs length or type\n",
770 data->name);
771 goto fail0;
772 }
773 }
774
775 spin_lock_irq (&data->dev->lock);
776 if (data->dev->state == STATE_DEV_UNBOUND) {
777 value = -ENOENT;
778 goto gone;
779 } else {
780 ep = data->ep;
781 if (ep == NULL) {
782 value = -ENODEV;
783 goto gone;
784 }
785 }
786 switch (data->dev->gadget->speed) {
787 case USB_SPEED_LOW:
788 case USB_SPEED_FULL:
789 ep->desc = &data->desc;
790 break;
791 case USB_SPEED_HIGH:
792 /* fails if caller didn't provide that descriptor... */
793 ep->desc = &data->hs_desc;
794 break;
795 default:
796 DBG(data->dev, "unconnected, %s init abandoned\n",
797 data->name);
798 value = -EINVAL;
799 goto gone;
800 }
801 value = usb_ep_enable(ep);
802 if (value == 0) {
803 data->state = STATE_EP_ENABLED;
804 value = length;
805 }
806gone:
807 spin_unlock_irq (&data->dev->lock);
808 if (value < 0) {
809fail:
810 data->desc.bDescriptorType = 0;
811 data->hs_desc.bDescriptorType = 0;
812 }
813 return value;
814fail0:
815 value = -EINVAL;
816 goto fail;
817}
818
819static int
820ep_open (struct inode *inode, struct file *fd)
821{
822 struct ep_data *data = inode->i_private;
823 int value = -EBUSY;
824
825 if (mutex_lock_interruptible(&data->lock) != 0)
826 return -EINTR;
827 spin_lock_irq (&data->dev->lock);
828 if (data->dev->state == STATE_DEV_UNBOUND)
829 value = -ENOENT;
830 else if (data->state == STATE_EP_DISABLED) {
831 value = 0;
832 data->state = STATE_EP_READY;
833 get_ep (data);
834 fd->private_data = data;
835 VDEBUG (data->dev, "%s ready\n", data->name);
836 } else
837 DBG (data->dev, "%s state %d\n",
838 data->name, data->state);
839 spin_unlock_irq (&data->dev->lock);
840 mutex_unlock(&data->lock);
841 return value;
842}
843
844/*----------------------------------------------------------------------*/
845
846/* EP0 IMPLEMENTATION can be partly in userspace.
847 *
848 * Drivers that use this facility receive various events, including
849 * control requests the kernel doesn't handle. Drivers that don't
850 * use this facility may be too simple-minded for real applications.
851 */
852
853static inline void ep0_readable (struct dev_data *dev)
854{
855 wake_up (&dev->wait);
856 kill_fasync (&dev->fasync, SIGIO, POLL_IN);
857}
858
859static void clean_req (struct usb_ep *ep, struct usb_request *req)
860{
861 struct dev_data *dev = ep->driver_data;
862
863 if (req->buf != dev->rbuf) {
864 kfree(req->buf);
865 req->buf = dev->rbuf;
866 }
867 req->complete = epio_complete;
868 dev->setup_out_ready = 0;
869}
870
871static void ep0_complete (struct usb_ep *ep, struct usb_request *req)
872{
873 struct dev_data *dev = ep->driver_data;
874 unsigned long flags;
875 int free = 1;
876
877 /* for control OUT, data must still get to userspace */
878 spin_lock_irqsave(&dev->lock, flags);
879 if (!dev->setup_in) {
880 dev->setup_out_error = (req->status != 0);
881 if (!dev->setup_out_error)
882 free = 0;
883 dev->setup_out_ready = 1;
884 ep0_readable (dev);
885 }
886
887 /* clean up as appropriate */
888 if (free && req->buf != &dev->rbuf)
889 clean_req (ep, req);
890 req->complete = epio_complete;
891 spin_unlock_irqrestore(&dev->lock, flags);
892}
893
894static int setup_req (struct usb_ep *ep, struct usb_request *req, u16 len)
895{
896 struct dev_data *dev = ep->driver_data;
897
898 if (dev->setup_out_ready) {
899 DBG (dev, "ep0 request busy!\n");
900 return -EBUSY;
901 }
902 if (len > sizeof (dev->rbuf))
903 req->buf = kmalloc(len, GFP_ATOMIC);
904 if (req->buf == NULL) {
905 req->buf = dev->rbuf;
906 return -ENOMEM;
907 }
908 req->complete = ep0_complete;
909 req->length = len;
910 req->zero = 0;
911 return 0;
912}
913
914static ssize_t
915ep0_read (struct file *fd, char __user *buf, size_t len, loff_t *ptr)
916{
917 struct dev_data *dev = fd->private_data;
918 ssize_t retval;
919 enum ep0_state state;
920
921 spin_lock_irq (&dev->lock);
922 if (dev->state <= STATE_DEV_OPENED) {
923 retval = -EINVAL;
924 goto done;
925 }
926
927 /* report fd mode change before acting on it */
928 if (dev->setup_abort) {
929 dev->setup_abort = 0;
930 retval = -EIDRM;
931 goto done;
932 }
933
934 /* control DATA stage */
935 if ((state = dev->state) == STATE_DEV_SETUP) {
936
937 if (dev->setup_in) { /* stall IN */
938 VDEBUG(dev, "ep0in stall\n");
939 (void) usb_ep_set_halt (dev->gadget->ep0);
940 retval = -EL2HLT;
941 dev->state = STATE_DEV_CONNECTED;
942
943 } else if (len == 0) { /* ack SET_CONFIGURATION etc */
944 struct usb_ep *ep = dev->gadget->ep0;
945 struct usb_request *req = dev->req;
946
947 if ((retval = setup_req (ep, req, 0)) == 0) {
948 ++dev->udc_usage;
949 spin_unlock_irq (&dev->lock);
950 retval = usb_ep_queue (ep, req, GFP_KERNEL);
951 spin_lock_irq (&dev->lock);
952 --dev->udc_usage;
953 }
954 dev->state = STATE_DEV_CONNECTED;
955
956 /* assume that was SET_CONFIGURATION */
957 if (dev->current_config) {
958 unsigned power;
959
960 if (gadget_is_dualspeed(dev->gadget)
961 && (dev->gadget->speed
962 == USB_SPEED_HIGH))
963 power = dev->hs_config->bMaxPower;
964 else
965 power = dev->config->bMaxPower;
966 usb_gadget_vbus_draw(dev->gadget, 2 * power);
967 }
968
969 } else { /* collect OUT data */
970 if ((fd->f_flags & O_NONBLOCK) != 0
971 && !dev->setup_out_ready) {
972 retval = -EAGAIN;
973 goto done;
974 }
975 spin_unlock_irq (&dev->lock);
976 retval = wait_event_interruptible (dev->wait,
977 dev->setup_out_ready != 0);
978
979 /* FIXME state could change from under us */
980 spin_lock_irq (&dev->lock);
981 if (retval)
982 goto done;
983
984 if (dev->state != STATE_DEV_SETUP) {
985 retval = -ECANCELED;
986 goto done;
987 }
988 dev->state = STATE_DEV_CONNECTED;
989
990 if (dev->setup_out_error)
991 retval = -EIO;
992 else {
993 len = min (len, (size_t)dev->req->actual);
994 ++dev->udc_usage;
995 spin_unlock_irq(&dev->lock);
996 if (copy_to_user (buf, dev->req->buf, len))
997 retval = -EFAULT;
998 else
999 retval = len;
1000 spin_lock_irq(&dev->lock);
1001 --dev->udc_usage;
1002 clean_req (dev->gadget->ep0, dev->req);
1003 /* NOTE userspace can't yet choose to stall */
1004 }
1005 }
1006 goto done;
1007 }
1008
1009 /* else normal: return event data */
1010 if (len < sizeof dev->event [0]) {
1011 retval = -EINVAL;
1012 goto done;
1013 }
1014 len -= len % sizeof (struct usb_gadgetfs_event);
1015 dev->usermode_setup = 1;
1016
1017scan:
1018 /* return queued events right away */
1019 if (dev->ev_next != 0) {
1020 unsigned i, n;
1021
1022 n = len / sizeof (struct usb_gadgetfs_event);
1023 if (dev->ev_next < n)
1024 n = dev->ev_next;
1025
1026 /* ep0 i/o has special semantics during STATE_DEV_SETUP */
1027 for (i = 0; i < n; i++) {
1028 if (dev->event [i].type == GADGETFS_SETUP) {
1029 dev->state = STATE_DEV_SETUP;
1030 n = i + 1;
1031 break;
1032 }
1033 }
1034 spin_unlock_irq (&dev->lock);
1035 len = n * sizeof (struct usb_gadgetfs_event);
1036 if (copy_to_user (buf, &dev->event, len))
1037 retval = -EFAULT;
1038 else
1039 retval = len;
1040 if (len > 0) {
1041 /* NOTE this doesn't guard against broken drivers;
1042 * concurrent ep0 readers may lose events.
1043 */
1044 spin_lock_irq (&dev->lock);
1045 if (dev->ev_next > n) {
1046 memmove(&dev->event[0], &dev->event[n],
1047 sizeof (struct usb_gadgetfs_event)
1048 * (dev->ev_next - n));
1049 }
1050 dev->ev_next -= n;
1051 spin_unlock_irq (&dev->lock);
1052 }
1053 return retval;
1054 }
1055 if (fd->f_flags & O_NONBLOCK) {
1056 retval = -EAGAIN;
1057 goto done;
1058 }
1059
1060 switch (state) {
1061 default:
1062 DBG (dev, "fail %s, state %d\n", __func__, state);
1063 retval = -ESRCH;
1064 break;
1065 case STATE_DEV_UNCONNECTED:
1066 case STATE_DEV_CONNECTED:
1067 spin_unlock_irq (&dev->lock);
1068 DBG (dev, "%s wait\n", __func__);
1069
1070 /* wait for events */
1071 retval = wait_event_interruptible (dev->wait,
1072 dev->ev_next != 0);
1073 if (retval < 0)
1074 return retval;
1075 spin_lock_irq (&dev->lock);
1076 goto scan;
1077 }
1078
1079done:
1080 spin_unlock_irq (&dev->lock);
1081 return retval;
1082}
1083
1084static struct usb_gadgetfs_event *
1085next_event (struct dev_data *dev, enum usb_gadgetfs_event_type type)
1086{
1087 struct usb_gadgetfs_event *event;
1088 unsigned i;
1089
1090 switch (type) {
1091 /* these events purge the queue */
1092 case GADGETFS_DISCONNECT:
1093 if (dev->state == STATE_DEV_SETUP)
1094 dev->setup_abort = 1;
1095 fallthrough;
1096 case GADGETFS_CONNECT:
1097 dev->ev_next = 0;
1098 break;
1099 case GADGETFS_SETUP: /* previous request timed out */
1100 case GADGETFS_SUSPEND: /* same effect */
1101 /* these events can't be repeated */
1102 for (i = 0; i != dev->ev_next; i++) {
1103 if (dev->event [i].type != type)
1104 continue;
1105 DBG(dev, "discard old event[%d] %d\n", i, type);
1106 dev->ev_next--;
1107 if (i == dev->ev_next)
1108 break;
1109 /* indices start at zero, for simplicity */
1110 memmove (&dev->event [i], &dev->event [i + 1],
1111 sizeof (struct usb_gadgetfs_event)
1112 * (dev->ev_next - i));
1113 }
1114 break;
1115 default:
1116 BUG ();
1117 }
1118 VDEBUG(dev, "event[%d] = %d\n", dev->ev_next, type);
1119 event = &dev->event [dev->ev_next++];
1120 BUG_ON (dev->ev_next > N_EVENT);
1121 memset (event, 0, sizeof *event);
1122 event->type = type;
1123 return event;
1124}
1125
1126static ssize_t
1127ep0_write (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
1128{
1129 struct dev_data *dev = fd->private_data;
1130 ssize_t retval = -ESRCH;
1131
1132 /* report fd mode change before acting on it */
1133 if (dev->setup_abort) {
1134 dev->setup_abort = 0;
1135 retval = -EIDRM;
1136
1137 /* data and/or status stage for control request */
1138 } else if (dev->state == STATE_DEV_SETUP) {
1139
1140 len = min_t(size_t, len, dev->setup_wLength);
1141 if (dev->setup_in) {
1142 retval = setup_req (dev->gadget->ep0, dev->req, len);
1143 if (retval == 0) {
1144 dev->state = STATE_DEV_CONNECTED;
1145 ++dev->udc_usage;
1146 spin_unlock_irq (&dev->lock);
1147 if (copy_from_user (dev->req->buf, buf, len))
1148 retval = -EFAULT;
1149 else {
1150 if (len < dev->setup_wLength)
1151 dev->req->zero = 1;
1152 retval = usb_ep_queue (
1153 dev->gadget->ep0, dev->req,
1154 GFP_KERNEL);
1155 }
1156 spin_lock_irq(&dev->lock);
1157 --dev->udc_usage;
1158 if (retval < 0) {
1159 clean_req (dev->gadget->ep0, dev->req);
1160 } else
1161 retval = len;
1162
1163 return retval;
1164 }
1165
1166 /* can stall some OUT transfers */
1167 } else if (dev->setup_can_stall) {
1168 VDEBUG(dev, "ep0out stall\n");
1169 (void) usb_ep_set_halt (dev->gadget->ep0);
1170 retval = -EL2HLT;
1171 dev->state = STATE_DEV_CONNECTED;
1172 } else {
1173 DBG(dev, "bogus ep0out stall!\n");
1174 }
1175 } else
1176 DBG (dev, "fail %s, state %d\n", __func__, dev->state);
1177
1178 return retval;
1179}
1180
1181static int
1182ep0_fasync (int f, struct file *fd, int on)
1183{
1184 struct dev_data *dev = fd->private_data;
1185 // caller must F_SETOWN before signal delivery happens
1186 VDEBUG (dev, "%s %s\n", __func__, on ? "on" : "off");
1187 return fasync_helper (f, fd, on, &dev->fasync);
1188}
1189
1190static struct usb_gadget_driver gadgetfs_driver;
1191
1192static int
1193dev_release (struct inode *inode, struct file *fd)
1194{
1195 struct dev_data *dev = fd->private_data;
1196
1197 /* closing ep0 === shutdown all */
1198
1199 if (dev->gadget_registered) {
1200 usb_gadget_unregister_driver (&gadgetfs_driver);
1201 dev->gadget_registered = false;
1202 }
1203
1204 /* at this point "good" hardware has disconnected the
1205 * device from USB; the host won't see it any more.
1206 * alternatively, all host requests will time out.
1207 */
1208
1209 kfree (dev->buf);
1210 dev->buf = NULL;
1211
1212 /* other endpoints were all decoupled from this device */
1213 spin_lock_irq(&dev->lock);
1214 dev->state = STATE_DEV_DISABLED;
1215 spin_unlock_irq(&dev->lock);
1216
1217 put_dev (dev);
1218 return 0;
1219}
1220
1221static __poll_t
1222ep0_poll (struct file *fd, poll_table *wait)
1223{
1224 struct dev_data *dev = fd->private_data;
1225 __poll_t mask = 0;
1226
1227 if (dev->state <= STATE_DEV_OPENED)
1228 return DEFAULT_POLLMASK;
1229
1230 poll_wait(fd, &dev->wait, wait);
1231
1232 spin_lock_irq(&dev->lock);
1233
1234 /* report fd mode change before acting on it */
1235 if (dev->setup_abort) {
1236 dev->setup_abort = 0;
1237 mask = EPOLLHUP;
1238 goto out;
1239 }
1240
1241 if (dev->state == STATE_DEV_SETUP) {
1242 if (dev->setup_in || dev->setup_can_stall)
1243 mask = EPOLLOUT;
1244 } else {
1245 if (dev->ev_next != 0)
1246 mask = EPOLLIN;
1247 }
1248out:
1249 spin_unlock_irq(&dev->lock);
1250 return mask;
1251}
1252
1253static long gadget_dev_ioctl (struct file *fd, unsigned code, unsigned long value)
1254{
1255 struct dev_data *dev = fd->private_data;
1256 struct usb_gadget *gadget = dev->gadget;
1257 long ret = -ENOTTY;
1258
1259 spin_lock_irq(&dev->lock);
1260 if (dev->state == STATE_DEV_OPENED ||
1261 dev->state == STATE_DEV_UNBOUND) {
1262 /* Not bound to a UDC */
1263 } else if (gadget->ops->ioctl) {
1264 ++dev->udc_usage;
1265 spin_unlock_irq(&dev->lock);
1266
1267 ret = gadget->ops->ioctl (gadget, code, value);
1268
1269 spin_lock_irq(&dev->lock);
1270 --dev->udc_usage;
1271 }
1272 spin_unlock_irq(&dev->lock);
1273
1274 return ret;
1275}
1276
1277/*----------------------------------------------------------------------*/
1278
1279/* The in-kernel gadget driver handles most ep0 issues, in particular
1280 * enumerating the single configuration (as provided from user space).
1281 *
1282 * Unrecognized ep0 requests may be handled in user space.
1283 */
1284
1285static void make_qualifier (struct dev_data *dev)
1286{
1287 struct usb_qualifier_descriptor qual;
1288 struct usb_device_descriptor *desc;
1289
1290 qual.bLength = sizeof qual;
1291 qual.bDescriptorType = USB_DT_DEVICE_QUALIFIER;
1292 qual.bcdUSB = cpu_to_le16 (0x0200);
1293
1294 desc = dev->dev;
1295 qual.bDeviceClass = desc->bDeviceClass;
1296 qual.bDeviceSubClass = desc->bDeviceSubClass;
1297 qual.bDeviceProtocol = desc->bDeviceProtocol;
1298
1299 /* assumes ep0 uses the same value for both speeds ... */
1300 qual.bMaxPacketSize0 = dev->gadget->ep0->maxpacket;
1301
1302 qual.bNumConfigurations = 1;
1303 qual.bRESERVED = 0;
1304
1305 memcpy (dev->rbuf, &qual, sizeof qual);
1306}
1307
1308static int
1309config_buf (struct dev_data *dev, u8 type, unsigned index)
1310{
1311 int len;
1312 int hs = 0;
1313
1314 /* only one configuration */
1315 if (index > 0)
1316 return -EINVAL;
1317
1318 if (gadget_is_dualspeed(dev->gadget)) {
1319 hs = (dev->gadget->speed == USB_SPEED_HIGH);
1320 if (type == USB_DT_OTHER_SPEED_CONFIG)
1321 hs = !hs;
1322 }
1323 if (hs) {
1324 dev->req->buf = dev->hs_config;
1325 len = le16_to_cpu(dev->hs_config->wTotalLength);
1326 } else {
1327 dev->req->buf = dev->config;
1328 len = le16_to_cpu(dev->config->wTotalLength);
1329 }
1330 ((u8 *)dev->req->buf) [1] = type;
1331 return len;
1332}
1333
1334static int
1335gadgetfs_setup (struct usb_gadget *gadget, const struct usb_ctrlrequest *ctrl)
1336{
1337 struct dev_data *dev = get_gadget_data (gadget);
1338 struct usb_request *req = dev->req;
1339 int value = -EOPNOTSUPP;
1340 struct usb_gadgetfs_event *event;
1341 u16 w_value = le16_to_cpu(ctrl->wValue);
1342 u16 w_length = le16_to_cpu(ctrl->wLength);
1343
1344 if (w_length > RBUF_SIZE) {
1345 if (ctrl->bRequestType & USB_DIR_IN) {
1346 /* Cast away the const, we are going to overwrite on purpose. */
1347 __le16 *temp = (__le16 *)&ctrl->wLength;
1348
1349 *temp = cpu_to_le16(RBUF_SIZE);
1350 w_length = RBUF_SIZE;
1351 } else {
1352 return value;
1353 }
1354 }
1355
1356 spin_lock (&dev->lock);
1357 dev->setup_abort = 0;
1358 if (dev->state == STATE_DEV_UNCONNECTED) {
1359 if (gadget_is_dualspeed(gadget)
1360 && gadget->speed == USB_SPEED_HIGH
1361 && dev->hs_config == NULL) {
1362 spin_unlock(&dev->lock);
1363 ERROR (dev, "no high speed config??\n");
1364 return -EINVAL;
1365 }
1366
1367 dev->state = STATE_DEV_CONNECTED;
1368
1369 INFO (dev, "connected\n");
1370 event = next_event (dev, GADGETFS_CONNECT);
1371 event->u.speed = gadget->speed;
1372 ep0_readable (dev);
1373
1374 /* host may have given up waiting for response. we can miss control
1375 * requests handled lower down (device/endpoint status and features);
1376 * then ep0_{read,write} will report the wrong status. controller
1377 * driver will have aborted pending i/o.
1378 */
1379 } else if (dev->state == STATE_DEV_SETUP)
1380 dev->setup_abort = 1;
1381
1382 req->buf = dev->rbuf;
1383 req->context = NULL;
1384 switch (ctrl->bRequest) {
1385
1386 case USB_REQ_GET_DESCRIPTOR:
1387 if (ctrl->bRequestType != USB_DIR_IN)
1388 goto unrecognized;
1389 switch (w_value >> 8) {
1390
1391 case USB_DT_DEVICE:
1392 value = min (w_length, (u16) sizeof *dev->dev);
1393 dev->dev->bMaxPacketSize0 = dev->gadget->ep0->maxpacket;
1394 req->buf = dev->dev;
1395 break;
1396 case USB_DT_DEVICE_QUALIFIER:
1397 if (!dev->hs_config)
1398 break;
1399 value = min (w_length, (u16)
1400 sizeof (struct usb_qualifier_descriptor));
1401 make_qualifier (dev);
1402 break;
1403 case USB_DT_OTHER_SPEED_CONFIG:
1404 case USB_DT_CONFIG:
1405 value = config_buf (dev,
1406 w_value >> 8,
1407 w_value & 0xff);
1408 if (value >= 0)
1409 value = min (w_length, (u16) value);
1410 break;
1411 case USB_DT_STRING:
1412 goto unrecognized;
1413
1414 default: // all others are errors
1415 break;
1416 }
1417 break;
1418
1419 /* currently one config, two speeds */
1420 case USB_REQ_SET_CONFIGURATION:
1421 if (ctrl->bRequestType != 0)
1422 goto unrecognized;
1423 if (0 == (u8) w_value) {
1424 value = 0;
1425 dev->current_config = 0;
1426 usb_gadget_vbus_draw(gadget, 8 /* mA */ );
1427 // user mode expected to disable endpoints
1428 } else {
1429 u8 config, power;
1430
1431 if (gadget_is_dualspeed(gadget)
1432 && gadget->speed == USB_SPEED_HIGH) {
1433 config = dev->hs_config->bConfigurationValue;
1434 power = dev->hs_config->bMaxPower;
1435 } else {
1436 config = dev->config->bConfigurationValue;
1437 power = dev->config->bMaxPower;
1438 }
1439
1440 if (config == (u8) w_value) {
1441 value = 0;
1442 dev->current_config = config;
1443 usb_gadget_vbus_draw(gadget, 2 * power);
1444 }
1445 }
1446
1447 /* report SET_CONFIGURATION like any other control request,
1448 * except that usermode may not stall this. the next
1449 * request mustn't be allowed start until this finishes:
1450 * endpoints and threads set up, etc.
1451 *
1452 * NOTE: older PXA hardware (before PXA 255: without UDCCFR)
1453 * has bad/racey automagic that prevents synchronizing here.
1454 * even kernel mode drivers often miss them.
1455 */
1456 if (value == 0) {
1457 INFO (dev, "configuration #%d\n", dev->current_config);
1458 usb_gadget_set_state(gadget, USB_STATE_CONFIGURED);
1459 if (dev->usermode_setup) {
1460 dev->setup_can_stall = 0;
1461 goto delegate;
1462 }
1463 }
1464 break;
1465
1466#ifndef CONFIG_USB_PXA25X
1467 /* PXA automagically handles this request too */
1468 case USB_REQ_GET_CONFIGURATION:
1469 if (ctrl->bRequestType != 0x80)
1470 goto unrecognized;
1471 *(u8 *)req->buf = dev->current_config;
1472 value = min (w_length, (u16) 1);
1473 break;
1474#endif
1475
1476 default:
1477unrecognized:
1478 VDEBUG (dev, "%s req%02x.%02x v%04x i%04x l%d\n",
1479 dev->usermode_setup ? "delegate" : "fail",
1480 ctrl->bRequestType, ctrl->bRequest,
1481 w_value, le16_to_cpu(ctrl->wIndex), w_length);
1482
1483 /* if there's an ep0 reader, don't stall */
1484 if (dev->usermode_setup) {
1485 dev->setup_can_stall = 1;
1486delegate:
1487 dev->setup_in = (ctrl->bRequestType & USB_DIR_IN)
1488 ? 1 : 0;
1489 dev->setup_wLength = w_length;
1490 dev->setup_out_ready = 0;
1491 dev->setup_out_error = 0;
1492
1493 /* read DATA stage for OUT right away */
1494 if (unlikely (!dev->setup_in && w_length)) {
1495 value = setup_req (gadget->ep0, dev->req,
1496 w_length);
1497 if (value < 0)
1498 break;
1499
1500 ++dev->udc_usage;
1501 spin_unlock (&dev->lock);
1502 value = usb_ep_queue (gadget->ep0, dev->req,
1503 GFP_KERNEL);
1504 spin_lock (&dev->lock);
1505 --dev->udc_usage;
1506 if (value < 0) {
1507 clean_req (gadget->ep0, dev->req);
1508 break;
1509 }
1510
1511 /* we can't currently stall these */
1512 dev->setup_can_stall = 0;
1513 }
1514
1515 /* state changes when reader collects event */
1516 event = next_event (dev, GADGETFS_SETUP);
1517 event->u.setup = *ctrl;
1518 ep0_readable (dev);
1519 spin_unlock (&dev->lock);
1520 /*
1521 * Return USB_GADGET_DELAYED_STATUS as a workaround to
1522 * stop some UDC drivers (e.g. dwc3) from automatically
1523 * proceeding with the status stage for 0-length
1524 * transfers.
1525 * Should be removed once all UDC drivers are fixed to
1526 * always delay the status stage until a response is
1527 * queued to EP0.
1528 */
1529 return w_length == 0 ? USB_GADGET_DELAYED_STATUS : 0;
1530 }
1531 }
1532
1533 /* proceed with data transfer and status phases? */
1534 if (value >= 0 && dev->state != STATE_DEV_SETUP) {
1535 req->length = value;
1536 req->zero = value < w_length;
1537
1538 ++dev->udc_usage;
1539 spin_unlock (&dev->lock);
1540 value = usb_ep_queue (gadget->ep0, req, GFP_KERNEL);
1541 spin_lock(&dev->lock);
1542 --dev->udc_usage;
1543 spin_unlock(&dev->lock);
1544 if (value < 0) {
1545 DBG (dev, "ep_queue --> %d\n", value);
1546 req->status = 0;
1547 }
1548 return value;
1549 }
1550
1551 /* device stalls when value < 0 */
1552 spin_unlock (&dev->lock);
1553 return value;
1554}
1555
1556static void destroy_ep_files (struct dev_data *dev)
1557{
1558 DBG (dev, "%s %d\n", __func__, dev->state);
1559
1560 /* dev->state must prevent interference */
1561 spin_lock_irq (&dev->lock);
1562 while (!list_empty(&dev->epfiles)) {
1563 struct ep_data *ep;
1564 struct inode *parent;
1565 struct dentry *dentry;
1566
1567 /* break link to FS */
1568 ep = list_first_entry (&dev->epfiles, struct ep_data, epfiles);
1569 list_del_init (&ep->epfiles);
1570 spin_unlock_irq (&dev->lock);
1571
1572 dentry = ep->dentry;
1573 ep->dentry = NULL;
1574 parent = d_inode(dentry->d_parent);
1575
1576 /* break link to controller */
1577 mutex_lock(&ep->lock);
1578 if (ep->state == STATE_EP_ENABLED)
1579 (void) usb_ep_disable (ep->ep);
1580 ep->state = STATE_EP_UNBOUND;
1581 usb_ep_free_request (ep->ep, ep->req);
1582 ep->ep = NULL;
1583 mutex_unlock(&ep->lock);
1584
1585 wake_up (&ep->wait);
1586 put_ep (ep);
1587
1588 /* break link to dcache */
1589 inode_lock(parent);
1590 d_delete (dentry);
1591 dput (dentry);
1592 inode_unlock(parent);
1593
1594 spin_lock_irq (&dev->lock);
1595 }
1596 spin_unlock_irq (&dev->lock);
1597}
1598
1599
1600static struct dentry *
1601gadgetfs_create_file (struct super_block *sb, char const *name,
1602 void *data, const struct file_operations *fops);
1603
1604static int activate_ep_files (struct dev_data *dev)
1605{
1606 struct usb_ep *ep;
1607 struct ep_data *data;
1608
1609 gadget_for_each_ep (ep, dev->gadget) {
1610
1611 data = kzalloc(sizeof(*data), GFP_KERNEL);
1612 if (!data)
1613 goto enomem0;
1614 data->state = STATE_EP_DISABLED;
1615 mutex_init(&data->lock);
1616 init_waitqueue_head (&data->wait);
1617
1618 strncpy (data->name, ep->name, sizeof (data->name) - 1);
1619 refcount_set (&data->count, 1);
1620 data->dev = dev;
1621 get_dev (dev);
1622
1623 data->ep = ep;
1624 ep->driver_data = data;
1625
1626 data->req = usb_ep_alloc_request (ep, GFP_KERNEL);
1627 if (!data->req)
1628 goto enomem1;
1629
1630 data->dentry = gadgetfs_create_file (dev->sb, data->name,
1631 data, &ep_io_operations);
1632 if (!data->dentry)
1633 goto enomem2;
1634 list_add_tail (&data->epfiles, &dev->epfiles);
1635 }
1636 return 0;
1637
1638enomem2:
1639 usb_ep_free_request (ep, data->req);
1640enomem1:
1641 put_dev (dev);
1642 kfree (data);
1643enomem0:
1644 DBG (dev, "%s enomem\n", __func__);
1645 destroy_ep_files (dev);
1646 return -ENOMEM;
1647}
1648
1649static void
1650gadgetfs_unbind (struct usb_gadget *gadget)
1651{
1652 struct dev_data *dev = get_gadget_data (gadget);
1653
1654 DBG (dev, "%s\n", __func__);
1655
1656 spin_lock_irq (&dev->lock);
1657 dev->state = STATE_DEV_UNBOUND;
1658 while (dev->udc_usage > 0) {
1659 spin_unlock_irq(&dev->lock);
1660 usleep_range(1000, 2000);
1661 spin_lock_irq(&dev->lock);
1662 }
1663 spin_unlock_irq (&dev->lock);
1664
1665 destroy_ep_files (dev);
1666 gadget->ep0->driver_data = NULL;
1667 set_gadget_data (gadget, NULL);
1668
1669 /* we've already been disconnected ... no i/o is active */
1670 if (dev->req)
1671 usb_ep_free_request (gadget->ep0, dev->req);
1672 DBG (dev, "%s done\n", __func__);
1673 put_dev (dev);
1674}
1675
1676static struct dev_data *the_device;
1677
1678static int gadgetfs_bind(struct usb_gadget *gadget,
1679 struct usb_gadget_driver *driver)
1680{
1681 struct dev_data *dev = the_device;
1682
1683 if (!dev)
1684 return -ESRCH;
1685 if (0 != strcmp (CHIP, gadget->name)) {
1686 pr_err("%s expected %s controller not %s\n",
1687 shortname, CHIP, gadget->name);
1688 return -ENODEV;
1689 }
1690
1691 set_gadget_data (gadget, dev);
1692 dev->gadget = gadget;
1693 gadget->ep0->driver_data = dev;
1694
1695 /* preallocate control response and buffer */
1696 dev->req = usb_ep_alloc_request (gadget->ep0, GFP_KERNEL);
1697 if (!dev->req)
1698 goto enomem;
1699 dev->req->context = NULL;
1700 dev->req->complete = epio_complete;
1701
1702 if (activate_ep_files (dev) < 0)
1703 goto enomem;
1704
1705 INFO (dev, "bound to %s driver\n", gadget->name);
1706 spin_lock_irq(&dev->lock);
1707 dev->state = STATE_DEV_UNCONNECTED;
1708 spin_unlock_irq(&dev->lock);
1709 get_dev (dev);
1710 return 0;
1711
1712enomem:
1713 gadgetfs_unbind (gadget);
1714 return -ENOMEM;
1715}
1716
1717static void
1718gadgetfs_disconnect (struct usb_gadget *gadget)
1719{
1720 struct dev_data *dev = get_gadget_data (gadget);
1721 unsigned long flags;
1722
1723 spin_lock_irqsave (&dev->lock, flags);
1724 if (dev->state == STATE_DEV_UNCONNECTED)
1725 goto exit;
1726 dev->state = STATE_DEV_UNCONNECTED;
1727
1728 INFO (dev, "disconnected\n");
1729 next_event (dev, GADGETFS_DISCONNECT);
1730 ep0_readable (dev);
1731exit:
1732 spin_unlock_irqrestore (&dev->lock, flags);
1733}
1734
1735static void
1736gadgetfs_suspend (struct usb_gadget *gadget)
1737{
1738 struct dev_data *dev = get_gadget_data (gadget);
1739 unsigned long flags;
1740
1741 INFO (dev, "suspended from state %d\n", dev->state);
1742 spin_lock_irqsave(&dev->lock, flags);
1743 switch (dev->state) {
1744 case STATE_DEV_SETUP: // VERY odd... host died??
1745 case STATE_DEV_CONNECTED:
1746 case STATE_DEV_UNCONNECTED:
1747 next_event (dev, GADGETFS_SUSPEND);
1748 ep0_readable (dev);
1749 fallthrough;
1750 default:
1751 break;
1752 }
1753 spin_unlock_irqrestore(&dev->lock, flags);
1754}
1755
1756static struct usb_gadget_driver gadgetfs_driver = {
1757 .function = (char *) driver_desc,
1758 .bind = gadgetfs_bind,
1759 .unbind = gadgetfs_unbind,
1760 .setup = gadgetfs_setup,
1761 .reset = gadgetfs_disconnect,
1762 .disconnect = gadgetfs_disconnect,
1763 .suspend = gadgetfs_suspend,
1764
1765 .driver = {
1766 .name = shortname,
1767 },
1768};
1769
1770/*----------------------------------------------------------------------*/
1771/* DEVICE INITIALIZATION
1772 *
1773 * fd = open ("/dev/gadget/$CHIP", O_RDWR)
1774 * status = write (fd, descriptors, sizeof descriptors)
1775 *
1776 * That write establishes the device configuration, so the kernel can
1777 * bind to the controller ... guaranteeing it can handle enumeration
1778 * at all necessary speeds. Descriptor order is:
1779 *
1780 * . message tag (u32, host order) ... for now, must be zero; it
1781 * would change to support features like multi-config devices
1782 * . full/low speed config ... all wTotalLength bytes (with interface,
1783 * class, altsetting, endpoint, and other descriptors)
1784 * . high speed config ... all descriptors, for high speed operation;
1785 * this one's optional except for high-speed hardware
1786 * . device descriptor
1787 *
1788 * Endpoints are not yet enabled. Drivers must wait until device
1789 * configuration and interface altsetting changes create
1790 * the need to configure (or unconfigure) them.
1791 *
1792 * After initialization, the device stays active for as long as that
1793 * $CHIP file is open. Events must then be read from that descriptor,
1794 * such as configuration notifications.
1795 */
1796
1797static int is_valid_config(struct usb_config_descriptor *config,
1798 unsigned int total)
1799{
1800 return config->bDescriptorType == USB_DT_CONFIG
1801 && config->bLength == USB_DT_CONFIG_SIZE
1802 && total >= USB_DT_CONFIG_SIZE
1803 && config->bConfigurationValue != 0
1804 && (config->bmAttributes & USB_CONFIG_ATT_ONE) != 0
1805 && (config->bmAttributes & USB_CONFIG_ATT_WAKEUP) == 0;
1806 /* FIXME if gadget->is_otg, _must_ include an otg descriptor */
1807 /* FIXME check lengths: walk to end */
1808}
1809
1810static ssize_t
1811dev_config (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
1812{
1813 struct dev_data *dev = fd->private_data;
1814 ssize_t value, length = len;
1815 unsigned total;
1816 u32 tag;
1817 char *kbuf;
1818
1819 spin_lock_irq(&dev->lock);
1820 if (dev->state > STATE_DEV_OPENED) {
1821 value = ep0_write(fd, buf, len, ptr);
1822 spin_unlock_irq(&dev->lock);
1823 return value;
1824 }
1825 spin_unlock_irq(&dev->lock);
1826
1827 if ((len < (USB_DT_CONFIG_SIZE + USB_DT_DEVICE_SIZE + 4)) ||
1828 (len > PAGE_SIZE * 4))
1829 return -EINVAL;
1830
1831 /* we might need to change message format someday */
1832 if (copy_from_user (&tag, buf, 4))
1833 return -EFAULT;
1834 if (tag != 0)
1835 return -EINVAL;
1836 buf += 4;
1837 length -= 4;
1838
1839 kbuf = memdup_user(buf, length);
1840 if (IS_ERR(kbuf))
1841 return PTR_ERR(kbuf);
1842
1843 spin_lock_irq (&dev->lock);
1844 value = -EINVAL;
1845 if (dev->buf) {
1846 spin_unlock_irq(&dev->lock);
1847 kfree(kbuf);
1848 return value;
1849 }
1850 dev->buf = kbuf;
1851
1852 /* full or low speed config */
1853 dev->config = (void *) kbuf;
1854 total = le16_to_cpu(dev->config->wTotalLength);
1855 if (!is_valid_config(dev->config, total) ||
1856 total > length - USB_DT_DEVICE_SIZE)
1857 goto fail;
1858 kbuf += total;
1859 length -= total;
1860
1861 /* optional high speed config */
1862 if (kbuf [1] == USB_DT_CONFIG) {
1863 dev->hs_config = (void *) kbuf;
1864 total = le16_to_cpu(dev->hs_config->wTotalLength);
1865 if (!is_valid_config(dev->hs_config, total) ||
1866 total > length - USB_DT_DEVICE_SIZE)
1867 goto fail;
1868 kbuf += total;
1869 length -= total;
1870 } else {
1871 dev->hs_config = NULL;
1872 }
1873
1874 /* could support multiple configs, using another encoding! */
1875
1876 /* device descriptor (tweaked for paranoia) */
1877 if (length != USB_DT_DEVICE_SIZE)
1878 goto fail;
1879 dev->dev = (void *)kbuf;
1880 if (dev->dev->bLength != USB_DT_DEVICE_SIZE
1881 || dev->dev->bDescriptorType != USB_DT_DEVICE
1882 || dev->dev->bNumConfigurations != 1)
1883 goto fail;
1884 dev->dev->bcdUSB = cpu_to_le16 (0x0200);
1885
1886 /* triggers gadgetfs_bind(); then we can enumerate. */
1887 spin_unlock_irq (&dev->lock);
1888 if (dev->hs_config)
1889 gadgetfs_driver.max_speed = USB_SPEED_HIGH;
1890 else
1891 gadgetfs_driver.max_speed = USB_SPEED_FULL;
1892
1893 value = usb_gadget_register_driver(&gadgetfs_driver);
1894 if (value != 0) {
1895 spin_lock_irq(&dev->lock);
1896 goto fail;
1897 } else {
1898 /* at this point "good" hardware has for the first time
1899 * let the USB the host see us. alternatively, if users
1900 * unplug/replug that will clear all the error state.
1901 *
1902 * note: everything running before here was guaranteed
1903 * to choke driver model style diagnostics. from here
1904 * on, they can work ... except in cleanup paths that
1905 * kick in after the ep0 descriptor is closed.
1906 */
1907 value = len;
1908 dev->gadget_registered = true;
1909 }
1910 return value;
1911
1912fail:
1913 dev->config = NULL;
1914 dev->hs_config = NULL;
1915 dev->dev = NULL;
1916 spin_unlock_irq (&dev->lock);
1917 pr_debug ("%s: %s fail %zd, %p\n", shortname, __func__, value, dev);
1918 kfree (dev->buf);
1919 dev->buf = NULL;
1920 return value;
1921}
1922
1923static int
1924gadget_dev_open (struct inode *inode, struct file *fd)
1925{
1926 struct dev_data *dev = inode->i_private;
1927 int value = -EBUSY;
1928
1929 spin_lock_irq(&dev->lock);
1930 if (dev->state == STATE_DEV_DISABLED) {
1931 dev->ev_next = 0;
1932 dev->state = STATE_DEV_OPENED;
1933 fd->private_data = dev;
1934 get_dev (dev);
1935 value = 0;
1936 }
1937 spin_unlock_irq(&dev->lock);
1938 return value;
1939}
1940
1941static const struct file_operations ep0_operations = {
1942 .llseek = no_llseek,
1943
1944 .open = gadget_dev_open,
1945 .read = ep0_read,
1946 .write = dev_config,
1947 .fasync = ep0_fasync,
1948 .poll = ep0_poll,
1949 .unlocked_ioctl = gadget_dev_ioctl,
1950 .release = dev_release,
1951};
1952
1953/*----------------------------------------------------------------------*/
1954
1955/* FILESYSTEM AND SUPERBLOCK OPERATIONS
1956 *
1957 * Mounting the filesystem creates a controller file, used first for
1958 * device configuration then later for event monitoring.
1959 */
1960
1961
1962/* FIXME PAM etc could set this security policy without mount options
1963 * if epfiles inherited ownership and permissons from ep0 ...
1964 */
1965
1966static unsigned default_uid;
1967static unsigned default_gid;
1968static unsigned default_perm = S_IRUSR | S_IWUSR;
1969
1970module_param (default_uid, uint, 0644);
1971module_param (default_gid, uint, 0644);
1972module_param (default_perm, uint, 0644);
1973
1974
1975static struct inode *
1976gadgetfs_make_inode (struct super_block *sb,
1977 void *data, const struct file_operations *fops,
1978 int mode)
1979{
1980 struct inode *inode = new_inode (sb);
1981
1982 if (inode) {
1983 inode->i_ino = get_next_ino();
1984 inode->i_mode = mode;
1985 inode->i_uid = make_kuid(&init_user_ns, default_uid);
1986 inode->i_gid = make_kgid(&init_user_ns, default_gid);
1987 simple_inode_init_ts(inode);
1988 inode->i_private = data;
1989 inode->i_fop = fops;
1990 }
1991 return inode;
1992}
1993
1994/* creates in fs root directory, so non-renamable and non-linkable.
1995 * so inode and dentry are paired, until device reconfig.
1996 */
1997static struct dentry *
1998gadgetfs_create_file (struct super_block *sb, char const *name,
1999 void *data, const struct file_operations *fops)
2000{
2001 struct dentry *dentry;
2002 struct inode *inode;
2003
2004 dentry = d_alloc_name(sb->s_root, name);
2005 if (!dentry)
2006 return NULL;
2007
2008 inode = gadgetfs_make_inode (sb, data, fops,
2009 S_IFREG | (default_perm & S_IRWXUGO));
2010 if (!inode) {
2011 dput(dentry);
2012 return NULL;
2013 }
2014 d_add (dentry, inode);
2015 return dentry;
2016}
2017
2018static const struct super_operations gadget_fs_operations = {
2019 .statfs = simple_statfs,
2020 .drop_inode = generic_delete_inode,
2021};
2022
2023static int
2024gadgetfs_fill_super (struct super_block *sb, struct fs_context *fc)
2025{
2026 struct inode *inode;
2027 struct dev_data *dev;
2028 int rc;
2029
2030 mutex_lock(&sb_mutex);
2031
2032 if (the_device) {
2033 rc = -ESRCH;
2034 goto Done;
2035 }
2036
2037 CHIP = usb_get_gadget_udc_name();
2038 if (!CHIP) {
2039 rc = -ENODEV;
2040 goto Done;
2041 }
2042
2043 /* superblock */
2044 sb->s_blocksize = PAGE_SIZE;
2045 sb->s_blocksize_bits = PAGE_SHIFT;
2046 sb->s_magic = GADGETFS_MAGIC;
2047 sb->s_op = &gadget_fs_operations;
2048 sb->s_time_gran = 1;
2049
2050 /* root inode */
2051 inode = gadgetfs_make_inode (sb,
2052 NULL, &simple_dir_operations,
2053 S_IFDIR | S_IRUGO | S_IXUGO);
2054 if (!inode)
2055 goto Enomem;
2056 inode->i_op = &simple_dir_inode_operations;
2057 if (!(sb->s_root = d_make_root (inode)))
2058 goto Enomem;
2059
2060 /* the ep0 file is named after the controller we expect;
2061 * user mode code can use it for sanity checks, like we do.
2062 */
2063 dev = dev_new ();
2064 if (!dev)
2065 goto Enomem;
2066
2067 dev->sb = sb;
2068 dev->dentry = gadgetfs_create_file(sb, CHIP, dev, &ep0_operations);
2069 if (!dev->dentry) {
2070 put_dev(dev);
2071 goto Enomem;
2072 }
2073
2074 /* other endpoint files are available after hardware setup,
2075 * from binding to a controller.
2076 */
2077 the_device = dev;
2078 rc = 0;
2079 goto Done;
2080
2081 Enomem:
2082 kfree(CHIP);
2083 CHIP = NULL;
2084 rc = -ENOMEM;
2085
2086 Done:
2087 mutex_unlock(&sb_mutex);
2088 return rc;
2089}
2090
2091/* "mount -t gadgetfs path /dev/gadget" ends up here */
2092static int gadgetfs_get_tree(struct fs_context *fc)
2093{
2094 return get_tree_single(fc, gadgetfs_fill_super);
2095}
2096
2097static const struct fs_context_operations gadgetfs_context_ops = {
2098 .get_tree = gadgetfs_get_tree,
2099};
2100
2101static int gadgetfs_init_fs_context(struct fs_context *fc)
2102{
2103 fc->ops = &gadgetfs_context_ops;
2104 return 0;
2105}
2106
2107static void
2108gadgetfs_kill_sb (struct super_block *sb)
2109{
2110 mutex_lock(&sb_mutex);
2111 kill_litter_super (sb);
2112 if (the_device) {
2113 put_dev (the_device);
2114 the_device = NULL;
2115 }
2116 kfree(CHIP);
2117 CHIP = NULL;
2118 mutex_unlock(&sb_mutex);
2119}
2120
2121/*----------------------------------------------------------------------*/
2122
2123static struct file_system_type gadgetfs_type = {
2124 .owner = THIS_MODULE,
2125 .name = shortname,
2126 .init_fs_context = gadgetfs_init_fs_context,
2127 .kill_sb = gadgetfs_kill_sb,
2128};
2129MODULE_ALIAS_FS("gadgetfs");
2130
2131/*----------------------------------------------------------------------*/
2132
2133static int __init gadgetfs_init (void)
2134{
2135 int status;
2136
2137 status = register_filesystem (&gadgetfs_type);
2138 if (status == 0)
2139 pr_info ("%s: %s, version " DRIVER_VERSION "\n",
2140 shortname, driver_desc);
2141 return status;
2142}
2143module_init (gadgetfs_init);
2144
2145static void __exit gadgetfs_cleanup (void)
2146{
2147 pr_debug ("unregister %s\n", shortname);
2148 unregister_filesystem (&gadgetfs_type);
2149}
2150module_exit (gadgetfs_cleanup);
2151
1// SPDX-License-Identifier: GPL-2.0+
2/*
3 * inode.c -- user mode filesystem api for usb gadget controllers
4 *
5 * Copyright (C) 2003-2004 David Brownell
6 * Copyright (C) 2003 Agilent Technologies
7 */
8
9
10/* #define VERBOSE_DEBUG */
11
12#include <linux/init.h>
13#include <linux/module.h>
14#include <linux/fs.h>
15#include <linux/fs_context.h>
16#include <linux/pagemap.h>
17#include <linux/uts.h>
18#include <linux/wait.h>
19#include <linux/compiler.h>
20#include <linux/uaccess.h>
21#include <linux/sched.h>
22#include <linux/slab.h>
23#include <linux/poll.h>
24#include <linux/mmu_context.h>
25#include <linux/aio.h>
26#include <linux/uio.h>
27#include <linux/refcount.h>
28#include <linux/delay.h>
29#include <linux/device.h>
30#include <linux/moduleparam.h>
31
32#include <linux/usb/gadgetfs.h>
33#include <linux/usb/gadget.h>
34
35
36/*
37 * The gadgetfs API maps each endpoint to a file descriptor so that you
38 * can use standard synchronous read/write calls for I/O. There's some
39 * O_NONBLOCK and O_ASYNC/FASYNC style i/o support. Example usermode
40 * drivers show how this works in practice. You can also use AIO to
41 * eliminate I/O gaps between requests, to help when streaming data.
42 *
43 * Key parts that must be USB-specific are protocols defining how the
44 * read/write operations relate to the hardware state machines. There
45 * are two types of files. One type is for the device, implementing ep0.
46 * The other type is for each IN or OUT endpoint. In both cases, the
47 * user mode driver must configure the hardware before using it.
48 *
49 * - First, dev_config() is called when /dev/gadget/$CHIP is configured
50 * (by writing configuration and device descriptors). Afterwards it
51 * may serve as a source of device events, used to handle all control
52 * requests other than basic enumeration.
53 *
54 * - Then, after a SET_CONFIGURATION control request, ep_config() is
55 * called when each /dev/gadget/ep* file is configured (by writing
56 * endpoint descriptors). Afterwards these files are used to write()
57 * IN data or to read() OUT data. To halt the endpoint, a "wrong
58 * direction" request is issued (like reading an IN endpoint).
59 *
60 * Unlike "usbfs" the only ioctl()s are for things that are rare, and maybe
61 * not possible on all hardware. For example, precise fault handling with
62 * respect to data left in endpoint fifos after aborted operations; or
63 * selective clearing of endpoint halts, to implement SET_INTERFACE.
64 */
65
66#define DRIVER_DESC "USB Gadget filesystem"
67#define DRIVER_VERSION "24 Aug 2004"
68
69static const char driver_desc [] = DRIVER_DESC;
70static const char shortname [] = "gadgetfs";
71
72MODULE_DESCRIPTION (DRIVER_DESC);
73MODULE_AUTHOR ("David Brownell");
74MODULE_LICENSE ("GPL");
75
76static int ep_open(struct inode *, struct file *);
77
78
79/*----------------------------------------------------------------------*/
80
81#define GADGETFS_MAGIC 0xaee71ee7
82
83/* /dev/gadget/$CHIP represents ep0 and the whole device */
84enum ep0_state {
85 /* DISABLED is the initial state. */
86 STATE_DEV_DISABLED = 0,
87
88 /* Only one open() of /dev/gadget/$CHIP; only one file tracks
89 * ep0/device i/o modes and binding to the controller. Driver
90 * must always write descriptors to initialize the device, then
91 * the device becomes UNCONNECTED until enumeration.
92 */
93 STATE_DEV_OPENED,
94
95 /* From then on, ep0 fd is in either of two basic modes:
96 * - (UN)CONNECTED: read usb_gadgetfs_event(s) from it
97 * - SETUP: read/write will transfer control data and succeed;
98 * or if "wrong direction", performs protocol stall
99 */
100 STATE_DEV_UNCONNECTED,
101 STATE_DEV_CONNECTED,
102 STATE_DEV_SETUP,
103
104 /* UNBOUND means the driver closed ep0, so the device won't be
105 * accessible again (DEV_DISABLED) until all fds are closed.
106 */
107 STATE_DEV_UNBOUND,
108};
109
110/* enough for the whole queue: most events invalidate others */
111#define N_EVENT 5
112
113struct dev_data {
114 spinlock_t lock;
115 refcount_t count;
116 int udc_usage;
117 enum ep0_state state; /* P: lock */
118 struct usb_gadgetfs_event event [N_EVENT];
119 unsigned ev_next;
120 struct fasync_struct *fasync;
121 u8 current_config;
122
123 /* drivers reading ep0 MUST handle control requests (SETUP)
124 * reported that way; else the host will time out.
125 */
126 unsigned usermode_setup : 1,
127 setup_in : 1,
128 setup_can_stall : 1,
129 setup_out_ready : 1,
130 setup_out_error : 1,
131 setup_abort : 1,
132 gadget_registered : 1;
133 unsigned setup_wLength;
134
135 /* the rest is basically write-once */
136 struct usb_config_descriptor *config, *hs_config;
137 struct usb_device_descriptor *dev;
138 struct usb_request *req;
139 struct usb_gadget *gadget;
140 struct list_head epfiles;
141 void *buf;
142 wait_queue_head_t wait;
143 struct super_block *sb;
144 struct dentry *dentry;
145
146 /* except this scratch i/o buffer for ep0 */
147 u8 rbuf [256];
148};
149
150static inline void get_dev (struct dev_data *data)
151{
152 refcount_inc (&data->count);
153}
154
155static void put_dev (struct dev_data *data)
156{
157 if (likely (!refcount_dec_and_test (&data->count)))
158 return;
159 /* needs no more cleanup */
160 BUG_ON (waitqueue_active (&data->wait));
161 kfree (data);
162}
163
164static struct dev_data *dev_new (void)
165{
166 struct dev_data *dev;
167
168 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
169 if (!dev)
170 return NULL;
171 dev->state = STATE_DEV_DISABLED;
172 refcount_set (&dev->count, 1);
173 spin_lock_init (&dev->lock);
174 INIT_LIST_HEAD (&dev->epfiles);
175 init_waitqueue_head (&dev->wait);
176 return dev;
177}
178
179/*----------------------------------------------------------------------*/
180
181/* other /dev/gadget/$ENDPOINT files represent endpoints */
182enum ep_state {
183 STATE_EP_DISABLED = 0,
184 STATE_EP_READY,
185 STATE_EP_ENABLED,
186 STATE_EP_UNBOUND,
187};
188
189struct ep_data {
190 struct mutex lock;
191 enum ep_state state;
192 refcount_t count;
193 struct dev_data *dev;
194 /* must hold dev->lock before accessing ep or req */
195 struct usb_ep *ep;
196 struct usb_request *req;
197 ssize_t status;
198 char name [16];
199 struct usb_endpoint_descriptor desc, hs_desc;
200 struct list_head epfiles;
201 wait_queue_head_t wait;
202 struct dentry *dentry;
203};
204
205static inline void get_ep (struct ep_data *data)
206{
207 refcount_inc (&data->count);
208}
209
210static void put_ep (struct ep_data *data)
211{
212 if (likely (!refcount_dec_and_test (&data->count)))
213 return;
214 put_dev (data->dev);
215 /* needs no more cleanup */
216 BUG_ON (!list_empty (&data->epfiles));
217 BUG_ON (waitqueue_active (&data->wait));
218 kfree (data);
219}
220
221/*----------------------------------------------------------------------*/
222
223/* most "how to use the hardware" policy choices are in userspace:
224 * mapping endpoint roles (which the driver needs) to the capabilities
225 * which the usb controller has. most of those capabilities are exposed
226 * implicitly, starting with the driver name and then endpoint names.
227 */
228
229static const char *CHIP;
230
231/*----------------------------------------------------------------------*/
232
233/* NOTE: don't use dev_printk calls before binding to the gadget
234 * at the end of ep0 configuration, or after unbind.
235 */
236
237/* too wordy: dev_printk(level , &(d)->gadget->dev , fmt , ## args) */
238#define xprintk(d,level,fmt,args...) \
239 printk(level "%s: " fmt , shortname , ## args)
240
241#ifdef DEBUG
242#define DBG(dev,fmt,args...) \
243 xprintk(dev , KERN_DEBUG , fmt , ## args)
244#else
245#define DBG(dev,fmt,args...) \
246 do { } while (0)
247#endif /* DEBUG */
248
249#ifdef VERBOSE_DEBUG
250#define VDEBUG DBG
251#else
252#define VDEBUG(dev,fmt,args...) \
253 do { } while (0)
254#endif /* DEBUG */
255
256#define ERROR(dev,fmt,args...) \
257 xprintk(dev , KERN_ERR , fmt , ## args)
258#define INFO(dev,fmt,args...) \
259 xprintk(dev , KERN_INFO , fmt , ## args)
260
261
262/*----------------------------------------------------------------------*/
263
264/* SYNCHRONOUS ENDPOINT OPERATIONS (bulk/intr/iso)
265 *
266 * After opening, configure non-control endpoints. Then use normal
267 * stream read() and write() requests; and maybe ioctl() to get more
268 * precise FIFO status when recovering from cancellation.
269 */
270
271static void epio_complete (struct usb_ep *ep, struct usb_request *req)
272{
273 struct ep_data *epdata = ep->driver_data;
274
275 if (!req->context)
276 return;
277 if (req->status)
278 epdata->status = req->status;
279 else
280 epdata->status = req->actual;
281 complete ((struct completion *)req->context);
282}
283
284/* tasklock endpoint, returning when it's connected.
285 * still need dev->lock to use epdata->ep.
286 */
287static int
288get_ready_ep (unsigned f_flags, struct ep_data *epdata, bool is_write)
289{
290 int val;
291
292 if (f_flags & O_NONBLOCK) {
293 if (!mutex_trylock(&epdata->lock))
294 goto nonblock;
295 if (epdata->state != STATE_EP_ENABLED &&
296 (!is_write || epdata->state != STATE_EP_READY)) {
297 mutex_unlock(&epdata->lock);
298nonblock:
299 val = -EAGAIN;
300 } else
301 val = 0;
302 return val;
303 }
304
305 val = mutex_lock_interruptible(&epdata->lock);
306 if (val < 0)
307 return val;
308
309 switch (epdata->state) {
310 case STATE_EP_ENABLED:
311 return 0;
312 case STATE_EP_READY: /* not configured yet */
313 if (is_write)
314 return 0;
315 // FALLTHRU
316 case STATE_EP_UNBOUND: /* clean disconnect */
317 break;
318 // case STATE_EP_DISABLED: /* "can't happen" */
319 default: /* error! */
320 pr_debug ("%s: ep %p not available, state %d\n",
321 shortname, epdata, epdata->state);
322 }
323 mutex_unlock(&epdata->lock);
324 return -ENODEV;
325}
326
327static ssize_t
328ep_io (struct ep_data *epdata, void *buf, unsigned len)
329{
330 DECLARE_COMPLETION_ONSTACK (done);
331 int value;
332
333 spin_lock_irq (&epdata->dev->lock);
334 if (likely (epdata->ep != NULL)) {
335 struct usb_request *req = epdata->req;
336
337 req->context = &done;
338 req->complete = epio_complete;
339 req->buf = buf;
340 req->length = len;
341 value = usb_ep_queue (epdata->ep, req, GFP_ATOMIC);
342 } else
343 value = -ENODEV;
344 spin_unlock_irq (&epdata->dev->lock);
345
346 if (likely (value == 0)) {
347 value = wait_event_interruptible (done.wait, done.done);
348 if (value != 0) {
349 spin_lock_irq (&epdata->dev->lock);
350 if (likely (epdata->ep != NULL)) {
351 DBG (epdata->dev, "%s i/o interrupted\n",
352 epdata->name);
353 usb_ep_dequeue (epdata->ep, epdata->req);
354 spin_unlock_irq (&epdata->dev->lock);
355
356 wait_event (done.wait, done.done);
357 if (epdata->status == -ECONNRESET)
358 epdata->status = -EINTR;
359 } else {
360 spin_unlock_irq (&epdata->dev->lock);
361
362 DBG (epdata->dev, "endpoint gone\n");
363 epdata->status = -ENODEV;
364 }
365 }
366 return epdata->status;
367 }
368 return value;
369}
370
371static int
372ep_release (struct inode *inode, struct file *fd)
373{
374 struct ep_data *data = fd->private_data;
375 int value;
376
377 value = mutex_lock_interruptible(&data->lock);
378 if (value < 0)
379 return value;
380
381 /* clean up if this can be reopened */
382 if (data->state != STATE_EP_UNBOUND) {
383 data->state = STATE_EP_DISABLED;
384 data->desc.bDescriptorType = 0;
385 data->hs_desc.bDescriptorType = 0;
386 usb_ep_disable(data->ep);
387 }
388 mutex_unlock(&data->lock);
389 put_ep (data);
390 return 0;
391}
392
393static long ep_ioctl(struct file *fd, unsigned code, unsigned long value)
394{
395 struct ep_data *data = fd->private_data;
396 int status;
397
398 if ((status = get_ready_ep (fd->f_flags, data, false)) < 0)
399 return status;
400
401 spin_lock_irq (&data->dev->lock);
402 if (likely (data->ep != NULL)) {
403 switch (code) {
404 case GADGETFS_FIFO_STATUS:
405 status = usb_ep_fifo_status (data->ep);
406 break;
407 case GADGETFS_FIFO_FLUSH:
408 usb_ep_fifo_flush (data->ep);
409 break;
410 case GADGETFS_CLEAR_HALT:
411 status = usb_ep_clear_halt (data->ep);
412 break;
413 default:
414 status = -ENOTTY;
415 }
416 } else
417 status = -ENODEV;
418 spin_unlock_irq (&data->dev->lock);
419 mutex_unlock(&data->lock);
420 return status;
421}
422
423/*----------------------------------------------------------------------*/
424
425/* ASYNCHRONOUS ENDPOINT I/O OPERATIONS (bulk/intr/iso) */
426
427struct kiocb_priv {
428 struct usb_request *req;
429 struct ep_data *epdata;
430 struct kiocb *iocb;
431 struct mm_struct *mm;
432 struct work_struct work;
433 void *buf;
434 struct iov_iter to;
435 const void *to_free;
436 unsigned actual;
437};
438
439static int ep_aio_cancel(struct kiocb *iocb)
440{
441 struct kiocb_priv *priv = iocb->private;
442 struct ep_data *epdata;
443 int value;
444
445 local_irq_disable();
446 epdata = priv->epdata;
447 // spin_lock(&epdata->dev->lock);
448 if (likely(epdata && epdata->ep && priv->req))
449 value = usb_ep_dequeue (epdata->ep, priv->req);
450 else
451 value = -EINVAL;
452 // spin_unlock(&epdata->dev->lock);
453 local_irq_enable();
454
455 return value;
456}
457
458static void ep_user_copy_worker(struct work_struct *work)
459{
460 struct kiocb_priv *priv = container_of(work, struct kiocb_priv, work);
461 struct mm_struct *mm = priv->mm;
462 struct kiocb *iocb = priv->iocb;
463 size_t ret;
464
465 use_mm(mm);
466 ret = copy_to_iter(priv->buf, priv->actual, &priv->to);
467 unuse_mm(mm);
468 if (!ret)
469 ret = -EFAULT;
470
471 /* completing the iocb can drop the ctx and mm, don't touch mm after */
472 iocb->ki_complete(iocb, ret, ret);
473
474 kfree(priv->buf);
475 kfree(priv->to_free);
476 kfree(priv);
477}
478
479static void ep_aio_complete(struct usb_ep *ep, struct usb_request *req)
480{
481 struct kiocb *iocb = req->context;
482 struct kiocb_priv *priv = iocb->private;
483 struct ep_data *epdata = priv->epdata;
484
485 /* lock against disconnect (and ideally, cancel) */
486 spin_lock(&epdata->dev->lock);
487 priv->req = NULL;
488 priv->epdata = NULL;
489
490 /* if this was a write or a read returning no data then we
491 * don't need to copy anything to userspace, so we can
492 * complete the aio request immediately.
493 */
494 if (priv->to_free == NULL || unlikely(req->actual == 0)) {
495 kfree(req->buf);
496 kfree(priv->to_free);
497 kfree(priv);
498 iocb->private = NULL;
499 /* aio_complete() reports bytes-transferred _and_ faults */
500
501 iocb->ki_complete(iocb, req->actual ? req->actual : req->status,
502 req->status);
503 } else {
504 /* ep_copy_to_user() won't report both; we hide some faults */
505 if (unlikely(0 != req->status))
506 DBG(epdata->dev, "%s fault %d len %d\n",
507 ep->name, req->status, req->actual);
508
509 priv->buf = req->buf;
510 priv->actual = req->actual;
511 INIT_WORK(&priv->work, ep_user_copy_worker);
512 schedule_work(&priv->work);
513 }
514
515 usb_ep_free_request(ep, req);
516 spin_unlock(&epdata->dev->lock);
517 put_ep(epdata);
518}
519
520static ssize_t ep_aio(struct kiocb *iocb,
521 struct kiocb_priv *priv,
522 struct ep_data *epdata,
523 char *buf,
524 size_t len)
525{
526 struct usb_request *req;
527 ssize_t value;
528
529 iocb->private = priv;
530 priv->iocb = iocb;
531
532 kiocb_set_cancel_fn(iocb, ep_aio_cancel);
533 get_ep(epdata);
534 priv->epdata = epdata;
535 priv->actual = 0;
536 priv->mm = current->mm; /* mm teardown waits for iocbs in exit_aio() */
537
538 /* each kiocb is coupled to one usb_request, but we can't
539 * allocate or submit those if the host disconnected.
540 */
541 spin_lock_irq(&epdata->dev->lock);
542 value = -ENODEV;
543 if (unlikely(epdata->ep == NULL))
544 goto fail;
545
546 req = usb_ep_alloc_request(epdata->ep, GFP_ATOMIC);
547 value = -ENOMEM;
548 if (unlikely(!req))
549 goto fail;
550
551 priv->req = req;
552 req->buf = buf;
553 req->length = len;
554 req->complete = ep_aio_complete;
555 req->context = iocb;
556 value = usb_ep_queue(epdata->ep, req, GFP_ATOMIC);
557 if (unlikely(0 != value)) {
558 usb_ep_free_request(epdata->ep, req);
559 goto fail;
560 }
561 spin_unlock_irq(&epdata->dev->lock);
562 return -EIOCBQUEUED;
563
564fail:
565 spin_unlock_irq(&epdata->dev->lock);
566 kfree(priv->to_free);
567 kfree(priv);
568 put_ep(epdata);
569 return value;
570}
571
572static ssize_t
573ep_read_iter(struct kiocb *iocb, struct iov_iter *to)
574{
575 struct file *file = iocb->ki_filp;
576 struct ep_data *epdata = file->private_data;
577 size_t len = iov_iter_count(to);
578 ssize_t value;
579 char *buf;
580
581 if ((value = get_ready_ep(file->f_flags, epdata, false)) < 0)
582 return value;
583
584 /* halt any endpoint by doing a "wrong direction" i/o call */
585 if (usb_endpoint_dir_in(&epdata->desc)) {
586 if (usb_endpoint_xfer_isoc(&epdata->desc) ||
587 !is_sync_kiocb(iocb)) {
588 mutex_unlock(&epdata->lock);
589 return -EINVAL;
590 }
591 DBG (epdata->dev, "%s halt\n", epdata->name);
592 spin_lock_irq(&epdata->dev->lock);
593 if (likely(epdata->ep != NULL))
594 usb_ep_set_halt(epdata->ep);
595 spin_unlock_irq(&epdata->dev->lock);
596 mutex_unlock(&epdata->lock);
597 return -EBADMSG;
598 }
599
600 buf = kmalloc(len, GFP_KERNEL);
601 if (unlikely(!buf)) {
602 mutex_unlock(&epdata->lock);
603 return -ENOMEM;
604 }
605 if (is_sync_kiocb(iocb)) {
606 value = ep_io(epdata, buf, len);
607 if (value >= 0 && (copy_to_iter(buf, value, to) != value))
608 value = -EFAULT;
609 } else {
610 struct kiocb_priv *priv = kzalloc(sizeof *priv, GFP_KERNEL);
611 value = -ENOMEM;
612 if (!priv)
613 goto fail;
614 priv->to_free = dup_iter(&priv->to, to, GFP_KERNEL);
615 if (!priv->to_free) {
616 kfree(priv);
617 goto fail;
618 }
619 value = ep_aio(iocb, priv, epdata, buf, len);
620 if (value == -EIOCBQUEUED)
621 buf = NULL;
622 }
623fail:
624 kfree(buf);
625 mutex_unlock(&epdata->lock);
626 return value;
627}
628
629static ssize_t ep_config(struct ep_data *, const char *, size_t);
630
631static ssize_t
632ep_write_iter(struct kiocb *iocb, struct iov_iter *from)
633{
634 struct file *file = iocb->ki_filp;
635 struct ep_data *epdata = file->private_data;
636 size_t len = iov_iter_count(from);
637 bool configured;
638 ssize_t value;
639 char *buf;
640
641 if ((value = get_ready_ep(file->f_flags, epdata, true)) < 0)
642 return value;
643
644 configured = epdata->state == STATE_EP_ENABLED;
645
646 /* halt any endpoint by doing a "wrong direction" i/o call */
647 if (configured && !usb_endpoint_dir_in(&epdata->desc)) {
648 if (usb_endpoint_xfer_isoc(&epdata->desc) ||
649 !is_sync_kiocb(iocb)) {
650 mutex_unlock(&epdata->lock);
651 return -EINVAL;
652 }
653 DBG (epdata->dev, "%s halt\n", epdata->name);
654 spin_lock_irq(&epdata->dev->lock);
655 if (likely(epdata->ep != NULL))
656 usb_ep_set_halt(epdata->ep);
657 spin_unlock_irq(&epdata->dev->lock);
658 mutex_unlock(&epdata->lock);
659 return -EBADMSG;
660 }
661
662 buf = kmalloc(len, GFP_KERNEL);
663 if (unlikely(!buf)) {
664 mutex_unlock(&epdata->lock);
665 return -ENOMEM;
666 }
667
668 if (unlikely(!copy_from_iter_full(buf, len, from))) {
669 value = -EFAULT;
670 goto out;
671 }
672
673 if (unlikely(!configured)) {
674 value = ep_config(epdata, buf, len);
675 } else if (is_sync_kiocb(iocb)) {
676 value = ep_io(epdata, buf, len);
677 } else {
678 struct kiocb_priv *priv = kzalloc(sizeof *priv, GFP_KERNEL);
679 value = -ENOMEM;
680 if (priv) {
681 value = ep_aio(iocb, priv, epdata, buf, len);
682 if (value == -EIOCBQUEUED)
683 buf = NULL;
684 }
685 }
686out:
687 kfree(buf);
688 mutex_unlock(&epdata->lock);
689 return value;
690}
691
692/*----------------------------------------------------------------------*/
693
694/* used after endpoint configuration */
695static const struct file_operations ep_io_operations = {
696 .owner = THIS_MODULE,
697
698 .open = ep_open,
699 .release = ep_release,
700 .llseek = no_llseek,
701 .unlocked_ioctl = ep_ioctl,
702 .read_iter = ep_read_iter,
703 .write_iter = ep_write_iter,
704};
705
706/* ENDPOINT INITIALIZATION
707 *
708 * fd = open ("/dev/gadget/$ENDPOINT", O_RDWR)
709 * status = write (fd, descriptors, sizeof descriptors)
710 *
711 * That write establishes the endpoint configuration, configuring
712 * the controller to process bulk, interrupt, or isochronous transfers
713 * at the right maxpacket size, and so on.
714 *
715 * The descriptors are message type 1, identified by a host order u32
716 * at the beginning of what's written. Descriptor order is: full/low
717 * speed descriptor, then optional high speed descriptor.
718 */
719static ssize_t
720ep_config (struct ep_data *data, const char *buf, size_t len)
721{
722 struct usb_ep *ep;
723 u32 tag;
724 int value, length = len;
725
726 if (data->state != STATE_EP_READY) {
727 value = -EL2HLT;
728 goto fail;
729 }
730
731 value = len;
732 if (len < USB_DT_ENDPOINT_SIZE + 4)
733 goto fail0;
734
735 /* we might need to change message format someday */
736 memcpy(&tag, buf, 4);
737 if (tag != 1) {
738 DBG(data->dev, "config %s, bad tag %d\n", data->name, tag);
739 goto fail0;
740 }
741 buf += 4;
742 len -= 4;
743
744 /* NOTE: audio endpoint extensions not accepted here;
745 * just don't include the extra bytes.
746 */
747
748 /* full/low speed descriptor, then high speed */
749 memcpy(&data->desc, buf, USB_DT_ENDPOINT_SIZE);
750 if (data->desc.bLength != USB_DT_ENDPOINT_SIZE
751 || data->desc.bDescriptorType != USB_DT_ENDPOINT)
752 goto fail0;
753 if (len != USB_DT_ENDPOINT_SIZE) {
754 if (len != 2 * USB_DT_ENDPOINT_SIZE)
755 goto fail0;
756 memcpy(&data->hs_desc, buf + USB_DT_ENDPOINT_SIZE,
757 USB_DT_ENDPOINT_SIZE);
758 if (data->hs_desc.bLength != USB_DT_ENDPOINT_SIZE
759 || data->hs_desc.bDescriptorType
760 != USB_DT_ENDPOINT) {
761 DBG(data->dev, "config %s, bad hs length or type\n",
762 data->name);
763 goto fail0;
764 }
765 }
766
767 spin_lock_irq (&data->dev->lock);
768 if (data->dev->state == STATE_DEV_UNBOUND) {
769 value = -ENOENT;
770 goto gone;
771 } else {
772 ep = data->ep;
773 if (ep == NULL) {
774 value = -ENODEV;
775 goto gone;
776 }
777 }
778 switch (data->dev->gadget->speed) {
779 case USB_SPEED_LOW:
780 case USB_SPEED_FULL:
781 ep->desc = &data->desc;
782 break;
783 case USB_SPEED_HIGH:
784 /* fails if caller didn't provide that descriptor... */
785 ep->desc = &data->hs_desc;
786 break;
787 default:
788 DBG(data->dev, "unconnected, %s init abandoned\n",
789 data->name);
790 value = -EINVAL;
791 goto gone;
792 }
793 value = usb_ep_enable(ep);
794 if (value == 0) {
795 data->state = STATE_EP_ENABLED;
796 value = length;
797 }
798gone:
799 spin_unlock_irq (&data->dev->lock);
800 if (value < 0) {
801fail:
802 data->desc.bDescriptorType = 0;
803 data->hs_desc.bDescriptorType = 0;
804 }
805 return value;
806fail0:
807 value = -EINVAL;
808 goto fail;
809}
810
811static int
812ep_open (struct inode *inode, struct file *fd)
813{
814 struct ep_data *data = inode->i_private;
815 int value = -EBUSY;
816
817 if (mutex_lock_interruptible(&data->lock) != 0)
818 return -EINTR;
819 spin_lock_irq (&data->dev->lock);
820 if (data->dev->state == STATE_DEV_UNBOUND)
821 value = -ENOENT;
822 else if (data->state == STATE_EP_DISABLED) {
823 value = 0;
824 data->state = STATE_EP_READY;
825 get_ep (data);
826 fd->private_data = data;
827 VDEBUG (data->dev, "%s ready\n", data->name);
828 } else
829 DBG (data->dev, "%s state %d\n",
830 data->name, data->state);
831 spin_unlock_irq (&data->dev->lock);
832 mutex_unlock(&data->lock);
833 return value;
834}
835
836/*----------------------------------------------------------------------*/
837
838/* EP0 IMPLEMENTATION can be partly in userspace.
839 *
840 * Drivers that use this facility receive various events, including
841 * control requests the kernel doesn't handle. Drivers that don't
842 * use this facility may be too simple-minded for real applications.
843 */
844
845static inline void ep0_readable (struct dev_data *dev)
846{
847 wake_up (&dev->wait);
848 kill_fasync (&dev->fasync, SIGIO, POLL_IN);
849}
850
851static void clean_req (struct usb_ep *ep, struct usb_request *req)
852{
853 struct dev_data *dev = ep->driver_data;
854
855 if (req->buf != dev->rbuf) {
856 kfree(req->buf);
857 req->buf = dev->rbuf;
858 }
859 req->complete = epio_complete;
860 dev->setup_out_ready = 0;
861}
862
863static void ep0_complete (struct usb_ep *ep, struct usb_request *req)
864{
865 struct dev_data *dev = ep->driver_data;
866 unsigned long flags;
867 int free = 1;
868
869 /* for control OUT, data must still get to userspace */
870 spin_lock_irqsave(&dev->lock, flags);
871 if (!dev->setup_in) {
872 dev->setup_out_error = (req->status != 0);
873 if (!dev->setup_out_error)
874 free = 0;
875 dev->setup_out_ready = 1;
876 ep0_readable (dev);
877 }
878
879 /* clean up as appropriate */
880 if (free && req->buf != &dev->rbuf)
881 clean_req (ep, req);
882 req->complete = epio_complete;
883 spin_unlock_irqrestore(&dev->lock, flags);
884}
885
886static int setup_req (struct usb_ep *ep, struct usb_request *req, u16 len)
887{
888 struct dev_data *dev = ep->driver_data;
889
890 if (dev->setup_out_ready) {
891 DBG (dev, "ep0 request busy!\n");
892 return -EBUSY;
893 }
894 if (len > sizeof (dev->rbuf))
895 req->buf = kmalloc(len, GFP_ATOMIC);
896 if (req->buf == NULL) {
897 req->buf = dev->rbuf;
898 return -ENOMEM;
899 }
900 req->complete = ep0_complete;
901 req->length = len;
902 req->zero = 0;
903 return 0;
904}
905
906static ssize_t
907ep0_read (struct file *fd, char __user *buf, size_t len, loff_t *ptr)
908{
909 struct dev_data *dev = fd->private_data;
910 ssize_t retval;
911 enum ep0_state state;
912
913 spin_lock_irq (&dev->lock);
914 if (dev->state <= STATE_DEV_OPENED) {
915 retval = -EINVAL;
916 goto done;
917 }
918
919 /* report fd mode change before acting on it */
920 if (dev->setup_abort) {
921 dev->setup_abort = 0;
922 retval = -EIDRM;
923 goto done;
924 }
925
926 /* control DATA stage */
927 if ((state = dev->state) == STATE_DEV_SETUP) {
928
929 if (dev->setup_in) { /* stall IN */
930 VDEBUG(dev, "ep0in stall\n");
931 (void) usb_ep_set_halt (dev->gadget->ep0);
932 retval = -EL2HLT;
933 dev->state = STATE_DEV_CONNECTED;
934
935 } else if (len == 0) { /* ack SET_CONFIGURATION etc */
936 struct usb_ep *ep = dev->gadget->ep0;
937 struct usb_request *req = dev->req;
938
939 if ((retval = setup_req (ep, req, 0)) == 0) {
940 ++dev->udc_usage;
941 spin_unlock_irq (&dev->lock);
942 retval = usb_ep_queue (ep, req, GFP_KERNEL);
943 spin_lock_irq (&dev->lock);
944 --dev->udc_usage;
945 }
946 dev->state = STATE_DEV_CONNECTED;
947
948 /* assume that was SET_CONFIGURATION */
949 if (dev->current_config) {
950 unsigned power;
951
952 if (gadget_is_dualspeed(dev->gadget)
953 && (dev->gadget->speed
954 == USB_SPEED_HIGH))
955 power = dev->hs_config->bMaxPower;
956 else
957 power = dev->config->bMaxPower;
958 usb_gadget_vbus_draw(dev->gadget, 2 * power);
959 }
960
961 } else { /* collect OUT data */
962 if ((fd->f_flags & O_NONBLOCK) != 0
963 && !dev->setup_out_ready) {
964 retval = -EAGAIN;
965 goto done;
966 }
967 spin_unlock_irq (&dev->lock);
968 retval = wait_event_interruptible (dev->wait,
969 dev->setup_out_ready != 0);
970
971 /* FIXME state could change from under us */
972 spin_lock_irq (&dev->lock);
973 if (retval)
974 goto done;
975
976 if (dev->state != STATE_DEV_SETUP) {
977 retval = -ECANCELED;
978 goto done;
979 }
980 dev->state = STATE_DEV_CONNECTED;
981
982 if (dev->setup_out_error)
983 retval = -EIO;
984 else {
985 len = min (len, (size_t)dev->req->actual);
986 ++dev->udc_usage;
987 spin_unlock_irq(&dev->lock);
988 if (copy_to_user (buf, dev->req->buf, len))
989 retval = -EFAULT;
990 else
991 retval = len;
992 spin_lock_irq(&dev->lock);
993 --dev->udc_usage;
994 clean_req (dev->gadget->ep0, dev->req);
995 /* NOTE userspace can't yet choose to stall */
996 }
997 }
998 goto done;
999 }
1000
1001 /* else normal: return event data */
1002 if (len < sizeof dev->event [0]) {
1003 retval = -EINVAL;
1004 goto done;
1005 }
1006 len -= len % sizeof (struct usb_gadgetfs_event);
1007 dev->usermode_setup = 1;
1008
1009scan:
1010 /* return queued events right away */
1011 if (dev->ev_next != 0) {
1012 unsigned i, n;
1013
1014 n = len / sizeof (struct usb_gadgetfs_event);
1015 if (dev->ev_next < n)
1016 n = dev->ev_next;
1017
1018 /* ep0 i/o has special semantics during STATE_DEV_SETUP */
1019 for (i = 0; i < n; i++) {
1020 if (dev->event [i].type == GADGETFS_SETUP) {
1021 dev->state = STATE_DEV_SETUP;
1022 n = i + 1;
1023 break;
1024 }
1025 }
1026 spin_unlock_irq (&dev->lock);
1027 len = n * sizeof (struct usb_gadgetfs_event);
1028 if (copy_to_user (buf, &dev->event, len))
1029 retval = -EFAULT;
1030 else
1031 retval = len;
1032 if (len > 0) {
1033 /* NOTE this doesn't guard against broken drivers;
1034 * concurrent ep0 readers may lose events.
1035 */
1036 spin_lock_irq (&dev->lock);
1037 if (dev->ev_next > n) {
1038 memmove(&dev->event[0], &dev->event[n],
1039 sizeof (struct usb_gadgetfs_event)
1040 * (dev->ev_next - n));
1041 }
1042 dev->ev_next -= n;
1043 spin_unlock_irq (&dev->lock);
1044 }
1045 return retval;
1046 }
1047 if (fd->f_flags & O_NONBLOCK) {
1048 retval = -EAGAIN;
1049 goto done;
1050 }
1051
1052 switch (state) {
1053 default:
1054 DBG (dev, "fail %s, state %d\n", __func__, state);
1055 retval = -ESRCH;
1056 break;
1057 case STATE_DEV_UNCONNECTED:
1058 case STATE_DEV_CONNECTED:
1059 spin_unlock_irq (&dev->lock);
1060 DBG (dev, "%s wait\n", __func__);
1061
1062 /* wait for events */
1063 retval = wait_event_interruptible (dev->wait,
1064 dev->ev_next != 0);
1065 if (retval < 0)
1066 return retval;
1067 spin_lock_irq (&dev->lock);
1068 goto scan;
1069 }
1070
1071done:
1072 spin_unlock_irq (&dev->lock);
1073 return retval;
1074}
1075
1076static struct usb_gadgetfs_event *
1077next_event (struct dev_data *dev, enum usb_gadgetfs_event_type type)
1078{
1079 struct usb_gadgetfs_event *event;
1080 unsigned i;
1081
1082 switch (type) {
1083 /* these events purge the queue */
1084 case GADGETFS_DISCONNECT:
1085 if (dev->state == STATE_DEV_SETUP)
1086 dev->setup_abort = 1;
1087 // FALL THROUGH
1088 case GADGETFS_CONNECT:
1089 dev->ev_next = 0;
1090 break;
1091 case GADGETFS_SETUP: /* previous request timed out */
1092 case GADGETFS_SUSPEND: /* same effect */
1093 /* these events can't be repeated */
1094 for (i = 0; i != dev->ev_next; i++) {
1095 if (dev->event [i].type != type)
1096 continue;
1097 DBG(dev, "discard old event[%d] %d\n", i, type);
1098 dev->ev_next--;
1099 if (i == dev->ev_next)
1100 break;
1101 /* indices start at zero, for simplicity */
1102 memmove (&dev->event [i], &dev->event [i + 1],
1103 sizeof (struct usb_gadgetfs_event)
1104 * (dev->ev_next - i));
1105 }
1106 break;
1107 default:
1108 BUG ();
1109 }
1110 VDEBUG(dev, "event[%d] = %d\n", dev->ev_next, type);
1111 event = &dev->event [dev->ev_next++];
1112 BUG_ON (dev->ev_next > N_EVENT);
1113 memset (event, 0, sizeof *event);
1114 event->type = type;
1115 return event;
1116}
1117
1118static ssize_t
1119ep0_write (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
1120{
1121 struct dev_data *dev = fd->private_data;
1122 ssize_t retval = -ESRCH;
1123
1124 /* report fd mode change before acting on it */
1125 if (dev->setup_abort) {
1126 dev->setup_abort = 0;
1127 retval = -EIDRM;
1128
1129 /* data and/or status stage for control request */
1130 } else if (dev->state == STATE_DEV_SETUP) {
1131
1132 len = min_t(size_t, len, dev->setup_wLength);
1133 if (dev->setup_in) {
1134 retval = setup_req (dev->gadget->ep0, dev->req, len);
1135 if (retval == 0) {
1136 dev->state = STATE_DEV_CONNECTED;
1137 ++dev->udc_usage;
1138 spin_unlock_irq (&dev->lock);
1139 if (copy_from_user (dev->req->buf, buf, len))
1140 retval = -EFAULT;
1141 else {
1142 if (len < dev->setup_wLength)
1143 dev->req->zero = 1;
1144 retval = usb_ep_queue (
1145 dev->gadget->ep0, dev->req,
1146 GFP_KERNEL);
1147 }
1148 spin_lock_irq(&dev->lock);
1149 --dev->udc_usage;
1150 if (retval < 0) {
1151 clean_req (dev->gadget->ep0, dev->req);
1152 } else
1153 retval = len;
1154
1155 return retval;
1156 }
1157
1158 /* can stall some OUT transfers */
1159 } else if (dev->setup_can_stall) {
1160 VDEBUG(dev, "ep0out stall\n");
1161 (void) usb_ep_set_halt (dev->gadget->ep0);
1162 retval = -EL2HLT;
1163 dev->state = STATE_DEV_CONNECTED;
1164 } else {
1165 DBG(dev, "bogus ep0out stall!\n");
1166 }
1167 } else
1168 DBG (dev, "fail %s, state %d\n", __func__, dev->state);
1169
1170 return retval;
1171}
1172
1173static int
1174ep0_fasync (int f, struct file *fd, int on)
1175{
1176 struct dev_data *dev = fd->private_data;
1177 // caller must F_SETOWN before signal delivery happens
1178 VDEBUG (dev, "%s %s\n", __func__, on ? "on" : "off");
1179 return fasync_helper (f, fd, on, &dev->fasync);
1180}
1181
1182static struct usb_gadget_driver gadgetfs_driver;
1183
1184static int
1185dev_release (struct inode *inode, struct file *fd)
1186{
1187 struct dev_data *dev = fd->private_data;
1188
1189 /* closing ep0 === shutdown all */
1190
1191 if (dev->gadget_registered) {
1192 usb_gadget_unregister_driver (&gadgetfs_driver);
1193 dev->gadget_registered = false;
1194 }
1195
1196 /* at this point "good" hardware has disconnected the
1197 * device from USB; the host won't see it any more.
1198 * alternatively, all host requests will time out.
1199 */
1200
1201 kfree (dev->buf);
1202 dev->buf = NULL;
1203
1204 /* other endpoints were all decoupled from this device */
1205 spin_lock_irq(&dev->lock);
1206 dev->state = STATE_DEV_DISABLED;
1207 spin_unlock_irq(&dev->lock);
1208
1209 put_dev (dev);
1210 return 0;
1211}
1212
1213static __poll_t
1214ep0_poll (struct file *fd, poll_table *wait)
1215{
1216 struct dev_data *dev = fd->private_data;
1217 __poll_t mask = 0;
1218
1219 if (dev->state <= STATE_DEV_OPENED)
1220 return DEFAULT_POLLMASK;
1221
1222 poll_wait(fd, &dev->wait, wait);
1223
1224 spin_lock_irq(&dev->lock);
1225
1226 /* report fd mode change before acting on it */
1227 if (dev->setup_abort) {
1228 dev->setup_abort = 0;
1229 mask = EPOLLHUP;
1230 goto out;
1231 }
1232
1233 if (dev->state == STATE_DEV_SETUP) {
1234 if (dev->setup_in || dev->setup_can_stall)
1235 mask = EPOLLOUT;
1236 } else {
1237 if (dev->ev_next != 0)
1238 mask = EPOLLIN;
1239 }
1240out:
1241 spin_unlock_irq(&dev->lock);
1242 return mask;
1243}
1244
1245static long dev_ioctl (struct file *fd, unsigned code, unsigned long value)
1246{
1247 struct dev_data *dev = fd->private_data;
1248 struct usb_gadget *gadget = dev->gadget;
1249 long ret = -ENOTTY;
1250
1251 spin_lock_irq(&dev->lock);
1252 if (dev->state == STATE_DEV_OPENED ||
1253 dev->state == STATE_DEV_UNBOUND) {
1254 /* Not bound to a UDC */
1255 } else if (gadget->ops->ioctl) {
1256 ++dev->udc_usage;
1257 spin_unlock_irq(&dev->lock);
1258
1259 ret = gadget->ops->ioctl (gadget, code, value);
1260
1261 spin_lock_irq(&dev->lock);
1262 --dev->udc_usage;
1263 }
1264 spin_unlock_irq(&dev->lock);
1265
1266 return ret;
1267}
1268
1269/*----------------------------------------------------------------------*/
1270
1271/* The in-kernel gadget driver handles most ep0 issues, in particular
1272 * enumerating the single configuration (as provided from user space).
1273 *
1274 * Unrecognized ep0 requests may be handled in user space.
1275 */
1276
1277static void make_qualifier (struct dev_data *dev)
1278{
1279 struct usb_qualifier_descriptor qual;
1280 struct usb_device_descriptor *desc;
1281
1282 qual.bLength = sizeof qual;
1283 qual.bDescriptorType = USB_DT_DEVICE_QUALIFIER;
1284 qual.bcdUSB = cpu_to_le16 (0x0200);
1285
1286 desc = dev->dev;
1287 qual.bDeviceClass = desc->bDeviceClass;
1288 qual.bDeviceSubClass = desc->bDeviceSubClass;
1289 qual.bDeviceProtocol = desc->bDeviceProtocol;
1290
1291 /* assumes ep0 uses the same value for both speeds ... */
1292 qual.bMaxPacketSize0 = dev->gadget->ep0->maxpacket;
1293
1294 qual.bNumConfigurations = 1;
1295 qual.bRESERVED = 0;
1296
1297 memcpy (dev->rbuf, &qual, sizeof qual);
1298}
1299
1300static int
1301config_buf (struct dev_data *dev, u8 type, unsigned index)
1302{
1303 int len;
1304 int hs = 0;
1305
1306 /* only one configuration */
1307 if (index > 0)
1308 return -EINVAL;
1309
1310 if (gadget_is_dualspeed(dev->gadget)) {
1311 hs = (dev->gadget->speed == USB_SPEED_HIGH);
1312 if (type == USB_DT_OTHER_SPEED_CONFIG)
1313 hs = !hs;
1314 }
1315 if (hs) {
1316 dev->req->buf = dev->hs_config;
1317 len = le16_to_cpu(dev->hs_config->wTotalLength);
1318 } else {
1319 dev->req->buf = dev->config;
1320 len = le16_to_cpu(dev->config->wTotalLength);
1321 }
1322 ((u8 *)dev->req->buf) [1] = type;
1323 return len;
1324}
1325
1326static int
1327gadgetfs_setup (struct usb_gadget *gadget, const struct usb_ctrlrequest *ctrl)
1328{
1329 struct dev_data *dev = get_gadget_data (gadget);
1330 struct usb_request *req = dev->req;
1331 int value = -EOPNOTSUPP;
1332 struct usb_gadgetfs_event *event;
1333 u16 w_value = le16_to_cpu(ctrl->wValue);
1334 u16 w_length = le16_to_cpu(ctrl->wLength);
1335
1336 spin_lock (&dev->lock);
1337 dev->setup_abort = 0;
1338 if (dev->state == STATE_DEV_UNCONNECTED) {
1339 if (gadget_is_dualspeed(gadget)
1340 && gadget->speed == USB_SPEED_HIGH
1341 && dev->hs_config == NULL) {
1342 spin_unlock(&dev->lock);
1343 ERROR (dev, "no high speed config??\n");
1344 return -EINVAL;
1345 }
1346
1347 dev->state = STATE_DEV_CONNECTED;
1348
1349 INFO (dev, "connected\n");
1350 event = next_event (dev, GADGETFS_CONNECT);
1351 event->u.speed = gadget->speed;
1352 ep0_readable (dev);
1353
1354 /* host may have given up waiting for response. we can miss control
1355 * requests handled lower down (device/endpoint status and features);
1356 * then ep0_{read,write} will report the wrong status. controller
1357 * driver will have aborted pending i/o.
1358 */
1359 } else if (dev->state == STATE_DEV_SETUP)
1360 dev->setup_abort = 1;
1361
1362 req->buf = dev->rbuf;
1363 req->context = NULL;
1364 value = -EOPNOTSUPP;
1365 switch (ctrl->bRequest) {
1366
1367 case USB_REQ_GET_DESCRIPTOR:
1368 if (ctrl->bRequestType != USB_DIR_IN)
1369 goto unrecognized;
1370 switch (w_value >> 8) {
1371
1372 case USB_DT_DEVICE:
1373 value = min (w_length, (u16) sizeof *dev->dev);
1374 dev->dev->bMaxPacketSize0 = dev->gadget->ep0->maxpacket;
1375 req->buf = dev->dev;
1376 break;
1377 case USB_DT_DEVICE_QUALIFIER:
1378 if (!dev->hs_config)
1379 break;
1380 value = min (w_length, (u16)
1381 sizeof (struct usb_qualifier_descriptor));
1382 make_qualifier (dev);
1383 break;
1384 case USB_DT_OTHER_SPEED_CONFIG:
1385 // FALLTHROUGH
1386 case USB_DT_CONFIG:
1387 value = config_buf (dev,
1388 w_value >> 8,
1389 w_value & 0xff);
1390 if (value >= 0)
1391 value = min (w_length, (u16) value);
1392 break;
1393 case USB_DT_STRING:
1394 goto unrecognized;
1395
1396 default: // all others are errors
1397 break;
1398 }
1399 break;
1400
1401 /* currently one config, two speeds */
1402 case USB_REQ_SET_CONFIGURATION:
1403 if (ctrl->bRequestType != 0)
1404 goto unrecognized;
1405 if (0 == (u8) w_value) {
1406 value = 0;
1407 dev->current_config = 0;
1408 usb_gadget_vbus_draw(gadget, 8 /* mA */ );
1409 // user mode expected to disable endpoints
1410 } else {
1411 u8 config, power;
1412
1413 if (gadget_is_dualspeed(gadget)
1414 && gadget->speed == USB_SPEED_HIGH) {
1415 config = dev->hs_config->bConfigurationValue;
1416 power = dev->hs_config->bMaxPower;
1417 } else {
1418 config = dev->config->bConfigurationValue;
1419 power = dev->config->bMaxPower;
1420 }
1421
1422 if (config == (u8) w_value) {
1423 value = 0;
1424 dev->current_config = config;
1425 usb_gadget_vbus_draw(gadget, 2 * power);
1426 }
1427 }
1428
1429 /* report SET_CONFIGURATION like any other control request,
1430 * except that usermode may not stall this. the next
1431 * request mustn't be allowed start until this finishes:
1432 * endpoints and threads set up, etc.
1433 *
1434 * NOTE: older PXA hardware (before PXA 255: without UDCCFR)
1435 * has bad/racey automagic that prevents synchronizing here.
1436 * even kernel mode drivers often miss them.
1437 */
1438 if (value == 0) {
1439 INFO (dev, "configuration #%d\n", dev->current_config);
1440 usb_gadget_set_state(gadget, USB_STATE_CONFIGURED);
1441 if (dev->usermode_setup) {
1442 dev->setup_can_stall = 0;
1443 goto delegate;
1444 }
1445 }
1446 break;
1447
1448#ifndef CONFIG_USB_PXA25X
1449 /* PXA automagically handles this request too */
1450 case USB_REQ_GET_CONFIGURATION:
1451 if (ctrl->bRequestType != 0x80)
1452 goto unrecognized;
1453 *(u8 *)req->buf = dev->current_config;
1454 value = min (w_length, (u16) 1);
1455 break;
1456#endif
1457
1458 default:
1459unrecognized:
1460 VDEBUG (dev, "%s req%02x.%02x v%04x i%04x l%d\n",
1461 dev->usermode_setup ? "delegate" : "fail",
1462 ctrl->bRequestType, ctrl->bRequest,
1463 w_value, le16_to_cpu(ctrl->wIndex), w_length);
1464
1465 /* if there's an ep0 reader, don't stall */
1466 if (dev->usermode_setup) {
1467 dev->setup_can_stall = 1;
1468delegate:
1469 dev->setup_in = (ctrl->bRequestType & USB_DIR_IN)
1470 ? 1 : 0;
1471 dev->setup_wLength = w_length;
1472 dev->setup_out_ready = 0;
1473 dev->setup_out_error = 0;
1474
1475 /* read DATA stage for OUT right away */
1476 if (unlikely (!dev->setup_in && w_length)) {
1477 value = setup_req (gadget->ep0, dev->req,
1478 w_length);
1479 if (value < 0)
1480 break;
1481
1482 ++dev->udc_usage;
1483 spin_unlock (&dev->lock);
1484 value = usb_ep_queue (gadget->ep0, dev->req,
1485 GFP_KERNEL);
1486 spin_lock (&dev->lock);
1487 --dev->udc_usage;
1488 if (value < 0) {
1489 clean_req (gadget->ep0, dev->req);
1490 break;
1491 }
1492
1493 /* we can't currently stall these */
1494 dev->setup_can_stall = 0;
1495 }
1496
1497 /* state changes when reader collects event */
1498 event = next_event (dev, GADGETFS_SETUP);
1499 event->u.setup = *ctrl;
1500 ep0_readable (dev);
1501 spin_unlock (&dev->lock);
1502 return 0;
1503 }
1504 }
1505
1506 /* proceed with data transfer and status phases? */
1507 if (value >= 0 && dev->state != STATE_DEV_SETUP) {
1508 req->length = value;
1509 req->zero = value < w_length;
1510
1511 ++dev->udc_usage;
1512 spin_unlock (&dev->lock);
1513 value = usb_ep_queue (gadget->ep0, req, GFP_KERNEL);
1514 spin_lock(&dev->lock);
1515 --dev->udc_usage;
1516 spin_unlock(&dev->lock);
1517 if (value < 0) {
1518 DBG (dev, "ep_queue --> %d\n", value);
1519 req->status = 0;
1520 }
1521 return value;
1522 }
1523
1524 /* device stalls when value < 0 */
1525 spin_unlock (&dev->lock);
1526 return value;
1527}
1528
1529static void destroy_ep_files (struct dev_data *dev)
1530{
1531 DBG (dev, "%s %d\n", __func__, dev->state);
1532
1533 /* dev->state must prevent interference */
1534 spin_lock_irq (&dev->lock);
1535 while (!list_empty(&dev->epfiles)) {
1536 struct ep_data *ep;
1537 struct inode *parent;
1538 struct dentry *dentry;
1539
1540 /* break link to FS */
1541 ep = list_first_entry (&dev->epfiles, struct ep_data, epfiles);
1542 list_del_init (&ep->epfiles);
1543 spin_unlock_irq (&dev->lock);
1544
1545 dentry = ep->dentry;
1546 ep->dentry = NULL;
1547 parent = d_inode(dentry->d_parent);
1548
1549 /* break link to controller */
1550 mutex_lock(&ep->lock);
1551 if (ep->state == STATE_EP_ENABLED)
1552 (void) usb_ep_disable (ep->ep);
1553 ep->state = STATE_EP_UNBOUND;
1554 usb_ep_free_request (ep->ep, ep->req);
1555 ep->ep = NULL;
1556 mutex_unlock(&ep->lock);
1557
1558 wake_up (&ep->wait);
1559 put_ep (ep);
1560
1561 /* break link to dcache */
1562 inode_lock(parent);
1563 d_delete (dentry);
1564 dput (dentry);
1565 inode_unlock(parent);
1566
1567 spin_lock_irq (&dev->lock);
1568 }
1569 spin_unlock_irq (&dev->lock);
1570}
1571
1572
1573static struct dentry *
1574gadgetfs_create_file (struct super_block *sb, char const *name,
1575 void *data, const struct file_operations *fops);
1576
1577static int activate_ep_files (struct dev_data *dev)
1578{
1579 struct usb_ep *ep;
1580 struct ep_data *data;
1581
1582 gadget_for_each_ep (ep, dev->gadget) {
1583
1584 data = kzalloc(sizeof(*data), GFP_KERNEL);
1585 if (!data)
1586 goto enomem0;
1587 data->state = STATE_EP_DISABLED;
1588 mutex_init(&data->lock);
1589 init_waitqueue_head (&data->wait);
1590
1591 strncpy (data->name, ep->name, sizeof (data->name) - 1);
1592 refcount_set (&data->count, 1);
1593 data->dev = dev;
1594 get_dev (dev);
1595
1596 data->ep = ep;
1597 ep->driver_data = data;
1598
1599 data->req = usb_ep_alloc_request (ep, GFP_KERNEL);
1600 if (!data->req)
1601 goto enomem1;
1602
1603 data->dentry = gadgetfs_create_file (dev->sb, data->name,
1604 data, &ep_io_operations);
1605 if (!data->dentry)
1606 goto enomem2;
1607 list_add_tail (&data->epfiles, &dev->epfiles);
1608 }
1609 return 0;
1610
1611enomem2:
1612 usb_ep_free_request (ep, data->req);
1613enomem1:
1614 put_dev (dev);
1615 kfree (data);
1616enomem0:
1617 DBG (dev, "%s enomem\n", __func__);
1618 destroy_ep_files (dev);
1619 return -ENOMEM;
1620}
1621
1622static void
1623gadgetfs_unbind (struct usb_gadget *gadget)
1624{
1625 struct dev_data *dev = get_gadget_data (gadget);
1626
1627 DBG (dev, "%s\n", __func__);
1628
1629 spin_lock_irq (&dev->lock);
1630 dev->state = STATE_DEV_UNBOUND;
1631 while (dev->udc_usage > 0) {
1632 spin_unlock_irq(&dev->lock);
1633 usleep_range(1000, 2000);
1634 spin_lock_irq(&dev->lock);
1635 }
1636 spin_unlock_irq (&dev->lock);
1637
1638 destroy_ep_files (dev);
1639 gadget->ep0->driver_data = NULL;
1640 set_gadget_data (gadget, NULL);
1641
1642 /* we've already been disconnected ... no i/o is active */
1643 if (dev->req)
1644 usb_ep_free_request (gadget->ep0, dev->req);
1645 DBG (dev, "%s done\n", __func__);
1646 put_dev (dev);
1647}
1648
1649static struct dev_data *the_device;
1650
1651static int gadgetfs_bind(struct usb_gadget *gadget,
1652 struct usb_gadget_driver *driver)
1653{
1654 struct dev_data *dev = the_device;
1655
1656 if (!dev)
1657 return -ESRCH;
1658 if (0 != strcmp (CHIP, gadget->name)) {
1659 pr_err("%s expected %s controller not %s\n",
1660 shortname, CHIP, gadget->name);
1661 return -ENODEV;
1662 }
1663
1664 set_gadget_data (gadget, dev);
1665 dev->gadget = gadget;
1666 gadget->ep0->driver_data = dev;
1667
1668 /* preallocate control response and buffer */
1669 dev->req = usb_ep_alloc_request (gadget->ep0, GFP_KERNEL);
1670 if (!dev->req)
1671 goto enomem;
1672 dev->req->context = NULL;
1673 dev->req->complete = epio_complete;
1674
1675 if (activate_ep_files (dev) < 0)
1676 goto enomem;
1677
1678 INFO (dev, "bound to %s driver\n", gadget->name);
1679 spin_lock_irq(&dev->lock);
1680 dev->state = STATE_DEV_UNCONNECTED;
1681 spin_unlock_irq(&dev->lock);
1682 get_dev (dev);
1683 return 0;
1684
1685enomem:
1686 gadgetfs_unbind (gadget);
1687 return -ENOMEM;
1688}
1689
1690static void
1691gadgetfs_disconnect (struct usb_gadget *gadget)
1692{
1693 struct dev_data *dev = get_gadget_data (gadget);
1694 unsigned long flags;
1695
1696 spin_lock_irqsave (&dev->lock, flags);
1697 if (dev->state == STATE_DEV_UNCONNECTED)
1698 goto exit;
1699 dev->state = STATE_DEV_UNCONNECTED;
1700
1701 INFO (dev, "disconnected\n");
1702 next_event (dev, GADGETFS_DISCONNECT);
1703 ep0_readable (dev);
1704exit:
1705 spin_unlock_irqrestore (&dev->lock, flags);
1706}
1707
1708static void
1709gadgetfs_suspend (struct usb_gadget *gadget)
1710{
1711 struct dev_data *dev = get_gadget_data (gadget);
1712 unsigned long flags;
1713
1714 INFO (dev, "suspended from state %d\n", dev->state);
1715 spin_lock_irqsave(&dev->lock, flags);
1716 switch (dev->state) {
1717 case STATE_DEV_SETUP: // VERY odd... host died??
1718 case STATE_DEV_CONNECTED:
1719 case STATE_DEV_UNCONNECTED:
1720 next_event (dev, GADGETFS_SUSPEND);
1721 ep0_readable (dev);
1722 /* FALLTHROUGH */
1723 default:
1724 break;
1725 }
1726 spin_unlock_irqrestore(&dev->lock, flags);
1727}
1728
1729static struct usb_gadget_driver gadgetfs_driver = {
1730 .function = (char *) driver_desc,
1731 .bind = gadgetfs_bind,
1732 .unbind = gadgetfs_unbind,
1733 .setup = gadgetfs_setup,
1734 .reset = gadgetfs_disconnect,
1735 .disconnect = gadgetfs_disconnect,
1736 .suspend = gadgetfs_suspend,
1737
1738 .driver = {
1739 .name = (char *) shortname,
1740 },
1741};
1742
1743/*----------------------------------------------------------------------*/
1744/* DEVICE INITIALIZATION
1745 *
1746 * fd = open ("/dev/gadget/$CHIP", O_RDWR)
1747 * status = write (fd, descriptors, sizeof descriptors)
1748 *
1749 * That write establishes the device configuration, so the kernel can
1750 * bind to the controller ... guaranteeing it can handle enumeration
1751 * at all necessary speeds. Descriptor order is:
1752 *
1753 * . message tag (u32, host order) ... for now, must be zero; it
1754 * would change to support features like multi-config devices
1755 * . full/low speed config ... all wTotalLength bytes (with interface,
1756 * class, altsetting, endpoint, and other descriptors)
1757 * . high speed config ... all descriptors, for high speed operation;
1758 * this one's optional except for high-speed hardware
1759 * . device descriptor
1760 *
1761 * Endpoints are not yet enabled. Drivers must wait until device
1762 * configuration and interface altsetting changes create
1763 * the need to configure (or unconfigure) them.
1764 *
1765 * After initialization, the device stays active for as long as that
1766 * $CHIP file is open. Events must then be read from that descriptor,
1767 * such as configuration notifications.
1768 */
1769
1770static int is_valid_config(struct usb_config_descriptor *config,
1771 unsigned int total)
1772{
1773 return config->bDescriptorType == USB_DT_CONFIG
1774 && config->bLength == USB_DT_CONFIG_SIZE
1775 && total >= USB_DT_CONFIG_SIZE
1776 && config->bConfigurationValue != 0
1777 && (config->bmAttributes & USB_CONFIG_ATT_ONE) != 0
1778 && (config->bmAttributes & USB_CONFIG_ATT_WAKEUP) == 0;
1779 /* FIXME if gadget->is_otg, _must_ include an otg descriptor */
1780 /* FIXME check lengths: walk to end */
1781}
1782
1783static ssize_t
1784dev_config (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
1785{
1786 struct dev_data *dev = fd->private_data;
1787 ssize_t value = len, length = len;
1788 unsigned total;
1789 u32 tag;
1790 char *kbuf;
1791
1792 spin_lock_irq(&dev->lock);
1793 if (dev->state > STATE_DEV_OPENED) {
1794 value = ep0_write(fd, buf, len, ptr);
1795 spin_unlock_irq(&dev->lock);
1796 return value;
1797 }
1798 spin_unlock_irq(&dev->lock);
1799
1800 if ((len < (USB_DT_CONFIG_SIZE + USB_DT_DEVICE_SIZE + 4)) ||
1801 (len > PAGE_SIZE * 4))
1802 return -EINVAL;
1803
1804 /* we might need to change message format someday */
1805 if (copy_from_user (&tag, buf, 4))
1806 return -EFAULT;
1807 if (tag != 0)
1808 return -EINVAL;
1809 buf += 4;
1810 length -= 4;
1811
1812 kbuf = memdup_user(buf, length);
1813 if (IS_ERR(kbuf))
1814 return PTR_ERR(kbuf);
1815
1816 spin_lock_irq (&dev->lock);
1817 value = -EINVAL;
1818 if (dev->buf) {
1819 kfree(kbuf);
1820 goto fail;
1821 }
1822 dev->buf = kbuf;
1823
1824 /* full or low speed config */
1825 dev->config = (void *) kbuf;
1826 total = le16_to_cpu(dev->config->wTotalLength);
1827 if (!is_valid_config(dev->config, total) ||
1828 total > length - USB_DT_DEVICE_SIZE)
1829 goto fail;
1830 kbuf += total;
1831 length -= total;
1832
1833 /* optional high speed config */
1834 if (kbuf [1] == USB_DT_CONFIG) {
1835 dev->hs_config = (void *) kbuf;
1836 total = le16_to_cpu(dev->hs_config->wTotalLength);
1837 if (!is_valid_config(dev->hs_config, total) ||
1838 total > length - USB_DT_DEVICE_SIZE)
1839 goto fail;
1840 kbuf += total;
1841 length -= total;
1842 } else {
1843 dev->hs_config = NULL;
1844 }
1845
1846 /* could support multiple configs, using another encoding! */
1847
1848 /* device descriptor (tweaked for paranoia) */
1849 if (length != USB_DT_DEVICE_SIZE)
1850 goto fail;
1851 dev->dev = (void *)kbuf;
1852 if (dev->dev->bLength != USB_DT_DEVICE_SIZE
1853 || dev->dev->bDescriptorType != USB_DT_DEVICE
1854 || dev->dev->bNumConfigurations != 1)
1855 goto fail;
1856 dev->dev->bcdUSB = cpu_to_le16 (0x0200);
1857
1858 /* triggers gadgetfs_bind(); then we can enumerate. */
1859 spin_unlock_irq (&dev->lock);
1860 if (dev->hs_config)
1861 gadgetfs_driver.max_speed = USB_SPEED_HIGH;
1862 else
1863 gadgetfs_driver.max_speed = USB_SPEED_FULL;
1864
1865 value = usb_gadget_probe_driver(&gadgetfs_driver);
1866 if (value != 0) {
1867 kfree (dev->buf);
1868 dev->buf = NULL;
1869 } else {
1870 /* at this point "good" hardware has for the first time
1871 * let the USB the host see us. alternatively, if users
1872 * unplug/replug that will clear all the error state.
1873 *
1874 * note: everything running before here was guaranteed
1875 * to choke driver model style diagnostics. from here
1876 * on, they can work ... except in cleanup paths that
1877 * kick in after the ep0 descriptor is closed.
1878 */
1879 value = len;
1880 dev->gadget_registered = true;
1881 }
1882 return value;
1883
1884fail:
1885 spin_unlock_irq (&dev->lock);
1886 pr_debug ("%s: %s fail %zd, %p\n", shortname, __func__, value, dev);
1887 kfree (dev->buf);
1888 dev->buf = NULL;
1889 return value;
1890}
1891
1892static int
1893dev_open (struct inode *inode, struct file *fd)
1894{
1895 struct dev_data *dev = inode->i_private;
1896 int value = -EBUSY;
1897
1898 spin_lock_irq(&dev->lock);
1899 if (dev->state == STATE_DEV_DISABLED) {
1900 dev->ev_next = 0;
1901 dev->state = STATE_DEV_OPENED;
1902 fd->private_data = dev;
1903 get_dev (dev);
1904 value = 0;
1905 }
1906 spin_unlock_irq(&dev->lock);
1907 return value;
1908}
1909
1910static const struct file_operations ep0_operations = {
1911 .llseek = no_llseek,
1912
1913 .open = dev_open,
1914 .read = ep0_read,
1915 .write = dev_config,
1916 .fasync = ep0_fasync,
1917 .poll = ep0_poll,
1918 .unlocked_ioctl = dev_ioctl,
1919 .release = dev_release,
1920};
1921
1922/*----------------------------------------------------------------------*/
1923
1924/* FILESYSTEM AND SUPERBLOCK OPERATIONS
1925 *
1926 * Mounting the filesystem creates a controller file, used first for
1927 * device configuration then later for event monitoring.
1928 */
1929
1930
1931/* FIXME PAM etc could set this security policy without mount options
1932 * if epfiles inherited ownership and permissons from ep0 ...
1933 */
1934
1935static unsigned default_uid;
1936static unsigned default_gid;
1937static unsigned default_perm = S_IRUSR | S_IWUSR;
1938
1939module_param (default_uid, uint, 0644);
1940module_param (default_gid, uint, 0644);
1941module_param (default_perm, uint, 0644);
1942
1943
1944static struct inode *
1945gadgetfs_make_inode (struct super_block *sb,
1946 void *data, const struct file_operations *fops,
1947 int mode)
1948{
1949 struct inode *inode = new_inode (sb);
1950
1951 if (inode) {
1952 inode->i_ino = get_next_ino();
1953 inode->i_mode = mode;
1954 inode->i_uid = make_kuid(&init_user_ns, default_uid);
1955 inode->i_gid = make_kgid(&init_user_ns, default_gid);
1956 inode->i_atime = inode->i_mtime = inode->i_ctime
1957 = current_time(inode);
1958 inode->i_private = data;
1959 inode->i_fop = fops;
1960 }
1961 return inode;
1962}
1963
1964/* creates in fs root directory, so non-renamable and non-linkable.
1965 * so inode and dentry are paired, until device reconfig.
1966 */
1967static struct dentry *
1968gadgetfs_create_file (struct super_block *sb, char const *name,
1969 void *data, const struct file_operations *fops)
1970{
1971 struct dentry *dentry;
1972 struct inode *inode;
1973
1974 dentry = d_alloc_name(sb->s_root, name);
1975 if (!dentry)
1976 return NULL;
1977
1978 inode = gadgetfs_make_inode (sb, data, fops,
1979 S_IFREG | (default_perm & S_IRWXUGO));
1980 if (!inode) {
1981 dput(dentry);
1982 return NULL;
1983 }
1984 d_add (dentry, inode);
1985 return dentry;
1986}
1987
1988static const struct super_operations gadget_fs_operations = {
1989 .statfs = simple_statfs,
1990 .drop_inode = generic_delete_inode,
1991};
1992
1993static int
1994gadgetfs_fill_super (struct super_block *sb, struct fs_context *fc)
1995{
1996 struct inode *inode;
1997 struct dev_data *dev;
1998
1999 if (the_device)
2000 return -ESRCH;
2001
2002 CHIP = usb_get_gadget_udc_name();
2003 if (!CHIP)
2004 return -ENODEV;
2005
2006 /* superblock */
2007 sb->s_blocksize = PAGE_SIZE;
2008 sb->s_blocksize_bits = PAGE_SHIFT;
2009 sb->s_magic = GADGETFS_MAGIC;
2010 sb->s_op = &gadget_fs_operations;
2011 sb->s_time_gran = 1;
2012
2013 /* root inode */
2014 inode = gadgetfs_make_inode (sb,
2015 NULL, &simple_dir_operations,
2016 S_IFDIR | S_IRUGO | S_IXUGO);
2017 if (!inode)
2018 goto Enomem;
2019 inode->i_op = &simple_dir_inode_operations;
2020 if (!(sb->s_root = d_make_root (inode)))
2021 goto Enomem;
2022
2023 /* the ep0 file is named after the controller we expect;
2024 * user mode code can use it for sanity checks, like we do.
2025 */
2026 dev = dev_new ();
2027 if (!dev)
2028 goto Enomem;
2029
2030 dev->sb = sb;
2031 dev->dentry = gadgetfs_create_file(sb, CHIP, dev, &ep0_operations);
2032 if (!dev->dentry) {
2033 put_dev(dev);
2034 goto Enomem;
2035 }
2036
2037 /* other endpoint files are available after hardware setup,
2038 * from binding to a controller.
2039 */
2040 the_device = dev;
2041 return 0;
2042
2043Enomem:
2044 return -ENOMEM;
2045}
2046
2047/* "mount -t gadgetfs path /dev/gadget" ends up here */
2048static int gadgetfs_get_tree(struct fs_context *fc)
2049{
2050 return get_tree_single(fc, gadgetfs_fill_super);
2051}
2052
2053static const struct fs_context_operations gadgetfs_context_ops = {
2054 .get_tree = gadgetfs_get_tree,
2055};
2056
2057static int gadgetfs_init_fs_context(struct fs_context *fc)
2058{
2059 fc->ops = &gadgetfs_context_ops;
2060 return 0;
2061}
2062
2063static void
2064gadgetfs_kill_sb (struct super_block *sb)
2065{
2066 kill_litter_super (sb);
2067 if (the_device) {
2068 put_dev (the_device);
2069 the_device = NULL;
2070 }
2071 kfree(CHIP);
2072 CHIP = NULL;
2073}
2074
2075/*----------------------------------------------------------------------*/
2076
2077static struct file_system_type gadgetfs_type = {
2078 .owner = THIS_MODULE,
2079 .name = shortname,
2080 .init_fs_context = gadgetfs_init_fs_context,
2081 .kill_sb = gadgetfs_kill_sb,
2082};
2083MODULE_ALIAS_FS("gadgetfs");
2084
2085/*----------------------------------------------------------------------*/
2086
2087static int __init init (void)
2088{
2089 int status;
2090
2091 status = register_filesystem (&gadgetfs_type);
2092 if (status == 0)
2093 pr_info ("%s: %s, version " DRIVER_VERSION "\n",
2094 shortname, driver_desc);
2095 return status;
2096}
2097module_init (init);
2098
2099static void __exit cleanup (void)
2100{
2101 pr_debug ("unregister %s\n", shortname);
2102 unregister_filesystem (&gadgetfs_type);
2103}
2104module_exit (cleanup);
2105