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>
28 #include <linux/device.h>
29 #include <linux/moduleparam.h>
31 #include <linux/usb/gadgetfs.h>
32 #include <linux/usb/gadget.h>
36 * The gadgetfs API maps each endpoint to a file descriptor so that you
37 * can use standard synchronous read/write calls for I/O. There's some
38 * O_NONBLOCK and O_ASYNC/FASYNC style i/o support. Example usermode
39 * drivers show how this works in practice. You can also use AIO to
40 * eliminate I/O gaps between requests, to help when streaming data.
42 * Key parts that must be USB-specific are protocols defining how the
43 * read/write operations relate to the hardware state machines. There
44 * are two types of files. One type is for the device, implementing ep0.
45 * The other type is for each IN or OUT endpoint. In both cases, the
46 * user mode driver must configure the hardware before using it.
48 * - First, dev_config() is called when /dev/gadget/$CHIP is configured
49 * (by writing configuration and device descriptors). Afterwards it
50 * may serve as a source of device events, used to handle all control
51 * requests other than basic enumeration.
53 * - Then, after a SET_CONFIGURATION control request, ep_config() is
54 * called when each /dev/gadget/ep* file is configured (by writing
55 * endpoint descriptors). Afterwards these files are used to write()
56 * IN data or to read() OUT data. To halt the endpoint, a "wrong
57 * direction" request is issued (like reading an IN endpoint).
59 * Unlike "usbfs" the only ioctl()s are for things that are rare, and maybe
60 * not possible on all hardware. For example, precise fault handling with
61 * respect to data left in endpoint fifos after aborted operations; or
62 * selective clearing of endpoint halts, to implement SET_INTERFACE.
65 #define DRIVER_DESC "USB Gadget filesystem"
66 #define DRIVER_VERSION "24 Aug 2004"
68 static const char driver_desc [] = DRIVER_DESC;
69 static const char shortname [] = "gadgetfs";
71 MODULE_DESCRIPTION (DRIVER_DESC);
72 MODULE_AUTHOR ("David Brownell");
73 MODULE_LICENSE ("GPL");
76 /*----------------------------------------------------------------------*/
78 #define GADGETFS_MAGIC 0xaee71ee7
79 #define DMA_ADDR_INVALID (~(dma_addr_t)0)
81 /* /dev/gadget/$CHIP represents ep0 and the whole device */
83 /* DISBLED is the initial state.
85 STATE_DEV_DISABLED = 0,
87 /* Only one open() of /dev/gadget/$CHIP; only one file tracks
88 * ep0/device i/o modes and binding to the controller. Driver
89 * must always write descriptors to initialize the device, then
90 * the device becomes UNCONNECTED until enumeration.
94 /* From then on, ep0 fd is in either of two basic modes:
95 * - (UN)CONNECTED: read usb_gadgetfs_event(s) from it
96 * - SETUP: read/write will transfer control data and succeed;
97 * or if "wrong direction", performs protocol stall
99 STATE_DEV_UNCONNECTED,
103 /* UNBOUND means the driver closed ep0, so the device won't be
104 * accessible again (DEV_DISABLED) until all fds are closed.
109 /* enough for the whole queue: most events invalidate others */
115 enum ep0_state state; /* P: lock */
116 struct usb_gadgetfs_event event [N_EVENT];
118 struct fasync_struct *fasync;
121 /* drivers reading ep0 MUST handle control requests (SETUP)
122 * reported that way; else the host will time out.
124 unsigned usermode_setup : 1,
130 unsigned setup_wLength;
132 /* the rest is basically write-once */
133 struct usb_config_descriptor *config, *hs_config;
134 struct usb_device_descriptor *dev;
135 struct usb_request *req;
136 struct usb_gadget *gadget;
137 struct list_head epfiles;
139 wait_queue_head_t wait;
140 struct super_block *sb;
141 struct dentry *dentry;
143 /* except this scratch i/o buffer for ep0 */
147 static inline void get_dev (struct dev_data *data)
149 atomic_inc (&data->count);
152 static void put_dev (struct dev_data *data)
154 if (likely (!atomic_dec_and_test (&data->count)))
156 /* needs no more cleanup */
157 BUG_ON (waitqueue_active (&data->wait));
161 static struct dev_data *dev_new (void)
163 struct dev_data *dev;
165 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
168 dev->state = STATE_DEV_DISABLED;
169 atomic_set (&dev->count, 1);
170 spin_lock_init (&dev->lock);
171 INIT_LIST_HEAD (&dev->epfiles);
172 init_waitqueue_head (&dev->wait);
176 /*----------------------------------------------------------------------*/
178 /* other /dev/gadget/$ENDPOINT files represent endpoints */
180 STATE_EP_DISABLED = 0,
190 struct dev_data *dev;
191 /* must hold dev->lock before accessing ep or req */
193 struct usb_request *req;
196 struct usb_endpoint_descriptor desc, hs_desc;
197 struct list_head epfiles;
198 wait_queue_head_t wait;
199 struct dentry *dentry;
203 static inline void get_ep (struct ep_data *data)
205 atomic_inc (&data->count);
208 static void put_ep (struct ep_data *data)
210 if (likely (!atomic_dec_and_test (&data->count)))
213 /* needs no more cleanup */
214 BUG_ON (!list_empty (&data->epfiles));
215 BUG_ON (waitqueue_active (&data->wait));
219 /*----------------------------------------------------------------------*/
221 /* most "how to use the hardware" policy choices are in userspace:
222 * mapping endpoint roles (which the driver needs) to the capabilities
223 * which the usb controller has. most of those capabilities are exposed
224 * implicitly, starting with the driver name and then endpoint names.
227 static const char *CHIP;
229 /*----------------------------------------------------------------------*/
231 /* NOTE: don't use dev_printk calls before binding to the gadget
232 * at the end of ep0 configuration, or after unbind.
235 /* too wordy: dev_printk(level , &(d)->gadget->dev , fmt , ## args) */
236 #define xprintk(d,level,fmt,args...) \
237 printk(level "%s: " fmt , shortname , ## args)
240 #define DBG(dev,fmt,args...) \
241 xprintk(dev , KERN_DEBUG , fmt , ## args)
243 #define DBG(dev,fmt,args...) \
250 #define VDEBUG(dev,fmt,args...) \
254 #define ERROR(dev,fmt,args...) \
255 xprintk(dev , KERN_ERR , fmt , ## args)
256 #define INFO(dev,fmt,args...) \
257 xprintk(dev , KERN_INFO , fmt , ## args)
260 /*----------------------------------------------------------------------*/
262 /* SYNCHRONOUS ENDPOINT OPERATIONS (bulk/intr/iso)
264 * After opening, configure non-control endpoints. Then use normal
265 * stream read() and write() requests; and maybe ioctl() to get more
266 * precise FIFO status when recovering from cancellation.
269 static void epio_complete (struct usb_ep *ep, struct usb_request *req)
271 struct ep_data *epdata = ep->driver_data;
276 epdata->status = req->status;
278 epdata->status = req->actual;
279 complete ((struct completion *)req->context);
282 /* tasklock endpoint, returning when it's connected.
283 * still need dev->lock to use epdata->ep.
286 get_ready_ep (unsigned f_flags, struct ep_data *epdata)
290 if (f_flags & O_NONBLOCK) {
291 if (!mutex_trylock(&epdata->lock))
293 if (epdata->state != STATE_EP_ENABLED) {
294 mutex_unlock(&epdata->lock);
302 val = mutex_lock_interruptible(&epdata->lock);
306 switch (epdata->state) {
307 case STATE_EP_ENABLED:
309 // case STATE_EP_DISABLED: /* "can't happen" */
310 // case STATE_EP_READY: /* "can't happen" */
311 default: /* error! */
312 pr_debug ("%s: ep %p not available, state %d\n",
313 shortname, epdata, epdata->state);
315 case STATE_EP_UNBOUND: /* clean disconnect */
317 mutex_unlock(&epdata->lock);
323 ep_io (struct ep_data *epdata, void *buf, unsigned len)
325 DECLARE_COMPLETION_ONSTACK (done);
328 spin_lock_irq (&epdata->dev->lock);
329 if (likely (epdata->ep != NULL)) {
330 struct usb_request *req = epdata->req;
332 req->context = &done;
333 req->complete = epio_complete;
336 value = usb_ep_queue (epdata->ep, req, GFP_ATOMIC);
339 spin_unlock_irq (&epdata->dev->lock);
341 if (likely (value == 0)) {
342 value = wait_event_interruptible (done.wait, done.done);
344 spin_lock_irq (&epdata->dev->lock);
345 if (likely (epdata->ep != NULL)) {
346 DBG (epdata->dev, "%s i/o interrupted\n",
348 usb_ep_dequeue (epdata->ep, epdata->req);
349 spin_unlock_irq (&epdata->dev->lock);
351 wait_event (done.wait, done.done);
352 if (epdata->status == -ECONNRESET)
353 epdata->status = -EINTR;
355 spin_unlock_irq (&epdata->dev->lock);
357 DBG (epdata->dev, "endpoint gone\n");
358 epdata->status = -ENODEV;
361 return epdata->status;
367 /* handle a synchronous OUT bulk/intr/iso transfer */
369 ep_read (struct file *fd, char __user *buf, size_t len, loff_t *ptr)
371 struct ep_data *data = fd->private_data;
375 if ((value = get_ready_ep (fd->f_flags, data)) < 0)
378 /* halt any endpoint by doing a "wrong direction" i/o call */
379 if (usb_endpoint_dir_in(&data->desc)) {
380 if (usb_endpoint_xfer_isoc(&data->desc)) {
381 mutex_unlock(&data->lock);
384 DBG (data->dev, "%s halt\n", data->name);
385 spin_lock_irq (&data->dev->lock);
386 if (likely (data->ep != NULL))
387 usb_ep_set_halt (data->ep);
388 spin_unlock_irq (&data->dev->lock);
389 mutex_unlock(&data->lock);
393 /* FIXME readahead for O_NONBLOCK and poll(); careful with ZLPs */
396 kbuf = kmalloc (len, GFP_KERNEL);
397 if (unlikely (!kbuf))
400 value = ep_io (data, kbuf, len);
401 VDEBUG (data->dev, "%s read %zu OUT, status %d\n",
402 data->name, len, (int) value);
403 if (value >= 0 && copy_to_user (buf, kbuf, value))
407 mutex_unlock(&data->lock);
412 /* handle a synchronous IN bulk/intr/iso transfer */
414 ep_write (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
416 struct ep_data *data = fd->private_data;
420 if ((value = get_ready_ep (fd->f_flags, data)) < 0)
423 /* halt any endpoint by doing a "wrong direction" i/o call */
424 if (!usb_endpoint_dir_in(&data->desc)) {
425 if (usb_endpoint_xfer_isoc(&data->desc)) {
426 mutex_unlock(&data->lock);
429 DBG (data->dev, "%s halt\n", data->name);
430 spin_lock_irq (&data->dev->lock);
431 if (likely (data->ep != NULL))
432 usb_ep_set_halt (data->ep);
433 spin_unlock_irq (&data->dev->lock);
434 mutex_unlock(&data->lock);
438 /* FIXME writebehind for O_NONBLOCK and poll(), qlen = 1 */
441 kbuf = kmalloc (len, GFP_KERNEL);
444 if (copy_from_user (kbuf, buf, len)) {
449 value = ep_io (data, kbuf, len);
450 VDEBUG (data->dev, "%s write %zu IN, status %d\n",
451 data->name, len, (int) value);
453 mutex_unlock(&data->lock);
459 ep_release (struct inode *inode, struct file *fd)
461 struct ep_data *data = fd->private_data;
464 value = mutex_lock_interruptible(&data->lock);
468 /* clean up if this can be reopened */
469 if (data->state != STATE_EP_UNBOUND) {
470 data->state = STATE_EP_DISABLED;
471 data->desc.bDescriptorType = 0;
472 data->hs_desc.bDescriptorType = 0;
473 usb_ep_disable(data->ep);
475 mutex_unlock(&data->lock);
480 static long ep_ioctl(struct file *fd, unsigned code, unsigned long value)
482 struct ep_data *data = fd->private_data;
485 if ((status = get_ready_ep (fd->f_flags, data)) < 0)
488 spin_lock_irq (&data->dev->lock);
489 if (likely (data->ep != NULL)) {
491 case GADGETFS_FIFO_STATUS:
492 status = usb_ep_fifo_status (data->ep);
494 case GADGETFS_FIFO_FLUSH:
495 usb_ep_fifo_flush (data->ep);
497 case GADGETFS_CLEAR_HALT:
498 status = usb_ep_clear_halt (data->ep);
505 spin_unlock_irq (&data->dev->lock);
506 mutex_unlock(&data->lock);
510 /*----------------------------------------------------------------------*/
512 /* ASYNCHRONOUS ENDPOINT I/O OPERATIONS (bulk/intr/iso) */
515 struct usb_request *req;
516 struct ep_data *epdata;
518 const struct iovec *iv;
519 unsigned long nr_segs;
523 static int ep_aio_cancel(struct kiocb *iocb, struct io_event *e)
525 struct kiocb_priv *priv = iocb->private;
526 struct ep_data *epdata;
530 epdata = priv->epdata;
531 // spin_lock(&epdata->dev->lock);
532 kiocbSetCancelled(iocb);
533 if (likely(epdata && epdata->ep && priv->req))
534 value = usb_ep_dequeue (epdata->ep, priv->req);
537 // spin_unlock(&epdata->dev->lock);
544 static ssize_t ep_aio_read_retry(struct kiocb *iocb)
546 struct kiocb_priv *priv = iocb->private;
551 /* we "retry" to get the right mm context for this: */
553 /* copy stuff into user buffers */
554 total = priv->actual;
557 for (i=0; i < priv->nr_segs; i++) {
558 ssize_t this = min((ssize_t)(priv->iv[i].iov_len), total);
560 if (copy_to_user(priv->iv[i].iov_base, to_copy, this)) {
577 static void ep_aio_complete(struct usb_ep *ep, struct usb_request *req)
579 struct kiocb *iocb = req->context;
580 struct kiocb_priv *priv = iocb->private;
581 struct ep_data *epdata = priv->epdata;
583 /* lock against disconnect (and ideally, cancel) */
584 spin_lock(&epdata->dev->lock);
588 /* if this was a write or a read returning no data then we
589 * don't need to copy anything to userspace, so we can
590 * complete the aio request immediately.
592 if (priv->iv == NULL || unlikely(req->actual == 0)) {
595 iocb->private = NULL;
596 /* aio_complete() reports bytes-transferred _and_ faults */
597 aio_complete(iocb, req->actual ? req->actual : req->status,
600 /* retry() won't report both; so we hide some faults */
601 if (unlikely(0 != req->status))
602 DBG(epdata->dev, "%s fault %d len %d\n",
603 ep->name, req->status, req->actual);
605 priv->buf = req->buf;
606 priv->actual = req->actual;
609 spin_unlock(&epdata->dev->lock);
611 usb_ep_free_request(ep, req);
620 struct ep_data *epdata,
621 const struct iovec *iv,
622 unsigned long nr_segs
625 struct kiocb_priv *priv;
626 struct usb_request *req;
629 priv = kmalloc(sizeof *priv, GFP_KERNEL);
636 iocb->private = priv;
638 priv->nr_segs = nr_segs;
640 value = get_ready_ep(iocb->ki_filp->f_flags, epdata);
641 if (unlikely(value < 0)) {
646 iocb->ki_cancel = ep_aio_cancel;
648 priv->epdata = epdata;
651 /* each kiocb is coupled to one usb_request, but we can't
652 * allocate or submit those if the host disconnected.
654 spin_lock_irq(&epdata->dev->lock);
655 if (likely(epdata->ep)) {
656 req = usb_ep_alloc_request(epdata->ep, GFP_ATOMIC);
661 req->complete = ep_aio_complete;
663 value = usb_ep_queue(epdata->ep, req, GFP_ATOMIC);
664 if (unlikely(0 != value))
665 usb_ep_free_request(epdata->ep, req);
670 spin_unlock_irq(&epdata->dev->lock);
672 mutex_unlock(&epdata->lock);
674 if (unlikely(value)) {
678 value = (iv ? -EIOCBRETRY : -EIOCBQUEUED);
683 ep_aio_read(struct kiocb *iocb, const struct iovec *iov,
684 unsigned long nr_segs, loff_t o)
686 struct ep_data *epdata = iocb->ki_filp->private_data;
689 if (unlikely(usb_endpoint_dir_in(&epdata->desc)))
692 buf = kmalloc(iocb->ki_left, GFP_KERNEL);
696 iocb->ki_retry = ep_aio_read_retry;
697 return ep_aio_rwtail(iocb, buf, iocb->ki_left, epdata, iov, nr_segs);
701 ep_aio_write(struct kiocb *iocb, const struct iovec *iov,
702 unsigned long nr_segs, loff_t o)
704 struct ep_data *epdata = iocb->ki_filp->private_data;
709 if (unlikely(!usb_endpoint_dir_in(&epdata->desc)))
712 buf = kmalloc(iocb->ki_left, GFP_KERNEL);
716 for (i=0; i < nr_segs; i++) {
717 if (unlikely(copy_from_user(&buf[len], iov[i].iov_base,
718 iov[i].iov_len) != 0)) {
722 len += iov[i].iov_len;
724 return ep_aio_rwtail(iocb, buf, len, epdata, NULL, 0);
727 /*----------------------------------------------------------------------*/
729 /* used after endpoint configuration */
730 static const struct file_operations ep_io_operations = {
731 .owner = THIS_MODULE,
736 .unlocked_ioctl = ep_ioctl,
737 .release = ep_release,
739 .aio_read = ep_aio_read,
740 .aio_write = ep_aio_write,
743 /* ENDPOINT INITIALIZATION
745 * fd = open ("/dev/gadget/$ENDPOINT", O_RDWR)
746 * status = write (fd, descriptors, sizeof descriptors)
748 * That write establishes the endpoint configuration, configuring
749 * the controller to process bulk, interrupt, or isochronous transfers
750 * at the right maxpacket size, and so on.
752 * The descriptors are message type 1, identified by a host order u32
753 * at the beginning of what's written. Descriptor order is: full/low
754 * speed descriptor, then optional high speed descriptor.
757 ep_config (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
759 struct ep_data *data = fd->private_data;
762 int value, length = len;
764 value = mutex_lock_interruptible(&data->lock);
768 if (data->state != STATE_EP_READY) {
774 if (len < USB_DT_ENDPOINT_SIZE + 4)
777 /* we might need to change message format someday */
778 if (copy_from_user (&tag, buf, 4)) {
782 DBG(data->dev, "config %s, bad tag %d\n", data->name, tag);
788 /* NOTE: audio endpoint extensions not accepted here;
789 * just don't include the extra bytes.
792 /* full/low speed descriptor, then high speed */
793 if (copy_from_user (&data->desc, buf, USB_DT_ENDPOINT_SIZE)) {
796 if (data->desc.bLength != USB_DT_ENDPOINT_SIZE
797 || data->desc.bDescriptorType != USB_DT_ENDPOINT)
799 if (len != USB_DT_ENDPOINT_SIZE) {
800 if (len != 2 * USB_DT_ENDPOINT_SIZE)
802 if (copy_from_user (&data->hs_desc, buf + USB_DT_ENDPOINT_SIZE,
803 USB_DT_ENDPOINT_SIZE)) {
806 if (data->hs_desc.bLength != USB_DT_ENDPOINT_SIZE
807 || data->hs_desc.bDescriptorType
808 != USB_DT_ENDPOINT) {
809 DBG(data->dev, "config %s, bad hs length or type\n",
815 spin_lock_irq (&data->dev->lock);
816 if (data->dev->state == STATE_DEV_UNBOUND) {
819 } else if ((ep = data->ep) == NULL) {
823 switch (data->dev->gadget->speed) {
826 ep->desc = &data->desc;
827 value = usb_ep_enable(ep);
829 data->state = STATE_EP_ENABLED;
832 /* fails if caller didn't provide that descriptor... */
833 ep->desc = &data->hs_desc;
834 value = usb_ep_enable(ep);
836 data->state = STATE_EP_ENABLED;
839 DBG(data->dev, "unconnected, %s init abandoned\n",
844 fd->f_op = &ep_io_operations;
848 spin_unlock_irq (&data->dev->lock);
851 data->desc.bDescriptorType = 0;
852 data->hs_desc.bDescriptorType = 0;
854 mutex_unlock(&data->lock);
865 ep_open (struct inode *inode, struct file *fd)
867 struct ep_data *data = inode->i_private;
870 if (mutex_lock_interruptible(&data->lock) != 0)
872 spin_lock_irq (&data->dev->lock);
873 if (data->dev->state == STATE_DEV_UNBOUND)
875 else if (data->state == STATE_EP_DISABLED) {
877 data->state = STATE_EP_READY;
879 fd->private_data = data;
880 VDEBUG (data->dev, "%s ready\n", data->name);
882 DBG (data->dev, "%s state %d\n",
883 data->name, data->state);
884 spin_unlock_irq (&data->dev->lock);
885 mutex_unlock(&data->lock);
889 /* used before endpoint configuration */
890 static const struct file_operations ep_config_operations = {
891 .owner = THIS_MODULE,
896 .release = ep_release,
899 /*----------------------------------------------------------------------*/
901 /* EP0 IMPLEMENTATION can be partly in userspace.
903 * Drivers that use this facility receive various events, including
904 * control requests the kernel doesn't handle. Drivers that don't
905 * use this facility may be too simple-minded for real applications.
908 static inline void ep0_readable (struct dev_data *dev)
910 wake_up (&dev->wait);
911 kill_fasync (&dev->fasync, SIGIO, POLL_IN);
914 static void clean_req (struct usb_ep *ep, struct usb_request *req)
916 struct dev_data *dev = ep->driver_data;
918 if (req->buf != dev->rbuf) {
920 req->buf = dev->rbuf;
921 req->dma = DMA_ADDR_INVALID;
923 req->complete = epio_complete;
924 dev->setup_out_ready = 0;
927 static void ep0_complete (struct usb_ep *ep, struct usb_request *req)
929 struct dev_data *dev = ep->driver_data;
933 /* for control OUT, data must still get to userspace */
934 spin_lock_irqsave(&dev->lock, flags);
935 if (!dev->setup_in) {
936 dev->setup_out_error = (req->status != 0);
937 if (!dev->setup_out_error)
939 dev->setup_out_ready = 1;
943 /* clean up as appropriate */
944 if (free && req->buf != &dev->rbuf)
946 req->complete = epio_complete;
947 spin_unlock_irqrestore(&dev->lock, flags);
950 static int setup_req (struct usb_ep *ep, struct usb_request *req, u16 len)
952 struct dev_data *dev = ep->driver_data;
954 if (dev->setup_out_ready) {
955 DBG (dev, "ep0 request busy!\n");
958 if (len > sizeof (dev->rbuf))
959 req->buf = kmalloc(len, GFP_ATOMIC);
960 if (req->buf == NULL) {
961 req->buf = dev->rbuf;
964 req->complete = ep0_complete;
971 ep0_read (struct file *fd, char __user *buf, size_t len, loff_t *ptr)
973 struct dev_data *dev = fd->private_data;
975 enum ep0_state state;
977 spin_lock_irq (&dev->lock);
979 /* report fd mode change before acting on it */
980 if (dev->setup_abort) {
981 dev->setup_abort = 0;
986 /* control DATA stage */
987 if ((state = dev->state) == STATE_DEV_SETUP) {
989 if (dev->setup_in) { /* stall IN */
990 VDEBUG(dev, "ep0in stall\n");
991 (void) usb_ep_set_halt (dev->gadget->ep0);
993 dev->state = STATE_DEV_CONNECTED;
995 } else if (len == 0) { /* ack SET_CONFIGURATION etc */
996 struct usb_ep *ep = dev->gadget->ep0;
997 struct usb_request *req = dev->req;
999 if ((retval = setup_req (ep, req, 0)) == 0)
1000 retval = usb_ep_queue (ep, req, GFP_ATOMIC);
1001 dev->state = STATE_DEV_CONNECTED;
1003 /* assume that was SET_CONFIGURATION */
1004 if (dev->current_config) {
1007 if (gadget_is_dualspeed(dev->gadget)
1008 && (dev->gadget->speed
1010 power = dev->hs_config->bMaxPower;
1012 power = dev->config->bMaxPower;
1013 usb_gadget_vbus_draw(dev->gadget, 2 * power);
1016 } else { /* collect OUT data */
1017 if ((fd->f_flags & O_NONBLOCK) != 0
1018 && !dev->setup_out_ready) {
1022 spin_unlock_irq (&dev->lock);
1023 retval = wait_event_interruptible (dev->wait,
1024 dev->setup_out_ready != 0);
1026 /* FIXME state could change from under us */
1027 spin_lock_irq (&dev->lock);
1031 if (dev->state != STATE_DEV_SETUP) {
1032 retval = -ECANCELED;
1035 dev->state = STATE_DEV_CONNECTED;
1037 if (dev->setup_out_error)
1040 len = min (len, (size_t)dev->req->actual);
1041 // FIXME don't call this with the spinlock held ...
1042 if (copy_to_user (buf, dev->req->buf, len))
1046 clean_req (dev->gadget->ep0, dev->req);
1047 /* NOTE userspace can't yet choose to stall */
1053 /* else normal: return event data */
1054 if (len < sizeof dev->event [0]) {
1058 len -= len % sizeof (struct usb_gadgetfs_event);
1059 dev->usermode_setup = 1;
1062 /* return queued events right away */
1063 if (dev->ev_next != 0) {
1066 n = len / sizeof (struct usb_gadgetfs_event);
1067 if (dev->ev_next < n)
1070 /* ep0 i/o has special semantics during STATE_DEV_SETUP */
1071 for (i = 0; i < n; i++) {
1072 if (dev->event [i].type == GADGETFS_SETUP) {
1073 dev->state = STATE_DEV_SETUP;
1078 spin_unlock_irq (&dev->lock);
1079 len = n * sizeof (struct usb_gadgetfs_event);
1080 if (copy_to_user (buf, &dev->event, len))
1085 /* NOTE this doesn't guard against broken drivers;
1086 * concurrent ep0 readers may lose events.
1088 spin_lock_irq (&dev->lock);
1089 if (dev->ev_next > n) {
1090 memmove(&dev->event[0], &dev->event[n],
1091 sizeof (struct usb_gadgetfs_event)
1092 * (dev->ev_next - n));
1095 spin_unlock_irq (&dev->lock);
1099 if (fd->f_flags & O_NONBLOCK) {
1106 DBG (dev, "fail %s, state %d\n", __func__, state);
1109 case STATE_DEV_UNCONNECTED:
1110 case STATE_DEV_CONNECTED:
1111 spin_unlock_irq (&dev->lock);
1112 DBG (dev, "%s wait\n", __func__);
1114 /* wait for events */
1115 retval = wait_event_interruptible (dev->wait,
1119 spin_lock_irq (&dev->lock);
1124 spin_unlock_irq (&dev->lock);
1128 static struct usb_gadgetfs_event *
1129 next_event (struct dev_data *dev, enum usb_gadgetfs_event_type type)
1131 struct usb_gadgetfs_event *event;
1135 /* these events purge the queue */
1136 case GADGETFS_DISCONNECT:
1137 if (dev->state == STATE_DEV_SETUP)
1138 dev->setup_abort = 1;
1140 case GADGETFS_CONNECT:
1143 case GADGETFS_SETUP: /* previous request timed out */
1144 case GADGETFS_SUSPEND: /* same effect */
1145 /* these events can't be repeated */
1146 for (i = 0; i != dev->ev_next; i++) {
1147 if (dev->event [i].type != type)
1149 DBG(dev, "discard old event[%d] %d\n", i, type);
1151 if (i == dev->ev_next)
1153 /* indices start at zero, for simplicity */
1154 memmove (&dev->event [i], &dev->event [i + 1],
1155 sizeof (struct usb_gadgetfs_event)
1156 * (dev->ev_next - i));
1162 VDEBUG(dev, "event[%d] = %d\n", dev->ev_next, type);
1163 event = &dev->event [dev->ev_next++];
1164 BUG_ON (dev->ev_next > N_EVENT);
1165 memset (event, 0, sizeof *event);
1171 ep0_write (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
1173 struct dev_data *dev = fd->private_data;
1174 ssize_t retval = -ESRCH;
1176 spin_lock_irq (&dev->lock);
1178 /* report fd mode change before acting on it */
1179 if (dev->setup_abort) {
1180 dev->setup_abort = 0;
1183 /* data and/or status stage for control request */
1184 } else if (dev->state == STATE_DEV_SETUP) {
1186 /* IN DATA+STATUS caller makes len <= wLength */
1187 if (dev->setup_in) {
1188 retval = setup_req (dev->gadget->ep0, dev->req, len);
1190 dev->state = STATE_DEV_CONNECTED;
1191 spin_unlock_irq (&dev->lock);
1192 if (copy_from_user (dev->req->buf, buf, len))
1195 if (len < dev->setup_wLength)
1197 retval = usb_ep_queue (
1198 dev->gadget->ep0, dev->req,
1202 spin_lock_irq (&dev->lock);
1203 clean_req (dev->gadget->ep0, dev->req);
1204 spin_unlock_irq (&dev->lock);
1211 /* can stall some OUT transfers */
1212 } else if (dev->setup_can_stall) {
1213 VDEBUG(dev, "ep0out stall\n");
1214 (void) usb_ep_set_halt (dev->gadget->ep0);
1216 dev->state = STATE_DEV_CONNECTED;
1218 DBG(dev, "bogus ep0out stall!\n");
1221 DBG (dev, "fail %s, state %d\n", __func__, dev->state);
1223 spin_unlock_irq (&dev->lock);
1228 ep0_fasync (int f, struct file *fd, int on)
1230 struct dev_data *dev = fd->private_data;
1231 // caller must F_SETOWN before signal delivery happens
1232 VDEBUG (dev, "%s %s\n", __func__, on ? "on" : "off");
1233 return fasync_helper (f, fd, on, &dev->fasync);
1236 static struct usb_gadget_driver gadgetfs_driver;
1239 dev_release (struct inode *inode, struct file *fd)
1241 struct dev_data *dev = fd->private_data;
1243 /* closing ep0 === shutdown all */
1245 usb_gadget_unregister_driver (&gadgetfs_driver);
1247 /* at this point "good" hardware has disconnected the
1248 * device from USB; the host won't see it any more.
1249 * alternatively, all host requests will time out.
1256 /* other endpoints were all decoupled from this device */
1257 spin_lock_irq(&dev->lock);
1258 dev->state = STATE_DEV_DISABLED;
1259 spin_unlock_irq(&dev->lock);
1264 ep0_poll (struct file *fd, poll_table *wait)
1266 struct dev_data *dev = fd->private_data;
1269 poll_wait(fd, &dev->wait, wait);
1271 spin_lock_irq (&dev->lock);
1273 /* report fd mode change before acting on it */
1274 if (dev->setup_abort) {
1275 dev->setup_abort = 0;
1280 if (dev->state == STATE_DEV_SETUP) {
1281 if (dev->setup_in || dev->setup_can_stall)
1284 if (dev->ev_next != 0)
1288 spin_unlock_irq(&dev->lock);
1292 static long dev_ioctl (struct file *fd, unsigned code, unsigned long value)
1294 struct dev_data *dev = fd->private_data;
1295 struct usb_gadget *gadget = dev->gadget;
1298 if (gadget->ops->ioctl)
1299 ret = gadget->ops->ioctl (gadget, code, value);
1304 /* used after device configuration */
1305 static const struct file_operations ep0_io_operations = {
1306 .owner = THIS_MODULE,
1307 .llseek = no_llseek,
1311 .fasync = ep0_fasync,
1313 .unlocked_ioctl = dev_ioctl,
1314 .release = dev_release,
1317 /*----------------------------------------------------------------------*/
1319 /* The in-kernel gadget driver handles most ep0 issues, in particular
1320 * enumerating the single configuration (as provided from user space).
1322 * Unrecognized ep0 requests may be handled in user space.
1325 static void make_qualifier (struct dev_data *dev)
1327 struct usb_qualifier_descriptor qual;
1328 struct usb_device_descriptor *desc;
1330 qual.bLength = sizeof qual;
1331 qual.bDescriptorType = USB_DT_DEVICE_QUALIFIER;
1332 qual.bcdUSB = cpu_to_le16 (0x0200);
1335 qual.bDeviceClass = desc->bDeviceClass;
1336 qual.bDeviceSubClass = desc->bDeviceSubClass;
1337 qual.bDeviceProtocol = desc->bDeviceProtocol;
1339 /* assumes ep0 uses the same value for both speeds ... */
1340 qual.bMaxPacketSize0 = dev->gadget->ep0->maxpacket;
1342 qual.bNumConfigurations = 1;
1345 memcpy (dev->rbuf, &qual, sizeof qual);
1349 config_buf (struct dev_data *dev, u8 type, unsigned index)
1354 /* only one configuration */
1358 if (gadget_is_dualspeed(dev->gadget)) {
1359 hs = (dev->gadget->speed == USB_SPEED_HIGH);
1360 if (type == USB_DT_OTHER_SPEED_CONFIG)
1364 dev->req->buf = dev->hs_config;
1365 len = le16_to_cpu(dev->hs_config->wTotalLength);
1367 dev->req->buf = dev->config;
1368 len = le16_to_cpu(dev->config->wTotalLength);
1370 ((u8 *)dev->req->buf) [1] = type;
1375 gadgetfs_setup (struct usb_gadget *gadget, const struct usb_ctrlrequest *ctrl)
1377 struct dev_data *dev = get_gadget_data (gadget);
1378 struct usb_request *req = dev->req;
1379 int value = -EOPNOTSUPP;
1380 struct usb_gadgetfs_event *event;
1381 u16 w_value = le16_to_cpu(ctrl->wValue);
1382 u16 w_length = le16_to_cpu(ctrl->wLength);
1384 spin_lock (&dev->lock);
1385 dev->setup_abort = 0;
1386 if (dev->state == STATE_DEV_UNCONNECTED) {
1387 if (gadget_is_dualspeed(gadget)
1388 && gadget->speed == USB_SPEED_HIGH
1389 && dev->hs_config == NULL) {
1390 spin_unlock(&dev->lock);
1391 ERROR (dev, "no high speed config??\n");
1395 dev->state = STATE_DEV_CONNECTED;
1397 INFO (dev, "connected\n");
1398 event = next_event (dev, GADGETFS_CONNECT);
1399 event->u.speed = gadget->speed;
1402 /* host may have given up waiting for response. we can miss control
1403 * requests handled lower down (device/endpoint status and features);
1404 * then ep0_{read,write} will report the wrong status. controller
1405 * driver will have aborted pending i/o.
1407 } else if (dev->state == STATE_DEV_SETUP)
1408 dev->setup_abort = 1;
1410 req->buf = dev->rbuf;
1411 req->dma = DMA_ADDR_INVALID;
1412 req->context = NULL;
1413 value = -EOPNOTSUPP;
1414 switch (ctrl->bRequest) {
1416 case USB_REQ_GET_DESCRIPTOR:
1417 if (ctrl->bRequestType != USB_DIR_IN)
1419 switch (w_value >> 8) {
1422 value = min (w_length, (u16) sizeof *dev->dev);
1423 dev->dev->bMaxPacketSize0 = dev->gadget->ep0->maxpacket;
1424 req->buf = dev->dev;
1426 case USB_DT_DEVICE_QUALIFIER:
1427 if (!dev->hs_config)
1429 value = min (w_length, (u16)
1430 sizeof (struct usb_qualifier_descriptor));
1431 make_qualifier (dev);
1433 case USB_DT_OTHER_SPEED_CONFIG:
1436 value = config_buf (dev,
1440 value = min (w_length, (u16) value);
1445 default: // all others are errors
1450 /* currently one config, two speeds */
1451 case USB_REQ_SET_CONFIGURATION:
1452 if (ctrl->bRequestType != 0)
1454 if (0 == (u8) w_value) {
1456 dev->current_config = 0;
1457 usb_gadget_vbus_draw(gadget, 8 /* mA */ );
1458 // user mode expected to disable endpoints
1462 if (gadget_is_dualspeed(gadget)
1463 && gadget->speed == USB_SPEED_HIGH) {
1464 config = dev->hs_config->bConfigurationValue;
1465 power = dev->hs_config->bMaxPower;
1467 config = dev->config->bConfigurationValue;
1468 power = dev->config->bMaxPower;
1471 if (config == (u8) w_value) {
1473 dev->current_config = config;
1474 usb_gadget_vbus_draw(gadget, 2 * power);
1478 /* report SET_CONFIGURATION like any other control request,
1479 * except that usermode may not stall this. the next
1480 * request mustn't be allowed start until this finishes:
1481 * endpoints and threads set up, etc.
1483 * NOTE: older PXA hardware (before PXA 255: without UDCCFR)
1484 * has bad/racey automagic that prevents synchronizing here.
1485 * even kernel mode drivers often miss them.
1488 INFO (dev, "configuration #%d\n", dev->current_config);
1489 if (dev->usermode_setup) {
1490 dev->setup_can_stall = 0;
1496 #ifndef CONFIG_USB_GADGET_PXA25X
1497 /* PXA automagically handles this request too */
1498 case USB_REQ_GET_CONFIGURATION:
1499 if (ctrl->bRequestType != 0x80)
1501 *(u8 *)req->buf = dev->current_config;
1502 value = min (w_length, (u16) 1);
1508 VDEBUG (dev, "%s req%02x.%02x v%04x i%04x l%d\n",
1509 dev->usermode_setup ? "delegate" : "fail",
1510 ctrl->bRequestType, ctrl->bRequest,
1511 w_value, le16_to_cpu(ctrl->wIndex), w_length);
1513 /* if there's an ep0 reader, don't stall */
1514 if (dev->usermode_setup) {
1515 dev->setup_can_stall = 1;
1517 dev->setup_in = (ctrl->bRequestType & USB_DIR_IN)
1519 dev->setup_wLength = w_length;
1520 dev->setup_out_ready = 0;
1521 dev->setup_out_error = 0;
1524 /* read DATA stage for OUT right away */
1525 if (unlikely (!dev->setup_in && w_length)) {
1526 value = setup_req (gadget->ep0, dev->req,
1530 value = usb_ep_queue (gadget->ep0, dev->req,
1533 clean_req (gadget->ep0, dev->req);
1537 /* we can't currently stall these */
1538 dev->setup_can_stall = 0;
1541 /* state changes when reader collects event */
1542 event = next_event (dev, GADGETFS_SETUP);
1543 event->u.setup = *ctrl;
1545 spin_unlock (&dev->lock);
1550 /* proceed with data transfer and status phases? */
1551 if (value >= 0 && dev->state != STATE_DEV_SETUP) {
1552 req->length = value;
1553 req->zero = value < w_length;
1554 value = usb_ep_queue (gadget->ep0, req, GFP_ATOMIC);
1556 DBG (dev, "ep_queue --> %d\n", value);
1561 /* device stalls when value < 0 */
1562 spin_unlock (&dev->lock);
1566 static void destroy_ep_files (struct dev_data *dev)
1568 DBG (dev, "%s %d\n", __func__, dev->state);
1570 /* dev->state must prevent interference */
1571 spin_lock_irq (&dev->lock);
1572 while (!list_empty(&dev->epfiles)) {
1574 struct inode *parent;
1575 struct dentry *dentry;
1577 /* break link to FS */
1578 ep = list_first_entry (&dev->epfiles, struct ep_data, epfiles);
1579 list_del_init (&ep->epfiles);
1580 dentry = ep->dentry;
1582 parent = dentry->d_parent->d_inode;
1584 /* break link to controller */
1585 if (ep->state == STATE_EP_ENABLED)
1586 (void) usb_ep_disable (ep->ep);
1587 ep->state = STATE_EP_UNBOUND;
1588 usb_ep_free_request (ep->ep, ep->req);
1590 wake_up (&ep->wait);
1593 spin_unlock_irq (&dev->lock);
1595 /* break link to dcache */
1596 mutex_lock (&parent->i_mutex);
1599 mutex_unlock (&parent->i_mutex);
1601 spin_lock_irq (&dev->lock);
1603 spin_unlock_irq (&dev->lock);
1607 static struct inode *
1608 gadgetfs_create_file (struct super_block *sb, char const *name,
1609 void *data, const struct file_operations *fops,
1610 struct dentry **dentry_p);
1612 static int activate_ep_files (struct dev_data *dev)
1615 struct ep_data *data;
1617 gadget_for_each_ep (ep, dev->gadget) {
1619 data = kzalloc(sizeof(*data), GFP_KERNEL);
1622 data->state = STATE_EP_DISABLED;
1623 mutex_init(&data->lock);
1624 init_waitqueue_head (&data->wait);
1626 strncpy (data->name, ep->name, sizeof (data->name) - 1);
1627 atomic_set (&data->count, 1);
1632 ep->driver_data = data;
1634 data->req = usb_ep_alloc_request (ep, GFP_KERNEL);
1638 data->inode = gadgetfs_create_file (dev->sb, data->name,
1639 data, &ep_config_operations,
1643 list_add_tail (&data->epfiles, &dev->epfiles);
1648 usb_ep_free_request (ep, data->req);
1653 DBG (dev, "%s enomem\n", __func__);
1654 destroy_ep_files (dev);
1659 gadgetfs_unbind (struct usb_gadget *gadget)
1661 struct dev_data *dev = get_gadget_data (gadget);
1663 DBG (dev, "%s\n", __func__);
1665 spin_lock_irq (&dev->lock);
1666 dev->state = STATE_DEV_UNBOUND;
1667 spin_unlock_irq (&dev->lock);
1669 destroy_ep_files (dev);
1670 gadget->ep0->driver_data = NULL;
1671 set_gadget_data (gadget, NULL);
1673 /* we've already been disconnected ... no i/o is active */
1675 usb_ep_free_request (gadget->ep0, dev->req);
1676 DBG (dev, "%s done\n", __func__);
1680 static struct dev_data *the_device;
1683 gadgetfs_bind (struct usb_gadget *gadget)
1685 struct dev_data *dev = the_device;
1689 if (0 != strcmp (CHIP, gadget->name)) {
1690 pr_err("%s expected %s controller not %s\n",
1691 shortname, CHIP, gadget->name);
1695 set_gadget_data (gadget, dev);
1696 dev->gadget = gadget;
1697 gadget->ep0->driver_data = dev;
1699 /* preallocate control response and buffer */
1700 dev->req = usb_ep_alloc_request (gadget->ep0, GFP_KERNEL);
1703 dev->req->context = NULL;
1704 dev->req->complete = epio_complete;
1706 if (activate_ep_files (dev) < 0)
1709 INFO (dev, "bound to %s driver\n", gadget->name);
1710 spin_lock_irq(&dev->lock);
1711 dev->state = STATE_DEV_UNCONNECTED;
1712 spin_unlock_irq(&dev->lock);
1717 gadgetfs_unbind (gadget);
1722 gadgetfs_disconnect (struct usb_gadget *gadget)
1724 struct dev_data *dev = get_gadget_data (gadget);
1725 unsigned long flags;
1727 spin_lock_irqsave (&dev->lock, flags);
1728 if (dev->state == STATE_DEV_UNCONNECTED)
1730 dev->state = STATE_DEV_UNCONNECTED;
1732 INFO (dev, "disconnected\n");
1733 next_event (dev, GADGETFS_DISCONNECT);
1736 spin_unlock_irqrestore (&dev->lock, flags);
1740 gadgetfs_suspend (struct usb_gadget *gadget)
1742 struct dev_data *dev = get_gadget_data (gadget);
1744 INFO (dev, "suspended from state %d\n", dev->state);
1745 spin_lock (&dev->lock);
1746 switch (dev->state) {
1747 case STATE_DEV_SETUP: // VERY odd... host died??
1748 case STATE_DEV_CONNECTED:
1749 case STATE_DEV_UNCONNECTED:
1750 next_event (dev, GADGETFS_SUSPEND);
1756 spin_unlock (&dev->lock);
1759 static struct usb_gadget_driver gadgetfs_driver = {
1760 .function = (char *) driver_desc,
1761 .unbind = gadgetfs_unbind,
1762 .setup = gadgetfs_setup,
1763 .disconnect = gadgetfs_disconnect,
1764 .suspend = gadgetfs_suspend,
1767 .name = (char *) shortname,
1771 /*----------------------------------------------------------------------*/
1773 static void gadgetfs_nop(struct usb_gadget *arg) { }
1775 static int gadgetfs_probe (struct usb_gadget *gadget)
1777 CHIP = gadget->name;
1781 static struct usb_gadget_driver probe_driver = {
1782 .max_speed = USB_SPEED_HIGH,
1783 .unbind = gadgetfs_nop,
1784 .setup = (void *)gadgetfs_nop,
1785 .disconnect = gadgetfs_nop,
1792 /* DEVICE INITIALIZATION
1794 * fd = open ("/dev/gadget/$CHIP", O_RDWR)
1795 * status = write (fd, descriptors, sizeof descriptors)
1797 * That write establishes the device configuration, so the kernel can
1798 * bind to the controller ... guaranteeing it can handle enumeration
1799 * at all necessary speeds. Descriptor order is:
1801 * . message tag (u32, host order) ... for now, must be zero; it
1802 * would change to support features like multi-config devices
1803 * . full/low speed config ... all wTotalLength bytes (with interface,
1804 * class, altsetting, endpoint, and other descriptors)
1805 * . high speed config ... all descriptors, for high speed operation;
1806 * this one's optional except for high-speed hardware
1807 * . device descriptor
1809 * Endpoints are not yet enabled. Drivers must wait until device
1810 * configuration and interface altsetting changes create
1811 * the need to configure (or unconfigure) them.
1813 * After initialization, the device stays active for as long as that
1814 * $CHIP file is open. Events must then be read from that descriptor,
1815 * such as configuration notifications.
1818 static int is_valid_config (struct usb_config_descriptor *config)
1820 return config->bDescriptorType == USB_DT_CONFIG
1821 && config->bLength == USB_DT_CONFIG_SIZE
1822 && config->bConfigurationValue != 0
1823 && (config->bmAttributes & USB_CONFIG_ATT_ONE) != 0
1824 && (config->bmAttributes & USB_CONFIG_ATT_WAKEUP) == 0;
1825 /* FIXME if gadget->is_otg, _must_ include an otg descriptor */
1826 /* FIXME check lengths: walk to end */
1830 dev_config (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
1832 struct dev_data *dev = fd->private_data;
1833 ssize_t value = len, length = len;
1838 if (len < (USB_DT_CONFIG_SIZE + USB_DT_DEVICE_SIZE + 4))
1841 /* we might need to change message format someday */
1842 if (copy_from_user (&tag, buf, 4))
1849 kbuf = memdup_user(buf, length);
1851 return PTR_ERR(kbuf);
1853 spin_lock_irq (&dev->lock);
1859 /* full or low speed config */
1860 dev->config = (void *) kbuf;
1861 total = le16_to_cpu(dev->config->wTotalLength);
1862 if (!is_valid_config (dev->config) || total >= length)
1867 /* optional high speed config */
1868 if (kbuf [1] == USB_DT_CONFIG) {
1869 dev->hs_config = (void *) kbuf;
1870 total = le16_to_cpu(dev->hs_config->wTotalLength);
1871 if (!is_valid_config (dev->hs_config) || total >= length)
1877 /* could support multiple configs, using another encoding! */
1879 /* device descriptor (tweaked for paranoia) */
1880 if (length != USB_DT_DEVICE_SIZE)
1882 dev->dev = (void *)kbuf;
1883 if (dev->dev->bLength != USB_DT_DEVICE_SIZE
1884 || dev->dev->bDescriptorType != USB_DT_DEVICE
1885 || dev->dev->bNumConfigurations != 1)
1887 dev->dev->bNumConfigurations = 1;
1888 dev->dev->bcdUSB = cpu_to_le16 (0x0200);
1890 /* triggers gadgetfs_bind(); then we can enumerate. */
1891 spin_unlock_irq (&dev->lock);
1893 gadgetfs_driver.max_speed = USB_SPEED_HIGH;
1895 gadgetfs_driver.max_speed = USB_SPEED_FULL;
1896 value = usb_gadget_probe_driver(&gadgetfs_driver, gadgetfs_bind);
1901 /* at this point "good" hardware has for the first time
1902 * let the USB the host see us. alternatively, if users
1903 * unplug/replug that will clear all the error state.
1905 * note: everything running before here was guaranteed
1906 * to choke driver model style diagnostics. from here
1907 * on, they can work ... except in cleanup paths that
1908 * kick in after the ep0 descriptor is closed.
1910 fd->f_op = &ep0_io_operations;
1916 spin_unlock_irq (&dev->lock);
1917 pr_debug ("%s: %s fail %Zd, %p\n", shortname, __func__, value, dev);
1924 dev_open (struct inode *inode, struct file *fd)
1926 struct dev_data *dev = inode->i_private;
1929 spin_lock_irq(&dev->lock);
1930 if (dev->state == STATE_DEV_DISABLED) {
1932 dev->state = STATE_DEV_OPENED;
1933 fd->private_data = dev;
1937 spin_unlock_irq(&dev->lock);
1941 static const struct file_operations dev_init_operations = {
1942 .owner = THIS_MODULE,
1943 .llseek = no_llseek,
1946 .write = dev_config,
1947 .fasync = ep0_fasync,
1948 .unlocked_ioctl = dev_ioctl,
1949 .release = dev_release,
1952 /*----------------------------------------------------------------------*/
1954 /* FILESYSTEM AND SUPERBLOCK OPERATIONS
1956 * Mounting the filesystem creates a controller file, used first for
1957 * device configuration then later for event monitoring.
1961 /* FIXME PAM etc could set this security policy without mount options
1962 * if epfiles inherited ownership and permissons from ep0 ...
1965 static unsigned default_uid;
1966 static unsigned default_gid;
1967 static unsigned default_perm = S_IRUSR | S_IWUSR;
1969 module_param (default_uid, uint, 0644);
1970 module_param (default_gid, uint, 0644);
1971 module_param (default_perm, uint, 0644);
1974 static struct inode *
1975 gadgetfs_make_inode (struct super_block *sb,
1976 void *data, const struct file_operations *fops,
1979 struct inode *inode = new_inode (sb);
1982 inode->i_ino = get_next_ino();
1983 inode->i_mode = mode;
1984 inode->i_uid = default_uid;
1985 inode->i_gid = default_gid;
1986 inode->i_atime = inode->i_mtime = inode->i_ctime
1988 inode->i_private = data;
1989 inode->i_fop = fops;
1994 /* creates in fs root directory, so non-renamable and non-linkable.
1995 * so inode and dentry are paired, until device reconfig.
1997 static struct inode *
1998 gadgetfs_create_file (struct super_block *sb, char const *name,
1999 void *data, const struct file_operations *fops,
2000 struct dentry **dentry_p)
2002 struct dentry *dentry;
2003 struct inode *inode;
2005 dentry = d_alloc_name(sb->s_root, name);
2009 inode = gadgetfs_make_inode (sb, data, fops,
2010 S_IFREG | (default_perm & S_IRWXUGO));
2015 d_add (dentry, inode);
2020 static const struct super_operations gadget_fs_operations = {
2021 .statfs = simple_statfs,
2022 .drop_inode = generic_delete_inode,
2026 gadgetfs_fill_super (struct super_block *sb, void *opts, int silent)
2028 struct inode *inode;
2029 struct dev_data *dev;
2034 /* fake probe to determine $CHIP */
2035 (void) usb_gadget_probe_driver(&probe_driver, gadgetfs_probe);
2040 sb->s_blocksize = PAGE_CACHE_SIZE;
2041 sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
2042 sb->s_magic = GADGETFS_MAGIC;
2043 sb->s_op = &gadget_fs_operations;
2044 sb->s_time_gran = 1;
2047 inode = gadgetfs_make_inode (sb,
2048 NULL, &simple_dir_operations,
2049 S_IFDIR | S_IRUGO | S_IXUGO);
2052 inode->i_op = &simple_dir_inode_operations;
2053 if (!(sb->s_root = d_make_root (inode)))
2056 /* the ep0 file is named after the controller we expect;
2057 * user mode code can use it for sanity checks, like we do.
2064 if (!gadgetfs_create_file (sb, CHIP,
2065 dev, &dev_init_operations,
2071 /* other endpoint files are available after hardware setup,
2072 * from binding to a controller.
2081 /* "mount -t gadgetfs path /dev/gadget" ends up here */
2082 static struct dentry *
2083 gadgetfs_mount (struct file_system_type *t, int flags,
2084 const char *path, void *opts)
2086 return mount_single (t, flags, opts, gadgetfs_fill_super);
2090 gadgetfs_kill_sb (struct super_block *sb)
2092 kill_litter_super (sb);
2094 put_dev (the_device);
2099 /*----------------------------------------------------------------------*/
2101 static struct file_system_type gadgetfs_type = {
2102 .owner = THIS_MODULE,
2104 .mount = gadgetfs_mount,
2105 .kill_sb = gadgetfs_kill_sb,
2108 /*----------------------------------------------------------------------*/
2110 static int __init init (void)
2114 status = register_filesystem (&gadgetfs_type);
2116 pr_info ("%s: %s, version " DRIVER_VERSION "\n",
2117 shortname, driver_desc);
2122 static void __exit cleanup (void)
2124 pr_debug ("unregister %s\n", shortname);
2125 unregister_filesystem (&gadgetfs_type);
2127 module_exit (cleanup);