2 * inode.c -- user mode filesystem api for usb gadget controllers
4 * Copyright (C) 2003-2004 David Brownell
5 * Copyright (C) 2003 Agilent Technologies
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
14 /* #define VERBOSE_DEBUG */
16 #include <linux/init.h>
17 #include <linux/module.h>
19 #include <linux/pagemap.h>
20 #include <linux/uts.h>
21 #include <linux/wait.h>
22 #include <linux/compiler.h>
23 #include <asm/uaccess.h>
24 #include <linux/sched.h>
25 #include <linux/slab.h>
26 #include <linux/poll.h>
27 #include <linux/mmu_context.h>
28 #include <linux/aio.h>
29 #include <linux/uio.h>
30 #include <linux/delay.h>
31 #include <linux/device.h>
32 #include <linux/moduleparam.h>
34 #include <linux/usb/gadgetfs.h>
35 #include <linux/usb/gadget.h>
39 * The gadgetfs API maps each endpoint to a file descriptor so that you
40 * can use standard synchronous read/write calls for I/O. There's some
41 * O_NONBLOCK and O_ASYNC/FASYNC style i/o support. Example usermode
42 * drivers show how this works in practice. You can also use AIO to
43 * eliminate I/O gaps between requests, to help when streaming data.
45 * Key parts that must be USB-specific are protocols defining how the
46 * read/write operations relate to the hardware state machines. There
47 * are two types of files. One type is for the device, implementing ep0.
48 * The other type is for each IN or OUT endpoint. In both cases, the
49 * user mode driver must configure the hardware before using it.
51 * - First, dev_config() is called when /dev/gadget/$CHIP is configured
52 * (by writing configuration and device descriptors). Afterwards it
53 * may serve as a source of device events, used to handle all control
54 * requests other than basic enumeration.
56 * - Then, after a SET_CONFIGURATION control request, ep_config() is
57 * called when each /dev/gadget/ep* file is configured (by writing
58 * endpoint descriptors). Afterwards these files are used to write()
59 * IN data or to read() OUT data. To halt the endpoint, a "wrong
60 * direction" request is issued (like reading an IN endpoint).
62 * Unlike "usbfs" the only ioctl()s are for things that are rare, and maybe
63 * not possible on all hardware. For example, precise fault handling with
64 * respect to data left in endpoint fifos after aborted operations; or
65 * selective clearing of endpoint halts, to implement SET_INTERFACE.
68 #define DRIVER_DESC "USB Gadget filesystem"
69 #define DRIVER_VERSION "24 Aug 2004"
71 static const char driver_desc [] = DRIVER_DESC;
72 static const char shortname [] = "gadgetfs";
74 MODULE_DESCRIPTION (DRIVER_DESC);
75 MODULE_AUTHOR ("David Brownell");
76 MODULE_LICENSE ("GPL");
78 static int ep_open(struct inode *, struct file *);
81 /*----------------------------------------------------------------------*/
83 #define GADGETFS_MAGIC 0xaee71ee7
85 /* /dev/gadget/$CHIP represents ep0 and the whole device */
87 /* DISBLED is the initial state.
89 STATE_DEV_DISABLED = 0,
91 /* Only one open() of /dev/gadget/$CHIP; only one file tracks
92 * ep0/device i/o modes and binding to the controller. Driver
93 * must always write descriptors to initialize the device, then
94 * the device becomes UNCONNECTED until enumeration.
98 /* From then on, ep0 fd is in either of two basic modes:
99 * - (UN)CONNECTED: read usb_gadgetfs_event(s) from it
100 * - SETUP: read/write will transfer control data and succeed;
101 * or if "wrong direction", performs protocol stall
103 STATE_DEV_UNCONNECTED,
107 /* UNBOUND means the driver closed ep0, so the device won't be
108 * accessible again (DEV_DISABLED) until all fds are closed.
113 /* enough for the whole queue: most events invalidate others */
116 #define RBUF_SIZE 256
122 enum ep0_state state; /* P: lock */
123 struct usb_gadgetfs_event event [N_EVENT];
125 struct fasync_struct *fasync;
128 /* drivers reading ep0 MUST handle control requests (SETUP)
129 * reported that way; else the host will time out.
131 unsigned usermode_setup : 1,
137 gadget_registered : 1;
138 unsigned setup_wLength;
140 /* the rest is basically write-once */
141 struct usb_config_descriptor *config, *hs_config;
142 struct usb_device_descriptor *dev;
143 struct usb_request *req;
144 struct usb_gadget *gadget;
145 struct list_head epfiles;
147 wait_queue_head_t wait;
148 struct super_block *sb;
149 struct dentry *dentry;
151 /* except this scratch i/o buffer for ep0 */
155 static inline void get_dev (struct dev_data *data)
157 atomic_inc (&data->count);
160 static void put_dev (struct dev_data *data)
162 if (likely (!atomic_dec_and_test (&data->count)))
164 /* needs no more cleanup */
165 BUG_ON (waitqueue_active (&data->wait));
169 static struct dev_data *dev_new (void)
171 struct dev_data *dev;
173 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
176 dev->state = STATE_DEV_DISABLED;
177 atomic_set (&dev->count, 1);
178 spin_lock_init (&dev->lock);
179 INIT_LIST_HEAD (&dev->epfiles);
180 init_waitqueue_head (&dev->wait);
184 /*----------------------------------------------------------------------*/
186 /* other /dev/gadget/$ENDPOINT files represent endpoints */
188 STATE_EP_DISABLED = 0,
198 struct dev_data *dev;
199 /* must hold dev->lock before accessing ep or req */
201 struct usb_request *req;
204 struct usb_endpoint_descriptor desc, hs_desc;
205 struct list_head epfiles;
206 wait_queue_head_t wait;
207 struct dentry *dentry;
210 static inline void get_ep (struct ep_data *data)
212 atomic_inc (&data->count);
215 static void put_ep (struct ep_data *data)
217 if (likely (!atomic_dec_and_test (&data->count)))
220 /* needs no more cleanup */
221 BUG_ON (!list_empty (&data->epfiles));
222 BUG_ON (waitqueue_active (&data->wait));
226 /*----------------------------------------------------------------------*/
228 /* most "how to use the hardware" policy choices are in userspace:
229 * mapping endpoint roles (which the driver needs) to the capabilities
230 * which the usb controller has. most of those capabilities are exposed
231 * implicitly, starting with the driver name and then endpoint names.
234 static const char *CHIP;
236 /*----------------------------------------------------------------------*/
238 /* NOTE: don't use dev_printk calls before binding to the gadget
239 * at the end of ep0 configuration, or after unbind.
242 /* too wordy: dev_printk(level , &(d)->gadget->dev , fmt , ## args) */
243 #define xprintk(d,level,fmt,args...) \
244 printk(level "%s: " fmt , shortname , ## args)
247 #define DBG(dev,fmt,args...) \
248 xprintk(dev , KERN_DEBUG , fmt , ## args)
250 #define DBG(dev,fmt,args...) \
257 #define VDEBUG(dev,fmt,args...) \
261 #define ERROR(dev,fmt,args...) \
262 xprintk(dev , KERN_ERR , fmt , ## args)
263 #define INFO(dev,fmt,args...) \
264 xprintk(dev , KERN_INFO , fmt , ## args)
267 /*----------------------------------------------------------------------*/
269 /* SYNCHRONOUS ENDPOINT OPERATIONS (bulk/intr/iso)
271 * After opening, configure non-control endpoints. Then use normal
272 * stream read() and write() requests; and maybe ioctl() to get more
273 * precise FIFO status when recovering from cancellation.
276 static void epio_complete (struct usb_ep *ep, struct usb_request *req)
278 struct ep_data *epdata = ep->driver_data;
283 epdata->status = req->status;
285 epdata->status = req->actual;
286 complete ((struct completion *)req->context);
289 /* tasklock endpoint, returning when it's connected.
290 * still need dev->lock to use epdata->ep.
293 get_ready_ep (unsigned f_flags, struct ep_data *epdata, bool is_write)
297 if (f_flags & O_NONBLOCK) {
298 if (!mutex_trylock(&epdata->lock))
300 if (epdata->state != STATE_EP_ENABLED &&
301 (!is_write || epdata->state != STATE_EP_READY)) {
302 mutex_unlock(&epdata->lock);
310 val = mutex_lock_interruptible(&epdata->lock);
314 switch (epdata->state) {
315 case STATE_EP_ENABLED:
317 case STATE_EP_READY: /* not configured yet */
321 case STATE_EP_UNBOUND: /* clean disconnect */
323 // case STATE_EP_DISABLED: /* "can't happen" */
324 default: /* error! */
325 pr_debug ("%s: ep %p not available, state %d\n",
326 shortname, epdata, epdata->state);
328 mutex_unlock(&epdata->lock);
333 ep_io (struct ep_data *epdata, void *buf, unsigned len)
335 DECLARE_COMPLETION_ONSTACK (done);
338 spin_lock_irq (&epdata->dev->lock);
339 if (likely (epdata->ep != NULL)) {
340 struct usb_request *req = epdata->req;
342 req->context = &done;
343 req->complete = epio_complete;
346 value = usb_ep_queue (epdata->ep, req, GFP_ATOMIC);
349 spin_unlock_irq (&epdata->dev->lock);
351 if (likely (value == 0)) {
352 value = wait_event_interruptible (done.wait, done.done);
354 spin_lock_irq (&epdata->dev->lock);
355 if (likely (epdata->ep != NULL)) {
356 DBG (epdata->dev, "%s i/o interrupted\n",
358 usb_ep_dequeue (epdata->ep, epdata->req);
359 spin_unlock_irq (&epdata->dev->lock);
361 wait_event (done.wait, done.done);
362 if (epdata->status == -ECONNRESET)
363 epdata->status = -EINTR;
365 spin_unlock_irq (&epdata->dev->lock);
367 DBG (epdata->dev, "endpoint gone\n");
368 wait_for_completion(&done);
369 epdata->status = -ENODEV;
372 return epdata->status;
378 ep_release (struct inode *inode, struct file *fd)
380 struct ep_data *data = fd->private_data;
383 value = mutex_lock_interruptible(&data->lock);
387 /* clean up if this can be reopened */
388 if (data->state != STATE_EP_UNBOUND) {
389 data->state = STATE_EP_DISABLED;
390 data->desc.bDescriptorType = 0;
391 data->hs_desc.bDescriptorType = 0;
392 usb_ep_disable(data->ep);
394 mutex_unlock(&data->lock);
399 static long ep_ioctl(struct file *fd, unsigned code, unsigned long value)
401 struct ep_data *data = fd->private_data;
404 if ((status = get_ready_ep (fd->f_flags, data, false)) < 0)
407 spin_lock_irq (&data->dev->lock);
408 if (likely (data->ep != NULL)) {
410 case GADGETFS_FIFO_STATUS:
411 status = usb_ep_fifo_status (data->ep);
413 case GADGETFS_FIFO_FLUSH:
414 usb_ep_fifo_flush (data->ep);
416 case GADGETFS_CLEAR_HALT:
417 status = usb_ep_clear_halt (data->ep);
424 spin_unlock_irq (&data->dev->lock);
425 mutex_unlock(&data->lock);
429 /*----------------------------------------------------------------------*/
431 /* ASYNCHRONOUS ENDPOINT I/O OPERATIONS (bulk/intr/iso) */
434 struct usb_request *req;
435 struct ep_data *epdata;
437 struct mm_struct *mm;
438 struct work_struct work;
445 static int ep_aio_cancel(struct kiocb *iocb)
447 struct kiocb_priv *priv = iocb->private;
448 struct ep_data *epdata;
452 epdata = priv->epdata;
453 // spin_lock(&epdata->dev->lock);
454 if (likely(epdata && epdata->ep && priv->req))
455 value = usb_ep_dequeue (epdata->ep, priv->req);
458 // spin_unlock(&epdata->dev->lock);
464 static void ep_user_copy_worker(struct work_struct *work)
466 struct kiocb_priv *priv = container_of(work, struct kiocb_priv, work);
467 struct mm_struct *mm = priv->mm;
468 struct kiocb *iocb = priv->iocb;
472 ret = copy_to_iter(priv->buf, priv->actual, &priv->to);
477 /* completing the iocb can drop the ctx and mm, don't touch mm after */
478 iocb->ki_complete(iocb, ret, ret);
481 kfree(priv->to_free);
485 static void ep_aio_complete(struct usb_ep *ep, struct usb_request *req)
487 struct kiocb *iocb = req->context;
488 struct kiocb_priv *priv = iocb->private;
489 struct ep_data *epdata = priv->epdata;
491 /* lock against disconnect (and ideally, cancel) */
492 spin_lock(&epdata->dev->lock);
496 /* if this was a write or a read returning no data then we
497 * don't need to copy anything to userspace, so we can
498 * complete the aio request immediately.
500 if (priv->to_free == NULL || unlikely(req->actual == 0)) {
502 kfree(priv->to_free);
504 iocb->private = NULL;
505 /* aio_complete() reports bytes-transferred _and_ faults */
507 iocb->ki_complete(iocb, req->actual ? req->actual : req->status,
510 /* ep_copy_to_user() won't report both; we hide some faults */
511 if (unlikely(0 != req->status))
512 DBG(epdata->dev, "%s fault %d len %d\n",
513 ep->name, req->status, req->actual);
515 priv->buf = req->buf;
516 priv->actual = req->actual;
517 INIT_WORK(&priv->work, ep_user_copy_worker);
518 schedule_work(&priv->work);
521 usb_ep_free_request(ep, req);
522 spin_unlock(&epdata->dev->lock);
526 static ssize_t ep_aio(struct kiocb *iocb,
527 struct kiocb_priv *priv,
528 struct ep_data *epdata,
532 struct usb_request *req;
535 iocb->private = priv;
538 kiocb_set_cancel_fn(iocb, ep_aio_cancel);
540 priv->epdata = epdata;
542 priv->mm = current->mm; /* mm teardown waits for iocbs in exit_aio() */
544 /* each kiocb is coupled to one usb_request, but we can't
545 * allocate or submit those if the host disconnected.
547 spin_lock_irq(&epdata->dev->lock);
549 if (unlikely(epdata->ep == NULL))
552 req = usb_ep_alloc_request(epdata->ep, GFP_ATOMIC);
560 req->complete = ep_aio_complete;
562 value = usb_ep_queue(epdata->ep, req, GFP_ATOMIC);
563 if (unlikely(0 != value)) {
564 usb_ep_free_request(epdata->ep, req);
567 spin_unlock_irq(&epdata->dev->lock);
571 spin_unlock_irq(&epdata->dev->lock);
572 kfree(priv->to_free);
579 ep_read_iter(struct kiocb *iocb, struct iov_iter *to)
581 struct file *file = iocb->ki_filp;
582 struct ep_data *epdata = file->private_data;
583 size_t len = iov_iter_count(to);
587 if ((value = get_ready_ep(file->f_flags, epdata, false)) < 0)
590 /* halt any endpoint by doing a "wrong direction" i/o call */
591 if (usb_endpoint_dir_in(&epdata->desc)) {
592 if (usb_endpoint_xfer_isoc(&epdata->desc) ||
593 !is_sync_kiocb(iocb)) {
594 mutex_unlock(&epdata->lock);
597 DBG (epdata->dev, "%s halt\n", epdata->name);
598 spin_lock_irq(&epdata->dev->lock);
599 if (likely(epdata->ep != NULL))
600 usb_ep_set_halt(epdata->ep);
601 spin_unlock_irq(&epdata->dev->lock);
602 mutex_unlock(&epdata->lock);
606 buf = kmalloc(len, GFP_KERNEL);
607 if (unlikely(!buf)) {
608 mutex_unlock(&epdata->lock);
611 if (is_sync_kiocb(iocb)) {
612 value = ep_io(epdata, buf, len);
613 if (value >= 0 && (copy_to_iter(buf, value, to) != value))
616 struct kiocb_priv *priv = kzalloc(sizeof *priv, GFP_KERNEL);
620 priv->to_free = dup_iter(&priv->to, to, GFP_KERNEL);
621 if (!priv->to_free) {
625 value = ep_aio(iocb, priv, epdata, buf, len);
626 if (value == -EIOCBQUEUED)
631 mutex_unlock(&epdata->lock);
635 static ssize_t ep_config(struct ep_data *, const char *, size_t);
638 ep_write_iter(struct kiocb *iocb, struct iov_iter *from)
640 struct file *file = iocb->ki_filp;
641 struct ep_data *epdata = file->private_data;
642 size_t len = iov_iter_count(from);
647 if ((value = get_ready_ep(file->f_flags, epdata, true)) < 0)
650 configured = epdata->state == STATE_EP_ENABLED;
652 /* halt any endpoint by doing a "wrong direction" i/o call */
653 if (configured && !usb_endpoint_dir_in(&epdata->desc)) {
654 if (usb_endpoint_xfer_isoc(&epdata->desc) ||
655 !is_sync_kiocb(iocb)) {
656 mutex_unlock(&epdata->lock);
659 DBG (epdata->dev, "%s halt\n", epdata->name);
660 spin_lock_irq(&epdata->dev->lock);
661 if (likely(epdata->ep != NULL))
662 usb_ep_set_halt(epdata->ep);
663 spin_unlock_irq(&epdata->dev->lock);
664 mutex_unlock(&epdata->lock);
668 buf = kmalloc(len, GFP_KERNEL);
669 if (unlikely(!buf)) {
670 mutex_unlock(&epdata->lock);
674 if (unlikely(copy_from_iter(buf, len, from) != len)) {
679 if (unlikely(!configured)) {
680 value = ep_config(epdata, buf, len);
681 } else if (is_sync_kiocb(iocb)) {
682 value = ep_io(epdata, buf, len);
684 struct kiocb_priv *priv = kzalloc(sizeof *priv, GFP_KERNEL);
687 value = ep_aio(iocb, priv, epdata, buf, len);
688 if (value == -EIOCBQUEUED)
694 mutex_unlock(&epdata->lock);
698 /*----------------------------------------------------------------------*/
700 /* used after endpoint configuration */
701 static const struct file_operations ep_io_operations = {
702 .owner = THIS_MODULE,
705 .release = ep_release,
707 .unlocked_ioctl = ep_ioctl,
708 .read_iter = ep_read_iter,
709 .write_iter = ep_write_iter,
712 /* ENDPOINT INITIALIZATION
714 * fd = open ("/dev/gadget/$ENDPOINT", O_RDWR)
715 * status = write (fd, descriptors, sizeof descriptors)
717 * That write establishes the endpoint configuration, configuring
718 * the controller to process bulk, interrupt, or isochronous transfers
719 * at the right maxpacket size, and so on.
721 * The descriptors are message type 1, identified by a host order u32
722 * at the beginning of what's written. Descriptor order is: full/low
723 * speed descriptor, then optional high speed descriptor.
726 ep_config (struct ep_data *data, const char *buf, size_t len)
730 int value, length = len;
732 if (data->state != STATE_EP_READY) {
738 if (len < USB_DT_ENDPOINT_SIZE + 4)
741 /* we might need to change message format someday */
742 memcpy(&tag, buf, 4);
744 DBG(data->dev, "config %s, bad tag %d\n", data->name, tag);
750 /* NOTE: audio endpoint extensions not accepted here;
751 * just don't include the extra bytes.
754 /* full/low speed descriptor, then high speed */
755 memcpy(&data->desc, buf, USB_DT_ENDPOINT_SIZE);
756 if (data->desc.bLength != USB_DT_ENDPOINT_SIZE
757 || data->desc.bDescriptorType != USB_DT_ENDPOINT)
759 if (len != USB_DT_ENDPOINT_SIZE) {
760 if (len != 2 * USB_DT_ENDPOINT_SIZE)
762 memcpy(&data->hs_desc, buf + USB_DT_ENDPOINT_SIZE,
763 USB_DT_ENDPOINT_SIZE);
764 if (data->hs_desc.bLength != USB_DT_ENDPOINT_SIZE
765 || data->hs_desc.bDescriptorType
766 != USB_DT_ENDPOINT) {
767 DBG(data->dev, "config %s, bad hs length or type\n",
773 spin_lock_irq (&data->dev->lock);
774 if (data->dev->state == STATE_DEV_UNBOUND) {
784 switch (data->dev->gadget->speed) {
787 ep->desc = &data->desc;
790 /* fails if caller didn't provide that descriptor... */
791 ep->desc = &data->hs_desc;
794 DBG(data->dev, "unconnected, %s init abandoned\n",
799 value = usb_ep_enable(ep);
801 data->state = STATE_EP_ENABLED;
805 spin_unlock_irq (&data->dev->lock);
808 data->desc.bDescriptorType = 0;
809 data->hs_desc.bDescriptorType = 0;
818 ep_open (struct inode *inode, struct file *fd)
820 struct ep_data *data = inode->i_private;
823 if (mutex_lock_interruptible(&data->lock) != 0)
825 spin_lock_irq (&data->dev->lock);
826 if (data->dev->state == STATE_DEV_UNBOUND)
828 else if (data->state == STATE_EP_DISABLED) {
830 data->state = STATE_EP_READY;
832 fd->private_data = data;
833 VDEBUG (data->dev, "%s ready\n", data->name);
835 DBG (data->dev, "%s state %d\n",
836 data->name, data->state);
837 spin_unlock_irq (&data->dev->lock);
838 mutex_unlock(&data->lock);
842 /*----------------------------------------------------------------------*/
844 /* EP0 IMPLEMENTATION can be partly in userspace.
846 * Drivers that use this facility receive various events, including
847 * control requests the kernel doesn't handle. Drivers that don't
848 * use this facility may be too simple-minded for real applications.
851 static inline void ep0_readable (struct dev_data *dev)
853 wake_up (&dev->wait);
854 kill_fasync (&dev->fasync, SIGIO, POLL_IN);
857 static void clean_req (struct usb_ep *ep, struct usb_request *req)
859 struct dev_data *dev = ep->driver_data;
861 if (req->buf != dev->rbuf) {
863 req->buf = dev->rbuf;
865 req->complete = epio_complete;
866 dev->setup_out_ready = 0;
869 static void ep0_complete (struct usb_ep *ep, struct usb_request *req)
871 struct dev_data *dev = ep->driver_data;
875 /* for control OUT, data must still get to userspace */
876 spin_lock_irqsave(&dev->lock, flags);
877 if (!dev->setup_in) {
878 dev->setup_out_error = (req->status != 0);
879 if (!dev->setup_out_error)
881 dev->setup_out_ready = 1;
885 /* clean up as appropriate */
886 if (free && req->buf != &dev->rbuf)
888 req->complete = epio_complete;
889 spin_unlock_irqrestore(&dev->lock, flags);
892 static int setup_req (struct usb_ep *ep, struct usb_request *req, u16 len)
894 struct dev_data *dev = ep->driver_data;
896 if (dev->setup_out_ready) {
897 DBG (dev, "ep0 request busy!\n");
900 if (len > sizeof (dev->rbuf))
901 req->buf = kmalloc(len, GFP_ATOMIC);
902 if (req->buf == NULL) {
903 req->buf = dev->rbuf;
906 req->complete = ep0_complete;
913 ep0_read (struct file *fd, char __user *buf, size_t len, loff_t *ptr)
915 struct dev_data *dev = fd->private_data;
917 enum ep0_state state;
919 spin_lock_irq (&dev->lock);
920 if (dev->state <= STATE_DEV_OPENED) {
925 /* report fd mode change before acting on it */
926 if (dev->setup_abort) {
927 dev->setup_abort = 0;
932 /* control DATA stage */
933 if ((state = dev->state) == STATE_DEV_SETUP) {
935 if (dev->setup_in) { /* stall IN */
936 VDEBUG(dev, "ep0in stall\n");
937 (void) usb_ep_set_halt (dev->gadget->ep0);
939 dev->state = STATE_DEV_CONNECTED;
941 } else if (len == 0) { /* ack SET_CONFIGURATION etc */
942 struct usb_ep *ep = dev->gadget->ep0;
943 struct usb_request *req = dev->req;
945 if ((retval = setup_req (ep, req, 0)) == 0) {
947 spin_unlock_irq (&dev->lock);
948 retval = usb_ep_queue (ep, req, GFP_KERNEL);
949 spin_lock_irq (&dev->lock);
952 dev->state = STATE_DEV_CONNECTED;
954 /* assume that was SET_CONFIGURATION */
955 if (dev->current_config) {
958 if (gadget_is_dualspeed(dev->gadget)
959 && (dev->gadget->speed
961 power = dev->hs_config->bMaxPower;
963 power = dev->config->bMaxPower;
964 usb_gadget_vbus_draw(dev->gadget, 2 * power);
967 } else { /* collect OUT data */
968 if ((fd->f_flags & O_NONBLOCK) != 0
969 && !dev->setup_out_ready) {
973 spin_unlock_irq (&dev->lock);
974 retval = wait_event_interruptible (dev->wait,
975 dev->setup_out_ready != 0);
977 /* FIXME state could change from under us */
978 spin_lock_irq (&dev->lock);
982 if (dev->state != STATE_DEV_SETUP) {
986 dev->state = STATE_DEV_CONNECTED;
988 if (dev->setup_out_error)
991 len = min (len, (size_t)dev->req->actual);
993 spin_unlock_irq(&dev->lock);
994 if (copy_to_user (buf, dev->req->buf, len))
998 spin_lock_irq(&dev->lock);
1000 clean_req (dev->gadget->ep0, dev->req);
1001 /* NOTE userspace can't yet choose to stall */
1007 /* else normal: return event data */
1008 if (len < sizeof dev->event [0]) {
1012 len -= len % sizeof (struct usb_gadgetfs_event);
1013 dev->usermode_setup = 1;
1016 /* return queued events right away */
1017 if (dev->ev_next != 0) {
1020 n = len / sizeof (struct usb_gadgetfs_event);
1021 if (dev->ev_next < n)
1024 /* ep0 i/o has special semantics during STATE_DEV_SETUP */
1025 for (i = 0; i < n; i++) {
1026 if (dev->event [i].type == GADGETFS_SETUP) {
1027 dev->state = STATE_DEV_SETUP;
1032 spin_unlock_irq (&dev->lock);
1033 len = n * sizeof (struct usb_gadgetfs_event);
1034 if (copy_to_user (buf, &dev->event, len))
1039 /* NOTE this doesn't guard against broken drivers;
1040 * concurrent ep0 readers may lose events.
1042 spin_lock_irq (&dev->lock);
1043 if (dev->ev_next > n) {
1044 memmove(&dev->event[0], &dev->event[n],
1045 sizeof (struct usb_gadgetfs_event)
1046 * (dev->ev_next - n));
1049 spin_unlock_irq (&dev->lock);
1053 if (fd->f_flags & O_NONBLOCK) {
1060 DBG (dev, "fail %s, state %d\n", __func__, state);
1063 case STATE_DEV_UNCONNECTED:
1064 case STATE_DEV_CONNECTED:
1065 spin_unlock_irq (&dev->lock);
1066 DBG (dev, "%s wait\n", __func__);
1068 /* wait for events */
1069 retval = wait_event_interruptible (dev->wait,
1073 spin_lock_irq (&dev->lock);
1078 spin_unlock_irq (&dev->lock);
1082 static struct usb_gadgetfs_event *
1083 next_event (struct dev_data *dev, enum usb_gadgetfs_event_type type)
1085 struct usb_gadgetfs_event *event;
1089 /* these events purge the queue */
1090 case GADGETFS_DISCONNECT:
1091 if (dev->state == STATE_DEV_SETUP)
1092 dev->setup_abort = 1;
1094 case GADGETFS_CONNECT:
1097 case GADGETFS_SETUP: /* previous request timed out */
1098 case GADGETFS_SUSPEND: /* same effect */
1099 /* these events can't be repeated */
1100 for (i = 0; i != dev->ev_next; i++) {
1101 if (dev->event [i].type != type)
1103 DBG(dev, "discard old event[%d] %d\n", i, type);
1105 if (i == dev->ev_next)
1107 /* indices start at zero, for simplicity */
1108 memmove (&dev->event [i], &dev->event [i + 1],
1109 sizeof (struct usb_gadgetfs_event)
1110 * (dev->ev_next - i));
1116 VDEBUG(dev, "event[%d] = %d\n", dev->ev_next, type);
1117 event = &dev->event [dev->ev_next++];
1118 BUG_ON (dev->ev_next > N_EVENT);
1119 memset (event, 0, sizeof *event);
1125 ep0_write (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
1127 struct dev_data *dev = fd->private_data;
1128 ssize_t retval = -ESRCH;
1130 /* report fd mode change before acting on it */
1131 if (dev->setup_abort) {
1132 dev->setup_abort = 0;
1135 /* data and/or status stage for control request */
1136 } else if (dev->state == STATE_DEV_SETUP) {
1138 len = min_t(size_t, len, dev->setup_wLength);
1139 if (dev->setup_in) {
1140 retval = setup_req (dev->gadget->ep0, dev->req, len);
1142 dev->state = STATE_DEV_CONNECTED;
1144 spin_unlock_irq (&dev->lock);
1145 if (copy_from_user (dev->req->buf, buf, len))
1148 if (len < dev->setup_wLength)
1150 retval = usb_ep_queue (
1151 dev->gadget->ep0, dev->req,
1154 spin_lock_irq(&dev->lock);
1157 clean_req (dev->gadget->ep0, dev->req);
1164 /* can stall some OUT transfers */
1165 } else if (dev->setup_can_stall) {
1166 VDEBUG(dev, "ep0out stall\n");
1167 (void) usb_ep_set_halt (dev->gadget->ep0);
1169 dev->state = STATE_DEV_CONNECTED;
1171 DBG(dev, "bogus ep0out stall!\n");
1174 DBG (dev, "fail %s, state %d\n", __func__, dev->state);
1180 ep0_fasync (int f, struct file *fd, int on)
1182 struct dev_data *dev = fd->private_data;
1183 // caller must F_SETOWN before signal delivery happens
1184 VDEBUG (dev, "%s %s\n", __func__, on ? "on" : "off");
1185 return fasync_helper (f, fd, on, &dev->fasync);
1188 static struct usb_gadget_driver gadgetfs_driver;
1191 dev_release (struct inode *inode, struct file *fd)
1193 struct dev_data *dev = fd->private_data;
1195 /* closing ep0 === shutdown all */
1197 if (dev->gadget_registered) {
1198 usb_gadget_unregister_driver (&gadgetfs_driver);
1199 dev->gadget_registered = false;
1202 /* at this point "good" hardware has disconnected the
1203 * device from USB; the host won't see it any more.
1204 * alternatively, all host requests will time out.
1210 /* other endpoints were all decoupled from this device */
1211 spin_lock_irq(&dev->lock);
1212 dev->state = STATE_DEV_DISABLED;
1213 spin_unlock_irq(&dev->lock);
1220 ep0_poll (struct file *fd, poll_table *wait)
1222 struct dev_data *dev = fd->private_data;
1225 if (dev->state <= STATE_DEV_OPENED)
1226 return DEFAULT_POLLMASK;
1228 poll_wait(fd, &dev->wait, wait);
1230 spin_lock_irq (&dev->lock);
1232 /* report fd mode change before acting on it */
1233 if (dev->setup_abort) {
1234 dev->setup_abort = 0;
1239 if (dev->state == STATE_DEV_SETUP) {
1240 if (dev->setup_in || dev->setup_can_stall)
1243 if (dev->ev_next != 0)
1247 spin_unlock_irq(&dev->lock);
1251 static long dev_ioctl (struct file *fd, unsigned code, unsigned long value)
1253 struct dev_data *dev = fd->private_data;
1254 struct usb_gadget *gadget = dev->gadget;
1257 spin_lock_irq(&dev->lock);
1258 if (dev->state == STATE_DEV_OPENED ||
1259 dev->state == STATE_DEV_UNBOUND) {
1260 /* Not bound to a UDC */
1261 } else if (gadget->ops->ioctl) {
1263 spin_unlock_irq(&dev->lock);
1265 ret = gadget->ops->ioctl (gadget, code, value);
1267 spin_lock_irq(&dev->lock);
1270 spin_unlock_irq(&dev->lock);
1275 /*----------------------------------------------------------------------*/
1277 /* The in-kernel gadget driver handles most ep0 issues, in particular
1278 * enumerating the single configuration (as provided from user space).
1280 * Unrecognized ep0 requests may be handled in user space.
1283 static void make_qualifier (struct dev_data *dev)
1285 struct usb_qualifier_descriptor qual;
1286 struct usb_device_descriptor *desc;
1288 qual.bLength = sizeof qual;
1289 qual.bDescriptorType = USB_DT_DEVICE_QUALIFIER;
1290 qual.bcdUSB = cpu_to_le16 (0x0200);
1293 qual.bDeviceClass = desc->bDeviceClass;
1294 qual.bDeviceSubClass = desc->bDeviceSubClass;
1295 qual.bDeviceProtocol = desc->bDeviceProtocol;
1297 /* assumes ep0 uses the same value for both speeds ... */
1298 qual.bMaxPacketSize0 = dev->gadget->ep0->maxpacket;
1300 qual.bNumConfigurations = 1;
1303 memcpy (dev->rbuf, &qual, sizeof qual);
1307 config_buf (struct dev_data *dev, u8 type, unsigned index)
1312 /* only one configuration */
1316 if (gadget_is_dualspeed(dev->gadget)) {
1317 hs = (dev->gadget->speed == USB_SPEED_HIGH);
1318 if (type == USB_DT_OTHER_SPEED_CONFIG)
1322 dev->req->buf = dev->hs_config;
1323 len = le16_to_cpu(dev->hs_config->wTotalLength);
1325 dev->req->buf = dev->config;
1326 len = le16_to_cpu(dev->config->wTotalLength);
1328 ((u8 *)dev->req->buf) [1] = type;
1333 gadgetfs_setup (struct usb_gadget *gadget, const struct usb_ctrlrequest *ctrl)
1335 struct dev_data *dev = get_gadget_data (gadget);
1336 struct usb_request *req = dev->req;
1337 int value = -EOPNOTSUPP;
1338 struct usb_gadgetfs_event *event;
1339 u16 w_value = le16_to_cpu(ctrl->wValue);
1340 u16 w_length = le16_to_cpu(ctrl->wLength);
1342 if (w_length > RBUF_SIZE) {
1343 if (ctrl->bRequestType & USB_DIR_IN) {
1344 /* Cast away the const, we are going to overwrite on purpose. */
1345 __le16 *temp = (__le16 *)&ctrl->wLength;
1347 *temp = cpu_to_le16(RBUF_SIZE);
1348 w_length = RBUF_SIZE;
1354 spin_lock (&dev->lock);
1355 dev->setup_abort = 0;
1356 if (dev->state == STATE_DEV_UNCONNECTED) {
1357 if (gadget_is_dualspeed(gadget)
1358 && gadget->speed == USB_SPEED_HIGH
1359 && dev->hs_config == NULL) {
1360 spin_unlock(&dev->lock);
1361 ERROR (dev, "no high speed config??\n");
1365 dev->state = STATE_DEV_CONNECTED;
1367 INFO (dev, "connected\n");
1368 event = next_event (dev, GADGETFS_CONNECT);
1369 event->u.speed = gadget->speed;
1372 /* host may have given up waiting for response. we can miss control
1373 * requests handled lower down (device/endpoint status and features);
1374 * then ep0_{read,write} will report the wrong status. controller
1375 * driver will have aborted pending i/o.
1377 } else if (dev->state == STATE_DEV_SETUP)
1378 dev->setup_abort = 1;
1380 req->buf = dev->rbuf;
1381 req->context = NULL;
1382 switch (ctrl->bRequest) {
1384 case USB_REQ_GET_DESCRIPTOR:
1385 if (ctrl->bRequestType != USB_DIR_IN)
1387 switch (w_value >> 8) {
1390 value = min (w_length, (u16) sizeof *dev->dev);
1391 dev->dev->bMaxPacketSize0 = dev->gadget->ep0->maxpacket;
1392 req->buf = dev->dev;
1394 case USB_DT_DEVICE_QUALIFIER:
1395 if (!dev->hs_config)
1397 value = min (w_length, (u16)
1398 sizeof (struct usb_qualifier_descriptor));
1399 make_qualifier (dev);
1401 case USB_DT_OTHER_SPEED_CONFIG:
1404 value = config_buf (dev,
1408 value = min (w_length, (u16) value);
1413 default: // all others are errors
1418 /* currently one config, two speeds */
1419 case USB_REQ_SET_CONFIGURATION:
1420 if (ctrl->bRequestType != 0)
1422 if (0 == (u8) w_value) {
1424 dev->current_config = 0;
1425 usb_gadget_vbus_draw(gadget, 8 /* mA */ );
1426 // user mode expected to disable endpoints
1430 if (gadget_is_dualspeed(gadget)
1431 && gadget->speed == USB_SPEED_HIGH) {
1432 config = dev->hs_config->bConfigurationValue;
1433 power = dev->hs_config->bMaxPower;
1435 config = dev->config->bConfigurationValue;
1436 power = dev->config->bMaxPower;
1439 if (config == (u8) w_value) {
1441 dev->current_config = config;
1442 usb_gadget_vbus_draw(gadget, 2 * power);
1446 /* report SET_CONFIGURATION like any other control request,
1447 * except that usermode may not stall this. the next
1448 * request mustn't be allowed start until this finishes:
1449 * endpoints and threads set up, etc.
1451 * NOTE: older PXA hardware (before PXA 255: without UDCCFR)
1452 * has bad/racey automagic that prevents synchronizing here.
1453 * even kernel mode drivers often miss them.
1456 INFO (dev, "configuration #%d\n", dev->current_config);
1457 usb_gadget_set_state(gadget, USB_STATE_CONFIGURED);
1458 if (dev->usermode_setup) {
1459 dev->setup_can_stall = 0;
1465 #ifndef CONFIG_USB_PXA25X
1466 /* PXA automagically handles this request too */
1467 case USB_REQ_GET_CONFIGURATION:
1468 if (ctrl->bRequestType != 0x80)
1470 *(u8 *)req->buf = dev->current_config;
1471 value = min (w_length, (u16) 1);
1477 VDEBUG (dev, "%s req%02x.%02x v%04x i%04x l%d\n",
1478 dev->usermode_setup ? "delegate" : "fail",
1479 ctrl->bRequestType, ctrl->bRequest,
1480 w_value, le16_to_cpu(ctrl->wIndex), w_length);
1482 /* if there's an ep0 reader, don't stall */
1483 if (dev->usermode_setup) {
1484 dev->setup_can_stall = 1;
1486 dev->setup_in = (ctrl->bRequestType & USB_DIR_IN)
1488 dev->setup_wLength = w_length;
1489 dev->setup_out_ready = 0;
1490 dev->setup_out_error = 0;
1493 /* read DATA stage for OUT right away */
1494 if (unlikely (!dev->setup_in && w_length)) {
1495 value = setup_req (gadget->ep0, dev->req,
1501 spin_unlock (&dev->lock);
1502 value = usb_ep_queue (gadget->ep0, dev->req,
1504 spin_lock (&dev->lock);
1507 clean_req (gadget->ep0, dev->req);
1511 /* we can't currently stall these */
1512 dev->setup_can_stall = 0;
1515 /* state changes when reader collects event */
1516 event = next_event (dev, GADGETFS_SETUP);
1517 event->u.setup = *ctrl;
1519 spin_unlock (&dev->lock);
1524 /* proceed with data transfer and status phases? */
1525 if (value >= 0 && dev->state != STATE_DEV_SETUP) {
1526 req->length = value;
1527 req->zero = value < w_length;
1530 spin_unlock (&dev->lock);
1531 value = usb_ep_queue (gadget->ep0, req, GFP_KERNEL);
1532 spin_lock(&dev->lock);
1534 spin_unlock(&dev->lock);
1536 DBG (dev, "ep_queue --> %d\n", value);
1542 /* device stalls when value < 0 */
1543 spin_unlock (&dev->lock);
1547 static void destroy_ep_files (struct dev_data *dev)
1549 DBG (dev, "%s %d\n", __func__, dev->state);
1551 /* dev->state must prevent interference */
1552 spin_lock_irq (&dev->lock);
1553 while (!list_empty(&dev->epfiles)) {
1555 struct inode *parent;
1556 struct dentry *dentry;
1558 /* break link to FS */
1559 ep = list_first_entry (&dev->epfiles, struct ep_data, epfiles);
1560 list_del_init (&ep->epfiles);
1561 spin_unlock_irq (&dev->lock);
1563 dentry = ep->dentry;
1565 parent = d_inode(dentry->d_parent);
1567 /* break link to controller */
1568 mutex_lock(&ep->lock);
1569 if (ep->state == STATE_EP_ENABLED)
1570 (void) usb_ep_disable (ep->ep);
1571 ep->state = STATE_EP_UNBOUND;
1572 usb_ep_free_request (ep->ep, ep->req);
1574 mutex_unlock(&ep->lock);
1576 wake_up (&ep->wait);
1579 /* break link to dcache */
1583 inode_unlock(parent);
1585 spin_lock_irq (&dev->lock);
1587 spin_unlock_irq (&dev->lock);
1591 static struct dentry *
1592 gadgetfs_create_file (struct super_block *sb, char const *name,
1593 void *data, const struct file_operations *fops);
1595 static int activate_ep_files (struct dev_data *dev)
1598 struct ep_data *data;
1600 gadget_for_each_ep (ep, dev->gadget) {
1602 data = kzalloc(sizeof(*data), GFP_KERNEL);
1605 data->state = STATE_EP_DISABLED;
1606 mutex_init(&data->lock);
1607 init_waitqueue_head (&data->wait);
1609 strncpy (data->name, ep->name, sizeof (data->name) - 1);
1610 atomic_set (&data->count, 1);
1615 ep->driver_data = data;
1617 data->req = usb_ep_alloc_request (ep, GFP_KERNEL);
1621 data->dentry = gadgetfs_create_file (dev->sb, data->name,
1622 data, &ep_io_operations);
1625 list_add_tail (&data->epfiles, &dev->epfiles);
1630 usb_ep_free_request (ep, data->req);
1635 DBG (dev, "%s enomem\n", __func__);
1636 destroy_ep_files (dev);
1641 gadgetfs_unbind (struct usb_gadget *gadget)
1643 struct dev_data *dev = get_gadget_data (gadget);
1645 DBG (dev, "%s\n", __func__);
1647 spin_lock_irq (&dev->lock);
1648 dev->state = STATE_DEV_UNBOUND;
1649 while (dev->udc_usage > 0) {
1650 spin_unlock_irq(&dev->lock);
1651 usleep_range(1000, 2000);
1652 spin_lock_irq(&dev->lock);
1654 spin_unlock_irq (&dev->lock);
1656 destroy_ep_files (dev);
1657 gadget->ep0->driver_data = NULL;
1658 set_gadget_data (gadget, NULL);
1660 /* we've already been disconnected ... no i/o is active */
1662 usb_ep_free_request (gadget->ep0, dev->req);
1663 DBG (dev, "%s done\n", __func__);
1667 static struct dev_data *the_device;
1669 static int gadgetfs_bind(struct usb_gadget *gadget,
1670 struct usb_gadget_driver *driver)
1672 struct dev_data *dev = the_device;
1676 if (0 != strcmp (CHIP, gadget->name)) {
1677 pr_err("%s expected %s controller not %s\n",
1678 shortname, CHIP, gadget->name);
1682 set_gadget_data (gadget, dev);
1683 dev->gadget = gadget;
1684 gadget->ep0->driver_data = dev;
1686 /* preallocate control response and buffer */
1687 dev->req = usb_ep_alloc_request (gadget->ep0, GFP_KERNEL);
1690 dev->req->context = NULL;
1691 dev->req->complete = epio_complete;
1693 if (activate_ep_files (dev) < 0)
1696 INFO (dev, "bound to %s driver\n", gadget->name);
1697 spin_lock_irq(&dev->lock);
1698 dev->state = STATE_DEV_UNCONNECTED;
1699 spin_unlock_irq(&dev->lock);
1704 gadgetfs_unbind (gadget);
1709 gadgetfs_disconnect (struct usb_gadget *gadget)
1711 struct dev_data *dev = get_gadget_data (gadget);
1712 unsigned long flags;
1714 spin_lock_irqsave (&dev->lock, flags);
1715 if (dev->state == STATE_DEV_UNCONNECTED)
1717 dev->state = STATE_DEV_UNCONNECTED;
1719 INFO (dev, "disconnected\n");
1720 next_event (dev, GADGETFS_DISCONNECT);
1723 spin_unlock_irqrestore (&dev->lock, flags);
1727 gadgetfs_suspend (struct usb_gadget *gadget)
1729 struct dev_data *dev = get_gadget_data (gadget);
1730 unsigned long flags;
1732 INFO (dev, "suspended from state %d\n", dev->state);
1733 spin_lock_irqsave(&dev->lock, flags);
1734 switch (dev->state) {
1735 case STATE_DEV_SETUP: // VERY odd... host died??
1736 case STATE_DEV_CONNECTED:
1737 case STATE_DEV_UNCONNECTED:
1738 next_event (dev, GADGETFS_SUSPEND);
1744 spin_unlock_irqrestore(&dev->lock, flags);
1747 static struct usb_gadget_driver gadgetfs_driver = {
1748 .function = (char *) driver_desc,
1749 .bind = gadgetfs_bind,
1750 .unbind = gadgetfs_unbind,
1751 .setup = gadgetfs_setup,
1752 .reset = gadgetfs_disconnect,
1753 .disconnect = gadgetfs_disconnect,
1754 .suspend = gadgetfs_suspend,
1757 .name = (char *) shortname,
1761 /*----------------------------------------------------------------------*/
1762 /* DEVICE INITIALIZATION
1764 * fd = open ("/dev/gadget/$CHIP", O_RDWR)
1765 * status = write (fd, descriptors, sizeof descriptors)
1767 * That write establishes the device configuration, so the kernel can
1768 * bind to the controller ... guaranteeing it can handle enumeration
1769 * at all necessary speeds. Descriptor order is:
1771 * . message tag (u32, host order) ... for now, must be zero; it
1772 * would change to support features like multi-config devices
1773 * . full/low speed config ... all wTotalLength bytes (with interface,
1774 * class, altsetting, endpoint, and other descriptors)
1775 * . high speed config ... all descriptors, for high speed operation;
1776 * this one's optional except for high-speed hardware
1777 * . device descriptor
1779 * Endpoints are not yet enabled. Drivers must wait until device
1780 * configuration and interface altsetting changes create
1781 * the need to configure (or unconfigure) them.
1783 * After initialization, the device stays active for as long as that
1784 * $CHIP file is open. Events must then be read from that descriptor,
1785 * such as configuration notifications.
1788 static int is_valid_config(struct usb_config_descriptor *config,
1791 return config->bDescriptorType == USB_DT_CONFIG
1792 && config->bLength == USB_DT_CONFIG_SIZE
1793 && total >= USB_DT_CONFIG_SIZE
1794 && config->bConfigurationValue != 0
1795 && (config->bmAttributes & USB_CONFIG_ATT_ONE) != 0
1796 && (config->bmAttributes & USB_CONFIG_ATT_WAKEUP) == 0;
1797 /* FIXME if gadget->is_otg, _must_ include an otg descriptor */
1798 /* FIXME check lengths: walk to end */
1802 dev_config (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
1804 struct dev_data *dev = fd->private_data;
1805 ssize_t value, length = len;
1810 spin_lock_irq(&dev->lock);
1811 if (dev->state > STATE_DEV_OPENED) {
1812 value = ep0_write(fd, buf, len, ptr);
1813 spin_unlock_irq(&dev->lock);
1816 spin_unlock_irq(&dev->lock);
1818 if ((len < (USB_DT_CONFIG_SIZE + USB_DT_DEVICE_SIZE + 4)) ||
1819 (len > PAGE_SIZE * 4))
1822 /* we might need to change message format someday */
1823 if (copy_from_user (&tag, buf, 4))
1830 kbuf = memdup_user(buf, length);
1832 return PTR_ERR(kbuf);
1834 spin_lock_irq (&dev->lock);
1837 spin_unlock_irq(&dev->lock);
1843 /* full or low speed config */
1844 dev->config = (void *) kbuf;
1845 total = le16_to_cpu(dev->config->wTotalLength);
1846 if (!is_valid_config(dev->config, total) ||
1847 total > length - USB_DT_DEVICE_SIZE)
1852 /* optional high speed config */
1853 if (kbuf [1] == USB_DT_CONFIG) {
1854 dev->hs_config = (void *) kbuf;
1855 total = le16_to_cpu(dev->hs_config->wTotalLength);
1856 if (!is_valid_config(dev->hs_config, total) ||
1857 total > length - USB_DT_DEVICE_SIZE)
1862 dev->hs_config = NULL;
1865 /* could support multiple configs, using another encoding! */
1867 /* device descriptor (tweaked for paranoia) */
1868 if (length != USB_DT_DEVICE_SIZE)
1870 dev->dev = (void *)kbuf;
1871 if (dev->dev->bLength != USB_DT_DEVICE_SIZE
1872 || dev->dev->bDescriptorType != USB_DT_DEVICE
1873 || dev->dev->bNumConfigurations != 1)
1875 dev->dev->bNumConfigurations = 1;
1876 dev->dev->bcdUSB = cpu_to_le16 (0x0200);
1878 /* triggers gadgetfs_bind(); then we can enumerate. */
1879 spin_unlock_irq (&dev->lock);
1881 gadgetfs_driver.max_speed = USB_SPEED_HIGH;
1883 gadgetfs_driver.max_speed = USB_SPEED_FULL;
1885 value = usb_gadget_probe_driver(&gadgetfs_driver);
1887 spin_lock_irq(&dev->lock);
1890 /* at this point "good" hardware has for the first time
1891 * let the USB the host see us. alternatively, if users
1892 * unplug/replug that will clear all the error state.
1894 * note: everything running before here was guaranteed
1895 * to choke driver model style diagnostics. from here
1896 * on, they can work ... except in cleanup paths that
1897 * kick in after the ep0 descriptor is closed.
1900 dev->gadget_registered = true;
1906 dev->hs_config = NULL;
1908 spin_unlock_irq (&dev->lock);
1909 pr_debug ("%s: %s fail %Zd, %p\n", shortname, __func__, value, dev);
1916 dev_open (struct inode *inode, struct file *fd)
1918 struct dev_data *dev = inode->i_private;
1921 spin_lock_irq(&dev->lock);
1922 if (dev->state == STATE_DEV_DISABLED) {
1924 dev->state = STATE_DEV_OPENED;
1925 fd->private_data = dev;
1929 spin_unlock_irq(&dev->lock);
1933 static const struct file_operations ep0_operations = {
1934 .llseek = no_llseek,
1938 .write = dev_config,
1939 .fasync = ep0_fasync,
1941 .unlocked_ioctl = dev_ioctl,
1942 .release = dev_release,
1945 /*----------------------------------------------------------------------*/
1947 /* FILESYSTEM AND SUPERBLOCK OPERATIONS
1949 * Mounting the filesystem creates a controller file, used first for
1950 * device configuration then later for event monitoring.
1954 /* FIXME PAM etc could set this security policy without mount options
1955 * if epfiles inherited ownership and permissons from ep0 ...
1958 static unsigned default_uid;
1959 static unsigned default_gid;
1960 static unsigned default_perm = S_IRUSR | S_IWUSR;
1962 module_param (default_uid, uint, 0644);
1963 module_param (default_gid, uint, 0644);
1964 module_param (default_perm, uint, 0644);
1967 static struct inode *
1968 gadgetfs_make_inode (struct super_block *sb,
1969 void *data, const struct file_operations *fops,
1972 struct inode *inode = new_inode (sb);
1975 inode->i_ino = get_next_ino();
1976 inode->i_mode = mode;
1977 inode->i_uid = make_kuid(&init_user_ns, default_uid);
1978 inode->i_gid = make_kgid(&init_user_ns, default_gid);
1979 inode->i_atime = inode->i_mtime = inode->i_ctime
1980 = current_time(inode);
1981 inode->i_private = data;
1982 inode->i_fop = fops;
1987 /* creates in fs root directory, so non-renamable and non-linkable.
1988 * so inode and dentry are paired, until device reconfig.
1990 static struct dentry *
1991 gadgetfs_create_file (struct super_block *sb, char const *name,
1992 void *data, const struct file_operations *fops)
1994 struct dentry *dentry;
1995 struct inode *inode;
1997 dentry = d_alloc_name(sb->s_root, name);
2001 inode = gadgetfs_make_inode (sb, data, fops,
2002 S_IFREG | (default_perm & S_IRWXUGO));
2007 d_add (dentry, inode);
2011 static const struct super_operations gadget_fs_operations = {
2012 .statfs = simple_statfs,
2013 .drop_inode = generic_delete_inode,
2017 gadgetfs_fill_super (struct super_block *sb, void *opts, int silent)
2019 struct inode *inode;
2020 struct dev_data *dev;
2025 CHIP = usb_get_gadget_udc_name();
2030 sb->s_blocksize = PAGE_SIZE;
2031 sb->s_blocksize_bits = PAGE_SHIFT;
2032 sb->s_magic = GADGETFS_MAGIC;
2033 sb->s_op = &gadget_fs_operations;
2034 sb->s_time_gran = 1;
2037 inode = gadgetfs_make_inode (sb,
2038 NULL, &simple_dir_operations,
2039 S_IFDIR | S_IRUGO | S_IXUGO);
2042 inode->i_op = &simple_dir_inode_operations;
2043 if (!(sb->s_root = d_make_root (inode)))
2046 /* the ep0 file is named after the controller we expect;
2047 * user mode code can use it for sanity checks, like we do.
2054 dev->dentry = gadgetfs_create_file(sb, CHIP, dev, &ep0_operations);
2060 /* other endpoint files are available after hardware setup,
2061 * from binding to a controller.
2073 /* "mount -t gadgetfs path /dev/gadget" ends up here */
2074 static struct dentry *
2075 gadgetfs_mount (struct file_system_type *t, int flags,
2076 const char *path, void *opts)
2078 return mount_single (t, flags, opts, gadgetfs_fill_super);
2082 gadgetfs_kill_sb (struct super_block *sb)
2084 kill_litter_super (sb);
2086 put_dev (the_device);
2093 /*----------------------------------------------------------------------*/
2095 static struct file_system_type gadgetfs_type = {
2096 .owner = THIS_MODULE,
2098 .mount = gadgetfs_mount,
2099 .kill_sb = gadgetfs_kill_sb,
2101 MODULE_ALIAS_FS("gadgetfs");
2103 /*----------------------------------------------------------------------*/
2105 static int __init init (void)
2109 status = register_filesystem (&gadgetfs_type);
2111 pr_info ("%s: %s, version " DRIVER_VERSION "\n",
2112 shortname, driver_desc);
2117 static void __exit cleanup (void)
2119 pr_debug ("unregister %s\n", shortname);
2120 unregister_filesystem (&gadgetfs_type);
2122 module_exit (cleanup);