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 <linux/hid.h>
25 #include <linux/module.h>
26 #include <asm/unaligned.h>
28 #include <linux/usb/composite.h>
29 #include <linux/usb/functionfs.h>
31 #include <linux/aio.h>
32 #include <linux/mmu_context.h>
33 #include <linux/poll.h>
38 #define FUNCTIONFS_MAGIC 0xa647361 /* Chosen by a honest dice roll ;) */
40 /* Variable Length Array Macros **********************************************/
41 #define vla_group(groupname) size_t groupname##__next = 0
42 #define vla_group_size(groupname) groupname##__next
44 #define vla_item(groupname, type, name, n) \
45 size_t groupname##_##name##__offset = ({ \
46 size_t align_mask = __alignof__(type) - 1; \
47 size_t offset = (groupname##__next + align_mask) & ~align_mask;\
48 size_t size = (n) * sizeof(type); \
49 groupname##__next = offset + size; \
53 #define vla_item_with_sz(groupname, type, name, n) \
54 size_t groupname##_##name##__sz = (n) * sizeof(type); \
55 size_t groupname##_##name##__offset = ({ \
56 size_t align_mask = __alignof__(type) - 1; \
57 size_t offset = (groupname##__next + align_mask) & ~align_mask;\
58 size_t size = groupname##_##name##__sz; \
59 groupname##__next = offset + size; \
63 #define vla_ptr(ptr, groupname, name) \
64 ((void *) ((char *)ptr + groupname##_##name##__offset))
66 /* Reference counter handling */
67 static void ffs_data_get(struct ffs_data
*ffs
);
68 static void ffs_data_put(struct ffs_data
*ffs
);
69 /* Creates new ffs_data object. */
70 static struct ffs_data
*__must_check
ffs_data_new(void) __attribute__((malloc
));
72 /* Opened counter handling. */
73 static void ffs_data_opened(struct ffs_data
*ffs
);
74 static void ffs_data_closed(struct ffs_data
*ffs
);
76 /* Called with ffs->mutex held; take over ownership of data. */
77 static int __must_check
78 __ffs_data_got_descs(struct ffs_data
*ffs
, char *data
, size_t len
);
79 static int __must_check
80 __ffs_data_got_strings(struct ffs_data
*ffs
, char *data
, size_t len
);
83 /* The function structure ***************************************************/
88 struct usb_configuration
*conf
;
89 struct usb_gadget
*gadget
;
94 short *interfaces_nums
;
96 struct usb_function function
;
100 static struct ffs_function
*ffs_func_from_usb(struct usb_function
*f
)
102 return container_of(f
, struct ffs_function
, function
);
106 static inline enum ffs_setup_state
107 ffs_setup_state_clear_cancelled(struct ffs_data
*ffs
)
109 return (enum ffs_setup_state
)
110 cmpxchg(&ffs
->setup_state
, FFS_SETUP_CANCELLED
, FFS_NO_SETUP
);
114 static void ffs_func_eps_disable(struct ffs_function
*func
);
115 static int __must_check
ffs_func_eps_enable(struct ffs_function
*func
);
117 static int ffs_func_bind(struct usb_configuration
*,
118 struct usb_function
*);
119 static int ffs_func_set_alt(struct usb_function
*, unsigned, unsigned);
120 static void ffs_func_disable(struct usb_function
*);
121 static int ffs_func_setup(struct usb_function
*,
122 const struct usb_ctrlrequest
*);
123 static void ffs_func_suspend(struct usb_function
*);
124 static void ffs_func_resume(struct usb_function
*);
127 static int ffs_func_revmap_ep(struct ffs_function
*func
, u8 num
);
128 static int ffs_func_revmap_intf(struct ffs_function
*func
, u8 intf
);
131 /* The endpoints structures *************************************************/
134 struct usb_ep
*ep
; /* P: ffs->eps_lock */
135 struct usb_request
*req
; /* P: epfile->mutex */
137 /* [0]: full speed, [1]: high speed, [2]: super speed */
138 struct usb_endpoint_descriptor
*descs
[3];
142 int status
; /* P: epfile->mutex */
146 /* Protects ep->ep and ep->req. */
148 wait_queue_head_t wait
;
150 struct ffs_data
*ffs
;
151 struct ffs_ep
*ep
; /* P: ffs->eps_lock */
153 struct dentry
*dentry
;
157 unsigned char in
; /* P: ffs->eps_lock */
158 unsigned char isoc
; /* P: ffs->eps_lock */
163 /* ffs_io_data structure ***************************************************/
170 const struct iovec
*iovec
;
171 unsigned long nr_segs
;
175 struct mm_struct
*mm
;
176 struct work_struct work
;
179 struct usb_request
*req
;
182 static int __must_check
ffs_epfiles_create(struct ffs_data
*ffs
);
183 static void ffs_epfiles_destroy(struct ffs_epfile
*epfiles
, unsigned count
);
185 static struct inode
*__must_check
186 ffs_sb_create_file(struct super_block
*sb
, const char *name
, void *data
,
187 const struct file_operations
*fops
,
188 struct dentry
**dentry_p
);
190 /* Devices management *******************************************************/
192 DEFINE_MUTEX(ffs_lock
);
193 EXPORT_SYMBOL(ffs_lock
);
195 static struct ffs_dev
*_ffs_find_dev(const char *name
);
196 static struct ffs_dev
*_ffs_alloc_dev(void);
197 static int _ffs_name_dev(struct ffs_dev
*dev
, const char *name
);
198 static void _ffs_free_dev(struct ffs_dev
*dev
);
199 static void *ffs_acquire_dev(const char *dev_name
);
200 static void ffs_release_dev(struct ffs_data
*ffs_data
);
201 static int ffs_ready(struct ffs_data
*ffs
);
202 static void ffs_closed(struct ffs_data
*ffs
);
204 /* Misc helper functions ****************************************************/
206 static int ffs_mutex_lock(struct mutex
*mutex
, unsigned nonblock
)
207 __attribute__((warn_unused_result
, nonnull
));
208 static char *ffs_prepare_buffer(const char __user
*buf
, size_t len
)
209 __attribute__((warn_unused_result
, nonnull
));
212 /* Control file aka ep0 *****************************************************/
214 static void ffs_ep0_complete(struct usb_ep
*ep
, struct usb_request
*req
)
216 struct ffs_data
*ffs
= req
->context
;
218 complete_all(&ffs
->ep0req_completion
);
221 static int __ffs_ep0_queue_wait(struct ffs_data
*ffs
, char *data
, size_t len
)
223 struct usb_request
*req
= ffs
->ep0req
;
226 req
->zero
= len
< le16_to_cpu(ffs
->ev
.setup
.wLength
);
228 spin_unlock_irq(&ffs
->ev
.waitq
.lock
);
234 * UDC layer requires to provide a buffer even for ZLP, but should
235 * not use it at all. Let's provide some poisoned pointer to catch
236 * possible bug in the driver.
238 if (req
->buf
== NULL
)
239 req
->buf
= (void *)0xDEADBABE;
241 reinit_completion(&ffs
->ep0req_completion
);
243 ret
= usb_ep_queue(ffs
->gadget
->ep0
, req
, GFP_ATOMIC
);
244 if (unlikely(ret
< 0))
247 ret
= wait_for_completion_interruptible(&ffs
->ep0req_completion
);
249 usb_ep_dequeue(ffs
->gadget
->ep0
, req
);
253 ffs
->setup_state
= FFS_NO_SETUP
;
254 return req
->status
? req
->status
: req
->actual
;
257 static int __ffs_ep0_stall(struct ffs_data
*ffs
)
259 if (ffs
->ev
.can_stall
) {
260 pr_vdebug("ep0 stall\n");
261 usb_ep_set_halt(ffs
->gadget
->ep0
);
262 ffs
->setup_state
= FFS_NO_SETUP
;
265 pr_debug("bogus ep0 stall!\n");
270 static ssize_t
ffs_ep0_write(struct file
*file
, const char __user
*buf
,
271 size_t len
, loff_t
*ptr
)
273 struct ffs_data
*ffs
= file
->private_data
;
279 /* Fast check if setup was canceled */
280 if (ffs_setup_state_clear_cancelled(ffs
) == FFS_SETUP_CANCELLED
)
284 ret
= ffs_mutex_lock(&ffs
->mutex
, file
->f_flags
& O_NONBLOCK
);
285 if (unlikely(ret
< 0))
289 switch (ffs
->state
) {
290 case FFS_READ_DESCRIPTORS
:
291 case FFS_READ_STRINGS
:
293 if (unlikely(len
< 16)) {
298 data
= ffs_prepare_buffer(buf
, len
);
305 if (ffs
->state
== FFS_READ_DESCRIPTORS
) {
306 pr_info("read descriptors\n");
307 ret
= __ffs_data_got_descs(ffs
, data
, len
);
308 if (unlikely(ret
< 0))
311 ffs
->state
= FFS_READ_STRINGS
;
314 pr_info("read strings\n");
315 ret
= __ffs_data_got_strings(ffs
, data
, len
);
316 if (unlikely(ret
< 0))
319 ret
= ffs_epfiles_create(ffs
);
321 ffs
->state
= FFS_CLOSING
;
325 ffs
->state
= FFS_ACTIVE
;
326 mutex_unlock(&ffs
->mutex
);
328 ret
= ffs_ready(ffs
);
329 if (unlikely(ret
< 0)) {
330 ffs
->state
= FFS_CLOSING
;
334 set_bit(FFS_FL_CALL_CLOSED_CALLBACK
, &ffs
->flags
);
342 * We're called from user space, we can use _irq
343 * rather then _irqsave
345 spin_lock_irq(&ffs
->ev
.waitq
.lock
);
346 switch (ffs_setup_state_clear_cancelled(ffs
)) {
347 case FFS_SETUP_CANCELLED
:
355 case FFS_SETUP_PENDING
:
359 /* FFS_SETUP_PENDING */
360 if (!(ffs
->ev
.setup
.bRequestType
& USB_DIR_IN
)) {
361 spin_unlock_irq(&ffs
->ev
.waitq
.lock
);
362 ret
= __ffs_ep0_stall(ffs
);
366 /* FFS_SETUP_PENDING and not stall */
367 len
= min(len
, (size_t)le16_to_cpu(ffs
->ev
.setup
.wLength
));
369 spin_unlock_irq(&ffs
->ev
.waitq
.lock
);
371 data
= ffs_prepare_buffer(buf
, len
);
377 spin_lock_irq(&ffs
->ev
.waitq
.lock
);
380 * We are guaranteed to be still in FFS_ACTIVE state
381 * but the state of setup could have changed from
382 * FFS_SETUP_PENDING to FFS_SETUP_CANCELLED so we need
383 * to check for that. If that happened we copied data
384 * from user space in vain but it's unlikely.
386 * For sure we are not in FFS_NO_SETUP since this is
387 * the only place FFS_SETUP_PENDING -> FFS_NO_SETUP
388 * transition can be performed and it's protected by
391 if (ffs_setup_state_clear_cancelled(ffs
) ==
392 FFS_SETUP_CANCELLED
) {
395 spin_unlock_irq(&ffs
->ev
.waitq
.lock
);
397 /* unlocks spinlock */
398 ret
= __ffs_ep0_queue_wait(ffs
, data
, len
);
408 mutex_unlock(&ffs
->mutex
);
412 static ssize_t
__ffs_ep0_read_events(struct ffs_data
*ffs
, char __user
*buf
,
416 * We are holding ffs->ev.waitq.lock and ffs->mutex and we need
419 struct usb_functionfs_event events
[n
];
422 memset(events
, 0, sizeof events
);
425 events
[i
].type
= ffs
->ev
.types
[i
];
426 if (events
[i
].type
== FUNCTIONFS_SETUP
) {
427 events
[i
].u
.setup
= ffs
->ev
.setup
;
428 ffs
->setup_state
= FFS_SETUP_PENDING
;
432 if (n
< ffs
->ev
.count
) {
434 memmove(ffs
->ev
.types
, ffs
->ev
.types
+ n
,
435 ffs
->ev
.count
* sizeof *ffs
->ev
.types
);
440 spin_unlock_irq(&ffs
->ev
.waitq
.lock
);
441 mutex_unlock(&ffs
->mutex
);
443 return unlikely(__copy_to_user(buf
, events
, sizeof events
))
444 ? -EFAULT
: sizeof events
;
447 static ssize_t
ffs_ep0_read(struct file
*file
, char __user
*buf
,
448 size_t len
, loff_t
*ptr
)
450 struct ffs_data
*ffs
= file
->private_data
;
457 /* Fast check if setup was canceled */
458 if (ffs_setup_state_clear_cancelled(ffs
) == FFS_SETUP_CANCELLED
)
462 ret
= ffs_mutex_lock(&ffs
->mutex
, file
->f_flags
& O_NONBLOCK
);
463 if (unlikely(ret
< 0))
467 if (ffs
->state
!= FFS_ACTIVE
) {
473 * We're called from user space, we can use _irq rather then
476 spin_lock_irq(&ffs
->ev
.waitq
.lock
);
478 switch (ffs_setup_state_clear_cancelled(ffs
)) {
479 case FFS_SETUP_CANCELLED
:
484 n
= len
/ sizeof(struct usb_functionfs_event
);
490 if ((file
->f_flags
& O_NONBLOCK
) && !ffs
->ev
.count
) {
495 if (wait_event_interruptible_exclusive_locked_irq(ffs
->ev
.waitq
,
501 return __ffs_ep0_read_events(ffs
, buf
,
502 min(n
, (size_t)ffs
->ev
.count
));
504 case FFS_SETUP_PENDING
:
505 if (ffs
->ev
.setup
.bRequestType
& USB_DIR_IN
) {
506 spin_unlock_irq(&ffs
->ev
.waitq
.lock
);
507 ret
= __ffs_ep0_stall(ffs
);
511 len
= min(len
, (size_t)le16_to_cpu(ffs
->ev
.setup
.wLength
));
513 spin_unlock_irq(&ffs
->ev
.waitq
.lock
);
516 data
= kmalloc(len
, GFP_KERNEL
);
517 if (unlikely(!data
)) {
523 spin_lock_irq(&ffs
->ev
.waitq
.lock
);
525 /* See ffs_ep0_write() */
526 if (ffs_setup_state_clear_cancelled(ffs
) ==
527 FFS_SETUP_CANCELLED
) {
532 /* unlocks spinlock */
533 ret
= __ffs_ep0_queue_wait(ffs
, data
, len
);
534 if (likely(ret
> 0) && unlikely(__copy_to_user(buf
, data
, len
)))
543 spin_unlock_irq(&ffs
->ev
.waitq
.lock
);
545 mutex_unlock(&ffs
->mutex
);
550 static int ffs_ep0_open(struct inode
*inode
, struct file
*file
)
552 struct ffs_data
*ffs
= inode
->i_private
;
556 if (unlikely(ffs
->state
== FFS_CLOSING
))
559 file
->private_data
= ffs
;
560 ffs_data_opened(ffs
);
565 static int ffs_ep0_release(struct inode
*inode
, struct file
*file
)
567 struct ffs_data
*ffs
= file
->private_data
;
571 ffs_data_closed(ffs
);
576 static long ffs_ep0_ioctl(struct file
*file
, unsigned code
, unsigned long value
)
578 struct ffs_data
*ffs
= file
->private_data
;
579 struct usb_gadget
*gadget
= ffs
->gadget
;
584 if (code
== FUNCTIONFS_INTERFACE_REVMAP
) {
585 struct ffs_function
*func
= ffs
->func
;
586 ret
= func
? ffs_func_revmap_intf(func
, value
) : -ENODEV
;
587 } else if (gadget
&& gadget
->ops
->ioctl
) {
588 ret
= gadget
->ops
->ioctl(gadget
, code
, value
);
596 static unsigned int ffs_ep0_poll(struct file
*file
, poll_table
*wait
)
598 struct ffs_data
*ffs
= file
->private_data
;
599 unsigned int mask
= POLLWRNORM
;
602 poll_wait(file
, &ffs
->ev
.waitq
, wait
);
604 ret
= ffs_mutex_lock(&ffs
->mutex
, file
->f_flags
& O_NONBLOCK
);
605 if (unlikely(ret
< 0))
608 switch (ffs
->state
) {
609 case FFS_READ_DESCRIPTORS
:
610 case FFS_READ_STRINGS
:
615 switch (ffs
->setup_state
) {
621 case FFS_SETUP_PENDING
:
622 case FFS_SETUP_CANCELLED
:
623 mask
|= (POLLIN
| POLLOUT
);
630 mutex_unlock(&ffs
->mutex
);
635 static const struct file_operations ffs_ep0_operations
= {
638 .open
= ffs_ep0_open
,
639 .write
= ffs_ep0_write
,
640 .read
= ffs_ep0_read
,
641 .release
= ffs_ep0_release
,
642 .unlocked_ioctl
= ffs_ep0_ioctl
,
643 .poll
= ffs_ep0_poll
,
647 /* "Normal" endpoints operations ********************************************/
649 static void ffs_epfile_io_complete(struct usb_ep
*_ep
, struct usb_request
*req
)
652 if (likely(req
->context
)) {
653 struct ffs_ep
*ep
= _ep
->driver_data
;
654 ep
->status
= req
->status
? req
->status
: req
->actual
;
655 complete(req
->context
);
659 static void ffs_user_copy_worker(struct work_struct
*work
)
661 struct ffs_io_data
*io_data
= container_of(work
, struct ffs_io_data
,
663 int ret
= io_data
->req
->status
? io_data
->req
->status
:
664 io_data
->req
->actual
;
666 if (io_data
->read
&& ret
> 0) {
670 for (i
= 0; i
< io_data
->nr_segs
; i
++) {
671 if (unlikely(copy_to_user(io_data
->iovec
[i
].iov_base
,
673 io_data
->iovec
[i
].iov_len
))) {
677 pos
+= io_data
->iovec
[i
].iov_len
;
679 unuse_mm(io_data
->mm
);
682 aio_complete(io_data
->kiocb
, ret
, ret
);
684 usb_ep_free_request(io_data
->ep
, io_data
->req
);
686 io_data
->kiocb
->private = NULL
;
688 kfree(io_data
->iovec
);
693 static void ffs_epfile_async_io_complete(struct usb_ep
*_ep
,
694 struct usb_request
*req
)
696 struct ffs_io_data
*io_data
= req
->context
;
700 INIT_WORK(&io_data
->work
, ffs_user_copy_worker
);
701 schedule_work(&io_data
->work
);
704 static ssize_t
ffs_epfile_io(struct file
*file
, struct ffs_io_data
*io_data
)
706 struct ffs_epfile
*epfile
= file
->private_data
;
709 ssize_t ret
, data_len
;
712 /* Are we still active? */
713 if (WARN_ON(epfile
->ffs
->state
!= FFS_ACTIVE
)) {
718 /* Wait for endpoint to be enabled */
721 if (file
->f_flags
& O_NONBLOCK
) {
726 ret
= wait_event_interruptible(epfile
->wait
, (ep
= epfile
->ep
));
734 halt
= (!io_data
->read
== !epfile
->in
);
735 if (halt
&& epfile
->isoc
) {
740 /* Allocate & copy */
743 * if we _do_ wait above, the epfile->ffs->gadget might be NULL
744 * before the waiting completes, so do not assign to 'gadget' earlier
746 struct usb_gadget
*gadget
= epfile
->ffs
->gadget
;
749 * Controller may require buffer size to be aligned to
750 * maxpacketsize of an out endpoint.
752 data_len
= io_data
->read
?
753 usb_ep_align_maybe(gadget
, ep
->ep
, io_data
->len
) :
756 data
= kmalloc(data_len
, GFP_KERNEL
);
759 if (io_data
->aio
&& !io_data
->read
) {
762 for (i
= 0; i
< io_data
->nr_segs
; i
++) {
763 if (unlikely(copy_from_user(&data
[pos
],
764 io_data
->iovec
[i
].iov_base
,
765 io_data
->iovec
[i
].iov_len
))) {
769 pos
+= io_data
->iovec
[i
].iov_len
;
772 if (!io_data
->read
&&
773 unlikely(__copy_from_user(data
, io_data
->buf
,
781 /* We will be using request */
782 ret
= ffs_mutex_lock(&epfile
->mutex
, file
->f_flags
& O_NONBLOCK
);
786 spin_lock_irq(&epfile
->ffs
->eps_lock
);
788 if (epfile
->ep
!= ep
) {
789 /* In the meantime, endpoint got disabled or changed. */
791 spin_unlock_irq(&epfile
->ffs
->eps_lock
);
794 if (likely(epfile
->ep
== ep
) && !WARN_ON(!ep
->ep
))
795 usb_ep_set_halt(ep
->ep
);
796 spin_unlock_irq(&epfile
->ffs
->eps_lock
);
799 /* Fire the request */
800 struct usb_request
*req
;
803 req
= usb_ep_alloc_request(ep
->ep
, GFP_KERNEL
);
808 req
->length
= io_data
->len
;
811 io_data
->ep
= ep
->ep
;
814 req
->context
= io_data
;
815 req
->complete
= ffs_epfile_async_io_complete
;
817 ret
= usb_ep_queue(ep
->ep
, req
, GFP_ATOMIC
);
819 usb_ep_free_request(ep
->ep
, req
);
824 spin_unlock_irq(&epfile
->ffs
->eps_lock
);
826 DECLARE_COMPLETION_ONSTACK(done
);
830 req
->length
= io_data
->len
;
832 req
->context
= &done
;
833 req
->complete
= ffs_epfile_io_complete
;
835 ret
= usb_ep_queue(ep
->ep
, req
, GFP_ATOMIC
);
837 spin_unlock_irq(&epfile
->ffs
->eps_lock
);
839 if (unlikely(ret
< 0)) {
842 wait_for_completion_interruptible(&done
))) {
844 usb_ep_dequeue(ep
->ep
, req
);
847 * XXX We may end up silently droping data
848 * here. Since data_len (i.e. req->length) may
849 * be bigger than len (after being rounded up
850 * to maxpacketsize), we may end up with more
851 * data then user space has space for.
854 if (io_data
->read
&& ret
> 0) {
855 ret
= min_t(size_t, ret
, io_data
->len
);
857 if (unlikely(copy_to_user(io_data
->buf
,
866 mutex_unlock(&epfile
->mutex
);
870 spin_unlock_irq(&epfile
->ffs
->eps_lock
);
871 mutex_unlock(&epfile
->mutex
);
878 ffs_epfile_write(struct file
*file
, const char __user
*buf
, size_t len
,
881 struct ffs_io_data io_data
;
886 io_data
.read
= false;
887 io_data
.buf
= (char * __user
)buf
;
890 return ffs_epfile_io(file
, &io_data
);
894 ffs_epfile_read(struct file
*file
, char __user
*buf
, size_t len
, loff_t
*ptr
)
896 struct ffs_io_data io_data
;
905 return ffs_epfile_io(file
, &io_data
);
909 ffs_epfile_open(struct inode
*inode
, struct file
*file
)
911 struct ffs_epfile
*epfile
= inode
->i_private
;
915 if (WARN_ON(epfile
->ffs
->state
!= FFS_ACTIVE
))
918 file
->private_data
= epfile
;
919 ffs_data_opened(epfile
->ffs
);
924 static int ffs_aio_cancel(struct kiocb
*kiocb
)
926 struct ffs_io_data
*io_data
= kiocb
->private;
927 struct ffs_epfile
*epfile
= kiocb
->ki_filp
->private_data
;
932 spin_lock_irq(&epfile
->ffs
->eps_lock
);
934 if (likely(io_data
&& io_data
->ep
&& io_data
->req
))
935 value
= usb_ep_dequeue(io_data
->ep
, io_data
->req
);
939 spin_unlock_irq(&epfile
->ffs
->eps_lock
);
944 static ssize_t
ffs_epfile_aio_write(struct kiocb
*kiocb
,
945 const struct iovec
*iovec
,
946 unsigned long nr_segs
, loff_t loff
)
948 struct ffs_io_data
*io_data
;
952 io_data
= kmalloc(sizeof(*io_data
), GFP_KERNEL
);
953 if (unlikely(!io_data
))
957 io_data
->read
= false;
958 io_data
->kiocb
= kiocb
;
959 io_data
->iovec
= iovec
;
960 io_data
->nr_segs
= nr_segs
;
961 io_data
->len
= kiocb
->ki_nbytes
;
962 io_data
->mm
= current
->mm
;
964 kiocb
->private = io_data
;
966 kiocb_set_cancel_fn(kiocb
, ffs_aio_cancel
);
968 return ffs_epfile_io(kiocb
->ki_filp
, io_data
);
971 static ssize_t
ffs_epfile_aio_read(struct kiocb
*kiocb
,
972 const struct iovec
*iovec
,
973 unsigned long nr_segs
, loff_t loff
)
975 struct ffs_io_data
*io_data
;
976 struct iovec
*iovec_copy
;
980 iovec_copy
= kmalloc_array(nr_segs
, sizeof(*iovec_copy
), GFP_KERNEL
);
981 if (unlikely(!iovec_copy
))
984 memcpy(iovec_copy
, iovec
, sizeof(struct iovec
)*nr_segs
);
986 io_data
= kmalloc(sizeof(*io_data
), GFP_KERNEL
);
987 if (unlikely(!io_data
)) {
993 io_data
->read
= true;
994 io_data
->kiocb
= kiocb
;
995 io_data
->iovec
= iovec_copy
;
996 io_data
->nr_segs
= nr_segs
;
997 io_data
->len
= kiocb
->ki_nbytes
;
998 io_data
->mm
= current
->mm
;
1000 kiocb
->private = io_data
;
1002 kiocb_set_cancel_fn(kiocb
, ffs_aio_cancel
);
1004 return ffs_epfile_io(kiocb
->ki_filp
, io_data
);
1008 ffs_epfile_release(struct inode
*inode
, struct file
*file
)
1010 struct ffs_epfile
*epfile
= inode
->i_private
;
1014 ffs_data_closed(epfile
->ffs
);
1019 static long ffs_epfile_ioctl(struct file
*file
, unsigned code
,
1020 unsigned long value
)
1022 struct ffs_epfile
*epfile
= file
->private_data
;
1027 if (WARN_ON(epfile
->ffs
->state
!= FFS_ACTIVE
))
1030 spin_lock_irq(&epfile
->ffs
->eps_lock
);
1031 if (likely(epfile
->ep
)) {
1033 case FUNCTIONFS_FIFO_STATUS
:
1034 ret
= usb_ep_fifo_status(epfile
->ep
->ep
);
1036 case FUNCTIONFS_FIFO_FLUSH
:
1037 usb_ep_fifo_flush(epfile
->ep
->ep
);
1040 case FUNCTIONFS_CLEAR_HALT
:
1041 ret
= usb_ep_clear_halt(epfile
->ep
->ep
);
1043 case FUNCTIONFS_ENDPOINT_REVMAP
:
1044 ret
= epfile
->ep
->num
;
1052 spin_unlock_irq(&epfile
->ffs
->eps_lock
);
1057 static const struct file_operations ffs_epfile_operations
= {
1058 .llseek
= no_llseek
,
1060 .open
= ffs_epfile_open
,
1061 .write
= ffs_epfile_write
,
1062 .read
= ffs_epfile_read
,
1063 .aio_write
= ffs_epfile_aio_write
,
1064 .aio_read
= ffs_epfile_aio_read
,
1065 .release
= ffs_epfile_release
,
1066 .unlocked_ioctl
= ffs_epfile_ioctl
,
1070 /* File system and super block operations ***********************************/
1073 * Mounting the file system creates a controller file, used first for
1074 * function configuration then later for event monitoring.
1077 static struct inode
*__must_check
1078 ffs_sb_make_inode(struct super_block
*sb
, void *data
,
1079 const struct file_operations
*fops
,
1080 const struct inode_operations
*iops
,
1081 struct ffs_file_perms
*perms
)
1083 struct inode
*inode
;
1087 inode
= new_inode(sb
);
1089 if (likely(inode
)) {
1090 struct timespec current_time
= CURRENT_TIME
;
1092 inode
->i_ino
= get_next_ino();
1093 inode
->i_mode
= perms
->mode
;
1094 inode
->i_uid
= perms
->uid
;
1095 inode
->i_gid
= perms
->gid
;
1096 inode
->i_atime
= current_time
;
1097 inode
->i_mtime
= current_time
;
1098 inode
->i_ctime
= current_time
;
1099 inode
->i_private
= data
;
1101 inode
->i_fop
= fops
;
1109 /* Create "regular" file */
1110 static struct inode
*ffs_sb_create_file(struct super_block
*sb
,
1111 const char *name
, void *data
,
1112 const struct file_operations
*fops
,
1113 struct dentry
**dentry_p
)
1115 struct ffs_data
*ffs
= sb
->s_fs_info
;
1116 struct dentry
*dentry
;
1117 struct inode
*inode
;
1121 dentry
= d_alloc_name(sb
->s_root
, name
);
1122 if (unlikely(!dentry
))
1125 inode
= ffs_sb_make_inode(sb
, data
, fops
, NULL
, &ffs
->file_perms
);
1126 if (unlikely(!inode
)) {
1131 d_add(dentry
, inode
);
1139 static const struct super_operations ffs_sb_operations
= {
1140 .statfs
= simple_statfs
,
1141 .drop_inode
= generic_delete_inode
,
1144 struct ffs_sb_fill_data
{
1145 struct ffs_file_perms perms
;
1147 const char *dev_name
;
1148 struct ffs_data
*ffs_data
;
1151 static int ffs_sb_fill(struct super_block
*sb
, void *_data
, int silent
)
1153 struct ffs_sb_fill_data
*data
= _data
;
1154 struct inode
*inode
;
1155 struct ffs_data
*ffs
= data
->ffs_data
;
1160 data
->ffs_data
= NULL
;
1161 sb
->s_fs_info
= ffs
;
1162 sb
->s_blocksize
= PAGE_CACHE_SIZE
;
1163 sb
->s_blocksize_bits
= PAGE_CACHE_SHIFT
;
1164 sb
->s_magic
= FUNCTIONFS_MAGIC
;
1165 sb
->s_op
= &ffs_sb_operations
;
1166 sb
->s_time_gran
= 1;
1169 data
->perms
.mode
= data
->root_mode
;
1170 inode
= ffs_sb_make_inode(sb
, NULL
,
1171 &simple_dir_operations
,
1172 &simple_dir_inode_operations
,
1174 sb
->s_root
= d_make_root(inode
);
1175 if (unlikely(!sb
->s_root
))
1179 if (unlikely(!ffs_sb_create_file(sb
, "ep0", ffs
,
1180 &ffs_ep0_operations
, NULL
)))
1186 static int ffs_fs_parse_opts(struct ffs_sb_fill_data
*data
, char *opts
)
1190 if (!opts
|| !*opts
)
1194 unsigned long value
;
1198 comma
= strchr(opts
, ',');
1203 eq
= strchr(opts
, '=');
1204 if (unlikely(!eq
)) {
1205 pr_err("'=' missing in %s\n", opts
);
1211 if (kstrtoul(eq
+ 1, 0, &value
)) {
1212 pr_err("%s: invalid value: %s\n", opts
, eq
+ 1);
1216 /* Interpret option */
1217 switch (eq
- opts
) {
1219 if (!memcmp(opts
, "rmode", 5))
1220 data
->root_mode
= (value
& 0555) | S_IFDIR
;
1221 else if (!memcmp(opts
, "fmode", 5))
1222 data
->perms
.mode
= (value
& 0666) | S_IFREG
;
1228 if (!memcmp(opts
, "mode", 4)) {
1229 data
->root_mode
= (value
& 0555) | S_IFDIR
;
1230 data
->perms
.mode
= (value
& 0666) | S_IFREG
;
1237 if (!memcmp(opts
, "uid", 3)) {
1238 data
->perms
.uid
= make_kuid(current_user_ns(), value
);
1239 if (!uid_valid(data
->perms
.uid
)) {
1240 pr_err("%s: unmapped value: %lu\n", opts
, value
);
1243 } else if (!memcmp(opts
, "gid", 3)) {
1244 data
->perms
.gid
= make_kgid(current_user_ns(), value
);
1245 if (!gid_valid(data
->perms
.gid
)) {
1246 pr_err("%s: unmapped value: %lu\n", opts
, value
);
1256 pr_err("%s: invalid option\n", opts
);
1260 /* Next iteration */
1269 /* "mount -t functionfs dev_name /dev/function" ends up here */
1271 static struct dentry
*
1272 ffs_fs_mount(struct file_system_type
*t
, int flags
,
1273 const char *dev_name
, void *opts
)
1275 struct ffs_sb_fill_data data
= {
1277 .mode
= S_IFREG
| 0600,
1278 .uid
= GLOBAL_ROOT_UID
,
1279 .gid
= GLOBAL_ROOT_GID
,
1281 .root_mode
= S_IFDIR
| 0500,
1286 struct ffs_data
*ffs
;
1290 ret
= ffs_fs_parse_opts(&data
, opts
);
1291 if (unlikely(ret
< 0))
1292 return ERR_PTR(ret
);
1294 ffs
= ffs_data_new();
1296 return ERR_PTR(-ENOMEM
);
1297 ffs
->file_perms
= data
.perms
;
1299 ffs
->dev_name
= kstrdup(dev_name
, GFP_KERNEL
);
1300 if (unlikely(!ffs
->dev_name
)) {
1302 return ERR_PTR(-ENOMEM
);
1305 ffs_dev
= ffs_acquire_dev(dev_name
);
1306 if (IS_ERR(ffs_dev
)) {
1308 return ERR_CAST(ffs_dev
);
1310 ffs
->private_data
= ffs_dev
;
1311 data
.ffs_data
= ffs
;
1313 rv
= mount_nodev(t
, flags
, &data
, ffs_sb_fill
);
1314 if (IS_ERR(rv
) && data
.ffs_data
) {
1315 ffs_release_dev(data
.ffs_data
);
1316 ffs_data_put(data
.ffs_data
);
1322 ffs_fs_kill_sb(struct super_block
*sb
)
1326 kill_litter_super(sb
);
1327 if (sb
->s_fs_info
) {
1328 ffs_release_dev(sb
->s_fs_info
);
1329 ffs_data_put(sb
->s_fs_info
);
1333 static struct file_system_type ffs_fs_type
= {
1334 .owner
= THIS_MODULE
,
1335 .name
= "functionfs",
1336 .mount
= ffs_fs_mount
,
1337 .kill_sb
= ffs_fs_kill_sb
,
1339 MODULE_ALIAS_FS("functionfs");
1342 /* Driver's main init/cleanup functions *************************************/
1344 static int functionfs_init(void)
1350 ret
= register_filesystem(&ffs_fs_type
);
1352 pr_info("file system registered\n");
1354 pr_err("failed registering file system (%d)\n", ret
);
1359 static void functionfs_cleanup(void)
1363 pr_info("unloading\n");
1364 unregister_filesystem(&ffs_fs_type
);
1368 /* ffs_data and ffs_function construction and destruction code **************/
1370 static void ffs_data_clear(struct ffs_data
*ffs
);
1371 static void ffs_data_reset(struct ffs_data
*ffs
);
1373 static void ffs_data_get(struct ffs_data
*ffs
)
1377 atomic_inc(&ffs
->ref
);
1380 static void ffs_data_opened(struct ffs_data
*ffs
)
1384 atomic_inc(&ffs
->ref
);
1385 atomic_inc(&ffs
->opened
);
1388 static void ffs_data_put(struct ffs_data
*ffs
)
1392 if (unlikely(atomic_dec_and_test(&ffs
->ref
))) {
1393 pr_info("%s(): freeing\n", __func__
);
1394 ffs_data_clear(ffs
);
1395 BUG_ON(waitqueue_active(&ffs
->ev
.waitq
) ||
1396 waitqueue_active(&ffs
->ep0req_completion
.wait
));
1397 kfree(ffs
->dev_name
);
1402 static void ffs_data_closed(struct ffs_data
*ffs
)
1406 if (atomic_dec_and_test(&ffs
->opened
)) {
1407 ffs
->state
= FFS_CLOSING
;
1408 ffs_data_reset(ffs
);
1414 static struct ffs_data
*ffs_data_new(void)
1416 struct ffs_data
*ffs
= kzalloc(sizeof *ffs
, GFP_KERNEL
);
1422 atomic_set(&ffs
->ref
, 1);
1423 atomic_set(&ffs
->opened
, 0);
1424 ffs
->state
= FFS_READ_DESCRIPTORS
;
1425 mutex_init(&ffs
->mutex
);
1426 spin_lock_init(&ffs
->eps_lock
);
1427 init_waitqueue_head(&ffs
->ev
.waitq
);
1428 init_completion(&ffs
->ep0req_completion
);
1430 /* XXX REVISIT need to update it in some places, or do we? */
1431 ffs
->ev
.can_stall
= 1;
1436 static void ffs_data_clear(struct ffs_data
*ffs
)
1440 if (test_and_clear_bit(FFS_FL_CALL_CLOSED_CALLBACK
, &ffs
->flags
))
1443 BUG_ON(ffs
->gadget
);
1446 ffs_epfiles_destroy(ffs
->epfiles
, ffs
->eps_count
);
1448 kfree(ffs
->raw_descs_data
);
1449 kfree(ffs
->raw_strings
);
1450 kfree(ffs
->stringtabs
);
1453 static void ffs_data_reset(struct ffs_data
*ffs
)
1457 ffs_data_clear(ffs
);
1459 ffs
->epfiles
= NULL
;
1460 ffs
->raw_descs_data
= NULL
;
1461 ffs
->raw_descs
= NULL
;
1462 ffs
->raw_strings
= NULL
;
1463 ffs
->stringtabs
= NULL
;
1465 ffs
->raw_descs_length
= 0;
1466 ffs
->fs_descs_count
= 0;
1467 ffs
->hs_descs_count
= 0;
1468 ffs
->ss_descs_count
= 0;
1470 ffs
->strings_count
= 0;
1471 ffs
->interfaces_count
= 0;
1476 ffs
->state
= FFS_READ_DESCRIPTORS
;
1477 ffs
->setup_state
= FFS_NO_SETUP
;
1482 static int functionfs_bind(struct ffs_data
*ffs
, struct usb_composite_dev
*cdev
)
1484 struct usb_gadget_strings
**lang
;
1489 if (WARN_ON(ffs
->state
!= FFS_ACTIVE
1490 || test_and_set_bit(FFS_FL_BOUND
, &ffs
->flags
)))
1493 first_id
= usb_string_ids_n(cdev
, ffs
->strings_count
);
1494 if (unlikely(first_id
< 0))
1497 ffs
->ep0req
= usb_ep_alloc_request(cdev
->gadget
->ep0
, GFP_KERNEL
);
1498 if (unlikely(!ffs
->ep0req
))
1500 ffs
->ep0req
->complete
= ffs_ep0_complete
;
1501 ffs
->ep0req
->context
= ffs
;
1503 lang
= ffs
->stringtabs
;
1504 for (lang
= ffs
->stringtabs
; *lang
; ++lang
) {
1505 struct usb_string
*str
= (*lang
)->strings
;
1507 for (; str
->s
; ++id
, ++str
)
1511 ffs
->gadget
= cdev
->gadget
;
1516 static void functionfs_unbind(struct ffs_data
*ffs
)
1520 if (!WARN_ON(!ffs
->gadget
)) {
1521 usb_ep_free_request(ffs
->gadget
->ep0
, ffs
->ep0req
);
1524 clear_bit(FFS_FL_BOUND
, &ffs
->flags
);
1529 static int ffs_epfiles_create(struct ffs_data
*ffs
)
1531 struct ffs_epfile
*epfile
, *epfiles
;
1536 count
= ffs
->eps_count
;
1537 epfiles
= kcalloc(count
, sizeof(*epfiles
), GFP_KERNEL
);
1542 for (i
= 1; i
<= count
; ++i
, ++epfile
) {
1544 mutex_init(&epfile
->mutex
);
1545 init_waitqueue_head(&epfile
->wait
);
1546 sprintf(epfiles
->name
, "ep%u", i
);
1547 if (!unlikely(ffs_sb_create_file(ffs
->sb
, epfiles
->name
, epfile
,
1548 &ffs_epfile_operations
,
1549 &epfile
->dentry
))) {
1550 ffs_epfiles_destroy(epfiles
, i
- 1);
1555 ffs
->epfiles
= epfiles
;
1559 static void ffs_epfiles_destroy(struct ffs_epfile
*epfiles
, unsigned count
)
1561 struct ffs_epfile
*epfile
= epfiles
;
1565 for (; count
; --count
, ++epfile
) {
1566 BUG_ON(mutex_is_locked(&epfile
->mutex
) ||
1567 waitqueue_active(&epfile
->wait
));
1568 if (epfile
->dentry
) {
1569 d_delete(epfile
->dentry
);
1570 dput(epfile
->dentry
);
1571 epfile
->dentry
= NULL
;
1579 static void ffs_func_eps_disable(struct ffs_function
*func
)
1581 struct ffs_ep
*ep
= func
->eps
;
1582 struct ffs_epfile
*epfile
= func
->ffs
->epfiles
;
1583 unsigned count
= func
->ffs
->eps_count
;
1584 unsigned long flags
;
1586 spin_lock_irqsave(&func
->ffs
->eps_lock
, flags
);
1588 /* pending requests get nuked */
1590 usb_ep_disable(ep
->ep
);
1596 spin_unlock_irqrestore(&func
->ffs
->eps_lock
, flags
);
1599 static int ffs_func_eps_enable(struct ffs_function
*func
)
1601 struct ffs_data
*ffs
= func
->ffs
;
1602 struct ffs_ep
*ep
= func
->eps
;
1603 struct ffs_epfile
*epfile
= ffs
->epfiles
;
1604 unsigned count
= ffs
->eps_count
;
1605 unsigned long flags
;
1608 spin_lock_irqsave(&func
->ffs
->eps_lock
, flags
);
1610 struct usb_endpoint_descriptor
*ds
;
1613 if (ffs
->gadget
->speed
== USB_SPEED_SUPER
)
1615 else if (ffs
->gadget
->speed
== USB_SPEED_HIGH
)
1620 /* fall-back to lower speed if desc missing for current speed */
1622 ds
= ep
->descs
[desc_idx
];
1623 } while (!ds
&& --desc_idx
>= 0);
1630 ep
->ep
->driver_data
= ep
;
1632 ret
= usb_ep_enable(ep
->ep
);
1635 epfile
->in
= usb_endpoint_dir_in(ds
);
1636 epfile
->isoc
= usb_endpoint_xfer_isoc(ds
);
1641 wake_up(&epfile
->wait
);
1646 spin_unlock_irqrestore(&func
->ffs
->eps_lock
, flags
);
1652 /* Parsing and building descriptors and strings *****************************/
1655 * This validates if data pointed by data is a valid USB descriptor as
1656 * well as record how many interfaces, endpoints and strings are
1657 * required by given configuration. Returns address after the
1658 * descriptor or NULL if data is invalid.
1661 enum ffs_entity_type
{
1662 FFS_DESCRIPTOR
, FFS_INTERFACE
, FFS_STRING
, FFS_ENDPOINT
1665 typedef int (*ffs_entity_callback
)(enum ffs_entity_type entity
,
1667 struct usb_descriptor_header
*desc
,
1670 static int __must_check
ffs_do_desc(char *data
, unsigned len
,
1671 ffs_entity_callback entity
, void *priv
)
1673 struct usb_descriptor_header
*_ds
= (void *)data
;
1679 /* At least two bytes are required: length and type */
1681 pr_vdebug("descriptor too short\n");
1685 /* If we have at least as many bytes as the descriptor takes? */
1686 length
= _ds
->bLength
;
1688 pr_vdebug("descriptor longer then available data\n");
1692 #define __entity_check_INTERFACE(val) 1
1693 #define __entity_check_STRING(val) (val)
1694 #define __entity_check_ENDPOINT(val) ((val) & USB_ENDPOINT_NUMBER_MASK)
1695 #define __entity(type, val) do { \
1696 pr_vdebug("entity " #type "(%02x)\n", (val)); \
1697 if (unlikely(!__entity_check_ ##type(val))) { \
1698 pr_vdebug("invalid entity's value\n"); \
1701 ret = entity(FFS_ ##type, &val, _ds, priv); \
1702 if (unlikely(ret < 0)) { \
1703 pr_debug("entity " #type "(%02x); ret = %d\n", \
1709 /* Parse descriptor depending on type. */
1710 switch (_ds
->bDescriptorType
) {
1714 case USB_DT_DEVICE_QUALIFIER
:
1715 /* function can't have any of those */
1716 pr_vdebug("descriptor reserved for gadget: %d\n",
1717 _ds
->bDescriptorType
);
1720 case USB_DT_INTERFACE
: {
1721 struct usb_interface_descriptor
*ds
= (void *)_ds
;
1722 pr_vdebug("interface descriptor\n");
1723 if (length
!= sizeof *ds
)
1726 __entity(INTERFACE
, ds
->bInterfaceNumber
);
1728 __entity(STRING
, ds
->iInterface
);
1732 case USB_DT_ENDPOINT
: {
1733 struct usb_endpoint_descriptor
*ds
= (void *)_ds
;
1734 pr_vdebug("endpoint descriptor\n");
1735 if (length
!= USB_DT_ENDPOINT_SIZE
&&
1736 length
!= USB_DT_ENDPOINT_AUDIO_SIZE
)
1738 __entity(ENDPOINT
, ds
->bEndpointAddress
);
1743 pr_vdebug("hid descriptor\n");
1744 if (length
!= sizeof(struct hid_descriptor
))
1749 if (length
!= sizeof(struct usb_otg_descriptor
))
1753 case USB_DT_INTERFACE_ASSOCIATION
: {
1754 struct usb_interface_assoc_descriptor
*ds
= (void *)_ds
;
1755 pr_vdebug("interface association descriptor\n");
1756 if (length
!= sizeof *ds
)
1759 __entity(STRING
, ds
->iFunction
);
1763 case USB_DT_SS_ENDPOINT_COMP
:
1764 pr_vdebug("EP SS companion descriptor\n");
1765 if (length
!= sizeof(struct usb_ss_ep_comp_descriptor
))
1769 case USB_DT_OTHER_SPEED_CONFIG
:
1770 case USB_DT_INTERFACE_POWER
:
1772 case USB_DT_SECURITY
:
1773 case USB_DT_CS_RADIO_CONTROL
:
1775 pr_vdebug("unimplemented descriptor: %d\n", _ds
->bDescriptorType
);
1779 /* We should never be here */
1780 pr_vdebug("unknown descriptor: %d\n", _ds
->bDescriptorType
);
1784 pr_vdebug("invalid length: %d (descriptor %d)\n",
1785 _ds
->bLength
, _ds
->bDescriptorType
);
1790 #undef __entity_check_DESCRIPTOR
1791 #undef __entity_check_INTERFACE
1792 #undef __entity_check_STRING
1793 #undef __entity_check_ENDPOINT
1798 static int __must_check
ffs_do_descs(unsigned count
, char *data
, unsigned len
,
1799 ffs_entity_callback entity
, void *priv
)
1801 const unsigned _len
= len
;
1802 unsigned long num
= 0;
1812 /* Record "descriptor" entity */
1813 ret
= entity(FFS_DESCRIPTOR
, (u8
*)num
, (void *)data
, priv
);
1814 if (unlikely(ret
< 0)) {
1815 pr_debug("entity DESCRIPTOR(%02lx); ret = %d\n",
1823 ret
= ffs_do_desc(data
, len
, entity
, priv
);
1824 if (unlikely(ret
< 0)) {
1825 pr_debug("%s returns %d\n", __func__
, ret
);
1835 static int __ffs_data_do_entity(enum ffs_entity_type type
,
1836 u8
*valuep
, struct usb_descriptor_header
*desc
,
1839 struct ffs_data
*ffs
= priv
;
1844 case FFS_DESCRIPTOR
:
1849 * Interfaces are indexed from zero so if we
1850 * encountered interface "n" then there are at least
1853 if (*valuep
>= ffs
->interfaces_count
)
1854 ffs
->interfaces_count
= *valuep
+ 1;
1859 * Strings are indexed from 1 (0 is magic ;) reserved
1860 * for languages list or some such)
1862 if (*valuep
> ffs
->strings_count
)
1863 ffs
->strings_count
= *valuep
;
1867 /* Endpoints are indexed from 1 as well. */
1868 if ((*valuep
& USB_ENDPOINT_NUMBER_MASK
) > ffs
->eps_count
)
1869 ffs
->eps_count
= (*valuep
& USB_ENDPOINT_NUMBER_MASK
);
1876 static int __ffs_data_got_descs(struct ffs_data
*ffs
,
1877 char *const _data
, size_t len
)
1879 char *data
= _data
, *raw_descs
;
1880 unsigned counts
[3], flags
;
1881 int ret
= -EINVAL
, i
;
1885 if (get_unaligned_le32(data
+ 4) != len
)
1888 switch (get_unaligned_le32(data
)) {
1889 case FUNCTIONFS_DESCRIPTORS_MAGIC
:
1890 flags
= FUNCTIONFS_HAS_FS_DESC
| FUNCTIONFS_HAS_HS_DESC
;
1894 case FUNCTIONFS_DESCRIPTORS_MAGIC_V2
:
1895 flags
= get_unaligned_le32(data
+ 8);
1896 if (flags
& ~(FUNCTIONFS_HAS_FS_DESC
|
1897 FUNCTIONFS_HAS_HS_DESC
|
1898 FUNCTIONFS_HAS_SS_DESC
)) {
1909 /* Read fs_count, hs_count and ss_count (if present) */
1910 for (i
= 0; i
< 3; ++i
) {
1911 if (!(flags
& (1 << i
))) {
1913 } else if (len
< 4) {
1916 counts
[i
] = get_unaligned_le32(data
);
1922 /* Read descriptors */
1924 for (i
= 0; i
< 3; ++i
) {
1927 ret
= ffs_do_descs(counts
[i
], data
, len
,
1928 __ffs_data_do_entity
, ffs
);
1935 if (raw_descs
== data
|| len
) {
1940 ffs
->raw_descs_data
= _data
;
1941 ffs
->raw_descs
= raw_descs
;
1942 ffs
->raw_descs_length
= data
- raw_descs
;
1943 ffs
->fs_descs_count
= counts
[0];
1944 ffs
->hs_descs_count
= counts
[1];
1945 ffs
->ss_descs_count
= counts
[2];
1954 static int __ffs_data_got_strings(struct ffs_data
*ffs
,
1955 char *const _data
, size_t len
)
1957 u32 str_count
, needed_count
, lang_count
;
1958 struct usb_gadget_strings
**stringtabs
, *t
;
1959 struct usb_string
*strings
, *s
;
1960 const char *data
= _data
;
1964 if (unlikely(get_unaligned_le32(data
) != FUNCTIONFS_STRINGS_MAGIC
||
1965 get_unaligned_le32(data
+ 4) != len
))
1967 str_count
= get_unaligned_le32(data
+ 8);
1968 lang_count
= get_unaligned_le32(data
+ 12);
1970 /* if one is zero the other must be zero */
1971 if (unlikely(!str_count
!= !lang_count
))
1974 /* Do we have at least as many strings as descriptors need? */
1975 needed_count
= ffs
->strings_count
;
1976 if (unlikely(str_count
< needed_count
))
1980 * If we don't need any strings just return and free all
1983 if (!needed_count
) {
1988 /* Allocate everything in one chunk so there's less maintenance. */
1992 vla_item(d
, struct usb_gadget_strings
*, stringtabs
,
1994 vla_item(d
, struct usb_gadget_strings
, stringtab
, lang_count
);
1995 vla_item(d
, struct usb_string
, strings
,
1996 lang_count
*(needed_count
+1));
1998 char *vlabuf
= kmalloc(vla_group_size(d
), GFP_KERNEL
);
2000 if (unlikely(!vlabuf
)) {
2005 /* Initialize the VLA pointers */
2006 stringtabs
= vla_ptr(vlabuf
, d
, stringtabs
);
2007 t
= vla_ptr(vlabuf
, d
, stringtab
);
2010 *stringtabs
++ = t
++;
2014 /* stringtabs = vlabuf = d_stringtabs for later kfree */
2015 stringtabs
= vla_ptr(vlabuf
, d
, stringtabs
);
2016 t
= vla_ptr(vlabuf
, d
, stringtab
);
2017 s
= vla_ptr(vlabuf
, d
, strings
);
2021 /* For each language */
2025 do { /* lang_count > 0 so we can use do-while */
2026 unsigned needed
= needed_count
;
2028 if (unlikely(len
< 3))
2030 t
->language
= get_unaligned_le16(data
);
2037 /* For each string */
2038 do { /* str_count > 0 so we can use do-while */
2039 size_t length
= strnlen(data
, len
);
2041 if (unlikely(length
== len
))
2045 * User may provide more strings then we need,
2046 * if that's the case we simply ignore the
2049 if (likely(needed
)) {
2051 * s->id will be set while adding
2052 * function to configuration so for
2053 * now just leave garbage here.
2062 } while (--str_count
);
2064 s
->id
= 0; /* terminator */
2068 } while (--lang_count
);
2070 /* Some garbage left? */
2075 ffs
->stringtabs
= stringtabs
;
2076 ffs
->raw_strings
= _data
;
2088 /* Events handling and management *******************************************/
2090 static void __ffs_event_add(struct ffs_data
*ffs
,
2091 enum usb_functionfs_event_type type
)
2093 enum usb_functionfs_event_type rem_type1
, rem_type2
= type
;
2097 * Abort any unhandled setup
2099 * We do not need to worry about some cmpxchg() changing value
2100 * of ffs->setup_state without holding the lock because when
2101 * state is FFS_SETUP_PENDING cmpxchg() in several places in
2102 * the source does nothing.
2104 if (ffs
->setup_state
== FFS_SETUP_PENDING
)
2105 ffs
->setup_state
= FFS_SETUP_CANCELLED
;
2108 case FUNCTIONFS_RESUME
:
2109 rem_type2
= FUNCTIONFS_SUSPEND
;
2111 case FUNCTIONFS_SUSPEND
:
2112 case FUNCTIONFS_SETUP
:
2114 /* Discard all similar events */
2117 case FUNCTIONFS_BIND
:
2118 case FUNCTIONFS_UNBIND
:
2119 case FUNCTIONFS_DISABLE
:
2120 case FUNCTIONFS_ENABLE
:
2121 /* Discard everything other then power management. */
2122 rem_type1
= FUNCTIONFS_SUSPEND
;
2123 rem_type2
= FUNCTIONFS_RESUME
;
2132 u8
*ev
= ffs
->ev
.types
, *out
= ev
;
2133 unsigned n
= ffs
->ev
.count
;
2134 for (; n
; --n
, ++ev
)
2135 if ((*ev
== rem_type1
|| *ev
== rem_type2
) == neg
)
2138 pr_vdebug("purging event %d\n", *ev
);
2139 ffs
->ev
.count
= out
- ffs
->ev
.types
;
2142 pr_vdebug("adding event %d\n", type
);
2143 ffs
->ev
.types
[ffs
->ev
.count
++] = type
;
2144 wake_up_locked(&ffs
->ev
.waitq
);
2147 static void ffs_event_add(struct ffs_data
*ffs
,
2148 enum usb_functionfs_event_type type
)
2150 unsigned long flags
;
2151 spin_lock_irqsave(&ffs
->ev
.waitq
.lock
, flags
);
2152 __ffs_event_add(ffs
, type
);
2153 spin_unlock_irqrestore(&ffs
->ev
.waitq
.lock
, flags
);
2157 /* Bind/unbind USB function hooks *******************************************/
2159 static int __ffs_func_bind_do_descs(enum ffs_entity_type type
, u8
*valuep
,
2160 struct usb_descriptor_header
*desc
,
2163 struct usb_endpoint_descriptor
*ds
= (void *)desc
;
2164 struct ffs_function
*func
= priv
;
2165 struct ffs_ep
*ffs_ep
;
2166 unsigned ep_desc_id
, idx
;
2167 static const char *speed_names
[] = { "full", "high", "super" };
2169 if (type
!= FFS_DESCRIPTOR
)
2173 * If ss_descriptors is not NULL, we are reading super speed
2174 * descriptors; if hs_descriptors is not NULL, we are reading high
2175 * speed descriptors; otherwise, we are reading full speed
2178 if (func
->function
.ss_descriptors
) {
2180 func
->function
.ss_descriptors
[(long)valuep
] = desc
;
2181 } else if (func
->function
.hs_descriptors
) {
2183 func
->function
.hs_descriptors
[(long)valuep
] = desc
;
2186 func
->function
.fs_descriptors
[(long)valuep
] = desc
;
2189 if (!desc
|| desc
->bDescriptorType
!= USB_DT_ENDPOINT
)
2192 idx
= (ds
->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
) - 1;
2193 ffs_ep
= func
->eps
+ idx
;
2195 if (unlikely(ffs_ep
->descs
[ep_desc_id
])) {
2196 pr_err("two %sspeed descriptors for EP %d\n",
2197 speed_names
[ep_desc_id
],
2198 ds
->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
);
2201 ffs_ep
->descs
[ep_desc_id
] = ds
;
2203 ffs_dump_mem(": Original ep desc", ds
, ds
->bLength
);
2205 ds
->bEndpointAddress
= ffs_ep
->descs
[0]->bEndpointAddress
;
2206 if (!ds
->wMaxPacketSize
)
2207 ds
->wMaxPacketSize
= ffs_ep
->descs
[0]->wMaxPacketSize
;
2209 struct usb_request
*req
;
2212 pr_vdebug("autoconfig\n");
2213 ep
= usb_ep_autoconfig(func
->gadget
, ds
);
2216 ep
->driver_data
= func
->eps
+ idx
;
2218 req
= usb_ep_alloc_request(ep
, GFP_KERNEL
);
2224 func
->eps_revmap
[ds
->bEndpointAddress
&
2225 USB_ENDPOINT_NUMBER_MASK
] = idx
+ 1;
2227 ffs_dump_mem(": Rewritten ep desc", ds
, ds
->bLength
);
2232 static int __ffs_func_bind_do_nums(enum ffs_entity_type type
, u8
*valuep
,
2233 struct usb_descriptor_header
*desc
,
2236 struct ffs_function
*func
= priv
;
2242 case FFS_DESCRIPTOR
:
2243 /* Handled in previous pass by __ffs_func_bind_do_descs() */
2248 if (func
->interfaces_nums
[idx
] < 0) {
2249 int id
= usb_interface_id(func
->conf
, &func
->function
);
2250 if (unlikely(id
< 0))
2252 func
->interfaces_nums
[idx
] = id
;
2254 newValue
= func
->interfaces_nums
[idx
];
2258 /* String' IDs are allocated when fsf_data is bound to cdev */
2259 newValue
= func
->ffs
->stringtabs
[0]->strings
[*valuep
- 1].id
;
2264 * USB_DT_ENDPOINT are handled in
2265 * __ffs_func_bind_do_descs().
2267 if (desc
->bDescriptorType
== USB_DT_ENDPOINT
)
2270 idx
= (*valuep
& USB_ENDPOINT_NUMBER_MASK
) - 1;
2271 if (unlikely(!func
->eps
[idx
].ep
))
2275 struct usb_endpoint_descriptor
**descs
;
2276 descs
= func
->eps
[idx
].descs
;
2277 newValue
= descs
[descs
[0] ? 0 : 1]->bEndpointAddress
;
2282 pr_vdebug("%02x -> %02x\n", *valuep
, newValue
);
2287 static inline struct f_fs_opts
*ffs_do_functionfs_bind(struct usb_function
*f
,
2288 struct usb_configuration
*c
)
2290 struct ffs_function
*func
= ffs_func_from_usb(f
);
2291 struct f_fs_opts
*ffs_opts
=
2292 container_of(f
->fi
, struct f_fs_opts
, func_inst
);
2298 * Legacy gadget triggers binding in functionfs_ready_callback,
2299 * which already uses locking; taking the same lock here would
2302 * Configfs-enabled gadgets however do need ffs_dev_lock.
2304 if (!ffs_opts
->no_configfs
)
2306 ret
= ffs_opts
->dev
->desc_ready
? 0 : -ENODEV
;
2307 func
->ffs
= ffs_opts
->dev
->ffs_data
;
2308 if (!ffs_opts
->no_configfs
)
2311 return ERR_PTR(ret
);
2314 func
->gadget
= c
->cdev
->gadget
;
2316 ffs_data_get(func
->ffs
);
2319 * in drivers/usb/gadget/configfs.c:configfs_composite_bind()
2320 * configurations are bound in sequence with list_for_each_entry,
2321 * in each configuration its functions are bound in sequence
2322 * with list_for_each_entry, so we assume no race condition
2323 * with regard to ffs_opts->bound access
2325 if (!ffs_opts
->refcnt
) {
2326 ret
= functionfs_bind(func
->ffs
, c
->cdev
);
2328 return ERR_PTR(ret
);
2331 func
->function
.strings
= func
->ffs
->stringtabs
;
2336 static int _ffs_func_bind(struct usb_configuration
*c
,
2337 struct usb_function
*f
)
2339 struct ffs_function
*func
= ffs_func_from_usb(f
);
2340 struct ffs_data
*ffs
= func
->ffs
;
2342 const int full
= !!func
->ffs
->fs_descs_count
;
2343 const int high
= gadget_is_dualspeed(func
->gadget
) &&
2344 func
->ffs
->hs_descs_count
;
2345 const int super
= gadget_is_superspeed(func
->gadget
) &&
2346 func
->ffs
->ss_descs_count
;
2348 int fs_len
, hs_len
, ret
;
2350 /* Make it a single chunk, less management later on */
2352 vla_item_with_sz(d
, struct ffs_ep
, eps
, ffs
->eps_count
);
2353 vla_item_with_sz(d
, struct usb_descriptor_header
*, fs_descs
,
2354 full
? ffs
->fs_descs_count
+ 1 : 0);
2355 vla_item_with_sz(d
, struct usb_descriptor_header
*, hs_descs
,
2356 high
? ffs
->hs_descs_count
+ 1 : 0);
2357 vla_item_with_sz(d
, struct usb_descriptor_header
*, ss_descs
,
2358 super
? ffs
->ss_descs_count
+ 1 : 0);
2359 vla_item_with_sz(d
, short, inums
, ffs
->interfaces_count
);
2360 vla_item_with_sz(d
, char, raw_descs
, ffs
->raw_descs_length
);
2365 /* Has descriptors only for speeds gadget does not support */
2366 if (unlikely(!(full
| high
| super
)))
2369 /* Allocate a single chunk, less management later on */
2370 vlabuf
= kmalloc(vla_group_size(d
), GFP_KERNEL
);
2371 if (unlikely(!vlabuf
))
2375 memset(vla_ptr(vlabuf
, d
, eps
), 0, d_eps__sz
);
2376 /* Copy descriptors */
2377 memcpy(vla_ptr(vlabuf
, d
, raw_descs
), ffs
->raw_descs
,
2378 ffs
->raw_descs_length
);
2380 memset(vla_ptr(vlabuf
, d
, inums
), 0xff, d_inums__sz
);
2381 for (ret
= ffs
->eps_count
; ret
; --ret
) {
2384 ptr
= vla_ptr(vlabuf
, d
, eps
);
2389 * d_eps == vlabuf, func->eps used to kfree vlabuf later
2391 func
->eps
= vla_ptr(vlabuf
, d
, eps
);
2392 func
->interfaces_nums
= vla_ptr(vlabuf
, d
, inums
);
2395 * Go through all the endpoint descriptors and allocate
2396 * endpoints first, so that later we can rewrite the endpoint
2397 * numbers without worrying that it may be described later on.
2400 func
->function
.fs_descriptors
= vla_ptr(vlabuf
, d
, fs_descs
);
2401 fs_len
= ffs_do_descs(ffs
->fs_descs_count
,
2402 vla_ptr(vlabuf
, d
, raw_descs
),
2404 __ffs_func_bind_do_descs
, func
);
2405 if (unlikely(fs_len
< 0)) {
2414 func
->function
.hs_descriptors
= vla_ptr(vlabuf
, d
, hs_descs
);
2415 hs_len
= ffs_do_descs(ffs
->hs_descs_count
,
2416 vla_ptr(vlabuf
, d
, raw_descs
) + fs_len
,
2417 d_raw_descs__sz
- fs_len
,
2418 __ffs_func_bind_do_descs
, func
);
2419 if (unlikely(hs_len
< 0)) {
2427 if (likely(super
)) {
2428 func
->function
.ss_descriptors
= vla_ptr(vlabuf
, d
, ss_descs
);
2429 ret
= ffs_do_descs(ffs
->ss_descs_count
,
2430 vla_ptr(vlabuf
, d
, raw_descs
) + fs_len
+ hs_len
,
2431 d_raw_descs__sz
- fs_len
- hs_len
,
2432 __ffs_func_bind_do_descs
, func
);
2433 if (unlikely(ret
< 0))
2438 * Now handle interface numbers allocation and interface and
2439 * endpoint numbers rewriting. We can do that in one go
2442 ret
= ffs_do_descs(ffs
->fs_descs_count
+
2443 (high
? ffs
->hs_descs_count
: 0) +
2444 (super
? ffs
->ss_descs_count
: 0),
2445 vla_ptr(vlabuf
, d
, raw_descs
), d_raw_descs__sz
,
2446 __ffs_func_bind_do_nums
, func
);
2447 if (unlikely(ret
< 0))
2450 /* And we're done */
2451 ffs_event_add(ffs
, FUNCTIONFS_BIND
);
2455 /* XXX Do we need to release all claimed endpoints here? */
2459 static int ffs_func_bind(struct usb_configuration
*c
,
2460 struct usb_function
*f
)
2462 struct f_fs_opts
*ffs_opts
= ffs_do_functionfs_bind(f
, c
);
2464 if (IS_ERR(ffs_opts
))
2465 return PTR_ERR(ffs_opts
);
2467 return _ffs_func_bind(c
, f
);
2471 /* Other USB function hooks *************************************************/
2473 static int ffs_func_set_alt(struct usb_function
*f
,
2474 unsigned interface
, unsigned alt
)
2476 struct ffs_function
*func
= ffs_func_from_usb(f
);
2477 struct ffs_data
*ffs
= func
->ffs
;
2480 if (alt
!= (unsigned)-1) {
2481 intf
= ffs_func_revmap_intf(func
, interface
);
2482 if (unlikely(intf
< 0))
2487 ffs_func_eps_disable(ffs
->func
);
2489 if (ffs
->state
!= FFS_ACTIVE
)
2492 if (alt
== (unsigned)-1) {
2494 ffs_event_add(ffs
, FUNCTIONFS_DISABLE
);
2499 ret
= ffs_func_eps_enable(func
);
2500 if (likely(ret
>= 0))
2501 ffs_event_add(ffs
, FUNCTIONFS_ENABLE
);
2505 static void ffs_func_disable(struct usb_function
*f
)
2507 ffs_func_set_alt(f
, 0, (unsigned)-1);
2510 static int ffs_func_setup(struct usb_function
*f
,
2511 const struct usb_ctrlrequest
*creq
)
2513 struct ffs_function
*func
= ffs_func_from_usb(f
);
2514 struct ffs_data
*ffs
= func
->ffs
;
2515 unsigned long flags
;
2520 pr_vdebug("creq->bRequestType = %02x\n", creq
->bRequestType
);
2521 pr_vdebug("creq->bRequest = %02x\n", creq
->bRequest
);
2522 pr_vdebug("creq->wValue = %04x\n", le16_to_cpu(creq
->wValue
));
2523 pr_vdebug("creq->wIndex = %04x\n", le16_to_cpu(creq
->wIndex
));
2524 pr_vdebug("creq->wLength = %04x\n", le16_to_cpu(creq
->wLength
));
2527 * Most requests directed to interface go through here
2528 * (notable exceptions are set/get interface) so we need to
2529 * handle them. All other either handled by composite or
2530 * passed to usb_configuration->setup() (if one is set). No
2531 * matter, we will handle requests directed to endpoint here
2532 * as well (as it's straightforward) but what to do with any
2535 if (ffs
->state
!= FFS_ACTIVE
)
2538 switch (creq
->bRequestType
& USB_RECIP_MASK
) {
2539 case USB_RECIP_INTERFACE
:
2540 ret
= ffs_func_revmap_intf(func
, le16_to_cpu(creq
->wIndex
));
2541 if (unlikely(ret
< 0))
2545 case USB_RECIP_ENDPOINT
:
2546 ret
= ffs_func_revmap_ep(func
, le16_to_cpu(creq
->wIndex
));
2547 if (unlikely(ret
< 0))
2555 spin_lock_irqsave(&ffs
->ev
.waitq
.lock
, flags
);
2556 ffs
->ev
.setup
= *creq
;
2557 ffs
->ev
.setup
.wIndex
= cpu_to_le16(ret
);
2558 __ffs_event_add(ffs
, FUNCTIONFS_SETUP
);
2559 spin_unlock_irqrestore(&ffs
->ev
.waitq
.lock
, flags
);
2564 static void ffs_func_suspend(struct usb_function
*f
)
2567 ffs_event_add(ffs_func_from_usb(f
)->ffs
, FUNCTIONFS_SUSPEND
);
2570 static void ffs_func_resume(struct usb_function
*f
)
2573 ffs_event_add(ffs_func_from_usb(f
)->ffs
, FUNCTIONFS_RESUME
);
2577 /* Endpoint and interface numbers reverse mapping ***************************/
2579 static int ffs_func_revmap_ep(struct ffs_function
*func
, u8 num
)
2581 num
= func
->eps_revmap
[num
& USB_ENDPOINT_NUMBER_MASK
];
2582 return num
? num
: -EDOM
;
2585 static int ffs_func_revmap_intf(struct ffs_function
*func
, u8 intf
)
2587 short *nums
= func
->interfaces_nums
;
2588 unsigned count
= func
->ffs
->interfaces_count
;
2590 for (; count
; --count
, ++nums
) {
2591 if (*nums
>= 0 && *nums
== intf
)
2592 return nums
- func
->interfaces_nums
;
2599 /* Devices management *******************************************************/
2601 static LIST_HEAD(ffs_devices
);
2603 static struct ffs_dev
*_ffs_do_find_dev(const char *name
)
2605 struct ffs_dev
*dev
;
2607 list_for_each_entry(dev
, &ffs_devices
, entry
) {
2608 if (!dev
->name
|| !name
)
2610 if (strcmp(dev
->name
, name
) == 0)
2618 * ffs_lock must be taken by the caller of this function
2620 static struct ffs_dev
*_ffs_get_single_dev(void)
2622 struct ffs_dev
*dev
;
2624 if (list_is_singular(&ffs_devices
)) {
2625 dev
= list_first_entry(&ffs_devices
, struct ffs_dev
, entry
);
2634 * ffs_lock must be taken by the caller of this function
2636 static struct ffs_dev
*_ffs_find_dev(const char *name
)
2638 struct ffs_dev
*dev
;
2640 dev
= _ffs_get_single_dev();
2644 return _ffs_do_find_dev(name
);
2647 /* Configfs support *********************************************************/
2649 static inline struct f_fs_opts
*to_ffs_opts(struct config_item
*item
)
2651 return container_of(to_config_group(item
), struct f_fs_opts
,
2655 static void ffs_attr_release(struct config_item
*item
)
2657 struct f_fs_opts
*opts
= to_ffs_opts(item
);
2659 usb_put_function_instance(&opts
->func_inst
);
2662 static struct configfs_item_operations ffs_item_ops
= {
2663 .release
= ffs_attr_release
,
2666 static struct config_item_type ffs_func_type
= {
2667 .ct_item_ops
= &ffs_item_ops
,
2668 .ct_owner
= THIS_MODULE
,
2672 /* Function registration interface ******************************************/
2674 static void ffs_free_inst(struct usb_function_instance
*f
)
2676 struct f_fs_opts
*opts
;
2678 opts
= to_f_fs_opts(f
);
2680 _ffs_free_dev(opts
->dev
);
2685 #define MAX_INST_NAME_LEN 40
2687 static int ffs_set_inst_name(struct usb_function_instance
*fi
, const char *name
)
2689 struct f_fs_opts
*opts
;
2694 name_len
= strlen(name
) + 1;
2695 if (name_len
> MAX_INST_NAME_LEN
)
2696 return -ENAMETOOLONG
;
2698 ptr
= kstrndup(name
, name_len
, GFP_KERNEL
);
2702 opts
= to_f_fs_opts(fi
);
2707 tmp
= opts
->dev
->name_allocated
? opts
->dev
->name
: NULL
;
2708 ret
= _ffs_name_dev(opts
->dev
, ptr
);
2714 opts
->dev
->name_allocated
= true;
2723 static struct usb_function_instance
*ffs_alloc_inst(void)
2725 struct f_fs_opts
*opts
;
2726 struct ffs_dev
*dev
;
2728 opts
= kzalloc(sizeof(*opts
), GFP_KERNEL
);
2730 return ERR_PTR(-ENOMEM
);
2732 opts
->func_inst
.set_inst_name
= ffs_set_inst_name
;
2733 opts
->func_inst
.free_func_inst
= ffs_free_inst
;
2735 dev
= _ffs_alloc_dev();
2739 return ERR_CAST(dev
);
2744 config_group_init_type_name(&opts
->func_inst
.group
, "",
2746 return &opts
->func_inst
;
2749 static void ffs_free(struct usb_function
*f
)
2751 kfree(ffs_func_from_usb(f
));
2754 static void ffs_func_unbind(struct usb_configuration
*c
,
2755 struct usb_function
*f
)
2757 struct ffs_function
*func
= ffs_func_from_usb(f
);
2758 struct ffs_data
*ffs
= func
->ffs
;
2759 struct f_fs_opts
*opts
=
2760 container_of(f
->fi
, struct f_fs_opts
, func_inst
);
2761 struct ffs_ep
*ep
= func
->eps
;
2762 unsigned count
= ffs
->eps_count
;
2763 unsigned long flags
;
2766 if (ffs
->func
== func
) {
2767 ffs_func_eps_disable(func
);
2771 if (!--opts
->refcnt
)
2772 functionfs_unbind(ffs
);
2774 /* cleanup after autoconfig */
2775 spin_lock_irqsave(&func
->ffs
->eps_lock
, flags
);
2777 if (ep
->ep
&& ep
->req
)
2778 usb_ep_free_request(ep
->ep
, ep
->req
);
2782 spin_unlock_irqrestore(&func
->ffs
->eps_lock
, flags
);
2786 * eps, descriptors and interfaces_nums are allocated in the
2787 * same chunk so only one free is required.
2789 func
->function
.fs_descriptors
= NULL
;
2790 func
->function
.hs_descriptors
= NULL
;
2791 func
->function
.ss_descriptors
= NULL
;
2792 func
->interfaces_nums
= NULL
;
2794 ffs_event_add(ffs
, FUNCTIONFS_UNBIND
);
2797 static struct usb_function
*ffs_alloc(struct usb_function_instance
*fi
)
2799 struct ffs_function
*func
;
2803 func
= kzalloc(sizeof(*func
), GFP_KERNEL
);
2804 if (unlikely(!func
))
2805 return ERR_PTR(-ENOMEM
);
2807 func
->function
.name
= "Function FS Gadget";
2809 func
->function
.bind
= ffs_func_bind
;
2810 func
->function
.unbind
= ffs_func_unbind
;
2811 func
->function
.set_alt
= ffs_func_set_alt
;
2812 func
->function
.disable
= ffs_func_disable
;
2813 func
->function
.setup
= ffs_func_setup
;
2814 func
->function
.suspend
= ffs_func_suspend
;
2815 func
->function
.resume
= ffs_func_resume
;
2816 func
->function
.free_func
= ffs_free
;
2818 return &func
->function
;
2822 * ffs_lock must be taken by the caller of this function
2824 static struct ffs_dev
*_ffs_alloc_dev(void)
2826 struct ffs_dev
*dev
;
2829 if (_ffs_get_single_dev())
2830 return ERR_PTR(-EBUSY
);
2832 dev
= kzalloc(sizeof(*dev
), GFP_KERNEL
);
2834 return ERR_PTR(-ENOMEM
);
2836 if (list_empty(&ffs_devices
)) {
2837 ret
= functionfs_init();
2840 return ERR_PTR(ret
);
2844 list_add(&dev
->entry
, &ffs_devices
);
2850 * ffs_lock must be taken by the caller of this function
2851 * The caller is responsible for "name" being available whenever f_fs needs it
2853 static int _ffs_name_dev(struct ffs_dev
*dev
, const char *name
)
2855 struct ffs_dev
*existing
;
2857 existing
= _ffs_do_find_dev(name
);
2867 * The caller is responsible for "name" being available whenever f_fs needs it
2869 int ffs_name_dev(struct ffs_dev
*dev
, const char *name
)
2874 ret
= _ffs_name_dev(dev
, name
);
2879 EXPORT_SYMBOL(ffs_name_dev
);
2881 int ffs_single_dev(struct ffs_dev
*dev
)
2888 if (!list_is_singular(&ffs_devices
))
2896 EXPORT_SYMBOL(ffs_single_dev
);
2899 * ffs_lock must be taken by the caller of this function
2901 static void _ffs_free_dev(struct ffs_dev
*dev
)
2903 list_del(&dev
->entry
);
2904 if (dev
->name_allocated
)
2907 if (list_empty(&ffs_devices
))
2908 functionfs_cleanup();
2911 static void *ffs_acquire_dev(const char *dev_name
)
2913 struct ffs_dev
*ffs_dev
;
2918 ffs_dev
= _ffs_find_dev(dev_name
);
2920 ffs_dev
= ERR_PTR(-ENODEV
);
2921 else if (ffs_dev
->mounted
)
2922 ffs_dev
= ERR_PTR(-EBUSY
);
2923 else if (ffs_dev
->ffs_acquire_dev_callback
&&
2924 ffs_dev
->ffs_acquire_dev_callback(ffs_dev
))
2925 ffs_dev
= ERR_PTR(-ENODEV
);
2927 ffs_dev
->mounted
= true;
2933 static void ffs_release_dev(struct ffs_data
*ffs_data
)
2935 struct ffs_dev
*ffs_dev
;
2940 ffs_dev
= ffs_data
->private_data
;
2942 ffs_dev
->mounted
= false;
2944 if (ffs_dev
->ffs_release_dev_callback
)
2945 ffs_dev
->ffs_release_dev_callback(ffs_dev
);
2951 static int ffs_ready(struct ffs_data
*ffs
)
2953 struct ffs_dev
*ffs_obj
;
2959 ffs_obj
= ffs
->private_data
;
2964 if (WARN_ON(ffs_obj
->desc_ready
)) {
2969 ffs_obj
->desc_ready
= true;
2970 ffs_obj
->ffs_data
= ffs
;
2972 if (ffs_obj
->ffs_ready_callback
)
2973 ret
= ffs_obj
->ffs_ready_callback(ffs
);
2980 static void ffs_closed(struct ffs_data
*ffs
)
2982 struct ffs_dev
*ffs_obj
;
2987 ffs_obj
= ffs
->private_data
;
2991 ffs_obj
->desc_ready
= false;
2993 if (ffs_obj
->ffs_closed_callback
)
2994 ffs_obj
->ffs_closed_callback(ffs
);
2996 if (!ffs_obj
->opts
|| ffs_obj
->opts
->no_configfs
2997 || !ffs_obj
->opts
->func_inst
.group
.cg_item
.ci_parent
)
3000 unregister_gadget_item(ffs_obj
->opts
->
3001 func_inst
.group
.cg_item
.ci_parent
->ci_parent
);
3006 /* Misc helper functions ****************************************************/
3008 static int ffs_mutex_lock(struct mutex
*mutex
, unsigned nonblock
)
3011 ? likely(mutex_trylock(mutex
)) ? 0 : -EAGAIN
3012 : mutex_lock_interruptible(mutex
);
3015 static char *ffs_prepare_buffer(const char __user
*buf
, size_t len
)
3022 data
= kmalloc(len
, GFP_KERNEL
);
3023 if (unlikely(!data
))
3024 return ERR_PTR(-ENOMEM
);
3026 if (unlikely(__copy_from_user(data
, buf
, len
))) {
3028 return ERR_PTR(-EFAULT
);
3031 pr_vdebug("Buffer from user space:\n");
3032 ffs_dump_mem("", data
, len
);
3037 DECLARE_USB_FUNCTION_INIT(ffs
, ffs_alloc_inst
, ffs_alloc
);
3038 MODULE_LICENSE("GPL");
3039 MODULE_AUTHOR("Michal Nazarewicz");