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 DEBUG /* data to help fault diagnosis */
24 // #define VERBOSE /* extra debug messages (success too) */
26 #include <linux/init.h>
27 #include <linux/module.h>
29 #include <linux/pagemap.h>
30 #include <linux/uts.h>
31 #include <linux/wait.h>
32 #include <linux/compiler.h>
33 #include <asm/uaccess.h>
34 #include <linux/slab.h>
36 #include <linux/device.h>
37 #include <linux/moduleparam.h>
39 #include <linux/usb_gadgetfs.h>
40 #include <linux/usb_gadget.h>
44 * The gadgetfs API maps each endpoint to a file descriptor so that you
45 * can use standard synchronous read/write calls for I/O. There's some
46 * O_NONBLOCK and O_ASYNC/FASYNC style i/o support. Example usermode
47 * drivers show how this works in practice. You can also use AIO to
48 * eliminate I/O gaps between requests, to help when streaming data.
50 * Key parts that must be USB-specific are protocols defining how the
51 * read/write operations relate to the hardware state machines. There
52 * are two types of files. One type is for the device, implementing ep0.
53 * The other type is for each IN or OUT endpoint. In both cases, the
54 * user mode driver must configure the hardware before using it.
56 * - First, dev_config() is called when /dev/gadget/$CHIP is configured
57 * (by writing configuration and device descriptors). Afterwards it
58 * may serve as a source of device events, used to handle all control
59 * requests other than basic enumeration.
61 * - Then either immediately, or after a SET_CONFIGURATION control request,
62 * ep_config() is called when each /dev/gadget/ep* file is configured
63 * (by writing endpoint descriptors). Afterwards these files are used
64 * to write() IN data or to read() OUT data. To halt the endpoint, a
65 * "wrong direction" request is issued (like reading an IN endpoint).
67 * Unlike "usbfs" the only ioctl()s are for things that are rare, and maybe
68 * not possible on all hardware. For example, precise fault handling with
69 * respect to data left in endpoint fifos after aborted operations; or
70 * selective clearing of endpoint halts, to implement SET_INTERFACE.
73 #define DRIVER_DESC "USB Gadget filesystem"
74 #define DRIVER_VERSION "24 Aug 2004"
76 static const char driver_desc [] = DRIVER_DESC;
77 static const char shortname [] = "gadgetfs";
79 MODULE_DESCRIPTION (DRIVER_DESC);
80 MODULE_AUTHOR ("David Brownell");
81 MODULE_LICENSE ("GPL");
84 /*----------------------------------------------------------------------*/
86 #define GADGETFS_MAGIC 0xaee71ee7
87 #define DMA_ADDR_INVALID (~(dma_addr_t)0)
89 /* /dev/gadget/$CHIP represents ep0 and the whole device */
91 /* DISBLED is the initial state.
93 STATE_DEV_DISABLED = 0,
95 /* Only one open() of /dev/gadget/$CHIP; only one file tracks
96 * ep0/device i/o modes and binding to the controller. Driver
97 * must always write descriptors to initialize the device, then
98 * the device becomes UNCONNECTED until enumeration.
102 /* From then on, ep0 fd is in either of two basic modes:
103 * - (UN)CONNECTED: read usb_gadgetfs_event(s) from it
104 * - SETUP: read/write will transfer control data and succeed;
105 * or if "wrong direction", performs protocol stall
111 /* UNBOUND means the driver closed ep0, so the device won't be
112 * accessible again (DEV_DISABLED) until all fds are closed.
117 /* enough for the whole queue: most events invalidate others */
123 enum ep0_state state;
124 struct usb_gadgetfs_event event [N_EVENT];
126 struct fasync_struct *fasync;
129 /* drivers reading ep0 MUST handle control requests (SETUP)
130 * reported that way; else the host will time out.
132 unsigned usermode_setup : 1,
139 /* the rest is basically write-once */
140 struct usb_config_descriptor *config, *hs_config;
141 struct usb_device_descriptor *dev;
142 struct usb_request *req;
143 struct usb_gadget *gadget;
144 struct list_head epfiles;
146 wait_queue_head_t wait;
147 struct super_block *sb;
148 struct dentry *dentry;
150 /* except this scratch i/o buffer for ep0 */
154 static inline void get_dev (struct dev_data *data)
156 atomic_inc (&data->count);
159 static void put_dev (struct dev_data *data)
161 if (likely (!atomic_dec_and_test (&data->count)))
163 /* needs no more cleanup */
164 BUG_ON (waitqueue_active (&data->wait));
168 static struct dev_data *dev_new (void)
170 struct dev_data *dev;
172 dev = kmalloc (sizeof *dev, GFP_KERNEL);
175 memset (dev, 0, sizeof *dev);
176 dev->state = STATE_DEV_DISABLED;
177 atomic_set (&dev->count, 1);
178 spin_lock_init (&dev->lock);
179 INIT_LIST_HEAD (&dev->epfiles);
180 init_waitqueue_head (&dev->wait);
184 /*----------------------------------------------------------------------*/
186 /* other /dev/gadget/$ENDPOINT files represent endpoints */
188 STATE_EP_DISABLED = 0,
190 STATE_EP_DEFER_ENABLE,
196 struct semaphore lock;
199 struct dev_data *dev;
200 /* must hold dev->lock before accessing ep or req */
202 struct usb_request *req;
205 struct usb_endpoint_descriptor desc, hs_desc;
206 struct list_head epfiles;
207 wait_queue_head_t wait;
208 struct dentry *dentry;
212 static inline void get_ep (struct ep_data *data)
214 atomic_inc (&data->count);
217 static void put_ep (struct ep_data *data)
219 if (likely (!atomic_dec_and_test (&data->count)))
222 /* needs no more cleanup */
223 BUG_ON (!list_empty (&data->epfiles));
224 BUG_ON (waitqueue_active (&data->wait));
225 BUG_ON (down_trylock (&data->lock) != 0);
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 WARN(dev,fmt,args...) \
267 xprintk(dev , KERN_WARNING , fmt , ## args)
268 #define INFO(dev,fmt,args...) \
269 xprintk(dev , KERN_INFO , fmt , ## args)
272 /*----------------------------------------------------------------------*/
274 /* SYNCHRONOUS ENDPOINT OPERATIONS (bulk/intr/iso)
276 * After opening, configure non-control endpoints. Then use normal
277 * stream read() and write() requests; and maybe ioctl() to get more
278 * precise FIFO status when recovering from cancellation.
281 static void epio_complete (struct usb_ep *ep, struct usb_request *req)
283 struct ep_data *epdata = ep->driver_data;
288 epdata->status = req->status;
290 epdata->status = req->actual;
291 complete ((struct completion *)req->context);
294 /* tasklock endpoint, returning when it's connected.
295 * still need dev->lock to use epdata->ep.
298 get_ready_ep (unsigned f_flags, struct ep_data *epdata)
302 if (f_flags & O_NONBLOCK) {
303 if (down_trylock (&epdata->lock) != 0)
305 if (epdata->state != STATE_EP_ENABLED) {
314 if ((val = down_interruptible (&epdata->lock)) < 0)
317 switch (epdata->state) {
318 case STATE_EP_ENABLED:
320 case STATE_EP_DEFER_ENABLE:
321 DBG (epdata->dev, "%s wait for host\n", epdata->name);
322 if ((val = wait_event_interruptible (epdata->wait,
323 epdata->state != STATE_EP_DEFER_ENABLE
324 || epdata->dev->state == STATE_DEV_UNBOUND
328 // case STATE_EP_DISABLED: /* "can't happen" */
329 // case STATE_EP_READY: /* "can't happen" */
330 default: /* error! */
331 pr_debug ("%s: ep %p not available, state %d\n",
332 shortname, epdata, epdata->state);
334 case STATE_EP_UNBOUND: /* clean disconnect */
343 ep_io (struct ep_data *epdata, void *buf, unsigned len)
345 DECLARE_COMPLETION (done);
348 spin_lock_irq (&epdata->dev->lock);
349 if (likely (epdata->ep != NULL)) {
350 struct usb_request *req = epdata->req;
352 req->context = &done;
353 req->complete = epio_complete;
356 value = usb_ep_queue (epdata->ep, req, GFP_ATOMIC);
359 spin_unlock_irq (&epdata->dev->lock);
361 if (likely (value == 0)) {
362 value = wait_event_interruptible (done.wait, done.done);
364 spin_lock_irq (&epdata->dev->lock);
365 if (likely (epdata->ep != NULL)) {
366 DBG (epdata->dev, "%s i/o interrupted\n",
368 usb_ep_dequeue (epdata->ep, epdata->req);
369 spin_unlock_irq (&epdata->dev->lock);
371 wait_event (done.wait, done.done);
372 if (epdata->status == -ECONNRESET)
373 epdata->status = -EINTR;
375 spin_unlock_irq (&epdata->dev->lock);
377 DBG (epdata->dev, "endpoint gone\n");
378 epdata->status = -ENODEV;
381 return epdata->status;
387 /* handle a synchronous OUT bulk/intr/iso transfer */
389 ep_read (struct file *fd, char __user *buf, size_t len, loff_t *ptr)
391 struct ep_data *data = fd->private_data;
395 if ((value = get_ready_ep (fd->f_flags, data)) < 0)
398 /* halt any endpoint by doing a "wrong direction" i/o call */
399 if (data->desc.bEndpointAddress & USB_DIR_IN) {
400 if ((data->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
401 == USB_ENDPOINT_XFER_ISOC)
403 DBG (data->dev, "%s halt\n", data->name);
404 spin_lock_irq (&data->dev->lock);
405 if (likely (data->ep != NULL))
406 usb_ep_set_halt (data->ep);
407 spin_unlock_irq (&data->dev->lock);
412 /* FIXME readahead for O_NONBLOCK and poll(); careful with ZLPs */
415 kbuf = kmalloc (len, SLAB_KERNEL);
416 if (unlikely (!kbuf))
419 value = ep_io (data, kbuf, len);
420 VDEBUG (data->dev, "%s read %d OUT, status %d\n",
421 data->name, len, value);
422 if (value >= 0 && copy_to_user (buf, kbuf, value))
431 /* handle a synchronous IN bulk/intr/iso transfer */
433 ep_write (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
435 struct ep_data *data = fd->private_data;
439 if ((value = get_ready_ep (fd->f_flags, data)) < 0)
442 /* halt any endpoint by doing a "wrong direction" i/o call */
443 if (!(data->desc.bEndpointAddress & USB_DIR_IN)) {
444 if ((data->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
445 == USB_ENDPOINT_XFER_ISOC)
447 DBG (data->dev, "%s halt\n", data->name);
448 spin_lock_irq (&data->dev->lock);
449 if (likely (data->ep != NULL))
450 usb_ep_set_halt (data->ep);
451 spin_unlock_irq (&data->dev->lock);
456 /* FIXME writebehind for O_NONBLOCK and poll(), qlen = 1 */
459 kbuf = kmalloc (len, SLAB_KERNEL);
462 if (copy_from_user (kbuf, buf, len)) {
467 value = ep_io (data, kbuf, len);
468 VDEBUG (data->dev, "%s write %d IN, status %d\n",
469 data->name, len, value);
477 ep_release (struct inode *inode, struct file *fd)
479 struct ep_data *data = fd->private_data;
481 /* clean up if this can be reopened */
482 if (data->state != STATE_EP_UNBOUND) {
483 data->state = STATE_EP_DISABLED;
484 data->desc.bDescriptorType = 0;
485 data->hs_desc.bDescriptorType = 0;
491 static int ep_ioctl (struct inode *inode, struct file *fd,
492 unsigned code, unsigned long value)
494 struct ep_data *data = fd->private_data;
497 if ((status = get_ready_ep (fd->f_flags, data)) < 0)
500 spin_lock_irq (&data->dev->lock);
501 if (likely (data->ep != NULL)) {
503 case GADGETFS_FIFO_STATUS:
504 status = usb_ep_fifo_status (data->ep);
506 case GADGETFS_FIFO_FLUSH:
507 usb_ep_fifo_flush (data->ep);
509 case GADGETFS_CLEAR_HALT:
510 status = usb_ep_clear_halt (data->ep);
517 spin_unlock_irq (&data->dev->lock);
522 /*----------------------------------------------------------------------*/
524 /* ASYNCHRONOUS ENDPOINT I/O OPERATIONS (bulk/intr/iso) */
527 struct usb_request *req;
528 struct ep_data *epdata;
534 static int ep_aio_cancel(struct kiocb *iocb, struct io_event *e)
536 struct kiocb_priv *priv = iocb->private;
537 struct ep_data *epdata;
541 epdata = priv->epdata;
542 // spin_lock(&epdata->dev->lock);
543 kiocbSetCancelled(iocb);
544 if (likely(epdata && epdata->ep && priv->req))
545 value = usb_ep_dequeue (epdata->ep, priv->req);
548 // spin_unlock(&epdata->dev->lock);
555 static ssize_t ep_aio_read_retry(struct kiocb *iocb)
557 struct kiocb_priv *priv = iocb->private;
558 ssize_t status = priv->actual;
560 /* we "retry" to get the right mm context for this: */
561 status = copy_to_user(priv->ubuf, priv->buf, priv->actual);
562 if (unlikely(0 != status))
565 status = priv->actual;
572 static void ep_aio_complete(struct usb_ep *ep, struct usb_request *req)
574 struct kiocb *iocb = req->context;
575 struct kiocb_priv *priv = iocb->private;
576 struct ep_data *epdata = priv->epdata;
578 /* lock against disconnect (and ideally, cancel) */
579 spin_lock(&epdata->dev->lock);
582 if (NULL == iocb->ki_retry
583 || unlikely(0 == req->actual)
584 || unlikely(kiocbIsCancelled(iocb))) {
587 iocb->private = NULL;
588 /* aio_complete() reports bytes-transferred _and_ faults */
589 if (unlikely(kiocbIsCancelled(iocb)))
593 req->actual ? req->actual : req->status,
596 /* retry() won't report both; so we hide some faults */
597 if (unlikely(0 != req->status))
598 DBG(epdata->dev, "%s fault %d len %d\n",
599 ep->name, req->status, req->actual);
601 priv->buf = req->buf;
602 priv->actual = req->actual;
605 spin_unlock(&epdata->dev->lock);
607 usb_ep_free_request(ep, req);
616 struct ep_data *epdata,
620 struct kiocb_priv *priv = (void *) &iocb->private;
621 struct usb_request *req;
624 priv = kmalloc(sizeof *priv, GFP_KERNEL);
631 iocb->private = priv;
634 value = get_ready_ep(iocb->ki_filp->f_flags, epdata);
635 if (unlikely(value < 0)) {
640 iocb->ki_cancel = ep_aio_cancel;
642 priv->epdata = epdata;
645 /* each kiocb is coupled to one usb_request, but we can't
646 * allocate or submit those if the host disconnected.
648 spin_lock_irq(&epdata->dev->lock);
649 if (likely(epdata->ep)) {
650 req = usb_ep_alloc_request(epdata->ep, GFP_ATOMIC);
655 req->complete = ep_aio_complete;
657 value = usb_ep_queue(epdata->ep, req, GFP_ATOMIC);
658 if (unlikely(0 != value))
659 usb_ep_free_request(epdata->ep, req);
664 spin_unlock_irq(&epdata->dev->lock);
668 if (unlikely(value)) {
672 value = -EIOCBQUEUED;
677 ep_aio_read(struct kiocb *iocb, char __user *ubuf, size_t len, loff_t o)
679 struct ep_data *epdata = iocb->ki_filp->private_data;
682 if (unlikely(epdata->desc.bEndpointAddress & USB_DIR_IN))
684 buf = kmalloc(len, GFP_KERNEL);
687 iocb->ki_retry = ep_aio_read_retry;
688 return ep_aio_rwtail(iocb, buf, len, epdata, ubuf);
692 ep_aio_write(struct kiocb *iocb, const char __user *ubuf, size_t len, loff_t o)
694 struct ep_data *epdata = iocb->ki_filp->private_data;
697 if (unlikely(!(epdata->desc.bEndpointAddress & USB_DIR_IN)))
699 buf = kmalloc(len, GFP_KERNEL);
702 if (unlikely(copy_from_user(buf, ubuf, len) != 0)) {
706 return ep_aio_rwtail(iocb, buf, len, epdata, NULL);
709 /*----------------------------------------------------------------------*/
711 /* used after endpoint configuration */
712 static struct file_operations ep_io_operations = {
713 .owner = THIS_MODULE,
719 .release = ep_release,
721 .aio_read = ep_aio_read,
722 .aio_write = ep_aio_write,
725 /* ENDPOINT INITIALIZATION
727 * fd = open ("/dev/gadget/$ENDPOINT", O_RDWR)
728 * status = write (fd, descriptors, sizeof descriptors)
730 * That write establishes the endpoint configuration, configuring
731 * the controller to process bulk, interrupt, or isochronous transfers
732 * at the right maxpacket size, and so on.
734 * The descriptors are message type 1, identified by a host order u32
735 * at the beginning of what's written. Descriptor order is: full/low
736 * speed descriptor, then optional high speed descriptor.
739 ep_config (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
741 struct ep_data *data = fd->private_data;
746 if ((value = down_interruptible (&data->lock)) < 0)
749 if (data->state != STATE_EP_READY) {
755 if (len < USB_DT_ENDPOINT_SIZE + 4)
758 /* we might need to change message format someday */
759 if (copy_from_user (&tag, buf, 4)) {
763 DBG(data->dev, "config %s, bad tag %d\n", data->name, tag);
769 /* NOTE: audio endpoint extensions not accepted here;
770 * just don't include the extra bytes.
773 /* full/low speed descriptor, then high speed */
774 if (copy_from_user (&data->desc, buf, USB_DT_ENDPOINT_SIZE)) {
777 if (data->desc.bLength != USB_DT_ENDPOINT_SIZE
778 || data->desc.bDescriptorType != USB_DT_ENDPOINT)
780 if (len != USB_DT_ENDPOINT_SIZE) {
781 if (len != 2 * USB_DT_ENDPOINT_SIZE)
783 if (copy_from_user (&data->hs_desc, buf + USB_DT_ENDPOINT_SIZE,
784 USB_DT_ENDPOINT_SIZE)) {
787 if (data->hs_desc.bLength != USB_DT_ENDPOINT_SIZE
788 || data->hs_desc.bDescriptorType
789 != USB_DT_ENDPOINT) {
790 DBG(data->dev, "config %s, bad hs length or type\n",
797 spin_lock_irq (&data->dev->lock);
798 if (data->dev->state == STATE_DEV_UNBOUND) {
801 } else if ((ep = data->ep) == NULL) {
805 switch (data->dev->gadget->speed) {
808 value = usb_ep_enable (ep, &data->desc);
810 data->state = STATE_EP_ENABLED;
814 /* fails if caller didn't provide that descriptor... */
815 value = usb_ep_enable (ep, &data->hs_desc);
817 data->state = STATE_EP_ENABLED;
821 DBG (data->dev, "unconnected, %s init deferred\n",
823 data->state = STATE_EP_DEFER_ENABLE;
826 fd->f_op = &ep_io_operations;
828 spin_unlock_irq (&data->dev->lock);
831 data->desc.bDescriptorType = 0;
832 data->hs_desc.bDescriptorType = 0;
845 ep_open (struct inode *inode, struct file *fd)
847 struct ep_data *data = inode->u.generic_ip;
850 if (down_interruptible (&data->lock) != 0)
852 spin_lock_irq (&data->dev->lock);
853 if (data->dev->state == STATE_DEV_UNBOUND)
855 else if (data->state == STATE_EP_DISABLED) {
857 data->state = STATE_EP_READY;
859 fd->private_data = data;
860 VDEBUG (data->dev, "%s ready\n", data->name);
862 DBG (data->dev, "%s state %d\n",
863 data->name, data->state);
864 spin_unlock_irq (&data->dev->lock);
869 /* used before endpoint configuration */
870 static struct file_operations ep_config_operations = {
871 .owner = THIS_MODULE,
876 .release = ep_release,
879 /*----------------------------------------------------------------------*/
881 /* EP0 IMPLEMENTATION can be partly in userspace.
883 * Drivers that use this facility receive various events, including
884 * control requests the kernel doesn't handle. Drivers that don't
885 * use this facility may be too simple-minded for real applications.
888 static inline void ep0_readable (struct dev_data *dev)
890 wake_up (&dev->wait);
891 kill_fasync (&dev->fasync, SIGIO, POLL_IN);
894 static void clean_req (struct usb_ep *ep, struct usb_request *req)
896 struct dev_data *dev = ep->driver_data;
898 if (req->buf != dev->rbuf) {
899 usb_ep_free_buffer (ep, req->buf, req->dma, req->length);
900 req->buf = dev->rbuf;
901 req->dma = DMA_ADDR_INVALID;
903 req->complete = epio_complete;
904 dev->setup_out_ready = 0;
907 static void ep0_complete (struct usb_ep *ep, struct usb_request *req)
909 struct dev_data *dev = ep->driver_data;
912 /* for control OUT, data must still get to userspace */
913 if (!dev->setup_in) {
914 dev->setup_out_error = (req->status != 0);
915 if (!dev->setup_out_error)
917 dev->setup_out_ready = 1;
919 } else if (dev->state == STATE_SETUP)
920 dev->state = STATE_CONNECTED;
922 /* clean up as appropriate */
923 if (free && req->buf != &dev->rbuf)
925 req->complete = epio_complete;
928 static int setup_req (struct usb_ep *ep, struct usb_request *req, u16 len)
930 struct dev_data *dev = ep->driver_data;
932 if (dev->setup_out_ready) {
933 DBG (dev, "ep0 request busy!\n");
936 if (len > sizeof (dev->rbuf))
937 req->buf = usb_ep_alloc_buffer (ep, len, &req->dma, GFP_ATOMIC);
939 req->buf = dev->rbuf;
942 req->complete = ep0_complete;
948 ep0_read (struct file *fd, char __user *buf, size_t len, loff_t *ptr)
950 struct dev_data *dev = fd->private_data;
952 enum ep0_state state;
954 spin_lock_irq (&dev->lock);
956 /* report fd mode change before acting on it */
957 if (dev->setup_abort) {
958 dev->setup_abort = 0;
963 /* control DATA stage */
964 if ((state = dev->state) == STATE_SETUP) {
966 if (dev->setup_in) { /* stall IN */
967 VDEBUG(dev, "ep0in stall\n");
968 (void) usb_ep_set_halt (dev->gadget->ep0);
970 dev->state = STATE_CONNECTED;
972 } else if (len == 0) { /* ack SET_CONFIGURATION etc */
973 struct usb_ep *ep = dev->gadget->ep0;
974 struct usb_request *req = dev->req;
976 if ((retval = setup_req (ep, req, 0)) == 0)
977 retval = usb_ep_queue (ep, req, GFP_ATOMIC);
978 dev->state = STATE_CONNECTED;
980 /* assume that was SET_CONFIGURATION */
981 if (dev->current_config) {
984 if (dev->gadget->speed == USB_SPEED_HIGH)
985 power = dev->hs_config->bMaxPower;
988 power = dev->config->bMaxPower;
989 usb_gadget_vbus_draw(dev->gadget, 2 * power);
992 } else { /* collect OUT data */
993 if ((fd->f_flags & O_NONBLOCK) != 0
994 && !dev->setup_out_ready) {
998 spin_unlock_irq (&dev->lock);
999 retval = wait_event_interruptible (dev->wait,
1000 dev->setup_out_ready != 0);
1002 /* FIXME state could change from under us */
1003 spin_lock_irq (&dev->lock);
1006 if (dev->setup_out_error)
1009 len = min (len, (size_t)dev->req->actual);
1010 // FIXME don't call this with the spinlock held ...
1011 if (copy_to_user (buf, &dev->req->buf, len))
1013 clean_req (dev->gadget->ep0, dev->req);
1014 /* NOTE userspace can't yet choose to stall */
1020 /* else normal: return event data */
1021 if (len < sizeof dev->event [0]) {
1025 len -= len % sizeof (struct usb_gadgetfs_event);
1026 dev->usermode_setup = 1;
1029 /* return queued events right away */
1030 if (dev->ev_next != 0) {
1032 int tmp = dev->ev_next;
1034 len = min (len, tmp * sizeof (struct usb_gadgetfs_event));
1035 n = len / sizeof (struct usb_gadgetfs_event);
1037 /* ep0 can't deliver events when STATE_SETUP */
1038 for (i = 0; i < n; i++) {
1039 if (dev->event [i].type == GADGETFS_SETUP) {
1041 len *= sizeof (struct usb_gadgetfs_event);
1046 spin_unlock_irq (&dev->lock);
1047 if (copy_to_user (buf, &dev->event, len))
1052 len /= sizeof (struct usb_gadgetfs_event);
1054 /* NOTE this doesn't guard against broken drivers;
1055 * concurrent ep0 readers may lose events.
1057 spin_lock_irq (&dev->lock);
1058 dev->ev_next -= len;
1059 if (dev->ev_next != 0)
1060 memmove (&dev->event, &dev->event [len],
1061 sizeof (struct usb_gadgetfs_event)
1064 dev->state = STATE_SETUP;
1065 spin_unlock_irq (&dev->lock);
1069 if (fd->f_flags & O_NONBLOCK) {
1076 DBG (dev, "fail %s, state %d\n", __FUNCTION__, state);
1079 case STATE_UNCONNECTED:
1080 case STATE_CONNECTED:
1081 spin_unlock_irq (&dev->lock);
1082 DBG (dev, "%s wait\n", __FUNCTION__);
1084 /* wait for events */
1085 retval = wait_event_interruptible (dev->wait,
1089 spin_lock_irq (&dev->lock);
1094 spin_unlock_irq (&dev->lock);
1098 static struct usb_gadgetfs_event *
1099 next_event (struct dev_data *dev, enum usb_gadgetfs_event_type type)
1101 struct usb_gadgetfs_event *event;
1105 /* these events purge the queue */
1106 case GADGETFS_DISCONNECT:
1107 if (dev->state == STATE_SETUP)
1108 dev->setup_abort = 1;
1110 case GADGETFS_CONNECT:
1113 case GADGETFS_SETUP: /* previous request timed out */
1114 case GADGETFS_SUSPEND: /* same effect */
1115 /* these events can't be repeated */
1116 for (i = 0; i != dev->ev_next; i++) {
1117 if (dev->event [i].type != type)
1119 DBG (dev, "discard old event %d\n", type);
1121 if (i == dev->ev_next)
1123 /* indices start at zero, for simplicity */
1124 memmove (&dev->event [i], &dev->event [i + 1],
1125 sizeof (struct usb_gadgetfs_event)
1126 * (dev->ev_next - i));
1132 event = &dev->event [dev->ev_next++];
1133 BUG_ON (dev->ev_next > N_EVENT);
1134 VDEBUG (dev, "ev %d, next %d\n", type, dev->ev_next);
1135 memset (event, 0, sizeof *event);
1141 ep0_write (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
1143 struct dev_data *dev = fd->private_data;
1144 ssize_t retval = -ESRCH;
1146 spin_lock_irq (&dev->lock);
1148 /* report fd mode change before acting on it */
1149 if (dev->setup_abort) {
1150 dev->setup_abort = 0;
1153 /* data and/or status stage for control request */
1154 } else if (dev->state == STATE_SETUP) {
1156 /* IN DATA+STATUS caller makes len <= wLength */
1157 if (dev->setup_in) {
1158 retval = setup_req (dev->gadget->ep0, dev->req, len);
1160 spin_unlock_irq (&dev->lock);
1161 if (copy_from_user (dev->req->buf, buf, len))
1164 retval = usb_ep_queue (
1165 dev->gadget->ep0, dev->req,
1168 spin_lock_irq (&dev->lock);
1169 clean_req (dev->gadget->ep0, dev->req);
1170 spin_unlock_irq (&dev->lock);
1177 /* can stall some OUT transfers */
1178 } else if (dev->setup_can_stall) {
1179 VDEBUG(dev, "ep0out stall\n");
1180 (void) usb_ep_set_halt (dev->gadget->ep0);
1182 dev->state = STATE_CONNECTED;
1184 DBG(dev, "bogus ep0out stall!\n");
1187 DBG (dev, "fail %s, state %d\n", __FUNCTION__, dev->state);
1189 spin_unlock_irq (&dev->lock);
1194 ep0_fasync (int f, struct file *fd, int on)
1196 struct dev_data *dev = fd->private_data;
1197 // caller must F_SETOWN before signal delivery happens
1198 VDEBUG (dev, "%s %s\n", __FUNCTION__, on ? "on" : "off");
1199 return fasync_helper (f, fd, on, &dev->fasync);
1202 static struct usb_gadget_driver gadgetfs_driver;
1205 dev_release (struct inode *inode, struct file *fd)
1207 struct dev_data *dev = fd->private_data;
1209 /* closing ep0 === shutdown all */
1211 usb_gadget_unregister_driver (&gadgetfs_driver);
1213 /* at this point "good" hardware has disconnected the
1214 * device from USB; the host won't see it any more.
1215 * alternatively, all host requests will time out.
1218 fasync_helper (-1, fd, 0, &dev->fasync);
1223 /* other endpoints were all decoupled from this device */
1224 dev->state = STATE_DEV_DISABLED;
1228 static int dev_ioctl (struct inode *inode, struct file *fd,
1229 unsigned code, unsigned long value)
1231 struct dev_data *dev = fd->private_data;
1232 struct usb_gadget *gadget = dev->gadget;
1234 if (gadget->ops->ioctl)
1235 return gadget->ops->ioctl (gadget, code, value);
1239 /* used after device configuration */
1240 static struct file_operations ep0_io_operations = {
1241 .owner = THIS_MODULE,
1242 .llseek = no_llseek,
1246 .fasync = ep0_fasync,
1247 // .poll = ep0_poll,
1249 .release = dev_release,
1252 /*----------------------------------------------------------------------*/
1254 /* The in-kernel gadget driver handles most ep0 issues, in particular
1255 * enumerating the single configuration (as provided from user space).
1257 * Unrecognized ep0 requests may be handled in user space.
1261 static void make_qualifier (struct dev_data *dev)
1263 struct usb_qualifier_descriptor qual;
1264 struct usb_device_descriptor *desc;
1266 qual.bLength = sizeof qual;
1267 qual.bDescriptorType = USB_DT_DEVICE_QUALIFIER;
1268 qual.bcdUSB = __constant_cpu_to_le16 (0x0200);
1271 qual.bDeviceClass = desc->bDeviceClass;
1272 qual.bDeviceSubClass = desc->bDeviceSubClass;
1273 qual.bDeviceProtocol = desc->bDeviceProtocol;
1275 /* assumes ep0 uses the same value for both speeds ... */
1276 qual.bMaxPacketSize0 = desc->bMaxPacketSize0;
1278 qual.bNumConfigurations = 1;
1281 memcpy (dev->rbuf, &qual, sizeof qual);
1286 config_buf (struct dev_data *dev, u8 type, unsigned index)
1293 /* only one configuration */
1298 hs = (dev->gadget->speed == USB_SPEED_HIGH);
1299 if (type == USB_DT_OTHER_SPEED_CONFIG)
1302 dev->req->buf = dev->hs_config;
1303 len = le16_to_cpup (&dev->hs_config->wTotalLength);
1307 dev->req->buf = dev->config;
1308 len = le16_to_cpup (&dev->config->wTotalLength);
1310 ((u8 *)dev->req->buf) [1] = type;
1315 gadgetfs_setup (struct usb_gadget *gadget, const struct usb_ctrlrequest *ctrl)
1317 struct dev_data *dev = get_gadget_data (gadget);
1318 struct usb_request *req = dev->req;
1319 int value = -EOPNOTSUPP;
1320 struct usb_gadgetfs_event *event;
1321 u16 w_value = ctrl->wValue;
1322 u16 w_length = ctrl->wLength;
1324 spin_lock (&dev->lock);
1325 dev->setup_abort = 0;
1326 if (dev->state == STATE_UNCONNECTED) {
1328 struct ep_data *data;
1330 dev->state = STATE_CONNECTED;
1331 dev->dev->bMaxPacketSize0 = gadget->ep0->maxpacket;
1334 if (gadget->speed == USB_SPEED_HIGH && dev->hs_config == 0) {
1335 ERROR (dev, "no high speed config??\n");
1338 #endif /* HIGHSPEED */
1340 INFO (dev, "connected\n");
1341 event = next_event (dev, GADGETFS_CONNECT);
1342 event->u.speed = gadget->speed;
1345 list_for_each_entry (ep, &gadget->ep_list, ep_list) {
1346 data = ep->driver_data;
1347 /* ... down_trylock (&data->lock) ... */
1348 if (data->state != STATE_EP_DEFER_ENABLE)
1351 if (gadget->speed == USB_SPEED_HIGH)
1352 value = usb_ep_enable (ep, &data->hs_desc);
1354 #endif /* HIGHSPEED */
1355 value = usb_ep_enable (ep, &data->desc);
1357 ERROR (dev, "deferred %s enable --> %d\n",
1361 data->state = STATE_EP_ENABLED;
1362 wake_up (&data->wait);
1363 DBG (dev, "woke up %s waiters\n", data->name);
1366 /* host may have given up waiting for response. we can miss control
1367 * requests handled lower down (device/endpoint status and features);
1368 * then ep0_{read,write} will report the wrong status. controller
1369 * driver will have aborted pending i/o.
1371 } else if (dev->state == STATE_SETUP)
1372 dev->setup_abort = 1;
1374 req->buf = dev->rbuf;
1375 req->dma = DMA_ADDR_INVALID;
1376 req->context = NULL;
1377 value = -EOPNOTSUPP;
1378 switch (ctrl->bRequest) {
1380 case USB_REQ_GET_DESCRIPTOR:
1381 if (ctrl->bRequestType != USB_DIR_IN)
1383 switch (w_value >> 8) {
1386 value = min (w_length, (u16) sizeof *dev->dev);
1387 req->buf = dev->dev;
1390 case USB_DT_DEVICE_QUALIFIER:
1391 if (!dev->hs_config)
1393 value = min (w_length, (u16)
1394 sizeof (struct usb_qualifier_descriptor));
1395 make_qualifier (dev);
1397 case USB_DT_OTHER_SPEED_CONFIG:
1401 value = config_buf (dev,
1405 value = min (w_length, (u16) value);
1410 default: // all others are errors
1415 /* currently one config, two speeds */
1416 case USB_REQ_SET_CONFIGURATION:
1417 if (ctrl->bRequestType != 0)
1419 if (0 == (u8) w_value) {
1421 dev->current_config = 0;
1422 usb_gadget_vbus_draw(gadget, 8 /* mA */ );
1423 // user mode expected to disable endpoints
1427 if (gadget->speed == USB_SPEED_HIGH) {
1428 config = dev->hs_config->bConfigurationValue;
1429 power = dev->hs_config->bMaxPower;
1433 config = dev->config->bConfigurationValue;
1434 power = dev->config->bMaxPower;
1437 if (config == (u8) w_value) {
1439 dev->current_config = config;
1440 usb_gadget_vbus_draw(gadget, 2 * power);
1444 /* report SET_CONFIGURATION like any other control request,
1445 * except that usermode may not stall this. the next
1446 * request mustn't be allowed start until this finishes:
1447 * endpoints and threads set up, etc.
1449 * NOTE: older PXA hardware (before PXA 255: without UDCCFR)
1450 * has bad/racey automagic that prevents synchronizing here.
1451 * even kernel mode drivers often miss them.
1454 INFO (dev, "configuration #%d\n", dev->current_config);
1455 if (dev->usermode_setup) {
1456 dev->setup_can_stall = 0;
1462 #ifndef CONFIG_USB_GADGETFS_PXA2XX
1463 /* PXA automagically handles this request too */
1464 case USB_REQ_GET_CONFIGURATION:
1465 if (ctrl->bRequestType != 0x80)
1467 *(u8 *)req->buf = dev->current_config;
1468 value = min (w_length, (u16) 1);
1474 VDEBUG (dev, "%s req%02x.%02x v%04x i%04x l%d\n",
1475 dev->usermode_setup ? "delegate" : "fail",
1476 ctrl->bRequestType, ctrl->bRequest,
1477 w_value, le16_to_cpu(ctrl->wIndex), w_length);
1479 /* if there's an ep0 reader, don't stall */
1480 if (dev->usermode_setup) {
1481 dev->setup_can_stall = 1;
1483 dev->setup_in = (ctrl->bRequestType & USB_DIR_IN)
1485 dev->setup_out_ready = 0;
1486 dev->setup_out_error = 0;
1489 /* read DATA stage for OUT right away */
1490 if (unlikely (!dev->setup_in && w_length)) {
1491 value = setup_req (gadget->ep0, dev->req,
1495 value = usb_ep_queue (gadget->ep0, dev->req,
1498 clean_req (gadget->ep0, dev->req);
1502 /* we can't currently stall these */
1503 dev->setup_can_stall = 0;
1506 /* state changes when reader collects event */
1507 event = next_event (dev, GADGETFS_SETUP);
1508 event->u.setup = *ctrl;
1510 spin_unlock (&dev->lock);
1515 /* proceed with data transfer and status phases? */
1516 if (value >= 0 && dev->state != STATE_SETUP) {
1517 req->length = value;
1518 req->zero = value < w_length;
1519 value = usb_ep_queue (gadget->ep0, req, GFP_ATOMIC);
1521 DBG (dev, "ep_queue --> %d\n", value);
1526 /* device stalls when value < 0 */
1527 spin_unlock (&dev->lock);
1531 static void destroy_ep_files (struct dev_data *dev)
1533 struct list_head *entry, *tmp;
1535 DBG (dev, "%s %d\n", __FUNCTION__, dev->state);
1537 /* dev->state must prevent interference */
1539 spin_lock_irq (&dev->lock);
1540 list_for_each_safe (entry, tmp, &dev->epfiles) {
1542 struct inode *parent;
1543 struct dentry *dentry;
1545 /* break link to FS */
1546 ep = list_entry (entry, struct ep_data, epfiles);
1547 list_del_init (&ep->epfiles);
1548 dentry = ep->dentry;
1550 parent = dentry->d_parent->d_inode;
1552 /* break link to controller */
1553 if (ep->state == STATE_EP_ENABLED)
1554 (void) usb_ep_disable (ep->ep);
1555 ep->state = STATE_EP_UNBOUND;
1556 usb_ep_free_request (ep->ep, ep->req);
1558 wake_up (&ep->wait);
1561 spin_unlock_irq (&dev->lock);
1563 /* break link to dcache */
1564 down (&parent->i_sem);
1567 up (&parent->i_sem);
1569 /* fds may still be open */
1572 spin_unlock_irq (&dev->lock);
1576 static struct inode *
1577 gadgetfs_create_file (struct super_block *sb, char const *name,
1578 void *data, struct file_operations *fops,
1579 struct dentry **dentry_p);
1581 static int activate_ep_files (struct dev_data *dev)
1585 gadget_for_each_ep (ep, dev->gadget) {
1586 struct ep_data *data;
1588 data = kmalloc (sizeof *data, GFP_KERNEL);
1591 memset (data, 0, sizeof data);
1592 data->state = STATE_EP_DISABLED;
1593 init_MUTEX (&data->lock);
1594 init_waitqueue_head (&data->wait);
1596 strncpy (data->name, ep->name, sizeof (data->name) - 1);
1597 atomic_set (&data->count, 1);
1602 ep->driver_data = data;
1604 data->req = usb_ep_alloc_request (ep, GFP_KERNEL);
1608 data->inode = gadgetfs_create_file (dev->sb, data->name,
1609 data, &ep_config_operations,
1615 list_add_tail (&data->epfiles, &dev->epfiles);
1620 DBG (dev, "%s enomem\n", __FUNCTION__);
1621 destroy_ep_files (dev);
1626 gadgetfs_unbind (struct usb_gadget *gadget)
1628 struct dev_data *dev = get_gadget_data (gadget);
1630 DBG (dev, "%s\n", __FUNCTION__);
1632 spin_lock_irq (&dev->lock);
1633 dev->state = STATE_DEV_UNBOUND;
1634 spin_unlock_irq (&dev->lock);
1636 destroy_ep_files (dev);
1637 gadget->ep0->driver_data = NULL;
1638 set_gadget_data (gadget, NULL);
1640 /* we've already been disconnected ... no i/o is active */
1642 usb_ep_free_request (gadget->ep0, dev->req);
1643 DBG (dev, "%s done\n", __FUNCTION__);
1647 static struct dev_data *the_device;
1650 gadgetfs_bind (struct usb_gadget *gadget)
1652 struct dev_data *dev = the_device;
1656 if (0 != strcmp (CHIP, gadget->name)) {
1657 printk (KERN_ERR "%s expected %s controller not %s\n",
1658 shortname, CHIP, gadget->name);
1662 set_gadget_data (gadget, dev);
1663 dev->gadget = gadget;
1664 gadget->ep0->driver_data = dev;
1665 dev->dev->bMaxPacketSize0 = gadget->ep0->maxpacket;
1667 /* preallocate control response and buffer */
1668 dev->req = usb_ep_alloc_request (gadget->ep0, GFP_KERNEL);
1671 dev->req->context = NULL;
1672 dev->req->complete = epio_complete;
1674 if (activate_ep_files (dev) < 0)
1677 INFO (dev, "bound to %s driver\n", gadget->name);
1678 dev->state = STATE_UNCONNECTED;
1683 gadgetfs_unbind (gadget);
1688 gadgetfs_disconnect (struct usb_gadget *gadget)
1690 struct dev_data *dev = get_gadget_data (gadget);
1692 if (dev->state == STATE_UNCONNECTED) {
1693 DBG (dev, "already unconnected\n");
1696 dev->state = STATE_UNCONNECTED;
1698 INFO (dev, "disconnected\n");
1699 spin_lock (&dev->lock);
1700 next_event (dev, GADGETFS_DISCONNECT);
1702 spin_unlock (&dev->lock);
1706 gadgetfs_suspend (struct usb_gadget *gadget)
1708 struct dev_data *dev = get_gadget_data (gadget);
1710 INFO (dev, "suspended from state %d\n", dev->state);
1711 spin_lock (&dev->lock);
1712 switch (dev->state) {
1713 case STATE_SETUP: // VERY odd... host died??
1714 case STATE_CONNECTED:
1715 case STATE_UNCONNECTED:
1716 next_event (dev, GADGETFS_SUSPEND);
1722 spin_unlock (&dev->lock);
1725 static struct usb_gadget_driver gadgetfs_driver = {
1727 .speed = USB_SPEED_HIGH,
1729 .speed = USB_SPEED_FULL,
1731 .function = (char *) driver_desc,
1732 .bind = gadgetfs_bind,
1733 .unbind = gadgetfs_unbind,
1734 .setup = gadgetfs_setup,
1735 .disconnect = gadgetfs_disconnect,
1736 .suspend = gadgetfs_suspend,
1739 .name = (char *) shortname,
1746 /*----------------------------------------------------------------------*/
1748 static void gadgetfs_nop(struct usb_gadget *arg) { }
1750 static int gadgetfs_probe (struct usb_gadget *gadget)
1752 CHIP = gadget->name;
1756 static struct usb_gadget_driver probe_driver = {
1757 .speed = USB_SPEED_HIGH,
1758 .bind = gadgetfs_probe,
1759 .unbind = gadgetfs_nop,
1760 .setup = (void *)gadgetfs_nop,
1761 .disconnect = gadgetfs_nop,
1768 /* DEVICE INITIALIZATION
1770 * fd = open ("/dev/gadget/$CHIP", O_RDWR)
1771 * status = write (fd, descriptors, sizeof descriptors)
1773 * That write establishes the device configuration, so the kernel can
1774 * bind to the controller ... guaranteeing it can handle enumeration
1775 * at all necessary speeds. Descriptor order is:
1777 * . message tag (u32, host order) ... for now, must be zero; it
1778 * would change to support features like multi-config devices
1779 * . full/low speed config ... all wTotalLength bytes (with interface,
1780 * class, altsetting, endpoint, and other descriptors)
1781 * . high speed config ... all descriptors, for high speed operation;
1782 * this one's optional except for high-speed hardware
1783 * . device descriptor
1785 * Endpoints are not yet enabled. Drivers may want to immediately
1786 * initialize them, using the /dev/gadget/ep* files that are available
1787 * as soon as the kernel sees the configuration, or they can wait
1788 * until device configuration and interface altsetting changes create
1789 * the need to configure (or unconfigure) them.
1791 * After initialization, the device stays active for as long as that
1792 * $CHIP file is open. Events may then be read from that descriptor,
1793 * such configuration notifications. More complex drivers will handle
1794 * some control requests in user space.
1797 static int is_valid_config (struct usb_config_descriptor *config)
1799 return config->bDescriptorType == USB_DT_CONFIG
1800 && config->bLength == USB_DT_CONFIG_SIZE
1801 && config->bConfigurationValue != 0
1802 && (config->bmAttributes & USB_CONFIG_ATT_ONE) != 0
1803 && (config->bmAttributes & USB_CONFIG_ATT_WAKEUP) == 0;
1804 /* FIXME if gadget->is_otg, _must_ include an otg descriptor */
1805 /* FIXME check lengths: walk to end */
1809 dev_config (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
1811 struct dev_data *dev = fd->private_data;
1812 ssize_t value = len, length = len;
1817 if (dev->state != STATE_OPENED)
1820 if (len < (USB_DT_CONFIG_SIZE + USB_DT_DEVICE_SIZE + 4))
1823 /* we might need to change message format someday */
1824 if (copy_from_user (&tag, buf, 4))
1831 kbuf = kmalloc (length, SLAB_KERNEL);
1834 if (copy_from_user (kbuf, buf, length)) {
1839 spin_lock_irq (&dev->lock);
1845 /* full or low speed config */
1846 dev->config = (void *) kbuf;
1847 total = le16_to_cpup (&dev->config->wTotalLength);
1848 if (!is_valid_config (dev->config) || total >= length)
1853 /* optional high speed config */
1854 if (kbuf [1] == USB_DT_CONFIG) {
1855 dev->hs_config = (void *) kbuf;
1856 total = le16_to_cpup (&dev->hs_config->wTotalLength);
1857 if (!is_valid_config (dev->hs_config) || total >= length)
1863 /* could support multiple configs, using another encoding! */
1865 /* device descriptor (tweaked for paranoia) */
1866 if (length != USB_DT_DEVICE_SIZE)
1868 dev->dev = (void *)kbuf;
1869 if (dev->dev->bLength != USB_DT_DEVICE_SIZE
1870 || dev->dev->bDescriptorType != USB_DT_DEVICE
1871 || dev->dev->bNumConfigurations != 1)
1873 dev->dev->bNumConfigurations = 1;
1874 dev->dev->bcdUSB = __constant_cpu_to_le16 (0x0200);
1876 /* triggers gadgetfs_bind(); then we can enumerate. */
1877 spin_unlock_irq (&dev->lock);
1878 value = usb_gadget_register_driver (&gadgetfs_driver);
1883 /* at this point "good" hardware has for the first time
1884 * let the USB the host see us. alternatively, if users
1885 * unplug/replug that will clear all the error state.
1887 * note: everything running before here was guaranteed
1888 * to choke driver model style diagnostics. from here
1889 * on, they can work ... except in cleanup paths that
1890 * kick in after the ep0 descriptor is closed.
1892 fd->f_op = &ep0_io_operations;
1898 spin_unlock_irq (&dev->lock);
1899 pr_debug ("%s: %s fail %Zd, %p\n", shortname, __FUNCTION__, value, dev);
1906 dev_open (struct inode *inode, struct file *fd)
1908 struct dev_data *dev = inode->u.generic_ip;
1911 if (dev->state == STATE_DEV_DISABLED) {
1913 dev->state = STATE_OPENED;
1914 fd->private_data = dev;
1921 static struct file_operations dev_init_operations = {
1922 .owner = THIS_MODULE,
1923 .llseek = no_llseek,
1926 .write = dev_config,
1927 .fasync = ep0_fasync,
1929 .release = dev_release,
1932 /*----------------------------------------------------------------------*/
1934 /* FILESYSTEM AND SUPERBLOCK OPERATIONS
1936 * Mounting the filesystem creates a controller file, used first for
1937 * device configuration then later for event monitoring.
1941 /* FIXME PAM etc could set this security policy without mount options
1942 * if epfiles inherited ownership and permissons from ep0 ...
1945 static unsigned default_uid;
1946 static unsigned default_gid;
1947 static unsigned default_perm = S_IRUSR | S_IWUSR;
1949 module_param (default_uid, uint, 0644);
1950 module_param (default_gid, uint, 0644);
1951 module_param (default_perm, uint, 0644);
1954 static struct inode *
1955 gadgetfs_make_inode (struct super_block *sb,
1956 void *data, struct file_operations *fops,
1959 struct inode *inode = new_inode (sb);
1962 inode->i_mode = mode;
1963 inode->i_uid = default_uid;
1964 inode->i_gid = default_gid;
1965 inode->i_blksize = PAGE_CACHE_SIZE;
1966 inode->i_blocks = 0;
1967 inode->i_atime = inode->i_mtime = inode->i_ctime
1969 inode->u.generic_ip = data;
1970 inode->i_fop = fops;
1975 /* creates in fs root directory, so non-renamable and non-linkable.
1976 * so inode and dentry are paired, until device reconfig.
1978 static struct inode *
1979 gadgetfs_create_file (struct super_block *sb, char const *name,
1980 void *data, struct file_operations *fops,
1981 struct dentry **dentry_p)
1983 struct dentry *dentry;
1984 struct inode *inode;
1986 dentry = d_alloc_name(sb->s_root, name);
1990 inode = gadgetfs_make_inode (sb, data, fops,
1991 S_IFREG | (default_perm & S_IRWXUGO));
1996 d_add (dentry, inode);
2001 static struct super_operations gadget_fs_operations = {
2002 .statfs = simple_statfs,
2003 .drop_inode = generic_delete_inode,
2007 gadgetfs_fill_super (struct super_block *sb, void *opts, int silent)
2009 struct inode *inode;
2011 struct dev_data *dev;
2016 /* fake probe to determine $CHIP */
2017 (void) usb_gadget_register_driver (&probe_driver);
2022 sb->s_blocksize = PAGE_CACHE_SIZE;
2023 sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
2024 sb->s_magic = GADGETFS_MAGIC;
2025 sb->s_op = &gadget_fs_operations;
2026 sb->s_time_gran = 1;
2029 inode = gadgetfs_make_inode (sb,
2030 NULL, &simple_dir_operations,
2031 S_IFDIR | S_IRUGO | S_IXUGO);
2034 inode->i_op = &simple_dir_inode_operations;
2035 if (!(d = d_alloc_root (inode))) {
2041 /* the ep0 file is named after the controller we expect;
2042 * user mode code can use it for sanity checks, like we do.
2049 if (!(inode = gadgetfs_create_file (sb, CHIP,
2050 dev, &dev_init_operations,
2056 /* other endpoint files are available after hardware setup,
2057 * from binding to a controller.
2063 /* "mount -t gadgetfs path /dev/gadget" ends up here */
2064 static struct super_block *
2065 gadgetfs_get_sb (struct file_system_type *t, int flags,
2066 const char *path, void *opts)
2068 return get_sb_single (t, flags, opts, gadgetfs_fill_super);
2072 gadgetfs_kill_sb (struct super_block *sb)
2074 kill_litter_super (sb);
2076 put_dev (the_device);
2081 /*----------------------------------------------------------------------*/
2083 static struct file_system_type gadgetfs_type = {
2084 .owner = THIS_MODULE,
2086 .get_sb = gadgetfs_get_sb,
2087 .kill_sb = gadgetfs_kill_sb,
2090 /*----------------------------------------------------------------------*/
2092 static int __init init (void)
2096 status = register_filesystem (&gadgetfs_type);
2098 pr_info ("%s: %s, version " DRIVER_VERSION "\n",
2099 shortname, driver_desc);
2104 static void __exit cleanup (void)
2106 pr_debug ("unregister %s\n", shortname);
2107 unregister_filesystem (&gadgetfs_type);
2109 module_exit (cleanup);