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.
14 /* #define VERBOSE_DEBUG */
16 #include <linux/init.h>
17 #include <linux/module.h>
19 #include <linux/pagemap.h>
20 #include <linux/uts.h>
21 #include <linux/wait.h>
22 #include <linux/compiler.h>
23 #include <asm/uaccess.h>
24 #include <linux/sched.h>
25 #include <linux/slab.h>
26 #include <linux/poll.h>
28 #include <linux/device.h>
29 #include <linux/moduleparam.h>
31 #include <linux/usb/gadgetfs.h>
32 #include <linux/usb/gadget.h>
36 * The gadgetfs API maps each endpoint to a file descriptor so that you
37 * can use standard synchronous read/write calls for I/O. There's some
38 * O_NONBLOCK and O_ASYNC/FASYNC style i/o support. Example usermode
39 * drivers show how this works in practice. You can also use AIO to
40 * eliminate I/O gaps between requests, to help when streaming data.
42 * Key parts that must be USB-specific are protocols defining how the
43 * read/write operations relate to the hardware state machines. There
44 * are two types of files. One type is for the device, implementing ep0.
45 * The other type is for each IN or OUT endpoint. In both cases, the
46 * user mode driver must configure the hardware before using it.
48 * - First, dev_config() is called when /dev/gadget/$CHIP is configured
49 * (by writing configuration and device descriptors). Afterwards it
50 * may serve as a source of device events, used to handle all control
51 * requests other than basic enumeration.
53 * - Then, after a SET_CONFIGURATION control request, ep_config() is
54 * called when each /dev/gadget/ep* file is configured (by writing
55 * endpoint descriptors). Afterwards these files are used to write()
56 * IN data or to read() OUT data. To halt the endpoint, a "wrong
57 * direction" request is issued (like reading an IN endpoint).
59 * Unlike "usbfs" the only ioctl()s are for things that are rare, and maybe
60 * not possible on all hardware. For example, precise fault handling with
61 * respect to data left in endpoint fifos after aborted operations; or
62 * selective clearing of endpoint halts, to implement SET_INTERFACE.
65 #define DRIVER_DESC "USB Gadget filesystem"
66 #define DRIVER_VERSION "24 Aug 2004"
68 static const char driver_desc
[] = DRIVER_DESC
;
69 static const char shortname
[] = "gadgetfs";
71 MODULE_DESCRIPTION (DRIVER_DESC
);
72 MODULE_AUTHOR ("David Brownell");
73 MODULE_LICENSE ("GPL");
76 /*----------------------------------------------------------------------*/
78 #define GADGETFS_MAGIC 0xaee71ee7
80 /* /dev/gadget/$CHIP represents ep0 and the whole device */
82 /* DISBLED is the initial state.
84 STATE_DEV_DISABLED
= 0,
86 /* Only one open() of /dev/gadget/$CHIP; only one file tracks
87 * ep0/device i/o modes and binding to the controller. Driver
88 * must always write descriptors to initialize the device, then
89 * the device becomes UNCONNECTED until enumeration.
93 /* From then on, ep0 fd is in either of two basic modes:
94 * - (UN)CONNECTED: read usb_gadgetfs_event(s) from it
95 * - SETUP: read/write will transfer control data and succeed;
96 * or if "wrong direction", performs protocol stall
98 STATE_DEV_UNCONNECTED
,
102 /* UNBOUND means the driver closed ep0, so the device won't be
103 * accessible again (DEV_DISABLED) until all fds are closed.
108 /* enough for the whole queue: most events invalidate others */
114 enum ep0_state state
; /* P: lock */
115 struct usb_gadgetfs_event event
[N_EVENT
];
117 struct fasync_struct
*fasync
;
120 /* drivers reading ep0 MUST handle control requests (SETUP)
121 * reported that way; else the host will time out.
123 unsigned usermode_setup
: 1,
129 unsigned setup_wLength
;
131 /* the rest is basically write-once */
132 struct usb_config_descriptor
*config
, *hs_config
;
133 struct usb_device_descriptor
*dev
;
134 struct usb_request
*req
;
135 struct usb_gadget
*gadget
;
136 struct list_head epfiles
;
138 wait_queue_head_t wait
;
139 struct super_block
*sb
;
140 struct dentry
*dentry
;
142 /* except this scratch i/o buffer for ep0 */
146 static inline void get_dev (struct dev_data
*data
)
148 atomic_inc (&data
->count
);
151 static void put_dev (struct dev_data
*data
)
153 if (likely (!atomic_dec_and_test (&data
->count
)))
155 /* needs no more cleanup */
156 BUG_ON (waitqueue_active (&data
->wait
));
160 static struct dev_data
*dev_new (void)
162 struct dev_data
*dev
;
164 dev
= kzalloc(sizeof(*dev
), GFP_KERNEL
);
167 dev
->state
= STATE_DEV_DISABLED
;
168 atomic_set (&dev
->count
, 1);
169 spin_lock_init (&dev
->lock
);
170 INIT_LIST_HEAD (&dev
->epfiles
);
171 init_waitqueue_head (&dev
->wait
);
175 /*----------------------------------------------------------------------*/
177 /* other /dev/gadget/$ENDPOINT files represent endpoints */
179 STATE_EP_DISABLED
= 0,
189 struct dev_data
*dev
;
190 /* must hold dev->lock before accessing ep or req */
192 struct usb_request
*req
;
195 struct usb_endpoint_descriptor desc
, hs_desc
;
196 struct list_head epfiles
;
197 wait_queue_head_t wait
;
198 struct dentry
*dentry
;
202 static inline void get_ep (struct ep_data
*data
)
204 atomic_inc (&data
->count
);
207 static void put_ep (struct ep_data
*data
)
209 if (likely (!atomic_dec_and_test (&data
->count
)))
212 /* needs no more cleanup */
213 BUG_ON (!list_empty (&data
->epfiles
));
214 BUG_ON (waitqueue_active (&data
->wait
));
218 /*----------------------------------------------------------------------*/
220 /* most "how to use the hardware" policy choices are in userspace:
221 * mapping endpoint roles (which the driver needs) to the capabilities
222 * which the usb controller has. most of those capabilities are exposed
223 * implicitly, starting with the driver name and then endpoint names.
226 static const char *CHIP
;
228 /*----------------------------------------------------------------------*/
230 /* NOTE: don't use dev_printk calls before binding to the gadget
231 * at the end of ep0 configuration, or after unbind.
234 /* too wordy: dev_printk(level , &(d)->gadget->dev , fmt , ## args) */
235 #define xprintk(d,level,fmt,args...) \
236 printk(level "%s: " fmt , shortname , ## args)
239 #define DBG(dev,fmt,args...) \
240 xprintk(dev , KERN_DEBUG , fmt , ## args)
242 #define DBG(dev,fmt,args...) \
249 #define VDEBUG(dev,fmt,args...) \
253 #define ERROR(dev,fmt,args...) \
254 xprintk(dev , KERN_ERR , fmt , ## args)
255 #define INFO(dev,fmt,args...) \
256 xprintk(dev , KERN_INFO , fmt , ## args)
259 /*----------------------------------------------------------------------*/
261 /* SYNCHRONOUS ENDPOINT OPERATIONS (bulk/intr/iso)
263 * After opening, configure non-control endpoints. Then use normal
264 * stream read() and write() requests; and maybe ioctl() to get more
265 * precise FIFO status when recovering from cancellation.
268 static void epio_complete (struct usb_ep
*ep
, struct usb_request
*req
)
270 struct ep_data
*epdata
= ep
->driver_data
;
275 epdata
->status
= req
->status
;
277 epdata
->status
= req
->actual
;
278 complete ((struct completion
*)req
->context
);
281 /* tasklock endpoint, returning when it's connected.
282 * still need dev->lock to use epdata->ep.
285 get_ready_ep (unsigned f_flags
, struct ep_data
*epdata
)
289 if (f_flags
& O_NONBLOCK
) {
290 if (!mutex_trylock(&epdata
->lock
))
292 if (epdata
->state
!= STATE_EP_ENABLED
) {
293 mutex_unlock(&epdata
->lock
);
301 val
= mutex_lock_interruptible(&epdata
->lock
);
305 switch (epdata
->state
) {
306 case STATE_EP_ENABLED
:
308 // case STATE_EP_DISABLED: /* "can't happen" */
309 // case STATE_EP_READY: /* "can't happen" */
310 default: /* error! */
311 pr_debug ("%s: ep %p not available, state %d\n",
312 shortname
, epdata
, epdata
->state
);
314 case STATE_EP_UNBOUND
: /* clean disconnect */
316 mutex_unlock(&epdata
->lock
);
322 ep_io (struct ep_data
*epdata
, void *buf
, unsigned len
)
324 DECLARE_COMPLETION_ONSTACK (done
);
327 spin_lock_irq (&epdata
->dev
->lock
);
328 if (likely (epdata
->ep
!= NULL
)) {
329 struct usb_request
*req
= epdata
->req
;
331 req
->context
= &done
;
332 req
->complete
= epio_complete
;
335 value
= usb_ep_queue (epdata
->ep
, req
, GFP_ATOMIC
);
338 spin_unlock_irq (&epdata
->dev
->lock
);
340 if (likely (value
== 0)) {
341 value
= wait_event_interruptible (done
.wait
, done
.done
);
343 spin_lock_irq (&epdata
->dev
->lock
);
344 if (likely (epdata
->ep
!= NULL
)) {
345 DBG (epdata
->dev
, "%s i/o interrupted\n",
347 usb_ep_dequeue (epdata
->ep
, epdata
->req
);
348 spin_unlock_irq (&epdata
->dev
->lock
);
350 wait_event (done
.wait
, done
.done
);
351 if (epdata
->status
== -ECONNRESET
)
352 epdata
->status
= -EINTR
;
354 spin_unlock_irq (&epdata
->dev
->lock
);
356 DBG (epdata
->dev
, "endpoint gone\n");
357 epdata
->status
= -ENODEV
;
360 return epdata
->status
;
366 /* handle a synchronous OUT bulk/intr/iso transfer */
368 ep_read (struct file
*fd
, char __user
*buf
, size_t len
, loff_t
*ptr
)
370 struct ep_data
*data
= fd
->private_data
;
374 if ((value
= get_ready_ep (fd
->f_flags
, data
)) < 0)
377 /* halt any endpoint by doing a "wrong direction" i/o call */
378 if (usb_endpoint_dir_in(&data
->desc
)) {
379 if (usb_endpoint_xfer_isoc(&data
->desc
)) {
380 mutex_unlock(&data
->lock
);
383 DBG (data
->dev
, "%s halt\n", data
->name
);
384 spin_lock_irq (&data
->dev
->lock
);
385 if (likely (data
->ep
!= NULL
))
386 usb_ep_set_halt (data
->ep
);
387 spin_unlock_irq (&data
->dev
->lock
);
388 mutex_unlock(&data
->lock
);
392 /* FIXME readahead for O_NONBLOCK and poll(); careful with ZLPs */
395 kbuf
= kmalloc (len
, GFP_KERNEL
);
396 if (unlikely (!kbuf
))
399 value
= ep_io (data
, kbuf
, len
);
400 VDEBUG (data
->dev
, "%s read %zu OUT, status %d\n",
401 data
->name
, len
, (int) value
);
402 if (value
>= 0 && copy_to_user (buf
, kbuf
, value
))
406 mutex_unlock(&data
->lock
);
411 /* handle a synchronous IN bulk/intr/iso transfer */
413 ep_write (struct file
*fd
, const char __user
*buf
, size_t len
, loff_t
*ptr
)
415 struct ep_data
*data
= fd
->private_data
;
419 if ((value
= get_ready_ep (fd
->f_flags
, data
)) < 0)
422 /* halt any endpoint by doing a "wrong direction" i/o call */
423 if (!usb_endpoint_dir_in(&data
->desc
)) {
424 if (usb_endpoint_xfer_isoc(&data
->desc
)) {
425 mutex_unlock(&data
->lock
);
428 DBG (data
->dev
, "%s halt\n", data
->name
);
429 spin_lock_irq (&data
->dev
->lock
);
430 if (likely (data
->ep
!= NULL
))
431 usb_ep_set_halt (data
->ep
);
432 spin_unlock_irq (&data
->dev
->lock
);
433 mutex_unlock(&data
->lock
);
437 /* FIXME writebehind for O_NONBLOCK and poll(), qlen = 1 */
440 kbuf
= kmalloc (len
, GFP_KERNEL
);
443 if (copy_from_user (kbuf
, buf
, len
)) {
448 value
= ep_io (data
, kbuf
, len
);
449 VDEBUG (data
->dev
, "%s write %zu IN, status %d\n",
450 data
->name
, len
, (int) value
);
452 mutex_unlock(&data
->lock
);
458 ep_release (struct inode
*inode
, struct file
*fd
)
460 struct ep_data
*data
= fd
->private_data
;
463 value
= mutex_lock_interruptible(&data
->lock
);
467 /* clean up if this can be reopened */
468 if (data
->state
!= STATE_EP_UNBOUND
) {
469 data
->state
= STATE_EP_DISABLED
;
470 data
->desc
.bDescriptorType
= 0;
471 data
->hs_desc
.bDescriptorType
= 0;
472 usb_ep_disable(data
->ep
);
474 mutex_unlock(&data
->lock
);
479 static long ep_ioctl(struct file
*fd
, unsigned code
, unsigned long value
)
481 struct ep_data
*data
= fd
->private_data
;
484 if ((status
= get_ready_ep (fd
->f_flags
, data
)) < 0)
487 spin_lock_irq (&data
->dev
->lock
);
488 if (likely (data
->ep
!= NULL
)) {
490 case GADGETFS_FIFO_STATUS
:
491 status
= usb_ep_fifo_status (data
->ep
);
493 case GADGETFS_FIFO_FLUSH
:
494 usb_ep_fifo_flush (data
->ep
);
496 case GADGETFS_CLEAR_HALT
:
497 status
= usb_ep_clear_halt (data
->ep
);
504 spin_unlock_irq (&data
->dev
->lock
);
505 mutex_unlock(&data
->lock
);
509 /*----------------------------------------------------------------------*/
511 /* ASYNCHRONOUS ENDPOINT I/O OPERATIONS (bulk/intr/iso) */
514 struct usb_request
*req
;
515 struct ep_data
*epdata
;
517 const struct iovec
*iv
;
518 unsigned long nr_segs
;
522 static int ep_aio_cancel(struct kiocb
*iocb
, struct io_event
*e
)
524 struct kiocb_priv
*priv
= iocb
->private;
525 struct ep_data
*epdata
;
529 epdata
= priv
->epdata
;
530 // spin_lock(&epdata->dev->lock);
531 kiocbSetCancelled(iocb
);
532 if (likely(epdata
&& epdata
->ep
&& priv
->req
))
533 value
= usb_ep_dequeue (epdata
->ep
, priv
->req
);
536 // spin_unlock(&epdata->dev->lock);
543 static ssize_t
ep_aio_read_retry(struct kiocb
*iocb
)
545 struct kiocb_priv
*priv
= iocb
->private;
550 /* we "retry" to get the right mm context for this: */
552 /* copy stuff into user buffers */
553 total
= priv
->actual
;
556 for (i
=0; i
< priv
->nr_segs
; i
++) {
557 ssize_t
this = min((ssize_t
)(priv
->iv
[i
].iov_len
), total
);
559 if (copy_to_user(priv
->iv
[i
].iov_base
, to_copy
, this)) {
576 static void ep_aio_complete(struct usb_ep
*ep
, struct usb_request
*req
)
578 struct kiocb
*iocb
= req
->context
;
579 struct kiocb_priv
*priv
= iocb
->private;
580 struct ep_data
*epdata
= priv
->epdata
;
582 /* lock against disconnect (and ideally, cancel) */
583 spin_lock(&epdata
->dev
->lock
);
587 /* if this was a write or a read returning no data then we
588 * don't need to copy anything to userspace, so we can
589 * complete the aio request immediately.
591 if (priv
->iv
== NULL
|| unlikely(req
->actual
== 0)) {
594 iocb
->private = NULL
;
595 /* aio_complete() reports bytes-transferred _and_ faults */
596 aio_complete(iocb
, req
->actual
? req
->actual
: req
->status
,
599 /* retry() won't report both; so we hide some faults */
600 if (unlikely(0 != req
->status
))
601 DBG(epdata
->dev
, "%s fault %d len %d\n",
602 ep
->name
, req
->status
, req
->actual
);
604 priv
->buf
= req
->buf
;
605 priv
->actual
= req
->actual
;
608 spin_unlock(&epdata
->dev
->lock
);
610 usb_ep_free_request(ep
, req
);
619 struct ep_data
*epdata
,
620 const struct iovec
*iv
,
621 unsigned long nr_segs
624 struct kiocb_priv
*priv
;
625 struct usb_request
*req
;
628 priv
= kmalloc(sizeof *priv
, GFP_KERNEL
);
635 iocb
->private = priv
;
637 priv
->nr_segs
= nr_segs
;
639 value
= get_ready_ep(iocb
->ki_filp
->f_flags
, epdata
);
640 if (unlikely(value
< 0)) {
645 iocb
->ki_cancel
= ep_aio_cancel
;
647 priv
->epdata
= epdata
;
650 /* each kiocb is coupled to one usb_request, but we can't
651 * allocate or submit those if the host disconnected.
653 spin_lock_irq(&epdata
->dev
->lock
);
654 if (likely(epdata
->ep
)) {
655 req
= usb_ep_alloc_request(epdata
->ep
, GFP_ATOMIC
);
660 req
->complete
= ep_aio_complete
;
662 value
= usb_ep_queue(epdata
->ep
, req
, GFP_ATOMIC
);
663 if (unlikely(0 != value
))
664 usb_ep_free_request(epdata
->ep
, req
);
669 spin_unlock_irq(&epdata
->dev
->lock
);
671 mutex_unlock(&epdata
->lock
);
673 if (unlikely(value
)) {
677 value
= (iv
? -EIOCBRETRY
: -EIOCBQUEUED
);
682 ep_aio_read(struct kiocb
*iocb
, const struct iovec
*iov
,
683 unsigned long nr_segs
, loff_t o
)
685 struct ep_data
*epdata
= iocb
->ki_filp
->private_data
;
688 if (unlikely(usb_endpoint_dir_in(&epdata
->desc
)))
691 buf
= kmalloc(iocb
->ki_left
, GFP_KERNEL
);
695 iocb
->ki_retry
= ep_aio_read_retry
;
696 return ep_aio_rwtail(iocb
, buf
, iocb
->ki_left
, epdata
, iov
, nr_segs
);
700 ep_aio_write(struct kiocb
*iocb
, const struct iovec
*iov
,
701 unsigned long nr_segs
, loff_t o
)
703 struct ep_data
*epdata
= iocb
->ki_filp
->private_data
;
708 if (unlikely(!usb_endpoint_dir_in(&epdata
->desc
)))
711 buf
= kmalloc(iocb
->ki_left
, GFP_KERNEL
);
715 for (i
=0; i
< nr_segs
; i
++) {
716 if (unlikely(copy_from_user(&buf
[len
], iov
[i
].iov_base
,
717 iov
[i
].iov_len
) != 0)) {
721 len
+= iov
[i
].iov_len
;
723 return ep_aio_rwtail(iocb
, buf
, len
, epdata
, NULL
, 0);
726 /*----------------------------------------------------------------------*/
728 /* used after endpoint configuration */
729 static const struct file_operations ep_io_operations
= {
730 .owner
= THIS_MODULE
,
735 .unlocked_ioctl
= ep_ioctl
,
736 .release
= ep_release
,
738 .aio_read
= ep_aio_read
,
739 .aio_write
= ep_aio_write
,
742 /* ENDPOINT INITIALIZATION
744 * fd = open ("/dev/gadget/$ENDPOINT", O_RDWR)
745 * status = write (fd, descriptors, sizeof descriptors)
747 * That write establishes the endpoint configuration, configuring
748 * the controller to process bulk, interrupt, or isochronous transfers
749 * at the right maxpacket size, and so on.
751 * The descriptors are message type 1, identified by a host order u32
752 * at the beginning of what's written. Descriptor order is: full/low
753 * speed descriptor, then optional high speed descriptor.
756 ep_config (struct file
*fd
, const char __user
*buf
, size_t len
, loff_t
*ptr
)
758 struct ep_data
*data
= fd
->private_data
;
761 int value
, length
= len
;
763 value
= mutex_lock_interruptible(&data
->lock
);
767 if (data
->state
!= STATE_EP_READY
) {
773 if (len
< USB_DT_ENDPOINT_SIZE
+ 4)
776 /* we might need to change message format someday */
777 if (copy_from_user (&tag
, buf
, 4)) {
781 DBG(data
->dev
, "config %s, bad tag %d\n", data
->name
, tag
);
787 /* NOTE: audio endpoint extensions not accepted here;
788 * just don't include the extra bytes.
791 /* full/low speed descriptor, then high speed */
792 if (copy_from_user (&data
->desc
, buf
, USB_DT_ENDPOINT_SIZE
)) {
795 if (data
->desc
.bLength
!= USB_DT_ENDPOINT_SIZE
796 || data
->desc
.bDescriptorType
!= USB_DT_ENDPOINT
)
798 if (len
!= USB_DT_ENDPOINT_SIZE
) {
799 if (len
!= 2 * USB_DT_ENDPOINT_SIZE
)
801 if (copy_from_user (&data
->hs_desc
, buf
+ USB_DT_ENDPOINT_SIZE
,
802 USB_DT_ENDPOINT_SIZE
)) {
805 if (data
->hs_desc
.bLength
!= USB_DT_ENDPOINT_SIZE
806 || data
->hs_desc
.bDescriptorType
807 != USB_DT_ENDPOINT
) {
808 DBG(data
->dev
, "config %s, bad hs length or type\n",
814 spin_lock_irq (&data
->dev
->lock
);
815 if (data
->dev
->state
== STATE_DEV_UNBOUND
) {
818 } else if ((ep
= data
->ep
) == NULL
) {
822 switch (data
->dev
->gadget
->speed
) {
825 ep
->desc
= &data
->desc
;
826 value
= usb_ep_enable(ep
);
828 data
->state
= STATE_EP_ENABLED
;
831 /* fails if caller didn't provide that descriptor... */
832 ep
->desc
= &data
->hs_desc
;
833 value
= usb_ep_enable(ep
);
835 data
->state
= STATE_EP_ENABLED
;
838 DBG(data
->dev
, "unconnected, %s init abandoned\n",
843 fd
->f_op
= &ep_io_operations
;
847 spin_unlock_irq (&data
->dev
->lock
);
850 data
->desc
.bDescriptorType
= 0;
851 data
->hs_desc
.bDescriptorType
= 0;
853 mutex_unlock(&data
->lock
);
864 ep_open (struct inode
*inode
, struct file
*fd
)
866 struct ep_data
*data
= inode
->i_private
;
869 if (mutex_lock_interruptible(&data
->lock
) != 0)
871 spin_lock_irq (&data
->dev
->lock
);
872 if (data
->dev
->state
== STATE_DEV_UNBOUND
)
874 else if (data
->state
== STATE_EP_DISABLED
) {
876 data
->state
= STATE_EP_READY
;
878 fd
->private_data
= data
;
879 VDEBUG (data
->dev
, "%s ready\n", data
->name
);
881 DBG (data
->dev
, "%s state %d\n",
882 data
->name
, data
->state
);
883 spin_unlock_irq (&data
->dev
->lock
);
884 mutex_unlock(&data
->lock
);
888 /* used before endpoint configuration */
889 static const struct file_operations ep_config_operations
= {
890 .owner
= THIS_MODULE
,
895 .release
= ep_release
,
898 /*----------------------------------------------------------------------*/
900 /* EP0 IMPLEMENTATION can be partly in userspace.
902 * Drivers that use this facility receive various events, including
903 * control requests the kernel doesn't handle. Drivers that don't
904 * use this facility may be too simple-minded for real applications.
907 static inline void ep0_readable (struct dev_data
*dev
)
909 wake_up (&dev
->wait
);
910 kill_fasync (&dev
->fasync
, SIGIO
, POLL_IN
);
913 static void clean_req (struct usb_ep
*ep
, struct usb_request
*req
)
915 struct dev_data
*dev
= ep
->driver_data
;
917 if (req
->buf
!= dev
->rbuf
) {
919 req
->buf
= dev
->rbuf
;
921 req
->complete
= epio_complete
;
922 dev
->setup_out_ready
= 0;
925 static void ep0_complete (struct usb_ep
*ep
, struct usb_request
*req
)
927 struct dev_data
*dev
= ep
->driver_data
;
931 /* for control OUT, data must still get to userspace */
932 spin_lock_irqsave(&dev
->lock
, flags
);
933 if (!dev
->setup_in
) {
934 dev
->setup_out_error
= (req
->status
!= 0);
935 if (!dev
->setup_out_error
)
937 dev
->setup_out_ready
= 1;
941 /* clean up as appropriate */
942 if (free
&& req
->buf
!= &dev
->rbuf
)
944 req
->complete
= epio_complete
;
945 spin_unlock_irqrestore(&dev
->lock
, flags
);
948 static int setup_req (struct usb_ep
*ep
, struct usb_request
*req
, u16 len
)
950 struct dev_data
*dev
= ep
->driver_data
;
952 if (dev
->setup_out_ready
) {
953 DBG (dev
, "ep0 request busy!\n");
956 if (len
> sizeof (dev
->rbuf
))
957 req
->buf
= kmalloc(len
, GFP_ATOMIC
);
958 if (req
->buf
== NULL
) {
959 req
->buf
= dev
->rbuf
;
962 req
->complete
= ep0_complete
;
969 ep0_read (struct file
*fd
, char __user
*buf
, size_t len
, loff_t
*ptr
)
971 struct dev_data
*dev
= fd
->private_data
;
973 enum ep0_state state
;
975 spin_lock_irq (&dev
->lock
);
977 /* report fd mode change before acting on it */
978 if (dev
->setup_abort
) {
979 dev
->setup_abort
= 0;
984 /* control DATA stage */
985 if ((state
= dev
->state
) == STATE_DEV_SETUP
) {
987 if (dev
->setup_in
) { /* stall IN */
988 VDEBUG(dev
, "ep0in stall\n");
989 (void) usb_ep_set_halt (dev
->gadget
->ep0
);
991 dev
->state
= STATE_DEV_CONNECTED
;
993 } else if (len
== 0) { /* ack SET_CONFIGURATION etc */
994 struct usb_ep
*ep
= dev
->gadget
->ep0
;
995 struct usb_request
*req
= dev
->req
;
997 if ((retval
= setup_req (ep
, req
, 0)) == 0)
998 retval
= usb_ep_queue (ep
, req
, GFP_ATOMIC
);
999 dev
->state
= STATE_DEV_CONNECTED
;
1001 /* assume that was SET_CONFIGURATION */
1002 if (dev
->current_config
) {
1005 if (gadget_is_dualspeed(dev
->gadget
)
1006 && (dev
->gadget
->speed
1008 power
= dev
->hs_config
->bMaxPower
;
1010 power
= dev
->config
->bMaxPower
;
1011 usb_gadget_vbus_draw(dev
->gadget
, 2 * power
);
1014 } else { /* collect OUT data */
1015 if ((fd
->f_flags
& O_NONBLOCK
) != 0
1016 && !dev
->setup_out_ready
) {
1020 spin_unlock_irq (&dev
->lock
);
1021 retval
= wait_event_interruptible (dev
->wait
,
1022 dev
->setup_out_ready
!= 0);
1024 /* FIXME state could change from under us */
1025 spin_lock_irq (&dev
->lock
);
1029 if (dev
->state
!= STATE_DEV_SETUP
) {
1030 retval
= -ECANCELED
;
1033 dev
->state
= STATE_DEV_CONNECTED
;
1035 if (dev
->setup_out_error
)
1038 len
= min (len
, (size_t)dev
->req
->actual
);
1039 // FIXME don't call this with the spinlock held ...
1040 if (copy_to_user (buf
, dev
->req
->buf
, len
))
1044 clean_req (dev
->gadget
->ep0
, dev
->req
);
1045 /* NOTE userspace can't yet choose to stall */
1051 /* else normal: return event data */
1052 if (len
< sizeof dev
->event
[0]) {
1056 len
-= len
% sizeof (struct usb_gadgetfs_event
);
1057 dev
->usermode_setup
= 1;
1060 /* return queued events right away */
1061 if (dev
->ev_next
!= 0) {
1064 n
= len
/ sizeof (struct usb_gadgetfs_event
);
1065 if (dev
->ev_next
< n
)
1068 /* ep0 i/o has special semantics during STATE_DEV_SETUP */
1069 for (i
= 0; i
< n
; i
++) {
1070 if (dev
->event
[i
].type
== GADGETFS_SETUP
) {
1071 dev
->state
= STATE_DEV_SETUP
;
1076 spin_unlock_irq (&dev
->lock
);
1077 len
= n
* sizeof (struct usb_gadgetfs_event
);
1078 if (copy_to_user (buf
, &dev
->event
, len
))
1083 /* NOTE this doesn't guard against broken drivers;
1084 * concurrent ep0 readers may lose events.
1086 spin_lock_irq (&dev
->lock
);
1087 if (dev
->ev_next
> n
) {
1088 memmove(&dev
->event
[0], &dev
->event
[n
],
1089 sizeof (struct usb_gadgetfs_event
)
1090 * (dev
->ev_next
- n
));
1093 spin_unlock_irq (&dev
->lock
);
1097 if (fd
->f_flags
& O_NONBLOCK
) {
1104 DBG (dev
, "fail %s, state %d\n", __func__
, state
);
1107 case STATE_DEV_UNCONNECTED
:
1108 case STATE_DEV_CONNECTED
:
1109 spin_unlock_irq (&dev
->lock
);
1110 DBG (dev
, "%s wait\n", __func__
);
1112 /* wait for events */
1113 retval
= wait_event_interruptible (dev
->wait
,
1117 spin_lock_irq (&dev
->lock
);
1122 spin_unlock_irq (&dev
->lock
);
1126 static struct usb_gadgetfs_event
*
1127 next_event (struct dev_data
*dev
, enum usb_gadgetfs_event_type type
)
1129 struct usb_gadgetfs_event
*event
;
1133 /* these events purge the queue */
1134 case GADGETFS_DISCONNECT
:
1135 if (dev
->state
== STATE_DEV_SETUP
)
1136 dev
->setup_abort
= 1;
1138 case GADGETFS_CONNECT
:
1141 case GADGETFS_SETUP
: /* previous request timed out */
1142 case GADGETFS_SUSPEND
: /* same effect */
1143 /* these events can't be repeated */
1144 for (i
= 0; i
!= dev
->ev_next
; i
++) {
1145 if (dev
->event
[i
].type
!= type
)
1147 DBG(dev
, "discard old event[%d] %d\n", i
, type
);
1149 if (i
== dev
->ev_next
)
1151 /* indices start at zero, for simplicity */
1152 memmove (&dev
->event
[i
], &dev
->event
[i
+ 1],
1153 sizeof (struct usb_gadgetfs_event
)
1154 * (dev
->ev_next
- i
));
1160 VDEBUG(dev
, "event[%d] = %d\n", dev
->ev_next
, type
);
1161 event
= &dev
->event
[dev
->ev_next
++];
1162 BUG_ON (dev
->ev_next
> N_EVENT
);
1163 memset (event
, 0, sizeof *event
);
1169 ep0_write (struct file
*fd
, const char __user
*buf
, size_t len
, loff_t
*ptr
)
1171 struct dev_data
*dev
= fd
->private_data
;
1172 ssize_t retval
= -ESRCH
;
1174 spin_lock_irq (&dev
->lock
);
1176 /* report fd mode change before acting on it */
1177 if (dev
->setup_abort
) {
1178 dev
->setup_abort
= 0;
1181 /* data and/or status stage for control request */
1182 } else if (dev
->state
== STATE_DEV_SETUP
) {
1184 /* IN DATA+STATUS caller makes len <= wLength */
1185 if (dev
->setup_in
) {
1186 retval
= setup_req (dev
->gadget
->ep0
, dev
->req
, len
);
1188 dev
->state
= STATE_DEV_CONNECTED
;
1189 spin_unlock_irq (&dev
->lock
);
1190 if (copy_from_user (dev
->req
->buf
, buf
, len
))
1193 if (len
< dev
->setup_wLength
)
1195 retval
= usb_ep_queue (
1196 dev
->gadget
->ep0
, dev
->req
,
1200 spin_lock_irq (&dev
->lock
);
1201 clean_req (dev
->gadget
->ep0
, dev
->req
);
1202 spin_unlock_irq (&dev
->lock
);
1209 /* can stall some OUT transfers */
1210 } else if (dev
->setup_can_stall
) {
1211 VDEBUG(dev
, "ep0out stall\n");
1212 (void) usb_ep_set_halt (dev
->gadget
->ep0
);
1214 dev
->state
= STATE_DEV_CONNECTED
;
1216 DBG(dev
, "bogus ep0out stall!\n");
1219 DBG (dev
, "fail %s, state %d\n", __func__
, dev
->state
);
1221 spin_unlock_irq (&dev
->lock
);
1226 ep0_fasync (int f
, struct file
*fd
, int on
)
1228 struct dev_data
*dev
= fd
->private_data
;
1229 // caller must F_SETOWN before signal delivery happens
1230 VDEBUG (dev
, "%s %s\n", __func__
, on
? "on" : "off");
1231 return fasync_helper (f
, fd
, on
, &dev
->fasync
);
1234 static struct usb_gadget_driver gadgetfs_driver
;
1237 dev_release (struct inode
*inode
, struct file
*fd
)
1239 struct dev_data
*dev
= fd
->private_data
;
1241 /* closing ep0 === shutdown all */
1243 usb_gadget_unregister_driver (&gadgetfs_driver
);
1245 /* at this point "good" hardware has disconnected the
1246 * device from USB; the host won't see it any more.
1247 * alternatively, all host requests will time out.
1254 /* other endpoints were all decoupled from this device */
1255 spin_lock_irq(&dev
->lock
);
1256 dev
->state
= STATE_DEV_DISABLED
;
1257 spin_unlock_irq(&dev
->lock
);
1262 ep0_poll (struct file
*fd
, poll_table
*wait
)
1264 struct dev_data
*dev
= fd
->private_data
;
1267 poll_wait(fd
, &dev
->wait
, wait
);
1269 spin_lock_irq (&dev
->lock
);
1271 /* report fd mode change before acting on it */
1272 if (dev
->setup_abort
) {
1273 dev
->setup_abort
= 0;
1278 if (dev
->state
== STATE_DEV_SETUP
) {
1279 if (dev
->setup_in
|| dev
->setup_can_stall
)
1282 if (dev
->ev_next
!= 0)
1286 spin_unlock_irq(&dev
->lock
);
1290 static long dev_ioctl (struct file
*fd
, unsigned code
, unsigned long value
)
1292 struct dev_data
*dev
= fd
->private_data
;
1293 struct usb_gadget
*gadget
= dev
->gadget
;
1296 if (gadget
->ops
->ioctl
)
1297 ret
= gadget
->ops
->ioctl (gadget
, code
, value
);
1302 /* used after device configuration */
1303 static const struct file_operations ep0_io_operations
= {
1304 .owner
= THIS_MODULE
,
1305 .llseek
= no_llseek
,
1309 .fasync
= ep0_fasync
,
1311 .unlocked_ioctl
= dev_ioctl
,
1312 .release
= dev_release
,
1315 /*----------------------------------------------------------------------*/
1317 /* The in-kernel gadget driver handles most ep0 issues, in particular
1318 * enumerating the single configuration (as provided from user space).
1320 * Unrecognized ep0 requests may be handled in user space.
1323 static void make_qualifier (struct dev_data
*dev
)
1325 struct usb_qualifier_descriptor qual
;
1326 struct usb_device_descriptor
*desc
;
1328 qual
.bLength
= sizeof qual
;
1329 qual
.bDescriptorType
= USB_DT_DEVICE_QUALIFIER
;
1330 qual
.bcdUSB
= cpu_to_le16 (0x0200);
1333 qual
.bDeviceClass
= desc
->bDeviceClass
;
1334 qual
.bDeviceSubClass
= desc
->bDeviceSubClass
;
1335 qual
.bDeviceProtocol
= desc
->bDeviceProtocol
;
1337 /* assumes ep0 uses the same value for both speeds ... */
1338 qual
.bMaxPacketSize0
= dev
->gadget
->ep0
->maxpacket
;
1340 qual
.bNumConfigurations
= 1;
1343 memcpy (dev
->rbuf
, &qual
, sizeof qual
);
1347 config_buf (struct dev_data
*dev
, u8 type
, unsigned index
)
1352 /* only one configuration */
1356 if (gadget_is_dualspeed(dev
->gadget
)) {
1357 hs
= (dev
->gadget
->speed
== USB_SPEED_HIGH
);
1358 if (type
== USB_DT_OTHER_SPEED_CONFIG
)
1362 dev
->req
->buf
= dev
->hs_config
;
1363 len
= le16_to_cpu(dev
->hs_config
->wTotalLength
);
1365 dev
->req
->buf
= dev
->config
;
1366 len
= le16_to_cpu(dev
->config
->wTotalLength
);
1368 ((u8
*)dev
->req
->buf
) [1] = type
;
1373 gadgetfs_setup (struct usb_gadget
*gadget
, const struct usb_ctrlrequest
*ctrl
)
1375 struct dev_data
*dev
= get_gadget_data (gadget
);
1376 struct usb_request
*req
= dev
->req
;
1377 int value
= -EOPNOTSUPP
;
1378 struct usb_gadgetfs_event
*event
;
1379 u16 w_value
= le16_to_cpu(ctrl
->wValue
);
1380 u16 w_length
= le16_to_cpu(ctrl
->wLength
);
1382 spin_lock (&dev
->lock
);
1383 dev
->setup_abort
= 0;
1384 if (dev
->state
== STATE_DEV_UNCONNECTED
) {
1385 if (gadget_is_dualspeed(gadget
)
1386 && gadget
->speed
== USB_SPEED_HIGH
1387 && dev
->hs_config
== NULL
) {
1388 spin_unlock(&dev
->lock
);
1389 ERROR (dev
, "no high speed config??\n");
1393 dev
->state
= STATE_DEV_CONNECTED
;
1395 INFO (dev
, "connected\n");
1396 event
= next_event (dev
, GADGETFS_CONNECT
);
1397 event
->u
.speed
= gadget
->speed
;
1400 /* host may have given up waiting for response. we can miss control
1401 * requests handled lower down (device/endpoint status and features);
1402 * then ep0_{read,write} will report the wrong status. controller
1403 * driver will have aborted pending i/o.
1405 } else if (dev
->state
== STATE_DEV_SETUP
)
1406 dev
->setup_abort
= 1;
1408 req
->buf
= dev
->rbuf
;
1409 req
->context
= NULL
;
1410 value
= -EOPNOTSUPP
;
1411 switch (ctrl
->bRequest
) {
1413 case USB_REQ_GET_DESCRIPTOR
:
1414 if (ctrl
->bRequestType
!= USB_DIR_IN
)
1416 switch (w_value
>> 8) {
1419 value
= min (w_length
, (u16
) sizeof *dev
->dev
);
1420 dev
->dev
->bMaxPacketSize0
= dev
->gadget
->ep0
->maxpacket
;
1421 req
->buf
= dev
->dev
;
1423 case USB_DT_DEVICE_QUALIFIER
:
1424 if (!dev
->hs_config
)
1426 value
= min (w_length
, (u16
)
1427 sizeof (struct usb_qualifier_descriptor
));
1428 make_qualifier (dev
);
1430 case USB_DT_OTHER_SPEED_CONFIG
:
1433 value
= config_buf (dev
,
1437 value
= min (w_length
, (u16
) value
);
1442 default: // all others are errors
1447 /* currently one config, two speeds */
1448 case USB_REQ_SET_CONFIGURATION
:
1449 if (ctrl
->bRequestType
!= 0)
1451 if (0 == (u8
) w_value
) {
1453 dev
->current_config
= 0;
1454 usb_gadget_vbus_draw(gadget
, 8 /* mA */ );
1455 // user mode expected to disable endpoints
1459 if (gadget_is_dualspeed(gadget
)
1460 && gadget
->speed
== USB_SPEED_HIGH
) {
1461 config
= dev
->hs_config
->bConfigurationValue
;
1462 power
= dev
->hs_config
->bMaxPower
;
1464 config
= dev
->config
->bConfigurationValue
;
1465 power
= dev
->config
->bMaxPower
;
1468 if (config
== (u8
) w_value
) {
1470 dev
->current_config
= config
;
1471 usb_gadget_vbus_draw(gadget
, 2 * power
);
1475 /* report SET_CONFIGURATION like any other control request,
1476 * except that usermode may not stall this. the next
1477 * request mustn't be allowed start until this finishes:
1478 * endpoints and threads set up, etc.
1480 * NOTE: older PXA hardware (before PXA 255: without UDCCFR)
1481 * has bad/racey automagic that prevents synchronizing here.
1482 * even kernel mode drivers often miss them.
1485 INFO (dev
, "configuration #%d\n", dev
->current_config
);
1486 if (dev
->usermode_setup
) {
1487 dev
->setup_can_stall
= 0;
1493 #ifndef CONFIG_USB_GADGET_PXA25X
1494 /* PXA automagically handles this request too */
1495 case USB_REQ_GET_CONFIGURATION
:
1496 if (ctrl
->bRequestType
!= 0x80)
1498 *(u8
*)req
->buf
= dev
->current_config
;
1499 value
= min (w_length
, (u16
) 1);
1505 VDEBUG (dev
, "%s req%02x.%02x v%04x i%04x l%d\n",
1506 dev
->usermode_setup
? "delegate" : "fail",
1507 ctrl
->bRequestType
, ctrl
->bRequest
,
1508 w_value
, le16_to_cpu(ctrl
->wIndex
), w_length
);
1510 /* if there's an ep0 reader, don't stall */
1511 if (dev
->usermode_setup
) {
1512 dev
->setup_can_stall
= 1;
1514 dev
->setup_in
= (ctrl
->bRequestType
& USB_DIR_IN
)
1516 dev
->setup_wLength
= w_length
;
1517 dev
->setup_out_ready
= 0;
1518 dev
->setup_out_error
= 0;
1521 /* read DATA stage for OUT right away */
1522 if (unlikely (!dev
->setup_in
&& w_length
)) {
1523 value
= setup_req (gadget
->ep0
, dev
->req
,
1527 value
= usb_ep_queue (gadget
->ep0
, dev
->req
,
1530 clean_req (gadget
->ep0
, dev
->req
);
1534 /* we can't currently stall these */
1535 dev
->setup_can_stall
= 0;
1538 /* state changes when reader collects event */
1539 event
= next_event (dev
, GADGETFS_SETUP
);
1540 event
->u
.setup
= *ctrl
;
1542 spin_unlock (&dev
->lock
);
1547 /* proceed with data transfer and status phases? */
1548 if (value
>= 0 && dev
->state
!= STATE_DEV_SETUP
) {
1549 req
->length
= value
;
1550 req
->zero
= value
< w_length
;
1551 value
= usb_ep_queue (gadget
->ep0
, req
, GFP_ATOMIC
);
1553 DBG (dev
, "ep_queue --> %d\n", value
);
1558 /* device stalls when value < 0 */
1559 spin_unlock (&dev
->lock
);
1563 static void destroy_ep_files (struct dev_data
*dev
)
1565 DBG (dev
, "%s %d\n", __func__
, dev
->state
);
1567 /* dev->state must prevent interference */
1568 spin_lock_irq (&dev
->lock
);
1569 while (!list_empty(&dev
->epfiles
)) {
1571 struct inode
*parent
;
1572 struct dentry
*dentry
;
1574 /* break link to FS */
1575 ep
= list_first_entry (&dev
->epfiles
, struct ep_data
, epfiles
);
1576 list_del_init (&ep
->epfiles
);
1577 dentry
= ep
->dentry
;
1579 parent
= dentry
->d_parent
->d_inode
;
1581 /* break link to controller */
1582 if (ep
->state
== STATE_EP_ENABLED
)
1583 (void) usb_ep_disable (ep
->ep
);
1584 ep
->state
= STATE_EP_UNBOUND
;
1585 usb_ep_free_request (ep
->ep
, ep
->req
);
1587 wake_up (&ep
->wait
);
1590 spin_unlock_irq (&dev
->lock
);
1592 /* break link to dcache */
1593 mutex_lock (&parent
->i_mutex
);
1596 mutex_unlock (&parent
->i_mutex
);
1598 spin_lock_irq (&dev
->lock
);
1600 spin_unlock_irq (&dev
->lock
);
1604 static struct inode
*
1605 gadgetfs_create_file (struct super_block
*sb
, char const *name
,
1606 void *data
, const struct file_operations
*fops
,
1607 struct dentry
**dentry_p
);
1609 static int activate_ep_files (struct dev_data
*dev
)
1612 struct ep_data
*data
;
1614 gadget_for_each_ep (ep
, dev
->gadget
) {
1616 data
= kzalloc(sizeof(*data
), GFP_KERNEL
);
1619 data
->state
= STATE_EP_DISABLED
;
1620 mutex_init(&data
->lock
);
1621 init_waitqueue_head (&data
->wait
);
1623 strncpy (data
->name
, ep
->name
, sizeof (data
->name
) - 1);
1624 atomic_set (&data
->count
, 1);
1629 ep
->driver_data
= data
;
1631 data
->req
= usb_ep_alloc_request (ep
, GFP_KERNEL
);
1635 data
->inode
= gadgetfs_create_file (dev
->sb
, data
->name
,
1636 data
, &ep_config_operations
,
1640 list_add_tail (&data
->epfiles
, &dev
->epfiles
);
1645 usb_ep_free_request (ep
, data
->req
);
1650 DBG (dev
, "%s enomem\n", __func__
);
1651 destroy_ep_files (dev
);
1656 gadgetfs_unbind (struct usb_gadget
*gadget
)
1658 struct dev_data
*dev
= get_gadget_data (gadget
);
1660 DBG (dev
, "%s\n", __func__
);
1662 spin_lock_irq (&dev
->lock
);
1663 dev
->state
= STATE_DEV_UNBOUND
;
1664 spin_unlock_irq (&dev
->lock
);
1666 destroy_ep_files (dev
);
1667 gadget
->ep0
->driver_data
= NULL
;
1668 set_gadget_data (gadget
, NULL
);
1670 /* we've already been disconnected ... no i/o is active */
1672 usb_ep_free_request (gadget
->ep0
, dev
->req
);
1673 DBG (dev
, "%s done\n", __func__
);
1677 static struct dev_data
*the_device
;
1679 static int gadgetfs_bind(struct usb_gadget
*gadget
,
1680 struct usb_gadget_driver
*driver
)
1682 struct dev_data
*dev
= the_device
;
1686 if (0 != strcmp (CHIP
, gadget
->name
)) {
1687 pr_err("%s expected %s controller not %s\n",
1688 shortname
, CHIP
, gadget
->name
);
1692 set_gadget_data (gadget
, dev
);
1693 dev
->gadget
= gadget
;
1694 gadget
->ep0
->driver_data
= dev
;
1696 /* preallocate control response and buffer */
1697 dev
->req
= usb_ep_alloc_request (gadget
->ep0
, GFP_KERNEL
);
1700 dev
->req
->context
= NULL
;
1701 dev
->req
->complete
= epio_complete
;
1703 if (activate_ep_files (dev
) < 0)
1706 INFO (dev
, "bound to %s driver\n", gadget
->name
);
1707 spin_lock_irq(&dev
->lock
);
1708 dev
->state
= STATE_DEV_UNCONNECTED
;
1709 spin_unlock_irq(&dev
->lock
);
1714 gadgetfs_unbind (gadget
);
1719 gadgetfs_disconnect (struct usb_gadget
*gadget
)
1721 struct dev_data
*dev
= get_gadget_data (gadget
);
1722 unsigned long flags
;
1724 spin_lock_irqsave (&dev
->lock
, flags
);
1725 if (dev
->state
== STATE_DEV_UNCONNECTED
)
1727 dev
->state
= STATE_DEV_UNCONNECTED
;
1729 INFO (dev
, "disconnected\n");
1730 next_event (dev
, GADGETFS_DISCONNECT
);
1733 spin_unlock_irqrestore (&dev
->lock
, flags
);
1737 gadgetfs_suspend (struct usb_gadget
*gadget
)
1739 struct dev_data
*dev
= get_gadget_data (gadget
);
1741 INFO (dev
, "suspended from state %d\n", dev
->state
);
1742 spin_lock (&dev
->lock
);
1743 switch (dev
->state
) {
1744 case STATE_DEV_SETUP
: // VERY odd... host died??
1745 case STATE_DEV_CONNECTED
:
1746 case STATE_DEV_UNCONNECTED
:
1747 next_event (dev
, GADGETFS_SUSPEND
);
1753 spin_unlock (&dev
->lock
);
1756 static struct usb_gadget_driver gadgetfs_driver
= {
1757 .function
= (char *) driver_desc
,
1758 .bind
= gadgetfs_bind
,
1759 .unbind
= gadgetfs_unbind
,
1760 .setup
= gadgetfs_setup
,
1761 .disconnect
= gadgetfs_disconnect
,
1762 .suspend
= gadgetfs_suspend
,
1765 .name
= (char *) shortname
,
1769 /*----------------------------------------------------------------------*/
1771 static void gadgetfs_nop(struct usb_gadget
*arg
) { }
1773 static int gadgetfs_probe(struct usb_gadget
*gadget
,
1774 struct usb_gadget_driver
*driver
)
1776 CHIP
= gadget
->name
;
1780 static struct usb_gadget_driver probe_driver
= {
1781 .max_speed
= USB_SPEED_HIGH
,
1782 .bind
= gadgetfs_probe
,
1783 .unbind
= gadgetfs_nop
,
1784 .setup
= (void *)gadgetfs_nop
,
1785 .disconnect
= gadgetfs_nop
,
1792 /* DEVICE INITIALIZATION
1794 * fd = open ("/dev/gadget/$CHIP", O_RDWR)
1795 * status = write (fd, descriptors, sizeof descriptors)
1797 * That write establishes the device configuration, so the kernel can
1798 * bind to the controller ... guaranteeing it can handle enumeration
1799 * at all necessary speeds. Descriptor order is:
1801 * . message tag (u32, host order) ... for now, must be zero; it
1802 * would change to support features like multi-config devices
1803 * . full/low speed config ... all wTotalLength bytes (with interface,
1804 * class, altsetting, endpoint, and other descriptors)
1805 * . high speed config ... all descriptors, for high speed operation;
1806 * this one's optional except for high-speed hardware
1807 * . device descriptor
1809 * Endpoints are not yet enabled. Drivers must wait until device
1810 * configuration and interface altsetting changes create
1811 * the need to configure (or unconfigure) them.
1813 * After initialization, the device stays active for as long as that
1814 * $CHIP file is open. Events must then be read from that descriptor,
1815 * such as configuration notifications.
1818 static int is_valid_config (struct usb_config_descriptor
*config
)
1820 return config
->bDescriptorType
== USB_DT_CONFIG
1821 && config
->bLength
== USB_DT_CONFIG_SIZE
1822 && config
->bConfigurationValue
!= 0
1823 && (config
->bmAttributes
& USB_CONFIG_ATT_ONE
) != 0
1824 && (config
->bmAttributes
& USB_CONFIG_ATT_WAKEUP
) == 0;
1825 /* FIXME if gadget->is_otg, _must_ include an otg descriptor */
1826 /* FIXME check lengths: walk to end */
1830 dev_config (struct file
*fd
, const char __user
*buf
, size_t len
, loff_t
*ptr
)
1832 struct dev_data
*dev
= fd
->private_data
;
1833 ssize_t value
= len
, length
= len
;
1838 if (len
< (USB_DT_CONFIG_SIZE
+ USB_DT_DEVICE_SIZE
+ 4))
1841 /* we might need to change message format someday */
1842 if (copy_from_user (&tag
, buf
, 4))
1849 kbuf
= memdup_user(buf
, length
);
1851 return PTR_ERR(kbuf
);
1853 spin_lock_irq (&dev
->lock
);
1859 /* full or low speed config */
1860 dev
->config
= (void *) kbuf
;
1861 total
= le16_to_cpu(dev
->config
->wTotalLength
);
1862 if (!is_valid_config (dev
->config
) || total
>= length
)
1867 /* optional high speed config */
1868 if (kbuf
[1] == USB_DT_CONFIG
) {
1869 dev
->hs_config
= (void *) kbuf
;
1870 total
= le16_to_cpu(dev
->hs_config
->wTotalLength
);
1871 if (!is_valid_config (dev
->hs_config
) || total
>= length
)
1877 /* could support multiple configs, using another encoding! */
1879 /* device descriptor (tweaked for paranoia) */
1880 if (length
!= USB_DT_DEVICE_SIZE
)
1882 dev
->dev
= (void *)kbuf
;
1883 if (dev
->dev
->bLength
!= USB_DT_DEVICE_SIZE
1884 || dev
->dev
->bDescriptorType
!= USB_DT_DEVICE
1885 || dev
->dev
->bNumConfigurations
!= 1)
1887 dev
->dev
->bNumConfigurations
= 1;
1888 dev
->dev
->bcdUSB
= cpu_to_le16 (0x0200);
1890 /* triggers gadgetfs_bind(); then we can enumerate. */
1891 spin_unlock_irq (&dev
->lock
);
1893 gadgetfs_driver
.max_speed
= USB_SPEED_HIGH
;
1895 gadgetfs_driver
.max_speed
= USB_SPEED_FULL
;
1897 value
= usb_gadget_probe_driver(&gadgetfs_driver
);
1902 /* at this point "good" hardware has for the first time
1903 * let the USB the host see us. alternatively, if users
1904 * unplug/replug that will clear all the error state.
1906 * note: everything running before here was guaranteed
1907 * to choke driver model style diagnostics. from here
1908 * on, they can work ... except in cleanup paths that
1909 * kick in after the ep0 descriptor is closed.
1911 fd
->f_op
= &ep0_io_operations
;
1917 spin_unlock_irq (&dev
->lock
);
1918 pr_debug ("%s: %s fail %Zd, %p\n", shortname
, __func__
, value
, dev
);
1925 dev_open (struct inode
*inode
, struct file
*fd
)
1927 struct dev_data
*dev
= inode
->i_private
;
1930 spin_lock_irq(&dev
->lock
);
1931 if (dev
->state
== STATE_DEV_DISABLED
) {
1933 dev
->state
= STATE_DEV_OPENED
;
1934 fd
->private_data
= dev
;
1938 spin_unlock_irq(&dev
->lock
);
1942 static const struct file_operations dev_init_operations
= {
1943 .owner
= THIS_MODULE
,
1944 .llseek
= no_llseek
,
1947 .write
= dev_config
,
1948 .fasync
= ep0_fasync
,
1949 .unlocked_ioctl
= dev_ioctl
,
1950 .release
= dev_release
,
1953 /*----------------------------------------------------------------------*/
1955 /* FILESYSTEM AND SUPERBLOCK OPERATIONS
1957 * Mounting the filesystem creates a controller file, used first for
1958 * device configuration then later for event monitoring.
1962 /* FIXME PAM etc could set this security policy without mount options
1963 * if epfiles inherited ownership and permissons from ep0 ...
1966 static unsigned default_uid
;
1967 static unsigned default_gid
;
1968 static unsigned default_perm
= S_IRUSR
| S_IWUSR
;
1970 module_param (default_uid
, uint
, 0644);
1971 module_param (default_gid
, uint
, 0644);
1972 module_param (default_perm
, uint
, 0644);
1975 static struct inode
*
1976 gadgetfs_make_inode (struct super_block
*sb
,
1977 void *data
, const struct file_operations
*fops
,
1980 struct inode
*inode
= new_inode (sb
);
1983 inode
->i_ino
= get_next_ino();
1984 inode
->i_mode
= mode
;
1985 inode
->i_uid
= make_kuid(&init_user_ns
, default_uid
);
1986 inode
->i_gid
= make_kgid(&init_user_ns
, default_gid
);
1987 inode
->i_atime
= inode
->i_mtime
= inode
->i_ctime
1989 inode
->i_private
= data
;
1990 inode
->i_fop
= fops
;
1995 /* creates in fs root directory, so non-renamable and non-linkable.
1996 * so inode and dentry are paired, until device reconfig.
1998 static struct inode
*
1999 gadgetfs_create_file (struct super_block
*sb
, char const *name
,
2000 void *data
, const struct file_operations
*fops
,
2001 struct dentry
**dentry_p
)
2003 struct dentry
*dentry
;
2004 struct inode
*inode
;
2006 dentry
= d_alloc_name(sb
->s_root
, name
);
2010 inode
= gadgetfs_make_inode (sb
, data
, fops
,
2011 S_IFREG
| (default_perm
& S_IRWXUGO
));
2016 d_add (dentry
, inode
);
2021 static const struct super_operations gadget_fs_operations
= {
2022 .statfs
= simple_statfs
,
2023 .drop_inode
= generic_delete_inode
,
2027 gadgetfs_fill_super (struct super_block
*sb
, void *opts
, int silent
)
2029 struct inode
*inode
;
2030 struct dev_data
*dev
;
2035 /* fake probe to determine $CHIP */
2036 usb_gadget_probe_driver(&probe_driver
);
2041 sb
->s_blocksize
= PAGE_CACHE_SIZE
;
2042 sb
->s_blocksize_bits
= PAGE_CACHE_SHIFT
;
2043 sb
->s_magic
= GADGETFS_MAGIC
;
2044 sb
->s_op
= &gadget_fs_operations
;
2045 sb
->s_time_gran
= 1;
2048 inode
= gadgetfs_make_inode (sb
,
2049 NULL
, &simple_dir_operations
,
2050 S_IFDIR
| S_IRUGO
| S_IXUGO
);
2053 inode
->i_op
= &simple_dir_inode_operations
;
2054 if (!(sb
->s_root
= d_make_root (inode
)))
2057 /* the ep0 file is named after the controller we expect;
2058 * user mode code can use it for sanity checks, like we do.
2065 if (!gadgetfs_create_file (sb
, CHIP
,
2066 dev
, &dev_init_operations
,
2072 /* other endpoint files are available after hardware setup,
2073 * from binding to a controller.
2082 /* "mount -t gadgetfs path /dev/gadget" ends up here */
2083 static struct dentry
*
2084 gadgetfs_mount (struct file_system_type
*t
, int flags
,
2085 const char *path
, void *opts
)
2087 return mount_single (t
, flags
, opts
, gadgetfs_fill_super
);
2091 gadgetfs_kill_sb (struct super_block
*sb
)
2093 kill_litter_super (sb
);
2095 put_dev (the_device
);
2100 /*----------------------------------------------------------------------*/
2102 static struct file_system_type gadgetfs_type
= {
2103 .owner
= THIS_MODULE
,
2105 .mount
= gadgetfs_mount
,
2106 .kill_sb
= gadgetfs_kill_sb
,
2109 /*----------------------------------------------------------------------*/
2111 static int __init
init (void)
2115 status
= register_filesystem (&gadgetfs_type
);
2117 pr_info ("%s: %s, version " DRIVER_VERSION
"\n",
2118 shortname
, driver_desc
);
2123 static void __exit
cleanup (void)
2125 pr_debug ("unregister %s\n", shortname
);
2126 unregister_filesystem (&gadgetfs_type
);
2128 module_exit (cleanup
);