drivers/usb/gadget/inode.c

   1 /*
   2  * inode.c -- user mode filesystem api for usb gadget controllers
   3  *
   4  * Copyright (C) 2003-2004 David Brownell
   5  * Copyright (C) 2003 Agilent Technologies
   6  *
   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.
  11  *
  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.
  16  *
  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
  20  */
  21
  22
  23 /* #define VERBOSE_DEBUG */
  24
  25 #include <linux/init.h>
  26 #include <linux/module.h>
  27 #include <linux/fs.h>
  28 #include <linux/pagemap.h>
  29 #include <linux/uts.h>
  30 #include <linux/wait.h>
  31 #include <linux/compiler.h>
  32 #include <asm/uaccess.h>
  33 #include <linux/slab.h>
  34 #include <linux/poll.h>
  35 #include <linux/smp_lock.h>
  36
  37 #include <linux/device.h>
  38 #include <linux/moduleparam.h>
  39
  40 #include <linux/usb/gadgetfs.h>
  41 #include <linux/usb/gadget.h>
  42
  43
  44 /*
  45  * The gadgetfs API maps each endpoint to a file descriptor so that you
  46  * can use standard synchronous read/write calls for I/O.  There's some
  47  * O_NONBLOCK and O_ASYNC/FASYNC style i/o support.  Example usermode
  48  * drivers show how this works in practice.  You can also use AIO to
  49  * eliminate I/O gaps between requests, to help when streaming data.
  50  *
  51  * Key parts that must be USB-specific are protocols defining how the
  52  * read/write operations relate to the hardware state machines.  There
  53  * are two types of files.  One type is for the device, implementing ep0.
  54  * The other type is for each IN or OUT endpoint.  In both cases, the
  55  * user mode driver must configure the hardware before using it.
  56  *
  57  * - First, dev_config() is called when /dev/gadget/$CHIP is configured
  58  *   (by writing configuration and device descriptors).  Afterwards it
  59  *   may serve as a source of device events, used to handle all control
  60  *   requests other than basic enumeration.
  61  *
  62  * - Then, after a SET_CONFIGURATION control request, ep_config() is
  63  *   called when each /dev/gadget/ep* file is configured (by writing
  64  *   endpoint descriptors).  Afterwards these files are used to write()
  65  *   IN data or to read() OUT data.  To halt the endpoint, a "wrong
  66  *   direction" request is issued (like reading an IN endpoint).
  67  *
  68  * Unlike "usbfs" the only ioctl()s are for things that are rare, and maybe
  69  * not possible on all hardware.  For example, precise fault handling with
  70  * respect to data left in endpoint fifos after aborted operations; or
  71  * selective clearing of endpoint halts, to implement SET_INTERFACE.
  72  */
  73
  74 #define DRIVER_DESC     "USB Gadget filesystem"
  75 #define DRIVER_VERSION  "24 Aug 2004"
  76
  77 static const char driver_desc [] = DRIVER_DESC;
  78 static const char shortname [] = "gadgetfs";
  79
  80 MODULE_DESCRIPTION (DRIVER_DESC);
  81 MODULE_AUTHOR ("David Brownell");
  82 MODULE_LICENSE ("GPL");
  83
  84
  85 /*----------------------------------------------------------------------*/
  86
  87 #define GADGETFS_MAGIC          0xaee71ee7
  88 #define DMA_ADDR_INVALID        (~(dma_addr_t)0)
  89
  90 /* /dev/gadget/$CHIP represents ep0 and the whole device */
  91 enum ep0_state {
  92         /* DISBLED is the initial state.
  93          */
  94         STATE_DEV_DISABLED = 0,
  95
  96         /* Only one open() of /dev/gadget/$CHIP; only one file tracks
  97          * ep0/device i/o modes and binding to the controller.  Driver
  98          * must always write descriptors to initialize the device, then
  99          * the device becomes UNCONNECTED until enumeration.
 100          */
 101         STATE_DEV_OPENED,
 102
 103         /* From then on, ep0 fd is in either of two basic modes:
 104          * - (UN)CONNECTED: read usb_gadgetfs_event(s) from it
 105          * - SETUP: read/write will transfer control data and succeed;
 106          *   or if "wrong direction", performs protocol stall
 107          */
 108         STATE_DEV_UNCONNECTED,
 109         STATE_DEV_CONNECTED,
 110         STATE_DEV_SETUP,
 111
 112         /* UNBOUND means the driver closed ep0, so the device won't be
 113          * accessible again (DEV_DISABLED) until all fds are closed.
 114          */
 115         STATE_DEV_UNBOUND,
 116 };
 117
 118 /* enough for the whole queue: most events invalidate others */
 119 #define N_EVENT                 5
 120
 121 struct dev_data {
 122         spinlock_t                      lock;
 123         atomic_t                        count;
 124         enum ep0_state                  state;          /* P: lock */
 125         struct usb_gadgetfs_event       event [N_EVENT];
 126         unsigned                        ev_next;
 127         struct fasync_struct            *fasync;
 128         u8                              current_config;
 129
 130         /* drivers reading ep0 MUST handle control requests (SETUP)
 131          * reported that way; else the host will time out.
 132          */
 133         unsigned                        usermode_setup : 1,
 134                                         setup_in : 1,
 135                                         setup_can_stall : 1,
 136                                         setup_out_ready : 1,
 137                                         setup_out_error : 1,
 138                                         setup_abort : 1;
 139         unsigned                        setup_wLength;
 140
 141         /* the rest is basically write-once */
 142         struct usb_config_descriptor    *config, *hs_config;
 143         struct usb_device_descriptor    *dev;
 144         struct usb_request              *req;
 145         struct usb_gadget               *gadget;
 146         struct list_head                epfiles;
 147         void                            *buf;
 148         wait_queue_head_t               wait;
 149         struct super_block              *sb;
 150         struct dentry                   *dentry;
 151
 152         /* except this scratch i/o buffer for ep0 */
 153         u8                              rbuf [256];
 154 };
 155
 156 static inline void get_dev (struct dev_data *data)
 157 {
 158         atomic_inc (&data->count);
 159 }
 160
 161 static void put_dev (struct dev_data *data)
 162 {
 163         if (likely (!atomic_dec_and_test (&data->count)))
 164                 return;
 165         /* needs no more cleanup */
 166         BUG_ON (waitqueue_active (&data->wait));
 167         kfree (data);
 168 }
 169
 170 static struct dev_data *dev_new (void)
 171 {
 172         struct dev_data         *dev;
 173
 174         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
 175         if (!dev)
 176                 return NULL;
 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);
 182         return dev;
 183 }
 184
 185 /*----------------------------------------------------------------------*/
 186
 187 /* other /dev/gadget/$ENDPOINT files represent endpoints */
 188 enum ep_state {
 189         STATE_EP_DISABLED = 0,
 190         STATE_EP_READY,
 191         STATE_EP_ENABLED,
 192         STATE_EP_UNBOUND,
 193 };
 194
 195 struct ep_data {
 196         struct semaphore                lock;
 197         enum ep_state                   state;
 198         atomic_t                        count;
 199         struct dev_data                 *dev;
 200         /* must hold dev->lock before accessing ep or req */
 201         struct usb_ep                   *ep;
 202         struct usb_request              *req;
 203         ssize_t                         status;
 204         char                            name [16];
 205         struct usb_endpoint_descriptor  desc, hs_desc;
 206         struct list_head                epfiles;
 207         wait_queue_head_t               wait;
 208         struct dentry                   *dentry;
 209         struct inode                    *inode;
 210 };
 211
 212 static inline void get_ep (struct ep_data *data)
 213 {
 214         atomic_inc (&data->count);
 215 }
 216
 217 static void put_ep (struct ep_data *data)
 218 {
 219         if (likely (!atomic_dec_and_test (&data->count)))
 220                 return;
 221         put_dev (data->dev);
 222         /* needs no more cleanup */
 223         BUG_ON (!list_empty (&data->epfiles));
 224         BUG_ON (waitqueue_active (&data->wait));
 225         kfree (data);
 226 }
 227
 228 /*----------------------------------------------------------------------*/
 229
 230 /* most "how to use the hardware" policy choices are in userspace:
 231  * mapping endpoint roles (which the driver needs) to the capabilities
 232  * which the usb controller has.  most of those capabilities are exposed
 233  * implicitly, starting with the driver name and then endpoint names.
 234  */
 235
 236 static const char *CHIP;
 237
 238 /*----------------------------------------------------------------------*/
 239
 240 /* NOTE:  don't use dev_printk calls before binding to the gadget
 241  * at the end of ep0 configuration, or after unbind.
 242  */
 243
 244 /* too wordy: dev_printk(level , &(d)->gadget->dev , fmt , ## args) */
 245 #define xprintk(d,level,fmt,args...) \
 246         printk(level "%s: " fmt , shortname , ## args)
 247
 248 #ifdef DEBUG
 249 #define DBG(dev,fmt,args...) \
 250         xprintk(dev , KERN_DEBUG , fmt , ## args)
 251 #else
 252 #define DBG(dev,fmt,args...) \
 253         do { } while (0)
 254 #endif /* DEBUG */
 255
 256 #ifdef VERBOSE_DEBUG
 257 #define VDEBUG  DBG
 258 #else
 259 #define VDEBUG(dev,fmt,args...) \
 260         do { } while (0)
 261 #endif /* DEBUG */
 262
 263 #define ERROR(dev,fmt,args...) \
 264         xprintk(dev , KERN_ERR , fmt , ## args)
 265 #define INFO(dev,fmt,args...) \
 266         xprintk(dev , KERN_INFO , fmt , ## args)
 267
 268
 269 /*----------------------------------------------------------------------*/
 270
 271 /* SYNCHRONOUS ENDPOINT OPERATIONS (bulk/intr/iso)
 272  *
 273  * After opening, configure non-control endpoints.  Then use normal
 274  * stream read() and write() requests; and maybe ioctl() to get more
 275  * precise FIFO status when recovering from cancellation.
 276  */
 277
 278 static void epio_complete (struct usb_ep *ep, struct usb_request *req)
 279 {
 280         struct ep_data  *epdata = ep->driver_data;
 281
 282         if (!req->context)
 283                 return;
 284         if (req->status)
 285                 epdata->status = req->status;
 286         else
 287                 epdata->status = req->actual;
 288         complete ((struct completion *)req->context);
 289 }
 290
 291 /* tasklock endpoint, returning when it's connected.
 292  * still need dev->lock to use epdata->ep.
 293  */
 294 static int
 295 get_ready_ep (unsigned f_flags, struct ep_data *epdata)
 296 {
 297         int     val;
 298
 299         if (f_flags & O_NONBLOCK) {
 300                 if (down_trylock (&epdata->lock) != 0)
 301                         goto nonblock;
 302                 if (epdata->state != STATE_EP_ENABLED) {
 303                         up (&epdata->lock);
 304 nonblock:
 305                         val = -EAGAIN;
 306                 } else
 307                         val = 0;
 308                 return val;
 309         }
 310
 311         if ((val = down_interruptible (&epdata->lock)) < 0)
 312                 return val;
 313
 314         switch (epdata->state) {
 315         case STATE_EP_ENABLED:
 316                 break;
 317         // case STATE_EP_DISABLED:              /* "can't happen" */
 318         // case STATE_EP_READY:                 /* "can't happen" */
 319         default:                                /* error! */
 320                 pr_debug ("%s: ep %p not available, state %d\n",
 321                                 shortname, epdata, epdata->state);
 322                 // FALLTHROUGH
 323         case STATE_EP_UNBOUND:                  /* clean disconnect */
 324                 val = -ENODEV;
 325                 up (&epdata->lock);
 326         }
 327         return val;
 328 }
 329
 330 static ssize_t
 331 ep_io (struct ep_data *epdata, void *buf, unsigned len)
 332 {
 333         DECLARE_COMPLETION_ONSTACK (done);
 334         int value;
 335
 336         spin_lock_irq (&epdata->dev->lock);
 337         if (likely (epdata->ep != NULL)) {
 338                 struct usb_request      *req = epdata->req;
 339
 340                 req->context = &done;
 341                 req->complete = epio_complete;
 342                 req->buf = buf;
 343                 req->length = len;
 344                 value = usb_ep_queue (epdata->ep, req, GFP_ATOMIC);
 345         } else
 346                 value = -ENODEV;
 347         spin_unlock_irq (&epdata->dev->lock);
 348
 349         if (likely (value == 0)) {
 350                 value = wait_event_interruptible (done.wait, done.done);
 351                 if (value != 0) {
 352                         spin_lock_irq (&epdata->dev->lock);
 353                         if (likely (epdata->ep != NULL)) {
 354                                 DBG (epdata->dev, "%s i/o interrupted\n",
 355                                                 epdata->name);
 356                                 usb_ep_dequeue (epdata->ep, epdata->req);
 357                                 spin_unlock_irq (&epdata->dev->lock);
 358
 359                                 wait_event (done.wait, done.done);
 360                                 if (epdata->status == -ECONNRESET)
 361                                         epdata->status = -EINTR;
 362                         } else {
 363                                 spin_unlock_irq (&epdata->dev->lock);
 364
 365                                 DBG (epdata->dev, "endpoint gone\n");
 366                                 epdata->status = -ENODEV;
 367                         }
 368                 }
 369                 return epdata->status;
 370         }
 371         return value;
 372 }
 373
 374
 375 /* handle a synchronous OUT bulk/intr/iso transfer */
 376 static ssize_t
 377 ep_read (struct file *fd, char __user *buf, size_t len, loff_t *ptr)
 378 {
 379         struct ep_data          *data = fd->private_data;
 380         void                    *kbuf;
 381         ssize_t                 value;
 382
 383         if ((value = get_ready_ep (fd->f_flags, data)) < 0)
 384                 return value;
 385
 386         /* halt any endpoint by doing a "wrong direction" i/o call */
 387         if (data->desc.bEndpointAddress & USB_DIR_IN) {
 388                 if ((data->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
 389                                 == USB_ENDPOINT_XFER_ISOC)
 390                         return -EINVAL;
 391                 DBG (data->dev, "%s halt\n", data->name);
 392                 spin_lock_irq (&data->dev->lock);
 393                 if (likely (data->ep != NULL))
 394                         usb_ep_set_halt (data->ep);
 395                 spin_unlock_irq (&data->dev->lock);
 396                 up (&data->lock);
 397                 return -EBADMSG;
 398         }
 399
 400         /* FIXME readahead for O_NONBLOCK and poll(); careful with ZLPs */
 401
 402         value = -ENOMEM;
 403         kbuf = kmalloc (len, GFP_KERNEL);
 404         if (unlikely (!kbuf))
 405                 goto free1;
 406
 407         value = ep_io (data, kbuf, len);
 408         VDEBUG (data->dev, "%s read %zu OUT, status %d\n",
 409                 data->name, len, (int) value);
 410         if (value >= 0 && copy_to_user (buf, kbuf, value))
 411                 value = -EFAULT;
 412
 413 free1:
 414         up (&data->lock);
 415         kfree (kbuf);
 416         return value;
 417 }
 418
 419 /* handle a synchronous IN bulk/intr/iso transfer */
 420 static ssize_t
 421 ep_write (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
 422 {
 423         struct ep_data          *data = fd->private_data;
 424         void                    *kbuf;
 425         ssize_t                 value;
 426
 427         if ((value = get_ready_ep (fd->f_flags, data)) < 0)
 428                 return value;
 429
 430         /* halt any endpoint by doing a "wrong direction" i/o call */
 431         if (!(data->desc.bEndpointAddress & USB_DIR_IN)) {
 432                 if ((data->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
 433                                 == USB_ENDPOINT_XFER_ISOC)
 434                         return -EINVAL;
 435                 DBG (data->dev, "%s halt\n", data->name);
 436                 spin_lock_irq (&data->dev->lock);
 437                 if (likely (data->ep != NULL))
 438                         usb_ep_set_halt (data->ep);
 439                 spin_unlock_irq (&data->dev->lock);
 440                 up (&data->lock);
 441                 return -EBADMSG;
 442         }
 443
 444         /* FIXME writebehind for O_NONBLOCK and poll(), qlen = 1 */
 445
 446         value = -ENOMEM;
 447         kbuf = kmalloc (len, GFP_KERNEL);
 448         if (!kbuf)
 449                 goto free1;
 450         if (copy_from_user (kbuf, buf, len)) {
 451                 value = -EFAULT;
 452                 goto free1;
 453         }
 454
 455         value = ep_io (data, kbuf, len);
 456         VDEBUG (data->dev, "%s write %zu IN, status %d\n",
 457                 data->name, len, (int) value);
 458 free1:
 459         up (&data->lock);
 460         kfree (kbuf);
 461         return value;
 462 }
 463
 464 static int
 465 ep_release (struct inode *inode, struct file *fd)
 466 {
 467         struct ep_data          *data = fd->private_data;
 468         int value;
 469
 470         if ((value = down_interruptible(&data->lock)) < 0)
 471                 return value;
 472
 473         /* clean up if this can be reopened */
 474         if (data->state != STATE_EP_UNBOUND) {
 475                 data->state = STATE_EP_DISABLED;
 476                 data->desc.bDescriptorType = 0;
 477                 data->hs_desc.bDescriptorType = 0;
 478                 usb_ep_disable(data->ep);
 479         }
 480         up (&data->lock);
 481         put_ep (data);
 482         return 0;
 483 }
 484
 485 static long ep_ioctl(struct file *fd, unsigned code, unsigned long value)
 486 {
 487         struct ep_data          *data = fd->private_data;
 488         int                     status;
 489
 490         if ((status = get_ready_ep (fd->f_flags, data)) < 0)
 491                 return status;
 492
 493         spin_lock_irq (&data->dev->lock);
 494         if (likely (data->ep != NULL)) {
 495                 switch (code) {
 496                 case GADGETFS_FIFO_STATUS:
 497                         status = usb_ep_fifo_status (data->ep);
 498                         break;
 499                 case GADGETFS_FIFO_FLUSH:
 500                         usb_ep_fifo_flush (data->ep);
 501                         break;
 502                 case GADGETFS_CLEAR_HALT:
 503                         status = usb_ep_clear_halt (data->ep);
 504                         break;
 505                 default:
 506                         status = -ENOTTY;
 507                 }
 508         } else
 509                 status = -ENODEV;
 510         spin_unlock_irq (&data->dev->lock);
 511         up (&data->lock);
 512         return status;
 513 }
 514
 515 /*----------------------------------------------------------------------*/
 516
 517 /* ASYNCHRONOUS ENDPOINT I/O OPERATIONS (bulk/intr/iso) */
 518
 519 struct kiocb_priv {
 520         struct usb_request      *req;
 521         struct ep_data          *epdata;
 522         void                    *buf;
 523         const struct iovec      *iv;
 524         unsigned long           nr_segs;
 525         unsigned                actual;
 526 };
 527
 528 static int ep_aio_cancel(struct kiocb *iocb, struct io_event *e)
 529 {
 530         struct kiocb_priv       *priv = iocb->private;
 531         struct ep_data          *epdata;
 532         int                     value;
 533
 534         local_irq_disable();
 535         epdata = priv->epdata;
 536         // spin_lock(&epdata->dev->lock);
 537         kiocbSetCancelled(iocb);
 538         if (likely(epdata && epdata->ep && priv->req))
 539                 value = usb_ep_dequeue (epdata->ep, priv->req);
 540         else
 541                 value = -EINVAL;
 542         // spin_unlock(&epdata->dev->lock);
 543         local_irq_enable();
 544
 545         aio_put_req(iocb);
 546         return value;
 547 }
 548
 549 static ssize_t ep_aio_read_retry(struct kiocb *iocb)
 550 {
 551         struct kiocb_priv       *priv = iocb->private;
 552         ssize_t                 len, total;
 553         void                    *to_copy;
 554         int                     i;
 555
 556         /* we "retry" to get the right mm context for this: */
 557
 558         /* copy stuff into user buffers */
 559         total = priv->actual;
 560         len = 0;
 561         to_copy = priv->buf;
 562         for (i=0; i < priv->nr_segs; i++) {
 563                 ssize_t this = min((ssize_t)(priv->iv[i].iov_len), total);
 564
 565                 if (copy_to_user(priv->iv[i].iov_base, to_copy, this)) {
 566                         if (len == 0)
 567                                 len = -EFAULT;
 568                         break;
 569                 }
 570
 571                 total -= this;
 572                 len += this;
 573                 to_copy += this;
 574                 if (total == 0)
 575                         break;
 576         }
 577         kfree(priv->buf);
 578         kfree(priv);
 579         return len;
 580 }
 581
 582 static void ep_aio_complete(struct usb_ep *ep, struct usb_request *req)
 583 {
 584         struct kiocb            *iocb = req->context;
 585         struct kiocb_priv       *priv = iocb->private;
 586         struct ep_data          *epdata = priv->epdata;
 587
 588         /* lock against disconnect (and ideally, cancel) */
 589         spin_lock(&epdata->dev->lock);
 590         priv->req = NULL;
 591         priv->epdata = NULL;
 592
 593         /* if this was a write or a read returning no data then we
 594          * don't need to copy anything to userspace, so we can
 595          * complete the aio request immediately.
 596          */
 597         if (priv->iv == NULL || unlikely(req->actual == 0)) {
 598                 kfree(req->buf);
 599                 kfree(priv);
 600                 iocb->private = NULL;
 601                 /* aio_complete() reports bytes-transferred _and_ faults */
 602                 aio_complete(iocb, req->actual ? req->actual : req->status,
 603                                 req->status);
 604         } else {
 605                 /* retry() won't report both; so we hide some faults */
 606                 if (unlikely(0 != req->status))
 607                         DBG(epdata->dev, "%s fault %d len %d\n",
 608                                 ep->name, req->status, req->actual);
 609
 610                 priv->buf = req->buf;
 611                 priv->actual = req->actual;
 612                 kick_iocb(iocb);
 613         }
 614         spin_unlock(&epdata->dev->lock);
 615
 616         usb_ep_free_request(ep, req);
 617         put_ep(epdata);
 618 }
 619
 620 static ssize_t
 621 ep_aio_rwtail(
 622         struct kiocb    *iocb,
 623         char            *buf,
 624         size_t          len,
 625         struct ep_data  *epdata,
 626         const struct iovec *iv,
 627         unsigned long   nr_segs
 628 )
 629 {
 630         struct kiocb_priv       *priv;
 631         struct usb_request      *req;
 632         ssize_t                 value;
 633
 634         priv = kmalloc(sizeof *priv, GFP_KERNEL);
 635         if (!priv) {
 636                 value = -ENOMEM;
 637 fail:
 638                 kfree(buf);
 639                 return value;
 640         }
 641         iocb->private = priv;
 642         priv->iv = iv;
 643         priv->nr_segs = nr_segs;
 644
 645         value = get_ready_ep(iocb->ki_filp->f_flags, epdata);
 646         if (unlikely(value < 0)) {
 647                 kfree(priv);
 648                 goto fail;
 649         }
 650
 651         iocb->ki_cancel = ep_aio_cancel;
 652         get_ep(epdata);
 653         priv->epdata = epdata;
 654         priv->actual = 0;
 655
 656         /* each kiocb is coupled to one usb_request, but we can't
 657          * allocate or submit those if the host disconnected.
 658          */
 659         spin_lock_irq(&epdata->dev->lock);
 660         if (likely(epdata->ep)) {
 661                 req = usb_ep_alloc_request(epdata->ep, GFP_ATOMIC);
 662                 if (likely(req)) {
 663                         priv->req = req;
 664                         req->buf = buf;
 665                         req->length = len;
 666                         req->complete = ep_aio_complete;
 667                         req->context = iocb;
 668                         value = usb_ep_queue(epdata->ep, req, GFP_ATOMIC);
 669                         if (unlikely(0 != value))
 670                                 usb_ep_free_request(epdata->ep, req);
 671                 } else
 672                         value = -EAGAIN;
 673         } else
 674                 value = -ENODEV;
 675         spin_unlock_irq(&epdata->dev->lock);
 676
 677         up(&epdata->lock);
 678
 679         if (unlikely(value)) {
 680                 kfree(priv);
 681                 put_ep(epdata);
 682         } else
 683                 value = (iv ? -EIOCBRETRY : -EIOCBQUEUED);
 684         return value;
 685 }
 686
 687 static ssize_t
 688 ep_aio_read(struct kiocb *iocb, const struct iovec *iov,
 689                 unsigned long nr_segs, loff_t o)
 690 {
 691         struct ep_data          *epdata = iocb->ki_filp->private_data;
 692         char                    *buf;
 693
 694         if (unlikely(epdata->desc.bEndpointAddress & USB_DIR_IN))
 695                 return -EINVAL;
 696
 697         buf = kmalloc(iocb->ki_left, GFP_KERNEL);
 698         if (unlikely(!buf))
 699                 return -ENOMEM;
 700
 701         iocb->ki_retry = ep_aio_read_retry;
 702         return ep_aio_rwtail(iocb, buf, iocb->ki_left, epdata, iov, nr_segs);
 703 }
 704
 705 static ssize_t
 706 ep_aio_write(struct kiocb *iocb, const struct iovec *iov,
 707                 unsigned long nr_segs, loff_t o)
 708 {
 709         struct ep_data          *epdata = iocb->ki_filp->private_data;
 710         char                    *buf;
 711         size_t                  len = 0;
 712         int                     i = 0;
 713
 714         if (unlikely(!(epdata->desc.bEndpointAddress & USB_DIR_IN)))
 715                 return -EINVAL;
 716
 717         buf = kmalloc(iocb->ki_left, GFP_KERNEL);
 718         if (unlikely(!buf))
 719                 return -ENOMEM;
 720
 721         for (i=0; i < nr_segs; i++) {
 722                 if (unlikely(copy_from_user(&buf[len], iov[i].iov_base,
 723                                 iov[i].iov_len) != 0)) {
 724                         kfree(buf);
 725                         return -EFAULT;
 726                 }
 727                 len += iov[i].iov_len;
 728         }
 729         return ep_aio_rwtail(iocb, buf, len, epdata, NULL, 0);
 730 }
 731
 732 /*----------------------------------------------------------------------*/
 733
 734 /* used after endpoint configuration */
 735 static const struct file_operations ep_io_operations = {
 736         .owner =        THIS_MODULE,
 737         .llseek =       no_llseek,
 738
 739         .read =         ep_read,
 740         .write =        ep_write,
 741         .unlocked_ioctl = ep_ioctl,
 742         .release =      ep_release,
 743
 744         .aio_read =     ep_aio_read,
 745         .aio_write =    ep_aio_write,
 746 };
 747
 748 /* ENDPOINT INITIALIZATION
 749  *
 750  *     fd = open ("/dev/gadget/$ENDPOINT", O_RDWR)
 751  *     status = write (fd, descriptors, sizeof descriptors)
 752  *
 753  * That write establishes the endpoint configuration, configuring
 754  * the controller to process bulk, interrupt, or isochronous transfers
 755  * at the right maxpacket size, and so on.
 756  *
 757  * The descriptors are message type 1, identified by a host order u32
 758  * at the beginning of what's written.  Descriptor order is: full/low
 759  * speed descriptor, then optional high speed descriptor.
 760  */
 761 static ssize_t
 762 ep_config (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
 763 {
 764         struct ep_data          *data = fd->private_data;
 765         struct usb_ep           *ep;
 766         u32                     tag;
 767         int                     value, length = len;
 768
 769         if ((value = down_interruptible (&data->lock)) < 0)
 770                 return value;
 771
 772         if (data->state != STATE_EP_READY) {
 773                 value = -EL2HLT;
 774                 goto fail;
 775         }
 776
 777         value = len;
 778         if (len < USB_DT_ENDPOINT_SIZE + 4)
 779                 goto fail0;
 780
 781         /* we might need to change message format someday */
 782         if (copy_from_user (&tag, buf, 4)) {
 783                 goto fail1;
 784         }
 785         if (tag != 1) {
 786                 DBG(data->dev, "config %s, bad tag %d\n", data->name, tag);
 787                 goto fail0;
 788         }
 789         buf += 4;
 790         len -= 4;
 791
 792         /* NOTE:  audio endpoint extensions not accepted here;
 793          * just don't include the extra bytes.
 794          */
 795
 796         /* full/low speed descriptor, then high speed */
 797         if (copy_from_user (&data->desc, buf, USB_DT_ENDPOINT_SIZE)) {
 798                 goto fail1;
 799         }
 800         if (data->desc.bLength != USB_DT_ENDPOINT_SIZE
 801                         || data->desc.bDescriptorType != USB_DT_ENDPOINT)
 802                 goto fail0;
 803         if (len != USB_DT_ENDPOINT_SIZE) {
 804                 if (len != 2 * USB_DT_ENDPOINT_SIZE)
 805                         goto fail0;
 806                 if (copy_from_user (&data->hs_desc, buf + USB_DT_ENDPOINT_SIZE,
 807                                         USB_DT_ENDPOINT_SIZE)) {
 808                         goto fail1;
 809                 }
 810                 if (data->hs_desc.bLength != USB_DT_ENDPOINT_SIZE
 811                                 || data->hs_desc.bDescriptorType
 812                                         != USB_DT_ENDPOINT) {
 813                         DBG(data->dev, "config %s, bad hs length or type\n",
 814                                         data->name);
 815                         goto fail0;
 816                 }
 817         }
 818
 819         spin_lock_irq (&data->dev->lock);
 820         if (data->dev->state == STATE_DEV_UNBOUND) {
 821                 value = -ENOENT;
 822                 goto gone;
 823         } else if ((ep = data->ep) == NULL) {
 824                 value = -ENODEV;
 825                 goto gone;
 826         }
 827         switch (data->dev->gadget->speed) {
 828         case USB_SPEED_LOW:
 829         case USB_SPEED_FULL:
 830                 value = usb_ep_enable (ep, &data->desc);
 831                 if (value == 0)
 832                         data->state = STATE_EP_ENABLED;
 833                 break;
 834 #ifdef  CONFIG_USB_GADGET_DUALSPEED
 835         case USB_SPEED_HIGH:
 836                 /* fails if caller didn't provide that descriptor... */
 837                 value = usb_ep_enable (ep, &data->hs_desc);
 838                 if (value == 0)
 839                         data->state = STATE_EP_ENABLED;
 840                 break;
 841 #endif
 842         default:
 843                 DBG(data->dev, "unconnected, %s init abandoned\n",
 844                                 data->name);
 845                 value = -EINVAL;
 846         }
 847         if (value == 0) {
 848                 fd->f_op = &ep_io_operations;
 849                 value = length;
 850         }
 851 gone:
 852         spin_unlock_irq (&data->dev->lock);
 853         if (value < 0) {
 854 fail:
 855                 data->desc.bDescriptorType = 0;
 856                 data->hs_desc.bDescriptorType = 0;
 857         }
 858         up (&data->lock);
 859         return value;
 860 fail0:
 861         value = -EINVAL;
 862         goto fail;
 863 fail1:
 864         value = -EFAULT;
 865         goto fail;
 866 }
 867
 868 static int
 869 ep_open (struct inode *inode, struct file *fd)
 870 {
 871         struct ep_data          *data = inode->i_private;
 872         int                     value = -EBUSY;
 873
 874         if (down_interruptible (&data->lock) != 0)
 875                 return -EINTR;
 876         spin_lock_irq (&data->dev->lock);
 877         if (data->dev->state == STATE_DEV_UNBOUND)
 878                 value = -ENOENT;
 879         else if (data->state == STATE_EP_DISABLED) {
 880                 value = 0;
 881                 data->state = STATE_EP_READY;
 882                 get_ep (data);
 883                 fd->private_data = data;
 884                 VDEBUG (data->dev, "%s ready\n", data->name);
 885         } else
 886                 DBG (data->dev, "%s state %d\n",
 887                         data->name, data->state);
 888         spin_unlock_irq (&data->dev->lock);
 889         up (&data->lock);
 890         return value;
 891 }
 892
 893 /* used before endpoint configuration */
 894 static const struct file_operations ep_config_operations = {
 895         .owner =        THIS_MODULE,
 896         .llseek =       no_llseek,
 897
 898         .open =         ep_open,
 899         .write =        ep_config,
 900         .release =      ep_release,
 901 };
 902
 903 /*----------------------------------------------------------------------*/
 904
 905 /* EP0 IMPLEMENTATION can be partly in userspace.
 906  *
 907  * Drivers that use this facility receive various events, including
 908  * control requests the kernel doesn't handle.  Drivers that don't
 909  * use this facility may be too simple-minded for real applications.
 910  */
 911
 912 static inline void ep0_readable (struct dev_data *dev)
 913 {
 914         wake_up (&dev->wait);
 915         kill_fasync (&dev->fasync, SIGIO, POLL_IN);
 916 }
 917
 918 static void clean_req (struct usb_ep *ep, struct usb_request *req)
 919 {
 920         struct dev_data         *dev = ep->driver_data;
 921
 922         if (req->buf != dev->rbuf) {
 923                 kfree(req->buf);
 924                 req->buf = dev->rbuf;
 925                 req->dma = DMA_ADDR_INVALID;
 926         }
 927         req->complete = epio_complete;
 928         dev->setup_out_ready = 0;
 929 }
 930
 931 static void ep0_complete (struct usb_ep *ep, struct usb_request *req)
 932 {
 933         struct dev_data         *dev = ep->driver_data;
 934         unsigned long           flags;
 935         int                     free = 1;
 936
 937         /* for control OUT, data must still get to userspace */
 938         spin_lock_irqsave(&dev->lock, flags);
 939         if (!dev->setup_in) {
 940                 dev->setup_out_error = (req->status != 0);
 941                 if (!dev->setup_out_error)
 942                         free = 0;
 943                 dev->setup_out_ready = 1;
 944                 ep0_readable (dev);
 945         }
 946
 947         /* clean up as appropriate */
 948         if (free && req->buf != &dev->rbuf)
 949                 clean_req (ep, req);
 950         req->complete = epio_complete;
 951         spin_unlock_irqrestore(&dev->lock, flags);
 952 }
 953
 954 static int setup_req (struct usb_ep *ep, struct usb_request *req, u16 len)
 955 {
 956         struct dev_data *dev = ep->driver_data;
 957
 958         if (dev->setup_out_ready) {
 959                 DBG (dev, "ep0 request busy!\n");
 960                 return -EBUSY;
 961         }
 962         if (len > sizeof (dev->rbuf))
 963                 req->buf = kmalloc(len, GFP_ATOMIC);
 964         if (req->buf == NULL) {
 965                 req->buf = dev->rbuf;
 966                 return -ENOMEM;
 967         }
 968         req->complete = ep0_complete;
 969         req->length = len;
 970         req->zero = 0;
 971         return 0;
 972 }
 973
 974 static ssize_t
 975 ep0_read (struct file *fd, char __user *buf, size_t len, loff_t *ptr)
 976 {
 977         struct dev_data                 *dev = fd->private_data;
 978         ssize_t                         retval;
 979         enum ep0_state                  state;
 980
 981         spin_lock_irq (&dev->lock);
 982
 983         /* report fd mode change before acting on it */
 984         if (dev->setup_abort) {
 985                 dev->setup_abort = 0;
 986                 retval = -EIDRM;
 987                 goto done;
 988         }
 989
 990         /* control DATA stage */
 991         if ((state = dev->state) == STATE_DEV_SETUP) {
 992
 993                 if (dev->setup_in) {            /* stall IN */
 994                         VDEBUG(dev, "ep0in stall\n");
 995                         (void) usb_ep_set_halt (dev->gadget->ep0);
 996                         retval = -EL2HLT;
 997                         dev->state = STATE_DEV_CONNECTED;
 998
 999                 } else if (len == 0) {          /* ack SET_CONFIGURATION etc */
1000                         struct usb_ep           *ep = dev->gadget->ep0;
1001                         struct usb_request      *req = dev->req;
1002
1003                         if ((retval = setup_req (ep, req, 0)) == 0)
1004                                 retval = usb_ep_queue (ep, req, GFP_ATOMIC);
1005                         dev->state = STATE_DEV_CONNECTED;
1006
1007                         /* assume that was SET_CONFIGURATION */
1008                         if (dev->current_config) {
1009                                 unsigned power;
1010
1011                                 if (gadget_is_dualspeed(dev->gadget)
1012                                                 && (dev->gadget->speed
1013                                                         == USB_SPEED_HIGH))
1014                                         power = dev->hs_config->bMaxPower;
1015                                 else
1016                                         power = dev->config->bMaxPower;
1017                                 usb_gadget_vbus_draw(dev->gadget, 2 * power);
1018                         }
1019
1020                 } else {                        /* collect OUT data */
1021                         if ((fd->f_flags & O_NONBLOCK) != 0
1022                                         && !dev->setup_out_ready) {
1023                                 retval = -EAGAIN;
1024                                 goto done;
1025                         }
1026                         spin_unlock_irq (&dev->lock);
1027                         retval = wait_event_interruptible (dev->wait,
1028                                         dev->setup_out_ready != 0);
1029
1030                         /* FIXME state could change from under us */
1031                         spin_lock_irq (&dev->lock);
1032                         if (retval)
1033                                 goto done;
1034
1035                         if (dev->state != STATE_DEV_SETUP) {
1036                                 retval = -ECANCELED;
1037                                 goto done;
1038                         }
1039                         dev->state = STATE_DEV_CONNECTED;
1040
1041                         if (dev->setup_out_error)
1042                                 retval = -EIO;
1043                         else {
1044                                 len = min (len, (size_t)dev->req->actual);
1045 // FIXME don't call this with the spinlock held ...
1046                                 if (copy_to_user (buf, dev->req->buf, len))
1047                                         retval = -EFAULT;
1048                                 clean_req (dev->gadget->ep0, dev->req);
1049                                 /* NOTE userspace can't yet choose to stall */
1050                         }
1051                 }
1052                 goto done;
1053         }
1054
1055         /* else normal: return event data */
1056         if (len < sizeof dev->event [0]) {
1057                 retval = -EINVAL;
1058                 goto done;
1059         }
1060         len -= len % sizeof (struct usb_gadgetfs_event);
1061         dev->usermode_setup = 1;
1062
1063 scan:
1064         /* return queued events right away */
1065         if (dev->ev_next != 0) {
1066                 unsigned                i, n;
1067
1068                 n = len / sizeof (struct usb_gadgetfs_event);
1069                 if (dev->ev_next < n)
1070                         n = dev->ev_next;
1071
1072                 /* ep0 i/o has special semantics during STATE_DEV_SETUP */
1073                 for (i = 0; i < n; i++) {
1074                         if (dev->event [i].type == GADGETFS_SETUP) {
1075                                 dev->state = STATE_DEV_SETUP;
1076                                 n = i + 1;
1077                                 break;
1078                         }
1079                 }
1080                 spin_unlock_irq (&dev->lock);
1081                 len = n * sizeof (struct usb_gadgetfs_event);
1082                 if (copy_to_user (buf, &dev->event, len))
1083                         retval = -EFAULT;
1084                 else
1085                         retval = len;
1086                 if (len > 0) {
1087                         /* NOTE this doesn't guard against broken drivers;
1088                          * concurrent ep0 readers may lose events.
1089                          */
1090                         spin_lock_irq (&dev->lock);
1091                         if (dev->ev_next > n) {
1092                                 memmove(&dev->event[0], &dev->event[n],
1093                                         sizeof (struct usb_gadgetfs_event)
1094                                                 * (dev->ev_next - n));
1095                         }
1096                         dev->ev_next -= n;
1097                         spin_unlock_irq (&dev->lock);
1098                 }
1099                 return retval;
1100         }
1101         if (fd->f_flags & O_NONBLOCK) {
1102                 retval = -EAGAIN;
1103                 goto done;
1104         }
1105
1106         switch (state) {
1107         default:
1108                 DBG (dev, "fail %s, state %d\n", __func__, state);
1109                 retval = -ESRCH;
1110                 break;
1111         case STATE_DEV_UNCONNECTED:
1112         case STATE_DEV_CONNECTED:
1113                 spin_unlock_irq (&dev->lock);
1114                 DBG (dev, "%s wait\n", __func__);
1115
1116                 /* wait for events */
1117                 retval = wait_event_interruptible (dev->wait,
1118                                 dev->ev_next != 0);
1119                 if (retval < 0)
1120                         return retval;
1121                 spin_lock_irq (&dev->lock);
1122                 goto scan;
1123         }
1124
1125 done:
1126         spin_unlock_irq (&dev->lock);
1127         return retval;
1128 }
1129
1130 static struct usb_gadgetfs_event *
1131 next_event (struct dev_data *dev, enum usb_gadgetfs_event_type type)
1132 {
1133         struct usb_gadgetfs_event       *event;
1134         unsigned                        i;
1135
1136         switch (type) {
1137         /* these events purge the queue */
1138         case GADGETFS_DISCONNECT:
1139                 if (dev->state == STATE_DEV_SETUP)
1140                         dev->setup_abort = 1;
1141                 // FALL THROUGH
1142         case GADGETFS_CONNECT:
1143                 dev->ev_next = 0;
1144                 break;
1145         case GADGETFS_SETUP:            /* previous request timed out */
1146         case GADGETFS_SUSPEND:          /* same effect */
1147                 /* these events can't be repeated */
1148                 for (i = 0; i != dev->ev_next; i++) {
1149                         if (dev->event [i].type != type)
1150                                 continue;
1151                         DBG(dev, "discard old event[%d] %d\n", i, type);
1152                         dev->ev_next--;
1153                         if (i == dev->ev_next)
1154                                 break;
1155                         /* indices start at zero, for simplicity */
1156                         memmove (&dev->event [i], &dev->event [i + 1],
1157                                 sizeof (struct usb_gadgetfs_event)
1158                                         * (dev->ev_next - i));
1159                 }
1160                 break;
1161         default:
1162                 BUG ();
1163         }
1164         VDEBUG(dev, "event[%d] = %d\n", dev->ev_next, type);
1165         event = &dev->event [dev->ev_next++];
1166         BUG_ON (dev->ev_next > N_EVENT);
1167         memset (event, 0, sizeof *event);
1168         event->type = type;
1169         return event;
1170 }
1171
1172 static ssize_t
1173 ep0_write (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
1174 {
1175         struct dev_data         *dev = fd->private_data;
1176         ssize_t                 retval = -ESRCH;
1177
1178         spin_lock_irq (&dev->lock);
1179
1180         /* report fd mode change before acting on it */
1181         if (dev->setup_abort) {
1182                 dev->setup_abort = 0;
1183                 retval = -EIDRM;
1184
1185         /* data and/or status stage for control request */
1186         } else if (dev->state == STATE_DEV_SETUP) {
1187
1188                 /* IN DATA+STATUS caller makes len <= wLength */
1189                 if (dev->setup_in) {
1190                         retval = setup_req (dev->gadget->ep0, dev->req, len);
1191                         if (retval == 0) {
1192                                 dev->state = STATE_DEV_CONNECTED;
1193                                 spin_unlock_irq (&dev->lock);
1194                                 if (copy_from_user (dev->req->buf, buf, len))
1195                                         retval = -EFAULT;
1196                                 else {
1197                                         if (len < dev->setup_wLength)
1198                                                 dev->req->zero = 1;
1199                                         retval = usb_ep_queue (
1200                                                 dev->gadget->ep0, dev->req,
1201                                                 GFP_KERNEL);
1202                                 }
1203                                 if (retval < 0) {
1204                                         spin_lock_irq (&dev->lock);
1205                                         clean_req (dev->gadget->ep0, dev->req);
1206                                         spin_unlock_irq (&dev->lock);
1207                                 } else
1208                                         retval = len;
1209
1210                                 return retval;
1211                         }
1212
1213                 /* can stall some OUT transfers */
1214                 } else if (dev->setup_can_stall) {
1215                         VDEBUG(dev, "ep0out stall\n");
1216                         (void) usb_ep_set_halt (dev->gadget->ep0);
1217                         retval = -EL2HLT;
1218                         dev->state = STATE_DEV_CONNECTED;
1219                 } else {
1220                         DBG(dev, "bogus ep0out stall!\n");
1221                 }
1222         } else
1223                 DBG (dev, "fail %s, state %d\n", __func__, dev->state);
1224
1225         spin_unlock_irq (&dev->lock);
1226         return retval;
1227 }
1228
1229 static int
1230 ep0_fasync (int f, struct file *fd, int on)
1231 {
1232         struct dev_data         *dev = fd->private_data;
1233         // caller must F_SETOWN before signal delivery happens
1234         VDEBUG (dev, "%s %s\n", __func__, on ? "on" : "off");
1235         return fasync_helper (f, fd, on, &dev->fasync);
1236 }
1237
1238 static struct usb_gadget_driver gadgetfs_driver;
1239
1240 static int
1241 dev_release (struct inode *inode, struct file *fd)
1242 {
1243         struct dev_data         *dev = fd->private_data;
1244
1245         /* closing ep0 === shutdown all */
1246
1247         usb_gadget_unregister_driver (&gadgetfs_driver);
1248
1249         /* at this point "good" hardware has disconnected the
1250          * device from USB; the host won't see it any more.
1251          * alternatively, all host requests will time out.
1252          */
1253
1254         kfree (dev->buf);
1255         dev->buf = NULL;
1256         put_dev (dev);
1257
1258         /* other endpoints were all decoupled from this device */
1259         spin_lock_irq(&dev->lock);
1260         dev->state = STATE_DEV_DISABLED;
1261         spin_unlock_irq(&dev->lock);
1262         return 0;
1263 }
1264
1265 static unsigned int
1266 ep0_poll (struct file *fd, poll_table *wait)
1267 {
1268        struct dev_data         *dev = fd->private_data;
1269        int                     mask = 0;
1270
1271        poll_wait(fd, &dev->wait, wait);
1272
1273        spin_lock_irq (&dev->lock);
1274
1275        /* report fd mode change before acting on it */
1276        if (dev->setup_abort) {
1277                dev->setup_abort = 0;
1278                mask = POLLHUP;
1279                goto out;
1280        }
1281
1282        if (dev->state == STATE_DEV_SETUP) {
1283                if (dev->setup_in || dev->setup_can_stall)
1284                        mask = POLLOUT;
1285        } else {
1286                if (dev->ev_next != 0)
1287                        mask = POLLIN;
1288        }
1289 out:
1290        spin_unlock_irq(&dev->lock);
1291        return mask;
1292 }
1293
1294 static long dev_ioctl (struct file *fd, unsigned code, unsigned long value)
1295 {
1296         struct dev_data         *dev = fd->private_data;
1297         struct usb_gadget       *gadget = dev->gadget;
1298         long ret = -ENOTTY;
1299
1300         if (gadget->ops->ioctl) {
1301                 lock_kernel();
1302                 ret = gadget->ops->ioctl (gadget, code, value);
1303                 unlock_kernel();
1304         }
1305         return ret;
1306 }
1307
1308 /* used after device configuration */
1309 static const struct file_operations ep0_io_operations = {
1310         .owner =        THIS_MODULE,
1311         .llseek =       no_llseek,
1312
1313         .read =         ep0_read,
1314         .write =        ep0_write,
1315         .fasync =       ep0_fasync,
1316         .poll =         ep0_poll,
1317         .unlocked_ioctl =       dev_ioctl,
1318         .release =      dev_release,
1319 };
1320
1321 /*----------------------------------------------------------------------*/
1322
1323 /* The in-kernel gadget driver handles most ep0 issues, in particular
1324  * enumerating the single configuration (as provided from user space).
1325  *
1326  * Unrecognized ep0 requests may be handled in user space.
1327  */
1328
1329 #ifdef  CONFIG_USB_GADGET_DUALSPEED
1330 static void make_qualifier (struct dev_data *dev)
1331 {
1332         struct usb_qualifier_descriptor         qual;
1333         struct usb_device_descriptor            *desc;
1334
1335         qual.bLength = sizeof qual;
1336         qual.bDescriptorType = USB_DT_DEVICE_QUALIFIER;
1337         qual.bcdUSB = __constant_cpu_to_le16 (0x0200);
1338
1339         desc = dev->dev;
1340         qual.bDeviceClass = desc->bDeviceClass;
1341         qual.bDeviceSubClass = desc->bDeviceSubClass;
1342         qual.bDeviceProtocol = desc->bDeviceProtocol;
1343
1344         /* assumes ep0 uses the same value for both speeds ... */
1345         qual.bMaxPacketSize0 = desc->bMaxPacketSize0;
1346
1347         qual.bNumConfigurations = 1;
1348         qual.bRESERVED = 0;
1349
1350         memcpy (dev->rbuf, &qual, sizeof qual);
1351 }
1352 #endif
1353
1354 static int
1355 config_buf (struct dev_data *dev, u8 type, unsigned index)
1356 {
1357         int             len;
1358         int             hs = 0;
1359
1360         /* only one configuration */
1361         if (index > 0)
1362                 return -EINVAL;
1363
1364         if (gadget_is_dualspeed(dev->gadget)) {
1365                 hs = (dev->gadget->speed == USB_SPEED_HIGH);
1366                 if (type == USB_DT_OTHER_SPEED_CONFIG)
1367                         hs = !hs;
1368         }
1369         if (hs) {
1370                 dev->req->buf = dev->hs_config;
1371                 len = le16_to_cpu(dev->hs_config->wTotalLength);
1372         } else {
1373                 dev->req->buf = dev->config;
1374                 len = le16_to_cpu(dev->config->wTotalLength);
1375         }
1376         ((u8 *)dev->req->buf) [1] = type;
1377         return len;
1378 }
1379
1380 static int
1381 gadgetfs_setup (struct usb_gadget *gadget, const struct usb_ctrlrequest *ctrl)
1382 {
1383         struct dev_data                 *dev = get_gadget_data (gadget);
1384         struct usb_request              *req = dev->req;
1385         int                             value = -EOPNOTSUPP;
1386         struct usb_gadgetfs_event       *event;
1387         u16                             w_value = le16_to_cpu(ctrl->wValue);
1388         u16                             w_length = le16_to_cpu(ctrl->wLength);
1389
1390         spin_lock (&dev->lock);
1391         dev->setup_abort = 0;
1392         if (dev->state == STATE_DEV_UNCONNECTED) {
1393                 if (gadget_is_dualspeed(gadget)
1394                                 && gadget->speed == USB_SPEED_HIGH
1395                                 && dev->hs_config == NULL) {
1396                         spin_unlock(&dev->lock);
1397                         ERROR (dev, "no high speed config??\n");
1398                         return -EINVAL;
1399                 }
1400
1401                 dev->state = STATE_DEV_CONNECTED;
1402                 dev->dev->bMaxPacketSize0 = gadget->ep0->maxpacket;
1403
1404                 INFO (dev, "connected\n");
1405                 event = next_event (dev, GADGETFS_CONNECT);
1406                 event->u.speed = gadget->speed;
1407                 ep0_readable (dev);
1408
1409         /* host may have given up waiting for response.  we can miss control
1410          * requests handled lower down (device/endpoint status and features);
1411          * then ep0_{read,write} will report the wrong status. controller
1412          * driver will have aborted pending i/o.
1413          */
1414         } else if (dev->state == STATE_DEV_SETUP)
1415                 dev->setup_abort = 1;
1416
1417         req->buf = dev->rbuf;
1418         req->dma = DMA_ADDR_INVALID;
1419         req->context = NULL;
1420         value = -EOPNOTSUPP;
1421         switch (ctrl->bRequest) {
1422
1423         case USB_REQ_GET_DESCRIPTOR:
1424                 if (ctrl->bRequestType != USB_DIR_IN)
1425                         goto unrecognized;
1426                 switch (w_value >> 8) {
1427
1428                 case USB_DT_DEVICE:
1429                         value = min (w_length, (u16) sizeof *dev->dev);
1430                         req->buf = dev->dev;
1431                         break;
1432 #ifdef  CONFIG_USB_GADGET_DUALSPEED
1433                 case USB_DT_DEVICE_QUALIFIER:
1434                         if (!dev->hs_config)
1435                                 break;
1436                         value = min (w_length, (u16)
1437                                 sizeof (struct usb_qualifier_descriptor));
1438                         make_qualifier (dev);
1439                         break;
1440                 case USB_DT_OTHER_SPEED_CONFIG:
1441                         // FALLTHROUGH
1442 #endif
1443                 case USB_DT_CONFIG:
1444                         value = config_buf (dev,
1445                                         w_value >> 8,
1446                                         w_value & 0xff);
1447                         if (value >= 0)
1448                                 value = min (w_length, (u16) value);
1449                         break;
1450                 case USB_DT_STRING:
1451                         goto unrecognized;
1452
1453                 default:                // all others are errors
1454                         break;
1455                 }
1456                 break;
1457
1458         /* currently one config, two speeds */
1459         case USB_REQ_SET_CONFIGURATION:
1460                 if (ctrl->bRequestType != 0)
1461                         goto unrecognized;
1462                 if (0 == (u8) w_value) {
1463                         value = 0;
1464                         dev->current_config = 0;
1465                         usb_gadget_vbus_draw(gadget, 8 /* mA */ );
1466                         // user mode expected to disable endpoints
1467                 } else {
1468                         u8      config, power;
1469
1470                         if (gadget_is_dualspeed(gadget)
1471                                         && gadget->speed == USB_SPEED_HIGH) {
1472                                 config = dev->hs_config->bConfigurationValue;
1473                                 power = dev->hs_config->bMaxPower;
1474                         } else {
1475                                 config = dev->config->bConfigurationValue;
1476                                 power = dev->config->bMaxPower;
1477                         }
1478
1479                         if (config == (u8) w_value) {
1480                                 value = 0;
1481                                 dev->current_config = config;
1482                                 usb_gadget_vbus_draw(gadget, 2 * power);
1483                         }
1484                 }
1485
1486                 /* report SET_CONFIGURATION like any other control request,
1487                  * except that usermode may not stall this.  the next
1488                  * request mustn't be allowed start until this finishes:
1489                  * endpoints and threads set up, etc.
1490                  *
1491                  * NOTE:  older PXA hardware (before PXA 255: without UDCCFR)
1492                  * has bad/racey automagic that prevents synchronizing here.
1493                  * even kernel mode drivers often miss them.
1494                  */
1495                 if (value == 0) {
1496                         INFO (dev, "configuration #%d\n", dev->current_config);
1497                         if (dev->usermode_setup) {
1498                                 dev->setup_can_stall = 0;
1499                                 goto delegate;
1500                         }
1501                 }
1502                 break;
1503
1504 #ifndef CONFIG_USB_GADGET_PXA25X
1505         /* PXA automagically handles this request too */
1506         case USB_REQ_GET_CONFIGURATION:
1507                 if (ctrl->bRequestType != 0x80)
1508                         goto unrecognized;
1509                 *(u8 *)req->buf = dev->current_config;
1510                 value = min (w_length, (u16) 1);
1511                 break;
1512 #endif
1513
1514         default:
1515 unrecognized:
1516                 VDEBUG (dev, "%s req%02x.%02x v%04x i%04x l%d\n",
1517                         dev->usermode_setup ? "delegate" : "fail",
1518                         ctrl->bRequestType, ctrl->bRequest,
1519                         w_value, le16_to_cpu(ctrl->wIndex), w_length);
1520
1521                 /* if there's an ep0 reader, don't stall */
1522                 if (dev->usermode_setup) {
1523                         dev->setup_can_stall = 1;
1524 delegate:
1525                         dev->setup_in = (ctrl->bRequestType & USB_DIR_IN)
1526                                                 ? 1 : 0;
1527                         dev->setup_wLength = w_length;
1528                         dev->setup_out_ready = 0;
1529                         dev->setup_out_error = 0;
1530                         value = 0;
1531
1532                         /* read DATA stage for OUT right away */
1533                         if (unlikely (!dev->setup_in && w_length)) {
1534                                 value = setup_req (gadget->ep0, dev->req,
1535                                                         w_length);
1536                                 if (value < 0)
1537                                         break;
1538                                 value = usb_ep_queue (gadget->ep0, dev->req,
1539                                                         GFP_ATOMIC);
1540                                 if (value < 0) {
1541                                         clean_req (gadget->ep0, dev->req);
1542                                         break;
1543                                 }
1544
1545                                 /* we can't currently stall these */
1546                                 dev->setup_can_stall = 0;
1547                         }
1548
1549                         /* state changes when reader collects event */
1550                         event = next_event (dev, GADGETFS_SETUP);
1551                         event->u.setup = *ctrl;
1552                         ep0_readable (dev);
1553                         spin_unlock (&dev->lock);
1554                         return 0;
1555                 }
1556         }
1557
1558         /* proceed with data transfer and status phases? */
1559         if (value >= 0 && dev->state != STATE_DEV_SETUP) {
1560                 req->length = value;
1561                 req->zero = value < w_length;
1562                 value = usb_ep_queue (gadget->ep0, req, GFP_ATOMIC);
1563                 if (value < 0) {
1564                         DBG (dev, "ep_queue --> %d\n", value);
1565                         req->status = 0;
1566                 }
1567         }
1568
1569         /* device stalls when value < 0 */
1570         spin_unlock (&dev->lock);
1571         return value;
1572 }
1573
1574 static void destroy_ep_files (struct dev_data *dev)
1575 {
1576         struct list_head        *entry, *tmp;
1577
1578         DBG (dev, "%s %d\n", __func__, dev->state);
1579
1580         /* dev->state must prevent interference */
1581 restart:
1582         spin_lock_irq (&dev->lock);
1583         list_for_each_safe (entry, tmp, &dev->epfiles) {
1584                 struct ep_data  *ep;
1585                 struct inode    *parent;
1586                 struct dentry   *dentry;
1587
1588                 /* break link to FS */
1589                 ep = list_entry (entry, struct ep_data, epfiles);
1590                 list_del_init (&ep->epfiles);
1591                 dentry = ep->dentry;
1592                 ep->dentry = NULL;
1593                 parent = dentry->d_parent->d_inode;
1594
1595                 /* break link to controller */
1596                 if (ep->state == STATE_EP_ENABLED)
1597                         (void) usb_ep_disable (ep->ep);
1598                 ep->state = STATE_EP_UNBOUND;
1599                 usb_ep_free_request (ep->ep, ep->req);
1600                 ep->ep = NULL;
1601                 wake_up (&ep->wait);
1602                 put_ep (ep);
1603
1604                 spin_unlock_irq (&dev->lock);
1605
1606                 /* break link to dcache */
1607                 mutex_lock (&parent->i_mutex);
1608                 d_delete (dentry);
1609                 dput (dentry);
1610                 mutex_unlock (&parent->i_mutex);
1611
1612                 /* fds may still be open */
1613                 goto restart;
1614         }
1615         spin_unlock_irq (&dev->lock);
1616 }
1617
1618
1619 static struct inode *
1620 gadgetfs_create_file (struct super_block *sb, char const *name,
1621                 void *data, const struct file_operations *fops,
1622                 struct dentry **dentry_p);
1623
1624 static int activate_ep_files (struct dev_data *dev)
1625 {
1626         struct usb_ep   *ep;
1627         struct ep_data  *data;
1628
1629         gadget_for_each_ep (ep, dev->gadget) {
1630
1631                 data = kzalloc(sizeof(*data), GFP_KERNEL);
1632                 if (!data)
1633                         goto enomem0;
1634                 data->state = STATE_EP_DISABLED;
1635                 init_MUTEX (&data->lock);
1636                 init_waitqueue_head (&data->wait);
1637
1638                 strncpy (data->name, ep->name, sizeof (data->name) - 1);
1639                 atomic_set (&data->count, 1);
1640                 data->dev = dev;
1641                 get_dev (dev);
1642
1643                 data->ep = ep;
1644                 ep->driver_data = data;
1645
1646                 data->req = usb_ep_alloc_request (ep, GFP_KERNEL);
1647                 if (!data->req)
1648                         goto enomem1;
1649
1650                 data->inode = gadgetfs_create_file (dev->sb, data->name,
1651                                 data, &ep_config_operations,
1652                                 &data->dentry);
1653                 if (!data->inode)
1654                         goto enomem2;
1655                 list_add_tail (&data->epfiles, &dev->epfiles);
1656         }
1657         return 0;
1658
1659 enomem2:
1660         usb_ep_free_request (ep, data->req);
1661 enomem1:
1662         put_dev (dev);
1663         kfree (data);
1664 enomem0:
1665         DBG (dev, "%s enomem\n", __func__);
1666         destroy_ep_files (dev);
1667         return -ENOMEM;
1668 }
1669
1670 static void
1671 gadgetfs_unbind (struct usb_gadget *gadget)
1672 {
1673         struct dev_data         *dev = get_gadget_data (gadget);
1674
1675         DBG (dev, "%s\n", __func__);
1676
1677         spin_lock_irq (&dev->lock);
1678         dev->state = STATE_DEV_UNBOUND;
1679         spin_unlock_irq (&dev->lock);
1680
1681         destroy_ep_files (dev);
1682         gadget->ep0->driver_data = NULL;
1683         set_gadget_data (gadget, NULL);
1684
1685         /* we've already been disconnected ... no i/o is active */
1686         if (dev->req)
1687                 usb_ep_free_request (gadget->ep0, dev->req);
1688         DBG (dev, "%s done\n", __func__);
1689         put_dev (dev);
1690 }
1691
1692 static struct dev_data          *the_device;
1693
1694 static int
1695 gadgetfs_bind (struct usb_gadget *gadget)
1696 {
1697         struct dev_data         *dev = the_device;
1698
1699         if (!dev)
1700                 return -ESRCH;
1701         if (0 != strcmp (CHIP, gadget->name)) {
1702                 pr_err("%s expected %s controller not %s\n",
1703                         shortname, CHIP, gadget->name);
1704                 return -ENODEV;
1705         }
1706
1707         set_gadget_data (gadget, dev);
1708         dev->gadget = gadget;
1709         gadget->ep0->driver_data = dev;
1710         dev->dev->bMaxPacketSize0 = gadget->ep0->maxpacket;
1711
1712         /* preallocate control response and buffer */
1713         dev->req = usb_ep_alloc_request (gadget->ep0, GFP_KERNEL);
1714         if (!dev->req)
1715                 goto enomem;
1716         dev->req->context = NULL;
1717         dev->req->complete = epio_complete;
1718
1719         if (activate_ep_files (dev) < 0)
1720                 goto enomem;
1721
1722         INFO (dev, "bound to %s driver\n", gadget->name);
1723         spin_lock_irq(&dev->lock);
1724         dev->state = STATE_DEV_UNCONNECTED;
1725         spin_unlock_irq(&dev->lock);
1726         get_dev (dev);
1727         return 0;
1728
1729 enomem:
1730         gadgetfs_unbind (gadget);
1731         return -ENOMEM;
1732 }
1733
1734 static void
1735 gadgetfs_disconnect (struct usb_gadget *gadget)
1736 {
1737         struct dev_data         *dev = get_gadget_data (gadget);
1738
1739         spin_lock (&dev->lock);
1740         if (dev->state == STATE_DEV_UNCONNECTED)
1741                 goto exit;
1742         dev->state = STATE_DEV_UNCONNECTED;
1743
1744         INFO (dev, "disconnected\n");
1745         next_event (dev, GADGETFS_DISCONNECT);
1746         ep0_readable (dev);
1747 exit:
1748         spin_unlock (&dev->lock);
1749 }
1750
1751 static void
1752 gadgetfs_suspend (struct usb_gadget *gadget)
1753 {
1754         struct dev_data         *dev = get_gadget_data (gadget);
1755
1756         INFO (dev, "suspended from state %d\n", dev->state);
1757         spin_lock (&dev->lock);
1758         switch (dev->state) {
1759         case STATE_DEV_SETUP:           // VERY odd... host died??
1760         case STATE_DEV_CONNECTED:
1761         case STATE_DEV_UNCONNECTED:
1762                 next_event (dev, GADGETFS_SUSPEND);
1763                 ep0_readable (dev);
1764                 /* FALLTHROUGH */
1765         default:
1766                 break;
1767         }
1768         spin_unlock (&dev->lock);
1769 }
1770
1771 static struct usb_gadget_driver gadgetfs_driver = {
1772 #ifdef  CONFIG_USB_GADGET_DUALSPEED
1773         .speed          = USB_SPEED_HIGH,
1774 #else
1775         .speed          = USB_SPEED_FULL,
1776 #endif
1777         .function       = (char *) driver_desc,
1778         .bind           = gadgetfs_bind,
1779         .unbind         = gadgetfs_unbind,
1780         .setup          = gadgetfs_setup,
1781         .disconnect     = gadgetfs_disconnect,
1782         .suspend        = gadgetfs_suspend,
1783
1784         .driver = {
1785                 .name           = (char *) shortname,
1786         },
1787 };
1788
1789 /*----------------------------------------------------------------------*/
1790
1791 static void gadgetfs_nop(struct usb_gadget *arg) { }
1792
1793 static int gadgetfs_probe (struct usb_gadget *gadget)
1794 {
1795         CHIP = gadget->name;
1796         return -EISNAM;
1797 }
1798
1799 static struct usb_gadget_driver probe_driver = {
1800         .speed          = USB_SPEED_HIGH,
1801         .bind           = gadgetfs_probe,
1802         .unbind         = gadgetfs_nop,
1803         .setup          = (void *)gadgetfs_nop,
1804         .disconnect     = gadgetfs_nop,
1805         .driver = {
1806                 .name           = "nop",
1807         },
1808 };
1809
1810
1811 /* DEVICE INITIALIZATION
1812  *
1813  *     fd = open ("/dev/gadget/$CHIP", O_RDWR)
1814  *     status = write (fd, descriptors, sizeof descriptors)
1815  *
1816  * That write establishes the device configuration, so the kernel can
1817  * bind to the controller ... guaranteeing it can handle enumeration
1818  * at all necessary speeds.  Descriptor order is:
1819  *
1820  * . message tag (u32, host order) ... for now, must be zero; it
1821  *      would change to support features like multi-config devices
1822  * . full/low speed config ... all wTotalLength bytes (with interface,
1823  *      class, altsetting, endpoint, and other descriptors)
1824  * . high speed config ... all descriptors, for high speed operation;
1825  *      this one's optional except for high-speed hardware
1826  * . device descriptor
1827  *
1828  * Endpoints are not yet enabled. Drivers must wait until device
1829  * configuration and interface altsetting changes create
1830  * the need to configure (or unconfigure) them.
1831  *
1832  * After initialization, the device stays active for as long as that
1833  * $CHIP file is open.  Events must then be read from that descriptor,
1834  * such as configuration notifications.
1835  */
1836
1837 static int is_valid_config (struct usb_config_descriptor *config)
1838 {
1839         return config->bDescriptorType == USB_DT_CONFIG
1840                 && config->bLength == USB_DT_CONFIG_SIZE
1841                 && config->bConfigurationValue != 0
1842                 && (config->bmAttributes & USB_CONFIG_ATT_ONE) != 0
1843                 && (config->bmAttributes & USB_CONFIG_ATT_WAKEUP) == 0;
1844         /* FIXME if gadget->is_otg, _must_ include an otg descriptor */
1845         /* FIXME check lengths: walk to end */
1846 }
1847
1848 static ssize_t
1849 dev_config (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
1850 {
1851         struct dev_data         *dev = fd->private_data;
1852         ssize_t                 value = len, length = len;
1853         unsigned                total;
1854         u32                     tag;
1855         char                    *kbuf;
1856
1857         if (len < (USB_DT_CONFIG_SIZE + USB_DT_DEVICE_SIZE + 4))
1858                 return -EINVAL;
1859
1860         /* we might need to change message format someday */
1861         if (copy_from_user (&tag, buf, 4))
1862                 return -EFAULT;
1863         if (tag != 0)
1864                 return -EINVAL;
1865         buf += 4;
1866         length -= 4;
1867
1868         kbuf = kmalloc (length, GFP_KERNEL);
1869         if (!kbuf)
1870                 return -ENOMEM;
1871         if (copy_from_user (kbuf, buf, length)) {
1872                 kfree (kbuf);
1873                 return -EFAULT;
1874         }
1875
1876         spin_lock_irq (&dev->lock);
1877         value = -EINVAL;
1878         if (dev->buf)
1879                 goto fail;
1880         dev->buf = kbuf;
1881
1882         /* full or low speed config */
1883         dev->config = (void *) kbuf;
1884         total = le16_to_cpu(dev->config->wTotalLength);
1885         if (!is_valid_config (dev->config) || total >= length)
1886                 goto fail;
1887         kbuf += total;
1888         length -= total;
1889
1890         /* optional high speed config */
1891         if (kbuf [1] == USB_DT_CONFIG) {
1892                 dev->hs_config = (void *) kbuf;
1893                 total = le16_to_cpu(dev->hs_config->wTotalLength);
1894                 if (!is_valid_config (dev->hs_config) || total >= length)
1895                         goto fail;
1896                 kbuf += total;
1897                 length -= total;
1898         }
1899
1900         /* could support multiple configs, using another encoding! */
1901
1902         /* device descriptor (tweaked for paranoia) */
1903         if (length != USB_DT_DEVICE_SIZE)
1904                 goto fail;
1905         dev->dev = (void *)kbuf;
1906         if (dev->dev->bLength != USB_DT_DEVICE_SIZE
1907                         || dev->dev->bDescriptorType != USB_DT_DEVICE
1908                         || dev->dev->bNumConfigurations != 1)
1909                 goto fail;
1910         dev->dev->bNumConfigurations = 1;
1911         dev->dev->bcdUSB = __constant_cpu_to_le16 (0x0200);
1912
1913         /* triggers gadgetfs_bind(); then we can enumerate. */
1914         spin_unlock_irq (&dev->lock);
1915         value = usb_gadget_register_driver (&gadgetfs_driver);
1916         if (value != 0) {
1917                 kfree (dev->buf);
1918                 dev->buf = NULL;
1919         } else {
1920                 /* at this point "good" hardware has for the first time
1921                  * let the USB the host see us.  alternatively, if users
1922                  * unplug/replug that will clear all the error state.
1923                  *
1924                  * note:  everything running before here was guaranteed
1925                  * to choke driver model style diagnostics.  from here
1926                  * on, they can work ... except in cleanup paths that
1927                  * kick in after the ep0 descriptor is closed.
1928                  */
1929                 fd->f_op = &ep0_io_operations;
1930                 value = len;
1931         }
1932         return value;
1933
1934 fail:
1935         spin_unlock_irq (&dev->lock);
1936         pr_debug ("%s: %s fail %Zd, %p\n", shortname, __func__, value, dev);
1937         kfree (dev->buf);
1938         dev->buf = NULL;
1939         return value;
1940 }
1941
1942 static int
1943 dev_open (struct inode *inode, struct file *fd)
1944 {
1945         struct dev_data         *dev = inode->i_private;
1946         int                     value = -EBUSY;
1947
1948         spin_lock_irq(&dev->lock);
1949         if (dev->state == STATE_DEV_DISABLED) {
1950                 dev->ev_next = 0;
1951                 dev->state = STATE_DEV_OPENED;
1952                 fd->private_data = dev;
1953                 get_dev (dev);
1954                 value = 0;
1955         }
1956         spin_unlock_irq(&dev->lock);
1957         return value;
1958 }
1959
1960 static const struct file_operations dev_init_operations = {
1961         .owner =        THIS_MODULE,
1962         .llseek =       no_llseek,
1963
1964         .open =         dev_open,
1965         .write =        dev_config,
1966         .fasync =       ep0_fasync,
1967         .unlocked_ioctl = dev_ioctl,
1968         .release =      dev_release,
1969 };
1970
1971 /*----------------------------------------------------------------------*/
1972
1973 /* FILESYSTEM AND SUPERBLOCK OPERATIONS
1974  *
1975  * Mounting the filesystem creates a controller file, used first for
1976  * device configuration then later for event monitoring.
1977  */
1978
1979
1980 /* FIXME PAM etc could set this security policy without mount options
1981  * if epfiles inherited ownership and permissons from ep0 ...
1982  */
1983
1984 static unsigned default_uid;
1985 static unsigned default_gid;
1986 static unsigned default_perm = S_IRUSR | S_IWUSR;
1987
1988 module_param (default_uid, uint, 0644);
1989 module_param (default_gid, uint, 0644);
1990 module_param (default_perm, uint, 0644);
1991
1992
1993 static struct inode *
1994 gadgetfs_make_inode (struct super_block *sb,
1995                 void *data, const struct file_operations *fops,
1996                 int mode)
1997 {
1998         struct inode *inode = new_inode (sb);
1999
2000         if (inode) {
2001                 inode->i_mode = mode;
2002                 inode->i_uid = default_uid;
2003                 inode->i_gid = default_gid;
2004                 inode->i_blocks = 0;
2005                 inode->i_atime = inode->i_mtime = inode->i_ctime
2006                                 = CURRENT_TIME;
2007                 inode->i_private = data;
2008                 inode->i_fop = fops;
2009         }
2010         return inode;
2011 }
2012
2013 /* creates in fs root directory, so non-renamable and non-linkable.
2014  * so inode and dentry are paired, until device reconfig.
2015  */
2016 static struct inode *
2017 gadgetfs_create_file (struct super_block *sb, char const *name,
2018                 void *data, const struct file_operations *fops,
2019                 struct dentry **dentry_p)
2020 {
2021         struct dentry   *dentry;
2022         struct inode    *inode;
2023
2024         dentry = d_alloc_name(sb->s_root, name);
2025         if (!dentry)
2026                 return NULL;
2027
2028         inode = gadgetfs_make_inode (sb, data, fops,
2029                         S_IFREG | (default_perm & S_IRWXUGO));
2030         if (!inode) {
2031                 dput(dentry);
2032                 return NULL;
2033         }
2034         d_add (dentry, inode);
2035         *dentry_p = dentry;
2036         return inode;
2037 }
2038
2039 static struct super_operations gadget_fs_operations = {
2040         .statfs =       simple_statfs,
2041         .drop_inode =   generic_delete_inode,
2042 };
2043
2044 static int
2045 gadgetfs_fill_super (struct super_block *sb, void *opts, int silent)
2046 {
2047         struct inode    *inode;
2048         struct dentry   *d;
2049         struct dev_data *dev;
2050
2051         if (the_device)
2052                 return -ESRCH;
2053
2054         /* fake probe to determine $CHIP */
2055         (void) usb_gadget_register_driver (&probe_driver);
2056         if (!CHIP)
2057                 return -ENODEV;
2058
2059         /* superblock */
2060         sb->s_blocksize = PAGE_CACHE_SIZE;
2061         sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
2062         sb->s_magic = GADGETFS_MAGIC;
2063         sb->s_op = &gadget_fs_operations;
2064         sb->s_time_gran = 1;
2065
2066         /* root inode */
2067         inode = gadgetfs_make_inode (sb,
2068                         NULL, &simple_dir_operations,
2069                         S_IFDIR | S_IRUGO | S_IXUGO);
2070         if (!inode)
2071                 goto enomem0;
2072         inode->i_op = &simple_dir_inode_operations;
2073         if (!(d = d_alloc_root (inode)))
2074                 goto enomem1;
2075         sb->s_root = d;
2076
2077         /* the ep0 file is named after the controller we expect;
2078          * user mode code can use it for sanity checks, like we do.
2079          */
2080         dev = dev_new ();
2081         if (!dev)
2082                 goto enomem2;
2083
2084         dev->sb = sb;
2085         if (!gadgetfs_create_file (sb, CHIP,
2086                                 dev, &dev_init_operations,
2087                                 &dev->dentry))
2088                 goto enomem3;
2089
2090         /* other endpoint files are available after hardware setup,
2091          * from binding to a controller.
2092          */
2093         the_device = dev;
2094         return 0;
2095
2096 enomem3:
2097         put_dev (dev);
2098 enomem2:
2099         dput (d);
2100 enomem1:
2101         iput (inode);
2102 enomem0:
2103         return -ENOMEM;
2104 }
2105
2106 /* "mount -t gadgetfs path /dev/gadget" ends up here */
2107 static int
2108 gadgetfs_get_sb (struct file_system_type *t, int flags,
2109                 const char *path, void *opts, struct vfsmount *mnt)
2110 {
2111         return get_sb_single (t, flags, opts, gadgetfs_fill_super, mnt);
2112 }
2113
2114 static void
2115 gadgetfs_kill_sb (struct super_block *sb)
2116 {
2117         kill_litter_super (sb);
2118         if (the_device) {
2119                 put_dev (the_device);
2120                 the_device = NULL;
2121         }
2122 }
2123
2124 /*----------------------------------------------------------------------*/
2125
2126 static struct file_system_type gadgetfs_type = {
2127         .owner          = THIS_MODULE,
2128         .name           = shortname,
2129         .get_sb         = gadgetfs_get_sb,
2130         .kill_sb        = gadgetfs_kill_sb,
2131 };
2132
2133 /*----------------------------------------------------------------------*/
2134
2135 static int __init init (void)
2136 {
2137         int status;
2138
2139         status = register_filesystem (&gadgetfs_type);
2140         if (status == 0)
2141                 pr_info ("%s: %s, version " DRIVER_VERSION "\n",
2142                         shortname, driver_desc);
2143         return status;
2144 }
2145 module_init (init);
2146
2147 static void __exit cleanup (void)
2148 {
2149         pr_debug ("unregister %s\n", shortname);
2150         unregister_filesystem (&gadgetfs_type);
2151 }
2152 module_exit (cleanup);
2153