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.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 /* #define VERBOSE_DEBUG */
25 #include <linux/init.h>
26 #include <linux/module.h>
28 #include <linux/pagemap.h>
29 #include <linux/uts.h>
30 #include <linux/wait.h>
31 #include <linux/compiler.h>
32 #include <asm/uaccess.h>
33 #include <linux/sched.h>
34 #include <linux/slab.h>
35 #include <linux/poll.h>
36 #include <linux/smp_lock.h>
38 #include <linux/device.h>
39 #include <linux/moduleparam.h>
41 #include <linux/usb/gadgetfs.h>
42 #include <linux/usb/gadget.h>
46 * The gadgetfs API maps each endpoint to a file descriptor so that you
47 * can use standard synchronous read/write calls for I/O. There's some
48 * O_NONBLOCK and O_ASYNC/FASYNC style i/o support. Example usermode
49 * drivers show how this works in practice. You can also use AIO to
50 * eliminate I/O gaps between requests, to help when streaming data.
52 * Key parts that must be USB-specific are protocols defining how the
53 * read/write operations relate to the hardware state machines. There
54 * are two types of files. One type is for the device, implementing ep0.
55 * The other type is for each IN or OUT endpoint. In both cases, the
56 * user mode driver must configure the hardware before using it.
58 * - First, dev_config() is called when /dev/gadget/$CHIP is configured
59 * (by writing configuration and device descriptors). Afterwards it
60 * may serve as a source of device events, used to handle all control
61 * requests other than basic enumeration.
63 * - Then, after a SET_CONFIGURATION control request, ep_config() is
64 * called when each /dev/gadget/ep* file is configured (by writing
65 * endpoint descriptors). Afterwards these files are used to write()
66 * IN data or to read() OUT data. To halt the endpoint, a "wrong
67 * direction" request is issued (like reading an IN endpoint).
69 * Unlike "usbfs" the only ioctl()s are for things that are rare, and maybe
70 * not possible on all hardware. For example, precise fault handling with
71 * respect to data left in endpoint fifos after aborted operations; or
72 * selective clearing of endpoint halts, to implement SET_INTERFACE.
75 #define DRIVER_DESC "USB Gadget filesystem"
76 #define DRIVER_VERSION "24 Aug 2004"
78 static const char driver_desc [] = DRIVER_DESC;
79 static const char shortname [] = "gadgetfs";
81 MODULE_DESCRIPTION (DRIVER_DESC);
82 MODULE_AUTHOR ("David Brownell");
83 MODULE_LICENSE ("GPL");
86 /*----------------------------------------------------------------------*/
88 #define GADGETFS_MAGIC 0xaee71ee7
89 #define DMA_ADDR_INVALID (~(dma_addr_t)0)
91 /* /dev/gadget/$CHIP represents ep0 and the whole device */
93 /* DISBLED is the initial state.
95 STATE_DEV_DISABLED = 0,
97 /* Only one open() of /dev/gadget/$CHIP; only one file tracks
98 * ep0/device i/o modes and binding to the controller. Driver
99 * must always write descriptors to initialize the device, then
100 * the device becomes UNCONNECTED until enumeration.
104 /* From then on, ep0 fd is in either of two basic modes:
105 * - (UN)CONNECTED: read usb_gadgetfs_event(s) from it
106 * - SETUP: read/write will transfer control data and succeed;
107 * or if "wrong direction", performs protocol stall
109 STATE_DEV_UNCONNECTED,
113 /* UNBOUND means the driver closed ep0, so the device won't be
114 * accessible again (DEV_DISABLED) until all fds are closed.
119 /* enough for the whole queue: most events invalidate others */
125 enum ep0_state state; /* P: lock */
126 struct usb_gadgetfs_event event [N_EVENT];
128 struct fasync_struct *fasync;
131 /* drivers reading ep0 MUST handle control requests (SETUP)
132 * reported that way; else the host will time out.
134 unsigned usermode_setup : 1,
140 unsigned setup_wLength;
142 /* the rest is basically write-once */
143 struct usb_config_descriptor *config, *hs_config;
144 struct usb_device_descriptor *dev;
145 struct usb_request *req;
146 struct usb_gadget *gadget;
147 struct list_head epfiles;
149 wait_queue_head_t wait;
150 struct super_block *sb;
151 struct dentry *dentry;
153 /* except this scratch i/o buffer for ep0 */
157 static inline void get_dev (struct dev_data *data)
159 atomic_inc (&data->count);
162 static void put_dev (struct dev_data *data)
164 if (likely (!atomic_dec_and_test (&data->count)))
166 /* needs no more cleanup */
167 BUG_ON (waitqueue_active (&data->wait));
171 static struct dev_data *dev_new (void)
173 struct dev_data *dev;
175 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
178 dev->state = STATE_DEV_DISABLED;
179 atomic_set (&dev->count, 1);
180 spin_lock_init (&dev->lock);
181 INIT_LIST_HEAD (&dev->epfiles);
182 init_waitqueue_head (&dev->wait);
186 /*----------------------------------------------------------------------*/
188 /* other /dev/gadget/$ENDPOINT files represent endpoints */
190 STATE_EP_DISABLED = 0,
200 struct dev_data *dev;
201 /* must hold dev->lock before accessing ep or req */
203 struct usb_request *req;
206 struct usb_endpoint_descriptor desc, hs_desc;
207 struct list_head epfiles;
208 wait_queue_head_t wait;
209 struct dentry *dentry;
213 static inline void get_ep (struct ep_data *data)
215 atomic_inc (&data->count);
218 static void put_ep (struct ep_data *data)
220 if (likely (!atomic_dec_and_test (&data->count)))
223 /* needs no more cleanup */
224 BUG_ON (!list_empty (&data->epfiles));
225 BUG_ON (waitqueue_active (&data->wait));
229 /*----------------------------------------------------------------------*/
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.
237 static const char *CHIP;
239 /*----------------------------------------------------------------------*/
241 /* NOTE: don't use dev_printk calls before binding to the gadget
242 * at the end of ep0 configuration, or after unbind.
245 /* too wordy: dev_printk(level , &(d)->gadget->dev , fmt , ## args) */
246 #define xprintk(d,level,fmt,args...) \
247 printk(level "%s: " fmt , shortname , ## args)
250 #define DBG(dev,fmt,args...) \
251 xprintk(dev , KERN_DEBUG , fmt , ## args)
253 #define DBG(dev,fmt,args...) \
260 #define VDEBUG(dev,fmt,args...) \
264 #define ERROR(dev,fmt,args...) \
265 xprintk(dev , KERN_ERR , fmt , ## args)
266 #define INFO(dev,fmt,args...) \
267 xprintk(dev , KERN_INFO , fmt , ## args)
270 /*----------------------------------------------------------------------*/
272 /* SYNCHRONOUS ENDPOINT OPERATIONS (bulk/intr/iso)
274 * After opening, configure non-control endpoints. Then use normal
275 * stream read() and write() requests; and maybe ioctl() to get more
276 * precise FIFO status when recovering from cancellation.
279 static void epio_complete (struct usb_ep *ep, struct usb_request *req)
281 struct ep_data *epdata = ep->driver_data;
286 epdata->status = req->status;
288 epdata->status = req->actual;
289 complete ((struct completion *)req->context);
292 /* tasklock endpoint, returning when it's connected.
293 * still need dev->lock to use epdata->ep.
296 get_ready_ep (unsigned f_flags, struct ep_data *epdata)
300 if (f_flags & O_NONBLOCK) {
301 if (!mutex_trylock(&epdata->lock))
303 if (epdata->state != STATE_EP_ENABLED) {
304 mutex_unlock(&epdata->lock);
312 val = mutex_lock_interruptible(&epdata->lock);
316 switch (epdata->state) {
317 case STATE_EP_ENABLED:
319 // case STATE_EP_DISABLED: /* "can't happen" */
320 // case STATE_EP_READY: /* "can't happen" */
321 default: /* error! */
322 pr_debug ("%s: ep %p not available, state %d\n",
323 shortname, epdata, epdata->state);
325 case STATE_EP_UNBOUND: /* clean disconnect */
327 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 epdata->status = -ENODEV;
371 return epdata->status;
377 /* handle a synchronous OUT bulk/intr/iso transfer */
379 ep_read (struct file *fd, char __user *buf, size_t len, loff_t *ptr)
381 struct ep_data *data = fd->private_data;
385 if ((value = get_ready_ep (fd->f_flags, data)) < 0)
388 /* halt any endpoint by doing a "wrong direction" i/o call */
389 if (usb_endpoint_dir_in(&data->desc)) {
390 if (usb_endpoint_xfer_isoc(&data->desc))
392 DBG (data->dev, "%s halt\n", data->name);
393 spin_lock_irq (&data->dev->lock);
394 if (likely (data->ep != NULL))
395 usb_ep_set_halt (data->ep);
396 spin_unlock_irq (&data->dev->lock);
397 mutex_unlock(&data->lock);
401 /* FIXME readahead for O_NONBLOCK and poll(); careful with ZLPs */
404 kbuf = kmalloc (len, GFP_KERNEL);
405 if (unlikely (!kbuf))
408 value = ep_io (data, kbuf, len);
409 VDEBUG (data->dev, "%s read %zu OUT, status %d\n",
410 data->name, len, (int) value);
411 if (value >= 0 && copy_to_user (buf, kbuf, value))
415 mutex_unlock(&data->lock);
420 /* handle a synchronous IN bulk/intr/iso transfer */
422 ep_write (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
424 struct ep_data *data = fd->private_data;
428 if ((value = get_ready_ep (fd->f_flags, data)) < 0)
431 /* halt any endpoint by doing a "wrong direction" i/o call */
432 if (!usb_endpoint_dir_in(&data->desc)) {
433 if (usb_endpoint_xfer_isoc(&data->desc))
435 DBG (data->dev, "%s halt\n", data->name);
436 spin_lock_irq (&data->dev->lock);
437 if (likely (data->ep != NULL))
438 usb_ep_set_halt (data->ep);
439 spin_unlock_irq (&data->dev->lock);
440 mutex_unlock(&data->lock);
444 /* FIXME writebehind for O_NONBLOCK and poll(), qlen = 1 */
447 kbuf = kmalloc (len, GFP_KERNEL);
450 if (copy_from_user (kbuf, buf, len)) {
455 value = ep_io (data, kbuf, len);
456 VDEBUG (data->dev, "%s write %zu IN, status %d\n",
457 data->name, len, (int) value);
459 mutex_unlock(&data->lock);
465 ep_release (struct inode *inode, struct file *fd)
467 struct ep_data *data = fd->private_data;
470 value = mutex_lock_interruptible(&data->lock);
474 /* clean up if this can be reopened */
475 if (data->state != STATE_EP_UNBOUND) {
476 data->state = STATE_EP_DISABLED;
477 data->desc.bDescriptorType = 0;
478 data->hs_desc.bDescriptorType = 0;
479 usb_ep_disable(data->ep);
481 mutex_unlock(&data->lock);
486 static long ep_ioctl(struct file *fd, unsigned code, unsigned long value)
488 struct ep_data *data = fd->private_data;
491 if ((status = get_ready_ep (fd->f_flags, data)) < 0)
494 spin_lock_irq (&data->dev->lock);
495 if (likely (data->ep != NULL)) {
497 case GADGETFS_FIFO_STATUS:
498 status = usb_ep_fifo_status (data->ep);
500 case GADGETFS_FIFO_FLUSH:
501 usb_ep_fifo_flush (data->ep);
503 case GADGETFS_CLEAR_HALT:
504 status = usb_ep_clear_halt (data->ep);
511 spin_unlock_irq (&data->dev->lock);
512 mutex_unlock(&data->lock);
516 /*----------------------------------------------------------------------*/
518 /* ASYNCHRONOUS ENDPOINT I/O OPERATIONS (bulk/intr/iso) */
521 struct usb_request *req;
522 struct ep_data *epdata;
524 const struct iovec *iv;
525 unsigned long nr_segs;
529 static int ep_aio_cancel(struct kiocb *iocb, struct io_event *e)
531 struct kiocb_priv *priv = iocb->private;
532 struct ep_data *epdata;
536 epdata = priv->epdata;
537 // spin_lock(&epdata->dev->lock);
538 kiocbSetCancelled(iocb);
539 if (likely(epdata && epdata->ep && priv->req))
540 value = usb_ep_dequeue (epdata->ep, priv->req);
543 // spin_unlock(&epdata->dev->lock);
550 static ssize_t ep_aio_read_retry(struct kiocb *iocb)
552 struct kiocb_priv *priv = iocb->private;
557 /* we "retry" to get the right mm context for this: */
559 /* copy stuff into user buffers */
560 total = priv->actual;
563 for (i=0; i < priv->nr_segs; i++) {
564 ssize_t this = min((ssize_t)(priv->iv[i].iov_len), total);
566 if (copy_to_user(priv->iv[i].iov_base, to_copy, this)) {
583 static void ep_aio_complete(struct usb_ep *ep, struct usb_request *req)
585 struct kiocb *iocb = req->context;
586 struct kiocb_priv *priv = iocb->private;
587 struct ep_data *epdata = priv->epdata;
589 /* lock against disconnect (and ideally, cancel) */
590 spin_lock(&epdata->dev->lock);
594 /* if this was a write or a read returning no data then we
595 * don't need to copy anything to userspace, so we can
596 * complete the aio request immediately.
598 if (priv->iv == NULL || unlikely(req->actual == 0)) {
601 iocb->private = NULL;
602 /* aio_complete() reports bytes-transferred _and_ faults */
603 aio_complete(iocb, req->actual ? req->actual : req->status,
606 /* retry() won't report both; so we hide some faults */
607 if (unlikely(0 != req->status))
608 DBG(epdata->dev, "%s fault %d len %d\n",
609 ep->name, req->status, req->actual);
611 priv->buf = req->buf;
612 priv->actual = req->actual;
615 spin_unlock(&epdata->dev->lock);
617 usb_ep_free_request(ep, req);
626 struct ep_data *epdata,
627 const struct iovec *iv,
628 unsigned long nr_segs
631 struct kiocb_priv *priv;
632 struct usb_request *req;
635 priv = kmalloc(sizeof *priv, GFP_KERNEL);
642 iocb->private = priv;
644 priv->nr_segs = nr_segs;
646 value = get_ready_ep(iocb->ki_filp->f_flags, epdata);
647 if (unlikely(value < 0)) {
652 iocb->ki_cancel = ep_aio_cancel;
654 priv->epdata = epdata;
657 /* each kiocb is coupled to one usb_request, but we can't
658 * allocate or submit those if the host disconnected.
660 spin_lock_irq(&epdata->dev->lock);
661 if (likely(epdata->ep)) {
662 req = usb_ep_alloc_request(epdata->ep, GFP_ATOMIC);
667 req->complete = ep_aio_complete;
669 value = usb_ep_queue(epdata->ep, req, GFP_ATOMIC);
670 if (unlikely(0 != value))
671 usb_ep_free_request(epdata->ep, req);
676 spin_unlock_irq(&epdata->dev->lock);
678 mutex_unlock(&epdata->lock);
680 if (unlikely(value)) {
684 value = (iv ? -EIOCBRETRY : -EIOCBQUEUED);
689 ep_aio_read(struct kiocb *iocb, const struct iovec *iov,
690 unsigned long nr_segs, loff_t o)
692 struct ep_data *epdata = iocb->ki_filp->private_data;
695 if (unlikely(usb_endpoint_dir_in(&epdata->desc)))
698 buf = kmalloc(iocb->ki_left, GFP_KERNEL);
702 iocb->ki_retry = ep_aio_read_retry;
703 return ep_aio_rwtail(iocb, buf, iocb->ki_left, epdata, iov, nr_segs);
707 ep_aio_write(struct kiocb *iocb, const struct iovec *iov,
708 unsigned long nr_segs, loff_t o)
710 struct ep_data *epdata = iocb->ki_filp->private_data;
715 if (unlikely(!usb_endpoint_dir_in(&epdata->desc)))
718 buf = kmalloc(iocb->ki_left, GFP_KERNEL);
722 for (i=0; i < nr_segs; i++) {
723 if (unlikely(copy_from_user(&buf[len], iov[i].iov_base,
724 iov[i].iov_len) != 0)) {
728 len += iov[i].iov_len;
730 return ep_aio_rwtail(iocb, buf, len, epdata, NULL, 0);
733 /*----------------------------------------------------------------------*/
735 /* used after endpoint configuration */
736 static const struct file_operations ep_io_operations = {
737 .owner = THIS_MODULE,
742 .unlocked_ioctl = ep_ioctl,
743 .release = ep_release,
745 .aio_read = ep_aio_read,
746 .aio_write = ep_aio_write,
749 /* ENDPOINT INITIALIZATION
751 * fd = open ("/dev/gadget/$ENDPOINT", O_RDWR)
752 * status = write (fd, descriptors, sizeof descriptors)
754 * That write establishes the endpoint configuration, configuring
755 * the controller to process bulk, interrupt, or isochronous transfers
756 * at the right maxpacket size, and so on.
758 * The descriptors are message type 1, identified by a host order u32
759 * at the beginning of what's written. Descriptor order is: full/low
760 * speed descriptor, then optional high speed descriptor.
763 ep_config (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
765 struct ep_data *data = fd->private_data;
768 int value, length = len;
770 value = mutex_lock_interruptible(&data->lock);
774 if (data->state != STATE_EP_READY) {
780 if (len < USB_DT_ENDPOINT_SIZE + 4)
783 /* we might need to change message format someday */
784 if (copy_from_user (&tag, buf, 4)) {
788 DBG(data->dev, "config %s, bad tag %d\n", data->name, tag);
794 /* NOTE: audio endpoint extensions not accepted here;
795 * just don't include the extra bytes.
798 /* full/low speed descriptor, then high speed */
799 if (copy_from_user (&data->desc, buf, USB_DT_ENDPOINT_SIZE)) {
802 if (data->desc.bLength != USB_DT_ENDPOINT_SIZE
803 || data->desc.bDescriptorType != USB_DT_ENDPOINT)
805 if (len != USB_DT_ENDPOINT_SIZE) {
806 if (len != 2 * USB_DT_ENDPOINT_SIZE)
808 if (copy_from_user (&data->hs_desc, buf + USB_DT_ENDPOINT_SIZE,
809 USB_DT_ENDPOINT_SIZE)) {
812 if (data->hs_desc.bLength != USB_DT_ENDPOINT_SIZE
813 || data->hs_desc.bDescriptorType
814 != USB_DT_ENDPOINT) {
815 DBG(data->dev, "config %s, bad hs length or type\n",
821 spin_lock_irq (&data->dev->lock);
822 if (data->dev->state == STATE_DEV_UNBOUND) {
825 } else if ((ep = data->ep) == NULL) {
829 switch (data->dev->gadget->speed) {
832 value = usb_ep_enable (ep, &data->desc);
834 data->state = STATE_EP_ENABLED;
836 #ifdef CONFIG_USB_GADGET_DUALSPEED
838 /* fails if caller didn't provide that descriptor... */
839 value = usb_ep_enable (ep, &data->hs_desc);
841 data->state = STATE_EP_ENABLED;
845 DBG(data->dev, "unconnected, %s init abandoned\n",
850 fd->f_op = &ep_io_operations;
854 spin_unlock_irq (&data->dev->lock);
857 data->desc.bDescriptorType = 0;
858 data->hs_desc.bDescriptorType = 0;
860 mutex_unlock(&data->lock);
871 ep_open (struct inode *inode, struct file *fd)
873 struct ep_data *data = inode->i_private;
876 if (mutex_lock_interruptible(&data->lock) != 0)
878 spin_lock_irq (&data->dev->lock);
879 if (data->dev->state == STATE_DEV_UNBOUND)
881 else if (data->state == STATE_EP_DISABLED) {
883 data->state = STATE_EP_READY;
885 fd->private_data = data;
886 VDEBUG (data->dev, "%s ready\n", data->name);
888 DBG (data->dev, "%s state %d\n",
889 data->name, data->state);
890 spin_unlock_irq (&data->dev->lock);
891 mutex_unlock(&data->lock);
895 /* used before endpoint configuration */
896 static const struct file_operations ep_config_operations = {
897 .owner = THIS_MODULE,
902 .release = ep_release,
905 /*----------------------------------------------------------------------*/
907 /* EP0 IMPLEMENTATION can be partly in userspace.
909 * Drivers that use this facility receive various events, including
910 * control requests the kernel doesn't handle. Drivers that don't
911 * use this facility may be too simple-minded for real applications.
914 static inline void ep0_readable (struct dev_data *dev)
916 wake_up (&dev->wait);
917 kill_fasync (&dev->fasync, SIGIO, POLL_IN);
920 static void clean_req (struct usb_ep *ep, struct usb_request *req)
922 struct dev_data *dev = ep->driver_data;
924 if (req->buf != dev->rbuf) {
926 req->buf = dev->rbuf;
927 req->dma = DMA_ADDR_INVALID;
929 req->complete = epio_complete;
930 dev->setup_out_ready = 0;
933 static void ep0_complete (struct usb_ep *ep, struct usb_request *req)
935 struct dev_data *dev = ep->driver_data;
939 /* for control OUT, data must still get to userspace */
940 spin_lock_irqsave(&dev->lock, flags);
941 if (!dev->setup_in) {
942 dev->setup_out_error = (req->status != 0);
943 if (!dev->setup_out_error)
945 dev->setup_out_ready = 1;
949 /* clean up as appropriate */
950 if (free && req->buf != &dev->rbuf)
952 req->complete = epio_complete;
953 spin_unlock_irqrestore(&dev->lock, flags);
956 static int setup_req (struct usb_ep *ep, struct usb_request *req, u16 len)
958 struct dev_data *dev = ep->driver_data;
960 if (dev->setup_out_ready) {
961 DBG (dev, "ep0 request busy!\n");
964 if (len > sizeof (dev->rbuf))
965 req->buf = kmalloc(len, GFP_ATOMIC);
966 if (req->buf == NULL) {
967 req->buf = dev->rbuf;
970 req->complete = ep0_complete;
977 ep0_read (struct file *fd, char __user *buf, size_t len, loff_t *ptr)
979 struct dev_data *dev = fd->private_data;
981 enum ep0_state state;
983 spin_lock_irq (&dev->lock);
985 /* report fd mode change before acting on it */
986 if (dev->setup_abort) {
987 dev->setup_abort = 0;
992 /* control DATA stage */
993 if ((state = dev->state) == STATE_DEV_SETUP) {
995 if (dev->setup_in) { /* stall IN */
996 VDEBUG(dev, "ep0in stall\n");
997 (void) usb_ep_set_halt (dev->gadget->ep0);
999 dev->state = STATE_DEV_CONNECTED;
1001 } else if (len == 0) { /* ack SET_CONFIGURATION etc */
1002 struct usb_ep *ep = dev->gadget->ep0;
1003 struct usb_request *req = dev->req;
1005 if ((retval = setup_req (ep, req, 0)) == 0)
1006 retval = usb_ep_queue (ep, req, GFP_ATOMIC);
1007 dev->state = STATE_DEV_CONNECTED;
1009 /* assume that was SET_CONFIGURATION */
1010 if (dev->current_config) {
1013 if (gadget_is_dualspeed(dev->gadget)
1014 && (dev->gadget->speed
1016 power = dev->hs_config->bMaxPower;
1018 power = dev->config->bMaxPower;
1019 usb_gadget_vbus_draw(dev->gadget, 2 * power);
1022 } else { /* collect OUT data */
1023 if ((fd->f_flags & O_NONBLOCK) != 0
1024 && !dev->setup_out_ready) {
1028 spin_unlock_irq (&dev->lock);
1029 retval = wait_event_interruptible (dev->wait,
1030 dev->setup_out_ready != 0);
1032 /* FIXME state could change from under us */
1033 spin_lock_irq (&dev->lock);
1037 if (dev->state != STATE_DEV_SETUP) {
1038 retval = -ECANCELED;
1041 dev->state = STATE_DEV_CONNECTED;
1043 if (dev->setup_out_error)
1046 len = min (len, (size_t)dev->req->actual);
1047 // FIXME don't call this with the spinlock held ...
1048 if (copy_to_user (buf, dev->req->buf, len))
1050 clean_req (dev->gadget->ep0, dev->req);
1051 /* NOTE userspace can't yet choose to stall */
1057 /* else normal: return event data */
1058 if (len < sizeof dev->event [0]) {
1062 len -= len % sizeof (struct usb_gadgetfs_event);
1063 dev->usermode_setup = 1;
1066 /* return queued events right away */
1067 if (dev->ev_next != 0) {
1070 n = len / sizeof (struct usb_gadgetfs_event);
1071 if (dev->ev_next < n)
1074 /* ep0 i/o has special semantics during STATE_DEV_SETUP */
1075 for (i = 0; i < n; i++) {
1076 if (dev->event [i].type == GADGETFS_SETUP) {
1077 dev->state = STATE_DEV_SETUP;
1082 spin_unlock_irq (&dev->lock);
1083 len = n * sizeof (struct usb_gadgetfs_event);
1084 if (copy_to_user (buf, &dev->event, len))
1089 /* NOTE this doesn't guard against broken drivers;
1090 * concurrent ep0 readers may lose events.
1092 spin_lock_irq (&dev->lock);
1093 if (dev->ev_next > n) {
1094 memmove(&dev->event[0], &dev->event[n],
1095 sizeof (struct usb_gadgetfs_event)
1096 * (dev->ev_next - n));
1099 spin_unlock_irq (&dev->lock);
1103 if (fd->f_flags & O_NONBLOCK) {
1110 DBG (dev, "fail %s, state %d\n", __func__, state);
1113 case STATE_DEV_UNCONNECTED:
1114 case STATE_DEV_CONNECTED:
1115 spin_unlock_irq (&dev->lock);
1116 DBG (dev, "%s wait\n", __func__);
1118 /* wait for events */
1119 retval = wait_event_interruptible (dev->wait,
1123 spin_lock_irq (&dev->lock);
1128 spin_unlock_irq (&dev->lock);
1132 static struct usb_gadgetfs_event *
1133 next_event (struct dev_data *dev, enum usb_gadgetfs_event_type type)
1135 struct usb_gadgetfs_event *event;
1139 /* these events purge the queue */
1140 case GADGETFS_DISCONNECT:
1141 if (dev->state == STATE_DEV_SETUP)
1142 dev->setup_abort = 1;
1144 case GADGETFS_CONNECT:
1147 case GADGETFS_SETUP: /* previous request timed out */
1148 case GADGETFS_SUSPEND: /* same effect */
1149 /* these events can't be repeated */
1150 for (i = 0; i != dev->ev_next; i++) {
1151 if (dev->event [i].type != type)
1153 DBG(dev, "discard old event[%d] %d\n", i, type);
1155 if (i == dev->ev_next)
1157 /* indices start at zero, for simplicity */
1158 memmove (&dev->event [i], &dev->event [i + 1],
1159 sizeof (struct usb_gadgetfs_event)
1160 * (dev->ev_next - i));
1166 VDEBUG(dev, "event[%d] = %d\n", dev->ev_next, type);
1167 event = &dev->event [dev->ev_next++];
1168 BUG_ON (dev->ev_next > N_EVENT);
1169 memset (event, 0, sizeof *event);
1175 ep0_write (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
1177 struct dev_data *dev = fd->private_data;
1178 ssize_t retval = -ESRCH;
1180 spin_lock_irq (&dev->lock);
1182 /* report fd mode change before acting on it */
1183 if (dev->setup_abort) {
1184 dev->setup_abort = 0;
1187 /* data and/or status stage for control request */
1188 } else if (dev->state == STATE_DEV_SETUP) {
1190 /* IN DATA+STATUS caller makes len <= wLength */
1191 if (dev->setup_in) {
1192 retval = setup_req (dev->gadget->ep0, dev->req, len);
1194 dev->state = STATE_DEV_CONNECTED;
1195 spin_unlock_irq (&dev->lock);
1196 if (copy_from_user (dev->req->buf, buf, len))
1199 if (len < dev->setup_wLength)
1201 retval = usb_ep_queue (
1202 dev->gadget->ep0, dev->req,
1206 spin_lock_irq (&dev->lock);
1207 clean_req (dev->gadget->ep0, dev->req);
1208 spin_unlock_irq (&dev->lock);
1215 /* can stall some OUT transfers */
1216 } else if (dev->setup_can_stall) {
1217 VDEBUG(dev, "ep0out stall\n");
1218 (void) usb_ep_set_halt (dev->gadget->ep0);
1220 dev->state = STATE_DEV_CONNECTED;
1222 DBG(dev, "bogus ep0out stall!\n");
1225 DBG (dev, "fail %s, state %d\n", __func__, dev->state);
1227 spin_unlock_irq (&dev->lock);
1232 ep0_fasync (int f, struct file *fd, int on)
1234 struct dev_data *dev = fd->private_data;
1235 // caller must F_SETOWN before signal delivery happens
1236 VDEBUG (dev, "%s %s\n", __func__, on ? "on" : "off");
1237 return fasync_helper (f, fd, on, &dev->fasync);
1240 static struct usb_gadget_driver gadgetfs_driver;
1243 dev_release (struct inode *inode, struct file *fd)
1245 struct dev_data *dev = fd->private_data;
1247 /* closing ep0 === shutdown all */
1249 usb_gadget_unregister_driver (&gadgetfs_driver);
1251 /* at this point "good" hardware has disconnected the
1252 * device from USB; the host won't see it any more.
1253 * alternatively, all host requests will time out.
1260 /* other endpoints were all decoupled from this device */
1261 spin_lock_irq(&dev->lock);
1262 dev->state = STATE_DEV_DISABLED;
1263 spin_unlock_irq(&dev->lock);
1268 ep0_poll (struct file *fd, poll_table *wait)
1270 struct dev_data *dev = fd->private_data;
1273 poll_wait(fd, &dev->wait, wait);
1275 spin_lock_irq (&dev->lock);
1277 /* report fd mode change before acting on it */
1278 if (dev->setup_abort) {
1279 dev->setup_abort = 0;
1284 if (dev->state == STATE_DEV_SETUP) {
1285 if (dev->setup_in || dev->setup_can_stall)
1288 if (dev->ev_next != 0)
1292 spin_unlock_irq(&dev->lock);
1296 static long dev_ioctl (struct file *fd, unsigned code, unsigned long value)
1298 struct dev_data *dev = fd->private_data;
1299 struct usb_gadget *gadget = dev->gadget;
1302 if (gadget->ops->ioctl)
1303 ret = gadget->ops->ioctl (gadget, code, value);
1308 /* used after device configuration */
1309 static const struct file_operations ep0_io_operations = {
1310 .owner = THIS_MODULE,
1311 .llseek = no_llseek,
1315 .fasync = ep0_fasync,
1317 .unlocked_ioctl = dev_ioctl,
1318 .release = dev_release,
1321 /*----------------------------------------------------------------------*/
1323 /* The in-kernel gadget driver handles most ep0 issues, in particular
1324 * enumerating the single configuration (as provided from user space).
1326 * Unrecognized ep0 requests may be handled in user space.
1329 #ifdef CONFIG_USB_GADGET_DUALSPEED
1330 static void make_qualifier (struct dev_data *dev)
1332 struct usb_qualifier_descriptor qual;
1333 struct usb_device_descriptor *desc;
1335 qual.bLength = sizeof qual;
1336 qual.bDescriptorType = USB_DT_DEVICE_QUALIFIER;
1337 qual.bcdUSB = cpu_to_le16 (0x0200);
1340 qual.bDeviceClass = desc->bDeviceClass;
1341 qual.bDeviceSubClass = desc->bDeviceSubClass;
1342 qual.bDeviceProtocol = desc->bDeviceProtocol;
1344 /* assumes ep0 uses the same value for both speeds ... */
1345 qual.bMaxPacketSize0 = desc->bMaxPacketSize0;
1347 qual.bNumConfigurations = 1;
1350 memcpy (dev->rbuf, &qual, sizeof qual);
1355 config_buf (struct dev_data *dev, u8 type, unsigned index)
1360 /* only one configuration */
1364 if (gadget_is_dualspeed(dev->gadget)) {
1365 hs = (dev->gadget->speed == USB_SPEED_HIGH);
1366 if (type == USB_DT_OTHER_SPEED_CONFIG)
1370 dev->req->buf = dev->hs_config;
1371 len = le16_to_cpu(dev->hs_config->wTotalLength);
1373 dev->req->buf = dev->config;
1374 len = le16_to_cpu(dev->config->wTotalLength);
1376 ((u8 *)dev->req->buf) [1] = type;
1381 gadgetfs_setup (struct usb_gadget *gadget, const struct usb_ctrlrequest *ctrl)
1383 struct dev_data *dev = get_gadget_data (gadget);
1384 struct usb_request *req = dev->req;
1385 int value = -EOPNOTSUPP;
1386 struct usb_gadgetfs_event *event;
1387 u16 w_value = le16_to_cpu(ctrl->wValue);
1388 u16 w_length = le16_to_cpu(ctrl->wLength);
1390 spin_lock (&dev->lock);
1391 dev->setup_abort = 0;
1392 if (dev->state == STATE_DEV_UNCONNECTED) {
1393 if (gadget_is_dualspeed(gadget)
1394 && gadget->speed == USB_SPEED_HIGH
1395 && dev->hs_config == NULL) {
1396 spin_unlock(&dev->lock);
1397 ERROR (dev, "no high speed config??\n");
1401 dev->state = STATE_DEV_CONNECTED;
1402 dev->dev->bMaxPacketSize0 = gadget->ep0->maxpacket;
1404 INFO (dev, "connected\n");
1405 event = next_event (dev, GADGETFS_CONNECT);
1406 event->u.speed = gadget->speed;
1409 /* host may have given up waiting for response. we can miss control
1410 * requests handled lower down (device/endpoint status and features);
1411 * then ep0_{read,write} will report the wrong status. controller
1412 * driver will have aborted pending i/o.
1414 } else if (dev->state == STATE_DEV_SETUP)
1415 dev->setup_abort = 1;
1417 req->buf = dev->rbuf;
1418 req->dma = DMA_ADDR_INVALID;
1419 req->context = NULL;
1420 value = -EOPNOTSUPP;
1421 switch (ctrl->bRequest) {
1423 case USB_REQ_GET_DESCRIPTOR:
1424 if (ctrl->bRequestType != USB_DIR_IN)
1426 switch (w_value >> 8) {
1429 value = min (w_length, (u16) sizeof *dev->dev);
1430 req->buf = dev->dev;
1432 #ifdef CONFIG_USB_GADGET_DUALSPEED
1433 case USB_DT_DEVICE_QUALIFIER:
1434 if (!dev->hs_config)
1436 value = min (w_length, (u16)
1437 sizeof (struct usb_qualifier_descriptor));
1438 make_qualifier (dev);
1440 case USB_DT_OTHER_SPEED_CONFIG:
1444 value = config_buf (dev,
1448 value = min (w_length, (u16) value);
1453 default: // all others are errors
1458 /* currently one config, two speeds */
1459 case USB_REQ_SET_CONFIGURATION:
1460 if (ctrl->bRequestType != 0)
1462 if (0 == (u8) w_value) {
1464 dev->current_config = 0;
1465 usb_gadget_vbus_draw(gadget, 8 /* mA */ );
1466 // user mode expected to disable endpoints
1470 if (gadget_is_dualspeed(gadget)
1471 && gadget->speed == USB_SPEED_HIGH) {
1472 config = dev->hs_config->bConfigurationValue;
1473 power = dev->hs_config->bMaxPower;
1475 config = dev->config->bConfigurationValue;
1476 power = dev->config->bMaxPower;
1479 if (config == (u8) w_value) {
1481 dev->current_config = config;
1482 usb_gadget_vbus_draw(gadget, 2 * power);
1486 /* report SET_CONFIGURATION like any other control request,
1487 * except that usermode may not stall this. the next
1488 * request mustn't be allowed start until this finishes:
1489 * endpoints and threads set up, etc.
1491 * NOTE: older PXA hardware (before PXA 255: without UDCCFR)
1492 * has bad/racey automagic that prevents synchronizing here.
1493 * even kernel mode drivers often miss them.
1496 INFO (dev, "configuration #%d\n", dev->current_config);
1497 if (dev->usermode_setup) {
1498 dev->setup_can_stall = 0;
1504 #ifndef CONFIG_USB_GADGET_PXA25X
1505 /* PXA automagically handles this request too */
1506 case USB_REQ_GET_CONFIGURATION:
1507 if (ctrl->bRequestType != 0x80)
1509 *(u8 *)req->buf = dev->current_config;
1510 value = min (w_length, (u16) 1);
1516 VDEBUG (dev, "%s req%02x.%02x v%04x i%04x l%d\n",
1517 dev->usermode_setup ? "delegate" : "fail",
1518 ctrl->bRequestType, ctrl->bRequest,
1519 w_value, le16_to_cpu(ctrl->wIndex), w_length);
1521 /* if there's an ep0 reader, don't stall */
1522 if (dev->usermode_setup) {
1523 dev->setup_can_stall = 1;
1525 dev->setup_in = (ctrl->bRequestType & USB_DIR_IN)
1527 dev->setup_wLength = w_length;
1528 dev->setup_out_ready = 0;
1529 dev->setup_out_error = 0;
1532 /* read DATA stage for OUT right away */
1533 if (unlikely (!dev->setup_in && w_length)) {
1534 value = setup_req (gadget->ep0, dev->req,
1538 value = usb_ep_queue (gadget->ep0, dev->req,
1541 clean_req (gadget->ep0, dev->req);
1545 /* we can't currently stall these */
1546 dev->setup_can_stall = 0;
1549 /* state changes when reader collects event */
1550 event = next_event (dev, GADGETFS_SETUP);
1551 event->u.setup = *ctrl;
1553 spin_unlock (&dev->lock);
1558 /* proceed with data transfer and status phases? */
1559 if (value >= 0 && dev->state != STATE_DEV_SETUP) {
1560 req->length = value;
1561 req->zero = value < w_length;
1562 value = usb_ep_queue (gadget->ep0, req, GFP_ATOMIC);
1564 DBG (dev, "ep_queue --> %d\n", value);
1569 /* device stalls when value < 0 */
1570 spin_unlock (&dev->lock);
1574 static void destroy_ep_files (struct dev_data *dev)
1576 struct list_head *entry, *tmp;
1578 DBG (dev, "%s %d\n", __func__, dev->state);
1580 /* dev->state must prevent interference */
1582 spin_lock_irq (&dev->lock);
1583 list_for_each_safe (entry, tmp, &dev->epfiles) {
1585 struct inode *parent;
1586 struct dentry *dentry;
1588 /* break link to FS */
1589 ep = list_entry (entry, struct ep_data, epfiles);
1590 list_del_init (&ep->epfiles);
1591 dentry = ep->dentry;
1593 parent = dentry->d_parent->d_inode;
1595 /* break link to controller */
1596 if (ep->state == STATE_EP_ENABLED)
1597 (void) usb_ep_disable (ep->ep);
1598 ep->state = STATE_EP_UNBOUND;
1599 usb_ep_free_request (ep->ep, ep->req);
1601 wake_up (&ep->wait);
1604 spin_unlock_irq (&dev->lock);
1606 /* break link to dcache */
1607 mutex_lock (&parent->i_mutex);
1610 mutex_unlock (&parent->i_mutex);
1612 /* fds may still be open */
1615 spin_unlock_irq (&dev->lock);
1619 static struct inode *
1620 gadgetfs_create_file (struct super_block *sb, char const *name,
1621 void *data, const struct file_operations *fops,
1622 struct dentry **dentry_p);
1624 static int activate_ep_files (struct dev_data *dev)
1627 struct ep_data *data;
1629 gadget_for_each_ep (ep, dev->gadget) {
1631 data = kzalloc(sizeof(*data), GFP_KERNEL);
1634 data->state = STATE_EP_DISABLED;
1635 mutex_init(&data->lock);
1636 init_waitqueue_head (&data->wait);
1638 strncpy (data->name, ep->name, sizeof (data->name) - 1);
1639 atomic_set (&data->count, 1);
1644 ep->driver_data = data;
1646 data->req = usb_ep_alloc_request (ep, GFP_KERNEL);
1650 data->inode = gadgetfs_create_file (dev->sb, data->name,
1651 data, &ep_config_operations,
1655 list_add_tail (&data->epfiles, &dev->epfiles);
1660 usb_ep_free_request (ep, data->req);
1665 DBG (dev, "%s enomem\n", __func__);
1666 destroy_ep_files (dev);
1671 gadgetfs_unbind (struct usb_gadget *gadget)
1673 struct dev_data *dev = get_gadget_data (gadget);
1675 DBG (dev, "%s\n", __func__);
1677 spin_lock_irq (&dev->lock);
1678 dev->state = STATE_DEV_UNBOUND;
1679 spin_unlock_irq (&dev->lock);
1681 destroy_ep_files (dev);
1682 gadget->ep0->driver_data = NULL;
1683 set_gadget_data (gadget, NULL);
1685 /* we've already been disconnected ... no i/o is active */
1687 usb_ep_free_request (gadget->ep0, dev->req);
1688 DBG (dev, "%s done\n", __func__);
1692 static struct dev_data *the_device;
1695 gadgetfs_bind (struct usb_gadget *gadget)
1697 struct dev_data *dev = the_device;
1701 if (0 != strcmp (CHIP, gadget->name)) {
1702 pr_err("%s expected %s controller not %s\n",
1703 shortname, CHIP, gadget->name);
1707 set_gadget_data (gadget, dev);
1708 dev->gadget = gadget;
1709 gadget->ep0->driver_data = dev;
1710 dev->dev->bMaxPacketSize0 = gadget->ep0->maxpacket;
1712 /* preallocate control response and buffer */
1713 dev->req = usb_ep_alloc_request (gadget->ep0, GFP_KERNEL);
1716 dev->req->context = NULL;
1717 dev->req->complete = epio_complete;
1719 if (activate_ep_files (dev) < 0)
1722 INFO (dev, "bound to %s driver\n", gadget->name);
1723 spin_lock_irq(&dev->lock);
1724 dev->state = STATE_DEV_UNCONNECTED;
1725 spin_unlock_irq(&dev->lock);
1730 gadgetfs_unbind (gadget);
1735 gadgetfs_disconnect (struct usb_gadget *gadget)
1737 struct dev_data *dev = get_gadget_data (gadget);
1739 spin_lock (&dev->lock);
1740 if (dev->state == STATE_DEV_UNCONNECTED)
1742 dev->state = STATE_DEV_UNCONNECTED;
1744 INFO (dev, "disconnected\n");
1745 next_event (dev, GADGETFS_DISCONNECT);
1748 spin_unlock (&dev->lock);
1752 gadgetfs_suspend (struct usb_gadget *gadget)
1754 struct dev_data *dev = get_gadget_data (gadget);
1756 INFO (dev, "suspended from state %d\n", dev->state);
1757 spin_lock (&dev->lock);
1758 switch (dev->state) {
1759 case STATE_DEV_SETUP: // VERY odd... host died??
1760 case STATE_DEV_CONNECTED:
1761 case STATE_DEV_UNCONNECTED:
1762 next_event (dev, GADGETFS_SUSPEND);
1768 spin_unlock (&dev->lock);
1771 static struct usb_gadget_driver gadgetfs_driver = {
1772 #ifdef CONFIG_USB_GADGET_DUALSPEED
1773 .speed = USB_SPEED_HIGH,
1775 .speed = USB_SPEED_FULL,
1777 .function = (char *) driver_desc,
1778 .bind = gadgetfs_bind,
1779 .unbind = gadgetfs_unbind,
1780 .setup = gadgetfs_setup,
1781 .disconnect = gadgetfs_disconnect,
1782 .suspend = gadgetfs_suspend,
1785 .name = (char *) shortname,
1789 /*----------------------------------------------------------------------*/
1791 static void gadgetfs_nop(struct usb_gadget *arg) { }
1793 static int gadgetfs_probe (struct usb_gadget *gadget)
1795 CHIP = gadget->name;
1799 static struct usb_gadget_driver probe_driver = {
1800 .speed = USB_SPEED_HIGH,
1801 .bind = gadgetfs_probe,
1802 .unbind = gadgetfs_nop,
1803 .setup = (void *)gadgetfs_nop,
1804 .disconnect = gadgetfs_nop,
1811 /* DEVICE INITIALIZATION
1813 * fd = open ("/dev/gadget/$CHIP", O_RDWR)
1814 * status = write (fd, descriptors, sizeof descriptors)
1816 * That write establishes the device configuration, so the kernel can
1817 * bind to the controller ... guaranteeing it can handle enumeration
1818 * at all necessary speeds. Descriptor order is:
1820 * . message tag (u32, host order) ... for now, must be zero; it
1821 * would change to support features like multi-config devices
1822 * . full/low speed config ... all wTotalLength bytes (with interface,
1823 * class, altsetting, endpoint, and other descriptors)
1824 * . high speed config ... all descriptors, for high speed operation;
1825 * this one's optional except for high-speed hardware
1826 * . device descriptor
1828 * Endpoints are not yet enabled. Drivers must wait until device
1829 * configuration and interface altsetting changes create
1830 * the need to configure (or unconfigure) them.
1832 * After initialization, the device stays active for as long as that
1833 * $CHIP file is open. Events must then be read from that descriptor,
1834 * such as configuration notifications.
1837 static int is_valid_config (struct usb_config_descriptor *config)
1839 return config->bDescriptorType == USB_DT_CONFIG
1840 && config->bLength == USB_DT_CONFIG_SIZE
1841 && config->bConfigurationValue != 0
1842 && (config->bmAttributes & USB_CONFIG_ATT_ONE) != 0
1843 && (config->bmAttributes & USB_CONFIG_ATT_WAKEUP) == 0;
1844 /* FIXME if gadget->is_otg, _must_ include an otg descriptor */
1845 /* FIXME check lengths: walk to end */
1849 dev_config (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
1851 struct dev_data *dev = fd->private_data;
1852 ssize_t value = len, length = len;
1857 if (len < (USB_DT_CONFIG_SIZE + USB_DT_DEVICE_SIZE + 4))
1860 /* we might need to change message format someday */
1861 if (copy_from_user (&tag, buf, 4))
1868 kbuf = memdup_user(buf, length);
1870 return PTR_ERR(kbuf);
1872 spin_lock_irq (&dev->lock);
1878 /* full or low speed config */
1879 dev->config = (void *) kbuf;
1880 total = le16_to_cpu(dev->config->wTotalLength);
1881 if (!is_valid_config (dev->config) || total >= length)
1886 /* optional high speed config */
1887 if (kbuf [1] == USB_DT_CONFIG) {
1888 dev->hs_config = (void *) kbuf;
1889 total = le16_to_cpu(dev->hs_config->wTotalLength);
1890 if (!is_valid_config (dev->hs_config) || total >= length)
1896 /* could support multiple configs, using another encoding! */
1898 /* device descriptor (tweaked for paranoia) */
1899 if (length != USB_DT_DEVICE_SIZE)
1901 dev->dev = (void *)kbuf;
1902 if (dev->dev->bLength != USB_DT_DEVICE_SIZE
1903 || dev->dev->bDescriptorType != USB_DT_DEVICE
1904 || dev->dev->bNumConfigurations != 1)
1906 dev->dev->bNumConfigurations = 1;
1907 dev->dev->bcdUSB = cpu_to_le16 (0x0200);
1909 /* triggers gadgetfs_bind(); then we can enumerate. */
1910 spin_unlock_irq (&dev->lock);
1911 value = usb_gadget_register_driver (&gadgetfs_driver);
1916 /* at this point "good" hardware has for the first time
1917 * let the USB the host see us. alternatively, if users
1918 * unplug/replug that will clear all the error state.
1920 * note: everything running before here was guaranteed
1921 * to choke driver model style diagnostics. from here
1922 * on, they can work ... except in cleanup paths that
1923 * kick in after the ep0 descriptor is closed.
1925 fd->f_op = &ep0_io_operations;
1931 spin_unlock_irq (&dev->lock);
1932 pr_debug ("%s: %s fail %Zd, %p\n", shortname, __func__, value, dev);
1939 dev_open (struct inode *inode, struct file *fd)
1941 struct dev_data *dev = inode->i_private;
1944 spin_lock_irq(&dev->lock);
1945 if (dev->state == STATE_DEV_DISABLED) {
1947 dev->state = STATE_DEV_OPENED;
1948 fd->private_data = dev;
1952 spin_unlock_irq(&dev->lock);
1956 static const struct file_operations dev_init_operations = {
1957 .owner = THIS_MODULE,
1958 .llseek = no_llseek,
1961 .write = dev_config,
1962 .fasync = ep0_fasync,
1963 .unlocked_ioctl = dev_ioctl,
1964 .release = dev_release,
1967 /*----------------------------------------------------------------------*/
1969 /* FILESYSTEM AND SUPERBLOCK OPERATIONS
1971 * Mounting the filesystem creates a controller file, used first for
1972 * device configuration then later for event monitoring.
1976 /* FIXME PAM etc could set this security policy without mount options
1977 * if epfiles inherited ownership and permissons from ep0 ...
1980 static unsigned default_uid;
1981 static unsigned default_gid;
1982 static unsigned default_perm = S_IRUSR | S_IWUSR;
1984 module_param (default_uid, uint, 0644);
1985 module_param (default_gid, uint, 0644);
1986 module_param (default_perm, uint, 0644);
1989 static struct inode *
1990 gadgetfs_make_inode (struct super_block *sb,
1991 void *data, const struct file_operations *fops,
1994 struct inode *inode = new_inode (sb);
1997 inode->i_mode = mode;
1998 inode->i_uid = default_uid;
1999 inode->i_gid = default_gid;
2000 inode->i_atime = inode->i_mtime = inode->i_ctime
2002 inode->i_private = data;
2003 inode->i_fop = fops;
2008 /* creates in fs root directory, so non-renamable and non-linkable.
2009 * so inode and dentry are paired, until device reconfig.
2011 static struct inode *
2012 gadgetfs_create_file (struct super_block *sb, char const *name,
2013 void *data, const struct file_operations *fops,
2014 struct dentry **dentry_p)
2016 struct dentry *dentry;
2017 struct inode *inode;
2019 dentry = d_alloc_name(sb->s_root, name);
2023 inode = gadgetfs_make_inode (sb, data, fops,
2024 S_IFREG | (default_perm & S_IRWXUGO));
2029 d_add (dentry, inode);
2034 static const struct super_operations gadget_fs_operations = {
2035 .statfs = simple_statfs,
2036 .drop_inode = generic_delete_inode,
2040 gadgetfs_fill_super (struct super_block *sb, void *opts, int silent)
2042 struct inode *inode;
2044 struct dev_data *dev;
2049 /* fake probe to determine $CHIP */
2050 (void) usb_gadget_register_driver (&probe_driver);
2055 sb->s_blocksize = PAGE_CACHE_SIZE;
2056 sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
2057 sb->s_magic = GADGETFS_MAGIC;
2058 sb->s_op = &gadget_fs_operations;
2059 sb->s_time_gran = 1;
2062 inode = gadgetfs_make_inode (sb,
2063 NULL, &simple_dir_operations,
2064 S_IFDIR | S_IRUGO | S_IXUGO);
2067 inode->i_op = &simple_dir_inode_operations;
2068 if (!(d = d_alloc_root (inode)))
2072 /* the ep0 file is named after the controller we expect;
2073 * user mode code can use it for sanity checks, like we do.
2080 if (!gadgetfs_create_file (sb, CHIP,
2081 dev, &dev_init_operations,
2085 /* other endpoint files are available after hardware setup,
2086 * from binding to a controller.
2101 /* "mount -t gadgetfs path /dev/gadget" ends up here */
2103 gadgetfs_get_sb (struct file_system_type *t, int flags,
2104 const char *path, void *opts, struct vfsmount *mnt)
2106 return get_sb_single (t, flags, opts, gadgetfs_fill_super, mnt);
2110 gadgetfs_kill_sb (struct super_block *sb)
2112 kill_litter_super (sb);
2114 put_dev (the_device);
2119 /*----------------------------------------------------------------------*/
2121 static struct file_system_type gadgetfs_type = {
2122 .owner = THIS_MODULE,
2124 .get_sb = gadgetfs_get_sb,
2125 .kill_sb = gadgetfs_kill_sb,
2128 /*----------------------------------------------------------------------*/
2130 static int __init init (void)
2134 status = register_filesystem (&gadgetfs_type);
2136 pr_info ("%s: %s, version " DRIVER_VERSION "\n",
2137 shortname, driver_desc);
2142 static void __exit cleanup (void)
2144 pr_debug ("unregister %s\n", shortname);
2145 unregister_filesystem (&gadgetfs_type);
2147 module_exit (cleanup);