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 = kmalloc (sizeof *dev, GFP_KERNEL);
176 memset (dev, 0, sizeof *dev);
177 dev->state = STATE_DEV_DISABLED;
178 atomic_set (&dev->count, 1);
179 spin_lock_init (&dev->lock);
180 INIT_LIST_HEAD (&dev->epfiles);
181 init_waitqueue_head (&dev->wait);
185 /*----------------------------------------------------------------------*/
187 /* other /dev/gadget/$ENDPOINT files represent endpoints */
189 STATE_EP_DISABLED = 0,
191 STATE_EP_DEFER_ENABLE,
197 struct semaphore lock;
200 struct dev_data *dev;
201 /* must hold dev->lock before accessing ep or req */
203 struct usb_request *req;
206 struct usb_endpoint_descriptor desc, hs_desc;
207 struct list_head epfiles;
208 wait_queue_head_t wait;
209 struct dentry *dentry;
213 static inline void get_ep (struct ep_data *data)
215 atomic_inc (&data->count);
218 static void put_ep (struct ep_data *data)
220 if (likely (!atomic_dec_and_test (&data->count)))
223 /* needs no more cleanup */
224 BUG_ON (!list_empty (&data->epfiles));
225 BUG_ON (waitqueue_active (&data->wait));
226 BUG_ON (down_trylock (&data->lock) != 0);
230 /*----------------------------------------------------------------------*/
232 /* most "how to use the hardware" policy choices are in userspace:
233 * mapping endpoint roles (which the driver needs) to the capabilities
234 * which the usb controller has. most of those capabilities are exposed
235 * implicitly, starting with the driver name and then endpoint names.
238 static const char *CHIP;
240 /*----------------------------------------------------------------------*/
242 /* NOTE: don't use dev_printk calls before binding to the gadget
243 * at the end of ep0 configuration, or after unbind.
246 /* too wordy: dev_printk(level , &(d)->gadget->dev , fmt , ## args) */
247 #define xprintk(d,level,fmt,args...) \
248 printk(level "%s: " fmt , shortname , ## args)
251 #define DBG(dev,fmt,args...) \
252 xprintk(dev , KERN_DEBUG , fmt , ## args)
254 #define DBG(dev,fmt,args...) \
261 #define VDEBUG(dev,fmt,args...) \
265 #define ERROR(dev,fmt,args...) \
266 xprintk(dev , KERN_ERR , fmt , ## args)
267 #define WARN(dev,fmt,args...) \
268 xprintk(dev , KERN_WARNING , fmt , ## args)
269 #define INFO(dev,fmt,args...) \
270 xprintk(dev , KERN_INFO , fmt , ## args)
273 /*----------------------------------------------------------------------*/
275 /* SYNCHRONOUS ENDPOINT OPERATIONS (bulk/intr/iso)
277 * After opening, configure non-control endpoints. Then use normal
278 * stream read() and write() requests; and maybe ioctl() to get more
279 * precise FIFO status when recovering from cancellation.
282 static void epio_complete (struct usb_ep *ep, struct usb_request *req)
284 struct ep_data *epdata = ep->driver_data;
289 epdata->status = req->status;
291 epdata->status = req->actual;
292 complete ((struct completion *)req->context);
295 /* tasklock endpoint, returning when it's connected.
296 * still need dev->lock to use epdata->ep.
299 get_ready_ep (unsigned f_flags, struct ep_data *epdata)
303 if (f_flags & O_NONBLOCK) {
304 if (down_trylock (&epdata->lock) != 0)
306 if (epdata->state != STATE_EP_ENABLED) {
315 if ((val = down_interruptible (&epdata->lock)) < 0)
318 switch (epdata->state) {
319 case STATE_EP_ENABLED:
321 case STATE_EP_DEFER_ENABLE:
322 DBG (epdata->dev, "%s wait for host\n", epdata->name);
323 if ((val = wait_event_interruptible (epdata->wait,
324 epdata->state != STATE_EP_DEFER_ENABLE
325 || epdata->dev->state == STATE_DEV_UNBOUND
329 // case STATE_EP_DISABLED: /* "can't happen" */
330 // case STATE_EP_READY: /* "can't happen" */
331 default: /* error! */
332 pr_debug ("%s: ep %p not available, state %d\n",
333 shortname, epdata, epdata->state);
335 case STATE_EP_UNBOUND: /* clean disconnect */
344 ep_io (struct ep_data *epdata, void *buf, unsigned len)
346 DECLARE_COMPLETION (done);
349 spin_lock_irq (&epdata->dev->lock);
350 if (likely (epdata->ep != NULL)) {
351 struct usb_request *req = epdata->req;
353 req->context = &done;
354 req->complete = epio_complete;
357 value = usb_ep_queue (epdata->ep, req, GFP_ATOMIC);
360 spin_unlock_irq (&epdata->dev->lock);
362 if (likely (value == 0)) {
363 value = wait_event_interruptible (done.wait, done.done);
365 spin_lock_irq (&epdata->dev->lock);
366 if (likely (epdata->ep != NULL)) {
367 DBG (epdata->dev, "%s i/o interrupted\n",
369 usb_ep_dequeue (epdata->ep, epdata->req);
370 spin_unlock_irq (&epdata->dev->lock);
372 wait_event (done.wait, done.done);
373 if (epdata->status == -ECONNRESET)
374 epdata->status = -EINTR;
376 spin_unlock_irq (&epdata->dev->lock);
378 DBG (epdata->dev, "endpoint gone\n");
379 epdata->status = -ENODEV;
382 return epdata->status;
388 /* handle a synchronous OUT bulk/intr/iso transfer */
390 ep_read (struct file *fd, char __user *buf, size_t len, loff_t *ptr)
392 struct ep_data *data = fd->private_data;
396 if ((value = get_ready_ep (fd->f_flags, data)) < 0)
399 /* halt any endpoint by doing a "wrong direction" i/o call */
400 if (data->desc.bEndpointAddress & USB_DIR_IN) {
401 if ((data->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
402 == USB_ENDPOINT_XFER_ISOC)
404 DBG (data->dev, "%s halt\n", data->name);
405 spin_lock_irq (&data->dev->lock);
406 if (likely (data->ep != NULL))
407 usb_ep_set_halt (data->ep);
408 spin_unlock_irq (&data->dev->lock);
413 /* FIXME readahead for O_NONBLOCK and poll(); careful with ZLPs */
416 kbuf = kmalloc (len, SLAB_KERNEL);
417 if (unlikely (!kbuf))
420 value = ep_io (data, kbuf, len);
421 VDEBUG (data->dev, "%s read %zu OUT, status %d\n",
422 data->name, len, (int) value);
423 if (value >= 0 && copy_to_user (buf, kbuf, value))
432 /* handle a synchronous IN bulk/intr/iso transfer */
434 ep_write (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
436 struct ep_data *data = fd->private_data;
440 if ((value = get_ready_ep (fd->f_flags, data)) < 0)
443 /* halt any endpoint by doing a "wrong direction" i/o call */
444 if (!(data->desc.bEndpointAddress & USB_DIR_IN)) {
445 if ((data->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
446 == USB_ENDPOINT_XFER_ISOC)
448 DBG (data->dev, "%s halt\n", data->name);
449 spin_lock_irq (&data->dev->lock);
450 if (likely (data->ep != NULL))
451 usb_ep_set_halt (data->ep);
452 spin_unlock_irq (&data->dev->lock);
457 /* FIXME writebehind for O_NONBLOCK and poll(), qlen = 1 */
460 kbuf = kmalloc (len, SLAB_KERNEL);
463 if (copy_from_user (kbuf, buf, len)) {
468 value = ep_io (data, kbuf, len);
469 VDEBUG (data->dev, "%s write %zu IN, status %d\n",
470 data->name, len, (int) value);
478 ep_release (struct inode *inode, struct file *fd)
480 struct ep_data *data = fd->private_data;
482 /* clean up if this can be reopened */
483 if (data->state != STATE_EP_UNBOUND) {
484 data->state = STATE_EP_DISABLED;
485 data->desc.bDescriptorType = 0;
486 data->hs_desc.bDescriptorType = 0;
487 usb_ep_disable(data->ep);
493 static int ep_ioctl (struct inode *inode, struct file *fd,
494 unsigned code, unsigned long value)
496 struct ep_data *data = fd->private_data;
499 if ((status = get_ready_ep (fd->f_flags, data)) < 0)
502 spin_lock_irq (&data->dev->lock);
503 if (likely (data->ep != NULL)) {
505 case GADGETFS_FIFO_STATUS:
506 status = usb_ep_fifo_status (data->ep);
508 case GADGETFS_FIFO_FLUSH:
509 usb_ep_fifo_flush (data->ep);
511 case GADGETFS_CLEAR_HALT:
512 status = usb_ep_clear_halt (data->ep);
519 spin_unlock_irq (&data->dev->lock);
524 /*----------------------------------------------------------------------*/
526 /* ASYNCHRONOUS ENDPOINT I/O OPERATIONS (bulk/intr/iso) */
529 struct usb_request *req;
530 struct ep_data *epdata;
536 static int ep_aio_cancel(struct kiocb *iocb, struct io_event *e)
538 struct kiocb_priv *priv = iocb->private;
539 struct ep_data *epdata;
543 epdata = priv->epdata;
544 // spin_lock(&epdata->dev->lock);
545 kiocbSetCancelled(iocb);
546 if (likely(epdata && epdata->ep && priv->req))
547 value = usb_ep_dequeue (epdata->ep, priv->req);
550 // spin_unlock(&epdata->dev->lock);
557 static ssize_t ep_aio_read_retry(struct kiocb *iocb)
559 struct kiocb_priv *priv = iocb->private;
560 ssize_t status = priv->actual;
562 /* we "retry" to get the right mm context for this: */
563 status = copy_to_user(priv->ubuf, priv->buf, priv->actual);
564 if (unlikely(0 != status))
567 status = priv->actual;
574 static void ep_aio_complete(struct usb_ep *ep, struct usb_request *req)
576 struct kiocb *iocb = req->context;
577 struct kiocb_priv *priv = iocb->private;
578 struct ep_data *epdata = priv->epdata;
580 /* lock against disconnect (and ideally, cancel) */
581 spin_lock(&epdata->dev->lock);
584 if (NULL == iocb->ki_retry
585 || unlikely(0 == req->actual)
586 || unlikely(kiocbIsCancelled(iocb))) {
589 iocb->private = NULL;
590 /* aio_complete() reports bytes-transferred _and_ faults */
591 if (unlikely(kiocbIsCancelled(iocb)))
595 req->actual ? req->actual : req->status,
598 /* retry() won't report both; so we hide some faults */
599 if (unlikely(0 != req->status))
600 DBG(epdata->dev, "%s fault %d len %d\n",
601 ep->name, req->status, req->actual);
603 priv->buf = req->buf;
604 priv->actual = req->actual;
607 spin_unlock(&epdata->dev->lock);
609 usb_ep_free_request(ep, req);
618 struct ep_data *epdata,
622 struct kiocb_priv *priv = (void *) &iocb->private;
623 struct usb_request *req;
626 priv = kmalloc(sizeof *priv, GFP_KERNEL);
633 iocb->private = priv;
636 value = get_ready_ep(iocb->ki_filp->f_flags, epdata);
637 if (unlikely(value < 0)) {
642 iocb->ki_cancel = ep_aio_cancel;
644 priv->epdata = epdata;
647 /* each kiocb is coupled to one usb_request, but we can't
648 * allocate or submit those if the host disconnected.
650 spin_lock_irq(&epdata->dev->lock);
651 if (likely(epdata->ep)) {
652 req = usb_ep_alloc_request(epdata->ep, GFP_ATOMIC);
657 req->complete = ep_aio_complete;
659 value = usb_ep_queue(epdata->ep, req, GFP_ATOMIC);
660 if (unlikely(0 != value))
661 usb_ep_free_request(epdata->ep, req);
666 spin_unlock_irq(&epdata->dev->lock);
670 if (unlikely(value)) {
674 value = -EIOCBQUEUED;
679 ep_aio_read(struct kiocb *iocb, char __user *ubuf, size_t len, loff_t o)
681 struct ep_data *epdata = iocb->ki_filp->private_data;
684 if (unlikely(epdata->desc.bEndpointAddress & USB_DIR_IN))
686 buf = kmalloc(len, GFP_KERNEL);
689 iocb->ki_retry = ep_aio_read_retry;
690 return ep_aio_rwtail(iocb, buf, len, epdata, ubuf);
694 ep_aio_write(struct kiocb *iocb, const char __user *ubuf, size_t len, loff_t o)
696 struct ep_data *epdata = iocb->ki_filp->private_data;
699 if (unlikely(!(epdata->desc.bEndpointAddress & USB_DIR_IN)))
701 buf = kmalloc(len, GFP_KERNEL);
704 if (unlikely(copy_from_user(buf, ubuf, len) != 0)) {
708 return ep_aio_rwtail(iocb, buf, len, epdata, NULL);
711 /*----------------------------------------------------------------------*/
713 /* used after endpoint configuration */
714 static struct file_operations ep_io_operations = {
715 .owner = THIS_MODULE,
721 .release = ep_release,
723 .aio_read = ep_aio_read,
724 .aio_write = ep_aio_write,
727 /* ENDPOINT INITIALIZATION
729 * fd = open ("/dev/gadget/$ENDPOINT", O_RDWR)
730 * status = write (fd, descriptors, sizeof descriptors)
732 * That write establishes the endpoint configuration, configuring
733 * the controller to process bulk, interrupt, or isochronous transfers
734 * at the right maxpacket size, and so on.
736 * The descriptors are message type 1, identified by a host order u32
737 * at the beginning of what's written. Descriptor order is: full/low
738 * speed descriptor, then optional high speed descriptor.
741 ep_config (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
743 struct ep_data *data = fd->private_data;
748 if ((value = down_interruptible (&data->lock)) < 0)
751 if (data->state != STATE_EP_READY) {
757 if (len < USB_DT_ENDPOINT_SIZE + 4)
760 /* we might need to change message format someday */
761 if (copy_from_user (&tag, buf, 4)) {
765 DBG(data->dev, "config %s, bad tag %d\n", data->name, tag);
771 /* NOTE: audio endpoint extensions not accepted here;
772 * just don't include the extra bytes.
775 /* full/low speed descriptor, then high speed */
776 if (copy_from_user (&data->desc, buf, USB_DT_ENDPOINT_SIZE)) {
779 if (data->desc.bLength != USB_DT_ENDPOINT_SIZE
780 || data->desc.bDescriptorType != USB_DT_ENDPOINT)
782 if (len != USB_DT_ENDPOINT_SIZE) {
783 if (len != 2 * USB_DT_ENDPOINT_SIZE)
785 if (copy_from_user (&data->hs_desc, buf + USB_DT_ENDPOINT_SIZE,
786 USB_DT_ENDPOINT_SIZE)) {
789 if (data->hs_desc.bLength != USB_DT_ENDPOINT_SIZE
790 || data->hs_desc.bDescriptorType
791 != USB_DT_ENDPOINT) {
792 DBG(data->dev, "config %s, bad hs length or type\n",
799 spin_lock_irq (&data->dev->lock);
800 if (data->dev->state == STATE_DEV_UNBOUND) {
803 } else if ((ep = data->ep) == NULL) {
807 switch (data->dev->gadget->speed) {
810 value = usb_ep_enable (ep, &data->desc);
812 data->state = STATE_EP_ENABLED;
816 /* fails if caller didn't provide that descriptor... */
817 value = usb_ep_enable (ep, &data->hs_desc);
819 data->state = STATE_EP_ENABLED;
823 DBG (data->dev, "unconnected, %s init deferred\n",
825 data->state = STATE_EP_DEFER_ENABLE;
828 fd->f_op = &ep_io_operations;
830 spin_unlock_irq (&data->dev->lock);
833 data->desc.bDescriptorType = 0;
834 data->hs_desc.bDescriptorType = 0;
847 ep_open (struct inode *inode, struct file *fd)
849 struct ep_data *data = inode->u.generic_ip;
852 if (down_interruptible (&data->lock) != 0)
854 spin_lock_irq (&data->dev->lock);
855 if (data->dev->state == STATE_DEV_UNBOUND)
857 else if (data->state == STATE_EP_DISABLED) {
859 data->state = STATE_EP_READY;
861 fd->private_data = data;
862 VDEBUG (data->dev, "%s ready\n", data->name);
864 DBG (data->dev, "%s state %d\n",
865 data->name, data->state);
866 spin_unlock_irq (&data->dev->lock);
871 /* used before endpoint configuration */
872 static struct file_operations ep_config_operations = {
873 .owner = THIS_MODULE,
878 .release = ep_release,
881 /*----------------------------------------------------------------------*/
883 /* EP0 IMPLEMENTATION can be partly in userspace.
885 * Drivers that use this facility receive various events, including
886 * control requests the kernel doesn't handle. Drivers that don't
887 * use this facility may be too simple-minded for real applications.
890 static inline void ep0_readable (struct dev_data *dev)
892 wake_up (&dev->wait);
893 kill_fasync (&dev->fasync, SIGIO, POLL_IN);
896 static void clean_req (struct usb_ep *ep, struct usb_request *req)
898 struct dev_data *dev = ep->driver_data;
900 if (req->buf != dev->rbuf) {
901 usb_ep_free_buffer (ep, req->buf, req->dma, req->length);
902 req->buf = dev->rbuf;
903 req->dma = DMA_ADDR_INVALID;
905 req->complete = epio_complete;
906 dev->setup_out_ready = 0;
909 static void ep0_complete (struct usb_ep *ep, struct usb_request *req)
911 struct dev_data *dev = ep->driver_data;
914 /* for control OUT, data must still get to userspace */
915 if (!dev->setup_in) {
916 dev->setup_out_error = (req->status != 0);
917 if (!dev->setup_out_error)
919 dev->setup_out_ready = 1;
921 } else if (dev->state == STATE_SETUP)
922 dev->state = STATE_CONNECTED;
924 /* clean up as appropriate */
925 if (free && req->buf != &dev->rbuf)
927 req->complete = epio_complete;
930 static int setup_req (struct usb_ep *ep, struct usb_request *req, u16 len)
932 struct dev_data *dev = ep->driver_data;
934 if (dev->setup_out_ready) {
935 DBG (dev, "ep0 request busy!\n");
938 if (len > sizeof (dev->rbuf))
939 req->buf = usb_ep_alloc_buffer (ep, len, &req->dma, GFP_ATOMIC);
941 req->buf = dev->rbuf;
944 req->complete = ep0_complete;
951 ep0_read (struct file *fd, char __user *buf, size_t len, loff_t *ptr)
953 struct dev_data *dev = fd->private_data;
955 enum ep0_state state;
957 spin_lock_irq (&dev->lock);
959 /* report fd mode change before acting on it */
960 if (dev->setup_abort) {
961 dev->setup_abort = 0;
966 /* control DATA stage */
967 if ((state = dev->state) == STATE_SETUP) {
969 if (dev->setup_in) { /* stall IN */
970 VDEBUG(dev, "ep0in stall\n");
971 (void) usb_ep_set_halt (dev->gadget->ep0);
973 dev->state = STATE_CONNECTED;
975 } else if (len == 0) { /* ack SET_CONFIGURATION etc */
976 struct usb_ep *ep = dev->gadget->ep0;
977 struct usb_request *req = dev->req;
979 if ((retval = setup_req (ep, req, 0)) == 0)
980 retval = usb_ep_queue (ep, req, GFP_ATOMIC);
981 dev->state = STATE_CONNECTED;
983 /* assume that was SET_CONFIGURATION */
984 if (dev->current_config) {
987 if (dev->gadget->speed == USB_SPEED_HIGH)
988 power = dev->hs_config->bMaxPower;
991 power = dev->config->bMaxPower;
992 usb_gadget_vbus_draw(dev->gadget, 2 * power);
995 } else { /* collect OUT data */
996 if ((fd->f_flags & O_NONBLOCK) != 0
997 && !dev->setup_out_ready) {
1001 spin_unlock_irq (&dev->lock);
1002 retval = wait_event_interruptible (dev->wait,
1003 dev->setup_out_ready != 0);
1005 /* FIXME state could change from under us */
1006 spin_lock_irq (&dev->lock);
1009 if (dev->setup_out_error)
1012 len = min (len, (size_t)dev->req->actual);
1013 // FIXME don't call this with the spinlock held ...
1014 if (copy_to_user (buf, &dev->req->buf, len))
1016 clean_req (dev->gadget->ep0, dev->req);
1017 /* NOTE userspace can't yet choose to stall */
1023 /* else normal: return event data */
1024 if (len < sizeof dev->event [0]) {
1028 len -= len % sizeof (struct usb_gadgetfs_event);
1029 dev->usermode_setup = 1;
1032 /* return queued events right away */
1033 if (dev->ev_next != 0) {
1035 int tmp = dev->ev_next;
1037 len = min (len, tmp * sizeof (struct usb_gadgetfs_event));
1038 n = len / sizeof (struct usb_gadgetfs_event);
1040 /* ep0 can't deliver events when STATE_SETUP */
1041 for (i = 0; i < n; i++) {
1042 if (dev->event [i].type == GADGETFS_SETUP) {
1044 len *= sizeof (struct usb_gadgetfs_event);
1049 spin_unlock_irq (&dev->lock);
1050 if (copy_to_user (buf, &dev->event, len))
1055 len /= sizeof (struct usb_gadgetfs_event);
1057 /* NOTE this doesn't guard against broken drivers;
1058 * concurrent ep0 readers may lose events.
1060 spin_lock_irq (&dev->lock);
1061 dev->ev_next -= len;
1062 if (dev->ev_next != 0)
1063 memmove (&dev->event, &dev->event [len],
1064 sizeof (struct usb_gadgetfs_event)
1067 dev->state = STATE_SETUP;
1068 spin_unlock_irq (&dev->lock);
1072 if (fd->f_flags & O_NONBLOCK) {
1079 DBG (dev, "fail %s, state %d\n", __FUNCTION__, state);
1082 case STATE_UNCONNECTED:
1083 case STATE_CONNECTED:
1084 spin_unlock_irq (&dev->lock);
1085 DBG (dev, "%s wait\n", __FUNCTION__);
1087 /* wait for events */
1088 retval = wait_event_interruptible (dev->wait,
1092 spin_lock_irq (&dev->lock);
1097 spin_unlock_irq (&dev->lock);
1101 static struct usb_gadgetfs_event *
1102 next_event (struct dev_data *dev, enum usb_gadgetfs_event_type type)
1104 struct usb_gadgetfs_event *event;
1108 /* these events purge the queue */
1109 case GADGETFS_DISCONNECT:
1110 if (dev->state == STATE_SETUP)
1111 dev->setup_abort = 1;
1113 case GADGETFS_CONNECT:
1116 case GADGETFS_SETUP: /* previous request timed out */
1117 case GADGETFS_SUSPEND: /* same effect */
1118 /* these events can't be repeated */
1119 for (i = 0; i != dev->ev_next; i++) {
1120 if (dev->event [i].type != type)
1122 DBG (dev, "discard old event %d\n", type);
1124 if (i == dev->ev_next)
1126 /* indices start at zero, for simplicity */
1127 memmove (&dev->event [i], &dev->event [i + 1],
1128 sizeof (struct usb_gadgetfs_event)
1129 * (dev->ev_next - i));
1135 event = &dev->event [dev->ev_next++];
1136 BUG_ON (dev->ev_next > N_EVENT);
1137 VDEBUG (dev, "ev %d, next %d\n", type, dev->ev_next);
1138 memset (event, 0, sizeof *event);
1144 ep0_write (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
1146 struct dev_data *dev = fd->private_data;
1147 ssize_t retval = -ESRCH;
1149 spin_lock_irq (&dev->lock);
1151 /* report fd mode change before acting on it */
1152 if (dev->setup_abort) {
1153 dev->setup_abort = 0;
1156 /* data and/or status stage for control request */
1157 } else if (dev->state == STATE_SETUP) {
1159 /* IN DATA+STATUS caller makes len <= wLength */
1160 if (dev->setup_in) {
1161 retval = setup_req (dev->gadget->ep0, dev->req, len);
1163 spin_unlock_irq (&dev->lock);
1164 if (copy_from_user (dev->req->buf, buf, len))
1167 if (len < dev->setup_wLength)
1169 retval = usb_ep_queue (
1170 dev->gadget->ep0, dev->req,
1174 spin_lock_irq (&dev->lock);
1175 clean_req (dev->gadget->ep0, dev->req);
1176 spin_unlock_irq (&dev->lock);
1183 /* can stall some OUT transfers */
1184 } else if (dev->setup_can_stall) {
1185 VDEBUG(dev, "ep0out stall\n");
1186 (void) usb_ep_set_halt (dev->gadget->ep0);
1188 dev->state = STATE_CONNECTED;
1190 DBG(dev, "bogus ep0out stall!\n");
1193 DBG (dev, "fail %s, state %d\n", __FUNCTION__, dev->state);
1195 spin_unlock_irq (&dev->lock);
1200 ep0_fasync (int f, struct file *fd, int on)
1202 struct dev_data *dev = fd->private_data;
1203 // caller must F_SETOWN before signal delivery happens
1204 VDEBUG (dev, "%s %s\n", __FUNCTION__, on ? "on" : "off");
1205 return fasync_helper (f, fd, on, &dev->fasync);
1208 static struct usb_gadget_driver gadgetfs_driver;
1211 dev_release (struct inode *inode, struct file *fd)
1213 struct dev_data *dev = fd->private_data;
1215 /* closing ep0 === shutdown all */
1217 usb_gadget_unregister_driver (&gadgetfs_driver);
1219 /* at this point "good" hardware has disconnected the
1220 * device from USB; the host won't see it any more.
1221 * alternatively, all host requests will time out.
1224 fasync_helper (-1, fd, 0, &dev->fasync);
1229 /* other endpoints were all decoupled from this device */
1230 dev->state = STATE_DEV_DISABLED;
1234 static int dev_ioctl (struct inode *inode, struct file *fd,
1235 unsigned code, unsigned long value)
1237 struct dev_data *dev = fd->private_data;
1238 struct usb_gadget *gadget = dev->gadget;
1240 if (gadget->ops->ioctl)
1241 return gadget->ops->ioctl (gadget, code, value);
1245 /* used after device configuration */
1246 static struct file_operations ep0_io_operations = {
1247 .owner = THIS_MODULE,
1248 .llseek = no_llseek,
1252 .fasync = ep0_fasync,
1253 // .poll = ep0_poll,
1255 .release = dev_release,
1258 /*----------------------------------------------------------------------*/
1260 /* The in-kernel gadget driver handles most ep0 issues, in particular
1261 * enumerating the single configuration (as provided from user space).
1263 * Unrecognized ep0 requests may be handled in user space.
1267 static void make_qualifier (struct dev_data *dev)
1269 struct usb_qualifier_descriptor qual;
1270 struct usb_device_descriptor *desc;
1272 qual.bLength = sizeof qual;
1273 qual.bDescriptorType = USB_DT_DEVICE_QUALIFIER;
1274 qual.bcdUSB = __constant_cpu_to_le16 (0x0200);
1277 qual.bDeviceClass = desc->bDeviceClass;
1278 qual.bDeviceSubClass = desc->bDeviceSubClass;
1279 qual.bDeviceProtocol = desc->bDeviceProtocol;
1281 /* assumes ep0 uses the same value for both speeds ... */
1282 qual.bMaxPacketSize0 = desc->bMaxPacketSize0;
1284 qual.bNumConfigurations = 1;
1287 memcpy (dev->rbuf, &qual, sizeof qual);
1292 config_buf (struct dev_data *dev, u8 type, unsigned index)
1299 /* only one configuration */
1304 hs = (dev->gadget->speed == USB_SPEED_HIGH);
1305 if (type == USB_DT_OTHER_SPEED_CONFIG)
1308 dev->req->buf = dev->hs_config;
1309 len = le16_to_cpup (&dev->hs_config->wTotalLength);
1313 dev->req->buf = dev->config;
1314 len = le16_to_cpup (&dev->config->wTotalLength);
1316 ((u8 *)dev->req->buf) [1] = type;
1321 gadgetfs_setup (struct usb_gadget *gadget, const struct usb_ctrlrequest *ctrl)
1323 struct dev_data *dev = get_gadget_data (gadget);
1324 struct usb_request *req = dev->req;
1325 int value = -EOPNOTSUPP;
1326 struct usb_gadgetfs_event *event;
1327 u16 w_value = le16_to_cpu(ctrl->wValue);
1328 u16 w_length = le16_to_cpu(ctrl->wLength);
1330 spin_lock (&dev->lock);
1331 dev->setup_abort = 0;
1332 if (dev->state == STATE_UNCONNECTED) {
1334 struct ep_data *data;
1336 dev->state = STATE_CONNECTED;
1337 dev->dev->bMaxPacketSize0 = gadget->ep0->maxpacket;
1340 if (gadget->speed == USB_SPEED_HIGH && dev->hs_config == 0) {
1341 ERROR (dev, "no high speed config??\n");
1344 #endif /* HIGHSPEED */
1346 INFO (dev, "connected\n");
1347 event = next_event (dev, GADGETFS_CONNECT);
1348 event->u.speed = gadget->speed;
1351 list_for_each_entry (ep, &gadget->ep_list, ep_list) {
1352 data = ep->driver_data;
1353 /* ... down_trylock (&data->lock) ... */
1354 if (data->state != STATE_EP_DEFER_ENABLE)
1357 if (gadget->speed == USB_SPEED_HIGH)
1358 value = usb_ep_enable (ep, &data->hs_desc);
1360 #endif /* HIGHSPEED */
1361 value = usb_ep_enable (ep, &data->desc);
1363 ERROR (dev, "deferred %s enable --> %d\n",
1367 data->state = STATE_EP_ENABLED;
1368 wake_up (&data->wait);
1369 DBG (dev, "woke up %s waiters\n", data->name);
1372 /* host may have given up waiting for response. we can miss control
1373 * requests handled lower down (device/endpoint status and features);
1374 * then ep0_{read,write} will report the wrong status. controller
1375 * driver will have aborted pending i/o.
1377 } else if (dev->state == STATE_SETUP)
1378 dev->setup_abort = 1;
1380 req->buf = dev->rbuf;
1381 req->dma = DMA_ADDR_INVALID;
1382 req->context = NULL;
1383 value = -EOPNOTSUPP;
1384 switch (ctrl->bRequest) {
1386 case USB_REQ_GET_DESCRIPTOR:
1387 if (ctrl->bRequestType != USB_DIR_IN)
1389 switch (w_value >> 8) {
1392 value = min (w_length, (u16) sizeof *dev->dev);
1393 req->buf = dev->dev;
1396 case USB_DT_DEVICE_QUALIFIER:
1397 if (!dev->hs_config)
1399 value = min (w_length, (u16)
1400 sizeof (struct usb_qualifier_descriptor));
1401 make_qualifier (dev);
1403 case USB_DT_OTHER_SPEED_CONFIG:
1407 value = config_buf (dev,
1411 value = min (w_length, (u16) value);
1416 default: // all others are errors
1421 /* currently one config, two speeds */
1422 case USB_REQ_SET_CONFIGURATION:
1423 if (ctrl->bRequestType != 0)
1425 if (0 == (u8) w_value) {
1427 dev->current_config = 0;
1428 usb_gadget_vbus_draw(gadget, 8 /* mA */ );
1429 // user mode expected to disable endpoints
1433 if (gadget->speed == USB_SPEED_HIGH) {
1434 config = dev->hs_config->bConfigurationValue;
1435 power = dev->hs_config->bMaxPower;
1439 config = dev->config->bConfigurationValue;
1440 power = dev->config->bMaxPower;
1443 if (config == (u8) w_value) {
1445 dev->current_config = config;
1446 usb_gadget_vbus_draw(gadget, 2 * power);
1450 /* report SET_CONFIGURATION like any other control request,
1451 * except that usermode may not stall this. the next
1452 * request mustn't be allowed start until this finishes:
1453 * endpoints and threads set up, etc.
1455 * NOTE: older PXA hardware (before PXA 255: without UDCCFR)
1456 * has bad/racey automagic that prevents synchronizing here.
1457 * even kernel mode drivers often miss them.
1460 INFO (dev, "configuration #%d\n", dev->current_config);
1461 if (dev->usermode_setup) {
1462 dev->setup_can_stall = 0;
1468 #ifndef CONFIG_USB_GADGETFS_PXA2XX
1469 /* PXA automagically handles this request too */
1470 case USB_REQ_GET_CONFIGURATION:
1471 if (ctrl->bRequestType != 0x80)
1473 *(u8 *)req->buf = dev->current_config;
1474 value = min (w_length, (u16) 1);
1480 VDEBUG (dev, "%s req%02x.%02x v%04x i%04x l%d\n",
1481 dev->usermode_setup ? "delegate" : "fail",
1482 ctrl->bRequestType, ctrl->bRequest,
1483 w_value, le16_to_cpu(ctrl->wIndex), w_length);
1485 /* if there's an ep0 reader, don't stall */
1486 if (dev->usermode_setup) {
1487 dev->setup_can_stall = 1;
1489 dev->setup_in = (ctrl->bRequestType & USB_DIR_IN)
1491 dev->setup_wLength = w_length;
1492 dev->setup_out_ready = 0;
1493 dev->setup_out_error = 0;
1496 /* read DATA stage for OUT right away */
1497 if (unlikely (!dev->setup_in && w_length)) {
1498 value = setup_req (gadget->ep0, dev->req,
1502 value = usb_ep_queue (gadget->ep0, dev->req,
1505 clean_req (gadget->ep0, dev->req);
1509 /* we can't currently stall these */
1510 dev->setup_can_stall = 0;
1513 /* state changes when reader collects event */
1514 event = next_event (dev, GADGETFS_SETUP);
1515 event->u.setup = *ctrl;
1517 spin_unlock (&dev->lock);
1522 /* proceed with data transfer and status phases? */
1523 if (value >= 0 && dev->state != STATE_SETUP) {
1524 req->length = value;
1525 req->zero = value < w_length;
1526 value = usb_ep_queue (gadget->ep0, req, GFP_ATOMIC);
1528 DBG (dev, "ep_queue --> %d\n", value);
1533 /* device stalls when value < 0 */
1534 spin_unlock (&dev->lock);
1538 static void destroy_ep_files (struct dev_data *dev)
1540 struct list_head *entry, *tmp;
1542 DBG (dev, "%s %d\n", __FUNCTION__, dev->state);
1544 /* dev->state must prevent interference */
1546 spin_lock_irq (&dev->lock);
1547 list_for_each_safe (entry, tmp, &dev->epfiles) {
1549 struct inode *parent;
1550 struct dentry *dentry;
1552 /* break link to FS */
1553 ep = list_entry (entry, struct ep_data, epfiles);
1554 list_del_init (&ep->epfiles);
1555 dentry = ep->dentry;
1557 parent = dentry->d_parent->d_inode;
1559 /* break link to controller */
1560 if (ep->state == STATE_EP_ENABLED)
1561 (void) usb_ep_disable (ep->ep);
1562 ep->state = STATE_EP_UNBOUND;
1563 usb_ep_free_request (ep->ep, ep->req);
1565 wake_up (&ep->wait);
1568 spin_unlock_irq (&dev->lock);
1570 /* break link to dcache */
1571 mutex_lock (&parent->i_mutex);
1574 mutex_unlock (&parent->i_mutex);
1576 /* fds may still be open */
1579 spin_unlock_irq (&dev->lock);
1583 static struct inode *
1584 gadgetfs_create_file (struct super_block *sb, char const *name,
1585 void *data, struct file_operations *fops,
1586 struct dentry **dentry_p);
1588 static int activate_ep_files (struct dev_data *dev)
1592 gadget_for_each_ep (ep, dev->gadget) {
1593 struct ep_data *data;
1595 data = kmalloc (sizeof *data, GFP_KERNEL);
1598 memset (data, 0, sizeof data);
1599 data->state = STATE_EP_DISABLED;
1600 init_MUTEX (&data->lock);
1601 init_waitqueue_head (&data->wait);
1603 strncpy (data->name, ep->name, sizeof (data->name) - 1);
1604 atomic_set (&data->count, 1);
1609 ep->driver_data = data;
1611 data->req = usb_ep_alloc_request (ep, GFP_KERNEL);
1615 data->inode = gadgetfs_create_file (dev->sb, data->name,
1616 data, &ep_config_operations,
1622 list_add_tail (&data->epfiles, &dev->epfiles);
1627 DBG (dev, "%s enomem\n", __FUNCTION__);
1628 destroy_ep_files (dev);
1633 gadgetfs_unbind (struct usb_gadget *gadget)
1635 struct dev_data *dev = get_gadget_data (gadget);
1637 DBG (dev, "%s\n", __FUNCTION__);
1639 spin_lock_irq (&dev->lock);
1640 dev->state = STATE_DEV_UNBOUND;
1641 spin_unlock_irq (&dev->lock);
1643 destroy_ep_files (dev);
1644 gadget->ep0->driver_data = NULL;
1645 set_gadget_data (gadget, NULL);
1647 /* we've already been disconnected ... no i/o is active */
1649 usb_ep_free_request (gadget->ep0, dev->req);
1650 DBG (dev, "%s done\n", __FUNCTION__);
1654 static struct dev_data *the_device;
1657 gadgetfs_bind (struct usb_gadget *gadget)
1659 struct dev_data *dev = the_device;
1663 if (0 != strcmp (CHIP, gadget->name)) {
1664 printk (KERN_ERR "%s expected %s controller not %s\n",
1665 shortname, CHIP, gadget->name);
1669 set_gadget_data (gadget, dev);
1670 dev->gadget = gadget;
1671 gadget->ep0->driver_data = dev;
1672 dev->dev->bMaxPacketSize0 = gadget->ep0->maxpacket;
1674 /* preallocate control response and buffer */
1675 dev->req = usb_ep_alloc_request (gadget->ep0, GFP_KERNEL);
1678 dev->req->context = NULL;
1679 dev->req->complete = epio_complete;
1681 if (activate_ep_files (dev) < 0)
1684 INFO (dev, "bound to %s driver\n", gadget->name);
1685 dev->state = STATE_UNCONNECTED;
1690 gadgetfs_unbind (gadget);
1695 gadgetfs_disconnect (struct usb_gadget *gadget)
1697 struct dev_data *dev = get_gadget_data (gadget);
1699 if (dev->state == STATE_UNCONNECTED) {
1700 DBG (dev, "already unconnected\n");
1703 dev->state = STATE_UNCONNECTED;
1705 INFO (dev, "disconnected\n");
1706 spin_lock (&dev->lock);
1707 next_event (dev, GADGETFS_DISCONNECT);
1709 spin_unlock (&dev->lock);
1713 gadgetfs_suspend (struct usb_gadget *gadget)
1715 struct dev_data *dev = get_gadget_data (gadget);
1717 INFO (dev, "suspended from state %d\n", dev->state);
1718 spin_lock (&dev->lock);
1719 switch (dev->state) {
1720 case STATE_SETUP: // VERY odd... host died??
1721 case STATE_CONNECTED:
1722 case STATE_UNCONNECTED:
1723 next_event (dev, GADGETFS_SUSPEND);
1729 spin_unlock (&dev->lock);
1732 static struct usb_gadget_driver gadgetfs_driver = {
1734 .speed = USB_SPEED_HIGH,
1736 .speed = USB_SPEED_FULL,
1738 .function = (char *) driver_desc,
1739 .bind = gadgetfs_bind,
1740 .unbind = gadgetfs_unbind,
1741 .setup = gadgetfs_setup,
1742 .disconnect = gadgetfs_disconnect,
1743 .suspend = gadgetfs_suspend,
1746 .name = (char *) shortname,
1750 /*----------------------------------------------------------------------*/
1752 static void gadgetfs_nop(struct usb_gadget *arg) { }
1754 static int gadgetfs_probe (struct usb_gadget *gadget)
1756 CHIP = gadget->name;
1760 static struct usb_gadget_driver probe_driver = {
1761 .speed = USB_SPEED_HIGH,
1762 .bind = gadgetfs_probe,
1763 .unbind = gadgetfs_nop,
1764 .setup = (void *)gadgetfs_nop,
1765 .disconnect = gadgetfs_nop,
1772 /* DEVICE INITIALIZATION
1774 * fd = open ("/dev/gadget/$CHIP", O_RDWR)
1775 * status = write (fd, descriptors, sizeof descriptors)
1777 * That write establishes the device configuration, so the kernel can
1778 * bind to the controller ... guaranteeing it can handle enumeration
1779 * at all necessary speeds. Descriptor order is:
1781 * . message tag (u32, host order) ... for now, must be zero; it
1782 * would change to support features like multi-config devices
1783 * . full/low speed config ... all wTotalLength bytes (with interface,
1784 * class, altsetting, endpoint, and other descriptors)
1785 * . high speed config ... all descriptors, for high speed operation;
1786 * this one's optional except for high-speed hardware
1787 * . device descriptor
1789 * Endpoints are not yet enabled. Drivers may want to immediately
1790 * initialize them, using the /dev/gadget/ep* files that are available
1791 * as soon as the kernel sees the configuration, or they can wait
1792 * until device configuration and interface altsetting changes create
1793 * the need to configure (or unconfigure) them.
1795 * After initialization, the device stays active for as long as that
1796 * $CHIP file is open. Events may then be read from that descriptor,
1797 * such configuration notifications. More complex drivers will handle
1798 * some control requests in user space.
1801 static int is_valid_config (struct usb_config_descriptor *config)
1803 return config->bDescriptorType == USB_DT_CONFIG
1804 && config->bLength == USB_DT_CONFIG_SIZE
1805 && config->bConfigurationValue != 0
1806 && (config->bmAttributes & USB_CONFIG_ATT_ONE) != 0
1807 && (config->bmAttributes & USB_CONFIG_ATT_WAKEUP) == 0;
1808 /* FIXME if gadget->is_otg, _must_ include an otg descriptor */
1809 /* FIXME check lengths: walk to end */
1813 dev_config (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
1815 struct dev_data *dev = fd->private_data;
1816 ssize_t value = len, length = len;
1821 if (dev->state != STATE_OPENED)
1824 if (len < (USB_DT_CONFIG_SIZE + USB_DT_DEVICE_SIZE + 4))
1827 /* we might need to change message format someday */
1828 if (copy_from_user (&tag, buf, 4))
1835 kbuf = kmalloc (length, SLAB_KERNEL);
1838 if (copy_from_user (kbuf, buf, length)) {
1843 spin_lock_irq (&dev->lock);
1849 /* full or low speed config */
1850 dev->config = (void *) kbuf;
1851 total = le16_to_cpup (&dev->config->wTotalLength);
1852 if (!is_valid_config (dev->config) || total >= length)
1857 /* optional high speed config */
1858 if (kbuf [1] == USB_DT_CONFIG) {
1859 dev->hs_config = (void *) kbuf;
1860 total = le16_to_cpup (&dev->hs_config->wTotalLength);
1861 if (!is_valid_config (dev->hs_config) || total >= length)
1867 /* could support multiple configs, using another encoding! */
1869 /* device descriptor (tweaked for paranoia) */
1870 if (length != USB_DT_DEVICE_SIZE)
1872 dev->dev = (void *)kbuf;
1873 if (dev->dev->bLength != USB_DT_DEVICE_SIZE
1874 || dev->dev->bDescriptorType != USB_DT_DEVICE
1875 || dev->dev->bNumConfigurations != 1)
1877 dev->dev->bNumConfigurations = 1;
1878 dev->dev->bcdUSB = __constant_cpu_to_le16 (0x0200);
1880 /* triggers gadgetfs_bind(); then we can enumerate. */
1881 spin_unlock_irq (&dev->lock);
1882 value = usb_gadget_register_driver (&gadgetfs_driver);
1887 /* at this point "good" hardware has for the first time
1888 * let the USB the host see us. alternatively, if users
1889 * unplug/replug that will clear all the error state.
1891 * note: everything running before here was guaranteed
1892 * to choke driver model style diagnostics. from here
1893 * on, they can work ... except in cleanup paths that
1894 * kick in after the ep0 descriptor is closed.
1896 fd->f_op = &ep0_io_operations;
1902 spin_unlock_irq (&dev->lock);
1903 pr_debug ("%s: %s fail %Zd, %p\n", shortname, __FUNCTION__, value, dev);
1910 dev_open (struct inode *inode, struct file *fd)
1912 struct dev_data *dev = inode->u.generic_ip;
1915 if (dev->state == STATE_DEV_DISABLED) {
1917 dev->state = STATE_OPENED;
1918 fd->private_data = dev;
1925 static struct file_operations dev_init_operations = {
1926 .owner = THIS_MODULE,
1927 .llseek = no_llseek,
1930 .write = dev_config,
1931 .fasync = ep0_fasync,
1933 .release = dev_release,
1936 /*----------------------------------------------------------------------*/
1938 /* FILESYSTEM AND SUPERBLOCK OPERATIONS
1940 * Mounting the filesystem creates a controller file, used first for
1941 * device configuration then later for event monitoring.
1945 /* FIXME PAM etc could set this security policy without mount options
1946 * if epfiles inherited ownership and permissons from ep0 ...
1949 static unsigned default_uid;
1950 static unsigned default_gid;
1951 static unsigned default_perm = S_IRUSR | S_IWUSR;
1953 module_param (default_uid, uint, 0644);
1954 module_param (default_gid, uint, 0644);
1955 module_param (default_perm, uint, 0644);
1958 static struct inode *
1959 gadgetfs_make_inode (struct super_block *sb,
1960 void *data, struct file_operations *fops,
1963 struct inode *inode = new_inode (sb);
1966 inode->i_mode = mode;
1967 inode->i_uid = default_uid;
1968 inode->i_gid = default_gid;
1969 inode->i_blksize = PAGE_CACHE_SIZE;
1970 inode->i_blocks = 0;
1971 inode->i_atime = inode->i_mtime = inode->i_ctime
1973 inode->u.generic_ip = data;
1974 inode->i_fop = fops;
1979 /* creates in fs root directory, so non-renamable and non-linkable.
1980 * so inode and dentry are paired, until device reconfig.
1982 static struct inode *
1983 gadgetfs_create_file (struct super_block *sb, char const *name,
1984 void *data, struct file_operations *fops,
1985 struct dentry **dentry_p)
1987 struct dentry *dentry;
1988 struct inode *inode;
1990 dentry = d_alloc_name(sb->s_root, name);
1994 inode = gadgetfs_make_inode (sb, data, fops,
1995 S_IFREG | (default_perm & S_IRWXUGO));
2000 d_add (dentry, inode);
2005 static struct super_operations gadget_fs_operations = {
2006 .statfs = simple_statfs,
2007 .drop_inode = generic_delete_inode,
2011 gadgetfs_fill_super (struct super_block *sb, void *opts, int silent)
2013 struct inode *inode;
2015 struct dev_data *dev;
2020 /* fake probe to determine $CHIP */
2021 (void) usb_gadget_register_driver (&probe_driver);
2026 sb->s_blocksize = PAGE_CACHE_SIZE;
2027 sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
2028 sb->s_magic = GADGETFS_MAGIC;
2029 sb->s_op = &gadget_fs_operations;
2030 sb->s_time_gran = 1;
2033 inode = gadgetfs_make_inode (sb,
2034 NULL, &simple_dir_operations,
2035 S_IFDIR | S_IRUGO | S_IXUGO);
2038 inode->i_op = &simple_dir_inode_operations;
2039 if (!(d = d_alloc_root (inode))) {
2045 /* the ep0 file is named after the controller we expect;
2046 * user mode code can use it for sanity checks, like we do.
2053 if (!(inode = gadgetfs_create_file (sb, CHIP,
2054 dev, &dev_init_operations,
2060 /* other endpoint files are available after hardware setup,
2061 * from binding to a controller.
2067 /* "mount -t gadgetfs path /dev/gadget" ends up here */
2068 static struct super_block *
2069 gadgetfs_get_sb (struct file_system_type *t, int flags,
2070 const char *path, void *opts)
2072 return get_sb_single (t, flags, opts, gadgetfs_fill_super);
2076 gadgetfs_kill_sb (struct super_block *sb)
2078 kill_litter_super (sb);
2080 put_dev (the_device);
2085 /*----------------------------------------------------------------------*/
2087 static struct file_system_type gadgetfs_type = {
2088 .owner = THIS_MODULE,
2090 .get_sb = gadgetfs_get_sb,
2091 .kill_sb = gadgetfs_kill_sb,
2094 /*----------------------------------------------------------------------*/
2096 static int __init init (void)
2100 status = register_filesystem (&gadgetfs_type);
2102 pr_info ("%s: %s, version " DRIVER_VERSION "\n",
2103 shortname, driver_desc);
2108 static void __exit cleanup (void)
2110 pr_debug ("unregister %s\n", shortname);
2111 unregister_filesystem (&gadgetfs_type);
2113 module_exit (cleanup);