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,
138 unsigned setup_wLength;
140 /* the rest is basically write-once */
141 struct usb_config_descriptor *config, *hs_config;
142 struct usb_device_descriptor *dev;
143 struct usb_request *req;
144 struct usb_gadget *gadget;
145 struct list_head epfiles;
147 wait_queue_head_t wait;
148 struct super_block *sb;
149 struct dentry *dentry;
151 /* except this scratch i/o buffer for ep0 */
155 static inline void get_dev (struct dev_data *data)
157 atomic_inc (&data->count);
160 static void put_dev (struct dev_data *data)
162 if (likely (!atomic_dec_and_test (&data->count)))
164 /* needs no more cleanup */
165 BUG_ON (waitqueue_active (&data->wait));
169 static struct dev_data *dev_new (void)
171 struct dev_data *dev;
173 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
176 dev->state = STATE_DEV_DISABLED;
177 atomic_set (&dev->count, 1);
178 spin_lock_init (&dev->lock);
179 INIT_LIST_HEAD (&dev->epfiles);
180 init_waitqueue_head (&dev->wait);
184 /*----------------------------------------------------------------------*/
186 /* other /dev/gadget/$ENDPOINT files represent endpoints */
188 STATE_EP_DISABLED = 0,
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 %zu OUT, status %d\n",
421 data->name, len, (int) 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 %zu IN, status %d\n",
469 data->name, len, (int) 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;
486 usb_ep_disable(data->ep);
492 static int ep_ioctl (struct inode *inode, struct file *fd,
493 unsigned code, unsigned long value)
495 struct ep_data *data = fd->private_data;
498 if ((status = get_ready_ep (fd->f_flags, data)) < 0)
501 spin_lock_irq (&data->dev->lock);
502 if (likely (data->ep != NULL)) {
504 case GADGETFS_FIFO_STATUS:
505 status = usb_ep_fifo_status (data->ep);
507 case GADGETFS_FIFO_FLUSH:
508 usb_ep_fifo_flush (data->ep);
510 case GADGETFS_CLEAR_HALT:
511 status = usb_ep_clear_halt (data->ep);
518 spin_unlock_irq (&data->dev->lock);
523 /*----------------------------------------------------------------------*/
525 /* ASYNCHRONOUS ENDPOINT I/O OPERATIONS (bulk/intr/iso) */
528 struct usb_request *req;
529 struct ep_data *epdata;
531 char __user *ubuf; /* NULL for writes */
535 static int ep_aio_cancel(struct kiocb *iocb, struct io_event *e)
537 struct kiocb_priv *priv = iocb->private;
538 struct ep_data *epdata;
542 epdata = priv->epdata;
543 // spin_lock(&epdata->dev->lock);
544 kiocbSetCancelled(iocb);
545 if (likely(epdata && epdata->ep && priv->req))
546 value = usb_ep_dequeue (epdata->ep, priv->req);
549 // spin_unlock(&epdata->dev->lock);
556 static ssize_t ep_aio_read_retry(struct kiocb *iocb)
558 struct kiocb_priv *priv = iocb->private;
559 ssize_t status = priv->actual;
561 /* we "retry" to get the right mm context for this: */
562 status = copy_to_user(priv->ubuf, priv->buf, priv->actual);
563 if (unlikely(0 != status))
566 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 (priv->ubuf == NULL
583 || unlikely(req->actual == 0)
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;
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 = (ubuf ? -EIOCBRETRY : -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;
744 int value, length = len;
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",
796 spin_lock_irq (&data->dev->lock);
797 if (data->dev->state == STATE_DEV_UNBOUND) {
800 } else if ((ep = data->ep) == NULL) {
804 switch (data->dev->gadget->speed) {
807 value = usb_ep_enable (ep, &data->desc);
809 data->state = STATE_EP_ENABLED;
811 #ifdef CONFIG_USB_GADGET_DUALSPEED
813 /* fails if caller didn't provide that descriptor... */
814 value = usb_ep_enable (ep, &data->hs_desc);
816 data->state = STATE_EP_ENABLED;
820 DBG (data->dev, "unconnected, %s init deferred\n",
822 data->state = STATE_EP_DEFER_ENABLE;
825 fd->f_op = &ep_io_operations;
829 spin_unlock_irq (&data->dev->lock);
832 data->desc.bDescriptorType = 0;
833 data->hs_desc.bDescriptorType = 0;
846 ep_open (struct inode *inode, struct file *fd)
848 struct ep_data *data = inode->i_private;
851 if (down_interruptible (&data->lock) != 0)
853 spin_lock_irq (&data->dev->lock);
854 if (data->dev->state == STATE_DEV_UNBOUND)
856 else if (data->state == STATE_EP_DISABLED) {
858 data->state = STATE_EP_READY;
860 fd->private_data = data;
861 VDEBUG (data->dev, "%s ready\n", data->name);
863 DBG (data->dev, "%s state %d\n",
864 data->name, data->state);
865 spin_unlock_irq (&data->dev->lock);
870 /* used before endpoint configuration */
871 static struct file_operations ep_config_operations = {
872 .owner = THIS_MODULE,
877 .release = ep_release,
880 /*----------------------------------------------------------------------*/
882 /* EP0 IMPLEMENTATION can be partly in userspace.
884 * Drivers that use this facility receive various events, including
885 * control requests the kernel doesn't handle. Drivers that don't
886 * use this facility may be too simple-minded for real applications.
889 static inline void ep0_readable (struct dev_data *dev)
891 wake_up (&dev->wait);
892 kill_fasync (&dev->fasync, SIGIO, POLL_IN);
895 static void clean_req (struct usb_ep *ep, struct usb_request *req)
897 struct dev_data *dev = ep->driver_data;
899 if (req->buf != dev->rbuf) {
900 usb_ep_free_buffer (ep, req->buf, req->dma, req->length);
901 req->buf = dev->rbuf;
902 req->dma = DMA_ADDR_INVALID;
904 req->complete = epio_complete;
905 dev->setup_out_ready = 0;
908 static void ep0_complete (struct usb_ep *ep, struct usb_request *req)
910 struct dev_data *dev = ep->driver_data;
913 /* for control OUT, data must still get to userspace */
914 if (!dev->setup_in) {
915 dev->setup_out_error = (req->status != 0);
916 if (!dev->setup_out_error)
918 dev->setup_out_ready = 1;
920 } else if (dev->state == STATE_SETUP)
921 dev->state = STATE_CONNECTED;
923 /* clean up as appropriate */
924 if (free && req->buf != &dev->rbuf)
926 req->complete = epio_complete;
929 static int setup_req (struct usb_ep *ep, struct usb_request *req, u16 len)
931 struct dev_data *dev = ep->driver_data;
933 if (dev->setup_out_ready) {
934 DBG (dev, "ep0 request busy!\n");
937 if (len > sizeof (dev->rbuf))
938 req->buf = usb_ep_alloc_buffer (ep, len, &req->dma, GFP_ATOMIC);
940 req->buf = dev->rbuf;
943 req->complete = ep0_complete;
950 ep0_read (struct file *fd, char __user *buf, size_t len, loff_t *ptr)
952 struct dev_data *dev = fd->private_data;
954 enum ep0_state state;
956 spin_lock_irq (&dev->lock);
958 /* report fd mode change before acting on it */
959 if (dev->setup_abort) {
960 dev->setup_abort = 0;
965 /* control DATA stage */
966 if ((state = dev->state) == STATE_SETUP) {
968 if (dev->setup_in) { /* stall IN */
969 VDEBUG(dev, "ep0in stall\n");
970 (void) usb_ep_set_halt (dev->gadget->ep0);
972 dev->state = STATE_CONNECTED;
974 } else if (len == 0) { /* ack SET_CONFIGURATION etc */
975 struct usb_ep *ep = dev->gadget->ep0;
976 struct usb_request *req = dev->req;
978 if ((retval = setup_req (ep, req, 0)) == 0)
979 retval = usb_ep_queue (ep, req, GFP_ATOMIC);
980 dev->state = STATE_CONNECTED;
982 /* assume that was SET_CONFIGURATION */
983 if (dev->current_config) {
985 #ifdef CONFIG_USB_GADGET_DUALSPEED
986 if (dev->gadget->speed == USB_SPEED_HIGH)
987 power = dev->hs_config->bMaxPower;
990 power = dev->config->bMaxPower;
991 usb_gadget_vbus_draw(dev->gadget, 2 * power);
994 } else { /* collect OUT data */
995 if ((fd->f_flags & O_NONBLOCK) != 0
996 && !dev->setup_out_ready) {
1000 spin_unlock_irq (&dev->lock);
1001 retval = wait_event_interruptible (dev->wait,
1002 dev->setup_out_ready != 0);
1004 /* FIXME state could change from under us */
1005 spin_lock_irq (&dev->lock);
1008 if (dev->setup_out_error)
1011 len = min (len, (size_t)dev->req->actual);
1012 // FIXME don't call this with the spinlock held ...
1013 if (copy_to_user (buf, &dev->req->buf, len))
1015 clean_req (dev->gadget->ep0, dev->req);
1016 /* NOTE userspace can't yet choose to stall */
1022 /* else normal: return event data */
1023 if (len < sizeof dev->event [0]) {
1027 len -= len % sizeof (struct usb_gadgetfs_event);
1028 dev->usermode_setup = 1;
1031 /* return queued events right away */
1032 if (dev->ev_next != 0) {
1034 int tmp = dev->ev_next;
1036 len = min (len, tmp * sizeof (struct usb_gadgetfs_event));
1037 n = len / sizeof (struct usb_gadgetfs_event);
1039 /* ep0 can't deliver events when STATE_SETUP */
1040 for (i = 0; i < n; i++) {
1041 if (dev->event [i].type == GADGETFS_SETUP) {
1043 len *= sizeof (struct usb_gadgetfs_event);
1048 spin_unlock_irq (&dev->lock);
1049 if (copy_to_user (buf, &dev->event, len))
1054 len /= sizeof (struct usb_gadgetfs_event);
1056 /* NOTE this doesn't guard against broken drivers;
1057 * concurrent ep0 readers may lose events.
1059 spin_lock_irq (&dev->lock);
1060 dev->ev_next -= len;
1061 if (dev->ev_next != 0)
1062 memmove (&dev->event, &dev->event [len],
1063 sizeof (struct usb_gadgetfs_event)
1066 dev->state = STATE_SETUP;
1067 spin_unlock_irq (&dev->lock);
1071 if (fd->f_flags & O_NONBLOCK) {
1078 DBG (dev, "fail %s, state %d\n", __FUNCTION__, state);
1081 case STATE_UNCONNECTED:
1082 case STATE_CONNECTED:
1083 spin_unlock_irq (&dev->lock);
1084 DBG (dev, "%s wait\n", __FUNCTION__);
1086 /* wait for events */
1087 retval = wait_event_interruptible (dev->wait,
1091 spin_lock_irq (&dev->lock);
1096 spin_unlock_irq (&dev->lock);
1100 static struct usb_gadgetfs_event *
1101 next_event (struct dev_data *dev, enum usb_gadgetfs_event_type type)
1103 struct usb_gadgetfs_event *event;
1107 /* these events purge the queue */
1108 case GADGETFS_DISCONNECT:
1109 if (dev->state == STATE_SETUP)
1110 dev->setup_abort = 1;
1112 case GADGETFS_CONNECT:
1115 case GADGETFS_SETUP: /* previous request timed out */
1116 case GADGETFS_SUSPEND: /* same effect */
1117 /* these events can't be repeated */
1118 for (i = 0; i != dev->ev_next; i++) {
1119 if (dev->event [i].type != type)
1121 DBG (dev, "discard old event %d\n", type);
1123 if (i == dev->ev_next)
1125 /* indices start at zero, for simplicity */
1126 memmove (&dev->event [i], &dev->event [i + 1],
1127 sizeof (struct usb_gadgetfs_event)
1128 * (dev->ev_next - i));
1134 event = &dev->event [dev->ev_next++];
1135 BUG_ON (dev->ev_next > N_EVENT);
1136 VDEBUG (dev, "ev %d, next %d\n", type, dev->ev_next);
1137 memset (event, 0, sizeof *event);
1143 ep0_write (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
1145 struct dev_data *dev = fd->private_data;
1146 ssize_t retval = -ESRCH;
1148 spin_lock_irq (&dev->lock);
1150 /* report fd mode change before acting on it */
1151 if (dev->setup_abort) {
1152 dev->setup_abort = 0;
1155 /* data and/or status stage for control request */
1156 } else if (dev->state == STATE_SETUP) {
1158 /* IN DATA+STATUS caller makes len <= wLength */
1159 if (dev->setup_in) {
1160 retval = setup_req (dev->gadget->ep0, dev->req, len);
1162 spin_unlock_irq (&dev->lock);
1163 if (copy_from_user (dev->req->buf, buf, len))
1166 if (len < dev->setup_wLength)
1168 retval = usb_ep_queue (
1169 dev->gadget->ep0, dev->req,
1173 spin_lock_irq (&dev->lock);
1174 clean_req (dev->gadget->ep0, dev->req);
1175 spin_unlock_irq (&dev->lock);
1182 /* can stall some OUT transfers */
1183 } else if (dev->setup_can_stall) {
1184 VDEBUG(dev, "ep0out stall\n");
1185 (void) usb_ep_set_halt (dev->gadget->ep0);
1187 dev->state = STATE_CONNECTED;
1189 DBG(dev, "bogus ep0out stall!\n");
1192 DBG (dev, "fail %s, state %d\n", __FUNCTION__, dev->state);
1194 spin_unlock_irq (&dev->lock);
1199 ep0_fasync (int f, struct file *fd, int on)
1201 struct dev_data *dev = fd->private_data;
1202 // caller must F_SETOWN before signal delivery happens
1203 VDEBUG (dev, "%s %s\n", __FUNCTION__, on ? "on" : "off");
1204 return fasync_helper (f, fd, on, &dev->fasync);
1207 static struct usb_gadget_driver gadgetfs_driver;
1210 dev_release (struct inode *inode, struct file *fd)
1212 struct dev_data *dev = fd->private_data;
1214 /* closing ep0 === shutdown all */
1216 usb_gadget_unregister_driver (&gadgetfs_driver);
1218 /* at this point "good" hardware has disconnected the
1219 * device from USB; the host won't see it any more.
1220 * alternatively, all host requests will time out.
1223 fasync_helper (-1, fd, 0, &dev->fasync);
1228 /* other endpoints were all decoupled from this device */
1229 dev->state = STATE_DEV_DISABLED;
1233 static int dev_ioctl (struct inode *inode, struct file *fd,
1234 unsigned code, unsigned long value)
1236 struct dev_data *dev = fd->private_data;
1237 struct usb_gadget *gadget = dev->gadget;
1239 if (gadget->ops->ioctl)
1240 return gadget->ops->ioctl (gadget, code, value);
1244 /* used after device configuration */
1245 static struct file_operations ep0_io_operations = {
1246 .owner = THIS_MODULE,
1247 .llseek = no_llseek,
1251 .fasync = ep0_fasync,
1252 // .poll = ep0_poll,
1254 .release = dev_release,
1257 /*----------------------------------------------------------------------*/
1259 /* The in-kernel gadget driver handles most ep0 issues, in particular
1260 * enumerating the single configuration (as provided from user space).
1262 * Unrecognized ep0 requests may be handled in user space.
1265 #ifdef CONFIG_USB_GADGET_DUALSPEED
1266 static void make_qualifier (struct dev_data *dev)
1268 struct usb_qualifier_descriptor qual;
1269 struct usb_device_descriptor *desc;
1271 qual.bLength = sizeof qual;
1272 qual.bDescriptorType = USB_DT_DEVICE_QUALIFIER;
1273 qual.bcdUSB = __constant_cpu_to_le16 (0x0200);
1276 qual.bDeviceClass = desc->bDeviceClass;
1277 qual.bDeviceSubClass = desc->bDeviceSubClass;
1278 qual.bDeviceProtocol = desc->bDeviceProtocol;
1280 /* assumes ep0 uses the same value for both speeds ... */
1281 qual.bMaxPacketSize0 = desc->bMaxPacketSize0;
1283 qual.bNumConfigurations = 1;
1286 memcpy (dev->rbuf, &qual, sizeof qual);
1291 config_buf (struct dev_data *dev, u8 type, unsigned index)
1294 #ifdef CONFIG_USB_GADGET_DUALSPEED
1298 /* only one configuration */
1302 #ifdef CONFIG_USB_GADGET_DUALSPEED
1303 hs = (dev->gadget->speed == USB_SPEED_HIGH);
1304 if (type == USB_DT_OTHER_SPEED_CONFIG)
1307 dev->req->buf = dev->hs_config;
1308 len = le16_to_cpup (&dev->hs_config->wTotalLength);
1312 dev->req->buf = dev->config;
1313 len = le16_to_cpup (&dev->config->wTotalLength);
1315 ((u8 *)dev->req->buf) [1] = type;
1320 gadgetfs_setup (struct usb_gadget *gadget, const struct usb_ctrlrequest *ctrl)
1322 struct dev_data *dev = get_gadget_data (gadget);
1323 struct usb_request *req = dev->req;
1324 int value = -EOPNOTSUPP;
1325 struct usb_gadgetfs_event *event;
1326 u16 w_value = le16_to_cpu(ctrl->wValue);
1327 u16 w_length = le16_to_cpu(ctrl->wLength);
1329 spin_lock (&dev->lock);
1330 dev->setup_abort = 0;
1331 if (dev->state == STATE_UNCONNECTED) {
1333 struct ep_data *data;
1335 dev->state = STATE_CONNECTED;
1336 dev->dev->bMaxPacketSize0 = gadget->ep0->maxpacket;
1338 #ifdef CONFIG_USB_GADGET_DUALSPEED
1339 if (gadget->speed == USB_SPEED_HIGH && dev->hs_config == 0) {
1340 ERROR (dev, "no high speed config??\n");
1343 #endif /* CONFIG_USB_GADGET_DUALSPEED */
1345 INFO (dev, "connected\n");
1346 event = next_event (dev, GADGETFS_CONNECT);
1347 event->u.speed = gadget->speed;
1350 list_for_each_entry (ep, &gadget->ep_list, ep_list) {
1351 data = ep->driver_data;
1352 /* ... down_trylock (&data->lock) ... */
1353 if (data->state != STATE_EP_DEFER_ENABLE)
1355 #ifdef CONFIG_USB_GADGET_DUALSPEED
1356 if (gadget->speed == USB_SPEED_HIGH)
1357 value = usb_ep_enable (ep, &data->hs_desc);
1359 #endif /* CONFIG_USB_GADGET_DUALSPEED */
1360 value = usb_ep_enable (ep, &data->desc);
1362 ERROR (dev, "deferred %s enable --> %d\n",
1366 data->state = STATE_EP_ENABLED;
1367 wake_up (&data->wait);
1368 DBG (dev, "woke up %s waiters\n", data->name);
1371 /* host may have given up waiting for response. we can miss control
1372 * requests handled lower down (device/endpoint status and features);
1373 * then ep0_{read,write} will report the wrong status. controller
1374 * driver will have aborted pending i/o.
1376 } else if (dev->state == STATE_SETUP)
1377 dev->setup_abort = 1;
1379 req->buf = dev->rbuf;
1380 req->dma = DMA_ADDR_INVALID;
1381 req->context = NULL;
1382 value = -EOPNOTSUPP;
1383 switch (ctrl->bRequest) {
1385 case USB_REQ_GET_DESCRIPTOR:
1386 if (ctrl->bRequestType != USB_DIR_IN)
1388 switch (w_value >> 8) {
1391 value = min (w_length, (u16) sizeof *dev->dev);
1392 req->buf = dev->dev;
1394 #ifdef CONFIG_USB_GADGET_DUALSPEED
1395 case USB_DT_DEVICE_QUALIFIER:
1396 if (!dev->hs_config)
1398 value = min (w_length, (u16)
1399 sizeof (struct usb_qualifier_descriptor));
1400 make_qualifier (dev);
1402 case USB_DT_OTHER_SPEED_CONFIG:
1406 value = config_buf (dev,
1410 value = min (w_length, (u16) value);
1415 default: // all others are errors
1420 /* currently one config, two speeds */
1421 case USB_REQ_SET_CONFIGURATION:
1422 if (ctrl->bRequestType != 0)
1424 if (0 == (u8) w_value) {
1426 dev->current_config = 0;
1427 usb_gadget_vbus_draw(gadget, 8 /* mA */ );
1428 // user mode expected to disable endpoints
1431 #ifdef CONFIG_USB_GADGET_DUALSPEED
1432 if (gadget->speed == USB_SPEED_HIGH) {
1433 config = dev->hs_config->bConfigurationValue;
1434 power = dev->hs_config->bMaxPower;
1438 config = dev->config->bConfigurationValue;
1439 power = dev->config->bMaxPower;
1442 if (config == (u8) w_value) {
1444 dev->current_config = config;
1445 usb_gadget_vbus_draw(gadget, 2 * power);
1449 /* report SET_CONFIGURATION like any other control request,
1450 * except that usermode may not stall this. the next
1451 * request mustn't be allowed start until this finishes:
1452 * endpoints and threads set up, etc.
1454 * NOTE: older PXA hardware (before PXA 255: without UDCCFR)
1455 * has bad/racey automagic that prevents synchronizing here.
1456 * even kernel mode drivers often miss them.
1459 INFO (dev, "configuration #%d\n", dev->current_config);
1460 if (dev->usermode_setup) {
1461 dev->setup_can_stall = 0;
1467 #ifndef CONFIG_USB_GADGETFS_PXA2XX
1468 /* PXA automagically handles this request too */
1469 case USB_REQ_GET_CONFIGURATION:
1470 if (ctrl->bRequestType != 0x80)
1472 *(u8 *)req->buf = dev->current_config;
1473 value = min (w_length, (u16) 1);
1479 VDEBUG (dev, "%s req%02x.%02x v%04x i%04x l%d\n",
1480 dev->usermode_setup ? "delegate" : "fail",
1481 ctrl->bRequestType, ctrl->bRequest,
1482 w_value, le16_to_cpu(ctrl->wIndex), w_length);
1484 /* if there's an ep0 reader, don't stall */
1485 if (dev->usermode_setup) {
1486 dev->setup_can_stall = 1;
1488 dev->setup_in = (ctrl->bRequestType & USB_DIR_IN)
1490 dev->setup_wLength = w_length;
1491 dev->setup_out_ready = 0;
1492 dev->setup_out_error = 0;
1495 /* read DATA stage for OUT right away */
1496 if (unlikely (!dev->setup_in && w_length)) {
1497 value = setup_req (gadget->ep0, dev->req,
1501 value = usb_ep_queue (gadget->ep0, dev->req,
1504 clean_req (gadget->ep0, dev->req);
1508 /* we can't currently stall these */
1509 dev->setup_can_stall = 0;
1512 /* state changes when reader collects event */
1513 event = next_event (dev, GADGETFS_SETUP);
1514 event->u.setup = *ctrl;
1516 spin_unlock (&dev->lock);
1521 /* proceed with data transfer and status phases? */
1522 if (value >= 0 && dev->state != STATE_SETUP) {
1523 req->length = value;
1524 req->zero = value < w_length;
1525 value = usb_ep_queue (gadget->ep0, req, GFP_ATOMIC);
1527 DBG (dev, "ep_queue --> %d\n", value);
1532 /* device stalls when value < 0 */
1533 spin_unlock (&dev->lock);
1537 static void destroy_ep_files (struct dev_data *dev)
1539 struct list_head *entry, *tmp;
1541 DBG (dev, "%s %d\n", __FUNCTION__, dev->state);
1543 /* dev->state must prevent interference */
1545 spin_lock_irq (&dev->lock);
1546 list_for_each_safe (entry, tmp, &dev->epfiles) {
1548 struct inode *parent;
1549 struct dentry *dentry;
1551 /* break link to FS */
1552 ep = list_entry (entry, struct ep_data, epfiles);
1553 list_del_init (&ep->epfiles);
1554 dentry = ep->dentry;
1556 parent = dentry->d_parent->d_inode;
1558 /* break link to controller */
1559 if (ep->state == STATE_EP_ENABLED)
1560 (void) usb_ep_disable (ep->ep);
1561 ep->state = STATE_EP_UNBOUND;
1562 usb_ep_free_request (ep->ep, ep->req);
1564 wake_up (&ep->wait);
1567 spin_unlock_irq (&dev->lock);
1569 /* break link to dcache */
1570 mutex_lock (&parent->i_mutex);
1573 mutex_unlock (&parent->i_mutex);
1575 /* fds may still be open */
1578 spin_unlock_irq (&dev->lock);
1582 static struct inode *
1583 gadgetfs_create_file (struct super_block *sb, char const *name,
1584 void *data, const struct file_operations *fops,
1585 struct dentry **dentry_p);
1587 static int activate_ep_files (struct dev_data *dev)
1590 struct ep_data *data;
1592 gadget_for_each_ep (ep, dev->gadget) {
1594 data = kzalloc(sizeof(*data), GFP_KERNEL);
1597 data->state = STATE_EP_DISABLED;
1598 init_MUTEX (&data->lock);
1599 init_waitqueue_head (&data->wait);
1601 strncpy (data->name, ep->name, sizeof (data->name) - 1);
1602 atomic_set (&data->count, 1);
1607 ep->driver_data = data;
1609 data->req = usb_ep_alloc_request (ep, GFP_KERNEL);
1613 data->inode = gadgetfs_create_file (dev->sb, data->name,
1614 data, &ep_config_operations,
1618 list_add_tail (&data->epfiles, &dev->epfiles);
1623 usb_ep_free_request (ep, data->req);
1628 DBG (dev, "%s enomem\n", __FUNCTION__);
1629 destroy_ep_files (dev);
1634 gadgetfs_unbind (struct usb_gadget *gadget)
1636 struct dev_data *dev = get_gadget_data (gadget);
1638 DBG (dev, "%s\n", __FUNCTION__);
1640 spin_lock_irq (&dev->lock);
1641 dev->state = STATE_DEV_UNBOUND;
1642 spin_unlock_irq (&dev->lock);
1644 destroy_ep_files (dev);
1645 gadget->ep0->driver_data = NULL;
1646 set_gadget_data (gadget, NULL);
1648 /* we've already been disconnected ... no i/o is active */
1650 usb_ep_free_request (gadget->ep0, dev->req);
1651 DBG (dev, "%s done\n", __FUNCTION__);
1655 static struct dev_data *the_device;
1658 gadgetfs_bind (struct usb_gadget *gadget)
1660 struct dev_data *dev = the_device;
1664 if (0 != strcmp (CHIP, gadget->name)) {
1665 printk (KERN_ERR "%s expected %s controller not %s\n",
1666 shortname, CHIP, gadget->name);
1670 set_gadget_data (gadget, dev);
1671 dev->gadget = gadget;
1672 gadget->ep0->driver_data = dev;
1673 dev->dev->bMaxPacketSize0 = gadget->ep0->maxpacket;
1675 /* preallocate control response and buffer */
1676 dev->req = usb_ep_alloc_request (gadget->ep0, GFP_KERNEL);
1679 dev->req->context = NULL;
1680 dev->req->complete = epio_complete;
1682 if (activate_ep_files (dev) < 0)
1685 INFO (dev, "bound to %s driver\n", gadget->name);
1686 dev->state = STATE_UNCONNECTED;
1691 gadgetfs_unbind (gadget);
1696 gadgetfs_disconnect (struct usb_gadget *gadget)
1698 struct dev_data *dev = get_gadget_data (gadget);
1700 spin_lock (&dev->lock);
1701 if (dev->state == STATE_UNCONNECTED) {
1702 DBG (dev, "already unconnected\n");
1705 dev->state = STATE_UNCONNECTED;
1707 INFO (dev, "disconnected\n");
1708 next_event (dev, GADGETFS_DISCONNECT);
1711 spin_unlock (&dev->lock);
1715 gadgetfs_suspend (struct usb_gadget *gadget)
1717 struct dev_data *dev = get_gadget_data (gadget);
1719 INFO (dev, "suspended from state %d\n", dev->state);
1720 spin_lock (&dev->lock);
1721 switch (dev->state) {
1722 case STATE_SETUP: // VERY odd... host died??
1723 case STATE_CONNECTED:
1724 case STATE_UNCONNECTED:
1725 next_event (dev, GADGETFS_SUSPEND);
1731 spin_unlock (&dev->lock);
1734 static struct usb_gadget_driver gadgetfs_driver = {
1735 #ifdef CONFIG_USB_GADGET_DUALSPEED
1736 .speed = USB_SPEED_HIGH,
1738 .speed = USB_SPEED_FULL,
1740 .function = (char *) driver_desc,
1741 .bind = gadgetfs_bind,
1742 .unbind = gadgetfs_unbind,
1743 .setup = gadgetfs_setup,
1744 .disconnect = gadgetfs_disconnect,
1745 .suspend = gadgetfs_suspend,
1748 .name = (char *) shortname,
1752 /*----------------------------------------------------------------------*/
1754 static void gadgetfs_nop(struct usb_gadget *arg) { }
1756 static int gadgetfs_probe (struct usb_gadget *gadget)
1758 CHIP = gadget->name;
1762 static struct usb_gadget_driver probe_driver = {
1763 .speed = USB_SPEED_HIGH,
1764 .bind = gadgetfs_probe,
1765 .unbind = gadgetfs_nop,
1766 .setup = (void *)gadgetfs_nop,
1767 .disconnect = gadgetfs_nop,
1774 /* DEVICE INITIALIZATION
1776 * fd = open ("/dev/gadget/$CHIP", O_RDWR)
1777 * status = write (fd, descriptors, sizeof descriptors)
1779 * That write establishes the device configuration, so the kernel can
1780 * bind to the controller ... guaranteeing it can handle enumeration
1781 * at all necessary speeds. Descriptor order is:
1783 * . message tag (u32, host order) ... for now, must be zero; it
1784 * would change to support features like multi-config devices
1785 * . full/low speed config ... all wTotalLength bytes (with interface,
1786 * class, altsetting, endpoint, and other descriptors)
1787 * . high speed config ... all descriptors, for high speed operation;
1788 * this one's optional except for high-speed hardware
1789 * . device descriptor
1791 * Endpoints are not yet enabled. Drivers may want to immediately
1792 * initialize them, using the /dev/gadget/ep* files that are available
1793 * as soon as the kernel sees the configuration, or they can wait
1794 * until device configuration and interface altsetting changes create
1795 * the need to configure (or unconfigure) them.
1797 * After initialization, the device stays active for as long as that
1798 * $CHIP file is open. Events may then be read from that descriptor,
1799 * such as configuration notifications. More complex drivers will handle
1800 * some control requests in user space.
1803 static int is_valid_config (struct usb_config_descriptor *config)
1805 return config->bDescriptorType == USB_DT_CONFIG
1806 && config->bLength == USB_DT_CONFIG_SIZE
1807 && config->bConfigurationValue != 0
1808 && (config->bmAttributes & USB_CONFIG_ATT_ONE) != 0
1809 && (config->bmAttributes & USB_CONFIG_ATT_WAKEUP) == 0;
1810 /* FIXME if gadget->is_otg, _must_ include an otg descriptor */
1811 /* FIXME check lengths: walk to end */
1815 dev_config (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
1817 struct dev_data *dev = fd->private_data;
1818 ssize_t value = len, length = len;
1823 if (dev->state != STATE_OPENED)
1826 if (len < (USB_DT_CONFIG_SIZE + USB_DT_DEVICE_SIZE + 4))
1829 /* we might need to change message format someday */
1830 if (copy_from_user (&tag, buf, 4))
1837 kbuf = kmalloc (length, SLAB_KERNEL);
1840 if (copy_from_user (kbuf, buf, length)) {
1845 spin_lock_irq (&dev->lock);
1851 /* full or low speed config */
1852 dev->config = (void *) kbuf;
1853 total = le16_to_cpup (&dev->config->wTotalLength);
1854 if (!is_valid_config (dev->config) || total >= length)
1859 /* optional high speed config */
1860 if (kbuf [1] == USB_DT_CONFIG) {
1861 dev->hs_config = (void *) kbuf;
1862 total = le16_to_cpup (&dev->hs_config->wTotalLength);
1863 if (!is_valid_config (dev->hs_config) || total >= length)
1869 /* could support multiple configs, using another encoding! */
1871 /* device descriptor (tweaked for paranoia) */
1872 if (length != USB_DT_DEVICE_SIZE)
1874 dev->dev = (void *)kbuf;
1875 if (dev->dev->bLength != USB_DT_DEVICE_SIZE
1876 || dev->dev->bDescriptorType != USB_DT_DEVICE
1877 || dev->dev->bNumConfigurations != 1)
1879 dev->dev->bNumConfigurations = 1;
1880 dev->dev->bcdUSB = __constant_cpu_to_le16 (0x0200);
1882 /* triggers gadgetfs_bind(); then we can enumerate. */
1883 spin_unlock_irq (&dev->lock);
1884 value = usb_gadget_register_driver (&gadgetfs_driver);
1889 /* at this point "good" hardware has for the first time
1890 * let the USB the host see us. alternatively, if users
1891 * unplug/replug that will clear all the error state.
1893 * note: everything running before here was guaranteed
1894 * to choke driver model style diagnostics. from here
1895 * on, they can work ... except in cleanup paths that
1896 * kick in after the ep0 descriptor is closed.
1898 fd->f_op = &ep0_io_operations;
1904 spin_unlock_irq (&dev->lock);
1905 pr_debug ("%s: %s fail %Zd, %p\n", shortname, __FUNCTION__, value, dev);
1912 dev_open (struct inode *inode, struct file *fd)
1914 struct dev_data *dev = inode->i_private;
1917 if (dev->state == STATE_DEV_DISABLED) {
1919 dev->state = STATE_OPENED;
1920 fd->private_data = dev;
1927 static struct file_operations dev_init_operations = {
1928 .owner = THIS_MODULE,
1929 .llseek = no_llseek,
1932 .write = dev_config,
1933 .fasync = ep0_fasync,
1935 .release = dev_release,
1938 /*----------------------------------------------------------------------*/
1940 /* FILESYSTEM AND SUPERBLOCK OPERATIONS
1942 * Mounting the filesystem creates a controller file, used first for
1943 * device configuration then later for event monitoring.
1947 /* FIXME PAM etc could set this security policy without mount options
1948 * if epfiles inherited ownership and permissons from ep0 ...
1951 static unsigned default_uid;
1952 static unsigned default_gid;
1953 static unsigned default_perm = S_IRUSR | S_IWUSR;
1955 module_param (default_uid, uint, 0644);
1956 module_param (default_gid, uint, 0644);
1957 module_param (default_perm, uint, 0644);
1960 static struct inode *
1961 gadgetfs_make_inode (struct super_block *sb,
1962 void *data, const struct file_operations *fops,
1965 struct inode *inode = new_inode (sb);
1968 inode->i_mode = mode;
1969 inode->i_uid = default_uid;
1970 inode->i_gid = default_gid;
1971 inode->i_blocks = 0;
1972 inode->i_atime = inode->i_mtime = inode->i_ctime
1974 inode->i_private = data;
1975 inode->i_fop = fops;
1980 /* creates in fs root directory, so non-renamable and non-linkable.
1981 * so inode and dentry are paired, until device reconfig.
1983 static struct inode *
1984 gadgetfs_create_file (struct super_block *sb, char const *name,
1985 void *data, const struct file_operations *fops,
1986 struct dentry **dentry_p)
1988 struct dentry *dentry;
1989 struct inode *inode;
1991 dentry = d_alloc_name(sb->s_root, name);
1995 inode = gadgetfs_make_inode (sb, data, fops,
1996 S_IFREG | (default_perm & S_IRWXUGO));
2001 d_add (dentry, inode);
2006 static struct super_operations gadget_fs_operations = {
2007 .statfs = simple_statfs,
2008 .drop_inode = generic_delete_inode,
2012 gadgetfs_fill_super (struct super_block *sb, void *opts, int silent)
2014 struct inode *inode;
2016 struct dev_data *dev;
2021 /* fake probe to determine $CHIP */
2022 (void) usb_gadget_register_driver (&probe_driver);
2027 sb->s_blocksize = PAGE_CACHE_SIZE;
2028 sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
2029 sb->s_magic = GADGETFS_MAGIC;
2030 sb->s_op = &gadget_fs_operations;
2031 sb->s_time_gran = 1;
2034 inode = gadgetfs_make_inode (sb,
2035 NULL, &simple_dir_operations,
2036 S_IFDIR | S_IRUGO | S_IXUGO);
2039 inode->i_op = &simple_dir_inode_operations;
2040 if (!(d = d_alloc_root (inode)))
2044 /* the ep0 file is named after the controller we expect;
2045 * user mode code can use it for sanity checks, like we do.
2052 if (!gadgetfs_create_file (sb, CHIP,
2053 dev, &dev_init_operations,
2057 /* other endpoint files are available after hardware setup,
2058 * from binding to a controller.
2073 /* "mount -t gadgetfs path /dev/gadget" ends up here */
2075 gadgetfs_get_sb (struct file_system_type *t, int flags,
2076 const char *path, void *opts, struct vfsmount *mnt)
2078 return get_sb_single (t, flags, opts, gadgetfs_fill_super, mnt);
2082 gadgetfs_kill_sb (struct super_block *sb)
2084 kill_litter_super (sb);
2086 put_dev (the_device);
2091 /*----------------------------------------------------------------------*/
2093 static struct file_system_type gadgetfs_type = {
2094 .owner = THIS_MODULE,
2096 .get_sb = gadgetfs_get_sb,
2097 .kill_sb = gadgetfs_kill_sb,
2100 /*----------------------------------------------------------------------*/
2102 static int __init init (void)
2106 status = register_filesystem (&gadgetfs_type);
2108 pr_info ("%s: %s, version " DRIVER_VERSION "\n",
2109 shortname, driver_desc);
2114 static void __exit cleanup (void)
2116 pr_debug ("unregister %s\n", shortname);
2117 unregister_filesystem (&gadgetfs_type);
2119 module_exit (cleanup);