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 VERBOSE_DEBUG */
25
#include <linux/init.h>
26
#include <linux/module.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>
37
#include <linux/device.h>
38
#include <linux/moduleparam.h>
40
#include <linux/usb/gadgetfs.h>
41
#include <linux/usb/gadget.h>
43
#include <linux/delay.h>
44
#include <linux/time.h>
47
* The gadgetfs API maps each endpoint to a file descriptor so that you
48
* can use standard synchronous read/write calls for I/O. There's some
49
* O_NONBLOCK and O_ASYNC/FASYNC style i/o support. Example usermode
50
* drivers show how this works in practice. You can also use AIO to
51
* eliminate I/O gaps between requests, to help when streaming data.
53
* Key parts that must be USB-specific are protocols defining how the
54
* read/write operations relate to the hardware state machines. There
55
* are two types of files. One type is for the device, implementing ep0.
56
* The other type is for each IN or OUT endpoint. In both cases, the
57
* user mode driver must configure the hardware before using it.
59
* - First, dev_config() is called when /dev/gadget/$CHIP is configured
60
* (by writing configuration and device descriptors). Afterwards it
61
* may serve as a source of device events, used to handle all control
62
* requests other than basic enumeration.
64
* - Then, after a SET_CONFIGURATION control request, ep_config() is
65
* called when each /dev/gadget/ep* file is configured (by writing
66
* endpoint descriptors). Afterwards these files are used to write()
67
* IN data or to read() OUT data. To halt the endpoint, a "wrong
68
* direction" request is issued (like reading an IN endpoint).
70
* Unlike "usbfs" the only ioctl()s are for things that are rare, and maybe
71
* not possible on all hardware. For example, precise fault handling with
72
* respect to data left in endpoint fifos after aborted operations; or
73
* selective clearing of endpoint halts, to implement SET_INTERFACE.
76
#define DRIVER_DESC "USB Gadget filesystem"
77
#define DRIVER_VERSION "24 Aug 2004"
79
static const char driver_desc [] = DRIVER_DESC;
80
static const char shortname [] = "gadgetfs";
82
MODULE_DESCRIPTION (DRIVER_DESC);
83
MODULE_AUTHOR ("David Brownell");
84
MODULE_LICENSE ("GPL");
86
/* Cancel IO, To store the bulkin and bulkout ep data. */
87
static struct ep_data *gp_ep_bulkin_data;
88
static struct ep_data *gp_ep_bulkout_data;
90
/*----------------------------------------------------------------------*/
92
#define GADGETFS_MAGIC 0xaee71ee7
93
#define DMA_ADDR_INVALID (~(dma_addr_t)0)
95
/* /dev/gadget/$CHIP represents ep0 and the whole device */
97
/* DISBLED is the initial state.
99
STATE_DEV_DISABLED = 0,
101
/* Only one open() of /dev/gadget/$CHIP; only one file tracks
102
* ep0/device i/o modes and binding to the controller. Driver
103
* must always write descriptors to initialize the device, then
104
* the device becomes UNCONNECTED until enumeration.
108
/* From then on, ep0 fd is in either of two basic modes:
109
* - (UN)CONNECTED: read usb_gadgetfs_event(s) from it
110
* - SETUP: read/write will transfer control data and succeed;
111
* or if "wrong direction", performs protocol stall
113
STATE_DEV_UNCONNECTED,
117
/* UNBOUND means the driver closed ep0, so the device won't be
118
* accessible again (DEV_DISABLED) until all fds are closed.
123
/* enough for the whole queue: most events invalidate others */
129
enum ep0_state state; /* P: lock */
130
struct usb_gadgetfs_event event [N_EVENT];
132
struct fasync_struct *fasync;
135
/* drivers reading ep0 MUST handle control requests (SETUP)
136
* reported that way; else the host will time out.
138
unsigned usermode_setup : 1,
144
unsigned setup_wLength;
146
/* the rest is basically write-once */
147
struct usb_config_descriptor *config, *hs_config;
148
struct usb_device_descriptor *dev;
149
struct usb_request *req;
150
struct usb_gadget *gadget;
151
struct list_head epfiles;
153
wait_queue_head_t wait;
154
struct super_block *sb;
155
struct dentry *dentry;
157
/* except this scratch i/o buffer for ep0 */
161
static inline void get_dev (struct dev_data *data)
163
atomic_inc (&data->count);
166
static void put_dev (struct dev_data *data)
168
if (likely (!atomic_dec_and_test (&data->count)))
170
/* needs no more cleanup */
171
BUG_ON (waitqueue_active (&data->wait));
175
static struct dev_data *dev_new (void)
177
struct dev_data *dev;
179
dev = kzalloc(sizeof(*dev), GFP_KERNEL);
182
dev->state = STATE_DEV_DISABLED;
183
atomic_set (&dev->count, 1);
184
spin_lock_init (&dev->lock);
185
INIT_LIST_HEAD (&dev->epfiles);
186
init_waitqueue_head (&dev->wait);
190
/*----------------------------------------------------------------------*/
192
/* other /dev/gadget/$ENDPOINT files represent endpoints */
194
STATE_EP_DISABLED = 0,
201
struct semaphore lock;
204
struct dev_data *dev;
205
/* must hold dev->lock before accessing ep or req */
207
struct usb_request *req;
210
struct usb_endpoint_descriptor desc, hs_desc;
211
struct list_head epfiles;
212
wait_queue_head_t wait;
213
struct dentry *dentry;
217
static inline void get_ep (struct ep_data *data)
219
atomic_inc (&data->count);
222
static void put_ep (struct ep_data *data)
224
if (likely (!atomic_dec_and_test (&data->count)))
227
/* needs no more cleanup */
228
BUG_ON (!list_empty (&data->epfiles));
229
BUG_ON (waitqueue_active (&data->wait));
233
/*----------------------------------------------------------------------*/
235
/* most "how to use the hardware" policy choices are in userspace:
236
* mapping endpoint roles (which the driver needs) to the capabilities
237
* which the usb controller has. most of those capabilities are exposed
238
* implicitly, starting with the driver name and then endpoint names.
241
static const char *CHIP;
243
/*----------------------------------------------------------------------*/
245
/* NOTE: don't use dev_printk calls before binding to the gadget
246
* at the end of ep0 configuration, or after unbind.
249
/* too wordy: dev_printk(level , &(d)->gadget->dev , fmt , ## args) */
250
#define xprintk(d,level,fmt,args...) \
251
printk(level "%s: " fmt , shortname , ## args)
254
#define DBG(dev,fmt,args...) \
255
xprintk(dev , KERN_DEBUG , fmt , ## args)
257
#define DBG(dev,fmt,args...) \
264
#define VDEBUG(dev,fmt,args...) \
268
#define ERROR(dev,fmt,args...) \
269
xprintk(dev , KERN_ERR , fmt , ## args)
270
#define INFO(dev,fmt,args...) \
271
xprintk(dev , KERN_INFO , fmt , ## args)
274
static int mtp_ctrl_cmd;
275
static int gbCancelFlag;
276
static unsigned long mtptimestamp;
278
/*----------------------------------------------------------------------*/
280
/* SYNCHRONOUS ENDPOINT OPERATIONS (bulk/intr/iso)
282
* After opening, configure non-control endpoints. Then use normal
283
* stream read() and write() requests; and maybe ioctl() to get more
284
* precise FIFO status when recovering from cancellation.
288
static void cancel_io_process(struct work_struct *work)
290
if (gp_ep_bulkout_data->req->status == -EINPROGRESS)
291
usb_ep_dequeue(gp_ep_bulkout_data->ep, gp_ep_bulkout_data->req);
293
if (gp_ep_bulkin_data->req->status == -EINPROGRESS)
294
usb_ep_dequeue(gp_ep_bulkin_data->ep, gp_ep_bulkin_data->req);
296
static DECLARE_DELAYED_WORK(cancel_work, cancel_io_process);
298
static void epio_complete (struct usb_ep *ep, struct usb_request *req)
300
struct ep_data *epdata = ep->driver_data;
305
epdata->status = req->status;
307
epdata->status = req->actual;
308
complete ((struct completion *)req->context);
311
/* tasklock endpoint, returning when it's connected.
312
* still need dev->lock to use epdata->ep.
315
get_ready_ep (unsigned f_flags, struct ep_data *epdata)
319
if (f_flags & O_NONBLOCK) {
320
if (down_trylock (&epdata->lock) != 0)
322
if (epdata->state != STATE_EP_ENABLED) {
331
if ((val = down_interruptible (&epdata->lock)) < 0)
334
switch (epdata->state) {
335
case STATE_EP_ENABLED:
337
// case STATE_EP_DISABLED: /* "can't happen" */
338
// case STATE_EP_READY: /* "can't happen" */
339
default: /* error! */
340
pr_debug ("%s: ep %p not available, state %d\n",
341
shortname, epdata, epdata->state);
343
case STATE_EP_UNBOUND: /* clean disconnect */
351
ep_io (struct ep_data *epdata, void *buf, unsigned len)
353
DECLARE_COMPLETION_ONSTACK (done);
356
spin_lock_irq (&epdata->dev->lock);
357
if (likely (epdata->ep != NULL)) {
358
struct usb_request *req = epdata->req;
360
req->context = &done;
361
req->complete = epio_complete;
364
value = usb_ep_queue (epdata->ep, req, GFP_ATOMIC);
367
spin_unlock_irq (&epdata->dev->lock);
369
if (likely (value == 0)) {
370
value = wait_event_interruptible (done.wait, done.done);
372
spin_lock_irq (&epdata->dev->lock);
373
if (likely (epdata->ep != NULL)) {
374
DBG (epdata->dev, "%s i/o interrupted\n",
376
usb_ep_dequeue (epdata->ep, epdata->req);
377
spin_unlock_irq (&epdata->dev->lock);
379
wait_event (done.wait, done.done);
380
if (epdata->status == -ECONNRESET)
381
epdata->status = -EINTR;
383
spin_unlock_irq (&epdata->dev->lock);
385
DBG (epdata->dev, "endpoint gone\n");
386
epdata->status = -ENODEV;
389
return epdata->status;
395
/* handle a synchronous OUT bulk/intr/iso transfer */
397
ep_read (struct file *fd, char __user *buf, size_t len, loff_t *ptr)
399
struct ep_data *data = fd->private_data;
403
if ((value = get_ready_ep (fd->f_flags, data)) < 0)
406
/* halt any endpoint by doing a "wrong direction" i/o call */
407
if (data->desc.bEndpointAddress & USB_DIR_IN) {
408
if ((data->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
409
== USB_ENDPOINT_XFER_ISOC)
411
DBG (data->dev, "%s halt\n", data->name);
412
spin_lock_irq (&data->dev->lock);
413
if (likely (data->ep != NULL))
414
usb_ep_set_halt (data->ep);
415
spin_unlock_irq (&data->dev->lock);
420
/* FIXME readahead for O_NONBLOCK and poll(); careful with ZLPs */
423
kbuf = kmalloc (len, GFP_KERNEL);
424
if (unlikely (!kbuf))
427
value = ep_io (data, kbuf, len);
428
VDEBUG (data->dev, "%s read %zu OUT, status %d\n",
429
data->name, len, (int) value);
430
if (value >= 0 && copy_to_user (buf, kbuf, value))
439
/* handle a synchronous IN bulk/intr/iso transfer */
441
ep_write (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
443
struct ep_data *data = fd->private_data;
447
if ((value = get_ready_ep (fd->f_flags, data)) < 0)
450
/* halt any endpoint by doing a "wrong direction" i/o call */
451
if (!(data->desc.bEndpointAddress & USB_DIR_IN)) {
452
if ((data->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
453
== USB_ENDPOINT_XFER_ISOC)
455
DBG (data->dev, "%s halt\n", data->name);
456
spin_lock_irq (&data->dev->lock);
457
if (likely (data->ep != NULL))
458
usb_ep_set_halt (data->ep);
459
spin_unlock_irq (&data->dev->lock);
464
/* FIXME writebehind for O_NONBLOCK and poll(), qlen = 1 */
467
kbuf = kmalloc (len, GFP_KERNEL);
470
if (copy_from_user (kbuf, buf, len)) {
475
value = ep_io (data, kbuf, len);
476
VDEBUG (data->dev, "%s write %zu IN, status %d\n",
477
data->name, len, (int) value);
485
ep_release (struct inode *inode, struct file *fd)
487
struct ep_data *data = fd->private_data;
490
if ((value = down_interruptible(&data->lock)) < 0)
493
/* clean up if this can be reopened */
494
if (data->state != STATE_EP_UNBOUND) {
495
data->state = STATE_EP_DISABLED;
496
data->desc.bDescriptorType = 0;
497
data->hs_desc.bDescriptorType = 0;
498
usb_ep_disable(data->ep);
505
static long ep_ioctl(struct file *fd, unsigned code, unsigned long value)
507
struct ep_data *data = fd->private_data;
510
if ((status = get_ready_ep (fd->f_flags, data)) < 0)
513
spin_lock_irq (&data->dev->lock);
514
if (likely (data->ep != NULL)) {
516
case GADGETFS_FIFO_STATUS:
517
status = usb_ep_fifo_status (data->ep);
519
case GADGETFS_FIFO_FLUSH:
520
usb_ep_fifo_flush (data->ep);
522
case GADGETFS_CLEAR_HALT:
523
status = usb_ep_clear_halt (data->ep);
530
spin_unlock_irq (&data->dev->lock);
535
/*----------------------------------------------------------------------*/
537
/* ASYNCHRONOUS ENDPOINT I/O OPERATIONS (bulk/intr/iso) */
540
struct usb_request *req;
541
struct ep_data *epdata;
543
const struct iovec *iv;
544
unsigned long nr_segs;
548
static int ep_aio_cancel(struct kiocb *iocb, struct io_event *e)
550
struct kiocb_priv *priv = iocb->private;
551
struct ep_data *epdata;
555
epdata = priv->epdata;
556
// spin_lock(&epdata->dev->lock);
557
kiocbSetCancelled(iocb);
558
if (likely(epdata && epdata->ep && priv->req))
559
value = usb_ep_dequeue (epdata->ep, priv->req);
562
// spin_unlock(&epdata->dev->lock);
569
static ssize_t ep_aio_read_retry(struct kiocb *iocb)
571
struct kiocb_priv *priv = iocb->private;
576
/* we "retry" to get the right mm context for this: */
578
/* copy stuff into user buffers */
579
total = priv->actual;
582
for (i=0; i < priv->nr_segs; i++) {
583
ssize_t this = min((ssize_t)(priv->iv[i].iov_len), total);
585
if (copy_to_user(priv->iv[i].iov_base, to_copy, this)) {
602
static void ep_aio_complete(struct usb_ep *ep, struct usb_request *req)
604
struct kiocb *iocb = req->context;
605
struct kiocb_priv *priv = iocb->private;
606
struct ep_data *epdata = priv->epdata;
608
/* lock against disconnect (and ideally, cancel) */
609
spin_lock(&epdata->dev->lock);
613
/* if this was a write or a read returning no data then we
614
* don't need to copy anything to userspace, so we can
615
* complete the aio request immediately.
617
if (priv->iv == NULL || unlikely(req->actual == 0)) {
620
iocb->private = NULL;
621
/* aio_complete() reports bytes-transferred _and_ faults */
622
aio_complete(iocb, req->actual ? req->actual : req->status,
625
/* retry() won't report both; so we hide some faults */
626
if (unlikely(0 != req->status))
627
DBG(epdata->dev, "%s fault %d len %d\n",
628
ep->name, req->status, req->actual);
630
priv->buf = req->buf;
631
priv->actual = req->actual;
634
spin_unlock(&epdata->dev->lock);
636
usb_ep_free_request(ep, req);
645
struct ep_data *epdata,
646
const struct iovec *iv,
647
unsigned long nr_segs
650
struct kiocb_priv *priv;
651
struct usb_request *req;
654
priv = kmalloc(sizeof *priv, GFP_KERNEL);
661
iocb->private = priv;
663
priv->nr_segs = nr_segs;
665
value = get_ready_ep(iocb->ki_filp->f_flags, epdata);
666
if (unlikely(value < 0)) {
671
iocb->ki_cancel = ep_aio_cancel;
673
priv->epdata = epdata;
676
/* each kiocb is coupled to one usb_request, but we can't
677
* allocate or submit those if the host disconnected.
679
spin_lock_irq(&epdata->dev->lock);
680
if (likely(epdata->ep)) {
681
req = usb_ep_alloc_request(epdata->ep, GFP_ATOMIC);
686
req->complete = ep_aio_complete;
688
value = usb_ep_queue(epdata->ep, req, GFP_ATOMIC);
689
if (unlikely(0 != value))
690
usb_ep_free_request(epdata->ep, req);
695
spin_unlock_irq(&epdata->dev->lock);
699
if (unlikely(value)) {
703
value = (iv ? -EIOCBRETRY : -EIOCBQUEUED);
708
ep_aio_read(struct kiocb *iocb, const struct iovec *iov,
709
unsigned long nr_segs, loff_t o)
711
struct ep_data *epdata = iocb->ki_filp->private_data;
714
if (unlikely(epdata->desc.bEndpointAddress & USB_DIR_IN))
717
buf = kmalloc(iocb->ki_left, GFP_KERNEL);
721
iocb->ki_retry = ep_aio_read_retry;
722
return ep_aio_rwtail(iocb, buf, iocb->ki_left, epdata, iov, nr_segs);
726
ep_aio_write(struct kiocb *iocb, const struct iovec *iov,
727
unsigned long nr_segs, loff_t o)
729
struct ep_data *epdata = iocb->ki_filp->private_data;
734
if (unlikely(!(epdata->desc.bEndpointAddress & USB_DIR_IN)))
737
buf = kmalloc(iocb->ki_left, GFP_KERNEL);
741
for (i=0; i < nr_segs; i++) {
742
if (unlikely(copy_from_user(&buf[len], iov[i].iov_base,
743
iov[i].iov_len) != 0)) {
747
len += iov[i].iov_len;
749
return ep_aio_rwtail(iocb, buf, len, epdata, NULL, 0);
752
/*----------------------------------------------------------------------*/
754
/* used after endpoint configuration */
755
static const struct file_operations ep_io_operations = {
756
.owner = THIS_MODULE,
761
.unlocked_ioctl = ep_ioctl,
762
.release = ep_release,
764
.aio_read = ep_aio_read,
765
.aio_write = ep_aio_write,
768
/* ENDPOINT INITIALIZATION
770
* fd = open ("/dev/gadget/$ENDPOINT", O_RDWR)
771
* status = write (fd, descriptors, sizeof descriptors)
773
* That write establishes the endpoint configuration, configuring
774
* the controller to process bulk, interrupt, or isochronous transfers
775
* at the right maxpacket size, and so on.
777
* The descriptors are message type 1, identified by a host order u32
778
* at the beginning of what's written. Descriptor order is: full/low
779
* speed descriptor, then optional high speed descriptor.
782
ep_config (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
784
struct ep_data *data = fd->private_data;
787
int value, length = len;
789
if ((value = down_interruptible (&data->lock)) < 0)
792
if (data->state != STATE_EP_READY) {
798
if (len < USB_DT_ENDPOINT_SIZE + 4)
801
/* we might need to change message format someday */
802
if (copy_from_user (&tag, buf, 4)) {
806
DBG(data->dev, "config %s, bad tag %d\n", data->name, tag);
812
/* NOTE: audio endpoint extensions not accepted here;
813
* just don't include the extra bytes.
816
/* full/low speed descriptor, then high speed */
817
if (copy_from_user (&data->desc, buf, USB_DT_ENDPOINT_SIZE)) {
820
if (data->desc.bLength != USB_DT_ENDPOINT_SIZE
821
|| data->desc.bDescriptorType != USB_DT_ENDPOINT)
823
if (len != USB_DT_ENDPOINT_SIZE) {
824
if (len != 2 * USB_DT_ENDPOINT_SIZE)
826
if (copy_from_user (&data->hs_desc, buf + USB_DT_ENDPOINT_SIZE,
827
USB_DT_ENDPOINT_SIZE)) {
830
if (data->hs_desc.bLength != USB_DT_ENDPOINT_SIZE
831
|| data->hs_desc.bDescriptorType
832
!= USB_DT_ENDPOINT) {
833
DBG(data->dev, "config %s, bad hs length or type\n",
839
spin_lock_irq (&data->dev->lock);
840
if (data->dev->state == STATE_DEV_UNBOUND) {
843
} else if ((ep = data->ep) == NULL) {
847
switch (data->dev->gadget->speed) {
850
value = usb_ep_enable (ep, &data->desc);
852
data->state = STATE_EP_ENABLED;
854
#ifdef CONFIG_USB_GADGET_DUALSPEED
856
/* fails if caller didn't provide that descriptor... */
857
value = usb_ep_enable (ep, &data->hs_desc);
859
data->state = STATE_EP_ENABLED;
863
DBG(data->dev, "unconnected, %s init abandoned\n",
868
fd->f_op = &ep_io_operations;
872
spin_unlock_irq (&data->dev->lock);
875
data->desc.bDescriptorType = 0;
876
data->hs_desc.bDescriptorType = 0;
889
ep_open (struct inode *inode, struct file *fd)
891
struct ep_data *data = inode->i_private;
893
char *epin = "ep1in";
894
char *epout = "ep1out";
896
if (down_interruptible (&data->lock) != 0)
898
spin_lock_irq (&data->dev->lock);
900
if (data->dev->state == STATE_DEV_UNBOUND)
902
else if (data->state == STATE_EP_DISABLED) {
904
data->state = STATE_EP_READY;
906
fd->private_data = data;
907
VDEBUG (data->dev, "%s ready\n", data->name);
909
if (0 == strcmp(data->name, epin))
910
gp_ep_bulkin_data = fd->private_data;
912
if (0 == strcmp(data->name, epout))
913
gp_ep_bulkout_data = fd->private_data;
915
DBG (data->dev, "%s state %d\n",
916
data->name, data->state);
918
spin_unlock_irq (&data->dev->lock);
923
/* used before endpoint configuration */
924
static const struct file_operations ep_config_operations = {
925
.owner = THIS_MODULE,
930
.release = ep_release,
933
/*----------------------------------------------------------------------*/
935
/* EP0 IMPLEMENTATION can be partly in userspace.
937
* Drivers that use this facility receive various events, including
938
* control requests the kernel doesn't handle. Drivers that don't
939
* use this facility may be too simple-minded for real applications.
942
static inline void ep0_readable (struct dev_data *dev)
944
wake_up (&dev->wait);
945
kill_fasync (&dev->fasync, SIGIO, POLL_IN);
948
static void clean_req (struct usb_ep *ep, struct usb_request *req)
950
struct dev_data *dev = ep->driver_data;
952
if (req->buf != dev->rbuf) {
954
req->buf = dev->rbuf;
955
req->dma = DMA_ADDR_INVALID;
957
req->complete = epio_complete;
958
dev->setup_out_ready = 0;
961
static void ep0_complete (struct usb_ep *ep, struct usb_request *req)
963
struct dev_data *dev = ep->driver_data;
967
/* for control OUT, data must still get to userspace */
968
spin_lock_irqsave(&dev->lock, flags);
969
if (!dev->setup_in) {
970
dev->setup_out_error = (req->status != 0);
971
if (!dev->setup_out_error)
973
dev->setup_out_ready = 1;
977
/* clean up as appropriate */
978
if (free && req->buf != &dev->rbuf)
980
req->complete = epio_complete;
981
spin_unlock_irqrestore(&dev->lock, flags);
984
static int setup_req (struct usb_ep *ep, struct usb_request *req, u16 len)
986
struct dev_data *dev = ep->driver_data;
988
if (dev->setup_out_ready) {
989
DBG (dev, "ep0 request busy!\n");
992
if (len > sizeof (dev->rbuf))
993
req->buf = kmalloc(len, GFP_ATOMIC);
994
if (req->buf == NULL) {
995
req->buf = dev->rbuf;
998
req->complete = ep0_complete;
1005
ep0_read (struct file *fd, char __user *buf, size_t len, loff_t *ptr)
1007
struct dev_data *dev = fd->private_data;
1009
enum ep0_state state;
1011
spin_lock_irq (&dev->lock);
1013
/* report fd mode change before acting on it */
1014
if (dev->setup_abort) {
1015
dev->setup_abort = 0;
1020
/* control DATA stage */
1021
if ((state = dev->state) == STATE_DEV_SETUP) {
1023
if (dev->setup_in) { /* stall IN */
1024
VDEBUG(dev, "ep0in stall\n");
1025
(void) usb_ep_set_halt (dev->gadget->ep0);
1027
dev->state = STATE_DEV_CONNECTED;
1029
} else if (len == 0) { /* ack SET_CONFIGURATION etc */
1030
struct usb_ep *ep = dev->gadget->ep0;
1031
struct usb_request *req = dev->req;
1033
if ((retval = setup_req (ep, req, 0)) == 0)
1034
retval = usb_ep_queue (ep, req, GFP_ATOMIC);
1035
dev->state = STATE_DEV_CONNECTED;
1037
/* assume that was SET_CONFIGURATION */
1038
if (dev->current_config) {
1041
if (gadget_is_dualspeed(dev->gadget)
1042
&& (dev->gadget->speed
1044
power = dev->hs_config->bMaxPower;
1046
power = dev->config->bMaxPower;
1047
usb_gadget_vbus_draw(dev->gadget, 2 * power);
1050
} else { /* collect OUT data */
1051
if ((fd->f_flags & O_NONBLOCK) != 0
1052
&& !dev->setup_out_ready) {
1056
spin_unlock_irq (&dev->lock);
1057
retval = wait_event_interruptible (dev->wait,
1058
dev->setup_out_ready != 0);
1060
/* FIXME state could change from under us */
1061
spin_lock_irq (&dev->lock);
1065
if (dev->state != STATE_DEV_SETUP) {
1066
retval = -ECANCELED;
1069
dev->state = STATE_DEV_CONNECTED;
1071
if (dev->setup_out_error)
1074
len = min (len, (size_t)dev->req->actual);
1075
/* FIXME don't call this with the spinlock held ... */
1076
if (copy_to_user (buf, dev->req->buf, len))
1079
/* Bug of Cancel IO 6 bytes read. */
1081
clean_req (dev->gadget->ep0, dev->req);
1082
/* NOTE userspace can't yet choose to stall */
1083
dev->state = STATE_DEV_CONNECTED; /* Cancel IO */
1089
/* else normal: return event data */
1090
if (len < sizeof dev->event [0]) {
1094
len -= len % sizeof (struct usb_gadgetfs_event);
1095
dev->usermode_setup = 1;
1097
/* Cancel IO, signal abort blocked IO. */
1098
if (mtp_ctrl_cmd == 1) {
1100
schedule_delayed_work(&cancel_work, HZ / 100);
1104
/* return queued events right away */
1105
if (dev->ev_next != 0) {
1108
n = len / sizeof (struct usb_gadgetfs_event);
1109
if (dev->ev_next < n)
1112
/* ep0 i/o has special semantics during STATE_DEV_SETUP */
1113
for (i = 0; i < n; i++) {
1114
if (dev->event [i].type == GADGETFS_SETUP) {
1115
dev->state = STATE_DEV_SETUP;
1120
spin_unlock_irq (&dev->lock);
1121
len = n * sizeof (struct usb_gadgetfs_event);
1122
if (copy_to_user (buf, &dev->event, len))
1127
/* NOTE this doesn't guard against broken drivers;
1128
* concurrent ep0 readers may lose events.
1130
spin_lock_irq (&dev->lock);
1131
if (dev->ev_next > n) {
1132
memmove(&dev->event[0], &dev->event[n],
1133
sizeof (struct usb_gadgetfs_event)
1134
* (dev->ev_next - n));
1137
spin_unlock_irq (&dev->lock);
1141
if (fd->f_flags & O_NONBLOCK) {
1148
DBG (dev, "fail %s, state %d\n", __func__, state);
1151
case STATE_DEV_UNCONNECTED:
1152
case STATE_DEV_CONNECTED:
1153
spin_unlock_irq (&dev->lock);
1154
DBG (dev, "%s wait\n", __func__);
1156
/* wait for events */
1157
retval = wait_event_interruptible (dev->wait,
1161
spin_lock_irq (&dev->lock);
1166
spin_unlock_irq (&dev->lock);
1170
static struct usb_gadgetfs_event *
1171
next_event (struct dev_data *dev, enum usb_gadgetfs_event_type type)
1173
struct usb_gadgetfs_event *event;
1177
/* these events purge the queue */
1178
case GADGETFS_DISCONNECT:
1179
if (dev->state == STATE_DEV_SETUP)
1180
dev->setup_abort = 1;
1182
case GADGETFS_CONNECT:
1185
case GADGETFS_SETUP: /* previous request timed out */
1186
case GADGETFS_SUSPEND: /* same effect */
1187
/* these events can't be repeated */
1188
for (i = 0; i != dev->ev_next; i++) {
1189
if (dev->event [i].type != type)
1191
DBG(dev, "discard old event[%d] %d\n", i, type);
1193
if (i == dev->ev_next)
1195
/* indices start at zero, for simplicity */
1196
memmove (&dev->event [i], &dev->event [i + 1],
1197
sizeof (struct usb_gadgetfs_event)
1198
* (dev->ev_next - i));
1204
VDEBUG(dev, "event[%d] = %d\n", dev->ev_next, type);
1205
event = &dev->event [dev->ev_next++];
1206
BUG_ON (dev->ev_next > N_EVENT);
1207
memset (event, 0, sizeof *event);
1213
ep0_write (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
1215
struct dev_data *dev = fd->private_data;
1216
ssize_t retval = -ESRCH;
1218
spin_lock_irq (&dev->lock);
1220
/* report fd mode change before acting on it */
1221
if (dev->setup_abort) {
1222
dev->setup_abort = 0;
1225
/* data and/or status stage for control request */
1226
} else if (dev->state == STATE_DEV_SETUP) {
1228
/* IN DATA+STATUS caller makes len <= wLength */
1229
if (dev->setup_in) {
1230
retval = setup_req (dev->gadget->ep0, dev->req, len);
1232
dev->state = STATE_DEV_CONNECTED;
1233
spin_unlock_irq (&dev->lock);
1234
if (copy_from_user (dev->req->buf, buf, len))
1237
if (len < dev->setup_wLength)
1239
retval = usb_ep_queue (
1240
dev->gadget->ep0, dev->req,
1244
spin_lock_irq (&dev->lock);
1245
clean_req (dev->gadget->ep0, dev->req);
1246
spin_unlock_irq (&dev->lock);
1253
/* can stall some OUT transfers */
1254
} else if (dev->setup_can_stall) {
1255
VDEBUG(dev, "ep0out stall\n");
1256
(void) usb_ep_set_halt (dev->gadget->ep0);
1258
dev->state = STATE_DEV_CONNECTED;
1260
DBG(dev, "bogus ep0out stall!\n");
1263
DBG (dev, "fail %s, state %d\n", __func__, dev->state);
1265
spin_unlock_irq (&dev->lock);
1270
ep0_fasync (int f, struct file *fd, int on)
1272
struct dev_data *dev = fd->private_data;
1273
// caller must F_SETOWN before signal delivery happens
1274
VDEBUG (dev, "%s %s\n", __func__, on ? "on" : "off");
1275
return fasync_helper (f, fd, on, &dev->fasync);
1278
static struct usb_gadget_driver gadgetfs_driver;
1281
dev_release (struct inode *inode, struct file *fd)
1283
struct dev_data *dev = fd->private_data;
1285
/* closing ep0 === shutdown all */
1287
usb_gadget_unregister_driver (&gadgetfs_driver);
1289
/* at this point "good" hardware has disconnected the
1290
* device from USB; the host won't see it any more.
1291
* alternatively, all host requests will time out.
1298
/* other endpoints were all decoupled from this device */
1299
spin_lock_irq(&dev->lock);
1300
dev->state = STATE_DEV_DISABLED;
1301
spin_unlock_irq(&dev->lock);
1306
ep0_poll (struct file *fd, poll_table *wait)
1308
struct dev_data *dev = fd->private_data;
1311
poll_wait(fd, &dev->wait, wait);
1313
spin_lock_irq (&dev->lock);
1315
/* report fd mode change before acting on it */
1316
if (dev->setup_abort) {
1317
dev->setup_abort = 0;
1322
if (dev->state == STATE_DEV_SETUP) {
1323
if (dev->setup_in || dev->setup_can_stall)
1326
if (dev->ev_next != 0)
1330
spin_unlock_irq(&dev->lock);
1334
static long dev_ioctl (struct file *fd, unsigned code, unsigned long value)
1336
struct dev_data *dev = fd->private_data;
1337
struct usb_gadget *gadget = dev->gadget;
1340
if (gadget->ops->ioctl) {
1342
ret = gadget->ops->ioctl (gadget, code, value);
1348
/* used after device configuration */
1349
static const struct file_operations ep0_io_operations = {
1350
.owner = THIS_MODULE,
1351
.llseek = no_llseek,
1355
.fasync = ep0_fasync,
1357
.unlocked_ioctl = dev_ioctl,
1358
.release = dev_release,
1361
/*----------------------------------------------------------------------*/
1363
/* The in-kernel gadget driver handles most ep0 issues, in particular
1364
* enumerating the single configuration (as provided from user space).
1366
* Unrecognized ep0 requests may be handled in user space.
1369
#ifdef CONFIG_USB_GADGET_DUALSPEED
1370
static void make_qualifier (struct dev_data *dev)
1372
struct usb_qualifier_descriptor qual;
1373
struct usb_device_descriptor *desc;
1375
qual.bLength = sizeof qual;
1376
qual.bDescriptorType = USB_DT_DEVICE_QUALIFIER;
1377
qual.bcdUSB = __constant_cpu_to_le16 (0x0200);
1380
qual.bDeviceClass = desc->bDeviceClass;
1381
qual.bDeviceSubClass = desc->bDeviceSubClass;
1382
qual.bDeviceProtocol = desc->bDeviceProtocol;
1384
/* assumes ep0 uses the same value for both speeds ... */
1385
qual.bMaxPacketSize0 = desc->bMaxPacketSize0;
1387
qual.bNumConfigurations = 1;
1390
memcpy (dev->rbuf, &qual, sizeof qual);
1395
config_buf (struct dev_data *dev, u8 type, unsigned index)
1400
/* only one configuration */
1404
if (gadget_is_dualspeed(dev->gadget)) {
1405
hs = (dev->gadget->speed == USB_SPEED_HIGH);
1406
if (type == USB_DT_OTHER_SPEED_CONFIG)
1410
dev->req->buf = dev->hs_config;
1411
len = le16_to_cpu(dev->hs_config->wTotalLength);
1413
dev->req->buf = dev->config;
1414
len = le16_to_cpu(dev->config->wTotalLength);
1416
((u8 *)dev->req->buf) [1] = type;
1421
gadgetfs_setup (struct usb_gadget *gadget, const struct usb_ctrlrequest *ctrl)
1423
struct dev_data *dev = get_gadget_data (gadget);
1424
struct usb_request *req = dev->req;
1425
int value = -EOPNOTSUPP;
1426
struct usb_gadgetfs_event *event;
1427
u16 w_value = le16_to_cpu(ctrl->wValue);
1428
u16 w_length = le16_to_cpu(ctrl->wLength);
1432
if (0x67 == ctrl->bRequest && 1 == gbCancelFlag
1433
&& dev->state == STATE_DEV_SETUP)
1434
dev->state = STATE_DEV_CONNECTED;
1436
if (0x67 == ctrl->bRequest && 2 == mtp_ctrl_cmd
1437
&& dev->state == STATE_DEV_SETUP)
1438
dev->state = STATE_DEV_CONNECTED;
1440
spin_lock (&dev->lock);
1441
dev->setup_abort = 0;
1442
if (dev->state == STATE_DEV_UNCONNECTED) {
1443
if (gadget_is_dualspeed(gadget)
1444
&& gadget->speed == USB_SPEED_HIGH
1445
&& dev->hs_config == NULL) {
1446
spin_unlock(&dev->lock);
1447
ERROR (dev, "no high speed config??\n");
1451
dev->state = STATE_DEV_CONNECTED;
1452
dev->dev->bMaxPacketSize0 = gadget->ep0->maxpacket;
1454
INFO (dev, "connected\n");
1455
event = next_event (dev, GADGETFS_CONNECT);
1456
event->u.speed = gadget->speed;
1459
/* host may have given up waiting for response. we can miss control
1460
* requests handled lower down (device/endpoint status and features);
1461
* then ep0_{read,write} will report the wrong status. controller
1462
* driver will have aborted pending i/o.
1464
} else if (dev->state == STATE_DEV_SETUP)
1465
dev->setup_abort = 1;
1467
if (mtp_ctrl_cmd == 1 && gbCancelFlag == 1 && dev->setup_abort == 1) {
1468
INFO(dev, "0x64->setup\n");
1469
dev->setup_abort = 0;
1472
req->buf = dev->rbuf;
1473
req->dma = DMA_ADDR_INVALID;
1474
req->context = NULL;
1475
value = -EOPNOTSUPP;
1476
switch (ctrl->bRequest) {
1478
case USB_REQ_GET_DESCRIPTOR:
1479
if (ctrl->bRequestType != USB_DIR_IN)
1481
switch (w_value >> 8) {
1484
value = min (w_length, (u16) sizeof *dev->dev);
1485
req->buf = dev->dev;
1487
#ifdef CONFIG_USB_GADGET_DUALSPEED
1488
case USB_DT_DEVICE_QUALIFIER:
1489
if (!dev->hs_config)
1491
value = min (w_length, (u16)
1492
sizeof (struct usb_qualifier_descriptor));
1493
make_qualifier (dev);
1495
case USB_DT_OTHER_SPEED_CONFIG:
1499
value = config_buf (dev,
1503
value = min (w_length, (u16) value);
1508
default: // all others are errors
1513
/* currently one config, two speeds */
1514
case USB_REQ_SET_CONFIGURATION:
1515
if (ctrl->bRequestType != 0)
1517
if (0 == (u8) w_value) {
1519
dev->current_config = 0;
1520
usb_gadget_vbus_draw(gadget, 8 /* mA */ );
1521
// user mode expected to disable endpoints
1525
if (gadget_is_dualspeed(gadget)
1526
&& gadget->speed == USB_SPEED_HIGH) {
1527
config = dev->hs_config->bConfigurationValue;
1528
power = dev->hs_config->bMaxPower;
1530
config = dev->config->bConfigurationValue;
1531
power = dev->config->bMaxPower;
1534
if (config == (u8) w_value) {
1536
dev->current_config = config;
1537
usb_gadget_vbus_draw(gadget, 2 * power);
1541
/* report SET_CONFIGURATION like any other control request,
1542
* except that usermode may not stall this. the next
1543
* request mustn't be allowed start until this finishes:
1544
* endpoints and threads set up, etc.
1546
* NOTE: older PXA hardware (before PXA 255: without UDCCFR)
1547
* has bad/racey automagic that prevents synchronizing here.
1548
* even kernel mode drivers often miss them.
1551
INFO (dev, "configuration #%d\n", dev->current_config);
1552
if (dev->usermode_setup) {
1553
dev->setup_can_stall = 0;
1559
#ifndef CONFIG_USB_GADGET_PXA25X
1560
/* PXA automagically handles this request too */
1561
case USB_REQ_GET_CONFIGURATION:
1562
if (ctrl->bRequestType != 0x80)
1564
*(u8 *)req->buf = dev->current_config;
1565
value = min (w_length, (u16) 1);
1571
VDEBUG (dev, "%s req%02x.%02x v%04x i%04x l%d\n",
1572
dev->usermode_setup ? "delegate" : "fail",
1573
ctrl->bRequestType, ctrl->bRequest,
1574
w_value, le16_to_cpu(ctrl->wIndex), w_length);
1576
/* if there's an ep0 reader, don't stall */
1577
if (dev->usermode_setup) {
1578
dev->setup_can_stall = 1;
1580
dev->setup_in = (ctrl->bRequestType & USB_DIR_IN)
1582
dev->setup_wLength = w_length;
1583
dev->setup_out_ready = 0;
1584
dev->setup_out_error = 0;
1587
/* read DATA stage for OUT right away */
1588
if (unlikely (!dev->setup_in && w_length)) {
1589
value = setup_req (gadget->ep0, dev->req,
1593
value = usb_ep_queue (gadget->ep0, dev->req,
1596
clean_req (gadget->ep0, dev->req);
1600
/* we can't currently stall these */
1601
dev->setup_can_stall = 0;
1604
if (0x67 == ctrl->bRequest && 1 == gbCancelFlag) {
1607
setup_req(gadget->ep0, dev->req, 4);
1608
*(unsigned long *)dev->req->buf = 0x20190004;
1609
usb_ep_queue(gadget->ep0, dev->req, GFP_ATOMIC);
1611
spin_unlock(&dev->lock);
1614
if (ctrl->bRequest == 0x67 && mtp_ctrl_cmd == 2) {
1619
/* state changes when reader collects event */
1620
event = next_event (dev, GADGETFS_SETUP);
1621
event->u.setup = *ctrl;
1623
if (0x64 == ctrl->bRequest) {
1627
/* get the timestamp */
1628
do_gettimeofday(&tv);
1629
mtptimestamp = tv.tv_usec;
1630
event->u.setup.wValue =
1631
(unsigned short)tv.tv_usec;
1633
if (0x66 == ctrl->bRequest) {
1634
/* get the timestamp */
1635
do_gettimeofday(&tv);
1636
mtptimestamp = tv.tv_usec;
1637
event->u.setup.wValue =
1638
(unsigned short)tv.tv_usec;
1642
/* Reset request. */
1643
if (ctrl->bRequest == 0x66) { /* reset ,send ZLP */
1646
if (gp_ep_bulkout_data->req->status ==
1648
usb_ep_dequeue(gp_ep_bulkout_data->ep,
1649
gp_ep_bulkout_data->req);
1651
if (gp_ep_bulkin_data->req->status ==
1653
usb_ep_dequeue(gp_ep_bulkin_data->ep,
1654
gp_ep_bulkin_data->req);
1657
if (ctrl->bRequest == 0x65)
1658
pr_debug("i:0x65,not supported\n");
1660
spin_unlock (&dev->lock);
1665
/* proceed with data transfer and status phases? */
1666
if (value >= 0 && dev->state != STATE_DEV_SETUP) {
1667
req->length = value;
1668
req->zero = value < w_length;
1669
value = usb_ep_queue (gadget->ep0, req, GFP_ATOMIC);
1671
DBG (dev, "ep_queue --> %d\n", value);
1676
/* device stalls when value < 0 */
1677
spin_unlock (&dev->lock);
1681
static void destroy_ep_files (struct dev_data *dev)
1683
struct list_head *entry, *tmp;
1685
DBG (dev, "%s %d\n", __func__, dev->state);
1687
/* dev->state must prevent interference */
1689
spin_lock_irq (&dev->lock);
1690
list_for_each_safe (entry, tmp, &dev->epfiles) {
1692
struct inode *parent;
1693
struct dentry *dentry;
1695
/* break link to FS */
1696
ep = list_entry (entry, struct ep_data, epfiles);
1697
list_del_init (&ep->epfiles);
1698
dentry = ep->dentry;
1700
parent = dentry->d_parent->d_inode;
1702
/* break link to controller */
1703
if (ep->state == STATE_EP_ENABLED)
1704
(void) usb_ep_disable (ep->ep);
1705
ep->state = STATE_EP_UNBOUND;
1706
usb_ep_free_request (ep->ep, ep->req);
1708
wake_up (&ep->wait);
1711
spin_unlock_irq (&dev->lock);
1713
/* break link to dcache */
1714
mutex_lock (&parent->i_mutex);
1717
mutex_unlock (&parent->i_mutex);
1719
/* fds may still be open */
1722
spin_unlock_irq (&dev->lock);
1726
static struct inode *
1727
gadgetfs_create_file (struct super_block *sb, char const *name,
1728
void *data, const struct file_operations *fops,
1729
struct dentry **dentry_p);
1731
static int activate_ep_files (struct dev_data *dev)
1734
struct ep_data *data;
1736
gadget_for_each_ep (ep, dev->gadget) {
1738
data = kzalloc(sizeof(*data), GFP_KERNEL);
1741
data->state = STATE_EP_DISABLED;
1742
init_MUTEX (&data->lock);
1743
init_waitqueue_head (&data->wait);
1745
strncpy (data->name, ep->name, sizeof (data->name) - 1);
1746
atomic_set (&data->count, 1);
1751
ep->driver_data = data;
1753
data->req = usb_ep_alloc_request (ep, GFP_KERNEL);
1757
data->inode = gadgetfs_create_file (dev->sb, data->name,
1758
data, &ep_config_operations,
1762
list_add_tail (&data->epfiles, &dev->epfiles);
1767
usb_ep_free_request (ep, data->req);
1772
DBG (dev, "%s enomem\n", __func__);
1773
destroy_ep_files (dev);
1778
gadgetfs_unbind (struct usb_gadget *gadget)
1780
struct dev_data *dev = get_gadget_data (gadget);
1782
DBG (dev, "%s\n", __func__);
1784
spin_lock_irq (&dev->lock);
1785
dev->state = STATE_DEV_UNBOUND;
1786
spin_unlock_irq (&dev->lock);
1788
destroy_ep_files (dev);
1789
gadget->ep0->driver_data = NULL;
1790
set_gadget_data (gadget, NULL);
1792
/* we've already been disconnected ... no i/o is active */
1794
usb_ep_free_request (gadget->ep0, dev->req);
1795
DBG (dev, "%s done\n", __func__);
1799
static struct dev_data *the_device;
1802
gadgetfs_bind (struct usb_gadget *gadget)
1804
struct dev_data *dev = the_device;
1808
if (0 != strcmp (CHIP, gadget->name)) {
1809
pr_err("%s expected %s controller not %s\n",
1810
shortname, CHIP, gadget->name);
1814
set_gadget_data (gadget, dev);
1815
dev->gadget = gadget;
1816
gadget->ep0->driver_data = dev;
1817
dev->dev->bMaxPacketSize0 = gadget->ep0->maxpacket;
1819
/* preallocate control response and buffer */
1820
dev->req = usb_ep_alloc_request (gadget->ep0, GFP_KERNEL);
1823
dev->req->context = NULL;
1824
dev->req->complete = epio_complete;
1826
if (activate_ep_files (dev) < 0)
1829
INFO (dev, "bound to %s driver\n", gadget->name);
1830
spin_lock_irq(&dev->lock);
1831
dev->state = STATE_DEV_UNCONNECTED;
1832
spin_unlock_irq(&dev->lock);
1837
gadgetfs_unbind (gadget);
1842
gadgetfs_disconnect (struct usb_gadget *gadget)
1844
struct dev_data *dev = get_gadget_data (gadget);
1846
spin_lock (&dev->lock);
1847
if (dev->state == STATE_DEV_UNCONNECTED)
1849
dev->state = STATE_DEV_UNCONNECTED;
1851
INFO (dev, "disconnected\n");
1852
next_event (dev, GADGETFS_DISCONNECT);
1855
spin_unlock (&dev->lock);
1859
gadgetfs_suspend (struct usb_gadget *gadget)
1861
struct dev_data *dev = get_gadget_data (gadget);
1863
INFO (dev, "suspended from state %d\n", dev->state);
1864
spin_lock (&dev->lock);
1865
switch (dev->state) {
1866
case STATE_DEV_SETUP: // VERY odd... host died??
1867
case STATE_DEV_CONNECTED:
1868
case STATE_DEV_UNCONNECTED:
1869
next_event (dev, GADGETFS_SUSPEND);
1875
spin_unlock (&dev->lock);
1878
static struct usb_gadget_driver gadgetfs_driver = {
1879
#ifdef CONFIG_USB_GADGET_DUALSPEED
1880
.speed = USB_SPEED_HIGH,
1882
.speed = USB_SPEED_FULL,
1884
.function = (char *) driver_desc,
1885
.bind = gadgetfs_bind,
1886
.unbind = gadgetfs_unbind,
1887
.setup = gadgetfs_setup,
1888
.disconnect = gadgetfs_disconnect,
1889
.suspend = gadgetfs_suspend,
1892
.name = (char *) shortname,
1896
/*----------------------------------------------------------------------*/
1898
static void gadgetfs_nop(struct usb_gadget *arg) { }
1900
static int gadgetfs_probe (struct usb_gadget *gadget)
1902
CHIP = gadget->name;
1906
static struct usb_gadget_driver probe_driver = {
1907
.speed = USB_SPEED_HIGH,
1908
.bind = gadgetfs_probe,
1909
.unbind = gadgetfs_nop,
1910
.setup = (void *)gadgetfs_nop,
1911
.disconnect = gadgetfs_nop,
1918
/* DEVICE INITIALIZATION
1920
* fd = open ("/dev/gadget/$CHIP", O_RDWR)
1921
* status = write (fd, descriptors, sizeof descriptors)
1923
* That write establishes the device configuration, so the kernel can
1924
* bind to the controller ... guaranteeing it can handle enumeration
1925
* at all necessary speeds. Descriptor order is:
1927
* . message tag (u32, host order) ... for now, must be zero; it
1928
* would change to support features like multi-config devices
1929
* . full/low speed config ... all wTotalLength bytes (with interface,
1930
* class, altsetting, endpoint, and other descriptors)
1931
* . high speed config ... all descriptors, for high speed operation;
1932
* this one's optional except for high-speed hardware
1933
* . device descriptor
1935
* Endpoints are not yet enabled. Drivers must wait until device
1936
* configuration and interface altsetting changes create
1937
* the need to configure (or unconfigure) them.
1939
* After initialization, the device stays active for as long as that
1940
* $CHIP file is open. Events must then be read from that descriptor,
1941
* such as configuration notifications.
1944
static int is_valid_config (struct usb_config_descriptor *config)
1946
return config->bDescriptorType == USB_DT_CONFIG
1947
&& config->bLength == USB_DT_CONFIG_SIZE
1948
&& config->bConfigurationValue != 0
1949
&& (config->bmAttributes & USB_CONFIG_ATT_ONE) != 0
1950
&& (config->bmAttributes & USB_CONFIG_ATT_WAKEUP) == 0;
1951
/* FIXME if gadget->is_otg, _must_ include an otg descriptor */
1952
/* FIXME check lengths: walk to end */
1956
dev_config (struct file *fd, const char __user *buf, size_t len, loff_t *ptr)
1958
struct dev_data *dev = fd->private_data;
1959
ssize_t value = len, length = len;
1964
if (len < (USB_DT_CONFIG_SIZE + USB_DT_DEVICE_SIZE + 4))
1967
/* we might need to change message format someday */
1968
if (copy_from_user (&tag, buf, 4))
1975
kbuf = kmalloc (length, GFP_KERNEL);
1978
if (copy_from_user (kbuf, buf, length)) {
1983
spin_lock_irq (&dev->lock);
1989
/* full or low speed config */
1990
dev->config = (void *) kbuf;
1991
total = le16_to_cpu(dev->config->wTotalLength);
1992
if (!is_valid_config (dev->config) || total >= length)
1997
/* optional high speed config */
1998
if (kbuf [1] == USB_DT_CONFIG) {
1999
dev->hs_config = (void *) kbuf;
2000
total = le16_to_cpu(dev->hs_config->wTotalLength);
2001
if (!is_valid_config (dev->hs_config) || total >= length)
2007
/* could support multiple configs, using another encoding! */
2009
/* device descriptor (tweaked for paranoia) */
2010
if (length != USB_DT_DEVICE_SIZE)
2012
dev->dev = (void *)kbuf;
2013
if (dev->dev->bLength != USB_DT_DEVICE_SIZE
2014
|| dev->dev->bDescriptorType != USB_DT_DEVICE
2015
|| dev->dev->bNumConfigurations != 1)
2017
dev->dev->bNumConfigurations = 1;
2018
dev->dev->bcdUSB = __constant_cpu_to_le16 (0x0200);
2020
/* triggers gadgetfs_bind(); then we can enumerate. */
2021
spin_unlock_irq (&dev->lock);
2022
value = usb_gadget_register_driver (&gadgetfs_driver);
2027
/* at this point "good" hardware has for the first time
2028
* let the USB the host see us. alternatively, if users
2029
* unplug/replug that will clear all the error state.
2031
* note: everything running before here was guaranteed
2032
* to choke driver model style diagnostics. from here
2033
* on, they can work ... except in cleanup paths that
2034
* kick in after the ep0 descriptor is closed.
2036
fd->f_op = &ep0_io_operations;
2042
spin_unlock_irq (&dev->lock);
2043
pr_debug ("%s: %s fail %Zd, %p\n", shortname, __func__, value, dev);
2050
dev_open (struct inode *inode, struct file *fd)
2052
struct dev_data *dev = inode->i_private;
2055
spin_lock_irq(&dev->lock);
2056
if (dev->state == STATE_DEV_DISABLED) {
2058
dev->state = STATE_DEV_OPENED;
2059
fd->private_data = dev;
2063
spin_unlock_irq(&dev->lock);
2067
static const struct file_operations dev_init_operations = {
2068
.owner = THIS_MODULE,
2069
.llseek = no_llseek,
2072
.write = dev_config,
2073
.fasync = ep0_fasync,
2074
.unlocked_ioctl = dev_ioctl,
2075
.release = dev_release,
2078
/*----------------------------------------------------------------------*/
2080
/* FILESYSTEM AND SUPERBLOCK OPERATIONS
2082
* Mounting the filesystem creates a controller file, used first for
2083
* device configuration then later for event monitoring.
2087
/* FIXME PAM etc could set this security policy without mount options
2088
* if epfiles inherited ownership and permissons from ep0 ...
2091
static unsigned default_uid;
2092
static unsigned default_gid;
2093
static unsigned default_perm = S_IRUSR | S_IWUSR;
2095
module_param (default_uid, uint, 0644);
2096
module_param (default_gid, uint, 0644);
2097
module_param (default_perm, uint, 0644);
2100
static struct inode *
2101
gadgetfs_make_inode (struct super_block *sb,
2102
void *data, const struct file_operations *fops,
2105
struct inode *inode = new_inode (sb);
2108
inode->i_mode = mode;
2109
inode->i_uid = default_uid;
2110
inode->i_gid = default_gid;
2111
inode->i_blocks = 0;
2112
inode->i_atime = inode->i_mtime = inode->i_ctime
2114
inode->i_private = data;
2115
inode->i_fop = fops;
2120
/* creates in fs root directory, so non-renamable and non-linkable.
2121
* so inode and dentry are paired, until device reconfig.
2123
static struct inode *
2124
gadgetfs_create_file (struct super_block *sb, char const *name,
2125
void *data, const struct file_operations *fops,
2126
struct dentry **dentry_p)
2128
struct dentry *dentry;
2129
struct inode *inode;
2131
dentry = d_alloc_name(sb->s_root, name);
2135
inode = gadgetfs_make_inode (sb, data, fops,
2136
S_IFREG | (default_perm & S_IRWXUGO));
2141
d_add (dentry, inode);
2146
static struct super_operations gadget_fs_operations = {
2147
.statfs = simple_statfs,
2148
.drop_inode = generic_delete_inode,
2152
gadgetfs_fill_super (struct super_block *sb, void *opts, int silent)
2154
struct inode *inode;
2156
struct dev_data *dev;
2161
/* fake probe to determine $CHIP */
2162
(void) usb_gadget_register_driver (&probe_driver);
2167
sb->s_blocksize = PAGE_CACHE_SIZE;
2168
sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
2169
sb->s_magic = GADGETFS_MAGIC;
2170
sb->s_op = &gadget_fs_operations;
2171
sb->s_time_gran = 1;
2174
inode = gadgetfs_make_inode (sb,
2175
NULL, &simple_dir_operations,
2176
S_IFDIR | S_IRUGO | S_IXUGO);
2179
inode->i_op = &simple_dir_inode_operations;
2180
if (!(d = d_alloc_root (inode)))
2184
/* the ep0 file is named after the controller we expect;
2185
* user mode code can use it for sanity checks, like we do.
2192
if (!gadgetfs_create_file (sb, CHIP,
2193
dev, &dev_init_operations,
2197
/* other endpoint files are available after hardware setup,
2198
* from binding to a controller.
2213
/* "mount -t gadgetfs path /dev/gadget" ends up here */
2215
gadgetfs_get_sb (struct file_system_type *t, int flags,
2216
const char *path, void *opts, struct vfsmount *mnt)
2218
return get_sb_single (t, flags, opts, gadgetfs_fill_super, mnt);
2222
gadgetfs_kill_sb (struct super_block *sb)
2224
kill_litter_super (sb);
2226
put_dev (the_device);
2231
/*----------------------------------------------------------------------*/
2233
static struct file_system_type gadgetfs_type = {
2234
.owner = THIS_MODULE,
2236
.get_sb = gadgetfs_get_sb,
2237
.kill_sb = gadgetfs_kill_sb,
2240
/*----------------------------------------------------------------------*/
2242
static int __init init (void)
2246
status = register_filesystem (&gadgetfs_type);
2248
pr_info ("%s: %s, version " DRIVER_VERSION "\n",
2249
shortname, driver_desc);
2254
static void __exit cleanup (void)
2256
pr_debug ("unregister %s\n", shortname);
2257
unregister_filesystem (&gadgetfs_type);
2259
module_exit (cleanup);
added
removed
drivers/usb/gadget/arm_mxc_ubuntu_inode.c
