2 * f_fs.c -- user mode file system API for USB composite function controllers
4 * Copyright (C) 2010 Samsung Electronics
5 * Author: Michal Nazarewicz <mina86@mina86.com>
7 * Based on inode.c (GadgetFS) which was:
8 * Copyright (C) 2003-2004 David Brownell
9 * Copyright (C) 2003 Agilent Technologies
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
19 /* #define VERBOSE_DEBUG */
21 #include <linux/blkdev.h>
22 #include <linux/pagemap.h>
23 #include <linux/export.h>
24 #include <asm/unaligned.h>
26 #include <linux/usb/composite.h>
27 #include <linux/usb/functionfs.h>
30 #define FUNCTIONFS_MAGIC 0xa647361 /* Chosen by a honest dice roll ;) */
33 /* Debugging ****************************************************************/
36 # define pr_vdebug pr_debug
37 # define ffs_dump_mem(prefix, ptr, len) \
38 print_hex_dump_bytes(pr_fmt(prefix ": "), DUMP_PREFIX_NONE, ptr, len)
40 # define pr_vdebug(...) do { } while (0)
41 # define ffs_dump_mem(prefix, ptr, len) do { } while (0)
42 #endif /* VERBOSE_DEBUG */
44 #define ENTER() pr_vdebug("%s()\n", __func__)
47 /* The data structure and setup file ****************************************/
51 * Waiting for descriptors and strings.
53 * In this state no open(2), read(2) or write(2) on epfiles
54 * may succeed (which should not be the problem as there
55 * should be no such files opened in the first place).
61 * We've got descriptors and strings. We are or have called
62 * functionfs_ready_callback(). functionfs_bind() may have
63 * been called but we don't know.
65 * This is the only state in which operations on epfiles may
71 * All endpoints have been closed. This state is also set if
72 * we encounter an unrecoverable error. The only
73 * unrecoverable error is situation when after reading strings
74 * from user space we fail to initialise epfiles or
75 * functionfs_ready_callback() returns with error (<0).
77 * In this state no open(2), read(2) or write(2) (both on ep0
78 * as well as epfile) may succeed (at this point epfiles are
79 * unlinked and all closed so this is not a problem; ep0 is
80 * also closed but ep0 file exists and so open(2) on ep0 must
87 enum ffs_setup_state
{
88 /* There is no setup request pending. */
91 * User has read events and there was a setup request event
92 * there. The next read/write on ep0 will handle the
97 * There was event pending but before user space handled it
98 * some other event was introduced which canceled existing
99 * setup. If this state is set read/write on ep0 return
100 * -EIDRM. This state is only set when adding event.
111 struct usb_gadget
*gadget
;
114 * Protect access read/write operations, only one read/write
115 * at a time. As a consequence protects ep0req and company.
116 * While setup request is being processed (queued) this is
122 * Protect access to endpoint related structures (basically
123 * usb_ep_queue(), usb_ep_dequeue(), etc. calls) except for
129 * XXX REVISIT do we need our own request? Since we are not
130 * handling setup requests immediately user space may be so
131 * slow that another setup will be sent to the gadget but this
132 * time not to us but another function and then there could be
133 * a race. Is that the case? Or maybe we can use cdev->req
134 * after all, maybe we just need some spinlock for that?
136 struct usb_request
*ep0req
; /* P: mutex */
137 struct completion ep0req_completion
; /* P: mutex */
138 int ep0req_status
; /* P: mutex */
140 /* reference counter */
142 /* how many files are opened (EP0 and others) */
146 enum ffs_state state
;
149 * Possible transitions:
150 * + FFS_NO_SETUP -> FFS_SETUP_PENDING -- P: ev.waitq.lock
151 * happens only in ep0 read which is P: mutex
152 * + FFS_SETUP_PENDING -> FFS_NO_SETUP -- P: ev.waitq.lock
153 * happens only in ep0 i/o which is P: mutex
154 * + FFS_SETUP_PENDING -> FFS_SETUP_CANCELED -- P: ev.waitq.lock
155 * + FFS_SETUP_CANCELED -> FFS_NO_SETUP -- cmpxchg
157 enum ffs_setup_state setup_state
;
159 #define FFS_SETUP_STATE(ffs) \
160 ((enum ffs_setup_state)cmpxchg(&(ffs)->setup_state, \
161 FFS_SETUP_CANCELED, FFS_NO_SETUP))
166 unsigned short count
;
167 /* XXX REVISIT need to update it in some places, or do we? */
168 unsigned short can_stall
;
169 struct usb_ctrlrequest setup
;
171 wait_queue_head_t waitq
;
172 } ev
; /* the whole structure, P: ev.waitq.lock */
176 #define FFS_FL_CALL_CLOSED_CALLBACK 0
177 #define FFS_FL_BOUND 1
179 /* Active function */
180 struct ffs_function
*func
;
183 * Device name, write once when file system is mounted.
184 * Intended for user to read if she wants.
186 const char *dev_name
;
187 /* Private data for our user (ie. gadget). Managed by user. */
190 /* filled by __ffs_data_got_descs() */
192 * Real descriptors are 16 bytes after raw_descs (so you need
193 * to skip 16 bytes (ie. ffs->raw_descs + 16) to get to the
194 * first full speed descriptor). raw_descs_length and
195 * raw_fs_descs_length do not have those 16 bytes added.
197 const void *raw_descs
;
198 unsigned raw_descs_length
;
199 unsigned raw_fs_descs_length
;
200 unsigned fs_descs_count
;
201 unsigned hs_descs_count
;
203 unsigned short strings_count
;
204 unsigned short interfaces_count
;
205 unsigned short eps_count
;
206 unsigned short _pad1
;
208 /* filled by __ffs_data_got_strings() */
209 /* ids in stringtabs are set in functionfs_bind() */
210 const void *raw_strings
;
211 struct usb_gadget_strings
**stringtabs
;
214 * File system's super block, write once when file system is
217 struct super_block
*sb
;
219 /* File permissions, written once when fs is mounted */
220 struct ffs_file_perms
{
227 * The endpoint files, filled by ffs_epfiles_create(),
228 * destroyed by ffs_epfiles_destroy().
230 struct ffs_epfile
*epfiles
;
233 /* Reference counter handling */
234 static void ffs_data_get(struct ffs_data
*ffs
);
235 static void ffs_data_put(struct ffs_data
*ffs
);
236 /* Creates new ffs_data object. */
237 static struct ffs_data
*__must_check
ffs_data_new(void) __attribute__((malloc
));
239 /* Opened counter handling. */
240 static void ffs_data_opened(struct ffs_data
*ffs
);
241 static void ffs_data_closed(struct ffs_data
*ffs
);
243 /* Called with ffs->mutex held; take over ownership of data. */
244 static int __must_check
245 __ffs_data_got_descs(struct ffs_data
*ffs
, char *data
, size_t len
);
246 static int __must_check
247 __ffs_data_got_strings(struct ffs_data
*ffs
, char *data
, size_t len
);
250 /* The function structure ***************************************************/
254 struct ffs_function
{
255 struct usb_configuration
*conf
;
256 struct usb_gadget
*gadget
;
257 struct ffs_data
*ffs
;
261 short *interfaces_nums
;
263 struct usb_function function
;
267 static struct ffs_function
*ffs_func_from_usb(struct usb_function
*f
)
269 return container_of(f
, struct ffs_function
, function
);
272 static void ffs_func_free(struct ffs_function
*func
);
274 static void ffs_func_eps_disable(struct ffs_function
*func
);
275 static int __must_check
ffs_func_eps_enable(struct ffs_function
*func
);
277 static int ffs_func_bind(struct usb_configuration
*,
278 struct usb_function
*);
279 static void ffs_func_unbind(struct usb_configuration
*,
280 struct usb_function
*);
281 static int ffs_func_set_alt(struct usb_function
*, unsigned, unsigned);
282 static void ffs_func_disable(struct usb_function
*);
283 static int ffs_func_setup(struct usb_function
*,
284 const struct usb_ctrlrequest
*);
285 static void ffs_func_suspend(struct usb_function
*);
286 static void ffs_func_resume(struct usb_function
*);
289 static int ffs_func_revmap_ep(struct ffs_function
*func
, u8 num
);
290 static int ffs_func_revmap_intf(struct ffs_function
*func
, u8 intf
);
293 /* The endpoints structures *************************************************/
296 struct usb_ep
*ep
; /* P: ffs->eps_lock */
297 struct usb_request
*req
; /* P: epfile->mutex */
299 /* [0]: full speed, [1]: high speed */
300 struct usb_endpoint_descriptor
*descs
[2];
304 int status
; /* P: epfile->mutex */
308 /* Protects ep->ep and ep->req. */
310 wait_queue_head_t wait
;
312 struct ffs_data
*ffs
;
313 struct ffs_ep
*ep
; /* P: ffs->eps_lock */
315 struct dentry
*dentry
;
319 unsigned char in
; /* P: ffs->eps_lock */
320 unsigned char isoc
; /* P: ffs->eps_lock */
325 static int __must_check
ffs_epfiles_create(struct ffs_data
*ffs
);
326 static void ffs_epfiles_destroy(struct ffs_epfile
*epfiles
, unsigned count
);
328 static struct inode
*__must_check
329 ffs_sb_create_file(struct super_block
*sb
, const char *name
, void *data
,
330 const struct file_operations
*fops
,
331 struct dentry
**dentry_p
);
334 /* Misc helper functions ****************************************************/
336 static int ffs_mutex_lock(struct mutex
*mutex
, unsigned nonblock
)
337 __attribute__((warn_unused_result
, nonnull
));
338 static char *ffs_prepare_buffer(const char * __user buf
, size_t len
)
339 __attribute__((warn_unused_result
, nonnull
));
342 /* Control file aka ep0 *****************************************************/
344 static void ffs_ep0_complete(struct usb_ep
*ep
, struct usb_request
*req
)
346 struct ffs_data
*ffs
= req
->context
;
348 complete_all(&ffs
->ep0req_completion
);
351 static int __ffs_ep0_queue_wait(struct ffs_data
*ffs
, char *data
, size_t len
)
353 struct usb_request
*req
= ffs
->ep0req
;
356 req
->zero
= len
< le16_to_cpu(ffs
->ev
.setup
.wLength
);
358 spin_unlock_irq(&ffs
->ev
.waitq
.lock
);
364 * UDC layer requires to provide a buffer even for ZLP, but should
365 * not use it at all. Let's provide some poisoned pointer to catch
366 * possible bug in the driver.
368 if (req
->buf
== NULL
)
369 req
->buf
= (void *)0xDEADBABE;
371 INIT_COMPLETION(ffs
->ep0req_completion
);
373 ret
= usb_ep_queue(ffs
->gadget
->ep0
, req
, GFP_ATOMIC
);
374 if (unlikely(ret
< 0))
377 ret
= wait_for_completion_interruptible(&ffs
->ep0req_completion
);
379 usb_ep_dequeue(ffs
->gadget
->ep0
, req
);
383 ffs
->setup_state
= FFS_NO_SETUP
;
384 return ffs
->ep0req_status
;
387 static int __ffs_ep0_stall(struct ffs_data
*ffs
)
389 if (ffs
->ev
.can_stall
) {
390 pr_vdebug("ep0 stall\n");
391 usb_ep_set_halt(ffs
->gadget
->ep0
);
392 ffs
->setup_state
= FFS_NO_SETUP
;
395 pr_debug("bogus ep0 stall!\n");
400 static ssize_t
ffs_ep0_write(struct file
*file
, const char __user
*buf
,
401 size_t len
, loff_t
*ptr
)
403 struct ffs_data
*ffs
= file
->private_data
;
409 /* Fast check if setup was canceled */
410 if (FFS_SETUP_STATE(ffs
) == FFS_SETUP_CANCELED
)
414 ret
= ffs_mutex_lock(&ffs
->mutex
, file
->f_flags
& O_NONBLOCK
);
415 if (unlikely(ret
< 0))
419 switch (ffs
->state
) {
420 case FFS_READ_DESCRIPTORS
:
421 case FFS_READ_STRINGS
:
423 if (unlikely(len
< 16)) {
428 data
= ffs_prepare_buffer(buf
, len
);
435 if (ffs
->state
== FFS_READ_DESCRIPTORS
) {
436 pr_info("read descriptors\n");
437 ret
= __ffs_data_got_descs(ffs
, data
, len
);
438 if (unlikely(ret
< 0))
441 ffs
->state
= FFS_READ_STRINGS
;
444 pr_info("read strings\n");
445 ret
= __ffs_data_got_strings(ffs
, data
, len
);
446 if (unlikely(ret
< 0))
449 ret
= ffs_epfiles_create(ffs
);
451 ffs
->state
= FFS_CLOSING
;
455 ffs
->state
= FFS_ACTIVE
;
456 mutex_unlock(&ffs
->mutex
);
458 ret
= functionfs_ready_callback(ffs
);
459 if (unlikely(ret
< 0)) {
460 ffs
->state
= FFS_CLOSING
;
464 set_bit(FFS_FL_CALL_CLOSED_CALLBACK
, &ffs
->flags
);
472 * We're called from user space, we can use _irq
473 * rather then _irqsave
475 spin_lock_irq(&ffs
->ev
.waitq
.lock
);
476 switch (FFS_SETUP_STATE(ffs
)) {
477 case FFS_SETUP_CANCELED
:
485 case FFS_SETUP_PENDING
:
489 /* FFS_SETUP_PENDING */
490 if (!(ffs
->ev
.setup
.bRequestType
& USB_DIR_IN
)) {
491 spin_unlock_irq(&ffs
->ev
.waitq
.lock
);
492 ret
= __ffs_ep0_stall(ffs
);
496 /* FFS_SETUP_PENDING and not stall */
497 len
= min(len
, (size_t)le16_to_cpu(ffs
->ev
.setup
.wLength
));
499 spin_unlock_irq(&ffs
->ev
.waitq
.lock
);
501 data
= ffs_prepare_buffer(buf
, len
);
507 spin_lock_irq(&ffs
->ev
.waitq
.lock
);
510 * We are guaranteed to be still in FFS_ACTIVE state
511 * but the state of setup could have changed from
512 * FFS_SETUP_PENDING to FFS_SETUP_CANCELED so we need
513 * to check for that. If that happened we copied data
514 * from user space in vain but it's unlikely.
516 * For sure we are not in FFS_NO_SETUP since this is
517 * the only place FFS_SETUP_PENDING -> FFS_NO_SETUP
518 * transition can be performed and it's protected by
521 if (FFS_SETUP_STATE(ffs
) == FFS_SETUP_CANCELED
) {
524 spin_unlock_irq(&ffs
->ev
.waitq
.lock
);
526 /* unlocks spinlock */
527 ret
= __ffs_ep0_queue_wait(ffs
, data
, len
);
537 mutex_unlock(&ffs
->mutex
);
541 static ssize_t
__ffs_ep0_read_events(struct ffs_data
*ffs
, char __user
*buf
,
545 * We are holding ffs->ev.waitq.lock and ffs->mutex and we need
548 struct usb_functionfs_event events
[n
];
551 memset(events
, 0, sizeof events
);
554 events
[i
].type
= ffs
->ev
.types
[i
];
555 if (events
[i
].type
== FUNCTIONFS_SETUP
) {
556 events
[i
].u
.setup
= ffs
->ev
.setup
;
557 ffs
->setup_state
= FFS_SETUP_PENDING
;
561 if (n
< ffs
->ev
.count
) {
563 memmove(ffs
->ev
.types
, ffs
->ev
.types
+ n
,
564 ffs
->ev
.count
* sizeof *ffs
->ev
.types
);
569 spin_unlock_irq(&ffs
->ev
.waitq
.lock
);
570 mutex_unlock(&ffs
->mutex
);
572 return unlikely(__copy_to_user(buf
, events
, sizeof events
))
573 ? -EFAULT
: sizeof events
;
576 static ssize_t
ffs_ep0_read(struct file
*file
, char __user
*buf
,
577 size_t len
, loff_t
*ptr
)
579 struct ffs_data
*ffs
= file
->private_data
;
586 /* Fast check if setup was canceled */
587 if (FFS_SETUP_STATE(ffs
) == FFS_SETUP_CANCELED
)
591 ret
= ffs_mutex_lock(&ffs
->mutex
, file
->f_flags
& O_NONBLOCK
);
592 if (unlikely(ret
< 0))
596 if (ffs
->state
!= FFS_ACTIVE
) {
602 * We're called from user space, we can use _irq rather then
605 spin_lock_irq(&ffs
->ev
.waitq
.lock
);
607 switch (FFS_SETUP_STATE(ffs
)) {
608 case FFS_SETUP_CANCELED
:
613 n
= len
/ sizeof(struct usb_functionfs_event
);
619 if ((file
->f_flags
& O_NONBLOCK
) && !ffs
->ev
.count
) {
624 if (wait_event_interruptible_exclusive_locked_irq(ffs
->ev
.waitq
,
630 return __ffs_ep0_read_events(ffs
, buf
,
631 min(n
, (size_t)ffs
->ev
.count
));
633 case FFS_SETUP_PENDING
:
634 if (ffs
->ev
.setup
.bRequestType
& USB_DIR_IN
) {
635 spin_unlock_irq(&ffs
->ev
.waitq
.lock
);
636 ret
= __ffs_ep0_stall(ffs
);
640 len
= min(len
, (size_t)le16_to_cpu(ffs
->ev
.setup
.wLength
));
642 spin_unlock_irq(&ffs
->ev
.waitq
.lock
);
645 data
= kmalloc(len
, GFP_KERNEL
);
646 if (unlikely(!data
)) {
652 spin_lock_irq(&ffs
->ev
.waitq
.lock
);
654 /* See ffs_ep0_write() */
655 if (FFS_SETUP_STATE(ffs
) == FFS_SETUP_CANCELED
) {
660 /* unlocks spinlock */
661 ret
= __ffs_ep0_queue_wait(ffs
, data
, len
);
662 if (likely(ret
> 0) && unlikely(__copy_to_user(buf
, data
, len
)))
671 spin_unlock_irq(&ffs
->ev
.waitq
.lock
);
673 mutex_unlock(&ffs
->mutex
);
678 static int ffs_ep0_open(struct inode
*inode
, struct file
*file
)
680 struct ffs_data
*ffs
= inode
->i_private
;
684 if (unlikely(ffs
->state
== FFS_CLOSING
))
687 file
->private_data
= ffs
;
688 ffs_data_opened(ffs
);
693 static int ffs_ep0_release(struct inode
*inode
, struct file
*file
)
695 struct ffs_data
*ffs
= file
->private_data
;
699 ffs_data_closed(ffs
);
704 static long ffs_ep0_ioctl(struct file
*file
, unsigned code
, unsigned long value
)
706 struct ffs_data
*ffs
= file
->private_data
;
707 struct usb_gadget
*gadget
= ffs
->gadget
;
712 if (code
== FUNCTIONFS_INTERFACE_REVMAP
) {
713 struct ffs_function
*func
= ffs
->func
;
714 ret
= func
? ffs_func_revmap_intf(func
, value
) : -ENODEV
;
715 } else if (gadget
->ops
->ioctl
) {
716 ret
= gadget
->ops
->ioctl(gadget
, code
, value
);
724 static const struct file_operations ffs_ep0_operations
= {
725 .owner
= THIS_MODULE
,
728 .open
= ffs_ep0_open
,
729 .write
= ffs_ep0_write
,
730 .read
= ffs_ep0_read
,
731 .release
= ffs_ep0_release
,
732 .unlocked_ioctl
= ffs_ep0_ioctl
,
736 /* "Normal" endpoints operations ********************************************/
738 static void ffs_epfile_io_complete(struct usb_ep
*_ep
, struct usb_request
*req
)
741 if (likely(req
->context
)) {
742 struct ffs_ep
*ep
= _ep
->driver_data
;
743 ep
->status
= req
->status
? req
->status
: req
->actual
;
744 complete(req
->context
);
748 static ssize_t
ffs_epfile_io(struct file
*file
,
749 char __user
*buf
, size_t len
, int read
)
751 struct ffs_epfile
*epfile
= file
->private_data
;
759 spin_unlock_irq(&epfile
->ffs
->eps_lock
);
760 mutex_unlock(&epfile
->mutex
);
763 /* Are we still active? */
764 if (WARN_ON(epfile
->ffs
->state
!= FFS_ACTIVE
)) {
769 /* Wait for endpoint to be enabled */
772 if (file
->f_flags
& O_NONBLOCK
) {
777 if (wait_event_interruptible(epfile
->wait
,
778 (ep
= epfile
->ep
))) {
785 halt
= !read
== !epfile
->in
;
786 if (halt
&& epfile
->isoc
) {
791 /* Allocate & copy */
792 if (!halt
&& !data
) {
793 data
= kzalloc(len
, GFP_KERNEL
);
798 unlikely(__copy_from_user(data
, buf
, len
))) {
804 /* We will be using request */
805 ret
= ffs_mutex_lock(&epfile
->mutex
,
806 file
->f_flags
& O_NONBLOCK
);
811 * We're called from user space, we can use _irq rather then
814 spin_lock_irq(&epfile
->ffs
->eps_lock
);
817 * While we were acquiring mutex endpoint got disabled
820 } while (unlikely(epfile
->ep
!= ep
));
823 if (unlikely(halt
)) {
824 if (likely(epfile
->ep
== ep
) && !WARN_ON(!ep
->ep
))
825 usb_ep_set_halt(ep
->ep
);
826 spin_unlock_irq(&epfile
->ffs
->eps_lock
);
829 /* Fire the request */
830 DECLARE_COMPLETION_ONSTACK(done
);
832 struct usb_request
*req
= ep
->req
;
833 req
->context
= &done
;
834 req
->complete
= ffs_epfile_io_complete
;
838 ret
= usb_ep_queue(ep
->ep
, req
, GFP_ATOMIC
);
840 spin_unlock_irq(&epfile
->ffs
->eps_lock
);
842 if (unlikely(ret
< 0)) {
844 } else if (unlikely(wait_for_completion_interruptible(&done
))) {
846 usb_ep_dequeue(ep
->ep
, req
);
849 if (read
&& ret
> 0 &&
850 unlikely(copy_to_user(buf
, data
, ret
)))
855 mutex_unlock(&epfile
->mutex
);
862 ffs_epfile_write(struct file
*file
, const char __user
*buf
, size_t len
,
867 return ffs_epfile_io(file
, (char __user
*)buf
, len
, 0);
871 ffs_epfile_read(struct file
*file
, char __user
*buf
, size_t len
, loff_t
*ptr
)
875 return ffs_epfile_io(file
, buf
, len
, 1);
879 ffs_epfile_open(struct inode
*inode
, struct file
*file
)
881 struct ffs_epfile
*epfile
= inode
->i_private
;
885 if (WARN_ON(epfile
->ffs
->state
!= FFS_ACTIVE
))
888 file
->private_data
= epfile
;
889 ffs_data_opened(epfile
->ffs
);
895 ffs_epfile_release(struct inode
*inode
, struct file
*file
)
897 struct ffs_epfile
*epfile
= inode
->i_private
;
901 ffs_data_closed(epfile
->ffs
);
906 static long ffs_epfile_ioctl(struct file
*file
, unsigned code
,
909 struct ffs_epfile
*epfile
= file
->private_data
;
914 if (WARN_ON(epfile
->ffs
->state
!= FFS_ACTIVE
))
917 spin_lock_irq(&epfile
->ffs
->eps_lock
);
918 if (likely(epfile
->ep
)) {
920 case FUNCTIONFS_FIFO_STATUS
:
921 ret
= usb_ep_fifo_status(epfile
->ep
->ep
);
923 case FUNCTIONFS_FIFO_FLUSH
:
924 usb_ep_fifo_flush(epfile
->ep
->ep
);
927 case FUNCTIONFS_CLEAR_HALT
:
928 ret
= usb_ep_clear_halt(epfile
->ep
->ep
);
930 case FUNCTIONFS_ENDPOINT_REVMAP
:
931 ret
= epfile
->ep
->num
;
939 spin_unlock_irq(&epfile
->ffs
->eps_lock
);
944 static const struct file_operations ffs_epfile_operations
= {
945 .owner
= THIS_MODULE
,
948 .open
= ffs_epfile_open
,
949 .write
= ffs_epfile_write
,
950 .read
= ffs_epfile_read
,
951 .release
= ffs_epfile_release
,
952 .unlocked_ioctl
= ffs_epfile_ioctl
,
956 /* File system and super block operations ***********************************/
959 * Mounting the file system creates a controller file, used first for
960 * function configuration then later for event monitoring.
963 static struct inode
*__must_check
964 ffs_sb_make_inode(struct super_block
*sb
, void *data
,
965 const struct file_operations
*fops
,
966 const struct inode_operations
*iops
,
967 struct ffs_file_perms
*perms
)
973 inode
= new_inode(sb
);
976 struct timespec current_time
= CURRENT_TIME
;
978 inode
->i_ino
= get_next_ino();
979 inode
->i_mode
= perms
->mode
;
980 inode
->i_uid
= perms
->uid
;
981 inode
->i_gid
= perms
->gid
;
982 inode
->i_atime
= current_time
;
983 inode
->i_mtime
= current_time
;
984 inode
->i_ctime
= current_time
;
985 inode
->i_private
= data
;
995 /* Create "regular" file */
996 static struct inode
*ffs_sb_create_file(struct super_block
*sb
,
997 const char *name
, void *data
,
998 const struct file_operations
*fops
,
999 struct dentry
**dentry_p
)
1001 struct ffs_data
*ffs
= sb
->s_fs_info
;
1002 struct dentry
*dentry
;
1003 struct inode
*inode
;
1007 dentry
= d_alloc_name(sb
->s_root
, name
);
1008 if (unlikely(!dentry
))
1011 inode
= ffs_sb_make_inode(sb
, data
, fops
, NULL
, &ffs
->file_perms
);
1012 if (unlikely(!inode
)) {
1017 d_add(dentry
, inode
);
1025 static const struct super_operations ffs_sb_operations
= {
1026 .statfs
= simple_statfs
,
1027 .drop_inode
= generic_delete_inode
,
1030 struct ffs_sb_fill_data
{
1031 struct ffs_file_perms perms
;
1033 const char *dev_name
;
1036 static int ffs_sb_fill(struct super_block
*sb
, void *_data
, int silent
)
1038 struct ffs_sb_fill_data
*data
= _data
;
1039 struct inode
*inode
;
1040 struct ffs_data
*ffs
;
1044 /* Initialise data */
1045 ffs
= ffs_data_new();
1050 ffs
->dev_name
= data
->dev_name
;
1051 ffs
->file_perms
= data
->perms
;
1053 sb
->s_fs_info
= ffs
;
1054 sb
->s_blocksize
= PAGE_CACHE_SIZE
;
1055 sb
->s_blocksize_bits
= PAGE_CACHE_SHIFT
;
1056 sb
->s_magic
= FUNCTIONFS_MAGIC
;
1057 sb
->s_op
= &ffs_sb_operations
;
1058 sb
->s_time_gran
= 1;
1061 data
->perms
.mode
= data
->root_mode
;
1062 inode
= ffs_sb_make_inode(sb
, NULL
,
1063 &simple_dir_operations
,
1064 &simple_dir_inode_operations
,
1066 sb
->s_root
= d_make_root(inode
);
1067 if (unlikely(!sb
->s_root
))
1071 if (unlikely(!ffs_sb_create_file(sb
, "ep0", ffs
,
1072 &ffs_ep0_operations
, NULL
)))
1081 static int ffs_fs_parse_opts(struct ffs_sb_fill_data
*data
, char *opts
)
1085 if (!opts
|| !*opts
)
1089 char *end
, *eq
, *comma
;
1090 unsigned long value
;
1093 comma
= strchr(opts
, ',');
1098 eq
= strchr(opts
, '=');
1099 if (unlikely(!eq
)) {
1100 pr_err("'=' missing in %s\n", opts
);
1106 value
= simple_strtoul(eq
+ 1, &end
, 0);
1107 if (unlikely(*end
!= ',' && *end
!= 0)) {
1108 pr_err("%s: invalid value: %s\n", opts
, eq
+ 1);
1112 /* Interpret option */
1113 switch (eq
- opts
) {
1115 if (!memcmp(opts
, "rmode", 5))
1116 data
->root_mode
= (value
& 0555) | S_IFDIR
;
1117 else if (!memcmp(opts
, "fmode", 5))
1118 data
->perms
.mode
= (value
& 0666) | S_IFREG
;
1124 if (!memcmp(opts
, "mode", 4)) {
1125 data
->root_mode
= (value
& 0555) | S_IFDIR
;
1126 data
->perms
.mode
= (value
& 0666) | S_IFREG
;
1133 if (!memcmp(opts
, "uid", 3))
1134 data
->perms
.uid
= value
;
1135 else if (!memcmp(opts
, "gid", 3))
1136 data
->perms
.gid
= value
;
1143 pr_err("%s: invalid option\n", opts
);
1147 /* Next iteration */
1156 /* "mount -t functionfs dev_name /dev/function" ends up here */
1158 static struct dentry
*
1159 ffs_fs_mount(struct file_system_type
*t
, int flags
,
1160 const char *dev_name
, void *opts
)
1162 struct ffs_sb_fill_data data
= {
1164 .mode
= S_IFREG
| 0600,
1168 .root_mode
= S_IFDIR
| 0500,
1174 ret
= functionfs_check_dev_callback(dev_name
);
1175 if (unlikely(ret
< 0))
1176 return ERR_PTR(ret
);
1178 ret
= ffs_fs_parse_opts(&data
, opts
);
1179 if (unlikely(ret
< 0))
1180 return ERR_PTR(ret
);
1182 data
.dev_name
= dev_name
;
1183 return mount_single(t
, flags
, &data
, ffs_sb_fill
);
1187 ffs_fs_kill_sb(struct super_block
*sb
)
1191 kill_litter_super(sb
);
1193 ffs_data_put(sb
->s_fs_info
);
1196 static struct file_system_type ffs_fs_type
= {
1197 .owner
= THIS_MODULE
,
1198 .name
= "functionfs",
1199 .mount
= ffs_fs_mount
,
1200 .kill_sb
= ffs_fs_kill_sb
,
1204 /* Driver's main init/cleanup functions *************************************/
1206 static int functionfs_init(void)
1212 ret
= register_filesystem(&ffs_fs_type
);
1214 pr_info("file system registered\n");
1216 pr_err("failed registering file system (%d)\n", ret
);
1221 static void functionfs_cleanup(void)
1225 pr_info("unloading\n");
1226 unregister_filesystem(&ffs_fs_type
);
1230 /* ffs_data and ffs_function construction and destruction code **************/
1232 static void ffs_data_clear(struct ffs_data
*ffs
);
1233 static void ffs_data_reset(struct ffs_data
*ffs
);
1235 static void ffs_data_get(struct ffs_data
*ffs
)
1239 atomic_inc(&ffs
->ref
);
1242 static void ffs_data_opened(struct ffs_data
*ffs
)
1246 atomic_inc(&ffs
->ref
);
1247 atomic_inc(&ffs
->opened
);
1250 static void ffs_data_put(struct ffs_data
*ffs
)
1254 if (unlikely(atomic_dec_and_test(&ffs
->ref
))) {
1255 pr_info("%s(): freeing\n", __func__
);
1256 ffs_data_clear(ffs
);
1257 BUG_ON(waitqueue_active(&ffs
->ev
.waitq
) ||
1258 waitqueue_active(&ffs
->ep0req_completion
.wait
));
1263 static void ffs_data_closed(struct ffs_data
*ffs
)
1267 if (atomic_dec_and_test(&ffs
->opened
)) {
1268 ffs
->state
= FFS_CLOSING
;
1269 ffs_data_reset(ffs
);
1275 static struct ffs_data
*ffs_data_new(void)
1277 struct ffs_data
*ffs
= kzalloc(sizeof *ffs
, GFP_KERNEL
);
1283 atomic_set(&ffs
->ref
, 1);
1284 atomic_set(&ffs
->opened
, 0);
1285 ffs
->state
= FFS_READ_DESCRIPTORS
;
1286 mutex_init(&ffs
->mutex
);
1287 spin_lock_init(&ffs
->eps_lock
);
1288 init_waitqueue_head(&ffs
->ev
.waitq
);
1289 init_completion(&ffs
->ep0req_completion
);
1291 /* XXX REVISIT need to update it in some places, or do we? */
1292 ffs
->ev
.can_stall
= 1;
1297 static void ffs_data_clear(struct ffs_data
*ffs
)
1301 if (test_and_clear_bit(FFS_FL_CALL_CLOSED_CALLBACK
, &ffs
->flags
))
1302 functionfs_closed_callback(ffs
);
1304 BUG_ON(ffs
->gadget
);
1307 ffs_epfiles_destroy(ffs
->epfiles
, ffs
->eps_count
);
1309 kfree(ffs
->raw_descs
);
1310 kfree(ffs
->raw_strings
);
1311 kfree(ffs
->stringtabs
);
1314 static void ffs_data_reset(struct ffs_data
*ffs
)
1318 ffs_data_clear(ffs
);
1320 ffs
->epfiles
= NULL
;
1321 ffs
->raw_descs
= NULL
;
1322 ffs
->raw_strings
= NULL
;
1323 ffs
->stringtabs
= NULL
;
1325 ffs
->raw_descs_length
= 0;
1326 ffs
->raw_fs_descs_length
= 0;
1327 ffs
->fs_descs_count
= 0;
1328 ffs
->hs_descs_count
= 0;
1330 ffs
->strings_count
= 0;
1331 ffs
->interfaces_count
= 0;
1336 ffs
->state
= FFS_READ_DESCRIPTORS
;
1337 ffs
->setup_state
= FFS_NO_SETUP
;
1342 static int functionfs_bind(struct ffs_data
*ffs
, struct usb_composite_dev
*cdev
)
1344 struct usb_gadget_strings
**lang
;
1349 if (WARN_ON(ffs
->state
!= FFS_ACTIVE
1350 || test_and_set_bit(FFS_FL_BOUND
, &ffs
->flags
)))
1353 first_id
= usb_string_ids_n(cdev
, ffs
->strings_count
);
1354 if (unlikely(first_id
< 0))
1357 ffs
->ep0req
= usb_ep_alloc_request(cdev
->gadget
->ep0
, GFP_KERNEL
);
1358 if (unlikely(!ffs
->ep0req
))
1360 ffs
->ep0req
->complete
= ffs_ep0_complete
;
1361 ffs
->ep0req
->context
= ffs
;
1363 lang
= ffs
->stringtabs
;
1364 for (lang
= ffs
->stringtabs
; *lang
; ++lang
) {
1365 struct usb_string
*str
= (*lang
)->strings
;
1367 for (; str
->s
; ++id
, ++str
)
1371 ffs
->gadget
= cdev
->gadget
;
1376 static void functionfs_unbind(struct ffs_data
*ffs
)
1380 if (!WARN_ON(!ffs
->gadget
)) {
1381 usb_ep_free_request(ffs
->gadget
->ep0
, ffs
->ep0req
);
1388 static int ffs_epfiles_create(struct ffs_data
*ffs
)
1390 struct ffs_epfile
*epfile
, *epfiles
;
1395 count
= ffs
->eps_count
;
1396 epfiles
= kcalloc(count
, sizeof(*epfiles
), GFP_KERNEL
);
1401 for (i
= 1; i
<= count
; ++i
, ++epfile
) {
1403 mutex_init(&epfile
->mutex
);
1404 init_waitqueue_head(&epfile
->wait
);
1405 sprintf(epfiles
->name
, "ep%u", i
);
1406 if (!unlikely(ffs_sb_create_file(ffs
->sb
, epfiles
->name
, epfile
,
1407 &ffs_epfile_operations
,
1408 &epfile
->dentry
))) {
1409 ffs_epfiles_destroy(epfiles
, i
- 1);
1414 ffs
->epfiles
= epfiles
;
1418 static void ffs_epfiles_destroy(struct ffs_epfile
*epfiles
, unsigned count
)
1420 struct ffs_epfile
*epfile
= epfiles
;
1424 for (; count
; --count
, ++epfile
) {
1425 BUG_ON(mutex_is_locked(&epfile
->mutex
) ||
1426 waitqueue_active(&epfile
->wait
));
1427 if (epfile
->dentry
) {
1428 d_delete(epfile
->dentry
);
1429 dput(epfile
->dentry
);
1430 epfile
->dentry
= NULL
;
1437 static int functionfs_bind_config(struct usb_composite_dev
*cdev
,
1438 struct usb_configuration
*c
,
1439 struct ffs_data
*ffs
)
1441 struct ffs_function
*func
;
1446 func
= kzalloc(sizeof *func
, GFP_KERNEL
);
1447 if (unlikely(!func
))
1450 func
->function
.name
= "Function FS Gadget";
1451 func
->function
.strings
= ffs
->stringtabs
;
1453 func
->function
.bind
= ffs_func_bind
;
1454 func
->function
.unbind
= ffs_func_unbind
;
1455 func
->function
.set_alt
= ffs_func_set_alt
;
1456 func
->function
.disable
= ffs_func_disable
;
1457 func
->function
.setup
= ffs_func_setup
;
1458 func
->function
.suspend
= ffs_func_suspend
;
1459 func
->function
.resume
= ffs_func_resume
;
1462 func
->gadget
= cdev
->gadget
;
1466 ret
= usb_add_function(c
, &func
->function
);
1468 ffs_func_free(func
);
1473 static void ffs_func_free(struct ffs_function
*func
)
1477 ffs_data_put(func
->ffs
);
1481 * eps and interfaces_nums are allocated in the same chunk so
1482 * only one free is required. Descriptors are also allocated
1483 * in the same chunk.
1489 static void ffs_func_eps_disable(struct ffs_function
*func
)
1491 struct ffs_ep
*ep
= func
->eps
;
1492 struct ffs_epfile
*epfile
= func
->ffs
->epfiles
;
1493 unsigned count
= func
->ffs
->eps_count
;
1494 unsigned long flags
;
1496 spin_lock_irqsave(&func
->ffs
->eps_lock
, flags
);
1498 /* pending requests get nuked */
1500 usb_ep_disable(ep
->ep
);
1506 spin_unlock_irqrestore(&func
->ffs
->eps_lock
, flags
);
1509 static int ffs_func_eps_enable(struct ffs_function
*func
)
1511 struct ffs_data
*ffs
= func
->ffs
;
1512 struct ffs_ep
*ep
= func
->eps
;
1513 struct ffs_epfile
*epfile
= ffs
->epfiles
;
1514 unsigned count
= ffs
->eps_count
;
1515 unsigned long flags
;
1518 spin_lock_irqsave(&func
->ffs
->eps_lock
, flags
);
1520 struct usb_endpoint_descriptor
*ds
;
1521 ds
= ep
->descs
[ep
->descs
[1] ? 1 : 0];
1523 ep
->ep
->driver_data
= ep
;
1525 ret
= usb_ep_enable(ep
->ep
);
1528 epfile
->in
= usb_endpoint_dir_in(ds
);
1529 epfile
->isoc
= usb_endpoint_xfer_isoc(ds
);
1534 wake_up(&epfile
->wait
);
1539 spin_unlock_irqrestore(&func
->ffs
->eps_lock
, flags
);
1545 /* Parsing and building descriptors and strings *****************************/
1548 * This validates if data pointed by data is a valid USB descriptor as
1549 * well as record how many interfaces, endpoints and strings are
1550 * required by given configuration. Returns address after the
1551 * descriptor or NULL if data is invalid.
1554 enum ffs_entity_type
{
1555 FFS_DESCRIPTOR
, FFS_INTERFACE
, FFS_STRING
, FFS_ENDPOINT
1558 typedef int (*ffs_entity_callback
)(enum ffs_entity_type entity
,
1560 struct usb_descriptor_header
*desc
,
1563 static int __must_check
ffs_do_desc(char *data
, unsigned len
,
1564 ffs_entity_callback entity
, void *priv
)
1566 struct usb_descriptor_header
*_ds
= (void *)data
;
1572 /* At least two bytes are required: length and type */
1574 pr_vdebug("descriptor too short\n");
1578 /* If we have at least as many bytes as the descriptor takes? */
1579 length
= _ds
->bLength
;
1581 pr_vdebug("descriptor longer then available data\n");
1585 #define __entity_check_INTERFACE(val) 1
1586 #define __entity_check_STRING(val) (val)
1587 #define __entity_check_ENDPOINT(val) ((val) & USB_ENDPOINT_NUMBER_MASK)
1588 #define __entity(type, val) do { \
1589 pr_vdebug("entity " #type "(%02x)\n", (val)); \
1590 if (unlikely(!__entity_check_ ##type(val))) { \
1591 pr_vdebug("invalid entity's value\n"); \
1594 ret = entity(FFS_ ##type, &val, _ds, priv); \
1595 if (unlikely(ret < 0)) { \
1596 pr_debug("entity " #type "(%02x); ret = %d\n", \
1602 /* Parse descriptor depending on type. */
1603 switch (_ds
->bDescriptorType
) {
1607 case USB_DT_DEVICE_QUALIFIER
:
1608 /* function can't have any of those */
1609 pr_vdebug("descriptor reserved for gadget: %d\n",
1610 _ds
->bDescriptorType
);
1613 case USB_DT_INTERFACE
: {
1614 struct usb_interface_descriptor
*ds
= (void *)_ds
;
1615 pr_vdebug("interface descriptor\n");
1616 if (length
!= sizeof *ds
)
1619 __entity(INTERFACE
, ds
->bInterfaceNumber
);
1621 __entity(STRING
, ds
->iInterface
);
1625 case USB_DT_ENDPOINT
: {
1626 struct usb_endpoint_descriptor
*ds
= (void *)_ds
;
1627 pr_vdebug("endpoint descriptor\n");
1628 if (length
!= USB_DT_ENDPOINT_SIZE
&&
1629 length
!= USB_DT_ENDPOINT_AUDIO_SIZE
)
1631 __entity(ENDPOINT
, ds
->bEndpointAddress
);
1636 if (length
!= sizeof(struct usb_otg_descriptor
))
1640 case USB_DT_INTERFACE_ASSOCIATION
: {
1641 struct usb_interface_assoc_descriptor
*ds
= (void *)_ds
;
1642 pr_vdebug("interface association descriptor\n");
1643 if (length
!= sizeof *ds
)
1646 __entity(STRING
, ds
->iFunction
);
1650 case USB_DT_OTHER_SPEED_CONFIG
:
1651 case USB_DT_INTERFACE_POWER
:
1653 case USB_DT_SECURITY
:
1654 case USB_DT_CS_RADIO_CONTROL
:
1656 pr_vdebug("unimplemented descriptor: %d\n", _ds
->bDescriptorType
);
1660 /* We should never be here */
1661 pr_vdebug("unknown descriptor: %d\n", _ds
->bDescriptorType
);
1665 pr_vdebug("invalid length: %d (descriptor %d)\n",
1666 _ds
->bLength
, _ds
->bDescriptorType
);
1671 #undef __entity_check_DESCRIPTOR
1672 #undef __entity_check_INTERFACE
1673 #undef __entity_check_STRING
1674 #undef __entity_check_ENDPOINT
1679 static int __must_check
ffs_do_descs(unsigned count
, char *data
, unsigned len
,
1680 ffs_entity_callback entity
, void *priv
)
1682 const unsigned _len
= len
;
1683 unsigned long num
= 0;
1693 /* Record "descriptor" entity */
1694 ret
= entity(FFS_DESCRIPTOR
, (u8
*)num
, (void *)data
, priv
);
1695 if (unlikely(ret
< 0)) {
1696 pr_debug("entity DESCRIPTOR(%02lx); ret = %d\n",
1704 ret
= ffs_do_desc(data
, len
, entity
, priv
);
1705 if (unlikely(ret
< 0)) {
1706 pr_debug("%s returns %d\n", __func__
, ret
);
1716 static int __ffs_data_do_entity(enum ffs_entity_type type
,
1717 u8
*valuep
, struct usb_descriptor_header
*desc
,
1720 struct ffs_data
*ffs
= priv
;
1725 case FFS_DESCRIPTOR
:
1730 * Interfaces are indexed from zero so if we
1731 * encountered interface "n" then there are at least
1734 if (*valuep
>= ffs
->interfaces_count
)
1735 ffs
->interfaces_count
= *valuep
+ 1;
1740 * Strings are indexed from 1 (0 is magic ;) reserved
1741 * for languages list or some such)
1743 if (*valuep
> ffs
->strings_count
)
1744 ffs
->strings_count
= *valuep
;
1748 /* Endpoints are indexed from 1 as well. */
1749 if ((*valuep
& USB_ENDPOINT_NUMBER_MASK
) > ffs
->eps_count
)
1750 ffs
->eps_count
= (*valuep
& USB_ENDPOINT_NUMBER_MASK
);
1757 static int __ffs_data_got_descs(struct ffs_data
*ffs
,
1758 char *const _data
, size_t len
)
1760 unsigned fs_count
, hs_count
;
1761 int fs_len
, ret
= -EINVAL
;
1766 if (unlikely(get_unaligned_le32(data
) != FUNCTIONFS_DESCRIPTORS_MAGIC
||
1767 get_unaligned_le32(data
+ 4) != len
))
1769 fs_count
= get_unaligned_le32(data
+ 8);
1770 hs_count
= get_unaligned_le32(data
+ 12);
1772 if (!fs_count
&& !hs_count
)
1778 if (likely(fs_count
)) {
1779 fs_len
= ffs_do_descs(fs_count
, data
, len
,
1780 __ffs_data_do_entity
, ffs
);
1781 if (unlikely(fs_len
< 0)) {
1792 if (likely(hs_count
)) {
1793 ret
= ffs_do_descs(hs_count
, data
, len
,
1794 __ffs_data_do_entity
, ffs
);
1795 if (unlikely(ret
< 0))
1801 if (unlikely(len
!= ret
))
1804 ffs
->raw_fs_descs_length
= fs_len
;
1805 ffs
->raw_descs_length
= fs_len
+ ret
;
1806 ffs
->raw_descs
= _data
;
1807 ffs
->fs_descs_count
= fs_count
;
1808 ffs
->hs_descs_count
= hs_count
;
1819 static int __ffs_data_got_strings(struct ffs_data
*ffs
,
1820 char *const _data
, size_t len
)
1822 u32 str_count
, needed_count
, lang_count
;
1823 struct usb_gadget_strings
**stringtabs
, *t
;
1824 struct usb_string
*strings
, *s
;
1825 const char *data
= _data
;
1829 if (unlikely(get_unaligned_le32(data
) != FUNCTIONFS_STRINGS_MAGIC
||
1830 get_unaligned_le32(data
+ 4) != len
))
1832 str_count
= get_unaligned_le32(data
+ 8);
1833 lang_count
= get_unaligned_le32(data
+ 12);
1835 /* if one is zero the other must be zero */
1836 if (unlikely(!str_count
!= !lang_count
))
1839 /* Do we have at least as many strings as descriptors need? */
1840 needed_count
= ffs
->strings_count
;
1841 if (unlikely(str_count
< needed_count
))
1845 * If we don't need any strings just return and free all
1848 if (!needed_count
) {
1853 /* Allocate everything in one chunk so there's less maintenance. */
1856 struct usb_gadget_strings
*stringtabs
[lang_count
+ 1];
1857 struct usb_gadget_strings stringtab
[lang_count
];
1858 struct usb_string strings
[lang_count
*(needed_count
+1)];
1862 d
= kmalloc(sizeof *d
, GFP_KERNEL
);
1868 stringtabs
= d
->stringtabs
;
1872 *stringtabs
++ = t
++;
1876 stringtabs
= d
->stringtabs
;
1882 /* For each language */
1886 do { /* lang_count > 0 so we can use do-while */
1887 unsigned needed
= needed_count
;
1889 if (unlikely(len
< 3))
1891 t
->language
= get_unaligned_le16(data
);
1898 /* For each string */
1899 do { /* str_count > 0 so we can use do-while */
1900 size_t length
= strnlen(data
, len
);
1902 if (unlikely(length
== len
))
1906 * User may provide more strings then we need,
1907 * if that's the case we simply ignore the
1910 if (likely(needed
)) {
1912 * s->id will be set while adding
1913 * function to configuration so for
1914 * now just leave garbage here.
1923 } while (--str_count
);
1925 s
->id
= 0; /* terminator */
1929 } while (--lang_count
);
1931 /* Some garbage left? */
1936 ffs
->stringtabs
= stringtabs
;
1937 ffs
->raw_strings
= _data
;
1949 /* Events handling and management *******************************************/
1951 static void __ffs_event_add(struct ffs_data
*ffs
,
1952 enum usb_functionfs_event_type type
)
1954 enum usb_functionfs_event_type rem_type1
, rem_type2
= type
;
1958 * Abort any unhandled setup
1960 * We do not need to worry about some cmpxchg() changing value
1961 * of ffs->setup_state without holding the lock because when
1962 * state is FFS_SETUP_PENDING cmpxchg() in several places in
1963 * the source does nothing.
1965 if (ffs
->setup_state
== FFS_SETUP_PENDING
)
1966 ffs
->setup_state
= FFS_SETUP_CANCELED
;
1969 case FUNCTIONFS_RESUME
:
1970 rem_type2
= FUNCTIONFS_SUSPEND
;
1972 case FUNCTIONFS_SUSPEND
:
1973 case FUNCTIONFS_SETUP
:
1975 /* Discard all similar events */
1978 case FUNCTIONFS_BIND
:
1979 case FUNCTIONFS_UNBIND
:
1980 case FUNCTIONFS_DISABLE
:
1981 case FUNCTIONFS_ENABLE
:
1982 /* Discard everything other then power management. */
1983 rem_type1
= FUNCTIONFS_SUSPEND
;
1984 rem_type2
= FUNCTIONFS_RESUME
;
1993 u8
*ev
= ffs
->ev
.types
, *out
= ev
;
1994 unsigned n
= ffs
->ev
.count
;
1995 for (; n
; --n
, ++ev
)
1996 if ((*ev
== rem_type1
|| *ev
== rem_type2
) == neg
)
1999 pr_vdebug("purging event %d\n", *ev
);
2000 ffs
->ev
.count
= out
- ffs
->ev
.types
;
2003 pr_vdebug("adding event %d\n", type
);
2004 ffs
->ev
.types
[ffs
->ev
.count
++] = type
;
2005 wake_up_locked(&ffs
->ev
.waitq
);
2008 static void ffs_event_add(struct ffs_data
*ffs
,
2009 enum usb_functionfs_event_type type
)
2011 unsigned long flags
;
2012 spin_lock_irqsave(&ffs
->ev
.waitq
.lock
, flags
);
2013 __ffs_event_add(ffs
, type
);
2014 spin_unlock_irqrestore(&ffs
->ev
.waitq
.lock
, flags
);
2018 /* Bind/unbind USB function hooks *******************************************/
2020 static int __ffs_func_bind_do_descs(enum ffs_entity_type type
, u8
*valuep
,
2021 struct usb_descriptor_header
*desc
,
2024 struct usb_endpoint_descriptor
*ds
= (void *)desc
;
2025 struct ffs_function
*func
= priv
;
2026 struct ffs_ep
*ffs_ep
;
2029 * If hs_descriptors is not NULL then we are reading hs
2032 const int isHS
= func
->function
.hs_descriptors
!= NULL
;
2035 if (type
!= FFS_DESCRIPTOR
)
2039 func
->function
.hs_descriptors
[(long)valuep
] = desc
;
2041 func
->function
.descriptors
[(long)valuep
] = desc
;
2043 if (!desc
|| desc
->bDescriptorType
!= USB_DT_ENDPOINT
)
2046 idx
= (ds
->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
) - 1;
2047 ffs_ep
= func
->eps
+ idx
;
2049 if (unlikely(ffs_ep
->descs
[isHS
])) {
2050 pr_vdebug("two %sspeed descriptors for EP %d\n",
2051 isHS
? "high" : "full",
2052 ds
->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
);
2055 ffs_ep
->descs
[isHS
] = ds
;
2057 ffs_dump_mem(": Original ep desc", ds
, ds
->bLength
);
2059 ds
->bEndpointAddress
= ffs_ep
->descs
[0]->bEndpointAddress
;
2060 if (!ds
->wMaxPacketSize
)
2061 ds
->wMaxPacketSize
= ffs_ep
->descs
[0]->wMaxPacketSize
;
2063 struct usb_request
*req
;
2066 pr_vdebug("autoconfig\n");
2067 ep
= usb_ep_autoconfig(func
->gadget
, ds
);
2070 ep
->driver_data
= func
->eps
+ idx
;
2072 req
= usb_ep_alloc_request(ep
, GFP_KERNEL
);
2078 func
->eps_revmap
[ds
->bEndpointAddress
&
2079 USB_ENDPOINT_NUMBER_MASK
] = idx
+ 1;
2081 ffs_dump_mem(": Rewritten ep desc", ds
, ds
->bLength
);
2086 static int __ffs_func_bind_do_nums(enum ffs_entity_type type
, u8
*valuep
,
2087 struct usb_descriptor_header
*desc
,
2090 struct ffs_function
*func
= priv
;
2096 case FFS_DESCRIPTOR
:
2097 /* Handled in previous pass by __ffs_func_bind_do_descs() */
2102 if (func
->interfaces_nums
[idx
] < 0) {
2103 int id
= usb_interface_id(func
->conf
, &func
->function
);
2104 if (unlikely(id
< 0))
2106 func
->interfaces_nums
[idx
] = id
;
2108 newValue
= func
->interfaces_nums
[idx
];
2112 /* String' IDs are allocated when fsf_data is bound to cdev */
2113 newValue
= func
->ffs
->stringtabs
[0]->strings
[*valuep
- 1].id
;
2118 * USB_DT_ENDPOINT are handled in
2119 * __ffs_func_bind_do_descs().
2121 if (desc
->bDescriptorType
== USB_DT_ENDPOINT
)
2124 idx
= (*valuep
& USB_ENDPOINT_NUMBER_MASK
) - 1;
2125 if (unlikely(!func
->eps
[idx
].ep
))
2129 struct usb_endpoint_descriptor
**descs
;
2130 descs
= func
->eps
[idx
].descs
;
2131 newValue
= descs
[descs
[0] ? 0 : 1]->bEndpointAddress
;
2136 pr_vdebug("%02x -> %02x\n", *valuep
, newValue
);
2141 static int ffs_func_bind(struct usb_configuration
*c
,
2142 struct usb_function
*f
)
2144 struct ffs_function
*func
= ffs_func_from_usb(f
);
2145 struct ffs_data
*ffs
= func
->ffs
;
2147 const int full
= !!func
->ffs
->fs_descs_count
;
2148 const int high
= gadget_is_dualspeed(func
->gadget
) &&
2149 func
->ffs
->hs_descs_count
;
2153 /* Make it a single chunk, less management later on */
2155 struct ffs_ep eps
[ffs
->eps_count
];
2156 struct usb_descriptor_header
2157 *fs_descs
[full
? ffs
->fs_descs_count
+ 1 : 0];
2158 struct usb_descriptor_header
2159 *hs_descs
[high
? ffs
->hs_descs_count
+ 1 : 0];
2160 short inums
[ffs
->interfaces_count
];
2161 char raw_descs
[high
? ffs
->raw_descs_length
2162 : ffs
->raw_fs_descs_length
];
2167 /* Only high speed but not supported by gadget? */
2168 if (unlikely(!(full
| high
)))
2172 data
= kmalloc(sizeof *data
, GFP_KERNEL
);
2173 if (unlikely(!data
))
2177 memset(data
->eps
, 0, sizeof data
->eps
);
2178 memcpy(data
->raw_descs
, ffs
->raw_descs
+ 16, sizeof data
->raw_descs
);
2179 memset(data
->inums
, 0xff, sizeof data
->inums
);
2180 for (ret
= ffs
->eps_count
; ret
; --ret
)
2181 data
->eps
[ret
].num
= -1;
2184 func
->eps
= data
->eps
;
2185 func
->interfaces_nums
= data
->inums
;
2188 * Go through all the endpoint descriptors and allocate
2189 * endpoints first, so that later we can rewrite the endpoint
2190 * numbers without worrying that it may be described later on.
2193 func
->function
.descriptors
= data
->fs_descs
;
2194 ret
= ffs_do_descs(ffs
->fs_descs_count
,
2196 sizeof data
->raw_descs
,
2197 __ffs_func_bind_do_descs
, func
);
2198 if (unlikely(ret
< 0))
2205 func
->function
.hs_descriptors
= data
->hs_descs
;
2206 ret
= ffs_do_descs(ffs
->hs_descs_count
,
2207 data
->raw_descs
+ ret
,
2208 (sizeof data
->raw_descs
) - ret
,
2209 __ffs_func_bind_do_descs
, func
);
2213 * Now handle interface numbers allocation and interface and
2214 * endpoint numbers rewriting. We can do that in one go
2217 ret
= ffs_do_descs(ffs
->fs_descs_count
+
2218 (high
? ffs
->hs_descs_count
: 0),
2219 data
->raw_descs
, sizeof data
->raw_descs
,
2220 __ffs_func_bind_do_nums
, func
);
2221 if (unlikely(ret
< 0))
2224 /* And we're done */
2225 ffs_event_add(ffs
, FUNCTIONFS_BIND
);
2229 /* XXX Do we need to release all claimed endpoints here? */
2234 /* Other USB function hooks *************************************************/
2236 static void ffs_func_unbind(struct usb_configuration
*c
,
2237 struct usb_function
*f
)
2239 struct ffs_function
*func
= ffs_func_from_usb(f
);
2240 struct ffs_data
*ffs
= func
->ffs
;
2244 if (ffs
->func
== func
) {
2245 ffs_func_eps_disable(func
);
2249 ffs_event_add(ffs
, FUNCTIONFS_UNBIND
);
2251 ffs_func_free(func
);
2254 static int ffs_func_set_alt(struct usb_function
*f
,
2255 unsigned interface
, unsigned alt
)
2257 struct ffs_function
*func
= ffs_func_from_usb(f
);
2258 struct ffs_data
*ffs
= func
->ffs
;
2261 if (alt
!= (unsigned)-1) {
2262 intf
= ffs_func_revmap_intf(func
, interface
);
2263 if (unlikely(intf
< 0))
2268 ffs_func_eps_disable(ffs
->func
);
2270 if (ffs
->state
!= FFS_ACTIVE
)
2273 if (alt
== (unsigned)-1) {
2275 ffs_event_add(ffs
, FUNCTIONFS_DISABLE
);
2280 ret
= ffs_func_eps_enable(func
);
2281 if (likely(ret
>= 0))
2282 ffs_event_add(ffs
, FUNCTIONFS_ENABLE
);
2286 static void ffs_func_disable(struct usb_function
*f
)
2288 ffs_func_set_alt(f
, 0, (unsigned)-1);
2291 static int ffs_func_setup(struct usb_function
*f
,
2292 const struct usb_ctrlrequest
*creq
)
2294 struct ffs_function
*func
= ffs_func_from_usb(f
);
2295 struct ffs_data
*ffs
= func
->ffs
;
2296 unsigned long flags
;
2301 pr_vdebug("creq->bRequestType = %02x\n", creq
->bRequestType
);
2302 pr_vdebug("creq->bRequest = %02x\n", creq
->bRequest
);
2303 pr_vdebug("creq->wValue = %04x\n", le16_to_cpu(creq
->wValue
));
2304 pr_vdebug("creq->wIndex = %04x\n", le16_to_cpu(creq
->wIndex
));
2305 pr_vdebug("creq->wLength = %04x\n", le16_to_cpu(creq
->wLength
));
2308 * Most requests directed to interface go through here
2309 * (notable exceptions are set/get interface) so we need to
2310 * handle them. All other either handled by composite or
2311 * passed to usb_configuration->setup() (if one is set). No
2312 * matter, we will handle requests directed to endpoint here
2313 * as well (as it's straightforward) but what to do with any
2316 if (ffs
->state
!= FFS_ACTIVE
)
2319 switch (creq
->bRequestType
& USB_RECIP_MASK
) {
2320 case USB_RECIP_INTERFACE
:
2321 ret
= ffs_func_revmap_intf(func
, le16_to_cpu(creq
->wIndex
));
2322 if (unlikely(ret
< 0))
2326 case USB_RECIP_ENDPOINT
:
2327 ret
= ffs_func_revmap_ep(func
, le16_to_cpu(creq
->wIndex
));
2328 if (unlikely(ret
< 0))
2336 spin_lock_irqsave(&ffs
->ev
.waitq
.lock
, flags
);
2337 ffs
->ev
.setup
= *creq
;
2338 ffs
->ev
.setup
.wIndex
= cpu_to_le16(ret
);
2339 __ffs_event_add(ffs
, FUNCTIONFS_SETUP
);
2340 spin_unlock_irqrestore(&ffs
->ev
.waitq
.lock
, flags
);
2345 static void ffs_func_suspend(struct usb_function
*f
)
2348 ffs_event_add(ffs_func_from_usb(f
)->ffs
, FUNCTIONFS_SUSPEND
);
2351 static void ffs_func_resume(struct usb_function
*f
)
2354 ffs_event_add(ffs_func_from_usb(f
)->ffs
, FUNCTIONFS_RESUME
);
2358 /* Endpoint and interface numbers reverse mapping ***************************/
2360 static int ffs_func_revmap_ep(struct ffs_function
*func
, u8 num
)
2362 num
= func
->eps_revmap
[num
& USB_ENDPOINT_NUMBER_MASK
];
2363 return num
? num
: -EDOM
;
2366 static int ffs_func_revmap_intf(struct ffs_function
*func
, u8 intf
)
2368 short *nums
= func
->interfaces_nums
;
2369 unsigned count
= func
->ffs
->interfaces_count
;
2371 for (; count
; --count
, ++nums
) {
2372 if (*nums
>= 0 && *nums
== intf
)
2373 return nums
- func
->interfaces_nums
;
2380 /* Misc helper functions ****************************************************/
2382 static int ffs_mutex_lock(struct mutex
*mutex
, unsigned nonblock
)
2385 ? likely(mutex_trylock(mutex
)) ? 0 : -EAGAIN
2386 : mutex_lock_interruptible(mutex
);
2389 static char *ffs_prepare_buffer(const char * __user buf
, size_t len
)
2396 data
= kmalloc(len
, GFP_KERNEL
);
2397 if (unlikely(!data
))
2398 return ERR_PTR(-ENOMEM
);
2400 if (unlikely(__copy_from_user(data
, buf
, len
))) {
2402 return ERR_PTR(-EFAULT
);
2405 pr_vdebug("Buffer from user space:\n");
2406 ffs_dump_mem("", data
, len
);