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 <linux/uio.h>
27 #include <asm/unaligned.h>
29 #include <linux/usb/composite.h>
30 #include <linux/usb/functionfs.h>
32 #include <linux/aio.h>
33 #include <linux/mmu_context.h>
34 #include <linux/poll.h>
35 #include <linux/eventfd.h>
39 #include "u_os_desc.h"
42 #define FUNCTIONFS_MAGIC 0xa647361 /* Chosen by a honest dice roll ;) */
44 /* Reference counter handling */
45 static void ffs_data_get(struct ffs_data *ffs);
46 static void ffs_data_put(struct ffs_data *ffs);
47 /* Creates new ffs_data object. */
48 static struct ffs_data *__must_check ffs_data_new(void) __attribute__((malloc));
50 /* Opened counter handling. */
51 static void ffs_data_opened(struct ffs_data *ffs);
52 static void ffs_data_closed(struct ffs_data *ffs);
54 /* Called with ffs->mutex held; take over ownership of data. */
55 static int __must_check
56 __ffs_data_got_descs(struct ffs_data *ffs, char *data, size_t len);
57 static int __must_check
58 __ffs_data_got_strings(struct ffs_data *ffs, char *data, size_t len);
61 /* The function structure ***************************************************/
66 struct usb_configuration *conf;
67 struct usb_gadget *gadget;
72 short *interfaces_nums;
74 struct usb_function function;
78 static struct ffs_function *ffs_func_from_usb(struct usb_function *f)
80 return container_of(f, struct ffs_function, function);
84 static inline enum ffs_setup_state
85 ffs_setup_state_clear_cancelled(struct ffs_data *ffs)
87 return (enum ffs_setup_state)
88 cmpxchg(&ffs->setup_state, FFS_SETUP_CANCELLED, FFS_NO_SETUP);
92 static void ffs_func_eps_disable(struct ffs_function *func);
93 static int __must_check ffs_func_eps_enable(struct ffs_function *func);
95 static int ffs_func_bind(struct usb_configuration *,
96 struct usb_function *);
97 static int ffs_func_set_alt(struct usb_function *, unsigned, unsigned);
98 static void ffs_func_disable(struct usb_function *);
99 static int ffs_func_setup(struct usb_function *,
100 const struct usb_ctrlrequest *);
101 static void ffs_func_suspend(struct usb_function *);
102 static void ffs_func_resume(struct usb_function *);
105 static int ffs_func_revmap_ep(struct ffs_function *func, u8 num);
106 static int ffs_func_revmap_intf(struct ffs_function *func, u8 intf);
109 /* The endpoints structures *************************************************/
112 struct usb_ep *ep; /* P: ffs->eps_lock */
113 struct usb_request *req; /* P: epfile->mutex */
115 /* [0]: full speed, [1]: high speed, [2]: super speed */
116 struct usb_endpoint_descriptor *descs[3];
120 int status; /* P: epfile->mutex */
124 /* Protects ep->ep and ep->req. */
126 wait_queue_head_t wait;
128 struct ffs_data *ffs;
129 struct ffs_ep *ep; /* P: ffs->eps_lock */
131 struct dentry *dentry;
135 unsigned char in; /* P: ffs->eps_lock */
136 unsigned char isoc; /* P: ffs->eps_lock */
141 /* ffs_io_data structure ***************************************************/
148 struct iov_iter data;
152 struct mm_struct *mm;
153 struct work_struct work;
156 struct usb_request *req;
158 struct ffs_data *ffs;
161 struct ffs_desc_helper {
162 struct ffs_data *ffs;
163 unsigned interfaces_count;
167 static int __must_check ffs_epfiles_create(struct ffs_data *ffs);
168 static void ffs_epfiles_destroy(struct ffs_epfile *epfiles, unsigned count);
170 static struct dentry *
171 ffs_sb_create_file(struct super_block *sb, const char *name, void *data,
172 const struct file_operations *fops);
174 /* Devices management *******************************************************/
176 DEFINE_MUTEX(ffs_lock);
177 EXPORT_SYMBOL_GPL(ffs_lock);
179 static struct ffs_dev *_ffs_find_dev(const char *name);
180 static struct ffs_dev *_ffs_alloc_dev(void);
181 static int _ffs_name_dev(struct ffs_dev *dev, const char *name);
182 static void _ffs_free_dev(struct ffs_dev *dev);
183 static void *ffs_acquire_dev(const char *dev_name);
184 static void ffs_release_dev(struct ffs_data *ffs_data);
185 static int ffs_ready(struct ffs_data *ffs);
186 static void ffs_closed(struct ffs_data *ffs);
188 /* Misc helper functions ****************************************************/
190 static int ffs_mutex_lock(struct mutex *mutex, unsigned nonblock)
191 __attribute__((warn_unused_result, nonnull));
192 static char *ffs_prepare_buffer(const char __user *buf, size_t len)
193 __attribute__((warn_unused_result, nonnull));
196 /* Control file aka ep0 *****************************************************/
198 static void ffs_ep0_complete(struct usb_ep *ep, struct usb_request *req)
200 struct ffs_data *ffs = req->context;
202 complete_all(&ffs->ep0req_completion);
205 static int __ffs_ep0_queue_wait(struct ffs_data *ffs, char *data, size_t len)
207 struct usb_request *req = ffs->ep0req;
210 req->zero = len < le16_to_cpu(ffs->ev.setup.wLength);
212 spin_unlock_irq(&ffs->ev.waitq.lock);
218 * UDC layer requires to provide a buffer even for ZLP, but should
219 * not use it at all. Let's provide some poisoned pointer to catch
220 * possible bug in the driver.
222 if (req->buf == NULL)
223 req->buf = (void *)0xDEADBABE;
225 reinit_completion(&ffs->ep0req_completion);
227 ret = usb_ep_queue(ffs->gadget->ep0, req, GFP_ATOMIC);
228 if (unlikely(ret < 0))
231 ret = wait_for_completion_interruptible(&ffs->ep0req_completion);
233 usb_ep_dequeue(ffs->gadget->ep0, req);
237 ffs->setup_state = FFS_NO_SETUP;
238 return req->status ? req->status : req->actual;
241 static int __ffs_ep0_stall(struct ffs_data *ffs)
243 if (ffs->ev.can_stall) {
244 pr_vdebug("ep0 stall\n");
245 usb_ep_set_halt(ffs->gadget->ep0);
246 ffs->setup_state = FFS_NO_SETUP;
249 pr_debug("bogus ep0 stall!\n");
254 static ssize_t ffs_ep0_write(struct file *file, const char __user *buf,
255 size_t len, loff_t *ptr)
257 struct ffs_data *ffs = file->private_data;
263 /* Fast check if setup was canceled */
264 if (ffs_setup_state_clear_cancelled(ffs) == FFS_SETUP_CANCELLED)
268 ret = ffs_mutex_lock(&ffs->mutex, file->f_flags & O_NONBLOCK);
269 if (unlikely(ret < 0))
273 switch (ffs->state) {
274 case FFS_READ_DESCRIPTORS:
275 case FFS_READ_STRINGS:
277 if (unlikely(len < 16)) {
282 data = ffs_prepare_buffer(buf, len);
289 if (ffs->state == FFS_READ_DESCRIPTORS) {
290 pr_info("read descriptors\n");
291 ret = __ffs_data_got_descs(ffs, data, len);
292 if (unlikely(ret < 0))
295 ffs->state = FFS_READ_STRINGS;
298 pr_info("read strings\n");
299 ret = __ffs_data_got_strings(ffs, data, len);
300 if (unlikely(ret < 0))
303 ret = ffs_epfiles_create(ffs);
305 ffs->state = FFS_CLOSING;
309 ffs->state = FFS_ACTIVE;
310 mutex_unlock(&ffs->mutex);
312 ret = ffs_ready(ffs);
313 if (unlikely(ret < 0)) {
314 ffs->state = FFS_CLOSING;
318 set_bit(FFS_FL_CALL_CLOSED_CALLBACK, &ffs->flags);
326 * We're called from user space, we can use _irq
327 * rather then _irqsave
329 spin_lock_irq(&ffs->ev.waitq.lock);
330 switch (ffs_setup_state_clear_cancelled(ffs)) {
331 case FFS_SETUP_CANCELLED:
339 case FFS_SETUP_PENDING:
343 /* FFS_SETUP_PENDING */
344 if (!(ffs->ev.setup.bRequestType & USB_DIR_IN)) {
345 spin_unlock_irq(&ffs->ev.waitq.lock);
346 ret = __ffs_ep0_stall(ffs);
350 /* FFS_SETUP_PENDING and not stall */
351 len = min(len, (size_t)le16_to_cpu(ffs->ev.setup.wLength));
353 spin_unlock_irq(&ffs->ev.waitq.lock);
355 data = ffs_prepare_buffer(buf, len);
361 spin_lock_irq(&ffs->ev.waitq.lock);
364 * We are guaranteed to be still in FFS_ACTIVE state
365 * but the state of setup could have changed from
366 * FFS_SETUP_PENDING to FFS_SETUP_CANCELLED so we need
367 * to check for that. If that happened we copied data
368 * from user space in vain but it's unlikely.
370 * For sure we are not in FFS_NO_SETUP since this is
371 * the only place FFS_SETUP_PENDING -> FFS_NO_SETUP
372 * transition can be performed and it's protected by
375 if (ffs_setup_state_clear_cancelled(ffs) ==
376 FFS_SETUP_CANCELLED) {
379 spin_unlock_irq(&ffs->ev.waitq.lock);
381 /* unlocks spinlock */
382 ret = __ffs_ep0_queue_wait(ffs, data, len);
392 mutex_unlock(&ffs->mutex);
396 /* Called with ffs->ev.waitq.lock and ffs->mutex held, both released on exit. */
397 static ssize_t __ffs_ep0_read_events(struct ffs_data *ffs, char __user *buf,
401 * n cannot be bigger than ffs->ev.count, which cannot be bigger than
402 * size of ffs->ev.types array (which is four) so that's how much space
405 struct usb_functionfs_event events[ARRAY_SIZE(ffs->ev.types)];
406 const size_t size = n * sizeof *events;
409 memset(events, 0, size);
412 events[i].type = ffs->ev.types[i];
413 if (events[i].type == FUNCTIONFS_SETUP) {
414 events[i].u.setup = ffs->ev.setup;
415 ffs->setup_state = FFS_SETUP_PENDING;
421 memmove(ffs->ev.types, ffs->ev.types + n,
422 ffs->ev.count * sizeof *ffs->ev.types);
424 spin_unlock_irq(&ffs->ev.waitq.lock);
425 mutex_unlock(&ffs->mutex);
427 return unlikely(__copy_to_user(buf, events, size)) ? -EFAULT : size;
430 static ssize_t ffs_ep0_read(struct file *file, char __user *buf,
431 size_t len, loff_t *ptr)
433 struct ffs_data *ffs = file->private_data;
440 /* Fast check if setup was canceled */
441 if (ffs_setup_state_clear_cancelled(ffs) == FFS_SETUP_CANCELLED)
445 ret = ffs_mutex_lock(&ffs->mutex, file->f_flags & O_NONBLOCK);
446 if (unlikely(ret < 0))
450 if (ffs->state != FFS_ACTIVE) {
456 * We're called from user space, we can use _irq rather then
459 spin_lock_irq(&ffs->ev.waitq.lock);
461 switch (ffs_setup_state_clear_cancelled(ffs)) {
462 case FFS_SETUP_CANCELLED:
467 n = len / sizeof(struct usb_functionfs_event);
473 if ((file->f_flags & O_NONBLOCK) && !ffs->ev.count) {
478 if (wait_event_interruptible_exclusive_locked_irq(ffs->ev.waitq,
484 return __ffs_ep0_read_events(ffs, buf,
485 min(n, (size_t)ffs->ev.count));
487 case FFS_SETUP_PENDING:
488 if (ffs->ev.setup.bRequestType & USB_DIR_IN) {
489 spin_unlock_irq(&ffs->ev.waitq.lock);
490 ret = __ffs_ep0_stall(ffs);
494 len = min(len, (size_t)le16_to_cpu(ffs->ev.setup.wLength));
496 spin_unlock_irq(&ffs->ev.waitq.lock);
499 data = kmalloc(len, GFP_KERNEL);
500 if (unlikely(!data)) {
506 spin_lock_irq(&ffs->ev.waitq.lock);
508 /* See ffs_ep0_write() */
509 if (ffs_setup_state_clear_cancelled(ffs) ==
510 FFS_SETUP_CANCELLED) {
515 /* unlocks spinlock */
516 ret = __ffs_ep0_queue_wait(ffs, data, len);
517 if (likely(ret > 0) && unlikely(__copy_to_user(buf, data, len)))
526 spin_unlock_irq(&ffs->ev.waitq.lock);
528 mutex_unlock(&ffs->mutex);
533 static int ffs_ep0_open(struct inode *inode, struct file *file)
535 struct ffs_data *ffs = inode->i_private;
539 if (unlikely(ffs->state == FFS_CLOSING))
542 file->private_data = ffs;
543 ffs_data_opened(ffs);
548 static int ffs_ep0_release(struct inode *inode, struct file *file)
550 struct ffs_data *ffs = file->private_data;
554 ffs_data_closed(ffs);
559 static long ffs_ep0_ioctl(struct file *file, unsigned code, unsigned long value)
561 struct ffs_data *ffs = file->private_data;
562 struct usb_gadget *gadget = ffs->gadget;
567 if (code == FUNCTIONFS_INTERFACE_REVMAP) {
568 struct ffs_function *func = ffs->func;
569 ret = func ? ffs_func_revmap_intf(func, value) : -ENODEV;
570 } else if (gadget && gadget->ops->ioctl) {
571 ret = gadget->ops->ioctl(gadget, code, value);
579 static unsigned int ffs_ep0_poll(struct file *file, poll_table *wait)
581 struct ffs_data *ffs = file->private_data;
582 unsigned int mask = POLLWRNORM;
585 poll_wait(file, &ffs->ev.waitq, wait);
587 ret = ffs_mutex_lock(&ffs->mutex, file->f_flags & O_NONBLOCK);
588 if (unlikely(ret < 0))
591 switch (ffs->state) {
592 case FFS_READ_DESCRIPTORS:
593 case FFS_READ_STRINGS:
598 switch (ffs->setup_state) {
604 case FFS_SETUP_PENDING:
605 case FFS_SETUP_CANCELLED:
606 mask |= (POLLIN | POLLOUT);
611 case FFS_DEACTIVATED:
615 mutex_unlock(&ffs->mutex);
620 static const struct file_operations ffs_ep0_operations = {
623 .open = ffs_ep0_open,
624 .write = ffs_ep0_write,
625 .read = ffs_ep0_read,
626 .release = ffs_ep0_release,
627 .unlocked_ioctl = ffs_ep0_ioctl,
628 .poll = ffs_ep0_poll,
632 /* "Normal" endpoints operations ********************************************/
634 static void ffs_epfile_io_complete(struct usb_ep *_ep, struct usb_request *req)
637 if (likely(req->context)) {
638 struct ffs_ep *ep = _ep->driver_data;
639 ep->status = req->status ? req->status : req->actual;
640 complete(req->context);
644 static void ffs_user_copy_worker(struct work_struct *work)
646 struct ffs_io_data *io_data = container_of(work, struct ffs_io_data,
648 int ret = io_data->req->status ? io_data->req->status :
649 io_data->req->actual;
651 if (io_data->read && ret > 0) {
653 ret = copy_to_iter(io_data->buf, ret, &io_data->data);
654 if (iov_iter_count(&io_data->data))
656 unuse_mm(io_data->mm);
659 io_data->kiocb->ki_complete(io_data->kiocb, ret, ret);
661 if (io_data->ffs->ffs_eventfd &&
662 !(io_data->kiocb->ki_flags & IOCB_EVENTFD))
663 eventfd_signal(io_data->ffs->ffs_eventfd, 1);
665 usb_ep_free_request(io_data->ep, io_data->req);
667 io_data->kiocb->private = NULL;
669 kfree(io_data->to_free);
674 static void ffs_epfile_async_io_complete(struct usb_ep *_ep,
675 struct usb_request *req)
677 struct ffs_io_data *io_data = req->context;
681 INIT_WORK(&io_data->work, ffs_user_copy_worker);
682 schedule_work(&io_data->work);
685 static ssize_t ffs_epfile_io(struct file *file, struct ffs_io_data *io_data)
687 struct ffs_epfile *epfile = file->private_data;
690 ssize_t ret, data_len = -EINVAL;
693 /* Are we still active? */
694 if (WARN_ON(epfile->ffs->state != FFS_ACTIVE)) {
699 /* Wait for endpoint to be enabled */
702 if (file->f_flags & O_NONBLOCK) {
707 ret = wait_event_interruptible(epfile->wait, (ep = epfile->ep));
715 halt = (!io_data->read == !epfile->in);
716 if (halt && epfile->isoc) {
721 /* Allocate & copy */
724 * if we _do_ wait above, the epfile->ffs->gadget might be NULL
725 * before the waiting completes, so do not assign to 'gadget' earlier
727 struct usb_gadget *gadget = epfile->ffs->gadget;
730 spin_lock_irq(&epfile->ffs->eps_lock);
731 /* In the meantime, endpoint got disabled or changed. */
732 if (epfile->ep != ep) {
733 spin_unlock_irq(&epfile->ffs->eps_lock);
736 data_len = iov_iter_count(&io_data->data);
738 * Controller may require buffer size to be aligned to
739 * maxpacketsize of an out endpoint.
742 data_len = usb_ep_align_maybe(gadget, ep->ep, data_len);
743 spin_unlock_irq(&epfile->ffs->eps_lock);
745 data = kmalloc(data_len, GFP_KERNEL);
748 if (!io_data->read) {
749 copied = copy_from_iter(data, data_len, &io_data->data);
750 if (copied != data_len) {
757 /* We will be using request */
758 ret = ffs_mutex_lock(&epfile->mutex, file->f_flags & O_NONBLOCK);
762 spin_lock_irq(&epfile->ffs->eps_lock);
764 if (epfile->ep != ep) {
765 /* In the meantime, endpoint got disabled or changed. */
767 spin_unlock_irq(&epfile->ffs->eps_lock);
770 if (likely(epfile->ep == ep) && !WARN_ON(!ep->ep))
771 usb_ep_set_halt(ep->ep);
772 spin_unlock_irq(&epfile->ffs->eps_lock);
775 /* Fire the request */
776 struct usb_request *req;
779 * Sanity Check: even though data_len can't be used
780 * uninitialized at the time I write this comment, some
781 * compilers complain about this situation.
782 * In order to keep the code clean from warnings, data_len is
783 * being initialized to -EINVAL during its declaration, which
784 * means we can't rely on compiler anymore to warn no future
785 * changes won't result in data_len being used uninitialized.
786 * For such reason, we're adding this redundant sanity check
789 if (unlikely(data_len == -EINVAL)) {
790 WARN(1, "%s: data_len == -EINVAL\n", __func__);
796 req = usb_ep_alloc_request(ep->ep, GFP_KERNEL);
801 req->length = data_len;
804 io_data->ep = ep->ep;
806 io_data->ffs = epfile->ffs;
808 req->context = io_data;
809 req->complete = ffs_epfile_async_io_complete;
811 ret = usb_ep_queue(ep->ep, req, GFP_ATOMIC);
813 usb_ep_free_request(ep->ep, req);
818 spin_unlock_irq(&epfile->ffs->eps_lock);
820 DECLARE_COMPLETION_ONSTACK(done);
824 req->length = data_len;
826 req->context = &done;
827 req->complete = ffs_epfile_io_complete;
829 ret = usb_ep_queue(ep->ep, req, GFP_ATOMIC);
831 spin_unlock_irq(&epfile->ffs->eps_lock);
833 if (unlikely(ret < 0)) {
836 wait_for_completion_interruptible(&done))) {
838 usb_ep_dequeue(ep->ep, req);
841 * XXX We may end up silently droping data
842 * here. Since data_len (i.e. req->length) may
843 * be bigger than len (after being rounded up
844 * to maxpacketsize), we may end up with more
845 * data then user space has space for.
848 if (io_data->read && ret > 0) {
849 ret = copy_to_iter(data, ret, &io_data->data);
850 if (unlikely(iov_iter_count(&io_data->data)))
858 mutex_unlock(&epfile->mutex);
862 spin_unlock_irq(&epfile->ffs->eps_lock);
863 mutex_unlock(&epfile->mutex);
870 ffs_epfile_open(struct inode *inode, struct file *file)
872 struct ffs_epfile *epfile = inode->i_private;
876 if (WARN_ON(epfile->ffs->state != FFS_ACTIVE))
879 file->private_data = epfile;
880 ffs_data_opened(epfile->ffs);
885 static int ffs_aio_cancel(struct kiocb *kiocb)
887 struct ffs_io_data *io_data = kiocb->private;
888 struct ffs_epfile *epfile = kiocb->ki_filp->private_data;
893 spin_lock_irq(&epfile->ffs->eps_lock);
895 if (likely(io_data && io_data->ep && io_data->req))
896 value = usb_ep_dequeue(io_data->ep, io_data->req);
900 spin_unlock_irq(&epfile->ffs->eps_lock);
905 static ssize_t ffs_epfile_write_iter(struct kiocb *kiocb, struct iov_iter *from)
907 struct ffs_io_data io_data, *p = &io_data;
912 if (!is_sync_kiocb(kiocb)) {
913 p = kmalloc(sizeof(io_data), GFP_KERNEL);
928 kiocb_set_cancel_fn(kiocb, ffs_aio_cancel);
930 res = ffs_epfile_io(kiocb->ki_filp, p);
931 if (res == -EIOCBQUEUED)
940 static ssize_t ffs_epfile_read_iter(struct kiocb *kiocb, struct iov_iter *to)
942 struct ffs_io_data io_data, *p = &io_data;
947 if (!is_sync_kiocb(kiocb)) {
948 p = kmalloc(sizeof(io_data), GFP_KERNEL);
959 p->to_free = dup_iter(&p->data, to, GFP_KERNEL);
972 kiocb_set_cancel_fn(kiocb, ffs_aio_cancel);
974 res = ffs_epfile_io(kiocb->ki_filp, p);
975 if (res == -EIOCBQUEUED)
988 ffs_epfile_release(struct inode *inode, struct file *file)
990 struct ffs_epfile *epfile = inode->i_private;
994 ffs_data_closed(epfile->ffs);
999 static long ffs_epfile_ioctl(struct file *file, unsigned code,
1000 unsigned long value)
1002 struct ffs_epfile *epfile = file->private_data;
1007 if (WARN_ON(epfile->ffs->state != FFS_ACTIVE))
1010 spin_lock_irq(&epfile->ffs->eps_lock);
1011 if (likely(epfile->ep)) {
1013 case FUNCTIONFS_FIFO_STATUS:
1014 ret = usb_ep_fifo_status(epfile->ep->ep);
1016 case FUNCTIONFS_FIFO_FLUSH:
1017 usb_ep_fifo_flush(epfile->ep->ep);
1020 case FUNCTIONFS_CLEAR_HALT:
1021 ret = usb_ep_clear_halt(epfile->ep->ep);
1023 case FUNCTIONFS_ENDPOINT_REVMAP:
1024 ret = epfile->ep->num;
1026 case FUNCTIONFS_ENDPOINT_DESC:
1029 struct usb_endpoint_descriptor *desc;
1031 switch (epfile->ffs->gadget->speed) {
1032 case USB_SPEED_SUPER:
1035 case USB_SPEED_HIGH:
1041 desc = epfile->ep->descs[desc_idx];
1043 spin_unlock_irq(&epfile->ffs->eps_lock);
1044 ret = copy_to_user((void *)value, desc, sizeof(*desc));
1055 spin_unlock_irq(&epfile->ffs->eps_lock);
1060 static const struct file_operations ffs_epfile_operations = {
1061 .llseek = no_llseek,
1063 .open = ffs_epfile_open,
1064 .write_iter = ffs_epfile_write_iter,
1065 .read_iter = ffs_epfile_read_iter,
1066 .release = ffs_epfile_release,
1067 .unlocked_ioctl = ffs_epfile_ioctl,
1071 /* File system and super block operations ***********************************/
1074 * Mounting the file system creates a controller file, used first for
1075 * function configuration then later for event monitoring.
1078 static struct inode *__must_check
1079 ffs_sb_make_inode(struct super_block *sb, void *data,
1080 const struct file_operations *fops,
1081 const struct inode_operations *iops,
1082 struct ffs_file_perms *perms)
1084 struct inode *inode;
1088 inode = new_inode(sb);
1090 if (likely(inode)) {
1091 struct timespec current_time = CURRENT_TIME;
1093 inode->i_ino = get_next_ino();
1094 inode->i_mode = perms->mode;
1095 inode->i_uid = perms->uid;
1096 inode->i_gid = perms->gid;
1097 inode->i_atime = current_time;
1098 inode->i_mtime = current_time;
1099 inode->i_ctime = current_time;
1100 inode->i_private = data;
1102 inode->i_fop = fops;
1110 /* Create "regular" file */
1111 static struct dentry *ffs_sb_create_file(struct super_block *sb,
1112 const char *name, void *data,
1113 const struct file_operations *fops)
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);
1136 static const struct super_operations ffs_sb_operations = {
1137 .statfs = simple_statfs,
1138 .drop_inode = generic_delete_inode,
1141 struct ffs_sb_fill_data {
1142 struct ffs_file_perms perms;
1144 const char *dev_name;
1146 struct ffs_data *ffs_data;
1149 static int ffs_sb_fill(struct super_block *sb, void *_data, int silent)
1151 struct ffs_sb_fill_data *data = _data;
1152 struct inode *inode;
1153 struct ffs_data *ffs = data->ffs_data;
1158 data->ffs_data = NULL;
1159 sb->s_fs_info = ffs;
1160 sb->s_blocksize = PAGE_CACHE_SIZE;
1161 sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
1162 sb->s_magic = FUNCTIONFS_MAGIC;
1163 sb->s_op = &ffs_sb_operations;
1164 sb->s_time_gran = 1;
1167 data->perms.mode = data->root_mode;
1168 inode = ffs_sb_make_inode(sb, NULL,
1169 &simple_dir_operations,
1170 &simple_dir_inode_operations,
1172 sb->s_root = d_make_root(inode);
1173 if (unlikely(!sb->s_root))
1177 if (unlikely(!ffs_sb_create_file(sb, "ep0", ffs,
1178 &ffs_ep0_operations)))
1184 static int ffs_fs_parse_opts(struct ffs_sb_fill_data *data, char *opts)
1188 if (!opts || !*opts)
1192 unsigned long value;
1196 comma = strchr(opts, ',');
1201 eq = strchr(opts, '=');
1202 if (unlikely(!eq)) {
1203 pr_err("'=' missing in %s\n", opts);
1209 if (kstrtoul(eq + 1, 0, &value)) {
1210 pr_err("%s: invalid value: %s\n", opts, eq + 1);
1214 /* Interpret option */
1215 switch (eq - opts) {
1217 if (!memcmp(opts, "no_disconnect", 13))
1218 data->no_disconnect = !!value;
1223 if (!memcmp(opts, "rmode", 5))
1224 data->root_mode = (value & 0555) | S_IFDIR;
1225 else if (!memcmp(opts, "fmode", 5))
1226 data->perms.mode = (value & 0666) | S_IFREG;
1232 if (!memcmp(opts, "mode", 4)) {
1233 data->root_mode = (value & 0555) | S_IFDIR;
1234 data->perms.mode = (value & 0666) | S_IFREG;
1241 if (!memcmp(opts, "uid", 3)) {
1242 data->perms.uid = make_kuid(current_user_ns(), value);
1243 if (!uid_valid(data->perms.uid)) {
1244 pr_err("%s: unmapped value: %lu\n", opts, value);
1247 } else if (!memcmp(opts, "gid", 3)) {
1248 data->perms.gid = make_kgid(current_user_ns(), value);
1249 if (!gid_valid(data->perms.gid)) {
1250 pr_err("%s: unmapped value: %lu\n", opts, value);
1260 pr_err("%s: invalid option\n", opts);
1264 /* Next iteration */
1273 /* "mount -t functionfs dev_name /dev/function" ends up here */
1275 static struct dentry *
1276 ffs_fs_mount(struct file_system_type *t, int flags,
1277 const char *dev_name, void *opts)
1279 struct ffs_sb_fill_data data = {
1281 .mode = S_IFREG | 0600,
1282 .uid = GLOBAL_ROOT_UID,
1283 .gid = GLOBAL_ROOT_GID,
1285 .root_mode = S_IFDIR | 0500,
1286 .no_disconnect = false,
1291 struct ffs_data *ffs;
1295 ret = ffs_fs_parse_opts(&data, opts);
1296 if (unlikely(ret < 0))
1297 return ERR_PTR(ret);
1299 ffs = ffs_data_new();
1301 return ERR_PTR(-ENOMEM);
1302 ffs->file_perms = data.perms;
1303 ffs->no_disconnect = data.no_disconnect;
1305 ffs->dev_name = kstrdup(dev_name, GFP_KERNEL);
1306 if (unlikely(!ffs->dev_name)) {
1308 return ERR_PTR(-ENOMEM);
1311 ffs_dev = ffs_acquire_dev(dev_name);
1312 if (IS_ERR(ffs_dev)) {
1314 return ERR_CAST(ffs_dev);
1316 ffs->private_data = ffs_dev;
1317 data.ffs_data = ffs;
1319 rv = mount_nodev(t, flags, &data, ffs_sb_fill);
1320 if (IS_ERR(rv) && data.ffs_data) {
1321 ffs_release_dev(data.ffs_data);
1322 ffs_data_put(data.ffs_data);
1328 ffs_fs_kill_sb(struct super_block *sb)
1332 kill_litter_super(sb);
1333 if (sb->s_fs_info) {
1334 ffs_release_dev(sb->s_fs_info);
1335 ffs_data_closed(sb->s_fs_info);
1336 ffs_data_put(sb->s_fs_info);
1340 static struct file_system_type ffs_fs_type = {
1341 .owner = THIS_MODULE,
1342 .name = "functionfs",
1343 .mount = ffs_fs_mount,
1344 .kill_sb = ffs_fs_kill_sb,
1346 MODULE_ALIAS_FS("functionfs");
1349 /* Driver's main init/cleanup functions *************************************/
1351 static int functionfs_init(void)
1357 ret = register_filesystem(&ffs_fs_type);
1359 pr_info("file system registered\n");
1361 pr_err("failed registering file system (%d)\n", ret);
1366 static void functionfs_cleanup(void)
1370 pr_info("unloading\n");
1371 unregister_filesystem(&ffs_fs_type);
1375 /* ffs_data and ffs_function construction and destruction code **************/
1377 static void ffs_data_clear(struct ffs_data *ffs);
1378 static void ffs_data_reset(struct ffs_data *ffs);
1380 static void ffs_data_get(struct ffs_data *ffs)
1384 atomic_inc(&ffs->ref);
1387 static void ffs_data_opened(struct ffs_data *ffs)
1391 atomic_inc(&ffs->ref);
1392 if (atomic_add_return(1, &ffs->opened) == 1 &&
1393 ffs->state == FFS_DEACTIVATED) {
1394 ffs->state = FFS_CLOSING;
1395 ffs_data_reset(ffs);
1399 static void ffs_data_put(struct ffs_data *ffs)
1403 if (unlikely(atomic_dec_and_test(&ffs->ref))) {
1404 pr_info("%s(): freeing\n", __func__);
1405 ffs_data_clear(ffs);
1406 BUG_ON(waitqueue_active(&ffs->ev.waitq) ||
1407 waitqueue_active(&ffs->ep0req_completion.wait));
1408 kfree(ffs->dev_name);
1413 static void ffs_data_closed(struct ffs_data *ffs)
1417 if (atomic_dec_and_test(&ffs->opened)) {
1418 if (ffs->no_disconnect) {
1419 ffs->state = FFS_DEACTIVATED;
1421 ffs_epfiles_destroy(ffs->epfiles,
1423 ffs->epfiles = NULL;
1425 if (ffs->setup_state == FFS_SETUP_PENDING)
1426 __ffs_ep0_stall(ffs);
1428 ffs->state = FFS_CLOSING;
1429 ffs_data_reset(ffs);
1432 if (atomic_read(&ffs->opened) < 0) {
1433 ffs->state = FFS_CLOSING;
1434 ffs_data_reset(ffs);
1440 static struct ffs_data *ffs_data_new(void)
1442 struct ffs_data *ffs = kzalloc(sizeof *ffs, GFP_KERNEL);
1448 atomic_set(&ffs->ref, 1);
1449 atomic_set(&ffs->opened, 0);
1450 ffs->state = FFS_READ_DESCRIPTORS;
1451 mutex_init(&ffs->mutex);
1452 spin_lock_init(&ffs->eps_lock);
1453 init_waitqueue_head(&ffs->ev.waitq);
1454 init_completion(&ffs->ep0req_completion);
1456 /* XXX REVISIT need to update it in some places, or do we? */
1457 ffs->ev.can_stall = 1;
1462 static void ffs_data_clear(struct ffs_data *ffs)
1466 if (test_and_clear_bit(FFS_FL_CALL_CLOSED_CALLBACK, &ffs->flags))
1469 BUG_ON(ffs->gadget);
1472 ffs_epfiles_destroy(ffs->epfiles, ffs->eps_count);
1474 if (ffs->ffs_eventfd)
1475 eventfd_ctx_put(ffs->ffs_eventfd);
1477 kfree(ffs->raw_descs_data);
1478 kfree(ffs->raw_strings);
1479 kfree(ffs->stringtabs);
1482 static void ffs_data_reset(struct ffs_data *ffs)
1486 ffs_data_clear(ffs);
1488 ffs->epfiles = NULL;
1489 ffs->raw_descs_data = NULL;
1490 ffs->raw_descs = NULL;
1491 ffs->raw_strings = NULL;
1492 ffs->stringtabs = NULL;
1494 ffs->raw_descs_length = 0;
1495 ffs->fs_descs_count = 0;
1496 ffs->hs_descs_count = 0;
1497 ffs->ss_descs_count = 0;
1499 ffs->strings_count = 0;
1500 ffs->interfaces_count = 0;
1505 ffs->state = FFS_READ_DESCRIPTORS;
1506 ffs->setup_state = FFS_NO_SETUP;
1511 static int functionfs_bind(struct ffs_data *ffs, struct usb_composite_dev *cdev)
1513 struct usb_gadget_strings **lang;
1518 if (WARN_ON(ffs->state != FFS_ACTIVE
1519 || test_and_set_bit(FFS_FL_BOUND, &ffs->flags)))
1522 first_id = usb_string_ids_n(cdev, ffs->strings_count);
1523 if (unlikely(first_id < 0))
1526 ffs->ep0req = usb_ep_alloc_request(cdev->gadget->ep0, GFP_KERNEL);
1527 if (unlikely(!ffs->ep0req))
1529 ffs->ep0req->complete = ffs_ep0_complete;
1530 ffs->ep0req->context = ffs;
1532 lang = ffs->stringtabs;
1534 for (; *lang; ++lang) {
1535 struct usb_string *str = (*lang)->strings;
1537 for (; str->s; ++id, ++str)
1542 ffs->gadget = cdev->gadget;
1547 static void functionfs_unbind(struct ffs_data *ffs)
1551 if (!WARN_ON(!ffs->gadget)) {
1552 usb_ep_free_request(ffs->gadget->ep0, ffs->ep0req);
1555 clear_bit(FFS_FL_BOUND, &ffs->flags);
1560 static int ffs_epfiles_create(struct ffs_data *ffs)
1562 struct ffs_epfile *epfile, *epfiles;
1567 count = ffs->eps_count;
1568 epfiles = kcalloc(count, sizeof(*epfiles), GFP_KERNEL);
1573 for (i = 1; i <= count; ++i, ++epfile) {
1575 mutex_init(&epfile->mutex);
1576 init_waitqueue_head(&epfile->wait);
1577 if (ffs->user_flags & FUNCTIONFS_VIRTUAL_ADDR)
1578 sprintf(epfile->name, "ep%02x", ffs->eps_addrmap[i]);
1580 sprintf(epfile->name, "ep%u", i);
1581 epfile->dentry = ffs_sb_create_file(ffs->sb, epfile->name,
1583 &ffs_epfile_operations);
1584 if (unlikely(!epfile->dentry)) {
1585 ffs_epfiles_destroy(epfiles, i - 1);
1590 ffs->epfiles = epfiles;
1594 static void ffs_epfiles_destroy(struct ffs_epfile *epfiles, unsigned count)
1596 struct ffs_epfile *epfile = epfiles;
1600 for (; count; --count, ++epfile) {
1601 BUG_ON(mutex_is_locked(&epfile->mutex) ||
1602 waitqueue_active(&epfile->wait));
1603 if (epfile->dentry) {
1604 d_delete(epfile->dentry);
1605 dput(epfile->dentry);
1606 epfile->dentry = NULL;
1613 static void ffs_func_eps_disable(struct ffs_function *func)
1615 struct ffs_ep *ep = func->eps;
1616 struct ffs_epfile *epfile = func->ffs->epfiles;
1617 unsigned count = func->ffs->eps_count;
1618 unsigned long flags;
1620 spin_lock_irqsave(&func->ffs->eps_lock, flags);
1622 /* pending requests get nuked */
1624 usb_ep_disable(ep->ep);
1632 spin_unlock_irqrestore(&func->ffs->eps_lock, flags);
1635 static int ffs_func_eps_enable(struct ffs_function *func)
1637 struct ffs_data *ffs = func->ffs;
1638 struct ffs_ep *ep = func->eps;
1639 struct ffs_epfile *epfile = ffs->epfiles;
1640 unsigned count = ffs->eps_count;
1641 unsigned long flags;
1644 spin_lock_irqsave(&func->ffs->eps_lock, flags);
1646 struct usb_endpoint_descriptor *ds;
1649 if (ffs->gadget->speed == USB_SPEED_SUPER)
1651 else if (ffs->gadget->speed == USB_SPEED_HIGH)
1656 /* fall-back to lower speed if desc missing for current speed */
1658 ds = ep->descs[desc_idx];
1659 } while (!ds && --desc_idx >= 0);
1666 ep->ep->driver_data = ep;
1668 ret = usb_ep_enable(ep->ep);
1671 epfile->in = usb_endpoint_dir_in(ds);
1672 epfile->isoc = usb_endpoint_xfer_isoc(ds);
1677 wake_up(&epfile->wait);
1682 spin_unlock_irqrestore(&func->ffs->eps_lock, flags);
1688 /* Parsing and building descriptors and strings *****************************/
1691 * This validates if data pointed by data is a valid USB descriptor as
1692 * well as record how many interfaces, endpoints and strings are
1693 * required by given configuration. Returns address after the
1694 * descriptor or NULL if data is invalid.
1697 enum ffs_entity_type {
1698 FFS_DESCRIPTOR, FFS_INTERFACE, FFS_STRING, FFS_ENDPOINT
1701 enum ffs_os_desc_type {
1702 FFS_OS_DESC, FFS_OS_DESC_EXT_COMPAT, FFS_OS_DESC_EXT_PROP
1705 typedef int (*ffs_entity_callback)(enum ffs_entity_type entity,
1707 struct usb_descriptor_header *desc,
1710 typedef int (*ffs_os_desc_callback)(enum ffs_os_desc_type entity,
1711 struct usb_os_desc_header *h, void *data,
1712 unsigned len, void *priv);
1714 static int __must_check ffs_do_single_desc(char *data, unsigned len,
1715 ffs_entity_callback entity,
1718 struct usb_descriptor_header *_ds = (void *)data;
1724 /* At least two bytes are required: length and type */
1726 pr_vdebug("descriptor too short\n");
1730 /* If we have at least as many bytes as the descriptor takes? */
1731 length = _ds->bLength;
1733 pr_vdebug("descriptor longer then available data\n");
1737 #define __entity_check_INTERFACE(val) 1
1738 #define __entity_check_STRING(val) (val)
1739 #define __entity_check_ENDPOINT(val) ((val) & USB_ENDPOINT_NUMBER_MASK)
1740 #define __entity(type, val) do { \
1741 pr_vdebug("entity " #type "(%02x)\n", (val)); \
1742 if (unlikely(!__entity_check_ ##type(val))) { \
1743 pr_vdebug("invalid entity's value\n"); \
1746 ret = entity(FFS_ ##type, &val, _ds, priv); \
1747 if (unlikely(ret < 0)) { \
1748 pr_debug("entity " #type "(%02x); ret = %d\n", \
1754 /* Parse descriptor depending on type. */
1755 switch (_ds->bDescriptorType) {
1759 case USB_DT_DEVICE_QUALIFIER:
1760 /* function can't have any of those */
1761 pr_vdebug("descriptor reserved for gadget: %d\n",
1762 _ds->bDescriptorType);
1765 case USB_DT_INTERFACE: {
1766 struct usb_interface_descriptor *ds = (void *)_ds;
1767 pr_vdebug("interface descriptor\n");
1768 if (length != sizeof *ds)
1771 __entity(INTERFACE, ds->bInterfaceNumber);
1773 __entity(STRING, ds->iInterface);
1777 case USB_DT_ENDPOINT: {
1778 struct usb_endpoint_descriptor *ds = (void *)_ds;
1779 pr_vdebug("endpoint descriptor\n");
1780 if (length != USB_DT_ENDPOINT_SIZE &&
1781 length != USB_DT_ENDPOINT_AUDIO_SIZE)
1783 __entity(ENDPOINT, ds->bEndpointAddress);
1788 pr_vdebug("hid descriptor\n");
1789 if (length != sizeof(struct hid_descriptor))
1794 if (length != sizeof(struct usb_otg_descriptor))
1798 case USB_DT_INTERFACE_ASSOCIATION: {
1799 struct usb_interface_assoc_descriptor *ds = (void *)_ds;
1800 pr_vdebug("interface association descriptor\n");
1801 if (length != sizeof *ds)
1804 __entity(STRING, ds->iFunction);
1808 case USB_DT_SS_ENDPOINT_COMP:
1809 pr_vdebug("EP SS companion descriptor\n");
1810 if (length != sizeof(struct usb_ss_ep_comp_descriptor))
1814 case USB_DT_OTHER_SPEED_CONFIG:
1815 case USB_DT_INTERFACE_POWER:
1817 case USB_DT_SECURITY:
1818 case USB_DT_CS_RADIO_CONTROL:
1820 pr_vdebug("unimplemented descriptor: %d\n", _ds->bDescriptorType);
1824 /* We should never be here */
1825 pr_vdebug("unknown descriptor: %d\n", _ds->bDescriptorType);
1829 pr_vdebug("invalid length: %d (descriptor %d)\n",
1830 _ds->bLength, _ds->bDescriptorType);
1835 #undef __entity_check_DESCRIPTOR
1836 #undef __entity_check_INTERFACE
1837 #undef __entity_check_STRING
1838 #undef __entity_check_ENDPOINT
1843 static int __must_check ffs_do_descs(unsigned count, char *data, unsigned len,
1844 ffs_entity_callback entity, void *priv)
1846 const unsigned _len = len;
1847 unsigned long num = 0;
1857 /* Record "descriptor" entity */
1858 ret = entity(FFS_DESCRIPTOR, (u8 *)num, (void *)data, priv);
1859 if (unlikely(ret < 0)) {
1860 pr_debug("entity DESCRIPTOR(%02lx); ret = %d\n",
1868 ret = ffs_do_single_desc(data, len, entity, priv);
1869 if (unlikely(ret < 0)) {
1870 pr_debug("%s returns %d\n", __func__, ret);
1880 static int __ffs_data_do_entity(enum ffs_entity_type type,
1881 u8 *valuep, struct usb_descriptor_header *desc,
1884 struct ffs_desc_helper *helper = priv;
1885 struct usb_endpoint_descriptor *d;
1890 case FFS_DESCRIPTOR:
1895 * Interfaces are indexed from zero so if we
1896 * encountered interface "n" then there are at least
1899 if (*valuep >= helper->interfaces_count)
1900 helper->interfaces_count = *valuep + 1;
1905 * Strings are indexed from 1 (0 is magic ;) reserved
1906 * for languages list or some such)
1908 if (*valuep > helper->ffs->strings_count)
1909 helper->ffs->strings_count = *valuep;
1914 helper->eps_count++;
1915 if (helper->eps_count >= 15)
1917 /* Check if descriptors for any speed were already parsed */
1918 if (!helper->ffs->eps_count && !helper->ffs->interfaces_count)
1919 helper->ffs->eps_addrmap[helper->eps_count] =
1920 d->bEndpointAddress;
1921 else if (helper->ffs->eps_addrmap[helper->eps_count] !=
1922 d->bEndpointAddress)
1930 static int __ffs_do_os_desc_header(enum ffs_os_desc_type *next_type,
1931 struct usb_os_desc_header *desc)
1933 u16 bcd_version = le16_to_cpu(desc->bcdVersion);
1934 u16 w_index = le16_to_cpu(desc->wIndex);
1936 if (bcd_version != 1) {
1937 pr_vdebug("unsupported os descriptors version: %d",
1943 *next_type = FFS_OS_DESC_EXT_COMPAT;
1946 *next_type = FFS_OS_DESC_EXT_PROP;
1949 pr_vdebug("unsupported os descriptor type: %d", w_index);
1953 return sizeof(*desc);
1957 * Process all extended compatibility/extended property descriptors
1958 * of a feature descriptor
1960 static int __must_check ffs_do_single_os_desc(char *data, unsigned len,
1961 enum ffs_os_desc_type type,
1963 ffs_os_desc_callback entity,
1965 struct usb_os_desc_header *h)
1968 const unsigned _len = len;
1972 /* loop over all ext compat/ext prop descriptors */
1973 while (feature_count--) {
1974 ret = entity(type, h, data, len, priv);
1975 if (unlikely(ret < 0)) {
1976 pr_debug("bad OS descriptor, type: %d\n", type);
1985 /* Process a number of complete Feature Descriptors (Ext Compat or Ext Prop) */
1986 static int __must_check ffs_do_os_descs(unsigned count,
1987 char *data, unsigned len,
1988 ffs_os_desc_callback entity, void *priv)
1990 const unsigned _len = len;
1991 unsigned long num = 0;
1995 for (num = 0; num < count; ++num) {
1997 enum ffs_os_desc_type type;
1999 struct usb_os_desc_header *desc = (void *)data;
2001 if (len < sizeof(*desc))
2005 * Record "descriptor" entity.
2006 * Process dwLength, bcdVersion, wIndex, get b/wCount.
2007 * Move the data pointer to the beginning of extended
2008 * compatibilities proper or extended properties proper
2009 * portions of the data
2011 if (le32_to_cpu(desc->dwLength) > len)
2014 ret = __ffs_do_os_desc_header(&type, desc);
2015 if (unlikely(ret < 0)) {
2016 pr_debug("entity OS_DESCRIPTOR(%02lx); ret = %d\n",
2021 * 16-bit hex "?? 00" Little Endian looks like 8-bit hex "??"
2023 feature_count = le16_to_cpu(desc->wCount);
2024 if (type == FFS_OS_DESC_EXT_COMPAT &&
2025 (feature_count > 255 || desc->Reserved))
2031 * Process all function/property descriptors
2032 * of this Feature Descriptor
2034 ret = ffs_do_single_os_desc(data, len, type,
2035 feature_count, entity, priv, desc);
2036 if (unlikely(ret < 0)) {
2037 pr_debug("%s returns %d\n", __func__, ret);
2048 * Validate contents of the buffer from userspace related to OS descriptors.
2050 static int __ffs_data_do_os_desc(enum ffs_os_desc_type type,
2051 struct usb_os_desc_header *h, void *data,
2052 unsigned len, void *priv)
2054 struct ffs_data *ffs = priv;
2060 case FFS_OS_DESC_EXT_COMPAT: {
2061 struct usb_ext_compat_desc *d = data;
2064 if (len < sizeof(*d) ||
2065 d->bFirstInterfaceNumber >= ffs->interfaces_count ||
2068 for (i = 0; i < ARRAY_SIZE(d->Reserved2); ++i)
2069 if (d->Reserved2[i])
2072 length = sizeof(struct usb_ext_compat_desc);
2075 case FFS_OS_DESC_EXT_PROP: {
2076 struct usb_ext_prop_desc *d = data;
2080 if (len < sizeof(*d) || h->interface >= ffs->interfaces_count)
2082 length = le32_to_cpu(d->dwSize);
2083 type = le32_to_cpu(d->dwPropertyDataType);
2084 if (type < USB_EXT_PROP_UNICODE ||
2085 type > USB_EXT_PROP_UNICODE_MULTI) {
2086 pr_vdebug("unsupported os descriptor property type: %d",
2090 pnl = le16_to_cpu(d->wPropertyNameLength);
2091 pdl = le32_to_cpu(*(u32 *)((u8 *)data + 10 + pnl));
2092 if (length != 14 + pnl + pdl) {
2093 pr_vdebug("invalid os descriptor length: %d pnl:%d pdl:%d (descriptor %d)\n",
2094 length, pnl, pdl, type);
2097 ++ffs->ms_os_descs_ext_prop_count;
2098 /* property name reported to the host as "WCHAR"s */
2099 ffs->ms_os_descs_ext_prop_name_len += pnl * 2;
2100 ffs->ms_os_descs_ext_prop_data_len += pdl;
2104 pr_vdebug("unknown descriptor: %d\n", type);
2110 static int __ffs_data_got_descs(struct ffs_data *ffs,
2111 char *const _data, size_t len)
2113 char *data = _data, *raw_descs;
2114 unsigned os_descs_count = 0, counts[3], flags;
2115 int ret = -EINVAL, i;
2116 struct ffs_desc_helper helper;
2120 if (get_unaligned_le32(data + 4) != len)
2123 switch (get_unaligned_le32(data)) {
2124 case FUNCTIONFS_DESCRIPTORS_MAGIC:
2125 flags = FUNCTIONFS_HAS_FS_DESC | FUNCTIONFS_HAS_HS_DESC;
2129 case FUNCTIONFS_DESCRIPTORS_MAGIC_V2:
2130 flags = get_unaligned_le32(data + 8);
2131 ffs->user_flags = flags;
2132 if (flags & ~(FUNCTIONFS_HAS_FS_DESC |
2133 FUNCTIONFS_HAS_HS_DESC |
2134 FUNCTIONFS_HAS_SS_DESC |
2135 FUNCTIONFS_HAS_MS_OS_DESC |
2136 FUNCTIONFS_VIRTUAL_ADDR |
2137 FUNCTIONFS_EVENTFD)) {
2148 if (flags & FUNCTIONFS_EVENTFD) {
2152 eventfd_ctx_fdget((int)get_unaligned_le32(data));
2153 if (IS_ERR(ffs->ffs_eventfd)) {
2154 ret = PTR_ERR(ffs->ffs_eventfd);
2155 ffs->ffs_eventfd = NULL;
2162 /* Read fs_count, hs_count and ss_count (if present) */
2163 for (i = 0; i < 3; ++i) {
2164 if (!(flags & (1 << i))) {
2166 } else if (len < 4) {
2169 counts[i] = get_unaligned_le32(data);
2174 if (flags & (1 << i)) {
2175 os_descs_count = get_unaligned_le32(data);
2180 /* Read descriptors */
2183 for (i = 0; i < 3; ++i) {
2186 helper.interfaces_count = 0;
2187 helper.eps_count = 0;
2188 ret = ffs_do_descs(counts[i], data, len,
2189 __ffs_data_do_entity, &helper);
2192 if (!ffs->eps_count && !ffs->interfaces_count) {
2193 ffs->eps_count = helper.eps_count;
2194 ffs->interfaces_count = helper.interfaces_count;
2196 if (ffs->eps_count != helper.eps_count) {
2200 if (ffs->interfaces_count != helper.interfaces_count) {
2208 if (os_descs_count) {
2209 ret = ffs_do_os_descs(os_descs_count, data, len,
2210 __ffs_data_do_os_desc, ffs);
2217 if (raw_descs == data || len) {
2222 ffs->raw_descs_data = _data;
2223 ffs->raw_descs = raw_descs;
2224 ffs->raw_descs_length = data - raw_descs;
2225 ffs->fs_descs_count = counts[0];
2226 ffs->hs_descs_count = counts[1];
2227 ffs->ss_descs_count = counts[2];
2228 ffs->ms_os_descs_count = os_descs_count;
2237 static int __ffs_data_got_strings(struct ffs_data *ffs,
2238 char *const _data, size_t len)
2240 u32 str_count, needed_count, lang_count;
2241 struct usb_gadget_strings **stringtabs, *t;
2242 struct usb_string *strings, *s;
2243 const char *data = _data;
2247 if (unlikely(get_unaligned_le32(data) != FUNCTIONFS_STRINGS_MAGIC ||
2248 get_unaligned_le32(data + 4) != len))
2250 str_count = get_unaligned_le32(data + 8);
2251 lang_count = get_unaligned_le32(data + 12);
2253 /* if one is zero the other must be zero */
2254 if (unlikely(!str_count != !lang_count))
2257 /* Do we have at least as many strings as descriptors need? */
2258 needed_count = ffs->strings_count;
2259 if (unlikely(str_count < needed_count))
2263 * If we don't need any strings just return and free all
2266 if (!needed_count) {
2271 /* Allocate everything in one chunk so there's less maintenance. */
2275 vla_item(d, struct usb_gadget_strings *, stringtabs,
2277 vla_item(d, struct usb_gadget_strings, stringtab, lang_count);
2278 vla_item(d, struct usb_string, strings,
2279 lang_count*(needed_count+1));
2281 char *vlabuf = kmalloc(vla_group_size(d), GFP_KERNEL);
2283 if (unlikely(!vlabuf)) {
2288 /* Initialize the VLA pointers */
2289 stringtabs = vla_ptr(vlabuf, d, stringtabs);
2290 t = vla_ptr(vlabuf, d, stringtab);
2293 *stringtabs++ = t++;
2297 /* stringtabs = vlabuf = d_stringtabs for later kfree */
2298 stringtabs = vla_ptr(vlabuf, d, stringtabs);
2299 t = vla_ptr(vlabuf, d, stringtab);
2300 s = vla_ptr(vlabuf, d, strings);
2304 /* For each language */
2308 do { /* lang_count > 0 so we can use do-while */
2309 unsigned needed = needed_count;
2311 if (unlikely(len < 3))
2313 t->language = get_unaligned_le16(data);
2320 /* For each string */
2321 do { /* str_count > 0 so we can use do-while */
2322 size_t length = strnlen(data, len);
2324 if (unlikely(length == len))
2328 * User may provide more strings then we need,
2329 * if that's the case we simply ignore the
2332 if (likely(needed)) {
2334 * s->id will be set while adding
2335 * function to configuration so for
2336 * now just leave garbage here.
2345 } while (--str_count);
2347 s->id = 0; /* terminator */
2351 } while (--lang_count);
2353 /* Some garbage left? */
2358 ffs->stringtabs = stringtabs;
2359 ffs->raw_strings = _data;
2371 /* Events handling and management *******************************************/
2373 static void __ffs_event_add(struct ffs_data *ffs,
2374 enum usb_functionfs_event_type type)
2376 enum usb_functionfs_event_type rem_type1, rem_type2 = type;
2380 * Abort any unhandled setup
2382 * We do not need to worry about some cmpxchg() changing value
2383 * of ffs->setup_state without holding the lock because when
2384 * state is FFS_SETUP_PENDING cmpxchg() in several places in
2385 * the source does nothing.
2387 if (ffs->setup_state == FFS_SETUP_PENDING)
2388 ffs->setup_state = FFS_SETUP_CANCELLED;
2391 * Logic of this function guarantees that there are at most four pending
2392 * evens on ffs->ev.types queue. This is important because the queue
2393 * has space for four elements only and __ffs_ep0_read_events function
2394 * depends on that limit as well. If more event types are added, those
2395 * limits have to be revisited or guaranteed to still hold.
2398 case FUNCTIONFS_RESUME:
2399 rem_type2 = FUNCTIONFS_SUSPEND;
2401 case FUNCTIONFS_SUSPEND:
2402 case FUNCTIONFS_SETUP:
2404 /* Discard all similar events */
2407 case FUNCTIONFS_BIND:
2408 case FUNCTIONFS_UNBIND:
2409 case FUNCTIONFS_DISABLE:
2410 case FUNCTIONFS_ENABLE:
2411 /* Discard everything other then power management. */
2412 rem_type1 = FUNCTIONFS_SUSPEND;
2413 rem_type2 = FUNCTIONFS_RESUME;
2418 WARN(1, "%d: unknown event, this should not happen\n", type);
2423 u8 *ev = ffs->ev.types, *out = ev;
2424 unsigned n = ffs->ev.count;
2425 for (; n; --n, ++ev)
2426 if ((*ev == rem_type1 || *ev == rem_type2) == neg)
2429 pr_vdebug("purging event %d\n", *ev);
2430 ffs->ev.count = out - ffs->ev.types;
2433 pr_vdebug("adding event %d\n", type);
2434 ffs->ev.types[ffs->ev.count++] = type;
2435 wake_up_locked(&ffs->ev.waitq);
2436 if (ffs->ffs_eventfd)
2437 eventfd_signal(ffs->ffs_eventfd, 1);
2440 static void ffs_event_add(struct ffs_data *ffs,
2441 enum usb_functionfs_event_type type)
2443 unsigned long flags;
2444 spin_lock_irqsave(&ffs->ev.waitq.lock, flags);
2445 __ffs_event_add(ffs, type);
2446 spin_unlock_irqrestore(&ffs->ev.waitq.lock, flags);
2449 /* Bind/unbind USB function hooks *******************************************/
2451 static int ffs_ep_addr2idx(struct ffs_data *ffs, u8 endpoint_address)
2455 for (i = 1; i < ARRAY_SIZE(ffs->eps_addrmap); ++i)
2456 if (ffs->eps_addrmap[i] == endpoint_address)
2461 static int __ffs_func_bind_do_descs(enum ffs_entity_type type, u8 *valuep,
2462 struct usb_descriptor_header *desc,
2465 struct usb_endpoint_descriptor *ds = (void *)desc;
2466 struct ffs_function *func = priv;
2467 struct ffs_ep *ffs_ep;
2468 unsigned ep_desc_id;
2470 static const char *speed_names[] = { "full", "high", "super" };
2472 if (type != FFS_DESCRIPTOR)
2476 * If ss_descriptors is not NULL, we are reading super speed
2477 * descriptors; if hs_descriptors is not NULL, we are reading high
2478 * speed descriptors; otherwise, we are reading full speed
2481 if (func->function.ss_descriptors) {
2483 func->function.ss_descriptors[(long)valuep] = desc;
2484 } else if (func->function.hs_descriptors) {
2486 func->function.hs_descriptors[(long)valuep] = desc;
2489 func->function.fs_descriptors[(long)valuep] = desc;
2492 if (!desc || desc->bDescriptorType != USB_DT_ENDPOINT)
2495 idx = ffs_ep_addr2idx(func->ffs, ds->bEndpointAddress) - 1;
2499 ffs_ep = func->eps + idx;
2501 if (unlikely(ffs_ep->descs[ep_desc_id])) {
2502 pr_err("two %sspeed descriptors for EP %d\n",
2503 speed_names[ep_desc_id],
2504 ds->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
2507 ffs_ep->descs[ep_desc_id] = ds;
2509 ffs_dump_mem(": Original ep desc", ds, ds->bLength);
2511 ds->bEndpointAddress = ffs_ep->descs[0]->bEndpointAddress;
2512 if (!ds->wMaxPacketSize)
2513 ds->wMaxPacketSize = ffs_ep->descs[0]->wMaxPacketSize;
2515 struct usb_request *req;
2517 u8 bEndpointAddress;
2520 * We back up bEndpointAddress because autoconfig overwrites
2521 * it with physical endpoint address.
2523 bEndpointAddress = ds->bEndpointAddress;
2524 pr_vdebug("autoconfig\n");
2525 ep = usb_ep_autoconfig(func->gadget, ds);
2528 ep->driver_data = func->eps + idx;
2530 req = usb_ep_alloc_request(ep, GFP_KERNEL);
2536 func->eps_revmap[ds->bEndpointAddress &
2537 USB_ENDPOINT_NUMBER_MASK] = idx + 1;
2539 * If we use virtual address mapping, we restore
2540 * original bEndpointAddress value.
2542 if (func->ffs->user_flags & FUNCTIONFS_VIRTUAL_ADDR)
2543 ds->bEndpointAddress = bEndpointAddress;
2545 ffs_dump_mem(": Rewritten ep desc", ds, ds->bLength);
2550 static int __ffs_func_bind_do_nums(enum ffs_entity_type type, u8 *valuep,
2551 struct usb_descriptor_header *desc,
2554 struct ffs_function *func = priv;
2560 case FFS_DESCRIPTOR:
2561 /* Handled in previous pass by __ffs_func_bind_do_descs() */
2566 if (func->interfaces_nums[idx] < 0) {
2567 int id = usb_interface_id(func->conf, &func->function);
2568 if (unlikely(id < 0))
2570 func->interfaces_nums[idx] = id;
2572 newValue = func->interfaces_nums[idx];
2576 /* String' IDs are allocated when fsf_data is bound to cdev */
2577 newValue = func->ffs->stringtabs[0]->strings[*valuep - 1].id;
2582 * USB_DT_ENDPOINT are handled in
2583 * __ffs_func_bind_do_descs().
2585 if (desc->bDescriptorType == USB_DT_ENDPOINT)
2588 idx = (*valuep & USB_ENDPOINT_NUMBER_MASK) - 1;
2589 if (unlikely(!func->eps[idx].ep))
2593 struct usb_endpoint_descriptor **descs;
2594 descs = func->eps[idx].descs;
2595 newValue = descs[descs[0] ? 0 : 1]->bEndpointAddress;
2600 pr_vdebug("%02x -> %02x\n", *valuep, newValue);
2605 static int __ffs_func_bind_do_os_desc(enum ffs_os_desc_type type,
2606 struct usb_os_desc_header *h, void *data,
2607 unsigned len, void *priv)
2609 struct ffs_function *func = priv;
2613 case FFS_OS_DESC_EXT_COMPAT: {
2614 struct usb_ext_compat_desc *desc = data;
2615 struct usb_os_desc_table *t;
2617 t = &func->function.os_desc_table[desc->bFirstInterfaceNumber];
2618 t->if_id = func->interfaces_nums[desc->bFirstInterfaceNumber];
2619 memcpy(t->os_desc->ext_compat_id, &desc->CompatibleID,
2620 ARRAY_SIZE(desc->CompatibleID) +
2621 ARRAY_SIZE(desc->SubCompatibleID));
2622 length = sizeof(*desc);
2625 case FFS_OS_DESC_EXT_PROP: {
2626 struct usb_ext_prop_desc *desc = data;
2627 struct usb_os_desc_table *t;
2628 struct usb_os_desc_ext_prop *ext_prop;
2629 char *ext_prop_name;
2630 char *ext_prop_data;
2632 t = &func->function.os_desc_table[h->interface];
2633 t->if_id = func->interfaces_nums[h->interface];
2635 ext_prop = func->ffs->ms_os_descs_ext_prop_avail;
2636 func->ffs->ms_os_descs_ext_prop_avail += sizeof(*ext_prop);
2638 ext_prop->type = le32_to_cpu(desc->dwPropertyDataType);
2639 ext_prop->name_len = le16_to_cpu(desc->wPropertyNameLength);
2640 ext_prop->data_len = le32_to_cpu(*(u32 *)
2641 usb_ext_prop_data_len_ptr(data, ext_prop->name_len));
2642 length = ext_prop->name_len + ext_prop->data_len + 14;
2644 ext_prop_name = func->ffs->ms_os_descs_ext_prop_name_avail;
2645 func->ffs->ms_os_descs_ext_prop_name_avail +=
2648 ext_prop_data = func->ffs->ms_os_descs_ext_prop_data_avail;
2649 func->ffs->ms_os_descs_ext_prop_data_avail +=
2651 memcpy(ext_prop_data,
2652 usb_ext_prop_data_ptr(data, ext_prop->name_len),
2653 ext_prop->data_len);
2654 /* unicode data reported to the host as "WCHAR"s */
2655 switch (ext_prop->type) {
2656 case USB_EXT_PROP_UNICODE:
2657 case USB_EXT_PROP_UNICODE_ENV:
2658 case USB_EXT_PROP_UNICODE_LINK:
2659 case USB_EXT_PROP_UNICODE_MULTI:
2660 ext_prop->data_len *= 2;
2663 ext_prop->data = ext_prop_data;
2665 memcpy(ext_prop_name, usb_ext_prop_name_ptr(data),
2666 ext_prop->name_len);
2667 /* property name reported to the host as "WCHAR"s */
2668 ext_prop->name_len *= 2;
2669 ext_prop->name = ext_prop_name;
2671 t->os_desc->ext_prop_len +=
2672 ext_prop->name_len + ext_prop->data_len + 14;
2673 ++t->os_desc->ext_prop_count;
2674 list_add_tail(&ext_prop->entry, &t->os_desc->ext_prop);
2678 pr_vdebug("unknown descriptor: %d\n", type);
2684 static inline struct f_fs_opts *ffs_do_functionfs_bind(struct usb_function *f,
2685 struct usb_configuration *c)
2687 struct ffs_function *func = ffs_func_from_usb(f);
2688 struct f_fs_opts *ffs_opts =
2689 container_of(f->fi, struct f_fs_opts, func_inst);
2695 * Legacy gadget triggers binding in functionfs_ready_callback,
2696 * which already uses locking; taking the same lock here would
2699 * Configfs-enabled gadgets however do need ffs_dev_lock.
2701 if (!ffs_opts->no_configfs)
2703 ret = ffs_opts->dev->desc_ready ? 0 : -ENODEV;
2704 func->ffs = ffs_opts->dev->ffs_data;
2705 if (!ffs_opts->no_configfs)
2708 return ERR_PTR(ret);
2711 func->gadget = c->cdev->gadget;
2714 * in drivers/usb/gadget/configfs.c:configfs_composite_bind()
2715 * configurations are bound in sequence with list_for_each_entry,
2716 * in each configuration its functions are bound in sequence
2717 * with list_for_each_entry, so we assume no race condition
2718 * with regard to ffs_opts->bound access
2720 if (!ffs_opts->refcnt) {
2721 ret = functionfs_bind(func->ffs, c->cdev);
2723 return ERR_PTR(ret);
2726 func->function.strings = func->ffs->stringtabs;
2731 static int _ffs_func_bind(struct usb_configuration *c,
2732 struct usb_function *f)
2734 struct ffs_function *func = ffs_func_from_usb(f);
2735 struct ffs_data *ffs = func->ffs;
2737 const int full = !!func->ffs->fs_descs_count;
2738 const int high = gadget_is_dualspeed(func->gadget) &&
2739 func->ffs->hs_descs_count;
2740 const int super = gadget_is_superspeed(func->gadget) &&
2741 func->ffs->ss_descs_count;
2743 int fs_len, hs_len, ss_len, ret, i;
2745 /* Make it a single chunk, less management later on */
2747 vla_item_with_sz(d, struct ffs_ep, eps, ffs->eps_count);
2748 vla_item_with_sz(d, struct usb_descriptor_header *, fs_descs,
2749 full ? ffs->fs_descs_count + 1 : 0);
2750 vla_item_with_sz(d, struct usb_descriptor_header *, hs_descs,
2751 high ? ffs->hs_descs_count + 1 : 0);
2752 vla_item_with_sz(d, struct usb_descriptor_header *, ss_descs,
2753 super ? ffs->ss_descs_count + 1 : 0);
2754 vla_item_with_sz(d, short, inums, ffs->interfaces_count);
2755 vla_item_with_sz(d, struct usb_os_desc_table, os_desc_table,
2756 c->cdev->use_os_string ? ffs->interfaces_count : 0);
2757 vla_item_with_sz(d, char[16], ext_compat,
2758 c->cdev->use_os_string ? ffs->interfaces_count : 0);
2759 vla_item_with_sz(d, struct usb_os_desc, os_desc,
2760 c->cdev->use_os_string ? ffs->interfaces_count : 0);
2761 vla_item_with_sz(d, struct usb_os_desc_ext_prop, ext_prop,
2762 ffs->ms_os_descs_ext_prop_count);
2763 vla_item_with_sz(d, char, ext_prop_name,
2764 ffs->ms_os_descs_ext_prop_name_len);
2765 vla_item_with_sz(d, char, ext_prop_data,
2766 ffs->ms_os_descs_ext_prop_data_len);
2767 vla_item_with_sz(d, char, raw_descs, ffs->raw_descs_length);
2772 /* Has descriptors only for speeds gadget does not support */
2773 if (unlikely(!(full | high | super)))
2776 /* Allocate a single chunk, less management later on */
2777 vlabuf = kzalloc(vla_group_size(d), GFP_KERNEL);
2778 if (unlikely(!vlabuf))
2781 ffs->ms_os_descs_ext_prop_avail = vla_ptr(vlabuf, d, ext_prop);
2782 ffs->ms_os_descs_ext_prop_name_avail =
2783 vla_ptr(vlabuf, d, ext_prop_name);
2784 ffs->ms_os_descs_ext_prop_data_avail =
2785 vla_ptr(vlabuf, d, ext_prop_data);
2787 /* Copy descriptors */
2788 memcpy(vla_ptr(vlabuf, d, raw_descs), ffs->raw_descs,
2789 ffs->raw_descs_length);
2791 memset(vla_ptr(vlabuf, d, inums), 0xff, d_inums__sz);
2792 for (ret = ffs->eps_count; ret; --ret) {
2795 ptr = vla_ptr(vlabuf, d, eps);
2800 * d_eps == vlabuf, func->eps used to kfree vlabuf later
2802 func->eps = vla_ptr(vlabuf, d, eps);
2803 func->interfaces_nums = vla_ptr(vlabuf, d, inums);
2806 * Go through all the endpoint descriptors and allocate
2807 * endpoints first, so that later we can rewrite the endpoint
2808 * numbers without worrying that it may be described later on.
2811 func->function.fs_descriptors = vla_ptr(vlabuf, d, fs_descs);
2812 fs_len = ffs_do_descs(ffs->fs_descs_count,
2813 vla_ptr(vlabuf, d, raw_descs),
2815 __ffs_func_bind_do_descs, func);
2816 if (unlikely(fs_len < 0)) {
2825 func->function.hs_descriptors = vla_ptr(vlabuf, d, hs_descs);
2826 hs_len = ffs_do_descs(ffs->hs_descs_count,
2827 vla_ptr(vlabuf, d, raw_descs) + fs_len,
2828 d_raw_descs__sz - fs_len,
2829 __ffs_func_bind_do_descs, func);
2830 if (unlikely(hs_len < 0)) {
2838 if (likely(super)) {
2839 func->function.ss_descriptors = vla_ptr(vlabuf, d, ss_descs);
2840 ss_len = ffs_do_descs(ffs->ss_descs_count,
2841 vla_ptr(vlabuf, d, raw_descs) + fs_len + hs_len,
2842 d_raw_descs__sz - fs_len - hs_len,
2843 __ffs_func_bind_do_descs, func);
2844 if (unlikely(ss_len < 0)) {
2853 * Now handle interface numbers allocation and interface and
2854 * endpoint numbers rewriting. We can do that in one go
2857 ret = ffs_do_descs(ffs->fs_descs_count +
2858 (high ? ffs->hs_descs_count : 0) +
2859 (super ? ffs->ss_descs_count : 0),
2860 vla_ptr(vlabuf, d, raw_descs), d_raw_descs__sz,
2861 __ffs_func_bind_do_nums, func);
2862 if (unlikely(ret < 0))
2865 func->function.os_desc_table = vla_ptr(vlabuf, d, os_desc_table);
2866 if (c->cdev->use_os_string)
2867 for (i = 0; i < ffs->interfaces_count; ++i) {
2868 struct usb_os_desc *desc;
2870 desc = func->function.os_desc_table[i].os_desc =
2871 vla_ptr(vlabuf, d, os_desc) +
2872 i * sizeof(struct usb_os_desc);
2873 desc->ext_compat_id =
2874 vla_ptr(vlabuf, d, ext_compat) + i * 16;
2875 INIT_LIST_HEAD(&desc->ext_prop);
2877 ret = ffs_do_os_descs(ffs->ms_os_descs_count,
2878 vla_ptr(vlabuf, d, raw_descs) +
2879 fs_len + hs_len + ss_len,
2880 d_raw_descs__sz - fs_len - hs_len - ss_len,
2881 __ffs_func_bind_do_os_desc, func);
2882 if (unlikely(ret < 0))
2884 func->function.os_desc_n =
2885 c->cdev->use_os_string ? ffs->interfaces_count : 0;
2887 /* And we're done */
2888 ffs_event_add(ffs, FUNCTIONFS_BIND);
2892 /* XXX Do we need to release all claimed endpoints here? */
2896 static int ffs_func_bind(struct usb_configuration *c,
2897 struct usb_function *f)
2899 struct f_fs_opts *ffs_opts = ffs_do_functionfs_bind(f, c);
2901 if (IS_ERR(ffs_opts))
2902 return PTR_ERR(ffs_opts);
2904 return _ffs_func_bind(c, f);
2908 /* Other USB function hooks *************************************************/
2910 static void ffs_reset_work(struct work_struct *work)
2912 struct ffs_data *ffs = container_of(work,
2913 struct ffs_data, reset_work);
2914 ffs_data_reset(ffs);
2917 static int ffs_func_set_alt(struct usb_function *f,
2918 unsigned interface, unsigned alt)
2920 struct ffs_function *func = ffs_func_from_usb(f);
2921 struct ffs_data *ffs = func->ffs;
2924 if (alt != (unsigned)-1) {
2925 intf = ffs_func_revmap_intf(func, interface);
2926 if (unlikely(intf < 0))
2931 ffs_func_eps_disable(ffs->func);
2933 if (ffs->state == FFS_DEACTIVATED) {
2934 ffs->state = FFS_CLOSING;
2935 INIT_WORK(&ffs->reset_work, ffs_reset_work);
2936 schedule_work(&ffs->reset_work);
2940 if (ffs->state != FFS_ACTIVE)
2943 if (alt == (unsigned)-1) {
2945 ffs_event_add(ffs, FUNCTIONFS_DISABLE);
2950 ret = ffs_func_eps_enable(func);
2951 if (likely(ret >= 0))
2952 ffs_event_add(ffs, FUNCTIONFS_ENABLE);
2956 static void ffs_func_disable(struct usb_function *f)
2958 ffs_func_set_alt(f, 0, (unsigned)-1);
2961 static int ffs_func_setup(struct usb_function *f,
2962 const struct usb_ctrlrequest *creq)
2964 struct ffs_function *func = ffs_func_from_usb(f);
2965 struct ffs_data *ffs = func->ffs;
2966 unsigned long flags;
2971 pr_vdebug("creq->bRequestType = %02x\n", creq->bRequestType);
2972 pr_vdebug("creq->bRequest = %02x\n", creq->bRequest);
2973 pr_vdebug("creq->wValue = %04x\n", le16_to_cpu(creq->wValue));
2974 pr_vdebug("creq->wIndex = %04x\n", le16_to_cpu(creq->wIndex));
2975 pr_vdebug("creq->wLength = %04x\n", le16_to_cpu(creq->wLength));
2978 * Most requests directed to interface go through here
2979 * (notable exceptions are set/get interface) so we need to
2980 * handle them. All other either handled by composite or
2981 * passed to usb_configuration->setup() (if one is set). No
2982 * matter, we will handle requests directed to endpoint here
2983 * as well (as it's straightforward) but what to do with any
2986 if (ffs->state != FFS_ACTIVE)
2989 switch (creq->bRequestType & USB_RECIP_MASK) {
2990 case USB_RECIP_INTERFACE:
2991 ret = ffs_func_revmap_intf(func, le16_to_cpu(creq->wIndex));
2992 if (unlikely(ret < 0))
2996 case USB_RECIP_ENDPOINT:
2997 ret = ffs_func_revmap_ep(func, le16_to_cpu(creq->wIndex));
2998 if (unlikely(ret < 0))
3000 if (func->ffs->user_flags & FUNCTIONFS_VIRTUAL_ADDR)
3001 ret = func->ffs->eps_addrmap[ret];
3008 spin_lock_irqsave(&ffs->ev.waitq.lock, flags);
3009 ffs->ev.setup = *creq;
3010 ffs->ev.setup.wIndex = cpu_to_le16(ret);
3011 __ffs_event_add(ffs, FUNCTIONFS_SETUP);
3012 spin_unlock_irqrestore(&ffs->ev.waitq.lock, flags);
3017 static void ffs_func_suspend(struct usb_function *f)
3020 ffs_event_add(ffs_func_from_usb(f)->ffs, FUNCTIONFS_SUSPEND);
3023 static void ffs_func_resume(struct usb_function *f)
3026 ffs_event_add(ffs_func_from_usb(f)->ffs, FUNCTIONFS_RESUME);
3030 /* Endpoint and interface numbers reverse mapping ***************************/
3032 static int ffs_func_revmap_ep(struct ffs_function *func, u8 num)
3034 num = func->eps_revmap[num & USB_ENDPOINT_NUMBER_MASK];
3035 return num ? num : -EDOM;
3038 static int ffs_func_revmap_intf(struct ffs_function *func, u8 intf)
3040 short *nums = func->interfaces_nums;
3041 unsigned count = func->ffs->interfaces_count;
3043 for (; count; --count, ++nums) {
3044 if (*nums >= 0 && *nums == intf)
3045 return nums - func->interfaces_nums;
3052 /* Devices management *******************************************************/
3054 static LIST_HEAD(ffs_devices);
3056 static struct ffs_dev *_ffs_do_find_dev(const char *name)
3058 struct ffs_dev *dev;
3060 list_for_each_entry(dev, &ffs_devices, entry) {
3061 if (!dev->name || !name)
3063 if (strcmp(dev->name, name) == 0)
3071 * ffs_lock must be taken by the caller of this function
3073 static struct ffs_dev *_ffs_get_single_dev(void)
3075 struct ffs_dev *dev;
3077 if (list_is_singular(&ffs_devices)) {
3078 dev = list_first_entry(&ffs_devices, struct ffs_dev, entry);
3087 * ffs_lock must be taken by the caller of this function
3089 static struct ffs_dev *_ffs_find_dev(const char *name)
3091 struct ffs_dev *dev;
3093 dev = _ffs_get_single_dev();
3097 return _ffs_do_find_dev(name);
3100 /* Configfs support *********************************************************/
3102 static inline struct f_fs_opts *to_ffs_opts(struct config_item *item)
3104 return container_of(to_config_group(item), struct f_fs_opts,
3108 static void ffs_attr_release(struct config_item *item)
3110 struct f_fs_opts *opts = to_ffs_opts(item);
3112 usb_put_function_instance(&opts->func_inst);
3115 static struct configfs_item_operations ffs_item_ops = {
3116 .release = ffs_attr_release,
3119 static struct config_item_type ffs_func_type = {
3120 .ct_item_ops = &ffs_item_ops,
3121 .ct_owner = THIS_MODULE,
3125 /* Function registration interface ******************************************/
3127 static void ffs_free_inst(struct usb_function_instance *f)
3129 struct f_fs_opts *opts;
3131 opts = to_f_fs_opts(f);
3133 _ffs_free_dev(opts->dev);
3138 #define MAX_INST_NAME_LEN 40
3140 static int ffs_set_inst_name(struct usb_function_instance *fi, const char *name)
3142 struct f_fs_opts *opts;
3147 name_len = strlen(name) + 1;
3148 if (name_len > MAX_INST_NAME_LEN)
3149 return -ENAMETOOLONG;
3151 ptr = kstrndup(name, name_len, GFP_KERNEL);
3155 opts = to_f_fs_opts(fi);
3160 tmp = opts->dev->name_allocated ? opts->dev->name : NULL;
3161 ret = _ffs_name_dev(opts->dev, ptr);
3167 opts->dev->name_allocated = true;
3176 static struct usb_function_instance *ffs_alloc_inst(void)
3178 struct f_fs_opts *opts;
3179 struct ffs_dev *dev;
3181 opts = kzalloc(sizeof(*opts), GFP_KERNEL);
3183 return ERR_PTR(-ENOMEM);
3185 opts->func_inst.set_inst_name = ffs_set_inst_name;
3186 opts->func_inst.free_func_inst = ffs_free_inst;
3188 dev = _ffs_alloc_dev();
3192 return ERR_CAST(dev);
3197 config_group_init_type_name(&opts->func_inst.group, "",
3199 return &opts->func_inst;
3202 static void ffs_free(struct usb_function *f)
3204 kfree(ffs_func_from_usb(f));
3207 static void ffs_func_unbind(struct usb_configuration *c,
3208 struct usb_function *f)
3210 struct ffs_function *func = ffs_func_from_usb(f);
3211 struct ffs_data *ffs = func->ffs;
3212 struct f_fs_opts *opts =
3213 container_of(f->fi, struct f_fs_opts, func_inst);
3214 struct ffs_ep *ep = func->eps;
3215 unsigned count = ffs->eps_count;
3216 unsigned long flags;
3219 if (ffs->func == func) {
3220 ffs_func_eps_disable(func);
3224 if (!--opts->refcnt)
3225 functionfs_unbind(ffs);
3227 /* cleanup after autoconfig */
3228 spin_lock_irqsave(&func->ffs->eps_lock, flags);
3230 if (ep->ep && ep->req)
3231 usb_ep_free_request(ep->ep, ep->req);
3235 spin_unlock_irqrestore(&func->ffs->eps_lock, flags);
3239 * eps, descriptors and interfaces_nums are allocated in the
3240 * same chunk so only one free is required.
3242 func->function.fs_descriptors = NULL;
3243 func->function.hs_descriptors = NULL;
3244 func->function.ss_descriptors = NULL;
3245 func->interfaces_nums = NULL;
3247 ffs_event_add(ffs, FUNCTIONFS_UNBIND);
3250 static struct usb_function *ffs_alloc(struct usb_function_instance *fi)
3252 struct ffs_function *func;
3256 func = kzalloc(sizeof(*func), GFP_KERNEL);
3257 if (unlikely(!func))
3258 return ERR_PTR(-ENOMEM);
3260 func->function.name = "Function FS Gadget";
3262 func->function.bind = ffs_func_bind;
3263 func->function.unbind = ffs_func_unbind;
3264 func->function.set_alt = ffs_func_set_alt;
3265 func->function.disable = ffs_func_disable;
3266 func->function.setup = ffs_func_setup;
3267 func->function.suspend = ffs_func_suspend;
3268 func->function.resume = ffs_func_resume;
3269 func->function.free_func = ffs_free;
3271 return &func->function;
3275 * ffs_lock must be taken by the caller of this function
3277 static struct ffs_dev *_ffs_alloc_dev(void)
3279 struct ffs_dev *dev;
3282 if (_ffs_get_single_dev())
3283 return ERR_PTR(-EBUSY);
3285 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
3287 return ERR_PTR(-ENOMEM);
3289 if (list_empty(&ffs_devices)) {
3290 ret = functionfs_init();
3293 return ERR_PTR(ret);
3297 list_add(&dev->entry, &ffs_devices);
3303 * ffs_lock must be taken by the caller of this function
3304 * The caller is responsible for "name" being available whenever f_fs needs it
3306 static int _ffs_name_dev(struct ffs_dev *dev, const char *name)
3308 struct ffs_dev *existing;
3310 existing = _ffs_do_find_dev(name);
3320 * The caller is responsible for "name" being available whenever f_fs needs it
3322 int ffs_name_dev(struct ffs_dev *dev, const char *name)
3327 ret = _ffs_name_dev(dev, name);
3332 EXPORT_SYMBOL_GPL(ffs_name_dev);
3334 int ffs_single_dev(struct ffs_dev *dev)
3341 if (!list_is_singular(&ffs_devices))
3349 EXPORT_SYMBOL_GPL(ffs_single_dev);
3352 * ffs_lock must be taken by the caller of this function
3354 static void _ffs_free_dev(struct ffs_dev *dev)
3356 list_del(&dev->entry);
3357 if (dev->name_allocated)
3360 if (list_empty(&ffs_devices))
3361 functionfs_cleanup();
3364 static void *ffs_acquire_dev(const char *dev_name)
3366 struct ffs_dev *ffs_dev;
3371 ffs_dev = _ffs_find_dev(dev_name);
3373 ffs_dev = ERR_PTR(-ENOENT);
3374 else if (ffs_dev->mounted)
3375 ffs_dev = ERR_PTR(-EBUSY);
3376 else if (ffs_dev->ffs_acquire_dev_callback &&
3377 ffs_dev->ffs_acquire_dev_callback(ffs_dev))
3378 ffs_dev = ERR_PTR(-ENOENT);
3380 ffs_dev->mounted = true;
3386 static void ffs_release_dev(struct ffs_data *ffs_data)
3388 struct ffs_dev *ffs_dev;
3393 ffs_dev = ffs_data->private_data;
3395 ffs_dev->mounted = false;
3397 if (ffs_dev->ffs_release_dev_callback)
3398 ffs_dev->ffs_release_dev_callback(ffs_dev);
3404 static int ffs_ready(struct ffs_data *ffs)
3406 struct ffs_dev *ffs_obj;
3412 ffs_obj = ffs->private_data;
3417 if (WARN_ON(ffs_obj->desc_ready)) {
3422 ffs_obj->desc_ready = true;
3423 ffs_obj->ffs_data = ffs;
3425 if (ffs_obj->ffs_ready_callback)
3426 ret = ffs_obj->ffs_ready_callback(ffs);
3433 static void ffs_closed(struct ffs_data *ffs)
3435 struct ffs_dev *ffs_obj;
3440 ffs_obj = ffs->private_data;
3444 ffs_obj->desc_ready = false;
3446 if (ffs_obj->ffs_closed_callback)
3447 ffs_obj->ffs_closed_callback(ffs);
3449 if (!ffs_obj->opts || ffs_obj->opts->no_configfs
3450 || !ffs_obj->opts->func_inst.group.cg_item.ci_parent)
3453 unregister_gadget_item(ffs_obj->opts->
3454 func_inst.group.cg_item.ci_parent->ci_parent);
3459 /* Misc helper functions ****************************************************/
3461 static int ffs_mutex_lock(struct mutex *mutex, unsigned nonblock)
3464 ? likely(mutex_trylock(mutex)) ? 0 : -EAGAIN
3465 : mutex_lock_interruptible(mutex);
3468 static char *ffs_prepare_buffer(const char __user *buf, size_t len)
3475 data = kmalloc(len, GFP_KERNEL);
3476 if (unlikely(!data))
3477 return ERR_PTR(-ENOMEM);
3479 if (unlikely(__copy_from_user(data, buf, len))) {
3481 return ERR_PTR(-EFAULT);
3484 pr_vdebug("Buffer from user space:\n");
3485 ffs_dump_mem("", data, len);
3490 DECLARE_USB_FUNCTION_INIT(ffs, ffs_alloc_inst, ffs_alloc);
3491 MODULE_LICENSE("GPL");
3492 MODULE_AUTHOR("Michal Nazarewicz");