1 // SPDX-License-Identifier: GPL-2.0+
3 * inode.c -- user mode filesystem api for usb gadget controllers
5 * Copyright (C) 2003-2004 David Brownell
6 * Copyright (C) 2003 Agilent Technologies
10 /* #define VERBOSE_DEBUG */
12 #include <linux/init.h>
13 #include <linux/module.h>
15 #include <linux/pagemap.h>
16 #include <linux/uts.h>
17 #include <linux/wait.h>
18 #include <linux/compiler.h>
19 #include <linux/uaccess.h>
20 #include <linux/sched.h>
21 #include <linux/slab.h>
22 #include <linux/poll.h>
23 #include <linux/mmu_context.h>
24 #include <linux/aio.h>
25 #include <linux/uio.h>
26 #include <linux/refcount.h>
27 #include <linux/delay.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");
75 static int ep_open(struct inode
*, struct file
*);
78 /*----------------------------------------------------------------------*/
80 #define GADGETFS_MAGIC 0xaee71ee7
82 /* /dev/gadget/$CHIP represents ep0 and the whole device */
84 /* DISABLED is the initial state. */
85 STATE_DEV_DISABLED
= 0,
87 /* Only one open() of /dev/gadget/$CHIP; only one file tracks
88 * ep0/device i/o modes and binding to the controller. Driver
89 * must always write descriptors to initialize the device, then
90 * the device becomes UNCONNECTED until enumeration.
94 /* From then on, ep0 fd is in either of two basic modes:
95 * - (UN)CONNECTED: read usb_gadgetfs_event(s) from it
96 * - SETUP: read/write will transfer control data and succeed;
97 * or if "wrong direction", performs protocol stall
99 STATE_DEV_UNCONNECTED
,
103 /* UNBOUND means the driver closed ep0, so the device won't be
104 * accessible again (DEV_DISABLED) until all fds are closed.
109 /* enough for the whole queue: most events invalidate others */
116 enum ep0_state state
; /* P: lock */
117 struct usb_gadgetfs_event event
[N_EVENT
];
119 struct fasync_struct
*fasync
;
122 /* drivers reading ep0 MUST handle control requests (SETUP)
123 * reported that way; else the host will time out.
125 unsigned usermode_setup
: 1,
131 gadget_registered
: 1;
132 unsigned setup_wLength
;
134 /* the rest is basically write-once */
135 struct usb_config_descriptor
*config
, *hs_config
;
136 struct usb_device_descriptor
*dev
;
137 struct usb_request
*req
;
138 struct usb_gadget
*gadget
;
139 struct list_head epfiles
;
141 wait_queue_head_t wait
;
142 struct super_block
*sb
;
143 struct dentry
*dentry
;
145 /* except this scratch i/o buffer for ep0 */
149 static inline void get_dev (struct dev_data
*data
)
151 refcount_inc (&data
->count
);
154 static void put_dev (struct dev_data
*data
)
156 if (likely (!refcount_dec_and_test (&data
->count
)))
158 /* needs no more cleanup */
159 BUG_ON (waitqueue_active (&data
->wait
));
163 static struct dev_data
*dev_new (void)
165 struct dev_data
*dev
;
167 dev
= kzalloc(sizeof(*dev
), GFP_KERNEL
);
170 dev
->state
= STATE_DEV_DISABLED
;
171 refcount_set (&dev
->count
, 1);
172 spin_lock_init (&dev
->lock
);
173 INIT_LIST_HEAD (&dev
->epfiles
);
174 init_waitqueue_head (&dev
->wait
);
178 /*----------------------------------------------------------------------*/
180 /* other /dev/gadget/$ENDPOINT files represent endpoints */
182 STATE_EP_DISABLED
= 0,
192 struct dev_data
*dev
;
193 /* must hold dev->lock before accessing ep or req */
195 struct usb_request
*req
;
198 struct usb_endpoint_descriptor desc
, hs_desc
;
199 struct list_head epfiles
;
200 wait_queue_head_t wait
;
201 struct dentry
*dentry
;
204 static inline void get_ep (struct ep_data
*data
)
206 refcount_inc (&data
->count
);
209 static void put_ep (struct ep_data
*data
)
211 if (likely (!refcount_dec_and_test (&data
->count
)))
214 /* needs no more cleanup */
215 BUG_ON (!list_empty (&data
->epfiles
));
216 BUG_ON (waitqueue_active (&data
->wait
));
220 /*----------------------------------------------------------------------*/
222 /* most "how to use the hardware" policy choices are in userspace:
223 * mapping endpoint roles (which the driver needs) to the capabilities
224 * which the usb controller has. most of those capabilities are exposed
225 * implicitly, starting with the driver name and then endpoint names.
228 static const char *CHIP
;
230 /*----------------------------------------------------------------------*/
232 /* NOTE: don't use dev_printk calls before binding to the gadget
233 * at the end of ep0 configuration, or after unbind.
236 /* too wordy: dev_printk(level , &(d)->gadget->dev , fmt , ## args) */
237 #define xprintk(d,level,fmt,args...) \
238 printk(level "%s: " fmt , shortname , ## args)
241 #define DBG(dev,fmt,args...) \
242 xprintk(dev , KERN_DEBUG , fmt , ## args)
244 #define DBG(dev,fmt,args...) \
251 #define VDEBUG(dev,fmt,args...) \
255 #define ERROR(dev,fmt,args...) \
256 xprintk(dev , KERN_ERR , fmt , ## args)
257 #define INFO(dev,fmt,args...) \
258 xprintk(dev , KERN_INFO , fmt , ## args)
261 /*----------------------------------------------------------------------*/
263 /* SYNCHRONOUS ENDPOINT OPERATIONS (bulk/intr/iso)
265 * After opening, configure non-control endpoints. Then use normal
266 * stream read() and write() requests; and maybe ioctl() to get more
267 * precise FIFO status when recovering from cancellation.
270 static void epio_complete (struct usb_ep
*ep
, struct usb_request
*req
)
272 struct ep_data
*epdata
= ep
->driver_data
;
277 epdata
->status
= req
->status
;
279 epdata
->status
= req
->actual
;
280 complete ((struct completion
*)req
->context
);
283 /* tasklock endpoint, returning when it's connected.
284 * still need dev->lock to use epdata->ep.
287 get_ready_ep (unsigned f_flags
, struct ep_data
*epdata
, bool is_write
)
291 if (f_flags
& O_NONBLOCK
) {
292 if (!mutex_trylock(&epdata
->lock
))
294 if (epdata
->state
!= STATE_EP_ENABLED
&&
295 (!is_write
|| epdata
->state
!= STATE_EP_READY
)) {
296 mutex_unlock(&epdata
->lock
);
304 val
= mutex_lock_interruptible(&epdata
->lock
);
308 switch (epdata
->state
) {
309 case STATE_EP_ENABLED
:
311 case STATE_EP_READY
: /* not configured yet */
315 case STATE_EP_UNBOUND
: /* clean disconnect */
317 // case STATE_EP_DISABLED: /* "can't happen" */
318 default: /* error! */
319 pr_debug ("%s: ep %p not available, state %d\n",
320 shortname
, epdata
, epdata
->state
);
322 mutex_unlock(&epdata
->lock
);
327 ep_io (struct ep_data
*epdata
, void *buf
, unsigned len
)
329 DECLARE_COMPLETION_ONSTACK (done
);
332 spin_lock_irq (&epdata
->dev
->lock
);
333 if (likely (epdata
->ep
!= NULL
)) {
334 struct usb_request
*req
= epdata
->req
;
336 req
->context
= &done
;
337 req
->complete
= epio_complete
;
340 value
= usb_ep_queue (epdata
->ep
, req
, GFP_ATOMIC
);
343 spin_unlock_irq (&epdata
->dev
->lock
);
345 if (likely (value
== 0)) {
346 value
= wait_event_interruptible (done
.wait
, done
.done
);
348 spin_lock_irq (&epdata
->dev
->lock
);
349 if (likely (epdata
->ep
!= NULL
)) {
350 DBG (epdata
->dev
, "%s i/o interrupted\n",
352 usb_ep_dequeue (epdata
->ep
, epdata
->req
);
353 spin_unlock_irq (&epdata
->dev
->lock
);
355 wait_event (done
.wait
, done
.done
);
356 if (epdata
->status
== -ECONNRESET
)
357 epdata
->status
= -EINTR
;
359 spin_unlock_irq (&epdata
->dev
->lock
);
361 DBG (epdata
->dev
, "endpoint gone\n");
362 epdata
->status
= -ENODEV
;
365 return epdata
->status
;
371 ep_release (struct inode
*inode
, struct file
*fd
)
373 struct ep_data
*data
= fd
->private_data
;
376 value
= mutex_lock_interruptible(&data
->lock
);
380 /* clean up if this can be reopened */
381 if (data
->state
!= STATE_EP_UNBOUND
) {
382 data
->state
= STATE_EP_DISABLED
;
383 data
->desc
.bDescriptorType
= 0;
384 data
->hs_desc
.bDescriptorType
= 0;
385 usb_ep_disable(data
->ep
);
387 mutex_unlock(&data
->lock
);
392 static long ep_ioctl(struct file
*fd
, unsigned code
, unsigned long value
)
394 struct ep_data
*data
= fd
->private_data
;
397 if ((status
= get_ready_ep (fd
->f_flags
, data
, false)) < 0)
400 spin_lock_irq (&data
->dev
->lock
);
401 if (likely (data
->ep
!= NULL
)) {
403 case GADGETFS_FIFO_STATUS
:
404 status
= usb_ep_fifo_status (data
->ep
);
406 case GADGETFS_FIFO_FLUSH
:
407 usb_ep_fifo_flush (data
->ep
);
409 case GADGETFS_CLEAR_HALT
:
410 status
= usb_ep_clear_halt (data
->ep
);
417 spin_unlock_irq (&data
->dev
->lock
);
418 mutex_unlock(&data
->lock
);
422 /*----------------------------------------------------------------------*/
424 /* ASYNCHRONOUS ENDPOINT I/O OPERATIONS (bulk/intr/iso) */
427 struct usb_request
*req
;
428 struct ep_data
*epdata
;
430 struct mm_struct
*mm
;
431 struct work_struct work
;
438 static int ep_aio_cancel(struct kiocb
*iocb
)
440 struct kiocb_priv
*priv
= iocb
->private;
441 struct ep_data
*epdata
;
445 epdata
= priv
->epdata
;
446 // spin_lock(&epdata->dev->lock);
447 if (likely(epdata
&& epdata
->ep
&& priv
->req
))
448 value
= usb_ep_dequeue (epdata
->ep
, priv
->req
);
451 // spin_unlock(&epdata->dev->lock);
457 static void ep_user_copy_worker(struct work_struct
*work
)
459 struct kiocb_priv
*priv
= container_of(work
, struct kiocb_priv
, work
);
460 struct mm_struct
*mm
= priv
->mm
;
461 struct kiocb
*iocb
= priv
->iocb
;
465 ret
= copy_to_iter(priv
->buf
, priv
->actual
, &priv
->to
);
470 /* completing the iocb can drop the ctx and mm, don't touch mm after */
471 iocb
->ki_complete(iocb
, ret
, ret
);
474 kfree(priv
->to_free
);
478 static void ep_aio_complete(struct usb_ep
*ep
, struct usb_request
*req
)
480 struct kiocb
*iocb
= req
->context
;
481 struct kiocb_priv
*priv
= iocb
->private;
482 struct ep_data
*epdata
= priv
->epdata
;
484 /* lock against disconnect (and ideally, cancel) */
485 spin_lock(&epdata
->dev
->lock
);
489 /* if this was a write or a read returning no data then we
490 * don't need to copy anything to userspace, so we can
491 * complete the aio request immediately.
493 if (priv
->to_free
== NULL
|| unlikely(req
->actual
== 0)) {
495 kfree(priv
->to_free
);
497 iocb
->private = NULL
;
498 /* aio_complete() reports bytes-transferred _and_ faults */
500 iocb
->ki_complete(iocb
, req
->actual
? req
->actual
: req
->status
,
503 /* ep_copy_to_user() won't report both; we hide some faults */
504 if (unlikely(0 != req
->status
))
505 DBG(epdata
->dev
, "%s fault %d len %d\n",
506 ep
->name
, req
->status
, req
->actual
);
508 priv
->buf
= req
->buf
;
509 priv
->actual
= req
->actual
;
510 INIT_WORK(&priv
->work
, ep_user_copy_worker
);
511 schedule_work(&priv
->work
);
514 usb_ep_free_request(ep
, req
);
515 spin_unlock(&epdata
->dev
->lock
);
519 static ssize_t
ep_aio(struct kiocb
*iocb
,
520 struct kiocb_priv
*priv
,
521 struct ep_data
*epdata
,
525 struct usb_request
*req
;
528 iocb
->private = priv
;
531 kiocb_set_cancel_fn(iocb
, ep_aio_cancel
);
533 priv
->epdata
= epdata
;
535 priv
->mm
= current
->mm
; /* mm teardown waits for iocbs in exit_aio() */
537 /* each kiocb is coupled to one usb_request, but we can't
538 * allocate or submit those if the host disconnected.
540 spin_lock_irq(&epdata
->dev
->lock
);
542 if (unlikely(epdata
->ep
== NULL
))
545 req
= usb_ep_alloc_request(epdata
->ep
, GFP_ATOMIC
);
553 req
->complete
= ep_aio_complete
;
555 value
= usb_ep_queue(epdata
->ep
, req
, GFP_ATOMIC
);
556 if (unlikely(0 != value
)) {
557 usb_ep_free_request(epdata
->ep
, req
);
560 spin_unlock_irq(&epdata
->dev
->lock
);
564 spin_unlock_irq(&epdata
->dev
->lock
);
565 kfree(priv
->to_free
);
572 ep_read_iter(struct kiocb
*iocb
, struct iov_iter
*to
)
574 struct file
*file
= iocb
->ki_filp
;
575 struct ep_data
*epdata
= file
->private_data
;
576 size_t len
= iov_iter_count(to
);
580 if ((value
= get_ready_ep(file
->f_flags
, epdata
, false)) < 0)
583 /* halt any endpoint by doing a "wrong direction" i/o call */
584 if (usb_endpoint_dir_in(&epdata
->desc
)) {
585 if (usb_endpoint_xfer_isoc(&epdata
->desc
) ||
586 !is_sync_kiocb(iocb
)) {
587 mutex_unlock(&epdata
->lock
);
590 DBG (epdata
->dev
, "%s halt\n", epdata
->name
);
591 spin_lock_irq(&epdata
->dev
->lock
);
592 if (likely(epdata
->ep
!= NULL
))
593 usb_ep_set_halt(epdata
->ep
);
594 spin_unlock_irq(&epdata
->dev
->lock
);
595 mutex_unlock(&epdata
->lock
);
599 buf
= kmalloc(len
, GFP_KERNEL
);
600 if (unlikely(!buf
)) {
601 mutex_unlock(&epdata
->lock
);
604 if (is_sync_kiocb(iocb
)) {
605 value
= ep_io(epdata
, buf
, len
);
606 if (value
>= 0 && (copy_to_iter(buf
, value
, to
) != value
))
609 struct kiocb_priv
*priv
= kzalloc(sizeof *priv
, GFP_KERNEL
);
613 priv
->to_free
= dup_iter(&priv
->to
, to
, GFP_KERNEL
);
614 if (!priv
->to_free
) {
618 value
= ep_aio(iocb
, priv
, epdata
, buf
, len
);
619 if (value
== -EIOCBQUEUED
)
624 mutex_unlock(&epdata
->lock
);
628 static ssize_t
ep_config(struct ep_data
*, const char *, size_t);
631 ep_write_iter(struct kiocb
*iocb
, struct iov_iter
*from
)
633 struct file
*file
= iocb
->ki_filp
;
634 struct ep_data
*epdata
= file
->private_data
;
635 size_t len
= iov_iter_count(from
);
640 if ((value
= get_ready_ep(file
->f_flags
, epdata
, true)) < 0)
643 configured
= epdata
->state
== STATE_EP_ENABLED
;
645 /* halt any endpoint by doing a "wrong direction" i/o call */
646 if (configured
&& !usb_endpoint_dir_in(&epdata
->desc
)) {
647 if (usb_endpoint_xfer_isoc(&epdata
->desc
) ||
648 !is_sync_kiocb(iocb
)) {
649 mutex_unlock(&epdata
->lock
);
652 DBG (epdata
->dev
, "%s halt\n", epdata
->name
);
653 spin_lock_irq(&epdata
->dev
->lock
);
654 if (likely(epdata
->ep
!= NULL
))
655 usb_ep_set_halt(epdata
->ep
);
656 spin_unlock_irq(&epdata
->dev
->lock
);
657 mutex_unlock(&epdata
->lock
);
661 buf
= kmalloc(len
, GFP_KERNEL
);
662 if (unlikely(!buf
)) {
663 mutex_unlock(&epdata
->lock
);
667 if (unlikely(!copy_from_iter_full(buf
, len
, from
))) {
672 if (unlikely(!configured
)) {
673 value
= ep_config(epdata
, buf
, len
);
674 } else if (is_sync_kiocb(iocb
)) {
675 value
= ep_io(epdata
, buf
, len
);
677 struct kiocb_priv
*priv
= kzalloc(sizeof *priv
, GFP_KERNEL
);
680 value
= ep_aio(iocb
, priv
, epdata
, buf
, len
);
681 if (value
== -EIOCBQUEUED
)
687 mutex_unlock(&epdata
->lock
);
691 /*----------------------------------------------------------------------*/
693 /* used after endpoint configuration */
694 static const struct file_operations ep_io_operations
= {
695 .owner
= THIS_MODULE
,
698 .release
= ep_release
,
700 .unlocked_ioctl
= ep_ioctl
,
701 .read_iter
= ep_read_iter
,
702 .write_iter
= ep_write_iter
,
705 /* ENDPOINT INITIALIZATION
707 * fd = open ("/dev/gadget/$ENDPOINT", O_RDWR)
708 * status = write (fd, descriptors, sizeof descriptors)
710 * That write establishes the endpoint configuration, configuring
711 * the controller to process bulk, interrupt, or isochronous transfers
712 * at the right maxpacket size, and so on.
714 * The descriptors are message type 1, identified by a host order u32
715 * at the beginning of what's written. Descriptor order is: full/low
716 * speed descriptor, then optional high speed descriptor.
719 ep_config (struct ep_data
*data
, const char *buf
, size_t len
)
723 int value
, length
= len
;
725 if (data
->state
!= STATE_EP_READY
) {
731 if (len
< USB_DT_ENDPOINT_SIZE
+ 4)
734 /* we might need to change message format someday */
735 memcpy(&tag
, buf
, 4);
737 DBG(data
->dev
, "config %s, bad tag %d\n", data
->name
, tag
);
743 /* NOTE: audio endpoint extensions not accepted here;
744 * just don't include the extra bytes.
747 /* full/low speed descriptor, then high speed */
748 memcpy(&data
->desc
, buf
, USB_DT_ENDPOINT_SIZE
);
749 if (data
->desc
.bLength
!= USB_DT_ENDPOINT_SIZE
750 || data
->desc
.bDescriptorType
!= USB_DT_ENDPOINT
)
752 if (len
!= USB_DT_ENDPOINT_SIZE
) {
753 if (len
!= 2 * USB_DT_ENDPOINT_SIZE
)
755 memcpy(&data
->hs_desc
, buf
+ USB_DT_ENDPOINT_SIZE
,
756 USB_DT_ENDPOINT_SIZE
);
757 if (data
->hs_desc
.bLength
!= USB_DT_ENDPOINT_SIZE
758 || data
->hs_desc
.bDescriptorType
759 != USB_DT_ENDPOINT
) {
760 DBG(data
->dev
, "config %s, bad hs length or type\n",
766 spin_lock_irq (&data
->dev
->lock
);
767 if (data
->dev
->state
== STATE_DEV_UNBOUND
) {
777 switch (data
->dev
->gadget
->speed
) {
780 ep
->desc
= &data
->desc
;
783 /* fails if caller didn't provide that descriptor... */
784 ep
->desc
= &data
->hs_desc
;
787 DBG(data
->dev
, "unconnected, %s init abandoned\n",
792 value
= usb_ep_enable(ep
);
794 data
->state
= STATE_EP_ENABLED
;
798 spin_unlock_irq (&data
->dev
->lock
);
801 data
->desc
.bDescriptorType
= 0;
802 data
->hs_desc
.bDescriptorType
= 0;
811 ep_open (struct inode
*inode
, struct file
*fd
)
813 struct ep_data
*data
= inode
->i_private
;
816 if (mutex_lock_interruptible(&data
->lock
) != 0)
818 spin_lock_irq (&data
->dev
->lock
);
819 if (data
->dev
->state
== STATE_DEV_UNBOUND
)
821 else if (data
->state
== STATE_EP_DISABLED
) {
823 data
->state
= STATE_EP_READY
;
825 fd
->private_data
= data
;
826 VDEBUG (data
->dev
, "%s ready\n", data
->name
);
828 DBG (data
->dev
, "%s state %d\n",
829 data
->name
, data
->state
);
830 spin_unlock_irq (&data
->dev
->lock
);
831 mutex_unlock(&data
->lock
);
835 /*----------------------------------------------------------------------*/
837 /* EP0 IMPLEMENTATION can be partly in userspace.
839 * Drivers that use this facility receive various events, including
840 * control requests the kernel doesn't handle. Drivers that don't
841 * use this facility may be too simple-minded for real applications.
844 static inline void ep0_readable (struct dev_data
*dev
)
846 wake_up (&dev
->wait
);
847 kill_fasync (&dev
->fasync
, SIGIO
, POLL_IN
);
850 static void clean_req (struct usb_ep
*ep
, struct usb_request
*req
)
852 struct dev_data
*dev
= ep
->driver_data
;
854 if (req
->buf
!= dev
->rbuf
) {
856 req
->buf
= dev
->rbuf
;
858 req
->complete
= epio_complete
;
859 dev
->setup_out_ready
= 0;
862 static void ep0_complete (struct usb_ep
*ep
, struct usb_request
*req
)
864 struct dev_data
*dev
= ep
->driver_data
;
868 /* for control OUT, data must still get to userspace */
869 spin_lock_irqsave(&dev
->lock
, flags
);
870 if (!dev
->setup_in
) {
871 dev
->setup_out_error
= (req
->status
!= 0);
872 if (!dev
->setup_out_error
)
874 dev
->setup_out_ready
= 1;
878 /* clean up as appropriate */
879 if (free
&& req
->buf
!= &dev
->rbuf
)
881 req
->complete
= epio_complete
;
882 spin_unlock_irqrestore(&dev
->lock
, flags
);
885 static int setup_req (struct usb_ep
*ep
, struct usb_request
*req
, u16 len
)
887 struct dev_data
*dev
= ep
->driver_data
;
889 if (dev
->setup_out_ready
) {
890 DBG (dev
, "ep0 request busy!\n");
893 if (len
> sizeof (dev
->rbuf
))
894 req
->buf
= kmalloc(len
, GFP_ATOMIC
);
895 if (req
->buf
== NULL
) {
896 req
->buf
= dev
->rbuf
;
899 req
->complete
= ep0_complete
;
906 ep0_read (struct file
*fd
, char __user
*buf
, size_t len
, loff_t
*ptr
)
908 struct dev_data
*dev
= fd
->private_data
;
910 enum ep0_state state
;
912 spin_lock_irq (&dev
->lock
);
913 if (dev
->state
<= STATE_DEV_OPENED
) {
918 /* report fd mode change before acting on it */
919 if (dev
->setup_abort
) {
920 dev
->setup_abort
= 0;
925 /* control DATA stage */
926 if ((state
= dev
->state
) == STATE_DEV_SETUP
) {
928 if (dev
->setup_in
) { /* stall IN */
929 VDEBUG(dev
, "ep0in stall\n");
930 (void) usb_ep_set_halt (dev
->gadget
->ep0
);
932 dev
->state
= STATE_DEV_CONNECTED
;
934 } else if (len
== 0) { /* ack SET_CONFIGURATION etc */
935 struct usb_ep
*ep
= dev
->gadget
->ep0
;
936 struct usb_request
*req
= dev
->req
;
938 if ((retval
= setup_req (ep
, req
, 0)) == 0) {
940 spin_unlock_irq (&dev
->lock
);
941 retval
= usb_ep_queue (ep
, req
, GFP_KERNEL
);
942 spin_lock_irq (&dev
->lock
);
945 dev
->state
= STATE_DEV_CONNECTED
;
947 /* assume that was SET_CONFIGURATION */
948 if (dev
->current_config
) {
951 if (gadget_is_dualspeed(dev
->gadget
)
952 && (dev
->gadget
->speed
954 power
= dev
->hs_config
->bMaxPower
;
956 power
= dev
->config
->bMaxPower
;
957 usb_gadget_vbus_draw(dev
->gadget
, 2 * power
);
960 } else { /* collect OUT data */
961 if ((fd
->f_flags
& O_NONBLOCK
) != 0
962 && !dev
->setup_out_ready
) {
966 spin_unlock_irq (&dev
->lock
);
967 retval
= wait_event_interruptible (dev
->wait
,
968 dev
->setup_out_ready
!= 0);
970 /* FIXME state could change from under us */
971 spin_lock_irq (&dev
->lock
);
975 if (dev
->state
!= STATE_DEV_SETUP
) {
979 dev
->state
= STATE_DEV_CONNECTED
;
981 if (dev
->setup_out_error
)
984 len
= min (len
, (size_t)dev
->req
->actual
);
986 spin_unlock_irq(&dev
->lock
);
987 if (copy_to_user (buf
, dev
->req
->buf
, len
))
991 spin_lock_irq(&dev
->lock
);
993 clean_req (dev
->gadget
->ep0
, dev
->req
);
994 /* NOTE userspace can't yet choose to stall */
1000 /* else normal: return event data */
1001 if (len
< sizeof dev
->event
[0]) {
1005 len
-= len
% sizeof (struct usb_gadgetfs_event
);
1006 dev
->usermode_setup
= 1;
1009 /* return queued events right away */
1010 if (dev
->ev_next
!= 0) {
1013 n
= len
/ sizeof (struct usb_gadgetfs_event
);
1014 if (dev
->ev_next
< n
)
1017 /* ep0 i/o has special semantics during STATE_DEV_SETUP */
1018 for (i
= 0; i
< n
; i
++) {
1019 if (dev
->event
[i
].type
== GADGETFS_SETUP
) {
1020 dev
->state
= STATE_DEV_SETUP
;
1025 spin_unlock_irq (&dev
->lock
);
1026 len
= n
* sizeof (struct usb_gadgetfs_event
);
1027 if (copy_to_user (buf
, &dev
->event
, len
))
1032 /* NOTE this doesn't guard against broken drivers;
1033 * concurrent ep0 readers may lose events.
1035 spin_lock_irq (&dev
->lock
);
1036 if (dev
->ev_next
> n
) {
1037 memmove(&dev
->event
[0], &dev
->event
[n
],
1038 sizeof (struct usb_gadgetfs_event
)
1039 * (dev
->ev_next
- n
));
1042 spin_unlock_irq (&dev
->lock
);
1046 if (fd
->f_flags
& O_NONBLOCK
) {
1053 DBG (dev
, "fail %s, state %d\n", __func__
, state
);
1056 case STATE_DEV_UNCONNECTED
:
1057 case STATE_DEV_CONNECTED
:
1058 spin_unlock_irq (&dev
->lock
);
1059 DBG (dev
, "%s wait\n", __func__
);
1061 /* wait for events */
1062 retval
= wait_event_interruptible (dev
->wait
,
1066 spin_lock_irq (&dev
->lock
);
1071 spin_unlock_irq (&dev
->lock
);
1075 static struct usb_gadgetfs_event
*
1076 next_event (struct dev_data
*dev
, enum usb_gadgetfs_event_type type
)
1078 struct usb_gadgetfs_event
*event
;
1082 /* these events purge the queue */
1083 case GADGETFS_DISCONNECT
:
1084 if (dev
->state
== STATE_DEV_SETUP
)
1085 dev
->setup_abort
= 1;
1087 case GADGETFS_CONNECT
:
1090 case GADGETFS_SETUP
: /* previous request timed out */
1091 case GADGETFS_SUSPEND
: /* same effect */
1092 /* these events can't be repeated */
1093 for (i
= 0; i
!= dev
->ev_next
; i
++) {
1094 if (dev
->event
[i
].type
!= type
)
1096 DBG(dev
, "discard old event[%d] %d\n", i
, type
);
1098 if (i
== dev
->ev_next
)
1100 /* indices start at zero, for simplicity */
1101 memmove (&dev
->event
[i
], &dev
->event
[i
+ 1],
1102 sizeof (struct usb_gadgetfs_event
)
1103 * (dev
->ev_next
- i
));
1109 VDEBUG(dev
, "event[%d] = %d\n", dev
->ev_next
, type
);
1110 event
= &dev
->event
[dev
->ev_next
++];
1111 BUG_ON (dev
->ev_next
> N_EVENT
);
1112 memset (event
, 0, sizeof *event
);
1118 ep0_write (struct file
*fd
, const char __user
*buf
, size_t len
, loff_t
*ptr
)
1120 struct dev_data
*dev
= fd
->private_data
;
1121 ssize_t retval
= -ESRCH
;
1123 /* report fd mode change before acting on it */
1124 if (dev
->setup_abort
) {
1125 dev
->setup_abort
= 0;
1128 /* data and/or status stage for control request */
1129 } else if (dev
->state
== STATE_DEV_SETUP
) {
1131 len
= min_t(size_t, len
, dev
->setup_wLength
);
1132 if (dev
->setup_in
) {
1133 retval
= setup_req (dev
->gadget
->ep0
, dev
->req
, len
);
1135 dev
->state
= STATE_DEV_CONNECTED
;
1137 spin_unlock_irq (&dev
->lock
);
1138 if (copy_from_user (dev
->req
->buf
, buf
, len
))
1141 if (len
< dev
->setup_wLength
)
1143 retval
= usb_ep_queue (
1144 dev
->gadget
->ep0
, dev
->req
,
1147 spin_lock_irq(&dev
->lock
);
1150 clean_req (dev
->gadget
->ep0
, dev
->req
);
1157 /* can stall some OUT transfers */
1158 } else if (dev
->setup_can_stall
) {
1159 VDEBUG(dev
, "ep0out stall\n");
1160 (void) usb_ep_set_halt (dev
->gadget
->ep0
);
1162 dev
->state
= STATE_DEV_CONNECTED
;
1164 DBG(dev
, "bogus ep0out stall!\n");
1167 DBG (dev
, "fail %s, state %d\n", __func__
, dev
->state
);
1173 ep0_fasync (int f
, struct file
*fd
, int on
)
1175 struct dev_data
*dev
= fd
->private_data
;
1176 // caller must F_SETOWN before signal delivery happens
1177 VDEBUG (dev
, "%s %s\n", __func__
, on
? "on" : "off");
1178 return fasync_helper (f
, fd
, on
, &dev
->fasync
);
1181 static struct usb_gadget_driver gadgetfs_driver
;
1184 dev_release (struct inode
*inode
, struct file
*fd
)
1186 struct dev_data
*dev
= fd
->private_data
;
1188 /* closing ep0 === shutdown all */
1190 if (dev
->gadget_registered
) {
1191 usb_gadget_unregister_driver (&gadgetfs_driver
);
1192 dev
->gadget_registered
= false;
1195 /* at this point "good" hardware has disconnected the
1196 * device from USB; the host won't see it any more.
1197 * alternatively, all host requests will time out.
1203 /* other endpoints were all decoupled from this device */
1204 spin_lock_irq(&dev
->lock
);
1205 dev
->state
= STATE_DEV_DISABLED
;
1206 spin_unlock_irq(&dev
->lock
);
1213 ep0_poll (struct file
*fd
, poll_table
*wait
)
1215 struct dev_data
*dev
= fd
->private_data
;
1218 if (dev
->state
<= STATE_DEV_OPENED
)
1219 return DEFAULT_POLLMASK
;
1221 poll_wait(fd
, &dev
->wait
, wait
);
1223 spin_lock_irq (&dev
->lock
);
1225 /* report fd mode change before acting on it */
1226 if (dev
->setup_abort
) {
1227 dev
->setup_abort
= 0;
1232 if (dev
->state
== STATE_DEV_SETUP
) {
1233 if (dev
->setup_in
|| dev
->setup_can_stall
)
1236 if (dev
->ev_next
!= 0)
1240 spin_unlock_irq(&dev
->lock
);
1244 static long dev_ioctl (struct file
*fd
, unsigned code
, unsigned long value
)
1246 struct dev_data
*dev
= fd
->private_data
;
1247 struct usb_gadget
*gadget
= dev
->gadget
;
1250 spin_lock_irq(&dev
->lock
);
1251 if (dev
->state
== STATE_DEV_OPENED
||
1252 dev
->state
== STATE_DEV_UNBOUND
) {
1253 /* Not bound to a UDC */
1254 } else if (gadget
->ops
->ioctl
) {
1256 spin_unlock_irq(&dev
->lock
);
1258 ret
= gadget
->ops
->ioctl (gadget
, code
, value
);
1260 spin_lock_irq(&dev
->lock
);
1263 spin_unlock_irq(&dev
->lock
);
1268 /*----------------------------------------------------------------------*/
1270 /* The in-kernel gadget driver handles most ep0 issues, in particular
1271 * enumerating the single configuration (as provided from user space).
1273 * Unrecognized ep0 requests may be handled in user space.
1276 static void make_qualifier (struct dev_data
*dev
)
1278 struct usb_qualifier_descriptor qual
;
1279 struct usb_device_descriptor
*desc
;
1281 qual
.bLength
= sizeof qual
;
1282 qual
.bDescriptorType
= USB_DT_DEVICE_QUALIFIER
;
1283 qual
.bcdUSB
= cpu_to_le16 (0x0200);
1286 qual
.bDeviceClass
= desc
->bDeviceClass
;
1287 qual
.bDeviceSubClass
= desc
->bDeviceSubClass
;
1288 qual
.bDeviceProtocol
= desc
->bDeviceProtocol
;
1290 /* assumes ep0 uses the same value for both speeds ... */
1291 qual
.bMaxPacketSize0
= dev
->gadget
->ep0
->maxpacket
;
1293 qual
.bNumConfigurations
= 1;
1296 memcpy (dev
->rbuf
, &qual
, sizeof qual
);
1300 config_buf (struct dev_data
*dev
, u8 type
, unsigned index
)
1305 /* only one configuration */
1309 if (gadget_is_dualspeed(dev
->gadget
)) {
1310 hs
= (dev
->gadget
->speed
== USB_SPEED_HIGH
);
1311 if (type
== USB_DT_OTHER_SPEED_CONFIG
)
1315 dev
->req
->buf
= dev
->hs_config
;
1316 len
= le16_to_cpu(dev
->hs_config
->wTotalLength
);
1318 dev
->req
->buf
= dev
->config
;
1319 len
= le16_to_cpu(dev
->config
->wTotalLength
);
1321 ((u8
*)dev
->req
->buf
) [1] = type
;
1326 gadgetfs_setup (struct usb_gadget
*gadget
, const struct usb_ctrlrequest
*ctrl
)
1328 struct dev_data
*dev
= get_gadget_data (gadget
);
1329 struct usb_request
*req
= dev
->req
;
1330 int value
= -EOPNOTSUPP
;
1331 struct usb_gadgetfs_event
*event
;
1332 u16 w_value
= le16_to_cpu(ctrl
->wValue
);
1333 u16 w_length
= le16_to_cpu(ctrl
->wLength
);
1335 spin_lock (&dev
->lock
);
1336 dev
->setup_abort
= 0;
1337 if (dev
->state
== STATE_DEV_UNCONNECTED
) {
1338 if (gadget_is_dualspeed(gadget
)
1339 && gadget
->speed
== USB_SPEED_HIGH
1340 && dev
->hs_config
== NULL
) {
1341 spin_unlock(&dev
->lock
);
1342 ERROR (dev
, "no high speed config??\n");
1346 dev
->state
= STATE_DEV_CONNECTED
;
1348 INFO (dev
, "connected\n");
1349 event
= next_event (dev
, GADGETFS_CONNECT
);
1350 event
->u
.speed
= gadget
->speed
;
1353 /* host may have given up waiting for response. we can miss control
1354 * requests handled lower down (device/endpoint status and features);
1355 * then ep0_{read,write} will report the wrong status. controller
1356 * driver will have aborted pending i/o.
1358 } else if (dev
->state
== STATE_DEV_SETUP
)
1359 dev
->setup_abort
= 1;
1361 req
->buf
= dev
->rbuf
;
1362 req
->context
= NULL
;
1363 value
= -EOPNOTSUPP
;
1364 switch (ctrl
->bRequest
) {
1366 case USB_REQ_GET_DESCRIPTOR
:
1367 if (ctrl
->bRequestType
!= USB_DIR_IN
)
1369 switch (w_value
>> 8) {
1372 value
= min (w_length
, (u16
) sizeof *dev
->dev
);
1373 dev
->dev
->bMaxPacketSize0
= dev
->gadget
->ep0
->maxpacket
;
1374 req
->buf
= dev
->dev
;
1376 case USB_DT_DEVICE_QUALIFIER
:
1377 if (!dev
->hs_config
)
1379 value
= min (w_length
, (u16
)
1380 sizeof (struct usb_qualifier_descriptor
));
1381 make_qualifier (dev
);
1383 case USB_DT_OTHER_SPEED_CONFIG
:
1386 value
= config_buf (dev
,
1390 value
= min (w_length
, (u16
) value
);
1395 default: // all others are errors
1400 /* currently one config, two speeds */
1401 case USB_REQ_SET_CONFIGURATION
:
1402 if (ctrl
->bRequestType
!= 0)
1404 if (0 == (u8
) w_value
) {
1406 dev
->current_config
= 0;
1407 usb_gadget_vbus_draw(gadget
, 8 /* mA */ );
1408 // user mode expected to disable endpoints
1412 if (gadget_is_dualspeed(gadget
)
1413 && gadget
->speed
== USB_SPEED_HIGH
) {
1414 config
= dev
->hs_config
->bConfigurationValue
;
1415 power
= dev
->hs_config
->bMaxPower
;
1417 config
= dev
->config
->bConfigurationValue
;
1418 power
= dev
->config
->bMaxPower
;
1421 if (config
== (u8
) w_value
) {
1423 dev
->current_config
= config
;
1424 usb_gadget_vbus_draw(gadget
, 2 * power
);
1428 /* report SET_CONFIGURATION like any other control request,
1429 * except that usermode may not stall this. the next
1430 * request mustn't be allowed start until this finishes:
1431 * endpoints and threads set up, etc.
1433 * NOTE: older PXA hardware (before PXA 255: without UDCCFR)
1434 * has bad/racey automagic that prevents synchronizing here.
1435 * even kernel mode drivers often miss them.
1438 INFO (dev
, "configuration #%d\n", dev
->current_config
);
1439 usb_gadget_set_state(gadget
, USB_STATE_CONFIGURED
);
1440 if (dev
->usermode_setup
) {
1441 dev
->setup_can_stall
= 0;
1447 #ifndef CONFIG_USB_PXA25X
1448 /* PXA automagically handles this request too */
1449 case USB_REQ_GET_CONFIGURATION
:
1450 if (ctrl
->bRequestType
!= 0x80)
1452 *(u8
*)req
->buf
= dev
->current_config
;
1453 value
= min (w_length
, (u16
) 1);
1459 VDEBUG (dev
, "%s req%02x.%02x v%04x i%04x l%d\n",
1460 dev
->usermode_setup
? "delegate" : "fail",
1461 ctrl
->bRequestType
, ctrl
->bRequest
,
1462 w_value
, le16_to_cpu(ctrl
->wIndex
), w_length
);
1464 /* if there's an ep0 reader, don't stall */
1465 if (dev
->usermode_setup
) {
1466 dev
->setup_can_stall
= 1;
1468 dev
->setup_in
= (ctrl
->bRequestType
& USB_DIR_IN
)
1470 dev
->setup_wLength
= w_length
;
1471 dev
->setup_out_ready
= 0;
1472 dev
->setup_out_error
= 0;
1474 /* read DATA stage for OUT right away */
1475 if (unlikely (!dev
->setup_in
&& w_length
)) {
1476 value
= setup_req (gadget
->ep0
, dev
->req
,
1482 spin_unlock (&dev
->lock
);
1483 value
= usb_ep_queue (gadget
->ep0
, dev
->req
,
1485 spin_lock (&dev
->lock
);
1488 clean_req (gadget
->ep0
, dev
->req
);
1492 /* we can't currently stall these */
1493 dev
->setup_can_stall
= 0;
1496 /* state changes when reader collects event */
1497 event
= next_event (dev
, GADGETFS_SETUP
);
1498 event
->u
.setup
= *ctrl
;
1500 spin_unlock (&dev
->lock
);
1505 /* proceed with data transfer and status phases? */
1506 if (value
>= 0 && dev
->state
!= STATE_DEV_SETUP
) {
1507 req
->length
= value
;
1508 req
->zero
= value
< w_length
;
1511 spin_unlock (&dev
->lock
);
1512 value
= usb_ep_queue (gadget
->ep0
, req
, GFP_KERNEL
);
1513 spin_lock(&dev
->lock
);
1515 spin_unlock(&dev
->lock
);
1517 DBG (dev
, "ep_queue --> %d\n", value
);
1523 /* device stalls when value < 0 */
1524 spin_unlock (&dev
->lock
);
1528 static void destroy_ep_files (struct dev_data
*dev
)
1530 DBG (dev
, "%s %d\n", __func__
, dev
->state
);
1532 /* dev->state must prevent interference */
1533 spin_lock_irq (&dev
->lock
);
1534 while (!list_empty(&dev
->epfiles
)) {
1536 struct inode
*parent
;
1537 struct dentry
*dentry
;
1539 /* break link to FS */
1540 ep
= list_first_entry (&dev
->epfiles
, struct ep_data
, epfiles
);
1541 list_del_init (&ep
->epfiles
);
1542 spin_unlock_irq (&dev
->lock
);
1544 dentry
= ep
->dentry
;
1546 parent
= d_inode(dentry
->d_parent
);
1548 /* break link to controller */
1549 mutex_lock(&ep
->lock
);
1550 if (ep
->state
== STATE_EP_ENABLED
)
1551 (void) usb_ep_disable (ep
->ep
);
1552 ep
->state
= STATE_EP_UNBOUND
;
1553 usb_ep_free_request (ep
->ep
, ep
->req
);
1555 mutex_unlock(&ep
->lock
);
1557 wake_up (&ep
->wait
);
1560 /* break link to dcache */
1564 inode_unlock(parent
);
1566 spin_lock_irq (&dev
->lock
);
1568 spin_unlock_irq (&dev
->lock
);
1572 static struct dentry
*
1573 gadgetfs_create_file (struct super_block
*sb
, char const *name
,
1574 void *data
, const struct file_operations
*fops
);
1576 static int activate_ep_files (struct dev_data
*dev
)
1579 struct ep_data
*data
;
1581 gadget_for_each_ep (ep
, dev
->gadget
) {
1583 data
= kzalloc(sizeof(*data
), GFP_KERNEL
);
1586 data
->state
= STATE_EP_DISABLED
;
1587 mutex_init(&data
->lock
);
1588 init_waitqueue_head (&data
->wait
);
1590 strncpy (data
->name
, ep
->name
, sizeof (data
->name
) - 1);
1591 refcount_set (&data
->count
, 1);
1596 ep
->driver_data
= data
;
1598 data
->req
= usb_ep_alloc_request (ep
, GFP_KERNEL
);
1602 data
->dentry
= gadgetfs_create_file (dev
->sb
, data
->name
,
1603 data
, &ep_io_operations
);
1606 list_add_tail (&data
->epfiles
, &dev
->epfiles
);
1611 usb_ep_free_request (ep
, data
->req
);
1616 DBG (dev
, "%s enomem\n", __func__
);
1617 destroy_ep_files (dev
);
1622 gadgetfs_unbind (struct usb_gadget
*gadget
)
1624 struct dev_data
*dev
= get_gadget_data (gadget
);
1626 DBG (dev
, "%s\n", __func__
);
1628 spin_lock_irq (&dev
->lock
);
1629 dev
->state
= STATE_DEV_UNBOUND
;
1630 while (dev
->udc_usage
> 0) {
1631 spin_unlock_irq(&dev
->lock
);
1632 usleep_range(1000, 2000);
1633 spin_lock_irq(&dev
->lock
);
1635 spin_unlock_irq (&dev
->lock
);
1637 destroy_ep_files (dev
);
1638 gadget
->ep0
->driver_data
= NULL
;
1639 set_gadget_data (gadget
, NULL
);
1641 /* we've already been disconnected ... no i/o is active */
1643 usb_ep_free_request (gadget
->ep0
, dev
->req
);
1644 DBG (dev
, "%s done\n", __func__
);
1648 static struct dev_data
*the_device
;
1650 static int gadgetfs_bind(struct usb_gadget
*gadget
,
1651 struct usb_gadget_driver
*driver
)
1653 struct dev_data
*dev
= the_device
;
1657 if (0 != strcmp (CHIP
, gadget
->name
)) {
1658 pr_err("%s expected %s controller not %s\n",
1659 shortname
, CHIP
, gadget
->name
);
1663 set_gadget_data (gadget
, dev
);
1664 dev
->gadget
= gadget
;
1665 gadget
->ep0
->driver_data
= dev
;
1667 /* preallocate control response and buffer */
1668 dev
->req
= usb_ep_alloc_request (gadget
->ep0
, GFP_KERNEL
);
1671 dev
->req
->context
= NULL
;
1672 dev
->req
->complete
= epio_complete
;
1674 if (activate_ep_files (dev
) < 0)
1677 INFO (dev
, "bound to %s driver\n", gadget
->name
);
1678 spin_lock_irq(&dev
->lock
);
1679 dev
->state
= STATE_DEV_UNCONNECTED
;
1680 spin_unlock_irq(&dev
->lock
);
1685 gadgetfs_unbind (gadget
);
1690 gadgetfs_disconnect (struct usb_gadget
*gadget
)
1692 struct dev_data
*dev
= get_gadget_data (gadget
);
1693 unsigned long flags
;
1695 spin_lock_irqsave (&dev
->lock
, flags
);
1696 if (dev
->state
== STATE_DEV_UNCONNECTED
)
1698 dev
->state
= STATE_DEV_UNCONNECTED
;
1700 INFO (dev
, "disconnected\n");
1701 next_event (dev
, GADGETFS_DISCONNECT
);
1704 spin_unlock_irqrestore (&dev
->lock
, flags
);
1708 gadgetfs_suspend (struct usb_gadget
*gadget
)
1710 struct dev_data
*dev
= get_gadget_data (gadget
);
1711 unsigned long flags
;
1713 INFO (dev
, "suspended from state %d\n", dev
->state
);
1714 spin_lock_irqsave(&dev
->lock
, flags
);
1715 switch (dev
->state
) {
1716 case STATE_DEV_SETUP
: // VERY odd... host died??
1717 case STATE_DEV_CONNECTED
:
1718 case STATE_DEV_UNCONNECTED
:
1719 next_event (dev
, GADGETFS_SUSPEND
);
1725 spin_unlock_irqrestore(&dev
->lock
, flags
);
1728 static struct usb_gadget_driver gadgetfs_driver
= {
1729 .function
= (char *) driver_desc
,
1730 .bind
= gadgetfs_bind
,
1731 .unbind
= gadgetfs_unbind
,
1732 .setup
= gadgetfs_setup
,
1733 .reset
= gadgetfs_disconnect
,
1734 .disconnect
= gadgetfs_disconnect
,
1735 .suspend
= gadgetfs_suspend
,
1738 .name
= (char *) shortname
,
1742 /*----------------------------------------------------------------------*/
1743 /* DEVICE INITIALIZATION
1745 * fd = open ("/dev/gadget/$CHIP", O_RDWR)
1746 * status = write (fd, descriptors, sizeof descriptors)
1748 * That write establishes the device configuration, so the kernel can
1749 * bind to the controller ... guaranteeing it can handle enumeration
1750 * at all necessary speeds. Descriptor order is:
1752 * . message tag (u32, host order) ... for now, must be zero; it
1753 * would change to support features like multi-config devices
1754 * . full/low speed config ... all wTotalLength bytes (with interface,
1755 * class, altsetting, endpoint, and other descriptors)
1756 * . high speed config ... all descriptors, for high speed operation;
1757 * this one's optional except for high-speed hardware
1758 * . device descriptor
1760 * Endpoints are not yet enabled. Drivers must wait until device
1761 * configuration and interface altsetting changes create
1762 * the need to configure (or unconfigure) them.
1764 * After initialization, the device stays active for as long as that
1765 * $CHIP file is open. Events must then be read from that descriptor,
1766 * such as configuration notifications.
1769 static int is_valid_config(struct usb_config_descriptor
*config
,
1772 return config
->bDescriptorType
== USB_DT_CONFIG
1773 && config
->bLength
== USB_DT_CONFIG_SIZE
1774 && total
>= USB_DT_CONFIG_SIZE
1775 && config
->bConfigurationValue
!= 0
1776 && (config
->bmAttributes
& USB_CONFIG_ATT_ONE
) != 0
1777 && (config
->bmAttributes
& USB_CONFIG_ATT_WAKEUP
) == 0;
1778 /* FIXME if gadget->is_otg, _must_ include an otg descriptor */
1779 /* FIXME check lengths: walk to end */
1783 dev_config (struct file
*fd
, const char __user
*buf
, size_t len
, loff_t
*ptr
)
1785 struct dev_data
*dev
= fd
->private_data
;
1786 ssize_t value
= len
, length
= len
;
1791 spin_lock_irq(&dev
->lock
);
1792 if (dev
->state
> STATE_DEV_OPENED
) {
1793 value
= ep0_write(fd
, buf
, len
, ptr
);
1794 spin_unlock_irq(&dev
->lock
);
1797 spin_unlock_irq(&dev
->lock
);
1799 if ((len
< (USB_DT_CONFIG_SIZE
+ USB_DT_DEVICE_SIZE
+ 4)) ||
1800 (len
> PAGE_SIZE
* 4))
1803 /* we might need to change message format someday */
1804 if (copy_from_user (&tag
, buf
, 4))
1811 kbuf
= memdup_user(buf
, length
);
1813 return PTR_ERR(kbuf
);
1815 spin_lock_irq (&dev
->lock
);
1823 /* full or low speed config */
1824 dev
->config
= (void *) kbuf
;
1825 total
= le16_to_cpu(dev
->config
->wTotalLength
);
1826 if (!is_valid_config(dev
->config
, total
) ||
1827 total
> length
- USB_DT_DEVICE_SIZE
)
1832 /* optional high speed config */
1833 if (kbuf
[1] == USB_DT_CONFIG
) {
1834 dev
->hs_config
= (void *) kbuf
;
1835 total
= le16_to_cpu(dev
->hs_config
->wTotalLength
);
1836 if (!is_valid_config(dev
->hs_config
, total
) ||
1837 total
> length
- USB_DT_DEVICE_SIZE
)
1842 dev
->hs_config
= NULL
;
1845 /* could support multiple configs, using another encoding! */
1847 /* device descriptor (tweaked for paranoia) */
1848 if (length
!= USB_DT_DEVICE_SIZE
)
1850 dev
->dev
= (void *)kbuf
;
1851 if (dev
->dev
->bLength
!= USB_DT_DEVICE_SIZE
1852 || dev
->dev
->bDescriptorType
!= USB_DT_DEVICE
1853 || dev
->dev
->bNumConfigurations
!= 1)
1855 dev
->dev
->bcdUSB
= cpu_to_le16 (0x0200);
1857 /* triggers gadgetfs_bind(); then we can enumerate. */
1858 spin_unlock_irq (&dev
->lock
);
1860 gadgetfs_driver
.max_speed
= USB_SPEED_HIGH
;
1862 gadgetfs_driver
.max_speed
= USB_SPEED_FULL
;
1864 value
= usb_gadget_probe_driver(&gadgetfs_driver
);
1869 /* at this point "good" hardware has for the first time
1870 * let the USB the host see us. alternatively, if users
1871 * unplug/replug that will clear all the error state.
1873 * note: everything running before here was guaranteed
1874 * to choke driver model style diagnostics. from here
1875 * on, they can work ... except in cleanup paths that
1876 * kick in after the ep0 descriptor is closed.
1879 dev
->gadget_registered
= true;
1884 spin_unlock_irq (&dev
->lock
);
1885 pr_debug ("%s: %s fail %zd, %p\n", shortname
, __func__
, value
, dev
);
1892 dev_open (struct inode
*inode
, struct file
*fd
)
1894 struct dev_data
*dev
= inode
->i_private
;
1897 spin_lock_irq(&dev
->lock
);
1898 if (dev
->state
== STATE_DEV_DISABLED
) {
1900 dev
->state
= STATE_DEV_OPENED
;
1901 fd
->private_data
= dev
;
1905 spin_unlock_irq(&dev
->lock
);
1909 static const struct file_operations ep0_operations
= {
1910 .llseek
= no_llseek
,
1914 .write
= dev_config
,
1915 .fasync
= ep0_fasync
,
1917 .unlocked_ioctl
= dev_ioctl
,
1918 .release
= dev_release
,
1921 /*----------------------------------------------------------------------*/
1923 /* FILESYSTEM AND SUPERBLOCK OPERATIONS
1925 * Mounting the filesystem creates a controller file, used first for
1926 * device configuration then later for event monitoring.
1930 /* FIXME PAM etc could set this security policy without mount options
1931 * if epfiles inherited ownership and permissons from ep0 ...
1934 static unsigned default_uid
;
1935 static unsigned default_gid
;
1936 static unsigned default_perm
= S_IRUSR
| S_IWUSR
;
1938 module_param (default_uid
, uint
, 0644);
1939 module_param (default_gid
, uint
, 0644);
1940 module_param (default_perm
, uint
, 0644);
1943 static struct inode
*
1944 gadgetfs_make_inode (struct super_block
*sb
,
1945 void *data
, const struct file_operations
*fops
,
1948 struct inode
*inode
= new_inode (sb
);
1951 inode
->i_ino
= get_next_ino();
1952 inode
->i_mode
= mode
;
1953 inode
->i_uid
= make_kuid(&init_user_ns
, default_uid
);
1954 inode
->i_gid
= make_kgid(&init_user_ns
, default_gid
);
1955 inode
->i_atime
= inode
->i_mtime
= inode
->i_ctime
1956 = current_time(inode
);
1957 inode
->i_private
= data
;
1958 inode
->i_fop
= fops
;
1963 /* creates in fs root directory, so non-renamable and non-linkable.
1964 * so inode and dentry are paired, until device reconfig.
1966 static struct dentry
*
1967 gadgetfs_create_file (struct super_block
*sb
, char const *name
,
1968 void *data
, const struct file_operations
*fops
)
1970 struct dentry
*dentry
;
1971 struct inode
*inode
;
1973 dentry
= d_alloc_name(sb
->s_root
, name
);
1977 inode
= gadgetfs_make_inode (sb
, data
, fops
,
1978 S_IFREG
| (default_perm
& S_IRWXUGO
));
1983 d_add (dentry
, inode
);
1987 static const struct super_operations gadget_fs_operations
= {
1988 .statfs
= simple_statfs
,
1989 .drop_inode
= generic_delete_inode
,
1993 gadgetfs_fill_super (struct super_block
*sb
, void *opts
, int silent
)
1995 struct inode
*inode
;
1996 struct dev_data
*dev
;
2001 CHIP
= usb_get_gadget_udc_name();
2006 sb
->s_blocksize
= PAGE_SIZE
;
2007 sb
->s_blocksize_bits
= PAGE_SHIFT
;
2008 sb
->s_magic
= GADGETFS_MAGIC
;
2009 sb
->s_op
= &gadget_fs_operations
;
2010 sb
->s_time_gran
= 1;
2013 inode
= gadgetfs_make_inode (sb
,
2014 NULL
, &simple_dir_operations
,
2015 S_IFDIR
| S_IRUGO
| S_IXUGO
);
2018 inode
->i_op
= &simple_dir_inode_operations
;
2019 if (!(sb
->s_root
= d_make_root (inode
)))
2022 /* the ep0 file is named after the controller we expect;
2023 * user mode code can use it for sanity checks, like we do.
2030 dev
->dentry
= gadgetfs_create_file(sb
, CHIP
, dev
, &ep0_operations
);
2036 /* other endpoint files are available after hardware setup,
2037 * from binding to a controller.
2046 /* "mount -t gadgetfs path /dev/gadget" ends up here */
2047 static struct dentry
*
2048 gadgetfs_mount (struct file_system_type
*t
, int flags
,
2049 const char *path
, void *opts
)
2051 return mount_single (t
, flags
, opts
, gadgetfs_fill_super
);
2055 gadgetfs_kill_sb (struct super_block
*sb
)
2057 kill_litter_super (sb
);
2059 put_dev (the_device
);
2066 /*----------------------------------------------------------------------*/
2068 static struct file_system_type gadgetfs_type
= {
2069 .owner
= THIS_MODULE
,
2071 .mount
= gadgetfs_mount
,
2072 .kill_sb
= gadgetfs_kill_sb
,
2074 MODULE_ALIAS_FS("gadgetfs");
2076 /*----------------------------------------------------------------------*/
2078 static int __init
init (void)
2082 status
= register_filesystem (&gadgetfs_type
);
2084 pr_info ("%s: %s, version " DRIVER_VERSION
"\n",
2085 shortname
, driver_desc
);
2090 static void __exit
cleanup (void)
2092 pr_debug ("unregister %s\n", shortname
);
2093 unregister_filesystem (&gadgetfs_type
);
2095 module_exit (cleanup
);